@metamesh/generator-sdk 0.19.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 +35 -0
- package/README.md +3 -0
- 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 +3 -0
- package/dist/docs/guides/parameters.md +3 -4
- package/dist/docs/manifest.json +272 -314
- 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 +3 -2
- package/dist/docs/reference/runtime/WorkerResponse.md +3 -2
- 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 +12 -3
- package/dist/modeling-delivery.d.ts.map +1 -1
- package/dist/modeling-delivery.js +12 -3
- package/dist/modeling-delivery.js.map +1 -1
- package/dist/modeling.d.ts +9 -4
- package/dist/modeling.d.ts.map +1 -1
- package/dist/modeling.js +9 -4
- 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 +15 -1
- 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/packages/GeneratorPreset.md +0 -14
- 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 -13
- package/dist/generator-package/versions.spec.js.map +0 -1
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# GeneratorPackageValidationError
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Invalid definition, preset, manifest, or descriptor with structured diagnostics.
|
|
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
|
+
/** Invalid definition, preset, manifest, or descriptor with structured diagnostics. */
|
|
8
9
|
export declare class GeneratorPackageValidationError extends Error {
|
|
9
10
|
readonly issues: readonly GeneratorDefinitionIssue[];
|
|
10
11
|
constructor(message: string, issues?: readonly GeneratorDefinitionIssue[]);
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# GeneratorRuntimeReference
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Exact Generator version and the host source from which its executable is loaded.
|
|
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
|
+
/** Exact Generator version and the host source from which its executable is loaded. */
|
|
8
9
|
export type GeneratorRuntimeReference = {
|
|
9
10
|
readonly kind: "bundled";
|
|
10
11
|
readonly version: string;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# InstalledGenerator
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Local installation identity, integrity, origin, and installation timestamp.
|
|
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
|
+
/** Local installation identity, integrity, origin, and installation timestamp. */
|
|
8
9
|
export interface InstalledGenerator {
|
|
9
10
|
readonly generatorId: string;
|
|
10
11
|
readonly installedAt: string;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_ARRAY_ITEMS
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum items in one array parameter.
|
|
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
|
MAX_ARRAY_ITEMS = 1024
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_CONDITION_BRANCHES
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum children in one all or any condition node.
|
|
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
|
MAX_CONDITION_BRANCHES = 32
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_CONDITION_DEPTH
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum nesting of all, any, and not condition nodes above a comparison.
|
|
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
|
MAX_CONDITION_DEPTH = 8
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_DESCRIPTOR_LIST_ITEMS
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum entries in each descriptor collection or tag list.
|
|
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
|
MAX_DESCRIPTOR_LIST_ITEMS = 128
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Maximum length of portable Generator and parameter identifiers.
|
|
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
|
MAX_GENERATOR_ID_LENGTH = 120
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_GENERATOR_PACKAGE_BYTES
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum downloaded executable bundle size in bytes.
|
|
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
|
MAX_GENERATOR_PACKAGE_BYTES: number
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_GENERATOR_PRESETS
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum presets in one Generator package.
|
|
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
|
MAX_GENERATOR_PRESETS = 256
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Maximum length of shared Generator metadata and choice labels.
|
|
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
|
MAX_METADATA_TEXT_LENGTH = 4096
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_PARAMETERS
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum parameters in one definition.
|
|
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
|
MAX_PARAMETERS = 256
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_PARAMETER_GROUPS
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum presentation groups in one definition.
|
|
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
|
MAX_PARAMETER_GROUPS = 64
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_PARAMETER_OPTIONS
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum options in one choice or choice-set parameter.
|
|
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
|
MAX_PARAMETER_OPTIONS = 512
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_TEXT_PARAMETER_LENGTH
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum UTF-16 code units in one text parameter.
|
|
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
|
MAX_TEXT_PARAMETER_LENGTH: number
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# METAMESH_RUNTIME_VERSION
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Modeling runtime compatibility version for this SDK release.
|
|
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
|
-
METAMESH_RUNTIME_VERSION = "
|
|
8
|
+
METAMESH_RUNTIME_VERSION = "13.0.0"
|
|
9
9
|
```
|
|
@@ -1,9 +1,14 @@
|
|
|
1
1
|
# compareSemanticVersions
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Compares canonical `major.minor.patch` versions; other version forms throw.
|
|
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
|
+
/**
|
|
9
|
+
* Compares canonical `major.minor.patch` versions; other version forms throw.
|
|
10
|
+
*
|
|
11
|
+
* @returns -1, 0, or 1 when the left version is earlier, equal, or later.
|
|
12
|
+
*/
|
|
8
13
|
export declare function compareSemanticVersions(left: string, right: string): number;
|
|
9
14
|
```
|
|
@@ -1,9 +1,15 @@
|
|
|
1
1
|
# isRuntimeCompatible
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Checks whether the host meets a same-major minimum; invalid versions return false.
|
|
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
|
+
/**
|
|
9
|
+
* Checks whether the host meets a same-major minimum; invalid versions return false.
|
|
10
|
+
*
|
|
11
|
+
* @param requiredVersion - Minimum runtime in canonical `major.minor.patch` form.
|
|
12
|
+
* @param currentVersion - Host runtime; defaults to {@link METAMESH_RUNTIME_VERSION}.
|
|
13
|
+
*/
|
|
8
14
|
export declare function isRuntimeCompatible(requiredVersion: string, currentVersion?: string): boolean;
|
|
9
15
|
```
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# parseGeneratorDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Parses Generator metadata and defaults, throwing GeneratorPackageValidationError on failure.
|
|
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
|
+
/** Parses Generator metadata and defaults, throwing GeneratorPackageValidationError on failure. */
|
|
8
9
|
export declare function parseGeneratorDefinition(value: unknown): GeneratorDefinition;
|
|
9
10
|
```
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# parseGeneratorDescriptor
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Parses strict catalog metadata; invalid descriptors throw GeneratorPackageValidationError.
|
|
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
|
+
/** Parses strict catalog metadata; invalid descriptors throw GeneratorPackageValidationError. */
|
|
8
9
|
export declare function parseGeneratorDescriptor(value: unknown): GeneratorDescriptor;
|
|
9
10
|
```
|
|
@@ -1,9 +1,15 @@
|
|
|
1
1
|
# parseGeneratorPackageManifest
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Parses strict portable manifest data and validates identity, runtime major, and presets. Invalid input throws GeneratorPackageValidationError.
|
|
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
|
+
/**
|
|
9
|
+
* Parses strict portable manifest data and validates identity, runtime major, and presets.
|
|
10
|
+
* Invalid input throws GeneratorPackageValidationError.
|
|
11
|
+
*
|
|
12
|
+
* @param value - Manifest data; copied before validation without invoking getters.
|
|
13
|
+
*/
|
|
8
14
|
export declare function parseGeneratorPackageManifest(value: unknown): GeneratorPackageManifest;
|
|
9
15
|
```
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# parseParameterDefinitionDocument
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Parses editable groups and parameters, throwing GeneratorPackageValidationError on failure.
|
|
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
|
+
/** Parses editable groups and parameters, throwing GeneratorPackageValidationError on failure. */
|
|
8
9
|
export declare function parseParameterDefinitionDocument(value: unknown): ParameterDefinitionDocument;
|
|
9
10
|
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Validates untrusted Generator metadata, collecting independent 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
8
|
/** Validates untrusted Generator metadata, collecting independent semantic issues. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Validates the editable groups/parameters document; issue paths are relative to its root.
|
|
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
|
/** Validates the editable groups/parameters document; issue paths are relative to its root. */
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
# validateGeneratorPresets
|
|
2
2
|
|
|
3
|
-
Validates strict preset metadata
|
|
3
|
+
Validates strict preset metadata and complete canonical values; invalid presets throw.
|
|
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
|
+
/**
|
|
9
|
+
* Validates strict preset metadata and complete canonical values; invalid presets throw.
|
|
10
|
+
*
|
|
11
|
+
* @param definition - Definition whose parameter map every preset must satisfy.
|
|
12
|
+
* @param presets - Portable presets to validate without changing the input.
|
|
13
|
+
* @param path - Diagnostic path prefix, including any enclosing manifest field.
|
|
14
|
+
*/
|
|
9
15
|
export declare function validateGeneratorPresets(definition: GeneratorDefinition, presets: readonly GeneratorPreset[], path?: string): void;
|
|
10
16
|
```
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# EMPTY_SVG_PARAMETER_DEFAULT
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Empty 100 mm square SVG document, centered on the origin.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
EMPTY_SVG_PARAMETER_DEFAULT = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"100mm\" height=\"100mm\" viewBox=\"-50 -50 100 100\"></svg>"
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_PARAMETER_ISSUES
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum retained issues from parameter validation or strict decoding.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
MAX_PARAMETER_ISSUES = 100
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_PARAMETER_ISSUE_MESSAGE_LENGTH
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum UTF-16 code units in a parsed parameter issue message.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
MAX_PARAMETER_ISSUE_MESSAGE_LENGTH = 1000
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_PROJECT_SVG_PARAMETER_BYTES
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum combined UTF-8 bytes across a Generator's SVG parameters.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
MAX_PROJECT_SVG_PARAMETER_BYTES: number
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# MAX_SVG_PARAMETER_BYTES
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Maximum UTF-8 bytes in one SVG parameter.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
MAX_SVG_PARAMETER_BYTES: number
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ParamCodec
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Strict decoder for a definition's complete, canonical parameter map.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Strict decoder for a definition's complete, canonical parameter map. */
|
|
8
9
|
export interface ParamCodec<D extends GeneratorDefinition> {
|
|
9
10
|
/** Returns a frozen parameter map or throws {@link ParamDecodeError} for validation failures. */
|
|
10
11
|
readonly parse: (input: unknown) => GeneratorParams<D>;
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# ParamDecodeCode
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Stable category reported by a strict parameter codec.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Stable category reported by a strict parameter codec. */
|
|
8
9
|
export type ParamDecodeCode = ParameterIssueCode;
|
|
9
10
|
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ParamDecodeError
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Parameter decoding failure with the retained validation issues.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Parameter decoding failure with the retained validation issues. */
|
|
8
9
|
export declare class ParamDecodeError extends TypeError {
|
|
9
10
|
readonly issues: readonly ParamDecodeIssue[];
|
|
10
11
|
constructor(issues: readonly ParamDecodeIssue[]);
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ParamDecodeIssue
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Strict decoding error tied to a parameter or the complete input map.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Strict decoding error tied to a parameter or the complete input map. */
|
|
8
9
|
export interface ParamDecodeIssue extends ParameterIssue {
|
|
9
10
|
readonly severity: "error";
|
|
10
11
|
readonly code: ParamDecodeCode;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ParamParseResult
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Strict decoding outcome; failures contain issues without substitute values.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Strict decoding outcome; failures contain issues without substitute values. */
|
|
8
9
|
export type ParamParseResult<P> = {
|
|
9
10
|
readonly success: true;
|
|
10
11
|
readonly data: P;
|
|
@@ -2,9 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
Caps reported issues, prioritizing errors while preserving the retained issues' input order.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Caps reported issues, prioritizing errors while preserving the retained issues' input order.
|
|
10
|
+
*
|
|
11
|
+
* @param issueSets - Validated issue lists, concatenated in the supplied order.
|
|
12
|
+
*/
|
|
9
13
|
export declare function aggregateParameterIssues(...issueSets: readonly (readonly ParameterIssue[])[]): ParameterValidationResult;
|
|
10
14
|
```
|
|
@@ -2,12 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
Creates a strict decoder for a definition's exact normalized parameter map. Decoding never fills, drops, clamps, or canonicalizes values.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/**
|
|
9
9
|
* Creates a strict decoder for a definition's exact normalized parameter map.
|
|
10
10
|
* Decoding never fills, drops, clamps, or canonicalizes values.
|
|
11
|
+
*
|
|
12
|
+
* @param definition - Validated definition; keep it unchanged while using the codec.
|
|
11
13
|
*/
|
|
12
14
|
export declare function createParamCodec<const D extends GeneratorDefinition>(definition: D): ParamCodec<D>;
|
|
13
15
|
```
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# getDefaultParameters
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Returns a fresh, frozen map of the definition's canonical defaults.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Returns a fresh, frozen map of the definition's canonical defaults. */
|
|
8
9
|
export declare function getDefaultParameters<const D extends GeneratorDefinition>(definition: D): GeneratorParams<D>;
|
|
9
10
|
```
|
|
@@ -2,12 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
Returns one value per declared parameter. Unknown input keys are discarded, missing/invalid values fall back to defaults, and numbers are clamped.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/**
|
|
9
9
|
* Returns one value per declared parameter. Unknown input keys are discarded,
|
|
10
10
|
* missing/invalid values fall back to defaults, and numbers are clamped.
|
|
11
|
+
*
|
|
12
|
+
* @param input - Saved or partial values; null or omission uses defaults.
|
|
11
13
|
*/
|
|
12
14
|
export declare function normalizeParameters<const D extends GeneratorDefinition>(definition: D, input?: Readonly<Record<string, unknown>> | null): GeneratorParams<D>;
|
|
13
15
|
```
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# parameterValueEquals
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Compares parameter content, including curve editing intent and font identity, using Object.is.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Compares parameter content, including curve editing intent and font identity, using Object.is. */
|
|
8
9
|
export declare function parameterValueEquals(previous: ParameterValue | undefined, next: ParameterValue | undefined): boolean;
|
|
9
10
|
```
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# parseParameterIssues
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Validates and freezes issue data returned by Generator code.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Validates and freezes issue data returned by Generator code.
|
|
10
10
|
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
11
|
+
* @param definition - Defines the parameter IDs that issues may reference.
|
|
12
|
+
* @param value - Untrusted issue list; malformed or oversized data throws TypeError.
|
|
13
13
|
*/
|
|
14
14
|
export declare function parseParameterIssues(definition: GeneratorDefinition, value: unknown): readonly ParameterIssue[];
|
|
15
15
|
```
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# svgParameterBytes
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Counts UTF-8 bytes without parsing or validating the SVG document.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/parameters` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Counts UTF-8 bytes without parsing or validating the SVG document. */
|
|
8
9
|
export declare function svgParameterBytes(value: string): number;
|
|
9
10
|
```
|
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
# ExecuteGeneratorOptions
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Strict input validation and the host callback used to execute one Generator request.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Strict input validation and the host callback used to execute one Generator request. */
|
|
8
9
|
export interface ExecuteGeneratorOptions<D extends GeneratorDefinition, Program extends GeneratorProgram, Output> {
|
|
9
10
|
readonly definition: D;
|
|
11
|
+
/** Complete parameter map; missing, unknown, or noncanonical values reject before execution. */
|
|
10
12
|
readonly parameters: Readonly<Record<string, unknown>>;
|
|
11
13
|
readonly module: GeneratorModule<D> & Program;
|
|
12
14
|
readonly services: GeneratorServices;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# GenerateRequest
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Requests generation from one exact Generator version and complete parameter map.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/runtime` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
+
/** Requests generation from one exact Generator version and complete parameter map. */
|
|
8
9
|
export interface GenerateRequest {
|
|
9
10
|
readonly type: "generate";
|
|
10
11
|
readonly requestId: number;
|