@supabase/storage-js 2.116.0-canary.1 → 2.116.0-canary.3

package/README.md

@@ -777,7 +777,7 @@ const { data, error } = await index.queryVectors({
 })
 
 if (data) {
-  data.matches.forEach((match) => {
+  data.vectors.forEach((match) => {
     console.log(`${match.key}: distance=${match.distance}`)
     console.log('Metadata:', match.metadata)
   })
@@ -996,11 +996,36 @@ const { data, error } = await index.queryVectors({
 })
 
 // Results ordered by similarity
-data?.matches.forEach((match) => {
+data?.vectors.forEach((match) => {
   console.log(`${match.key}: distance=${match.distance}`)
 })
 ```
 
+S3 vector buckets support deep queries with `topK` up to 10,000, returning at most 100 vectors per response. Pass the response's `nextToken` with the same query to retrieve the next page:
+
+```typescript
+const query = {
+  queryVector: { float32: embedding },
+  topK: 1000,
+  returnDistance: true,
+}
+
+let nextToken: string | undefined
+
+do {
+  const { data, error } = await index.queryVectors({ ...query, nextToken })
+  if (error) throw error
+
+  for (const vector of data.vectors) {
+    console.log(`${vector.key}: distance=${vector.distance}`)
+  }
+
+  nextToken = data.nextToken
+} while (nextToken)
+```
+
+The pgvector backend supports `topK` up to 100 and does not support `nextToken` pagination.
+
 **Filter Syntax:**
 The `filter` parameter accepts arbitrary JSON for metadata filtering. Non-filterable keys (configured at index creation) cannot be used in filters but can still be returned.
 

package/dist/index.cjs

@@ -1004,6 +1004,7 @@ var StorageFileApi = class extends BaseApiClient {
 	* @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
 	* @param options.transform Transform the asset before serving it to the client.
 	* @param options.cacheNonce Append a cache nonce parameter to the URL to invalidate the cache.
+	* @param options.versionId Create a signed URL for a specific object version rather than the current one.
 	* @returns Promise with response containing signed URL or error
 	*
 	* @example Create Signed URL
@@ -1058,7 +1059,7 @@ var StorageFileApi = class extends BaseApiClient {
 		return _this8.handleOperation(async () => {
 			let _path = _this8._getFinalPath(path);
 			const hasTransform = typeof (options === null || options === void 0 ? void 0 : options.transform) === "object" && options.transform !== null && Object.keys(options.transform).length > 0;
-			let data = await post(_this8.fetch, `${_this8.url}/object/sign/${_path}`, _objectSpread2({ expiresIn }, hasTransform ? { transform: options.transform } : {}), { headers: _this8.headers });
+			let data = await post(_this8.fetch, `${_this8.url}/object/sign/${_path}`, _objectSpread2(_objectSpread2({ expiresIn }, hasTransform ? { transform: options.transform } : {}), (options === null || options === void 0 ? void 0 : options.versionId) != null ? { versionId: options.versionId } : {}), { headers: _this8.headers });
 			const query = new URLSearchParams();
 			if (options === null || options === void 0 ? void 0 : options.download) query.set("download", options.download === true ? "" : options.download);
 			if ((options === null || options === void 0 ? void 0 : options.cacheNonce) != null) query.set("cacheNonce", String(options.cacheNonce));
@@ -1288,6 +1289,7 @@ var StorageFileApi = class extends BaseApiClient {
 	* @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
 	* @param options.transform Transform the asset before serving it to the client.
 	* @param options.cacheNonce Append a cache nonce parameter to the URL to invalidate the cache.
+	* @param options.versionId Return the URL for a specific object version rather than the current one.
 	* @returns Object with public URL
 	*
 	* @example Returns the URL for an asset in a public bucket
@@ -1343,6 +1345,7 @@ var StorageFileApi = class extends BaseApiClient {
 		if (options === null || options === void 0 ? void 0 : options.download) query.set("download", options.download === true ? "" : options.download);
 		if (options === null || options === void 0 ? void 0 : options.transform) this.applyTransformOptsToQuery(query, options.transform);
 		if ((options === null || options === void 0 ? void 0 : options.cacheNonce) != null) query.set("cacheNonce", String(options.cacheNonce));
+		if ((options === null || options === void 0 ? void 0 : options.versionId) != null) query.set("versionId", String(options.versionId));
 		const queryString = query.toString();
 		const renderPath = typeof (options === null || options === void 0 ? void 0 : options.transform) === "object" && options.transform !== null && Object.keys(options.transform).length > 0 ? "render/image" : "object";
 		return { data: { publicUrl: encodeURI(`${this.url}/${renderPath}/public/${_path}`) + (queryString ? `?${queryString}` : "") } };
@@ -1629,7 +1632,7 @@ var StorageFileApi = class extends BaseApiClient {
 
 //#endregion
 //#region src/lib/version.ts
-const version = "2.116.0-canary.1";
+const version = "2.116.0-canary.3";
 
 //#endregion
 //#region src/lib/constants.ts
@@ -1992,8 +1995,8 @@ var StorageBucketApi = class extends BaseApiClient {
 	* is overwritten. Send at least one rule. Call {@link deleteBucketLifecycle}
 	* to remove the policy.
 	*
-	* Each rule currently supports only `noncurrentVersionExpiration`. Set
-	* `filter` to `{}`. Prefix filters, tag filters, and current-object
+	* Each rule currently supports only `noncurrentVersionExpiration`. `filter`
+	* is required and must be `{}`. Prefix filters, tag filters, and current-object
 	* expiration are rejected. Rule IDs must be unique. Omit `id` and the
 	* server generates one.
 	*
@@ -3154,7 +3157,7 @@ var VectorIndexScope = class extends VectorDataApi {
 	* @category Storage
 	* @subcategory Vector Buckets
 	* @param options - Query options (bucket and index names automatically set)
-	* @returns Promise with response containing matches array of similar vectors ordered by distance or error
+	* @returns Promise with response containing vectors ordered by distance, an optional pagination token, or an error
 	*
 	* @example Query similar vectors
 	* ```typescript