@dereekb/firebase 13.11.13 → 13.11.15

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

@@ -13,20 +13,20 @@ import { type NotificationTemplateType } from './notification.id';
  * Applies an array of config entry params to a {@link NotificationBoxRecipientTemplateConfigRecord},
  * inserting new entries, merging updates, and removing entries marked with `remove: true`.
  *
- * @param a - existing config record
- * @param b - array of update params to apply
- * @param limitToAllowedConfigTypes - when provided, filters the result to only include these template types
- * @returns the updated config record, or undefined if no changes were made
+ * @param a - Existing config record.
+ * @param b - Array of update params to apply.
+ * @param limitToAllowedConfigTypes - When provided, filters the result to only include these template types.
+ * @returns The updated config record, or undefined if no changes were made.
  */
 export declare function updateNotificationBoxRecipientTemplateConfigRecord(a: NotificationBoxRecipientTemplateConfigRecord, b: NotificationBoxRecipientTemplateConfigArrayEntryParam[], limitToAllowedConfigTypes?: Maybe<Iterable<NotificationTemplateType>>): Maybe<NotificationBoxRecipientTemplateConfigRecord>;
 /**
  * Applies {@link UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams} to an existing
  * {@link NotificationUserDefaultNotificationBoxRecipientConfig}, producing an updated config.
  *
- * @param a - existing config
- * @param b - update params to apply
- * @param limitToAllowedConfigTypes - when provided, filters config types to only allowed template types
- * @returns the updated default recipient config
+ * @param a - Existing config.
+ * @param b - Update params to apply.
+ * @param limitToAllowedConfigTypes - When provided, filters config types to only allowed template types.
+ * @returns The updated default recipient config.
  */
 export declare function updateNotificationUserDefaultNotificationBoxRecipientConfig(a: NotificationUserDefaultNotificationBoxRecipientConfig, b: UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams, limitToAllowedConfigTypes?: Maybe<Iterable<NotificationTemplateType>>): NotificationUserDefaultNotificationBoxRecipientConfig;
 /**
@@ -35,10 +35,10 @@ export declare function updateNotificationUserDefaultNotificationBoxRecipientCon
  *
  * Automatically sets `ns = true` (needs sync) when changes are detected and the recipient has been indexed.
  *
- * @param a - existing per-box recipient config
- * @param b - update params to apply
- * @param limitToAllowedConfigTypes - when provided, filters template config types to only allowed types
- * @returns the updated config if changes were detected, or undefined if no changes occurred
+ * @param a - Existing per-box recipient config.
+ * @param b - Update params to apply.
+ * @param limitToAllowedConfigTypes - When provided, filters template config types to only allowed types.
+ * @returns The updated config if changes were detected, or undefined if no changes occurred.
  */
 export declare function updateNotificationUserNotificationBoxRecipientConfigIfChanged(a: NotificationUserNotificationBoxRecipientConfig, b: UpdateNotificationUserNotificationBoxRecipientParams, limitToAllowedConfigTypes?: Maybe<Iterable<NotificationTemplateType>>): Maybe<NotificationUserNotificationBoxRecipientConfig>;
 /**
@@ -50,9 +50,9 @@ export declare function updateNotificationUserNotificationBoxRecipientConfigIfCh
  *
  * Returns `undefined` if no changes were made.
  *
- * @param a - existing per-box recipient config array
- * @param b - array of update params to apply to matching boxes
- * @param filterWithService - optional service used to filter template types to only those valid for each box's model
- * @returns the updated config array if any changes occurred, or undefined if nothing changed
+ * @param a - Existing per-box recipient config array.
+ * @param b - Array of update params to apply to matching boxes.
+ * @param filterWithService - Optional service used to filter template types to only those valid for each box's model.
+ * @returns The updated config array if any changes occurred, or undefined if nothing changed.
  */
 export declare function updateNotificationUserNotificationBoxRecipientConfigs(a: NotificationUserNotificationBoxRecipientConfig[], b: UpdateNotificationUserNotificationBoxRecipientParams[], filterWithService?: AppNotificationTemplateTypeInfoRecordService): Maybe<NotificationUserNotificationBoxRecipientConfig[]>;

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

@@ -31,30 +31,30 @@ export interface NotificationBoxRecipientTemplateConfig {
     /**
      * Master toggle. When set, acts as the default for all channels that aren't individually configured.
      */
-    sd?: Maybe<boolean>;
+    readonly sd?: Maybe<boolean>;
     /**
      * Email channel enabled/disabled.
      */
-    se?: Maybe<boolean>;
+    readonly se?: Maybe<boolean>;
     /**
      * Text/SMS channel enabled/disabled.
      */
-    st?: Maybe<boolean>;
+    readonly st?: Maybe<boolean>;
     /**
      * Push notification channel enabled/disabled.
      */
-    sp?: Maybe<boolean>;
+    readonly sp?: Maybe<boolean>;
     /**
      * In-app notification summary channel enabled/disabled.
      */
-    sn?: Maybe<boolean>;
+    readonly sn?: Maybe<boolean>;
 }
 /**
  * Merges two {@link NotificationBoxRecipientTemplateConfig} objects, preferring values from `a` over `b`.
  *
- * @param a - primary config whose defined values take precedence
- * @param b - fallback config supplying values when `a` fields are undefined
- * @returns the merged template config with values from `a` preferred over `b`
+ * @param a - Primary config whose defined values take precedence.
+ * @param b - Fallback config supplying values when `a` fields are undefined.
+ * @returns The merged template config with values from `a` preferred over `b`
  *
  * @example
  * ```ts
@@ -71,8 +71,8 @@ export declare function mergeNotificationBoxRecipientTemplateConfigs(a?: Maybe<N
  *
  * This produces the "effective" configuration used at send time, where each channel has a definite boolean.
  *
- * @param a - the template config to resolve
- * @returns the effective config with each channel flag filled in using the send-default fallback
+ * @param a - The template config to resolve.
+ * @returns The effective config with each channel flag filled in using the send-default fallback.
  *
  * @example
  * ```ts
@@ -121,9 +121,9 @@ export interface NotificationRecipient {
  *
  * Automatically clears the summary ID (`s`) when a `uid` is present.
  *
- * @param a - existing recipient to update
- * @param b - partial values to apply on top of the existing recipient
- * @returns the updated recipient with merged values
+ * @param a - Existing recipient to update.
+ * @param b - Partial values to apply on top of the existing recipient.
+ * @returns The updated recipient with merged values.
  */
 export declare function updateNotificationRecipient(a: NotificationRecipient, b: Partial<NotificationRecipient>): NotificationRecipient;
 /**
@@ -192,9 +192,9 @@ export interface NotificationBoxRecipient extends NotificationRecipient, IndexRe
 /**
  * Creates a new {@link NotificationBoxRecipient} for a user with an empty config record.
  *
- * @param uid - the user's Firebase auth UID
- * @param i - the recipient's index position in the box's recipient array
- * @returns a new recipient entry with the given uid and index and an empty template config record
+ * @param uid - The user's Firebase auth UID.
+ * @param i - The recipient's index position in the box's recipient array.
+ * @returns A new recipient entry with the given uid and index and an empty template config record.
  */
 export declare function newNotificationBoxRecipientForUid(uid: FirebaseAuthUserId, i: number): NotificationBoxRecipient;
 /**
@@ -211,18 +211,18 @@ export interface NotificationUserDefaultNotificationBoxRecipientConfig extends O
     /**
      * Locked flag. Prevents the NotificationBox from modifying this user's recipient config.
      */
-    lk?: Maybe<SavedToFirestoreIfTrue>;
+    readonly lk?: Maybe<SavedToFirestoreIfTrue>;
     /**
      * Blocked flag. Prevents the NotificationBox from re-adding this user as a recipient.
      */
-    bk?: Maybe<SavedToFirestoreIfTrue>;
+    readonly bk?: Maybe<SavedToFirestoreIfTrue>;
 }
 /**
  * Merges two {@link NotificationUserDefaultNotificationBoxRecipientConfig} objects, preferring defined values from `a` over `b`.
  *
- * @param a - primary config whose defined values take precedence
- * @param b - fallback config supplying values when `a` fields are undefined
- * @returns the merged config
+ * @param a - Primary config whose defined values take precedence.
+ * @param b - Fallback config supplying values when `a` fields are undefined.
+ * @returns The merged config.
  */
 export declare function mergeNotificationUserDefaultNotificationBoxRecipientConfig(a: NotificationUserDefaultNotificationBoxRecipientConfig, b: NotificationUserDefaultNotificationBoxRecipientConfig): NotificationUserDefaultNotificationBoxRecipientConfig;
 /**
@@ -242,26 +242,26 @@ export interface NotificationUserNotificationBoxRecipientConfig extends Omit<Not
     /**
      * ID of the {@link NotificationBox} this config mirrors. The related model key can be inferred via {@link inferNotificationBoxRelatedModelKey}.
      */
-    nb: NotificationBoxId;
+    readonly nb: NotificationBoxId;
     /**
      * Self-removal flag. When set, the user has removed themselves from this box.
      *
      * Only the box owner can restore a removed user. Users typically prefer the `f` (opt-out) flag instead,
      * which stops delivery without removing the subscription. The config is retained unless the user explicitly deletes it.
      */
-    rm?: Maybe<SavedToFirestoreIfTrue>;
+    readonly rm?: Maybe<SavedToFirestoreIfTrue>;
     /**
      * Whether this config needs to be synced with the corresponding {@link NotificationBox} recipient entry.
      */
-    ns?: Maybe<NeedsSyncBoolean>;
+    readonly ns?: Maybe<NeedsSyncBoolean>;
     /**
      * Locked flag. Prevents the box from modifying this user's recipient config.
      */
-    lk?: Maybe<SavedToFirestoreIfTrue>;
+    readonly lk?: Maybe<SavedToFirestoreIfTrue>;
     /**
      * Blocked flag. Prevents the box from re-adding this user as a recipient.
      */
-    bk?: Maybe<SavedToFirestoreIfTrue>;
+    readonly bk?: Maybe<SavedToFirestoreIfTrue>;
 }
 /**
  * Bit positions for encoding {@link NotificationBoxRecipientTemplateConfig} as a {@link BitwiseEncodedSet}.
@@ -296,9 +296,9 @@ export type NotificationBoxRecipientTemplateConfigRecord = Record<NotificationTe
 /**
  * Merges two {@link NotificationBoxRecipientTemplateConfigRecord} objects, preferring defined values from `a`.
  *
- * @param a - primary record whose defined values take precedence
- * @param b - fallback record supplying values when `a` entries are undefined
- * @returns the merged template config record
+ * @param a - Primary record whose defined values take precedence.
+ * @param b - Fallback record supplying values when `a` entries are undefined.
+ * @returns The merged template config record.
  */
 export declare function mergeNotificationBoxRecipientTemplateConfigRecords(a: NotificationBoxRecipientTemplateConfigRecord, b: NotificationBoxRecipientTemplateConfigRecord): NotificationBoxRecipientTemplateConfigRecord;
 /**
@@ -310,7 +310,8 @@ export type EncodedNotificationBoxRecipientTemplateConfigRecord = Record<Notific
  * Creates a Firestore field converter for {@link NotificationBoxRecipientTemplateConfigRecord},
  * using bitwise encoding for compact storage.
  *
- * @returns a Firestore field converter that encodes and decodes template config records using bitwise encoding
+ * @returns A Firestore field converter that encodes and decodes template config records using bitwise encoding.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreNotificationBoxRecipientTemplateConfigRecord(): import("../..").FirestoreModelFieldMapFunctionsConfig<import("../..").FirestoreEncodedObjectMapFieldValueType<NotificationBoxRecipientTemplateConfig, string>, import("../..").FirestoreMapFieldType<number, string>>;
@@ -344,8 +345,8 @@ export type NotificationBoxRecipientTemplateConfigArray = NotificationBoxRecipie
 /**
  * Converts a {@link NotificationBoxRecipientTemplateConfigRecord} to an array of entries with their type keys.
  *
- * @param input - the template config record to convert
- * @returns an array of entries each containing a type key and the corresponding channel config
+ * @param input - Template config record keyed by template type.
+ * @returns Flattened entries combining each template type with its channel config.
  *
  * @example
  * ```ts
@@ -357,8 +358,8 @@ export declare function notificationBoxRecipientTemplateConfigRecordToArray(inpu
 /**
  * Converts a {@link NotificationBoxRecipientTemplateConfigArray} back to a {@link NotificationBoxRecipientTemplateConfigRecord}.
  *
- * @param input - the array of typed config entries to convert
- * @returns a record keyed by template type
+ * @param input - Flattened entries that include the template type and channel config.
+ * @returns Template config record keyed by template type.
  */
 export declare function notificationBoxRecipientTemplateConfigArrayToRecord(input: NotificationBoxRecipientTemplateConfigArray): NotificationBoxRecipientTemplateConfigRecord;
 /**

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

@@ -124,8 +124,9 @@ export interface CreateNotificationTemplateInput extends Partial<Omit<CreateNoti
  * Maps friendly field names (`subject`, `message`, `createdBy`, etc.) to their Firestore abbreviations
  * and filters out null/undefined metadata values.
  *
- * @param input - friendly input with readable field names
- * @returns the low-level template using Firestore field abbreviations
+ * @param input - Friendly input with readable field names.
+ * @returns The low-level template using Firestore field abbreviations.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function createNotificationTemplate(input: CreateNotificationTemplateInput): CreateNotificationTemplate;
@@ -154,8 +155,8 @@ export interface ShouldSendCreatedNotificationInput {
  *
  * Returns false if `sendNotification` is explicitly false, or if the throttle window hasn't elapsed.
  *
- * @param input - the send control parameters including the toggle and throttle configuration
- * @returns true if the notification should be created and sent
+ * @param input - The send control parameters including the toggle and throttle configuration.
+ * @returns True if the notification should be created and sent.
  */
 export declare function shouldSendCreatedNotificationInput(input: ShouldSendCreatedNotificationInput): boolean;
 /**
@@ -218,19 +219,20 @@ export interface CreateNotificationDocumentPairResult extends Pick<CreateNotific
  *
  * For unique task notifications, generates a deterministic document ID from the target model and task type.
  *
- * @param input - the creation parameters including template, context, and accessor
- * @returns the document reference and notification data pair, with `notificationCreated` set to false
- * @throws {Error} When neither an accessor nor sufficient context is provided
- * @throws {Error} When `unique=true` but no target model is specified
+ * @param input - The creation parameters including template, context, and accessor.
+ * @returns The document reference and notification data pair, with `notificationCreated` set to false.
+ * @throws {Error} When neither an accessor nor sufficient context is provided.
+ * @throws {Error} When `unique=true` but no target model is specified.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function createNotificationDocumentPair(input: CreateNotificationDocumentPairInput): CreateNotificationDocumentPairResult;
 /**
  * Internal function used by createNotificationDocument().
  *
- * @param input - send control parameters (throttle settings, shouldCreateNotification flag)
- * @param pair - the document pair created by {@link createNotificationDocumentPair}
- * @returns the pair with `notificationCreated` updated to reflect whether the document was saved
+ * @param input - Send control parameters (throttle settings, shouldCreateNotification flag)
+ * @param pair - The document pair created by {@link createNotificationDocumentPair}
+ * @returns The pair with `notificationCreated` updated to reflect whether the document was saved.
  */
 export declare function _createNotificationDocumentFromPair(input: Pick<CreateNotificationDocumentPairInput, 'shouldCreateNotification' | keyof ShouldSendCreatedNotificationInput>, pair: CreateNotificationDocumentPairResult): Promise<CreateNotificationDocumentPairResult>;
 /**
@@ -239,8 +241,8 @@ export declare function _createNotificationDocumentFromPair(input: Pick<CreateNo
  * For unique tasks with `overrideExistingTask`, uses `set()` to replace existing documents.
  * Otherwise uses `create()` which fails if the document already exists.
  *
- * @param input - the creation parameters including template, context, send control settings
- * @returns the document pair with `notificationCreated` reflecting whether the document was saved
+ * @param input - The creation parameters including template, context, send control settings.
+ * @returns The document pair with `notificationCreated` reflecting whether the document was saved.
  */
 export declare function createNotificationDocument(input: CreateNotificationDocumentPairInput): Promise<CreateNotificationDocumentPairResult>;
 /**
@@ -248,7 +250,7 @@ export declare function createNotificationDocument(input: CreateNotificationDocu
  *
  * Returns `undefined` if the notification was not created.
  *
- * @param input - the creation parameters including template, context, and send control settings
- * @returns the document pair if the notification was created, or undefined if it was skipped
+ * @param input - The creation parameters including template, context, and send control settings.
+ * @returns The document pair if the notification was created, or undefined if it was skipped.
  */
 export declare function createNotificationDocumentIfSending(input: CreateNotificationDocumentPairInput): Promise<Maybe<CreateNotificationDocumentPairResult>>;

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

@@ -16,8 +16,8 @@ export type CreateNotificationLoggedEventTemplateInput = Omit<CreateNotification
  * {@link createNotificationDocumentPair}), so it is invisible to the send loop and is archived to
  * {@link NotificationLoggedEventDay} during cleanup.
  *
- * @param input - logged-event template input parameters
- * @returns the configured logged-event notification template
+ * @param input - Logged-event template input parameters.
+ * @returns The configured logged-event notification template.
  * @throws {Error} When `notificationModel` is not provided.
  *
  * @example
@@ -28,6 +28,7 @@ export type CreateNotificationLoggedEventTemplateInput = Omit<CreateNotification
  *   data: { workerId: 'w_001', at: new Date().toISOString() }
  * });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function createNotificationLoggedEventTemplate(input: CreateNotificationLoggedEventTemplateInput): CreateNotificationLoggedEventTemplate;

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

@@ -28,8 +28,8 @@ export interface CreateNotificationTaskTemplateInput extends Omit<CreateNotifica
 /**
  * Creates a {@link CreateNotificationTaskTemplate} with `TASK_NOTIFICATION` send type and no recipients.
  *
- * @param input - task template input parameters
- * @returns the configured task notification template
+ * @param input - Task template input parameters.
+ * @returns The configured task notification template.
  * @throws {Error} When `unique=true` but no `notificationModel` or target model is specified.
  *
  * @example
@@ -41,6 +41,7 @@ export interface CreateNotificationTaskTemplateInput extends Omit<CreateNotifica
  *   data: { reportType: 'monthly' }
  * });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function createNotificationTaskTemplate(input: CreateNotificationTaskTemplateInput): CreateNotificationTaskTemplate;

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

@@ -153,8 +153,8 @@ export declare const notificationUserConverter: import("../..").SnapshotConverte
 /**
  * Creates a Firestore collection reference for {@link NotificationUser} documents.
  *
- * @param context - Firestore context to create the collection reference from
- * @returns a typed collection reference for NotificationUser documents
+ * @param context - Firestore context to create the collection reference from.
+ * @returns A typed collection reference for NotificationUser documents.
  */
 export declare function notificationUserCollectionReference(context: FirestoreContext): CollectionReference<NotificationUser>;
 /**
@@ -164,8 +164,8 @@ export type NotificationUserFirestoreCollection = FirestoreCollection<Notificati
 /**
  * Creates a typed {@link NotificationUserFirestoreCollection} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection to
- * @returns a typed Firestore collection for NotificationUser documents
+ * @param firestoreContext - Firestore context to bind the collection to.
+ * @returns A typed Firestore collection for NotificationUser documents.
  */
 export declare function notificationUserFirestoreCollection(firestoreContext: FirestoreContext): NotificationUserFirestoreCollection;
 /**
@@ -256,8 +256,8 @@ export declare const notificationSummaryConverter: import("../..").SnapshotConve
 /**
  * Creates a Firestore collection reference for {@link NotificationSummary} documents.
  *
- * @param context - Firestore context to create the collection reference from
- * @returns a typed collection reference for NotificationSummary documents
+ * @param context - Firestore context to create the collection reference from.
+ * @returns A typed collection reference for NotificationSummary documents.
  */
 export declare function notificationSummaryCollectionReference(context: FirestoreContext): CollectionReference<NotificationSummary>;
 /**
@@ -267,8 +267,8 @@ export type NotificationSummaryFirestoreCollection = FirestoreCollection<Notific
 /**
  * Creates a typed {@link NotificationSummaryFirestoreCollection} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection to
- * @returns a typed Firestore collection for NotificationSummary documents
+ * @param firestoreContext - Firestore context to bind the collection to.
+ * @returns A typed Firestore collection for NotificationSummary documents.
  */
 export declare function notificationSummaryFirestoreCollection(firestoreContext: FirestoreContext): NotificationSummaryFirestoreCollection;
 /**
@@ -361,8 +361,8 @@ export declare const notificationBoxConverter: import("../..").SnapshotConverter
 /**
  * Creates a Firestore collection reference for {@link NotificationBox} documents.
  *
- * @param context - Firestore context to create the collection reference from
- * @returns a typed collection reference for NotificationBox documents
+ * @param context - Firestore context to create the collection reference from.
+ * @returns A typed collection reference for NotificationBox documents.
  */
 export declare function notificationBoxCollectionReference(context: FirestoreContext): CollectionReference<NotificationBox>;
 /**
@@ -372,8 +372,8 @@ export type NotificationBoxFirestoreCollection = FirestoreCollection<Notificatio
 /**
  * Creates a typed {@link NotificationBoxFirestoreCollection} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection to
- * @returns a typed Firestore collection for NotificationBox documents
+ * @param firestoreContext - Firestore context to bind the collection to.
+ * @returns A typed Firestore collection for NotificationBox documents.
  */
 export declare function notificationBoxFirestoreCollection(firestoreContext: FirestoreContext): NotificationBoxFirestoreCollection;
 /**
@@ -679,8 +679,9 @@ export declare const notificationConverter: import("../..").SnapshotConverterFun
 /**
  * Creates a factory that produces {@link Notification} subcollection references for a given {@link NotificationBoxDocument} parent.
  *
- * @param context - Firestore context to create subcollection references from
- * @returns a factory function that creates collection references for a given NotificationBox parent
+ * @param context - Firestore context to create subcollection references from.
+ * @returns A factory function that creates collection references for a given NotificationBox parent.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function notificationCollectionReferenceFactory(context: FirestoreContext): (notificationBox: NotificationBoxDocument) => CollectionReference<Notification>;
@@ -695,16 +696,17 @@ export type NotificationFirestoreCollectionFactory = (parent: NotificationBoxDoc
 /**
  * Creates a {@link NotificationFirestoreCollectionFactory} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection factory to
- * @returns a factory that creates typed Firestore subcollections for Notification documents
+ * @param firestoreContext - Firestore context to bind the collection factory to.
+ * @returns A factory that creates typed Firestore subcollections for Notification documents.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function notificationFirestoreCollectionFactory(firestoreContext: FirestoreContext): NotificationFirestoreCollectionFactory;
 /**
  * Creates a collection group reference for querying all {@link Notification} documents across all {@link NotificationBox} parents.
  *
- * @param context - Firestore context to create the collection group reference from
- * @returns a typed collection group for querying Notification documents across all parents
+ * @param context - Firestore context to create the collection group reference from.
+ * @returns A typed collection group for querying Notification documents across all parents.
  */
 export declare function notificationCollectionReference(context: FirestoreContext): CollectionGroup<Notification>;
 /**
@@ -714,8 +716,8 @@ export type NotificationFirestoreCollectionGroup = FirestoreCollectionGroup<Noti
 /**
  * Creates a typed {@link NotificationFirestoreCollectionGroup} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection group to
- * @returns a typed Firestore collection group for querying Notification documents across all parents
+ * @param firestoreContext - Firestore context to bind the collection group to.
+ * @returns A typed Firestore collection group for querying Notification documents across all parents.
  */
 export declare function notificationFirestoreCollectionGroup(firestoreContext: FirestoreContext): NotificationFirestoreCollectionGroup;
 /**
@@ -761,8 +763,9 @@ export declare const notificationWeekConverter: import("../..").SnapshotConverte
 /**
  * Creates a factory that produces {@link NotificationWeek} subcollection references for a given {@link NotificationBoxDocument} parent.
  *
- * @param context - Firestore context to create subcollection references from
- * @returns a factory function that creates collection references for a given NotificationBox parent
+ * @param context - Firestore context to create subcollection references from.
+ * @returns A factory function that creates collection references for a given NotificationBox parent.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function notificationWeekCollectionReferenceFactory(context: FirestoreContext): (notificationBox: NotificationBoxDocument) => CollectionReference<NotificationWeek>;
@@ -777,16 +780,17 @@ export type NotificationWeekFirestoreCollectionFactory = (parent: NotificationBo
 /**
  * Creates a {@link NotificationWeekFirestoreCollectionFactory} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection factory to
- * @returns a factory that creates typed Firestore subcollections for NotificationWeek documents
+ * @param firestoreContext - Firestore context to bind the collection factory to.
+ * @returns A factory that creates typed Firestore subcollections for NotificationWeek documents.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function notificationWeekFirestoreCollectionFactory(firestoreContext: FirestoreContext): NotificationWeekFirestoreCollectionFactory;
 /**
  * Creates a collection group reference for querying all {@link NotificationWeek} documents across all {@link NotificationBox} parents.
  *
- * @param context - Firestore context to create the collection group reference from
- * @returns a typed collection group for querying NotificationWeek documents across all parents
+ * @param context - Firestore context to create the collection group reference from.
+ * @returns A typed collection group for querying NotificationWeek documents across all parents.
  */
 export declare function notificationWeekCollectionReference(context: FirestoreContext): CollectionGroup<NotificationWeek>;
 /**
@@ -796,8 +800,8 @@ export type NotificationWeekFirestoreCollectionGroup = FirestoreCollectionGroup<
 /**
  * Creates a typed {@link NotificationWeekFirestoreCollectionGroup} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection group to
- * @returns a typed Firestore collection group for querying NotificationWeek documents across all parents
+ * @param firestoreContext - Firestore context to bind the collection group to.
+ * @returns A typed Firestore collection group for querying NotificationWeek documents across all parents.
  */
 export declare function notificationWeekFirestoreCollectionGroup(firestoreContext: FirestoreContext): NotificationWeekFirestoreCollectionGroup;
 /**
@@ -821,7 +825,7 @@ export declare const notificationLoggedEventDayPageIdentity: import("../..").Fir
  * day pages. Wraps the existing {@link firestoreNotificationItem} sub-object converter so individual
  * items round-trip through the same field rules used everywhere else NotificationItems are persisted.
  */
-export declare const notificationLoggedEventDayItemConverter: PagedItemConverter<NotificationItem>;
+export declare const NOTIFICATION_LOGGED_EVENT_DAY_ITEM_CONVERTER: PagedItemConverter<NotificationItem>;
 /**
  * Day-keyed wrapper document for a single day's worth of archived logged-event notifications under a
  * {@link NotificationBox}.
@@ -853,8 +857,9 @@ export declare const notificationLoggedEventDayConverter: import("../..").Snapsh
 /**
  * Creates a factory that produces {@link NotificationLoggedEventDay} subcollection references for a given {@link NotificationBoxDocument} parent.
  *
- * @param context - Firestore context to create subcollection references from
- * @returns a factory function that creates collection references for a given NotificationBox parent
+ * @param context - Firestore context to create subcollection references from.
+ * @returns A factory function that creates collection references for a given NotificationBox parent.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function notificationLoggedEventDayCollectionReferenceFactory(context: FirestoreContext): (notificationBox: NotificationBoxDocument) => CollectionReference<NotificationLoggedEventDay>;
@@ -869,16 +874,17 @@ export type NotificationLoggedEventDayFirestoreCollectionFactory = (parent: Noti
 /**
  * Creates a {@link NotificationLoggedEventDayFirestoreCollectionFactory} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection factory to
- * @returns a factory that creates typed Firestore subcollections for NotificationLoggedEventDay wrapper documents
+ * @param firestoreContext - Firestore context to bind the collection factory to.
+ * @returns A factory that creates typed Firestore subcollections for NotificationLoggedEventDay wrapper documents.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function notificationLoggedEventDayFirestoreCollectionFactory(firestoreContext: FirestoreContext): NotificationLoggedEventDayFirestoreCollectionFactory;
 /**
  * Creates a collection group reference for querying all {@link NotificationLoggedEventDay} documents across all {@link NotificationBox} parents.
  *
- * @param context - Firestore context to create the collection group reference from
- * @returns a typed collection group for querying NotificationLoggedEventDay documents across all parents
+ * @param context - Firestore context to create the collection group reference from.
+ * @returns A typed collection group for querying NotificationLoggedEventDay documents across all parents.
  */
 export declare function notificationLoggedEventDayCollectionReference(context: FirestoreContext): CollectionGroup<NotificationLoggedEventDay>;
 /**
@@ -888,8 +894,8 @@ export type NotificationLoggedEventDayFirestoreCollectionGroup = FirestoreCollec
 /**
  * Creates a typed {@link NotificationLoggedEventDayFirestoreCollectionGroup} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection group to
- * @returns a typed Firestore collection group for querying NotificationLoggedEventDay documents across all parents
+ * @param firestoreContext - Firestore context to bind the collection group to.
+ * @returns A typed Firestore collection group for querying NotificationLoggedEventDay documents across all parents.
  */
 export declare function notificationLoggedEventDayFirestoreCollectionGroup(firestoreContext: FirestoreContext): NotificationLoggedEventDayFirestoreCollectionGroup;
 /**
@@ -909,8 +915,9 @@ export declare class NotificationLoggedEventDayPageDocument extends AbstractFire
 /**
  * Creates a factory that produces page subcollection references for a given {@link NotificationLoggedEventDayDocument} parent.
  *
- * @param context - Firestore context to create subcollection references from
- * @returns a factory function that creates collection references for a given NotificationLoggedEventDayDocument parent
+ * @param context - Firestore context to create subcollection references from.
+ * @returns A factory function that creates collection references for a given NotificationLoggedEventDayDocument parent.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function notificationLoggedEventDayPagedItemsCollectionReferenceFactory(context: FirestoreContext): (day: NotificationLoggedEventDayDocument) => CollectionReference<NotificationLoggedEventDayPageDocumentData>;
@@ -933,16 +940,17 @@ export type NotificationLoggedEventDayPagedItemsFirestoreCollectionFactory = (pa
  * Uses the framework's default count-based dynamic page distribution; consumers do not need to provide
  * a {@link PagedItemDistributionScheme}. The per-item converter delegates to {@link firestoreNotificationItem}.
  *
- * @param firestoreContext - Firestore context to bind the collection factory to
- * @returns a factory that creates paged Firestore subcollections of NotificationItem for a given day
+ * @param firestoreContext - Firestore context to bind the collection factory to.
+ * @returns A factory that creates paged Firestore subcollections of NotificationItem for a given day.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function notificationLoggedEventDayPagedItemsCollectionFactory(firestoreContext: FirestoreContext): NotificationLoggedEventDayPagedItemsFirestoreCollectionFactory;
 /**
  * Creates a collection group reference for querying all logged-event page documents across every {@link NotificationLoggedEventDay} parent.
  *
- * @param context - Firestore context to create the collection group reference from
- * @returns a typed collection group for querying logged-event page documents
+ * @param context - Firestore context to create the collection group reference from.
+ * @returns A typed collection group for querying logged-event page documents.
  */
 export declare function notificationLoggedEventDayPageCollectionReference(context: FirestoreContext): CollectionGroup<NotificationLoggedEventDayPageDocumentData>;
 /**
@@ -954,7 +962,7 @@ export type NotificationLoggedEventDayPageFirestoreCollectionGroup = FirestoreCo
 /**
  * Creates a typed {@link NotificationLoggedEventDayPageFirestoreCollectionGroup} bound to the given Firestore context.
  *
- * @param firestoreContext - Firestore context to bind the collection group to
- * @returns a typed Firestore collection group for querying logged-event page documents across all parents
+ * @param firestoreContext - Firestore context to bind the collection group to.
+ * @returns A typed Firestore collection group for querying logged-event page documents across all parents.
  */
 export declare function notificationLoggedEventDayPageFirestoreCollectionGroup(firestoreContext: FirestoreContext): NotificationLoggedEventDayPageFirestoreCollectionGroup;

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

@@ -99,8 +99,8 @@ export type NotificationTemplateTypeInfoRecord = Record<NotificationTemplateType
 /**
  * Creates a {@link NotificationTemplateTypeInfoRecord} from an array of template type info entries.
  *
- * @param infoArray - array of template type info entries to index
- * @returns a record keyed by template type
+ * @param infoArray - Array of template type info entries to index.
+ * @returns A record keyed by template type.
  * @throws {Error} When duplicate template types are found in the input array.
  *
  * @example
@@ -187,8 +187,8 @@ export declare abstract class AppNotificationTemplateTypeInfoRecordService {
  * Builds internal indexes for fast lookup by notification model identity and target model identity.
  * Handles alternative model identities defined in {@link NotificationTemplateTypeInfoIdentityInfoAlternativeModelIdentityPair}.
  *
- * @param appNotificationTemplateTypeInfoRecord - the complete template type registry for the application
- * @returns a fully initialized service with indexed lookups for fast template type discovery
+ * @param appNotificationTemplateTypeInfoRecord - The complete template type registry for the application.
+ * @returns A fully initialized service with indexed lookups for fast template type discovery.
  *
  * @example
  * ```ts
@@ -197,6 +197,7 @@ export declare abstract class AppNotificationTemplateTypeInfoRecordService {
  * );
  * const types = service.getTemplateTypesForNotificationModel('project/abc123');
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function appNotificationTemplateTypeInfoRecordService(appNotificationTemplateTypeInfoRecord: NotificationTemplateTypeInfoRecord): AppNotificationTemplateTypeInfoRecordService;