@livestore/livestore 0.4.0-dev.17 → 0.4.0-dev.19

package/docs/api/sync-cf/@livestore/namespaces/CfTypes/classes/URLSearchParams/index.md

@@ -0,0 +1,287 @@
+# URLSearchParams
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3270
+
+The **`URLSearchParams`** interface defines utility methods to work with the query string of a URL.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams)
+
+## Constructors
+
+### Constructor
+
+> **new URLSearchParams**(`init?`): `URLSearchParams`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3271
+
+#### Parameters
+
+##### init?
+
+`string` | `URLSearchParams` | `Record`\<`string`, `string`\> | \[`string`, `string`\][]
+
+#### Returns
+
+`URLSearchParams`
+
+## Accessors
+
+### size
+
+#### Get Signature
+
+> **get** **size**(): `number`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3283
+
+The **`size`** read-only property of the URLSearchParams interface indicates the total number of search parameter entries.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/size)
+
+##### Returns
+
+`number`
+
+## Methods
+
+### \[iterator\]()
+
+> **\[iterator\]**(): `IterableIterator`\<\[`string`, `string`\]\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3343
+
+#### Returns
+
+`IterableIterator`\<\[`string`, `string`\]\>
+
+***
+
+### append()
+
+> **append**(`name`, `value`): `void`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3289
+
+The **`append()`** method of the URLSearchParams interface appends a specified key/value pair as a new search parameter.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/append)
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### value
+
+`string`
+
+#### Returns
+
+`void`
+
+***
+
+### delete()
+
+> **delete**(`name`): `void`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3295
+
+The **`delete()`** method of the URLSearchParams interface deletes specified parameters and their associated value(s) from the list of all search parameters.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/delete)
+
+#### Parameters
+
+##### name
+
+`string`
+
+#### Returns
+
+`void`
+
+***
+
+### entries()
+
+> **entries**(): `IterableIterator`\<\[`string`, `string`\]\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3327
+
+#### Returns
+
+`IterableIterator`\<\[`string`, `string`\]\>
+
+***
+
+### forEach()
+
+> **forEach**\<`This`\>(`callback`, `thisArg?`): `void`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3332
+
+#### Type Parameters
+
+##### This
+
+`This` = `unknown`
+
+#### Parameters
+
+##### callback
+
+(`this`, `value`, `key`, `parent`) => `void`
+
+##### thisArg?
+
+`This`
+
+#### Returns
+
+`void`
+
+***
+
+### get()
+
+> **get**(`name`): `null` \| `string`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3301
+
+The **`get()`** method of the URLSearchParams interface returns the first value associated to the given search parameter.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/get)
+
+#### Parameters
+
+##### name
+
+`string`
+
+#### Returns
+
+`null` \| `string`
+
+***
+
+### getAll()
+
+> **getAll**(`name`): `string`[]
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3307
+
+The **`getAll()`** method of the URLSearchParams interface returns all the values associated with a given search parameter as an array.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/getAll)
+
+#### Parameters
+
+##### name
+
+`string`
+
+#### Returns
+
+`string`[]
+
+***
+
+### has()
+
+> **has**(`name`): `boolean`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3313
+
+The **`has()`** method of the URLSearchParams interface returns a boolean value that indicates whether the specified parameter is in the search parameters.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/has)
+
+#### Parameters
+
+##### name
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### keys()
+
+> **keys**(): `IterableIterator`\<`string`\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3329
+
+#### Returns
+
+`IterableIterator`\<`string`\>
+
+***
+
+### set()
+
+> **set**(`name`, `value`): `void`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3319
+
+The **`set()`** method of the URLSearchParams interface sets the value associated with a given search parameter to the given value.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/set)
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### value
+
+`string`
+
+#### Returns
+
+`void`
+
+***
+
+### sort()
+
+> **sort**(): `void`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3325
+
+The **`URLSearchParams.sort()`** method sorts all key/value pairs contained in this object in place and returns `undefined`.
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/sort)
+
+#### Returns
+
+`void`
+
+***
+
+### toString()
+
+> **toString**(): `string`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3342
+
+#### Returns
+
+`string`
+
+***
+
+### values()
+
+> **values**(): `IterableIterator`\<`string`\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:3331
+
+#### Returns
+
+`IterableIterator`\<`string`\>

package/docs/api/sync-cf/@livestore/namespaces/CfTypes/classes/Vectorize/index.md

@@ -0,0 +1,189 @@
+# Vectorize
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:9998
+
+A Vectorize Vector Search Index for querying vectors/embeddings.
+
+Mutations in this version are async, returning a mutation id.
+
+## Constructors
+
+### Constructor
+
+> **new Vectorize**(): `Vectorize`
+
+#### Returns
+
+`Vectorize`
+
+## Methods
+
+### deleteByIds()
+
+> **deleteByIds**(`ids`): `Promise`\<[`VectorizeAsyncMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeasyncmutation/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:10041
+
+Delete a list of vectors with a matching id.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+List of vector ids that should be deleted.
+
+#### Returns
+
+`Promise`\<[`VectorizeAsyncMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeasyncmutation/)\>
+
+A promise that resolves with a unique identifier of a mutation containing the delete changeset.
+
+***
+
+### describe()
+
+> **describe**(): `Promise`\<[`VectorizeIndexInfo`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeindexinfo/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:10003
+
+Get information about the currently bound index.
+
+#### Returns
+
+`Promise`\<[`VectorizeIndexInfo`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeindexinfo/)\>
+
+A promise that resolves with information about the current index.
+
+***
+
+### getByIds()
+
+> **getByIds**(`ids`): `Promise`\<[`VectorizeVector`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevector/)[]\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:10047
+
+Get a list of vectors with a matching id.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+List of vector ids that should be returned.
+
+#### Returns
+
+`Promise`\<[`VectorizeVector`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevector/)[]\>
+
+A promise that resolves with the raw unscored vectors matching the id set.
+
+***
+
+### insert()
+
+> **insert**(`vectors`): `Promise`\<[`VectorizeAsyncMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeasyncmutation/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:10029
+
+Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
+
+#### Parameters
+
+##### vectors
+
+[`VectorizeVector`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevector/)[]
+
+List of vectors that will be inserted.
+
+#### Returns
+
+`Promise`\<[`VectorizeAsyncMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeasyncmutation/)\>
+
+A promise that resolves with a unique identifier of a mutation containing the insert changeset.
+
+***
+
+### query()
+
+> **query**(`vector`, `options?`): `Promise`\<[`VectorizeMatches`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizematches/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:10010
+
+Use the provided vector to perform a similarity search across the index.
+
+#### Parameters
+
+##### vector
+
+Input vector that will be used to drive the similarity search.
+
+`number`[] | [`VectorFloatArray`](/api/sync-cf/livestore/namespaces/cftypes/type-aliases/vectorfloatarray/)
+
+##### options?
+
+[`VectorizeQueryOptions`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizequeryoptions/)
+
+Configuration options to massage the returned data.
+
+#### Returns
+
+`Promise`\<[`VectorizeMatches`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizematches/)\>
+
+A promise that resolves with matched and scored vectors.
+
+***
+
+### queryById()
+
+> **queryById**(`vectorId`, `options?`): `Promise`\<[`VectorizeMatches`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizematches/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:10020
+
+Use the provided vector-id to perform a similarity search across the index.
+
+#### Parameters
+
+##### vectorId
+
+`string`
+
+Id for a vector in the index against which the index should be queried.
+
+##### options?
+
+[`VectorizeQueryOptions`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizequeryoptions/)
+
+Configuration options to massage the returned data.
+
+#### Returns
+
+`Promise`\<[`VectorizeMatches`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizematches/)\>
+
+A promise that resolves with matched and scored vectors.
+
+***
+
+### upsert()
+
+> **upsert**(`vectors`): `Promise`\<[`VectorizeAsyncMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeasyncmutation/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:10035
+
+Upsert a list of vectors into the index dataset. If a provided id exists, it will be replaced with the new values.
+
+#### Parameters
+
+##### vectors
+
+[`VectorizeVector`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevector/)[]
+
+List of vectors that will be upserted.
+
+#### Returns
+
+`Promise`\<[`VectorizeAsyncMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeasyncmutation/)\>
+
+A promise that resolves with a unique identifier of a mutation containing the upsert changeset.

package/docs/api/sync-cf/@livestore/namespaces/CfTypes/classes/VectorizeIndex/index.md

@@ -0,0 +1,160 @@
+# VectorizeIndex
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:9952
+
+A Vectorize Vector Search Index for querying vectors/embeddings.
+
+This type is exclusively for the Vectorize **beta** and will be deprecated once Vectorize RC is released.
+See [Vectorize](/api/sync-cf/livestore/namespaces/cftypes/classes/vectorize/) for its new implementation.
+
+## Constructors
+
+### Constructor
+
+> **new VectorizeIndex**(): `VectorizeIndex`
+
+#### Returns
+
+`VectorizeIndex`
+
+## Methods
+
+### deleteByIds()
+
+> **deleteByIds**(`ids`): `Promise`\<[`VectorizeVectorMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevectormutation/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:9985
+
+Delete a list of vectors with a matching id.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+List of vector ids that should be deleted.
+
+#### Returns
+
+`Promise`\<[`VectorizeVectorMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevectormutation/)\>
+
+A promise that resolves with the ids & count of records that were successfully processed (and thus deleted).
+
+***
+
+### describe()
+
+> **describe**(): `Promise`\<[`VectorizeIndexDetails`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeindexdetails/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:9957
+
+Get information about the currently bound index.
+
+#### Returns
+
+`Promise`\<[`VectorizeIndexDetails`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizeindexdetails/)\>
+
+A promise that resolves with information about the current index.
+
+***
+
+### getByIds()
+
+> **getByIds**(`ids`): `Promise`\<[`VectorizeVector`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevector/)[]\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:9991
+
+Get a list of vectors with a matching id.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+List of vector ids that should be returned.
+
+#### Returns
+
+`Promise`\<[`VectorizeVector`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevector/)[]\>
+
+A promise that resolves with the raw unscored vectors matching the id set.
+
+***
+
+### insert()
+
+> **insert**(`vectors`): `Promise`\<[`VectorizeVectorMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevectormutation/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:9973
+
+Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
+
+#### Parameters
+
+##### vectors
+
+[`VectorizeVector`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevector/)[]
+
+List of vectors that will be inserted.
+
+#### Returns
+
+`Promise`\<[`VectorizeVectorMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevectormutation/)\>
+
+A promise that resolves with the ids & count of records that were successfully processed.
+
+***
+
+### query()
+
+> **query**(`vector`, `options?`): `Promise`\<[`VectorizeMatches`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizematches/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:9964
+
+Use the provided vector to perform a similarity search across the index.
+
+#### Parameters
+
+##### vector
+
+Input vector that will be used to drive the similarity search.
+
+`number`[] | [`VectorFloatArray`](/api/sync-cf/livestore/namespaces/cftypes/type-aliases/vectorfloatarray/)
+
+##### options?
+
+[`VectorizeQueryOptions`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizequeryoptions/)
+
+Configuration options to massage the returned data.
+
+#### Returns
+
+`Promise`\<[`VectorizeMatches`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizematches/)\>
+
+A promise that resolves with matched and scored vectors.
+
+***
+
+### upsert()
+
+> **upsert**(`vectors`): `Promise`\<[`VectorizeVectorMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevectormutation/)\>
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:9979
+
+Upsert a list of vectors into the index dataset. If a provided id exists, it will be replaced with the new values.
+
+#### Parameters
+
+##### vectors
+
+[`VectorizeVector`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevector/)[]
+
+List of vectors that will be upserted.
+
+#### Returns
+
+`Promise`\<[`VectorizeVectorMutation`](/api/sync-cf/livestore/namespaces/cftypes/interfaces/vectorizevectormutation/)\>
+
+A promise that resolves with the ids & count of records that were successfully processed.

package/docs/api/sync-cf/@livestore/namespaces/CfTypes/classes/WebSocketRequestResponsePair/index.md

@@ -0,0 +1,53 @@
+# WebSocketRequestResponsePair
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:720
+
+## Constructors
+
+### Constructor
+
+> **new WebSocketRequestResponsePair**(`request`, `response`): `WebSocketRequestResponsePair`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:721
+
+#### Parameters
+
+##### request
+
+`string`
+
+##### response
+
+`string`
+
+#### Returns
+
+`WebSocketRequestResponsePair`
+
+## Accessors
+
+### request
+
+#### Get Signature
+
+> **get** **request**(): `string`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:722
+
+##### Returns
+
+`string`
+
+***
+
+### response
+
+#### Get Signature
+
+> **get** **response**(): `string`
+
+Defined in: node\_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node\_modules/@cloudflare/workers-types/index.ts:723
+
+##### Returns
+
+`string`