@lark-project/js-sdk 0.0.30-alpha.0 → 0.1.0-alpha.0

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.
Files changed (4) hide show
  1. package/dist/es/index.js +25 -59
  2. package/dist/lib/index.js +26 -62
  3. package/dist/types/index.d.ts +42 -76
  4. package/package.json +1 -1
package/dist/es/index.js CHANGED
@@ -37,42 +37,25 @@ var BaseModel = class {
37
37
  };
38
38
  IMPL_KEY;
39
39
 
40
- // src/context/HostEnv.ts
40
+ // src/context/index.ts
41
41
  var _a;
42
- var HostEnv = class extends BaseModel {
42
+ var Context = class extends BaseModel {
43
43
  /**
44
- * 当前区域
44
+ * 加载上下文
45
45
  */
46
- // abstract locale: Locale;
46
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
47
+ static load() {
48
+ throw new Error("not implemented");
49
+ }
47
50
  };
48
51
  _a = IMPL_KEY;
49
52
  /**
50
53
  * @internal
51
54
  */
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";
55
+ Context[_a] = "Context";
73
56
 
74
57
  // src/model/Space.ts
75
- var _a4;
58
+ var _a2;
76
59
  var Space = class extends BaseModel {
77
60
  /**
78
61
  * 加载空间模型
@@ -89,14 +72,14 @@ var Space = class extends BaseModel {
89
72
  // */
90
73
  // abstract watch(callback: (next: Space) => void): unwatch;
91
74
  };
92
- _a4 = IMPL_KEY;
75
+ _a2 = IMPL_KEY;
93
76
  /**
94
77
  * @internal
95
78
  */
96
- Space[_a4] = "Space";
79
+ Space[_a2] = "Space";
97
80
 
98
81
  // src/model/WorkObject.ts
99
- var _a5;
82
+ var _a3;
100
83
  var WorkObject = class extends BaseModel {
101
84
  /**
102
85
  * 加载工作项对象模型
@@ -114,14 +97,14 @@ var WorkObject = class extends BaseModel {
114
97
  // */
115
98
  // abstract watch(callback: (next: WorkObject) => void): unwatch;
116
99
  };
117
- _a5 = IMPL_KEY;
100
+ _a3 = IMPL_KEY;
118
101
  /**
119
102
  * @internal
120
103
  */
121
- WorkObject[_a5] = "WorkObject";
104
+ WorkObject[_a3] = "WorkObject";
122
105
 
123
106
  // src/model/WorkItem.ts
124
- var _a6;
107
+ var _a4;
125
108
  var WorkItem = class extends BaseModel {
126
109
  /**
127
110
  * 加载工作项实例模型
@@ -135,14 +118,14 @@ var WorkItem = class extends BaseModel {
135
118
  throw new Error("not implemented");
136
119
  }
137
120
  };
138
- _a6 = IMPL_KEY;
121
+ _a4 = IMPL_KEY;
139
122
  /**
140
123
  * @internal
141
124
  */
142
- WorkItem[_a6] = "WorkItem";
125
+ WorkItem[_a4] = "WorkItem";
143
126
 
144
127
  // src/model/Field.ts
145
- var _a7;
128
+ var _a5;
146
129
  var Field = class extends BaseModel {
147
130
  /**
148
131
  * 加载字段模型
@@ -160,37 +143,22 @@ var Field = class extends BaseModel {
160
143
  */
161
144
  // abstract getAdvancedConfig<T extends FieldType>(): AdvancedConfigs[T];
162
145
  };
163
- _a7 = IMPL_KEY;
146
+ _a5 = IMPL_KEY;
164
147
  /**
165
148
  * @internal
166
149
  */
167
- Field[_a7] = "Field";
150
+ Field[_a5] = "Field";
168
151
 
169
152
  // src/client.ts
170
153
  function getImplClass(decl, impls) {
171
154
  return impls == null ? void 0 : impls[decl[IMPL_KEY]];
172
155
  }
173
- function getImplValue(decl, impls) {
174
- return impls == null ? void 0 : impls[decl[IMPL_KEY]];
175
- }
176
156
  var _SDKClient = class {
177
157
  /**
178
- * 宿主环境
179
- */
180
- get hostEnv() {
181
- return getImplValue(HostEnv, this._meegoBizHub);
182
- }
183
- /**
184
- * 当前会话状态，如当前登录用户
185
- */
186
- get session() {
187
- return getImplValue(Session, this._meegoBizHub);
188
- }
189
- /**
190
- * 当前页面状态集合，如详情页选中的节点
158
+ * 应用上下文
191
159
  */
192
- get cursor() {
193
- return getImplValue(Cursor, this._meegoBizHub);
160
+ get Context() {
161
+ return getImplClass(Context, this._meegoBizHub);
194
162
  }
195
163
  /**
196
164
  * 空间
@@ -242,7 +210,7 @@ var SDKClient = _SDKClient;
242
210
  /**
243
211
  * SDK 版本号
244
212
  */
245
- SDKClient.version = "0.0.30-alpha.0";
213
+ SDKClient.version = "0.1.0-alpha.0";
246
214
 
247
215
  // src/types/biz.ts
248
216
  var FieldType = /* @__PURE__ */ ((FieldType2) => {
@@ -347,11 +315,10 @@ var NotFoundError = class extends CustomError {
347
315
  var src_default = SDKClient;
348
316
  export {
349
317
  ButtonScene,
350
- Cursor,
318
+ Context,
351
319
  Field,
352
320
  FieldType,
353
321
  FlowMode,
354
- HostEnv,
355
322
  IMPL_KEY,
356
323
  InterceptionEvent,
357
324
  InternalError,
@@ -359,7 +326,6 @@ export {
359
326
  NoAuthError,
360
327
  NotFoundError,
361
328
  SDKClient,
362
- Session,
363
329
  Space,
364
330
  WorkItem,
365
331
  WorkObject,
package/dist/lib/index.js CHANGED
@@ -49,11 +49,10 @@ var __async = (__this, __arguments, generator) => {
49
49
  var src_exports = {};
50
50
  __export(src_exports, {
51
51
  ButtonScene: () => ButtonScene,
52
- Cursor: () => Cursor,
52
+ Context: () => Context,
53
53
  Field: () => Field,
54
54
  FieldType: () => FieldType,
55
55
  FlowMode: () => FlowMode,
56
- HostEnv: () => HostEnv,
57
56
  IMPL_KEY: () => IMPL_KEY,
58
57
  InterceptionEvent: () => InterceptionEvent,
59
58
  InternalError: () => InternalError,
@@ -61,7 +60,6 @@ __export(src_exports, {
61
60
  NoAuthError: () => NoAuthError,
62
61
  NotFoundError: () => NotFoundError,
63
62
  SDKClient: () => SDKClient,
64
- Session: () => Session,
65
63
  Space: () => Space,
66
64
  WorkItem: () => WorkItem,
67
65
  WorkObject: () => WorkObject,
@@ -78,42 +76,25 @@ var BaseModel = class {
78
76
  };
79
77
  IMPL_KEY;
80
78
 
81
- // src/context/HostEnv.ts
79
+ // src/context/index.ts
82
80
  var _a;
83
- var HostEnv = class extends BaseModel {
81
+ var Context = class extends BaseModel {
84
82
  /**
85
- * 当前区域
83
+ * 加载上下文
86
84
  */
87
- // abstract locale: Locale;
85
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
86
+ static load() {
87
+ throw new Error("not implemented");
88
+ }
88
89
  };
89
90
  _a = IMPL_KEY;
90
91
  /**
91
92
  * @internal
92
93
  */
93
- HostEnv[_a] = "hostEnv";
94
-
95
- // src/context/Session.ts
96
- var _a2;
97
- var Session = class extends BaseModel {
98
- };
99
- _a2 = IMPL_KEY;
100
- /**
101
- * @internal
102
- */
103
- Session[_a2] = "session";
104
-
105
- // src/context/Cursor.ts
106
- var _a3;
107
- var Cursor = class extends BaseModel {
108
- };
109
- _a3 = IMPL_KEY;
110
- /**
111
- * @internal
112
- */
113
- Cursor[_a3] = "cursor";
94
+ Context[_a] = "Context";
114
95
 
115
96
  // src/model/Space.ts
116
- var _a4;
97
+ var _a2;
117
98
  var Space = class extends BaseModel {
118
99
  /**
119
100
  * 加载空间模型
@@ -130,14 +111,14 @@ var Space = class extends BaseModel {
130
111
  // */
131
112
  // abstract watch(callback: (next: Space) => void): unwatch;
132
113
  };
133
- _a4 = IMPL_KEY;
114
+ _a2 = IMPL_KEY;
134
115
  /**
135
116
  * @internal
136
117
  */
137
- Space[_a4] = "Space";
118
+ Space[_a2] = "Space";
138
119
 
139
120
  // src/model/WorkObject.ts
140
- var _a5;
121
+ var _a3;
141
122
  var WorkObject = class extends BaseModel {
142
123
  /**
143
124
  * 加载工作项对象模型
@@ -155,14 +136,14 @@ var WorkObject = class extends BaseModel {
155
136
  // */
156
137
  // abstract watch(callback: (next: WorkObject) => void): unwatch;
157
138
  };
158
- _a5 = IMPL_KEY;
139
+ _a3 = IMPL_KEY;
159
140
  /**
160
141
  * @internal
161
142
  */
162
- WorkObject[_a5] = "WorkObject";
143
+ WorkObject[_a3] = "WorkObject";
163
144
 
164
145
  // src/model/WorkItem.ts
165
- var _a6;
146
+ var _a4;
166
147
  var WorkItem = class extends BaseModel {
167
148
  /**
168
149
  * 加载工作项实例模型
@@ -176,14 +157,14 @@ var WorkItem = class extends BaseModel {
176
157
  throw new Error("not implemented");
177
158
  }
178
159
  };
179
- _a6 = IMPL_KEY;
160
+ _a4 = IMPL_KEY;
180
161
  /**
181
162
  * @internal
182
163
  */
183
- WorkItem[_a6] = "WorkItem";
164
+ WorkItem[_a4] = "WorkItem";
184
165
 
185
166
  // src/model/Field.ts
186
- var _a7;
167
+ var _a5;
187
168
  var Field = class extends BaseModel {
188
169
  /**
189
170
  * 加载字段模型
@@ -201,37 +182,22 @@ var Field = class extends BaseModel {
201
182
  */
202
183
  // abstract getAdvancedConfig<T extends FieldType>(): AdvancedConfigs[T];
203
184
  };
204
- _a7 = IMPL_KEY;
185
+ _a5 = IMPL_KEY;
205
186
  /**
206
187
  * @internal
207
188
  */
208
- Field[_a7] = "Field";
189
+ Field[_a5] = "Field";
209
190
 
210
191
  // src/client.ts
211
192
  function getImplClass(decl, impls) {
212
193
  return impls == null ? void 0 : impls[decl[IMPL_KEY]];
213
194
  }
214
- function getImplValue(decl, impls) {
215
- return impls == null ? void 0 : impls[decl[IMPL_KEY]];
216
- }
217
195
  var _SDKClient = class {
218
196
  /**
219
- * 宿主环境
220
- */
221
- get hostEnv() {
222
- return getImplValue(HostEnv, this._meegoBizHub);
223
- }
224
- /**
225
- * 当前会话状态，如当前登录用户
226
- */
227
- get session() {
228
- return getImplValue(Session, this._meegoBizHub);
229
- }
230
- /**
231
- * 当前页面状态集合，如详情页选中的节点
197
+ * 应用上下文
232
198
  */
233
- get cursor() {
234
- return getImplValue(Cursor, this._meegoBizHub);
199
+ get Context() {
200
+ return getImplClass(Context, this._meegoBizHub);
235
201
  }
236
202
  /**
237
203
  * 空间
@@ -283,7 +249,7 @@ var SDKClient = _SDKClient;
283
249
  /**
284
250
  * SDK 版本号
285
251
  */
286
- SDKClient.version = "0.0.30-alpha.0";
252
+ SDKClient.version = "0.1.0-alpha.0";
287
253
 
288
254
  // src/types/biz.ts
289
255
  var FieldType = /* @__PURE__ */ ((FieldType2) => {
@@ -389,11 +355,10 @@ var src_default = SDKClient;
389
355
  // Annotate the CommonJS export names for ESM import in node:
390
356
  0 && (module.exports = {
391
357
  ButtonScene,
392
- Cursor,
358
+ Context,
393
359
  Field,
394
360
  FieldType,
395
361
  FlowMode,
396
- HostEnv,
397
362
  IMPL_KEY,
398
363
  InterceptionEvent,
399
364
  InternalError,
@@ -401,7 +366,6 @@ var src_default = SDKClient;
401
366
  NoAuthError,
402
367
  NotFoundError,
403
368
  SDKClient,
404
- Session,
405
369
  Space,
406
370
  WorkItem,
407
371
  WorkObject
package/dist/types/index.d.ts CHANGED
@@ -1,43 +1,3 @@
1
- /**
2
- * @internal
3
- */
4
- declare const MEEGO_BIZ_HUB = "__MEEGO_BIZ_HUB__";
5
- /**
6
- * @internal
7
- * 每个声明的抽象类都必须实现这个属性，用于唯一标识
8
- */
9
- declare const IMPL_KEY = "__MEEGO_SDK_IMPL_KEY__";
10
-
11
- /**
12
- * @internal
13
- */
14
- declare abstract class BaseModel {
15
- protected static [IMPL_KEY]: string;
16
- }
17
-
18
- /**
19
- * @public
20
- * 语言
21
- */
22
- type Language = 'zh_CN' | 'en_US';
23
- /**
24
- * 区域
25
- */
26
- /**
27
- * @public
28
- * 宿主环境信息
29
- */
30
- declare abstract class HostEnv extends BaseModel {
31
- /**
32
- * @internal
33
- */
34
- protected static [IMPL_KEY]: string;
35
- /**
36
- * 当前语言
37
- */
38
- abstract language: Language;
39
- }
40
-
41
1
  /**
42
2
  * @public
43
3
  * 用户信息
@@ -288,6 +248,11 @@ interface BriefNode {
288
248
  * 视图（仅含关键属性）
289
249
  */
290
250
  type BriefView = any;
251
+ /**
252
+ * @public
253
+ * 语言
254
+ */
255
+ type Language = 'zh_CN' | 'en_US';
291
256
 
292
257
  /**
293
258
  * 集成构成
@@ -436,51 +401,60 @@ interface InterceptionFeatureContext {
436
401
  type unwatch = () => void;
437
402
 
438
403
  /**
439
- * @public
440
- * 当前会话状态
404
+ * @internal
441
405
  */
442
- declare abstract class Session extends BaseModel {
443
- /**
444
- * @internal
445
- */
406
+ declare const MEEGO_BIZ_HUB = "__MEEGO_BIZ_HUB__";
407
+ /**
408
+ * @internal
409
+ * 每个声明的抽象类都必须实现这个属性，用于唯一标识
410
+ */
411
+ declare const IMPL_KEY = "__MEEGO_SDK_IMPL_KEY__";
412
+
413
+ /**
414
+ * @internal
415
+ */
416
+ declare abstract class BaseModel {
446
417
  protected static [IMPL_KEY]: string;
447
- /**
448
- * 当前登录用户信息
449
- */
450
- abstract user: User;
451
418
  }
452
419
 
453
420
  /**
454
421
  * @public
455
- * 当前页面状态集合
422
+ * 应用上下文/状态
456
423
  */
457
- declare abstract class Cursor extends BaseModel {
424
+ declare abstract class Context extends BaseModel {
458
425
  /**
459
426
  * @internal
460
427
  */
461
428
  protected static [IMPL_KEY]: string;
429
+ /**
430
+ * 加载上下文
431
+ */
432
+ static load(): Promise<Context>;
433
+ /**
434
+ * 当前语言
435
+ */
436
+ abstract language: Language;
437
+ /**
438
+ * 当前登录用户信息
439
+ */
440
+ abstract loginUser: User;
462
441
  /**
463
442
  * 主空间信息（左侧导航栏选中的空间）
464
443
  */
465
444
  abstract mainSpace?: BriefSpace;
466
445
  /**
467
- * 详情页的状态
446
+ * 当前打开的工作项（仅工作项详情页可用）
447
+ */
448
+ abstract activeWorkItem?: BriefWorkItem;
449
+ /**
450
+ * 当前选中的工作流节点（仅工作项详情页可用）
468
451
  */
469
- abstract detailPage?: {
470
- /**
471
- * 激活工作项
472
- */
473
- activeWorkItem?: BriefWorkItem;
474
- /**
475
- * 当前选中的工作流节点
476
- */
477
- selectedWorkflowNode?: BriefNode;
478
- };
452
+ abstract selectedWorkflowNode?: BriefNode;
479
453
  /**
480
- * 监听 Cursor 变化，目前仅在 Web 端 mainSpace、detailPage.activeWorkItem、detailPage.selectedWorkflowNode 变化时触发回调
454
+ * 监听 Context 变化，目前仅在 Web 端 mainSpace、activeWorkItem、selectedWorkflowNode 变化时触发回调
481
455
  * @param callback
482
456
  */
483
- abstract watch(callback: (nextValue: Cursor) => void): unwatch;
457
+ abstract watch(callback: (nextValue: Context) => void): unwatch;
484
458
  }
485
459
 
486
460
  /**
@@ -711,17 +685,9 @@ declare class SDKClient {
711
685
  */
712
686
  static version: string;
713
687
  /**
714
- * 宿主环境
715
- */
716
- get hostEnv(): HostEnv;
717
- /**
718
- * 当前会话状态，如当前登录用户
719
- */
720
- get session(): Session;
721
- /**
722
- * 当前页面状态集合，如详情页选中的节点
688
+ * 应用上下文
723
689
  */
724
- get cursor(): Cursor;
690
+ get Context(): typeof Context;
725
691
  /**
726
692
  * 空间
727
693
  */
@@ -800,4 +766,4 @@ declare class NotFoundError extends CustomError {
800
766
  * @packageDocumentation
801
767
  */
802
768
 
803
- export { BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, ButtonFeatureContext, ButtonScene, ControlFeatureContext, Cursor, Field, FieldType, FlowMode, HostEnv, IMPL_KEY, IntegrationFeatureContext, InterceptionEvent, InterceptionFeatureContext, InternalError, Language, MEEGO_BIZ_HUB, NoAuthError, NotFoundError, PageFeatureContext, Role, RoleOwners, SDKClient, SDKClientOptions, Session, Space, TabFeatureContext, User, ViewFeatureContext, WorkItem, WorkObject, SDKClient as default, unwatch };
769
+ export { 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, NoAuthError, NotFoundError, PageFeatureContext, Role, RoleOwners, SDKClient, SDKClientOptions, Space, TabFeatureContext, User, ViewFeatureContext, WorkItem, 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.0.30-alpha.0",
3
+ "version": "0.1.0-alpha.0",
4
4
  "runtimeMinVersions": {
5
5
  "web": "2.1.0",
6
6
  "mobile": "1.1.0"