@particle-academy/fancy-flow 0.65.0 → 0.65.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/dist/index.cjs +2 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/ux.cjs +8 -3
- package/dist/ux.cjs.map +1 -1
- package/dist/ux.d.cts +12 -0
- package/dist/ux.d.ts +12 -0
- package/dist/ux.js +8 -3
- package/dist/ux.js.map +1 -1
- package/package.json +1 -1
package/dist/ux.d.cts
CHANGED
|
@@ -20,6 +20,18 @@ type UxEffectMeta = {
|
|
|
20
20
|
category?: NodeCategory;
|
|
21
21
|
/** Config form fields = the effect's params. */
|
|
22
22
|
configSchema?: ConfigField[];
|
|
23
|
+
/**
|
|
24
|
+
* Include the executor's exact resolved input-port map as `$inputs` in the
|
|
25
|
+
* effect params. Off by default so existing effects keep their payload shape.
|
|
26
|
+
*/
|
|
27
|
+
includeInputs?: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Make this UX node an inline step instead of a terminal notification. It
|
|
30
|
+
* gains an `out` port, waits for the effect Promise, then emits its `in`
|
|
31
|
+
* payload unchanged. This is the native shape for dialogs/overlays whose
|
|
32
|
+
* lifetime gates the rest of a workflow.
|
|
33
|
+
*/
|
|
34
|
+
passThrough?: boolean;
|
|
23
35
|
};
|
|
24
36
|
type FlowRunnerUxOptions = {
|
|
25
37
|
/** Named host UX effects the flow can invoke. */
|
package/dist/ux.d.ts
CHANGED
|
@@ -20,6 +20,18 @@ type UxEffectMeta = {
|
|
|
20
20
|
category?: NodeCategory;
|
|
21
21
|
/** Config form fields = the effect's params. */
|
|
22
22
|
configSchema?: ConfigField[];
|
|
23
|
+
/**
|
|
24
|
+
* Include the executor's exact resolved input-port map as `$inputs` in the
|
|
25
|
+
* effect params. Off by default so existing effects keep their payload shape.
|
|
26
|
+
*/
|
|
27
|
+
includeInputs?: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Make this UX node an inline step instead of a terminal notification. It
|
|
30
|
+
* gains an `out` port, waits for the effect Promise, then emits its `in`
|
|
31
|
+
* payload unchanged. This is the native shape for dialogs/overlays whose
|
|
32
|
+
* lifetime gates the rest of a workflow.
|
|
33
|
+
*/
|
|
34
|
+
passThrough?: boolean;
|
|
23
35
|
};
|
|
24
36
|
type FlowRunnerUxOptions = {
|
|
25
37
|
/** Named host UX effects the flow can invoke. */
|
package/dist/ux.js
CHANGED
|
@@ -15,12 +15,15 @@ function createFlowRunnerUx(options) {
|
|
|
15
15
|
const dispatcher = createEffectDispatcher(effects, { actor, targetKind: "ux" });
|
|
16
16
|
const executors = {};
|
|
17
17
|
for (const name of Object.keys(effects)) {
|
|
18
|
-
executors[kindFor(name)] = async ({ node }) => {
|
|
19
|
-
const
|
|
18
|
+
executors[kindFor(name)] = async ({ node, inputs }) => {
|
|
19
|
+
const m = meta[name] ?? {};
|
|
20
|
+
const config = node.data?.config ?? {};
|
|
21
|
+
const params = m.includeInputs ? { ...config, $inputs: inputs } : config;
|
|
20
22
|
const result = await dispatcher.dispatch(name, params);
|
|
21
23
|
if (result && typeof result === "object" && ("branch" in result || "__port" in result)) {
|
|
22
24
|
return result;
|
|
23
25
|
}
|
|
26
|
+
if (m.passThrough) return inputs.in ?? inputs;
|
|
24
27
|
return { effect: name, result };
|
|
25
28
|
};
|
|
26
29
|
}
|
|
@@ -35,7 +38,9 @@ function createFlowRunnerUx(options) {
|
|
|
35
38
|
icon: m.icon ?? "\u2728",
|
|
36
39
|
accent: m.accent ?? "#8b5cf6",
|
|
37
40
|
inputs: [{ id: "in" }],
|
|
38
|
-
outputs: [],
|
|
41
|
+
outputs: m.passThrough ? [{ id: "out" }] : [],
|
|
42
|
+
emits: m.passThrough ? "input" : void 0,
|
|
43
|
+
sideEffects: "unsafe-to-replay",
|
|
39
44
|
configSchema: m.configSchema
|
|
40
45
|
});
|
|
41
46
|
}
|
package/dist/ux.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/ux.ts"],"names":[],"mappings":";;;;;;
|
|
1
|
+
{"version":3,"sources":["../src/ux.ts"],"names":[],"mappings":";;;;;;AAqFA,IAAM,cAAA,GAAiB,CAAC,IAAA,KAAiB,CAAA,GAAA,EAAM,IAAI,CAAA,CAAA;AAG5C,SAAS,mBAAmB,OAAA,EAA4C;AAC7E,EAAA,MAAM;AAAA,IACJ,OAAA;AAAA,IACA,OAAO,EAAC;AAAA,IACR,KAAA,GAAQ,EAAE,EAAA,EAAI,MAAA,EAAQ,QAAQ,MAAA,EAAO;AAAA,IACrC,OAAA,GAAU;AAAA,GACZ,GAAI,OAAA;AAEJ,EAAA,MAAM,aAAa,sBAAA,CAAuB,OAAA,EAAS,EAAE,KAAA,EAAO,UAAA,EAAY,MAAM,CAAA;AAE9E,EAAA,MAAM,YAA8B,EAAC;AACrC,EAAA,KAAA,MAAW,IAAA,IAAQ,MAAA,CAAO,IAAA,CAAK,OAAO,CAAA,EAAG;AACvC,IAAA,SAAA,CAAU,OAAA,CAAQ,IAAI,CAAC,CAAA,GAAI,OAAO,EAAE,IAAA,EAAM,QAAO,KAA2D;AAC1G,MAAA,MAAM,CAAA,GAAI,IAAA,CAAK,IAAI,CAAA,IAAK,EAAC;AACzB,MAAA,MAAM,MAAA,GAAU,IAAA,CAAK,IAAA,EAA2D,MAAA,IAAU,EAAC;AAC3F,MAAA,MAAM,MAAA,GAAS,EAAE,aAAA,GAAgB,EAAE,GAAG,MAAA,EAAQ,OAAA,EAAS,QAAO,GAAI,MAAA;AAClE,MAAA,MAAM,MAAA,GAAS,MAAM,UAAA,CAAW,QAAA,CAAS,MAAM,MAAM,CAAA;AAKrD,MAAA,IAAI,UAAU,OAAO,MAAA,KAAW,aAAa,QAAA,IAAY,MAAA,IAAU,YAAY,MAAA,CAAA,EAAS;AACtF,QAAA,OAAO,MAAA;AAAA,MACT;AACA,MAAA,IAAI,CAAA,CAAE,WAAA,EAAa,OAAO,MAAA,CAAO,EAAA,IAAM,MAAA;AACvC,MAAA,OAAO,EAAE,MAAA,EAAQ,IAAA,EAAM,MAAA,EAAO;AAAA,IAChC,CAAA;AAAA,EACF;AAEA,EAAA,MAAM,gBAAgB,MAAM;AAC1B,IAAA,KAAA,MAAW,IAAA,IAAQ,MAAA,CAAO,IAAA,CAAK,OAAO,CAAA,EAAG;AACvC,MAAA,MAAM,CAAA,GAAI,IAAA,CAAK,IAAI,CAAA,IAAK,EAAC;AACzB,MAAA,gBAAA,CAAiB;AAAA,QACf,IAAA,EAAM,QAAQ,IAAI,CAAA;AAAA,QAClB,QAAA,EAAU,EAAE,QAAA,IAAY,QAAA;AAAA,QACxB,KAAA,EAAO,EAAE,KAAA,IAAS,IAAA;AAAA,QAClB,WAAA,EAAa,CAAA,CAAE,WAAA,IAAe,CAAA,uBAAA,EAA0B,IAAI,CAAA,CAAA,CAAA;AAAA,QAC5D,IAAA,EAAM,EAAE,IAAA,IAAQ,QAAA;AAAA,QAChB,MAAA,EAAQ,EAAE,MAAA,IAAU,SAAA;AAAA,QACpB,MAAA,EAAQ,CAAC,EAAE,EAAA,EAAI,MAAM,CAAA;AAAA,QACrB,OAAA,EAAS,EAAE,WAAA,GAAc,CAAC,EAAE,EAAA,EAAI,KAAA,EAAO,CAAA,GAAI,EAAC;AAAA,QAC5C,KAAA,EAAO,CAAA,CAAE,WAAA,GAAc,OAAA,GAAU,MAAA;AAAA,QACjC,WAAA,EAAa,kBAAA;AAAA,QACb,cAAc,CAAA,CAAE;AAAA,OACjB,CAAA;AAAA,IACH;AAAA,EACF,CAAA;AAEA,EAAA,OAAO;AAAA,IACL,SAAA;AAAA,IACA,UAAU,UAAA,CAAW,QAAA;AAAA,IACrB,aAAa,UAAA,CAAW,KAAA;AAAA,IACxB;AAAA,GACF;AACF;AAMO,SAAS,gBAAgB,OAAA,EAA4C;AAC1E,EAAA,MAAM,MAAM,CAAA,EAAG,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,OAAO,CAAA,CAAE,IAAA,EAAK,CAAE,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA,EAAI,OAAA,CAAQ,KAAA,EAAO,MAAM,MAAM,CAAA,CAAA;AAE3F,EAAA,OAAO,QAAQ,MAAM,kBAAA,CAAmB,OAAO,CAAA,EAAG,CAAC,GAAG,CAAC,CAAA;AACzD","file":"ux.js","sourcesContent":["/**\n * FlowRunnerUx — the **flow-driven UX** bridge. The headless counterpart to\n * agent-integrations: where that wires an *agent* to host UI surfaces, this\n * wires a *running flow* to host UX. Both share the same primitives from\n * `@particle-academy/fancy-auto-common` (activity bus, effect dispatch).\n *\n * The host registers named UX effects (toast, navigate, confirm, …); this turns\n * each into a flow executor keyed by a node kind (`ux_<effect>` by default), so\n * dropping a `ux_toast` node into a `<FlowEditor>` and running it fires the\n * host's toast. Every dispatch broadcasts an `AutoActivityEvent` (source:\"flow\")\n * for presence / logging. Human-in-the-loop is free: an effect that returns a\n * Promise (e.g. an approval dialog) pauses the run until the user resolves it.\n *\n * const ux = createFlowRunnerUx({\n * effects: {\n * toast: ({ message }) => toast({ title: message }),\n * navigate:({ to }) => router.visit(to),\n * confirm: ({ prompt }) => new Promise(res => openDialog(prompt, res)), // pauses the run\n * },\n * });\n * ux.registerKinds(); // adds ux_toast / ux_navigate / ux_confirm to the palette\n * <FlowEditor initial={graph} executors={ux.executors} />\n */\nimport { useMemo } from \"react\";\nimport {\n createEffectDispatcher,\n type DispatchActor,\n type EffectRegistry,\n} from \"@particle-academy/fancy-auto-common\";\nimport { registerNodeKind } from \"./registry/registry\";\nimport type { ConfigField, NodeCategory } from \"./registry/types\";\nimport type { ExecutorRegistry, FlowNode } from \"./types\";\n\nexport type { AutoActivityEvent } from \"@particle-academy/fancy-auto-common\";\n\n/** Per-effect presentation for the palette node kind that drives it. */\nexport type UxEffectMeta = {\n /** Palette label. Default: the effect name. */\n label?: string;\n /** One-line palette description. */\n description?: string;\n /** Emoji / glyph for the node header. */\n icon?: string;\n /** Header accent color. */\n accent?: string;\n /** Palette grouping. Default \"output\". */\n category?: NodeCategory;\n /** Config form fields = the effect's params. */\n configSchema?: ConfigField[];\n /**\n * Include the executor's exact resolved input-port map as `$inputs` in the\n * effect params. Off by default so existing effects keep their payload shape.\n */\n includeInputs?: boolean;\n /**\n * Make this UX node an inline step instead of a terminal notification. It\n * gains an `out` port, waits for the effect Promise, then emits its `in`\n * payload unchanged. This is the native shape for dialogs/overlays whose\n * lifetime gates the rest of a workflow.\n */\n passThrough?: boolean;\n};\n\nexport type FlowRunnerUxOptions = {\n /** Named host UX effects the flow can invoke. */\n effects: EffectRegistry;\n /** Optional per-effect palette metadata (used by `registerKinds`). */\n meta?: Record<string, UxEffectMeta>;\n /** Identifies the flow run in emitted activity. Default `{ id: \"flow\", source: \"flow\" }`. */\n actor?: DispatchActor;\n /** Map an effect name to its node-kind name. Default `ux_<effect>`. */\n kindFor?: (effectName: string) => string;\n};\n\nexport type FlowRunnerUx = {\n /** Executor registry to hand to `<FlowEditor executors>` or `runFlow`. */\n executors: ExecutorRegistry;\n /** Invoke an effect imperatively (also emits activity). */\n dispatch: <R = unknown>(name: string, params?: unknown) => Promise<R>;\n /** All effect names. */\n effectNames: () => string[];\n /** Register a palette node kind per effect (`ux_<effect>`). Idempotent. */\n registerKinds: () => void;\n};\n\nconst defaultKindFor = (name: string) => `ux_${name}`;\n\n/** Build a FlowRunnerUx from a set of host effects. Framework-agnostic. */\nexport function createFlowRunnerUx(options: FlowRunnerUxOptions): FlowRunnerUx {\n const {\n effects,\n meta = {},\n actor = { id: \"flow\", source: \"flow\" },\n kindFor = defaultKindFor,\n } = options;\n\n const dispatcher = createEffectDispatcher(effects, { actor, targetKind: \"ux\" });\n\n const executors: ExecutorRegistry = {};\n for (const name of Object.keys(effects)) {\n executors[kindFor(name)] = async ({ node, inputs }: { node: FlowNode; inputs: Record<string, unknown> }) => {\n const m = meta[name] ?? {};\n const config = (node.data as { config?: Record<string, unknown> } | undefined)?.config ?? {};\n const params = m.includeInputs ? { ...config, $inputs: inputs } : config;\n const result = await dispatcher.dispatch(name, params);\n // A UX effect can drive flow control: if it returns the decision sugar\n // (`{ branch }` or `{ __port }`) — e.g. an interactive \"choose\" effect that\n // awaits a human pick and returns the chosen port — pass it straight\n // through so runFlow routes on it. Otherwise wrap the result for the feed.\n if (result && typeof result === \"object\" && (\"branch\" in result || \"__port\" in result)) {\n return result;\n }\n if (m.passThrough) return inputs.in ?? inputs;\n return { effect: name, result };\n };\n }\n\n const registerKinds = () => {\n for (const name of Object.keys(effects)) {\n const m = meta[name] ?? {};\n registerNodeKind({\n name: kindFor(name),\n category: m.category ?? \"output\",\n label: m.label ?? name,\n description: m.description ?? `Flow-driven UX effect: ${name}.`,\n icon: m.icon ?? \"✨\",\n accent: m.accent ?? \"#8b5cf6\",\n inputs: [{ id: \"in\" }],\n outputs: m.passThrough ? [{ id: \"out\" }] : [],\n emits: m.passThrough ? \"input\" : undefined,\n sideEffects: \"unsafe-to-replay\",\n configSchema: m.configSchema,\n });\n }\n };\n\n return {\n executors,\n dispatch: dispatcher.dispatch as FlowRunnerUx[\"dispatch\"],\n effectNames: dispatcher.names,\n registerKinds,\n };\n}\n\n/**\n * React hook form — memoizes on the effect-name set + actor id so the returned\n * executors keep a stable identity across renders.\n */\nexport function useFlowRunnerUx(options: FlowRunnerUxOptions): FlowRunnerUx {\n const key = `${Object.keys(options.effects).sort().join(\",\")}|${options.actor?.id ?? \"flow\"}`;\n // eslint-disable-next-line react-hooks/exhaustive-deps\n return useMemo(() => createFlowRunnerUx(options), [key]);\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@particle-academy/fancy-flow",
|
|
3
|
-
"version": "0.65.
|
|
3
|
+
"version": "0.65.2",
|
|
4
4
|
"description": "Workflow editor + runner. Six built-in node kits (trigger / action / decision / output / note / subgraph), tokenized theme, topological execution with per-node status. React-flow bundled; consumers npm install fancy-flow and get nothing extra.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|