@sanity/client 6.7.1 → 6.8.0-pink-lizard.1

package/dist/csm.d.ts

@@ -0,0 +1,248 @@
+/// <reference types="node" />
+
+/**
+ * Used to tag types that is set to `any` as a temporary measure, but should be replaced with proper typings in the future
+ * @internal
+ */
+export declare type Any = any
+
+/**
+ * Optimistically applies source documents to a result, using the content source map to trace fields.
+ * Can be used to apply mutations to documents being edited in a Studio, or any mutation on Content Lake, to a result with extremely low latency.
+ * @alpha
+ */
+export declare function applySourceDocuments<Result = unknown>(
+  result: Result,
+  resultSourceMap: ContentSourceMap | undefined,
+  getCachedDocument: (
+    sourceDocument: ContentSourceMapDocuments[number],
+  ) => SanityDocument | undefined,
+  updateFn?: ApplySourceDocumentsUpdateFunction,
+): Result
+
+/**
+ * @alpha
+ */
+export declare type ApplySourceDocumentsUpdateFunction = <T = unknown>(
+  changedValue: T,
+  context: {
+    cachedDocument: SanityDocument
+    previousValue: T
+    sourceDocument: ContentSourceMapDocuments[number]
+    sourcePath: PathSegment[]
+  },
+) => T
+
+/** @public */
+export declare interface ContentSourceMap {
+  mappings: ContentSourceMapMappings
+  documents: ContentSourceMapDocuments
+  paths: ContentSourceMapPaths
+}
+
+/** @public */
+export declare interface ContentSourceMapDocument extends ContentSourceMapDocumentBase {
+  _projectId?: undefined
+  _dataset?: undefined
+}
+
+/** @public */
+export declare interface ContentSourceMapDocumentBase {
+  _id: string
+  _type: string
+}
+
+/** @public */
+export declare type ContentSourceMapDocuments = (
+  | ContentSourceMapDocument
+  | ContentSourceMapRemoteDocument
+)[]
+
+/**
+ * DocumentValueSource is a path to a value within a document
+ * @public
+ */
+export declare interface ContentSourceMapDocumentValueSource {
+  type: 'documentValue'
+  document: number
+  path: number
+}
+
+/**
+ * When a value is not from a source, its a literal
+ * @public
+ */
+export declare interface ContentSourceMapLiteralSource {
+  type: 'literal'
+}
+
+/** @public */
+export declare type ContentSourceMapMapping = ContentSourceMapValueMapping
+
+/** @public */
+export declare type ContentSourceMapMappings = Record<string, ContentSourceMapMapping>
+
+/** @public */
+export declare type ContentSourceMapPaths = string[]
+
+/** @public */
+export declare interface ContentSourceMapRemoteDocument extends ContentSourceMapDocumentBase {
+  _projectId: string
+  _dataset: string
+}
+
+/** @public */
+export declare type ContentSourceMapSource =
+  | ContentSourceMapDocumentValueSource
+  | ContentSourceMapLiteralSource
+  | ContentSourceMapUnknownSource
+
+/**
+ * When a field source is unknown
+ * @public
+ */
+export declare interface ContentSourceMapUnknownSource {
+  type: 'unknown'
+}
+
+/**
+ * ValueMapping is a mapping when for value that is from a single source value
+ * It may refer to a field within a document or a literal value
+ * @public
+ */
+export declare interface ContentSourceMapValueMapping {
+  type: 'value'
+  source: ContentSourceMapSource
+}
+
+/** @public */
+export declare function createEditLink(
+  options: CreateEditLinkOptions,
+): `${StudioUrl}${EditIntentLink}` | undefined
+
+/** @public */
+export declare interface CreateEditLinkOptions {
+  studioUrl: StudioUrl | ResolveStudioUrl
+  resultSourceMap: ContentSourceMap
+  resultPath: Path
+}
+
+/** @public */
+export declare type EditIntentLink = `/intent/edit/id=${string};type=${string};path=${string}`
+
+/** @internal */
+export declare function encodeJsonPathToUriComponent(path: string | PathSegment[]): string
+
+/**
+ * @internal
+ */
+export declare function getPublishedId(id: string): string
+
+/**
+ * @internal
+ */
+export declare function jsonPath(
+  path: PathSegment[],
+  opts?: {
+    keyArraySelectors: boolean
+  },
+): string
+
+/** @public */
+export declare type KeyedSegment = {
+  key: string
+  index: number
+}
+
+/**
+ * @internal
+ */
+export declare function parseJsonPath(path: string): PathSegment[]
+
+/** @public */
+export declare type Path = PathSegment[]
+
+/** @public */
+export declare type PathSegment = string | number | KeyedSegment
+
+/**
+ * @internal
+ */
+export declare function resolvedKeyedSourcePath(options: {
+  keyedResultPath: PathSegment[]
+  pathSuffix?: string
+  sourceBasePath: string
+}): PathSegment[]
+
+/**
+ * @internal
+ */
+export declare function resolveMapping(
+  resultPath: PathSegment[],
+  csm?: ContentSourceMap,
+):
+  | {
+      mapping: ContentSourceMapMapping
+      matchedPath: string
+      pathSuffix: string
+    }
+  | undefined
+
+/** @public */
+export declare type ResolveStudioUrl = (
+  sourceDocument: ContentSourceMapDocuments[number],
+  sourcePath: Path,
+) => StudioUrl
+
+/** @internal */
+export declare type SanityDocument<T extends Record<string, Any> = Record<string, Any>> = {
+  [P in keyof T]: T[P]
+} & {
+  _id: string
+  _rev: string
+  _type: string
+  _createdAt: string
+  _updatedAt: string
+  /**
+   * Present when `perspective` is set to `previewDrafts`
+   */
+  _originalId?: string
+}
+
+/**
+ * @internal
+ */
+export declare function simplifyPath(path: PathSegment[]): string
+
+/**
+ * Equivalent to `import type {Exclude<Path, IndexTuple>} from 'sanity'`
+ * The `IndexTuple` piece is omitted since it's irrelavent to CSM source links.
+ * @public
+ */
+export declare type StudioPathLike = (
+  | string
+  | number
+  | {
+      _key: string
+    }
+)[]
+
+/** @public */
+export declare type StudioUrl =
+  | `/${string}`
+  | `${string}.sanity.studio`
+  | `https://${string}`
+  | string
+
+/**
+ * generic way to walk a nested object or array and apply a mapping function to each value
+ * @internal
+ */
+export declare function walkMap(value: unknown, mappingFn: WalkMapFn, path?: PathSegment[]): unknown
+
+/**
+ * @internal
+ */
+export declare type WalkMapFn = (value: unknown, path: PathSegment[]) => unknown
+
+export {}

package/dist/csm.js

@@ -0,0 +1,58 @@
+import { walkMap, resolveMapping, parseJsonPath } from './_chunks/createEditLink-f3l2nngi.js';
+export { createEditLink, encodeJsonPathToUriComponent, getPublishedId, jsonPath, resolvedKeyedSourcePath, simplifyPath } from './_chunks/createEditLink-f3l2nngi.js';
+const defaultUpdateFunction = changed => changed;
+function applySourceDocuments(result, resultSourceMap, getCachedDocument) {
+  let updateFn = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : defaultUpdateFunction;
+  if (!resultSourceMap) return result;
+  return walkMap(result, (value, path) => {
+    var _a;
+    const resolveMappingResult = resolveMapping(path, resultSourceMap);
+    if (!resolveMappingResult) {
+      return value;
+    }
+    const {
+      mapping,
+      pathSuffix
+    } = resolveMappingResult;
+    if (mapping.type !== "value") {
+      return value;
+    }
+    if (mapping.source.type !== "documentValue") {
+      return value;
+    }
+    const sourceDocument = resultSourceMap.documents[mapping.source.document];
+    const sourcePath = resultSourceMap.paths[mapping.source.path];
+    if (sourceDocument) {
+      const cachedDocument = getCachedDocument(sourceDocument);
+      if (!cachedDocument) {
+        return value;
+      }
+      const parsedPath = parseJsonPath(sourcePath + pathSuffix);
+      const changedValue = cachedDocument ? (_a = getField(cachedDocument, parsedPath)) != null ? _a : value : value;
+      return value === changedValue ? value : updateFn(changedValue, {
+        cachedDocument,
+        previousValue: value,
+        sourceDocument,
+        sourcePath: parsedPath
+      });
+    }
+    return value;
+  });
+}
+function getField(obj, path) {
+  let value = obj;
+  for (const segment of path) {
+    if (typeof segment === "string") {
+      value = value[segment];
+    } else {
+      const match = typeof segment === "object" ? value.find(item => item._key === segment.key) : value[segment];
+      value = match || null;
+    }
+    if (value === null || value === void 0) {
+      break;
+    }
+  }
+  return value;
+}
+export { applySourceDocuments, parseJsonPath, resolveMapping, walkMap };
+//# sourceMappingURL=csm.js.map

package/dist/csm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"csm.js","sources":["../src/csm/applySourceDocuments.ts"],"sourcesContent":["import {parseJsonPath} from './jsonpath'\nimport {resolveMapping} from './resolveMapping'\nimport type {\n  Any,\n  ApplySourceDocumentsUpdateFunction,\n  ContentSourceMap,\n  ContentSourceMapDocuments,\n  PathSegment,\n  SanityDocument,\n} from './types'\nimport {walkMap} from './walkMap'\n\nconst defaultUpdateFunction = <T = unknown>(changed: T): T => changed\n\n/**\n * Optimistically applies source documents to a result, using the content source map to trace fields.\n * Can be used to apply mutations to documents being edited in a Studio, or any mutation on Content Lake, to a result with extremely low latency.\n * @alpha\n */\nexport function applySourceDocuments<Result = unknown>(\n  result: Result,\n  resultSourceMap: ContentSourceMap | undefined,\n  getCachedDocument: (\n    sourceDocument: ContentSourceMapDocuments[number],\n  ) => SanityDocument | undefined,\n  updateFn: ApplySourceDocumentsUpdateFunction = defaultUpdateFunction,\n): Result {\n  if (!resultSourceMap) return result\n\n  return walkMap(result, (value, path) => {\n    const resolveMappingResult = resolveMapping(path, resultSourceMap)\n    if (!resolveMappingResult) {\n      return value\n    }\n\n    const {mapping, pathSuffix} = resolveMappingResult\n    if (mapping.type !== 'value') {\n      return value\n    }\n\n    if (mapping.source.type !== 'documentValue') {\n      return value\n    }\n\n    const sourceDocument = resultSourceMap.documents[mapping.source.document]\n    const sourcePath = resultSourceMap.paths[mapping.source.path]\n\n    if (sourceDocument) {\n      const cachedDocument = getCachedDocument(sourceDocument)\n      if (!cachedDocument) {\n        return value\n      }\n\n      const parsedPath = parseJsonPath(sourcePath + pathSuffix)\n      const changedValue = cachedDocument ? getField(cachedDocument, parsedPath) ?? value : value\n      return value === changedValue\n        ? value\n        : updateFn<Result[keyof Result]>(changedValue, {\n            cachedDocument,\n            previousValue: value as Result[keyof Result],\n            sourceDocument,\n            sourcePath: parsedPath,\n          })\n    }\n\n    return value\n  }) as Result\n}\n\nfunction getField(obj: SanityDocument, path: PathSegment[]): Any {\n  let value = obj as SanityDocument | SanityDocument[keyof SanityDocument]\n  for (const segment of path) {\n    if (typeof segment === 'string') {\n      value = value[segment]\n    } else {\n      const match =\n        typeof segment === 'object'\n          ? value.find((item: SanityDocument[keyof SanityDocument]) => item._key === segment.key)\n          : value[segment]\n      value = match || null\n    }\n    if (value === null || value === undefined) {\n      break\n    }\n  }\n  return value\n}\n"],"names":["defaultUpdateFunction","changed","applySourceDocuments","result","resultSourceMap","getCachedDocument","updateFn","walkMap","value","path","_a","resolveMappingResult","resolveMapping","mapping","pathSuffix","type","source","sourceDocument","documents","document","sourcePath","paths","cachedDocument","parsedPath","parseJsonPath","changedValue","getField","previousValue","obj","segment","match","find","item","_key","key"],"mappings":";;AAYA,MAAMA,qBAAA,GAAsCC,OAAkB,IAAAA,OAAA;AAOvD,SAASC,oBACdA,CAAAC,MAAA,EACAC,eACA,EAAAC,iBAAA,EAIQ;EAAA,IADRC,+EAA+CN,qBACvC;EACR,IAAI,CAACI,eAAA,EAAwB,OAAAD,MAAA;EAE7B,OAAOI,OAAQ,CAAAJ,MAAA,EAAQ,CAACK,KAAA,EAAOC,IAAS,KAAA;IA7B1C,IAAAC,EAAA;IA8BU,MAAAC,oBAAA,GAAuBC,cAAe,CAAAH,IAAA,EAAML,eAAe,CAAA;IACjE,IAAI,CAACO,oBAAsB,EAAA;MAClB,OAAAH,KAAA;IACT;IAEM,MAAA;MAACK,OAAS;MAAAC;IAAc,CAAA,GAAAH,oBAAA;IAC1B,IAAAE,OAAA,CAAQE,SAAS,OAAS,EAAA;MACrB,OAAAP,KAAA;IACT;IAEI,IAAAK,OAAA,CAAQG,MAAO,CAAAD,IAAA,KAAS,eAAiB,EAAA;MACpC,OAAAP,KAAA;IACT;IAEA,MAAMS,cAAiB,GAAAb,eAAA,CAAgBc,SAAU,CAAAL,OAAA,CAAQG,OAAOG,QAAQ,CAAA;IACxE,MAAMC,UAAa,GAAAhB,eAAA,CAAgBiB,KAAM,CAAAR,OAAA,CAAQG,OAAOP,IAAI,CAAA;IAE5D,IAAIQ,cAAgB,EAAA;MACZ,MAAAK,cAAA,GAAiBjB,kBAAkBY,cAAc,CAAA;MACvD,IAAI,CAACK,cAAgB,EAAA;QACZ,OAAAd,KAAA;MACT;MAEM,MAAAe,UAAA,GAAaC,aAAc,CAAAJ,UAAA,GAAaN,UAAU,CAAA;MACxD,MAAMW,eAAeH,cAAiB,GAAA,CAAAZ,EAAA,GAAAgB,QAAA,CAASJ,gBAAgBC,UAAU,CAAA,KAAnC,YAAwCf,KAAQ,GAAAA,KAAA;MACtF,OAAOA,KAAU,KAAAiB,YAAA,GACbjB,KACA,GAAAF,QAAA,CAA+BmB,YAAc,EAAA;QAC3CH,cAAA;QACAK,aAAe,EAAAnB,KAAA;QACfS,cAAA;QACAG,UAAY,EAAAG;MAAA,CACb,CAAA;IACP;IAEO,OAAAf,KAAA;EAAA,CACR,CAAA;AACH;AAEA,SAASkB,QAAAA,CAASE,KAAqBnB,IAA0B,EAAA;EAC/D,IAAID,KAAQ,GAAAoB,GAAA;EACZ,KAAA,MAAWC,WAAWpB,IAAM,EAAA;IACtB,IAAA,OAAOoB,YAAY,QAAU,EAAA;MAC/BrB,KAAA,GAAQA,MAAMqB,OAAO,CAAA;IAAA,CAChB,MAAA;MACL,MAAMC,KACJ,GAAA,OAAOD,OAAY,KAAA,QAAA,GACfrB,MAAMuB,IAAK,CAACC,IAA+C,IAAAA,IAAA,CAAKC,IAAS,KAAAJ,OAAA,CAAQK,GAAG,CAAA,GACpF1B,MAAMqB,OAAO,CAAA;MACnBrB,KAAA,GAAQsB,KAAS,IAAA,IAAA;IACnB;IACI,IAAAtB,KAAA,KAAU,IAAQ,IAAAA,KAAA,KAAU,KAAW,CAAA,EAAA;MACzC;IACF;EACF;EACO,OAAAA,KAAA;AACT;"}