fluidcad 0.0.33 → 0.0.35

package/lib/dist/core/interfaces.d.ts

@@ -5,6 +5,7 @@ import type { EdgeFilterBuilder } from "../filters/edge/edge-filter.js";
 import type { Matrix4 } from "../math/matrix4.js";
 import type { AxisLike } from "../math/axis.js";
 import type { PlaneLike } from "../math/plane.js";
+import type { NumberParam } from "./param.js";
 export interface ISceneObject {
     /**
      * Sets a custom display name for this object, overriding the default type-based name.
@@ -81,15 +82,15 @@ export interface ITransformable extends ISceneObject {
      * Translate along X.
      * @param x - Distance along world X.
      */
-    translate(x: number): this;
+    translate(x: NumberParam): this;
     /**
      * Translate along X and Y.
      */
-    translate(x: number, y: number): this;
+    translate(x: NumberParam, y: NumberParam): this;
     /**
      * Translate along X, Y, and Z.
      */
-    translate(x: number, y: number, z: number): this;
+    translate(x: NumberParam, y: NumberParam, z: NumberParam): this;
     /**
      * Translate by a point-like offset in world space.
      */
@@ -98,13 +99,13 @@ export interface ITransformable extends ISceneObject {
      * Rotate by an angle around world Z through the origin.
      * @param angle - Rotation in degrees.
      */
-    rotate(angle: number): this;
+    rotate(angle: NumberParam): this;
     /**
      * Rotate around an axis by an angle.
      * @param axis - The axis to rotate around. Use `local(...)` to reference a sketch-local axis.
      * @param angle - Rotation in degrees.
      */
-    rotate(axis: AxisLike, angle: number): this;
+    rotate(axis: AxisLike, angle: NumberParam): this;
     /**
      * Mirror across a plane.
      */
@@ -157,13 +158,27 @@ export interface IArcPoints extends IExtrudableGeometry {
      * Positive = CCW, negative = CW.
      * @param value - The bulge radius.
      */
-    radius(value: number): this;
+    radius(value: NumberParam): IArcRadius;
     /**
      * Specifies the circle center point for the arc.
      * Mutually exclusive with `.radius()`.
      * @param value - The center point of the arc's circle.
      */
-    center(value: Point2DLike): this;
+    center(value: Point2DLike): IArcCenter;
+}
+export interface IArcRadius extends IExtrudableGeometry {
+    /**
+     * Switches to the major arc (> 180°).
+     * By default, `.radius()` produces the minor arc (< 180°);
+     * `.major()` switches to the complementary major arc on the same circle.
+     */
+    major(): this;
+}
+export interface IArcCenter extends IExtrudableGeometry {
+    /**
+     * Sweeps the arc clockwise from start to end instead of the default counter-clockwise.
+     */
+    cw(): this;
 }
 export interface IArcAngles extends IExtrudableGeometry {
     /**
@@ -245,7 +260,7 @@ export interface ISlot extends IExtrudableGeometry {
      * Sets the rotation angle of the slot's primary axis.
      * @param angle - Rotation in degrees.
      */
-    rotate(angle: number): this;
+    rotate(angle: NumberParam): this;
 }
 export interface IALine extends IGeometry {
     /**
@@ -298,6 +313,14 @@ export interface ITwoObjectsTangentLine extends IGeometry {
      */
     end(index?: number): LazyVertex;
 }
+export interface ITangentArcToObject extends IGeometry {
+    /**
+     * Flips the arc to the opposite side of the start tangent. By default,
+     * the arc curves to the left of the current tangent direction;
+     * `.flip()` switches it to the right.
+     */
+    flip(): this;
+}
 export interface ITangentArcTwoObjects extends IGeometry {
     /**
      * Returns the start vertex of the tangent arc.
@@ -378,12 +401,12 @@ export interface IExtrude extends IBooleanOperation {
      * Applies a draft (taper) angle to the extrusion walls.
      * @param value - A single angle for uniform draft, or a `[start, end]` tuple for asymmetric draft.
      */
-    draft(value: number | [number, number]): this;
+    draft(value: NumberParam | [NumberParam, NumberParam]): this;
     /**
      * Offsets the end face by a specified distance along the extrusion direction.
      * @param value - The offset distance.
      */
-    endOffset(value: number): this;
+    endOffset(value: NumberParam): this;
     /**
      * Enables or disables drill mode, which partitions the sketch into face regions
      * before extruding.
@@ -400,7 +423,7 @@ export interface IExtrude extends IBooleanOperation {
      * instead of extruding filled faces. Positive values offset outward, negative values offset inward.
      * @param offset - The wall offset distance. Positive = outward, negative = inward.
      */
-    thin(offset: number): this;
+    thin(offset: NumberParam): this;
     /**
      * Enables thin extrude mode with two offset directions.
      * The two offsets must go in opposite directions. If both have the same sign,
@@ -408,7 +431,7 @@ export interface IExtrude extends IBooleanOperation {
      * @param offset1 - The first wall offset distance. Positive = outward, negative = inward.
      * @param offset2 - The second wall offset distance, in the opposite direction of offset1.
      */
-    thin(offset1: number, offset2: number): this;
+    thin(offset1: NumberParam, offset2: NumberParam): this;
 }
 export interface ICut extends ISceneObject {
     /**
@@ -425,12 +448,12 @@ export interface ICut extends ISceneObject {
      * Applies a draft (taper) angle to the cut walls.
      * @param value - A single angle for uniform draft, or a `[start, end]` tuple for asymmetric draft.
      */
-    draft(value: number | [number, number]): this;
+    draft(value: NumberParam | [NumberParam, NumberParam]): this;
     /**
      * Offsets the cut end face by a specified distance along the cut direction.
      * @param value - The offset distance.
      */
-    endOffset(value: number): this;
+    endOffset(value: NumberParam): this;
     /**
      * Selects edges at the start of the cut path, classified by signed distance from the cut plane.
      * @param args - Numeric indices or {@link EdgeFilterBuilder} instances to filter the selection.
@@ -461,7 +484,7 @@ export interface ICut extends ISceneObject {
      * instead of cutting filled faces. Positive values offset outward, negative values offset inward.
      * @param offset - The wall offset distance. Positive = outward, negative = inward.
      */
-    thin(offset: number): this;
+    thin(offset: NumberParam): this;
     /**
      * Enables thin cut mode with two offset directions.
      * The two offsets must go in opposite directions. If both have the same sign,
@@ -469,7 +492,7 @@ export interface ICut extends ISceneObject {
      * @param offset1 - The first wall offset distance. Positive = outward, negative = inward.
      * @param offset2 - The second wall offset distance, in the opposite direction of offset1.
      */
-    thin(offset1: number, offset2: number): this;
+    thin(offset1: NumberParam, offset2: NumberParam): this;
 }
 export interface IRevolve extends IBooleanOperation {
     /**
@@ -487,7 +510,7 @@ export interface IRevolve extends IBooleanOperation {
      * outward, negative values offset inward.
      * @param offset - The wall offset distance. Positive = outward, negative = inward.
      */
-    thin(offset: number): this;
+    thin(offset: NumberParam): this;
     /**
      * Enables thin revolve mode with two offset directions.
      * The two offsets must go in opposite directions. If both have the same sign,
@@ -495,7 +518,7 @@ export interface IRevolve extends IBooleanOperation {
      * @param offset1 - The first wall offset distance. Positive = outward, negative = inward.
      * @param offset2 - The second wall offset distance, in the opposite direction of offset1.
      */
-    thin(offset1: number, offset2: number): this;
+    thin(offset1: NumberParam, offset2: NumberParam): this;
     /**
      * Selects faces created inside the solid during revolution (e.g., the inner
      * wall of a thin-walled revolve from a closed profile).
@@ -556,7 +579,7 @@ export interface ILoft extends IBooleanOperation {
      * and share the same topology. Positive values offset outward, negative offsets inward.
      * @param offset - The wall offset distance. Positive = outward, negative = inward.
      */
-    thin(offset: number): this;
+    thin(offset: NumberParam): this;
     /**
      * Enables thin loft mode with two offset directions.
      * The two offsets must go in opposite directions. If both have the same sign,
@@ -564,7 +587,7 @@ export interface ILoft extends IBooleanOperation {
      * @param offset1 - The first wall offset distance. Positive = outward, negative = inward.
      * @param offset2 - The second wall offset distance, in the opposite direction of offset1.
      */
-    thin(offset1: number, offset2: number): this;
+    thin(offset1: NumberParam, offset2: NumberParam): this;
     /**
      * Selects faces created inside the solid during loft (e.g., the inner
      * wall of a thin-walled loft from closed profiles).
@@ -633,12 +656,12 @@ export interface ISweep extends IBooleanOperation {
      * Applies a draft (taper) angle to the sweep walls.
      * @param value - A single angle for uniform draft, or a `[start, end]` tuple for asymmetric draft.
      */
-    draft(value: number | [number, number]): this;
+    draft(value: NumberParam | [NumberParam, NumberParam]): this;
     /**
      * Offsets the end face by a specified distance along the sweep direction.
      * @param value - The offset distance.
      */
-    endOffset(value: number): this;
+    endOffset(value: NumberParam): this;
     /**
      * Enables or disables drill mode.
      * @param value - `true` to enable (default), `false` to disable.
@@ -655,7 +678,7 @@ export interface ISweep extends IBooleanOperation {
      * negative values offset inward.
      * @param offset - The wall offset distance. Positive = outward, negative = inward.
      */
-    thin(offset: number): this;
+    thin(offset: NumberParam): this;
     /**
      * Enables thin sweep mode with two offset directions.
      * The two offsets must go in opposite directions. If both have the same sign,
@@ -663,7 +686,7 @@ export interface ISweep extends IBooleanOperation {
      * @param offset1 - The first wall offset distance. Positive = outward, negative = inward.
      * @param offset2 - The second wall offset distance, in the opposite direction of offset1.
      */
-    thin(offset1: number, offset2: number): this;
+    thin(offset1: NumberParam, offset2: NumberParam): this;
     /**
      * Selects the cap faces at the open ends of a thin-walled sweep from an open profile.
      * These are the small faces connecting the inner and outer walls at the profile endpoints.
@@ -759,7 +782,7 @@ export interface IRib extends IBooleanOperation {
      * Applies a draft (taper) angle to the rib walls.
      * @param value - A single angle for uniform draft, or a `[start, end]` tuple for asymmetric draft.
      */
-    draft(value: number | [number, number]): this;
+    draft(value: NumberParam | [NumberParam, NumberParam]): this;
     /**
      * Switches the extrusion direction to parallel to the sketch plane
      * (perpendicular to the spine within the plane) instead of normal to it.
@@ -771,6 +794,7 @@ export interface IRib extends IBooleanOperation {
      */
     extend(): this;
 }
+export type ShellJoinType = 'arc' | 'intersection' | 'tangent';
 export interface IShell extends ISceneObject {
     /**
      * Selects the inner wall faces created by the shell operation (from thickness removal).
@@ -783,4 +807,10 @@ export interface IShell extends ISceneObject {
      * @param args - Numeric indices or {@link EdgeFilterBuilder} instances to filter the selection.
      */
     internalEdges(...args: (number | EdgeFilterBuilder)[]): ISceneObject;
+    /**
+     * Sets the join type used at inner-wall corners.
+     * @param type - `'arc'` (default) for rounded blends, `'intersection'` for sharp corners,
+     *   or `'tangent'` for tangent-continuous blends.
+     */
+    join(type: ShellJoinType): this;
 }

package/lib/dist/core/param.d.ts

@@ -0,0 +1,74 @@
+import { type MultiControlType, type SelectOption } from "../param-registry.js";
+export type ParamType = 'number' | 'slider' | 'text' | 'select' | 'checkbox' | 'color';
+interface BaseParamOptions {
+    group?: string;
+    description?: string;
+}
+export interface NumberParamOptions extends BaseParamOptions {
+    min?: number;
+    max?: number;
+    step?: number;
+}
+export interface SliderParamOptions extends BaseParamOptions {
+    min?: number;
+    max?: number;
+    step?: number;
+}
+export interface SelectParamOptions extends BaseParamOptions {
+    options: SelectOption[];
+    multi?: boolean;
+    multiControlType?: MultiControlType;
+}
+export type CheckboxParamOptions = BaseParamOptions;
+export type TextParamOptions = BaseParamOptions;
+export type ColorParamOptions = BaseParamOptions;
+export interface ParamOptionsMap {
+    number: NumberParamOptions;
+    slider: SliderParamOptions;
+    select: SelectParamOptions;
+    checkbox: CheckboxParamOptions;
+    text: TextParamOptions;
+    color: ColorParamOptions;
+}
+/** @deprecated Use `param()` with a `ParamOptions` object instead. */
+export declare class ParamValue<T extends string | number | boolean> {
+    private _value;
+    private _definition;
+    constructor(label: string, defaultValue: T);
+    slider(opts?: {
+        min?: number;
+        max?: number;
+        step?: number;
+    }): this;
+    number(opts?: {
+        min?: number;
+        max?: number;
+        step?: number;
+    }): this;
+    text(): this;
+    checkbox(): this;
+    select(items: SelectOption[], opts?: {
+        multi?: boolean;
+        multiControlType?: MultiControlType;
+    }): this;
+    description(desc: string): this;
+    group(name: string): this;
+    valueOf(): T;
+    toString(): string;
+    toJSON(): T;
+    [Symbol.toPrimitive](hint: string): T | string;
+}
+export type NumberParam = number | ParamValue<number>;
+export type StringParam = string | ParamValue<string>;
+export type BooleanParam = boolean | ParamValue<boolean>;
+export declare function isNumberParam(v: unknown): v is NumberParam;
+export declare function isBooleanParam(v: unknown): v is BooleanParam;
+export declare function resolveParam(v: NumberParam): number;
+export declare function resolveParam(v: StringParam): string;
+export declare function resolveParam(v: BooleanParam): boolean;
+export default function param<T extends string | number | boolean>(label: string, defaultValue: T): T;
+export default function param<T extends string | number | boolean, K extends ParamType>(label: string, defaultValue: T, type: K, options?: ParamOptionsMap[K]): T;
+export default function param(label: string, defaultValue: (string | number)[], type: 'select', options: SelectParamOptions & {
+    multi: true;
+}): (string | number)[];
+export {};

package/lib/dist/core/param.js

@@ -0,0 +1,147 @@
+import { getParamRegistry } from "../param-registry.js";
+/** @deprecated Use `param()` with a `ParamOptions` object instead. */
+export class ParamValue {
+    _value;
+    _definition;
+    constructor(label, defaultValue) {
+        const registry = getParamRegistry();
+        this._value = registry.resolve(label, defaultValue);
+        this._definition = {
+            label,
+            defaultValue,
+            currentValue: this._value,
+            controlType: typeof defaultValue === 'boolean' ? 'checkbox'
+                : typeof defaultValue === 'number' ? 'number'
+                    : 'text',
+        };
+        registry.register(this._definition);
+    }
+    slider(opts) {
+        this._definition.controlType = 'slider';
+        if (opts) {
+            if (opts.min != null) {
+                this._definition.min = opts.min;
+            }
+            if (opts.max != null) {
+                this._definition.max = opts.max;
+            }
+            if (opts.step != null) {
+                this._definition.step = opts.step;
+            }
+        }
+        return this;
+    }
+    number(opts) {
+        this._definition.controlType = 'number';
+        if (opts) {
+            if (opts.min != null) {
+                this._definition.min = opts.min;
+            }
+            if (opts.max != null) {
+                this._definition.max = opts.max;
+            }
+            if (opts.step != null) {
+                this._definition.step = opts.step;
+            }
+        }
+        return this;
+    }
+    text() {
+        this._definition.controlType = 'text';
+        return this;
+    }
+    checkbox() {
+        this._definition.controlType = 'checkbox';
+        return this;
+    }
+    select(items, opts) {
+        this._definition.controlType = 'select';
+        this._definition.options = items;
+        if (opts?.multi) {
+            this._definition.multi = true;
+        }
+        if (opts?.multiControlType) {
+            this._definition.multiControlType = opts.multiControlType;
+        }
+        return this;
+    }
+    description(desc) {
+        this._definition.description = desc;
+        return this;
+    }
+    group(name) {
+        this._definition.group = name;
+        return this;
+    }
+    valueOf() {
+        return this._value;
+    }
+    toString() {
+        return String(this._value);
+    }
+    toJSON() {
+        return this._value;
+    }
+    [Symbol.toPrimitive](hint) {
+        if (hint === 'string') {
+            return String(this._value);
+        }
+        return this._value;
+    }
+}
+export function isNumberParam(v) {
+    return typeof v === 'number' || (v instanceof ParamValue && typeof v.valueOf() === 'number');
+}
+export function isBooleanParam(v) {
+    return typeof v === 'boolean' || (v instanceof ParamValue && typeof v.valueOf() === 'boolean');
+}
+export function resolveParam(v) {
+    if (v instanceof ParamValue) {
+        return v.valueOf();
+    }
+    return v;
+}
+export default function param(label, defaultValue, type, options) {
+    const registry = getParamRegistry();
+    const value = Array.isArray(defaultValue)
+        ? registry.resolve(label, defaultValue)
+        : registry.resolve(label, defaultValue);
+    const controlType = type
+        ?? (typeof defaultValue === 'boolean' ? 'checkbox'
+            : typeof defaultValue === 'number' ? 'number'
+                : 'text');
+    const definition = {
+        label,
+        defaultValue,
+        currentValue: value,
+        controlType,
+    };
+    if (options) {
+        if ('group' in options && options.group != null) {
+            definition.group = options.group;
+        }
+        if ('description' in options && options.description != null) {
+            definition.description = options.description;
+        }
+        if ('min' in options && options.min != null) {
+            definition.min = options.min;
+        }
+        if ('max' in options && options.max != null) {
+            definition.max = options.max;
+        }
+        if ('step' in options && options.step != null) {
+            definition.step = options.step;
+        }
+        if ('options' in options && options.options != null) {
+            definition.options = options.options;
+        }
+        if ('multi' in options && options.multi != null) {
+            definition.multi = options.multi;
+        }
+        if ('multiControlType' in options && options.multiControlType != null) {
+            definition.multiControlType = options.multiControlType;
+        }
+    }
+    registry.register(definition);
+    return value;
+}

package/lib/dist/core/repeat.d.ts

@@ -3,6 +3,7 @@ import { Matrix4 } from "../math/matrix4.js";
 import { LinearRepeatOptions } from "../features/repeat-linear.js";
 import { CircularRepeatOptions } from "../features/repeat-circular.js";
 import { ISceneObject } from "./interfaces.js";
+import { type NumberParam } from "./param.js";
 import { PlaneLike } from "../math/plane.js";
 export type RepeatType = 'linear' | 'circular' | 'mirror' | 'rotate';
 interface RepeatFunction {
@@ -44,7 +45,7 @@ interface RepeatFunction {
      * @param angle - The rotation angle in degrees (defaults to 90)
      * @param objects - The objects to rotate (defaults to last object)
      */
-    (type: 'rotate', axis: AxisLike, angle?: number, ...objects: ISceneObject[]): ISceneObject;
+    (type: 'rotate', axis: AxisLike, angle?: NumberParam, ...objects: ISceneObject[]): ISceneObject;
     /**
      * Creates a transformed clone of objects using an arbitrary matrix.
      * @param matrix - The transformation matrix to apply