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 * as yamlFrontmatter from "../deps/deno.land/std/front_matter/yaml.ts";

import type {
	DirectoryReader,
	FileReader,
} from "../filesystem_reader/interface.ts";
import type { DocumentMetadata, MetadataParser, Skip } from "./interface.ts";

function escapeNodeName(nodeName: string): string {
	return encodeURIComponent(nodeName.toLowerCase());
}

export interface VaultParserOptions {
	/**
	 * Whether to read YAML frontmatter of notes.
	 * When enabled,
	 *
	 * - Use `name` property for document name if defined.
	 * - Use `title` property for document title if defined.
	 *
	 * This flag is off by-default for performance reasons.
	 */
	readFrontMatter?: boolean;
}

/**
 * A parser for Obsidian Vault.
 *
 * By default, this parser uses file and directory name as document title
 * and lowercased escaped one as document name.
 */
export class VaultParser implements MetadataParser {
	#readFrontMatter: boolean;

	constructor({ readFrontMatter = false }: VaultParserOptions = {}) {
		this.#readFrontMatter = readFrontMatter;
	}

	async parse(
		node: FileReader | DirectoryReader,
	): Promise<DocumentMetadata | Skip> {
		if (node.type === "directory") {
			return {
				name: escapeNodeName(node.name),
				title: node.name,
			};
		}

		const ext = extname(node.name);
		const basename = ext ? node.name.slice(0, -ext.length) : node.name;

		switch (ext) {
			case ".md": {
				const fromFileName: DocumentMetadata = {
					name: escapeNodeName(basename),
					title: basename,
				};

				if (this.#readFrontMatter) {
					const parsed = await this.#parseFrontMatter(node);

					return {
						name: parsed.name || fromFileName.name,
						title: parsed.title || fromFileName.title,
					};
				}

				return fromFileName;
			}
			case ".canvas": {
				return {
					name: escapeNodeName(basename),
					title: basename,
				};
			}
			// Not an Obsidian document.
			default: {
				return {
					skip: true,
				};
			}
		}
	}

	async #parseFrontMatter(
		file: FileReader,
	): Promise<Partial<DocumentMetadata>> {
		const markdown = new TextDecoder().decode(await file.read());

		// Obsidian currently supports YAML frontmatter only.
		const frontmatter = yamlFrontmatter.extract(markdown);

		const name = ("name" in frontmatter.attrs &&
			typeof frontmatter.attrs.name === "string" && frontmatter.attrs.name) ||
			undefined;

		const title = ("title" in frontmatter.attrs &&
			typeof frontmatter.attrs.title === "string" &&
			frontmatter.attrs.title) || undefined;

		return { name, title };
	}
}