@uniformdev/context-devtools 19.35.2 → 19.36.0

package/dist/index.d.mts

@@ -0,0 +1,84 @@
+import * as _emotion_react_types_jsx_namespace from '@emotion/react/types/jsx-namespace';
+import { VisitorData, OutputSeverity, DevToolsState, DevToolsActions, Context } from '@uniformdev/context';
+import { ManifestV2 } from '@uniformdev/context/*';
+import { DimensionDisplayData, Quirk } from '@uniformdev/context/api';
+
+type FullDimensionData = DimensionDisplayData & {
+    cap: number;
+    str: number;
+};
+type DimensionIndexData = Record<string, FullDimensionData>;
+/**
+ * Fetches dimension data in an indexed object from Uniform API
+ * If incomplete data is sent, returns empty index.
+ */
+declare function useDimensionIndex({ apiHost, apiKey, projectId }: DevToolsSettings, manifest?: ManifestV2): {
+    loading: boolean;
+    error: Error | undefined;
+    index: DimensionIndexData;
+};
+
+type QuirkIndexHookType = {
+    loading: boolean;
+    error: Error | undefined;
+    index: QuirksIndexData;
+};
+type QuirksIndexData = Record<string, Quirk & {
+    value: string | undefined;
+}>;
+/**
+ * Fetches dimension data in an indexed object from Uniform API
+ * If incomplete data is sent, returns empty index.
+ */
+declare function useQuirkIndex({ apiHost, apiKey, projectId }: DevToolsSettings, quirksData: VisitorData['quirks']): QuirkIndexHookType;
+
+type Override<T> = {
+    initial: T;
+    override: T;
+};
+/** Settings for the DevTools. Stored **per-origin**. */
+type DevToolsSettings = {
+    apiKey?: string;
+    projectId?: string;
+    apiHost?: string;
+    logLevel?: OutputSeverity;
+    /** Current route the app is on */
+    route?: string;
+    consentMode?: boolean;
+    ignoreApiKeyPrompt?: boolean;
+    scoreOverrides?: Record<string, Override<number>>;
+    quirkOverrides?: Record<string, Override<string>>;
+};
+type ContextDevToolsProps = {
+    state: DevToolsState;
+    actions: DevToolsActions;
+    settings: DevToolsSettings;
+    saveSettings: (settings: DevToolsSettings) => void | Promise<void>;
+    clearAllExtensionData: () => void | Promise<void>;
+};
+type ContextDevToolsRouteProps = ContextDevToolsProps & {
+    dimensionIndex: ReturnType<typeof useDimensionIndex>;
+    quirksIndex: ReturnType<typeof useQuirkIndex>;
+};
+declare function ContextDevTools(props: ContextDevToolsProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type EmbeddedContextDevToolsProps = {
+    /**
+     * Pass a Context instance to connect to DevTools.
+     * This is optional, and defaults to a context instance registered in `window`
+     * when the `enableContextDevTools()` plugin is activated so no direct contact is required.
+     *
+     * Using the window interface enables you to render the DevTools in an isolated React app easily,
+     * or in non-React apps.
+     */
+    context?: Context;
+    /** Initial settings for the devtools. */
+    initialSettings?: DevToolsSettings;
+};
+/** Renders Uniform Context DevTools in an embedded state (as a React component that can be an island on a demo page, for example) */
+declare function EmbeddedContextDevTools({ context, initialSettings }: EmbeddedContextDevToolsProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+/** Renders Uniform Context DevTools in an embedded state (as a React component that can be an island on a demo page, for example) */
+declare function ToggleEmbeddedContextDevTools(props: EmbeddedContextDevToolsProps): _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
+
+export { ContextDevTools, ContextDevToolsProps, ContextDevToolsRouteProps, DevToolsSettings, EmbeddedContextDevTools, EmbeddedContextDevToolsProps, Override, ToggleEmbeddedContextDevTools };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context-devtools",
-  "version": "19.35.2",
+  "version": "19.36.0",
   "description": "Uniform Context developer tools components",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -27,12 +27,12 @@
     "postcss": "8.4.25",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "tsup": "7.0.0"
+    "tsup": "7.1.0"
   },
   "dependencies": {
     "@emotion/react": "11.11.1",
-    "@uniformdev/context": "19.35.2",
-    "@uniformdev/design-system": "19.35.2",
+    "@uniformdev/context": "19.36.0",
+    "@uniformdev/design-system": "19.36.0",
     "formik": "^2.2.9",
     "react-use": "^17.4.0",
     "reakit": "^1.3.11",
@@ -44,5 +44,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "64d3270175087c87cfaa29a283aa4a7b0a98fd2c"
+  "gitHead": "3ae246a7f0f39adeaf04ecba4c7e48c478c019ad"
 }