@xbg.solutions/bpsk-utils-firebase-auth 1.2.3

package/lib/services/auth/email-link.d.ts

@@ -0,0 +1,99 @@
+/**
+ * src/lib/services/auth/email-link.ts
+ * Email Link Authentication service
+ *
+ * Provides functionality for Firebase Email Link authentication:
+ * - Sending authentication links
+ * - Verifying links
+ * - Managing email persistence
+ * - Error handling specific to email link flow
+ */
+import { AppError } from '@xbg.solutions/bpsk-core';
+import type { EmailLinkOptions, EmailLinkVerifyOptions, AuthResult } from '@xbg.solutions/bpsk-core';
+/**
+ * Sends an email authentication link
+ *
+ * @param options Email link configuration options
+ * @returns Promise resolving to success status
+ */
+export declare function checkUserExistsAndCreate(email: string): Promise<boolean>;
+export declare function sendEmailLink(options: EmailLinkOptions): Promise<AuthResult>;
+/**
+ * Verifies an email authentication link and signs in the user
+ *
+ * @param options Email link verification options
+ * @returns Promise resolving to authentication result
+ */
+export declare function verifyEmailLink(options?: EmailLinkVerifyOptions): Promise<AuthResult>;
+/**
+ * Safely sends an email authentication link with error handling
+ */
+export declare const safeSendEmailLink: (options: EmailLinkOptions) => Promise<{
+    success: boolean;
+    data?: AuthResult | undefined;
+    error?: AppError;
+}>;
+/**
+ * Safely verifies an email authentication link with error handling
+ */
+export declare const safeVerifyEmailLink: (options?: EmailLinkVerifyOptions | undefined) => Promise<{
+    success: boolean;
+    data?: AuthResult | undefined;
+    error?: AppError;
+}>;
+/**
+ * Checks if the current URL is an email sign-in link
+ *
+ * @returns Promise resolving to whether the URL is an email sign-in link
+ */
+export declare function isEmailSignInLink(): Promise<boolean>;
+/**
+ * Synchronous version that can be used in places where async isn't supported
+ * This uses the current auth instance if available, otherwise returns false
+ */
+export declare function isEmailSignInLinkSync(): boolean;
+/**
+ * Gets the stored email for sign-in
+ *
+ * @returns The stored email or null if not found
+ */
+export declare function getStoredEmail(): string | null;
+/**
+ * Stores an email for sign-in
+ *
+ * IMPORTANT: We use localStorage WITHOUT encryption to ensure cross-tab compatibility.
+ * This is a necessary security trade-off for email link authentication which requires
+ * the email to be available in any tab where the user opens the verification link.
+ *
+ * @param email Email to store
+ * @returns Whether storage was successful
+ */
+export declare function storeEmail(email: string): boolean;
+/**
+ * Clears the stored email for sign-in
+ *
+ * @returns Whether removal was successful
+ */
+export declare function clearStoredEmail(): boolean;
+declare const _default: {
+    sendEmailLink: typeof sendEmailLink;
+    verifyEmailLink: typeof verifyEmailLink;
+    safeSendEmailLink: (options: EmailLinkOptions) => Promise<{
+        success: boolean;
+        data?: AuthResult | undefined;
+        error?: AppError;
+    }>;
+    safeVerifyEmailLink: (options?: EmailLinkVerifyOptions | undefined) => Promise<{
+        success: boolean;
+        data?: AuthResult | undefined;
+        error?: AppError;
+    }>;
+    isEmailSignInLink: typeof isEmailSignInLink;
+    isEmailSignInLinkSync: typeof isEmailSignInLinkSync;
+    getStoredEmail: typeof getStoredEmail;
+    storeEmail: typeof storeEmail;
+    clearStoredEmail: typeof clearStoredEmail;
+    checkUserExistsAndCreate: typeof checkUserExistsAndCreate;
+};
+export default _default;
+//# sourceMappingURL=email-link.d.ts.map

package/lib/services/auth/email-link.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-link.d.ts","sourceRoot":"","sources":["../../../src/services/auth/email-link.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAYH,OAAO,EAAE,QAAQ,EAAkD,MAAM,0BAA0B,CAAC;AAGpG,OAAO,KAAK,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAgFrG;;;;;GAKG;AAEH,wBAAsB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAI9E;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,CAgFlF;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,UAAU,CAAC,CA4Q/F;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;EAAmC,CAAC;AAElE;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;EAAqC,CAAC;AAEtE;;;;GAIG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC,CAmB1D;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,OAAO,CAqB/C;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,MAAM,GAAG,IAAI,CAqH9C;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAkEjD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CA6E1C;;;;;;;;;;;;;;;;;;;;;AAED,wBAWE"}