@sanity/client 7.15.0 → 7.17.0

package/dist/index.browser.d.cts

@@ -1099,6 +1099,20 @@ export declare interface CurrentSanityUser {
 /** @public */
 export declare type DatasetAclMode = 'public' | 'private' | 'custom'
 
+/** @public */
+export declare type DatasetCreateOptions = {
+  aclMode?: DatasetAclMode
+  embeddings?: {
+    enabled: boolean
+    projection?: string
+  }
+}
+
+/** @public */
+export declare type DatasetEditOptions = {
+  aclMode?: DatasetAclMode
+}
+
 /** @public */
 export declare type DatasetResponse = {
   datasetName: string
@@ -1113,26 +1127,16 @@ export declare class DatasetsClient {
    * Create a new dataset with the given name
    *
    * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
+   * @param options - Options for the dataset, including optional embeddings configuration
    */
-  create(
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    },
-  ): Promise<DatasetResponse>
+  create(name: string, options?: DatasetCreateOptions): Promise<DatasetResponse>
   /**
    * Edit a dataset with the given name
    *
    * @param name - Name of the dataset to edit
    * @param options - New options for the dataset
    */
-  edit(
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    },
-  ): Promise<DatasetResponse>
+  edit(name: string, options?: DatasetEditOptions): Promise<DatasetResponse>
   /**
    * Delete a dataset with the given name
    *
@@ -1145,6 +1149,19 @@ export declare class DatasetsClient {
    * Fetch a list of datasets for the configured project
    */
   list(): Promise<DatasetsResponse>
+  /**
+   * Get embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   */
+  getEmbeddingsSettings(name: string): Promise<EmbeddingsSettings>
+  /**
+   * Edit embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   * @param settings - Embeddings settings to apply
+   */
+  editEmbeddingsSettings(name: string, settings: EmbeddingsSettingsBody): Promise<void>
 }
 
 /** @public */
@@ -1355,6 +1372,19 @@ export declare interface EditReleaseAction {
   patch: PatchOperations
 }
 
+/** @public */
+export declare type EmbeddingsSettings = {
+  enabled: boolean
+  projection?: string
+  status: string
+}
+
+/** @public */
+export declare type EmbeddingsSettingsBody = {
+  enabled: boolean
+  projection?: string
+}
+
 /** @public */
 export declare interface ErrorProps {
   message: string
@@ -2553,26 +2583,16 @@ export declare class ObservableDatasetsClient {
    * Create a new dataset with the given name
    *
    * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
+   * @param options - Options for the dataset, including optional embeddings configuration
    */
-  create(
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    },
-  ): Observable<DatasetResponse>
+  create(name: string, options?: DatasetCreateOptions): Observable<DatasetResponse>
   /**
    * Edit a dataset with the given name
    *
    * @param name - Name of the dataset to edit
    * @param options - New options for the dataset
    */
-  edit(
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    },
-  ): Observable<DatasetResponse>
+  edit(name: string, options?: DatasetEditOptions): Observable<DatasetResponse>
   /**
    * Delete a dataset with the given name
    *
@@ -2585,6 +2605,19 @@ export declare class ObservableDatasetsClient {
    * Fetch a list of datasets for the configured project
    */
   list(): Observable<DatasetsResponse>
+  /**
+   * Get embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   */
+  getEmbeddingsSettings(name: string): Observable<EmbeddingsSettings>
+  /**
+   * Edit embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   * @param settings - Embeddings settings to apply
+   */
+  editEmbeddingsSettings(name: string, settings: EmbeddingsSettingsBody): Observable<void>
 }
 
 /** @internal */
@@ -2666,11 +2699,17 @@ export declare class ObservableProjectsClient {
    * @param options - Options for the list request
    *   - `includeMembers` - Whether to include members in the response (default: true)
    *   - `organizationId` - ID of the organization to fetch projects for
+   *   - `onlyExplicitMembership` - Only include projects where the user has explicit membership (default: false)
    */
-  list(options?: {includeMembers?: true; organizationId?: string}): Observable<SanityProject[]>
+  list(options?: {
+    includeMembers?: true
+    organizationId?: string
+    onlyExplicitMembership?: boolean
+  }): Observable<SanityProject[]>
   list(options?: {
     includeMembers?: false
     organizationId?: string
+    onlyExplicitMembership?: boolean
   }): Observable<Omit<SanityProject, 'members'>[]>
   /**
    * Fetch a project by project ID
@@ -4043,11 +4082,17 @@ export declare class ProjectsClient {
    * @param options - Options for the list request
    *   - `includeMembers` - Whether to include members in the response (default: true)
    *   - `organizationId` - ID of the organization to fetch projects for
+   *   - `onlyExplicitMembership` - Only include projects where the user has explicit membership (default: false)
    */
-  list(options?: {includeMembers?: true; organizationId?: string}): Promise<SanityProject[]>
+  list(options?: {
+    includeMembers?: true
+    organizationId?: string
+    onlyExplicitMembership?: boolean
+  }): Promise<SanityProject[]>
   list(options?: {
     includeMembers?: false
     organizationId?: string
+    onlyExplicitMembership?: boolean
   }): Promise<Omit<SanityProject, 'members'>[]>
   /**
    * Fetch a project by project ID

package/dist/index.browser.d.ts

@@ -1099,6 +1099,20 @@ export declare interface CurrentSanityUser {
 /** @public */
 export declare type DatasetAclMode = 'public' | 'private' | 'custom'
 
+/** @public */
+export declare type DatasetCreateOptions = {
+  aclMode?: DatasetAclMode
+  embeddings?: {
+    enabled: boolean
+    projection?: string
+  }
+}
+
+/** @public */
+export declare type DatasetEditOptions = {
+  aclMode?: DatasetAclMode
+}
+
 /** @public */
 export declare type DatasetResponse = {
   datasetName: string
@@ -1113,26 +1127,16 @@ export declare class DatasetsClient {
    * Create a new dataset with the given name
    *
    * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
+   * @param options - Options for the dataset, including optional embeddings configuration
    */
-  create(
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    },
-  ): Promise<DatasetResponse>
+  create(name: string, options?: DatasetCreateOptions): Promise<DatasetResponse>
   /**
    * Edit a dataset with the given name
    *
    * @param name - Name of the dataset to edit
    * @param options - New options for the dataset
    */
-  edit(
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    },
-  ): Promise<DatasetResponse>
+  edit(name: string, options?: DatasetEditOptions): Promise<DatasetResponse>
   /**
    * Delete a dataset with the given name
    *
@@ -1145,6 +1149,19 @@ export declare class DatasetsClient {
    * Fetch a list of datasets for the configured project
    */
   list(): Promise<DatasetsResponse>
+  /**
+   * Get embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   */
+  getEmbeddingsSettings(name: string): Promise<EmbeddingsSettings>
+  /**
+   * Edit embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   * @param settings - Embeddings settings to apply
+   */
+  editEmbeddingsSettings(name: string, settings: EmbeddingsSettingsBody): Promise<void>
 }
 
 /** @public */
@@ -1355,6 +1372,19 @@ export declare interface EditReleaseAction {
   patch: PatchOperations
 }
 
+/** @public */
+export declare type EmbeddingsSettings = {
+  enabled: boolean
+  projection?: string
+  status: string
+}
+
+/** @public */
+export declare type EmbeddingsSettingsBody = {
+  enabled: boolean
+  projection?: string
+}
+
 /** @public */
 export declare interface ErrorProps {
   message: string
@@ -2553,26 +2583,16 @@ export declare class ObservableDatasetsClient {
    * Create a new dataset with the given name
    *
    * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
+   * @param options - Options for the dataset, including optional embeddings configuration
    */
-  create(
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    },
-  ): Observable<DatasetResponse>
+  create(name: string, options?: DatasetCreateOptions): Observable<DatasetResponse>
   /**
    * Edit a dataset with the given name
    *
    * @param name - Name of the dataset to edit
    * @param options - New options for the dataset
    */
-  edit(
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    },
-  ): Observable<DatasetResponse>
+  edit(name: string, options?: DatasetEditOptions): Observable<DatasetResponse>
   /**
    * Delete a dataset with the given name
    *
@@ -2585,6 +2605,19 @@ export declare class ObservableDatasetsClient {
    * Fetch a list of datasets for the configured project
    */
   list(): Observable<DatasetsResponse>
+  /**
+   * Get embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   */
+  getEmbeddingsSettings(name: string): Observable<EmbeddingsSettings>
+  /**
+   * Edit embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   * @param settings - Embeddings settings to apply
+   */
+  editEmbeddingsSettings(name: string, settings: EmbeddingsSettingsBody): Observable<void>
 }
 
 /** @internal */
@@ -2666,11 +2699,17 @@ export declare class ObservableProjectsClient {
    * @param options - Options for the list request
    *   - `includeMembers` - Whether to include members in the response (default: true)
    *   - `organizationId` - ID of the organization to fetch projects for
+   *   - `onlyExplicitMembership` - Only include projects where the user has explicit membership (default: false)
    */
-  list(options?: {includeMembers?: true; organizationId?: string}): Observable<SanityProject[]>
+  list(options?: {
+    includeMembers?: true
+    organizationId?: string
+    onlyExplicitMembership?: boolean
+  }): Observable<SanityProject[]>
   list(options?: {
     includeMembers?: false
     organizationId?: string
+    onlyExplicitMembership?: boolean
   }): Observable<Omit<SanityProject, 'members'>[]>
   /**
    * Fetch a project by project ID
@@ -4043,11 +4082,17 @@ export declare class ProjectsClient {
    * @param options - Options for the list request
    *   - `includeMembers` - Whether to include members in the response (default: true)
    *   - `organizationId` - ID of the organization to fetch projects for
+   *   - `onlyExplicitMembership` - Only include projects where the user has explicit membership (default: false)
    */
-  list(options?: {includeMembers?: true; organizationId?: string}): Promise<SanityProject[]>
+  list(options?: {
+    includeMembers?: true
+    organizationId?: string
+    onlyExplicitMembership?: boolean
+  }): Promise<SanityProject[]>
   list(options?: {
     includeMembers?: false
     organizationId?: string
+    onlyExplicitMembership?: boolean
   }): Promise<Omit<SanityProject, 'members'>[]>
   /**
    * Fetch a project by project ID

package/dist/index.browser.js

@@ -1,7 +1,7 @@
 import { getIt } from "get-it";
 import { adapter, environment } from "get-it";
 import { retry, jsonRequest, jsonResponse, progress, observable } from "get-it/middleware";
-import { Observable, defer, of, isObservable, mergeMap, from, lastValueFrom, shareReplay, catchError, concat, throwError, timer, tap, finalize, share, merge, map as map$1, firstValueFrom } from "rxjs";
+import { Observable, defer, isObservable, of, mergeMap, from, lastValueFrom, shareReplay, catchError, concat, timer, throwError, tap, finalize, share, merge, map as map$1, firstValueFrom } from "rxjs";
 import { isRecord, stegaClean } from "./_chunks-es/stegaClean.js";
 import { combineLatestWith, map, filter, finalize as finalize$1 } from "rxjs/operators";
 import { getVersionFromId, isDraftId, getVersionId, getDraftId, isVersionId, getPublishedId } from "@sanity/client/csm";
@@ -1542,7 +1542,7 @@ class ObservableDatasetsClient {
    * Create a new dataset with the given name
    *
    * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
+   * @param options - Options for the dataset, including optional embeddings configuration
    */
   create(name, options) {
     return _modify(this.#client, this.#httpRequest, "PUT", name, options);
@@ -1576,6 +1576,31 @@ class ObservableDatasetsClient {
       tag: null
     });
   }
+  /**
+   * Get embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   */
+  getEmbeddingsSettings(name) {
+    return resourceGuard("dataset", this.#client.config()), dataset(name), _request(this.#client, this.#httpRequest, {
+      uri: _embeddingsSettingsUri(this.#client, name),
+      tag: null
+    });
+  }
+  /**
+   * Edit embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   * @param settings - Embeddings settings to apply
+   */
+  editEmbeddingsSettings(name, settings) {
+    return resourceGuard("dataset", this.#client.config()), dataset(name), _request(this.#client, this.#httpRequest, {
+      method: "PUT",
+      uri: _embeddingsSettingsUri(this.#client, name),
+      body: settings,
+      tag: null
+    });
+  }
 }
 class DatasetsClient {
   #client;
@@ -1587,7 +1612,7 @@ class DatasetsClient {
    * Create a new dataset with the given name
    *
    * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
+   * @param options - Options for the dataset, including optional embeddings configuration
    */
   create(name, options) {
     return resourceGuard("dataset", this.#client.config()), lastValueFrom(
@@ -1624,6 +1649,39 @@ class DatasetsClient {
       _request(this.#client, this.#httpRequest, { uri, tag: null })
     );
   }
+  /**
+   * Get embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   */
+  getEmbeddingsSettings(name) {
+    return resourceGuard("dataset", this.#client.config()), dataset(name), lastValueFrom(
+      _request(this.#client, this.#httpRequest, {
+        uri: _embeddingsSettingsUri(this.#client, name),
+        tag: null
+      })
+    );
+  }
+  /**
+   * Edit embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   * @param settings - Embeddings settings to apply
+   */
+  editEmbeddingsSettings(name, settings) {
+    return resourceGuard("dataset", this.#client.config()), dataset(name), lastValueFrom(
+      _request(this.#client, this.#httpRequest, {
+        method: "PUT",
+        uri: _embeddingsSettingsUri(this.#client, name),
+        body: settings,
+        tag: null
+      })
+    );
+  }
+}
+function _embeddingsSettingsUri(client, name) {
+  const config = client.config();
+  return config.useProjectHostname === !1 ? `/projects/${config.projectId}/datasets/${name}/settings/embeddings` : `/datasets/${name}/settings/embeddings`;
 }
 function _modify(client, httpRequest, method, name, options) {
   return resourceGuard("dataset", client.config()), dataset(name), _request(client, httpRequest, {
@@ -1715,7 +1773,7 @@ class ObservableProjectsClient {
   }
   list(options) {
     const query = {}, uri = "/projects";
-    return options?.includeMembers === !1 && (query.includeMembers = "false"), options?.organizationId && (query.organizationId = options.organizationId), _request(this.#client, this.#httpRequest, { uri, query });
+    return options?.includeMembers === !1 && (query.includeMembers = "false"), options?.organizationId && (query.organizationId = options.organizationId), options?.onlyExplicitMembership === !0 && (query.onlyExplicitMembership = "true"), _request(this.#client, this.#httpRequest, { uri, query });
   }
   /**
    * Fetch a project by project ID
@@ -1734,7 +1792,7 @@ class ProjectsClient {
   }
   list(options) {
     const query = {}, uri = "/projects";
-    return options?.includeMembers === !1 && (query.includeMembers = "false"), options?.organizationId && (query.organizationId = options.organizationId), lastValueFrom(_request(this.#client, this.#httpRequest, { uri, query }));
+    return options?.includeMembers === !1 && (query.includeMembers = "false"), options?.organizationId && (query.organizationId = options.organizationId), options?.onlyExplicitMembership === !0 && (query.onlyExplicitMembership = "true"), lastValueFrom(_request(this.#client, this.#httpRequest, { uri, query }));
   }
   /**
    * Fetch a project by project ID