firebase-admin-edge 1.0.25 → 1.1.1

package/dist/auth/firebase-admin-auth.d.ts

@@ -1,6 +1,28 @@
 import type { ServiceAccount } from './firebase-types.js';
 import { FirebaseEdgeError } from './errors.js';
 import type { CacheConfig } from './cache-types.js';
+import { type DeleteUsersResult, type UserImportResult } from './user-batch.js';
+import { type UserImportRecord, type UserImportOptions } from './user-import.js';
+export type { DeleteUsersResult, UserImportResult, FirebaseArrayIndexError } from './user-batch.js';
+export type { UserImportRecord, UserImportOptions, HashAlgorithmType, UserMetadataRequest, UserProviderRequest } from './user-import.js';
+import { type GetUsersResult, type ListUsersResult } from './user-record.js';
+import type { UserRecord } from './user-record.js';
+import { type UserIdentifier, type CreateRequest, type UpdateRequest } from './user-request.js';
+export type { UserIdentifier, UidIdentifier, EmailIdentifier, PhoneIdentifier, ProviderIdentifier, CreateRequest, UpdateRequest, UserProvider, CreatePhoneMultiFactorInfoRequest, UpdatePhoneMultiFactorInfoRequest } from './user-request.js';
+export type { GetUsersResult, ListUsersResult, UserRecord } from './user-record.js';
+type AdminResult<T> = {
+    data: T;
+    error: null;
+} | {
+    data: null;
+    error: FirebaseEdgeError;
+};
+import { type ActionCodeSettings } from './email-action-request.js';
+export type { ActionCodeSettings } from './email-action-request.js';
+export interface SessionCookieOptions {
+    /** Session lifetime in milliseconds, between five minutes and fourteen days. */
+    expiresIn: number;
+}
 /**
  * Firebase Admin Authentication handler for edge environments.
  * Provides server-side authentication operations using service account credentials.
@@ -29,6 +51,22 @@ export declare class FirebaseAdminAuth {
      * @returns Promise with token data and error
      */
     private getCachedToken;
+    /** Create a user and return the complete user record. */
+    createUser(properties: CreateRequest): Promise<AdminResult<UserRecord>>;
+    /** Update a user; null clears displayName, photoURL, or phoneNumber. */
+    updateUser(uid: string, properties: UpdateRequest): Promise<AdminResult<UserRecord>>;
+    /** Replace stored custom claims; pass null to clear all claims. */
+    setCustomUserClaims(uid: string, claims: object | null): Promise<AdminResult<void>>;
+    /** Delete one user. A successful deletion returns undefined data. */
+    deleteUser(uid: string): Promise<AdminResult<void>>;
+    /** Delete up to 1000 users, reporting failures by original input index. */
+    deleteUsers(uids: string[]): Promise<AdminResult<DeleteUsersResult>>;
+    /** Import up to 1000 users, with local and API failures indexed to the original input. */
+    importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<AdminResult<UserImportResult>>;
+    /** Read back a complete record after a successful create or update. */
+    private getManagedUser;
+    /** Look up at most 100 identifiers, returning users and unmatched identifiers. */
+    getUsers(identifiers: UserIdentifier[]): Promise<AdminResult<GetUsersResult>>;
     /**
      * Retrieves user account information by UID.
      *
@@ -42,6 +80,19 @@ export declare class FirebaseAdminAuth {
         data: import("./firebase-types.js").UserInfo | null | undefined;
         error: null;
     }>;
+    /**
+     * Lists one page of users, using Firebase Admin's page size and token contract.
+     * @param maxResults Page size (1–1000), defaults to 1000.
+     * @param pageToken Token returned by the previous page.
+     * @returns User records and an optional next page token, or a structured error.
+     */
+    listUsers(maxResults?: number, pageToken?: string): Promise<{
+        data: ListUsersResult;
+        error: null;
+    } | {
+        data: null;
+        error: FirebaseEdgeError;
+    }>;
     /**
      * Retrieves user account information by email address.
      *
@@ -55,6 +106,10 @@ export declare class FirebaseAdminAuth {
         data: import("./firebase-types.js").UserInfo | null | undefined;
         error: null;
     }>;
+    /** Look up a linked provider UID, or a primary email/phone identifier. */
+    getUserByProviderUid(providerId: string, uid: string): Promise<AdminResult<UserRecord>>;
+    /** Look up a user by their primary international phone number. */
+    getUserByPhoneNumber(phoneNumber: string): Promise<AdminResult<UserRecord>>;
     /**
      * Verifies a Firebase ID token and returns the decoded payload.
      * Optionally checks if the token has been revoked.
@@ -74,16 +129,19 @@ export declare class FirebaseAdminAuth {
      * Creates a session cookie from a Firebase ID token.
      *
      * @param idToken Firebase ID token to convert to session cookie
-     * @param expiresIn_ms Session cookie expiration time in milliseconds
+     * @param options Session cookie lifetime in milliseconds
      * @returns Promise with object containing session cookie string or null, and error if any
      */
-    createSessionCookie(idToken: string, expiresIn_ms: number): Promise<{
-        data: null;
-        error: FirebaseEdgeError;
-    } | {
-        data: string | null;
-        error: null;
-    }>;
+    createSessionCookie(idToken: string, options: SessionCookieOptions): Promise<AdminResult<string>>;
+    /** Generate a password reset link to send through your own email service. */
+    generatePasswordResetLink(email: string, settings?: ActionCodeSettings): Promise<AdminResult<string>>;
+    /** Generate an email verification link without sending an email. */
+    generateEmailVerificationLink(email: string, settings?: ActionCodeSettings): Promise<AdminResult<string>>;
+    /** Generate a link that verifies a new email before changing the account email. */
+    generateVerifyAndChangeEmailLink(email: string, newEmail: string, settings?: ActionCodeSettings): Promise<AdminResult<string>>;
+    /** Generate an email sign-in link; action code settings are required. */
+    generateSignInWithEmailLink(email: string, settings: ActionCodeSettings): Promise<AdminResult<string>>;
+    private generateActionLink;
     /**
      * Verifies a Firebase session cookie and returns the decoded payload.
      * Optionally checks if the token has been revoked.
@@ -109,7 +167,7 @@ export declare class FirebaseAdminAuth {
         data: null;
         error: FirebaseEdgeError;
     } | {
-        data: import("./firebase-types.js").FirebaseUpdateAccountResponse | null;
+        data: import("./firebase-types.js").FirebaseUpdateAccountResponse;
         error: null;
     }>;
     /**

package/dist/auth/firebase-admin-auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"firebase-admin-auth.d.ts","sourceRoot":"","sources":["../../src/auth/firebase-admin-auth.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAuB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE/E,OAAO,EACH,iBAAiB,EAGpB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;GAGG;AACH,qBAAa,iBAAiB;IAatB,OAAO,CAAC,iBAAiB;IACzB,OAAO,CAAC,QAAQ,CAAC;IACjB,OAAO,CAAC,KAAK,CAAC;IACd,OAAO,CAAC,KAAK,CAAC;IACd,OAAO,CAAC,SAAS,CAAC;IAhBtB,OAAO,CAAC,UAAU,CAAa;IAE/B;;;;;;;;OAQG;gBAES,iBAAiB,EAAE,cAAc,EACjC,QAAQ,CAAC,EAAE,MAAM,YAAA,EACjB,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,YAAA,EAC/B,KAAK,CAAC,EAAE,WAAW,YAAA,EACnB,SAAS,CAAC,EAAE,MAAM,YAAA;IAK9B;;;;;OAKG;YACW,cAAc;IAoC5B;;;;;OAKG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM;;;;;;;IA+BzB;;;;;OAKG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM;;;;;;;IA+BlC;;;;;;;OAOG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,GAAE,OAAe;;;;;;;IAwGlE;;;;;;OAMG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;;;;;;;IAuC/D;;;;;;;OAOG;IACG,mBAAmB,CACrB,aAAa,EAAE,MAAM,EACrB,YAAY,GAAE,OAAe;;;;;;;IAgFjC;;;;;OAKG;IACG,mBAAmB,CAAC,GAAG,EAAE,MAAM;;;;;;;IAwCrC;;;;;;OAMG;IACG,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,GAAE,MAAW;;;;;;;CAmCpE"}
+{"version":3,"file":"firebase-admin-auth.d.ts","sourceRoot":"","sources":["../../src/auth/firebase-admin-auth.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAuB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE/E,OAAO,EACH,iBAAiB,EAGpB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAGH,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACxB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAEH,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACR,iBAAiB,EACjB,gBAAgB,EAChB,uBAAuB,EAC1B,MAAM,iBAAiB,CAAC;AACzB,YAAY,EACR,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAGH,KAAK,cAAc,EACnB,KAAK,eAAe,EACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAIH,KAAK,cAAc,EAEnB,KAAK,aAAa,EAClB,KAAK,aAAa,EACrB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACR,cAAc,EACd,aAAa,EACb,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,YAAY,EACZ,iCAAiC,EACjC,iCAAiC,EACpC,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACR,cAAc,EACd,eAAe,EACf,UAAU,EACb,MAAM,kBAAkB,CAAC;AAE1B,KAAK,WAAW,CAAC,CAAC,IACZ;IAAE,IAAI,EAAE,CAAC,CAAC;IAAC,KAAK,EAAE,IAAI,CAAA;CAAE,GACxB;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAE,CAAC;AAE/C,OAAO,EAEH,KAAK,kBAAkB,EAE1B,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,MAAM,WAAW,oBAAoB;IACjC,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,qBAAa,iBAAiB;IAatB,OAAO,CAAC,iBAAiB;IACzB,OAAO,CAAC,QAAQ,CAAC;IACjB,OAAO,CAAC,KAAK,CAAC;IACd,OAAO,CAAC,KAAK,CAAC;IACd,OAAO,CAAC,SAAS,CAAC;IAhBtB,OAAO,CAAC,UAAU,CAAa;IAE/B;;;;;;;;OAQG;gBAES,iBAAiB,EAAE,cAAc,EACjC,QAAQ,CAAC,EAAE,MAAM,YAAA,EACjB,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,YAAA,EAC/B,KAAK,CAAC,EAAE,WAAW,YAAA,EACnB,SAAS,CAAC,EAAE,MAAM,YAAA;IAK9B;;;;;OAKG;YACW,cAAc;IAoC5B,yDAAyD;IACnD,UAAU,CACZ,UAAU,EAAE,aAAa,GAC1B,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAkDnC,wEAAwE;IAClE,UAAU,CACZ,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,aAAa,GAC1B,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAqDnC,mEAAmE;IAC7D,mBAAmB,CACrB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,GAAG,IAAI,GACtB,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAkD7B,qEAAqE;IAC/D,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAwCzD,2EAA2E;IACrE,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAuD1E,0FAA0F;IACpF,WAAW,CACb,KAAK,EAAE,gBAAgB,EAAE,EACzB,OAAO,CAAC,EAAE,iBAAiB,GAC5B,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IA6DzC,uEAAuE;YACzD,cAAc;IAsB5B,kFAAkF;IAC5E,QAAQ,CACV,WAAW,EAAE,cAAc,EAAE,GAC9B,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAoDvC;;;;;OAKG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM;;;;;;;IA+BzB;;;;;OAKG;IACG,SAAS,CACX,UAAU,SAAO,EACjB,SAAS,CAAC,EAAE,MAAM,GACnB,OAAO,CACJ;QAAE,IAAI,EAAE,eAAe,CAAC;QAAC,KAAK,EAAE,IAAI,CAAA;KAAE,GACtC;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,iBAAiB,CAAA;KAAE,CAC7C;IAuFD;;;;;OAKG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM;;;;;;;IA+BlC,0EAA0E;IACpE,oBAAoB,CACtB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,GACZ,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAoBnC,kEAAkE;IAC5D,oBAAoB,CACtB,WAAW,EAAE,MAAM,GACpB,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAwCnC;;;;;;;OAOG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,GAAE,OAAe;;;;;;;IAwGlE;;;;;;OAMG;IACG,mBAAmB,CACrB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,oBAAoB,GAC9B,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAmF/B,6EAA6E;IACvE,yBAAyB,CAC3B,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,kBAAkB,GAC9B,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAI/B,oEAAoE;IAC9D,6BAA6B,CAC/B,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,kBAAkB,GAC9B,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAI/B,mFAAmF;IAC7E,gCAAgC,CAClC,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,kBAAkB,GAC9B,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAS/B,yEAAyE;IACnE,2BAA2B,CAC7B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,kBAAkB,GAC7B,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAIjB,kBAAkB;IA0DhC;;;;;;;OAOG;IACG,mBAAmB,CACrB,aAAa,EAAE,MAAM,EACrB,YAAY,GAAE,OAAe;;;;;;;IA+FjC;;;;;OAKG;IACG,mBAAmB,CAAC,GAAG,EAAE,MAAM;;;;;;;IAwCrC;;;;;;OAMG;IACG,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,GAAE,MAAW;;;;;;;CAmCpE"}