@kensio/colophon 2.1.0 → 2.3.0

package/dist/types.d.ts

@@ -9,8 +9,10 @@ export interface Dimensions {
  * A named output size. The `name` identifies the size in output filenames
  * (e.g. `og`, `square`) and must be unique within a config, so every
  * generated image gets a distinct, descriptive filename.
+ *
+ * A size may also carry {@link SizeOverrides}, applied only when rendering it.
  */
-export interface OutputSize {
+export interface OutputSize extends SizeOverrides {
     readonly name: string;
     readonly width: number;
     readonly height: number;
@@ -75,7 +77,10 @@ export interface Badge {
 export interface CodeStyle {
     /** Shiki theme name, e.g. `github-dark`, `monokai`, `catppuccin-mocha`. */
     readonly theme?: string;
-    /** Monospace font stack. Must resolve to a font available to `sharp`. */
+    /**
+     * Monospace font stack. Must resolve to a configured font, or to an
+     * installed one when `systemFonts` is on.
+     */
     readonly fontFamily?: string;
     /**
      * Glyph advance width as a fraction of the font size. `0.6` matches most
@@ -89,15 +94,42 @@ export interface CodeStyle {
     readonly tabSize?: number;
     /** Corner radius of the code panel, as a fraction of the smaller side. */
     readonly cornerScale?: number;
-    /** Upper bound on the auto-fitted font size, as a fraction of image height. */
+    /** Upper bound on the auto-fitted font size, as a fraction of image width. */
     readonly maxFontScale?: number;
     /**
-     * Lower bound on the auto-fitted font size, as a fraction of image height.
-     * Code too long to fit at this size is truncated with an ellipsis rather
-     * than shrunk into illegibility.
+     * Lower bound on the auto-fitted font size, as a fraction of image width —
+     * width, because that is what a feed scales a share image to. Code too long
+     * to fit at this size is truncated with an ellipsis rather than shrunk into
+     * illegibility, so raising this trades lines of code for readability and
+     * lowering it does the reverse.
      */
     readonly minFontScale?: number;
 }
+/**
+ * A font to load into the rasteriser, given either as a file path or as the
+ * font's bytes. Supply one entry per font file: weight and style are read from
+ * the file itself, so a bold and a regular face are two entries, and the SVG's
+ * `font-weight` picks between them.
+ *
+ * `family` is optional and does not affect matching — the family name in the
+ * font file does that. When given on the first font it seeds `fontFamily`,
+ * which saves repeating the name for the common single-font case.
+ */
+export type FontSource = {
+    readonly family?: string;
+    /**
+     * Path to a `.ttf`, `.otf`, `.ttc` or `.otc` file, resolved from the
+     * current working directory when relative.
+     */
+    readonly path: string;
+} | {
+    readonly family?: string;
+    /**
+     * The font file's bytes, for fonts loaded from a bundle or fetched at
+     * build time rather than read from disk.
+     */
+    readonly data: Uint8Array;
+};
 /**
  * Image properties, typically read from a post's frontmatter. The schema is
  * intentionally open: templates read whatever fields they understand, so a
@@ -111,6 +143,199 @@ export interface MetaImageProps {
     readonly version?: string | number;
     readonly [key: string]: unknown;
 }
+/**
+ * Build image props from a post's whole frontmatter, so a project can use the
+ * fields it already has rather than adding a props block to every file.
+ *
+ * Return `undefined` to leave a post without images. That is the filter for
+ * drafts, section indexes and anything else in the tree that is not a page
+ * worth sharing — without it, mapping frontmatter would mean an image for every
+ * markdown file there is. It only settles posts that say nothing for
+ * themselves, though: one declaring a props block is rendered either way, since
+ * asking for an image outright beats a blanket rule.
+ *
+ * The returned fields need not be complete: they are merged under whatever the
+ * post declares explicitly, and a missing template falls back to
+ * {@link ContentOptions.defaultTemplate}.
+ */
+export type PropsFromFrontmatter = (frontmatter: Record<string, unknown>) => Record<string, unknown> | undefined;
+/**
+ * How a post's slug — the base name for its images — is derived from its path
+ * when the frontmatter does not declare one.
+ *
+ * - `basename`: the filename without extension, or the parent directory for
+ *   `index.*`. Suits page bundles, where the image sits beside the content.
+ * - `route`: the whole path without extension, with `index.*` standing for its
+ *   directory, so `services/iam/index.md` becomes `services/iam` and a root
+ *   `index.md` becomes `index`. Suits a site addressed by route.
+ */
+export type SlugStrategy = "basename" | "route";
+/**
+ * How to read image props out of a content tree. Every field is optional.
+ *
+ * This is the host-project half of the job — finding posts and understanding
+ * their frontmatter — and is deliberately absent from {@link ResolvedConfig}:
+ * a template is handed the resolved config, and where the props came from is
+ * none of its business.
+ */
+export interface ContentOptions {
+    /** Frontmatter key holding the image props object. Default `meta_img_props`. */
+    readonly propsKey?: string;
+    /** Field within the props object naming the template. Default `template`. */
+    readonly templateField?: string;
+    /** Template to use when the template field is absent. */
+    readonly defaultTemplate?: string;
+    /**
+     * Derive props from a post's existing frontmatter, for a site whose posts
+     * already carry the fields an image needs under different names. An explicit
+     * props object still wins field by field, so per-post overrides keep working.
+     */
+    readonly props?: PropsFromFrontmatter;
+    /**
+     * Top-level frontmatter field to read the post slug from (used as the base
+     * filename). Default `slug`; falls back to the file/directory name.
+     */
+    readonly slugField?: string;
+    /**
+     * How to derive a slug from a post's path when its frontmatter declares
+     * none. Default `basename`.
+     */
+    readonly slugStrategy?: SlugStrategy;
+    /** File extensions to include. Default `.md` and `.markdown`. */
+    readonly extensions?: readonly string[];
+}
+/**
+ * A discovered content file with the image props read from its frontmatter.
+ *
+ * It lives here rather than with the walker so that {@link Placement} can name
+ * it without the config module depending on the content module, for the reason
+ * {@link ContentOptions} does.
+ */
+export interface ContentFile {
+    /** Path relative to the walk `dir`. */
+    readonly contentPath: string;
+    /** Absolute path on disk. */
+    readonly absolutePath: string;
+    /** Base filename for this post's images (frontmatter slug, or path-derived). */
+    readonly slug: string;
+    readonly props: MetaImageProps;
+}
+/**
+ * Where an image is written, and the URL it is served at once it is.
+ *
+ * `outputPath` alone says where the bytes go and nothing about how anyone
+ * reaches them, so every site ends up rebuilding that mapping in its own
+ * templates — from information Colophon had at generate time and threw away.
+ *
+ * - `beside-content`: next to the post, which is the page-bundle convention
+ *   and what Colophon has always done. Still the default.
+ * - `public-dir`: gathered into one directory, as Astro, Eleventy and Vite
+ *   expect. A slug carrying directories keeps them underneath it.
+ * - `custom`: for a site whose mapping is its own — images under a dated
+ *   directory, say.
+ *
+ * `urlBase` is what makes a URL: it is prefixed to the image's path under the
+ * root that placed it, and without one there is no URL, because no directory
+ * on disk says by itself how it is served. It can be a site-relative path
+ * (`/og`) or an absolute one, for images served from a CDN.
+ *
+ * `hash` puts a digest of the image's inputs in its filename, so that changing
+ * a post gives its image a URL nobody has cached yet. It is opt-in because it
+ * also means the filename moves whenever the image does, which not every setup
+ * wants. `custom` has no say in it: a placement naming its own paths is the
+ * one that can hash them itself.
+ */
+export type Placement = {
+    readonly strategy: "beside-content";
+    readonly urlBase?: string;
+    readonly hash?: boolean;
+} | {
+    readonly strategy: "public-dir";
+    /** Directory to gather images into, relative to the working directory. */
+    readonly dir: string;
+    readonly urlBase?: string;
+    readonly hash?: boolean;
+} | {
+    readonly strategy: "custom";
+    readonly path: (file: ContentFile, size: OutputSize) => string;
+    /** Omit for images that are written but not served. */
+    readonly url?: (file: ContentFile, size: OutputSize) => string | undefined;
+};
+/**
+ * One image in the manifest.
+ *
+ * The dimensions are the ones it was actually rendered at, which is the point:
+ * sites hardcode 1200 and 630 into their meta tags because nothing told them
+ * otherwise, and a size they later change leaves the tags behind.
+ */
+export interface ManifestImage {
+    /** Absent where the placement knows no URL — see {@link Placement}. */
+    readonly url?: string;
+    readonly width: number;
+    readonly height: number;
+}
+/** One page's images, keyed by output size name. */
+export interface ManifestPage {
+    readonly images: Readonly<Record<string, ManifestImage>>;
+    /**
+     * The name of the most landscape image, by aspect ratio, with ties going to
+     * the first size configured. It is what a `summary_large_image` card wants,
+     * and picking it is a check every site currently writes for itself.
+     */
+    readonly widest: string;
+    /** Alt text, from the props' title. Absent for a page that has no title. */
+    readonly alt?: string;
+}
+/**
+ * What a build generated, for the site to read back: a JSON file listing every
+ * page's images, their URLs and the dimensions they were rendered at.
+ *
+ * Without it a site reconstructs all of that in template code — globbing for
+ * `*-og.png` to find the landscape variant, or writing image paths back into
+ * each post's frontmatter. All of it is known while generating.
+ *
+ * Pages are keyed by slug, which is what a site addresses a page by: with
+ * `slugStrategy: "route"` that is the route itself.
+ */
+export interface Manifest {
+    /** Schema version, so a reader can tell what it is holding. */
+    readonly version: 1;
+    readonly pages: Readonly<Record<string, ManifestPage>>;
+}
+/**
+ * One `<meta>` tag, as the attributes it carries.
+ *
+ * Open Graph names its tags with `property` and Twitter with `name`, which is
+ * a distinction sites get wrong routinely. Keeping them apart in the type
+ * means a component can spread a tag — `<meta {...tag} />` — and be right
+ * either way.
+ */
+export type MetaTag = {
+    readonly property: string;
+    readonly content: string;
+} | {
+    readonly name: string;
+    readonly content: string;
+};
+/** Options for {@link MetaTag} generation. */
+export interface MetaTagOptions {
+    /**
+     * Absolute base for a site-relative image URL, e.g. `https://example.com`.
+     *
+     * Open Graph wants an absolute URL — a crawler has no page to resolve a
+     * relative one against — and a manifest records whatever the placement's
+     * `urlBase` said, which is usually site-relative. A URL that is already
+     * absolute is left alone, so a CDN base needs nothing here.
+     */
+    readonly baseUrl?: string;
+}
+/**
+ * Reports something a template had to compromise on — code truncated to stay
+ * legible, so far. Rendering carries on regardless: a share image is worth
+ * having even when the input did not quite fit, but the author should hear
+ * about it rather than discover it in someone else's timeline.
+ */
+export type WarningHandler = (message: string) => void;
 /**
  * Everything a template needs to produce its SVG foreground content.
  */
@@ -140,6 +365,24 @@ export interface ColophonConfig {
     readonly colors?: BrandColors;
     /** Explicit background, overriding the gradient derived from `colors`. */
     readonly background?: Background;
+    /**
+     * Fonts to load into the rasteriser, so the output does not depend on what
+     * the build machine happens to have installed. Supplying any font turns
+     * {@link ColophonConfig.systemFonts} off by default, which is the point:
+     * a laptop, CI and a Docker image then render the same image.
+     */
+    readonly fonts?: readonly FontSource[];
+    /**
+     * Whether to also load the machine's installed fonts. Defaults to `true`
+     * when no `fonts` are configured (nothing else would render) and `false`
+     * when they are. Turn it on alongside `fonts` to fall back to system fonts
+     * for families you have not supplied — at the cost of determinism.
+     */
+    readonly systemFonts?: boolean;
+    /**
+     * Font stack for template text. Defaults to the `family` of the first
+     * configured font, or to `DEFAULT_FONT_FAMILY` when there is none.
+     */
     readonly fontFamily?: string;
     /** Footer text drawn along the bottom edge. Omit (the default) for none. */
     readonly footer?: string;
@@ -147,6 +390,11 @@ export interface ColophonConfig {
     readonly badge?: Badge;
     /** Styling for the `code` template. */
     readonly code?: CodeStyle;
+    /**
+     * Where non-fatal rendering complaints go. Defaults to `console.warn`; pass
+     * a no-op to silence them, or your build's logger to route them.
+     */
+    readonly onWarning?: WarningHandler;
     /**
      * Output sizes, each with a unique `name` used in the filename. Defaults to
      * a 1.91:1 Open Graph landscape plus a 1:1 square (see `DEFAULT_SIZES`).
@@ -154,6 +402,93 @@ export interface ColophonConfig {
     readonly sizes?: readonly OutputSize[];
     /** Extra templates, merged over (and able to override) the built-ins. */
     readonly templates?: Readonly<Record<string, Template>>;
+    /**
+     * How to read props out of the content tree. Used by `generate` and the CLI;
+     * the render core never sees it.
+     */
+    readonly content?: ContentOptions;
+    /**
+     * Where images are written and what URL they end up at. Defaults to
+     * `beside-content`, which is what Colophon did before there was a choice.
+     */
+    readonly placement?: Placement;
+    /**
+     * Where to write a {@link Manifest} of everything the build generated,
+     * relative to the working directory. Omit (the default) to write none.
+     *
+     * Somewhere the site reads data from: `data/colophon.json` for Hugo,
+     * `src/data/` for Astro, `_data/` for Eleventy and Jekyll.
+     */
+    readonly manifest?: string;
+    /**
+     * One-off images that belong to the project rather than to any post — a
+     * package card, a repository social preview. Rendered by the same build, and
+     * skipped or re-rendered on the same stamps.
+     */
+    readonly extra?: readonly ExtraImage[];
+}
+/**
+ * A function a config module may export instead of a config object, so that a
+ * config which has to compute something — brand colours read out of the site's
+ * own stylesheet, say — can still be a config module rather than a script.
+ *
+ * It takes no arguments. Anything it might be handed is either already on the
+ * command line or a decision the config itself is making.
+ */
+export type ColophonConfigFactory = () => ColophonConfig | Promise<ColophonConfig>;
+/** What a config module's default export may be. */
+export type ColophonConfigInput = ColophonConfig | ColophonConfigFactory;
+/**
+ * Config an {@link OutputSize} may override for itself.
+ *
+ * Some settings only make sense per size: `code.minFontScale` is the clearest
+ * case, because a 1:1 square and a 1.91:1 landscape have very different amounts
+ * of vertical room for the same snippet. Without this the only way to vary one
+ * is a `generate` pass per size, which walks and parses the whole content tree
+ * again for each.
+ *
+ * Only what a template reads while drawing is overridable. `fonts`,
+ * `systemFonts` and `templates` are shared build inputs rather than part of the
+ * picture; `onWarning` is where messages go, not what they say; and `sizes`
+ * inside a size would be nonsense.
+ */
+export interface SizeOverrides {
+    /**
+     * Merged over the config's `colors`, so a size can change one shade on its
+     * own — `brand` is optional here precisely because the rest are kept.
+     */
+    readonly colors?: Partial<BrandColors>;
+    /** Replaces the config's background outright — see the note on merging. */
+    readonly background?: Background;
+    readonly fontFamily?: string;
+    readonly footer?: string;
+    readonly badge?: Badge;
+    /** Merged over the config's `code`, so a size can change one setting. */
+    readonly code?: CodeStyle;
+}
+/**
+ * A single image that is not tied to a content file: props, somewhere to write
+ * it, and the size to draw it at.
+ *
+ * The alternative is a script that calls `renderMetaImages` and writes the
+ * bytes itself, which is a lot of machinery for one card — and one that keeps
+ * neither the rebuild stamps nor the build log a content image gets.
+ */
+export interface ExtraImage {
+    readonly props: MetaImageProps;
+    /**
+     * Where to write the PNG, resolved from the current working directory when
+     * relative. This image has no post to sit beside, so there is nothing to
+     * derive a path from and `generate`'s `outputPath` is not consulted.
+     */
+    readonly output: string;
+    /**
+     * The size to render at, {@link SizeOverrides} and all — an inline size is
+     * how a one-off image gets its own footer or palette without a whole entry
+     * in `sizes`. Defaults to the first configured size, since a one-off card
+     * usually wants to match the site's primary share format.
+     */
+    readonly size?: OutputSize;
 }
 /**
  * Fully-resolved configuration with all defaults applied.
@@ -161,10 +496,14 @@ export interface ColophonConfig {
 export interface ResolvedConfig {
     readonly colors: Required<BrandColors>;
     readonly background: Background;
+    /** Configured fonts, with every `path` made absolute. */
+    readonly fonts: readonly FontSource[];
+    readonly systemFonts: boolean;
     readonly fontFamily: string;
     readonly footer: string | undefined;
     readonly badge: Badge | undefined;
     readonly code: Required<CodeStyle>;
+    readonly onWarning: WarningHandler;
     readonly sizes: readonly OutputSize[];
     readonly templates: Readonly<Record<string, Template>>;
 }

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAClD;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IACxC,QAAQ,CAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3D,QAAQ,CAAC,EAAE,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1D,CAAC;AAEN;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,iDAAiD;IACjD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,uDAAuD;IACvD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,kDAAkD;IAClD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,yEAAyE;IACzE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,mEAAmE;IACnE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,0EAA0E;IAC1E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,+EAA+E;IAC/E,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;CACjC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC5D;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAC9B,0EAA0E;IAC1E,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;IACjC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,uCAAuC;IACvC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACvC,yEAAyE;IACzE,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACvC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC/C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAClD;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IACxC,QAAQ,CAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3D,QAAQ,CAAC,EAAE,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1D,CAAC;AAEN;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,iDAAiD;IACjD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,uDAAuD;IACvD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,kDAAkD;IAClD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,mEAAmE;IACnE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,0EAA0E;IAC1E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,8EAA8E;IAC9E,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAClB;IACE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,GACD;IACE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC3B,CAAC;AAEN;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACjC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACjC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;AAEzC;;;;;;;;;GASG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,OAAO,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,6EAA6E;IAC7E,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,yDAAyD;IACzD,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,oBAAoB,CAAC;IACtC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACrC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,uCAAuC;IACvC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,6BAA6B;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,gFAAgF;IAChF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,SAAS,GACjB;IACE,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB,GACD;IACE,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,0EAA0E;IAC1E,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB,GACD;IACE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,KAAK,MAAM,CAAC;IAC/D,uDAAuD;IACvD,QAAQ,CAAC,GAAG,CAAC,EAAE,CACb,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,UAAU,KACb,MAAM,GAAG,SAAS,CAAC;CACzB,CAAC;AAEN;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,uEAAuE;IACvE,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,oDAAoD;AACpD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IACzD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,4EAA4E;IAC5E,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,QAAQ;IACvB,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;CACxD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,OAAO,GACf;IAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACvD;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAExD,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;CACjC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC5D;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAC9B,0EAA0E;IAC1E,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,uCAAuC;IACvC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC;IACpC;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACvC,yEAAyE;IACzE,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IACxD;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;CACxC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAClC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAE3C,oDAAoD;AACpD,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,qBAAqB,CAAC;AAEzE;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACvC,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;IACjC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,yEAAyE;IACzE,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACvC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,yDAAyD;IACzD,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;IACtC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB"}

package/dist/validate/check.d.ts

@@ -0,0 +1,13 @@
+/** Whether a value is a plain object, and so has keys worth checking. */
+export declare function isRecord(value: unknown): value is Record<string, unknown>;
+/** Whether a value is a list, and so has entries worth checking. */
+export declare function isList(value: unknown): value is readonly unknown[];
+/**
+ * Report every key of one config object that is not a known option. Anything
+ * that is not an object is left alone: the shape of a value is the type
+ * checker's business, and there are no keys to judge either way.
+ */
+export declare function checkKeys(value: unknown, path: string, known: readonly string[], problems: string[]): void;
+/** Check every entry of a list, naming each by its index. */
+export declare function checkEach(values: unknown, path: string, known: readonly string[], problems: string[]): void;
+//# sourceMappingURL=check.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/validate/check.ts"],"names":[],"mappings":"AAEA,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE;AAED,oEAAoE;AACpE,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,OAAO,EAAE,CAElE;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,QAAQ,EAAE,MAAM,EAAE,GACjB,IAAI,CAYN;AAED,6DAA6D;AAC7D,wBAAgB,SAAS,CACvB,MAAM,EAAE,OAAO,EACf,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,QAAQ,EAAE,MAAM,EAAE,GACjB,IAAI,CAQN"}

package/dist/validate/check.js

@@ -0,0 +1,34 @@
+import { describeUnknownOption } from "./suggest.js";
+/** Whether a value is a plain object, and so has keys worth checking. */
+export function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/** Whether a value is a list, and so has entries worth checking. */
+export function isList(value) {
+    return Array.isArray(value);
+}
+/**
+ * Report every key of one config object that is not a known option. Anything
+ * that is not an object is left alone: the shape of a value is the type
+ * checker's business, and there are no keys to judge either way.
+ */
+export function checkKeys(value, path, known, problems) {
+    if (!isRecord(value)) {
+        return;
+    }
+    for (const key of Object.keys(value)) {
+        if (!known.includes(key)) {
+            problems.push(describeUnknownOption(path === "" ? key : `${path}.${key}`, key, known));
+        }
+    }
+}
+/** Check every entry of a list, naming each by its index. */
+export function checkEach(values, path, known, problems) {
+    if (!isList(values)) {
+        return;
+    }
+    for (const [index, value] of values.entries()) {
+        checkKeys(value, `${path}[${String(index)}]`, known, problems);
+    }
+}
+//# sourceMappingURL=check.js.map

package/dist/validate/check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.js","sourceRoot":"","sources":["../../src/validate/check.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAErD,yEAAyE;AACzE,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,MAAM,CAAC,KAAc;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CACvB,KAAc,EACd,IAAY,EACZ,KAAwB,EACxB,QAAkB;IAElB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO;IACT,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,QAAQ,CAAC,IAAI,CACX,qBAAqB,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,CACxE,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,SAAS,CACvB,MAAe,EACf,IAAY,EACZ,KAAwB,EACxB,QAAkB;IAElB,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,SAAS,CAAC,KAAK,EAAE,GAAG,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;AACH,CAAC"}

package/dist/validate/index.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=index.d.ts.map

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

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

package/dist/validate/index.js

@@ -0,0 +1,41 @@
+import { checkEach, checkKeys } from "./check.js";
+import { badgeKeys, codeKeys, colorKeys, configKeys, contentKeys, fontKeys, } from "./keys.js";
+import { checkExtras, checkSizes } from "./overrides.js";
+import { checkPlacement } from "./placement.js";
+import { checkBackground, checkSlugStrategy } from "./values.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 function validateConfig(config) {
+    // The types say what should be here; validation exists for when it is not.
+    const raw = config;
+    const problems = [];
+    checkKeys(config, "", configKeys, problems);
+    checkKeys(raw.colors, "colors", colorKeys, problems);
+    checkKeys(raw.badge, "badge", badgeKeys, problems);
+    checkKeys(raw.code, "code", codeKeys, problems);
+    checkKeys(raw.content, "content", contentKeys, problems);
+    checkSlugStrategy(raw.content, problems);
+    checkSizes(raw.sizes, problems);
+    checkExtras(raw.extra, problems);
+    checkEach(raw.fonts, "fonts", fontKeys, problems);
+    checkBackground(raw.background, "background", problems);
+    checkPlacement(raw.placement, problems);
+    const [first, ...rest] = problems;
+    if (first === undefined) {
+        return;
+    }
+    throw new Error(rest.length === 0
+        ? first
+        : `Invalid config:\n${problems.map((problem) => `  - ${problem}`).join("\n")}`);
+}
+//# sourceMappingURL=index.js.map

package/dist/validate/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/validate/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EACL,SAAS,EACT,QAAQ,EACR,SAAS,EACT,UAAU,EACV,WAAW,EACX,QAAQ,GACT,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEjE;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,cAAc,CAAC,MAAsB;IACnD,2EAA2E;IAC3E,MAAM,GAAG,GAAG,MAUX,CAAC;IACF,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,SAAS,CAAC,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC5C,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IACrD,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IACnD,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAChD,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACzD,iBAAiB,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACzC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAChC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACjC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,eAAe,CAAC,GAAG,CAAC,UAAU,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;IACxD,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAExC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,QAAQ,CAAC;IAElC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO;IACT,CAAC;IAED,MAAM,IAAI,KAAK,CACb,IAAI,CAAC,MAAM,KAAK,CAAC;QACf,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,oBAAoB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACjF,CAAC;AACJ,CAAC"}

package/dist/validate/keys.d.ts

@@ -0,0 +1,58 @@
+/** Top-level config options. */
+export declare const configKeys: readonly string[];
+/** Keys of a placement that writes each image beside its post. */
+export declare const besideContentKeys: readonly string[];
+/** Keys of a placement that gathers images into one directory. */
+export declare const publicDirKeys: readonly string[];
+/** Keys of a placement that works both halves out for itself. */
+export declare const customPlacementKeys: readonly string[];
+/**
+ * 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 declare const placementStrategies: readonly string[];
+/** One ad hoc image declared in config. */
+export declare const extraKeys: readonly string[];
+/** Options for reading a project's own frontmatter. */
+export declare const contentKeys: readonly string[];
+/** Brand palette shades. */
+export declare const colorKeys: readonly string[];
+/** Corner-badge options. */
+export declare const badgeKeys: readonly string[];
+/** `code` template styling options. */
+export declare const codeKeys: readonly string[];
+/** One output size, including the overrides it may carry. */
+export declare const sizeKeys: readonly string[];
+/**
+ * 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 declare const fontKeys: string[];
+/** Keys of a solid background. */
+export declare const solidBackgroundKeys: readonly string[];
+/** Keys of a gradient background. */
+export declare const gradientBackgroundKeys: readonly string[];
+/** Keys of one gradient stop. */
+export declare const gradientStopKeys: readonly string[];
+/** Keys of a gradient's `from` and `to` points. */
+export declare const gradientPointKeys: readonly string[];
+/**
+ * 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 declare const backgroundTypes: readonly string[];
+/**
+ * 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 declare const slugStrategies: readonly string[];
+//# sourceMappingURL=keys.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../src/validate/keys.ts"],"names":[],"mappings":"AA0CA,gCAAgC;AAChC,eAAO,MAAM,UAAU,mBAgBrB,CAAC;AAEH,kEAAkE;AAClE,eAAO,MAAM,iBAAiB,mBAI5B,CAAC;AAEH,kEAAkE;AAClE,eAAO,MAAM,aAAa,mBAKxB,CAAC;AAEH,iEAAiE;AACjE,eAAO,MAAM,mBAAmB,mBAI9B,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,mBAQ9B,CAAC;AAEH,2CAA2C;AAC3C,eAAO,MAAM,SAAS,mBAIpB,CAAC;AAEH,uDAAuD;AACvD,eAAO,MAAM,WAAW,mBAQtB,CAAC;AAEH,4BAA4B;AAC5B,eAAO,MAAM,SAAS,mBAKpB,CAAC;AAEH,4BAA4B;AAC5B,eAAO,MAAM,SAAS,mBAIpB,CAAC;AAEH,uCAAuC;AACvC,eAAO,MAAM,QAAQ,mBASnB,CAAC;AAEH,6DAA6D;AAC7D,eAAO,MAAM,QAAQ,mBAUnB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,QAAQ,UAKpB,CAAC;AAEF,kCAAkC;AAClC,eAAO,MAAM,mBAAmB,mBAG9B,CAAC;AAEH,qCAAqC;AACrC,eAAO,MAAM,sBAAsB,mBAKjC,CAAC;AAEH,iCAAiC;AACjC,eAAO,MAAM,gBAAgB,mBAG3B,CAAC;AAEH,mDAAmD;AACnD,eAAO,MAAM,iBAAiB,mBAAiD,CAAC;AAEhF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,mBAG1B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,cAAc,mBAGzB,CAAC"}