@cadit-app/script-params 0.5.2 → 0.5.3

package/dist/index.js

@@ -19,333 +19,12 @@
  * });
  * ```
  */
-/**
- * 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));
-}
-// =============================================================================
-// Core Functions
-// =============================================================================
-/**
- * Build default values object from a schema.
- * @internal
- */
-function buildDefaults(schema) {
-    const defaults = {};
-    for (const [key, def] of Object.entries(schema)) {
-        if (def.type === 'embedded') {
-            // For embedded params, build a nested default object
-            const embeddedDef = def;
-            defaults[key] = {
-                enabled: embeddedDef.enabled ?? false,
-                showSettings: embeddedDef.showSettings ?? false,
-                params: buildDefaults(embeddedDef.params),
-            };
-        }
-        else {
-            defaults[key] = def.default;
-        }
-    }
-    return defaults;
-}
-/**
- * Define parameters for a parametric script.
- *
- * Pass a config object with `params` (required), and optionally `main` and `exporters`.
- *
- * @example Basic usage
- * ```typescript
- * export default defineParams({
- *   params: {
- *     size: { type: 'number', default: 10 },
- *   },
- *   main: (params) => Manifold.cube([params.size, params.size, params.size]),
- * });
- * ```
- *
- * @example With exporters
- * ```typescript
- * export default defineParams({
- *   params: {
- *     size: { type: 'number', default: 10 },
- *   },
- *   exporters: {
- *     svg: { name: 'SVG', export: (p) => svgExport(p) },
- *     png: { name: 'PNG', export: (p) => pngExport(p) },
- *   },
- *   main: (params) => Manifold.cube([params.size, params.size, params.size]),
- * });
- * ```
- *
- * @example Without main (add main separately with createMain)
- * ```typescript
- * const script = defineParams({
- *   params: { size: { type: 'number', default: 10 } },
- *   exporters: { svg: svgExporter },
- * });
- * export default createMain(script, myMainFunction);
- * ```
- */
-export function defineParams(config) {
-    const { params: schema, main, exporters } = config;
-    const defaults = buildDefaults(schema);
-    const scriptModule = ((inputParams) => {
-        if (!main) {
-            throw new Error('This script does not have a main function. Use createMain() to add one.');
-        }
-        const merged = { ...defaults, ...inputParams };
-        return main(merged);
-    });
-    scriptModule.params = schema;
-    if (exporters) {
-        scriptModule.exporters = exporters;
-    }
-    return scriptModule;
-}
-/**
- * Create an executable script module by adding a main function.
- *
- * Use this when you want to define your main function separately from the params,
- * for example when the main is complex or needs to be tested independently.
- *
- * Preserves any exporters defined on the original ScriptModule.
- *
- * @example
- * ```typescript
- * const script = defineParams({
- *   params: { size: { type: 'number', default: 10 } },
- *   exporters: { svg: svgExporter },
- * });
- *
- * export default createMain(script, (p) => Manifold.cube([p.size, ...]));
- * ```
- */
-export function createMain(scriptModule, main) {
-    const defaults = buildDefaults(scriptModule.params);
-    const newModule = ((inputParams) => {
-        const merged = { ...defaults, ...inputParams };
-        return main(merged);
-    });
-    newModule.params = scriptModule.params;
-    if (scriptModule.exporters) {
-        newModule.exporters = scriptModule.exporters;
-    }
-    return newModule;
-}
+// Geometry utility functions
+export { isPathSegment, getPathPointXY, samplePathTo2D, hasShape3dMesh, getShape3dMeshOptions, toManifold, } from './params';
+export { getExporterMetadata, getExportersMetadata, } from './exporters';
+export { defineParams, createMain, } from './script';
 // =============================================================================
 // Utility Functions
 // =============================================================================
-/**
- * Convert a single param def to ObjectMakerParam format.
- * Handles special cases like embedded params that need recursive conversion.
- * @internal
- */
-function convertParamDef(name, def) {
-    const base = {
-        name,
-        type: def.type,
-        caption: def.label ?? name,
-    };
-    // Copy common properties
-    if ('default' in def) {
-        base.initial = def.default;
-    }
-    if ('min' in def)
-        base.min = def.min;
-    if ('max' in def)
-        base.max = def.max;
-    if ('step' in def)
-        base.step = def.step;
-    if ('maxLength' in def)
-        base.maxLength = def.maxLength;
-    // Handle type-specific conversions
-    switch (def.type) {
-        case 'choice': {
-            // Handle both simple string options and { value, label } objects
-            const options = def.options;
-            const values = [];
-            const captions = [];
-            let hasCaptions = false;
-            for (const opt of options) {
-                if (typeof opt === 'string') {
-                    values.push(opt);
-                    captions.push(opt); // Use value as caption if no label
-                }
-                else {
-                    values.push(opt.value);
-                    captions.push(opt.label ?? opt.value);
-                    if (opt.label)
-                        hasCaptions = true;
-                }
-            }
-            base.values = values;
-            // Only set captions if at least one option has a label
-            if (hasCaptions) {
-                base.captions = captions;
-            }
-            break;
-        }
-        case 'buttonGrid': {
-            // Convert buttonGrid options to ObjectMakerButtonGridParam format
-            base.options = def.options.map((opt) => ({
-                value: opt.value,
-                image: opt.image,
-                caption: opt.caption,
-            }));
-            break;
-        }
-        case 'embedded': {
-            // Convert embedded params recursively
-            const embeddedDef = def;
-            base.parameters = schemaToArray(embeddedDef.params);
-            base.enabled = embeddedDef.enabled ?? false;
-            base.showSettings = embeddedDef.showSettings ?? false;
-            // Propagate npm package for resolving relative asset URLs
-            if (embeddedDef.npmPackage) {
-                base.npmPackage = embeddedDef.npmPackage;
-            }
-            break;
-        }
-    }
-    return base;
-}
-/**
- * Convert an object-based schema to array format for legacy UI compatibility.
- *
- * This function transforms the script-params schema format into the
- * ObjectMakerParam[] format expected by the Core UI.
- *
- * @example
- * ```typescript
- * const schema = { size: { type: 'number', default: 10 } };
- * const array = schemaToArray(schema);
- * // [{ name: 'size', type: 'number', initial: 10, caption: 'size' }]
- * ```
- */
-export function schemaToArray(schema) {
-    return Object.entries(schema).map(([name, def]) => convertParamDef(name, def));
-}
-/**
- * Extract defaults from a schema as a plain object.
- *
- * @example
- * ```typescript
- * const schema = {
- *   size: { type: 'number', default: 10 },
- *   label: { type: 'text', default: 'Hi' },
- * };
- * const defaults = getDefaults(schema);
- * // { size: 10, label: 'Hi' }
- * ```
- */
-export function getDefaults(schema) {
-    return buildDefaults(schema);
-}
-/**
- * Check if a module export uses the defineParams format.
- *
- * @example
- * ```typescript
- * const mod = await import('./script.ts');
- * if (isScriptModule(mod.default)) {
- *   const result = mod.default({ size: 20 });
- * }
- * ```
- */
-export function isScriptModule(value) {
-    return (typeof value === 'function' &&
-        'params' in value &&
-        typeof value.params === 'object' &&
-        value.params !== null);
-}
-/**
- * Extract the parameter schema from a ScriptModule.
- * Useful for embedding another script's parameters.
- *
- * @example
- * ```typescript
- * import qrCodeScript from './qr-code';
- *
- * const qrParams = getParams(qrCodeScript);
- *
- * // Use in embedded param definition
- * export default defineParams({
- *   params: {
- *     qrCode: {
- *       type: 'embedded',
- *       params: getParams(qrCodeScript),
- *       enabled: false,
- *     },
- *   },
- * });
- * ```
- */
-export function getParams(source) {
-    return source.params;
-}
-/**
- * Extract exporters from a ScriptModule.
- * Returns an empty object if the module has no exporters.
- *
- * @example
- * ```typescript
- * import qrCodeScript from './qr-code';
- *
- * const exporters = getExporters(qrCodeScript);
- * // { svg: { name: 'SVG', ... }, png: { name: 'PNG', ... } }
- * ```
- */
-export function getExporters(source) {
-    return source.exporters ?? {};
-}
-/**
- * Helper to create an embedded param definition with npm package metadata.
- * This enables relative asset paths (like buttonGrid images) to be resolved
- * correctly when embedding another npm package's parameters.
- *
- * @param npmPackage - The npm package name (e.g., '@cadit-app/qr-code')
- * @param embeddedDef - The embedded param definition
- * @returns The embedded definition with npmPackage attached
- *
- * @example
- * ```typescript
- * import qrCodeModule from '@cadit-app/qr-code';
- * import { defineParams, embedParams } from '@cadit-app/script-params';
- *
- * export default defineParams({
- *   params: {
- *     qrCodeSettings: embedParams('@cadit-app/qr-code', {
- *       type: 'embedded',
- *       label: 'QR Code (Optional)',
- *       params: qrCodeModule.params,
- *       enabled: false,
- *       showSettings: false,
- *     }),
- *   },
- *   main: (params) => { ... },
- * });
- * ```
- */
-export function embedParams(npmPackage, embeddedDef) {
-    return {
-        ...embeddedDef,
-        npmPackage,
-    };
-}
+export { schemaToArray, getDefaults, isScriptModule, getParams, getExporters, embedParams, } from './utils';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AA4FH;;;;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;AAoWD,gFAAgF;AAChF,iBAAiB;AACjB,gFAAgF;AAEhF;;;GAGG;AACH,SAAS,aAAa,CAAwB,MAAS;IACrD,MAAM,QAAQ,GAAG,EAAe,CAAC;IACjC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC5B,qDAAqD;YACrD,MAAM,WAAW,GAAG,GAAuB,CAAC;YAC3C,QAAoC,CAAC,GAAG,CAAC,GAAG;gBAC3C,OAAO,EAAE,WAAW,CAAC,OAAO,IAAI,KAAK;gBACrC,YAAY,EAAE,WAAW,CAAC,YAAY,IAAI,KAAK;gBAC/C,MAAM,EAAE,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC;aAC1C,CAAC;QACJ,CAAC;aAAM,CAAC;YACL,QAAoC,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3D,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,UAAU,YAAY,CAC1B,MAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAEnD,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAEvC,MAAM,YAAY,GAAG,CAAC,CAAC,WAAgC,EAAK,EAAE;QAC5D,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;QAC7F,CAAC;QACD,MAAM,MAAM,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,WAAW,EAAe,CAAC;QAC5D,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC,CAAuB,CAAC;IAEzB,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC;IAC7B,IAAI,SAAS,EAAE,CAAC;QACd,YAAY,CAAC,SAAS,GAAG,SAAS,CAAC;IACrC,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,UAAU,CACxB,YAAsC,EACtC,IAA8B;IAE9B,MAAM,QAAQ,GAAG,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAEpD,MAAM,SAAS,GAAG,CAAC,CAAC,WAAgC,EAAK,EAAE;QACzD,MAAM,MAAM,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,WAAW,EAAe,CAAC;QAC5D,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC,CAAuB,CAAC;IAEzB,SAAS,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;IACvC,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC;QAC3B,SAAS,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;IAC/C,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,gFAAgF;AAChF,oBAAoB;AACpB,gFAAgF;AAEhF;;;;GAIG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,GAAa;IAClD,MAAM,IAAI,GAA4B;QACpC,IAAI;QACJ,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,OAAO,EAAE,GAAG,CAAC,KAAK,IAAI,IAAI;KAC3B,CAAC;IAEF,yBAAyB;IACzB,IAAI,SAAS,IAAI,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAC7B,CAAC;IACD,IAAI,KAAK,IAAI,GAAG;QAAE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;IACrC,IAAI,KAAK,IAAI,GAAG;QAAE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;IACrC,IAAI,MAAM,IAAI,GAAG;QAAE,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IACxC,IAAI,WAAW,IAAI,GAAG;QAAE,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IAEvD,mCAAmC;IACnC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,iEAAiE;YACjE,MAAM,OAAO,GAAG,GAAG,CAAC,OAAkE,CAAC;YACvF,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAa,EAAE,CAAC;YAC9B,IAAI,WAAW,GAAG,KAAK,CAAC;YAExB,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;gBAC1B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;oBAC5B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACjB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,mCAAmC;gBACzD,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;oBACvB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;oBACtC,IAAI,GAAG,CAAC,KAAK;wBAAE,WAAW,GAAG,IAAI,CAAC;gBACpC,CAAC;YACH,CAAC;YAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,uDAAuD;YACvD,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC3B,CAAC;YACD,MAAM;QACR,CAAC;QACD,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,kEAAkE;YAClE,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBACvC,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,OAAO,EAAE,GAAG,CAAC,OAAO;aACrB,CAAC,CAAC,CAAC;YACJ,MAAM;QACR,CAAC;QACD,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,sCAAsC;YACtC,MAAM,WAAW,GAAG,GAAuB,CAAC;YAC5C,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACpD,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,IAAI,KAAK,CAAC;YAC5C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY,IAAI,KAAK,CAAC;YACtD,0DAA0D;YAC1D,IAAI,WAAW,CAAC,UAAU,EAAE,CAAC;gBAC3B,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC;YAC3C,CAAC;YACD,MAAM;QACR,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAS;IAET,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AACjF,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,WAAW,CAAwB,MAAS;IAC1D,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAc;IAEd,OAAO,CACL,OAAO,KAAK,KAAK,UAAU;QAC3B,QAAQ,IAAI,KAAK;QACjB,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;QAChC,KAAK,CAAC,MAAM,KAAK,IAAI,CACtB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,SAAS,CACvB,MAAgC;IAEhC,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAgC;IAEhC,OAAO,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,WAAW,CACzB,UAAkB,EAClB,WAAiD;IAEjD,OAAO;QACL,GAAG,WAAW;QACd,UAAU;KACX,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AA+DH,6BAA6B;AAC7B,OAAO,EACL,aAAa,EACb,cAAc,EACd,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,UAAU,GACX,MAAM,UAAU,CAAC;AAalB,OAAO,EACL,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,aAAa,CAAC;AAYrB,OAAO,EACL,YAAY,EACZ,UAAU,GACX,MAAM,UAAU,CAAC;AAElB,gFAAgF;AAChF,oBAAoB;AACpB,gFAAgF;AAEhF,OAAO,EACL,aAAa,EACb,WAAW,EACX,cAAc,EACd,SAAS,EACT,YAAY,EACZ,WAAW,GACZ,MAAM,SAAS,CAAC"}

package/dist/params/geometry.d.ts

@@ -0,0 +1,313 @@
+/**
+ * Geometry-related parameter types for CADit parametric scripts.
+ *
+ * This module defines the shape2d and shape3d parameter types and their
+ * associated value types, as well as utility functions for working with
+ * path geometry (bezier curves, point extraction, etc.).
+ */
+import type { ParamDefBase } from './types';
+/**
+ * A 2D point with x, y coordinates.
+ */
+export interface Point2D {
+    x: number;
+    y: number;
+}
+/**
+ * A 3D point with x, y, z coordinates.
+ */
+export interface Point3D {
+    x: number;
+    y: number;
+    z: number;
+}
+/**
+ * A bezier segment includes the main point and optional control handles.
+ * Used for smooth curves in 2D paths.
+ *
+ * Handles are RELATIVE to the point (like Paper.js):
+ * - handleIn: Controls the curve coming INTO this point from the previous point
+ * - handleOut: Controls the curve going OUT of this point to the next point
+ *
+ * @example
+ * ```typescript
+ * // A point with symmetric handles for a smooth curve
+ * const smoothPoint: PathSegment = {
+ *   point: { x: 100, y: 100 },
+ *   handleIn: { x: -20, y: 0 },  // handle comes from left
+ *   handleOut: { x: 20, y: 0 },  // handle goes to right
+ * };
+ * ```
+ */
+export interface PathSegment {
+    /** The main anchor point position */
+    point: Point2D;
+    /** Control handle for incoming curve (relative to point) */
+    handleIn?: Point2D;
+    /** Control handle for outgoing curve (relative to point) */
+    handleOut?: Point2D;
+}
+/**
+ * A path point can be either a simple point or a bezier segment with handles.
+ * For 2D operations, Point2D (x, y only) is also valid.
+ */
+export type PathPoint = Point2D | Point3D | PathSegment;
+/**
+ * A path in a doodle shape.
+ * Contains the main points of the path and any holes within it.
+ */
+export interface DoodlePath {
+    /**
+     * Array of points defining the path outline.
+     * Points are normalized with counter-clockwise winding order for CrossSection compatibility.
+     */
+    points: PathPoint[];
+    /**
+     * Optional holes within this path, each defined as an array of points.
+     * Holes are normalized with clockwise winding order (opposite of outer contour).
+     */
+    holes?: PathPoint[][];
+}
+/**
+ * Serialized shape data structure.
+ * Contains the geometry information for a 2D shape.
+ */
+export interface SerializedShapeData {
+    /** Array of paths that make up the shape. */
+    doodlePaths: DoodlePath[];
+}
+/**
+ * The runtime value of a shape2d parameter.
+ * Contains the shape ID and optionally the serialized geometry data.
+ */
+export interface Shape2dValue {
+    /** The ID of the selected shape in the CADit scene. */
+    shapeId: string;
+    /** The serialized shape geometry, if available. */
+    shapeData?: SerializedShapeData;
+}
+/**
+ * Shape2d parameter - allows selecting a 2D shape from the CADit scene.
+ * The selected shape's geometry can be used as input for the script.
+ *
+ * @example
+ * ```typescript
+ * export default defineParams({
+ *   params: {
+ *     inputShape: {
+ *       type: 'shape2d',
+ *       label: 'Select a 2D shape',
+ *     },
+ *   },
+ *   main: (params) => {
+ *     if (params.inputShape?.shapeData) {
+ *       // Use the shape data to create geometry
+ *       const paths = params.inputShape.shapeData.doodlePaths;
+ *       // ...
+ *     }
+ *     return Manifold.cube([10, 10, 10]); // fallback
+ *   },
+ * });
+ * ```
+ */
+export interface Shape2dParamDef extends ParamDefBase {
+    type: 'shape2d';
+    /** Optional default value (typically null/undefined - user must select). */
+    default?: Shape2dValue | null;
+}
+/**
+ * A 3D triangle represented as 3 vertex indices.
+ */
+export interface Triangle {
+    /** Indices into the vertices array */
+    indices: [number, number, number];
+}
+/**
+ * Serialized 3D mesh data structure.
+ * Contains vertex positions, triangle indices, and optional normal data.
+ */
+export interface SerializedMeshData {
+    /**
+     * Flat array of vertex positions [x0, y0, z0, x1, y1, z1, ...].
+     * Every 3 consecutive values represent one vertex.
+     */
+    vertices: number[];
+    /**
+     * Flat array of triangle indices [v0, v1, v2, v3, v4, v5, ...].
+     * Every 3 consecutive values represent one triangle.
+     */
+    triangles: number[];
+    /**
+     * Optional flat array of vertex normals [nx0, ny0, nz0, nx1, ny1, nz1, ...].
+     * Same length as vertices array.
+     */
+    normals?: number[];
+}
+/**
+ * The runtime value of a shape3d parameter.
+ * Contains the 3D object ID and optionally the serialized mesh data.
+ */
+export interface Shape3dValue {
+    /** The ID of the selected 3D object in the CADit scene. */
+    objectId: string;
+    /** The serialized mesh geometry, if available. */
+    meshData?: SerializedMeshData;
+}
+/**
+ * Shape3d parameter - allows selecting a 3D object from the CADit scene.
+ * The selected object's mesh geometry can be used as input for the script.
+ *
+ * @example
+ * ```typescript
+ * export default defineParams({
+ *   params: {
+ *     inputMesh: {
+ *       type: 'shape3d',
+ *       label: 'Select a 3D object',
+ *     },
+ *   },
+ *   main: (params, manifold) => {
+ *     if (params.inputMesh?.meshData) {
+ *       // Use the mesh data to create geometry
+ *       const { vertices, triangles } = params.inputMesh.meshData;
+ *       const mesh = new manifold.Mesh({ numProp: 3, vertProperties: vertices, triVerts: triangles });
+ *       return new manifold.Manifold(mesh);
+ *     }
+ *     return manifold.cube([10, 10, 10]); // fallback
+ *   },
+ * });
+ * ```
+ */
+export interface Shape3dParamDef extends ParamDefBase {
+    type: 'shape3d';
+    /** Optional default value (typically null/undefined - user must select). */
+    default?: Shape3dValue | null;
+}
+/**
+ * Type guard to check if a path point is a bezier segment with handles.
+ *
+ * @example
+ * ```typescript
+ * for (const point of path.points) {
+ *   if (isPathSegment(point)) {
+ *     // point is PathSegment with handleIn/handleOut
+ *     console.log('Bezier point:', point.point, point.handleIn, point.handleOut);
+ *   } else {
+ *     // point is Point3D (simple point)
+ *     console.log('Simple point:', point.x, point.y);
+ *   }
+ * }
+ * ```
+ */
+export declare function isPathSegment(point: PathPoint): point is PathSegment;
+/**
+ * Get the x, y coordinates from a path point.
+ * Works for both simple Point3D and PathSegment.
+ *
+ * @example
+ * ```typescript
+ * const points2D = path.points.map(p => {
+ *   const { x, y } = getPathPointXY(p);
+ *   return [x, y];
+ * });
+ * ```
+ */
+export declare function getPathPointXY(point: PathPoint): Point2D;
+/**
+ * Convert a path with bezier segments to simple 2D points.
+ * This samples the bezier curves at regular intervals.
+ *
+ * @param points - Array of path points (can include bezier segments)
+ * @param samplesPerSegment - Number of samples per bezier segment (default: 8)
+ * @returns Array of [x, y] tuples suitable for CrossSection
+ *
+ * @example
+ * ```typescript
+ * const path = inputShape.shapeData.doodlePaths[0];
+ * const points2D = samplePathTo2D(path.points);
+ * const crossSection = Module.CrossSection(points2D);
+ * ```
+ */
+export declare function samplePathTo2D(points: PathPoint[], samplesPerSegment?: number): [number, number][];
+/**
+ * Interface for the Mesh constructor options expected by manifold-3d.
+ */
+export interface MeshOptions {
+    numProp: number;
+    vertProperties: Float32Array;
+    triVerts: Uint32Array;
+}
+/**
+ * Type guard to check if a Shape3dValue has valid mesh data.
+ * Use this to narrow the type before accessing meshData properties.
+ *
+ * @param shape3d - The Shape3dValue to check (may be null/undefined)
+ * @returns True if the shape has valid mesh data with vertices and triangles
+ *
+ * @example
+ * ```typescript
+ * import { Manifold, Mesh } from '@cadit-app/manifold-3d/manifoldCAD';
+ * import { hasShape3dMesh, getShape3dMeshOptions } from '@cadit-app/script-params';
+ *
+ * if (hasShape3dMesh(params.inputMesh)) {
+ *   const manifold = new Manifold(new Mesh(getShape3dMeshOptions(params.inputMesh)));
+ *   // use manifold...
+ * }
+ * ```
+ */
+export declare function hasShape3dMesh(shape3d: Shape3dValue | null | undefined): shape3d is Shape3dValue & {
+    meshData: SerializedMeshData;
+};
+/**
+ * Get mesh options from a Shape3dValue for use with Manifold's Mesh constructor.
+ *
+ * IMPORTANT: Always call hasShape3dMesh() first to validate the shape,
+ * or use toManifold() for a simpler one-liner.
+ *
+ * @param shape3d - A Shape3dValue that has valid meshData (use hasShape3dMesh to check)
+ * @returns MeshOptions ready to pass to `new Mesh(options)`
+ *
+ * @example
+ * ```typescript
+ * import { Manifold, Mesh } from '@cadit-app/manifold-3d/manifoldCAD';
+ * import { hasShape3dMesh, getShape3dMeshOptions } from '@cadit-app/script-params';
+ *
+ * if (hasShape3dMesh(baseShape)) {
+ *   const opts = getShape3dMeshOptions(baseShape);
+ *   const manifold = new Manifold(new Mesh(opts));
+ * }
+ * ```
+ */
+export declare function getShape3dMeshOptions(shape3d: Shape3dValue & {
+    meshData: SerializedMeshData;
+}): MeshOptions;
+/**
+ * Convert a Shape3dValue to a Manifold in a single expression.
+ *
+ * This is a convenience function that combines hasShape3dMesh check and
+ * Manifold construction. Pass your Mesh and Manifold constructors.
+ *
+ * Note: We can't import Manifold/Mesh directly in script-params because
+ * manifold-3d requires async WASM initialization. The worker pre-initializes
+ * it and exposes the classes, which you import in your script.
+ *
+ * @param shape3d - The Shape3dValue from a shape3d parameter (may be null)
+ * @param Mesh - The Mesh constructor from manifold-3d
+ * @param Manifold - The Manifold constructor from manifold-3d
+ * @returns A Manifold object, or null if the shape3d is invalid
+ *
+ * @example
+ * ```typescript
+ * import { Manifold, Mesh } from '@cadit-app/manifold-3d/manifoldCAD';
+ * import { toManifold } from '@cadit-app/script-params';
+ *
+ * const manifoldA = toManifold(params.baseShape, Mesh, Manifold);
+ * const manifoldB = toManifold(params.sweepShape, Mesh, Manifold);
+ *
+ * if (manifoldA && manifoldB) {
+ *   return manifoldA.add(manifoldB);
+ * }
+ * ```
+ */
+export declare function toManifold<TMesh, TManifold>(shape3d: Shape3dValue | null | undefined, Mesh: new (options: MeshOptions) => TMesh, Manifold: new (mesh: TMesh) => TManifold): TManifold | null;
+//# sourceMappingURL=geometry.d.ts.map

package/dist/params/geometry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geometry.d.ts","sourceRoot":"","sources":["../../src/params/geometry.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAM5C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,WAAW;IAC1B,qCAAqC;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,SAAS,CAAC,EAAE,mBAAmB,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,SAAS,CAAC;IAChB,4EAA4E;IAC5E,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;CAC/B;AAMD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,sCAAsC;IACtC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,SAAS,CAAC;IAChB,4EAA4E;IAC5E,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;CAC/B;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,KAAK,IAAI,WAAW,CAEpE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAKxD;AAgBD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,iBAAiB,GAAE,MAAU,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAgDrG;AAMD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,YAAY,CAAC;IAC7B,QAAQ,EAAE,WAAW,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,YAAY,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,IAAI,YAAY,GAAG;IAAE,QAAQ,EAAE,kBAAkB,CAAA;CAAE,CAK5D;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,YAAY,GAAG;IAAE,QAAQ,EAAE,kBAAkB,CAAA;CAAE,GACvD,WAAW,CAOb;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,SAAS,EACzC,OAAO,EAAE,YAAY,GAAG,IAAI,GAAG,SAAS,EACxC,IAAI,EAAE,KAAK,OAAO,EAAE,WAAW,KAAK,KAAK,EACzC,QAAQ,EAAE,KAAK,IAAI,EAAE,KAAK,KAAK,SAAS,GACvC,SAAS,GAAG,IAAI,CAUlB"}