@sanity/client 6.11.3 → 6.11.4-canary.0

package/dist/index.d.ts

@@ -325,6 +325,10 @@ 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
 }
 
 /** @public */
@@ -388,6 +392,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[]
 
@@ -520,6 +537,55 @@ export declare interface ErrorProps {
   details: Any
 }
 
+/** @public */
+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 type FilteredResponseQueryOptions = ResponseQueryOptions & {
   filterResponse?: true
@@ -573,8 +639,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 +759,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
@@ -1742,6 +1823,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'
@@ -1760,6 +1846,7 @@ export declare interface ResponseQueryOptions<T = 'next'> extends RequestOptions
   cache?: RequestInit['cache']
   next?: T extends keyof RequestInit ? RequestInit[T] : never
   useCdn?: boolean
+  stega?: boolean | StegaConfig
 }
 
 /** @internal */
@@ -2394,6 +2481,52 @@ 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

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-LGORMZpx.js';
+export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableSanityClient, ObservableTransaction, Patch, ServerError, Transaction } from './_chunks/nodeMiddleware-LGORMZpx.js';
 export { adapter as unstable__adapter, environment as unstable__environment } from 'get-it';
 
 function defineDeprecatedCreateClient(createClient) {