@dereekb/firebase 13.6.17 → 13.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "13.6.17",
+  "version": "13.8.0",
   "exports": {
     "./test": {
       "module": "./test/index.esm.js",
@@ -17,14 +17,14 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/util": "13.6.17",
-    "@dereekb/date": "13.6.17",
-    "@dereekb/model": "13.6.17",
-    "@dereekb/rxjs": "13.6.17",
+    "@dereekb/util": "13.8.0",
+    "@dereekb/date": "13.8.0",
+    "@dereekb/model": "13.8.0",
+    "@dereekb/rxjs": "13.8.0",
     "@firebase/rules-unit-testing": "5.0.0",
     "arktype": "^2.2.0",
     "date-fns": "^4.0.0",
-    "firebase": "^12.0.0",
+    "firebase": "^12.12.0",
     "make-error": "^1.3.0",
     "rxjs": "^7.8.0",
     "ts-essentials": "^10.0.0"

package/src/lib/common/auth/auth.error.d.ts

@@ -48,6 +48,13 @@ export declare const FIREBASE_AUTH_CREDENTIAL_ALREADY_IN_USE_ERROR = "auth/crede
  * Error code when an email address is already in use by another account during linking.
  */
 export declare const FIREBASE_AUTH_EMAIL_ALREADY_IN_USE_ERROR = "auth/email-already-in-use";
+/**
+ * Error code when the quota for updating account information has been exceeded.
+ *
+ * This typically occurs when too many account update operations (e.g., updateUser, setCustomUserClaims)
+ * are performed in a short time window.
+ */
+export declare const FIREBASE_AUTH_QUOTA_EXCEEDED_ERROR = "auth/quota-exceeded";
 /**
  * Converts a {@link FirebaseAuthError} into a user-friendly {@link ReadableError} with a human-readable message.
  *

package/src/lib/common/auth/auth.server.error.d.ts

@@ -10,3 +10,19 @@ export declare const DBX_FIREBASE_SERVER_NO_AUTH_ERROR_CODE = "NO_AUTH";
  * This can happen with anonymous or malformed tokens.
  */
 export declare const DBX_FIREBASE_SERVER_NO_UID_ERROR_CODE = "NO_USER_UID";
+/**
+ * Error code used when the provided password reset code is invalid or expired.
+ */
+export declare const DBX_FIREBASE_SERVER_PASSWORD_RESET_INVALID_CODE_ERROR_CODE = "PASSWORD_RESET_INVALID_CODE";
+/**
+ * Error code used when a password reset is attempted but no active reset exists for the user.
+ */
+export declare const DBX_FIREBASE_SERVER_PASSWORD_RESET_NO_CONFIG_ERROR_CODE = "PASSWORD_RESET_NO_CONFIG";
+/**
+ * Error code used when a password reset email send is throttled due to a recent send.
+ */
+export declare const DBX_FIREBASE_SERVER_PASSWORD_RESET_THROTTLE_ERROR_CODE = "PASSWORD_RESET_THROTTLE";
+/**
+ * Error code used when a password reset email has already been sent and the send-once constraint is active.
+ */
+export declare const DBX_FIREBASE_SERVER_PASSWORD_RESET_SEND_ONCE_ERROR_CODE = "PASSWORD_RESET_SEND_ONCE";

package/src/lib/common/function/error.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Error code for unauthenticated (401) requests.
+ */
+export declare const UNAUTHENTICATED_ERROR_CODE = "UNAUTHENTICATED";
+/**
+ * Error code for forbidden (403) requests.
+ */
+export declare const FORBIDDEN_ERROR_CODE = "FORBIDDEN";
+/**
+ * Error code for permission-denied (403) requests.
+ */
+export declare const PERMISSION_DENIED_ERROR_CODE = "PERMISSION_DENIED";
+/**
+ * Error code for not-found (404) requests.
+ */
+export declare const NOT_FOUND_ERROR_CODE = "NOT_FOUND";
+/**
+ * Error code for a Firestore document that does not exist (404).
+ */
+export declare const MODEL_NOT_AVAILABLE_ERROR_CODE = "MODEL_NOT_AVAILABLE";
+/**
+ * Error code for bad-request (400) responses.
+ */
+export declare const BAD_REQUEST_ERROR_CODE = "BAD_REQUEST";
+/**
+ * Error code for precondition-conflict (409) responses.
+ */
+export declare const CONFLICT_ERROR_CODE = "CONFLICT";
+/**
+ * Error code for already-exists (409) responses.
+ */
+export declare const ALREADY_EXISTS_ERROR_CODE = "ALREADY_EXISTS";
+/**
+ * Error code for unavailable (503) responses.
+ */
+export declare const UNAVAILABLE_ERROR_CODE = "UNAVAILABLE";
+/**
+ * Error code for deactivated or unavailable functions (501).
+ */
+export declare const UNAVAILABLE_OR_DEACTIVATED_FUNCTION_ERROR_CODE = "UNAVAILABLE_OR_DEACTIVATED_FUNCTION";
+/**
+ * Error code for internal server errors (500).
+ */
+export declare const INTERNAL_SERVER_ERROR_CODE = "INTERNAL_ERROR";

package/src/lib/common/function/index.d.ts

@@ -1 +1,2 @@
 export * from './action';
+export * from './error';

package/src/lib/common/model/function.d.ts

@@ -4,7 +4,7 @@ import { type FirestoreModelKey, type FirestoreModelType, type FirestoreModelTyp
 /**
  * Standard CRUD call types used by the `callModel` Firebase function pattern.
  */
-export type KnownOnCallFunctionType = 'create' | 'read' | 'update' | 'delete';
+export type KnownOnCallFunctionType = 'create' | 'read' | 'update' | 'delete' | 'query';
 /**
  * Call type identifier — one of the standard CRUD types or a custom string.
  */
@@ -82,6 +82,10 @@ export declare const onCallUpdateModelParams: OnCallTypeModelParamsFunction;
  * Pre-configured OnCallTypedModelParamsFunctions for 'delete'
  */
 export declare const onCallDeleteModelParams: OnCallTypeModelParamsFunction;
+/**
+ * Pre-configured OnCallTypedModelParamsFunctions for 'query'
+ */
+export declare const onCallQueryModelParams: OnCallTypeModelParamsFunction;
 /**
  * Key used on the front-end and backend that refers to the call function.
  */
@@ -102,6 +106,80 @@ export type OnCallUpdateModelParams<T = unknown> = OnCallTypedModelParams<T>;
  * OnCallTypedModelParams for Delete calls.
  */
 export type OnCallDeleteModelParams<T = unknown> = OnCallTypedModelParams<T>;
+/**
+ * OnCallTypedModelParams for Query calls.
+ */
+export type OnCallQueryModelParams<T extends OnCallQueryModelRequestParams = OnCallQueryModelRequestParams> = OnCallTypedModelParams<T>;
+/**
+ * Default maximum items per page for query operations.
+ */
+export declare const DEFAULT_ON_CALL_QUERY_MODEL_LIMIT = 50;
+/**
+ * Absolute maximum items per page for query operations. Prevents unbounded queries.
+ */
+export declare const MAX_ON_CALL_QUERY_MODEL_LIMIT = 200;
+/**
+ * Base request parameters that all query handler input types must include.
+ *
+ * Provides cursor-based pagination fields. Custom query handlers extend this
+ * with additional filter fields specific to their model type.
+ *
+ * @example
+ * ```typescript
+ * interface QueryGuestbooksParams extends OnCallQueryModelRequestParams {
+ *   readonly name?: string;
+ *   readonly published?: boolean;
+ * }
+ * ```
+ */
+export interface OnCallQueryModelRequestParams {
+    /**
+     * Maximum number of items to return per page.
+     *
+     * Clamped server-side to {@link MAX_ON_CALL_QUERY_MODEL_LIMIT}.
+     * Defaults to {@link DEFAULT_ON_CALL_QUERY_MODEL_LIMIT} when omitted.
+     */
+    readonly limit?: number;
+    /**
+     * Firestore model key of the last document from the previous page.
+     *
+     * When provided, the query resumes after the document at this key.
+     * Obtained from {@link OnCallQueryModelResult.cursorDocumentKey}.
+     */
+    readonly cursorDocumentKey?: FirestoreModelKey;
+}
+/**
+ * Standard result returned by model query operations.
+ *
+ * Includes the matched documents and cursor information for pagination.
+ *
+ * @typeParam T - The document data type.
+ */
+export interface OnCallQueryModelResult<T = unknown> {
+    /**
+     * The matched documents' data for this page.
+     */
+    readonly results: readonly T[];
+    /**
+     * The keys of the matched documents, in the same order as {@link results}.
+     */
+    readonly keys: readonly FirestoreModelKey[];
+    /**
+     * Total number of results returned in this page.
+     */
+    readonly count: number;
+    /**
+     * Firestore model key of the last document in this page.
+     *
+     * Pass this value as the `cursorDocumentKey` field in the next query request to fetch the next page.
+     * Undefined when there are no more results.
+     */
+    readonly cursorDocumentKey?: FirestoreModelKey;
+    /**
+     * Whether there are more results after this page.
+     */
+    readonly hasMore: boolean;
+}
 /**
  * Standard result returned by model create operations, containing the key(s) of the created document(s).
  */

package/src/lib/common/model/function.error.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Error code for a model type string that has no registered handler.
+ */
+export declare const UNKNOWN_MODEL_TYPE_ERROR_CODE = "UNKNOWN_MODEL_TYPE";
+/**
+ * Error code for an invalid or inaccessible cursor document key in a query request.
+ */
+export declare const BAD_DOCUMENT_QUERY_CURSOR_ERROR_CODE = "BAD_DOCUMENT_QUERY_CURSOR";

package/src/lib/common/model/index.d.ts

@@ -2,4 +2,5 @@ export * from './model';
 export * from './permission';
 export * from './context';
 export * from './function';
+export * from './function.error';
 export * from './model.service';

package/src/lib/model/oidcmodel/oidcmodel.d.ts

@@ -27,7 +27,7 @@ export declare const oidcEntryIdentity: import("../..").RootFirestoreModelIdenti
  *
  * Used as the discriminator in the {@link OidcEntry.type} field.
  */
-export type OidcEntryType = 'Session' | 'AccessToken' | 'AuthorizationCode' | 'RefreshToken' | 'DeviceCode' | 'ClientCredentials' | 'Client' | 'InitialAccessToken' | 'RegistrationAccessToken' | 'Interaction' | 'ReplayDetection' | 'PushedAuthorizationRequest' | 'Grant' | 'BackchannelAuthenticationRequest' | (string & {});
+export type OidcEntryType = 'Session' | 'AccessToken' | 'AuthorizationCode' | 'RefreshToken' | 'DeviceCode' | 'ClientCredentials' | 'Client' | 'InitialAccessToken' | 'RegistrationAccessToken' | 'Interaction' | 'ReplayDetection' | 'PushedAuthorizationRequest' | 'Grant' | 'BackchannelAuthenticationRequest' | string;
 /**
  * Type value for Client adapter entries.
  */

package/test/index.cjs.js

@@ -10,7 +10,7 @@ var rxjs = require('@dereekb/rxjs');
 var dateFns = require('date-fns');
 var date = require('@dereekb/date');
 var stream = require('stream');
-var fs = require('fs');
+var node_fs = require('node:fs');
 
 function _array_like_to_array$2(arr, len) {
     if (len == null || len > arr.length) len = arr.length;
@@ -10032,6 +10032,56 @@ function _ts_generator$1(thisArg, body) {
                             done();
                         });
                     }));
+                    it('should reach end when limit equals total document count.', test.callbackTest(function(done) {
+                        var limit = testDocumentCount; // exactly matches item count
+                        var iteration = firestoreIteration({
+                            limit: limit
+                        });
+                        var accumulator = firebase.firebaseQuerySnapshotAccumulator(iteration);
+                        // First page should return all items but not yet know it's the end
+                        iteration.nextPage().then(function() {
+                            // Load the next page which should discover end via empty snapshot
+                            iteration.nextPage().then(function() {
+                                sub.subscription = iteration.latestState$.pipe(rxjs$1.filter(function(x) {
+                                    return rxjs.isLoadingStateFinishedLoading(x);
+                                }), rxjs$1.first()).subscribe(function(state) {
+                                    expect(state.hasNextPage).toBe(false);
+                                    // Verify all items loaded without duplicates
+                                    rxjs.flattenAccumulatorResultItemArray(accumulator).pipe(rxjs$1.first()).subscribe(function(values) {
+                                        expect(values.length).toBe(testDocumentCount);
+                                        expect(util.arrayContainsDuplicateValue(values.map(function(x) {
+                                            return x.id;
+                                        }))).toBe(false);
+                                        done();
+                                    });
+                                });
+                            });
+                        });
+                    }));
+                    it('should reach end when loading all pages with limit as a divisor of total count.', test.callbackTest(function(done) {
+                        var limit = 5; // divides evenly into testDocumentCount (10)
+                        var expectedPages = testDocumentCount / limit; // 2 full pages + 1 empty to discover end
+                        var iteration = firestoreIteration({
+                            limit: limit
+                        });
+                        var accumulator = firebase.firebaseQuerySnapshotAccumulator(iteration);
+                        // Load pages until the iterator reaches the end
+                        rxjs.iteratorNextPageUntilPage(iteration, expectedPages + 1).then(function(page) {
+                            sub.subscription = iteration.latestState$.pipe(rxjs$1.filter(function(x) {
+                                return rxjs.isLoadingStateFinishedLoading(x);
+                            }), rxjs$1.first()).subscribe(function(state) {
+                                expect(state.hasNextPage).toBe(false);
+                                // Verify all items loaded without duplicates
+                                rxjs.flattenAccumulatorResultItemArray(accumulator).pipe(rxjs$1.first()).subscribe(function(values) {
+                                    expect(values.length).toBe(testDocumentCount);
+                                    expect(util.arrayContainsDuplicateValue(values.map(function(x) {
+                                        return x.id;
+                                    }))).toBe(false);
+                                    done();
+                                });
+                            });
+                        });
+                    }));
                 });
                 describe('with inferEndOfResultsFromPageSize=false', function() {
                     it('should not mark the result as the end even when fewer items are returned than the limit.', test.callbackTest(function(done) {
@@ -11108,7 +11158,7 @@ function _ts_generator(thisArg, body) {
                                         ];
                                         testFilePath = "".concat(__dirname, "/assets/testpng.png");
                                         contentType = 'image/png';
-                                        testFileStream = fs.createReadStream(testFilePath, {});
+                                        testFileStream = node_fs.createReadStream(testFilePath, {});
                                         return [
                                             4,
                                             firebase.uploadFileWithStream(uploadFile, testFileStream, {

package/test/index.esm.js

@@ -4,11 +4,11 @@ import { firebaseStorageContextFactory, firestoreContextFactory, firebaseFiresto
 import { setLogLevel } from 'firebase/firestore';
 import { AbstractTestContextFixture, instanceWrapTestContextFactory, AbstractWrappedFixtureWithInstance, itShouldFail, expectFail, callbackTest } from '@dereekb/util/test';
 import { firstValueFrom, filter, skip, from, first, map, switchMap } from 'rxjs';
-import { SubscriptionObject, iteratorNextPageUntilPage, flattenAccumulatorResultItemArray, accumulatorCurrentPageListLoadingState, isLoadingStateFinishedLoading, accumulatorFlattenPageListLoadingState } from '@dereekb/rxjs';
+import { SubscriptionObject, isLoadingStateFinishedLoading, flattenAccumulatorResultItemArray, iteratorNextPageUntilPage, accumulatorCurrentPageListLoadingState, accumulatorFlattenPageListLoadingState } from '@dereekb/rxjs';
 import { addDays, startOfDay, addHours } from 'date-fns';
 import { DateRangeType } from '@dereekb/date';
 import { Readable } from 'stream';
-import { createReadStream } from 'fs';
+import { createReadStream } from 'node:fs';
 
 function _array_like_to_array$2(arr, len) {
     if (len == null || len > arr.length) len = arr.length;
@@ -10030,6 +10030,56 @@ function _ts_generator$1(thisArg, body) {
                             done();
                         });
                     }));
+                    it('should reach end when limit equals total document count.', callbackTest(function(done) {
+                        var limit = testDocumentCount; // exactly matches item count
+                        var iteration = firestoreIteration({
+                            limit: limit
+                        });
+                        var accumulator = firebaseQuerySnapshotAccumulator(iteration);
+                        // First page should return all items but not yet know it's the end
+                        iteration.nextPage().then(function() {
+                            // Load the next page which should discover end via empty snapshot
+                            iteration.nextPage().then(function() {
+                                sub.subscription = iteration.latestState$.pipe(filter(function(x) {
+                                    return isLoadingStateFinishedLoading(x);
+                                }), first()).subscribe(function(state) {
+                                    expect(state.hasNextPage).toBe(false);
+                                    // Verify all items loaded without duplicates
+                                    flattenAccumulatorResultItemArray(accumulator).pipe(first()).subscribe(function(values) {
+                                        expect(values.length).toBe(testDocumentCount);
+                                        expect(arrayContainsDuplicateValue(values.map(function(x) {
+                                            return x.id;
+                                        }))).toBe(false);
+                                        done();
+                                    });
+                                });
+                            });
+                        });
+                    }));
+                    it('should reach end when loading all pages with limit as a divisor of total count.', callbackTest(function(done) {
+                        var limit = 5; // divides evenly into testDocumentCount (10)
+                        var expectedPages = testDocumentCount / limit; // 2 full pages + 1 empty to discover end
+                        var iteration = firestoreIteration({
+                            limit: limit
+                        });
+                        var accumulator = firebaseQuerySnapshotAccumulator(iteration);
+                        // Load pages until the iterator reaches the end
+                        iteratorNextPageUntilPage(iteration, expectedPages + 1).then(function(page) {
+                            sub.subscription = iteration.latestState$.pipe(filter(function(x) {
+                                return isLoadingStateFinishedLoading(x);
+                            }), first()).subscribe(function(state) {
+                                expect(state.hasNextPage).toBe(false);
+                                // Verify all items loaded without duplicates
+                                flattenAccumulatorResultItemArray(accumulator).pipe(first()).subscribe(function(values) {
+                                    expect(values.length).toBe(testDocumentCount);
+                                    expect(arrayContainsDuplicateValue(values.map(function(x) {
+                                        return x.id;
+                                    }))).toBe(false);
+                                    done();
+                                });
+                            });
+                        });
+                    }));
                 });
                 describe('with inferEndOfResultsFromPageSize=false', function() {
                     it('should not mark the result as the end even when fewer items are returned than the limit.', callbackTest(function(done) {

package/test/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "13.6.17",
+  "version": "13.8.0",
   "peerDependencies": {
-    "@dereekb/date": "13.6.17",
-    "@dereekb/firebase": "13.6.17",
-    "@dereekb/model": "13.6.17",
-    "@dereekb/rxjs": "13.6.17",
-    "@dereekb/util": "13.6.17",
+    "@dereekb/date": "13.8.0",
+    "@dereekb/firebase": "13.8.0",
+    "@dereekb/model": "13.8.0",
+    "@dereekb/rxjs": "13.8.0",
+    "@dereekb/util": "13.8.0",
     "@firebase/rules-unit-testing": "5.0.0",
     "date-fns": "^4.0.0",
-    "firebase": "^12.0.0",
+    "firebase": "^12.12.0",
     "rxjs": "^7.8.0"
   },
   "exports": {