macana

Static site generator for Obsidian Vault

  1. 1
  2. 2
  3. 3
  4. 4
  5. 5
  6. 6
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. 14
  15. 15
  16. 16
  17. 17
  18. 18
  19. 19
  20. 20
  21. 21
  22. 22
  23. 23
  24. 24
  25. 25
  26. 26
  27. 27
  28. 28
  29. 29
  30. 30
  31. 31
  32. 32
  33. 33
  34. 34
  35. 35
  36. 36
  37. 37
  38. 38
  39. 39
  40. 40
  41. 41
  42. 42
  43. 43
  44. 44
  45. 45
  46. 46
  47. 47
  48. 48
  49. 49
  50. 50
  51. 51
  52. 52
  53. 53
  54. 54
  55. 55
  56. 56
  57. 57
  58. 58
  59. 59
  60. 60
  61. 61
  62. 62
  63. 63
  64. 64
  65. 65
  66. 66
  67. 67
  68. 68
  69. 69
  70. 70
  71. 71
  72. 72
  73. 73
  74. 74
  75. 75
  76. 76
  77. 77
  78. 78
  79. 79
  80. 80
  81. 81
  82. 82
  83. 83
  84. 84
  85. 85
  86. 86
  87. 87
  88. 88
  89. 89
// SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0

import type * as Mdast from "../../deps/esm.sh/mdast/types.ts";

import { visit } from "../../deps/esm.sh/unist-util-visit/mod.ts";

import type { DocumentToken } from "../../types.ts";

import type { OfmWikilink } from "./mdast_util_ofm_wikilink.ts";

function hasDocumentToken(
	node: Mdast.Node,
): node is typeof node & { data: { macanaDocumentToken: DocumentToken } } {
	return !!(node.data && ("macanaDocumentToken" in node.data) &&
		typeof node.data.macanaDocumentToken === "string" &&
		node.data.macanaDocumentToken.startsWith("mxt_"));
}

export interface ExchangeResult {
	/**
	 * Path string appears on the final markup.
	 */
	path: string;
}

function replace(
	node: Mdast.Nodes | OfmWikilink,
	{ path }: ExchangeResult,
): void {
	switch (node.type) {
		case "ofmWikilink": {
			// Do not use resolved path as a fallback label
			node.label ??= node.target;

			node.target = path;
			return;
		}
		case "link": {
			node.url = path;
			return;
		}
		case "definition": {
			node.url = path;
			return;
		}
	}
}

/**
 * Modifies the given Mdast tree by searching nodes having `macanaDocumentToken`
 * property then replacing node properties.
 * This function modifies Mdast tree in place.
 *
 * @param tree - Mdast tree to modify.
 * @param exchange - A function that takes Document Token and returns properties required for constructing markup.
 */
export function macanaReplaceDocumentToken(
	tree: Mdast.Nodes,
	exchange: (token: DocumentToken) => ExchangeResult | Promise<ExchangeResult>,
): Promise<void> | void {
	const promises: Promise<unknown>[] = [];

	visit(
		tree,
		(node) => hasDocumentToken(node),
		(node) => {
			if (!hasDocumentToken(node)) {
				return;
			}

			const exchanged = exchange(node.data.macanaDocumentToken);

			if (exchanged instanceof Promise) {
				promises.push(exchanged.then((payload) => {
					replace(node, payload);
				}));
				return;
			}

			replace(node, exchanged);
		},
	);

	if (promises.length > 0) {
		return Promise.all(promises).then(() => {});
	}
}