@metamesh/generator-sdk 0.12.0 → 0.13.0

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

@@ -0,0 +1,10 @@
+# ParameterIssueCode
+
+Stable machine-readable categories shared by schema, authoring and strict decoding.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Stable machine-readable categories shared by schema, authoring and strict decoding. */
+export type ParameterIssueCode = "invalid" | "missing" | "type" | "unknown" | "minimum" | "maximum" | "integer" | "choice" | "duplicate" | "length" | "bytes" | "structure";
+```

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

@@ -0,0 +1,9 @@
+# ParameterIssueSeverity
+
+ParameterIssueSeverity exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type ParameterIssueSeverity = "error" | "warning";
+```

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

@@ -0,0 +1,13 @@
+# ParameterScaleReference
+
+Positive editing-unit reference to a declared millimetre dimension; saved coordinates stay normalized.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Positive editing-unit reference to a declared millimetre dimension; saved coordinates stay normalized. */
+export interface ParameterScaleReference {
+    readonly parameterId: string;
+    readonly factor: number;
+}
+```

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

@@ -0,0 +1,15 @@
+# ParameterUi
+
+Presentation hints shared by every parameter editor. Hidden values remain valid and saved.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Presentation hints shared by every parameter editor. Hidden values remain valid and saved. */
+export interface ParameterUi {
+    readonly group?: string | undefined;
+    /** Essential instruction displayed inline whenever this control is visible. */
+    readonly hint?: string | undefined;
+    readonly visibleWhen?: ConditionExpression | undefined;
+}
+```

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

@@ -0,0 +1,14 @@
+# ParameterValidationResult
+
+ParameterValidationResult exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface ParameterValidationResult {
+    readonly isValid: boolean;
+    readonly issues: readonly ParameterIssue[];
+    readonly errors: readonly ParameterIssue[];
+    readonly warnings: readonly ParameterIssue[];
+}
+```

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

@@ -0,0 +1,9 @@
+# ParameterValue
+
+ParameterValue exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type ParameterValue = ScalarParameterValue | readonly number[] | readonly string[] | FontSelection | SideProfileValue | ContourValue;
+```

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

@@ -0,0 +1,9 @@
+# ParameterValues
+
+ParameterValues exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type ParameterValues = Readonly<Record<string, ParameterValue>>;
+```

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

@@ -0,0 +1,12 @@
+# RowParameterUi
+
+RowParameterUi exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface RowParameterUi extends ParameterUi {
+    /** At most two adjacent controls in the same group may share equal-width space. */
+    readonly row?: string | undefined;
+}
+```

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

@@ -0,0 +1,9 @@
+# ScalarParameterValue
+
+ScalarParameterValue exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type ScalarParameterValue = number | boolean | string;
+```

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

@@ -0,0 +1,12 @@
+# SideProfileAnchor
+
+Editing intent is retained alongside the explicit curve controls.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Editing intent is retained alongside the explicit curve controls. */
+export interface SideProfileAnchor extends SideProfilePoint {
+    readonly mode: "auto" | "smooth" | "corner";
+}
+```

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

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

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

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

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

@@ -0,0 +1,13 @@
+# SideProfilePoint
+
+Normalized radius and upward height; both coordinates lie between zero and one.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Normalized radius and upward height; both coordinates lie between zero and one. */
+export interface SideProfilePoint {
+    readonly radius: number;
+    readonly height: number;
+}
+```

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

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

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

@@ -0,0 +1,14 @@
+# SideProfileValue
+
+An open, upward side silhouette. Generators own scaling and solid closure.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** An open, upward side silhouette. Generators own scaling and solid closure. */
+export interface SideProfileValue {
+    readonly version: 1;
+    readonly start: SideProfileAnchor;
+    readonly segments: readonly SideProfileSegment[];
+}
+```

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

@@ -0,0 +1,15 @@
+# SourceVisibility
+
+Declares whether a project may expose client-delivered source in MetaMesh.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/**
+ * Declares whether a project may expose client-delivered source in MetaMesh.
+ *
+ * This presentation and authoring capability is not a licensing or security boundary.
+ * Hidden source remains accessible if delivered elsewhere in a client bundle.
+ */
+export type SourceVisibility = "hidden" | "view" | "editable";
+```

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

@@ -0,0 +1,11 @@
+# StringArrayItemDefinition
+
+StringArrayItemDefinition exported from @metamesh/generator-sdk.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface StringArrayItemDefinition {
+    readonly type: "string";
+}
+```

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+# UNPREPARED_GENERATOR_SERVICES
+
+A font-free execution fails explicitly if a callback requests unprepared text geometry.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+UNPREPARED_GENERATOR_SERVICES: GeneratorServices
+```

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

@@ -0,0 +1,10 @@
+# cloneContourValue
+
+Returns a fresh, deeply frozen closed contour, including its editing intent.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Returns a fresh, deeply frozen closed contour, including its editing intent. */
+export declare function cloneContourValue(value: ContourValue): ContourValue;
+```

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

@@ -0,0 +1,10 @@
+# cloneSideProfileValue
+
+Returns a fresh, deeply frozen portable profile, including its editing intent.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Returns a fresh, deeply frozen portable profile, including its editing intent. */
+export declare function cloneSideProfileValue(value: SideProfileValue): SideProfileValue;
+```

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

@@ -0,0 +1,10 @@
+# contourValuesEqual
+
+Compares the serialized shape and editing intent rather than object identity.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Compares the serialized shape and editing intent rather than object identity. */
+export declare function contourValuesEqual(previous: ContourValue, next: ContourValue): boolean;
+```

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

@@ -0,0 +1,10 @@
+# defineGenerator
+
+Captures literal IDs and options; the host validates serializable metadata.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Captures literal IDs and options; the host validates serializable metadata. */
+export declare function defineGenerator<const D extends GeneratorDefinition>(definition: D): D;
+```

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

@@ -0,0 +1,10 @@
+# defineGeneratorModule
+
+Binds a Modeling program to serializable identity without executing it.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Binds a Modeling program to serializable identity without executing it. */
+export declare function defineGeneratorModule<const D extends GeneratorDefinition, Program extends GeneratorProgram>({ definition, generate }: GeneratorModuleOptions<D, Program>): GeneratorModule<D, Program>;
+```

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

@@ -0,0 +1,10 @@
+# definePresets
+
+Contextually types complete presets from the same definition as the controls.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Contextually types complete presets from the same definition as the controls. */
+export declare function definePresets<const D extends GeneratorDefinition, const Presets extends readonly GeneratorPreset<NoInfer<D>>[]>(_definition: D, presets: Presets): Presets;
+```

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

@@ -0,0 +1,13 @@
+# evaluateCondition
+
+Evaluates a serializable visibility condition. A comparison against a missing parameter is always false, including `ne`.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/**
+ * Evaluates a serializable visibility condition. A comparison against a
+ * missing parameter is always false, including `ne`.
+ */
+export declare function evaluateCondition(condition: ConditionExpression, parameters: ParameterValues): boolean;
+```

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

@@ -0,0 +1,10 @@
+# isContourValue
+
+Checks portable data and explicit closure without evaluating getters or inspecting topology.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Checks portable data and explicit closure without evaluating getters or inspecting topology. */
+export declare function isContourValue(value: unknown): value is ContourValue;
+```

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

@@ -0,0 +1,10 @@
+# isFontSelection
+
+Checks only the portable value, without consulting a catalog or substituting fonts.
+
+Import from `@metamesh/generator-sdk` (@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/isSideProfileValue.md

@@ -0,0 +1,10 @@
+# isSideProfileValue
+
+Strictly checks portable profile data without evaluating getters or invoking curve libraries.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Strictly checks portable profile data without evaluating getters or invoking curve libraries. */
+export declare function isSideProfileValue(value: unknown): value is SideProfileValue;
+```

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

@@ -0,0 +1,10 @@
+# sideProfileValuesEqual
+
+Compares the serialized shape and editing intent rather than object identity.
+
+Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+/** Compares the serialized shape and editing intent rather than object identity. */
+export declare function sideProfileValuesEqual(previous: SideProfileValue, next: SideProfileValue): boolean;
+```

package/dist/docs/reference/packages/GENERATOR_PACKAGE_FORMAT_VERSION.md

@@ -0,0 +1,9 @@
+# GENERATOR_PACKAGE_FORMAT_VERSION
+
+GENERATOR_PACKAGE_FORMAT_VERSION exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+GENERATOR_PACKAGE_FORMAT_VERSION = 4
+```

package/dist/docs/reference/packages/GeneratorAccess.md

@@ -0,0 +1,9 @@
+# GeneratorAccess
+
+GeneratorAccess exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type GeneratorAccess = GeneratorPackageManifest["access"];
+```

package/dist/docs/reference/packages/GeneratorDefinitionIssue.md

@@ -0,0 +1,14 @@
+# GeneratorDefinitionIssue
+
+GeneratorDefinitionIssue exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface GeneratorDefinitionIssue {
+    readonly kind: "structural" | "semantic";
+    readonly path: readonly (string | number)[];
+    readonly code: ParameterIssueCode;
+    readonly message: string;
+}
+```

package/dist/docs/reference/packages/GeneratorDefinitionParseResult.md

@@ -0,0 +1,15 @@
+# GeneratorDefinitionParseResult
+
+GeneratorDefinitionParseResult exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type GeneratorDefinitionParseResult<T> = {
+    readonly success: true;
+    readonly data: T;
+} | {
+    readonly success: false;
+    readonly issues: readonly GeneratorDefinitionIssue[];
+};
+```

package/dist/docs/reference/packages/GeneratorDescriptor.md

@@ -0,0 +1,9 @@
+# GeneratorDescriptor
+
+GeneratorDescriptor exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type GeneratorDescriptor = z.output<typeof generatorDescriptorSchema>;
+```

package/dist/docs/reference/packages/GeneratorPackageManifest.md

@@ -0,0 +1,11 @@
+# GeneratorPackageManifest
+
+GeneratorPackageManifest exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type GeneratorPackageManifest = Omit<z.output<typeof generatorPackageManifestSchema>, "definition"> & {
+    readonly definition: GeneratorDefinition;
+};
+```

package/dist/docs/reference/packages/GeneratorPackageSource.md

@@ -0,0 +1,9 @@
+# GeneratorPackageSource
+
+GeneratorPackageSource exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type GeneratorPackageSource = GeneratorPackageManifest["source"];
+```

package/dist/docs/reference/packages/GeneratorPackageValidationError.md

@@ -0,0 +1,12 @@
+# GeneratorPackageValidationError
+
+GeneratorPackageValidationError exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export declare class GeneratorPackageValidationError extends Error {
+    readonly issues: readonly GeneratorDefinitionIssue[];
+    constructor(message: string, issues?: readonly GeneratorDefinitionIssue[]);
+}
+```

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

@@ -0,0 +1,14 @@
+# GeneratorPreset
+
+GeneratorPreset exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@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/packages/GeneratorRuntimeReference.md

@@ -0,0 +1,15 @@
+# GeneratorRuntimeReference
+
+GeneratorRuntimeReference exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export type GeneratorRuntimeReference = {
+    readonly kind: "bundled";
+    readonly version: string;
+} | {
+    readonly kind: "installed";
+    readonly version: string;
+};
+```

package/dist/docs/reference/packages/InstalledGenerator.md

@@ -0,0 +1,15 @@
+# InstalledGenerator
+
+InstalledGenerator exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+export interface InstalledGenerator {
+    readonly generatorId: string;
+    readonly installedAt: string;
+    readonly integrity: string;
+    readonly source: "bundled" | "downloaded";
+    readonly version: string;
+}
+```

package/dist/docs/reference/packages/MAX_ARRAY_ITEMS.md

@@ -0,0 +1,9 @@
+# MAX_ARRAY_ITEMS
+
+MAX_ARRAY_ITEMS exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+MAX_ARRAY_ITEMS = 1024
+```

package/dist/docs/reference/packages/MAX_CONDITION_BRANCHES.md

@@ -0,0 +1,9 @@
+# MAX_CONDITION_BRANCHES
+
+MAX_CONDITION_BRANCHES exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+MAX_CONDITION_BRANCHES = 32
+```

package/dist/docs/reference/packages/MAX_CONDITION_DEPTH.md

@@ -0,0 +1,9 @@
+# MAX_CONDITION_DEPTH
+
+MAX_CONDITION_DEPTH exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+MAX_CONDITION_DEPTH = 8
+```

package/dist/docs/reference/packages/MAX_DESCRIPTOR_LIST_ITEMS.md

@@ -0,0 +1,9 @@
+# MAX_DESCRIPTOR_LIST_ITEMS
+
+MAX_DESCRIPTOR_LIST_ITEMS exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+MAX_DESCRIPTOR_LIST_ITEMS = 128
+```

package/dist/docs/reference/packages/MAX_GENERATOR_ID_LENGTH.md

@@ -0,0 +1,9 @@
+# MAX_GENERATOR_ID_LENGTH
+
+Portable metadata limits enforced before package content reaches Studio.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+MAX_GENERATOR_ID_LENGTH = 120
+```

package/dist/docs/reference/packages/MAX_GENERATOR_PACKAGE_BYTES.md

@@ -0,0 +1,9 @@
+# MAX_GENERATOR_PACKAGE_BYTES
+
+MAX_GENERATOR_PACKAGE_BYTES exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+MAX_GENERATOR_PACKAGE_BYTES: number
+```

package/dist/docs/reference/packages/MAX_GENERATOR_PRESETS.md

@@ -0,0 +1,9 @@
+# MAX_GENERATOR_PRESETS
+
+MAX_GENERATOR_PRESETS exported from @metamesh/generator-sdk/packages.
+
+Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
+
+```ts
+MAX_GENERATOR_PRESETS = 256
+```