@lark-project/js-sdk 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,10 +1,19 @@
 # Change Log
 
+## 0.1.2（2023/08/23）
+- 「Add」Navigation 新增 getHref 读取当前完整的页面地址
+
+## 0.1.1（2023/07/18）
+- 「Refactor」移除 HostEnv、Cursor、Session
+
 ## 0.1.0（2023/07/18）
 - 「Add」新增 Context，替换原 HostEnv、Cursor、Session
 - 「Add」Context selectedWorkflowNode 新增 status
 - 「Add」新增 Navigation
 
+## 0.0.31（2023/07/05）
+- 「Add」WorkObject getTemplateList 增加 disabled
+
 ## 0.0.30（2023/06/27）
 - 「Refactor」FieldType 枚举值与 OpenAPI 对齐
 

package/dist/es/index.js

@@ -37,42 +37,8 @@ var BaseModel = class {
 };
 IMPL_KEY;
 
-// src/context/HostEnv.ts
-var _a;
-var HostEnv = class extends BaseModel {
-  /**
-   * 当前区域
-   */
-  // abstract locale: Locale;
-};
-_a = IMPL_KEY;
-/**
- * @internal
- */
-HostEnv[_a] = "hostEnv";
-
-// src/context/Session.ts
-var _a2;
-var Session = class extends BaseModel {
-};
-_a2 = IMPL_KEY;
-/**
- * @internal
- */
-Session[_a2] = "session";
-
-// src/context/Cursor.ts
-var _a3;
-var Cursor = class extends BaseModel {
-};
-_a3 = IMPL_KEY;
-/**
- * @internal
- */
-Cursor[_a3] = "cursor";
-
 // src/context/index.ts
-var _a4;
+var _a;
 var Context = class extends BaseModel {
   /**
    * 加载上下文
@@ -81,14 +47,14 @@ var Context = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a4 = IMPL_KEY;
+_a = IMPL_KEY;
 /**
  * @internal
  */
-Context[_a4] = "Context";
+Context[_a] = "Context";
 
 // src/model/Space.ts
-var _a5;
+var _a2;
 var Space = class extends BaseModel {
   /**
    * 加载空间模型
@@ -105,14 +71,14 @@ var Space = class extends BaseModel {
   //  */
   // abstract watch(callback: (next: Space) => void): unwatch;
 };
-_a5 = IMPL_KEY;
+_a2 = IMPL_KEY;
 /**
  * @internal
  */
-Space[_a5] = "Space";
+Space[_a2] = "Space";
 
 // src/model/WorkObject.ts
-var _a6;
+var _a3;
 var WorkObject = class extends BaseModel {
   /**
    * 加载工作项对象模型
@@ -130,14 +96,14 @@ var WorkObject = class extends BaseModel {
   //  */
   // abstract watch(callback: (next: WorkObject) => void): unwatch;
 };
-_a6 = IMPL_KEY;
+_a3 = IMPL_KEY;
 /**
  * @internal
  */
-WorkObject[_a6] = "WorkObject";
+WorkObject[_a3] = "WorkObject";
 
 // src/model/WorkItem.ts
-var _a7;
+var _a4;
 var WorkItem = class extends BaseModel {
   /**
    * 加载工作项实例模型
@@ -151,14 +117,14 @@ var WorkItem = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a7 = IMPL_KEY;
+_a4 = IMPL_KEY;
 /**
  * @internal
  */
-WorkItem[_a7] = "WorkItem";
+WorkItem[_a4] = "WorkItem";
 
 // src/model/Field.ts
-var _a8;
+var _a5;
 var Field = class extends BaseModel {
   /**
    * 加载字段模型
@@ -176,14 +142,14 @@ var Field = class extends BaseModel {
    */
   // abstract getAdvancedConfig<T extends FieldType>(): AdvancedConfigs[T];
 };
-_a8 = IMPL_KEY;
+_a5 = IMPL_KEY;
 /**
  * @internal
  */
-Field[_a8] = "Field";
+Field[_a5] = "Field";
 
 // src/biz/Navigation.ts
-var _a9;
+var _a6;
 var Navigation = class extends BaseModel {
   /**
    * @internal
@@ -192,11 +158,11 @@ var Navigation = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a9 = IMPL_KEY;
+_a6 = IMPL_KEY;
 /**
  * @internal
  */
-Navigation[_a9] = "navigation";
+Navigation[_a6] = "navigation";
 
 // src/client.ts
 function getImplClass(decl, impls) {
@@ -206,30 +172,6 @@ function getImplValue(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
 }
 var _SDKClient = class {
-  /**
-   * 宿主环境
-   *
-   * @deprecated 请用 {@link Context} 替代
-   */
-  get hostEnv() {
-    return getImplValue(HostEnv, this._meegoBizHub);
-  }
-  /**
-   * 当前会话状态，如当前登录用户
-   *
-   * @deprecated 请用 {@link Context} 替代
-   */
-  get session() {
-    return getImplValue(Session, this._meegoBizHub);
-  }
-  /**
-   * 当前页面状态集合，如详情页选中的节点
-   *
-   * @deprecated 请用 {@link Context} 替代
-   */
-  get cursor() {
-    return getImplValue(Cursor, this._meegoBizHub);
-  }
   /**
    * 应用导航
    */
@@ -292,7 +234,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "0.1.0";
+SDKClient.version = "0.1.2";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -410,11 +352,9 @@ export {
   AttributeType,
   ButtonScene,
   Context,
-  Cursor,
   Field,
   FieldType,
   FlowMode,
-  HostEnv,
   IMPL_KEY,
   InterceptionEvent,
   InternalError,
@@ -424,7 +364,6 @@ export {
   NodeStatus,
   NotFoundError,
   SDKClient,
-  Session,
   Space,
   WorkItem,
   WorkObject,

package/dist/lib/index.js

@@ -51,11 +51,9 @@ __export(src_exports, {
   AttributeType: () => AttributeType,
   ButtonScene: () => ButtonScene,
   Context: () => Context,
-  Cursor: () => Cursor,
   Field: () => Field,
   FieldType: () => FieldType,
   FlowMode: () => FlowMode,
-  HostEnv: () => HostEnv,
   IMPL_KEY: () => IMPL_KEY,
   InterceptionEvent: () => InterceptionEvent,
   InternalError: () => InternalError,
@@ -65,7 +63,6 @@ __export(src_exports, {
   NodeStatus: () => NodeStatus,
   NotFoundError: () => NotFoundError,
   SDKClient: () => SDKClient,
-  Session: () => Session,
   Space: () => Space,
   WorkItem: () => WorkItem,
   WorkObject: () => WorkObject,
@@ -82,42 +79,8 @@ var BaseModel = class {
 };
 IMPL_KEY;
 
-// src/context/HostEnv.ts
-var _a;
-var HostEnv = class extends BaseModel {
-  /**
-   * 当前区域
-   */
-  // abstract locale: Locale;
-};
-_a = IMPL_KEY;
-/**
- * @internal
- */
-HostEnv[_a] = "hostEnv";
-
-// src/context/Session.ts
-var _a2;
-var Session = class extends BaseModel {
-};
-_a2 = IMPL_KEY;
-/**
- * @internal
- */
-Session[_a2] = "session";
-
-// src/context/Cursor.ts
-var _a3;
-var Cursor = class extends BaseModel {
-};
-_a3 = IMPL_KEY;
-/**
- * @internal
- */
-Cursor[_a3] = "cursor";
-
 // src/context/index.ts
-var _a4;
+var _a;
 var Context = class extends BaseModel {
   /**
    * 加载上下文
@@ -126,14 +89,14 @@ var Context = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a4 = IMPL_KEY;
+_a = IMPL_KEY;
 /**
  * @internal
  */
-Context[_a4] = "Context";
+Context[_a] = "Context";
 
 // src/model/Space.ts
-var _a5;
+var _a2;
 var Space = class extends BaseModel {
   /**
    * 加载空间模型
@@ -150,14 +113,14 @@ var Space = class extends BaseModel {
   //  */
   // abstract watch(callback: (next: Space) => void): unwatch;
 };
-_a5 = IMPL_KEY;
+_a2 = IMPL_KEY;
 /**
  * @internal
  */
-Space[_a5] = "Space";
+Space[_a2] = "Space";
 
 // src/model/WorkObject.ts
-var _a6;
+var _a3;
 var WorkObject = class extends BaseModel {
   /**
    * 加载工作项对象模型
@@ -175,14 +138,14 @@ var WorkObject = class extends BaseModel {
   //  */
   // abstract watch(callback: (next: WorkObject) => void): unwatch;
 };
-_a6 = IMPL_KEY;
+_a3 = IMPL_KEY;
 /**
  * @internal
  */
-WorkObject[_a6] = "WorkObject";
+WorkObject[_a3] = "WorkObject";
 
 // src/model/WorkItem.ts
-var _a7;
+var _a4;
 var WorkItem = class extends BaseModel {
   /**
    * 加载工作项实例模型
@@ -196,14 +159,14 @@ var WorkItem = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a7 = IMPL_KEY;
+_a4 = IMPL_KEY;
 /**
  * @internal
  */
-WorkItem[_a7] = "WorkItem";
+WorkItem[_a4] = "WorkItem";
 
 // src/model/Field.ts
-var _a8;
+var _a5;
 var Field = class extends BaseModel {
   /**
    * 加载字段模型
@@ -221,14 +184,14 @@ var Field = class extends BaseModel {
    */
   // abstract getAdvancedConfig<T extends FieldType>(): AdvancedConfigs[T];
 };
-_a8 = IMPL_KEY;
+_a5 = IMPL_KEY;
 /**
  * @internal
  */
-Field[_a8] = "Field";
+Field[_a5] = "Field";
 
 // src/biz/Navigation.ts
-var _a9;
+var _a6;
 var Navigation = class extends BaseModel {
   /**
    * @internal
@@ -237,11 +200,11 @@ var Navigation = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a9 = IMPL_KEY;
+_a6 = IMPL_KEY;
 /**
  * @internal
  */
-Navigation[_a9] = "navigation";
+Navigation[_a6] = "navigation";
 
 // src/client.ts
 function getImplClass(decl, impls) {
@@ -251,30 +214,6 @@ function getImplValue(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
 }
 var _SDKClient = class {
-  /**
-   * 宿主环境
-   *
-   * @deprecated 请用 {@link Context} 替代
-   */
-  get hostEnv() {
-    return getImplValue(HostEnv, this._meegoBizHub);
-  }
-  /**
-   * 当前会话状态，如当前登录用户
-   *
-   * @deprecated 请用 {@link Context} 替代
-   */
-  get session() {
-    return getImplValue(Session, this._meegoBizHub);
-  }
-  /**
-   * 当前页面状态集合，如详情页选中的节点
-   *
-   * @deprecated 请用 {@link Context} 替代
-   */
-  get cursor() {
-    return getImplValue(Cursor, this._meegoBizHub);
-  }
   /**
    * 应用导航
    */
@@ -337,7 +276,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "0.1.0";
+SDKClient.version = "0.1.2";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -456,11 +395,9 @@ var src_default = SDKClient;
   AttributeType,
   ButtonScene,
   Context,
-  Cursor,
   Field,
   FieldType,
   FlowMode,
-  HostEnv,
   IMPL_KEY,
   InterceptionEvent,
   InternalError,
@@ -470,7 +407,6 @@ var src_default = SDKClient;
   NodeStatus,
   NotFoundError,
   SDKClient,
-  Session,
   Space,
   WorkItem,
   WorkObject

package/dist/types/index.d.ts

@@ -183,12 +183,25 @@ type BriefWorkItem = {
 };
 /**
  * @public
- * 模板（仅含关键属性）
+ * 工作项模板（仅含关键属性）
  */
 interface BriefTemplate {
+    /**
+     * 工作项模板唯一标识
+     */
     id: number;
+    /**
+     * 工作项模板名称
+     */
     name: string;
+    /**
+     * 流程模式
+     */
     flowMode: FlowMode;
+    /**
+     * 模板已禁用
+     */
+    disabled: boolean;
 }
 /**
  * @public
@@ -449,78 +462,6 @@ declare abstract class BaseModel {
     protected static [IMPL_KEY]: string;
 }
 
-/**
- * 区域
- */
-/**
- * @public
- * 宿主环境信息
- *
- * @deprecated 请用 {@link Context} 替代
- */
-declare abstract class HostEnv extends BaseModel {
-    /**
-     * @internal
-     */
-    protected static [IMPL_KEY]: string;
-    /**
-     * 当前语言
-     */
-    abstract language: Language;
-}
-
-/**
- * @public
- * 当前会话状态
- *
- * @deprecated 请用 {@link Context} 替代
- */
-declare abstract class Session extends BaseModel {
-    /**
-     * @internal
-     */
-    protected static [IMPL_KEY]: string;
-    /**
-     * 当前登录用户信息
-     */
-    abstract user: User;
-}
-
-/**
- * @public
- * 当前页面状态集合
- *
- * @deprecated 请用 {@link Context} 替代
- */
-declare abstract class Cursor extends BaseModel {
-    /**
-     * @internal
-     */
-    protected static [IMPL_KEY]: string;
-    /**
-     * 主空间信息（左侧导航栏选中的空间）
-     */
-    abstract mainSpace?: BriefSpace;
-    /**
-     * 详情页的状态
-     */
-    abstract detailPage?: {
-        /**
-         * 激活工作项
-         */
-        activeWorkItem?: BriefWorkItem;
-        /**
-         * 当前选中的工作流节点
-         */
-        selectedWorkflowNode?: BriefNode;
-    };
-    /**
-     * 监听 Cursor 变化，目前仅在 Web 端 mainSpace、detailPage.activeWorkItem、detailPage.selectedWorkflowNode 变化时触发回调
-     * @param callback
-     */
-    abstract watch(callback: (nextValue: Cursor) => void): unwatch;
-}
-
 /**
  * @public
  * 应用上下文/状态
@@ -809,6 +750,10 @@ declare abstract class Navigation extends BaseModel {
      * @internal
      */
     private static load;
+    /**
+     * 读取当前完整的页面地址
+     */
+    abstract getHref(): Promise<string>;
     /**
      * 打开新标签页加载指定的资源
      * @param url 需要载入的 URL，可以是 HTML 页面或者图片文件等浏览器支持的文件格式
@@ -849,24 +794,6 @@ declare class SDKClient {
      * SDK 版本号
      */
     static version: string;
-    /**
-     * 宿主环境
-     *
-     * @deprecated 请用 {@link Context} 替代
-     */
-    get hostEnv(): HostEnv;
-    /**
-     * 当前会话状态，如当前登录用户
-     *
-     * @deprecated 请用 {@link Context} 替代
-     */
-    get session(): Session;
-    /**
-     * 当前页面状态集合，如详情页选中的节点
-     *
-     * @deprecated 请用 {@link Context} 替代
-     */
-    get cursor(): Cursor;
     /**
      * 应用导航
      */
@@ -953,4 +880,4 @@ declare class NotFoundError extends CustomError {
  * @packageDocumentation
  */
 
-export { AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, ButtonFeatureContext, ButtonScene, Context, ControlFeatureContext, Cursor, Field, FieldType, FlowMode, HostEnv, IMPL_KEY, IntegrationFeatureContext, InterceptionEvent, InterceptionFeatureContext, InternalError, Language, MEEGO_BIZ_HUB, Navigation, NoAuthError, NodeStatus, NotFoundError, PageFeatureContext, Role, RoleOwners, SDKClient, SDKClientOptions, Session, Space, TabFeatureContext, User, ViewFeatureContext, WorkItem, WorkItemCreateFormPreset, WorkObject, SDKClient as default, unwatch };
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-project/js-sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"
@@ -73,5 +73,6 @@
     "飞书项目",
     "Lark",
     "开放平台"
-  ]
+  ],
+  "license": "MIT"
 }