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

import type {
	AssetToken,
	DocumentContent,
	DocumentMetadata,
	DocumentToken,
	FileReader,
} from "../types.ts";

export type ContentParseResult<
	Content extends DocumentContent = DocumentContent,
> = Content | {
	documentContent: Content;
	documentMetadata: DocumentMetadata;
};

export interface ParseParameters {
	fileReader: FileReader;
	documentMetadata: DocumentMetadata;

	getAssetToken(path: readonly string[]): AssetToken | Promise<AssetToken>;
	getDocumentToken(
		path: readonly string[],
		fragments?: readonly string[],
	): DocumentToken | Promise<DocumentToken>;
}

export interface ContentParser<
	Content extends DocumentContent = DocumentContent,
> {
	parse(params: ParseParameters): Promise<ContentParseResult<Content>>;
}