@dereekb/firebase-server 13.11.14 → 13.11.15

package/model/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@dereekb/firebase-server/model",
-  "version": "13.11.14",
+  "version": "13.11.15",
   "peerDependencies": {
-    "@dereekb/analytics": "13.11.14",
-    "@dereekb/date": "13.11.14",
-    "@dereekb/firebase": "13.11.14",
-    "@dereekb/firebase-server": "13.11.14",
-    "@dereekb/model": "13.11.14",
-    "@dereekb/nestjs": "13.11.14",
-    "@dereekb/rxjs": "13.11.14",
-    "@dereekb/util": "13.11.14",
+    "@dereekb/analytics": "13.11.15",
+    "@dereekb/date": "13.11.15",
+    "@dereekb/firebase": "13.11.15",
+    "@dereekb/firebase-server": "13.11.15",
+    "@dereekb/model": "13.11.15",
+    "@dereekb/nestjs": "13.11.15",
+    "@dereekb/rxjs": "13.11.15",
+    "@dereekb/util": "13.11.15",
     "@nestjs/common": "^11.1.19",
     "@nestjs/config": "^4.0.4",
     "archiver": "^7.0.1",

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

@@ -42,7 +42,7 @@ export interface MailgunNotificationEmailSendServiceConfig {
      */
     readonly messageBuilders: Record<NotificationSendMessageTemplateName, MailgunNotificationEmailSendServiceTemplateBuilder>;
 }
-export declare const MAILGUN_NOTIFICATION_EMAIL_SEND_SERVICE_DEFAULT_MAX_BATCH_SIZE_PER_REQUEST = 50;
+export declare const DEFAULT_MAILGUN_NOTIFICATION_EMAIL_SEND_SERVICE_MAX_BATCH_SIZE_PER_REQUEST = 50;
 /**
  * Function that converts the input into zero or more MailgunTemplateEmailRequests.
  */
@@ -58,8 +58,8 @@ export type MailgunNotificationEmailSendService = NotificationEmailSendService;
  * converts each batch to a {@link MailgunTemplateEmailRequest} using the configured template builders,
  * 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
+ * @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/notification.action.server.d.ts

@@ -64,8 +64,8 @@ export declare abstract class NotificationServerActions {
  * Creates a concrete {@link NotificationServerActions} implementation by wiring each action
  * to its factory function using the provided context.
  *
- * @param context - the fully assembled notification server actions context
- * @returns a fully wired {@link NotificationServerActions} instance
+ * @param context - The fully assembled notification server actions context.
+ * @returns A fully wired {@link NotificationServerActions} instance.
  *
  * @example
  * ```ts
@@ -81,8 +81,8 @@ 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
+ * @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>;
 /**
@@ -92,8 +92,8 @@ export declare function createNotificationUserFactory(context: NotificationServe
  * 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
+ * @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>;
 /**
@@ -104,8 +104,8 @@ export declare function updateNotificationUserFactory(context: NotificationServe
  * 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
+ * @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>;
 /**
@@ -115,8 +115,8 @@ export declare function resyncNotificationUserFactory(context: NotificationServe
  * 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
+ * @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>;
 /**
@@ -125,8 +125,8 @@ 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
+ * @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>;
 /**
@@ -135,8 +135,8 @@ 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
+ * @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>;
 /**
@@ -160,8 +160,8 @@ 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
+ * @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;
@@ -173,8 +173,8 @@ 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
+ * @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>;
 /**
@@ -183,8 +183,8 @@ export declare function createNotificationBoxFactory(context: NotificationServer
  * 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
+ * @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 {
@@ -199,8 +199,8 @@ 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
+ * @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 {
@@ -231,8 +231,8 @@ export interface UpdateNotificationBoxRecipientInTransactionResult {
  * 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
+ * @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>>;
 /**
@@ -241,8 +241,8 @@ 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
+ * @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;
@@ -274,8 +274,8 @@ 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
+ * @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>;
 /**
@@ -300,8 +300,8 @@ export interface SendQueuedNotificationsInput {
  * 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
+ * @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>;
 /**
@@ -311,8 +311,8 @@ export declare function sendQueuedNotificationsFactory(context: NotificationServ
  * 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
+ * @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>;
 /**
@@ -325,7 +325,7 @@ export declare function cleanupSentNotificationsFactory(context: NotificationSer
  * For each old day, all docs in the day's paged subcollection are deleted before the wrapper doc
  * itself, so a partial failure leaves the index pointing at zero pages rather than orphaned ones.
  *
- * @param context - the notification server actions context with paged-items collection access
- * @returns a transform-and-validate function that purges old logged-event days and returns aggregate counts
+ * @param context - The notification server actions context with paged-items collection access.
+ * @returns A transform-and-validate function that purges old logged-event days and returns aggregate counts.
  */
 export declare function cleanupOldNotificationLoggedEventDaysFactory(context: NotificationServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<CleanupOldNotificationLoggedEventDaysParams, () => Promise<CleanupOldNotificationLoggedEventDaysResult>, object, unknown>;

package/model/src/lib/notification/notification.action.server.init.d.ts

@@ -74,8 +74,8 @@ export declare abstract class NotificationInitServerActions {
  * Creates a concrete {@link NotificationInitServerActions} implementation by wiring each
  * initialization action to its factory function.
  *
- * @param context - the initialization context with template functions and Firestore access
- * @returns a fully wired {@link NotificationInitServerActions} instance
+ * @param context - The initialization context with template functions and Firestore access.
+ * @returns A fully wired {@link NotificationInitServerActions} instance.
  *
  * @example
  * ```ts
@@ -106,9 +106,9 @@ 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
+ * @param input - The document, transaction, template function, and options.
+ * @returns An object with `initialized` and `alreadyInitialized` boolean flags.
+ * @throws {Error} NotificationModelAlreadyInitializedError when `throwErrorIfAlreadyInitialized` is true.
  */
 export declare function initializeNotificationModelInTransaction<D extends FirestoreDocument<InitializedNotificationModel, any>>(input: InitializeNotificationModelInTransactionInput<D>): Promise<{
     initialized: boolean;
@@ -120,8 +120,8 @@ 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
+ * @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;
@@ -133,8 +133,8 @@ 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
+ * @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>;
 /**
@@ -144,8 +144,8 @@ export declare function initializeNotificationBoxFactory(context: NotificationIn
  * 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
+ * @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>;
 /**
@@ -154,8 +154,8 @@ 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
+ * @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;
@@ -167,8 +167,8 @@ 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
+ * @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>;
 /**
@@ -178,7 +178,7 @@ export declare function initializeNotificationSummaryFactory(context: Notificati
  * 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
+ * @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

@@ -27,16 +27,16 @@ export declare class NotificationTemplateService {
     /**
      * Returns the default factory and optional type-specific config for the given template type.
      *
-     * @param type - the notification template type to look up
-     * @returns a tuple of [defaultFactory, typeConfig] where either may be undefined
+     * @param type - The notification template type to look up.
+     * @returns A tuple of [defaultFactory, typeConfig] where either may be undefined.
      */
     configPairForType(type: NotificationTemplateType): [NotificationMessageFunctionFactory, Maybe<NotificationTemplateServiceTypeConfig>];
     /**
      * Creates a {@link NotificationTemplateServiceInstance} scoped to a single template type,
      * 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
+     * @param type - The notification template type.
+     * @returns A new {@link NotificationTemplateServiceInstance} bound to the given type.
      */
     templateInstanceForType(type: NotificationTemplateType): NotificationTemplateServiceInstance;
 }
@@ -74,9 +74,9 @@ export interface NotificationTemplateServiceInstance {
  * Resolves the factory from the service's type-specific config first, falling back to
  * a no-content default factory when no config is registered for the type.
  *
- * @param service - the parent template service
- * @param type - the template type to bind
- * @returns a {@link NotificationTemplateServiceInstance} with the resolved factory for the type
+ * @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

@@ -64,9 +64,9 @@ 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
+ * @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
  * ```ts

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

@@ -4,7 +4,7 @@ import { type FirestoreModelKey, type FirebaseAuthUserId } from '@dereekb/fireba
  *
  * 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
+ * @returns A precondition conflict error with the notification ID required error code.
  */
 export declare function createNotificationIdRequiredError(): import("firebase-functions/https").HttpsError;
 /**
@@ -13,7 +13,7 @@ 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
+ * @returns A precondition conflict error with the already-initialized error code.
  */
 export declare function notificationModelAlreadyInitializedError(): import("firebase-functions/https").HttpsError;
 /**
@@ -21,8 +21,8 @@ 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
+ * @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;
 /**
@@ -30,7 +30,7 @@ export declare function notificationBoxUnregistredModelTypeInitializationError(k
  *
  * 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
+ * @returns A precondition conflict error with the box-not-found error code.
  */
 export declare function notificationBoxDoesNotExist(): import("firebase-functions/https").HttpsError;
 /**
@@ -39,7 +39,7 @@ 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
+ * @returns A precondition conflict error with the invalid exclusion target error code.
  */
 export declare function notificationBoxExclusionTargetInvalidError(): import("firebase-functions/https").HttpsError;
 /**
@@ -47,7 +47,7 @@ export declare function notificationBoxExclusionTargetInvalidError(): import("fi
  *
  * 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
+ * @returns A precondition conflict error with the box-exists error code.
  */
 export declare function notificationBoxExistsForModelError(): import("firebase-functions/https").HttpsError;
 /**
@@ -56,7 +56,7 @@ 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
+ * @returns A precondition conflict error with the recipient-not-found error code.
  */
 export declare function notificationBoxRecipientDoesNotExistsError(): import("firebase-functions/https").HttpsError;
 /**
@@ -64,8 +64,8 @@ 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
+ * @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;
 /**
@@ -74,8 +74,8 @@ export declare function notificationUserInvalidUidForCreateError(uid: FirebaseAu
  * Thrown when a {@link NotificationUser} has the `bk` (blocked-from-add) flag set on their config
  * 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
+ * @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;
 /**
@@ -84,7 +84,7 @@ export declare function notificationUserBlockedFromBeingAddedToRecipientsError(u
  * Thrown when a {@link NotificationUser} has the `lk` (locked) flag set on their config
  * 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
+ * @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

@@ -47,9 +47,9 @@ export interface NotificationExpediteServiceInstance {
 }
 /**
  * Creates a new NotificationExpediteServiceInstance with the input NotificationExpediteService.
- 
- * @param notificationExpediteService - the expedite service to use for sending
- * @returns a new {@link NotificationExpediteServiceInstance} with an internal queue
+ *
+ * @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;
 /**
@@ -71,13 +71,13 @@ export declare class MutableNotificationExpediteService implements NotificationE
     /**
      * Returns the configured NotificationServerActions instance.
      *
-     * @returns the current {@link NotificationServerActions} instance
+     * @returns The current {@link NotificationServerActions} instance.
      */
     getNotificationServerActions(): NotificationServerActions;
     /**
      * Sets the NotificationServerActions instance to use.
      *
-     * @param notificationServerActions - the actions instance to configure
+     * @param notificationServerActions - The actions instance to configure.
      */
     setNotificationServerActions(notificationServerActions: NotificationServerActions): void;
     sendNotification(notificationDocument: NotificationDocument, options?: NotificationExpediteServiceSendNotificationOptions): Promise<SendNotificationResult>;
@@ -88,7 +88,7 @@ export declare class MutableNotificationExpediteService implements NotificationE
  *
  * This should generally be used in the global module of an app.
  *
- * @returns an array of NestJS providers for both MutableNotificationExpediteService and NotificationExpediteService
+ * @returns Array of NestJS providers for both MutableNotificationExpediteService and NotificationExpediteService.
  */
 export declare function provideMutableNotificationExpediteService(): Provider[];
 /**
@@ -96,6 +96,6 @@ export declare function provideMutableNotificationExpediteService(): Provider[];
  *
  * This should generally be used in the global module of an app.
  *
- * @returns an array of abstract classes to export from the NestJS module
+ * @returns The abstract classes to export from the NestJS module.
  */
 export declare function exportMutableNotificationExpediteService(): Abstract<any>[];

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

@@ -10,12 +10,12 @@ 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}
+ * @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;
@@ -41,17 +41,17 @@ 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
+ * @param context - The assembled notification server actions context.
+ * @returns A new {@link NotificationServerActions} instance.
  */
 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
+ * @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'> {
@@ -80,8 +80,8 @@ export interface ProvideAppNotificationMetadataConfig extends Pick<ModuleMetadat
  *
  * Be sure the class that delares the module using this function also extends AbstractAppNotificationModule.
  *
- * @param config - module metadata configuration including dependency module and additional providers
- * @returns the assembled {@link ModuleMetadata} for the notification module
+ * @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

@@ -32,8 +32,8 @@ 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
+ * @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,7 +6,7 @@ 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
+ * @returns A no-op {@link NotificationTextSendService} that ignores all messages.
  *
  * @example
  * ```ts

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

@@ -46,8 +46,8 @@ export interface NotificationTaskServiceConfig {
  * finds the next uncompleted checkpoint in the flow and executes its handler function.
  * 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
+ * @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

@@ -6,9 +6,9 @@ import { type NotificationTaskCheckpointString, type NotificationTaskServiceHand
  * If `removeFromCompletedCheckpoints` is set, removes only those specific checkpoints.
  * Otherwise, returns the original array unchanged.
  *
- * @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
+ * @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