@dereekb/firebase-server 12.5.8 → 12.5.10

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [12.5.10](https://github.com/dereekb/dbx-components/compare/v12.5.9-dev...v12.5.10) (2025-11-21)
+
+
+
+## [12.5.9](https://github.com/dereekb/dbx-components/compare/v12.5.8-dev...v12.5.9) (2025-11-16)
+
+
+
 ## [12.5.8](https://github.com/dereekb/dbx-components/compare/v12.5.7-dev...v12.5.8) (2025-11-06)
 
 

package/mailgun/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase-server/mailgun",
-  "version": "12.5.8",
+  "version": "12.5.10",
   "type": "commonjs",
   "peerDependencies": {
     "mailgun.js": "^12.0.0"

package/model/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase-server/model",
-  "version": "12.5.8",
+  "version": "12.5.10",
   "type": "commonjs",
   "types": "./src/index.d.ts",
   "main": "./src/index.js"

package/model/src/lib/notification/index.d.ts

@@ -9,6 +9,7 @@ export * from './notification.send.service';
 export * from './notification.send';
 export * from './notification.task.service';
 export * from './notification.task.service.handler';
+export * from './notification.task.subtask.handler';
 export * from './notification.error';
 export * from './notification.expedite.service';
 export * from './notification.util';

package/model/src/lib/notification/index.js

@@ -12,6 +12,7 @@ tslib_1.__exportStar(require("./notification.send.service"), exports);
 tslib_1.__exportStar(require("./notification.send"), exports);
 tslib_1.__exportStar(require("./notification.task.service"), exports);
 tslib_1.__exportStar(require("./notification.task.service.handler"), exports);
+tslib_1.__exportStar(require("./notification.task.subtask.handler"), exports);
 tslib_1.__exportStar(require("./notification.error"), exports);
 tslib_1.__exportStar(require("./notification.expedite.service"), exports);
 tslib_1.__exportStar(require("./notification.util"), exports);

package/model/src/lib/notification/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/model/src/lib/notification/index.ts"],"names":[],"mappings":";;;AAAA,uEAA6C;AAC7C,4EAAkD;AAClD,wEAA8C;AAC9C,gEAAsC;AACtC,gEAAsC;AACtC,0FAAgE;AAChE,2EAAiD;AACjD,sEAA4C;AAC5C,8DAAoC;AACpC,sEAA4C;AAC5C,8EAAoD;AACpD,+DAAqC;AACrC,0EAAgD;AAChD,8DAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/model/src/lib/notification/index.ts"],"names":[],"mappings":";;;AAAA,uEAA6C;AAC7C,4EAAkD;AAClD,wEAA8C;AAC9C,gEAAsC;AACtC,gEAAsC;AACtC,0FAAgE;AAChE,2EAAiD;AACjD,sEAA4C;AAC5C,8DAAoC;AACpC,sEAA4C;AAC5C,8EAAoD;AACpD,8EAAoD;AACpD,+DAAqC;AACrC,0EAAgD;AAChD,8DAAoC"}

package/model/src/lib/notification/notification.task.subtask.handler.d.ts

@@ -0,0 +1,215 @@
+import { type NotificationTaskSubtaskTarget, type NotificationTask, type NotificationTaskServiceHandleNotificationTaskResult, type NotificationTaskSubtaskMetadata, type NotificationTaskSubtaskCheckpointString, type NotificationTaskSubtaskData, type NotificationTaskSubtaskCheckpoint, type NotificationTaskType } from '@dereekb/firebase';
+import { type NotificationTaskServiceTaskHandlerConfig } from '../notification/notification.task.service.handler';
+import { type Maybe, type MaybeSo, type Milliseconds, type PromiseOrValue } from '@dereekb/util';
+import { BaseError } from 'make-error';
+/**
+ * A NotificationTask with a set data value.
+ */
+export type NotificationTaskSubtaskInputTask<D extends NotificationTaskSubtaskData> = Omit<NotificationTask<D>, 'data'> & {
+    readonly data: MaybeSo<NotificationTask<D>['data']>;
+};
+/**
+ * Input for a generic NotificationTaskSubtask
+ */
+export interface NotificationTaskSubtaskInput<D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> {
+    /**
+     * The retrieved target.
+     */
+    readonly target: NotificationTaskSubtaskTarget;
+    /**
+     * The root NotificationTask.
+     *
+     * The data is always guranteed.
+     */
+    readonly notificationTask: NotificationTaskSubtaskInputTask<D>;
+    /**
+     * List of completed subtasks.
+     */
+    readonly completedSubtasks: S[];
+    /**
+     * The current metadata for the subtask.
+     */
+    readonly subtaskData?: Maybe<M>;
+}
+/**
+ * Result of a NotificationTaskSubtask.
+ */
+export type NotificationTaskSubtaskResult<M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> = NotificationTaskServiceHandleNotificationTaskResult<M, S>;
+/**
+ * A NotificationTaskSubtask is a function that handles a specific NotificationTaskSubtaskTarget subtask.
+ */
+export type NotificationTaskSubtask<I extends NotificationTaskSubtaskInput<D, M, S>, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> = (input: I) => Promise<NotificationTaskSubtaskResult<M, S>>;
+/**
+ * Similar to NotificationTaskServiceTaskHandlerFlowEntry, but used in NotificationTaskSubtaskProcessorConfig as part of the flow.
+ */
+export interface NotificationTaskSubtaskFlowEntry<I extends NotificationTaskSubtaskInput<D, M, S>, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> {
+    /**
+     * The subtask this flow entry represents.
+     */
+    readonly subtask: S;
+    /**
+     * The subtask function
+     */
+    readonly fn: NotificationTaskSubtask<I, D, M, S>;
+}
+/**
+ * The base output cleanup configuration.
+ */
+export interface NotificationTaskSubtaskCleanupInstructions {
+    /**
+     * Whether or not the cleanup was successful. If false, the task will be delayed until the cleanup can be retried.
+     *
+     * Defaults to true.
+     */
+    readonly cleanupSuccess?: boolean;
+    /**
+     * How long to delay the retry of the cleanup after cleanup fails.
+     *
+     * Ignored if cleanupSuccess is not false.
+     */
+    readonly delayRetryUntil?: NotificationTaskServiceHandleNotificationTaskResult['delayUntil'];
+}
+/**
+ * Cleanup function for a NotificationTaskSubtask.
+ *
+ * This is called during the cleanup step.
+ */
+export type NotificationTaskSubtaskCleanupInstructionsFunction<I extends NotificationTaskSubtaskInput<D, M, S>, CUI extends NotificationTaskSubtaskCleanupInstructions, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> = (input: NotificationTaskSubtaskCleanupFunctionInput<I, D, M, S>) => CUI;
+/**
+ * The actual cleanup function to execute using the input and instructions.
+ */
+export type NotificationTaskSubtaskCleanupFunction<I extends NotificationTaskSubtaskInput<D, M, S>, CUI extends NotificationTaskSubtaskCleanupInstructions, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> = (input: NotificationTaskSubtaskCleanupFunctionInput<I, D, M, S>, cleanupInstructions: CUI) => Promise<NotificationTaskServiceHandleNotificationTaskResult<D, NotificationTaskSubtaskCheckpoint>>;
+/**
+ * The input function result may not include a target, and the notificationTask, completedSubtasks, and subtaskData properties are ignored.
+ */
+export type NotificationTaskSubtaskCleanupFunctionInput<I extends NotificationTaskSubtaskInput<D, M, S>, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> = Omit<I, 'target' | 'completedSubtasks' | 'subtaskData'> & Partial<Pick<I, 'target'>>;
+/**
+ * Similar to NotificationTaskServiceTaskHandlerConfig, but instead targets a specific NotificationTaskSubtaskTarget.
+ *
+ * The flows behave the same way.
+ */
+export interface NotificationTaskSubtaskProcessorConfig<I extends NotificationTaskSubtaskInput<D, M, S>, CUI extends NotificationTaskSubtaskCleanupInstructions, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> {
+    /**
+     * The target this configuration is for.
+     */
+    readonly target: NotificationTaskSubtaskTarget;
+    /**
+     * The order/flow of checkpoints and handler functions.
+     *
+     * When handling a notification task, if the checkpoint has already been completed then the entry will be skipped.
+     */
+    readonly flow: NotificationTaskSubtaskFlowEntry<I, D, M, S>[];
+    /**
+     * Optional cleanup function for the subtask.
+     *
+     * If not provided, the default cleanup actions will take place.
+     */
+    readonly cleanup?: NotificationTaskSubtaskCleanupInstructionsFunction<I, CUI, D, M, S>;
+    /**
+     * If true, then results returned by this processor will set "canRunNextCheckpoint" to true if it is undefined.
+     */
+    readonly allowRunMultipleParts?: Maybe<boolean>;
+}
+/**
+ * Generates input for a NotificationTaskSubtaskNotificationTaskHandler from the provided NotificationTask.
+ *
+ * Should throw an NotificationTaskSubTaskMissingRequiredDataTermination error if the NotificationTask is missing required data.
+ */
+export type NotificationTaskSubtaskNotificationTaskHandlerInputFunction<I extends NotificationTaskSubtaskInput<D, M, S>, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> = (data: D, notificationTask: NotificationTask<D>) => PromiseOrValue<NotificationTaskSubtaskNotificationTaskHandlerInputFunctionResult<I, D, M, S>>;
+/**
+ * The input function result may not include a target, and the notificationTask, completedSubtasks, and subtaskData properties are ignored.
+ */
+export type NotificationTaskSubtaskNotificationTaskHandlerInputFunctionResult<I extends NotificationTaskSubtaskInput<D, M, S>, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> = Omit<I, 'target' | 'notificationTask' | 'completedSubtasks' | 'subtaskData'> & Partial<Pick<I, 'target'>>;
+/**
+ * Function that builds the update metadata for a NotificationTaskSubtask.
+ *
+ * Updates to sfps and sd are ignored, as those should be managed by the processors/flow entries.
+ */
+export type NotificationTaskSubtaskNotificationTaskHandlerBuildUpdateMetadataFunction<I extends NotificationTaskSubtaskInput<D, M, S>, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> = (baseUpdateMetadata: D, input: I) => PromiseOrValue<Omit<D, 'sfps' | 'sd'>>;
+/**
+ * Configuration for notificationTaskSubtaskNotificationTaskHandler().
+ */
+export interface NotificationTaskSubtaskNotificationTaskHandlerFactoryConfig<I extends NotificationTaskSubtaskInput<D, M, S>, CUI extends NotificationTaskSubtaskCleanupInstructions, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> {
+    /**
+     * A name for the subtask handler. Used for logging errors.
+     */
+    readonly subtaskHandlerFunctionName: string;
+    /**
+     * The task type
+     */
+    readonly taskType: NotificationTaskType;
+    /**
+     * Creates input for the NotificationTaskSubtaskNotificationTaskHandler from the provided NotificationTask.
+     */
+    readonly inputFunction: NotificationTaskSubtaskNotificationTaskHandlerInputFunction<I, D, M, S>;
+    /**
+     * Configuration function for building/extending the update metadata for the NotificationTaskSubtaskNotificationTask.
+     */
+    readonly buildUpdateMetadata?: NotificationTaskSubtaskNotificationTaskHandlerBuildUpdateMetadataFunction<I, D, M, S>;
+    /**
+     * The default cleanup instructions function.
+     */
+    readonly defaultCleanup: NotificationTaskSubtaskCleanupInstructionsFunction<I, CUI, D, M, S>;
+    /**
+     * The cleanup function to execute using the input and instructions.
+     */
+    readonly cleanupFunction: NotificationTaskSubtaskCleanupFunction<I, CUI, D, M, S>;
+    /**
+     * Sets the default max cleanup retry attempts for each processor.
+     */
+    readonly defaultMaxCleanupRetryAttempts?: Maybe<number>;
+    /**
+     * Sets the default cleanup retry delay for each processor.
+     */
+    readonly defaultCleanupRetryDelay?: Maybe<Milliseconds>;
+}
+/**
+ * Creates a NotificationTaskServiceTaskHandlerConfig using the input config.
+ */
+export type NotificationTaskSubtaskNotificationTaskHandlerFactory<I extends NotificationTaskSubtaskInput<D, M, S>, CUI extends NotificationTaskSubtaskCleanupInstructions, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> = (config: NotificationTaskSubtaskNotificationTaskHandlerConfig<I, CUI, D, M, S>) => NotificationTaskServiceTaskHandlerConfig<D, NotificationTaskSubtaskCheckpoint>;
+/**
+ * Configuration for notificationTaskSubtaskNotificationTaskHandler().
+ */
+export interface NotificationTaskSubtaskNotificationTaskHandlerConfig<I extends NotificationTaskSubtaskInput<D, M, S>, CUI extends NotificationTaskSubtaskCleanupInstructions, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString> {
+    /**
+     * List of all target values for the app. Used for verifying that all target values are handled.
+     */
+    readonly validate?: NotificationTaskSubtaskTarget[];
+    /**
+     * List of handlers for NotificationTaskSubtaskTarget values.
+     */
+    readonly processors: NotificationTaskSubtaskProcessorConfig<I, CUI, D, M, S>[];
+    /**
+     * The maximum number of times to delay the cleanup step of a NotificationTaskSubtaskNotificationTask.
+     *
+     * Defaults to DEFAULT_MAX_STORAGE_FILE_PROCESSING_CLEANUP_RETRY_ATTEMPTS.
+     */
+    readonly maxCleanupRetryAttempts?: Maybe<number>;
+    /**
+     * The amount of time to delay the cleanup step of a NotificationTaskSubtaskNotificationTask.
+     *
+     * Defaults to DEFAULT_STORAGE_FILE_PROCESSING_CLEANUP_RETRY_DELAY.
+     */
+    readonly cleanupRetryDelay?: Maybe<Milliseconds>;
+    /**
+     * The default value to use for allowRunMultipleParts if it is not specified, for each processor.
+     */
+    readonly defaultAllowRunMultipleParts?: Maybe<boolean>;
+}
+/**
+ * Creates a NotificationTaskSubtaskNotificationTaskHandlerFactory.
+ */
+export declare function notificationTaskSubtaskNotificationTaskHandlerFactory<I extends NotificationTaskSubtaskInput<D, M, S>, CUI extends NotificationTaskSubtaskCleanupInstructions, D extends NotificationTaskSubtaskData<M, S>, M extends NotificationTaskSubtaskMetadata = any, S extends NotificationTaskSubtaskCheckpointString = NotificationTaskSubtaskCheckpointString>(factoryConfig: NotificationTaskSubtaskNotificationTaskHandlerFactoryConfig<I, CUI, D, M, S>): NotificationTaskSubtaskNotificationTaskHandlerFactory<I, CUI, D, M, S>;
+/**
+ * Thrown when a subtask no longer has data available to continue processing.
+ *
+ * The subtask will be marked as immediately complete, and no cleanup will occur.
+ *
+ * This is useful in cases where the underlying models or data that the subtask rely on are deleted (and those models were also required for cleanup) so the task can be marked as complete without attempting cleanup.
+ */
+export declare class NotificationTaskSubTaskMissingRequiredDataTermination extends BaseError {
+}
+/**
+ * Creates a NotificationTaskSubTaskMissingRequiredDataTermination.
+ */
+export declare function notificationTaskSubTaskMissingRequiredDataTermination(): NotificationTaskSubTaskMissingRequiredDataTermination;

package/model/src/lib/notification/notification.task.subtask.handler.js

@@ -0,0 +1,256 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationTaskSubTaskMissingRequiredDataTermination = void 0;
+exports.notificationTaskSubtaskNotificationTaskHandlerFactory = notificationTaskSubtaskNotificationTaskHandlerFactory;
+exports.notificationTaskSubTaskMissingRequiredDataTermination = notificationTaskSubTaskMissingRequiredDataTermination;
+const firebase_1 = require("@dereekb/firebase");
+const util_1 = require("@dereekb/util");
+const make_error_1 = require("make-error");
+const notification_task_service_util_1 = require("./notification.task.service.util");
+/**
+ * Creates a NotificationTaskSubtaskNotificationTaskHandlerFactory.
+ */
+function notificationTaskSubtaskNotificationTaskHandlerFactory(factoryConfig) {
+    const { taskType, subtaskHandlerFunctionName: subtaskHandlerName, inputFunction, defaultCleanup, cleanupFunction, buildUpdateMetadata: inputBuildUpdateMetadata } = factoryConfig;
+    return (subtaskHandlerConfig) => {
+        const { processors: inputProcessors, maxCleanupRetryAttempts: inputMaxCleanupRetryAttempts, cleanupRetryDelay: inputCleanupRetryDelay, defaultAllowRunMultipleParts } = subtaskHandlerConfig;
+        const maxCleanupRetryAttempts = inputMaxCleanupRetryAttempts ?? firebase_1.DEFAULT_NOTIFICATION_TASK_SUBTASK_CLEANUP_RETRY_ATTEMPTS;
+        const cleanupRetryDelay = inputCleanupRetryDelay ?? firebase_1.DEFAULT_NOTIFICATION_TASK_SUBTASK_CLEANUP_RETRY_DELAY;
+        const buildUpdateMetadata = inputBuildUpdateMetadata ?? (() => undefined);
+        const processors = {};
+        inputProcessors.forEach((processorConfig) => {
+            const { target } = processorConfig;
+            processors[target] = processorFunctionForConfig(processorConfig);
+        });
+        /**
+         * Structure is similar to notificationTaskService(), but contained to handle the subtasks.
+         */
+        function processorFunctionForConfig(processorConfig) {
+            const { flow: inputFlows, cleanup, allowRunMultipleParts: processorAllowRunMultipleParts } = processorConfig;
+            const { included: subtaskFlows, excluded: nonSubtaskFlows } = (0, util_1.separateValues)(inputFlows, (x) => x.subtask != null);
+            const allowRunMultipleParts = processorAllowRunMultipleParts ?? defaultAllowRunMultipleParts;
+            if (inputFlows.length === 0) {
+                throw new Error(`${subtaskHandlerName}(): NotificationTaskSubtaskProcessorConfig must have at least one flow entry.`);
+            }
+            else if (nonSubtaskFlows.length > 1) {
+                throw new Error(`${subtaskHandlerName}(): NotificationTaskSubtaskProcessorConfig must not have more than one non-subtask flow.`);
+            }
+            const allKnownSubtasks = (0, util_1.unique)(inputFlows.map((x) => x.subtask));
+            return {
+                process: async (input) => {
+                    const { notificationTask, completedSubtasks, subtaskData } = input;
+                    let fn;
+                    switch (completedSubtasks.length) {
+                        case 0:
+                            fn = (nonSubtaskFlows[0] ?? subtaskFlows[0])?.fn;
+                            break;
+                        default:
+                            const completedSubtasksSet = new Set(completedSubtasks);
+                            /**
+                             * Find the next flow function that hasn't had its checkpoint completed yet.
+                             */
+                            const nextSubtask = subtaskFlows.find((x) => !completedSubtasksSet.has(x.subtask));
+                            fn = nextSubtask?.fn;
+                            break;
+                    }
+                    let result;
+                    if (fn) {
+                        /*
+                         * This section is similar to handleNotificationTask() in notification.action.server.ts,
+                         * but is modified to handle the subtasks. The main difference is the attempt count is maintained,
+                         * and instead is available via the normal NotificationTask attempts details.
+                         */
+                        const subtaskResult = await fn(input);
+                        const { completion: subtaskCompletion, updateMetadata: subtaskUpdateMetadata, delayUntil, canRunNextCheckpoint } = subtaskResult;
+                        let allSubtasksDone = false;
+                        let sfps = completedSubtasks;
+                        // update the task metadata to reflect the changes
+                        switch (subtaskCompletion) {
+                            case true:
+                                allSubtasksDone = true;
+                                break;
+                            case false:
+                                // remove any completions, if applicable
+                                sfps = (0, notification_task_service_util_1.removeFromCompletionsArrayWithTaskResult)(sfps, subtaskResult);
+                                break;
+                            default:
+                                sfps = (0, util_1.unique)([
+                                    ...(0, notification_task_service_util_1.removeFromCompletionsArrayWithTaskResult)(sfps, subtaskResult), // remove any completions, if applicable
+                                    ...(0, util_1.asArray)(subtaskCompletion)
+                                ]);
+                                const completedSubtasksSet = new Set(sfps);
+                                const incompleteSubtasks = allKnownSubtasks.filter((x) => !completedSubtasksSet.has(x));
+                                allSubtasksDone = incompleteSubtasks.length === 0;
+                                break;
+                        }
+                        // configure the update metadata result
+                        const sd = {
+                            ...subtaskData,
+                            ...subtaskUpdateMetadata
+                        };
+                        /**
+                         * This is updating the metadata for the NotificationTask, which has a nested data
+                         */
+                        const baseUpdateMetadata = {
+                            ...notificationTask.data,
+                            sfps,
+                            sd
+                        };
+                        let updateMetadata = (await buildUpdateMetadata(baseUpdateMetadata, input));
+                        if (updateMetadata) {
+                            // inject sfps and sd back in
+                            updateMetadata = {
+                                ...updateMetadata,
+                                sfps,
+                                sd
+                            };
+                        }
+                        else {
+                            updateMetadata = baseUpdateMetadata;
+                        }
+                        const nextCanRunNextCheckpoint = canRunNextCheckpoint ?? allowRunMultipleParts;
+                        result = {
+                            completion: allSubtasksDone ? ['processing'] : (0, firebase_1.delayCompletion)(), // return processing until all subtasks are complete.
+                            updateMetadata,
+                            canRunNextCheckpoint: nextCanRunNextCheckpoint,
+                            allCompletedSubTasks: sfps,
+                            delayUntil // delay is passed through
+                        };
+                    }
+                    else {
+                        // no more subtasks to process, and no metadata changes. Mark as processing complete and continue.
+                        result = (0, firebase_1.completeSubtaskProcessingAndScheduleCleanupTaskResult)();
+                    }
+                    return result;
+                },
+                cleanup
+            };
+        }
+        function useInputDataFactory(fn) {
+            return async (notificationTask) => {
+                const { data } = notificationTask;
+                let result;
+                if (data) {
+                    try {
+                        const inputFunctionResult = await inputFunction(data, notificationTask);
+                        result = await fn(notificationTask, inputFunctionResult, data);
+                    }
+                    catch (e) {
+                        if (e instanceof NotificationTaskSubTaskMissingRequiredDataTermination) {
+                            // Task is complete if the required data no longer exists. Nothing to cleanup.
+                            result = (0, firebase_1.notificationTaskComplete)();
+                        }
+                        else {
+                            // rethrow the error
+                            throw e;
+                        }
+                    }
+                }
+                else {
+                    // Improperly configured task. Complete immediately.
+                    result = (0, firebase_1.notificationTaskComplete)();
+                }
+                return result;
+            };
+        }
+        const result = {
+            type: taskType,
+            flow: [
+                {
+                    checkpoint: firebase_1.NOTIFICATION_TASK_SUBTASK_CHECKPOINT_PROCESSING,
+                    fn: useInputDataFactory(async (notificationTask, inputFunctionResult, data) => {
+                        let result;
+                        const baseInput = {
+                            ...inputFunctionResult,
+                            notificationTask
+                        };
+                        const { target } = baseInput;
+                        if (target) {
+                            const processor = processors[target];
+                            if (processor) {
+                                const { sd: subtaskData, sfps: completedSubtasks } = data;
+                                const input = {
+                                    ...baseInput,
+                                    target,
+                                    completedSubtasks: completedSubtasks ?? [],
+                                    subtaskData
+                                };
+                                result = await processor.process(input);
+                            }
+                            else {
+                                // processor is unknown. Complete the task.
+                                result = (0, firebase_1.completeSubtaskProcessingAndScheduleCleanupTaskResult)();
+                            }
+                        }
+                        else {
+                            // target is unknown. Complete the task.
+                            result = (0, firebase_1.completeSubtaskProcessingAndScheduleCleanupTaskResult)();
+                        }
+                        return result;
+                    })
+                },
+                {
+                    checkpoint: firebase_1.NOTIFICATION_TASK_SUBTASK_CHECKPOINT_CLEANUP,
+                    fn: useInputDataFactory(async (notificationTask, inputFunctionResult, data) => {
+                        let result;
+                        let cleanupFunctionInput = {
+                            ...inputFunctionResult,
+                            notificationTask
+                        };
+                        const { target } = cleanupFunctionInput;
+                        let cleanupInstructions;
+                        if (target) {
+                            const processor = processors[target];
+                            if (processor && processor.cleanup) {
+                                const { sd: subtaskData, sfps: completedSubtasks } = data;
+                                const input = {
+                                    ...cleanupFunctionInput,
+                                    notificationTask,
+                                    completedSubtasks: completedSubtasks ?? [],
+                                    target,
+                                    subtaskData
+                                };
+                                cleanupInstructions = await processor.cleanup(input);
+                                cleanupFunctionInput = input;
+                            }
+                            else {
+                                // processor is unknown. Complete the task.
+                                cleanupInstructions = defaultCleanup(cleanupFunctionInput);
+                            }
+                        }
+                        else {
+                            // target is unknown. Complete the task.
+                            cleanupInstructions = defaultCleanup(cleanupFunctionInput);
+                        }
+                        if (cleanupInstructions.cleanupSuccess === false && notificationTask.currentCheckpointSendAttempts <= maxCleanupRetryAttempts) {
+                            result = (0, firebase_1.notificationTaskDelayRetry)(cleanupInstructions.delayRetryUntil ?? cleanupRetryDelay);
+                        }
+                        else {
+                            result = await cleanupFunction(cleanupFunctionInput, cleanupInstructions);
+                        }
+                        return result;
+                    })
+                }
+            ]
+        };
+        return result;
+    };
+}
+// MARK: Internally Handled Errors
+/**
+ * Thrown when a subtask no longer has data available to continue processing.
+ *
+ * The subtask will be marked as immediately complete, and no cleanup will occur.
+ *
+ * This is useful in cases where the underlying models or data that the subtask rely on are deleted (and those models were also required for cleanup) so the task can be marked as complete without attempting cleanup.
+ */
+class NotificationTaskSubTaskMissingRequiredDataTermination extends make_error_1.BaseError {
+}
+exports.NotificationTaskSubTaskMissingRequiredDataTermination = NotificationTaskSubTaskMissingRequiredDataTermination;
+/**
+ * Creates a NotificationTaskSubTaskMissingRequiredDataTermination.
+ */
+function notificationTaskSubTaskMissingRequiredDataTermination() {
+    return new NotificationTaskSubTaskMissingRequiredDataTermination();
+}
+//# sourceMappingURL=notification.task.subtask.handler.js.map

package/model/src/lib/notification/notification.task.subtask.handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.task.subtask.handler.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/model/src/lib/notification/notification.task.subtask.handler.ts"],"names":[],"mappings":";;;AAkPA,sHA8QC;AAeD,sHAEC;AAjhBD,gDAiB2B;AAE3B,wCAAkI;AAClI,2CAAuC;AACvC,qFAA4F;AA0N5F;;GAEG;AACH,SAAgB,qDAAqD,CACnE,aAA2F;IAE3F,MAAM,EAAE,QAAQ,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,GAAG,aAAa,CAAC;IAElL,OAAO,CAAC,oBAA2F,EAAE,EAAE;QACrG,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,GAAG,oBAAoB,CAAC;QAC7L,MAAM,uBAAuB,GAAG,4BAA4B,IAAI,mEAAwD,CAAC;QACzH,MAAM,iBAAiB,GAAG,sBAAsB,IAAI,gEAAqD,CAAC;QAE1G,MAAM,mBAAmB,GAAG,wBAAwB,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAS1E,MAAM,UAAU,GAA6F,EAAE,CAAC;QAEhH,eAAe,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;YACnC,UAAU,CAAC,MAAM,CAAC,GAAG,0BAA0B,CAAC,eAAe,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH;;WAEG;QACH,SAAS,0BAA0B,CAAC,eAAwE;YAC1G,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,qBAAqB,EAAE,8BAA8B,EAAE,GAAG,eAAe,CAAC;YAC7G,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,IAAA,qBAAc,EAAC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;YACnH,MAAM,qBAAqB,GAAG,8BAA8B,IAAI,4BAA4B,CAAC;YAE7F,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CAAC,GAAG,kBAAkB,+EAA+E,CAAC,CAAC;YACxH,CAAC;iBAAM,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,KAAK,CAAC,GAAG,kBAAkB,0FAA0F,CAAC,CAAC;YACnI,CAAC;YAED,MAAM,gBAAgB,GAAG,IAAA,aAAM,EAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YAElE,OAAO;gBACL,OAAO,EAAE,KAAK,EAAE,KAAQ,EAAE,EAAE;oBAC1B,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;oBAEnE,IAAI,EAA8C,CAAC;oBAEnD,QAAQ,iBAAiB,CAAC,MAAM,EAAE,CAAC;wBACjC,KAAK,CAAC;4BACJ,EAAE,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,EAAgD,CAAC;4BAC/F,MAAM;wBACR;4BACE,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC;4BACxD;;+BAEG;4BACH,MAAM,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;4BACnF,EAAE,GAAG,WAAW,EAAE,EAAgD,CAAC;4BACnE,MAAM;oBACV,CAAC;oBAED,IAAI,MAAiG,CAAC;oBAEtG,IAAI,EAAE,EAAE,CAAC;wBACP;;;;2BAIG;wBAEH,MAAM,aAAa,GAA8D,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;wBACjG,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,cAAc,EAAE,qBAAqB,EAAE,UAAU,EAAE,oBAAoB,EAAE,GAAG,aAAa,CAAC;wBAEjI,IAAI,eAAe,GAAG,KAAK,CAAC;wBAC5B,IAAI,IAAI,GAAQ,iBAAiB,CAAC;wBAElC,kDAAkD;wBAClD,QAAQ,iBAAiB,EAAE,CAAC;4BAC1B,KAAK,IAAI;gCACP,eAAe,GAAG,IAAI,CAAC;gCACvB,MAAM;4BACR,KAAK,KAAK;gCACR,wCAAwC;gCACxC,IAAI,GAAG,IAAA,yEAAwC,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gCACrE,MAAM;4BACR;gCACE,IAAI,GAAG,IAAA,aAAM,EAAC;oCACZ,GAAG,IAAA,yEAAwC,EAAC,IAAI,EAAE,aAAa,CAAC,EAAE,wCAAwC;oCAC1G,GAAG,IAAA,cAAO,EAAC,iBAAiB,CAAC;iCAC9B,CAAC,CAAC;gCAEH,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;gCAC3C,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gCAExF,eAAe,GAAG,kBAAkB,CAAC,MAAM,KAAK,CAAC,CAAC;gCAClD,MAAM;wBACV,CAAC;wBAED,uCAAuC;wBACvC,MAAM,EAAE,GAAG;4BACT,GAAG,WAAW;4BACd,GAAG,qBAAqB;yBACpB,CAAC;wBAEP;;2BAEG;wBACH,MAAM,kBAAkB,GAAM;4BAC5B,GAAG,gBAAgB,CAAC,IAAI;4BACxB,IAAI;4BACJ,EAAE;yBACH,CAAC;wBAEF,IAAI,cAAc,GAAG,CAAC,MAAM,mBAAmB,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAM,CAAC;wBAEjF,IAAI,cAAc,EAAE,CAAC;4BACnB,6BAA6B;4BAC7B,cAAc,GAAG;gCACf,GAAG,cAAc;gCACjB,IAAI;gCACJ,EAAE;6BACH,CAAC;wBACJ,CAAC;6BAAM,CAAC;4BACN,cAAc,GAAG,kBAAkB,CAAC;wBACtC,CAAC;wBAED,MAAM,wBAAwB,GAAG,oBAAoB,IAAI,qBAAqB,CAAC;wBAE/E,MAAM,GAAG;4BACP,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAA,0BAAe,GAAE,EAAE,qDAAqD;4BACvH,cAAc;4BACd,oBAAoB,EAAE,wBAAwB;4BAC9C,oBAAoB,EAAE,IAAI;4BAC1B,UAAU,CAAC,0BAA0B;yBACtC,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,kGAAkG;wBAClG,MAAM,GAAG,IAAA,gEAAqD,GAAmB,CAAC;oBACpF,CAAC;oBAED,OAAO,MAAM,CAAC;gBAChB,CAAC;gBACD,OAAO;aACR,CAAC;QACJ,CAAC;QAED,SAAS,mBAAmB,CAAC,EAA8P;YACzR,OAAO,KAAK,EAAE,gBAAqC,EAAE,EAAE;gBACrD,MAAM,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC;gBAElC,IAAI,MAAiG,CAAC;gBAEtG,IAAI,IAAI,EAAE,CAAC;oBACT,IAAI,CAAC;wBACH,MAAM,mBAAmB,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;wBAExE,MAAM,GAAG,MAAM,EAAE,CAAC,gBAAgB,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;oBACjE,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,CAAC,YAAY,qDAAqD,EAAE,CAAC;4BACvE,8EAA8E;4BAC9E,MAAM,GAAG,IAAA,mCAAwB,GAAE,CAAC;wBACtC,CAAC;6BAAM,CAAC;4BACN,oBAAoB;4BACpB,MAAM,CAAC,CAAC;wBACV,CAAC;oBACH,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,oDAAoD;oBACpD,MAAM,GAAG,IAAA,mCAAwB,GAAE,CAAC;gBACtC,CAAC;gBAED,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAmF;YAC7F,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE;gBACJ;oBACE,UAAU,EAAE,0DAA+C;oBAC3D,EAAE,EAAE,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,IAAI,EAAE,EAAE;wBAC5E,IAAI,MAAiG,CAAC;wBAEtG,MAAM,SAAS,GAAG;4BAChB,GAAG,mBAAmB;4BACtB,gBAAgB;yBACjB,CAAC;wBAEF,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;wBAE7B,IAAI,MAAM,EAAE,CAAC;4BACX,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;4BAErC,IAAI,SAAS,EAAE,CAAC;gCACd,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;gCAE1D,MAAM,KAAK,GAAM;oCACf,GAAG,SAAS;oCACZ,MAAM;oCACN,iBAAiB,EAAE,iBAAiB,IAAI,EAAE;oCAC1C,WAAW;iCACP,CAAC;gCAEP,MAAM,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;4BAC1C,CAAC;iCAAM,CAAC;gCACN,2CAA2C;gCAC3C,MAAM,GAAG,IAAA,gEAAqD,GAAE,CAAC;4BACnE,CAAC;wBACH,CAAC;6BAAM,CAAC;4BACN,wCAAwC;4BACxC,MAAM,GAAG,IAAA,gEAAqD,GAAE,CAAC;wBACnE,CAAC;wBAED,OAAO,MAAM,CAAC;oBAChB,CAAC,CAAC;iBACH;gBACD;oBACE,UAAU,EAAE,uDAA4C;oBACxD,EAAE,EAAE,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,IAAI,EAAE,EAAE;wBAC5E,IAAI,MAAiG,CAAC;wBAEtG,IAAI,oBAAoB,GAAG;4BACzB,GAAG,mBAAmB;4BACtB,gBAAgB;yBAC0C,CAAC;wBAE7D,MAAM,EAAE,MAAM,EAAE,GAAG,oBAAoB,CAAC;wBAExC,IAAI,mBAAwB,CAAC;wBAE7B,IAAI,MAAM,EAAE,CAAC;4BACX,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;4BAErC,IAAI,SAAS,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;gCACnC,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;gCAE1D,MAAM,KAAK,GAAM;oCACf,GAAG,oBAAoB;oCACvB,gBAAgB;oCAChB,iBAAiB,EAAE,iBAAiB,IAAI,EAAE;oCAC1C,MAAM;oCACN,WAAW;iCACP,CAAC;gCAEP,mBAAmB,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gCACrD,oBAAoB,GAAG,KAAK,CAAC;4BAC/B,CAAC;iCAAM,CAAC;gCACN,2CAA2C;gCAC3C,mBAAmB,GAAG,cAAc,CAAC,oBAAoB,CAAC,CAAC;4BAC7D,CAAC;wBACH,CAAC;6BAAM,CAAC;4BACN,wCAAwC;4BACxC,mBAAmB,GAAG,cAAc,CAAC,oBAAoB,CAAC,CAAC;wBAC7D,CAAC;wBAED,IAAI,mBAAmB,CAAC,cAAc,KAAK,KAAK,IAAI,gBAAgB,CAAC,6BAA6B,IAAI,uBAAuB,EAAE,CAAC;4BAC9H,MAAM,GAAG,IAAA,qCAA0B,EAAC,mBAAmB,CAAC,eAAe,IAAI,iBAAiB,CAAC,CAAC;wBAChG,CAAC;6BAAM,CAAC;4BACN,MAAM,GAAG,MAAM,eAAe,CAAC,oBAAoB,EAAE,mBAAmB,CAAC,CAAC;wBAC5E,CAAC;wBAED,OAAO,MAAM,CAAC;oBAChB,CAAC,CAAC;iBACH;aACF;SACF,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAED,kCAAkC;AAClC;;;;;;GAMG;AACH,MAAa,qDAAsD,SAAQ,sBAAS;CAAG;AAAvF,sHAAuF;AAEvF;;GAEG;AACH,SAAgB,qDAAqD;IACnE,OAAO,IAAI,qDAAqD,EAAE,CAAC;AACrE,CAAC"}

package/model/src/lib/storagefile/storagefile.action.server.d.ts

@@ -1,4 +1,4 @@
-import { type FirestoreContextReference, InitializeStorageFileFromUploadParams, type AsyncStorageFileCreateAction, type StorageFileFirestoreCollections, ProcessStorageFileParams, type StorageFileDocument, type ProcessStorageFileResult, CreateStorageFileParams, type AsyncStorageFileUpdateAction, UpdateStorageFileParams, type NotificationFirestoreCollections, type FirebaseStorageAccessorFile, type InitializeAllStorageFilesFromUploadsResult, InitializeAllStorageFilesFromUploadsParams, ProcessAllQueuedStorageFilesParams, type ProcessAllQueuedStorageFilesResult, DeleteAllQueuedStorageFilesParams, type DeleteAllQueuedStorageFilesResult, DeleteStorageFileParams, type AsyncStorageFileDeleteAction } from '@dereekb/firebase';
+import { type FirestoreContextReference, InitializeStorageFileFromUploadParams, type AsyncStorageFileCreateAction, type StorageFileFirestoreCollections, ProcessStorageFileParams, type StorageFileDocument, type ProcessStorageFileResult, CreateStorageFileParams, type AsyncStorageFileUpdateAction, UpdateStorageFileParams, type NotificationFirestoreCollections, type FirebaseStorageAccessorFile, type InitializeAllStorageFilesFromUploadsResult, InitializeAllStorageFilesFromUploadsParams, ProcessAllQueuedStorageFilesParams, type ProcessAllQueuedStorageFilesResult, DeleteAllQueuedStorageFilesParams, type DeleteAllQueuedStorageFilesResult, DeleteStorageFileParams, type AsyncStorageFileDeleteAction, DownloadStorageFileParams, type DownloadStorageFileResult } from '@dereekb/firebase';
 import { type FirebaseServerStorageServiceRef, type FirebaseServerActionsContext, type FirebaseServerAuthServiceRef } from '@dereekb/firebase-server';
 import { type TransformAndValidateFunctionResult } from '@dereekb/model';
 import { type InjectionToken } from '@nestjs/common';
@@ -25,6 +25,7 @@ export declare abstract class StorageFileServerActions {
     abstract processStorageFile(params: ProcessStorageFileParams): Promise<TransformAndValidateFunctionResult<ProcessStorageFileParams, (storageFileDocument: StorageFileDocument) => Promise<ProcessStorageFileResult>>>;
     abstract deleteAllQueuedStorageFiles(params: DeleteAllQueuedStorageFilesParams): Promise<TransformAndValidateFunctionResult<DeleteAllQueuedStorageFilesParams, () => Promise<DeleteAllQueuedStorageFilesResult>>>;
     abstract deleteStorageFile(params: DeleteStorageFileParams): AsyncStorageFileDeleteAction<DeleteStorageFileParams>;
+    abstract downloadStorageFile(params: DownloadStorageFileParams): Promise<TransformAndValidateFunctionResult<DownloadStorageFileParams, (storageFileDocument: StorageFileDocument) => Promise<DownloadStorageFileResult>>>;
 }
 export declare function storageFileServerActions(context: StorageFileServerActionsContext): StorageFileServerActions;
 export declare function createStorageFileFactory(context: BaseStorageFileServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<CreateStorageFileParams, () => Promise<any>, object, unknown>;
@@ -39,3 +40,4 @@ export declare function processAllQueuedStorageFilesFactory(context: StorageFile
 export declare function processStorageFileFactory(context: StorageFileServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<ProcessStorageFileParams, (storageFileDocument: StorageFileDocument) => Promise<ProcessStorageFileResult>, object, unknown>;
 export declare function deleteAllQueuedStorageFilesFactory(context: StorageFileServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<DeleteAllQueuedStorageFilesParams, () => Promise<DeleteAllQueuedStorageFilesResult>, object, unknown>;
 export declare function deleteStorageFileFactory(context: StorageFileServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<DeleteStorageFileParams, (inputStorageFileDocument: StorageFileDocument) => Promise<void>, object, unknown>;
+export declare function downloadStorageFileFactory(context: StorageFileServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<DownloadStorageFileParams, (storageFileDocument: StorageFileDocument) => Promise<DownloadStorageFileResult>, object, unknown>;

package/model/src/lib/storagefile/storagefile.action.server.js

@@ -11,10 +11,13 @@ exports.processAllQueuedStorageFilesFactory = processAllQueuedStorageFilesFactor
 exports.processStorageFileFactory = processStorageFileFactory;
 exports.deleteAllQueuedStorageFilesFactory = deleteAllQueuedStorageFilesFactory;
 exports.deleteStorageFileFactory = deleteStorageFileFactory;
+exports.downloadStorageFileFactory = downloadStorageFileFactory;
 const firebase_1 = require("@dereekb/firebase");
 const firebase_server_1 = require("@dereekb/firebase-server");
 const storagefile_error_1 = require("./storagefile.error");
 const util_1 = require("@dereekb/util");
+const date_1 = require("@dereekb/date");
+const date_fns_1 = require("date-fns");
 /**
  * Injection token for the BaseStorageFileServerActionsContext
  */
@@ -35,7 +38,8 @@ function storageFileServerActions(context) {
         processAllQueuedStorageFiles: processAllQueuedStorageFilesFactory(context),
         processStorageFile: processStorageFileFactory(context),
         deleteAllQueuedStorageFiles: deleteAllQueuedStorageFilesFactory(context),
-        deleteStorageFile: deleteStorageFileFactory(context)
+        deleteStorageFile: deleteStorageFileFactory(context),
+        downloadStorageFile: downloadStorageFileFactory(context)
     };
 }
 // MARK: Actions
@@ -389,4 +393,37 @@ function deleteStorageFileFactory(context) {
         };
     });
 }
+function downloadStorageFileFactory(context) {
+    const { storageService, firebaseServerActionTransformFunctionFactory } = context;
+    return firebaseServerActionTransformFunctionFactory(firebase_1.DownloadStorageFileParams, async (params) => {
+        const { asAdmin, expiresAt, expiresIn, responseDisposition, responseContentType } = params;
+        return async (storageFileDocument) => {
+            const storageFile = await (0, firebase_server_1.assertSnapshotData)(storageFileDocument);
+            const fileAccessor = storageService.file(storageFile);
+            let result;
+            if (fileAccessor.getSignedUrl) {
+                const expires = (0, util_1.expirationDetails)({ expiresAt, expiresIn });
+                let downloadUrlExpiresAt = expires.getExpirationDate();
+                // if they're not an admin, limit the expiration to a max of 30 days.
+                if (downloadUrlExpiresAt && !asAdmin) {
+                    const maxExpirationDate = (0, date_fns_1.addDays)(new Date(), 30);
+                    downloadUrlExpiresAt = (0, date_1.findMinDate)([downloadUrlExpiresAt, maxExpirationDate]);
+                }
+                const downloadUrl = await fileAccessor.getSignedUrl({
+                    action: 'read',
+                    expiresAt: downloadUrlExpiresAt ?? undefined,
+                    responseDisposition: responseDisposition ?? undefined, // can be set by anyone
+                    responseType: asAdmin ? (responseContentType ?? undefined) : undefined // can only be set by admins
+                });
+                result = {
+                    url: downloadUrl
+                };
+            }
+            else {
+                throw (0, firebase_server_1.internalServerError)('Signed url function appears to not be avalable.');
+            }
+            return result;
+        };
+    });
+}
 //# sourceMappingURL=storagefile.action.server.js.map