@sanity/client 6.11.3 → 6.11.4-canary.0

package/src/stega/SanityStegaClient.ts

@@ -1,298 +0,0 @@
-import {Observable} from 'rxjs'
-import {map} from 'rxjs/operators'
-
-import {defaultConfig} from '../config'
-import {
-  ObservableSanityClient as INTERNAL_DO_NOT_USE_DIRECTLY_ObservableSanityClient,
-  SanityClient as INTERNAL_DO_NOT_USE_DIRECTLY_SanityClient,
-} from '../SanityClient'
-import type {
-  Any,
-  ClientConfig,
-  FilteredResponseQueryOptions,
-  HttpRequest,
-  QueryParams,
-  RawQueryResponse,
-  UnfilteredResponseQueryOptions,
-} from '../types'
-import {
-  defaultStegaConfig,
-  initStegaConfig,
-  splitConfig,
-  splitStegaConfigFromFetchOptions,
-} from './config'
-import {stegaEncodeSourceMap} from './stegaEncodeSourceMap'
-import {ClientStegaConfig, InitializedClientStegaConfig, InitializedStegaConfig} from './types'
-import {vercelStegaCleanAll} from './vercelStegaCleanAll'
-
-/** @public */
-export class ObservableSanityStegaClient extends INTERNAL_DO_NOT_USE_DIRECTLY_ObservableSanityClient {
-  /**
-   * Private properties
-   */
-  #httpRequest: HttpRequest
-  private stegaConfig: InitializedStegaConfig
-
-  constructor(httpRequest: HttpRequest, config: ClientStegaConfig = defaultConfig) {
-    const {clientConfig, stegaConfig} = splitConfig(config)
-    super(httpRequest, clientConfig)
-
-    this.#httpRequest = httpRequest
-    this.stegaConfig = initStegaConfig(stegaConfig, defaultStegaConfig)
-  }
-
-  /**
-   * Clone the client - returns a new instance
-   */
-  clone(): ObservableSanityStegaClient {
-    return new ObservableSanityStegaClient(this.#httpRequest, this.config())
-  }
-
-  /**
-   * Returns the current client configuration
-   */
-  config(): InitializedClientStegaConfig
-  /**
-   * Reconfigure the client. Note that this _mutates_ the current client.
-   */
-  config(newConfig?: Partial<ClientStegaConfig>): this
-  config(newConfig?: Partial<ClientStegaConfig>): ClientStegaConfig | this {
-    if (newConfig === undefined) {
-      return {...super.config(), stega: {...this.stegaConfig}}
-    }
-
-    const {clientConfig, stegaConfig} = splitConfig(newConfig)
-    super.config(clientConfig)
-
-    this.stegaConfig = initStegaConfig(stegaConfig, this.stegaConfig || {})
-    return this
-  }
-
-  /**
-   * Clone the client with a new (partial) configuration.
-   *
-   * @param newConfig - New client configuration properties, shallowly merged with existing configuration
-   */
-  withConfig(newConfig?: Partial<ClientConfig>): ObservableSanityStegaClient {
-    const thisConfig = this.config()
-    const {stegaConfig} = splitConfig(newConfig || {})
-    return new ObservableSanityStegaClient(this.#httpRequest, {
-      ...thisConfig,
-      ...newConfig,
-      stega: {
-        ...(thisConfig.stega || {}),
-        ...(stegaConfig || {}),
-      },
-    })
-  }
-
-  /**
-   * Perform a GROQ-query against the configured dataset.
-   *
-   * @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>
-  /**
-   * Perform a GROQ-query against the configured dataset.
-   *
-   * @param query - GROQ-query to perform
-   * @param params - Query parameters
-   * @param options - Request options
-   */
-  fetch<R = Any, Q = QueryParams>(
-    query: string,
-    params: Q | undefined,
-    options: FilteredResponseQueryOptions,
-  ): Observable<R>
-  /**
-   * Perform a GROQ-query against the configured dataset.
-   *
-   * @param query - GROQ-query to perform
-   * @param params - Query parameters
-   * @param options - Request options
-   */
-  fetch<R = Any, Q = QueryParams>(
-    query: string,
-    params: Q | undefined,
-    options: UnfilteredResponseQueryOptions,
-  ): Observable<RawQueryResponse<R>>
-  fetch<R, Q extends QueryParams>(
-    query: string,
-    _params?: Q,
-    _options: FilteredResponseQueryOptions | UnfilteredResponseQueryOptions = {},
-  ): Observable<RawQueryResponse<R> | R> {
-    const {stegaConfig, fetchOptions: options} = splitStegaConfigFromFetchOptions(
-      _options,
-      this.stegaConfig,
-    )
-    const params = _params ? vercelStegaCleanAll(_params) : _params
-    if (!stegaConfig.enabled) {
-      return super.fetch<R, Q>(query, params, options as Any)
-    }
-    const {filterResponse: originalFilterResponse = true} = options
-    return super
-      .fetch<R, Q>(
-        query,
-        params,
-        Object.assign({}, options as Any, {
-          filterResponse: false,
-          resultSourceMap: 'withKeyArraySelector',
-        }),
-      )
-      .pipe(
-        map((res: Any) => {
-          const {result: _result, resultSourceMap} = res as RawQueryResponse<R>
-          const result = stegaEncodeSourceMap(_result, resultSourceMap, stegaConfig)
-          return originalFilterResponse ? result : {...res, result}
-        }),
-      )
-  }
-}
-
-/** @public */
-export class SanityStegaClient extends INTERNAL_DO_NOT_USE_DIRECTLY_SanityClient {
-  /**
-   * Observable version of the Sanity client, with the same configuration as the promise-based one
-   */
-  observable: ObservableSanityStegaClient
-
-  /**
-   * Private properties
-   */
-  #httpRequest: HttpRequest
-  private stegaConfig: InitializedStegaConfig
-
-  constructor(httpRequest: HttpRequest, config: ClientStegaConfig = defaultConfig) {
-    const {clientConfig, stegaConfig} = splitConfig(config)
-    super(httpRequest, clientConfig)
-
-    this.#httpRequest = httpRequest
-    this.stegaConfig = initStegaConfig(stegaConfig, defaultStegaConfig)
-
-    this.observable = new ObservableSanityStegaClient(httpRequest, config)
-  }
-
-  /**
-   * Clone the client - returns a new instance
-   */
-  clone(): SanityStegaClient {
-    return new SanityStegaClient(this.#httpRequest, this.config())
-  }
-
-  /**
-   * Returns the current client configuration
-   */
-  config(): InitializedClientStegaConfig
-  /**
-   * Reconfigure the client. Note that this _mutates_ the current client.
-   */
-  config(newConfig?: Partial<ClientStegaConfig>): this
-  config(newConfig?: Partial<ClientStegaConfig>): ClientStegaConfig | this {
-    if (newConfig === undefined) {
-      return {...super.config(), stega: {...this.stegaConfig}}
-    }
-
-    const {clientConfig, stegaConfig} = splitConfig(newConfig)
-    super.config(clientConfig)
-
-    this.stegaConfig = initStegaConfig(stegaConfig, {...(this.stegaConfig || {})})
-    return this
-  }
-
-  /**
-   * Clone the client with a new (partial) configuration.
-   *
-   * @param newConfig - New client configuration properties, shallowly merged with existing configuration
-   */
-  withConfig(newConfig?: Partial<ClientStegaConfig>): SanityStegaClient {
-    const thisConfig = this.config()
-    const {stegaConfig} = splitConfig(newConfig || {})
-    return new SanityStegaClient(this.#httpRequest, {
-      ...thisConfig,
-      ...newConfig,
-      stega: {
-        ...(thisConfig.stega || {}),
-        ...(stegaConfig || {}),
-      },
-    })
-  }
-
-  /**
-   * Perform a GROQ-query against the configured dataset.
-   *
-   * @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>
-  /**
-   * Perform a GROQ-query against the configured dataset.
-   *
-   * @param query - GROQ-query to perform
-   * @param params - Optional query parameters
-   * @param options - Request options
-   */
-  fetch<R = Any, Q = QueryParams>(
-    query: string,
-    params: Q | undefined,
-    options: FilteredResponseQueryOptions,
-  ): 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
-   */
-  fetch<R = Any, Q = QueryParams>(
-    query: string,
-    params: Q | undefined,
-    options: UnfilteredResponseQueryOptions,
-  ): Promise<RawQueryResponse<R>>
-  fetch<R, Q extends QueryParams>(
-    query: string,
-    _params?: Q,
-    _options: FilteredResponseQueryOptions | UnfilteredResponseQueryOptions = {},
-  ): Promise<RawQueryResponse<R> | R> {
-    const {stegaConfig, fetchOptions: options} = splitStegaConfigFromFetchOptions(
-      _options,
-      this.stegaConfig,
-    )
-    const params = _params ? vercelStegaCleanAll(_params) : _params
-    if (!stegaConfig.enabled) {
-      return super.fetch<R, Q>(query, params, options as Any)
-    }
-    const {filterResponse: originalFilterResponse = true} = options
-    return super
-      .fetch<R, Q>(
-        query,
-        params,
-        Object.assign({}, options as Any, {
-          filterResponse: false,
-          resultSourceMap: 'withKeyArraySelector',
-        }),
-      )
-      .then((res: Any) => {
-        const {result: _result, resultSourceMap} = res as RawQueryResponse<R>
-        const result = stegaEncodeSourceMap(_result, resultSourceMap, stegaConfig)
-        return originalFilterResponse ? result : {...res, result}
-      })
-  }
-}
-
-export type {
-  INTERNAL_DO_NOT_USE_DIRECTLY_ObservableSanityClient,
-  INTERNAL_DO_NOT_USE_DIRECTLY_SanityClient,
-}

package/src/stega/config.ts

@@ -1,76 +0,0 @@
-import type {
-  ClientConfig,
-  FilteredResponseQueryOptions,
-  UnfilteredResponseQueryOptions,
-} from '../types'
-import type {ClientStegaConfig, InitializedStegaConfig, StegaConfig} from './types'
-
-export const defaultStegaConfig: StegaConfig = {
-  enabled: false,
-  filter: (props) => props.filterDefault(props),
-}
-
-export function splitConfig(config: ClientStegaConfig): {
-  clientConfig: ClientConfig
-  stegaConfig: StegaConfig
-} {
-  const {stega = {}, ...clientConfig} = config
-  return {clientConfig, stegaConfig: typeof stega === 'boolean' ? {enabled: stega} : stega}
-}
-
-export const initStegaConfig = (
-  config: Partial<StegaConfig>,
-  prevConfig: Partial<StegaConfig>,
-): InitializedStegaConfig => {
-  const specifiedConfig = Object.assign({} as StegaConfig, prevConfig, config)
-  const newConfig = Object.assign({} as InitializedStegaConfig, defaultStegaConfig, specifiedConfig)
-
-  if ('encodeSourceMap' in newConfig) {
-    throw new Error(
-      `It looks like you're using options meant for '@sanity/preview-kit/client'. 'encodeSourceMap' is not supported in '@sanity/client/stega'. Did you mean 'enabled'?`,
-    )
-  }
-
-  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/stega'. Did you mean 'filter'?`,
-    )
-  }
-
-  if (typeof newConfig.enabled !== 'boolean') {
-    throw new Error(`config.enabled must be a boolean, received ${newConfig.enabled}`)
-  }
-
-  if (newConfig.enabled && newConfig.studioUrl === undefined) {
-    throw new Error(`config.studioUrl must be defined when config.enabled is true`)
-  }
-
-  if (
-    newConfig.enabled &&
-    typeof newConfig.studioUrl !== 'string' &&
-    typeof newConfig.studioUrl !== 'function'
-  ) {
-    throw new Error(
-      `config.studioUrl must be a string or a function, received ${newConfig.studioUrl}`,
-    )
-  }
-
-  return newConfig
-}
-
-export function splitStegaConfigFromFetchOptions(
-  options: (FilteredResponseQueryOptions | UnfilteredResponseQueryOptions) & {
-    stega?: boolean | StegaConfig
-  },
-  initializedStegaConfig: InitializedStegaConfig,
-): {
-  fetchOptions: FilteredResponseQueryOptions | UnfilteredResponseQueryOptions
-  stegaConfig: InitializedStegaConfig
-} {
-  const {stega = {}, ...fetchOptions} = options
-  const stegaConfig = initStegaConfig(
-    typeof stega === 'boolean' ? {enabled: stega} : stega,
-    initializedStegaConfig,
-  )
-  return {fetchOptions, stegaConfig}
-}