@revturbine/sdk 0.7.12 → 0.8.0
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/dist/headless.d.ts +1506 -114
- package/dist/headless.js +2 -2
- package/dist/headless.js.map +1 -1
- package/dist/index.d.ts +1749 -121
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/types/web-sdk/config-artifact.d.ts +54 -12
- package/dist/types/web-sdk/config-artifact.d.ts.map +1 -1
- package/dist/types/web-sdk/control-plane-events.d.ts +6 -5
- package/dist/types/web-sdk/control-plane-events.d.ts.map +1 -1
- package/dist/types/web-sdk/controllers.d.ts +17 -0
- package/dist/types/web-sdk/controllers.d.ts.map +1 -1
- package/dist/types/web-sdk/customer-side.d.ts +332 -4
- package/dist/types/web-sdk/customer-side.d.ts.map +1 -1
- package/dist/types/web-sdk/headless.d.ts +1 -1
- package/dist/types/web-sdk/headless.d.ts.map +1 -1
- package/dist/types/web-sdk/pii-redact.d.ts +19 -0
- package/dist/types/web-sdk/pii-redact.d.ts.map +1 -1
- package/dist/types/web-sdk/placements/FixedSurfaceSlot.d.ts +14 -3
- package/dist/types/web-sdk/placements/FixedSurfaceSlot.d.ts.map +1 -1
- package/dist/types/web-sdk/placements/MessageSurfaceSlot.d.ts.map +1 -1
- package/dist/types/web-sdk/placements/useSurfaceSlot.d.ts +24 -0
- package/dist/types/web-sdk/placements/useSurfaceSlot.d.ts.map +1 -1
- package/dist/types/web-sdk/react/InitFailureDiagnostic.d.ts +35 -0
- package/dist/types/web-sdk/react/InitFailureDiagnostic.d.ts.map +1 -0
- package/dist/types/web-sdk/react/RevTurbineProvider.d.ts +18 -4
- package/dist/types/web-sdk/react/RevTurbineProvider.d.ts.map +1 -1
- package/dist/types/web-sdk/react/index.d.ts +2 -0
- package/dist/types/web-sdk/react/index.d.ts.map +1 -1
- package/dist/types/web-sdk/react/init-status.d.ts +63 -0
- package/dist/types/web-sdk/react/init-status.d.ts.map +1 -0
- package/dist/types/web-sdk/react/useRevTurbine.d.ts +18 -0
- package/dist/types/web-sdk/react/useRevTurbine.d.ts.map +1 -1
- package/dist/types/web-sdk/theme/ThemeContext.d.ts +28 -2
- package/dist/types/web-sdk/theme/ThemeContext.d.ts.map +1 -1
- package/dist/types/web-sdk/theme/defaults.d.ts +44 -3
- package/dist/types/web-sdk/theme/defaults.d.ts.map +1 -1
- package/dist/types/web-sdk/theme/index.d.ts +4 -2
- package/dist/types/web-sdk/theme/index.d.ts.map +1 -1
- package/dist/types/web-sdk/theme/useColorScheme.d.ts +14 -0
- package/dist/types/web-sdk/theme/useColorScheme.d.ts.map +1 -0
- package/package.json +4 -4
|
@@ -6,8 +6,49 @@ import type { RevTurbineTheme, RevTurbineThemeInput } from './types';
|
|
|
6
6
|
*/
|
|
7
7
|
export declare const DEFAULT_THEME: Readonly<RevTurbineTheme>;
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
10
|
-
*
|
|
9
|
+
* Dark counterpart to {@link DEFAULT_THEME}.
|
|
10
|
+
*
|
|
11
|
+
* Plan 233 TASK-6. The SDK had no sanctioned dark story at all, so a customer
|
|
12
|
+
* running a dark app either lived with white modals or — as the escalated one
|
|
13
|
+
* did — injected a palette into the Playbook object and re-initialized the SDK
|
|
14
|
+
* on every toggle. Shipping the palette is what makes `colorScheme` a swap
|
|
15
|
+
* rather than a rebuild.
|
|
16
|
+
*
|
|
17
|
+
* Only the colors differ. Typography, shape and shadows are scheme-independent,
|
|
18
|
+
* so they are inherited from {@link DEFAULT_THEME} rather than duplicated —
|
|
19
|
+
* a second copy would drift the moment either is edited.
|
|
20
|
+
*
|
|
21
|
+
* Contrast: every text-on-surface pair here clears WCAG AA at body size against
|
|
22
|
+
* its intended background.
|
|
23
|
+
*
|
|
24
|
+
* @public
|
|
11
25
|
*/
|
|
12
|
-
export declare
|
|
26
|
+
export declare const DARK_THEME: Readonly<RevTurbineTheme>;
|
|
27
|
+
/**
|
|
28
|
+
* The colour scheme a theme resolves against.
|
|
29
|
+
*
|
|
30
|
+
* `'system'` follows the OS/browser `prefers-color-scheme` and keeps following
|
|
31
|
+
* it as the user changes it.
|
|
32
|
+
*
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
export type RevTurbineColorScheme = 'light' | 'dark' | 'system';
|
|
36
|
+
/**
|
|
37
|
+
* The base palette for a resolved scheme.
|
|
38
|
+
*
|
|
39
|
+
* @param scheme - `'light'` or `'dark'`. Resolve `'system'` before calling.
|
|
40
|
+
* @returns The matching base theme.
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export declare function baseThemeForScheme(scheme: 'light' | 'dark'): Readonly<RevTurbineTheme>;
|
|
44
|
+
/**
|
|
45
|
+
* Deep-merge a partial theme input with a base theme, producing a complete
|
|
46
|
+
* {@link RevTurbineTheme}.
|
|
47
|
+
*
|
|
48
|
+
* @param input - Partial tokens. Every omitted token falls back to `base`.
|
|
49
|
+
* @param base - The palette to merge over. Defaults to {@link DEFAULT_THEME};
|
|
50
|
+
* pass {@link DARK_THEME} (or use {@link baseThemeForScheme}) to resolve a
|
|
51
|
+
* partial brand theme against the dark palette instead.
|
|
52
|
+
*/
|
|
53
|
+
export declare function mergeTheme(input?: RevTurbineThemeInput | null, base?: Readonly<RevTurbineTheme>): RevTurbineTheme;
|
|
13
54
|
//# sourceMappingURL=defaults.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../../../theme/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAErE;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,eAAe,CA2ClD,CAAC;AAEH
|
|
1
|
+
{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../../../theme/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAErE;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,eAAe,CA2ClD,CAAC;AAGH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,EAAE,QAAQ,CAAC,eAAe,CA2B/C,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEhE;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC,eAAe,CAAC,CAEtF;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACxB,KAAK,CAAC,EAAE,oBAAoB,GAAG,IAAI,EACnC,IAAI,GAAE,QAAQ,CAAC,eAAe,CAAiB,GAC9C,eAAe,CAYjB"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
export type { RevTurbineTheme, RevTurbineThemeInput, RevTurbineThemeColors, RevTurbineThemeTypography, RevTurbineThemeShape, RevTurbineThemeShadows, } from './types';
|
|
2
|
-
export { DEFAULT_THEME, mergeTheme } from './defaults';
|
|
2
|
+
export { DEFAULT_THEME, DARK_THEME, baseThemeForScheme, mergeTheme, } from './defaults';
|
|
3
|
+
export type { RevTurbineColorScheme } from './defaults';
|
|
4
|
+
export { useResolvedColorScheme } from './useColorScheme';
|
|
3
5
|
export { loadTheme, clearPersistedTheme } from './theme-loader';
|
|
4
6
|
export type { ThemeLoaderOptions } from './theme-loader';
|
|
5
|
-
export { RevTurbineThemeProvider, useRevTurbineTheme } from './ThemeContext';
|
|
7
|
+
export { RevTurbineThemeProvider, useRevTurbineTheme, useRevTurbineThemeProviderPresent, } from './ThemeContext';
|
|
6
8
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../theme/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,SAAS,CAAC;AAEjB,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../theme/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,UAAU,GACX,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAChE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EAClB,iCAAiC,GAClC,MAAM,gBAAgB,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { RevTurbineColorScheme } from './defaults';
|
|
2
|
+
/**
|
|
3
|
+
* Resolve a {@link RevTurbineColorScheme} to the concrete scheme to paint.
|
|
4
|
+
*
|
|
5
|
+
* `'system'` tracks `prefers-color-scheme` and keeps tracking it: a user
|
|
6
|
+
* flipping their OS theme updates the resolved value without a remount, which
|
|
7
|
+
* is the difference between following the system and sampling it once at init.
|
|
8
|
+
*
|
|
9
|
+
* @param preference - The requested scheme. `'system'` follows the OS.
|
|
10
|
+
* @returns `'light'` or `'dark'`.
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export declare function useResolvedColorScheme(preference: RevTurbineColorScheme): 'light' | 'dark';
|
|
14
|
+
//# sourceMappingURL=useColorScheme.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useColorScheme.d.ts","sourceRoot":"","sources":["../../../../theme/useColorScheme.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAoBxD;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,qBAAqB,GAAG,OAAO,GAAG,MAAM,CAuC1F"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@revturbine/sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "RevTurbine customer-facing SDK — placement decisioning, entitlement checks, and usage tracking.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"packageManager": "pnpm@11.12.0",
|
|
@@ -55,9 +55,9 @@
|
|
|
55
55
|
"devDependencies": {
|
|
56
56
|
"@growthbook/growthbook": "^1.7.0",
|
|
57
57
|
"@optimizely/optimizely-sdk": "^6.5.0",
|
|
58
|
-
"@revt-eng/core": "0.1.
|
|
59
|
-
"@revt-eng/schema": "0.1.
|
|
60
|
-
"@revt-eng/schema-external": "0.1.
|
|
58
|
+
"@revt-eng/core": "0.1.306",
|
|
59
|
+
"@revt-eng/schema": "0.1.306",
|
|
60
|
+
"@revt-eng/schema-external": "0.1.306",
|
|
61
61
|
"@types/react": "^19.2.17",
|
|
62
62
|
"@types/react-dom": "^19.2.3",
|
|
63
63
|
"openapi-fetch": "^0.17.0",
|