@antcde/vue-utils 0.2.32-rc.1 → 0.2.32

package/dist/index.js

@@ -1971,23 +1971,43 @@ function En(e, t) {
 	return g(() => e.context.value.user?.language, (e) => n.locale.value = e ?? "en", { immediate: !0 }), n;
 }
 //#endregion
+//#region src/useAppQueryParam.ts
+function Dn(e) {
+	let t = Array.isArray(e) ? e[0] : e;
+	return typeof t == "string" && t !== "" ? t : null;
+}
+function On(e, t, n = {}) {
+	let r = m(void 0), i = e.signal.receive((e) => {
+		e.route?.query && (r.value = Dn(e.route.query[t]));
+	});
+	return d(i), s({
+		get: () => r.value === void 0 ? Dn(e.context.value?.initialRouteQuery?.[t]) : r.value,
+		set: (i) => {
+			r.value = i, e.signal({ route: {
+				query: { [t]: i },
+				push: n.history === "push"
+			} });
+		}
+	});
+}
+//#endregion
 //#region src/useAppTourMode.ts
-var Dn = m(!1), On = m(null);
-function kn() {
+var kn = m(!1), An = m(null);
+function jn() {
 	function e(e) {
 		g(() => e.value.tourMode, (e) => {
-			Dn.value = !!e, e || (On.value = null);
+			kn.value = !!e, e || (An.value = null);
 		}, { immediate: !0 });
 	}
 	function t(e) {
-		Dn.value && (On.value = e);
+		kn.value && (An.value = e);
 	}
 	function n() {
-		Dn.value = !1, On.value = null;
+		kn.value = !1, An.value = null;
 	}
 	return {
-		isActive: p(Dn),
-		activeZoneId: p(On),
+		isActive: p(kn),
+		activeZoneId: p(An),
 		connectContext: e,
 		setActiveZone: t,
 		exit: n
@@ -1995,7 +2015,7 @@ function kn() {
 }
 //#endregion
 //#region src/useCommsClient.ts
-function An(t, n, r) {
+function Mn(t, n, r) {
 	let i = m({}), a = b({
 		parent: window.parent,
 		connect: t,
@@ -2004,17 +2024,17 @@ function An(t, n, r) {
 		get: () => o.value,
 		set: (e) => a.appState.set(e)
 	});
-	return a.context.subscribe((e) => i.value = e), ne(a.appState.get(), a.appState).subscribe((e) => o.value = e), Mn(a.signal, a, n), l(() => a.unsubscribe()), Object.assign(e(a, [
+	return a.context.subscribe((e) => i.value = e), ne(a.appState.get(), a.appState).subscribe((e) => o.value = e), Pn(a.signal, a, n), l(() => a.unsubscribe()), Object.assign(e(a, [
 		"context",
 		"toolbar",
 		"appState"
 	]), {
 		context: i,
-		toolbar: jn(a),
+		toolbar: Nn(a),
 		appState: c
 	});
 }
-function jn(e) {
+function Nn(e) {
 	let t = m(""), n = {
 		title: s({
 			get: () => e.toolbar.get().title,
@@ -2067,13 +2087,13 @@ function jn(e) {
 	};
 	return e.toolbar.pipe(C((e) => e.search.input ?? ""), ae(), ie(300)).forEach((e) => t.value = e), n;
 }
-function Mn(e, t, n) {
+function Pn(e, t, n) {
 	let r = i(), a = r.ctrl ?? s(() => !1), c = r.shift ?? s(() => !1), l = new te(), u = l.pipe(re(n ?? ((e) => Promise.resolve(e))), re((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 Nn(e) {
+function Fn(e) {
 	let { context: t } = e, n = new x({}), r = (e) => n.next(e(n.value)), i = m(), o = new x(void 0), c = g(i, (e) => o.next(e), { immediate: !0 }), l = o.asObservable().pipe(C((e) => e?.contentWindow), S((e) => !!e)), u = ee({
 		...e,
 		contextChanges: n,
@@ -2114,12 +2134,12 @@ function Nn(e) {
 }
 //#endregion
 //#region src/useFeature.ts
-function Pn(e, t) {
+function In(e, t) {
 	return s(() => e.value?.features?.[t] === !0);
 }
 //#endregion
 //#region src/usePermissions.ts
-function Fn(e) {
+function Ln(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);
@@ -2145,7 +2165,7 @@ function Fn(e) {
 }
 //#endregion
 //#region src/useTemplateVersioning.ts
-function In(e) {
+function Rn(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;
@@ -2294,7 +2314,7 @@ function In(e) {
 }
 //#endregion
 //#region src/useTriggerDispatch.ts
-function Ln(e, t = {}) {
+function zn(e, t = {}) {
 	let n = t.authorizationTimeoutMs ?? 3e5, r = /* @__PURE__ */ new Set();
 	d(() => {
 		for (let e of r) e();
@@ -2321,18 +2341,18 @@ function Ln(e, t = {}) {
 }
 //#endregion
 //#region src/utils.ts
-function Rn(e = "comms") {
-	let [t, n] = zn(e, () => An(), (e) => e.unsubscribe());
+function Bn(e = "comms") {
+	let [t, n] = Vn(e, () => Mn(), (e) => e.unsubscribe());
 	return {
 		provideComms: t,
 		injectComms: n
 	};
 }
-function zn(e, t, n) {
+function Vn(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 Bn(t, r, i) {
+function Hn(t, r, i) {
 	let a = n(t, r, {
 		immediate: !1,
 		...i
@@ -2342,9 +2362,9 @@ function Bn(t, r, i) {
 		executeDelayed: a.execute
 	});
 }
-function Vn(e) {
+function Un(e) {
 	let t, n = m(void 0);
 	return u(() => t = e.signal.receive((e) => n.value = e)), f(() => t?.()), [p(n), () => t?.()];
 }
 //#endregion
-export { pe as SCHEDULE_DAYS, bn as TASK_PRIORITIES, _e as browserZone, be as buildScheduleRule, ve as defaultScheduleSpec, we as describeRefresh, le as formatDate, ue as formatDateRange, fe as formatRefreshLabel, yn as nextOccurrences, Ce as parseScheduleRule, wn as taskPriorityColor, Cn as taskPriorityIcon, Tn as useAntColorMode, En as useAntI18n, Bn as useApi, kn as useAppTourMode, An as useCommsClient, Nn as useCommsHost, Rn as useCommsInjection, Pn as useFeature, Fn as usePermissions, Vn as useSignal, zn as useSingleton, In as useTemplateVersioning, Ln as useTriggerDispatch, ye as weekdayOf };
+export { pe as SCHEDULE_DAYS, bn as TASK_PRIORITIES, _e as browserZone, be as buildScheduleRule, ve as defaultScheduleSpec, we as describeRefresh, le as formatDate, ue as formatDateRange, fe as formatRefreshLabel, yn as nextOccurrences, Ce as parseScheduleRule, wn as taskPriorityColor, Cn as taskPriorityIcon, Tn as useAntColorMode, En as useAntI18n, Hn as useApi, On as useAppQueryParam, jn as useAppTourMode, Mn as useCommsClient, Fn as useCommsHost, Bn as useCommsInjection, In as useFeature, Ln as usePermissions, Un as useSignal, Vn as useSingleton, Rn as useTemplateVersioning, zn as useTriggerDispatch, ye as weekdayOf };

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export { nextOccurrences, type ScheduleOccurrence } from './refreshScheduleOccur
 export { TASK_PRIORITIES, taskPriorityColor, taskPriorityIcon } from './taskPriority';
 export { useAntColorMode, type UseAntColorModeOptions, type UseAntColorModeReturn } from './useAntColorMode';
 export { useAntI18n, type UseAntI18nReturn } from './useAntI18n';
+export { useAppQueryParam, type UseAppQueryParamOptions } from './useAppQueryParam';
 export { useAppTourMode } from './useAppTourMode';
 export { type UseCommsClient, useCommsClient } from './useCommsClient';
 export { type CommsHostArgs, type UseCommsHost, useCommsHost } from './useCommsHost';

package/dist/types/useAppQueryParam.d.ts

@@ -0,0 +1,8 @@
+import { WritableComputedRef } from 'vue';
+import { UseCommsClient } from './useCommsClient';
+export interface UseAppQueryParamOptions {
+    /** `push` adds a browser history entry per change, so Back returns to the previous value. */
+    history?: 'push' | 'replace';
+}
+/** An OS URL query param this app owns, synced both ways: deep links, back/forward and task state replay. */
+export declare function useAppQueryParam(comms: UseCommsClient, key: string, options?: UseAppQueryParamOptions): WritableComputedRef<string | null>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@antcde/vue-utils",
   "type": "module",
-  "version": "0.2.32-rc.1",
+  "version": "0.2.32",
   "description": "Helper to use ANT Comms in Vue 3",
   "author": "CollaborAll",
   "exports": {
@@ -33,7 +33,7 @@
     "vue-i18n": "^11.1.12"
   },
   "dependencies": {
-    "@antcde/connect-ts": "0.4.37-rc.1",
+    "@antcde/connect-ts": "0.4.37",
     "rrule": "^2.8.1"
   },
   "devDependencies": {