@sanity/client 6.6.0 → 6.7.1-canary.0

package/src/csm/sourcemap.ts

@@ -0,0 +1,127 @@
+import type {ContentSourceMap, ContentSourceMapDocuments, ContentSourceMapMapping} from '../types'
+import {jsonPath, parseJsonPath} from './jsonpath'
+import type {PathSegment} from './types'
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+  return typeof value === 'object' && value !== null
+}
+
+function isArray(value: unknown): value is Array<unknown> {
+  return value !== null && Array.isArray(value)
+}
+
+/** @alpha */
+export type Encoder<E> = (
+  value: string,
+  sourceDocument: ContentSourceMapDocuments[number],
+  path: PathSegment[],
+) => E
+
+/** @alpha */
+export function encode<R, E>(
+  result: R,
+  csm: ContentSourceMap,
+  encoder: Encoder<E>,
+  options?: {keyArraySelectors: boolean},
+): R {
+  return encodeIntoResult(result, csm, encoder, options) as R
+}
+
+/** @alpha */
+export function encodeIntoResult<R>(
+  result: R,
+  csm: ContentSourceMap,
+  encoder: Encoder<unknown>,
+  options?: {keyArraySelectors: boolean},
+): ReturnType<Encoder<unknown>> {
+  return walkMap(result, (value, path) => {
+    // Only map strings, we could extend this in the future to support other types like integers...
+    if (typeof value !== 'string') {
+      return value
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const resolveMappingResult = resolveMapping(path, csm)
+    if (!resolveMappingResult) {
+      return value
+    }
+
+    const [mapping, matchedPath, pathSuffix] = resolveMappingResult
+    if (mapping.type !== 'value') {
+      return value
+    }
+
+    if (mapping.source.type !== 'documentValue') {
+      return value
+    }
+
+    const sourceDocument =
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      csm.documents[mapping.source.document!]
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const sourcePath = csm.paths[mapping.source.path]
+
+    if (options?.keyArraySelectors) {
+      const matchPathSegments = parseJsonPath(matchedPath)
+      const sourcePathSegments = parseJsonPath(sourcePath)
+      const fullSourceSegments = sourcePathSegments.concat(path.slice(matchPathSegments.length))
+
+      return encoder(value, sourceDocument, fullSourceSegments)
+    }
+
+    return encoder(value, sourceDocument, parseJsonPath(sourcePath + pathSuffix))
+  })
+}
+
+/** @alpha */
+export type WalkMapFn = (value: unknown, path: PathSegment[]) => unknown
+
+/** generic way to walk a nested object or array and apply a mapping function to each value
+ * @alpha
+ */
+export function walkMap(value: unknown, mappingFn: WalkMapFn, path: PathSegment[] = []): unknown {
+  if (isArray(value)) {
+    return value.map((v, idx) => {
+      if (isRecord(v)) {
+        const key = v['_key']
+        if (typeof key === 'string') {
+          return walkMap(v, mappingFn, path.concat({key, index: idx}))
+        }
+      }
+
+      return walkMap(v, mappingFn, path.concat(idx))
+    })
+  }
+
+  if (isRecord(value)) {
+    return Object.fromEntries(
+      Object.entries(value).map(([k, v]) => [k, walkMap(v, mappingFn, path.concat(k))]),
+    )
+  }
+
+  return mappingFn(value, path)
+}
+
+/** @alpha */
+export function resolveMapping(
+  resultPath: PathSegment[],
+  csm: ContentSourceMap,
+): [ContentSourceMapMapping, string, string] | undefined {
+  const resultJsonPath = jsonPath(resultPath)
+
+  if (csm.mappings[resultJsonPath] !== undefined) {
+    return [csm.mappings[resultJsonPath], resultJsonPath, '']
+  }
+
+  const mappings = Object.entries(csm.mappings)
+    .filter(([key]) => resultJsonPath.startsWith(key))
+    .sort(([key1], [key2]) => key2.length - key1.length)
+
+  if (mappings.length == 0) {
+    return undefined
+  }
+
+  const [matchedPath, mapping] = mappings[0]
+  const pathSuffix = resultJsonPath.substring(matchedPath.length)
+  return [mapping, matchedPath, pathSuffix]
+}

package/src/csm/types.ts

@@ -0,0 +1,8 @@
+/** @public */
+export type PathSegment = string | number | KeyedSegment
+
+/** @public */
+export type KeyedSegment = {key: string; index: number}
+
+/** @public */
+export type StudioUrl = `/${string}` | `${string}.sanity.studio` | `https://${string}` | string

package/src/data/dataMethods.ts

@@ -323,8 +323,9 @@ export function _requestObservable<R>(
     ['GET', 'HEAD', 'POST'].indexOf(options.method || 'GET') >= 0 &&
     uri.indexOf('/data/query/') === 0
   ) {
-    if (options.resultSourceMap ?? config.resultSourceMap) {
-      options.query = {resultSourceMap: true, ...options.query}
+    const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap
+    if (resultSourceMap !== undefined && resultSourceMap !== false) {
+      options.query = {resultSourceMap, ...options.query}
     }
     const perspective = options.perspective || config.perspective
     if (typeof perspective === 'string' && perspective !== 'raw') {

package/src/types.ts

@@ -84,7 +84,7 @@ export interface ClientConfig {
   /**
    * Adds a `resultSourceMap` key to the API response, with the type `ContentSourceMap`
    */
-  resultSourceMap?: boolean
+  resultSourceMap?: boolean | 'withKeyArraySelector'
   /**
    *@deprecated set `cache` and `next` options on `client.fetch` instead
    */

package/umd/sanityClient.js

@@ -219,17 +219,6 @@
     initMiddleware.forEach(request.use);
     return request;
   }
-  var __defProp$1 = Object.defineProperty;
-  var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value
-  }) : obj[key] = value;
-  var __publicField$1 = (obj, key, value) => {
-    __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
-    return value;
-  };
   var __accessCheck$7 = (obj, member, msg) => {
     if (!member.has(obj)) throw TypeError("Cannot " + msg);
   };
@@ -249,23 +238,11 @@
   var _method, _url, _resHeaders, _headers, _controller, _init, _useAbortSignal;
   class FetchXhr {
     constructor() {
-      /**
-       * Public interface, interop with real XMLHttpRequest
-       */
-      __publicField$1(this, "onabort");
-      __publicField$1(this, "onerror");
-      __publicField$1(this, "onreadystatechange");
-      __publicField$1(this, "ontimeout");
       /**
        * https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/readyState
        */
-      __publicField$1(this, "readyState", 0);
-      __publicField$1(this, "response");
-      __publicField$1(this, "responseText");
-      __publicField$1(this, "responseType", "");
-      __publicField$1(this, "status");
-      __publicField$1(this, "statusText");
-      __publicField$1(this, "withCredentials");
+      this.readyState = 0;
+      this.responseType = "";
       /**
        * Private implementation details
        */
@@ -1365,21 +1342,9 @@
       }
     };
   }
-  var __defProp = Object.defineProperty;
-  var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value
-  }) : obj[key] = value;
-  var __publicField = (obj, key, value) => {
-    __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-    return value;
-  };
   class Cancel {
     constructor(message) {
-      __publicField(this, "__CANCEL__", true);
-      __publicField(this, "message");
+      this.__CANCEL__ = true;
       this.message = message;
     }
     toString() {
@@ -1388,8 +1353,6 @@
   }
   const _CancelToken = class _CancelToken {
     constructor(executor) {
-      __publicField(this, "promise");
-      __publicField(this, "reason");
       if (typeof executor !== "function") {
         throw new TypeError("executor must be a function.");
       }
@@ -1406,7 +1369,7 @@
       });
     }
   };
-  __publicField(_CancelToken, "source", () => {
+  _CancelToken.source = () => {
     let cancel;
     const token = new _CancelToken(can => {
       cancel = can;
@@ -1415,7 +1378,7 @@
       token,
       cancel
     };
-  });
+  };
   var defaultShouldRetry = (err, attempt, options) => {
     if (options.method !== "GET" && options.method !== "HEAD") {
       return false;
@@ -3112,9 +3075,10 @@
       };
     }
     if (["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && uri.indexOf("/data/query/") === 0) {
-      if ((_a = options.resultSourceMap) != null ? _a : config.resultSourceMap) {
+      const resultSourceMap = (_a = options.resultSourceMap) != null ? _a : config.resultSourceMap;
+      if (resultSourceMap !== void 0 && resultSourceMap !== false) {
         options.query = {
-          resultSourceMap: true,
+          resultSourceMap,
           ...options.query
         };
       }