@sanity/client 7.18.0 → 7.20.0

package/src/projects/ProjectsClient.ts

@@ -4,6 +4,17 @@ import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {HttpRequest, SanityProject} from '../types'
 
+type ListOptions = {
+  includeMembers?: boolean
+  includeFeatures?: boolean
+  organizationId?: string
+  onlyExplicitMembership?: boolean
+}
+
+type OmittedProjectFields<T extends ListOptions | undefined> =
+  | (T extends {includeMembers: false} ? 'members' : never)
+  | (T extends {includeFeatures: false} ? 'features' : never)
+
 /** @internal */
 export class ObservableProjectsClient {
   #client: ObservableSanityClient
@@ -18,37 +29,31 @@ export 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)
+   *   - `onlyExplicitMembership` - Whether to include only projects with 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'>[]>
-  list(options?: {
-    includeMembers?: boolean
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Observable<SanityProject[] | Omit<SanityProject, 'members'>[]> {
+  list<T extends ListOptions>(
+    options?: T,
+  ): Observable<Omit<SanityProject, OmittedProjectFields<T>>[]> {
     const query: Record<string, string> = {}
     const uri = '/projects'
     if (options?.includeMembers === false) {
       query.includeMembers = 'false'
     }
+    if (options?.includeFeatures === false) {
+      query.includeFeatures = 'false'
+    }
     if (options?.organizationId) {
       query.organizationId = options.organizationId
     }
-    if (options?.onlyExplicitMembership === true) {
+    if (options?.onlyExplicitMembership) {
       query.onlyExplicitMembership = 'true'
     }
 
-    return _request<SanityProject[]>(this.#client, this.#httpRequest, {uri, query})
+    return _request<SanityProject[]>(this.#client, this.#httpRequest, {uri, query}) as Observable<
+      Omit<SanityProject, OmittedProjectFields<T>>[]
+    >
   }
 
   /**
@@ -75,36 +80,32 @@ export 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)
+   *   - `onlyExplicitMembership` - Whether to include only projects with 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'>[]>
-  list(options?: {
-    includeMembers?: boolean
-    organizationId?: string
-    onlyExplicitMembership?: boolean
-  }): Promise<SanityProject[] | Omit<SanityProject, 'members'>[]> {
+  list<T extends ListOptions>(
+    options?: T,
+  ): Promise<Omit<SanityProject, OmittedProjectFields<T>>[]> {
     const query: Record<string, string> = {}
     const uri = '/projects'
     if (options?.includeMembers === false) {
       query.includeMembers = 'false'
     }
+    if (options?.includeFeatures === false) {
+      query.includeFeatures = 'false'
+    }
     if (options?.organizationId) {
       query.organizationId = options.organizationId
     }
-    if (options?.onlyExplicitMembership === true) {
+    if (options?.onlyExplicitMembership) {
       query.onlyExplicitMembership = 'true'
     }
-    return lastValueFrom(_request<SanityProject[]>(this.#client, this.#httpRequest, {uri, query}))
+    return lastValueFrom(
+      _request<SanityProject[]>(this.#client, this.#httpRequest, {uri, query}) as Observable<
+        Omit<SanityProject, OmittedProjectFields<T>>[]
+      >,
+    )
   }
 
   /**

package/src/types.ts

@@ -529,6 +529,7 @@ export interface SanityProject {
   pendingInvites?: number
   maxRetentionDays?: number
   members: SanityProjectMember[]
+  features: string[]
   metadata: {
     cliInitializedAt?: string
     color?: string
@@ -1996,12 +1997,38 @@ export interface VideoRenditionInfoSigned extends VideoRenditionInfoPublic {
 /** @public */
 export type VideoRenditionInfo = VideoRenditionInfoPublic | VideoRenditionInfoSigned
 
+/** @public */
+export 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 interface VideoSubtitleInfoSigned extends VideoSubtitleInfoPublic {
+  /** Authentication token for signed playback */
+  token: string
+  /** Token expiration time in ISO 8601 format */
+  expiresAt: string
+}
+
+/** @public */
+export type VideoSubtitleInfo = VideoSubtitleInfoPublic | VideoSubtitleInfoSigned
+
 /** @public */
 export interface VideoPlaybackInfo<
   T extends VideoPlaybackInfoItem = VideoPlaybackInfoItem,
   R extends VideoRenditionInfo = T extends VideoPlaybackInfoItemSigned
     ? VideoRenditionInfoSigned
     : VideoRenditionInfo,
+  S extends VideoSubtitleInfo = T extends VideoPlaybackInfoItemSigned
+    ? VideoSubtitleInfoSigned
+    : VideoSubtitleInfo,
 > {
   id: string
   thumbnail: T
@@ -2011,6 +2038,7 @@ export interface VideoPlaybackInfo<
   duration: number
   aspectRatio: number
   renditions?: R[]
+  subtitles?: S[]
 }
 
 /** @public */

package/umd/sanityClient.js

@@ -3745,9 +3745,18 @@ ${selectionOpts}`);
     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 === false && (query.includeMembers = "false"), options?.organizationId && (query.organizationId = options.organizationId), options?.onlyExplicitMembership === true && (query.onlyExplicitMembership = "true"), _request(this.#client, this.#httpRequest, { uri, query });
+      return options?.includeMembers === false && (query.includeMembers = "false"), options?.includeFeatures === false && (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
@@ -3764,9 +3773,20 @@ ${selectionOpts}`);
     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 === false && (query.includeMembers = "false"), options?.organizationId && (query.organizationId = options.organizationId), options?.onlyExplicitMembership === true && (query.onlyExplicitMembership = "true"), lastValueFrom(_request(this.#client, this.#httpRequest, { uri, query }));
+      return options?.includeMembers === false && (query.includeMembers = "false"), options?.includeFeatures === false && (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