@lark-project/js-sdk 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,10 +1,16 @@
1
1
  # Change Log
2
2
 
3
+ ## 0.1.1(2023/07/18)
4
+ - 「Refactor」移除 HostEnv、Cursor、Session
5
+
3
6
  ## 0.1.0(2023/07/18)
4
7
  - 「Add」新增 Context,替换原 HostEnv、Cursor、Session
5
8
  - 「Add」Context selectedWorkflowNode 新增 status
6
9
  - 「Add」新增 Navigation
7
10
 
11
+ ## 0.0.31(2023/07/05)
12
+ - 「Add」WorkObject getTemplateList 增加 disabled
13
+
8
14
  ## 0.0.30(2023/06/27)
9
15
  - 「Refactor」FieldType 枚举值与 OpenAPI 对齐
10
16
 
package/dist/es/index.js CHANGED
@@ -37,42 +37,8 @@ var BaseModel = class {
37
37
  };
38
38
  IMPL_KEY;
39
39
 
40
- // src/context/HostEnv.ts
41
- var _a;
42
- var HostEnv = class extends BaseModel {
43
- /**
44
- * 当前区域
45
- */
46
- // abstract locale: Locale;
47
- };
48
- _a = IMPL_KEY;
49
- /**
50
- * @internal
51
- */
52
- HostEnv[_a] = "hostEnv";
53
-
54
- // src/context/Session.ts
55
- var _a2;
56
- var Session = class extends BaseModel {
57
- };
58
- _a2 = IMPL_KEY;
59
- /**
60
- * @internal
61
- */
62
- Session[_a2] = "session";
63
-
64
- // src/context/Cursor.ts
65
- var _a3;
66
- var Cursor = class extends BaseModel {
67
- };
68
- _a3 = IMPL_KEY;
69
- /**
70
- * @internal
71
- */
72
- Cursor[_a3] = "cursor";
73
-
74
40
  // src/context/index.ts
75
- var _a4;
41
+ var _a;
76
42
  var Context = class extends BaseModel {
77
43
  /**
78
44
  * 加载上下文
@@ -81,14 +47,14 @@ var Context = class extends BaseModel {
81
47
  throw new Error("not implemented");
82
48
  }
83
49
  };
84
- _a4 = IMPL_KEY;
50
+ _a = IMPL_KEY;
85
51
  /**
86
52
  * @internal
87
53
  */
88
- Context[_a4] = "Context";
54
+ Context[_a] = "Context";
89
55
 
90
56
  // src/model/Space.ts
91
- var _a5;
57
+ var _a2;
92
58
  var Space = class extends BaseModel {
93
59
  /**
94
60
  * 加载空间模型
@@ -105,14 +71,14 @@ var Space = class extends BaseModel {
105
71
  // */
106
72
  // abstract watch(callback: (next: Space) => void): unwatch;
107
73
  };
108
- _a5 = IMPL_KEY;
74
+ _a2 = IMPL_KEY;
109
75
  /**
110
76
  * @internal
111
77
  */
112
- Space[_a5] = "Space";
78
+ Space[_a2] = "Space";
113
79
 
114
80
  // src/model/WorkObject.ts
115
- var _a6;
81
+ var _a3;
116
82
  var WorkObject = class extends BaseModel {
117
83
  /**
118
84
  * 加载工作项对象模型
@@ -130,14 +96,14 @@ var WorkObject = class extends BaseModel {
130
96
  // */
131
97
  // abstract watch(callback: (next: WorkObject) => void): unwatch;
132
98
  };
133
- _a6 = IMPL_KEY;
99
+ _a3 = IMPL_KEY;
134
100
  /**
135
101
  * @internal
136
102
  */
137
- WorkObject[_a6] = "WorkObject";
103
+ WorkObject[_a3] = "WorkObject";
138
104
 
139
105
  // src/model/WorkItem.ts
140
- var _a7;
106
+ var _a4;
141
107
  var WorkItem = class extends BaseModel {
142
108
  /**
143
109
  * 加载工作项实例模型
@@ -151,14 +117,14 @@ var WorkItem = class extends BaseModel {
151
117
  throw new Error("not implemented");
152
118
  }
153
119
  };
154
- _a7 = IMPL_KEY;
120
+ _a4 = IMPL_KEY;
155
121
  /**
156
122
  * @internal
157
123
  */
158
- WorkItem[_a7] = "WorkItem";
124
+ WorkItem[_a4] = "WorkItem";
159
125
 
160
126
  // src/model/Field.ts
161
- var _a8;
127
+ var _a5;
162
128
  var Field = class extends BaseModel {
163
129
  /**
164
130
  * 加载字段模型
@@ -176,14 +142,14 @@ var Field = class extends BaseModel {
176
142
  */
177
143
  // abstract getAdvancedConfig<T extends FieldType>(): AdvancedConfigs[T];
178
144
  };
179
- _a8 = IMPL_KEY;
145
+ _a5 = IMPL_KEY;
180
146
  /**
181
147
  * @internal
182
148
  */
183
- Field[_a8] = "Field";
149
+ Field[_a5] = "Field";
184
150
 
185
151
  // src/biz/Navigation.ts
186
- var _a9;
152
+ var _a6;
187
153
  var Navigation = class extends BaseModel {
188
154
  /**
189
155
  * @internal
@@ -192,11 +158,11 @@ var Navigation = class extends BaseModel {
192
158
  throw new Error("not implemented");
193
159
  }
194
160
  };
195
- _a9 = IMPL_KEY;
161
+ _a6 = IMPL_KEY;
196
162
  /**
197
163
  * @internal
198
164
  */
199
- Navigation[_a9] = "navigation";
165
+ Navigation[_a6] = "navigation";
200
166
 
201
167
  // src/client.ts
202
168
  function getImplClass(decl, impls) {
@@ -206,30 +172,6 @@ function getImplValue(decl, impls) {
206
172
  return impls == null ? void 0 : impls[decl[IMPL_KEY]];
207
173
  }
208
174
  var _SDKClient = class {
209
- /**
210
- * 宿主环境
211
- *
212
- * @deprecated 请用 {@link Context} 替代
213
- */
214
- get hostEnv() {
215
- return getImplValue(HostEnv, this._meegoBizHub);
216
- }
217
- /**
218
- * 当前会话状态,如当前登录用户
219
- *
220
- * @deprecated 请用 {@link Context} 替代
221
- */
222
- get session() {
223
- return getImplValue(Session, this._meegoBizHub);
224
- }
225
- /**
226
- * 当前页面状态集合,如详情页选中的节点
227
- *
228
- * @deprecated 请用 {@link Context} 替代
229
- */
230
- get cursor() {
231
- return getImplValue(Cursor, this._meegoBizHub);
232
- }
233
175
  /**
234
176
  * 应用导航
235
177
  */
@@ -292,7 +234,7 @@ var SDKClient = _SDKClient;
292
234
  /**
293
235
  * SDK 版本号
294
236
  */
295
- SDKClient.version = "0.1.0";
237
+ SDKClient.version = "0.1.1";
296
238
 
297
239
  // src/types/biz.ts
298
240
  var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -410,11 +352,9 @@ export {
410
352
  AttributeType,
411
353
  ButtonScene,
412
354
  Context,
413
- Cursor,
414
355
  Field,
415
356
  FieldType,
416
357
  FlowMode,
417
- HostEnv,
418
358
  IMPL_KEY,
419
359
  InterceptionEvent,
420
360
  InternalError,
@@ -424,7 +364,6 @@ export {
424
364
  NodeStatus,
425
365
  NotFoundError,
426
366
  SDKClient,
427
- Session,
428
367
  Space,
429
368
  WorkItem,
430
369
  WorkObject,
package/dist/lib/index.js CHANGED
@@ -51,11 +51,9 @@ __export(src_exports, {
51
51
  AttributeType: () => AttributeType,
52
52
  ButtonScene: () => ButtonScene,
53
53
  Context: () => Context,
54
- Cursor: () => Cursor,
55
54
  Field: () => Field,
56
55
  FieldType: () => FieldType,
57
56
  FlowMode: () => FlowMode,
58
- HostEnv: () => HostEnv,
59
57
  IMPL_KEY: () => IMPL_KEY,
60
58
  InterceptionEvent: () => InterceptionEvent,
61
59
  InternalError: () => InternalError,
@@ -65,7 +63,6 @@ __export(src_exports, {
65
63
  NodeStatus: () => NodeStatus,
66
64
  NotFoundError: () => NotFoundError,
67
65
  SDKClient: () => SDKClient,
68
- Session: () => Session,
69
66
  Space: () => Space,
70
67
  WorkItem: () => WorkItem,
71
68
  WorkObject: () => WorkObject,
@@ -82,42 +79,8 @@ var BaseModel = class {
82
79
  };
83
80
  IMPL_KEY;
84
81
 
85
- // src/context/HostEnv.ts
86
- var _a;
87
- var HostEnv = class extends BaseModel {
88
- /**
89
- * 当前区域
90
- */
91
- // abstract locale: Locale;
92
- };
93
- _a = IMPL_KEY;
94
- /**
95
- * @internal
96
- */
97
- HostEnv[_a] = "hostEnv";
98
-
99
- // src/context/Session.ts
100
- var _a2;
101
- var Session = class extends BaseModel {
102
- };
103
- _a2 = IMPL_KEY;
104
- /**
105
- * @internal
106
- */
107
- Session[_a2] = "session";
108
-
109
- // src/context/Cursor.ts
110
- var _a3;
111
- var Cursor = class extends BaseModel {
112
- };
113
- _a3 = IMPL_KEY;
114
- /**
115
- * @internal
116
- */
117
- Cursor[_a3] = "cursor";
118
-
119
82
  // src/context/index.ts
120
- var _a4;
83
+ var _a;
121
84
  var Context = class extends BaseModel {
122
85
  /**
123
86
  * 加载上下文
@@ -126,14 +89,14 @@ var Context = class extends BaseModel {
126
89
  throw new Error("not implemented");
127
90
  }
128
91
  };
129
- _a4 = IMPL_KEY;
92
+ _a = IMPL_KEY;
130
93
  /**
131
94
  * @internal
132
95
  */
133
- Context[_a4] = "Context";
96
+ Context[_a] = "Context";
134
97
 
135
98
  // src/model/Space.ts
136
- var _a5;
99
+ var _a2;
137
100
  var Space = class extends BaseModel {
138
101
  /**
139
102
  * 加载空间模型
@@ -150,14 +113,14 @@ var Space = class extends BaseModel {
150
113
  // */
151
114
  // abstract watch(callback: (next: Space) => void): unwatch;
152
115
  };
153
- _a5 = IMPL_KEY;
116
+ _a2 = IMPL_KEY;
154
117
  /**
155
118
  * @internal
156
119
  */
157
- Space[_a5] = "Space";
120
+ Space[_a2] = "Space";
158
121
 
159
122
  // src/model/WorkObject.ts
160
- var _a6;
123
+ var _a3;
161
124
  var WorkObject = class extends BaseModel {
162
125
  /**
163
126
  * 加载工作项对象模型
@@ -175,14 +138,14 @@ var WorkObject = class extends BaseModel {
175
138
  // */
176
139
  // abstract watch(callback: (next: WorkObject) => void): unwatch;
177
140
  };
178
- _a6 = IMPL_KEY;
141
+ _a3 = IMPL_KEY;
179
142
  /**
180
143
  * @internal
181
144
  */
182
- WorkObject[_a6] = "WorkObject";
145
+ WorkObject[_a3] = "WorkObject";
183
146
 
184
147
  // src/model/WorkItem.ts
185
- var _a7;
148
+ var _a4;
186
149
  var WorkItem = class extends BaseModel {
187
150
  /**
188
151
  * 加载工作项实例模型
@@ -196,14 +159,14 @@ var WorkItem = class extends BaseModel {
196
159
  throw new Error("not implemented");
197
160
  }
198
161
  };
199
- _a7 = IMPL_KEY;
162
+ _a4 = IMPL_KEY;
200
163
  /**
201
164
  * @internal
202
165
  */
203
- WorkItem[_a7] = "WorkItem";
166
+ WorkItem[_a4] = "WorkItem";
204
167
 
205
168
  // src/model/Field.ts
206
- var _a8;
169
+ var _a5;
207
170
  var Field = class extends BaseModel {
208
171
  /**
209
172
  * 加载字段模型
@@ -221,14 +184,14 @@ var Field = class extends BaseModel {
221
184
  */
222
185
  // abstract getAdvancedConfig<T extends FieldType>(): AdvancedConfigs[T];
223
186
  };
224
- _a8 = IMPL_KEY;
187
+ _a5 = IMPL_KEY;
225
188
  /**
226
189
  * @internal
227
190
  */
228
- Field[_a8] = "Field";
191
+ Field[_a5] = "Field";
229
192
 
230
193
  // src/biz/Navigation.ts
231
- var _a9;
194
+ var _a6;
232
195
  var Navigation = class extends BaseModel {
233
196
  /**
234
197
  * @internal
@@ -237,11 +200,11 @@ var Navigation = class extends BaseModel {
237
200
  throw new Error("not implemented");
238
201
  }
239
202
  };
240
- _a9 = IMPL_KEY;
203
+ _a6 = IMPL_KEY;
241
204
  /**
242
205
  * @internal
243
206
  */
244
- Navigation[_a9] = "navigation";
207
+ Navigation[_a6] = "navigation";
245
208
 
246
209
  // src/client.ts
247
210
  function getImplClass(decl, impls) {
@@ -251,30 +214,6 @@ function getImplValue(decl, impls) {
251
214
  return impls == null ? void 0 : impls[decl[IMPL_KEY]];
252
215
  }
253
216
  var _SDKClient = class {
254
- /**
255
- * 宿主环境
256
- *
257
- * @deprecated 请用 {@link Context} 替代
258
- */
259
- get hostEnv() {
260
- return getImplValue(HostEnv, this._meegoBizHub);
261
- }
262
- /**
263
- * 当前会话状态,如当前登录用户
264
- *
265
- * @deprecated 请用 {@link Context} 替代
266
- */
267
- get session() {
268
- return getImplValue(Session, this._meegoBizHub);
269
- }
270
- /**
271
- * 当前页面状态集合,如详情页选中的节点
272
- *
273
- * @deprecated 请用 {@link Context} 替代
274
- */
275
- get cursor() {
276
- return getImplValue(Cursor, this._meegoBizHub);
277
- }
278
217
  /**
279
218
  * 应用导航
280
219
  */
@@ -337,7 +276,7 @@ var SDKClient = _SDKClient;
337
276
  /**
338
277
  * SDK 版本号
339
278
  */
340
- SDKClient.version = "0.1.0";
279
+ SDKClient.version = "0.1.1";
341
280
 
342
281
  // src/types/biz.ts
343
282
  var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -456,11 +395,9 @@ var src_default = SDKClient;
456
395
  AttributeType,
457
396
  ButtonScene,
458
397
  Context,
459
- Cursor,
460
398
  Field,
461
399
  FieldType,
462
400
  FlowMode,
463
- HostEnv,
464
401
  IMPL_KEY,
465
402
  InterceptionEvent,
466
403
  InternalError,
@@ -470,7 +407,6 @@ var src_default = SDKClient;
470
407
  NodeStatus,
471
408
  NotFoundError,
472
409
  SDKClient,
473
- Session,
474
410
  Space,
475
411
  WorkItem,
476
412
  WorkObject
@@ -183,12 +183,25 @@ type BriefWorkItem = {
183
183
  };
184
184
  /**
185
185
  * @public
186
- * 模板(仅含关键属性)
186
+ * 工作项模板(仅含关键属性)
187
187
  */
188
188
  interface BriefTemplate {
189
+ /**
190
+ * 工作项模板唯一标识
191
+ */
189
192
  id: number;
193
+ /**
194
+ * 工作项模板名称
195
+ */
190
196
  name: string;
197
+ /**
198
+ * 流程模式
199
+ */
191
200
  flowMode: FlowMode;
201
+ /**
202
+ * 模板已禁用
203
+ */
204
+ disabled: boolean;
192
205
  }
193
206
  /**
194
207
  * @public
@@ -449,78 +462,6 @@ declare abstract class BaseModel {
449
462
  protected static [IMPL_KEY]: string;
450
463
  }
451
464
 
452
- /**
453
- * 区域
454
- */
455
- /**
456
- * @public
457
- * 宿主环境信息
458
- *
459
- * @deprecated 请用 {@link Context} 替代
460
- */
461
- declare abstract class HostEnv extends BaseModel {
462
- /**
463
- * @internal
464
- */
465
- protected static [IMPL_KEY]: string;
466
- /**
467
- * 当前语言
468
- */
469
- abstract language: Language;
470
- }
471
-
472
- /**
473
- * @public
474
- * 当前会话状态
475
- *
476
- * @deprecated 请用 {@link Context} 替代
477
- */
478
- declare abstract class Session extends BaseModel {
479
- /**
480
- * @internal
481
- */
482
- protected static [IMPL_KEY]: string;
483
- /**
484
- * 当前登录用户信息
485
- */
486
- abstract user: User;
487
- }
488
-
489
- /**
490
- * @public
491
- * 当前页面状态集合
492
- *
493
- * @deprecated 请用 {@link Context} 替代
494
- */
495
- declare abstract class Cursor extends BaseModel {
496
- /**
497
- * @internal
498
- */
499
- protected static [IMPL_KEY]: string;
500
- /**
501
- * 主空间信息(左侧导航栏选中的空间)
502
- */
503
- abstract mainSpace?: BriefSpace;
504
- /**
505
- * 详情页的状态
506
- */
507
- abstract detailPage?: {
508
- /**
509
- * 激活工作项
510
- */
511
- activeWorkItem?: BriefWorkItem;
512
- /**
513
- * 当前选中的工作流节点
514
- */
515
- selectedWorkflowNode?: BriefNode;
516
- };
517
- /**
518
- * 监听 Cursor 变化,目前仅在 Web 端 mainSpace、detailPage.activeWorkItem、detailPage.selectedWorkflowNode 变化时触发回调
519
- * @param callback
520
- */
521
- abstract watch(callback: (nextValue: Cursor) => void): unwatch;
522
- }
523
-
524
465
  /**
525
466
  * @public
526
467
  * 应用上下文/状态
@@ -849,24 +790,6 @@ declare class SDKClient {
849
790
  * SDK 版本号
850
791
  */
851
792
  static version: string;
852
- /**
853
- * 宿主环境
854
- *
855
- * @deprecated 请用 {@link Context} 替代
856
- */
857
- get hostEnv(): HostEnv;
858
- /**
859
- * 当前会话状态,如当前登录用户
860
- *
861
- * @deprecated 请用 {@link Context} 替代
862
- */
863
- get session(): Session;
864
- /**
865
- * 当前页面状态集合,如详情页选中的节点
866
- *
867
- * @deprecated 请用 {@link Context} 替代
868
- */
869
- get cursor(): Cursor;
870
793
  /**
871
794
  * 应用导航
872
795
  */
@@ -953,4 +876,4 @@ declare class NotFoundError extends CustomError {
953
876
  * @packageDocumentation
954
877
  */
955
878
 
956
- 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 };
879
+ 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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lark-project/js-sdk",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "runtimeMinVersions": {
5
5
  "web": "2.1.0",
6
6
  "mobile": "1.1.0"
@@ -73,5 +73,6 @@
73
73
  "飞书项目",
74
74
  "Lark",
75
75
  "开放平台"
76
- ]
76
+ ],
77
+ "license": "MIT"
77
78
  }