@sanity/client/dist/types-CfGzbXrl.d.ts

Client for retrieving, creating and patching data from Sanity.io

import { ContentSourceMap as ContentSourceMap$2, ContentSourceMapDocuments, ContentSourceMapParsedPath, ContentSourceMapParsedPath as ContentSourceMapParsedPath$1, ContentSourceMapParsedPathKeyedSegment, ResolveStudioUrl, StudioBaseRoute, StudioBaseUrl, StudioUrl, StudioUrl as StudioUrl$1 } from "@sanity/client/csm";
import { ClientConfig, InitializedClientConfig, RawQueryResponse } from "@sanity/client";
/** @public */
type ContentSourceMapQueryResponse = RawQueryResponse<unknown> | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>;
/** @public */
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;
  /**
   * Set to `true` to omit cross dataset reference specific data from encoded strings
   */
  omitCrossDatasetReferenceData?: boolean;
}
/** @public */
type StegaConfigRequiredKeys = Extract<keyof StegaConfig, 'enabled'>;
/** @public */
type InitializedStegaConfig = Omit<StegaConfig, StegaConfigRequiredKeys> & Required<Pick<StegaConfig, StegaConfigRequiredKeys>>;
/**
 * @public
 * @deprecated -- use `ClientConfig` instead
 */
interface ClientStegaConfig extends ClientConfig {}
/**
 * @public
 * @deprecated -- use `InitializedClientConfig` instead
 */
interface InitializedClientStegaConfig extends InitializedClientConfig {}
/** @public */
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 */
type Logger = typeof console | Partial<Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>>;
/**
 * @internal
 */
type Encoder = (context: {
  sourcePath: ContentSourceMapParsedPath;
  sourceDocument: ContentSourceMapDocuments[number];
  resultPath: ContentSourceMapParsedPath;
  value: string;
}) => string;
export { ContentSourceMapQueryResponse as a, InitializedClientStegaConfig as c, ResolveStudioUrl as d, StegaConfig as f, StudioUrl$1 as g, StudioBaseUrl as h, ContentSourceMapParsedPathKeyedSegment as i, InitializedStegaConfig as l, StudioBaseRoute as m, ContentSourceMap$2 as n, Encoder as o, StegaConfigRequiredKeys as p, ContentSourceMapParsedPath$1 as r, FilterDefault as s, ClientStegaConfig as t, Logger as u };
//# sourceMappingURL=types-CfGzbXrl.d.ts.map