Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

feat(api): the asset API was not in the governed surface at all

esengine1ffb17e23e10
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index 419929364..5656dde1e 100644
--- a/sdk/etc/index.api.md
+++ b/sdk/etc/index.api.md
@@ -420,7 +420,11 @@ enabled: boolean
## AnimatorEdge — type @experimental
```
-GraphEdge<AnimatorTransition>
+from: string
+id: string
+index: number
+to: string
+transition: AnimatorTransition
```
## AnimatorEvalResult — interface @experimental
@@ -686,7 +690,78 @@ ResourceDef<AssetsClass>
## AssetsData — type @experimental
```
-AssetsClass
+@internal releaseTyped: (type: string, ref: string) => void
+@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
+backend: Backend
+baseUrl: string | undefined
+catalog: Catalog
+checkForUpdate: (options: CheckForUpdateOptions) => Promise<UpdatePlan>
+fetchBinary: (ref: string) => Promise<ArrayBuffer>
+fetchJson: <T = unknown>(ref: string) => Promise<T>
+fetchText: (ref: string) => Promise<string>
+getAssetRefResolver: () => AssetRefResolver | null
+getAssetRegistry: () => AssetRegistry | null
+getAtlasFrame: (ref: string) => AtlasFrameInfo | null
+getLoader: <T>(type: string) => AssetLoader<T> | undefined
+getManifest: () => ManifestModel | null
+getRefCounter: () => AssetRefCounter | null
+getSpineLoader: () => SpineAssetLoader
+getTexture: (ref: string) => TextureResult | undefined
+getTextureLoader: () => TextureLoader
+invalidate: (ref: string) => boolean
+load: <T>(type: string, ref: string) => Promise<T>
+loadAnimClip: (ref: string) => Promise<AnimClipResult>
+loadAnimatorController: (ref: string) => Promise<AnimatorControllerResult>
+loadAudio: (ref: string) => Promise<AudioResult>
+loadBehaviorTree: (ref: string) => Promise<BtResult>
+loadByLabel: (label: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadFont: (ref: string) => Promise<FontResult>
+loadGroup: (groupName: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadJson: <T = unknown>(ref: string) => Promise<JsonResult<T>>
+loadLocaleTable: (ref: string) => Promise<LocaleResult>
+loadMaterial: (ref: string) => Promise<MaterialResult>
+loadPrefab: (ref: string) => Promise<PrefabResult>
+loadSpine: (skeletonRef: string, atlasRef?: string) => Promise<SpineResult>
+loadStateMachine: (ref: string) => Promise<FsmResult>
+loadTexture: (ref: string) => Promise<TextureResult>
+loadTextureRaw: (ref: string) => Promise<TextureResult>
+loadTilemap: (ref: string) => Promise<TilemapResult>
+loadTileset: (ref: string) => Promise<TilesetResult>
+loadTimeline: (ref: string) => Promise<TimelineResult>
+onInvalidate: (listener: InvalidateListener) => () => void
+pathForHandle: (kind: string, handle: number) => string | null
+preload: (refs: ReadonlyArray<string>, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; }) => Promise<{ failed: MissingAsset[]; }>
+preloadSceneAssets: (sceneData: SceneData, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; readonly skipSpine?: boolean; }) => Promise<SceneAssetResult>
+recoverFromDeviceLoss: () => Promise<boolean>
+register: <T>(loader: AssetLoader<T>) => void
+releaseAll: () => void
+releaseAnimClip: (ref: string) => void
+releaseAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
+releaseAudio: (ref: string) => void
+releaseFont: (ref: string) => void
+releaseGroup: (groupName: string) => void
+releaseMaterial: (handle: number) => void
+releasePrefab: (ref: string) => void
+releaseTexture: (ref: string) => void
+releaseTilemap: (ref: string) => void
+releaseTimeline: (ref: string) => void
+remoteRoot: string | undefined
+resolveLoadPath: (ref: string) => string
+resolveRef: (ref: string) => string | null
+resolveSceneAssetPaths: (sceneData: SceneData, result: SceneAssetResult) => void
+restorePersistedUpdate: (key: string) => boolean
+reuploadTexturesAfterDeviceLoss: () => Promise<number>
+setAssetRefResolver: (resolver: AssetRefResolver) => void
+setAssetRegistry: (registry: AssetRegistry) => void
+setManifest: (manifest: AddressableManifest | ManifestModel | null) => void
+setRefCounter: (counter: AssetRefCounter) => void
+setRemoteRoot: (url: string | undefined) => void
+setSpineController: (controller: SpineModuleController) => void
+setTextureImportSettingsResolver: (resolver: TextureImportSettingsResolver | null) => void
+static create: (options: AssetsOptions) => AssetsClass
+static new (options: AssetsOptions): AssetsClass
+static prototype: AssetsClass
```
## AsyncCache — class @experimental
@@ -2879,7 +2954,11 @@ states: FsmState[]
## FsmEdge — type @experimental
```
-GraphEdge<FsmTransition>
+from: string
+id: string
+index: number
+to: string
+transition: FsmTransition
```
## FsmPlugin — class @experimental
@@ -4510,7 +4589,10 @@ code: number | undefined
## PaymentRequest — type @experimental
```
-PlatformPaymentRequest
+offerId: string
+quantity: number
+sandbox: boolean | undefined
+zoneId: string | undefined
```
## Perceiver — const @experimental
@@ -6261,7 +6343,9 @@ static prototype: ShareAPI
## ShareCard — type @experimental
```
-PlatformShareOptions
+imageUrl: string | undefined
+query: string | undefined
+title: string | undefined
```
## SideModuleDescriptor — interface @experimental
diff --git a/sdk/etc/index.native.api.md b/sdk/etc/index.native.api.md
index c796e1abb..354736e1d 100644
--- a/sdk/etc/index.native.api.md
+++ b/sdk/etc/index.native.api.md
@@ -420,7 +420,11 @@ enabled: boolean
## AnimatorEdge — type @experimental
```
-GraphEdge<AnimatorTransition>
+from: string
+id: string
+index: number
+to: string
+transition: AnimatorTransition
```
## AnimatorEvalResult — interface @experimental
@@ -686,7 +690,78 @@ ResourceDef<AssetsClass>
## AssetsData — type @experimental
```
-AssetsClass
+@internal releaseTyped: (type: string, ref: string) => void
+@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
+backend: Backend
+baseUrl: string | undefined
+catalog: Catalog
+checkForUpdate: (options: CheckForUpdateOptions) => Promise<UpdatePlan>
+fetchBinary: (ref: string) => Promise<ArrayBuffer>
+fetchJson: <T = unknown>(ref: string) => Promise<T>
+fetchText: (ref: string) => Promise<string>
+getAssetRefResolver: () => AssetRefResolver | null
+getAssetRegistry: () => AssetRegistry | null
+getAtlasFrame: (ref: string) => AtlasFrameInfo | null
+getLoader: <T>(type: string) => AssetLoader<T> | undefined
+getManifest: () => ManifestModel | null
+getRefCounter: () => AssetRefCounter | null
+getSpineLoader: () => SpineAssetLoader
+getTexture: (ref: string) => TextureResult | undefined
+getTextureLoader: () => TextureLoader
+invalidate: (ref: string) => boolean
+load: <T>(type: string, ref: string) => Promise<T>
+loadAnimClip: (ref: string) => Promise<AnimClipResult>
+loadAnimatorController: (ref: string) => Promise<AnimatorControllerResult>
+loadAudio: (ref: string) => Promise<AudioResult>
+loadBehaviorTree: (ref: string) => Promise<BtResult>
+loadByLabel: (label: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadFont: (ref: string) => Promise<FontResult>
+loadGroup: (groupName: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadJson: <T = unknown>(ref: string) => Promise<JsonResult<T>>
+loadLocaleTable: (ref: string) => Promise<LocaleResult>
+loadMaterial: (ref: string) => Promise<MaterialResult>
+loadPrefab: (ref: string) => Promise<PrefabResult>
+loadSpine: (skeletonRef: string, atlasRef?: string) => Promise<SpineResult>
+loadStateMachine: (ref: string) => Promise<FsmResult>
+loadTexture: (ref: string) => Promise<TextureResult>
+loadTextureRaw: (ref: string) => Promise<TextureResult>
+loadTilemap: (ref: string) => Promise<TilemapResult>
+loadTileset: (ref: string) => Promise<TilesetResult>
+loadTimeline: (ref: string) => Promise<TimelineResult>
+onInvalidate: (listener: InvalidateListener) => () => void
+pathForHandle: (kind: string, handle: number) => string | null
+preload: (refs: ReadonlyArray<string>, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; }) => Promise<{ failed: MissingAsset[]; }>
+preloadSceneAssets: (sceneData: SceneData, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; readonly skipSpine?: boolean; }) => Promise<SceneAssetResult>
+recoverFromDeviceLoss: () => Promise<boolean>
+register: <T>(loader: AssetLoader<T>) => void
+releaseAll: () => void
+releaseAnimClip: (ref: string) => void
+releaseAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
+releaseAudio: (ref: string) => void
+releaseFont: (ref: string) => void
+releaseGroup: (groupName: string) => void
+releaseMaterial: (handle: number) => void
+releasePrefab: (ref: string) => void
+releaseTexture: (ref: string) => void
+releaseTilemap: (ref: string) => void
+releaseTimeline: (ref: string) => void
+remoteRoot: string | undefined
+resolveLoadPath: (ref: string) => string
+resolveRef: (ref: string) => string | null
+resolveSceneAssetPaths: (sceneData: SceneData, result: SceneAssetResult) => void
+restorePersistedUpdate: (key: string) => boolean
+reuploadTexturesAfterDeviceLoss: () => Promise<number>
+setAssetRefResolver: (resolver: AssetRefResolver) => void
+setAssetRegistry: (registry: AssetRegistry) => void
+setManifest: (manifest: AddressableManifest | ManifestModel | null) => void
+setRefCounter: (counter: AssetRefCounter) => void
+setRemoteRoot: (url: string | undefined) => void
+setSpineController: (controller: SpineModuleController) => void
+setTextureImportSettingsResolver: (resolver: TextureImportSettingsResolver | null) => void
+static create: (options: AssetsOptions) => AssetsClass
+static new (options: AssetsOptions): AssetsClass
+static prototype: AssetsClass
```
## AsyncCache — class @experimental
@@ -2887,7 +2962,11 @@ states: FsmState[]
## FsmEdge — type @experimental
```
-GraphEdge<FsmTransition>
+from: string
+id: string
+index: number
+to: string
+transition: FsmTransition
```
## FsmPlugin — class @experimental
@@ -4693,7 +4772,10 @@ code: number | undefined
## PaymentRequest — type @experimental
```
-PlatformPaymentRequest
+offerId: string
+quantity: number
+sandbox: boolean | undefined
+zoneId: string | undefined
```
## Perceiver — const @experimental
@@ -6454,7 +6536,9 @@ static prototype: ShareAPI
## ShareCard — type @experimental
```
-PlatformShareOptions
+imageUrl: string | undefined
+query: string | undefined
+title: string | undefined
```
## SideModuleDescriptor — interface @experimental
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index 70abc87a2..a051dd06b 100644
--- a/sdk/etc/index.node.api.md
+++ b/sdk/etc/index.node.api.md
@@ -415,7 +415,11 @@ enabled: boolean
## AnimatorEdge — type @experimental
```
-GraphEdge<AnimatorTransition>
+from: string
+id: string
+index: number
+to: string
+transition: AnimatorTransition
```
## AnimatorEvalResult — interface @experimental
@@ -681,7 +685,78 @@ ResourceDef<AssetsClass>
## AssetsData — type @experimental
```
-AssetsClass
+@internal releaseTyped: (type: string, ref: string) => void
+@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
+backend: Backend
+baseUrl: string | undefined
+catalog: Catalog
+checkForUpdate: (options: CheckForUpdateOptions) => Promise<UpdatePlan>
+fetchBinary: (ref: string) => Promise<ArrayBuffer>
+fetchJson: <T = unknown>(ref: string) => Promise<T>
+fetchText: (ref: string) => Promise<string>
+getAssetRefResolver: () => AssetRefResolver | null
+getAssetRegistry: () => AssetRegistry | null
+getAtlasFrame: (ref: string) => AtlasFrameInfo | null
+getLoader: <T>(type: string) => AssetLoader<T> | undefined
+getManifest: () => ManifestModel | null
+getRefCounter: () => AssetRefCounter | null
+getSpineLoader: () => SpineAssetLoader
+getTexture: (ref: string) => TextureResult | undefined
+getTextureLoader: () => TextureLoader
+invalidate: (ref: string) => boolean
+load: <T>(type: string, ref: string) => Promise<T>
+loadAnimClip: (ref: string) => Promise<AnimClipResult>
+loadAnimatorController: (ref: string) => Promise<AnimatorControllerResult>
+loadAudio: (ref: string) => Promise<AudioResult>
+loadBehaviorTree: (ref: string) => Promise<BtResult>
+loadByLabel: (label: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadFont: (ref: string) => Promise<FontResult>
+loadGroup: (groupName: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadJson: <T = unknown>(ref: string) => Promise<JsonResult<T>>
+loadLocaleTable: (ref: string) => Promise<LocaleResult>
+loadMaterial: (ref: string) => Promise<MaterialResult>
+loadPrefab: (ref: string) => Promise<PrefabResult>
+loadSpine: (skeletonRef: string, atlasRef?: string) => Promise<SpineResult>
+loadStateMachine: (ref: string) => Promise<FsmResult>
+loadTexture: (ref: string) => Promise<TextureResult>
+loadTextureRaw: (ref: string) => Promise<TextureResult>
+loadTilemap: (ref: string) => Promise<TilemapResult>
+loadTileset: (ref: string) => Promise<TilesetResult>
+loadTimeline: (ref: string) => Promise<TimelineResult>
+onInvalidate: (listener: InvalidateListener) => () => void
+pathForHandle: (kind: string, handle: number) => string | null
+preload: (refs: ReadonlyArray<string>, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; }) => Promise<{ failed: MissingAsset[]; }>
+preloadSceneAssets: (sceneData: SceneData, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; readonly skipSpine?: boolean; }) => Promise<SceneAssetResult>
+recoverFromDeviceLoss: () => Promise<boolean>
+register: <T>(loader: AssetLoader<T>) => void
+releaseAll: () => void
+releaseAnimClip: (ref: string) => void
+releaseAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
+releaseAudio: (ref: string) => void
+releaseFont: (ref: string) => void
+releaseGroup: (groupName: string) => void
+releaseMaterial: (handle: number) => void
+releasePrefab: (ref: string) => void
+releaseTexture: (ref: string) => void
+releaseTilemap: (ref: string) => void
+releaseTimeline: (ref: string) => void
+remoteRoot: string | undefined
+resolveLoadPath: (ref: string) => string
+resolveRef: (ref: string) => string | null
+resolveSceneAssetPaths: (sceneData: SceneData, result: SceneAssetResult) => void
+restorePersistedUpdate: (key: string) => boolean
+reuploadTexturesAfterDeviceLoss: () => Promise<number>
+setAssetRefResolver: (resolver: AssetRefResolver) => void
+setAssetRegistry: (registry: AssetRegistry) => void
+setManifest: (manifest: AddressableManifest | ManifestModel | null) => void
+setRefCounter: (counter: AssetRefCounter) => void
+setRemoteRoot: (url: string | undefined) => void
+setSpineController: (controller: SpineModuleController) => void
+setTextureImportSettingsResolver: (resolver: TextureImportSettingsResolver | null) => void
+static create: (options: AssetsOptions) => AssetsClass
+static new (options: AssetsOptions): AssetsClass
+static prototype: AssetsClass
```
## AsyncCache — class @experimental
@@ -2874,7 +2949,11 @@ states: FsmState[]
## FsmEdge — type @experimental
```
-GraphEdge<FsmTransition>
+from: string
+id: string
+index: number
+to: string
+transition: FsmTransition
```
## FsmPlugin — class @experimental
@@ -4505,7 +4584,10 @@ code: number | undefined
## PaymentRequest — type @experimental
```
-PlatformPaymentRequest
+offerId: string
+quantity: number
+sandbox: boolean | undefined
+zoneId: string | undefined
```
## Perceiver — const @experimental
@@ -6256,7 +6338,9 @@ static prototype: ShareAPI
## ShareCard — type @experimental
```
-PlatformShareOptions
+imageUrl: string | undefined
+query: string | undefined
+title: string | undefined
```
## SideModuleDescriptor — interface @experimental
diff --git a/sdk/etc/minigame.api.md b/sdk/etc/minigame.api.md
index 628f635f9..d1e6b676b 100644
--- a/sdk/etc/minigame.api.md
+++ b/sdk/etc/minigame.api.md
@@ -415,7 +415,11 @@ enabled: boolean
## AnimatorEdge — type @experimental
```
-GraphEdge<AnimatorTransition>
+from: string
+id: string
+index: number
+to: string
+transition: AnimatorTransition
```
## AnimatorEvalResult — interface @experimental
@@ -681,7 +685,78 @@ ResourceDef<AssetsClass>
## AssetsData — type @experimental
```
-AssetsClass
+@internal releaseTyped: (type: string, ref: string) => void
+@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
+backend: Backend
+baseUrl: string | undefined
+catalog: Catalog
+checkForUpdate: (options: CheckForUpdateOptions) => Promise<UpdatePlan>
+fetchBinary: (ref: string) => Promise<ArrayBuffer>
+fetchJson: <T = unknown>(ref: string) => Promise<T>
+fetchText: (ref: string) => Promise<string>
+getAssetRefResolver: () => AssetRefResolver | null
+getAssetRegistry: () => AssetRegistry | null
+getAtlasFrame: (ref: string) => AtlasFrameInfo | null
+getLoader: <T>(type: string) => AssetLoader<T> | undefined
+getManifest: () => ManifestModel | null
+getRefCounter: () => AssetRefCounter | null
+getSpineLoader: () => SpineAssetLoader
+getTexture: (ref: string) => TextureResult | undefined
+getTextureLoader: () => TextureLoader
+invalidate: (ref: string) => boolean
+load: <T>(type: string, ref: string) => Promise<T>
+loadAnimClip: (ref: string) => Promise<AnimClipResult>
+loadAnimatorController: (ref: string) => Promise<AnimatorControllerResult>
+loadAudio: (ref: string) => Promise<AudioResult>
+loadBehaviorTree: (ref: string) => Promise<BtResult>
+loadByLabel: (label: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadFont: (ref: string) => Promise<FontResult>
+loadGroup: (groupName: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadJson: <T = unknown>(ref: string) => Promise<JsonResult<T>>
+loadLocaleTable: (ref: string) => Promise<LocaleResult>
+loadMaterial: (ref: string) => Promise<MaterialResult>
+loadPrefab: (ref: string) => Promise<PrefabResult>
+loadSpine: (skeletonRef: string, atlasRef?: string) => Promise<SpineResult>
+loadStateMachine: (ref: string) => Promise<FsmResult>
+loadTexture: (ref: string) => Promise<TextureResult>
+loadTextureRaw: (ref: string) => Promise<TextureResult>
+loadTilemap: (ref: string) => Promise<TilemapResult>
+loadTileset: (ref: string) => Promise<TilesetResult>
+loadTimeline: (ref: string) => Promise<TimelineResult>
+onInvalidate: (listener: InvalidateListener) => () => void
+pathForHandle: (kind: string, handle: number) => string | null
+preload: (refs: ReadonlyArray<string>, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; }) => Promise<{ failed: MissingAsset[]; }>
+preloadSceneAssets: (sceneData: SceneData, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; readonly skipSpine?: boolean; }) => Promise<SceneAssetResult>
+recoverFromDeviceLoss: () => Promise<boolean>
+register: <T>(loader: AssetLoader<T>) => void
+releaseAll: () => void
+releaseAnimClip: (ref: string) => void
+releaseAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
+releaseAudio: (ref: string) => void
+releaseFont: (ref: string) => void
+releaseGroup: (groupName: string) => void
+releaseMaterial: (handle: number) => void
+releasePrefab: (ref: string) => void
+releaseTexture: (ref: string) => void
+releaseTilemap: (ref: string) => void
+releaseTimeline: (ref: string) => void
+remoteRoot: string | undefined
+resolveLoadPath: (ref: string) => string
+resolveRef: (ref: string) => string | null
+resolveSceneAssetPaths: (sceneData: SceneData, result: SceneAssetResult) => void
+restorePersistedUpdate: (key: string) => boolean
+reuploadTexturesAfterDeviceLoss: () => Promise<number>
+setAssetRefResolver: (resolver: AssetRefResolver) => void
+setAssetRegistry: (registry: AssetRegistry) => void
+setManifest: (manifest: AddressableManifest | ManifestModel | null) => void
+setRefCounter: (counter: AssetRefCounter) => void
+setRemoteRoot: (url: string | undefined) => void
+setSpineController: (controller: SpineModuleController) => void
+setTextureImportSettingsResolver: (resolver: TextureImportSettingsResolver | null) => void
+static create: (options: AssetsOptions) => AssetsClass
+static new (options: AssetsOptions): AssetsClass
+static prototype: AssetsClass
```
## AsyncCache — class @experimental
@@ -2874,7 +2949,11 @@ states: FsmState[]
## FsmEdge — type @experimental
```
-GraphEdge<FsmTransition>
+from: string
+id: string
+index: number
+to: string
+transition: FsmTransition
```
## FsmPlugin — class @experimental
@@ -4750,7 +4829,10 @@ code: number | undefined
## PaymentRequest — type @experimental
```
-PlatformPaymentRequest
+offerId: string
+quantity: number
+sandbox: boolean | undefined
+zoneId: string | undefined
```
## Perceiver — const @experimental
@@ -6501,7 +6583,9 @@ static prototype: ShareAPI
## ShareCard — type @experimental
```
-PlatformShareOptions
+imageUrl: string | undefined
+query: string | undefined
+title: string | undefined
```
## SideModuleDescriptor — interface @experimental
diff --git a/sdk/etc/wechat.api.md b/sdk/etc/wechat.api.md
index a2cf77178..b4f02c3e4 100644
--- a/sdk/etc/wechat.api.md
+++ b/sdk/etc/wechat.api.md
@@ -415,7 +415,11 @@ enabled: boolean
## AnimatorEdge — type @experimental
```
-GraphEdge<AnimatorTransition>
+from: string
+id: string
+index: number
+to: string
+transition: AnimatorTransition
```
## AnimatorEvalResult — interface @experimental
@@ -681,7 +685,78 @@ ResourceDef<AssetsClass>
## AssetsData — type @experimental
```
-AssetsClass
+@internal releaseTyped: (type: string, ref: string) => void
+@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
+backend: Backend
+baseUrl: string | undefined
+catalog: Catalog
+checkForUpdate: (options: CheckForUpdateOptions) => Promise<UpdatePlan>
+fetchBinary: (ref: string) => Promise<ArrayBuffer>
+fetchJson: <T = unknown>(ref: string) => Promise<T>
+fetchText: (ref: string) => Promise<string>
+getAssetRefResolver: () => AssetRefResolver | null
+getAssetRegistry: () => AssetRegistry | null
+getAtlasFrame: (ref: string) => AtlasFrameInfo | null
+getLoader: <T>(type: string) => AssetLoader<T> | undefined
+getManifest: () => ManifestModel | null
+getRefCounter: () => AssetRefCounter | null
+getSpineLoader: () => SpineAssetLoader
+getTexture: (ref: string) => TextureResult | undefined
+getTextureLoader: () => TextureLoader
+invalidate: (ref: string) => boolean
+load: <T>(type: string, ref: string) => Promise<T>
+loadAnimClip: (ref: string) => Promise<AnimClipResult>
+loadAnimatorController: (ref: string) => Promise<AnimatorControllerResult>
+loadAudio: (ref: string) => Promise<AudioResult>
+loadBehaviorTree: (ref: string) => Promise<BtResult>
+loadByLabel: (label: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadFont: (ref: string) => Promise<FontResult>
+loadGroup: (groupName: string, onProgress?: (loaded: number, total: number) => void) => Promise<AssetBundle>
+loadJson: <T = unknown>(ref: string) => Promise<JsonResult<T>>
+loadLocaleTable: (ref: string) => Promise<LocaleResult>
+loadMaterial: (ref: string) => Promise<MaterialResult>
+loadPrefab: (ref: string) => Promise<PrefabResult>
+loadSpine: (skeletonRef: string, atlasRef?: string) => Promise<SpineResult>
+loadStateMachine: (ref: string) => Promise<FsmResult>
+loadTexture: (ref: string) => Promise<TextureResult>
+loadTextureRaw: (ref: string) => Promise<TextureResult>
+loadTilemap: (ref: string) => Promise<TilemapResult>
+loadTileset: (ref: string) => Promise<TilesetResult>
+loadTimeline: (ref: string) => Promise<TimelineResult>
+onInvalidate: (listener: InvalidateListener) => () => void
+pathForHandle: (kind: string, handle: number) => string | null
+preload: (refs: ReadonlyArray<string>, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; }) => Promise<{ failed: MissingAsset[]; }>
+preloadSceneAssets: (sceneData: SceneData, onProgress?: (loaded: number, total: number) => void, options?: { readonly maxConcurrent?: number; readonly skipSpine?: boolean; }) => Promise<SceneAssetResult>
+recoverFromDeviceLoss: () => Promise<boolean>
+register: <T>(loader: AssetLoader<T>) => void
+releaseAll: () => void
+releaseAnimClip: (ref: string) => void
+releaseAssets: (byType: ReadonlyMap<string, ReadonlySet<string>>) => void
+releaseAudio: (ref: string) => void
+releaseFont: (ref: string) => void
+releaseGroup: (groupName: string) => void
+releaseMaterial: (handle: number) => void
+releasePrefab: (ref: string) => void
+releaseTexture: (ref: string) => void
+releaseTilemap: (ref: string) => void
+releaseTimeline: (ref: string) => void
+remoteRoot: string | undefined
+resolveLoadPath: (ref: string) => string
+resolveRef: (ref: string) => string | null
+resolveSceneAssetPaths: (sceneData: SceneData, result: SceneAssetResult) => void
+restorePersistedUpdate: (key: string) => boolean
+reuploadTexturesAfterDeviceLoss: () => Promise<number>
+setAssetRefResolver: (resolver: AssetRefResolver) => void
+setAssetRegistry: (registry: AssetRegistry) => void
+setManifest: (manifest: AddressableManifest | ManifestModel | null) => void
+setRefCounter: (counter: AssetRefCounter) => void
+setRemoteRoot: (url: string | undefined) => void
+setSpineController: (controller: SpineModuleController) => void
+setTextureImportSettingsResolver: (resolver: TextureImportSettingsResolver | null) => void
+static create: (options: AssetsOptions) => AssetsClass
+static new (options: AssetsOptions): AssetsClass
+static prototype: AssetsClass
```
## AsyncCache — class @experimental
@@ -2874,7 +2949,11 @@ states: FsmState[]
## FsmEdge — type @experimental
```
-GraphEdge<FsmTransition>
+from: string
+id: string
+index: number
+to: string
+transition: FsmTransition
```
## FsmPlugin — class @experimental
@@ -4512,7 +4591,10 @@ code: number | undefined
## PaymentRequest — type @experimental
```
-PlatformPaymentRequest
+offerId: string
+quantity: number
+sandbox: boolean | undefined
+zoneId: string | undefined
```
## Perceiver — const @experimental
@@ -6263,7 +6345,9 @@ static prototype: ShareAPI
## ShareCard — type @experimental
```
-PlatformShareOptions
+imageUrl: string | undefined
+query: string | undefined
+title: string | undefined
```
## SideModuleDescriptor — interface @experimental
diff --git a/tools/api-surface.mjs b/tools/api-surface.mjs
index fec1aa981..d34a2c942 100644
--- a/tools/api-surface.mjs
+++ b/tools/api-surface.mjs
@@ -124,6 +124,23 @@ const entryPaths = fromDts
const { program, checker } = createSdkProgram(entryPaths, { strictLibCheck: fromDts });
+/**
+ * Every symbol any entry exports, by identity rather than by name. Identity is
+ * load-bearing: the asset class is called `Assets` and so is the resource const
+ * that holds one, so a name check reads the class as exported when only the const
+ * is. The union across entries, since a shape exported from `physics` is nameable.
+ */
+const exportedSymbols = new Set();
+for (const entryPath of Object.values(entryPaths)) {
+ const sourceFile = program.getSourceFile(join(SDK, entryPath));
+ const moduleSymbol = sourceFile && checker.getSymbolAtLocation(sourceFile);
+ if (!moduleSymbol) continue;
+ for (const s of checker.getExportsOfModule(moduleSymbol)) {
+ exportedSymbols.add(s);
+ if (s.flags & ts.SymbolFlags.Alias) exportedSymbols.add(checker.getAliasedSymbol(s));
+ }
+}
+
const FMT = ts.TypeFormatFlags.NoTruncation | ts.TypeFormatFlags.UseAliasDefinedOutsideCurrentScope;
// ---------------------------------------------------------------------------
@@ -252,6 +269,22 @@ function memberLines(type, location, owner) {
return lines.sort();
}
+/**
+ * The class or interface an alias points at when that target's OWN name is not
+ * exported — `export type AssetsData = AssetsClass`, an alias for a class no entry
+ * re-exports. Null for anything a reader can look up, or with no members to record.
+ */
+function hiddenTargetOf(aliasDecl) {
+ if (!ts.isTypeReferenceNode(aliasDecl.type)) return null;
+ const target = checker.getTypeAtLocation(aliasDecl.type).getSymbol();
+ if (!target || !(target.flags & (ts.SymbolFlags.Class | ts.SymbolFlags.Interface))) return null;
+ if (exportedSymbols.has(target)) return null;
+ // Only our own source: an alias to a lib or @types shape is not ours to record.
+ const from = target.declarations?.[0]?.getSourceFile().fileName.replace(/\\/g, '/');
+ if (!from || !from.startsWith(SDK.replace(/\\/g, '/')) || from.includes('/node_modules/')) return null;
+ return target;
+}
+
function describeSymbol(name, symbol) {
const resolved = symbol.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(symbol) : symbol;
const decl = resolved.declarations?.[0];
@@ -277,7 +310,19 @@ function describeSymbol(name, symbol) {
} else if (flags & ts.SymbolFlags.TypeAlias) {
kind = 'type';
const aliasDecl = resolved.declarations.find(ts.isTypeAliasDeclaration);
- body.push(normalizeType(aliasDecl ? aliasDecl.type.getText() : 'unknown'));
+ const hidden = aliasDecl && hiddenTargetOf(aliasDecl);
+ if (hidden) {
+ // Recording the target's unexported NAME records nothing — no member
+ // would reach the snapshot, the diff or the baseline rule. The type AT
+ // the reference, so a `GraphEdge<FsmTransition>` keeps its instantiation.
+ body.push(...memberLines(checker.getTypeAtLocation(aliasDecl.type), aliasDecl, owner));
+ if (hidden.flags & ts.SymbolFlags.Class) {
+ const statics = checker.getTypeOfSymbolAtLocation(hidden, hidden.declarations[0]);
+ body.push(...memberLines(statics, aliasDecl, owner).map((l) => `static ${l}`));
+ }
+ } else {
+ body.push(normalizeType(aliasDecl ? aliasDecl.type.getText() : 'unknown'));
+ }
} else if (flags & ts.SymbolFlags.Enum) {
kind = 'enum';
for (const m of resolved.exports?.values() ?? []) {