bruce-models 4.8.0 → 4.8.1

package/dist/bruce-models.umd.js

@@ -10548,6 +10548,70 @@
             });
         }
         PendingAction.Cancel = Cancel;
+        /**
+         * Resolves when the Pending Action is no longer running.
+         * @param params
+         *
+         * @example
+         * try {
+         *    const { action } = await PendingAction.OnCompletion({ actionId: 123 });
+         * }
+         * catch (e) {
+         *    // Threw because the action failed to be found.
+         *    // Most likely scenarios are invalid actionId or server connection issues.
+         *    // If it's related to server connection issues then wait a bit and relaunch.
+         * }
+         *
+         * // Here is how you can stop the loop on early disposal.
+         * let disposed = false;
+         * const { action } = await PendingAction.OnCompletion({
+         *     actionId: 123,
+         *     isDisposed: () => {
+         *         return disposed;
+         *     }
+         * });
+         * // Action will resolve as null if it was disposed early.
+         */
+        function OnCompletion(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, actionId, req: reqParams, interval: intMs, isDisposed } = params;
+                if (!actionId) {
+                    throw ("Action ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                if (!intMs || intMs <= 0) {
+                    intMs = 3000;
+                }
+                const res = yield new Promise((res, rej) => {
+                    let interval = setInterval(() => __awaiter(this, void 0, void 0, function* () {
+                        if (isDisposed && isDisposed()) {
+                            clearInterval(interval);
+                            res(null);
+                        }
+                        try {
+                            const { action } = yield Get({
+                                api,
+                                actionId,
+                                req: reqParams
+                            });
+                            if (action.Status !== EStatus.InProgress) {
+                                clearInterval(interval);
+                                res(action);
+                            }
+                        }
+                        catch (e) {
+                            rej(e);
+                        }
+                    }), intMs);
+                });
+                return {
+                    action: res
+                };
+            });
+        }
+        PendingAction.OnCompletion = OnCompletion;
     })(exports.PendingAction || (exports.PendingAction = {}));
 
     // Some dead accounts that we don't want to show in the UI.
@@ -13916,7 +13980,7 @@
     })(exports.DataSource || (exports.DataSource = {}));
 
     // This is updated with the package.json version on build.
-    const VERSION = "4.8.0";
+    const VERSION = "4.8.1";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;