@bitmagic/cli 0.1.6 → 0.1.8

package/dist/verify/result.d.ts

@@ -0,0 +1,60 @@
+import type { VerifyResult } from './classify.js';
+export declare const VERIFY_RESULT_FILENAME = "result.json";
+/**
+ * What `bitmagic verify` observed, written so `bitmagic publish` can gate on it.
+ *
+ * `fingerprint` is what makes the record trustworthy later: it names the exact project state
+ * that was verified, so publish can tell "verified and unchanged" from "verified, then edited".
+ */
+export interface VerifyRunRecord {
+    ok: boolean;
+    failures: string[];
+    warnings: string[];
+    fingerprint: string;
+    /** ISO 8601. Reported to the creator; never used to decide staleness. */
+    at: string;
+}
+export declare function writeVerifyRecord(artifactDir: string, record: VerifyRunRecord): void;
+/**
+ * The last recorded run, or `null` if there is none to trust.
+ *
+ * Unreadable and malformed both read as null on purpose. This is not swallowing an error: the
+ * caller's next move is identical in all three cases — tell the creator to run `bitmagic
+ * verify` — and a partially-parsed record would be a worse thing to gate a publish on than no
+ * record at all.
+ */
+export declare function readVerifyRecord(artifactDir: string): VerifyRunRecord | null;
+/**
+ * What a classified verify run produces: the record to write, and whether the command then
+ * fails.
+ *
+ * Split out of the command so the ORDER is testable. The record must be written even when the
+ * run failed — publish distinguishes "verify failed" from "verify never ran", and those have
+ * different messages and different remedies. Inside `run()` that ordering is only observable by
+ * spawning vite and a browser, which is why it went unguarded.
+ */
+export declare function decideVerifyOutcome(result: VerifyResult, fingerprint: string, at: string): {
+    record: VerifyRunRecord;
+    shouldThrow: boolean;
+};
+export interface VerifyReporter {
+    write: (artifactDir: string, record: VerifyRunRecord) => void;
+    info: (line: string) => void;
+    error: (line: string) => void;
+}
+/**
+ * Record the run, report it, and fail the command if it did not pass.
+ *
+ * The record is written BEFORE the throw and regardless of the verdict, because publish
+ * distinguishes "verify failed" from "verify never ran" and those have different remedies.
+ * That ordering lives here, behind injectable seams, precisely so a test can prove the record
+ * survives a failing run — inside `run()` it was observable only by spawning vite and a browser,
+ * which is why it went unguarded.
+ */
+export declare function recordAndGateVerify(artifactDir: string, outcome: {
+    record: VerifyRunRecord;
+    shouldThrow: boolean;
+}, paths: {
+    consolePath: string;
+    screenshotPath: string;
+}, reporter: VerifyReporter): void;

package/dist/verify/result.js

@@ -0,0 +1,74 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import { CliError } from '../errors.js';
+export const VERIFY_RESULT_FILENAME = 'result.json';
+export function writeVerifyRecord(artifactDir, record) {
+    fs.mkdirSync(artifactDir, { recursive: true });
+    fs.writeFileSync(path.join(artifactDir, VERIFY_RESULT_FILENAME), `${JSON.stringify(record, null, 2)}\n`);
+}
+function isRecord(value) {
+    if (typeof value !== 'object' || value === null)
+        return false;
+    const r = value;
+    return (typeof r.ok === 'boolean'
+        && Array.isArray(r.failures)
+        && r.failures.every((f) => typeof f === 'string')
+        && Array.isArray(r.warnings)
+        && r.warnings.every((w) => typeof w === 'string')
+        && typeof r.fingerprint === 'string'
+        && typeof r.at === 'string');
+}
+/**
+ * The last recorded run, or `null` if there is none to trust.
+ *
+ * Unreadable and malformed both read as null on purpose. This is not swallowing an error: the
+ * caller's next move is identical in all three cases — tell the creator to run `bitmagic
+ * verify` — and a partially-parsed record would be a worse thing to gate a publish on than no
+ * record at all.
+ */
+export function readVerifyRecord(artifactDir) {
+    try {
+        const parsed = JSON.parse(fs.readFileSync(path.join(artifactDir, VERIFY_RESULT_FILENAME), 'utf-8'));
+        return isRecord(parsed) ? parsed : null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * What a classified verify run produces: the record to write, and whether the command then
+ * fails.
+ *
+ * Split out of the command so the ORDER is testable. The record must be written even when the
+ * run failed — publish distinguishes "verify failed" from "verify never ran", and those have
+ * different messages and different remedies. Inside `run()` that ordering is only observable by
+ * spawning vite and a browser, which is why it went unguarded.
+ */
+export function decideVerifyOutcome(result, fingerprint, at) {
+    return {
+        record: { ok: result.ok, failures: result.failures, warnings: result.warnings, fingerprint, at },
+        shouldThrow: !result.ok,
+    };
+}
+/**
+ * Record the run, report it, and fail the command if it did not pass.
+ *
+ * The record is written BEFORE the throw and regardless of the verdict, because publish
+ * distinguishes "verify failed" from "verify never ran" and those have different remedies.
+ * That ordering lives here, behind injectable seams, precisely so a test can prove the record
+ * survives a failing run — inside `run()` it was observable only by spawning vite and a browser,
+ * which is why it went unguarded.
+ */
+export function recordAndGateVerify(artifactDir, outcome, paths, reporter) {
+    reporter.write(artifactDir, outcome.record);
+    for (const warning of outcome.record.warnings)
+        reporter.info(`warning: ${warning}`);
+    if (outcome.shouldThrow) {
+        for (const failure of outcome.record.failures)
+            reporter.error(`✗ ${failure}`);
+        reporter.error(`\nArtifacts: ${paths.consolePath}, ${paths.screenshotPath}`);
+        throw new CliError('Verification failed.');
+    }
+    reporter.info(`Verification passed. Artifacts in ${artifactDir}`);
+}
+//# sourceMappingURL=result.js.map

package/dist/verify/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../../src/verify/result.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,MAAM,CAAC,MAAM,sBAAsB,GAAG,aAAa,CAAC;AAiBpD,MAAM,UAAU,iBAAiB,CAAC,WAAmB,EAAE,MAAuB;IAC5E,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,sBAAsB,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3G,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,CAAC,GAAG,KAAgC,CAAC;IAC3C,OAAO,CACL,OAAO,CAAC,CAAC,EAAE,KAAK,SAAS;WACtB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;WACxB,CAAC,CAAC,QAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;WAC7D,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;WACxB,CAAC,CAAC,QAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;WAC7D,OAAO,CAAC,CAAC,WAAW,KAAK,QAAQ;WACjC,OAAO,CAAC,CAAC,EAAE,KAAK,QAAQ,CAC5B,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,WAAmB;IAClD,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,sBAAsB,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAoB,EACpB,WAAmB,EACnB,EAAU;IAEV,OAAO;QACL,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,EAAE;QAChG,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE;KACxB,CAAC;AACJ,CAAC;AAQD;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CACjC,WAAmB,EACnB,OAA0D,EAC1D,KAAsD,EACtD,QAAwB;IAExB,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ;QAAE,QAAQ,CAAC,IAAI,CAAC,YAAY,OAAO,EAAE,CAAC,CAAC;IACpF,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ;YAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;QAC9E,QAAQ,CAAC,KAAK,CAAC,gBAAgB,KAAK,CAAC,WAAW,KAAK,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC;QAC7E,MAAM,IAAI,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IAC7C,CAAC;IACD,QAAQ,CAAC,IAAI,CAAC,qCAAqC,WAAW,EAAE,CAAC,CAAC;AACpE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitmagic/cli",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "Build Bitmagic games from your own agent tool",
   "type": "module",
   "bin": {