@vaultix.ai/react 0.3.2 → 0.3.4

package/dist/index.d.mts

@@ -22,6 +22,7 @@ interface VaultixUser {
     firstName: string | null;
     lastName: string | null;
     imageUrl: string | null;
+    publicMetadata: Record<string, unknown>;
     createdAt: number;
     updatedAt: number;
 }
@@ -58,13 +59,26 @@ interface ConnectPlatformOptions {
     /** Where to redirect after the user authorizes. Defaults to current page. */
     redirectUrl?: string;
 }
+interface UpdateUserParams {
+    firstName?: string | null;
+    lastName?: string | null;
+    imageUrl?: string | null;
+    publicMetadata?: Record<string, unknown>;
+    /** Requires currentPassword when changing password. */
+    newPassword?: string;
+    currentPassword?: string;
+}
 interface VaultixContextValue {
     user: VaultixUser | null;
     session: VaultixSession | null;
     organization: VaultixOrganization | null;
     isLoaded: boolean;
     isSignedIn: boolean;
-    signOut: () => Promise<void>;
+    /** Resolved API origin derived from the publishable key. */
+    apiOrigin: string;
+    signOut: (redirectUrl?: string) => Promise<void>;
+    /** Update the current user's profile. Resolves with the updated user. */
+    updateUser: (params: UpdateUserParams) => Promise<VaultixUser>;
     /**
      * Initiate a platform OAuth connection flow (posting, reading, etc.).
      * Redirects the user to the provider's authorization page via Vaultix.
@@ -73,6 +87,28 @@ interface VaultixContextValue {
      */
     connectPlatform: (provider: string, options?: ConnectPlatformOptions) => void;
 }
+interface VaultixAppearanceVariables {
+    /** Primary accent color — used for buttons, focus rings, and icons. Accepts any CSS color value. */
+    colorPrimary?: string;
+    /** Card / form background. Default: dark glass (rgba(22,27,45,0.92)). */
+    colorBackground?: string;
+    /** Primary text color. Default: rgba(255,255,255,0.9). */
+    colorText?: string;
+    /** Secondary / muted text color. Default: #475569. */
+    colorTextMuted?: string;
+}
+interface VaultixAppearance {
+    variables?: VaultixAppearanceVariables;
+}
+interface PlatformConnectResult {
+    provider: string;
+    platformUserId?: string;
+    username?: string;
+    accessToken?: string;
+    scope?: string;
+    /** Full decoded JWT payload. */
+    raw: Record<string, unknown>;
+}
 interface VaultixProviderProps {
     publishableKey: string;
     /** Required for smritix_ keys. The base URL of your auth-engine (no trailing slash). */
@@ -93,6 +129,8 @@ interface UseUserReturn {
     user: VaultixUser | null;
     isLoaded: boolean;
     isSignedIn: boolean;
+    /** Update the current user's profile fields or password. */
+    update: (params: UpdateUserParams) => Promise<VaultixUser>;
 }
 interface UseOrganizationReturn {
     organization: VaultixOrganization | null;
@@ -102,7 +140,7 @@ interface UseOrganizationReturn {
 declare function useVaultix(): VaultixContextValue;
 /** Returns the current session and its loading state. */
 declare function useSession(): UseSessionReturn;
-/** Returns the current user and their loading state. */
+/** Returns the current user, their loading state, and an update function. */
 declare function useUser(): UseUserReturn;
 /** Returns the active organization for the current session. */
 declare function useOrganization(): UseOrganizationReturn;
@@ -116,7 +154,29 @@ interface UseAuthReturn {
     /** Returns the session JWT for use in API calls via Authorization: Bearer header. */
     getToken: () => Promise<string | null>;
 }
-/** Clerk-compatible auth hook. Returns key auth identifiers and helpers. */
+interface UsePlatformConnectReturn {
+    /** Redirect the user to the provider's OAuth authorization page. */
+    connect: (overrides?: ConnectPlatformOptions) => void;
+    /**
+     * Non-null immediately after the OAuth callback lands on the current page.
+     * The token is parsed from `__vaultix_connect` in the URL and then removed
+     * from the address bar. Null if the user has not connected yet this page load.
+     */
+    connectedAccount: PlatformConnectResult | null;
+}
+/**
+ * Hook for connecting a social/platform account via Vaultix OAuth.
+ *
+ * @example
+ * const { connect, connectedAccount } = usePlatformConnect("google", {
+ *   scopes: ["https://www.googleapis.com/auth/youtube.upload"],
+ * });
+ *
+ * // After connect() → user returns with __vaultix_connect in URL
+ * // connectedAccount.accessToken has the token; URL is cleaned automatically
+ */
+declare function usePlatformConnect(provider: string, defaultOptions?: ConnectPlatformOptions): UsePlatformConnectReturn;
+/** Returns key auth identifiers and helpers. */
 declare function useAuth(): UseAuthReturn;
 
 interface SignInProps {
@@ -128,8 +188,10 @@ interface SignInProps {
     /** API origin — injected by VaultixProvider via DOM attribute, or pass directly. */
     apiOrigin?: string;
     className?: string;
+    /** Override colors and card background. */
+    appearance?: VaultixAppearance;
 }
-declare function SignIn({ redirectUrl, onSuccess, onError, apiOrigin: apiOriginProp, className, }: SignInProps): react_jsx_runtime.JSX.Element;
+declare function SignIn({ redirectUrl, onSuccess, onError, apiOrigin: apiOriginProp, className, appearance, }: SignInProps): react_jsx_runtime.JSX.Element;
 
 interface SignUpProps {
     redirectUrl?: string;
@@ -137,8 +199,10 @@ interface SignUpProps {
     onError?: (message: string) => void;
     apiOrigin?: string;
     className?: string;
+    /** Override colors and card background. */
+    appearance?: VaultixAppearance;
 }
-declare function SignUp({ redirectUrl, onSuccess, onError, apiOrigin: apiOriginProp, className, }: SignUpProps): react_jsx_runtime.JSX.Element;
+declare function SignUp({ redirectUrl, onSuccess, onError, apiOrigin: apiOriginProp, className, appearance, }: SignUpProps): react_jsx_runtime.JSX.Element;
 
 /** Renders children only when the user is signed in and auth is loaded. */
 declare function SignedIn({ children }: {
@@ -159,12 +223,11 @@ declare function RedirectToSignIn({ redirectUrl }: RedirectProps): null;
 declare function RedirectToSignUp({ redirectUrl }: RedirectProps): null;
 
 interface UserButtonProps {
-    /** Show the user's name next to the avatar. Default false. */
     showName?: boolean;
     afterSignOutUrl?: string;
     className?: string;
 }
-declare function UserButton({ showName, afterSignOutUrl, className, }: UserButtonProps): react_jsx_runtime.JSX.Element | null;
+declare function UserButton({ showName, afterSignOutUrl, className }: UserButtonProps): react_jsx_runtime.JSX.Element | null;
 
 interface OrganizationSwitcherProps {
     afterSwitchUrl?: string;
@@ -172,9 +235,9 @@ interface OrganizationSwitcherProps {
 }
 declare function OrganizationSwitcher({ afterSwitchUrl, className, }: OrganizationSwitcherProps): react_jsx_runtime.JSX.Element | null;
 
-/** Returns the stored session JWT, or null if not signed in. */
+/** Returns the stored session JWT from the vaultix-token cookie, or null if not signed in. */
 declare function getStoredToken(): string | null;
 /** Clears the stored session JWT. Call on 401 so the user is prompted to sign in again. */
 declare function clearStoredToken(): void;
 
-export { type ChallengeType, type ConnectPlatformOptions, OrganizationSwitcher, RedirectToSignIn, RedirectToSignUp, type RiskLevel, type SessionClaims, SignIn, SignUp, SignedIn, SignedOut, UserButton, type VaultixContextValue, type VaultixOrganization, VaultixProvider, type VaultixProviderProps, type VaultixSession, type VaultixUser, clearStoredToken, getStoredToken, useAuth, useOrganization, useSession, useUser, useVaultix };
+export { type ChallengeType, type ConnectPlatformOptions, OrganizationSwitcher, type PlatformConnectResult, RedirectToSignIn, RedirectToSignUp, type RiskLevel, type SessionClaims, SignIn, SignUp, SignedIn, SignedOut, type UpdateUserParams, UserButton, type VaultixAppearance, type VaultixAppearanceVariables, type VaultixContextValue, type VaultixOrganization, VaultixProvider, type VaultixProviderProps, type VaultixSession, type VaultixUser, clearStoredToken, getStoredToken, useAuth, useOrganization, usePlatformConnect, useSession, useUser, useVaultix };

package/dist/index.d.ts

@@ -22,6 +22,7 @@ interface VaultixUser {
     firstName: string | null;
     lastName: string | null;
     imageUrl: string | null;
+    publicMetadata: Record<string, unknown>;
     createdAt: number;
     updatedAt: number;
 }
@@ -58,13 +59,26 @@ interface ConnectPlatformOptions {
     /** Where to redirect after the user authorizes. Defaults to current page. */
     redirectUrl?: string;
 }
+interface UpdateUserParams {
+    firstName?: string | null;
+    lastName?: string | null;
+    imageUrl?: string | null;
+    publicMetadata?: Record<string, unknown>;
+    /** Requires currentPassword when changing password. */
+    newPassword?: string;
+    currentPassword?: string;
+}
 interface VaultixContextValue {
     user: VaultixUser | null;
     session: VaultixSession | null;
     organization: VaultixOrganization | null;
     isLoaded: boolean;
     isSignedIn: boolean;
-    signOut: () => Promise<void>;
+    /** Resolved API origin derived from the publishable key. */
+    apiOrigin: string;
+    signOut: (redirectUrl?: string) => Promise<void>;
+    /** Update the current user's profile. Resolves with the updated user. */
+    updateUser: (params: UpdateUserParams) => Promise<VaultixUser>;
     /**
      * Initiate a platform OAuth connection flow (posting, reading, etc.).
      * Redirects the user to the provider's authorization page via Vaultix.
@@ -73,6 +87,28 @@ interface VaultixContextValue {
      */
     connectPlatform: (provider: string, options?: ConnectPlatformOptions) => void;
 }
+interface VaultixAppearanceVariables {
+    /** Primary accent color — used for buttons, focus rings, and icons. Accepts any CSS color value. */
+    colorPrimary?: string;
+    /** Card / form background. Default: dark glass (rgba(22,27,45,0.92)). */
+    colorBackground?: string;
+    /** Primary text color. Default: rgba(255,255,255,0.9). */
+    colorText?: string;
+    /** Secondary / muted text color. Default: #475569. */
+    colorTextMuted?: string;
+}
+interface VaultixAppearance {
+    variables?: VaultixAppearanceVariables;
+}
+interface PlatformConnectResult {
+    provider: string;
+    platformUserId?: string;
+    username?: string;
+    accessToken?: string;
+    scope?: string;
+    /** Full decoded JWT payload. */
+    raw: Record<string, unknown>;
+}
 interface VaultixProviderProps {
     publishableKey: string;
     /** Required for smritix_ keys. The base URL of your auth-engine (no trailing slash). */
@@ -93,6 +129,8 @@ interface UseUserReturn {
     user: VaultixUser | null;
     isLoaded: boolean;
     isSignedIn: boolean;
+    /** Update the current user's profile fields or password. */
+    update: (params: UpdateUserParams) => Promise<VaultixUser>;
 }
 interface UseOrganizationReturn {
     organization: VaultixOrganization | null;
@@ -102,7 +140,7 @@ interface UseOrganizationReturn {
 declare function useVaultix(): VaultixContextValue;
 /** Returns the current session and its loading state. */
 declare function useSession(): UseSessionReturn;
-/** Returns the current user and their loading state. */
+/** Returns the current user, their loading state, and an update function. */
 declare function useUser(): UseUserReturn;
 /** Returns the active organization for the current session. */
 declare function useOrganization(): UseOrganizationReturn;
@@ -116,7 +154,29 @@ interface UseAuthReturn {
     /** Returns the session JWT for use in API calls via Authorization: Bearer header. */
     getToken: () => Promise<string | null>;
 }
-/** Clerk-compatible auth hook. Returns key auth identifiers and helpers. */
+interface UsePlatformConnectReturn {
+    /** Redirect the user to the provider's OAuth authorization page. */
+    connect: (overrides?: ConnectPlatformOptions) => void;
+    /**
+     * Non-null immediately after the OAuth callback lands on the current page.
+     * The token is parsed from `__vaultix_connect` in the URL and then removed
+     * from the address bar. Null if the user has not connected yet this page load.
+     */
+    connectedAccount: PlatformConnectResult | null;
+}
+/**
+ * Hook for connecting a social/platform account via Vaultix OAuth.
+ *
+ * @example
+ * const { connect, connectedAccount } = usePlatformConnect("google", {
+ *   scopes: ["https://www.googleapis.com/auth/youtube.upload"],
+ * });
+ *
+ * // After connect() → user returns with __vaultix_connect in URL
+ * // connectedAccount.accessToken has the token; URL is cleaned automatically
+ */
+declare function usePlatformConnect(provider: string, defaultOptions?: ConnectPlatformOptions): UsePlatformConnectReturn;
+/** Returns key auth identifiers and helpers. */
 declare function useAuth(): UseAuthReturn;
 
 interface SignInProps {
@@ -128,8 +188,10 @@ interface SignInProps {
     /** API origin — injected by VaultixProvider via DOM attribute, or pass directly. */
     apiOrigin?: string;
     className?: string;
+    /** Override colors and card background. */
+    appearance?: VaultixAppearance;
 }
-declare function SignIn({ redirectUrl, onSuccess, onError, apiOrigin: apiOriginProp, className, }: SignInProps): react_jsx_runtime.JSX.Element;
+declare function SignIn({ redirectUrl, onSuccess, onError, apiOrigin: apiOriginProp, className, appearance, }: SignInProps): react_jsx_runtime.JSX.Element;
 
 interface SignUpProps {
     redirectUrl?: string;
@@ -137,8 +199,10 @@ interface SignUpProps {
     onError?: (message: string) => void;
     apiOrigin?: string;
     className?: string;
+    /** Override colors and card background. */
+    appearance?: VaultixAppearance;
 }
-declare function SignUp({ redirectUrl, onSuccess, onError, apiOrigin: apiOriginProp, className, }: SignUpProps): react_jsx_runtime.JSX.Element;
+declare function SignUp({ redirectUrl, onSuccess, onError, apiOrigin: apiOriginProp, className, appearance, }: SignUpProps): react_jsx_runtime.JSX.Element;
 
 /** Renders children only when the user is signed in and auth is loaded. */
 declare function SignedIn({ children }: {
@@ -159,12 +223,11 @@ declare function RedirectToSignIn({ redirectUrl }: RedirectProps): null;
 declare function RedirectToSignUp({ redirectUrl }: RedirectProps): null;
 
 interface UserButtonProps {
-    /** Show the user's name next to the avatar. Default false. */
     showName?: boolean;
     afterSignOutUrl?: string;
     className?: string;
 }
-declare function UserButton({ showName, afterSignOutUrl, className, }: UserButtonProps): react_jsx_runtime.JSX.Element | null;
+declare function UserButton({ showName, afterSignOutUrl, className }: UserButtonProps): react_jsx_runtime.JSX.Element | null;
 
 interface OrganizationSwitcherProps {
     afterSwitchUrl?: string;
@@ -172,9 +235,9 @@ interface OrganizationSwitcherProps {
 }
 declare function OrganizationSwitcher({ afterSwitchUrl, className, }: OrganizationSwitcherProps): react_jsx_runtime.JSX.Element | null;
 
-/** Returns the stored session JWT, or null if not signed in. */
+/** Returns the stored session JWT from the vaultix-token cookie, or null if not signed in. */
 declare function getStoredToken(): string | null;
 /** Clears the stored session JWT. Call on 401 so the user is prompted to sign in again. */
 declare function clearStoredToken(): void;
 
-export { type ChallengeType, type ConnectPlatformOptions, OrganizationSwitcher, RedirectToSignIn, RedirectToSignUp, type RiskLevel, type SessionClaims, SignIn, SignUp, SignedIn, SignedOut, UserButton, type VaultixContextValue, type VaultixOrganization, VaultixProvider, type VaultixProviderProps, type VaultixSession, type VaultixUser, clearStoredToken, getStoredToken, useAuth, useOrganization, useSession, useUser, useVaultix };
+export { type ChallengeType, type ConnectPlatformOptions, OrganizationSwitcher, type PlatformConnectResult, RedirectToSignIn, RedirectToSignUp, type RiskLevel, type SessionClaims, SignIn, SignUp, SignedIn, SignedOut, type UpdateUserParams, UserButton, type VaultixAppearance, type VaultixAppearanceVariables, type VaultixContextValue, type VaultixOrganization, VaultixProvider, type VaultixProviderProps, type VaultixSession, type VaultixUser, clearStoredToken, getStoredToken, useAuth, useOrganization, usePlatformConnect, useSession, useUser, useVaultix };