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

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

import type { Document, DocumentTree, FileReader } from "../../types.ts";

export interface Assets {
	globalCss: readonly string[];
	faviconSvg?: readonly string[];
	faviconPng?: readonly string[];
	siteLogo?: readonly string[];
	openGraphImage?: readonly string[];
	thirdPartyNotices: readonly string[];
}

export interface BuildContext {
	documentTree: DocumentTree;

	/**
	 * Current document's language.
	 *
	 * You should use this property instead of `document.metadata.language`.
	 * The document metadata only contains metadata defined by the document itself.
	 * If the document does not declare language and inherits from ancestor,
	 * the value of `document.metadata.language` would be `undefined`.
	 */
	language: string;

	/**
	 * Site-wide asset paths.
	 */
	assets: Readonly<Assets>;

	websiteTitle: string;

	copyright: string;

	/**
	 * Returns full URL, absolute path or relative path from the current
	 * document depends on a base URL.
	 */
	resolveURL(path: readonly string[]): string;

	/**
	 * Copy file to the output directory.
	 */
	copyFile(file: FileReader): void;

	/**
	 * Write file to the given path.
	 */
	writeFile(path: readonly string[], contents: Uint8Array): void;
}

export interface DocumentBuildContext extends BuildContext {
	/**
	 * The document currently building.
	 */
	document: Document;
}