@the-portland-company/shell 0.30.0 → 0.32.0

package/dist/native.d.cts

@@ -162,11 +162,35 @@ declare function useThemePreference(): {
 };
 
 /**
- * Icon slots used by the standard menu. The shell stays icon-library-agnostic:
+ * Icon slots used by the standard menus. The shell stays icon-library-agnostic:
  * callers map each key to their own icon components (lucide, react-icons, …).
  * A missing key simply renders that row without an icon.
  */
-type StandardNavIconKey = 'home' | 'users' | 'mail' | 'messageSquare' | 'layout' | 'activity' | 'lifeBuoy' | 'grid' | 'list' | 'upload' | 'edit' | 'fileText' | 'send' | 'clock' | 'user' | 'barChart' | 'briefcase' | 'settings' | 'creditCard' | 'dollarSign' | 'share';
+type StandardNavIconKey = 'home' | 'users' | 'mail' | 'messageSquare' | 'layout' | 'activity' | 'lifeBuoy' | 'grid' | 'list' | 'upload' | 'edit' | 'fileText' | 'send' | 'clock' | 'user' | 'barChart' | 'briefcase' | 'settings' | 'creditCard' | 'dollarSign' | 'share' | 'phone' | 'map' | 'mapPin' | 'target' | 'flag';
+/** The operating Mode whose nav tree to build. Defaults to `relationship`. */
+type StandardNavMode = 'relationship' | 'campaign' | 'petition';
+/**
+ * Per-feature availability for the Campaign tree. Campaign Mode ships its apps
+ * incrementally: a disabled feature is omitted from the nav entirely (rather
+ * than rendered as a dead/disabled row), and its flag flips to `true` in a
+ * later patch release as the app goes live. Dashboard and Voter Contact are
+ * core-hosted and always present, so they carry no flag.
+ */
+interface CampaignFeatureAvailability {
+    a2p: boolean;
+    phonebank: boolean;
+    canvass: boolean;
+    signs: boolean;
+    tribes: boolean;
+    polling: boolean;
+}
+/**
+ * Launch state at this shell version: Polling Engine (polls app) and Tribes
+ * (Contacts app) are live; A2P, Phone Banking, Field Canvassing and Sign
+ * Mapping are not yet deployed and stay hidden until their patch release flips
+ * the flag.
+ */
+declare const CAMPAIGN_FEATURE_AVAILABILITY: CampaignFeatureAvailability;
 interface StandardNavOptions {
     /** VRM core origin, e.g. "https://app.politogyvrm.com". Trailing slash OK. */
     coreBaseUrl: string;
@@ -177,6 +201,7 @@ interface StandardNavOptions {
      * (NOT absolutized) so the owning app nests its own routes; `href` (also
      * verbatim) feeds active-detection for the group header. When omitted, the
      * item carries VRM core's own contacts sub-pages as absolute links.
+     * (Relationship tree only.)
      */
     contactsItem?: {
         href?: string;
@@ -185,17 +210,35 @@ interface StandardNavOptions {
     /**
      * The trailing "Support" row. VRM core opens its SupportRequestModal here;
      * other apps supply their own handler (`onClick`) or a link (`href`).
-     * Omitted or `false` → no Support row.
+     * Omitted or `false` → no Support row. Appended to every mode's tree.
      */
     supportItem?: {
         onClick?: () => void;
         href?: string;
     } | false;
+    /**
+     * Which mode's tree to build. Default `relationship`, whose output is
+     * byte-for-byte what this function produced before modes existed.
+     */
+    mode?: StandardNavMode;
+    /**
+     * Active organization id. Cross-app links in the Campaign/Petition trees
+     * carry it as `?org=<last6>` — the same convention the Mode switcher and My
+     * Account menu use — so the destination app opens on the same org. The
+     * Relationship tree ignores this (its links never carried an org).
+     */
+    activeOrgId?: string | null;
+    /**
+     * Per-feature Campaign availability overrides, merged over
+     * `CAMPAIGN_FEATURE_AVAILABILITY`. Only meaningful for the Campaign tree.
+     */
+    campaignAvailability?: Partial<CampaignFeatureAvailability>;
 }
 /**
- * Build the standard Politogy VRM menu (relationship mode), in the exact order
- * and wording the main app renders it. See `StandardNavOptions` for the two
- * app-specific hooks (`contactsItem`, `supportItem`).
+ * Build the standard Politogy VRM menu for the given `mode` (default
+ * `relationship`), in the exact order and wording the main app renders it. See
+ * `StandardNavOptions` for the app-specific hooks (`contactsItem`,
+ * `supportItem`) and the Campaign inputs (`activeOrgId`, `campaignAvailability`).
  */
 declare function standardPolitogyNav(opts: StandardNavOptions): NavItem[];
 
@@ -518,4 +561,4 @@ type NavAppShellProps = {
 };
 declare function NavAppShell({ sidebar, topBar, betaBanner, contentWrapper, children, }: NavAppShellProps): react_jsx_runtime.JSX.Element;
 
-export { type ChromeMe, type ChromeNotificationAlert, type ChromeNotificationReply, type ChromeNotificationsPayload, type ChromeOrgSummary, type CommunicationsFuelStatus, FuelAction, type FuelChannelStatus, NavAppShell, type NavAppShellProps, NavBetaBanner, type NavBetaBannerProps, type NavBrand, type NavBreadcrumb, type NavChromeFetcher, NavChromeProvider, NavDisplayAction, type NavDisplayMode, type NavFooter, type NavFooterLink, type NavIcon, type NavItem, type NavLinkComponent, type NavLinkProps, type NavLinkedAccount, type NavMode, type NavModeOption, type NavOrg, type NavOrgOption, type NavRoleBadge, NavSidebar, type NavSidebarProps, type NavTab, NavTabStrip, type NavTabStripProps, NavThemeControl, NavTopBar, type NavTopBarAction, type NavTopBarProps, type NavUser, type NavUserMenu, NotificationsAction, type StandardNavIconKey, type StandardNavOptions, SupportAction, type ThemePreference, TopBarCountBadge, TopBarPanelArrow, TopBarPopover, TopBarTooltip, TopBarWidgetSlot, envChipClasses, isNavItemActive, standardPolitogyNav, topBarIconButtonClass, useChromeMe, useChromeOrgs, useNavChromeFetcher, useThemePreference };
+export { CAMPAIGN_FEATURE_AVAILABILITY, type CampaignFeatureAvailability, type ChromeMe, type ChromeNotificationAlert, type ChromeNotificationReply, type ChromeNotificationsPayload, type ChromeOrgSummary, type CommunicationsFuelStatus, FuelAction, type FuelChannelStatus, NavAppShell, type NavAppShellProps, NavBetaBanner, type NavBetaBannerProps, type NavBrand, type NavBreadcrumb, type NavChromeFetcher, NavChromeProvider, NavDisplayAction, type NavDisplayMode, type NavFooter, type NavFooterLink, type NavIcon, type NavItem, type NavLinkComponent, type NavLinkProps, type NavLinkedAccount, type NavMode, type NavModeOption, type NavOrg, type NavOrgOption, type NavRoleBadge, NavSidebar, type NavSidebarProps, type NavTab, NavTabStrip, type NavTabStripProps, NavThemeControl, NavTopBar, type NavTopBarAction, type NavTopBarProps, type NavUser, type NavUserMenu, NotificationsAction, type StandardNavIconKey, type StandardNavMode, type StandardNavOptions, SupportAction, type ThemePreference, TopBarCountBadge, TopBarPanelArrow, TopBarPopover, TopBarTooltip, TopBarWidgetSlot, envChipClasses, isNavItemActive, standardPolitogyNav, topBarIconButtonClass, useChromeMe, useChromeOrgs, useNavChromeFetcher, useThemePreference };

package/dist/native.d.ts

@@ -162,11 +162,35 @@ declare function useThemePreference(): {
 };
 
 /**
- * Icon slots used by the standard menu. The shell stays icon-library-agnostic:
+ * Icon slots used by the standard menus. The shell stays icon-library-agnostic:
  * callers map each key to their own icon components (lucide, react-icons, …).
  * A missing key simply renders that row without an icon.
  */
-type StandardNavIconKey = 'home' | 'users' | 'mail' | 'messageSquare' | 'layout' | 'activity' | 'lifeBuoy' | 'grid' | 'list' | 'upload' | 'edit' | 'fileText' | 'send' | 'clock' | 'user' | 'barChart' | 'briefcase' | 'settings' | 'creditCard' | 'dollarSign' | 'share';
+type StandardNavIconKey = 'home' | 'users' | 'mail' | 'messageSquare' | 'layout' | 'activity' | 'lifeBuoy' | 'grid' | 'list' | 'upload' | 'edit' | 'fileText' | 'send' | 'clock' | 'user' | 'barChart' | 'briefcase' | 'settings' | 'creditCard' | 'dollarSign' | 'share' | 'phone' | 'map' | 'mapPin' | 'target' | 'flag';
+/** The operating Mode whose nav tree to build. Defaults to `relationship`. */
+type StandardNavMode = 'relationship' | 'campaign' | 'petition';
+/**
+ * Per-feature availability for the Campaign tree. Campaign Mode ships its apps
+ * incrementally: a disabled feature is omitted from the nav entirely (rather
+ * than rendered as a dead/disabled row), and its flag flips to `true` in a
+ * later patch release as the app goes live. Dashboard and Voter Contact are
+ * core-hosted and always present, so they carry no flag.
+ */
+interface CampaignFeatureAvailability {
+    a2p: boolean;
+    phonebank: boolean;
+    canvass: boolean;
+    signs: boolean;
+    tribes: boolean;
+    polling: boolean;
+}
+/**
+ * Launch state at this shell version: Polling Engine (polls app) and Tribes
+ * (Contacts app) are live; A2P, Phone Banking, Field Canvassing and Sign
+ * Mapping are not yet deployed and stay hidden until their patch release flips
+ * the flag.
+ */
+declare const CAMPAIGN_FEATURE_AVAILABILITY: CampaignFeatureAvailability;
 interface StandardNavOptions {
     /** VRM core origin, e.g. "https://app.politogyvrm.com". Trailing slash OK. */
     coreBaseUrl: string;
@@ -177,6 +201,7 @@ interface StandardNavOptions {
      * (NOT absolutized) so the owning app nests its own routes; `href` (also
      * verbatim) feeds active-detection for the group header. When omitted, the
      * item carries VRM core's own contacts sub-pages as absolute links.
+     * (Relationship tree only.)
      */
     contactsItem?: {
         href?: string;
@@ -185,17 +210,35 @@ interface StandardNavOptions {
     /**
      * The trailing "Support" row. VRM core opens its SupportRequestModal here;
      * other apps supply their own handler (`onClick`) or a link (`href`).
-     * Omitted or `false` → no Support row.
+     * Omitted or `false` → no Support row. Appended to every mode's tree.
      */
     supportItem?: {
         onClick?: () => void;
         href?: string;
     } | false;
+    /**
+     * Which mode's tree to build. Default `relationship`, whose output is
+     * byte-for-byte what this function produced before modes existed.
+     */
+    mode?: StandardNavMode;
+    /**
+     * Active organization id. Cross-app links in the Campaign/Petition trees
+     * carry it as `?org=<last6>` — the same convention the Mode switcher and My
+     * Account menu use — so the destination app opens on the same org. The
+     * Relationship tree ignores this (its links never carried an org).
+     */
+    activeOrgId?: string | null;
+    /**
+     * Per-feature Campaign availability overrides, merged over
+     * `CAMPAIGN_FEATURE_AVAILABILITY`. Only meaningful for the Campaign tree.
+     */
+    campaignAvailability?: Partial<CampaignFeatureAvailability>;
 }
 /**
- * Build the standard Politogy VRM menu (relationship mode), in the exact order
- * and wording the main app renders it. See `StandardNavOptions` for the two
- * app-specific hooks (`contactsItem`, `supportItem`).
+ * Build the standard Politogy VRM menu for the given `mode` (default
+ * `relationship`), in the exact order and wording the main app renders it. See
+ * `StandardNavOptions` for the app-specific hooks (`contactsItem`,
+ * `supportItem`) and the Campaign inputs (`activeOrgId`, `campaignAvailability`).
  */
 declare function standardPolitogyNav(opts: StandardNavOptions): NavItem[];
 
@@ -518,4 +561,4 @@ type NavAppShellProps = {
 };
 declare function NavAppShell({ sidebar, topBar, betaBanner, contentWrapper, children, }: NavAppShellProps): react_jsx_runtime.JSX.Element;
 
-export { type ChromeMe, type ChromeNotificationAlert, type ChromeNotificationReply, type ChromeNotificationsPayload, type ChromeOrgSummary, type CommunicationsFuelStatus, FuelAction, type FuelChannelStatus, NavAppShell, type NavAppShellProps, NavBetaBanner, type NavBetaBannerProps, type NavBrand, type NavBreadcrumb, type NavChromeFetcher, NavChromeProvider, NavDisplayAction, type NavDisplayMode, type NavFooter, type NavFooterLink, type NavIcon, type NavItem, type NavLinkComponent, type NavLinkProps, type NavLinkedAccount, type NavMode, type NavModeOption, type NavOrg, type NavOrgOption, type NavRoleBadge, NavSidebar, type NavSidebarProps, type NavTab, NavTabStrip, type NavTabStripProps, NavThemeControl, NavTopBar, type NavTopBarAction, type NavTopBarProps, type NavUser, type NavUserMenu, NotificationsAction, type StandardNavIconKey, type StandardNavOptions, SupportAction, type ThemePreference, TopBarCountBadge, TopBarPanelArrow, TopBarPopover, TopBarTooltip, TopBarWidgetSlot, envChipClasses, isNavItemActive, standardPolitogyNav, topBarIconButtonClass, useChromeMe, useChromeOrgs, useNavChromeFetcher, useThemePreference };
+export { CAMPAIGN_FEATURE_AVAILABILITY, type CampaignFeatureAvailability, type ChromeMe, type ChromeNotificationAlert, type ChromeNotificationReply, type ChromeNotificationsPayload, type ChromeOrgSummary, type CommunicationsFuelStatus, FuelAction, type FuelChannelStatus, NavAppShell, type NavAppShellProps, NavBetaBanner, type NavBetaBannerProps, type NavBrand, type NavBreadcrumb, type NavChromeFetcher, NavChromeProvider, NavDisplayAction, type NavDisplayMode, type NavFooter, type NavFooterLink, type NavIcon, type NavItem, type NavLinkComponent, type NavLinkProps, type NavLinkedAccount, type NavMode, type NavModeOption, type NavOrg, type NavOrgOption, type NavRoleBadge, NavSidebar, type NavSidebarProps, type NavTab, NavTabStrip, type NavTabStripProps, NavThemeControl, NavTopBar, type NavTopBarAction, type NavTopBarProps, type NavUser, type NavUserMenu, NotificationsAction, type StandardNavIconKey, type StandardNavMode, type StandardNavOptions, SupportAction, type ThemePreference, TopBarCountBadge, TopBarPanelArrow, TopBarPopover, TopBarTooltip, TopBarWidgetSlot, envChipClasses, isNavItemActive, standardPolitogyNav, topBarIconButtonClass, useChromeMe, useChromeOrgs, useNavChromeFetcher, useThemePreference };

package/dist/native.js

@@ -1,5 +1,5 @@
 "use client";
-export { FuelAction, NavAppShell, NavBetaBanner, NavChromeProvider, NavDisplayAction, NavSidebar, NavTabStrip, NavThemeControl, NavTopBar, NotificationsAction, SupportAction, TopBarCountBadge, TopBarPanelArrow, TopBarPopover, TopBarTooltip, TopBarWidgetSlot, envChipClasses, isNavItemActive, standardPolitogyNav, topBarIconButtonClass, useChromeMe, useChromeOrgs, useNavChromeFetcher, useThemePreference } from './chunk-QL5BWYN5.js';
+export { CAMPAIGN_FEATURE_AVAILABILITY, FuelAction, NavAppShell, NavBetaBanner, NavChromeProvider, NavDisplayAction, NavSidebar, NavTabStrip, NavThemeControl, NavTopBar, NotificationsAction, SupportAction, TopBarCountBadge, TopBarPanelArrow, TopBarPopover, TopBarTooltip, TopBarWidgetSlot, envChipClasses, isNavItemActive, standardPolitogyNav, topBarIconButtonClass, useChromeMe, useChromeOrgs, useNavChromeFetcher, useThemePreference } from './chunk-FF6RDQY7.js';
 import './chunk-NV6WHTEZ.js';
 import './chunk-LL7RCJQN.js';
 //# sourceMappingURL=native.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@the-portland-company/shell",
-  "version": "0.30.0",
+  "version": "0.32.0",
   "description": "Shared chrome (header, sidebar, footer, theme, auth) for politogy apps. Drop into any Vite SPA to inherit the politogy look and signed-in user.",
   "license": "UNLICENSED",
   "private": false,