Merge pull request #302 from powersync-ja/common-cjs

NodeJS support for @powersync/common

Author: rkistner

.changeset/tough-impalas-confess.md

@@ -0,0 +1,5 @@
+---
+'@powersync/common': minor
+---
+
+Correctly identify @powersync/common as an ES module

.gitignore

@@ -1,7 +1,7 @@
 node_modules
 lib
 dist
-tsconfig.tsbuildinfo
+*.tsbuildinfo
 .vscode
 .DS_STORE
 .idea

packages/common/package.json

@@ -6,8 +6,17 @@
     "access": "public"
   },
   "description": "API definitions for JourneyApps PowerSync",
-  "main": "dist/index.js",
+  "type": "module",
+  "main": "dist/bundle.mjs",
+  "module": "dist/bundle.mjs",
   "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/bundle.mjs",
+      "default": "./dist/bundle.mjs",
+      "types": "./lib/index.d.ts"
+    }
+  },
   "author": "JOURNEYAPPS",
   "license": "Apache-2.0",
   "files": [
@@ -24,7 +33,7 @@
   "homepage": "https://docs.powersync.com",
   "scripts": {
     "build": "tsc -b && rollup -c rollup.config.mjs",
-    "clean": "rm -rf lib tsconfig.tsbuildinfo dist",
+    "clean": "rm -rf lib dist tsconfig.tsbuildinfo",
     "test": "vitest"
   },
   "dependencies": {

packages/common/rollup.config.mjs

@@ -13,7 +13,7 @@ export default (commandLineArgs) => {
   return {
     input: 'lib/index.js',
     output: {
-      file: 'dist/index.js',
+      file: 'dist/bundle.mjs',
       format: 'esm',
       sourcemap: sourcemap
     },

packages/common/src/client/AbstractPowerSyncDatabase.ts

@@ -8,26 +8,26 @@ import {
   Transaction,
   UpdateNotification,
   isBatchedUpdateNotification
-} from '../db/DBAdapter';
-import { SyncStatus } from '../db/crud/SyncStatus';
-import { UploadQueueStats } from '../db/crud/UploadQueueStatus';
-import { Schema } from '../db/schema/Schema';
-import { BaseObserver } from '../utils/BaseObserver';
-import { ControlledExecutor } from '../utils/ControlledExecutor';
-import { mutexRunExclusive } from '../utils/mutex';
+} from '../db/DBAdapter.js';
+import { SyncStatus } from '../db/crud/SyncStatus.js';
+import { UploadQueueStats } from '../db/crud/UploadQueueStatus.js';
+import { Schema } from '../db/schema/Schema.js';
+import { BaseObserver } from '../utils/BaseObserver.js';
+import { ControlledExecutor } from '../utils/ControlledExecutor.js';
+import { mutexRunExclusive } from '../utils/mutex.js';
 import { throttleTrailing } from '../utils/throttle.js';
-import { SQLOpenFactory, SQLOpenOptions, isDBAdapter, isSQLOpenFactory, isSQLOpenOptions } from './SQLOpenFactory';
-import { PowerSyncBackendConnector } from './connection/PowerSyncBackendConnector';
-import { BucketStorageAdapter, PSInternalTable } from './sync/bucket/BucketStorageAdapter';
-import { CrudBatch } from './sync/bucket/CrudBatch';
-import { CrudEntry, CrudEntryJSON } from './sync/bucket/CrudEntry';
-import { CrudTransaction } from './sync/bucket/CrudTransaction';
+import { SQLOpenFactory, SQLOpenOptions, isDBAdapter, isSQLOpenFactory, isSQLOpenOptions } from './SQLOpenFactory.js';
+import { PowerSyncBackendConnector } from './connection/PowerSyncBackendConnector.js';
+import { BucketStorageAdapter, PSInternalTable } from './sync/bucket/BucketStorageAdapter.js';
+import { CrudBatch } from './sync/bucket/CrudBatch.js';
+import { CrudEntry, CrudEntryJSON } from './sync/bucket/CrudEntry.js';
+import { CrudTransaction } from './sync/bucket/CrudTransaction.js';
 import {
   DEFAULT_CRUD_UPLOAD_THROTTLE_MS,
   PowerSyncConnectionOptions,
   StreamingSyncImplementation,
   StreamingSyncImplementationListener
-} from './sync/stream/AbstractStreamingSyncImplementation';
+} from './sync/stream/AbstractStreamingSyncImplementation.js';
 
 export interface DisconnectAndClearOptions {
   /** When set to false, data in local-only tables is preserved. */

packages/common/src/client/AbstractPowerSyncOpenFactory.ts

@@ -1,8 +1,8 @@
 import Logger from 'js-logger';
-import { DBAdapter } from '../db/DBAdapter';
-import { Schema } from '../db/schema/Schema';
-import { AbstractPowerSyncDatabase, PowerSyncDatabaseOptions } from './AbstractPowerSyncDatabase';
-import { SQLOpenOptions } from './SQLOpenFactory';
+import { DBAdapter } from '../db/DBAdapter.js';
+import { Schema } from '../db/schema/Schema.js';
+import { AbstractPowerSyncDatabase, PowerSyncDatabaseOptions } from './AbstractPowerSyncDatabase.js';
+import { SQLOpenOptions } from './SQLOpenFactory.js';
 
 export interface PowerSyncOpenFactoryOptions extends Partial<PowerSyncDatabaseOptions>, SQLOpenOptions {
   /** Schema used for the local database. */

packages/common/src/client/SQLOpenFactory.ts

@@ -1,4 +1,4 @@
-import { DBAdapter } from '../db/DBAdapter';
+import { DBAdapter } from '../db/DBAdapter.js';
 
 export interface SQLOpenOptions {
   /**

packages/common/src/client/connection/PowerSyncBackendConnector.ts

@@ -1,5 +1,5 @@
-import { PowerSyncCredentials } from './PowerSyncCredentials';
-import type { AbstractPowerSyncDatabase } from '../AbstractPowerSyncDatabase';
+import { PowerSyncCredentials } from './PowerSyncCredentials.js';
+import type { AbstractPowerSyncDatabase } from '../AbstractPowerSyncDatabase.js';
 
 export interface PowerSyncBackendConnector {
   /** Allows the PowerSync client to retrieve an authentication token from your backend

packages/common/src/client/sync/bucket/BucketStorageAdapter.ts

@@ -1,7 +1,7 @@
-import { BaseListener, BaseObserver, Disposable } from '../../../utils/BaseObserver';
-import { CrudBatch } from './CrudBatch';
-import { CrudEntry, OpId } from './CrudEntry';
-import { SyncDataBatch } from './SyncDataBatch';
+import { BaseListener, BaseObserver, Disposable } from '../../../utils/BaseObserver.js';
+import { CrudBatch } from './CrudBatch.js';
+import { CrudEntry, OpId } from './CrudEntry.js';
+import { SyncDataBatch } from './SyncDataBatch.js';
 
 export interface Checkpoint {
   last_op_id: OpId;

packages/common/src/client/sync/bucket/CrudBatch.ts

@@ -1,4 +1,4 @@
-import { CrudEntry } from './CrudEntry';
+import { CrudEntry } from './CrudEntry.js';
 
 /**
  * A batch of client-side changes.