@cadit-app/script-params 0.5.2 → 0.5.4

package/dist/exporters.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Exporter types for CADit parametric scripts.
+ *
+ * Exporters allow scripts to provide custom download formats (SVG, PNG, 3MF, etc.).
+ */
+/**
+ * Result returned by an exporter function.
+ * Contains the file data, MIME type, and suggested filename.
+ */
+export interface ExportResult {
+    /** MIME type of the exported data (e.g., 'image/svg+xml', 'image/png'). */
+    mimeType: string;
+    /** Suggested filename for download (e.g., 'model.svg'). */
+    fileName: string;
+    /** The exported data - string for text formats, ArrayBuffer for binary. */
+    data: ArrayBuffer | string;
+}
+/**
+ * Exporter definition.
+ * Provides a function to export the current state to a downloadable format.
+ *
+ * @template P - The params type. Use `InferParams<typeof myScript>` to derive
+ *               from a script, or define inline when used with defineParams.
+ *
+ * @example Inline with defineParams (type is inferred automatically)
+ * ```typescript
+ * export default defineParams({
+ *   params: { size: { type: 'number', default: 10 } },
+ *   exporters: {
+ *     svg: {
+ *       name: 'SVG',
+ *       export: (p) => ({ ... }), // p.size is typed as number
+ *     },
+ *   },
+ * });
+ * ```
+ *
+ * @example Separate file using InferParams
+ * ```typescript
+ * import type { Exporter, InferParams } from '@cadit-app/script-params';
+ * import type script from './main';
+ *
+ * type Params = InferParams<typeof script>;
+ *
+ * export const pngExporter: Exporter<Params> = {
+ *   name: 'PNG',
+ *   export: (params) => { ... }, // params is fully typed
+ * };
+ * ```
+ */
+export interface Exporter<P = unknown> {
+    /** Short name for the exporter (e.g., 'SVG', 'PNG', '3MF'). */
+    name: string;
+    /** Label shown on the download button (e.g., 'Download SVG'). */
+    label?: string;
+    /** Description or tooltip for the exporter. */
+    description?: string;
+    /**
+     * Optional async initialization function.
+     * Called once before the first export.
+     * Use for WASM initialization or other one-time setup.
+     *
+     * @example
+     * ```typescript
+     * init: async () => {
+     *   const wasm = await __cadit_loadWasm('@resvg/resvg-wasm', 'index_bg.wasm');
+     *   await resvg.initWasm(wasm);
+     * }
+     * ```
+     */
+    init?: () => Promise<void>;
+    /** Export function that receives the current parameter values. */
+    export: (params: P) => Promise<ExportResult> | ExportResult;
+}
+/**
+ * Serializable exporter metadata for passing to UI.
+ * Contains only the display information, not the actual export function.
+ */
+export interface ExporterMetadata {
+    /** The key used to identify this exporter in the exporters record. */
+    key: string;
+    /** Short name for the exporter (e.g., 'SVG', 'PNG', '3MF'). */
+    name: string;
+    /** Label shown on the download button (e.g., 'Download SVG'). */
+    label?: string;
+    /** Description or tooltip for the exporter. */
+    description?: string;
+}
+/**
+ * Map of exporters keyed by identifier.
+ * The key is used to identify the exporter, the value contains the definition.
+ *
+ * @template P - The params type for all exporters in the map.
+ */
+export type Exporters<P = unknown> = Record<string, Exporter<P>>;
+/**
+ * Extract metadata from an Exporter (strips non-serializable functions).
+ * @param key - The key in the exporters record
+ * @param exporter - The exporter definition
+ */
+export declare function getExporterMetadata<P>(key: string, exporter: Exporter<P>): ExporterMetadata;
+/**
+ * Extract metadata array from Exporters record.
+ * Preserves the key for each exporter so it can be looked up later.
+ */
+export declare function getExportersMetadata<P>(exporters: Exporters<P>): ExporterMetadata[];
+//# sourceMappingURL=exporters.d.ts.map

package/dist/exporters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exporters.d.ts","sourceRoot":"","sources":["../src/exporters.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,2EAA2E;IAC3E,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,2EAA2E;IAC3E,IAAI,EAAE,WAAW,GAAG,MAAM,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,OAAO;IACnC,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,kEAAkE;IAClE,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC;CAC7D;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sEAAsE;IACtE,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAMjE;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAO3F;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,gBAAgB,EAAE,CAEnF"}

package/dist/exporters.js

@@ -0,0 +1,29 @@
+/**
+ * Exporter types for CADit parametric scripts.
+ *
+ * Exporters allow scripts to provide custom download formats (SVG, PNG, 3MF, etc.).
+ */
+// =============================================================================
+// Exporter Utility Functions
+// =============================================================================
+/**
+ * Extract metadata from an Exporter (strips non-serializable functions).
+ * @param key - The key in the exporters record
+ * @param exporter - The exporter definition
+ */
+export function getExporterMetadata(key, exporter) {
+    return {
+        key,
+        name: exporter.name,
+        label: exporter.label,
+        description: exporter.description,
+    };
+}
+/**
+ * Extract metadata array from Exporters record.
+ * Preserves the key for each exporter so it can be looked up later.
+ */
+export function getExportersMetadata(exporters) {
+    return Object.entries(exporters).map(([key, exporter]) => getExporterMetadata(key, exporter));
+}
+//# sourceMappingURL=exporters.js.map

package/dist/exporters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exporters.js","sourceRoot":"","sources":["../src/exporters.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAoGH,gFAAgF;AAChF,6BAA6B;AAC7B,gFAAgF;AAEhF;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAI,GAAW,EAAE,QAAqB;IACvE,OAAO;QACL,GAAG;QACH,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,WAAW,EAAE,QAAQ,CAAC,WAAW;KAClC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAI,SAAuB;IAC7D,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;AAChG,CAAC"}