@dereekb/firebase-server 13.11.13 → 13.11.15

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

@@ -76,6 +76,9 @@ export type CloudEventHandlerWithNestContextFactory<N> = <E extends CloudEvent<a
  * context, and delegates to the handler. This is the event-triggered equivalent of
  * {@link onCallHandlerWithNestContextFactory} for callable functions.
  *
+ * @param makeNestContext - Factory that creates the typed context from the NestJS application context.
+ * @returns A factory for creating nest-context-aware event function handlers.
+ *
  * @example
  * ```ts
  * const factory = cloudEventHandlerWithNestContextFactory(makeMyContext);
@@ -87,8 +90,6 @@ export type CloudEventHandlerWithNestContextFactory<N> = <E extends CloudEvent<a
  * );
  * ```
  *
- * @param makeNestContext - Factory that creates the typed context from the NestJS application context.
- * @returns A factory for creating nest-context-aware event function handlers.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function cloudEventHandlerWithNestContextFactory<N>(makeNestContext: MakeNestContext<N>): CloudEventHandlerWithNestContextFactory<N>;

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

@@ -36,6 +36,9 @@ export type OnScheduleHandlerWithNestApplicationFactory = (schedule: OnScheduleC
  * merges base and per-function schedule options, and attaches `_runNow` and `_schedule` metadata
  * to the resulting function for testing and introspection.
  *
+ * @param baseScheduleConfig - Optional default schedule options merged into every function created by this factory.
+ * @returns A factory for creating nest-application-aware scheduled functions.
+ *
  * @example
  * ```ts
  * const scheduleFactory = onScheduleHandlerWithNestApplicationFactory({ timeoutSeconds: 60 });
@@ -45,8 +48,6 @@ export type OnScheduleHandlerWithNestApplicationFactory = (schedule: OnScheduleC
  * );
  * ```
  *
- * @param baseScheduleConfig - Optional default schedule options merged into every function created by this factory.
- * @returns A factory for creating nest-application-aware scheduled functions.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function onScheduleHandlerWithNestApplicationFactory(baseScheduleConfig?: OnScheduleConfigWithGlobalOptions): OnScheduleHandlerWithNestApplicationFactory;

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

@@ -14,9 +14,10 @@ export type TaskQueueFunctionHandlerWithNestContextFactory<N> = <I = unknown>(fn
 /**
  * Creates a TaskQueueFunctionHandlerWithNestContextFactory.
  *
- * @param appFactory
  * @param makeNestContext
+ * @param appFactory
  * @returns
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function taskQueueFunctionHandlerWithNestContextFactory<N>(makeNestContext: MakeNestContext<N>): TaskQueueFunctionHandlerWithNestContextFactory<N>;

package/src/lib/nest/model/analytics.emit.d.ts

@@ -26,15 +26,15 @@ export type OnCallAnalyticsEmitterInstance = (lifecycle: OnCallModelAnalyticsEve
  * Creates an {@link OnCallAnalyticsEmitterInstance} that produces {@link OnCallAnalyticsEmitter} instances
  * for each lifecycle stage, pre-bound to the given service and context.
  *
+ * @param config - The service and context to bind to the emitter factory.
+ * @returns A factory function that creates lifecycle-stage-specific emitters.
+ *
  * @example
  * ```typescript
  * const emitter = onCallAnalyticsEmitterInstance({ service, context });
  * emitter('triggered').sendEventType('Handler Starting');
  * emitter('success').sendEvent('Widget Created', { id: result.id });
  * ```
- *
- * @param config - The service and context to bind to the emitter factory.
- * @returns A factory function that creates lifecycle-stage-specific emitters.
  */
 export declare function onCallAnalyticsEmitterInstance(config: OnCallAnalyticsEmitterInstanceConfig): OnCallAnalyticsEmitterInstance;
 /**
@@ -55,8 +55,8 @@ export interface CallWithAnalyticsConfig<O> {
  * Analytics callback errors are caught and logged but never propagate — the handler result
  * or error is always returned/thrown unmodified.
  *
- * @param config - the handler, analytics details, service, and context
- * @returns the handler's return value
+ * @param config - The handler, analytics details, service, and context.
+ * @returns The handler's return value.
  *
  * @example
  * ```ts

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

@@ -227,6 +227,9 @@ export interface WithApiDetailsConfig<F extends (...args: any[]) => any> extends
  * (same effect as optionalAuthContext). This avoids the composition issue where
  * optionalAuthContext(withApiDetails(...)) would lose the _apiDetails.
  *
+ * @param config - The API details configuration including the handler function.
+ * @returns The handler function with _apiDetails attached.
+ *
  * @example
  * ```typescript
  * // Handler with api details (auth required by default)
@@ -245,9 +248,6 @@ export interface WithApiDetailsConfig<F extends (...args: any[]) => any> extends
  *   fn: async (request) => { ... }
  * });
  * ```
- *
- * @param config - The API details configuration including the handler function.
- * @returns The handler function with _apiDetails attached.
  */
 export declare function withApiDetails<F extends (...args: any[]) => any>(config: WithApiDetailsConfig<F>): F & OnCallModelFunctionApiDetailsRef;
 /**
@@ -344,7 +344,7 @@ export interface ModelApiDetailsModelEntry {
  * pivots it to modelType → CRUD, which is the natural shape for MCP tool generation
  * and schema introspection.
  *
- * @param callModelFn The function returned by onCallModel(), or any object with _apiDetails.
+ * @param callModelFn - The function returned by onCallModel(), or any object with _apiDetails.
  * @returns Model-first API details, or undefined if no _apiDetails are present.
  *
  * @example

package/src/lib/nest/model/query.model.function.d.ts

@@ -178,6 +178,9 @@ export interface ExecuteOnCallQueryConfig<T, R = T> {
  * - Fetching one extra document to detect whether more results exist
  * - Building the {@link OnCallQueryModelResult} with cursorDocumentKey and hasMore
  *
+ * @param config - Query configuration including collection, constraints, and pagination params.
+ * @returns Paginated query result with cursor for the next page.
+ *
  * @example
  * ```typescript
  * export const queryGuestbooks: DemoQueryModelFunction<QueryGuestbooksParams, OnCallQueryModelResult<Guestbook>> = async (request) => {
@@ -200,8 +203,5 @@ export interface ExecuteOnCallQueryConfig<T, R = T> {
  *   });
  * };
  * ```
- *
- * @param config - Query configuration including collection, constraints, and pagination params.
- * @returns Paginated query result with cursor for the next page.
  */
 export declare function executeOnCallQuery<T, R = T>(config: ExecuteOnCallQueryConfig<T, R>): Promise<OnCallQueryModelResult<R>>;

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

@@ -30,8 +30,9 @@ export declare abstract class AbstractNestContext {
     /**
      * Returns the NestJS application context.
      *
-     * @deprecated use nestApplication instead.
      * @returns The NestJS application context.
+     *
+     * @deprecated use nestApplication instead.
      */
     get nest(): INestApplicationContext;
     /**
@@ -94,12 +95,11 @@ export declare abstract class AbstractFirebaseNestContext<A, Y extends FirebaseM
      * When called without a `use` function, returns the {@link ContextGrantedModelRolesReader}
      * which provides access to the document and its granted roles.
      *
-     * @throws Throws {@link nestFirebaseDoesNotExistError} if the document does not exist.
-     * @throws Throws {@link nestFirebaseForbiddenPermissionError} if the caller lacks the requested roles.
-     *
      * @param type - The model type string (e.g., 'profile', 'guestbook').
      * @param select - Selection params including key, roles, and optional use function.
      * @returns The result of the `use` function, or the roles reader if no `use` function is provided.
+     * @throws {Error} Throws {@link nestFirebaseDoesNotExistError} if the document does not exist.
+     * @throws {Error} Throws {@link nestFirebaseForbiddenPermissionError} if the caller lacks the requested roles.
      */
     useModel<T extends FirebaseModelsServiceTypes<Y>, O>(type: T, select: UseModelInput<FirebaseAppModelContext<A>, Y, T, O>): Promise<O>;
     useModel<T extends FirebaseModelsServiceTypes<Y>>(type: T, select: UseModelInputForRolesReader<FirebaseAppModelContext<A>, Y, T>): Promise<FirebaseModelsServiceSelectionResultRolesReader<Y, T>>;
@@ -114,9 +114,9 @@ export declare abstract class AbstractFirebaseNestContext<A, Y extends FirebaseM
      * {@link nestFirebaseForbiddenPermissionError}. These errors are captured per-key
      * and passed to the `use` function via the failure array (unless `throwOnFirstError` is true).
      *
-     * @param type - the model type to load
-     * @param select - selection params including keys array, roles, and use function
-     * @returns the result of the use function
+     * @param type - The model type to load.
+     * @param select - Selection params including keys array, roles, and use function.
+     * @returns The result of the use function.
      *
      * @example
      * ```ts

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

@@ -29,7 +29,7 @@ export declare class FirebaseServerStorageContextModule {
  *
  * @param input - A bucket ID string or full factory config object.
  * @returns A NestJS provider for the storage context factory config token.
- * @throws Error if `defaultBucketId` is empty.
+ * @throws {Error} If `defaultBucketId` is empty.
  *
  * @example
  * ```typescript
@@ -57,7 +57,7 @@ export type ProvideFirebaseServerStorageService<T extends FirebaseServerStorageS
  * so the service can also be injected by the abstract type.
  *
  * @param provider - The storage service provider configuration.
- * @returns An array of NestJS providers for the storage service.
+ * @returns Array of NestJS providers for the storage service.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function provideFirebaseServerStorageService<T extends FirebaseServerStorageService = FirebaseServerStorageService>(provider: ProvideFirebaseServerStorageService<T>): Provider<T>[];
@@ -71,10 +71,11 @@ export interface FirebaseServerStorageModuleMetadataConfig<T extends FirebaseSer
  * @param config - Optional configuration including a custom service provider and additional module metadata.
  * @returns NestJS module metadata ready to be passed to the `@Module()` decorator.
  *
- * @example
- * ```typescript
- * @Module(firebaseServerStorageModuleMetadata())
+ * @Module (firebaseServerStorageModuleMetadata())
  * export class AppStorageModule {}
  * ```
+ *
+ * @example
+ * ```typescript
  */
 export declare function firebaseServerStorageModuleMetadata<T extends FirebaseServerStorageService = FirebaseServerStorageService>(config?: FirebaseServerStorageModuleMetadataConfig<T>): ModuleMetadata;

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

@@ -4,16 +4,16 @@ import { type GetFilesOptions, type Storage as GoogleCloudStorage, type File as
 /**
  * Resolves a Google Cloud Storage {@link Bucket} from a {@link StoragePath}.
  *
- * @param storage - the Google Cloud Storage client instance.
- * @param path - the storage path containing the bucket ID.
+ * @param storage - The Google Cloud Storage client instance.
+ * @param path - The storage path containing the bucket ID.
  * @returns The resolved Google Cloud Storage bucket.
  */
 export declare function googleCloudStorageBucketForStorageFilePath(storage: GoogleCloudStorage, path: StoragePath): Bucket;
 /**
  * Resolves a Google Cloud Storage {@link GoogleCloudFile} from a {@link StoragePath}.
  *
- * @param storage - the Google Cloud Storage client instance.
- * @param path - the storage path containing bucket ID and file path.
+ * @param storage - The Google Cloud Storage client instance.
+ * @param path - The storage path containing bucket ID and file path.
  * @returns The resolved Google Cloud Storage file reference.
  */
 export declare function googleCloudStorageFileForStorageFilePath(storage: GoogleCloudStorage, path: StoragePath): GoogleCloudFile;
@@ -24,8 +24,8 @@ export type GoogleCloudStorageAccessorFile = FirebaseStorageAccessorFile<GoogleC
 /**
  * Converts Google Cloud Storage {@link FileMetadata} into the normalized {@link StorageMetadata} format.
  *
- * @param file - the Google Cloud Storage file reference.
- * @param metadata - the raw file metadata from the Google Cloud SDK.
+ * @param file - The Google Cloud Storage file reference.
+ * @param metadata - The raw file metadata from the Google Cloud SDK.
  * @returns Normalized storage metadata.
  */
 export declare function googleCloudFileMetadataToStorageMetadata(file: GoogleCloudFile, metadata: FileMetadata): StorageMetadata;
@@ -35,8 +35,8 @@ export declare function googleCloudFileMetadataToStorageMetadata(file: GoogleClo
  *
  * Handles emulator-specific edge cases (e.g., signing errors, atomic move fallback).
  *
- * @param storage - the Google Cloud Storage client instance.
- * @param storagePath - the storage path identifying the file's bucket and path.
+ * @param storage - The Google Cloud Storage client instance.
+ * @param storagePath - The storage path identifying the file's bucket and path.
  * @returns A file accessor with CRUD, streaming, and ACL operations.
  */
 export declare function googleCloudStorageAccessorFile(storage: GoogleCloudStorage, storagePath: StoragePath): GoogleCloudStorageAccessorFile;
@@ -66,8 +66,8 @@ export declare const googleCloudStorageListFilesResultFactory: import("@dereekb/
  * Creates a {@link GoogleCloudStorageAccessorFolder} that supports checking folder existence
  * and listing files/subfolders with pagination.
  *
- * @param storage - the Google Cloud Storage client instance.
- * @param storagePath - the storage path identifying the folder's bucket and prefix.
+ * @param storage - The Google Cloud Storage client instance.
+ * @param storagePath - The storage path identifying the folder's bucket and prefix.
  * @returns A folder accessor with existence checking and listing operations.
  */
 export declare function googleCloudStorageAccessorFolder(storage: GoogleCloudStorage, storagePath: StoragePath): GoogleCloudStorageAccessorFolder;

package/test/index.cjs.js

@@ -426,7 +426,7 @@ function _ts_generator$a(thisArg, body) {
      * @param fn - Wrapped gen 2 callable request to invoke.
      * @param params - Request payload to pass to the callable, simulating the JSON body of an HTTP call.
      * @param skipJsonConversion - When `true`, skip the JSON serialize/parse round-trip applied to `params` (default `false`).
-     * @returns A promise resolving to the callable's return value.
+     * @returns Promise resolving to the callable's return value.
      */ key: "callWrappedFunction",
             value: function callWrappedFunction(fn, params, skipJsonConversion) {
                 // Parse to JSON then back to simulate sending JSON to the server, and the server parsing it as a POJO.
@@ -462,7 +462,7 @@ function _ts_generator$a(thisArg, body) {
      * @param input.eventType - Discriminator for the auth event being simulated (`google.firebase.auth.user.create` or `google.firebase.auth.user.delete`).
      * @param input.eventOverride - Partial event fields used to override the default placeholder values (e.g., `ipAddress`, `userAgent`, `resource`).
      * @param input.skipJsonConversion - When `true`, skip the JSON serialize/parse round-trip applied to the event payload (default `false`).
-     * @returns A promise that resolves once the blocking function has completed.
+     * @returns Resolves once the blocking function has completed.
      */ key: "callAuthBlockingFunction",
             value: function callAuthBlockingFunction(input) {
                 var fn = input.fn, userRecord = input.userRecord, eventType = input.eventType, eventOverride = input.eventOverride, _input_skipJsonConversion = input.skipJsonConversion, skipJsonConversion = _input_skipJsonConversion === void 0 ? false : _input_skipJsonConversion;
@@ -486,13 +486,13 @@ function _ts_generator$a(thisArg, body) {
         },
         {
             /**
-     * @deprecated gen 1
-     *
      * @param fn
      * @param params
      * @param contextOptions
      * @param skipJsonConversion
      * @returns
+     *
+     * @deprecated gen 1
      */ // eslint-disable-next-line @typescript-eslint/max-params -- deprecated gen 1 signature kept for downstream compatibility
             key: "callEventCloudFunction",
             value: function callEventCloudFunction(fn, params, contextOptions) {
@@ -536,7 +536,7 @@ function _ts_generator$a(thisArg, body) {
  * custom claims, and post-create initialization) and tear it down afterward.
  *
  * @param config - Factory configuration: optional uid generator, custom fixture/instance constructors, user-detail builder, and `initUser` hook.
- * @returns A function that, given runtime params and a `buildTests` callback, wires the authorized-user fixture into the active test context.
+ * @returns Function that, given runtime params and a `buildTests` callback, wires the authorized-user fixture into the active test context.
  */ function authorizedUserContextFactory(config) {
     var uidGetter = config.uid, _config_makeInstance = config.makeInstance, makeInstance = _config_makeInstance === void 0 ? function(uid, testInstance) {
         return new AuthorizedUserTestContextInstance(uid, testInstance);
@@ -1147,7 +1147,7 @@ function _ts_generator$9(thisArg, body) {
  * build the test context instance, optionally initialize the document, and clean up after each test.
  *
  * @param config - Factory configuration that resolves the collection, optionally produces document refs, builds fixtures/instances, and tears down state.
- * @returns A function that, given runtime params and a `buildTests` callback, registers the model fixture hooks against the active test context.
+ * @returns Function that, given runtime params and a `buildTests` callback, registers the model fixture hooks against the active test context.
  *
  * @see {@link ModelTestContextFactoryParams} for configuration options
  */ function modelTestContextFactory(config) {
@@ -1309,7 +1309,7 @@ var adminEnvironmentInitialized = false;
  * so that each component can also
  *
  * @returns The test project ID that was re-applied to `FIREBASE_CONFIG`/`GCLOUD_PROJECT`.
- * @throws Error when no test project ID is present in the environment (i.e., {@link initFirebaseAdminTestEnvironment} has not been called).
+ * @throws {Error} When no test project ID is present in the environment (i.e., {@link initFirebaseAdminTestEnvironment} has not been called).
  */ function applyFirebaseGCloudTestProjectIdToFirebaseConfigEnv() {
     var _process_env_FIREBASE_CONFIG;
     // firebase-functions-test overwrites this each time.
@@ -2681,24 +2681,16 @@ function _ts_generator$5(thisArg, body) {
             return _async_to_generator$5(function() {
                 var _ref, request;
                 return _ts_generator$5(this, function(_state) {
-                    switch(_state.label){
-                        case 0:
-                            request = _object_spread_props$2(_object_spread$3({}, context), {
-                                data: data,
-                                // NOTE: These will typically not be used/available as they are express.js properties that are not available or useful to the handlers
-                                rawRequest: (_ref = context === null || context === void 0 ? void 0 : context.rawRequest) !== null && _ref !== void 0 ? _ref : {},
-                                acceptsStreaming: false
-                            });
-                            return [
-                                4,
-                                wrappedCloudFunction(request)
-                            ];
-                        case 1:
-                            return [
-                                2,
-                                _state.sent()
-                            ];
-                    }
+                    request = _object_spread_props$2(_object_spread$3({}, context), {
+                        data: data,
+                        // NOTE: These will typically not be used/available as they are express.js properties that are not available or useful to the handlers
+                        rawRequest: (_ref = context === null || context === void 0 ? void 0 : context.rawRequest) !== null && _ref !== void 0 ? _ref : {},
+                        acceptsStreaming: false
+                    });
+                    return [
+                        2,
+                        wrappedCloudFunction(request)
+                    ];
                 });
             })();
         };
@@ -2722,28 +2714,6 @@ function _ts_generator$5(thisArg, body) {
     };
     return wrapper;
 }
-/**
- * Creates a lazy getter that wraps a gen 1 cloud function for testing each time it is called.
- *
- * The returned getter re-wraps on every invocation, so it always reflects the latest function
- * reference from the provided getter — useful when the function under test is re-created between tests.
- *
- * @param wrapper - The cloud function wrapper providing gen 1 wrap support.
- * @param getter - Lazy accessor for the gen 1 cloud function under test; re-evaluated on every getter call.
- * @returns A getter that, when invoked, returns a freshly wrapped gen 1 cloud function ready for invocation in tests.
- *
- * @example
- * ```ts
- * const getWrapped = wrapCloudFunctionV1ForTests(wrapper, () => myV1Function);
- * const result = await getWrapped()({ /* event data *\/ });
- * ```
- *
- * @deprecated Prefer gen 2 functions and {@link wrapCloudFunctionV2ForTests} or {@link wrapCloudFunctionTests}.
- */ function wrapCloudFunctionV1ForTests(wrapper, getter) {
-    return function() {
-        return wrapper.wrapV1CloudFunction(getter());
-    };
-}
 /**
  * Creates a lazy getter that wraps a {@link CallableHttpFunction} for testing each time it is called.
  *
@@ -2764,6 +2734,28 @@ function _ts_generator$5(thisArg, body) {
         return wrapper.wrapCallableRequest(getter());
     };
 }
+/**
+ * Creates a lazy getter that wraps a gen 1 cloud function for testing each time it is called.
+ *
+ * The returned getter re-wraps on every invocation, so it always reflects the latest function
+ * reference from the provided getter — useful when the function under test is re-created between tests.
+ *
+ * @param wrapper - The cloud function wrapper providing gen 1 wrap support.
+ * @param getter - Lazy accessor for the gen 1 cloud function under test; re-evaluated on every getter call.
+ * @returns A getter that, when invoked, returns a freshly wrapped gen 1 cloud function ready for invocation in tests.
+ *
+ * @deprecated Prefer gen 2 functions and {@link wrapCloudFunctionV2ForTests} or {@link wrapCloudFunctionTests}.
+ *
+ * @example
+ * ```ts
+ * const getWrapped = wrapCloudFunctionV1ForTests(wrapper, () => myV1Function);
+ * const result = await getWrapped()({ /* event data *\/ });
+ * ```
+ */ function wrapCloudFunctionV1ForTests(wrapper, getter) {
+    return function() {
+        return wrapper.wrapV1CloudFunction(getter());
+    };
+}
 
 function _assert_this_initialized$4(self) {
     if (self === void 0) {
@@ -3034,7 +3026,7 @@ var functionsInitialized = false;
  * @param reroll - When `true`, generates a new project ID instead of reusing the current one.
  * @returns The initialized {@link FeaturesList} singleton.
  *
- * @throws Error if `initFirebaseAdminTestEnvironment()` has not been called.
+ * @throws {Error} If `initFirebaseAdminTestEnvironment()` has not been called.
  *
  * @example
  * ```ts
@@ -4908,18 +4900,17 @@ function _ts_generator$1(thisArg, body) {
  * @returns The space-separated scope string to pass to the `/oidc/auth` endpoint.
  */ function resolveScopes(nestApp, config) {
     return _async_to_generator$1(function() {
-        var accountService;
+        var result, accountService;
         return _ts_generator$1(this, function(_state) {
             if (config === null || config === void 0 ? void 0 : config.scopes) {
-                return [
-                    2,
-                    config.scopes
-                ];
+                result = config.scopes;
+            } else {
+                accountService = nestApp.get(oidc.OidcAccountService);
+                result = Object.keys(accountService.providerConfig.claims).join(' ');
             }
-            accountService = nestApp.get(oidc.OidcAccountService);
             return [
                 2,
-                Object.keys(accountService.providerConfig.claims).join(' ')
+                result
             ];
         });
     })();
@@ -4936,7 +4927,7 @@ function _ts_generator$1(thisArg, body) {
  * @param input.uid - Firebase user ID for whom the test ID token is minted and the OAuth flow is authorized.
  * @param input.config - Optional flow overrides (scopes, redirect URI, client name, token endpoint auth method).
  * @returns The exchanged access token and ID token from the OIDC `/token` endpoint.
- * @throws Error when the token exchange step fails (the response body and status are included in the message).
+ * @throws {Error} When the token exchange step fails (the response body and status are included in the message).
  */ function performFullOAuthFlow(input) {
     return _async_to_generator$1(function() {
         var _ref, _ref1, _ref2, server, oidcClientService, nestApp, uid, config, _createCookieJar, collectCookies, cookieHeader, redirectUri, clientName, tokenEndpointAuthMethod, scopes, _ref3, client_id, client_secret, codeVerifier, codeChallenge, authRes, loginUid, idToken, loginRes, resumeAfterLoginPath, consentRedirectRes, consentUid, consentRes, resumeAfterConsentPath, callbackRedirectRes, callbackUrl, authorizationCode, tokenRes;
@@ -5471,7 +5462,7 @@ function _ts_generator(thisArg, body) {
  * and provides an authenticated supertest agent and helper methods.
  *
  * @param config - Optional flow overrides (scopes, redirect URI, client name, timeout) and custom fixture/instance constructors.
- * @returns A function that, given parent fixtures and a `buildTests` callback, registers a `describe('(oauth)', ...)` block which performs the full OAuth flow and exposes the authenticated supertest fixture.
+ * @returns Function that, given parent fixtures and a `buildTests` callback, registers a `describe('(oauth)', ...)` block which performs the full OAuth flow and exposes the authenticated supertest fixture.
  *
  * @example
  * ```typescript