[WIP] Fix ES module native support

.github/workflows/main.yml

@@ -35,6 +35,9 @@ jobs:
           RUNNING_IN_CI: true
         run: pnpm test
 
+      - name: Test ESM and CJS consumers
+        run: pnpm test:esm-consumer && pnpm test:cjs-consumer
+
       - name: Check examples & demos
         run: pnpm check-examples
 

package.json

@@ -2,7 +2,7 @@
   "name": "monorepo",
   "private": true,
   "license": "GPL-3.0-only",
-  "author": "Piotr Roslaniec <p.roslaniec@gmail.com>",
+  "author": "NuCypher <dev@nucypher.com>",
   "scripts": {
     "postinstall": "pnpm build",
     "typedoc": "typedoc",
@@ -12,9 +12,11 @@
     "lint": "pnpm run --parallel --aggregate-output --reporter append-only lint",
     "lint:fix": "pnpm --parallel --aggregate-output --reporter append-only lint:fix",
     "type-check": "pnpm --parallel --aggregate-output --reporter append-only type-check",
-    "build": "tsc --build --verbose ./tsconfig.prod.json",
+    "build": "tsc --build --verbose ./tsconfig.prod.json && node scripts/fix-dist-markers.cjs",
     "watch": "tsc --build --verbose --watch ./tsconfig.prod.json",
     "test": "pnpm build && vitest run",
+    "test:esm-consumer": "node scripts/test-consumer.cjs esm",
+    "test:cjs-consumer": "node scripts/test-consumer.cjs cjs",
     "package:check": "pnpm run --parallel --aggregate-output --reporter append-only --filter './packages/**' package-check",
     "packages:lint": "pnpm packages:sort --check",
     "packages:sort": "sort-package-json \"package.json\" \"examples/*/package.json\" \"packages/*/package.json\"",

packages/pre/.eslintrc.cjs

@@ -0,0 +1,5 @@
+const baseConfig = require('../../.eslintrc.cjs');
+
+module.exports = {
+  ...baseConfig,
+};

packages/pre/package.json

@@ -11,11 +11,17 @@
     "url": "https://github.com/nucypher/taco-web"
   },
   "license": "GPL-3.0-only",
-  "author": "Piotr Roslaniec <p.roslaniec@gmail.com>",
+  "author": "NuCypher <dev@nucypher.com>",
   "exports": {
     ".": {
-      "import": "./dist/es/index.js",
-      "require": "./dist/cjs/index.js"
+      "import": {
+        "types": "./dist/es/index.d.ts",
+        "default": "./dist/es/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
   "main": "./dist/cjs/index.js",
@@ -26,7 +32,8 @@
   ],
   "scripts": {
     "prebuild": "pnpm clean",
-    "build": "pnpm build:module && pnpm build:cjs",
+    "build": "pnpm build:module && pnpm build:cjs && pnpm postbuild",
+    "postbuild": "node ../../scripts/fix-dist-markers.cjs .",
     "build:cjs": "tsc --build ./tsconfig.cjs.json --verbose",
     "build:module": "tsc --build ./tsconfig.es.json --verbose",
     "clean": "rm -rf dist",

packages/pre/src/characters/alice.ts

@@ -7,15 +7,15 @@ import {
 import { ChecksumAddress, Domain, PorterClient } from '@nucypher/shared';
 import { ethers } from 'ethers';
 
-import { Keyring } from '../keyring';
+import { Keyring } from '../keyring.js';
 import {
   BlockchainPolicy,
   BlockchainPolicyParameters,
   EnactedPolicy,
   PreEnactedPolicy,
-} from '../policy';
+} from '../policy.js';
 
-import { RemoteBob } from './bob';
+import { RemoteBob } from './bob.js';
 
 export class Alice {
   private readonly keyring: Keyring;

packages/pre/src/characters/bob.ts

@@ -7,8 +7,8 @@ import {
 } from '@nucypher/nucypher-core';
 import { ChecksumAddress, PorterClient, zip } from '@nucypher/shared';
 
-import { Keyring } from '../keyring';
-import { PolicyMessageKit, RetrievalResult } from '../kits';
+import { Keyring } from '../keyring.js';
+import { PolicyMessageKit, RetrievalResult } from '../kits/index.js';
 
 export class RemoteBob {
   private constructor(

packages/pre/src/characters/enrico.ts

@@ -1,7 +1,7 @@
 import { MessageKit, PublicKey, SecretKey } from '@nucypher/nucypher-core';
 import { toBytes } from '@nucypher/shared';
 
-import { Keyring } from '../keyring';
+import { Keyring } from '../keyring.js';
 
 export class Enrico {
   public readonly encryptingKey: PublicKey;

packages/pre/src/characters/index.ts

@@ -1,3 +1,3 @@
-export * from './alice';
-export * from './bob';
-export * from './enrico';
+export * from './alice.js';
+export * from './bob.js';
+export * from './enrico.js';

packages/pre/src/index.ts

@@ -17,6 +17,6 @@ export {
   toHexString,
 } from '@nucypher/shared';
 
-export { Alice, Bob, Enrico } from './characters';
-export { Cohort } from './cohort';
-export { EnactedPolicy } from './policy';
+export { Alice, Bob, Enrico } from './characters/index.js';
+export { Cohort } from './cohort.js';
+export { EnactedPolicy } from './policy.js';

packages/pre/src/keyring.ts

@@ -9,7 +9,7 @@ import {
 } from '@nucypher/nucypher-core';
 import { toBytes } from '@nucypher/shared';
 
-import { PolicyMessageKit } from './kits';
+import { PolicyMessageKit } from './kits/index.js';
 
 export class Keyring {
   constructor(public readonly secretKey: SecretKey) {}

packages/pre/src/kits/index.ts

@@ -1,2 +1,2 @@
-export * from './message';
-export * from './retrieval';
+export * from './message.js';
+export * from './retrieval.js';

packages/pre/src/kits/message.ts

@@ -7,7 +7,7 @@ import {
 } from '@nucypher/nucypher-core';
 import { ChecksumAddress } from '@nucypher/shared';
 
-import { RetrievalResult } from './retrieval';
+import { RetrievalResult } from './retrieval.js';
 
 export class PolicyMessageKit {
   constructor(

packages/pre/src/policy.ts

@@ -18,7 +18,7 @@ import {
 } from '@nucypher/shared';
 import { ethers } from 'ethers';
 
-import { Alice, RemoteBob } from './characters';
+import { Alice, RemoteBob } from './characters/index.js';
 
 export type EnactedPolicy = {
   readonly id: HRAC;

packages/pre/test/acceptance/alice-grants.test.ts

@@ -17,7 +17,7 @@ import {
 } from '@nucypher/test-utils';
 import { beforeEach, describe, expect, it } from 'vitest';
 
-import { EnactedPolicy, Enrico, toBytes } from '../../src';
+import { EnactedPolicy, Enrico, toBytes } from '../../src/index.js';
 import {
   fakeAlice,
   fakeBob,
@@ -27,7 +27,7 @@ import {
   mockMakeTreasureMap,
   mockPublishToBlockchain,
   reencryptKFrags,
-} from '../utils';
+} from '../utils.js';
 
 describe('story: alice shares message with bob through policy', () => {
   const message = 'secret-message-from-alice';

packages/pre/test/acceptance/delay-enact.test.ts

@@ -7,14 +7,14 @@ import {
 } from '@nucypher/test-utils';
 import { beforeAll, describe, expect, it } from 'vitest';
 
-import { domains, initialize } from '../../src';
+import { domains, initialize } from '../../src/index.js';
 import {
   fakeAlice,
   fakeRemoteBob,
   mockEncryptTreasureMap,
   mockGenerateKFrags,
   mockPublishToBlockchain,
-} from '../utils';
+} from '../utils.js';
 
 describe('story: alice creates a policy but someone else enacts it', () => {
   const threshold = 2;

packages/pre/test/cohort.test.ts

@@ -2,9 +2,9 @@ import { initialize } from '@nucypher/shared';
 import { fakeUrsulas } from '@nucypher/test-utils';
 import { beforeAll, describe, expect, it } from 'vitest';
 
-import { Cohort } from '../src';
+import { Cohort } from '../src/index.js';
 
-import { makeCohort } from './utils';
+import { makeCohort } from './utils.js';
 
 describe('Cohort', () => {
   beforeAll(async () => {

packages/pre/test/enrico.test.ts

@@ -3,10 +3,10 @@
 import { bytesEqual, fromBytes } from '@nucypher/test-utils';
 import { beforeAll, describe, expect, it } from 'vitest';
 
-import { Enrico, initialize, toBytes } from '../src';
-import { PolicyMessageKit, RetrievalResult } from '../src/kits';
+import { Enrico, initialize, toBytes } from '../src/index.js';
+import { PolicyMessageKit, RetrievalResult } from '../src/kits/index.js';
 
-import { fakeAlice, fakeBob, reencryptKFrags } from './utils';
+import { fakeAlice, fakeBob, reencryptKFrags } from './utils.js';
 
 describe('enrico', () => {
   beforeAll(async () => {

packages/pre/test/message-kit.test.ts

@@ -1,8 +1,8 @@
 import { beforeAll, describe, expect, it } from 'vitest';
 
-import { initialize, MessageKit, toBytes } from '../src';
+import { initialize, MessageKit, toBytes } from '../src/index.js';
 
-import { fakeBob } from './utils';
+import { fakeBob } from './utils.js';
 
 describe('message kit', () => {
   beforeAll(async () => {

packages/pre/test/pre.test.ts

@@ -3,10 +3,10 @@ import { zip } from '@nucypher/shared';
 import { fakeUrsulas } from '@nucypher/test-utils';
 import { beforeAll, describe, expect, it } from 'vitest';
 
-import { Alice, Bob, Enrico, MessageKit, toBytes } from '../src';
-import { PolicyMessageKit, RetrievalResult } from '../src/kits';
+import { Alice, Bob, Enrico, MessageKit, toBytes } from '../src/index.js';
+import { PolicyMessageKit, RetrievalResult } from '../src/kits/index.js';
 
-import { fakeAlice, fakeBob, reencryptKFrags } from './utils';
+import { fakeAlice, fakeBob, reencryptKFrags } from './utils.js';
 
 describe('proxy reencryption', () => {
   let alice: Alice;

packages/pre/test/utils.ts

@@ -16,9 +16,9 @@ import { Ursula } from '@nucypher/shared';
 import { fakeUrsulas, mockGetUrsulas } from '@nucypher/test-utils';
 import { expect, MockInstance, vi } from 'vitest';
 
-import { Alice, Bob, Cohort, toBytes } from '../src';
-import { RemoteBob } from '../src/characters';
-import { BlockchainPolicy, PreEnactedPolicy } from '../src/policy';
+import { RemoteBob } from '../src/characters/index.js';
+import { Alice, Bob, Cohort, toBytes } from '../src/index.js';
+import { BlockchainPolicy, PreEnactedPolicy } from '../src/policy.js';
 
 export const fakeBob = (): Bob => {
   const secretKey = SecretKey.fromBEBytes(

packages/pre/tsconfig.cjs.json

@@ -2,6 +2,7 @@
   "extends": "./tsconfig.es.json",
   "compilerOptions": {
     "outDir": "dist/cjs",
-    "module": "CommonJS"
+    "module": "CommonJS",
+    "moduleResolution": "node"
   }
 }

packages/pre/tsconfig.es.json

@@ -5,6 +5,7 @@
     "outDir": "dist/es",
     "rootDir": "src",
     "module": "ES2022",
+    "moduleResolution": "Bundler",
     "target": "ES2022"
   }
 }

packages/shared/.eslintrc.cjs

@@ -0,0 +1,5 @@
+const baseConfig = require('../../.eslintrc.cjs');
+
+module.exports = {
+  ...baseConfig,
+};

packages/shared/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nucypher/shared",
-  "version": "0.6.0-alpha.12",
+  "version": "0.6.0-dev.es",
   "keywords": [
     "pre",
     "taco",
@@ -15,8 +15,14 @@
   "author": "NuCypher <dev@nucypher.com>",
   "exports": {
     ".": {
-      "import": "./dist/es/index.js",
-      "require": "./dist/cjs/index.js"
+      "import": {
+        "types": "./dist/es/index.d.ts",
+        "default": "./dist/es/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
   "main": "./dist/cjs/index.js",
@@ -27,7 +33,8 @@
   ],
   "scripts": {
     "prebuild": "pnpm typechain && pnpm clean",
-    "build": "pnpm build:module && pnpm build:cjs",
+    "build": "pnpm build:module && pnpm build:cjs && pnpm postbuild",
+    "postbuild": "node ../../scripts/fix-dist-markers.cjs .",
     "build:cjs": "tsc --build ./tsconfig.cjs.json --verbose",
     "build:module": "tsc --build ./tsconfig.es.json --verbose",
     "clean": "rm -rf dist",