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

// SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0

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

export interface DocumentMetadata {
	/**
	 * An identifier for a document, unique among a directory the document belongs to.
	 * A *document name* appears in a generated URL, thus available characters are limited to:
	 *
	 * - Alphabet (`a-z`, `A-Z`)
	 * - Digit (`0-9`)
	 * - Percent symbol (`%`)
	 * - Hyphen (`-`)
	 * - Dot (`.`)
	 * - Underscore (`_`)
	 * - Tilde (`~`)
	 */
	readonly name: string;

	/**
	 * Human-readable text representing a title of the *document*.
	 * Although there is no restriction on available characters, you should avoid using
	 * control characters.
	 * ([Unicode control characters - Wikipedia](https://en.wikipedia.org/wiki/Unicode_control_characters))
	 */
	readonly title: string;

	/**
	 * Language for a document directory or a document.
	 * If this is empty, Macana looks up the most closest document directory language set.
	 * If none of the ancestors have a language, Macana will use a user given default language.
	 */
	readonly language?: string;
}

/**
 * Skip this parser.
 * If no parsers left, do not include the file in a document tree.
 */
export interface Skip {
	readonly skip: true;
}

export interface MetadataParser {
	/**
	 * Parses a file or directory then returns metadata for the file or directory.
	 * Throws when the file or directory does not meet the expectation.
	 */
	parse(
		fileOrDirectory: FileReader | DirectoryReader,
	): Promise<DocumentMetadata | Skip>;
}