@sanity/client 6.11.3 → 6.11.4-canary.1

package/src/data/dataMethods.ts

@@ -1,30 +1,30 @@
-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,
   Any,
   BaseMutationOptions,
-  FilteredResponseQueryOptions,
   FirstDocumentIdMutationOptions,
   FirstDocumentMutationOptions,
   HttpRequest,
   HttpRequestEvent,
   IdentifiedSanityDocumentStub,
+  InitializedStegaConfig,
   MultipleMutationResult,
   Mutation,
   MutationSelection,
-  QueryParams,
+  QueryOptions,
   RawQueryResponse,
   RequestObservableOptions,
   RequestOptions,
   SanityDocument,
   SingleMutationResult,
-  UnfilteredResponseQueryOptions,
 } from '../types'
 import {getSelection} from '../util/getSelection'
 import * as validate from '../validators'
@@ -62,24 +62,30 @@ const indexBy = (docs: Any[], attr: Any) =>
 const getQuerySizeLimit = 11264
 
 /** @internal */
-export function _fetch<R, Q extends QueryParams>(
+export function _fetch<R, Q>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
+  _stega: InitializedStegaConfig,
   query: string,
-  params?: Q,
-  options: FilteredResponseQueryOptions | UnfilteredResponseQueryOptions = {},
+  _params: Q = {} as Q,
+  options: QueryOptions = {},
 ): 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 +93,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/data/patch.ts

@@ -19,6 +19,8 @@ import type {
 import {getSelection} from '../util/getSelection'
 import {validateInsert, validateObject} from '../validators'
 
+const clientSymbol = Symbol('#client')
+
 /** @internal */
 export class BasePatch {
   protected selection: PatchSelection
@@ -193,7 +195,7 @@ export class BasePatch {
 
 /** @public */
 export class ObservablePatch extends BasePatch {
-  #client?: ObservableSanityClient
+  private [clientSymbol]?: ObservableSanityClient
 
   constructor(
     selection: PatchSelection,
@@ -201,14 +203,14 @@ export class ObservablePatch extends BasePatch {
     client?: ObservableSanityClient,
   ) {
     super(selection, operations)
-    this.#client = client
+    this[clientSymbol] = client
   }
 
   /**
    * Clones the patch
    */
   clone(): ObservablePatch {
-    return new ObservablePatch(this.selection, {...this.operations}, this.#client)
+    return new ObservablePatch(this.selection, {...this.operations}, this[clientSymbol])
   }
 
   /**
@@ -257,7 +259,7 @@ export class ObservablePatch extends BasePatch {
   ): Observable<
     SanityDocument<R> | SanityDocument<R>[] | SingleMutationResult | MultipleMutationResult
   > {
-    if (!this.#client) {
+    if (!this[clientSymbol]) {
       throw new Error(
         'No `client` passed to patch, either provide one or pass the ' +
           'patch to a clients `mutate()` method',
@@ -266,23 +268,23 @@ export class ObservablePatch extends BasePatch {
 
     const returnFirst = typeof this.selection === 'string'
     const opts = Object.assign({returnFirst, returnDocuments: true}, options)
-    return this.#client.mutate<R>({patch: this.serialize()} as Any, opts)
+    return this[clientSymbol].mutate<R>({patch: this.serialize()} as Any, opts)
   }
 }
 
 /** @public */
 export class Patch extends BasePatch {
-  #client?: SanityClient
+  private [clientSymbol]?: SanityClient
   constructor(selection: PatchSelection, operations?: PatchOperations, client?: SanityClient) {
     super(selection, operations)
-    this.#client = client
+    this[clientSymbol] = client
   }
 
   /**
    * Clones the patch
    */
   clone(): Patch {
-    return new Patch(this.selection, {...this.operations}, this.#client)
+    return new Patch(this.selection, {...this.operations}, this[clientSymbol])
   }
 
   /**
@@ -331,7 +333,7 @@ export class Patch extends BasePatch {
   ): Promise<
     SanityDocument<R> | SanityDocument<R>[] | SingleMutationResult | MultipleMutationResult
   > {
-    if (!this.#client) {
+    if (!this[clientSymbol]) {
       throw new Error(
         'No `client` passed to patch, either provide one or pass the ' +
           'patch to a clients `mutate()` method',
@@ -340,6 +342,6 @@ export class Patch extends BasePatch {
 
     const returnFirst = typeof this.selection === 'string'
     const opts = Object.assign({returnFirst, returnDocuments: true}, options)
-    return this.#client.mutate<R>({patch: this.serialize()} as Any, opts)
+    return this[clientSymbol].mutate<R>({patch: this.serialize()} as Any, opts)
   }
 }

package/src/data/transaction.ts

@@ -25,6 +25,7 @@ export type PatchBuilder = (patch: Patch) => Patch
 export type ObservablePatchBuilder = (patch: ObservablePatch) => ObservablePatch
 
 const defaultMutateOptions = {returnDocuments: false}
+const clientSymbol = Symbol('#client')
 
 /** @internal */
 export class BaseTransaction {
@@ -135,17 +136,17 @@ export class BaseTransaction {
 
 /** @public */
 export class Transaction extends BaseTransaction {
-  #client?: SanityClient
+  private [clientSymbol]?: SanityClient
   constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string) {
     super(operations, transactionId)
-    this.#client = client
+    this[clientSymbol] = client
   }
 
   /**
    * Clones the transaction
    */
   clone(): Transaction {
-    return new Transaction([...this.operations], this.#client, this.trxId)
+    return new Transaction([...this.operations], this[clientSymbol], this.trxId)
   }
 
   /**
@@ -192,14 +193,14 @@ export class Transaction extends BaseTransaction {
   ): Promise<
     SanityDocument<R> | SanityDocument<R>[] | SingleMutationResult | MultipleMutationResult
   > {
-    if (!this.#client) {
+    if (!this[clientSymbol]) {
       throw new Error(
         'No `client` passed to transaction, either provide one or pass the ' +
           'transaction to a clients `mutate()` method',
       )
     }
 
-    return this.#client.mutate<R>(
+    return this[clientSymbol].mutate<R>(
       this.serialize() as Any,
       Object.assign({transactionId: this.trxId}, defaultMutateOptions, options || {}),
     )
@@ -231,7 +232,7 @@ export class Transaction extends BaseTransaction {
 
     // patch => patch.inc({visits: 1}).set({foo: 'bar'})
     if (isBuilder) {
-      const patch = patchOps(new Patch(patchOrDocumentId, {}, this.#client))
+      const patch = patchOps(new Patch(patchOrDocumentId, {}, this[clientSymbol]))
       if (!(patch instanceof Patch)) {
         throw new Error('function passed to `patch()` must return the patch')
       }
@@ -245,17 +246,17 @@ export class Transaction extends BaseTransaction {
 
 /** @public */
 export class ObservableTransaction extends BaseTransaction {
-  #client?: ObservableSanityClient
+  private [clientSymbol]?: ObservableSanityClient
   constructor(operations?: Mutation[], client?: ObservableSanityClient, transactionId?: string) {
     super(operations, transactionId)
-    this.#client = client
+    this[clientSymbol] = client
   }
 
   /**
    * Clones the transaction
    */
   clone(): ObservableTransaction {
-    return new ObservableTransaction([...this.operations], this.#client, this.trxId)
+    return new ObservableTransaction([...this.operations], this[clientSymbol], this.trxId)
   }
 
   /**
@@ -302,14 +303,14 @@ export class ObservableTransaction extends BaseTransaction {
   ): Observable<
     SanityDocument<R> | SanityDocument<R>[] | SingleMutationResult | MultipleMutationResult
   > {
-    if (!this.#client) {
+    if (!this[clientSymbol]) {
       throw new Error(
         'No `client` passed to transaction, either provide one or pass the ' +
           'transaction to a clients `mutate()` method',
       )
     }
 
-    return this.#client.mutate<R>(
+    return this[clientSymbol].mutate<R>(
       this.serialize() as Any,
       Object.assign({transactionId: this.trxId}, defaultMutateOptions, options || {}),
     )
@@ -345,7 +346,7 @@ export class ObservableTransaction extends BaseTransaction {
 
     // patch => patch.inc({visits: 1}).set({foo: 'bar'})
     if (isBuilder) {
-      const patch = patchOps(new ObservablePatch(patchOrDocumentId, {}, this.#client))
+      const patch = patchOps(new ObservablePatch(patchOrDocumentId, {}, this[clientSymbol]))
       if (!(patch instanceof ObservablePatch)) {
         throw new Error('function passed to `patch()` must return the patch')
       }

package/src/datasets/DatasetsClient.ts

@@ -5,13 +5,16 @@ import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {DatasetAclMode, DatasetResponse, DatasetsResponse, HttpRequest} from '../types'
 import * as validate from '../validators'
 
+const clientSymbol = Symbol('#client')
+const httpRequestSymbol = Symbol('#httpRequest')
+
 /** @internal */
 export class ObservableDatasetsClient {
-  #client: ObservableSanityClient
-  #httpRequest: HttpRequest
+  private [clientSymbol]: ObservableSanityClient
+  private [httpRequestSymbol]: HttpRequest
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
-    this.#client = client
-    this.#httpRequest = httpRequest
+    this[clientSymbol] = client
+    this[httpRequestSymbol] = httpRequest
   }
 
   /**
@@ -21,7 +24,13 @@ export class ObservableDatasetsClient {
    * @param options - Options for the dataset
    */
   create(name: string, options?: {aclMode?: DatasetAclMode}): Observable<DatasetResponse> {
-    return _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PUT', name, options)
+    return _modify<DatasetResponse>(
+      this[clientSymbol],
+      this[httpRequestSymbol],
+      'PUT',
+      name,
+      options,
+    )
   }
 
   /**
@@ -31,7 +40,13 @@ export class ObservableDatasetsClient {
    * @param options - New options for the dataset
    */
   edit(name: string, options?: {aclMode?: DatasetAclMode}): Observable<DatasetResponse> {
-    return _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PATCH', name, options)
+    return _modify<DatasetResponse>(
+      this[clientSymbol],
+      this[httpRequestSymbol],
+      'PATCH',
+      name,
+      options,
+    )
   }
 
   /**
@@ -40,14 +55,14 @@ export class ObservableDatasetsClient {
    * @param name - Name of the dataset to delete
    */
   delete(name: string): Observable<{deleted: true}> {
-    return _modify<{deleted: true}>(this.#client, this.#httpRequest, 'DELETE', name)
+    return _modify<{deleted: true}>(this[clientSymbol], this[httpRequestSymbol], 'DELETE', name)
   }
 
   /**
    * Fetch a list of datasets for the configured project
    */
   list(): Observable<DatasetsResponse> {
-    return _request<DatasetsResponse>(this.#client, this.#httpRequest, {
+    return _request<DatasetsResponse>(this[clientSymbol], this[httpRequestSymbol], {
       uri: '/datasets',
       tag: null,
     })
@@ -56,11 +71,11 @@ export class ObservableDatasetsClient {
 
 /** @internal */
 export class DatasetsClient {
-  #client: SanityClient
-  #httpRequest: HttpRequest
+  private [clientSymbol]: SanityClient
+  private [httpRequestSymbol]: HttpRequest
   constructor(client: SanityClient, httpRequest: HttpRequest) {
-    this.#client = client
-    this.#httpRequest = httpRequest
+    this[clientSymbol] = client
+    this[httpRequestSymbol] = httpRequest
   }
 
   /**
@@ -71,7 +86,7 @@ export class DatasetsClient {
    */
   create(name: string, options?: {aclMode?: DatasetAclMode}): Promise<DatasetResponse> {
     return lastValueFrom(
-      _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PUT', name, options),
+      _modify<DatasetResponse>(this[clientSymbol], this[httpRequestSymbol], 'PUT', name, options),
     )
   }
 
@@ -83,7 +98,7 @@ export class DatasetsClient {
    */
   edit(name: string, options?: {aclMode?: DatasetAclMode}): Promise<DatasetResponse> {
     return lastValueFrom(
-      _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PATCH', name, options),
+      _modify<DatasetResponse>(this[clientSymbol], this[httpRequestSymbol], 'PATCH', name, options),
     )
   }
 
@@ -93,7 +108,9 @@ export class DatasetsClient {
    * @param name - Name of the dataset to delete
    */
   delete(name: string): Promise<{deleted: true}> {
-    return lastValueFrom(_modify<{deleted: true}>(this.#client, this.#httpRequest, 'DELETE', name))
+    return lastValueFrom(
+      _modify<{deleted: true}>(this[clientSymbol], this[httpRequestSymbol], 'DELETE', name),
+    )
   }
 
   /**
@@ -101,7 +118,10 @@ export class DatasetsClient {
    */
   list(): Promise<DatasetsResponse> {
     return lastValueFrom(
-      _request<DatasetsResponse>(this.#client, this.#httpRequest, {uri: '/datasets', tag: null}),
+      _request<DatasetsResponse>(this[clientSymbol], this[httpRequestSymbol], {
+        uri: '/datasets',
+        tag: null,
+      }),
     )
   }
 }

package/src/projects/ProjectsClient.ts

@@ -4,13 +4,16 @@ import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {HttpRequest, SanityProject} from '../types'
 
+const clientSymbol = Symbol('#client')
+const httpRequestSymbol = Symbol('#httpRequest')
+
 /** @internal */
 export class ObservableProjectsClient {
-  #client: ObservableSanityClient
-  #httpRequest: HttpRequest
+  private [clientSymbol]: ObservableSanityClient
+  private [httpRequestSymbol]: HttpRequest
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
-    this.#client = client
-    this.#httpRequest = httpRequest
+    this[clientSymbol] = client
+    this[httpRequestSymbol] = httpRequest
   }
 
   /**
@@ -25,7 +28,7 @@ export class ObservableProjectsClient {
     includeMembers?: boolean
   }): Observable<SanityProject[] | Omit<SanityProject, 'members'>[]> {
     const uri = options?.includeMembers === false ? '/projects?includeMembers=false' : '/projects'
-    return _request<SanityProject[]>(this.#client, this.#httpRequest, {uri})
+    return _request<SanityProject[]>(this[clientSymbol], this[httpRequestSymbol], {uri})
   }
 
   /**
@@ -34,17 +37,19 @@ export class ObservableProjectsClient {
    * @param projectId - ID of the project to fetch
    */
   getById(projectId: string): Observable<SanityProject> {
-    return _request<SanityProject>(this.#client, this.#httpRequest, {uri: `/projects/${projectId}`})
+    return _request<SanityProject>(this[clientSymbol], this[httpRequestSymbol], {
+      uri: `/projects/${projectId}`,
+    })
   }
 }
 
 /** @internal */
 export class ProjectsClient {
-  #client: SanityClient
-  #httpRequest: HttpRequest
+  private [clientSymbol]: SanityClient
+  private [httpRequestSymbol]: HttpRequest
   constructor(client: SanityClient, httpRequest: HttpRequest) {
-    this.#client = client
-    this.#httpRequest = httpRequest
+    this[clientSymbol] = client
+    this[httpRequestSymbol] = httpRequest
   }
 
   /**
@@ -57,7 +62,9 @@ export class ProjectsClient {
   list(options?: {includeMembers?: false}): Promise<Omit<SanityProject, 'members'>[]>
   list(options?: {includeMembers?: boolean}): Promise<SanityProject[]> {
     const uri = options?.includeMembers === false ? '/projects?includeMembers=false' : '/projects'
-    return lastValueFrom(_request<SanityProject[]>(this.#client, this.#httpRequest, {uri}))
+    return lastValueFrom(
+      _request<SanityProject[]>(this[clientSymbol], this[httpRequestSymbol], {uri}),
+    )
   }
 
   /**
@@ -67,7 +74,9 @@ export class ProjectsClient {
    */
   getById(projectId: string): Promise<SanityProject> {
     return lastValueFrom(
-      _request<SanityProject>(this.#client, this.#httpRequest, {uri: `/projects/${projectId}`}),
+      _request<SanityProject>(this[clientSymbol], this[httpRequestSymbol], {
+        uri: `/projects/${projectId}`,
+      }),
     )
   }
 }

package/src/stega/index.browser.ts

@@ -2,15 +2,11 @@ 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'
 
 /** @public */

package/src/stega/index.ts

@@ -2,15 +2,11 @@ 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'
 
 /** @public */

package/src/stega/shared.ts

@@ -1,17 +1,19 @@
+import {ObservableSanityClient, SanityClient} from '../SanityClient'
+
+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
+ * @deprecated -- Use `import {SanityClient} from '@sanity/client'` instead
  * @public
  */
-export type SanityClient = never
+export class SanityStegaClient extends SanityClient {}
 
 /**
- * @deprecated -- Use `import type {ObservableSanityClient} from '@sanity/client'` instead
+ * @deprecated -- Use `import {ObservableSanityClient} from '@sanity/client'` instead
  * @public
  */
-export type ObservableSanityClient = never
+export class ObservableSanityStegaClient extends ObservableSanityClient {}

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
-  }
-}