dexie-cloud-addon 4.2.4 → 4.3.0

package/dist/modern/authentication/handleOAuthCallback.d.ts

@@ -0,0 +1,57 @@
+/** Parsed OAuth callback parameters */
+export interface OAuthCallbackParams {
+    /** The Dexie Cloud authorization code */
+    code: string;
+    /** The OAuth provider that was used */
+    provider: string;
+    /** The state parameter for CSRF validation */
+    state: string;
+}
+/**
+ * Parses OAuth callback parameters from the current URL.
+ *
+ * Use this on your OAuth callback page (for redirect/deep link flows)
+ * to extract the authorization code and complete the login.
+ *
+ * @param url - The URL to parse (defaults to window.location.href)
+ * @returns OAuthCallbackParams if valid callback, null otherwise
+ * @throws OAuthError if there's an error in the callback
+ */
+export declare function parseOAuthCallback(url?: string): OAuthCallbackParams | null;
+/**
+ * Validates the OAuth state parameter against the stored state.
+ *
+ * @param receivedState - The state from the callback URL
+ * @returns true if valid, false otherwise
+ */
+export declare function validateOAuthState(receivedState: string): boolean;
+/**
+ * Gets the OAuth provider from sessionStorage (for redirect flows).
+ */
+export declare function getStoredOAuthProvider(): string | null;
+/**
+ * Cleans up OAuth-related query parameters from the URL.
+ * Call this after successfully handling the callback to clean up the browser URL.
+ */
+export declare function cleanupOAuthUrl(): void;
+/**
+ * Complete handler for OAuth callback pages.
+ *
+ * Parses the callback URL, validates state, and returns the parameters
+ * needed to complete the login flow.
+ *
+ * @param url - The callback URL (defaults to window.location.href)
+ * @returns OAuthCallbackParams if valid callback, null otherwise
+ * @throws OAuthError on validation failure or if callback contains an error
+ *
+ * @example
+ * ```typescript
+ * // On your OAuth callback page:
+ * const callback = handleOAuthCallback();
+ * if (callback) {
+ *   await db.cloud.login({ oauthCode: callback.code, provider: callback.provider });
+ *   cleanupOAuthUrl();
+ * }
+ * ```
+ */
+export declare function handleOAuthCallback(url?: string): OAuthCallbackParams | null;

package/dist/modern/authentication/interactWithUser.d.ts

@@ -1,3 +1,4 @@
+import type { OAuthProviderInfo } from 'dexie-cloud-common';
 import { BehaviorSubject } from 'rxjs';
 import { DXCAlert } from '../types/DXCAlert';
 import { DXCInputField } from '../types/DXCInputField';
@@ -19,3 +20,21 @@ export declare function alertUser(userInteraction: BehaviorSubject<DXCUserIntera
 export declare function promptForEmail(userInteraction: BehaviorSubject<DXCUserInteraction | undefined>, title: string, emailHint?: string): Promise<string>;
 export declare function promptForOTP(userInteraction: BehaviorSubject<DXCUserInteraction | undefined>, email: string, alert?: DXCAlert): Promise<string>;
 export declare function confirmLogout(userInteraction: BehaviorSubject<DXCUserInteraction | undefined>, currentUserId: string, numUnsyncedChanges: number): Promise<boolean>;
+/** Result from provider selection prompt */
+export type ProviderSelectionResult = {
+    type: 'provider';
+    provider: string;
+} | {
+    type: 'otp';
+};
+/**
+ * Prompts the user to select an authentication method (OAuth provider or OTP).
+ *
+ * @param userInteraction - The user interaction BehaviorSubject
+ * @param providers - Available OAuth providers
+ * @param otpEnabled - Whether OTP is available
+ * @param title - Dialog title
+ * @param alerts - Optional alerts to display
+ * @returns Promise resolving to the user's selection
+ */
+export declare function promptForProvider(userInteraction: BehaviorSubject<DXCUserInteraction | undefined>, providers: OAuthProviderInfo[], otpEnabled: boolean, title?: string, alerts?: DXCAlert[]): Promise<ProviderSelectionResult>;

package/dist/modern/authentication/oauthLogin.d.ts

@@ -0,0 +1,37 @@
+/** Options for OAuth login */
+export interface OAuthLoginOptions {
+    /** The Dexie Cloud database URL */
+    databaseUrl: string;
+    /** The OAuth provider name */
+    provider: string;
+    /** Optional redirect URI for non-popup flows */
+    redirectUri?: string;
+    /** Whether to use popup (default: true) */
+    usePopup?: boolean;
+}
+/** Result from OAuth login */
+export interface OAuthLoginResult {
+    /** The Dexie Cloud authorization code */
+    code: string;
+    /** The provider that was used */
+    provider: string;
+    /** The state parameter */
+    state: string;
+}
+/**
+ * Initiates OAuth login flow using a popup window.
+ *
+ * Opens a popup to the OAuth provider, listens for postMessage with the result,
+ * and returns the Dexie Cloud authorization code.
+ *
+ * @param options - OAuth login options
+ * @returns Promise resolving to OAuthLoginResult
+ * @throws OAuthError on failure
+ */
+export declare function oauthLogin(options: OAuthLoginOptions): Promise<OAuthLoginResult>;
+/**
+ * Initiates OAuth login via redirect (non-popup flow).
+ * The page will navigate to the OAuth provider and redirect back to the app.
+ * Use handleOAuthCallback on the callback page to complete the flow.
+ */
+export declare function startOAuthRedirect(options: OAuthLoginOptions): void;

package/dist/modern/default-ui/AuthProviderButton.d.ts

@@ -0,0 +1,21 @@
+import { h } from 'preact';
+import type { OAuthProviderInfo } from 'dexie-cloud-common';
+export interface AuthProviderButtonProps {
+    provider: OAuthProviderInfo;
+    onClick: () => void;
+}
+/**
+ * Button component for OAuth provider login.
+ * Displays the provider's icon and name following provider branding guidelines.
+ */
+export declare function AuthProviderButton({ provider, onClick }: AuthProviderButtonProps): h.JSX.Element;
+/**
+ * Button for email/OTP authentication option.
+ */
+export declare function OtpButton({ onClick }: {
+    onClick: () => void;
+}): h.JSX.Element;
+/**
+ * Visual divider with "or" text.
+ */
+export declare function Divider(): h.JSX.Element;

package/dist/modern/default-ui/LoginDialog.d.ts

@@ -1,3 +1,6 @@
 import { h } from 'preact';
-import { DXCUserInteraction } from '../types/DXCUserInteraction';
-export declare function LoginDialog({ title, type, alerts, fields, submitLabel, cancelLabel, onCancel, onSubmit, }: DXCUserInteraction): h.JSX.Element;
+import { DXCUserInteraction, DXCProviderSelection } from '../types/DXCUserInteraction';
+/** User interactions that have the standard form-based structure */
+type FormBasedInteraction = Exclude<DXCUserInteraction, DXCProviderSelection>;
+export declare function LoginDialog({ title, type, alerts, fields, submitLabel, cancelLabel, onCancel, onSubmit, }: FormBasedInteraction): h.JSX.Element;
+export {};

package/dist/modern/default-ui/ProviderSelectionDialog.d.ts

@@ -0,0 +1,7 @@
+import { h } from 'preact';
+import { DXCProviderSelection } from '../types/DXCUserInteraction';
+/**
+ * Dialog component for OAuth provider selection.
+ * Displays available OAuth providers as buttons and optionally an email/OTP option.
+ */
+export declare function ProviderSelectionDialog({ title, alerts, providers, otpEnabled, cancelLabel, onSelectProvider, onSelectOtp, onCancel, }: DXCProviderSelection): h.JSX.Element;