sage-nexus-ui 1.3.6 → 1.3.7

package/dist/assets/images/favicon.ico.mjs

@@ -0,0 +1 @@
+var a="assets/images/favicon.ico";export{a as default};

package/dist/assets/images/urls.mjs

@@ -0,0 +1 @@
+import o from"./nexus-logo-favicon.svg.mjs";import m from"./favicon.ico.mjs";import{SAGE_NEXUS_UI_VERSION as r}from"../../generated/version.mjs";const i=r,s=(r=!0)=>({svg:r?`${o}?v=${i}`:o,ico:r?`${m}?v=${i}`:m});export{s as getFaviconUrls};

package/dist/components/FaviconLinks.mjs

@@ -0,0 +1 @@
+import{jsxs as r,Fragment as e,jsx as s}from"react/jsx-runtime";import o from"../assets/images/nexus-logo-favicon.svg.mjs";import i from"../assets/images/favicon.ico.mjs";import{SAGE_NEXUS_UI_VERSION as t}from"../generated/version.mjs";const m=t,n=({versioned:t=!0,svgAttrs:n,icoAttrs:c})=>{const a=t?`${i}?v=${m}`:i;return r(e,{children:[s("link",{rel:"icon",type:"image/svg+xml",href:t?`${o}?v=${m}`:o,...n}),s("link",{rel:"icon",href:a,...c})]})};export{n as FaviconLinks};

package/dist/generated/version.mjs

@@ -0,0 +1 @@
+const o="1.3.7";export{o as SAGE_NEXUS_UI_VERSION};

package/dist/index.d.ts

@@ -9,6 +9,7 @@ import { SxProps as SxProps$1 } from '@mui/system';
 import { Theme as Theme$1, SxProps as SxProps$2 } from '@mui/material/styles';
 export { default as nexusLogoNode } from './assets/images/nexus-logo-node.svg';
 export { default as nexusLogoFavicon } from './assets/images/nexus-logo-favicon.svg';
+export { default as nexusLogoIco } from './assets/images/favicon.ico';
 
 declare const getFiscalPeriod: (date: Date) => {
     fiscalYear: number;
@@ -378,6 +379,21 @@ interface TooltipProps extends Omit<TooltipProps$1, "title"> {
 }
 declare const Tooltip: ({ title, children, ...rest }: TooltipProps) => react_jsx_runtime.JSX.Element;
 
+declare const getFaviconUrls: (versioned?: boolean) => {
+    svg: string;
+    ico: string;
+};
+
+type FaviconLinksProps = {
+    /** Append version query param for cache-busting (default true) */
+    versioned?: boolean;
+    /** Optional additional attributes to add to the svg link */
+    svgAttrs?: react__default.LinkHTMLAttributes<HTMLLinkElement>;
+    /** Optional additional attributes to add to the ico link */
+    icoAttrs?: react__default.LinkHTMLAttributes<HTMLLinkElement>;
+};
+declare const FaviconLinks: react__default.FC<FaviconLinksProps>;
+
 type ThemeMode = "light" | "dark";
 type ModeTokens = {
     background: {
@@ -483,5 +499,5 @@ declare const getGradientBorderStyles: (theme: Theme$1, options?: GradientBorder
 declare const leftPipe: SxProps$2<Theme$1>;
 declare const expandableText: (isExpanded: boolean) => SxProps$2<Theme$1>;
 
-export { AccordionGroup, AccordionGroupItem, AccordionSingle, ActionBar, ActionBarTitle, AiButton, AiCard, AiGlassCard, AiGlassPaper, AiPaper, Body1, Body2, Box, ButtonBase, Caption, Card, CheckboxGroup, Chip, Collapse, Dialog, DialogActions, DialogContent, DialogContentText, DialogTitle, Divider, GlassCard, GlassPaper, GlassPaperAsync, GreenWaveBackground, H1, H2, H3, H4, IconButton, LoadingSpinnerNexus, LocationMultiSelect, LogoOptions, MuiAppThemeProvider, NexusDataGrid, NexusHome, NexusLogo, Paper, PrimaryButton, PrimaryButtonLink, RagChip, RagDot, SearchInput, SecondaryButton, SecondaryButtonLink, SideBlade, Skeleton, SkillChip, Stack, StatusChip, Tab, Tabs, TextField, ThemeModeProvider, ThemeToggle, Tooltip, colours, createSageTheme, expandableText, fontSageHeadline, fontSageText, fontSageUI, formatDate, getFiscalPeriod, getGradientBorderStyles, getModeTokens, gradients, leftPipe, useThemeMode, useTokens };
+export { AccordionGroup, AccordionGroupItem, AccordionSingle, ActionBar, ActionBarTitle, AiButton, AiCard, AiGlassCard, AiGlassPaper, AiPaper, Body1, Body2, Box, ButtonBase, Caption, Card, CheckboxGroup, Chip, Collapse, Dialog, DialogActions, DialogContent, DialogContentText, DialogTitle, Divider, FaviconLinks, GlassCard, GlassPaper, GlassPaperAsync, GreenWaveBackground, H1, H2, H3, H4, IconButton, LoadingSpinnerNexus, LocationMultiSelect, LogoOptions, MuiAppThemeProvider, NexusDataGrid, NexusHome, NexusLogo, Paper, PrimaryButton, PrimaryButtonLink, RagChip, RagDot, SearchInput, SecondaryButton, SecondaryButtonLink, SideBlade, Skeleton, SkillChip, Stack, StatusChip, Tab, Tabs, TextField, ThemeModeProvider, ThemeToggle, Tooltip, colours, createSageTheme, expandableText, fontSageHeadline, fontSageText, fontSageUI, formatDate, getFaviconUrls, getFiscalPeriod, getGradientBorderStyles, getModeTokens, gradients, leftPipe, useThemeMode, useTokens };
 export type { AccordionGroupItemProps, AccordionGroupProps, AccordionSingleProps, AiButtonProps, AiCardProps, AiGlassCardProps, AiGlassPaperProps, AiPaperProps, CardProps, CardTrend, GlassCardProps, GlassPaperAsyncProps, GlassPaperProps, GradientBorderOptions, GreenWaveBackgroundProps, IconButtonProps, LoadingSpinnerNexusProps, ModeTokens, PrimaryButtonLinkProps, PrimaryButtonProps, SecondaryButtonLinkProps, SecondaryButtonProps, SideBladeProps, SkeletonProps, ThemeMode, TooltipProps };

package/dist/index.mjs

@@ -1 +1 @@
-export{formatDate,getFiscalPeriod}from"./components/DateFormats.mjs";export{ActionBarTitle,Body1,Body2,Caption,H1,H2,H3,H4}from"./components/Typography.mjs";export{ActionBar}from"./components/ActionBar.mjs";export{AccordionGroup,AccordionGroupItem}from"./components/AccordionGroup.mjs";export{AccordionSingle}from"./components/AccordionSingle.mjs";export{AiButton}from"./components/AiButton.mjs";export{AiCard}from"./components/AiCard.mjs";export{AiGlassCard}from"./components/AiGlassCard.mjs";export{AiPaper}from"./components/AiPaper.mjs";export{AiGlassPaper}from"./components/AiGlassPaper.mjs";export{Box}from"./components/Box.mjs";export{Collapse}from"./components/Collapse.mjs";export{NexusDataGrid}from"./components/NexusDataGrid.mjs";export{ButtonBase}from"./components/ButtonBase.mjs";export{Card}from"./components/Card.mjs";export{CheckboxGroup}from"./components/CheckboxGroup.mjs";export{Chip}from"./components/Chip.mjs";export{Dialog,DialogActions,DialogContent,DialogContentText,DialogTitle}from"./components/Dialog.mjs";export{Divider}from"./components/Divider.mjs";export{GlassCard}from"./components/GlassCard.mjs";export{GlassPaper}from"./components/GlassPaper.mjs";export{GlassPaperAsync}from"./components/GlassPaperAsync.mjs";export{GreenWaveBackground}from"./components/GreenWaveBackground.mjs";export{IconButton}from"./components/IconButton.mjs";export{LoadingSpinnerNexus}from"./components/LoadingSpinnerNexus.mjs";export{LocationMultiSelect}from"./components/LocationMultiSelect.mjs";export{LogoOptions}from"./components/LogoOptions/index.mjs";export{NexusHome}from"./components/NexusHome.mjs";export{default as NexusLogo}from"./components/NexusLogo.mjs";export{Paper}from"./components/Paper.mjs";export{PrimaryButton}from"./components/PrimaryButton.mjs";export{PrimaryButtonLink}from"./components/PrimaryButtonLink.mjs";export{SecondaryButton}from"./components/SecondaryButton.mjs";export{RagDot}from"./components/RagDot.mjs";export{RagChip}from"./components/RagChip.mjs";export{SecondaryButtonLink}from"./components/SecondaryButtonLink.mjs";export{SearchInput}from"./components/SearchInput.mjs";export{SideBlade}from"./components/SideBlade.mjs";export{Skeleton}from"./components/Skeleton.mjs";export{SkillChip}from"./components/SkillChip.mjs";export{Stack}from"./components/Stack.mjs";export{StatusChip}from"./components/StatusChip.mjs";export{Tab}from"./components/Tab.mjs";export{Tabs}from"./components/Tabs.mjs";export{TextField}from"./components/TextField.mjs";export{ThemeToggle}from"./components/ThemeToggle.mjs";export{Tooltip}from"./components/Tooltip.mjs";export{default as nexusLogoNode}from"./assets/images/nexus-logo-node.svg.mjs";export{default as nexusLogoFavicon}from"./assets/images/nexus-logo-favicon.svg.mjs";export{createSageTheme}from"./theme/sageTheme.mjs";export{colours,fontSageHeadline,fontSageText,fontSageUI,getModeTokens,gradients}from"./theme/tokens.mjs";export{useTokens}from"./theme/useTokens.mjs";export{default as MuiAppThemeProvider}from"./theme/MuiAppThemeProvider.mjs";export{ThemeModeProvider,useThemeMode}from"./theme/ThemeContext.mjs";export{alpha,useMediaQuery,useTheme}from"@mui/material";export{expandableText,getGradientBorderStyles,leftPipe}from"./theme/sxHelpers.mjs";
+export{formatDate,getFiscalPeriod}from"./components/DateFormats.mjs";export{ActionBarTitle,Body1,Body2,Caption,H1,H2,H3,H4}from"./components/Typography.mjs";export{ActionBar}from"./components/ActionBar.mjs";export{AccordionGroup,AccordionGroupItem}from"./components/AccordionGroup.mjs";export{AccordionSingle}from"./components/AccordionSingle.mjs";export{AiButton}from"./components/AiButton.mjs";export{AiCard}from"./components/AiCard.mjs";export{AiGlassCard}from"./components/AiGlassCard.mjs";export{AiPaper}from"./components/AiPaper.mjs";export{AiGlassPaper}from"./components/AiGlassPaper.mjs";export{Box}from"./components/Box.mjs";export{Collapse}from"./components/Collapse.mjs";export{NexusDataGrid}from"./components/NexusDataGrid.mjs";export{ButtonBase}from"./components/ButtonBase.mjs";export{Card}from"./components/Card.mjs";export{CheckboxGroup}from"./components/CheckboxGroup.mjs";export{Chip}from"./components/Chip.mjs";export{Dialog,DialogActions,DialogContent,DialogContentText,DialogTitle}from"./components/Dialog.mjs";export{Divider}from"./components/Divider.mjs";export{GlassCard}from"./components/GlassCard.mjs";export{GlassPaper}from"./components/GlassPaper.mjs";export{GlassPaperAsync}from"./components/GlassPaperAsync.mjs";export{GreenWaveBackground}from"./components/GreenWaveBackground.mjs";export{IconButton}from"./components/IconButton.mjs";export{LoadingSpinnerNexus}from"./components/LoadingSpinnerNexus.mjs";export{LocationMultiSelect}from"./components/LocationMultiSelect.mjs";export{LogoOptions}from"./components/LogoOptions/index.mjs";export{NexusHome}from"./components/NexusHome.mjs";export{default as NexusLogo}from"./components/NexusLogo.mjs";export{Paper}from"./components/Paper.mjs";export{PrimaryButton}from"./components/PrimaryButton.mjs";export{PrimaryButtonLink}from"./components/PrimaryButtonLink.mjs";export{SecondaryButton}from"./components/SecondaryButton.mjs";export{RagDot}from"./components/RagDot.mjs";export{RagChip}from"./components/RagChip.mjs";export{SecondaryButtonLink}from"./components/SecondaryButtonLink.mjs";export{SearchInput}from"./components/SearchInput.mjs";export{SideBlade}from"./components/SideBlade.mjs";export{Skeleton}from"./components/Skeleton.mjs";export{SkillChip}from"./components/SkillChip.mjs";export{Stack}from"./components/Stack.mjs";export{StatusChip}from"./components/StatusChip.mjs";export{Tab}from"./components/Tab.mjs";export{Tabs}from"./components/Tabs.mjs";export{TextField}from"./components/TextField.mjs";export{ThemeToggle}from"./components/ThemeToggle.mjs";export{Tooltip}from"./components/Tooltip.mjs";export{default as nexusLogoNode}from"./assets/images/nexus-logo-node.svg.mjs";export{default as nexusLogoFavicon}from"./assets/images/nexus-logo-favicon.svg.mjs";export{default as nexusLogoIco}from"./assets/images/favicon.ico.mjs";export{getFaviconUrls}from"./assets/images/urls.mjs";export{FaviconLinks}from"./components/FaviconLinks.mjs";export{createSageTheme}from"./theme/sageTheme.mjs";export{colours,fontSageHeadline,fontSageText,fontSageUI,getModeTokens,gradients}from"./theme/tokens.mjs";export{useTokens}from"./theme/useTokens.mjs";export{default as MuiAppThemeProvider}from"./theme/MuiAppThemeProvider.mjs";export{ThemeModeProvider,useThemeMode}from"./theme/ThemeContext.mjs";export{alpha,useMediaQuery,useTheme}from"@mui/material";export{expandableText,getGradientBorderStyles,leftPipe}from"./theme/sxHelpers.mjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sage-nexus-ui",
-  "version": "1.3.6",
+  "version": "1.3.7",
   "description": "Nexus core components",
   "license": "ISC",
   "author": "emsmart-sage",
@@ -23,6 +23,7 @@
   ],
   "sideEffects": false,
   "scripts": {
+    "prebuild": "node scripts/write-version.mjs",
     "build": "node -e \"require('fs').rmSync('dist', {recursive:true, force:true})\" && rollup -c",
     "build-storybook": "storybook build",
     "generate-favicon": "node scripts/generate-favicon.mjs",
@@ -54,6 +55,7 @@
     "@mui/material": "^9.0.1",
     "@mui/x-data-grid": "^9.0.0",
     "@rollup/plugin-alias": "^6.0.0",
+    "@rollup/plugin-json": "^5.0.0",
     "@rollup/plugin-commonjs": "^29.0.2",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^1.0.0",

package/readme.md

@@ -1 +1,109 @@
 Small component library for personal use.
+
+## Favicon usage
+
+This package exports the favicon assets and a small helper to make adding
+favicon links in consuming apps trivial.
+
+Files available in package:
+
+- `nexus-logo-favicon.svg` — modern SVG favicon
+- `favicon.ico` — multi-size ICO (legacy support)
+
+Quick copy approach (recommended):
+
+1. Add and then run these asset copy scripts in the consuming project's package.json:
+
+```json
+"scripts": {
+	"copy-sage-assets": "cpx \"node_modules/sage-nexus-ui/dist/assets/images/*\" public/assets/sage-nexus-ui/",
+	"postinstall": "npm run copy-sage-assets"
+}
+```
+
+2. Add links in your HTML head:
+
+```html
+<link
+  rel="icon"
+  type="image/svg+xml"
+  href="/assets/sage-nexus-ui/nexus-logo-favicon.svg"
+/>
+<link rel="icon" href="/assets/sage-nexus-ui/favicon.ico" />
+```
+
+Or, use the React helper exported by this package:
+
+```tsx
+import { FaviconLinks } from "sage-nexus-ui";
+
+function AppHead() {
+  return <FaviconLinks />; // adds versioned SVG and ICO links
+}
+```
+
+### Next.js example
+
+If you use Next.js (Pages or App router), you can copy the built assets into your `public/` folder and render the helper component from the app head so the favicon is present on first render.
+
+1. Copy assets during install/build (example `package.json` scripts in the consuming app):
+
+```json
+"scripts": {
+  "copy-sage-assets": "cpx \"node_modules/sage-nexus-ui/dist/assets/images/*\" public/assets/sage-nexus-ui/",
+  "postinstall": "npm run copy-sage-assets"
+}
+```
+
+2. Pages router (`pages/_document.tsx`) example — server-side rendered so the links are available immediately:
+
+```tsx
+// pages/_document.tsx
+import Document, { Html, Head, Main, NextScript } from "next/document";
+import { FaviconLinks } from "sage-nexus-ui";
+
+class MyDocument extends Document {
+  render() {
+    return (
+      <Html>
+        <Head>
+          <FaviconLinks />
+        </Head>
+        <body>
+          <Main />
+          <NextScript />
+        </body>
+      </Html>
+    );
+  }
+}
+
+export default MyDocument;
+```
+
+3. App router (`app/layout.tsx`) example:
+
+```tsx
+// app/layout.tsx
+import { FaviconLinks } from "sage-nexus-ui";
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html>
+      <head>
+        <FaviconLinks />
+      </head>
+      <body>{children}</body>
+    </html>
+  );
+}
+```
+
+Notes:
+
+- Copying assets into `public/` ensures the files are served as static assets (no runtime JS required) and avoids a flash-of-default-favicon.
+- The `FaviconLinks` helper uses versioned URLs by default to help cache-busting when you publish a new library version.