@sanity/client 5.4.1 → 5.4.2-dev.0

package/dist/index.d.ts

@@ -297,6 +297,7 @@ export declare interface ClientConfig {
    * @deprecated Don't use
    */
   requester?: Requester
+  resultSourceMap?: boolean
 }
 
 /** @public */
@@ -308,6 +309,13 @@ export declare class ClientError extends Error {
   constructor(res: Any)
 }
 
+/** @internal */
+export declare type ContentSourceMapping = {
+  mappings: Record<string, Mapping>
+  documents: Array<SanityDocument>
+  paths: Array<string>
+}
+
 /** @public */
 export declare const createClient: (config: ClientConfig) => SanityClient
 
@@ -390,6 +398,16 @@ export declare type DisconnectEvent = {
   reason: string
 }
 
+/**
+ * DocumentValueSource is a path to a value within a document
+ * @internal
+ */
+export declare type DocumentValueSource = {
+  type: 'documentValue'
+  document: number
+  path: number
+}
+
 /** @public */
 export declare interface ErrorProps {
   message: string
@@ -519,6 +537,17 @@ export declare interface ListenOptions {
   tag?: string
 }
 
+/**
+ * When a value is not from a source, its a literal
+ * @internal
+ */
+export declare type LiteralSource = {
+  type: 'literal'
+}
+
+/** @internal */
+export declare type Mapping = ValueMapping
+
 /** @internal */
 export declare interface MultipleMutationResult {
   transactionId: string
@@ -1408,6 +1437,7 @@ export declare interface RawQueryResponse<R> {
   q: string
   ms: number
   result: R
+  resultSourceMap: ContentSourceMapping
 }
 
 /** @internal */
@@ -2079,6 +2109,9 @@ export declare interface SingleMutationResult {
   }[]
 }
 
+/** @internal */
+export declare type Source = DocumentValueSource | LiteralSource | UnknownSource
+
 /** @public */
 export declare class Transaction extends BaseTransaction {
   #private
@@ -2174,6 +2207,14 @@ export declare type UnfilteredResponseQueryOptions = RequestOptions & {
   filterResponse: false
 }
 
+/**
+ * When a field source is unknown
+ * @internal
+ */
+export declare type UnknownSource = {
+  type: 'unknown'
+}
+
 export {unstable__adapter}
 
 export {unstable__environment}
@@ -2254,6 +2295,16 @@ export declare class UsersClient {
   getById<T extends 'me' | string>(id: T): Promise<T extends 'me' ? CurrentSanityUser : SanityUser>
 }
 
+/**
+ * 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
+ * @internal
+ */
+export declare type ValueMapping = {
+  type: 'value'
+  source: Source
+}
+
 /** @public */
 export declare type WelcomeEvent = {
   type: 'welcome'

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.1";
+var version = "5.4.2-dev.0";
 const middleware = [debug({
   verbose: true,
   namespace: "sanity:client"
@@ -813,6 +813,12 @@ function _requestObservable(client, httpRequest, options) {
       ...options.query
     };
   }
+  if (config.resultSourceMap) {
+    options.query = {
+      resultSourceMap: true,
+      ...options.query
+    };
+  }
   const reqOptions = requestOptions(config, Object.assign({}, options, {
     url: _getUrl(client, uri, useCdn)
   }));