@dereekb/firebase-server 11.0.21 → 11.1.1

package/model/src/lib/notification/notification.send.service.notificationsummary.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firestoreNotificationSummarySendService = void 0;
+const firebase_1 = require("@dereekb/firebase");
+const util_1 = require("@dereekb/util");
+const notification_util_1 = require("./notification.util");
+function firestoreNotificationSummarySendService(config) {
+    const { context, allowCreateNotificationSummaries: inputAllowCreateNotificationSummaries } = config;
+    const { firestoreContext, notificationSummaryCollection } = context;
+    const allowCreateNotificationSummaries = inputAllowCreateNotificationSummaries ?? true;
+    const sendService = {
+        async buildSendInstanceForNotificationSummaryMessages(notificationMessages) {
+            const messagesGroupedByNotificationSummaryMapBuilder = (0, util_1.multiValueMapBuilder)();
+            notificationMessages.forEach((x) => {
+                if (x.inputContext.recipient.s != null && x.item != null) {
+                    // only add to map builder if recipient id is defined
+                    messagesGroupedByNotificationSummaryMapBuilder.add(x.inputContext.recipient.s, x);
+                }
+            });
+            const cutSubject = (0, util_1.cutStringFunction)({ maxLength: firebase_1.NOTIFICATION_SUMMARY_EMBEDDED_NOTIFICATION_ITEM_SUBJECT_MAX_LENGTH });
+            const cutMessage = (0, util_1.cutStringFunction)({ maxLength: firebase_1.NOTIFICATION_SUMMARY_EMBEDDED_NOTIFICATION_ITEM_MESSAGE_MAX_LENGTH });
+            const messagesGroups = messagesGroupedByNotificationSummaryMapBuilder.entries();
+            return async () => {
+                const success = [];
+                const failed = [];
+                const ignored = [];
+                await (0, util_1.runAsyncTasksForValues)(messagesGroups, async ([notificationSummaryId, messages]) => {
+                    await firestoreContext
+                        .runTransaction(async (transaction) => {
+                        const notificationSummaryDocument = notificationSummaryCollection.documentAccessorForTransaction(transaction).loadDocumentForId(notificationSummaryId);
+                        const notificationSummary = await notificationSummaryDocument.snapshotData();
+                        let updated = false;
+                        let updateTemplate;
+                        const existingMessages = notificationSummary?.n ?? [];
+                        const existingMessageIds = new Set(existingMessages.map((x) => x.id));
+                        // ignore any repeat messages
+                        const messagesToSend = messages.filter((x) => !existingMessageIds.has(x.item.id));
+                        if (messagesToSend.length > 0) {
+                            // add the new items to existing n, then keep the last 1000
+                            const sortedN = existingMessages
+                                .concat(messagesToSend.map((x) => {
+                                let message = '';
+                                if (x.content.openingMessage) {
+                                    message = x.content.openingMessage;
+                                }
+                                if (x.content.closingMessage) {
+                                    message = (message ? message + '\n\n' : message) + x.content.closingMessage;
+                                }
+                                const item = {
+                                    ...x.item,
+                                    s: cutSubject(x.content.title),
+                                    g: cutMessage(message)
+                                };
+                                return item;
+                            }))
+                                .sort(firebase_1.sortNotificationItemsFunction);
+                            const n = (0, util_1.takeLast)(sortedN, firebase_1.NOTIFICATION_SUMMARY_ITEM_LIMIT);
+                            updateTemplate = {
+                                n,
+                                lat: new Date()
+                            };
+                        }
+                        if (updateTemplate != null) {
+                            if (notificationSummary != null) {
+                                await notificationSummaryDocument.update(updateTemplate);
+                                updated = true;
+                            }
+                            else if (allowCreateNotificationSummaries) {
+                                // if it does not exist, and we are allowed to create new summaries, create it and add the new notifications
+                                const createTemplate = {
+                                    ...(0, notification_util_1.makeNewNotificationSummaryTemplate)((0, firebase_1.inferKeyFromTwoWayFlatFirestoreModelKey)(notificationSummaryId)),
+                                    ...updateTemplate
+                                };
+                                await notificationSummaryDocument.create(createTemplate);
+                                updated = true;
+                            }
+                        }
+                        return updated;
+                    })
+                        .then((updated) => {
+                        if (updated) {
+                            success.push(notificationSummaryId);
+                        }
+                        else {
+                            ignored.push(notificationSummaryId);
+                        }
+                    })
+                        .catch((e) => {
+                        console.error('firestoreNotificationSummarySendService(): failed updating notification summary', e);
+                        failed.push(notificationSummaryId);
+                    });
+                });
+                const sendResult = {
+                    success,
+                    failed,
+                    ignored
+                };
+                return sendResult;
+            };
+        }
+    };
+    return sendService;
+}
+exports.firestoreNotificationSummarySendService = firestoreNotificationSummarySendService;
+//# sourceMappingURL=notification.send.service.notificationsummary.js.map

package/model/src/lib/notification/notification.send.service.notificationsummary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.send.service.notificationsummary.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/model/src/lib/notification/notification.send.service.notificationsummary.ts"],"names":[],"mappings":";;;AAAA,gDAc2B;AAI3B,wCAAsH;AACtH,2DAAyE;AAiBzE,SAAgB,uCAAuC,CAAC,MAAqD;IAC3G,MAAM,EAAE,OAAO,EAAE,gCAAgC,EAAE,qCAAqC,EAAE,GAAG,MAAM,CAAC;IACpG,MAAM,EAAE,gBAAgB,EAAE,6BAA6B,EAAE,GAAG,OAAO,CAAC;IAEpE,MAAM,gCAAgC,GAAG,qCAAqC,IAAI,IAAI,CAAC;IAEvF,MAAM,WAAW,GAA4C;QAC3D,KAAK,CAAC,+CAA+C,CAAC,oBAA2C;YAC/F,MAAM,8CAA8C,GAAG,IAAA,2BAAoB,GAA8C,CAAC;YAE1H,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBACjC,IAAI,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE;oBACxD,qDAAqD;oBACrD,8CAA8C,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;iBACnF;YACH,CAAC,CAAC,CAAC;YAEH,MAAM,UAAU,GAAG,IAAA,wBAAiB,EAAC,EAAE,SAAS,EAAE,6EAAkE,EAAE,CAAC,CAAC;YACxH,MAAM,UAAU,GAAG,IAAA,wBAAiB,EAAC,EAAE,SAAS,EAAE,6EAAkE,EAAE,CAAC,CAAC;YAExH,MAAM,cAAc,GAAG,8CAA8C,CAAC,OAAO,EAA0D,CAAC;YAExI,OAAO,KAAK,IAAI,EAAE;gBAChB,MAAM,OAAO,GAA4B,EAAE,CAAC;gBAC5C,MAAM,MAAM,GAA4B,EAAE,CAAC;gBAC3C,MAAM,OAAO,GAA4B,EAAE,CAAC;gBAE5C,MAAM,IAAA,6BAAsB,EAAC,cAAc,EAAE,KAAK,EAAE,CAAC,qBAAqB,EAAE,QAAQ,CAAC,EAAE,EAAE;oBACvF,MAAM,gBAAgB;yBACnB,cAAc,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;wBACpC,MAAM,2BAA2B,GAAG,6BAA6B,CAAC,8BAA8B,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,qBAA8C,CAAC,CAAC;wBAChL,MAAM,mBAAmB,GAAG,MAAM,2BAA2B,CAAC,YAAY,EAAE,CAAC;wBAE7E,IAAI,OAAO,GAAG,KAAK,CAAC;wBACpB,IAAI,cAA6D,CAAC;wBAElE,MAAM,gBAAgB,GAAG,mBAAmB,EAAE,CAAC,IAAI,EAAE,CAAC;wBACtD,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;wBAEtE,6BAA6B;wBAC7B,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAE,CAAC,CAAC,IAAyB,CAAC,EAAE,CAAC,CAAC,CAAC;wBAExG,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;4BAC7B,2DAA2D;4BAC3D,MAAM,OAAO,GAAG,gBAAgB;iCAC7B,MAAM,CACL,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gCACvB,IAAI,OAAO,GAAW,EAAE,CAAC;gCAEzB,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE;oCAC5B,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;iCACpC;gCAED,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE;oCAC5B,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;iCAC7E;gCAED,MAAM,IAAI,GAAqB;oCAC7B,GAAI,CAAC,CAAC,IAAyB;oCAC/B,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;oCAC9B,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;iCACvB,CAAC;gCAEF,OAAO,IAAI,CAAC;4BACd,CAAC,CAAC,CACH;iCACA,IAAI,CAAC,wCAA6B,CAAC,CAAC;4BAEvC,MAAM,CAAC,GAAG,IAAA,eAAQ,EAAC,OAAO,EAAE,0CAA+B,CAAC,CAAC;4BAE7D,cAAc,GAAG;gCACf,CAAC;gCACD,GAAG,EAAE,IAAI,IAAI,EAAE;6BAChB,CAAC;yBACH;wBAED,IAAI,cAAc,IAAI,IAAI,EAAE;4BAC1B,IAAI,mBAAmB,IAAI,IAAI,EAAE;gCAC/B,MAAM,2BAA2B,CAAC,MAAM,CAAC,cAAe,CAAC,CAAC;gCAC1D,OAAO,GAAG,IAAI,CAAC;6BAChB;iCAAM,IAAI,gCAAgC,EAAE;gCAC3C,4GAA4G;gCAC5G,MAAM,cAAc,GAAwB;oCAC1C,GAAG,IAAA,sDAAkC,EAAC,IAAA,kDAAuC,EAAC,qBAAqB,CAAC,CAAC;oCACrG,GAAG,cAAc;iCAClB,CAAC;gCAEF,MAAM,2BAA2B,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;gCACzD,OAAO,GAAG,IAAI,CAAC;6BAChB;yBACF;wBAED,OAAO,OAAO,CAAC;oBACjB,CAAC,CAAC;yBACD,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;wBAChB,IAAI,OAAO,EAAE;4BACX,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;yBACrC;6BAAM;4BACL,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;yBACrC;oBACH,CAAC,CAAC;yBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;wBACX,OAAO,CAAC,KAAK,CAAC,iFAAiF,EAAE,CAAC,CAAC,CAAC;wBACpG,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;oBACrC,CAAC,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC;gBAEH,MAAM,UAAU,GAAsD;oBACpE,OAAO;oBACP,MAAM;oBACN,OAAO;iBACR,CAAC;gBAEF,OAAO,UAAU,CAAC;YACpB,CAAC,CAAC;QACJ,CAAC;KACF,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC;AAvHD,0FAuHC"}

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

@@ -0,0 +1,9 @@
+import { type NotificationTextSendService } from './notification.send.service';
+/**
+ * NotificationTextSendService that ignores sending all messages.
+ *
+ * This is useful for cases where your app may eventually want to send text notifications and want the rest of your app configured like it currently does.
+ *
+ * @returns
+ */
+export declare function ignoreSendNotificationTextSendService(): NotificationTextSendService;

package/model/src/lib/notification/notification.send.service.text.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ignoreSendNotificationTextSendService = void 0;
+/**
+ * NotificationTextSendService that ignores sending all messages.
+ *
+ * This is useful for cases where your app may eventually want to send text notifications and want the rest of your app configured like it currently does.
+ *
+ * @returns
+ */
+function ignoreSendNotificationTextSendService() {
+    const sendService = {
+        async buildSendInstanceForTextNotificationMessages(notificationMessages) {
+            return async () => {
+                const success = [];
+                const failed = [];
+                const ignored = notificationMessages.map((x) => x.inputContext.recipient.t);
+                const sendResult = {
+                    success,
+                    failed,
+                    ignored
+                };
+                return sendResult;
+            };
+        }
+    };
+    return sendService;
+}
+exports.ignoreSendNotificationTextSendService = ignoreSendNotificationTextSendService;
+//# sourceMappingURL=notification.send.service.text.js.map

package/model/src/lib/notification/notification.send.service.text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.send.service.text.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/model/src/lib/notification/notification.send.service.text.ts"],"names":[],"mappings":";;;AAKA;;;;;;GAMG;AACH,SAAgB,qCAAqC;IACnD,MAAM,WAAW,GAAgC;QAC/C,KAAK,CAAC,4CAA4C,CAAC,oBAA2C;YAC5F,OAAO,KAAK,IAAI,EAAE;gBAChB,MAAM,OAAO,GAAsB,EAAE,CAAC;gBACtC,MAAM,MAAM,GAAsB,EAAE,CAAC;gBACrC,MAAM,OAAO,GAAsB,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAoB,CAAC,CAAC;gBAElH,MAAM,UAAU,GAAuC;oBACrD,OAAO;oBACP,MAAM;oBACN,OAAO;iBACR,CAAC;gBAEF,OAAO,UAAU,CAAC;YACpB,CAAC,CAAC;QACJ,CAAC;KACF,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC;AApBD,sFAoBC"}

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

@@ -0,0 +1,128 @@
+import { type Notification, type NotificationBox, type NotificationBoxRecipient, type NotificationBoxRecipientTemplateConfig, NotificationRecipientSendFlag, type NotificationRecipientWithConfig, type FirebaseAuthDetails, type FirebaseAuthUserId, type NotificationSummaryId, type NotificationBoxId, type NotificationUser, type NotificationUserNotificationBoxRecipientConfig, type NotificationUserId, type FirestoreDocumentAccessor, type NotificationUserDocument, type NotificationUserDefaultNotificationBoxRecipientConfig, type NotificationSummaryIdForUidFunction, type NotificationSummary } from '@dereekb/firebase';
+import { type FirebaseServerAuthService } from '@dereekb/firebase-server';
+import { type E164PhoneNumber, type EmailAddress, type Maybe, type PhoneNumber, type ModelKey } from '@dereekb/util';
+export declare function makeNewNotificationSummaryTemplate(model: ModelKey): NotificationSummary;
+export interface ExpandNotificationRecipientsInput {
+    readonly notification: Notification;
+    readonly notificationBox?: Maybe<NotificationBox>;
+    readonly authService: FirebaseServerAuthService;
+    /**
+     * Used for loading NotificationUsers in the system for accessing default configurations for the "other" recipients not in the NotificationBox.
+     */
+    readonly notificationUserAccessor: FirestoreDocumentAccessor<NotificationUser, NotificationUserDocument>;
+    /**
+     * Factory for creating a NotificationSummaryKey given a uid.
+     *
+     * If not defined, then notification summaries will not be generated for recipients with uids.
+     */
+    readonly notificationSummaryIdForUid?: Maybe<NotificationSummaryIdForUidFunction>;
+    /**
+     * Overrides the recipient flag for the notification.
+     */
+    readonly recipientFlagOverride?: Maybe<NotificationRecipientSendFlag>;
+    /**
+     * Recipients that come from the message, also known as global recipients.
+     */
+    readonly globalRecipients?: Maybe<NotificationRecipientWithConfig[]>;
+    /**
+     * Only text those who have texting/sms notifications explicitly enabled.
+     *
+     * Defaults to true.
+     */
+    readonly onlyTextExplicitlyEnabledRecipients?: Maybe<boolean>;
+}
+export interface ExpandedNotificationRecipientConfig {
+    readonly recipient: Omit<NotificationBoxRecipient, 'i'>;
+    readonly effectiveTemplateConfig?: Maybe<NotificationBoxRecipientTemplateConfig>;
+}
+export interface ExpandedNotificationRecipientBase {
+    readonly name?: Maybe<string>;
+    readonly emailAddress?: Maybe<EmailAddress>;
+    readonly phoneNumber?: Maybe<E164PhoneNumber>;
+    /**
+     * The recipient that is registered with the NotificationBox and their configuration from that box.
+     */
+    readonly boxRecipient?: ExpandedNotificationRecipientConfig;
+    /**
+     * A recipient that is not registered with the NotificationBox but was requested by UID and their configuration from their NotificationUser, if applicable.
+     */
+    readonly otherUserRecipient?: ExpandedNotificationRecipientConfig;
+    /**
+     * The recipient that is not registered with the NotificationBox.
+     */
+    readonly otherRecipient?: NotificationRecipientWithConfig;
+}
+export interface ExpandedNotificationRecipientEmail extends ExpandedNotificationRecipientBase {
+    readonly emailAddress: EmailAddress;
+}
+export interface ExpandedNotificationRecipientPhone extends ExpandedNotificationRecipientBase {
+    readonly phoneNumber: E164PhoneNumber;
+}
+export type ExpandedNotificationRecipientText = ExpandedNotificationRecipientPhone;
+export interface ExpandedNotificationNotificationSummaryRecipient extends Pick<ExpandedNotificationRecipientBase, 'name' | 'boxRecipient' | 'otherRecipient'> {
+    readonly notificationSummaryId: NotificationSummaryId;
+}
+export interface ExpandNotificationRecipientsInternal {
+    readonly userDetailsMap: Map<string, FirebaseAuthDetails | undefined>;
+    readonly explicitRecipients: NotificationRecipientWithConfig[];
+    readonly globalRecipients: NotificationRecipientWithConfig[];
+    readonly allBoxRecipientConfigs: NotificationBoxRecipient[];
+    readonly relevantBoxRecipientConfigs: ExpandedNotificationRecipientConfig[];
+    readonly recipientUids: Set<FirebaseAuthUserId>;
+    readonly otherRecipientConfigs: Map<FirebaseAuthUserId, NotificationRecipientWithConfig>;
+    readonly explicitOtherRecipientEmailAddresses: Map<EmailAddress, NotificationRecipientWithConfig>;
+    readonly explicitOtherRecipientTextNumbers: Map<PhoneNumber, NotificationRecipientWithConfig>;
+    readonly explicitOtherRecipientNotificationSummaryIds: Map<NotificationSummaryId, NotificationRecipientWithConfig>;
+    readonly otherNotificationUserUidOptOuts: Set<NotificationUserId>;
+    readonly nonNotificationBoxUidRecipientConfigs: Map<FirebaseAuthUserId, NotificationRecipientWithConfig>;
+    readonly notificationUserRecipientConfigs: Map<NotificationUserId, NotificationUserDefaultNotificationBoxRecipientConfig>;
+}
+export interface ExpandNotificationRecipientsResult {
+    readonly _internal: ExpandNotificationRecipientsInternal;
+    readonly emails: ExpandedNotificationRecipientEmail[];
+    readonly texts: ExpandedNotificationRecipientText[];
+    readonly notificationSummaries: ExpandedNotificationNotificationSummaryRecipient[];
+}
+/**
+ * "Expands" the input into recipients for emails, texts, etc.
+ *
+ * Recipients may come from the NotificationBox, Notification or from the global recipients.
+ *
+ * Recipients are each configurable and may be defined with as little info as a single contact info, or have multiple contact info pieces associated with them.
+ *
+ * @param input
+ * @returns
+ */
+export declare function expandNotificationRecipients(input: ExpandNotificationRecipientsInput): Promise<ExpandNotificationRecipientsResult>;
+export interface UpdateNotificationUserNotificationBoxRecipientConfigInput {
+    readonly notificationBoxId: NotificationBoxId;
+    readonly notificationBoxAssociatedModelKey: ModelKey;
+    readonly notificationUserId: NotificationUserId;
+    /**
+     * The existing NotificationUser.
+     */
+    readonly notificationUser: Pick<NotificationUser, 'gc' | 'bc'>;
+    /**
+     * If true, flag as if the recipient is being inserted into the NotificationBox since it does not exist there.
+     */
+    readonly insertingRecipientIntoNotificationBox?: Maybe<boolean>;
+    /**
+     * If true, flag as if the recipient is being removed from the NotificationBox.
+     */
+    readonly removeRecipientFromNotificationBox?: Maybe<boolean>;
+    /**
+     * The current NotificationBoxRecipient
+     */
+    readonly notificationBoxRecipient: Maybe<NotificationBoxRecipient>;
+}
+export interface UpdateNotificationUserNotificationBoxRecipientConfigResult {
+    /**
+     * New configs array, if changes occured.
+     */
+    readonly updatedBc?: Maybe<NotificationUserNotificationBoxRecipientConfig[]>;
+    /**
+     * The updated NotificationBox recipient
+     */
+    readonly updatedNotificationBoxRecipient: Maybe<NotificationBoxRecipient>;
+}
+export declare function updateNotificationUserNotificationBoxRecipientConfig(input: UpdateNotificationUserNotificationBoxRecipientConfigInput): UpdateNotificationUserNotificationBoxRecipientConfigResult;