@redsift/products 12.5.2-muiv7 → 12.5.2

package/signal-cards.d.ts

@@ -1,8 +1,118 @@
 import * as _redsift_design_system from '@redsift/design-system';
-import { JmapProps, InvestigateProps, SpfProps, DmarcProps, DkimProps, DnsSecurityProps, ExtsecrepProps, MtaProps, DomainAnalyzerDkimProps, DomainAnalyzerSpfProps, CardStatus, TlsProps, EhloProps, FcrdnsProps, EhloCheckProps, RecommendationsData } from '@redsift/signal-logic';
+import { RecommendationsData, JmapProps, DmarcProps, DkimProps, SpfProps, EhloProps, FcrdnsProps, EhloCheckProps, TlsProps, CardStatus, DomainAnalyzerSpfProps, DomainAnalyzerDkimProps, MtaProps, ExtsecrepProps, DnsSecurityProps, InvestigateProps } from '@redsift/signal-logic';
 export { BIMI_CHECKER_SIGNAL_TYPES, BimiCheckerSignalType, CARD_STATUS, DOMAIN_ANALYZER_SIGNAL_TYPES, DomainAnalyzerSignalType, PUBLIC_INVESTIGATE_SIGNAL_TYPES, PublicInvestigateSignalType, RecommendationSignal, RecommendationsAnalysis, RecommendationsData, SIGNAL_TYPES, SignalType, getSignalStatus } from '@redsift/signal-logic';
 import react, { ComponentProps, ReactNode } from 'react';
 
+type SignalData = {
+    signalType: string;
+    jmap?: {
+        extsecrep?: Record<string, any>;
+        [key: string]: unknown;
+    };
+    shortDescription?: unknown;
+    [key: string]: unknown;
+};
+type ErrorLike = {
+    name?: string;
+    message?: string;
+    stack?: string;
+};
+type CardEnabledOverrides = Record<string, boolean | undefined>;
+interface SignalCardListProps extends Omit<ComponentProps<'div'>, 'children'> {
+    /** Array of signal data objects containing DMARC, DKIM, SPF information */
+    signals?: SignalData[];
+    /** Error object to display if signal loading fails */
+    error?: ErrorLike | null;
+    /** Map of signal types to enabled/disabled state */
+    isCardEnabledMap?: CardEnabledOverrides;
+    /** Signal types to display in the priority section (shown first). Defaults to DMARC, DKIM, SPF */
+    prioritySignalTypes?: string[];
+    /** Initial selected signal type for external selection control */
+    initialSelectedSignalType?: string | null;
+    /** Callback when a signal card is selected */
+    onSelectSignalType?: (signalType: string) => void;
+    /** Custom header renderer for adding content at the top of each card, after the title */
+    renderCardHeader?: (signal: SignalData) => React.ReactNode;
+    /** Override the promo banner button href on all cards (e.g. to add UTM parameters). Only used when renderCardHeader is not provided. Defaults to the OnDMARC signup URL (`https://iam.redsift.cloud/signup?redirectapp=cloud&product=ondmarc`). */
+    cardPromoHref?: string;
+    /** Custom footer renderer for adding content at the bottom of each card */
+    renderCardFooter?: (signal: SignalData) => React.ReactNode;
+    /**
+     * Heading text for the priority signals section.
+     * Defaults to "Required for the selected compliance profile"
+     */
+    prioritySectionHeading?: string;
+    /**
+     * Heading text for the remaining signals section.
+     * Defaults to "Not required for the selected compliance profile"
+     */
+    remainingSectionHeading?: string;
+    /** Use Investigate handbook colors instead of Design System CSS variables */
+    useInvestigateColors?: boolean;
+    /**
+     * Enable collapsible sections inside all child cards.
+     * @default true
+     */
+    isCollapsible?: boolean;
+    /**
+     * Controlled collapsed state for all sections in all child cards.
+     * Used with isCollapsible to manage collapsed state externally.
+     */
+    areAllCollapsed?: boolean;
+    /**
+     * Callback fired when the collapse-all toggle changes in any child card.
+     */
+    onCollapseAll?: (areAllCollapsed: boolean) => void;
+    /**
+     * AI-powered recommendations data including analysis and per-protocol signals.
+     * When provided (and showRecommendations is not false), renders a RecommendationsSummary
+     * section above the signal cards.
+     */
+    recommendations?: RecommendationsData | null;
+    /**
+     * Whether recommendations data is still loading.
+     * When true, shows a skeleton/shimmer placeholder for the recommendations section.
+     */
+    recommendationsLoading?: boolean;
+    /**
+     * Whether to show the recommendations section.
+     * @default true
+     */
+    showRecommendations?: boolean;
+    /**
+     * Structured data for the CTA card in the recommendations section.
+     * The DS owns the layout; the consumer provides the content and click handler.
+     */
+    recommendationsCTA?: {
+        title: string;
+        description: string;
+        buttonLabel: string;
+        onClickCTA: () => void;
+    };
+    /**
+     * Callback when user clicks "See more details" on a status card.
+     * The consumer uses this to scroll to and expand the corresponding signal card.
+     */
+    onExpandSignalCard?: (signalType: string) => void;
+    /**
+     * Callback for the "Check another email" button in the header.
+     * When provided, renders a styled button with a sync icon and translated label.
+     * Only rendered when a checked email is found in the signal data.
+     */
+    onCheckAnotherEmail?: () => void;
+    /**
+     * Render prop for custom action area in the header.
+     * Overrides the default "Check another email" button when provided.
+     * Only rendered when a checked email is found in the signal data.
+     */
+    renderHeaderAction?: () => ReactNode;
+    /**
+     * Whether to show the "Powered by OnDMARC" branding in the header.
+     * @default true
+     */
+    showBranding?: boolean;
+}
+
 /**
  * Common props shared by all signal card components. These cover layout options
  * that ultimately map to `SignalCardNormal`.
@@ -28,148 +138,159 @@ interface SignalCardSharedProps extends Omit<ComponentProps<'div'>, 'children' |
     onCollapseAll?: (areAllCollapsed: boolean) => void;
 }
 
+/**
+ * Extended JMAP props for DMARC card including required extsecrep data
+ */
+interface SignalCardDmarcJmapProps extends JmapProps {
+    extsecrep: {
+        dmarc?: DmarcProps;
+        dkim?: DkimProps | DkimProps[];
+        spf?: SpfProps;
+    };
+}
 /**
  * Component props.
  */
-interface SignalCardGoogleYahooComplianceProps extends SignalCardSharedProps {
-    /**
-     * Domain name (currently not used but maintained for API compatibility)
-     */
-    domain?: string | null;
+interface SignalCardDmarcProps extends SignalCardSharedProps {
     /**
-     * JMAP extsecrep data containing authentication results
+     * JMAP email data containing DMARC, DKIM, SPF information
      */
-    jmap?: JmapProps | null;
+    jmap: SignalCardDmarcJmapProps;
     /**
-     * Investigate data with FCrDNS and EHLO check results
+     * Whether this is being used in domain analyzer mode
      */
-    investigate?: InvestigateProps | null;
+    isDomainAnalyzer?: boolean;
 }
 
+type SpfData = SpfProps;
 /**
  * Component props.
  */
-interface SignalCardUrlsProps extends SignalCardSharedProps {
-    /**
-     * Investigate data containing extracted URLs
-     */
-    investigate?: InvestigateProps | null;
+interface SignalCardSpfProps extends SignalCardSharedProps {
+    /** JMAP email data containing SPF information */
+    jmap: {
+        extsecrep: {
+            spf?: SpfData;
+        };
+    };
 }
 
+type DkimResult = DkimProps;
+type DmarcResult$1 = DmarcProps | null;
 /**
- * External security report data structure
+ * Component props.
  */
-interface ExtsecrepData {
-    /** SPF check data */
-    spf?: SpfProps | null;
-    /** DMARC policy data */
-    dmarc?: DmarcProps | null;
-    /** DKIM signature data - can be array or object */
-    dkim?: DkimProps | DkimProps[] | null;
+interface SignalCardDkimProps extends SignalCardSharedProps {
+    /** JMAP email data containing DKIM, DMARC information */
+    jmap: {
+        extsecrep: {
+            dkim?: DkimResult | DkimResult[] | null;
+            dmarc?: DmarcResult$1;
+        };
+    };
 }
+
 /**
  * Component props.
  */
-interface SignalCardAmpProps extends SignalCardSharedProps {
-    /** JMAP data containing authentication information */
+interface SignalCardFcrdnsProps extends SignalCardSharedProps {
+    /** JMAP data containing EHLO information */
     jmap: {
-        /** External security report with SPF, DMARC, DKIM data */
-        extsecrep: ExtsecrepData;
-        /** From email address information */
-        from?: {
-            email?: string | null;
-        } | null;
+        extsecrep: {
+            ehlo?: EhloProps;
+        };
+    };
+    /** Investigation data with FCrDNS and EHLO check results */
+    investigate?: {
+        fcrdns?: FcrdnsProps | null;
+        ehloCheck?: EhloCheckProps | null;
     };
 }
 
 /**
  * Component props.
  */
-interface SignalCardDnssecProps extends SignalCardSharedProps {
-    /** JMAP data containing DNS security information */
-    jmap?: {
-        extsecrep?: {
-            dnsSecurity?: DnsSecurityProps | null;
-        } | null;
-    } | null;
-    /** Custom short description (overrides default based on result) */
-    shortDescription?: ReactNode;
+interface SignalCardTlsProps extends SignalCardSharedProps {
+    /** JMAP email data containing TLS information */
+    jmap: {
+        extsecrep: {
+            tls?: TlsProps;
+        };
+    };
 }
 
-type ExtsecrepThreatLevel = ExtsecrepProps;
-type FromInfo = {
-    name?: string | null;
-    email?: string | null;
+type DmarcResult = {
+    status?: CardStatus | string | null;
+    errors?: string[] | null;
+};
+type DmarcData$1 = {
+    raw?: string | null;
+    result?: DmarcResult | null;
+    txtExtractedFrom?: string | null;
+    policyDomain?: string | null;
+    fromDomain?: string | null;
+    domainPublished?: string | null;
+};
+type Originator = {
+    domain?: string | null;
+    orgDomain?: string | null;
 } | null;
-/**
- * Component props.
- */
-interface SignalCardThreatInvProps extends SignalCardSharedProps {
-    /** JMAP email data containing threat intelligence information */
+interface SignalCardDmarcDomainProps extends SignalCardSharedProps {
     jmap: {
-        extsecrep: ExtsecrepThreatLevel;
-        from?: FromInfo;
+        extsecrep: {
+            dmarc: DmarcData$1;
+            originator?: Originator;
+        };
     };
-    /** Whether this is being used in domain analyzer mode */
-    isDomainAnalyzer?: boolean;
 }
 
-type SubdoReportEntry = {
+/**
+ * SPF report item from the BIMI Checker API
+ */
+interface SpfReportItem {
+    status?: string;
     message?: string;
     spfError?: string;
-    raw?: string;
-    value?: unknown;
-    details?: unknown;
+}
+interface SpfDetails {
+    raw?: string | string[] | null;
+    status?: string | null;
+    txtExtractedFrom?: string | null;
+    report?: SpfReportItem[];
     [key: string]: unknown;
-};
+}
 /**
- * Component props.
+ * Props for the SignalCardSpfDomain component.
+ *
+ * Simplified SPF Domain Card for BIMI Checker - shows only pass/fail status and raw SPF record.
  */
-interface SignalCardSubdoProps extends SignalCardSharedProps {
+interface SignalCardSpfDomainProps extends SignalCardSharedProps {
     /**
-     * JMAP data containing SPF subdomain takeover report
+     * JMAP data containing SPF authentication results
      */
     jmap?: {
         extsecrep?: {
-            spf?: {
-                domain?: string | null;
-                report?: SubdoReportEntry[] | null;
-            } | null;
-        } | null;
-    } | null;
-}
-
-/**
- * Component props.
- */
-interface SignalCardMtaStsProps extends SignalCardSharedProps {
-    /** JMAP email data containing MTA-STS information */
-    jmap?: {
-        extsecrep?: {
-            mta?: MtaProps | null;
+            spf?: SpfDetails | null;
         } | null;
     } | null;
-    /** Domain to analyze */
-    domain?: string;
 }
 
 /**
  * Component props.
  */
-interface SignalCardBimiProps extends SignalCardSharedProps {
+interface SignalCardSpfDomainAnalyzerProps extends SignalCardSharedProps {
     /**
-     * JMAP data containing BIMI and DMARC information from the email security report.
+     * JMAP data containing SPF analysis results
      */
     jmap: {
         extsecrep: {
-            bimi?: any;
-            dmarc?: any;
+            spf: DomainAnalyzerSpfProps;
+            originator?: {
+                domain?: string | null;
+                orgDomain?: string | null;
+            } | null;
         };
     };
-    /**
-     * Optional callback invoked when the component mounts.
-     */
-    onComponentMount?: () => void;
 }
 
 /**
@@ -178,7 +299,7 @@ interface SignalCardBimiProps extends SignalCardSharedProps {
  */
 type ExtractionCaptionType = 'email' | 'dns' | 'dns-details' | 'policy' | 'email-details';
 
-type DmarcData$1 = {
+type DmarcData = {
     domain?: string | null;
 } | null;
 /**
@@ -192,7 +313,7 @@ interface SignalCardDkimDomainAnalyzerProps extends SignalCardSharedProps {
      */
     jmap: {
         extsecrep: {
-            dmarc?: DmarcData$1;
+            dmarc?: DmarcData;
             dkim?: DomainAnalyzerDkimProps;
         };
     };
@@ -201,266 +322,145 @@ interface SignalCardDkimDomainAnalyzerProps extends SignalCardSharedProps {
 /**
  * Component props.
  */
-interface SignalCardSpfDomainAnalyzerProps extends SignalCardSharedProps {
+interface SignalCardBimiProps extends SignalCardSharedProps {
     /**
-     * JMAP data containing SPF analysis results
+     * JMAP data containing BIMI and DMARC information from the email security report.
      */
     jmap: {
         extsecrep: {
-            spf: DomainAnalyzerSpfProps;
-            originator?: {
-                domain?: string | null;
-                orgDomain?: string | null;
-            } | null;
+            bimi?: any;
+            dmarc?: any;
         };
     };
+    /**
+     * Optional callback invoked when the component mounts.
+     */
+    onComponentMount?: () => void;
 }
 
 /**
- * SPF report item from the BIMI Checker API
+ * Component props.
  */
-interface SpfReportItem {
-    status?: string;
+interface SignalCardMtaStsProps extends SignalCardSharedProps {
+    /** JMAP email data containing MTA-STS information */
+    jmap?: {
+        extsecrep?: {
+            mta?: MtaProps | null;
+        } | null;
+    } | null;
+    /** Domain to analyze */
+    domain?: string;
+}
+
+type SubdoReportEntry = {
     message?: string;
     spfError?: string;
-}
-interface SpfDetails {
-    raw?: string | string[] | null;
-    status?: string | null;
-    txtExtractedFrom?: string | null;
-    report?: SpfReportItem[];
+    raw?: string;
+    value?: unknown;
+    details?: unknown;
     [key: string]: unknown;
-}
+};
 /**
- * Props for the SignalCardSpfDomain component.
- *
- * Simplified SPF Domain Card for BIMI Checker - shows only pass/fail status and raw SPF record.
+ * Component props.
  */
-interface SignalCardSpfDomainProps extends SignalCardSharedProps {
+interface SignalCardSubdoProps extends SignalCardSharedProps {
     /**
-     * JMAP data containing SPF authentication results
+     * JMAP data containing SPF subdomain takeover report
      */
     jmap?: {
         extsecrep?: {
-            spf?: SpfDetails | null;
+            spf?: {
+                domain?: string | null;
+                report?: SubdoReportEntry[] | null;
+            } | null;
         } | null;
     } | null;
 }
 
-type DmarcResult$1 = {
-    status?: CardStatus | string | null;
-    errors?: string[] | null;
-};
-type DmarcData = {
-    raw?: string | null;
-    result?: DmarcResult$1 | null;
-    txtExtractedFrom?: string | null;
-    policyDomain?: string | null;
-    fromDomain?: string | null;
-    domainPublished?: string | null;
-};
-type Originator = {
-    domain?: string | null;
-    orgDomain?: string | null;
+type ExtsecrepThreatLevel = ExtsecrepProps;
+type FromInfo = {
+    name?: string | null;
+    email?: string | null;
 } | null;
-interface SignalCardDmarcDomainProps extends SignalCardSharedProps {
-    jmap: {
-        extsecrep: {
-            dmarc: DmarcData;
-            originator?: Originator;
-        };
-    };
-}
-
 /**
  * Component props.
  */
-interface SignalCardTlsProps extends SignalCardSharedProps {
-    /** JMAP email data containing TLS information */
+interface SignalCardThreatInvProps extends SignalCardSharedProps {
+    /** JMAP email data containing threat intelligence information */
     jmap: {
-        extsecrep: {
-            tls?: TlsProps;
-        };
+        extsecrep: ExtsecrepThreatLevel;
+        from?: FromInfo;
     };
+    /** Whether this is being used in domain analyzer mode */
+    isDomainAnalyzer?: boolean;
 }
 
 /**
  * Component props.
  */
-interface SignalCardFcrdnsProps extends SignalCardSharedProps {
-    /** JMAP data containing EHLO information */
-    jmap: {
-        extsecrep: {
-            ehlo?: EhloProps;
-        };
-    };
-    /** Investigation data with FCrDNS and EHLO check results */
-    investigate?: {
-        fcrdns?: FcrdnsProps | null;
-        ehloCheck?: EhloCheckProps | null;
-    };
+interface SignalCardDnssecProps extends SignalCardSharedProps {
+    /** JMAP data containing DNS security information */
+    jmap?: {
+        extsecrep?: {
+            dnsSecurity?: DnsSecurityProps | null;
+        } | null;
+    } | null;
+    /** Custom short description (overrides default based on result) */
+    shortDescription?: ReactNode;
 }
 
-type DkimResult = DkimProps;
-type DmarcResult = DmarcProps | null;
 /**
- * Component props.
+ * External security report data structure
  */
-interface SignalCardDkimProps extends SignalCardSharedProps {
-    /** JMAP email data containing DKIM, DMARC information */
-    jmap: {
-        extsecrep: {
-            dkim?: DkimResult | DkimResult[] | null;
-            dmarc?: DmarcResult;
-        };
-    };
+interface ExtsecrepData {
+    /** SPF check data */
+    spf?: SpfProps | null;
+    /** DMARC policy data */
+    dmarc?: DmarcProps | null;
+    /** DKIM signature data - can be array or object */
+    dkim?: DkimProps | DkimProps[] | null;
 }
-
-type SpfData = SpfProps;
 /**
  * Component props.
  */
-interface SignalCardSpfProps extends SignalCardSharedProps {
-    /** JMAP email data containing SPF information */
+interface SignalCardAmpProps extends SignalCardSharedProps {
+    /** JMAP data containing authentication information */
     jmap: {
-        extsecrep: {
-            spf?: SpfData;
-        };
+        /** External security report with SPF, DMARC, DKIM data */
+        extsecrep: ExtsecrepData;
+        /** From email address information */
+        from?: {
+            email?: string | null;
+        } | null;
     };
 }
 
-/**
- * Extended JMAP props for DMARC card including required extsecrep data
- */
-interface SignalCardDmarcJmapProps extends JmapProps {
-    extsecrep: {
-        dmarc?: DmarcProps;
-        dkim?: DkimProps | DkimProps[];
-        spf?: SpfProps;
-    };
-}
 /**
  * Component props.
  */
-interface SignalCardDmarcProps extends SignalCardSharedProps {
-    /**
-     * JMAP email data containing DMARC, DKIM, SPF information
-     */
-    jmap: SignalCardDmarcJmapProps;
+interface SignalCardUrlsProps extends SignalCardSharedProps {
     /**
-     * Whether this is being used in domain analyzer mode
+     * Investigate data containing extracted URLs
      */
-    isDomainAnalyzer?: boolean;
+    investigate?: InvestigateProps | null;
 }
 
-type SignalData = {
-    signalType: string;
-    jmap?: {
-        extsecrep?: Record<string, any>;
-        [key: string]: unknown;
-    };
-    shortDescription?: unknown;
-    [key: string]: unknown;
-};
-type ErrorLike = {
-    name?: string;
-    message?: string;
-    stack?: string;
-};
-type CardEnabledOverrides = Record<string, boolean | undefined>;
-interface SignalCardListProps extends Omit<ComponentProps<'div'>, 'children'> {
-    /** Array of signal data objects containing DMARC, DKIM, SPF information */
-    signals?: SignalData[];
-    /** Error object to display if signal loading fails */
-    error?: ErrorLike | null;
-    /** Map of signal types to enabled/disabled state */
-    isCardEnabledMap?: CardEnabledOverrides;
-    /** Signal types to display in the priority section (shown first). Defaults to DMARC, DKIM, SPF */
-    prioritySignalTypes?: string[];
-    /** Initial selected signal type for external selection control */
-    initialSelectedSignalType?: string | null;
-    /** Callback when a signal card is selected */
-    onSelectSignalType?: (signalType: string) => void;
-    /** Custom header renderer for adding content at the top of each card, after the title */
-    renderCardHeader?: (signal: SignalData) => React.ReactNode;
-    /** Override the promo banner button href on all cards (e.g. to add UTM parameters). Only used when renderCardHeader is not provided. Defaults to the OnDMARC signup URL (`https://iam.redsift.cloud/signup?redirectapp=cloud&product=ondmarc`). */
-    cardPromoHref?: string;
-    /** Custom footer renderer for adding content at the bottom of each card */
-    renderCardFooter?: (signal: SignalData) => React.ReactNode;
-    /**
-     * Heading text for the priority signals section.
-     * Defaults to "Required for the selected compliance profile"
-     */
-    prioritySectionHeading?: string;
-    /**
-     * Heading text for the remaining signals section.
-     * Defaults to "Not required for the selected compliance profile"
-     */
-    remainingSectionHeading?: string;
-    /** Use Investigate handbook colors instead of Design System CSS variables */
-    useInvestigateColors?: boolean;
-    /**
-     * Enable collapsible sections inside all child cards.
-     * @default true
-     */
-    isCollapsible?: boolean;
-    /**
-     * Controlled collapsed state for all sections in all child cards.
-     * Used with isCollapsible to manage collapsed state externally.
-     */
-    areAllCollapsed?: boolean;
-    /**
-     * Callback fired when the collapse-all toggle changes in any child card.
-     */
-    onCollapseAll?: (areAllCollapsed: boolean) => void;
-    /**
-     * AI-powered recommendations data including analysis and per-protocol signals.
-     * When provided (and showRecommendations is not false), renders a RecommendationsSummary
-     * section above the signal cards.
-     */
-    recommendations?: RecommendationsData | null;
-    /**
-     * Whether recommendations data is still loading.
-     * When true, shows a skeleton/shimmer placeholder for the recommendations section.
-     */
-    recommendationsLoading?: boolean;
-    /**
-     * Whether to show the recommendations section.
-     * @default true
-     */
-    showRecommendations?: boolean;
-    /**
-     * Structured data for the CTA card in the recommendations section.
-     * The DS owns the layout; the consumer provides the content and click handler.
-     */
-    recommendationsCTA?: {
-        title: string;
-        description: string;
-        buttonLabel: string;
-        onClickCTA: () => void;
-    };
-    /**
-     * Callback when user clicks "See more details" on a status card.
-     * The consumer uses this to scroll to and expand the corresponding signal card.
-     */
-    onExpandSignalCard?: (signalType: string) => void;
+/**
+ * Component props.
+ */
+interface SignalCardGoogleYahooComplianceProps extends SignalCardSharedProps {
     /**
-     * Callback for the "Check another email" button in the header.
-     * When provided, renders a styled button with a sync icon and translated label.
-     * Only rendered when a checked email is found in the signal data.
+     * Domain name (currently not used but maintained for API compatibility)
      */
-    onCheckAnotherEmail?: () => void;
+    domain?: string | null;
     /**
-     * Render prop for custom action area in the header.
-     * Overrides the default "Check another email" button when provided.
-     * Only rendered when a checked email is found in the signal data.
+     * JMAP extsecrep data containing authentication results
      */
-    renderHeaderAction?: () => ReactNode;
+    jmap?: JmapProps | null;
     /**
-     * Whether to show the "Powered by OnDMARC" branding in the header.
-     * @default true
+     * Investigate data with FCrDNS and EHLO check results
      */
-    showBranding?: boolean;
+    investigate?: InvestigateProps | null;
 }
 
 /**