@dereekb/firebase-server 13.4.1 → 13.4.2

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

@@ -16,7 +16,7 @@ export declare class DefaultFirestoreDocumentDataAccessor<T> implements Firestor
     exists(): Promise<boolean>;
     get(): Promise<DocumentSnapshot<T>>;
     getWithConverter<U = DocumentData>(converter: null | FirestoreDataConverter<U>): Promise<DocumentSnapshot<U>>;
-    delete(params: FirestoreDocumentDeleteParams): Promise<GoogleCloudWriteResult>;
+    delete(params?: FirestoreDocumentDeleteParams): Promise<GoogleCloudWriteResult>;
     set(data: WithFieldValue<T>, options?: SetOptions): Promise<GoogleCloudWriteResult>;
     increment(data: FirestoreAccessorIncrementUpdate<T>, params?: FirestoreDocumentUpdateParams): Promise<GoogleCloudWriteResult>;
     arrayUpdate(data: FirestoreAccessorArrayUpdate<T>, params?: FirestoreDocumentUpdateParams): Promise<GoogleCloudWriteResult>;
@@ -25,6 +25,8 @@ export declare class DefaultFirestoreDocumentDataAccessor<T> implements Firestor
 /**
  * Creates a {@link FirestoreDocumentDataAccessorFactory} that produces default (non-batched, non-transactional) accessors.
  *
+ * @returns A factory that creates default (non-batched, non-transactional) accessors.
+ *
  * @example
  * ```typescript
  * const factory = defaultFirestoreAccessorFactory<User>();
@@ -36,5 +38,7 @@ export declare function defaultFirestoreAccessorFactory<T>(): FirestoreDocumentD
  * Creates a {@link FirestoreDocumentContext} with no special execution context (no batch, no transaction).
  *
  * Operations performed through this context execute immediately against Firestore.
+ *
+ * @returns A {@link FirestoreDocumentContext} for direct Firestore operations.
  */
 export declare function defaultFirestoreDocumentContext<T>(): FirestoreDocumentContext<T>;

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

@@ -32,6 +32,7 @@ export declare class TransactionFirestoreDocumentDataAccessor<T> implements Fire
  * atomic operation.
  *
  * @param transaction - The Google Cloud Transaction to execute operations within.
+ * @returns A factory that creates transaction-backed accessors sharing the given transaction.
  *
  * @example
  * ```typescript
@@ -58,5 +59,8 @@ export declare class TransactionFirestoreDocumentContext<T> implements Firestore
 }
 /**
  * Creates a {@link TransactionFirestoreDocumentContext} wrapping the given transaction.
+ *
+ * @param transaction - The Google Cloud Transaction to use.
+ * @returns A new {@link TransactionFirestoreDocumentContext} for the given transaction.
  */
 export declare function transactionDocumentContext<T>(transaction: GoogleCloudTransaction): TransactionFirestoreDocumentContext<T>;

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

@@ -8,6 +8,8 @@ export type GoogleCloudFirestoreDrivers = FirestoreDrivers;
  *
  * Bundles the server-side accessor driver and query driver, identified as `@google-cloud/firestore`.
  *
+ * @returns A complete set of {@link FirestoreDrivers} for the Google Cloud Admin SDK.
+ *
  * @example
  * ```typescript
  * const drivers = googleCloudFirestoreDrivers();

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

@@ -14,6 +14,8 @@ export declare const FIRESTORE_CLIENT_QUERY_CONSTRAINT_HANDLER_MAPPING: FullFire
  * Creates a {@link FirestoreQueryConstraintFunctionsDriver} for the Google Cloud Firestore server SDK.
  *
  * Translates abstract query constraints into Google Cloud Firestore query builder calls.
+ *
+ * @returns A {@link FirestoreQueryConstraintFunctionsDriver} for the server SDK.
  */
 export declare function firestoreClientQueryConstraintFunctionsDriver(): FirestoreQueryConstraintFunctionsDriver;
 /**
@@ -23,6 +25,8 @@ export declare function firestoreClientQueryConstraintFunctionsDriver(): Firesto
  * streaming (streamDocs) via `onSnapshot`. Transaction-aware reads are supported
  * through the optional transaction parameter in `getDocs`.
  *
+ * @returns A complete {@link FirestoreQueryDriver} for the Google Cloud Admin SDK.
+ *
  * @example
  * ```typescript
  * const queryDriver = googleCloudFirestoreQueryDriver();

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

@@ -6,6 +6,7 @@ import { type UpdateData, type FirestoreAccessorIncrementUpdate } from '@dereekb
  * Each field in the input maps to an atomic increment operation. Null/undefined values default to 0.
  *
  * @param input - The increment specification mapping field names to numeric deltas.
+ * @returns Firestore {@link UpdateData} with atomic increment operations.
  *
  * @example
  * ```typescript

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

@@ -3,6 +3,7 @@ import { type CallableContext } from '../type';
 /**
  * Asserts that the callable context contains auth data with a valid UID.
  *
+ * @param context - The callable context to check for auth data.
  * @throws {HttpsError} Throws unauthenticated error if no auth data is present.
  *
  * @example
@@ -17,6 +18,7 @@ export declare function assertContextHasAuth(context: CallableContext): void;
  *
  * @param document - The Firestore document to load data from.
  * @param message - Optional custom error message.
+ * @returns The document's snapshot data.
  * @throws {HttpsError} Throws a {@link modelNotAvailableError} (404) if the document has no data.
  *
  * @example
@@ -32,6 +34,7 @@ export declare function assertSnapshotData<D extends FirestoreDocument<any>>(doc
  *
  * @param document - The Firestore document to load data from.
  * @param message - Optional custom error message.
+ * @returns The document's snapshot data with `id` and `key` attached.
  * @throws {HttpsError} Throws a {@link modelNotAvailableError} (404) if the document has no data.
  */
 export declare function assertSnapshotDataWithKey<D extends FirestoreDocument<any>>(document: D, message?: string): Promise<DocumentDataWithIdAndKey<FirestoreDocumentData<D>>>;
@@ -47,5 +50,9 @@ export declare function assertDocumentExists<D extends FirestoreDocument<any>>(d
  * Creates a {@link modelNotAvailableError} for the given document's model type.
  *
  * Used by {@link assertDocumentExists} and other assertion functions.
+ *
+ * @param document - The document (or object with `modelType`) to generate the error for.
+ * @param message - Optional custom error message.
+ * @returns A {@link modelNotAvailableError} with the document's model type in the message.
  */
 export declare function documentModelNotAvailableError(document: Pick<FirestoreDocument<any>, 'modelType'>, message?: string): import("firebase-functions/https").HttpsError;

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

@@ -8,6 +8,9 @@ export type CallableContextWithAuthData<R extends CallableContext = CallableCont
 /**
  * Type guard that checks whether the given callable context contains authenticated user data (non-null auth with a uid).
  *
+ * @param context - The callable context to check.
+ * @returns `true` if the context has authenticated user data with a valid UID.
+ *
  * @example
  * ```typescript
  * if (isContextWithAuthData(context)) {
@@ -19,6 +22,7 @@ export declare function isContextWithAuthData<R extends CallableContext>(context
 /**
  * Asserts that the callable context contains authenticated user data.
  *
+ * @param context - The callable context to assert on.
  * @throws {HttpsError} Throws an unauthenticated error if auth data is missing.
  *
  * @example

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

@@ -6,6 +6,8 @@ import type * as admin from 'firebase-admin';
 export declare const PHONE_NUMBER_ALREADY_EXISTS_ERROR_CODE = "PHONE_NUMBER_ALREADY_EXISTS";
 /**
  * Creates a precondition conflict (409) error indicating the phone number already exists.
+ *
+ * @returns A new precondition-conflict (409) {@link HttpsError} with the phone-number-exists code.
  */
 export declare function phoneNumberAlreadyExistsError(): import("firebase-functions/https").HttpsError;
 /**

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

@@ -4,10 +4,14 @@ import { type FirebaseErrorCode } from '@dereekb/firebase';
 import { HttpsError } from 'firebase-functions/https';
 /**
  * Creates an unauthenticated {@link HttpsError} indicating the request context has no auth data.
+ *
+ * @returns A new unauthenticated {@link HttpsError} with the no-auth error code.
  */
 export declare function unauthenticatedContextHasNoAuthData(): HttpsError;
 /**
  * Creates an unauthenticated {@link HttpsError} indicating the request context has no user UID.
+ *
+ * @returns A new unauthenticated {@link HttpsError} with the no-auth error code.
  */
 export declare function unauthenticatedContextHasNoUidError(): HttpsError;
 /**
@@ -17,37 +21,92 @@ export declare function unauthenticatedContextHasNoUidError(): HttpsError;
  * a string error code, and an optional {@link ServerError} detail object.
  */
 export declare const UNAUTHENTICATED_ERROR_CODE = "UNAUTHENTICATED";
-/** Creates an unauthenticated (401) {@link HttpsError}. */
+/**
+ * Creates an unauthenticated (401) {@link HttpsError}.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new unauthenticated (401) {@link HttpsError}.
+ */
 export declare function unauthenticatedError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const FORBIDDEN_ERROR_CODE = "FORBIDDEN";
-/** Creates a forbidden (403) {@link HttpsError}. */
+/**
+ * Creates a forbidden (403) {@link HttpsError}.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new forbidden (403) {@link HttpsError}.
+ */
 export declare function forbiddenError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const PERMISSION_DENIED_ERROR_CODE = "PERMISSION_DENIED";
-/** Creates a permission-denied (403) {@link HttpsError}. */
+/**
+ * Creates a permission-denied (403) {@link HttpsError}.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new permission-denied (403) {@link HttpsError}.
+ */
 export declare function permissionDeniedError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const NOT_FOUND_ERROR_CODE = "NOT_FOUND";
-/** Creates a not-found (404) {@link HttpsError}. */
+/**
+ * Creates a not-found (404) {@link HttpsError}.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new not-found (404) {@link HttpsError}.
+ */
 export declare function notFoundError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const MODEL_NOT_AVAILABLE_ERROR_CODE = "MODEL_NOT_AVAILABLE";
-/** Creates a model-not-available (404) {@link HttpsError}, used when a Firestore document does not exist. */
+/**
+ * Creates a model-not-available (404) {@link HttpsError}, used when a Firestore document does not exist.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new model-not-available (404) {@link HttpsError}.
+ */
 export declare function modelNotAvailableError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const BAD_REQUEST_ERROR_CODE = "BAD_REQUEST";
-/** Creates a bad-request (400) {@link HttpsError}. */
+/**
+ * Creates a bad-request (400) {@link HttpsError}.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new bad-request (400) {@link HttpsError}.
+ */
 export declare function badRequestError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const CONFLICT_ERROR_CODE = "CONFLICT";
-/** Creates a precondition-conflict (409) {@link HttpsError}. */
+/**
+ * Creates a precondition-conflict (409) {@link HttpsError}.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new precondition-conflict (409) {@link HttpsError}.
+ */
 export declare function preconditionConflictError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const ALREADY_EXISTS_ERROR_CODE = "ALREADY_EXISTS";
-/** Creates an already-exists (409) {@link HttpsError}. */
+/**
+ * Creates an already-exists (409) {@link HttpsError}.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new already-exists (409) {@link HttpsError}.
+ */
 export declare function alreadyExistsError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const UNAVAILABLE_ERROR_CODE = "UNAVAILABLE";
-/** Creates an unavailable (503) {@link HttpsError}. */
+/**
+ * Creates an unavailable (503) {@link HttpsError}.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new unavailable (503) {@link HttpsError}.
+ */
 export declare function unavailableError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const UNAVAILABLE_OR_DEACTIVATED_FUNCTION_ERROR_CODE = "UNAVAILABLE_OR_DEACTIVATED_FUNCTION";
-/** Creates an unimplemented (501) {@link HttpsError} for deactivated or unavailable functions. */
+/**
+ * Creates an unimplemented (501) {@link HttpsError} for deactivated or unavailable functions.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new unimplemented (501) {@link HttpsError}.
+ */
 export declare function unavailableOrDeactivatedFunctionError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 export declare const INTERNAL_SERVER_ERROR_CODE = "INTERNAL_ERROR";
-/** Creates an internal-error (500) {@link HttpsError}. */
+/**
+ * Creates an internal-error (500) {@link HttpsError}.
+ *
+ * @param messageOrError - Optional error message string or partial server error object.
+ * @returns A new internal-error (500) {@link HttpsError}.
+ */
 export declare function internalServerError(messageOrError?: ErrorMessageOrPartialServerError): HttpsError;
 /**
  * Discriminator for the type of Firebase server error encountered.
@@ -91,10 +150,16 @@ export interface FirebaseServerErrorInfo {
 }
 /**
  * Type guard for Firebase {@link HttpsError} instances.
+ *
+ * @param input - The value to check.
+ * @returns `true` if the input is a Firebase {@link HttpsError}.
  */
 export declare function isFirebaseHttpsError(input: unknown | HttpsError): input is HttpsError;
 /**
  * Type guard for Firebase Admin {@link admin.FirebaseError} instances.
+ *
+ * @param input - The value to check.
+ * @returns `true` if the input is a Firebase Admin {@link admin.FirebaseError}.
  */
 export declare function isFirebaseError(input: unknown | admin.FirebaseError): input is admin.FirebaseError;
 /**
@@ -104,6 +169,7 @@ export declare function isFirebaseError(input: unknown | admin.FirebaseError): i
  * and extracts any embedded error codes and {@link ServerError} details.
  *
  * @param e - The caught error to analyze.
+ * @returns Structured {@link FirebaseServerErrorInfo} with classified error details.
  *
  * @example
  * ```typescript
@@ -118,14 +184,23 @@ export declare function isFirebaseError(input: unknown | admin.FirebaseError): i
 export declare function firebaseServerErrorInfo(e: unknown): FirebaseServerErrorInfo;
 /**
  * Returns a tuple of [firebaseErrorCode, errorInfo] for pattern-matching on Firebase error codes.
+ *
+ * @param e - The caught error to analyze.
+ * @returns A tuple of the Firebase error code (if present) and the full error info.
  */
 export declare function firebaseServerErrorInfoCodePair(e: unknown): [Maybe<FirebaseErrorCode>, FirebaseServerErrorInfo];
 /**
  * Returns a tuple of [serverError, errorInfo] for pattern-matching on embedded server error details.
+ *
+ * @param e - The caught error to analyze.
+ * @returns A tuple of the server error (if present) and the full error info.
  */
 export declare function firebaseServerErrorInfoServerErrorPair(e: unknown): [Maybe<ServerError>, FirebaseServerErrorInfo];
 /**
  * Returns a tuple of [serverErrorCode, errorInfo] for pattern-matching on server error string codes.
+ *
+ * @param e - The caught error to analyze.
+ * @returns A tuple of the server error code (if present) and the full error info.
  */
 export declare function firebaseServerErrorInfoServerErrorCodePair(e: unknown): [Maybe<StringErrorCode>, FirebaseServerErrorInfo];
 /**

package/src/lib/index.d.ts

@@ -1,5 +1,4 @@
 export * from './auth';
-export * from './auth';
 export * from './env';
 export * from './firestore';
 export * from './function';

package/src/lib/nest/analytics/analytics.service.listener.d.ts

@@ -46,5 +46,7 @@ export declare abstract class FirebaseServerAnalyticsServiceListener {
  * Creates a default no-op {@link FirebaseServerAnalyticsServiceListener}.
  *
  * Used when no analytics provider is configured. All methods are no-ops.
+ *
+ * @returns A no-op listener that silently discards all analytics events.
  */
 export declare function noopFirebaseServerAnalyticsServiceListener(): FirebaseServerAnalyticsServiceListener;

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

@@ -39,8 +39,6 @@ export interface NestServerInstance<T> {
      */
     removeNestServer(firebaseApp: admin.app.App): Promise<boolean>;
 }
-/** @deprecated Use `FirebaseNestServerRootModule` from `./app.module` instead. */
-export { FirebaseNestServerRootModule } from './app.module';
 /**
  * Optional hook to customize the NestJS application after creation but before initialization.
  */
@@ -108,7 +106,9 @@ export interface NestServerInstanceConfig<T> {
 export interface NestFirebaseServerEnvironmentConfig {
     readonly environment: FirebaseServerEnvironmentConfig;
 }
-/** @deprecated Use NestFirebaseServerEnvironmentConfig instead. */
+/**
+ * @deprecated Use NestFirebaseServerEnvironmentConfig instead.
+ */
 export type NestServerEnvironmentConfig = NestFirebaseServerEnvironmentConfig;
 /**
  * Creates a {@link NestServerInstance} that manages NestJS server lifecycle within Firebase Cloud Functions.
@@ -117,6 +117,9 @@ export type NestServerEnvironmentConfig = NestFirebaseServerEnvironmentConfig;
  * times with the same app reuses the existing server. The factory wires up Firebase Admin,
  * environment config, storage, AppCheck middleware, and webhook routes based on the config.
  *
+ * @param config - Configuration for the NestJS server instance including the root module, providers, and middleware options.
+ * @returns A NestServerInstance that manages server lifecycle for the given module class.
+ *
  * @example
  * ```typescript
  * const instance = nestServerInstance({ moduleClass: AppModule, appCheckEnabled: true });

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

@@ -28,6 +28,9 @@ export type ProvideFirebaseServerAuthService<T extends FirebaseServerAuthService
  * Returns two providers: the concrete service and an alias that maps
  * `FirebaseServerAuthService` to the concrete token, enabling injection by the abstract type.
  *
+ * @param provider - The factory provider configuration for the auth service.
+ * @returns A tuple containing the configured provider and an alias provider.
+ *
  * @example
  * ```typescript
  * const providers = provideFirebaseServerAuthService({
@@ -44,6 +47,9 @@ export interface FirebaseServerAuthModuleMetadataConfig<T extends FirebaseServer
  * Generates NestJS {@link ModuleMetadata} for an app's auth module, including the {@link FirebaseServerAuthModule}
  * import and the custom {@link FirebaseServerAuthService} provider.
  *
+ * @param config - The module metadata configuration including the service provider.
+ * @returns The merged NestJS module metadata.
+ *
  * @example
  * ```typescript
  * @Module(firebaseServerAuthModuleMetadata({

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

@@ -5,11 +5,15 @@ import { type AbstractFirebaseNestContext } from '../nest.provider';
 /**
  * Asserts that the caller has admin privileges in the request.
  *
+ * @param request - The callable request to check for admin privileges.
  * @throws {HttpsError} Throws forbidden (403) if the caller is not an admin.
  */
 export declare function assertIsAdminInRequest<N extends AbstractFirebaseNestContext<any, any> = AbstractFirebaseNestContext<any, any>, I = unknown>(request: NestContextCallableRequestWithOptionalAuth<N, I>): void;
 /**
  * Checks whether the caller has admin privileges in the request.
+ *
+ * @param request - The callable request to check for admin privileges.
+ * @returns True if the caller has admin privileges.
  */
 export declare function isAdminInRequest<N extends AbstractFirebaseNestContext<any, any> = AbstractFirebaseNestContext<any, any>, I = unknown>(request: NestContextCallableRequestWithOptionalAuth<N, I>): boolean;
 /**
@@ -17,6 +21,8 @@ export declare function isAdminInRequest<N extends AbstractFirebaseNestContext<a
  *
  * If the request data contains a `uid` that differs from the caller's auth UID, admin status is required.
  *
+ * @param request - The callable request containing the target UID.
+ * @param requireUid - If true, a UID must be present in the request data.
  * @returns The resolved target UID (from request data or auth).
  * @throws {HttpsError} Throws forbidden (403) if the caller is not authorized.
  */
@@ -24,28 +30,39 @@ export declare function assertIsAdminOrTargetUserInRequestData<N extends Abstrac
 /**
  * Checks whether the caller is an admin or is targeting their own user record in the request data.
  *
+ * @param request - The callable request containing the target UID.
  * @param requireUid - If true, a UID must be present in the request data.
+ * @returns True if the caller is an admin or is targeting their own user record.
  */
 export declare function isAdminOrTargetUserInRequestData<N extends AbstractFirebaseNestContext<any, any> = AbstractFirebaseNestContext<any, any>, I extends Partial<UserRelated> = Partial<UserRelated>>(request: NestContextCallableRequestWithOptionalAuth<N, I>, requireUid?: boolean): boolean;
 /**
  * Asserts that the caller has signed the Terms of Service.
  *
+ * @param request - The callable request to check for ToS status.
  * @throws {HttpsError} Throws forbidden (403) if ToS has not been signed.
  */
 export declare function assertHasSignedTosInRequest<N extends AbstractFirebaseNestContext<any, any> = AbstractFirebaseNestContext<any, any>, I = unknown>(request: NestContextCallableRequestWithOptionalAuth<N, I>): void;
 /**
  * Checks whether the caller has signed the Terms of Service.
+ *
+ * @param request - The callable request to check for ToS status.
+ * @returns True if the caller has signed the Terms of Service.
  */
 export declare function hasSignedTosInRequest<N extends AbstractFirebaseNestContext<any, any> = AbstractFirebaseNestContext<any, any>, I = unknown>(request: NestContextCallableRequestWithOptionalAuth<N, I>): boolean;
 /**
  * Asserts that the caller has all of the specified auth roles.
  *
+ * @param request - The callable request to check for auth roles.
  * @param authRoles - One or more roles that must all be present.
  * @throws {HttpsError} Throws forbidden (403) if any required role is missing.
  */
 export declare function assertHasRolesInRequest<N extends AbstractFirebaseNestContext<any, any> = AbstractFirebaseNestContext<any, any>, I = unknown>(request: NestContextCallableRequestWithOptionalAuth<N, I>, authRoles: ArrayOrValue<AuthRole>): void;
 /**
  * Checks whether the caller has all of the specified auth roles.
+ *
+ * @param request - The callable request to check for auth roles.
+ * @param authRoles - One or more roles that must all be present.
+ * @returns True if the caller has all of the specified auth roles.
  */
 export declare function hasAuthRolesInRequest<N extends AbstractFirebaseNestContext<any, any> = AbstractFirebaseNestContext<any, any>, I = unknown>(request: NestContextCallableRequestWithOptionalAuth<N, I>, authRoles: ArrayOrValue<AuthRole>): boolean;
 /**
@@ -53,6 +70,7 @@ export declare function hasAuthRolesInRequest<N extends AbstractFirebaseNestCont
  *
  * This may be used to filter out new users that were not invited from finishing their onboarding.
  *
- * @param request
+ * @param request - The callable request to check for setup password claims.
+ * @returns True if the claims contain a setup password key.
  */
 export declare function hasNewUserSetupPasswordInRequest<N extends AbstractFirebaseNestContext<any, any> = AbstractFirebaseNestContext<any, any>, I = unknown>(request: NestContextCallableRequestWithOptionalAuth<N, I>): boolean;

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

@@ -16,7 +16,9 @@ import { type OnCallDevelopmentFunctionMap } from './development.function';
  * @typeParam S - The schedule function map type.
  */
 export interface FirebaseServerDevFunctionsConfig<N extends AbstractFirebaseNestContext<any, any>, S extends NestApplicationScheduleConfiguredFunctionMap> {
-    /** When false, dev endpoints return an "unavailable" error instead of executing. */
+    /**
+     * When false, dev endpoints return an "unavailable" error instead of executing.
+     */
     readonly enabled: boolean;
     /**
      * Whether or not to require an auth context when calling dev functions. True by default.
@@ -24,11 +26,17 @@ export interface FirebaseServerDevFunctionsConfig<N extends AbstractFirebaseNest
      * Set to false only in local development where authentication is unavailable.
      */
     readonly secure?: boolean;
-    /** Getter for the NestJS application promise, used to bootstrap the context. */
+    /**
+     * Getter for the NestJS application promise, used to bootstrap the context.
+     */
     readonly nest: NestAppPromiseGetter;
-    /** Map of specifier keys to developer utility functions. */
+    /**
+     * Map of specifier keys to developer utility functions.
+     */
     readonly developerFunctionsMap: OnCallDevelopmentFunctionMap<N>;
-    /** Factory that wraps a handler function with NestJS context resolution. */
+    /**
+     * Factory that wraps a handler function with NestJS context resolution.
+     */
     readonly onCallFactory: OnCallHandlerWithNestContextFactory<N>;
     /**
      * Whether or not to disable adding the dev schedule function. False by default.

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

@@ -10,9 +10,13 @@ import { type NestContextCallableRequest } from '../function/nest';
  * @typeParam I - The input data type of the request.
  */
 export interface AssertDevelopmentRequestFunctionContext<N, I = unknown> {
-    /** The original callable request including the NestJS context and caller data. */
+    /**
+     * The original callable request including the NestJS context and caller data.
+     */
     readonly request: NestContextCallableRequest<N, I>;
-    /** The development function specifier string identifying which dev operation was requested. */
+    /**
+     * The development function specifier string identifying which dev operation was requested.
+     */
     readonly specifier: string;
 }
 /**

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

@@ -31,7 +31,9 @@ export type OnCallDevelopmentFunctionMap<N> = {
  * @typeParam N - The NestJS context type.
  */
 export interface OnCallDevelopmentConfig<N> {
-    /** Optional assertion run before the dev handler; throw to reject the request. */
+    /**
+     * Optional assertion run before the dev handler; throw to reject the request.
+     */
     readonly preAssert?: AssertDevelopmentRequestFunction<N, OnCallDevelopmentParams>;
 }
 /**
@@ -55,5 +57,8 @@ export interface OnCallDevelopmentConfig<N> {
 export declare function onCallDevelopmentFunction<N>(map: OnCallDevelopmentFunctionMap<N>, config?: OnCallDevelopmentConfig<N>): OnCallWithNestContext<N, OnCallDevelopmentParams>;
 /**
  * Creates a bad-request error indicating the provided development function specifier is not recognized.
+ *
+ * @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.d.ts

@@ -5,7 +5,9 @@ import { type OnCallDevelopmentFunction } from './development.function';
  * Configuration for {@link makeScheduledFunctionDevelopmentFunction}.
  */
 export interface MakeScheduledFunctionDevelopmentFunctionConfig {
-    /** The complete map of registered scheduled functions that can be triggered manually. */
+    /**
+     * The complete map of registered scheduled functions that can be triggered manually.
+     */
     readonly allScheduledFunctions: NestApplicationScheduleConfiguredFunctionMap;
 }
 /**

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

@@ -5,6 +5,8 @@ export declare const NO_RUN_NAME_SPECIFIED_FOR_SCHEDULED_FUNCTION_DEVELOPMENT_FU
 /**
  * Creates a bad-request error for when the caller sends a 'run' command
  * without specifying which scheduled function to execute.
+ *
+ * @returns A bad-request error indicating the missing run name.
  */
 export declare function noRunNameSpecifiedForScheduledFunctionDevelopmentFunction(): import("firebase-functions/https").HttpsError;
 /**
@@ -14,6 +16,9 @@ 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.
+ * @returns A bad-request error with the unknown function name details.
  */
 export declare function unknownScheduledFunctionDevelopmentFunctionName(name: unknown): import("firebase-functions/https").HttpsError;
 /**
@@ -23,5 +28,8 @@ 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.
+ * @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.service.d.ts

@@ -11,6 +11,8 @@ export declare class DefaultFirebaseServerEnvService extends ServerEnvironmentSe
     private readonly _appUrlDetails;
     /**
      * Enabled when not in production and not in a testing environment.
+     *
+     * @returns True if the development scheduler should be enabled.
      */
     get developmentSchedulerEnabled(): boolean;
     get appUrlDetails(): Maybe<WebsiteUrlDetails>;

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

@@ -5,6 +5,9 @@ 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.
+ * @returns An async decision function that resolves to `true` in production.
+ *
  * @example
  * ```typescript
  * const isProduction = nestAppIsProductionEnvironment(nestAppGetter);
@@ -16,5 +19,8 @@ export declare function nestAppIsProductionEnvironment(nest: NestAppPromiseGette
  * Creates an async decision function that resolves to `true` if the development scheduler is enabled.
  *
  * The development scheduler is enabled in non-production, non-testing environments.
+ *
+ * @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/firebase/firebase.module.d.ts

@@ -10,6 +10,7 @@ export declare const FIREBASE_APP_TOKEN: InjectionToken;
  * Creates a NestJS {@link FactoryProvider} that binds a Firebase Admin app getter to {@link FIREBASE_APP_TOKEN}.
  *
  * @param useFactory - Factory function returning the Firebase Admin app instance.
+ * @returns A NestJS factory provider for the Firebase Admin app.
  *
  * @example
  * ```typescript

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

@@ -33,6 +33,11 @@ export interface ProvideAppFirestoreCollectionsConfig<T> {
 /**
  * Creates a NestJS provider that initializes a Firestore collections instance from the app's {@link FirestoreContext}.
  *
+ * @param config - The provide token and factory function configuration.
+ * @param config.provide - The class token to provide.
+ * @param config.useFactory - Factory that creates the collections from a FirestoreContext.
+ * @returns A tuple containing the configured NestJS provider.
+ *
  * @example
  * ```typescript
  * const [provider] = provideAppFirestoreCollections({
@@ -48,6 +53,9 @@ export interface ProvideAppFirestoreModuleMetadataConfig<T> extends ProvideAppFi
  * Generates NestJS {@link ModuleMetadata} for an app's Firestore module, including the
  * {@link FirebaseServerFirestoreContextModule} import and the app's collections provider.
  *
+ * @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({

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

@@ -43,6 +43,8 @@ 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.
  */
 export declare const defaultFirebaseServerActionsTransformFactoryLogErrorFunction: FirebaseServerActionsTransformFactoryLogErrorFunction;
 /**