@zjw-jszn/shared-imsdk 1.0.3 → 1.0.4

package/README.md

@@ -1,45 +1,109 @@
-# Shared IMSDK
+# @zjw-jszn/shared-imsdk
 
-`@zjw-jszn/shared-imsdk` 是平台与门店 SDK 的共用内核，提供：
+`@zjw-jszn/shared-imsdk` 是 IM Web SDK 的共享内核，提供鉴权、会话、消息、未读、WebSocket 与通用聊天 UI。
 
-- 通用 API 能力（会话、消息、未读、鉴权）
-- 通用 WebSocket 客户端与消息流转
-- 通用 UI 组件与状态管理
-- 可配置的 API 前缀与 WebSocket controller
-- 基于 API 前缀自动识别平台/门店能力差异
+适用场景：你需要自定义模式（非标准平台/门店）或需要直接复用底层能力。  
+如果你是标准平台/门店接入，优先使用 `@zjw-jszn/platform-imsdk` 或 `@zjw-jszn/store-imsdk`。
 
-该包用于被业务包二次封装，不直接绑定具体业务前缀。
+## 安装
 
-## 核心配置
+```bash
+pnpm add @zjw-jszn/shared-imsdk
+```
+
+## 导入
 
 ```ts
 import { IMSDK } from '@zjw-jszn/shared-imsdk'
+import type { IMSDKConfig, UserInfo } from '@zjw-jszn/shared-imsdk'
+```
+
+默认导出也可用：
+
+```ts
+import IMSDK from '@zjw-jszn/shared-imsdk'
+```
+
+## 初始化
+
+```ts
+type Controls = {
+  show: () => void
+  hide: () => void
+}
+
+declare function init(config?: IMSDKConfig): Promise<Controls>
+```
+
+### 最小可运行配置（自定义模式）
+
+> `shared` 不会自动注入平台/门店模式默认值，以下字段必须由接入方提供。
 
-IMSDK.init({
-  phone: '18888888888', // 示例使用平台当前联调值；完整映射见 docs/API/IM-WS-对接约定.md
+```ts
+import { IMSDK } from '@zjw-jszn/shared-imsdk'
+import type { IMSDKConfig } from '@zjw-jszn/shared-imsdk'
+
+const config: IMSDKConfig = {
+  phone: '18888888888',
   api: {
     baseURL: 'https://aox.api.orchiport.asia',
-    prefix: '/site/IM', // 或 /cashier/IM
+    prefix: '/site/IM',
+    siteId: '6',
   },
   ws: {
-    controller: 'Site', // 或 Manager
-    platform: 'site', // 或 manager（必须小写，且与 controller 对应）
-  },
-  auth: {
-    // 仅当业务端有扩展鉴权参数时使用（如门店 username/avatar）
-    authorizationPayload: {},
+    controller: 'Site',
+    platform: 'site',
   },
-})
+}
+
+const controls = await IMSDK.init(config)
+controls.show()
 ```
 
-## 建议使用方式
+## `IMSDKConfig` 关键字段
 
-- 平台业务：使用 `@zjw-jszn/platform-imsdk`
-- 门店业务：使用 `@zjw-jszn/store-imsdk`
+| 字段 | 说明 |
+| --- | --- |
+| `phone` | 首次鉴权必填（无 token 场景） |
+| `api.baseURL` | HTTP 基础地址（默认 `https://aox.api.orchiport.asia`） |
+| `api.prefix` | API 前缀，`shared` 模式下必须显式传入 |
+| `api.siteId` | 站点 ID，用于鉴权后 WS 连接 |
+| `ws.controller` | WebSocket 控制器，必须显式传入 |
+| `ws.platform` | 平台标识，必须为小写，且等于 `controller.toLowerCase()` |
+| `sound` | 消息提示音开关与地址 |
+| `auth.authorizationPayload` | 鉴权扩展参数透传 |
+| `runtimeApi` | 运行时扩展接口（`getChatConfig/closeSession/getCustomerChatList`） |
 
-`@zjw-jszn/shared-imsdk` 主要面向内部复用与扩展封装。
+## 常用导出
 
-能力差异说明：
+```ts
+import {
+  IMSDK,
+  getUserInfo,
+  isInitialized,
+  getConfig,
+  updateConfig,
+  resetConfig,
+  buildApiPath,
+  hasApiCapability,
+  http,
+  wsClient,
+} from '@zjw-jszn/shared-imsdk'
+```
 
-- `prefix=/site/IM`：启用平台扩展接口（会话配置、结束会话、客服会话等）
-- `prefix=/cashier/IM`：仅启用门店基础会话接口
+## 初始化约束与错误
+
+- 缺少 `api.prefix` 会抛错。
+- 缺少 `ws.controller` 或 `ws.platform` 会抛错。
+- `ws.platform` 必须小写，且需与 `ws.controller.toLowerCase()` 一致。
+- 首次初始化且无 token 时，必须传 `phone`。
+- 已以某模式初始化后，不允许在同页面切换到另一模式。
+
+## 样式
+
+包入口会自动注入样式；通常无需手动引入。  
+如需手动控制加载时机：
+
+```ts
+import '@zjw-jszn/shared-imsdk/style.css'
+```

package/index.js

@@ -0,0 +1,5 @@
+// eslint-disable-next-line antfu/no-import-dist
+import './dist/shared-imsdk.css'
+
+export { default } from './dist/shared-imsdk.es.js'
+export * from './dist/shared-imsdk.es.js'

package/package.json

@@ -1,25 +1,20 @@
 {
   "name": "@zjw-jszn/shared-imsdk",
   "type": "module",
-  "version": "1.0.3",
-  "main": "./dist/shared-imsdk.umd.js",
-  "module": "./dist/shared-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/shared-imsdk.es.js"
-      }
+      "types": "./dist/index.d.ts",
+      "import": "./index.js"
     },
     "./style.css": "./dist/shared-imsdk.css"
   },
+  "main": "./dist/shared-imsdk.umd.js",
+  "module": "./index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "index.js"
   ],
   "publishConfig": {
     "access": "public",