@metamesh/generator-sdk 0.18.0 → 0.20.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 +74 -0
- package/README.md +62 -50
- package/dist/authoring.d.ts +11 -2
- package/dist/authoring.d.ts.map +1 -1
- package/dist/authoring.js +11 -2
- package/dist/authoring.js.map +1 -1
- package/dist/docs/guides/authoring.md +4 -4
- package/dist/docs/guides/package.md +62 -50
- package/dist/docs/guides/parameters.md +8 -9
- package/dist/docs/manifest.json +272 -384
- package/dist/docs/reference/fonts/FontSelection.md +6 -3
- package/dist/docs/reference/fonts/isFontSelection.md +3 -3
- package/dist/docs/reference/index/ArrayParameterDefinition.md +3 -2
- package/dist/docs/reference/index/BaseParameterDefinition.md +5 -2
- package/dist/docs/reference/index/BooleanParameterDefinition.md +3 -2
- package/dist/docs/reference/index/ChoiceOption.md +3 -2
- package/dist/docs/reference/index/ChoiceParameterDefinition.md +3 -2
- package/dist/docs/reference/index/ChoiceSetParameterDefinition.md +3 -2
- package/dist/docs/reference/index/ColorParameterDefinition.md +3 -2
- package/dist/docs/reference/index/ConditionExpression.md +3 -2
- package/dist/docs/reference/index/ContourAnchor.md +1 -1
- package/dist/docs/reference/index/ContourParameterDefinition.md +3 -2
- package/dist/docs/reference/index/ContourParameterUi.md +3 -2
- package/dist/docs/reference/index/ContourPoint.md +1 -1
- package/dist/docs/reference/index/ContourSegment.md +3 -2
- package/dist/docs/reference/index/ContourValue.md +6 -3
- package/dist/docs/reference/index/FontParameterDefinition.md +3 -2
- package/dist/docs/reference/index/GeneratorDefinition.md +3 -2
- package/dist/docs/reference/index/GeneratorIssue.md +1 -1
- package/dist/docs/reference/index/GeneratorModule.md +1 -1
- package/dist/docs/reference/index/GeneratorModuleOptions.md +5 -2
- package/dist/docs/reference/index/GeneratorParamId.md +1 -1
- package/dist/docs/reference/index/GeneratorParams.md +1 -1
- package/dist/docs/reference/index/GeneratorPreset.md +3 -2
- package/dist/docs/reference/index/GeneratorProgram.md +1 -1
- package/dist/docs/reference/index/GeneratorServices.md +6 -2
- package/dist/docs/reference/index/GeneratorTextArcBaseline.md +1 -1
- package/dist/docs/reference/index/GeneratorTextLayout.md +1 -1
- package/dist/docs/reference/index/GeneratorTextMetrics.md +10 -3
- package/dist/docs/reference/index/GeneratorTextOptions.md +7 -1
- package/dist/docs/reference/index/MAX_CONTOUR_SEGMENTS.md +1 -1
- package/dist/docs/reference/index/MAX_SIDE_PROFILE_SEGMENTS.md +1 -1
- package/dist/docs/reference/index/NumberArrayItemDefinition.md +3 -2
- package/dist/docs/reference/index/NumberArrayParameterDefinition.md +3 -2
- package/dist/docs/reference/index/NumberParameterDefinition.md +4 -3
- package/dist/docs/reference/index/NumberParameterUi.md +3 -2
- package/dist/docs/reference/index/ParameterDefinition.md +3 -2
- package/dist/docs/reference/index/ParameterDefinitionDocument.md +3 -2
- package/dist/docs/reference/index/ParameterGroup.md +1 -1
- package/dist/docs/reference/index/ParameterIssue.md +4 -3
- package/dist/docs/reference/index/ParameterIssueCode.md +1 -1
- package/dist/docs/reference/index/ParameterIssueSeverity.md +3 -2
- package/dist/docs/reference/index/ParameterScaleReference.md +5 -3
- package/dist/docs/reference/index/ParameterUi.md +5 -3
- package/dist/docs/reference/index/ParameterValidationResult.md +3 -2
- package/dist/docs/reference/index/ParameterValue.md +3 -2
- package/dist/docs/reference/index/ParameterValues.md +3 -2
- package/dist/docs/reference/index/RowParameterUi.md +3 -2
- package/dist/docs/reference/index/ScalarParameterValue.md +3 -2
- package/dist/docs/reference/index/SideProfileAnchor.md +1 -1
- package/dist/docs/reference/index/SideProfileParameterDefinition.md +3 -2
- package/dist/docs/reference/index/SideProfileParameterUi.md +3 -2
- package/dist/docs/reference/index/SideProfilePoint.md +1 -1
- package/dist/docs/reference/index/SideProfileSegment.md +3 -2
- package/dist/docs/reference/index/SideProfileValue.md +6 -3
- package/dist/docs/reference/index/SourceVisibility.md +1 -1
- package/dist/docs/reference/index/StringArrayItemDefinition.md +3 -2
- package/dist/docs/reference/index/StringArrayParameterDefinition.md +3 -2
- package/dist/docs/reference/index/SvgParameterDefinition.md +3 -2
- package/dist/docs/reference/index/TextParameterDefinition.md +3 -2
- package/dist/docs/reference/index/UNPREPARED_GENERATOR_SERVICES.md +1 -1
- package/dist/docs/reference/index/cloneContourValue.md +3 -3
- package/dist/docs/reference/index/cloneSideProfileValue.md +3 -3
- package/dist/docs/reference/index/contourValuesEqual.md +1 -1
- package/dist/docs/reference/index/defineGenerator.md +7 -3
- package/dist/docs/reference/index/defineGeneratorModule.md +1 -1
- package/dist/docs/reference/index/definePresets.md +8 -3
- package/dist/docs/reference/index/evaluateCondition.md +1 -1
- package/dist/docs/reference/index/isContourValue.md +1 -1
- package/dist/docs/reference/index/isSideProfileValue.md +1 -1
- package/dist/docs/reference/index/sideProfileValuesEqual.md +1 -1
- package/dist/docs/reference/modeling/GeneratorModel.md +1 -1
- package/dist/docs/reference/modeling/ModelDeliveryEncoder.md +14 -5
- package/dist/docs/reference/modeling/defineGeneratorModel.md +4 -1
- package/dist/docs/reference/modeling/parseGeneratorModel.md +8 -6
- package/dist/docs/reference/packages/GENERATOR_PACKAGE_FORMAT_VERSION.md +2 -2
- package/dist/docs/reference/packages/GeneratorAccess.md +3 -2
- package/dist/docs/reference/packages/GeneratorDefinitionIssue.md +3 -2
- package/dist/docs/reference/packages/GeneratorDefinitionParseResult.md +3 -2
- package/dist/docs/reference/packages/GeneratorDescriptor.md +3 -2
- package/dist/docs/reference/packages/GeneratorPackageManifest.md +3 -2
- package/dist/docs/reference/packages/GeneratorPackageSource.md +3 -2
- package/dist/docs/reference/packages/GeneratorPackageValidationError.md +3 -2
- package/dist/docs/reference/packages/GeneratorRuntimeReference.md +3 -2
- package/dist/docs/reference/packages/InstalledGenerator.md +3 -2
- package/dist/docs/reference/packages/MAX_ARRAY_ITEMS.md +2 -2
- package/dist/docs/reference/packages/MAX_CONDITION_BRANCHES.md +2 -2
- package/dist/docs/reference/packages/MAX_CONDITION_DEPTH.md +2 -2
- package/dist/docs/reference/packages/MAX_DESCRIPTOR_LIST_ITEMS.md +2 -2
- package/dist/docs/reference/packages/MAX_GENERATOR_ID_LENGTH.md +1 -1
- package/dist/docs/reference/packages/MAX_GENERATOR_PACKAGE_BYTES.md +2 -2
- package/dist/docs/reference/packages/MAX_GENERATOR_PRESETS.md +2 -2
- package/dist/docs/reference/packages/MAX_METADATA_TEXT_LENGTH.md +1 -1
- package/dist/docs/reference/packages/MAX_PARAMETERS.md +2 -2
- package/dist/docs/reference/packages/MAX_PARAMETER_GROUPS.md +2 -2
- package/dist/docs/reference/packages/MAX_PARAMETER_OPTIONS.md +2 -2
- package/dist/docs/reference/packages/MAX_TEXT_PARAMETER_LENGTH.md +2 -2
- package/dist/docs/reference/packages/METAMESH_RUNTIME_VERSION.md +3 -3
- package/dist/docs/reference/packages/compareSemanticVersions.md +7 -2
- package/dist/docs/reference/packages/isRuntimeCompatible.md +8 -2
- package/dist/docs/reference/packages/parseGeneratorDefinition.md +3 -2
- package/dist/docs/reference/packages/parseGeneratorDescriptor.md +3 -2
- package/dist/docs/reference/packages/parseGeneratorPackageManifest.md +8 -2
- package/dist/docs/reference/packages/parseParameterDefinitionDocument.md +3 -2
- package/dist/docs/reference/packages/safeParseGeneratorDefinition.md +1 -1
- package/dist/docs/reference/packages/safeParseParameterDefinitionDocument.md +1 -1
- package/dist/docs/reference/packages/validateGeneratorPresets.md +9 -3
- package/dist/docs/reference/parameters/EMPTY_SVG_PARAMETER_DEFAULT.md +2 -2
- package/dist/docs/reference/parameters/MAX_PARAMETER_ISSUES.md +2 -2
- package/dist/docs/reference/parameters/MAX_PARAMETER_ISSUE_MESSAGE_LENGTH.md +2 -2
- package/dist/docs/reference/parameters/MAX_PROJECT_SVG_PARAMETER_BYTES.md +2 -2
- package/dist/docs/reference/parameters/MAX_SVG_PARAMETER_BYTES.md +2 -2
- package/dist/docs/reference/parameters/ParamCodec.md +3 -2
- package/dist/docs/reference/parameters/ParamDecodeCode.md +3 -2
- package/dist/docs/reference/parameters/ParamDecodeError.md +3 -2
- package/dist/docs/reference/parameters/ParamDecodeIssue.md +3 -2
- package/dist/docs/reference/parameters/ParamParseResult.md +3 -2
- package/dist/docs/reference/parameters/aggregateParameterIssues.md +6 -2
- package/dist/docs/reference/parameters/createParamCodec.md +3 -1
- package/dist/docs/reference/parameters/getDefaultParameters.md +3 -2
- package/dist/docs/reference/parameters/normalizeParameters.md +3 -1
- package/dist/docs/reference/parameters/parameterValueEquals.md +3 -2
- package/dist/docs/reference/parameters/parseParameterIssues.md +5 -5
- package/dist/docs/reference/parameters/svgParameterBytes.md +3 -2
- package/dist/docs/reference/runtime/ExecuteGeneratorOptions.md +4 -2
- package/dist/docs/reference/runtime/GenerateRequest.md +3 -2
- package/dist/docs/reference/runtime/GenerationError.md +3 -2
- package/dist/docs/reference/runtime/GenerationInvalid.md +3 -2
- package/dist/docs/reference/runtime/GenerationSuccess.md +3 -2
- package/dist/docs/reference/runtime/GeneratorExecutionGenerated.md +3 -2
- package/dist/docs/reference/runtime/GeneratorExecutionInvalid.md +3 -2
- package/dist/docs/reference/runtime/GeneratorExecutionResult.md +3 -2
- package/dist/docs/reference/runtime/MeshResourceData.md +1 -1
- package/dist/docs/reference/runtime/MeshTopologyMode.md +3 -3
- package/dist/docs/reference/runtime/ModelBounds.md +3 -2
- package/dist/docs/reference/runtime/ModelData.md +1 -1
- package/dist/docs/reference/runtime/ModelDelivery.md +1 -1
- package/dist/docs/reference/runtime/ModelPartData.md +5 -4
- package/dist/docs/reference/runtime/ModelStats.md +1 -1
- package/dist/docs/reference/runtime/ModelTimings.md +6 -4
- package/dist/docs/reference/runtime/ParsedGeneratorModule.md +3 -2
- package/dist/docs/reference/runtime/PartDelivery.md +1 -1
- package/dist/docs/reference/runtime/PartDeliveryDecoder.md +6 -2
- package/dist/docs/reference/runtime/PartDeliveryLimits.md +7 -3
- package/dist/docs/reference/runtime/RuntimeError.md +3 -2
- package/dist/docs/reference/runtime/ValidateRequest.md +3 -2
- package/dist/docs/reference/runtime/ValidationError.md +3 -2
- package/dist/docs/reference/runtime/ValidationSuccess.md +3 -2
- package/dist/docs/reference/runtime/WorkerRequest.md +4 -3
- package/dist/docs/reference/runtime/WorkerResponse.md +4 -3
- package/dist/docs/reference/runtime/canonicalizeParameters.md +8 -3
- package/dist/docs/reference/runtime/executeGenerator.md +1 -1
- package/dist/docs/reference/runtime/generationIssues.md +9 -3
- package/dist/docs/reference/runtime/parseGenerationSentAt.md +7 -3
- package/dist/docs/reference/runtime/parseGeneratorModule.md +8 -3
- package/dist/docs/reference/runtime/parseModelParts.md +4 -1
- package/dist/fonts.d.ts +5 -2
- package/dist/fonts.d.ts.map +1 -1
- package/dist/fonts.js +1 -1
- package/dist/fonts.js.map +1 -1
- package/dist/generator-module.d.ts +3 -0
- package/dist/generator-module.d.ts.map +1 -1
- package/dist/generator-module.js.map +1 -1
- package/dist/generator-package/constants.d.ts +6 -1
- package/dist/generator-package/constants.d.ts.map +1 -1
- package/dist/generator-package/constants.js +6 -2
- package/dist/generator-package/constants.js.map +1 -1
- package/dist/generator-package/contracts.d.ts +2 -0
- package/dist/generator-package/contracts.d.ts.map +1 -1
- package/dist/generator-package/index.d.ts +0 -1
- package/dist/generator-package/index.d.ts.map +1 -1
- package/dist/generator-package/index.js.map +1 -1
- package/dist/generator-package/parse-package.d.ts +7 -0
- package/dist/generator-package/parse-package.d.ts.map +1 -1
- package/dist/generator-package/parse-package.js +7 -0
- package/dist/generator-package/parse-package.js.map +1 -1
- package/dist/generator-package/schemas/descriptor.schema.d.ts +1 -0
- package/dist/generator-package/schemas/descriptor.schema.d.ts.map +1 -1
- package/dist/generator-package/schemas/manifest.schema.d.ts +4 -1
- package/dist/generator-package/schemas/manifest.schema.d.ts.map +1 -1
- package/dist/generator-package/validate-manifest.d.ts +7 -1
- package/dist/generator-package/validate-manifest.d.ts.map +1 -1
- package/dist/generator-package/validate-manifest.js +7 -1
- package/dist/generator-package/validate-manifest.js.map +1 -1
- package/dist/generator-package/versions.d.ts +11 -0
- package/dist/generator-package/versions.d.ts.map +1 -1
- package/dist/generator-package/versions.js +11 -0
- package/dist/generator-package/versions.js.map +1 -1
- package/dist/generator-services.d.ts +19 -2
- package/dist/generator-services.d.ts.map +1 -1
- package/dist/generator-services.js.map +1 -1
- package/dist/index.d.ts +0 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -1
- package/dist/index.js.map +1 -1
- package/dist/modeling-delivery.d.ts +14 -8
- package/dist/modeling-delivery.d.ts.map +1 -1
- package/dist/modeling-delivery.js +12 -13
- package/dist/modeling-delivery.js.map +1 -1
- package/dist/modeling.d.ts +10 -5
- package/dist/modeling.d.ts.map +1 -1
- package/dist/modeling.js +10 -5
- package/dist/modeling.js.map +1 -1
- package/dist/parameters/conditions.d.ts +1 -0
- package/dist/parameters/conditions.d.ts.map +1 -1
- package/dist/parameters/conditions.js.map +1 -1
- package/dist/parameters/contours.d.ts +6 -2
- package/dist/parameters/contours.d.ts.map +1 -1
- package/dist/parameters/contours.js +1 -1
- package/dist/parameters/contours.js.map +1 -1
- package/dist/parameters/contracts.d.ts +8 -1
- package/dist/parameters/contracts.d.ts.map +1 -1
- package/dist/parameters/definitions.d.ts +33 -3
- package/dist/parameters/definitions.d.ts.map +1 -1
- package/dist/parameters/issues.d.ts +10 -4
- package/dist/parameters/issues.d.ts.map +1 -1
- package/dist/parameters/issues.js +10 -4
- package/dist/parameters/issues.js.map +1 -1
- package/dist/parameters/limits.d.ts +7 -1
- package/dist/parameters/limits.d.ts.map +1 -1
- package/dist/parameters/limits.js +7 -1
- package/dist/parameters/limits.js.map +1 -1
- package/dist/parameters/recovery.d.ts +3 -0
- package/dist/parameters/recovery.d.ts.map +1 -1
- package/dist/parameters/recovery.js +3 -0
- package/dist/parameters/recovery.js.map +1 -1
- package/dist/parameters/side-profiles.d.ts +6 -2
- package/dist/parameters/side-profiles.d.ts.map +1 -1
- package/dist/parameters/side-profiles.js +1 -1
- package/dist/parameters/side-profiles.js.map +1 -1
- package/dist/parameters/strict.d.ts +7 -0
- package/dist/parameters/strict.d.ts.map +1 -1
- package/dist/parameters/strict.js +3 -0
- package/dist/parameters/strict.js.map +1 -1
- package/dist/parameters/values.d.ts +5 -0
- package/dist/parameters/values.d.ts.map +1 -1
- package/dist/parameters/values.js +5 -0
- package/dist/parameters/values.js.map +1 -1
- package/dist/runtime/execute-generator.d.ts +12 -1
- package/dist/runtime/execute-generator.d.ts.map +1 -1
- package/dist/runtime/execute-generator.js +7 -1
- package/dist/runtime/execute-generator.js.map +1 -1
- package/dist/runtime/model-contracts.d.ts +11 -6
- package/dist/runtime/model-contracts.d.ts.map +1 -1
- package/dist/runtime/parameter-identities.d.ts +6 -1
- package/dist/runtime/parameter-identities.d.ts.map +1 -1
- package/dist/runtime/parameter-identities.js +6 -1
- package/dist/runtime/parameter-identities.js.map +1 -1
- package/dist/runtime/parse-generator-module.d.ts +7 -1
- package/dist/runtime/parse-generator-module.d.ts.map +1 -1
- package/dist/runtime/parse-generator-module.js +6 -1
- package/dist/runtime/parse-generator-module.js.map +1 -1
- package/dist/runtime/part-delivery.d.ts +13 -2
- package/dist/runtime/part-delivery.d.ts.map +1 -1
- package/dist/runtime/part-delivery.js +8 -1
- package/dist/runtime/part-delivery.js.map +1 -1
- package/dist/runtime/worker-contracts.d.ts +18 -29
- package/dist/runtime/worker-contracts.d.ts.map +1 -1
- package/dist/runtime/worker-contracts.js +5 -1
- package/dist/runtime/worker-contracts.js.map +1 -1
- package/dist/validation/errors.d.ts +4 -1
- package/dist/validation/errors.d.ts.map +1 -1
- package/dist/validation/errors.js +2 -1
- package/dist/validation/errors.js.map +1 -1
- package/dist/validation/parse-definition.d.ts +2 -0
- package/dist/validation/parse-definition.d.ts.map +1 -1
- package/dist/validation/parse-definition.js +2 -0
- package/dist/validation/parse-definition.js.map +1 -1
- package/dist/validation/portable-data.d.ts.map +1 -1
- package/dist/validation/portable-data.js +1 -0
- package/dist/validation/portable-data.js.map +1 -1
- package/dist/validation/schemas/common.schema.d.ts +0 -1
- package/dist/validation/schemas/common.schema.d.ts.map +1 -1
- package/dist/validation/schemas/common.schema.js +1 -1
- package/dist/validation/schemas/common.schema.js.map +1 -1
- package/dist/validation/schemas/definition.schema.d.ts +0 -7
- package/dist/validation/schemas/definition.schema.d.ts.map +1 -1
- package/dist/validation/schemas/definition.schema.js +1 -1
- package/dist/validation/schemas/definition.schema.js.map +1 -1
- package/package.json +3 -3
- package/dist/docs/reference/index/FontSelection.md +0 -14
- package/dist/docs/reference/index/isFontSelection.md +0 -10
- package/dist/docs/reference/modeling/toWorldMeshes.md +0 -10
- package/dist/docs/reference/packages/GeneratorPreset.md +0 -14
- package/dist/docs/reference/runtime/Export3mfRequest.md +0 -18
- package/dist/docs/reference/runtime/ExportError.md +0 -13
- package/dist/docs/reference/runtime/ExportSuccess.md +0 -13
- package/dist/docs/reference/runtime/ExportedFile.md +0 -13
- package/dist/generator-package/versions.spec.d.ts +0 -2
- package/dist/generator-package/versions.spec.d.ts.map +0 -1
- package/dist/generator-package/versions.spec.js +0 -12
- package/dist/generator-package/versions.spec.js.map +0 -1
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# ParameterIssueSeverity
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Errors block generation; warnings do not.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Errors block generation; warnings do not. */
|
|
8
9
|
export type ParameterIssueSeverity = "error" | "warning";
|
|
9
10
|
```
|
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
# ParameterScaleReference
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Physical editing scale from a millimetre parameter; saved coordinates stay normalized.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/**
|
|
8
|
+
/** Physical editing scale from a millimetre parameter; saved coordinates stay normalized. */
|
|
9
9
|
export interface ParameterScaleReference {
|
|
10
|
+
/** ID of a number parameter in mm with a positive minimum. */
|
|
10
11
|
readonly parameterId: string;
|
|
12
|
+
/** Positive multiplier; changes editing units only. */
|
|
11
13
|
readonly factor: number;
|
|
12
14
|
}
|
|
13
15
|
```
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
# ParameterUi
|
|
2
2
|
|
|
3
|
-
Presentation hints shared by every parameter editor.
|
|
3
|
+
Presentation hints shared by every parameter editor.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/** Presentation hints shared by every parameter editor.
|
|
8
|
+
/** Presentation hints shared by every parameter editor. */
|
|
9
9
|
export interface ParameterUi {
|
|
10
|
+
/** ID of a declared group; omit for an ungrouped control. */
|
|
10
11
|
readonly group?: string | undefined;
|
|
11
12
|
/** Essential instruction displayed inline whenever this control is visible. */
|
|
12
13
|
readonly hint?: string | undefined;
|
|
14
|
+
/** Controls visibility only; hidden values remain saved and validated. */
|
|
13
15
|
readonly visibleWhen?: ConditionExpression | undefined;
|
|
14
16
|
}
|
|
15
17
|
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ParameterValidationResult
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Retained validation issues, partitioned by severity; validity depends only on errors.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Retained validation issues, partitioned by severity; validity depends only on errors. */
|
|
8
9
|
export interface ParameterValidationResult {
|
|
9
10
|
readonly isValid: boolean;
|
|
10
11
|
readonly issues: readonly ParameterIssue[];
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# ParameterValue
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Portable value accepted by a declared parameter type.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Portable value accepted by a declared parameter type. */
|
|
8
9
|
export type ParameterValue = ScalarParameterValue | readonly number[] | readonly string[] | FontSelection | SideProfileValue | ContourValue;
|
|
9
10
|
```
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# ParameterValues
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Parameter values keyed by ID, without definition-specific type inference.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Parameter values keyed by ID, without definition-specific type inference. */
|
|
8
9
|
export type ParameterValues = Readonly<Record<string, ParameterValue>>;
|
|
9
10
|
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# RowParameterUi
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Presentation hints for controls that can share a row.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Presentation hints for controls that can share a row. */
|
|
8
9
|
export interface RowParameterUi extends ParameterUi {
|
|
9
10
|
/** At most two adjacent controls in the same group may share equal-width space. */
|
|
10
11
|
readonly row?: string | undefined;
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# ScalarParameterValue
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Scalar value supported by parameter conditions and controls.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Scalar value supported by parameter conditions and controls. */
|
|
8
9
|
export type ScalarParameterValue = number | boolean | string;
|
|
9
10
|
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Editing intent is retained alongside the explicit curve controls.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Editing intent is retained alongside the explicit curve controls. */
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# SideProfileParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Editable normalized side silhouette; Generators own physical scaling and solid closure.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Editable normalized side silhouette; Generators own physical scaling and solid closure. */
|
|
8
9
|
export interface SideProfileParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "side-profile";
|
|
10
11
|
readonly default: SideProfileValue;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# SideProfileParameterUi
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Optional physical editing scales for normalized radius and height coordinates.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Optional physical editing scales for normalized radius and height coordinates. */
|
|
8
9
|
export interface SideProfileParameterUi extends ParameterUi {
|
|
9
10
|
readonly radiusScale?: ParameterScaleReference | undefined;
|
|
10
11
|
readonly heightScale?: ParameterScaleReference | undefined;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Normalized radius and upward height; both coordinates lie between zero and one.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Normalized radius and upward height; both coordinates lie between zero and one. */
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# SideProfileSegment
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Straight or cubic upward span ending at an explicit profile anchor.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Straight or cubic upward span ending at an explicit profile anchor. */
|
|
8
9
|
export type SideProfileSegment = {
|
|
9
10
|
readonly type: "line";
|
|
10
11
|
readonly end: SideProfileAnchor;
|
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
# SideProfileValue
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Open normalized silhouette with increasing anchor heights from zero to one. Generators own physical scaling and solid closure.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Open normalized silhouette with increasing anchor heights from zero to one.
|
|
10
|
+
* Generators own physical scaling and solid closure.
|
|
11
|
+
*/
|
|
9
12
|
export interface SideProfileValue {
|
|
10
13
|
readonly version: 1;
|
|
11
14
|
readonly start: SideProfileAnchor;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# StringArrayItemDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Text array item, bounded by the SDK's metadata text limit.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Text array item, bounded by the SDK's metadata text limit. */
|
|
8
9
|
export interface StringArrayItemDefinition {
|
|
9
10
|
readonly type: "string";
|
|
10
11
|
}
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# StringArrayParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Ordered text values sharing one set of item rules.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Ordered text values sharing one set of item rules. */
|
|
8
9
|
export interface StringArrayParameterDefinition extends ArrayParameterBase {
|
|
9
10
|
readonly default: readonly string[];
|
|
10
11
|
readonly items: StringArrayItemDefinition;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# SvgParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Complete SVG document text, bounded by individual and combined UTF-8 byte limits.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Complete SVG document text, bounded by individual and combined UTF-8 byte limits. */
|
|
8
9
|
export interface SvgParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "svg";
|
|
10
11
|
readonly default: string;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# TextParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Plain text parameter, bounded by the SDK's text length limit.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Plain text parameter, bounded by the SDK's text length limit. */
|
|
8
9
|
export interface TextParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "text";
|
|
10
11
|
readonly default: string;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
A font-free execution fails explicitly if a callback requests unprepared text geometry.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
UNPREPARED_GENERATOR_SERVICES: GeneratorServices
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# cloneContourValue
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Validates and returns a fresh, deeply frozen contour, including its editing intent.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/**
|
|
8
|
+
/** Validates and returns a fresh, deeply frozen contour, including its editing intent. */
|
|
9
9
|
export declare function cloneContourValue(value: ContourValue): ContourValue;
|
|
10
10
|
```
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# cloneSideProfileValue
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Validates and returns a fresh, deeply frozen profile, including its editing intent.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/**
|
|
8
|
+
/** Validates and returns a fresh, deeply frozen profile, including its editing intent. */
|
|
9
9
|
export declare function cloneSideProfileValue(value: SideProfileValue): SideProfileValue;
|
|
10
10
|
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Compares the serialized shape and editing intent rather than object identity.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Compares the serialized shape and editing intent rather than object identity. */
|
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
# defineGenerator
|
|
2
2
|
|
|
3
|
-
Validates metadata while preserving
|
|
3
|
+
Validates Generator metadata while preserving literal control types; invalid definitions throw.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Validates Generator metadata while preserving literal control types; invalid definitions throw.
|
|
10
|
+
*
|
|
11
|
+
* @param definition - Serializable controls and metadata; returned unchanged after validation.
|
|
12
|
+
*/
|
|
9
13
|
export declare function defineGenerator<const D extends GeneratorDefinition>(definition: D & Omit<GeneratorDefinition, "parameters"> & {
|
|
10
14
|
readonly parameters: DefinitionParameters<NoInfer<D["parameters"]>>;
|
|
11
15
|
}): D;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Binds a Modeling program to serializable identity without executing it.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Binds a Modeling program to serializable identity without executing it. */
|
|
@@ -1,10 +1,15 @@
|
|
|
1
1
|
# definePresets
|
|
2
2
|
|
|
3
|
-
Validates complete
|
|
3
|
+
Validates preset metadata and complete canonical values while preserving literal types.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Validates preset metadata and complete canonical values while preserving literal types.
|
|
10
|
+
*
|
|
11
|
+
* @param definition - Definition whose complete parameter map each preset must supply.
|
|
12
|
+
* @param presets - Preset values and metadata; returned without copying.
|
|
13
|
+
*/
|
|
9
14
|
export declare function definePresets<const D extends GeneratorDefinition, const Presets extends readonly GeneratorPreset<NoInfer<D>>[]>(definition: D, presets: Presets & readonly GeneratorPreset<NoInfer<D>>[]): Presets;
|
|
10
15
|
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Evaluates a serializable visibility condition. A comparison against a missing parameter is always false, including `ne`.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Checks portable data and explicit closure without evaluating getters or inspecting topology.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Checks portable data and explicit closure without evaluating getters or inspecting topology. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Strictly checks portable profile data without evaluating getters or invoking curve libraries.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Strictly checks portable profile data without evaluating getters or invoking curve libraries. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Compares the serialized shape and editing intent rather than object identity.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Compares the serialized shape and editing intent rather than object identity. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Definition-bound executable Generator with Modeling's typed parameters and prepared services.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/modeling` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/modeling` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/** Definition-bound executable Generator with Modeling's typed parameters and prepared services. */
|
|
@@ -1,20 +1,29 @@
|
|
|
1
1
|
# ModelDeliveryEncoder
|
|
2
2
|
|
|
3
|
-
Copies
|
|
3
|
+
Copies resources absent from the previous delivery; repeated resources use references. Keep one encoder per receiving connection and reset it when that connection is replaced. Transferring the returned buffers never detaches engine results or session caches.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/modeling` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/modeling` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/**
|
|
9
|
-
* Copies
|
|
9
|
+
* Copies resources absent from the previous delivery; repeated resources use references.
|
|
10
10
|
* Keep one encoder per receiving connection and reset it when that connection is replaced.
|
|
11
11
|
* Transferring the returned buffers never detaches engine results or session caches.
|
|
12
12
|
*/
|
|
13
13
|
export declare class ModelDeliveryEncoder {
|
|
14
14
|
#private;
|
|
15
|
-
/**
|
|
15
|
+
/**
|
|
16
|
+
* Namespaces resource identities for this host connection.
|
|
17
|
+
*
|
|
18
|
+
* @param namespace - Sender identity, using 1–64 ASCII letters, digits, or hyphens.
|
|
19
|
+
*/
|
|
16
20
|
constructor(namespace: string);
|
|
17
|
-
/**
|
|
21
|
+
/**
|
|
22
|
+
* Encodes one finalized revision for an ordered receiving connection.
|
|
23
|
+
*
|
|
24
|
+
* @param result - Finalized revision to deliver without detaching its engine buffers.
|
|
25
|
+
* @param metadata - Host metadata for the same finalized revision.
|
|
26
|
+
*/
|
|
18
27
|
encode(result: ModelResult, metadata: Omit<ModelDelivery, "parts">): ModelDelivery;
|
|
19
28
|
/** Forgets the receiver's resources; the next delivery includes complete buffers. */
|
|
20
29
|
clear(): void;
|
|
@@ -2,13 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
Defines a Generator model with parameters and prepared services inferred from its definition. The callback stays synchronous; hosts own normalization, assets, execution and cleanup. Import this adapter from `@metamesh/generator-sdk/modeling` with matching Modeling installed.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/modeling` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/modeling` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/**
|
|
9
9
|
* Defines a Generator model with parameters and prepared services inferred from its definition.
|
|
10
10
|
* The callback stays synchronous; hosts own normalization, assets, execution and cleanup.
|
|
11
11
|
* Import this adapter from `@metamesh/generator-sdk/modeling` with matching Modeling installed.
|
|
12
|
+
*
|
|
13
|
+
* @param definition - Definition supplying parameter types and module identity.
|
|
14
|
+
* @param callback - Synchronous callback returning one part or a readonly part array.
|
|
12
15
|
*/
|
|
13
16
|
export declare function defineGeneratorModel<const D extends GeneratorDefinition>(definition: D, callback: GenerateCallback<GeneratorParams<D>, GeneratorServices>): GeneratorModel<D>;
|
|
14
17
|
```
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
# parseGeneratorModel
|
|
2
2
|
|
|
3
|
-
Validates a
|
|
3
|
+
Validates a loaded Generator and returns its definition-bound Modeling program without running it. For local entries that also export a definition, pass the default export itself. The host enforces synchronous execution.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/modeling` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/modeling` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/**
|
|
9
|
-
* Validates a
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
9
|
+
* Validates a loaded Generator and returns its definition-bound Modeling program without running it.
|
|
10
|
+
* For local entries that also export a definition, pass the default export itself.
|
|
11
|
+
* The host enforces synchronous execution.
|
|
12
|
+
*
|
|
13
|
+
* @param value - Module envelope or namespace containing only a default export.
|
|
14
|
+
* @param definition - Expected Generator identity and parameter types.
|
|
13
15
|
*/
|
|
14
16
|
export declare function parseGeneratorModel<const D extends GeneratorDefinition>(value: unknown, definition: D): GeneratorModel<D>;
|
|
15
17
|
```
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# GENERATOR_PACKAGE_FORMAT_VERSION
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Supported executable module and package manifest format.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
GENERATOR_PACKAGE_FORMAT_VERSION = 5
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# GeneratorAccess
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package delivery access tier; independent of authored-source visibility.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Package delivery access tier; independent of authored-source visibility. */
|
|
8
9
|
export type GeneratorAccess = GeneratorPackageManifest["access"];
|
|
9
10
|
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# GeneratorDefinitionIssue
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Structural or semantic package problem, with a path relative to the parsed document.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Structural or semantic package problem, with a path relative to the parsed document. */
|
|
8
9
|
export interface GeneratorDefinitionIssue {
|
|
9
10
|
readonly kind: "structural" | "semantic";
|
|
10
11
|
readonly path: readonly (string | number)[];
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# GeneratorDefinitionParseResult
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Parsed metadata or a bounded list of structural and semantic issues.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Parsed metadata or a bounded list of structural and semantic issues. */
|
|
8
9
|
export type GeneratorDefinitionParseResult<T> = {
|
|
9
10
|
readonly success: true;
|
|
10
11
|
readonly data: T;
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# GeneratorDescriptor
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Catalog discovery metadata; installed manifests remain authoritative for execution.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Catalog discovery metadata; installed manifests remain authoritative for execution. */
|
|
8
9
|
export type GeneratorDescriptor = z.output<typeof generatorDescriptorSchema>;
|
|
9
10
|
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# GeneratorPackageManifest
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Strict package metadata binding executable bytes, definition, presets, and runtime version.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Strict package metadata binding executable bytes, definition, presets, and runtime version. */
|
|
8
9
|
export type GeneratorPackageManifest = Omit<z.output<typeof generatorPackageManifestSchema>, "definition"> & {
|
|
9
10
|
readonly definition: GeneratorDefinition;
|
|
10
11
|
};
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# GeneratorPackageSource
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Authored-source visibility and, when available, its TypeScript entry path.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/packages` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Authored-source visibility and, when available, its TypeScript entry path. */
|
|
8
9
|
export type GeneratorPackageSource = GeneratorPackageManifest["source"];
|
|
9
10
|
```
|