@sanity/client 7.19.0 → 7.21.0

package/dist/index.d.cts

@@ -811,6 +811,32 @@ export declare interface ClientConfig {
    * Lineage token for recursion control
    */
   lineage?: string
+  /**
+   * A custom request handler that intercepts all HTTP requests made by the client.
+   *
+   * Useful for logging, adding custom headers, refreshing auth tokens, rate limiting, etc.
+   *
+   * When using `withConfig()`, the new handler **replaces** the previous one (it does not
+   * wrap it). To compose handlers, you can chain them manually:
+   *
+   * ```ts
+   * const parent = createClient({...config, _requestHandler: handlerA})
+   * const child = parent.withConfig({
+   *   _requestHandler: (req, defaultRequester) =>
+   *     handlerB(req, (opts) => handlerA(opts, defaultRequester)),
+   * })
+   * ```
+   *
+   * Setting `_requestHandler` to `undefined` via `withConfig()` removes the handler.
+   *
+   * Note: This only applies to HTTP requests. Real-time listener connections
+   * (`client.listen()`) use EventSource and are not intercepted by this handler.
+   *
+   * @internal
+   * @deprecated Don't use outside of Sanity internals
+   * @see {@link RequestHandler}
+   */
+  _requestHandler?: RequestHandler
 }
 
 declare type ClientConfigResource =
@@ -2134,6 +2160,13 @@ export declare type ListenParams = {
   [key: string]: Any
 }
 
+declare type ListOptions = {
+  includeMembers?: boolean
+  includeFeatures?: boolean
+  organizationId?: string
+  onlyExplicitMembership?: boolean
+}
+
 /**
  * @public
  */
@@ -2146,6 +2179,7 @@ export declare class LiveClient {
   events({
     includeDrafts,
     tag: _tag,
+    waitFor,
   }?: {
     includeDrafts?: boolean
     /**
@@ -2154,6 +2188,11 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
+    /**
+     * Delays events until after a Sanity Function has processed them and called the callback endpoint.
+     * When omitted, events are delivered immediately.
+     */
+    waitFor?: 'function'
   }): Observable<LiveEvent>
 }
 
@@ -2690,19 +2729,13 @@ export declare class ObservableProjectsClient {
    *
    * @param options - Options for the list request
    *   - `includeMembers` - Whether to include members in the response (default: true)
+   *   - `includeFeatures` - Whether to include features in the response (default: true)
    *   - `organizationId` - ID of the organization to fetch projects for
-   *   - `onlyExplicitMembership` - Only include projects where the user has explicit membership (default: false)
-   */
-  list(options?: {
-    includeMembers?: true
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Observable<SanityProject[]>
-  list(options?: {
-    includeMembers?: false
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Observable<Omit<SanityProject, 'members'>[]>
+   *   - `onlyExplicitMembership` - Whether to include only projects with explicit membership (default: false)
+   */
+  list<T extends ListOptions>(
+    options?: T,
+  ): Observable<Omit<SanityProject, OmittedProjectFields<T>>[]>
   /**
    * Fetch a project by project ID
    *
@@ -3857,6 +3890,18 @@ export declare class ObservableUsersClient {
   ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>
 }
 
+declare type OmittedProjectFields<T extends ListOptions | undefined> =
+  | (T extends {
+      includeMembers: false
+    }
+      ? 'members'
+      : never)
+  | (T extends {
+      includeFeatures: false
+    }
+      ? 'features'
+      : never)
+
 /**
  * The listener connection has been established
  * note: it's usually a better option to use the 'welcome' event
@@ -4073,19 +4118,11 @@ export declare class ProjectsClient {
    *
    * @param options - Options for the list request
    *   - `includeMembers` - Whether to include members in the response (default: true)
+   *   - `includeFeatures` - Whether to include features in the response (default: true)
    *   - `organizationId` - ID of the organization to fetch projects for
-   *   - `onlyExplicitMembership` - Only include projects where the user has explicit membership (default: false)
-   */
-  list(options?: {
-    includeMembers?: true
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Promise<SanityProject[]>
-  list(options?: {
-    includeMembers?: false
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Promise<Omit<SanityProject, 'members'>[]>
+   *   - `onlyExplicitMembership` - Whether to include only projects with explicit membership (default: false)
+   */
+  list<T extends ListOptions>(options?: T): Promise<Omit<SanityProject, OmittedProjectFields<T>>[]>
   /**
    * Fetch a project by project ID
    *
@@ -4765,6 +4802,44 @@ export declare interface ReplaceVersionAction {
 /** @public */
 export declare const requester: Requester
 
+/**
+ * A function that intercepts HTTP requests made by the client.
+ *
+ * Receives the resolved request options, a `defaultRequester` function that
+ * executes the request through the normal pipeline, and a `client` instance
+ * without a `_requestHandler` (to avoid recursive interception).
+ *
+ * The consumer can:
+ * - Modify request options before calling `defaultRequester`
+ * - Transform the response stream (e.g. via `pipe`)
+ * - Skip `defaultRequester` entirely and return a custom Observable
+ * - Use `client` to make additional requests (e.g. refresh an auth token on 401)
+ *
+ * When set via `withConfig()`, the new handler **replaces** (not wraps) the previous one.
+ *
+ * Note: This only applies to HTTP requests. Real-time listener connections
+ * (`client.listen()`) use EventSource and are not intercepted by this handler.
+ *
+ * @param request - The resolved request options including `url`
+ * @param defaultRequester - Executes the request through the normal pipeline
+ * @param client - A client instance with the same configuration but without a `_requestHandler`,
+ *   useful for making side requests (e.g. token refresh) without triggering the handler recursively
+ *
+ * @internal
+ * @deprecated Don't use outside of Sanity internals
+ */
+export declare type RequestHandler = (
+  request: RequestOptions & {
+    url: string
+  },
+  defaultRequester: (
+    options: RequestOptions & {
+      url: string
+    },
+  ) => Observable<HttpRequestEvent>,
+  client: SanityClient,
+) => Observable<HttpRequestEvent>
+
 /** @internal */
 export declare interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
   url?: string
@@ -5738,6 +5813,7 @@ export declare interface SanityProject {
   pendingInvites?: number
   maxRetentionDays?: number
   members: SanityProjectMember[]
+  features: string[]
   metadata: {
     cliInitializedAt?: string
     color?: string

package/dist/index.d.ts

@@ -811,6 +811,32 @@ export declare interface ClientConfig {
    * Lineage token for recursion control
    */
   lineage?: string
+  /**
+   * A custom request handler that intercepts all HTTP requests made by the client.
+   *
+   * Useful for logging, adding custom headers, refreshing auth tokens, rate limiting, etc.
+   *
+   * When using `withConfig()`, the new handler **replaces** the previous one (it does not
+   * wrap it). To compose handlers, you can chain them manually:
+   *
+   * ```ts
+   * const parent = createClient({...config, _requestHandler: handlerA})
+   * const child = parent.withConfig({
+   *   _requestHandler: (req, defaultRequester) =>
+   *     handlerB(req, (opts) => handlerA(opts, defaultRequester)),
+   * })
+   * ```
+   *
+   * Setting `_requestHandler` to `undefined` via `withConfig()` removes the handler.
+   *
+   * Note: This only applies to HTTP requests. Real-time listener connections
+   * (`client.listen()`) use EventSource and are not intercepted by this handler.
+   *
+   * @internal
+   * @deprecated Don't use outside of Sanity internals
+   * @see {@link RequestHandler}
+   */
+  _requestHandler?: RequestHandler
 }
 
 declare type ClientConfigResource =
@@ -2134,6 +2160,13 @@ export declare type ListenParams = {
   [key: string]: Any
 }
 
+declare type ListOptions = {
+  includeMembers?: boolean
+  includeFeatures?: boolean
+  organizationId?: string
+  onlyExplicitMembership?: boolean
+}
+
 /**
  * @public
  */
@@ -2146,6 +2179,7 @@ export declare class LiveClient {
   events({
     includeDrafts,
     tag: _tag,
+    waitFor,
   }?: {
     includeDrafts?: boolean
     /**
@@ -2154,6 +2188,11 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
+    /**
+     * Delays events until after a Sanity Function has processed them and called the callback endpoint.
+     * When omitted, events are delivered immediately.
+     */
+    waitFor?: 'function'
   }): Observable<LiveEvent>
 }
 
@@ -2690,19 +2729,13 @@ export declare class ObservableProjectsClient {
    *
    * @param options - Options for the list request
    *   - `includeMembers` - Whether to include members in the response (default: true)
+   *   - `includeFeatures` - Whether to include features in the response (default: true)
    *   - `organizationId` - ID of the organization to fetch projects for
-   *   - `onlyExplicitMembership` - Only include projects where the user has explicit membership (default: false)
-   */
-  list(options?: {
-    includeMembers?: true
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Observable<SanityProject[]>
-  list(options?: {
-    includeMembers?: false
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Observable<Omit<SanityProject, 'members'>[]>
+   *   - `onlyExplicitMembership` - Whether to include only projects with explicit membership (default: false)
+   */
+  list<T extends ListOptions>(
+    options?: T,
+  ): Observable<Omit<SanityProject, OmittedProjectFields<T>>[]>
   /**
    * Fetch a project by project ID
    *
@@ -3857,6 +3890,18 @@ export declare class ObservableUsersClient {
   ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>
 }
 
+declare type OmittedProjectFields<T extends ListOptions | undefined> =
+  | (T extends {
+      includeMembers: false
+    }
+      ? 'members'
+      : never)
+  | (T extends {
+      includeFeatures: false
+    }
+      ? 'features'
+      : never)
+
 /**
  * The listener connection has been established
  * note: it's usually a better option to use the 'welcome' event
@@ -4073,19 +4118,11 @@ export declare class ProjectsClient {
    *
    * @param options - Options for the list request
    *   - `includeMembers` - Whether to include members in the response (default: true)
+   *   - `includeFeatures` - Whether to include features in the response (default: true)
    *   - `organizationId` - ID of the organization to fetch projects for
-   *   - `onlyExplicitMembership` - Only include projects where the user has explicit membership (default: false)
-   */
-  list(options?: {
-    includeMembers?: true
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Promise<SanityProject[]>
-  list(options?: {
-    includeMembers?: false
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Promise<Omit<SanityProject, 'members'>[]>
+   *   - `onlyExplicitMembership` - Whether to include only projects with explicit membership (default: false)
+   */
+  list<T extends ListOptions>(options?: T): Promise<Omit<SanityProject, OmittedProjectFields<T>>[]>
   /**
    * Fetch a project by project ID
    *
@@ -4765,6 +4802,44 @@ export declare interface ReplaceVersionAction {
 /** @public */
 export declare const requester: Requester
 
+/**
+ * A function that intercepts HTTP requests made by the client.
+ *
+ * Receives the resolved request options, a `defaultRequester` function that
+ * executes the request through the normal pipeline, and a `client` instance
+ * without a `_requestHandler` (to avoid recursive interception).
+ *
+ * The consumer can:
+ * - Modify request options before calling `defaultRequester`
+ * - Transform the response stream (e.g. via `pipe`)
+ * - Skip `defaultRequester` entirely and return a custom Observable
+ * - Use `client` to make additional requests (e.g. refresh an auth token on 401)
+ *
+ * When set via `withConfig()`, the new handler **replaces** (not wraps) the previous one.
+ *
+ * Note: This only applies to HTTP requests. Real-time listener connections
+ * (`client.listen()`) use EventSource and are not intercepted by this handler.
+ *
+ * @param request - The resolved request options including `url`
+ * @param defaultRequester - Executes the request through the normal pipeline
+ * @param client - A client instance with the same configuration but without a `_requestHandler`,
+ *   useful for making side requests (e.g. token refresh) without triggering the handler recursively
+ *
+ * @internal
+ * @deprecated Don't use outside of Sanity internals
+ */
+export declare type RequestHandler = (
+  request: RequestOptions & {
+    url: string
+  },
+  defaultRequester: (
+    options: RequestOptions & {
+      url: string
+    },
+  ) => Observable<HttpRequestEvent>,
+  client: SanityClient,
+) => Observable<HttpRequestEvent>
+
 /** @internal */
 export declare interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
   url?: string
@@ -5738,6 +5813,7 @@ export declare interface SanityProject {
   pendingInvites?: number
   maxRetentionDays?: number
   members: SanityProjectMember[]
+  features: string[]
   metadata: {
     cliInitializedAt?: string
     color?: string

package/dist/index.js

@@ -1269,7 +1269,8 @@ class LiveClient {
    */
   events({
     includeDrafts = !1,
-    tag: _tag
+    tag: _tag,
+    waitFor
   } = {}) {
     const {
       projectId,
@@ -1288,7 +1289,7 @@ class LiveClient {
         "The live events API requires a token or withCredentials when 'includeDrafts: true'. Please update your client configuration. The token should have the lowest possible access role."
       );
     const path = _getDataUrl(this.#client, "live/events"), url = new URL(this.#client.getUrl(path, !1)), tag = _tag && requestTagPrefix ? [requestTagPrefix, _tag].join(".") : _tag;
-    tag && url.searchParams.set("tag", tag), includeDrafts && url.searchParams.set("includeDrafts", "true");
+    tag && url.searchParams.set("tag", tag), includeDrafts && url.searchParams.set("includeDrafts", "true"), waitFor && url.searchParams.set("waitFor", waitFor);
     const esOptions = {};
     includeDrafts && withCredentials && (esOptions.withCredentials = !0), (includeDrafts && token || configHeaders) && (esOptions.headers = {}, includeDrafts && token && (esOptions.headers.Authorization = `Bearer ${token}`), configHeaders && Object.assign(esOptions.headers, configHeaders));
     const key = `${url.href}::${JSON.stringify(esOptions)}`, existing = eventsCache.get(key);
@@ -1589,9 +1590,18 @@ class ObservableProjectsClient {
   constructor(client, httpRequest) {
     this.#client = client, this.#httpRequest = httpRequest;
   }
+  /**
+   * Fetch a list of projects the authenticated user has access to.
+   *
+   * @param options - Options for the list request
+   *   - `includeMembers` - Whether to include members in the response (default: true)
+   *   - `includeFeatures` - Whether to include features in the response (default: true)
+   *   - `organizationId` - ID of the organization to fetch projects for
+   *   - `onlyExplicitMembership` - Whether to include only projects with explicit membership (default: false)
+   */
   list(options) {
     const query = {}, uri = "/projects";
-    return options?.includeMembers === !1 && (query.includeMembers = "false"), options?.organizationId && (query.organizationId = options.organizationId), options?.onlyExplicitMembership === !0 && (query.onlyExplicitMembership = "true"), _request(this.#client, this.#httpRequest, { uri, query });
+    return options?.includeMembers === !1 && (query.includeMembers = "false"), options?.includeFeatures === !1 && (query.includeFeatures = "false"), options?.organizationId && (query.organizationId = options.organizationId), options?.onlyExplicitMembership && (query.onlyExplicitMembership = "true"), _request(this.#client, this.#httpRequest, { uri, query });
   }
   /**
    * Fetch a project by project ID
@@ -1608,9 +1618,20 @@ class ProjectsClient {
   constructor(client, httpRequest) {
     this.#client = client, this.#httpRequest = httpRequest;
   }
+  /**
+   * Fetch a list of projects the authenticated user has access to.
+   *
+   * @param options - Options for the list request
+   *   - `includeMembers` - Whether to include members in the response (default: true)
+   *   - `includeFeatures` - Whether to include features in the response (default: true)
+   *   - `organizationId` - ID of the organization to fetch projects for
+   *   - `onlyExplicitMembership` - Whether to include only projects with explicit membership (default: false)
+   */
   list(options) {
     const query = {}, uri = "/projects";
-    return options?.includeMembers === !1 && (query.includeMembers = "false"), options?.organizationId && (query.organizationId = options.organizationId), options?.onlyExplicitMembership === !0 && (query.onlyExplicitMembership = "true"), lastValueFrom(_request(this.#client, this.#httpRequest, { uri, query }));
+    return options?.includeMembers === !1 && (query.includeMembers = "false"), options?.includeFeatures === !1 && (query.includeFeatures = "false"), options?.organizationId && (query.organizationId = options.organizationId), options?.onlyExplicitMembership && (query.onlyExplicitMembership = "true"), lastValueFrom(
+      _request(this.#client, this.#httpRequest, { uri, query })
+    );
   }
   /**
    * Fetch a project by project ID
@@ -2166,13 +2187,22 @@ class ObservableSanityClient {
    * Private properties
    */
   #clientConfig;
+  #originalHttpRequest;
   #httpRequest;
   /**
    * Instance properties
    */
   listen = _listen;
   constructor(httpRequest, config = defaultConfig) {
-    this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = {
+    this.config(config), this.#originalHttpRequest = httpRequest;
+    const requestHandler = config._requestHandler;
+    this.#httpRequest = requestHandler ? /* @__PURE__ */ (() => {
+      let bareClient;
+      return (options, requester2) => {
+        const opts = options;
+        return bareClient || (bareClient = new SanityClient(httpRequest, { ...config, _requestHandler: void 0 })), requestHandler(opts, (o) => httpRequest(o, requester2), bareClient);
+      };
+    })() : httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = {
       video: new ObservableMediaLibraryVideoClient(this, this.#httpRequest)
     }, this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest), this.agent = {
       action: new ObservableAgentsActionClient(this, this.#httpRequest)
@@ -2182,7 +2212,7 @@ class ObservableSanityClient {
    * Clone the client - returns a new instance
    */
   clone() {
-    return new ObservableSanityClient(this.#httpRequest, this.config());
+    return new ObservableSanityClient(this.#originalHttpRequest, this.config());
   }
   config(newConfig) {
     if (newConfig === void 0)
@@ -2200,7 +2230,7 @@ class ObservableSanityClient {
    */
   withConfig(newConfig) {
     const thisConfig = this.config();
-    return new ObservableSanityClient(this.#httpRequest, {
+    return new ObservableSanityClient(this.#originalHttpRequest, {
       ...thisConfig,
       ...newConfig,
       stega: {
@@ -2430,13 +2460,22 @@ class SanityClient {
    * Private properties
    */
   #clientConfig;
+  #originalHttpRequest;
   #httpRequest;
   /**
    * Instance properties
    */
   listen = _listen;
   constructor(httpRequest, config = defaultConfig) {
-    this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = {
+    this.config(config), this.#originalHttpRequest = httpRequest;
+    const requestHandler = config._requestHandler;
+    this.#httpRequest = requestHandler ? /* @__PURE__ */ (() => {
+      let bareClient;
+      return (options, requester2) => {
+        const opts = options;
+        return bareClient || (bareClient = new SanityClient(httpRequest, { ...config, _requestHandler: void 0 })), requestHandler(opts, (o) => httpRequest(o, requester2), bareClient);
+      };
+    })() : httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = {
       video: new MediaLibraryVideoClient(this, this.#httpRequest)
     }, this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.agent = {
       action: new AgentActionsClient(this, this.#httpRequest)
@@ -2446,7 +2485,7 @@ class SanityClient {
    * Clone the client - returns a new instance
    */
   clone() {
-    return new SanityClient(this.#httpRequest, this.config());
+    return new SanityClient(this.#originalHttpRequest, this.config());
   }
   config(newConfig) {
     if (newConfig === void 0)
@@ -2464,7 +2503,7 @@ class SanityClient {
    */
   withConfig(newConfig) {
     const thisConfig = this.config();
-    return new SanityClient(this.#httpRequest, {
+    return new SanityClient(this.#originalHttpRequest, {
       ...thisConfig,
       ...newConfig,
       stega: {
@@ -2735,7 +2774,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "7.19.0";
+var name = "@sanity/client", version = "7.21.0";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),