@dereekb/firebase 13.10.1 → 13.10.3

package/index.cjs.js

@@ -7835,10 +7835,10 @@ var FIRESTORE_DUMMY_MODEL_KEY = 'dummymodel/dummykey';
 /**
  * Creates a root-level Firestore collection focused on a single document.
  *
- * This factory function creates a specialized collection that combines standard collection
- * functionality with convenient accessors for working with a single document. It's particularly
- * useful for application settings, configuration, or any singleton-like data structures
- * that are stored in Firestore.
+ * Backing factory for the `'root-singleton'` collection kind. Combines
+ * standard collection functionality with convenient accessors for working
+ * with a single document. Useful for application settings, configuration,
+ * or any singleton-like data structures that are stored in Firestore.
  *
  * @template T - The data type of the document
  * @template D - The FirestoreDocument type, defaults to FirestoreDocument<T>

package/index.esm.js

@@ -7833,10 +7833,10 @@ var FIRESTORE_DUMMY_MODEL_KEY = 'dummymodel/dummykey';
 /**
  * Creates a root-level Firestore collection focused on a single document.
  *
- * This factory function creates a specialized collection that combines standard collection
- * functionality with convenient accessors for working with a single document. It's particularly
- * useful for application settings, configuration, or any singleton-like data structures
- * that are stored in Firestore.
+ * Backing factory for the `'root-singleton'` collection kind. Combines
+ * standard collection functionality with convenient accessors for working
+ * with a single document. Useful for application settings, configuration,
+ * or any singleton-like data structures that are stored in Firestore.
  *
  * @template T - The data type of the document
  * @template D - The FirestoreDocument type, defaults to FirestoreDocument<T>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "13.10.1",
+  "version": "13.10.3",
   "exports": {
     "./test": {
       "module": "./test/index.esm.js",
@@ -17,10 +17,10 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/util": "13.10.1",
-    "@dereekb/date": "13.10.1",
-    "@dereekb/model": "13.10.1",
-    "@dereekb/rxjs": "13.10.1",
+    "@dereekb/util": "13.10.3",
+    "@dereekb/date": "13.10.3",
+    "@dereekb/model": "13.10.3",
+    "@dereekb/rxjs": "13.10.3",
     "@firebase/rules-unit-testing": "5.0.0",
     "arktype": "^2.2.0",
     "date-fns": "^4.1.0",

package/src/lib/common/firestore/collection/collection.d.ts

@@ -596,6 +596,16 @@ export interface FirestoreCollectionConfig<T, D extends FirestoreDocument<T> = F
 /**
  * Full Firestore collection interface with document CRUD, querying, iteration, and context support.
  *
+ * Backs the `'root'` collection kind: a standard Firestore root collection.
+ * Created at runtime via `firestoreContext.firestoreCollection({...})` and
+ * typed at the model layer as
+ * `<Model>FirestoreCollection = FirestoreCollection<T, D>`.
+ *
+ * For other collection kinds, see:
+ * - `'root-singleton'` ({@link RootSingleItemFirestoreCollection} in `./collection.single`) — single doc in a root collection.
+ * - `'sub-collection'` ({@link FirestoreCollectionWithParent} in `./subcollection`) — multi-item subcollection under a parent.
+ * - `'singleton-sub'` ({@link SingleItemFirestoreCollection} in `./subcollection.single`) — one document per parent.
+ *
  * This is the primary interface used to interact with a Firestore collection. It provides:
  * - **Document access**: Create, load, and manage documents via {@link FirestoreDocumentAccessor}
  * - **Querying**: Build typed queries via the query factory

package/src/lib/common/firestore/collection/collection.single.d.ts

@@ -3,9 +3,11 @@ import { type FirestoreCollection, type FirestoreCollectionConfig } from './coll
 /**
  * Configuration for creating a root-level collection that focuses on a single document.
  *
- * This configuration extends the standard FirestoreCollectionConfig with optional
- * settings for specifying a single document identifier. This is used when you need
- * to work with a specific document in a collection, such as configuration or settings.
+ * Backs the `'root-singleton'` collection kind. This configuration extends
+ * the standard FirestoreCollectionConfig with optional settings for
+ * specifying a single document identifier — used when you need to work with
+ * a specific document in a root collection, such as application
+ * configuration or per-deploy settings.
  *
  * @template T - The data type of the document
  * @template D - The FirestoreDocument type, defaults to FirestoreDocument<T>
@@ -15,6 +17,15 @@ export interface RootSingleItemFirestoreCollectionConfig<T, D extends FirestoreD
 /**
  * A Firestore collection that provides specialized accessors for working with a single document.
  *
+ * Backs the `'root-singleton'` collection kind: a single document in a root
+ * collection, identified up-front by a fixed `singleItemIdentifier`. Created
+ * at runtime via `firestoreContext.rootSingleItemFirestoreCollection({...})`
+ * and typed at the model layer as
+ * `<Model>FirestoreCollection = RootSingleItemFirestoreCollection<T, D>`.
+ *
+ * For the parent-bound counterpart (one document per parent), see
+ * {@link SingleItemFirestoreCollection} (kind `'singleton-sub'`).
+ *
  * This interface combines the capabilities of a standard FirestoreCollection with
  * FirestoreSingleDocumentAccessor, providing convenient methods for working directly
  * with a single document without needing to specify its ID in each call.
@@ -27,10 +38,10 @@ export interface RootSingleItemFirestoreCollection<T, D extends FirestoreDocumen
 /**
  * Creates a root-level Firestore collection focused on a single document.
  *
- * This factory function creates a specialized collection that combines standard collection
- * functionality with convenient accessors for working with a single document. It's particularly
- * useful for application settings, configuration, or any singleton-like data structures
- * that are stored in Firestore.
+ * Backing factory for the `'root-singleton'` collection kind. Combines
+ * standard collection functionality with convenient accessors for working
+ * with a single document. Useful for application settings, configuration,
+ * or any singleton-like data structures that are stored in Firestore.
  *
  * @template T - The data type of the document
  * @template D - The FirestoreDocument type, defaults to FirestoreDocument<T>

package/src/lib/common/firestore/collection/subcollection.d.ts

@@ -5,6 +5,10 @@
  * within a specific document rather than at the root level. Subcollections enable hierarchical
  * data modeling in Firestore by allowing documents to contain their own collections.
  *
+ * Collection kind: `'sub-collection'` (multi-item subcollection under a parent).
+ * For the one-document-per-parent variant, see `'singleton-sub'`
+ * ({@link SingleItemFirestoreCollection} in `./subcollection.single`).
+ *
  * Key features of subcollections:
  * - They provide a natural way to model hierarchical relationships
  * - They establish clear ownership boundaries (parent document owns child documents)
@@ -42,6 +46,13 @@ export interface FirestoreCollectionWithParentConfig<T, PT, D extends FirestoreD
 /**
  * A FirestoreCollection that represents a subcollection with a reference to its parent document.
  *
+ * Backs the `'sub-collection'` collection kind: a multi-item subcollection
+ * under a parent. Created at runtime via `firestoreContext.firestoreCollectionWithParent({...})`
+ * and typed at the model layer as `<Model>FirestoreCollection = FirestoreCollectionWithParent<T, PT, D, PD>`.
+ *
+ * For one-document-per-parent subcollections, use {@link SingleItemFirestoreCollection}
+ * (kind `'singleton-sub'`) instead.
+ *
  * This interface extends FirestoreCollection to maintain the parent-child relationship
  * between documents. It allows access to documents within the context of their parent,
  * enabling proper path construction and maintaining the document hierarchy.

package/src/lib/common/firestore/collection/subcollection.single.d.ts

@@ -18,6 +18,13 @@ export interface SingleItemFirestoreCollectionConfig<T, PT, D extends FirestoreD
  * A subcollection that provides specialized accessors for working with a single document
  * within a parent document context.
  *
+ * Backs the `'singleton-sub'` collection kind: one document per parent.
+ * Created at runtime via `firestoreContext.singleItemFirestoreCollection({...})`
+ * and typed at the model layer as `<Model>FirestoreCollection = SingleItemFirestoreCollection<T, PT, D, PD>`.
+ *
+ * For multi-item subcollections under the same parent, use
+ * {@link FirestoreCollectionWithParent} (kind `'sub-collection'`) instead.
+ *
  * This interface combines the capabilities of FirestoreCollectionWithParent (which maintains
  * the parent-child relationship) with FirestoreSingleDocumentAccessor (which provides
  * convenient methods for working with a specific document). This allows for direct access