@uniformdev/mesh-sdk-react 20.50.2-alpha.39 → 20.50.2-alpha.77

package/dist/index.d.mts

@@ -892,20 +892,35 @@ type DataTypeEditorProps = PropsWithChildren<{
  */
 declare function DataTypeEditor({ onChange, children, editVariableComponent }: DataTypeEditorProps): _emotion_react_jsx_runtime.JSX.Element;
 
-/** Status of the delegation session as seen from the React provider. */
+/**
+ * Status of the delegation session as seen from the React provider.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
+ */
 type DelegationStatus = 'idle' | 'acquiring' | 'active' | 'disabled' | 'error';
-/** Value provided by DelegationProvider via React context. */
+/**
+ * Value provided by DelegationProvider via React context.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
+ */
 interface DelegationContextValue {
     status: DelegationStatus;
     error: Error | null;
     reacquire: () => void;
 }
+/** @deprecated This beta identity delegation API may change with breaking changes. */
 declare const DelegationContext: React$1.Context<DelegationContextValue | null>;
 
+/**
+ * @deprecated This beta identity delegation API may change with breaking changes.
+ */
 interface DelegationGateProps {
     children: React__default.ReactNode;
+    /** Shown while delegation is starting. Omit to use the default loading UI. */
     loadingComponent?: React__default.ReactNode;
+    /** Shown when identity delegation is not enabled for this integration. Omit to use the default callout. */
     disabledComponent?: React__default.ReactNode;
+    /** Shown when delegation fails. Omit to use the default error callout. */
     errorComponent?: React__default.ReactNode | ((props: {
         error: Error;
     }) => React__default.ReactNode);
@@ -913,9 +928,17 @@ interface DelegationGateProps {
 /**
  * Renders children only when the delegation session is active.
  * Shows appropriate fallback UI for loading, disabled, and error states.
+ *
+ * Sensible defaults use the design system (loading overlay, callouts). Pass `loadingComponent`,
+ * `disabledComponent`, or `errorComponent` to customize; pass `null` to render nothing for that state.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
  */
 declare function DelegationGate({ children, loadingComponent, disabledComponent, errorComponent, }: DelegationGateProps): _emotion_react_jsx_runtime.JSX.Element | null;
 
+/**
+ * @deprecated This beta identity delegation API may change with breaking changes.
+ */
 interface DelegationProviderProps {
     /** `UniformMeshSDK` instance obtained from `useUniformMeshSdk()`. */
     sdk: UniformMeshSDK;
@@ -929,13 +952,39 @@ interface DelegationProviderProps {
      * Return `true` to skip the session-token exchange.
      */
     checkActive: () => Promise<boolean>;
+    /**
+     * When `true`, re-checks the delegation session after the tab becomes visible again
+     * following a period of being hidden. If the server reports the session is no longer
+     * active (e.g. the access token expired and the refresh token is gone/invalid), the
+     * full session-token exchange is re-run; otherwise the check is silent and does not
+     * flip the status back to `acquiring`.
+     *
+     * Defaults to `true`.
+     */
+    revalidateOnFocus?: boolean;
+    /**
+     * Minimum number of milliseconds the tab must have been hidden before a
+     * `revalidateOnFocus` check runs. Prevents hammering the server on rapid tab
+     * switches. Defaults to 5 minutes.
+     */
+    revalidateAfterMs?: number;
     children: React__default.ReactNode;
 }
 /**
  * Manages the identity delegation lifecycle: checks for an existing session, acquires a
  * session token from the dashboard parent if needed, and delegates exchange to the caller.
+ *
+ * Should ONLY be used to wrap locations which actually needed delegation and not the entire app like <MeshApp />.
+ *
+ * Also handles stale-session recovery: when the tab becomes visible again after being
+ * hidden for longer than `revalidateAfterMs`, the provider silently re-checks via
+ * `checkActive` and re-runs the session exchange only if the server says the session is
+ * no longer active. This covers the "returned after a long time" case where the stored
+ * access token has expired and the refresh token is also gone or no longer valid.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
  */
-declare function DelegationProvider({ sdk, onSessionToken, checkActive, children }: DelegationProviderProps): _emotion_react_jsx_runtime.JSX.Element;
+declare function DelegationProvider({ sdk, onSessionToken, checkActive, revalidateOnFocus, revalidateAfterMs, children, }: DelegationProviderProps): _emotion_react_jsx_runtime.JSX.Element;
 
 type MeshAppProps = {
     loadingComponent?: React__default.ComponentType;
@@ -2013,6 +2062,8 @@ declare function useConnectedDataAsVariables(connectedData: Record<string, unkno
 /**
  * Returns the current delegation session state.
  * Must be used within a `DelegationProvider`.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
  */
 declare function useDelegation(): DelegationContextValue;
 

package/dist/index.d.ts

@@ -892,20 +892,35 @@ type DataTypeEditorProps = PropsWithChildren<{
  */
 declare function DataTypeEditor({ onChange, children, editVariableComponent }: DataTypeEditorProps): _emotion_react_jsx_runtime.JSX.Element;
 
-/** Status of the delegation session as seen from the React provider. */
+/**
+ * Status of the delegation session as seen from the React provider.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
+ */
 type DelegationStatus = 'idle' | 'acquiring' | 'active' | 'disabled' | 'error';
-/** Value provided by DelegationProvider via React context. */
+/**
+ * Value provided by DelegationProvider via React context.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
+ */
 interface DelegationContextValue {
     status: DelegationStatus;
     error: Error | null;
     reacquire: () => void;
 }
+/** @deprecated This beta identity delegation API may change with breaking changes. */
 declare const DelegationContext: React$1.Context<DelegationContextValue | null>;
 
+/**
+ * @deprecated This beta identity delegation API may change with breaking changes.
+ */
 interface DelegationGateProps {
     children: React__default.ReactNode;
+    /** Shown while delegation is starting. Omit to use the default loading UI. */
     loadingComponent?: React__default.ReactNode;
+    /** Shown when identity delegation is not enabled for this integration. Omit to use the default callout. */
     disabledComponent?: React__default.ReactNode;
+    /** Shown when delegation fails. Omit to use the default error callout. */
     errorComponent?: React__default.ReactNode | ((props: {
         error: Error;
     }) => React__default.ReactNode);
@@ -913,9 +928,17 @@ interface DelegationGateProps {
 /**
  * Renders children only when the delegation session is active.
  * Shows appropriate fallback UI for loading, disabled, and error states.
+ *
+ * Sensible defaults use the design system (loading overlay, callouts). Pass `loadingComponent`,
+ * `disabledComponent`, or `errorComponent` to customize; pass `null` to render nothing for that state.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
  */
 declare function DelegationGate({ children, loadingComponent, disabledComponent, errorComponent, }: DelegationGateProps): _emotion_react_jsx_runtime.JSX.Element | null;
 
+/**
+ * @deprecated This beta identity delegation API may change with breaking changes.
+ */
 interface DelegationProviderProps {
     /** `UniformMeshSDK` instance obtained from `useUniformMeshSdk()`. */
     sdk: UniformMeshSDK;
@@ -929,13 +952,39 @@ interface DelegationProviderProps {
      * Return `true` to skip the session-token exchange.
      */
     checkActive: () => Promise<boolean>;
+    /**
+     * When `true`, re-checks the delegation session after the tab becomes visible again
+     * following a period of being hidden. If the server reports the session is no longer
+     * active (e.g. the access token expired and the refresh token is gone/invalid), the
+     * full session-token exchange is re-run; otherwise the check is silent and does not
+     * flip the status back to `acquiring`.
+     *
+     * Defaults to `true`.
+     */
+    revalidateOnFocus?: boolean;
+    /**
+     * Minimum number of milliseconds the tab must have been hidden before a
+     * `revalidateOnFocus` check runs. Prevents hammering the server on rapid tab
+     * switches. Defaults to 5 minutes.
+     */
+    revalidateAfterMs?: number;
     children: React__default.ReactNode;
 }
 /**
  * Manages the identity delegation lifecycle: checks for an existing session, acquires a
  * session token from the dashboard parent if needed, and delegates exchange to the caller.
+ *
+ * Should ONLY be used to wrap locations which actually needed delegation and not the entire app like <MeshApp />.
+ *
+ * Also handles stale-session recovery: when the tab becomes visible again after being
+ * hidden for longer than `revalidateAfterMs`, the provider silently re-checks via
+ * `checkActive` and re-runs the session exchange only if the server says the session is
+ * no longer active. This covers the "returned after a long time" case where the stored
+ * access token has expired and the refresh token is also gone or no longer valid.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
  */
-declare function DelegationProvider({ sdk, onSessionToken, checkActive, children }: DelegationProviderProps): _emotion_react_jsx_runtime.JSX.Element;
+declare function DelegationProvider({ sdk, onSessionToken, checkActive, revalidateOnFocus, revalidateAfterMs, children, }: DelegationProviderProps): _emotion_react_jsx_runtime.JSX.Element;
 
 type MeshAppProps = {
     loadingComponent?: React__default.ComponentType;
@@ -2013,6 +2062,8 @@ declare function useConnectedDataAsVariables(connectedData: Record<string, unkno
 /**
  * Returns the current delegation session state.
  * Must be used within a `DelegationProvider`.
+ *
+ * @deprecated This beta identity delegation API may change with breaking changes.
  */
 declare function useDelegation(): DelegationContextValue;