@bussolabs/closeyourit-cli 0.24.2 → 0.25.0

package/README.md

@@ -162,6 +162,8 @@ CLOSEYOURIT_TOKEN=cyi_u_… CLOSEYOURIT_API_URL=https://www.closeyour.it \
 | `kb related <id> [--question <q>] [--links-only]` | Pages to read next: linked with `[[wiki links]]` plus close matches by meaning. |
 | `kb create [--project <id\|key>…] [--group <id\|name>…] [--tag <tag>…] --title <t> [--kind note\|decision\|guide] (--body <md> \| --body-file <path>) [--tech-spec <md> \| --tech-spec-file <path>] [--in-review] [--review-note <line>] [--author-origin <name>]` | Create a knowledge page (optional technical section, kept separate from the body). `--project`, `--group` and `--tag` are repeatable — a page can belong to several projects and groups at once, and to groups alone; at least one project or group is required. Length caps: title 255, body 4000, technical section 1500, review note 240 characters — every field over the cap is listed at once, before the call. With `--in-review` the page waits for a human and stays out of search, answers and related panels. `--author-origin` declares the assistant or skill that wrote the text, which is not the owner of the token. |
 | `kb publish --project <id\|key> --publication-key <key> --title <t> [--kind note\|decision\|guide] (--body <md> \| --body-file <path>)` | Create or update a knowledge page in one atomic call, keyed by a stable `--publication-key` (1-255 URL-safe characters). Safe to repeat: the same key always lands on the same page, and the output says whether it was `created` or `updated`. Exactly one body source is required. Omitting `--kind` keeps the kind the page already has (a new page is a `note`). Same title/body caps as `kb create`. |
+| `kb approve <id>` | Accept a page waiting for review: it enters search, answers and related panels. A human decision: a service token is refused, and a page the automatic reviewer rejected must be fixed and saved first. |
+| `kb reject <id>` | Discard a page waiting for review: it stays archived as rejected, out of search and answers, so it is not proposed again. Nothing is deleted. |
 | `kb consolidate <id> --path <doc-path>` | Mark an accepted page as written to the versioned docs, recording where the document lives. |
 | `kb update <id> [--title] [--kind] [--body \| --body-file] [--tech-spec \| --tech-spec-file] [--project <id\|key>…] [--group <id\|name>…] [--tag <tag>…] [--author-origin <name>]` | Update a page (unpassed fields keep their current value — including projects, groups, tags and attachments). Passing `--project`, `--group` or `--tag` **replaces** that list with what you name; `--tag ""` clears the tags. Changing only scope or tags never rewrites the text, so a concurrent edit is not overwritten. Same length caps as `kb create`; text already over the cap is refused only if it grows. |
 | `kb delete <id> --confirm` | Delete a knowledge page (irreversible). |

package/dist/base.js

@@ -207,10 +207,12 @@ class BaseCommand extends core_1.Command {
     async catch(error) {
         if (error instanceof api_1.ApiRequestError) {
             if (this.jsonEnabled()) {
-                this.logJson({ error: { code: error.code, message: error.message } });
+                this.logJson({ error: { code: error.code, message: error.message, ...(error.details === undefined ? {} : { details: error.details }) } });
             }
             else {
                 this.logToStderr(`${error.code}: ${error.message}`);
+                for (const line of reviewVerdictLines(error))
+                    this.logToStderr(line);
             }
             return this.exit(1);
         }
@@ -253,3 +255,31 @@ class BaseCommand extends core_1.Command {
     }
 }
 exports.BaseCommand = BaseCommand;
+/**
+ * The automatic reviewer of knowledge pages (R422-KNOWLEDGE-013, CYRA-764) answers with the whole
+ * verdict in `details`: every rule violated, the format it recognised, a suggested title, the page it
+ * looks like a duplicate of. The message carries only the first three rules, so a human reading the
+ * terminal would otherwise have to open the site to learn what to fix.
+ */
+function reviewVerdictLines(error) {
+    if (error.code !== 'R422-KNOWLEDGE-013' || typeof error.details !== 'object' || error.details === null)
+        return [];
+    const details = error.details;
+    const lines = [];
+    const violations = Array.isArray(details.violations) ? details.violations : [];
+    if (violations.length > 0) {
+        lines.push('Rules violated:');
+        for (const v of violations)
+            lines.push(`  ${v.code ?? '?'}${v.blocking === false ? ' (warning)' : ''}: ${v.message ?? ''}`);
+    }
+    if (details.format && details.format !== 'unknown')
+        lines.push(`Format recognised: ${details.format}`);
+    if (details.suggested_title)
+        lines.push(`Suggested title: ${details.suggested_title}`);
+    if (details.duplicate_of)
+        lines.push(`Looks like a duplicate of: ${details.duplicate_of}`);
+    if (Array.isArray(details.split_suggestion) && details.split_suggestion.length > 0) {
+        lines.push(`Split into: ${details.split_suggestion.join(' · ')}`);
+    }
+    return lines;
+}

package/dist/commands/kb/approve.d.ts

@@ -0,0 +1,15 @@
+import { BaseCommand } from '../../base';
+/**
+ * First step of the review flow: a page proposed with `kb create --in-review` enters the knowledge
+ * (search, answers, related panels). The server insists the decision comes from a person: a service
+ * token gets R403-KNOWLEDGE-005, and a page the automatic reviewer rejected must be fixed and saved
+ * first (R422-KNOWLEDGE-009).
+ */
+export default class KbApprove extends BaseCommand {
+    static args: {
+        id: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<unknown>;
+}

package/dist/commands/kb/approve.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const base_1 = require("../../base");
+const output_1 = require("../../lib/output");
+/**
+ * First step of the review flow: a page proposed with `kb create --in-review` enters the knowledge
+ * (search, answers, related panels). The server insists the decision comes from a person: a service
+ * token gets R403-KNOWLEDGE-005, and a page the automatic reviewer rejected must be fixed and saved
+ * first (R422-KNOWLEDGE-009).
+ */
+class KbApprove extends base_1.BaseCommand {
+    static args = {
+        id: core_1.Args.string({ description: 'Knowledge page id', required: true }),
+    };
+    static description = 'Accept a page waiting for review: it enters search, answers and related panels';
+    static examples = ['<%= config.bin %> kb approve <page-id>', '<%= config.bin %> kb approve <page-id> --json'];
+    async run() {
+        const { args } = await this.parse(KbApprove);
+        const res = await this.api.post(`/cli/v1/knowledge/pages/${args.id}/approve`);
+        if (!this.jsonEnabled()) {
+            this.log('Knowledge page accepted:');
+            this.log((0, output_1.renderRecord)(res.data ?? {}));
+        }
+        return res;
+    }
+}
+exports.default = KbApprove;

package/dist/commands/kb/reject.d.ts

@@ -0,0 +1,14 @@
+import { BaseCommand } from '../../base';
+/**
+ * Mirror of `kb approve`: the proposal stays archived as rejected — out of search, answers, related
+ * panels and lists — so whoever proposes can see it when hunting duplicates and not propose it again.
+ * Nothing is deleted (that is `kb delete`). A human decision, like approve.
+ */
+export default class KbReject extends BaseCommand {
+    static args: {
+        id: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<unknown>;
+}

package/dist/commands/kb/reject.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const base_1 = require("../../base");
+const output_1 = require("../../lib/output");
+/**
+ * Mirror of `kb approve`: the proposal stays archived as rejected — out of search, answers, related
+ * panels and lists — so whoever proposes can see it when hunting duplicates and not propose it again.
+ * Nothing is deleted (that is `kb delete`). A human decision, like approve.
+ */
+class KbReject extends base_1.BaseCommand {
+    static args = {
+        id: core_1.Args.string({ description: 'Knowledge page id', required: true }),
+    };
+    static description = 'Discard a page waiting for review: it stays archived as rejected, out of search and answers';
+    static examples = ['<%= config.bin %> kb reject <page-id>', '<%= config.bin %> kb reject <page-id> --json'];
+    async run() {
+        const { args } = await this.parse(KbReject);
+        const res = await this.api.post(`/cli/v1/knowledge/pages/${args.id}/reject`);
+        if (!this.jsonEnabled()) {
+            this.log('Knowledge page rejected:');
+            this.log((0, output_1.renderRecord)(res.data ?? {}));
+        }
+        return res;
+    }
+}
+exports.default = KbReject;