@streamoid/ui 0.5.1 → 0.6.0

package/dist/index.d.ts

@@ -205,12 +205,14 @@ interface IScPlanDetailsCardProps extends React.HTMLAttributes<HTMLDivElement> {
     planCredits?: string;
     planPrice?: string;
     badgeText?: string;
+    badgeSubText?: string;
     currentPlanLabel?: string;
     upgradeButtonText?: string;
+    isLoading?: boolean;
     onUpgrade?: () => void;
     className?: string;
 }
-declare const ScPlanDetailsCard: ({ planName, planCredits, planPrice, badgeText, currentPlanLabel, upgradeButtonText, onUpgrade, className, ...props }: IScPlanDetailsCardProps) => JSX.Element;
+declare const ScPlanDetailsCard: ({ planName, planCredits, planPrice, badgeText, badgeSubText, currentPlanLabel, upgradeButtonText, isLoading, onUpgrade, className, ...props }: IScPlanDetailsCardProps) => JSX.Element;
 
 interface IScProfileProps extends React.HTMLAttributes<HTMLDivElement> {
     name?: string;
@@ -310,6 +312,10 @@ interface StreamoidSidebarProps {
     profile?: SidebarProfileConfig;
     versionText?: string;
     toggleIcon?: ReactNode | ((expanded: boolean) => ReactNode);
+    /** Footer = profile (flex-1) + a SEPARATE collapse-toggle button beside it,
+     *  with no version footer. Each is its own interactive unit. Expanded layout
+     *  only; collapsed is unaffected. */
+    toggleInProfile?: boolean;
     hideFooter?: boolean;
     preFooterContent?: ReactNode;
     bodyContent?: ReactNode;
@@ -322,7 +328,7 @@ interface StreamoidSidebarProps {
     /** Explicit state override per top item id — takes priority over activeItemId/highlightedItemIds for top items */
     topItemStates?: Record<string, "default" | "active" | "hover" | "default-highlight" | "default-active">;
 }
-declare function StreamoidSidebar({ expanded, onToggle, config, iconMap, activeItemId, highlightedItemIds, onItemSelect, moreIcon, onMoreClick, expandedLogo, collapsedLogo, profile, versionText, toggleIcon, hideFooter, preFooterContent, bodyContent, showBody, isMobile, className, style, topItems, topItemStates, }: StreamoidSidebarProps): react_jsx_runtime.JSX.Element;
+declare function StreamoidSidebar({ expanded, onToggle, config, iconMap, activeItemId, highlightedItemIds, onItemSelect, moreIcon, onMoreClick, expandedLogo, collapsedLogo, profile, versionText, toggleIcon, toggleInProfile, hideFooter, preFooterContent, bodyContent, showBody, isMobile, className, style, topItems, topItemStates, }: StreamoidSidebarProps): react_jsx_runtime.JSX.Element;
 
 interface ArtifaxMenuItem {
     id: string;
@@ -392,6 +398,64 @@ interface IScArtifaxSidebarProps {
 }
 declare const ScArtifaxSidebar: ({ expanded, onToggle, sections, iconMap, activeItemId, onItemSelect, expandedLogo, collapsedLogo, creditWarning, assistantCta, profile, toggleIcon, openSections, onSectionToggle, className, style, }: IScArtifaxSidebarProps) => JSX.Element;
 
+interface CatalogixNavItem {
+    id: string;
+    label: string;
+    iconKey: string;
+}
+interface CatalogixSidebarIconContext {
+    active: boolean;
+    expanded: boolean;
+}
+type CatalogixSidebarIconRenderer = (context: CatalogixSidebarIconContext) => ReactNode;
+type CatalogixSidebarIconMap = Record<string, ReactNode | CatalogixSidebarIconRenderer>;
+interface CatalogixSidebarProfile {
+    name: string;
+    subtitle?: string;
+    avatar?: ReactNode;
+    onClick?: () => void;
+}
+interface CatalogixSidebarCreditWarning {
+    availableCredits: number;
+    remainingPct: number;
+    level?: "warning" | "danger";
+    onBuyCredits: () => void;
+    onCollapsedClick?: () => void;
+}
+interface CatalogixSwitchApp {
+    id: string;
+    name: string;
+    description?: string;
+    icon?: ReactNode;
+    onClick?: () => void;
+}
+interface IScCatalogixSidebarProps {
+    expanded: boolean;
+    onToggle: () => void;
+    /** Nav items below the logo. Defaults to Stores / AI Training / Insights. */
+    items?: CatalogixNavItem[];
+    /** Maps each item's iconKey to an icon (node or render fn). Defaults supply
+     *  Stores/AI Training/Insights icons; override per the product's set. */
+    iconMap?: CatalogixSidebarIconMap;
+    activeItemId?: string;
+    onItemSelect?: (item: CatalogixNavItem) => void;
+    /** Other products shown inline below the logo when the switch chip is
+     *  clicked (the same "switch apps" list used across the sidebars). */
+    switchApps?: CatalogixSwitchApp[];
+    /** Fires (in addition to toggling the inline list) when the switch chip is
+     *  clicked — e.g. to lazy-load the product list. */
+    onLogoClick?: () => void;
+    /** Logo nodes. Default to the built-in Catalogix wordmark logo unit. */
+    expandedLogo?: ReactNode;
+    collapsedLogo?: ReactNode;
+    profile?: CatalogixSidebarProfile;
+    creditWarning?: CatalogixSidebarCreditWarning | null;
+    toggleIcon?: ReactNode | ((expanded: boolean) => ReactNode);
+    className?: string;
+    style?: CSSProperties;
+}
+declare const ScCatalogixSidebar: ({ expanded, onToggle, items, iconMap, activeItemId, onItemSelect, switchApps, onLogoClick, expandedLogo, collapsedLogo, profile, creditWarning, toggleIcon, className, style, }: IScCatalogixSidebarProps) => JSX.Element;
+
 interface IScGuideProps {
     /** Heading text. */
     title?: ReactNode;
@@ -422,13 +486,42 @@ interface IScGuideProps {
 }
 declare const ScGuide: ({ title, description, skipLabel, nextLabel, nextIcon, stepLabel, onSkip, onNext, hideSkip, hideNext, disabled, className, style, }: IScGuideProps) => JSX.Element;
 
+interface MarkPath {
+    d: string;
+    fillRule?: "evenodd" | "nonzero";
+    clipRule?: "evenodd" | "nonzero";
+}
+interface Wordmark {
+    viewBox: string;
+    width: number;
+    paths: MarkPath[];
+}
+declare const WORDMARKS: Record<string, Wordmark>;
+type SidebarProduct = keyof typeof WORDMARKS;
+/** Full product wordmark (expanded sidebar). */
+declare function ProductWordmark({ product, style, }: {
+    product: SidebarProduct;
+    style?: CSSProperties;
+}): JSX.Element | null;
+/** Square product icon (collapsed sidebar). Returns null if the product has no
+ *  collapsed mark defined yet. */
+declare function ProductCollapsedMark({ product, style, }: {
+    product: SidebarProduct;
+    style?: CSSProperties;
+}): JSX.Element | null;
+/** True when the product has a dedicated collapsed icon. */
+declare function hasCollapsedMark(product: SidebarProduct): boolean;
+
 interface IScSideBarLogoUnitProps {
     /** "expanded" renders the merged wordmark + switcher row.
      *  "collapsed" renders a bare clickable product icon. */
     state?: "expanded" | "collapsed";
     /** In expanded state: the stacked "Product / Streamoid" wordmark `<img>`.
-     *  In collapsed state: the square product icon `<img>`. */
+     *  In collapsed state: the square product icon `<img>`. Overrides `product`. */
     wordmark?: ReactNode;
+    /** Built-in branded wordmark to render when `wordmark` is not supplied
+     *  (e.g. "CXO", "Catalogix"). The mark follows the surrounding text color. */
+    product?: SidebarProduct;
     /** Click handler for the whole row (wordmark + switcher are one click
      *  target now — matches the design intent). */
     onClick?: () => void;
@@ -452,7 +545,7 @@ interface IScSideBarLogoUnitProps {
     className?: string;
     style?: CSSProperties;
 }
-declare const ScSideBarLogoUnit: ({ state, wordmark, onClick, onSwitchClick, switchAriaLabel, hideSwitch, hover, disabled, className, style, }: IScSideBarLogoUnitProps) => JSX.Element;
+declare const ScSideBarLogoUnit: ({ state, wordmark, product, onClick, onSwitchClick, switchAriaLabel, hideSwitch, hover, disabled, className, style, }: IScSideBarLogoUnitProps) => JSX.Element;
 
 interface IScSidebarMenuProps extends React.HTMLAttributes<HTMLDivElement> {
     icon?: JSX.Element;
@@ -465,6 +558,18 @@ interface IScSidebarMenuProps extends React.HTMLAttributes<HTMLDivElement> {
 }
 declare const ScSidebarMenu: ({ icon, state, variant, className, text, moreIcon, onMoreClick, ...props }: IScSidebarMenuProps) => JSX.Element;
 
+interface IScSidebarSwitchMenuProps extends React.HTMLAttributes<HTMLDivElement> {
+    icon?: ReactNode;
+    state?: "default" | "active" | "hover" | "default-highlight" | "default-active";
+    variant?: "expanded" | "collapsed";
+    className?: string;
+    text?: string;
+    description?: string;
+    moreIcon?: ReactNode;
+    onMoreClick?: (e: React.MouseEvent) => void;
+}
+declare const ScSidebarSwitchMenu: ({ icon, state, variant, className, text, description, moreIcon, onMoreClick, ...props }: IScSidebarSwitchMenuProps) => JSX.Element;
+
 interface IScSidebarProfileProps extends React.HTMLAttributes<HTMLDivElement> {
     state?: "default" | "hover";
     variant?: "expanded" | "collapsed";
@@ -1069,11 +1174,13 @@ interface IScPlanDetailsCardMobileProps extends React.HTMLAttributes<HTMLDivElem
     planCredits?: string;
     planPrice?: string;
     badgeText?: string;
+    badgeSubText?: string;
     currentPlanLabel?: string;
     upgradeButtonText?: string;
+    isLoading?: boolean;
     onUpgrade?: () => void;
     className?: string;
 }
-declare const ScPlanDetailsCardMobile: ({ planName, planCredits, planPrice, badgeText, currentPlanLabel, upgradeButtonText, onUpgrade, className, ...props }: IScPlanDetailsCardMobileProps) => JSX.Element;
+declare const ScPlanDetailsCardMobile: ({ planName, planCredits, planPrice, badgeText, badgeSubText, currentPlanLabel, upgradeButtonText, isLoading, onUpgrade, className, ...props }: IScPlanDetailsCardMobileProps) => JSX.Element;
 
-export { type ArtifaxMenuItem, type ArtifaxSection, type ArtifaxSidebarAssistantCta, type ArtifaxSidebarCreditWarning, type ArtifaxSidebarIconContext, type ArtifaxSidebarIconMap, type ArtifaxSidebarIconRenderer, type ArtifaxSidebarProfile, CreditWarningBanner, type CreditWarningBannerProps, type IInvoiceHistoryMobileProps, type IScAccessProps, type IScAppCardProps, type IScAppCardV3Props, type IScAppFieldProps, type IScAppListingCardProps, type IScArtifaxInviteProps, type IScArtifaxSidebarProps, type IScBadgesProps, type IScBillingHistoryHeaderProps, type IScBillingHistoryTableListProps, type IScBillingLogsTableHeaderProps, type IScBillingLogsTableListProps, type IScBriefCardProps, type IScButtonProps, type IScCalendarDateCompsProps, type IScCalendarProps, type IScCatalogixInviteProps, type IScCheckFieldProps, type IScCheckboxProps, type IScCreditsUsageCardMobileProps, type IScCreditsUsageCardProps, type IScFieldButtonProps, type IScGoogleSignInProps, type IScGuideProps, type IScHDividerProps, type IScHeaderProps, type IScImageFieldProps, type IScIntialProfileCoverProps, type IScLogoUnitProps, type IScMenuOptionsProps, type IScMobileBottomActionProps, type IScMobileTopNavProps, type IScOnlyFieldProps, type IScOnlyIconProps, type IScPairtextProps, type IScPendingActionProps, type IScPhtogenixInviteProps, type IScPlanCardProps, type IScPlanDetailsCardMobileProps, type IScPlanDetailsCardProps, type IScPopUpMenuProps, type IScProfileImageUpdateProps, type IScProfileOptionsProps, type IScProfileProps, type IScProfileSettingsCompProps, type IScProfileV2MobileProps, type IScProgressBarProps, type IScQuickPromptProps, type IScRadioProps, type IScReferralCardMobileProps, type IScReferralTableHeaderProps, type IScReferralTableListProps, type IScRoleMobileProps, type IScRoleProps, type IScSettingsNavProps, type IScSettingsTabCompProps, type IScSideBarLogoUnitProps, type IScSidebarIconsProps, type IScSidebarMenuProps, type IScSidebarProfileProps, type IScSidebarProps, type IScSliderProps, type IScStrLogoProps, type IScTabCompProps, type IScTabFieldProps, type IScTabSwitcherProps, type IScTableHeaderProps, type IScTableListMobileProps, type IScTableListProps, type IScTextFieldProps, type IScToggleSwitchProps, type IScVDividerProps, type IScVersionProps, type IScWorkspaceCardProps, type IScWorkspaceSettingsMobileProps, type IScWorkspaceSwitchMobileProps, type IScWorkspaceSwitchMobileV2Props, type IUsageHistoryMobileProps, InvoiceHistoryMobile, NscWorkspaceSwitch, type PlanFeatureSection, ScAccess, ScAppCard, ScAppCardV3, ScAppField, ScAppListingCard, ScArtifaxInvite, ScArtifaxSidebar, ScBadges, ScBillingHistoryHeader, ScBillingHistoryTableList, ScBillingLogsTableHeader, ScBillingLogsTableList, ScBriefCard, ScButton, ScCalendar, ScCalendarDateComps, ScCatalogixInvite, ScCheckField, ScCheckbox, ScCreditsUsageCard, ScCreditsUsageCardMobile, ScDp, type ScDpProps, ScFieldButton, ScGoogleSignIn, ScGuide, ScHDivider, ScHeader, ScImageField, ScIntialProfileCover, ScLogoUnit, ScMenuOptions, ScMobileBottomAction, ScMobileTopNav, ScOnlyField, ScOnlyIcon, ScPairtext, ScPendingAction, ScPhtogenixInvite, ScPlanCard, ScPlanDetailsCard, ScPlanDetailsCardMobile, ScPopUpMenu, ScProfile, ScProfileImageUpdate, ScProfileOptions, ScProfileSettingsComp, ScProfileV2Mobile, ScProgressBar, ScQuickPrompt, ScRadio, ScReferralCardMobile, ScReferralTableHeader, ScReferralTableList, ScRole, ScRoleMobile, ScSettingsNav, ScSettingsTabComp, ScSideBarLogoUnit, ScSidebar, ScSidebarIcons, ScSidebarMenu, ScSidebarProfile, ScSlider, ScStrLogo, ScTabComp, ScTabField, ScTabSwitcher, ScTableHeader, ScTableList, ScTableListMobile, ScTextField, ScToggleSwitch, ScVDivider, ScVersion, ScWorkspaceCard, ScWorkspaceSettingsMobile, ScWorkspaceSwitchCard, type ScWorkspaceSwitchCardProps, ScWorkspaceSwitchMobile, ScWorkspaceSwitchMobileV2, type SidebarConfig, type SidebarIconContext, type SidebarIconMap, type SidebarIconRenderer, type SidebarMenuItemConfig, type SidebarProfileConfig, type SidebarSectionConfig, StreamoidSidebar, type StreamoidSidebarProps, StreamoidWorkspaceSwitcher, type StreamoidWorkspaceSwitcherProps, UsageHistoryMobile, type WorkspaceSwitcherConfig, type WorkspaceSwitcherItem };
+export { type ArtifaxMenuItem, type ArtifaxSection, type ArtifaxSidebarAssistantCta, type ArtifaxSidebarCreditWarning, type ArtifaxSidebarIconContext, type ArtifaxSidebarIconMap, type ArtifaxSidebarIconRenderer, type ArtifaxSidebarProfile, type CatalogixNavItem, type CatalogixSidebarCreditWarning, type CatalogixSidebarIconContext, type CatalogixSidebarIconMap, type CatalogixSidebarIconRenderer, type CatalogixSidebarProfile, type CatalogixSwitchApp, CreditWarningBanner, type CreditWarningBannerProps, type IInvoiceHistoryMobileProps, type IScAccessProps, type IScAppCardProps, type IScAppCardV3Props, type IScAppFieldProps, type IScAppListingCardProps, type IScArtifaxInviteProps, type IScArtifaxSidebarProps, type IScBadgesProps, type IScBillingHistoryHeaderProps, type IScBillingHistoryTableListProps, type IScBillingLogsTableHeaderProps, type IScBillingLogsTableListProps, type IScBriefCardProps, type IScButtonProps, type IScCalendarDateCompsProps, type IScCalendarProps, type IScCatalogixInviteProps, type IScCatalogixSidebarProps, type IScCheckFieldProps, type IScCheckboxProps, type IScCreditsUsageCardMobileProps, type IScCreditsUsageCardProps, type IScFieldButtonProps, type IScGoogleSignInProps, type IScGuideProps, type IScHDividerProps, type IScHeaderProps, type IScImageFieldProps, type IScIntialProfileCoverProps, type IScLogoUnitProps, type IScMenuOptionsProps, type IScMobileBottomActionProps, type IScMobileTopNavProps, type IScOnlyFieldProps, type IScOnlyIconProps, type IScPairtextProps, type IScPendingActionProps, type IScPhtogenixInviteProps, type IScPlanCardProps, type IScPlanDetailsCardMobileProps, type IScPlanDetailsCardProps, type IScPopUpMenuProps, type IScProfileImageUpdateProps, type IScProfileOptionsProps, type IScProfileProps, type IScProfileSettingsCompProps, type IScProfileV2MobileProps, type IScProgressBarProps, type IScQuickPromptProps, type IScRadioProps, type IScReferralCardMobileProps, type IScReferralTableHeaderProps, type IScReferralTableListProps, type IScRoleMobileProps, type IScRoleProps, type IScSettingsNavProps, type IScSettingsTabCompProps, type IScSideBarLogoUnitProps, type IScSidebarIconsProps, type IScSidebarMenuProps, type IScSidebarProfileProps, type IScSidebarProps, type IScSidebarSwitchMenuProps, type IScSliderProps, type IScStrLogoProps, type IScTabCompProps, type IScTabFieldProps, type IScTabSwitcherProps, type IScTableHeaderProps, type IScTableListMobileProps, type IScTableListProps, type IScTextFieldProps, type IScToggleSwitchProps, type IScVDividerProps, type IScVersionProps, type IScWorkspaceCardProps, type IScWorkspaceSettingsMobileProps, type IScWorkspaceSwitchMobileProps, type IScWorkspaceSwitchMobileV2Props, type IUsageHistoryMobileProps, InvoiceHistoryMobile, NscWorkspaceSwitch, type PlanFeatureSection, ProductCollapsedMark, ProductWordmark, ScAccess, ScAppCard, ScAppCardV3, ScAppField, ScAppListingCard, ScArtifaxInvite, ScArtifaxSidebar, ScBadges, ScBillingHistoryHeader, ScBillingHistoryTableList, ScBillingLogsTableHeader, ScBillingLogsTableList, ScBriefCard, ScButton, ScCalendar, ScCalendarDateComps, ScCatalogixInvite, ScCatalogixSidebar, ScCheckField, ScCheckbox, ScCreditsUsageCard, ScCreditsUsageCardMobile, ScDp, type ScDpProps, ScFieldButton, ScGoogleSignIn, ScGuide, ScHDivider, ScHeader, ScImageField, ScIntialProfileCover, ScLogoUnit, ScMenuOptions, ScMobileBottomAction, ScMobileTopNav, ScOnlyField, ScOnlyIcon, ScPairtext, ScPendingAction, ScPhtogenixInvite, ScPlanCard, ScPlanDetailsCard, ScPlanDetailsCardMobile, ScPopUpMenu, ScProfile, ScProfileImageUpdate, ScProfileOptions, ScProfileSettingsComp, ScProfileV2Mobile, ScProgressBar, ScQuickPrompt, ScRadio, ScReferralCardMobile, ScReferralTableHeader, ScReferralTableList, ScRole, ScRoleMobile, ScSettingsNav, ScSettingsTabComp, ScSideBarLogoUnit, ScSidebar, ScSidebarIcons, ScSidebarMenu, ScSidebarProfile, ScSidebarSwitchMenu, ScSlider, ScStrLogo, ScTabComp, ScTabField, ScTabSwitcher, ScTableHeader, ScTableList, ScTableListMobile, ScTextField, ScToggleSwitch, ScVDivider, ScVersion, ScWorkspaceCard, ScWorkspaceSettingsMobile, ScWorkspaceSwitchCard, type ScWorkspaceSwitchCardProps, ScWorkspaceSwitchMobile, ScWorkspaceSwitchMobileV2, type SidebarConfig, type SidebarIconContext, type SidebarIconMap, type SidebarIconRenderer, type SidebarMenuItemConfig, type SidebarProduct, type SidebarProfileConfig, type SidebarSectionConfig, StreamoidSidebar, type StreamoidSidebarProps, StreamoidWorkspaceSwitcher, type StreamoidWorkspaceSwitcherProps, UsageHistoryMobile, type WorkspaceSwitcherConfig, type WorkspaceSwitcherItem, hasCollapsedMark };