@metamesh/generator-sdk 0.11.0 → 0.13.0

package/dist/docs/reference/fonts/FontSelection.md

@@ -0,0 +1,14 @@
+# FontSelection
+
+An immutable catalog face; revision is the SHA-256 digest of the complete font file.
+
+Import from `@metamesh/generator-sdk/fonts` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** An immutable catalog face; revision is the SHA-256 digest of the complete font file. */
+export interface FontSelection {
+    readonly faceId: string;
+    readonly revision: string;
+    readonly weight: number;
+}
+```

package/dist/docs/reference/fonts/isFontSelection.md

@@ -0,0 +1,10 @@
+# isFontSelection
+
+Checks only the portable value, without consulting a catalog or substituting fonts.
+
+Import from `@metamesh/generator-sdk/fonts` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Checks only the portable value, without consulting a catalog or substituting fonts. */
+export declare function isFontSelection(value: unknown): value is FontSelection;
+```

package/dist/docs/reference/index/ArrayParameterDefinition.md

@@ -0,0 +1,12 @@
+# ArrayParameterDefinition
+
+ArrayParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ArrayParameterDefinition extends ArrayParameterBase {
+    readonly default: readonly number[] | readonly string[];
+    readonly items: NumberArrayItemDefinition | StringArrayItemDefinition;
+}
+```

package/dist/docs/reference/index/BaseParameterDefinition.md

@@ -0,0 +1,16 @@
+# BaseParameterDefinition
+
+BaseParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface BaseParameterDefinition {
+    readonly id: string;
+    readonly label: string;
+    /** Supplementary description, also available as on-demand help in the editor. */
+    readonly description?: string | undefined;
+    readonly unit?: string | undefined;
+    readonly ui?: ParameterUi | undefined;
+}
+```

package/dist/docs/reference/index/BooleanParameterDefinition.md

@@ -0,0 +1,12 @@
+# BooleanParameterDefinition
+
+BooleanParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface BooleanParameterDefinition extends BaseParameterDefinition {
+    readonly type: "boolean";
+    readonly default: boolean;
+}
+```

package/dist/docs/reference/index/ChoiceOption.md

@@ -0,0 +1,13 @@
+# ChoiceOption
+
+ChoiceOption exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ChoiceOption {
+    readonly value: string;
+    readonly label: string;
+    readonly description?: string | undefined;
+}
+```

package/dist/docs/reference/index/ChoiceParameterDefinition.md

@@ -0,0 +1,14 @@
+# ChoiceParameterDefinition
+
+ChoiceParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ChoiceParameterDefinition extends BaseParameterDefinition {
+    readonly type: "choice";
+    readonly default: string;
+    readonly options: readonly ChoiceOption[];
+    readonly ui?: RowParameterUi | undefined;
+}
+```

package/dist/docs/reference/index/ChoiceSetParameterDefinition.md

@@ -0,0 +1,15 @@
+# ChoiceSetParameterDefinition
+
+ChoiceSetParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ChoiceSetParameterDefinition extends BaseParameterDefinition {
+    readonly type: "choice-set";
+    readonly default: readonly string[];
+    readonly options: readonly ChoiceOption[];
+    readonly minSelections?: number | undefined;
+    readonly maxSelections?: number | undefined;
+}
+```

package/dist/docs/reference/index/ColorParameterDefinition.md

@@ -0,0 +1,12 @@
+# ColorParameterDefinition
+
+ColorParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ColorParameterDefinition extends BaseParameterDefinition {
+    readonly type: "color";
+    readonly default: string;
+}
+```

package/dist/docs/reference/index/ConditionExpression.md

@@ -0,0 +1,36 @@
+# ConditionExpression
+
+ConditionExpression exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type ConditionExpression = {
+    readonly all: readonly ConditionExpression[];
+} | {
+    readonly any: readonly ConditionExpression[];
+} | {
+    readonly not: ConditionExpression;
+} | {
+    readonly param: string;
+    readonly eq: ScalarParameterValue;
+} | {
+    readonly param: string;
+    readonly ne: ScalarParameterValue;
+} | {
+    readonly param: string;
+    readonly contains: string;
+} | {
+    readonly param: string;
+    readonly gt: number;
+} | {
+    readonly param: string;
+    readonly gte: number;
+} | {
+    readonly param: string;
+    readonly lt: number;
+} | {
+    readonly param: string;
+    readonly lte: number;
+};
+```

package/dist/docs/reference/index/ContourAnchor.md

@@ -0,0 +1,12 @@
+# ContourAnchor
+
+Editing intent accompanies the explicit curve controls; no tangent is inferred at runtime.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Editing intent accompanies the explicit curve controls; no tangent is inferred at runtime. */
+export interface ContourAnchor extends ContourPoint {
+    readonly mode: "smooth" | "corner";
+}
+```

package/dist/docs/reference/index/ContourParameterDefinition.md

@@ -0,0 +1,13 @@
+# ContourParameterDefinition
+
+ContourParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ContourParameterDefinition extends BaseParameterDefinition {
+    readonly type: "contour";
+    readonly default: ContourValue;
+    readonly ui?: ContourParameterUi | undefined;
+}
+```

package/dist/docs/reference/index/ContourParameterUi.md

@@ -0,0 +1,12 @@
+# ContourParameterUi
+
+ContourParameterUi exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ContourParameterUi extends ParameterUi {
+    readonly widthScale?: ParameterScaleReference | undefined;
+    readonly heightScale?: ParameterScaleReference | undefined;
+}
+```

package/dist/docs/reference/index/ContourPoint.md

@@ -0,0 +1,13 @@
+# ContourPoint
+
+Normalized planar coordinates, with X rightward and Y upward, in the unit square.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Normalized planar coordinates, with X rightward and Y upward, in the unit square. */
+export interface ContourPoint {
+    readonly x: number;
+    readonly y: number;
+}
+```

package/dist/docs/reference/index/ContourSegment.md

@@ -0,0 +1,17 @@
+# ContourSegment
+
+ContourSegment exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type ContourSegment = {
+    readonly type: "line";
+    readonly end: ContourAnchor;
+} | {
+    readonly type: "cubic";
+    readonly control1: ContourPoint;
+    readonly control2: ContourPoint;
+    readonly end: ContourAnchor;
+};
+```

package/dist/docs/reference/index/ContourValue.md

@@ -0,0 +1,14 @@
+# ContourValue
+
+One explicitly closed planar contour. Generators own physical scaling and topology checks.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** One explicitly closed planar contour. Generators own physical scaling and topology checks. */
+export interface ContourValue {
+    readonly version: 1;
+    readonly start: ContourAnchor;
+    readonly segments: readonly ContourSegment[];
+}
+```

package/dist/docs/reference/index/FontParameterDefinition.md

@@ -0,0 +1,12 @@
+# FontParameterDefinition
+
+FontParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface FontParameterDefinition extends BaseParameterDefinition {
+    readonly type: "font";
+    readonly default: FontSelection;
+}
+```

package/dist/docs/reference/index/FontSelection.md

@@ -0,0 +1,14 @@
+# FontSelection
+
+An immutable catalog face; revision is the SHA-256 digest of the complete font file.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** An immutable catalog face; revision is the SHA-256 digest of the complete font file. */
+export interface FontSelection {
+    readonly faceId: string;
+    readonly revision: string;
+    readonly weight: number;
+}
+```

package/dist/docs/reference/index/GeneratorDefinition.md

@@ -0,0 +1,14 @@
+# GeneratorDefinition
+
+GeneratorDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface GeneratorDefinition extends ParameterDefinitionDocument {
+    readonly id: string;
+    readonly version: string;
+    readonly title: string;
+    readonly description?: string | undefined;
+}
+```

package/dist/docs/reference/index/GeneratorIssue.md

@@ -0,0 +1,12 @@
+# GeneratorIssue
+
+A validation issue whose optional parameter ID is tied to one definition.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** A validation issue whose optional parameter ID is tied to one definition. */
+export type GeneratorIssue<D extends GeneratorDefinition = GeneratorDefinition> = Omit<ParameterIssue, "parameterId"> & {
+    readonly parameterId?: GeneratorParamId<D> | undefined;
+};
+```

package/dist/docs/reference/index/GeneratorModule.md

@@ -0,0 +1,15 @@
+# GeneratorModule
+
+The sole executable package envelope. Metadata stays callback-free.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** The sole executable package envelope. Metadata stays callback-free. */
+export interface GeneratorModule<D extends GeneratorDefinition = GeneratorDefinition, Program extends GeneratorProgram = GeneratorProgram> {
+    readonly formatVersion: typeof GENERATOR_PACKAGE_FORMAT_VERSION;
+    readonly generatorId: D["id"];
+    readonly version: D["version"];
+    readonly generate: Program;
+}
+```

package/dist/docs/reference/index/GeneratorModuleOptions.md

@@ -0,0 +1,12 @@
+# GeneratorModuleOptions
+
+GeneratorModuleOptions exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface GeneratorModuleOptions<D extends GeneratorDefinition, Program extends GeneratorProgram> {
+    readonly definition: D;
+    readonly generate: DefinitionBoundProgram<D, Program>;
+}
+```

package/dist/docs/reference/index/GeneratorParamId.md

@@ -0,0 +1,10 @@
+# GeneratorParamId
+
+The declared parameter ID union for a Generator definition.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** The declared parameter ID union for a Generator definition. */
+export type GeneratorParamId<D extends GeneratorDefinition> = Extract<D["parameters"][number]["id"], string>;
+```

package/dist/docs/reference/index/GeneratorParams.md

@@ -0,0 +1,12 @@
+# GeneratorParams
+
+Exact normalized parameter values derived from a Generator definition.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Exact normalized parameter values derived from a Generator definition. */
+export type GeneratorParams<D extends GeneratorDefinition> = {
+    readonly [Parameter in D["parameters"][number] as Parameter["id"]]: ParameterValueFor<Parameter>;
+};
+```

package/dist/docs/reference/index/GeneratorPreset.md

@@ -0,0 +1,14 @@
+# GeneratorPreset
+
+GeneratorPreset exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface GeneratorPreset<D extends GeneratorDefinition = GeneratorDefinition> {
+    readonly id: string;
+    readonly label: string;
+    readonly description?: string | undefined;
+    readonly parameterValues: GeneratorParams<D>;
+}
+```

package/dist/docs/reference/index/GeneratorProgram.md

@@ -0,0 +1,13 @@
+# GeneratorProgram
+
+Structural program boundary; the SDK never imports a Modeling runtime or kernel.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Structural program boundary; the SDK never imports a Modeling runtime or kernel. */
+export interface GeneratorProgram {
+    readonly kind: "metamesh-model";
+    readonly generate: (context: never) => unknown;
+}
+```

package/dist/docs/reference/index/GeneratorServices.md

@@ -0,0 +1,15 @@
+# GeneratorServices
+
+Host services are local to an execution; functions never cross the Worker protocol.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Host services are local to an execution; functions never cross the Worker protocol. */
+export interface GeneratorServices {
+    readonly text: {
+        /** Prepares vector paths and metrics for imported textSection() and sampleTextContours(). */
+        readonly layout: (text: string, options: GeneratorTextOptions) => GeneratorTextLayout;
+    };
+}
+```

package/dist/docs/reference/index/GeneratorTextArcBaseline.md

@@ -0,0 +1,18 @@
+# GeneratorTextArcBaseline
+
+Circular text baseline centered at the XY origin; glyph groups retain their proportions.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Circular text baseline centered at the XY origin; glyph groups retain their proportions. */
+export interface GeneratorTextArcBaseline {
+    readonly kind: "arc";
+    /** Baseline radius in millimetres, greater than zero and at most 10000. */
+    readonly radius: number;
+    /** Alignment datum in degrees counterclockwise from +X; defaults to 90. */
+    readonly centerAngleDegrees?: number;
+    /** Reading direction; defaults to clockwise. */
+    readonly direction?: "clockwise" | "counterclockwise";
+}
+```

package/dist/docs/reference/index/GeneratorTextLayout.md

@@ -0,0 +1,13 @@
+# GeneratorTextLayout
+
+Exact vector paths and measurements in Y-up millimetres, never font bytes or live objects.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Exact vector paths and measurements in Y-up millimetres, never font bytes or live objects. */
+export interface GeneratorTextLayout {
+    readonly paths: readonly string[];
+    readonly metrics: GeneratorTextMetrics;
+}
+```

package/dist/docs/reference/index/GeneratorTextMetrics.md

@@ -0,0 +1,21 @@
+# GeneratorTextMetrics
+
+Structural mirror of Geometry text metrics, keeping the SDK renderer-independent.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Structural mirror of Geometry text metrics, keeping the SDK renderer-independent. */
+export interface GeneratorTextMetrics {
+    readonly bounds: {
+        readonly min: readonly [number, number];
+        readonly max: readonly [number, number];
+    } | null;
+    readonly advance: readonly [number, number];
+    readonly logicalWidth: number;
+    readonly ascent: number;
+    readonly descent: number;
+    readonly lineHeight: number;
+    readonly lineCount: number;
+}
+```

package/dist/docs/reference/index/GeneratorTextOptions.md

@@ -0,0 +1,19 @@
+# GeneratorTextOptions
+
+Text layout uses millimetres and prepared catalog fonts, with no runtime network access.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Text layout uses millimetres and prepared catalog fonts, with no runtime network access. */
+export interface GeneratorTextOptions {
+    readonly font: FontSelection;
+    readonly fontSize: number;
+    readonly letterSpacing?: number;
+    readonly lineHeight?: number;
+    readonly align?: "left" | "center" | "right";
+    /** One circular line with baseline vertical alignment; align defaults to center. */
+    readonly baseline?: GeneratorTextArcBaseline;
+    readonly verticalAlign?: "baseline" | "top" | "center" | "bottom";
+}
+```

package/dist/docs/reference/index/MAX_CONTOUR_SEGMENTS.md

@@ -0,0 +1,9 @@
+# MAX_CONTOUR_SEGMENTS
+
+Maximum number of straight or cubic segments in an editable closed cross section.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+MAX_CONTOUR_SEGMENTS = 32
+```

package/dist/docs/reference/index/MAX_SIDE_PROFILE_SEGMENTS.md

@@ -0,0 +1,9 @@
+# MAX_SIDE_PROFILE_SEGMENTS
+
+Maximum number of straight or cubic segments in an editable side profile.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+MAX_SIDE_PROFILE_SEGMENTS = 31
+```

package/dist/docs/reference/index/NumberArrayItemDefinition.md

@@ -0,0 +1,19 @@
+# NumberArrayItemDefinition
+
+NumberArrayItemDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface NumberArrayItemDefinition {
+    readonly type: "number";
+    /** Defaults and bounds must be integers; strict decoding rejects fractional items. */
+    readonly integer?: boolean | undefined;
+    readonly min?: number | undefined;
+    readonly max?: number | undefined;
+    readonly unit?: string | undefined;
+    readonly ui?: {
+        readonly step?: number | undefined;
+    } | undefined;
+}
+```

package/dist/docs/reference/index/NumberArrayParameterDefinition.md

@@ -0,0 +1,12 @@
+# NumberArrayParameterDefinition
+
+NumberArrayParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface NumberArrayParameterDefinition extends ArrayParameterBase {
+    readonly default: readonly number[];
+    readonly items: NumberArrayItemDefinition;
+}
+```

package/dist/docs/reference/index/NumberParameterDefinition.md

@@ -0,0 +1,19 @@
+# NumberParameterDefinition
+
+NumberParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface NumberParameterDefinition extends BaseParameterDefinition {
+    readonly type: "number";
+    readonly default: number;
+    /** Defaults and bounds must be integers; strict decoding rejects fractions. */
+    readonly integer?: boolean | undefined;
+    /** Saved maximum sampled curve deviation, requiring millimetres and positive bounds. */
+    readonly role?: "curve-resolution" | undefined;
+    readonly min?: number | undefined;
+    readonly max?: number | undefined;
+    readonly ui?: NumberParameterUi | undefined;
+}
+```

package/dist/docs/reference/index/NumberParameterUi.md

@@ -0,0 +1,14 @@
+# NumberParameterUi
+
+NumberParameterUi exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface NumberParameterUi extends RowParameterUi {
+    /** Defaults to number. A slider requires min, max, and a positive ui.step, and cannot share a row. */
+    readonly control?: "number" | "slider" | undefined;
+    /** Positive editing increment; it never constrains valid values to multiples. */
+    readonly step?: number | undefined;
+}
+```

package/dist/docs/reference/index/ParameterDefinition.md

@@ -0,0 +1,9 @@
+# ParameterDefinition
+
+ParameterDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type ParameterDefinition = NumberParameterDefinition | BooleanParameterDefinition | ChoiceParameterDefinition | ChoiceSetParameterDefinition | ColorParameterDefinition | TextParameterDefinition | FontParameterDefinition | SvgParameterDefinition | SideProfileParameterDefinition | ContourParameterDefinition | ArrayParameterDefinition;
+```

package/dist/docs/reference/index/ParameterDefinitionDocument.md

@@ -0,0 +1,12 @@
+# ParameterDefinitionDocument
+
+ParameterDefinitionDocument exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ParameterDefinitionDocument {
+    readonly groups: readonly ParameterGroup[];
+    readonly parameters: readonly ParameterDefinition[];
+}
+```

package/dist/docs/reference/index/ParameterGroup.md

@@ -0,0 +1,15 @@
+# ParameterGroup
+
+Ordered presentation group; these objects contain no value semantics.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Ordered presentation group; these objects contain no value semantics. */
+export interface ParameterGroup {
+    readonly id: string;
+    readonly label: string;
+    readonly description?: string | undefined;
+    readonly collapsed?: boolean | undefined;
+}
+```

package/dist/docs/reference/index/ParameterIssue.md

@@ -0,0 +1,17 @@
+# ParameterIssue
+
+ParameterIssue exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ParameterIssue {
+    readonly severity: ParameterIssueSeverity;
+    readonly parameterId?: string | undefined;
+    readonly message: string;
+    /** Optional stable category; messages remain suitable for existing hosts. */
+    readonly code?: ParameterIssueCode | undefined;
+    /** Location relative to this parameter value; omitted or empty means the whole value. */
+    readonly path?: readonly (number | string)[] | undefined;
+}
+```