@dereekb/firebase 13.0.6 → 13.1.0

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

@@ -1,11 +1,12 @@
-import { TargetModelParams, type FirestoreModelKey, type FirebaseAuthUserId } from '../../common';
+import { type Type } from 'arktype';
+import { type TargetModelParams, type FirestoreModelKey, type FirebaseAuthUserId } from '../../common';
 import { type ModelFirebaseCrudFunction, type FirebaseFunctionTypeConfigMap, type ModelFirebaseCrudFunctionConfigMap, type ModelFirebaseFunctionMap } from '../../client';
 import { type E164PhoneNumber, type EmailAddress, type IndexNumber, type Maybe } from '@dereekb/util';
 import { type NotificationTypes } from './notification';
 import { type NotificationUserDefaultNotificationBoxRecipientConfig, type NotificationBoxRecipientTemplateConfigArrayEntry, NotificationBoxRecipientFlag } from './notification.config';
 import { type NotificationBoxId, type NotificationSummaryId, type NotificationTemplateType } from './notification.id';
 import { type NotificationSendEmailMessagesResult, type NotificationSendTextMessagesResult, type NotificationSendNotificationSummaryMessagesResult } from './notification.send';
-import { NotificationTaskServiceTaskHandlerCompletionType } from './notification.task';
+import { type NotificationTaskServiceTaskHandlerCompletionType } from './notification.task';
 export declare const NOTIFICATION_RECIPIENT_NAME_MIN_LENGTH = 0;
 export declare const NOTIFICATION_RECIPIENT_NAME_MAX_LENGTH = 42;
 export declare const NOTIFICATION_SUBJECT_MIN_LENGTH = 2;
@@ -15,134 +16,98 @@ export declare const NOTIFICATION_MESSAGE_MAX_LENGTH = 1000;
 /**
  * Config entries are inserted, unless marked as remove.
  */
-export declare class NotificationBoxRecipientTemplateConfigArrayEntryParam implements NotificationBoxRecipientTemplateConfigArrayEntry {
-    type: string;
-    sd?: Maybe<boolean>;
-    se?: Maybe<boolean>;
-    st?: Maybe<boolean>;
-    sp?: Maybe<boolean>;
-    sn?: Maybe<boolean>;
-    /**
-     * If true, removes this configuration
-     */
-    remove?: Maybe<boolean>;
+export interface NotificationBoxRecipientTemplateConfigArrayEntryParam extends NotificationBoxRecipientTemplateConfigArrayEntry {
+    readonly type: string;
+    readonly sd?: Maybe<boolean>;
+    readonly se?: Maybe<boolean>;
+    readonly st?: Maybe<boolean>;
+    readonly sp?: Maybe<boolean>;
+    readonly sn?: Maybe<boolean>;
+    readonly remove?: Maybe<boolean>;
 }
+export declare const notificationBoxRecipientTemplateConfigArrayEntryParamType: import("arktype/internal/variants/object.ts").ObjectType<{
+    type: string;
+    sd?: boolean | null | undefined;
+    se?: boolean | null | undefined;
+    st?: boolean | null | undefined;
+    sp?: boolean | null | undefined;
+    sn?: boolean | null | undefined;
+    remove?: boolean | null | undefined;
+}, {}>;
 /**
  * Used for creating a new NotificationUser for a user.
  */
-export declare class CreateNotificationUserParams {
-    /**
-     * UID of the user to create the NotificationUser for.
-     */
-    uid: FirebaseAuthUserId;
+export interface CreateNotificationUserParams {
+    readonly uid: FirebaseAuthUserId;
 }
+export declare const createNotificationUserParamsType: Type<CreateNotificationUserParams>;
 /**
  * Used for updating the global or default config on a NotificationUser.
  */
-export declare class UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams implements Omit<NotificationUserDefaultNotificationBoxRecipientConfig, 'c'> {
-    /**
-     * NotificationBox recipient to update. Is ignored if UID is provided and matches a user. Used for external recipients/users.
-     */
-    i?: Maybe<IndexNumber>;
-    /**
-     * Override email address
-     */
-    e?: Maybe<EmailAddress>;
-    /**
-     * Override phone number
-     */
-    t?: Maybe<E164PhoneNumber>;
-    /**
-     * Array of configs that correspond with "c"
-     */
-    configs?: Maybe<NotificationBoxRecipientTemplateConfigArrayEntryParam[]>;
-    lk?: Maybe<boolean>;
-    bk?: Maybe<boolean>;
-    f?: Maybe<NotificationBoxRecipientFlag>;
+export interface UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams extends Omit<NotificationUserDefaultNotificationBoxRecipientConfig, 'c'> {
+    readonly i?: Maybe<IndexNumber>;
+    readonly e?: Maybe<EmailAddress>;
+    readonly t?: Maybe<E164PhoneNumber>;
+    readonly configs?: Maybe<NotificationBoxRecipientTemplateConfigArrayEntryParam[]>;
+    readonly lk?: Maybe<boolean>;
+    readonly bk?: Maybe<boolean>;
+    readonly f?: Maybe<NotificationBoxRecipientFlag>;
 }
-export declare class UpdateNotificationBoxRecipientLikeParams {
-    /**
-     * Override email address
-     */
-    e?: Maybe<EmailAddress>;
-    /**
-     * Override phone number
-     */
-    t?: Maybe<E164PhoneNumber>;
-    /**
-     * Notification summary id
-     */
-    s?: Maybe<NotificationSummaryId>;
-    /**
-     * Array of configs
-     */
-    configs?: Maybe<NotificationBoxRecipientTemplateConfigArrayEntryParam[]>;
+export declare const updateNotificationUserDefaultNotificationBoxRecipientConfigParamsType: Type<UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams>;
+export interface UpdateNotificationBoxRecipientLikeParams {
+    readonly e?: Maybe<EmailAddress>;
+    readonly t?: Maybe<E164PhoneNumber>;
+    readonly s?: Maybe<NotificationSummaryId>;
+    readonly configs?: Maybe<NotificationBoxRecipientTemplateConfigArrayEntryParam[]>;
 }
+export declare const updateNotificationBoxRecipientLikeParamsType: Type<UpdateNotificationBoxRecipientLikeParams>;
 /**
  * Used for updating the target NotificationUserNotificationBoxRecipientConfig.
  */
-export declare class UpdateNotificationUserNotificationBoxRecipientParams extends UpdateNotificationBoxRecipientLikeParams {
-    /**
-     * NotificationBox config to update
-     */
-    nb: NotificationBoxId;
-    rm?: Maybe<boolean>;
-    lk?: Maybe<boolean>;
-    bk?: Maybe<boolean>;
-    f?: Maybe<NotificationBoxRecipientFlag>;
-    /**
-     * Whether or not to delete this configuration entirely.
-     *
-     * Will only delete if rm is true and ns is false. Is ignored otherwise.
-     */
-    deleteRemovedConfig?: Maybe<boolean>;
+export interface UpdateNotificationUserNotificationBoxRecipientParams extends UpdateNotificationBoxRecipientLikeParams {
+    readonly nb: NotificationBoxId;
+    readonly rm?: Maybe<boolean>;
+    readonly lk?: Maybe<boolean>;
+    readonly bk?: Maybe<boolean>;
+    readonly f?: Maybe<NotificationBoxRecipientFlag>;
+    readonly deleteRemovedConfig?: Maybe<boolean>;
 }
+export declare const updateNotificationUserNotificationBoxRecipientParamsType: Type<UpdateNotificationUserNotificationBoxRecipientParams>;
 /**
  * Used for updating the NotificationUser.
  */
-export declare class UpdateNotificationUserParams extends TargetModelParams {
-    gc?: Maybe<UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams>;
-    dc?: Maybe<UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams>;
-    bc?: Maybe<UpdateNotificationUserNotificationBoxRecipientParams[]>;
-}
-export declare class ResyncNotificationUserParams extends TargetModelParams {
+export interface UpdateNotificationUserParams extends TargetModelParams {
+    readonly gc?: Maybe<UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams>;
+    readonly dc?: Maybe<UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams>;
+    readonly bc?: Maybe<UpdateNotificationUserNotificationBoxRecipientParams[]>;
 }
+export declare const updateNotificationUserParamsType: Type<UpdateNotificationUserParams>;
+export type ResyncNotificationUserParams = TargetModelParams;
+export declare const resyncNotificationUserParamsType: Type<ResyncNotificationUserParams>;
 export interface ResyncNotificationUserResult {
-    /**
-     * Total number of notification boxes updated.
-     */
     readonly notificationBoxesUpdated: number;
 }
-export declare class ResyncAllNotificationUserParams {
+export interface ResyncAllNotificationUserParams {
 }
+export declare const resyncAllNotificationUserParamsType: Type<ResyncAllNotificationUserParams>;
 export interface ResyncAllNotificationUsersResult extends ResyncNotificationUserResult {
-    /**
-     * Total number of users updated.
-     */
     readonly notificationUsersResynced: number;
 }
 /**
  * Used for creating a new NotificationSummary for a model.
  */
-export declare class CreateNotificationSummaryParams {
-    /**
-     * Model to create the NotificationSummary for.
-     */
-    model: FirestoreModelKey;
+export interface CreateNotificationSummaryParams {
+    readonly model: FirestoreModelKey;
 }
+export declare const createNotificationSummaryParamsType: Type<CreateNotificationSummaryParams>;
 /**
  * Used for updating the NotificationSummary.
  */
-export declare class UpdateNotificationSummaryParams extends TargetModelParams {
-    /**
-     * Updates the "rat" time to now.
-     */
+export interface UpdateNotificationSummaryParams extends TargetModelParams {
     readonly flagAllRead?: Maybe<boolean>;
-    /**
-     * Sets the "rat" time to the given date, or clears it.
-     */
     readonly setReadAtTime?: Maybe<Date>;
 }
+export declare const updateNotificationSummaryParamsType: Type<UpdateNotificationSummaryParams>;
 /**
  * Used for creating or initializing a new NotificationBox for a model.
  *
@@ -150,28 +115,29 @@ export declare class UpdateNotificationSummaryParams extends TargetModelParams {
  *
  * The preferred way is to create a NotificationBox through a Notification.
  */
-export declare class CreateNotificationBoxParams {
-    model: FirestoreModelKey;
+export interface CreateNotificationBoxParams {
+    readonly model: FirestoreModelKey;
 }
+export declare const createNotificationBoxParamsType: Type<CreateNotificationBoxParams>;
 /**
  * Used for initializing an uninitialized model like NotificationBox or NotificationSummary.
  */
-export declare class InitializeNotificationModelParams extends TargetModelParams {
-    /**
-     * Whether or not to throw an error if the notification has already been sent or is being sent.
-     */
-    throwErrorIfAlreadyInitialized?: boolean;
+export interface InitializeNotificationModelParams extends TargetModelParams {
+    readonly throwErrorIfAlreadyInitialized?: boolean;
 }
-export declare class InitializeAllApplicableNotificationBoxesParams {
+export declare const initializeNotificationModelParamsType: Type<InitializeNotificationModelParams>;
+export interface InitializeAllApplicableNotificationBoxesParams {
 }
+export declare const initializeAllApplicableNotificationBoxesParamsType: Type<InitializeAllApplicableNotificationBoxesParams>;
 export interface InitializeAllApplicableNotificationBoxesResult {
     readonly notificationBoxesVisited: number;
     readonly notificationBoxesSucceeded: number;
     readonly notificationBoxesFailed: number;
     readonly notificationBoxesAlreadyInitialized: number;
 }
-export declare class InitializeAllApplicableNotificationSummariesParams {
+export interface InitializeAllApplicableNotificationSummariesParams {
 }
+export declare const initializeAllApplicableNotificationSummariesParamsType: Type<InitializeAllApplicableNotificationSummariesParams>;
 export interface InitializeAllApplicableNotificationSummariesResult {
     readonly notificationSummariesVisited: number;
     readonly notificationSummariesSucceeded: number;
@@ -181,244 +147,87 @@ export interface InitializeAllApplicableNotificationSummariesResult {
 /**
  * Used for updating the NotificationBox.
  */
-export declare class UpdateNotificationBoxParams extends TargetModelParams {
-}
+export type UpdateNotificationBoxParams = TargetModelParams;
+export declare const updateNotificationBoxParamsType: Type<UpdateNotificationBoxParams>;
 /**
  * Used to create/update a notification box recipient.
  */
-export declare class UpdateNotificationBoxRecipientParams extends UpdateNotificationBoxRecipientLikeParams implements TargetModelParams {
-    /**
-     * NotificationBox key to update.
-     */
-    key: FirestoreModelKey;
-    /**
-     * NotificationBox recipient to update. Is ignored if UID is provided and matches a user. Used for external recipients/users.
-     */
-    i?: Maybe<IndexNumber>;
-    /**
-     * Notification recipient to update by UID, if applicable.
-     */
-    uid?: Maybe<FirebaseAuthUserId>;
-    /**
-     * Whether or not to create the user if they currently do not exist. Defaults to false.
-     */
-    insert?: Maybe<boolean>;
-    /**
-     * Whether or not to enable/disable the recipient from recieving items from this box.
-     */
-    enabled?: Maybe<boolean>;
-    /**
-     * Whether or not to remove the user if they exist. Defaults to false.
-     */
-    remove?: Maybe<boolean>;
-    /**
-     * If true, the target recipient will have this NotificationBox added to their exclusion list.
-     * If false, the target recipient will have this NotificationBox removed from their exclusion list.
-     *
-     * If set, the other functions are ignored.
-     *
-     * If targeting the user by the index, the NotificationBox must exist, and the user must have a uid, otherwise an error will be thrown.
-     */
-    setExclusion?: Maybe<boolean>;
+export interface UpdateNotificationBoxRecipientParams extends UpdateNotificationBoxRecipientLikeParams, TargetModelParams {
+    readonly key: FirestoreModelKey;
+    readonly i?: Maybe<IndexNumber>;
+    readonly uid?: Maybe<FirebaseAuthUserId>;
+    readonly insert?: Maybe<boolean>;
+    readonly enabled?: Maybe<boolean>;
+    readonly remove?: Maybe<boolean>;
+    readonly setExclusion?: Maybe<boolean>;
 }
-export declare class NotificationRecipientParams {
-    /**
-     * User to send the notification to.
-     */
-    uid?: Maybe<FirebaseAuthUserId>;
-    /**
-     * Recipient Name
-     */
-    un?: Maybe<string>;
-    /**
-     * Email address
-     */
-    e?: Maybe<EmailAddress>;
-    /**
-     * Phone number
-     */
-    p?: Maybe<E164PhoneNumber>;
+export declare const updateNotificationBoxRecipientParamsType: Type<UpdateNotificationBoxRecipientParams>;
+export interface NotificationRecipientParams {
+    readonly uid?: Maybe<FirebaseAuthUserId>;
+    readonly un?: Maybe<string>;
+    readonly e?: Maybe<EmailAddress>;
+    readonly p?: Maybe<E164PhoneNumber>;
 }
+export declare const notificationRecipientParamsType: Type<NotificationRecipientParams>;
 /**
  * Used for sending the notification immediately, if it has not already been sent.
  */
-export declare class SendNotificationParams extends TargetModelParams {
-    /**
-     * Whether or not to ignore the send at time. Defaults to false.
-     *
-     * If true, the send at time will be ignored and the notification will be sent immediately.
-     */
-    ignoreSendAtThrottle?: Maybe<boolean>;
-    /**
-     * Whether or not to throw an error if the notification has already been sent or is being sent.
-     *
-     * Defaults to false.
-     */
-    throwErrorIfSent?: Maybe<boolean>;
+export interface SendNotificationParams extends TargetModelParams {
+    readonly ignoreSendAtThrottle?: Maybe<boolean>;
+    readonly throwErrorIfSent?: Maybe<boolean>;
 }
+export declare const sendNotificationParamsType: Type<SendNotificationParams>;
 /**
  * Params class used for subscribing a system user to a NotificationBox for a model.
  */
-export declare abstract class AbstractSubscribeToNotificationBoxParams extends TargetModelParams {
-    /**
-     * Notification recipient to subscribe to notifications
-     */
-    uid: FirebaseAuthUserId;
+export interface AbstractSubscribeToNotificationBoxParams extends TargetModelParams {
+    readonly uid: FirebaseAuthUserId;
 }
-export declare abstract class AbstractSubscribeOrUnsubscribeToNotificationBoxParams extends AbstractSubscribeToNotificationBoxParams {
-    /**
-     * If true, unsubscribes from the notification box instead.
-     */
-    unsubscribe?: Maybe<boolean>;
+export declare const abstractSubscribeToNotificationBoxParamsType: Type<AbstractSubscribeToNotificationBoxParams>;
+export interface AbstractSubscribeOrUnsubscribeToNotificationBoxParams extends AbstractSubscribeToNotificationBoxParams {
+    readonly unsubscribe?: Maybe<boolean>;
 }
+export declare const abstractSubscribeOrUnsubscribeToNotificationBoxParamsType: Type<AbstractSubscribeOrUnsubscribeToNotificationBoxParams>;
 export interface SendNotificationResultOnSendCompleteResult<T = unknown> {
-    /**
-     * Value, if returned by the onSendSuccess callback.
-     */
     readonly value?: T;
-    /**
-     * Error value if the onSendSuccess callback throws an error.
-     */
     readonly error?: Maybe<unknown>;
 }
 export interface SendNotificationResult {
-    /**
-     * Attempted notification type
-     */
     readonly notificationTemplateType: Maybe<NotificationTemplateType>;
-    /**
-     * Whether or not the notification was of a known type.
-     */
     readonly isKnownTemplateType: Maybe<boolean>;
-    /**
-     * Whether or not the notification was of a task type.
-     */
     readonly isNotificationTask: boolean;
-    /**
-     * True if the notification task is flagged as unique.
-     */
     readonly isUniqueNotificationTask: boolean;
-    /**
-     * True if the notification task is flagged as unique and there was a conflict where a new notification task was created while the old one was mid-task.
-     */
     readonly uniqueNotificationTaskConflict: boolean;
-    /**
-     * Whether or not the notification was of a configured type.
-     */
     readonly isConfiguredTemplateType: Maybe<boolean>;
-    /**
-     * Whether or not the try was aborted due to being throttled.
-     */
     readonly throttled: boolean;
-    /**
-     * Whether or not the run was successful.
-     *
-     * In cases where the Notification is set to SEND_IF_BOX_EXISTS and the box does not exist, this will return true.
-     */
     readonly success: boolean;
-    /**
-     * Completion type for the notification task, if applicable.
-     */
     readonly notificationTaskCompletionType?: Maybe<NotificationTaskServiceTaskHandlerCompletionType>;
-    /**
-     * Number of parts of the notification task that were run.
-     *
-     * Set only if the notification was a task.
-     */
     readonly notificationTaskPartsRunCount?: Maybe<number>;
-    /**
-     * Whether or not the notification task was triggered by the looping protection.
-     */
     readonly notificationTaskLoopingProtectionTriggered?: Maybe<boolean>;
-    /**
-     * Whether or not the notification was marked as done.
-     *
-     * May occur in cases where success is false, but the notification reached the max number of send attempts.
-     */
     readonly notificationMarkedDone: boolean;
-    /**
-     * Whether or not the NotificationBox was created.
-     */
     readonly createdBox: boolean;
-    /**
-     * Whether or not the NotificationBox exists but still needs initialization.
-     */
     readonly notificationBoxNeedsInitialization: boolean;
-    /**
-     * Whether or not the notification was deleted.
-     *
-     * This typically only occurs when SEND_IF_BOX_EXISTS is set and the box does not exist, or the notification has reached the maximum number of send attempts.
-     */
     readonly deletedNotification: boolean;
-    /**
-     * Whether or not the notification exists.
-     */
     readonly exists: boolean;
-    /**
-     * Whether or not the NotificationBox exists.
-     */
     readonly boxExists: boolean;
-    /**
-     * Whether or not the run was tried.
-     */
     readonly tryRun: boolean;
-    /**
-     * Send emails result.
-     *
-     * Undefined if not attempted or a task notification.
-     */
     readonly sendEmailsResult: Maybe<NotificationSendEmailMessagesResult>;
-    /**
-     *
-     * Send texts result.
-     *
-     * Undefined if not attempted or a task notification.
-     */
     readonly sendTextsResult: Maybe<NotificationSendTextMessagesResult>;
-    /**
-     * Send notification summaries result.
-     *
-     * Undefined if not attempted or a task notification.
-     */
     readonly sendNotificationSummaryResult: Maybe<NotificationSendNotificationSummaryMessagesResult>;
-    /**
-     * Failed while attempting to loada the proper message function
-     */
     readonly loadMessageFunctionFailure: boolean;
-    /**
-     * Failed while attempting to build a message
-     */
     readonly buildMessageFailure: boolean;
-    /**
-     * Result of the onSendAttempted callback, if called.
-     */
     readonly onSendAttemptedResult?: Maybe<SendNotificationResultOnSendCompleteResult>;
-    /**
-     * Result of the onSendSuccess callback, if called.
-     */
     readonly onSendSuccessResult?: Maybe<SendNotificationResultOnSendCompleteResult>;
 }
 /**
  * Used for sending queued notifications in the system.
  */
-export declare class SendQueuedNotificationsParams {
-    /**
-     * The max number of send loops to run.
-     *
-     * No limit by default.
-     */
+export interface SendQueuedNotificationsParams {
     readonly maxSendNotificationLoops?: Maybe<number>;
-    /**
-     * The max number of parallel send tasks to run.
-     *
-     * Defaults to 5.
-     */
     readonly maxParellelSendTasks?: Maybe<number>;
-    /**
-     * The threshold to use when to log a warning for an excessive of notification loops.
-     */
     readonly sendNotificationLoopsTaskExcessThreshold?: Maybe<number>;
 }
+export declare const sendQueuedNotificationsParamsType: Type<SendQueuedNotificationsParams>;
 export interface SendQueuedNotificationsResult extends Omit<SendNotificationResult, 'throttled' | 'isNotificationTask' | 'isUniqueNotificationTask' | 'notificationTaskCompletionType' | 'uniqueNotificationTaskConflict' | 'isConfiguredTemplateType' | 'isKnownTemplateType' | 'notificationTemplateType' | 'notificationMarkedDone' | 'deletedNotification' | 'createdBox' | 'success' | 'exists' | 'boxExists' | 'notificationBoxNeedsInitialization' | 'tryRun' | 'loadMessageFunctionFailure' | 'buildMessageFailure'> {
     readonly excessLoopsDetected: boolean;
     readonly notificationLoopCount: number;
@@ -433,12 +242,10 @@ export interface SendQueuedNotificationsResult extends Omit<SendNotificationResu
 /**
  * Used for sending queued notifications in the system.
  */
-export declare class CleanupSentNotificationsParams {
+export interface CleanupSentNotificationsParams {
 }
+export declare const cleanupSentNotificationsParamsType: Type<CleanupSentNotificationsParams>;
 export interface CleanupSentNotificationsResult {
-    /**
-     * Number of total updates. May include the same notification box more than once.
-     */
     readonly notificationBoxesUpdatesCount: number;
     readonly notificationTasksDeletedCount: number;
     readonly notificationsDeleted: number;