@nkzw/fate 0.1.2 → 1.0.0-rc.0

package/docs/api/classes/FateClient.md

@@ -0,0 +1,832 @@
+# Class: FateClient\<Roots, Mutations\>
+
+Defined in: [packages/fate/src/client.ts:361](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L361)
+
+Core client that normalizes records, manages the view cache, and coordinates
+data fetching.
+
+## Type Parameters
+
+### Roots
+
+`Roots` *extends* [`FateRoots`](../type-aliases/FateRoots.md)
+
+### Mutations
+
+`Mutations` *extends* [`FateMutations`](../type-aliases/FateMutations.md)
+
+## Constructors
+
+### Constructor
+
+> **new FateClient**\<`Roots`, `Mutations`\>(`options`): `FateClient`\<`Roots`, `Mutations`\>
+
+Defined in: [packages/fate/src/client.ts:400](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L400)
+
+#### Parameters
+
+##### options
+
+`FateClientOptions`\<`Roots`, `Mutations`\>
+
+#### Returns
+
+`FateClient`\<`Roots`, `Mutations`\>
+
+## Properties
+
+### actions
+
+> `readonly` **actions**: `MutationTreeFromRecord`\<`Mutations`\>
+
+Defined in: [packages/fate/src/client.ts:396](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L396)
+
+***
+
+### mutations
+
+> `readonly` **mutations**: `MutationTreeFromRecord`\<`Mutations`\>
+
+Defined in: [packages/fate/src/client.ts:397](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L397)
+
+***
+
+### roots
+
+> `readonly` **roots**: `Roots`
+
+Defined in: [packages/fate/src/client.ts:398](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L398)
+
+***
+
+### store
+
+> `readonly` **store**: `Store`
+
+Defined in: [packages/fate/src/client.ts:389](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L389)
+
+## Methods
+
+### assertLiveConnectionSupport()
+
+> **assertLiveConnectionSupport**(): `void`
+
+Defined in: [packages/fate/src/client.ts:845](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L845)
+
+#### Returns
+
+`void`
+
+***
+
+### assertLiveViewSupport()
+
+> **assertLiveViewSupport**(): `void`
+
+Defined in: [packages/fate/src/client.ts:837](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L837)
+
+#### Returns
+
+`void`
+
+***
+
+### clearOptimisticUpdate()
+
+> **clearOptimisticUpdate**(`token`): `void`
+
+Defined in: [packages/fate/src/client.ts:1496](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1496)
+
+#### Parameters
+
+##### token
+
+`number` \| `null`
+
+#### Returns
+
+`void`
+
+***
+
+### deleteRecord()
+
+> **deleteRecord**(`type`, `id`, `snapshots?`, `listSnapshots?`): `void`
+
+Defined in: [packages/fate/src/client.ts:650](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L650)
+
+#### Parameters
+
+##### type
+
+`string`
+
+##### id
+
+`string` \| `number`
+
+##### snapshots?
+
+`Map`\<`string`, `Readonly`\<\{ `mask?`: `FieldMask`; `record?`: [`FateRecord`](../type-aliases/FateRecord.md); \}\>\>
+
+##### listSnapshots?
+
+`Map`\<`string`, `Readonly`\<\{ `backwardPageLimit?`: `number`; `cursors?`: readonly (`string` \| `undefined`)[]; `forwardPageLimit?`: `number`; `ids`: readonly `string`[]; `liveAfterIds?`: readonly `string`[]; `liveBeforeIds?`: readonly `string`[]; `pagination?`: [`Pagination`](../type-aliases/Pagination.md); `pendingAfterIds?`: readonly `string`[]; `pendingBeforeIds?`: readonly `string`[]; \}\>\>
+
+#### Returns
+
+`void`
+
+***
+
+### executeMutation()
+
+> **executeMutation**(`key`, `input`, `select`, `options?`): `Promise`\<`unknown`\>
+
+Defined in: [packages/fate/src/client.ts:594](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L594)
+
+#### Parameters
+
+##### key
+
+`string`
+
+##### input
+
+`unknown`
+
+##### select
+
+`Set`\<`string`\>
+
+##### options?
+
+###### args?
+
+[`FateRecord`](../type-aliases/FateRecord.md)
+
+###### plan?
+
+`SelectionPlan`
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+***
+
+### filterSelectionForPendingOptimistics()
+
+> **filterSelectionForPendingOptimistics**(`entityId`, `select`, `options?`): `Set`\<`string`\>
+
+Defined in: [packages/fate/src/client.ts:1559](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1559)
+
+#### Parameters
+
+##### entityId
+
+`string` \| `null`
+
+##### select
+
+`Set`\<`string`\>
+
+##### options?
+
+###### excludeToken?
+
+`number` \| `null`
+
+#### Returns
+
+`Set`\<`string`\>
+
+***
+
+### gc()
+
+> **gc**(): `void`
+
+Defined in: [packages/fate/src/client.ts:1868](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1868)
+
+Removes records and lists that are not reachable from retained requests or
+the release buffer.
+
+Garbage collection is scheduled automatically when retained requests are
+released. Calling this method manually is mainly useful in tests and custom
+memory-management flows.
+
+#### Returns
+
+`void`
+
+***
+
+### getPendingOptimisticMask()
+
+> **getPendingOptimisticMask**(`entityId`, `options?`): `FieldMask` \| `null`
+
+Defined in: [packages/fate/src/client.ts:1518](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1518)
+
+#### Parameters
+
+##### entityId
+
+`string` \| `null`
+
+##### options?
+
+###### excludeToken?
+
+`number` \| `null`
+
+#### Returns
+
+`FieldMask` \| `null`
+
+***
+
+### getRequestKey()
+
+> **getRequestKey**(`request`): `string`
+
+Defined in: [packages/fate/src/client.ts:2086](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L2086)
+
+#### Parameters
+
+##### request
+
+[`Request`](../type-aliases/Request.md)
+
+#### Returns
+
+`string`
+
+***
+
+### getRequestResult()
+
+> **getRequestResult**\<`R`\>(`request`): [`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>
+
+Defined in: [packages/fate/src/client.ts:2226](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L2226)
+
+#### Type Parameters
+
+##### R
+
+`R` *extends* [`Request`](../type-aliases/Request.md)
+
+#### Parameters
+
+##### request
+
+`R`
+
+#### Returns
+
+[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>
+
+***
+
+### getTypeConfig()
+
+> **getTypeConfig**(`type`): [`TypeConfig`](../type-aliases/TypeConfig.md)
+
+Defined in: [packages/fate/src/client.ts:586](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L586)
+
+#### Parameters
+
+##### type
+
+`string`
+
+#### Returns
+
+[`TypeConfig`](../type-aliases/TypeConfig.md)
+
+***
+
+### loadConnection()
+
+> **loadConnection**\<`V`\>(`view`, `connection`, `args`, `options?`): `Promise`\<`Readonly`\<\{ `backwardPageLimit?`: `number`; `cursors?`: readonly (`string` \| `undefined`)[]; `forwardPageLimit?`: `number`; `ids`: readonly `string`[]; `liveAfterIds?`: readonly `string`[]; `liveBeforeIds?`: readonly `string`[]; `pagination?`: [`Pagination`](../type-aliases/Pagination.md); `pendingAfterIds?`: readonly `string`[]; `pendingBeforeIds?`: readonly `string`[]; \}\> \| `undefined`\>
+
+Defined in: [packages/fate/src/client.ts:1583](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1583)
+
+#### Type Parameters
+
+##### V
+
+`V` *extends* [`View`](../type-aliases/View.md)\<`any`, `any`\>
+
+#### Parameters
+
+##### view
+
+`V`
+
+##### connection
+
+[`ConnectionMetadata`](../type-aliases/ConnectionMetadata.md)
+
+##### args
+
+`Record`\<`string`, `unknown`\>
+
+##### options?
+
+###### direction?
+
+`"forward"` \| `"backward"`
+
+#### Returns
+
+`Promise`\<`Readonly`\<\{ `backwardPageLimit?`: `number`; `cursors?`: readonly (`string` \| `undefined`)[]; `forwardPageLimit?`: `number`; `ids`: readonly `string`[]; `liveAfterIds?`: readonly `string`[]; `liveBeforeIds?`: readonly `string`[]; `pagination?`: [`Pagination`](../type-aliases/Pagination.md); `pendingAfterIds?`: readonly `string`[]; `pendingBeforeIds?`: readonly `string`[]; \}\> \| `undefined`\>
+
+***
+
+### prepareRequestForRender()
+
+> **prepareRequestForRender**\<`R`\>(`request`, `options`): `Readonly`\<\{ `promise`: `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>; `requestKey`: `string`; \}\>
+
+Defined in: [packages/fate/src/client.ts:1753](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1753)
+
+#### Type Parameters
+
+##### R
+
+`R` *extends* [`Request`](../type-aliases/Request.md)
+
+#### Parameters
+
+##### request
+
+`R`
+
+##### options
+
+`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); \}\> \| `undefined`
+
+#### Returns
+
+`Readonly`\<\{ `promise`: `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>; `requestKey`: `string`; \}\>
+
+***
+
+### readView()
+
+> **readView**\<`T`, `S`, `V`\>(`view`, `ref`): [`FateThenable`](../interfaces/FateThenable.md)\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: [`ViewData`](../type-aliases/ViewData.md)\<`T`, `S`\>; \}\>\>
+
+Defined in: [packages/fate/src/client.ts:713](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L713)
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Entity`](../type-aliases/Entity.md)
+
+##### S
+
+`S` *extends* [`Selection`](../type-aliases/Selection.md)\<`T`\>
+
+##### V
+
+`V` *extends* [`View`](../type-aliases/View.md)\<`T`, `S`\>
+
+#### Parameters
+
+##### view
+
+`V`
+
+##### ref
+
+[`ViewRef`](../type-aliases/ViewRef.md)\<`T`\[`"__typename"`\]\>
+
+#### Returns
+
+[`FateThenable`](../interfaces/FateThenable.md)\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: [`ViewData`](../type-aliases/ViewData.md)\<`T`, `S`\>; \}\>\>
+
+***
+
+### ref()
+
+> **ref**\<`T`\>(`type`, `id`, `view`): [`ViewRef`](../type-aliases/ViewRef.md)\<`T`\[`"__typename"`\]\>
+
+Defined in: [packages/fate/src/client.ts:700](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L700)
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Entity`](../type-aliases/Entity.md)
+
+#### Parameters
+
+##### type
+
+`T`\[`"__typename"`\]
+
+##### id
+
+`string` \| `number`
+
+##### view
+
+[`View`](../type-aliases/View.md)\<`T`, [`Selection`](../type-aliases/Selection.md)\<`T`\>\>
+
+#### Returns
+
+[`ViewRef`](../type-aliases/ViewRef.md)\<`T`\[`"__typename"`\]\>
+
+***
+
+### registerOptimisticUpdate()
+
+> **registerOptimisticUpdate**(`entityId`, `select`): `number` \| `null`
+
+Defined in: [packages/fate/src/client.ts:1477](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1477)
+
+#### Parameters
+
+##### entityId
+
+`string` \| `null`
+
+##### select
+
+`ReadonlySet`\<`string`\>
+
+#### Returns
+
+`number` \| `null`
+
+***
+
+### registerPendingOptimisticMutation()
+
+> **registerPendingOptimisticMutation**(`entityId`, `promise`): `void`
+
+Defined in: [packages/fate/src/client.ts:1447](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1447)
+
+#### Parameters
+
+##### entityId
+
+`string`
+
+##### promise
+
+`Promise`\<`unknown`\>
+
+#### Returns
+
+`void`
+
+***
+
+### releaseRequest()
+
+> **releaseRequest**(`request`, `mode`): `void`
+
+Defined in: [packages/fate/src/client.ts:1807](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1807)
+
+#### Parameters
+
+##### request
+
+[`Request`](../type-aliases/Request.md)
+
+##### mode
+
+[`RequestMode`](../type-aliases/RequestMode.md)
+
+#### Returns
+
+`void`
+
+***
+
+### releaseRequestKey()
+
+> **releaseRequestKey**(`requestKey`, `mode`): `void`
+
+Defined in: [packages/fate/src/client.ts:1811](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1811)
+
+#### Parameters
+
+##### requestKey
+
+`string`
+
+##### mode
+
+[`RequestMode`](../type-aliases/RequestMode.md)
+
+#### Returns
+
+`void`
+
+***
+
+### request()
+
+> **request**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
+
+Defined in: [packages/fate/src/client.ts:1736](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1736)
+
+#### Type Parameters
+
+##### R
+
+`R` *extends* [`Request`](../type-aliases/Request.md)
+
+#### Parameters
+
+##### request
+
+`R`
+
+##### options?
+
+`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); \}\>
+
+#### Returns
+
+`Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
+
+***
+
+### requestForRender()
+
+> **requestForRender**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
+
+Defined in: [packages/fate/src/client.ts:1746](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1746)
+
+#### Type Parameters
+
+##### R
+
+`R` *extends* [`Request`](../type-aliases/Request.md)
+
+#### Parameters
+
+##### request
+
+`R`
+
+##### options?
+
+`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); \}\>
+
+#### Returns
+
+`Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
+
+***
+
+### resolveOptimisticEntity()
+
+> **resolveOptimisticEntity**(`optimisticEntityId`, `resolvedEntityId`): `void`
+
+Defined in: [packages/fate/src/client.ts:1472](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1472)
+
+#### Parameters
+
+##### optimisticEntityId
+
+`string`
+
+##### resolvedEntityId
+
+`string`
+
+#### Returns
+
+`void`
+
+***
+
+### restore()
+
+> **restore**(`id`, `snapshot`): `void`
+
+Defined in: [packages/fate/src/client.ts:668](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L668)
+
+#### Parameters
+
+##### id
+
+`string`
+
+##### snapshot
+
+[`Snapshot`](../type-aliases/Snapshot.md)
+
+#### Returns
+
+`void`
+
+***
+
+### restoreList()
+
+> **restoreList**(`name`, `list?`): `void`
+
+Defined in: [packages/fate/src/client.ts:673](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L673)
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### list?
+
+`Readonly`\<\{ `backwardPageLimit?`: `number`; `cursors?`: readonly (`string` \| `undefined`)[]; `forwardPageLimit?`: `number`; `ids`: readonly `string`[]; `liveAfterIds?`: readonly `string`[]; `liveBeforeIds?`: readonly `string`[]; `pagination?`: [`Pagination`](../type-aliases/Pagination.md); `pendingAfterIds?`: readonly `string`[]; `pendingBeforeIds?`: readonly `string`[]; \}\>
+
+#### Returns
+
+`void`
+
+***
+
+### retain()
+
+> **retain**(`request`): `RetainHandle`
+
+Defined in: [packages/fate/src/client.ts:1842](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1842)
+
+Keeps the records and lists reachable from a request alive until the
+returned handle is disposed.
+
+`useRequest` calls this automatically while the component is mounted.
+Use it directly for non-React request lifetimes, tests, or preloaded data
+that must survive manual garbage collection.
+
+#### Parameters
+
+##### request
+
+[`Request`](../type-aliases/Request.md)
+
+#### Returns
+
+`RetainHandle`
+
+***
+
+### retainRequestKey()
+
+> **retainRequestKey**(`requestKey`, `mode?`): `RetainHandle`
+
+Defined in: [packages/fate/src/client.ts:1823](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L1823)
+
+#### Parameters
+
+##### requestKey
+
+`string`
+
+##### mode?
+
+[`RequestMode`](../type-aliases/RequestMode.md)
+
+#### Returns
+
+`RetainHandle`
+
+***
+
+### rootListRef()
+
+> **rootListRef**(`entityId`, `rootView`): `Readonly`\<\{ `__typename`: `string`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\>
+
+Defined in: [packages/fate/src/client.ts:708](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L708)
+
+#### Parameters
+
+##### entityId
+
+`string`
+
+##### rootView
+
+[`View`](../type-aliases/View.md)\<`any`, `any`\>
+
+#### Returns
+
+`Readonly`\<\{ `__typename`: `string`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\>
+
+***
+
+### subscribeLiveListView()
+
+> **subscribeLiveListView**\<`V`\>(`view`, `connection`): () => `void`
+
+Defined in: [packages/fate/src/client.ts:937](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L937)
+
+#### Type Parameters
+
+##### V
+
+`V` *extends* [`View`](../type-aliases/View.md)\<`any`, `any`\>
+
+#### Parameters
+
+##### view
+
+`V`
+
+##### connection
+
+[`ConnectionMetadata`](../type-aliases/ConnectionMetadata.md)
+
+#### Returns
+
+() => `void`
+
+***
+
+### subscribeLiveView()
+
+> **subscribeLiveView**\<`T`, `S`, `V`\>(`view`, `ref`): () => `void`
+
+Defined in: [packages/fate/src/client.ts:853](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L853)
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Entity`](../type-aliases/Entity.md)
+
+##### S
+
+`S` *extends* [`Selection`](../type-aliases/Selection.md)\<`T`\>
+
+##### V
+
+`V` *extends* [`View`](../type-aliases/View.md)\<`T`, `S`\>
+
+#### Parameters
+
+##### view
+
+`V`
+
+##### ref
+
+[`ViewRef`](../type-aliases/ViewRef.md)\<`T`\[`"__typename"`\]\>
+
+#### Returns
+
+() => `void`
+
+***
+
+### write()
+
+> **write**(`type`, `data`, `select`, `snapshots?`, `plan?`, `pathPrefix?`, `blockedMask?`, `insert?`, `listSnapshots?`): `string`
+
+Defined in: [packages/fate/src/client.ts:626](https://github.com/nkzw-tech/fate/blob/d972c17c02c8292194208ab53c91f9216703a5a7/packages/fate/src/client.ts#L626)
+
+#### Parameters
+
+##### type
+
+`string`
+
+##### data
+
+[`FateRecord`](../type-aliases/FateRecord.md)
+
+##### select
+
+`ReadonlySet`\<`string`\>
+
+##### snapshots?
+
+`Map`\<`string`, `Readonly`\<\{ `mask?`: `FieldMask`; `record?`: [`FateRecord`](../type-aliases/FateRecord.md); \}\>\>
+
+##### plan?
+
+`SelectionPlan`
+
+##### pathPrefix?
+
+`string` \| `null`
+
+##### blockedMask?
+
+`FieldMask` \| `null`
+
+##### insert?
+
+`InsertPosition`
+
+##### listSnapshots?
+
+`Map`\<`string`, `Readonly`\<\{ `backwardPageLimit?`: `number`; `cursors?`: readonly (`string` \| `undefined`)[]; `forwardPageLimit?`: `number`; `ids`: readonly `string`[]; `liveAfterIds?`: readonly `string`[]; `liveBeforeIds?`: readonly `string`[]; `pagination?`: [`Pagination`](../type-aliases/Pagination.md); `pendingAfterIds?`: readonly `string`[]; `pendingBeforeIds?`: readonly `string`[]; \}\>\>
+
+#### Returns
+
+`string`