@inboxychat/cli 0.0.0-stage → 0.2.0

package/dist/output.js

@@ -0,0 +1,161 @@
+/**
+ * Output contract of the `inboxy` CLI.
+ *
+ * --json prints exactly one JSON document on stdout (schemaVersion 1):
+ *   success: { schemaVersion: 1, ok: true,  command, data, meta? }
+ *   failure: { schemaVersion: 1, ok: false, command, error: { kind, code, message, status, details, retryAfterSeconds } }
+ * Fields may be added within schemaVersion 1; none is renamed or removed.
+ *
+ * Exit codes are stable and documented in the README.
+ */
+import { InboxyError, describeError, redactSecrets } from '@inboxychat/sdk';
+export const JSON_SCHEMA_VERSION = 1;
+export const EXIT = {
+    OK: 0,
+    UNEXPECTED: 1,
+    USAGE: 2,
+    CONFIG: 3,
+    AUTH: 4,
+    FORBIDDEN: 5,
+    NOT_FOUND: 6,
+    RATE_LIMITED: 7,
+    NETWORK: 8,
+    SERVER: 9,
+    CHECKS_FAILED: 10,
+};
+export function exitCodeFor(kind) {
+    switch (kind) {
+        case 'config':
+            return EXIT.CONFIG;
+        case 'auth':
+            return EXIT.AUTH;
+        case 'forbidden':
+            return EXIT.FORBIDDEN;
+        case 'not_found':
+            return EXIT.NOT_FOUND;
+        case 'rate_limited':
+            return EXIT.RATE_LIMITED;
+        case 'timeout':
+        case 'cancelled':
+        case 'network':
+            return EXIT.NETWORK;
+        case 'server':
+        case 'invalid_response':
+            return EXIT.SERVER;
+        case 'invalid_request':
+            return EXIT.USAGE;
+        default:
+            return EXIT.UNEXPECTED;
+    }
+}
+export class UsageError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'UsageError';
+    }
+}
+export class Output {
+    io;
+    json;
+    command;
+    secrets;
+    constructor(io, json, command, 
+    /** Secrets that must never reach the terminal (the key in use). */
+    secrets) {
+        this.io = io;
+        this.json = json;
+        this.command = command;
+        this.secrets = secrets;
+    }
+    clean(text) {
+        return redactSecrets(text, this.secrets());
+    }
+    /** Success. `human` renders the non-JSON view. */
+    success(data, meta, human) {
+        if (this.json) {
+            const doc = {
+                schemaVersion: JSON_SCHEMA_VERSION,
+                ok: true,
+                command: this.command,
+                data,
+            };
+            if (meta !== undefined)
+                doc.meta = meta;
+            this.io.stdout(`${this.clean(JSON.stringify(doc, null, 2))}\n`);
+        }
+        else {
+            const text = human();
+            if (text)
+                this.io.stdout(`${this.clean(text)}\n`);
+        }
+        return EXIT.OK;
+    }
+    failure(error) {
+        let payload;
+        let code;
+        let human;
+        if (error instanceof InboxyError) {
+            payload = { ...error.toJSON(), message: describeError(error) };
+            code = exitCodeFor(error.kind);
+            human = `Error (${error.code}): ${describeError(error)}`;
+        }
+        else if (error instanceof UsageError) {
+            payload = {
+                kind: 'usage',
+                code: 'USAGE',
+                message: error.message,
+                status: 0,
+                details: {},
+                retryAfterSeconds: null,
+            };
+            code = EXIT.USAGE;
+            human = `Error: ${error.message}\nRun \`inboxy --help\` for usage.`;
+        }
+        else {
+            const message = error instanceof Error ? error.message : 'Unexpected error';
+            payload = {
+                kind: 'unexpected',
+                code: 'UNEXPECTED',
+                message,
+                status: 0,
+                details: {},
+                retryAfterSeconds: null,
+            };
+            code = EXIT.UNEXPECTED;
+            human = `Error: ${message}`;
+        }
+        if (this.json) {
+            const doc = {
+                schemaVersion: JSON_SCHEMA_VERSION,
+                ok: false,
+                command: this.command,
+                error: payload,
+            };
+            this.io.stdout(`${this.clean(JSON.stringify(doc, null, 2))}\n`);
+        }
+        else {
+            this.io.stderr(`${this.clean(human)}\n`);
+        }
+        return code;
+    }
+    /** Progress or hints for humans; suppressed in --json mode. */
+    note(text) {
+        if (!this.json)
+            this.io.stderr(`${this.clean(text)}\n`);
+    }
+}
+/** A plain aligned table; cells are flattened to one line. */
+export function table(headers, rows) {
+    const cells = rows.map((r) => r.map((c) => (c === null || c === undefined ? '-' : String(c).replace(/\s+/g, ' '))));
+    const widths = headers.map((h, i) => Math.min(48, Math.max(h.length, ...cells.map((r) => (r[i] ?? '').length))));
+    const fmt = (r) => r
+        .map((c, i) => {
+        const w = widths[i];
+        const v = c.length > w ? `${c.slice(0, w - 1)}…` : c;
+        return v.padEnd(w);
+    })
+        .join('  ')
+        .trimEnd();
+    return [fmt(headers), fmt(widths.map((w) => '-'.repeat(w))), ...cells.map(fmt)].join('\n');
+}
+//# sourceMappingURL=output.js.map

package/dist/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../src/output.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAwB,MAAM,iBAAiB,CAAC;AAElG,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAErC,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,EAAE,EAAE,CAAC;IACL,UAAU,EAAE,CAAC;IACb,KAAK,EAAE,CAAC;IACR,MAAM,EAAE,CAAC;IACT,IAAI,EAAE,CAAC;IACP,SAAS,EAAE,CAAC;IACZ,SAAS,EAAE,CAAC;IACZ,YAAY,EAAE,CAAC;IACf,OAAO,EAAE,CAAC;IACV,MAAM,EAAE,CAAC;IACT,aAAa,EAAE,EAAE;CACT,CAAC;AAEX,MAAM,UAAU,WAAW,CAAC,IAAqB;IAC/C,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,KAAK,WAAW;YACd,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,KAAK,WAAW;YACd,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,KAAK,cAAc;YACjB,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,KAAK,SAAS,CAAC;QACf,KAAK,WAAW,CAAC;QACjB,KAAK,SAAS;YACZ,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,KAAK,QAAQ,CAAC;QACd,KAAK,kBAAkB;YACrB,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,KAAK,iBAAiB;YACpB,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;AACH,CAAC;AAED,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF;AAsBD,MAAM,OAAO,MAAM;IAEE;IACA;IACA;IAEA;IALnB,YACmB,EAAS,EACT,IAAa,EACb,OAAe;IAChC,mEAAmE;IAClD,OAAuB;QAJvB,OAAE,GAAF,EAAE,CAAO;QACT,SAAI,GAAJ,IAAI,CAAS;QACb,YAAO,GAAP,OAAO,CAAQ;QAEf,YAAO,GAAP,OAAO,CAAgB;IACvC,CAAC;IAEI,KAAK,CAAC,IAAY;QACxB,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,kDAAkD;IAClD,OAAO,CAAC,IAAa,EAAE,IAAa,EAAE,KAAmB;QACvD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,GAAG,GAA4B;gBACnC,aAAa,EAAE,mBAAmB;gBAClC,EAAE,EAAE,IAAI;gBACR,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI;aACL,CAAC;YACF,IAAI,IAAI,KAAK,SAAS;gBAAE,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;YACxC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC;YACrB,IAAI,IAAI;gBAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,KAAc;QACpB,IAAI,OAOH,CAAC;QACF,IAAI,IAAY,CAAC;QACjB,IAAI,KAAa,CAAC;QAClB,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,OAAO,GAAG,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/D,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC/B,KAAK,GAAG,UAAU,KAAK,CAAC,IAAI,MAAM,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,CAAC;aAAM,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YACvC,OAAO,GAAG;gBACR,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,MAAM,EAAE,CAAC;gBACT,OAAO,EAAE,EAAE;gBACX,iBAAiB,EAAE,IAAI;aACxB,CAAC;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;YAClB,KAAK,GAAG,UAAU,KAAK,CAAC,OAAO,oCAAoC,CAAC;QACtE,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC;YAC5E,OAAO,GAAG;gBACR,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,YAAY;gBAClB,OAAO;gBACP,MAAM,EAAE,CAAC;gBACT,OAAO,EAAE,EAAE;gBACX,iBAAiB,EAAE,IAAI;aACxB,CAAC;YACF,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC;YACvB,KAAK,GAAG,UAAU,OAAO,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,GAAG,GAAG;gBACV,aAAa,EAAE,mBAAmB;gBAClC,EAAE,EAAE,KAAK;gBACT,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,KAAK,EAAE,OAAO;aACf,CAAC;YACF,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+DAA+D;IAC/D,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,IAAI,CAAC,IAAI;YAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;CACF;AAED,8DAA8D;AAC9D,MAAM,UAAU,KAAK,CACnB,OAAiB,EACjB,IAAsD;IAEtD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3B,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CACrF,CAAC;IACF,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAClC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAC3E,CAAC;IACF,MAAM,GAAG,GAAG,CAAC,CAAW,EAAE,EAAE,CAC1B,CAAC;SACE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACZ,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;QACrB,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC;SACV,OAAO,EAAE,CAAC;IACf,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7F,CAAC"}

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@inboxychat/cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "Inboxy command line with read methods, diagnostics and schema-validated confirmed operations.",
+  "license": "UNLICENSED",
+  "type": "module",
+  "bin": {
+    "inboxy": "./dist/bin.js"
+  },
+  "files": [
+    "dist",
+    "!dist/.tsbuildinfo",
+    "!dist/**/*.tsbuildinfo"
+  ],
+  "engines": {
+    "node": ">=20.3.0"
+  },
+  "dependencies": {
+    "@inboxychat/sdk": "^0.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "typescript": "^5.3.0",
+    "vitest": "^4.0.16"
+  },
+  "homepage": "https://inboxy.chat/developers/cli",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "type-check": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "clean": "rm -rf dist .turbo"
+  }
 }