chore(treewide): natively support CommonJS (#334)

Co-authored-by: lukasIO <mail@lukasseiler.de>

.changeset/brave-terms-pretend.md

@@ -0,0 +1,6 @@
+---
+"@livekit/rtc-node": minor
+"livekit-server-sdk": minor
+---
+
+natively support CommonJS

REUSE.toml

@@ -21,7 +21,7 @@ SPDX-License-Identifier = "Apache-2.0"
 
 # project configuration files
 [[annotations]]
-path = ["packages/livekit-rtc/.npmignore", ".prettierrc", ".prettierignore", ".eslintrc", "**.json", ".npmrc"]
+path = ["packages/livekit-rtc/.npmignore", ".prettierrc", ".prettierignore", ".eslintrc", "**.json", ".npmrc", "**/tsup.config.ts"]
 SPDX-FileCopyrightText = "2024 LiveKit, Inc."
 SPDX-License-Identifier = "Apache-2.0"
 

examples/agent-dispatch/package.json

@@ -14,7 +14,7 @@
   "dependencies": {
     "dotenv": "^16.4.5",
     "livekit-server-sdk": "workspace:*",
-    "@livekit/protocol": "^1.27.1"
+    "@livekit/protocol": "^1.28.0"
   },
   "devDependencies": {
     "@types/node": "^20.10.4",

packages/livekit-rtc/package.json

@@ -5,7 +5,15 @@
   "author": "LiveKit",
   "version": "0.11.1",
   "main": "dist/index.js",
+  "require": "dist/index.cjs",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
   "type": "module",
   "repository": {
     "type": "git",
@@ -42,6 +50,7 @@
     "@napi-rs/cli": "^2.18.0",
     "@types/node": "^20.9.2",
     "prettier": "^3.0.3",
+    "tsup": "^8.3.5",
     "typescript": "^5.2.2"
   },
   "optionalDependencies": {
@@ -56,9 +65,9 @@
   },
   "scripts": {
     "prebuild": "node -p \"'export const SDK_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
-    "build:tsc": "pnpm prebuild && tsc && cp -r src/napi dist/",
-    "build": "pnpm build:tsc && napi build --platform --release --dts native.d.ts --js native.cjs --pipe \"prettier -w\" src/napi",
-    "artifacts": "pnpm build:tsc && napi artifacts",
+    "build:ts": "pnpm prebuild && tsup --onSuccess \"tsc --declaration --emitDeclarationOnly\" && cp -r src/napi dist/ && cp -r src/napi/* dist/",
+    "build": "pnpm build:ts && napi build --platform --release --dts native.d.ts --js native.cjs --pipe \"prettier -w\" src/napi",
+    "artifacts": "pnpm build:ts && napi artifacts",
     "build:debug": "napi build --platform",
     "lint": "eslint -f unix \"src/**/*.ts\" --ignore-pattern \"src/proto/*\"",
     "universal": "napi universal",

packages/livekit-rtc/src/audio_source.ts

@@ -66,7 +66,7 @@ export class AudioSource {
 
   get queuedDuration(): number {
     return Math.max(
-      this.currentQueueSize - Number(process.hrtime.bigint() / 1000000n) + this.lastCapture,
+      this.currentQueueSize - Number(process.hrtime.bigint() / BigInt(1000000)) + this.lastCapture,
       0,
     );
   }
@@ -102,7 +102,7 @@ export class AudioSource {
   }
 
   async captureFrame(frame: AudioFrame) {
-    const now = Number(process.hrtime.bigint() / 1000000n);
+    const now = Number(process.hrtime.bigint() / BigInt(1000000));
     const elapsed = this.lastCapture === 0 ? 0 : now - this.lastCapture;
     const frameDurationMs = (frame.samplesPerChannel / frame.sampleRate) * 1000;
     this.currentQueueSize += frameDurationMs - elapsed;

packages/livekit-rtc/src/e2ee.ts

@@ -190,7 +190,7 @@ export class KeyProvider {
 }
 
 export class FrameCryptor {
-  private roomHandle = 0n;
+  private roomHandle = BigInt(0);
   participantIdentity: string;
   keyIndex: number;
   enabled: boolean;
@@ -246,7 +246,7 @@ export class FrameCryptor {
 }
 
 export class E2EEManager {
-  private roomHandle = 0n;
+  private roomHandle = BigInt(0);
   private options: E2EEOptions;
   private keyProvider?: KeyProvider;
 

packages/livekit-rtc/src/napi/native.d.ts

@@ -3,15 +3,15 @@
 
 /* auto-generated by NAPI-RS */
 
-export declare function livekitInitialize(
+export function livekitInitialize(
   callback: (data: Uint8Array) => void,
   captureLogs: boolean,
   sdkVersion: string,
 ): void;
-export declare function livekitFfiRequest(data: Uint8Array): Uint8Array;
-export declare function livekitRetrievePtr(handle: Uint8Array): bigint;
-export declare function livekitCopyBuffer(ptr: bigint, len: number): Uint8Array;
-export declare function livekitDispose(): Promise<void>;
+export function livekitFfiRequest(data: Uint8Array): Uint8Array;
+export function livekitRetrievePtr(handle: Uint8Array): bigint;
+export function livekitCopyBuffer(ptr: bigint, len: number): Uint8Array;
+export function livekitDispose(): Promise<void>;
 export declare class FfiHandle {
   constructor(handle: bigint);
   dispose(): void;

packages/livekit-rtc/src/video_source.ts

@@ -48,7 +48,11 @@ export class VideoSource {
     this.ffiHandle = new FfiHandle(res.source!.handle!.id);
   }
 
-  captureFrame(frame: VideoFrame, timestampUs = 0n, rotation = VideoRotation.VIDEO_ROTATION_0) {
+  captureFrame(
+    frame: VideoFrame,
+    timestampUs = BigInt(0),
+    rotation = VideoRotation.VIDEO_ROTATION_0,
+  ) {
     const req = create(CaptureVideoFrameRequestSchema, {
       sourceHandle: this.ffiHandle.handle,
       buffer: frame.protoInfo(),

packages/livekit-rtc/tsconfig.json

@@ -1,12 +1,12 @@
 {
   "compilerOptions": {
-    "module": "ES2020",
+    "module": "ES2015",
     "esModuleInterop": true,
     "allowJs": true,
     "declaration": true,
     "declarationMap": true,
-    "target": "es2020",
-    "lib": ["es2020"],
+    "target": "es2015",
+    "lib": ["es2015"],
     "moduleResolution": "node",
     "sourceMap": true,
     "outDir": "dist",

packages/livekit-rtc/tsup.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'tsup';
+
+import defaults from '../../tsup.config';
+
+export default defineConfig({
+  ...defaults,
+  external: [/\.\/.*\.cjs/, /\.\/.*.node/],
+});

packages/livekit-server-sdk/package.json

@@ -3,17 +3,25 @@
   "version": "2.8.1",
   "description": "Server-side SDK for LiveKit",
   "main": "dist/index.js",
+  "require": "dist/index.cjs",
   "types": "dist/index.d.ts",
   "repository": "git@github.com:livekit/server-sdk-js.git",
   "author": "David Zhao <david@davidzhao.com>",
   "license": "Apache-2.0",
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
   "files": [
     "dist",
     "src"
   ],
   "scripts": {
-    "build": "tsc --project tsconfig.json",
+    "build": "tsup --onSuccess \"tsc --declaration --emitDeclarationOnly\"",
     "build:watch": "tsc --watch",
     "build-docs": "typedoc",
     "changeset": "changeset",
@@ -26,7 +34,7 @@
     "test:edge": "vitest --environment edge-runtime run"
   },
   "dependencies": {
-    "@livekit/protocol": "^1.27.1",
+    "@livekit/protocol": "^1.28.1",
     "camelcase-keys": "^9.0.0",
     "jose": "^5.1.2"
   },
@@ -38,6 +46,7 @@
     "@types/node": "^20.10.1",
     "happy-dom": "^15.0.0",
     "prettier": "^3.0.0",
+    "tsup": "^8.3.5",
     "typedoc": "^0.26.0",
     "typescript": "5.6.x",
     "vite": "^5.2.9",

packages/livekit-server-sdk/src/TwirpRPC.ts

@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 import type { JsonValue } from '@bufbuild/protobuf';
-import camelcaseKeys from 'camelcase-keys';
 
 // twirp RPC adapter for client implementation
 
@@ -51,6 +50,7 @@ export class TwirpRpc {
       throw new Error(`Request failed with status ${response.status}: ${response.statusText}`);
     }
     const parsedResp = await response.json();
+    const camelcaseKeys = await import('camelcase-keys').then((mod) => mod.default);
     return camelcaseKeys(parsedResp, { deep: true });
   }
 }

packages/livekit-server-sdk/tsup.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'tsup';
+
+import defaults from '../../tsup.config';
+
+export default defineConfig({
+  ...defaults,
+});