convert to TS

Author: bencmbrook

.prettierignore

@@ -9,4 +9,5 @@ LICENSE
 .browserslistrc
 fixtures/files
 example/files.js
-pnpm-lock.yaml
+pnpm-lock.yaml
+test/fixtures.json

README.md

@@ -1,18 +1,13 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-## Table of Contents
-
 - [Conflux](#conflux)
   - [Blazing Fast](#blazing-fast)
   - [Compatibility](#compatibility)
   - [Examples](#examples)
   - [Usage](#usage)
     - [Importing Conflux](#importing-conflux)
     - [Creating a ZIP](#creating-a-zip)
-      - [Example using `ReadableStream#pipeThrough`](#example-using-readablestreampipethrough)
-      - [Example using `writer.write`](#example-using-writerwrite)
-      - [Incorporating other streams](#incorporating-other-streams)
     - [Reading ZIP files](#reading-zip-files)
   - [Supporting Legacy Browsers](#supporting-legacy-browsers)
   - [License](#license)

eslint.config.js

@@ -31,6 +31,7 @@ const eslintConfig = tseslint.config(
       ],
       'unicorn/no-null': 'off',
       'unicorn/no-nested-ternary': 'off',
+      'unicorn/number-literal-case': 'off',
       '@typescript-eslint/no-unnecessary-condition': [
         'error',
         {

knip.config.ts

@@ -1,20 +1,9 @@
 import type { KnipConfig } from 'knip';
 
 const config: KnipConfig = {
-  entry: [
-    'src/index.ts!',
-    'src/api.ts!', // knip needs a little help getting past the actual entrypoint
-    'src/worker.penumbra.ts!',
-    'tests/*.test.ts',
-    'web-test-runner.config.js',
-  ],
-  project: ['src/**', 'fixtures/**', 'tests/**'],
-  ignore: [
-    // Vendored third-party library has some unused exports
-    'src/utils/brand.ts',
-    'src/**/*.d.ts',
-  ],
-  ignoreDependencies: ['@web/test-runner-playwright'],
+  entry: ['src/index.ts!', 'test/**/*.test.ts', 'web-test-runner.config.js'],
+  project: ['src/**/*.ts', 'test/**/*.ts'],
+  ignoreDependencies: ['@web/test-runner-playwright', 'tsx'],
   // Bypass unlisted binaries "scripts/postbuild.ts package.json"]
   exclude: ['binaries'],
 };

package.json

@@ -8,17 +8,17 @@
   "unpkg": "dist/conflux.umd.min.js",
   "browser": "dist/conflux.esm.js",
   "module": "dist/conflux.esm.js",
+  "types": "dist/types/index.d.ts",
   "scripts": {
-    "build": "rollup -c --bundleConfigAsCjs",
-    "test": "scripts/run-tests.sh",
-    "test:chromium": "scripts/run-tests.sh --browsers chromium",
+    "build": "rollup --config rollup.config.ts --configPlugin typescript",
+    "test": "pnpm exec web-test-runner --files test/**/*.test.ts --node-resolve --playwright --coverage --browsers chromium firefox webkit",
     "lint": "pnpm run \"/^lint:.*/\"",
     "lint:prettier": "prettier --check . --log-level warn",
     "lint:eslint": "eslint .",
     "lint:types": "tsc --build",
     "lint:knip": "knip",
     "format": "prettier --write . --log-level warn && doctoc README.md --maxlevel 3",
-    "rebuild-fixtures": "tsx test/build.js",
+    "rebuild-fixtures": "tsx scripts/rebuild-fixtures.ts",
     "prepublishOnly": "pnpm lint && pnpm run build"
   },
   "repository": {
@@ -69,9 +69,11 @@
     "@eslint/js": "^9.32.0",
     "@esm-bundle/chai": "4.3.4-fix.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^12.1.4",
     "@tsconfig/strictest": "^2.0.5",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.17.1",
+    "@types/pako": "^2.0.3",
     "@web/dev-server-esbuild": "^1.0.4",
     "@web/test-runner": "^0.20.2",
     "@web/test-runner-playwright": "^0.11.1",

pnpm-lock.yaml

@@ -1,19 +1,21 @@
-import resolve from '@rollup/plugin-node-resolve';
-import pkg from './package.json' with { type: 'json' };
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import typescript from '@rollup/plugin-typescript';
+import packageJson from './package.json' with { type: 'json' };
 
 export default [
   // browser-friendly UMD build
   {
-    input: 'src/index.js',
+    input: 'src/index.ts',
     output: [
       {
         name: 'conflux',
-        file: pkg.main,
+        file: packageJson.main,
         format: 'umd',
       },
     ],
     plugins: [
-      resolve(), // so Rollup can find package dependencies
+      nodeResolve(), // so Rollup can find package dependencies
+      typescript(),
     ],
   },
 
@@ -24,11 +26,12 @@ export default [
   // an array for the `output` option, where we can specify
   // `file` and `format` for each target)
   {
-    input: 'src/index.js',
+    input: 'src/index.ts',
     external: [/pako/],
     output: [
       // { file: pkg.main, format: 'cjs' }, // don't need a Node import yet
-      { file: pkg.module, format: 'es' },
+      { file: packageJson.module, format: 'es' },
     ],
+    plugins: [typescript()],
   },
 ];

rollup.config.js rollup.config.tsrollup.config.js renamed to rollup.config.ts

@@ -0,0 +1,20 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import jsonBinaryBlobCodec from '../test/json-binary-blob-codec.js';
+
+const { replacer } = jsonBinaryBlobCodec;
+
+const pathname = new URL(import.meta.url).pathname;
+const __dirname = path.dirname(pathname);
+
+const files = await fs.readdir(path.resolve(__dirname, '../test/fixture'));
+const fixtures: Record<string, Uint8Array> = {};
+for (const file of files) {
+  if (file.endsWith('.zip') || file.endsWith('.gif')) {
+    fixtures[file] = new Uint8Array(
+      await fs.readFile(path.resolve(__dirname, '../test/fixture', file)),
+    );
+  }
+}
+const replaced = JSON.stringify(fixtures, replacer, 2);
+await fs.writeFile(path.resolve(__dirname, '../test/fixtures.json'), replaced);

scripts/rebuild-fixtures.ts

@@ -0,0 +1,70 @@
+const jsbiShim = {
+  // constructor
+  BigInt: BigInt,
+
+  // note: JSBI toString is already the same: a.toString()
+  toNumber: Number,
+
+  // binary functions to expressions
+  add: (a: bigint, b: bigint) => a + b,
+  subtract: (a: bigint, b: bigint) => a - b,
+  multiply: (a: bigint, b: bigint) => a * b,
+  divide: (a: bigint, b: bigint) => a / b,
+  remainder: (a: bigint, b: bigint) => a % b,
+  exponentiate: (a: bigint, b: bigint) => a ** b,
+  leftShift: (a: bigint, b: bigint) => a << b,
+  signedRightShift: (a: bigint, b: bigint) => a >> b,
+  bitwiseAnd: (a: bigint, b: bigint) => a & b,
+  bitwiseOr: (a: bigint, b: bigint) => a | b,
+  bitwiseXor: (a: bigint, b: bigint) => a ^ b,
+  equal: (a: bigint, b: bigint) => a === b,
+  notEqual: (a: bigint, b: bigint) => a !== b,
+  lessThan: (a: bigint, b: bigint) => a < b,
+  lessThanOrEqual: (a: bigint, b: bigint) => a <= b,
+  greaterThan: (a: bigint, b: bigint) => a > b,
+  greaterThanOrEqual: (a: bigint, b: bigint) => a >= b,
+  EQ: (a: bigint, b: bigint) => a == b,
+  NE: (a: bigint, b: bigint) => a != b,
+  LT: (a: bigint, b: bigint) => a < b,
+  LE: (a: bigint, b: bigint) => a <= b,
+  GT: (a: bigint, b: bigint) => a > b,
+  GE: (a: bigint, b: bigint) => a >= b,
+  ADD: (a: bigint, b: bigint) => a + b,
+
+  // unary functions to expressions
+  unaryMinus: (a: bigint) => -a,
+  bitwiseNot: (a: bigint) => ~a,
+
+  // static methods
+  asIntN: (a: number, b: bigint) => BigInt.asIntN(a, b),
+  asUintN: (a: number, b: bigint) => BigInt.asUintN(a, b),
+};
+
+type JSBI = typeof jsbiShim;
+
+declare global {
+  interface Window {
+    JSBI?: JSBI;
+  }
+}
+
+if (!(self.BigInt as unknown) && !self.JSBI) {
+  throw new Error(
+    'BigInt is not supported in this browser.' +
+      ' Conflux is unable to create zip files without BigInt support, or a JSBI polyfill.',
+  );
+}
+
+/**
+ * Use JSBI syntax for BigInt operations, instead of calling BigInt directly.
+ *
+ * This is NOT a polyfill. It uses native BigInt by default. Using this syntax simply makes it _possible_ to polyfill BigInt.
+ * If BigInt is not natively supported (ES2020+), library consumer MUST expose globalThis.JSBI before using Conflux.
+ *
+ * @see https://github.com/GoogleChromeLabs/jsbi - JSBI library for why BigInt
+ * @see https://github.com/GoogleChromeLabs/jsbi/blob/master/jsbi.d.ts - types
+ */
+const jsbi: JSBI =
+  !(self.BigInt as unknown) && self.JSBI ? self.JSBI : jsbiShim;
+
+export default jsbi;