firebase-admin-edge 1.1.1 → 2.0.0

package/dist/firebase-edge-server.d.ts

@@ -1,25 +1,38 @@
+import { FIREBASE_PROVIDER_IDS, type ProviderCredential, type ProviderAuthorizationOptions } from './auth/provider-credential.js';
 import type { CookieConfig, CookieOptions } from './auth/cookie-types.js';
 import { FirebaseAdminAuth } from './auth/firebase-admin-auth.js';
+import { Firestore } from './db/firestore.js';
+import { AppCheck } from './app-check/app-check.js';
+import { Storage } from './storage/storage.js';
 import { FirebaseAuth } from './auth/firebase-auth.js';
-import type { FirebaseConfig, ServiceAccount } from './auth/firebase-types.js';
+import type { FirebaseConfig, ServiceAccount, FirebaseIdpSignInResponse } from './auth/firebase-types.js';
 import { FirebaseEdgeError } from './auth/errors.js';
 import type { CacheConfig } from './auth/cache-types.js';
+export type EmailLinkOptions = {
+    includeEmailInLink?: boolean;
+    callbackUrl?: string;
+    locale?: string;
+};
+export type SignInCallbackOptions = {
+    email?: string;
+    expiresInMs?: number;
+    postBody?: string;
+};
+export type CallbackOptions = SignInCallbackOptions & {
+    newPassword?: string;
+    confirmPassword?: string;
+};
 /**
  * Official Firebase OAuth providers
  */
-export declare const OFFICIAL_FIREBASE_OAUTH_PROVIDERS: readonly ["google", "facebook", "apple", "twitter", "github", "microsoft", "yahoo", "playgames"];
-type ProviderList = (typeof OFFICIAL_FIREBASE_OAUTH_PROVIDERS)[number];
-type ProviderConfig = Partial<Record<ProviderList, {
-    client_id: string;
-    client_secret: string;
-}>>;
+type ProviderList = keyof typeof FIREBASE_PROVIDER_IDS;
+export declare const OFFICIAL_FIREBASE_OAUTH_PROVIDERS: readonly ProviderList[];
 /**
  * Creates a Firebase Edge Server for authentication and session management in edge environments.
  *
  * @param config Configuration object
  * @param config.serviceAccount Firebase service account for admin operations
  * @param config.firebaseConfig Firebase client configuration
- * @param config.providers OAuth provider configurations (Google, GitHub, etc.)
  * @param config.cookies Cookie management functions (getSession, saveSession)
  * @param config.redirectUri OAuth callback redirect URI
  * @param config.cache Optional cache implementation for token caching
@@ -29,12 +42,12 @@ type ProviderConfig = Partial<Record<ProviderList, {
  * @param config.tenantId Optional Firebase Auth tenant ID for multi-tenancy
  * @param config.autoLinkProviders Optional flag to automatically link accounts with same email
  * @param config.fetch Optional custom fetch implementation
- * @returns Object with authentication methods (auth, adminAuth, signOut, getUser, getGoogleLoginURL, getGitHubLoginURL, signInWithCallback, getToken)
+ * @param config.authEmulatorHost Auth emulator host:port; null forces production, undefined reads the environment.
+ * @returns Object with auth, adminAuth, firestore, and session management methods
  */
-export declare function createFirebaseEdgeServer({ serviceAccount, firebaseConfig, providers, cookies, cookieName, cookieOptions, cache, cacheName, tenantId, redirectUri, autoLinkProviders, fetch }: {
+export declare function createFirebaseEdgeServer({ serviceAccount, firebaseConfig, cookies, cookieName, cookieOptions, cache, cacheName, tenantId, redirectUri, autoLinkProviders, fetch, authEmulatorHost }: {
     serviceAccount: ServiceAccount;
     firebaseConfig: FirebaseConfig;
-    providers: ProviderConfig;
     cookies: CookieConfig;
     cache?: CacheConfig;
     cacheName?: string;
@@ -44,9 +57,95 @@ export declare function createFirebaseEdgeServer({ serviceAccount, firebaseConfi
     tenantId?: string;
     autoLinkProviders?: boolean;
     fetch?: typeof globalThis.fetch;
+    authEmulatorHost?: string | null;
 }): {
     auth: FirebaseAuth;
     adminAuth: FirebaseAdminAuth;
+    firestore: Firestore;
+    appCheck: AppCheck;
+    storage: Storage;
+    sendSignInLinkToEmail: (email: string, next?: string, options?: EmailLinkOptions) => Promise<{
+        error: Error | FirebaseEdgeError;
+        data?: undefined;
+    } | {
+        data: {
+            sent: true;
+        };
+        error: null;
+    }>;
+    getCallbackAction: (url: URL) => {
+        data: null;
+        error: null;
+    } | {
+        data: {
+            hasLink: boolean;
+            actionMode: import("./auth/email-link.js").EmailActionMode;
+        };
+        error: null;
+    } | {
+        data: null;
+        error: Error;
+    };
+    handleCallback: (url: URL, options?: CallbackOptions) => Promise<{
+        data: null;
+        error: Error;
+    } | {
+        data: {
+            type: "redirect";
+            url: string;
+            message?: undefined;
+        };
+        error: null;
+    } | {
+        data: {
+            type: "complete";
+            message: string;
+            url?: undefined;
+        };
+        error: null;
+    }>;
+    sendPasswordResetEmail: (email: string, locale?: string) => Promise<{
+        data: {
+            email: string;
+        } | null;
+        error: FirebaseEdgeError | null;
+    } | {
+        data: null;
+        error: Error;
+    }>;
+    confirmPasswordReset: (oobCode: string, newPassword: string) => Promise<{
+        error: Error | FirebaseEdgeError;
+        data: {
+            email: string;
+        } | null;
+    } | {
+        error: null;
+        data: {
+            email: string;
+        } | null;
+    }>;
+    verifyBeforeUpdateEmail: (newEmail: string, locale?: string) => Promise<{
+        data: {
+            email: string;
+        } | null;
+        error: FirebaseEdgeError | null;
+    } | {
+        data: null;
+        error: Error;
+    }>;
+    applyActionCode: (oobCode: string) => Promise<{
+        error: Error | FirebaseEdgeError;
+        data: {
+            email?: string;
+            localId?: string;
+        } | null;
+    } | {
+        error: null;
+        data: {
+            email?: string;
+            localId?: string;
+        } | null;
+    }>;
     signOut: () => void;
     getUser: (checkRevoked?: boolean) => Promise<{
         data: null;
@@ -58,30 +157,38 @@ export declare function createFirebaseEdgeServer({ serviceAccount, firebaseConfi
         data: import("./auth/firebase-types.js").FirebaseIdTokenPayload;
         error: null;
     }>;
-    getGoogleLoginURL: (next: string, options?: {
-        languageCode?: string;
-        customParameters?: Record<string, string>;
-        addScopes?: string[];
-    }) => Promise<string>;
-    getGitHubLoginURL: (next: string, options?: {
-        customParameters?: Record<string, string>;
-        addScopes?: string[];
-    }) => Promise<string>;
-    getGoogleLinkURL: (next: string, options?: {
-        languageCode?: string;
-        customParameters?: Record<string, string>;
-        addScopes?: string[];
-    }) => Promise<string>;
-    getGitHubLinkURL: (next: string, options?: {
-        customParameters?: Record<string, string>;
-        addScopes?: string[];
-    }) => Promise<string>;
-    signInWithCallback: (url: URL, expiresIn_ms?: number) => Promise<{
-        error: FirebaseEdgeError;
-        data?: undefined;
-    } | {
+    getProviderLoginURL: (provider: string, next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getProviderLinkURL: (provider: string, next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    signInWithProviderCallback: (url: URL, postBody?: string, expiresIn_ms?: number) => Promise<{
         data: string;
         error: null;
+    } | {
+        error: Error | FirebaseEdgeError;
+    }>;
+    signInWithProviderToken: (provider: string, oauthToken: string | ProviderCredential) => Promise<{
+        data?: FirebaseIdpSignInResponse | null;
+        error?: Error | null;
+    }>;
+    getFacebookLoginURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getFacebookLinkURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getAppleLoginURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getAppleLinkURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getTwitterLoginURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getTwitterLinkURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getMicrosoftLoginURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getMicrosoftLinkURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getYahooLoginURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getYahooLinkURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getGoogleLoginURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getGitHubLoginURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getGoogleLinkURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    getGitHubLinkURL: (next: string, options?: ProviderAuthorizationOptions) => Promise<string>;
+    signInWithCallback: (url: URL, options?: number | SignInCallbackOptions) => Promise<{
+        error: null;
+        data: string;
+    } | {
+        error: Error;
+        data?: never;
     }>;
     getToken: () => Promise<{
         data: null;
@@ -90,17 +197,17 @@ export declare function createFirebaseEdgeServer({ serviceAccount, firebaseConfi
         data: null;
         error: null;
     } | {
-        data: import("./auth/firebase-types.js").FirebaseIdpSignInResponse;
+        data: FirebaseIdpSignInResponse;
         error: null;
     }>;
-    linkProvider: (providerToken: string, providerId: string) => Promise<{
+    linkProvider: (providerToken: string | ProviderCredential, providerId: string) => Promise<{
         data: null;
         error: FirebaseEdgeError;
     } | {
         data: null;
         error: null;
     } | {
-        data: import("./auth/firebase-types.js").FirebaseIdpSignInResponse;
+        data: FirebaseIdpSignInResponse;
         error: null;
     }>;
     unlinkProvider: (provider: string, expiresIn_ms?: number) => Promise<{

package/dist/firebase-edge-server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"firebase-edge-server.d.ts","sourceRoot":"","sources":["../src/firebase-edge-server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAO/E,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAYzD;;GAEG;AACH,eAAO,MAAM,iCAAiC,kGASpC,CAAC;AAEX,KAAK,YAAY,GAAG,CAAC,OAAO,iCAAiC,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvE,KAAK,cAAc,GAAG,OAAO,CACzB,MAAM,CACF,YAAY,EACZ;IACI,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACzB,CACJ,CACJ,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,wBAAwB,CAAC,EACrC,cAAc,EACd,cAAc,EACd,SAAS,EACT,OAAO,EACP,UAAU,EACV,aAAa,EACb,KAAK,EACL,SAAS,EACT,QAAQ,EACR,WAAW,EACX,iBAAiB,EACjB,KAAK,EACR,EAAE;IACC,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,EAAE,cAAc,CAAC;IAC1B,OAAO,EAAE,YAAY,CAAC;IACtB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CACnC;;;;6BAuDwC,OAAO;;;;;;;;;;8BAiDlC,MAAM,YACF;QACN,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC1C,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB;8BAmCK,MAAM,YACF;QACN,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC1C,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB;6BA8fK,MAAM,YACF;QACN,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC1C,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB;6BAgCK,MAAM,YACF;QACN,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC1C,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB;8BAhZI,GAAG,iBACM,MAAM;;;;;;;;;;;;;;;;;kCA0amB,MAAM,cAAc,MAAM;;;;;;;;;;+BA1JvD,MAAM,iBACF,MAAM;;;;;;;;;;;;;EA4M3B"}
+{"version":3,"file":"firebase-edge-server.d.ts","sourceRoot":"","sources":["../src/firebase-edge-server.ts"],"names":[],"mappings":"AAIA,OAAO,EAGH,qBAAqB,EACrB,KAAK,kBAAkB,EACvB,KAAK,4BAA4B,EACpC,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,KAAK,EACR,cAAc,EACd,cAAc,EACd,yBAAyB,EAC5B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAe,MAAM,kBAAkB,CAAC;AAElE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AASzD,MAAM,MAAM,gBAAgB,GAAG;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAYF;;GAEG;AACH,KAAK,YAAY,GAAG,MAAM,OAAO,qBAAqB,CAAC;AACvD,eAAO,MAAM,iCAAiC,EAAE,SAAS,YAAY,EACb,CAAC;AAEzD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,wBAAwB,CAAC,EACrC,cAAc,EACd,cAAc,EACd,OAAO,EACP,UAAU,EACV,aAAa,EACb,KAAK,EACL,SAAS,EACT,QAAQ,EACR,WAAW,EACX,iBAAiB,EACjB,KAAK,EACL,gBAAgB,EACnB,EAAE;IACC,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,OAAO,EAAE,YAAY,CAAC;IACtB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;;;;;;mCAoPc,MAAM,2BAEJ,gBAAgB;;;;;;;;;6BA/LG,GAAG;;;;;;;;;;;;;0BAqBA,GAAG,YAAW,eAAe;;;;;;;;;;;;;;;;;;oCA2DnB,MAAM,WAAW,MAAM;;;;;;;;;oCAKvB,MAAM,eAAe,MAAM;;;;;;;;;;;wCAWvB,MAAM,WAAW,MAAM;;;;;;;;;+BAyChC,MAAM;;;;;;;;;;;;;;6BA8YT,OAAO;;;;;;;;;;oCAzM9B,MAAM,QACV,MAAM,YACF,4BAA4B;mCAM5B,MAAM,QACV,MAAM,YACF,4BAA4B;sCAOjC,GAAG,aACG,MAAM;;;;;;wCAoPP,MAAM,cACJ,MAAM,GAAG,kBAAkB;eAmC5B,yBAAyB,GAAG,IAAI;gBAC/B,KAAK,GAAG,IAAI;;gCAlMlB,MAAM,YACF,4BAA4B;+BAMhC,MAAM,YACF,4BAA4B;6BAMhC,MAAM,YACF,4BAA4B;4BAMhC,MAAM,YACF,4BAA4B;+BAMhC,MAAM,YACF,4BAA4B;8BAMhC,MAAM,YACF,4BAA4B;iCAMhC,MAAM,YACF,4BAA4B;gCAMhC,MAAM,YACF,4BAA4B;6BAMhC,MAAM,YACF,4BAA4B;4BAMhC,MAAM,YACF,4BAA4B;8BAuEhC,MAAM,YACF,4BAA4B;8BAOhC,MAAM,YACF,4BAA4B;6BAkThC,MAAM,YACF,4BAA4B;6BAOhC,MAAM,YACF,4BAA4B;8BApLjC,GAAG,YACC,MAAM,GAAG,qBAAqB,KACxC,OAAO,CAAC;QAAE,KAAK,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,IAAI,CAAC,EAAE,KAAK,CAAA;KAAE,CAAC;;;;;;;;;;;kCA8LvD,MAAM,GAAG,kBAAkB,cAC9B,MAAM;;;;;;;;;;+BAlGR,MAAM,iBACF,MAAM;;;;;;;;;;;;;EA6K3B"}