@sanity/client 7.8.1 → 7.8.2-datasets.0

package/dist/index.browser.d.cts

@@ -780,6 +780,10 @@ declare type ClientConfigResource =
       type: 'dashboard'
       id: string
     }
+  | {
+      type: 'project'
+      id: string
+    }
 
 /** @public */
 export declare class ClientError extends Error {
@@ -798,6 +802,14 @@ export declare type ClientPerspective =
   | 'raw'
   | StackablePerspective[]
 
+/** @public */
+declare type ClientPerspective_2 =
+  | DeprecatedPreviewDrafts_2
+  | 'published'
+  | 'drafts'
+  | 'raw'
+  | StackablePerspective_2[]
+
 /** @public */
 export declare type ClientReturn<
   GroqString extends string,
@@ -1147,6 +1159,11 @@ export default deprecatedCreateClient
  */
 declare type DeprecatedPreviewDrafts = 'previewDrafts'
 
+/**
+ * @deprecated use 'drafts' instead
+ */
+declare type DeprecatedPreviewDrafts_2 = 'previewDrafts'
+
 /**
  * Delete the draft version of a document.
  * It is an error if it does not exist. If the purge flag is set, the document history is also deleted.
@@ -1745,6 +1762,7 @@ export declare interface GroqAgentActionParam {
   type: 'groq'
   query: string
   params?: Record<string, string>
+  perspective?: ClientPerspective_2
 }
 
 /**
@@ -3822,10 +3840,8 @@ export declare class ProjectsClient {
 declare interface PromptJsonResponse<T extends Record<string, Any> = Record<string, Any>> {
   /**
    *
-   * When true, the response body will be json according to the instruction.
-   * When false, the response is the raw text response to the instruction.
-   *
-   * Note: In addition to setting this to true,  `instruction` MUST include the word 'JSON', or 'json' for this to work.
+   * When format is 'json', the response will be json according to the instruction.
+   * Note: In addition to setting this to 'json',  `instruction` MUST include the word 'JSON', or 'json' for this to work.
    */
   format: 'json'
 }
@@ -3932,13 +3948,9 @@ declare interface PromptRequestBase {
 
 declare interface PromptTextResponse {
   /**
-   *
-   * When true, the response body will be json according to the instruction.
-   * When false, the response is the raw text response to the instruction.
-   *
-   * Note: In addition to setting this to true,  `instruction` MUST include the word 'JSON', or 'json' for this to work.
+   * When format is 'string', the response will be a raw text response to the instruction.
    */
-  format?: 'text'
+  format?: 'string'
 }
 
 /**
@@ -5490,6 +5502,9 @@ export declare interface SingleMutationResult {
 /** @public */
 export declare type StackablePerspective = ('published' | 'drafts' | string) & {}
 
+/** @public */
+declare type StackablePerspective_2 = ('published' | 'drafts' | string) & {}
+
 /** @public */
 export declare interface StegaConfig {
   /**

package/dist/index.browser.d.ts

@@ -780,6 +780,10 @@ declare type ClientConfigResource =
       type: 'dashboard'
       id: string
     }
+  | {
+      type: 'project'
+      id: string
+    }
 
 /** @public */
 export declare class ClientError extends Error {
@@ -798,6 +802,14 @@ export declare type ClientPerspective =
   | 'raw'
   | StackablePerspective[]
 
+/** @public */
+declare type ClientPerspective_2 =
+  | DeprecatedPreviewDrafts_2
+  | 'published'
+  | 'drafts'
+  | 'raw'
+  | StackablePerspective_2[]
+
 /** @public */
 export declare type ClientReturn<
   GroqString extends string,
@@ -1147,6 +1159,11 @@ export default deprecatedCreateClient
  */
 declare type DeprecatedPreviewDrafts = 'previewDrafts'
 
+/**
+ * @deprecated use 'drafts' instead
+ */
+declare type DeprecatedPreviewDrafts_2 = 'previewDrafts'
+
 /**
  * Delete the draft version of a document.
  * It is an error if it does not exist. If the purge flag is set, the document history is also deleted.
@@ -1745,6 +1762,7 @@ export declare interface GroqAgentActionParam {
   type: 'groq'
   query: string
   params?: Record<string, string>
+  perspective?: ClientPerspective_2
 }
 
 /**
@@ -3822,10 +3840,8 @@ export declare class ProjectsClient {
 declare interface PromptJsonResponse<T extends Record<string, Any> = Record<string, Any>> {
   /**
    *
-   * When true, the response body will be json according to the instruction.
-   * When false, the response is the raw text response to the instruction.
-   *
-   * Note: In addition to setting this to true,  `instruction` MUST include the word 'JSON', or 'json' for this to work.
+   * When format is 'json', the response will be json according to the instruction.
+   * Note: In addition to setting this to 'json',  `instruction` MUST include the word 'JSON', or 'json' for this to work.
    */
   format: 'json'
 }
@@ -3932,13 +3948,9 @@ declare interface PromptRequestBase {
 
 declare interface PromptTextResponse {
   /**
-   *
-   * When true, the response body will be json according to the instruction.
-   * When false, the response is the raw text response to the instruction.
-   *
-   * Note: In addition to setting this to true,  `instruction` MUST include the word 'JSON', or 'json' for this to work.
+   * When format is 'string', the response will be a raw text response to the instruction.
    */
-  format?: 'text'
+  format?: 'string'
 }
 
 /**
@@ -5490,6 +5502,9 @@ export declare interface SingleMutationResult {
 /** @public */
 export declare type StackablePerspective = ('published' | 'drafts' | string) & {}
 
+/** @public */
+declare type StackablePerspective_2 = ('published' | 'drafts' | string) & {}
+
 /** @public */
 export declare interface StegaConfig {
   /**

package/dist/index.browser.js

@@ -276,6 +276,7 @@ const VALID_ASSET_TYPES = ["image", "file"], VALID_INSERT_LOCATIONS = ["before",
         throw new Error('Dataset resource ID must be in the format "project.dataset"');
       return;
     }
+    case "project":
     case "dashboard":
     case "media-library":
     case "canvas":
@@ -1100,10 +1101,24 @@ function _request(client, httpRequest, options) {
 function _getDataUrl(client, operation, path) {
   const config = client.config();
   if (config["~experimental_resource"]) {
-    resourceConfig(config);
-    const resourceBase = resourceDataBase(config), uri2 = path !== void 0 ? `${operation}/${path}` : operation;
+    if (resourceConfig(config), operation === "" && path?.startsWith("datasets")) {
+      const { type, id } = config["~experimental_resource"];
+      if (type === "dataset") {
+        const segments = id.split(".");
+        if (segments.length !== 2)
+          throw new Error('Invalid dataset resource ID. Expected format "project.dataset".');
+        const base = `/projects/${segments[0]}`, uri3 = [path].filter(Boolean).join("/");
+        return `${base}/${uri3}`.replace(/\/($|\?)/, "$1");
+      } else if (type === "project") {
+        const base = `/projects/${id}`, uri3 = [path].filter(Boolean).join("/");
+        return `${base}/${uri3}`.replace(/\/($|\?)/, "$1");
+      }
+    }
+    const resourceBase = resourceDataBase(config), uri2 = [operation, path].filter(Boolean).join("/");
     return `${resourceBase}/${uri2}`.replace(/\/($|\?)/, "$1");
   }
+  if (operation === "")
+    return `/${path || ""}`;
   const catalog = hasDataset(config), baseUri = `/${operation}/${catalog}`;
   return `/data${path !== void 0 ? `${baseUri}/${path}` : baseUri}`.replace(/\/($|\?)/, "$1");
 }
@@ -1148,6 +1163,8 @@ const resourceDataBase = (config) => {
       return `/media-libraries/${id}`;
     case "dashboard":
       return `/dashboards/${id}`;
+    case "project":
+      return `/projects/${id}`;
     default:
       throw new Error(`Unsupported resource type: ${type.toString()}`);
   }
@@ -1318,6 +1335,10 @@ function buildAssetUploadUrl(config, assetType) {
   if (config["~experimental_resource"]) {
     const { type, id } = config["~experimental_resource"];
     switch (type) {
+      case "project":
+        throw new Error(
+          "Assets are not supported for project resources, yet. Configure the client with `{projectId: <projectId>}` instead."
+        );
       case "dataset":
         throw new Error(
           "Assets are not supported for dataset resources, yet. Configure the client with `{projectId: <projectId>, dataset: <datasetId>}` instead."
@@ -1535,8 +1556,12 @@ class ObservableDatasetsClient {
    * Fetch a list of datasets for the configured project
    */
   list() {
+    const resource = this.#client.config()["~experimental_resource"];
+    if (resource && resource.type !== "project")
+      throw new Error('`dataset.list()` requires a resource type of "project".');
+    const uri = _getDataUrl(this.#client, "", "datasets");
     return _request(this.#client, this.#httpRequest, {
-      uri: "/datasets",
+      uri,
       tag: null
     });
   }
@@ -1554,7 +1579,7 @@ class DatasetsClient {
    * @param options - Options for the dataset
    */
   create(name, options) {
-    return resourceGuard("dataset", this.#client.config()), lastValueFrom(
+    return lastValueFrom(
       _modify(this.#client, this.#httpRequest, "PUT", name, options)
     );
   }
@@ -1565,7 +1590,7 @@ class DatasetsClient {
    * @param options - New options for the dataset
    */
   edit(name, options) {
-    return resourceGuard("dataset", this.#client.config()), lastValueFrom(
+    return lastValueFrom(
       _modify(this.#client, this.#httpRequest, "PATCH", name, options)
     );
   }
@@ -1575,21 +1600,38 @@ class DatasetsClient {
    * @param name - Name of the dataset to delete
    */
   delete(name) {
-    return resourceGuard("dataset", this.#client.config()), lastValueFrom(_modify(this.#client, this.#httpRequest, "DELETE", name));
+    return lastValueFrom(_modify(this.#client, this.#httpRequest, "DELETE", name));
   }
   /**
    * Fetch a list of datasets for the configured project
    */
   list() {
-    return resourceGuard("dataset", this.#client.config()), lastValueFrom(
-      _request(this.#client, this.#httpRequest, { uri: "/datasets", tag: null })
+    const resource = this.#client.config()["~experimental_resource"];
+    if (resource && resource.type !== "project")
+      throw new Error('`dataset.list()` requires a resource type of "project".');
+    const uri = _getDataUrl(this.#client, "", "datasets");
+    return lastValueFrom(
+      _request(this.#client, this.#httpRequest, { uri, tag: null })
     );
   }
 }
 function _modify(client, httpRequest, method, name, options) {
-  return resourceGuard("dataset", client.config()), dataset(name), _request(client, httpRequest, {
+  dataset(name);
+  const resource = client.config()["~experimental_resource"];
+  if (resource)
+    if (resource.type === "dataset") {
+      const segments = resource.id.split(".");
+      if (segments.length !== 2)
+        throw new Error('Dataset resource ID must be in the format "project.dataset"');
+      const datasetName = segments[1];
+      if (name !== datasetName)
+        throw new Error(`Dataset name "${name}" does not match resource dataset "${datasetName}"`);
+    } else
+      throw new Error('Dataset create/edit/delete operations require a resource type of "dataset"');
+  const uri = _getDataUrl(client, "", `datasets/${name}`);
+  return _request(client, httpRequest, {
     method,
-    uri: `/datasets/${name}`,
+    uri,
     body: options,
     tag: null
   });
@@ -1601,7 +1643,6 @@ class ObservableProjectsClient {
     this.#client = client, this.#httpRequest = httpRequest;
   }
   list(options) {
-    resourceGuard("projects", this.#client.config());
     const uri = options?.includeMembers === !1 ? "/projects?includeMembers=false" : "/projects";
     return _request(this.#client, this.#httpRequest, { uri });
   }
@@ -1611,7 +1652,7 @@ class ObservableProjectsClient {
    * @param projectId - ID of the project to fetch
    */
   getById(projectId2) {
-    return resourceGuard("projects", this.#client.config()), _request(this.#client, this.#httpRequest, { uri: `/projects/${projectId2}` });
+    return _request(this.#client, this.#httpRequest, { uri: `/projects/${projectId2}` });
   }
 }
 class ProjectsClient {
@@ -1621,7 +1662,6 @@ class ProjectsClient {
     this.#client = client, this.#httpRequest = httpRequest;
   }
   list(options) {
-    resourceGuard("projects", this.#client.config());
     const uri = options?.includeMembers === !1 ? "/projects?includeMembers=false" : "/projects";
     return lastValueFrom(_request(this.#client, this.#httpRequest, { uri }));
   }
@@ -1631,7 +1671,7 @@ class ProjectsClient {
    * @param projectId - ID of the project to fetch
    */
   getById(projectId2) {
-    return resourceGuard("projects", this.#client.config()), lastValueFrom(
+    return lastValueFrom(
       _request(this.#client, this.#httpRequest, { uri: `/projects/${projectId2}` })
     );
   }