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

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

@@ -875,6 +875,8 @@ A point-in-time view of one document.
 | :------ | :------ | :------ |
 | <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`\> |
 
 #### Methods
 
@@ -1162,6 +1164,24 @@ applySandbox(q: Query): Query;
 
 [`Query`](pyric-admin-firestore-reference-api.md#query)
 
+<a id="preparesandbox"></a>
+
+##### prepareSandbox()?
+
+```ts
+optional prepareSandbox(owner: object): QueryConstraint;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `owner` | `object` |
+
+###### Returns
+
+[`QueryConstraint`](#queryconstraint)
+
 ***
 
 <a id="querydocumentsnapshot"></a>
@@ -1189,6 +1209,8 @@ callbacks. Mirrors the JS SDK's narrowing.
 | :------ | :------ | :------ |
 | <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
 
@@ -1228,6 +1250,7 @@ A point-in-time view of a query result.
 | :------ | :------ | :------ |
 | <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` |
 
 ***
@@ -1859,6 +1882,19 @@ 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
@@ -1879,6 +1915,20 @@ matching the JS SDK's effective behavior).
 
 ***
 
+<a id="transactionoptions"></a>
+
+### TransactionOptions
+
+Options accepted by the modular Web-SDK-shaped `runTransaction`.
+
+#### Properties
+
+| Property | Type |
+| :------ | :------ |
+| <a id="maxattempts"></a> `maxAttempts?` | `number` |
+
+***
+
 <a id="userauth"></a>
 
 ### UserAuth
@@ -2042,7 +2092,7 @@ Mirrors `firebase/firestore`'s `LogLevel` union.
 ### OrderDirection
 
 ```ts
-type OrderDirection = "asc" | "desc";
+type OrderDirection = QueryOrderDirection;
 ```
 
 ***
@@ -2076,17 +2126,7 @@ type Unsubscribe = () => void;
 ### WhereFilterOp
 
 ```ts
-type WhereFilterOp =
-  | "<"
-  | "<="
-  | "=="
-  | "!="
-  | ">="
-  | ">"
-  | "in"
-  | "not-in"
-  | "array-contains"
-  | "array-contains-any";
+type WhereFilterOp = QueryWhereFilterOp;
 ```
 
 ***
@@ -2601,17 +2641,9 @@ function documentId(): FieldPath;
 function enableIndexedDbPersistence(db: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;
 ```
 
-Sandbox: no-op success. The sandbox's default persistence (IndexedDB
-on the SharedWorker/serve path, or whatever backend `enablePersistence`
-was configured with) already caches every write — this call has
-nothing left to enable. Resolves immediately.
-
-Unlike the real SDK, this does NOT reject with `'failed-precondition'`
-when called after other Firestore ops have already run. The guard
-exists in the real SDK to protect an actual cache-initialization
-race; the sandbox has no such race (there's no cache to initialize),
-so enforcing the same restriction would only make app code that
-calls this defensively at startup fail for no local reason.
+Enables the persistence lifecycle before first use. As in the browser SDK,
+initialization after another Firestore operation rejects with
+`failed-precondition`.
 
 #### Parameters
 
@@ -3656,12 +3688,9 @@ function onSnapshotsInSync(db: Firestore, observerOrCallback:
 }): Unsubscribe;
 ```
 
-Sandbox: fires the callback once the current snapshot-delivery
-microtask queue settles — the closest honest approximation of "every
-active listener has delivered its latest state" available without a
-true cross-listener sync signal (the sandbox doesn't track one).
-This is NOT the real SDK's guarantee (which is scoped to actual
-server round-trips); it is scoped to local delivery only.
+Registers a service-scoped synchronization observer. It receives an
+initial signal and a batched signal after snapshot listeners deliver their
+latest local state, matching the production-observed callback ordering.
 
 #### Parameters
 
@@ -3708,7 +3737,7 @@ Mirrors `firebase/firestore`'s `or(...filters)` shape.
 ### orderBy()
 
 ```ts
-function orderBy(field: string | FieldPath, direction?: OrderDirection): QueryConstraint;
+function orderBy(field: string | FieldPath, direction?: QueryOrderDirection): QueryConstraint;
 ```
 
 #### Parameters
@@ -3716,7 +3745,7 @@ function orderBy(field: string | FieldPath, direction?: OrderDirection): QueryCo
 | Parameter | Type |
 | :------ | :------ |
 | `field` | `string` \| [`FieldPath`](#fieldpath) |
-| `direction?` | [`OrderDirection`](#orderdirection) |
+| `direction?` | `QueryOrderDirection` |
 
 #### Returns
 
@@ -3871,7 +3900,10 @@ function refEqual(a: DocumentReference, b: DocumentReference): boolean;
 ### runTransaction()
 
 ```ts
-function runTransaction<R>(db: Firestore, fn: (tx: Transaction) => R | Promise<R>): Promise<R>;
+function runTransaction<R>(
+   db: Firestore,
+   fn: (tx: Transaction) => R | Promise<R>,
+options?: TransactionOptions): Promise<R>;
 ```
 
 #### Type Parameters
@@ -3886,6 +3918,7 @@ function runTransaction<R>(db: Firestore, fn: (tx: Transaction) => R | Promise<R
 | :------ | :------ |
 | `db` | [`Firestore`](#firestore) |
 | `fn` | (`tx`: [`Transaction`](pyric-admin-firestore-reference-api.md#transaction)) => `R` \| `Promise`\<`R`\> |
+| `options?` | [`TransactionOptions`](#transactionoptions) |
 
 #### Returns
 
@@ -4119,20 +4152,9 @@ Factory: sum-of-`field` aggregate.
 function terminate(db: Firestore): Promise<void>;
 ```
 
-Sandbox: genuinely tears the target down by calling
-`Sandbox.dispose()` — NOT a pure no-op like the rest of this family.
-`dispose()` tears down listener registries on the sandbox's
-environment without replacing it (idempotent, doesn't touch data).
-This is the honest mapping of "terminate this Firestore instance":
-a real app that calls `terminate(db)` expects listeners to stop and
-the instance to be unusable for further meaningful work, and
-`dispose()` delivers exactly that for the sandbox.
-
-Caveat: `dispose()` operates on the whole `Sandbox`, not a
-Firestore-only slice of it — if `pyric/database` or `pyric/storage`
-share the same `Sandbox`, their listener registries are torn down
-too. This differs from the real SDK, where `terminate()` only
-affects the one `Firestore` instance. Documented divergence.
+Terminates this Firestore service target only. Held references become
+unusable and owned listeners stop, while sibling Firestore handles and
+other services on the same Sandbox remain alive.
 
 #### Parameters
 
@@ -4202,12 +4224,8 @@ function vector(values?: number[]): VectorValue;
 function waitForPendingWrites(db: Firestore): Promise<void>;
 ```
 
-Sandbox: resolves immediately. The real SDK's version waits for
-queued writes to reach the server; the sandbox has no server to wait
-on — every write it accepts is already committed to the local store
-by the time the write's own promise resolves, so by the time this is
-called there are, honestly, never any writes still pending a round
-trip.
+Resolves after writes that were issued while offline receive their modeled
+acknowledgement on reconnect.
 
 #### Parameters
 
@@ -4228,7 +4246,7 @@ trip.
 ```ts
 function where(
    field: string | FieldPath,
-   op: WhereFilterOp,
+   op: QueryWhereFilterOp,
    value: unknown): QueryConstraint;
 ```
 
@@ -4237,7 +4255,7 @@ function where(
 | Parameter | Type |
 | :------ | :------ |
 | `field` | `string` \| [`FieldPath`](#fieldpath) |
-| `op` | [`WhereFilterOp`](#wherefilterop) |
+| `op` | `QueryWhereFilterOp` |
 | `value` | `unknown` |
 
 #### Returns