@aelionsdk/material-sdk
此内容尚不支持你的语言。
@aelionsdk/material-sdk
Section titled “@aelionsdk/material-sdk”Type-safe authoring, validation, packaging, signing and trust tools for Aelion Material Protocol v1.
Install
Section titled “Install”npm install @aelionsdk/material-sdkAuthor CLI
Section titled “Author CLI”The package installs aelion-material:
pnpm exec aelion-material init ./my-packpnpm exec aelion-material build ./my-packpnpm exec aelion-material validate ./my-packpnpm exec aelion-material types ./my-packpnpm exec aelion-material preview ./my-packpnpm exec aelion-material prepublish ./my-packpnpm exec aelion-material pack ./my-pack --out ./dist/my-pack.aelionmatpnpm exec aelion-material golden actual.rgba expected.rgba --tolerance 2build refreshes declared payload sizes/hashes and generates types plus the
preview report. prepublish requires valid payload hashes and schemas, no error diagnostics,
strict determinism, and WebGL2/WebGPU compiler parity for declarative Graph
materials. The .aelionmat archive is deterministic.
Signing keys are deliberately not read by the generic CLI. A host that owns a
publisher key should obtain a CryptoKey from its own key system and call
signMaterialPackage() explicitly.
Node build systems can import the same operations from
@aelionsdk/material-sdk/author-cli.
TypeScript API
Section titled “TypeScript API”import { MaterialLabSession, materialDefinition, materialGraph, packMaterialPackage,} from '@aelionsdk/material-sdk';See the Material guide and AMP v1 reference.
Version 1.2.0 is the current stable release. Public API changes follow SemVer
and are recorded in the repository changelog and migration documentation.
Licensed under MIT.
Classes
Section titled “Classes”- AdaptiveMaterialQualityController
- MaterialCatalog
- MaterialDefinitionBuilder
- MaterialGraphBuilder
- MaterialLabSession
- MaterialMigrationRegistry
- MaterialRegistry
- MaterialTrustStore
Interfaces
Section titled “Interfaces”- AdaptiveMaterialQualityOptions
- AuthoredMaterial
- BundledMaterialResource
- GraphValue
- InspectedMaterialPackageFile
- InstallMaterialPackageOptions
- MaterialCatalogEntry
- MaterialCompositionPlan
- MaterialCompositionSlot
- MaterialDefinition
- MaterialDefinitionBuilderOptions
- MaterialDisplay
- MaterialExecutionContract
- MaterialExecutionPermissions
- MaterialFusionGroup
- MaterialGoldenDiff
- MaterialHostSecurityPolicy
- MaterialLabBackendReport
- MaterialLabBudgetReport
- MaterialLabReport
- MaterialMigration
- MaterialMigrationReport
- MaterialPackageByteLimits
- MaterialPackageFile
- MaterialPackageManifest
- MaterialPackageMetadata
- MaterialPackageReference
- MaterialPackageResolver
- MaterialPackageSignature
- MaterialPackageTransportInspection
- MaterialParameter
- MaterialPort
- MaterialPublisherKey
- MaterialRegistryOptions
- MaterialResourceSlot
- MaterialTrustAuditEntry
- MaterialValidationResult
- PackedMaterialPackage
- PackMaterialPackageOptions
- ResolvedMaterial
- SignedMaterialPackage
- SignMaterialPackageOptions
Type Aliases
Section titled “Type Aliases”- EnumValue
- FloatValue
- GraphValueType
- MaterialCatalogStatus
- MaterialGraphLiteral
- MaterialImplementation
- MaterialKind
- MaterialMigrationDomain
- MaterialPackageByteLimitOptions
- MaterialParameterDefault
- MaterialParameterType
- MaterialPortType
- MaterialResourceKind
- MaterialScope
- MaterialSignatureAlgorithm
- VisualFrameValue
Variables
Section titled “Variables”- DEFAULT_MATERIAL_PACKAGE_BYTE_LIMITS
- MATERIAL_DEFINITION_SCHEMA
- MATERIAL_GRAPH_SCHEMA
- MATERIAL_NODE_SET
- MATERIAL_PACKAGE_MAX_ARCHIVE_BYTES
- MATERIAL_PACKAGE_MAX_BYTES
- MATERIAL_PACKAGE_MAX_FILE_BYTES
- MATERIAL_PACKAGE_MAX_FILES
- MATERIAL_PACKAGE_MAX_MANIFEST_BYTES
- MATERIAL_PACKAGE_SCHEMA
- MATERIAL_PROTOCOL_VERSION
Functions
Section titled “Functions”- addMaterialPackageBytes
- canonicalizeMaterialJson
- canonicalMaterialBytes
- compareMaterialGolden
- copyMaterialBytes
- createDeterministicMaterialArchive
- createMaterialCompositionPlan
- decodeMaterialJson
- enforceMaterialExecutionPolicy
- inspectPackedMaterialPackage
- materialDefinition
- materialGraph
- materialPackageBudgetExceeded
- materialUint8ArrayByteLength
- packMaterialPackage
- resolveMaterialPackageByteLimits
- sha256Hex
- signMaterialPackage
- validateAuthoredMaterial
- validMaterialPackagePath
- verifyMaterialPackage