@sanity/client 5.4.3-dev.3 → 6.0.0

package/README.md

@@ -27,7 +27,7 @@ export const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: true, // set to `false` to bypass the edge cache
-  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
   // token: process.env.SANITY_SECRET_TOKEN // Only if you want to update content with the client
 })
 
@@ -65,7 +65,6 @@ export async function updateDocumentTitle(_id, title) {
     - [UMD](#umd)
   - [Specifying API version](#specifying-api-version)
   - [Performing queries](#performing-queries)
-  - [Get started with Content Source Maps](#get-started-with-content-source-maps)
   - [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)
@@ -133,7 +132,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: true, // set to `false` to bypass the edge cache
-  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const data = await client.fetch(`count(*)`)
@@ -149,7 +148,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: true, // set to `false` to bypass the edge cache
-  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 client
@@ -167,7 +166,7 @@ const config: ClientConfig = {
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: true, // set to `false` to bypass the edge cache
-  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
 }
 const client = createClient(config)
 
@@ -187,7 +186,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: true, // set to `false` to bypass the edge cache
-  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const schema = z.number()
@@ -214,7 +213,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: true, // set to `false` to bypass the edge cache
-  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const data = await client.fetch<number>(`count(*)`)
@@ -242,7 +241,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: true, // set to `false` to bypass the edge cache
-  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const data = await client.fetch<number>(`count(*)`)
@@ -275,7 +274,7 @@ export default async function handler(req: NextRequest) {
     projectId: 'your-project-id',
     dataset: 'your-dataset-name',
     useCdn: true, // set to `false` to bypass the edge cache
-    apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+    apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
   })
 
   const count = await client.fetch<number>(`count(*)`)
@@ -306,7 +305,7 @@ Using [esm.sh] you can either load the client using a `<script type="module">` t
     projectId: 'your-project-id',
     dataset: 'your-dataset-name',
     useCdn: true, // set to `false` to bypass the edge cache
-    apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+    apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
   })
 
   const data = await client.fetch(`count(*)`)
@@ -325,7 +324,7 @@ const client = createClient({
   projectId: 'your-project-id',
   dataset: 'your-dataset-name',
   useCdn: true, // set to `false` to bypass the edge cache
-  apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+  apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
 })
 
 const data = await client.fetch(`count(*)`)
@@ -347,7 +346,7 @@ Loading the UMD script creates a `SanityClient` global that have the same export
     projectId: 'your-project-id',
     dataset: 'your-dataset-name',
     useCdn: true, // set to `false` to bypass the edge cache
-    apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+    apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
   })
 
   client.fetch(`count(*)`).then((data) => console.log(`Number of documents: ${data}`))
@@ -368,7 +367,7 @@ The `require-unpkg` library lets you consume `npm` packages from `unpkg.com` sim
       projectId: 'your-project-id',
       dataset: 'your-dataset-name',
       useCdn: true, // set to `false` to bypass the edge cache
-      apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
+      apiVersion: '2022-01-12', // use current date (YYYY-MM-DD) to target the latest API version
     })
 
     const data = await client.fetch(`count(*)`)
@@ -405,58 +404,6 @@ client.fetch(query, params).then((bikes) => {
 
 Perform a query using the given parameters (if any).
 
-### Get started with Content Source Maps
-
-> **Note**
->
-> [Content Source Maps][content-source-maps-intro] are available [as an API][content-source-maps] for select [Sanity enterprise customers][enterprise-cta]. [Contact our sales team for more information.][sales-cta]
-
-[Visual editing][visual-editing] is available in [`@sanity/preview-kit/client`][preview-kit-client]. It offers both a turn-key solution and a flexible API for custom experiences.
-
-This guide is for developers who want to build custom use cases beyond, or in addition to, [visual editing][visual-editing]. Read the [Content Source Maps introduction][content-source-maps-intro] before diving in, and keep the [Content Source Maps reference][content-source-maps] handy.
-
-Enabling Content Source Maps is a two-step process:
-
-1. Update your client configuration with `resultSourceMap`.
-
-   ```js
-   import {createClient} from '@sanity/client'
-
-   const client = createClient({
-     projectId: 'your-project-id',
-     dataset: 'your-dataset-name',
-     useCdn: true, // set to `false` to bypass the edge cache
-     apiVersion: '2023-05-03', // use current date (YYYY-MM-DD) to target the latest API version
-     resultSourceMap: true, // tells the API to start sending source maps, if available
-   })
-   ```
-
-2. On `client.fetch` calls add `{filterResponse: false}` to return the full response on queries.
-
-   ```js
-   // Before
-   // const result = await client.fetch(query, params)
-
-   // After adding `filterResponse: false`
-   const {result, resultSourceMap} = await client.fetch(query, params, {filterResponse: false})
-   // Build something cool with the source map
-   console.log(resultSourceMap)
-   ```
-
-Once enabled, the `resultSourceMap` property will always exist on the response, given your `apiVersion` is recent enough. If there is no source map, it will be an empty object. There's also a TypeScript definition for it:
-
-```ts
-import type {ContentSourceMapping} from '@sanity/client'
-
-const {result, resultSourceMap} = await client.fetch(query, params, {filterResponse: false})
-
-function useContentSourceMap(resultSourceMap: ContentSourceMapping): unknown {
-  // Sky's the limit
-}
-
-useContentSourceMap(resultSourceMap)
-```
-
 ### Listening to queries
 
 ```js
@@ -1295,9 +1242,3 @@ await client.request<void>({uri: '/auth/logout', method: 'POST'})
 [groqd]: https://github.com/FormidableLabs/groqd#readme
 [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
 [AbortController]: https://developer.mozilla.org/en-US/docs/Web/API/AbortController
-[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
-[preview-kit-client]: https://github.com/sanity-io/preview-kit#sanitypreview-kitclient
-[sales-cta]: https://www.sanity.io/contact/sales?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch
-[enterprise-cta]: https://www.sanity.io/enterprise?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch

package/dist/index.cjs

@@ -8,7 +8,7 @@ var getIt = require('get-it');
 var rxjs = require('rxjs');
 var operators = require('rxjs/operators');
 var name = "@sanity/client";
-var version = "5.4.3-dev.3";
+var version = "6.0.0";
 const middleware = [middleware$1.debug({
   verbose: true,
   namespace: "sanity:client"

package/dist/index.d.ts

@@ -331,13 +331,14 @@ export declare interface ContentSourceMap {
 
 /** @public */
 export declare interface ContentSourceMapDocument {
-  _projectId: string
-  _dataset: string
   _id: string
 }
 
 /** @public */
-export declare type ContentSourceMapDocuments = ContentSourceMapDocument[]
+export declare type ContentSourceMapDocuments = (
+  | ContentSourceMapDocument
+  | ContentSourceMapRemoteDocument
+)[]
 
 /**
  * DocumentValueSource is a path to a value within a document
@@ -366,6 +367,12 @@ export declare type ContentSourceMapMappings = Record<string, ContentSourceMapMa
 /** @public */
 export declare type ContentSourceMapPaths = string[]
 
+/** @public */
+export declare interface ContentSourceMapRemoteDocument extends ContentSourceMapDocument {
+  _projectId: string
+  _dataset: string
+}
+
 /** @public */
 export declare type ContentSourceMapSource =
   | ContentSourceMapDocumentValueSource

package/dist/index.js

@@ -4,7 +4,7 @@ export { adapter as unstable__adapter, environment as unstable__environment } fr
 import { Observable, lastValueFrom } from 'rxjs';
 import { map, filter } from 'rxjs/operators';
 var name = "@sanity/client";
-var version = "5.4.3-dev.3";
+var version = "6.0.0";
 const middleware = [debug({
   verbose: true,
   namespace: "sanity:client"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "5.4.3-dev.3",
+  "version": "6.0.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/{types/_legacy.ts → types.ts}

@@ -1,11 +1,7 @@
 // deno-lint-ignore-file no-empty-interface
-// eslint-disable-next-line no-warning-comments
-// @TODO the types in this file should be split into their own files, that's why the file is named `_legacy`
 
 import type {Requester} from 'get-it'
 
-import type {ContentSourceMap} from './resultSourceMap'
-
 /**
  * Used to tag types that is set to `any` as a temporary measure, but should be replaced with proper typings in the future
  * @internal
@@ -623,3 +619,76 @@ export interface MutationErrorItem {
     value?: unknown
   }
 }
+
+/**
+ * DocumentValueSource is a path to a value within a document
+ * @public
+ */
+export interface ContentSourceMapDocumentValueSource {
+  type: 'documentValue'
+  // index location of the document
+  document: number
+  // index location of the path
+  path: number
+}
+/**
+ * When a value is not from a source, its a literal
+ * @public
+ */
+export interface ContentSourceMapLiteralSource {
+  type: 'literal'
+}
+/**
+ * When a field source is unknown
+ * @public
+ */
+export interface ContentSourceMapUnknownSource {
+  type: 'unknown'
+}
+/** @public */
+export type ContentSourceMapSource =
+  | ContentSourceMapDocumentValueSource
+  | ContentSourceMapLiteralSource
+  | ContentSourceMapUnknownSource
+/**
+ * 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 interface ContentSourceMapValueMapping {
+  type: 'value'
+  // source of the value
+  source: ContentSourceMapSource
+}
+/** @public */
+export type ContentSourceMapMapping = ContentSourceMapValueMapping
+
+/** @public */
+export type ContentSourceMapMappings = Record<string, ContentSourceMapMapping>
+
+/** @public */
+export interface ContentSourceMapDocument {
+  _id: string
+}
+
+/** @public */
+export interface ContentSourceMapRemoteDocument extends ContentSourceMapDocument {
+  _projectId: string
+  _dataset: string
+}
+
+/** @public */
+export type ContentSourceMapDocuments = (
+  | ContentSourceMapDocument
+  | ContentSourceMapRemoteDocument
+)[]
+
+/** @public */
+export type ContentSourceMapPaths = string[]
+
+/** @public */
+export interface ContentSourceMap {
+  mappings: ContentSourceMapMappings
+  documents: ContentSourceMapDocuments
+  paths: ContentSourceMapPaths
+}

package/src/types/index.ts

@@ -1,2 +0,0 @@
-export type * from './_legacy'
-export type * from './resultSourceMap'

package/src/types/resultSourceMap.ts

@@ -1,65 +0,0 @@
-/**
- * DocumentValueSource is a path to a value within a document
- * @public
- */
-export interface ContentSourceMapDocumentValueSource {
-  type: 'documentValue'
-  // index location of the document
-  document: number
-  // index location of the path
-  path: number
-}
-/**
- * When a value is not from a source, its a literal
- * @public
- */
-export interface ContentSourceMapLiteralSource {
-  type: 'literal'
-}
-/**
- * When a field source is unknown
- * @public
- */
-export interface ContentSourceMapUnknownSource {
-  type: 'unknown'
-}
-/** @public */
-export type ContentSourceMapSource =
-  | ContentSourceMapDocumentValueSource
-  | ContentSourceMapLiteralSource
-  | ContentSourceMapUnknownSource
-/**
- * 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 interface ContentSourceMapValueMapping {
-  type: 'value'
-  // source of the value
-  source: ContentSourceMapSource
-}
-/** @public */
-export type ContentSourceMapMapping = ContentSourceMapValueMapping
-
-/** @public */
-export type ContentSourceMapMappings = Record<string, ContentSourceMapMapping>
-
-/** @public */
-export interface ContentSourceMapDocument {
-  _projectId: string
-  _dataset: string
-  _id: string
-}
-
-/** @public */
-export type ContentSourceMapDocuments = ContentSourceMapDocument[]
-
-/** @public */
-export type ContentSourceMapPaths = string[]
-
-/** @public */
-export interface ContentSourceMap {
-  mappings: ContentSourceMapMappings
-  documents: ContentSourceMapDocuments
-  paths: ContentSourceMapPaths
-}