@sanity/client 6.11.3 → 6.11.4-canary.1

package/src/types.ts

@@ -2,6 +2,8 @@
 
 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
  * @internal
@@ -89,6 +91,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 +117,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 */
@@ -425,6 +435,79 @@ export interface PatchOperations {
 
 /** @public */
 export type QueryParams = {[key: string]: Any}
+
+/**
+ * Verify this type has all the same keys as QueryOptions before exporting
+ * @internal
+ */
+export type _QueryParamsLikelyByMistake = {
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  body?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  cache?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  filterResponse?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  headers?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  method?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  next?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  perspective?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  query?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  resultSourceMap?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  signal?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  stega?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  tag?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  timeout?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  token?: Any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  useCdn?: Any
+}
+
+/**
+ * It's easy to accidentally set query options such as `filterResponse`, `cache` and `next` as the second parameter in `client.fetch`,
+ * as that is a wide type used to set GROQ query paramaters and it accepts anything that can serialize to JSON.
+ * This type is used to prevent that, and will cause a type error if you try to pass a query option as the second parameter.
+ * If this type is `never`, it means `_QueryParamsLikelyByMistake` is missing keys from `QueryOptions`.
+ * @internal
+ */
+export type QueryParamsLikelyByMistake =
+  Required<_QueryParamsLikelyByMistake> extends Record<keyof QueryOptions, Any>
+    ? _QueryParamsLikelyByMistake
+    : never
+
+/**
+ * It's easy to accidentally set query options such as `filterResponse`, `cache` and `next` as the second parameter in `client.fetch`,
+ * as that is a wide type used to set GROQ query paramaters and it accepts anything that can serialize to JSON.
+ * This type is used to prevent that, and will cause a type error if you try to pass a query option as the second parameter.
+ * @internal
+ */
+export type QueryParamsWithoutQueryOptions = {
+  [K in keyof _QueryParamsLikelyByMistake]: never
+} & QueryParams
+
+/**
+ * Transform a QueryParams generic type to a valid parameter type for `client.fetch
+ * @public
+ */
+export type QueryParamsParameter<QueryParamsParameterType> =
+  QueryParamsParameterType extends QueryParams
+    ? QueryParamsParameterType
+    : QueryParamsParameterType extends Record<string, never>
+      ? Record<string, never>
+      : QueryParamsParameterType extends undefined
+        ? undefined | Record<string, never>
+        : never
+
 /** @internal */
 export type MutationSelection = {query: string; params?: QueryParams} | {id: string | string[]}
 /** @internal */
@@ -664,24 +747,29 @@ export interface ListenOptions {
 }
 
 /** @public */
-export interface ResponseQueryOptions<T = 'next'> extends RequestOptions {
+export interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
   resultSourceMap?: boolean | 'withKeyArraySelector'
-  cache?: RequestInit['cache']
-  next?: T extends keyof RequestInit ? RequestInit[T] : never
   useCdn?: boolean
+  stega?: boolean | StegaConfig
+  // The `cache` and `next` options are specific to the Next.js App Router integration
+  cache?: 'next' extends keyof RequestInit ? RequestInit['cache'] : never
+  next?: ('next' extends keyof RequestInit ? RequestInit : never)['next']
 }
 
 /** @public */
-export type FilteredResponseQueryOptions = ResponseQueryOptions & {
+export interface FilteredResponseQueryOptions extends ResponseQueryOptions {
   filterResponse?: true
 }
 
 /** @public */
-export type UnfilteredResponseQueryOptions = ResponseQueryOptions & {
+export interface UnfilteredResponseQueryOptions extends ResponseQueryOptions {
   filterResponse: false
 }
 
+/** @public */
+export type QueryOptions = FilteredResponseQueryOptions | UnfilteredResponseQueryOptions
+
 /** @public */
 export interface RawQueryResponse<R> {
   query: string
@@ -898,3 +986,17 @@ export interface ContentSourceMap {
   documents: ContentSourceMapDocuments
   paths: ContentSourceMapPaths
 }
+
+export type {
+  ContentSourceMapParsedPath,
+  ContentSourceMapParsedPathKeyedSegment,
+  FilterDefault,
+  InitializedStegaConfig,
+  Logger,
+  ResolveStudioUrl,
+  StegaConfig,
+  StegaConfigRequiredKeys,
+  StudioBaseRoute,
+  StudioBaseUrl,
+  StudioUrl,
+} from './stega/types'

package/src/users/UsersClient.ts

@@ -4,13 +4,16 @@ import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {CurrentSanityUser, HttpRequest, SanityUser} from '../types'
 
+const clientSymbol = Symbol('#client')
+const httpRequestSymbol = Symbol('#httpRequest')
+
 /** @public */
 export class ObservableUsersClient {
-  #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
   }
 
   /**
@@ -22,8 +25,8 @@ export class ObservableUsersClient {
     id: T,
   ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser> {
     return _request<T extends 'me' ? CurrentSanityUser : SanityUser>(
-      this.#client,
-      this.#httpRequest,
+      this[clientSymbol],
+      this[httpRequestSymbol],
       {uri: `/users/${id}`},
     )
   }
@@ -31,11 +34,11 @@ export class ObservableUsersClient {
 
 /** @public */
 export class UsersClient {
-  #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
   }
 
   /**
@@ -47,9 +50,13 @@ export class UsersClient {
     id: T,
   ): Promise<T extends 'me' ? CurrentSanityUser : SanityUser> {
     return lastValueFrom(
-      _request<T extends 'me' ? CurrentSanityUser : SanityUser>(this.#client, this.#httpRequest, {
-        uri: `/users/${id}`,
-      }),
+      _request<T extends 'me' ? CurrentSanityUser : SanityUser>(
+        this[clientSymbol],
+        this[httpRequestSymbol],
+        {
+          uri: `/users/${id}`,
+        },
+      ),
     )
   }
 }