@withpotter/lib 0.13.0-next.101

package/dist/use-money-visibility.js

@@ -0,0 +1,13 @@
+"use client";
+import { usePermissions } from "./use-permissions";
+import {
+  resolveMoneyVisibility
+} from "./money-visibility";
+function useMoneyVisibility() {
+  const { can, loading } = usePermissions();
+  return { ...resolveMoneyVisibility(can), loading };
+}
+export {
+  useMoneyVisibility
+};
+//# sourceMappingURL=use-money-visibility.js.map

package/dist/use-money-visibility.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/use-money-visibility.ts"],"sourcesContent":["'use client';\n\nimport { usePermissions } from './use-permissions';\nimport {\n  resolveMoneyVisibility,\n  type MoneyVisibility,\n} from './money-visibility';\n\n/**\n * Whether this person is allowed to see money.\n *\n * Every currency figure in the dashboard asks this rather than calling\n * `can('canViewFinance')` directly, and that indirection is what let the\n * amounts/earnings split land in one file instead of a sweep across every\n * screen that renders a naira sign. See `money-visibility.ts` for where the\n * line falls and why.\n */\nexport function useMoneyVisibility(): MoneyVisibility & { loading: boolean } {\n  const { can, loading } = usePermissions();\n  return { ...resolveMoneyVisibility(can), loading };\n}\n\nexport type { MoneyVisibility };\n"],"mappings":";AAEA,SAAS,sBAAsB;AAC/B;AAAA,EACE;AAAA,OAEK;AAWA,SAAS,qBAA6D;AAC3E,QAAM,EAAE,KAAK,QAAQ,IAAI,eAAe;AACxC,SAAO,EAAE,GAAG,uBAAuB,GAAG,GAAG,QAAQ;AACnD;","names":[]}

package/dist/use-nav-groups.d.ts

@@ -0,0 +1,27 @@
+import { type NavGroup } from '@withpotter/components/sidebar/config';
+import type { RouteRule } from '@withpotter/lib/route-permission';
+export declare function useNavGroups(): NavGroup[];
+/**
+ * Every destination this business has, with the grant each one asks for —
+ * before anybody's permissions are applied to it.
+ *
+ * `useNavGroups` returns what THIS person may see, which cannot answer "may
+ * this person be here": a row missing from their nav is missing for four
+ * different reasons, and only one of them is permission. Built from the same
+ * table with the filter switched off, so the sidebar and the page gate can
+ * never drift into disagreeing about which grant a screen needs.
+ */
+export declare function useAllNavRoutes(): RouteRule[];
+/**
+ * What the nav calls the row that owns this route.
+ *
+ * `resolveScreenTitle` answers this for the archetype rows, and answers nothing
+ * for the rest — Analytics, Payments, Templates, Help and the settings tree are
+ * platform rows that live in the spine rather than in an intent's nav. Those
+ * are most of the 94 screens that sit on no page frame, so without this they
+ * reach the tab with no name of their own.
+ *
+ * Deepest href wins, so /dashboard/settings/team is Team rather than the
+ * Settings row above it.
+ */
+export declare function useNavScreenName(): string | undefined;

package/dist/use-nav-groups.js

@@ -0,0 +1,141 @@
+"use client";
+import { useMemo } from "react";
+import { usePathname } from "@withpotter/lib/use-pathname";
+import { effectiveModuleLabels } from "./effective-module-labels";
+import { useAuth } from "@withpotter/lib/auth-context";
+import { useCurrentTemplate } from "@withpotter/lib/template-context";
+import { usePlatformModules } from "@withpotter/lib/use-platform-modules";
+import { useIntentConfig } from "@withpotter/lib/intents/use-intent-config";
+import { usePermissions } from "@withpotter/lib/use-permissions";
+import { resolveEnabledBehaviors } from "@withpotter/lib/resolve-enabled-behaviors";
+import { isSalesChannel } from "@withpotter/hooks/use-sales-channel";
+import { buildNavGroups } from "@withpotter/components/sidebar/build-nav-groups";
+import {
+  ACCOUNT_GROUPS,
+  BUSINESS_GROUPS
+} from "@withpotter/components/sidebar/config";
+import { businessItems, customizationItems } from "@withpotter/lib/navigation-groups";
+function useNavDeps() {
+  const { tenant } = useAuth();
+  const { template, dashboardState } = useCurrentTemplate(tenant?.templateId);
+  const settings = tenant?.settings;
+  const moduleLabels = effectiveModuleLabels(settings);
+  const hiddenModules = settings?.hiddenModules;
+  const salesChannel = isSalesChannel(settings?.salesChannel) ? settings.salesChannel : null;
+  const enabledBehaviors = useMemo(
+    () => resolveEnabledBehaviors(settings, template),
+    [settings, template]
+  );
+  const { coreNavigation } = usePlatformModules({
+    template,
+    dashboardState,
+    enabledBehaviors,
+    hiddenModules,
+    moduleLabels,
+    moduleOrder: settings?.moduleOrder
+  });
+  const intentConfig = useIntentConfig();
+  return useMemo(
+    () => ({
+      hiddenModules,
+      moduleLabels,
+      enabledBehaviors,
+      inPersonOnly: salesChannel === "in_person",
+      intentConfig,
+      coreNavigation,
+      template
+    }),
+    [
+      hiddenModules,
+      moduleLabels,
+      enabledBehaviors,
+      salesChannel,
+      intentConfig,
+      coreNavigation,
+      template
+    ]
+  );
+}
+function useNavGroups() {
+  const deps = useNavDeps();
+  const { can, isOwner, loading: permissionsLoading } = usePermissions();
+  return useMemo(
+    () => buildNavGroups({ ...deps, isOwner, can, permissionsLoading }),
+    [deps, isOwner, can, permissionsLoading]
+  );
+}
+function useAllNavRoutes() {
+  const deps = useNavDeps();
+  return useMemo(() => {
+    const groups = buildNavGroups({
+      ...deps,
+      isOwner: true,
+      can: () => true,
+      permissionsLoading: false
+    });
+    const rules = [];
+    const walk = (items) => {
+      for (const item of items) {
+        if (item.href) {
+          rules.push({
+            href: item.href,
+            requiredPermission: item.requiredPermission
+          });
+        }
+        if (item.children?.length) walk(item.children);
+      }
+    };
+    for (const group of groups) {
+      if (group.href) {
+        rules.push({
+          href: group.href,
+          requiredPermission: group.requiredPermission
+        });
+      }
+      for (const section of group.sections ?? []) walk(section.items);
+      walk(group.items ?? []);
+    }
+    return rules;
+  }, [deps]);
+}
+function useNavScreenName() {
+  const groups = useNavGroups();
+  const pathname = usePathname();
+  return useMemo(() => {
+    const path = (pathname ?? "").replace(/\/+$/, "");
+    let best;
+    const consider = (name, href) => {
+      if (!name || !href) return;
+      const target = href.split("?")[0].replace(/\/+$/, "");
+      if (path !== target && !path.startsWith(`${target}/`)) return;
+      if (!best || target.length > best.depth) {
+        best = { name, depth: target.length };
+      }
+    };
+    const walk = (items) => items?.forEach((item) => {
+      consider(item.name, item.href);
+      walk(item.children);
+    });
+    groups.forEach((group) => {
+      consider(group.label, group.href);
+      walk(group.items);
+      group.sections?.forEach((section) => walk(section.items));
+    });
+    [...ACCOUNT_GROUPS, ...BUSINESS_GROUPS].forEach(
+      (group) => group.items.forEach((item) => {
+        consider(item.name, item.href);
+        item.match?.forEach((href) => consider(item.name, href));
+      })
+    );
+    [...customizationItems, ...businessItems].forEach(
+      (item) => consider(item.name, item.href)
+    );
+    return best?.name;
+  }, [groups, pathname]);
+}
+export {
+  useAllNavRoutes,
+  useNavGroups,
+  useNavScreenName
+};
+//# sourceMappingURL=use-nav-groups.js.map

package/dist/use-nav-groups.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/use-nav-groups.ts"],"sourcesContent":["'use client';\n\nimport { useMemo } from 'react';\nimport { usePathname } from '@withpotter/lib/use-pathname';\nimport { effectiveModuleLabels } from './effective-module-labels';\nimport { useAuth } from '@withpotter/lib/auth-context';\nimport { useCurrentTemplate } from '@withpotter/lib/template-context';\nimport { usePlatformModules } from '@withpotter/lib/use-platform-modules';\nimport { useIntentConfig } from '@withpotter/lib/intents/use-intent-config';\nimport { usePermissions } from '@withpotter/lib/use-permissions';\nimport { resolveEnabledBehaviors } from '@withpotter/lib/resolve-enabled-behaviors';\nimport { isSalesChannel } from '@withpotter/hooks/use-sales-channel';\nimport { buildNavGroups } from '@withpotter/components/sidebar/build-nav-groups';\nimport {\n  ACCOUNT_GROUPS,\n  BUSINESS_GROUPS,\n  type NavGroup,\n  type NavItem,\n} from '@withpotter/components/sidebar/config';\nimport type { RouteRule } from '@withpotter/lib/route-permission';\nimport { businessItems, customizationItems } from '@withpotter/lib/navigation-groups';\n\n/**\n * The sidebar's own groups, for callers that need to know what the nav shows\n * without being the sidebar.\n *\n * The deps this builder wants are a fixed dozen, and assembling them was\n * already copied out once into the editor's jump targets. This is that\n * assembly, named — permissions, hidden modules, archetype collapsing and the\n * merchant's own module labels all arrive already applied, because they are\n * applied inside `buildNavGroups`.\n *\n * Calls `useIntentConfig`, which calls `useSearchParams`. A caller in a layout\n * needs a Suspense boundary above it or the whole route bails out of rendering.\n */\nfunction useNavDeps() {\n  const { tenant } = useAuth();\n  const { template, dashboardState } = useCurrentTemplate(tenant?.templateId);\n\n  const settings = tenant?.settings as Record<string, unknown> | undefined;\n  const moduleLabels = effectiveModuleLabels(settings);\n  const hiddenModules = settings?.hiddenModules as string[] | undefined;\n  const salesChannel = isSalesChannel(settings?.salesChannel)\n    ? settings.salesChannel\n    : null;\n\n  // Resolved first: the core list gates its modules on these, and the raw\n  // stored field knows nothing of the merchant's own switches.\n  const enabledBehaviors = useMemo(\n    () => resolveEnabledBehaviors(settings, template),\n    [settings, template],\n  );\n\n  const { coreNavigation } = usePlatformModules({\n    template,\n    dashboardState,\n    enabledBehaviors,\n    hiddenModules,\n    moduleLabels,\n    moduleOrder: settings?.moduleOrder as string[] | undefined,\n  });\n\n  const intentConfig = useIntentConfig();\n\n  return useMemo(\n    () => ({\n      hiddenModules,\n      moduleLabels,\n      enabledBehaviors,\n      inPersonOnly: salesChannel === 'in_person',\n      intentConfig,\n      coreNavigation,\n      template,\n    }),\n    [\n      hiddenModules,\n      moduleLabels,\n      enabledBehaviors,\n      salesChannel,\n      intentConfig,\n      coreNavigation,\n      template,\n    ],\n  );\n}\n\nexport function useNavGroups(): NavGroup[] {\n  const deps = useNavDeps();\n  const { can, isOwner, loading: permissionsLoading } = usePermissions();\n\n  return useMemo(\n    () => buildNavGroups({ ...deps, isOwner, can, permissionsLoading }),\n    [deps, isOwner, can, permissionsLoading],\n  );\n}\n\n/**\n * Every destination this business has, with the grant each one asks for —\n * before anybody's permissions are applied to it.\n *\n * `useNavGroups` returns what THIS person may see, which cannot answer \"may\n * this person be here\": a row missing from their nav is missing for four\n * different reasons, and only one of them is permission. Built from the same\n * table with the filter switched off, so the sidebar and the page gate can\n * never drift into disagreeing about which grant a screen needs.\n */\nexport function useAllNavRoutes(): RouteRule[] {\n  const deps = useNavDeps();\n\n  return useMemo(() => {\n    const groups = buildNavGroups({\n      ...deps,\n      isOwner: true,\n      can: () => true,\n      permissionsLoading: false,\n    });\n\n    const rules: RouteRule[] = [];\n    const walk = (items: NavItem[]) => {\n      for (const item of items) {\n        if (item.href) {\n          rules.push({\n            href: item.href,\n            requiredPermission: item.requiredPermission,\n          });\n        }\n        if (item.children?.length) walk(item.children);\n      }\n    };\n\n    for (const group of groups) {\n      if (group.href) {\n        rules.push({\n          href: group.href,\n          requiredPermission: group.requiredPermission,\n        });\n      }\n      for (const section of group.sections ?? []) walk(section.items);\n      walk(group.items ?? []);\n    }\n    return rules;\n  }, [deps]);\n}\n\n/**\n * What the nav calls the row that owns this route.\n *\n * `resolveScreenTitle` answers this for the archetype rows, and answers nothing\n * for the rest — Analytics, Payments, Templates, Help and the settings tree are\n * platform rows that live in the spine rather than in an intent's nav. Those\n * are most of the 94 screens that sit on no page frame, so without this they\n * reach the tab with no name of their own.\n *\n * Deepest href wins, so /dashboard/settings/team is Team rather than the\n * Settings row above it.\n */\nexport function useNavScreenName(): string | undefined {\n  const groups = useNavGroups();\n  const pathname = usePathname();\n\n  return useMemo(() => {\n    const path = (pathname ?? '').replace(/\\/+$/, '');\n    let best: { name: string; depth: number } | undefined;\n\n    const consider = (name: string | undefined, href: string | undefined) => {\n      if (!name || !href) return;\n      const target = href.split('?')[0].replace(/\\/+$/, '');\n      if (path !== target && !path.startsWith(`${target}/`)) return;\n      if (!best || target.length > best.depth) {\n        best = { name, depth: target.length };\n      }\n    };\n\n    const walk = (items: NavItem[] | undefined) =>\n      items?.forEach((item) => {\n        consider(item.name, item.href);\n        walk(item.children);\n      });\n\n    groups.forEach((group) => {\n      consider(group.label, group.href);\n      walk(group.items);\n      group.sections?.forEach((section) => walk(section.items));\n    });\n\n    // The account and settings rail is a third list, and a static one — it\n    // takes no deps and never varies by archetype, which is why it is a plain\n    // constant rather than something the builder assembles. Workspaces, Account\n    // and the settings sections are only reachable through it.\n    [...ACCOUNT_GROUPS, ...BUSINESS_GROUPS].forEach((group) =>\n      group.items.forEach((item) => {\n        consider(item.name, item.href);\n        // A collapsed row can own routes it does not link to — Team & permissions\n        // owns /settings/roles, Shipping owns /settings/service-areas. The rail\n        // already says so in order to keep itself highlighted, and that is the\n        // same question the tab is asking.\n        item.match?.forEach((href) => consider(item.name, href));\n      }),\n    );\n\n    // And a fourth list, the one the Settings and Website hubs are built from.\n    // Several screens are reachable only through a hub tile — the editor,\n    // Templates, SEO, Payouts — so the sidebar never names them and they were\n    // arriving at the tab anonymous. The tile that opens a screen is as good a\n    // name for it as a sidebar row is, and it is already written down.\n    [...customizationItems, ...businessItems].forEach((item) =>\n      consider(item.name, item.href),\n    );\n\n    return best?.name;\n  }, [groups, pathname]);\n}\n"],"mappings":";AAEA,SAAS,eAAe;AACxB,SAAS,mBAAmB;AAC5B,SAAS,6BAA6B;AACtC,SAAS,eAAe;AACxB,SAAS,0BAA0B;AACnC,SAAS,0BAA0B;AACnC,SAAS,uBAAuB;AAChC,SAAS,sBAAsB;AAC/B,SAAS,+BAA+B;AACxC,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAC/B;AAAA,EACE;AAAA,EACA;AAAA,OAGK;AAEP,SAAS,eAAe,0BAA0B;AAelD,SAAS,aAAa;AACpB,QAAM,EAAE,OAAO,IAAI,QAAQ;AAC3B,QAAM,EAAE,UAAU,eAAe,IAAI,mBAAmB,QAAQ,UAAU;AAE1E,QAAM,WAAW,QAAQ;AACzB,QAAM,eAAe,sBAAsB,QAAQ;AACnD,QAAM,gBAAgB,UAAU;AAChC,QAAM,eAAe,eAAe,UAAU,YAAY,IACtD,SAAS,eACT;AAIJ,QAAM,mBAAmB;AAAA,IACvB,MAAM,wBAAwB,UAAU,QAAQ;AAAA,IAChD,CAAC,UAAU,QAAQ;AAAA,EACrB;AAEA,QAAM,EAAE,eAAe,IAAI,mBAAmB;AAAA,IAC5C;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,aAAa,UAAU;AAAA,EACzB,CAAC;AAED,QAAM,eAAe,gBAAgB;AAErC,SAAO;AAAA,IACL,OAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA,cAAc,iBAAiB;AAAA,MAC/B;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;AAEO,SAAS,eAA2B;AACzC,QAAM,OAAO,WAAW;AACxB,QAAM,EAAE,KAAK,SAAS,SAAS,mBAAmB,IAAI,eAAe;AAErE,SAAO;AAAA,IACL,MAAM,eAAe,EAAE,GAAG,MAAM,SAAS,KAAK,mBAAmB,CAAC;AAAA,IAClE,CAAC,MAAM,SAAS,KAAK,kBAAkB;AAAA,EACzC;AACF;AAYO,SAAS,kBAA+B;AAC7C,QAAM,OAAO,WAAW;AAExB,SAAO,QAAQ,MAAM;AACnB,UAAM,SAAS,eAAe;AAAA,MAC5B,GAAG;AAAA,MACH,SAAS;AAAA,MACT,KAAK,MAAM;AAAA,MACX,oBAAoB;AAAA,IACtB,CAAC;AAED,UAAM,QAAqB,CAAC;AAC5B,UAAM,OAAO,CAAC,UAAqB;AACjC,iBAAW,QAAQ,OAAO;AACxB,YAAI,KAAK,MAAM;AACb,gBAAM,KAAK;AAAA,YACT,MAAM,KAAK;AAAA,YACX,oBAAoB,KAAK;AAAA,UAC3B,CAAC;AAAA,QACH;AACA,YAAI,KAAK,UAAU,OAAQ,MAAK,KAAK,QAAQ;AAAA,MAC/C;AAAA,IACF;AAEA,eAAW,SAAS,QAAQ;AAC1B,UAAI,MAAM,MAAM;AACd,cAAM,KAAK;AAAA,UACT,MAAM,MAAM;AAAA,UACZ,oBAAoB,MAAM;AAAA,QAC5B,CAAC;AAAA,MACH;AACA,iBAAW,WAAW,MAAM,YAAY,CAAC,EAAG,MAAK,QAAQ,KAAK;AAC9D,WAAK,MAAM,SAAS,CAAC,CAAC;AAAA,IACxB;AACA,WAAO;AAAA,EACT,GAAG,CAAC,IAAI,CAAC;AACX;AAcO,SAAS,mBAAuC;AACrD,QAAM,SAAS,aAAa;AAC5B,QAAM,WAAW,YAAY;AAE7B,SAAO,QAAQ,MAAM;AACnB,UAAM,QAAQ,YAAY,IAAI,QAAQ,QAAQ,EAAE;AAChD,QAAI;AAEJ,UAAM,WAAW,CAAC,MAA0B,SAA6B;AACvE,UAAI,CAAC,QAAQ,CAAC,KAAM;AACpB,YAAM,SAAS,KAAK,MAAM,GAAG,EAAE,CAAC,EAAE,QAAQ,QAAQ,EAAE;AACpD,UAAI,SAAS,UAAU,CAAC,KAAK,WAAW,GAAG,MAAM,GAAG,EAAG;AACvD,UAAI,CAAC,QAAQ,OAAO,SAAS,KAAK,OAAO;AACvC,eAAO,EAAE,MAAM,OAAO,OAAO,OAAO;AAAA,MACtC;AAAA,IACF;AAEA,UAAM,OAAO,CAAC,UACZ,OAAO,QAAQ,CAAC,SAAS;AACvB,eAAS,KAAK,MAAM,KAAK,IAAI;AAC7B,WAAK,KAAK,QAAQ;AAAA,IACpB,CAAC;AAEH,WAAO,QAAQ,CAAC,UAAU;AACxB,eAAS,MAAM,OAAO,MAAM,IAAI;AAChC,WAAK,MAAM,KAAK;AAChB,YAAM,UAAU,QAAQ,CAAC,YAAY,KAAK,QAAQ,KAAK,CAAC;AAAA,IAC1D,CAAC;AAMD,KAAC,GAAG,gBAAgB,GAAG,eAAe,EAAE;AAAA,MAAQ,CAAC,UAC/C,MAAM,MAAM,QAAQ,CAAC,SAAS;AAC5B,iBAAS,KAAK,MAAM,KAAK,IAAI;AAK7B,aAAK,OAAO,QAAQ,CAAC,SAAS,SAAS,KAAK,MAAM,IAAI,CAAC;AAAA,MACzD,CAAC;AAAA,IACH;AAOA,KAAC,GAAG,oBAAoB,GAAG,aAAa,EAAE;AAAA,MAAQ,CAAC,SACjD,SAAS,KAAK,MAAM,KAAK,IAAI;AAAA,IAC/B;AAEA,WAAO,MAAM;AAAA,EACf,GAAG,CAAC,QAAQ,QAAQ,CAAC;AACvB;","names":[]}

package/dist/use-pathname.d.ts

@@ -0,0 +1,15 @@
+/** The raw cookie string, so useSyncExternalStore compares by value. */
+export declare function readAliasCookie(): string;
+/**
+ * The route a screen REALLY lives at, not the address the merchant sees.
+ *
+ * Screens show up as /dashboard/<their word for it> (see
+ * `lib/destination-alias.ts`), but navigation, permissions, the sidebar's
+ * active row and the page's own title are all keyed on the real route. Use this
+ * wherever the path is READ to decide something.
+ *
+ * Do not use it to build a URL to navigate to: `router.replace(pathname)` with
+ * the real route works (the proxy sends it to the word) but costs a redirect,
+ * so those callers use next/navigation's own hook.
+ */
+export declare function usePathname(): string;

package/dist/use-pathname.js

@@ -0,0 +1,29 @@
+"use client";
+import { useSyncExternalStore } from "react";
+import { usePathname as useNextPathname } from "next/navigation";
+import {
+  DEST_ALIAS_COOKIE,
+  parseAliasMap,
+  toRealPath
+} from "@withpotter/lib/destination-alias";
+function readAliasCookie() {
+  try {
+    const match = document.cookie.split("; ").find((c) => c.startsWith(`${DEST_ALIAS_COOKIE}=`));
+    return match ? match.slice(DEST_ALIAS_COOKIE.length + 1) : "";
+  } catch {
+    return "";
+  }
+}
+const subscribe = () => () => {
+};
+const serverCookie = () => "";
+function usePathname() {
+  const raw = useNextPathname();
+  const cookie = useSyncExternalStore(subscribe, readAliasCookie, serverCookie);
+  return cookie && raw ? toRealPath(raw, parseAliasMap(cookie)) : raw;
+}
+export {
+  readAliasCookie,
+  usePathname
+};
+//# sourceMappingURL=use-pathname.js.map

package/dist/use-pathname.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/use-pathname.ts"],"sourcesContent":["'use client';\n\nimport { useSyncExternalStore } from 'react';\nimport { usePathname as useNextPathname } from 'next/navigation';\nimport {\n  DEST_ALIAS_COOKIE,\n  parseAliasMap,\n  toRealPath,\n} from '@withpotter/lib/destination-alias';\n\n/** The raw cookie string, so useSyncExternalStore compares by value. */\nexport function readAliasCookie(): string {\n  try {\n    const match = document.cookie\n      .split('; ')\n      .find((c) => c.startsWith(`${DEST_ALIAS_COOKIE}=`));\n    return match ? match.slice(DEST_ALIAS_COOKIE.length + 1) : '';\n  } catch {\n    return '';\n  }\n}\n\nconst subscribe = () => () => {};\nconst serverCookie = () => '';\n\n/**\n * The route a screen REALLY lives at, not the address the merchant sees.\n *\n * Screens show up as /dashboard/<their word for it> (see\n * `lib/destination-alias.ts`), but navigation, permissions, the sidebar's\n * active row and the page's own title are all keyed on the real route. Use this\n * wherever the path is READ to decide something.\n *\n * Do not use it to build a URL to navigate to: `router.replace(pathname)` with\n * the real route works (the proxy sends it to the word) but costs a redirect,\n * so those callers use next/navigation's own hook.\n */\nexport function usePathname(): string {\n  const raw = useNextPathname();\n  const cookie = useSyncExternalStore(subscribe, readAliasCookie, serverCookie);\n  return cookie && raw ? toRealPath(raw, parseAliasMap(cookie)) : raw;\n}\n"],"mappings":";AAEA,SAAS,4BAA4B;AACrC,SAAS,eAAe,uBAAuB;AAC/C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAGA,SAAS,kBAA0B;AACxC,MAAI;AACF,UAAM,QAAQ,SAAS,OACpB,MAAM,IAAI,EACV,KAAK,CAAC,MAAM,EAAE,WAAW,GAAG,iBAAiB,GAAG,CAAC;AACpD,WAAO,QAAQ,MAAM,MAAM,kBAAkB,SAAS,CAAC,IAAI;AAAA,EAC7D,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAEA,MAAM,YAAY,MAAM,MAAM;AAAC;AAC/B,MAAM,eAAe,MAAM;AAcpB,SAAS,cAAsB;AACpC,QAAM,MAAM,gBAAgB;AAC5B,QAAM,SAAS,qBAAqB,WAAW,iBAAiB,YAAY;AAC5E,SAAO,UAAU,MAAM,WAAW,KAAK,cAAc,MAAM,CAAC,IAAI;AAClE;","names":[]}

package/dist/use-permissions.d.ts

@@ -0,0 +1,43 @@
+import { type TeamMemberResponse } from './api';
+import { type PermissionChange } from './permission-change';
+import { type MembershipOutcome } from './membership-freshness';
+/**
+ * Canonical set of team permission keys. Kept as a runtime constant so
+ * TypeScript can derive the union without depending on the api package.
+ */
+export declare const PERMISSION_KEYS: readonly ["canManageProducts", "canViewProducts", "canManageOrders", "canViewOrders", "canManageMembers", "canViewMembers", "canManageDiscounts", "canViewDiscounts", "canManageReviews", "canViewReviews", "canManageAnalytics", "canViewAnalytics", "canManageFinance", "canViewFinance", "canApproveMoneyMovement", "canManageSettings", "canManageBusinessProfile", "canViewWebsite", "canManageDomains", "canManageEditor", "canManageBlog", "canViewBlog", "canManageHardware", "canViewHardware", "canManageTeam", "canManageCommunications", "canViewCommunications"];
+export type PermissionKey = (typeof PERMISSION_KEYS)[number];
+interface UsePermissionsResult {
+    loading: boolean;
+    role: TeamMemberResponse['role'] | null;
+    permissions: Record<PermissionKey, boolean>;
+    /** Convenience: true when the current user is an OWNER (can do anything). */
+    isOwner: boolean;
+    /** Convenience: true when the user is a viewer (can only view). */
+    isViewer: boolean;
+    /**
+     * `removed` once the api has said this account is not a member of the active
+     * tenant. Only ever set from a real answer (a 403/404, or a 200 with no
+     * membership) — never from a timeout, or a flaky connection would eject
+     * people from their own workspace.
+     */
+    membership: MembershipOutcome;
+    /**
+     * Set when the effective permissions changed between two fetches of the same
+     * session — i.e. somebody altered this person's access while they were
+     * working. Null on first load, and null again once acknowledged.
+     */
+    permissionChange: PermissionChange | null;
+    /** Dismiss the change notice. */
+    acknowledgePermissionChange: () => void;
+    can: (permission: PermissionKey) => boolean;
+    refresh: () => Promise<void>;
+}
+/**
+ * Fetches the current user's team membership + effective permissions for
+ * the active tenant. Components use `can('canManageProducts')` to gate
+ * write actions in the UI. The backend still enforces every write via
+ * `PermissionsGuard`, so this is UX only — do not treat it as security.
+ */
+export declare function usePermissions(): UsePermissionsResult;
+export {};

package/dist/use-permissions.js

@@ -0,0 +1,158 @@
+"use client";
+import { useEffect, useRef, useState, useCallback, useMemo } from "react";
+import { useAuth } from "./auth-context";
+import { teamApi } from "./api";
+import { diffPermissions } from "./permission-change";
+import { grantsKey } from "./permission-aliases";
+import {
+  isMembershipStale,
+  classifyMembershipError,
+  outcomeForMember
+} from "./membership-freshness";
+const PERMISSION_KEYS = [
+  "canManageProducts",
+  "canViewProducts",
+  "canManageOrders",
+  "canViewOrders",
+  "canManageMembers",
+  "canViewMembers",
+  "canManageDiscounts",
+  "canViewDiscounts",
+  "canManageReviews",
+  "canViewReviews",
+  "canManageAnalytics",
+  "canViewAnalytics",
+  "canManageFinance",
+  "canViewFinance",
+  // Moves money out of the wallet. Owners hold it by default; nobody else does.
+  "canApproveMoneyMovement",
+  "canManageSettings",
+  "canManageBusinessProfile",
+  "canViewWebsite",
+  "canManageDomains",
+  "canManageEditor",
+  "canManageBlog",
+  "canViewBlog",
+  // Tills, readers and gates. Not folded into Finance, which this surface
+  // borrowed for want of anything else: a shop manager who must never see a
+  // payout still has to be able to pair the till that stopped on a Saturday.
+  "canManageHardware",
+  "canViewHardware",
+  "canManageTeam",
+  "canManageCommunications",
+  "canViewCommunications"
+];
+const EMPTY_PERMISSIONS = PERMISSION_KEYS.reduce(
+  (acc, key) => ({ ...acc, [key]: false }),
+  {}
+);
+function usePermissions() {
+  const { tenant, user } = useAuth();
+  const [loading, setLoading] = useState(true);
+  const [member, setMember] = useState(null);
+  const [membership, setMembership] = useState("unknown");
+  const lastFetchedAt = useRef(null);
+  const [permissionChange, setPermissionChange] = useState(null);
+  const previousPermissions = useRef(null);
+  const load = useCallback(
+    async (background) => {
+      if (!tenant?.slug || !user) {
+        setMember(null);
+        setMembership("unknown");
+        setLoading(false);
+        return;
+      }
+      if (user.currentWorkspace?.role === "owner") {
+        setMember(null);
+        setMembership("active");
+        setLoading(false);
+        return;
+      }
+      if (!background) setLoading(true);
+      try {
+        const me = await teamApi.me(tenant.slug);
+        setMember(me);
+        setMembership(outcomeForMember(me));
+      } catch (error) {
+        const outcome = classifyMembershipError(error);
+        if (!background || outcome === "removed") setMember(null);
+        if (outcome === "removed") setMembership("removed");
+      } finally {
+        lastFetchedAt.current = Date.now();
+        if (!background) setLoading(false);
+      }
+    },
+    [tenant?.slug, user]
+  );
+  useEffect(() => {
+    lastFetchedAt.current = null;
+    previousPermissions.current = null;
+    setPermissionChange(null);
+    void load();
+  }, [load]);
+  useEffect(() => {
+    if (!tenant?.slug || !user) return;
+    if (user.currentWorkspace?.role === "owner") return;
+    const recheck = () => {
+      if (document.visibilityState === "hidden") return;
+      if (!isMembershipStale(lastFetchedAt.current, Date.now())) return;
+      void load(true);
+    };
+    window.addEventListener("focus", recheck);
+    document.addEventListener("visibilitychange", recheck);
+    return () => {
+      window.removeEventListener("focus", recheck);
+      document.removeEventListener("visibilitychange", recheck);
+    };
+  }, [load, tenant?.slug, user]);
+  const workspacePermissions = user?.currentWorkspace?.permissions;
+  const permissions = useMemo(() => {
+    const effectivePermissions = member?.effectivePermissions ?? workspacePermissions;
+    return effectivePermissions ? PERMISSION_KEYS.reduce(
+      (acc, key) => ({
+        ...acc,
+        // Through its alias too: see permission-aliases.ts.
+        [key]: grantsKey(effectivePermissions, key)
+      }),
+      {}
+    ) : EMPTY_PERMISSIONS;
+  }, [member, workspacePermissions]);
+  useEffect(() => {
+    if (loading) return;
+    const change = diffPermissions(previousPermissions.current, permissions);
+    previousPermissions.current = permissions;
+    if (change) setPermissionChange(change);
+  }, [loading, permissions]);
+  const acknowledgePermissionChange = useCallback(
+    () => setPermissionChange(null),
+    []
+  );
+  const isWorkspaceOwner = user?.currentWorkspace?.role === "owner";
+  const isOwner = member?.role === "owner" || isWorkspaceOwner;
+  const role = member?.role ?? user?.currentWorkspace?.role ?? null;
+  const isViewer = role === "viewer";
+  const can = useCallback(
+    (permission) => {
+      if (isOwner) return true;
+      return Boolean(permissions[permission]);
+    },
+    [isOwner, permissions]
+  );
+  return {
+    loading,
+    role,
+    permissions,
+    isOwner,
+    isViewer,
+    membership,
+    permissionChange,
+    acknowledgePermissionChange,
+    can,
+    refresh: load
+  };
+}
+export {
+  PERMISSION_KEYS,
+  usePermissions
+};
+//# sourceMappingURL=use-permissions.js.map

package/dist/use-permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/use-permissions.ts"],"sourcesContent":["'use client';\n\nimport { useEffect, useRef, useState, useCallback, useMemo } from 'react';\nimport { useAuth } from './auth-context';\nimport { teamApi, type TeamMemberResponse } from './api';\nimport { diffPermissions, type PermissionChange } from './permission-change';\nimport { grantsKey } from './permission-aliases';\nimport {\n  isMembershipStale,\n  classifyMembershipError,\n  outcomeForMember,\n  type MembershipOutcome,\n} from './membership-freshness';\n\n/**\n * Canonical set of team permission keys. Kept as a runtime constant so\n * TypeScript can derive the union without depending on the api package.\n */\nexport const PERMISSION_KEYS = [\n  'canManageProducts',\n  'canViewProducts',\n  'canManageOrders',\n  'canViewOrders',\n  'canManageMembers',\n  'canViewMembers',\n  'canManageDiscounts',\n  'canViewDiscounts',\n  'canManageReviews',\n  'canViewReviews',\n  'canManageAnalytics',\n  'canViewAnalytics',\n  'canManageFinance',\n  'canViewFinance',\n  // Moves money out of the wallet. Owners hold it by default; nobody else does.\n  'canApproveMoneyMovement',\n  'canManageSettings',\n  'canManageBusinessProfile',\n  'canViewWebsite',\n  'canManageDomains',\n  'canManageEditor',\n  'canManageBlog',\n  'canViewBlog',\n  // Tills, readers and gates. Not folded into Finance, which this surface\n  // borrowed for want of anything else: a shop manager who must never see a\n  // payout still has to be able to pair the till that stopped on a Saturday.\n  'canManageHardware',\n  'canViewHardware',\n  'canManageTeam',\n  'canManageCommunications',\n  'canViewCommunications',\n] as const;\n\nexport type PermissionKey = (typeof PERMISSION_KEYS)[number];\n\n/**\n * Permission map with every key defaulted to false. Used before the\n * network response resolves so the UI stays read-only rather than\n * flashing an admin view for a viewer.\n */\nconst EMPTY_PERMISSIONS: Record<PermissionKey, boolean> =\n  PERMISSION_KEYS.reduce(\n    (acc, key) => ({ ...acc, [key]: false }),\n    {} as Record<PermissionKey, boolean>,\n  );\n\ninterface UsePermissionsResult {\n  loading: boolean;\n  role: TeamMemberResponse['role'] | null;\n  permissions: Record<PermissionKey, boolean>;\n  /** Convenience: true when the current user is an OWNER (can do anything). */\n  isOwner: boolean;\n  /** Convenience: true when the user is a viewer (can only view). */\n  isViewer: boolean;\n  /**\n   * `removed` once the api has said this account is not a member of the active\n   * tenant. Only ever set from a real answer (a 403/404, or a 200 with no\n   * membership) — never from a timeout, or a flaky connection would eject\n   * people from their own workspace.\n   */\n  membership: MembershipOutcome;\n  /**\n   * Set when the effective permissions changed between two fetches of the same\n   * session — i.e. somebody altered this person's access while they were\n   * working. Null on first load, and null again once acknowledged.\n   */\n  permissionChange: PermissionChange | null;\n  /** Dismiss the change notice. */\n  acknowledgePermissionChange: () => void;\n  can: (permission: PermissionKey) => boolean;\n  refresh: () => Promise<void>;\n}\n\n/**\n * Fetches the current user's team membership + effective permissions for\n * the active tenant. Components use `can('canManageProducts')` to gate\n * write actions in the UI. The backend still enforces every write via\n * `PermissionsGuard`, so this is UX only — do not treat it as security.\n */\nexport function usePermissions(): UsePermissionsResult {\n  const { tenant, user } = useAuth();\n  const [loading, setLoading] = useState(true);\n  const [member, setMember] = useState<TeamMemberResponse | null>(null);\n  const [membership, setMembership] = useState<MembershipOutcome>('unknown');\n  const lastFetchedAt = useRef<number | null>(null);\n  const [permissionChange, setPermissionChange] =\n    useState<PermissionChange | null>(null);\n  // The map as it was the last time we looked. A ref, not state: comparing is a\n  // side effect of the next fetch, and putting it in state would re-render\n  // everything that reads this hook for no visible reason.\n  const previousPermissions = useRef<Record<string, boolean> | null>(null);\n\n  /**\n   * `background` is a re-check of someone already known: it must not look like\n   * a first load. It used to set `loading` and, on a failed request, empty the\n   * member, so every return to the tab (a phone call, switching apps) made the\n   * screens that wait on `loading` hide and reappear, and a flaky connection\n   * locked sections until the next check. A background check keeps what it\n   * knew until the API actually answers.\n   */\n  const load = useCallback(\n    async (background?: boolean) => {\n      if (!tenant?.slug || !user) {\n        setMember(null);\n        setMembership('unknown');\n        setLoading(false);\n        return;\n      }\n      if (user.currentWorkspace?.role === 'owner') {\n        setMember(null);\n        setMembership('active');\n        setLoading(false);\n        return;\n      }\n      if (!background) setLoading(true);\n      try {\n        const me = await teamApi.me(tenant.slug);\n        setMember(me);\n        setMembership(outcomeForMember(me));\n      } catch (error) {\n        // A failure that is not an answer leaves the previous verdict alone; what\n        // must not happen is a timeout reading as \"you were removed\". First load\n        // collapses the permission map to empty (the UI locks down); a background\n        // check keeps what it had unless the API says the access is gone.\n        const outcome = classifyMembershipError(error);\n        if (!background || outcome === 'removed') setMember(null);\n        if (outcome === 'removed') setMembership('removed');\n      } finally {\n        lastFetchedAt.current = Date.now();\n        if (!background) setLoading(false);\n      }\n    },\n    [tenant?.slug, user],\n  );\n\n  useEffect(() => {\n    // A different tenant is a different set of grants, not a change to this\n    // person's access. Clearing the baseline stops a workspace switch from\n    // announcing itself as somebody taking something away.\n    lastFetchedAt.current = null;\n    previousPermissions.current = null;\n    setPermissionChange(null);\n    void load();\n  }, [load]);\n\n  /**\n   * Re-ask when the tab comes back.\n   *\n   * This fetched once per tenant change and then never again, so a merchant who\n   * demoted or removed somebody had no effect on that person's open tab until\n   * they happened to reload — the nav kept offering rows the api had already\n   * started refusing. A returning tab is the cheapest honest moment to check.\n   *\n   * Rate-limited, because alt-tabbing is not a session change and this would\n   * otherwise fire on every window switch.\n   */\n  useEffect(() => {\n    if (!tenant?.slug || !user) return;\n    if (user.currentWorkspace?.role === 'owner') return;\n\n    const recheck = () => {\n      if (document.visibilityState === 'hidden') return;\n      if (!isMembershipStale(lastFetchedAt.current, Date.now())) return;\n      void load(true);\n    };\n\n    window.addEventListener('focus', recheck);\n    document.addEventListener('visibilitychange', recheck);\n    return () => {\n      window.removeEventListener('focus', recheck);\n      document.removeEventListener('visibilitychange', recheck);\n    };\n  }, [load, tenant?.slug, user]);\n\n  // Staging's workspace-permissions fallback, kept memoized (HEAD) so\n  // `permissions`/`can` stay a stable reference across renders — the sidebar\n  // nav tree memoizes on `can` and depends on that.\n  const workspacePermissions = user?.currentWorkspace?.permissions;\n  const permissions: Record<PermissionKey, boolean> = useMemo(() => {\n    const effectivePermissions =\n      member?.effectivePermissions ?? workspacePermissions;\n    return effectivePermissions\n      ? PERMISSION_KEYS.reduce(\n          (acc, key) => ({\n            ...acc,\n            // Through its alias too: see permission-aliases.ts.\n            [key]: grantsKey(effectivePermissions, key),\n          }),\n          {} as Record<PermissionKey, boolean>,\n        )\n      : EMPTY_PERMISSIONS;\n  }, [member, workspacePermissions]);\n\n  /**\n   * Notice when access changed under a live session.\n   *\n   * This is the cost of re-fetching on focus: a sidebar can now change while\n   * someone is mid-task. Rows appearing and disappearing with no explanation is\n   * worse than the staleness it replaced, so the change gets said out loud\n   * exactly once.\n   */\n  useEffect(() => {\n    if (loading) return;\n    const change = diffPermissions(previousPermissions.current, permissions);\n    previousPermissions.current = permissions;\n    if (change) setPermissionChange(change);\n  }, [loading, permissions]);\n\n  const acknowledgePermissionChange = useCallback(\n    () => setPermissionChange(null),\n    [],\n  );\n\n  const isWorkspaceOwner = user?.currentWorkspace?.role === 'owner';\n  const isOwner = member?.role === 'owner' || isWorkspaceOwner;\n  const role = member?.role ?? user?.currentWorkspace?.role ?? null;\n  const isViewer = role === 'viewer';\n\n  const can = useCallback(\n    (permission: PermissionKey) => {\n      if (isOwner) return true;\n      return Boolean(permissions[permission]);\n    },\n    [isOwner, permissions],\n  );\n\n  return {\n    loading,\n    role,\n    permissions,\n    isOwner,\n    isViewer,\n    membership,\n    permissionChange,\n    acknowledgePermissionChange,\n    can,\n    refresh: load,\n  };\n}\n"],"mappings":";AAEA,SAAS,WAAW,QAAQ,UAAU,aAAa,eAAe;AAClE,SAAS,eAAe;AACxB,SAAS,eAAwC;AACjD,SAAS,uBAA8C;AACvD,SAAS,iBAAiB;AAC1B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAMA,MAAM,kBAAkB;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA;AAAA;AAAA,EAIA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AASA,MAAM,oBACJ,gBAAgB;AAAA,EACd,CAAC,KAAK,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,GAAG,MAAM;AAAA,EACtC,CAAC;AACH;AAmCK,SAAS,iBAAuC;AACrD,QAAM,EAAE,QAAQ,KAAK,IAAI,QAAQ;AACjC,QAAM,CAAC,SAAS,UAAU,IAAI,SAAS,IAAI;AAC3C,QAAM,CAAC,QAAQ,SAAS,IAAI,SAAoC,IAAI;AACpE,QAAM,CAAC,YAAY,aAAa,IAAI,SAA4B,SAAS;AACzE,QAAM,gBAAgB,OAAsB,IAAI;AAChD,QAAM,CAAC,kBAAkB,mBAAmB,IAC1C,SAAkC,IAAI;AAIxC,QAAM,sBAAsB,OAAuC,IAAI;AAUvE,QAAM,OAAO;AAAA,IACX,OAAO,eAAyB;AAC9B,UAAI,CAAC,QAAQ,QAAQ,CAAC,MAAM;AAC1B,kBAAU,IAAI;AACd,sBAAc,SAAS;AACvB,mBAAW,KAAK;AAChB;AAAA,MACF;AACA,UAAI,KAAK,kBAAkB,SAAS,SAAS;AAC3C,kBAAU,IAAI;AACd,sBAAc,QAAQ;AACtB,mBAAW,KAAK;AAChB;AAAA,MACF;AACA,UAAI,CAAC,WAAY,YAAW,IAAI;AAChC,UAAI;AACF,cAAM,KAAK,MAAM,QAAQ,GAAG,OAAO,IAAI;AACvC,kBAAU,EAAE;AACZ,sBAAc,iBAAiB,EAAE,CAAC;AAAA,MACpC,SAAS,OAAO;AAKd,cAAM,UAAU,wBAAwB,KAAK;AAC7C,YAAI,CAAC,cAAc,YAAY,UAAW,WAAU,IAAI;AACxD,YAAI,YAAY,UAAW,eAAc,SAAS;AAAA,MACpD,UAAE;AACA,sBAAc,UAAU,KAAK,IAAI;AACjC,YAAI,CAAC,WAAY,YAAW,KAAK;AAAA,MACnC;AAAA,IACF;AAAA,IACA,CAAC,QAAQ,MAAM,IAAI;AAAA,EACrB;AAEA,YAAU,MAAM;AAId,kBAAc,UAAU;AACxB,wBAAoB,UAAU;AAC9B,wBAAoB,IAAI;AACxB,SAAK,KAAK;AAAA,EACZ,GAAG,CAAC,IAAI,CAAC;AAaT,YAAU,MAAM;AACd,QAAI,CAAC,QAAQ,QAAQ,CAAC,KAAM;AAC5B,QAAI,KAAK,kBAAkB,SAAS,QAAS;AAE7C,UAAM,UAAU,MAAM;AACpB,UAAI,SAAS,oBAAoB,SAAU;AAC3C,UAAI,CAAC,kBAAkB,cAAc,SAAS,KAAK,IAAI,CAAC,EAAG;AAC3D,WAAK,KAAK,IAAI;AAAA,IAChB;AAEA,WAAO,iBAAiB,SAAS,OAAO;AACxC,aAAS,iBAAiB,oBAAoB,OAAO;AACrD,WAAO,MAAM;AACX,aAAO,oBAAoB,SAAS,OAAO;AAC3C,eAAS,oBAAoB,oBAAoB,OAAO;AAAA,IAC1D;AAAA,EACF,GAAG,CAAC,MAAM,QAAQ,MAAM,IAAI,CAAC;AAK7B,QAAM,uBAAuB,MAAM,kBAAkB;AACrD,QAAM,cAA8C,QAAQ,MAAM;AAChE,UAAM,uBACJ,QAAQ,wBAAwB;AAClC,WAAO,uBACH,gBAAgB;AAAA,MACd,CAAC,KAAK,SAAS;AAAA,QACb,GAAG;AAAA;AAAA,QAEH,CAAC,GAAG,GAAG,UAAU,sBAAsB,GAAG;AAAA,MAC5C;AAAA,MACA,CAAC;AAAA,IACH,IACA;AAAA,EACN,GAAG,CAAC,QAAQ,oBAAoB,CAAC;AAUjC,YAAU,MAAM;AACd,QAAI,QAAS;AACb,UAAM,SAAS,gBAAgB,oBAAoB,SAAS,WAAW;AACvE,wBAAoB,UAAU;AAC9B,QAAI,OAAQ,qBAAoB,MAAM;AAAA,EACxC,GAAG,CAAC,SAAS,WAAW,CAAC;AAEzB,QAAM,8BAA8B;AAAA,IAClC,MAAM,oBAAoB,IAAI;AAAA,IAC9B,CAAC;AAAA,EACH;AAEA,QAAM,mBAAmB,MAAM,kBAAkB,SAAS;AAC1D,QAAM,UAAU,QAAQ,SAAS,WAAW;AAC5C,QAAM,OAAO,QAAQ,QAAQ,MAAM,kBAAkB,QAAQ;AAC7D,QAAM,WAAW,SAAS;AAE1B,QAAM,MAAM;AAAA,IACV,CAAC,eAA8B;AAC7B,UAAI,QAAS,QAAO;AACpB,aAAO,QAAQ,YAAY,UAAU,CAAC;AAAA,IACxC;AAAA,IACA,CAAC,SAAS,WAAW;AAAA,EACvB;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,SAAS;AAAA,EACX;AACF;","names":[]}

package/dist/use-platform-modules.d.ts

@@ -0,0 +1,49 @@
+import { type LucideIcon } from 'lucide-react';
+import { type TemplateConfig, type DashboardModule, type DashboardState } from './template-context';
+export declare const moduleCapabilities: Record<string, string | string[]>;
+export declare const platformNavigation: DashboardModule[];
+declare const coreModuleDefaultIcons: Record<string, LucideIcon>;
+declare const coreModuleIds: Set<string>;
+declare const coreModuleOrder: string[];
+export declare const universalCoreModules: (DashboardModule & {
+    requiredBehavior?: string | string[];
+})[];
+/**
+ * Check if a template supports a given behavior.
+ * Handles both array format (["subscribable", "sellable"]) and
+ * object format ({ enableSubscriptions: true, enableBookings: true }).
+ * Object keys are matched by convention: "subscribable" → enableSubscriptions/enableSubscription.
+ */
+declare function templateHasBehavior(behaviors: unknown, behavior: string): boolean;
+interface UsePlatformModulesOptions {
+    /** The current tenant's resolved template config (null if unavailable) */
+    template: TemplateConfig | null;
+    /** Dashboard resilience state */
+    dashboardState: DashboardState;
+    /** Tenant's enabled behaviors — overrides template behaviors when present */
+    enabledBehaviors?: string[];
+    /** Module IDs the merchant has explicitly hidden */
+    hiddenModules?: string[];
+    /** Custom labels for sidebar modules — overrides platform default names */
+    moduleLabels?: Record<string, string>;
+    /** Merchant's custom module order — array of module IDs */
+    moduleOrder?: string[];
+}
+interface UsePlatformModulesReturn {
+    /** Platform-owned operational modules — always present */
+    coreNavigation: DashboardModule[];
+}
+/**
+ * Determines which navigation modules to display in the dashboard sidebar.
+ *
+ * **Platform modules** (coreNavigation) — derived from API capabilities (behaviors).
+ * Always present regardless of template dashboardModules config. Behavior-gated
+ * modules (Inventory, Bookings, Subscriptions) appear when the tenant has enabled
+ * the relevant behavior. When the template is unavailable, ALL platform modules
+ * are shown unconditionally to prevent merchants from losing access to operational tools.
+ *
+ * This hook is the trust boundary: template corruption can never hide operational
+ * platform modules.
+ */
+export declare function usePlatformModules({ template, dashboardState, enabledBehaviors, hiddenModules, moduleLabels, moduleOrder, }: UsePlatformModulesOptions): UsePlatformModulesReturn;
+export { coreModuleIds, coreModuleDefaultIcons, coreModuleOrder, templateHasBehavior, };