@antcde/vue-utils 0.2.19 → 0.2.21-rc.1

package/dist/index.js

@@ -1,10 +1,10 @@
 import { objectOmit as e, objectPick as t, useAsyncState as n, useColorMode as r, useMagicKeys as i, watchDebounced as a, whenever as o } from "@vueuse/core";
-import { computed as s, inject as c, onBeforeUnmount as l, onMounted as u, onUnmounted as d, readonly as f, ref as p, shallowRef as m, watch as h } from "vue";
-import { useI18n as g } from "vue-i18n";
-import { clone as _, newCommsClient as v, newCommsHost as y } from "@antcde/connect-ts";
-import { BehaviorSubject as b, Subject as x, concat as S, concatMap as C, debounceTime as w, distinctUntilChanged as T, filter as E, map as D } from "rxjs";
+import { computed as s, inject as c, onBeforeUnmount as l, onMounted as u, onScopeDispose as d, onUnmounted as f, readonly as p, ref as m, shallowRef as h, watch as g } from "vue";
+import { useI18n as _ } from "vue-i18n";
+import { clone as v, isAuthorizationRequired as y, newCommsClient as b, newCommsHost as x } from "@antcde/connect-ts";
+import { BehaviorSubject as S, Subject as C, concat as w, concatMap as T, debounceTime as E, distinctUntilChanged as D, filter as O, map as k } from "rxjs";
 //#region src/formatDate.ts
-var O = "nl", k = {
+var A = "nl", j = {
 	short: {
 		day: "2-digit",
 		month: "2-digit",
@@ -40,25 +40,25 @@ var O = "nl", k = {
 		minute: "2-digit",
 		hour12: !1
 	}
-}, A = new Set(["short", "shortDateTime"]);
-function j(e) {
+}, M = /* @__PURE__ */ new Set(["short", "shortDateTime"]);
+function N(e) {
 	return e instanceof Date ? e : new Date(e);
 }
-function M(e) {
+function P(e) {
 	return `${e.getFullYear()}-${String(e.getMonth() + 1).padStart(2, "0")}-${String(e.getDate()).padStart(2, "0")}`;
 }
-function N(e, t = {}) {
-	let { preset: n = "short", locale: r = O, fallback: i = "" } = t;
+function F(e, t = {}) {
+	let { preset: n = "short", locale: r = A, fallback: i = "" } = t;
 	if (e == null || e === "") return i;
-	let a = j(e);
+	let a = N(e);
 	if (Number.isNaN(a.getTime())) return i;
-	if (n === "iso") return M(a);
-	let o = A.has(n) && /^en\b/i.test(r) ? O : r;
-	return new Intl.DateTimeFormat(o, k[n]).format(a);
+	if (n === "iso") return P(a);
+	let o = M.has(n) && /^en\b/i.test(r) ? A : r;
+	return new Intl.DateTimeFormat(o, j[n]).format(a);
 }
 //#endregion
 //#region src/useAntColorMode.ts
-function P(e, n) {
+function I(e, n) {
 	let i = r(n), a = s(() => e.context.value.darkMode), o = s(() => {
 		switch (a.value) {
 			case null: return "auto";
@@ -84,28 +84,28 @@ function P(e, n) {
 }
 //#endregion
 //#region src/useAntI18n.ts
-function F(e, t) {
-	let n = g(t);
-	return h(() => e.context.value.user?.language, (e) => n.locale.value = e ?? "en", { immediate: !0 }), n;
+function L(e, t) {
+	let n = _(t);
+	return g(() => e.context.value.user?.language, (e) => n.locale.value = e ?? "en", { immediate: !0 }), n;
 }
 //#endregion
 //#region src/useAppTourMode.ts
-var I = p(!1), L = p(null);
-function R() {
+var R = m(!1), z = m(null);
+function B() {
 	function e(e) {
-		h(() => e.value.tourMode, (e) => {
-			I.value = !!e, e || (L.value = null);
+		g(() => e.value.tourMode, (e) => {
+			R.value = !!e, e || (z.value = null);
 		}, { immediate: !0 });
 	}
 	function t(e) {
-		I.value && (L.value = e);
+		R.value && (z.value = e);
 	}
 	function n() {
-		I.value = !1, L.value = null;
+		R.value = !1, z.value = null;
 	}
 	return {
-		isActive: f(I),
-		activeZoneId: f(L),
+		isActive: p(R),
+		activeZoneId: p(z),
 		connectContext: e,
 		setActiveZone: t,
 		exit: n
@@ -113,27 +113,27 @@ function R() {
 }
 //#endregion
 //#region src/useCommsClient.ts
-function z(t, n, r) {
-	let i = p({}), a = v({
+function V(t, n, r) {
+	let i = m({}), a = b({
 		parent: window.parent,
 		connect: t,
 		manifest: r
-	}), o = p(""), c = s({
+	}), o = m(""), c = s({
 		get: () => o.value,
 		set: (e) => a.appState.set(e)
 	});
-	return a.context.subscribe((e) => i.value = e), S(a.appState.get(), a.appState).subscribe((e) => o.value = e), V(a.signal, a, n), l(() => a.unsubscribe()), Object.assign(e(a, [
+	return a.context.subscribe((e) => i.value = e), w(a.appState.get(), a.appState).subscribe((e) => o.value = e), U(a.signal, a, n), l(() => a.unsubscribe()), Object.assign(e(a, [
 		"context",
 		"toolbar",
 		"appState"
 	]), {
 		context: i,
-		toolbar: B(a),
+		toolbar: H(a),
 		appState: c
 	});
 }
-function B(e) {
-	let t = p(""), n = {
+function H(e) {
+	let t = m(""), n = {
 		title: s({
 			get: () => e.toolbar.get().title,
 			set: (t) => e.toolbar.set((e) => ({
@@ -183,23 +183,23 @@ function B(e) {
 			}))
 		})
 	};
-	return e.toolbar.pipe(D((e) => e.search.input ?? ""), T(), w(300)).forEach((e) => t.value = e), n;
+	return e.toolbar.pipe(k((e) => e.search.input ?? ""), D(), E(300)).forEach((e) => t.value = e), n;
 }
-function V(e, t, n) {
-	let r = i(), a = r.ctrl ?? s(() => !1), c = r.shift ?? s(() => !1), l = new x(), u = l.pipe(C(n ?? ((e) => Promise.resolve(e))), C((t) => e(t))).subscribe();
+function U(e, t, n) {
+	let r = i(), a = r.ctrl ?? s(() => !1), c = r.shift ?? s(() => !1), l = new C(), u = l.pipe(T(n ?? ((e) => Promise.resolve(e))), T((t) => e(t))).subscribe();
 	return t.add(u), u.add(o(a, () => l.next({ hotkeys: { ctrl: !0 } }))), u.add(o(c, () => l.next({ hotkeys: { shift: !0 } }))), u;
 }
 //#endregion
 //#region src/useCommsHost.ts
-function H(e) {
-	let { context: t } = e, n = new b({}), r = (e) => n.next(e(n.value)), i = p(), o = new b(void 0), c = h(i, (e) => o.next(e), { immediate: !0 }), l = o.asObservable().pipe(D((e) => e?.contentWindow), E((e) => !!e)), u = y({
+function W(e) {
+	let { context: t } = e, n = new S({}), r = (e) => n.next(e(n.value)), i = m(), o = new S(void 0), c = g(i, (e) => o.next(e), { immediate: !0 }), l = o.asObservable().pipe(k((e) => e?.contentWindow), O((e) => !!e)), u = x({
 		...e,
 		contextChanges: n,
 		windowChanges: l
 	});
-	Object.entries(t).map(([e, t]) => h(t, (t) => r((n) => ({
+	Object.entries(t).map(([e, t]) => g(t, (t) => r((n) => ({
 		...n,
-		[e]: _(t)
+		[e]: v(t)
 	})), { immediate: !0 })).forEach((e) => u.scope.add(e)), u.toolbar.subscribe((t) => {
 		let n = e.toolbar;
 		n.title.value = t.title, n.subtitle.value = t.subtitle, n.searchEnabled.value = t.search?.enabled ?? !1, n.search.value = t.search?.input, n.menu.value = t.menu, n.isLoading.value = t?.isLoading ?? !1;
@@ -209,30 +209,30 @@ function H(e) {
 		debounce: 100
 	});
 	u.scope.add(c), u.scope.add(d);
-	let f = p(u.appState.get()), m = s({
+	let f = m(u.appState.get()), p = s({
 		get: () => f.value,
 		set: (e) => u.appState.set(e)
 	});
 	u.appState.changes.subscribe((e) => f.value = e);
-	let g = p(!1);
-	u.isConnectionInitialized.subscribe((e) => g.value = e);
-	let v = p(null);
-	u.manifest?.subscribe((e) => v.value = e);
-	let { unsubscribe: x, signal: S, closed: C } = u;
+	let h = m(!1);
+	u.isConnectionInitialized.subscribe((e) => h.value = e);
+	let _ = m(null);
+	u.manifest?.subscribe((e) => _.value = e);
+	let { unsubscribe: y, signal: b, closed: C } = u;
 	return {
 		...e,
 		client: i,
-		appState: m,
-		isConnectionInitialized: g,
-		manifest: v,
-		unsubscribe: x,
-		signal: S,
+		appState: p,
+		isConnectionInitialized: h,
+		manifest: _,
+		unsubscribe: y,
+		signal: b,
 		closed: C
 	};
 }
 //#endregion
 //#region src/usePermissions.ts
-function U(e) {
+function G(e) {
 	let t = s(() => e.value?.user), n = s(() => e.value?.license), r = s(() => e.value?.project), i = s(() => !!t.value?.is_admin), a = s(() => !!n.value?.user_is_admin), o = s(() => !!r.value?.user_is_admin || a.value);
 	function c(e) {
 		return !t.value || !n.value ? !1 : i.value || a.value ? !0 : (n.value.user_roles ?? []).some((t) => t.name === e);
@@ -258,12 +258,13 @@ function U(e) {
 }
 //#endregion
 //#region src/useTemplateVersioning.ts
-function W(e) {
-	let t = m(null), n = m(null), r = m(null), i = m(null), a = m([]), o = m(null), c = p(!1), l = p(!1), u = p(!1), d = p(!1), f = p(!1), h = p(!1), g = s(() => t.value?.has_update ?? !1), _ = s(() => t.value?.current_version ?? null), v = s(() => t.value?.latest_version ?? null), y = s(() => n.value ? n.value.added.length + n.value.removed.length + n.value.modified.length + n.value.relations_added.length + n.value.relations_removed.length : 0);
+function K(e) {
+	let t = h(null), n = h(null), r = h(null), i = h(null), a = h([]), o = h(null), c = m(!1), l = m(!1), u = m(!1), d = m(!1), f = m(!1), p = m(!1), g = s(() => t.value?.has_update ?? !1), _ = s(() => t.value?.current_version ?? null), v = s(() => t.value?.latest_version ?? null), y = s(() => n.value ? n.value.added.length + n.value.removed.length + n.value.modified.length + n.value.relations_added.length + n.value.relations_removed.length : 0);
 	async function b(n) {
 		c.value = !0;
 		try {
-			return t.value = (await e.tasks.checkForUpdates(n))?.data ?? null, t.value;
+			let r = await e.tasks.checkForUpdates(n);
+			return t.value = r?.data ?? null, t.value;
 		} catch {
 			return t.value = null, null;
 		} finally {
@@ -273,7 +274,8 @@ function W(e) {
 	async function x(t, r) {
 		l.value = !0;
 		try {
-			return n.value = (await e.tasks.versionDiff(t, r))?.data ?? null, n.value;
+			let i = await e.tasks.versionDiff(t, r);
+			return n.value = i?.data ?? null, n.value;
 		} catch {
 			return n.value = null, null;
 		} finally {
@@ -283,7 +285,8 @@ function W(e) {
 	async function S(t, r, i) {
 		l.value = !0;
 		try {
-			return n.value = (await e.tasks.versionCompare(t, r, i))?.data ?? null, n.value;
+			let a = await e.tasks.versionCompare(t, r, i);
+			return n.value = a?.data ?? null, n.value;
 		} catch {
 			return n.value = null, null;
 		} finally {
@@ -293,7 +296,8 @@ function W(e) {
 	async function C(t) {
 		u.value = !0;
 		try {
-			return r.value = (await e.tasks.versionDiffOriginal(t))?.data ?? null, r.value;
+			let n = await e.tasks.versionDiffOriginal(t);
+			return r.value = n?.data ?? null, r.value;
 		} catch {
 			return r.value = null, null;
 		} finally {
@@ -303,7 +307,8 @@ function W(e) {
 	async function w(r, a) {
 		d.value = !0;
 		try {
-			return i.value = (await e.tasks.syncToLatestVersion(r, a))?.data ?? null, t.value = null, n.value = null, i.value;
+			let o = await e.tasks.syncToLatestVersion(r, a);
+			return i.value = o?.data ?? null, t.value = null, n.value = null, i.value;
 		} catch {
 			return i.value = null, null;
 		} finally {
@@ -322,27 +327,30 @@ function W(e) {
 		}
 	}
 	async function E(t) {
-		h.value = !0;
+		p.value = !0;
 		try {
-			return a.value = (await e.tasks.listVersions(t))?.data ?? [], a.value;
+			let n = await e.tasks.listVersions(t);
+			return a.value = n?.data ?? [], a.value;
 		} catch {
 			return a.value = [], [];
 		} finally {
-			h.value = !1;
+			p.value = !1;
 		}
 	}
 	async function D(t) {
 		try {
-			return o.value = (await e.tasks.latestVersion(t))?.data ?? null, o.value;
+			let n = await e.tasks.latestVersion(t);
+			return o.value = n?.data ?? null, o.value;
 		} catch {
 			return o.value = null, null;
 		}
 	}
-	let O = m([]), k = p(!1), A = p(!1), j = m([]);
+	let O = h([]), k = m(!1), A = m(!1), j = h([]);
 	async function M(t) {
 		k.value = !0;
 		try {
-			return O.value = (await e.tasks.getInstances(t))?.data ?? [], O.value;
+			let n = await e.tasks.getInstances(t);
+			return O.value = n?.data ?? [], O.value;
 		} catch {
 			return O.value = [], [];
 		} finally {
@@ -352,7 +360,8 @@ function W(e) {
 	async function N(t, n) {
 		A.value = !0, j.value = [];
 		try {
-			return j.value = (await e.tasks.pushSync(t, n))?.data ?? [], j.value;
+			let r = await e.tasks.pushSync(t, n);
+			return j.value = r?.data ?? [], j.value;
 		} catch {
 			return j.value = [], [];
 		} finally {
@@ -376,7 +385,7 @@ function W(e) {
 		isFetchingCustomizations: u,
 		isSyncing: d,
 		isPublishing: f,
-		isFetchingVersions: h,
+		isFetchingVersions: p,
 		isFetchingInstances: k,
 		isPushSyncing: A,
 		hasUpdate: g,
@@ -397,19 +406,46 @@ function W(e) {
 	};
 }
 //#endregion
+//#region src/useTriggerDispatch.ts
+function q(e, t = {}) {
+	let n = t.authorizationTimeoutMs ?? 3e5, r = /* @__PURE__ */ new Set();
+	d(() => {
+		for (let e of r) e();
+	});
+	function i(t) {
+		return new Promise((i) => {
+			let a = !1, o, s, c, l = (e) => {
+				a || (a = !0, o?.(), s && clearTimeout(s), c && r.delete(c), i(e));
+			};
+			c = () => l(!1), r.add(c), o = e.signal.receive((e) => {
+				let n = e.oauthAuthorizeResult;
+				n && n.secretId === t.secret_id && l(n.ok);
+			}), s = setTimeout(l, n, !1), e.signal({ oauthAuthorize: {
+				authorizeUrl: t.authorize_url,
+				secretId: t.secret_id
+			} });
+		});
+	}
+	async function a(e) {
+		let t = await e();
+		return !y(t) || !await i(t) ? t : e();
+	}
+	return { dispatch: a };
+}
+//#endregion
 //#region src/utils.ts
-function G(e = "comms") {
-	let [t, n] = K(e, () => z(), (e) => e.unsubscribe());
+function J(e = "comms") {
+	let [t, n] = Y(e, () => V(), (e) => e.unsubscribe());
 	return {
 		provideComms: t,
 		injectComms: n
 	};
 }
-function K(e, t, n) {
+function Y(e, t, n) {
 	let r, i = () => (!r && (r = t()), r);
 	return [(t) => (t.onUnmount(() => n && r && n(r)), t.provide(e, i)), () => c(e)()];
 }
-function q(t, r, i) {
+function X(t, r, i) {
 	let a = n(t, r, {
 		immediate: !1,
 		...i
@@ -419,9 +455,9 @@ function q(t, r, i) {
 		executeDelayed: a.execute
 	});
 }
-function J(e) {
-	let t, n = p(void 0);
-	return u(() => t = e.signal.receive((e) => n.value = e)), d(() => t?.()), [f(n), () => t?.()];
+function Z(e) {
+	let t, n = m(void 0);
+	return u(() => t = e.signal.receive((e) => n.value = e)), f(() => t?.()), [p(n), () => t?.()];
 }
 //#endregion
-export { N as formatDate, P as useAntColorMode, F as useAntI18n, q as useApi, R as useAppTourMode, z as useCommsClient, H as useCommsHost, G as useCommsInjection, U as usePermissions, J as useSignal, K as useSingleton, W as useTemplateVersioning };
+export { F as formatDate, I as useAntColorMode, L as useAntI18n, X as useApi, B as useAppTourMode, V as useCommsClient, W as useCommsHost, J as useCommsInjection, G as usePermissions, Z as useSignal, Y as useSingleton, K as useTemplateVersioning, q as useTriggerDispatch };

package/dist/types/index.d.ts

@@ -6,4 +6,5 @@ export { type UseCommsClient, useCommsClient } from './useCommsClient';
 export { type CommsHostArgs, type UseCommsHost, useCommsHost } from './useCommsHost';
 export { type UsePermissions, usePermissions } from './usePermissions';
 export { useTemplateVersioning, type UseTemplateVersioningReturn } from './useTemplateVersioning';
+export { useTriggerDispatch, type UseTriggerDispatchOptions, type UseTriggerDispatchReturn } from './useTriggerDispatch';
 export { type AnyUseApiReturn, type CommsToolbar, useApi, type UseApiReturn, useCommsInjection, useSignal, useSingleton, } from './utils';

package/dist/types/useTriggerDispatch.d.ts

@@ -0,0 +1,28 @@
+import { TriggerDispatchResult } from '@antcde/connect-ts';
+import { UseCommsClient } from './useCommsClient';
+export interface UseTriggerDispatchOptions {
+    authorizationTimeoutMs?: number;
+}
+export interface UseTriggerDispatchReturn {
+    dispatch: (run: () => Promise<TriggerDispatchResult>) => Promise<TriggerDispatchResult>;
+}
+/**
+ * Wrap a trigger dispatch so a per-user OAuth2 "authorization required" outcome is
+ * handled transparently for iframe apps: on that outcome the helper asks the HOST
+ * (via the `oauthAuthorize` signal) to open the provider consent popup, awaits the
+ * host's `oauthAuthorizeResult`, and — when the user authorized — re-runs the
+ * dispatch exactly once. Any other outcome is returned unchanged.
+ *
+ * `run` is the caller's own dispatch invocation (e.g. a `useApi(...).execute`
+ * wrapper that resolves to the response body), so this composable stays decoupled
+ * from how the request is made and re-runs the identical call after consent.
+ *
+ * @example
+ * const { dispatch } = useTriggerDispatch(comms)
+ * const call = useApi(connect.triggers.dispatch, null)
+ * const result = await dispatch(async () => {
+ *   await call.execute(triggerableType, triggerableId, triggerId)
+ *   return call.state.value
+ * })
+ */
+export declare function useTriggerDispatch(comms: UseCommsClient, options?: UseTriggerDispatchOptions): UseTriggerDispatchReturn;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@antcde/vue-utils",
   "type": "module",
-  "version": "0.2.19",
+  "version": "0.2.21-rc.1",
   "description": "Helper to use ANT Comms in Vue 3",
   "author": "CollaborAll",
   "exports": {
@@ -31,16 +31,16 @@
     "vue-i18n": "^11.1.12"
   },
   "dependencies": {
-    "@antcde/connect-ts": "0.4.24"
+    "@antcde/connect-ts": "0.4.26-rc.1"
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.5",
-    "@types/node": "^22.19.21",
-    "@vitejs/plugin-vue": "^6.0.7",
+    "@types/node": "^22.20.1",
+    "@vitejs/plugin-vue": "^6.0.8",
     "@vue/tsconfig": "^0.9.1",
     "typescript": "~6.0.3",
-    "vite": "^8.0.16",
+    "vite": "^8.1.5",
     "vite-plugin-dts": "^4.5.4",
-    "vue-tsc": "^3.3.5"
+    "vue-tsc": "^3.3.7"
   }
 }