fix: declare File for envs without lib.dom (#175)

sanity-io · Mar 22, 2023 · 1e9cb5e · 1e9cb5e
1 parent 75064df
commit 1e9cb5e
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 10 deletions.
diff --git a/src/assets/AssetsClient.ts b/src/assets/AssetsClient.ts
@@ -10,6 +10,7 @@ import type {
   ResponseEvent,
   SanityAssetDocument,
   SanityImageAssetDocument,
+  UploadBody,
   UploadClientConfig,
 } from '../types'
 import * as validators from '../validators'
@@ -32,7 +33,7 @@ export class ObservableAssetsClient {
    */
   upload(
     assetType: 'file',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<HttpRequestEvent<{document: SanityAssetDocument}>>
 
@@ -45,7 +46,7 @@ export class ObservableAssetsClient {
    */
   upload(
     assetType: 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<HttpRequestEvent<{document: SanityImageAssetDocument}>>
   /**
@@ -57,12 +58,12 @@ export class ObservableAssetsClient {
    */
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>>
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>> {
     return _upload(this.#client, this.#httpRequest, assetType, body, options)
@@ -87,7 +88,7 @@ export class AssetsClient {
    */
   upload(
     assetType: 'file',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityAssetDocument>
   /**
@@ -99,7 +100,7 @@ export class AssetsClient {
    */
   upload(
     assetType: 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityImageAssetDocument>
   /**
@@ -111,12 +112,12 @@ export class AssetsClient {
    */
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityAssetDocument | SanityImageAssetDocument>
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityAssetDocument | SanityImageAssetDocument> {
     const observable = _upload(this.#client, this.#httpRequest, assetType, body, options)
@@ -137,7 +138,7 @@ function _upload(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
   assetType: 'image' | 'file',
-  body: File | Blob | Buffer | NodeJS.ReadableStream,
+  body: UploadBody,
   opts: UploadClientConfig = {}
 ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>> {
   validators.validateAssetType(assetType)

diff --git a/src/types.ts b/src/types.ts
@@ -1,3 +1,4 @@
+// deno-lint-ignore-file no-empty-interface
 import type {Requester} from 'get-it'
 
 /**
@@ -6,6 +7,14 @@ import type {Requester} from 'get-it'
  */
 export type Any = any // eslint-disable-line @typescript-eslint/no-explicit-any
 
+declare global {
+  // Declare empty stub interfaces for environments where "dom" lib is not included
+  interface File {}
+}
+
+/** @public */
+export type UploadBody = File | Blob | Buffer | NodeJS.ReadableStream
+
 /** @public */
 export interface RequestOptions {
   timeout?: number

diff --git a/test/warnings.test.ts b/test/warnings.test.ts
@@ -19,7 +19,7 @@ describe('Client config warnings', async () => {
     )
   })
 
-  test.skipIf(isEdge)('warns if in browser on localhost and a token is provided', () => {
+  test('warns if in browser on localhost and a token is provided', () => {
     const restoreWindow = global.window
     global.window = {location: {hostname: 'localhost'}} as any
     createClient({projectId: 'abc123', useCdn: false, token: 'foo', apiVersion: '1'})