@anzusystems/common-admin 1.47.0-beta.dev-1790143991 → 2.0.0-rc.1

package/dist/domains/unsavedGuard/composables/useUnsavedChangesGuard.d.ts

@@ -0,0 +1,82 @@
+import { ComputedRef, Ref } from 'vue';
+import { UnsavedSectionSource } from './useUnsavedSection';
+type UnsavedSource = Ref<boolean | Set<unknown> | unknown[] | null | undefined>;
+export interface UseUnsavedChangesGuardOptions {
+    /**
+     * Reactive sources that signal "unsaved" state. Each source's truthiness is
+     * checked: a Set/array is "dirty" when non-empty, a boolean when true, null
+     * or undefined as not dirty.
+     */
+    sources: UnsavedSource[];
+    /**
+     * Block route navigation via vue-router's onBeforeRouteLeave, and onBeforeRouteUpdate when the path changes. Default true.
+     * Only a literal `false` skips registering the guard; a Ref is read when the navigation happens, so
+     * it can turn blocking on and off later.
+     */
+    guardRoute?: boolean | Ref<boolean>;
+    /**
+     * Block window/tab unload via beforeunload. Default true. Like `guardRoute`: only a literal `false`
+     * skips the listener, a Ref is read when the unload happens.
+     */
+    guardWindowUnload?: boolean | Ref<boolean>;
+    /**
+     * Optional Vuetify dialog v-model. When provided, attempts to close the
+     * dialog while dirty are intercepted: dialog stays open until the user
+     * confirms via the confirm dialog or via `acknowledge()`.
+     */
+    guardDialogModel?: Ref<boolean>;
+    /**
+     * Named sections owned by the guard host component itself. Descendants use
+     * `useUnsavedSection` instead — but a component can't `inject` its own
+     * `provide`, so when the host *is* the section owner (e.g. a dialog), pass
+     * the sections here.
+     */
+    ownSections?: UnsavedSectionSource;
+}
+export interface UseUnsavedChangesGuardApi {
+    hasUnsavedChanges: ComputedRef<boolean>;
+    /**
+     * Labels of the dirty sections registered by descendants via
+     * `useUnsavedSection`. Bind to `AUnsavedConfirmDialog`'s `dirtyLabels` prop
+     * so the dialog names *which* parts are unsaved. Empty when no descendant
+     * registered a section (dialog falls back to the generic message).
+     */
+    dirtyLabels: ComputedRef<string[]>;
+    /**
+     * v-model-bound to the confirm dialog. When the guard wants to ask the user
+     * to confirm leaving, it sets this to true. The confirm dialog reads it.
+     */
+    promptOpen: Ref<boolean>;
+    /**
+     * Resolves the confirm prompt with `discard=true` (proceed) or `false`
+     * (stay). Called by the confirm dialog.
+     */
+    resolvePrompt: (discard: boolean) => void;
+    /**
+     * Manually mark the most recent intent as acknowledged so the next
+     * route/dialog/unload attempt proceeds without prompting. Useful right
+     * before a programmatic navigation that the consumer has already
+     * confirmed.
+     *
+     * The acknowledgement AUTO-EXPIRES after a few seconds if nothing consumes it
+     * (see `ACKNOWLEDGE_TTL_MS`): a delete that acknowledges up-front but then FAILS
+     * (throws, never navigates) must not leave the guard silently disarmed for the
+     * next unrelated navigation. Consuming it (a real leave) clears the timer.
+     */
+    acknowledge: () => void;
+    /**
+     * Releases what the guard registered imperatively — `beforeunload` listener, acknowledge timer,
+     * dialog watcher — and settles an open prompt as "stay". Idempotent, and called automatically on
+     * unmount; outside a component it is the only way to clean up. The route-leave guard is
+     * lifecycle-bound and unaffected.
+     */
+    stop: () => void;
+    /**
+     * Cancel a pending `acknowledge()` (disarm). Call from a delete's failure path
+     * so a failed/aborted delete restores the guard immediately instead of waiting
+     * for the TTL. No-op if nothing is acknowledged.
+     */
+    unacknowledge: () => void;
+}
+export declare function useUnsavedChangesGuard(options: UseUnsavedChangesGuardOptions): UseUnsavedChangesGuardApi;
+export {};

package/dist/domains/unsavedGuard/composables/useUnsavedChangesGuard.js

@@ -0,0 +1,69 @@
+import { provideUnsavedSectionRegistry as e } from "./useUnsavedSection.js";
+import { computed as t, getCurrentInstance as n, onBeforeUnmount as r, ref as i, watch as a } from "vue";
+import { onBeforeRouteLeave as o, onBeforeRouteUpdate as s } from "vue-router";
+//#region src/domains/unsavedGuard/composables/useUnsavedChangesGuard.ts
+var c = 8e3, l = (e) => e == null ? !1 : typeof e == "boolean" ? e : e instanceof Set ? e.size > 0 : Array.isArray(e) ? e.length > 0 : !!e, u = (e, t) => e === void 0 ? t : typeof e == "boolean" ? e : e.value;
+function d(d) {
+	let f = e();
+	if (d.ownSections) {
+		let e = d.ownSections, n = Symbol("unsaved.section.own"), r = t(() => {
+			let t = e();
+			return Array.isArray(t) ? t : [t];
+		});
+		f.register(n, r);
+	}
+	let p = t(() => d.sources.some((e) => l(e.value)) || f.dirtyLabels.value.length > 0), m = i(!1), h = [], g = !1, _ = null, v = () => {
+		_ !== null && (clearTimeout(_), _ = null);
+	}, y = () => g ? (g = !1, v(), Promise.resolve(!0)) : new Promise((e) => {
+		h.push(e), m.value = !0;
+	}), b = (e) => {
+		m.value = !1;
+		let t = h;
+		h = [], t.forEach((t) => t(e));
+	}, x = () => {
+		g = !0, v(), _ = setTimeout(() => {
+			g = !1, _ = null;
+		}, c);
+	}, S = () => {
+		g = !1, v();
+	};
+	if (d.guardRoute !== !1 && n()) try {
+		let e = async () => !u(d.guardRoute, !0) || !p.value || await y();
+		o(e), s((t, n) => t.path === n.path || e());
+	} catch {}
+	let C = [v], w = !1;
+	if (d.guardWindowUnload !== !1) {
+		let e = (e) => {
+			u(d.guardWindowUnload, !0) && p.value && (e.preventDefault(), e.returnValue = "");
+		};
+		typeof window < "u" && (window.addEventListener("beforeunload", e), C.push(() => window.removeEventListener("beforeunload", e)));
+	}
+	if (d.guardDialogModel) {
+		let e = d.guardDialogModel, t = !1, n = a(e, async (n, r) => {
+			if (t) t = !1;
+			else if (r === !0 && n === !1 && p.value) {
+				t = !0, e.value = !0;
+				let n = await y();
+				if (w) return;
+				n && (t = !0, e.value = !1);
+			}
+		});
+		C.push(n);
+	}
+	let T = () => {
+		w || (w = !0, b(!1), C.forEach((e) => e()));
+	};
+	return n() && r(T), {
+		hasUnsavedChanges: p,
+		dirtyLabels: f.dirtyLabels,
+		promptOpen: m,
+		resolvePrompt: b,
+		acknowledge: x,
+		unacknowledge: S,
+		stop: T
+	};
+}
+//#endregion
+export { d as useUnsavedChangesGuard };
+
+//# sourceMappingURL=useUnsavedChangesGuard.js.map

package/dist/domains/unsavedGuard/composables/useUnsavedChangesGuard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUnsavedChangesGuard.js","names":["ACKNOWLEDGE_TTL_MS","isTruthySource","value","resolveBool","v","fallback","useUnsavedChangesGuard","sectionRegistry","provideUnsavedSectionRegistry","options","ownSections","id","normalized","computed","resolved","hasUnsavedChanges","s","promptOpen","ref","pendingResolvers","acknowledgedOnce","acknowledgeTimer","clearAcknowledgeTimer","askToLeave","resolve","resolvePrompt","resolvers","discard","acknowledge","unacknowledge","getCurrentInstance","guardLeave","onBeforeRouteLeave","onBeforeRouteUpdate","to","from","disposers","stopped","onBeforeUnload","dialogModel","suppressNext","stopDialogWatch","watch","prev","now","stop","dispose","onBeforeUnmount"],"sources":["../../../../src/domains/unsavedGuard/composables/useUnsavedChangesGuard.ts"],"sourcesContent":["import { computed, getCurrentInstance, onBeforeUnmount, ref, watch, type ComputedRef, type Ref } from 'vue'\nimport { onBeforeRouteLeave, onBeforeRouteUpdate } from 'vue-router'\nimport {\n  provideUnsavedSectionRegistry,\n  type UnsavedSectionDescriptor,\n  type UnsavedSectionSource,\n} from '@/domains/unsavedGuard/composables/useUnsavedSection'\n\ntype UnsavedSource = Ref<boolean | Set<unknown> | unknown[] | null | undefined>\n\nexport interface UseUnsavedChangesGuardOptions {\n  /**\n   * Reactive sources that signal \"unsaved\" state. Each source's truthiness is\n   * checked: a Set/array is \"dirty\" when non-empty, a boolean when true, null\n   * or undefined as not dirty.\n   */\n  sources: UnsavedSource[]\n  /**\n   * Block route navigation via vue-router's onBeforeRouteLeave, and onBeforeRouteUpdate when the path changes. Default true.\n   * Only a literal `false` skips registering the guard; a Ref is read when the navigation happens, so\n   * it can turn blocking on and off later.\n   */\n  guardRoute?: boolean | Ref<boolean>\n  /**\n   * Block window/tab unload via beforeunload. Default true. Like `guardRoute`: only a literal `false`\n   * skips the listener, a Ref is read when the unload happens.\n   */\n  guardWindowUnload?: boolean | Ref<boolean>\n  /**\n   * Optional Vuetify dialog v-model. When provided, attempts to close the\n   * dialog while dirty are intercepted: dialog stays open until the user\n   * confirms via the confirm dialog or via `acknowledge()`.\n   */\n  guardDialogModel?: Ref<boolean>\n  /**\n   * Named sections owned by the guard host component itself. Descendants use\n   * `useUnsavedSection` instead — but a component can't `inject` its own\n   * `provide`, so when the host *is* the section owner (e.g. a dialog), pass\n   * the sections here.\n   */\n  ownSections?: UnsavedSectionSource\n}\n\nexport interface UseUnsavedChangesGuardApi {\n  hasUnsavedChanges: ComputedRef<boolean>\n  /**\n   * Labels of the dirty sections registered by descendants via\n   * `useUnsavedSection`. Bind to `AUnsavedConfirmDialog`'s `dirtyLabels` prop\n   * so the dialog names *which* parts are unsaved. Empty when no descendant\n   * registered a section (dialog falls back to the generic message).\n   */\n  dirtyLabels: ComputedRef<string[]>\n  /**\n   * v-model-bound to the confirm dialog. When the guard wants to ask the user\n   * to confirm leaving, it sets this to true. The confirm dialog reads it.\n   */\n  promptOpen: Ref<boolean>\n  /**\n   * Resolves the confirm prompt with `discard=true` (proceed) or `false`\n   * (stay). Called by the confirm dialog.\n   */\n  resolvePrompt: (discard: boolean) => void\n  /**\n   * Manually mark the most recent intent as acknowledged so the next\n   * route/dialog/unload attempt proceeds without prompting. Useful right\n   * before a programmatic navigation that the consumer has already\n   * confirmed.\n   *\n   * The acknowledgement AUTO-EXPIRES after a few seconds if nothing consumes it\n   * (see `ACKNOWLEDGE_TTL_MS`): a delete that acknowledges up-front but then FAILS\n   * (throws, never navigates) must not leave the guard silently disarmed for the\n   * next unrelated navigation. Consuming it (a real leave) clears the timer.\n   */\n  acknowledge: () => void\n  /**\n   * Releases what the guard registered imperatively — `beforeunload` listener, acknowledge timer,\n   * dialog watcher — and settles an open prompt as \"stay\". Idempotent, and called automatically on\n   * unmount; outside a component it is the only way to clean up. The route-leave guard is\n   * lifecycle-bound and unaffected.\n   */\n  stop: () => void\n  /**\n   * Cancel a pending `acknowledge()` (disarm). Call from a delete's failure path\n   * so a failed/aborted delete restores the guard immediately instead of waiting\n   * for the TTL. No-op if nothing is acknowledged.\n   */\n  unacknowledge: () => void\n}\n\n// An acknowledgement is meant for an IMMINENT navigation (a delete's router.push after its HTTP\n// round-trip — tens to hundreds of ms). If none arrives within this window the delete almost\n// certainly failed, so the one-shot expires rather than arming an unrelated later navigation.\n// Generously longer than any real delete request so a legitimate slow-success never false-prompts.\nconst ACKNOWLEDGE_TTL_MS = 8000\n\nconst isTruthySource = (value: unknown): boolean => {\n  if (value === null || value === undefined) return false\n  if (typeof value === 'boolean') return value\n  if (value instanceof Set) return value.size > 0\n  if (Array.isArray(value)) return value.length > 0\n  return Boolean(value)\n}\n\nconst resolveBool = (v: boolean | Ref<boolean> | undefined, fallback: boolean): boolean => {\n  if (v === undefined) return fallback\n  if (typeof v === 'boolean') return v\n  return v.value\n}\n\nexport function useUnsavedChangesGuard(options: UseUnsavedChangesGuardOptions): UseUnsavedChangesGuardApi {\n  // Provide a section registry so descendants can name their dirty sections\n  // via `useUnsavedSection`. The dialog reads `dirtyLabels` from this.\n  const sectionRegistry = provideUnsavedSectionRegistry()\n\n  // The host component can't inject its own provide, so register its own\n  // sections directly.\n  if (options.ownSections) {\n    const ownSections = options.ownSections\n    const id = Symbol('unsaved.section.own')\n    const normalized = computed<UnsavedSectionDescriptor[]>(() => {\n      const resolved = ownSections()\n      return Array.isArray(resolved) ? resolved : [resolved]\n    })\n    sectionRegistry.register(id, normalized)\n  }\n\n  const hasUnsavedChanges = computed<boolean>(\n    () => options.sources.some((s) => isTruthySource(s.value)) || sectionRegistry.dirtyLabels.value.length > 0\n  )\n\n  const promptOpen = ref<boolean>(false)\n  // Every navigation waiting on the open prompt: one started meanwhile (the browser's Back) asks too, and the answer is\n  // theirs alike.\n  let pendingResolvers: ((discard: boolean) => void)[] = []\n  let acknowledgedOnce = false\n  let acknowledgeTimer: ReturnType<typeof setTimeout> | null = null\n\n  const clearAcknowledgeTimer = () => {\n    if (acknowledgeTimer !== null) {\n      clearTimeout(acknowledgeTimer)\n      acknowledgeTimer = null\n    }\n  }\n\n  const askToLeave = (): Promise<boolean> => {\n    if (acknowledgedOnce) {\n      acknowledgedOnce = false\n      clearAcknowledgeTimer()\n      return Promise.resolve(true)\n    }\n    return new Promise((resolve) => {\n      pendingResolvers.push(resolve)\n      promptOpen.value = true\n    })\n  }\n\n  const resolvePrompt = (discard: boolean) => {\n    promptOpen.value = false\n    const resolvers = pendingResolvers\n    pendingResolvers = []\n    resolvers.forEach((resolve) => resolve(discard))\n  }\n\n  const acknowledge = () => {\n    acknowledgedOnce = true\n    // Auto-expire: if the imminent navigation never arrives (e.g. the delete threw), don't leave\n    // the guard armed for an unrelated later leave. A real consume (askToLeave) clears this first.\n    clearAcknowledgeTimer()\n    acknowledgeTimer = setTimeout(() => {\n      acknowledgedOnce = false\n      acknowledgeTimer = null\n    }, ACKNOWLEDGE_TTL_MS)\n  }\n\n  const unacknowledge = () => {\n    acknowledgedOnce = false\n    clearAcknowledgeTimer()\n  }\n\n  // Route guards — `onBeforeRouteLeave` and `onBeforeRouteUpdate` only work inside a route component\n  // (it reads the current vm context). Outside a component it's a no-op.\n  // A Ref option is read at event time (register whenever it is not a literal `false`).\n  if (options.guardRoute !== false && getCurrentInstance()) {\n    try {\n      const guardLeave = async () => {\n        if (!resolveBool(options.guardRoute, true) || !hasUnsavedChanges.value) return true\n        const discard = await askToLeave()\n        return discard\n      }\n      onBeforeRouteLeave(guardLeave)\n      // The same route with other params (another article's edit page) drops this page's changes as surely: an admin\n      // keys its view by path and remounts it, a child route switching under a guarded parent included, and only a\n      // leave was asked about. Any path, not only the guarded route's own params: where the view is not keyed so, the\n      // question is one too many, never a loss of changes without one. Query and hash alone keep the page.\n      onBeforeRouteUpdate((to, from) => (to.path === from.path ? true : guardLeave()))\n    } catch {\n      // Not in a route context — skip silently.\n    }\n  }\n\n  // beforeunload — modern browsers strip custom messages but still display a\n  // generic confirm. Setting `returnValue` is the canonical way to opt in.\n  // Collected, not tied to onBeforeUnmount: outside a component that hook is a silent no-op.\n  const disposers: Array<() => void> = [clearAcknowledgeTimer]\n  let stopped = false\n\n  if (options.guardWindowUnload !== false) {\n    const onBeforeUnload = (e: BeforeUnloadEvent) => {\n      if (!resolveBool(options.guardWindowUnload, true) || !hasUnsavedChanges.value) return\n      e.preventDefault()\n      e.returnValue = ''\n    }\n    if (typeof window !== 'undefined') {\n      window.addEventListener('beforeunload', onBeforeUnload)\n      disposers.push(() => window.removeEventListener('beforeunload', onBeforeUnload))\n    }\n  }\n\n  // Dialog guard — when the parent dialog tries to close while dirty, intercept\n  // and ask the user to confirm. The parent dialog model goes from false→true\n  // (open) to true→false (closing); we re-open it while we await the prompt.\n  if (options.guardDialogModel) {\n    const dialogModel = options.guardDialogModel\n    let suppressNext = false\n    const stopDialogWatch = watch(dialogModel, async (now, prev) => {\n      if (suppressNext) {\n        suppressNext = false\n        return\n      }\n      if (prev === true && now === false && hasUnsavedChanges.value) {\n        // Re-open the dialog while we wait for the user's choice.\n        suppressNext = true\n        dialogModel.value = true\n        const discard = await askToLeave()\n        // A teardown mid-prompt must not fall through and mutate the caller's dialog model.\n        if (stopped) return\n        if (discard) {\n          suppressNext = true\n          dialogModel.value = false\n        }\n      }\n    })\n    disposers.push(stopDialogWatch)\n  }\n\n  const stop = () => {\n    if (stopped) return\n    stopped = true\n    // An open prompt would leave whoever awaits askToLeave() pending forever; \"stay\" is safe.\n    resolvePrompt(false)\n    disposers.forEach((dispose) => dispose())\n  }\n\n  if (getCurrentInstance()) {\n    onBeforeUnmount(stop)\n  }\n\n  return {\n    hasUnsavedChanges,\n    dirtyLabels: sectionRegistry.dirtyLabels,\n    promptOpen,\n    resolvePrompt,\n    acknowledge,\n    unacknowledge,\n    stop,\n  }\n}\n"],"mappings":";;;;AA6FA,IAAMA,IAAqB,KAErBC,KAAkB,MAClBC,KAAU,OAAoC,KAC9C,OAAOA,KAAU,YAAkBA,IACnCA,aAAiB,MAAYA,EAAM,OAAO,IAC1C,MAAM,QAAQA,CAAK,IAAUA,EAAM,SAAS,IACzC,EAAQA,GAGXC,KAAe,GAAuC,MACtDC,MAAM,KAAA,IAAkBC,IACxB,OAAOD,KAAM,YAAkBA,IAC5BA,EAAE;AAGX,SAAgBE,EAAuB,GAAmE;CAGxG,IAAMC,IAAkBC,EAA8B;CAItD,IAAIC,EAAQ,aAAa;EACvB,IAAMC,IAAcD,EAAQ,aACtBE,IAAK,OAAO,qBAAqB,GACjCC,IAAaC,QAA2C;GAC5D,IAAMC,IAAWJ,EAAY;GAC7B,OAAO,MAAM,QAAQI,CAAQ,IAAIA,IAAW,CAACA,CAAQ;EACvD,CAAC;EACD,EAAgB,SAASH,GAAIC,CAAU;CACzC;CAEA,IAAMG,IAAoBF,QAClBJ,EAAQ,QAAQ,MAAM,MAAMR,EAAee,EAAE,KAAK,CAAC,KAAKT,EAAgB,YAAY,MAAM,SAAS,CAC3G,GAEMU,IAAaC,EAAa,EAAK,GAGjCC,IAAmD,CAAC,GACpDC,IAAmB,IACnBC,IAAyD,MAEvDC,UAA8B;EAClC,AAAID,MAAqB,SACvB,aAAaA,CAAgB,GAC7B,IAAmB;CAEvB,GAEME,UACAH,KACF,IAAmB,IACnBE,EAAsB,GACf,QAAQ,QAAQ,EAAI,KAEtB,IAAI,SAAS,MAAY;EAE9B,AADAH,EAAiB,KAAKK,CAAO,GAC7B,EAAW,QAAQ;CACrB,CAAC,GAGGC,KAAiB,MAAqB;EAC1C,EAAW,QAAQ;EACnB,IAAMC,IAAYP;EAElB,AADA,IAAmB,CAAC,GACpBO,EAAU,SAAS,MAAYF,EAAQG,CAAO,CAAC;CACjD,GAEMC,UAAoB;EAKxB,AAJA,IAAmB,IAGnBN,EAAsB,GACtB,IAAmB,iBAAiB;GAElC,AADA,IAAmB,IACnB,IAAmB;EACrB,GAAGtB,CAAkB;CACvB,GAEM6B,UAAsB;EAE1B,AADA,IAAmB,IACnBP,EAAsB;CACxB;CAKA,IAAIb,EAAQ,eAAe,MAASqB,EAAmB,GACrD,IAAI;EACF,IAAMC,IAAa,YACb,CAAC5B,EAAYM,EAAQ,YAAY,EAAI,KAAK,CAACM,EAAkB,SAE1D,MADeQ,EAAW;EAQnC,AALAS,EAAmBD,CAAU,GAK7BE,GAAqB,GAAI,MAAUC,EAAG,SAASC,EAAK,QAAcJ,EAAW,CAAE;CACjF,QAAQ,CAER;CAMF,IAAMK,IAA+B,CAACd,CAAqB,GACvDe,IAAU;CAEd,IAAI5B,EAAQ,sBAAsB,IAAO;EACvC,IAAM6B,KAAkB,MAAyB;GAC/C,AAAKnC,EAAYM,EAAQ,mBAAmB,EAAI,KAAMM,EAAkB,UACxE,EAAE,eAAe,GACjB,EAAE,cAAc;EAClB;EACA,AAAI,OAAO,SAAW,QACpB,OAAO,iBAAiB,gBAAgBuB,CAAc,GACtDF,EAAU,WAAW,OAAO,oBAAoB,gBAAgBE,CAAc,CAAC;CAEnF;CAKA,IAAI7B,EAAQ,kBAAkB;EAC5B,IAAM8B,IAAc9B,EAAQ,kBACxB+B,IAAe,IACbC,IAAkBC,EAAMH,GAAa,OAAO,GAAK,MAAS;GAC9D,IAAIC,GACF,IAAe;QAGjB,IAAIG,MAAS,MAAQC,MAAQ,MAAS7B,EAAkB,OAAO;IAG7D,AADA,IAAe,IACf,EAAY,QAAQ;IACpB,IAAMY,IAAU,MAAMJ,EAAW;IAEjC,IAAIc,GAAS;IACb,AAAIV,MACF,IAAe,IACf,EAAY,QAAQ;GAExB;EACF,CAAC;EACD,EAAU,KAAKc,CAAe;CAChC;CAEA,IAAMI,UAAa;EACjB,AAAIR,MACJ,IAAU,IAEVZ,EAAc,EAAK,GACnBW,EAAU,SAAS,MAAYU,EAAQ,CAAC;CAC1C;CAMA,OAJIhB,EAAmB,KACrBiB,EAAgBF,CAAI,GAGf;EACL;EACA,aAAatC,EAAgB;EAC7B;EACA;EACA;EACA;EACA;CACF;AACF"}

package/dist/domains/unsavedGuard/composables/useUnsavedSection.d.ts

@@ -0,0 +1,36 @@
+import { ComputedRef, InjectionKey } from 'vue';
+/**
+ * One named, savable section the unsaved-changes confirm dialog can name back
+ * to the user. `dirty` is evaluated reactively inside the section's getter.
+ */
+export interface UnsavedSectionDescriptor {
+    label: string;
+    dirty: boolean;
+}
+/**
+ * Getter returning a single descriptor, or an array of them for a component
+ * that owns several sub-sections (e.g. page positions in one PageContentsManage).
+ */
+export type UnsavedSectionSource = () => UnsavedSectionDescriptor | UnsavedSectionDescriptor[];
+export interface UnsavedSectionRegistry {
+    register: (id: symbol, source: ComputedRef<UnsavedSectionDescriptor[]>) => void;
+    unregister: (id: symbol) => void;
+    /** Labels of every registered section currently flagged dirty. */
+    dirtyLabels: ComputedRef<string[]>;
+}
+export declare const UnsavedSectionKey: InjectionKey<UnsavedSectionRegistry>;
+export declare function createUnsavedSectionRegistry(): UnsavedSectionRegistry;
+/**
+ * Creates a registry and `provide`s it for descendants. Called internally by
+ * `useUnsavedChangesGuard` so the guard host automatically supplies one.
+ */
+export declare function provideUnsavedSectionRegistry(): UnsavedSectionRegistry;
+/**
+ * Registers one or more named sections so the unsaved-changes confirm dialog
+ * can tell the user *which* parts are dirty instead of a generic message.
+ *
+ * Pass a getter returning a descriptor — or an array of descriptors when the
+ * component owns several sub-sections (e.g. one PageContentsManage owns N page
+ * positions). No-op when called outside a guarded route (inject returns null).
+ */
+export declare function useUnsavedSection(source: UnsavedSectionSource): void;

package/dist/domains/unsavedGuard/composables/useUnsavedSection.js

@@ -0,0 +1,36 @@
+import { computed as e, getCurrentInstance as t, inject as n, onBeforeUnmount as r, provide as i, reactive as a } from "vue";
+//#region src/domains/unsavedGuard/composables/useUnsavedSection.ts
+var o = Symbol("unsaved.sections");
+function s() {
+	let t = a(/* @__PURE__ */ new Map());
+	return {
+		register(e, n) {
+			t.set(e, n);
+		},
+		unregister(e) {
+			t.delete(e);
+		},
+		dirtyLabels: e(() => {
+			let e = /* @__PURE__ */ new Set();
+			for (let n of t.values()) for (let t of n.value) t.dirty && e.add(t.label);
+			return [...e];
+		})
+	};
+}
+function c() {
+	let e = s();
+	return t() && i(o, e), e;
+}
+function l(i) {
+	let a = n(o, null);
+	if (!a || !t()) return;
+	let s = Symbol("unsaved.section"), c = e(() => {
+		let e = i();
+		return Array.isArray(e) ? e : [e];
+	});
+	a.register(s, c), r(() => a.unregister(s));
+}
+//#endregion
+export { o as UnsavedSectionKey, s as createUnsavedSectionRegistry, c as provideUnsavedSectionRegistry, l as useUnsavedSection };
+
+//# sourceMappingURL=useUnsavedSection.js.map

package/dist/domains/unsavedGuard/composables/useUnsavedSection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUnsavedSection.js","names":["UnsavedSectionKey","createUnsavedSectionRegistry","sources","reactive","id","source","computed","out","descriptor","provideUnsavedSectionRegistry","registry","getCurrentInstance","provide","useUnsavedSection","inject","normalized","resolved","onBeforeUnmount"],"sources":["../../../../src/domains/unsavedGuard/composables/useUnsavedSection.ts"],"sourcesContent":["import {\n  computed,\n  getCurrentInstance,\n  inject,\n  onBeforeUnmount,\n  provide,\n  reactive,\n  type ComputedRef,\n  type InjectionKey,\n} from 'vue'\n\n/**\n * One named, savable section the unsaved-changes confirm dialog can name back\n * to the user. `dirty` is evaluated reactively inside the section's getter.\n */\nexport interface UnsavedSectionDescriptor {\n  label: string\n  dirty: boolean\n}\n\n/**\n * Getter returning a single descriptor, or an array of them for a component\n * that owns several sub-sections (e.g. page positions in one PageContentsManage).\n */\nexport type UnsavedSectionSource = () => UnsavedSectionDescriptor | UnsavedSectionDescriptor[]\n\nexport interface UnsavedSectionRegistry {\n  register: (id: symbol, source: ComputedRef<UnsavedSectionDescriptor[]>) => void\n  unregister: (id: symbol) => void\n  /** Labels of every registered section currently flagged dirty. */\n  dirtyLabels: ComputedRef<string[]>\n}\n\nexport const UnsavedSectionKey = Symbol('unsaved.sections') as InjectionKey<UnsavedSectionRegistry>\n\nexport function createUnsavedSectionRegistry(): UnsavedSectionRegistry {\n  const sources = reactive(new Map<symbol, ComputedRef<UnsavedSectionDescriptor[]>>())\n\n  // Each label once: two open rows of a list editor can each hold the same nested list, and the leave\n  // dialog names what is unsaved, not how many times.\n  const dirtyLabels = computed<string[]>(() => {\n    const out = new Set<string>()\n    for (const source of sources.values()) {\n      for (const descriptor of source.value) {\n        if (descriptor.dirty) out.add(descriptor.label)\n      }\n    }\n    return [...out]\n  })\n\n  return {\n    register(id, source) {\n      sources.set(id, source)\n    },\n    unregister(id) {\n      sources.delete(id)\n    },\n    dirtyLabels,\n  }\n}\n\n/**\n * Creates a registry and `provide`s it for descendants. Called internally by\n * `useUnsavedChangesGuard` so the guard host automatically supplies one.\n */\nexport function provideUnsavedSectionRegistry(): UnsavedSectionRegistry {\n  const registry = createUnsavedSectionRegistry()\n  if (getCurrentInstance()) provide(UnsavedSectionKey, registry)\n  return registry\n}\n\n/**\n * Registers one or more named sections so the unsaved-changes confirm dialog\n * can tell the user *which* parts are dirty instead of a generic message.\n *\n * Pass a getter returning a descriptor — or an array of descriptors when the\n * component owns several sub-sections (e.g. one PageContentsManage owns N page\n * positions). No-op when called outside a guarded route (inject returns null).\n */\nexport function useUnsavedSection(source: UnsavedSectionSource): void {\n  const registry = inject(UnsavedSectionKey, null)\n  if (!registry) return\n  if (!getCurrentInstance()) return\n\n  const id = Symbol('unsaved.section')\n  const normalized = computed<UnsavedSectionDescriptor[]>(() => {\n    const resolved = source()\n    return Array.isArray(resolved) ? resolved : [resolved]\n  })\n\n  registry.register(id, normalized)\n  onBeforeUnmount(() => registry.unregister(id))\n}\n"],"mappings":";;AAiCA,IAAaA,IAAoB,OAAO,kBAAkB;AAE1D,SAAgBC,IAAuD;CACrE,IAAMC,IAAUC,kBAAS,IAAI,IAAqD,CAAC;CAcnF,OAAO;EACL,SAAS,GAAI,GAAQ;GACnB,EAAQ,IAAIC,GAAIC,CAAM;EACxB;EACA,WAAW,GAAI;GACb,EAAQ,OAAOD,CAAE;EACnB;EACA,aAjBkBE,QAAyB;GAC3C,IAAMC,oBAAM,IAAI,IAAY;GAC5B,KAAK,IAAMF,KAAUH,EAAQ,OAAO,GAClC,KAAK,IAAMM,KAAcH,EAAO,OAC9B,AAAIG,EAAW,SAAOD,EAAI,IAAIC,EAAW,KAAK;GAGlD,OAAO,CAAC,GAAGD,CAAG;EAChB,CASE;CACF;AACF;AAMA,SAAgBE,IAAwD;CACtE,IAAMC,IAAWT,EAA6B;CAE9C,OADIU,EAAmB,KAAGC,EAAQZ,GAAmBU,CAAQ,GACtDA;AACT;AAUA,SAAgBG,EAAkB,GAAoC;CACpE,IAAMH,IAAWI,EAAOd,GAAmB,IAAI;CAE/C,IADI,CAACU,KACD,CAACC,EAAmB,GAAG;CAE3B,IAAMP,IAAK,OAAO,iBAAiB,GAC7BW,IAAaT,QAA2C;EAC5D,IAAMU,IAAWX,EAAO;EACxB,OAAO,MAAM,QAAQW,CAAQ,IAAIA,IAAW,CAACA,CAAQ;CACvD,CAAC;CAGD,AADAN,EAAS,SAASN,GAAIW,CAAU,GAChCE,QAAsBP,EAAS,WAAWN,CAAE,CAAC;AAC/C"}