@sanity/client 6.15.6 → 6.15.8

package/README.md

@@ -65,11 +65,14 @@ export async function updateDocumentTitle(_id, title) {
     - [Browser ESM CDN](#browser-esm-cdn)
     - [UMD](#umd)
   - [Specifying API version](#specifying-api-version)
+  - [Request tags](#request-tags)
   - [Performing queries](#performing-queries)
   - [Using perspectives](#using-perspectives)
     - [`published`](#published)
     - [`previewDrafts`](#previewdrafts)
   - [Fetching Content Source Maps](#fetching-content-source-maps)
+    - [Using Visual editing with steganography](#using-visual-editing-with-steganography)
+    - [Creating Studio edit intent links](#creating-studio-edit-intent-links)
   - [Listening to queries](#listening-to-queries)
   - [Fetch a single document](#fetch-a-single-document)
   - [Fetch multiple documents in one go](#fetch-multiple-documents-in-one-go)
@@ -94,13 +97,28 @@ export async function updateDocumentTitle(_id, title) {
   - [Deleting an asset](#deleting-an-asset)
   - [Mutation options](#mutation-options)
   - [Aborting a request](#aborting-a-request)
+    - [1. Abort a request by passing an AbortSignal with the request options](#1-abort-a-request-by-passing-an-abortsignal-with-the-request-options)
+    - [2. Cancel a request by unsubscribing from the Observable](#2-cancel-a-request-by-unsubscribing-from-the-observable)
   - [Get client configuration](#get-client-configuration)
   - [Set client configuration](#set-client-configuration)
-- [Release new version](#release-new-version)
 - [License](#license)
-- [Migrate](#migrate)
-  - [From `v5`](#from-v5)
-  - [From `v4`](#from-v4)
+- [From `v5`](#from-v5)
+  - [The default `useCdn` is changed to `true`](#the-default-usecdn-is-changed-to-true)
+- [From `v4`](#from-v4)
+  - [No longer shipping `ES5`](#no-longer-shipping-es5)
+  - [Node.js `v12` no longer supported](#nodejs-v12-no-longer-supported)
+  - [The `default` export is replaced with the named export `createClient`](#the-default-export-is-replaced-with-the-named-export-createclient)
+  - [`client.assets.delete` is removed](#clientassetsdelete-is-removed)
+  - [`client.assets.getImageUrl` is removed, replace with `@sanity/image-url`](#clientassetsgetimageurl-is-removed-replace-with-sanityimage-url)
+  - [`SanityClient` static properties moved to named exports](#sanityclient-static-properties-moved-to-named-exports)
+  - [`client.clientConfig` is removed, replace with `client.config()`](#clientclientconfig-is-removed-replace-with-clientconfig)
+  - [`client.isPromiseAPI()` is removed, replace with an `instanceof` check](#clientispromiseapi-is-removed-replace-with-an-instanceof-check)
+  - [`client.observable.isObservableAPI()` is removed, replace with an `instanceof` check](#clientobservableisobservableapi-is-removed-replace-with-an-instanceof-check)
+  - [`client._requestObservable` is removed, replace with `client.observable.request`](#client_requestobservable-is-removed-replace-with-clientobservablerequest)
+  - [`client._dataRequest` is removed, replace with `client.dataRequest`](#client_datarequest-is-removed-replace-with-clientdatarequest)
+  - [`client._create_` is removed, replace with one of `client.create`, `client.createIfNotExists` or `client.createOrReplace`](#client_create_-is-removed-replace-with-one-of-clientcreate-clientcreateifnotexists-or-clientcreateorreplace)
+  - [`client.patch.replace` is removed, replace with `client.createOrReplace`](#clientpatchreplace-is-removed-replace-with-clientcreateorreplace)
+  - [`client.auth` is removed, replace with `client.request`](#clientauth-is-removed-replace-with-clientrequest)
 
 ## Requirements
 
@@ -428,6 +446,31 @@ In general, unless you know what API version you want to use, you'll want to sta
 
 In future versions, specifying an API version will be required. For now (to maintain backwards compatiblity) not specifying a version will trigger a deprecation warning and fall back to using `v1`.
 
+### Request tags
+
+Request tags are values assigned to API and CDN requests that can be used to filter and aggregate log data within [request logs][request-logs] from your Sanity Content Lake.
+
+Sanity Client has out-of-the-box support for tagging every API and CDN request on two levels:
+
+- Globally: Using the `requestTagPrefix` client configuration parameter
+- Per Request: Pass the tag option to the SDK’s Request method.
+
+The following example will result in a query with `tag=website.landing-page`:
+
+```ts
+const client = createClient({
+  projectId: '<project>',
+  dataset: '<dataset>',
+  useCdn: true,
+  apiVersion: '2024-01-24',
+  requestTagPrefix: 'website', // Added to every request
+})
+
+const posts = await client.fetch('*[_type == "post"]', {
+  tag: `index-page`, // Appended to requestTagPrefix for this individual request
+})
+```
+
 ### Performing queries
 
 ```js
@@ -640,7 +683,7 @@ Enabling Content Source Maps is a two-step process:
    console.log(resultSourceMap)
    ```
 
-If your `apiVersion` is `2021-03-25` or later, the `resultSourceMap` property will always exist in the response after enabling it. If there is no source map, `resultSourceMap` is an empty object.  
+If your `apiVersion` is `2021-03-25` or later, the `resultSourceMap` property will always exist in the response after enabling it. If there is no source map, `resultSourceMap` is an empty object.
 This is the corresponding TypeScript definition:
 
 ```ts
@@ -1608,3 +1651,4 @@ await client.request<void>({uri: '/auth/logout', method: 'POST'})
 [visual-editing]: https://www.sanity.io/docs/vercel-visual-editing?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch
 [content-source-maps]: https://www.sanity.io/docs/content-source-maps?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch
 [content-source-maps-intro]: https://www.sanity.io/blog/content-source-maps-announce?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch
+[request-logs]: https://www.sanity.io/docs/request-logs?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch

package/dist/_chunks-cjs/nodeMiddleware.cjs

@@ -1474,7 +1474,7 @@ function defineCreateClientExports(envMiddleware, ClassConstructor) {
     config
   ) };
 }
-var name = "@sanity/client", version = "6.15.6";
+var name = "@sanity/client", version = "6.15.8";
 const middleware = [
   middleware$1.debug({ verbose: !0, namespace: "sanity:client" }),
   middleware$1.headers({ "User-Agent": `${name} ${version}` }),

package/dist/_chunks-es/nodeMiddleware.js

@@ -1455,7 +1455,7 @@ function defineCreateClientExports(envMiddleware, ClassConstructor) {
     config
   ) };
 }
-var name = "@sanity/client", version = "6.15.6";
+var name = "@sanity/client", version = "6.15.8";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),

package/dist/csm.d.cts

@@ -0,0 +1,349 @@
+/// <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],
+  ) => Partial<SanityDocument> | null | undefined,
+  updateFn?: ApplySourceDocumentsUpdateFunction,
+  perspective?: ClientPerspective,
+): Result
+
+/**
+ * @alpha
+ */
+export declare type ApplySourceDocumentsUpdateFunction = <T = unknown>(
+  changedValue: T,
+  context: {
+    cachedDocument: Partial<SanityDocument>
+    previousValue: T
+    sourceDocument: ContentSourceMapDocuments[number]
+    sourcePath: ContentSourceMapParsedPath
+  },
+) => T
+
+/** @public */
+export declare type ClientPerspective = 'previewDrafts' | 'published' | 'raw'
+
+/** @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>
+
+/** @alpha */
+export declare type ContentSourceMapParsedPath = (
+  | string
+  | number
+  | ContentSourceMapParsedPathKeyedSegment
+)[]
+
+/** @alpha */
+export declare type ContentSourceMapParsedPathKeyedSegment = {
+  _key: string
+  _index: number
+}
+
+/**
+ * @alpha
+ * @deprecated use `ContentSourceMapParsedPath[number]` instead
+ */
+export declare type ContentSourceMapParsedPathSegment = ContentSourceMapParsedPath[number]
+
+/** @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
+}
+
+/** @internal */
+export declare function createEditUrl(
+  options: CreateEditUrlOptions,
+): `${StudioBaseUrl}${EditIntentUrl}`
+
+/** @internal */
+export declare interface CreateEditUrlOptions {
+  baseUrl: string
+  workspace?: string
+  tool?: string
+  id: string
+  type: string
+  path: ContentSourceMapParsedPath | string
+  projectId?: string
+  dataset?: string
+}
+
+/** @alpha */
+export declare type EditIntentUrl =
+  `/intent/edit/mode=presentation;id=${string};type=${string};path=${string}`
+
+/** @alpha */
+declare function fromString(path: string): Path
+
+/** @internal */
+declare function get<Result = unknown, Fallback = unknown>(
+  obj: unknown,
+  path: Path | string,
+  defaultVal?: Fallback,
+): Result | typeof defaultVal
+
+/** @internal */
+export declare function getPublishedId(id: string): string
+
+/** @alpha */
+export declare type IndexTuple = [number | '', number | '']
+
+/** @internal */
+declare function isIndexSegment(segment: PathSegment): segment is number
+
+/** @internal */
+declare function isIndexTuple(segment: PathSegment): segment is IndexTuple
+
+/** @internal */
+declare function isKeySegment(segment: PathSegment): segment is KeyedSegment
+
+/**
+ * @internal
+ */
+export declare function jsonPath(path: ContentSourceMapParsedPath): ContentSourceMapPaths[number]
+
+/**
+ * @internal
+ */
+export declare function jsonPathToStudioPath(path: ContentSourceMapParsedPath): Path
+
+/** @alpha */
+export declare type KeyedSegment = {
+  _key: string
+}
+
+/**
+ * @internal
+ */
+export declare function parseJsonPath(
+  path: ContentSourceMapPaths[number],
+): ContentSourceMapParsedPath
+
+/** @alpha */
+export declare type Path = PathSegment[]
+
+/** @alpha */
+export declare type PathSegment = string | number | KeyedSegment | IndexTuple
+
+/** @internal */
+declare const reKeySegment: RegExp
+
+/**
+ * @internal
+ */
+export declare function resolvedKeyedSourcePath(options: {
+  keyedResultPath: ContentSourceMapParsedPath
+  pathSuffix?: string
+  sourceBasePath: string
+}): ContentSourceMapParsedPath
+
+/** @internal */
+export declare function resolveEditInfo(
+  options: ResolveEditInfoOptions,
+): CreateEditUrlOptions | undefined
+
+/** @alpha */
+export declare interface ResolveEditInfoOptions {
+  studioUrl: StudioUrl | ResolveStudioUrl
+  resultSourceMap: ContentSourceMap
+  resultPath: ContentSourceMapParsedPath
+}
+
+/** @alpha */
+export declare function resolveEditUrl(
+  options: ResolveEditUrlOptions,
+): ReturnType<typeof createEditUrl> | undefined
+
+/** @alpha */
+export declare interface ResolveEditUrlOptions extends Omit<ResolveEditInfoOptions, 'resultPath'> {
+  resultPath: StudioPathLike
+}
+
+/**
+ * @internal
+ */
+export declare function resolveMapping(
+  resultPath: ContentSourceMapParsedPath,
+  csm?: ContentSourceMap,
+):
+  | {
+      mapping: ContentSourceMapMapping
+      matchedPath: string
+      pathSuffix: string
+    }
+  | undefined
+
+/** @alpha */
+export declare type ResolveStudioUrl = (
+  sourceDocument: ContentSourceMapDocuments[number],
+) => 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
+}
+
+/** @alpha */
+export declare type StudioBaseRoute = {
+  baseUrl: StudioBaseUrl
+  workspace?: string
+  tool?: string
+}
+
+/** @alpha */
+export declare type StudioBaseUrl =
+  | `/${string}`
+  | `${string}.sanity.studio`
+  | `https://${string}`
+  | string
+
+declare namespace studioPath {
+  export {
+    isIndexSegment,
+    isKeySegment,
+    isIndexTuple,
+    get,
+    toString_2 as toString,
+    fromString,
+    KeyedSegment,
+    IndexTuple,
+    PathSegment,
+    Path,
+    reKeySegment,
+  }
+}
+export {studioPath}
+
+/**
+ * Path syntax as used by the `sanity` package, you can give it a string:
+ * `products[0].images[_key=="abc123"].asset._ref`
+ * or an array:
+ * `['products', 0, 'images', {_key: 'abc123'}, 'asset', '_ref']`
+ * @alpha
+ */
+export declare type StudioPathLike = Path | string
+
+/**
+ * @internal
+ */
+export declare function studioPathToJsonPath(path: Path | string): ContentSourceMapParsedPath
+
+/** @alpha */
+export declare type StudioUrl = StudioBaseUrl | StudioBaseRoute
+
+/** @alpha */
+declare function toString_2(path: Path): 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?: ContentSourceMapParsedPath,
+): unknown
+
+/**
+ * @internal
+ */
+export declare type WalkMapFn = (value: unknown, path: ContentSourceMapParsedPath) => unknown
+
+export {}