@dereekb/firebase-server 13.6.10 → 13.6.12

package/mailgun/package.json

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

package/model/index.cjs.js

@@ -7192,7 +7192,7 @@ function _inherits(subClass, superClass) {
     });
     if (superClass) _set_prototype_of(subClass, superClass);
 }
-function _instanceof(left, right) {
+function _instanceof$1(left, right) {
     if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
         return !!right[Symbol.hasInstance](left);
     } else {
@@ -7577,7 +7577,7 @@ function _ts_generator$5(thisArg, body) {
                                 ];
                             case 4:
                                 e = _state.sent();
-                                if (_instanceof(e, NotificationTaskSubTaskMissingRequiredDataTermination)) {
+                                if (_instanceof$1(e, NotificationTaskSubTaskMissingRequiredDataTermination)) {
                                     // Task is complete if the required data no longer exists. Nothing to cleanup.
                                     result = firebase.notificationTaskComplete();
                                 } else {
@@ -8017,6 +8017,13 @@ function _define_property$4(obj, key, value) {
     }
     return obj;
 }
+function _instanceof(left, right) {
+    if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
+        return !!right[Symbol.hasInstance](left);
+    } else {
+        return left instanceof right;
+    }
+}
 function _iterable_to_array_limit(arr, i) {
     var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
     if (_i == null) return;
@@ -8240,6 +8247,7 @@ function _ts_generator$4(thisArg, body) {
         deleteAllQueuedStorageFiles: deleteAllQueuedStorageFilesFactory(context),
         deleteStorageFile: deleteStorageFileFactory(context),
         downloadStorageFile: downloadStorageFileFactory(context),
+        downloadMultipleStorageFiles: downloadMultipleStorageFilesFactory(context),
         createStorageFileGroup: createStorageFileGroupFactory(context),
         updateStorageFileGroup: updateStorageFileGroupFactory(context),
         syncStorageFileWithGroups: syncStorageFileWithGroupsFactory(context),
@@ -9467,91 +9475,172 @@ function _ts_generator$4(thisArg, body) {
         })();
     });
 }
+/**
+ * Default maximum number of concurrent download operations when batch-downloading StorageFiles.
+ */ var DEFAULT_DOWNLOAD_MULTIPLE_STORAGE_FILES_MAX_PARALLEL_TASKS = 5;
+/**
+ * Internal factory that generates signed download URLs for one or more StorageFiles.
+ *
+ * Uses {@link performAsyncTasks} with concurrency limiting to avoid overwhelming Cloud Storage.
+ * Shared expiration/disposition/content-type options are applied uniformly to all items.
+ * When `throwOnFirstError` is true, the first failure throws immediately (single-download behavior).
+ * When false, failures are collected in the errors array (batch behavior).
+ *
+ * @param context - the storage file server actions context
+ * @returns an async function that processes a {@link DownloadMultipleStorageFilesFactoryInput} and returns a {@link DownloadMultipleStorageFilesResult}
+ */ function _downloadMultipleStorageFilesFactory(context) {
+    var storageService = context.storageService, storageFileCollection = context.storageFileCollection;
+    return function(input) {
+        return _async_to_generator$4(function() {
+            var items, asAdmin, expiresAt, inputExpiresIn, responseDisposition, responseContentType, throwOnFirstError, inputMaxParallelTasks, taskResult, success, errors;
+            return _ts_generator$4(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        items = input.items, asAdmin = input.asAdmin, expiresAt = input.expiresAt, inputExpiresIn = input.expiresIn, responseDisposition = input.responseDisposition, responseContentType = input.responseContentType, throwOnFirstError = input.throwOnFirstError, inputMaxParallelTasks = input.maxParallelTasks;
+                        return [
+                            4,
+                            util.performAsyncTasks(items, function(item) {
+                                return _async_to_generator$4(function() {
+                                    var _item_storageFileDocument, _item_responseDisposition, _item_responseContentType, _ref, _item_expiresIn, _item_expiresAt, storageFileDocument, storageFile, fileAccessor, itemResponseDisposition, itemResponseContentType, expiresIn, expires, downloadUrlExpiresAt, maxExpirationDate, _ref1, downloadUrl, metadata;
+                                    return _ts_generator$4(this, function(_state) {
+                                        switch(_state.label){
+                                            case 0:
+                                                // Load document from key if not provided
+                                                storageFileDocument = (_item_storageFileDocument = item.storageFileDocument) !== null && _item_storageFileDocument !== void 0 ? _item_storageFileDocument : storageFileCollection.documentAccessor().loadDocumentForKey(item.key);
+                                                return [
+                                                    4,
+                                                    firebaseServer.assertSnapshotData(storageFileDocument)
+                                                ];
+                                            case 1:
+                                                storageFile = _state.sent();
+                                                fileAccessor = storageService.file(storageFile);
+                                                if (!fileAccessor.getSignedUrl) {
+                                                    throw firebaseServer.internalServerError('Signed url function appears to not be available.');
+                                                }
+                                                // Per-item options override defaults
+                                                itemResponseDisposition = (_item_responseDisposition = item.responseDisposition) !== null && _item_responseDisposition !== void 0 ? _item_responseDisposition : responseDisposition;
+                                                itemResponseContentType = (_item_responseContentType = item.responseContentType) !== null && _item_responseContentType !== void 0 ? _item_responseContentType : responseContentType;
+                                                expiresIn = (_ref = (_item_expiresIn = item.expiresIn) !== null && _item_expiresIn !== void 0 ? _item_expiresIn : inputExpiresIn) !== null && _ref !== void 0 ? _ref : util.MS_IN_MINUTE * 30;
+                                                expires = util.expirationDetails({
+                                                    defaultExpiresFromDateToNow: true,
+                                                    expiresAt: (_item_expiresAt = item.expiresAt) !== null && _item_expiresAt !== void 0 ? _item_expiresAt : expiresAt,
+                                                    expiresIn: expiresIn
+                                                });
+                                                downloadUrlExpiresAt = expires.getExpirationDate(); // always returns a Date when defaultExpiresFromDateToNow and expiresIn are set
+                                                // if they're not an admin, limit the expiration to a max of 30 days.
+                                                if (!asAdmin) {
+                                                    maxExpirationDate = dateFns.addDays(new Date(), 30);
+                                                    downloadUrlExpiresAt = date.findMinDate([
+                                                        downloadUrlExpiresAt,
+                                                        maxExpirationDate
+                                                    ]);
+                                                }
+                                                return [
+                                                    4,
+                                                    Promise.all([
+                                                        fileAccessor.getSignedUrl({
+                                                            action: 'read',
+                                                            expiresAt: downloadUrlExpiresAt,
+                                                            responseDisposition: itemResponseDisposition !== null && itemResponseDisposition !== void 0 ? itemResponseDisposition : undefined,
+                                                            responseType: asAdmin ? itemResponseContentType !== null && itemResponseContentType !== void 0 ? itemResponseContentType : undefined : undefined // can only be set by admins
+                                                        }),
+                                                        fileAccessor.getMetadata()
+                                                    ])
+                                                ];
+                                            case 2:
+                                                _ref1 = _sliced_to_array.apply(void 0, [
+                                                    _state.sent(),
+                                                    2
+                                                ]), downloadUrl = _ref1[0], metadata = _ref1[1];
+                                                return [
+                                                    2,
+                                                    {
+                                                        key: item.key,
+                                                        url: downloadUrl,
+                                                        fileName: metadata.name ? util.slashPathDetails(metadata.name).end : undefined,
+                                                        mimeType: itemResponseContentType !== null && itemResponseContentType !== void 0 ? itemResponseContentType : metadata.contentType,
+                                                        expiresAt: util.unixDateTimeSecondsNumberFromDate(downloadUrlExpiresAt)
+                                                    }
+                                                ];
+                                        }
+                                    });
+                                })();
+                            }, {
+                                throwError: throwOnFirstError !== null && throwOnFirstError !== void 0 ? throwOnFirstError : false,
+                                maxParallelTasks: inputMaxParallelTasks !== null && inputMaxParallelTasks !== void 0 ? inputMaxParallelTasks : DEFAULT_DOWNLOAD_MULTIPLE_STORAGE_FILES_MAX_PARALLEL_TASKS
+                            })
+                        ];
+                    case 1:
+                        taskResult = _state.sent();
+                        success = taskResult.results.map(function(param) {
+                            var _param = _sliced_to_array(param, 2), result = _param[1];
+                            return result;
+                        });
+                        errors = taskResult.errors.map(function(param) {
+                            var _param = _sliced_to_array(param, 2), item = _param[0], error = _param[1];
+                            return {
+                                key: item.key,
+                                error: _instanceof(error, Error) ? error.message : 'Download failed'
+                            };
+                        });
+                        return [
+                            2,
+                            {
+                                success: success,
+                                errors: errors
+                            }
+                        ];
+                }
+            });
+        })();
+    };
+}
 /**
  * Factory for the `downloadStorageFile` action.
  *
  * Generates a signed download URL for a {@link StorageFile}'s associated Cloud Storage file.
- * The URL expires after the configured duration. Supports loading the storage file document
- * by key if not provided directly.
+ * Delegates to {@link _downloadMultipleStorageFilesFactory} with a single item and `throwOnFirstError: true`.
  *
  * @param context - the storage file server actions context
  * @returns an async transform-and-validate function that generates a signed download URL
  */ function downloadStorageFileFactory(context) {
-    var storageService = context.storageService, firebaseServerActionTransformFunctionFactory = context.firebaseServerActionTransformFunctionFactory, storageFileCollection = context.storageFileCollection;
+    var firebaseServerActionTransformFunctionFactory = context.firebaseServerActionTransformFunctionFactory;
+    var downloadMultipleStorageFiles = _downloadMultipleStorageFilesFactory(context);
     return firebaseServerActionTransformFunctionFactory(firebase.downloadStorageFileParamsType, function(params) {
         return _async_to_generator$4(function() {
-            var targetStorageFileDocumentKey, asAdmin, expiresAt, inputExpiresIn, responseDisposition, responseContentType;
+            var key, asAdmin, expiresAt, expiresIn, responseDisposition, responseContentType;
             return _ts_generator$4(this, function(_state) {
-                targetStorageFileDocumentKey = params.key, asAdmin = params.asAdmin, expiresAt = params.expiresAt, inputExpiresIn = params.expiresIn, responseDisposition = params.responseDisposition, responseContentType = params.responseContentType;
+                key = params.key, asAdmin = params.asAdmin, expiresAt = params.expiresAt, expiresIn = params.expiresIn, responseDisposition = params.responseDisposition, responseContentType = params.responseContentType;
                 return [
                     2,
                     function(storageFileDocument) {
                         return _async_to_generator$4(function() {
-                            var storageFile, fileAccessor, result, expiresIn, expires, downloadUrlExpiresAt, maxExpirationDate, _ref, downloadUrl, metadata;
+                            var result;
                             return _ts_generator$4(this, function(_state) {
                                 switch(_state.label){
                                     case 0:
-                                        // if the StorageFileDocument was not provided, set it from the target key
-                                        storageFileDocument !== null && storageFileDocument !== void 0 ? storageFileDocument : storageFileDocument = storageFileCollection.documentAccessor().loadDocumentForKey(targetStorageFileDocumentKey);
                                         return [
                                             4,
-                                            firebaseServer.assertSnapshotData(storageFileDocument)
+                                            downloadMultipleStorageFiles({
+                                                items: [
+                                                    {
+                                                        key: key,
+                                                        storageFileDocument: storageFileDocument
+                                                    }
+                                                ],
+                                                asAdmin: asAdmin,
+                                                expiresAt: expiresAt,
+                                                expiresIn: expiresIn,
+                                                responseDisposition: responseDisposition,
+                                                responseContentType: responseContentType,
+                                                throwOnFirstError: true
+                                            })
                                         ];
                                     case 1:
-                                        storageFile = _state.sent();
-                                        fileAccessor = storageService.file(storageFile);
-                                        if (!fileAccessor.getSignedUrl) return [
-                                            3,
-                                            3
-                                        ];
-                                        expiresIn = inputExpiresIn !== null && inputExpiresIn !== void 0 ? inputExpiresIn : util.MS_IN_MINUTE * 30;
-                                        expires = util.expirationDetails({
-                                            defaultExpiresFromDateToNow: true,
-                                            expiresAt: expiresAt,
-                                            expiresIn: expiresIn
-                                        });
-                                        downloadUrlExpiresAt = expires.getExpirationDate(); // always returns a Date when defaultExpiresFromDateToNow and expiresIn are set
-                                        // if they're not an admin, limit the expiration to a max of 30 days.
-                                        if (!asAdmin) {
-                                            maxExpirationDate = dateFns.addDays(new Date(), 30);
-                                            downloadUrlExpiresAt = date.findMinDate([
-                                                downloadUrlExpiresAt,
-                                                maxExpirationDate
-                                            ]);
-                                        }
-                                        return [
-                                            4,
-                                            Promise.all([
-                                                fileAccessor.getSignedUrl({
-                                                    action: 'read',
-                                                    expiresAt: downloadUrlExpiresAt,
-                                                    responseDisposition: responseDisposition !== null && responseDisposition !== void 0 ? responseDisposition : undefined,
-                                                    responseType: asAdmin ? responseContentType !== null && responseContentType !== void 0 ? responseContentType : undefined : undefined // can only be set by admins
-                                                }),
-                                                fileAccessor.getMetadata()
-                                            ])
-                                        ];
-                                    case 2:
-                                        _ref = _sliced_to_array.apply(void 0, [
-                                            _state.sent(),
-                                            2
-                                        ]), downloadUrl = _ref[0], metadata = _ref[1];
-                                        result = {
-                                            url: downloadUrl,
-                                            fileName: metadata.name ? util.slashPathDetails(metadata.name).end : undefined,
-                                            mimeType: responseContentType !== null && responseContentType !== void 0 ? responseContentType : metadata.contentType,
-                                            expiresAt: util.unixDateTimeSecondsNumberFromDate(downloadUrlExpiresAt)
-                                        };
-                                        return [
-                                            3,
-                                            4
-                                        ];
-                                    case 3:
-                                        throw firebaseServer.internalServerError('Signed url function appears to not be avalable.');
-                                    case 4:
+                                        result = _state.sent();
                                         return [
                                             2,
-                                            result
+                                            result.success[0]
                                         ];
                                 }
                             });
@@ -9562,6 +9651,59 @@ function _ts_generator$4(thisArg, body) {
         })();
     });
 }
+/**
+ * Factory for the `downloadMultipleStorageFiles` action.
+ *
+ * Generates signed download URLs for multiple {@link StorageFile} documents in a single call.
+ * By default, individual failures are collected in the errors array rather than failing the entire batch.
+ * Set `throwOnFirstError` in params to throw on the first failure instead.
+ *
+ * @param context - the storage file server actions context
+ * @returns an async transform-and-validate function that generates signed download URLs for multiple files
+ */ function downloadMultipleStorageFilesFactory(context) {
+    var firebaseServerActionTransformFunctionFactory = context.firebaseServerActionTransformFunctionFactory;
+    var downloadMultipleStorageFiles = _downloadMultipleStorageFilesFactory(context);
+    return firebaseServerActionTransformFunctionFactory(firebase.downloadMultipleStorageFilesParamsType, function(params) {
+        return _async_to_generator$4(function() {
+            var files, asAdmin, expiresAt, expiresIn, responseDisposition, responseContentType, throwOnFirstError;
+            return _ts_generator$4(this, function(_state) {
+                files = params.files, asAdmin = params.asAdmin, expiresAt = params.expiresAt, expiresIn = params.expiresIn, responseDisposition = params.responseDisposition, responseContentType = params.responseContentType, throwOnFirstError = params.throwOnFirstError;
+                return [
+                    2,
+                    function(storageFileDocuments) {
+                        return _async_to_generator$4(function() {
+                            var items;
+                            return _ts_generator$4(this, function(_state) {
+                                items = files.map(function(file, i) {
+                                    return {
+                                        key: file.key,
+                                        storageFileDocument: storageFileDocuments === null || storageFileDocuments === void 0 ? void 0 : storageFileDocuments[i],
+                                        expiresAt: file.expiresAt,
+                                        expiresIn: file.expiresIn,
+                                        responseDisposition: file.responseDisposition,
+                                        responseContentType: file.responseContentType
+                                    };
+                                });
+                                return [
+                                    2,
+                                    downloadMultipleStorageFiles({
+                                        items: items,
+                                        asAdmin: asAdmin,
+                                        expiresAt: expiresAt,
+                                        expiresIn: expiresIn,
+                                        responseDisposition: responseDisposition,
+                                        responseContentType: responseContentType,
+                                        throwOnFirstError: throwOnFirstError !== null && throwOnFirstError !== void 0 ? throwOnFirstError : false
+                                    })
+                                ];
+                            });
+                        })();
+                    }
+                ];
+            });
+        })();
+    });
+}
 /**
  * Internal factory that creates a function for creating a {@link StorageFileGroup} document
  * within a Firestore transaction.
@@ -12419,6 +12561,7 @@ function _ts_generator(thisArg, body) {
 
 exports.BASE_NOTIFICATION_SERVER_ACTION_CONTEXT_TOKEN = BASE_NOTIFICATION_SERVER_ACTION_CONTEXT_TOKEN;
 exports.BASE_STORAGE_FILE_SERVER_ACTION_CONTEXT_TOKEN = BASE_STORAGE_FILE_SERVER_ACTION_CONTEXT_TOKEN;
+exports.DEFAULT_DOWNLOAD_MULTIPLE_STORAGE_FILES_MAX_PARALLEL_TASKS = DEFAULT_DOWNLOAD_MULTIPLE_STORAGE_FILES_MAX_PARALLEL_TASKS;
 exports.KNOWN_BUT_UNCONFIGURED_NOTIFICATION_TEMPLATE_TYPE_DELETE_AFTER_RETRY_ATTEMPTS = KNOWN_BUT_UNCONFIGURED_NOTIFICATION_TEMPLATE_TYPE_DELETE_AFTER_RETRY_ATTEMPTS;
 exports.KNOWN_BUT_UNCONFIGURED_NOTIFICATION_TEMPLATE_TYPE_HOURS_DELAY = KNOWN_BUT_UNCONFIGURED_NOTIFICATION_TEMPLATE_TYPE_HOURS_DELAY;
 exports.MAILGUN_NOTIFICATION_EMAIL_SEND_SERVICE_DEFAULT_MAX_BATCH_SIZE_PER_REQUEST = MAILGUN_NOTIFICATION_EMAIL_SEND_SERVICE_DEFAULT_MAX_BATCH_SIZE_PER_REQUEST;
@@ -12469,6 +12612,7 @@ exports.createStorageFileGroupInTransactionFactory = createStorageFileGroupInTra
 exports.createStorageFileGroupInputError = createStorageFileGroupInputError;
 exports.deleteAllQueuedStorageFilesFactory = deleteAllQueuedStorageFilesFactory;
 exports.deleteStorageFileFactory = deleteStorageFileFactory;
+exports.downloadMultipleStorageFilesFactory = downloadMultipleStorageFilesFactory;
 exports.downloadStorageFileFactory = downloadStorageFileFactory;
 exports.expandNotificationRecipients = expandNotificationRecipients;
 exports.exportMutableNotificationExpediteService = exportMutableNotificationExpediteService;