@dereekb/firebase 11.0.21 → 11.1.0

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

@@ -0,0 +1,207 @@
+import { type Maybe, type EmailAddress, type E164PhoneNumber, type BitwiseEncodedSet, type IndexRef, type NeedsSyncBoolean } from '@dereekb/util';
+import { type NotificationBoxId, type NotificationSummaryId, type NotificationTemplateType } from './notification.id';
+import { type FirebaseAuthUserId, type SavedToFirestoreIfTrue } from '../../common';
+/**
+ * Notification configuration state for a template.
+ *
+ * Denotes which modes of message are enabled for the user to recieve.
+ */
+export interface NotificationBoxRecipientTemplateConfig {
+    /**
+     * Send default is enabled/disabled for all types if not defined
+     */
+    sd?: Maybe<boolean>;
+    /**
+     * Email enabled / Send Email
+     */
+    se?: Maybe<boolean>;
+    /**
+     * Phone enabled / Send Text
+     */
+    st?: Maybe<boolean>;
+    /**
+     * Push notification enabled / Send Push Notification
+     */
+    sp?: Maybe<boolean>;
+    /**
+     * Send to notification summary of the associate user, if applicable.
+     */
+    sn?: Maybe<boolean>;
+}
+export declare function mergeNotificationBoxRecipientTemplateConfigs(a?: Maybe<NotificationBoxRecipientTemplateConfig>, b?: Maybe<NotificationBoxRecipientTemplateConfig>): NotificationBoxRecipientTemplateConfig;
+export declare function effectiveNotificationBoxRecipientTemplateConfig(x: NotificationBoxRecipientTemplateConfig): NotificationBoxRecipientTemplateConfig;
+/**
+ * Recipient configuration for a notification
+ */
+export interface NotificationRecipient {
+    /**
+     * User id for this config, if applicable.
+     *
+     * Is used to retrieve the contact's information when sending them information, as well as push notification details.
+     */
+    uid?: Maybe<FirebaseAuthUserId>;
+    /**
+     * User's name. Overrides any info in the user's Profile.
+     */
+    n?: Maybe<string>;
+    /**
+     * User's email address. Overrides any info in the user's Profile.
+     */
+    e?: Maybe<EmailAddress>;
+    /**
+     * User's phone number to send text messages to. Overrides any info in the user's Profile.
+     */
+    t?: Maybe<E164PhoneNumber>;
+    /**
+     * Notification summary id to send notifications to. Ignored and/or set null if uid is defined.
+     */
+    s?: Maybe<NotificationSummaryId>;
+}
+export declare function updateNotificationRecipient(a: NotificationRecipient, b: Partial<NotificationRecipient>): NotificationRecipient;
+export interface NotificationRecipientWithConfig extends NotificationRecipient, NotificationBoxRecipientTemplateConfig {
+}
+export declare const firestoreNotificationRecipientWithConfig: import("../../common").FirestoreSubObjectFieldMapFunctionsConfig<NotificationRecipientWithConfig, Partial<import("@dereekb/util").ReplaceType<NotificationRecipientWithConfig, import("@dereekb/util").MaybeMap<object>, any>>>;
+export declare enum NotificationBoxRecipientFlag {
+    /**
+     * The recipient is enabled.
+     *
+     * This is a transient state that should not be stored.
+     */
+    ENABLED = 0,
+    /**
+     * The recipient is not enabled to recieve notifications currently.
+     */
+    DISABLED = 1,
+    /**
+     * Recipient opted themselves out from recieving notifications.
+     */
+    OPT_OUT = 2
+}
+/**
+ * Settings related to recipients that recieve notifications.
+ *
+ * If uid is set, then most other NotificationRecipient fields are ignored as those are pulled from auth.
+ */
+export interface NotificationBoxRecipient extends NotificationRecipient, IndexRef {
+    /**
+     * Enabled config types
+     */
+    c: NotificationBoxRecipientTemplateConfigRecord;
+    /**
+     * Current opt in flag. Non-zero values are opt-out.
+     *
+     * TODO: Test updating the flag and syncing
+     */
+    f?: Maybe<NotificationBoxRecipientFlag>;
+    /**
+     * Locked state that corresponds to the user's configuration and is sync'd by NotificationUserNotificationBoxRecipientConfig.
+     *
+     * If locked, updating the NotificationBox recipient will throw an error. The user can update their settings without issue.
+     */
+    lk?: Maybe<SavedToFirestoreIfTrue>;
+}
+export declare function newNotificationBoxRecipientForUid(uid: FirebaseAuthUserId, i: number): NotificationBoxRecipient;
+/**
+ * Default NotificationUserNotificationBoxRecipientConfig.
+ */
+export interface NotificationUserDefaultNotificationBoxRecipientConfig extends Omit<NotificationBoxRecipient, 'i' | 'n' | 's' | 'uid'> {
+    /**
+     * Locked state.
+     *
+     * If locked, updating the NotificationBox recipient will throw an error. The user can update their settings without issue.
+     */
+    lk?: Maybe<SavedToFirestoreIfTrue>;
+    /**
+     * Blocked state.
+     *
+     * If blocked, this NotificationBox will not be able to add this user back.
+     */
+    bk?: Maybe<SavedToFirestoreIfTrue>;
+}
+export declare function mergeNotificationUserDefaultNotificationBoxRecipientConfig(a: NotificationUserDefaultNotificationBoxRecipientConfig, b: NotificationUserDefaultNotificationBoxRecipientConfig): NotificationUserDefaultNotificationBoxRecipientConfig;
+/**
+ * Used to reflect the NotificationBoxRecipient config back to a NotificationUser.
+ *
+ * The index reflects the index the user is in the NotificationBox.
+ */
+export interface NotificationUserNotificationBoxRecipientConfig extends Omit<NotificationBoxRecipient, 'uid'> {
+    /**
+     * NotificationBox this configuration reflects.
+     *
+     * The model can be derived from this id.
+     */
+    nb: NotificationBoxId;
+    /**
+     * Removed state.
+     *
+     * If flagged, then this user has flagged themselves to be removed from the NotificationBox or have already been removed.
+     *
+     * Only the NotificationBox can restore a user, so a if a user removes themselves the user cannot restore themselves.
+     * A user will typically prefer to utilize the "f" value (opt-out) flag to not recieve any notifications, rather than remove themselves.
+     *
+     * The config for this NotificationBox is retained on the NotificationUser, unless the user deletes the configuration themselves.
+     */
+    rm?: Maybe<SavedToFirestoreIfTrue>;
+    /**
+     * Needs to be sync'd with the NotificationBox
+     */
+    ns?: Maybe<NeedsSyncBoolean>;
+    /**
+     * Locked state.
+     *
+     * If locked, updating the NotificationBox recipient will throw an error. The user can update their settings without issue.
+     */
+    lk?: Maybe<SavedToFirestoreIfTrue>;
+    /**
+     * Blocked state.
+     *
+     * If blocked, this NotificationBox will not be able to add this user back.
+     */
+    bk?: Maybe<SavedToFirestoreIfTrue>;
+}
+export declare enum NotificationBoxRecipientTemplateConfigBoolean {
+    SEND_ALL_ON = 0,
+    SEND_ALL_OFF = 1,
+    EMAIL = 2,
+    EMAIL_OFF = 3,
+    TEXT = 4,
+    TEXT_OFF = 5,
+    PUSH_NOTIFICATION = 6,
+    PUSH_NOTIFICATION_OFF = 7,
+    NOTIFICATION_SUMMARY = 8,
+    NOTIFICATION_SUMMARY_OFF = 9
+}
+/**
+ * Encoded NotificationBoxRecipientTemplateConfig
+ */
+export type EncodedNotificationBoxRecipientTemplateConfig = BitwiseEncodedSet;
+/**
+ * Map of template types to their configurations.
+ *
+ * Should not be saved with any template type entirely disabled.
+ */
+export type NotificationBoxRecipientTemplateConfigRecord = Record<NotificationTemplateType, NotificationBoxRecipientTemplateConfig>;
+export declare function mergeNotificationBoxRecipientTemplateConfigRecords(a: NotificationBoxRecipientTemplateConfigRecord, b: NotificationBoxRecipientTemplateConfigRecord): NotificationBoxRecipientTemplateConfigRecord;
+/**
+ * Encoded NotificationBoxRecipientTemplateConfigRecord
+ */
+export type EncodedNotificationBoxRecipientTemplateConfigRecord = Record<NotificationTemplateType, EncodedNotificationBoxRecipientTemplateConfig>;
+export declare function firestoreNotificationBoxRecipientTemplateConfigRecord(): import("../../common").FirestoreModelFieldMapFunctionsConfig<import("../../common").FirestoreEncodedObjectMapFieldValueType<NotificationBoxRecipientTemplateConfig, string>, import("../../common").FirestoreMapFieldType<number, string>>;
+export declare const firestoreNotificationBoxRecipient: import("../../common").FirestoreSubObjectFieldMapFunctionsConfig<NotificationBoxRecipient, Partial<import("@dereekb/util").ReplaceType<NotificationBoxRecipient, import("@dereekb/util").MaybeMap<object>, any>>>;
+export declare const firestoreNotificationUserDefaultNotificationBoxRecipientConfig: import("../../common").FirestoreSubObjectFieldMapFunctionsConfig<NotificationUserDefaultNotificationBoxRecipientConfig, Partial<import("@dereekb/util").ReplaceType<NotificationUserDefaultNotificationBoxRecipientConfig, import("@dereekb/util").MaybeMap<object>, any>>>;
+export declare const firestoreNotificationUserNotificationBoxRecipientConfig: import("../../common").FirestoreSubObjectFieldMapFunctionsConfig<NotificationUserNotificationBoxRecipientConfig, Partial<import("@dereekb/util").ReplaceType<NotificationUserNotificationBoxRecipientConfig, import("@dereekb/util").MaybeMap<object>, any>>>;
+export interface NotificationBoxRecipientTemplateConfigArrayEntry extends NotificationBoxRecipientTemplateConfig {
+    /**
+     * Array entry template type
+     */
+    type: NotificationTemplateType;
+}
+export type NotificationBoxRecipientTemplateConfigArray = NotificationBoxRecipientTemplateConfigArrayEntry[];
+export declare function notificationBoxRecipientTemplateConfigRecordToArray(input: NotificationBoxRecipientTemplateConfigRecord): NotificationBoxRecipientTemplateConfigArray;
+export declare function notificationBoxRecipientTemplateConfigArrayToRecord(input: NotificationBoxRecipientTemplateConfigArray): NotificationBoxRecipientTemplateConfigRecord;
+/**
+ * Config object that may contain a boolean called sendNotification.
+ */
+export interface SendNotificationRef {
+    sendNotification?: Maybe<boolean>;
+}

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

@@ -0,0 +1,139 @@
+import { type Maybe, type ModelKey } from '@dereekb/util';
+import { type Notification, type NotificationDocument, type NotificationFirestoreCollections, NotificationSendType } from './notification';
+import { type NotificationRecipientWithConfig } from './notification.config';
+import { type NotificationTemplateType } from './notification.id';
+import { type FirebaseAuthUserId, type FirestoreDocumentAccessor, type ReadFirestoreModelKeyInput, type Transaction } from '../../common';
+import { type NotificationItem } from './notification.item';
+/**
+ * Template item for a new Notification
+ */
+export interface CreateNotificationTemplateItem extends Omit<NotificationItem, 'r' | 'id' | 'cat'> {
+    /**
+     * Custom created at date for the item.
+     */
+    cat?: Maybe<Date>;
+}
+/**
+ * Template use for creating a new Notification
+ */
+export interface CreateNotificationTemplate extends Partial<Omit<Notification, 'n' | 'a' | 'd' | 'tsr' | 'esr'>> {
+    /**
+     * Model key of the NotificationBox's target model (not the NotificationBox's key)
+     */
+    notificationModel: ModelKey;
+    /**
+     * Item template
+     */
+    n: CreateNotificationTemplateItem;
+}
+export interface CreateNotificationTemplateInput extends Partial<Omit<CreateNotificationTemplate, 'notificationModel'>>, Partial<Omit<CreateNotificationTemplateItem, 't'>> {
+    /**
+     * Model key input of the NotificationBox's target model (not the NotificationBox/key)
+     */
+    readonly notificationModel: ReadFirestoreModelKeyInput;
+    /**
+     * Template type
+     */
+    readonly type: NotificationTemplateType;
+    /**
+     * Overrides st
+     */
+    readonly sendType?: NotificationSendType;
+    /**
+     * Overrides r
+     */
+    readonly recipients?: NotificationRecipientWithConfig[];
+    /**
+     * Overrides cb
+     */
+    readonly createdBy?: Maybe<FirebaseAuthUserId>;
+    /**
+     * Overrides m
+     */
+    readonly targetModel?: Maybe<ReadFirestoreModelKeyInput>;
+    /**
+     * Overrides s
+     */
+    readonly subject?: Maybe<string>;
+    /**
+     * Overrides g
+     */
+    readonly message?: Maybe<string>;
+    /**
+     * Overrides d
+     */
+    readonly data?: Maybe<object>;
+}
+export declare function createNotificationTemplate(input: CreateNotificationTemplateInput): CreateNotificationTemplate;
+export interface ShouldSendCreatedNotificationInput {
+    /**
+     * Whether or not to actually create/save the notification. Defaults to true.
+     */
+    readonly sendNotification?: Maybe<boolean>;
+    /**
+     * Date that can be provided to throttle sending notifications. If the throttle time has not elapsed since the last send then the notification will not be sent.
+     */
+    readonly sendNotificationThrottleDate?: Maybe<Date>;
+    /**
+     * Amount of time to throttle notifications. Only used if sendNotificationThrottleDate is provided. Defaults to 1 hour.
+     */
+    readonly sendNotificationThrottleTime?: Maybe<number>;
+}
+/**
+ * Returns true if the notification should be created/sent, given the input.
+ *
+ * @param input
+ * @returns
+ */
+export declare function shouldSendCreatedNotificationInput(input: ShouldSendCreatedNotificationInput): boolean;
+export interface CreateNotificationDocumentPairInput extends ShouldSendCreatedNotificationInput {
+    /**
+     * Additional flag controlling whether or not to create the notification.
+     */
+    readonly shouldCreateNotification?: Maybe<boolean>;
+    /**
+     * Template
+     */
+    readonly template: CreateNotificationTemplate;
+    /**
+     * Transaction, if available.
+     */
+    readonly transaction?: Maybe<Transaction>;
+    /**
+     * Context to create the accessor from.
+     */
+    readonly context?: Pick<NotificationFirestoreCollections, 'notificationCollectionFactory' | 'notificationBoxCollection'>;
+    /**
+     * Accessor to use directly.
+     */
+    readonly accessor?: FirestoreDocumentAccessor<Notification, NotificationDocument>;
+}
+export interface CreateNotificationDocumentPairResult {
+    readonly notificationDocument: NotificationDocument;
+    readonly notification: Notification;
+    /**
+     * Whether or not the notification was created.
+     */
+    readonly notificationCreated: boolean;
+}
+/**
+ * Creates a CreateNotificationDocumentPairResult from the input.
+ *
+ * Only creates a pair. Used createNotificationDocument() to also save the document's data.
+ *
+ * @param template
+ */
+export declare function createNotificationDocumentPair(input: CreateNotificationDocumentPairInput): CreateNotificationDocumentPairResult;
+/**
+ * Creates a new Notification and saves it to Firestore. Returns the pair.
+ *
+ * @param input
+ */
+export declare function createNotificationDocument(input: CreateNotificationDocumentPairInput): Promise<CreateNotificationDocumentPairResult>;
+/**
+ * Creates a new Notification and saves it to Firestore and returns the pair if sendNotification in the input is not false.
+ *
+ * @param input
+ * @returns
+ */
+export declare function createNotificationDocumentIfSending(input: CreateNotificationDocumentPairInput): Promise<Maybe<CreateNotificationDocumentPairResult>>;