SDK public API
Supported exports and import paths for the published Aether SDK package.
47 minute read
Every entry below is available from the published @aether/sdk package. Use the listed import path; Aether's repository layout is not part of the API. Entries marked as schemas are Zod validators for authored packages and runtime data.
#Action feedback
| Export | Import from | Kind | Purpose |
|---|---|---|---|
SandboxToastAction | @aether/sdk | type | Type for sandbox toast action. |
sandboxToastActionSchema | @aether/sdk | schema | Validates sandbox toast action data. |
SandboxToastRequest | @aether/sdk | type | Type for sandbox toast request. |
sandboxToastRequestSchema | @aether/sdk | schema | Bounded feedback a sandbox application may ask Aether to render. |
ValidatedSandboxToastAction | @aether/sdk | type | Type for validated sandbox toast action. |
ValidatedSandboxToastRequest | @aether/sdk | type | Type for validated sandbox toast request. |
#Audio
| Export | Import from | Kind | Purpose |
|---|---|---|---|
AudioCueMetadata | @aether/sdk | type | Type for audio cue metadata. |
audioCueMetadataSchema | @aether/sdk | schema | Playback-relevant cue metadata exposed without asset bytes or private URLs. |
AudioManageCommand | @aether/sdk | type | Type for audio manage command. |
audioManageCommandSchema | @aether/sdk | schema | Validates audio manage command data. |
AudioPlaybackCommand | @aether/sdk | type | Type for audio playback command. |
audioPlaybackCommandSchema | @aether/sdk | schema | Validates audio playback command data. |
audioReadRequestSchema | @aether/sdk | schema | Validates audio read request data. |
#Capabilities and permissions
| Export | Import from | Kind | Purpose |
|---|---|---|---|
CapabilityView | @aether/sdk | interface | A grantable capability, resolved to its consent-dialog / Permissions-tab label. |
compareSemver | @aether/sdk | function | Compare two semver strings: -1 if a < b, 0 if equal, 1 if a > b. |
describeCapabilities | @aether/sdk | function | Split a mod's requested capability ids into grantable (with labels) vs denied. |
DescribedCapabilities | @aether/sdk | interface | Type for described capabilities. |
isGrantableCapability | @aether/sdk | function | True if a capability id may be offered for consent + host-allowlisted (known & not denied). |
MOD_CAPABILITIES | @aether/sdk | constant | The versioned registry. |
ModCapabilityDef | @aether/sdk | interface | The mod capability taxonomy. |
satisfies | @aether/sdk | function | Minimal semver range match. |
satisfiesMinSdk | @aether/sdk | function | True if the host SDK version 'have' satisfies a package's 'minSdkVersion'. |
#Companion app bridge
| Export | Import from | Kind | Purpose |
|---|---|---|---|
BRIDGE_VERSION | @aether/sdk/bridge | constant | Bumped when the wire contract changes; negotiated in the init/ready handshake. |
BridgeMessage | @aether/sdk/bridge | type | Type for bridge message. |
capabilityArgSchemas | @aether/sdk/bridge | constant | Positional-arg schemas per op, derived from the 'MOD_CAPABILITIES' taxonomy. |
EventMessage | @aether/sdk/bridge | interface | Host → guest: a broadcast on a topic the guest subscribed to (e.g. "rolls"). |
grantForOp | @aether/sdk/bridge | function | Map an op to the manifest capability it requires (undefined = namespace-scoped only). |
GuestToHostMessage | @aether/sdk/bridge | type | Type for guest to host message. |
HOST_NONCE_PARAM | @aether/sdk/bridge | constant | The host nonce param value. |
HOST_ORIGIN_PARAM | @aether/sdk/bridge | constant | URL query param the host appends to the mod iframe src carrying the host origin. |
HostToGuestMessage | @aether/sdk/bridge | type | Type for host to guest message. |
InitMessage | @aether/sdk/bridge | interface | Host → guest: sent once the guest signals 'ready'. |
InvokeMessage | @aether/sdk/bridge | interface | Guest → host: a capability-gated op call, correlated by 'callId'. |
isBridgeMessage | @aether/sdk/bridge | function | Narrow an arbitrary 'postMessage' payload to a bridge message. |
MessageBus | @aether/sdk/bridge | class | A tiny typed postMessage transport. |
MessageBusConfig | @aether/sdk/bridge | interface | Type for message bus config. |
MIN_BRIDGE_VERSION | @aether/sdk/bridge | constant | Existing version-2 mods remain loadable; only version 3 may use scene objects. |
namespaceScopedOps | @aether/sdk/bridge | constant | Ops that don't need a manifest grant but are namespace-scoped by the host (derived). |
PingMessage | @aether/sdk/bridge | interface | Type for ping message. |
PongMessage | @aether/sdk/bridge | interface | Type for pong message. |
PortInitMessage | @aether/sdk/bridge | interface | Type for port init message. |
PortMessageBus | @aether/sdk/bridge | class | The steady-state transport for opaque-origin apps. |
PortReadyMessage | @aether/sdk/bridge | interface | Opaque-origin bootstrap. |
ReadyMessage | @aether/sdk/bridge | interface | Guest → host: sent when the guest's runtime is ready to receive 'init'. |
ResultMessage | @aether/sdk/bridge | type | Host → guest: the reply to a single 'invoke', correlated by 'callId'. |
SubscribeMessage | @aether/sdk/bridge | interface | Guest → host: subscribe/unsubscribe to a broadcast topic. |
ThemeMessage | @aether/sdk/bridge | interface | Host → guest: re-sent whenever the host theme (e.g. light/dark) changes. |
topicGrants | @aether/sdk/bridge | constant | Broadcast topics a mod can subscribe to, and the grant each one requires (derived). |
TourAnchorRect | @aether/sdk/bridge | type | Type for tour anchor rect. |
tourAnchorRectSchema | @aether/sdk/bridge | schema | Validates tour anchor rect data. |
TourAnchorUpdateMessage | @aether/sdk/bridge | type | Type for tour anchor update message. |
tourAnchorUpdateMessageSchema | @aether/sdk/bridge | schema | Guest → host: one frame-relative rectangle for an element the package owns. |
TourSignalMessage | @aether/sdk/bridge | type | Type for tour signal message. |
tourSignalMessageSchema | @aether/sdk/bridge | schema | Guest → host: a semantic outcome, never an imperative current-step completion. |
UnsubscribeMessage | @aether/sdk/bridge | interface | Type for unsubscribe message. |
#Companion app client
| Export | Import from | Kind | Purpose |
|---|---|---|---|
ConnectOptions | @aether/sdk/sandbox | interface | Type for connect options. |
connectToHost | @aether/sdk/sandbox | function | Handshake with the host and return a typed client. |
SandboxClient | @aether/sdk/sandbox | interface | The guest runtime for sandboxed mod panels. |
SandboxRollOptions | @aether/sdk/sandbox | interface | Type for sandbox roll options. |
#Content packs
| Export | Import from | Kind | Purpose |
|---|---|---|---|
buildContentPack | @aether/sdk | function | Build a content pack from selected world documents. |
BuildContentPackOptions | @aether/sdk | interface | Options for buildContentPack - the pack identity a GM's export assigns. |
checkPackCompatibility | @aether/sdk | function | Check a content pack against the world's system, document types, and installed dependencies. |
ContentPack | @aether/sdk | type | A parsed content pack (defaults applied). |
ContentPackEntryMeta | @aether/sdk | interface | One entry in a pack's lazy index. |
contentPackIndex | @aether/sdk | function | Derive the lazy index from a pack (Foundry's index-first pattern). |
ContentPackIndex | @aether/sdk | interface | The lazy index of a pack - cheap metadata a client shows before hydrating bodies. |
ContentPackInput | @aether/sdk | type | The author-facing pack (defaulted arrays optional). |
contentPackSchema | @aether/sdk | schema | Validates content pack data. |
defineContentPack | @aether/sdk | function | Author entrypoint: 'export const MY_PACK = defineContentPack({ ... })'. |
NormalizedPackDependency | @aether/sdk | interface | Type for normalized pack dependency. |
normalizePackDependencies | @aether/sdk | function | Normalize pack dependencies. |
PACK_ASSET_PREFIX | @aether/sdk | constant | The pack-local asset ref an authored document uses; rewritten to 'asset:<hash>' on install. |
PackAsset | @aether/sdk | type | Type for pack asset. |
packAssetRef | @aether/sdk | function | Pack asset ref. |
packAssetSchema | @aether/sdk | schema | A content-addressed asset shipped in a pack. |
PackCompatResult | @aether/sdk | type | Type for pack compat result. |
PackDependency | @aether/sdk | type | Type for pack dependency. |
packDependencySchema | @aether/sdk | schema | A dependency needed by a declarative pack. |
PackDocument | @aether/sdk | type | Type for pack document. |
packDocumentSchema | @aether/sdk | schema | A pre-authored document instance. |
PackInstallContext | @aether/sdk | interface | The world state a pack's compatibility is checked against. |
parsePackAssetRef | @aether/sdk | function | Parse pack asset ref. |
remapPackRefs | @aether/sdk | function | Rewrite intra-pack references on install. |
#Context menus
| Export | Import from | Kind | Purpose |
|---|---|---|---|
SandboxContextMenuActionAnchor | @aether/sdk | type | Type for sandbox context menu action anchor. |
sandboxContextMenuActionAnchorSchema | @aether/sdk | schema | Validates sandbox context menu action anchor data. |
SandboxContextMenuIcon | @aether/sdk | type | Type for sandbox context menu icon. |
sandboxContextMenuIconSchema | @aether/sdk | schema | Validates sandbox context menu icon data. |
SandboxContextMenuItem | @aether/sdk | type | Type for sandbox context menu item. |
sandboxContextMenuItemSchema | @aether/sdk | schema | Validates sandbox context menu item data. |
SandboxContextMenuRequest | @aether/sdk | type | Type for sandbox context menu request. |
sandboxContextMenuRequestSchema | @aether/sdk | schema | Bounded data a sandbox app may ask Aether to render as a native context menu. |
ValidatedSandboxContextMenuItem | @aether/sdk | type | Type for validated sandbox context menu item. |
ValidatedSandboxContextMenuRequest | @aether/sdk | type | Type for validated sandbox context menu request. |
#Creation flows
| Export | Import from | Kind | Purpose |
|---|---|---|---|
compileSystemProjectCreationFlows | @aether/sdk | function | Compile authored Creation flows against a System Project snapshot. |
CREATION_FLOW_ARTIFACT_FORMAT | @aether/sdk | constant | The format of Creation flow artifacts included in a system package. |
CreationFlowArtifact | @aether/sdk | type | Type for creation flow artifact. |
creationFlowArtifactSchema | @aether/sdk | schema | Validates creation flow artifact data. |
creationFlowArtifactV1Schema | @aether/sdk | schema | Validates creation flow artifact v1 data. |
CreationFlowCompileError | @aether/sdk | class | The creation flow compile error class. |
CreationFlowQuestionArtifact | @aether/sdk | type | Type for creation flow question artifact. |
creationFlowQuestionArtifactSchema | @aether/sdk | schema | Validates creation flow question artifact data. |
CreationFlowStepArtifact | @aether/sdk | type | Type for creation flow step artifact. |
creationFlowStepArtifactSchema | @aether/sdk | schema | Validates creation flow step artifact data. |
OwnedFieldContribution | @aether/sdk | type | Type for owned field contribution. |
ownedFieldContributionSchema | @aether/sdk | schema | Exact Add-owned binding carried with format-4 systems, never inferred from a label. |
SYSTEM_PROJECT_CREATION_FLOW_LIMITS | @aether/sdk | constant | Limits on authored Creation flow steps, questions and choices. |
SYSTEM_PROJECT_CREATION_FLOW_SOURCE_FORMAT | @aether/sdk | constant | The source format for Creation flows authored in System Projects. |
SystemProjectCreationAnswer | @aether/sdk | type | Type for system project creation answer. |
SystemProjectCreationFlowSource | @aether/sdk | type | Type for system project creation flow source. |
systemProjectCreationFlowSourceSchema | @aether/sdk | schema | Validates system project creation flow source data. |
SystemProjectCreationQuestion | @aether/sdk | type | Type for system project creation question. |
systemProjectCreationQuestionSchema | @aether/sdk | schema | Validates system project creation question data. |
SystemProjectCreationStep | @aether/sdk | type | Type for system project creation step. |
systemProjectCreationStepSchema | @aether/sdk | schema | Validates system project creation step data. |
#Document navigation
| Export | Import from | Kind | Purpose |
|---|---|---|---|
SandboxDocumentOpenOptions | @aether/sdk | type | Type for sandbox document open options. |
sandboxDocumentOpenOptionsSchema | @aether/sdk | schema | The document-owned surface Aether should reveal. |
ValidatedSandboxDocumentOpenOptions | @aether/sdk | type | Type for validated sandbox document open options. |
#Events and dice
| Export | Import from | Kind | Purpose |
|---|---|---|---|
DiceApi | @aether/sdk | interface | The dice operations available to a dice mod. |
DiceCosmeticDescriptor | @aether/sdk | interface | Type for dice cosmetic descriptor. |
ENGINE_EVENTS | @aether/sdk | constant | The catalogue as data, so the consent dialog and the docs can list it without a second copy. |
EngineEventName | @aether/sdk | type | Type for engine event name. |
EngineEvents | @aether/sdk | interface | Every event the engine emits, with its payload. |
isEngineEvent | @aether/sdk | function | Is engine event. |
RollPresentation | @aether/sdk | interface | Type for roll presentation. |
#Game actions
| Export | Import from | Kind | Purpose |
|---|---|---|---|
ActionInvocation | @aether/sdk | type | Type for action invocation. |
actionInvocationSchema | @aether/sdk | schema | Validates action invocation data. |
ActionSpec | @aether/sdk | type | Type for action spec. |
actionSpecSchema | @aether/sdk | schema | Validates action spec data. |
evaluateRuleValue | @aether/sdk | function | Evaluate rule value. |
GameActionOutcome | @aether/sdk | type | Type for game action outcome. |
gameActionOutcomeSchema | @aether/sdk | schema | Validates game action outcome data. |
PackageActionRef | @aether/sdk | type | Type for package action ref. |
packageActionRefSchema | @aether/sdk | schema | Validates package action ref data. |
rule | @aether/sdk | constant | The rule value. |
RuleContext | @aether/sdk | interface | Type for rule context. |
RuleValue | @aether/sdk | type | Type for rule value. |
ruleValueSchema | @aether/sdk | schema | Validates rule value data. |
#Guided tours
| Export | Import from | Kind | Purpose |
|---|---|---|---|
localizedTourText | @aether/sdk | function | Localized tour text. |
TOUR_LIMITS | @aether/sdk | constant | The tour limits value. |
TourAnchor | @aether/sdk | type | Type for tour anchor. |
tourAnchorSchema | @aether/sdk | schema | Validates tour anchor data. |
TourAudience | @aether/sdk | type | Type for tour audience. |
tourAudienceSchema | @aether/sdk | schema | Validates tour audience data. |
TourCompletion | @aether/sdk | type | Type for tour completion. |
tourCompletionSchema | @aether/sdk | schema | Validates tour completion data. |
TourContribution | @aether/sdk | type | Type for tour contribution. |
tourContributionSchema | @aether/sdk | schema | Manual-only, data-only package contribution. |
tourLocalizedBodySchema | @aether/sdk | schema | Validates tour localized body data. |
TourLocalizedText | @aether/sdk | type | Type for tour localized text. |
tourLocalizedTitleSchema | @aether/sdk | schema | Validates tour localized title data. |
TourMissingAnchorPolicy | @aether/sdk | type | Type for tour missing anchor policy. |
tourMissingAnchorPolicySchema | @aether/sdk | schema | Validates tour missing anchor policy data. |
tourPanelAnchorSchema | @aether/sdk | schema | Validates tour panel anchor data. |
TourStep | @aether/sdk | type | Type for tour step. |
tourStepSchema | @aether/sdk | schema | Validates tour step data. |
#Hosted systems
| Export | Import from | Kind | Purpose |
|---|---|---|---|
buildSystemArtifact | @aether/sdk/system | function | Build the deterministic logical artifact. |
BuiltSystemArtifact | @aether/sdk/system | interface | Type for built system artifact. |
canonicalSystemJson | @aether/sdk/system | function | Stable JSON used for manifest bytes and identity calculations. |
compilePortableDocumentType | @aether/sdk/system | function | Compile portable document type. |
compilePortableSchema | @aether/sdk/system | function | Compile inert portable data into the runtime validator used by a loaded system. |
compileSystemArtifact | @aether/sdk/system | function | Runtime contribution compiled without executing package code. |
PortableDocumentType | @aether/sdk/system | type | Type for portable document type. |
portableDocumentTypeSchema | @aether/sdk/system | schema | Validates portable document type data. |
PortableSchema | @aether/sdk/system | type | Type for portable. |
portableSchemaSchema | @aether/sdk/system | schema | Validates portable schema data. |
ProvidedService | @aether/sdk/system | type | Type for provided service. |
providedServiceSchema | @aether/sdk/system | schema | Validates provided service data. |
quickJsSystemGeneratorSchema | @aether/sdk/system | schema | Validates quick js system generator data. |
RequiredService | @aether/sdk/system | type | Type for required service. |
requiredServiceSchema | @aether/sdk/system | schema | Validates required service data. |
serviceScopeSchema | @aether/sdk/system | schema | Validates service scope data. |
sha256SystemBytes | @aether/sdk/system | function | Sha256 system bytes. |
SYSTEM_ARTIFACT_FORMAT | @aether/sdk/system | constant | The current hosted-system artifact format identifier. |
SYSTEM_ARTIFACT_LEGACY_FORMAT_V3 | @aether/sdk/system | constant | The system artifact legacy format v3 value. |
SYSTEM_ARTIFACT_LEGACY_FORMAT_V4 | @aether/sdk/system | constant | The system artifact legacy format v4 value. |
SYSTEM_ARTIFACT_LEGACY_FORMAT_V5 | @aether/sdk/system | constant | The system artifact legacy format v5 value. |
SYSTEM_ARTIFACT_LEGACY_FORMAT_V6 | @aether/sdk/system | constant | The system artifact legacy format v6 value. |
SYSTEM_ARTIFACT_LEGACY_FORMAT_V7 | @aether/sdk/system | constant | The system artifact legacy format v7 value. |
SYSTEM_ARTIFACT_LEGACY_FORMAT_V8 | @aether/sdk/system | constant | The system artifact legacy format v8 value. |
SYSTEM_ARTIFACT_LIMITS | @aether/sdk/system | constant | The system artifact limits value. |
SystemArtifactEntry | @aether/sdk/system | type | Type for system artifact entry. |
SystemArtifactFileInput | @aether/sdk/system | interface | Type for system artifact file input. |
systemArtifactIdentity | @aether/sdk/system | function | Identity named by installs before the artifact bytes are materialized into a runtime object. |
SystemArtifactInput | @aether/sdk/system | type | Type for system artifact input. |
systemArtifactInputSchema | @aether/sdk/system | schema | Validates system artifact input data. |
SystemArtifactInputV1 | @aether/sdk/system | type | Type for system artifact input v1. |
SystemArtifactManifest | @aether/sdk/system | type | Type for system artifact manifest. |
systemArtifactManifestSchema | @aether/sdk/system | schema | Validates system artifact manifest data. |
SystemDependency | @aether/sdk/system | type | Type for system dependency. |
systemDependencySchema | @aether/sdk/system | schema | Validates system dependency data. |
SystemGenerator | @aether/sdk/system | type | Type for system generator. |
systemGeneratorSchema | @aether/sdk/system | schema | Validates system generator data. |
SystemLibrary | @aether/sdk/system | type | Type for system library. |
systemLibrarySchema | @aether/sdk/system | schema | Immutable mounted reference library declared by a hosted system. |
SystemMigration | @aether/sdk/system | type | Type for system migration. |
systemMigrationSchema | @aether/sdk/system | schema | Validates system migration data. |
SystemUpgradePolicy | @aether/sdk/system | type | Type for system upgrade policy. |
systemUpgradePolicySchema | @aether/sdk/system | schema | Format-3 install policy is part of immutable artifact bytes, never a listing hint. |
verifySystemArtifact | @aether/sdk/system | function | Verify system artifact. |
verifySystemLibraries | @aether/sdk/system | function | Validate index/shard bodies against their declaration and portable entry schema. |
visualRecipeSystemGeneratorSchema | @aether/sdk/system | schema | Validates visual recipe system generator data. |
#Integrity
| Export | Import from | Kind | Purpose |
|---|---|---|---|
hashManifest | @aether/sdk | function | The integrity hash a GM consents to for a mod: SHA-256 hex of the raw 'mod.json' text. |
sha256HexOfText | @aether/sdk | function | SHA-256 of a UTF-8 string, as lowercase hex. |
#Native JSX runtime
| Export | Import from | Kind | Purpose |
|---|---|---|---|
Fragment | @aether/sdk/native/jsx-runtime | constant | The fragment value. |
jsx | @aether/sdk/native/jsx-runtime | function | Jsx. |
JSX | @aether/sdk/native/jsx-runtime | export | Type for jsx. |
jsxDEV | @aether/sdk/native/jsx-runtime | constant | The jsx dev value. |
jsxs | @aether/sdk/native/jsx-runtime | constant | The jsxs value. |
#Native views
| Export | Import from | Kind | Purpose |
|---|---|---|---|
Badge | @aether/sdk/native | function | Badge. |
Button | @aether/sdk/native | function | Button. |
Callout | @aether/sdk/native | function | Callout. |
Collection | @aether/sdk/native | function | Collection. |
defineNativeView | @aether/sdk/native | function | Define native view. |
Divider | @aether/sdk/native | function | Divider. |
document | @aether/sdk/native | constant | The document value. |
expr | @aether/sdk/native | constant | The expr value. |
Field | @aether/sdk/native | function | Field. |
gesture | @aether/sdk/native | constant | The gesture value. |
Grid | @aether/sdk/native | function | Grid. |
Heading | @aether/sdk/native | function | Heading. |
item | @aether/sdk/native | constant | The item value. |
Meter | @aether/sdk/native | function | Meter. |
Metric | @aether/sdk/native | function | Metric. |
native | @aether/sdk/native | constant | The native value. |
NATIVE_VIEW_FORMAT | @aether/sdk/native | constant | one bounded, inert format shared by every wire-facing host renderer. |
NATIVE_VIEW_FORMAT_V2 | @aether/sdk/native | constant | V2 adds named layout nodes without widening the V1 node schema. |
NATIVE_VIEW_LIMITS | @aether/sdk/native | constant | The native view limits value. |
NativeChild | @aether/sdk/native | type | Type for native child. |
NativeComponent | @aether/sdk/native | type | Type for native component. |
NativeExpression | @aether/sdk/native | interface | Type for native expression. |
nativeExpressionSchema | @aether/sdk/native | schema | Validates native expression data. |
NativeFragment | @aether/sdk/native | function | Native fragment. |
NativeGesture | @aether/sdk/native | type | Type for native gesture. |
nativeGestureSchema | @aether/sdk/native | schema | Validates native gesture data. |
NativeNode | @aether/sdk/native | type | Type for native node. |
nativeNodeSchema | @aether/sdk/native | schema | Validates native node data. |
NativeNodeV2 | @aether/sdk/native | type | Type for native node v2. |
nativeNodeV2Schema | @aether/sdk/native | schema | Validates native node v2 data. |
NativeQuery | @aether/sdk/native | type | Type for native query. |
nativeQuerySchema | @aether/sdk/native | schema | Validates native query data. |
NativeRef | @aether/sdk/native | type | Type for native ref. |
nativeRefSchema | @aether/sdk/native | schema | Validates native ref data. |
NativeScalar | @aether/sdk/native | type | Type for native scalar. |
NativeScope | @aether/sdk/native | interface | Type for native scope. |
NativeTextPart | @aether/sdk/native | type | Type for native text part. |
NativeValue | @aether/sdk/native | type | Type for native value. |
nativeValueSchema | @aether/sdk/native | schema | Validates native value data. |
NativeViewAreaAppearanceV2 | @aether/sdk/native | interface | Type for native view area appearance v2. |
nativeViewAreaAppearanceV2Schema | @aether/sdk/native | schema | Validates native view area appearance v2 data. |
NativeViewArtifact | @aether/sdk/native | type | Type for native view artifact. |
nativeViewArtifactAnySchema | @aether/sdk/native | schema | Validates native view artifact any data. |
nativeViewArtifactSchema | @aether/sdk/native | schema | Validates native view artifact data. |
NativeViewArtifactV1 | @aether/sdk/native | interface | Type for native view artifact v1. |
NativeViewArtifactV2 | @aether/sdk/native | interface | Type for native view artifact v2. |
nativeViewArtifactV2Schema | @aether/sdk/native | schema | Validates native view artifact v2 data. |
NativeViewGapV2 | @aether/sdk/native | type | Type for native view gap v2. |
nativeViewGapV2Schema | @aether/sdk/native | schema | Validates native view gap v2 data. |
Prose | @aether/sdk/native | function | Prose. |
query | @aether/sdk/native | constant | The query value. |
Rank | @aether/sdk/native | function | Rank. |
Score | @aether/sdk/native | function | Score. |
Section | @aether/sdk/native | function | Section. |
Stack | @aether/sdk/native | function | Stack. |
Stat | @aether/sdk/native | constant | The stat value. |
Tab | @aether/sdk/native | function | Tab. |
Tabs | @aether/sdk/native | function | Tabs. |
Text | @aether/sdk/native | function | Text. |
#Package resolution
| Export | Import from | Kind | Purpose |
|---|---|---|---|
PackageCandidate | @aether/sdk/package-graph | interface | Type for package candidate. |
PackageGraphEdge | @aether/sdk/package-graph | interface | Type for package graph edge. |
PackageResolutionCode | @aether/sdk/package-graph | type | Type for package resolution code. |
PackageResolutionError | @aether/sdk/package-graph | class | The package resolution error class. |
PackageRootRequirement | @aether/sdk/package-graph | interface | Type for package root requirement. |
PinnedPackage | @aether/sdk/package-graph | interface | Type for pinned package. |
ResolvedPackageGraph | @aether/sdk/package-graph | interface | Type for resolved package graph. |
resolvePackageGraph | @aether/sdk/package-graph | function | Resolve one immutable version per package before installation mutates a world. |
ResolvePackageGraphOptions | @aether/sdk/package-graph | interface | Type for resolve package graph options. |
validatePinnedGraph | @aether/sdk/package-graph | function | Refuse a mutation that would break any pinned package or service edge. |
#Packages and contributions
| Export | Import from | Kind | Purpose |
|---|---|---|---|
ActionAnchor | @aether/sdk | type | Type for action anchor. |
actionAnchorSchema | @aether/sdk | schema | Semantic locations owned and laid out by the host. |
ActionContribution | @aether/sdk | type | Type for action contribution. |
actionContributionSchema | @aether/sdk | schema | One host-placed action. |
AutomationContribution | @aether/sdk | interface | A system's automation contribution: a set of named scripts, invoked by id. |
ChatCommandContribution | @aether/sdk | type | Type for chat command contribution. |
chatCommandContributionSchema | @aether/sdk | schema | Validates a slash command contributed to chat. |
ContentPackContribution | @aether/sdk | type | Type for content pack contribution. |
contentPackContributionSchema | @aether/sdk | schema | Validates a package contribution that provides a content pack. |
Contribution | @aether/sdk | type | Type for contribution. |
contributionSchema | @aether/sdk | schema | Validates contribution data. |
defineModule | @aether/sdk | function | Define module. |
defineSystem | @aether/sdk | function | Author entrypoint: 'export default defineSystem({ ... })'. |
deriveCategory | @aether/sdk | function | Return the Marketplace category for a package manifest. |
dockLocationSchema | @aether/sdk | schema | Validates where a contributed panel opens in a fresh layout. |
GridDefaults | @aether/sdk | type | Type for grid defaults. |
gridDefaultsSchema | @aether/sdk | schema | Validates grid defaults data. |
Manifest | @aether/sdk | type | The parsed manifest (defaults applied) - what consumers read after 'manifestSchema.parse'. |
ManifestInput | @aether/sdk | type | The author-facing manifest - defaulted fields (authors, compatibility, capabilities, contributes) are optional. |
manifestSchema | @aether/sdk | schema | Validates manifest data. |
manifestUsesCustomInterface | @aether/sdk | function | Renderer disclosure used by install and marketplace UI. |
MarketplaceCategory | @aether/sdk | type | A browsable Marketplace package category. |
marketplaceCategorySchema | @aether/sdk | schema | Validates marketplace category data. |
MarketplaceContentSummary | @aether/sdk | type | Type for marketplace content summary. |
MarketplaceInstallDescriptor | @aether/sdk | interface | Persisted publish-time classification. |
MarketplaceInstallKind | @aether/sdk | type | Type for marketplace install kind. |
marketplaceInstallKindSchema | @aether/sdk | schema | Validates marketplace install kind data. |
MarketplaceSoundscapeFileSummary | @aether/sdk | interface | Type for marketplace soundscape file summary. |
MarketplaceSoundscapeSummary | @aether/sdk | interface | Type for marketplace soundscape summary. |
MarketplaceSystemSummary | @aether/sdk | interface | Type for marketplace system summary. |
modToolset | @aether/sdk | function | Group a mod's tool contributions into the display shape above. |
ModToolset | @aether/sdk | interface | One mod's scene contributions as the HOST groups them for display: the tools and the one-shot actions, under the mod that supplied them. |
ModuleContext | @aether/sdk | interface | Narrow, capability-scoped context handed to a module at setup time (lifecycle only). |
ModuleDefinition | @aether/sdk | interface | Type for module definition. |
PackageDependency | @aether/sdk | type | Type for package dependency. |
packageDependencySchema | @aether/sdk | schema | One directly-required marketplace package. |
PackageKind | @aether/sdk | type | Type for package kind. |
packageKindSchema | @aether/sdk | schema | Validates whether a package is a system, module, or mod. |
PanelContribution | @aether/sdk | type | Type for panel contribution. |
panelContributionSchema | @aether/sdk | schema | Validates panel contribution data. |
PanelRenderer | @aether/sdk | type | Type for panel renderer. |
panelRendererSchema | @aether/sdk | schema | Validates panel renderer data. |
SceneLayerContribution | @aether/sdk | type | Type for scene layer contribution. |
sceneLayerContributionSchema | @aether/sdk | schema | Validates a mod contribution to the shared 3D scene. |
ScriptDef | @aether/sdk | interface | A named automation script contributed by a system. |
SDK_VERSION | @aether/sdk | constant | The SDK contract version used for package compatibility checks. |
SettingField | @aether/sdk | type | Type for setting field. |
settingFieldSchema | @aether/sdk | schema | A settings page is a bounded form, not a general view tree. |
SettingsContribution | @aether/sdk | type | Type for settings contribution. |
settingsContributionSchema | @aether/sdk | schema | Validates settings contribution data. |
SystemContribution | @aether/sdk | interface | What a system contributes when it initializes. |
SystemDefinition | @aether/sdk | interface | Type for system definition. |
ToolAction | @aether/sdk | type | Type for tool action. |
toolActionSchema | @aether/sdk | schema | A menu ITEM a mod contributes, as opposed to a mode. |
ToolContribution | @aether/sdk | type | Type for tool contribution. |
toolContributionSchema | @aether/sdk | schema | Validates a declarative toolbar or scene-control contribution. |
ToolTone | @aether/sdk | type | Type for tool tone. |
toolToneSchema | @aether/sdk | schema | What a tool means, as one of a fixed set the engine owns. |
ToolVariant | @aether/sdk | type | Type for tool variant. |
toolVariantSchema | @aether/sdk | schema | One entry in a tool's flyout - a sub-mode of the same button, the way a door is a kind of wall rather than a separate tool. |
#Scene objects
| Export | Import from | Kind | Purpose |
|---|---|---|---|
SCENE_OBJECT_LIMITS | @aether/sdk | constant | Limits for portable scene-object descriptors. |
SCENE_PRIMITIVE_LANDING_ROTATIONS | @aether/sdk | constant | Closed primitive orientation contract: each quaternion turns that face toward the host camera. |
SceneFaceMark | @aether/sdk | type | Type for scene face mark. |
sceneFaceMarkSchema | @aether/sdk | schema | Validates scene face mark data. |
sceneMeshAssetSchema | @aether/sdk | schema | Validates scene mesh asset data. |
SceneObjectAnimation | @aether/sdk | type | Type for scene object animation. |
sceneObjectAnimationSchema | @aether/sdk | schema | Validates scene object animation data. |
SceneObjectCommand | @aether/sdk | type | Type for scene object command. |
sceneObjectCommandSchema | @aether/sdk | schema | Validates scene object command data. |
SceneObjectDescriptor | @aether/sdk | type | Type for scene object descriptor. |
sceneObjectDescriptorSchema | @aether/sdk | schema | Validates scene object descriptor data. |
SceneObjectGeometry | @aether/sdk | type | Type for scene object geometry. |
sceneObjectGeometrySchema | @aether/sdk | schema | Validates scene object geometry data. |
sceneObjectKeyframeSchema | @aether/sdk | schema | Validates scene object keyframe data. |
SceneObjectLifecycleEvent | @aether/sdk | type | Type for scene object lifecycle event. |
sceneObjectLifecycleEventSchema | @aether/sdk | schema | Validates scene object lifecycle event data. |
SceneObjectMaterial | @aether/sdk | type | Type for scene object material. |
sceneObjectMaterialSchema | @aether/sdk | schema | Validates scene object material data. |
SceneObjectPatch | @aether/sdk | type | Type for scene object patch. |
sceneObjectPatchSchema | @aether/sdk | schema | Validates scene object patch data. |
SceneObjectsApi | @aether/sdk | interface | Type for scene objects api. |
SceneObjectTransform | @aether/sdk | type | Type for scene object transform. |
sceneObjectTransformSchema | @aether/sdk | schema | Validates scene object transform data. |
ScenePresentation | @aether/sdk | type | Type for scene presentation. |
scenePresentationSchema | @aether/sdk | schema | Validates scene presentation data. |
#Soundscape packs
| Export | Import from | Kind | Purpose |
|---|---|---|---|
AssetReference | @aether/sdk | interface | Type for asset reference. |
assetReferences | @aether/sdk | function | Inventory every content-addressed asset reference in system and capability data. |
buildSoundscapePack | @aether/sdk | function | Build deterministic package-local definitions and an immutable inline-audio artifact. |
BuildSoundscapePackOptions | @aether/sdk | interface | Type for build soundscape pack options. |
collectSoundscapeDefinitions | @aether/sdk | function | Follow native audio definition references and reject missing nodes, cycles, or abusive depth. |
decodeBase64 | @aether/sdk | function | Decode base64. |
packAssetIdRef | @aether/sdk | function | Pack asset id ref. |
parsePackAssetIdRef | @aether/sdk | function | Parse pack asset id ref. |
serializeSoundscapeArtifact | @aether/sdk | function | Canonical JSON for deterministic artifact bytes and immutable identity. |
sha256 | @aether/sdk | function | Sha256. |
SOUNDSCAPE_PACK_ASSET_ID_PREFIX | @aether/sdk | constant | The soundscape pack asset id prefix value. |
SOUNDSCAPE_PACK_FORMAT | @aether/sdk | constant | The soundscape pack format value. |
SOUNDSCAPE_PACK_LIMITS | @aether/sdk | constant | The soundscape pack limits value. |
SOUNDSCAPE_PACK_VERSION | @aether/sdk | constant | The soundscape pack version value. |
SoundscapeFileInput | @aether/sdk | interface | Type for soundscape file input. |
soundscapeFileSchema | @aether/sdk | schema | Validates soundscape file data. |
SoundscapePackArtifact | @aether/sdk | type | Type for soundscape pack artifact. |
soundscapePackArtifactSchema | @aether/sdk | schema | Validates soundscape pack artifact data. |
SoundscapePackManifest | @aether/sdk | type | Type for soundscape pack manifest. |
soundscapePackManifestSchema | @aether/sdk | schema | Validates soundscape pack manifest data. |
SoundscapeRights | @aether/sdk | type | Type for soundscape rights. |
soundscapeRightsSchema | @aether/sdk | schema | Validates soundscape rights data. |
validateSoundscapeArtifact | @aether/sdk | function | Validate every inline byte, graph edge, count and identity without mutating a world. |
#System definition client
| Export | Import from | Kind | Purpose |
|---|---|---|---|
connectToDefinitionHost | @aether/sdk/sandbox-definitions | function | Connect a system-owned app that consumes installed and world definitions. |
DefinitionSandboxClient | @aether/sdk/sandbox-definitions | type | A sandbox client with the opt-in additive definition resolver. |
#System definitions
| Export | Import from | Kind | Purpose |
|---|---|---|---|
buildSystemDefinitionsFile | @aether/sdk/system-definitions | function | Validate and encode the definition declarations as an artifact-hashed sidecar file. |
parseSystemDefinitions | @aether/sdk/system-definitions | function | Parse and validate a verified system artifact's definition sidecar bytes. |
SYSTEM_DEFINITIONS_PATH | @aether/sdk/system-definitions | constant | Manifest-covered sidecar for declaring mutable world definition types. |
#System Project rules
| Export | Import from | Kind | Purpose |
|---|---|---|---|
CompiledSystemProjectActionV2 | @aether/sdk/system-project | interface | Type for compiled system project action v2. |
CompiledSystemProjectDerivedValue | @aether/sdk/system-project | interface | Type for compiled system project derived value. |
CompiledSystemProjectEffect | @aether/sdk/system-project | interface | Type for compiled system project effect. |
CompiledSystemProjectGeneratorRecipe | @aether/sdk/system-project | interface | Type for compiled system project generator recipe. |
CompiledSystemProjectMacro | @aether/sdk/system-project | interface | Type for compiled system project macro. |
CompiledSystemProjectRollProcedure | @aether/sdk/system-project | interface | Type for compiled system project roll procedure. |
compileSystemProjectActionV2 | @aether/sdk/system-project | function | Compile Action source format 2 into the runtime Action format 2. |
compileSystemProjectDerivedValue | @aether/sdk/system-project | function | Compile one Derived Value into a single pure 'ActionValueV2'. |
compileSystemProjectEffect | @aether/sdk/system-project | function | Compile one reusable Effect into the typed embedded Effect descriptor. |
compileSystemProjectGeneratorRecipe | @aether/sdk/system-project | function | Compile a Generator source into the visual recipe: typed inputs, ordered calculate and source choice steps with named outputs, and at least one output map into the declared Record Type. |
compileSystemProjectMacro | @aether/sdk/system-project | function | Compile a Macro source into 'core.Macro' data pinned to the supplied immutable package coordinates. |
compileSystemProjectRollProcedure | @aether/sdk/system-project | function | Compile one Roll Procedure. |
diagnoseSystemProjectRule | @aether/sdk/system-project | function | Diagnose one Rules source against one project snapshot. |
GENERATOR_OUTPUT_FIELD_UNAVAILABLE | @aether/sdk/system-project | constant | Diagnostic text hosts can localize when a selected Catalogue no longer supplies a field. |
SYSTEM_PROJECT_ACTION_SOURCE_FORMAT_V2 | @aether/sdk/system-project | constant | The system project action source format v2 value. |
SYSTEM_PROJECT_DERIVED_VALUE_SOURCE_FORMAT | @aether/sdk/system-project | constant | System Project rules-family sources. |
SYSTEM_PROJECT_DERIVED_VALUE_SOURCE_FORMAT_V2 | @aether/sdk/system-project | constant | The system project derived value source format v2 value. |
SYSTEM_PROJECT_EFFECT_SOURCE_FORMAT | @aether/sdk/system-project | constant | The system project effect source format value. |
SYSTEM_PROJECT_GENERATOR_SOURCE_FORMAT | @aether/sdk/system-project | constant | The system project generator source format value. |
SYSTEM_PROJECT_MACRO_SOURCE_FORMAT | @aether/sdk/system-project | constant | The system project macro source format value. |
SYSTEM_PROJECT_ROLL_PROCEDURE_SOURCE_FORMAT | @aether/sdk/system-project | constant | The system project roll procedure source format value. |
SYSTEM_PROJECT_RULE_EXAMPLE_SOURCE_FORMAT | @aether/sdk/system-project | constant | The system project rule example source format value. |
SYSTEM_PROJECT_RULE_LIMITS | @aether/sdk/system-project | constant | Every rules family stays bounded in the same places: how many sources one project may hold, how many nodes, inputs, steps, bindings, outcomes and prompts one source may declare, how deep an expression or a branch may nest, and how long an ID, name, label, message or formula may be. |
SystemProjectActionOutcome | @aether/sdk/system-project | interface | Type for system project action outcome. |
systemProjectActionOutcomeSchema | @aether/sdk/system-project | schema | Validates system project action outcome data. |
SystemProjectActionResultField | @aether/sdk/system-project | interface | Type for system project action result field. |
systemProjectActionResultFieldSchema | @aether/sdk/system-project | schema | Validates system project action result field data. |
SystemProjectActionSetResultField | @aether/sdk/system-project | interface | Type for system project action set result field. |
systemProjectActionSetResultFieldSchema | @aether/sdk/system-project | schema | Validates system project action set result field data. |
SystemProjectActionSourceV2 | @aether/sdk/system-project | interface | Complete Action source format 2: typed inputs and targets, one ordered semantic sequence with branches and typed step outputs, a typed result contract with common and named-outcome fields, and Effect, owned-instance, result and Chat steps. |
systemProjectActionSourceV2Schema | @aether/sdk/system-project | schema | Validates system project action source v2 data. |
SystemProjectActionV2Node | @aether/sdk/system-project | type | One node of the Action's ordered semantic sequence. |
systemProjectActionV2NodeSchema | @aether/sdk/system-project | schema | Validates system project action v2 node data. |
SystemProjectActionV2Target | @aether/sdk/system-project | interface | Type for system project action v2 target. |
systemProjectActionV2TargetSchema | @aether/sdk/system-project | schema | Validates system project action v2 target data. |
SystemProjectDerivedValueInputType | @aether/sdk/system-project | type | One typed input of a Derived Value: a plain number or a record of one Record Type. |
systemProjectDerivedValueInputTypeSchema | @aether/sdk/system-project | schema | Validates system project derived value input type data. |
SystemProjectDerivedValueSource | @aether/sdk/system-project | interface | A Derived Value is one pure numeric program: ordered names the caller binds, ordered calculation steps that may read prior in-scope outputs, and one result. |
systemProjectDerivedValueSourceSchema | @aether/sdk/system-project | schema | Validates system project derived value source data. |
systemProjectDerivedValueSourceV1Schema | @aether/sdk/system-project | schema | Validates system project derived value source v1 data. |
systemProjectDerivedValueSourceV2Schema | @aether/sdk/system-project | schema | New operators live only in the explicitly versioned Derived Value reader. |
SystemProjectDerivedValueStep | @aether/sdk/system-project | interface | Type for system project derived value step. |
systemProjectDerivedValueStepSchema | @aether/sdk/system-project | schema | Validates system project derived value step data. |
SystemProjectEffectChange | @aether/sdk/system-project | interface | Type for system project effect change. |
systemProjectEffectChangeSchema | @aether/sdk/system-project | schema | Validates system project effect change data. |
SystemProjectEffectCopies | @aether/sdk/system-project | type | Type for system project effect copies. |
systemProjectEffectCopiesSchema | @aether/sdk/system-project | schema | Validates system project effect copies data. |
SystemProjectEffectLifecycle | @aether/sdk/system-project | interface | Type for system project effect lifecycle. |
systemProjectEffectLifecycleSchema | @aether/sdk/system-project | schema | Validates system project effect lifecycle data. |
SystemProjectEffectSource | @aether/sdk/system-project | interface | A reusable Effect: the Record Types it may affect, its readable field changes, how many copies may coexist and what a matching reapplication does, plus an optional bounded turn-anchored lifecycle. |
systemProjectEffectSourceSchema | @aether/sdk/system-project | schema | Validates system project effect source data. |
SystemProjectGeneratorSelection | @aether/sdk/system-project | interface | Type for system project generator selection. |
systemProjectGeneratorSelectionSchema | @aether/sdk/system-project | schema | Validates system project generator selection data. |
SystemProjectGeneratorSource | @aether/sdk/system-project | interface | The canonical visual Generator recipe: typed inputs collected once, ordered calculation and source-choice steps whose named outputs only later steps may read, and at least one output map into the declared Record Type. |
systemProjectGeneratorSourceSchema | @aether/sdk/system-project | schema | Validates system project generator source data. |
SystemProjectGeneratorStep | @aether/sdk/system-project | type | One step of a Generator's ordered visual recipe. |
systemProjectGeneratorStepSchema | @aether/sdk/system-project | schema | Validates system project generator step data. |
SystemProjectMacroActionStep | @aether/sdk/system-project | interface | Type for system project macro action step. |
systemProjectMacroActionStepSchema | @aether/sdk/system-project | schema | Validates system project macro action step data. |
SystemProjectMacroBinding | @aether/sdk/system-project | interface | Type for system project macro binding. |
systemProjectMacroBindingSchema | @aether/sdk/system-project | schema | Validates system project macro binding data. |
SystemProjectMacroBindingSource | @aether/sdk/system-project | type | Type for system project macro binding source. |
systemProjectMacroBindingSourceSchema | @aether/sdk/system-project | schema | Validates system project macro binding source data. |
SystemProjectMacroPrompt | @aether/sdk/system-project | interface | Type for system project macro prompt. |
systemProjectMacroPromptSchema | @aether/sdk/system-project | schema | Validates system project macro prompt data. |
SystemProjectMacroSource | @aether/sdk/system-project | interface | A Macro asks zero or more ordered typed prompts and then invokes a bounded sequence of exact project Actions. |
systemProjectMacroSourceSchema | @aether/sdk/system-project | schema | Validates system project macro source data. |
SystemProjectRollProcedureSource | @aether/sdk/system-project | interface | One canonical Aether formula plus the named values its '${name}' tokens are resolved from. |
systemProjectRollProcedureSourceSchema | @aether/sdk/system-project | schema | Validates system project roll procedure source data. |
SystemProjectRollProcedureValue | @aether/sdk/system-project | interface | Type for system project roll procedure value. |
systemProjectRollProcedureValueSchema | @aether/sdk/system-project | schema | Validates system project roll procedure value data. |
SystemProjectRuleDiagnostic | @aether/sdk/system-project | interface | Deterministic compilers from the System Project Rules family sources to the committed core runtime contracts: Action format 2, the typed embedded Effect descriptor, 'core.Macro' and the visual Generator recipe. |
SystemProjectRuleDiagnosticFamily | @aether/sdk/system-project | type | A source that does not declare enough identity to infer a Rules family reports 'unknown'. |
SystemProjectRuleExampleBinding | @aether/sdk/system-project | type | One named binding of a Rule Example. |
systemProjectRuleExampleBindingSchema | @aether/sdk/system-project | schema | Validates system project rule example binding data. |
SystemProjectRuleExampleRevision | @aether/sdk/system-project | interface | Type for system project rule example revision. |
systemProjectRuleExampleRevisionSchema | @aether/sdk/system-project | schema | Validates system project rule example revision data. |
SystemProjectRuleExampleSource | @aether/sdk/system-project | interface | A reusable, reproducible example context: which Rule it exercises and how every named input is bound to project data, with an optional Generator seed and the exact source revisions the example was authored against. |
systemProjectRuleExampleSourceSchema | @aether/sdk/system-project | schema | Validates system project rule example source data. |
SystemProjectRuleFieldBehavior | @aether/sdk/system-project | type | Type for system project rule field behavior. |
systemProjectRuleFieldBehaviorSchema | @aether/sdk/system-project | schema | The plain-language behaviors an Effect change or an Action change may use. |
SystemProjectRuleKind | @aether/sdk/system-project | type | Type for system project rule kind. |
systemProjectRuleKindSchema | @aether/sdk/system-project | schema | The six authorable families a Rule Example may bind. |
SystemProjectRuleTrace | @aether/sdk/system-project | interface | One runtime location and the project node it came from. |
SystemProjectRuleTraceKind | @aether/sdk/system-project | type | Type for system project rule trace kind. |
SystemProjectRuleTypedInput | @aether/sdk/system-project | interface | A typed input collected by an Action or a Generator. |
systemProjectRuleTypedInputSchema | @aether/sdk/system-project | schema | Validates system project rule typed input data. |
SystemProjectRuleValueOperator | @aether/sdk/system-project | type | Type for system project rule value operator. |
SystemProjectRuleValueOperatorWithRounding | @aether/sdk/system-project | type | Type for system project rule value operator with rounding. |
SystemProjectRuleValueSource | @aether/sdk/system-project | type | One value a rule can read. |
systemProjectRuleValueSourceSchema | @aether/sdk/system-project | schema | Format-1 families retain the closed operator vocabulary. |
systemProjectRuleValueSourceV2Schema | @aether/sdk/system-project | schema | Validates system project rule value source v2 data. |
SystemProjectRuleValueType | @aether/sdk/system-project | type | Type for system project rule value type. |
systemProjectRuleValueTypeSchema | @aether/sdk/system-project | schema | Validates system project rule value type data. |
#System Projects
| Export | Import from | Kind | Purpose |
|---|---|---|---|
applySystemProjectCatalogueEntryImpact | @aether/sdk/system-project | function | Resolve every current project usage and remove one Definition in one candidate snapshot. |
applySystemProjectFieldImpact | @aether/sdk/system-project | function | Resolve every current exact usage and remove its field in one candidate snapshot. |
applySystemProjectOperation | @aether/sdk/system-project | function | Apply one typed edit to an exact System Project snapshot. |
compiledCatalogueData | @aether/sdk/system-project | function | Project field IDs become the exact typed keys stored in a compiled Catalogue Definition. |
CompiledSystemProjectAction | @aether/sdk/system-project | interface | Type for compiled system project action. |
CompiledSystemProjectCatalogue | @aether/sdk/system-project | interface | Type for compiled system project catalogue. |
CompiledSystemProjectTestFixture | @aether/sdk/system-project | interface | Type for compiled system project test fixture. |
compileSystemProjectAction | @aether/sdk/system-project | function | Compile system project action. |
compileSystemProjectActions | @aether/sdk/system-project | function | Compile system project actions. |
compileSystemProjectActorSceneType | @aether/sdk/system-project | function | Generate the registered Scene type for a project with explicit Actor capability. |
compileSystemProjectActorTokenType | @aether/sdk/system-project | function | Generate the registered token type for a project with explicit Actor capability. |
compileSystemProjectCatalogue | @aether/sdk/system-project | function | Compile system project catalogue. |
compileSystemProjectCatalogues | @aether/sdk/system-project | function | Compile system project catalogues. |
compileSystemProjectNativeView | @aether/sdk/system-project | function | Compiles semantic source to the existing inert artifact. |
compileSystemProjectNativeViewV2 | @aether/sdk/system-project | function | Studio and package compilation share one inert V2 artifact. |
compileSystemProjectOwnedFields | @aether/sdk/system-project | function | Export exact Owned Instances bindings for authoritative Add controls in Play. |
compileSystemProjectRecordType | @aether/sdk/system-project | function | Compile one Studio Record Type through the hosted portable schema vocabulary. |
compileSystemProjectTestFixture | @aether/sdk/system-project | function | Compile system project test fixture. |
createSystemProjectNativeViewSource | @aether/sdk/system-project | function | Creates the first editable tree without changing the Record Type it binds. |
createSystemProjectPreviewDocument | @aether/sdk/system-project | function | Create system project preview document. |
createSystemProjectSnapshot | @aether/sdk/system-project | function | Create a validated editable System Project snapshot. |
diagnoseSystemProjectAction | @aether/sdk/system-project | function | Diagnose system project action. |
diagnoseSystemProjectCatalogue | @aether/sdk/system-project | function | Diagnose system project catalogue. |
diagnoseSystemProjectNativeView | @aether/sdk/system-project | function | Diagnose system project native view. |
diagnoseSystemProjectNativeViewV2 | @aether/sdk/system-project | function | Missing bindings are valid Studio drafts, but never count as publish-ready. |
diagnoseSystemProjectRecordTypeDefaults | @aether/sdk/system-project | function | Diagnose authored starting values without rewriting older saved source. |
diagnoseSystemProjectTestScenario | @aether/sdk/system-project | function | Diagnose system project test scenario. |
generateSystemProjectNativeView | @aether/sdk/system-project | function | Generate the Aether-native fallback sheet for a Studio Record Type. |
hashSystemProjectSourceForArtifact | @aether/sdk/system-project | function | Frozen artifact source hashes retain their own normalizer epoch, never today's store envelope. |
indexSystemProjectCatalogueEntryUsages | @aether/sdk/system-project | function | Exact project-source usages of one Catalogue Definition. |
indexSystemProjectOwnedInstances | @aether/sdk/system-project | function | List every stored owned record a project declares, with its parent, path and instance ID. |
indexSystemProjectUsages | @aether/sdk/system-project | function | Exact, stable project-source usages for Data impact and diagnostics. |
normalizeSystemProjectTestSeed | @aether/sdk/system-project | function | Normalize system project test seed. |
resolveProjectText | @aether/sdk/system-project | function | Resolve project text. |
resolveSystemProjectText | @aether/sdk/system-project | function | Resolve every '{t("key")}' token in 'text' for 'locale', falling back to the project's default locale. |
SYSTEM_PROJECT_ACTION_SOURCE_FORMAT | @aether/sdk/system-project | constant | The system project action source format value. |
SYSTEM_PROJECT_CATALOGUE_LIMITS | @aether/sdk/system-project | constant | The system project catalogue limits value. |
SYSTEM_PROJECT_CATALOGUE_SOURCE_FORMAT | @aether/sdk/system-project | constant | The system project catalogue source format value. |
SYSTEM_PROJECT_CATALOGUE_SOURCE_FORMAT_V2 | @aether/sdk/system-project | constant | The system project catalogue source format v2 value. |
SYSTEM_PROJECT_FORMAT | @aether/sdk/system-project | constant | The current editable System Project source-format identifier. |
SYSTEM_PROJECT_LEGACY_FORMAT | @aether/sdk/system-project | constant | The system project legacy format value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V10 | @aether/sdk/system-project | constant | The system project legacy format v10 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V11 | @aether/sdk/system-project | constant | The system project legacy format v11 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V12 | @aether/sdk/system-project | constant | The system project legacy format v12 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V2 | @aether/sdk/system-project | constant | The system project legacy format v2 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V3 | @aether/sdk/system-project | constant | The system project legacy format v3 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V4 | @aether/sdk/system-project | constant | The system project legacy format v4 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V5 | @aether/sdk/system-project | constant | The system project legacy format v5 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V6 | @aether/sdk/system-project | constant | The system project legacy format v6 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V7 | @aether/sdk/system-project | constant | The system project legacy format v7 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V8 | @aether/sdk/system-project | constant | The system project legacy format v8 value. |
SYSTEM_PROJECT_LEGACY_FORMAT_V9 | @aether/sdk/system-project | constant | The system project legacy format v9 value. |
SYSTEM_PROJECT_NATIVE_VIEW_SOURCE_FORMAT | @aether/sdk/system-project | constant | The system project native view source format value. |
SYSTEM_PROJECT_RELEASE_LIMITS | @aether/sdk/system-project | constant | The system project release limits value. |
SYSTEM_PROJECT_RELEASE_SOURCE_FORMAT | @aether/sdk/system-project | constant | Release source is inert, bounded project data. |
SYSTEM_PROJECT_TEST_LIMITS | @aether/sdk/system-project | constant | The system project test limits value. |
SYSTEM_PROJECT_TEST_SCENARIO_SOURCE_FORMAT | @aether/sdk/system-project | constant | The system project test scenario source format value. |
SYSTEM_PROJECT_TRANSLATION_LIMITS | @aether/sdk/system-project | constant | Bounded limits for a project's catalog. |
SystemProjectActionDiagnostic | @aether/sdk/system-project | interface | Type for system project action diagnostic. |
SystemProjectActionExpression | @aether/sdk/system-project | type | Type for system project action expression. |
systemProjectActionExpressionSchema | @aether/sdk/system-project | schema | Validates system project action expression data. |
SystemProjectActionRefusal | @aether/sdk/system-project | type | A refusal reason is either inline prose (optionally carrying '{t("…")}' tokens) or a legacy per-locale record. |
SystemProjectActionRequirement | @aether/sdk/system-project | interface | Type for system project action requirement. |
systemProjectActionRequirementSchema | @aether/sdk/system-project | schema | Validates system project action requirement data. |
SystemProjectActionResultRow | @aether/sdk/system-project | interface | Type for system project action result row. |
SystemProjectActionSource | @aether/sdk/system-project | interface | Type for system project action source. |
systemProjectActionSourceSchema | @aether/sdk/system-project | schema | Validates system project action source data. |
SystemProjectActionStep | @aether/sdk/system-project | type | Type for system project action step. |
systemProjectActionStepSchema | @aether/sdk/system-project | schema | Validates system project action step data. |
SystemProjectActionTrace | @aether/sdk/system-project | interface | Type for system project action trace. |
systemProjectActorSchema | @aether/sdk/system-project | schema | Explicit engine capability, independent of a Record Type's name or creation starter. |
SystemProjectAnyActionSource | @aether/sdk/system-project | type | Type for system project any action source. |
systemProjectAnyActionSourceSchema | @aether/sdk/system-project | schema | Validates system project any action source data. |
SystemProjectAnyNativeViewSource | @aether/sdk/system-project | type | A project reads old Sheets unchanged and accepts new profile-aware Sheets. |
systemProjectAnyNativeViewSourceSchema | @aether/sdk/system-project | schema | Validates system project any native view source data. |
SystemProjectAtomicOperation | @aether/sdk/system-project | type | Type for system project atomic operation. |
systemProjectAtomicOperationSchemas | @aether/sdk/system-project | function | Each atomic operation's schema, keyed by its 'kind', in declaration order. |
SystemProjectCatalogueCollection | @aether/sdk/system-project | type | Type for system project catalogue collection. |
systemProjectCatalogueCollectionSchema | @aether/sdk/system-project | schema | Validates system project catalogue collection data. |
SystemProjectCatalogueDiagnostic | @aether/sdk/system-project | interface | Type for system project catalogue diagnostic. |
SystemProjectCatalogueEntry | @aether/sdk/system-project | type | Type for system project catalogue entry. |
SystemProjectCatalogueEntryImpactResolution | @aether/sdk/system-project | type | Type for system project catalogue entry impact resolution. |
systemProjectCatalogueEntryImpactResolutionSchema | @aether/sdk/system-project | schema | Validates system project catalogue entry impact resolution data. |
systemProjectCatalogueEntrySchema | @aether/sdk/system-project | schema | Validates system project catalogue entry data. |
SystemProjectCatalogueEntryV1 | @aether/sdk/system-project | type | Type for system project catalogue entry v1. |
systemProjectCatalogueEntryV1Schema | @aether/sdk/system-project | schema | Validates system project catalogue entry v1 data. |
SystemProjectCatalogueEntryV2 | @aether/sdk/system-project | type | Type for system project catalogue entry v2. |
systemProjectCatalogueEntryV2Schema | @aether/sdk/system-project | schema | Validates system project catalogue entry v2 data. |
SystemProjectCatalogueImportWarning | @aether/sdk/system-project | type | Type for system project catalogue import warning. |
systemProjectCatalogueImportWarningSchema | @aether/sdk/system-project | schema | Validates system project catalogue import warning data. |
SystemProjectCatalogueProvenance | @aether/sdk/system-project | type | Type for system project catalogue provenance. |
systemProjectCatalogueProvenanceSchema | @aether/sdk/system-project | schema | Validates system project catalogue provenance data. |
SystemProjectCatalogueSource | @aether/sdk/system-project | type | Type for system project catalogue source. |
systemProjectCatalogueSourceSchema | @aether/sdk/system-project | schema | Validates system project catalogue source data. |
SystemProjectCatalogueSourceV1 | @aether/sdk/system-project | type | Type for system project catalogue source v1. |
systemProjectCatalogueSourceV1Schema | @aether/sdk/system-project | schema | Validates system project catalogue source v1 data. |
SystemProjectCatalogueSourceV2 | @aether/sdk/system-project | type | Type for system project catalogue source v2. |
systemProjectCatalogueSourceV2Schema | @aether/sdk/system-project | schema | Validates system project catalogue source v2 data. |
SystemProjectDefaultIssue | @aether/sdk/system-project | type | Type for system project default issue. |
SystemProjectDictionaryKeys | @aether/sdk/system-project | type | Type for system project dictionary keys. |
systemProjectDictionaryKeysSchema | @aether/sdk/system-project | schema | Exact Dictionary identities survive even while no locale has authored a message. |
SystemProjectEnum | @aether/sdk/system-project | type | Type for system project enum. |
systemProjectEnumSchema | @aether/sdk/system-project | schema | Validates system project enum data. |
SystemProjectField | @aether/sdk/system-project | type | Type for system project field. |
SystemProjectFieldImpactResolution | @aether/sdk/system-project | type | Type for system project field impact resolution. |
systemProjectFieldImpactResolutionSchema | @aether/sdk/system-project | schema | Validates system project field impact resolution data. |
systemProjectFieldSchema | @aether/sdk/system-project | schema | Validates system project field data. |
SystemProjectFieldVisibility | @aether/sdk/system-project | type | Type for system project field visibility. |
systemProjectFieldVisibilitySchema | @aether/sdk/system-project | schema | Validates system project field visibility data. |
systemProjectLegacyTestActionCaseSchema | @aether/sdk/system-project | schema | Validates system project legacy test action case data. |
SystemProjectListItem | @aether/sdk/system-project | type | Type for system project list item. |
systemProjectListItemSchema | @aether/sdk/system-project | schema | Validates system project list item data. |
SystemProjectMigrationEdge | @aether/sdk/system-project | type | Type for system project migration edge. |
systemProjectMigrationEdgeSchema | @aether/sdk/system-project | schema | Validates system project migration edge data. |
SystemProjectMigrationFixture | @aether/sdk/system-project | type | Type for system project migration fixture. |
systemProjectMigrationFixtureSchema | @aether/sdk/system-project | schema | Validates system project migration fixture data. |
SystemProjectMigrationStep | @aether/sdk/system-project | type | Type for system project migration step. |
systemProjectMigrationStepSchema | @aether/sdk/system-project | schema | IDs refer to the source and destination Project Revisions, not rendered labels. |
SystemProjectNativeViewDiagnostic | @aether/sdk/system-project | interface | Type for system project native view diagnostic. |
SystemProjectNativeViewNode | @aether/sdk/system-project | type | Type for system project native view node. |
systemProjectNativeViewNodeSchema | @aether/sdk/system-project | schema | Validates system project native view node data. |
SystemProjectNativeViewSource | @aether/sdk/system-project | interface | Type for system project native view source. |
systemProjectNativeViewSourceSchema | @aether/sdk/system-project | schema | Validates system project native view source data. |
SystemProjectNativeViewV2Diagnostic | @aether/sdk/system-project | interface | Type for system project native view v2 diagnostic. |
SystemProjectOperation | @aether/sdk/system-project | type | Type for system project operation. |
systemProjectOperationSchema | @aether/sdk/system-project | schema | Validates system project operation data. |
SystemProjectOwnedInstance | @aether/sdk/system-project | interface | Runtime child state belongs to its parent document, not to a second World document. |
SystemProjectOwnedInstanceUsage | @aether/sdk/system-project | interface | One stored owned record, its parent location, and its exact definition reference and values. |
SystemProjectPreviewAudience | @aether/sdk/system-project | type | Type for system project preview audience. |
SystemProjectRecordType | @aether/sdk/system-project | type | Type for system project record type. |
systemProjectRecordTypeSchema | @aether/sdk/system-project | schema | Validates system project record type data. |
SystemProjectReleasePlan | @aether/sdk/system-project | type | Type for system project release plan. |
systemProjectReleasePlanSchema | @aether/sdk/system-project | schema | Validates system project release plan data. |
SystemProjectReleaseSourceArtifact | @aether/sdk/system-project | type | Type for system project release source artifact. |
systemProjectReleaseSourceArtifactSchema | @aether/sdk/system-project | schema | Validates system project release source artifact data. |
SystemProjectSnapshot | @aether/sdk/system-project | type | Type for system project snapshot. |
systemProjectSnapshotSchema | @aether/sdk/system-project | schema | Older projects normalize in memory and persist as format 11 on their next accepted exact-base operation. |
SystemProjectTestActionCase | @aether/sdk/system-project | type | Type for system project test action case. |
systemProjectTestActionCaseSchema | @aether/sdk/system-project | schema | Validates system project test action case data. |
SystemProjectTestActionCaseV2 | @aether/sdk/system-project | type | Type for system project test action case v2. |
systemProjectTestActionCaseV2Schema | @aether/sdk/system-project | schema | Validates system project test action case v2 data. |
systemProjectTestActionInputSchema | @aether/sdk/system-project | schema | exact invocation inputs for saved current-Action cases. |
SystemProjectTestAssertion | @aether/sdk/system-project | type | Type for system project test assertion. |
systemProjectTestAssertionSchema | @aether/sdk/system-project | schema | Validates system project test assertion data. |
SystemProjectTestCase | @aether/sdk/system-project | type | Type for system project test case. |
systemProjectTestCaseSchema | @aether/sdk/system-project | schema | Validates system project test case data. |
SystemProjectTestCreationCase | @aether/sdk/system-project | type | Type for system project test creation case. |
systemProjectTestCreationCaseSchema | @aether/sdk/system-project | schema | one exact Creation flow exercised without a World write. |
SystemProjectTestDefinitionCase | @aether/sdk/system-project | type | Type for system project test definition case. |
systemProjectTestDefinitionCaseSchema | @aether/sdk/system-project | schema | Validates system project test definition case data. |
SystemProjectTestDefinitionExpectation | @aether/sdk/system-project | type | Type for system project test definition expectation. |
systemProjectTestDefinitionExpectationSchema | @aether/sdk/system-project | schema | Validates system project test definition expectation data. |
SystemProjectTestDiagnostic | @aether/sdk/system-project | interface | Type for system project test diagnostic. |
SystemProjectTestFixture | @aether/sdk/system-project | type | Type for system project test fixture. |
SystemProjectTestFixtureOverride | @aether/sdk/system-project | type | Type for system project test fixture override. |
systemProjectTestFixtureOverrideSchema | @aether/sdk/system-project | schema | Validates system project test fixture override data. |
systemProjectTestFixtureSchema | @aether/sdk/system-project | schema | Validates system project test fixture data. |
SystemProjectTestScenarioSource | @aether/sdk/system-project | type | Type for system project test scenario source. |
systemProjectTestScenarioSourceSchema | @aether/sdk/system-project | schema | Validates system project test scenario source data. |
SystemProjectTextContext | @aether/sdk/system-project | interface | The optional project text context for a compiled surface. |
systemProjectTranslationKeySchema | @aether/sdk/system-project | schema | Validates system project translation key data. |
SystemProjectTranslations | @aether/sdk/system-project | type | Type for system project translations. |
systemProjectTranslationsSchema | @aether/sdk/system-project | schema | One catalog per declared locale, keyed by the exact payload of a '{t("…")}' token. |
SystemProjectUsage | @aether/sdk/system-project | interface | Type for system project usage. |
SystemProjectUsageActivity | @aether/sdk/system-project | type | Type for system project usage activity. |
upgradeSystemProjectCatalogueSource | @aether/sdk/system-project | function | First structural edit upgrades a legacy Catalogue without changing compiled identity or values. |
Was this page helpful?