@kensio/colophon 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,198 @@
+# @kensio/colophon
+
+Generate social meta images (Open Graph / share-card images) for the posts of a
+static website, driven by each post's frontmatter.
+
+You describe an image in frontmatter — `title`, `subtitle`, `version`, a
+template name — and Colophon renders branded PNGs at the sizes you need. The
+name comes from the printer's _colophon_: the emblem a publisher stamps on a
+finished work.
+
+- **Frontmatter-driven** — general props read from a post, not a fixed schema.
+- **Templates** — a small registry of layouts; frontmatter picks one.
+- **Configurable branding** — colours, gradient, fonts, footer and badge come
+  from config, not from any one site's stylesheet.
+- **Multiple sizes from one input** — a 1:1 square plus a 1.91:1 landscape by
+  default, or whatever set you configure.
+- **Small, reusable API** — a render core with no filesystem concerns, plus an
+  optional content walker and CLI.
+
+## Install
+
+```bash
+pnpm add @kensio/colophon
+```
+
+`sharp` is a dependency and does the SVG → PNG rasterisation.
+
+## Quick start (CLI)
+
+Add image props to a post's frontmatter:
+
+```yaml
+---
+title: My post
+meta_img_props:
+  template: banner
+  title: "@kensio/colophon"
+  subtitle: Generate social meta images from frontmatter
+  version: 1.2.0
+---
+```
+
+Create a config module (optional — omit to use the neutral defaults):
+
+```ts
+// colophon.config.ts
+import { defineConfig } from "@kensio/colophon";
+
+export default defineConfig({
+  colors: { brand: "#2563eb", brandDark: "#1e3a8a", brandWarm: "#f59e0b" },
+  footer: "example.com",
+  badge: { text: "npm" },
+});
+```
+
+Run it over a content tree:
+
+```bash
+colophon content --config colophon.config.ts
+```
+
+For every file that declares `meta_img_props`, Colophon writes a PNG next to it
+(`post/index.md` → `post/post.png`, plus `post/post-1200x630.png` for the extra
+size). Existing files are skipped unless you pass `--overwrite`.
+
+```
+colophon [contentDir] [options]
+
+  -c, --config <path>   Config module whose default export is a ColophonConfig
+  -o, --overwrite       Re-render even if the output file already exists
+  -h, --help            Show help
+
+  contentDir            defaults to "content"
+```
+
+## Programmatic use
+
+### Render from props (core)
+
+The core takes props and config and returns rendered bytes — no filesystem, no
+content discovery:
+
+```ts
+import { renderMetaImages } from "@kensio/colophon";
+import { writeFile } from "node:fs/promises";
+
+const images = await renderMetaImages(
+  {
+    template: "banner",
+    title: "@kensio/colophon",
+    subtitle: "Generate social meta images from frontmatter",
+    version: "1.2.0",
+  },
+  {
+    colors: { brand: "#2563eb" },
+    footer: "example.com",
+    badge: { text: "npm" },
+  },
+);
+
+for (const image of images) {
+  const { width, height } = image.dimensions;
+  await writeFile(`card-${width}x${height}.png`, image.png);
+}
+```
+
+### Walk content + generate (host helpers)
+
+`walkContent` finds `.md` files and reads their frontmatter; `generate` ties
+walking, rendering and writing together (this is what the CLI uses):
+
+```ts
+import { generate } from "@kensio/colophon";
+
+await generate({
+  contentDir: "content",
+  config: { colors: { brand: "#2563eb" } },
+  overwrite: false,
+  onResult: (result) =>
+    console.log(`${result.skipped ? "skip" : "wrote"} ${result.outputPath}`),
+});
+```
+
+Import the walker on its own from the `@kensio/colophon/content` subpath if you
+only want frontmatter discovery.
+
+## Templates
+
+| Name     | Layout                                                                       |
+| -------- | ---------------------------------------------------------------------------- |
+| `banner` | Left-aligned title with optional version, subtitle, corner badge and footer. |
+| `card`   | Minimal centred title with an optional subtitle.                             |
+
+Register your own by passing `templates` in config — a template is `{ name,
+render(context) }` returning SVG foreground content. Anything you add merges
+over (and can override) the built-ins.
+
+## Configuration
+
+All fields are optional; sensible defaults apply.
+
+| Option       | Default                        | Notes                                               |
+| ------------ | ------------------------------ | --------------------------------------------------- |
+| `colors`     | neutral indigo/pink            | `brand`, `brandDark`, `brandWarm`, `foreground`.    |
+| `background` | gradient derived from `colors` | Or a `{ type: "solid" }` / custom gradient.         |
+| `fontFamily` | `Arial, Helvetica, sans-serif` | Uses fonts available to `sharp`/librsvg.            |
+| `footer`     | none                           | Footer text; omit the field for none.               |
+| `badge`      | none                           | Corner badge for `banner`; omit the field for none. |
+| `dimensions` | `1200×1200` and `1200×630`     | Any list of `{ width, height }`.                    |
+| `templates`  | `banner`, `card`               | Merged over the built-ins.                          |
+
+### Frontmatter shape
+
+By default Colophon reads a `meta_img_props` object and a `template` field
+within it. Both are configurable via walk options (`propsKey`, `templateField`,
+`defaultTemplate`, `extensions`) so you can match an existing convention.
+
+## Sample output
+
+These are generated by [`scripts/gen-samples.ts`](scripts/gen-samples.ts) — run
+`pnpm samples` to regenerate them after changing a template, then commit the
+updated PNGs so this gallery stays in sync.
+
+<table>
+  <tr>
+    <td width="50%">
+      <img src="docs/samples/banner-square.png" alt="banner template, square" width="100%" /><br />
+      <sub><code>banner</code> · 1200×1200 · gradient, badge, version, subtitle, footer</sub>
+    </td>
+    <td width="50%">
+      <img src="docs/samples/card-square.png" alt="card template, square" width="100%" /><br />
+      <sub><code>card</code> · 1200×1200 · centred title and subtitle</sub>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <img src="docs/samples/banner-wide.png" alt="banner template, landscape" width="100%" /><br />
+      <sub><code>banner</code> · 1200×630 · the same input at Open Graph size</sub>
+    </td>
+    <td>
+      <img src="docs/samples/card-wide-solid.png" alt="card template, solid background" width="100%" /><br />
+      <sub><code>card</code> · 1200×630 · solid background, title only</sub>
+    </td>
+  </tr>
+</table>
+
+## Development
+
+- `pnpm build` — compile to `dist/`.
+- `pnpm test` / `pnpm test:coverage` — run Vitest.
+- `pnpm lint` — ESLint + Prettier check.
+- `pnpm fmt` — auto-fix.
+- `pnpm samples` — regenerate the README sample images into `docs/samples/`.
+- `pnpm check` — format, typecheck and test with coverage (run before committing).
+
+## License
+
+Apache-2.0

package/dist/background.d.ts

@@ -0,0 +1,8 @@
+import type { Background, Dimensions } from "./types.js";
+/**
+ * Render a full-bleed background as SVG. For a gradient, this emits a `<defs>`
+ * block with a `<linearGradient>` (using the given `id`) followed by a filled
+ * rect; for a solid colour it emits just the rect.
+ */
+export declare function backgroundSvg(background: Background, dimensions: Dimensions, id: string): string;
+//# sourceMappingURL=background.d.ts.map

package/dist/background.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"background.d.ts","sourceRoot":"","sources":["../src/background.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEzD;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,UAAU,EACtB,EAAE,EAAE,MAAM,GACT,MAAM,CAqBR"}

package/dist/background.js

@@ -0,0 +1,22 @@
+/**
+ * Render a full-bleed background as SVG. For a gradient, this emits a `<defs>`
+ * block with a `<linearGradient>` (using the given `id`) followed by a filled
+ * rect; for a solid colour it emits just the rect.
+ */
+export function backgroundSvg(background, dimensions, id) {
+    const { width, height } = dimensions;
+    if (background.type === "solid") {
+        return `<rect width="${String(width)}" height="${String(height)}" fill="${background.color}"/>`;
+    }
+    const from = background.from ?? { x: 0, y: 0 };
+    const to = background.to ?? { x: 1, y: 1 };
+    const stops = background.stops
+        .map((stop) => `<stop offset="${stop.offset}" stop-color="${stop.color}"/>`)
+        .join("");
+    return (`<defs>` +
+        `<linearGradient id="${id}" x1="${String(from.x)}" y1="${String(from.y)}"` +
+        ` x2="${String(to.x)}" y2="${String(to.y)}">${stops}</linearGradient>` +
+        `</defs>` +
+        `<rect width="${String(width)}" height="${String(height)}" fill="url(#${id})"/>`);
+}
+//# sourceMappingURL=background.js.map

package/dist/background.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"background.js","sourceRoot":"","sources":["../src/background.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAC3B,UAAsB,EACtB,UAAsB,EACtB,EAAU;IAEV,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAErC,IAAI,UAAU,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAChC,OAAO,gBAAgB,MAAM,CAAC,KAAK,CAAC,aAAa,MAAM,CAAC,MAAM,CAAC,WAAW,UAAU,CAAC,KAAK,KAAK,CAAC;IAClG,CAAC;IAED,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IAC/C,MAAM,EAAE,GAAG,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IAE3C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK;SAC3B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iBAAiB,IAAI,CAAC,MAAM,iBAAiB,IAAI,CAAC,KAAK,KAAK,CAAC;SAC3E,IAAI,CAAC,EAAE,CAAC,CAAC;IAEZ,OAAO,CACL,QAAQ;QACR,uBAAuB,EAAE,SAAS,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG;QAC1E,QAAQ,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,mBAAmB;QACtE,SAAS;QACT,gBAAgB,MAAM,CAAC,KAAK,CAAC,aAAa,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CACjF,CAAC;AACJ,CAAC"}

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+import path from "node:path";
+import { pathToFileURL } from "node:url";
+import { generate } from "./generate.js";
+const usage = `colophon — generate social meta images from frontmatter
+
+Usage:
+  colophon [contentDir] [options]
+
+Options:
+  -c, --config <path>   Load a config module (default export = ColophonConfig)
+  -o, --overwrite       Re-render images even if the output file exists
+  -h, --help            Show this help
+
+Defaults:
+  contentDir            content`;
+function parseCliArgs(argv) {
+    let contentDir = "content";
+    let configPath;
+    let shouldOverwrite = false;
+    for (let index = 0; index < argv.length; index += 1) {
+        const arg = argv[index];
+        if (arg === "-c" || arg === "--config") {
+            index += 1;
+            const value = argv[index];
+            if (value === undefined) {
+                throw new Error(`Missing value for ${arg}`);
+            }
+            configPath = value;
+        }
+        else if (arg === "-o" || arg === "--overwrite") {
+            shouldOverwrite = true;
+        }
+        else if (arg !== undefined && !arg.startsWith("-")) {
+            contentDir = arg;
+        }
+    }
+    return { contentDir, configPath, overwrite: shouldOverwrite };
+}
+async function loadConfig(configPath) {
+    if (configPath === undefined) {
+        return undefined;
+    }
+    const url = pathToFileURL(path.resolve(configPath)).href;
+    const module = (await import(url));
+    return module.default;
+}
+async function main() {
+    const argv = process.argv.slice(2);
+    if (argv.includes("-h") || argv.includes("--help")) {
+        console.log(usage);
+        return;
+    }
+    const args = parseCliArgs(argv);
+    const config = await loadConfig(args.configPath);
+    const results = await generate({
+        contentDir: args.contentDir,
+        overwrite: args.overwrite,
+        ...(config !== undefined && { config }),
+        onResult: (result) => {
+            console.log(`${result.skipped ? "skip " : "wrote"} ${result.outputPath}`);
+        },
+    });
+    const written = results.filter((result) => !result.skipped).length;
+    console.log(`Done: ${String(written)} written, ${String(results.length - written)} skipped.`);
+}
+try {
+    await main();
+}
+catch (error) {
+    console.error(error instanceof Error ? error.message : String(error));
+    process.exitCode = 1;
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AASzC,MAAM,KAAK,GAAG;;;;;;;;;;;gCAWkB,CAAC;AAEjC,SAAS,YAAY,CAAC,IAAuB;IAC3C,IAAI,UAAU,GAAG,SAAS,CAAC;IAC3B,IAAI,UAA8B,CAAC;IACnC,IAAI,eAAe,GAAG,KAAK,CAAC;IAE5B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAExB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;YACvC,KAAK,IAAI,CAAC,CAAC;YACX,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAC;YAC9C,CAAC;YACD,UAAU,GAAG,KAAK,CAAC;QACrB,CAAC;aAAM,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YACjD,eAAe,GAAG,IAAI,CAAC;QACzB,CAAC;aAAM,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACrD,UAAU,GAAG,GAAG,CAAC;QACnB,CAAC;IACH,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;AAChE,CAAC;AAED,KAAK,UAAU,UAAU,CACvB,UAA8B;IAE9B,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;IACzD,MAAM,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,GAAG,CAAC,CAAiC,CAAC;IACnE,OAAO,MAAM,CAAC,OAAO,CAAC;AACxB,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEnC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACnB,OAAO;IACT,CAAC;IAED,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAEjD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC;QAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,EAAE,MAAM,EAAE,CAAC;QACvC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE;YACnB,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QAC5E,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IACnE,OAAO,CAAC,GAAG,CACT,SAAS,MAAM,CAAC,OAAO,CAAC,aAAa,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,WAAW,CACjF,CAAC;AACJ,CAAC;AAED,IAAI,CAAC;IACH,MAAM,IAAI,EAAE,CAAC;AACf,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,17 @@
+import type { BrandColors, ColophonConfig, Dimensions, ResolvedConfig } from "./types.js";
+/** Default output sizes: a 1:1 square plus a 1.91:1 landscape (Open Graph). */
+export declare const DEFAULT_DIMENSIONS: readonly Dimensions[];
+/** Default font stack. Override via `config.fontFamily` for branded fonts. */
+export declare const DEFAULT_FONT_FAMILY = "Arial, Helvetica, sans-serif";
+/** Neutral default palette, used when no `colors.brand` is supplied. */
+export declare const DEFAULT_COLORS: Required<BrandColors>;
+/**
+ * Identity helper that returns its argument typed as {@link ColophonConfig}.
+ * Use it in a config module to get editor completion and type-checking.
+ */
+export declare function defineConfig(config: ColophonConfig): ColophonConfig;
+/**
+ * Apply defaults to a user config. Safe to call with no argument.
+ */
+export declare function resolveConfig(config?: ColophonConfig): ResolvedConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,WAAW,EACX,cAAc,EACd,UAAU,EACV,cAAc,EACf,MAAM,YAAY,CAAC;AAEpB,+EAA+E;AAC/E,eAAO,MAAM,kBAAkB,EAAE,SAAS,UAAU,EAGnD,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,mBAAmB,iCAAiC,CAAC;AAElE,wEAAwE;AACxE,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,WAAW,CAKhD,CAAC;AAEF;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAEnE;AA4BD;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,GAAE,cAAmB,GAAG,cAAc,CAgBzE"}

package/dist/config.js

@@ -0,0 +1,64 @@
+import { builtinTemplates } from "./templates/index.js";
+/** Default output sizes: a 1:1 square plus a 1.91:1 landscape (Open Graph). */
+export const DEFAULT_DIMENSIONS = [
+    { width: 1200, height: 1200 },
+    { width: 1200, height: 630 },
+];
+/** Default font stack. Override via `config.fontFamily` for branded fonts. */
+export const DEFAULT_FONT_FAMILY = "Arial, Helvetica, sans-serif";
+/** Neutral default palette, used when no `colors.brand` is supplied. */
+export const DEFAULT_COLORS = {
+    brand: "#4f46e5",
+    brandDark: "#3730a3",
+    brandWarm: "#db2777",
+    foreground: "#ffffff",
+};
+/**
+ * Identity helper that returns its argument typed as {@link ColophonConfig}.
+ * Use it in a config module to get editor completion and type-checking.
+ */
+export function defineConfig(config) {
+    return config;
+}
+function resolveColors(colors) {
+    if (colors === undefined) {
+        return DEFAULT_COLORS;
+    }
+    // When a project supplies only `brand`, use it for the whole gradient rather
+    // than mixing in the neutral defaults, which would clash.
+    return {
+        brand: colors.brand,
+        brandDark: colors.brandDark ?? colors.brand,
+        brandWarm: colors.brandWarm ?? colors.brand,
+        foreground: colors.foreground ?? DEFAULT_COLORS.foreground,
+    };
+}
+function defaultBackground(colors) {
+    return {
+        type: "gradient",
+        stops: [
+            { offset: "0%", color: colors.brandDark },
+            { offset: "55%", color: colors.brand },
+            { offset: "100%", color: colors.brandWarm },
+        ],
+    };
+}
+/**
+ * Apply defaults to a user config. Safe to call with no argument.
+ */
+export function resolveConfig(config = {}) {
+    const colors = resolveColors(config.colors);
+    const dimensions = config.dimensions && config.dimensions.length > 0
+        ? config.dimensions
+        : DEFAULT_DIMENSIONS;
+    return {
+        colors,
+        background: config.background ?? defaultBackground(colors),
+        fontFamily: config.fontFamily ?? DEFAULT_FONT_FAMILY,
+        footer: config.footer,
+        badge: config.badge,
+        dimensions,
+        templates: { ...builtinTemplates, ...config.templates },
+    };
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AASxD,+EAA+E;AAC/E,MAAM,CAAC,MAAM,kBAAkB,GAA0B;IACvD,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IAC7B,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE;CAC7B,CAAC;AAEF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,8BAA8B,CAAC;AAElE,wEAAwE;AACxE,MAAM,CAAC,MAAM,cAAc,GAA0B;IACnD,KAAK,EAAE,SAAS;IAChB,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,SAAS;IACpB,UAAU,EAAE,SAAS;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAsB;IACjD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,MAA+B;IACpD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,6EAA6E;IAC7E,0DAA0D;IAC1D,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK;QAC3C,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK;QAC3C,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,cAAc,CAAC,UAAU;KAC3D,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,MAA6B;IACtD,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE;YACL,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE;YACzC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE;YACtC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE;SAC5C;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,MAAM,GAAmB,EAAE;IACvD,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,MAAM,UAAU,GACd,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;QAC/C,CAAC,CAAC,MAAM,CAAC,UAAU;QACnB,CAAC,CAAC,kBAAkB,CAAC;IAEzB,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,iBAAiB,CAAC,MAAM,CAAC;QAC1D,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,mBAAmB;QACpD,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,UAAU;QACV,SAAS,EAAE,EAAE,GAAG,gBAAgB,EAAE,GAAG,MAAM,CAAC,SAAS,EAAE;KACxD,CAAC;AACJ,CAAC"}

package/dist/content/index.d.ts

@@ -0,0 +1,39 @@
+import type { MetaImageProps } from "../types.js";
+/**
+ * Options for {@link walkContent}. Only `dir` is required.
+ */
+export interface WalkOptions {
+    /** Root directory to search recursively for content files. */
+    readonly dir: string;
+    /** 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;
+    /** File extensions to include. Default `.md` and `.markdown`. */
+    readonly extensions?: readonly string[];
+}
+/**
+ * A discovered content file with the image props read from its frontmatter.
+ */
+export interface ContentFile {
+    /** Path relative to the walk `dir`. */
+    readonly contentPath: string;
+    /** Absolute path on disk. */
+    readonly absolutePath: string;
+    readonly props: MetaImageProps;
+}
+/**
+ * Extract {@link MetaImageProps} from a parsed frontmatter object, or return
+ * `undefined` if this file should be skipped (no props object, or no usable
+ * template/title). Pure — no filesystem access.
+ */
+export declare function extractProps(frontmatter: Record<string, unknown>, options?: Pick<WalkOptions, "propsKey" | "templateField" | "defaultTemplate">): MetaImageProps | undefined;
+/**
+ * Walk a content tree, read each file's frontmatter with `gray-matter`, and
+ * return the files that declare image props. This is the host-project concern
+ * — finding content and reading frontmatter — kept separate from rendering.
+ */
+export declare function walkContent(options: WalkOptions): Promise<ContentFile[]>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/content/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAsBlD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,8DAA8D;IAC9D,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,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,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,uCAAuC;IACvC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,6BAA6B;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;CAChC;AAMD;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,OAAO,GAAE,IAAI,CACX,WAAW,EACX,UAAU,GAAG,eAAe,GAAG,iBAAiB,CAC5C,GACL,cAAc,GAAG,SAAS,CA+C5B;AA8BD;;;;GAIG;AACH,wBAAsB,WAAW,CAC/B,OAAO,EAAE,WAAW,GACnB,OAAO,CAAC,WAAW,EAAE,CAAC,CAsBxB"}