@peers-app/peers-sdk 0.23.5 → 0.23.6

package/dist/package-installer/index.d.ts

@@ -2,6 +2,7 @@ export * from "./package-author-signer";
 export * from "./package-author-signing";
 export * from "./package-cloner";
 export * from "./package-creator";
+export * from "./package-dev-tools";
 export * from "./package-installer";
 export * from "./package-propagation";
 export * from "./package-publisher";

package/dist/package-installer/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./package-author-signer"), exports);
 __exportStar(require("./package-author-signing"), exports);
 __exportStar(require("./package-cloner"), exports);
 __exportStar(require("./package-creator"), exports);
+__exportStar(require("./package-dev-tools"), exports);
 __exportStar(require("./package-installer"), exports);
 __exportStar(require("./package-propagation"), exports);
 __exportStar(require("./package-publisher"), exports);

package/dist/package-installer/package-cloner.d.ts

@@ -9,7 +9,7 @@ export declare function deriveRepoSlug(url: string): string;
  * Clone a remote git repository containing a Peers package, install dependencies,
  * build it, and register the dev bundle in the database.
  *
- * Prerequisites (git, npm) are validated up front with clear error messages.
+ * Prerequisites (git, and Node.js/npm unless `skipBuild`) are validated up front.
  * If the target directory already exists and contains a valid package, delegates
  * to {@link installPackageFromBundles} instead of re-cloning.
  */

package/dist/package-installer/package-cloner.js

@@ -6,6 +6,7 @@ const packages_1 = require("../data/packages");
 const persistent_vars_1 = require("../data/persistent-vars");
 const system_ids_1 = require("../system-ids");
 const utils_1 = require("../utils");
+const package_dev_tools_1 = require("./package-dev-tools");
 const package_installer_1 = require("./package-installer");
 /**
  * Derive a filesystem-safe slug from a git remote URL.
@@ -26,24 +27,13 @@ function autoDetectDisabled(remoteRepo) {
  * Clone a remote git repository containing a Peers package, install dependencies,
  * build it, and register the dev bundle in the database.
  *
- * Prerequisites (git, npm) are validated up front with clear error messages.
+ * Prerequisites (git, and Node.js/npm unless `skipBuild`) are validated up front.
  * If the target directory already exists and contains a valid package, delegates
  * to {@link installPackageFromBundles} instead of re-cloning.
  */
 async function clonePackage(dataContext, deps, opts) {
-    // 1. Validate prerequisites
-    try {
-        await deps.shell.exec("git --version");
-    }
-    catch {
-        throw new Error("git is not installed. Please install git to add remote packages.");
-    }
-    try {
-        await deps.shell.exec("npm --version");
-    }
-    catch {
-        throw new Error("npm is not installed. Please install Node.js (which includes npm) to add remote packages.");
-    }
+    // 1. Validate prerequisites before cloning so a missing toolchain does not leave a partial repo.
+    await (0, package_dev_tools_1.assertPackageDevTools)(deps, { requireNode: opts.skipBuild !== true });
     // 2. Resolve location
     const location = opts.location ?? deps.resolvePath(deps.packagesRootDir, deriveRepoSlug(opts.remoteRepo));
     // 3. Check if directory already exists
@@ -66,8 +56,13 @@ async function clonePackage(dataContext, deps, opts) {
     await deps.shell.exec(`git clone ${opts.remoteRepo} ${location}`);
     // 5. Install + build (unless skipBuild)
     if (!opts.skipBuild) {
-        await deps.shell.exec("npm install", { cwd: location });
-        await deps.shell.exec("npm run build", { cwd: location });
+        try {
+            await deps.shell.exec("npm install", { cwd: location });
+            await deps.shell.exec("npm run build", { cwd: location });
+        }
+        catch (error) {
+            throw (0, package_dev_tools_1.rewriteMissingDevToolError)(error);
+        }
     }
     // 6. Read package info and resolve packageId
     const info = await (0, package_installer_1.getPackageInfo)(deps, location);

package/dist/package-installer/package-cloner.test.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const package_cloner_1 = require("./package-cloner");
+const package_dev_tools_1 = require("./package-dev-tools");
 // --- Mocks for SDK internals ---
 const mockSignAndSavePkg = jest.fn();
 jest.mock("../data/packages", () => ({
@@ -68,7 +69,7 @@ describe("clonePackage", () => {
         });
         const deps = makeMockDeps(shellExec);
         const dc = mockDataContext();
-        await expect((0, package_cloner_1.clonePackage)(dc, deps, { remoteRepo: "https://github.com/peers-app/test.git" })).rejects.toThrow("git is not installed");
+        await expect((0, package_cloner_1.clonePackage)(dc, deps, { remoteRepo: "https://github.com/peers-app/test.git" })).rejects.toThrow(package_dev_tools_1.MISSING_GIT_MESSAGE);
     });
     it("throws when npm is not installed", async () => {
         const shellExec = jest.fn(async (cmd) => {
@@ -78,7 +79,7 @@ describe("clonePackage", () => {
         });
         const deps = makeMockDeps(shellExec);
         const dc = mockDataContext();
-        await expect((0, package_cloner_1.clonePackage)(dc, deps, { remoteRepo: "https://github.com/peers-app/test.git" })).rejects.toThrow("npm is not installed");
+        await expect((0, package_cloner_1.clonePackage)(dc, deps, { remoteRepo: "https://github.com/peers-app/test.git" })).rejects.toThrow(package_dev_tools_1.MISSING_NODE_MESSAGE);
     });
     it("clones, installs, builds, and registers a package with valid packageId", async () => {
         const deps = makeMockDeps();
@@ -184,7 +185,8 @@ describe("clonePackage", () => {
         });
         const execCalls = deps.shell.exec.mock.calls.map((c) => c[0]);
         expect(execCalls).toContain("git --version");
-        expect(execCalls).toContain("npm --version");
+        expect(execCalls).not.toContain("node --version");
+        expect(execCalls).not.toContain("npm --version");
         expect(execCalls).toContain("git clone https://github.com/peers-app/prebuilt.git /packages/prebuilt");
         expect(execCalls).not.toContain("npm install");
         expect(execCalls).not.toContain("npm run build");

package/dist/package-installer/package-creator.d.ts

@@ -43,9 +43,10 @@ export declare function importExistingPackage(dataContext: DataContext, deps: IP
 /**
  * Create a new Peers package from the package template.
  *
- * Clones the template repo, patches IDs and metadata, runs npm install + build,
- * initializes a fresh git repo, then delegates to {@link installPackageFromBundles}
- * to register the dev bundle in the database.
+ * Validates git/Node.js/npm first so a missing toolchain does not leave a
+ * half-copied package directory. Then clones the template repo, patches IDs
+ * and metadata, runs npm install + build, initializes a fresh git repo, and
+ * delegates to {@link installPackageFromBundles} to register the dev bundle.
  *
  * When `location` already exists and contains a valid Peers package manifest,
  * imports that directory instead (see {@link importExistingPackage}).

package/dist/package-installer/package-creator.js

@@ -11,6 +11,7 @@ const keys_1 = require("../keys");
 const system_ids_1 = require("../system-ids");
 const utils_1 = require("../utils");
 const package_author_signing_1 = require("./package-author-signing");
+const package_dev_tools_1 = require("./package-dev-tools");
 const package_installer_1 = require("./package-installer");
 const DEFAULT_TEMPLATE_REPO = "https://github.com/peers-app/peers-package-template.git";
 const TEMPLATE_CACHE_DIR = ".peers-package-template";
@@ -170,9 +171,10 @@ async function importExistingPackage(dataContext, deps, opts) {
 /**
  * Create a new Peers package from the package template.
  *
- * Clones the template repo, patches IDs and metadata, runs npm install + build,
- * initializes a fresh git repo, then delegates to {@link installPackageFromBundles}
- * to register the dev bundle in the database.
+ * Validates git/Node.js/npm first so a missing toolchain does not leave a
+ * half-copied package directory. Then clones the template repo, patches IDs
+ * and metadata, runs npm install + build, initializes a fresh git repo, and
+ * delegates to {@link installPackageFromBundles} to register the dev bundle.
  *
  * When `location` already exists and contains a valid Peers package manifest,
  * imports that directory instead (see {@link importExistingPackage}).
@@ -187,6 +189,7 @@ async function createPackage(dataContext, deps, opts) {
             displayName: opts.name,
         });
     }
+    await (0, package_dev_tools_1.assertPackageDevTools)(deps);
     // Generate fresh IDs
     const packageId = (0, utils_1.newid)();
     const contractId = (0, utils_1.newid)();
@@ -226,8 +229,13 @@ async function createPackage(dataContext, deps, opts) {
     }
     // Initialize as a new project: remove template git history, install, build, fresh git
     await deps.shell.exec("rm -rf .git", { cwd: location });
-    await deps.shell.exec("npm install", { cwd: location });
-    await deps.shell.exec("npm run build", { cwd: location });
+    try {
+        await deps.shell.exec("npm install", { cwd: location });
+        await deps.shell.exec("npm run build", { cwd: location });
+    }
+    catch (error) {
+        throw (0, package_dev_tools_1.rewriteMissingDevToolError)(error);
+    }
     await deps.shell.exec("git init", { cwd: location });
     await deps.shell.exec("git add .", { cwd: location });
     await deps.shell.exec('git commit -m "Initial commit"', { cwd: location });

package/dist/package-installer/package-creator.test.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const package_creator_1 = require("./package-creator");
+const package_dev_tools_1 = require("./package-dev-tools");
 // --- Mocks for SDK internals ---
 const mockSignAndSavePkg = jest.fn();
 const mockGetPkg = jest.fn();
@@ -97,6 +98,23 @@ describe("nameToFolderSlug", () => {
     });
 });
 describe("createPackage", () => {
+    it("fails before scaffolding when Node.js or npm is missing", async () => {
+        const shellExec = jest.fn(async (cmd) => {
+            if (cmd === "npm --version") {
+                throw new Error("/bin/sh: npm: command not found");
+            }
+            return { stdout: "", stderr: "" };
+        });
+        const deps = makeMockDeps({}, shellExec);
+        deps.fs.exists.mockResolvedValue(false);
+        await expect((0, package_creator_1.createPackage)(mockDataContext(), deps, { name: "KidsTube" })).rejects.toThrow(package_dev_tools_1.MISSING_NODE_MESSAGE);
+        expect(deps.fs.writeFile).not.toHaveBeenCalled();
+        expect(shellExec.mock.calls.map((call) => call[0])).toEqual([
+            "git --version",
+            "node --version",
+            "npm --version",
+        ]);
+    });
     it("creates a package using local template cache with correct steps", async () => {
         const templatePkgJson = JSON.stringify({
             name: "peers-package-template",
@@ -135,6 +153,7 @@ describe("createPackage", () => {
             author: "Test User",
         });
         const execCalls = deps.shell.exec.mock.calls.map((c) => c[0]);
+        expect(execCalls.slice(0, 3)).toEqual(["git --version", "node --version", "npm --version"]);
         // Verify template was cloned to cache (not directly to location)
         expect(execCalls).toContain("git clone https://github.com/peers-app/peers-package-template.git /packages/.peers-package-template");
         // Verify cp -r from cache to location

package/dist/package-installer/package-dev-tools.d.ts

@@ -0,0 +1,30 @@
+import type { IPackageInstallerDeps } from "./types";
+/** User-facing error when `git` is missing from the host PATH. */
+export declare const MISSING_GIT_MESSAGE = "git is required to create and add packages. Install git, then quit and reopen Peers.";
+/**
+ * User-facing error when Node.js or npm cannot be found.
+ *
+ * Keep this specific enough that a packaged-app PATH miss is distinguishable
+ * from an install/build failure, and actionable when Node is truly absent.
+ */
+export declare const MISSING_NODE_MESSAGE: string;
+/** Options for {@link assertPackageDevTools}. */
+export interface IAssertPackageDevToolsOpts {
+    /** When false, skip Node.js/npm checks (for clone-only/import-only flows). Defaults to true. */
+    requireNode?: boolean;
+}
+/**
+ * Verify that package create/clone prerequisites are on the host PATH.
+ *
+ * @param deps - Injected filesystem/shell host.
+ * @param opts - Optional Node.js requirement override.
+ * @throws When git, Node.js, or npm cannot be executed.
+ */
+export declare function assertPackageDevTools(deps: IPackageInstallerDeps, opts?: IAssertPackageDevToolsOpts): Promise<void>;
+/**
+ * Rewrite a late "command not found" failure into the same user-facing message.
+ *
+ * @param error - Error thrown by `shell.exec`.
+ * @returns The original error, or a clearer missing-tool error.
+ */
+export declare function rewriteMissingDevToolError(error: unknown): Error;

package/dist/package-installer/package-dev-tools.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MISSING_NODE_MESSAGE = exports.MISSING_GIT_MESSAGE = void 0;
+exports.assertPackageDevTools = assertPackageDevTools;
+exports.rewriteMissingDevToolError = rewriteMissingDevToolError;
+/** User-facing error when `git` is missing from the host PATH. */
+exports.MISSING_GIT_MESSAGE = "git is required to create and add packages. Install git, then quit and reopen Peers.";
+/**
+ * User-facing error when Node.js or npm cannot be found.
+ *
+ * Keep this specific enough that a packaged-app PATH miss is distinguishable
+ * from an install/build failure, and actionable when Node is truly absent.
+ */
+exports.MISSING_NODE_MESSAGE = "Node.js and npm are required to create and build packages. Peers couldn't find them on this computer.\n\n" +
+    "Install Node.js from https://nodejs.org (this includes npm), then quit and reopen Peers.\n\n" +
+    "If Node is already installed through nvm, Homebrew, or fnm, those tools must be available in your login shell.";
+/**
+ * Verify that package create/clone prerequisites are on the host PATH.
+ *
+ * @param deps - Injected filesystem/shell host.
+ * @param opts - Optional Node.js requirement override.
+ * @throws When git, Node.js, or npm cannot be executed.
+ */
+async function assertPackageDevTools(deps, opts) {
+    try {
+        await deps.shell.exec("git --version");
+    }
+    catch {
+        throw new Error(exports.MISSING_GIT_MESSAGE);
+    }
+    if (opts?.requireNode === false) {
+        return;
+    }
+    try {
+        await deps.shell.exec("node --version");
+        await deps.shell.exec("npm --version");
+    }
+    catch {
+        throw new Error(exports.MISSING_NODE_MESSAGE);
+    }
+}
+/**
+ * Rewrite a late "command not found" failure into the same user-facing message.
+ *
+ * @param error - Error thrown by `shell.exec`.
+ * @returns The original error, or a clearer missing-tool error.
+ */
+function rewriteMissingDevToolError(error) {
+    const message = error instanceof Error ? error.message : String(error);
+    if (isCommandNotFound(message, "git")) {
+        return new Error(exports.MISSING_GIT_MESSAGE);
+    }
+    if (isCommandNotFound(message, "node") || isCommandNotFound(message, "npm")) {
+        return new Error(exports.MISSING_NODE_MESSAGE);
+    }
+    return error instanceof Error ? error : new Error(message);
+}
+function isCommandNotFound(message, command) {
+    const lower = message.toLowerCase();
+    return (lower.includes(`${command}: command not found`) ||
+        lower.includes(`'${command}' is not recognized`) ||
+        (lower.includes("enoent") && lower.includes(command)));
+}

package/dist/package-installer/package-dev-tools.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/package-installer/package-dev-tools.test.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const package_dev_tools_1 = require("./package-dev-tools");
+function makeDeps(exec) {
+    return {
+        fs: {
+            readFile: jest.fn(),
+            writeFile: jest.fn(),
+            exists: jest.fn(),
+            readJson: jest.fn(),
+        },
+        shell: { exec },
+        resolvePath: (...segments) => segments.join("/"),
+        packagesRootDir: "/packages",
+    };
+}
+describe("assertPackageDevTools", () => {
+    it("requires git, node, and npm by default", async () => {
+        const exec = jest.fn(async () => ({ stdout: "ok", stderr: "" }));
+        await (0, package_dev_tools_1.assertPackageDevTools)(makeDeps(exec));
+        expect(exec.mock.calls.map((call) => call[0])).toEqual([
+            "git --version",
+            "node --version",
+            "npm --version",
+        ]);
+    });
+    it("skips Node.js checks when requireNode is false", async () => {
+        const exec = jest.fn(async () => ({ stdout: "ok", stderr: "" }));
+        await (0, package_dev_tools_1.assertPackageDevTools)(makeDeps(exec), { requireNode: false });
+        expect(exec.mock.calls.map((call) => call[0])).toEqual(["git --version"]);
+    });
+    it("throws a clear git error", async () => {
+        const exec = jest.fn(async (cmd) => {
+            if (cmd === "git --version") {
+                throw new Error("git: command not found");
+            }
+            return { stdout: "ok", stderr: "" };
+        });
+        await expect((0, package_dev_tools_1.assertPackageDevTools)(makeDeps(exec))).rejects.toThrow(package_dev_tools_1.MISSING_GIT_MESSAGE);
+    });
+    it("throws a clear Node.js/npm error", async () => {
+        const exec = jest.fn(async (cmd) => {
+            if (cmd === "npm --version") {
+                throw new Error("/bin/sh: npm: command not found");
+            }
+            return { stdout: "ok", stderr: "" };
+        });
+        await expect((0, package_dev_tools_1.assertPackageDevTools)(makeDeps(exec))).rejects.toThrow(package_dev_tools_1.MISSING_NODE_MESSAGE);
+    });
+});
+describe("rewriteMissingDevToolError", () => {
+    it("rewrites npm command-not-found failures", () => {
+        const rewritten = (0, package_dev_tools_1.rewriteMissingDevToolError)(new Error("Command failed: npm install\n/bin/sh: npm: command not found"));
+        expect(rewritten.message).toBe(package_dev_tools_1.MISSING_NODE_MESSAGE);
+    });
+    it("rewrites Windows npm-not-recognized failures", () => {
+        const rewritten = (0, package_dev_tools_1.rewriteMissingDevToolError)(new Error("'npm' is not recognized as an internal or external command"));
+        expect(rewritten.message).toBe(package_dev_tools_1.MISSING_NODE_MESSAGE);
+    });
+    it("leaves unrelated install failures unchanged", () => {
+        const original = new Error("npm ERR! network timeout");
+        expect((0, package_dev_tools_1.rewriteMissingDevToolError)(original)).toBe(original);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peers-app/peers-sdk",
-  "version": "0.23.5",
+  "version": "0.23.6",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/peers-app/peers-sdk.git"