@dereekb/firebase 11.0.21 → 11.1.0

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

@@ -0,0 +1,152 @@
+import { type Maybe, type WebsiteUrl } from '@dereekb/util';
+import { type NotificationRecipient, type NotificationRecipientWithConfig } from './notification.config';
+import { type Notification, type NotificationBox } from './notification';
+import { type NotificationItem, type NotificationItemMetadata } from './notification.item';
+import { type DocumentDataWithIdAndKey } from '../../common';
+/**
+ * Contextual information when
+ */
+export interface NotificationMessageInputContext {
+    /**
+     * Recipient of the notification.
+     */
+    readonly recipient: NotificationRecipient;
+}
+/**
+ * Arbitrary template name/key that is used to configure which template to use by the sending service.
+ */
+export type NotificationSendMessageTemplateName = string;
+/**
+ * Generic notification message content.
+ */
+export interface NotificationMessageContent {
+    /**
+     * Explicit send template name to use, if applicable.
+     *
+     * The sending service determines how this template is used.
+     */
+    readonly sendTemplateName?: Maybe<NotificationSendMessageTemplateName>;
+    /**
+     * The title/subject of the message for the recipient
+     */
+    readonly title: string;
+    /**
+     * The message for the recipient
+     */
+    readonly openingMessage?: Maybe<string>;
+    /**
+     * Bolded/Highlighted information
+     */
+    readonly boldHighlight?: Maybe<string>;
+    /**
+     * Second paragraph. Comes after the main message and bold content.
+     */
+    readonly closingMessage?: Maybe<string>;
+    /**
+     * The associated action.
+     */
+    readonly action?: Maybe<string>;
+    /**
+     * Url the action goes to.
+     */
+    readonly actionUrl?: Maybe<WebsiteUrl>;
+}
+export interface NotificationMessageEmailContent extends NotificationMessageContent {
+    /**
+     * Email subject. If not defined, defaults to the title.
+     */
+    readonly subject?: string;
+    /**
+     * Email action prompt. If not defined, defaults to the title.
+     */
+    readonly prompt?: string;
+}
+export interface NotificationMessageNotificationSummaryContent {
+}
+export declare enum NotificationMessageFlag {
+    /**
+     * No flag
+     */
+    NONE = 0,
+    /**
+     * Special flag to indicate there is no content. Should not be sent.
+     */
+    NO_CONTENT = 1,
+    /**
+     * Special flag to not send the notification.
+     */
+    DO_NOT_SEND = 2
+}
+/**
+ * A NotificationMessage is the final result of the expanded notification.
+ */
+export interface NotificationMessage<D extends NotificationItemMetadata = {}> {
+    /**
+     * Optional flag
+     */
+    readonly flag?: NotificationMessageFlag;
+    /**
+     * Associated item used to generate the content.
+     *
+     * Is required for sending NotificationSummary messages.
+     */
+    readonly item?: NotificationItem<D>;
+    /**
+     * The input context used to generate the message.
+     */
+    readonly inputContext: NotificationMessageInputContext;
+    /**
+     * The output content.
+     */
+    readonly content: NotificationMessageContent;
+    /**
+     * Content specific for an email.
+     */
+    readonly emailContent?: NotificationMessageEmailContent;
+    /**
+     * Content specific for a text.
+     */
+    readonly textContent?: NotificationMessageContent;
+    /**
+     * Content specific for notification summaries.
+     */
+    readonly notificationSummaryContent?: NotificationMessageNotificationSummaryContent;
+}
+export interface NotificationMessageFunctionFactoryConfig<D extends NotificationItemMetadata = {}> {
+    /**
+     * Notification item.
+     */
+    readonly item: NotificationItem<D>;
+    /**
+     * NotificationBox details for this message.
+     */
+    readonly notificationBox: Pick<NotificationBox, 'm'>;
+    /**
+     * Full Notification for this message.
+     */
+    readonly notification: DocumentDataWithIdAndKey<Notification>;
+}
+/**
+ * Creates a NotificationMessageFunction from the input config.
+ */
+export type NotificationMessageFunctionFactory<D extends NotificationItemMetadata = {}> = (config: NotificationMessageFunctionFactoryConfig<D>) => Promise<NotificationMessageFunction>;
+export interface NotificationMessageFunctionExtras {
+    /**
+     * Any global/additional recipient(s) that should be added to all Notifications associated with this NotificationMessageFunctionExtras.
+     */
+    readonly globalRecipients?: Maybe<NotificationRecipientWithConfig[]>;
+}
+export type NotificationMessageFunctionWithoutExtras = (inputContext: NotificationMessageInputContext) => Promise<NotificationMessage>;
+/**
+ * Converts a NotificationMessageContext to a NotificationMessage.
+ */
+export type NotificationMessageFunction = NotificationMessageFunctionWithoutExtras & NotificationMessageFunctionExtras;
+/**
+ * Creates a NotificationMessageFunction from the input.
+ *
+ * @param fn
+ * @param extras
+ * @returns
+ */
+export declare function notificationMessageFunction(fn: NotificationMessageFunctionWithoutExtras, extras?: NotificationMessageFunctionExtras): NotificationMessageFunction;
+export declare function noContentNotificationMessageFunctionFactory<D extends NotificationItemMetadata = any>(): NotificationMessageFunctionFactory<D>;

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

@@ -0,0 +1,43 @@
+import { type FirestoreQueryConstraint } from '../../common/firestore';
+/**
+ * Query for notificationUsers that are flagged for initialization.
+ *
+ * @param now
+ * @returns
+ */
+export declare function notificationUsersFlaggedForNeedsSyncQuery(): FirestoreQueryConstraint[];
+/**
+ * Query for notificationSummaries that are flagged for initialization.
+ *
+ * @param now
+ * @returns
+ */
+export declare function notificationSummariesFlaggedForNeedsInitializationQuery(): FirestoreQueryConstraint[];
+/**
+ * Query for notificationBoxes that are flagged for initialization.
+ *
+ * @param now
+ * @returns
+ */
+export declare function notificationBoxesFlaggedForNeedsInitializationQuery(): FirestoreQueryConstraint[];
+/**
+ * Query for notificationBoxes that are flagged as invalid.
+ *
+ * @param now
+ * @returns
+ */
+export declare function notificationBoxesFlaggedInvalidQuery(): FirestoreQueryConstraint[];
+/**
+ * Query for notifications that are not done and the send at time is in the past.
+ *
+ * @param now
+ * @returns
+ */
+export declare function notificationsPastSendAtTimeQuery(now?: Date): FirestoreQueryConstraint[];
+/**
+ * Query for notifications that are marked ready for cleanup/deletion.
+ *
+ * @param now
+ * @returns
+ */
+export declare function notificationsReadyForCleanupQuery(): FirestoreQueryConstraint[];

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

@@ -0,0 +1,22 @@
+import { type Maybe, type EmailAddress, type E164PhoneNumber } from '@dereekb/util';
+import { type NotificationSummaryId } from './notification.id';
+export interface NotificationSendMessagesResult<K> {
+    /**
+     * Set of all successful recipients.
+     */
+    readonly success: K[];
+    /**
+     * Set of all failed recipients.
+     *
+     * A failed recipient is a valid recipient that failed due to a temporary error and should be retried again it the future.
+     */
+    readonly failed: K[];
+    /**
+     * Set of all ignored recipients, if applicable..
+     */
+    readonly ignored: K[];
+}
+export declare function mergeNotificationSendMessagesResult<K>(a: Maybe<NotificationSendMessagesResult<K>>, b: Maybe<NotificationSendMessagesResult<K>>): NotificationSendMessagesResult<K>;
+export type NotificationSendEmailMessagesResult = NotificationSendMessagesResult<EmailAddress>;
+export type NotificationSendTextMessagesResult = NotificationSendMessagesResult<E164PhoneNumber>;
+export type NotificationSendNotificationSummaryMessagesResult = NotificationSendMessagesResult<NotificationSummaryId>;

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

@@ -0,0 +1,51 @@
+import { type Maybe } from '@dereekb/util';
+import { type Notification, NotificationRecipientSendFlag, type NotificationSendFlags, NotificationSendState } from './notification';
+import { type NotificationUserNotificationBoxRecipientConfig, type NotificationBoxRecipient, type NotificationUserDefaultNotificationBoxRecipientConfig } from './notification.config';
+import { type AppNotificationTemplateTypeInfoRecordService } from './notification.details';
+import { type FirebaseAuthUserId, type FirestoreModelKey } from '../../common';
+export interface EffectiveNotificationBoxRecipientConfigInput {
+    readonly uid: FirebaseAuthUserId;
+    readonly m?: FirestoreModelKey;
+    readonly appNotificationTemplateTypeInfoRecordService: AppNotificationTemplateTypeInfoRecordService;
+    readonly gc: NotificationUserDefaultNotificationBoxRecipientConfig;
+    readonly boxConfig: NotificationUserNotificationBoxRecipientConfig;
+    readonly recipient?: Maybe<NotificationBoxRecipient>;
+}
+export declare function effectiveNotificationBoxRecipientConfig(input: EffectiveNotificationBoxRecipientConfigInput): NotificationBoxRecipient;
+/**
+ * Returns true if the notification's send types are all marked as sent.
+ *
+ * @param input
+ * @returns
+ */
+export declare function notificationSendFlagsImplyIsComplete(input: NotificationSendFlags): boolean;
+/**
+ * Returns true if the state implies completion of sending (not necessarily success, but that attempts to send are done)
+ *
+ * @param input
+ * @returns
+ */
+export declare function isCompleteNotificationSendState(input: NotificationSendState): boolean;
+export interface AllowedNotificationRecipients {
+    readonly canSendToGlobalRecipients: boolean;
+    readonly canSendToBoxRecipients: boolean;
+    readonly canSendToExplicitRecipients: boolean;
+}
+/**
+ * Returns a AllowedNotificationRecipients from the input NotificationRecipientSendFlag.
+ *
+ * @param flag
+ * @returns
+ */
+export declare function allowedNotificationRecipients(flag?: Maybe<NotificationRecipientSendFlag>): AllowedNotificationRecipients;
+/**
+ * Whether or not the Notification should be saved to the NotificationWeek.
+ *
+ * A Notification should only be saved when the notification can be sent to box recipients.
+ *
+ * @param notification
+ * @returns
+ */
+export declare function shouldSaveNotificationToNotificationWeek(notification: Notification): boolean;
+export declare function mergeNotificationUserNotificationBoxRecipientConfigs(a: NotificationUserNotificationBoxRecipientConfig, b: Partial<NotificationUserNotificationBoxRecipientConfig>): NotificationUserNotificationBoxRecipientConfig;
+export declare function mergeNotificationBoxRecipients<T extends NotificationBoxRecipient>(a: T, b: Partial<T>): T;

package/test/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [11.1.0](https://github.com/dereekb/dbx-components/compare/v11.0.21-dev...v11.1.0) (2025-02-28)
+
+
+
 ## [11.0.21](https://github.com/dereekb/dbx-components/compare/v11.0.20-dev...v11.0.21) (2025-01-28)
 
 

package/test/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "11.0.21",
+  "version": "11.1.0",
   "type": "commonjs",
   "peerDependencies": {
     "@dereekb/util": "*",