@dereekb/firebase-server 13.4.0 → 13.4.2

package/model/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@dereekb/firebase-server/model",
-  "version": "13.4.0",
+  "version": "13.4.2",
   "peerDependencies": {
-    "@dereekb/analytics": "13.4.0",
-    "@dereekb/date": "13.4.0",
-    "@dereekb/firebase": "13.4.0",
-    "@dereekb/firebase-server": "13.4.0",
-    "@dereekb/model": "13.4.0",
-    "@dereekb/nestjs": "13.4.0",
-    "@dereekb/rxjs": "13.4.0",
-    "@dereekb/util": "13.4.0",
+    "@dereekb/analytics": "13.4.2",
+    "@dereekb/date": "13.4.2",
+    "@dereekb/firebase": "13.4.2",
+    "@dereekb/firebase-server": "13.4.2",
+    "@dereekb/model": "13.4.2",
+    "@dereekb/nestjs": "13.4.2",
+    "@dereekb/rxjs": "13.4.2",
+    "@dereekb/util": "13.4.2",
     "@nestjs/common": "^11.1.16",
     "@nestjs/config": "^4.0.3",
     "archiver": "^7.0.0",

package/model/src/lib/mailgun/notification.send.service.mailgun.d.ts

@@ -59,6 +59,7 @@ export type MailgunNotificationEmailSendService = NotificationEmailSendService;
  * and dispatches them through the Mailgun API.
  *
  * @param config - service configuration including the Mailgun service, template builders, and batch size
+ * @returns a {@link NotificationEmailSendService} that batches and sends emails through Mailgun
  *
  * @example
  * ```ts

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

@@ -1,5 +1,5 @@
-export * from './notification.action.service';
-export * from './notification.action.init.service';
+export * from './notification.action.server';
+export * from './notification.action.server.init';
 export * from './notification.config.service';
 export * from './notification.config';
 export * from './notification.create.run';

package/model/src/lib/notification/{notification.action.service.d.ts → notification.action.server.d.ts}

@@ -64,6 +64,7 @@ export declare abstract class NotificationServerActions {
  * to its factory function using the provided context.
  *
  * @param context - the fully assembled notification server actions context
+ * @returns a fully wired {@link NotificationServerActions} instance
  *
  * @example
  * ```ts
@@ -78,6 +79,9 @@ export declare function notificationServerActions(context: NotificationServerAct
  *
  * Validates the UID exists in Firebase Auth, then creates a new {@link NotificationUser} document
  * with empty default and global configs. Throws if the UID is not found in Auth.
+ *
+ * @param context - the notification server actions context with auth and collection access
+ * @returns a transform-and-validate function that creates a new notification user document
  */
 export declare function createNotificationUserFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<CreateNotificationUserParams, () => Promise<NotificationUserDocument>, object, unknown>;
 /**
@@ -86,6 +90,9 @@ export declare function createNotificationUserFactory(context: NotificationServe
  * Updates a {@link NotificationUser}'s default config (`dc`), global config (`gc`), and/or
  * box configs (`bc`). When the global config changes, iterates all box configs to propagate
  * effective recipient changes and marks affected entries for sync.
+ *
+ * @param context - the notification server actions context with Firestore and collection access
+ * @returns a transform-and-validate function that updates an existing notification user document
  */
 export declare function updateNotificationUserFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<UpdateNotificationUserParams, (notificationUserDocument: NotificationUserDocument) => Promise<NotificationUserDocument>, object, unknown>;
 /**
@@ -95,6 +102,9 @@ export declare function updateNotificationUserFactory(context: NotificationServe
  * entries flagged with `ns=true` (needs-sync), loading the corresponding {@link NotificationBox},
  * and merging the user's preferences back into the box's recipient list. Handles removed entries
  * and cleans up stale box references.
+ *
+ * @param context - the notification server actions context with Firestore and collection access
+ * @returns a transform-and-validate function that resyncs a notification user's box configurations
  */
 export declare function resyncNotificationUserFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<import("@dereekb/firebase").TargetModelParams, (notificationUserDocument: NotificationUserDocument) => Promise<ResyncNotificationUserResult>, object, unknown>;
 /**
@@ -103,6 +113,9 @@ export declare function resyncNotificationUserFactory(context: NotificationServe
  * Batch-processes all {@link NotificationUser} documents flagged for sync by querying
  * for entries with `ns=true`, then calling the resync logic for each in parallel
  * (up to 5 concurrent tasks). Loops until no more flagged users are found.
+ *
+ * @param context - the notification server actions context with collection access
+ * @returns an async function that resyncs all flagged notification users and returns aggregate results
  */
 export declare function resyncAllNotificationUsersFactory(context: NotificationServerActionsContext): () => Promise<ResyncAllNotificationUsersResult>;
 /**
@@ -110,6 +123,9 @@ export declare function resyncAllNotificationUsersFactory(context: NotificationS
  *
  * Creates a new {@link NotificationSummary} document for a model, generating the summary ID
  * from the model key and initializing it with a blank template.
+ *
+ * @param context - the notification server actions context with collection access
+ * @returns a transform-and-validate function that creates a new notification summary document
  */
 export declare function createNotificationSummaryFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<CreateNotificationSummaryParams, () => Promise<NotificationSummaryDocument>, object, unknown>;
 /**
@@ -117,6 +133,9 @@ export declare function createNotificationSummaryFactory(context: NotificationSe
  *
  * Updates an existing {@link NotificationSummary} document's owner or setup flag.
  * Runs within a Firestore transaction to ensure consistency.
+ *
+ * @param context - the notification server actions context
+ * @returns a transform-and-validate function that updates an existing notification summary document
  */
 export declare function updateNotificationSummaryFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<UpdateNotificationSummaryParams, (notificationSummaryDocument: NotificationSummaryDocument) => Promise<NotificationSummaryDocument>, object, unknown>;
 /**
@@ -139,6 +158,9 @@ export interface CreateNotificationBoxInTransactionInput extends NotificationBox
  *
  * Checks for existing boxes and throws if one already exists for the model.
  * Also syncs initial recipients with their corresponding {@link NotificationUser} documents.
+ *
+ * @param context - the base notification server actions context with collection access
+ * @returns an async function that creates a notification box within a transaction and returns the document and template
  */
 export declare function createNotificationBoxInTransactionFactory(context: BaseNotificationServerActionsContext): (params: CreateNotificationBoxInTransactionInput, transaction: Transaction) => Promise<{
     notificationBoxTemplate: NotificationBox;
@@ -149,9 +171,21 @@ export declare function createNotificationBoxInTransactionFactory(context: BaseN
  *
  * Wraps {@link createNotificationBoxInTransactionFactory} in a Firestore transaction
  * and follows the transform-and-validate pattern.
+ *
+ * @param context - the notification server actions context with Firestore and collection access
+ * @returns a transform-and-validate function that creates a new notification box document
  */
 export declare function createNotificationBoxFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<CreateNotificationBoxParams, () => Promise<NotificationBoxDocument>, object, unknown>;
-export declare function updateNotificationBoxFactory({ firebaseServerActionTransformFunctionFactory }: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<import("@dereekb/firebase").TargetModelParams, (notificationBoxDocument: NotificationBoxDocument) => Promise<NotificationBoxDocument>, object, unknown>;
+/**
+ * Factory for the `updateNotificationBox` action.
+ *
+ * Currently a no-op placeholder that returns the document unchanged.
+ * Reserved for future box-level update logic.
+ *
+ * @param context - the notification server actions context (destructured for the transform factory)
+ * @returns a transform-and-validate function that returns the notification box document unchanged
+ */
+export declare function updateNotificationBoxFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<import("@dereekb/firebase").TargetModelParams, (notificationBoxDocument: NotificationBoxDocument) => Promise<NotificationBoxDocument>, object, unknown>;
 export interface UpdateNotificationBoxRecipientExclusionInTransactionInput extends NotificationBoxDocumentReferencePair {
     readonly params: UpdateNotificationBoxRecipientParams;
 }
@@ -163,6 +197,9 @@ export interface UpdateNotificationBoxRecipientExclusionInTransactionResult {
  *
  * Manages the exclusion list (`x`) on both the box recipient and the corresponding
  * {@link NotificationUser}'s send exclusion array, keeping them in sync.
+ *
+ * @param context - the base notification server actions context with collection access
+ * @returns an async function that updates recipient exclusions within a transaction
  */
 export declare function updateNotificationBoxRecipientExclusionInTransactionFactory(context: BaseNotificationServerActionsContext): (input: UpdateNotificationBoxRecipientExclusionInTransactionInput, transaction: Transaction) => Promise<Maybe<UpdateNotificationBoxRecipientExclusionInTransactionResult>>;
 export interface UpdateNotificationBoxRecipientInTransactionInput extends NotificationBoxDocumentReferencePair {
@@ -192,6 +229,9 @@ export interface UpdateNotificationBoxRecipientInTransactionResult {
  * Handles inserting new recipients, updating existing ones, and removing recipients.
  * Syncs changes with the recipient's {@link NotificationUser} document and manages
  * recipient index assignment via a sorted-values free-index calculator.
+ *
+ * @param context - the base notification server actions context with auth and collection access
+ * @returns an async function that updates a recipient on a notification box within a transaction
  */
 export declare function updateNotificationBoxRecipientInTransactionFactory(context: BaseNotificationServerActionsContext): (input: UpdateNotificationBoxRecipientInTransactionInput, transaction: Transaction) => Promise<Maybe<UpdateNotificationBoxRecipientInTransactionResult>>;
 /**
@@ -199,6 +239,9 @@ export declare function updateNotificationBoxRecipientInTransactionFactory(conte
  *
  * Wraps the in-transaction recipient update logic, handling both recipient changes
  * and send exclusion updates in a single Firestore transaction.
+ *
+ * @param context - the notification server actions context with Firestore and collection access
+ * @returns a transform-and-validate function that updates a recipient on a notification box
  */
 export declare function updateNotificationBoxRecipientFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<UpdateNotificationBoxRecipientParams, (notificationBoxDocument: NotificationBoxDocument) => Promise<NotificationBoxDocument>, object, unknown>;
 export declare const UNKNOWN_NOTIFICATION_TEMPLATE_TYPE_HOURS_DELAY = 8;
@@ -229,6 +272,9 @@ export declare const NOTIFICATION_TASK_TYPE_FAILURE_DELAY_MS: number;
  *
  * Supports throttling via `sendAt` time, configurable send flags, and task-based
  * async workflows for notifications that require multi-step processing.
+ *
+ * @param context - the notification server actions context with template, send, and task services
+ * @returns a transform-and-validate function that processes and sends a notification document
  */
 export declare function sendNotificationFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<SendNotificationParams, (inputNotificationDocument: NotificationDocument) => Promise<SendNotificationResult>, object, unknown>;
 /**
@@ -252,6 +298,9 @@ export interface SendQueuedNotificationsInput {
  * and an optional {@link NotificationExpediteService} for immediate delivery.
  * Continues processing batches until no more queued notifications are found
  * or the time budget is exhausted.
+ *
+ * @param context - the notification server actions context with collection group and send factory access
+ * @returns a transform-and-validate function that processes all queued notifications and returns aggregate results
  */
 export declare function sendQueuedNotificationsFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<SendQueuedNotificationsParams, (input?: Maybe<SendQueuedNotificationsInput>) => Promise<SendQueuedNotificationsResult>, object, unknown>;
 /**
@@ -260,5 +309,8 @@ export declare function sendQueuedNotificationsFactory(context: NotificationServ
  * Queries for {@link Notification} documents that are ready for cleanup (fully sent,
  * past the retention window) and deletes them in batches. Continues until no more
  * cleanup-eligible notifications are found.
+ *
+ * @param context - the notification server actions context with Firestore and collection access
+ * @returns a transform-and-validate function that cleans up sent notification documents and returns aggregate results
  */
 export declare function cleanupSentNotificationsFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<CleanupSentNotificationsParams, () => Promise<CleanupSentNotificationsResult>, object, unknown>;

package/model/src/lib/notification/{notification.action.init.service.d.ts → notification.action.server.init.d.ts}

@@ -75,6 +75,7 @@ export declare abstract class NotificationInitServerActions {
  * initialization action to its factory function.
  *
  * @param context - the initialization context with template functions and Firestore access
+ * @returns a fully wired {@link NotificationInitServerActions} instance
  *
  * @example
  * ```ts
@@ -106,6 +107,7 @@ export interface InitializeNotificationModelInTransactionInput<D extends Firesto
  * Skips initialization if the model is already initialized, optionally throwing an error.
  *
  * @param input - the document, transaction, template function, and options
+ * @returns an object with `initialized` and `alreadyInitialized` boolean flags
  * @throws notificationModelAlreadyInitializedError when `throwErrorIfAlreadyInitialized` is true
  */
 export declare function initializeNotificationModelInTransaction<D extends FirestoreDocument<InitializedNotificationModel, any>>(input: InitializeNotificationModelInTransactionInput<D>): Promise<{
@@ -117,6 +119,9 @@ export declare function initializeNotificationModelInTransaction<D extends Fires
  *
  * Loads the box document in the transaction, reads its current data, and delegates
  * to {@link initializeNotificationModelInTransaction} with the box-specific template function.
+ *
+ * @param context - the initialization context with collection references and template functions
+ * @returns an async function that initializes a notification box given params, document, and transaction
  */
 export declare function initializeNotificationBoxInTransactionFactory(context: NotificationInitServerActionsContext): (params: InitializeNotificationModelParams, notificationBoxDocument: NotificationBoxDocument, transaction: Transaction) => Promise<{
     initialized: boolean;
@@ -127,6 +132,9 @@ export declare function initializeNotificationBoxInTransactionFactory(context: N
  *
  * Wraps the in-transaction initialization in a Firestore transaction
  * and follows the transform-and-validate pattern.
+ *
+ * @param context - the initialization context with Firestore access and template functions
+ * @returns a transform-and-validate function that initializes a single notification box
  */
 export declare function initializeNotificationBoxFactory(context: NotificationInitServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<InitializeNotificationModelParams, (notificationBoxDocument: NotificationBoxDocument) => Promise<NotificationBoxDocument>, object, unknown>;
 /**
@@ -135,6 +143,9 @@ export declare function initializeNotificationBoxFactory(context: NotificationIn
  * Batch-processes all {@link NotificationBox} documents flagged for initialization
  * by querying for entries with `s=true` (setup needed), then initializing each in
  * parallel (up to 5 concurrent tasks). Loops until no more flagged boxes are found.
+ *
+ * @param context - the initialization context with Firestore access and collection references
+ * @returns a transform-and-validate function that batch-initializes all applicable notification boxes
  */
 export declare function initializeAllApplicableNotificationBoxesFactory(context: NotificationInitServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<InitializeAllApplicableNotificationBoxesParams, () => Promise<InitializeAllApplicableNotificationBoxesResult>, object, unknown>;
 /**
@@ -142,6 +153,9 @@ export declare function initializeAllApplicableNotificationBoxesFactory(context:
  *
  * Loads the summary document in the transaction, reads its current data, and delegates
  * to {@link initializeNotificationModelInTransaction} with the summary-specific template function.
+ *
+ * @param context - the initialization context with collection references and template functions
+ * @returns an async function that initializes a notification summary given params, document, and transaction
  */
 export declare function initializeNotificationSummaryInTransactionFactory(context: NotificationInitServerActionsContext): (params: InitializeNotificationModelParams, notificationSummaryDocument: NotificationSummaryDocument, transaction: Transaction) => Promise<{
     initialized: boolean;
@@ -152,6 +166,9 @@ export declare function initializeNotificationSummaryInTransactionFactory(contex
  *
  * Wraps the in-transaction summary initialization in a Firestore transaction
  * and follows the transform-and-validate pattern.
+ *
+ * @param context - the initialization context with Firestore access and template functions
+ * @returns a transform-and-validate function that initializes a single notification summary
  */
 export declare function initializeNotificationSummaryFactory(context: NotificationInitServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<InitializeNotificationModelParams, (notificationSummaryDocument: NotificationSummaryDocument) => Promise<NotificationSummaryDocument>, object, unknown>;
 /**
@@ -160,5 +177,8 @@ export declare function initializeNotificationSummaryFactory(context: Notificati
  * Batch-processes all {@link NotificationSummary} documents flagged for initialization
  * by querying for entries with `s=true` (setup needed), then initializing each in
  * parallel (up to 5 concurrent tasks). Loops until no more flagged summaries are found.
+ *
+ * @param context - the initialization context with Firestore access and collection references
+ * @returns a transform-and-validate function that batch-initializes all applicable notification summaries
  */
 export declare function initializeAllApplicableNotificationSummariesFactory(context: NotificationInitServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<InitializeAllApplicableNotificationSummariesParams, () => Promise<InitializeAllApplicableNotificationSummariesResult>, object, unknown>;

package/model/src/lib/notification/notification.config.service.d.ts

@@ -36,6 +36,7 @@ export declare class NotificationTemplateService {
      * pre-wired with the resolved factory for that type.
      *
      * @param type - the notification template type
+     * @returns a new {@link NotificationTemplateServiceInstance} bound to the given type
      */
     templateInstanceForType(type: NotificationTemplateType): NotificationTemplateServiceInstance;
 }
@@ -75,6 +76,7 @@ export interface NotificationTemplateServiceInstance {
  *
  * @param service - the parent template service
  * @param type - the template type to bind
+ * @returns a {@link NotificationTemplateServiceInstance} with the resolved factory for the type
  *
  * @example
  * ```ts

package/model/src/lib/notification/notification.create.run.d.ts

@@ -65,6 +65,7 @@ export interface CreateOrRunUniqueNotificationDocumentRunResult extends CreateNo
  * Does not support Firestore transactions, as running should occur outside of a transaction.
  *
  * @param input - creation and run configuration
+ * @returns the creation pair result with optional send/enqueue outcomes
  * @throws Error if the notification template is not flagged as unique
  *
  * @example

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

@@ -3,6 +3,8 @@ import { type FirestoreModelKey, type FirebaseAuthUserId } from '@dereekb/fireba
  * Creates an error indicating that a required notification ID was missing during creation.
  *
  * Thrown when attempting to create a {@link Notification} document without providing the mandatory ID field.
+ *
+ * @returns a precondition conflict error with the notification ID required error code
  */
 export declare function createNotificationIdRequiredError(): import("firebase-functions/https").HttpsError;
 /**
@@ -10,6 +12,8 @@ export declare function createNotificationIdRequiredError(): import("firebase-fu
  *
  * Thrown during initialization when `throwErrorIfAlreadyInitialized` is true and the model's
  * setup flag (`s`) indicates it was previously initialized.
+ *
+ * @returns a precondition conflict error with the already-initialized error code
  */
 export declare function notificationModelAlreadyInitializedError(): import("firebase-functions/https").HttpsError;
 /**
@@ -18,12 +22,15 @@ export declare function notificationModelAlreadyInitializedError(): import("fire
  * Thrown when the model key's collection name does not match any registered notification model type.
  *
  * @param key - the Firestore model key that has no registered notification model type
+ * @returns a precondition conflict error with the unregistered model type error code
  */
 export declare function notificationBoxUnregistredModelTypeInitializationError(key: FirestoreModelKey): import("firebase-functions/https").HttpsError;
 /**
  * Creates an error indicating that no {@link NotificationBox} exists for the target model.
  *
  * Thrown when an operation requires a NotificationBox but none has been created for the given model key.
+ *
+ * @returns a precondition conflict error with the box-not-found error code
  */
 export declare function notificationBoxDoesNotExist(): import("firebase-functions/https").HttpsError;
 /**
@@ -31,12 +38,16 @@ export declare function notificationBoxDoesNotExist(): import("firebase-function
  *
  * Thrown when the target recipient on the {@link NotificationBox} does not exist on the box
  * or does not have a UID, making it ineligible for exclusion.
+ *
+ * @returns a precondition conflict error with the invalid exclusion target error code
  */
 export declare function notificationBoxExclusionTargetInvalidError(): import("firebase-functions/https").HttpsError;
 /**
  * Creates an error indicating that a {@link NotificationBox} already exists for this model.
  *
  * Thrown when attempting to create a duplicate NotificationBox for a model that already has one.
+ *
+ * @returns a precondition conflict error with the box-exists error code
  */
 export declare function notificationBoxExistsForModelError(): import("firebase-functions/https").HttpsError;
 /**
@@ -44,6 +55,8 @@ export declare function notificationBoxExistsForModelError(): import("firebase-f
  *
  * Thrown when attempting to update a recipient that is not registered on the box
  * and `insert=true` was not passed to allow creating a new recipient entry.
+ *
+ * @returns a precondition conflict error with the recipient-not-found error code
  */
 export declare function notificationBoxRecipientDoesNotExistsError(): import("firebase-functions/https").HttpsError;
 /**
@@ -52,6 +65,7 @@ export declare function notificationBoxRecipientDoesNotExistsError(): import("fi
  * Thrown during {@link NotificationUser} creation when the provided UID cannot be found in Firebase Auth.
  *
  * @param uid - the Firebase Auth user ID that was not found
+ * @returns a precondition conflict error with the invalid-uid error code
  */
 export declare function notificationUserInvalidUidForCreateError(uid: FirebaseAuthUserId): import("firebase-functions/https").HttpsError;
 /**
@@ -61,6 +75,7 @@ export declare function notificationUserInvalidUidForCreateError(uid: FirebaseAu
  * and an operation attempts to insert them into a {@link NotificationBox}'s recipient list.
  *
  * @param uid - the Firebase Auth user ID of the blocked user
+ * @returns a precondition conflict error with the blocked-from-add error code
  */
 export declare function notificationUserBlockedFromBeingAddedToRecipientsError(uid: FirebaseAuthUserId): import("firebase-functions/https").HttpsError;
 /**
@@ -70,5 +85,6 @@ export declare function notificationUserBlockedFromBeingAddedToRecipientsError(u
  * and an operation attempts to modify their recipient settings on a {@link NotificationBox}.
  *
  * @param uid - the Firebase Auth user ID of the locked user
+ * @returns a precondition conflict error with the locked-config error code
  */
 export declare function notificationUserLockedConfigFromBeingUpdatedError(uid: FirebaseAuthUserId): import("firebase-functions/https").HttpsError;

package/model/src/lib/notification/notification.expedite.service.d.ts

@@ -1,5 +1,5 @@
 import { type CreateNotificationDocumentPairResult, type NotificationDocument, type SendNotificationParams, type SendNotificationResult } from '@dereekb/firebase';
-import { type NotificationServerActions } from './notification.action.service';
+import { type NotificationServerActions } from './notification.action.server';
 import { type Abstract, type Provider } from '@nestjs/common';
 import { type Maybe } from '@dereekb/util';
 export type NotificationExpediteServiceSendNotificationOptions = Pick<SendNotificationParams, 'ignoreSendAtThrottle' | 'throwErrorIfSent'>;
@@ -48,8 +48,8 @@ export interface NotificationExpediteServiceInstance {
 /**
  * Creates a new NotificationExpediteServiceInstance with the input NotificationExpediteService.
  
- * @param notificationExpediteService
- * @returns
+ * @param notificationExpediteService - the expedite service to use for sending
+ * @returns a new {@link NotificationExpediteServiceInstance} with an internal queue
  */
 export declare function notificationExpediteServiceInstance(notificationExpediteService: NotificationExpediteService): NotificationExpediteServiceInstance;
 /**
@@ -70,10 +70,14 @@ export declare class MutableNotificationExpediteService implements NotificationE
     private _notificationServerActions;
     /**
      * Returns the configured NotificationServerActions instance.
+     *
+     * @returns the current {@link NotificationServerActions} instance
      */
     getNotificationServerActions(): NotificationServerActions;
     /**
      * Sets the NotificationServerActions instance to use.
+     *
+     * @param notificationServerActions - the actions instance to configure
      */
     setNotificationServerActions(notificationServerActions: NotificationServerActions): void;
     sendNotification(notificationDocument: NotificationDocument, options?: NotificationExpediteServiceSendNotificationOptions): Promise<SendNotificationResult>;
@@ -83,11 +87,15 @@ export declare class MutableNotificationExpediteService implements NotificationE
  * Provides an instance of MutableNotificationExpediteService and NotificationExpediteService.
  *
  * This should generally be used in the global module of an app.
+ *
+ * @returns an array of NestJS providers for both MutableNotificationExpediteService and NotificationExpediteService
  */
 export declare function provideMutableNotificationExpediteService(): Provider[];
 /**
  * Convenience function that exports NotificationExpediteService and MutableNotificationExpediteService.
  *
  * This should generally be used in the global module of an app.
+ *
+ * @returns an array of abstract classes to export from the NestJS module
  */
 export declare function exportMutableNotificationExpediteService(): Abstract<any>[];

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

@@ -1,6 +1,6 @@
 import { type ModuleMetadata } from '@nestjs/common';
-import { NotificationInitServerActions, type NotificationInitServerActionsContextConfig } from './notification.action.init.service';
-import { type BaseNotificationServerActionsContext, NotificationServerActions, type NotificationServerActionsContext } from './notification.action.service';
+import { NotificationInitServerActions, type NotificationInitServerActionsContextConfig } from './notification.action.server.init';
+import { type BaseNotificationServerActionsContext, NotificationServerActions, type NotificationServerActionsContext } from './notification.action.server';
 import { NotificationTemplateService } from './notification.config.service';
 import { type Maybe } from '@dereekb/util';
 import { NotificationSendService } from './notification.send.service';
@@ -9,6 +9,13 @@ import { MutableNotificationExpediteService, NotificationExpediteService } from
 /**
  * Factory that assembles the full {@link NotificationServerActionsContext} by combining
  * the base context with the template, send, task, and expedite services.
+ *
+ * @param context - the base server actions context
+ * @param notificationTemplateService - resolves message factories for notification template types
+ * @param notificationSendService - handles sending notification messages
+ * @param notificationTaskService - handles notification task dispatch
+ * @param notificationsExpediteService - expedites immediate notification delivery
+ * @returns the assembled {@link NotificationServerActionsContext}
  */
 export declare function notificationServerActionsContextFactory(context: BaseNotificationServerActionsContext, notificationTemplateService: NotificationTemplateService, notificationSendService: NotificationSendService, notificationTaskService: NotificationTaskService, notificationsExpediteService: NotificationExpediteService): {
     notificationTemplateService: NotificationTemplateService;
@@ -29,11 +36,18 @@ export declare function notificationServerActionsContextFactory(context: BaseNot
 };
 /**
  * Factory that creates a {@link NotificationServerActions} instance from the assembled context.
+ *
+ * @param context - the assembled notification server actions context
+ * @returns a new {@link NotificationServerActions} instance
  */
-export declare function notificationServerActionsFactory(context: NotificationServerActionsContext, mutableNotificationExpediteService: MutableNotificationExpediteService): NotificationServerActions;
+export declare function notificationServerActionsFactory(context: NotificationServerActionsContext): NotificationServerActions;
 /**
  * Factory that creates a {@link NotificationInitServerActions} instance by merging the
  * server actions context with the init-specific configuration.
+ *
+ * @param context - the assembled notification server actions context
+ * @param notificationInitServerActionsContextConfig - init-specific configuration
+ * @returns a new {@link NotificationInitServerActions} instance
  */
 export declare function notificationInitServerActionsFactory(context: NotificationServerActionsContext, notificationInitServerActionsContextConfig: NotificationInitServerActionsContextConfig): NotificationInitServerActions;
 export interface ProvideAppNotificationMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
@@ -62,9 +76,8 @@ export interface ProvideAppNotificationMetadataConfig extends Pick<ModuleMetadat
  *
  * Be sure the class that delares the module using this function also extends AbstractAppNotificationModule.
  *
- * @param provide
- * @param useFactory
- * @returns
+ * @param config - module metadata configuration including dependency module and additional providers
+ * @returns the assembled {@link ModuleMetadata} for the notification module
  */
 export declare function appNotificationModuleMetadata(config: ProvideAppNotificationMetadataConfig): ModuleMetadata;
 /**

package/model/src/lib/notification/notification.send.service.notificationsummary.d.ts

@@ -33,6 +33,7 @@ export type FirestoreNotificationSummarySendService = NotificationSummarySendSer
  * Each summary update runs in a Firestore transaction to prevent concurrent write conflicts.
  *
  * @param config - service configuration including Firestore context and collection references
+ * @returns a {@link NotificationSummarySendService} backed by Firestore
  *
  * @example
  * ```ts

package/model/src/lib/notification/notification.send.service.text.d.ts

@@ -6,6 +6,8 @@ import { type NotificationTextSendService } from './notification.send.service';
  * Useful as a placeholder when your app's notification pipeline is fully wired for SMS
  * but actual delivery is not yet enabled, avoiding the need for conditional logic elsewhere.
  *
+ * @returns a no-op {@link NotificationTextSendService} that ignores all messages
+ *
  * @example
  * ```ts
  * const textService = ignoreSendNotificationTextSendService();

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

@@ -47,6 +47,7 @@ export interface NotificationTaskServiceConfig {
  * If all checkpoints are complete, the task is marked as done.
  *
  * @param config - handler configurations and optional validation list
+ * @returns a {@link NotificationTaskService} that dispatches tasks to the registered handlers
  *
  * @example
  * ```ts

package/model/src/lib/notification/notification.task.service.util.d.ts

@@ -8,6 +8,7 @@ import { type NotificationTaskCheckpointString, type NotificationTaskServiceHand
  *
  * @param inputCompletions - the current list of completed checkpoint strings
  * @param handleTaskResult - the handler result containing removal instructions
+ * @returns the filtered completions array with specified checkpoints removed
  *
  * @example
  * ```ts

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

@@ -219,6 +219,7 @@ export interface NotificationTaskSubtaskNotificationTaskHandlerConfig<I extends
  * such as storage file processing or other async workflows.
  *
  * @param factoryConfig - shared configuration including the input function, cleanup logic, and task type
+ * @returns a factory function that produces {@link NotificationTaskServiceTaskHandlerConfig} entries
  *
  * @example
  * ```ts
@@ -249,5 +250,7 @@ export declare class NotificationTaskSubTaskMissingRequiredDataTermination exten
 }
 /**
  * Creates a NotificationTaskSubTaskMissingRequiredDataTermination.
+ *
+ * @returns a new {@link NotificationTaskSubTaskMissingRequiredDataTermination} error instance
  */
 export declare function notificationTaskSubTaskMissingRequiredDataTermination(): NotificationTaskSubTaskMissingRequiredDataTermination;

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

@@ -8,6 +8,7 @@ import { type E164PhoneNumber, type EmailAddress, type Maybe, type PhoneNumber,
  * and initializes with an empty notifications array.
  *
  * @param model - the model key to associate the summary with
+ * @returns a blank {@link NotificationSummary} with creation timestamp and empty notifications
  *
  * @example
  * ```ts
@@ -142,8 +143,8 @@ export interface ExpandNotificationRecipientsResult {
  *
  * Recipients are each configurable and may be defined with as little info as a single contact info, or have multiple contact info pieces associated with them.
  *
- * @param input
- * @returns
+ * @param input - the notification, box, auth service, and recipient configuration
+ * @returns channel-specific recipient lists (email, text, notification summary) ready for delivery
  */
 export declare function expandNotificationRecipients(input: ExpandNotificationRecipientsInput): Promise<ExpandNotificationRecipientsResult>;
 /**
@@ -199,6 +200,7 @@ export interface UpdateNotificationUserNotificationBoxRecipientConfigResult {
  * Also re-applies send exclusions to the updated config array.
  *
  * @param input - the current state and intended change
+ * @returns the updated box config array and notification box recipient, if changes occurred
  * @throws notificationUserBlockedFromBeingAddedToRecipientsError when inserting a blocked user
  * @throws notificationUserLockedConfigFromBeingUpdatedError when updating a locked user's config
  */

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

@@ -1,5 +1,5 @@
 export * from './storagefile.action.server';
-export * from './storagefile.action.init.service';
+export * from './storagefile.action.server.init';
 export * from './storagefile.error';
 export * from './storagefile.module';
 export * from './storagefile.task.service.handler';