@sanity/client 7.18.0 → 7.20.0

package/dist/index.browser.d.cts

@@ -2142,6 +2142,13 @@ export declare type ListenParams = {
   [key: string]: Any
 }
 
+declare type ListOptions = {
+  includeMembers?: boolean
+  includeFeatures?: boolean
+  organizationId?: string
+  onlyExplicitMembership?: boolean
+}
+
 /**
  * @public
  */
@@ -2698,19 +2705,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
    *
@@ -3865,6 +3866,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
@@ -4081,19 +4094,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
    *
@@ -5746,6 +5751,7 @@ export declare interface SanityProject {
   pendingInvites?: number
   maxRetentionDays?: number
   members: SanityProjectMember[]
+  features: string[]
   metadata: {
     cliInitializedAt?: string
     color?: string
@@ -6564,6 +6570,9 @@ export declare interface VideoPlaybackInfo<
   R extends VideoRenditionInfo = T extends VideoPlaybackInfoItemSigned
     ? VideoRenditionInfoSigned
     : VideoRenditionInfo,
+  S extends VideoSubtitleInfo = T extends VideoPlaybackInfoItemSigned
+    ? VideoSubtitleInfoSigned
+    : VideoSubtitleInfo,
 > {
   id: string
   thumbnail: T
@@ -6573,6 +6582,7 @@ export declare interface VideoPlaybackInfo<
   duration: number
   aspectRatio: number
   renditions?: R[]
+  subtitles?: S[]
 }
 
 /** @public */
@@ -6623,6 +6633,29 @@ export declare interface VideoRenditionInfoSigned extends VideoRenditionInfoPubl
   expiresAt: string
 }
 
+/** @public */
+export declare type VideoSubtitleInfo = VideoSubtitleInfoPublic | VideoSubtitleInfoSigned
+
+/** @public */
+export declare interface VideoSubtitleInfoPublic {
+  /** Subtitle track identifier */
+  trackId: string
+  /** ISO 639-1 language code */
+  languageCode: string
+  /** URL to the subtitle file */
+  url: string
+  /** Whether this track contains closed captions */
+  closedCaptions: boolean
+}
+
+/** @public */
+export declare interface VideoSubtitleInfoSigned extends VideoSubtitleInfoPublic {
+  /** Authentication token for signed playback */
+  token: string
+  /** Token expiration time in ISO 8601 format */
+  expiresAt: string
+}
+
 /**
  * Emitted when the listener reconnects and successfully resumes from
  * its previous position.

package/dist/index.browser.d.ts

@@ -2142,6 +2142,13 @@ export declare type ListenParams = {
   [key: string]: Any
 }
 
+declare type ListOptions = {
+  includeMembers?: boolean
+  includeFeatures?: boolean
+  organizationId?: string
+  onlyExplicitMembership?: boolean
+}
+
 /**
  * @public
  */
@@ -2698,19 +2705,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
    *
@@ -3865,6 +3866,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
@@ -4081,19 +4094,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
    *
@@ -5746,6 +5751,7 @@ export declare interface SanityProject {
   pendingInvites?: number
   maxRetentionDays?: number
   members: SanityProjectMember[]
+  features: string[]
   metadata: {
     cliInitializedAt?: string
     color?: string
@@ -6564,6 +6570,9 @@ export declare interface VideoPlaybackInfo<
   R extends VideoRenditionInfo = T extends VideoPlaybackInfoItemSigned
     ? VideoRenditionInfoSigned
     : VideoRenditionInfo,
+  S extends VideoSubtitleInfo = T extends VideoPlaybackInfoItemSigned
+    ? VideoSubtitleInfoSigned
+    : VideoSubtitleInfo,
 > {
   id: string
   thumbnail: T
@@ -6573,6 +6582,7 @@ export declare interface VideoPlaybackInfo<
   duration: number
   aspectRatio: number
   renditions?: R[]
+  subtitles?: S[]
 }
 
 /** @public */
@@ -6623,6 +6633,29 @@ export declare interface VideoRenditionInfoSigned extends VideoRenditionInfoPubl
   expiresAt: string
 }
 
+/** @public */
+export declare type VideoSubtitleInfo = VideoSubtitleInfoPublic | VideoSubtitleInfoSigned
+
+/** @public */
+export declare interface VideoSubtitleInfoPublic {
+  /** Subtitle track identifier */
+  trackId: string
+  /** ISO 639-1 language code */
+  languageCode: string
+  /** URL to the subtitle file */
+  url: string
+  /** Whether this track contains closed captions */
+  closedCaptions: boolean
+}
+
+/** @public */
+export declare interface VideoSubtitleInfoSigned extends VideoSubtitleInfoPublic {
+  /** Authentication token for signed playback */
+  token: string
+  /** Token expiration time in ISO 8601 format */
+  expiresAt: string
+}
+
 /**
  * Emitted when the listener reconnects and successfully resumes from
  * its previous position.

package/dist/index.browser.js

@@ -1771,9 +1771,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
@@ -1790,9 +1799,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