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
  90. 90
  91. 91
  92. 92
  93. 93
  94. 94
  95. 95
  96. 96
  97. 97
  98. 98
  99. 99
  100. 100
  101. 101
  102. 102
  103. 103
  104. 104
  105. 105
  106. 106
  107. 107
  108. 108
// SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0

import { extname } from "../../deps/deno.land/std/path/mod.ts";
import type * as Mdast from "../../deps/npm/mdast/types.ts";

import type { ContentParser, ParseParameters } from "./interface.ts";
import type { DocumentContent } from "../types.ts";

import { isJSONCanvas, type JSONCanvas } from "./json_canvas/types.ts";
import { mapNodeAsync } from "./json_canvas/utils.ts";
import { parseMarkdown } from "./obsidian_markdown.ts";

const PROBABLY_URL_PATTERN = /^[a-z0-9]+:/i;
const SEPARATOR = "/";

export class JSONCanvasParseError extends Error {}

export class InvalidJSONCanvasError extends JSONCanvasParseError {
	constructor() {
		super("The data is not valid JSONCanvas data");
	}
}

export class InvalidJSONError extends JSONCanvasParseError {
	constructor(cause: unknown) {
		super();

		const subMessage = cause instanceof Error ? cause.message : String(cause);
		this.message = `JSONCanvas data MUST be valid JSON string: ${subMessage}`;
		this.cause = cause;
	}
}

export type JSONCanvasDocument<T> = DocumentContent<
	"json_canvas",
	JSONCanvas<T>
>;

/**
 * Content parser for JSONCanvas documents.
 *
 * This parser uses Obsidian Markdown parser internally.
 */
export class JSONCanvasParser
	implements ContentParser<JSONCanvasDocument<Mdast.Nodes>> {
	async parse(
		{ fileReader, getDocumentToken, getAssetToken }: ParseParameters,
	): Promise<JSONCanvasDocument<Mdast.Nodes>> {
		const text = new TextDecoder().decode(await fileReader.read());

		let json: unknown;
		try {
			json = JSON.parse(text);
		} catch (err) {
			throw new InvalidJSONError(err);
		}

		if (!isJSONCanvas(json)) {
			throw new InvalidJSONCanvasError();
		}

		return {
			kind: "json_canvas",
			content: await mapNodeAsync(json, async (node) => {
				switch (node.type) {
					case "text": {
						return {
							...node,
							text: await parseMarkdown(node.text, {
								getAssetToken,
								getDocumentToken,
							}),
						};
					}
					case "file": {
						if (PROBABLY_URL_PATTERN.test(node.file)) {
							return node;
						}

						const path = node.file.split(SEPARATOR);

						const ext = extname(node.file);
						const token = (!ext || /^\.md$/i.test(ext))
							? await getDocumentToken(path)
							: await getAssetToken(path);

						return {
							...node,
							file: token,
						};
					}
					default: {
						return node;
					}
				}
			}),
			getHash(fragments) {
				const n = fileReader.path.join(SEPARATOR);
				throw new Error(
					`You can't reference part of JSONCanvas via hash syntax.` +
						`Requested ${n} # ${fragments.join(" > ")}`,
				);
			},
		};
	}
}