@quillmark/registry 0.5.2 → 0.6.0

package/dist/index.d.ts

@@ -7,4 +7,6 @@ export { HttpSource } from './sources/http-source.js';
 export type { HttpSourceOptions } from './sources/http-source.js';
 export { QuillRegistry } from './registry.js';
 export type { QuillRegistryOptions } from './registry.js';
+export { validateQuills } from './validate.js';
+export type { QuillValidationEngine, ValidateQuillsOptions, QuillValidationEntry, ValidateQuillsResult, } from './validate.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACX,SAAS,EACT,aAAa,EACb,aAAa,EACb,WAAW,EACX,WAAW,EACX,SAAS,EACT,eAAe,GACf,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,YAAY,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,YAAY,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,YAAY,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACX,SAAS,EACT,aAAa,EACb,aAAa,EACb,WAAW,EACX,WAAW,EACX,SAAS,EACT,eAAe,GACf,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,YAAY,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,YAAY,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,YAAY,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAG1D,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,YAAY,EACX,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,GACpB,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -7,4 +7,6 @@ export { FileSystemSource } from './sources/file-system-source.js';
 export { HttpSource } from './sources/http-source.js';
 // Registry
 export { QuillRegistry } from './registry.js';
+// Validation
+export { validateQuills } from './validate.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAWA,SAAS;AACT,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,mBAAmB;AACnB,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,UAAU;AACV,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAGtD,WAAW;AACX,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAWA,SAAS;AACT,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,mBAAmB;AACnB,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,UAAU;AACV,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAGtD,WAAW;AACX,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAG9C,aAAa;AACb,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC"}

package/dist/validate.d.ts

@@ -0,0 +1,103 @@
+import type { QuillmarkEngine } from './types.js';
+/**
+ * Engine interface for quill validation.
+ *
+ * Extends the base {@link QuillmarkEngine} with `render()` so the validator
+ * can compile each quill's example document end-to-end.
+ *
+ * Structurally compatible with `@quillmark/wasm`'s `Quillmark` class —
+ * pass a `Quillmark` instance directly without adapters:
+ *
+ * ```ts
+ * import { Quillmark } from '@quillmark/wasm';
+ * const engine: QuillValidationEngine = new Quillmark();
+ * ```
+ */
+export interface QuillValidationEngine extends QuillmarkEngine {
+    render(parsed: {
+        fields: Record<string, unknown>;
+        quillName: string;
+    }, opts: {
+        format?: string;
+    }): {
+        artifacts: Array<{
+            bytes: Uint8Array;
+        }>;
+    };
+}
+/**
+ * Options for {@link validateQuills}.
+ *
+ * Example usage in a collection repo's test suite:
+ *
+ * ```ts
+ * import { validateQuills } from '@quillmark/registry';
+ * import { Quillmark, init } from '@quillmark/wasm';
+ *
+ * init();
+ * const wasm = new Quillmark();
+ * try {
+ *   const { passed, failed, results } = await validateQuills({
+ *     quillsDir: './quills',
+ *     engine: wasm,
+ *     parseMarkdown: Quillmark.parseMarkdown,
+ *   });
+ *   console.log(`${passed} passed, ${failed} failed`);
+ * } finally {
+ *   wasm.free();
+ * }
+ * ```
+ */
+export interface ValidateQuillsOptions {
+    /** Path to the quills directory following the `name/version/` layout. */
+    quillsDir: string;
+    /**
+     * Initialised WASM engine instance (e.g. `new Quillmark()` from `@quillmark/wasm`).
+     *
+     * Must support `registerQuill`, `resolveQuill`, `listQuills`, and `render`.
+     */
+    engine: QuillValidationEngine;
+    /**
+     * Static markdown parser (e.g. `Quillmark.parseMarkdown` from `@quillmark/wasm`).
+     */
+    parseMarkdown: (markdown: string) => {
+        fields: Record<string, unknown>;
+        quillName: string;
+    };
+}
+/** Validation result for a single quill version. */
+export interface QuillValidationEntry {
+    name: string;
+    version: string;
+    /** Whether `registerQuill()` succeeded (validates quill structure). */
+    registered: boolean;
+    /** Whether the quill's example document rendered to non-empty artifacts. */
+    rendered: boolean;
+    /** Error message if any validation step failed. */
+    error?: string;
+}
+/** Aggregate result returned by {@link validateQuills}. */
+export interface ValidateQuillsResult {
+    results: QuillValidationEntry[];
+    /** Number of quills that passed all validation steps. */
+    passed: number;
+    /** Number of quills that failed at least one validation step. */
+    failed: number;
+}
+/**
+ * Validates every quill in a directory by registering it with the WASM engine
+ * and rendering its example document.
+ *
+ * Designed for Quill collection repositories to run as a CI gate before release.
+ * Each quill goes through two validation stages:
+ *
+ * 1. **Registration** — `registerQuill()` validates the quill's file structure,
+ *    `Quill.yaml` schema, and Typst package layout.
+ * 2. **Render** — if the quill includes an example document, it is parsed and
+ *    rendered to the first supported output format (e.g. PDF), confirming that
+ *    the Typst template compiles without error.
+ *
+ * @returns Per-quill results and aggregate pass/fail counts.
+ */
+export declare function validateQuills(options: ValidateQuillsOptions): Promise<ValidateQuillsResult>;
+//# 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":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAa,MAAM,YAAY,CAAC;AAE7D;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC7D,MAAM,CACL,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EAC9D,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GACvB;QAAE,SAAS,EAAE,KAAK,CAAC;YAAE,KAAK,EAAE,UAAU,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC;CAC/C;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,qBAAqB;IACrC,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,MAAM,EAAE,qBAAqB,CAAC;IAE9B;;OAEG;IACH,aAAa,EAAE,CACd,QAAQ,EAAE,MAAM,KACZ;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5D;AAED,oDAAoD;AACpD,MAAM,WAAW,oBAAoB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,UAAU,EAAE,OAAO,CAAC;IACpB,4EAA4E;IAC5E,QAAQ,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,2DAA2D;AAC3D,MAAM,WAAW,oBAAoB;IACpC,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,yDAAyD;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CACnC,OAAO,EAAE,qBAAqB,GAC5B,OAAO,CAAC,oBAAoB,CAAC,CAkD/B"}

package/dist/validate.js

@@ -0,0 +1,64 @@
+import { FileSystemSource } from './sources/file-system-source.js';
+import { QuillRegistry } from './registry.js';
+/**
+ * Validates every quill in a directory by registering it with the WASM engine
+ * and rendering its example document.
+ *
+ * Designed for Quill collection repositories to run as a CI gate before release.
+ * Each quill goes through two validation stages:
+ *
+ * 1. **Registration** — `registerQuill()` validates the quill's file structure,
+ *    `Quill.yaml` schema, and Typst package layout.
+ * 2. **Render** — if the quill includes an example document, it is parsed and
+ *    rendered to the first supported output format (e.g. PDF), confirming that
+ *    the Typst template compiles without error.
+ *
+ * @returns Per-quill results and aggregate pass/fail counts.
+ */
+export async function validateQuills(options) {
+    const { quillsDir, engine, parseMarkdown } = options;
+    const source = new FileSystemSource(quillsDir);
+    const registry = new QuillRegistry({ source, engine });
+    const manifest = await source.getManifest();
+    const results = [];
+    for (const quill of manifest.quills) {
+        const entry = {
+            name: quill.name,
+            version: quill.version,
+            registered: false,
+            rendered: false,
+        };
+        try {
+            // Stage 1: load + register (validates quill structure)
+            const ref = `${quill.name}@${quill.version}`;
+            await registry.resolve(ref);
+            entry.registered = true;
+            // Stage 2: render the example document
+            const info = engine.resolveQuill(quill.name);
+            if (info?.example && info.supportedFormats?.length > 0) {
+                // Replace the colon-style QUILL reference (e.g. "name:0.1") with
+                // the engine-compatible "@" format (e.g. "name@0.1.0")
+                const exampleMd = info.example.replace(/^QUILL:.*$/m, `QUILL: ${ref}`);
+                const parsed = parseMarkdown(exampleMd);
+                const result = engine.render(parsed, {
+                    format: info.supportedFormats[0],
+                });
+                const firstArtifact = result.artifacts[0];
+                if (!firstArtifact || firstArtifact.bytes.length === 0) {
+                    entry.error = 'Render produced no output artifacts';
+                }
+                else {
+                    entry.rendered = true;
+                }
+            }
+        }
+        catch (err) {
+            entry.error = err instanceof Error ? err.message : String(err);
+        }
+        results.push(entry);
+    }
+    const failed = results.filter((r) => r.error !== undefined).length;
+    const passed = results.length - failed;
+    return { results, passed, failed };
+}
+//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAuF9C;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CACnC,OAA8B;IAE9B,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IACrD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,IAAI,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5C,MAAM,OAAO,GAA2B,EAAE,CAAC;IAE3C,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrC,MAAM,KAAK,GAAyB;YACnC,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,KAAK;SACf,CAAC;QAEF,IAAI,CAAC;YACJ,uDAAuD;YACvD,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAC7C,MAAM,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;YAExB,uCAAuC;YACvC,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAqB,CAAC;YACjE,IAAI,IAAI,EAAE,OAAO,IAAI,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxD,iEAAiE;gBACjE,uDAAuD;gBACvD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,GAAG,EAAE,CAAC,CAAC;gBACvE,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;gBACxC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;oBACpC,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;iBAChC,CAAC,CAAC;gBAEH,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC1C,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACxD,KAAK,CAAC,KAAK,GAAG,qCAAqC,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACP,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACvB,CAAC;YACF,CAAC;QACF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,KAAK,CAAC,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;IACnE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;IAEvC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACpC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quillmark/registry",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "Unified API for discovering, loading, packaging, and registering Quills with the WASM engine",
   "main": "./dist/index.js",
   "publishConfig": {