@autifyhq/aximo-cli 0.15.0 → 0.16.0

package/dist/commands/session/cancel.js

@@ -0,0 +1,39 @@
+import { defineCommand } from "citty";
+import { request } from "../../client.js";
+import { handleApiError } from "../../errors.js";
+import { dryRunEnvelope } from "../../mutate.js";
+import { formatSuccess, printResult, validationError } from "../../output.js";
+import { requireId } from "../../validate.js";
+export async function runSessionCancel(options, deps) {
+    let sessionId;
+    try {
+        sessionId = requireId("sessionId", options.sessionId);
+    }
+    catch (err) {
+        return validationError(err);
+    }
+    const path = `/api/sessions/${encodeURIComponent(sessionId)}/cancel`;
+    if (options.dryRun) {
+        return dryRunEnvelope("POST", path);
+    }
+    try {
+        const res = await request(path, { method: "POST" }, deps ?? {});
+        return formatSuccess(res);
+    }
+    catch (err) {
+        return handleApiError(err);
+    }
+}
+export default defineCommand({
+    meta: {
+        name: "cancel",
+        description: "Cancel a queued or running session (stops it on its device)",
+    },
+    args: {
+        sessionId: { type: "positional", description: "Session ID", required: true },
+        "dry-run": { type: "boolean", description: "Validate and show request without calling API" },
+    },
+    async run({ args }) {
+        printResult(await runSessionCancel({ sessionId: args.sessionId, dryRun: args["dry-run"] }));
+    },
+});

package/dist/commands/session/index.js

@@ -4,6 +4,7 @@ export default defineCommand({
     subCommands: {
         create: () => import("./create.js").then((m) => m.default),
         get: () => import("./get.js").then((m) => m.default),
+        cancel: () => import("./cancel.js").then((m) => m.default),
         export: () => import("./export.js").then((m) => m.default),
         "save-as-case": () => import("./save-as-case.js").then((m) => m.default),
     },

package/dist/commands/session/session.test.js

@@ -3,6 +3,7 @@ import { tmpdir } from "node:os";
 import { join, resolve } from "node:path";
 import { afterAll, afterEach, beforeAll, describe, expect, it } from "vitest";
 import { server, http, HttpResponse, TEST_BASE_URL } from "../../test-utils.js";
+import { runSessionCancel } from "./cancel.js";
 import { runSessionCreate } from "./create.js";
 import { runSessionExport } from "./export.js";
 import { runSessionGet } from "./get.js";
@@ -130,6 +131,43 @@ describe("runSessionGet", () => {
             expect(result.error.code).toBe("not_found");
     });
 });
+describe("runSessionCancel", () => {
+    it("POSTs the cancel endpoint and returns the terminated session", async () => {
+        let method;
+        server.use(http.post(`${TEST_BASE_URL}/api/sessions/s1/cancel`, ({ request: req }) => {
+            method = req.method;
+            return HttpResponse.json({ success: true, sessionId: "s1", status: "terminated" });
+        }));
+        const result = await runSessionCancel({ sessionId: "s1" });
+        expect(method).toBe("POST");
+        expect(result).toEqual({
+            ok: true,
+            data: { success: true, sessionId: "s1", status: "terminated" },
+        });
+    });
+    it("shows the request without calling the API on --dry-run", async () => {
+        const result = await runSessionCancel({ sessionId: "s1", dryRun: true });
+        expect(result).toEqual({
+            ok: true,
+            data: { dryRun: true, method: "POST", url: `${TEST_BASE_URL}/api/sessions/s1/cancel` },
+        });
+    });
+    it("rejects an empty id", async () => {
+        const result = await runSessionCancel({ sessionId: "" });
+        expect(result.ok).toBe(false);
+        if (!result.ok)
+            expect(result.error.code).toBe("validation_error");
+    });
+    it("maps a finished session to conflict without the archive hint", async () => {
+        server.use(http.post(`${TEST_BASE_URL}/api/sessions/s1/cancel`, () => HttpResponse.json({ error: "Cannot cancel a session that has already finished" }, { status: 409 })));
+        const result = await runSessionCancel({ sessionId: "s1" });
+        expect(result.ok).toBe(false);
+        if (!result.ok) {
+            expect(result.error.code).toBe("conflict");
+            expect(result.error.hint).toBeUndefined();
+        }
+    });
+});
 describe("runSessionExport", () => {
     const sessionId = "44444444-4444-4444-9444-444444444444";
     const defaultPdf = resolve(`${sessionId}.pdf`);

package/dist/errors.d.ts

@@ -2,6 +2,8 @@ import type { ErrorEnvelope } from "./types.js";
 export declare function describeDetails(details: unknown): string | undefined;
 export declare function withDetails(message: string, details: unknown): string;
 export declare function featureHint(message: string, details: unknown): string | undefined;
+export declare const CREDIT_HINT = "The organization is out of credits. Ask an Aximo organization admin to add credits, then retry.";
+export declare function creditHint(message: string): string | undefined;
 export declare const ARCHIVE_FIRST_HINT = "Archive the resource first, then retry: `aximo case archive <caseId>` / `aximo plan archive <planId>` (MCP: aximo_archive_case / aximo_archive_plan).";
 export declare function isArchiveFirstConflict(message: string): boolean;
 export declare function handleApiError(error: unknown): ErrorEnvelope;

package/dist/errors.js

@@ -85,6 +85,10 @@ export function featureHint(message, details) {
     }
     return undefined;
 }
+export const CREDIT_HINT = "The organization is out of credits. Ask an Aximo organization admin to add credits, then retry.";
+export function creditHint(message) {
+    return /insufficient credits/i.test(message) ? CREDIT_HINT : undefined;
+}
 const NOT_FOUND_HINT = "Check the ID exists and you have access. List resources: aximo project list / aximo device list / aximo upload list";
 const AUTH_HINT = "Run `aximo configure` to save credentials, or set AXIMO_API_KEY via `export AXIMO_API_KEY=your-key` or `node --env-file=.env`.";
 // 403 is a permission outcome, not a credentials problem, so it no longer routes
@@ -142,6 +146,7 @@ export function handleApiError(error) {
             // when the server says which role is missing. Never the credentials hint: a
             // 403 means the key is valid.
             const hint = featureHint(error.message, details) ??
+                creditHint(error.message) ??
                 (/admin|owner/i.test(message) ? ADMIN_ROLE_HINT : undefined);
             return formatError("forbidden", message, false, hint);
         }

package/dist/errors.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { describeDetails, featureHint, handleApiError, withDetails } from "./errors.js";
+import { CREDIT_HINT, describeDetails, featureHint, handleApiError, withDetails, } from "./errors.js";
 function httpErr(status, message = `status ${status}`, retryAfter) {
     const err = Object.assign(new Error(message), { status });
     if (retryAfter !== undefined)
@@ -27,6 +27,11 @@ describe("handleApiError", () => {
         expect(r.error.code).toBe("forbidden");
         expect(r.error.hint).toContain("admin or owner");
     });
+    it("adds the credit hint when the organization is out of credits", () => {
+        const r = handleApiError(httpErr(403, "Insufficient credits to start session"));
+        expect(r.error.code).toBe("forbidden");
+        expect(r.error.hint).toBe(CREDIT_HINT);
+    });
     it("maps 404 to not_found with list hint", () => {
         const r = handleApiError(httpErr(404));
         expect(r.error.code).toBe("not_found");

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export { runPlanRemoveCase } from "./commands/plan/remove-case.js";
 export { runProjectList } from "./commands/project/list.js";
 export { runSessionCreate } from "./commands/session/create.js";
 export { runSessionGet } from "./commands/session/get.js";
+export { runSessionCancel } from "./commands/session/cancel.js";
 export { runSessionSaveAsCase } from "./commands/session/save-as-case.js";
 export { runTriggerCaseGet } from "./commands/trigger/case/get.js";
 export { runTriggerCaseRun } from "./commands/trigger/case/run.js";

package/dist/index.js

@@ -11,6 +11,7 @@ export { runPlanRemoveCase } from "./commands/plan/remove-case.js";
 export { runProjectList } from "./commands/project/list.js";
 export { runSessionCreate } from "./commands/session/create.js";
 export { runSessionGet } from "./commands/session/get.js";
+export { runSessionCancel } from "./commands/session/cancel.js";
 export { runSessionSaveAsCase } from "./commands/session/save-as-case.js";
 export { runTriggerCaseGet } from "./commands/trigger/case/get.js";
 export { runTriggerCaseRun } from "./commands/trigger/case/run.js";

package/dist/types.d.ts

@@ -305,6 +305,11 @@ export interface CreatePlanResult {
 export interface PlanCaseResult {
     success: boolean;
 }
+export interface CancelSessionResult {
+    success: boolean;
+    sessionId: string;
+    status: "terminated";
+}
 export interface SaveSessionAsCaseInput {
     title?: string | undefined;
     type?: Exclude<CaseType, "multi_device"> | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autifyhq/aximo-cli",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Autify Aximo Command Line Interface (CLI)",
   "keywords": [
     "autify",