@jumoo/processing 17.4.3-prerelease.2 → 17.4.3-prerelease.3

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.
@@ -1,3 +1,3 @@
1
1
  export { client, type CreateClientConfig } from './client.gen';
2
2
  export { type Options, PipelinesService, QueuesService } from './sdk.gen';
3
- export { type ClearPipelineData, type ClearPipelineError, type ClearPipelineErrors, type ClearPipelineResponses, type ClientOptions, type CreatePipelineData, type CreatePipelineError, type CreatePipelineErrors, type CreatePipelineResponse, type CreatePipelineResponses, type DeleteData, type DeleteError, type DeleteErrors, type DeleteResponses, type GetPipelineData, type GetPipelineError, type GetPipelineErrors, type GetPipelineResponse, type GetPipelineResponses, type GetProcessorsData, type GetProcessorsError, type GetProcessorsErrors, type GetProcessorsResponse, type GetProcessorsResponses, type GetResultsData, type GetResultsError, type GetResultsErrors, type GetResultsResponse, type GetResultsResponses, type ListPipelinesByStrategyData, type ListPipelinesByStrategyError, type ListPipelinesByStrategyErrors, type ListPipelinesByStrategyResponse, type ListPipelinesByStrategyResponses, type ListPipelinesData, type ListPipelinesError, type ListPipelinesErrors, type ListPipelinesResponse, type ListPipelinesResponses, type ListQueueData, type ListQueueError, type ListQueueErrors, type ListQueueResponse, type ListQueueResponses, type PagedModelQueuedItemModel, type PeekItemData, type PeekItemError, type PeekItemErrors, type PeekItemResponse, type PeekItemResponses, type Pipeline, type PipelineBackgroundState, type PipelineCreateRequest, type PipelineState, PipelineStatus, type ProblemDetails, type ProcessData, type ProcessError, type ProcessErrors, type ProcessingChildRequestAction, type ProcessingErrorDetails, type ProcessingOptions, type ProcessingOptionsResults, type ProcessingRequest, type ProcessingRequestAction, type ProcessingResults, type ProcessPipelineData, type ProcessPipelineError, type ProcessPipelineErrors, type ProcessPipelineResponse, type ProcessPipelineResponses, type ProcessResponse, type ProcessResponses, type ProgressInformation, type QueuedItem, type ReattachPipelineData, type ReattachPipelineError, type ReattachPipelineErrors, type ReattachPipelineResponse, type ReattachPipelineResponses, type StepInfo, StepStatus, type UpdatePipelineData, type UpdatePipelineError, type UpdatePipelineErrors, type UpdatePipelineResponse, type UpdatePipelineResponses } from './types.gen';
3
+ export { type CancelPipelineData, type CancelPipelineError, type CancelPipelineErrors, type CancelPipelineResponses, type ClearPipelineData, type ClearPipelineError, type ClearPipelineErrors, type ClearPipelineResponses, type ClientOptions, type CreatePipelineData, type CreatePipelineError, type CreatePipelineErrors, type CreatePipelineResponse, type CreatePipelineResponses, type DeleteData, type DeleteError, type DeleteErrors, type DeleteResponses, type GetPipelineData, type GetPipelineError, type GetPipelineErrors, type GetPipelineResponse, type GetPipelineResponses, type GetProcessorsData, type GetProcessorsError, type GetProcessorsErrors, type GetProcessorsResponse, type GetProcessorsResponses, type GetResultsData, type GetResultsError, type GetResultsErrors, type GetResultsResponse, type GetResultsResponses, type ListPipelinesByStrategyData, type ListPipelinesByStrategyError, type ListPipelinesByStrategyErrors, type ListPipelinesByStrategyResponse, type ListPipelinesByStrategyResponses, type ListPipelinesData, type ListPipelinesError, type ListPipelinesErrors, type ListPipelinesResponse, type ListPipelinesResponses, type ListQueueData, type ListQueueError, type ListQueueErrors, type ListQueueResponse, type ListQueueResponses, type PagedModelQueuedItemModel, type PeekItemData, type PeekItemError, type PeekItemErrors, type PeekItemResponse, type PeekItemResponses, type Pipeline, type PipelineBackgroundState, type PipelineCreateRequest, type PipelineRunError, type PipelineRunProgress, type PipelineRunRejected, PipelineRunRejectedReason, type PipelineRunRequest, type PipelineRunStarted, PipelineRunState, type PipelineRunStatus, type PipelineRunSummary, type PipelineState, PipelineStatus, type PipelineStatusData, type PipelineStatusError, type PipelineStatusErrors, type PipelineStatusResponse, type PipelineStatusResponses, type ProblemDetails, type ProcessData, type ProcessError, type ProcessErrors, type ProcessingChildRequestAction, type ProcessingErrorDetails, type ProcessingOptions, type ProcessingOptionsResults, type ProcessingRequest, type ProcessingRequestAction, type ProcessingResults, type ProcessPipelineData, type ProcessPipelineError, type ProcessPipelineErrors, type ProcessPipelineResponse, type ProcessPipelineResponses, type ProcessResponse, type ProcessResponses, type ProgressInformation, type QueuedItem, type ReattachPipelineData, type ReattachPipelineError, type ReattachPipelineErrors, type ReattachPipelineResponse, type ReattachPipelineResponses, type StartPipelineData, type StartPipelineError, type StartPipelineErrors, type StartPipelineResponse, type StartPipelineResponses, type StepInfo, StepStatus, type UpdatePipelineData, type UpdatePipelineError, type UpdatePipelineErrors, type UpdatePipelineResponse, type UpdatePipelineResponses } from './types.gen';
package/dist/api/index.js CHANGED
@@ -1,4 +1,4 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
  export { client } from './client.gen';
3
3
  export { PipelinesService, QueuesService } from './sdk.gen';
4
- export { PipelineStatus, StepStatus } from './types.gen';
4
+ export { PipelineRunRejectedReason, PipelineRunState, PipelineStatus, StepStatus } from './types.gen';
@@ -1,5 +1,5 @@
1
1
  import type { Client, Options as Options2, TDataShape } from './client';
2
- import type { ClearPipelineData, ClearPipelineErrors, ClearPipelineResponses, CreatePipelineData, CreatePipelineErrors, CreatePipelineResponses, DeleteData, DeleteErrors, DeleteResponses, GetPipelineData, GetPipelineErrors, GetPipelineResponses, GetProcessorsData, GetProcessorsErrors, GetProcessorsResponses, GetResultsData, GetResultsErrors, GetResultsResponses, ListPipelinesByStrategyData, ListPipelinesByStrategyErrors, ListPipelinesByStrategyResponses, ListPipelinesData, ListPipelinesErrors, ListPipelinesResponses, ListQueueData, ListQueueErrors, ListQueueResponses, PeekItemData, PeekItemErrors, PeekItemResponses, ProcessData, ProcessErrors, ProcessPipelineData, ProcessPipelineErrors, ProcessPipelineResponses, ProcessResponses, ReattachPipelineData, ReattachPipelineErrors, ReattachPipelineResponses, UpdatePipelineData, UpdatePipelineErrors, UpdatePipelineResponses } from './types.gen';
2
+ import type { CancelPipelineData, CancelPipelineErrors, CancelPipelineResponses, ClearPipelineData, ClearPipelineErrors, ClearPipelineResponses, CreatePipelineData, CreatePipelineErrors, CreatePipelineResponses, DeleteData, DeleteErrors, DeleteResponses, GetPipelineData, GetPipelineErrors, GetPipelineResponses, GetProcessorsData, GetProcessorsErrors, GetProcessorsResponses, GetResultsData, GetResultsErrors, GetResultsResponses, ListPipelinesByStrategyData, ListPipelinesByStrategyErrors, ListPipelinesByStrategyResponses, ListPipelinesData, ListPipelinesErrors, ListPipelinesResponses, ListQueueData, ListQueueErrors, ListQueueResponses, PeekItemData, PeekItemErrors, PeekItemResponses, PipelineStatusData, PipelineStatusErrors, PipelineStatusResponses, ProcessData, ProcessErrors, ProcessPipelineData, ProcessPipelineErrors, ProcessPipelineResponses, ProcessResponses, ReattachPipelineData, ReattachPipelineErrors, ReattachPipelineResponses, StartPipelineData, StartPipelineErrors, StartPipelineResponses, UpdatePipelineData, UpdatePipelineErrors, UpdatePipelineResponses } from './types.gen';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -14,6 +14,7 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
14
14
  meta?: Record<string, unknown>;
15
15
  };
16
16
  export declare class PipelinesService {
17
+ static cancelPipeline<ThrowOnError extends boolean = true>(options: Options<CancelPipelineData, ThrowOnError>): import("./client").RequestResult<CancelPipelineResponses, CancelPipelineErrors, ThrowOnError, "fields">;
17
18
  static clearPipeline<ThrowOnError extends boolean = true>(options: Options<ClearPipelineData, ThrowOnError>): import("./client").RequestResult<ClearPipelineResponses, ClearPipelineErrors, ThrowOnError, "fields">;
18
19
  static createPipeline<ThrowOnError extends boolean = true>(options?: Options<CreatePipelineData, ThrowOnError>): import("./client").RequestResult<CreatePipelineResponses, CreatePipelineErrors, ThrowOnError, "fields">;
19
20
  static getPipeline<ThrowOnError extends boolean = true>(options: Options<GetPipelineData, ThrowOnError>): import("./client").RequestResult<GetPipelineResponses, GetPipelineErrors, ThrowOnError, "fields">;
@@ -21,8 +22,10 @@ export declare class PipelinesService {
21
22
  static getResults<ThrowOnError extends boolean = true>(options: Options<GetResultsData, ThrowOnError>): import("./client").RequestResult<GetResultsResponses, GetResultsErrors, ThrowOnError, "fields">;
22
23
  static listPipelines<ThrowOnError extends boolean = true>(options: Options<ListPipelinesData, ThrowOnError>): import("./client").RequestResult<ListPipelinesResponses, ListPipelinesErrors, ThrowOnError, "fields">;
23
24
  static listPipelinesByStrategy<ThrowOnError extends boolean = true>(options: Options<ListPipelinesByStrategyData, ThrowOnError>): import("./client").RequestResult<ListPipelinesByStrategyResponses, ListPipelinesByStrategyErrors, ThrowOnError, "fields">;
25
+ static pipelineStatus<ThrowOnError extends boolean = true>(options: Options<PipelineStatusData, ThrowOnError>): import("./client").RequestResult<PipelineStatusResponses, PipelineStatusErrors, ThrowOnError, "fields">;
24
26
  static processPipeline<ThrowOnError extends boolean = true>(options: Options<ProcessPipelineData, ThrowOnError>): import("./client").RequestResult<ProcessPipelineResponses, ProcessPipelineErrors, ThrowOnError, "fields">;
25
27
  static reattachPipeline<ThrowOnError extends boolean = true>(options: Options<ReattachPipelineData, ThrowOnError>): import("./client").RequestResult<ReattachPipelineResponses, ReattachPipelineErrors, ThrowOnError, "fields">;
28
+ static startPipeline<ThrowOnError extends boolean = true>(options?: Options<StartPipelineData, ThrowOnError>): import("./client").RequestResult<StartPipelineResponses, StartPipelineErrors, ThrowOnError, "fields">;
26
29
  static updatePipeline<ThrowOnError extends boolean = true>(options: Options<UpdatePipelineData, ThrowOnError>): import("./client").RequestResult<UpdatePipelineResponses, UpdatePipelineErrors, ThrowOnError, "fields">;
27
30
  }
28
31
  export declare class QueuesService {
@@ -1,6 +1,13 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
  import { client } from './client.gen';
3
3
  export class PipelinesService {
4
+ static cancelPipeline(options) {
5
+ return (options.client ?? client).post({
6
+ security: [{ scheme: 'bearer', type: 'http' }],
7
+ url: '/umbraco/jumoo/api/v1/processing/CancelPipeline/{id}',
8
+ ...options
9
+ });
10
+ }
4
11
  static clearPipeline(options) {
5
12
  return (options.client ?? client).post({
6
13
  security: [{ scheme: 'bearer', type: 'http' }],
@@ -54,6 +61,13 @@ export class PipelinesService {
54
61
  ...options
55
62
  });
56
63
  }
64
+ static pipelineStatus(options) {
65
+ return (options.client ?? client).get({
66
+ security: [{ scheme: 'bearer', type: 'http' }],
67
+ url: '/umbraco/jumoo/api/v1/processing/PipelineStatus/{id}',
68
+ ...options
69
+ });
70
+ }
57
71
  static processPipeline(options) {
58
72
  return (options.client ?? client).post({
59
73
  security: [{ scheme: 'bearer', type: 'http' }],
@@ -68,6 +82,17 @@ export class PipelinesService {
68
82
  ...options
69
83
  });
70
84
  }
85
+ static startPipeline(options) {
86
+ return (options?.client ?? client).post({
87
+ security: [{ scheme: 'bearer', type: 'http' }],
88
+ url: '/umbraco/jumoo/api/v1/processing/StartPipeline',
89
+ ...options,
90
+ headers: {
91
+ 'Content-Type': 'application/json',
92
+ ...options?.headers
93
+ }
94
+ });
95
+ }
71
96
  static updatePipeline(options) {
72
97
  return (options.client ?? client).post({
73
98
  security: [{ scheme: 'bearer', type: 'http' }],
@@ -26,6 +26,68 @@ export type PipelineCreateRequest = {
26
26
  options?: ProcessingOptions | null;
27
27
  clientId?: string | null;
28
28
  };
29
+ export type PipelineRunError = {
30
+ message: string;
31
+ action?: string | null;
32
+ step?: string | null;
33
+ };
34
+ export type PipelineRunProgress = {
35
+ percentage: number;
36
+ action?: string | null;
37
+ step?: string | null;
38
+ page: number;
39
+ };
40
+ export type PipelineRunRejected = {
41
+ reason: PipelineRunRejectedReason;
42
+ message: string;
43
+ runningPipelineId?: string | null;
44
+ concurrencyKey?: string | null;
45
+ };
46
+ export declare enum PipelineRunRejectedReason {
47
+ NOT_FOUND = "NotFound",
48
+ ALREADY_RUNNING = "AlreadyRunning",
49
+ INVALID = "Invalid"
50
+ }
51
+ export type PipelineRunRequest = {
52
+ processor: string;
53
+ strategy: string;
54
+ options?: ProcessingOptions | null;
55
+ startAtUtc?: string | null;
56
+ clientId?: string | null;
57
+ };
58
+ export type PipelineRunStarted = {
59
+ pipelineId: string;
60
+ status: PipelineRunState;
61
+ statusUrl: string;
62
+ };
63
+ export declare enum PipelineRunState {
64
+ QUEUED = "Queued",
65
+ RUNNING = "Running",
66
+ SCHEDULED = "Scheduled",
67
+ WAITING = "Waiting",
68
+ COMPLETED = "Completed",
69
+ FAILED = "Failed",
70
+ CANCELLED = "Cancelled"
71
+ }
72
+ export type PipelineRunStatus = {
73
+ pipelineId: string;
74
+ processor: string;
75
+ strategy: string;
76
+ status: PipelineRunState;
77
+ complete: boolean;
78
+ succeeded: boolean;
79
+ cancelRequested: boolean;
80
+ progress: PipelineRunProgress;
81
+ startedBy?: string | null;
82
+ created?: string | null;
83
+ modified?: string | null;
84
+ scheduledFor?: string | null;
85
+ error?: PipelineRunError | null;
86
+ summary?: PipelineRunSummary | null;
87
+ };
88
+ export type PipelineRunSummary = {
89
+ [key: string]: unknown;
90
+ };
29
91
  export type PipelineState = {
30
92
  status: PipelineStatus;
31
93
  childPipeline?: string | null;
@@ -35,6 +97,11 @@ export type PipelineState = {
35
97
  schedule?: string | null;
36
98
  backgroundState?: PipelineBackgroundState | null;
37
99
  isChildPipeline: boolean;
100
+ cancelRequested: boolean;
101
+ concurrencyKey?: string | null;
102
+ userKey?: string | null;
103
+ created?: string | null;
104
+ modified?: string | null;
38
105
  };
39
106
  export declare enum PipelineStatus {
40
107
  NOT_STARTED = "NotStarted",
@@ -43,7 +110,8 @@ export declare enum PipelineStatus {
43
110
  WAITING = "Waiting",
44
111
  SCHEDULED = "Scheduled",
45
112
  COMPLETED = "Completed",
46
- FAILED = "Failed"
113
+ FAILED = "Failed",
114
+ CANCELLED = "Cancelled"
47
115
  }
48
116
  export type ProblemDetails = {
49
117
  type?: string | null;
@@ -146,6 +214,43 @@ export declare enum StepStatus {
146
214
  COMPLETE = "Complete",
147
215
  ERROR = "Error"
148
216
  }
217
+ export type CancelPipelineData = {
218
+ body?: never;
219
+ path: {
220
+ id: string;
221
+ };
222
+ query?: never;
223
+ url: '/umbraco/jumoo/api/v1/processing/CancelPipeline/{id}';
224
+ };
225
+ export type CancelPipelineErrors = {
226
+ /**
227
+ * Bad Request
228
+ */
229
+ 400: ProblemDetails;
230
+ /**
231
+ * The resource is protected and requires an authentication token
232
+ */
233
+ 401: unknown;
234
+ /**
235
+ * Forbidden
236
+ */
237
+ 403: ProblemDetails;
238
+ /**
239
+ * Not Found
240
+ */
241
+ 404: unknown;
242
+ /**
243
+ * Conflict
244
+ */
245
+ 409: ProblemDetails;
246
+ };
247
+ export type CancelPipelineError = CancelPipelineErrors[keyof CancelPipelineErrors];
248
+ export type CancelPipelineResponses = {
249
+ /**
250
+ * Accepted
251
+ */
252
+ 202: unknown;
253
+ };
149
254
  export type ClearPipelineData = {
150
255
  body?: never;
151
256
  path: {
@@ -340,6 +445,40 @@ export type ListPipelinesByStrategyResponses = {
340
445
  200: Array<Pipeline>;
341
446
  };
342
447
  export type ListPipelinesByStrategyResponse = ListPipelinesByStrategyResponses[keyof ListPipelinesByStrategyResponses];
448
+ export type PipelineStatusData = {
449
+ body?: never;
450
+ path: {
451
+ id: string;
452
+ };
453
+ query?: never;
454
+ url: '/umbraco/jumoo/api/v1/processing/PipelineStatus/{id}';
455
+ };
456
+ export type PipelineStatusErrors = {
457
+ /**
458
+ * Bad Request
459
+ */
460
+ 400: ProblemDetails;
461
+ /**
462
+ * The resource is protected and requires an authentication token
463
+ */
464
+ 401: unknown;
465
+ /**
466
+ * Forbidden
467
+ */
468
+ 403: ProblemDetails;
469
+ /**
470
+ * Not Found
471
+ */
472
+ 404: unknown;
473
+ };
474
+ export type PipelineStatusError = PipelineStatusErrors[keyof PipelineStatusErrors];
475
+ export type PipelineStatusResponses = {
476
+ /**
477
+ * OK
478
+ */
479
+ 200: PipelineRunStatus;
480
+ };
481
+ export type PipelineStatusResponse = PipelineStatusResponses[keyof PipelineStatusResponses];
343
482
  export type ProcessPipelineData = {
344
483
  body?: never;
345
484
  path: {
@@ -400,6 +539,38 @@ export type ReattachPipelineResponses = {
400
539
  200: Pipeline;
401
540
  };
402
541
  export type ReattachPipelineResponse = ReattachPipelineResponses[keyof ReattachPipelineResponses];
542
+ export type StartPipelineData = {
543
+ body?: PipelineRunRequest;
544
+ path?: never;
545
+ query?: never;
546
+ url: '/umbraco/jumoo/api/v1/processing/StartPipeline';
547
+ };
548
+ export type StartPipelineErrors = {
549
+ /**
550
+ * Bad Request
551
+ */
552
+ 400: ProblemDetails;
553
+ /**
554
+ * The resource is protected and requires an authentication token
555
+ */
556
+ 401: unknown;
557
+ /**
558
+ * Not Found
559
+ */
560
+ 404: PipelineRunRejected;
561
+ /**
562
+ * Conflict
563
+ */
564
+ 409: PipelineRunRejected;
565
+ };
566
+ export type StartPipelineError = StartPipelineErrors[keyof StartPipelineErrors];
567
+ export type StartPipelineResponses = {
568
+ /**
569
+ * Accepted
570
+ */
571
+ 202: PipelineRunStarted;
572
+ };
573
+ export type StartPipelineResponse = StartPipelineResponses[keyof StartPipelineResponses];
403
574
  export type UpdatePipelineData = {
404
575
  body?: ProcessingOptions;
405
576
  path: {
@@ -1,4 +1,20 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
+ export var PipelineRunRejectedReason;
3
+ (function (PipelineRunRejectedReason) {
4
+ PipelineRunRejectedReason["NOT_FOUND"] = "NotFound";
5
+ PipelineRunRejectedReason["ALREADY_RUNNING"] = "AlreadyRunning";
6
+ PipelineRunRejectedReason["INVALID"] = "Invalid";
7
+ })(PipelineRunRejectedReason || (PipelineRunRejectedReason = {}));
8
+ export var PipelineRunState;
9
+ (function (PipelineRunState) {
10
+ PipelineRunState["QUEUED"] = "Queued";
11
+ PipelineRunState["RUNNING"] = "Running";
12
+ PipelineRunState["SCHEDULED"] = "Scheduled";
13
+ PipelineRunState["WAITING"] = "Waiting";
14
+ PipelineRunState["COMPLETED"] = "Completed";
15
+ PipelineRunState["FAILED"] = "Failed";
16
+ PipelineRunState["CANCELLED"] = "Cancelled";
17
+ })(PipelineRunState || (PipelineRunState = {}));
2
18
  export var PipelineStatus;
3
19
  (function (PipelineStatus) {
4
20
  PipelineStatus["NOT_STARTED"] = "NotStarted";
@@ -8,6 +24,7 @@ export var PipelineStatus;
8
24
  PipelineStatus["SCHEDULED"] = "Scheduled";
9
25
  PipelineStatus["COMPLETED"] = "Completed";
10
26
  PipelineStatus["FAILED"] = "Failed";
27
+ PipelineStatus["CANCELLED"] = "Cancelled";
11
28
  })(PipelineStatus || (PipelineStatus = {}));
12
29
  export var StepStatus;
13
30
  (function (StepStatus) {
@@ -13,6 +13,7 @@ let JumooPipelineBackgroundElement = class JumooPipelineBackgroundElement extend
13
13
  case PipelineStatus.COMPLETED:
14
14
  return this.renderComplete();
15
15
  case PipelineStatus.FAILED:
16
+ case PipelineStatus.CANCELLED:
16
17
  return this.renderError();
17
18
  default:
18
19
  return html `${this.renderBackgroundBanner()} ${this.renderProgress()}`;
@@ -35,6 +35,7 @@ let JumooProcessingPipelineList = class JumooProcessingPipelineList extends UmbL
35
35
  PipelineStatus.RUNNING,
36
36
  PipelineStatus.COMPLETED,
37
37
  PipelineStatus.FAILED,
38
+ PipelineStatus.CANCELLED,
38
39
  ];
39
40
  this._modalPath = '';
40
41
  this.status = PipelineStatus.WAITING;
@@ -155,6 +155,7 @@ let JumooPipelineElement = class JumooPipelineElement extends UmbLitElement {
155
155
  case PipelineStatus.RUNNING:
156
156
  return this.renderSteps();
157
157
  case PipelineStatus.FAILED:
158
+ case PipelineStatus.CANCELLED:
158
159
  return this.renderFail();
159
160
  case PipelineStatus.BACKGROUND:
160
161
  return this.renderBackground();
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@jumoo/processing",
3
3
  "licence": "custom",
4
- "version": "17.4.3-prerelease.2",
4
+ "version": "17.4.3-prerelease.3",
5
5
  "type": "module",
6
6
  "description": "Jumoo processing library",
7
7
  "exports": {