@sanity/client 6.7.1-pink-lizard.4 → 6.7.1

package/src/stega/index.ts

@@ -1,19 +0,0 @@
-export * from '../defineCreateClient'
-
-import defineCreateClientExports from '../defineCreateClient'
-import envMiddleware from '../http/nodeMiddleware'
-import {SanityStegaClient} from './SanityStegaClient'
-import type {ClientStegaConfig} from './types'
-
-const exp = defineCreateClientExports<SanityStegaClient, ClientStegaConfig>(
-  envMiddleware,
-  SanityStegaClient,
-)
-
-export * from './shared'
-
-/** @public */
-export const requester = exp.requester
-
-/** @public */
-export const createClient = exp.createClient

package/src/stega/shared.ts

@@ -1,4 +0,0 @@
-export {encodeIntoResult} from './encodeIntoResult'
-export * from './SanityStegaClient'
-export {stegaEncodeSourceMap} from './stegaEncodeSourceMap'
-export * from './types'

package/src/stega/stegaEncodeSourceMap.ts

@@ -1,128 +0,0 @@
-import {vercelStegaCombine} from '@vercel/stega'
-
-import type {PathSegment} from '../csm'
-import {createEditLink} from '../csm/createEditLink'
-import {encodeIntoResult} from './encodeIntoResult'
-import {filterDefault} from './filterDefault'
-import {ContentSourceMap, InitializedStegaConfig} from './types'
-
-const TRUNCATE_LENGTH = 20
-
-/**
- * Uses `@vercel/stega` to embed edit info JSON into strings in your query result.
- * The JSON payloads are added using invisible characters so they don't show up visually.
- * The edit info is generated from the Content Source Map (CSM) that is returned from Sanity for the query.
- * @public
- */
-export function stegaEncodeSourceMap<Result = unknown>(
-  result: Result,
-  resultSourceMap: ContentSourceMap | undefined,
-  config: InitializedStegaConfig,
-): Result {
-  const {filter, vercelStegaCombineSkip, logger, studioUrl, enabled} = config
-  if (!enabled) {
-    const msg = "config.enabled must be true, don't call this function otherwise"
-    logger?.error?.(`[@sanity/client/stega]: ${msg}`, {result, resultSourceMap, config})
-    throw new TypeError(msg)
-  }
-
-  if (!resultSourceMap) {
-    logger?.error?.('[@sanity/client/stega]: Missing Content Source Map from response body', {
-      result,
-      resultSourceMap,
-      config,
-    })
-    return result
-  }
-
-  if (!studioUrl) {
-    const msg = 'config.studioUrl must be defined'
-    logger?.error?.(`[@sanity/client/stega]: ${msg}`, {result, resultSourceMap, config})
-    throw new TypeError(msg)
-  }
-
-  const report: Record<'encoded' | 'skipped', {path: string; length: number; value: string}[]> = {
-    encoded: [],
-    skipped: [],
-  }
-
-  const resultWithStega = encodeIntoResult(
-    result,
-    resultSourceMap,
-    ({sourcePath, sourceDocument, resultPath, value}) => {
-      // Allow userland to control when to opt-out of encoding
-      if (
-        (typeof filter === 'function'
-          ? filter({sourcePath, resultPath, filterDefault, sourceDocument, value})
-          : filterDefault({sourcePath, resultPath, filterDefault, sourceDocument, value})) === false
-      ) {
-        if (logger) {
-          report.skipped.push({
-            path: prettyPathForLogging(sourcePath),
-            value: `${value.slice(0, TRUNCATE_LENGTH)}${
-              value.length > TRUNCATE_LENGTH ? '...' : ''
-            }`,
-            length: value.length,
-          })
-        }
-        return value
-      }
-
-      if (logger) {
-        report.encoded.push({
-          path: prettyPathForLogging(sourcePath),
-          value: `${value.slice(0, TRUNCATE_LENGTH)}${value.length > TRUNCATE_LENGTH ? '...' : ''}`,
-          length: value.length,
-        })
-      }
-
-      return vercelStegaCombine(
-        value,
-        {
-          origin: 'sanity.io',
-          href: createEditLink({studioUrl, resultSourceMap, resultPath}),
-        },
-        vercelStegaCombineSkip,
-      )
-    },
-    {keyArraySelectors: true},
-  )
-
-  if (logger) {
-    const isSkipping = report.skipped.length
-    const isEncoding = report.encoded.length
-    if (isSkipping || isEncoding) {
-      ;(logger?.groupCollapsed || logger.log)?.(
-        '[@sanity/client/stega]: Encoding source map into result',
-      )
-      logger.log?.(
-        `[@sanity/client/stega]: Paths encoded: ${report.encoded.length}, skipped: ${report.skipped.length}`,
-      )
-    }
-    if (report.encoded.length > 0) {
-      logger?.log?.(`[@sanity/client/stega]: Table of encoded paths`)
-      ;(logger?.table || logger.log)?.(report.encoded)
-    }
-    if (report.skipped.length > 0) {
-      const skipped = new Set<string>()
-      for (const {path} of report.skipped) {
-        skipped.add(path.replace(/\[\d+\]/g, '[]'))
-      }
-      logger?.log?.(`[@sanity/client/stega]: List of skipped paths`, [...skipped.values()])
-    }
-
-    if (isSkipping || isEncoding) {
-      logger?.groupEnd?.()
-    }
-  }
-
-  return resultWithStega
-}
-
-function prettyPathForLogging(path: PathSegment[]): string {
-  return path
-    .map((segment, index) =>
-      typeof segment === 'number' ? `[${segment}]` : index > 0 ? `.${segment}` : segment,
-    )
-    .join('')
-}

package/src/stega/types.ts

@@ -1,139 +0,0 @@
-import type {
-  ContentSourceMap,
-  ContentSourceMapDocuments,
-  Path,
-  ResolveStudioUrl,
-  StudioUrl,
-} from '../csm'
-import {ClientConfig, InitializedClientConfig, RawQueryResponse} from '../types'
-
-export type {KeyedSegment, PathSegment, StudioUrl} from '../csm/types'
-export type * from '../types'
-
-export type {ContentSourceMap, Path, ResolveStudioUrl}
-
-/** @public */
-export type ContentSourceMapQueryResponse =
-  | RawQueryResponse<unknown>
-  | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>
-
-/** @public */
-export 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
-
-  /**
-   * Override the `skip` parameter in `vercelStegaCombine`
-   * @defaultValue `'auto'`
-   */
-  vercelStegaCombineSkip?: 'auto' | boolean
-}
-
-/** @public */
-export type StegaConfigRequiredKeys = Extract<
-  keyof StegaConfig,
-  'enabled' | 'filter' | 'vercelStegaCombineSkip'
->
-
-/** @public */
-export type InitializedStegaConfig = Omit<StegaConfig, StegaConfigRequiredKeys> &
-  Required<Pick<StegaConfig, StegaConfigRequiredKeys>>
-
-/** @public */
-export interface ClientStegaConfig extends ClientConfig {
-  stega?: StegaConfig
-}
-
-/** @public */
-export interface InitializedClientStegaConfig extends InitializedClientConfig {
-  stega: InitializedStegaConfig
-}
-
-/** @public */
-export 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: Path
-  /**
-   * 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: Path
-  /**
-   * 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 type Logger =
-  | typeof console
-  | Partial<
-      Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>
-    >
-
-/**
- * @internal
- */
-export type Encoder = (context: {
-  sourcePath: Path
-  sourceDocument: ContentSourceMapDocuments[number]
-  resultPath: Path
-  value: string
-}) => string