@dereekb/firebase 13.9.0 → 13.10.1

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

@@ -22,6 +22,8 @@ import { type NotificationKey } from '../notification';
  * Abstract base providing access to StorageFile and StorageFileGroup Firestore collections.
  *
  * Implement this in your app module to wire up the collections for dependency injection.
+ *
+ * @dbxModelGroup StorageFile
  */
 export declare abstract class StorageFileFirestoreCollections {
     abstract readonly storageFileCollection: StorageFileFirestoreCollection;
@@ -41,6 +43,8 @@ export interface InitializedStorageFileModel {
      * True if this model needs to be sync'd/initialized with the original model.
      *
      * Is set false if/when "fi" is set true.
+     *
+     * @dbxModelVariable needsSync
      */
     s?: Maybe<NeedsSyncBoolean>;
     /**
@@ -49,6 +53,8 @@ export interface InitializedStorageFileModel {
      * This is for cases where the model cannot be properly initiialized.
      *
      * Typically this results in this model and related data being deleted.
+     *
+     * @dbxModelVariable flaggedInvalid
      */
     fi?: Maybe<SavedToFirestoreIfTrue>;
 }
@@ -254,10 +260,13 @@ export type StorageFileDownloadUrl = StorageFilePublicDownloadUrl | StorageFileS
  * `StorageFileActionServerActions` in `@dereekb/firebase-server/model`.
  *
  * @template M - type of the arbitrary metadata stored in the `d` field
+ * @dbxModel
  */
 export interface StorageFile<M extends StorageFileMetadata = StorageFileMetadata> extends StoragePath {
     /**
      * Created at date.
+     *
+     * @dbxModelVariable createdAt
      */
     cat: Date;
     /**
@@ -265,14 +274,20 @@ export interface StorageFile<M extends StorageFileMetadata = StorageFileMetadata
      *
      * This name is used in StorageFileGroup composite file generations, instead
      * of the file's normal path file name, if available.
+     *
+     * @dbxModelVariable displayName
      */
     n?: Maybe<StorageFileDisplayName>;
     /**
      * Type of creation.
+     *
+     * @dbxModelVariable creationType
      */
     ct?: Maybe<StorageFileCreationType>;
     /**
      * State of the storage file.
+     *
+     * @dbxModelVariable fileState
      */
     fs: StorageFileState;
     /**
@@ -281,6 +296,8 @@ export interface StorageFile<M extends StorageFileMetadata = StorageFileMetadata
      * The state is important for managing the processing of the StorageFile.
      *
      * Once processing is finished, the state determines whether or not the StorageFile can be processed again.
+     *
+     * @dbxModelVariable processingState
      */
     ps: StorageFileProcessingState;
     /**
@@ -289,50 +306,70 @@ export interface StorageFile<M extends StorageFileMetadata = StorageFileMetadata
      * Set only if the StorageFile has an associated NotificationTask.
      *
      * Cleared once the processing stage is no longer PROCESSING.
+     *
+     * @dbxModelVariable processingNotificationKey
      */
     pn?: Maybe<NotificationKey>;
     /**
      * The date that state was last updated to PROCESSING.
      *
      * Is used as a way to track if processing should be checked on.
+     *
+     * @dbxModelVariable processingAt
      */
     pat?: Maybe<Date>;
     /**
      * The date that the cleanup step of the processing task was run, and the notification ended.
+     *
+     * @dbxModelVariable processingCleanupAt
      */
     pcat?: Maybe<Date>;
     /**
      * User this file is associated with, if applicable.
+     *
+     * @dbxModelVariable userId
      */
     u?: Maybe<FirebaseAuthUserId>;
     /**
      * User who uploaded this file, if applicable.
+     *
+     * @dbxModelVariable uploadedBy
      */
     uby?: Maybe<FirebaseAuthUserId>;
     /**
      * Ownership key, if applicable.
+     *
+     * @dbxModelVariable ownerKey
      */
     o?: Maybe<FirebaseAuthOwnershipKey>;
     /**
      * Purpose of the file, if applicable.
      *
      * Is required for processing a StorageFile.
+     *
+     * @dbxModelVariable purpose
      */
     p?: Maybe<StorageFilePurpose>;
     /**
      * Subgroup of the purpose of the file, if applicable.
      *
      * If a StorageFilePurpose should have subgroups, then all StorageFiles should have subgroups too.
+     *
+     * @dbxModelVariable purposeSubgroup
      */
     pg?: Maybe<StorageFilePurposeSubgroup>;
     /**
      * Arbitrary metadata attached to the StorageFile.
+     *
+     * @dbxModelVariable data
      */
     d?: Maybe<M>;
     /**
      * Scheduled delete at date. The StorageFile cannot be deleted before this set time.
      *
      * Is the main trigger for determining a StorageFile should be deleted.
+     *
+     * @dbxModelVariable scheduledDeleteAt
      */
     sdat?: Maybe<Date>;
     /**
@@ -346,10 +383,14 @@ export interface StorageFile<M extends StorageFileMetadata = StorageFileMetadata
      * but there is no gurantee about timeliness when this will happen. StorageFiles, when deleted, are removed from StorageFileGroups immediately, which are flagged for another regeneration automatically.
      *
      * In cases where you need to have the StorageFileGroup be updated promptly, you should manually handle those cases.
+     *
+     * @dbxModelVariable groupIds
      */
     g: StorageFileGroupId[];
     /**
      * If true, this file should be re-synced with each StorageFileGroup that it references.
+     *
+     * @dbxModelVariable groupsNeedSync
      */
     gs?: Maybe<NeedsSyncBoolean>;
 }
@@ -416,20 +457,28 @@ export declare const storageFileGroupIdentity: import("../..").RootFirestoreMode
  */
 export interface StorageFileGroupEmbeddedFile {
     /**
-     * StorageFile id
+     * StorageFile id.
+     *
+     * @dbxModelVariable storageFileId
      */
     s: StorageFileId;
     /**
      * Overrides the display name for this file within the group when generating
      * a composite file (zip, etc.).
+     *
+     * @dbxModelVariable displayName
      */
     n?: Maybe<StorageFileDisplayName>;
     /**
      * The time number it was added to the group.
+     *
+     * @dbxModelVariable addedAt
      */
     sat: Date;
     /**
      * The first time the StorageFile's file was added to the zip, if applicable.
+     *
+     * @dbxModelVariable zippedAt
      */
     zat?: Maybe<Date>;
 }
@@ -447,42 +496,60 @@ export declare const storageFileGroupEmbeddedFile: import("../..").FirestoreSubO
  *
  * Implements {@link InitializedStorageFileModel} for async initialization tracking —
  * the `s` (needs sync) flag is set on creation and cleared once initialized.
+ *
+ * @dbxModel
  */
 export interface StorageFileGroup extends InitializedStorageFileModel {
     /**
      * List of embedded files in this group currently.
+     *
+     * @dbxModelVariable files
      */
     f: StorageFileGroupEmbeddedFile[];
     /**
      * Created at date.
+     *
+     * @dbxModelVariable createdAt
      */
     cat: Date;
     /**
      * Ownership key, if applicable.
+     *
+     * @dbxModelVariable ownerKey
      */
     o?: Maybe<FirebaseAuthOwnershipKey>;
     /**
      * True if a zip file should be generated for this group.
      *
      * This should remain true while a zip file
+     *
+     * @dbxModelVariable shouldZip
      */
     z?: Maybe<SavedToFirestoreIfTrue>;
     /**
      * StorageFile that contains the zip file for this group.
+     *
+     * @dbxModelVariable zipStorageFileId
      */
     zsf?: Maybe<StorageFileId>;
     /**
      * The last date the zip file was regenerated for this group.
+     *
+     * @dbxModelVariable zippedAt
      */
     zat?: Maybe<Date>;
     /**
      * True if this StorageFileGroup should flag regeneration of output StorageFiles/content.
+     *
+     * @dbxModelVariable shouldRegenerate
      */
     re?: Maybe<SavedToFirestoreIfTrue>;
     /**
      * True if this StorageFileGroup should clean up file references.
      *
      * This cleanup process will occur during the next regeneration.
+     *
+     * @dbxModelVariable shouldCleanup
      */
     c?: Maybe<SavedToFirestoreIfTrue>;
 }

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

@@ -26,6 +26,11 @@ export type StorageFileKey = FirestoreModelKey;
  * set on files that do not get processed.
  *
  * Can be used for querying.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-firebase:storage-file
  */
 export type StorageFilePurpose = string;
 /**
@@ -34,6 +39,11 @@ export type StorageFilePurpose = string;
  * This is useful for being able to query StorageFiles that have a specific purpose and purpose subgroup.
  *
  * Example use case: Documents with the same StorageFilePurpose/processing, but should only have a single StorageFile per subgroup.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-firebase:storage-file
  */
 export type StorageFilePurposeSubgroup = string;
 /**

package/src/lib/model/storagefile/storagefile.upload.d.ts

@@ -75,6 +75,11 @@ export declare function userUploadsFolderStoragePathFactory({ bucketId, basePath
  * - folder name: A specific folder name (e.g. 'photos' in 'photos/12345.png')
  * - metadata: specific metadata value in the uploaded file's custom metadata
  * - data: specific data in the uploaded file
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-firebase:storage-file
  */
 export type UploadedFileTypeIdentifier = string;
 /**

package/src/lib/model/storagefile/storagefile.upload.determiner.d.ts

@@ -33,6 +33,10 @@ import { type StoredFileReader } from './storagefile.file';
  * it is processed properly.
  *
  * In the ideal case there generally shouldn't be two determiners that could potentially match the same file.
+ *
+ * @semanticType
+ * @semanticTopic numeric
+ * @semanticTopic dereekb-firebase:storage-file
  */
 export type UploadedFileTypeDeterminationLevel = number;
 /**

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

@@ -20,6 +20,8 @@ import { type ModelFieldMapFunctionsConfig } from '@dereekb/util';
  * Abstract base providing access to the SystemState Firestore collection.
  *
  * Implement this in your app module to wire up dependency injection.
+ *
+ * @dbxModelGroup SystemState
  */
 export declare abstract class SystemStateFirestoreCollections {
     abstract readonly systemStateCollection: SystemStateFirestoreCollection;
@@ -34,6 +36,11 @@ export type SystemStateTypes = typeof systemStateIdentity;
 export declare const systemStateIdentity: import("../..").RootFirestoreModelIdentity<"systemState", "sys">;
 /**
  * Used to identify a SystemStateId.
+ *
+ * @semanticType
+ * @semanticTopic identifier
+ * @semanticTopic string
+ * @semanticTopic dereekb-firebase:system-state
  */
 export type SystemStateTypeIdentifier = string;
 /**
@@ -52,8 +59,14 @@ export type SystemStateStoredData = Record<string, any>;
  * or any system-wide state that needs persistence.
  *
  * @template T - shape of the stored data record
+ * @dbxModel
  */
 export interface SystemState<T extends SystemStateStoredData = SystemStateStoredData> {
+    /**
+     * Arbitrary persisted data for this system state singleton.
+     *
+     * @dbxModelVariable data
+     */
     data: T;
 }
 /**

package/test/index.cjs.js

@@ -4882,6 +4882,7 @@ function _async_to_generator$3(fn) {
     };
 }
 function _instanceof(left, right) {
+    "@swc/helpers - instanceof";
     if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
         return !!right[Symbol.hasInstance](left);
     } else {

package/test/index.esm.js

@@ -4880,6 +4880,7 @@ function _async_to_generator$3(fn) {
     };
 }
 function _instanceof(left, right) {
+    "@swc/helpers - instanceof";
     if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
         return !!right[Symbol.hasInstance](left);
     } else {

package/test/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "13.9.0",
+  "version": "13.10.1",
   "peerDependencies": {
-    "@dereekb/date": "13.9.0",
-    "@dereekb/firebase": "13.9.0",
-    "@dereekb/model": "13.9.0",
-    "@dereekb/rxjs": "13.9.0",
-    "@dereekb/util": "13.9.0",
+    "@dereekb/date": "13.10.1",
+    "@dereekb/firebase": "13.10.1",
+    "@dereekb/model": "13.10.1",
+    "@dereekb/rxjs": "13.10.1",
+    "@dereekb/util": "13.10.1",
     "@firebase/rules-unit-testing": "5.0.0",
-    "date-fns": "^4.0.0",
-    "firebase": "^12.12.0",
-    "rxjs": "^7.8.0"
+    "date-fns": "^4.1.0",
+    "firebase": "^12.12.1",
+    "rxjs": "^7.8.2"
   },
   "exports": {
     "./package.json": "./package.json",