@dereekb/firebase 13.11.13 → 13.11.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "13.11.13",
+  "version": "13.11.15",
   "sideEffects": false,
   "exports": {
     "./test": {
@@ -18,10 +18,10 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/util": "13.11.13",
-    "@dereekb/date": "13.11.13",
-    "@dereekb/model": "13.11.13",
-    "@dereekb/rxjs": "13.11.13",
+    "@dereekb/util": "13.11.15",
+    "@dereekb/date": "13.11.15",
+    "@dereekb/model": "13.11.15",
+    "@dereekb/rxjs": "13.11.15",
     "@firebase/rules-unit-testing": "5.0.0",
     "arktype": "^2.2.0",
     "date-fns": "^4.1.0",

package/src/lib/client/error/error.d.ts

@@ -6,7 +6,7 @@ import { type FirebaseError } from 'firebase/app';
  * for the `FirebaseError` name and a string `code` property. Used by {@link convertHttpsCallableErrorToReadableError}
  * to determine the appropriate error wrapping strategy.
  *
- * @param error - the value to check
+ * @param error - The value to check.
  * @returns `true` if the input matches the shape of a client-side `FirebaseError`
  *
  * @example

package/src/lib/client/firestore/array.d.ts

@@ -7,8 +7,8 @@ import { type UpdateData } from '../../common/firestore/types';
  * Processes both `union` (add elements) and `remove` (delete elements) operations,
  * spreading array values as individual arguments since Firestore does not allow nested arrays.
  *
- * @param input - object with `union` and/or `remove` maps from field names to arrays of values
- * @returns Firestore `UpdateData` with `FieldValue.arrayUnion()`/`FieldValue.arrayRemove()` sentinels
+ * @param input - Object with `union` and/or `remove` maps from field names to arrays of values.
+ * @returns Firestore `UpdateData` with `FieldValue.arrayUnion()`/`FieldValue.arrayRemove()` sentinels.
  *
  * @example
  * ```ts
@@ -18,6 +18,7 @@ import { type UpdateData } from '../../common/firestore/types';
  * });
  * await updateDoc(docRef, updateData);
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreClientArrayUpdateToUpdateData<T extends object>(input: FirestoreAccessorArrayUpdate<T>): UpdateData<T>;

package/src/lib/client/firestore/driver.accessor.batch.d.ts

@@ -21,8 +21,8 @@ export declare class WriteBatchFirestoreDocumentDataAccessor<T> extends DefaultF
  * instances bound to the given `WriteBatch`. All write operations from these accessors are queued
  * into the same batch.
  *
- * @param writeBatch - the Firestore `WriteBatch` to queue operations into
- * @returns a factory that creates write-batch-backed document data accessors for any document reference
+ * @param writeBatch - The Firestore `WriteBatch` to queue operations into.
+ * @returns A factory that creates write-batch-backed document data accessors for any document reference.
  *
  * @example
  * ```ts
@@ -32,6 +32,7 @@ export declare class WriteBatchFirestoreDocumentDataAccessor<T> extends DefaultF
  * await accessor.set(data);
  * await batch.commit();
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function writeBatchAccessorFactory<T>(writeBatch: FirebaseFirestoreWriteBatch): FirestoreDocumentDataAccessorFactory<T>;
@@ -51,8 +52,8 @@ export declare class WriteBatchFirestoreDocumentContext<T> implements FirestoreD
 /**
  * Factory function that creates a {@link WriteBatchFirestoreDocumentContext} for the given batch.
  *
- * @param batch - the Firestore `WriteBatch` to use for all document operations
- * @returns a new {@link WriteBatchFirestoreDocumentContext} bound to the given batch
+ * @param batch - The Firestore `WriteBatch` to use for all document operations.
+ * @returns A new {@link WriteBatchFirestoreDocumentContext} bound to the given batch.
  *
  * @example
  * ```ts

package/src/lib/client/firestore/driver.accessor.create.d.ts

@@ -6,15 +6,16 @@ import { type WithFieldValue, type WriteResult } from '../../common/firestore/ty
  * Used by client-side accessor implementations (default, transaction) as their `create()` method.
  * Checks for document existence first, then calls `set()` if the document is absent.
  *
- * @param accessor - the accessor to perform the existence check and set operation on
- * @returns a function that creates the document if it does not exist, or throws if it does
- * @throws {Error} When the document already exists at the reference path
+ * @param accessor - Accessor used to check for existence and write the new document.
+ * @returns Create function that writes the document or throws when it already exists.
+ * @throws {Error} When the document already exists at the reference path.
  *
  * @example
  * ```ts
  * const create = createWithAccessor(accessor);
  * await create({ name: 'New Item' }); // throws if document already exists
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function createWithAccessor<T>(accessor: FirestoreDocumentDataAccessor<T>): (data: WithFieldValue<T>) => Promise<void | WriteResult>;

package/src/lib/client/firestore/driver.accessor.d.ts

@@ -8,13 +8,14 @@ import { type FirestoreAccessorDriver } from '../../common/firestore/driver/acce
  * - Transaction and write batch context factories for atomic operations
  * - A default (non-transactional) document context
  *
- * @returns a {@link FirestoreAccessorDriver} backed by the `firebase/firestore` client SDK
+ * @returns A {@link FirestoreAccessorDriver} backed by the `firebase/firestore` client SDK.
  *
  * @example
  * ```ts
  * const driver = firestoreClientAccessorDriver();
  * // Used internally by firebaseFirestoreClientDrivers()
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreClientAccessorDriver(): FirestoreAccessorDriver;

package/src/lib/client/firestore/driver.accessor.default.d.ts

@@ -1,4 +1,5 @@
 import { type DocumentReference, type DocumentSnapshot, type UpdateData, type WithFieldValue } from 'firebase/firestore';
+import type { Maybe } from '@dereekb/util';
 import { type Observable } from 'rxjs';
 import { type DocumentData, type FirestoreAccessorArrayUpdate, type FirestoreAccessorIncrementUpdate, type FirestoreDataConverter, type FirestoreDocumentContext, type FirestoreDocumentDataAccessor, type FirestoreDocumentDataAccessorFactory, type SetOptions, type WriteResult } from '../../common/firestore';
 /**
@@ -18,7 +19,7 @@ export declare class DefaultFirestoreDocumentDataAccessor<T> implements Firestor
     create(data: WithFieldValue<T>): Promise<void>;
     exists(): Promise<boolean>;
     get(): Promise<DocumentSnapshot<T>>;
-    getWithConverter<U = DocumentData>(converter: null | FirestoreDataConverter<U>): Promise<DocumentSnapshot<U>>;
+    getWithConverter<U = DocumentData>(converter: Maybe<FirestoreDataConverter<U>>): Promise<DocumentSnapshot<U>>;
     delete(): Promise<void>;
     set(data: WithFieldValue<T>, options?: SetOptions): Promise<void>;
     increment(data: FirestoreAccessorIncrementUpdate<T>): Promise<void | WriteResult>;
@@ -29,7 +30,7 @@ export declare class DefaultFirestoreDocumentDataAccessor<T> implements Firestor
  * Creates a {@link FirestoreDocumentDataAccessorFactory} that produces {@link DefaultFirestoreDocumentDataAccessor} instances
  * for direct (non-batched, non-transactional) Firestore operations.
  *
- * @returns a factory that creates default (non-transactional) document data accessors
+ * @returns A factory that creates default (non-transactional) document data accessors.
  *
  * @example
  * ```ts
@@ -37,6 +38,7 @@ export declare class DefaultFirestoreDocumentDataAccessor<T> implements Firestor
  * const accessor = factory.accessorFor(documentRef);
  * const snapshot = await accessor.get();
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function defaultFirestoreAccessorFactory<T>(): FirestoreDocumentDataAccessorFactory<T>;
@@ -46,7 +48,7 @@ export declare function defaultFirestoreAccessorFactory<T>(): FirestoreDocumentD
  * The context type is {@link FirestoreDocumentContextType.NONE}, meaning operations execute immediately
  * against Firestore without transaction or batch grouping.
  *
- * @returns a default {@link FirestoreDocumentContext} with no transaction or batch semantics
+ * @returns A default {@link FirestoreDocumentContext} with no transaction or batch semantics.
  *
  * @example
  * ```ts

package/src/lib/client/firestore/driver.accessor.transaction.d.ts

@@ -1,4 +1,5 @@
 import { type DocumentReference, type DocumentSnapshot, type Transaction as FirebaseFirestoreTransaction, type UpdateData, type WithFieldValue } from 'firebase/firestore';
+import type { Maybe } from '@dereekb/util';
 import { type Observable } from 'rxjs';
 import { type FirestoreDocumentDataAccessor, type FirestoreDocumentDataAccessorFactory, type FirestoreDocumentContext, FirestoreDocumentContextType, type SetOptions, type DocumentData, type FirestoreDataConverter, type WriteResult, type FirestoreAccessorIncrementUpdate, type FirestoreAccessorArrayUpdate } from '../../common/firestore';
 /**
@@ -18,7 +19,7 @@ export declare class TransactionFirestoreDocumentDataAccessor<T> implements Fire
     create(data: WithFieldValue<T>): Promise<void>;
     exists(): Promise<boolean>;
     get(): Promise<DocumentSnapshot<T>>;
-    getWithConverter<U extends DocumentData = DocumentData>(converter: null | FirestoreDataConverter<U>): Promise<DocumentSnapshot<DocumentData, U>>;
+    getWithConverter<U extends DocumentData = DocumentData>(converter: Maybe<FirestoreDataConverter<U>>): Promise<DocumentSnapshot<DocumentData, U>>;
     delete(): Promise<void>;
     set(data: WithFieldValue<T>, options?: SetOptions): Promise<void>;
     increment(data: FirestoreAccessorIncrementUpdate<T>): Promise<void | WriteResult>;
@@ -29,8 +30,8 @@ export declare class TransactionFirestoreDocumentDataAccessor<T> implements Fire
  * Creates a {@link FirestoreDocumentDataAccessorFactory} that produces {@link TransactionFirestoreDocumentDataAccessor}
  * instances bound to the given transaction. All operations from these accessors participate in the same transaction.
  *
- * @param transaction - the Firestore `Transaction` to bind operations to
- * @returns a factory that creates transaction-backed document data accessors for any document reference
+ * @param transaction - The Firestore `Transaction` to bind operations to.
+ * @returns A factory that creates transaction-backed document data accessors for any document reference.
  *
  * @example
  * ```ts
@@ -41,6 +42,7 @@ export declare class TransactionFirestoreDocumentDataAccessor<T> implements Fire
  *   // ... modify and set
  * });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function transactionAccessorFactory<T>(transaction: FirebaseFirestoreTransaction): FirestoreDocumentDataAccessorFactory<T>;
@@ -60,8 +62,8 @@ export declare class TransactionFirestoreDocumentContext<T> implements Firestore
 /**
  * Factory function that creates a {@link TransactionFirestoreDocumentContext} for the given transaction.
  *
- * @param transaction - the Firestore `Transaction` to use for all document operations
- * @returns a new {@link TransactionFirestoreDocumentContext} bound to the given transaction
+ * @param transaction - The Firestore `Transaction` to use for all document operations.
+ * @returns A new {@link TransactionFirestoreDocumentContext} bound to the given transaction.
  *
  * @example
  * ```ts

package/src/lib/client/firestore/driver.d.ts

@@ -10,7 +10,7 @@ export type FirebaseFirestoreClientDrivers = FirestoreDrivers;
  * Provides accessor drivers (default, batch, transaction) and query drivers for use
  * with {@link clientFirebaseFirestoreContextFactory}.
  *
- * @returns the client-side {@link FirebaseFirestoreClientDrivers} for the `firebase/firestore` SDK
+ * @returns The client-side {@link FirebaseFirestoreClientDrivers} for the `firebase/firestore` SDK.
  *
  * @example
  * ```ts

package/src/lib/client/firestore/driver.query.d.ts

@@ -16,9 +16,9 @@ export interface FirebaseFirestoreQueryBuilder {
 /**
  * Appends one or more `QueryConstraint` values to the builder, returning a new builder instance.
  *
- * @param builder - current query builder state
- * @param constraint - constraint(s) to append
- * @returns a new {@link FirebaseFirestoreQueryBuilder} with the added constraint(s)
+ * @param builder - Current query builder state.
+ * @param constraint - Constraint(s) to append.
+ * @returns A new {@link FirebaseFirestoreQueryBuilder} with the added constraint(s)
  */
 export declare function addConstraintToBuilder(builder: FirebaseFirestoreQueryBuilder, constraint: ArrayOrValue<QueryConstraint>): FirebaseFirestoreQueryBuilder;
 /**
@@ -33,7 +33,7 @@ export declare const FIRESTORE_CLIENT_QUERY_CONSTRAINT_HANDLER_MAPPING: FullFire
  * Converts abstract query constraints into `firebase/firestore` `QueryConstraint` objects
  * and composes them into an executable `Query`.
  *
- * @returns a {@link FirestoreQueryConstraintFunctionsDriver} backed by the `firebase/firestore` client SDK
+ * @returns A {@link FirestoreQueryConstraintFunctionsDriver} backed by the `firebase/firestore` client SDK.
  */
 export declare function firebaseFirestoreQueryConstraintFunctionsDriver(): FirestoreQueryConstraintFunctionsDriver;
 /**
@@ -43,7 +43,7 @@ export declare function firebaseFirestoreQueryConstraintFunctionsDriver(): Fires
  * Note: Transactions are not supported for queries on the client; passing a `transaction` to `getDocs`
  * will throw an error.
  *
- * @returns a {@link FirestoreQueryDriver} backed by the `firebase/firestore` client SDK
+ * @returns A {@link FirestoreQueryDriver} backed by the `firebase/firestore` client SDK.
  *
  * @example
  * ```ts

package/src/lib/client/firestore/increment.d.ts

@@ -6,14 +6,15 @@ import { type FirestoreAccessorIncrementUpdate } from '../../common/firestore/ac
  *
  * Maps each field in the input to an `increment()` call, defaulting to 0 for `undefined` values.
  *
- * @param input - object mapping field names to their increment amounts
- * @returns Firestore `UpdateData` with `FieldValue.increment()` sentinels
+ * @param input - Object mapping field names to their increment amounts.
+ * @returns Firestore `UpdateData` with `FieldValue.increment()` sentinels.
  *
  * @example
  * ```ts
  * const updateData = firestoreClientIncrementUpdateToUpdateData<MyModel>({ viewCount: 1, likeCount: -1 });
  * await updateDoc(docRef, updateData);
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreClientIncrementUpdateToUpdateData<T extends object>(input: FirestoreAccessorIncrementUpdate<T>): UpdateData<T>;

package/src/lib/client/function/development.function.factory.d.ts

@@ -24,8 +24,8 @@ export type DevelopmentFirebaseFunctionMapFactory<M extends DevelopmentFirebaseF
  * Similar to {@link callModelFirebaseFunctionMapFactory}, all development functions are multiplexed
  * through a single endpoint. The function specifier and data are wrapped via {@link onCallDevelopmentParams}.
  *
- * @param configMap - maps each development function key to optional configuration
- * @returns a factory that creates a {@link DevelopmentFirebaseFunctionMap} for a given `Functions` instance
+ * @param configMap - Maps each development function key to optional configuration.
+ * @returns A factory that creates a {@link DevelopmentFirebaseFunctionMap} for a given `Functions` instance.
  *
  * @example
  * ```ts
@@ -36,6 +36,7 @@ export type DevelopmentFirebaseFunctionMapFactory<M extends DevelopmentFirebaseF
  * const devFns = factory(getFunctions());
  * await devFns.resetData();
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function developmentFirebaseFunctionMapFactory<M extends DevelopmentFirebaseFunctionTypeMap>(configMap: DevelopmentFirebaseFunctionConfigMap<M>): DevelopmentFirebaseFunctionMapFactory<M>;

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

@@ -27,8 +27,8 @@ export declare class FirebaseServerError<T extends ServerErrorResponseData = Ser
      * Creates a {@link FirebaseServerError} from a raw {@link FirebaseError}, extracting
      * structured error details from the error's `details` property if available.
      *
-     * @param error - the Firebase error from an `HttpsCallable` failure
-     * @returns a new {@link FirebaseServerError} wrapping the given Firebase error with structured server error details
+     * @param error - The Firebase error from an `HttpsCallable` failure.
+     * @returns A new {@link FirebaseServerError} wrapping the given Firebase error with structured server error details.
      */
     static fromFirebaseError(error: FirebaseError): FirebaseServerError;
     constructor(firebaseError: FirebaseError, serverError: ServerError<T>);

package/src/lib/client/function/function.callable.d.ts

@@ -47,14 +47,14 @@ export declare function mapHttpsCallable<I, O, A, B = unknown>(callable: HttpsCa
  * Unwraps an `HttpsCallable` so it returns the response data directly (`O`) instead of
  * `HttpsCallableResult<O>`. Simplifies consumption when only the data payload is needed.
  */
-export type DirectDataHttpsCallable<C extends HttpsCallable<any, any>> = C extends HttpsCallable<infer I, infer O> ? (data?: I | null) => Promise<O> : never;
+export type DirectDataHttpsCallable<C extends HttpsCallable<any, any>> = C extends HttpsCallable<infer I, infer O> ? (data?: Maybe<I>) => Promise<O> : never;
 /**
  * Wraps an `HttpsCallable` to return the data payload directly, stripping the `HttpsCallableResult` wrapper.
  *
  * Errors are converted to readable errors via {@link convertHttpsCallableErrorToReadableError}.
  *
- * @param callable - the `HttpsCallable` to wrap
- * @returns a {@link DirectDataHttpsCallable} that resolves to the response data directly
+ * @param callable - The `HttpsCallable` to wrap.
+ * @returns A {@link DirectDataHttpsCallable} that resolves to the response data directly.
  *
  * @example
  * ```ts
@@ -69,7 +69,7 @@ export declare function directDataHttpsCallable<I, O, C extends HttpsCallable<I,
  * If the error is a client-side {@link FirebaseError} with `details`, wraps it as a {@link FirebaseServerError}
  * to preserve server-side error context. Otherwise, converts it to a generic readable error via `toReadableError`.
  *
- * @param error - the caught error from an `HttpsCallable` invocation
- * @returns a {@link FirebaseServerError} if the error has structured details, or a generic readable error otherwise
+ * @param error - The caught error from an `HttpsCallable` invocation.
+ * @returns A {@link FirebaseServerError} if the error has structured details, or a generic readable error otherwise.
  */
 export declare function convertHttpsCallableErrorToReadableError(error: unknown): unknown;

package/src/lib/client/function/function.factory.d.ts

@@ -27,8 +27,8 @@ export type FirebaseFunctionMapFactory<M extends FirebaseFunctionTypeMap> = (fun
  * Each key in the config map becomes an `HttpsCallable` function wrapped with {@link directDataHttpsCallable}
  * for direct data access. Per-key options (e.g., timeout) are applied if provided.
  *
- * @param configMap - maps function keys to their optional configuration
- * @returns a {@link FirebaseFunctionMapFactory} that creates a typed callable function map for a given `Functions` instance
+ * @param configMap - Maps function keys to their optional configuration.
+ * @returns A {@link FirebaseFunctionMapFactory} that creates a typed callable function map for a given `Functions` instance.
  *
  * @example
  * ```ts
@@ -39,6 +39,7 @@ export type FirebaseFunctionMapFactory<M extends FirebaseFunctionTypeMap> = (fun
  * const functions = factory(getFunctions());
  * const result = await functions.createUser({ name: 'Alice' });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firebaseFunctionMapFactory<M extends FirebaseFunctionTypeMap>(configMap: FirebaseFunctionTypeConfigMap<M>): FirebaseFunctionMapFactory<M>;
@@ -97,8 +98,8 @@ export type LazyFirebaseFunctions<M extends FirebaseFunctionsMap> = {
  * Each function group is lazily initialized on first access using `cachedGetter`,
  * so `httpsCallable` instances are only created when actually needed.
  *
- * @param configMap - maps each function group key to its `[ClassType, Factory]` tuple
- * @returns a {@link LazyFirebaseFunctionsFactory} that creates a lazy-loaded function map for a given `Functions` instance
+ * @param configMap - Maps each function group key to its `[ClassType, Factory]` tuple.
+ * @returns A {@link LazyFirebaseFunctionsFactory} that creates a lazy-loaded function map for a given `Functions` instance.
  *
  * @example
  * ```ts
@@ -110,6 +111,7 @@ export type LazyFirebaseFunctions<M extends FirebaseFunctionsMap> = {
  * const lazyFns = factory(getFunctions());
  * const notifFns = lazyFns.notificationFunctions(); // initialized on first call
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function lazyFirebaseFunctionsFactory<M extends FirebaseFunctionsMap, C extends FirebaseFunctionsConfigMap<M> = FirebaseFunctionsConfigMap<M>>(configMap: C): LazyFirebaseFunctionsFactory<M>;

package/src/lib/client/function/model.function.factory.d.ts

@@ -1,6 +1,6 @@
 import { type MaybeNot, type ValuesTypesAsArray, type CommaSeparatedKeysOfObject } from '@dereekb/util';
 import { type Functions } from 'firebase/functions';
-import { type NonNever } from 'ts-essentials';
+import { type OmitNeverProperties } from 'ts-essentials';
 import { type FirestoreModelIdentity, type FirestoreModelTypes } from '../../common/firestore/collection';
 import { type FirebaseFunctionTypeMap, type FirebaseFunctionMap, type FirebaseFunction } from './function';
 import { type FirebaseFunctionTypeConfigMap } from './function.factory';
@@ -86,8 +86,8 @@ export type ModelFirebaseCrudFunctionQueryTypeConfig = {
  * Default specifier string (`'_'`) used when a CRUD operation has specifiers but one
  * should map to the base function name without a specifier suffix.
  */
-export declare const MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER_DEFAULT = "_";
-export type ModelFirebaseCrudFunctionSpecifierDefault = typeof MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER_DEFAULT;
+export declare const DEFAULT_MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER = "_";
+export type ModelFirebaseCrudFunctionSpecifierDefault = typeof DEFAULT_MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER;
 /**
  * Separator character (`','`) used to split multiple specifier keys in a config string.
  * For example, `'update:status,config'` defines two update specifiers: `status` and `config`.
@@ -100,7 +100,7 @@ export type ModelFirebaseCrudFunctionSpecifierSplitter = typeof MODEL_FUNCTION_F
  * The {@link FirestoreModelIdentity} type parameter `T` constrains which model type keys are
  * valid, providing compile-time safety. Entries are string arrays like `['create', 'update:status,config']`.
  */
-export type ModelFirebaseCrudFunctionConfigMap<C extends ModelFirebaseCrudFunctionTypeMap<T>, T extends FirestoreModelIdentity> = NonNever<{
+export type ModelFirebaseCrudFunctionConfigMap<C extends ModelFirebaseCrudFunctionTypeMap<T>, T extends FirestoreModelIdentity> = OmitNeverProperties<{
     [K in FirestoreModelTypes<T>]: C[K] extends null ? never : ModelFirebaseCrudFunctionConfigMapEntry<C[K]>;
 }>;
 export type ModelFirebaseCrudFunctionConfigMapEntry<T> = ValuesTypesAsArray<{
@@ -108,7 +108,7 @@ export type ModelFirebaseCrudFunctionConfigMapEntry<T> = ValuesTypesAsArray<{
 }>;
 export type ModelFirebaseCrudFunctionConfigMapEntrySpecifier<K extends string, M extends object> = `${K}:${CommaSeparatedKeysOfObject<M>}`;
 export type ModelFirebaseCrudFunctionMap<C extends ModelFirebaseCrudFunctionTypeMap> = ModelFirebaseCrudFunctionRawMap<C>;
-export type ModelFirebaseCrudFunctionRawMap<C extends ModelFirebaseCrudFunctionTypeMap> = NonNever<{
+export type ModelFirebaseCrudFunctionRawMap<C extends ModelFirebaseCrudFunctionTypeMap> = OmitNeverProperties<{
     [K in keyof C]: K extends string ? ModelFirebaseCrudFunctionMapEntry<K, C[K]> : never;
 }>;
 export type ModelFirebaseCrudFunctionName<MODEL extends string, CRUD extends string> = `${CRUD}${Capitalize<MODEL>}`;
@@ -145,9 +145,9 @@ export type ModelFirebaseFunctionMapFactory<M extends FirebaseFunctionTypeMap, U
  *
  * Custom (non-CRUD) functions from `configMap` get their own individual `HttpsCallable` instances.
  *
- * @param configMap - configuration for custom (non-CRUD) functions
- * @param crudConfigMap - configuration for model CRUD functions with optional specifiers
- * @returns a {@link ModelFirebaseFunctionMapFactory} that creates a combined custom and CRUD function map for a given `Functions` instance
+ * @param configMap - Configuration for custom (non-CRUD) functions.
+ * @param crudConfigMap - Configuration for model CRUD functions with optional specifiers.
+ * @returns A {@link ModelFirebaseFunctionMapFactory} that creates a combined custom and CRUD function map for a given `Functions` instance.
  *
  * @example
  * ```ts
@@ -159,6 +159,7 @@ export type ModelFirebaseFunctionMapFactory<M extends FirebaseFunctionTypeMap, U
  * await fns.createNotification(data);
  * await fns.updateNotificationStatus(data);
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function callModelFirebaseFunctionMapFactory<M extends FirebaseFunctionTypeMap, U extends ModelFirebaseCrudFunctionTypeMap>(configMap: FirebaseFunctionTypeConfigMap<M>, crudConfigMap: ModelFirebaseCrudFunctionConfigMap<U, FirestoreModelIdentity>): ModelFirebaseFunctionMapFactory<M, U>;

package/src/lib/client/storage/driver.accessor.d.ts

@@ -8,8 +8,8 @@ import { type ErrorInput, type Maybe } from '@dereekb/util';
  * Useful for distinguishing missing-file errors from other storage failures,
  * e.g., to silently handle deletion of already-deleted files.
  *
- * @param input - the error or error message to check
- * @returns `true` if the error message contains `'storage/object-not-found'`, `false` otherwise
+ * @param input - The error or error message to check.
+ * @returns `true` if the error message contains `'storage/object-not-found'`, `false` otherwise.
  *
  * @example
  * ```ts
@@ -26,9 +26,9 @@ export declare function isFirebaseStorageObjectNotFoundError(input: Maybe<ErrorI
 /**
  * Creates a `StorageReference` from an abstract {@link StoragePath} using the client `firebase/storage` SDK.
  *
- * @param storage - the client Firebase Storage instance
- * @param path - abstract storage path to resolve
- * @returns a `StorageReference` pointing to the resolved storage path
+ * @param storage - The client Firebase Storage instance.
+ * @param path - Abstract storage path to resolve.
+ * @returns A `StorageReference` pointing to the resolved storage path.
  */
 export declare function firebaseStorageRefForStorageFilePath(storage: ClientFirebaseStorage, path: StoragePath): StorageReference;
 /**
@@ -36,8 +36,8 @@ export declare function firebaseStorageRefForStorageFilePath(storage: ClientFire
  *
  * Returns `true` if metadata is successfully retrieved, `false` for any error (including permission errors).
  *
- * @param ref - the storage reference to check
- * @returns a promise that resolves to `true` if the file exists, `false` otherwise
+ * @param ref - Storage reference whose metadata is probed.
+ * @returns Resolves with `true` when metadata exists, otherwise `false`.
  */
 export declare function firebaseStorageFileExists(ref: StorageReference): Promise<boolean>;
 /**
@@ -50,9 +50,9 @@ export type FirebaseStorageClientAccessorFile = FirebaseStorageAccessorFile<Stor
  * Provides all file operations (upload, download, metadata, delete, resumable upload) backed by
  * the `firebase/storage` SDK. Resumable uploads expose an Observable stream of upload progress snapshots.
  *
- * @param storage - the client Firebase Storage instance
- * @param storagePath - the abstract storage path for the file
- * @returns a {@link FirebaseStorageClientAccessorFile} providing CRUD and upload operations for the given path
+ * @param storage - The client Firebase Storage instance.
+ * @param storagePath - The abstract storage path for the file.
+ * @returns A {@link FirebaseStorageClientAccessorFile} providing CRUD and upload operations for the given path.
  *
  * @example
  * ```ts
@@ -87,9 +87,9 @@ export declare const firebaseStorageClientListFilesResultFactory: import("../.."
  * Supports existence checks, paginated file/folder listing, and recursive nested listing
  * when `includeNestedResults` is enabled.
  *
- * @param storage - the client Firebase Storage instance
- * @param storagePath - the abstract storage path for the folder
- * @returns a {@link FirebaseStorageClientAccessorFolder} providing listing and existence operations for the given path
+ * @param storage - The client Firebase Storage instance.
+ * @param storagePath - The abstract storage path for the folder.
+ * @returns A {@link FirebaseStorageClientAccessorFolder} providing listing and existence operations for the given path.
  *
  * @example
  * ```ts
@@ -106,7 +106,7 @@ export declare function firebaseStorageClientAccessorFolder(storage: ClientFireb
  * Provides file and folder accessor factories and default bucket resolution.
  * Used internally by {@link firebaseStorageClientDrivers}.
  *
- * @returns a {@link FirebaseStorageAccessorDriver} backed by the `firebase/storage` client SDK
+ * @returns A {@link FirebaseStorageAccessorDriver} backed by the `firebase/storage` client SDK.
  *
  * @example
  * ```ts

package/src/lib/client/storage/driver.d.ts

@@ -9,7 +9,7 @@ export type FirebaseStorageClientDrivers = FirebaseStorageDrivers;
  *
  * Provides file and folder accessor operations for use with {@link clientFirebaseStorageContextFactory}.
  *
- * @returns the client-side {@link FirebaseStorageClientDrivers} for the `firebase/storage` SDK
+ * @returns The client-side {@link FirebaseStorageClientDrivers} for the `firebase/storage` SDK.
  *
  * @example
  * ```ts

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

@@ -61,8 +61,8 @@ export declare const FIREBASE_AUTH_QUOTA_EXCEEDED_ERROR = "auth/quota-exceeded";
  * Maps known error codes (wrong password, user not found, network errors) to contextual messages
  * suitable for display in the UI.
  *
- * @param inputError - the Firebase Auth error to convert
- * @returns a {@link ReadableError} with a human-readable message suitable for display
+ * @param inputError - The Firebase Auth error to convert.
+ * @returns A {@link ReadableError} with a human-readable message suitable for display.
  *
  * @example
  * ```ts

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

@@ -21,15 +21,15 @@ export type DevelopmentFirebaseFunctionSpecifierRef = {
  * Routes the call to a specific function via `specifier` and passes arbitrary data.
  */
 export interface OnCallDevelopmentParams<T = unknown> {
-    specifier: string;
-    data: T;
+    readonly specifier: string;
+    readonly data: T;
 }
 /**
  * Creates an {@link OnCallDevelopmentParams} envelope for a development function call.
  *
- * @param specifier - the development function to invoke
- * @param data - the call payload
- * @returns an {@link OnCallDevelopmentParams} envelope ready to send to the dev endpoint
+ * @param specifier - The development function to invoke.
+ * @param data - The call payload.
+ * @returns An {@link OnCallDevelopmentParams} envelope ready to send to the dev endpoint.
  *
  * @example
  * ```ts

package/src/lib/common/firestore/accessor/accessor.d.ts

@@ -84,7 +84,7 @@ export interface FirestoreDocumentDataAccessor<T, D = DocumentData> extends Docu
      * @param converter
      */
     getWithConverter(converter: null): Promise<DocumentSnapshot<DocumentData>>;
-    getWithConverter<U = DocumentData>(converter: null | FirestoreDataConverter<U>): Promise<DocumentSnapshot<U>>;
+    getWithConverter<U = DocumentData>(converter: Maybe<FirestoreDataConverter<U>>): Promise<DocumentSnapshot<U>>;
     /**
      * Whether or not the target object currently exists.
      */
@@ -178,20 +178,22 @@ export declare enum FirestoreAccessorStreamMode {
 /**
  * Creates an Observable that emits the document data from snapshots based on the specified stream mode.
  *
+ * @param accessor - The document accessor to retrieve snapshots from.
+ * @param mode - Whether to use a one-time GET or continuous STREAM mode.
+ * @param options - Options for how to format the document data.
+ * @returns An Observable that emits the document data or undefined if the document doesn't exist.
+ *
  * @template T - The document data type
- * @param accessor - The document accessor to retrieve snapshots from
- * @param mode - Whether to use a one-time GET or continuous STREAM mode
- * @param options - Options for how to format the document data
- * @returns An Observable that emits the document data or undefined if the document doesn't exist
  */
 export declare function snapshotStreamDataForAccessor<T>(accessor: FirestoreDocumentDataAccessor<T>, mode: FirestoreAccessorStreamMode, options?: SnapshotOptions): Observable<Maybe<T>>;
 /**
  * Creates an Observable that emits DocumentSnapshots based on the specified stream mode.
  *
+ * @param accessor - The document accessor to retrieve snapshots from.
+ * @param mode - Whether to use a one-time GET or continuous STREAM mode.
+ * @returns An Observable that emits DocumentSnapshots.
+ *
  * @template T - The document data type
- * @param accessor - The document accessor to retrieve snapshots from
- * @param mode - Whether to use a one-time GET or continuous STREAM mode
- * @returns An Observable that emits DocumentSnapshots
  */
 export declare function snapshotStreamForAccessor<T>(accessor: FirestoreDocumentDataAccessor<T>, mode: FirestoreAccessorStreamMode): Observable<DocumentSnapshot<T>>;
 /**
@@ -199,18 +201,20 @@ export declare function snapshotStreamForAccessor<T>(accessor: FirestoreDocument
  *
  * Filters out null/undefined values from the stream (documents that don't exist).
  *
+ * @param stream - Observable that emits DocumentSnapshots.
+ * @param options - Options for how to format the document data.
+ * @returns An Observable that emits document data, filtering out non-existent documents.
+ *
  * @template T - The document data type
- * @param stream - Observable that emits DocumentSnapshots
- * @param options - Options for how to format the document data
- * @returns An Observable that emits document data, filtering out non-existent documents
  */
 export declare function dataFromSnapshotStream<T>(stream: Observable<DocumentSnapshot<T>>, options?: SnapshotOptions): Observable<T>;
 /**
  * Creates an RxJS operator that transforms DocumentSnapshots into their data.
  *
- * @template T - The document data type
- * @param options - Options for how to format the document data
+ * @param options - Options for how to format the document data.
  * @returns An operator that transforms DocumentSnapshots into document data (or undefined if the document doesn't exist)
+ *
+ * @template T - The document data type
  */
 export declare function mapDataFromSnapshot<T>(options?: SnapshotOptions): OperatorFunction<DocumentSnapshot<T>, Maybe<T>>;
 /**
@@ -238,10 +242,12 @@ export type UpdateWithAccessorUpdateAndConverterFunction<T> = (data: Partial<T>,
  * - Skips the update if the resulting data is empty
  * - Applies any provided preconditions to the update
  *
+ * @param accessor - Accessor used to apply the underlying update.
+ * @param converter - Converter that normalizes input data into Firestore format.
+ * @returns Update function that converts then writes the partial data.
+ *
  * @template T - The document data type
- * @param accessor - The document accessor to use for updates
- * @param converter - The data converter to transform input data to Firestore format
- * @returns A function that updates the document with converted data
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function updateWithAccessorUpdateAndConverterFunction<T>(accessor: FirestoreDocumentDataAccessor<T>, converter: FirestoreDataConverter<T>): UpdateWithAccessorUpdateAndConverterFunction<T>;