firebase-admin-edge 2.0.0 → 3.0.1

package/dist/auth/identity-filter.js

@@ -0,0 +1,129 @@
+import { FirebaseEdgeError } from './errors.js';
+import { buildUsersLookupRequest } from './user-request.js';
+/** Validate direct query construction as well as fluent queries before I/O. @internal */
+export function validateIdentityQueryOptions(options) {
+    if (!options ||
+        typeof options !== 'object' ||
+        Array.isArray(options) ||
+        Object.keys(options).some((key) => ![
+            'filter',
+            'identifiers',
+            'orderBy',
+            'offset',
+            'limit'
+        ].includes(key))) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: 'Unsupported identity query options.'
+        });
+    }
+    const { filter, orderBy, offset, limit } = options;
+    if (filter !== undefined) {
+        if (!filter ||
+            typeof filter !== 'object' ||
+            Array.isArray(filter) ||
+            Object.keys(filter).some((key) => !['field', 'operator', 'value'].includes(key)) ||
+            (filter.operator !== undefined &&
+                filter.operator !== '==' &&
+                filter.operator !== 'in') ||
+            (filter.field === 'provider' && filter.operator !== 'in')) {
+            throw new FirebaseEdgeError({
+                code: 'auth/invalid-argument',
+                message: 'Specify one supported identity filter.'
+            });
+        }
+        identityLookupIdentifiers(filter.field, filter.operator === 'in' ? filter.value : [filter.value]);
+    }
+    if (options.identifiers !== undefined) {
+        identityOrIdentifiers(options.identifiers);
+        if (filter !== undefined) {
+            throw new FirebaseEdgeError({
+                code: 'auth/invalid-argument',
+                message: 'OR lookups cannot be combined with another filter.'
+            });
+        }
+    }
+    if (orderBy !== undefined &&
+        (!orderBy ||
+            typeof orderBy !== 'object' ||
+            Array.isArray(orderBy) ||
+            Object.keys(orderBy).some((key) => !['field', 'direction'].includes(key)) ||
+            ![
+                'uid',
+                'email',
+                'displayName',
+                'createdAt',
+                'lastLoginAt'
+            ].includes(orderBy.field) ||
+            !['asc', 'desc'].includes(orderBy.direction))) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: 'Specify one supported sort field and direction.'
+        });
+    }
+    if (offset !== undefined && (!Number.isSafeInteger(offset) || offset < 0)) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: 'offset must be a nonnegative safe integer.'
+        });
+    }
+    if (limit !== undefined &&
+        (!Number.isInteger(limit) || limit < 1 || limit > 1000)) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: 'limit must be an integer from 1 through 1000.'
+        });
+    }
+}
+/** Validate and snapshot an OR of exact identifiers. @internal */
+export function identityOrIdentifiers(identifiers) {
+    if (!Array.isArray(identifiers) || identifiers.length === 0) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: 'OR requires 1 through 100 exact identifiers.'
+        });
+    }
+    for (const identifier of identifiers) {
+        const keys = Object.keys(identifier ?? {});
+        const provider = keys.includes('providerId') && keys.includes('providerUid');
+        if (keys.length !== (provider ? 2 : 1)) {
+            throw new FirebaseEdgeError({
+                code: 'auth/invalid-argument',
+                message: 'Each OR branch must contain one identifier or one provider ID/UID pair; AND conditions are unsupported.'
+            });
+        }
+    }
+    const { error } = buildUsersLookupRequest([...identifiers]);
+    if (error) {
+        throw error;
+    }
+    return identifiers.map((identifier) => ({ ...identifier }));
+}
+/** Validate one lookup batch without splitting it into multiple requests. @internal */
+export function identityLookupIdentifiers(field, values) {
+    if (!['uid', 'email', 'phoneNumber', 'initialEmail', 'provider'].includes(field) ||
+        !Array.isArray(values) ||
+        values.length === 0 ||
+        values.length > 100) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: 'Lookup filters require a supported field and 1 through 100 identifiers.'
+        });
+    }
+    const identifiers = Array.from(values, (value) => {
+        if (field === 'provider') {
+            const pair = value;
+            return {
+                providerId: pair?.providerId,
+                providerUid: pair?.providerUid
+            };
+        }
+        return { [field]: value };
+    });
+    const { error } = buildUsersLookupRequest(identifiers);
+    if (error) {
+        throw error;
+    }
+    return identifiers;
+}
+//# sourceMappingURL=identity-filter.js.map

package/dist/auth/identity-filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity-filter.js","sourceRoot":"","sources":["../../src/auth/identity-filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAKhD,OAAO,EACH,uBAAuB,EAG1B,MAAM,mBAAmB,CAAC;AAE3B,yFAAyF;AACzF,MAAM,UAAU,4BAA4B,CACxC,OAA6B;IAE7B,IACI,CAAC,OAAO;QACR,OAAO,OAAO,KAAK,QAAQ;QAC3B,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CACrB,CAAC,GAAG,EAAE,EAAE,CACJ,CAAC;YACG,QAAQ;YACR,aAAa;YACb,SAAS;YACT,QAAQ;YACR,OAAO;SACV,CAAC,QAAQ,CAAC,GAAG,CAAC,CACtB,EACH,CAAC;QACC,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,qCAAqC;SACjD,CAAC,CAAC;IACP,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACnD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,IACI,CAAC,MAAM;YACP,OAAO,MAAM,KAAK,QAAQ;YAC1B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YACrB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CACpB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CACzD;YACD,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS;gBAC1B,MAAM,CAAC,QAAQ,KAAK,IAAI;gBACxB,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC;YAC7B,CAAC,MAAM,CAAC,KAAK,KAAK,UAAU,IAAI,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC,EAC3D,CAAC;YACC,MAAM,IAAI,iBAAiB,CAAC;gBACxB,IAAI,EAAE,uBAAuB;gBAC7B,OAAO,EAAE,wCAAwC;aACpD,CAAC,CAAC;QACP,CAAC;QACD,yBAAyB,CACrB,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAC3D,CAAC;IACN,CAAC;IACD,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACpC,qBAAqB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC3C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,iBAAiB,CAAC;gBACxB,IAAI,EAAE,uBAAuB;gBAC7B,OAAO,EAAE,oDAAoD;aAChE,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IACD,IACI,OAAO,KAAK,SAAS;QACrB,CAAC,CAAC,OAAO;YACL,OAAO,OAAO,KAAK,QAAQ;YAC3B,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CACrB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CACjD;YACD,CAAC;gBACG,KAAK;gBACL,OAAO;gBACP,aAAa;gBACb,WAAW;gBACX,aAAa;aAChB,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;YACzB,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EACnD,CAAC;QACC,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,iDAAiD;SAC7D,CAAC,CAAC;IACP,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QACxE,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,4CAA4C;SACxD,CAAC,CAAC;IACP,CAAC;IACD,IACI,KAAK,KAAK,SAAS;QACnB,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,EACzD,CAAC;QACC,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,+CAA+C;SAC3D,CAAC,CAAC;IACP,CAAC;AACL,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,qBAAqB,CACjC,WAAsC;IAEtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,8CAA8C;SAC1D,CAAC,CAAC;IACP,CAAC;IACD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;QAC3C,MAAM,QAAQ,GACV,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,iBAAiB,CAAC;gBACxB,IAAI,EAAE,uBAAuB;gBAC7B,OAAO,EACH,yGAAyG;aAChH,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,GAAG,uBAAuB,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAC5D,IAAI,KAAK,EAAE,CAAC;QACR,MAAM,KAAK,CAAC;IAChB,CAAC;IACD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;AAChE,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,yBAAyB,CACrC,KAA0B,EAC1B,MAAgD;IAEhD,IACI,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC,QAAQ,CACjE,KAAK,CACR;QACD,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACtB,MAAM,CAAC,MAAM,KAAK,CAAC;QACnB,MAAM,CAAC,MAAM,GAAG,GAAG,EACrB,CAAC;QACC,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EACH,yEAAyE;SAChF,CAAC,CAAC;IACP,CAAC;IACD,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;QAC7C,IAAI,KAAK,KAAK,UAAU,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,KAAkC,CAAC;YAChD,OAAO;gBACH,UAAU,EAAE,IAAI,EAAE,UAAU;gBAC5B,WAAW,EAAE,IAAI,EAAE,WAAW;aACX,CAAC;QAC5B,CAAC;QACD,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAoB,CAAC;IAChD,CAAC,CAAC,CAAC;IACH,MAAM,EAAE,KAAK,EAAE,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;IACvD,IAAI,KAAK,EAAE,CAAC;QACR,MAAM,KAAK,CAAC;IAChB,CAAC;IACD,OAAO,WAAW,CAAC;AACvB,CAAC"}

package/dist/auth/identity-query.d.ts

@@ -0,0 +1,11 @@
+import type { FirebaseAdminAuth } from './firebase-admin-auth.js';
+import type { IdentityQueryOptions, IdentityQueryResult } from './identity-types.js';
+/** Execute one backend request, never follow a token or scan for more matches. @internal */
+export declare function executeIdentityQuery(auth: FirebaseAdminAuth, options: IdentityQueryOptions, last?: boolean, pageToken?: string): Promise<{
+    data: IdentityQueryResult;
+    error: null;
+} | {
+    data: null;
+    error: Error;
+}>;
+//# sourceMappingURL=identity-query.d.ts.map

package/dist/auth/identity-query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity-query.d.ts","sourceRoot":"","sources":["../../src/auth/identity-query.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,KAAK,EACR,oBAAoB,EACpB,mBAAmB,EACtB,MAAM,qBAAqB,CAAC;AAE7B,4FAA4F;AAC5F,wBAAsB,oBAAoB,CACtC,IAAI,EAAE,iBAAiB,EACvB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,UAAQ,EACZ,SAAS,CAAC,EAAE,MAAM,GACnB,OAAO,CACN;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,KAAK,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAC5E,CAyIA"}

package/dist/auth/identity-query.js

@@ -0,0 +1,122 @@
+import { identityLookupIdentifiers, identityOrIdentifiers, validateIdentityQueryOptions } from './identity-filter.js';
+import { FirebaseEdgeError } from './errors.js';
+/** Execute one backend request, never follow a token or scan for more matches. @internal */
+export async function executeIdentityQuery(auth, options, last = false, pageToken) {
+    validateIdentityQueryOptions(options);
+    if (typeof last !== 'boolean' ||
+        (pageToken !== undefined &&
+            (typeof pageToken !== 'string' || pageToken.length === 0))) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: 'Use a boolean last flag and a nonempty page token.'
+        });
+    }
+    if (options.identifiers !== undefined ||
+        options.filter?.field === 'initialEmail' ||
+        options.filter?.operator === 'in') {
+        if ((options.identifiers !== undefined &&
+            options.filter !== undefined) ||
+            options.orderBy ||
+            options.offset !== undefined ||
+            options.limit !== undefined ||
+            last ||
+            pageToken !== undefined) {
+            throw new FirebaseEdgeError({
+                code: 'auth/invalid-argument',
+                message: 'Lookup filters do not support sorting, limits, offsets, or page tokens.'
+            });
+        }
+        const identifiers = options.identifiers !== undefined
+            ? identityOrIdentifiers(options.identifiers)
+            : identityLookupIdentifiers(options.filter.field, options.filter.operator === 'in'
+                ? options.filter.value
+                : [options.filter.value]);
+        const { error, data } = await auth.getUsers(identifiers);
+        if (error) {
+            return { error, data: null };
+        }
+        return {
+            error: null,
+            data: { users: data.users, nextOffset: null, nextPageToken: null }
+        };
+    }
+    const offset = options.offset ?? 0;
+    const limit = options.limit ?? 500;
+    const orderBy = options.orderBy ?? { field: 'uid', direction: 'asc' };
+    const useBatch = !options.filter &&
+        !last &&
+        offset === 0 &&
+        orderBy.field === 'uid' &&
+        orderBy.direction === 'asc';
+    if (pageToken !== undefined && !useBatch) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: 'Page tokens require an unfiltered UID-ascending listing without offset or limitToLast.'
+        });
+    }
+    if (limit > (useBatch ? 1000 : 500)) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: useBatch
+                ? 'Token listings support at most 1000 users per request.'
+                : 'Filtered, sorted, and offset queries support at most 500 users per request.'
+        });
+    }
+    if (last && offset + limit > 500) {
+        throw new FirebaseEdgeError({
+            code: 'auth/invalid-argument',
+            message: 'limitToLast plus offset must not exceed 500 for a single query request.'
+        });
+    }
+    if (useBatch) {
+        const { error, data } = await auth.listUsers(limit, pageToken);
+        if (error) {
+            return { data: null, error };
+        }
+        return {
+            data: {
+                users: data.users,
+                nextOffset: null,
+                nextPageToken: data.pageToken ?? null
+            },
+            error: null
+        };
+    }
+    const request = last
+        ? {
+            ...options,
+            offset: 0,
+            limit: limit + offset,
+            orderBy: {
+                field: orderBy.field,
+                direction: orderBy.direction === 'asc'
+                    ? 'desc'
+                    : 'asc'
+            }
+        }
+        : { ...options, orderBy };
+    const { error, data } = await auth._queryUsers(request);
+    if (error) {
+        return { data: null, error };
+    }
+    if (last) {
+        const count = Math.min(limit, Math.max(0, data.length - offset));
+        return {
+            data: {
+                users: data.slice(0, count).reverse(),
+                nextOffset: null,
+                nextPageToken: null
+            },
+            error: null
+        };
+    }
+    return {
+        data: {
+            users: data,
+            nextOffset: data.length === limit ? offset + data.length : null,
+            nextPageToken: null
+        },
+        error: null
+    };
+}
+//# sourceMappingURL=identity-query.js.map

package/dist/auth/identity-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity-query.js","sourceRoot":"","sources":["../../src/auth/identity-query.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,yBAAyB,EACzB,qBAAqB,EACrB,4BAA4B,EAC/B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAOhD,4FAA4F;AAC5F,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACtC,IAAuB,EACvB,OAA6B,EAC7B,IAAI,GAAG,KAAK,EACZ,SAAkB;IAIlB,4BAA4B,CAAC,OAAO,CAAC,CAAC;IACtC,IACI,OAAO,IAAI,KAAK,SAAS;QACzB,CAAC,SAAS,KAAK,SAAS;YACpB,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,EAChE,CAAC;QACC,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,oDAAoD;SAChE,CAAC,CAAC;IACP,CAAC;IACD,IACI,OAAO,CAAC,WAAW,KAAK,SAAS;QACjC,OAAO,CAAC,MAAM,EAAE,KAAK,KAAK,cAAc;QACxC,OAAO,CAAC,MAAM,EAAE,QAAQ,KAAK,IAAI,EACnC,CAAC;QACC,IACI,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS;YAC9B,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC;YACjC,OAAO,CAAC,OAAO;YACf,OAAO,CAAC,MAAM,KAAK,SAAS;YAC5B,OAAO,CAAC,KAAK,KAAK,SAAS;YAC3B,IAAI;YACJ,SAAS,KAAK,SAAS,EACzB,CAAC;YACC,MAAM,IAAI,iBAAiB,CAAC;gBACxB,IAAI,EAAE,uBAAuB;gBAC7B,OAAO,EACH,yEAAyE;aAChF,CAAC,CAAC;QACP,CAAC;QACD,MAAM,WAAW,GACb,OAAO,CAAC,WAAW,KAAK,SAAS;YAC7B,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,WAAW,CAAC;YAC5C,CAAC,CAAC,yBAAyB,CACrB,OAAO,CAAC,MAAO,CAAC,KAAK,EACrB,OAAO,CAAC,MAAO,CAAC,QAAQ,KAAK,IAAI;gBAC7B,CAAC,CAAC,OAAO,CAAC,MAAO,CAAC,KAAK;gBACvB,CAAC,CAAC,CAAC,OAAO,CAAC,MAAO,CAAC,KAAe,CAAC,CAC1C,CAAC;QACZ,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACzD,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACjC,CAAC;QACD,OAAO;YACH,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE;SACrE,CAAC;IACN,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC;IACnC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAEtE,MAAM,QAAQ,GACV,CAAC,OAAO,CAAC,MAAM;QACf,CAAC,IAAI;QACL,MAAM,KAAK,CAAC;QACZ,OAAO,CAAC,KAAK,KAAK,KAAK;QACvB,OAAO,CAAC,SAAS,KAAK,KAAK,CAAC;IAEhC,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,QAAQ,EAAE,CAAC;QACvC,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EACH,wFAAwF;SAC/F,CAAC,CAAC;IACP,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,QAAQ;gBACb,CAAC,CAAC,wDAAwD;gBAC1D,CAAC,CAAC,6EAA6E;SACtF,CAAC,CAAC;IACP,CAAC;IACD,IAAI,IAAI,IAAI,MAAM,GAAG,KAAK,GAAG,GAAG,EAAE,CAAC;QAC/B,MAAM,IAAI,iBAAiB,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EACH,yEAAyE;SAChF,CAAC,CAAC;IACP,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACX,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC/D,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QACjC,CAAC;QACD,OAAO;YACH,IAAI,EAAE;gBACF,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,UAAU,EAAE,IAAI;gBAChB,aAAa,EAAE,IAAI,CAAC,SAAS,IAAI,IAAI;aACxC;YACD,KAAK,EAAE,IAAI;SACd,CAAC;IACN,CAAC;IAED,MAAM,OAAO,GAAG,IAAI;QAChB,CAAC,CAAC;YACI,GAAG,OAAO;YACV,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,KAAK,GAAG,MAAM;YACrB,OAAO,EAAE;gBACL,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,SAAS,EACL,OAAO,CAAC,SAAS,KAAK,KAAK;oBACvB,CAAC,CAAE,MAAgB;oBACnB,CAAC,CAAE,KAAe;aAC7B;SACJ;QACH,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC;IAC9B,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACxD,IAAI,KAAK,EAAE,CAAC;QACR,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IACjC,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACP,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;QACjE,OAAO;YACH,IAAI,EAAE;gBACF,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE;gBACrC,UAAU,EAAE,IAAI;gBAChB,aAAa,EAAE,IAAI;aACtB;YACD,KAAK,EAAE,IAAI;SACd,CAAC;IACN,CAAC;IACD,OAAO;QACH,IAAI,EAAE;YACF,KAAK,EAAE,IAAI;YACX,UAAU,EAAE,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;YAC/D,aAAa,EAAE,IAAI;SACtB;QACD,KAAK,EAAE,IAAI;KACd,CAAC;AACN,CAAC"}

package/dist/auth/identity-reference.d.ts

@@ -0,0 +1,150 @@
+import type { IdentityUpdateData, IdentitySetData, IdentityWriteResult } from './identity-write.js';
+import type { UserMetadataRequest } from './user-import.js';
+import type { ActionCodeSettings, FirebaseAdminAuth } from './firebase-admin-auth.js';
+import { type UserIdentifier } from './user-request.js';
+import type { UserRecord } from './user-record.js';
+import { FirebaseEdgeError } from './errors.js';
+export type IdentityUserRecord<Claims extends object = Record<string, unknown>> = Omit<UserRecord, 'customClaims'> & {
+    readonly customClaims?: Partial<Claims>;
+};
+type IdentityWriteResponse = {
+    error: null;
+    data: IdentityWriteResult;
+} | {
+    error: Error;
+    data: null;
+};
+export interface IdentityReferenceOptions<Multiple extends boolean = false, Uid extends boolean = false> {
+    /** Return an array of matches instead of one user or null. Defaults to false. */
+    multiple?: Multiple;
+    /** Enable mutations for a single UID identifier. Defaults to false. */
+    uidReference?: Uid;
+}
+/** Exact lookup with no query modifiers or count operation. */
+export declare class IdentityReference<Multiple extends boolean = false, Uid extends boolean = false, Claims extends object = Record<string, unknown>> {
+    private readonly auth;
+    private readonly identifier;
+    private readonly multiple;
+    private readonly uidReference;
+    private claimsResource?;
+    private metadataResource?;
+    constructor(auth: FirebaseAdminAuth, identifier: UserIdentifier, options?: IdentityReferenceOptions<Multiple, Uid>);
+    update(this: IdentityReference<false, true, Claims>, data: IdentityUpdateData<Claims>): Promise<{
+        data: null;
+        error: FirebaseEdgeError;
+    } | {
+        data: IdentityWriteResult;
+        error: null;
+    }>;
+    set(this: IdentityReference<false, true, Claims>, data: IdentitySetData<Claims>): Promise<{
+        data: null;
+        error: FirebaseEdgeError;
+    } | {
+        data: IdentityWriteResult;
+        error: null;
+    }>;
+    /** Disable sign-in for this user. */
+    disable(this: IdentityReference<false, true, Claims>): Promise<{
+        data: null;
+        error: FirebaseEdgeError;
+    } | {
+        data: IdentityWriteResult;
+        error: null;
+    }>;
+    /** Enable sign-in for this user. */
+    enable(this: IdentityReference<false, true, Claims>): Promise<{
+        data: null;
+        error: FirebaseEdgeError;
+    } | {
+        data: IdentityWriteResult;
+        error: null;
+    }>;
+    /** Ask Firebase to send a password-reset email to this user. */
+    resetPassword(this: IdentityReference<false, true, Claims>, settings?: ActionCodeSettings): Promise<IdentityWriteResponse>;
+    private sendPasswordResetEmail;
+    /** Custom-claims operations for a UID reference; accessing this performs no I/O. */
+    get claims(): Uid extends true ? Multiple extends false ? IdentityClaims<Claims> : never : never;
+    /** Writable timestamps for a UID reference; accessing this performs no I/O. */
+    get metadata(): Uid extends true ? Multiple extends false ? IdentityMetadata : never : never;
+    delete(this: IdentityReference<false, true, Claims>): Promise<IdentityWriteResponse>;
+    private requireUid;
+    /** Check whether an exact single-user lookup matches an account. */
+    exists(this: IdentityReference<false, Uid, Claims>): Promise<{
+        error: null;
+        data: boolean;
+    } | {
+        error: Error;
+        data: null;
+    }>;
+    get(): Promise<{
+        error: null;
+        data: Multiple extends true ? IdentityUserRecord<Claims>[] : IdentityUserRecord<Claims> | null;
+    } | {
+        error: Error;
+        data: null;
+    }>;
+}
+/** Update explicitly supplied account timestamps. Access through user.metadata. */
+declare class IdentityMetadata {
+    private readonly auth;
+    private readonly uid;
+    constructor(auth: FirebaseAdminAuth, uid: string);
+    update(metadata: UserMetadataRequest): Promise<{
+        data: null;
+        error: FirebaseEdgeError;
+    } | {
+        data: IdentityWriteResult;
+        error: null;
+    }>;
+    get(): Promise<{
+        error: Error;
+        data: null;
+    } | {
+        error: null;
+        data: import("./firebase-types.js").UserMetadata & {
+            toJSON(): object;
+        };
+    }>;
+    revokeTokens(): Promise<IdentityWriteResponse>;
+}
+/** Claims stored on one existing UID. Access through user.claims. */
+declare class IdentityClaims<Claims extends object> {
+    private readonly auth;
+    private readonly uid;
+    constructor(auth: FirebaseAdminAuth, uid: string);
+    /** Replace all custom claims; null clears them. No read is required. */
+    set(claims: Partial<Claims> | null): Promise<IdentityWriteResponse>;
+    get(): Promise<{
+        error: Error;
+        data: null;
+    } | {
+        error: null;
+        data: Partial<Claims>;
+    }>;
+    /** Select one literal top-level claim key, not a dotted path. */
+    byKey<Key extends Extract<keyof Claims, string>>(key: Key): IdentityClaimKey<Claims, Key>;
+    /** Shallow-merge claims using a non-atomic read followed by a write. */
+    update(claims: Partial<Claims>): Promise<IdentityWriteResponse>;
+    /** Clear all custom claims without deleting the user. */
+    delete(): Promise<IdentityWriteResponse>;
+}
+/** One claim value. Updates and deletion preserve other top-level claims. */
+declare class IdentityClaimKey<Claims extends object, Key extends Extract<keyof Claims, string>> {
+    private readonly claims;
+    private readonly key;
+    constructor(claims: IdentityClaims<Claims>, key: Key);
+    /** Set or replace this key's value while preserving the other claims. */
+    set(value: Exclude<Claims[Key], undefined>): Promise<IdentityWriteResponse>;
+    /** Read one own claim value; an absent key returns undefined. */
+    get(): Promise<{
+        error: null;
+        data: Claims[Key] | undefined;
+    } | {
+        error: Error;
+        data: null;
+    }>;
+    update(value: Exclude<Claims[Key], undefined>): Promise<IdentityWriteResponse>;
+    delete(): Promise<IdentityWriteResponse>;
+}
+export {};
+//# sourceMappingURL=identity-reference.d.ts.map

package/dist/auth/identity-reference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity-reference.d.ts","sourceRoot":"","sources":["../../src/auth/identity-reference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,kBAAkB,EAClB,eAAe,EACf,mBAAmB,EACtB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EACR,kBAAkB,EAClB,iBAAiB,EACpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAGH,KAAK,cAAc,EACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAe,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE7D,MAAM,MAAM,kBAAkB,CAC1B,MAAM,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC/C,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG;IACnC,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3C,CAAC;AAEF,KAAK,qBAAqB,GACpB;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,GAC1C;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC;AAEnC,MAAM,WAAW,wBAAwB,CACrC,QAAQ,SAAS,OAAO,GAAG,KAAK,EAChC,GAAG,SAAS,OAAO,GAAG,KAAK;IAE3B,iFAAiF;IACjF,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,uEAAuE;IACvE,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED,+DAA+D;AAC/D,qBAAa,iBAAiB,CAC1B,QAAQ,SAAS,OAAO,GAAG,KAAK,EAChC,GAAG,SAAS,OAAO,GAAG,KAAK,EAC3B,MAAM,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAS3C,OAAO,CAAC,QAAQ,CAAC,IAAI;IAPzB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAiB;IAC5C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAM;IACnC,OAAO,CAAC,cAAc,CAAC,CAAyB;IAChD,OAAO,CAAC,gBAAgB,CAAC,CAAmB;gBAGvB,IAAI,EAAE,iBAAiB,EACxC,UAAU,EAAE,cAAc,EAC1B,OAAO,GAAE,wBAAwB,CAAC,QAAQ,EAAE,GAAG,CAAM;IA0BzD,MAAM,CACF,IAAI,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,EAC5C,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC;;;;;;;IAMpC,GAAG,CACC,IAAI,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,EAC5C,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC;;;;;;;IAMjC,qCAAqC;IACrC,OAAO,CAAC,IAAI,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC;;;;;;;IAIpD,oCAAoC;IACpC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC;;;;;;;IAInD,gEAAgE;IAChE,aAAa,CACT,IAAI,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,EAC5C,QAAQ,CAAC,EAAE,kBAAkB;YAMnB,sBAAsB;IAyBpC,oFAAoF;IACpF,IAAI,MAAM,IAAI,GAAG,SAAS,IAAI,GACxB,QAAQ,SAAS,KAAK,GAClB,cAAc,CAAC,MAAM,CAAC,GACtB,KAAK,GACT,KAAK,CAQV;IAED,+EAA+E;IAC/E,IAAI,QAAQ,IAAI,GAAG,SAAS,IAAI,GAC1B,QAAQ,SAAS,KAAK,GAClB,gBAAgB,GAChB,KAAK,GACT,KAAK,CAQV;IAED,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC;IAKnD,OAAO,CAAC,UAAU;IAclB,oEAAoE;IAC9D,MAAM,CACR,IAAI,EAAE,iBAAiB,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,GAC5C,OAAO,CAAC;QAAE,KAAK,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC;IAiBnE,GAAG,IAAI,OAAO,CACd;QACI,KAAK,EAAE,IAAI,CAAC;QACZ,IAAI,EAAE,QAAQ,SAAS,IAAI,GACrB,kBAAkB,CAAC,MAAM,CAAC,EAAE,GAC5B,kBAAkB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KAC3C,GACD;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CACjC;CAkBJ;AAED,mFAAmF;AACnF,cAAM,gBAAgB;IAEd,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,IAAI,EAAE,iBAAiB,EACvB,GAAG,EAAE,MAAM;IAGhC,MAAM,CAAC,QAAQ,EAAE,mBAAmB;;;;;;;IAI9B,GAAG;;;;;;;;;IAQT,YAAY;CAMf;AAED,qEAAqE;AACrE,cAAM,cAAc,CAAC,MAAM,SAAS,MAAM;IAElC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,IAAI,EAAE,iBAAiB,EACvB,GAAG,EAAE,MAAM;IAGhC,wEAAwE;IACxE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI;IAO5B,GAAG;;;;;cAOkC,OAAO,CAAC,MAAM,CAAC;;IAI1D,iEAAiE;IACjE,KAAK,CAAC,GAAG,SAAS,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG;IAczD,wEAAwE;IAClE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;IA+BpC,yDAAyD;IACzD,MAAM;CAGT;AAED,6EAA6E;AAC7E,cAAM,gBAAgB,CAClB,MAAM,SAAS,MAAM,EACrB,GAAG,SAAS,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC;IAGrC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,EAC9B,GAAG,EAAE,GAAG;IAG7B,yEAAyE;IACzE,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC;IAI1C,iEAAiE;IAC3D,GAAG,IAAI,OAAO,CACd;QAAE,KAAK,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAA;KAAE,GAC9C;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CACjC;IAWK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC;IAsC7C,MAAM;CASf"}