@sanity/client 0.0.0-dev.2 → 0.0.0-dev.4

package/dist/index.d.ts

@@ -2,6 +2,8 @@
 
 import {Observable} from 'rxjs'
 import {Requester} from 'get-it'
+import {adapter as unstable__adapter} from 'get-it'
+import {environment as unstable__environment} from 'get-it'
 
 /** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
@@ -21,6 +23,13 @@ export declare type AllDocumentsMutationOptions = BaseMutationOptions & {
  */
 export declare type Any = any
 
+/** @internal */
+export declare interface ApiError {
+  error: string
+  message: string
+  statusCode: number
+}
+
 /** @public */
 export declare type AssetMetadataType =
   | 'location'
@@ -44,7 +53,7 @@ export declare class AssetsClient {
    */
   upload(
     assetType: 'file',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityAssetDocument>
   /**
@@ -56,7 +65,7 @@ export declare class AssetsClient {
    */
   upload(
     assetType: 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityImageAssetDocument>
   /**
@@ -68,7 +77,7 @@ export declare class AssetsClient {
    */
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityAssetDocument | SanityImageAssetDocument>
 }
@@ -288,12 +297,7 @@ export declare interface ClientConfig {
    * @deprecated Don't use
    */
   requester?: Requester
-  /**
-   * Experimental, requires apiVersion: 'X' and will overlay drafts on top of published documents
-   * which lets you preview your query on what it'll look like after every document is published.
-   * @alpha
-   */
-  unstable_overlayDrafts?: boolean
+  encodeStegaSourceMap?: boolean
 }
 
 /** @public */
@@ -544,6 +548,24 @@ export declare type Mutation<R extends Record<string, Any> = Record<string, Any>
       patch: PatchMutationOperation
     }
 
+/** @internal */
+export declare interface MutationError {
+  error: {
+    type: 'mutationError'
+    description: string
+    items?: MutationErrorItem[]
+  }
+}
+
+/** @internal */
+export declare interface MutationErrorItem {
+  error: {
+    type: string
+    description: string
+    value?: unknown
+  }
+}
+
 /** @public */
 declare type MutationEvent_2<R extends Record<string, Any> = Record<string, Any>> = {
   type: 'mutation'
@@ -592,7 +614,7 @@ export declare class ObservableAssetsClient {
    */
   upload(
     assetType: 'file',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<
     HttpRequestEvent<{
@@ -608,7 +630,7 @@ export declare class ObservableAssetsClient {
    */
   upload(
     assetType: 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<
     HttpRequestEvent<{
@@ -624,7 +646,7 @@ export declare class ObservableAssetsClient {
    */
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<
     HttpRequestEvent<{
@@ -2153,6 +2175,13 @@ export declare type UnfilteredResponseQueryOptions = RequestOptions & {
   filterResponse: false
 }
 
+export {unstable__adapter}
+
+export {unstable__environment}
+
+/** @public */
+export declare type UploadBody = File | Blob | Buffer | NodeJS.ReadableStream
+
 /** @public */
 export declare interface UploadClientConfig {
   /**

package/dist/index.js

@@ -1,10 +1,10 @@
 import { debug, headers, retry, jsonRequest, jsonResponse, progress, observable } from 'get-it/middleware';
 import { getIt } from 'get-it';
+export { adapter as unstable__adapter, environment as unstable__environment } from 'get-it';
 import { Observable, lastValueFrom } from 'rxjs';
 import { map, filter } from 'rxjs/operators';
-import polyfilledEventSource from '@sanity/eventsource';
 var name = "@sanity/client";
-var version = "0.0.0-dev.2";
+var version = "0.0.0-dev.4";
 const middleware = [debug({
   verbose: true,
   namespace: "sanity:client"
@@ -13,6 +13,7 @@ const middleware = [debug({
 }), retry({
   maxRetries: 3
 })];
+const MAX_ITEMS_IN_ERROR_MESSAGE = 5;
 class ClientError extends Error {
   constructor(res) {
     const props = extractErrorProps(res);
@@ -42,6 +43,20 @@ function extractErrorProps(res) {
     props.message = "".concat(body.error, " - ").concat(body.message);
     return props;
   }
+  if (isMutationError(body)) {
+    const allItems = body.error.items || [];
+    const items = allItems.slice(0, MAX_ITEMS_IN_ERROR_MESSAGE).map(item => {
+      var _a;
+      return (_a = item.error) == null ? void 0 : _a.description;
+    }).filter(Boolean);
+    let itemsStr = items.length ? ":\n- ".concat(items.join("\n- ")) : "";
+    if (allItems.length > MAX_ITEMS_IN_ERROR_MESSAGE) {
+      itemsStr += "\n...and ".concat(allItems.length - MAX_ITEMS_IN_ERROR_MESSAGE, " more");
+    }
+    props.message = "".concat(body.error.description).concat(itemsStr);
+    props.details = body.error;
+    return props;
+  }
   if (body.error && body.error.description) {
     props.message = body.error.description;
     props.details = body.error;
@@ -50,6 +65,12 @@ function extractErrorProps(res) {
   props.message = body.error || body.message || httpErrorMessage(res);
   return props;
 }
+function isMutationError(body) {
+  return isPlainObject(body) && isPlainObject(body.error) && body.error.type === "mutationError" && typeof body.error.description === "string";
+}
+function isPlainObject(obj) {
+  return typeof obj === "object" && obj !== null && !Array.isArray(obj);
+}
 function httpErrorMessage(res) {
   const statusMessage = res.statusMessage ? " ".concat(res.statusMessage) : "";
   return "".concat(res.method, "-request to ").concat(res.url, " resulted in HTTP ").concat(res.statusCode).concat(statusMessage);
@@ -152,7 +173,7 @@ const validateObject = (op, val) => {
   }
 };
 const validateDocumentId = (op, id) => {
-  if (typeof id !== "string" || !/^[a-z0-9_.-]+$/i.test(id)) {
+  if (typeof id !== "string" || !/^[a-z0-9_][a-z0-9_.-]{0,127}$/i.test(id) || id.includes("..")) {
     throw new Error("".concat(op, "(): \"").concat(id, "\" is not a valid document ID"));
   }
 };
@@ -792,16 +813,10 @@ function _requestObservable(client, httpRequest, options) {
       ...options.query
     };
   }
-  if (config.unstable_overlayDrafts) {
-    if (config.apiVersion !== "X") {
-      console.error("You need to set `apiVersion` to `X` to use `unstable_overlayDrafts");
-    }
+  if (config.encodeStegaSourceMap) {
     options.query = {
-      ...options.query,
-      params: {
-        ...(options.query.params || {}),
-        draftMode: true
-      }
+      encodeHackySourceMap: true,
+      ...options.query
     };
   }
   const reqOptions = requestOptions(config, Object.assign({}, options, {
@@ -948,7 +963,7 @@ function _upload(client, httpRequest, assetType, body) {
   });
 }
 function optionsFromFile(opts, file) {
-  if (typeof window === "undefined" || !(file instanceof window.File)) {
+  if (typeof File === "undefined" || !(file instanceof File)) {
     return opts;
   }
   return Object.assign({
@@ -1061,7 +1076,6 @@ const pick = (obj, props) => props.reduce((selection, prop) => {
   return selection;
 }, {});
 const MAX_URL_LENGTH = 16e3 - 1200;
-const EventSource = polyfilledEventSource;
 const possibleOptions = ["includePreviousRevision", "includeResult", "visibility", "effectFormat", "tag"];
 const defaultOptions = {
   includeResult: true
@@ -1104,7 +1118,13 @@ function _listen(query, params) {
     };
   }
   return new Observable(observer => {
-    let es = getEventSource();
+    let es;
+    getEventSource().then(eventSource => {
+      es = eventSource;
+    }).catch(reason => {
+      observer.error(reason);
+      stop();
+    });
     let reconnectTimer;
     let stopped = false;
     function onError() {
@@ -1115,7 +1135,7 @@ function _listen(query, params) {
       if (stopped) {
         return;
       }
-      if (es.readyState === EventSource.CLOSED) {
+      if (es.readyState === es.CLOSED) {
         unsubscribe();
         clearTimeout(reconnectTimer);
         reconnectTimer = setTimeout(open, 100);
@@ -1134,10 +1154,11 @@ function _listen(query, params) {
       observer.complete();
     }
     function unsubscribe() {
-      es.removeEventListener("error", onError, false);
-      es.removeEventListener("channelError", onChannelError, false);
-      es.removeEventListener("disconnect", onDisconnect, false);
-      listenFor.forEach(type => es.removeEventListener(type, onMessage, false));
+      if (!es) return;
+      es.removeEventListener("error", onError);
+      es.removeEventListener("channelError", onChannelError);
+      es.removeEventListener("disconnect", onDisconnect);
+      listenFor.forEach(type => es.removeEventListener(type, onMessage));
       es.close();
     }
     function emitReconnect() {
@@ -1147,16 +1168,24 @@ function _listen(query, params) {
         });
       }
     }
-    function getEventSource() {
+    async function getEventSource() {
+      const {
+        default: EventSource
+      } = await import('@sanity/eventsource');
       const evs = new EventSource(uri, esOptions);
-      evs.addEventListener("error", onError, false);
-      evs.addEventListener("channelError", onChannelError, false);
-      evs.addEventListener("disconnect", onDisconnect, false);
-      listenFor.forEach(type => evs.addEventListener(type, onMessage, false));
+      evs.addEventListener("error", onError);
+      evs.addEventListener("channelError", onChannelError);
+      evs.addEventListener("disconnect", onDisconnect);
+      listenFor.forEach(type => evs.addEventListener(type, onMessage));
       return evs;
     }
     function open() {
-      es = getEventSource();
+      getEventSource().then(eventSource => {
+        es = eventSource;
+      }).catch(reason => {
+        observer.error(reason);
+        stop();
+      });
     }
     function stop() {
       stopped = true;