@zjw-jszn/platform-imsdk 1.0.2 → 1.0.4

package/README.md

@@ -1,30 +1,103 @@
-# Platform IMSDK
+# @zjw-jszn/platform-imsdk
 
-平台 SDK（基于共用内核 `@zjw-jszn/shared-imsdk`）：
+`@zjw-jszn/platform-imsdk` 是平台侧接入包，在 `shared` 内核上固化平台模式并内置平台扩展 API。
 
-- API 前缀：`/site/IM`
-- WebSocket controller：`Site`
-- WebSocket platform：`site`
-- 能力范围：基础会话能力 + 平台扩展接口（结束会话、客服会话、会话配置、AI 配置）
-平台 API 文档：`docs/API/平台.md`
-
-安装：
+## 安装
 
 ```bash
 pnpm add @zjw-jszn/platform-imsdk
 ```
 
-使用：
+## 导入
 
 ```ts
 import { IMSDK } from '@zjw-jszn/platform-imsdk'
+import type {
+  IMSDKConfig,
+  PlatformChatConfig,
+  PlatformCloseSessionParams,
+  PlatformPageResponse,
+  PlatformSession,
+} from '@zjw-jszn/platform-imsdk'
+```
+
+## 平台模式默认值（自动注入）
+
+| 配置项 | 固定值 |
+| --- | --- |
+| `api.prefix` | `/site/IM` |
+| `api.userType` | `4` |
+| `ws.controller` | `Site` |
+| `ws.platform` | `site` |
+
+> 以上字段以平台模式为准；外部覆盖会被忽略并打印告警。
+
+## 初始化
+
+```ts
+type Controls = {
+  show: () => void
+  hide: () => void
+}
+
+declare function init(config: IMSDKConfig): Promise<Controls>
+```
+
+### 最小接入示例
+
+```ts
+import { IMSDK } from '@zjw-jszn/platform-imsdk'
+import type { IMSDKConfig } from '@zjw-jszn/platform-imsdk'
+
+const config: IMSDKConfig = {
+  phone: '18888888888',
+  api: {
+    baseURL: 'https://aox.api.orchiport.asia',
+    siteId: '6',
+  },
+}
+
+const controls = await IMSDK.init(config)
+controls.show()
+```
 
-IMSDK.init({
-  phone: '18888888888', // 当前测试约定值（平台）
-})
+## 平台扩展 API
+
+### `getChatConfig`
+
+```ts
+declare function getChatConfig(): Promise<PlatformChatConfig>
 ```
 
-说明：
+### `closeSession`
 
-- 平台端 `getAuthorization.phone` 需使用 `im-backend-web`「系统设置/管理员管理（system/admin）」中的管理员手机号。
-- 上述示例值仅为当前联调值（2026-03-24）；若后台管理员手机号变更需同步更新。
+```ts
+declare function closeSession(data: PlatformCloseSessionParams): Promise<boolean>
+```
+
+约束：`uid` 与 `session_id` 至少传一个。
+
+### `getCustomerChatList`
+
+```ts
+declare function getCustomerChatList(data: {
+  page: number
+  limit: number
+  phone?: string
+}): Promise<PlatformPageResponse<PlatformSession>>
+```
+
+## 配置约束
+
+- 可配置 shared 通用项：`api.baseURL`、`api.siteId`、`sound`、`auth` 等。
+- 外部传入 `runtimeApi.getChatConfig/closeSession/getCustomerChatList` 会被忽略（平台内置实现优先）。
+- 已初始化后若尝试切换到门店模式，会抛错并提示刷新页面。
+
+## 样式
+
+样式由依赖链中的 shared 包自动注入，通常不需要手动引入。  
+如需手动控制加载时机：
+
+```ts
+import '@zjw-jszn/platform-imsdk/style.css'
+```

package/index.js

@@ -0,0 +1,2 @@
+export { default } from './dist/platform-imsdk.es.js'
+export * from './dist/platform-imsdk.es.js'

package/package.json

@@ -1,25 +1,20 @@
 {
   "name": "@zjw-jszn/platform-imsdk",
   "type": "module",
-  "version": "1.0.2",
-  "main": "./dist/platform-imsdk.umd.js",
-  "module": "./dist/platform-imsdk.es.js",
+  "version": "1.0.4",
   "exports": {
     ".": {
-      "types": {
-        "development": "./src/index.ts",
-        "default": "./dist/index.d.ts"
-      },
-      "import": {
-        "development": "./src/index.ts",
-        "default": "./dist/platform-imsdk.es.js"
-      }
+      "types": "./dist/index.d.ts",
+      "import": "./index.js"
     },
     "./style.css": "./style.css"
   },
+  "main": "./dist/platform-imsdk.umd.js",
+  "module": "./index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
+    "index.js",
     "style.css"
   ],
   "publishConfig": {
@@ -27,7 +22,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@zjw-jszn/shared-imsdk": "1.0.2"
+    "@zjw-jszn/shared-imsdk": "1.0.4"
   },
   "devDependencies": {
     "typescript": "~5.9.3",