@lark-project/js-sdk 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -1,4 +1,6 @@
 # Change Log
+## 0.1.3（2023/09/04）
+- 「Add」新增 storage
 
 ## 0.1.2（2023/08/23）
 - 「Add」Navigation 新增 getHref 读取当前完整的页面地址

package/dist/es/index.js

@@ -164,6 +164,22 @@ _a6 = IMPL_KEY;
  */
 Navigation[_a6] = "navigation";
 
+// src/biz/Storage.ts
+var _a7;
+var Storage = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a7 = IMPL_KEY;
+/**
+ * @internal
+ */
+Storage[_a7] = "storage";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -178,6 +194,12 @@ var _SDKClient = class {
   get navigation() {
     return getImplValue(Navigation, this._meegoBizHub);
   }
+  /**
+   * 本地存储
+   */
+  get storage() {
+    return getImplValue(Storage, this._meegoBizHub);
+  }
   /**
    * 应用上下文
    */
@@ -234,7 +256,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "0.1.2";
+SDKClient.version = "0.1.4";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -346,6 +368,17 @@ var NotFoundError = class extends CustomError {
   }
 };
 
+// src/errors/OutOfLimitError.ts
+var OutOfLimitError = class extends CustomError {
+  constructor(options) {
+    super({
+      message: "out of the limit",
+      originMessage: options.originMessage
+    });
+    this.name = "OutOfLimitError";
+  }
+};
+
 // src/index.ts
 var src_default = SDKClient;
 export {
@@ -363,8 +396,10 @@ export {
   NoAuthError,
   NodeStatus,
   NotFoundError,
+  OutOfLimitError,
   SDKClient,
   Space,
+  Storage,
   WorkItem,
   WorkObject,
   src_default as default

package/dist/lib/index.js

@@ -62,8 +62,10 @@ __export(src_exports, {
   NoAuthError: () => NoAuthError,
   NodeStatus: () => NodeStatus,
   NotFoundError: () => NotFoundError,
+  OutOfLimitError: () => OutOfLimitError,
   SDKClient: () => SDKClient,
   Space: () => Space,
+  Storage: () => Storage,
   WorkItem: () => WorkItem,
   WorkObject: () => WorkObject,
   default: () => src_default
@@ -206,6 +208,22 @@ _a6 = IMPL_KEY;
  */
 Navigation[_a6] = "navigation";
 
+// src/biz/Storage.ts
+var _a7;
+var Storage = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a7 = IMPL_KEY;
+/**
+ * @internal
+ */
+Storage[_a7] = "storage";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -220,6 +238,12 @@ var _SDKClient = class {
   get navigation() {
     return getImplValue(Navigation, this._meegoBizHub);
   }
+  /**
+   * 本地存储
+   */
+  get storage() {
+    return getImplValue(Storage, this._meegoBizHub);
+  }
   /**
    * 应用上下文
    */
@@ -276,7 +300,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "0.1.2";
+SDKClient.version = "0.1.4";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -388,6 +412,17 @@ var NotFoundError = class extends CustomError {
   }
 };
 
+// src/errors/OutOfLimitError.ts
+var OutOfLimitError = class extends CustomError {
+  constructor(options) {
+    super({
+      message: "out of the limit",
+      originMessage: options.originMessage
+    });
+    this.name = "OutOfLimitError";
+  }
+};
+
 // src/index.ts
 var src_default = SDKClient;
 // Annotate the CommonJS export names for ESM import in node:
@@ -406,8 +441,10 @@ var src_default = SDKClient;
   NoAuthError,
   NodeStatus,
   NotFoundError,
+  OutOfLimitError,
   SDKClient,
   Space,
+  Storage,
   WorkItem,
   WorkObject
 });

package/dist/types/index.d.ts

@@ -298,6 +298,11 @@ type BriefView = any;
  * 语言
  */
 type Language = 'zh_CN' | 'en_US';
+/**
+ * @public
+ * 颜色方案
+ */
+type ColorScheme = 'light' | 'dark';
 
 /**
  * 集成构成
@@ -479,6 +484,10 @@ declare abstract class Context extends BaseModel {
      * 当前语言
      */
     abstract language: Language;
+    /**
+     * 用户偏好的色彩方案
+     */
+    abstract colorScheme: ColorScheme;
     /**
      * 当前登录用户信息
      */
@@ -777,6 +786,43 @@ declare abstract class Navigation extends BaseModel {
     }) => void): void;
 }
 
+/**
+ * @public
+ * 本地临时存储
+ * 存储是当前登录用户 + 插件维度隔离，跨插件无法实现互相访问，每个插件的临时存储空间不超过 5MB
+ */
+declare abstract class Storage extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * @internal
+     */
+    private static load;
+    /**
+     * 写入存储
+     * @param key 存储标识
+     * @param value 存储值
+     */
+    abstract setItem(key: string, value: string | undefined): Promise<void>;
+    /**
+     * 读取存储
+     * @param key 存储标识
+     * @returns 存储值（Promise）
+     */
+    abstract getItem(key: string): Promise<string | undefined>;
+    /**
+     * 移除存储
+     * @param key 待移除的存储标识
+     */
+    abstract removeItem(key: string): Promise<void>;
+    /**
+     * 清除所有存储
+     */
+    abstract clear(): Promise<void>;
+}
+
 /**
  * @public
  * SDKClient 的配置项
@@ -798,6 +844,10 @@ declare class SDKClient {
      * 应用导航
      */
     get navigation(): Navigation;
+    /**
+     * 本地存储
+     */
+    get storage(): Storage;
     /**
      * 应用上下文
      */
@@ -871,6 +921,16 @@ declare class NotFoundError extends CustomError {
     });
 }
 
+/**
+ * @public
+ * 超出限制异常，如 Storage 存储超额
+ */
+declare class OutOfLimitError extends CustomError {
+    constructor(options: {
+        originMessage: string;
+    });
+}
+
 /**
  * 用于飞书项目插件读取系统数据的 JSSDK
  *
@@ -880,4 +940,4 @@ declare class NotFoundError extends CustomError {
  * @packageDocumentation
  */
 
-export { AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, ButtonFeatureContext, ButtonScene, Context, ControlFeatureContext, Field, FieldType, FlowMode, IMPL_KEY, IntegrationFeatureContext, InterceptionEvent, InterceptionFeatureContext, InternalError, Language, MEEGO_BIZ_HUB, Navigation, NoAuthError, NodeStatus, NotFoundError, PageFeatureContext, Role, RoleOwners, SDKClient, SDKClientOptions, Space, TabFeatureContext, User, ViewFeatureContext, WorkItem, WorkItemCreateFormPreset, WorkObject, SDKClient as default, unwatch };
+export { AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, ButtonFeatureContext, ButtonScene, ColorScheme, Context, ControlFeatureContext, Field, FieldType, FlowMode, IMPL_KEY, IntegrationFeatureContext, InterceptionEvent, InterceptionFeatureContext, InternalError, Language, MEEGO_BIZ_HUB, Navigation, NoAuthError, NodeStatus, NotFoundError, OutOfLimitError, PageFeatureContext, Role, RoleOwners, SDKClient, SDKClientOptions, Space, Storage, TabFeatureContext, User, ViewFeatureContext, WorkItem, WorkItemCreateFormPreset, WorkObject, SDKClient as default, unwatch };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-project/js-sdk",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"