@vaultix.ai/react 0.3.1 → 0.3.3

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;
 }
@@ -42,13 +43,49 @@ interface VaultixSession {
     expiresAt: number;
     claims: SessionClaims;
 }
+interface ConnectPlatformOptions {
+    /** OAuth scopes to request. Joined by the provider's delimiter (space or comma). */
+    scopes?: string[];
+    /**
+     * Meta-specific: a Login Config ID registered on the Vaultix Meta app.
+     * When provided, takes precedence over `scopes` (Meta's rule).
+     */
+    configId?: string;
+    /**
+     * Extra provider-specific params forwarded to the authorization URL.
+     * e.g. { shop: "mystore.myshopify.com" } for Shopify.
+     */
+    extraParams?: Record<string, string>;
+    /** 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.
+     * On completion, Vaultix redirects back with `__vaultix_connect` + `provider`
+     * query params that your app exchanges via POST /oauth/{provider}/connect-complete.
+     */
+    connectPlatform: (provider: string, options?: ConnectPlatformOptions) => void;
 }
 interface VaultixProviderProps {
     publishableKey: string;
@@ -70,6 +107,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;
@@ -79,7 +118,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;
@@ -93,7 +132,7 @@ 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. */
+/** Returns key auth identifiers and helpers. */
 declare function useAuth(): UseAuthReturn;
 
 interface SignInProps {
@@ -136,12 +175,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;
@@ -149,4 +187,9 @@ interface OrganizationSwitcherProps {
 }
 declare function OrganizationSwitcher({ afterSwitchUrl, className, }: OrganizationSwitcherProps): react_jsx_runtime.JSX.Element | null;
 
-export { type ChallengeType, OrganizationSwitcher, RedirectToSignIn, RedirectToSignUp, type RiskLevel, type SessionClaims, SignIn, SignUp, SignedIn, SignedOut, UserButton, type VaultixContextValue, type VaultixOrganization, VaultixProvider, type VaultixProviderProps, type VaultixSession, type VaultixUser, useAuth, useOrganization, useSession, useUser, useVaultix };
+/** 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, type UpdateUserParams, UserButton, type VaultixContextValue, type VaultixOrganization, VaultixProvider, type VaultixProviderProps, type VaultixSession, type VaultixUser, clearStoredToken, getStoredToken, useAuth, useOrganization, 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;
 }
@@ -42,13 +43,49 @@ interface VaultixSession {
     expiresAt: number;
     claims: SessionClaims;
 }
+interface ConnectPlatformOptions {
+    /** OAuth scopes to request. Joined by the provider's delimiter (space or comma). */
+    scopes?: string[];
+    /**
+     * Meta-specific: a Login Config ID registered on the Vaultix Meta app.
+     * When provided, takes precedence over `scopes` (Meta's rule).
+     */
+    configId?: string;
+    /**
+     * Extra provider-specific params forwarded to the authorization URL.
+     * e.g. { shop: "mystore.myshopify.com" } for Shopify.
+     */
+    extraParams?: Record<string, string>;
+    /** 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.
+     * On completion, Vaultix redirects back with `__vaultix_connect` + `provider`
+     * query params that your app exchanges via POST /oauth/{provider}/connect-complete.
+     */
+    connectPlatform: (provider: string, options?: ConnectPlatformOptions) => void;
 }
 interface VaultixProviderProps {
     publishableKey: string;
@@ -70,6 +107,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;
@@ -79,7 +118,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;
@@ -93,7 +132,7 @@ 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. */
+/** Returns key auth identifiers and helpers. */
 declare function useAuth(): UseAuthReturn;
 
 interface SignInProps {
@@ -136,12 +175,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;
@@ -149,4 +187,9 @@ interface OrganizationSwitcherProps {
 }
 declare function OrganizationSwitcher({ afterSwitchUrl, className, }: OrganizationSwitcherProps): react_jsx_runtime.JSX.Element | null;
 
-export { type ChallengeType, OrganizationSwitcher, RedirectToSignIn, RedirectToSignUp, type RiskLevel, type SessionClaims, SignIn, SignUp, SignedIn, SignedOut, UserButton, type VaultixContextValue, type VaultixOrganization, VaultixProvider, type VaultixProviderProps, type VaultixSession, type VaultixUser, useAuth, useOrganization, useSession, useUser, useVaultix };
+/** 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, type UpdateUserParams, UserButton, type VaultixContextValue, type VaultixOrganization, VaultixProvider, type VaultixProviderProps, type VaultixSession, type VaultixUser, clearStoredToken, getStoredToken, useAuth, useOrganization, useSession, useUser, useVaultix };