support cjs/esm building

.github/workflows/integrity-checks.yml

@@ -36,8 +36,8 @@ jobs:
       - name: Run audit checks
         run: npm audit
 
-      - name: Test compilation
-        run: npm run compile
+      - name: Test build
+        run: npm run build
 
       - name: start containerized dbs
         run: |

.github/workflows/npm-publish.yml

@@ -76,7 +76,7 @@ jobs:
 
       - name: Build all workspace packages
         if: env.IS_LATEST == 'true'
-        run: npm run compile
+        run: npm run build
 
       - name: Publish @tbd54566975/dwn-sql-store@${{ env.REPO_VERSION }}
         if: env.IS_LATEST == 'true'

CODEOWNERS

@@ -9,7 +9,7 @@
 # The format is described: https://github.blog/2017-07-06-introducing-code-owners/
 
 # These owners will be the default owners for everything in the repo.
-* @amika-sq @mistermoe
+* @amika-sq @mistermoe @adam4leos
 
 
 # -----------------------------------------------

README.md

@@ -140,8 +140,10 @@ Docker is used to spin up a local containerized DBs for testing purposes. Docker
 
 | Script                  | Description                                 |
 | ----------------------- | ------------------------------------------- |
-| `npm run compile`       | compiles typescript into ESM JS             |
-| `npm run clean`         | deletes compiled JS                         |
+| `npm run build:esm`    | compiles typescript into ESM JS                                    |
+| `npm run build:cjs`    | compiles typescript into CommonJS                                  |
+| `npm run build`        | compiles typescript into ESM JS & CommonJS                         |
+| `npm run clean`        | deletes compiled JS                                                |
 | `npm run test`          | runs tests.                                 |
 | `npm run test-coverage` | runs tests and includes coverage            |
 | `npm run lint`          | runs linter                                 |

build/create-cjs-bundle.cjs

@@ -0,0 +1,40 @@
+const esbuild = require('esbuild');
+const packageJson = require('../package.json');
+
+// list of dependencies that _dont_ ship cjs
+const includeList = new Set([
+  '@ipld/dag-cbor',
+  '@noble/ed25519',
+  '@noble/secp256k1',
+  'blockstore-core',
+  'ipfs-unixfs-exporter',
+  'ipfs-unixfs-importer',
+  'multiformats',
+  'pg',
+]);
+
+// create list of dependencies that we _do not_ want to include in our bundle
+const excludeList = [];
+for (const dependency in packageJson.dependencies) {
+  if (includeList.has(dependency)) {
+    continue;
+  } else {
+    excludeList.push(dependency);
+  }
+}
+
+/** @type {import('esbuild').BuildOptions} */
+const baseConfig = {
+  platform: 'node',
+  format: 'cjs',
+  bundle: true,
+  external: excludeList,
+};
+
+const indexConfig = {
+  ...baseConfig,
+  entryPoints: ['./dist/esm/src/main.js'],
+  outfile: './dist/cjs/main.js',
+};
+
+esbuild.buildSync(indexConfig);