@paperkite/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/dist/index.d.ts +29 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -133,6 +133,12 @@ export interface ActionSpecView {
|
|
|
133
133
|
readonly config?: unknown;
|
|
134
134
|
readonly hook?: string;
|
|
135
135
|
}
|
|
136
|
+
export type StopReason = "error" | "stop" | "maxruns" | "finished";
|
|
137
|
+
export interface FlowLastStop {
|
|
138
|
+
readonly reason: StopReason;
|
|
139
|
+
readonly error?: string;
|
|
140
|
+
readonly at: string;
|
|
141
|
+
}
|
|
136
142
|
export interface FlowSnapshot {
|
|
137
143
|
readonly kind: FlowKind;
|
|
138
144
|
readonly id: string;
|
|
@@ -153,6 +159,9 @@ export interface FlowSnapshot {
|
|
|
153
159
|
readonly logFile: boolean;
|
|
154
160
|
readonly startedAt?: string;
|
|
155
161
|
readonly suspended?: FlowSuspension;
|
|
162
|
+
readonly lastStop?: FlowLastStop;
|
|
163
|
+
readonly warnings?: readonly string[];
|
|
164
|
+
readonly pendingReload?: boolean;
|
|
156
165
|
}
|
|
157
166
|
export interface FlowSuspension {
|
|
158
167
|
readonly since: string;
|
|
@@ -183,6 +192,8 @@ export interface RuntimeSnapshot {
|
|
|
183
192
|
readonly running: boolean;
|
|
184
193
|
readonly pid: number;
|
|
185
194
|
readonly uptimeSeconds: number;
|
|
195
|
+
readonly configDirty: boolean;
|
|
196
|
+
readonly flowsFile?: string;
|
|
186
197
|
readonly triggers: readonly string[];
|
|
187
198
|
readonly services: readonly string[];
|
|
188
199
|
readonly schedules: readonly string[];
|
|
@@ -234,7 +245,17 @@ export interface ServiceStoppedEvent {
|
|
|
234
245
|
readonly id: string;
|
|
235
246
|
readonly capability: string;
|
|
236
247
|
readonly session?: string;
|
|
237
|
-
readonly reason:
|
|
248
|
+
readonly reason: StopReason;
|
|
249
|
+
readonly error?: string;
|
|
250
|
+
readonly durationMs: number;
|
|
251
|
+
readonly at: string;
|
|
252
|
+
}
|
|
253
|
+
export interface TriggerStoppedEvent {
|
|
254
|
+
readonly type: "trigger.stopped";
|
|
255
|
+
readonly id: string;
|
|
256
|
+
readonly capability: string;
|
|
257
|
+
readonly session?: string;
|
|
258
|
+
readonly reason: StopReason;
|
|
238
259
|
readonly error?: string;
|
|
239
260
|
readonly durationMs: number;
|
|
240
261
|
readonly at: string;
|
|
@@ -300,7 +321,7 @@ export interface FlowResumedEvent {
|
|
|
300
321
|
readonly session: string;
|
|
301
322
|
readonly at: string;
|
|
302
323
|
}
|
|
303
|
-
export type RuntimeEvent = ActionStartedEvent | ActionFinishedEvent | ServiceStartedEvent | ServiceStoppedEvent | FlowUpdatedEvent | FlowReloadedEvent | FlowFinishedEvent | ScheduleFiredEvent | FlowsReloadingEvent | FlowsReloadedEvent | SessionStateEvent | FlowSuspendedEvent | FlowResumedEvent;
|
|
324
|
+
export type RuntimeEvent = ActionStartedEvent | ActionFinishedEvent | ServiceStartedEvent | ServiceStoppedEvent | TriggerStoppedEvent | FlowUpdatedEvent | FlowReloadedEvent | FlowFinishedEvent | ScheduleFiredEvent | FlowsReloadingEvent | FlowsReloadedEvent | SessionStateEvent | FlowSuspendedEvent | FlowResumedEvent;
|
|
304
325
|
export type RuntimeEventListener = (event: RuntimeEvent) => void;
|
|
305
326
|
export type Unsubscribe = () => void;
|
|
306
327
|
export interface FlowPatch {
|
|
@@ -330,8 +351,10 @@ export interface RuntimeControl {
|
|
|
330
351
|
listPlugins(): readonly PluginInfo[];
|
|
331
352
|
subscribe(listener: RuntimeEventListener): Unsubscribe;
|
|
332
353
|
}
|
|
354
|
+
export type ConfigValidator = (config: unknown) => readonly string[];
|
|
333
355
|
export interface CapabilityOptions {
|
|
334
356
|
readonly control?: boolean;
|
|
357
|
+
readonly validateConfig?: ConfigValidator;
|
|
335
358
|
}
|
|
336
359
|
export type ActionConstructor = new (context: ActionContext<any>) => Action<any>;
|
|
337
360
|
export type TriggerConstructor = new (context: TriggerContext<any>) => Trigger<any>;
|
|
@@ -341,12 +364,16 @@ export interface PluginCapability {
|
|
|
341
364
|
readonly name: string;
|
|
342
365
|
readonly handler?: string;
|
|
343
366
|
readonly control?: boolean;
|
|
367
|
+
/** 校验器本身,或插件模块导出的符号名(清单为 JSON 时只能写符号名)。 */
|
|
368
|
+
readonly validateConfig?: ConfigValidator | string;
|
|
344
369
|
}
|
|
345
370
|
export interface PluginInfo {
|
|
346
371
|
readonly name: string;
|
|
347
372
|
readonly version?: string;
|
|
348
373
|
readonly capabilities: readonly PluginCapability[];
|
|
349
374
|
readonly loaded: boolean;
|
|
375
|
+
/** 任一启用流程引用了该插件的能力。 */
|
|
376
|
+
readonly used: boolean;
|
|
350
377
|
}
|
|
351
378
|
export interface PluginModule {
|
|
352
379
|
readonly [handler: string]: unknown;
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgCA,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAErC,OAAO;IACP,KAAK;IAFhB,YACW,OAAe,EACf,KAAmB,EAC5B,MAAe;QAEf,KAAK,CAAC,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;uBAJpE,OAAO;qBACP,KAAK;IAIhB,CAAC;CACF;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,OAAO,KAAK,YAAY,uBAAuB,CAAC;AAClD,CAAC;AAoCD,MAAM,OAAgB,MAAM;IACK,OAAO;IAAtC,YAA+B,OAAyB;uBAAzB,OAAO;IAAqB,CAAC;IAE5D,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,MAAM,CAAC,KAAQ;QACjB,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAM,CAAC;QACtD,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;oBACrC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;oBAC3B,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;iBAC5B,CAAC,CAAC;gBACH,MAAM,QAAQ,GAAG,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAClE,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAW,CAAC;gBAC3C,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChG,IAAI,QAAQ,CAAC,IAAI;oBAAE,OAAO;YAC5B,CAAC;YACD,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;QACjC,CAAC;IACH,CAAC;CAGF;AAED,MAAM,OAAgB,OAAO;IAGI,OAAO;IAF9B,QAAQ,GAAG,CAAC,CAAC;IAErB,YAA+B,OAA0B;uBAA1B,OAAO;IAAsB,CAAC;IAE7D,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAES,KAAK,CAAC,IAAI,CAAC,KAA6C;QAChE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO;QACjD,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAES,MAAM;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IACpF,CAAC;IAES,SAAS;QACjB,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IACpF,CAAC;CAGF;AAeD,MAAM,OAAgB,OAAO;IACI,OAAO;IAAtC,YAA+B,OAA0B;uBAA1B,OAAO;IAAsB,CAAC;IAE7D,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;CAGF;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgCA,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAErC,OAAO;IACP,KAAK;IAFhB,YACW,OAAe,EACf,KAAmB,EAC5B,MAAe;QAEf,KAAK,CAAC,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;uBAJpE,OAAO;qBACP,KAAK;IAIhB,CAAC;CACF;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,OAAO,KAAK,YAAY,uBAAuB,CAAC;AAClD,CAAC;AAoCD,MAAM,OAAgB,MAAM;IACK,OAAO;IAAtC,YAA+B,OAAyB;uBAAzB,OAAO;IAAqB,CAAC;IAE5D,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,MAAM,CAAC,KAAQ;QACjB,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAM,CAAC;QACtD,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;oBACrC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;oBAC3B,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;iBAC5B,CAAC,CAAC;gBACH,MAAM,QAAQ,GAAG,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAClE,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAW,CAAC;gBAC3C,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChG,IAAI,QAAQ,CAAC,IAAI;oBAAE,OAAO;YAC5B,CAAC;YACD,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;QACjC,CAAC;IACH,CAAC;CAGF;AAED,MAAM,OAAgB,OAAO;IAGI,OAAO;IAF9B,QAAQ,GAAG,CAAC,CAAC;IAErB,YAA+B,OAA0B;uBAA1B,OAAO;IAAsB,CAAC;IAE7D,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAES,KAAK,CAAC,IAAI,CAAC,KAA6C;QAChE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO;QACjD,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAES,MAAM;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IACpF,CAAC;IAES,SAAS;QACjB,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IACpF,CAAC;CAGF;AAeD,MAAM,OAAgB,OAAO;IACI,OAAO;IAAtC,YAA+B,OAA0B;uBAA1B,OAAO;IAAsB,CAAC;IAE7D,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;CAGF;AAgUD,SAAS,mBAAmB,CAAC,MAAe,EAAE,OAAgB;IAC5D,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;YACnF,IAAI,EAAE,MAAM,CAAC,IAAI,KAAK,IAAI;SAC3B,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAChG,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,QAAQ,IAAI,KAAK,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC;AAC/F,CAAC;AAED,SAAS,WAAW,CAAC,OAAgB,EAAE,IAAa;IAClD,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACxE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,UAAU,CAAI,KAAQ;IAC7B,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC"}
|