@metamesh/generator-sdk 0.12.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +24 -0
- package/README.md +67 -66
- package/dist/contracts.d.ts +5 -5
- package/dist/contracts.d.ts.map +1 -1
- package/dist/docs/guides/authoring.md +114 -0
- package/dist/docs/guides/package.md +120 -0
- package/dist/docs/guides/parameters.md +429 -0
- package/dist/docs/manifest.json +2361 -0
- package/dist/docs/reference/fonts/FontSelection.md +14 -0
- package/dist/docs/reference/fonts/isFontSelection.md +10 -0
- package/dist/docs/reference/index/ArrayParameterDefinition.md +12 -0
- package/dist/docs/reference/index/BaseParameterDefinition.md +16 -0
- package/dist/docs/reference/index/BooleanParameterDefinition.md +12 -0
- package/dist/docs/reference/index/ChoiceOption.md +13 -0
- package/dist/docs/reference/index/ChoiceParameterDefinition.md +14 -0
- package/dist/docs/reference/index/ChoiceSetParameterDefinition.md +15 -0
- package/dist/docs/reference/index/ColorParameterDefinition.md +12 -0
- package/dist/docs/reference/index/ConditionExpression.md +36 -0
- package/dist/docs/reference/index/ContourAnchor.md +12 -0
- package/dist/docs/reference/index/ContourParameterDefinition.md +13 -0
- package/dist/docs/reference/index/ContourParameterUi.md +12 -0
- package/dist/docs/reference/index/ContourPoint.md +13 -0
- package/dist/docs/reference/index/ContourSegment.md +17 -0
- package/dist/docs/reference/index/ContourValue.md +14 -0
- package/dist/docs/reference/index/FontParameterDefinition.md +12 -0
- package/dist/docs/reference/index/FontSelection.md +14 -0
- package/dist/docs/reference/index/GeneratorDefinition.md +14 -0
- package/dist/docs/reference/index/GeneratorIssue.md +12 -0
- package/dist/docs/reference/index/GeneratorModule.md +15 -0
- package/dist/docs/reference/index/GeneratorModuleOptions.md +12 -0
- package/dist/docs/reference/index/GeneratorParamId.md +10 -0
- package/dist/docs/reference/index/GeneratorParams.md +12 -0
- package/dist/docs/reference/index/GeneratorPreset.md +14 -0
- package/dist/docs/reference/index/GeneratorProgram.md +13 -0
- package/dist/docs/reference/index/GeneratorServices.md +15 -0
- package/dist/docs/reference/index/GeneratorTextArcBaseline.md +18 -0
- package/dist/docs/reference/index/GeneratorTextLayout.md +13 -0
- package/dist/docs/reference/index/GeneratorTextMetrics.md +21 -0
- package/dist/docs/reference/index/GeneratorTextOptions.md +19 -0
- package/dist/docs/reference/index/MAX_CONTOUR_SEGMENTS.md +9 -0
- package/dist/docs/reference/index/MAX_SIDE_PROFILE_SEGMENTS.md +9 -0
- package/dist/docs/reference/index/NumberArrayItemDefinition.md +19 -0
- package/dist/docs/reference/index/NumberArrayParameterDefinition.md +12 -0
- package/dist/docs/reference/index/NumberParameterDefinition.md +19 -0
- package/dist/docs/reference/index/NumberParameterUi.md +14 -0
- package/dist/docs/reference/index/ParameterDefinition.md +9 -0
- package/dist/docs/reference/index/ParameterDefinitionDocument.md +12 -0
- package/dist/docs/reference/index/ParameterGroup.md +15 -0
- package/dist/docs/reference/index/ParameterIssue.md +17 -0
- package/dist/docs/reference/index/ParameterIssueCode.md +10 -0
- package/dist/docs/reference/index/ParameterIssueSeverity.md +9 -0
- package/dist/docs/reference/index/ParameterScaleReference.md +13 -0
- package/dist/docs/reference/index/ParameterUi.md +15 -0
- package/dist/docs/reference/index/ParameterValidationResult.md +14 -0
- package/dist/docs/reference/index/ParameterValue.md +9 -0
- package/dist/docs/reference/index/ParameterValues.md +9 -0
- package/dist/docs/reference/index/RowParameterUi.md +12 -0
- package/dist/docs/reference/index/ScalarParameterValue.md +9 -0
- package/dist/docs/reference/index/SideProfileAnchor.md +12 -0
- package/dist/docs/reference/index/SideProfileParameterDefinition.md +13 -0
- package/dist/docs/reference/index/SideProfileParameterUi.md +12 -0
- package/dist/docs/reference/index/SideProfilePoint.md +13 -0
- package/dist/docs/reference/index/SideProfileSegment.md +17 -0
- package/dist/docs/reference/index/SideProfileValue.md +14 -0
- package/dist/docs/reference/index/SourceVisibility.md +15 -0
- package/dist/docs/reference/index/StringArrayItemDefinition.md +11 -0
- package/dist/docs/reference/index/StringArrayParameterDefinition.md +12 -0
- package/dist/docs/reference/index/SvgParameterDefinition.md +12 -0
- package/dist/docs/reference/index/TextParameterDefinition.md +13 -0
- package/dist/docs/reference/index/UNPREPARED_GENERATOR_SERVICES.md +9 -0
- package/dist/docs/reference/index/cloneContourValue.md +10 -0
- package/dist/docs/reference/index/cloneSideProfileValue.md +10 -0
- package/dist/docs/reference/index/contourValuesEqual.md +10 -0
- package/dist/docs/reference/index/defineGenerator.md +10 -0
- package/dist/docs/reference/index/defineGeneratorModule.md +10 -0
- package/dist/docs/reference/index/definePresets.md +10 -0
- package/dist/docs/reference/index/evaluateCondition.md +13 -0
- package/dist/docs/reference/index/isContourValue.md +10 -0
- package/dist/docs/reference/index/isFontSelection.md +10 -0
- package/dist/docs/reference/index/isSideProfileValue.md +10 -0
- package/dist/docs/reference/index/sideProfileValuesEqual.md +10 -0
- package/dist/docs/reference/packages/GENERATOR_PACKAGE_FORMAT_VERSION.md +9 -0
- package/dist/docs/reference/packages/GeneratorAccess.md +9 -0
- package/dist/docs/reference/packages/GeneratorDefinitionIssue.md +14 -0
- package/dist/docs/reference/packages/GeneratorDefinitionParseResult.md +15 -0
- package/dist/docs/reference/packages/GeneratorDescriptor.md +9 -0
- package/dist/docs/reference/packages/GeneratorPackageManifest.md +11 -0
- package/dist/docs/reference/packages/GeneratorPackageSource.md +9 -0
- package/dist/docs/reference/packages/GeneratorPackageValidationError.md +12 -0
- package/dist/docs/reference/packages/GeneratorPreset.md +14 -0
- package/dist/docs/reference/packages/GeneratorRuntimeReference.md +15 -0
- package/dist/docs/reference/packages/InstalledGenerator.md +15 -0
- package/dist/docs/reference/packages/MAX_ARRAY_ITEMS.md +9 -0
- package/dist/docs/reference/packages/MAX_CONDITION_BRANCHES.md +9 -0
- package/dist/docs/reference/packages/MAX_CONDITION_DEPTH.md +9 -0
- package/dist/docs/reference/packages/MAX_DESCRIPTOR_LIST_ITEMS.md +9 -0
- package/dist/docs/reference/packages/MAX_GENERATOR_ID_LENGTH.md +9 -0
- package/dist/docs/reference/packages/MAX_GENERATOR_PACKAGE_BYTES.md +9 -0
- package/dist/docs/reference/packages/MAX_GENERATOR_PRESETS.md +9 -0
- package/dist/docs/reference/packages/MAX_METADATA_TEXT_LENGTH.md +9 -0
- package/dist/docs/reference/packages/MAX_PARAMETERS.md +9 -0
- package/dist/docs/reference/packages/MAX_PARAMETER_GROUPS.md +9 -0
- package/dist/docs/reference/packages/MAX_PARAMETER_OPTIONS.md +9 -0
- package/dist/docs/reference/packages/MAX_TEXT_PARAMETER_LENGTH.md +9 -0
- package/dist/docs/reference/packages/METAMESH_RUNTIME_VERSION.md +9 -0
- package/dist/docs/reference/packages/compareSemanticVersions.md +9 -0
- package/dist/docs/reference/packages/definitionIssuesFromZod.md +10 -0
- package/dist/docs/reference/packages/isRuntimeCompatible.md +9 -0
- package/dist/docs/reference/packages/parseGeneratorDefinition.md +9 -0
- package/dist/docs/reference/packages/parseGeneratorDescriptor.md +9 -0
- package/dist/docs/reference/packages/parseGeneratorPackageManifest.md +9 -0
- package/dist/docs/reference/packages/parseParameterDefinitionDocument.md +9 -0
- package/dist/docs/reference/packages/safeParseGeneratorDefinition.md +10 -0
- package/dist/docs/reference/packages/safeParseParameterDefinitionDocument.md +10 -0
- package/dist/docs/reference/packages/validateGeneratorPresets.md +10 -0
- package/dist/docs/reference/packages/validationErrorFromIssues.md +9 -0
- package/dist/docs/reference/packages/validationErrorFromZod.md +9 -0
- package/dist/docs/reference/parameters/EMPTY_SVG_PARAMETER_DEFAULT.md +9 -0
- package/dist/docs/reference/parameters/MAX_PARAMETER_ISSUES.md +9 -0
- package/dist/docs/reference/parameters/MAX_PARAMETER_ISSUE_MESSAGE_LENGTH.md +9 -0
- package/dist/docs/reference/parameters/MAX_PROJECT_SVG_PARAMETER_BYTES.md +9 -0
- package/dist/docs/reference/parameters/MAX_SVG_PARAMETER_BYTES.md +9 -0
- package/dist/docs/reference/parameters/ParamCodec.md +14 -0
- package/dist/docs/reference/parameters/ParamDecodeCode.md +9 -0
- package/dist/docs/reference/parameters/ParamDecodeError.md +12 -0
- package/dist/docs/reference/parameters/ParamDecodeIssue.md +14 -0
- package/dist/docs/reference/parameters/ParamParseResult.md +15 -0
- package/dist/docs/reference/parameters/PreparedParameters.md +12 -0
- package/dist/docs/reference/parameters/aggregateParameterIssues.md +10 -0
- package/dist/docs/reference/parameters/canonicalizeParameters.md +10 -0
- package/dist/docs/reference/parameters/createParamCodec.md +13 -0
- package/dist/docs/reference/parameters/getDefaultParameters.md +9 -0
- package/dist/docs/reference/parameters/normalizeParameters.md +13 -0
- package/dist/docs/reference/parameters/parameterValueEquals.md +9 -0
- package/dist/docs/reference/parameters/parseParameterIssues.md +15 -0
- package/dist/docs/reference/parameters/prepareParameters.md +13 -0
- package/dist/docs/reference/parameters/svgParameterBytes.md +9 -0
- package/dist/docs/reference/parameters/validateParameters.md +10 -0
- package/dist/docs/reference/runtime/ExecuteGeneratorOptions.md +18 -0
- package/dist/docs/reference/runtime/Export3mfRequest.md +18 -0
- package/dist/docs/reference/runtime/ExportError.md +13 -0
- package/dist/docs/reference/runtime/ExportSuccess.md +13 -0
- package/dist/docs/reference/runtime/ExportedFile.md +13 -0
- package/dist/docs/reference/runtime/GenerateRequest.md +16 -0
- package/dist/docs/reference/runtime/GeneratedModel.md +17 -0
- package/dist/docs/reference/runtime/GeneratedModelDelivery.md +12 -0
- package/dist/docs/reference/runtime/GeneratedPart.md +20 -0
- package/dist/docs/reference/runtime/GeneratedPartDelivery.md +13 -0
- package/dist/docs/reference/runtime/GeneratedPartsDecoder.md +24 -0
- package/dist/docs/reference/runtime/GeneratedPartsLimits.md +15 -0
- package/dist/docs/reference/runtime/GenerationError.md +13 -0
- package/dist/docs/reference/runtime/GenerationInvalid.md +13 -0
- package/dist/docs/reference/runtime/GenerationSuccess.md +15 -0
- package/dist/docs/reference/runtime/GeneratorExecutionGenerated.md +14 -0
- package/dist/docs/reference/runtime/GeneratorExecutionInvalid.md +13 -0
- package/dist/docs/reference/runtime/GeneratorExecutionResult.md +9 -0
- package/dist/docs/reference/runtime/MeshTopologyMode.md +10 -0
- package/dist/docs/reference/runtime/ModelBounds.md +12 -0
- package/dist/docs/reference/runtime/ModelStats.md +15 -0
- package/dist/docs/reference/runtime/ModelTimings.md +27 -0
- package/dist/docs/reference/runtime/ParsedGeneratorModule.md +9 -0
- package/dist/docs/reference/runtime/RuntimeError.md +14 -0
- package/dist/docs/reference/runtime/ValidateRequest.md +15 -0
- package/dist/docs/reference/runtime/ValidationError.md +13 -0
- package/dist/docs/reference/runtime/ValidationSuccess.md +13 -0
- package/dist/docs/reference/runtime/WorkerRequest.md +9 -0
- package/dist/docs/reference/runtime/WorkerResponse.md +9 -0
- package/dist/docs/reference/runtime/executeGenerator.md +10 -0
- package/dist/docs/reference/runtime/generationIssues.md +10 -0
- package/dist/docs/reference/runtime/isGeneratorModule.md +9 -0
- package/dist/docs/reference/runtime/parseGeneratedParts.md +15 -0
- package/dist/docs/reference/runtime/parseGenerationSentAt.md +10 -0
- package/dist/docs/reference/runtime/parseGeneratorModule.md +10 -0
- package/dist/generator-package/constants.d.ts +1 -1
- package/dist/generator-package/constants.js +1 -1
- package/dist/generator-package/validate-manifest.js +2 -2
- package/dist/parameters/issues.d.ts +2 -2
- package/dist/parameters/issues.js +2 -2
- package/dist/parameters/strict.d.ts +4 -3
- package/dist/parameters/strict.d.ts.map +1 -1
- package/dist/parameters/strict.js +2 -3
- package/dist/parameters/strict.js.map +1 -1
- package/dist/{execute-generator.d.ts → runtime/execute-generator.d.ts} +4 -4
- package/dist/runtime/execute-generator.d.ts.map +1 -0
- package/dist/{execute-generator.js → runtime/execute-generator.js} +1 -1
- package/dist/runtime/execute-generator.js.map +1 -0
- package/dist/{generated-parts.d.ts → runtime/generated-parts.d.ts} +1 -1
- package/dist/runtime/generated-parts.d.ts.map +1 -0
- package/dist/runtime/generated-parts.js.map +1 -0
- package/dist/{parse-generator-module.d.ts → runtime/parse-generator-module.d.ts} +2 -2
- package/dist/runtime/parse-generator-module.d.ts.map +1 -0
- package/dist/{parse-generator-module.js → runtime/parse-generator-module.js} +1 -1
- package/dist/runtime/parse-generator-module.js.map +1 -0
- package/dist/{worker-contracts.d.ts → runtime/worker-contracts.d.ts} +2 -2
- package/dist/runtime/worker-contracts.d.ts.map +1 -0
- package/dist/runtime/worker-contracts.js.map +1 -0
- package/dist/runtime.d.ts +8 -8
- package/dist/runtime.d.ts.map +1 -1
- package/dist/runtime.js +4 -4
- package/dist/runtime.js.map +1 -1
- package/dist/source-visibility.d.ts +2 -3
- package/dist/source-visibility.d.ts.map +1 -1
- package/package.json +4 -3
- package/dist/execute-generator.d.ts.map +0 -1
- package/dist/execute-generator.js.map +0 -1
- package/dist/generated-parts.d.ts.map +0 -1
- package/dist/generated-parts.js.map +0 -1
- package/dist/parse-generator-module.d.ts.map +0 -1
- package/dist/parse-generator-module.js.map +0 -1
- package/dist/worker-contracts.d.ts.map +0 -1
- package/dist/worker-contracts.js.map +0 -1
- /package/dist/{generated-parts.js → runtime/generated-parts.js} +0 -0
- /package/dist/{worker-contracts.js → runtime/worker-contracts.js} +0 -0
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# compareSemanticVersions
|
|
2
|
+
|
|
3
|
+
compareSemanticVersions exported from @metamesh/generator-sdk/packages.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function compareSemanticVersions(left: string, right: string): number;
|
|
9
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# definitionIssuesFromZod
|
|
2
|
+
|
|
3
|
+
Custom refinements need SDK markers because JSON Schema cannot represent them.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Custom refinements need SDK markers because JSON Schema cannot represent them. */
|
|
9
|
+
export declare function definitionIssuesFromZod(error: ZodError): readonly GeneratorDefinitionIssue[];
|
|
10
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# isRuntimeCompatible
|
|
2
|
+
|
|
3
|
+
isRuntimeCompatible exported from @metamesh/generator-sdk/packages.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function isRuntimeCompatible(requiredVersion: string, currentVersion?: string): boolean;
|
|
9
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# parseGeneratorDefinition
|
|
2
|
+
|
|
3
|
+
parseGeneratorDefinition exported from @metamesh/generator-sdk/packages.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function parseGeneratorDefinition(value: unknown): GeneratorDefinition;
|
|
9
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# parseGeneratorDescriptor
|
|
2
|
+
|
|
3
|
+
parseGeneratorDescriptor exported from @metamesh/generator-sdk/packages.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function parseGeneratorDescriptor(value: unknown): GeneratorDescriptor;
|
|
9
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# parseGeneratorPackageManifest
|
|
2
|
+
|
|
3
|
+
parseGeneratorPackageManifest exported from @metamesh/generator-sdk/packages.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function parseGeneratorPackageManifest(value: unknown): GeneratorPackageManifest;
|
|
9
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# parseParameterDefinitionDocument
|
|
2
|
+
|
|
3
|
+
parseParameterDefinitionDocument exported from @metamesh/generator-sdk/packages.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function parseParameterDefinitionDocument(value: unknown): ParameterDefinitionDocument;
|
|
9
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# safeParseGeneratorDefinition
|
|
2
|
+
|
|
3
|
+
Validates untrusted Generator metadata, collecting independent semantic issues.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Validates untrusted Generator metadata, collecting independent semantic issues. */
|
|
9
|
+
export declare function safeParseGeneratorDefinition(value: unknown): GeneratorDefinitionParseResult<GeneratorDefinition>;
|
|
10
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# safeParseParameterDefinitionDocument
|
|
2
|
+
|
|
3
|
+
Validates the editable groups/parameters document; issue paths are relative to its root.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Validates the editable groups/parameters document; issue paths are relative to its root. */
|
|
9
|
+
export declare function safeParseParameterDefinitionDocument(value: unknown): GeneratorDefinitionParseResult<ParameterDefinitionDocument>;
|
|
10
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# validateGeneratorPresets
|
|
2
|
+
|
|
3
|
+
Validates strict preset metadata, completeness, and canonical parameter normalization.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Validates strict preset metadata, completeness, and canonical parameter normalization. */
|
|
9
|
+
export declare function validateGeneratorPresets(definition: GeneratorDefinition, presets: readonly GeneratorPreset[], path?: string): void;
|
|
10
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# validationErrorFromIssues
|
|
2
|
+
|
|
3
|
+
validationErrorFromIssues exported from @metamesh/generator-sdk/packages.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function validationErrorFromIssues(context: string, issues: readonly GeneratorDefinitionIssue[]): GeneratorPackageValidationError;
|
|
9
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# validationErrorFromZod
|
|
2
|
+
|
|
3
|
+
validationErrorFromZod exported from @metamesh/generator-sdk/packages.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function validationErrorFromZod(context: string, error: ZodError): GeneratorPackageValidationError;
|
|
9
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# EMPTY_SVG_PARAMETER_DEFAULT
|
|
2
|
+
|
|
3
|
+
EMPTY_SVG_PARAMETER_DEFAULT exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
EMPTY_SVG_PARAMETER_DEFAULT = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"100mm\" height=\"100mm\" viewBox=\"-50 -50 100 100\"></svg>"
|
|
9
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# MAX_PARAMETER_ISSUE_MESSAGE_LENGTH
|
|
2
|
+
|
|
3
|
+
MAX_PARAMETER_ISSUE_MESSAGE_LENGTH exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
MAX_PARAMETER_ISSUE_MESSAGE_LENGTH = 1000
|
|
9
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# MAX_PROJECT_SVG_PARAMETER_BYTES
|
|
2
|
+
|
|
3
|
+
MAX_PROJECT_SVG_PARAMETER_BYTES exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
MAX_PROJECT_SVG_PARAMETER_BYTES: number
|
|
9
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# ParamCodec
|
|
2
|
+
|
|
3
|
+
ParamCodec exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface ParamCodec<D extends GeneratorDefinition> {
|
|
9
|
+
/** Returns a frozen parameter map or throws {@link ParamDecodeError} for validation failures. */
|
|
10
|
+
readonly parse: (input: unknown) => GeneratorParams<D>;
|
|
11
|
+
/** Returns validation issues instead of throwing {@link ParamDecodeError}. */
|
|
12
|
+
readonly safeParse: (input: unknown) => ParamParseResult<GeneratorParams<D>>;
|
|
13
|
+
}
|
|
14
|
+
```
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# ParamDecodeError
|
|
2
|
+
|
|
3
|
+
ParamDecodeError exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare class ParamDecodeError extends TypeError {
|
|
9
|
+
readonly issues: readonly ParamDecodeIssue[];
|
|
10
|
+
constructor(issues: readonly ParamDecodeIssue[]);
|
|
11
|
+
}
|
|
12
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# ParamDecodeIssue
|
|
2
|
+
|
|
3
|
+
ParamDecodeIssue exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface ParamDecodeIssue {
|
|
9
|
+
readonly code: ParamDecodeCode;
|
|
10
|
+
readonly parameterId?: string;
|
|
11
|
+
readonly path: readonly (number | string)[];
|
|
12
|
+
readonly message: string;
|
|
13
|
+
}
|
|
14
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# ParamParseResult
|
|
2
|
+
|
|
3
|
+
ParamParseResult exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export type ParamParseResult<P> = {
|
|
9
|
+
readonly success: true;
|
|
10
|
+
readonly data: P;
|
|
11
|
+
} | {
|
|
12
|
+
readonly success: false;
|
|
13
|
+
readonly issues: readonly ParamDecodeIssue[];
|
|
14
|
+
};
|
|
15
|
+
```
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# PreparedParameters
|
|
2
|
+
|
|
3
|
+
PreparedParameters exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface PreparedParameters<D extends GeneratorDefinition> {
|
|
9
|
+
readonly parameters: GeneratorParams<D>;
|
|
10
|
+
readonly validation: ParameterValidationResult;
|
|
11
|
+
}
|
|
12
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# aggregateParameterIssues
|
|
2
|
+
|
|
3
|
+
Caps reported issues, prioritizing errors while preserving the retained issues' input order.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Caps reported issues, prioritizing errors while preserving the retained issues' input order. */
|
|
9
|
+
export declare function aggregateParameterIssues(...issueSets: readonly (readonly ParameterIssue[])[]): ParameterValidationResult;
|
|
10
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# canonicalizeParameters
|
|
2
|
+
|
|
3
|
+
Reuses semantically unchanged bounded parameter values after normalization or Worker cloning.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Reuses semantically unchanged bounded parameter values after normalization or Worker cloning. */
|
|
9
|
+
export declare function canonicalizeParameters<const D extends GeneratorDefinition>(_definition: D, parameters: GeneratorParams<D>, previous?: GeneratorParams<D>): GeneratorParams<D>;
|
|
10
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# createParamCodec
|
|
2
|
+
|
|
3
|
+
Creates a strict decoder for a definition's exact normalized parameter map. Decoding never fills, drops, clamps, or canonicalizes values.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/**
|
|
9
|
+
* Creates a strict decoder for a definition's exact normalized parameter map.
|
|
10
|
+
* Decoding never fills, drops, clamps, or canonicalizes values.
|
|
11
|
+
*/
|
|
12
|
+
export declare function createParamCodec<const D extends GeneratorDefinition>(definition: D): ParamCodec<D>;
|
|
13
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# getDefaultParameters
|
|
2
|
+
|
|
3
|
+
getDefaultParameters exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function getDefaultParameters<const D extends GeneratorDefinition>(definition: D): GeneratorParams<D>;
|
|
9
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# normalizeParameters
|
|
2
|
+
|
|
3
|
+
Returns one value per declared parameter. Unknown input keys are discarded, missing/invalid values fall back to defaults, and numbers are clamped.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/**
|
|
9
|
+
* Returns one value per declared parameter. Unknown input keys are discarded,
|
|
10
|
+
* missing/invalid values fall back to defaults, and numbers are clamped.
|
|
11
|
+
*/
|
|
12
|
+
export declare function normalizeParameters<const D extends GeneratorDefinition>(definition: D, input?: Readonly<Record<string, unknown>> | null): GeneratorParams<D>;
|
|
13
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# parameterValueEquals
|
|
2
|
+
|
|
3
|
+
parameterValueEquals exported from @metamesh/generator-sdk/parameters.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export declare function parameterValueEquals(previous: ParameterValue | undefined, next: ParameterValue | undefined): boolean;
|
|
9
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# parseParameterIssues
|
|
2
|
+
|
|
3
|
+
Parses validator output at the executable-code boundary.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/**
|
|
9
|
+
* Parses validator output at the executable-code boundary.
|
|
10
|
+
*
|
|
11
|
+
* Strict, bounded checks protect against authored and installed Generator code
|
|
12
|
+
* returning values that did not pass TypeScript.
|
|
13
|
+
*/
|
|
14
|
+
export declare function parseParameterIssues(definition: GeneratorDefinition, value: unknown): readonly ParameterIssue[];
|
|
15
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# prepareParameters
|
|
2
|
+
|
|
3
|
+
Normalizes known values once and validates the declared parameter schema. Domain assertions belong to the generation program.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/**
|
|
9
|
+
* Normalizes known values once and validates the declared parameter schema.
|
|
10
|
+
* Domain assertions belong to the generation program.
|
|
11
|
+
*/
|
|
12
|
+
export declare function prepareParameters<const D extends GeneratorDefinition>(definition: D, parameters: Readonly<Record<string, unknown>>): PreparedParameters<D>;
|
|
13
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# validateParameters
|
|
2
|
+
|
|
3
|
+
Validates the declared parameter schema without executing generation.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Validates the declared parameter schema without executing generation. */
|
|
9
|
+
export declare function validateParameters<const D extends GeneratorDefinition>(definition: D, parameters: Readonly<Record<string, unknown>>): ParameterValidationResult;
|
|
10
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ExecuteGeneratorOptions
|
|
2
|
+
|
|
3
|
+
ExecuteGeneratorOptions exported from @metamesh/generator-sdk/runtime.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface ExecuteGeneratorOptions<D extends GeneratorDefinition, Program extends GeneratorProgram, Output> {
|
|
9
|
+
readonly definition: D;
|
|
10
|
+
readonly parameters: Readonly<Record<string, unknown>>;
|
|
11
|
+
/** Reuses host normalization performed before asynchronous asset preparation. */
|
|
12
|
+
readonly parameterState?: PreparedParameters<D>;
|
|
13
|
+
readonly module: GeneratorModule<D, Program>;
|
|
14
|
+
readonly services: GeneratorServices;
|
|
15
|
+
/** The owning host runs its session; the SDK never initializes Modeling. */
|
|
16
|
+
readonly execute: (program: Program, parameters: GeneratorParams<D>, services: GeneratorServices) => Output;
|
|
17
|
+
}
|
|
18
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Export3mfRequest
|
|
2
|
+
|
|
3
|
+
Export3mfRequest exported from @metamesh/generator-sdk/runtime.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface Export3mfRequest {
|
|
9
|
+
/** Project appearance overrides keyed by semantic part ID; does not affect generation. */
|
|
10
|
+
readonly partColors?: Readonly<Record<string, string>>;
|
|
11
|
+
readonly type: "export-3mf";
|
|
12
|
+
readonly requestId: number;
|
|
13
|
+
readonly filename: string;
|
|
14
|
+
/** Captured finalized geometry. Export never evaluates generator code. */
|
|
15
|
+
readonly model: GeneratedModel;
|
|
16
|
+
readonly name: string;
|
|
17
|
+
}
|
|
18
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# ExportError
|
|
2
|
+
|
|
3
|
+
ExportError exported from @metamesh/generator-sdk/runtime.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface ExportError {
|
|
9
|
+
readonly type: "export-error";
|
|
10
|
+
readonly requestId: number;
|
|
11
|
+
readonly error: RuntimeError;
|
|
12
|
+
}
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# ExportSuccess
|
|
2
|
+
|
|
3
|
+
ExportSuccess exported from @metamesh/generator-sdk/runtime.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface ExportSuccess {
|
|
9
|
+
readonly type: "export-success";
|
|
10
|
+
readonly requestId: number;
|
|
11
|
+
readonly file: ExportedFile;
|
|
12
|
+
}
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# ExportedFile
|
|
2
|
+
|
|
3
|
+
ExportedFile exported from @metamesh/generator-sdk/runtime.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface ExportedFile {
|
|
9
|
+
readonly bytes: ArrayBuffer;
|
|
10
|
+
readonly filename: string;
|
|
11
|
+
readonly mimeType: "model/3mf";
|
|
12
|
+
}
|
|
13
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# GenerateRequest
|
|
2
|
+
|
|
3
|
+
GenerateRequest exported from @metamesh/generator-sdk/runtime.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface GenerateRequest {
|
|
9
|
+
readonly type: "generate";
|
|
10
|
+
readonly requestId: number;
|
|
11
|
+
readonly generatorId: string;
|
|
12
|
+
readonly meshTopologyMode: MeshTopologyMode;
|
|
13
|
+
readonly runtime: GeneratorRuntimeReference;
|
|
14
|
+
readonly parameters: ParameterValues;
|
|
15
|
+
}
|
|
16
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# GeneratedModel
|
|
2
|
+
|
|
3
|
+
GeneratedModel exported from @metamesh/generator-sdk/runtime.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface GeneratedModel {
|
|
9
|
+
/** Opaque execution identity captured by every exporter. */
|
|
10
|
+
readonly revisionId: string;
|
|
11
|
+
readonly requestId: number;
|
|
12
|
+
readonly parts: readonly GeneratedPart[];
|
|
13
|
+
readonly bounds: ModelBounds;
|
|
14
|
+
readonly stats?: ModelStats | undefined;
|
|
15
|
+
readonly warnings: readonly ParameterIssue[];
|
|
16
|
+
}
|
|
17
|
+
```
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# GeneratedModelDelivery
|
|
2
|
+
|
|
3
|
+
Worker delivery; receiving hosts hydrate references before strict full-model parsing.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** Worker delivery; receiving hosts hydrate references before strict full-model parsing. */
|
|
9
|
+
export type GeneratedModelDelivery = Omit<GeneratedModel, "parts"> & {
|
|
10
|
+
readonly parts: readonly GeneratedPartDelivery[];
|
|
11
|
+
};
|
|
12
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GeneratedPart
|
|
2
|
+
|
|
3
|
+
GeneratedPart exported from @metamesh/generator-sdk/runtime.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
export interface GeneratedPart {
|
|
9
|
+
/** Session-scoped immutable local mesh resource identity. */
|
|
10
|
+
readonly geometryId: string;
|
|
11
|
+
readonly geometryRevision: number;
|
|
12
|
+
/** Authoritative translation in mm and fixed global X, Y, Z rotations in degrees. */
|
|
13
|
+
readonly position: Vector3;
|
|
14
|
+
readonly rotation: Vector3;
|
|
15
|
+
readonly id: string;
|
|
16
|
+
readonly positions: Float32Array;
|
|
17
|
+
readonly indices: Uint32Array;
|
|
18
|
+
readonly color?: string | undefined;
|
|
19
|
+
}
|
|
20
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# GeneratedPartDelivery
|
|
2
|
+
|
|
3
|
+
A subsequent delivery may reference a mesh already owned by the receiving session.
|
|
4
|
+
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.13.0).
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
/** A subsequent delivery may reference a mesh already owned by the receiving session. */
|
|
9
|
+
export type GeneratedPartDelivery = GeneratedPart | (Omit<GeneratedPart, "positions" | "indices"> & {
|
|
10
|
+
readonly positions?: never;
|
|
11
|
+
readonly indices?: never;
|
|
12
|
+
});
|
|
13
|
+
```
|