summaryrefslogtreecommitdiff
path: root/node_modules/@11ty/eleventy/src/Util/ReservedData.js
blob: d726c738b70f87b1a7c39b830b35017ab7db89f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class EleventyReservedDataError extends TypeError {}

class ReservedData {
	static properties = [
		// "pkg", // Object.freeze’d upstream
		// "eleventy", // Object.freeze’d upstream
		// "page" is only frozen for specific subproperties below
		"content",
		"collections",
	];

	static pageProperties = [
		"date",
		"inputPath",
		"fileSlug",
		"filePathStem",
		"outputFileExtension",
		"templateSyntax",
		"url",
		"outputPath",
		// not yet `excerpt` or `lang` set via front matter and computed data
	];

	// Check in the data cascade for reserved data properties.
	static getReservedKeys(data) {
		if (!data) {
			return [];
		}

		let keys = this.properties.filter((key) => {
			return key in data;
		});

		if ("page" in data) {
			if (typeof data.page === "object") {
				for (let key of this.pageProperties) {
					if (key in data.page) {
						keys.push(`page.${key}`);
					}
				}
			} else {
				// fail `page` when set to non-object values.
				keys.push("page");
			}
		}
		return keys;
	}

	static check(data) {
		let reserved = ReservedData.getReservedKeys(data);
		if (reserved.length === 0) {
			return;
		}

		let error = new EleventyReservedDataError(
			`Cannot override reserved Eleventy properties: ${reserved.join(", ")}`,
		);

		error.reservedNames = reserved;

		throw error;
	}

	static isReservedDataError(e) {
		return e instanceof EleventyReservedDataError;
	}
}

export default ReservedData;