@atscript/moost-wf 0.1.68 → 0.1.69

package/README.md

@@ -17,7 +17,7 @@ Part of the [atscript-ui](https://github.com/moostjs/atscript-ui) monorepo.
 - Workflow decorators that wrap Moost handlers and expose them as `@atscript/vue-wf`-compatible endpoints
 - Interceptors that serialize / deserialize workflow state across HTTP requests
 - `@AsWfState` storage abstraction with a default `@atscript/db`-backed implementation
-- Unified `WfFinished` envelope + helpers (`finishWfWithData`, `finishWfWithRedirect`, `finishWfWithChoice`, …) for terminal-screen UX. See [Finish Screens](https://ui.atscript.dev/workflows/finish-screens).
+- Unified `WfFinished` envelope + helpers (`finishWf(opts)`, `abortWf(reason, opts)`) for terminal-screen UX. See [Finish Screens](https://ui.atscript.dev/workflows/finish-screens).
 
 ## Install
 

package/dist/index.d.mts

@@ -124,7 +124,6 @@ interface TFormActions {
 declare function extractPassContext(type: TAtscriptAnnotatedType, wfContext: Record<string, unknown>): Record<string, unknown>;
 /**
  * Read declared action names from `@ui.form.action` and `@wf.action.withData` annotations.
- * Also reads legacy `@ui.altAction` as a stateless action fallback.
  * Results are cached per type identity.
  */
 declare function getFormActions(type: TAtscriptAnnotatedType): TFormActions;
@@ -179,7 +178,7 @@ interface WfFinished<TData = unknown> {
   finished: true;
   data?: TData;
   message?: WfMessage;
-  end?: WfFinishedEnd;
+  next?: WfNext;
   aborted?: boolean;
   reason?: string;
 }
@@ -187,11 +186,11 @@ interface WfMessage {
   level: "info" | "success" | "warn" | "error";
   text: string;
 }
-type WfFinishedEnd = {
-  mode: "immediate";
+type WfNext = {
+  trigger: "immediate";
   action: WfAction;
 } | {
-  mode: "auto";
+  trigger: "auto";
   timeoutMs: number;
   action: WfAction;
   skipButton?: {
@@ -199,7 +198,7 @@ type WfFinishedEnd = {
     behavior?: "now" | "cancel";
   };
 } | {
-  mode: "manual";
+  trigger: "manual";
   primary?: WfButton;
   options?: WfButton[];
 };
@@ -218,28 +217,41 @@ type WfAction = {
 };
 /** Type-guard for the unified envelope. */
 declare function isWfFinished(v: unknown): v is WfFinished;
-declare function finishWf<T>(payload: WfFinished<T>): void;
-declare function finishWfWithData<T>(data: T, message?: WfMessage): void;
-declare function finishWfWithMessage(level: WfMessage["level"], text: string): void;
-interface RedirectOpts {
-  reason?: string;
-  message?: WfMessage;
-  /** Present → `mode: 'auto'` with countdown; absent → `mode: 'immediate'`. */
-  autoMs?: number;
-  /** Only honored when `autoMs` is set — adds a "skip / cancel" button. */
-  skipLabel?: string;
-}
-declare function finishWfWithRedirect(target: string, opts?: RedirectOpts): void;
-interface ChoiceOpts {
-  data?: unknown;
+/**
+ * Options bag shared by `finishWf` and `abortWf`. Every field is optional
+ * — pick whichever envelope properties the terminal screen needs.
+ */
+interface FinishWfOpts<T = unknown> {
+  data?: T;
   message?: WfMessage;
-  primary?: WfButton;
-  options?: WfButton[];
+  next?: WfNext;
 }
-declare function finishWfWithChoice(opts: ChoiceOpts): void;
-declare function finishWfAborted(reason: string, opts?: {
-  message?: WfMessage;
-  end?: WfFinishedEnd;
-}): void;
+/**
+ * Build a `WfFinished` envelope and hand it to wooks. All envelope
+ * properties are optional; pass `data`, `message`, and/or `next`:
+ *
+ *   finishWf({ data: { id: 42 } });
+ *   finishWf({ message: { level: "success", text: "Saved." } });
+ *   finishWf({
+ *     next: {
+ *       trigger: "auto",
+ *       timeoutMs: 3000,
+ *       action: { type: "redirect", target: "/home" },
+ *     },
+ *   });
+ */
+declare function finishWf<T = unknown>(opts?: FinishWfOpts<T>): void;
+/**
+ * Build an aborted `WfFinished` envelope (`aborted: true` + `reason`) and
+ * hand it to wooks. The same options as `finishWf` are accepted — an
+ * aborted flow may still carry partial `data`, a `message`, or a `next`
+ * action that lets the user navigate away.
+ *
+ *   abortWf("user-cancelled");
+ *   abortWf("rate-limited", {
+ *     message: { level: "warn", text: "Try again later." },
+ *   });
+ */
+declare function abortWf(reason: string, opts?: FinishWfOpts): void;
 //#endregion
-export { AltAction, type ChoiceOpts, FormInput, FormInputRequired, type RedirectOpts, type TFormInput, type WfAction, type WfButton, type WfFinished, type WfFinishedEnd, type WfMessage, createAsHttpOutlet, extractPassContext, finishWf, finishWfAborted, finishWfWithChoice, finishWfWithData, finishWfWithMessage, finishWfWithRedirect, formInputInterceptor, getFormActions, handleAsOutletRequest, isWfFinished, serializeFormSchema, useFormInput, useWfAction };
+export { AltAction, type FinishWfOpts, FormInput, FormInputRequired, type TFormInput, type WfAction, type WfButton, type WfFinished, type WfMessage, type WfNext, abortWf, createAsHttpOutlet, extractPassContext, finishWf, formInputInterceptor, getFormActions, handleAsOutletRequest, isWfFinished, serializeFormSchema, useFormInput, useWfAction };

package/dist/index.mjs

@@ -7,7 +7,6 @@ import { useWfFinished } from "@wooksjs/event-wf";
 const WF_CONTEXT_PASS = "wf.context.pass";
 const UI_FORM_ACTION = "ui.form.action";
 const WF_ACTION_WITH_DATA = "wf.action.withData";
-const UI_ALT_ACTION = "ui.altAction";
 const formActionsCache = /* @__PURE__ */ new WeakMap();
 /**
 * Extract whitelisted context keys from workflow state.
@@ -22,7 +21,6 @@ function extractPassContext(type, wfContext) {
 }
 /**
 * Read declared action names from `@ui.form.action` and `@wf.action.withData` annotations.
-* Also reads legacy `@ui.altAction` as a stateless action fallback.
 * Results are cached per type identity.
 */
 function getFormActions(type) {
@@ -50,8 +48,6 @@ function getFormActions(type) {
 			actionsWithData.push(wfAction);
 			continue;
 		}
-		const altAction = fieldType.metadata.get(UI_ALT_ACTION);
-		if (altAction) actions.push(typeof altAction === "string" ? altAction : altAction.id);
 	}
 	const result = {
 		actions,
@@ -419,67 +415,44 @@ function setEnvelope(envelope) {
 		value: envelope
 	});
 }
-function finishWf(payload) {
-	setEnvelope(payload);
-}
-function finishWfWithData(data, message) {
-	finishWf({
-		finished: true,
-		data,
-		message
-	});
-}
-function finishWfWithMessage(level, text) {
-	finishWf({
-		finished: true,
-		message: {
-			level,
-			text
-		}
-	});
-}
-function finishWfWithRedirect(target, opts = {}) {
-	const action = {
-		type: "redirect",
-		target,
-		reason: opts.reason
-	};
-	const end = opts.autoMs ? {
-		mode: "auto",
-		timeoutMs: opts.autoMs,
-		action,
-		skipButton: opts.skipLabel ? { label: opts.skipLabel } : void 0
-	} : {
-		mode: "immediate",
-		action
-	};
-	finishWf({
-		finished: true,
-		message: opts.message,
-		end
-	});
-}
-function finishWfWithChoice(opts) {
-	if (!opts.primary && (!opts.options || opts.options.length === 0)) throw new Error("finishWfWithChoice() requires at least a primary button or one option.");
-	finishWf({
+/**
+* Build a `WfFinished` envelope and hand it to wooks. All envelope
+* properties are optional; pass `data`, `message`, and/or `next`:
+*
+*   finishWf({ data: { id: 42 } });
+*   finishWf({ message: { level: "success", text: "Saved." } });
+*   finishWf({
+*     next: {
+*       trigger: "auto",
+*       timeoutMs: 3000,
+*       action: { type: "redirect", target: "/home" },
+*     },
+*   });
+*/
+function finishWf(opts) {
+	setEnvelope({
 		finished: true,
-		data: opts.data,
-		message: opts.message,
-		end: {
-			mode: "manual",
-			primary: opts.primary,
-			options: opts.options
-		}
+		...opts
 	});
 }
-function finishWfAborted(reason, opts = {}) {
-	finishWf({
+/**
+* Build an aborted `WfFinished` envelope (`aborted: true` + `reason`) and
+* hand it to wooks. The same options as `finishWf` are accepted — an
+* aborted flow may still carry partial `data`, a `message`, or a `next`
+* action that lets the user navigate away.
+*
+*   abortWf("user-cancelled");
+*   abortWf("rate-limited", {
+*     message: { level: "warn", text: "Try again later." },
+*   });
+*/
+function abortWf(reason, opts) {
+	setEnvelope({
 		finished: true,
 		aborted: true,
 		reason,
-		message: opts.message,
-		end: opts.end
+		...opts
 	});
 }
 //#endregion
-export { AltAction, FormInput, FormInputRequired, createAsHttpOutlet, extractPassContext, finishWf, finishWfAborted, finishWfWithChoice, finishWfWithData, finishWfWithMessage, finishWfWithRedirect, formInputInterceptor, getFormActions, handleAsOutletRequest, isWfFinished, serializeFormSchema, useFormInput, useWfAction };
+export { AltAction, FormInput, FormInputRequired, abortWf, createAsHttpOutlet, extractPassContext, finishWf, formInputInterceptor, getFormActions, handleAsOutletRequest, isWfFinished, serializeFormSchema, useFormInput, useWfAction };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atscript/moost-wf",
-  "version": "0.1.68",
+  "version": "0.1.69",
   "description": "Workflow form integration for moost — decorators, interceptors, and serialization driven by atscript type metadata",
   "keywords": [
     "atscript",
@@ -51,26 +51,26 @@
     "access": "public"
   },
   "devDependencies": {
-    "@atscript/core": "^0.1.56",
-    "@atscript/db": "^0.1.80",
-    "@atscript/db-sqlite": "^0.1.80",
-    "@atscript/typescript": "^0.1.56",
-    "@moostjs/event-wf": "^0.6.10",
+    "@atscript/core": "^0.1.58",
+    "@atscript/db": "^0.1.82",
+    "@atscript/db-sqlite": "^0.1.82",
+    "@atscript/typescript": "^0.1.58",
+    "@moostjs/event-wf": "^0.6.14",
     "@prostojs/wf": "^0.1.1",
-    "@wooksjs/event-core": "^0.7.12",
-    "@wooksjs/event-wf": "^0.7.12",
-    "moost": "^0.6.10",
-    "unplugin-atscript": "^0.1.56",
-    "vitest": "npm:@voidzero-dev/vite-plus-test@latest",
-    "@atscript/ui": "^0.1.68"
+    "@wooksjs/event-core": "^0.7.13",
+    "@wooksjs/event-wf": "^0.7.13",
+    "moost": "^0.6.14",
+    "unplugin-atscript": "^0.1.58",
+    "vitest": "npm:@voidzero-dev/vite-plus-test@0.1.14",
+    "@atscript/ui": "^0.1.69"
   },
   "peerDependencies": {
-    "@atscript/core": "^0.1.56",
-    "@atscript/typescript": "^0.1.56",
-    "@moostjs/event-wf": "^0.6.10",
-    "@wooksjs/event-core": "^0.7.12",
-    "@wooksjs/event-wf": "^0.7.12",
-    "moost": "^0.6.10"
+    "@atscript/core": "^0.1.58",
+    "@atscript/typescript": "^0.1.58",
+    "@moostjs/event-wf": "^0.6.14",
+    "@wooksjs/event-core": "^0.7.13",
+    "@wooksjs/event-wf": "^0.7.13",
+    "moost": "^0.6.14"
   },
   "scripts": {
     "build": "vp pack",