@dereekb/firebase 13.11.13 → 13.11.15

package/test/src/lib/common/mock/mock.item.collection.fixture.d.ts

@@ -52,6 +52,9 @@ export interface MockItemCollectionFirebaseContextConfig {
  *
  * Compose with a Firebase test context factory to get a fully wired test environment:
  *
+ * @param _config - Reserved for future setup/teardown configuration; currently unused.
+ * @returns A factory builder that wraps a parent {@link TestFirestoreContextFixture} with a {@link MockItemCollectionFixture} per test.
+ *
  * @example
  * ```ts
  * const f = testWithMockItemCollectionFixture()(authorizedFirebaseFactory);
@@ -59,8 +62,5 @@ export interface MockItemCollectionFirebaseContextConfig {
  *   it('should work', () => { ... });
  * }));
  * ```
- *
- * @param _config - Reserved for future setup/teardown configuration; currently unused.
- * @returns A factory builder that wraps a parent {@link TestFirestoreContextFixture} with a {@link MockItemCollectionFixture} per test.
  */
 export declare function testWithMockItemCollectionFixture(_config?: MockItemCollectionFirebaseContextConfig): TestWrappedContextFactoryBuilder<MockItemCollectionFixture, TestFirestoreContextFixture>;

package/test/src/lib/common/mock/mock.item.d.ts

@@ -83,14 +83,14 @@ export type MockItemFirestoreCollection = FirestoreCollection<MockItem, MockItem
 /**
  * Creates a {@link MockItemFirestoreCollection} bound to the given {@link FirestoreContext}.
  *
+ * @param firestoreContext - The Firestore context (test or production) used to resolve the underlying collection reference.
+ * @returns A {@link MockItemFirestoreCollection} wired with the {@link mockItemConverter} and {@link mockItemIdentity}.
+ *
  * @example
  * ```ts
  * const collection = mockItemFirestoreCollection(firestoreContext);
  * const doc = collection.documentAccessor().newDocument();
  * ```
- *
- * @param firestoreContext - The Firestore context (test or production) used to resolve the underlying collection reference.
- * @returns A {@link MockItemFirestoreCollection} wired with the {@link mockItemConverter} and {@link mockItemIdentity}.
  */
 export declare function mockItemFirestoreCollection(firestoreContext: FirestoreContext): MockItemFirestoreCollection;
 /**
@@ -182,7 +182,7 @@ export declare const mockItemPrivateConverter: import("@dereekb/firebase").Snaps
  * subcollections under a given {@link MockItemDocument} parent.
  *
  * @param context - The Firestore context used to resolve subcollections.
- * @returns A function that, given a parent {@link MockItemDocument}, returns a typed {@link CollectionReference} for that parent's MockItemPrivate subcollection.
+ * @returns Function that, given a parent {@link MockItemDocument}, returns a typed {@link CollectionReference} for that parent's MockItemPrivate subcollection.
  */
 export declare function mockItemPrivateCollectionReferenceFactory(context: FirestoreContext): (parent: MockItemDocument) => CollectionReference<MockItemPrivate>;
 /**
@@ -247,11 +247,11 @@ export type MockItemUserData = FirestoreModelData<MockItemUser, {}>;
 /**
  * Firestore collection path name.
  */
-export declare const mockItemUserCollectionName = "mockItemUser";
+export declare const MOCK_ITEM_USER_COLLECTION_NAME = "mockItemUser";
 /**
  * Default document identifier used for MockItemUser in tests.
  */
-export declare const mockItemUserIdentifier = "0";
+export declare const MOCK_ITEM_USER_IDENTIFIER = "0";
 /**
  * Used to build a FirestoreDataConverter. Fields are configured via configuration. See the SnapshotConverterFunctions for more info.
  */
@@ -267,7 +267,7 @@ export declare const mockItemUserConverter: import("@dereekb/firebase").Snapshot
  * subcollections under a given {@link MockItemDocument} parent.
  *
  * @param context - The Firestore context used to resolve subcollections.
- * @returns A function that, given a parent {@link MockItemDocument}, returns a typed {@link CollectionReference} for that parent's MockItemUser subcollection.
+ * @returns Function that, given a parent {@link MockItemDocument}, returns a typed {@link CollectionReference} for that parent's MockItemUser subcollection.
  */
 export declare function mockItemUserCollectionReferenceFactory(context: FirestoreContext): (parent: MockItemDocument) => CollectionReference<MockItemUser>;
 /**
@@ -347,7 +347,7 @@ export declare const mockItemSubItemConverter: import("@dereekb/firebase").Snaps
  * subcollections under a given {@link MockItemDocument} parent.
  *
  * @param context - The Firestore context used to resolve subcollections.
- * @returns A function that, given a parent {@link MockItemDocument}, returns a typed {@link CollectionReference} for that parent's MockItemSubItem subcollection.
+ * @returns Function that, given a parent {@link MockItemDocument}, returns a typed {@link CollectionReference} for that parent's MockItemSubItem subcollection.
  */
 export declare function mockItemSubItemCollectionReferenceFactory(context: FirestoreContext): (parent: MockItemDocument) => CollectionReference<MockItemSubItem>;
 /**
@@ -423,7 +423,7 @@ export declare const mockItemSubItemDeepConverter: import("@dereekb/firebase").S
  * subcollections under a given {@link MockItemSubItemDocument} parent.
  *
  * @param context - The Firestore context used to resolve subcollections.
- * @returns A function that, given a parent {@link MockItemSubItemDocument}, returns a typed {@link CollectionReference} for that parent's MockItemSubItemDeep subcollection.
+ * @returns Function that, given a parent {@link MockItemSubItemDocument}, returns a typed {@link CollectionReference} for that parent's MockItemSubItemDeep subcollection.
  */
 export declare function mockItemSubItemDeepCollectionReferenceFactory(context: FirestoreContext): (parent: MockItemSubItemDocument) => CollectionReference<MockItemSubItemDeep>;
 /**
@@ -504,17 +504,17 @@ export declare class MockItemPagedDocument extends AbstractFirestoreDocumentWith
  * The mock entry shape is already Firestore-safe, so the converter is an identity
  * pass-through. Production usage may wrap a real converter (e.g. for date fields).
  */
-export declare const mockItemPagedEntryConverter: PagedItemConverter<MockItemPagedEntry>;
+export declare const MOCK_ITEM_PAGED_ENTRY_CONVERTER: PagedItemConverter<MockItemPagedEntry>;
 /**
  * Static distribution scheme for {@link MockItemPagedEntry} that buckets items by their
  * {@link MockItemPagedEntry.group} field across three page IDs (`a`, `b`, `c`).
  */
-export declare const mockItemPagedAlphaDistributionScheme: PagedItemDistributionScheme<MockItemPagedEntry>;
+export declare const MOCK_ITEM_PAGED_ALPHA_DISTRIBUTION_SCHEME: PagedItemDistributionScheme<MockItemPagedEntry>;
 /**
  * Default `maxItemsPerPage` used by the dynamic mock paged collection factory. Kept small to
  * exercise multi-page boundary conditions in tests without writing many entries.
  */
-export declare const MOCK_ITEM_PAGED_DEFAULT_MAX_ITEMS_PER_PAGE = 3;
+export declare const DEFAULT_MOCK_ITEM_PAGED_MAX_ITEMS_PER_PAGE = 3;
 /**
  * Typed {@link PagedItemFirestoreCollection} for {@link MockItemPagedEntry} items under a
  * {@link MockItem} parent.
@@ -536,7 +536,7 @@ export interface MockItemPagedFirestoreCollectionConfig {
     readonly distributionScheme?: PagedItemDistributionScheme<MockItemPagedEntry>;
     /**
      * Maximum items per page document in dynamic mode. Defaults to
-     * {@link MOCK_ITEM_PAGED_DEFAULT_MAX_ITEMS_PER_PAGE}.
+     * {@link DEFAULT_MOCK_ITEM_PAGED_MAX_ITEMS_PER_PAGE}.
      */
     readonly maxItemsPerPage?: number;
 }
@@ -547,7 +547,7 @@ export interface MockItemPagedFirestoreCollectionConfig {
  * @param firestoreContext - The Firestore context used to resolve the underlying subcollection.
  * @param config - Optional config selecting between dynamic (default) and static distribution.
  * @returns A factory that, given a parent {@link MockItemDocument}, returns a paged subcollection
- * wired with {@link mockItemPagedEntryConverter}.
+ * wired with {@link MOCK_ITEM_PAGED_ENTRY_CONVERTER}.
  */
 export declare function mockItemPagedFirestoreCollection(firestoreContext: FirestoreContext, config?: MockItemPagedFirestoreCollectionConfig): MockItemPagedFirestoreCollectionFactory;
 /**
@@ -579,7 +579,7 @@ export declare function mockItemPagedFirestoreCollectionGroup(firestoreContext:
 /**
  * System state type identifier for mock system state data.
  *
- * Used as the key in {@link mockItemSystemStateStoredDataConverterMap}.
+ * Used as the key in {@link MOCK_ITEM_SYSTEM_STATE_STORED_DATA_CONVERTER_MAP}.
  */
 export declare const MOCK_SYSTEM_STATE_TYPE = "mockitemsystemstate";
 /**
@@ -604,4 +604,4 @@ export declare const mockItemSystemDataConverter: SystemStateStoredDataFieldConv
  * Used when creating the mock system state Firestore collection to register
  * the {@link MockSystemData} converter under the {@link MOCK_SYSTEM_STATE_TYPE} key.
  */
-export declare const mockItemSystemStateStoredDataConverterMap: SystemStateStoredDataConverterMap;
+export declare const MOCK_ITEM_SYSTEM_STATE_STORED_DATA_CONVERTER_MAP: SystemStateStoredDataConverterMap;

package/test/src/lib/common/mock/mock.item.query.d.ts

@@ -3,14 +3,14 @@ import { type FirestoreQueryConstraint, type DocumentReference } from '@dereekb/
 /**
  * Creates a Firestore query constraint that filters {@link MockItem} documents by their `value` field.
  *
+ * @param value - The exact `value` to match.
+ * @returns A `where('value', '==', value)` constraint typed for {@link MockItem}.
+ *
  * @example
  * ```ts
  * const constraint = mockItemWithValue('hello');
  * const results = await collection.query(constraint);
  * ```
- *
- * @param value - The exact `value` to match.
- * @returns A `where('value', '==', value)` constraint typed for {@link MockItem}.
  */
 export declare function mockItemWithValue(value: string): FirestoreQueryConstraint;
 /**
@@ -35,6 +35,6 @@ export declare function mockItemWithTestValue(test: boolean): FirestoreQueryCons
  * https://medium.com/firebase-developers/how-to-query-collections-in-firestore-under-a-certain-path-6a0d686cebd2
  *
  * @param mockItem - The parent {@link MockItem} document reference whose descendant documents the constraint should bound to.
- * @returns An array of constraints (suitable for use on a collection group query) that restricts results to documents under the given parent path.
+ * @returns The constraints (suitable for use on a collection group query) that restricts results to documents under the given parent path.
  */
 export declare function allChildMockItemSubItemDeepsWithinMockItem(mockItem: DocumentReference<MockItem>): FirestoreQueryConstraint[];

package/test/src/lib/common/mock/mock.item.storage.fixture.d.ts

@@ -34,6 +34,9 @@ export interface MockItemStorageFirebaseStorageContextConfig {
  *
  * Compose with a Firebase test context factory to get a fully wired storage test environment:
  *
+ * @param _config - Reserved for future setup/teardown configuration; currently unused.
+ * @returns A factory builder that wraps a parent {@link TestFirebaseStorageContextFixture} with a {@link MockItemStorageFixture} per test.
+ *
  * @example
  * ```ts
  * const f = testWithMockItemStorageFixture()(authorizedFirebaseFactory);
@@ -41,8 +44,5 @@ export interface MockItemStorageFirebaseStorageContextConfig {
  *   it('should upload', () => { ... });
  * }));
  * ```
- *
- * @param _config - Reserved for future setup/teardown configuration; currently unused.
- * @returns A factory builder that wraps a parent {@link TestFirebaseStorageContextFixture} with a {@link MockItemStorageFixture} per test.
  */
 export declare function testWithMockItemStorageFixture(_config?: MockItemStorageFirebaseStorageContextConfig): TestWrappedContextFactoryBuilder<MockItemStorageFixture, TestFirebaseStorageContextFixture>;

package/test/src/lib/common/storage/storage.d.ts

@@ -10,7 +10,7 @@ export interface MakeTestingFirebaseStorageAccessorDriverConfig {
      * original driver's default bucket is preserved. When omitted, a test bucket is
      * generated only if the base driver does not already define a default bucket.
      */
-    useTestDefaultBucket?: boolean;
+    readonly useTestDefaultBucket?: boolean;
 }
 /**
  * Creates a {@link TestingFirebaseStorageAccessorDriver} that wraps the given driver,