@sanity/client 6.28.0-instruct.0 → 6.28.0-resources-projects.1

package/src/config.ts

@@ -78,6 +78,25 @@ export const initConfig = (
     ...defaultConfig,
     ...specifiedConfig,
   } as InitializedClientConfig
+
+  const projectId = newConfig.projectId
+
+  //this "feature" is meant for internal Sanity use only. Do not use.
+  if (projectId?.startsWith('resource.')) {
+    const [, resourceType, resourceId] = projectId.split('.')
+    if (resourceType && resourceId) {
+      newConfig.experimental_resource = {
+        type: resourceType,
+        id: resourceId,
+      }
+    }
+  }
+  // resource oriented clients should not use project hostname in base url
+  const experimentalResource = newConfig.experimental_resource
+  if (experimentalResource) {
+    newConfig.useProjectHostname = false
+  }
+
   const projectBased = newConfig.useProjectHostname
 
   if (typeof Promise === 'undefined') {
@@ -168,5 +187,17 @@ export const initConfig = (
     newConfig.cdnUrl = newConfig.url
   }
 
+  if (experimentalResource && experimentalResource.type !== 'projects') {
+    const resourceSuffix = `${experimentalResource.type}/${experimentalResource.id}`
+    newConfig.url = `${newConfig.url}/${resourceSuffix}`
+    newConfig.cdnUrl = `${newConfig.cdnUrl}/${resourceSuffix}`
+  }
+
+  if (experimentalResource?.type === 'projects' && 'dataset' in experimentalResource) {
+    const suffix = `projects/${experimentalResource.id}/datasets/${experimentalResource.dataset}`
+    newConfig.url = `${newConfig.url}/${suffix}`
+    newConfig.cdnUrl = `${newConfig.cdnUrl}/${suffix}`
+  }
+
   return newConfig
 }

package/src/data/dataMethods.ts

@@ -12,6 +12,7 @@ import type {
   Any,
   BaseActionOptions,
   BaseMutationOptions,
+  ClientConfig,
   FirstDocumentIdMutationOptions,
   FirstDocumentMutationOptions,
   HttpRequest,
@@ -38,6 +39,8 @@ import {encodeQueryString} from './encodeQueryString'
 import {ObservablePatch, Patch} from './patch'
 import {ObservableTransaction, Transaction} from './transaction'
 
+type ExperimentalResourceConfig = Exclude<ClientConfig['experimental_resource'], undefined>
+
 const excludeFalsey = (param: Any, defValue: Any) => {
   const value = typeof param === 'undefined' ? defValue : param
   return param === false ? undefined : value
@@ -367,6 +370,33 @@ export function _create<R extends Record<string, Any>>(
   return _dataRequest(client, httpRequest, 'mutate', {mutations: [mutation]}, opts)
 }
 
+function _resourceBase(resource: ExperimentalResourceConfig) {
+  if (resource.type === 'projects' && 'dataset' in resource) {
+    return `/projects/${resource.id}/datasets/${resource.dataset}`
+  }
+
+  return `/${resource.type}/${resource.id}`
+}
+
+function isDataRequestUri(uri: string, resource?: ExperimentalResourceConfig) {
+  if (resource) {
+    return uri.indexOf(`/${_resourceBase(resource)}/data/`) === 0
+  }
+  return uri.indexOf('/data/') === 0
+}
+
+function isDataQueryRequestUri(uri: string, resource?: ExperimentalResourceConfig) {
+  if (resource && resource.type !== 'projects') {
+    return uri.indexOf(`/${_resourceBase(resource)}/data/query`) === 0
+  }
+
+  if (resource && resource.type === 'projects' && 'dataset' in resource) {
+    return uri.indexOf(`/projects/${resource.id}/datasets/${resource.dataset}/query`) === 0
+  }
+
+  return uri.indexOf('/data/query') === 0
+}
+
 /**
  * @internal
  */
@@ -382,7 +412,8 @@ export function _requestObservable<R>(
   // Only the /data endpoint is currently available through API-CDN.
   const canUseCdn =
     typeof options.canUseCdn === 'undefined'
-      ? ['GET', 'HEAD'].indexOf(options.method || 'GET') >= 0 && uri.indexOf('/data/') === 0
+      ? ['GET', 'HEAD'].indexOf(options.method || 'GET') >= 0 &&
+        isDataRequestUri(uri, config.experimental_resource)
       : options.canUseCdn
 
   let useCdn = (options.useCdn ?? config.useCdn) && canUseCdn
@@ -399,7 +430,7 @@ export function _requestObservable<R>(
   // GROQ query-only parameters
   if (
     ['GET', 'HEAD', 'POST'].indexOf(options.method || 'GET') >= 0 &&
-    uri.indexOf('/data/query/') === 0
+    isDataQueryRequestUri(uri, config.experimental_resource)
   ) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap
     if (resultSourceMap !== undefined && resultSourceMap !== false) {
@@ -482,6 +513,12 @@ export function _getDataUrl(
   path?: string,
 ): string {
   const config = client.config()
+
+  if (config.experimental_resource) {
+    const baseUri = `/${operation}`
+    const uri = path ? `${baseUri}/${path}` : baseUri
+    return uri.replace(/\/($|\?)/, '$1')
+  }
   const catalog = validators.hasDataset(config)
   const baseUri = `/${operation}/${catalog}`
   const uri = path ? `${baseUri}/${path}` : baseUri
@@ -496,8 +533,15 @@ export function _getUrl(
   uri: string,
   canUseCdn = false,
 ): string {
-  const {url, cdnUrl} = client.config()
-  const base = canUseCdn ? cdnUrl : url
+  const {url, cdnUrl, experimental_resource} = client.config()
+  let base = canUseCdn ? cdnUrl : url
+
+  if (experimental_resource) {
+    if (uri.indexOf('/users') !== -1 || uri.indexOf('/assets') !== -1) {
+      base = base.replace(_resourceBase(experimental_resource), '')
+    }
+  }
+
   return `${base}/${uri.replace(/^\//, '')}`
 }
 

package/src/datasets/DatasetsClient.ts

@@ -106,6 +106,28 @@ export class DatasetsClient {
   }
 }
 
+export class ThrowingDatasetsClient extends DatasetsClient {
+  constructor(client: SanityClient, httpRequest: HttpRequest) {
+    super(client, httpRequest)
+  }
+
+  create(): Promise<DatasetResponse> {
+    throw new Error('cannot create dataset with the current client configuration')
+  }
+
+  edit(): Promise<DatasetResponse> {
+    throw new Error('cannot edit dataset with the current client configuration')
+  }
+
+  delete(): Promise<{deleted: true}> {
+    throw new Error('cannot delete dataset with the current client configuration')
+  }
+
+  list(): Promise<DatasetsResponse> {
+    throw new Error('cannot list dataset with the current client configuration')
+  }
+}
+
 function _modify<R = unknown>(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,

package/src/types.ts

@@ -115,6 +115,13 @@ export interface ClientConfig {
    * Options for how, if enabled, Content Source Maps are encoded into query results using steganography
    */
   stega?: StegaConfig | boolean
+
+  /**
+   * @deprecated Don't use
+   */
+  experimental_resource?:
+    | {type: 'projects'; id: string; dataset: string}
+    | {type: string; id: string}
 }
 
 /** @public */
@@ -1320,16 +1327,6 @@ export type ClientReturn<
   Fallback = Any,
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
-export type {
-  AssistAsyncInstruction,
-  AssistInstruction,
-  AssistSyncInstruction,
-  ConstantInstructionParam,
-  FieldInstructionParam,
-  GroqInstructionParam,
-  InstructionParam,
-  InstructionParams,
-} from './assist/types'
 export type {
   ContentSourceMapParsedPath,
   ContentSourceMapParsedPathKeyedSegment,

package/umd/sanityClient.js

@@ -2133,7 +2133,17 @@
     const newConfig = {
       ...defaultConfig,
       ...specifiedConfig
-    }, projectBased = newConfig.useProjectHostname;
+    }, projectId$1 = newConfig.projectId;
+    if (projectId$1?.startsWith("resource.")) {
+      const [, resourceType, resourceId] = projectId$1.split(".");
+      resourceType && resourceId && (newConfig.experimental_resource = {
+        type: resourceType,
+        id: resourceId
+      });
+    }
+    const experimentalResource = newConfig.experimental_resource;
+    experimentalResource && (newConfig.useProjectHostname = false);
+    const projectBased = newConfig.useProjectHostname;
     if (typeof Promise > "u") {
       const helpUrl = generateHelpUrl("js-client-promise-polyfill");
       throw new Error(`No native Promise-implementation found, polyfill needed - see ${helpUrl}`);
@@ -2159,7 +2169,15 @@
     const isBrowser = typeof window < "u" && window.location && window.location.hostname, isLocalhost = isBrowser && isLocal(window.location.hostname);
     isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== true ? printBrowserTokenWarning() : typeof newConfig.useCdn > "u" && printCdnWarning(), projectBased && projectId(newConfig.projectId), newConfig.dataset && dataset(newConfig.dataset), "requestTagPrefix" in newConfig && (newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0), newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, ""), newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost, newConfig.useCdn === true && newConfig.withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== false && !newConfig.withCredentials, validateApiVersion(newConfig.apiVersion);
     const hostParts = newConfig.apiHost.split("://", 2), protocol = hostParts[0], host = hostParts[1], cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
-    return newConfig.useProjectHostname ? (newConfig.url = `${protocol}://${newConfig.projectId}.${host}/v${newConfig.apiVersion}`, newConfig.cdnUrl = `${protocol}://${newConfig.projectId}.${cdnHost}/v${newConfig.apiVersion}`) : (newConfig.url = `${newConfig.apiHost}/v${newConfig.apiVersion}`, newConfig.cdnUrl = newConfig.url), newConfig;
+    if (newConfig.useProjectHostname ? (newConfig.url = `${protocol}://${newConfig.projectId}.${host}/v${newConfig.apiVersion}`, newConfig.cdnUrl = `${protocol}://${newConfig.projectId}.${cdnHost}/v${newConfig.apiVersion}`) : (newConfig.url = `${newConfig.apiHost}/v${newConfig.apiVersion}`, newConfig.cdnUrl = newConfig.url), experimentalResource && experimentalResource.type !== "projects") {
+      const resourceSuffix = `${experimentalResource.type}/${experimentalResource.id}`;
+      newConfig.url = `${newConfig.url}/${resourceSuffix}`, newConfig.cdnUrl = `${newConfig.cdnUrl}/${resourceSuffix}`;
+    }
+    if (experimentalResource?.type === "projects" && "dataset" in experimentalResource) {
+      const suffix = `projects/${experimentalResource.id}/datasets/${experimentalResource.dataset}`;
+      newConfig.url = `${newConfig.url}/${suffix}`, newConfig.cdnUrl = `${newConfig.cdnUrl}/${suffix}`;
+    }
+    return newConfig;
   };
   class ConnectionFailedError extends Error {
     name = "ConnectionFailedError";
@@ -2770,11 +2788,20 @@ ${selectionOpts}`);
     const mutation = { [op]: doc }, opts = Object.assign({ returnFirst: true, returnDocuments: true }, options);
     return _dataRequest(client, httpRequest, "mutate", { mutations: [mutation] }, opts);
   }
+  function _resourceBase(resource) {
+    return resource.type === "projects" && "dataset" in resource ? `/projects/${resource.id}/datasets/${resource.dataset}` : `/${resource.type}/${resource.id}`;
+  }
+  function isDataRequestUri(uri, resource) {
+    return resource ? uri.indexOf(`/${_resourceBase(resource)}/data/`) === 0 : uri.indexOf("/data/") === 0;
+  }
+  function isDataQueryRequestUri(uri, resource) {
+    return resource && resource.type !== "projects" ? uri.indexOf(`/${_resourceBase(resource)}/data/query`) === 0 : resource && resource.type === "projects" && "dataset" in resource ? uri.indexOf(`/projects/${resource.id}/datasets/${resource.dataset}/query`) === 0 : uri.indexOf("/data/query") === 0;
+  }
   function _requestObservable(client, httpRequest, options) {
-    const uri = options.url || options.uri, config = client.config(), canUseCdn = typeof options.canUseCdn > "u" ? ["GET", "HEAD"].indexOf(options.method || "GET") >= 0 && uri.indexOf("/data/") === 0 : options.canUseCdn;
+    const uri = options.url || options.uri, config = client.config(), canUseCdn = typeof options.canUseCdn > "u" ? ["GET", "HEAD"].indexOf(options.method || "GET") >= 0 && isDataRequestUri(uri, config.experimental_resource) : options.canUseCdn;
     let useCdn = (options.useCdn ?? config.useCdn) && canUseCdn;
     const tag = options.tag && config.requestTagPrefix ? [config.requestTagPrefix, options.tag].join(".") : options.tag || config.requestTagPrefix;
-    if (tag && options.tag !== null && (options.query = { tag: requestTag(tag), ...options.query }), ["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && uri.indexOf("/data/query/") === 0) {
+    if (tag && options.tag !== null && (options.query = { tag: requestTag(tag), ...options.query }), ["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && isDataQueryRequestUri(uri, config.experimental_resource)) {
       const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap;
       resultSourceMap !== void 0 && resultSourceMap !== false && (options.query = { resultSourceMap, ...options.query });
       const perspectiveOption = options.perspective || config.perspective;
@@ -2801,12 +2828,18 @@ ${selectionOpts}`);
     );
   }
   function _getDataUrl(client, operation, path) {
-    const config = client.config(), catalog = hasDataset(config), baseUri = `/${operation}/${catalog}`;
+    const config = client.config();
+    if (config.experimental_resource) {
+      const baseUri2 = `/${operation}`;
+      return (path ? `${baseUri2}/${path}` : baseUri2).replace(/\/($|\?)/, "$1");
+    }
+    const catalog = hasDataset(config), baseUri = `/${operation}/${catalog}`;
     return `/data${path ? `${baseUri}/${path}` : baseUri}`.replace(/\/($|\?)/, "$1");
   }
   function _getUrl(client, uri, canUseCdn = false) {
-    const { url, cdnUrl } = client.config();
-    return `${canUseCdn ? cdnUrl : url}/${uri.replace(/^\//, "")}`;
+    const { url, cdnUrl, experimental_resource } = client.config();
+    let base = canUseCdn ? cdnUrl : url;
+    return experimental_resource && (uri.indexOf("/users") !== -1 || uri.indexOf("/assets") !== -1) && (base = base.replace(_resourceBase(experimental_resource), "")), `${base}/${uri.replace(/^\//, "")}`;
   }
   function _withAbortSignal(signal) {
     return (input) => new Observable((observer) => {
@@ -2860,7 +2893,7 @@ ${selectionOpts}`);
     validateAssetType(assetType);
     let meta = opts.extract || void 0;
     meta && !meta.length && (meta = ["none"]);
-    const dataset2 = hasDataset(client.config()), assetEndpoint = assetType === "image" ? "images" : "files", options = optionsFromFile(opts, body), { tag, label, title, description, creditLine, filename, source } = options, query = {
+    const config = client.config(), resource = config.experimental_resource, dataset2 = resource ? void 0 : hasDataset(config), assetEndpoint = assetType === "image" ? "images" : "files", options = optionsFromFile(opts, body), { tag, label, title, description, creditLine, filename, source } = options, query = {
       label,
       title,
       description,
@@ -2872,7 +2905,7 @@ ${selectionOpts}`);
       tag,
       method: "POST",
       timeout: options.timeout || 0,
-      uri: `/assets/${assetEndpoint}/${dataset2}`,
+      uri: resource ? `/assets/${resource.type}/${resource.id}/${assetEndpoint}` : `/assets/${assetEndpoint}/${dataset2}`,
       headers: options.contentType ? { "Content-Type": options.contentType } : {},
       query,
       body
@@ -2887,42 +2920,6 @@ ${selectionOpts}`);
       opts
     );
   }
-  function _instruct(client, httpRequest, request) {
-    const dataset2 = hasDataset(client.config());
-    return _request(client, httpRequest, {
-      method: "POST",
-      uri: `/assist/tasks/instruct/${dataset2}`,
-      body: request
-    });
-  }
-  class ObservableAssistClient {
-    #client;
-    #httpRequest;
-    constructor(client, httpRequest) {
-      this.#client = client, this.#httpRequest = httpRequest;
-    }
-    /**
-     * Run an ad-hoc instruction for a target document.
-     * @param request instruction request
-     */
-    instruct(request) {
-      return _instruct(this.#client, this.#httpRequest, request);
-    }
-  }
-  class AssistClient {
-    #client;
-    #httpRequest;
-    constructor(client, httpRequest) {
-      this.#client = client, this.#httpRequest = httpRequest;
-    }
-    /**
-     * Run an ad-hoc instruction for a target document.
-     * @param request instruction request
-     */
-    instruct(request) {
-      return lastValueFrom(_instruct(this.#client, this.#httpRequest, request));
-    }
-  }
   var defaults = (obj, defaults2) => Object.keys(defaults2).concat(Object.keys(obj)).reduce((target, prop) => (target[prop] = typeof obj[prop] > "u" ? defaults2[prop] : obj[prop], target), {});
   const pick = (obj, props) => props.reduce((selection, prop) => (typeof obj[prop] > "u" || (selection[prop] = obj[prop]), selection), {}), eventSourcePolyfill = defer(() => Promise.resolve().then(function () { return browser$1; })).pipe(
     map(({ default: EventSource2 }) => EventSource2),
@@ -3163,6 +3160,23 @@ ${selectionOpts}`);
       );
     }
   }
+  class ThrowingDatasetsClient extends DatasetsClient {
+    constructor(client, httpRequest) {
+      super(client, httpRequest);
+    }
+    create() {
+      throw new Error("cannot create dataset with the current client configuration");
+    }
+    edit() {
+      throw new Error("cannot edit dataset with the current client configuration");
+    }
+    delete() {
+      throw new Error("cannot delete dataset with the current client configuration");
+    }
+    list() {
+      throw new Error("cannot list dataset with the current client configuration");
+    }
+  }
   function _modify(client, httpRequest, method, name, options) {
     return dataset(name), _request(client, httpRequest, {
       method,
@@ -3255,7 +3269,6 @@ ${selectionOpts}`);
     live;
     projects;
     users;
-    assist;
     /**
      * Private properties
      */
@@ -3266,7 +3279,7 @@ ${selectionOpts}`);
      */
     listen = _listen;
     constructor(httpRequest, config = defaultConfig) {
-      this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest), this.assist = new ObservableAssistClient(this, this.#httpRequest);
+      this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest);
     }
     /**
      * Clone the client - returns a new instance
@@ -3405,7 +3418,6 @@ ${selectionOpts}`);
     live;
     projects;
     users;
-    assist;
     /**
      * Observable version of the Sanity client, with the same configuration as the promise-based one
      */
@@ -3420,7 +3432,7 @@ ${selectionOpts}`);
      */
     listen = _listen;
     constructor(httpRequest, config = defaultConfig) {
-      this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.assist = new AssistClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
+      this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = this.#clientConfig.experimental_resource ? new ThrowingDatasetsClient(this, this.#httpRequest) : new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
     }
     /**
      * Clone the client - returns a new instance