@sanity/client 6.11.3 → 6.11.4-canary.0

package/src/config.ts

@@ -8,6 +8,7 @@ export const defaultConfig = {
   apiHost: 'https://api.sanity.io',
   apiVersion: '1',
   useProjectHostname: true,
+  stega: {enabled: false},
 } satisfies ClientConfig
 
 const LOCALHOSTS = ['localhost', '127.0.0.1', '0.0.0.0']
@@ -44,12 +45,24 @@ export const initConfig = (
   config: Partial<ClientConfig>,
   prevConfig: Partial<ClientConfig>,
 ): InitializedClientConfig => {
-  const specifiedConfig = Object.assign({}, prevConfig, config)
+  const specifiedConfig = {
+    ...prevConfig,
+    ...config,
+    stega: {
+      ...(typeof prevConfig.stega === 'boolean'
+        ? {enabled: prevConfig.stega}
+        : prevConfig.stega || defaultConfig.stega),
+      ...(typeof config.stega === 'boolean' ? {enabled: config.stega} : config.stega || {}),
+    },
+  }
   if (!specifiedConfig.apiVersion) {
     warnings.printNoApiVersionSpecifiedWarning()
   }
 
-  const newConfig = Object.assign({} as InitializedClientConfig, defaultConfig, specifiedConfig)
+  const newConfig = {
+    ...defaultConfig,
+    ...specifiedConfig,
+  } as InitializedClientConfig
   const projectBased = newConfig.useProjectHostname
 
   if (typeof Promise === 'undefined') {
@@ -65,20 +78,29 @@ export const initConfig = (
     validateApiPerspective(newConfig.perspective)
   }
 
-  if (
-    'encodeSourceMapAtPath' in newConfig ||
-    'encodeSourceMap' in newConfig ||
-    'studioUrl' in newConfig ||
-    'logger' in newConfig
-  ) {
+  if ('encodeSourceMap' in newConfig) {
     throw new Error(
-      `It looks like you're using options meant for '@sanity/preview-kit/client', such as 'encodeSourceMapAtPath', 'encodeSourceMap', 'studioUrl' and 'logger'. Make sure you're using the right import.`,
+      `It looks like you're using options meant for '@sanity/preview-kit/client'. 'encodeSourceMap' is not supported in '@sanity/client'. Did you mean 'stega.enabled'?`,
     )
   }
-
-  if ('stega' in newConfig && newConfig['stega'] !== undefined && newConfig['stega'] !== false) {
+  if ('encodeSourceMapAtPath' in newConfig) {
+    throw new Error(
+      `It looks like you're using options meant for '@sanity/preview-kit/client'. 'encodeSourceMapAtPath' is not supported in '@sanity/client'. Did you mean 'stega.filter'?`,
+    )
+  }
+  if (typeof newConfig.stega.enabled !== 'boolean') {
+    throw new Error(`stega.enabled must be a boolean, received ${newConfig.stega.enabled}`)
+  }
+  if (newConfig.stega.enabled && newConfig.stega.studioUrl === undefined) {
+    throw new Error(`stega.studioUrl must be defined when stega.enabled is true`)
+  }
+  if (
+    newConfig.stega.enabled &&
+    typeof newConfig.stega.studioUrl !== 'string' &&
+    typeof newConfig.stega.studioUrl !== 'function'
+  ) {
     throw new Error(
-      `It looks like you're using options meant for '@sanity/client/stega'. Make sure you're using the right import. Or set 'stega' in 'createClient' to 'false'.`,
+      `stega.studioUrl must be a string or a function, received ${newConfig.stega.studioUrl}`,
     )
   }
 

package/src/data/dataMethods.ts

@@ -1,9 +1,10 @@
-import {type MonoTypeOperatorFunction, Observable} from 'rxjs'
-import {filter, map} from 'rxjs/operators'
+import {from, type MonoTypeOperatorFunction, Observable} from 'rxjs'
+import {combineLatestWith, filter, map} from 'rxjs/operators'
 
 import {validateApiPerspective} from '../config'
 import {requestOptions} from '../http/requestOptions'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
+import {vercelStegaCleanAll} from '../stega/vercelStegaCleanAll'
 import type {
   AllDocumentIdsMutationOptions,
   AllDocumentsMutationOptions,
@@ -15,6 +16,7 @@ import type {
   HttpRequest,
   HttpRequestEvent,
   IdentifiedSanityDocumentStub,
+  InitializedStegaConfig,
   MultipleMutationResult,
   Mutation,
   MutationSelection,
@@ -65,21 +67,27 @@ const getQuerySizeLimit = 11264
 export function _fetch<R, Q extends QueryParams>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
+  _stega: InitializedStegaConfig,
   query: string,
-  params?: Q,
+  _params?: Q,
   options: FilteredResponseQueryOptions | UnfilteredResponseQueryOptions = {},
 ): Observable<RawQueryResponse<R> | R> {
-  if ('stega' in options && options['stega'] !== undefined && options['stega'] !== false) {
-    throw new Error(
-      `It looks like you're using options meant for '@sanity/client/stega'. Make sure you're using the right import. Or set 'stega' in 'fetch' to 'false'.`,
-    )
-  }
+  const stega =
+    'stega' in options
+      ? {
+          ...(_stega || {}),
+          ...(typeof options.stega === 'boolean' ? {enabled: options.stega} : options.stega || {}),
+        }
+      : _stega
+  const params = stega.enabled ? vercelStegaCleanAll(_params) : _params
   const mapResponse =
     options.filterResponse === false ? (res: Any) => res : (res: Any) => res.result
   const {cache, next, ...opts} = {
     // Opt out of setting a `signal` on an internal `fetch` if one isn't provided.
     // This is necessary in React Server Components to avoid opting out of Request Memoization.
     useAbortSignal: typeof options.signal !== 'undefined',
+    // Set `resultSourceMap' when stega is enabled, as it's required for encoding.
+    resultSourceMap: stega.enabled ? 'withKeyArraySelector' : options.resultSourceMap,
     ...options,
   }
   const reqOpts =
@@ -87,7 +95,27 @@ export function _fetch<R, Q extends QueryParams>(
       ? {...opts, fetch: {cache, next}}
       : opts
 
-  return _dataRequest(client, httpRequest, 'query', {query, params}, reqOpts).pipe(map(mapResponse))
+  const $request = _dataRequest(client, httpRequest, 'query', {query, params}, reqOpts)
+  return stega.enabled
+    ? $request.pipe(
+        combineLatestWith(
+          from(
+            import('../stega/stegaEncodeSourceMap').then(
+              ({stegaEncodeSourceMap}) => stegaEncodeSourceMap,
+            ),
+          ),
+        ),
+        map(
+          ([res, stegaEncodeSourceMap]: [
+            Any,
+            (typeof import('../stega/stegaEncodeSourceMap'))['stegaEncodeSourceMap'],
+          ]) => {
+            const result = stegaEncodeSourceMap(res.result, res.resultSourceMap, stega)
+            return mapResponse({...res, result})
+          },
+        ),
+      )
+    : $request.pipe(map(mapResponse))
 }
 
 /** @internal */

package/src/stega/index.browser.ts

@@ -2,13 +2,10 @@ export * from '../defineCreateClient'
 
 import defineCreateClientExports from '../defineCreateClient'
 import envMiddleware from '../http/browserMiddleware'
-import {SanityStegaClient} from './SanityStegaClient'
-import type {ClientStegaConfig} from './types'
+import {SanityClient} from '../SanityClient'
+import type {ClientConfig} from './types'
 
-const exp = defineCreateClientExports<SanityStegaClient, ClientStegaConfig>(
-  envMiddleware,
-  SanityStegaClient,
-)
+const exp = defineCreateClientExports<SanityClient, ClientConfig>(envMiddleware, SanityClient)
 
 export type {ObservableSanityClient, SanityClient} from './shared'
 export * from './shared'

package/src/stega/index.ts

@@ -2,13 +2,10 @@ export * from '../defineCreateClient'
 
 import defineCreateClientExports from '../defineCreateClient'
 import envMiddleware from '../http/nodeMiddleware'
-import {SanityStegaClient} from './SanityStegaClient'
-import type {ClientStegaConfig} from './types'
+import {SanityClient} from '../SanityClient'
+import type {ClientConfig} from './types'
 
-const exp = defineCreateClientExports<SanityStegaClient, ClientStegaConfig>(
-  envMiddleware,
-  SanityStegaClient,
-)
+const exp = defineCreateClientExports<SanityClient, ClientConfig>(envMiddleware, SanityClient)
 
 export type {ObservableSanityClient, SanityClient} from './shared'
 export * from './shared'

package/src/stega/shared.ts

@@ -1,17 +1,5 @@
+export * from '../SanityClient'
 export {encodeIntoResult} from './encodeIntoResult'
-export * from './SanityStegaClient'
 export {stegaEncodeSourceMap} from './stegaEncodeSourceMap'
 export * from './types'
 export {vercelStegaCleanAll} from './vercelStegaCleanAll'
-
-/**
- * @deprecated -- Use `import type {SanityClient} from '@sanity/client'` instead
- * @public
- */
-export type SanityClient = never
-
-/**
- * @deprecated -- Use `import type {ObservableSanityClient} from '@sanity/client'` instead
- * @public
- */
-export type ObservableSanityClient = never

package/src/stega/types.ts

@@ -53,21 +53,23 @@ export interface StegaConfig {
 }
 
 /** @public */
-export type StegaConfigRequiredKeys = Extract<keyof StegaConfig, 'enabled' | 'filter'>
+export type StegaConfigRequiredKeys = Extract<keyof StegaConfig, 'enabled'>
 
 /** @public */
 export type InitializedStegaConfig = Omit<StegaConfig, StegaConfigRequiredKeys> &
   Required<Pick<StegaConfig, StegaConfigRequiredKeys>>
 
-/** @public */
-export interface ClientStegaConfig extends ClientConfig {
-  stega?: StegaConfig | boolean
-}
+/**
+ * @public
+ * @deprecated -- use `ClientConfig` instead
+ */
+export interface ClientStegaConfig extends ClientConfig {}
 
-/** @public */
-export interface InitializedClientStegaConfig extends InitializedClientConfig {
-  stega: InitializedStegaConfig
-}
+/**
+ * @public
+ * @deprecated -- use `InitializedClientConfig` instead
+ */
+export interface InitializedClientStegaConfig extends InitializedClientConfig {}
 
 /** @public */
 export type FilterDefault = (props: {
@@ -134,12 +136,3 @@ export type Encoder = (context: {
   resultPath: ContentSourceMapParsedPath
   value: string
 }) => string
-
-// Extends the `client.fetch` call with a `stega` option
-declare module '../types' {
-  /** @public */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  export interface ResponseQueryOptions<T = 'next'> extends RequestOptions {
-    stega?: boolean | StegaConfig
-  }
-}

package/src/types.ts

@@ -1,6 +1,7 @@
 // deno-lint-ignore-file no-empty-interface
 
 import type {Requester} from 'get-it'
+import type {InitializedStegaConfig, StegaConfig} from './stega/types'
 
 /**
  * Used to tag types that is set to `any` as a temporary measure, but should be replaced with proper typings in the future
@@ -89,6 +90,10 @@ export 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 */
@@ -111,6 +116,10 @@ export 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 */
@@ -670,6 +679,7 @@ export interface ResponseQueryOptions<T = 'next'> extends RequestOptions {
   cache?: RequestInit['cache']
   next?: T extends keyof RequestInit ? RequestInit[T] : never
   useCdn?: boolean
+  stega?: boolean | StegaConfig
 }
 
 /** @public */
@@ -898,3 +908,17 @@ export interface ContentSourceMap {
   documents: ContentSourceMapDocuments
   paths: ContentSourceMapPaths
 }
+
+export type {
+  ContentSourceMapParsedPath,
+  ContentSourceMapParsedPathKeyedSegment,
+  FilterDefault,
+  InitializedStegaConfig,
+  Logger,
+  ResolveStudioUrl,
+  StegaConfig,
+  StegaConfigRequiredKeys,
+  StudioBaseRoute,
+  StudioBaseUrl,
+  StudioUrl,
+} from './stega/types'