@pimcore/studio-ui-bundle 1.0.0-canary.20251124-160625-9aabc32 → 1.0.0-canary.20251124-163422-00f18e7

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 (22) hide show
  1. package/dist/build/types/src/core/modules/app/settings/settings-slice.gen.d.ts +187 -0
  2. package/dist/build/types/src/core/modules/background-processor/process/abstract-mercure-process.d.ts +1 -0
  3. package/dist/build/types/src/core/modules/execution-engine/execution-engine-api-slice-enhanced.d.ts +517 -0
  4. package/dist/build/types/src/core/modules/execution-engine/execution-engine-api-slice.gen.d.ts +573 -0
  5. package/dist/build/types/src/core/modules/execution-engine/jobs/batch-delete/abstract-batch-delete-job.d.ts +1 -1
  6. package/dist/build/types/src/core/modules/execution-engine/jobs/batch-delete/asset-batch-delete-job.d.ts +1 -1
  7. package/dist/build/types/src/core/modules/execution-engine/jobs/batch-delete/data-object-batch-delete-job.d.ts +1 -1
  8. package/dist/build/types/src/core/modules/execution-engine/jobs/batch-edit/abstract-batch-edit-job.d.ts +1 -1
  9. package/dist/build/types/src/core/modules/execution-engine/jobs/batch-edit/asset-batch-edit-job.d.ts +1 -1
  10. package/dist/build/types/src/core/modules/execution-engine/jobs/batch-edit/asset-folder-batch-edit-job.d.ts +1 -1
  11. package/dist/build/types/src/core/modules/execution-engine/jobs/batch-edit/data-object-batch-edit-job.d.ts +1 -1
  12. package/dist/build/types/src/core/modules/execution-engine/jobs/batch-edit/data-object-folder-batch-edit-job.d.ts +1 -1
  13. package/dist/build/types/src/core/modules/execution-engine/jobs/clone/abstract-clone-job.d.ts +1 -1
  14. package/dist/build/types/src/core/modules/execution-engine/jobs/clone/document-clone-job.d.ts +1 -1
  15. package/dist/build/types/src/core/modules/execution-engine/jobs/clone/element-clone-job.d.ts +2 -2
  16. package/dist/build/types/src/core/modules/execution-engine/message-handlers/message-bus-job/job-run-polling.d.ts +43 -0
  17. package/dist/build/types/src/core/modules/execution-engine/message-handlers/message-bus-job/message-bus-job-handler.d.ts +6 -2
  18. package/dist/build/types/src/core/modules/execution-engine/notification/job/job-view.d.ts +1 -0
  19. package/dist/build/types/src/core/modules/widget-manager/widget/title/title-view.d.ts +1 -0
  20. package/dist/build/types/src/core/modules/widget-manager/widget/title/title-view.styles.d.ts +1 -0
  21. package/dist/build/types/src/core/utils/exponential-backoff.d.ts +27 -0
  22. package/package.json +1 -1
@@ -15,5 +15,5 @@ export interface DocumentCloneJobOptions extends Omit<AbstractCloneJobOptions, '
15
15
  export declare class DocumentCloneJob extends AbstractCloneJob {
16
16
  private readonly parameters;
17
17
  constructor(options: DocumentCloneJobOptions);
18
- protected executeCloneRequest(): Promise<string | number | null>;
18
+ protected executeCloneRequest(): Promise<number | null>;
19
19
  }
@@ -17,12 +17,12 @@ export interface ElementCloneJobOptions extends AbstractCloneJobOptions {
17
17
  cloneParameters: CloneParameters;
18
18
  }) => Promise<{
19
19
  success: boolean;
20
- jobRunId?: string | number;
20
+ jobRunId?: number;
21
21
  }>;
22
22
  }
23
23
  export declare class ElementCloneJob extends AbstractCloneJob {
24
24
  private readonly parameters;
25
25
  private readonly elementClone;
26
26
  constructor(options: ElementCloneJobOptions);
27
- protected executeCloneRequest(): Promise<string | number | null>;
27
+ protected executeCloneRequest(): Promise<number | null>;
28
28
  }
@@ -0,0 +1,43 @@
1
+ /**
2
+ * This source file is available under the terms of the
3
+ * Pimcore Open Core License (POCL)
4
+ * Full copyright and license information is available in
5
+ * LICENSE.md which is distributed with this source code.
6
+ *
7
+ * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com)
8
+ * @license Pimcore Open Core License (POCL)
9
+ */
10
+ import { type JobRun } from '../../../../modules/execution-engine/execution-engine-api-slice.gen';
11
+ export interface JobRunPollingCallbacks {
12
+ onStatusUpdate: (data: JobStatusUpdateData) => void | Promise<void>;
13
+ onError?: (error: Error) => void;
14
+ }
15
+ export interface JobStatusUpdateData {
16
+ status: string;
17
+ currentStep?: number | null;
18
+ totalSteps?: number | null;
19
+ currentMessage?: string;
20
+ jobRun: JobRun;
21
+ }
22
+ /**
23
+ * Handles polling for job run status when Mercure updates are not received
24
+ * Automatically polls the API after a timeout period of no updates
25
+ */
26
+ export declare class JobRunPolling {
27
+ private readonly jobRunId;
28
+ private readonly callbacks;
29
+ private isPolling;
30
+ private isDestroyed;
31
+ private lastJobSnapshot;
32
+ private readonly pollingBackoff;
33
+ constructor(jobRunId: string | number, callbacks: JobRunPollingCallbacks);
34
+ notifyUpdate(): void;
35
+ destroy(): void;
36
+ private schedulePolling;
37
+ private startPolling;
38
+ private scheduleNextPoll;
39
+ private hasJobChanged;
40
+ private stopPolling;
41
+ private createSnapshot;
42
+ private pollJobStatus;
43
+ }
@@ -25,10 +25,11 @@ export declare class MessageBusJobHandler extends AbstractMessageHandler {
25
25
  private readonly totalSteps?;
26
26
  private lastProgressValue;
27
27
  private readonly title;
28
+ private readonly polling;
28
29
  private readonly throttledProgressUpdate;
29
30
  constructor(options: MessageBusJobHandlerOptions);
30
31
  shouldHandle(message: AbstractMercureMessage): boolean;
31
- getId(): string | number;
32
+ getId(): number;
32
33
  onRegister(): void;
33
34
  handleMessage(message: AbstractMercureMessage): Promise<void>;
34
35
  onUnregister(): void;
@@ -46,6 +47,8 @@ export declare class MessageBusJobHandler extends AbstractMessageHandler {
46
47
  private handleStatusUpdate;
47
48
  private handleProgressUpdate;
48
49
  private performProgressUpdate;
50
+ private handlePolledStatusUpdate;
51
+ private processUpdate;
49
52
  }
50
53
  export interface MessageBusJob extends AbstractJob {
51
54
  progress?: number;
@@ -54,6 +57,7 @@ export interface MessageBusJob extends AbstractJob {
54
57
  onRetry?: () => void | Promise<void>;
55
58
  onCustomizeButtons?: (context: JobButtonCustomizationContext) => void;
56
59
  messages?: string[];
60
+ jobRunId: number;
57
61
  }
58
62
  export interface JobCompletionData {
59
63
  isSuccessful: boolean;
@@ -63,7 +67,7 @@ export interface JobCompletionData {
63
67
  payload: any;
64
68
  }
65
69
  export interface MessageBusJobHandlerOptions {
66
- jobRunId: string | number;
70
+ jobRunId: number;
67
71
  title: string | ((job: MessageBusJob) => string);
68
72
  totalSteps?: number;
69
73
  onJobCompletion?: (data: JobCompletionData) => void | Promise<void>;
@@ -17,6 +17,7 @@ export interface JobViewProps extends JobProps {
17
17
  successButtonActions?: ButtonAction[];
18
18
  failureButtonActions?: ButtonAction[];
19
19
  finishedWithErrorsButtonActions?: ButtonAction[];
20
+ onAbort?: () => void | Promise<void>;
20
21
  progress: number;
21
22
  currentStep?: number;
22
23
  totalSteps?: number;
@@ -13,6 +13,7 @@ interface TitleViewProps {
13
13
  title: string;
14
14
  icon: IconProps;
15
15
  className?: string;
16
+ onClose?: () => void;
16
17
  }
17
18
  declare const TitleView: (props: TitleViewProps) => React.JSX.Element;
18
19
  export { TitleView };
@@ -9,4 +9,5 @@
9
9
  */
10
10
  export declare const useStyles: (props?: unknown) => import("antd-style").ReturnStyles<{
11
11
  WidgetTitle: import("antd-style").SerializedStyles;
12
+ CloseButton: import("antd-style").SerializedStyles;
12
13
  }>;
@@ -0,0 +1,27 @@
1
+ /**
2
+ * This source file is available under the terms of the
3
+ * Pimcore Open Core License (POCL)
4
+ * Full copyright and license information is available in
5
+ * LICENSE.md which is distributed with this source code.
6
+ *
7
+ * @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com)
8
+ * @license Pimcore Open Core License (POCL)
9
+ */
10
+ export interface ExponentialBackoffOptions {
11
+ initialDelay: number;
12
+ maxDelay: number;
13
+ multiplier: number;
14
+ }
15
+ export declare class ExponentialBackoff {
16
+ private readonly initialDelay;
17
+ private readonly maxDelay;
18
+ private readonly multiplier;
19
+ private currentDelay;
20
+ private timeoutId;
21
+ constructor(options: ExponentialBackoffOptions);
22
+ schedule(callback: () => void): void;
23
+ increase(): void;
24
+ reset(): void;
25
+ clear(): void;
26
+ getCurrentDelay(): number;
27
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pimcore/studio-ui-bundle",
3
- "version": "1.0.0-canary.20251124-160625-9aabc32",
3
+ "version": "1.0.0-canary.20251124-163422-00f18e7",
4
4
  "keywords": [
5
5
  "pimcore",
6
6
  "pimcore-studio-ui"