@world-engines/agent-kit 0.1.0-alpha.0

package/assets/docs/development/generated/chatplay-sdk/descriptor.json

@@ -0,0 +1,699 @@
+{
+  "version": "3.1",
+  "runtimeReleaseId": "runtime-3-1",
+  "runtimeMajor": 3,
+  "runtimePatch": 1,
+  "protocolVersion": 3,
+  "sdkSchemaVersion": 3,
+  "capabilitiesShapeVersion": 3,
+  "headerSentinel": "ChatPlay SDK 接口描述",
+  "viewSurface": [
+    {
+      "name": "ready",
+      "kind": "property",
+      "paramsType": "N/A (property)",
+      "returnType": "Promise<{ scriptId: string; saveId: string; locale: string; theme: ThemeSnapshot; capabilities: SdkCapabilities }>",
+      "jsDoc": "同步握手 Promise 入口必先 await window.ChatPlay.ready 完成后才能调任何 wrapper",
+      "hostUiDomain": false
+    },
+    {
+      "name": "context",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "{ scriptId: string; saveId: string; locale: string; theme: ThemeSnapshot; capabilities: SdkCapabilities } | null",
+      "jsDoc": "同步取当前握手 context ready 之前返回 null",
+      "hostUiDomain": false
+    },
+    {
+      "name": "listMessages",
+      "kind": "method",
+      "paramsType": "(opts?: { after?: string; before?: string; limit?: number })",
+      "returnType": "Promise<PersistedListItem[]>",
+      "jsDoc": "拉当前 save 持久化消息列表 支持 after/before 切片与 limit 截断",
+      "hostUiDomain": false
+    },
+    {
+      "name": "sendUserMessage",
+      "kind": "method",
+      "paramsType": "(text: string)",
+      "returnType": "Promise<{ messageId: string; turnId: string }>",
+      "jsDoc": "通过宿主受控 chat.sendUserMessage 发送非空 user 消息；不暴露底层 RPC",
+      "hostUiDomain": false
+    },
+    {
+      "name": "listAssets",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "Promise<Array<{ id: string; url: string; size: number; mime: string; filename: string; scriptId: string; createdTs: number }>>",
+      "jsDoc": "列出当前 script 名下所有资产",
+      "hostUiDomain": false
+    },
+    {
+      "name": "getAssetUrl",
+      "kind": "method",
+      "paramsType": "(id: string)",
+      "returnType": "Promise<string>",
+      "jsDoc": "把 asset id 解析成运行时可访问 URL (blob:)",
+      "hostUiDomain": false
+    },
+    {
+      "name": "loadCustomState",
+      "kind": "method",
+      "paramsType": "(key: string)",
+      "returnType": "Promise<unknown>",
+      "jsDoc": "读 view 端自定义状态 缺省 key 返回 undefined",
+      "hostUiDomain": false
+    },
+    {
+      "name": "listCustomStateKeys",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "Promise<string[]>",
+      "jsDoc": "列出当前 save 下所有 custom state key",
+      "hostUiDomain": false
+    },
+    {
+      "name": "customState",
+      "kind": "property",
+      "paramsType": "N/A (property)",
+      "returnType": "ReadonlyCustomStateApi",
+      "jsDoc": "按当前 view 作用域只读查询自定义状态；写入、删除和批量提交不暴露给 TMW3 view",
+      "hostUiDomain": false
+    },
+    {
+      "name": "events",
+      "kind": "property",
+      "paramsType": "N/A (property; emit(eventType: string, payload: Readonly<Record<string, TmwViewJsonValue>>, interactionId: string))",
+      "returnType": "TmwViewEventsApi { emit(eventType: string, payload: Readonly<Record<string, TmwViewJsonValue>>, interactionId: string): TmwViewEventEmitReceipt }",
+      "jsDoc": "TMW3 view interaction capability；仅可提交 manifest 预声明 eventType，返回 interactionId 与 nonce 回执；最终激活结果通过 interactionResult 事件异步回传，不生成或扩大宿主权限",
+      "hostUiDomain": false
+    },
+    {
+      "name": "worldline",
+      "kind": "property",
+      "paramsType": "N/A (property)",
+      "returnType": "ReadonlyPlayerWorldlines",
+      "jsDoc": "TMW3 same-Save worldline API. Scope is host-derived; no Save identifier is accepted or returned.",
+      "hostUiDomain": false
+    },
+    {
+      "name": "getScenarioMeta",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "Promise<{ scriptId: string; title: string; schemaVersion: number }>",
+      "jsDoc": "取当前剧本元信息",
+      "hostUiDomain": false
+    },
+    {
+      "name": "getProgress",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "Promise<number>",
+      "jsDoc": "取进度比 0..1",
+      "hostUiDomain": false
+    },
+    {
+      "name": "getVariable",
+      "kind": "method",
+      "paramsType": "(name: string)",
+      "returnType": "Promise<unknown>",
+      "jsDoc": "读取当前 save 的触发器变量；scope 由宿主固定为 save，View 不可改写",
+      "hostUiDomain": false
+    },
+    {
+      "name": "getUnlock",
+      "kind": "method",
+      "paramsType": "(target: \"node\" | \"edge\", id: string)",
+      "returnType": "Promise<{ unlocked: boolean }>",
+      "jsDoc": "读取当前 save 中指定节点或边的触发器解锁状态",
+      "hostUiDomain": false
+    },
+    {
+      "name": "getOwnedResources",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "Promise<OwnedResourceGroup[]>",
+      "jsDoc": "返回当前已解锁资源 按节点和属性锚点分组",
+      "hostUiDomain": false
+    },
+    {
+      "name": "openModelSettings",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "Promise<{ ok: true }>",
+      "jsDoc": "请求宿主打开模型设置面板；只返回是否接受意图，不读取或返回任何配置",
+      "hostUiDomain": false
+    },
+    {
+      "name": "getLocale",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "Promise<string>",
+      "jsDoc": "取当前 UI locale (zh / en / ja)",
+      "hostUiDomain": false
+    },
+    {
+      "name": "getTheme",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "Promise<ThemeSnapshot>",
+      "jsDoc": "只读获取宿主主题选择和当前解析后的明暗配色",
+      "hostUiDomain": false
+    },
+    {
+      "name": "runtimeVersion",
+      "kind": "method",
+      "paramsType": "()",
+      "returnType": "{ major: number; patch: number }",
+      "jsDoc": "同步返回 SDK runtime 版本号",
+      "hostUiDomain": false
+    },
+    {
+      "name": "on",
+      "kind": "method",
+      "paramsType": "(event: ChatPlayEvent, listener: (payload: unknown) => void)",
+      "returnType": "() => void",
+      "jsDoc": "订阅 SDK 事件 返回取消订阅函数；interactionResult 只关联本 iframe 的 interactionId/nonce，不暴露 committed event envelope、capability 或原始错误；tmwDelivery 不参与互动结果关联",
+      "hostUiDomain": false
+    }
+  ],
+  "hostOnly": [
+    {
+      "key": "chat.editMessage",
+      "paramsType": "unknown",
+      "paramsInferred": "{ id: string; content: string }",
+      "returnType": "Promise<WorldlineEditResult & { streamId?: string; }>",
+      "jsDoc": "",
+      "hostOnly": true,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.rewindToMessage",
+      "paramsType": "unknown",
+      "paramsInferred": "{ id: string }",
+      "returnType": "Promise<WorldlineRewindResult>",
+      "jsDoc": "",
+      "hostOnly": true,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.forkAtMessage",
+      "paramsType": "unknown",
+      "paramsInferred": "{ id: string; title: string }",
+      "returnType": "Promise<WorldlineForkResult>",
+      "jsDoc": "",
+      "hostOnly": true,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.cloneFullSave",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<CloneFullSaveResult>",
+      "jsDoc": "",
+      "hostOnly": true,
+      "saveReserved": false
+    }
+  ],
+  "saveReserved": [
+    {
+      "key": "save.list",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.create",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.delete",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.rename",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.load",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.export",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    }
+  ],
+  "lowLevel": [
+    {
+      "key": "system.ready",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<{ scriptId: string; saveId: string; locale: Lang; theme: ThemeSnapshot; capabilities: SdkCapabilities; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "system.getLocale",
+      "paramsType": "void",
+      "paramsInferred": null,
+      "returnType": "Promise<Lang>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "system.getTheme",
+      "paramsType": "void",
+      "paramsInferred": null,
+      "returnType": "Promise<ThemeSnapshot>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.listMessages",
+      "paramsType": "unknown",
+      "paramsInferred": "{ after: string; before: string; limit: number }",
+      "returnType": "Promise<Message[]>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.sendUserMessage",
+      "paramsType": "unknown",
+      "paramsInferred": "{ text: string; meta: Record<string, unknown>; visibility: unknown; abortPending: unknown }",
+      "returnType": "Promise<{ userMessageId: string; streamId: string; assistantMessageId: string; turnId: string; extractionMessageId: string; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.abort",
+      "paramsType": "unknown",
+      "paramsInferred": "{ streamId: string; reason: string }",
+      "returnType": "Promise<{ ok: boolean; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.editMessage",
+      "paramsType": "unknown",
+      "paramsInferred": "{ id: string; content: string }",
+      "returnType": "Promise<WorldlineEditResult & { streamId?: string; }>",
+      "jsDoc": "",
+      "hostOnly": true,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.deleteMessage",
+      "paramsType": "void",
+      "paramsInferred": null,
+      "returnType": "Promise<never>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.rewindToMessage",
+      "paramsType": "unknown",
+      "paramsInferred": "{ id: string }",
+      "returnType": "Promise<WorldlineRewindResult>",
+      "jsDoc": "",
+      "hostOnly": true,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.forkAtMessage",
+      "paramsType": "unknown",
+      "paramsInferred": "{ id: string; title: string }",
+      "returnType": "Promise<WorldlineForkResult>",
+      "jsDoc": "",
+      "hostOnly": true,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.cloneFullSave",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<CloneFullSaveResult>",
+      "jsDoc": "",
+      "hostOnly": true,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.regenerate",
+      "paramsType": "unknown",
+      "paramsInferred": "{ assistantMessageId: string }",
+      "returnType": "Promise<WorldlineRegenerateResult & { streamId: string; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "chat.retryPersistence",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<{ status: string; turnId: string; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "save.list",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.create",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.delete",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.rename",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.load",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "save.export",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": true
+    },
+    {
+      "key": "state.get",
+      "paramsType": "unknown",
+      "paramsInferred": "{ key: string }",
+      "returnType": "Promise<unknown>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "state.getEntry",
+      "paramsType": "unknown",
+      "paramsInferred": "{ key: string }",
+      "returnType": "Promise<CustomStateEntry | undefined>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "state.set",
+      "paramsType": "unknown",
+      "paramsInferred": "{ key: string; scope: unknown; authorizedUserIds: unknown; value: unknown }",
+      "returnType": "Promise<{ ok: boolean; generation: number; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "state.delete",
+      "paramsType": "unknown",
+      "paramsInferred": "{ key: string }",
+      "returnType": "Promise<{ ok: boolean; generation: number; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "state.keys",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<readonly string[]>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "state.commitBatch",
+      "paramsType": "unknown",
+      "paramsInferred": "{ idempotencyKey: string; mutations: unknown[]; expectedGeneration: unknown }",
+      "returnType": "Promise<CustomStateCommitResult>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "state.requestCheckpoint",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<{ generation: number; entryCount: number; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "asset.upload",
+      "paramsType": "unknown",
+      "paramsInferred": "{ data: string; filename: string; mime: string }",
+      "returnType": "Promise<{ url: string; id: string; scriptId: string; saveId: string; sha256: string; r2Key: string; uri: string; cloudRefVerified: boolean; eventSeq: number | null; filename: string; mime: string; size: number; createdTs: number; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "asset.list",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<{ url: string; id: string; scriptId: string; saveId: string; sha256: string; r2Key: string; uri: string; cloudRefVerified: boolean; eventSeq: number | null; filename: string; mime: string; size: number; createdTs: number; }[]>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "asset.delete",
+      "paramsType": "unknown",
+      "paramsInferred": "{ id: string }",
+      "returnType": "Promise<{ ok: boolean; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "asset.getUrl",
+      "paramsType": "unknown",
+      "paramsInferred": "{ id: string }",
+      "returnType": "Promise<string>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "scenario.getVariable",
+      "paramsType": "unknown",
+      "paramsInferred": "{ name: string; scope: unknown }",
+      "returnType": "Promise<TmwVariableV1>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "scenario.getUnlock",
+      "paramsType": "unknown",
+      "paramsInferred": "{ id: string; target: unknown }",
+      "returnType": "Promise<{ unlocked: boolean; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "scenario.getMeta",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<{ scriptId: string; title: string; schemaVersion: number; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "scenario.getProgress",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<number>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "scenario.setProgress",
+      "paramsType": "unknown",
+      "paramsInferred": "{ ratio: number }",
+      "returnType": "Promise<{ ok: boolean; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "scenario.getOwnedResources",
+      "paramsType": "void",
+      "paramsInferred": null,
+      "returnType": "Promise<OwnedResourceGroup[]>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "ui.requestExit",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<{ ok: boolean; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "ui.requestReturnToSaveList",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<ReturnToSaveListAck>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "ui.requestFullscreen",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<{ ok: boolean; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "ui.requestSettings",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<{ ok: boolean; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "ui.requestHistory",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<{ ok: boolean; }>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "view.querySnapshot",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<ViewQuerySnapshotResult>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "view.applyPatch",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<ViewApplyPatchResult>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "worldline.list",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<WorldlineListResult>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "worldline.fork",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<ProtocolWorldlineForkResult>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "worldline.activate",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<WorldlineActivateResult>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    },
+    {
+      "key": "worldline.trim",
+      "paramsType": "unknown",
+      "paramsInferred": null,
+      "returnType": "Promise<WorldlineTrimResult>",
+      "jsDoc": "",
+      "hostOnly": false,
+      "saveReserved": false
+    }
+  ]
+}