@bravostudioai/react 0.1.28 → 0.1.30

package/src/stores/useEncoreState.ts

@@ -3,32 +3,76 @@ import { create } from "zustand";
 
 import { CONST_APPS_SERVICE_URL } from "../../constants";
 
-type EncoreState = {
+/**
+ * Global state for the Encore runtime
+ *
+ * Manages app data, form inputs, authentication, and UI state across
+ * all Encore components in the application.
+ */
+export type EncoreState = {
+  /** Current app definition loaded from Encore service */
   app: any;
+
+  /** Base URL for Encore service API requests */
   baseURL: string;
+
+  /** Authentication token with expiration and refresh capability */
   accessToken?: {
     expireAt: number;
     token: string;
     refreshToken: string;
     params: string;
   };
+
+  /** Currently loaded app ID */
   appId?: string;
+
+  /** Form input values organized by page ID, then by component ID */
   formInputs: Record<string, Record<string, any>>;
+
+  /** Currently loaded page ID */
   pageId?: string;
+
+  /** Component variant selections for stateful sets */
   statefulSetVariants: Record<string, string>;
-  inputGroups: Record<string, string>; // Maps group name to active element name
+
+  /** Input group selections - maps group name to active element name */
+  inputGroups: Record<string, string>;
+
+  /** Asset lookup by ID (images, videos, etc.) */
   assetsById: Record<string, any>;
+
+  /** Font family names by font ID */
   fontsById: Record<string, string>;
+
+  /** Full font metadata by font ID */
   fontsByIdFull: Record<string, { family: string; postScriptName?: string }>;
 
+  /** Clear all form inputs across all pages */
   resetFormInputs: () => void;
+
+  /** Set authentication token */
   setAccessToken: (accessToken: EncoreState["accessToken"]) => void;
+
+  /** Set app definition and extract assets/fonts */
   setApp: (app: any) => void;
+
+  /** Set current app ID */
   setAppId: (appId: string) => void;
+
+  /** Set form input value for current page */
   setFormInputValue: (nodeId: string, value: any) => void;
+
+  /** Set current page ID */
   setPageId: (pageId: string) => void;
+
+  /** Set active variant for a stateful set component */
   setStatefulSetVariant: (statefulSetId: string, variant: string) => void;
+
+  /** Set active element for an input group */
   setInputGroupValue: (groupName: string, elementName: string) => void;
+
+  /** Set base URL for Encore service */
   setBaseURL: (baseURL: string) => void;
 };
 
@@ -126,4 +170,20 @@ const useEncoreState = create<EncoreState>((set) => ({
   setBaseURL: (baseURL) => set((state) => ({ ...state, baseURL })),
 }));
 
+/**
+ * Global Zustand store for Encore runtime state
+ *
+ * Provides centralized state management for app data, form inputs,
+ * authentication, and UI state across all Encore components.
+ *
+ * @example
+ * // Access state in a component
+ * const app = useEncoreState((state) => state.app);
+ * const setFormValue = useEncoreState((state) => state.setFormInputValue);
+ *
+ * @example
+ * // Access state outside React components
+ * const currentApp = useEncoreState.getState().app;
+ * useEncoreState.getState().setAppId('01ABC123');
+ */
 export default useEncoreState;

package/src/version.ts

@@ -1 +1 @@
-export const PACKAGE_VERSION = "0.1.28";
+export const PACKAGE_VERSION = "0.1.30";