@dereekb/firebase-server 13.6.10 → 13.6.12

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

@@ -89,6 +89,31 @@ export declare abstract class AbstractFirebaseNestContext<A, Y extends FirebaseM
     model(context: AuthDataRef, buildFn?: BuildFunction<FirebaseAppModelContext<A>>): InContextFirebaseModelsService<Y>;
     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>>;
+    /**
+     * Loads and checks permissions for multiple models of the same type in parallel.
+     *
+     * Uses {@link performAsyncTasks} internally. The `use` function receives the array of
+     * successful {@link ContextGrantedModelRolesReader} values and an array of failed items.
+     *
+     * @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
+     * const result = await nest.useMultipleModels('storageFile', {
+     *   request,
+     *   keys: ['storageFile/abc', 'storageFile/def'],
+     *   roles: 'download',
+     *   throwOnFirstError: false,
+     *   use: (successful, failed) => ({
+     *     documents: successful.map((r) => r.document),
+     *     errors: failed
+     *   })
+     * });
+     * ```
+     */
+    useMultipleModels<T extends FirebaseModelsServiceTypes<Y>, O>(type: T, select: UseMultipleModelsInput<FirebaseAppModelContext<A>, Y, T, O>): Promise<O>;
 }
 /**
  * Input for {@link AbstractFirebaseNestContext.useModel} when only a roles reader is needed (no custom use function).
@@ -103,3 +128,60 @@ export type UseModelInputForRolesReader<C extends FirebaseModelServiceContext, Y
 export type UseModelInput<C extends FirebaseModelServiceContext, Y extends FirebaseModelsService<any, C>, T extends FirebaseModelsServiceTypes<Y>, O> = UseModelInputForRolesReader<C, Y, T> & {
     readonly use: UseFirebaseModelsServiceSelectionUseFunction<Y, T, O>;
 };
+/**
+ * Extracts the key type from a {@link UseFirebaseModelsServiceSelection} for a given model type.
+ */
+export type UseFirebaseModelsServiceSelectionKeyType<Y extends FirebaseModelsService<any, any>, T extends FirebaseModelsServiceTypes<Y>> = UseFirebaseModelsServiceSelection<Y, T> extends {
+    key: infer K;
+} ? K : never;
+/**
+ * Input for {@link AbstractFirebaseNestContext.useMultipleModels}.
+ *
+ * Takes an array of keys and a `use` function that receives the successful roles readers
+ * and a {@link UseMultipleModelsFailure} describing any errors. Shared `roles` and `rolesSetIncludes` apply to all keys.
+ */
+export type UseMultipleModelsInput<C extends FirebaseModelServiceContext, Y extends FirebaseModelsService<any, C>, T extends FirebaseModelsServiceTypes<Y>, O> = Omit<UseModelInputForRolesReader<C, Y, T>, 'key'> & {
+    readonly keys: UseFirebaseModelsServiceSelectionKeyType<Y, T>[];
+    readonly use: UseMultipleModelsUseFunction<Y, T, O>;
+    /**
+     * When true, throws the first error directly without calling `use`.
+     *
+     * Defaults to true (unless `useOnFirstError` is set).
+     */
+    readonly throwOnFirstError?: boolean;
+    /**
+     * When true, calls `use` on the first error with an empty successful array
+     * and `abortedEarly: true` in the failure object.
+     *
+     * Takes precedence over `throwOnFirstError` when both are set.
+     */
+    readonly useOnFirstError?: boolean;
+};
+/**
+ * Use function for {@link UseMultipleModelsInput}.
+ *
+ * Receives the successful roles readers and a failure object containing any errors.
+ */
+export type UseMultipleModelsUseFunction<Y extends FirebaseModelsService<any, any>, T extends FirebaseModelsServiceTypes<Y>, O> = (successful: FirebaseModelsServiceSelectionResultRolesReader<Y, T>[], failure: UseMultipleModelsFailure<Y, T>) => Promise<O> | O;
+/**
+ * Failure information passed to the {@link UseMultipleModelsUseFunction}.
+ *
+ * Contains the array of failed items and whether the operation was aborted early
+ * (via `useOnFirstError`) before all keys were processed.
+ */
+export interface UseMultipleModelsFailure<Y extends FirebaseModelsService<any, any>, T extends FirebaseModelsServiceTypes<Y>> {
+    readonly errors: UseMultipleModelsFailedItem<Y, T>[];
+    /**
+     * True when the operation was aborted on the first error (via `useOnFirstError`).
+     *
+     * When true, the successful array will be empty and not all keys may have been attempted.
+     */
+    readonly abortedEarly: boolean;
+}
+/**
+ * Represents a key that failed permission checking in {@link AbstractFirebaseNestContext.useMultipleModels}.
+ */
+export interface UseMultipleModelsFailedItem<Y extends FirebaseModelsService<any, any>, T extends FirebaseModelsServiceTypes<Y>> {
+    readonly key: UseFirebaseModelsServiceSelectionKeyType<Y, T>;
+    readonly error: unknown;
+}

package/test/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@dereekb/firebase-server/test",
-  "version": "13.6.10",
+  "version": "13.6.12",
   "peerDependencies": {
-    "@dereekb/analytics": "13.6.10",
-    "@dereekb/date": "13.6.10",
-    "@dereekb/firebase": "13.6.10",
-    "@dereekb/firebase-server": "13.6.10",
-    "@dereekb/model": "13.6.10",
-    "@dereekb/nestjs": "13.6.10",
-    "@dereekb/rxjs": "13.6.10",
-    "@dereekb/util": "13.6.10",
+    "@dereekb/analytics": "13.6.12",
+    "@dereekb/date": "13.6.12",
+    "@dereekb/firebase": "13.6.12",
+    "@dereekb/firebase-server": "13.6.12",
+    "@dereekb/model": "13.6.12",
+    "@dereekb/nestjs": "13.6.12",
+    "@dereekb/rxjs": "13.6.12",
+    "@dereekb/util": "13.6.12",
     "@google-cloud/firestore": "^7.11.6",
     "@google-cloud/storage": "^7.19.0",
     "@nestjs/common": "^11.1.17",
@@ -21,7 +21,7 @@
     "make-error": "^1.3.0"
   },
   "devDependencies": {
-    "@dereekb/nestjs": "13.6.10"
+    "@dereekb/nestjs": "13.6.12"
   },
   "exports": {
     "./package.json": "./package.json",

package/zoho/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@dereekb/firebase-server/zoho",
-  "version": "13.6.10",
+  "version": "13.6.12",
   "peerDependencies": {
-    "@dereekb/analytics": "13.6.10",
-    "@dereekb/date": "13.6.10",
-    "@dereekb/model": "13.6.10",
-    "@dereekb/nestjs": "13.6.10",
-    "@dereekb/rxjs": "13.6.10",
-    "@dereekb/firebase": "13.6.10",
-    "@dereekb/util": "13.6.10",
-    "@dereekb/zoho": "13.6.10"
+    "@dereekb/analytics": "13.6.12",
+    "@dereekb/date": "13.6.12",
+    "@dereekb/model": "13.6.12",
+    "@dereekb/nestjs": "13.6.12",
+    "@dereekb/rxjs": "13.6.12",
+    "@dereekb/firebase": "13.6.12",
+    "@dereekb/util": "13.6.12",
+    "@dereekb/zoho": "13.6.12"
   },
   "exports": {
     "./package.json": "./package.json",