@cascode/cascode-js 0.5.2

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@cascode/cascode-js",
+  "version": "0.5.2",
+  "description": "Synchronous Node binding for libcascode",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "license": "BSD-3-Clause",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/daniellovell/cascode.git",
+    "directory": "editors/node"
+  },
+  "files": [
+    "src/**/*",
+    "native/**/*",
+    "lib/std/**/*.cas",
+    "binding.gyp",
+    "README.md",
+    "platform-packages/**/*",
+    "scripts/**/*"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "gypfile": false,
+  "optionalDependencies": {
+    "@cascode/cascode-js-darwin-arm64": "0.5.2",
+    "@cascode/cascode-js-darwin-x64": "0.5.2",
+    "@cascode/cascode-js-linux-x64": "0.5.2",
+    "@cascode/cascode-js-win32-x64": "0.5.2"
+  },
+  "scripts": {
+    "build": "node-gyp rebuild",
+    "stage:platform": "node ./scripts/stage-platform-package.mjs",
+    "prepack": "node ./scripts/sync-stdlib.mjs",
+    "test:integration": "node --test test/integration.test.mjs",
+    "test:types": "tsc -p tsconfig.json --noEmit",
+    "test": "npm run test:integration && npm run test:types"
+  },
+  "devDependencies": {
+    "node-gyp": "^11.1.0",
+    "typescript": "^5.9.2"
+  }
+}

package/platform-packages/cascode-js-darwin-arm64/README.md

@@ -0,0 +1,4 @@
+# @cascode/native-darwin-arm64
+
+Prebuilt macOS arm64 runtime bundle used by `@cascode/native`.
+

package/platform-packages/cascode-js-darwin-arm64/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+const path = require("path");
+
+module.exports = {
+  addonPath: path.join(__dirname, "prebuilds", "cascode_native_addon.node"),
+  libraryPath: path.join(__dirname, "native", "osx-arm64", "Cascode.Native.dylib"),
+  libraryDir: path.join(__dirname, "native", "osx-arm64"),
+};
+

package/platform-packages/cascode-js-darwin-arm64/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@cascode/cascode-js-darwin-arm64",
+  "version": "0.5.2",
+  "description": "Prebuilt macOS arm64 runtime bundle for @cascode/cascode-js",
+  "license": "BSD-3-Clause",
+  "private": false,
+  "main": "index.js",
+  "os": [
+    "darwin"
+  ],
+  "cpu": [
+    "arm64"
+  ],
+  "files": [
+    "index.js",
+    "README.md",
+    "prebuilds/**/*",
+    "native/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/daniellovell/cascode.git",
+    "directory": "editors/node/platform-packages/cascode-js-darwin-arm64"
+  }
+}

package/platform-packages/cascode-js-darwin-x64/README.md

@@ -0,0 +1,4 @@
+# @cascode/native-darwin-x64
+
+Prebuilt macOS x64 runtime bundle used by `@cascode/native`.
+

package/platform-packages/cascode-js-darwin-x64/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+const path = require("path");
+
+module.exports = {
+  addonPath: path.join(__dirname, "prebuilds", "cascode_native_addon.node"),
+  libraryPath: path.join(__dirname, "native", "osx-x64", "Cascode.Native.dylib"),
+  libraryDir: path.join(__dirname, "native", "osx-x64"),
+};
+

package/platform-packages/cascode-js-darwin-x64/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@cascode/cascode-js-darwin-x64",
+  "version": "0.5.2",
+  "description": "Prebuilt macOS x64 runtime bundle for @cascode/cascode-js",
+  "license": "BSD-3-Clause",
+  "private": false,
+  "main": "index.js",
+  "os": [
+    "darwin"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "files": [
+    "index.js",
+    "README.md",
+    "prebuilds/**/*",
+    "native/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/daniellovell/cascode.git",
+    "directory": "editors/node/platform-packages/cascode-js-darwin-x64"
+  }
+}

package/platform-packages/cascode-js-linux-x64/README.md

@@ -0,0 +1,4 @@
+# @cascode/native-linux-x64
+
+Prebuilt Linux x64 runtime bundle used by `@cascode/native`.
+

package/platform-packages/cascode-js-linux-x64/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+const path = require("path");
+
+module.exports = {
+  addonPath: path.join(__dirname, "prebuilds", "cascode_native_addon.node"),
+  libraryPath: path.join(__dirname, "native", "linux-x64", "Cascode.Native.so"),
+  libraryDir: path.join(__dirname, "native", "linux-x64"),
+};
+

package/platform-packages/cascode-js-linux-x64/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@cascode/cascode-js-linux-x64",
+  "version": "0.5.2",
+  "description": "Prebuilt Linux x64 runtime bundle for @cascode/cascode-js",
+  "license": "BSD-3-Clause",
+  "private": false,
+  "main": "index.js",
+  "os": [
+    "linux"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "files": [
+    "index.js",
+    "README.md",
+    "prebuilds/**/*",
+    "native/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/daniellovell/cascode.git",
+    "directory": "editors/node/platform-packages/cascode-js-linux-x64"
+  }
+}

package/platform-packages/cascode-js-win32-x64/README.md

@@ -0,0 +1,4 @@
+# @cascode/native-win32-x64
+
+Prebuilt Windows x64 runtime bundle used by `@cascode/native`.
+

package/platform-packages/cascode-js-win32-x64/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+const path = require("path");
+
+module.exports = {
+  addonPath: path.join(__dirname, "prebuilds", "cascode_native_addon.node"),
+  libraryPath: path.join(__dirname, "native", "win-x64", "Cascode.Native.dll"),
+  libraryDir: path.join(__dirname, "native", "win-x64"),
+};
+

package/platform-packages/cascode-js-win32-x64/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@cascode/cascode-js-win32-x64",
+  "version": "0.5.2",
+  "description": "Prebuilt Windows x64 runtime bundle for @cascode/cascode-js",
+  "license": "BSD-3-Clause",
+  "private": false,
+  "main": "index.js",
+  "os": [
+    "win32"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "files": [
+    "index.js",
+    "README.md",
+    "prebuilds/**/*",
+    "native/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/daniellovell/cascode.git",
+    "directory": "editors/node/platform-packages/cascode-js-win32-x64"
+  }
+}

package/scripts/stage-platform-package.mjs

@@ -0,0 +1,128 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+/**
+ * Retrieve the value for a command-line argument provided in the form `--name=value`.
+ * @param {string} name - Argument name without leading dashes.
+ * @returns {string} The value after the `=` for the matching argument, or an empty string if not found.
+ */
+function readArg(name) {
+  const prefix = `--${name}=`;
+  const value = process.argv.find((arg) => arg.startsWith(prefix));
+  return value ? value.slice(prefix.length) : "";
+}
+
+const packageName = readArg("package");
+const rid = readArg("rid");
+const libName = readArg("lib");
+const rawVersion = readArg("version");
+const version = rawVersion.startsWith("v") ? rawVersion.slice(1) : rawVersion;
+const outDirArg = readArg("out");
+
+if (!packageName || !rid || !libName || !version || !outDirArg) {
+  throw new Error(
+    "Missing required args. Expected --package=... --rid=... --lib=... --version=... --out=..."
+  );
+}
+
+const scriptFile = fileURLToPath(import.meta.url);
+const nodeRoot = path.resolve(path.dirname(scriptFile), "..");
+const repoRoot = path.resolve(nodeRoot, "..", "..");
+const packageShort = packageName.replace("@cascode/", "");
+const templateDir = path.join(nodeRoot, "platform-packages", packageShort);
+const outDir = path.resolve(outDirArg);
+
+const addonSrc = path.join(nodeRoot, "build", "Release", "cascode_native_addon.node");
+const nativeSrcDir = path.join(repoRoot, "build", "native", rid);
+const expectedLibPath = path.join(nativeSrcDir, libName);
+
+/**
+ * Ensure the given filesystem path exists.
+ *
+ * @param {string} targetPath - Path to check for existence.
+ * @param {string} label - Human-readable label used in the error message if the path is missing.
+ * @throws {Error} If the path does not exist.
+ */
+async function ensureExists(targetPath, label) {
+  const stat = await fs.stat(targetPath).catch(() => null);
+  if (!stat) {
+    throw new Error(`Missing ${label}: ${targetPath}`);
+  }
+}
+
+/**
+ * Recursively copies files and directories from sourceDir into targetDir, excluding files that end with `.pdb` (case-insensitive).
+ * @param {string} sourceDir - Path to the source directory to copy from.
+ * @param {string} targetDir - Path to the destination directory to copy into; created recursively if it does not exist.
+ */
+async function copyRuntimeFiles(sourceDir, targetDir) {
+  await fs.mkdir(targetDir, { recursive: true });
+  const entries = await fs.readdir(sourceDir, { withFileTypes: true });
+  for (const entry of entries) {
+    const sourcePath = path.join(sourceDir, entry.name);
+    const targetPath = path.join(targetDir, entry.name);
+
+    if (entry.isDirectory()) {
+      await copyRuntimeFiles(sourcePath, targetPath);
+      continue;
+    }
+
+    const lowerName = entry.name.toLowerCase();
+    if (lowerName.endsWith(".pdb")) continue;
+    await fs.copyFile(sourcePath, targetPath);
+  }
+}
+
+/**
+ * Prepare and stage a platform package into the configured output directory.
+ *
+ * Validates required resources, recreates the output directory, copies the package
+ * template, updates the package.json version, installs the built native addon into
+ * a prebuilds folder, copies native runtime files for the target RID, and logs the
+ * final staged location.
+ */
+async function run() {
+  await ensureExists(templateDir, "template directory");
+  await ensureExists(addonSrc, "built addon");
+  await ensureExists(nativeSrcDir, "published native runtime directory");
+  await ensureExists(expectedLibPath, "expected runtime shared library");
+
+  const resolvedRepoRoot = path.resolve(repoRoot);
+  const resolvedOutDir = path.resolve(outDir);
+  const outDirRoot = path.parse(resolvedOutDir).root;
+  const outDirIsDescendantOfRepoRoot = resolvedOutDir.startsWith(
+    `${resolvedRepoRoot}${path.sep}`
+  );
+
+  if (
+    resolvedOutDir === outDirRoot ||
+    resolvedOutDir === resolvedRepoRoot ||
+    !outDirIsDescendantOfRepoRoot
+  ) {
+    throw new Error(
+      `Unsafe delete target in run(): outDir="${resolvedOutDir}" must be a descendant of repoRoot="${resolvedRepoRoot}" and must not be filesystem root or repoRoot.`
+    );
+  }
+
+  await fs.rm(resolvedOutDir, { recursive: true, force: true });
+  await fs.mkdir(resolvedOutDir, { recursive: true });
+  await fs.cp(templateDir, resolvedOutDir, { recursive: true });
+
+  const pkgPath = path.join(resolvedOutDir, "package.json");
+  const pkg = JSON.parse(await fs.readFile(pkgPath, "utf8"));
+  pkg.version = version;
+  await fs.writeFile(pkgPath, `${JSON.stringify(pkg, null, 2)}\n`, "utf8");
+
+  const prebuildDir = path.join(resolvedOutDir, "prebuilds");
+  await fs.mkdir(prebuildDir, { recursive: true });
+  await fs.copyFile(addonSrc, path.join(prebuildDir, "cascode_native_addon.node"));
+
+  const nativeOutDir = path.join(resolvedOutDir, "native", rid);
+  await fs.mkdir(path.dirname(nativeOutDir), { recursive: true });
+  await copyRuntimeFiles(nativeSrcDir, nativeOutDir);
+
+  console.log(`Staged ${packageName}@${version} at ${resolvedOutDir}`);
+}
+
+await run();

package/scripts/sync-stdlib.mjs

@@ -0,0 +1,35 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const scriptFile = fileURLToPath(import.meta.url);
+const nodeRoot = path.resolve(path.dirname(scriptFile), "..");
+const repoRoot = path.resolve(nodeRoot, "..", "..");
+
+const stdlibSrc = path.join(repoRoot, "lib", "std");
+const stdlibDst = path.join(nodeRoot, "lib", "std");
+
+async function pathExists(p) {
+  return fs.stat(p).then(
+    () => true,
+    () => false
+  );
+}
+
+async function ensureStdlibPresent() {
+  const ok = await pathExists(stdlibSrc);
+  if (!ok) {
+    throw new Error(`[cascode-native] stdlib source directory not found: ${stdlibSrc}`);
+  }
+}
+
+async function run() {
+  await ensureStdlibPresent();
+  await fs.mkdir(path.dirname(stdlibDst), { recursive: true });
+  await fs.rm(stdlibDst, { recursive: true, force: true });
+  await fs.cp(stdlibSrc, stdlibDst, { recursive: true });
+  console.log(`[cascode-native] Staged stdlib into package at: ${stdlibDst}`);
+}
+
+await run();
+

package/src/index.d.ts

@@ -0,0 +1,38 @@
+export interface CascodeNative {
+  createSession(optionsJson?: string): number;
+  destroySession(session: number): void;
+  call(session: number, method: string, requestJson: string): string;
+  lastErrorJson(session: number): string | null;
+  apiVersion(): string;
+  schemaVersion(): string;
+}
+
+export const native: CascodeNative;
+
+/** Absolute path to the bundled standard library (lib/std) directory. */
+export const stdlibPath: string;
+
+export function createSession(optionsJson?: string): number;
+export function destroySession(session: number): void;
+export function call(session: number, method: string, requestJson: string): string;
+export function lastErrorJson(session: number): string | null;
+export function apiVersion(): string;
+export function schemaVersion(): string;
+
+export type NativeMethodCall = <Req extends object, Res>(
+  native: CascodeNative,
+  session: number,
+  req: Req
+) => Res;
+
+export const open: NativeMethodCall;
+export const updateText: NativeMethodCall;
+export const close: NativeMethodCall;
+export const render: NativeMethodCall;
+export const applyOps: NativeMethodCall;
+export const erc: NativeMethodCall;
+export const emit: NativeMethodCall;
+export const verify: NativeMethodCall;
+export const jobStart: NativeMethodCall;
+export const jobPoll: NativeMethodCall;
+export const jobCancel: NativeMethodCall;