@jieyin/editor-sdk 1.1.125 → 1.1.126

package/README.md

@@ -135,7 +135,7 @@ import '@jieyin/editor-sdk/style.css'
 | `fileBaseUrl`            | `string`                                                     | -      | 文件资源基础 URL（用于代理/拼接）                         |
 | `licenseConfig`          | `LicenseConfig`                                              | -      | License 配置（不传则不做 License 校验）                |
 | `fileToken`              | `string \| null`                                             | `null` | 文件访问 Token（用于带鉴权的图片/资源）                     |
-| `onObjectModified`       | `(getDiecutStateMap: () => Record<string, unknown>) => void` | -      | 画布内容变更回调，可在此调用 `getDiecutStateMap()` 拿各刀版状态 |
+| `onObjectModified`       | `(getDiecutStateMap: () => DiecutStateMapResult) => void` | -      | 画布内容变更回调，调用 `getDiecutStateMap()` 可得 `{ stateMap, selectedColor, selectedSize }` |
 | `onRenderAllTemplates`   | `(renderMethod) => Promise<...>`                             | -      | 自定义「渲染所有模板」逻辑（如上传到服务器）                      |
 | `onSaveDesign`           | `() => void \| Promise<void>`                                | -      | 保存设计（传入则在 Topbar 显示保存按钮）                    |
 | `onGoHome`               | `() => void`                                                 | -      | 返回首页（传入则在 Topbar 显示返回按钮）                    |
@@ -155,16 +155,18 @@ interface EditorOptions {
 
 ### 暴露方法（ref 调用）
 
+> **详细入参/出参说明**：见 [API 对接文档](./docs/API-对接文档.md)，含 `getDiecutStateMap`、`renderAllTemplates` 等核心方法的入参、出参及对接示例。
+
 通过 `ref` 获取组件实例后，可调用以下方法：
 
 | 方法                               | 说明                                                                              |
 | -------------------------------- | ------------------------------------------------------------------------------- |
 | `renderAllTemplates()`           | 渲染当前产品下所有模板，返回 `Promise<Array<{ index: number; bitmap: ImageBitmap \| null }>>` |
 | `triggerRenderAllTemplates()`    | 触发一次「渲染所有模板」（会走 `onRenderAllTemplates` 若已传）                                     |
-| `getDiecutStateMap()`            | 获取当前各刀版画布状态 Map（用于保存设计）                                                         |
+| `getDiecutStateMap()`            | 获取带元数据的设计状态：`{ stateMap, selectedColor, selectedSize }`（用于保存设计）               |
 | `getCurrentProductName()`        | 获取当前产品名称                                                                        |
 | `loadCanvasJson(diecutId, json)` | 按刀版 ID 加载一份画布 JSON                                                              |
-| `loadDesignStateMap(stateMap)`   | 从「按 diecutId 分组」的状态 Map 还原整单设计                                                  |
+| `loadDesignStateMap(payload)`    | 还原设计：支持 `{ stateMap, selectedColor?, selectedSize? }` 或旧格式 `Record<diecutId, fabricJson>` |
 
 示例：
 
@@ -180,13 +182,13 @@ import { Editor } from '@jieyin/editor-sdk'
 const editorRef = ref<InstanceType<typeof Editor> | null>(null)
 
 async function save() {
-  const stateMap = editorRef.value?.getDiecutStateMap?.()
+  const result = editorRef.value?.getDiecutStateMap?.()
   const name = editorRef.value?.getCurrentProductName?.()
-  // 上传 stateMap、name 到后端...
+  // result 为 { stateMap, selectedColor, selectedSize }，上传到后端...
 }
 
-async function restore(stateMap: Record<string, unknown>) {
-  editorRef.value?.loadDesignStateMap?.(stateMap)
+async function restore(payload: { stateMap: Record<string, unknown>; selectedColor?: string; selectedSize?: string } | Record<string, unknown>) {
+  editorRef.value?.loadDesignStateMap?.(payload)
 }
 </script>
 ```
@@ -328,10 +330,10 @@ Editor 内部由多个 composable 组成（产品数据、模板、刀版、画
 const editorRef = ref<InstanceType<typeof Editor> | null>(null)
 
 async function onSaveDesign() {
-  const stateMap = editorRef.value?.getDiecutStateMap?.()
+  const result = editorRef.value?.getDiecutStateMap?.()
   const productName = editorRef.value?.getCurrentProductName?.()
-  if (!stateMap) return
-  await saveDesignTask({ productName, stateMap })
+  if (!result?.stateMap) return
+  await saveDesignTask({ productName, ...result })
 }
 ```
 
@@ -342,10 +344,10 @@ async function onSaveDesign() {
 2. 若用 `stateMap`：先让 Editor 完成模板加载（产品、刀版、变形数据就绪），在 `onTemplateReady` 中调用：
    
    ```ts
-   editorRef.value?.loadDesignStateMap?.(stateMap)
+   editorRef.value?.loadDesignStateMap?.(payload)
    ```
 
-3. 若用 `completeJsonUrl`：在 `onTemplateReady` 中 fetch 该 JSON，按你与后端的约定解析成 `stateMap` 再调用 `loadDesignStateMap(stateMap)`。
+3. 若用 `completeJsonUrl`：在 `onTemplateReady` 中 fetch 该 JSON，解析成 `{ stateMap, selectedColor?, selectedSize? }` 或旧格式的 stateMap，再调用 `loadDesignStateMap(payload)`。
 
 ### License 配置