@pyric/cli 0.1.0-alpha.15 → 0.1.0-alpha.17

package/dist/serve/site-ui/docs/pyric-firestore-reference-api.md

@@ -2,6 +2,131 @@
 
 ## Classes
 
+<a id="abstractuserdatawriter"></a>
+
+### AbstractUserDataWriter
+
+#### Constructors
+
+<a id="constructor"></a>
+
+##### Constructor
+
+```ts
+new AbstractUserDataWriter(): AbstractUserDataWriter;
+```
+
+###### Returns
+
+[`AbstractUserDataWriter`](#abstractuserdatawriter)
+
+***
+
+<a id="aggregatefield"></a>
+
+### AggregateField
+
+#### Constructors
+
+<a id="constructor-1"></a>
+
+##### Constructor
+
+```ts
+new AggregateField(): AggregateField;
+```
+
+###### Returns
+
+[`AggregateField`](#aggregatefield)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="field"></a> `field?` | `readonly` | `string` |
+| <a id="kind"></a> `kind` | `readonly` | [`AggregateFieldType`](#aggregatefieldtype) |
+
+#### Methods
+
+<a id="hasinstance"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+***
+
+<a id="aggregatequerysnapshot"></a>
+
+### AggregateQuerySnapshot
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| :------ | :------ |
+| `T` *extends* `Record`\<`string`, `number` \| `null`\> | `Record`\<`string`, `number` \| `null`\> |
+
+#### Constructors
+
+<a id="constructor-2"></a>
+
+##### Constructor
+
+```ts
+new AggregateQuerySnapshot<T>(): AggregateQuerySnapshot<T>;
+```
+
+###### Returns
+
+[`AggregateQuerySnapshot`](#aggregatequerysnapshot)\<`T`\>
+
+#### Methods
+
+<a id="data"></a>
+
+##### data()
+
+```ts
+data(): T;
+```
+
+###### Returns
+
+`T`
+
+<a id="hasinstance-2"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+***
+
 <a id="bytes"></a>
 
 ### Bytes
@@ -130,45 +255,52 @@ static fromUint8Array(array: Uint8Array): Bytes;
 
 ***
 
-<a id="fieldpath"></a>
+<a id="collectionreference"></a>
 
-### FieldPath
+### CollectionReference
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| :------ | :------ |
+| `_T` | [`DocumentData`](#documentdata) |
 
 #### Constructors
 
-<a id="constructor"></a>
+<a id="constructor-3"></a>
 
 ##### Constructor
 
 ```ts
-new FieldPath(...fieldNames: string[]): FieldPath;
+new CollectionReference<_T>(): CollectionReference<_T>;
 ```
 
-###### Parameters
+###### Returns
 
-| Parameter | Type |
-| :------ | :------ |
-| ...`fieldNames` | `string`[] |
+[`CollectionReference`](#collectionreference)\<`_T`\>
 
-###### Returns
+#### Properties
 
-[`FieldPath`](#fieldpath)
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="id"></a> `id` | `readonly` | `string` |
+| <a id="path"></a> `path` | `readonly` | `string` |
 
 #### Methods
 
-<a id="isequal-2"></a>
+<a id="hasinstance-4"></a>
 
-##### isEqual()
+##### \[hasInstance\]()
 
 ```ts
-isEqual(other: FieldPath): boolean;
+static hasInstance: boolean;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `other` | [`FieldPath`](#fieldpath) |
+| `instance` | `unknown` |
 
 ###### Returns
 
@@ -176,306 +308,351 @@ isEqual(other: FieldPath): boolean;
 
 ***
 
-<a id="fieldvalue"></a>
+<a id="documentreference"></a>
 
-### FieldValue
+### DocumentReference
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| :------ | :------ |
+| `_T` | [`DocumentData`](#documentdata) |
 
 #### Constructors
 
-<a id="constructor-1"></a>
+<a id="constructor-4"></a>
 
 ##### Constructor
 
 ```ts
-new FieldValue(): FieldValue;
+new DocumentReference<_T>(): DocumentReference<_T>;
 ```
 
 ###### Returns
 
-[`FieldValue`](#fieldvalue)
+[`DocumentReference`](#documentreference)\<`_T`\>
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="id-1"></a> `id` | `readonly` | `string` |
+| <a id="path-1"></a> `path` | `readonly` | `string` |
 
 #### Methods
 
-<a id="arrayremove"></a>
+<a id="hasinstance-6"></a>
 
-##### arrayRemove()
+##### \[hasInstance\]()
 
 ```ts
-static arrayRemove(...values: unknown[]): FieldValueSentinel;
+static hasInstance: boolean;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| ...`values` | `unknown`[] |
+| `instance` | `unknown` |
 
 ###### Returns
 
-[`FieldValueSentinel`](#fieldvaluesentinel)
+`boolean`
 
-<a id="arrayunion"></a>
+***
 
-##### arrayUnion()
+<a id="documentsnapshot"></a>
 
-```ts
-static arrayUnion(...values: unknown[]): FieldValueSentinel;
-```
+### DocumentSnapshot
 
-###### Parameters
+#### Extended by
 
-| Parameter | Type |
-| :------ | :------ |
-| ...`values` | `unknown`[] |
+- [`QueryDocumentSnapshot`](#querydocumentsnapshot)
 
-###### Returns
+#### Type Parameters
 
-[`FieldValueSentinel`](#fieldvaluesentinel)
+| Type Parameter | Default type |
+| :------ | :------ |
+| `T` | [`DocumentData`](#documentdata) |
 
-<a id="delete"></a>
+#### Constructors
 
-##### delete()
+<a id="constructor-5"></a>
+
+##### Constructor
 
 ```ts
-static delete(): FieldValueSentinel;
+new DocumentSnapshot<T>(): DocumentSnapshot<T>;
 ```
 
 ###### Returns
 
-[`FieldValueSentinel`](#fieldvaluesentinel)
+[`DocumentSnapshot`](#documentsnapshot)\<`T`\>
 
-<a id="increment"></a>
+#### Properties
 
-##### increment()
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="exists"></a> `exists` | `readonly` | `boolean` \| () => `boolean` |
+| <a id="id-2"></a> `id` | `readonly` | `string` |
+| <a id="metadata"></a> `metadata` | `readonly` | [`SnapshotMetadata`](#snapshotmetadata) |
+| <a id="ref"></a> `ref` | `readonly` | [`DocumentReference`](#documentreference)\<`T`\> |
 
-```ts
-static increment(n: number): FieldValueSentinel;
-```
+#### Methods
 
-###### Parameters
+<a id="data-2"></a>
 
-| Parameter | Type |
-| :------ | :------ |
-| `n` | `number` |
+##### data()
+
+```ts
+data(): T;
+```
 
 ###### Returns
 
-[`FieldValueSentinel`](#fieldvaluesentinel)
+`T`
 
-<a id="servertimestamp"></a>
+<a id="hasinstance-8"></a>
 
-##### serverTimestamp()
+##### \[hasInstance\]()
 
 ```ts
-static serverTimestamp(): FieldValueSentinel;
+static hasInstance: boolean;
 ```
 
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
 ###### Returns
 
-[`FieldValueSentinel`](#fieldvaluesentinel)
+`boolean`
 
 ***
 
-<a id="geopoint"></a>
+<a id="fieldpath"></a>
 
-### GeoPoint
+### FieldPath
 
 #### Constructors
 
-<a id="constructor-2"></a>
+<a id="constructor-6"></a>
 
 ##### Constructor
 
 ```ts
-new GeoPoint(lat: number, lng: number): GeoPoint;
+new FieldPath(...fieldNames: string[]): FieldPath;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `lat` | `number` |
-| `lng` | `number` |
+| ...`fieldNames` | `string`[] |
 
 ###### Returns
 
-[`GeoPoint`](#geopoint)
-
-#### Accessors
+[`FieldPath`](#fieldpath)
 
-<a id="latitude"></a>
+#### Methods
 
-##### latitude
+<a id="isequal-2"></a>
 
-###### Get Signature
+##### isEqual()
 
 ```ts
-get latitude(): number;
+isEqual(other: FieldPath): boolean;
 ```
 
-###### Returns
+###### Parameters
 
-`number`
+| Parameter | Type |
+| :------ | :------ |
+| `other` | [`FieldPath`](#fieldpath) |
 
-<a id="longitude"></a>
+###### Returns
 
-##### longitude
+`boolean`
 
-###### Get Signature
+***
+
+<a id="fieldvalue"></a>
+
+### FieldValue
+
+#### Constructors
+
+<a id="constructor-7"></a>
+
+##### Constructor
 
 ```ts
-get longitude(): number;
+new FieldValue(): FieldValue;
 ```
 
 ###### Returns
 
-`number`
+[`FieldValue`](#fieldvalue)
 
 #### Methods
 
-<a id="isequal-4"></a>
+<a id="arrayremove"></a>
 
-##### isEqual()
+##### arrayRemove()
 
 ```ts
-isEqual(other: GeoPoint): boolean;
+static arrayRemove(...values: unknown[]): FieldValueSentinel;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `other` | [`GeoPoint`](#geopoint) |
+| ...`values` | `unknown`[] |
 
 ###### Returns
 
-`boolean`
+[`FieldValueSentinel`](#fieldvaluesentinel)
 
-<a id="tojson-2"></a>
+<a id="arrayunion"></a>
 
-##### toJSON()
+##### arrayUnion()
 
 ```ts
-toJSON(): {
-  latitude: number;
-  longitude: number;
-  type: string;
-};
+static arrayUnion(...values: unknown[]): FieldValueSentinel;
 ```
 
-###### Returns
+###### Parameters
 
-```ts
-{
-  latitude: number;
-  longitude: number;
-  type: string;
-}
-```
+| Parameter | Type |
+| :------ | :------ |
+| ...`values` | `unknown`[] |
 
-###### latitude
+###### Returns
 
-```ts
-latitude: number;
-```
+[`FieldValueSentinel`](#fieldvaluesentinel)
 
-###### longitude
+<a id="delete"></a>
+
+##### delete()
 
 ```ts
-longitude: number;
+static delete(): FieldValueSentinel;
 ```
 
-###### type
+###### Returns
 
-```ts
-type: string;
-```
+[`FieldValueSentinel`](#fieldvaluesentinel)
 
-<a id="fromjson-2"></a>
+<a id="increment"></a>
 
-##### fromJSON()
+##### increment()
 
 ```ts
-static fromJSON(json: object): GeoPoint;
+static increment(n: number): FieldValueSentinel;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `json` | `object` |
+| `n` | `number` |
 
 ###### Returns
 
-[`GeoPoint`](#geopoint)
+[`FieldValueSentinel`](#fieldvaluesentinel)
 
-***
+<a id="servertimestamp"></a>
 
-<a id="sandboxerror"></a>
+##### serverTimestamp()
 
-### SandboxError
+```ts
+static serverTimestamp(): FieldValueSentinel;
+```
 
-Sandbox-layer error. Catch with `instanceof SandboxError` and switch
-on `code`. `denialContext` is populated for `permission-denied` only
-(and only after Slice 4 wires it through).
+###### Returns
 
-Two construction forms are supported:
-  - Positional: `new SandboxError(code, message, denialContext?)` —
-    the original signature, kept for backward compatibility with
-    existing internal call sites.
-  - Options bag: `new SandboxError({ code, message, remediation? })` —
-    used when attaching remediation guidance.
+[`FieldValueSentinel`](#fieldvaluesentinel)
 
-#### Extends
+***
 
-- `Error`
+<a id="firestore"></a>
+
+### Firestore
 
 #### Constructors
 
-<a id="constructor-3"></a>
+<a id="constructor-8"></a>
 
 ##### Constructor
 
 ```ts
-new SandboxError(
-   code: SandboxErrorCode,
-   message: string,
-   denialContext?: DenialContext): SandboxError;
+new Firestore(): Firestore;
+```
+
+###### Returns
+
+[`Firestore`](#firestore)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="target_symbol"></a> `[TARGET_SYMBOL]` | `readonly` | `Target` |
+| <a id="app"></a> `app?` | `readonly` | [`FirebaseApp`](pyric-app-reference-api.md#firebaseapp) |
+
+#### Methods
+
+<a id="hasinstance-10"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `code` | [`SandboxErrorCode`](pyric-sandbox-reference-api.md#sandboxerrorcode) |
-| `message` | `string` |
-| `denialContext?` | [`DenialContext`](pyric-sandbox-reference-api.md#denialcontext) |
+| `instance` | `unknown` |
 
 ###### Returns
 
-[`SandboxError`](#sandboxerror)
+`boolean`
 
-###### Overrides
+***
 
-```ts
-Error.constructor
-```
+<a id="firestoreerror"></a>
+
+### FirestoreError
+
+#### Extends
+
+- `Error`
+
+#### Constructors
+
+<a id="constructor-9"></a>
 
 ##### Constructor
 
 ```ts
-new SandboxError(options: SandboxErrorOptions): SandboxError;
+new FirestoreError(code: string, message: string): FirestoreError;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `options` | `SandboxErrorOptions` |
+| `code` | `string` |
+| `message` | `string` |
 
 ###### Returns
 
-[`SandboxError`](#sandboxerror)
+[`FirestoreError`](#firestoreerror)
 
 ###### Overrides
 
@@ -487,112 +664,117 @@ Error.constructor
 
 | Property | Modifier | Type |
 | :------ | :------ | :------ |
-| <a id="code"></a> `code` | `readonly` | [`SandboxErrorCode`](pyric-sandbox-reference-api.md#sandboxerrorcode) |
-| <a id="denialcontext"></a> `denialContext?` | `readonly` | [`DenialContext`](pyric-sandbox-reference-api.md#denialcontext) |
-| <a id="remediation"></a> `remediation?` | `readonly` | `string` |
+| <a id="code"></a> `code` | `readonly` | `string` |
 
 ***
 
-<a id="timestamp"></a>
+<a id="geopoint"></a>
 
-### Timestamp
+### GeoPoint
 
 #### Constructors
 
-<a id="constructor-4"></a>
+<a id="constructor-10"></a>
 
 ##### Constructor
 
 ```ts
-new Timestamp(seconds: number, nanoseconds: number): Timestamp;
+new GeoPoint(lat: number, lng: number): GeoPoint;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `seconds` | `number` |
-| `nanoseconds` | `number` |
+| `lat` | `number` |
+| `lng` | `number` |
 
 ###### Returns
 
-[`Timestamp`](#timestamp)
-
-#### Properties
+[`GeoPoint`](#geopoint)
 
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="nanoseconds"></a> `nanoseconds` | `readonly` | `number` |
-| <a id="seconds"></a> `seconds` | `readonly` | `number` |
+#### Accessors
 
-#### Methods
+<a id="latitude"></a>
 
-<a id="isequal-6"></a>
+##### latitude
 
-##### isEqual()
+###### Get Signature
 
 ```ts
-isEqual(other: Timestamp): boolean;
+get latitude(): number;
 ```
 
-FS-B12 — value equality, mirroring `fb.Timestamp.isEqual`.
+###### Returns
 
-###### Parameters
+`number`
 
-| Parameter | Type |
-| :------ | :------ |
-| `other` | [`Timestamp`](#timestamp) |
+<a id="longitude"></a>
+
+##### longitude
+
+###### Get Signature
+
+```ts
+get longitude(): number;
+```
 
 ###### Returns
 
-`boolean`
+`number`
 
-<a id="todate"></a>
+#### Methods
 
-##### toDate()
+<a id="isequal-4"></a>
+
+##### isEqual()
 
 ```ts
-toDate(): Date;
+isEqual(other: GeoPoint): boolean;
 ```
 
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `other` | [`GeoPoint`](#geopoint) |
+
 ###### Returns
 
-`Date`
+`boolean`
 
-<a id="tojson-4"></a>
+<a id="tojson-2"></a>
 
 ##### toJSON()
 
 ```ts
 toJSON(): {
-  nanoseconds: number;
-  seconds: number;
+  latitude: number;
+  longitude: number;
   type: string;
 };
 ```
 
-FS-B12 — JSON form, mirroring `fb.Timestamp.toJSON`.
-
 ###### Returns
 
 ```ts
 {
-  nanoseconds: number;
-  seconds: number;
+  latitude: number;
+  longitude: number;
   type: string;
 }
 ```
 
-###### nanoseconds
+###### latitude
 
 ```ts
-nanoseconds: number;
+latitude: number;
 ```
 
-###### seconds
+###### longitude
 
 ```ts
-seconds: number;
+longitude: number;
 ```
 
 ###### type
@@ -601,378 +783,1919 @@ seconds: number;
 type: string;
 ```
 
-<a id="tomillis"></a>
+<a id="fromjson-2"></a>
 
-##### toMillis()
+##### fromJSON()
 
 ```ts
-toMillis(): number;
+static fromJSON(json: object): GeoPoint;
 ```
 
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `json` | `object` |
+
 ###### Returns
 
-`number`
+[`GeoPoint`](#geopoint)
 
-<a id="tostring-2"></a>
+***
 
-##### toString()
+<a id="loadbundletask"></a>
 
-```ts
-toString(): string;
-```
+### LoadBundleTask
 
-FS-B12 — textual form, mirroring `fb.Timestamp.toString`.
+#### Implements
 
-###### Returns
+- `PromiseLike`\<[`LoadBundleTaskProgress`](#loadbundletaskprogress)\>
 
-`string`
+#### Constructors
 
-<a id="valueof"></a>
+<a id="constructor-11"></a>
 
-##### valueOf()
+##### Constructor
 
 ```ts
-valueOf(): string;
+new LoadBundleTask(promise: Promise<LoadBundleTaskProgress>): LoadBundleTask;
 ```
 
-FS-B12 — primitive coercion for `<`/`<=`/`>=`/`>` comparisons, mirroring
-`fb.Timestamp.valueOf`: a zero-padded `<seconds>.<nanoseconds>` string
-(seconds offset by MIN_SECONDS so it stays non-negative and lexically
-ordered).
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `promise` | `Promise`\<[`LoadBundleTaskProgress`](#loadbundletaskprogress)\> |
 
 ###### Returns
 
-`string`
+[`LoadBundleTask`](#loadbundletask)
 
-<a id="fromdate"></a>
+#### Methods
 
-##### fromDate()
+<a id="catch"></a>
+
+##### catch()
 
 ```ts
-static fromDate(d: Date): Timestamp;
+catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult>): Promise<LoadBundleTaskProgress | TResult>;
 ```
 
+###### Type Parameters
+
+| Type Parameter | Default type |
+| :------ | :------ |
+| `TResult` | `never` |
+
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `d` | `Date` |
+| `onrejected?` | (`reason`: `any`) => `TResult` \| `PromiseLike`\<`TResult`\> |
 
 ###### Returns
 
-[`Timestamp`](#timestamp)
+`Promise`\<[`LoadBundleTaskProgress`](#loadbundletaskprogress) \| `TResult`\>
 
-<a id="frommillis"></a>
+<a id="onprogress"></a>
 
-##### fromMillis()
+##### onProgress()
 
 ```ts
-static fromMillis(ms: number): Timestamp;
+onProgress(
+   _next?: (progress: LoadBundleTaskProgress) => void,
+   _error?: (err: Error) => void,
+   _complete?: () => void): void;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `ms` | `number` |
+| `_next?` | (`progress`: [`LoadBundleTaskProgress`](#loadbundletaskprogress)) => `void` |
+| `_error?` | (`err`: `Error`) => `void` |
+| `_complete?` | () => `void` |
 
 ###### Returns
 
-[`Timestamp`](#timestamp)
+`void`
 
-<a id="now"></a>
+<a id="then"></a>
 
-##### now()
+##### then()
 
 ```ts
-static now(): Timestamp;
+then<TResult1, TResult2>(onfulfilled?: (value: LoadBundleTaskProgress) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>;
 ```
 
+Attaches callbacks for the resolution and/or rejection of the Promise.
+
+###### Type Parameters
+
+| Type Parameter | Default type |
+| :------ | :------ |
+| `TResult1` | [`LoadBundleTaskProgress`](#loadbundletaskprogress) |
+| `TResult2` | `never` |
+
+###### Parameters
+
+| Parameter | Type | Description |
+| :------ | :------ | :------ |
+| `onfulfilled?` | (`value`: [`LoadBundleTaskProgress`](#loadbundletaskprogress)) => `TResult1` \| `PromiseLike`\<`TResult1`\> | The callback to execute when the Promise is resolved. |
+| `onrejected?` | (`reason`: `any`) => `TResult2` \| `PromiseLike`\<`TResult2`\> | The callback to execute when the Promise is rejected. |
+
 ###### Returns
 
-[`Timestamp`](#timestamp)
+`Promise`\<`TResult1` \| `TResult2`\>
+
+A Promise for the completion of which ever callback is executed.
+
+###### Implementation of
+
+```ts
+PromiseLike.then
+```
 
 ***
 
-<a id="vectorvalue"></a>
+<a id="persistentcacheindexmanager"></a>
 
-### VectorValue
+### PersistentCacheIndexManager
 
-#### Methods
+#### Constructors
 
-<a id="isequal-8"></a>
+<a id="constructor-12"></a>
 
-##### isEqual()
+##### Constructor
 
 ```ts
-isEqual(other: VectorValue): boolean;
+new PersistentCacheIndexManager(_db: Firestore): PersistentCacheIndexManager;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `other` | [`VectorValue`](#vectorvalue) |
+| `_db` | [`Firestore`](#firestore) |
 
 ###### Returns
 
-`boolean`
+[`PersistentCacheIndexManager`](#persistentcacheindexmanager)
 
-<a id="toarray"></a>
+#### Methods
 
-##### toArray()
+<a id="deleteallindexes"></a>
+
+##### deleteAllIndexes()
 
 ```ts
-toArray(): number[];
+deleteAllIndexes(): Promise<void>;
 ```
 
 ###### Returns
 
-`number`[]
+`Promise`\<`void`\>
 
-<a id="tojson-6"></a>
+<a id="disableindexautocreation"></a>
 
-##### toJSON()
+##### disableIndexAutoCreation()
 
 ```ts
-toJSON(): object;
+disableIndexAutoCreation(): Promise<void>;
 ```
 
 ###### Returns
 
-`object`
+`Promise`\<`void`\>
 
-<a id="create"></a>
+<a id="enableindexautocreation"></a>
 
-##### create()
+##### enableIndexAutoCreation()
 
 ```ts
-static create(values: number[]): VectorValue;
+enableIndexAutoCreation(): Promise<void>;
 ```
 
-###### Parameters
+###### Returns
 
-| Parameter | Type |
+`Promise`\<`void`\>
+
+***
+
+<a id="query"></a>
+
+### Query
+
+#### Type Parameters
+
+| Type Parameter | Default type |
 | :------ | :------ |
-| `values` | `number`[] |
+| `_T` | [`DocumentData`](#documentdata) |
+
+#### Constructors
+
+<a id="constructor-13"></a>
+
+##### Constructor
+
+```ts
+new Query<_T>(): Query<_T>;
+```
 
 ###### Returns
 
-[`VectorValue`](#vectorvalue)
+[`Query`](#query)\<`_T`\>
 
-<a id="fromjson-4"></a>
+#### Methods
 
-##### fromJSON()
+<a id="hasinstance-12"></a>
+
+##### \[hasInstance\]()
 
 ```ts
-static fromJSON(json: object): VectorValue;
+static hasInstance: boolean;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `json` | `object` |
+| `instance` | `unknown` |
 
 ###### Returns
 
-[`VectorValue`](#vectorvalue)
-
-## Interfaces
+`boolean`
 
-<a id="aggregatequerysnapshot"></a>
+***
 
-### AggregateQuerySnapshot
+<a id="querycompositefilterconstraint"></a>
 
-Snapshot returned by `getCountFromServer` /
-`getAggregateFromServer`. `.data()` returns the computed numbers
-keyed by the spec's aliases (or `{ count: number }` for the
-count-only entry point).
+### QueryCompositeFilterConstraint
 
-#### Type Parameters
+#### Extends
 
-| Type Parameter | Default type |
-| :------ | :------ |
-| `T` *extends* `Record`\<`string`, `number` \| `null`\> | `Record`\<`string`, `number` \| `null`\> |
+- [`QueryConstraint`](#queryconstraint)
 
-#### Methods
+#### Constructors
 
-<a id="data"></a>
+<a id="constructor-14"></a>
 
-##### data()
+##### Constructor
 
 ```ts
-data(): T;
+new QueryCompositeFilterConstraint(): QueryCompositeFilterConstraint;
 ```
 
 ###### Returns
 
-`T`
-
-***
-
-<a id="collectionreference"></a>
-
-### CollectionReference
-
-A reference to a Firestore collection. Backend-opaque.
+[`QueryCompositeFilterConstraint`](#querycompositefilterconstraint)
 
-#### Type Parameters
+###### Inherited from
 
-| Type Parameter | Default type |
-| :------ | :------ |
-| `_T` | [`DocumentData`](#documentdata) |
+[`QueryConstraint`](#queryconstraint).[`constructor`](#constructor-15)
 
 #### Properties
 
 | Property | Modifier | Type |
 | :------ | :------ | :------ |
-| <a id="id"></a> `id` | `readonly` | `string` |
-| <a id="path"></a> `path` | `readonly` | `string` |
+| <a id="type"></a> `type?` | `readonly` | `string` |
 
-***
+#### Methods
 
-<a id="documentreference"></a>
+<a id="applysandbox"></a>
 
-### DocumentReference
+##### applySandbox()
 
-A reference to a Firestore document. Backend-opaque.
+```ts
+applySandbox(q: Query): Query;
+```
 
-#### Type Parameters
+###### Parameters
 
-| Type Parameter | Default type |
+| Parameter | Type |
 | :------ | :------ |
-| `_T` | [`DocumentData`](#documentdata) |
-
-#### Properties
+| `q` | [`Query`](pyric-admin-firestore-reference-api.md#query) |
 
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="id-1"></a> `id` | `readonly` | `string` |
-| <a id="path-1"></a> `path` | `readonly` | `string` |
+###### Returns
 
-***
+[`Query`](pyric-admin-firestore-reference-api.md#query)
 
-<a id="documentsnapshot"></a>
+###### Inherited from
 
-### DocumentSnapshot
+[`QueryConstraint`](#queryconstraint).[`applySandbox`](#applysandbox-2)
 
-A point-in-time view of one document.
+<a id="preparesandbox"></a>
 
-#### Extended by
+##### prepareSandbox()?
 
-- [`QueryDocumentSnapshot`](#querydocumentsnapshot)
+```ts
+optional prepareSandbox(owner: object): QueryConstraint;
+```
 
-#### Type Parameters
+###### Parameters
 
-| Type Parameter | Default type |
+| Parameter | Type |
 | :------ | :------ |
-| `T` | [`DocumentData`](#documentdata) |
+| `owner` | `object` |
 
-#### Properties
+###### Returns
 
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="exists"></a> `exists` | `readonly` | `boolean` \| () => `boolean` |
-| <a id="id-2"></a> `id` | `readonly` | `string` |
-| <a id="metadata"></a> `metadata` | `readonly` | [`SnapshotMetadata`](#snapshotmetadata) |
-| <a id="ref"></a> `ref` | `readonly` | [`DocumentReference`](#documentreference)\<`T`\> |
+[`QueryConstraint`](#queryconstraint)
 
-#### Methods
+###### Inherited from
 
-<a id="data-2"></a>
+[`QueryConstraint`](#queryconstraint).[`prepareSandbox`](#preparesandbox-2)
 
-##### data()
+<a id="hasinstance-14"></a>
+
+##### \[hasInstance\]()
 
 ```ts
-data(): T;
+static hasInstance: boolean;
 ```
 
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
 ###### Returns
 
-`T`
+`boolean`
+
+###### Overrides
+
+[`QueryConstraint`](#queryconstraint).[`[hasInstance]`](#hasinstance-16)
 
 ***
 
-<a id="firestore"></a>
+<a id="queryconstraint"></a>
 
-### Firestore
+### QueryConstraint
 
-Opaque sandbox handle carrying its owner via [TARGET\_SYMBOL](#target_symbol-1).
+#### Extended by
 
-#### Properties
+- [`QueryFieldFilterConstraint`](#queryfieldfilterconstraint)
+- [`QueryCompositeFilterConstraint`](#querycompositefilterconstraint)
+- [`QueryOrderByConstraint`](#queryorderbyconstraint)
+- [`QueryLimitConstraint`](#querylimitconstraint)
+- [`QueryStartAtConstraint`](#querystartatconstraint)
+- [`QueryEndAtConstraint`](#queryendatconstraint)
 
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="target_symbol"></a> `[TARGET_SYMBOL]` | `readonly` | `Target` |
-| <a id="app"></a> `app?` | `readonly` | [`FirebaseApp`](pyric-app-reference-api.md#firebaseapp) |
+#### Constructors
 
-***
+<a id="constructor-15"></a>
 
-<a id="firestoredataconverter"></a>
+##### Constructor
 
-### FirestoreDataConverter
+```ts
+new QueryConstraint(): QueryConstraint;
+```
 
-Pair of translators between the consumer's app model and the
-underlying Firestore representation. Mirrors `firebase/firestore`'s
-`FirestoreDataConverter` shape.
+###### Returns
 
-  - `toFirestore(model)` runs on every write (`setDoc`, `addDoc`)
-    through a converted ref. Returns the `DocumentData` to send.
-  - `fromFirestore(snapshot)` runs on every read (`getDoc`,
-    `getDocs`, snapshot listener callback) through a converted ref.
-    Receives the raw snapshot, returns the typed model.
+[`QueryConstraint`](#queryconstraint)
 
-#### Type Parameters
+#### Properties
 
-| Type Parameter | Default type |
-| :------ | :------ |
-| `AppModelType` | - |
-| `DbModelType` *extends* [`DocumentData`](#documentdata) | [`DocumentData`](#documentdata) |
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="type-1"></a> `type?` | `readonly` | `string` |
 
 #### Methods
 
-<a id="fromfirestore"></a>
+<a id="applysandbox-2"></a>
 
-##### fromFirestore()
+##### applySandbox()
 
 ```ts
-fromFirestore(snapshot: QueryDocumentSnapshot<DbModelType>): AppModelType;
+applySandbox(q: Query): Query;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `snapshot` | [`QueryDocumentSnapshot`](#querydocumentsnapshot)\<`DbModelType`\> |
+| `q` | [`Query`](pyric-admin-firestore-reference-api.md#query) |
 
 ###### Returns
 
-`AppModelType`
+[`Query`](pyric-admin-firestore-reference-api.md#query)
 
-<a id="tofirestore"></a>
+<a id="preparesandbox-2"></a>
 
-##### toFirestore()
+##### prepareSandbox()?
 
 ```ts
-toFirestore(modelObject: AppModelType): DbModelType;
+optional prepareSandbox(owner: object): QueryConstraint;
 ```
 
 ###### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `modelObject` | `AppModelType` |
+| `owner` | `object` |
 
 ###### Returns
 
-`DbModelType`
+[`QueryConstraint`](#queryconstraint)
 
-***
+<a id="hasinstance-16"></a>
 
-<a id="firestoredatatooldeps"></a>
+##### \[hasInstance\]()
 
-### FirestoreDataToolDeps
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+***
+
+<a id="querydocumentsnapshot"></a>
+
+### QueryDocumentSnapshot
+
+#### Extends
+
+- [`DocumentSnapshot`](#documentsnapshot)\<`T`\>
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| :------ | :------ |
+| `T` | [`DocumentData`](#documentdata) |
+
+#### Constructors
+
+<a id="constructor-16"></a>
+
+##### Constructor
+
+```ts
+new QueryDocumentSnapshot<T>(): QueryDocumentSnapshot<T>;
+```
+
+###### Returns
+
+[`QueryDocumentSnapshot`](#querydocumentsnapshot)\<`T`\>
+
+###### Inherited from
+
+[`DocumentSnapshot`](#documentsnapshot).[`constructor`](#constructor-5)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="exists-1"></a> `exists` | `readonly` | `boolean` \| () => `boolean` |
+| <a id="id-3"></a> `id` | `readonly` | `string` |
+| <a id="metadata-1"></a> `metadata` | `readonly` | [`SnapshotMetadata`](#snapshotmetadata) |
+| <a id="ref-1"></a> `ref` | `readonly` | [`DocumentReference`](#documentreference)\<`T`\> |
+
+#### Methods
+
+<a id="data-4"></a>
+
+##### data()
+
+```ts
+data(): T;
+```
+
+###### Returns
+
+`T`
+
+###### Overrides
+
+[`DocumentSnapshot`](#documentsnapshot).[`data`](#data-2)
+
+<a id="hasinstance-18"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+###### Inherited from
+
+[`DocumentSnapshot`](#documentsnapshot).[`[hasInstance]`](#hasinstance-8)
+
+***
+
+<a id="queryendatconstraint"></a>
+
+### QueryEndAtConstraint
+
+#### Extends
+
+- [`QueryConstraint`](#queryconstraint)
+
+#### Constructors
+
+<a id="constructor-17"></a>
+
+##### Constructor
+
+```ts
+new QueryEndAtConstraint(): QueryEndAtConstraint;
+```
+
+###### Returns
+
+[`QueryEndAtConstraint`](#queryendatconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`constructor`](#constructor-15)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="type-2"></a> `type?` | `readonly` | `string` |
+
+#### Methods
+
+<a id="applysandbox-4"></a>
+
+##### applySandbox()
+
+```ts
+applySandbox(q: Query): Query;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `q` | [`Query`](pyric-admin-firestore-reference-api.md#query) |
+
+###### Returns
+
+[`Query`](pyric-admin-firestore-reference-api.md#query)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`applySandbox`](#applysandbox-2)
+
+<a id="preparesandbox-4"></a>
+
+##### prepareSandbox()?
+
+```ts
+optional prepareSandbox(owner: object): QueryConstraint;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `owner` | `object` |
+
+###### Returns
+
+[`QueryConstraint`](#queryconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`prepareSandbox`](#preparesandbox-2)
+
+<a id="hasinstance-20"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+###### Overrides
+
+[`QueryConstraint`](#queryconstraint).[`[hasInstance]`](#hasinstance-16)
+
+***
+
+<a id="queryfieldfilterconstraint"></a>
+
+### QueryFieldFilterConstraint
+
+#### Extends
+
+- [`QueryConstraint`](#queryconstraint)
+
+#### Constructors
+
+<a id="constructor-18"></a>
+
+##### Constructor
+
+```ts
+new QueryFieldFilterConstraint(): QueryFieldFilterConstraint;
+```
+
+###### Returns
+
+[`QueryFieldFilterConstraint`](#queryfieldfilterconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`constructor`](#constructor-15)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="type-3"></a> `type?` | `readonly` | `string` |
+
+#### Methods
+
+<a id="applysandbox-6"></a>
+
+##### applySandbox()
+
+```ts
+applySandbox(q: Query): Query;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `q` | [`Query`](pyric-admin-firestore-reference-api.md#query) |
+
+###### Returns
+
+[`Query`](pyric-admin-firestore-reference-api.md#query)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`applySandbox`](#applysandbox-2)
+
+<a id="preparesandbox-6"></a>
+
+##### prepareSandbox()?
+
+```ts
+optional prepareSandbox(owner: object): QueryConstraint;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `owner` | `object` |
+
+###### Returns
+
+[`QueryConstraint`](#queryconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`prepareSandbox`](#preparesandbox-2)
+
+<a id="hasinstance-22"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+###### Overrides
+
+[`QueryConstraint`](#queryconstraint).[`[hasInstance]`](#hasinstance-16)
+
+***
+
+<a id="querylimitconstraint"></a>
+
+### QueryLimitConstraint
+
+#### Extends
+
+- [`QueryConstraint`](#queryconstraint)
+
+#### Constructors
+
+<a id="constructor-19"></a>
+
+##### Constructor
+
+```ts
+new QueryLimitConstraint(): QueryLimitConstraint;
+```
+
+###### Returns
+
+[`QueryLimitConstraint`](#querylimitconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`constructor`](#constructor-15)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="type-4"></a> `type?` | `readonly` | `string` |
+
+#### Methods
+
+<a id="applysandbox-8"></a>
+
+##### applySandbox()
+
+```ts
+applySandbox(q: Query): Query;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `q` | [`Query`](pyric-admin-firestore-reference-api.md#query) |
+
+###### Returns
+
+[`Query`](pyric-admin-firestore-reference-api.md#query)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`applySandbox`](#applysandbox-2)
+
+<a id="preparesandbox-8"></a>
+
+##### prepareSandbox()?
+
+```ts
+optional prepareSandbox(owner: object): QueryConstraint;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `owner` | `object` |
+
+###### Returns
+
+[`QueryConstraint`](#queryconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`prepareSandbox`](#preparesandbox-2)
+
+<a id="hasinstance-24"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+###### Overrides
+
+[`QueryConstraint`](#queryconstraint).[`[hasInstance]`](#hasinstance-16)
+
+***
+
+<a id="queryorderbyconstraint"></a>
+
+### QueryOrderByConstraint
+
+#### Extends
+
+- [`QueryConstraint`](#queryconstraint)
+
+#### Constructors
+
+<a id="constructor-20"></a>
+
+##### Constructor
+
+```ts
+new QueryOrderByConstraint(): QueryOrderByConstraint;
+```
+
+###### Returns
+
+[`QueryOrderByConstraint`](#queryorderbyconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`constructor`](#constructor-15)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="type-5"></a> `type?` | `readonly` | `string` |
+
+#### Methods
+
+<a id="applysandbox-10"></a>
+
+##### applySandbox()
+
+```ts
+applySandbox(q: Query): Query;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `q` | [`Query`](pyric-admin-firestore-reference-api.md#query) |
+
+###### Returns
+
+[`Query`](pyric-admin-firestore-reference-api.md#query)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`applySandbox`](#applysandbox-2)
+
+<a id="preparesandbox-10"></a>
+
+##### prepareSandbox()?
+
+```ts
+optional prepareSandbox(owner: object): QueryConstraint;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `owner` | `object` |
+
+###### Returns
+
+[`QueryConstraint`](#queryconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`prepareSandbox`](#preparesandbox-2)
+
+<a id="hasinstance-26"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+###### Overrides
+
+[`QueryConstraint`](#queryconstraint).[`[hasInstance]`](#hasinstance-16)
+
+***
+
+<a id="querysnapshot"></a>
+
+### QuerySnapshot
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| :------ | :------ |
+| `T` | [`DocumentData`](#documentdata) |
+
+#### Constructors
+
+<a id="constructor-21"></a>
+
+##### Constructor
+
+```ts
+new QuerySnapshot<T>(): QuerySnapshot<T>;
+```
+
+###### Returns
+
+[`QuerySnapshot`](#querysnapshot)\<`T`\>
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="docs"></a> `docs` | `readonly` | readonly [`QueryDocumentSnapshot`](#querydocumentsnapshot)\<`T`\>[] |
+| <a id="empty"></a> `empty` | `readonly` | `boolean` |
+| <a id="metadata-2"></a> `metadata` | `readonly` | [`SnapshotMetadata`](#snapshotmetadata) |
+| <a id="size"></a> `size` | `readonly` | `number` |
+
+#### Methods
+
+<a id="hasinstance-28"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+***
+
+<a id="querystartatconstraint"></a>
+
+### QueryStartAtConstraint
+
+#### Extends
+
+- [`QueryConstraint`](#queryconstraint)
+
+#### Constructors
+
+<a id="constructor-22"></a>
+
+##### Constructor
+
+```ts
+new QueryStartAtConstraint(): QueryStartAtConstraint;
+```
+
+###### Returns
+
+[`QueryStartAtConstraint`](#querystartatconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`constructor`](#constructor-15)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="type-6"></a> `type?` | `readonly` | `string` |
+
+#### Methods
+
+<a id="applysandbox-12"></a>
+
+##### applySandbox()
+
+```ts
+applySandbox(q: Query): Query;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `q` | [`Query`](pyric-admin-firestore-reference-api.md#query) |
+
+###### Returns
+
+[`Query`](pyric-admin-firestore-reference-api.md#query)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`applySandbox`](#applysandbox-2)
+
+<a id="preparesandbox-12"></a>
+
+##### prepareSandbox()?
+
+```ts
+optional prepareSandbox(owner: object): QueryConstraint;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `owner` | `object` |
+
+###### Returns
+
+[`QueryConstraint`](#queryconstraint)
+
+###### Inherited from
+
+[`QueryConstraint`](#queryconstraint).[`prepareSandbox`](#preparesandbox-2)
+
+<a id="hasinstance-30"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+###### Overrides
+
+[`QueryConstraint`](#queryconstraint).[`[hasInstance]`](#hasinstance-16)
+
+***
+
+<a id="sandboxerror"></a>
+
+### SandboxError
+
+Sandbox-layer error. Catch with `instanceof SandboxError` and switch
+on `code`. `denialContext` is populated for `permission-denied` only
+(and only after Slice 4 wires it through).
+
+Two construction forms are supported:
+  - Positional: `new SandboxError(code, message, denialContext?)` —
+    the original signature, kept for backward compatibility with
+    existing internal call sites.
+  - Options bag: `new SandboxError({ code, message, remediation? })` —
+    used when attaching remediation guidance.
+
+#### Extends
+
+- `Error`
+
+#### Constructors
+
+<a id="constructor-23"></a>
+
+##### Constructor
+
+```ts
+new SandboxError(
+   code: SandboxErrorCode,
+   message: string,
+   denialContext?: DenialContext): SandboxError;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `code` | [`SandboxErrorCode`](pyric-sandbox-reference-api.md#sandboxerrorcode) |
+| `message` | `string` |
+| `denialContext?` | [`DenialContext`](pyric-sandbox-reference-api.md#denialcontext) |
+
+###### Returns
+
+[`SandboxError`](#sandboxerror)
+
+###### Overrides
+
+```ts
+Error.constructor
+```
+
+##### Constructor
+
+```ts
+new SandboxError(options: SandboxErrorOptions): SandboxError;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `options` | `SandboxErrorOptions` |
+
+###### Returns
+
+[`SandboxError`](#sandboxerror)
+
+###### Overrides
+
+```ts
+Error.constructor
+```
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="code-1"></a> `code` | `readonly` | [`SandboxErrorCode`](pyric-sandbox-reference-api.md#sandboxerrorcode) |
+| <a id="denialcontext"></a> `denialContext?` | `readonly` | [`DenialContext`](pyric-sandbox-reference-api.md#denialcontext) |
+| <a id="remediation"></a> `remediation?` | `readonly` | `string` |
+
+***
+
+<a id="snapshotmetadata"></a>
+
+### SnapshotMetadata
+
+#### Constructors
+
+<a id="constructor-24"></a>
+
+##### Constructor
+
+```ts
+new SnapshotMetadata(): SnapshotMetadata;
+```
+
+###### Returns
+
+[`SnapshotMetadata`](#snapshotmetadata)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="fromcache"></a> `fromCache` | `readonly` | `boolean` |
+| <a id="haspendingwrites"></a> `hasPendingWrites` | `readonly` | `boolean` |
+
+#### Methods
+
+<a id="hasinstance-32"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+***
+
+<a id="timestamp"></a>
+
+### Timestamp
+
+#### Constructors
+
+<a id="constructor-25"></a>
+
+##### Constructor
+
+```ts
+new Timestamp(seconds: number, nanoseconds: number): Timestamp;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `seconds` | `number` |
+| `nanoseconds` | `number` |
+
+###### Returns
+
+[`Timestamp`](#timestamp)
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="nanoseconds"></a> `nanoseconds` | `readonly` | `number` |
+| <a id="seconds"></a> `seconds` | `readonly` | `number` |
+
+#### Methods
+
+<a id="isequal-6"></a>
+
+##### isEqual()
+
+```ts
+isEqual(other: Timestamp): boolean;
+```
+
+FS-B12 — value equality, mirroring `fb.Timestamp.isEqual`.
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `other` | [`Timestamp`](#timestamp) |
+
+###### Returns
+
+`boolean`
+
+<a id="todate"></a>
+
+##### toDate()
+
+```ts
+toDate(): Date;
+```
+
+###### Returns
+
+`Date`
+
+<a id="tojson-4"></a>
+
+##### toJSON()
+
+```ts
+toJSON(): {
+  nanoseconds: number;
+  seconds: number;
+  type: string;
+};
+```
+
+FS-B12 — JSON form, mirroring `fb.Timestamp.toJSON`.
+
+###### Returns
+
+```ts
+{
+  nanoseconds: number;
+  seconds: number;
+  type: string;
+}
+```
+
+###### nanoseconds
+
+```ts
+nanoseconds: number;
+```
+
+###### seconds
+
+```ts
+seconds: number;
+```
+
+###### type
+
+```ts
+type: string;
+```
+
+<a id="tomillis"></a>
+
+##### toMillis()
+
+```ts
+toMillis(): number;
+```
+
+###### Returns
+
+`number`
+
+<a id="tostring-2"></a>
+
+##### toString()
+
+```ts
+toString(): string;
+```
+
+FS-B12 — textual form, mirroring `fb.Timestamp.toString`.
+
+###### Returns
+
+`string`
+
+<a id="valueof"></a>
+
+##### valueOf()
+
+```ts
+valueOf(): string;
+```
+
+FS-B12 — primitive coercion for `<`/`<=`/`>=`/`>` comparisons, mirroring
+`fb.Timestamp.valueOf`: a zero-padded `<seconds>.<nanoseconds>` string
+(seconds offset by MIN_SECONDS so it stays non-negative and lexically
+ordered).
+
+###### Returns
+
+`string`
+
+<a id="fromdate"></a>
+
+##### fromDate()
+
+```ts
+static fromDate(d: Date): Timestamp;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `d` | `Date` |
+
+###### Returns
+
+[`Timestamp`](#timestamp)
+
+<a id="frommillis"></a>
+
+##### fromMillis()
+
+```ts
+static fromMillis(ms: number): Timestamp;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `ms` | `number` |
+
+###### Returns
+
+[`Timestamp`](#timestamp)
+
+<a id="now"></a>
+
+##### now()
+
+```ts
+static now(): Timestamp;
+```
+
+###### Returns
+
+[`Timestamp`](#timestamp)
+
+***
+
+<a id="transaction"></a>
+
+### Transaction
+
+#### Extends
+
+- [`Transaction`](pyric-admin-firestore-reference-api.md#transaction)
+
+#### Constructors
+
+<a id="constructor-26"></a>
+
+##### Constructor
+
+```ts
+new Transaction(): Transaction;
+```
+
+###### Returns
+
+[`Transaction`](#transaction)
+
+###### Inherited from
+
+```ts
+ChainTransaction.constructor
+```
+
+#### Methods
+
+<a id="delete-2"></a>
+
+##### delete()
+
+```ts
+delete(ref: DocumentReference): Transaction;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `ref` | [`DocumentReference`](pyric-admin-firestore-reference-api.md#documentreference) |
+
+###### Returns
+
+[`Transaction`](pyric-admin-firestore-reference-api.md#transaction)
+
+###### Inherited from
+
+[`Transaction`](pyric-admin-firestore-reference-api.md#transaction).[`delete`](pyric-admin-firestore-reference-api.md#delete-2)
+
+<a id="get"></a>
+
+##### get()
+
+###### Call Signature
+
+```ts
+get(ref: DocumentReference): Promise<AdminDocumentSnapshot>;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `ref` | [`DocumentReference`](pyric-admin-firestore-reference-api.md#documentreference) |
+
+###### Returns
+
+`Promise`\<[`AdminDocumentSnapshot`](pyric-admin-firestore-reference-api.md#admindocumentsnapshot)\>
+
+###### Inherited from
+
+[`Transaction`](pyric-admin-firestore-reference-api.md#transaction).[`get`](pyric-admin-firestore-reference-api.md#get-14)
+
+###### Call Signature
+
+```ts
+get(query: Query): Promise<AdminQuerySnapshot>;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `query` | [`Query`](pyric-admin-firestore-reference-api.md#query) |
+
+###### Returns
+
+`Promise`\<[`AdminQuerySnapshot`](pyric-admin-firestore-reference-api.md#adminquerysnapshot)\>
+
+###### Inherited from
+
+[`Transaction`](pyric-admin-firestore-reference-api.md#transaction).[`get`](pyric-admin-firestore-reference-api.md#get-14)
+
+<a id="set"></a>
+
+##### set()
+
+```ts
+set(ref: DocumentReference, data: DocumentData): Transaction;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `ref` | [`DocumentReference`](pyric-admin-firestore-reference-api.md#documentreference) |
+| `data` | [`DocumentData`](#documentdata) |
+
+###### Returns
+
+[`Transaction`](pyric-admin-firestore-reference-api.md#transaction)
+
+###### Inherited from
+
+[`Transaction`](pyric-admin-firestore-reference-api.md#transaction).[`set`](pyric-admin-firestore-reference-api.md#set-2)
+
+<a id="update"></a>
+
+##### update()
+
+```ts
+update(ref: DocumentReference, data: DocumentData): Transaction;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `ref` | [`DocumentReference`](pyric-admin-firestore-reference-api.md#documentreference) |
+| `data` | [`DocumentData`](#documentdata) |
+
+###### Returns
+
+[`Transaction`](pyric-admin-firestore-reference-api.md#transaction)
+
+###### Inherited from
+
+[`Transaction`](pyric-admin-firestore-reference-api.md#transaction).[`update`](pyric-admin-firestore-reference-api.md#update-2)
+
+<a id="hasinstance-34"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+***
+
+<a id="vectorvalue"></a>
+
+### VectorValue
+
+#### Methods
+
+<a id="isequal-8"></a>
+
+##### isEqual()
+
+```ts
+isEqual(other: VectorValue): boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `other` | [`VectorValue`](#vectorvalue) |
+
+###### Returns
+
+`boolean`
+
+<a id="toarray"></a>
+
+##### toArray()
+
+```ts
+toArray(): number[];
+```
+
+###### Returns
+
+`number`[]
+
+<a id="tojson-6"></a>
+
+##### toJSON()
+
+```ts
+toJSON(): object;
+```
+
+###### Returns
+
+`object`
+
+<a id="create"></a>
+
+##### create()
+
+```ts
+static create(values: number[]): VectorValue;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `values` | `number`[] |
+
+###### Returns
+
+[`VectorValue`](#vectorvalue)
+
+<a id="fromjson-4"></a>
+
+##### fromJSON()
+
+```ts
+static fromJSON(json: object): VectorValue;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `json` | `object` |
+
+###### Returns
+
+[`VectorValue`](#vectorvalue)
+
+***
+
+<a id="writebatch"></a>
+
+### WriteBatch
+
+#### Extends
+
+- [`WriteBatch`](pyric-admin-firestore-reference-api.md#writebatch)
+
+#### Constructors
+
+<a id="constructor-27"></a>
+
+##### Constructor
+
+```ts
+new WriteBatch(): WriteBatch;
+```
+
+###### Returns
+
+[`WriteBatch`](#writebatch)
+
+###### Inherited from
+
+```ts
+ChainWriteBatch.constructor
+```
+
+#### Methods
+
+<a id="commit"></a>
+
+##### commit()
+
+```ts
+commit(opts?: OperationOptions): Promise<void>;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `opts?` | `OperationOptions` |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Inherited from
+
+[`WriteBatch`](pyric-admin-firestore-reference-api.md#writebatch).[`commit`](pyric-admin-firestore-reference-api.md#commit)
+
+<a id="delete-4"></a>
+
+##### delete()
+
+```ts
+delete(ref: DocumentReference): WriteBatch;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `ref` | [`DocumentReference`](pyric-admin-firestore-reference-api.md#documentreference) |
+
+###### Returns
+
+[`WriteBatch`](pyric-admin-firestore-reference-api.md#writebatch)
+
+###### Inherited from
+
+[`WriteBatch`](pyric-admin-firestore-reference-api.md#writebatch).[`delete`](pyric-admin-firestore-reference-api.md#delete-4)
+
+<a id="set-2"></a>
+
+##### set()
+
+```ts
+set(ref: DocumentReference, data: DocumentData): WriteBatch;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `ref` | [`DocumentReference`](pyric-admin-firestore-reference-api.md#documentreference) |
+| `data` | [`DocumentData`](#documentdata) |
+
+###### Returns
+
+[`WriteBatch`](pyric-admin-firestore-reference-api.md#writebatch)
+
+###### Inherited from
+
+[`WriteBatch`](pyric-admin-firestore-reference-api.md#writebatch).[`set`](pyric-admin-firestore-reference-api.md#set-4)
+
+<a id="update-2"></a>
+
+##### update()
+
+```ts
+update(ref: DocumentReference, data: DocumentData): WriteBatch;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `ref` | [`DocumentReference`](pyric-admin-firestore-reference-api.md#documentreference) |
+| `data` | [`DocumentData`](#documentdata) |
+
+###### Returns
+
+[`WriteBatch`](pyric-admin-firestore-reference-api.md#writebatch)
+
+###### Inherited from
+
+[`WriteBatch`](pyric-admin-firestore-reference-api.md#writebatch).[`update`](pyric-admin-firestore-reference-api.md#update-4)
+
+<a id="hasinstance-36"></a>
+
+##### \[hasInstance\]()
+
+```ts
+static hasInstance: boolean;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `instance` | `unknown` |
+
+###### Returns
+
+`boolean`
+
+## Interfaces
+
+<a id="documentchange"></a>
+
+### DocumentChange
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| :------ | :------ |
+| `T` | [`DocumentData`](#documentdata) |
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="doc"></a> `doc` | `readonly` | [`QueryDocumentSnapshot`](#querydocumentsnapshot)\<`T`\> |
+| <a id="newindex"></a> `newIndex` | `readonly` | `number` |
+| <a id="oldindex"></a> `oldIndex` | `readonly` | `number` |
+| <a id="type-7"></a> `type` | `readonly` | [`DocumentChangeType`](#documentchangetype-1) |
+
+***
+
+<a id="emulatormocktokenoptions"></a>
+
+### EmulatorMockTokenOptions
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="mockusertoken"></a> `mockUserToken?` | `string` \| `Record`\<`string`, `unknown`\> |
+
+***
+
+<a id="experimentallongpollingoptions"></a>
+
+### ExperimentalLongPollingOptions
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="forcelongpolling"></a> `forceLongPolling?` | `boolean` |
+
+***
+
+<a id="firestoredataconverter"></a>
+
+### FirestoreDataConverter
+
+Pair of translators between the consumer's app model and the
+underlying Firestore representation. Mirrors `firebase/firestore`'s
+`FirestoreDataConverter` shape.
+
+  - `toFirestore(model)` runs on every write (`setDoc`, `addDoc`)
+    through a converted ref. Returns the `DocumentData` to send.
+  - `fromFirestore(snapshot)` runs on every read (`getDoc`,
+    `getDocs`, snapshot listener callback) through a converted ref.
+    Receives the raw snapshot, returns the typed model.
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| :------ | :------ |
+| `AppModelType` | - |
+| `DbModelType` *extends* [`DocumentData`](#documentdata) | [`DocumentData`](#documentdata) |
+
+#### Methods
+
+<a id="fromfirestore"></a>
+
+##### fromFirestore()
+
+```ts
+fromFirestore(snapshot: QueryDocumentSnapshot<DbModelType>): AppModelType;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `snapshot` | [`QueryDocumentSnapshot`](#querydocumentsnapshot)\<`DbModelType`\> |
+
+###### Returns
+
+`AppModelType`
+
+<a id="tofirestore"></a>
+
+##### toFirestore()
+
+```ts
+toFirestore(modelObject: AppModelType): DbModelType;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `modelObject` | `AppModelType` |
+
+###### Returns
+
+`DbModelType`
+
+***
+
+<a id="firestoredatatooldeps"></a>
+
+### FirestoreDataToolDeps
 
 #### Methods
 
@@ -1051,207 +2774,171 @@ Client-cache/network settings `initializeFirestore` accepts but no-ops
 
 ***
 
-<a id="lintresult"></a>
+<a id="index"></a>
 
-### LintResult
+### Index
 
 #### Properties
 
-| Property | Type | Description |
-| :------ | :------ | :------ |
-| <a id="metrics"></a> `metrics` | [`RulesMetrics`](pyric-admin-firestore-reference-api.md#rulesmetrics) | - |
-| <a id="parseerror"></a> `parseError?` | `ParseError` | Structured parse failure when the source did not parse. When defined, `metrics` (except `sourceSize`) and `warnings` carry no signal — budget checks were skipped. Callers should branch on `parseError` before interpreting warnings or metrics. Why this isn't a new `severity` value: a parse failure means "this isn't a rule yet" rather than "this rule will fail at runtime", which is a categorically different question from anything `warnings` answers. Adding a new severity would force every consumer to handle a third branch they don't care about; a separate field lets old code keep working and gives new code a clean signal to check. |
-| <a id="warnings"></a> `warnings` | [`LintWarning`](pyric-admin-firestore-reference-api.md#lintwarning)[] | - |
+| Property | Type |
+| :------ | :------ |
+| <a id="collectiongroup"></a> `collectionGroup` | `string` |
+| <a id="fields"></a> `fields?` | [`IndexField`](#indexfield)[] |
 
 ***
 
-<a id="localcache-1"></a>
-
-### LocalCache
+<a id="indexconfiguration"></a>
 
-Opaque local-cache config token accepted by [initializeFirestore](#initializefirestore)'s
- `settings.localCache`. Inert — see the tier-1 section rationale above.
+### IndexConfiguration
 
 #### Properties
 
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="local_cache_symbol"></a> `[LOCAL_CACHE_SYMBOL]` | `readonly` | `"persistent"` \| `"memory"` |
-| <a id="garbagecollector"></a> `garbageCollector?` | `readonly` | [`MemoryGarbageCollector`](#memorygarbagecollector) |
-| <a id="tabmanager"></a> `tabManager?` | `readonly` | [`PersistentTabManager`](#persistenttabmanager) |
+| Property | Type |
+| :------ | :------ |
+| <a id="fieldoverrides"></a> `fieldOverrides?` | `unknown`[] |
+| <a id="indexes"></a> `indexes?` | [`Index`](#index)[] |
 
 ***
 
-<a id="memorygarbagecollector"></a>
-
-### MemoryGarbageCollector
+<a id="indexfield"></a>
 
-Opaque garbage-collector config token. Inert for the same reason —
- there is no memory cache tier with GC pressure to tune.
+### IndexField
 
 #### Properties
 
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="gc_symbol"></a> `[GC_SYMBOL]` | `readonly` | `"eager"` \| `"lru"` |
+| Property | Type |
+| :------ | :------ |
+| <a id="arrayconfig"></a> `arrayConfig?` | `"contains"` |
+| <a id="fieldpath-1"></a> `fieldPath` | `string` |
+| <a id="order"></a> `order?` | `"ascending"` \| `"descending"` |
 
 ***
 
-<a id="persistencesettings"></a>
+<a id="lintresult"></a>
 
-### PersistenceSettings
+### LintResult
 
 #### Properties
 
-| Property | Type |
-| :------ | :------ |
-| <a id="forceownership"></a> `forceOwnership?` | `boolean` |
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| <a id="metrics"></a> `metrics` | [`RulesMetrics`](pyric-admin-firestore-reference-api.md#rulesmetrics) | - |
+| <a id="parseerror"></a> `parseError?` | `ParseError` | Structured parse failure when the source did not parse. When defined, `metrics` (except `sourceSize`) and `warnings` carry no signal — budget checks were skipped. Callers should branch on `parseError` before interpreting warnings or metrics. Why this isn't a new `severity` value: a parse failure means "this isn't a rule yet" rather than "this rule will fail at runtime", which is a categorically different question from anything `warnings` answers. Adding a new severity would force every consumer to handle a third branch they don't care about; a separate field lets old code keep working and gives new code a clean signal to check. |
+| <a id="warnings"></a> `warnings` | [`LintWarning`](pyric-admin-firestore-reference-api.md#lintwarning)[] | - |
 
 ***
 
-<a id="persistenttabmanager"></a>
-
-### PersistentTabManager
+<a id="loadbundletaskprogress"></a>
 
-Opaque tab-manager config token. Inert — persistence is always on,
- and the SharedWorker/`pyric dev` path already is the one shared
- store every tab talks to, so there is no separate multi-tab mode
- to opt into. Carries the requested kind only for debugging.
+### LoadBundleTaskProgress
 
 #### Properties
 
 | Property | Modifier | Type |
 | :------ | :------ | :------ |
-| <a id="tab_manager_symbol"></a> `[TAB_MANAGER_SYMBOL]` | `readonly` | `"single"` \| `"multiple"` |
+| <a id="bytesloaded"></a> `bytesLoaded` | `readonly` | `number` |
+| <a id="documentsloaded"></a> `documentsLoaded` | `readonly` | `number` |
+| <a id="taskstate"></a> `taskState` | `readonly` | [`TaskState`](#taskstate-1) |
+| <a id="totalbytes"></a> `totalBytes` | `readonly` | `number` |
+| <a id="totaldocuments"></a> `totalDocuments` | `readonly` | `number` |
 
 ***
 
-<a id="query"></a>
+<a id="localcache-1"></a>
 
-### Query
+### LocalCache
 
-A Firestore query (a collection ref or one with where/orderBy/limit applied).
+Opaque local-cache config token accepted by [initializeFirestore](#initializefirestore)'s
+ `settings.localCache`. Inert — see the tier-1 section rationale above.
 
-#### Type Parameters
+#### Properties
 
-| Type Parameter | Default type |
-| :------ | :------ |
-| `_T` | [`DocumentData`](#documentdata) |
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="local_cache_symbol"></a> `[LOCAL_CACHE_SYMBOL]` | `readonly` | `"persistent"` \| `"memory"` |
+| <a id="garbagecollector"></a> `garbageCollector?` | `readonly` | [`MemoryGarbageCollector`](#memorygarbagecollector) |
+| <a id="tabmanager"></a> `tabManager?` | `readonly` | [`PersistentTabManager`](#persistenttabmanager) |
 
 ***
 
-<a id="queryconstraint"></a>
-
-### QueryConstraint
-
-#### Methods
-
-<a id="applysandbox"></a>
-
-##### applySandbox()
+<a id="memorycachesettings"></a>
 
-```ts
-applySandbox(q: Query): Query;
-```
+### MemoryCacheSettings
 
-###### Parameters
+#### Properties
 
-| Parameter | Type |
+| Property | Type |
 | :------ | :------ |
-| `q` | [`Query`](pyric-admin-firestore-reference-api.md#query) |
+| <a id="garbagecollector-1"></a> `garbageCollector?` | [`MemoryGarbageCollector`](#memorygarbagecollector) |
 
-###### Returns
-
-[`Query`](pyric-admin-firestore-reference-api.md#query)
-
-<a id="preparesandbox"></a>
-
-##### prepareSandbox()?
+***
 
-```ts
-optional prepareSandbox(owner: object): QueryConstraint;
-```
+<a id="memorygarbagecollector"></a>
 
-###### Parameters
+### MemoryGarbageCollector
 
-| Parameter | Type |
-| :------ | :------ |
-| `owner` | `object` |
+Opaque garbage-collector config token. Inert for the same reason —
+ there is no memory cache tier with GC pressure to tune.
 
-###### Returns
+#### Properties
 
-[`QueryConstraint`](#queryconstraint)
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="gc_symbol"></a> `[GC_SYMBOL]` | `readonly` | `"eager"` \| `"lru"` |
 
 ***
 
-<a id="querydocumentsnapshot"></a>
-
-### QueryDocumentSnapshot
-
-`QueryDocumentSnapshot` is a `DocumentSnapshot` known to exist —
-`.data()` always returns the typed model, never `undefined`. Yielded
-by `QuerySnapshot.docs` and passed to converter `fromFirestore`
-callbacks. Mirrors the JS SDK's narrowing.
-
-#### Extends
+<a id="persistencesettings"></a>
 
-- [`DocumentSnapshot`](#documentsnapshot)\<`T`\>
+### PersistenceSettings
 
-#### Type Parameters
+#### Properties
 
-| Type Parameter | Default type |
+| Property | Type |
 | :------ | :------ |
-| `T` | [`DocumentData`](#documentdata) |
+| <a id="forceownership"></a> `forceOwnership?` | `boolean` |
 
-#### Properties
+***
 
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="exists-1"></a> `exists` | `readonly` | `boolean` \| () => `boolean` |
-| <a id="id-3"></a> `id` | `readonly` | `string` |
-| <a id="metadata-1"></a> `metadata` | `readonly` | [`SnapshotMetadata`](#snapshotmetadata) |
-| <a id="ref-1"></a> `ref` | `readonly` | [`DocumentReference`](#documentreference)\<`T`\> |
+<a id="persistentcachesettings"></a>
 
-#### Methods
+### PersistentCacheSettings
 
-<a id="data-4"></a>
+#### Properties
 
-##### data()
+| Property | Type |
+| :------ | :------ |
+| <a id="cachesizebytes-1"></a> `cacheSizeBytes?` | `number` |
+| <a id="tabmanager-1"></a> `tabManager?` | [`PersistentTabManager`](#persistenttabmanager) |
 
-```ts
-data(): T;
-```
+***
 
-###### Returns
+<a id="persistentsingletabmanagersettings"></a>
 
-`T`
+### PersistentSingleTabManagerSettings
 
-###### Overrides
+#### Properties
 
-[`DocumentSnapshot`](#documentsnapshot).[`data`](#data-2)
+| Property | Type |
+| :------ | :------ |
+| <a id="forceownership-1"></a> `forceOwnership?` | `boolean` |
 
 ***
 
-<a id="querysnapshot"></a>
-
-### QuerySnapshot
-
-A point-in-time view of a query result.
+<a id="persistenttabmanager"></a>
 
-#### Type Parameters
+### PersistentTabManager
 
-| Type Parameter | Default type |
-| :------ | :------ |
-| `T` | [`DocumentData`](#documentdata) |
+Opaque tab-manager config token. Inert — persistence is always on,
+ and the SharedWorker/`pyric dev` path already is the one shared
+ store every tab talks to, so there is no separate multi-tab mode
+ to opt into. Carries the requested kind only for debugging.
 
 #### Properties
 
 | Property | Modifier | Type |
 | :------ | :------ | :------ |
-| <a id="docs"></a> `docs` | `readonly` | readonly [`QueryDocumentSnapshot`](#querydocumentsnapshot)\<`T`\>[] |
-| <a id="empty"></a> `empty` | `readonly` | `boolean` |
-| <a id="metadata-2"></a> `metadata` | `readonly` | [`SnapshotMetadata`](#snapshotmetadata) |
-| <a id="size"></a> `size` | `readonly` | `number` |
+| <a id="tab_manager_symbol"></a> `[TAB_MANAGER_SYMBOL]` | `readonly` | `"single"` \| `"multiple"` |
 
 ***
 
@@ -1882,19 +3569,6 @@ matching the JS SDK's effective behavior).
 
 ***
 
-<a id="snapshotmetadata"></a>
-
-### SnapshotMetadata
-
-#### Properties
-
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="fromcache"></a> `fromCache` | `readonly` | `boolean` |
-| <a id="haspendingwrites"></a> `hasPendingWrites` | `readonly` | `boolean` |
-
-***
-
 <a id="snapshotobserver"></a>
 
 ### SnapshotObserver
@@ -1915,6 +3589,18 @@ matching the JS SDK's effective behavior).
 
 ***
 
+<a id="snapshotoptions"></a>
+
+### SnapshotOptions
+
+#### Properties
+
+| Property | Modifier | Type |
+| :------ | :------ | :------ |
+| <a id="servertimestamps"></a> `serverTimestamps?` | `readonly` | `"estimate"` \| `"previous"` \| `"none"` |
+
+***
+
 <a id="transactionoptions"></a>
 
 ### TransactionOptions
@@ -1933,32 +3619,38 @@ Options accepted by the modular Web-SDK-shaped `runTransaction`.
 
 ### UserAuth
 
-#### Properties
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="claims"></a> `claims?` | `Record`\<`string`, `unknown`\> |
+| <a id="uid"></a> `uid` | `string` |
+
+## Type Aliases
+
+<a id="addprefixtokeys"></a>
+
+### AddPrefixToKeys
+
+```ts
+type AddPrefixToKeys<Prefix, T> = { [K in keyof T as `${Prefix}.${string & K}`]: T[K] };
+```
+
+#### Type Parameters
 
-| Property | Type |
-| :------ | :------ |
-| <a id="claims"></a> `claims?` | `Record`\<`string`, `unknown`\> |
-| <a id="uid"></a> `uid` | `string` |
+| Type Parameter |
+| :------ |
+| `Prefix` *extends* `string` |
+| `T` *extends* `Record`\<`string`, `unknown`\> |
 
-## Type Aliases
+***
 
-<a id="aggregatefield"></a>
+<a id="aggregatefieldtype"></a>
 
-### AggregateField
+### AggregateFieldType
 
 ```ts
-type AggregateField =
-  | {
-  kind: "count";
-}
-  | {
-  field: string;
-  kind: "sum";
-}
-  | {
-  field: string;
-  kind: "average";
-};
+type AggregateFieldType = "count" | "sum" | "average";
 ```
 
 Aggregate-field descriptor returned by `count()` / `sum(field)` /
@@ -1978,6 +3670,32 @@ Spec passed to `getAggregateFromServer(query, spec)`.
 
 ***
 
+<a id="aggregatespecdata"></a>
+
+### AggregateSpecData
+
+```ts
+type AggregateSpecData<T> = Record<string, unknown>;
+```
+
+#### Type Parameters
+
+| Type Parameter |
+| :------ |
+| `T` |
+
+***
+
+<a id="aggregatetype"></a>
+
+### AggregateType
+
+```ts
+type AggregateType = "count" | "sum" | "average";
+```
+
+***
+
 <a id="appfirestore"></a>
 
 ### AppFirestore
@@ -2042,6 +3760,32 @@ names should reflect that.
 
 ***
 
+<a id="childupdatefields"></a>
+
+### ChildUpdateFields
+
+```ts
+type ChildUpdateFields<T> = Record<string, unknown>;
+```
+
+#### Type Parameters
+
+| Type Parameter |
+| :------ |
+| `T` |
+
+***
+
+<a id="documentchangetype-1"></a>
+
+### DocumentChangeType
+
+```ts
+type DocumentChangeType = "added" | "removed" | "modified";
+```
+
+***
+
 <a id="documentdata"></a>
 
 ### DocumentData
@@ -2075,6 +3819,52 @@ type FieldValueSentinel =
 
 ***
 
+<a id="firestoreerrorcode-1"></a>
+
+### FirestoreErrorCode
+
+```ts
+type FirestoreErrorCode =
+  | "cancelled"
+  | "unknown"
+  | "invalid-argument"
+  | "deadline-exceeded"
+  | "not-found"
+  | "already-exists"
+  | "permission-denied"
+  | "resource-exhausted"
+  | "failed-precondition"
+  | "aborted"
+  | "out-of-range"
+  | "unimplemented"
+  | "internal"
+  | "unavailable"
+  | "data-loss"
+  | "unauthenticated";
+```
+
+***
+
+<a id="firestorelocalcache"></a>
+
+### FirestoreLocalCache
+
+```ts
+type FirestoreLocalCache = LocalCache;
+```
+
+***
+
+<a id="listensource"></a>
+
+### ListenSource
+
+```ts
+type ListenSource = "default" | "cache";
+```
+
+***
+
 <a id="loglevel"></a>
 
 ### LogLevel
@@ -2087,6 +3877,92 @@ Mirrors `firebase/firestore`'s `LogLevel` union.
 
 ***
 
+<a id="memoryeagergarbagecollector"></a>
+
+### MemoryEagerGarbageCollector
+
+```ts
+type MemoryEagerGarbageCollector = MemoryGarbageCollector & {
+  [GC_SYMBOL]: "eager";
+};
+```
+
+#### Type Declaration
+
+##### \[GC\_SYMBOL\]
+
+```ts
+readonly [GC_SYMBOL]: "eager";
+```
+
+***
+
+<a id="memorylocalcache"></a>
+
+### MemoryLocalCache
+
+```ts
+type MemoryLocalCache = LocalCache & {
+  [LOCAL_CACHE_SYMBOL]: "memory";
+};
+```
+
+#### Type Declaration
+
+##### \[LOCAL\_CACHE\_SYMBOL\]
+
+```ts
+readonly [LOCAL_CACHE_SYMBOL]: "memory";
+```
+
+***
+
+<a id="memorylrugarbagecollector"></a>
+
+### MemoryLruGarbageCollector
+
+```ts
+type MemoryLruGarbageCollector = MemoryGarbageCollector & {
+  [GC_SYMBOL]: "lru";
+};
+```
+
+#### Type Declaration
+
+##### \[GC\_SYMBOL\]
+
+```ts
+readonly [GC_SYMBOL]: "lru";
+```
+
+***
+
+<a id="nestedupdatefields"></a>
+
+### NestedUpdateFields
+
+```ts
+type NestedUpdateFields<T> = Record<string, unknown>;
+```
+
+#### Type Parameters
+
+| Type Parameter |
+| :------ |
+| `T` |
+
+***
+
+<a id="orderbydirection"></a>
+
+### OrderByDirection
+
+```ts
+type OrderByDirection = "asc" | "desc";
+```
+
+***
+
 <a id="orderdirection"></a>
 
 ### OrderDirection
@@ -2097,16 +3973,158 @@ type OrderDirection = QueryOrderDirection;
 
 ***
 
-<a id="transaction"></a>
+<a id="partialwithfieldvalue"></a>
 
-### Transaction
+### PartialWithFieldValue
+
+```ts
+type PartialWithFieldValue<T> = Partial<T> | Record<string, unknown>;
+```
+
+#### Type Parameters
+
+| Type Parameter |
+| :------ |
+| `T` |
+
+***
+
+<a id="persistentlocalcache"></a>
+
+### PersistentLocalCache
+
+```ts
+type PersistentLocalCache = LocalCache & {
+  [LOCAL_CACHE_SYMBOL]: "persistent";
+};
+```
+
+#### Type Declaration
+
+##### \[LOCAL\_CACHE\_SYMBOL\]
+
+```ts
+readonly [LOCAL_CACHE_SYMBOL]: "persistent";
+```
+
+***
+
+<a id="persistentmultipletabmanager"></a>
+
+### PersistentMultipleTabManager
+
+```ts
+type PersistentMultipleTabManager = PersistentTabManager & {
+  [TAB_MANAGER_SYMBOL]: "multiple";
+};
+```
+
+#### Type Declaration
+
+##### \[TAB\_MANAGER\_SYMBOL\]
+
+```ts
+readonly [TAB_MANAGER_SYMBOL]: "multiple";
+```
+
+***
+
+<a id="persistentsingletabmanager"></a>
+
+### PersistentSingleTabManager
+
+```ts
+type PersistentSingleTabManager = PersistentTabManager & {
+  [TAB_MANAGER_SYMBOL]: "single";
+};
+```
+
+#### Type Declaration
+
+##### \[TAB\_MANAGER\_SYMBOL\]
+
+```ts
+readonly [TAB_MANAGER_SYMBOL]: "single";
+```
+
+***
+
+<a id="primitive"></a>
+
+### Primitive
+
+```ts
+type Primitive = string | number | boolean | bigint | symbol | undefined | null;
+```
+
+***
+
+<a id="queryconstrainttype-1"></a>
+
+### QueryConstraintType
+
+```ts
+type QueryConstraintType =
+  | "where"
+  | "orderBy"
+  | "limit"
+  | "limitToLast"
+  | "startAt"
+  | "startAfter"
+  | "endAt"
+  | "endBefore"
+  | "or"
+  | "and";
+```
+
+***
+
+<a id="queryfilterconstraint"></a>
+
+### QueryFilterConstraint
+
+```ts
+type QueryFilterConstraint = any;
+```
+
+***
+
+<a id="querynonfilterconstraint"></a>
+
+### QueryNonFilterConstraint
+
+```ts
+type QueryNonFilterConstraint = any;
+```
+
+***
+
+<a id="taskstate-1"></a>
+
+### TaskState
 
 ```ts
-type Transaction = Transaction;
+type TaskState = "Error" | "Running" | "Success";
 ```
 
 ***
 
+<a id="uniontointersection"></a>
+
+### UnionToIntersection
+
+```ts
+type UnionToIntersection<U> = U extends any ? (k: U) => void : never extends (k: infer I) => void ? I : never;
+```
+
+#### Type Parameters
+
+| Type Parameter |
+| :------ |
+| `U` |
+
+***
+
 <a id="unsubscribe"></a>
 
 ### Unsubscribe()
@@ -2121,6 +4139,22 @@ type Unsubscribe = () => void;
 
 ***
 
+<a id="updatedata"></a>
+
+### UpdateData
+
+```ts
+type UpdateData<T> = { [path in string]: unknown };
+```
+
+#### Type Parameters
+
+| Type Parameter |
+| :------ |
+| `T` |
+
+***
+
 <a id="wherefilterop"></a>
 
 ### WhereFilterOp
@@ -2131,16 +4165,32 @@ type WhereFilterOp = QueryWhereFilterOp;
 
 ***
 
-<a id="writebatch"></a>
+<a id="withfieldvalue"></a>
 
-### WriteBatch
+### WithFieldValue
 
 ```ts
-type WriteBatch = WriteBatch;
+type WithFieldValue<T> = T | Record<string, unknown>;
 ```
 
+#### Type Parameters
+
+| Type Parameter |
+| :------ |
+| `T` |
+
 ## Variables
 
+<a id="cache_size_unlimited"></a>
+
+### CACHE\_SIZE\_UNLIMITED
+
+```ts
+const CACHE_SIZE_UNLIMITED: -1 = -1;
+```
+
+***
+
 <a id="target_symbol-1"></a>
 
 ### TARGET\_SYMBOL
@@ -2233,6 +4283,48 @@ function addDoc<T>(coll: CollectionReference<T>, data: T): Promise<DocumentRefer
 
 ***
 
+<a id="aggregatefieldequal"></a>
+
+### aggregateFieldEqual()
+
+```ts
+function aggregateFieldEqual(a: any, b: any): boolean;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `a` | `any` |
+| `b` | `any` |
+
+#### Returns
+
+`boolean`
+
+***
+
+<a id="aggregatequerysnapshotequal"></a>
+
+### aggregateQuerySnapshotEqual()
+
+```ts
+function aggregateQuerySnapshotEqual(a: any, b: any): boolean;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `a` | `any` |
+| `b` | `any` |
+
+#### Returns
+
+`boolean`
+
+***
+
 <a id="and"></a>
 
 ### and()
@@ -2378,7 +4470,7 @@ function collection(parent:
 
 ***
 
-<a id="collectiongroup"></a>
+<a id="collectiongroup-1"></a>
 
 ### collectionGroup()
 
@@ -2527,6 +4619,26 @@ Sandbox-only. `resolveSandbox` must return the owning Sandbox.
 
 ***
 
+<a id="deleteallpersistentcacheindexes"></a>
+
+### deleteAllPersistentCacheIndexes()
+
+```ts
+function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `indexManager` | [`PersistentCacheIndexManager`](#persistentcacheindexmanager) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
 <a id="deletedoc"></a>
 
 ### deleteDoc()
@@ -2590,7 +4702,27 @@ crash, but it also will not observe write-queuing behavior.
 
 ***
 
-<a id="doc"></a>
+<a id="disablepersistentcacheindexautocreation"></a>
+
+### disablePersistentCacheIndexAutoCreation()
+
+```ts
+function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `indexManager` | [`PersistentCacheIndexManager`](#persistentcacheindexmanager) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+<a id="doc-1"></a>
 
 ### doc()
 
@@ -2633,6 +4765,27 @@ function documentId(): FieldPath;
 
 ***
 
+<a id="documentsnapshotfromjson"></a>
+
+### documentSnapshotFromJSON()
+
+```ts
+function documentSnapshotFromJSON(db: Firestore, json: string): DocumentSnapshot;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `db` | [`Firestore`](#firestore) |
+| `json` | `string` |
+
+#### Returns
+
+[`DocumentSnapshot`](#documentsnapshot)
+
+***
+
 <a id="enableindexeddbpersistence"></a>
 
 ### enableIndexedDbPersistence()
@@ -2706,6 +4859,26 @@ network was never disabled locally, there is nothing to re-enable.
 
 ***
 
+<a id="enablepersistentcacheindexautocreation"></a>
+
+### enablePersistentCacheIndexAutoCreation()
+
+```ts
+function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `indexManager` | [`PersistentCacheIndexManager`](#persistentcacheindexmanager) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
 <a id="endat"></a>
 
 ### endAt()
@@ -2794,6 +4967,53 @@ Same as `endAt`, but EXCLUDES the document at the cursor — the
 
 ***
 
+<a id="ensurefirestoreconfigured"></a>
+
+### ensureFirestoreConfigured()
+
+```ts
+function ensureFirestoreConfigured(db: Firestore): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `db` | [`Firestore`](#firestore) |
+
+#### Returns
+
+`void`
+
+***
+
+<a id="executewrite"></a>
+
+### executeWrite()
+
+```ts
+function executeWrite<T>(db: Firestore, action: (batch: WriteBatch) => Promise<T>): Promise<T>;
+```
+
+#### Type Parameters
+
+| Type Parameter |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `db` | [`Firestore`](#firestore) |
+| `action` | (`batch`: [`WriteBatch`](#writebatch)) => `Promise`\<`T`\> |
+
+#### Returns
+
+`Promise`\<`T`\>
+
+***
+
 <a id="getadminfirestore"></a>
 
 ### getAdminFirestore()
@@ -3443,6 +5663,26 @@ const db = getFirestore(app);
 
 ***
 
+<a id="getpersistentcacheindexmanager"></a>
+
+### getPersistentCacheIndexManager()
+
+```ts
+function getPersistentCacheIndexManager(db: Firestore): PersistentCacheIndexManager;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `db` | [`Firestore`](#firestore) |
+
+#### Returns
+
+[`PersistentCacheIndexManager`](#persistentcacheindexmanager)
+
+***
+
 <a id="increment-2"></a>
 
 ### increment()
@@ -3542,7 +5782,31 @@ the simulator throws at execute time without one).
 
 ***
 
-<a id="memoryeagergarbagecollector"></a>
+<a id="loadbundle"></a>
+
+### loadBundle()
+
+```ts
+function loadBundle(db: Firestore, bundleData:
+  | string
+  | ArrayBuffer
+  | ReadableStream<Uint8Array<ArrayBufferLike>>): LoadBundleTask;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `db` | [`Firestore`](#firestore) |
+| `bundleData` | \| `string` \| `ArrayBuffer` \| `ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\> |
+
+#### Returns
+
+[`LoadBundleTask`](#loadbundletask)
+
+***
+
+<a id="memoryeagergarbagecollector-1"></a>
 
 ### memoryEagerGarbageCollector()
 
@@ -3550,7 +5814,7 @@ the simulator throws at execute time without one).
 function memoryEagerGarbageCollector(): MemoryGarbageCollector;
 ```
 
-Inert config token accepted by [memoryLocalCache](#memorylocalcache)'s `garbageCollector`.
+Inert config token accepted by [memoryLocalCache](#memorylocalcache-1)'s `garbageCollector`.
 
 #### Returns
 
@@ -3558,7 +5822,7 @@ Inert config token accepted by [memoryLocalCache](#memorylocalcache)'s `garbageC
 
 ***
 
-<a id="memorylocalcache"></a>
+<a id="memorylocalcache-1"></a>
 
 ### memoryLocalCache()
 
@@ -3568,7 +5832,7 @@ function memoryLocalCache(settings?: {
 }): LocalCache;
 ```
 
-Inert config token — the memory-cache counterpart of [persistentLocalCache](#persistentlocalcache).
+Inert config token — the memory-cache counterpart of [persistentLocalCache](#persistentlocalcache-1).
 
 #### Parameters
 
@@ -3583,7 +5847,7 @@ Inert config token — the memory-cache counterpart of [persistentLocalCache](#p
 
 ***
 
-<a id="memorylrugarbagecollector"></a>
+<a id="memorylrugarbagecollector-1"></a>
 
 ### memoryLruGarbageCollector()
 
@@ -3593,7 +5857,7 @@ function memoryLruGarbageCollector(_settings?: {
 }): MemoryGarbageCollector;
 ```
 
-Inert config token accepted by [memoryLocalCache](#memorylocalcache)'s `garbageCollector`.
+Inert config token accepted by [memoryLocalCache](#memorylocalcache-1)'s `garbageCollector`.
 
 #### Parameters
 
@@ -3608,6 +5872,27 @@ Inert config token accepted by [memoryLocalCache](#memorylocalcache)'s `garbageC
 
 ***
 
+<a id="namedquery"></a>
+
+### namedQuery()
+
+```ts
+function namedQuery(db: Firestore, name: string): Promise<Query<DocumentData>>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `db` | [`Firestore`](#firestore) |
+| `name` | `string` |
+
+#### Returns
+
+`Promise`\<[`Query`](#query)\<[`DocumentData`](#documentdata)\>\>
+
+***
+
 <a id="onsnapshot"></a>
 
 ### onSnapshot()
@@ -3674,6 +5959,35 @@ function onSnapshot<T>(
 
 ***
 
+<a id="onsnapshotresume"></a>
+
+### onSnapshotResume()
+
+```ts
+function onSnapshotResume(
+   query: Query,
+   snapshot: QuerySnapshot,
+   observerOrNext: unknown,
+   error?: unknown,
+   complete?: unknown): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `query` | [`Query`](#query) |
+| `snapshot` | [`QuerySnapshot`](#querysnapshot) |
+| `observerOrNext` | `unknown` |
+| `error?` | `unknown` |
+| `complete?` | `unknown` |
+
+#### Returns
+
+[`Unsubscribe`](#unsubscribe)
+
+***
+
 <a id="onsnapshotsinsync"></a>
 
 ### onSnapshotsInSync()
@@ -3753,7 +6067,7 @@ function orderBy(field: string | FieldPath, direction?: QueryOrderDirection): Qu
 
 ***
 
-<a id="persistentlocalcache"></a>
+<a id="persistentlocalcache-1"></a>
 
 ### persistentLocalCache()
 
@@ -3783,7 +6097,7 @@ tagged token `initializeFirestore` can accept without crashing.
 
 ***
 
-<a id="persistentmultipletabmanager"></a>
+<a id="persistentmultipletabmanager-1"></a>
 
 ### persistentMultipleTabManager()
 
@@ -3791,7 +6105,7 @@ tagged token `initializeFirestore` can accept without crashing.
 function persistentMultipleTabManager(): PersistentTabManager;
 ```
 
-Inert config token accepted by [persistentLocalCache](#persistentlocalcache)'s `tabManager`.
+Inert config token accepted by [persistentLocalCache](#persistentlocalcache-1)'s `tabManager`.
 
 #### Returns
 
@@ -3799,7 +6113,7 @@ Inert config token accepted by [persistentLocalCache](#persistentlocalcache)'s `
 
 ***
 
-<a id="persistentsingletabmanager"></a>
+<a id="persistentsingletabmanager-1"></a>
 
 ### persistentSingleTabManager()
 
@@ -3809,7 +6123,7 @@ function persistentSingleTabManager(_settings?: {
 }): PersistentTabManager;
 ```
 
-Inert config token accepted by [persistentLocalCache](#persistentlocalcache)'s `tabManager`.
+Inert config token accepted by [persistentLocalCache](#persistentlocalcache-1)'s `tabManager`.
 
 #### Parameters
 
@@ -3874,6 +6188,27 @@ function queryEqual(a: Query, b: Query): boolean;
 
 ***
 
+<a id="querysnapshotfromjson"></a>
+
+### querySnapshotFromJSON()
+
+```ts
+function querySnapshotFromJSON(db: Firestore, json: string): QuerySnapshot;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `db` | [`Firestore`](#firestore) |
+| `json` | `string` |
+
+#### Returns
+
+[`QuerySnapshot`](#querysnapshot)
+
+***
+
 <a id="refequal"></a>
 
 ### refEqual()
@@ -3917,7 +6252,7 @@ options?: TransactionOptions): Promise<R>;
 | Parameter | Type |
 | :------ | :------ |
 | `db` | [`Firestore`](#firestore) |
-| `fn` | (`tx`: [`Transaction`](pyric-admin-firestore-reference-api.md#transaction)) => `R` \| `Promise`\<`R`\> |
+| `fn` | (`tx`: [`Transaction`](#transaction)) => `R` \| `Promise`\<`R`\> |
 | `options?` | [`TransactionOptions`](#transactionoptions) |
 
 #### Returns
@@ -3971,6 +6306,27 @@ options?: SetOptions): Promise<void>;
 
 ***
 
+<a id="setindexconfiguration"></a>
+
+### setIndexConfiguration()
+
+```ts
+function setIndexConfiguration(db: Firestore, configuration: string | IndexConfiguration): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `db` | [`Firestore`](#firestore) |
+| `configuration` | `string` \| [`IndexConfiguration`](#indexconfiguration) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
 <a id="setloglevel"></a>
 
 ### setLogLevel()
@@ -4409,4 +6765,4 @@ function writeBatch(db: Firestore): WriteBatch;
 
 #### Returns
 
-[`WriteBatch`](pyric-admin-firestore-reference-api.md#writebatch)
+[`WriteBatch`](#writebatch)