@openvcs/sdk 0.2.2 → 0.2.4

package/test/cli.test.js

@@ -27,6 +27,7 @@ test("openvcs --help prints usage", () => {
   const result = runCli(["--help"]);
   assert.equal(result.status, 0);
   assert.match(result.stdout, /Usage: openvcs <command>/);
+  assert.match(result.stdout, /build \[args\]/);
 });
 
 test("openvcs with no args exits non-zero", () => {
@@ -41,6 +42,12 @@ test("openvcs dist --help prints dist usage", () => {
   assert.match(result.stdout, /openvcs dist \[args\]/);
 });
 
+test("openvcs build --help prints build usage", () => {
+  const result = runCli(["build", "--help"]);
+  assert.equal(result.status, 0);
+  assert.match(result.stdout, /openvcs build \[args\]/);
+});
+
 test("openvcs init --help prints init usage", () => {
   const result = runCli(["init", "--help"]);
   assert.equal(result.status, 0);
@@ -70,6 +77,7 @@ test("openvcs dist command creates bundle", () => {
     pluginDir,
     "--out",
     outDir,
+    "--no-build",
     "--no-npm-deps",
   ]);
 
@@ -85,3 +93,32 @@ test("openvcs dist reports argument errors", () => {
   assert.equal(result.status, 1);
   assert.match(result.stderr, /missing value for --plugin-dir/);
 });
+
+test("openvcs build command builds code plugin assets", () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const pluginDir = path.join(root, "plugin");
+
+  writeJson(path.join(pluginDir, "openvcs.plugin.json"), {
+    id: "build-plugin",
+    module: { exec: "plugin.js" },
+  });
+  writeJson(path.join(pluginDir, "package.json"), {
+    name: "build-plugin",
+    private: true,
+    scripts: {
+      "build:plugin": "node ./scripts/build-plugin.js",
+    },
+  });
+  writeText(
+    path.join(pluginDir, "scripts", "build-plugin.js"),
+    "const fs = require('node:fs');\nconst path = require('node:path');\nconst out = path.join(process.cwd(), 'bin', 'plugin.js');\nfs.mkdirSync(path.dirname(out), { recursive: true });\nfs.writeFileSync(out, 'export {};\\n', 'utf8');\n"
+  );
+
+  const result = runCli(["build", "--plugin-dir", pluginDir]);
+
+  assert.equal(result.status, 0);
+  assert.equal(result.stdout.trim(), "build-plugin");
+  assert.equal(fs.existsSync(path.join(pluginDir, "bin", "plugin.js")), true);
+
+  cleanupTempDir(root);
+});

package/test/dist.test.js

@@ -26,11 +26,13 @@ test("parseDistArgs parses known flags", () => {
     "some/plugin",
     "--out",
     "some/out",
+    "--no-build",
     "--no-npm-deps",
     "--verbose",
   ]);
   assert.equal(parsed.pluginDir, path.resolve("some/plugin"));
   assert.equal(parsed.outDir, path.resolve("some/out"));
+  assert.equal(parsed.noBuild, true);
   assert.equal(parsed.noNpmDeps, true);
   assert.equal(parsed.verbose, true);
 });
@@ -237,7 +239,13 @@ test("bundlePlugin writes a gzip .ovcsp for themes-only plugin", async () => {
   writeText(path.join(pluginDir, "themes", "default", "theme.json"), '{"name":"test"}\n');
   writeText(path.join(pluginDir, "icon.png"), "icon-bytes");
 
-  const outPath = await bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true });
+  const outPath = await bundlePlugin({
+    pluginDir,
+    outDir,
+    verbose: false,
+    noBuild: true,
+    noNpmDeps: true,
+  });
   const entries = await readBundleEntries(outPath);
 
   assert.equal(path.basename(outPath), "ui-only.ovcsp");
@@ -248,15 +256,15 @@ test("bundlePlugin writes a gzip .ovcsp for themes-only plugin", async () => {
   cleanupTempDir(root);
 });
 
-test("bundlePlugin rejects manifest with no module and no themes", async () => {
+test("bundlePlugin rejects manifest with no module, entry, or themes", async () => {
   const root = makeTempDir("openvcs-sdk-test");
   const pluginDir = path.join(root, "plugin");
   const outDir = path.join(root, "out");
   writeJson(path.join(pluginDir, "openvcs.plugin.json"), { id: "x" });
 
   await assert.rejects(
-    () => bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true }),
-    /manifest has no module\.exec or themes\//
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true }),
+    /manifest has no module\.exec, entry, or themes\//
   );
 
   cleanupTempDir(root);
@@ -274,7 +282,13 @@ test("bundlePlugin trims module.exec and includes extra bin files", async () =>
   writeText(path.join(pluginDir, "bin", "module.mjs"), "export {};\n");
   writeText(path.join(pluginDir, "bin", "helpers", "util.mjs"), "export const x = 1;\n");
 
-  const outPath = await bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true });
+  const outPath = await bundlePlugin({
+    pluginDir,
+    outDir,
+    verbose: false,
+    noBuild: true,
+    noNpmDeps: true,
+  });
   const entries = await readBundleEntries(outPath);
 
   assert.equal(entries.has("x/bin/module.mjs"), true);
@@ -282,6 +296,81 @@ test("bundlePlugin trims module.exec and includes extra bin files", async () =>
   cleanupTempDir(root);
 });
 
+test("bundlePlugin builds code plugins before packaging", async () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const pluginDir = path.join(root, "plugin");
+  const outDir = path.join(root, "out");
+
+  writeJson(path.join(pluginDir, "openvcs.plugin.json"), {
+    id: "builder",
+    module: { exec: "plugin.js" },
+  });
+  writeJson(path.join(pluginDir, "package.json"), {
+    name: "builder",
+    private: true,
+    scripts: {
+      "build:plugin": "node ./scripts/build-plugin.js",
+    },
+  });
+  writeText(
+    path.join(pluginDir, "scripts", "build-plugin.js"),
+    "const fs = require('node:fs');\nconst path = require('node:path');\nconst out = path.join(process.cwd(), 'bin', 'plugin.js');\nfs.mkdirSync(path.dirname(out), { recursive: true });\nfs.writeFileSync(out, 'export {};\\n', 'utf8');\n"
+  );
+
+  const outPath = await bundlePlugin({
+    pluginDir,
+    outDir,
+    verbose: false,
+    noBuild: false,
+    noNpmDeps: true,
+  });
+  const entries = await readBundleEntries(outPath);
+
+  assert.equal(entries.has("builder/bin/plugin.js"), true);
+  cleanupTempDir(root);
+});
+
+test("bundlePlugin with no-build requires prebuilt module entrypoint", async () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const pluginDir = path.join(root, "plugin");
+  const outDir = path.join(root, "out");
+
+  writeJson(path.join(pluginDir, "openvcs.plugin.json"), {
+    id: "prebuilt",
+    module: { exec: "plugin.js" },
+  });
+
+  await assert.rejects(
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true }),
+    /module entrypoint not found/
+  );
+
+  cleanupTempDir(root);
+});
+
+test("bundlePlugin errors when code plugin lacks build:plugin", async () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const pluginDir = path.join(root, "plugin");
+  const outDir = path.join(root, "out");
+
+  writeJson(path.join(pluginDir, "openvcs.plugin.json"), {
+    id: "missing-script",
+    module: { exec: "plugin.js" },
+  });
+  writeJson(path.join(pluginDir, "package.json"), {
+    name: "missing-script",
+    private: true,
+    scripts: {},
+  });
+
+  await assert.rejects(
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: false, noNpmDeps: true }),
+    /build:plugin/
+  );
+
+  cleanupTempDir(root);
+});
+
 test("bundlePlugin rejects module.exec path traversal", async () => {
   const root = makeTempDir("openvcs-sdk-test");
   const pluginDir = path.join(root, "plugin");
@@ -294,7 +383,7 @@ test("bundlePlugin rejects module.exec path traversal", async () => {
   writeText(path.join(pluginDir, "secret.js"), "console.log('secret')\n");
 
   await assert.rejects(
-    () => bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true }),
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true }),
     /module\.exec/
   );
 
@@ -313,7 +402,7 @@ test("bundlePlugin rejects non-node module.exec extension", async () => {
   writeText(path.join(pluginDir, "bin", "plugin.ts"), "export {};\n");
 
   await assert.rejects(
-    () => bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true }),
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true }),
     /must end with .js\/.mjs\/.cjs/
   );
 
@@ -332,7 +421,7 @@ test("bundlePlugin rejects plugin id with path separators", async () => {
   writeText(path.join(pluginDir, "bin", "plugin.js"), "export {};\n");
 
   await assert.rejects(
-    () => bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true }),
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true }),
     /must not contain path separators/
   );
 
@@ -357,7 +446,7 @@ test("bundlePlugin rejects symlink in bin", async () => {
   fs.symlinkSync(path.join(pluginDir, "bin", "target.js"), path.join(pluginDir, "bin", "link.js"));
 
   await assert.rejects(
-    () => bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true }),
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true }),
     /symlink/
   );
 
@@ -375,7 +464,13 @@ test("bundlePlugin output archive keeps plugin-id root directory", async () => {
   });
   writeText(path.join(pluginDir, "bin", "plugin.js"), "export {};\n");
 
-  const outPath = await bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true });
+  const outPath = await bundlePlugin({
+    pluginDir,
+    outDir,
+    verbose: false,
+    noBuild: true,
+    noNpmDeps: true,
+  });
   const entries = await readBundleEntries(outPath);
   for (const key of entries.keys()) {
     assert.equal(key.startsWith("root-check/"), true);
@@ -399,14 +494,20 @@ test("bundlePlugin overwrites existing bundle file", async () => {
   const existingPath = path.join(outDir, "replace.ovcsp");
   writeText(existingPath, "not-a-tar");
 
-  const outPath = await bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true });
+  const outPath = await bundlePlugin({
+    pluginDir,
+    outDir,
+    verbose: false,
+    noBuild: true,
+    noNpmDeps: true,
+  });
   const entries = await readBundleEntries(outPath);
   assert.equal(entries.has("replace/openvcs.plugin.json"), true);
 
   cleanupTempDir(root);
 });
 
-test("bundlePlugin generates package-lock when package.json exists", async () => {
+test("bundlePlugin generates package-lock in staging, not pluginDir", async () => {
   const root = makeTempDir("openvcs-sdk-test");
   const pluginDir = path.join(root, "plugin");
   const outDir = path.join(root, "out");
@@ -422,10 +523,16 @@ test("bundlePlugin generates package-lock when package.json exists", async () =>
     private: true,
   });
 
-  const outPath = await bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: false });
+  const outPath = await bundlePlugin({
+    pluginDir,
+    outDir,
+    verbose: false,
+    noBuild: true,
+    noNpmDeps: false,
+  });
   const entries = await readBundleEntries(outPath);
 
-  assert.equal(fs.existsSync(path.join(pluginDir, "package-lock.json")), true);
+  assert.equal(fs.existsSync(path.join(pluginDir, "package-lock.json")), false);
   assert.equal(entries.has("npm-plugin/package.json"), true);
   assert.equal(entries.has("npm-plugin/package-lock.json"), true);
 
@@ -448,9 +555,126 @@ test("bundlePlugin with --no-npm-deps does not generate lockfile", async () => {
     private: true,
   });
 
-  await bundlePlugin({ pluginDir, outDir, verbose: false, noNpmDeps: true });
+  await bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true });
 
   assert.equal(fs.existsSync(path.join(pluginDir, "package-lock.json")), false);
 
   cleanupTempDir(root);
 });
+
+test("bundlePlugin bundles manifest entry file with sibling assets", async () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const pluginDir = path.join(root, "plugin");
+  const outDir = path.join(root, "out");
+
+  writeJson(path.join(pluginDir, "openvcs.plugin.json"), {
+    id: "ui-plugin",
+    entry: "ui/index.html",
+  });
+  writeText(path.join(pluginDir, "ui", "index.html"), "<html></html>\n");
+  writeText(path.join(pluginDir, "ui", "app.js"), "console.log('ui');\n");
+  writeText(path.join(pluginDir, "ui", "styles.css"), "body {}\n");
+  writeText(path.join(pluginDir, "icon.png"), "icon-bytes");
+
+  const outPath = await bundlePlugin({
+    pluginDir,
+    outDir,
+    verbose: false,
+    noBuild: true,
+    noNpmDeps: true,
+  });
+  const entries = await readBundleEntries(outPath);
+
+  assert.equal(entries.has("ui-plugin/openvcs.plugin.json"), true);
+  assert.equal(entries.has("ui-plugin/ui/index.html"), true);
+  assert.equal(entries.has("ui-plugin/ui/app.js"), true);
+  assert.equal(entries.has("ui-plugin/ui/styles.css"), true);
+  assert.equal(entries.has("ui-plugin/icon.png"), true);
+
+  cleanupTempDir(root);
+});
+
+test("bundlePlugin bundles root-level entry with sibling assets", async () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const pluginDir = path.join(root, "plugin");
+  const outDir = path.join(root, "out");
+
+  writeJson(path.join(pluginDir, "openvcs.plugin.json"), {
+    id: "root-ui",
+    entry: "index.html",
+  });
+  writeText(path.join(pluginDir, "index.html"), "<html></html>\n");
+  writeText(path.join(pluginDir, "app.js"), "console.log('ui');\n");
+  writeText(path.join(pluginDir, "styles.css"), "body {}\n");
+
+  const outPath = await bundlePlugin({
+    pluginDir,
+    outDir,
+    verbose: false,
+    noBuild: true,
+    noNpmDeps: true,
+  });
+  const entries = await readBundleEntries(outPath);
+
+  assert.equal(entries.has("root-ui/openvcs.plugin.json"), true);
+  assert.equal(entries.has("root-ui/index.html"), true);
+  assert.equal(entries.has("root-ui/app.js"), true);
+  assert.equal(entries.has("root-ui/styles.css"), true);
+
+  cleanupTempDir(root);
+});
+
+test("bundlePlugin rejects manifest entry path traversal", async () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const pluginDir = path.join(root, "plugin");
+  const outDir = path.join(root, "out");
+
+  writeJson(path.join(pluginDir, "openvcs.plugin.json"), {
+    id: "bad-entry",
+    entry: "../secret.txt",
+  });
+  writeText(path.join(pluginDir, "secret.txt"), "secret");
+
+  await assert.rejects(
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true }),
+    /manifest entry must point to a file under the plugin directory/
+  );
+
+  cleanupTempDir(root);
+});
+
+test("bundlePlugin rejects manifest entry absolute path", async () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const pluginDir = path.join(root, "plugin");
+  const outDir = path.join(root, "out");
+
+  writeJson(path.join(pluginDir, "openvcs.plugin.json"), {
+    id: "abs-entry",
+    entry: "/tmp/secret.txt",
+  });
+
+  await assert.rejects(
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true }),
+    /manifest entry must be a relative path/
+  );
+
+  cleanupTempDir(root);
+});
+
+test("bundlePlugin rejects missing manifest entry file", async () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const pluginDir = path.join(root, "plugin");
+  const outDir = path.join(root, "out");
+
+  writeJson(path.join(pluginDir, "openvcs.plugin.json"), {
+    id: "missing-entry",
+    entry: "nonexistent.html",
+  });
+
+  await assert.rejects(
+    () => bundlePlugin({ pluginDir, outDir, verbose: false, noBuild: true, noNpmDeps: true }),
+    /manifest entry file not found/
+  );
+
+  cleanupTempDir(root);
+});

package/test/init.test.js

@@ -1,8 +1,10 @@
 const assert = require("node:assert/strict");
+const fs = require("node:fs");
 const test = require("node:test");
 const path = require("node:path");
 
 const { __private } = require("../lib/init");
+const { cleanupTempDir, makeTempDir } = require("./helpers");
 
 test("validatePluginId accepts regular ids", () => {
   assert.equal(__private.validatePluginId("my.plugin"), undefined);
@@ -63,3 +65,26 @@ test("collectAnswers re-prompts invalid plugin id", async () => {
   assert.equal(answers.runNpmInstall, false);
   assert.equal(messages.some((message) => message.includes("must not contain path separators")), true);
 });
+
+test("writeModuleTemplate scaffolds SDK runtime entrypoint", () => {
+  const root = makeTempDir("openvcs-sdk-test");
+  const targetDir = path.join(root, "plugin");
+
+  __private.writeModuleTemplate({
+    targetDir,
+    kind: "module",
+    pluginId: "example.plugin",
+    pluginName: "Example Plugin",
+    pluginVersion: "0.1.0",
+    defaultEnabled: true,
+    runNpmInstall: false,
+  });
+
+  const pluginSource = fs.readFileSync(path.join(targetDir, "src", "plugin.ts"), "utf8");
+
+  assert.match(pluginSource, /createPluginRuntime/);
+  assert.match(pluginSource, /startPluginRuntime/);
+  assert.match(pluginSource, /context\.host\.info\('OpenVCS plugin started'\)/);
+
+  cleanupTempDir(root);
+});

package/test/runtime.test.js

@@ -0,0 +1,118 @@
+const assert = require("node:assert/strict");
+const { EventEmitter } = require("node:events");
+const test = require("node:test");
+
+const { createPluginRuntime } = require("../lib/runtime");
+const {
+  parseFramedMessages,
+  serializeFramedMessage,
+} = require("../lib/runtime/transport");
+
+function createRuntimeHarness(options) {
+  const stdin = new EventEmitter();
+  const chunks = [];
+  const stdout = {
+    write(chunk) {
+      chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+      return true;
+    },
+  };
+  const runtime = createPluginRuntime(options);
+  runtime.start({ stdin, stdout });
+
+  return {
+    async request(message) {
+      stdin.emit("data", serializeFramedMessage(message));
+      await new Promise((resolve) => setImmediate(resolve));
+      const parsed = parseFramedMessages(Buffer.concat(chunks));
+      chunks.length = 0;
+      return parsed.messages;
+    },
+  };
+}
+
+test("createPluginRuntime answers plugin.initialize with inferred capabilities", async () => {
+  const harness = createRuntimeHarness({});
+
+  const messages = await harness.request({
+    jsonrpc: "2.0",
+    id: 1,
+    method: "plugin.initialize",
+    params: {},
+  });
+
+  assert.deepEqual(messages, [
+    {
+      jsonrpc: "2.0",
+      id: 1,
+      result: {
+        protocol_version: 1,
+        implements: {
+          plugin: true,
+          vcs: false,
+        },
+      },
+    },
+  ]);
+});
+
+test("createPluginRuntime uses plugin defaults and host notifications", async () => {
+  const harness = createRuntimeHarness({
+    plugin: {
+      async "plugin.init"(_params, context) {
+        context.host.info("ready");
+        return null;
+      },
+    },
+  });
+
+  const messages = await harness.request({
+    jsonrpc: "2.0",
+    id: 2,
+    method: "plugin.init",
+    params: {},
+  });
+
+  assert.deepEqual(messages, [
+    {
+      jsonrpc: "2.0",
+      method: "host.log",
+      params: {
+        level: "info",
+        target: "openvcs.plugin",
+        message: "ready",
+      },
+    },
+    {
+      jsonrpc: "2.0",
+      id: 2,
+      result: null,
+    },
+  ]);
+});
+
+test("createPluginRuntime reports missing methods as plugin failures", async () => {
+  const harness = createRuntimeHarness({});
+
+  const messages = await harness.request({
+    jsonrpc: "2.0",
+    id: 3,
+    method: "vcs.get_caps",
+    params: {},
+  });
+
+  assert.deepEqual(messages, [
+    {
+      jsonrpc: "2.0",
+      id: 3,
+      error: {
+        code: -32001,
+        message: "method 'vcs.get_caps' is not implemented",
+        data: {
+          code: "rpc-method-not-found",
+          message: "method 'vcs.get_caps' is not implemented",
+        },
+      },
+    },
+  ]);
+});