@redsift/products 12.5.12 → 12.5.13-muiv6
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 +92 -92
- package/index.d.ts +292 -292
- package/package.json +5 -5
- package/signal-cards.d.ts +292 -292
package/bimi-checker.d.ts
CHANGED
|
@@ -1,67 +1,8 @@
|
|
|
1
1
|
import * as _redsift_design_system from '@redsift/design-system';
|
|
2
|
-
import React, {
|
|
2
|
+
import React, { ComponentProps, ReactNode } from 'react';
|
|
3
3
|
import { DmarcDomainData } 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
|
-
|
|
65
6
|
/**
|
|
66
7
|
* Common props shared by all signal card components. These cover layout options
|
|
67
8
|
* that ultimately map to `SignalCardNormal`.
|
|
@@ -93,38 +34,6 @@ interface SignalCardSharedProps extends Omit<ComponentProps<'div'>, 'children' |
|
|
|
93
34
|
onCollapseAll?: (areAllCollapsed: boolean) => void;
|
|
94
35
|
}
|
|
95
36
|
|
|
96
|
-
/**
|
|
97
|
-
* Component props.
|
|
98
|
-
*/
|
|
99
|
-
interface SignalCardBimiProps extends SignalCardSharedProps {
|
|
100
|
-
/**
|
|
101
|
-
* JMAP data containing BIMI and DMARC information from the email security report.
|
|
102
|
-
*/
|
|
103
|
-
jmap: {
|
|
104
|
-
extsecrep: {
|
|
105
|
-
bimi?: any;
|
|
106
|
-
dmarc?: any;
|
|
107
|
-
};
|
|
108
|
-
};
|
|
109
|
-
/**
|
|
110
|
-
* Optional callback invoked when the component mounts.
|
|
111
|
-
*/
|
|
112
|
-
onComponentMount?: () => void;
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
type Originator = {
|
|
116
|
-
domain?: string | null;
|
|
117
|
-
orgDomain?: string | null;
|
|
118
|
-
} | null;
|
|
119
|
-
interface SignalCardDmarcDomainProps extends SignalCardSharedProps {
|
|
120
|
-
jmap: {
|
|
121
|
-
extsecrep: {
|
|
122
|
-
dmarc: DmarcDomainData;
|
|
123
|
-
originator?: Originator;
|
|
124
|
-
};
|
|
125
|
-
};
|
|
126
|
-
}
|
|
127
|
-
|
|
128
37
|
/**
|
|
129
38
|
* SPF report item from the BIMI Checker API
|
|
130
39
|
*/
|
|
@@ -156,6 +65,97 @@ interface SignalCardSpfDomainProps extends SignalCardSharedProps {
|
|
|
156
65
|
} | null;
|
|
157
66
|
}
|
|
158
67
|
|
|
68
|
+
type Originator = {
|
|
69
|
+
domain?: string | null;
|
|
70
|
+
orgDomain?: string | null;
|
|
71
|
+
} | null;
|
|
72
|
+
interface SignalCardDmarcDomainProps extends SignalCardSharedProps {
|
|
73
|
+
jmap: {
|
|
74
|
+
extsecrep: {
|
|
75
|
+
dmarc: DmarcDomainData;
|
|
76
|
+
originator?: Originator;
|
|
77
|
+
};
|
|
78
|
+
};
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Component props.
|
|
83
|
+
*/
|
|
84
|
+
interface SignalCardBimiProps extends SignalCardSharedProps {
|
|
85
|
+
/**
|
|
86
|
+
* JMAP data containing BIMI and DMARC information from the email security report.
|
|
87
|
+
*/
|
|
88
|
+
jmap: {
|
|
89
|
+
extsecrep: {
|
|
90
|
+
bimi?: any;
|
|
91
|
+
dmarc?: any;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
/**
|
|
95
|
+
* Optional callback invoked when the component mounts.
|
|
96
|
+
*/
|
|
97
|
+
onComponentMount?: () => void;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Signal Cards Theme Configuration
|
|
102
|
+
*
|
|
103
|
+
* This context provides theme configuration to signal card components,
|
|
104
|
+
* eliminating the need to pass `useInvestigateColors` through every component layer.
|
|
105
|
+
*/
|
|
106
|
+
interface SignalCardTheme {
|
|
107
|
+
/**
|
|
108
|
+
* Whether to use Investigate-specific colors and fonts.
|
|
109
|
+
* When true, applies custom fonts and color palette for the Investigate tool.
|
|
110
|
+
*/
|
|
111
|
+
useInvestigateColors: boolean;
|
|
112
|
+
}
|
|
113
|
+
interface SignalCardThemeProviderProps {
|
|
114
|
+
children: ReactNode;
|
|
115
|
+
/**
|
|
116
|
+
* Theme configuration to apply to all signal card descendants
|
|
117
|
+
*/
|
|
118
|
+
theme?: Partial<SignalCardTheme>;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Provider component for Signal Card theming.
|
|
122
|
+
*
|
|
123
|
+
* Wrap signal card components with this provider to set theme options
|
|
124
|
+
* without passing props through every component level.
|
|
125
|
+
*
|
|
126
|
+
* This provider injects CSS custom properties (--sc-*) that components use for styling.
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* ```tsx
|
|
130
|
+
* <SignalCardThemeProvider theme={{ useInvestigateColors: true }}>
|
|
131
|
+
* <SignalCardList signals={signals} />
|
|
132
|
+
* </SignalCardThemeProvider>
|
|
133
|
+
* ```
|
|
134
|
+
*/
|
|
135
|
+
declare const SignalCardThemeProvider: React.FC<SignalCardThemeProviderProps>;
|
|
136
|
+
/**
|
|
137
|
+
* Hook to access the current signal card theme.
|
|
138
|
+
*
|
|
139
|
+
* Components can use this hook to access theme configuration
|
|
140
|
+
* without requiring explicit props.
|
|
141
|
+
*
|
|
142
|
+
* @example
|
|
143
|
+
* ```tsx
|
|
144
|
+
* const { useInvestigateColors } = useSignalCardTheme();
|
|
145
|
+
* ```
|
|
146
|
+
*/
|
|
147
|
+
declare const useSignalCardTheme: () => SignalCardTheme;
|
|
148
|
+
/**
|
|
149
|
+
* Hook that combines prop value with context value.
|
|
150
|
+
* Prop value takes precedence over context when explicitly provided.
|
|
151
|
+
*
|
|
152
|
+
* Components can receive useInvestigateColors via props or context.
|
|
153
|
+
*
|
|
154
|
+
* @param propValue - Explicitly passed prop value (takes precedence)
|
|
155
|
+
* @returns Resolved theme configuration
|
|
156
|
+
*/
|
|
157
|
+
declare const useResolvedTheme: (propValue?: boolean) => SignalCardTheme;
|
|
158
|
+
|
|
159
159
|
/**
|
|
160
160
|
* BIMI signal card - displays Brand Indicators for Message Identification status.
|
|
161
161
|
* Shows SVG logo, VMC/CMC certificate validation, and BIMI record analysis.
|