@optiaxiom/globals 1.1.0 → 1.1.1

package/README.md

@@ -1,11 +1,19 @@
-# `globals`
+# `@optiaxiom/globals`
+
+Design tokens and shared React contexts for Axiom.
 
 ## Installation
 
 ```sh
-$ npm install @optiaxiom/globals
+npm install @optiaxiom/globals
 ```
 
 ## Usage
 
-This is an internal utility, not intended for public usage.
+This package contains design tokens and shared React contexts used by `@optiaxiom/react`. It's primarily intended for advanced use cases like module federation, where the globals package should be shared across federated modules (similar to React itself).
+
+**Note:** Most developers will never need to install or use this package directly. It's automatically included when you install `@optiaxiom/react`.
+
+### Module Federation
+
+For module federation configuration, see our [Module Federation guide](https://optimizely-axiom.github.io/optiaxiom/guides/module-federation/).

package/dist/cjs/index.js

@@ -8,6 +8,8 @@ const AxiomVersionContext = react.createContext(void 0);
 
 const [ModalProvider, useModalContext] = reactContext.createContext("@optiaxiom/react/Modal", { shardRef: { current: null } });
 
+const [unstable_SurfaceProvider, unstable_useSurfaceContext] = reactContext.createContext("@optiaxiom/globals/Surface", null);
+
 var theme = {borderRadius:{xs:'var(--ax-borderRadius-xs)',sm:'var(--ax-borderRadius-sm)',md:'var(--ax-borderRadius-md)',lg:'var(--ax-borderRadius-lg)',xl:'var(--ax-borderRadius-xl)',full:'var(--ax-borderRadius-full)'},boxShadow:{sm:'var(--ax-boxShadow-sm)',md:'var(--ax-boxShadow-md)',lg:'var(--ax-boxShadow-lg)'},colors:{'bg.accent':'var(--ax-colors-bg-accent)','bg.accent.hovered':'var(--ax-colors-bg-accent-hovered)','bg.accent.light':'var(--ax-colors-bg-accent-light)','bg.accent.pressed':'var(--ax-colors-bg-accent-pressed)','bg.accent.subtle':'var(--ax-colors-bg-accent-subtle)','bg.avatar.neutral':'var(--ax-colors-bg-avatar-neutral)','bg.avatar.purple':'var(--ax-colors-bg-avatar-purple)','bg.default':'var(--ax-colors-bg-default)','bg.default.hovered':'var(--ax-colors-bg-default-hovered)','bg.default.inverse':'var(--ax-colors-bg-default-inverse)','bg.default.inverse.hovered':'var(--ax-colors-bg-default-inverse-hovered)','bg.default.inverse.pressed':'var(--ax-colors-bg-default-inverse-pressed)','bg.default.pressed':'var(--ax-colors-bg-default-pressed)','bg.error':'var(--ax-colors-bg-error)','bg.error.hovered':'var(--ax-colors-bg-error-hovered)','bg.error.light':'var(--ax-colors-bg-error-light)','bg.error.pressed':'var(--ax-colors-bg-error-pressed)','bg.error.subtle':'var(--ax-colors-bg-error-subtle)','bg.error.subtlest':'var(--ax-colors-bg-error-subtlest)','bg.information':'var(--ax-colors-bg-information)','bg.information.light':'var(--ax-colors-bg-information-light)','bg.information.subtle':'var(--ax-colors-bg-information-subtle)','bg.overlay':'var(--ax-colors-bg-overlay)','bg.page':'var(--ax-colors-bg-page)','bg.secondary':'var(--ax-colors-bg-secondary)','bg.secondary.hovered':'var(--ax-colors-bg-secondary-hovered)','bg.spinner.default':'var(--ax-colors-bg-spinner-default)','bg.spinner.inverse':'var(--ax-colors-bg-spinner-inverse)','bg.success':'var(--ax-colors-bg-success)','bg.success.hovered':'var(--ax-colors-bg-success-hovered)','bg.success.light':'var(--ax-colors-bg-success-light)','bg.success.subtle':'var(--ax-colors-bg-success-subtle)','bg.tertiary':'var(--ax-colors-bg-tertiary)','bg.tertiary.hovered':'var(--ax-colors-bg-tertiary-hovered)','bg.warning':'var(--ax-colors-bg-warning)','bg.warning.hovered':'var(--ax-colors-bg-warning-hovered)','bg.warning.light':'var(--ax-colors-bg-warning-light)','bg.warning.subtle':'var(--ax-colors-bg-warning-subtle)','border.accent':'var(--ax-colors-border-accent)','border.control':'var(--ax-colors-border-control)','border.control.hovered':'var(--ax-colors-border-control-hovered)','border.default':'var(--ax-colors-border-default)','border.disabled':'var(--ax-colors-border-disabled)','border.error':'var(--ax-colors-border-error)','border.focus':'var(--ax-colors-border-focus)','border.focus.error':'var(--ax-colors-border-focus-error)','border.secondary':'var(--ax-colors-border-secondary)','border.success':'var(--ax-colors-border-success)','border.tertiary':'var(--ax-colors-border-tertiary)','border.warning':'var(--ax-colors-border-warning)','fg.accent':'var(--ax-colors-fg-accent)','fg.accent.hovered':'var(--ax-colors-fg-accent-hovered)','fg.accent.strong':'var(--ax-colors-fg-accent-strong)','fg.avatar.neutral':'var(--ax-colors-fg-avatar-neutral)','fg.avatar.purple':'var(--ax-colors-fg-avatar-purple)','fg.default':'var(--ax-colors-fg-default)','fg.default.inverse':'var(--ax-colors-fg-default-inverse)','fg.disabled':'var(--ax-colors-fg-disabled)','fg.error':'var(--ax-colors-fg-error)','fg.error.hovered':'var(--ax-colors-fg-error-hovered)','fg.error.light':'var(--ax-colors-fg-error-light)','fg.error.strong':'var(--ax-colors-fg-error-strong)','fg.information':'var(--ax-colors-fg-information)','fg.information.light':'var(--ax-colors-fg-information-light)','fg.information.strong':'var(--ax-colors-fg-information-strong)','fg.link.default':'var(--ax-colors-fg-link-default)','fg.link.default.hovered':'var(--ax-colors-fg-link-default-hovered)','fg.link.inverse':'var(--ax-colors-fg-link-inverse)','fg.link.subtle':'var(--ax-colors-fg-link-subtle)','fg.link.visited':'var(--ax-colors-fg-link-visited)','fg.secondary':'var(--ax-colors-fg-secondary)','fg.spinner.default':'var(--ax-colors-fg-spinner-default)','fg.spinner.inverse':'var(--ax-colors-fg-spinner-inverse)','fg.success':'var(--ax-colors-fg-success)','fg.success.hovered':'var(--ax-colors-fg-success-hovered)','fg.success.light':'var(--ax-colors-fg-success-light)','fg.success.strong':'var(--ax-colors-fg-success-strong)','fg.tertiary':'var(--ax-colors-fg-tertiary)','fg.warning':'var(--ax-colors-fg-warning)','fg.warning.hovered':'var(--ax-colors-fg-warning-hovered)','fg.warning.inverse':'var(--ax-colors-fg-warning-inverse)','fg.warning.light':'var(--ax-colors-fg-warning-light)','fg.warning.strong':'var(--ax-colors-fg-warning-strong)','fg.white':'var(--ax-colors-fg-white)'},duration:{sm:'var(--ax-duration-sm)',md:'var(--ax-duration-md)',lg:'var(--ax-duration-lg)'},fontFamily:{mono:'var(--ax-fontFamily-mono)',sans:'var(--ax-fontFamily-sans)'},fontSize:{xs:{fontSize:'var(--ax-fontSize-xs-fontSize)',lineHeight:'var(--ax-fontSize-xs-lineHeight)'},sm:{fontSize:'var(--ax-fontSize-sm-fontSize)',lineHeight:'var(--ax-fontSize-sm-lineHeight)'},md:{fontSize:'var(--ax-fontSize-md-fontSize)',lineHeight:'var(--ax-fontSize-md-lineHeight)'},lg:{fontSize:'var(--ax-fontSize-lg-fontSize)',lineHeight:'var(--ax-fontSize-lg-lineHeight)'},xl:{fontSize:'var(--ax-fontSize-xl-fontSize)',lineHeight:'var(--ax-fontSize-xl-lineHeight)'},'2xl':{fontSize:'var(--ax-fontSize-2xl-fontSize)',lineHeight:'var(--ax-fontSize-2xl-lineHeight)'},'3xl':{fontSize:'var(--ax-fontSize-3xl-fontSize)',lineHeight:'var(--ax-fontSize-3xl-lineHeight)'},'4xl':{fontSize:'var(--ax-fontSize-4xl-fontSize)',lineHeight:'var(--ax-fontSize-4xl-lineHeight)'}},maxSize:{xs:'var(--ax-maxSize-xs)',sm:'var(--ax-maxSize-sm)',md:'var(--ax-maxSize-md)',lg:'var(--ax-maxSize-lg)'},screens:{sm:'var(--ax-screens-sm)',md:'var(--ax-screens-md)'},size:{'2xs':'var(--ax-size-2xs)',xs:'var(--ax-size-xs)',sm:'var(--ax-size-sm)',md:'var(--ax-size-md)',lg:'var(--ax-size-lg)',xl:'var(--ax-size-xl)','3xl':'var(--ax-size-3xl)'},zIndex:{popover:'var(--ax-zIndex-popover)',toast:'var(--ax-zIndex-toast)',tooltip:'var(--ax-zIndex-tooltip)'}};
 
 const [ToastProviderProvider, useToastProviderContext] = reactContext.createContext("@optiaxiom/react/ToastProvider");
@@ -361,5 +363,7 @@ exports.createToaster = createToaster;
 exports.theme = theme;
 exports.toaster = toaster;
 exports.tokens = tokens;
+exports.unstable_SurfaceProvider = unstable_SurfaceProvider;
+exports.unstable_useSurfaceContext = unstable_useSurfaceContext;
 exports.useModalContext = useModalContext;
 exports.useToastProviderContext = useToastProviderContext;

package/dist/esm/index.js

@@ -1,5 +1,6 @@
 export { AxiomAuthContext, AxiomVersionContext } from './context.js';
 export { ModalProvider, useModalContext } from './modal-context.js';
+export { unstable_SurfaceProvider, unstable_useSurfaceContext } from './surface-context.js';
 export { theme } from './theme-css.js';
 export { ToastProviderProvider, useToastProviderContext } from './toast-context.js';
 export { createToaster, toaster } from './toaster.js';

package/dist/esm/surface-context.js

@@ -0,0 +1,5 @@
+import { createContext } from '@radix-ui/react-context';
+
+const [unstable_SurfaceProvider, unstable_useSurfaceContext] = createContext("@optiaxiom/globals/Surface", null);
+
+export { unstable_SurfaceProvider, unstable_useSurfaceContext };

package/dist/index.d.ts

@@ -26,6 +26,88 @@ declare const useModalContext: (consumerName: string) => {
     shardRef: RefObject<HTMLElement>;
 };
 
+type Surface<T extends Record<string, unknown> | undefined = Record<string, unknown> | undefined> = {
+    /**
+     * Optional data associated with this surface.
+     */
+    data?: T;
+    /**
+     * The surface name (used in surface path).
+     */
+    name: string;
+    /**
+     * The surface type.
+     */
+    type: "action" | "cards" | "collection" | "page" | "product" | "property" | "resource" | "tab";
+};
+type SurfaceContextValue = {
+    accept: (suggestionId: string) => void;
+    executeTool: (name: string, parameters: unknown) => Promise<void> | void;
+    metadata: Record<string, Omit<Surface, "name">>;
+    name: string;
+    pageViewId: string | undefined;
+    path: string;
+    reject: (suggestionId: string) => void;
+    renderSuggestionValue?: (value: unknown) => React.ReactNode;
+    suggestionPopover: {
+        register: () => () => void;
+        registered: boolean;
+    };
+    suggestions: SurfaceSuggestion[];
+    track: (interaction: SurfaceInteraction, metadata?: Record<string, Omit<Surface, "name">>) => void;
+    type: Surface["type"];
+};
+type SurfaceInteraction = {
+    id?: string;
+} & ({
+    checked: boolean;
+    name: "toggled";
+} | {
+    name: "added";
+    value: unknown;
+} | {
+    name: "blurred";
+} | {
+    name: "changed";
+    value: unknown;
+} | {
+    name: "focused";
+} | {
+    name: "invoked";
+} | {
+    name: "removed";
+    value: unknown;
+} | {
+    name: "viewed";
+});
+type SurfaceSuggestion = {
+    id: string;
+    surface: string;
+} & ({
+    cards: Array<{
+        data: unknown;
+        id: string;
+        name: string;
+        reason: string;
+    }>;
+    type: "cards";
+} | {
+    reason: string;
+    type: "value";
+    value: unknown;
+} | {
+    text: string;
+    tool?: {
+        name: string;
+        parameters: unknown;
+    };
+    type: "message";
+});
+declare const unstable_SurfaceProvider: react.FC<SurfaceContextValue & {
+    children: React.ReactNode;
+}>;
+declare const unstable_useSurfaceContext: (consumerName: string) => SurfaceContextValue | null;
+
 declare const theme: MapLeafNodes<{
     readonly borderRadius: {
         readonly xs: "2px";
@@ -414,5 +496,5 @@ declare const tokens: {
     };
 };
 
-export { AxiomAuthContext, AxiomVersionContext, ModalProvider, ToastProviderProvider, createToaster, theme, toaster, tokens, useModalContext, useToastProviderContext };
+export { AxiomAuthContext, AxiomVersionContext, ModalProvider, ToastProviderProvider, createToaster, theme, toaster, tokens, unstable_SurfaceProvider, unstable_useSurfaceContext, useModalContext, useToastProviderContext };
 export type { MapLeafNodes };

package/package.json

@@ -7,7 +7,7 @@
     "url": "git+https://github.com/optimizely-axiom/optiaxiom.git"
   },
   "type": "module",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "files": [
     "dist/**",
     "LICENSE"