@redsift/products 12.5.2-muiv7 → 12.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/bimi-checker.d.ts CHANGED
@@ -1,8 +1,67 @@
1
1
  import * as _redsift_design_system from '@redsift/design-system';
2
- import React, { ComponentProps, ReactNode } from 'react';
2
+ import React, { ReactNode, ComponentProps } from 'react';
3
3
  import { CardStatus } from '@redsift/signal-logic';
4
4
  export { BIMI_CHECKER_SIGNAL_TYPES, BimiCheckerSignalType, CARD_STATUS, SIGNAL_TYPES, STATUS_COLORS, STATUS_ICONS, STATUS_ICON_STYLES, SignalType, getStatusColor, getStatusIcon, getStatusIconStyle, isCardStatus, isFailureStatus, isSuccessStatus, isWarningStatus, mapStatusToDetailedCardColor, normalizeStatus } from '@redsift/signal-logic';
5
5
 
6
+ /**
7
+ * Signal Cards Theme Configuration
8
+ *
9
+ * This context provides theme configuration to signal card components,
10
+ * eliminating the need to pass `useInvestigateColors` through every component layer.
11
+ */
12
+ interface SignalCardTheme {
13
+ /**
14
+ * Whether to use Investigate-specific colors and fonts.
15
+ * When true, applies custom fonts and color palette for the Investigate tool.
16
+ */
17
+ useInvestigateColors: boolean;
18
+ }
19
+ interface SignalCardThemeProviderProps {
20
+ children: ReactNode;
21
+ /**
22
+ * Theme configuration to apply to all signal card descendants
23
+ */
24
+ theme?: Partial<SignalCardTheme>;
25
+ }
26
+ /**
27
+ * Provider component for Signal Card theming.
28
+ *
29
+ * Wrap signal card components with this provider to set theme options
30
+ * without passing props through every component level.
31
+ *
32
+ * This provider injects CSS custom properties (--sc-*) that components use for styling.
33
+ *
34
+ * @example
35
+ * ```tsx
36
+ * <SignalCardThemeProvider theme={{ useInvestigateColors: true }}>
37
+ * <SignalCardList signals={signals} />
38
+ * </SignalCardThemeProvider>
39
+ * ```
40
+ */
41
+ declare const SignalCardThemeProvider: React.FC<SignalCardThemeProviderProps>;
42
+ /**
43
+ * Hook to access the current signal card theme.
44
+ *
45
+ * Components can use this hook to access theme configuration
46
+ * without requiring explicit props.
47
+ *
48
+ * @example
49
+ * ```tsx
50
+ * const { useInvestigateColors } = useSignalCardTheme();
51
+ * ```
52
+ */
53
+ declare const useSignalCardTheme: () => SignalCardTheme;
54
+ /**
55
+ * Hook that combines prop value with context value.
56
+ * Prop value takes precedence over context when explicitly provided.
57
+ *
58
+ * Components can receive useInvestigateColors via props or context.
59
+ *
60
+ * @param propValue - Explicitly passed prop value (takes precedence)
61
+ * @returns Resolved theme configuration
62
+ */
63
+ declare const useResolvedTheme: (propValue?: boolean) => SignalCardTheme;
64
+
6
65
  /**
7
66
  * Common props shared by all signal card components. These cover layout options
8
67
  * that ultimately map to `SignalCardNormal`.
@@ -29,34 +88,22 @@ interface SignalCardSharedProps extends Omit<ComponentProps<'div'>, 'children' |
29
88
  }
30
89
 
31
90
  /**
32
- * SPF report item from the BIMI Checker API
33
- */
34
- interface SpfReportItem {
35
- status?: string;
36
- message?: string;
37
- spfError?: string;
38
- }
39
- interface SpfDetails {
40
- raw?: string | string[] | null;
41
- status?: string | null;
42
- txtExtractedFrom?: string | null;
43
- report?: SpfReportItem[];
44
- [key: string]: unknown;
45
- }
46
- /**
47
- * Props for the SignalCardSpfDomain component.
48
- *
49
- * Simplified SPF Domain Card for BIMI Checker - shows only pass/fail status and raw SPF record.
91
+ * Component props.
50
92
  */
51
- interface SignalCardSpfDomainProps extends SignalCardSharedProps {
93
+ interface SignalCardBimiProps extends SignalCardSharedProps {
52
94
  /**
53
- * JMAP data containing SPF authentication results
95
+ * JMAP data containing BIMI and DMARC information from the email security report.
54
96
  */
55
- jmap?: {
56
- extsecrep?: {
57
- spf?: SpfDetails | null;
58
- } | null;
59
- } | null;
97
+ jmap: {
98
+ extsecrep: {
99
+ bimi?: any;
100
+ dmarc?: any;
101
+ };
102
+ };
103
+ /**
104
+ * Optional callback invoked when the component mounts.
105
+ */
106
+ onComponentMount?: () => void;
60
107
  }
61
108
 
62
109
  type DmarcResult = {
@@ -85,82 +132,35 @@ interface SignalCardDmarcDomainProps extends SignalCardSharedProps {
85
132
  }
86
133
 
87
134
  /**
88
- * Component props.
135
+ * SPF report item from the BIMI Checker API
89
136
  */
90
- interface SignalCardBimiProps extends SignalCardSharedProps {
91
- /**
92
- * JMAP data containing BIMI and DMARC information from the email security report.
93
- */
94
- jmap: {
95
- extsecrep: {
96
- bimi?: any;
97
- dmarc?: any;
98
- };
99
- };
100
- /**
101
- * Optional callback invoked when the component mounts.
102
- */
103
- onComponentMount?: () => void;
137
+ interface SpfReportItem {
138
+ status?: string;
139
+ message?: string;
140
+ spfError?: string;
141
+ }
142
+ interface SpfDetails {
143
+ raw?: string | string[] | null;
144
+ status?: string | null;
145
+ txtExtractedFrom?: string | null;
146
+ report?: SpfReportItem[];
147
+ [key: string]: unknown;
104
148
  }
105
-
106
149
  /**
107
- * Signal Cards Theme Configuration
150
+ * Props for the SignalCardSpfDomain component.
108
151
  *
109
- * This context provides theme configuration to signal card components,
110
- * eliminating the need to pass `useInvestigateColors` through every component layer.
152
+ * Simplified SPF Domain Card for BIMI Checker - shows only pass/fail status and raw SPF record.
111
153
  */
112
- interface SignalCardTheme {
113
- /**
114
- * Whether to use Investigate-specific colors and fonts.
115
- * When true, applies custom fonts and color palette for the Investigate tool.
116
- */
117
- useInvestigateColors: boolean;
118
- }
119
- interface SignalCardThemeProviderProps {
120
- children: ReactNode;
154
+ interface SignalCardSpfDomainProps extends SignalCardSharedProps {
121
155
  /**
122
- * Theme configuration to apply to all signal card descendants
156
+ * JMAP data containing SPF authentication results
123
157
  */
124
- theme?: Partial<SignalCardTheme>;
158
+ jmap?: {
159
+ extsecrep?: {
160
+ spf?: SpfDetails | null;
161
+ } | null;
162
+ } | null;
125
163
  }
126
- /**
127
- * Provider component for Signal Card theming.
128
- *
129
- * Wrap signal card components with this provider to set theme options
130
- * without passing props through every component level.
131
- *
132
- * This provider injects CSS custom properties (--sc-*) that components use for styling.
133
- *
134
- * @example
135
- * ```tsx
136
- * <SignalCardThemeProvider theme={{ useInvestigateColors: true }}>
137
- * <SignalCardList signals={signals} />
138
- * </SignalCardThemeProvider>
139
- * ```
140
- */
141
- declare const SignalCardThemeProvider: React.FC<SignalCardThemeProviderProps>;
142
- /**
143
- * Hook to access the current signal card theme.
144
- *
145
- * Components can use this hook to access theme configuration
146
- * without requiring explicit props.
147
- *
148
- * @example
149
- * ```tsx
150
- * const { useInvestigateColors } = useSignalCardTheme();
151
- * ```
152
- */
153
- declare const useSignalCardTheme: () => SignalCardTheme;
154
- /**
155
- * Hook that combines prop value with context value.
156
- * Prop value takes precedence over context when explicitly provided.
157
- *
158
- * Components can receive useInvestigateColors via props or context.
159
- *
160
- * @param propValue - Explicitly passed prop value (takes precedence)
161
- * @returns Resolved theme configuration
162
- */
163
- declare const useResolvedTheme: (propValue?: boolean) => SignalCardTheme;
164
164
 
165
165
  /**
166
166
  * BIMI signal card - displays Brand Indicators for Message Identification status.