@object-ui/auth 3.0.0 → 3.0.2

package/README.md

@@ -10,6 +10,7 @@ Authentication system for Object UI — AuthProvider, guards, login/register for
 - 👤 **UserMenu** - Display authenticated user info with sign-out support
 - 🔑 **Auth Client Factory** - `createAuthClient` for pluggable backend integration
 - 🌐 **Authenticated Fetch** - `createAuthenticatedFetch` for automatic token injection
+- 👀 **Preview Mode** - Auto-login with simulated identity for marketplace demos and app showcases
 - 🎯 **Type-Safe** - Full TypeScript support with exported types
 
 ## Installation
@@ -71,9 +72,31 @@ Wraps your application with authentication context:
 Hook for accessing auth state and methods:
 
 ```tsx
-const { user, session, signIn, signOut, signUp, isAuthenticated, isLoading } = useAuth();
+const {
+  user,
+  session,
+  signIn,
+  signOut,
+  signUp,
+  isAuthenticated,
+  isLoading,
+  isPreviewMode,
+  previewMode,
+} = useAuth();
 ```
 
+| Property | Type | Description |
+| --- | --- | --- |
+| `user` | `AuthUser \| null` | Current authenticated user |
+| `session` | `AuthSession \| null` | Current session information |
+| `isAuthenticated` | `boolean` | Whether the user is authenticated |
+| `isLoading` | `boolean` | Whether auth state is loading |
+| `isPreviewMode` | `boolean` | Whether the app is running in preview mode |
+| `previewMode` | `PreviewModeOptions \| null` | Preview mode configuration (only set when `isPreviewMode` is true) |
+| `signIn` | `(email, password) => Promise` | Sign in with credentials |
+| `signOut` | `() => Promise` | Sign out the current user |
+| `signUp` | `(name, email, password) => Promise` | Register a new user |
+
 ### AuthGuard
 
 Protects children from unauthenticated access:
@@ -110,6 +133,75 @@ Creates a fetch wrapper that injects auth tokens into DataSource requests:
 const authedFetch = createAuthenticatedFetch({ getToken: () => session.token });
 ```
 
+## Preview Mode
+
+Preview mode allows visitors (e.g. marketplace customers) to explore the platform without registering or logging in. The `AuthProvider` auto-authenticates with a simulated user identity and bypasses login/registration screens.
+
+This feature aligns with the `PreviewModeConfig` from `@objectstack/spec/kernel` ([spec PR #676](https://github.com/objectstack-ai/spec/pull/676)).
+
+### Usage
+
+```tsx
+import { AuthProvider, PreviewBanner } from '@object-ui/auth';
+
+function App() {
+  return (
+    <AuthProvider
+      authUrl="/api/auth"
+      previewMode={{
+        simulatedRole: 'admin',
+        simulatedUserName: 'Demo Admin',
+        readOnly: false,
+        bannerMessage: 'You are exploring a demo — data will be reset periodically.',
+      }}
+    >
+      <PreviewBanner />
+      <Dashboard />
+    </AuthProvider>
+  );
+}
+```
+
+### PreviewModeOptions
+
+| Property | Type | Default | Description |
+| --- | --- | --- | --- |
+| `autoLogin` | `boolean` | `true` | Auto-login as simulated user, skipping login/registration pages |
+| `simulatedRole` | `'admin' \| 'user' \| 'viewer'` | `'admin'` | Permission role for the simulated preview user |
+| `simulatedUserName` | `string` | `'Preview User'` | Display name for the simulated preview user |
+| `readOnly` | `boolean` | `false` | Restrict the preview session to read-only operations |
+| `expiresInSeconds` | `number` | `0` | Preview session duration in seconds (0 = no expiration) |
+| `bannerMessage` | `string` | — | Banner message displayed in the UI during preview mode |
+
+### PreviewBanner
+
+A component that renders a status banner when preview mode is active. Shows `bannerMessage` from the preview config, or a default message.
+
+```tsx
+import { PreviewBanner } from '@object-ui/auth';
+
+// Only renders when isPreviewMode is true
+<PreviewBanner />
+```
+
+### Detecting Preview Mode
+
+Use the `useAuth` hook to check if the app is in preview mode:
+
+```tsx
+function MyComponent() {
+  const { isPreviewMode, previewMode } = useAuth();
+
+  if (isPreviewMode && previewMode?.readOnly) {
+    // Disable write operations
+  }
+
+  return <div>...</div>;
+}
+```
+
+> **⚠️ Security:** Preview mode should **never** be used in production environments.
+
 ## License
 
 MIT

package/dist/AuthContext.d.ts

@@ -5,7 +5,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { AuthUser, AuthSession } from './types';
+import type { AuthUser, AuthSession, PreviewModeOptions } from './types';
 export interface AuthContextValue {
     /** Current authenticated user */
     user: AuthUser | null;
@@ -17,6 +17,10 @@ export interface AuthContextValue {
     isLoading: boolean;
     /** Authentication error */
     error: Error | null;
+    /** Whether the app is running in preview mode */
+    isPreviewMode: boolean;
+    /** Preview mode configuration (only set when isPreviewMode is true) */
+    previewMode: PreviewModeOptions | null;
     /** Sign in with email and password */
     signIn: (email: string, password: string) => Promise<void>;
     /** Sign up with name, email, and password */

package/dist/AuthContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AuthContext.d.ts","sourceRoot":"","sources":["../src/AuthContext.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAErD,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,kCAAkC;IAClC,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,wCAAwC;IACxC,eAAe,EAAE,OAAO,CAAC;IACzB,oCAAoC;IACpC,SAAS,EAAE,OAAO,CAAC;IACnB,2BAA2B;IAC3B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,sCAAsC;IACtC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,6CAA6C;IAC7C,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE,gCAAgC;IAChC,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,0BAA0B;IAC1B,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,6BAA6B;IAC7B,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,gCAAgC;IAChC,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtE;AAED,eAAO,MAAM,OAAO,kDAA+C,CAAC"}
+{"version":3,"file":"AuthContext.d.ts","sourceRoot":"","sources":["../src/AuthContext.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAEzE,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,kCAAkC;IAClC,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,wCAAwC;IACxC,eAAe,EAAE,OAAO,CAAC;IACzB,oCAAoC;IACpC,SAAS,EAAE,OAAO,CAAC;IACnB,2BAA2B;IAC3B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,iDAAiD;IACjD,aAAa,EAAE,OAAO,CAAC;IACvB,uEAAuE;IACvE,WAAW,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACvC,sCAAsC;IACtC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,6CAA6C;IAC7C,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE,gCAAgC;IAChC,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,0BAA0B;IAC1B,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,6BAA6B;IAC7B,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,gCAAgC;IAChC,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtE;AAED,eAAO,MAAM,OAAO,kDAA+C,CAAC"}

package/dist/AuthProvider.d.ts

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import type { AuthProviderConfig } from './types';
+import type { AuthProviderConfig, PreviewModeOptions } from './types';
 export interface AuthProviderProps extends AuthProviderConfig {
     children: React.ReactNode;
     /**
@@ -16,6 +16,12 @@ export interface AuthProviderProps extends AuthProviderConfig {
      * @default true
      */
     enabled?: boolean;
+    /**
+     * Preview mode configuration.
+     * When provided, the auth provider auto-logs in a simulated user and bypasses
+     * login/registration screens. Useful for marketplace demos and app showcases.
+     */
+    previewMode?: PreviewModeOptions;
 }
 /**
  * Authentication context provider.
@@ -36,6 +42,12 @@ export interface AuthProviderProps extends AuthProviderConfig {
  *   <App />
  * </AuthProvider>
  * ```
+ * @example With preview mode (marketplace demo)
+ * ```tsx
+ * <AuthProvider authUrl="/api/auth" previewMode={{ simulatedRole: 'admin', bannerMessage: 'Demo mode' }}>
+ *   <App />
+ * </AuthProvider>
+ * ```
  */
-export declare function AuthProvider({ authUrl, client: externalClient, onAuthStateChange, enabled, children, }: AuthProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function AuthProvider({ authUrl, client: externalClient, onAuthStateChange, enabled, previewMode, children, }: AuthProviderProps): import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=AuthProvider.d.ts.map

package/dist/AuthProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AuthProvider.d.ts","sourceRoot":"","sources":["../src/AuthProvider.tsx"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAoD,MAAM,OAAO,CAAC;AACzE,OAAO,KAAK,EAAwB,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAIxE,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,YAAY,CAAC,EAC3B,OAAO,EACP,MAAM,EAAE,cAAc,EACtB,iBAAiB,EACjB,OAAc,EACd,QAAQ,GACT,EAAE,iBAAiB,2CAqLnB"}
+{"version":3,"file":"AuthProvider.d.ts","sourceRoot":"","sources":["../src/AuthProvider.tsx"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAoD,MAAM,OAAO,CAAC;AACzE,OAAO,KAAK,EAAwB,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAI5F,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,YAAY,CAAC,EAC3B,OAAO,EACP,MAAM,EAAE,cAAc,EACtB,iBAAiB,EACjB,OAAc,EACd,WAAW,EACX,QAAQ,GACT,EAAE,iBAAiB,2CAgNnB"}

package/dist/AuthProvider.js

@@ -28,19 +28,48 @@ import { createAuthClient } from './createAuthClient';
  *   <App />
  * </AuthProvider>
  * ```
+ * @example With preview mode (marketplace demo)
+ * ```tsx
+ * <AuthProvider authUrl="/api/auth" previewMode={{ simulatedRole: 'admin', bannerMessage: 'Demo mode' }}>
+ *   <App />
+ * </AuthProvider>
+ * ```
  */
-export function AuthProvider({ authUrl, client: externalClient, onAuthStateChange, enabled = true, children, }) {
+export function AuthProvider({ authUrl, client: externalClient, onAuthStateChange, enabled = true, previewMode, children, }) {
     const client = useMemo(() => externalClient ?? createAuthClient({ baseURL: authUrl }), [externalClient, authUrl]);
     const [user, setUser] = useState(null);
     const [session, setSession] = useState(null);
     const [isLoading, setIsLoading] = useState(true);
     const [error, setError] = useState(null);
-    // If auth is disabled, automatically set as authenticated with a guest user
-    const isAuthenticated = enabled
+    // Determine if we're in preview mode
+    const isPreviewMode = previewMode != null;
+    // If auth is disabled or in preview mode, automatically set as authenticated
+    const isAuthenticated = (enabled && !isPreviewMode)
         ? user !== null && session !== null
         : true;
-    // Load session on mount (only if auth is enabled)
+    // Load session on mount (only if auth is enabled and not in preview mode)
     useEffect(() => {
+        if (isPreviewMode) {
+            // Preview mode: simulate a user based on previewMode config
+            const role = previewMode.simulatedRole ?? 'admin';
+            const name = previewMode.simulatedUserName ?? 'Preview User';
+            const expiresInSeconds = previewMode.expiresInSeconds ?? 0;
+            setUser({
+                id: 'preview-user',
+                email: 'preview@preview.local',
+                name,
+                role,
+                roles: [role],
+            });
+            setSession({
+                token: 'preview-token',
+                expiresAt: expiresInSeconds > 0
+                    ? new Date(Date.now() + expiresInSeconds * 1000)
+                    : new Date(Date.now() + 365 * 24 * 60 * 60 * 1000),
+            });
+            setIsLoading(false);
+            return;
+        }
         if (!enabled) {
             // When auth is disabled, set a guest user and mark as loaded
             setUser({
@@ -79,7 +108,7 @@ export function AuthProvider({ authUrl, client: externalClient, onAuthStateChang
         }
         loadSession();
         return () => { cancelled = true; };
-    }, [client, enabled]);
+    }, [client, enabled, isPreviewMode, previewMode]);
     // Notify on auth state changes
     useEffect(() => {
         onAuthStateChange?.({
@@ -179,12 +208,14 @@ export function AuthProvider({ authUrl, client: externalClient, onAuthStateChang
         isAuthenticated,
         isLoading,
         error,
+        isPreviewMode,
+        previewMode: isPreviewMode ? previewMode : null,
         signIn,
         signUp,
         signOut,
         updateUser,
         forgotPassword,
         resetPassword,
-    }), [user, session, isAuthenticated, isLoading, error, signIn, signUp, signOut, updateUser, forgotPassword, resetPassword]);
+    }), [user, session, isAuthenticated, isLoading, error, isPreviewMode, previewMode, signIn, signUp, signOut, updateUser, forgotPassword, resetPassword]);
     return _jsx(AuthCtx.Provider, { value: value, children: children });
 }

package/dist/PreviewBanner.d.ts

@@ -0,0 +1,23 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export interface PreviewBannerProps {
+    /** Custom class name for the banner */
+    className?: string;
+}
+/**
+ * Banner component that displays a message when the app is in preview mode.
+ * Only renders when preview mode is active. Uses the bannerMessage from
+ * preview mode config, or a default message if none is provided.
+ *
+ * @example
+ * ```tsx
+ * <PreviewBanner />
+ * ```
+ */
+export declare function PreviewBanner({ className }: PreviewBannerProps): import("react/jsx-runtime").JSX.Element | null;
+//# sourceMappingURL=PreviewBanner.d.ts.map

package/dist/PreviewBanner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreviewBanner.d.ts","sourceRoot":"","sources":["../src/PreviewBanner.tsx"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH,MAAM,WAAW,kBAAkB;IACjC,uCAAuC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,kBAAkB,kDAyB9D"}

package/dist/PreviewBanner.js

@@ -0,0 +1,27 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useAuth } from './useAuth';
+/**
+ * Banner component that displays a message when the app is in preview mode.
+ * Only renders when preview mode is active. Uses the bannerMessage from
+ * preview mode config, or a default message if none is provided.
+ *
+ * @example
+ * ```tsx
+ * <PreviewBanner />
+ * ```
+ */
+export function PreviewBanner({ className }) {
+    const { isPreviewMode, previewMode } = useAuth();
+    if (!isPreviewMode) {
+        return null;
+    }
+    const message = previewMode?.bannerMessage ?? 'You are in preview mode.';
+    return (_jsx("div", { role: "status", className: className, style: {
+            padding: '8px 16px',
+            backgroundColor: '#fef3c7',
+            color: '#92400e',
+            textAlign: 'center',
+            fontSize: '14px',
+            borderBottom: '1px solid #fcd34d',
+        }, children: message }));
+}

package/dist/index.d.ts

@@ -26,9 +26,10 @@ export { LoginForm, type LoginFormProps } from './LoginForm';
 export { RegisterForm, type RegisterFormProps } from './RegisterForm';
 export { ForgotPasswordForm, type ForgotPasswordFormProps } from './ForgotPasswordForm';
 export { UserMenu, type UserMenuProps } from './UserMenu';
+export { PreviewBanner, type PreviewBannerProps } from './PreviewBanner';
 export { createAuthClient } from './createAuthClient';
 export { createAuthenticatedFetch, type AuthenticatedAdapterOptions } from './createAuthenticatedFetch';
 export { getUserInitials } from './types';
-export type { AuthUser, AuthSession, AuthState, AuthClient, AuthClientConfig, AuthProviderConfig, SignInCredentials, SignUpData, } from './types';
+export type { AuthUser, AuthSession, AuthState, AuthClient, AuthClientConfig, AuthProviderConfig, PreviewModeOptions, SignInCredentials, SignUpData, } from './types';
 export type { AuthContextValue } from './AuthContext';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAE,KAAK,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AACxG,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG1C,YAAY,EACV,QAAQ,EACR,WAAW,EACX,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,GACX,MAAM,SAAS,CAAC;AAEjB,YAAY,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAE,KAAK,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AACxG,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG1C,YAAY,EACV,QAAQ,EACR,WAAW,EACX,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,GACX,MAAM,SAAS,CAAC;AAEjB,YAAY,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -26,6 +26,7 @@ export { LoginForm } from './LoginForm';
 export { RegisterForm } from './RegisterForm';
 export { ForgotPasswordForm } from './ForgotPasswordForm';
 export { UserMenu } from './UserMenu';
+export { PreviewBanner } from './PreviewBanner';
 export { createAuthClient } from './createAuthClient';
 export { createAuthenticatedFetch } from './createAuthenticatedFetch';
 export { getUserInitials } from './types';

package/dist/types.d.ts

@@ -98,6 +98,25 @@ export interface AuthClient {
     /** Update user profile */
     updateUser: (data: Partial<AuthUser>) => Promise<AuthUser>;
 }
+/**
+ * Preview mode configuration options.
+ * When preview mode is active, the auth provider auto-logs in a simulated user
+ * and bypasses login/registration screens.
+ */
+export interface PreviewModeOptions {
+    /** Auto-login as simulated user, skipping login/registration pages */
+    autoLogin?: boolean;
+    /** Permission role for the simulated preview user */
+    simulatedRole?: 'admin' | 'user' | 'viewer';
+    /** Display name for the simulated preview user */
+    simulatedUserName?: string;
+    /** Restrict the preview session to read-only operations */
+    readOnly?: boolean;
+    /** Preview session duration in seconds (0 = no expiration) */
+    expiresInSeconds?: number;
+    /** Banner message displayed in the UI during preview mode */
+    bannerMessage?: string;
+}
 /** Auth provider configuration */
 export interface AuthProviderConfig {
     /** Authentication server URL */

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;GAEG;AAEH,qCAAqC;AACrC,MAAM,WAAW,QAAQ;IACvB,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,gCAAgC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,+BAA+B;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAWjG;AAED,0BAA0B;AAC1B,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,2BAA2B;AAC3B,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,sBAAsB;IACtB,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,wCAAwC;IACxC,eAAe,EAAE,OAAO,CAAC;IACzB,oCAAoC;IACpC,SAAS,EAAE,OAAO,CAAC;IACnB,2BAA2B;IAC3B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;CACrB;AAED,0BAA0B;AAC1B,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,mBAAmB;AACnB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,gCAAgC;AAChC,MAAM,WAAW,gBAAgB;IAC/B,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;CACxB;AAED,oEAAoE;AACpE,MAAM,WAAW,UAAU;IACzB,kCAAkC;IAClC,MAAM,EAAE,CAAC,WAAW,EAAE,iBAAiB,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAC9F,kCAAkC;IAClC,MAAM,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAChF,eAAe;IACf,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,0BAA0B;IAC1B,UAAU,EAAE,MAAM,OAAO,CAAC;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAE,GAAG,IAAI,CAAC,CAAC;IAC3E,6BAA6B;IAC7B,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,gCAAgC;IAChC,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACrE,0BAA0B;IAC1B,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC5D;AAED,kCAAkC;AAClC,MAAM,WAAW,kBAAkB;IACjC,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,uCAAuC;IACvC,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IAC/C,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;GAEG;AAEH,qCAAqC;AACrC,MAAM,WAAW,QAAQ;IACvB,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,gCAAgC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,+BAA+B;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAWjG;AAED,0BAA0B;AAC1B,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,2BAA2B;AAC3B,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,sBAAsB;IACtB,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,wCAAwC;IACxC,eAAe,EAAE,OAAO,CAAC;IACzB,oCAAoC;IACpC,SAAS,EAAE,OAAO,CAAC;IACnB,2BAA2B;IAC3B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;CACrB;AAED,0BAA0B;AAC1B,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,mBAAmB;AACnB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,gCAAgC;AAChC,MAAM,WAAW,gBAAgB;IAC/B,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;CACxB;AAED,oEAAoE;AACpE,MAAM,WAAW,UAAU;IACzB,kCAAkC;IAClC,MAAM,EAAE,CAAC,WAAW,EAAE,iBAAiB,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAC9F,kCAAkC;IAClC,MAAM,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAChF,eAAe;IACf,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,0BAA0B;IAC1B,UAAU,EAAE,MAAM,OAAO,CAAC;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAE,GAAG,IAAI,CAAC,CAAC;IAC3E,6BAA6B;IAC7B,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,gCAAgC;IAChC,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACrE,0BAA0B;IAC1B,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC5D;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,qDAAqD;IACrD,aAAa,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;IAC5C,kDAAkD;IAClD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,kCAAkC;AAClC,MAAM,WAAW,kBAAkB;IACjC,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,uCAAuC;IACvC,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IAC/C,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/dist/useAuth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useAuth.d.ts","sourceRoot":"","sources":["../src/useAuth.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAW,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE/D;;;;;;;;;;;;GAYG;AACH,wBAAgB,OAAO,IAAI,gBAAgB,CAqB1C"}
+{"version":3,"file":"useAuth.d.ts","sourceRoot":"","sources":["../src/useAuth.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAW,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE/D;;;;;;;;;;;;GAYG;AACH,wBAAgB,OAAO,IAAI,gBAAgB,CAuB1C"}

package/dist/useAuth.js

@@ -30,6 +30,8 @@ export function useAuth() {
             isAuthenticated: false,
             isLoading: false,
             error: null,
+            isPreviewMode: false,
+            previewMode: null,
             signIn: async () => { throw new Error('useAuth must be used within an AuthProvider'); },
             signUp: async () => { throw new Error('useAuth must be used within an AuthProvider'); },
             signOut: async () => { throw new Error('useAuth must be used within an AuthProvider'); },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/auth",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "type": "module",
   "license": "MIT",
   "description": "Authentication system for Object UI with AuthProvider, useAuth hook, AuthGuard, and form components.",
@@ -26,7 +26,7 @@
     "react": "^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@object-ui/types": "3.0.0"
+    "@object-ui/types": "3.0.2"
   },
   "devDependencies": {
     "@types/react": "19.2.13",