@sanity/client 7.0.0 → 7.0.1-canary.1

package/src/assets/AssetsClient.ts

@@ -16,8 +16,104 @@ import type {
 } from '../types'
 import * as validators from '../validators'
 
+/**
+ * The interface implemented by the `ObservableAssetsClient` class.
+ * When writing code that wants to take an instance of `ObservableAssetsClient` as input it's better to use this type,
+ * as the `ObservableAssetsClient` class has private properties and thus TypeScript will consider the type incompatible
+ * in cases where you might have multiple `@sanity/client` instances in your node_modules.
+ * @public
+ */
+export interface ObservableAssetsClientType {
+  /**
+   * Uploads a file asset to the configured dataset
+   *
+   * @param assetType - Asset type (file)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
+   */
+  upload(
+    assetType: 'file',
+    body: UploadBody,
+    options?: UploadClientConfig,
+  ): Observable<HttpRequestEvent<{document: SanityAssetDocument}>>
+
+  /**
+   * Uploads an image asset to the configured dataset
+   *
+   * @param assetType - Asset type (image)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
+   */
+  upload(
+    assetType: 'image',
+    body: UploadBody,
+    options?: UploadClientConfig,
+  ): Observable<HttpRequestEvent<{document: SanityImageAssetDocument}>>
+
+  /**
+   * Uploads a file or an image asset to the configured dataset
+   *
+   * @param assetType - Asset type (file/image)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
+   */
+  upload(
+    assetType: 'file' | 'image',
+    body: UploadBody,
+    options?: UploadClientConfig,
+  ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>>
+}
+
+/**
+ * The interface implemented by the `AssetsClient` class.
+ * When writing code that wants to take an instance of `AssetsClient` as input it's better to use this type,
+ * as the `AssetsClient` class has private properties and thus TypeScript will consider the type incompatible
+ * in cases where you might have multiple `@sanity/client` instances in your node_modules.
+ * @public
+ */
+export interface AssetsClientType {
+  /**
+   * Uploads a file asset to the configured dataset
+   *
+   * @param assetType - Asset type (file)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
+   */
+  upload(
+    assetType: 'file',
+    body: UploadBody,
+    options?: UploadClientConfig,
+  ): Promise<SanityAssetDocument>
+
+  /**
+   * Uploads an image asset to the configured dataset
+   *
+   * @param assetType - Asset type (image)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
+   */
+  upload(
+    assetType: 'image',
+    body: UploadBody,
+    options?: UploadClientConfig,
+  ): Promise<SanityImageAssetDocument>
+
+  /**
+   * Uploads a file or an image asset to the configured dataset
+   *
+   * @param assetType - Asset type (file/image)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
+   */
+  upload(
+    assetType: 'file' | 'image',
+    body: UploadBody,
+    options?: UploadClientConfig,
+  ): Promise<SanityAssetDocument | SanityImageAssetDocument>
+}
+
 /** @internal */
-export class ObservableAssetsClient {
+export class ObservableAssetsClient implements ObservableAssetsClientType {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
@@ -72,7 +168,7 @@ export class ObservableAssetsClient {
 }
 
 /** @internal */
-export class AssetsClient {
+export class AssetsClient implements AssetsClientType {
   #client: SanityClient
   #httpRequest: HttpRequest
   constructor(client: SanityClient, httpRequest: HttpRequest) {

package/umd/sanityClient.js

@@ -3291,14 +3291,8 @@ ${selectionOpts}`);
     live;
     projects;
     users;
-    /**
-     * Private properties
-     */
     #clientConfig;
     #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.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest);
@@ -3444,14 +3438,8 @@ ${selectionOpts}`);
      * Observable version of the Sanity client, with the same configuration as the promise-based one
      */
     observable;
-    /**
-     * Private properties
-     */
     #clientConfig;
     #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.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
@@ -3548,8 +3536,8 @@ ${selectionOpts}`);
      * @param operations - Optional object of patch operations to initialize the patch instance with
      * @returns Patch instance - call `.commit()` to perform the operations defined
      */
-    patch(documentId, operations) {
-      return new Patch(documentId, operations, this);
+    patch(selection, operations) {
+      return new Patch(selection, operations, this);
     }
     /**
      * Create a new transaction of mutations