@5minds/processcube_engine_client - npm Package Compare versions

Comparing version 6.0.0-renovate-819c7e-m6eb9mfk to 6.0.0-renovate-82a651-m77sknmg

dist/Clients/FlowNodeInstanceHttpClient.d.ts

@@ -11,3 +11,6 @@ import { DataModels, IFlowNodeInstanceExtensionAdapter } from '@5minds/processcube_engine_sdk';
     }): Promise<DataModels.FlowNodeInstances.FlowNodeInstanceList>;
-    finishUntypedTask(taskInstanceId: string, identity?: IdentityLike): Promise<void>;
+    /**
+     * @param useLegacyEndpoint If true, will use the old "Empty Activity" Socket.IO Endpoint for receiving the notification.
+     */
+    finishUntypedTask(taskInstanceId: string, identity?: IdentityLike, useLegacyEndpoint?: boolean): Promise<void>;
     finishManualTask(manualTaskInstanceId: string, identity?: IdentityLike): Promise<void>;
@@ -14,0 +17,0 @@ finishUserTask(userTaskInstanceId: string, userTaskResult: DataModels.FlowNodeInstances.UserTaskResult, identity?: IdentityLike): Promise<void>;

dist/Clients/NotificationHttpClient.d.ts

@@ -102,2 +102,6 @@ import { INotificationExtensionAdapter, Messages, Subscription } from '@5minds/processcube_engine_sdk';
         identity?: IdentityLike;
+        /**
+         * If true, will use the old "Empty Activity" Socket.IO Endpoint for receiving the notification.
+         */
+        useLegacyEndpoint?: boolean;
     }): Promise<Subscription>;
@@ -107,2 +111,6 @@ onUntypedTaskFinished(callback: Messages.CallbackTypes.OnUntypedTaskFinishedCallback, options?: {
         identity?: IdentityLike;
+        /**
+         * If true, will use the old "Empty Activity" Socket.IO Endpoint for receiving the notification.
+         */
+        useLegacyEndpoint?: boolean;
     }): Promise<Subscription>;
@@ -109,0 +117,0 @@ onManualTaskWaiting(callback: Messages.CallbackTypes.OnManualTaskWaitingCallback, options?: {

dist/Clients/UntypedTaskHttpClient.d.ts

@@ -11,6 +11,13 @@ import { FlowNodeInstanceSortSettings, IUntypedTaskExtensionAdapter, Messages, Subscription, UntypedTaskList, UntypedTaskQuery } from '@5minds/processcube_engine_sdk';
     }): Promise<UntypedTaskList>;
-    finishTask(taskInstanceId: string, identity?: IdentityLike): Promise<void>;
+    /**
+     * @param useLegacyEndpoint If true, will use the old "Empty Activity" Socket.IO Endpoint for receiving the notification.
+     */
+    finishTask(taskInstanceId: string, identity?: IdentityLike, useLegacyEndpoint?: boolean): Promise<void>;
     onUntypedTaskWaiting(callback: Messages.CallbackTypes.OnUntypedTaskWaitingCallback, options?: {
         subscribeOnce?: boolean;
         identity?: IdentityLike;
+        /**
+         * If true, will use the old "Empty Activity" Socket.IO Endpoint for receiving the notification.
+         */
+        useLegacyEndpoint?: boolean;
     }): Promise<Subscription>;
@@ -20,4 +27,8 @@ onUntypedTaskFinished(callback: Messages.CallbackTypes.OnUntypedTaskFinishedCallback, options?: {
         identity?: IdentityLike;
+        /**
+         * If true, will use the old "Empty Activity" Socket.IO Endpoint for receiving the notification.
+         */
+        useLegacyEndpoint?: boolean;
     }): Promise<Subscription>;
     removeSubscription(subscription: Subscription, identity?: IdentityLike): void;
 }

dist/commonjs/Clients/FlowNodeInstanceHttpClient.js

@@ -18,5 +18,10 @@ "use strict";
     }
-    async finishUntypedTask(taskInstanceId, identity) {
+    /**
+     * @param useLegacyEndpoint If true, will use the old "Empty Activity" Socket.IO Endpoint for receiving the notification.
+     */
+    async finishUntypedTask(taskInstanceId, identity, useLegacyEndpoint) {
         const requestAuthHeaders = await this.createRequestAuthHeaders(identity);
-        const urlRestPart = index_1.restSettings.paths.finishUntypedTask.replace(index_1.restSettings.params.untypedTaskInstanceId, taskInstanceId);
+        const urlRestPart = useLegacyEndpoint === true
+            ? index_1.restSettings.paths.finishEmptyActivity.replace(index_1.restSettings.params.emptyActivityInstanceId, taskInstanceId)
+            : index_1.restSettings.paths.finishUntypedTask.replace(index_1.restSettings.params.untypedTaskInstanceId, taskInstanceId);
         const url = this.buildUrl(urlRestPart);
@@ -23,0 +28,0 @@ await this.httpClient.put(url, {}, requestAuthHeaders);

dist/commonjs/Clients/NotificationHttpClient.js

@@ -83,5 +83,11 @@ "use strict";
     async onUntypedTaskWaiting(callback, options) {
+        if (options?.useLegacyEndpoint === true) {
+            return this.createSocketIoSubscription(index_1.socketSettings.paths.emptyActivityWaiting, callback, options?.subscribeOnce, options?.identity);
+        }
         return this.createSocketIoSubscription(index_1.socketSettings.paths.untypedTaskWaiting, callback, options?.subscribeOnce, options?.identity);
     }
     async onUntypedTaskFinished(callback, options) {
+        if (options?.useLegacyEndpoint === true) {
+            return this.createSocketIoSubscription(index_1.socketSettings.paths.emptyActivityFinished, callback, options?.subscribeOnce, options?.identity);
+        }
         return this.createSocketIoSubscription(index_1.socketSettings.paths.untypedTaskFinished, callback, options?.subscribeOnce, options?.identity);
@@ -88,0 +94,0 @@ }

dist/commonjs/Clients/UntypedTaskHttpClient.js

@@ -23,5 +23,10 @@ "use strict";
     }
-    async finishTask(taskInstanceId, identity) {
+    /**
+     * @param useLegacyEndpoint If true, will use the old "Empty Activity" Socket.IO Endpoint for receiving the notification.
+     */
+    async finishTask(taskInstanceId, identity, useLegacyEndpoint) {
         const requestAuthHeaders = await this.createRequestAuthHeaders(identity);
-        const urlRestPart = index_1.restSettings.paths.finishUntypedTask.replace(index_1.restSettings.params.untypedTaskInstanceId, taskInstanceId);
+        const urlRestPart = useLegacyEndpoint === true
+            ? index_1.restSettings.paths.finishEmptyActivity.replace(index_1.restSettings.params.emptyActivityInstanceId, taskInstanceId)
+            : index_1.restSettings.paths.finishUntypedTask.replace(index_1.restSettings.params.untypedTaskInstanceId, taskInstanceId);
         const url = this.buildUrl(urlRestPart);
@@ -31,5 +36,11 @@ await this.httpClient.put(url, {}, requestAuthHeaders);
     async onUntypedTaskWaiting(callback, options) {
+        if (options?.useLegacyEndpoint === true) {
+            return this.createSocketIoSubscription(index_1.socketSettings.paths.emptyActivityWaiting, callback, options?.subscribeOnce, options?.identity);
+        }
         return this.createSocketIoSubscription(index_1.socketSettings.paths.untypedTaskWaiting, callback, options?.subscribeOnce, options?.identity);
     }
     async onUntypedTaskFinished(callback, options) {
+        if (options?.useLegacyEndpoint === true) {
+            return this.createSocketIoSubscription(index_1.socketSettings.paths.emptyActivityFinished, callback, options?.subscribeOnce, options?.identity);
+        }
         return this.createSocketIoSubscription(index_1.socketSettings.paths.untypedTaskFinished, callback, options?.subscribeOnce, options?.identity);
@@ -36,0 +47,0 @@ }

dist/commonjs/Types/RestSettings.js

@@ -9,2 +9,4 @@ "use strict";
     untypedTaskInstanceId: ':untyped_task_instance_id',
+    // Deprecated version of "untypedTaskInstanceId"
+    emptyActivityInstanceId: ':empty_activity_instance_id',
     // Id of an Event.
@@ -154,2 +156,9 @@ eventId: ':event_id',
     /**
+     * Finishes a specific EmptyActivity by its InstanceId. Deprecated, use "finish Untyped Task" instead
+     * @tags EmptyActivity
+     * @deprecated
+     * @method put
+     */
+    finishEmptyActivity: `/empty_activities/${params.emptyActivityInstanceId}/finish`,
+    /**
      * Finishes a specific UntypedTask by its InstanceId.
@@ -566,2 +575,16 @@ * @tags UntypedTask
     /**
+     * Wait for an UntypedTaskWaiting notification and resolves with the notification's content.
+     * @tags Notifications
+     * @method get
+     * @responseType EventMessage
+     */
+    onUntypedTaskWaiting: '/notifications/long_polling/empty_activity_waiting',
+    /**
+     * Wait for an UntypedTaskFinished notification and resolves with the notification's content.
+     * @tags Notifications
+     * @method get
+     * @responseType EventMessage
+     */
+    onUntypedTaskFinished: '/notifications/long_polling/empty_activity_finished',
+    /**
      * Wait for a ManualTaskWaiting notification and resolves with the notification's content.
@@ -568,0 +591,0 @@ * @tags Notifications

dist/commonjs/Types/SocketSettings.js

@@ -20,2 +20,4 @@ "use strict";
     cronjobUpdated: 'cronjob_updated',
+    emptyActivityWaiting: 'empty_activity_waiting',
+    emptyActivityFinished: 'empty_activity_finished',
     untypedTaskWaiting: 'untyped_task_waiting',
@@ -22,0 +24,0 @@ untypedTaskFinished: 'untyped_task_finished',

dist/Types/RestSettings.d.ts

@@ -5,2 +5,3 @@ export declare const restSettings: {
         untypedTaskInstanceId: string;
+        emptyActivityInstanceId: string;
         eventId: string;
@@ -131,2 +132,9 @@ eventName: string;
         /**
+         * Finishes a specific EmptyActivity by its InstanceId. Deprecated, use "finish Untyped Task" instead
+         * @tags EmptyActivity
+         * @deprecated
+         * @method put
+         */
+        finishEmptyActivity: string;
+        /**
          * Finishes a specific UntypedTask by its InstanceId.
@@ -537,2 +545,16 @@ * @tags UntypedTask
         /**
+         * Wait for an UntypedTaskWaiting notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onUntypedTaskWaiting: string;
+        /**
+         * Wait for an UntypedTaskFinished notification and resolves with the notification's content.
+         * @tags Notifications
+         * @method get
+         * @responseType EventMessage
+         */
+        onUntypedTaskFinished: string;
+        /**
          * Wait for a ManualTaskWaiting notification and resolves with the notification's content.
@@ -539,0 +561,0 @@ * @tags Notifications

dist/Types/SocketSettings.d.ts

@@ -19,2 +19,4 @@ export declare const socketSettings: {
         cronjobUpdated: string;
+        emptyActivityWaiting: string;
+        emptyActivityFinished: string;
         untypedTaskWaiting: string;
@@ -21,0 +23,0 @@ untypedTaskFinished: string;

package.json

@@ -7,3 +7,3 @@ {
   "name": "@5minds/processcube_engine_client",
-  "version": "6.0.0-renovate-819c7e-m6eb9mfk",
+  "version": "6.0.0-renovate-82a651-m77sknmg",
   "description": "Contains a typescript based client for accessing the Engine.",
@@ -43,3 +43,3 @@ "main": "dist/commonjs/index.js",
   "dependencies": {
-    "@5minds/processcube_engine_sdk": "6.1.0-alpha.6",
+    "@5minds/processcube_engine_sdk": "6.1.0-alpha.8",
     "async-lock": "^1.4.1",
@@ -46,0 +46,0 @@ "bufferutil": "4.0.9",

No alert changes

Improved metrics

Total package byte prevSize

356287

increased by1.64%

Lines of code

5087

increased by1.86%

Dependency changes

• + Added@5minds/processcube_engine_sdk@6.1.0-alpha.8(transitive)

• - Removed@5minds/processcube_engine_sdk@6.1.0-alpha.6(transitive)

• Updated@5minds/processcube_engine_sdk@6.1.0-alpha.8