@dereekb/firebase-server 13.11.14 → 13.11.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase-server",
-  "version": "13.11.14",
+  "version": "13.11.16",
   "sideEffects": false,
   "exports": {
     "./test": {
@@ -44,15 +44,15 @@
   "main": "./index.cjs.js",
   "types": "./src/index.d.ts",
   "peerDependencies": {
-    "@dereekb/analytics": "13.11.14",
-    "@dereekb/date": "13.11.14",
-    "@dereekb/dbx-core": "13.11.14",
-    "@dereekb/firebase": "13.11.14",
-    "@dereekb/model": "13.11.14",
-    "@dereekb/nestjs": "13.11.14",
-    "@dereekb/rxjs": "13.11.14",
-    "@dereekb/util": "13.11.14",
-    "@dereekb/zoho": "13.11.14",
+    "@dereekb/analytics": "13.11.16",
+    "@dereekb/date": "13.11.16",
+    "@dereekb/dbx-core": "13.11.16",
+    "@dereekb/firebase": "13.11.16",
+    "@dereekb/model": "13.11.16",
+    "@dereekb/nestjs": "13.11.16",
+    "@dereekb/rxjs": "13.11.16",
+    "@dereekb/util": "13.11.16",
+    "@dereekb/zoho": "13.11.16",
     "@google-cloud/firestore": "^7.11.6",
     "@google-cloud/storage": "^7.19.0",
     "@nestjs/common": "^11.1.19",

package/src/lib/auth/auth.service.d.ts

@@ -56,13 +56,13 @@ export interface FirebaseServerAuthUserContext extends FirebaseServerAuthUserIde
     /**
      * Loads the full Firebase Auth {@link admin.auth.UserRecord} for this user.
      *
-     * @throws Throws if the user does not exist.
+     * @throws {Error} Throws if the user does not exist.
      */
     loadRecord(): Promise<admin.auth.UserRecord>;
     /**
      * Loads a normalized {@link FirebaseAuthDetails} snapshot of the user's auth profile.
      *
-     * @throws Throws if the user does not exist.
+     * @throws {Error} Throws if the user does not exist.
      */
     loadDetails(): Promise<FirebaseAuthDetails>;
     /**
@@ -124,7 +124,7 @@ export interface FirebaseServerAuthUserContext extends FirebaseServerAuthUserIde
     /**
      * Loads the user's raw custom claims object from their Firebase Auth record.
      *
-     * @throws Throws if the user does not exist.
+     * @throws {Error} Throws if the user does not exist.
      */
     loadClaims<T extends AuthClaimsObject = AuthClaimsObject>(): Promise<AuthClaims<T>>;
     /**
@@ -218,7 +218,7 @@ export declare abstract class AbstractFirebaseServerAuthUserContext<S extends Fi
     loadClaims<T extends AuthClaimsObject = AuthClaimsObject>(): Promise<AuthClaims<T>>;
     updateClaims<T extends AuthClaimsObject = AuthClaimsObject>(claims: AuthClaimsUpdate<T>): Promise<void>;
     clearClaims(): Promise<void>;
-    setClaims<T extends AuthClaimsObject = AuthClaimsObject>(claims: AuthClaimsUpdate<T> | null): Promise<void>;
+    setClaims<T extends AuthClaimsObject = AuthClaimsObject>(claims: Maybe<AuthClaimsUpdate<T>>): Promise<void>;
 }
 /**
  * Read-only auth context derived from a Firebase callable function request.
@@ -436,7 +436,7 @@ export interface FirebaseServerNewUserService<D = unknown, U extends FirebaseSer
      * when explicitly requested via the input flags.
      *
      * @param input - Configuration for the new user and setup content delivery.
-     * @throws Throws if neither email, phone, nor uid is provided.
+     * @throws {Error} Throws if neither email, phone, nor uid is provided.
      */
     initializeNewUser(input: FirebaseServerAuthInitializeNewUser<D>): Promise<admin.auth.UserRecord>;
     /**
@@ -556,7 +556,7 @@ export declare abstract class AbstractFirebaseServerNewUserService<U extends Fir
      *
      * @param input - The initialization configuration for the new user.
      * @returns The created user record and the setup password used.
-     * @throws Throws if the Firebase Admin SDK rejects the user creation.
+     * @throws {Error} Throws if the Firebase Admin SDK rejects the user creation.
      */
     protected createNewUser(input: FirebaseServerAuthInitializeNewUser<D>): Promise<FirebaseServerAuthCreateNewUserResult>;
     protected generateRandomSetupPassword(): FirebaseAuthSetupPassword;
@@ -707,7 +707,7 @@ export interface FirebaseServerUserPasswordResetService<D = unknown, U extends F
      * may throw the same errors (throttle, send-once, no-config) depending on the configuration.
      *
      * @param input - Configuration for the reset, including user identification and send options.
-     * @throws Throws if neither uid nor email is provided.
+     * @throws {Error} Throws if neither uid nor email is provided.
      * @throws {FirebaseServerAuthPasswordResetThrottleError} When send is throttled and `sendResetThrowErrors` is true.
      * @throws {FirebaseServerAuthPasswordResetSendOnceError} When already sent and `sendResetDetailsOnce` + `sendResetThrowErrors` are true.
      * @throws {FirebaseServerAuthPasswordResetNoResetConfigError} When no reset claims exist and `sendResetThrowErrors` is true.
@@ -848,7 +848,7 @@ export declare abstract class FirebaseServerAuthService<U extends FirebaseServer
      * Asserts that the request contains valid auth data (a UID is present).
      *
      * @param context - The callable function context from a Firebase function invocation.
-     * @throws Throws if the context does not contain authenticated user data.
+     * @throws {Error} Throws if the context does not contain authenticated user data.
      */
     abstract context(context: CallableContext): C;
     /**

package/src/lib/auth/auth.util.d.ts

@@ -6,7 +6,7 @@ import type * as admin from 'firebase-admin';
  *
  * Any error other than {@link FIREBASE_AUTH_USER_NOT_FOUND_ERROR} is re-thrown.
  *
- * @param promise - A promise resolving to a UserRecord (e.g., from `auth.getUser(uid)`).
+ * @param promise - Promise resolving to a UserRecord (e.g., from `auth.getUser(uid)`).
  * @returns The user record, or `undefined` if the user does not exist.
  *
  * @example

package/src/lib/env/env.config.d.ts

@@ -50,14 +50,15 @@ export declare function firebaseServerEnvTokenProvider<T extends FirebaseServerE
  * Use this when the NestJS app needs the config accessible via either token.
  *
  * @param env - The Firebase server environment configuration.
- * @returns An array of providers binding the config to both Firebase and base server env tokens.
+ * @returns The providers binding the config to both Firebase and base server env tokens.
  *
- * @example
- * ```typescript
- * @Module({
+ * @Module ({
  *   providers: [...firebaseServerEnvTokenProviders(myEnvConfig)]
  * })
  * export class AppModule {}
  * ```
+ *
+ * @example
+ * ```typescript
  */
 export declare function firebaseServerEnvTokenProviders<T extends FirebaseServerEnvironmentConfig = FirebaseServerEnvironmentConfig>(env: T): Provider[];

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

@@ -1,4 +1,5 @@
 import { type DocumentReference, type WriteBatch as GoogleCloudWriteBatch, type DocumentSnapshot } from '@google-cloud/firestore';
+import type { Maybe } from '@dereekb/util';
 import { type Observable } from 'rxjs';
 import { type WithFieldValue, type FirestoreDocumentContext, FirestoreDocumentContextType, type FirestoreDocumentDataAccessor, type FirestoreDocumentDataAccessorFactory, type FirestoreDocumentDeleteParams, type FirestoreDocumentUpdateParams, type UpdateData, type DocumentData, type FirestoreDataConverter, type FirestoreAccessorIncrementUpdate, type FirestoreAccessorArrayUpdate } from '@dereekb/firebase';
 /**
@@ -17,7 +18,7 @@ export declare class WriteBatchFirestoreDocumentDataAccessor<T> implements Fires
     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(params?: FirestoreDocumentDeleteParams): Promise<void>;
     set(data: WithFieldValue<T>): Promise<void>;
     increment(data: FirestoreAccessorIncrementUpdate<T>, params?: FirestoreDocumentUpdateParams): Promise<void>;

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

@@ -14,7 +14,7 @@ interface CollectionRefForPathInput {
  * @param path - The initial collection path.
  * @param pathSegments - Optional pairs of [docId, collectionName] for subcollection traversal.
  * @returns The resolved {@link CollectionReference} at the given path.
- * @throws Error if pathSegments length is odd (segments must come in pairs).
+ * @throws {Error} If pathSegments length is odd (segments must come in pairs).
  *
  * @example
  * ```typescript

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

@@ -1,4 +1,5 @@
 import { type DocumentReference, type WriteResult as GoogleCloudWriteResult, type DocumentSnapshot } from '@google-cloud/firestore';
+import type { Maybe } from '@dereekb/util';
 import { type Observable } from 'rxjs';
 import { type WithFieldValue, type UpdateData, type FirestoreDocumentContext, type FirestoreDocumentDataAccessor, type FirestoreDocumentDataAccessorFactory, type FirestoreDocumentDeleteParams, type FirestoreDocumentUpdateParams, type SetOptions, type FirestoreDataConverter, type DocumentData, type FirestoreAccessorIncrementUpdate, type FirestoreAccessorArrayUpdate } from '@dereekb/firebase';
 /**
@@ -15,7 +16,7 @@ export declare class DefaultFirestoreDocumentDataAccessor<T> implements Firestor
     create(data: T): Promise<GoogleCloudWriteResult>;
     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(params?: FirestoreDocumentDeleteParams): Promise<GoogleCloudWriteResult>;
     set(data: WithFieldValue<T>, options?: SetOptions): Promise<GoogleCloudWriteResult>;
     increment(data: FirestoreAccessorIncrementUpdate<T>, params?: FirestoreDocumentUpdateParams): Promise<GoogleCloudWriteResult>;

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

@@ -1,4 +1,5 @@
 import { type DocumentReference, type DocumentSnapshot, type Transaction as GoogleCloudTransaction, type SetOptions } from '@google-cloud/firestore';
+import type { Maybe } from '@dereekb/util';
 import { type Observable } from 'rxjs';
 import { type WithFieldValue, type UpdateData, type FirestoreDocumentDataAccessor, type FirestoreDocumentDataAccessorFactory, type FirestoreDocumentContext, FirestoreDocumentContextType, type FirestoreDocumentUpdateParams, type FirestoreDataConverter, type DocumentData, type FirestoreAccessorIncrementUpdate, type FirestoreAccessorArrayUpdate } from '@dereekb/firebase';
 /**
@@ -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 = 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>, params?: FirestoreDocumentUpdateParams): Promise<void>;

package/src/lib/firestore/snapshot/snapshot.field.encrypt.d.ts

@@ -33,6 +33,11 @@ export interface OptionalFirestoreEncryptedFieldConfig<T> {
  * The encryption key is resolved from the configured secret source on each read/write,
  * allowing for key rotation via environment variable changes.
  *
+ * @param config - Encryption field configuration.
+ * @returns A field mapping configuration for encrypted values.
+ *
+ * @template T - The JSON-serializable value type.
+ *
  * @example
  * ```typescript
  * const jwksField = firestoreEncryptedField<JWKSet>({
@@ -41,9 +46,6 @@ export interface OptionalFirestoreEncryptedFieldConfig<T> {
  * });
  * ```
  *
- * @template T - The JSON-serializable value type.
- * @param config - Encryption field configuration.
- * @returns A field mapping configuration for encrypted values.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreEncryptedField<T>(config: FirestoreEncryptedFieldConfig<T>): FirestoreModelFieldMapFunctionsConfig<T, string>;
@@ -53,6 +55,11 @@ export declare function firestoreEncryptedField<T>(config: FirestoreEncryptedFie
  * When the value is null/undefined, it is stored/read as null. When present, it is
  * encrypted/decrypted using AES-256-GCM.
  *
+ * @param config - Encryption field configuration.
+ * @returns A field mapping configuration for optional encrypted values.
+ *
+ * @template T - The JSON-serializable value type.
+ *
  * @example
  * ```typescript
  * const optionalSecretField = optionalFirestoreEncryptedField<OAuthClientSecret>({
@@ -60,9 +67,6 @@ export declare function firestoreEncryptedField<T>(config: FirestoreEncryptedFie
  * });
  * ```
  *
- * @template T - The JSON-serializable value type.
- * @param config - Encryption field configuration.
- * @returns A field mapping configuration for optional encrypted values.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function optionalFirestoreEncryptedField<T>(config: OptionalFirestoreEncryptedFieldConfig<T>): FirestoreModelFieldMapFunctionsConfig<Maybe<T>, Maybe<string>>;

package/src/lib/function/type.d.ts

@@ -1,6 +1,10 @@
 import { type PromiseOrValue } from '@dereekb/util';
 import { type Runnable, type HttpsFunction } from 'firebase-functions/v1';
 import { type CallableFunction } from 'firebase-functions/v2/https';
+/**
+ * Firebase Functions V2 - CallableFunction with output as an optional type.
+ */
+export type CallableHttpFunction<I, O = unknown> = CallableFunction<I, PromiseOrValue<O>>;
 /**
  * Firebase Functions V1 - Union of firebase-functions HttpsFunction and Runnable.
  *
@@ -9,7 +13,3 @@ import { type CallableFunction } from 'firebase-functions/v2/https';
  * @see CallableHttpFunction
  */
 export type RunnableHttpFunction<I> = HttpsFunction & Runnable<I>;
-/**
- * Firebase Functions V2 - CallableFunction with output as an optional type.
- */
-export type CallableHttpFunction<I, O = unknown> = CallableFunction<I, PromiseOrValue<O>>;

package/src/lib/nest/analytics/analytics.module.d.ts

@@ -24,15 +24,16 @@ export interface ProvideAppAnalyticsMetadataConfig extends Pick<ModuleMetadata,
  * Provides {@link FirebaseServerAnalyticsService} and registers it as the
  * {@link ON_CALL_MODEL_ANALYTICS_SERVICE} token for the onCall dispatch chain.
  *
- * @param config - the configuration including an optional dependency module and additional providers
- * @returns module metadata ready for use with `@Module()`
+ * @param config - The configuration including an optional dependency module and additional providers.
+ * @returns Module metadata ready for use with `@Module()`
  *
- * @example
- * ```ts
- * @Module(appAnalyticsModuleMetadata({
+ * @Module (appAnalyticsModuleMetadata({
  *   dependencyModule: FirebaseServerAnalyticsSegmentModule
  * }))
  * export class AppAnalyticsModule {}
  * ```
+ *
+ * @example
+ * ```ts
  */
 export declare function appAnalyticsModuleMetadata(config: ProvideAppAnalyticsMetadataConfig): ModuleMetadata;

package/src/lib/nest/app.d.ts

@@ -73,10 +73,6 @@ export interface NestServerInstanceConfig<T> extends Omit<NestServerRootModuleCo
 export interface NestFirebaseServerEnvironmentConfig {
     readonly environment: FirebaseServerEnvironmentConfig;
 }
-/**
- * @deprecated Use NestFirebaseServerEnvironmentConfig instead.
- */
-export type NestServerEnvironmentConfig = NestFirebaseServerEnvironmentConfig;
 /**
  * Creates a {@link NestServerInstance} that manages NestJS server lifecycle within Firebase Cloud Functions.
  *
@@ -94,3 +90,7 @@ export type NestServerEnvironmentConfig = NestFirebaseServerEnvironmentConfig;
  * ```
  */
 export declare function nestServerInstance<T>(config: NestServerInstanceConfig<T>): NestServerInstance<T>;
+/**
+ * @deprecated Use NestFirebaseServerEnvironmentConfig instead.
+ */
+export type NestServerEnvironmentConfig = NestFirebaseServerEnvironmentConfig;

package/src/lib/nest/app.module.d.ts

@@ -119,8 +119,9 @@ export interface NestServerRootModuleResult {
  * - `GlobalRoutePrefixConfig` token
  * - Optional webhook and AppCheck middleware modules
  *
- * @param config - Shared configuration
- * @returns The root module and resolved prefix config
+ * @param config - Shared configuration.
+ * @returns The root module and resolved prefix config.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function buildNestServerRootModule(config: NestServerRootModuleConfig): NestServerRootModuleResult;

package/src/lib/nest/auth/auth.module.d.ts

@@ -51,12 +51,13 @@ export interface FirebaseServerAuthModuleMetadataConfig<T extends FirebaseServer
  * @param config - The module metadata configuration including the service provider.
  * @returns The merged NestJS module metadata.
  *
- * @example
- * ```typescript
- * @Module(firebaseServerAuthModuleMetadata({
+ * @Module (firebaseServerAuthModuleMetadata({
  *   serviceProvider: { provide: MyAuthService, useFactory: (auth) => new MyAuthService(auth) }
  * }))
  * export class AppAuthModule {}
  * ```
+ *
+ * @example
+ * ```typescript
  */
 export declare function firebaseServerAuthModuleMetadata<T extends FirebaseServerAuthService>(config: FirebaseServerAuthModuleMetadataConfig<T>): ModuleMetadata;

package/src/lib/nest/controller/model/model.api.controller.d.ts

@@ -85,6 +85,7 @@ export declare class ModelApiController {
      *
      * @param req - The Express request containing wildcard path params.
      * @returns Parsed path components with modelType, call, and specifier (defaults to '_').
+     * @throws {HttpException} `400 BAD_REQUEST` when `modelType` or `call` is missing from the path.
      */
     private _parsePath;
     private _dispatch;

package/src/lib/nest/controller/model/model.api.get.service.d.ts

@@ -46,7 +46,7 @@ export declare class ModelApiGetService {
      * @param key - The full Firestore model key (e.g., 'pr/abc123').
      * @param auth - The authenticated user's auth data from the request.
      * @returns The document key and data.
-     * @throws Permission or not-found errors from useModel.
+     * @throws {Error} Permission or not-found errors from useModel.
      */
     readDocument(modelType: FirestoreModelType, key: FirestoreModelKey, auth: Maybe<FirebaseServerAuthData>): Promise<ModelAccessReadResult>;
     /**

package/src/lib/nest/controller/model/model.api.module.d.ts

@@ -21,12 +21,13 @@ export interface ModelApiModuleMetadataConfig extends Pick<ModuleMetadata, 'impo
  * @param metadataConfig - Configuration including the dependency module.
  * @returns NestJS module metadata with the Model API controller, dispatch service, and app context provider.
  *
- * @example
- * ```typescript
- * @Module(modelApiModuleMetadata({
+ * @Module (modelApiModuleMetadata({
  *   dependencyModule: DemoModelApiDependencyModule
  * }))
  * export class DemoModelApiModule {}
  * ```
+ *
+ * @example
+ * ```typescript
  */
 export declare function modelApiModuleMetadata(metadataConfig: ModelApiModuleMetadataConfig): ModuleMetadata;

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

@@ -59,7 +59,7 @@ export declare function onCallDevelopmentFunction<N>(map: OnCallDevelopmentFunct
 /**
  * Creates a bad-request error indicating the provided development function specifier is not recognized.
  *
- * @param specifier - the unrecognized specifier string from the client request.
+ * @param specifier - The unrecognized specifier string from the client request.
  * @returns A bad-request error with the unknown specifier details.
  */
 export declare function developmentUnknownSpecifierError(specifier: DevelopmentFirebaseFunctionSpecifier): import("firebase-functions/https").HttpsError;

package/src/lib/nest/development/development.schedule.function.error.d.ts

@@ -18,7 +18,7 @@ export declare const UNKNOWN_SCHEDULED_FUNCTION_DEVELOPMENT_FUNCTION_NAME_CODE =
  * Creates a bad-request error for when the requested scheduled function name
  * is not found in the registered function map.
  *
- * @param name - the unrecognized function name from the client request.
+ * @param name - The unrecognized function name from the client request.
  * @returns A bad-request error with the unknown function name details.
  */
 export declare function unknownScheduledFunctionDevelopmentFunctionName(name: unknown): import("firebase-functions/https").HttpsError;
@@ -30,7 +30,7 @@ export declare const UNKNOWN_SCHEDULED_FUNCTION_DEVELOPMENT_FUNCTION_TYPE_CODE =
  * Creates a bad-request error for when the request `type` field does not match
  * any supported operation ('run' or 'list').
  *
- * @param type - the unrecognized type value from the client request.
+ * @param type - The unrecognized type value from the client request.
  * @returns A bad-request error with the unknown type details.
  */
 export declare function unknownScheduledFunctionDevelopmentFunctionType(type: unknown): import("firebase-functions/https").HttpsError;

package/src/lib/nest/env/env.util.d.ts

@@ -5,7 +5,7 @@ import { type NestAppPromiseGetter } from '../app';
  *
  * Useful for conditionally enabling production-only Cloud Functions (e.g., scheduled tasks).
  *
- * @param nest - getter for the NestJS application context promise.
+ * @param nest - Getter for the NestJS application context promise.
  * @returns An async decision function that resolves to `true` in production.
  *
  * @example
@@ -20,7 +20,7 @@ export declare function nestAppIsProductionEnvironment(nest: NestAppPromiseGette
  *
  * The development scheduler is enabled in non-production, non-testing environments.
  *
- * @param nest - getter for the NestJS application context promise.
+ * @param nest - Getter for the NestJS application context promise.
  * @returns An async decision function that resolves to `true` when the development scheduler is enabled.
  */
 export declare function nestAppHasDevelopmentSchedulerEnabled(nest: NestAppPromiseGetter): AsyncDecisionFunction<void>;

package/src/lib/nest/firestore/firestore.module.d.ts

@@ -39,16 +39,17 @@ export interface FirebaseServerFirestoreContextModuleConfig {
  *
  * If caching is not needed, use {@link FirebaseServerFirestoreContextModule} directly instead.
  *
- * @param config - Configuration including the cache factory
- * @returns Module metadata ready for the `@Module()` decorator
+ * @param config - Configuration including the cache factory.
+ * @returns Module metadata ready for the `@Module()` decorator.
  *
- * @example
- * ```typescript
- * @Module(firebaseServerFirestoreContextModuleMetadata({
+ * @Module (firebaseServerFirestoreContextModuleMetadata({
  *   firestoreContextCacheFactory: inMemoryFirestoreContextCacheFactory()
  * }))
  * export class AppFirestoreContextModule {}
  * ```
+ *
+ * @example
+ * ```typescript
  */
 export declare function firebaseServerFirestoreContextModuleMetadata(config: FirebaseServerFirestoreContextModuleConfig): ModuleMetadata;
 /**
@@ -59,8 +60,8 @@ export type ProvideAppFirestoreCollectionsFactory<T> = (context: FirestoreContex
  * Configuration for providing an app's Firestore collections class via NestJS DI.
  */
 export interface ProvideAppFirestoreCollectionsConfig<T> {
-    provide: ClassLikeType<T>;
-    useFactory: ProvideAppFirestoreCollectionsFactory<T>;
+    readonly provide: ClassLikeType<T>;
+    readonly useFactory: ProvideAppFirestoreCollectionsFactory<T>;
 }
 /**
  * Creates a NestJS provider that initializes a Firestore collections instance from the app's {@link FirestoreContext}.
@@ -93,24 +94,24 @@ export interface ProvideAppFirestoreModuleMetadataConfig<T> extends ProvideAppFi
  * @param config - The Firestore collections config plus optional additional module metadata.
  * @returns NestJS module metadata ready to be passed to the `@Module()` decorator.
  *
- * @example
- * ```typescript
- * @Module(appFirestoreModuleMetadata({
+ * @Module (appFirestoreModuleMetadata({
  *   provide: DemoFirestoreCollections,
  *   useFactory: (context) => new DemoFirestoreCollections(context)
  * }))
  * export class AppFirestoreModule {}
  * ```
- *
- * @example
- * ```typescript
- * // With caching
- * @Module(appFirestoreModuleMetadata({
+ * @Module (appFirestoreModuleMetadata({
  *   provide: DemoFirestoreCollections,
  *   useFactory: (context) => new DemoFirestoreCollections(context),
  *   firestoreContextCacheFactory: inMemoryFirestoreContextCacheFactory()
  * }))
  * export class AppFirestoreModule {}
  * ```
+ *
+ * @example
+ * ```typescript
+ * @example
+ * ```typescript
+ * // With caching
  */
 export declare function appFirestoreModuleMetadata<T>(config: ProvideAppFirestoreModuleMetadataConfig<T>): ModuleMetadata;

package/src/lib/nest/function/call.d.ts

@@ -65,6 +65,9 @@ export type OnCallWithOptionalAuthorizedNestContext<N, I = unknown, O = unknown>
  * By default, callable functions with auth-aware nest context require auth. Use this wrapper to
  * explicitly opt out of that requirement for endpoints that should be publicly accessible.
  *
+ * @param fn - The callable function handler to wrap.
+ * @returns A new handler flagged with `_requireAuth: false`.
+ *
  * @example
  * ```ts
  * const handler = optionalAuthContext<MyContext, Input, Output>((request) => {
@@ -72,9 +75,6 @@ export type OnCallWithOptionalAuthorizedNestContext<N, I = unknown, O = unknown>
  *   return doSomething(request);
  * });
  * ```
- *
- * @param fn - The callable function handler to wrap.
- * @returns A new handler flagged with `_requireAuth: false`.
  */
 export declare function optionalAuthContext<N, I, O>(fn: OnCallWithNestContext<N, I, O>): OnCallWithOptionalAuthorizedNestContext<N, I, O>;
 /**
@@ -107,6 +107,9 @@ export declare function assertRequestRequiresAuthForFunction(fn: OnCallWithAuthA
  * The wrapper calls {@link assertIsContextWithAuthData} before invoking the handler, ensuring that
  * unauthenticated requests are rejected with an appropriate error before reaching handler logic.
  *
+ * @param fn - The authorized handler to wrap with auth assertion.
+ * @returns A general {@link OnCallWithNestContext} handler that asserts auth before delegating.
+ *
  * @example
  * ```ts
  * const secureHandler = inAuthContext<MyContext, Input, Output>((request) => {
@@ -114,8 +117,5 @@ export declare function assertRequestRequiresAuthForFunction(fn: OnCallWithAuthA
  *   return processAuthenticatedRequest(request);
  * });
  * ```
- *
- * @param fn - The authorized handler to wrap with auth assertion.
- * @returns A general {@link OnCallWithNestContext} handler that asserts auth before delegating.
  */
 export declare function inAuthContext<N, I, O>(fn: OnCallWithAuthorizedNestContext<N, I, O>): OnCallWithNestContext<N, I, O>;

package/src/lib/nest/function/context.d.ts

@@ -21,13 +21,13 @@ export type FirebaseServerActionsContextOptions = FirebaseServerActionsTransform
 /**
  * Creates a {@link FirebaseServerActionsContext} with the default transform and validation factories.
  *
+ * @param options - Optional configuration for error logging behavior.
+ * @returns A fully configured actions context.
+ *
  * @example
  * ```ts
  * const context = firebaseServerActionsContext({ logError: true });
  * ```
- *
- * @param options - Optional configuration for error logging behavior.
- * @returns A fully configured actions context.
  */
 export declare function firebaseServerActionsContext(options?: FirebaseServerActionsContextOptions): FirebaseServerActionsContext;
 /**
@@ -44,7 +44,7 @@ export type FirebaseServerActionsTransformFactoryLogErrorFunctionInput = Firebas
  * Default error logger that writes validation error details to the console.
  * Used when `logError` is `true` or omitted in the factory options.
  *
- * @param details - the validation error details to log.
+ * @param details - The validation error details to log.
  */
 export declare const defaultFirebaseServerActionsTransformFactoryLogErrorFunction: FirebaseServerActionsTransformFactoryLogErrorFunction;
 /**
@@ -115,6 +115,9 @@ export interface FirebaseServerActionsTransformFactoryOptions {
  *
  * Validation errors are optionally logged before the error is thrown, controlled by the `logError` option.
  *
+ * @param options - Optional configuration for error logging behavior.
+ * @returns A factory that creates type-safe transform functions from ArkType schemas.
+ *
  * @example
  * ```ts
  * const transformFactory = firebaseServerActionsTransformFactory({ logError: true });
@@ -122,8 +125,6 @@ export interface FirebaseServerActionsTransformFactoryOptions {
  * const validated = await transform(rawInput);
  * ```
  *
- * @param options - Optional configuration for error logging behavior.
- * @returns A factory that creates type-safe transform functions from ArkType schemas.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firebaseServerActionsTransformFactory(options?: FirebaseServerActionsTransformFactoryOptions): TransformAndValidateObjectFactory;

package/src/lib/nest/function/v2/blocking.d.ts

@@ -60,6 +60,11 @@ export interface BlockingFunctionBuilder<E extends object, O> {
  * The attached `__handler` enables direct handler invocation in tests without triggering
  * the full Firebase blocking function infrastructure.
  *
+ * @param blockingFunctionBuilder - The Firebase blocking function constructor (e.g., `beforeUserCreated`).
+ * @param handler - The handler logic to execute on each event.
+ * @param opts - Optional {@link BlockingOptions} passed to the builder.
+ * @returns A {@link BlockingFunctionWithHandler} with the handler accessible via `__handler`.
+ *
  * @example
  * ```ts
  * const fn = makeBlockingFunctionWithHandler(
@@ -70,10 +75,6 @@ export interface BlockingFunctionBuilder<E extends object, O> {
  * // In tests: fn.__handler(mockEvent)
  * ```
  *
- * @param blockingFunctionBuilder - The Firebase blocking function constructor (e.g., `beforeUserCreated`).
- * @param handler - The handler logic to execute on each event.
- * @param opts - Optional {@link BlockingOptions} passed to the builder.
- * @returns A {@link BlockingFunctionWithHandler} with the handler accessible via `__handler`.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeBlockingFunctionWithHandler<E extends object, O>(blockingFunctionBuilder: BlockingFunctionBuilder<E, O>, handler: BlockingFunctionHandler<E, O>, opts?: Maybe<BlockingOptions>): BlockingFunctionWithHandler<E, O>;
@@ -116,6 +117,9 @@ export type BlockingFunctionHandlerWithNestContextFactory<N> = <E extends object
  * The returned factory lazily resolves the NestJS application on each invocation, injects the
  * typed context into the event, and delegates to the handler.
  *
+ * @param makeNestContext - Factory that creates the typed context from the NestJS application context.
+ * @returns A factory for creating nest-context-aware blocking function handlers.
+ *
  * @example
  * ```ts
  * const factory = blockingFunctionHandlerWithNestContextFactory(makeMyContext);
@@ -127,8 +131,6 @@ export type BlockingFunctionHandlerWithNestContextFactory<N> = <E extends object
  * );
  * ```
  *
- * @param makeNestContext - Factory that creates the typed context from the NestJS application context.
- * @returns A factory for creating nest-context-aware blocking function handlers.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function blockingFunctionHandlerWithNestContextFactory<N>(makeNestContext: MakeNestContext<N>): BlockingFunctionHandlerWithNestContextFactory<N>;

package/src/lib/nest/function/v2/call.d.ts

@@ -20,6 +20,9 @@ export type OnCallHandlerWithNestApplicationFactory = <I = unknown, O = unknown>
  * The `defaultOpts` are merged with per-function options, allowing shared configuration (e.g., CORS settings,
  * memory allocation) to be set once at the factory level.
  *
+ * @param defaultOpts - Default {@link https.CallableOptions} applied to all functions created by this factory.
+ * @returns A factory that creates nest-application-aware callable functions.
+ *
  * @example
  * ```ts
  * const callFactory = onCallHandlerWithNestApplicationFactory({ cors: true });
@@ -29,8 +32,6 @@ export type OnCallHandlerWithNestApplicationFactory = <I = unknown, O = unknown>
  * );
  * ```
  *
- * @param defaultOpts - Default {@link https.CallableOptions} applied to all functions created by this factory.
- * @returns A factory that creates nest-application-aware callable functions.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function onCallHandlerWithNestApplicationFactory(defaultOpts?: https.CallableOptions): OnCallHandlerWithNestApplicationFactory;
@@ -45,6 +46,10 @@ export type OnCallHandlerWithNestContextFactory<C> = <I = unknown, O = unknown>(
  * This is the standard way to create callable functions that receive a domain-specific context
  * (e.g., `MyApiNestContext`) rather than the raw NestJS application context.
  *
+ * @param appFactory - The base application-level callable factory.
+ * @param makeNestContext - Factory that creates the typed context from the application context.
+ * @returns A factory that creates typed-context-aware callable functions.
+ *
  * @example
  * ```ts
  * const appFactory = onCallHandlerWithNestApplicationFactory();
@@ -55,9 +60,6 @@ export type OnCallHandlerWithNestContextFactory<C> = <I = unknown, O = unknown>(
  * });
  * ```
  *
- * @param appFactory - The base application-level callable factory.
- * @param makeNestContext - Factory that creates the typed context from the application context.
- * @returns A factory that creates typed-context-aware callable functions.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function onCallHandlerWithNestContextFactory<C>(appFactory: OnCallHandlerWithNestApplicationFactory, makeNestContext: MakeNestContext<C>): OnCallHandlerWithNestContextFactory<C>;