Updates

Author: cmdcolin

package.json

@@ -3,18 +3,9 @@
   "description": "uniform interface for accessing binary data from local files, remote HTTP resources, and browser Blob data",
   "version": "2.0.3",
   "type": "module",
+  "module": "./esm/index.js",
   "main": "./esm/index.js",
-  "exports": {
-    ".": {
-      "import": "./esm/index.js",
-      "require": "./dist/index.js"
-    },
-    "./localFile.js": {
-      "import": "./esm/localFile.js",
-      "require": "./dist/localFile.js",
-      "browser": null
-    }
-  },
+  "exports": "./esm/index.js",
   "repository": "GMOD/generic-filehandle2",
   "license": "MIT",
   "author": {
@@ -26,16 +17,20 @@
     "node": ">=14"
   },
   "files": [
+    "dist",
     "esm",
     "src"
   ],
   "scripts": {
     "test": "vitest",
     "coverage": "yarn test --coverage",
     "lint": "eslint --report-unused-disable-directives --max-warnings 0 src test",
-    "clean": "rimraf esm",
+    "clean": "rimraf dist esm",
     "prebuild": "yarn clean",
-    "build": "tsc --outDir esm",
+    "build:esm": "tsc --outDir esm",
+    "build:es5": "tsc --module commonjs --outDir dist",
+    "build": "yarn build:esm && yarn build:es5",
+    "postbuild:es5": "echo '{\"type\": \"commonjs\"}' > dist/package.json",
     "preversion": "yarn lint && yarn test --run && yarn build",
     "postversion": "git push --follow-tags"
   },
@@ -63,5 +58,11 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "browser": {
+    "./dist/localFile.js": false,
+    "./esm/localFile.js": false,
+    "fs": false,
+    "fs/promises": false
   }
 }

src/mockLocalFile.ts

@@ -0,0 +1,40 @@
+import type { FilehandleOptions, GenericFilehandle, Stats } from './filehandle'
+
+export default class LocalFile implements GenericFilehandle {
+  public constructor(_source: string, _opts: FilehandleOptions = {}) {
+    throw new Error('unimplemented')
+  }
+
+  read(): Promise<Uint8Array<ArrayBuffer>> {
+    throw new Error('unimplemented')
+  }
+
+  public async readFile(): Promise<Uint8Array<ArrayBuffer>>
+  public async readFile(options: BufferEncoding): Promise<string>
+  public async readFile<T extends undefined>(
+    options:
+      | Omit<FilehandleOptions, 'encoding'>
+      | (Omit<FilehandleOptions, 'encoding'> & { encoding: T }),
+  ): Promise<Uint8Array<ArrayBuffer>>
+  public async readFile<T extends BufferEncoding>(
+    options: Omit<FilehandleOptions, 'encoding'> & { encoding: T },
+  ): Promise<string>
+  readFile<T extends BufferEncoding>(
+    options: Omit<FilehandleOptions, 'encoding'> & { encoding: T },
+  ): T extends BufferEncoding
+    ? Promise<Uint8Array<ArrayBuffer>>
+    : Promise<Uint8Array<ArrayBuffer> | string>
+  public async readFile(
+    _options: FilehandleOptions | BufferEncoding = {},
+  ): Promise<Uint8Array<ArrayBuffer> | string> {
+    throw new Error('unimplemented')
+  }
+
+  stat(): Promise<Stats> {
+    throw new Error('unimplemented')
+  }
+
+  close(): Promise<void> {
+    throw new Error('unimplemented')
+  }
+}

test/remoteFile.test.ts

@@ -1,7 +1,7 @@
 import { TextDecoder } from 'util'
 
 import rangeParser from 'range-parser'
-import { beforeEach, afterEach, expect, test, vi } from 'vitest'
+import { afterEach, beforeEach, expect, test, vi } from 'vitest'
 
 import { LocalFile, RemoteFile } from '../src/'
 

yarn.lock

@@ -2825,9 +2825,9 @@ tinyexec@^0.3.2:
   integrity sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==
 
 tinyglobby@^0.2.13:
-  version "0.2.13"
-  resolved "https://registry.yarnpkg.com/tinyglobby/-/tinyglobby-0.2.13.tgz#a0e46515ce6cbcd65331537e57484af5a7b2ff7e"
-  integrity sha512-mEwzpUgrLySlveBwEVDMKk5B57bhLPYovRfPAXD5gA/98Opn0rCDj3GtLwFvCvH5RK9uPCExUROW5NjDwvqkxw==
+  version "0.2.14"
+  resolved "https://registry.yarnpkg.com/tinyglobby/-/tinyglobby-0.2.14.tgz#5280b0cf3f972b050e74ae88406c0a6a58f4079d"
+  integrity sha512-tX5e7OM1HnYr2+a2C/4V0htOcSQcoSTH9KgJnVvNm5zm/cyEWKJ7j7YutsH9CxMdtOkkLFy2AHrMci9IM8IPZQ==
   dependencies:
     fdir "^6.4.4"
     picomatch "^4.0.2"