@kensio/colophon 2.1.0 → 2.3.0

package/dist/validate/keys.js

@@ -0,0 +1,166 @@
+/**
+ * The keys of one config object, as a list to check incoming keys against.
+ *
+ * Taking a `Record<keyof T, true>` rather than a plain array of strings is
+ * what keeps the list honest: adding an option to `types.ts` without listing
+ * it here fails the build, which is much better than the new option quietly
+ * becoming an unknown one.
+ */
+function knownKeys(shape) {
+    return Object.keys(shape);
+}
+/** Top-level config options. */
+export const configKeys = knownKeys({
+    colors: true,
+    background: true,
+    fonts: true,
+    systemFonts: true,
+    fontFamily: true,
+    footer: true,
+    badge: true,
+    code: true,
+    onWarning: true,
+    sizes: true,
+    templates: true,
+    content: true,
+    placement: true,
+    manifest: true,
+    extra: true,
+});
+/** Keys of a placement that writes each image beside its post. */
+export const besideContentKeys = knownKeys({
+    strategy: true,
+    urlBase: true,
+    hash: true,
+});
+/** Keys of a placement that gathers images into one directory. */
+export const publicDirKeys = knownKeys({
+    strategy: true,
+    dir: true,
+    urlBase: true,
+    hash: true,
+});
+/** Keys of a placement that works both halves out for itself. */
+export const customPlacementKeys = knownKeys({
+    strategy: true,
+    path: true,
+    url: true,
+});
+/**
+ * The placement strategies, for the same reason as {@link backgroundTypes}: a
+ * mistyped one would otherwise be reported as an unknown key on whichever
+ * variant it was guessed to be.
+ *
+ * Two of the names are hyphenated because they are values a user writes in a
+ * config, not identifiers — the casing rule is about the latter. Keeping them
+ * as keys is what keeps the list exhaustive, which is the whole point of it.
+ */
+export const placementStrategies = knownKeys({
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    "beside-content": true,
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    "public-dir": true,
+    custom: true,
+});
+/** One ad hoc image declared in config. */
+export const extraKeys = knownKeys({
+    props: true,
+    output: true,
+    size: true,
+});
+/** Options for reading a project's own frontmatter. */
+export const contentKeys = knownKeys({
+    propsKey: true,
+    templateField: true,
+    defaultTemplate: true,
+    props: true,
+    slugField: true,
+    slugStrategy: true,
+    extensions: true,
+});
+/** Brand palette shades. */
+export const colorKeys = knownKeys({
+    brand: true,
+    brandDark: true,
+    brandWarm: true,
+    foreground: true,
+});
+/** Corner-badge options. */
+export const badgeKeys = knownKeys({
+    text: true,
+    color: true,
+    background: true,
+});
+/** `code` template styling options. */
+export const codeKeys = knownKeys({
+    theme: true,
+    fontFamily: true,
+    charWidthRatio: true,
+    lineHeight: true,
+    tabSize: true,
+    cornerScale: true,
+    maxFontScale: true,
+    minFontScale: true,
+});
+/** One output size, including the overrides it may carry. */
+export const sizeKeys = knownKeys({
+    name: true,
+    width: true,
+    height: true,
+    colors: true,
+    background: true,
+    fontFamily: true,
+    footer: true,
+    badge: true,
+    code: true,
+});
+/**
+ * Both font variants at once. Which of `path` and `data` a font may carry is
+ * `fonts/resolve.ts`'s ruling to make, and it has a better message for it than
+ * a list of keys could.
+ */
+export const fontKeys = [
+    ...new Set([
+        ...knownKeys({ family: true, path: true }),
+        ...knownKeys({ family: true, data: true }),
+    ]),
+];
+/** Keys of a solid background. */
+export const solidBackgroundKeys = knownKeys({
+    type: true,
+    color: true,
+});
+/** Keys of a gradient background. */
+export const gradientBackgroundKeys = knownKeys({
+    type: true,
+    stops: true,
+    from: true,
+    to: true,
+});
+/** Keys of one gradient stop. */
+export const gradientStopKeys = knownKeys({
+    offset: true,
+    color: true,
+});
+/** Keys of a gradient's `from` and `to` points. */
+export const gradientPointKeys = knownKeys({ x: true, y: true });
+/**
+ * The background variants, as values to check a declared `type` against. Typed
+ * against the union for the same reason the key lists are: a variant added to
+ * `Background` and not listed here would otherwise be reported as an unknown
+ * type, rejecting a config that is perfectly valid.
+ */
+export const backgroundTypes = knownKeys({
+    solid: true,
+    gradient: true,
+});
+/**
+ * The slug strategies, for the same reason as {@link backgroundTypes}:
+ * `slugFromPath` treats anything that is not `basename` as a route, so a
+ * mistyped `rout` would quietly re-slug a whole site rather than complain.
+ */
+export const slugStrategies = knownKeys({
+    basename: true,
+    route: true,
+});
+//# sourceMappingURL=keys.js.map

package/dist/validate/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../src/validate/keys.ts"],"names":[],"mappings":"AAeA;;;;;;;GAOG;AACH,SAAS,SAAS,CAAI,KAA4B;IAChD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AAiBD,gCAAgC;AAChC,MAAM,CAAC,MAAM,UAAU,GAAG,SAAS,CAAiB;IAClD,MAAM,EAAE,IAAI;IACZ,UAAU,EAAE,IAAI;IAChB,KAAK,EAAE,IAAI;IACX,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,SAAS,EAAE,IAAI;IACf,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC;AAEH,kEAAkE;AAClE,MAAM,CAAC,MAAM,iBAAiB,GAAG,SAAS,CAAkB;IAC1D,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,IAAI;CACX,CAAC,CAAC;AAEH,kEAAkE;AAClE,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAqB;IACzD,QAAQ,EAAE,IAAI;IACd,GAAG,EAAE,IAAI;IACT,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,IAAI;CACX,CAAC,CAAC;AAEH,iEAAiE;AACjE,MAAM,CAAC,MAAM,mBAAmB,GAAG,SAAS,CAAkB;IAC5D,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,IAAI;CACV,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,SAAS,CAE1C;IACA,gEAAgE;IAChE,gBAAgB,EAAE,IAAI;IACtB,gEAAgE;IAChE,YAAY,EAAE,IAAI;IAClB,MAAM,EAAE,IAAI;CACb,CAAC,CAAC;AAEH,2CAA2C;AAC3C,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAa;IAC7C,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,IAAI,EAAE,IAAI;CACX,CAAC,CAAC;AAEH,uDAAuD;AACvD,MAAM,CAAC,MAAM,WAAW,GAAG,SAAS,CAAiB;IACnD,QAAQ,EAAE,IAAI;IACd,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,IAAI;CACjB,CAAC,CAAC;AAEH,4BAA4B;AAC5B,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAc;IAC9C,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,IAAI;CACjB,CAAC,CAAC;AAEH,4BAA4B;AAC5B,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAQ;IACxC,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;CACjB,CAAC,CAAC;AAEH,uCAAuC;AACvC,MAAM,CAAC,MAAM,QAAQ,GAAG,SAAS,CAAY;IAC3C,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,IAAI;IACpB,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;IACb,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,IAAI;CACnB,CAAC,CAAC;AAEH,6DAA6D;AAC7D,MAAM,CAAC,MAAM,QAAQ,GAAG,SAAS,CAAa;IAC5C,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;CACX,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,GAAG,IAAI,GAAG,CAAC;QACT,GAAG,SAAS,CAAa,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACtD,GAAG,SAAS,CAAa,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;KACvD,CAAC;CACH,CAAC;AAEF,kCAAkC;AAClC,MAAM,CAAC,MAAM,mBAAmB,GAAG,SAAS,CAAkB;IAC5D,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC;AAEH,qCAAqC;AACrC,MAAM,CAAC,MAAM,sBAAsB,GAAG,SAAS,CAAqB;IAClE,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,EAAE,EAAE,IAAI;CACT,CAAC,CAAC;AAEH,iCAAiC;AACjC,MAAM,CAAC,MAAM,gBAAgB,GAAG,SAAS,CAAe;IACtD,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC;AAEH,mDAAmD;AACnD,MAAM,CAAC,MAAM,iBAAiB,GAAG,SAAS,CAAgB,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,SAAS,CAAsC;IAC5E,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,SAAS,CAAgC;IACrE,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC"}

package/dist/validate/overrides.d.ts

@@ -0,0 +1,5 @@
+/** Check each output size, and the overrides it carries. */
+export declare function checkSizes(sizes: unknown, problems: string[]): void;
+/** Check each extra image, and the size it renders at. */
+export declare function checkExtras(extras: unknown, problems: string[]): void;
+//# sourceMappingURL=overrides.d.ts.map

package/dist/validate/overrides.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"overrides.d.ts","sourceRoot":"","sources":["../../src/validate/overrides.ts"],"names":[],"mappings":"AAwBA,4DAA4D;AAC5D,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAQnE;AAED,0DAA0D;AAC1D,wBAAgB,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAarE"}

package/dist/validate/overrides.js

@@ -0,0 +1,43 @@
+import { checkKeys, isList, isRecord } from "./check.js";
+import { badgeKeys, codeKeys, colorKeys, extraKeys, sizeKeys } from "./keys.js";
+import { checkBackground } from "./values.js";
+/**
+ * Check one output size, and the overrides it carries.
+ *
+ * A size is the one place the same option names appear twice over, so the paths
+ * matter more here than anywhere else: `sizes[1].code.minFontScal` has to say
+ * which size it is talking about to be worth reading at all.
+ */
+function checkSize(size, path, problems) {
+    checkKeys(size, path, sizeKeys, problems);
+    if (!isRecord(size)) {
+        return;
+    }
+    checkKeys(size["colors"], `${path}.colors`, colorKeys, problems);
+    checkKeys(size["badge"], `${path}.badge`, badgeKeys, problems);
+    checkKeys(size["code"], `${path}.code`, codeKeys, problems);
+    checkBackground(size["background"], `${path}.background`, problems);
+}
+/** Check each output size, and the overrides it carries. */
+export function checkSizes(sizes, problems) {
+    if (!isList(sizes)) {
+        return;
+    }
+    for (const [index, size] of sizes.entries()) {
+        checkSize(size, `sizes[${String(index)}]`, problems);
+    }
+}
+/** Check each extra image, and the size it renders at. */
+export function checkExtras(extras, problems) {
+    if (!isList(extras)) {
+        return;
+    }
+    for (const [index, extra] of extras.entries()) {
+        const path = `extra[${String(index)}]`;
+        checkKeys(extra, path, extraKeys, problems);
+        if (isRecord(extra)) {
+            checkSize(extra["size"], `${path}.size`, problems);
+        }
+    }
+}
+//# sourceMappingURL=overrides.js.map

package/dist/validate/overrides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overrides.js","sourceRoot":"","sources":["../../src/validate/overrides.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,IAAa,EAAE,IAAY,EAAE,QAAkB;IAChE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAE1C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO;IACT,CAAC;IAED,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IACjE,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/D,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC5D,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,IAAI,aAAa,EAAE,QAAQ,CAAC,CAAC;AACtE,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,UAAU,CAAC,KAAc,EAAE,QAAkB;IAC3D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO;IACT,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5C,SAAS,CAAC,IAAI,EAAE,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,WAAW,CAAC,MAAe,EAAE,QAAkB;IAC7D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACpB,OAAO;IACT,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9C,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;QACvC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAE5C,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,OAAO,EAAE,QAAQ,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/validate/placement.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Check a placement against the keys of whichever strategy it declares.
+ *
+ * The strategy is required, unlike a background's `type`: a background with
+ * none still looks like the gradient it is rendered as, where a placement with
+ * none is a `dir` and a `urlBase` read by nobody and images written somewhere
+ * else entirely.
+ */
+export declare function checkPlacement(placement: unknown, problems: string[]): void;
+//# sourceMappingURL=placement.d.ts.map

package/dist/validate/placement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"placement.d.ts","sourceRoot":"","sources":["../../src/validate/placement.ts"],"names":[],"mappings":"AAsBA;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CA6B3E"}

package/dist/validate/placement.js

@@ -0,0 +1,38 @@
+import { checkKeys, isRecord } from "./check.js";
+import { besideContentKeys, customPlacementKeys, placementStrategies, publicDirKeys, } from "./keys.js";
+import { describeUnknownValue } from "./values.js";
+/** The keys one placement strategy accepts, or nothing if it names none. */
+function placementKeys(strategy) {
+    if (strategy === "beside-content") {
+        return besideContentKeys;
+    }
+    if (strategy === "public-dir") {
+        return publicDirKeys;
+    }
+    return strategy === "custom" ? customPlacementKeys : undefined;
+}
+/**
+ * Check a placement against the keys of whichever strategy it declares.
+ *
+ * The strategy is required, unlike a background's `type`: a background with
+ * none still looks like the gradient it is rendered as, where a placement with
+ * none is a `dir` and a `urlBase` read by nobody and images written somewhere
+ * else entirely.
+ */
+export function checkPlacement(placement, problems) {
+    if (!isRecord(placement)) {
+        return;
+    }
+    const strategy = placement["strategy"];
+    if (typeof strategy !== "string") {
+        problems.push(`placement needs a "strategy": ${placementStrategies.join(", ")}.`);
+        return;
+    }
+    const keys = placementKeys(strategy);
+    if (keys === undefined) {
+        problems.push(describeUnknownValue("placement strategy", "strategies", strategy, placementStrategies));
+        return;
+    }
+    checkKeys(placement, "placement", keys, problems);
+}
+//# sourceMappingURL=placement.js.map

package/dist/validate/placement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"placement.js","sourceRoot":"","sources":["../../src/validate/placement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,GACd,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEnD,4EAA4E;AAC5E,SAAS,aAAa,CAAC,QAAgB;IACrC,IAAI,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QAClC,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,IAAI,QAAQ,KAAK,YAAY,EAAE,CAAC;QAC9B,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;AACjE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,SAAkB,EAAE,QAAkB;IACnE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IAEvC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,QAAQ,CAAC,IAAI,CACX,iCAAiC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACnE,CAAC;QACF,OAAO;IACT,CAAC;IAED,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAErC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAClB,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EACR,mBAAmB,CACpB,CACF,CAAC;QACF,OAAO;IACT,CAAC;IAED,SAAS,CAAC,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;AACpD,CAAC"}

package/dist/validate/sizes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Check each output size, and the overrides it carries.
+ *
+ * A size is the one place the same option names appear twice over, so the paths
+ * matter more here than anywhere else: `sizes[1].code.minFontScal` has to say
+ * which size it is talking about to be worth reading at all.
+ */
+export declare function checkSizes(sizes: unknown, problems: string[]): void;
+//# sourceMappingURL=sizes.d.ts.map

package/dist/validate/sizes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sizes.d.ts","sourceRoot":"","sources":["../../src/validate/sizes.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAkBnE"}

package/dist/validate/sizes.js

@@ -0,0 +1,27 @@
+import { checkKeys, isList, isRecord } from "./check.js";
+import { badgeKeys, codeKeys, colorKeys, sizeKeys } from "./keys.js";
+import { checkBackground } from "./values.js";
+/**
+ * Check each output size, and the overrides it carries.
+ *
+ * A size is the one place the same option names appear twice over, so the paths
+ * matter more here than anywhere else: `sizes[1].code.minFontScal` has to say
+ * which size it is talking about to be worth reading at all.
+ */
+export function checkSizes(sizes, problems) {
+    if (!isList(sizes)) {
+        return;
+    }
+    for (const [index, size] of sizes.entries()) {
+        const path = `sizes[${String(index)}]`;
+        checkKeys(size, path, sizeKeys, problems);
+        if (!isRecord(size)) {
+            continue;
+        }
+        checkKeys(size["colors"], `${path}.colors`, colorKeys, problems);
+        checkKeys(size["badge"], `${path}.badge`, badgeKeys, problems);
+        checkKeys(size["code"], `${path}.code`, codeKeys, problems);
+        checkBackground(size["background"], `${path}.background`, problems);
+    }
+}
+//# sourceMappingURL=sizes.js.map

package/dist/validate/sizes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sizes.js","sourceRoot":"","sources":["../../src/validate/sizes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,KAAc,EAAE,QAAkB;IAC3D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO;IACT,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5C,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;QACvC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE1C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,SAAS;QACX,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACjE,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC/D,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC5D,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,IAAI,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtE,CAAC;AACH,CAAC"}

package/dist/validate/suggest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The known name a mistyped one was most likely meant to be, or `undefined`
+ * when nothing is close enough. A confident suggestion of something unrelated
+ * is worse than none, so the tolerance stays under the length of the name:
+ * a slip of a key or two earns a suggestion, a different word does not.
+ */
+export declare function nearestName(name: string, known: readonly string[]): string | undefined;
+/** Report one unknown option, naming the likeliest thing it was meant to be. */
+export declare function describeUnknownOption(path: string, key: string, known: readonly string[]): string;
+//# sourceMappingURL=suggest.d.ts.map

package/dist/validate/suggest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggest.d.ts","sourceRoot":"","sources":["../../src/validate/suggest.ts"],"names":[],"mappings":"AAsCA;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,MAAM,GAAG,SAAS,CAmBpB;AAED,gFAAgF;AAChF,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,MAAM,CAQR"}

package/dist/validate/suggest.js

@@ -0,0 +1,55 @@
+/**
+ * Options that have been renamed, keyed by where the old name turns up.
+ * Edit distance cannot connect a rename that changed the word — `dimensions`
+ * became `sizes` — and a config carried over from an older version is exactly
+ * where a bare "unknown option" helps least.
+ */
+const renamedOptions = new Map([["dimensions", "sizes"]]);
+/**
+ * Levenshtein distance between two strings, used to work out which option a
+ * typo was aiming at. Both strings are option names and the lists are a
+ * handful of entries long, so the plain two-row dynamic program is ample.
+ */
+function editDistance(a, b) {
+    let previous = Array.from({ length: b.length + 1 }, (_, index) => index);
+    for (let row = 1; row <= a.length; row += 1) {
+        const current = [row];
+        for (let column = 1; column <= b.length; column += 1) {
+            const cost = a[row - 1] === b[column - 1] ? 0 : 1;
+            // Every index here is within the row by construction; the fallbacks are
+            // there for `noUncheckedIndexedAccess` rather than for any real case.
+            current.push(Math.min((previous[column - 1] ?? 0) + cost, (previous[column] ?? 0) + 1, (current[column - 1] ?? 0) + 1));
+        }
+        previous = current;
+    }
+    return previous[b.length] ?? 0;
+}
+/**
+ * The known name a mistyped one was most likely meant to be, or `undefined`
+ * when nothing is close enough. A confident suggestion of something unrelated
+ * is worse than none, so the tolerance stays under the length of the name:
+ * a slip of a key or two earns a suggestion, a different word does not.
+ */
+export function nearestName(name, known) {
+    const tolerance = Math.min(name.length - 1, Math.max(2, Math.ceil(name.length / 4)));
+    let nearest;
+    let shortest = Infinity;
+    for (const candidate of known) {
+        // Case-insensitive: `tabsize` for `tabSize` is the same slip as a typo.
+        const distance = editDistance(name.toLowerCase(), candidate.toLowerCase());
+        if (distance < shortest) {
+            nearest = candidate;
+            shortest = distance;
+        }
+    }
+    return shortest <= tolerance ? nearest : undefined;
+}
+/** Report one unknown option, naming the likeliest thing it was meant to be. */
+export function describeUnknownOption(path, key, known) {
+    const suggestion = renamedOptions.get(path) ?? nearestName(key, known);
+    if (suggestion !== undefined) {
+        return `Unknown option "${path}". Did you mean "${suggestion}"?`;
+    }
+    return `Unknown option "${path}". Valid options here: ${known.join(", ")}.`;
+}
+//# sourceMappingURL=suggest.js.map

package/dist/validate/suggest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggest.js","sourceRoot":"","sources":["../../src/validate/suggest.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,cAAc,GAAG,IAAI,GAAG,CAAiB,CAAC,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;AAE1E;;;;GAIG;AACH,SAAS,YAAY,CAAC,CAAS,EAAE,CAAS;IACxC,IAAI,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAEzE,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAEtB,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,wEAAwE;YACxE,sEAAsE;YACtE,OAAO,CAAC,IAAI,CACV,IAAI,CAAC,GAAG,CACN,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,EAClC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAC3B,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAC/B,CACF,CAAC;QACJ,CAAC;QAED,QAAQ,GAAG,OAAO,CAAC;IACrB,CAAC;IAED,OAAO,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CACzB,IAAY,EACZ,KAAwB;IAExB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CACxB,IAAI,CAAC,MAAM,GAAG,CAAC,EACf,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACxC,CAAC;IACF,IAAI,OAA2B,CAAC;IAChC,IAAI,QAAQ,GAAG,QAAQ,CAAC;IAExB,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,wEAAwE;QACxE,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;QAE3E,IAAI,QAAQ,GAAG,QAAQ,EAAE,CAAC;YACxB,OAAO,GAAG,SAAS,CAAC;YACpB,QAAQ,GAAG,QAAQ,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,IAAI,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,qBAAqB,CACnC,IAAY,EACZ,GAAW,EACX,KAAwB;IAExB,MAAM,UAAU,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAEvE,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,mBAAmB,IAAI,oBAAoB,UAAU,IAAI,CAAC;IACnE,CAAC;IAED,OAAO,mBAAmB,IAAI,0BAA0B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AAC9E,CAAC"}

package/dist/validate/values.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Report a value that is not one of the names a field accepts. `noun` names
+ * the field, `plural` heads the list of what it does accept.
+ */
+export declare function describeUnknownValue(noun: string, plural: string, value: string, known: readonly string[]): string;
+/**
+ * Check a background against the keys of whichever variant it declares.
+ *
+ * A misspelt `type` is worth reporting on its own: `backgroundSvg` treats
+ * anything that is not `solid` as a gradient, so `gradiant` silently becomes
+ * one and then falls over on the stops it does not have. A background with no
+ * `type` at all is left alone — the type is what says which keys apply, and
+ * guessing would report the keys rather than the omission.
+ */
+export declare function checkBackground(background: unknown, path: string, problems: string[]): void;
+/**
+ * Check the slug strategy names a real one. Only a string can be a strategy;
+ * anything else is a shape the type checker already covers, as elsewhere here.
+ */
+export declare function checkSlugStrategy(content: unknown, problems: string[]): void;
+//# sourceMappingURL=values.d.ts.map

package/dist/validate/values.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"values.d.ts","sourceRoot":"","sources":["../../src/validate/values.ts"],"names":[],"mappings":"AAWA;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,MAAM,CAMR;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,OAAO,EACnB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAAE,GACjB,IAAI,CAyBN;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAmB5E"}

package/dist/validate/values.js

@@ -0,0 +1,57 @@
+import { checkEach, checkKeys, isRecord } from "./check.js";
+import { backgroundTypes, gradientBackgroundKeys, gradientPointKeys, gradientStopKeys, slugStrategies, solidBackgroundKeys, } from "./keys.js";
+import { nearestName } from "./suggest.js";
+/**
+ * Report a value that is not one of the names a field accepts. `noun` names
+ * the field, `plural` heads the list of what it does accept.
+ */
+export function describeUnknownValue(noun, plural, value, known) {
+    const suggestion = nearestName(value, known);
+    return suggestion === undefined
+        ? `Unknown ${noun} "${value}". Valid ${plural}: ${known.join(", ")}.`
+        : `Unknown ${noun} "${value}". Did you mean "${suggestion}"?`;
+}
+/**
+ * Check a background against the keys of whichever variant it declares.
+ *
+ * A misspelt `type` is worth reporting on its own: `backgroundSvg` treats
+ * anything that is not `solid` as a gradient, so `gradiant` silently becomes
+ * one and then falls over on the stops it does not have. A background with no
+ * `type` at all is left alone — the type is what says which keys apply, and
+ * guessing would report the keys rather than the omission.
+ */
+export function checkBackground(background, path, problems) {
+    if (!isRecord(background)) {
+        return;
+    }
+    const { type, stops, from, to } = background;
+    if (type === "solid") {
+        checkKeys(background, path, solidBackgroundKeys, problems);
+        return;
+    }
+    if (type === "gradient") {
+        checkKeys(background, path, gradientBackgroundKeys, problems);
+        checkEach(stops, `${path}.stops`, gradientStopKeys, problems);
+        checkKeys(from, `${path}.from`, gradientPointKeys, problems);
+        checkKeys(to, `${path}.to`, gradientPointKeys, problems);
+        return;
+    }
+    if (typeof type === "string") {
+        problems.push(describeUnknownValue("background type", "types", type, backgroundTypes));
+    }
+}
+/**
+ * Check the slug strategy names a real one. Only a string can be a strategy;
+ * anything else is a shape the type checker already covers, as elsewhere here.
+ */
+export function checkSlugStrategy(content, problems) {
+    if (!isRecord(content)) {
+        return;
+    }
+    const strategy = content["slugStrategy"];
+    if (typeof strategy !== "string" || slugStrategies.includes(strategy)) {
+        return;
+    }
+    problems.push(describeUnknownValue("slug strategy", "strategies", strategy, slugStrategies));
+}
+//# sourceMappingURL=values.js.map

package/dist/validate/values.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"values.js","sourceRoot":"","sources":["../../src/validate/values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,mBAAmB,GACpB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAY,EACZ,MAAc,EACd,KAAa,EACb,KAAwB;IAExB,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAE7C,OAAO,UAAU,KAAK,SAAS;QAC7B,CAAC,CAAC,WAAW,IAAI,KAAK,KAAK,YAAY,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QACrE,CAAC,CAAC,WAAW,IAAI,KAAK,KAAK,oBAAoB,UAAU,IAAI,CAAC;AAClE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,UAAmB,EACnB,IAAY,EACZ,QAAkB;IAElB,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,UAAU,CAAC;IAE7C,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAC3D,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,sBAAsB,EAAE,QAAQ,CAAC,CAAC;QAC9D,SAAS,CAAC,KAAK,EAAE,GAAG,IAAI,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAC9D,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAC7D,SAAS,CAAC,EAAE,EAAE,GAAG,IAAI,KAAK,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QACzD,OAAO;IACT,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAAC,iBAAiB,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,CAAC,CACxE,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAgB,EAAE,QAAkB;IACpE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEzC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtE,OAAO;IACT,CAAC;IAED,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAClB,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,cAAc,CACf,CACF,CAAC;AACJ,CAAC"}

package/dist/validate.d.ts

@@ -0,0 +1,15 @@
+import type { ColophonConfig } from "./types.js";
+/**
+ * Reject a config carrying options Colophon does not know.
+ *
+ * An unrecognised key is otherwise ignored in silence: the build succeeds, the
+ * option does nothing, and the images come out with the defaults in its place.
+ * That is at its worst across an upgrade, where a config that still reads
+ * correctly is describing images nobody is rendering.
+ *
+ * Only the closed parts of the config are checked. The names in `templates`
+ * are the project's own, and a post's props are open by design — a template
+ * reads whatever fields it understands.
+ */
+export declare function validateConfig(config: ColophonConfig): void;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,cAAc,EAMf,MAAM,YAAY,CAAC;AAsWpB;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAkC3D"}