@vireocodedev/shell 0.2.0 → 0.2.1

package/dist/config/shellConfig.d.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+import { ShellNavigationEntry } from '../navigation/shellNavigation';
+import { ShellPage, ShellPermission, ShellSitemap } from '../sitemap/shellSitemap.types';
+export declare const ShellModeSchema: z.ZodEnum<{
+    dashboard: "dashboard";
+    public: "public";
+    bare: "bare";
+}>;
+export type ShellMode = z.infer<typeof ShellModeSchema>;
+export type ShellConfig<TPermission extends ShellPermission = ShellPermission, TContext = unknown> = {
+    mode: ShellMode;
+    sitemap: ShellSitemap;
+    entryPage: ShellPage<string, string, TPermission, TContext>;
+    loginPage?: ShellPage<string, string, TPermission, TContext>;
+    unauthorizedPage?: ShellPage<string, string, TPermission, TContext>;
+    navigation?: {
+        authenticated?: readonly ShellNavigationEntry<TPermission, TContext>[];
+        public?: readonly ShellNavigationEntry<TPermission, TContext>[];
+    };
+};
+export type ShellConfigValidationOptions<TPermission extends ShellPermission = ShellPermission> = {
+    permissions?: ReadonlySet<TPermission> | readonly TPermission[] | Readonly<Record<TPermission, unknown>>;
+};
+export declare function defineShellConfig<TPermission extends ShellPermission = ShellPermission, TContext = unknown>(config: ShellConfig<TPermission, TContext>, options?: ShellConfigValidationOptions<TPermission>): ShellConfig<TPermission, TContext>;

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export { defineShellConfig, ShellModeSchema } from './config/shellConfig';
+export type { ShellConfig, ShellConfigValidationOptions, ShellMode } from './config/shellConfig';
+export { createAuthRedirectState, isSafeInternalPath, resolvePostLoginPath } from './navigation/authRedirect';
+export type { ShellAuthRedirectState, ShellLocationSnapshot } from './navigation/authRedirect';
+export { ShellNavigationIdSchema, shellNavigation } from './navigation/shellNavigation';
+export type { ShellNavigationEntry } from './navigation/shellNavigation';
+export { createOverlayHistoryRegistry, getCommonOverlayPrefixLength, OVERLAY_HISTORY_STATE_KEY, readOverlayStack, resolveOverlayHistoryAction, withOverlayStack, } from './overlay-history/overlayHistory';
+export type { OverlayHistoryAction, OverlayHistoryEntry, OverlayHistoryEntryId, OverlayHistoryRegistry, OverlayHistoryResolveInput, } from './overlay-history/overlayHistory';
+export { generateShellPath, getRequiredRouteParamNames, joinRoutePattern, normalizeRoutePath, } from './sitemap/routePath';
+export { createShellSitemap, defineShellPages, defineShellSections, ShellRouteKeySchema, ShellRoutePathSchema, } from './sitemap/shellSitemap';
+export type { ResolvedShellRoute, ShellLabel, ShellPage, ShellPageDefinition, ShellPathForPage, ShellPermission, ShellPermissionScope, ShellRouteMetadata, ShellRouteNode, ShellRouteParams, ShellRouteParamValue, ShellRouteTreeNode, ShellRouteTreePageEntries, ShellSection, ShellSectionDefinition, ShellSitemap, } from './sitemap/shellSitemap.types';

package/dist/index.js

@@ -0,0 +1,260 @@
+import { z as e } from "zod";
+//#region src/config/shellConfig.ts
+var t = e.enum([
+	"dashboard",
+	"public",
+	"bare"
+]);
+function n(e, t) {
+	return t ? t instanceof Set ? t.has(e) : Array.isArray(t) ? t.includes(e) : Object.prototype.hasOwnProperty.call(t, e) : !0;
+}
+function r(r, i = {}) {
+	let a = [];
+	t.parse(r.mode);
+	let o = (t, n) => {
+		t && r.sitemap.getRoute(t.key)?.kind !== "page" && a.push({
+			code: e.ZodIssueCode.custom,
+			path: n,
+			message: `Page "${t.key}" is not mounted in the sitemap.`
+		});
+	};
+	if (o(r.entryPage, ["entryPage"]), o(r.loginPage, ["loginPage"]), o(r.unauthorizedPage, ["unauthorizedPage"]), Object.entries(r.navigation ?? {}).forEach(([t, r]) => {
+		let s = /* @__PURE__ */ new Set();
+		r?.forEach((r, c) => {
+			r.type === "item" && o(r.page, [
+				"navigation",
+				t,
+				c,
+				"page"
+			]), (r.type === "heading" || r.type === "action") && (s.has(r.id) && a.push({
+				code: e.ZodIssueCode.custom,
+				path: [
+					"navigation",
+					t,
+					c,
+					"id"
+				],
+				message: `Duplicate navigation id "${r.id}".`
+			}), s.add(r.id)), "permission" in r && r.permission && !n(r.permission, i.permissions) && a.push({
+				code: e.ZodIssueCode.custom,
+				path: [
+					"navigation",
+					t,
+					c,
+					"permission"
+				],
+				message: `Unknown permission "${r.permission}".`
+			});
+		});
+	}), r.sitemap.routes.forEach((t, r) => {
+		let o = t.node.permission;
+		o && !n(o, i.permissions) && a.push({
+			code: e.ZodIssueCode.custom,
+			path: [
+				"sitemap",
+				"routes",
+				r,
+				"permission"
+			],
+			message: `Unknown permission "${o}".`
+		});
+	}), a.length > 0) throw new e.ZodError(a);
+	return Object.freeze(r);
+}
+//#endregion
+//#region src/navigation/authRedirect.ts
+function i(e) {
+	if (!e.startsWith("/") || e.startsWith("//") || e.includes("\\")) return !1;
+	try {
+		return new URL(e, "https://starter.invalid").origin === "https://starter.invalid";
+	} catch {
+		return !1;
+	}
+}
+function a(e, t) {
+	let n = `${e.pathname}${e.search ?? ""}${e.hash ?? ""}`;
+	if (!(e.pathname === t || !i(n))) return { from: n };
+}
+function o(e, t) {
+	if (typeof e != "object" || !e || !("from" in e)) return t;
+	let n = e.from;
+	return typeof n == "string" && i(n) ? n : t;
+}
+//#endregion
+//#region src/navigation/shellNavigation.ts
+var s = e.string().trim().min(1, "Navigation identifiers cannot be blank."), c = {
+	item(e, t = {}) {
+		return {
+			type: "item",
+			page: e,
+			...t
+		};
+	},
+	heading(e, t) {
+		return {
+			type: "heading",
+			id: s.parse(e),
+			label: t
+		};
+	},
+	action(e, t, n = {}) {
+		return {
+			type: "action",
+			id: s.parse(e),
+			label: t,
+			...n
+		};
+	},
+	divider() {
+		return { type: "divider" };
+	}
+}, l = "__starterShellOverlayStack";
+function u(e) {
+	return Array.isArray(e) && e.every((e) => typeof e == "string");
+}
+function d(e) {
+	if (typeof e != "object" || !e) return [];
+	let t = e[l];
+	return u(t) ? [...t] : [];
+}
+function f(e, t) {
+	let n = typeof e == "object" && e ? { ...e } : {};
+	return t.length === 0 ? delete n[l] : n[l] = [...t], n;
+}
+function p(e, t) {
+	let n = Math.min(e.length, t.length), r = 0;
+	for (; r < n && e[r] === t[r];) r += 1;
+	return r;
+}
+function m(e) {
+	let { desired: t, actual: n, previousActual: r, navigationType: i, locationChanged: a, urlChanged: o } = e;
+	if (a && o) return { type: "idle" };
+	if (a && i === "POP") {
+		let e = [...r].reverse().find((e) => !n.includes(e) && t.includes(e));
+		if (e !== void 0) return {
+			type: "requestClose",
+			id: e
+		};
+	}
+	let s = p(t, n);
+	return n.length > s ? { type: "consume" } : t.length > s ? {
+		type: "push",
+		stack: [...n, t[s]]
+	} : { type: "idle" };
+}
+function h() {
+	let e = [], t = /* @__PURE__ */ new Set(), n = () => t.forEach((e) => e());
+	return {
+		register(t) {
+			return e = e.some((e) => e.id === t.id) ? e.map((e) => e.id === t.id ? t : e) : [...e, t], n(), () => this.unregister(t.id);
+		},
+		unregister(t) {
+			e.some((e) => e.id === t) && (e = e.filter((e) => e.id !== t), n());
+		},
+		getSnapshot() {
+			return e;
+		},
+		subscribe(e) {
+			return t.add(e), () => t.delete(e);
+		},
+		clear() {
+			e.length !== 0 && (e = [], n());
+		}
+	};
+}
+//#endregion
+//#region src/sitemap/routePath.ts
+function g(e) {
+	return e.replace(/^\/+|\/+$/gu, "");
+}
+function _(e, t) {
+	let n = g(e), r = g(t);
+	return !n && !r ? "/" : `/${[n, r].filter(Boolean).join("/")}`;
+}
+function v(e) {
+	return Array.from(e.matchAll(/:([^/?*]+)([?*]?)/gu)).filter((e) => e[2] === "").map((e) => e[1]);
+}
+function y(e, t) {
+	let n = String(e);
+	return t ? n.split("/").map(encodeURIComponent).join("/") : encodeURIComponent(n);
+}
+function b(e, t = {}) {
+	return e.split("/").flatMap((n) => {
+		let r = n.match(/^:([^?*]+)([?*]?)$/u);
+		if (!r) return [n];
+		let [, i, a] = r, o = t[i];
+		if (o == null) {
+			if (a === "?" || a === "*") return [];
+			throw Error(`Missing required route parameter "${i}" for pattern "${e}".`);
+		}
+		return [y(o, a === "*")];
+	}).join("/") || "/";
+}
+//#endregion
+//#region src/sitemap/shellSitemap.ts
+var x = e.string().trim().min(1, "Route keys cannot be blank."), S = e.string().refine((e) => !e.startsWith("/"), "Route paths must be local segments without a leading slash.").refine((e) => !e.includes("//"), "Route paths cannot contain empty segments.");
+function C(e, t) {
+	return Object.fromEntries(Object.entries(e).map(([e, n]) => {
+		let r = x.parse(e);
+		return S.parse(n.routePath), [e, Object.freeze({
+			...n,
+			kind: t,
+			key: r
+		})];
+	}));
+}
+function w(e) {
+	return C(e, "page");
+}
+function T(e) {
+	return C(e, "section");
+}
+function E(e) {
+	return "kind" in e;
+}
+function D(e) {
+	let t = /* @__PURE__ */ new Map(), n = /* @__PURE__ */ new Map(), r = /* @__PURE__ */ new Map(), i = [];
+	function a(e, o, s) {
+		e.forEach((e) => {
+			let c = E(e) ? e : e.node;
+			if (x.parse(c.key), S.parse(c.routePath), n.has(c.key)) throw Error(`Route key "${c.key}" is mounted more than once.`);
+			let l = _(o, c.routePath), u = r.get(l);
+			if (u) throw Error(`Route pattern "${l}" is shared by "${u}" and "${c.key}".`);
+			let d = {
+				key: c.key,
+				kind: c.kind,
+				pathPattern: l,
+				parentKey: s,
+				node: c
+			};
+			n.set(c.key, d), r.set(l, c.key), c.kind === "page" && t.set(c.key, l), E(e) || (e.redirectTo && i.push({
+				route: d,
+				target: e.redirectTo
+			}), e.children && a(e.children, l, c.key));
+		});
+	}
+	a(e, ""), i.forEach(({ route: e, target: n }) => {
+		let r = t.get(n.key);
+		if (!r) throw Error(`Redirect target "${n.key}" is not mounted in the sitemap.`);
+		e.redirectToPattern = r;
+	});
+	let o = {
+		routes: Object.freeze([...n.values()]),
+		getPath(e, ...t) {
+			return b(o.getPathPattern(e), t[0]);
+		},
+		getPathPattern(e) {
+			let n = t.get(e.key);
+			if (!n) throw Error(`Page "${e.key}" is not mounted in the sitemap.`);
+			return n;
+		},
+		getRoute(e) {
+			return n.get(e);
+		}
+	};
+	return o;
+}
+//#endregion
+export { l as OVERLAY_HISTORY_STATE_KEY, t as ShellModeSchema, s as ShellNavigationIdSchema, x as ShellRouteKeySchema, S as ShellRoutePathSchema, a as createAuthRedirectState, h as createOverlayHistoryRegistry, D as createShellSitemap, r as defineShellConfig, w as defineShellPages, T as defineShellSections, b as generateShellPath, p as getCommonOverlayPrefixLength, v as getRequiredRouteParamNames, i as isSafeInternalPath, _ as joinRoutePattern, g as normalizeRoutePath, d as readOverlayStack, m as resolveOverlayHistoryAction, o as resolvePostLoginPath, c as shellNavigation, f as withOverlayStack };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/config/shellConfig.ts","../src/navigation/authRedirect.ts","../src/navigation/shellNavigation.ts","../src/overlay-history/overlayHistory.ts","../src/sitemap/routePath.ts","../src/sitemap/shellSitemap.ts"],"sourcesContent":["import { z } from \"zod\";\nimport type { ShellNavigationEntry } from \"../navigation/shellNavigation\";\nimport type { ShellPage, ShellPermission, ShellSitemap } from \"../sitemap/shellSitemap.types\";\n\nexport const ShellModeSchema = z.enum([\"dashboard\", \"public\", \"bare\"]);\nexport type ShellMode = z.infer<typeof ShellModeSchema>;\n\nexport type ShellConfig<TPermission extends ShellPermission = ShellPermission, TContext = unknown> = {\n  mode: ShellMode;\n  sitemap: ShellSitemap;\n  entryPage: ShellPage<string, string, TPermission, TContext>;\n  loginPage?: ShellPage<string, string, TPermission, TContext>;\n  unauthorizedPage?: ShellPage<string, string, TPermission, TContext>;\n  navigation?: {\n    authenticated?: readonly ShellNavigationEntry<TPermission, TContext>[];\n    public?: readonly ShellNavigationEntry<TPermission, TContext>[];\n  };\n};\n\nexport type ShellConfigValidationOptions<TPermission extends ShellPermission = ShellPermission> = {\n  permissions?: ReadonlySet<TPermission> | readonly TPermission[] | Readonly<Record<TPermission, unknown>>;\n};\n\nfunction hasPermission<TPermission extends ShellPermission>(\n  permission: TPermission,\n  registry: ShellConfigValidationOptions<TPermission>[\"permissions\"],\n): boolean {\n  if (!registry) return true;\n  if (registry instanceof Set) return registry.has(permission);\n  if (Array.isArray(registry)) return registry.includes(permission);\n  return Object.prototype.hasOwnProperty.call(registry, permission);\n}\n\nexport function defineShellConfig<TPermission extends ShellPermission = ShellPermission, TContext = unknown>(\n  config: ShellConfig<TPermission, TContext>,\n  options: ShellConfigValidationOptions<TPermission> = {},\n): ShellConfig<TPermission, TContext> {\n  const issues: z.ZodIssue[] = [];\n  ShellModeSchema.parse(config.mode);\n\n  const assertMountedPage = (page: { key: string } | undefined, path: (string | number)[]) => {\n    if (!page) return;\n    const route = config.sitemap.getRoute(page.key);\n    if (route?.kind !== \"page\") {\n      issues.push({\n        code: z.ZodIssueCode.custom,\n        path,\n        message: `Page \"${page.key}\" is not mounted in the sitemap.`,\n      });\n    }\n  };\n\n  assertMountedPage(config.entryPage, [\"entryPage\"]);\n  assertMountedPage(config.loginPage, [\"loginPage\"]);\n  assertMountedPage(config.unauthorizedPage, [\"unauthorizedPage\"]);\n\n  Object.entries(config.navigation ?? {}).forEach(([group, entries]) => {\n    const seenIds = new Set<string>();\n    entries?.forEach((entry, index) => {\n      if (entry.type === \"item\") assertMountedPage(entry.page, [\"navigation\", group, index, \"page\"]);\n      if (entry.type === \"heading\" || entry.type === \"action\") {\n        if (seenIds.has(entry.id)) {\n          issues.push({\n            code: z.ZodIssueCode.custom,\n            path: [\"navigation\", group, index, \"id\"],\n            message: `Duplicate navigation id \"${entry.id}\".`,\n          });\n        }\n        seenIds.add(entry.id);\n      }\n      if (\"permission\" in entry && entry.permission && !hasPermission(entry.permission, options.permissions)) {\n        issues.push({\n          code: z.ZodIssueCode.custom,\n          path: [\"navigation\", group, index, \"permission\"],\n          message: `Unknown permission \"${entry.permission}\".`,\n        });\n      }\n    });\n  });\n\n  config.sitemap.routes.forEach((route, index) => {\n    const permission = route.node.permission as TPermission | undefined;\n    if (permission && !hasPermission(permission, options.permissions)) {\n      issues.push({\n        code: z.ZodIssueCode.custom,\n        path: [\"sitemap\", \"routes\", index, \"permission\"],\n        message: `Unknown permission \"${permission}\".`,\n      });\n    }\n  });\n\n  if (issues.length > 0) throw new z.ZodError(issues);\n  return Object.freeze(config);\n}\n","export type ShellLocationSnapshot = { pathname: string; search?: string; hash?: string };\nexport type ShellAuthRedirectState = { from: string };\n\nexport function isSafeInternalPath(path: string): boolean {\n  if (!path.startsWith(\"/\") || path.startsWith(\"//\") || path.includes(\"\\\\\")) return false;\n  try {\n    return new URL(path, \"https://starter.invalid\").origin === \"https://starter.invalid\";\n  } catch {\n    return false;\n  }\n}\n\nexport function createAuthRedirectState(\n  location: ShellLocationSnapshot,\n  loginPath: string,\n): ShellAuthRedirectState | undefined {\n  const returnPath = `${location.pathname}${location.search ?? \"\"}${location.hash ?? \"\"}`;\n  if (location.pathname === loginPath || !isSafeInternalPath(returnPath)) return undefined;\n  return { from: returnPath };\n}\n\nexport function resolvePostLoginPath(state: unknown, fallbackPath: string): string {\n  if (typeof state !== \"object\" || state == null || !(\"from\" in state)) return fallbackPath;\n  const from = (state as { from?: unknown }).from;\n  return typeof from === \"string\" && isSafeInternalPath(from) ? from : fallbackPath;\n}\n","import { z } from \"zod\";\nimport type { ShellLabel, ShellPage, ShellPermission, ShellPermissionScope } from \"../sitemap/shellSitemap.types\";\n\nexport const ShellNavigationIdSchema = z.string().trim().min(1, \"Navigation identifiers cannot be blank.\");\n\nexport type ShellNavigationEntry<TPermission extends ShellPermission = ShellPermission, TContext = unknown> =\n  | {\n      type: \"item\";\n      page: ShellPage<string, string, TPermission, TContext>;\n      label?: ShellLabel<TContext>;\n      icon?: string;\n      disabled?: boolean;\n      disabledReason?: ShellLabel<TContext>;\n      permission?: TPermission;\n      permissionScope?: ShellPermissionScope;\n    }\n  | { type: \"heading\"; id: string; label: ShellLabel<TContext> }\n  | { type: \"action\"; id: string; label: ShellLabel<TContext>; icon?: string; permission?: TPermission }\n  | { type: \"divider\" };\n\nexport const shellNavigation = {\n  item<TPermission extends ShellPermission = ShellPermission, TContext = unknown>(\n    page: ShellPage<string, string, TPermission, TContext>,\n    overrides: Omit<ShellNavigationEntry<TPermission, TContext> & { type: \"item\" }, \"page\" | \"type\"> = {},\n  ): ShellNavigationEntry<TPermission, TContext> {\n    return { type: \"item\", page, ...overrides };\n  },\n  heading<TContext = unknown>(\n    id: string,\n    label: ShellLabel<TContext>,\n  ): ShellNavigationEntry<ShellPermission, TContext> {\n    return { type: \"heading\", id: ShellNavigationIdSchema.parse(id), label };\n  },\n  action<TPermission extends ShellPermission = ShellPermission, TContext = unknown>(\n    id: string,\n    label: ShellLabel<TContext>,\n    options: { icon?: string; permission?: TPermission } = {},\n  ): ShellNavigationEntry<TPermission, TContext> {\n    return { type: \"action\", id: ShellNavigationIdSchema.parse(id), label, ...options };\n  },\n  divider(): ShellNavigationEntry {\n    return { type: \"divider\" };\n  },\n};\n","export const OVERLAY_HISTORY_STATE_KEY = \"__starterShellOverlayStack\";\nexport type OverlayHistoryEntryId = string;\nexport type OverlayHistoryEntry = { id: OverlayHistoryEntryId; requestClose: () => void };\nexport type OverlayHistoryAction =\n  | { type: \"idle\" }\n  | { type: \"push\"; stack: readonly OverlayHistoryEntryId[] }\n  | { type: \"consume\" }\n  | { type: \"requestClose\"; id: OverlayHistoryEntryId };\n\nexport type OverlayHistoryResolveInput = {\n  desired: readonly OverlayHistoryEntryId[];\n  actual: readonly OverlayHistoryEntryId[];\n  previousActual: readonly OverlayHistoryEntryId[];\n  navigationType: \"POP\" | \"PUSH\" | \"REPLACE\";\n  locationChanged: boolean;\n  urlChanged: boolean;\n};\n\nfunction isEntryIdList(value: unknown): value is OverlayHistoryEntryId[] {\n  return Array.isArray(value) && value.every(item => typeof item === \"string\");\n}\n\nexport function readOverlayStack(state: unknown): OverlayHistoryEntryId[] {\n  if (typeof state !== \"object\" || state === null) return [];\n  const stack = (state as Record<string, unknown>)[OVERLAY_HISTORY_STATE_KEY];\n  return isEntryIdList(stack) ? [...stack] : [];\n}\n\nexport function withOverlayStack(state: unknown, stack: readonly OverlayHistoryEntryId[]): Record<string, unknown> {\n  const nextState = typeof state === \"object\" && state !== null ? { ...(state as Record<string, unknown>) } : {};\n  if (stack.length === 0) delete nextState[OVERLAY_HISTORY_STATE_KEY];\n  else nextState[OVERLAY_HISTORY_STATE_KEY] = [...stack];\n  return nextState;\n}\n\nexport function getCommonOverlayPrefixLength(\n  left: readonly OverlayHistoryEntryId[],\n  right: readonly OverlayHistoryEntryId[],\n): number {\n  const max = Math.min(left.length, right.length);\n  let index = 0;\n  while (index < max && left[index] === right[index]) index += 1;\n  return index;\n}\n\nexport function resolveOverlayHistoryAction(input: OverlayHistoryResolveInput): OverlayHistoryAction {\n  const { desired, actual, previousActual, navigationType, locationChanged, urlChanged } = input;\n  if (locationChanged && urlChanged) return { type: \"idle\" };\n\n  if (locationChanged && navigationType === \"POP\") {\n    const poppedStillOpen = [...previousActual].reverse().find(id => !actual.includes(id) && desired.includes(id));\n    if (poppedStillOpen !== undefined) return { type: \"requestClose\", id: poppedStillOpen };\n  }\n\n  const prefixLength = getCommonOverlayPrefixLength(desired, actual);\n  if (actual.length > prefixLength) return { type: \"consume\" };\n  if (desired.length > prefixLength) return { type: \"push\", stack: [...actual, desired[prefixLength]] };\n  return { type: \"idle\" };\n}\n\nexport type OverlayHistoryRegistry = {\n  register(entry: OverlayHistoryEntry): () => void;\n  unregister(id: OverlayHistoryEntryId): void;\n  getSnapshot(): readonly OverlayHistoryEntry[];\n  subscribe(listener: () => void): () => void;\n  clear(): void;\n};\n\nexport function createOverlayHistoryRegistry(): OverlayHistoryRegistry {\n  let entries: readonly OverlayHistoryEntry[] = [];\n  const listeners = new Set<() => void>();\n  const publish = () => listeners.forEach(listener => listener());\n\n  return {\n    register(entry) {\n      const exists = entries.some(candidate => candidate.id === entry.id);\n      entries = exists\n        ? entries.map(candidate => (candidate.id === entry.id ? entry : candidate))\n        : [...entries, entry];\n      publish();\n      return () => this.unregister(entry.id);\n    },\n    unregister(id) {\n      if (!entries.some(entry => entry.id === id)) return;\n      entries = entries.filter(entry => entry.id !== id);\n      publish();\n    },\n    getSnapshot() {\n      return entries;\n    },\n    subscribe(listener) {\n      listeners.add(listener);\n      return () => listeners.delete(listener);\n    },\n    clear() {\n      if (entries.length === 0) return;\n      entries = [];\n      publish();\n    },\n  };\n}\n","import type { ShellRouteParams } from \"./shellSitemap.types\";\n\nexport function normalizeRoutePath(path: string): string {\n  return path.replace(/^\\/+|\\/+$/gu, \"\");\n}\n\nexport function joinRoutePattern(parentPath: string, routePath: string): string {\n  const parent = normalizeRoutePath(parentPath);\n  const child = normalizeRoutePath(routePath);\n\n  if (!parent && !child) return \"/\";\n  return `/${[parent, child].filter(Boolean).join(\"/\")}`;\n}\n\nexport function getRequiredRouteParamNames(pattern: string): string[] {\n  return Array.from(pattern.matchAll(/:([^/?*]+)([?*]?)/gu))\n    .filter(match => match[2] === \"\")\n    .map(match => match[1]);\n}\n\nfunction encodeRouteValue(value: string | number, preserveSlashes: boolean): string {\n  const text = String(value);\n  return preserveSlashes ? text.split(\"/\").map(encodeURIComponent).join(\"/\") : encodeURIComponent(text);\n}\n\nexport function generateShellPath(pattern: string, params: ShellRouteParams = {}): string {\n  const segments = pattern.split(\"/\");\n  const generated = segments.flatMap(segment => {\n    const match = segment.match(/^:([^?*]+)([?*]?)$/u);\n    if (!match) return [segment];\n\n    const [, name, modifier] = match;\n    const value = params[name];\n    if (value == null) {\n      if (modifier === \"?\" || modifier === \"*\") return [];\n      throw new Error(`Missing required route parameter \"${name}\" for pattern \"${pattern}\".`);\n    }\n\n    return [encodeRouteValue(value, modifier === \"*\")];\n  });\n\n  return generated.join(\"/\") || \"/\";\n}\n","import { z } from \"zod\";\nimport { generateShellPath, joinRoutePattern } from \"./routePath\";\nimport type {\n  ResolvedShellRoute,\n  ShellPage,\n  ShellPageDefinition,\n  ShellPermission,\n  ShellRouteNode,\n  ShellRouteTreeNode,\n  ShellSection,\n  ShellSectionDefinition,\n  ShellSitemap,\n} from \"./shellSitemap.types\";\n\nexport const ShellRouteKeySchema = z.string().trim().min(1, \"Route keys cannot be blank.\");\nexport const ShellRoutePathSchema = z\n  .string()\n  .refine(path => !path.startsWith(\"/\"), \"Route paths must be local segments without a leading slash.\")\n  .refine(path => !path.includes(\"//\"), \"Route paths cannot contain empty segments.\");\n\ntype StrictConfig<TConfig, TShape> = TConfig & Record<Exclude<keyof TConfig, keyof TShape>, never>;\ntype StrictConfigRecord<TRecord, TShape> = {\n  readonly [K in keyof TRecord]: StrictConfig<TRecord[K], TShape>;\n};\n\ntype ShellPageRecord<\n  TPages extends Record<string, ShellPageDefinition<TPermission, TContext>>,\n  TPermission extends ShellPermission,\n  TContext,\n> = {\n  readonly [K in keyof TPages]: ShellPage<K & string, TPages[K][\"routePath\"], TPermission, TContext> & TPages[K];\n};\n\ntype ShellSectionRecord<\n  TSections extends Record<string, ShellSectionDefinition<TPermission, TContext>>,\n  TPermission extends ShellPermission,\n  TContext,\n> = {\n  readonly [K in keyof TSections]: ShellSection<K & string, TSections[K][\"routePath\"], TPermission, TContext> &\n    TSections[K];\n};\n\nfunction defineNodes<TKind extends \"page\" | \"section\">(\n  definitions: Readonly<Record<string, { routePath: string }>>,\n  kind: TKind,\n): Record<string, unknown> {\n  return Object.fromEntries(\n    Object.entries(definitions).map(([key, definition]) => {\n      const parsedKey = ShellRouteKeySchema.parse(key);\n      ShellRoutePathSchema.parse(definition.routePath);\n      return [key, Object.freeze({ ...definition, kind, key: parsedKey })];\n    }),\n  );\n}\n\nexport function defineShellPages<\n  TPermission extends ShellPermission = ShellPermission,\n  TContext = unknown,\n  const TPages extends Record<string, ShellPageDefinition<TPermission, TContext>> = Record<\n    string,\n    ShellPageDefinition<TPermission, TContext>\n  >,\n>(\n  pages: StrictConfigRecord<TPages, ShellPageDefinition<TPermission, TContext>>,\n): ShellPageRecord<TPages, TPermission, TContext> {\n  return defineNodes(pages, \"page\") as unknown as ShellPageRecord<TPages, TPermission, TContext>;\n}\n\nexport function defineShellSections<\n  TPermission extends ShellPermission = ShellPermission,\n  TContext = unknown,\n  const TSections extends Record<string, ShellSectionDefinition<TPermission, TContext>> = Record<\n    string,\n    ShellSectionDefinition<TPermission, TContext>\n  >,\n>(\n  sections: StrictConfigRecord<TSections, ShellSectionDefinition<TPermission, TContext>>,\n): ShellSectionRecord<TSections, TPermission, TContext> {\n  return defineNodes(sections, \"section\") as unknown as ShellSectionRecord<TSections, TPermission, TContext>;\n}\n\nfunction isDirectNode(node: ShellRouteTreeNode): node is ShellPage {\n  return \"kind\" in node;\n}\n\nexport function createShellSitemap<const TRoutes extends readonly ShellRouteTreeNode[]>(\n  tree: TRoutes,\n): ShellSitemap<TRoutes> {\n  const pagePatterns = new Map<string, string>();\n  const routesByKey = new Map<string, ResolvedShellRoute>();\n  const pathOwners = new Map<string, string>();\n  const pendingRedirects: Array<{ route: ResolvedShellRoute; target: ShellPage }> = [];\n\n  function visit(nodes: readonly ShellRouteTreeNode[], parentPattern: string, parentKey?: string): void {\n    nodes.forEach(treeNode => {\n      const node: ShellRouteNode = isDirectNode(treeNode) ? treeNode : treeNode.node;\n      ShellRouteKeySchema.parse(node.key);\n      ShellRoutePathSchema.parse(node.routePath);\n\n      if (routesByKey.has(node.key)) throw new Error(`Route key \"${node.key}\" is mounted more than once.`);\n      const pathPattern = joinRoutePattern(parentPattern, node.routePath);\n      const existingPathOwner = pathOwners.get(pathPattern);\n      if (existingPathOwner) {\n        throw new Error(`Route pattern \"${pathPattern}\" is shared by \"${existingPathOwner}\" and \"${node.key}\".`);\n      }\n\n      const route: ResolvedShellRoute = { key: node.key, kind: node.kind, pathPattern, parentKey, node };\n      routesByKey.set(node.key, route);\n      pathOwners.set(pathPattern, node.key);\n      if (node.kind === \"page\") pagePatterns.set(node.key, pathPattern);\n\n      if (!isDirectNode(treeNode)) {\n        if (treeNode.redirectTo) pendingRedirects.push({ route, target: treeNode.redirectTo });\n        if (treeNode.children) visit(treeNode.children, pathPattern, node.key);\n      }\n    });\n  }\n\n  visit(tree, \"\");\n  pendingRedirects.forEach(({ route, target }) => {\n    const targetPattern = pagePatterns.get(target.key);\n    if (!targetPattern) throw new Error(`Redirect target \"${target.key}\" is not mounted in the sitemap.`);\n    route.redirectToPattern = targetPattern;\n  });\n\n  const sitemap: ShellSitemap<TRoutes> = {\n    routes: Object.freeze([...routesByKey.values()]),\n    getPath(page, ...args) {\n      const pattern = sitemap.getPathPattern(page);\n      return generateShellPath(pattern, args[0]);\n    },\n    getPathPattern(page) {\n      const pattern = pagePatterns.get(page.key);\n      if (!pattern) throw new Error(`Page \"${page.key}\" is not mounted in the sitemap.`);\n      return pattern as never;\n    },\n    getRoute(key) {\n      return routesByKey.get(key);\n    },\n  };\n\n  return sitemap;\n}\n"],"mappings":";;AAIA,IAAa,IAAkB,EAAE,KAAK;CAAC;CAAa;CAAU;AAAM,CAAC;AAmBrE,SAAS,EACP,GACA,GACS;CAIT,OAHK,IACD,aAAoB,MAAY,EAAS,IAAI,CAAU,IACvD,MAAM,QAAQ,CAAQ,IAAU,EAAS,SAAS,CAAU,IACzD,OAAO,UAAU,eAAe,KAAK,GAAU,CAAU,IAH1C;AAIxB;AAEA,SAAgB,EACd,GACA,IAAqD,CAAC,GAClB;CACpC,IAAM,IAAuB,CAAC;CAC9B,EAAgB,MAAM,EAAO,IAAI;CAEjC,IAAM,KAAqB,GAAmC,MAA8B;EACrF,KACS,EAAO,QAAQ,SAAS,EAAK,GACvC,CAAA,EAAO,SAAS,UAClB,EAAO,KAAK;GACV,MAAM,EAAE,aAAa;GACrB;GACA,SAAS,SAAS,EAAK,IAAI;EAC7B,CAAC;CAEL;CAyCA,IAvCA,EAAkB,EAAO,WAAW,CAAC,WAAW,CAAC,GACjD,EAAkB,EAAO,WAAW,CAAC,WAAW,CAAC,GACjD,EAAkB,EAAO,kBAAkB,CAAC,kBAAkB,CAAC,GAE/D,OAAO,QAAQ,EAAO,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAO,OAAa;EACpE,IAAM,oBAAU,IAAI,IAAY;EAChC,GAAS,SAAS,GAAO,MAAU;GAYjC,AAXI,EAAM,SAAS,UAAQ,EAAkB,EAAM,MAAM;IAAC;IAAc;IAAO;IAAO;GAAM,CAAC,IACzF,EAAM,SAAS,aAAa,EAAM,SAAS,cACzC,EAAQ,IAAI,EAAM,EAAE,KACtB,EAAO,KAAK;IACV,MAAM,EAAE,aAAa;IACrB,MAAM;KAAC;KAAc;KAAO;KAAO;IAAI;IACvC,SAAS,4BAA4B,EAAM,GAAG;GAChD,CAAC,GAEH,EAAQ,IAAI,EAAM,EAAE,IAElB,gBAAgB,KAAS,EAAM,cAAc,CAAC,EAAc,EAAM,YAAY,EAAQ,WAAW,KACnG,EAAO,KAAK;IACV,MAAM,EAAE,aAAa;IACrB,MAAM;KAAC;KAAc;KAAO;KAAO;IAAY;IAC/C,SAAS,uBAAuB,EAAM,WAAW;GACnD,CAAC;EAEL,CAAC;CACH,CAAC,GAED,EAAO,QAAQ,OAAO,SAAS,GAAO,MAAU;EAC9C,IAAM,IAAa,EAAM,KAAK;EAC9B,AAAI,KAAc,CAAC,EAAc,GAAY,EAAQ,WAAW,KAC9D,EAAO,KAAK;GACV,MAAM,EAAE,aAAa;GACrB,MAAM;IAAC;IAAW;IAAU;IAAO;GAAY;GAC/C,SAAS,uBAAuB,EAAW;EAC7C,CAAC;CAEL,CAAC,GAEG,EAAO,SAAS,GAAG,MAAM,IAAI,EAAE,SAAS,CAAM;CAClD,OAAO,OAAO,OAAO,CAAM;AAC7B;;;AC1FA,SAAgB,EAAmB,GAAuB;CACxD,IAAI,CAAC,EAAK,WAAW,GAAG,KAAK,EAAK,WAAW,IAAI,KAAK,EAAK,SAAS,IAAI,GAAG,OAAO;CAClF,IAAI;EACF,OAAO,IAAI,IAAI,GAAM,yBAAyB,CAAC,CAAC,WAAW;CAC7D,QAAQ;EACN,OAAO;CACT;AACF;AAEA,SAAgB,EACd,GACA,GACoC;CACpC,IAAM,IAAa,GAAG,EAAS,WAAW,EAAS,UAAU,KAAK,EAAS,QAAQ;CAC/E,QAAS,aAAa,KAAa,CAAC,EAAmB,CAAU,IACrE,OAAO,EAAE,MAAM,EAAW;AAC5B;AAEA,SAAgB,EAAqB,GAAgB,GAA8B;CACjF,IAAI,OAAO,KAAU,aAAY,KAAiB,EAAE,UAAU,IAAQ,OAAO;CAC7E,IAAM,IAAQ,EAA6B;CAC3C,OAAO,OAAO,KAAS,YAAY,EAAmB,CAAI,IAAI,IAAO;AACvE;;;ACtBA,IAAa,IAA0B,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,yCAAyC,GAiB5F,IAAkB;CAC7B,KACE,GACA,IAAmG,CAAC,GACvD;EAC7C,OAAO;GAAE,MAAM;GAAQ;GAAM,GAAG;EAAU;CAC5C;CACA,QACE,GACA,GACiD;EACjD,OAAO;GAAE,MAAM;GAAW,IAAI,EAAwB,MAAM,CAAE;GAAG;EAAM;CACzE;CACA,OACE,GACA,GACA,IAAuD,CAAC,GACX;EAC7C,OAAO;GAAE,MAAM;GAAU,IAAI,EAAwB,MAAM,CAAE;GAAG;GAAO,GAAG;EAAQ;CACpF;CACA,UAAgC;EAC9B,OAAO,EAAE,MAAM,UAAU;CAC3B;AACF,GC3Ca,IAA4B;AAkBzC,SAAS,EAAc,GAAkD;CACvE,OAAO,MAAM,QAAQ,CAAK,KAAK,EAAM,OAAM,MAAQ,OAAO,KAAS,QAAQ;AAC7E;AAEA,SAAgB,EAAiB,GAAyC;CACxE,IAAI,OAAO,KAAU,aAAY,GAAgB,OAAO,CAAC;CACzD,IAAM,IAAS,EAAkC;CACjD,OAAO,EAAc,CAAK,IAAI,CAAC,GAAG,CAAK,IAAI,CAAC;AAC9C;AAEA,SAAgB,EAAiB,GAAgB,GAAkE;CACjH,IAAM,IAAY,OAAO,KAAU,YAAY,IAAiB,EAAE,GAAI,EAAkC,IAAI,CAAC;CAG7G,OAFI,EAAM,WAAW,IAAG,OAAO,EAAU,KACpC,EAAU,KAA6B,CAAC,GAAG,CAAK,GAC9C;AACT;AAEA,SAAgB,EACd,GACA,GACQ;CACR,IAAM,IAAM,KAAK,IAAI,EAAK,QAAQ,EAAM,MAAM,GAC1C,IAAQ;CACZ,OAAO,IAAQ,KAAO,EAAK,OAAW,EAAM,KAAQ,KAAS;CAC7D,OAAO;AACT;AAEA,SAAgB,EAA4B,GAAyD;CACnG,IAAM,EAAE,YAAS,WAAQ,mBAAgB,mBAAgB,oBAAiB,kBAAe;CACzF,IAAI,KAAmB,GAAY,OAAO,EAAE,MAAM,OAAO;CAEzD,IAAI,KAAmB,MAAmB,OAAO;EAC/C,IAAM,IAAkB,CAAC,GAAG,CAAc,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAK,MAAM,CAAC,EAAO,SAAS,CAAE,KAAK,EAAQ,SAAS,CAAE,CAAC;EAC7G,IAAI,MAAoB,KAAA,GAAW,OAAO;GAAE,MAAM;GAAgB,IAAI;EAAgB;CACxF;CAEA,IAAM,IAAe,EAA6B,GAAS,CAAM;CAGjE,OAFI,EAAO,SAAS,IAAqB,EAAE,MAAM,UAAU,IACvD,EAAQ,SAAS,IAAqB;EAAE,MAAM;EAAQ,OAAO,CAAC,GAAG,GAAQ,EAAQ,EAAa;CAAE,IAC7F,EAAE,MAAM,OAAO;AACxB;AAUA,SAAgB,IAAuD;CACrE,IAAI,IAA0C,CAAC,GACzC,oBAAY,IAAI,IAAgB,GAChC,UAAgB,EAAU,SAAQ,MAAY,EAAS,CAAC;CAE9D,OAAO;EACL,SAAS,GAAO;GAMd,OAJA,IADe,EAAQ,MAAK,MAAa,EAAU,OAAO,EAAM,EACtD,IACN,EAAQ,KAAI,MAAc,EAAU,OAAO,EAAM,KAAK,IAAQ,CAAU,IACxE,CAAC,GAAG,GAAS,CAAK,GACtB,EAAQ,SACK,KAAK,WAAW,EAAM,EAAE;EACvC;EACA,WAAW,GAAI;GACR,EAAQ,MAAK,MAAS,EAAM,OAAO,CAAE,MAC1C,IAAU,EAAQ,QAAO,MAAS,EAAM,OAAO,CAAE,GACjD,EAAQ;EACV;EACA,cAAc;GACZ,OAAO;EACT;EACA,UAAU,GAAU;GAElB,OADA,EAAU,IAAI,CAAQ,SACT,EAAU,OAAO,CAAQ;EACxC;EACA,QAAQ;GACF,EAAQ,WAAW,MACvB,IAAU,CAAC,GACX,EAAQ;EACV;CACF;AACF;;;AClGA,SAAgB,EAAmB,GAAsB;CACvD,OAAO,EAAK,QAAQ,eAAe,EAAE;AACvC;AAEA,SAAgB,EAAiB,GAAoB,GAA2B;CAC9E,IAAM,IAAS,EAAmB,CAAU,GACtC,IAAQ,EAAmB,CAAS;CAG1C,OADI,CAAC,KAAU,CAAC,IAAc,MACvB,IAAI,CAAC,GAAQ,CAAK,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC,KAAK,GAAG;AACrD;AAEA,SAAgB,EAA2B,GAA2B;CACpE,OAAO,MAAM,KAAK,EAAQ,SAAS,qBAAqB,CAAC,CAAC,CACvD,QAAO,MAAS,EAAM,OAAO,EAAE,CAAC,CAChC,KAAI,MAAS,EAAM,EAAE;AAC1B;AAEA,SAAS,EAAiB,GAAwB,GAAkC;CAClF,IAAM,IAAO,OAAO,CAAK;CACzB,OAAO,IAAkB,EAAK,MAAM,GAAG,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,KAAK,GAAG,IAAI,mBAAmB,CAAI;AACtG;AAEA,SAAgB,EAAkB,GAAiB,IAA2B,CAAC,GAAW;CAgBxF,OAfiB,EAAQ,MAAM,GACb,CAAA,CAAS,SAAQ,MAAW;EAC5C,IAAM,IAAQ,EAAQ,MAAM,qBAAqB;EACjD,IAAI,CAAC,GAAO,OAAO,CAAC,CAAO;EAE3B,IAAM,GAAG,GAAM,KAAY,GACrB,IAAQ,EAAO;EACrB,IAAI,KAAS,MAAM;GACjB,IAAI,MAAa,OAAO,MAAa,KAAK,OAAO,CAAC;GAClD,MAAU,MAAM,qCAAqC,EAAK,iBAAiB,EAAQ,GAAG;EACxF;EAEA,OAAO,CAAC,EAAiB,GAAO,MAAa,GAAG,CAAC;CACnD,CAEO,CAAA,CAAU,KAAK,GAAG,KAAK;AAChC;;;AC5BA,IAAa,IAAsB,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,6BAA6B,GAC5E,IAAuB,EACjC,OAAO,CAAC,CACR,QAAO,MAAQ,CAAC,EAAK,WAAW,GAAG,GAAG,6DAA6D,CAAC,CACpG,QAAO,MAAQ,CAAC,EAAK,SAAS,IAAI,GAAG,4CAA4C;AAwBpF,SAAS,EACP,GACA,GACyB;CACzB,OAAO,OAAO,YACZ,OAAO,QAAQ,CAAW,CAAC,CAAC,KAAK,CAAC,GAAK,OAAgB;EACrD,IAAM,IAAY,EAAoB,MAAM,CAAG;EAE/C,OADA,EAAqB,MAAM,EAAW,SAAS,GACxC,CAAC,GAAK,OAAO,OAAO;GAAE,GAAG;GAAY;GAAM,KAAK;EAAU,CAAC,CAAC;CACrE,CAAC,CACH;AACF;AAEA,SAAgB,EAQd,GACgD;CAChD,OAAO,EAAY,GAAO,MAAM;AAClC;AAEA,SAAgB,EAQd,GACsD;CACtD,OAAO,EAAY,GAAU,SAAS;AACxC;AAEA,SAAS,EAAa,GAA6C;CACjE,OAAO,UAAU;AACnB;AAEA,SAAgB,EACd,GACuB;CACvB,IAAM,oBAAe,IAAI,IAAoB,GACvC,oBAAc,IAAI,IAAgC,GAClD,oBAAa,IAAI,IAAoB,GACrC,IAA4E,CAAC;CAEnF,SAAS,EAAM,GAAsC,GAAuB,GAA0B;EACpG,EAAM,SAAQ,MAAY;GACxB,IAAM,IAAuB,EAAa,CAAQ,IAAI,IAAW,EAAS;GAI1E,IAHA,EAAoB,MAAM,EAAK,GAAG,GAClC,EAAqB,MAAM,EAAK,SAAS,GAErC,EAAY,IAAI,EAAK,GAAG,GAAG,MAAU,MAAM,cAAc,EAAK,IAAI,6BAA6B;GACnG,IAAM,IAAc,EAAiB,GAAe,EAAK,SAAS,GAC5D,IAAoB,EAAW,IAAI,CAAW;GACpD,IAAI,GACF,MAAU,MAAM,kBAAkB,EAAY,kBAAkB,EAAkB,SAAS,EAAK,IAAI,GAAG;GAGzG,IAAM,IAA4B;IAAE,KAAK,EAAK;IAAK,MAAM,EAAK;IAAM;IAAa;IAAW;GAAK;GAKjG,AAJA,EAAY,IAAI,EAAK,KAAK,CAAK,GAC/B,EAAW,IAAI,GAAa,EAAK,GAAG,GAChC,EAAK,SAAS,UAAQ,EAAa,IAAI,EAAK,KAAK,CAAW,GAE3D,EAAa,CAAQ,MACpB,EAAS,cAAY,EAAiB,KAAK;IAAE;IAAO,QAAQ,EAAS;GAAW,CAAC,GACjF,EAAS,YAAU,EAAM,EAAS,UAAU,GAAa,EAAK,GAAG;EAEzE,CAAC;CACH;CAGA,AADA,EAAM,GAAM,EAAE,GACd,EAAiB,SAAS,EAAE,UAAO,gBAAa;EAC9C,IAAM,IAAgB,EAAa,IAAI,EAAO,GAAG;EACjD,IAAI,CAAC,GAAe,MAAU,MAAM,oBAAoB,EAAO,IAAI,iCAAiC;EACpG,EAAM,oBAAoB;CAC5B,CAAC;CAED,IAAM,IAAiC;EACrC,QAAQ,OAAO,OAAO,CAAC,GAAG,EAAY,OAAO,CAAC,CAAC;EAC/C,QAAQ,GAAM,GAAG,GAAM;GAErB,OAAO,EADS,EAAQ,eAAe,CACd,GAAS,EAAK,EAAE;EAC3C;EACA,eAAe,GAAM;GACnB,IAAM,IAAU,EAAa,IAAI,EAAK,GAAG;GACzC,IAAI,CAAC,GAAS,MAAU,MAAM,SAAS,EAAK,IAAI,iCAAiC;GACjF,OAAO;EACT;EACA,SAAS,GAAK;GACZ,OAAO,EAAY,IAAI,CAAG;EAC5B;CACF;CAEA,OAAO;AACT"}

package/dist/navigation/authRedirect.d.ts

@@ -0,0 +1,11 @@
+export type ShellLocationSnapshot = {
+    pathname: string;
+    search?: string;
+    hash?: string;
+};
+export type ShellAuthRedirectState = {
+    from: string;
+};
+export declare function isSafeInternalPath(path: string): boolean;
+export declare function createAuthRedirectState(location: ShellLocationSnapshot, loginPath: string): ShellAuthRedirectState | undefined;
+export declare function resolvePostLoginPath(state: unknown, fallbackPath: string): string;

package/dist/navigation/shellNavigation.d.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+import { ShellLabel, ShellPage, ShellPermission, ShellPermissionScope } from '../sitemap/shellSitemap.types';
+export declare const ShellNavigationIdSchema: z.ZodString;
+export type ShellNavigationEntry<TPermission extends ShellPermission = ShellPermission, TContext = unknown> = {
+    type: "item";
+    page: ShellPage<string, string, TPermission, TContext>;
+    label?: ShellLabel<TContext>;
+    icon?: string;
+    disabled?: boolean;
+    disabledReason?: ShellLabel<TContext>;
+    permission?: TPermission;
+    permissionScope?: ShellPermissionScope;
+} | {
+    type: "heading";
+    id: string;
+    label: ShellLabel<TContext>;
+} | {
+    type: "action";
+    id: string;
+    label: ShellLabel<TContext>;
+    icon?: string;
+    permission?: TPermission;
+} | {
+    type: "divider";
+};
+export declare const shellNavigation: {
+    item<TPermission extends ShellPermission = string, TContext = unknown>(page: ShellPage<string, string, TPermission, TContext>, overrides?: Omit<ShellNavigationEntry<TPermission, TContext> & {
+        type: "item";
+    }, "page" | "type">): ShellNavigationEntry<TPermission, TContext>;
+    heading<TContext = unknown>(id: string, label: ShellLabel<TContext>): ShellNavigationEntry<ShellPermission, TContext>;
+    action<TPermission extends ShellPermission = string, TContext = unknown>(id: string, label: ShellLabel<TContext>, options?: {
+        icon?: string;
+        permission?: TPermission;
+    }): ShellNavigationEntry<TPermission, TContext>;
+    divider(): ShellNavigationEntry;
+};

package/dist/overlay-history/overlayHistory.d.ts

@@ -0,0 +1,37 @@
+export declare const OVERLAY_HISTORY_STATE_KEY = "__starterShellOverlayStack";
+export type OverlayHistoryEntryId = string;
+export type OverlayHistoryEntry = {
+    id: OverlayHistoryEntryId;
+    requestClose: () => void;
+};
+export type OverlayHistoryAction = {
+    type: "idle";
+} | {
+    type: "push";
+    stack: readonly OverlayHistoryEntryId[];
+} | {
+    type: "consume";
+} | {
+    type: "requestClose";
+    id: OverlayHistoryEntryId;
+};
+export type OverlayHistoryResolveInput = {
+    desired: readonly OverlayHistoryEntryId[];
+    actual: readonly OverlayHistoryEntryId[];
+    previousActual: readonly OverlayHistoryEntryId[];
+    navigationType: "POP" | "PUSH" | "REPLACE";
+    locationChanged: boolean;
+    urlChanged: boolean;
+};
+export declare function readOverlayStack(state: unknown): OverlayHistoryEntryId[];
+export declare function withOverlayStack(state: unknown, stack: readonly OverlayHistoryEntryId[]): Record<string, unknown>;
+export declare function getCommonOverlayPrefixLength(left: readonly OverlayHistoryEntryId[], right: readonly OverlayHistoryEntryId[]): number;
+export declare function resolveOverlayHistoryAction(input: OverlayHistoryResolveInput): OverlayHistoryAction;
+export type OverlayHistoryRegistry = {
+    register(entry: OverlayHistoryEntry): () => void;
+    unregister(id: OverlayHistoryEntryId): void;
+    getSnapshot(): readonly OverlayHistoryEntry[];
+    subscribe(listener: () => void): () => void;
+    clear(): void;
+};
+export declare function createOverlayHistoryRegistry(): OverlayHistoryRegistry;

package/dist/sitemap/routePath.d.ts

@@ -0,0 +1,5 @@
+import { ShellRouteParams } from './shellSitemap.types';
+export declare function normalizeRoutePath(path: string): string;
+export declare function joinRoutePattern(parentPath: string, routePath: string): string;
+export declare function getRequiredRouteParamNames(pattern: string): string[];
+export declare function generateShellPath(pattern: string, params?: ShellRouteParams): string;

package/dist/sitemap/shellSitemap.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { ShellPage, ShellPageDefinition, ShellPermission, ShellRouteTreeNode, ShellSection, ShellSectionDefinition, ShellSitemap } from './shellSitemap.types';
+export declare const ShellRouteKeySchema: z.ZodString;
+export declare const ShellRoutePathSchema: z.ZodString;
+type StrictConfig<TConfig, TShape> = TConfig & Record<Exclude<keyof TConfig, keyof TShape>, never>;
+type StrictConfigRecord<TRecord, TShape> = {
+    readonly [K in keyof TRecord]: StrictConfig<TRecord[K], TShape>;
+};
+type ShellPageRecord<TPages extends Record<string, ShellPageDefinition<TPermission, TContext>>, TPermission extends ShellPermission, TContext> = {
+    readonly [K in keyof TPages]: ShellPage<K & string, TPages[K]["routePath"], TPermission, TContext> & TPages[K];
+};
+type ShellSectionRecord<TSections extends Record<string, ShellSectionDefinition<TPermission, TContext>>, TPermission extends ShellPermission, TContext> = {
+    readonly [K in keyof TSections]: ShellSection<K & string, TSections[K]["routePath"], TPermission, TContext> & TSections[K];
+};
+export declare function defineShellPages<TPermission extends ShellPermission = ShellPermission, TContext = unknown, const TPages extends Record<string, ShellPageDefinition<TPermission, TContext>> = Record<string, ShellPageDefinition<TPermission, TContext>>>(pages: StrictConfigRecord<TPages, ShellPageDefinition<TPermission, TContext>>): ShellPageRecord<TPages, TPermission, TContext>;
+export declare function defineShellSections<TPermission extends ShellPermission = ShellPermission, TContext = unknown, const TSections extends Record<string, ShellSectionDefinition<TPermission, TContext>> = Record<string, ShellSectionDefinition<TPermission, TContext>>>(sections: StrictConfigRecord<TSections, ShellSectionDefinition<TPermission, TContext>>): ShellSectionRecord<TSections, TPermission, TContext>;
+export declare function createShellSitemap<const TRoutes extends readonly ShellRouteTreeNode[]>(tree: TRoutes): ShellSitemap<TRoutes>;
+export {};

package/dist/sitemap/shellSitemap.types.d.ts

@@ -0,0 +1,80 @@
+export type ShellRouteParamValue = string | number;
+export type ShellRouteParams = Readonly<Record<string, ShellRouteParamValue | undefined>>;
+export type ShellPermission = string;
+export type ShellPermissionScope = Readonly<Record<string, unknown>>;
+export type ShellRouteMetadata = Readonly<Record<string, unknown>>;
+export type ShellLabel<TContext = unknown> = string | ((context: TContext, params: ShellRouteParams) => string);
+export type ShellPageDefinition<TPermission extends ShellPermission = ShellPermission, TContext = unknown, TRoutePath extends string = string> = {
+    routePath: TRoutePath;
+    label: ShellLabel<TContext>;
+    icon?: string;
+    permission?: TPermission;
+    permissionScope?: ShellPermissionScope;
+    metadata?: ShellRouteMetadata;
+};
+export type ShellSectionDefinition<TPermission extends ShellPermission = ShellPermission, TContext = unknown, TRoutePath extends string = string> = Omit<ShellPageDefinition<TPermission, TContext, TRoutePath>, "icon"> & {
+    icon?: string;
+};
+export type ShellPage<TKey extends string = string, TRoutePath extends string = string, TPermission extends ShellPermission = ShellPermission, TContext = unknown> = ShellPageDefinition<TPermission, TContext, TRoutePath> & {
+    readonly kind: "page";
+    readonly key: TKey;
+};
+export type ShellSection<TKey extends string = string, TRoutePath extends string = string, TPermission extends ShellPermission = ShellPermission, TContext = unknown> = ShellSectionDefinition<TPermission, TContext, TRoutePath> & {
+    readonly kind: "section";
+    readonly key: TKey;
+};
+export type ShellRouteNode<TPermission extends ShellPermission = ShellPermission, TContext = unknown> = ShellPage<string, string, TPermission, TContext> | ShellSection<string, string, TPermission, TContext>;
+export type ShellRouteTreeNode<TPermission extends ShellPermission = ShellPermission, TContext = unknown> = ShellPage<string, string, TPermission, TContext> | {
+    node: ShellRouteNode<TPermission, TContext>;
+    redirectTo?: ShellPage<string, string, TPermission, TContext>;
+    children?: readonly ShellRouteTreeNode<TPermission, TContext>[];
+};
+export type ResolvedShellRoute<TPermission extends ShellPermission = ShellPermission, TContext = unknown> = {
+    key: string;
+    kind: "page" | "section";
+    pathPattern: string;
+    parentKey?: string;
+    redirectToPattern?: string;
+    node: ShellRouteNode<TPermission, TContext>;
+};
+type NormalizePath<TPath extends string> = TPath extends `/${infer Rest}` ? NormalizePath<Rest> : TPath extends `${infer Rest}/` ? NormalizePath<Rest> : TPath;
+type JoinRoutePath<TParent extends string, TChild extends string> = NormalizePath<TParent> extends "" ? NormalizePath<TChild> extends "" ? "/" : `/${NormalizePath<TChild>}` : NormalizePath<TChild> extends "" ? `/${NormalizePath<TParent>}` : `/${NormalizePath<TParent>}/${NormalizePath<TChild>}`;
+type RouteNodePath<TNode> = TNode extends {
+    routePath: infer TRoutePath extends string;
+} ? TRoutePath : never;
+type PreviousDepth = [never, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
+type RouteNodePageEntry<TNode, TParentPath extends string, TDepth extends number> = [TDepth] extends [never] ? never : TNode extends ShellPage ? {
+    page: TNode;
+    path: JoinRoutePath<TParentPath, RouteNodePath<TNode>>;
+} : TNode extends {
+    node: infer TConfig;
+    children?: infer TChildren;
+} ? TConfig extends ShellRouteNode ? TConfig extends ShellPage ? {
+    page: TConfig;
+    path: JoinRoutePath<TParentPath, RouteNodePath<TConfig>>;
+} | ShellRouteTreePageEntries<Extract<TChildren, readonly ShellRouteTreeNode[]>, JoinRoutePath<TParentPath, RouteNodePath<TConfig>>, PreviousDepth[TDepth]> : ShellRouteTreePageEntries<Extract<TChildren, readonly ShellRouteTreeNode[]>, JoinRoutePath<TParentPath, RouteNodePath<TConfig>>, PreviousDepth[TDepth]> : never : never;
+export type ShellRouteTreePageEntries<TNodes, TParentPath extends string = "", TDepth extends number = 8> = [
+    TDepth
+] extends [never] ? never : TNodes extends readonly unknown[] ? RouteNodePageEntry<TNodes[number], TParentPath, TDepth> : never;
+export type ShellPathForPage<TNodes extends readonly ShellRouteTreeNode[], TPage extends ShellPage> = Extract<ShellRouteTreePageEntries<TNodes>, {
+    page: TPage;
+}> extends {
+    path: infer TPath extends string;
+} ? TPath : never;
+type StripParamSuffix<TParam extends string> = TParam extends `${infer TName}?` ? TName : TParam extends `${infer TName}*` ? TName : TParam;
+type ExtractRouteTokens<TPath extends string> = TPath extends `${string}:${infer TParam}/${infer TRest}` ? TParam | ExtractRouteTokens<TRest> : TPath extends `${string}:${infer TParam}` ? TParam : never;
+type OptionalRouteParamNames<TPath extends string> = ExtractRouteTokens<TPath> extends infer TToken extends string ? TToken extends `${string}?` | `${string}*` ? StripParamSuffix<TToken> : never : never;
+type RequiredRouteParamNames<TPath extends string> = Exclude<StripParamSuffix<ExtractRouteTokens<TPath>>, OptionalRouteParamNames<TPath>>;
+type RoutePathParams<TPath extends string> = {
+    [K in RequiredRouteParamNames<TPath>]: ShellRouteParamValue;
+} & {
+    [K in OptionalRouteParamNames<TPath>]?: ShellRouteParamValue;
+};
+type RoutePathParamArgs<TPath extends string> = [ExtractRouteTokens<TPath>] extends [never] ? [] : [params: RoutePathParams<TPath>];
+export type ShellSitemap<TRoutes extends readonly ShellRouteTreeNode[] = readonly ShellRouteTreeNode[]> = {
+    readonly routes: readonly ResolvedShellRoute[];
+    getPath<TPage extends ShellRouteTreePageEntries<TRoutes>["page"]>(page: TPage, ...args: RoutePathParamArgs<ShellPathForPage<TRoutes, TPage>>): string;
+    getPathPattern<TPage extends ShellRouteTreePageEntries<TRoutes>["page"]>(page: TPage): ShellPathForPage<TRoutes, TPage>;
+    getRoute(key: string): ResolvedShellRoute | undefined;
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vireocodedev/shell",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Framework-free contracts for application sitemap construction, navigation metadata, auth redirects, and overlay history.",
   "type": "module",
   "sideEffects": false,