@plolink/sdk 0.0.4

package/dist/poller-BlIRbwL4.d.cts

@@ -0,0 +1,201 @@
+import { P as PollerOptions, a as PollerSnapshot } from './core-77EbLgbp.cjs';
+
+/**
+ * 指数退避轮询器
+ *
+ * @description
+ * 实现了智能轮询机制，具有以下特性：
+ * - **指数退避**：失败时按配置的退避因子增加轮询间隔
+ * - **自动停止**：通过 shouldStop 判断终态自动停止
+ * - **状态快照**：支持导出和恢复轮询状态
+ * - **挂载恢复**：适用于组件卸载后重新挂载的场景
+ *
+ * @template T - 轮询任务返回值的类型
+ *
+ * @example
+ * ```typescript
+ * // 创建轮询器
+ * const poller = new Poller({
+ *   task: () => fetch('/api/order/123').then(r => r.json()),
+ *   onResult: (data) => {
+ *     console.log('Order status:', data.status);
+ *   },
+ *   shouldStop: (data) => data.status === 'success' || data.status === 'failed',
+ *   initialInterval: 1000,
+ *   maxInterval: 30000,
+ *   backoffFactor: 1.5,
+ *   onError: (error) => {
+ *     console.error('Polling error:', error);
+ *   }
+ * });
+ *
+ * // 启动轮询
+ * poller.start();
+ *
+ * // 停止轮询
+ * poller.stop();
+ *
+ * // 导出状态快照（用于恢复）
+ * const snapshot = poller.getSnapshot();
+ *
+ * // 从快照恢复
+ * poller.restoreFromSnapshot(snapshot);
+ * ```
+ */
+declare class Poller<T> {
+    /**
+     * 轮询配置选项
+     */
+    private readonly options;
+    /**
+     * 定时器引用
+     */
+    private timer;
+    /**
+     * 当前轮询间隔（毫秒）
+     */
+    private currentInterval;
+    /**
+     * 当前重试次数
+     */
+    private retryCount;
+    /**
+     * 是否正在运行
+     */
+    private isRunning;
+    /**
+     * 是否正在执行任务
+     */
+    private isExecuting;
+    /**
+     * 创建一个 Poller 实例
+     *
+     * @param options - 轮询器配置选项
+     *
+     * @example
+     * ```typescript
+     * const poller = new Poller({
+     *   task: async () => {
+     *     const response = await fetch('/api/status');
+     *     return response.json();
+     *   },
+     *   onResult: (data) => console.log(data),
+     *   shouldStop: (data) => data.completed === true
+     * });
+     * ```
+     */
+    constructor(options: PollerOptions<T>);
+    /**
+     * 启动或恢复轮询
+     *
+     * @description
+     * 如果轮询器已经在运行，此方法不会有任何效果。
+     * 首次调用会立即执行一次任务。
+     *
+     * @returns Promise，在首次任务执行完成后 resolve
+     *
+     * @example
+     * ```typescript
+     * await poller.start();
+     * console.log('Polling started');
+     * ```
+     */
+    start(): Promise<void>;
+    /**
+     * 停止轮询
+     *
+     * @description
+     * 停止后可以通过再次调用 start() 恢复轮询。
+     * 如果有正在执行的任务，会等待其完成。
+     *
+     * @example
+     * ```typescript
+     * poller.stop();
+     * console.log('Polling stopped');
+     * ```
+     */
+    stop(): void;
+    /**
+     * 执行轮询任务
+     *
+     * @private
+     */
+    private execute;
+    /**
+     * 获取当前状态快照
+     *
+     * @description
+     * 用于保存轮询器的当前状态，以便后续恢复。
+     * 这在组件卸载/重新挂载场景中非常有用。
+     *
+     * @returns 状态快照对象
+     *
+     * @example
+     * ```typescript
+     * const snapshot = poller.getSnapshot();
+     * localStorage.setItem('poller-state', JSON.stringify(snapshot));
+     *
+     * // 恢复时
+     * const snapshot = JSON.parse(localStorage.getItem('poller-state'));
+     * poller.restoreFromSnapshot(snapshot);
+     * ```
+     */
+    getSnapshot(): PollerSnapshot;
+    /**
+     * 从状态快照恢复
+     *
+     * @description
+     * 从之前保存的快照中恢复轮询器状态。
+     * 注意：此方法不会自动启动轮询，需要手动调用 start()。
+     *
+     * @param snapshot - 状态快照对象
+     *
+     * @example
+     * ```typescript
+     * const snapshot = {
+     *   retryCount: 3,
+     *   currentInterval: 3375,
+     *   isRunning: false
+     * };
+     * poller.restoreFromSnapshot(snapshot);
+     *
+     * // 如果需要继续轮询
+     * if (snapshot.isRunning) {
+     *   poller.start();
+     * }
+     * ```
+     */
+    restoreFromSnapshot(snapshot: PollerSnapshot): void;
+    /**
+     * 重置轮询器状态
+     *
+     * @description
+     * 将轮询器重置到初始状态（重试次数归零，间隔重置）。
+     * 不会停止正在运行的轮询。
+     *
+     * @example
+     * ```typescript
+     * poller.reset();
+     * ```
+     */
+    reset(): void;
+    /**
+     * 获取当前状态信息
+     *
+     * @returns 包含当前状态的对象
+     *
+     * @example
+     * ```typescript
+     * const status = poller.getStatus();
+     * console.log(`Running: ${status.isRunning}, Retry: ${status.retryCount}`);
+     * ```
+     */
+    getStatus(): {
+        isRunning: boolean;
+        isExecuting: boolean;
+        retryCount: number;
+        currentInterval: number;
+    };
+}
+
+export { Poller as P };

package/dist/poller-DWKZjuSw.d.ts

@@ -0,0 +1,201 @@
+import { P as PollerOptions, a as PollerSnapshot } from './core-77EbLgbp.js';
+
+/**
+ * 指数退避轮询器
+ *
+ * @description
+ * 实现了智能轮询机制，具有以下特性：
+ * - **指数退避**：失败时按配置的退避因子增加轮询间隔
+ * - **自动停止**：通过 shouldStop 判断终态自动停止
+ * - **状态快照**：支持导出和恢复轮询状态
+ * - **挂载恢复**：适用于组件卸载后重新挂载的场景
+ *
+ * @template T - 轮询任务返回值的类型
+ *
+ * @example
+ * ```typescript
+ * // 创建轮询器
+ * const poller = new Poller({
+ *   task: () => fetch('/api/order/123').then(r => r.json()),
+ *   onResult: (data) => {
+ *     console.log('Order status:', data.status);
+ *   },
+ *   shouldStop: (data) => data.status === 'success' || data.status === 'failed',
+ *   initialInterval: 1000,
+ *   maxInterval: 30000,
+ *   backoffFactor: 1.5,
+ *   onError: (error) => {
+ *     console.error('Polling error:', error);
+ *   }
+ * });
+ *
+ * // 启动轮询
+ * poller.start();
+ *
+ * // 停止轮询
+ * poller.stop();
+ *
+ * // 导出状态快照（用于恢复）
+ * const snapshot = poller.getSnapshot();
+ *
+ * // 从快照恢复
+ * poller.restoreFromSnapshot(snapshot);
+ * ```
+ */
+declare class Poller<T> {
+    /**
+     * 轮询配置选项
+     */
+    private readonly options;
+    /**
+     * 定时器引用
+     */
+    private timer;
+    /**
+     * 当前轮询间隔（毫秒）
+     */
+    private currentInterval;
+    /**
+     * 当前重试次数
+     */
+    private retryCount;
+    /**
+     * 是否正在运行
+     */
+    private isRunning;
+    /**
+     * 是否正在执行任务
+     */
+    private isExecuting;
+    /**
+     * 创建一个 Poller 实例
+     *
+     * @param options - 轮询器配置选项
+     *
+     * @example
+     * ```typescript
+     * const poller = new Poller({
+     *   task: async () => {
+     *     const response = await fetch('/api/status');
+     *     return response.json();
+     *   },
+     *   onResult: (data) => console.log(data),
+     *   shouldStop: (data) => data.completed === true
+     * });
+     * ```
+     */
+    constructor(options: PollerOptions<T>);
+    /**
+     * 启动或恢复轮询
+     *
+     * @description
+     * 如果轮询器已经在运行，此方法不会有任何效果。
+     * 首次调用会立即执行一次任务。
+     *
+     * @returns Promise，在首次任务执行完成后 resolve
+     *
+     * @example
+     * ```typescript
+     * await poller.start();
+     * console.log('Polling started');
+     * ```
+     */
+    start(): Promise<void>;
+    /**
+     * 停止轮询
+     *
+     * @description
+     * 停止后可以通过再次调用 start() 恢复轮询。
+     * 如果有正在执行的任务，会等待其完成。
+     *
+     * @example
+     * ```typescript
+     * poller.stop();
+     * console.log('Polling stopped');
+     * ```
+     */
+    stop(): void;
+    /**
+     * 执行轮询任务
+     *
+     * @private
+     */
+    private execute;
+    /**
+     * 获取当前状态快照
+     *
+     * @description
+     * 用于保存轮询器的当前状态，以便后续恢复。
+     * 这在组件卸载/重新挂载场景中非常有用。
+     *
+     * @returns 状态快照对象
+     *
+     * @example
+     * ```typescript
+     * const snapshot = poller.getSnapshot();
+     * localStorage.setItem('poller-state', JSON.stringify(snapshot));
+     *
+     * // 恢复时
+     * const snapshot = JSON.parse(localStorage.getItem('poller-state'));
+     * poller.restoreFromSnapshot(snapshot);
+     * ```
+     */
+    getSnapshot(): PollerSnapshot;
+    /**
+     * 从状态快照恢复
+     *
+     * @description
+     * 从之前保存的快照中恢复轮询器状态。
+     * 注意：此方法不会自动启动轮询，需要手动调用 start()。
+     *
+     * @param snapshot - 状态快照对象
+     *
+     * @example
+     * ```typescript
+     * const snapshot = {
+     *   retryCount: 3,
+     *   currentInterval: 3375,
+     *   isRunning: false
+     * };
+     * poller.restoreFromSnapshot(snapshot);
+     *
+     * // 如果需要继续轮询
+     * if (snapshot.isRunning) {
+     *   poller.start();
+     * }
+     * ```
+     */
+    restoreFromSnapshot(snapshot: PollerSnapshot): void;
+    /**
+     * 重置轮询器状态
+     *
+     * @description
+     * 将轮询器重置到初始状态（重试次数归零，间隔重置）。
+     * 不会停止正在运行的轮询。
+     *
+     * @example
+     * ```typescript
+     * poller.reset();
+     * ```
+     */
+    reset(): void;
+    /**
+     * 获取当前状态信息
+     *
+     * @returns 包含当前状态的对象
+     *
+     * @example
+     * ```typescript
+     * const status = poller.getStatus();
+     * console.log(`Running: ${status.isRunning}, Retry: ${status.retryCount}`);
+     * ```
+     */
+    getStatus(): {
+        isRunning: boolean;
+        isExecuting: boolean;
+        retryCount: number;
+        currentInterval: number;
+    };
+}
+
+export { Poller as P };

package/dist/shared-6ZepUSPW.d.cts

@@ -0,0 +1,31 @@
+/**
+ * 跨模块共享类型
+ *
+ * @description
+ * 这些类型会被多个模块复用（例如 VirtualAccount 与 RBAC），放在 shared 里避免循环依赖与重复定义。
+ */
+/**
+ * 角色类型
+ */
+type RoleType = 'SYSTEM' | 'CUSTOM';
+/**
+ * 数据范围类型
+ */
+type ScopeType = 'TEAM' | 'SELF' | 'CUSTOM';
+/**
+ * 角色分配参数（用于创建虚拟账号预置角色、以及成员角色分配）
+ */
+interface AssignRoleParams {
+    /** 角色类型 */
+    roleType: RoleType;
+    /** 系统角色代码（roleType=SYSTEM时使用） */
+    roleCode?: string;
+    /** 自定义角色ID（roleType=CUSTOM时使用） */
+    roleId?: string;
+    /** 数据范围类型 */
+    scopeType: ScopeType;
+    /** 数据范围值（scopeType=CUSTOM时使用） */
+    scopeValue?: Record<string, unknown>;
+}
+
+export type { AssignRoleParams as A, RoleType as R, ScopeType as S };

package/dist/shared-6ZepUSPW.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 跨模块共享类型
+ *
+ * @description
+ * 这些类型会被多个模块复用（例如 VirtualAccount 与 RBAC），放在 shared 里避免循环依赖与重复定义。
+ */
+/**
+ * 角色类型
+ */
+type RoleType = 'SYSTEM' | 'CUSTOM';
+/**
+ * 数据范围类型
+ */
+type ScopeType = 'TEAM' | 'SELF' | 'CUSTOM';
+/**
+ * 角色分配参数（用于创建虚拟账号预置角色、以及成员角色分配）
+ */
+interface AssignRoleParams {
+    /** 角色类型 */
+    roleType: RoleType;
+    /** 系统角色代码（roleType=SYSTEM时使用） */
+    roleCode?: string;
+    /** 自定义角色ID（roleType=CUSTOM时使用） */
+    roleId?: string;
+    /** 数据范围类型 */
+    scopeType: ScopeType;
+    /** 数据范围值（scopeType=CUSTOM时使用） */
+    scopeValue?: Record<string, unknown>;
+}
+
+export type { AssignRoleParams as A, RoleType as R, ScopeType as S };

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@plolink/sdk",
+  "version": "0.0.4",
+  "description": "Plolink 开放平台官方 SDK",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./billing": {
+      "types": "./dist/modules/billing/index.d.ts",
+      "import": "./dist/modules/billing/index.js",
+      "require": "./dist/modules/billing/index.cjs"
+    },
+    "./agent": {
+      "types": "./dist/modules/agent/index.d.ts",
+      "import": "./dist/modules/agent/index.js",
+      "require": "./dist/modules/agent/index.cjs"
+    },
+    "./psych": {
+      "types": "./dist/modules/psych/index.d.ts",
+      "import": "./dist/modules/psych/index.js",
+      "require": "./dist/modules/psych/index.cjs"
+    },
+    "./chat": {
+      "types": "./dist/modules/chat/index.d.ts",
+      "import": "./dist/modules/chat/index.js",
+      "require": "./dist/modules/chat/index.cjs"
+    },
+    "./virtual-account": {
+      "types": "./dist/modules/virtual-account/index.d.ts",
+      "import": "./dist/modules/virtual-account/index.js",
+      "require": "./dist/modules/virtual-account/index.cjs"
+    },
+    "./rbac": {
+      "types": "./dist/modules/rbac/index.d.ts",
+      "import": "./dist/modules/rbac/index.js",
+      "require": "./dist/modules/rbac/index.cjs"
+    },
+    "./team": {
+      "types": "./dist/modules/team/index.d.ts",
+      "import": "./dist/modules/team/index.js",
+      "require": "./dist/modules/team/index.cjs"
+    },
+    "./common": {
+      "types": "./dist/common/index.d.ts",
+      "import": "./dist/common/index.js",
+      "require": "./dist/common/index.cjs"
+    }
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "lint": "eslint src --ext .ts",
+    "test": "jest --coverage --testPathIgnorePatterns tests/integration",
+    "test:integration": "PLOLINK_JEST_DISABLE_COVERAGE_THRESHOLD=true jest --coverage tests/integration",
+    "test:watch": "jest --watch",
+    "docs": "typedoc",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "plolink",
+    "sdk",
+    "api-client"
+  ],
+  "author": "Plolink Team",
+  "license": "MIT",
+  "peerDependencies": {
+    "axios": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.19",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "axios": "^1.9.0",
+    "axios-mock-adapter": "^1.22.0",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "tslib": "^2.8.1",
+    "tsup": "^8.0.2",
+    "typedoc": "^0.25.8",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typescript": "^5.3.3"
+  }
+}