workers-start 0.1.1 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,37 +1,99 @@
1
1
  /**
2
2
  * Finds local secrets compiled into a build.
3
3
  *
4
- * Reads every value in the local `.env*` and `.dev.vars*` files (examples
5
- * excluded) and searches the built files for each one. A match means a key
4
+ * Reads every value in the local `.env*` and `.dev.vars*` files (examples and
5
+ * `.tpl` templates excluded) and searches the built files for each one, raw
6
+ * and in the encodings a bundler or a URL would give it. A match means a key
6
7
  * reached something that ships, whichever tool put it there.
7
8
  */
8
- import { existsSync, readdirSync, readFileSync, statSync } from "node:fs";
9
- import { join } from "node:path";
9
+ import { existsSync, lstatSync, readdirSync, readFileSync } from "node:fs";
10
+ import { join, relative, sep } from "node:path";
11
+ import { brotliDecompressSync, gunzipSync } from "node:zlib";
10
12
  /** Values shorter than this are flags or placeholders, not secrets. */
11
13
  export const MIN_SECRET_LENGTH = 12;
14
+ /**
15
+ * Paths, relative to a build directory, that are never uploaded: the copy of
16
+ * the local env the Cloudflare Vite plugin writes for `vite preview`.
17
+ */
18
+ export const DEFAULT_SKIP = ["server/.dev.vars"];
19
+ /** Keys Vite inlines on purpose; their values are public. */
20
+ export const DEFAULT_PUBLIC_PREFIXES = ["VITE_"];
12
21
  const ENV_FILE = /^(\.env(\..+)?|\.dev\.vars(\..+)?)$/;
13
- const EXAMPLE_FILE = /\.example$/;
14
- const ENV_LINE = /^\s*(?:export\s+)?([A-Za-z_][A-Za-z0-9_]*)\s*=\s*(.*?)\s*$/;
15
- const QUOTED = /^(['"])(.*)\1$/;
16
- /** `.dev.vars` copies the Cloudflare Vite plugin writes for `vite preview`; wrangler never uploads them. */
17
- export const DEFAULT_SKIP = [".dev.vars"];
18
- /** KEY=value pairs from a dotenv-style file, quotes stripped. */
22
+ const NOT_SECRETS = /\.(example|sample|template|tpl)$/;
23
+ const KEY = /^\s*(?:export\s+)?([A-Za-z_][A-Za-z0-9_.-]*)\s*=\s*(.*)$/;
24
+ const INLINE_COMMENT = /\s+#.*$/;
25
+ const ESCAPES = { n: "\n", r: "\r", t: "\t", '"': '"', "\\": "\\" };
26
+ /**
27
+ * KEY=value pairs from a dotenv file, parsed the way dotenv does: `#`
28
+ * comments, inline ` #` comments on unquoted values, single quotes taken
29
+ * literally, double quotes with `\n` escapes and multi-line values.
30
+ */
19
31
  export function parseEnvFile(source) {
20
32
  const pairs = [];
21
- for (const line of source.split("\n")) {
22
- const match = line.match(ENV_LINE);
33
+ const lines = source.replace(/\r\n?/g, "\n").split("\n");
34
+ for (let i = 0; i < lines.length; i++) {
35
+ const match = (lines[i] ?? "").match(KEY);
23
36
  if (!(match?.[1] && match[2] !== undefined)) {
24
37
  continue;
25
38
  }
26
- pairs.push([match[1], match[2].replace(QUOTED, "$2")]);
39
+ const key = match[1];
40
+ let raw = match[2].trim();
41
+ const quote = raw[0];
42
+ if (quote === '"' || quote === "'" || quote === "`") {
43
+ // Gather lines until the closing quote, for multi-line values.
44
+ let body = raw.slice(1);
45
+ while (!hasClosingQuote(body, quote) && i + 1 < lines.length) {
46
+ i++;
47
+ body += `\n${lines[i]}`;
48
+ }
49
+ const end = closingQuoteIndex(body, quote);
50
+ raw = end === -1 ? body : body.slice(0, end);
51
+ pairs.push([key, quote === '"' ? raw.replace(/\\(.)/g, (m, c) => ESCAPES[c] ?? m) : raw]);
52
+ }
53
+ else {
54
+ pairs.push([key, raw.replace(INLINE_COMMENT, "").trim()]);
55
+ }
27
56
  }
28
57
  return pairs;
29
58
  }
30
- /** The env keys whose values appear in any of the given file contents. */
31
- export function leakedKeys(pairs, contents) {
59
+ function closingQuoteIndex(body, quote) {
60
+ for (let i = 0; i < body.length; i++) {
61
+ if (body[i] === "\\" && quote === '"') {
62
+ i++;
63
+ }
64
+ else if (body[i] === quote) {
65
+ return i;
66
+ }
67
+ }
68
+ return -1;
69
+ }
70
+ function hasClosingQuote(body, quote) {
71
+ return closingQuoteIndex(body, quote) !== -1;
72
+ }
73
+ /** The forms a value can take once it is in a bundle or a URL. */
74
+ export function encodings(value) {
75
+ const forms = new Set([
76
+ value,
77
+ encodeURIComponent(value),
78
+ JSON.stringify(value).slice(1, -1),
79
+ Buffer.from(value).toString("base64").replace(/=+$/, ""),
80
+ Buffer.from(value).toString("base64url").replace(/=+$/, ""),
81
+ ]);
82
+ return [...forms].filter((form) => form.length >= MIN_SECRET_LENGTH);
83
+ }
84
+ /** The env keys whose values appear, in any encoding, in any of the given file contents. */
85
+ export function leakedKeys(pairs, contents, options = {}) {
86
+ const publicPrefixes = options.publicPrefixes ?? DEFAULT_PUBLIC_PREFIXES;
32
87
  const leaked = new Set();
33
88
  for (const [key, value] of pairs) {
34
- if (value.length >= MIN_SECRET_LENGTH && contents.some((text) => text.includes(value))) {
89
+ if (value.length < MIN_SECRET_LENGTH || value.startsWith("op://")) {
90
+ continue;
91
+ }
92
+ if (options.allow?.includes(key) || publicPrefixes.some((prefix) => key.startsWith(prefix))) {
93
+ continue;
94
+ }
95
+ const forms = encodings(value);
96
+ if (contents.some((text) => forms.some((form) => text.includes(form)))) {
35
97
  leaked.add(key);
36
98
  }
37
99
  }
@@ -40,30 +102,59 @@ export function leakedKeys(pairs, contents) {
40
102
  /** Every KEY=value pair in the local env files of `dir`. */
41
103
  export function localEnvPairs(dir) {
42
104
  return readdirSync(dir)
43
- .filter((name) => ENV_FILE.test(name) && !EXAMPLE_FILE.test(name))
105
+ .filter((name) => ENV_FILE.test(name) && !NOT_SECRETS.test(name))
44
106
  .flatMap((name) => parseEnvFile(readFileSync(join(dir, name), "utf8")));
45
107
  }
46
- /** Every file under `dir`, recursively, minus names in `skip`. */
108
+ /**
109
+ * Every regular file under `dir`, recursively. Symlinks are skipped, so the
110
+ * walk never loops or leaves the directory. `skip` holds paths relative to
111
+ * `dir`, with forward slashes.
112
+ */
47
113
  export function listFiles(dir, skip = DEFAULT_SKIP) {
48
114
  const files = [];
49
- for (const name of readdirSync(dir)) {
50
- const path = join(dir, name);
51
- if (statSync(path).isDirectory()) {
52
- files.push(...listFiles(path, skip));
115
+ const walk = (current) => {
116
+ for (const name of readdirSync(current)) {
117
+ const path = join(current, name);
118
+ const stat = lstatSync(path);
119
+ if (stat.isSymbolicLink()) {
120
+ continue;
121
+ }
122
+ if (stat.isDirectory()) {
123
+ walk(path);
124
+ }
125
+ else if (stat.isFile() && !skip.includes(relative(dir, path).split(sep).join("/"))) {
126
+ files.push(path);
127
+ }
53
128
  }
54
- else if (!skip.includes(name)) {
55
- files.push(path);
56
- }
57
- }
129
+ };
130
+ walk(dir);
58
131
  return files;
59
132
  }
60
- export function checkBundle(root, dist, skip = DEFAULT_SKIP) {
61
- if (!existsSync(dist)) {
62
- throw new Error(`${dist} does not exist. Build first.`);
133
+ /** File contents as text, decompressing `.gz` and `.br` files. */
134
+ export function readBuilt(path) {
135
+ const bytes = readFileSync(path);
136
+ try {
137
+ if (path.endsWith(".gz"))
138
+ return gunzipSync(bytes).toString("latin1");
139
+ if (path.endsWith(".br"))
140
+ return brotliDecompressSync(bytes).toString("latin1");
141
+ }
142
+ catch {
143
+ // Not really compressed; scan the bytes as they are.
144
+ }
145
+ return bytes.toString("latin1");
146
+ }
147
+ /** Scan one or more build directories against the local env files in `root`. */
148
+ export function checkBundle(root, dists, options = {}) {
149
+ const dirs = typeof dists === "string" ? [dists] : dists;
150
+ for (const dir of dirs) {
151
+ if (!existsSync(dir)) {
152
+ throw new Error(`${dir} does not exist. Build first.`);
153
+ }
63
154
  }
64
155
  const pairs = localEnvPairs(root);
65
- const files = listFiles(dist, skip);
66
- const leaked = leakedKeys(pairs, files.map((path) => readFileSync(path, "latin1")));
156
+ const files = dirs.flatMap((dir) => listFiles(dir, options.skip ?? DEFAULT_SKIP));
157
+ const leaked = leakedKeys(pairs, files.map(readBuilt), options);
67
158
  return { envValues: pairs.length, files: files.length, leaked };
68
159
  }
69
160
  //# sourceMappingURL=check-bundle.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"check-bundle.js","sourceRoot":"","sources":["../src/check-bundle.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,uEAAuE;AACvE,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC,MAAM,QAAQ,GAAG,qCAAqC,CAAC;AACvD,MAAM,YAAY,GAAG,YAAY,CAAC;AAClC,MAAM,QAAQ,GAAG,4DAA4D,CAAC;AAC9E,MAAM,MAAM,GAAG,gBAAgB,CAAC;AAEhC,4GAA4G;AAC5G,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAW,CAAC,CAAC;AAE1C,iEAAiE;AACjE,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,MAAM,KAAK,GAAuB,EAAE,CAAC;IACrC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;YAC5C,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,UAAU,CAAC,KAAyB,EAAE,QAAkB;IACtE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC;QACjC,IAAI,KAAK,CAAC,MAAM,IAAI,iBAAiB,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YACvF,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;AAC5B,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,OAAO,WAAW,CAAC,GAAG,CAAC;SACpB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACjE,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,IAAI,GAAsB,YAAY;IAC3E,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC7B,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACvC,CAAC;aAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAQD,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,IAAY,EAAE,IAAI,GAAsB,YAAY;IAC5F,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,+BAA+B,CAAC,CAAC;IAC1D,CAAC;IACD,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,UAAU,CACvB,KAAK,EACL,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAClD,CAAC;IACF,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;AAClE,CAAC"}
1
+ {"version":3,"file":"check-bundle.js","sourceRoot":"","sources":["../src/check-bundle.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE7D,uEAAuE;AACvE,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,kBAAkB,CAAC,CAAC;AAEjD,6DAA6D;AAC7D,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,OAAO,CAAC,CAAC;AAEjD,MAAM,QAAQ,GAAG,qCAAqC,CAAC;AACvD,MAAM,WAAW,GAAG,kCAAkC,CAAC;AACvD,MAAM,GAAG,GAAG,0DAA0D,CAAC;AACvE,MAAM,cAAc,GAAG,SAAS,CAAC;AACjC,MAAM,OAAO,GAA2B,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAE5F;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,MAAM,KAAK,GAAuB,EAAE,CAAC;IACrC,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;YAC5C,SAAS;QACX,CAAC;QACD,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,EAAE,CAAC;YACpD,+DAA+D;YAC/D,IAAI,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACxB,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC7D,CAAC,EAAE,CAAC;gBACJ,IAAI,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1B,CAAC;YACD,MAAM,GAAG,GAAG,iBAAiB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC3C,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAS,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACpG,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY,EAAE,KAAa;IACpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,KAAK,GAAG,EAAE,CAAC;YACtC,CAAC,EAAE,CAAC;QACN,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YAC7B,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAED,SAAS,eAAe,CAAC,IAAY,EAAE,KAAa;IAClD,OAAO,iBAAiB,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC;QACpB,KAAK;QACL,kBAAkB,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;QACxD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;KAC5D,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,iBAAiB,CAAC,CAAC;AACvE,CAAC;AASD,4FAA4F;AAC5F,MAAM,UAAU,UAAU,CAAC,KAAyB,EAAE,QAAkB,EAAE,OAAO,GAAgB,EAAE;IACjG,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,uBAAuB,CAAC;IACzE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC;QACjC,IAAI,KAAK,CAAC,MAAM,GAAG,iBAAiB,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAClE,SAAS;QACX,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YAC5F,SAAS;QACX,CAAC;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACvE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;AAC5B,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,OAAO,WAAW,CAAC,GAAG,CAAC;SACpB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAChE,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,IAAI,GAAsB,YAAY;IAC3E,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,CAAC,OAAe,EAAQ,EAAE;QACrC,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACjC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC1B,SAAS;YACX,CAAC;YACD,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;gBACvB,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,CAAC;iBAAM,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACrF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,CAAC;QACH,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtE,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAClF,CAAC;IAAC,MAAM,CAAC;QACP,qDAAqD;IACvD,CAAC;IACD,OAAO,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAClC,CAAC;AAYD,gFAAgF;AAChF,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,KAAiC,EAAE,OAAO,GAAiB,EAAE;IACrG,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACzD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,+BAA+B,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,IAAI,YAAY,CAAC,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;AAClE,CAAC"}
package/dist/entry.d.ts CHANGED
@@ -2,13 +2,14 @@
2
2
  * A Worker entry that sits in front of a TanStack Start handler (or any
3
3
  * `{ fetch }` handler) and fixes what Start leaves to the app:
4
4
  *
5
- * - A page request whose Accept header includes text/markdown gets the
6
- * Markdown rendering the app provides, on the same URL.
7
- * - A page request whose Accept header names neither text/html nor *∕* gets
8
- * HTML instead of Start's 406.
9
- * - Page responses of both kinds carry `Vary: Accept`.
10
- * - Paths under a read-only prefix (default `/api/`) answer any method other
11
- * than GET and HEAD with 405, instead of an empty 200 page shell.
5
+ * - A page request that prefers text/markdown gets the Markdown rendering the
6
+ * app provides, on the same URL.
7
+ * - A page request whose Accept header rules out HTML gets HTML anyway,
8
+ * instead of Start's 406.
9
+ * - When Markdown is on, every page response carries `Vary: Accept`.
10
+ * - Paths under a read-only prefix (default `/api`) answer OPTIONS with 204
11
+ * and anything other than GET, HEAD and OPTIONS with 405, instead of an
12
+ * empty 200 page shell.
12
13
  */
13
14
  type MaybePromise<T> = T | Promise<T>;
14
15
  /** What a Markdown renderer returns: a body, a body with a status, or null to serve HTML. */
@@ -23,24 +24,45 @@ export interface EntryOptions {
23
24
  /** The framework handler, usually the default export of `@tanstack/react-start/server-entry`. */
24
25
  handler: FetchHandler;
25
26
  /**
26
- * Markdown rendering of a page. Called for GET and HEAD page requests whose
27
- * Accept header includes text/markdown. Return null to serve HTML instead.
27
+ * Markdown rendering of a page. Called for GET and HEAD page requests that
28
+ * prefer text/markdown, with the decoded path, no trailing slash. Return
29
+ * null to serve HTML instead. If it throws, the error is logged and HTML is
30
+ * served.
28
31
  */
29
- markdown?: (pathname: string, request: Request) => MaybePromise<MarkdownResult>;
30
- /** Path prefixes that only accept GET and HEAD. Default `["/api/"]`. Pass `[]` to turn off. */
31
- readOnlyPrefixes?: string[];
32
+ markdown?: (path: string, request: Request) => MaybePromise<MarkdownResult>;
32
33
  /**
33
- * Whether a path is a page (negotiated and given `Vary: Accept`). Default:
34
- * not under a read-only prefix, not a framework internal (`/_…`, `/@…`), and
35
- * no file extension on the last segment.
34
+ * Path prefixes that only accept GET, HEAD and OPTIONS. Matched by segment,
35
+ * case-insensitively, after decoding: `/api` covers `/api`, `/api/x` and
36
+ * `/API/x`, not `/apiary`. Default `["/api"]`. Pass `[]` to turn off.
36
37
  */
37
- isPage?: (pathname: string) => boolean;
38
+ readOnlyPrefixes?: string[];
39
+ /** Whether a path is a page. Receives the normalized path. Default: {@link defaultIsPage}. */
40
+ isPage?: (path: string) => boolean;
38
41
  }
39
42
  export declare const MARKDOWN_HEADERS: Readonly<Record<string, string>>;
43
+ /**
44
+ * True when the client names text/markdown with q > 0 and rates it at least
45
+ * as high as HTML. Wildcards alone never select Markdown.
46
+ */
40
47
  export declare function wantsMarkdown(request: Request): boolean;
41
- export declare function defaultIsPage(pathname: string, readOnlyPrefixes?: readonly string[]): boolean;
42
- /** `/learn/` becomes `/learn`; `/` stays `/`. */
48
+ export declare function acceptsHtml(request: Request): boolean;
49
+ /**
50
+ * Decodes the path, collapses repeated slashes and drops trailing ones:
51
+ * `/learn//caf%C3%A9/` becomes `/learn/café`. `/` stays `/`. A path that is
52
+ * not valid percent-encoding is returned with only the slash fixes.
53
+ */
43
54
  export declare function normalizePath(pathname: string): string;
55
+ /** Whether `path` sits under `prefix`, by whole segments and ignoring case. */
56
+ export declare function underPrefix(path: string, prefix: string): boolean;
57
+ /**
58
+ * Default page test: not under a read-only prefix, not a Start or Vite
59
+ * internal (`/_…`, `/@vite/…` and similar), and no file extension such as
60
+ * `.js` or `.xml` on the last segment. A dotted slug like `/blog/node.js-tips`
61
+ * is still a page.
62
+ */
63
+ export declare function defaultIsPage(path: string, readOnlyPrefixes?: readonly string[]): boolean;
64
+ /** Appends `token` to a Vary header value unless it is already there or the value is `*`. */
65
+ export declare function mergeVary(existing: string | null, token: string): string;
44
66
  export declare function createEntry(options: EntryOptions): {
45
67
  fetch(request: Request, ...rest: unknown[]): Promise<Response>;
46
68
  };
@@ -1 +1 @@
1
- {"version":3,"file":"entry.d.ts","sourceRoot":"","sources":["../src/entry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEtC,6FAA6F;AAC7F,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,GAAG,SAAS,CAAC;AAE3F,MAAM,WAAW,YAAY;IAE3B,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,YAAY;IAC3B,iGAAiG;IACjG,OAAO,EAAE,YAAY,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,YAAY,CAAC,cAAc,CAAC,CAAC;IAChF,+FAA+F;IAC/F,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;CACxC;AAKD,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAK7D,CAAC;AAEF,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAEvD;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,gBAAgB,GAAE,SAAS,MAAM,EAAc,GAAG,OAAO,CASxG;AAED,iDAAiD;AACjD,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEtD;AAgBD,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG;IAClD,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAChE,CAkCA"}
1
+ {"version":3,"file":"entry.d.ts","sourceRoot":"","sources":["../src/entry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEtC,6FAA6F;AAC7F,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,GAAG,SAAS,CAAC;AAE3F,MAAM,WAAW,YAAY;IAE3B,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,YAAY;IAC3B,iGAAiG;IACjG,OAAO,EAAE,YAAY,CAAC;IACtB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,YAAY,CAAC,cAAc,CAAC,CAAC;IAC5E;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,8FAA8F;IAC9F,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;CACpC;AASD,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAK5D,CAAC;AAEH;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAIvD;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAErD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAStD;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAIjE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,gBAAgB,GAAE,SAAS,MAAM,EAAa,GAAG,OAAO,CAQnG;AAED,6FAA6F;AAC7F,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CASxE;AAoBD,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG;IAClD,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAChE,CAiDA"}
package/dist/entry.js CHANGED
@@ -2,77 +2,141 @@
2
2
  * A Worker entry that sits in front of a TanStack Start handler (or any
3
3
  * `{ fetch }` handler) and fixes what Start leaves to the app:
4
4
  *
5
- * - A page request whose Accept header includes text/markdown gets the
6
- * Markdown rendering the app provides, on the same URL.
7
- * - A page request whose Accept header names neither text/html nor *∕* gets
8
- * HTML instead of Start's 406.
9
- * - Page responses of both kinds carry `Vary: Accept`.
10
- * - Paths under a read-only prefix (default `/api/`) answer any method other
11
- * than GET and HEAD with 405, instead of an empty 200 page shell.
5
+ * - A page request that prefers text/markdown gets the Markdown rendering the
6
+ * app provides, on the same URL.
7
+ * - A page request whose Accept header rules out HTML gets HTML anyway,
8
+ * instead of Start's 406.
9
+ * - When Markdown is on, every page response carries `Vary: Accept`.
10
+ * - Paths under a read-only prefix (default `/api`) answer OPTIONS with 204
11
+ * and anything other than GET, HEAD and OPTIONS with 405, instead of an
12
+ * empty 200 page shell.
12
13
  */
13
- const ACCEPTS_HTML = /(^|,)\s*(\*\/\*|text\/html)/;
14
+ import { parseAccept, quality } from "./accept.js";
15
+ /** Last-segment extensions that mark a file rather than a page. */
16
+ const FILE_EXTENSION = /\.(?:js|mjs|cjs|css|map|json|xml|txt|md|csv|ico|png|jpe?g|gif|svg|webp|avif|bmp|woff2?|ttf|otf|eot|pdf|mp[34]|webm|wav|ogg|zip|gz|br|wasm|webmanifest|html?|rss|atom)$/i;
17
+ const DEV_INTERNALS = ["/@vite/", "/@fs/", "/@id/", "/@react-refresh", "/node_modules/"];
18
+ const DUPLICATE_SLASHES = /\/{2,}/g;
14
19
  const TRAILING_SLASHES = /\/+$/;
15
- export const MARKDOWN_HEADERS = {
20
+ export const MARKDOWN_HEADERS = Object.freeze({
16
21
  "content-type": "text/markdown; charset=utf-8",
17
22
  vary: "Accept",
18
23
  // A Markdown body is a second representation of a page, not a page of its own.
19
24
  "x-robots-tag": "noindex",
20
- };
25
+ });
26
+ /**
27
+ * True when the client names text/markdown with q > 0 and rates it at least
28
+ * as high as HTML. Wildcards alone never select Markdown.
29
+ */
21
30
  export function wantsMarkdown(request) {
22
- return (request.headers.get("accept") ?? "").includes("text/markdown");
31
+ const ranges = parseAccept(request.headers.get("accept"));
32
+ const markdown = quality(ranges, "text/markdown", { exactOnly: true });
33
+ return markdown > 0 && markdown >= quality(ranges, "text/html");
34
+ }
35
+ export function acceptsHtml(request) {
36
+ return quality(parseAccept(request.headers.get("accept")), "text/html") > 0;
37
+ }
38
+ /**
39
+ * Decodes the path, collapses repeated slashes and drops trailing ones:
40
+ * `/learn//caf%C3%A9/` becomes `/learn/café`. `/` stays `/`. A path that is
41
+ * not valid percent-encoding is returned with only the slash fixes.
42
+ */
43
+ export function normalizePath(pathname) {
44
+ let path = pathname;
45
+ try {
46
+ path = decodeURIComponent(pathname);
47
+ }
48
+ catch {
49
+ // Malformed escapes: match on the raw path.
50
+ }
51
+ path = path.replace(DUPLICATE_SLASHES, "/");
52
+ return path.length > 1 ? path.replace(TRAILING_SLASHES, "") || "/" : path;
53
+ }
54
+ /** Whether `path` sits under `prefix`, by whole segments and ignoring case. */
55
+ export function underPrefix(path, prefix) {
56
+ const p = path.toLowerCase();
57
+ const base = prefix.toLowerCase().replace(TRAILING_SLASHES, "");
58
+ return base === "" || p === base || p.startsWith(`${base}/`);
23
59
  }
24
- export function defaultIsPage(pathname, readOnlyPrefixes = ["/api/"]) {
25
- if (readOnlyPrefixes.some((prefix) => pathname.startsWith(prefix))) {
60
+ /**
61
+ * Default page test: not under a read-only prefix, not a Start or Vite
62
+ * internal (`/_…`, `/@vite/…` and similar), and no file extension such as
63
+ * `.js` or `.xml` on the last segment. A dotted slug like `/blog/node.js-tips`
64
+ * is still a page.
65
+ */
66
+ export function defaultIsPage(path, readOnlyPrefixes = ["/api"]) {
67
+ if (readOnlyPrefixes.some((prefix) => underPrefix(path, prefix))) {
26
68
  return false;
27
69
  }
28
- if (pathname.startsWith("/_") || pathname.startsWith("/@")) {
70
+ if (path.startsWith("/_") || DEV_INTERNALS.some((prefix) => path.startsWith(prefix))) {
29
71
  return false;
30
72
  }
31
- const lastSegment = pathname.slice(pathname.lastIndexOf("/") + 1);
32
- return !lastSegment.includes(".");
73
+ return !FILE_EXTENSION.test(path);
33
74
  }
34
- /** `/learn/` becomes `/learn`; `/` stays `/`. */
35
- export function normalizePath(pathname) {
36
- return pathname.length > 1 ? pathname.replace(TRAILING_SLASHES, "") || "/" : pathname;
75
+ /** Appends `token` to a Vary header value unless it is already there or the value is `*`. */
76
+ export function mergeVary(existing, token) {
77
+ if (!existing?.trim()) {
78
+ return token;
79
+ }
80
+ const tokens = existing.split(",").map((t) => t.trim().toLowerCase());
81
+ if (tokens.includes("*") || tokens.includes(token.toLowerCase())) {
82
+ return existing;
83
+ }
84
+ return `${existing}, ${token}`;
37
85
  }
86
+ const NULL_BODY_STATUS = new Set([101, 204, 205, 304]);
38
87
  function markdownResponse(result, head) {
39
88
  const { body, status = 200 } = typeof result === "string" ? { body: result } : result;
40
- return new Response(head ? null : body, { status, headers: MARKDOWN_HEADERS });
89
+ const noBody = head || NULL_BODY_STATUS.has(status);
90
+ return new Response(noBody ? null : body, { status, headers: MARKDOWN_HEADERS });
41
91
  }
42
92
  function withVaryAccept(response) {
43
- if (!response.headers.get("content-type")?.startsWith("text/html")) {
93
+ const vary = mergeVary(response.headers.get("vary"), "Accept");
94
+ if (vary === response.headers.get("vary")) {
44
95
  return response;
45
96
  }
46
97
  const headers = new Headers(response.headers);
47
- headers.append("vary", "Accept");
98
+ headers.set("vary", vary);
48
99
  return new Response(response.body, { status: response.status, statusText: response.statusText, headers });
49
100
  }
50
101
  export function createEntry(options) {
51
- const readOnlyPrefixes = options.readOnlyPrefixes ?? ["/api/"];
52
- const isPage = options.isPage ?? ((pathname) => defaultIsPage(pathname, readOnlyPrefixes));
102
+ const readOnlyPrefixes = options.readOnlyPrefixes ?? ["/api"];
103
+ const isPage = options.isPage ?? ((path) => defaultIsPage(path, readOnlyPrefixes));
53
104
  return {
54
105
  async fetch(request, ...rest) {
55
- const { pathname } = new URL(request.url);
56
- const isRead = request.method === "GET" || request.method === "HEAD";
57
- if (!isRead && readOnlyPrefixes.some((prefix) => pathname.startsWith(prefix))) {
58
- return Response.json({ error: "Method not allowed" }, { status: 405, headers: { allow: "GET, HEAD" } });
106
+ const path = normalizePath(new URL(request.url).pathname);
107
+ const method = request.method.toUpperCase();
108
+ const isRead = method === "GET" || method === "HEAD";
109
+ if (readOnlyPrefixes.some((prefix) => underPrefix(path, prefix))) {
110
+ if (method === "OPTIONS") {
111
+ return new Response(null, { status: 204, headers: { allow: "GET, HEAD, OPTIONS" } });
112
+ }
113
+ if (!isRead) {
114
+ return Response.json({ error: "Method not allowed" }, { status: 405, headers: { allow: "GET, HEAD, OPTIONS" } });
115
+ }
116
+ return options.handler.fetch(request, ...rest);
59
117
  }
60
- if (!isPage(pathname)) {
118
+ if (!(isRead && isPage(path))) {
61
119
  return options.handler.fetch(request, ...rest);
62
120
  }
63
- if (isRead && options.markdown && wantsMarkdown(request)) {
64
- const result = await options.markdown(normalizePath(pathname), request);
65
- if (result !== null && result !== undefined) {
66
- return markdownResponse(result, request.method === "HEAD");
121
+ if (options.markdown && wantsMarkdown(request)) {
122
+ try {
123
+ const result = await options.markdown(path, request);
124
+ if (result !== null && result !== undefined) {
125
+ return markdownResponse(result, method === "HEAD");
126
+ }
127
+ }
128
+ catch (error) {
129
+ console.error("workers-start: markdown renderer failed, serving HTML", error);
67
130
  }
68
131
  }
69
132
  let pageRequest = request;
70
- if (isRead && !ACCEPTS_HTML.test(request.headers.get("accept") ?? "*/*")) {
133
+ if (!acceptsHtml(request)) {
71
134
  const headers = new Headers(request.headers);
72
135
  headers.set("accept", "text/html");
73
136
  pageRequest = new Request(request, { headers });
74
137
  }
75
- return withVaryAccept(await options.handler.fetch(pageRequest, ...rest));
138
+ const response = await options.handler.fetch(pageRequest, ...rest);
139
+ return options.markdown ? withVaryAccept(response) : response;
76
140
  },
77
141
  };
78
142
  }
package/dist/entry.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"entry.js","sourceRoot":"","sources":["../src/entry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AA8BH,MAAM,YAAY,GAAG,6BAA6B,CAAC;AACnD,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,CAAC,MAAM,gBAAgB,GAAqC;IAChE,cAAc,EAAE,8BAA8B;IAC9C,IAAI,EAAE,QAAQ;IACd,+EAA+E;IAC/E,cAAc,EAAE,SAAS;CAC1B,CAAC;AAEF,MAAM,UAAU,aAAa,CAAC,OAAgB;IAC5C,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAgB,EAAE,gBAAgB,GAAsB,CAAC,OAAO,CAAC;IAC7F,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QACnE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3D,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAClE,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC5C,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;AACxF,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAiD,EAAE,IAAa;IACxF,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,EAAE,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;IACtF,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC,CAAC;AACjF,CAAC;AAED,SAAS,cAAc,CAAC,QAAkB;IACxC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QACnE,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjC,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;AAC5G,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAqB;IAG/C,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAEnG,OAAO;QACL,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI;YAC1B,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC1C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,KAAK,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC;YAErE,IAAI,CAAC,MAAM,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBAC9E,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,oBAAoB,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;YAC1G,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACtB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;YACjD,CAAC;YAED,IAAI,MAAM,IAAI,OAAO,CAAC,QAAQ,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;gBACzD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;gBACxE,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBAC5C,OAAO,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;gBAC7D,CAAC;YACH,CAAC;YAED,IAAI,WAAW,GAAG,OAAO,CAAC;YAC1B,IAAI,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBACzE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC7C,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;gBACnC,WAAW,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAClD,CAAC;YAED,OAAO,cAAc,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;QAC3E,CAAC;KACF,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"entry.js","sourceRoot":"","sources":["../src/entry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAgCnD,mEAAmE;AACnE,MAAM,cAAc,GAClB,yKAAyK,CAAC;AAC5K,MAAM,aAAa,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;AACzF,MAAM,iBAAiB,GAAG,SAAS,CAAC;AACpC,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,CAAC,MAAM,gBAAgB,GAAqC,MAAM,CAAC,MAAM,CAAC;IAC9E,cAAc,EAAE,8BAA8B;IAC9C,IAAI,EAAE,QAAQ;IACd,+EAA+E;IAC/E,cAAc,EAAE,SAAS;CAC1B,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,OAAgB;IAC5C,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACvE,OAAO,QAAQ,GAAG,CAAC,IAAI,QAAQ,IAAI,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAgB;IAC1C,OAAO,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;AAC9E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC5C,IAAI,IAAI,GAAG,QAAQ,CAAC;IACpB,IAAI,CAAC;QACH,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAAC,MAAM,CAAC;QACP,4CAA4C;IAC9C,CAAC;IACD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;IAC5C,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5E,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,MAAc;IACtD,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAChE,OAAO,IAAI,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,gBAAgB,GAAsB,CAAC,MAAM,CAAC;IACxF,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;QACjE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QACrF,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,SAAS,CAAC,QAAuB,EAAE,KAAa;IAC9D,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;IACtE,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QACjE,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,OAAO,GAAG,QAAQ,KAAK,KAAK,EAAE,CAAC;AACjC,CAAC;AAED,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAEvD,SAAS,gBAAgB,CAAC,MAAiD,EAAE,IAAa;IACxF,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,EAAE,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;IACtF,MAAM,MAAM,GAAG,IAAI,IAAI,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpD,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,cAAc,CAAC,QAAkB;IACxC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/D,IAAI,IAAI,KAAK,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1C,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC1B,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;AAC5G,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAqB;IAG/C,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAE3F,OAAO;QACL,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI;YAC1B,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAC5C,MAAM,MAAM,GAAG,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,MAAM,CAAC;YAErD,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;gBACjE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACzB,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,oBAAoB,EAAE,EAAE,CAAC,CAAC;gBACvF,CAAC;gBACD,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,OAAO,QAAQ,CAAC,IAAI,CAClB,EAAE,KAAK,EAAE,oBAAoB,EAAE,EAC/B,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,oBAAoB,EAAE,EAAE,CAC1D,CAAC;gBACJ,CAAC;gBACD,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;YACjD,CAAC;YAED,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;YACjD,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/C,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;oBACrD,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;wBAC5C,OAAO,gBAAgB,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;oBACrD,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CAAC,uDAAuD,EAAE,KAAK,CAAC,CAAC;gBAChF,CAAC;YACH,CAAC;YAED,IAAI,WAAW,GAAG,OAAO,CAAC;YAC1B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC7C,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;gBACnC,WAAW,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,CAAC;YACnE,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAChE,CAAC;KACF,CAAC;AACJ,CAAC"}
package/dist/head.d.ts CHANGED
@@ -2,24 +2,36 @@
2
2
  * Per-page head tags in the shape a TanStack Router `head()` returns.
3
3
  *
4
4
  * The router keeps one meta per `name` or `property`, deepest route winning,
5
- * so any tag a page leaves out falls back to a parent's. This helper writes
6
- * the full Open Graph and Twitter set for every page so nothing inherits the
7
- * homepage's share card by accident.
5
+ * and concatenates links. So call `pageHead` from leaf routes only: a tag a
6
+ * leaf leaves out falls back to a parent's, and a canonical from both a
7
+ * layout and a leaf is emitted twice. Put site-wide tags (charset, viewport,
8
+ * icons) in the root route without this helper.
8
9
  */
9
10
  export interface SiteHead {
10
- /** Absolute origin, no trailing slash: `https://example.com`. */
11
+ /** Absolute origin: `https://example.com`. A trailing slash is ignored. */
11
12
  url: string;
12
13
  /** Used for `og:site_name` and the default title suffix. */
13
14
  name: string;
14
- /** Path under the site of the default share image. */
15
+ /** Path under the site, or an absolute URL, of the default share image. */
15
16
  defaultImage?: string;
16
- /** Twitter handle with the @. */
17
+ /** Author's handle with the @, for `twitter:creator`. */
17
18
  twitterCreator?: string;
19
+ /** Site's handle with the @, for `twitter:site`. */
20
+ twitterSite?: string;
18
21
  /** Default `en_US`. */
19
22
  locale?: string;
20
23
  /** Default `(title) => \`${title} | ${name}\``. */
21
24
  titleTemplate?: (title: string) => string;
22
25
  }
26
+ export interface PageImage {
27
+ /** Path under the site, or an absolute URL. */
28
+ url: string;
29
+ width?: number;
30
+ height?: number;
31
+ alt?: string;
32
+ /** MIME type, such as `image/png`. */
33
+ type?: string;
34
+ }
23
35
  export interface PageSeo {
24
36
  title: string;
25
37
  /** Use `title` as the whole document title, without the template. */
@@ -34,19 +46,31 @@ export interface PageSeo {
34
46
  socialDescription?: string;
35
47
  /** Defaults to `socialDescription`. */
36
48
  twitterDescription?: string;
37
- /** Path under the site, or an absolute URL. */
38
- image?: string;
49
+ /** A path or URL, or an object with size, alt and type. Defaults to the site's image. */
50
+ image?: string | PageImage;
51
+ /** @deprecated Use `image: { url, width, height, alt }`. */
39
52
  imageSize?: {
40
53
  width: number;
41
54
  height: number;
42
- alt: string;
55
+ alt?: string;
43
56
  };
44
57
  /** ISO date, for articles. */
45
58
  published?: string;
46
59
  /** ISO date, for articles. */
47
60
  modified?: string;
48
- /** Adds `robots: noindex`. */
61
+ /** For articles: author names or profile URLs, one `article:author` each. */
62
+ authors?: string[];
63
+ /** For articles: one `article:tag` each. */
64
+ tags?: string[];
65
+ keywords?: string[];
66
+ /** Adds `robots: noindex`. Ignored when `robots` is set. */
49
67
  noindex?: boolean;
68
+ /** Full robots directive, such as `noindex, follow` or `max-image-preview:large`. */
69
+ robots?: string;
70
+ /** Override the canonical URL, or `false` to emit none. Defaults to the page URL. */
71
+ canonical?: string | false;
72
+ /** Extra tags, appended last. */
73
+ meta?: MetaTag[];
50
74
  }
51
75
  export type MetaTag = {
52
76
  title: string;
@@ -1 +1 @@
1
- {"version":3,"file":"head.d.ts","sourceRoot":"","sources":["../src/head.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,MAAM,WAAW,QAAQ;IACvB,iEAAiE;IACjE,GAAG,EAAE,MAAM,CAAC;IACZ,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IACb,sDAAsD;IACtD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CAC3C;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAC7B,2BAA2B;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,uCAAuC;IACvC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3D,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACxC;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG;IAC9C,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,QAAQ,CAAC;IACrC,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACvC,CAiEA"}
1
+ {"version":3,"file":"head.d.ts","sourceRoot":"","sources":["../src/head.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,MAAM,WAAW,QAAQ;IACvB,2EAA2E;IAC3E,GAAG,EAAE,MAAM,CAAC;IACZ,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yDAAyD;IACzD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CAC3C;AAED,MAAM,WAAW,SAAS;IACxB,+CAA+C;IAC/C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAC7B,2BAA2B;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,uCAAuC;IACvC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,yFAAyF;IACzF,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,4DAA4D;IAC5D,SAAS,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5D,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6EAA6E;IAC7E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,4DAA4D;IAC5D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,qFAAqF;IACrF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC3B,iCAAiC;IACjC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;CAClB;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACxC;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG;IAC9C,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,QAAQ,CAAC;IACrC,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACvC,CA2EA"}