@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,14 +1,17 @@
|
|
|
1
1
|
# FontSelection
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Portable catalog font selection; catalog lookup and font preparation belong to the host.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/fonts` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/fonts` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/**
|
|
8
|
+
/** Portable catalog font selection; catalog lookup and font preparation belong to the host. */
|
|
9
9
|
export interface FontSelection {
|
|
10
|
+
/** 1–160 lowercase letters, digits, /, or -; starts with a letter or digit. */
|
|
10
11
|
readonly faceId: string;
|
|
12
|
+
/** Lowercase SHA-256 hex digest of the complete font file. */
|
|
11
13
|
readonly revision: string;
|
|
14
|
+
/** Requested static or variable weight, an integer from 1 through 1000. */
|
|
12
15
|
readonly weight: number;
|
|
13
16
|
}
|
|
14
17
|
```
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# isFontSelection
|
|
2
2
|
|
|
3
|
-
Checks
|
|
3
|
+
Checks selection fields without consulting a catalog or invoking property accessors.
|
|
4
4
|
|
|
5
|
-
Import from `@metamesh/generator-sdk/fonts` (@metamesh/generator-sdk@0.
|
|
5
|
+
Import from `@metamesh/generator-sdk/fonts` (@metamesh/generator-sdk@0.20.0).
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
|
-
/** Checks
|
|
8
|
+
/** Checks selection fields without consulting a catalog or invoking property accessors. */
|
|
9
9
|
export declare function isFontSelection(value: unknown): value is FontSelection;
|
|
10
10
|
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ArrayParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Ordered homogeneous numeric or text values with optional item-count bounds.
|
|
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 homogeneous numeric or text values with optional item-count bounds. */
|
|
8
9
|
export interface ArrayParameterDefinition extends ArrayParameterBase {
|
|
9
10
|
readonly default: readonly number[] | readonly string[];
|
|
10
11
|
readonly items: NumberArrayItemDefinition | StringArrayItemDefinition;
|
|
@@ -1,15 +1,18 @@
|
|
|
1
1
|
# BaseParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Shared identity, label, units, and presentation metadata for a parameter.
|
|
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
|
+
/** Shared identity, label, units, and presentation metadata for a parameter. */
|
|
8
9
|
export interface BaseParameterDefinition {
|
|
10
|
+
/** Stable parameter ID, unique within its definition. */
|
|
9
11
|
readonly id: string;
|
|
10
12
|
readonly label: string;
|
|
11
13
|
/** Supplementary description, also available as on-demand help in the editor. */
|
|
12
14
|
readonly description?: string | undefined;
|
|
15
|
+
/** Unit of saved values, such as mm or degrees; no conversion is applied. */
|
|
13
16
|
readonly unit?: string | undefined;
|
|
14
17
|
readonly ui?: ParameterUi | undefined;
|
|
15
18
|
}
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# BooleanParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
True-or-false parameter and its initial value.
|
|
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
|
+
/** True-or-false parameter and its initial value. */
|
|
8
9
|
export interface BooleanParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "boolean";
|
|
10
11
|
readonly default: boolean;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ChoiceOption
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Stable saved choice value with a separate display label and optional help.
|
|
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
|
+
/** Stable saved choice value with a separate display label and optional help. */
|
|
8
9
|
export interface ChoiceOption {
|
|
9
10
|
readonly value: string;
|
|
10
11
|
readonly label: string;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ChoiceParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
One selected value from ordered, uniquely identified options.
|
|
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
|
+
/** One selected value from ordered, uniquely identified options. */
|
|
8
9
|
export interface ChoiceParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "choice";
|
|
10
11
|
readonly default: string;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ChoiceSetParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Distinct selected values stored in the definition's option order.
|
|
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
|
+
/** Distinct selected values stored in the definition's option order. */
|
|
8
9
|
export interface ChoiceSetParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "choice-set";
|
|
10
11
|
readonly default: readonly string[];
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ColorParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Six-digit hexadecimal color; normalized values use lowercase #rrggbb.
|
|
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
|
+
/** Six-digit hexadecimal color; normalized values use lowercase #rrggbb. */
|
|
8
9
|
export interface ColorParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "color";
|
|
10
11
|
readonly default: string;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ConditionExpression
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Serializable visibility rule over parameter values; it never changes or validates those values.
|
|
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
|
+
/** Serializable visibility rule over parameter values; it never changes or validates those values. */
|
|
8
9
|
export type ConditionExpression = {
|
|
9
10
|
readonly all: readonly ConditionExpression[];
|
|
10
11
|
} | {
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Editing intent accompanies the explicit curve controls; no tangent is inferred at runtime.
|
|
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 accompanies the explicit curve controls; no tangent is inferred at runtime. */
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ContourParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Editable normalized closed contour; Generators own physical scaling and topology checks.
|
|
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 closed contour; Generators own physical scaling and topology checks. */
|
|
8
9
|
export interface ContourParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "contour";
|
|
10
11
|
readonly default: ContourValue;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ContourParameterUi
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Optional physical editing scales for normalized XY 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 XY coordinates. */
|
|
8
9
|
export interface ContourParameterUi extends ParameterUi {
|
|
9
10
|
readonly widthScale?: ParameterScaleReference | undefined;
|
|
10
11
|
readonly heightScale?: ParameterScaleReference | undefined;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Normalized planar coordinates, with X rightward and Y upward, in the unit square.
|
|
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 planar coordinates, with X rightward and Y upward, in the unit square. */
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ContourSegment
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Straight or cubic span ending at an explicit contour 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 span ending at an explicit contour anchor. */
|
|
8
9
|
export type ContourSegment = {
|
|
9
10
|
readonly type: "line";
|
|
10
11
|
readonly end: ContourAnchor;
|
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
# ContourValue
|
|
2
2
|
|
|
3
|
-
One
|
|
3
|
+
One normalized planar contour; its final endpoint and mode repeat the start exactly. Generators own physical scaling and topology checks.
|
|
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
|
+
* One normalized planar contour; its final endpoint and mode repeat the start exactly.
|
|
10
|
+
* Generators own physical scaling and topology checks.
|
|
11
|
+
*/
|
|
9
12
|
export interface ContourValue {
|
|
10
13
|
readonly version: 1;
|
|
11
14
|
readonly start: ContourAnchor;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# FontParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Font face, immutable file revision, and weight; contains no font bytes.
|
|
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
|
+
/** Font face, immutable file revision, and weight; contains no font bytes. */
|
|
8
9
|
export interface FontParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "font";
|
|
10
11
|
readonly default: FontSelection;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# GeneratorDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Serializable Generator identity, metadata, and ordered parameter definitions.
|
|
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
|
+
/** Serializable Generator identity, metadata, and ordered parameter definitions. */
|
|
8
9
|
export interface GeneratorDefinition extends ParameterDefinitionDocument {
|
|
9
10
|
readonly id: string;
|
|
10
11
|
readonly version: string;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
A validation issue whose optional parameter ID is tied to one definition.
|
|
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
|
/** A validation issue whose optional parameter ID is tied to one definition. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
One executable model program carrying its serializable Generator 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
|
/** One executable model program carrying its serializable Generator identity. */
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
# GeneratorModuleOptions
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Definition and typed program to bind without running 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
|
+
/** Definition and typed program to bind without running geometry. */
|
|
8
9
|
export interface GeneratorModuleOptions<D extends GeneratorDefinition, Program extends GeneratorProgram> {
|
|
10
|
+
/** Generator identity and parameter contract for the program. */
|
|
9
11
|
readonly definition: D;
|
|
12
|
+
/** Program using this definition's parameters and host-prepared services. */
|
|
10
13
|
readonly program: DefinitionBoundProgram<D, Program>;
|
|
11
14
|
}
|
|
12
15
|
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
The declared parameter ID union for a Generator definition.
|
|
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
|
/** The declared parameter ID union for a Generator definition. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Exact normalized parameter values derived from a Generator definition.
|
|
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
|
/** Exact normalized parameter values derived from a Generator definition. */
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# GeneratorPreset
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Named starting configuration containing every declared parameter in canonical form.
|
|
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
|
+
/** Named starting configuration containing every declared parameter in canonical form. */
|
|
8
9
|
export interface GeneratorPreset<D extends GeneratorDefinition = GeneratorDefinition> {
|
|
9
10
|
readonly id: string;
|
|
10
11
|
readonly label: string;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Structural program boundary; the SDK root never imports a Modeling runtime or kernel.
|
|
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
|
/** Structural program boundary; the SDK root never imports a Modeling runtime or kernel. */
|
|
@@ -2,13 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
Host services are local to an execution; functions never cross the Worker protocol.
|
|
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
|
/** Host services are local to an execution; functions never cross the Worker protocol. */
|
|
9
9
|
export interface GeneratorServices {
|
|
10
10
|
readonly text: {
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* Shapes vector paths and measurements for textSection() and sampleTextContours().
|
|
13
|
+
*
|
|
14
|
+
* @param text - Up to 512 UTF-16 code units; arc text must fit on one line.
|
|
15
|
+
*/
|
|
12
16
|
readonly layout: (text: string, options: GeneratorTextOptions) => GeneratorTextLayout;
|
|
13
17
|
};
|
|
14
18
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Circular text baseline centered at the XY origin; glyph groups retain their proportions.
|
|
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
|
/** Circular text baseline centered at the XY origin; glyph groups retain their proportions. */
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Exact vector paths and measurements in Y-up millimetres, never font bytes or live objects.
|
|
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
|
/** Exact vector paths and measurements in Y-up millimetres, never font bytes or live objects. */
|
|
@@ -1,21 +1,28 @@
|
|
|
1
1
|
# GeneratorTextMetrics
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Text measurements in millimetres, except the unitless lineCount; independent of a renderer.
|
|
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
|
+
/** Text measurements in millimetres, except the unitless lineCount; independent of a renderer. */
|
|
9
9
|
export interface GeneratorTextMetrics {
|
|
10
|
+
/** Visible curve bounds after alignment, or null when the text has no ink. */
|
|
10
11
|
readonly bounds: {
|
|
11
12
|
readonly min: readonly [number, number];
|
|
12
13
|
readonly max: readonly [number, number];
|
|
13
14
|
} | null;
|
|
15
|
+
/** Unaligned pen advance and baseline displacement; arcs retain [arc length, 0]. */
|
|
14
16
|
readonly advance: readonly [number, number];
|
|
17
|
+
/** Maximum line advance, including spaces; arc length on circular baselines. */
|
|
15
18
|
readonly logicalWidth: number;
|
|
19
|
+
/** Font ascender distance above the baseline. */
|
|
16
20
|
readonly ascent: number;
|
|
21
|
+
/** Nonnegative font descender distance below the baseline. */
|
|
17
22
|
readonly descent: number;
|
|
23
|
+
/** Actual distance between successive baselines. */
|
|
18
24
|
readonly lineHeight: number;
|
|
25
|
+
/** Includes empty and trailing lines; empty text occupies one line. */
|
|
19
26
|
readonly lineCount: number;
|
|
20
27
|
}
|
|
21
28
|
```
|
|
@@ -2,18 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
Text layout uses millimetres and prepared catalog fonts, with no runtime network access.
|
|
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
|
/** Text layout uses millimetres and prepared catalog fonts, with no runtime network access. */
|
|
9
9
|
export interface GeneratorTextOptions {
|
|
10
|
+
/** Catalog face already prepared by the host. */
|
|
10
11
|
readonly font: FontSelection;
|
|
12
|
+
/** Em size in millimetres; visible glyph height depends on the font. */
|
|
11
13
|
readonly fontSize: number;
|
|
14
|
+
/** Tracking between glyph clusters in millimetres; defaults to zero. */
|
|
12
15
|
readonly letterSpacing?: number;
|
|
16
|
+
/** Baseline spacing in ems; omission uses the font's natural metrics. */
|
|
13
17
|
readonly lineHeight?: number;
|
|
18
|
+
/** Horizontal alignment; defaults to center on arcs, otherwise left. */
|
|
14
19
|
readonly align?: "left" | "center" | "right";
|
|
15
20
|
/** One circular line with baseline vertical alignment; align defaults to center. */
|
|
16
21
|
readonly baseline?: GeneratorTextArcBaseline;
|
|
22
|
+
/** Aligns the baseline or complete ink bounds at Y=0; arcs require baseline. */
|
|
17
23
|
readonly verticalAlign?: "baseline" | "top" | "center" | "bottom";
|
|
18
24
|
}
|
|
19
25
|
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Maximum number of straight or cubic segments in an editable closed cross section.
|
|
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
|
MAX_CONTOUR_SEGMENTS = 32
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Maximum number of straight or cubic segments in an editable side profile.
|
|
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
|
MAX_SIDE_PROFILE_SEGMENTS = 31
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# NumberArrayItemDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Numeric array item rules, including optional bounds, units, and editing increment.
|
|
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
|
+
/** Numeric array item rules, including optional bounds, units, and editing increment. */
|
|
8
9
|
export interface NumberArrayItemDefinition {
|
|
9
10
|
readonly type: "number";
|
|
10
11
|
/** Defaults and bounds must be integers; strict decoding rejects fractional items. */
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# NumberArrayParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Ordered numeric 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 numeric values sharing one set of item rules. */
|
|
8
9
|
export interface NumberArrayParameterDefinition extends ArrayParameterBase {
|
|
9
10
|
readonly default: readonly number[];
|
|
10
11
|
readonly items: NumberArrayItemDefinition;
|
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
# NumberParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Finite numeric parameter with optional inclusive bounds and integer validation.
|
|
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
|
+
/** Finite numeric parameter with optional inclusive bounds and integer validation. */
|
|
8
9
|
export interface NumberParameterDefinition extends BaseParameterDefinition {
|
|
9
10
|
readonly type: "number";
|
|
10
11
|
readonly default: number;
|
|
11
12
|
/** Defaults and bounds must be integers; strict decoding rejects fractions. */
|
|
12
13
|
readonly integer?: boolean | undefined;
|
|
13
|
-
/** Saved maximum
|
|
14
|
+
/** Saved maximum curve deviation; requires unit "mm" and positive default and minimum. */
|
|
14
15
|
readonly role?: "curve-resolution" | undefined;
|
|
15
16
|
readonly min?: number | undefined;
|
|
16
17
|
readonly max?: number | undefined;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# NumberParameterUi
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Numeric editor choice and editing increments, independent of value validation.
|
|
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
|
+
/** Numeric editor choice and editing increments, independent of value validation. */
|
|
8
9
|
export interface NumberParameterUi extends RowParameterUi {
|
|
9
10
|
/** Defaults to number. A slider requires min, max, and a positive ui.step, and cannot share a row. */
|
|
10
11
|
readonly control?: "number" | "slider" | undefined;
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
# ParameterDefinition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Supported value definitions and their optional editor metadata.
|
|
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
|
+
/** Supported value definitions and their optional editor metadata. */
|
|
8
9
|
export type ParameterDefinition = NumberParameterDefinition | BooleanParameterDefinition | ChoiceParameterDefinition | ChoiceSetParameterDefinition | ColorParameterDefinition | TextParameterDefinition | FontParameterDefinition | SvgParameterDefinition | SideProfileParameterDefinition | ContourParameterDefinition | ArrayParameterDefinition;
|
|
9
10
|
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# ParameterDefinitionDocument
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Ordered parameter definitions and presentation groups, without Generator 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
|
+
/** Ordered parameter definitions and presentation groups, without Generator identity. */
|
|
8
9
|
export interface ParameterDefinitionDocument {
|
|
9
10
|
readonly groups: readonly ParameterGroup[];
|
|
10
11
|
readonly parameters: readonly ParameterDefinition[];
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Ordered presentation group; these objects contain no value semantics.
|
|
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
|
/** Ordered presentation group; these objects contain no value semantics. */
|
|
@@ -1,15 +1,16 @@
|
|
|
1
1
|
# ParameterIssue
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A parameter validation message, optionally tied to one value or nested field.
|
|
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
|
+
/** A parameter validation message, optionally tied to one value or nested field. */
|
|
8
9
|
export interface ParameterIssue {
|
|
9
10
|
readonly severity: ParameterIssueSeverity;
|
|
10
11
|
readonly parameterId?: string | undefined;
|
|
11
12
|
readonly message: string;
|
|
12
|
-
/** Optional stable category;
|
|
13
|
+
/** Optional stable category for host logic; message text is intended for people. */
|
|
13
14
|
readonly code?: ParameterIssueCode | undefined;
|
|
14
15
|
/** Location relative to this parameter value; omitted or empty means the whole value. */
|
|
15
16
|
readonly path?: readonly (number | string)[] | undefined;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Stable machine-readable categories shared by schema, authoring and strict decoding.
|
|
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
|
/** Stable machine-readable categories shared by schema, authoring and strict decoding. */
|