@dereekb/firebase 12.2.0 → 12.3.0

package/index.cjs.js

@@ -8031,6 +8031,16 @@ function notificationSummaryIdForUidFunctionForRootFirestoreModelIdentity(userMo
  * The default notification template type that can be provided to subscribe to notifications not specified in the configurations.
  */
 const DEFAULT_NOTIFICATION_TEMPLATE_TYPE = 'D';
+/**
+ * Creates a NotificationTaskUniqueId from the input model id and task type.
+ *
+ * @param input model id input
+ * @param taskType task type
+ * @returns NotificationTaskUniqueId
+ */
+function notificationTaskUniqueId(input, taskType) {
+  return `${firestoreModelId(input)}_${taskType}`; // combineation of model id and template type
+}
 
 function mergeNotificationBoxRecipientTemplateConfigs(a, b) {
   const {
@@ -8482,6 +8492,12 @@ exports.NotificationSendType = void 0;
    * Sends the notification even if the NotificationBox does not exist.
    */
   NotificationSendType[NotificationSendType["SEND_WITHOUT_CREATING_BOX"] = 2] = "SEND_WITHOUT_CREATING_BOX";
+  /**
+   * A task notification.
+   *
+   * This is used with Task-type notifications.
+   */
+  NotificationSendType[NotificationSendType["TASK_NOTIFICATION"] = 3] = "TASK_NOTIFICATION";
 })(exports.NotificationSendType || (exports.NotificationSendType = {}));
 exports.NotificationSendState = void 0;
 (function (NotificationSendState) {
@@ -8494,7 +8510,7 @@ exports.NotificationSendState = void 0;
    */
   NotificationSendState[NotificationSendState["QUEUED"] = 0] = "QUEUED";
   /**
-   * Notification has been sent. Will still show as sent even if there were no messages/recipients to send for this medium.
+   * Notification has been sent/complete. Will still show as sent even if there were no messages/recipients to send for this medium.
    */
   NotificationSendState[NotificationSendState["SENT"] = 1] = "SENT";
   /**
@@ -8522,17 +8538,9 @@ exports.NotificationSendState = void 0;
    */
   NotificationSendState[NotificationSendState["CONFIG_ERROR"] = 7] = "CONFIG_ERROR";
 })(exports.NotificationSendState || (exports.NotificationSendState = {}));
-exports.NotificationType = void 0;
-(function (NotificationType) {
-  /**
-   * Normal notification that is sent to everyone that is configured for the notification box.
-   */
-  NotificationType[NotificationType["NORMAL"] = 0] = "NORMAL";
-  /**
-   * Notification that goes to only the configured users.
-   */
-  NotificationType[NotificationType["AD_HOC"] = 1] = "AD_HOC";
-})(exports.NotificationType || (exports.NotificationType = {}));
+/**
+ * Notification recipient send flags.
+ */
 exports.NotificationRecipientSendFlag = void 0;
 (function (NotificationRecipientSendFlag) {
   /**
@@ -8597,7 +8605,8 @@ const notificationConverter = snapshotConverterFunctions({
       default: false
     }),
     tsr: firestoreUniqueStringArray(),
-    esr: firestoreUniqueStringArray()
+    esr: firestoreUniqueStringArray(),
+    tpr: firestoreUniqueStringArray()
   }
 });
 function notificationCollectionReferenceFactory(context) {
@@ -9146,6 +9155,8 @@ function createNotificationTemplate(input) {
   const {
     notificationModel: inputNotification,
     type,
+    unique,
+    overrideExistingTask,
     // notification
     sendType,
     recipients,
@@ -9153,6 +9164,8 @@ function createNotificationTemplate(input) {
     r,
     rf,
     sat,
+    // task notifications
+    tpr,
     // item
     createdBy,
     targetModel: inputTargetModel,
@@ -9181,6 +9194,7 @@ function createNotificationTemplate(input) {
     notificationModel,
     st: sendType ?? st,
     sat,
+    tpr,
     rf,
     r: recipients ?? r,
     n: {
@@ -9191,7 +9205,9 @@ function createNotificationTemplate(input) {
       s: subject ?? s,
       g: message ?? g,
       d
-    }
+    },
+    unique,
+    overrideExistingTask
   };
   return template;
 }
@@ -9235,7 +9251,10 @@ function createNotificationDocumentPair(input) {
     ts,
     es,
     ps,
-    ns
+    ns,
+    tpr,
+    unique: inputUnique,
+    overrideExistingTask
   } = template;
   let accessor = inputAccessor;
   const notificationBoxId = notificationBoxIdForModel(notificationModel);
@@ -9252,7 +9271,22 @@ function createNotificationDocumentPair(input) {
   if (!accessor) {
     throw new Error('createNotificationDocument() failed as neither an accessor nor sufficient information was provided about the target.');
   }
-  const notificationDocument = accessor.newDocument();
+  let notificationDocument;
+  const isNotificationTask = st === exports.NotificationSendType.TASK_NOTIFICATION;
+  if (isNotificationTask && inputUnique) {
+    let uniqueId;
+    if (typeof inputUnique === 'string') {
+      uniqueId = inputUnique;
+      if (!isFirestoreModelId(uniqueId)) {
+        throw new Error('Input "unique" notification task id is not a valid firestore model id.');
+      }
+    } else {
+      uniqueId = notificationTaskUniqueId(notificationModel, n.t);
+    }
+    notificationDocument = accessor.loadDocumentForId(uniqueId);
+  } else {
+    notificationDocument = accessor.newDocument();
+  }
   const id = notificationDocument.id;
   const notification = {
     st: st ?? exports.NotificationSendType.INIT_BOX_AND_SEND,
@@ -9273,14 +9307,27 @@ function createNotificationDocumentPair(input) {
     d: false,
     tsr: [],
     esr: [],
+    tpr: [],
     ts: ts ?? exports.NotificationSendState.QUEUED,
     es: es ?? exports.NotificationSendState.QUEUED,
     ps: ps ?? exports.NotificationSendState.QUEUED,
     ns: ns ?? exports.NotificationSendState.QUEUED
   };
+  if (isNotificationTask) {
+    notification.tpr = tpr ?? []; // only set for task notifications
+    // no recipients
+    notification.r = [];
+    // no send states
+    notification.ts = exports.NotificationSendState.NONE;
+    notification.es = exports.NotificationSendState.NONE;
+    notification.ps = exports.NotificationSendState.NONE;
+    notification.ns = exports.NotificationSendState.NONE;
+  }
   return {
     notificationDocument,
     notification,
+    isNotificationTask,
+    overrideExistingTask,
     notificationCreated: false
   };
 }
@@ -9293,10 +9340,16 @@ async function createNotificationDocument(input) {
   const pair = createNotificationDocumentPair(input);
   const {
     notification,
-    notificationDocument
+    notificationDocument,
+    isNotificationTask,
+    overrideExistingTask
   } = pair;
   if (input.shouldCreateNotification !== false && shouldSendCreatedNotificationInput(input)) {
-    await notificationDocument.create(notification);
+    if (isNotificationTask && overrideExistingTask) {
+      await notificationDocument.accessor.set(notification);
+    } else {
+      await notificationDocument.create(notification);
+    }
     pair.notificationCreated = true;
   }
   return pair;
@@ -9316,6 +9369,24 @@ async function createNotificationDocumentIfSending(input) {
   }
 }
 
+/**
+ * Creates a notification template for a Notification with the task type.
+ *
+ * @param input
+ * @returns
+ */
+function createNotificationTaskTemplate(input) {
+  return createNotificationTemplate({
+    ...input,
+    tpr: input.completedCheckpoints ?? input.tpr,
+    sendType: exports.NotificationSendType.TASK_NOTIFICATION,
+    st: undefined,
+    rf: undefined,
+    recipients: undefined,
+    r: undefined
+  });
+}
+
 /**
  * Creates a NotificationTemplateTypeInfoRecord from the input info array.
  *
@@ -9532,6 +9603,13 @@ function mergeNotificationSendMessagesResult(a, b) {
   };
 }
 
+/**
+ * Returns an empty array, which is used to signal that the task did not fail but has not complete the current checkpoint.
+ */
+function delayCompletion() {
+  return [];
+}
+
 function effectiveNotificationBoxRecipientConfig(input) {
   const {
     uid,
@@ -9890,9 +9968,11 @@ exports.copyUserRelatedDataModifierConfig = copyUserRelatedDataModifierConfig;
 exports.createNotificationDocument = createNotificationDocument;
 exports.createNotificationDocumentIfSending = createNotificationDocumentIfSending;
 exports.createNotificationDocumentPair = createNotificationDocumentPair;
+exports.createNotificationTaskTemplate = createNotificationTaskTemplate;
 exports.createNotificationTemplate = createNotificationTemplate;
 exports.dataFromDocumentSnapshots = dataFromDocumentSnapshots;
 exports.dataFromSnapshotStream = dataFromSnapshotStream;
+exports.delayCompletion = delayCompletion;
 exports.developmentFirebaseFunctionMapFactory = developmentFirebaseFunctionMapFactory;
 exports.directDataHttpsCallable = directDataHttpsCallable;
 exports.documentData = documentData;
@@ -10147,6 +10227,7 @@ exports.notificationSummaryFirestoreCollection = notificationSummaryFirestoreCol
 exports.notificationSummaryIdForModel = notificationSummaryIdForModel;
 exports.notificationSummaryIdForUidFunctionForRootFirestoreModelIdentity = notificationSummaryIdForUidFunctionForRootFirestoreModelIdentity;
 exports.notificationSummaryIdentity = notificationSummaryIdentity;
+exports.notificationTaskUniqueId = notificationTaskUniqueId;
 exports.notificationTemplateTypeDetailsRecord = notificationTemplateTypeDetailsRecord;
 exports.notificationTemplateTypeInfoRecord = notificationTemplateTypeInfoRecord;
 exports.notificationUserCollectionReference = notificationUserCollectionReference;

package/index.esm.js

@@ -8029,6 +8029,16 @@ function notificationSummaryIdForUidFunctionForRootFirestoreModelIdentity(userMo
  * The default notification template type that can be provided to subscribe to notifications not specified in the configurations.
  */
 const DEFAULT_NOTIFICATION_TEMPLATE_TYPE = 'D';
+/**
+ * Creates a NotificationTaskUniqueId from the input model id and task type.
+ *
+ * @param input model id input
+ * @param taskType task type
+ * @returns NotificationTaskUniqueId
+ */
+function notificationTaskUniqueId(input, taskType) {
+  return `${firestoreModelId(input)}_${taskType}`; // combineation of model id and template type
+}
 
 function mergeNotificationBoxRecipientTemplateConfigs(a, b) {
   const {
@@ -8480,6 +8490,12 @@ var NotificationSendType;
    * Sends the notification even if the NotificationBox does not exist.
    */
   NotificationSendType[NotificationSendType["SEND_WITHOUT_CREATING_BOX"] = 2] = "SEND_WITHOUT_CREATING_BOX";
+  /**
+   * A task notification.
+   *
+   * This is used with Task-type notifications.
+   */
+  NotificationSendType[NotificationSendType["TASK_NOTIFICATION"] = 3] = "TASK_NOTIFICATION";
 })(NotificationSendType || (NotificationSendType = {}));
 var NotificationSendState;
 (function (NotificationSendState) {
@@ -8492,7 +8508,7 @@ var NotificationSendState;
    */
   NotificationSendState[NotificationSendState["QUEUED"] = 0] = "QUEUED";
   /**
-   * Notification has been sent. Will still show as sent even if there were no messages/recipients to send for this medium.
+   * Notification has been sent/complete. Will still show as sent even if there were no messages/recipients to send for this medium.
    */
   NotificationSendState[NotificationSendState["SENT"] = 1] = "SENT";
   /**
@@ -8520,17 +8536,9 @@ var NotificationSendState;
    */
   NotificationSendState[NotificationSendState["CONFIG_ERROR"] = 7] = "CONFIG_ERROR";
 })(NotificationSendState || (NotificationSendState = {}));
-var NotificationType;
-(function (NotificationType) {
-  /**
-   * Normal notification that is sent to everyone that is configured for the notification box.
-   */
-  NotificationType[NotificationType["NORMAL"] = 0] = "NORMAL";
-  /**
-   * Notification that goes to only the configured users.
-   */
-  NotificationType[NotificationType["AD_HOC"] = 1] = "AD_HOC";
-})(NotificationType || (NotificationType = {}));
+/**
+ * Notification recipient send flags.
+ */
 var NotificationRecipientSendFlag;
 (function (NotificationRecipientSendFlag) {
   /**
@@ -8595,7 +8603,8 @@ const notificationConverter = snapshotConverterFunctions({
       default: false
     }),
     tsr: firestoreUniqueStringArray(),
-    esr: firestoreUniqueStringArray()
+    esr: firestoreUniqueStringArray(),
+    tpr: firestoreUniqueStringArray()
   }
 });
 function notificationCollectionReferenceFactory(context) {
@@ -9144,6 +9153,8 @@ function createNotificationTemplate(input) {
   const {
     notificationModel: inputNotification,
     type,
+    unique,
+    overrideExistingTask,
     // notification
     sendType,
     recipients,
@@ -9151,6 +9162,8 @@ function createNotificationTemplate(input) {
     r,
     rf,
     sat,
+    // task notifications
+    tpr,
     // item
     createdBy,
     targetModel: inputTargetModel,
@@ -9179,6 +9192,7 @@ function createNotificationTemplate(input) {
     notificationModel,
     st: sendType ?? st,
     sat,
+    tpr,
     rf,
     r: recipients ?? r,
     n: {
@@ -9189,7 +9203,9 @@ function createNotificationTemplate(input) {
       s: subject ?? s,
       g: message ?? g,
       d
-    }
+    },
+    unique,
+    overrideExistingTask
   };
   return template;
 }
@@ -9233,7 +9249,10 @@ function createNotificationDocumentPair(input) {
     ts,
     es,
     ps,
-    ns
+    ns,
+    tpr,
+    unique: inputUnique,
+    overrideExistingTask
   } = template;
   let accessor = inputAccessor;
   const notificationBoxId = notificationBoxIdForModel(notificationModel);
@@ -9250,7 +9269,22 @@ function createNotificationDocumentPair(input) {
   if (!accessor) {
     throw new Error('createNotificationDocument() failed as neither an accessor nor sufficient information was provided about the target.');
   }
-  const notificationDocument = accessor.newDocument();
+  let notificationDocument;
+  const isNotificationTask = st === NotificationSendType.TASK_NOTIFICATION;
+  if (isNotificationTask && inputUnique) {
+    let uniqueId;
+    if (typeof inputUnique === 'string') {
+      uniqueId = inputUnique;
+      if (!isFirestoreModelId(uniqueId)) {
+        throw new Error('Input "unique" notification task id is not a valid firestore model id.');
+      }
+    } else {
+      uniqueId = notificationTaskUniqueId(notificationModel, n.t);
+    }
+    notificationDocument = accessor.loadDocumentForId(uniqueId);
+  } else {
+    notificationDocument = accessor.newDocument();
+  }
   const id = notificationDocument.id;
   const notification = {
     st: st ?? NotificationSendType.INIT_BOX_AND_SEND,
@@ -9271,14 +9305,27 @@ function createNotificationDocumentPair(input) {
     d: false,
     tsr: [],
     esr: [],
+    tpr: [],
     ts: ts ?? NotificationSendState.QUEUED,
     es: es ?? NotificationSendState.QUEUED,
     ps: ps ?? NotificationSendState.QUEUED,
     ns: ns ?? NotificationSendState.QUEUED
   };
+  if (isNotificationTask) {
+    notification.tpr = tpr ?? []; // only set for task notifications
+    // no recipients
+    notification.r = [];
+    // no send states
+    notification.ts = NotificationSendState.NONE;
+    notification.es = NotificationSendState.NONE;
+    notification.ps = NotificationSendState.NONE;
+    notification.ns = NotificationSendState.NONE;
+  }
   return {
     notificationDocument,
     notification,
+    isNotificationTask,
+    overrideExistingTask,
     notificationCreated: false
   };
 }
@@ -9291,10 +9338,16 @@ async function createNotificationDocument(input) {
   const pair = createNotificationDocumentPair(input);
   const {
     notification,
-    notificationDocument
+    notificationDocument,
+    isNotificationTask,
+    overrideExistingTask
   } = pair;
   if (input.shouldCreateNotification !== false && shouldSendCreatedNotificationInput(input)) {
-    await notificationDocument.create(notification);
+    if (isNotificationTask && overrideExistingTask) {
+      await notificationDocument.accessor.set(notification);
+    } else {
+      await notificationDocument.create(notification);
+    }
     pair.notificationCreated = true;
   }
   return pair;
@@ -9314,6 +9367,24 @@ async function createNotificationDocumentIfSending(input) {
   }
 }
 
+/**
+ * Creates a notification template for a Notification with the task type.
+ *
+ * @param input
+ * @returns
+ */
+function createNotificationTaskTemplate(input) {
+  return createNotificationTemplate({
+    ...input,
+    tpr: input.completedCheckpoints ?? input.tpr,
+    sendType: NotificationSendType.TASK_NOTIFICATION,
+    st: undefined,
+    rf: undefined,
+    recipients: undefined,
+    r: undefined
+  });
+}
+
 /**
  * Creates a NotificationTemplateTypeInfoRecord from the input info array.
  *
@@ -9530,6 +9601,13 @@ function mergeNotificationSendMessagesResult(a, b) {
   };
 }
 
+/**
+ * Returns an empty array, which is used to signal that the task did not fail but has not complete the current checkpoint.
+ */
+function delayCompletion() {
+  return [];
+}
+
 function effectiveNotificationBoxRecipientConfig(input) {
   const {
     uid,
@@ -9728,4 +9806,4 @@ function systemStateFirestoreCollection(firestoreContext, converters) {
   });
 }
 
-export { AbstractFirestoreDocument, AbstractFirestoreDocumentDataAccessorWrapper, AbstractFirestoreDocumentWithParent, AbstractSubscribeOrUnsubscribeToNotificationBoxParams, AbstractSubscribeToNotificationBoxParams, AppNotificationTemplateTypeInfoRecordService, BASE_MODEL_STORAGE_FILE_PATH, CALL_MODEL_APP_FUNCTION_KEY, COPY_USER_RELATED_DATA_ACCESSOR_FACTORY_FUNCTION, CREATE_NOTIFICATION_ID_REQUIRED_ERROR_CODE, CleanupSentNotificationsParams, ContextGrantedModelRolesReaderInstance, CreateNotificationBoxParams, CreateNotificationSummaryParams, CreateNotificationUserParams, DEFAULT_DATE_CELL_RANGE_VALUE, DEFAULT_FIRESTORE_DATE_CELL_SCHEDULE_VALUE, DEFAULT_FIRESTORE_ITEM_PAGE_ITERATOR_ITEMS_PER_PAGE, DEFAULT_FIRESTORE_STRING_FIELD_VALUE, DEFAULT_FIRESTORE_UNITED_STATES_ADDRESS_VALUE, DEFAULT_FIRESTORE_WEBSITE_FILE_LINK_VALUE, DEFAULT_ITERATE_FIRESTORE_DOCUMENT_SNAPSHOT_BATCHES_BATCH_SIZE, DEFAULT_NOTIFICATION_TEMPLATE_TYPE, DEFAULT_QUERY_CHANGE_WATCHER_DELAY, DEFAULT_SINGLE_ITEM_FIRESTORE_COLLECTION_DOCUMENT_IDENTIFIER, DEFAULT_WEBSITE_LINK, FIREBASE_AUTH_NETWORK_REQUEST_ERROR, FIREBASE_AUTH_NETWORK_REQUEST_FAILED, FIREBASE_AUTH_PASSWORD_MAX_LENGTH, FIREBASE_AUTH_PASSWORD_MIN_LENGTH, FIREBASE_AUTH_USER_NOT_FOUND_ERROR, FIREBASE_AUTH_WRONG_PASSWORD, FIREBASE_DEVELOPMENT_FUNCTIONS_MAP_KEY, FIREBASE_SERVER_AUTH_CLAIMS_RESET_LAST_COM_DATE_KEY, FIREBASE_SERVER_AUTH_CLAIMS_RESET_PASSWORD_KEY, FIREBASE_SERVER_AUTH_CLAIMS_SETUP_LAST_COM_DATE_KEY, FIREBASE_SERVER_AUTH_CLAIMS_SETUP_PASSWORD_KEY, FIRESTORE_CLIENT_QUERY_CONSTRAINT_HANDLER_MAPPING, FIRESTORE_COLLECTION_NAME_SEPARATOR, FIRESTORE_DUMMY_MODEL_KEY, FIRESTORE_EMPTY_VALUE, FIRESTORE_END_AT_QUERY_CONSTRAINT_TYPE, FIRESTORE_END_AT_VALUE_QUERY_CONSTRAINT_TYPE, FIRESTORE_END_BEFORE_QUERY_CONSTRAINT_TYPE, FIRESTORE_ITEM_PAGE_ITERATOR, FIRESTORE_ITEM_PAGE_ITERATOR_DELEGATE, FIRESTORE_LIMIT_QUERY_CONSTRAINT_TYPE, FIRESTORE_LIMIT_TO_LAST_QUERY_CONSTRAINT_TYPE, FIRESTORE_MAX_WHERE_IN_FILTER_ARGS_COUNT, FIRESTORE_MODEL_ID_REGEX, FIRESTORE_MODEL_KEY_REGEX, FIRESTORE_MODEL_KEY_REGEX_STRICT, FIRESTORE_OFFSET_QUERY_CONSTRAINT_TYPE, FIRESTORE_ORDER_BY_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE, FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE, FIRESTORE_PASSTHROUGH_FIELD, FIRESTORE_PERMISSION_DENIED_ERROR_CODE, FIRESTORE_START_AFTER_QUERY_CONSTRAINT_TYPE, FIRESTORE_START_AT_QUERY_CONSTRAINT_TYPE, FIRESTORE_START_AT_VALUE_QUERY_CONSTRAINT_TYPE, FIRESTORE_WHERE_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE, FIRESTORE_WHERE_QUERY_CONSTRAINT_TYPE, FirebaseDevelopmentFunctions, FirebaseModelPermissionServiceInstance, FirebaseServerError, FirestoreAccessorStreamMode, FirestoreDocumentContextType, InferredTargetModelIdParams, InferredTargetModelParams, InitializeAllApplicableNotificationBoxesParams, InitializeAllApplicableNotificationSummariesParams, InitializeNotificationModelParams, IsFirestoreModelId, IsFirestoreModelIdOrKey, IsFirestoreModelKey, MAX_FIRESTORE_MAP_ZOOM_LEVEL_VALUE, MIN_FIRESTORE_MAP_ZOOM_LEVEL_VALUE, MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER_DEFAULT, MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER_SPLITTER, MODEL_STORAGE_FILE_SLASH_PATH_FACTORY, ModifyBeforeSetFirestoreDocumentDataAccessorWrapper, NOTIFICATION_BOX_DOES_NOT_EXIST_ERROR_CODE, NOTIFICATION_BOX_EXISTS_FOR_MODEL_ERROR_CODE, NOTIFICATION_BOX_RECIPIENT_DOES_NOT_EXIST_ERROR_CODE, NOTIFICATION_MESSAGE_MAX_LENGTH, NOTIFICATION_MESSAGE_MIN_LENGTH, NOTIFICATION_MODEL_ALREADY_INITIALIZED_ERROR_CODE, NOTIFICATION_RECIPIENT_NAME_MAX_LENGTH, NOTIFICATION_RECIPIENT_NAME_MIN_LENGTH, NOTIFICATION_SUBJECT_MAX_LENGTH, NOTIFICATION_SUBJECT_MIN_LENGTH, NOTIFICATION_SUMMARY_EMBEDDED_NOTIFICATION_ITEM_MESSAGE_MAX_LENGTH, NOTIFICATION_SUMMARY_EMBEDDED_NOTIFICATION_ITEM_SUBJECT_MAX_LENGTH, NOTIFICATION_SUMMARY_ITEM_LIMIT, NOTIFICATION_USER_BLOCKED_FROM_BEING_ADD_TO_RECIPIENTS_ERROR_CODE, NOTIFICATION_USER_INVALID_UID_FOR_CREATE_ERROR_CODE, NOTIFICATION_USER_LOCKED_CONFIG_FROM_BEING_UPDATED_ERROR_CODE, NOTIFICATION_WEEK_NOTIFICATION_ITEM_LIMIT, NotificationBoxDocument, NotificationBoxRecipientFlag, NotificationBoxRecipientTemplateConfigArrayEntryParam, NotificationBoxRecipientTemplateConfigBoolean, NotificationDocument, NotificationFirestoreCollections, NotificationFunctions, NotificationMessageFlag, NotificationRecipientParams, NotificationRecipientSendFlag, NotificationSendState, NotificationSendType, NotificationSummaryDocument, NotificationType, NotificationUserDocument, NotificationWeekDocument, RUN_DEV_FUNCTION_APP_FUNCTION_KEY, ResyncAllNotificationUserParams, ResyncNotificationUserParams, SCHEDULED_FUNCTION_DEV_FUNCTION_SPECIFIER, ScheduledFunctionDevelopmentFirebaseFunctionListEntry, ScheduledFunctionDevelopmentFirebaseFunctionParams, ScheduledFunctionDevelopmentFunctionTypeEnum, SendNotificationParams, SendQueuedNotificationsParams, SystemStateDocument, SystemStateFirestoreCollections, TargetModelIdParams, TargetModelParams, UpdateNotificationBoxParams, UpdateNotificationBoxRecipientLikeParams, UpdateNotificationBoxRecipientParams, UpdateNotificationSummaryParams, UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams, UpdateNotificationUserNotificationBoxRecipientParams, UpdateNotificationUserParams, addConstraintToBuilder, addOrReplaceLimitInConstraints, allChildDocumentsUnderParent, allChildDocumentsUnderParentPath, allChildDocumentsUnderRelativePath, allowDocumentSnapshotWithPathOnceFilter, allowedNotificationRecipients, appNotificationTemplateTypeInfoRecordService, arrayUpdateWithAccessorFunction, asTopLevelFieldPath, asTopLevelFieldPaths, assertFirestoreUpdateHasData, assertStorageUploadOptionsStringFormat, assignDateCellRangeFunction, assignDateCellScheduleFunction, assignUnitedStatesAddressFunction, assignWebsiteFileLinkFunction, assignWebsiteLinkFunction, buildFirebaseCollectionTypeModelTypeMap, callModelFirebaseFunctionMapFactory, childFirestoreModelKey, childFirestoreModelKeyPath, childFirestoreModelKeys, clientFirebaseFirestoreContextFactory, clientFirebaseStorageContextFactory, contextGrantedModelRolesReader, contextGrantedModelRolesReaderDoesNotExistErrorMessage, contextGrantedModelRolesReaderPermissionErrorMessage, convertHttpsCallableErrorToReadableError, copyDocumentIdForUserRelatedModifierFunction, copyDocumentIdToFieldModifierFunction, copyUserRelatedDataAccessorFactoryFunction, copyUserRelatedDataModifierConfig, createNotificationDocument, createNotificationDocumentIfSending, createNotificationDocumentPair, createNotificationTemplate, dataFromDocumentSnapshots, dataFromSnapshotStream, developmentFirebaseFunctionMapFactory, directDataHttpsCallable, documentData, documentDataFunction, documentDataWithIdAndKey, documentReferenceFromDocument, documentReferencesFromDocuments, documentReferencesFromSnapshot, effectiveNotificationBoxRecipientConfig, effectiveNotificationBoxRecipientTemplateConfig, endAt, endAtValue, endBefore, extendFirestoreCollectionWithSingleDocumentAccessor, filterConstraintsOfType, filterDisallowedFirestoreItemPageIteratorInputConstraints, filterDisallowedFirestoreItemPageIteratorInputContraints, filterRepeatCheckpointSnapshots, filterWithDateRange, firebaseAuthErrorToReadableError, firebaseFirestoreClientDrivers, firebaseFirestoreQueryConstraintFunctionsDriver, firebaseFirestoreQueryDriver, firebaseFunctionMapFactory, firebaseModelLoader, firebaseModelPermissionService, firebaseModelService, firebaseModelServiceFactory, firebaseModelsService, firebaseQueryItemAccumulator, firebaseQuerySnapshotAccumulator, firebaseStorageBucketFolderPath, firebaseStorageClientAccessorDriver, firebaseStorageClientAccessorFile, firebaseStorageClientAccessorFolder, firebaseStorageClientDrivers, firebaseStorageClientListFilesResultFactory, firebaseStorageContextFactory, firebaseStorageFileExists, firebaseStorageFilePathFromStorageFilePath, firebaseStorageRefForStorageFilePath, firestoreArray, firestoreArrayMap, firestoreBitwiseObjectMap, firestoreBitwiseSet, firestoreBitwiseSetMap, firestoreBoolean, firestoreClientAccessorDriver, firestoreClientArrayUpdateToUpdateData, firestoreClientIncrementUpdateToUpdateData, firestoreCollectionQueryFactory, firestoreContextFactory, firestoreDate, firestoreDateCellRange, firestoreDateCellRangeArray, firestoreDateCellRangeAssignFn, firestoreDateCellSchedule, firestoreDateCellScheduleAssignFn, firestoreDencoderArray, firestoreDencoderMap, firestoreDencoderStringArray, firestoreDocumentAccessorContextExtension, firestoreDocumentAccessorFactory, firestoreDocumentLoader, firestoreDocumentSnapshotPairsLoader, firestoreDocumentSnapshotPairsLoaderInstance, firestoreDummyKey, firestoreEncodedArray, firestoreEncodedObjectMap, firestoreEnum, firestoreEnumArray, firestoreField, firestoreFieldConfigToModelMapFunctionsRef, firestoreIdBatchVerifierFactory, firestoreIdentityTypeArray, firestoreIdentityTypeArrayName, firestoreItemPageIteration, firestoreItemPageIterationFactory, firestoreLatLngString, firestoreMap, firestoreMapZoomLevel, firestoreModelId, firestoreModelIdArrayField, firestoreModelIdFromDocument, firestoreModelIdGrantedRoleArrayMap, firestoreModelIdGrantedRoleMap, firestoreModelIdString, firestoreModelIdentity, firestoreModelIdentityTypeMap, firestoreModelIdsFromDocuments, firestoreModelIdsFromKey, firestoreModelKey, firestoreModelKeyArrayField, firestoreModelKeyCollectionName, firestoreModelKeyCollectionType, firestoreModelKeyCollectionTypeArray, firestoreModelKeyCollectionTypeArrayName, firestoreModelKeyCollectionTypePair, firestoreModelKeyEncodedGrantedRoleMap, firestoreModelKeyFromDocument, firestoreModelKeyGrantedRoleArrayMap, firestoreModelKeyGrantedRoleMap, firestoreModelKeyPairObject, firestoreModelKeyParentKey, firestoreModelKeyParentKeyPartPairs, firestoreModelKeyPart, firestoreModelKeyPartPairs, firestoreModelKeyPartPairsKeyPath, firestoreModelKeyPartPairsPaths, firestoreModelKeyPath, firestoreModelKeyString, firestoreModelKeyTypePair, firestoreModelKeys, firestoreModelKeysFromDocuments, firestoreModelType, firestoreNotificationBoxRecipient, firestoreNotificationBoxRecipientTemplateConfigRecord, firestoreNotificationItem, firestoreNotificationRecipientWithConfig, firestoreNotificationUserDefaultNotificationBoxRecipientConfig, firestoreNotificationUserNotificationBoxRecipientConfig, firestoreNumber, firestoreObjectArray, firestorePassThroughField, firestoreQueryConstraint, firestoreQueryConstraintFactory, firestoreQueryDocumentSnapshotPairsLoader, firestoreQueryFactory, firestoreSingleDocumentAccessor, firestoreString, firestoreSubObject, firestoreTimezoneString, firestoreUID, firestoreUniqueArray, firestoreUniqueKeyedArray, firestoreUniqueNumberArray, firestoreUniqueStringArray, firestoreUnitedStatesAddress, firestoreUnitedStatesAddressAssignFn, firestoreUpdateWithNoDataError, firestoreWebsiteFileLink, firestoreWebsiteFileLinkAssignFn, firestoreWebsiteFileLinkEncodedArray, firestoreWebsiteFileLinkObjectArray, firestoreWebsiteLink, firestoreWebsiteLinkArray, firestoreWebsiteLinkAssignFn, flatFirestoreModelKey, getDataFromDocumentSnapshots, getDocumentSnapshotData, getDocumentSnapshotDataPair, getDocumentSnapshotDataPairs, getDocumentSnapshotDataPairsWithData, getDocumentSnapshotDataTuples, getDocumentSnapshotPair, getDocumentSnapshotPairs, getDocumentSnapshots, getDocumentSnapshotsData, grantFullAccessIfAdmin, grantFullAccessIfAuthUserRelated, grantModelRolesIfAdmin, grantModelRolesIfAdminFunction, grantModelRolesIfAuthUserRelatedModelFunction, grantModelRolesIfFunction, grantModelRolesIfHasAuthRolesFactory, grantModelRolesIfHasAuthRolesFunction, grantModelRolesOnlyIfFunction, inContextFirebaseModelServiceFactory, inContextFirebaseModelsServiceFactory, incrementUpdateWithAccessorFunction, inferKeyFromTwoWayFlatFirestoreModelKey, inferNotificationBoxRelatedModelKey, interceptAccessorFactoryFunction, isAdminInFirebaseModelContext, isClientFirebaseError, isCompleteNotificationSendState, isFirebaseStorageObjectNotFoundError, isFirestoreModelId, isFirestoreModelIdOrKey, isFirestoreModelKey, isOwnerOfUserRelatedModelInFirebaseModelContext, iterateFirestoreDocumentSnapshotBatches, iterateFirestoreDocumentSnapshotCheckpoints, iterateFirestoreDocumentSnapshotPairBatches, iterateFirestoreDocumentSnapshotPairs, iterateFirestoreDocumentSnapshots, iterationQueryDocChangeWatcher, iterationQueryDocChangeWatcherChangeTypeForGroup, latestDataFromDocuments, latestSnapshotsFromDocuments, lazyFirebaseFunctionsFactory, limit, limitToLast, limitedFirestoreDocumentAccessorFactory, loadAllFirestoreDocumentSnapshot, loadAllFirestoreDocumentSnapshotPairs, loadDocumentsForDocumentReferences, loadDocumentsForDocumentReferencesFromValues, loadDocumentsForIds, loadDocumentsForIdsFromValues, loadDocumentsForKeys, loadDocumentsForKeysFromValues, loadDocumentsForSnapshots, loadDocumentsForValues, loadNotificationBoxDocumentForReferencePair, makeDocuments, makeFirestoreCollection, makeFirestoreCollectionGroup, makeFirestoreCollectionWithParent, makeFirestoreItemPageIteratorDelegate, makeFirestoreQueryConstraintFunctionsDriver, makeRootSingleItemFirestoreCollection, makeSingleItemFirestoreCollection, mapDataFromSnapshot, mapHttpsCallable, mergeNotificationBoxRecipientTemplateConfigRecords, mergeNotificationBoxRecipientTemplateConfigs, mergeNotificationBoxRecipients, mergeNotificationSendMessagesResult, mergeNotificationUserDefaultNotificationBoxRecipientConfig, mergeNotificationUserNotificationBoxRecipientConfigs, modelStorageSlashPathFactory, modifyBeforeSetInterceptAccessorFactoryFunction, newDocuments, newNotificationBoxRecipientForUid, noContentNotificationMessageFunctionFactory, noStringFormatInStorageUploadOptionsError, notificationBoxCollectionReference, notificationBoxConverter, notificationBoxFirestoreCollection, notificationBoxIdForModel, notificationBoxIdentity, notificationBoxModelCrudFunctionsConfig, notificationBoxRecipientTemplateConfigArrayToRecord, notificationBoxRecipientTemplateConfigRecordToArray, notificationBoxesFlaggedForNeedsInitializationQuery, notificationBoxesFlaggedInvalidQuery, notificationCollectionReference, notificationCollectionReferenceFactory, notificationConverter, notificationFirestoreCollectionFactory, notificationFirestoreCollectionGroup, notificationFunctionMap, notificationFunctionTypeConfigMap, notificationIdentity, notificationMessageFunction, notificationSendFlagsImplyIsComplete, notificationSummariesFlaggedForNeedsInitializationQuery, notificationSummaryCollectionReference, notificationSummaryConverter, notificationSummaryFirestoreCollection, notificationSummaryIdForModel, notificationSummaryIdForUidFunctionForRootFirestoreModelIdentity, notificationSummaryIdentity, notificationTemplateTypeDetailsRecord, notificationTemplateTypeInfoRecord, notificationUserCollectionReference, notificationUserConverter, notificationUserFirestoreCollection, notificationUserIdentity, notificationUsersFlaggedForNeedsSyncQuery, notificationWeekCollectionReference, notificationWeekCollectionReferenceFactory, notificationWeekConverter, notificationWeekFirestoreCollectionFactory, notificationWeekFirestoreCollectionGroup, notificationWeekIdentity, notificationsPastSendAtTimeQuery, notificationsReadyForCleanupQuery, offset, onCallCreateModelParams, onCallCreateModelResult, onCallCreateModelResultWithDocs, onCallDeleteModelParams, onCallDevelopmentParams, onCallReadModelParams, onCallTypedModelParams, onCallTypedModelParamsFunction, onCallUpdateModelParams, optionalFirestoreArray, optionalFirestoreBoolean, optionalFirestoreDate, optionalFirestoreEnum, optionalFirestoreField, optionalFirestoreNumber, optionalFirestoreString, optionalFirestoreUID, optionalFirestoreUnitedStatesAddress, orderBy, orderByDocumentId, readFirestoreModelKey, readFirestoreModelKeyFromDocumentSnapshot, replaceConstraints, selectFromFirebaseModelsService, separateConstraints, setIdAndKeyFromKeyIdRefOnDocumentData, setIdAndKeyFromSnapshotOnDocumentData, shouldSaveNotificationToNotificationWeek, shouldSendCreatedNotificationInput, snapshotConverterFunctions, snapshotStreamDataForAccessor, snapshotStreamForAccessor, sortNotificationItemsFunction, startAfter, startAt, startAtValue, storageListFilesResultFactory, storageListFilesResultHasNoNextError, storagePathFactory, streamFromOnSnapshot, systemStateCollectionReference, systemStateConverter, systemStateFirestoreCollection, systemStateIdentity, twoWayFlatFirestoreModelKey, unreadNotificationItems, unsupportedFirestoreDriverFunctionError, updateNotificationBoxRecipientTemplateConfigRecord, updateNotificationRecipient, updateNotificationUserDefaultNotificationBoxRecipientConfig, updateNotificationUserNotificationBoxRecipientConfigIfChanged, updateNotificationUserNotificationBoxRecipientConfigs, updateWithAccessorUpdateAndConverterFunction, useContextAuth, useContextAuthUid, useDocumentSnapshot, useDocumentSnapshotData, useFirebaseModelsService, where, whereDateIsAfter, whereDateIsAfterWithSort, whereDateIsBefore, whereDateIsBeforeWithSort, whereDateIsBetween, whereDateIsInRange, whereDateIsOnOrAfter, whereDateIsOnOrAfterWithSort, whereDateIsOnOrBefore, whereDateIsOnOrBeforeWithSort, whereDocumentId, whereStringHasRootIdentityModelKey, whereStringValueHasPrefix };
+export { AbstractFirestoreDocument, AbstractFirestoreDocumentDataAccessorWrapper, AbstractFirestoreDocumentWithParent, AbstractSubscribeOrUnsubscribeToNotificationBoxParams, AbstractSubscribeToNotificationBoxParams, AppNotificationTemplateTypeInfoRecordService, BASE_MODEL_STORAGE_FILE_PATH, CALL_MODEL_APP_FUNCTION_KEY, COPY_USER_RELATED_DATA_ACCESSOR_FACTORY_FUNCTION, CREATE_NOTIFICATION_ID_REQUIRED_ERROR_CODE, CleanupSentNotificationsParams, ContextGrantedModelRolesReaderInstance, CreateNotificationBoxParams, CreateNotificationSummaryParams, CreateNotificationUserParams, DEFAULT_DATE_CELL_RANGE_VALUE, DEFAULT_FIRESTORE_DATE_CELL_SCHEDULE_VALUE, DEFAULT_FIRESTORE_ITEM_PAGE_ITERATOR_ITEMS_PER_PAGE, DEFAULT_FIRESTORE_STRING_FIELD_VALUE, DEFAULT_FIRESTORE_UNITED_STATES_ADDRESS_VALUE, DEFAULT_FIRESTORE_WEBSITE_FILE_LINK_VALUE, DEFAULT_ITERATE_FIRESTORE_DOCUMENT_SNAPSHOT_BATCHES_BATCH_SIZE, DEFAULT_NOTIFICATION_TEMPLATE_TYPE, DEFAULT_QUERY_CHANGE_WATCHER_DELAY, DEFAULT_SINGLE_ITEM_FIRESTORE_COLLECTION_DOCUMENT_IDENTIFIER, DEFAULT_WEBSITE_LINK, FIREBASE_AUTH_NETWORK_REQUEST_ERROR, FIREBASE_AUTH_NETWORK_REQUEST_FAILED, FIREBASE_AUTH_PASSWORD_MAX_LENGTH, FIREBASE_AUTH_PASSWORD_MIN_LENGTH, FIREBASE_AUTH_USER_NOT_FOUND_ERROR, FIREBASE_AUTH_WRONG_PASSWORD, FIREBASE_DEVELOPMENT_FUNCTIONS_MAP_KEY, FIREBASE_SERVER_AUTH_CLAIMS_RESET_LAST_COM_DATE_KEY, FIREBASE_SERVER_AUTH_CLAIMS_RESET_PASSWORD_KEY, FIREBASE_SERVER_AUTH_CLAIMS_SETUP_LAST_COM_DATE_KEY, FIREBASE_SERVER_AUTH_CLAIMS_SETUP_PASSWORD_KEY, FIRESTORE_CLIENT_QUERY_CONSTRAINT_HANDLER_MAPPING, FIRESTORE_COLLECTION_NAME_SEPARATOR, FIRESTORE_DUMMY_MODEL_KEY, FIRESTORE_EMPTY_VALUE, FIRESTORE_END_AT_QUERY_CONSTRAINT_TYPE, FIRESTORE_END_AT_VALUE_QUERY_CONSTRAINT_TYPE, FIRESTORE_END_BEFORE_QUERY_CONSTRAINT_TYPE, FIRESTORE_ITEM_PAGE_ITERATOR, FIRESTORE_ITEM_PAGE_ITERATOR_DELEGATE, FIRESTORE_LIMIT_QUERY_CONSTRAINT_TYPE, FIRESTORE_LIMIT_TO_LAST_QUERY_CONSTRAINT_TYPE, FIRESTORE_MAX_WHERE_IN_FILTER_ARGS_COUNT, FIRESTORE_MODEL_ID_REGEX, FIRESTORE_MODEL_KEY_REGEX, FIRESTORE_MODEL_KEY_REGEX_STRICT, FIRESTORE_OFFSET_QUERY_CONSTRAINT_TYPE, FIRESTORE_ORDER_BY_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE, FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE, FIRESTORE_PASSTHROUGH_FIELD, FIRESTORE_PERMISSION_DENIED_ERROR_CODE, FIRESTORE_START_AFTER_QUERY_CONSTRAINT_TYPE, FIRESTORE_START_AT_QUERY_CONSTRAINT_TYPE, FIRESTORE_START_AT_VALUE_QUERY_CONSTRAINT_TYPE, FIRESTORE_WHERE_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE, FIRESTORE_WHERE_QUERY_CONSTRAINT_TYPE, FirebaseDevelopmentFunctions, FirebaseModelPermissionServiceInstance, FirebaseServerError, FirestoreAccessorStreamMode, FirestoreDocumentContextType, InferredTargetModelIdParams, InferredTargetModelParams, InitializeAllApplicableNotificationBoxesParams, InitializeAllApplicableNotificationSummariesParams, InitializeNotificationModelParams, IsFirestoreModelId, IsFirestoreModelIdOrKey, IsFirestoreModelKey, MAX_FIRESTORE_MAP_ZOOM_LEVEL_VALUE, MIN_FIRESTORE_MAP_ZOOM_LEVEL_VALUE, MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER_DEFAULT, MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER_SPLITTER, MODEL_STORAGE_FILE_SLASH_PATH_FACTORY, ModifyBeforeSetFirestoreDocumentDataAccessorWrapper, NOTIFICATION_BOX_DOES_NOT_EXIST_ERROR_CODE, NOTIFICATION_BOX_EXISTS_FOR_MODEL_ERROR_CODE, NOTIFICATION_BOX_RECIPIENT_DOES_NOT_EXIST_ERROR_CODE, NOTIFICATION_MESSAGE_MAX_LENGTH, NOTIFICATION_MESSAGE_MIN_LENGTH, NOTIFICATION_MODEL_ALREADY_INITIALIZED_ERROR_CODE, NOTIFICATION_RECIPIENT_NAME_MAX_LENGTH, NOTIFICATION_RECIPIENT_NAME_MIN_LENGTH, NOTIFICATION_SUBJECT_MAX_LENGTH, NOTIFICATION_SUBJECT_MIN_LENGTH, NOTIFICATION_SUMMARY_EMBEDDED_NOTIFICATION_ITEM_MESSAGE_MAX_LENGTH, NOTIFICATION_SUMMARY_EMBEDDED_NOTIFICATION_ITEM_SUBJECT_MAX_LENGTH, NOTIFICATION_SUMMARY_ITEM_LIMIT, NOTIFICATION_USER_BLOCKED_FROM_BEING_ADD_TO_RECIPIENTS_ERROR_CODE, NOTIFICATION_USER_INVALID_UID_FOR_CREATE_ERROR_CODE, NOTIFICATION_USER_LOCKED_CONFIG_FROM_BEING_UPDATED_ERROR_CODE, NOTIFICATION_WEEK_NOTIFICATION_ITEM_LIMIT, NotificationBoxDocument, NotificationBoxRecipientFlag, NotificationBoxRecipientTemplateConfigArrayEntryParam, NotificationBoxRecipientTemplateConfigBoolean, NotificationDocument, NotificationFirestoreCollections, NotificationFunctions, NotificationMessageFlag, NotificationRecipientParams, NotificationRecipientSendFlag, NotificationSendState, NotificationSendType, NotificationSummaryDocument, NotificationUserDocument, NotificationWeekDocument, RUN_DEV_FUNCTION_APP_FUNCTION_KEY, ResyncAllNotificationUserParams, ResyncNotificationUserParams, SCHEDULED_FUNCTION_DEV_FUNCTION_SPECIFIER, ScheduledFunctionDevelopmentFirebaseFunctionListEntry, ScheduledFunctionDevelopmentFirebaseFunctionParams, ScheduledFunctionDevelopmentFunctionTypeEnum, SendNotificationParams, SendQueuedNotificationsParams, SystemStateDocument, SystemStateFirestoreCollections, TargetModelIdParams, TargetModelParams, UpdateNotificationBoxParams, UpdateNotificationBoxRecipientLikeParams, UpdateNotificationBoxRecipientParams, UpdateNotificationSummaryParams, UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams, UpdateNotificationUserNotificationBoxRecipientParams, UpdateNotificationUserParams, addConstraintToBuilder, addOrReplaceLimitInConstraints, allChildDocumentsUnderParent, allChildDocumentsUnderParentPath, allChildDocumentsUnderRelativePath, allowDocumentSnapshotWithPathOnceFilter, allowedNotificationRecipients, appNotificationTemplateTypeInfoRecordService, arrayUpdateWithAccessorFunction, asTopLevelFieldPath, asTopLevelFieldPaths, assertFirestoreUpdateHasData, assertStorageUploadOptionsStringFormat, assignDateCellRangeFunction, assignDateCellScheduleFunction, assignUnitedStatesAddressFunction, assignWebsiteFileLinkFunction, assignWebsiteLinkFunction, buildFirebaseCollectionTypeModelTypeMap, callModelFirebaseFunctionMapFactory, childFirestoreModelKey, childFirestoreModelKeyPath, childFirestoreModelKeys, clientFirebaseFirestoreContextFactory, clientFirebaseStorageContextFactory, contextGrantedModelRolesReader, contextGrantedModelRolesReaderDoesNotExistErrorMessage, contextGrantedModelRolesReaderPermissionErrorMessage, convertHttpsCallableErrorToReadableError, copyDocumentIdForUserRelatedModifierFunction, copyDocumentIdToFieldModifierFunction, copyUserRelatedDataAccessorFactoryFunction, copyUserRelatedDataModifierConfig, createNotificationDocument, createNotificationDocumentIfSending, createNotificationDocumentPair, createNotificationTaskTemplate, createNotificationTemplate, dataFromDocumentSnapshots, dataFromSnapshotStream, delayCompletion, developmentFirebaseFunctionMapFactory, directDataHttpsCallable, documentData, documentDataFunction, documentDataWithIdAndKey, documentReferenceFromDocument, documentReferencesFromDocuments, documentReferencesFromSnapshot, effectiveNotificationBoxRecipientConfig, effectiveNotificationBoxRecipientTemplateConfig, endAt, endAtValue, endBefore, extendFirestoreCollectionWithSingleDocumentAccessor, filterConstraintsOfType, filterDisallowedFirestoreItemPageIteratorInputConstraints, filterDisallowedFirestoreItemPageIteratorInputContraints, filterRepeatCheckpointSnapshots, filterWithDateRange, firebaseAuthErrorToReadableError, firebaseFirestoreClientDrivers, firebaseFirestoreQueryConstraintFunctionsDriver, firebaseFirestoreQueryDriver, firebaseFunctionMapFactory, firebaseModelLoader, firebaseModelPermissionService, firebaseModelService, firebaseModelServiceFactory, firebaseModelsService, firebaseQueryItemAccumulator, firebaseQuerySnapshotAccumulator, firebaseStorageBucketFolderPath, firebaseStorageClientAccessorDriver, firebaseStorageClientAccessorFile, firebaseStorageClientAccessorFolder, firebaseStorageClientDrivers, firebaseStorageClientListFilesResultFactory, firebaseStorageContextFactory, firebaseStorageFileExists, firebaseStorageFilePathFromStorageFilePath, firebaseStorageRefForStorageFilePath, firestoreArray, firestoreArrayMap, firestoreBitwiseObjectMap, firestoreBitwiseSet, firestoreBitwiseSetMap, firestoreBoolean, firestoreClientAccessorDriver, firestoreClientArrayUpdateToUpdateData, firestoreClientIncrementUpdateToUpdateData, firestoreCollectionQueryFactory, firestoreContextFactory, firestoreDate, firestoreDateCellRange, firestoreDateCellRangeArray, firestoreDateCellRangeAssignFn, firestoreDateCellSchedule, firestoreDateCellScheduleAssignFn, firestoreDencoderArray, firestoreDencoderMap, firestoreDencoderStringArray, firestoreDocumentAccessorContextExtension, firestoreDocumentAccessorFactory, firestoreDocumentLoader, firestoreDocumentSnapshotPairsLoader, firestoreDocumentSnapshotPairsLoaderInstance, firestoreDummyKey, firestoreEncodedArray, firestoreEncodedObjectMap, firestoreEnum, firestoreEnumArray, firestoreField, firestoreFieldConfigToModelMapFunctionsRef, firestoreIdBatchVerifierFactory, firestoreIdentityTypeArray, firestoreIdentityTypeArrayName, firestoreItemPageIteration, firestoreItemPageIterationFactory, firestoreLatLngString, firestoreMap, firestoreMapZoomLevel, firestoreModelId, firestoreModelIdArrayField, firestoreModelIdFromDocument, firestoreModelIdGrantedRoleArrayMap, firestoreModelIdGrantedRoleMap, firestoreModelIdString, firestoreModelIdentity, firestoreModelIdentityTypeMap, firestoreModelIdsFromDocuments, firestoreModelIdsFromKey, firestoreModelKey, firestoreModelKeyArrayField, firestoreModelKeyCollectionName, firestoreModelKeyCollectionType, firestoreModelKeyCollectionTypeArray, firestoreModelKeyCollectionTypeArrayName, firestoreModelKeyCollectionTypePair, firestoreModelKeyEncodedGrantedRoleMap, firestoreModelKeyFromDocument, firestoreModelKeyGrantedRoleArrayMap, firestoreModelKeyGrantedRoleMap, firestoreModelKeyPairObject, firestoreModelKeyParentKey, firestoreModelKeyParentKeyPartPairs, firestoreModelKeyPart, firestoreModelKeyPartPairs, firestoreModelKeyPartPairsKeyPath, firestoreModelKeyPartPairsPaths, firestoreModelKeyPath, firestoreModelKeyString, firestoreModelKeyTypePair, firestoreModelKeys, firestoreModelKeysFromDocuments, firestoreModelType, firestoreNotificationBoxRecipient, firestoreNotificationBoxRecipientTemplateConfigRecord, firestoreNotificationItem, firestoreNotificationRecipientWithConfig, firestoreNotificationUserDefaultNotificationBoxRecipientConfig, firestoreNotificationUserNotificationBoxRecipientConfig, firestoreNumber, firestoreObjectArray, firestorePassThroughField, firestoreQueryConstraint, firestoreQueryConstraintFactory, firestoreQueryDocumentSnapshotPairsLoader, firestoreQueryFactory, firestoreSingleDocumentAccessor, firestoreString, firestoreSubObject, firestoreTimezoneString, firestoreUID, firestoreUniqueArray, firestoreUniqueKeyedArray, firestoreUniqueNumberArray, firestoreUniqueStringArray, firestoreUnitedStatesAddress, firestoreUnitedStatesAddressAssignFn, firestoreUpdateWithNoDataError, firestoreWebsiteFileLink, firestoreWebsiteFileLinkAssignFn, firestoreWebsiteFileLinkEncodedArray, firestoreWebsiteFileLinkObjectArray, firestoreWebsiteLink, firestoreWebsiteLinkArray, firestoreWebsiteLinkAssignFn, flatFirestoreModelKey, getDataFromDocumentSnapshots, getDocumentSnapshotData, getDocumentSnapshotDataPair, getDocumentSnapshotDataPairs, getDocumentSnapshotDataPairsWithData, getDocumentSnapshotDataTuples, getDocumentSnapshotPair, getDocumentSnapshotPairs, getDocumentSnapshots, getDocumentSnapshotsData, grantFullAccessIfAdmin, grantFullAccessIfAuthUserRelated, grantModelRolesIfAdmin, grantModelRolesIfAdminFunction, grantModelRolesIfAuthUserRelatedModelFunction, grantModelRolesIfFunction, grantModelRolesIfHasAuthRolesFactory, grantModelRolesIfHasAuthRolesFunction, grantModelRolesOnlyIfFunction, inContextFirebaseModelServiceFactory, inContextFirebaseModelsServiceFactory, incrementUpdateWithAccessorFunction, inferKeyFromTwoWayFlatFirestoreModelKey, inferNotificationBoxRelatedModelKey, interceptAccessorFactoryFunction, isAdminInFirebaseModelContext, isClientFirebaseError, isCompleteNotificationSendState, isFirebaseStorageObjectNotFoundError, isFirestoreModelId, isFirestoreModelIdOrKey, isFirestoreModelKey, isOwnerOfUserRelatedModelInFirebaseModelContext, iterateFirestoreDocumentSnapshotBatches, iterateFirestoreDocumentSnapshotCheckpoints, iterateFirestoreDocumentSnapshotPairBatches, iterateFirestoreDocumentSnapshotPairs, iterateFirestoreDocumentSnapshots, iterationQueryDocChangeWatcher, iterationQueryDocChangeWatcherChangeTypeForGroup, latestDataFromDocuments, latestSnapshotsFromDocuments, lazyFirebaseFunctionsFactory, limit, limitToLast, limitedFirestoreDocumentAccessorFactory, loadAllFirestoreDocumentSnapshot, loadAllFirestoreDocumentSnapshotPairs, loadDocumentsForDocumentReferences, loadDocumentsForDocumentReferencesFromValues, loadDocumentsForIds, loadDocumentsForIdsFromValues, loadDocumentsForKeys, loadDocumentsForKeysFromValues, loadDocumentsForSnapshots, loadDocumentsForValues, loadNotificationBoxDocumentForReferencePair, makeDocuments, makeFirestoreCollection, makeFirestoreCollectionGroup, makeFirestoreCollectionWithParent, makeFirestoreItemPageIteratorDelegate, makeFirestoreQueryConstraintFunctionsDriver, makeRootSingleItemFirestoreCollection, makeSingleItemFirestoreCollection, mapDataFromSnapshot, mapHttpsCallable, mergeNotificationBoxRecipientTemplateConfigRecords, mergeNotificationBoxRecipientTemplateConfigs, mergeNotificationBoxRecipients, mergeNotificationSendMessagesResult, mergeNotificationUserDefaultNotificationBoxRecipientConfig, mergeNotificationUserNotificationBoxRecipientConfigs, modelStorageSlashPathFactory, modifyBeforeSetInterceptAccessorFactoryFunction, newDocuments, newNotificationBoxRecipientForUid, noContentNotificationMessageFunctionFactory, noStringFormatInStorageUploadOptionsError, notificationBoxCollectionReference, notificationBoxConverter, notificationBoxFirestoreCollection, notificationBoxIdForModel, notificationBoxIdentity, notificationBoxModelCrudFunctionsConfig, notificationBoxRecipientTemplateConfigArrayToRecord, notificationBoxRecipientTemplateConfigRecordToArray, notificationBoxesFlaggedForNeedsInitializationQuery, notificationBoxesFlaggedInvalidQuery, notificationCollectionReference, notificationCollectionReferenceFactory, notificationConverter, notificationFirestoreCollectionFactory, notificationFirestoreCollectionGroup, notificationFunctionMap, notificationFunctionTypeConfigMap, notificationIdentity, notificationMessageFunction, notificationSendFlagsImplyIsComplete, notificationSummariesFlaggedForNeedsInitializationQuery, notificationSummaryCollectionReference, notificationSummaryConverter, notificationSummaryFirestoreCollection, notificationSummaryIdForModel, notificationSummaryIdForUidFunctionForRootFirestoreModelIdentity, notificationSummaryIdentity, notificationTaskUniqueId, notificationTemplateTypeDetailsRecord, notificationTemplateTypeInfoRecord, notificationUserCollectionReference, notificationUserConverter, notificationUserFirestoreCollection, notificationUserIdentity, notificationUsersFlaggedForNeedsSyncQuery, notificationWeekCollectionReference, notificationWeekCollectionReferenceFactory, notificationWeekConverter, notificationWeekFirestoreCollectionFactory, notificationWeekFirestoreCollectionGroup, notificationWeekIdentity, notificationsPastSendAtTimeQuery, notificationsReadyForCleanupQuery, offset, onCallCreateModelParams, onCallCreateModelResult, onCallCreateModelResultWithDocs, onCallDeleteModelParams, onCallDevelopmentParams, onCallReadModelParams, onCallTypedModelParams, onCallTypedModelParamsFunction, onCallUpdateModelParams, optionalFirestoreArray, optionalFirestoreBoolean, optionalFirestoreDate, optionalFirestoreEnum, optionalFirestoreField, optionalFirestoreNumber, optionalFirestoreString, optionalFirestoreUID, optionalFirestoreUnitedStatesAddress, orderBy, orderByDocumentId, readFirestoreModelKey, readFirestoreModelKeyFromDocumentSnapshot, replaceConstraints, selectFromFirebaseModelsService, separateConstraints, setIdAndKeyFromKeyIdRefOnDocumentData, setIdAndKeyFromSnapshotOnDocumentData, shouldSaveNotificationToNotificationWeek, shouldSendCreatedNotificationInput, snapshotConverterFunctions, snapshotStreamDataForAccessor, snapshotStreamForAccessor, sortNotificationItemsFunction, startAfter, startAt, startAtValue, storageListFilesResultFactory, storageListFilesResultHasNoNextError, storagePathFactory, streamFromOnSnapshot, systemStateCollectionReference, systemStateConverter, systemStateFirestoreCollection, systemStateIdentity, twoWayFlatFirestoreModelKey, unreadNotificationItems, unsupportedFirestoreDriverFunctionError, updateNotificationBoxRecipientTemplateConfigRecord, updateNotificationRecipient, updateNotificationUserDefaultNotificationBoxRecipientConfig, updateNotificationUserNotificationBoxRecipientConfigIfChanged, updateNotificationUserNotificationBoxRecipientConfigs, updateWithAccessorUpdateAndConverterFunction, useContextAuth, useContextAuthUid, useDocumentSnapshot, useDocumentSnapshotData, useFirebaseModelsService, where, whereDateIsAfter, whereDateIsAfterWithSort, whereDateIsBefore, whereDateIsBeforeWithSort, whereDateIsBetween, whereDateIsInRange, whereDateIsOnOrAfter, whereDateIsOnOrAfterWithSort, whereDateIsOnOrBefore, whereDateIsOnOrBeforeWithSort, whereDocumentId, whereStringHasRootIdentityModelKey, whereStringValueHasPrefix };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "12.2.0",
+  "version": "12.3.0",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

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

@@ -5,10 +5,12 @@ export * from './notification.api.util';
 export * from './notification.action';
 export * from './notification.config';
 export * from './notification.create';
+export * from './notification.create.task';
 export * from './notification.details';
 export * from './notification.item';
 export * from './notification.id';
 export * from './notification.message';
 export * from './notification.query';
 export * from './notification.send';
+export * from './notification.task';
 export * from './notification.util';

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

@@ -5,6 +5,7 @@ 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';
 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;
@@ -266,6 +267,10 @@ export interface SendNotificationResult {
      * 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;
     /**
      * Whether or not the notification was of a configured type.
      */
@@ -280,6 +285,10 @@ export interface SendNotificationResult {
      * 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>;
     /**
      * Whether or not the notification was marked as done.
      *
@@ -297,29 +306,38 @@ export interface SendNotificationResult {
     /**
      * Whether or not the notification was deleted.
      *
-     * This typically only occurs when SEND_IF_BOX_EXISTS is set and the box does not exist.
+     * 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.
+     * Undefined if not attempted or a task notification.
      */
     readonly sendEmailsResult: Maybe<NotificationSendEmailMessagesResult>;
     /**
      *
      * Send texts result.
      *
-     * Undefined if not attempted.
+     * Undefined if not attempted or a task notification.
      */
     readonly sendTextsResult: Maybe<NotificationSendTextMessagesResult>;
     /**
      * Send notification summaries result.
      *
-     * Undefined if not attempted.
+     * Undefined if not attempted or a task notification.
      */
     readonly sendNotificationSummaryResult: Maybe<NotificationSendNotificationSummaryMessagesResult>;
     /**
@@ -336,9 +354,10 @@ export interface SendNotificationResult {
  */
 export declare class SendQueuedNotificationsParams {
 }
-export interface SendQueuedNotificationsResult extends Omit<SendNotificationResult, 'throttled' | 'isConfiguredTemplateType' | 'isKnownTemplateType' | 'notificationTemplateType' | 'notificationMarkedDone' | 'deletedNotification' | 'createdBox' | 'success' | 'exists' | 'boxExists' | 'notificationBoxNeedsInitialization' | 'tryRun' | 'loadMessageFunctionFailure' | 'buildMessageFailure'> {
+export interface SendQueuedNotificationsResult extends Omit<SendNotificationResult, 'throttled' | 'isNotificationTask' | 'isConfiguredTemplateType' | 'isKnownTemplateType' | 'notificationTemplateType' | 'notificationMarkedDone' | 'deletedNotification' | 'createdBox' | 'success' | 'exists' | 'boxExists' | 'notificationBoxNeedsInitialization' | 'tryRun' | 'loadMessageFunctionFailure' | 'buildMessageFailure'> {
     readonly notificationBoxesCreated: number;
     readonly notificationsVisited: number;
+    readonly notificationTasksVisited: number;
     readonly notificationsSucceeded: number;
     readonly notificationsDelayed: number;
     readonly notificationsFailed: number;
@@ -354,6 +373,7 @@ 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;
     readonly notificationWeeksCreated: number;
     readonly notificationWeeksUpdated: number;

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

@@ -1,7 +1,7 @@
 import { type Maybe, type Milliseconds, 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 { NotificationTaskType, NotificationTaskUniqueId, type NotificationTemplateType } from './notification.id';
 import { type FirebaseAuthUserId, type FirestoreDocumentAccessor, type ReadFirestoreModelKeyInput, type Transaction } from '../../common';
 import { type NotificationItem } from './notification.item';
 /**
@@ -11,7 +11,7 @@ export interface CreateNotificationTemplateItem extends Omit<NotificationItem, '
     /**
      * Custom created at date for the item.
      */
-    cat?: Maybe<Date>;
+    readonly cat?: Maybe<Date>;
 }
 /**
  * Template use for creating a new Notification
@@ -20,11 +20,29 @@ export interface CreateNotificationTemplate extends Partial<Omit<Notification, '
     /**
      * Model key of the NotificationBox's target model (not the NotificationBox's key)
      */
-    notificationModel: ModelKey;
+    readonly notificationModel: ModelKey;
     /**
      * Item template
      */
-    n: CreateNotificationTemplateItem;
+    readonly n: CreateNotificationTemplateItem;
+    /**
+     * Whether or not this notification task is "unique".
+     *
+     * If true, the notification task will be created using a unique key based on the target model's id and the task type.
+     *
+     * If a string, the notification task will be created with the provided unique key.
+     *
+     * Only used for Notification Tasks.
+     */
+    readonly unique?: boolean | NotificationTaskUniqueId;
+    /**
+     * Whether or not to override an existing task with the same unique key when creating.
+     *
+     * Defaults to true.
+     *
+     * Only used for Notification Tasks.
+     */
+    readonly overrideExistingTask?: boolean;
 }
 export interface CreateNotificationTemplateInput extends Partial<Omit<CreateNotificationTemplate, 'notificationModel'>>, Partial<Omit<CreateNotificationTemplateItem, 't'>> {
     /**
@@ -34,7 +52,7 @@ export interface CreateNotificationTemplateInput extends Partial<Omit<CreateNoti
     /**
      * Template type
      */
-    readonly type: NotificationTemplateType;
+    readonly type: NotificationTemplateType | NotificationTaskType;
     /**
      * Overrides st
      */
@@ -108,13 +126,17 @@ export interface CreateNotificationDocumentPairInput extends ShouldSendCreatedNo
      */
     readonly accessor?: FirestoreDocumentAccessor<Notification, NotificationDocument>;
 }
-export interface CreateNotificationDocumentPairResult {
+export interface CreateNotificationDocumentPairResult extends Pick<CreateNotificationTemplate, 'overrideExistingTask'> {
     readonly notificationDocument: NotificationDocument;
     readonly notification: Notification;
     /**
      * Whether or not the notification was created.
      */
     readonly notificationCreated: boolean;
+    /**
+     * Whether or not the notification is considered a task notification.
+     */
+    readonly isNotificationTask: boolean;
 }
 /**
  * Creates a CreateNotificationDocumentPairResult from the input.

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

@@ -0,0 +1,22 @@
+import { Maybe } from '@dereekb/util';
+import { NotificationTaskCheckpointString } from './notification';
+import { CreateNotificationTemplate, CreateNotificationTemplateInput } from './notification.create';
+/**
+ * Template use for creating a new Notification task.
+ */
+export type CreateNotificationTaskTemplate = CreateNotificationTemplate;
+export interface CreateNotificationTaskTemplateInput extends Omit<CreateNotificationTemplateInput, 'st' | 'recipients' | 'r' | 'rf' | 'sendType' | 'st'> {
+    /**
+     * Corresponds with the tpr field in the Notification.
+     *
+     * Provide this if some checkpoints have already been completed.
+     */
+    readonly completedCheckpoints?: Maybe<NotificationTaskCheckpointString[]>;
+}
+/**
+ * Creates a notification template for a Notification with the task type.
+ *
+ * @param input
+ * @returns
+ */
+export declare function createNotificationTaskTemplate(input: CreateNotificationTaskTemplateInput): CreateNotificationTaskTemplate;

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

@@ -223,7 +223,13 @@ export declare enum NotificationSendType {
     /**
      * Sends the notification even if the NotificationBox does not exist.
      */
-    SEND_WITHOUT_CREATING_BOX = 2
+    SEND_WITHOUT_CREATING_BOX = 2,
+    /**
+     * A task notification.
+     *
+     * This is used with Task-type notifications.
+     */
+    TASK_NOTIFICATION = 3
 }
 export declare enum NotificationSendState {
     /**
@@ -235,7 +241,7 @@ export declare enum NotificationSendState {
      */
     QUEUED = 0,
     /**
-     * Notification has been sent. Will still show as sent even if there were no messages/recipients to send for this medium.
+     * Notification has been sent/complete. Will still show as sent even if there were no messages/recipients to send for this medium.
      */
     SENT = 1,
     /**
@@ -263,16 +269,9 @@ export declare enum NotificationSendState {
      */
     CONFIG_ERROR = 7
 }
-export declare enum NotificationType {
-    /**
-     * Normal notification that is sent to everyone that is configured for the notification box.
-     */
-    NORMAL = 0,
-    /**
-     * Notification that goes to only the configured users.
-     */
-    AD_HOC = 1
-}
+/**
+ * Notification recipient send flags.
+ */
 export declare enum NotificationRecipientSendFlag {
     /**
      * Will send to all recipients.
@@ -317,6 +316,10 @@ export interface NotificationSendFlags {
      */
     rf?: Maybe<NotificationRecipientSendFlag>;
 }
+/**
+ * Arbitrary unique string that denotes checkpoint progress for a multi-step task.
+ */
+export type NotificationTaskCheckpointString = string;
 /**
  * Contains information about which recipients were already sent their messages, etc.
  */
@@ -329,6 +332,12 @@ export interface NotificationSendCheckpoints {
      * Set of emails that the notification was set to via email.
      */
     esr: EmailAddress[];
+    /**
+     * Set of checkpoint strings that denote checkpoint progress for a task.
+     *
+     * Used for multi-step tasks.
+     */
+    tpr: NotificationTaskCheckpointString[];
 }
 export interface Notification extends NotificationSendFlags, NotificationSendCheckpoints {
     /**
@@ -373,10 +382,16 @@ export interface Notification extends NotificationSendFlags, NotificationSendChe
     sat: Date;
     /**
      * Sending attempts count.
+     *
+     * Only incremented when sending encounters an issue/error.
      */
     a: number;
     /**
-     * Notification has been delivered or should be archived. This is now safe to sync to the NotificationWeek and then delete this.
+     * Notification has been delivered or should be archived.
+     *
+     * This is now safe to sync to the NotificationWeek (not applicable for task-type notifications) and then delete this.
+     *
+     * For Task-type notifications, this is always set to false, as when the task is completed it is deleted.
      */
     d: boolean;
 }

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

@@ -1,5 +1,5 @@
 import { type FactoryWithRequiredInput } from '@dereekb/util';
-import { type FirestoreModelId, type FirestoreModelKey, type FlatFirestoreModelKey, twoWayFlatFirestoreModelKey, inferKeyFromTwoWayFlatFirestoreModelKey, type FirebaseAuthUserId, type RootFirestoreModelIdentity } from '../../common';
+import { type FirestoreModelId, type FirestoreModelKey, type FlatFirestoreModelKey, twoWayFlatFirestoreModelKey, inferKeyFromTwoWayFlatFirestoreModelKey, type FirebaseAuthUserId, type RootFirestoreModelIdentity, FirestoreModelIdInput } from '../../common';
 /**
  * The NotificationBox's id is the two way flat firestore model key of the object that it represents.
  */
@@ -44,6 +44,30 @@ export declare const DEFAULT_NOTIFICATION_TEMPLATE_TYPE = "D";
  *
  * Types are generally intended to be handled case-insensitively by notification services.
  *
- * Ideally type type values are shorter to reduce database size impact.
+ * Ideally type values are shorter to reduce database size impact.
  */
 export type NotificationTemplateType = string;
+/**
+ * Task type identifier of the notification, which is used to pass this task to the appropriate handler.
+ *
+ * Ideally type values are shorter to reduce database size impact.
+ */
+export type NotificationTaskType = string;
+/**
+ * Unique key for a notification task.
+ *
+ * Used as the notification task's id, so it must follow Firestore model id rules.
+ *
+ * Using a unique key for a notification task ensures that only one of this type of task can exist at a single time.
+ *
+ * If a unique key is reused, the new task will replace the old task.
+ */
+export type NotificationTaskUniqueId = FirestoreModelId;
+/**
+ * Creates a NotificationTaskUniqueId from the input model id and task type.
+ *
+ * @param input model id input
+ * @param taskType task type
+ * @returns NotificationTaskUniqueId
+ */
+export declare function notificationTaskUniqueId(input: FirestoreModelIdInput, taskType: NotificationTaskType): NotificationTaskUniqueId;

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

@@ -1,6 +1,6 @@
 import { type Maybe } from '@dereekb/util';
 import { type FirebaseAuthUserId, type FirestoreModelKey, type SavedToFirestoreIfTrue } from '../../common';
-import { type NotificationId, type NotificationTemplateType } from './notification.id';
+import { NotificationTaskType, type NotificationId, type NotificationTemplateType } from './notification.id';
 /**
  * Arbitrary metadata for a job. Derived/managed by the concrete job type.
  */
@@ -26,9 +26,9 @@ export interface NotificationItem<D extends NotificationItemMetadata = {}> {
      */
     cat: Date;
     /**
-     * Notification template type.
+     * Notification task/template type.
      */
-    t: NotificationTemplateType;
+    t: NotificationTemplateType | NotificationTaskType;
     /**
      * User who created this notification, if applicable.
      */

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

@@ -0,0 +1,58 @@
+import { NotificationItem, NotificationItemMetadata } from './notification.item';
+import { NotificationTaskType } from './notification.id';
+import { NotificationTaskCheckpointString } from './notification';
+import { ArrayOrValue, Maybe, Milliseconds } from '@dereekb/util';
+/**
+ * A NotificationTask is the final result of the expanded notification with a task type.
+ */
+export interface NotificationTask<D extends NotificationItemMetadata = {}> {
+    /**
+     * Task type identifier of the notification, which is used to pass this task to the appropriate handler.
+     *
+     * Ideally type values are shorter to reduce database size impact.
+     */
+    readonly taskType: NotificationTaskType;
+    /**
+     * Notification item
+     */
+    readonly item: NotificationItem<D>;
+    /**
+     * Notification item data, if applicable.
+     */
+    readonly data?: Maybe<D>;
+    /**
+     * Current checkpoints for the notification task.
+     */
+    readonly checkpoints: NotificationTaskCheckpointString[];
+}
+/**
+ * Returns an empty array, which is used to signal that the task did not fail but has not complete the current checkpoint.
+ */
+export declare function delayCompletion(): NotificationTaskServiceTaskHandlerCompletionType;
+/**
+ * Result of a NotificationTaskServiceTaskHandler.handleNotificationTask() call.
+ *
+ * true: The task was completed successfully and can now be discarded.
+ * false: The task was not completed successfully and should be retried again in the future. Note there are a maximum number of retry attempts before the task is deleted. Use delayCompletion() to avoid increasing the attempt count.
+ * NotificationTaskCheckpointString(s): The task has successfully completed this/these particular checkpoint(s) but is not complete and should be continued again in the future. Return an empty array to signal that the task did not fail but has not reached the next checkpoint.
+ */
+export type NotificationTaskServiceTaskHandlerCompletionType = true | false | ArrayOrValue<NotificationTaskCheckpointString>;
+/**
+ * Result of a NotificationTaskServiceTaskHandler.handleNotificationTask() call.
+ */
+export interface NotificationTaskServiceHandleNotificationTaskResult<D extends NotificationItemMetadata = {}> {
+    /**
+     * Completion type for the task result.
+     */
+    readonly completion: NotificationTaskServiceTaskHandlerCompletionType;
+    /**
+     * Updates the metadata for the notification item if the task is successful but not yet marked done.
+     *
+     * Does not update the metadata if the completion type is true or false.
+     */
+    readonly updateMetadata?: Partial<D>;
+    /**
+     * Delays the next run of the task by the specified amount of time or until the given date.
+     */
+    readonly delayUntil?: Maybe<Date | Milliseconds>;
+}

package/test/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [12.3.0](https://github.com/dereekb/dbx-components/compare/v12.2.1-dev...v12.3.0) (2025-07-04)
+
+
+
+## [12.2.1](https://github.com/dereekb/dbx-components/compare/v12.2.0-dev...v12.2.1) (2025-07-02)
+
+
+
 # [12.2.0](https://github.com/dereekb/dbx-components/compare/v12.1.14-dev...v12.2.0) (2025-06-29)
 
 

package/test/package.json

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