@plitzi/sdk-interactions 0.33.2 → 0.34.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @plitzi/sdk-interactions
 
+## 0.34.0
+
+### Minor Changes
+
+- v0.34.0
+
+### Patch Changes
+
+- Updated dependencies [5aceda0]
+- Updated dependencies
+- Updated dependencies [5aceda0]
+  - @plitzi/sdk-shared@0.34.0
+  - @plitzi/sdk-auth@0.34.0
+  - @plitzi/sdk-dev-tools@0.34.0
+  - @plitzi/sdk-event-bridge@0.34.0
+  - @plitzi/sdk-navigation@0.34.0
+  - @plitzi/sdk-schema@0.34.0
+
 ## 0.33.2
 
 ### Patch Changes

package/dist/InteractionsHelper.d.ts

@@ -1,9 +1,9 @@
 import { ElementInteraction } from '@plitzi/sdk-shared';
 declare const flowTrigger: (triggerNode: ElementInteraction, nodes?: {}, callbacksAvailables?: {}, flowParams?: Record<string, unknown>, globalParams?: {}, 
-/** The idRef of the element this fired on, carried through purely so the log can name it. */
-elementRef?: string, postCallbacksTotal?: never[]) => Promise<void>;
+/** The id of the element this fired on, carried through purely so the log can name it. */
+hostElementId?: string, postCallbacksTotal?: never[]) => Promise<void>;
 export { flowTrigger };
 declare const InteractionsHelper: {
-    flowTrigger: (triggerNode: ElementInteraction, nodes?: {}, callbacksAvailables?: {}, flowParams?: Record<string, unknown>, globalParams?: {}, elementRef?: string, postCallbacksTotal?: never[]) => Promise<void>;
+    flowTrigger: (triggerNode: ElementInteraction, nodes?: {}, callbacksAvailables?: {}, flowParams?: Record<string, unknown>, globalParams?: {}, hostElementId?: string, postCallbacksTotal?: never[]) => Promise<void>;
 };
 export default InteractionsHelper;

package/dist/InteractionsHelper.mjs

@@ -5,144 +5,150 @@ import { pConsole as i } from "@plitzi/sdk-shared/devTools/utils/PlitziConsole";
 import { hasValidToken as a, processTwig as o } from "@plitzi/sdk-shared/helpers/twigWrapper";
 import { Fragment as s, jsx as c, jsxs as l } from "react/jsx-runtime";
 //#region src/InteractionsHelper.tsx
-var u = 5, d = (e, t, n, r, s) => e === "utility" && s === "twigTemplate" ? t : Object.keys(t).reduce((s, d) => {
-	let f = t[d];
-	if (e !== "trigger") {
-		let e = u;
-		for (; typeof f == "string" && a(f) && e > 0;) f = o(f, {
-			...n,
-			...r
-		}, !1, !0), e--;
-		typeof f == "string" && a(f) && i.warning("interactions", /* @__PURE__ */ l("span", { children: [
-			"Twig token resolution exceeded ",
-			u,
-			" passes for ",
-			/* @__PURE__ */ c("b", { children: d }),
-			", leaving unresolved tokens"
-		] }), {
-			param: d,
-			value: f
-		});
-	}
-	return {
-		...s,
-		[d]: f
+var u = 5, d = 5, f = (e, t, n, r, s) => {
+	if (e === "utility" && s === "twigTemplate") return t;
+	let f = {
+		...n,
+		...r
+	}, p = (e, t, n) => {
+		if (typeof e == "string") {
+			let n = e, r = u;
+			for (; typeof n == "string" && a(n) && r > 0;) n = o(n, f, !1, !0), r--;
+			return typeof n == "string" && a(n) && i.warning("interactions", /* @__PURE__ */ l("span", { children: [
+				"Twig token resolution exceeded ",
+				u,
+				" passes for ",
+				/* @__PURE__ */ c("b", { children: t }),
+				", leaving unresolved tokens"
+			] }), {
+				param: t,
+				value: n
+			}), n;
+		}
+		return n >= d || typeof e != "object" || !e ? e : Array.isArray(e) ? e.map((e) => p(e, t, n + 1)) : Object.fromEntries(Object.entries(e).map(([e, r]) => [e, p(r, t, n + 1)]));
 	};
-}, {}), f = async (n, a = {}, o = {}, s = {}) => {
-	let u = {}, f = [], { id: p, action: m, enabled: h, params: g, elementId: _, type: v, when: y } = n;
-	if (!m || !h) return {
+	return Object.keys(t).reduce((n, r) => {
+		let i = e === "trigger" ? t[r] : p(t[r], r, 0);
+		return {
+			...n,
+			[r]: i
+		};
+	}, {});
+}, p = async (n, a = {}, o = {}, s = {}, u = {}) => {
+	let d = {}, p = [], { id: m, action: h, enabled: g, params: _, elementId: v, type: y, when: b } = n;
+	if (!h || !g) return {
 		status: "disabled",
-		result: u,
-		postCallbacks: f
+		result: d,
+		postCallbacks: p
 	};
-	let b = {
+	let x = {
 		...s,
 		...o,
-		[p]: g
+		[m]: _
 	};
-	if (y && !r(y, b)) return {
+	if (b && !r(b, x)) return {
 		status: "skipped",
-		result: u,
-		postCallbacks: f,
-		whenParams: b
+		result: d,
+		postCallbacks: p,
+		whenParams: x
 	};
-	let x = {
+	let S = {
 		...o,
 		...s,
-		...d(v, g, o, s, m)
+		...f(y, _, o, s, h)
 	};
 	try {
-		switch (v) {
+		switch (y) {
 			case "callback":
 			case "globalCallback": {
-				if (!_) return i.warning("interactions", /* @__PURE__ */ l("span", { children: [
+				if (!v) return i.warning("interactions", /* @__PURE__ */ l("span", { children: [
 					"Step ",
-					/* @__PURE__ */ c("b", { children: m }),
+					/* @__PURE__ */ c("b", { children: h }),
 					" names no element, so there is nothing to run it on"
 				] }), { node: n }), {
 					status: "failed",
-					result: u,
-					postCallbacks: f,
-					whenParams: b
+					result: d,
+					postCallbacks: p,
+					whenParams: x
 				};
-				let e = t(a, `${_}.${m}`);
+				let e = t(a, `${v}.${h}`);
 				if (!e) return i.warning("interactions", /* @__PURE__ */ l("span", { children: [
 					"Nothing is registered as ",
-					/* @__PURE__ */ c("b", { children: `${_}.${m}` }),
+					/* @__PURE__ */ c("b", { children: `${v}.${h}` }),
 					", so this step did nothing"
 				] }), {
 					node: n,
-					available: Object.keys(t(a, _, {}))
+					available: Object.keys(t(a, v, {}))
 				}), {
 					status: "failed",
-					result: u,
-					postCallbacks: f,
-					whenParams: b
+					result: d,
+					postCallbacks: p,
+					whenParams: x
 				};
 				let { callback: r, postCallback: o } = e;
-				r && (u = await r(x)), o && f.push({
-					id: p,
+				r && (d = await r(S, u)), o && p.push({
+					id: m,
 					callback: o,
 					params: {
-						...x,
-						[p]: u
+						...S,
+						[m]: d
 					}
 				});
 				break;
 			}
 			case "utility": {
-				let { callback: n, postCallback: r } = t(e, m, {});
-				n && (u = await n(x)), r && f.push({
-					id: p,
+				let { callback: n, postCallback: r } = t(e, h, {});
+				n && (d = await n(S, u)), r && p.push({
+					id: m,
 					callback: r,
 					params: {
-						...x,
-						[p]: u
+						...S,
+						[m]: d
 					}
 				});
 				break;
 			}
 		}
 	} catch (e) {
-		return i.danger("interactions", /* @__PURE__ */ l("span", { children: ["Interaction node failed ", /* @__PURE__ */ c("b", { children: m })] }), {
+		return i.danger("interactions", /* @__PURE__ */ l("span", { children: ["Interaction node failed ", /* @__PURE__ */ c("b", { children: h })] }), {
 			error: e instanceof Error ? e.message : String(e),
 			node: n
 		}), {
 			status: "failed",
-			result: u,
-			postCallbacks: f,
-			whenParams: b
+			result: d,
+			postCallbacks: p,
+			whenParams: x
 		};
 	}
 	return {
 		status: "success",
-		result: u,
-		postCallbacks: f,
-		whenParams: b
+		result: d,
+		postCallbacks: p,
+		whenParams: x
 	};
-}, p = async (e = []) => {
+}, m = async (e = []) => {
 	let t = {};
 	return await Promise.all(e.reverse().map(async ({ id: e, callback: r, params: i }) => {
 		t[e] = await r?.(n(i, [e]), i[e]);
 	})), t;
-}, m = async (e, n = {}, r = {}, a = {}, o = {}, s = [], c = {}) => {
+}, h = async (e, n = {}, r = {}, a = {}, o = {}, s = [], c = {}, l = {}) => {
 	if (!e) return c;
-	let l = t(n, e.afterNode);
-	if (!l && s.length > 0 && await p(s), !l) return c;
-	let u = i.getTime().valueOf(), { status: d, result: h, postCallbacks: g, whenParams: _ } = await f(l, r, a, o);
-	return c[l.id] = {
-		node: l,
-		status: d,
-		result: h,
-		postCallbacks: g,
-		whenParams: _,
-		startTime: u,
+	let u = t(n, e.afterNode);
+	if (!u && s.length > 0 && await m(s), !u) return c;
+	let d = i.getTime().valueOf(), { status: f, result: g, postCallbacks: _, whenParams: v } = await p(u, r, a, o, l);
+	return c[u.id] = {
+		node: u,
+		status: f,
+		result: g,
+		postCallbacks: _,
+		whenParams: v,
+		startTime: d,
 		endTime: i.getTime().valueOf()
-	}, s.push(...g), m(l, n, r, {
+	}, s.push(..._), h(u, n, r, {
 		...a,
-		[l.id]: h
-	}, o, s, c);
-}, h = (e, t, n = {}, r, a) => {
+		[u.id]: g
+	}, o, s, c, l);
+}, g = (e, t, n = {}, r, a) => {
 	let o = i.getTime().valueOf(), u = r === "skipped" ? "skipped" : "success", d = /* @__PURE__ */ l("span", { children: [
 		"Interaction triggered ",
 		/* @__PURE__ */ c("b", { children: `${e.title} [${e.action}]` }),
@@ -151,7 +157,7 @@ var u = 5, d = (e, t, n, r, s) => e === "utility" && s === "twigTemplate" ? t :
 		status: r,
 		node: e,
 		elementId: e.elementId,
-		elementRef: a,
+		hostElementId: a,
 		nodes: {
 			...n,
 			[e.id]: {
@@ -171,17 +177,17 @@ var u = 5, d = (e, t, n, r, s) => e === "utility" && s === "twigTemplate" ? t :
 		return;
 	}
 	i.info("interactions", d, f);
-}, g = (e) => Object.values(e).some(({ status: e }) => e === "failed") ? "failed" : "completed", _ = async (e, t = {}, n = {}, a = {}, o = {}, s, c = []) => {
+}, _ = (e) => Object.values(e).some(({ status: e }) => e === "failed") ? "failed" : "completed", v = async (e, t = {}, n = {}, a = {}, o = {}, s, c = []) => {
 	let l = i.getTime().valueOf(), { action: u, enabled: d, when: f } = e;
 	if (!u || !d || f && !r(f, {
 		...o,
 		...a
 	})) {
-		h(e, l, {}, "skipped", s);
+		g(e, l, {}, "skipped", s);
 		return;
 	}
-	let p = await m(e, t, n, a, o, c);
-	h(e, l, p, g(p), s);
-}, v = { flowTrigger: _ };
+	let p = await h(e, t, n, a, o, c, {}, { hostElementId: s });
+	g(e, l, p, _(p), s);
+}, y = { flowTrigger: v };
 //#endregion
-export { v as default, _ as flowTrigger };
+export { y as default, v as flowTrigger };

package/dist/InteractionsManager.mjs

@@ -20,7 +20,7 @@ var i = class i {
 		}, this.lastUpdate = Date.now();
 	}
 	eventBridgeCallback = (r) => async (i, a, o) => {
-		if (!(!r || !a || !i || t(this.interactionsRunning, `${i}.${a}`))) {
+		if (r && a && i && !t(this.interactionsRunning, `${i}.${a}`)) {
 			n(this.interactionsRunning, `${i}.${a}`, !0);
 			try {
 				let n = t(this.subscriptors, `${i}.getAdditionalParams`, void 0), s;

package/dist/InteractionsSourcesProvider.d.ts

@@ -1,6 +1,9 @@
+import { HostActions } from '@plitzi/sdk-shared';
 import { ReactNode } from 'react';
 export type InteractionsSourcesProviderProps = {
     children?: ReactNode;
+    /** What the embedding application is willing to be asked to do — see {@link HostActions}. */
+    hostActions?: HostActions;
 };
-declare const InteractionsSourcesProvider: ({ children }: InteractionsSourcesProviderProps) => import("react").JSX.Element;
+declare const InteractionsSourcesProvider: ({ children, hostActions }: InteractionsSourcesProviderProps) => import("react").JSX.Element;
 export default InteractionsSourcesProvider;

package/dist/InteractionsSourcesProvider.mjs

@@ -1,29 +1,34 @@
 import e from "./InteractionsContextProvider.mjs";
-import t from "./sources/AuthSource/AuthInteractions.mjs";
-import n from "./sources/NavigationSource/NavigationInteractions.mjs";
-import r from "./sources/StateSource/StateInteractions.mjs";
-import { jsx as i } from "react/jsx-runtime";
-import { useRenderSettings as a, useSdkStore as o } from "@plitzi/sdk-shared/store";
+import t from "./sources/ActionsSource/ActionInteractions.mjs";
+import n from "./sources/AuthSource/AuthInteractions.mjs";
+import r from "./sources/HostSource/HostInteractions.mjs";
+import i from "./sources/NavigationSource/NavigationInteractions.mjs";
+import a from "./sources/StateSource/StateInteractions.mjs";
+import { jsx as o } from "react/jsx-runtime";
+import { useRenderSettings as s, useSdkStore as c } from "@plitzi/sdk-shared/store";
 //#region src/InteractionsSourcesProvider.tsx
-var s = ({ children: s }) => {
-	let [[c = "basic", l, u, d]] = o([
+var l = ({ children: l, hostActions: u }) => {
+	let [[d = "basic", f, p, m]] = c([
 		"schema.settings.userProvider",
 		"navigation.routeParams",
 		"navigation.queryParams",
 		"navigation.currentPageId"
-	]), { previewMode: f } = a();
-	return /* @__PURE__ */ i(e, {
-		currentPageId: d,
-		routeParams: l,
-		queryParams: u,
-		children: /* @__PURE__ */ i(t, {
-			authProvider: c,
-			children: /* @__PURE__ */ i(r, { children: /* @__PURE__ */ i(n, {
-				previewMode: f,
-				children: s
-			}) })
+	]), { previewMode: h } = s();
+	return /* @__PURE__ */ o(e, {
+		currentPageId: m,
+		routeParams: f,
+		queryParams: p,
+		children: /* @__PURE__ */ o(n, {
+			authProvider: d,
+			children: /* @__PURE__ */ o(a, { children: /* @__PURE__ */ o(t, { children: /* @__PURE__ */ o(i, {
+				previewMode: h,
+				children: /* @__PURE__ */ o(r, {
+					actions: u,
+					children: l
+				})
+			}) }) })
 		})
 	});
 };
 //#endregion
-export { s as default };
+export { l as default };

package/dist/hooks/useInteractions.d.ts

@@ -1,6 +1,6 @@
 import { ElementInteraction, InteractionCallback, Subscriptor } from '@plitzi/sdk-shared';
 export type UseInteractionsProps<TParams extends Record<string, unknown> = Record<string, unknown>> = {
-    /** The element's idRef: interactions are wired by ref only. Absent for an element that has none, which is then
+    /** The element's id — the one name it answers to, and the key interactions are wired by. Absent for a caller
      *  left unregistered rather than falling back to its opaque id. */
     id?: string;
     interactions?: Record<string, ElementInteraction>;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { default as InteractionsContextProvider } from './InteractionsContextPro
 import { default as InteractionsHelper } from './InteractionsHelper';
 import { default as InteractionsManager } from './InteractionsManager';
 import { default as InteractionsSourcesProvider } from './InteractionsSourcesProvider';
-import { AuthInteractions, NavigationInteractions, StateInteractions } from './sources';
+import { ActionInteractions, AuthInteractions, NavigationInteractions, StateInteractions } from './sources';
 import { default as utility } from './utility';
 export * from './utility';
 export * from './InteractionsContext';
@@ -14,4 +14,4 @@ export * from './InteractionsSourcesProvider';
 export * from './hooks/useInteractions';
 export * from './sources';
 export * from './InteractionsManager';
-export { InteractionsManager, utility, InteractionsContext, InteractionsContextProvider, InteractionsHelper, InteractionsSourcesProvider, useInteractions, AuthInteractions, NavigationInteractions, StateInteractions };
+export { InteractionsManager, utility, InteractionsContext, InteractionsContextProvider, InteractionsHelper, InteractionsSourcesProvider, useInteractions, ActionInteractions, AuthInteractions, NavigationInteractions, StateInteractions };

package/dist/index.mjs

@@ -4,8 +4,11 @@ import n from "./utility/index.mjs";
 import r, { flowTrigger as i } from "./InteractionsHelper.mjs";
 import a from "./InteractionsManager.mjs";
 import o from "./InteractionsContextProvider.mjs";
-import s from "./sources/AuthSource/AuthInteractions.mjs";
-import c from "./sources/NavigationSource/NavigationInteractions.mjs";
-import l from "./sources/StateSource/StateInteractions.mjs";
-import u from "./InteractionsSourcesProvider.mjs";
-export { s as AuthInteractions, e as InteractionsContext, o as InteractionsContextProvider, r as InteractionsHelper, a as InteractionsManager, u as InteractionsSourcesProvider, c as NavigationInteractions, l as StateInteractions, i as flowTrigger, t as useInteractions, n as utility };
+import s from "./sources/ActionsSource/ActionInteractions.mjs";
+import c from "./sources/AuthSource/AuthInteractions.mjs";
+import l from "./sources/HostSource/callbacks.mjs";
+import u from "./sources/HostSource/HostInteractions.mjs";
+import d from "./sources/NavigationSource/NavigationInteractions.mjs";
+import f from "./sources/StateSource/StateInteractions.mjs";
+import p from "./InteractionsSourcesProvider.mjs";
+export { s as ActionInteractions, c as AuthInteractions, u as HostInteractions, e as InteractionsContext, o as InteractionsContextProvider, r as InteractionsHelper, a as InteractionsManager, p as InteractionsSourcesProvider, d as NavigationInteractions, f as StateInteractions, i as flowTrigger, l as hostCallbacks, t as useInteractions, n as utility };

package/dist/sources/ActionsSource/ActionInteractions.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+export type ActionInteractionsProps = {
+    children?: ReactNode;
+};
+/**
+ * Running a server action from a client flow.
+ *
+ * The step names an action and hands it inputs — never a URL, a connector or a credential. Which one it can reach
+ * is the server's to decide from the space's own documents, so a page can only ever run what that space already
+ * declared.
+ */
+declare const ActionInteractions: ({ children }: ActionInteractionsProps) => ReactNode;
+export default ActionInteractions;