@acmekit/core-flows 2.13.34 → 2.13.36

package/dist/common/index.d.ts

@@ -8,6 +8,7 @@ export * from "./steps/update-remote-links";
 export * from "./steps/use-query-graph";
 export * from "./steps/use-remote-query";
 export * from "./steps/validate-presence-of";
+export * from "./steps/wait-for-approval";
 export * from "./workflows/batch-links";
 export * from "./workflows/create-links";
 export * from "./workflows/dismiss-links";

package/dist/common/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA"}

package/dist/common/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./steps/update-remote-links"), exports);
 __exportStar(require("./steps/use-query-graph"), exports);
 __exportStar(require("./steps/use-remote-query"), exports);
 __exportStar(require("./steps/validate-presence-of"), exports);
+__exportStar(require("./steps/wait-for-approval"), exports);
 __exportStar(require("./workflows/batch-links"), exports);
 __exportStar(require("./workflows/create-links"), exports);
 __exportStar(require("./workflows/dismiss-links"), exports);

package/dist/common/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAuC;AACvC,8DAA2C;AAC3C,+DAA4C;AAC5C,0DAAuC;AACvC,qDAAkC;AAClC,8DAA2C;AAC3C,8DAA2C;AAC3C,0DAAuC;AACvC,2DAAwC;AACxC,+DAA4C;AAC5C,0DAAuC;AACvC,2DAAwC;AACxC,4DAAyC;AACzC,2DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAuC;AACvC,8DAA2C;AAC3C,+DAA4C;AAC5C,0DAAuC;AACvC,qDAAkC;AAClC,8DAA2C;AAC3C,8DAA2C;AAC3C,0DAAuC;AACvC,2DAAwC;AACxC,+DAA4C;AAC5C,4DAAyC;AACzC,0DAAuC;AACvC,2DAAwC;AACxC,4DAAyC;AACzC,2DAAwC"}

package/dist/common/steps/wait-for-approval.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Configuration for the wait-for-approval step.
+ */
+type WaitForApprovalInput = {
+    /**
+     * A human-readable description of what approval is being requested.
+     * Surfaced in dashboards and audit logs.
+     */
+    description?: string;
+    /**
+     * Timeout in seconds. If no approval/rejection is received
+     * within this window the step will fail permanently.
+     */
+    timeout?: number;
+};
+export declare const waitForApprovalStepId = "wait-for-approval";
+/**
+ * An async step that pauses the workflow until an external actor
+ * calls `registerStepSuccess` (approve) or `registerStepFailure` (reject)
+ * via the workflow engine API.
+ *
+ * This leverages the existing `async: true` mechanism so the step
+ * goes into WAITING status and the transaction is checkpointed.
+ *
+ * @example
+ * ```ts
+ * import { createWorkflow, WorkflowResponse } from "@acmekit/framework/workflows-sdk"
+ * import { waitForApprovalStep } from "@acmekit/core-flows"
+ *
+ * const approvalWorkflow = createWorkflow("approval-workflow", () => {
+ *   // ... earlier steps ...
+ *   const approval = waitForApprovalStep({
+ *     description: "Manager must approve the refund",
+ *     timeout: 86400, // 24 hours
+ *   })
+ *   // ... later steps only run after approval ...
+ *   return new WorkflowResponse(approval)
+ * })
+ * ```
+ */
+export declare const waitForApprovalStep: import("@acmekit/framework/workflows-sdk").StepFunction<WaitForApprovalInput, {
+    approved: boolean;
+    description: string | undefined;
+}>;
+export {};
+//# sourceMappingURL=wait-for-approval.d.ts.map

package/dist/common/steps/wait-for-approval.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait-for-approval.d.ts","sourceRoot":"","sources":["../../../src/common/steps/wait-for-approval.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,KAAK,oBAAoB,GAAG;IAC1B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,qBAAqB,sBAAsB,CAAA;AAExD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,mBAAmB;;;EAgB/B,CAAA"}

package/dist/common/steps/wait-for-approval.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForApprovalStep = exports.waitForApprovalStepId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.waitForApprovalStepId = "wait-for-approval";
+/**
+ * An async step that pauses the workflow until an external actor
+ * calls `registerStepSuccess` (approve) or `registerStepFailure` (reject)
+ * via the workflow engine API.
+ *
+ * This leverages the existing `async: true` mechanism so the step
+ * goes into WAITING status and the transaction is checkpointed.
+ *
+ * @example
+ * ```ts
+ * import { createWorkflow, WorkflowResponse } from "@acmekit/framework/workflows-sdk"
+ * import { waitForApprovalStep } from "@acmekit/core-flows"
+ *
+ * const approvalWorkflow = createWorkflow("approval-workflow", () => {
+ *   // ... earlier steps ...
+ *   const approval = waitForApprovalStep({
+ *     description: "Manager must approve the refund",
+ *     timeout: 86400, // 24 hours
+ *   })
+ *   // ... later steps only run after approval ...
+ *   return new WorkflowResponse(approval)
+ * })
+ * ```
+ */
+exports.waitForApprovalStep = (0, workflows_sdk_1.createStep)({
+    name: exports.waitForApprovalStepId,
+    async: true,
+    timeout: 86400, // default: 24 hours
+}, async (input) => {
+    // The step handler returns immediately. Because `async: true`,
+    // the orchestrator puts this step into WAITING status.
+    // An external call to registerStepSuccess/registerStepFailure
+    // will resume the workflow.
+    return new workflows_sdk_1.StepResponse({
+        approved: true,
+        description: input?.description,
+    });
+});
+//# sourceMappingURL=wait-for-approval.js.map

package/dist/common/steps/wait-for-approval.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait-for-approval.js","sourceRoot":"","sources":["../../../src/common/steps/wait-for-approval.ts"],"names":[],"mappings":";;;AAAA,oEAGyC;AAkB5B,QAAA,qBAAqB,GAAG,mBAAmB,CAAA;AAExD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,mBAAmB,GAAG,IAAA,0BAAU,EAC3C;IACE,IAAI,EAAE,6BAAqB;IAC3B,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,KAAK,EAAE,oBAAoB;CACrC,EACD,KAAK,EAAE,KAA2B,EAAE,EAAE;IACpC,+DAA+D;IAC/D,uDAAuD;IACvD,8DAA8D;IAC9D,4BAA4B;IAC5B,OAAO,IAAI,4BAAY,CAAC;QACtB,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,KAAK,EAAE,WAAW;KAChC,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/index.ts","../src/api-key/index.ts","../src/api-key/steps/create-api-keys.ts","../src/api-key/steps/delete-api-keys.ts","../src/api-key/steps/index.ts","../src/api-key/steps/revoke-api-keys.ts","../src/api-key/steps/update-api-keys.ts","../src/api-key/workflows/create-api-keys.ts","../src/api-key/workflows/delete-api-keys.ts","../src/api-key/workflows/index.ts","../src/api-key/workflows/revoke-api-keys.ts","../src/api-key/workflows/update-api-keys.ts","../src/auth/index.ts","../src/auth/steps/index.ts","../src/auth/steps/set-auth-app-metadata.ts","../src/auth/workflows/generate-reset-password-token.ts","../src/auth/workflows/index.ts","../src/auth/workflows/set-auth-app-metadata.ts","../src/common/index.ts","../src/common/steps/create-entities.ts","../src/common/steps/create-remote-links.ts","../src/common/steps/delete-entities.ts","../src/common/steps/dismiss-remote-links.ts","../src/common/steps/emit-event.ts","../src/common/steps/release-event.ts","../src/common/steps/remove-remote-links.ts","../src/common/steps/update-remote-links.ts","../src/common/steps/use-query-graph.ts","../src/common/steps/use-remote-query.ts","../src/common/steps/validate-presence-of.ts","../src/common/steps/__fixtures__/remote-query.ts","../src/common/steps/__tests__/use-query-graph-step.spec.ts","../src/common/workflows/batch-links.ts","../src/common/workflows/create-links.ts","../src/common/workflows/dismiss-links.ts","../src/common/workflows/update-links.ts","../src/defaults/index.ts","../src/defaults/steps/index.ts","../src/defaults/workflows/create-defaults.ts","../src/defaults/workflows/index.ts","../src/file/index.ts","../src/file/steps/delete-files.ts","../src/file/steps/index.ts","../src/file/steps/upload-files.ts","../src/file/workflows/delete-files.ts","../src/file/workflows/index.ts","../src/file/workflows/upload-files.ts","../src/invite/index.ts","../src/invite/steps/create-invites.ts","../src/invite/steps/delete-invites.ts","../src/invite/steps/get-invite-roles.ts","../src/invite/steps/index.ts","../src/invite/steps/refresh-invite-tokens.ts","../src/invite/steps/validate-roles-exist.ts","../src/invite/steps/validate-token.ts","../src/invite/workflows/accept-invite.ts","../src/invite/workflows/create-invites.ts","../src/invite/workflows/delete-invites.ts","../src/invite/workflows/index.ts","../src/invite/workflows/refresh-invite-tokens.ts","../src/locking/index.ts","../src/locking/steps/acquire-lock.ts","../src/locking/steps/release-lock.ts","../src/notification/index.ts","../src/notification/steps/index.ts","../src/notification/steps/notify-on-failure.ts","../src/notification/steps/send-notifications.ts","../src/rbac/index.ts","../src/rbac/steps/create-rbac-policies.ts","../src/rbac/steps/create-rbac-role-parents.ts","../src/rbac/steps/create-rbac-role-policies.ts","../src/rbac/steps/create-rbac-roles.ts","../src/rbac/steps/delete-rbac-policies.ts","../src/rbac/steps/delete-rbac-role-policies.ts","../src/rbac/steps/delete-rbac-roles.ts","../src/rbac/steps/index.ts","../src/rbac/steps/set-role-parent.ts","../src/rbac/steps/update-rbac-policies.ts","../src/rbac/steps/update-rbac-role-policies.ts","../src/rbac/steps/update-rbac-roles.ts","../src/rbac/steps/validate-user-permissions.ts","../src/rbac/workflows/create-rbac-policies.ts","../src/rbac/workflows/create-rbac-role-policies.ts","../src/rbac/workflows/create-rbac-roles.ts","../src/rbac/workflows/delete-rbac-policies.ts","../src/rbac/workflows/delete-rbac-role-policies.ts","../src/rbac/workflows/delete-rbac-roles.ts","../src/rbac/workflows/index.ts","../src/rbac/workflows/update-rbac-policies.ts","../src/rbac/workflows/update-rbac-role-policies.ts","../src/rbac/workflows/update-rbac-roles.ts","../src/settings/index.ts","../src/settings/steps/create-view-configuration.ts","../src/settings/steps/index.ts","../src/settings/steps/set-active-view-configuration.ts","../src/settings/steps/update-view-configuration.ts","../src/settings/workflows/create-view-configuration.ts","../src/settings/workflows/index.ts","../src/settings/workflows/update-view-configuration.ts","../src/translation/index.ts","../src/translation/steps/create-translation-settings.ts","../src/translation/steps/create-translations.ts","../src/translation/steps/delete-translation-settings.ts","../src/translation/steps/delete-translations.ts","../src/translation/steps/index.ts","../src/translation/steps/update-translation-settings.ts","../src/translation/steps/update-translations.ts","../src/translation/steps/validate-translations.ts","../src/translation/workflows/batch-translation-settings.ts","../src/translation/workflows/batch-translations.ts","../src/translation/workflows/create-translations.ts","../src/translation/workflows/delete-translations.ts","../src/translation/workflows/index.ts","../src/translation/workflows/update-translations.ts","../src/user/index.ts","../src/user/steps/create-users.ts","../src/user/steps/delete-users.ts","../src/user/steps/index.ts","../src/user/steps/update-users.ts","../src/user/workflows/create-user-account.ts","../src/user/workflows/create-users.ts","../src/user/workflows/delete-users.ts","../src/user/workflows/index.ts","../src/user/workflows/remove-user-account.ts","../src/user/workflows/update-users.ts"],"version":"5.9.3"}
+{"root":["../src/index.ts","../src/api-key/index.ts","../src/api-key/steps/create-api-keys.ts","../src/api-key/steps/delete-api-keys.ts","../src/api-key/steps/index.ts","../src/api-key/steps/revoke-api-keys.ts","../src/api-key/steps/update-api-keys.ts","../src/api-key/workflows/create-api-keys.ts","../src/api-key/workflows/delete-api-keys.ts","../src/api-key/workflows/index.ts","../src/api-key/workflows/revoke-api-keys.ts","../src/api-key/workflows/update-api-keys.ts","../src/auth/index.ts","../src/auth/steps/index.ts","../src/auth/steps/set-auth-app-metadata.ts","../src/auth/workflows/generate-reset-password-token.ts","../src/auth/workflows/index.ts","../src/auth/workflows/set-auth-app-metadata.ts","../src/common/index.ts","../src/common/steps/create-entities.ts","../src/common/steps/create-remote-links.ts","../src/common/steps/delete-entities.ts","../src/common/steps/dismiss-remote-links.ts","../src/common/steps/emit-event.ts","../src/common/steps/release-event.ts","../src/common/steps/remove-remote-links.ts","../src/common/steps/update-remote-links.ts","../src/common/steps/use-query-graph.ts","../src/common/steps/use-remote-query.ts","../src/common/steps/validate-presence-of.ts","../src/common/steps/wait-for-approval.ts","../src/common/steps/__fixtures__/remote-query.ts","../src/common/steps/__tests__/use-query-graph-step.spec.ts","../src/common/workflows/batch-links.ts","../src/common/workflows/create-links.ts","../src/common/workflows/dismiss-links.ts","../src/common/workflows/update-links.ts","../src/defaults/index.ts","../src/defaults/steps/index.ts","../src/defaults/workflows/create-defaults.ts","../src/defaults/workflows/index.ts","../src/file/index.ts","../src/file/steps/delete-files.ts","../src/file/steps/index.ts","../src/file/steps/upload-files.ts","../src/file/workflows/delete-files.ts","../src/file/workflows/index.ts","../src/file/workflows/upload-files.ts","../src/invite/index.ts","../src/invite/steps/create-invites.ts","../src/invite/steps/delete-invites.ts","../src/invite/steps/get-invite-roles.ts","../src/invite/steps/index.ts","../src/invite/steps/refresh-invite-tokens.ts","../src/invite/steps/validate-roles-exist.ts","../src/invite/steps/validate-token.ts","../src/invite/workflows/accept-invite.ts","../src/invite/workflows/create-invites.ts","../src/invite/workflows/delete-invites.ts","../src/invite/workflows/index.ts","../src/invite/workflows/refresh-invite-tokens.ts","../src/locking/index.ts","../src/locking/steps/acquire-lock.ts","../src/locking/steps/release-lock.ts","../src/notification/index.ts","../src/notification/steps/index.ts","../src/notification/steps/notify-on-failure.ts","../src/notification/steps/send-notifications.ts","../src/rbac/index.ts","../src/rbac/steps/create-rbac-policies.ts","../src/rbac/steps/create-rbac-role-parents.ts","../src/rbac/steps/create-rbac-role-policies.ts","../src/rbac/steps/create-rbac-roles.ts","../src/rbac/steps/delete-rbac-policies.ts","../src/rbac/steps/delete-rbac-role-policies.ts","../src/rbac/steps/delete-rbac-roles.ts","../src/rbac/steps/index.ts","../src/rbac/steps/set-role-parent.ts","../src/rbac/steps/update-rbac-policies.ts","../src/rbac/steps/update-rbac-role-policies.ts","../src/rbac/steps/update-rbac-roles.ts","../src/rbac/steps/validate-user-permissions.ts","../src/rbac/workflows/create-rbac-policies.ts","../src/rbac/workflows/create-rbac-role-policies.ts","../src/rbac/workflows/create-rbac-roles.ts","../src/rbac/workflows/delete-rbac-policies.ts","../src/rbac/workflows/delete-rbac-role-policies.ts","../src/rbac/workflows/delete-rbac-roles.ts","../src/rbac/workflows/index.ts","../src/rbac/workflows/update-rbac-policies.ts","../src/rbac/workflows/update-rbac-role-policies.ts","../src/rbac/workflows/update-rbac-roles.ts","../src/settings/index.ts","../src/settings/steps/create-view-configuration.ts","../src/settings/steps/index.ts","../src/settings/steps/set-active-view-configuration.ts","../src/settings/steps/update-view-configuration.ts","../src/settings/workflows/create-view-configuration.ts","../src/settings/workflows/index.ts","../src/settings/workflows/update-view-configuration.ts","../src/translation/index.ts","../src/translation/steps/create-translation-settings.ts","../src/translation/steps/create-translations.ts","../src/translation/steps/delete-translation-settings.ts","../src/translation/steps/delete-translations.ts","../src/translation/steps/index.ts","../src/translation/steps/update-translation-settings.ts","../src/translation/steps/update-translations.ts","../src/translation/steps/validate-translations.ts","../src/translation/workflows/batch-translation-settings.ts","../src/translation/workflows/batch-translations.ts","../src/translation/workflows/create-translations.ts","../src/translation/workflows/delete-translations.ts","../src/translation/workflows/index.ts","../src/translation/workflows/update-translations.ts","../src/user/index.ts","../src/user/steps/create-users.ts","../src/user/steps/delete-users.ts","../src/user/steps/index.ts","../src/user/steps/update-users.ts","../src/user/workflows/create-user-account.ts","../src/user/workflows/create-users.ts","../src/user/workflows/delete-users.ts","../src/user/workflows/index.ts","../src/user/workflows/remove-user-account.ts","../src/user/workflows/update-users.ts"],"version":"5.9.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acmekit/core-flows",
-  "version": "2.13.34",
+  "version": "2.13.36",
   "description": "Set of workflow definitions for AcmeKit",
   "main": "dist/index.js",
   "exports": {
@@ -26,14 +26,14 @@
   "author": "AcmeKit",
   "license": "MIT",
   "devDependencies": {
-    "@acmekit/framework": "2.13.34"
+    "@acmekit/framework": "2.13.36"
   },
   "dependencies": {
     "csv-parse": "^5.6.0",
     "json-2-csv": "^5.5.4"
   },
   "peerDependencies": {
-    "@acmekit/framework": "2.13.34"
+    "@acmekit/framework": "2.13.36"
   },
   "scripts": {
     "build": "yarn run -T rimraf dist && yarn run -T tsc --build",