@kindgi/cli 0.1.8 → 0.1.9-rc.1

package/dist/feedback/report.js

@@ -0,0 +1,122 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright (C) 2026 Kindgi Inc.
+/**
+ * What `kindgi feedback submit` sends: the entries picked from `FEEDBACK.md`,
+ * their titles and bodies redacted, and the client's environment, checked
+ * against the intake's caps and turned into the exact bytes the person OKs.
+ * The digest is the sha256 of those bytes: `--yes=<digest>` sends them only
+ * if nothing changed since the preview.
+ */
+import { createHash } from 'node:crypto';
+import { AUTHORS, KINDS, SEVERITIES } from './entries.js';
+import { ARCH, DATE, ENTRY_HASH, ENTRY_ID, MAX_BODY_BYTES, MAX_CHECKS, MAX_ENTRIES, MAX_REQUEST_BYTES, MAX_TITLE_LENGTH, OS, OS_RELEASE, isVersion, } from './protocol.js';
+import { REDACTION_RULES, redactForSending, } from './redact.js';
+/** The entries to send: those named, or with none named, every one not yet sent and not fixed. */
+export function pickEntries(entries, selectors) {
+    if (selectors.length === 0) {
+        return {
+            kind: 'ok',
+            picked: entries.filter((e) => e.submissions.length === 0 && !e.fixed),
+        };
+    }
+    const unmatched = selectors.filter((s) => !entries.some((e) => e.fields.id === s || e.fields.hash === s));
+    if (unmatched.length > 0)
+        return { kind: 'unmatched', selectors: unmatched };
+    return {
+        kind: 'ok',
+        picked: entries.filter((e) => selectors.includes(e.fields.id ?? '') || selectors.includes(e.fields.hash ?? '')),
+    };
+}
+/** The client's environment: the doctor's checks as id and status only, never their text. */
+export function clientInfo(doctor, platform) {
+    return {
+        cli: isVersion(doctor.cliVersion) ? doctor.cliVersion : 'unknown',
+        os: OS.test(platform.os) ? platform.os : 'unknown',
+        osRelease: OS_RELEASE.test(platform.osRelease) ? platform.osRelease : 'unknown',
+        arch: ARCH.test(platform.arch) ? platform.arch : 'unknown',
+        node: platform.node,
+        language: doctor.project?.language ?? null,
+        checks: doctor.checks.slice(0, MAX_CHECKS).map((c) => ({ id: c.id, status: c.status })),
+    };
+}
+/** One entry as sent, its title and body redacted, or what stops it being sent. */
+export function entryPayload(entry, redaction) {
+    const f = entry.fields;
+    const name = f.id !== undefined && ENTRY_ID.test(f.id) ? f.id : `"${entry.title}"`;
+    const bad = (problem) => ({
+        kind: 'problem',
+        problem: { entry: name, problem },
+    });
+    if (f.id === undefined || !ENTRY_ID.test(f.id))
+        return bad('its id line (`- **id:** YYYY-MM-DD.N`) is missing or malformed');
+    if (f.hash === undefined || !ENTRY_HASH.test(f.hash))
+        return bad('its hash (`feedback-<8 hex>`) is missing or malformed');
+    if (!KINDS.includes(f.kind ?? ''))
+        return bad(`its kind must be one of ${KINDS.join(', ')}`);
+    if (!SEVERITIES.includes(f.severity ?? '')) {
+        return bad(`its severity must be one of ${SEVERITIES.join(', ')}`);
+    }
+    if (!AUTHORS.includes(f.by ?? ''))
+        return bad(`its by must be one of ${AUTHORS.join(', ')}`);
+    if (f.date === undefined || !DATE.test(f.date))
+        return bad('its date must be an ISO 8601 time in UTC, as `feedback write` writes it');
+    for (const key of ['sdk', 'cli']) {
+        const v = f[key];
+        if (v === undefined || !(v === 'unknown' || isVersion(v)))
+            return bad(`its ${key} must be a version or unknown`);
+    }
+    const title = redactForSending(entry.title.trim(), redaction);
+    const body = redactForSending(entry.body, redaction);
+    if (title.text === '')
+        return bad('its title is empty');
+    if (title.text.length > MAX_TITLE_LENGTH) {
+        return bad(`its title is ${title.text.length} characters; the intake takes at most ${MAX_TITLE_LENGTH}`);
+    }
+    const bodyBytes = Buffer.byteLength(body.text, 'utf8');
+    if (bodyBytes > MAX_BODY_BYTES) {
+        return bad(`its body is ${bodyBytes} bytes; the intake takes at most ${MAX_BODY_BYTES}: shorten it`);
+    }
+    return {
+        kind: 'ok',
+        payload: {
+            entry: f.id,
+            hash: f.hash,
+            title: title.text,
+            kind: f.kind,
+            severity: f.severity,
+            by: f.by,
+            date: f.date,
+            sdk: f.sdk,
+            cli: f.cli,
+            body: body.text,
+        },
+        applied: REDACTION_RULES.filter((r) => title.applied.includes(r) || body.applied.includes(r)),
+    };
+}
+/** The request body's bytes and their digest. */
+export function serialize(payload) {
+    const bytes = JSON.stringify(payload);
+    return { bytes, digest: createHash('sha256').update(bytes, 'utf8').digest('hex') };
+}
+/**
+ * The entries that fit one request: at most 20, at most 64 KiB in all, in
+ * the file's order. `held` is how many were left for the next run.
+ */
+export function fitRequest(client, entries) {
+    const fitted = [];
+    for (const entry of entries) {
+        if (fitted.length === MAX_ENTRIES)
+            break;
+        const next = [...fitted, entry];
+        if (Buffer.byteLength(serialize({ client, entries: next }).bytes, 'utf8') > MAX_REQUEST_BYTES)
+            break;
+        fitted.push(entry);
+    }
+    return { entries: fitted, held: entries.length - fitted.length };
+}
+/** Whether a request with these entries fits: for entries the person named, which are never left out. */
+export function fitsOneRequest(client, entries) {
+    return (entries.length <= MAX_ENTRIES &&
+        Buffer.byteLength(serialize({ client, entries }).bytes, 'utf8') <= MAX_REQUEST_BYTES);
+}
+//# sourceMappingURL=report.js.map

package/dist/feedback/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../src/feedback/report.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,iCAAiC;AAEjC;;;;;;GAMG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC,OAAO,EAAE,OAAO,EAAsB,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC9E,OAAO,EACL,IAAI,EAGJ,IAAI,EACJ,UAAU,EACV,QAAQ,EAER,cAAc,EACd,UAAU,EACV,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,EAAE,EACF,UAAU,EAEV,SAAS,GACV,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,eAAe,EAGf,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAgBrB,kGAAkG;AAClG,MAAM,UAAU,WAAW,CACzB,OAAiC,EACjC,SAA4B;IAI5B,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO;YACL,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;SACtE,CAAC;IACJ,CAAC;IACD,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAChC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,CACtE,CAAC;IACF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;IAC7E,OAAO;QACL,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,OAAO,CAAC,MAAM,CACpB,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CACxF;KACF,CAAC;AACJ,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,UAAU,CAAC,MAAoB,EAAE,QAAkB;IACjE,OAAO;QACL,GAAG,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;QACjE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;QAClD,SAAS,EAAE,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QAC/E,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC1D,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,IAAI,IAAI;QAC1C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;KACxF,CAAC;AACJ,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,YAAY,CAC1B,KAAoB,EACpB,SAA2B;IAQ3B,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;IACvB,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC;IACnF,MAAM,GAAG,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,CAAC;QAChC,IAAI,EAAE,SAAkB;QACxB,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE;KAClC,CAAC,CAAC;IACH,IAAI,CAAC,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,OAAO,GAAG,CAAC,gEAAgE,CAAC,CAAC;IAC/E,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAClD,OAAO,GAAG,CAAC,uDAAuD,CAAC,CAAC;IACtE,IAAI,CAAE,KAA2B,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QACtD,OAAO,GAAG,CAAC,2BAA2B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5D,IAAI,CAAE,UAAgC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;QAClE,OAAO,GAAG,CAAC,+BAA+B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,CAAE,OAA6B,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;QACtD,OAAO,GAAG,CAAC,yBAAyB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5D,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,OAAO,GAAG,CAAC,yEAAyE,CAAC,CAAC;IACxF,KAAK,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAU,EAAE,CAAC;QAC1C,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACjB,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;YACvD,OAAO,GAAG,CAAC,OAAO,GAAG,+BAA+B,CAAC,CAAC;IAC1D,CAAC;IACD,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACrD,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE;QAAE,OAAO,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACxD,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;QACzC,OAAO,GAAG,CACR,gBAAgB,KAAK,CAAC,IAAI,CAAC,MAAM,yCAAyC,gBAAgB,EAAE,CAC7F,CAAC;IACJ,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACvD,IAAI,SAAS,GAAG,cAAc,EAAE,CAAC;QAC/B,OAAO,GAAG,CACR,eAAe,SAAS,oCAAoC,cAAc,cAAc,CACzF,CAAC;IACJ,CAAC;IACD,OAAO;QACL,IAAI,EAAE,IAAI;QACV,OAAO,EAAE;YACP,KAAK,EAAE,CAAC,CAAC,EAAE;YACX,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,KAAK,EAAE,KAAK,CAAC,IAAI;YACjB,IAAI,EAAE,CAAC,CAAC,IAA4B;YACpC,QAAQ,EAAE,CAAC,CAAC,QAAoC;YAChD,EAAE,EAAE,CAAC,CAAC,EAAgB;YACtB,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,GAAG,EAAE,CAAC,CAAC,GAAa;YACpB,GAAG,EAAE,CAAC,CAAC,GAAa;YACpB,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB;QACD,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;KAC9F,CAAC;AACJ,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,SAAS,CAAC,OAAsB;IAI9C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACtC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AACrF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,MAAkB,EAClB,OAAgC;IAEhC,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW;YAAE,MAAM;QACzC,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,CAAC;QAChC,IAAI,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,iBAAiB;YAC3F,MAAM;QACR,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;AACnE,CAAC;AAED,yGAAyG;AACzG,MAAM,UAAU,cAAc,CAAC,MAAkB,EAAE,OAAgC;IACjF,OAAO,CACL,OAAO,CAAC,MAAM,IAAI,WAAW;QAC7B,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,iBAAiB,CACrF,CAAC;AACJ,CAAC"}

package/dist/feedback/run.d.ts

@@ -0,0 +1,21 @@
+import { type DoctorReport } from '../commands/doctor.js';
+import type { CommandResult } from '../commands/types.js';
+import type { CommandContext } from '../context.js';
+import { type Platform } from './report.js';
+/** Injectable seams, so tests run without the doctor's tools, a terminal or the real clock. */
+export interface FeedbackSeam {
+    /** Milliseconds since the epoch. */
+    readonly now?: () => number;
+    /** The checks sent with a report. Default: `kindgi doctor`'s, for the pack. */
+    readonly doctor?: (dir: string) => Promise<DoctorReport>;
+    readonly platform?: Platform;
+    /** Whether a person is at a terminal to ask. Default: stdin and stderr are TTYs. */
+    readonly interactive?: () => boolean;
+    readonly confirm?: (question: string) => Promise<boolean>;
+}
+/** The env var that turns `submit` off for a machine or a team. */
+export declare const SUBMIT_SWITCH = "KINDGI_FEEDBACK_SUBMIT";
+export declare function runSubmit(ctx: CommandContext): Promise<CommandResult>;
+export declare function runStatus(ctx: CommandContext): Promise<CommandResult>;
+export declare function runWithdraw(ctx: CommandContext): Promise<CommandResult>;
+//# sourceMappingURL=run.d.ts.map

package/dist/feedback/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/feedback/run.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,KAAK,YAAY,EAAa,MAAM,uBAAuB,CAAC;AAGrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AA0BpD,OAAO,EAEL,KAAK,QAAQ,EAOd,MAAM,aAAa,CAAC;AAUrB,+FAA+F;AAC/F,MAAM,WAAW,YAAY;IAC3B,oCAAoC;IACpC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IAC5B,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACzD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC7B,oFAAoF;IACpF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3D;AAED,mEAAmE;AACnE,eAAO,MAAM,aAAa,2BAA2B,CAAC;AAKtD,wBAAsB,SAAS,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAoB3E;AA4ND,wBAAsB,SAAS,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAkF3E;AAED,wBAAsB,WAAW,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAwE7E"}