@sanity/client 6.11.3 → 6.11.4-canary.1

package/dist/index.d.ts

@@ -42,7 +42,8 @@ export declare type AssetMetadataType =
 
 /** @internal */
 export declare class AssetsClient {
-  #private
+  private [clientSymbol]
+  private [httpRequestSymbol]
   constructor(client: SanityClient, httpRequest: HttpRequest)
   /**
    * Uploads a file asset to the configured dataset
@@ -325,8 +326,14 @@ export declare interface ClientConfig {
    *@deprecated set `cache` and `next` options on `client.fetch` instead
    */
   fetch?: RequestFetchOptions | boolean
+  /**
+   * Options for how, if enabled, Content Source Maps are encoded into query results using steganography
+   */
+  stega?: StegaConfig | boolean
 }
 
+declare const clientConfigSymbol: unique symbol
+
 /** @public */
 export declare class ClientError extends Error {
   response: ErrorProps['response']
@@ -339,6 +346,18 @@ export declare class ClientError extends Error {
 /** @public */
 export declare type ClientPerspective = 'previewDrafts' | 'published' | 'raw'
 
+declare const clientSymbol: unique symbol
+
+declare const clientSymbol_2: unique symbol
+
+declare const clientSymbol_3: unique symbol
+
+declare const clientSymbol_4: unique symbol
+
+declare const clientSymbol_5: unique symbol
+
+declare const clientSymbol_6: unique symbol
+
 /** @public */
 export declare interface ContentSourceMap {
   mappings: ContentSourceMapMappings
@@ -388,6 +407,19 @@ 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
+}
+
 /** @public */
 export declare type ContentSourceMapPaths = string[]
 
@@ -444,7 +476,8 @@ export declare type DatasetResponse = {
 
 /** @internal */
 export declare class DatasetsClient {
-  #private
+  private [clientSymbol_2]
+  private [httpRequestSymbol_2]
   constructor(client: SanityClient, httpRequest: HttpRequest)
   /**
    * Create a new dataset with the given name
@@ -521,7 +554,56 @@ export declare interface ErrorProps {
 }
 
 /** @public */
-export declare type FilteredResponseQueryOptions = ResponseQueryOptions & {
+export declare type FilterDefault = (props: {
+  /**
+   * The path to the value in the source document, for example if you queried for a document like this:
+   * `*[_type == "author"][0]{"slug": slug.current}`
+   * Then the `sourcePath` for `result.slug` would be `['slug', 'current']`.
+   *
+   */
+  sourcePath: ContentSourceMapParsedPath
+  /**
+   * If `sourcePath` alone isn't enough to tell you if it's safe to contain stega strings, then you can use `sourceDocument`
+   * for additional metadata.
+   * It'll always have a `_type` property, which can be used to trace it to the Studio Schema that were used initially.
+   * It also has `_id` to help you debug and look at the whole document when troubleshooting.
+   * Finally, if the document origins in a Cross Dataset Reference you'll also have `_projectId` and `_dataset` properties to help you trace it.
+   */
+  sourceDocument: ContentSourceMapDocuments[number]
+  /**
+   * If you don't colocate your Studio Schemas with your GROQ queries it might be hard to make sense of `sourcePath`,
+   * as it operates on the original shape of a document.
+   * In that case `resultPath` can be used, as it mirrors the path to the value in the result.
+   * For example in a query like this:
+   * `*[_type == "author"][0]{"slug": slug.current}`
+   * The `resultPath` for `result.slug` would be `['slug']`, while `sourcePath` will be `['slug', 'current']`.
+   */
+  resultPath: ContentSourceMapParsedPath
+  /**
+   * You can also use your own string validation logic to determine if it's safe.
+   */
+  value: string
+  /**
+     * If you want to keep the default filtering behavior, but only override it for a specific path, you can use `filterDefault` to do that.
+     * For example, here all "icon" documents in a Page Builder skips encoding:
+     * ```ts
+     {
+     filter: (props) => {
+     switch (props.sourceDocument._type) {
+     case 'icon':
+     return false
+     default:
+     return props.filterDefault(props)
+     }
+     }
+     }
+     * ```
+     */
+  filterDefault: FilterDefault
+}) => boolean
+
+/** @public */
+export declare interface FilteredResponseQueryOptions extends ResponseQueryOptions {
   filterResponse?: true
 }
 
@@ -546,6 +628,16 @@ export declare type HttpRequest = {
 /** @public */
 export declare type HttpRequestEvent<T = unknown> = ResponseEvent<T> | ProgressEvent_2
 
+declare const httpRequestSymbol: unique symbol
+
+declare const httpRequestSymbol_2: unique symbol
+
+declare const httpRequestSymbol_3: unique symbol
+
+declare const httpRequestSymbol_4: unique symbol
+
+declare const httpRequestSymbol_5: unique symbol
+
 /** @public */
 export declare type IdentifiedSanityDocumentStub<
   T extends Record<string, Any> = Record<string, Any>,
@@ -573,8 +665,16 @@ export declare interface InitializedClientConfig extends ClientConfig {
    * @deprecated Internal, don't use
    */
   cdnUrl: string
+  /**
+   * The fully initialized stega config, can be used to check if stega is enabled
+   */
+  stega: InitializedStegaConfig
 }
 
+/** @public */
+export declare type InitializedStegaConfig = Omit<StegaConfig, StegaConfigRequiredKeys> &
+  Required<Pick<StegaConfig, StegaConfigRequiredKeys>>
+
 /** @internal */
 export declare type InsertPatch =
   | {
@@ -685,6 +785,13 @@ export declare interface ListenOptions {
   tag?: string
 }
 
+/** @public */
+export declare type Logger =
+  | typeof console
+  | Partial<
+      Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>
+    >
+
 /** @internal */
 export declare interface MultipleMutationResult {
   transactionId: string
@@ -843,7 +950,8 @@ export declare type MutationSelection =
 
 /** @internal */
 export declare class ObservableAssetsClient {
-  #private
+  private [clientSymbol]
+  private [httpRequestSymbol]
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
   /**
    * Uploads a file asset to the configured dataset
@@ -897,7 +1005,8 @@ export declare class ObservableAssetsClient {
 
 /** @internal */
 export declare class ObservableDatasetsClient {
-  #private
+  private [clientSymbol_2]
+  private [httpRequestSymbol_2]
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
   /**
    * Create a new dataset with the given name
@@ -939,7 +1048,7 @@ export declare class ObservableDatasetsClient {
 
 /** @public */
 export declare class ObservablePatch extends BasePatch {
-  #private
+  private [clientSymbol_5]?
   constructor(
     selection: PatchSelection,
     operations?: PatchOperations,
@@ -992,7 +1101,8 @@ export declare type ObservablePatchBuilder = (patch: ObservablePatch) => Observa
 
 /** @internal */
 export declare class ObservableProjectsClient {
-  #private
+  private [clientSymbol_3]
+  private [httpRequestSymbol_3]
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
   /**
    * Fetch a list of projects the authenticated user has access to.
@@ -1012,11 +1122,15 @@ export declare class ObservableProjectsClient {
 
 /** @public */
 export declare class ObservableSanityClient {
-  #private
   assets: ObservableAssetsClient
   datasets: ObservableDatasetsClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
+  /**
+   * Private properties
+   */
+  private [clientConfigSymbol]
+  private [httpRequestSymbol_5]
   /**
    * Instance properties
    */
@@ -1045,38 +1159,49 @@ export declare class ObservableSanityClient {
    *
    * @param query - GROQ-query to perform
    */
-  fetch<R = Any>(query: string): Observable<R>
-  /**
-   * Perform a GROQ-query against the configured dataset.
-   *
-   * @param query - GROQ-query to perform
-   * @param params - Query parameters
-   */
-  fetch<R = Any, Q = QueryParams>(query: string, params: Q): Observable<R>
+  fetch<R = Any, Q extends never | undefined | Record<string, never> = never>(
+    query: string,
+  ): Observable<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
    * @param query - GROQ-query to perform
-   * @param params - Query parameters
-   * @param options - Request options
+   * @param params - Optional query parameters
+   * @param options - Optional request options
    */
-  fetch<R = Any, Q = QueryParams>(
+  fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(
     query: string,
-    params: Q | undefined,
-    options: FilteredResponseQueryOptions,
+    params: QueryParamsParameter<Q>,
+    options?: FilteredResponseQueryOptions,
   ): Observable<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
    * @param query - GROQ-query to perform
-   * @param params - Query parameters
+   * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q = QueryParams>(
+  fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(
     query: string,
-    params: Q | undefined,
+    params: QueryParamsParameter<Q>,
     options: UnfilteredResponseQueryOptions,
   ): Observable<RawQueryResponse<R>>
+  /**
+   * You're passing in query parameters to a GROQ query that looks like query options.
+   * This is likely a mistake, you can either:
+   * a) replace the second argument with an empty object, and move the options to the third argument
+   * ```diff
+   * -client.fetch(query, {cache: 'no-store'})
+   * +client.fetch(query, {}, {cache: 'no-store'})
+   * ```
+   * b) add a generic type parameter that allows the query parameters to be passed in to silence the error
+   * @deprecated not actually deprecated, marking it as deprecated makes this error easier to spot
+   */
+  fetch<R = Any>(
+    query: string,
+    params: QueryParamsLikelyByMistake & QueryParams,
+    options?: QueryOptions,
+  ): unknown
   /**
    * Fetch a single document with the given ID.
    *
@@ -1484,7 +1609,7 @@ export declare class ObservableSanityClient {
 
 /** @public */
 export declare class ObservableTransaction extends BaseTransaction {
-  #private
+  private [clientSymbol_6]?
   constructor(operations?: Mutation[], client?: ObservableSanityClient, transactionId?: string)
   /**
    * Clones the transaction
@@ -1543,7 +1668,8 @@ export declare class ObservableTransaction extends BaseTransaction {
 
 /** @public */
 export declare class ObservableUsersClient {
-  #private
+  private [clientSymbol_4]
+  private [httpRequestSymbol_4]
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
   /**
    * Fetch a user by user ID
@@ -1557,7 +1683,7 @@ export declare class ObservableUsersClient {
 
 /** @public */
 export declare class Patch extends BasePatch {
-  #private
+  private [clientSymbol_5]?
   constructor(selection: PatchSelection, operations?: PatchOperations, client?: SanityClient)
   /**
    * Clones the patch
@@ -1645,7 +1771,8 @@ export {ProgressEvent_2 as ProgressEvent}
 
 /** @internal */
 export declare class ProjectsClient {
-  #private
+  private [clientSymbol_3]
+  private [httpRequestSymbol_3]
   constructor(client: SanityClient, httpRequest: HttpRequest)
   /**
    * Fetch a list of projects the authenticated user has access to.
@@ -1663,11 +1790,86 @@ export declare class ProjectsClient {
   getById(projectId: string): Promise<SanityProject>
 }
 
+/** @public */
+export declare type QueryOptions = FilteredResponseQueryOptions | UnfilteredResponseQueryOptions
+
 /** @public */
 export declare type QueryParams = {
   [key: string]: Any
 }
 
+/**
+ * It's easy to accidentally set query options such as `filterResponse`, `cache` and `next` as the second parameter in `client.fetch`,
+ * as that is a wide type used to set GROQ query paramaters and it accepts anything that can serialize to JSON.
+ * This type is used to prevent that, and will cause a type error if you try to pass a query option as the second parameter.
+ * If this type is `never`, it means `_QueryParamsLikelyByMistake` is missing keys from `QueryOptions`.
+ * @internal
+ */
+export declare type QueryParamsLikelyByMistake =
+  Required<_QueryParamsLikelyByMistake> extends Record<keyof QueryOptions, Any>
+    ? _QueryParamsLikelyByMistake
+    : never
+
+/**
+ * Verify this type has all the same keys as QueryOptions before exporting
+ * @internal
+ */
+export declare type _QueryParamsLikelyByMistake = {
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  body?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  cache?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  filterResponse?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  headers?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  method?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  next?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  perspective?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  query?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  resultSourceMap?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  signal?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  stega?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  tag?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  timeout?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  token?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  useCdn?: Any
+}
+
+/**
+ * Transform a QueryParams generic type to a valid parameter type for `client.fetch
+ * @public
+ */
+export declare type QueryParamsParameter<QueryParamsParameterType> =
+  QueryParamsParameterType extends QueryParams
+    ? QueryParamsParameterType
+    : QueryParamsParameterType extends Record<string, never>
+      ? Record<string, never>
+      : QueryParamsParameterType extends undefined
+        ? undefined | Record<string, never>
+        : never
+
+/**
+ * It's easy to accidentally set query options such as `filterResponse`, `cache` and `next` as the second parameter in `client.fetch`,
+ * as that is a wide type used to set GROQ query paramaters and it accepts anything that can serialize to JSON.
+ * This type is used to prevent that, and will cause a type error if you try to pass a query option as the second parameter.
+ * @internal
+ */
+export declare type QueryParamsWithoutQueryOptions = {
+  [K in keyof _QueryParamsLikelyByMistake]: never
+} & QueryParams
+
 /** @public */
 export declare interface RawQueryResponse<R> {
   query: string
@@ -1742,6 +1944,11 @@ export declare interface RequestOptions {
   signal?: AbortSignal
 }
 
+/** @alpha */
+export declare type ResolveStudioUrl = (
+  sourceDocument: ContentSourceMapDocuments[number],
+) => StudioUrl
+
 /** @public */
 export declare interface ResponseEvent<T = unknown> {
   type: 'response'
@@ -1754,12 +1961,13 @@ export declare interface ResponseEvent<T = unknown> {
 }
 
 /** @public */
-export declare interface ResponseQueryOptions<T = 'next'> extends RequestOptions {
+export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
   resultSourceMap?: boolean | 'withKeyArraySelector'
-  cache?: RequestInit['cache']
-  next?: T extends keyof RequestInit ? RequestInit[T] : never
   useCdn?: boolean
+  stega?: boolean | StegaConfig
+  cache?: 'next' extends keyof RequestInit ? RequestInit['cache'] : never
+  next?: ('next' extends keyof RequestInit ? RequestInit : never)['next']
 }
 
 /** @internal */
@@ -1777,7 +1985,6 @@ export declare interface SanityAssetDocument extends SanityDocument {
 
 /** @public */
 export declare class SanityClient {
-  #private
   assets: AssetsClient
   datasets: DatasetsClient
   projects: ProjectsClient
@@ -1786,6 +1993,11 @@ export declare class SanityClient {
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
   observable: ObservableSanityClient
+  /**
+   * Private properties
+   */
+  private [clientConfigSymbol]
+  private [httpRequestSymbol_5]
   /**
    * Instance properties
    */
@@ -1814,25 +2026,20 @@ export declare class SanityClient {
    *
    * @param query - GROQ-query to perform
    */
-  fetch<R = Any>(query: string): Promise<R>
-  /**
-   * Perform a GROQ-query against the configured dataset.
-   *
-   * @param query - GROQ-query to perform
-   * @param params - Optional query parameters
-   */
-  fetch<R = Any, Q = QueryParams>(query: string, params: Q): Promise<R>
+  fetch<R = Any, Q extends never | undefined | Record<string, never> = never>(
+    query: string,
+  ): Promise<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
    * @param query - GROQ-query to perform
    * @param params - Optional query parameters
-   * @param options - Request options
+   * @param options - Optional request options
    */
-  fetch<R = Any, Q = QueryParams>(
+  fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(
     query: string,
-    params: Q | undefined,
-    options: FilteredResponseQueryOptions,
+    params: QueryParamsParameter<Q>,
+    options?: FilteredResponseQueryOptions,
   ): Promise<R>
   /**
    * Perform a GROQ-query against the configured dataset.
@@ -1841,11 +2048,27 @@ export declare class SanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q = QueryParams>(
+  fetch<R = Any, Q = QueryParamsWithoutQueryOptions>(
     query: string,
-    params: Q | undefined,
+    params: QueryParamsParameter<Q>,
     options: UnfilteredResponseQueryOptions,
   ): Promise<RawQueryResponse<R>>
+  /**
+   * You're passing in query parameters to a GROQ query that looks like query options.
+   * This is likely a mistake, you can either:
+   * a) replace the second argument with an empty object, and move the options to the third argument
+   * ```diff
+   * -client.fetch(query, {cache: 'no-store'})
+   * +client.fetch(query, {}, {cache: 'no-store'})
+   * ```
+   * b) add a generic type parameter that allows the query parameters to be passed in to silence the error
+   * @deprecated not actually deprecated, marking it as deprecated makes this error easier to spot
+   */
+  fetch<R = Any>(
+    query: string,
+    params: QueryParamsLikelyByMistake & QueryParams,
+    options?: QueryOptions,
+  ): unknown
   /**
    * Fetch a single document with the given ID.
    *
@@ -2394,9 +2617,55 @@ export declare interface SingleMutationResult {
   }[]
 }
 
+/** @public */
+export declare interface StegaConfig {
+  /**
+     * Enable or disable stega encoded strings in query results
+     * ```ts
+     {
+     enabled: process.env.VERCEL_ENV !== 'production'
+     }
+     * ```
+     * @defaultValue `false`
+     */
+  enabled?: boolean
+  /**
+   * Where the Studio is hosted.
+   * If it's embedded in the app, use the base path for example `/studio`.
+   * Otherwise provide the full URL to where the Studio is hosted, for example: `https://blog.sanity.studio`.
+   *
+   */
+  studioUrl?: StudioUrl | ResolveStudioUrl
+  filter?: FilterDefault
+  /**
+   * Specify a `console.log` compatible logger to see debug logs, which keys are encoded and which are not.
+   */
+  logger?: Logger
+}
+
+/** @public */
+export declare type StegaConfigRequiredKeys = Extract<keyof StegaConfig, 'enabled'>
+
+/** @alpha */
+export declare type StudioBaseRoute = {
+  baseUrl: StudioBaseUrl
+  workspace?: string
+  tool?: string
+}
+
+/** @alpha */
+export declare type StudioBaseUrl =
+  | `/${string}`
+  | `${string}.sanity.studio`
+  | `https://${string}`
+  | string
+
+/** @alpha */
+export declare type StudioUrl = StudioBaseUrl | StudioBaseRoute
+
 /** @public */
 export declare class Transaction extends BaseTransaction {
-  #private
+  private [clientSymbol_6]?
   constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string)
   /**
    * Clones the transaction
@@ -2485,7 +2754,7 @@ export declare type TransactionMutationOptions =
   | TransactionAllDocumentIdsMutationOptions
 
 /** @public */
-export declare type UnfilteredResponseQueryOptions = ResponseQueryOptions & {
+export declare interface UnfilteredResponseQueryOptions extends ResponseQueryOptions {
   filterResponse: false
 }
 
@@ -2559,7 +2828,8 @@ export declare interface UploadClientConfig {
 
 /** @public */
 export declare class UsersClient {
-  #private
+  private [clientSymbol_4]
+  private [httpRequestSymbol_4]
   constructor(client: SanityClient, httpRequest: HttpRequest)
   /**
    * Fetch a user by user ID

package/dist/index.js

@@ -1,5 +1,5 @@
-import { printNoDefaultExport, defineCreateClientExports, SanityClient, middleware } from './_chunks/nodeMiddleware-u_fUUnxa.js';
-export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableSanityClient, ObservableTransaction, Patch, ServerError, Transaction } from './_chunks/nodeMiddleware-u_fUUnxa.js';
+import { printNoDefaultExport, defineCreateClientExports, SanityClient, middleware } from './_chunks/nodeMiddleware-hZIb_1T_.js';
+export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableSanityClient, ObservableTransaction, Patch, ServerError, Transaction } from './_chunks/nodeMiddleware-hZIb_1T_.js';
 export { adapter as unstable__adapter, environment as unstable__environment } from 'get-it';
 
 function defineDeprecatedCreateClient(createClient) {