@lark-project/js-sdk 0.1.7 → 2.0.0-alpha.0

package/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 2.0.0（2024/03/27）
+- 「Add」新增 Modal / ActionSheet（mobile）/ Utils
+
 ## 0.1.7（2023/12/27）
 - 「Add」新增 Toast，支持四种状态的简单提示
 

package/dist/es/index.js

@@ -212,6 +212,54 @@ _a9 = IMPL_KEY;
  */
 Toast[_a9] = "toast";
 
+// src/biz/ActionSheet.ts
+var _a10;
+var ActionSheet = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a10 = IMPL_KEY;
+/**
+ * @internal
+ */
+ActionSheet[_a10] = "actionSheet";
+
+// src/biz/Modal.ts
+var _a11;
+var Modal = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a11 = IMPL_KEY;
+/**
+ * @internal
+ */
+Modal[_a11] = "modal";
+
+// src/biz/Utils.ts
+var _a12;
+var Utils = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a12 = IMPL_KEY;
+/**
+ * @internal
+ */
+Utils[_a12] = "utils";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -244,6 +292,24 @@ var _SDKClient = class {
   get toast() {
     return getImplValue(Toast, this._meegoBizHub);
   }
+  /**
+   * 模态框
+   */
+  get modal() {
+    return getImplValue(Modal, this._meegoBizHub);
+  }
+  /**
+   * 操作菜单
+   */
+  get actionSheet() {
+    return getImplValue(ActionSheet, this._meegoBizHub);
+  }
+  /**
+   * 工具方法
+   */
+  get utils() {
+    return getImplValue(Utils, this._meegoBizHub);
+  }
   /**
    * 应用上下文
    */
@@ -300,7 +366,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "0.1.7";
+SDKClient.version = "2.0.0-alpha.0";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -426,6 +492,7 @@ var OutOfLimitError = class extends CustomError {
 // src/index.ts
 var src_default = SDKClient;
 export {
+  ActionSheet,
   AttributeType,
   ButtonScene,
   Clipboard,
@@ -437,6 +504,7 @@ export {
   InterceptionEvent,
   InternalError,
   MEEGO_BIZ_HUB,
+  Modal,
   Navigation,
   NoAuthError,
   NodeStatus,
@@ -446,6 +514,7 @@ export {
   Space,
   Storage,
   Toast,
+  Utils,
   WorkItem,
   WorkObject,
   src_default as default

package/dist/lib/index.js

@@ -48,6 +48,7 @@ var __async = (__this, __arguments, generator) => {
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  ActionSheet: () => ActionSheet,
   AttributeType: () => AttributeType,
   ButtonScene: () => ButtonScene,
   Clipboard: () => Clipboard,
@@ -59,6 +60,7 @@ __export(src_exports, {
   InterceptionEvent: () => InterceptionEvent,
   InternalError: () => InternalError,
   MEEGO_BIZ_HUB: () => MEEGO_BIZ_HUB,
+  Modal: () => Modal,
   Navigation: () => Navigation,
   NoAuthError: () => NoAuthError,
   NodeStatus: () => NodeStatus,
@@ -68,6 +70,7 @@ __export(src_exports, {
   Space: () => Space,
   Storage: () => Storage,
   Toast: () => Toast,
+  Utils: () => Utils,
   WorkItem: () => WorkItem,
   WorkObject: () => WorkObject,
   default: () => src_default
@@ -258,6 +261,54 @@ _a9 = IMPL_KEY;
  */
 Toast[_a9] = "toast";
 
+// src/biz/ActionSheet.ts
+var _a10;
+var ActionSheet = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a10 = IMPL_KEY;
+/**
+ * @internal
+ */
+ActionSheet[_a10] = "actionSheet";
+
+// src/biz/Modal.ts
+var _a11;
+var Modal = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a11 = IMPL_KEY;
+/**
+ * @internal
+ */
+Modal[_a11] = "modal";
+
+// src/biz/Utils.ts
+var _a12;
+var Utils = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a12 = IMPL_KEY;
+/**
+ * @internal
+ */
+Utils[_a12] = "utils";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -290,6 +341,24 @@ var _SDKClient = class {
   get toast() {
     return getImplValue(Toast, this._meegoBizHub);
   }
+  /**
+   * 模态框
+   */
+  get modal() {
+    return getImplValue(Modal, this._meegoBizHub);
+  }
+  /**
+   * 操作菜单
+   */
+  get actionSheet() {
+    return getImplValue(ActionSheet, this._meegoBizHub);
+  }
+  /**
+   * 工具方法
+   */
+  get utils() {
+    return getImplValue(Utils, this._meegoBizHub);
+  }
   /**
    * 应用上下文
    */
@@ -346,7 +415,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "0.1.7";
+SDKClient.version = "2.0.0-alpha.0";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -473,6 +542,7 @@ var OutOfLimitError = class extends CustomError {
 var src_default = SDKClient;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ActionSheet,
   AttributeType,
   ButtonScene,
   Clipboard,
@@ -484,6 +554,7 @@ var src_default = SDKClient;
   InterceptionEvent,
   InternalError,
   MEEGO_BIZ_HUB,
+  Modal,
   Navigation,
   NoAuthError,
   NodeStatus,
@@ -493,6 +564,7 @@ var src_default = SDKClient;
   Space,
   Storage,
   Toast,
+  Utils,
   WorkItem,
   WorkObject
 });

package/dist/types/index.d.ts

@@ -921,6 +921,130 @@ declare abstract class Toast extends BaseModel {
     abstract close(id: string): void;
 }
 
+/**
+ * ActionSheet 配置选项
+ */
+interface ActionSheetOptions {
+    /**
+     * 菜单列表
+     * 数量限制 1 至 6 个
+     */
+    itemList: string[];
+}
+/**
+ * @mobile
+ * @public
+ * ActionSheet 动作菜单用于让用户选择操作
+ */
+declare abstract class ActionSheet extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * @internal
+     */
+    private static load;
+    /**
+     * 打开操作菜单
+     * @param options
+     * @return
+     *    tapIndex 用户点击的菜单位置
+     */
+    abstract show(options: ActionSheetOptions): Promise<{
+        tapIndex: number;
+    }>;
+}
+
+/**
+ * Modal 展示配置
+ */
+interface ModalOptions {
+    /**
+     * 标题
+     * title 和 content 不可同时为空
+     */
+    title?: string;
+    /**
+     * 内容
+     * title 和 content 不可同时为空
+     */
+    content?: string;
+    /**
+     * 确认按钮文字
+     * 默认 ok
+     */
+    confirmText?: string;
+    /**
+     * 是否展示取消按钮
+     * 默认 true
+     */
+    showCancel?: boolean;
+    /**
+     * 取消按钮文字
+     * 默认 cancel
+     */
+    cancelText?: string;
+}
+/**
+ * @public
+ * Modal 用于等待用户响应、告知用户重要信息或在不丢失上下文的情况下展示更多信息
+ */
+declare abstract class Modal extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * @internal
+     */
+    private static load;
+    /**
+     * 打开模态框
+     * @param options
+     * @return
+     *    confirmed 点击了确认
+     *    conceled  点击了取消
+     */
+    abstract show(options: string | ModalOptions): Promise<{
+        confirmed: boolean;
+        canceled: boolean;
+    }>;
+}
+
+/**
+ * @mobile
+ * @public
+ * Utils
+ */
+declare abstract class Utils extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * @internal
+     */
+    private static load;
+    /**
+     * 信息类型提示
+     * @param apiList string[] 方法名列表
+     * @returns
+     *  availableList string[] 可用方法名列表
+     */
+    abstract canIUse(apiList: string[]): Promise<{
+        availableList: string[];
+    }>;
+    /**
+     * 获取用户身份授权码，用于 OpenAPI 换取 user_access_token
+     * @returns
+     *  code 授权码
+     */
+    abstract getAuthCode(): Promise<{
+        code: string;
+    }>;
+}
+
 /**
  * @public
  * SDKClient 的配置项
@@ -954,6 +1078,18 @@ declare class SDKClient {
      * 提示
      */
     get toast(): Toast;
+    /**
+     * 模态框
+     */
+    get modal(): Modal;
+    /**
+     * 操作菜单
+     */
+    get actionSheet(): ActionSheet;
+    /**
+     * 工具方法
+     */
+    get utils(): Utils;
     /**
      * 应用上下文
      */
@@ -1046,4 +1182,4 @@ declare class OutOfLimitError extends CustomError {
  * @packageDocumentation
  */
 
-export { AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, ButtonFeatureContext, ButtonScene, Clipboard, ColorScheme, Context, ControlFeatureContext, Field, FieldType, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IntegrationFeatureContext, InterceptionEvent, InterceptionFeatureContext, InternalError, Language, MEEGO_BIZ_HUB, Navigation, NoAuthError, NodeStatus, NotFoundError, OutOfLimitError, PageFeatureContext, Role, RoleOwners, SDKClient, SDKClientOptions, Space, Storage, TabFeatureContext, Toast, ToastOptions, User, ViewFeatureContext, WorkItem, WorkItemCreateFormPreset, WorkObject, SDKClient as default, unwatch };
+export { ActionSheet, ActionSheetOptions, AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, ButtonFeatureContext, ButtonScene, Clipboard, ColorScheme, Context, ControlFeatureContext, Field, FieldType, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IntegrationFeatureContext, InterceptionEvent, InterceptionFeatureContext, InternalError, Language, MEEGO_BIZ_HUB, Modal, ModalOptions, Navigation, NoAuthError, NodeStatus, NotFoundError, OutOfLimitError, PageFeatureContext, Role, RoleOwners, SDKClient, SDKClientOptions, Space, Storage, TabFeatureContext, Toast, ToastOptions, User, Utils, ViewFeatureContext, WorkItem, WorkItemCreateFormPreset, WorkObject, SDKClient as default, unwatch };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-project/js-sdk",
-  "version": "0.1.7",
+  "version": "2.0.0-alpha.0",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"