@illuminis/comprism 0.1.0 → 0.1.2

package/out/lib/readiness.d.ts

@@ -0,0 +1,30 @@
+export interface Requirement {
+    /** What it is for, said as the work it makes possible. */
+    purpose: string;
+    /** Any one of these being present is enough. */
+    anyOf: string[];
+    /** Work that cannot be done without it, for the message. */
+    without: string;
+    /** True when the tool cannot function at all without this. */
+    essential: boolean;
+}
+export declare const REQUIREMENTS: Requirement[];
+/** Is this program on the machine, by name, without running anything of theirs. */
+export declare function present(program: string): boolean;
+/**
+ * The one command that installs what is missing, for the machine it is on.
+ *
+ * Named per platform rather than guessed: telling somebody on Ubuntu to run a
+ * Homebrew command is worse than saying nothing, because they now have to work
+ * out that the instruction was wrong before they can work out what is right.
+ */
+export declare function howToInstall(missing: string[]): string;
+export interface Readiness {
+    ready: boolean;
+    /** One line per requirement, ready to print. */
+    lines: string[];
+    /** The command to run, empty when nothing is missing. */
+    fix: string;
+}
+/** What this machine can and cannot do, and how to close the gap. */
+export declare function check(): Readiness;

package/out/lib/readiness.js

@@ -0,0 +1,107 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUIREMENTS = void 0;
+exports.present = present;
+exports.howToInstall = howToInstall;
+exports.check = check;
+/**
+ * What this machine needs before the work can be done on it, and what to type
+ * when something is missing.
+ *
+ * ── Why this is short, and why that is the right answer ───────────────────
+ *
+ * Almost everything people expect to need here is not needed at all, because it
+ * happens on our servers. A Word document, a slide deck and a PDF are BUILT
+ * there and arrive as bytes; the tool only writes them to disk. Nothing on a
+ * customer's machine has to know what a .docx is.
+ *
+ * What genuinely has to be local is the work that touches their own files:
+ *
+ *   - `git`, so a repository can be read, branched and committed.
+ *   - A PDF reader, so a specification they already have can be read back.
+ *
+ * That is the whole list, and it stays that way deliberately. Every program
+ * added here is one more thing that can be absent, the wrong version, or
+ * refused by somebody's security team.
+ *
+ * ── Why the install does not simply install them ──────────────────────────
+ *
+ * It would have to install system software, unasked, from a package manager, as
+ * a side effect of `npm install`. Any security team that found that would ban
+ * the product, and rightly: a tool that quietly runs a system installer on a
+ * laptop is indistinguishable from one that does something worse. So this
+ * reports and gives the exact command, and the person runs it. One line to copy
+ * is not friction worth trading a customer's trust for.
+ */
+const node_child_process_1 = require("node:child_process");
+const node_os_1 = __importDefault(require("node:os"));
+exports.REQUIREMENTS = [
+    {
+        purpose: 'working with a repository',
+        anyOf: ['git'],
+        without: 'reading, branching and committing a project',
+        essential: false,
+    },
+    {
+        purpose: 'reading a PDF you already have',
+        // Three ways to do the same job. The first keeps the layout, the second is
+        // close, the third is usually there on any machine with Python at all.
+        anyOf: ['pdftotext', 'mutool', 'python3'],
+        without: 'reading a specification or a contract that arrived as a PDF',
+        essential: false,
+    },
+];
+/** Is this program on the machine, by name, without running anything of theirs. */
+function present(program) {
+    try {
+        (0, node_child_process_1.execFileSync)('/usr/bin/env', ['which', program], { stdio: 'ignore' });
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * The one command that installs what is missing, for the machine it is on.
+ *
+ * Named per platform rather than guessed: telling somebody on Ubuntu to run a
+ * Homebrew command is worse than saying nothing, because they now have to work
+ * out that the instruction was wrong before they can work out what is right.
+ */
+function howToInstall(missing) {
+    if (missing.length === 0)
+        return '';
+    const platform = node_os_1.default.platform();
+    const parts = missing.map((m) => (m === 'pdftotext' ? 'poppler' : m));
+    if (platform === 'darwin')
+        return `brew install ${parts.join(' ')}`;
+    if (platform === 'linux') {
+        const apt = missing.map((m) => (m === 'pdftotext' ? 'poppler-utils' : m));
+        return `sudo apt-get install -y ${apt.join(' ')}`;
+    }
+    if (platform === 'win32')
+        return `winget install ${parts.join(' ')}`;
+    return `install: ${parts.join(', ')}`;
+}
+/** What this machine can and cannot do, and how to close the gap. */
+function check() {
+    const lines = [];
+    const missing = [];
+    for (const req of exports.REQUIREMENTS) {
+        const found = req.anyOf.find(present);
+        if (found) {
+            lines.push(`  ready    ${req.purpose}`);
+        }
+        else {
+            // The FIRST of the alternatives is the one named, because a list of three
+            // equivalent programs is a decision nobody wants to make about a thing
+            // they did not know they needed.
+            missing.push(req.anyOf[0]);
+            lines.push(`  missing  ${req.purpose}, so ${req.without} will not work`);
+        }
+    }
+    return { ready: missing.length === 0, lines, fix: howToInstall(missing) };
+}

package/out/lib/version.d.ts

@@ -6,8 +6,7 @@
  * behavior behind them changes, never on a whim, because consumers select by
  * version and old records keep meaning what they meant.
  */
-/** The package version. Stamped on every row the Companion writes. */
-export declare const COMPRISM_VERSION = "0.1.0";
+export declare const COMPRISM_VERSION: string;
 /** The structural classifier. Bump when a signal is added, removed or retuned. */
 export declare const CLASSIFIER_VERSION = "structural-v1";
 /**

package/out/lib/version.js

@@ -9,8 +9,27 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ESTIMATOR_VERSION = exports.POLICY_VERSION = exports.CLASSIFIER_VERSION = exports.COMPRISM_VERSION = void 0;
-/** The package version. Stamped on every row the Companion writes. */
-exports.COMPRISM_VERSION = '0.1.0';
+/**
+ * The package version. Stamped on every row the Companion writes.
+ *
+ * Read from the package's own manifest rather than typed here. It was typed
+ * here once, and a published 0.1.1 went on reporting itself as 0.1.0 to every
+ * customer and onto every record it wrote, which is the one number a version
+ * stamp exists to get right. A literal drifts the moment `npm version` runs;
+ * the manifest cannot.
+ */
+function packageVersion() {
+    try {
+        // Two levels up from out/lib, which is where the manifest sits in both the
+        // built package and a checkout.
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return String(require('../../package.json').version || '0.0.0');
+    }
+    catch {
+        return '0.0.0';
+    }
+}
+exports.COMPRISM_VERSION = packageVersion();
 /** The structural classifier. Bump when a signal is added, removed or retuned. */
 exports.CLASSIFIER_VERSION = 'structural-v1';
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@illuminis/comprism",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "CompletionPrism Companion. Records what finishing a piece of work actually costs - every attempt, and the human time spent noticing and repairing the ones that failed.",
   "license": "UNLICENSED",
   "private": false,
@@ -24,6 +24,8 @@
     "out/lib/gateway.d.ts",
     "out/lib/prompt.js",
     "out/lib/prompt.d.ts",
+    "out/lib/readiness.js",
+    "out/lib/readiness.d.ts",
     "out/lib/types.js",
     "out/lib/types.d.ts",
     "out/lib/ui.js",