Improve Exports (#686)

Author: stevensJourney

.changeset/kind-apricots-matter.md

@@ -0,0 +1,7 @@
+---
+'@powersync/drizzle-driver': minor
+'@powersync/kysely-driver': minor
+'@powersync/attachments': minor
+---
+
+Updated package exports to reflect ESM exports. Added CommonJS exports.

.changeset/modern-feet-add.md

@@ -0,0 +1,6 @@
+---
+'@powersync/common': minor
+'@powersync/node': minor
+---
+
+Added CJS specific type declarations.

.changeset/soft-swans-drive.md

@@ -0,0 +1,7 @@
+---
+'@powersync/tanstack-react-query': minor
+'@powersync/react': minor
+'@powersync/vue': minor
+---
+
+Updated package exports to reflect ESM nature.

.changeset/unlucky-singers-clean.md

@@ -0,0 +1,5 @@
+---
+'@powersync/react': minor
+---
+
+Update package exports to reflect ESM exports.

.github/workflows/test-isolated.yaml

@@ -45,6 +45,9 @@ jobs:
       - name: Build Packages
         run: pnpm build:packages
 
+      - name: Test Package Exports
+        run: pnpm test:packages:exports
+
       - name: Start Verdaccio
         run: |
           npm install -g verdaccio

package.json

@@ -20,7 +20,8 @@
     "format": "prettier --write .",
     "lint": "eslint .",
     "release": "pnpm build:packages:prod && pnpm changeset publish",
-    "test": "pnpm run -r --workspace-concurrency=0 test"
+    "test": "pnpm run -r --workspace-concurrency=1 test --run",
+    "test:packages:exports": "pnpm -r --filter {./packages/**} test:exports"
   },
   "keywords": [],
   "type": "module",
@@ -31,15 +32,21 @@
   },
   "devDependencies": {
     "@actions/core": "^1.10.1",
+    "@arethetypeswrong/cli": "^0.18.2",
     "@changesets/cli": "2.27.2",
     "@pnpm/workspace.find-packages": "^4.0.2",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "15.2.3",
+    "@rollup/plugin-typescript": "^12.1.4",
     "@vitest/browser": "^3.2.4",
     "husky": "^9.0.11",
     "lint-staged": "^15.2.2",
     "playwright": "^1.51.0",
     "prettier": "^3.2.5",
     "prettier-plugin-embed": "^0.4.15",
     "prettier-plugin-sql": "^0.18.1",
+    "rollup": "4.14.3",
+    "rollup-plugin-dts": "^6.2.1",
     "typescript": "^5.7.2",
     "vitest": "^3.2.4"
   }

packages/attachments/package.json

@@ -16,17 +16,33 @@
     "url": "https://github.com/powersync-ja/powersync-js/issues"
   },
   "description": "An PowerSync library to manage attachments for TypeScript and React Native apps",
-  "main": "./lib/index.js",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./lib/index.js",
+        "types": "./lib/index.d.ts"
+      },
+      "require": {
+        "default": "./dist/index.cjs",
+        "types": "./dist/index.d.cts"
+      }
+    }
+  },
   "files": [
-    "lib"
+    "lib",
+    "dist"
   ],
   "scripts": {
-    "build": "tsc -b",
-    "build:prod": "tsc -b --sourceMap false",
-    "clean": "rm -rf lib tsconfig.tsbuildinfo node_modules",
+    "build": "tsc -b && rollup --config",
+    "build:prod": "tsc -b --sourceMap false && rollup --config --sourceMap=false",
+    "clean": "rm -rf lib dist tsconfig.tsbuildinfo",
     "watch": "tsc -b -w",
-    "test": "pnpm build && vitest"
+    "test": "pnpm build && vitest",
+    "test:exports": "attw --pack ."
   },
   "peerDependencies": {
     "@powersync/common": "workspace:^1.35.0"

packages/attachments/rollup.config.js

@@ -0,0 +1,40 @@
+import commonjs from '@rollup/plugin-commonjs';
+import resolve from '@rollup/plugin-node-resolve';
+import typescript from '@rollup/plugin-typescript';
+import { dts } from 'rollup-plugin-dts';
+
+/** @type {import('rollup').RollupOptions} */
+export default (commandLineArgs) => {
+  const sourceMap = (commandLineArgs.sourceMap || 'true') == 'true';
+
+  // Clears rollup CLI warning https://github.com/rollup/rollup/issues/2694
+  delete commandLineArgs.sourceMap;
+
+  return [
+    {
+      input: 'src/index.ts',
+      output: {
+        format: 'cjs',
+        file: 'dist/index.cjs',
+        sourcemap: sourceMap,
+        exports: 'named'
+      },
+      plugins: [
+        resolve(),
+        commonjs(),
+        typescript({
+          tsconfig: './tsconfig.json',
+          outDir: 'dist',
+          sourceMap
+        })
+      ],
+      external: ['@powersync/common']
+    },
+    // This is required to avoid https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseESM.md
+    {
+      input: './lib/index.d.ts',
+      output: [{ file: 'dist/index.d.cts', format: 'cjs' }],
+      plugins: [dts()]
+    }
+  ];
+};

packages/attachments/src/AbstractAttachmentQueue.ts

@@ -1,6 +1,6 @@
 import { AbstractPowerSyncDatabase, Transaction } from '@powersync/common';
-import { ATTACHMENT_TABLE, AttachmentRecord, AttachmentState } from './Schema';
-import { EncodingType, StorageAdapter } from './StorageAdapter';
+import { ATTACHMENT_TABLE, AttachmentRecord, AttachmentState } from './Schema.js';
+import { EncodingType, StorageAdapter } from './StorageAdapter.js';
 
 export interface AttachmentQueueOptions {
   powersync: AbstractPowerSyncDatabase;

packages/attachments/src/index.ts

@@ -1,4 +1,4 @@
-export * from './Schema';
-export * from './StorageAdapter';
+export * from './Schema.js';
+export * from './StorageAdapter.js';
 
-export * from './AbstractAttachmentQueue';
+export * from './AbstractAttachmentQueue.js';