Switch Node to TypeScript build

Author: cuihairu

.gitignore

@@ -66,6 +66,7 @@ docs/.vuepress/cache/
 docs/.vuepress/temp/
 docs/.vuepress/.temp/
 node/coverage/
+node/dist/
 
 # Build outputs
 cppbuild/

node/package.json

@@ -2,11 +2,15 @@
   "name": "epoch",
   "version": "0.1.0",
   "type": "commonjs",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "test": "c8 --reporter=lcov --reporter=text node --test"
+    "build": "tsc -p tsconfig.json",
+    "test": "npm run build && c8 --reporter=lcov --reporter=text node --test"
   },
   "devDependencies": {
-    "c8": "9.1.0"
+    "c8": "9.1.0",
+    "@types/node": "22.13.1",
+    "typescript": "5.5.4"
   }
 }

node/actor-id.js node/src/actor-id.tsnode/actor-id.js renamed to node/src/actor-id.ts

@@ -1,3 +1,17 @@
+export type ActorIdParts = {
+  region: number;
+  server: number;
+  processType: number;
+  processIndex: number;
+  actorIndex: number;
+};
+
+export type ActorIdCodec = {
+  name: string;
+  encode(parts: ActorIdParts): bigint;
+  decode(value: bigint): ActorIdParts;
+};
+
 const REGION_BITS = 10n;
 const SERVER_BITS = 12n;
 const PROCESS_TYPE_BITS = 6n;
@@ -16,7 +30,7 @@ const PROCESS_TYPE_SHIFT = PROCESS_INDEX_SHIFT + PROCESS_INDEX_BITS;
 const SERVER_SHIFT = PROCESS_TYPE_SHIFT + PROCESS_TYPE_BITS;
 const REGION_SHIFT = SERVER_SHIFT + SERVER_BITS;
 
-const defaultActorIdCodec = {
+export const defaultActorIdCodec: ActorIdCodec = {
   name: "default",
   encode(parts) {
     const region = BigInt(parts.region);
@@ -51,16 +65,10 @@ const defaultActorIdCodec = {
   }
 };
 
-function encodeActorId(parts, codec = defaultActorIdCodec) {
+export function encodeActorId(parts: ActorIdParts, codec: ActorIdCodec = defaultActorIdCodec): bigint {
   return codec.encode(parts);
 }
 
-function decodeActorId(value, codec = defaultActorIdCodec) {
+export function decodeActorId(value: bigint, codec: ActorIdCodec = defaultActorIdCodec): ActorIdParts {
   return codec.decode(value);
 }
-
-module.exports = {
-  defaultActorIdCodec,
-  encodeActorId,
-  decodeActorId
-};

node/index.js node/src/index.tsnode/index.js renamed to node/src/index.ts

@@ -1,14 +1,30 @@
-function version() {
+import { decodeActorId, defaultActorIdCodec, encodeActorId } from "./actor-id";
+
+export type Message = {
+  epoch: number;
+  channelId: number;
+  sourceId: number;
+  sourceSeq: number;
+  schemaId: number;
+  qos?: number;
+  payload: number;
+};
+
+export type AeronConfig = {
+  channel: string;
+  streamId: number;
+  aeronDirectory: string;
+};
+
+export function version(): string {
   return "0.1.0";
 }
 
-const actorId = require("./actor-id");
-
 const FNV_OFFSET_BASIS = 0xcbf29ce484222325n;
 const FNV_PRIME = 0x100000001b3n;
 const FNV_MASK = 0xffffffffffffffffn;
 
-function fnv1a64Hex(input) {
+export function fnv1a64Hex(input: string): string {
   let hash = FNV_OFFSET_BASIS;
   const bytes = Buffer.from(input, "utf8");
   for (const b of bytes) {
@@ -18,7 +34,7 @@ function fnv1a64Hex(input) {
   return hash.toString(16).padStart(16, "0");
 }
 
-function processMessages(messages) {
+export function processMessages(messages: Message[]) {
   messages.sort((a, b) => {
     if (a.epoch !== b.epoch) return a.epoch - b.epoch;
     if (a.channelId !== b.channelId) return a.channelId - b.channelId;
@@ -29,9 +45,9 @@ function processMessages(messages) {
     return a.sourceSeq - b.sourceSeq;
   });
 
-  const results = [];
+  const results: { epoch: number; state: number; hash: string }[] = [];
   let state = 0;
-  let currentEpoch = null;
+  let currentEpoch: number | null = null;
 
   for (const message of messages) {
     if (currentEpoch === null) {
@@ -59,16 +75,14 @@ function processMessages(messages) {
   return results;
 }
 
-class InMemoryTransport {
-  constructor() {
-    this.queue = [];
-  }
+export class InMemoryTransport {
+  private queue: Message[] = [];
 
-  send(message) {
+  send(message: Message) {
     this.queue.push(message);
   }
 
-  poll(max) {
+  poll(max: number) {
     if (!max || this.queue.length === 0) {
       return [];
     }
@@ -81,10 +95,8 @@ class InMemoryTransport {
   }
 }
 
-class AeronTransport {
-  constructor(config) {
-    this.config = config;
-  }
+export class AeronTransport {
+  constructor(public readonly config: AeronConfig) {}
 
   send() {
     throw new Error("Aeron transport not linked");
@@ -97,13 +109,4 @@ class AeronTransport {
   close() {}
 }
 
-module.exports = {
-  version,
-  fnv1a64Hex,
-  processMessages,
-  InMemoryTransport,
-  AeronTransport,
-  defaultActorIdCodec: actorId.defaultActorIdCodec,
-  encodeActorId: actorId.encodeActorId,
-  decodeActorId: actorId.decodeActorId
-};
+export { defaultActorIdCodec, encodeActorId, decodeActorId };

node/test/version.test.js

@@ -3,7 +3,7 @@ const assert = require("node:assert/strict");
 
 const fs = require("node:fs");
 const path = require("node:path");
-const epoch = require("../index.js");
+const epoch = require("../dist/index.js");
 
 test("vector matches expected", () => {
   const vectorPath = locateVectorFile();

node/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "rootDir": "src",
+    "outDir": "dist",
+    "declaration": true,
+    "strict": true,
+    "esModuleInterop": false,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts"]
+}