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
// SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0

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

export interface Document {
	readonly metadata: DocumentMetadata;
	readonly file: FileReader;
}

export interface DocumentDirectory {
	readonly metadata: DocumentMetadata;
	readonly directory: DirectoryReader;
	readonly entries: ReadonlyArray<Document | DocumentDirectory>;
}

export interface DocumentTree {
	readonly locales: ReadonlyMap<
		string,
		ReadonlyArray<Document | DocumentDirectory>
	>;
}

export interface BuildParameters {
	readonly fileSystemReader: FileSystemReader;
	readonly metadataParser: MetadataParser;
}

export interface TreeBuilder {
	build(opts: BuildParameters): Promise<DocumentTree>;
}