@sanity/client - npm Package Compare versions

Comparing version 7.19.0 to 7.20.0

package.json

 {
   "name": "@sanity/client",
-  "version": "7.19.0",
+  "version": "7.20.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
@@ -5,0 +5,0 @@ "keywords": [

src/projects/ProjectsClient.ts

@@ -7,2 +7,13 @@ import {lastValueFrom, type Observable} from 'rxjs'
 
+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 */
@@ -22,20 +33,9 @@ export class ObservableProjectsClient {
    *   - `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> = {}
@@ -46,10 +46,15 @@ const uri = '/projects'
     }
+    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>>[]
+    >
   }
@@ -81,20 +86,9 @@
    *   - `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> = {}
@@ -105,9 +99,16 @@ const uri = '/projects'
     }
+    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>>[]
+      >,
+    )
   }
@@ -114,0 +115,0 @@

src/types.ts

@@ -532,2 +532,3 @@ // deno-lint-ignore-file no-empty-interface
   members: SanityProjectMember[]
+  features: string[]
   metadata: {
@@ -534,0 +535,0 @@ cliInitializedAt?: string

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Improved metrics

Total package byte prevSize

4975231

0.17%

Lines of code

58615

0.2%

No dependency changes