@atscript/moost-wf 0.1.62 → 0.1.64

package/README.md

@@ -17,6 +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).
 
 ## Install
 

package/dist/index.d.mts

@@ -174,4 +174,72 @@ declare function createAsHttpOutlet(): WfOutlet;
  */
 declare function handleAsOutletRequest(config: WfOutletTriggerConfig, deps: WfOutletTriggerDeps): Promise<unknown>;
 //#endregion
-export { AltAction, FormInput, FormInputRequired, type TFormInput, createAsHttpOutlet, extractPassContext, formInputInterceptor, getFormActions, handleAsOutletRequest, serializeFormSchema, useFormInput, useWfAction };
+//#region src/wf-finished.d.ts
+interface WfFinished<TData = unknown> {
+  finished: true;
+  data?: TData;
+  message?: WfMessage;
+  end?: WfFinishedEnd;
+  aborted?: boolean;
+  reason?: string;
+}
+interface WfMessage {
+  level: "info" | "success" | "warn" | "error";
+  text: string;
+}
+type WfFinishedEnd = {
+  mode: "immediate";
+  action: WfAction;
+} | {
+  mode: "auto";
+  timeoutMs: number;
+  action: WfAction;
+  skipButton?: {
+    label: string;
+    behavior?: "now" | "cancel";
+  };
+} | {
+  mode: "manual";
+  primary?: WfButton;
+  options?: WfButton[];
+};
+interface WfButton {
+  label: string;
+  action: WfAction;
+}
+type WfAction = {
+  type: "redirect";
+  target: string;
+  reason?: string;
+} | {
+  type: "reload";
+} | {
+  type: "dismiss";
+};
+/** 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;
+  message?: WfMessage;
+  primary?: WfButton;
+  options?: WfButton[];
+}
+declare function finishWfWithChoice(opts: ChoiceOpts): void;
+declare function finishWfAborted(reason: string, opts?: {
+  message?: WfMessage;
+  end?: WfFinishedEnd;
+}): 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 };

package/dist/index.mjs

@@ -2,6 +2,7 @@ import { createHttpOutlet, handleWfOutletRequest, useWfState } from "@moostjs/ev
 import { Intercept, Resolve, TInterceptorPriority, useControllerContext } from "moost";
 import { isAnnotatedType, serializeAnnotatedType } from "@atscript/typescript/utils";
 import { current, key } from "@wooksjs/event-core";
+import { useWfFinished } from "@wooksjs/event-wf";
 //#region src/form-input/context.ts
 const WF_CONTEXT_PASS = "wf.context.pass";
 const UI_FORM_ACTION = "ui.form.action";
@@ -407,4 +408,78 @@ async function handleAsOutletRequest(config, deps) {
 	return wrapFinished(await handleWfOutletRequest(config, deps));
 }
 //#endregion
-export { AltAction, FormInput, FormInputRequired, createAsHttpOutlet, extractPassContext, formInputInterceptor, getFormActions, handleAsOutletRequest, serializeFormSchema, useFormInput, useWfAction };
+//#region src/wf-finished.ts
+/** Type-guard for the unified envelope. */
+function isWfFinished(v) {
+	return !!(v && typeof v === "object" && v.finished);
+}
+function setEnvelope(envelope) {
+	useWfFinished().set({
+		type: "data",
+		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({
+		finished: true,
+		data: opts.data,
+		message: opts.message,
+		end: {
+			mode: "manual",
+			primary: opts.primary,
+			options: opts.options
+		}
+	});
+}
+function finishWfAborted(reason, opts = {}) {
+	finishWf({
+		finished: true,
+		aborted: true,
+		reason,
+		message: opts.message,
+		end: opts.end
+	});
+}
+//#endregion
+export { AltAction, FormInput, FormInputRequired, createAsHttpOutlet, extractPassContext, finishWf, finishWfAborted, finishWfWithChoice, finishWfWithData, finishWfWithMessage, finishWfWithRedirect, formInputInterceptor, getFormActions, handleAsOutletRequest, isWfFinished, serializeFormSchema, useFormInput, useWfAction };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atscript/moost-wf",
-  "version": "0.1.62",
+  "version": "0.1.64",
   "description": "Workflow form integration for moost — decorators, interceptors, and serialization driven by atscript type metadata",
   "keywords": [
     "atscript",
@@ -51,23 +51,24 @@
     "access": "public"
   },
   "devDependencies": {
-    "@atscript/core": "^0.1.55",
-    "@atscript/db": "^0.1.76",
-    "@atscript/db-sqlite": "^0.1.76",
-    "@atscript/typescript": "^0.1.55",
-    "@moostjs/event-wf": "^0.6.9",
+    "@atscript/core": "^0.1.56",
+    "@atscript/db": "^0.1.79",
+    "@atscript/db-sqlite": "^0.1.79",
+    "@atscript/typescript": "^0.1.56",
+    "@moostjs/event-wf": "^0.6.10",
     "@prostojs/wf": "^0.1.1",
-    "@wooksjs/event-core": "^0.7.11",
-    "moost": "^0.6.9",
-    "unplugin-atscript": "^0.1.55",
+    "@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.62"
+    "@atscript/ui": "^0.1.64"
   },
   "peerDependencies": {
-    "@atscript/core": "^0.1.55",
-    "@atscript/typescript": "^0.1.55",
-    "@moostjs/event-wf": "^0.6.9",
-    "moost": "^0.6.9"
+    "@atscript/core": "^0.1.56",
+    "@atscript/typescript": "^0.1.56",
+    "@moostjs/event-wf": "^0.6.10",
+    "moost": "^0.6.10"
   },
   "scripts": {
     "build": "vp pack",