@sanity/client 5.4.3-dev.0 → 5.4.3-dev.2

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.0";
+var version = "5.4.3-dev.2";
 const middleware = [middleware$1.debug({
   verbose: true,
   namespace: "sanity:client"

package/dist/index.d.ts

@@ -322,11 +322,72 @@ 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 interface ContentSourceMap {
+  mappings: ContentSourceMapMappings
+  documents: ContentSourceMapDocuments
+  paths: ContentSourceMapPaths
+}
+
+/** @public */
+export declare interface ContentSourceMapDocument {
+  _projectId: string
+  _dataset: string
+  _id: string
+}
+
+/** @public */
+export declare type ContentSourceMapDocuments = ContentSourceMapDocument[]
+
+/**
+ * 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 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 */
@@ -411,16 +472,6 @@ 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
@@ -430,7 +481,7 @@ export declare interface ErrorProps {
   details: Any
 }
 
-/** @internal */
+/** @public */
 export declare type FilteredResponseQueryOptions = RequestOptions & {
   filterResponse?: true
 }
@@ -550,17 +601,6 @@ 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
@@ -1445,12 +1485,12 @@ export declare type QueryParams = {
   [key: string]: Any
 }
 
-/** @internal */
+/** @public */
 export declare interface RawQueryResponse<R> {
   q: string
   ms: number
   result: R
-  resultSourceMap: ContentSourceMapping
+  resultSourceMap: ContentSourceMap
 }
 
 /** @internal */
@@ -2125,9 +2165,6 @@ export declare interface SingleMutationResult {
   }[]
 }
 
-/** @internal */
-export declare type Source = DocumentValueSource | LiteralSource | UnknownSource
-
 /** @public */
 export declare class Transaction extends BaseTransaction {
   #private
@@ -2218,19 +2255,11 @@ export declare type TransactionMutationOptions =
   | TransactionAllDocumentsMutationOptions
   | TransactionAllDocumentIdsMutationOptions
 
-/** @internal */
+/** @public */
 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}
@@ -2311,16 +2340,6 @@ 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.3-dev.0";
+var version = "5.4.3-dev.2";
 const middleware = [debug({
   verbose: true,
   namespace: "sanity:client"

package/package.json

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

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

@@ -1,6 +1,9 @@
+// @TODO the types in this file should be split into their own files, that's why the file is named `_legacy`
 // deno-lint-ignore-file no-empty-interface
 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
@@ -472,72 +475,22 @@ export interface ListenOptions {
   tag?: string
 }
 
-/** @internal */
+/** @public */
 export type FilteredResponseQueryOptions = RequestOptions & {
   filterResponse?: true
 }
 
-/**
- * DocumentValueSource is a path to a value within a document
- * @internal
- */
-export type DocumentValueSource = {
-  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
- * @internal
- */
-export type LiteralSource = {
-  type: 'literal'
-}
-/**
- * When a field source is unknown
- * @internal
- */
-export type UnknownSource = {
-  type: 'unknown'
-}
-/** @internal */
-export type Source = DocumentValueSource | LiteralSource | UnknownSource
-/**
- * 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 type ValueMapping = {
-  type: 'value'
-
-  // source of the value
-  source: Source
-}
-
-/** @internal */
-export type Mapping = ValueMapping
-
-/** @internal */
+/** @public */
 export type UnfilteredResponseQueryOptions = RequestOptions & {
   filterResponse: false
 }
 
-/** @internal */
-export type ContentSourceMapping = {
-  mappings: Record<string, Mapping>
-  documents: Array<SanityDocument>
-  paths: Array<string>
-}
-
-/** @internal */
+/** @public */
 export interface RawQueryResponse<R> {
   q: string
   ms: number
   result: R
-  resultSourceMap: ContentSourceMapping
+  resultSourceMap: ContentSourceMap
 }
 
 /** @internal */

package/src/types/index.ts

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

package/src/types/resultSourceMap.ts

@@ -0,0 +1,65 @@
+/**
+ * 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
+}