@autifyhq/aximo-cli 0.8.0 → 0.9.0

package/dist/types.d.ts

@@ -19,8 +19,12 @@ export interface ErrorEnvelope {
 export type Envelope<T> = SuccessEnvelope<T> | ErrorEnvelope;
 export type Platform = "ANDROID" | "IOS";
 export type FileType = "ANDROID_APP" | "IOS_APP";
+export type ExecutionMode = "parallel" | "sequential";
+export type CaseType = "web" | "mobile" | "desktop" | "multi_device";
+export type CaseFormat = "gherkin" | "markdown" | "plain_text";
 export interface HealthStatus {
     status: string;
+    auth?: string | undefined;
 }
 export interface CreateSessionInput {
     title: string;
@@ -75,11 +79,30 @@ export interface CaseRunStatus {
 export interface PlanRunInput {
     model?: string | undefined;
     mobileConfig?: Record<string, unknown> | undefined;
+    executionMode?: ExecutionMode | undefined;
 }
 export interface PlanRunResult {
     success: boolean;
     planRunId: string;
     totalCases: number;
+    executionMode?: ExecutionMode | undefined;
+}
+export interface UpdatePlanInput {
+    title?: string | undefined;
+    description?: string | undefined;
+    executionMode?: ExecutionMode | undefined;
+    stopOnFailure?: boolean | undefined;
+}
+export interface UpdatePlanResult {
+    success: boolean;
+    plan: {
+        id: string;
+        title: string;
+        description: string | null;
+        executionMode: ExecutionMode;
+        stopOnFailure: boolean;
+        updatedAt: string;
+    };
 }
 export interface PlanRun {
     id: string;
@@ -123,10 +146,10 @@ export interface Project {
 export interface CreateCaseInput {
     projectId: string;
     scenario: string;
-    type?: string | undefined;
+    type?: CaseType | undefined;
     title?: string | undefined;
     description?: string | undefined;
-    format?: string | undefined;
+    format?: CaseFormat | undefined;
     startUrl?: string | undefined;
     directoryId?: string | undefined;
 }
@@ -134,6 +157,28 @@ export interface CreateCaseResult {
     success: boolean;
     caseId: string;
 }
+export interface UpdateCaseInput {
+    title?: string | undefined;
+    description?: string | undefined;
+    scenario?: string | undefined;
+    type?: CaseType | undefined;
+    format?: CaseFormat | undefined;
+    startUrl?: string | undefined;
+}
+export interface UpdateCaseResult {
+    success: boolean;
+    case: {
+        id: string;
+        projectId: string;
+        type: string;
+        title: string;
+        description: string | null;
+        scenario: string;
+        format: string;
+        startUrl: string | null;
+        updatedAt: string;
+    };
+}
 export interface DeleteCaseResult {
     success: boolean;
 }
@@ -151,9 +196,9 @@ export interface PlanCaseResult {
 }
 export interface SaveSessionAsCaseInput {
     title?: string | undefined;
-    type?: string | undefined;
+    type?: Exclude<CaseType, "multi_device"> | undefined;
     scenario?: string | undefined;
-    format?: string | undefined;
+    format?: CaseFormat | undefined;
 }
 export interface SaveSessionAsCaseResult {
     success: boolean;

package/dist/validate.d.ts

@@ -1,10 +1,15 @@
-import type { Platform, FileType } from "./types.js";
+import type { CaseFormat, CaseType, ExecutionMode, FileType, Platform } from "./types.js";
 export declare function optionalString(name: string, value: unknown): string | undefined;
 export declare function parseStringList(name: string, value: unknown): string[] | undefined;
 export declare function requireString(name: string, value: unknown): string;
 export declare function requireId(name: string, value: unknown): string;
 export declare function parsePlatform(value: unknown): Platform | undefined;
 export declare function parseFileType(value: unknown): FileType | undefined;
+export declare function parseExecutionMode(value: unknown): ExecutionMode | undefined;
+export declare function parseCaseType(value: unknown): CaseType | undefined;
+export declare function parseSaveAsCaseType(value: unknown): Exclude<CaseType, "multi_device"> | undefined;
+export declare function parseCaseFormat(value: unknown): CaseFormat | undefined;
+export declare function parseOptionalBoolean(name: string, value: unknown): boolean | undefined;
 export declare function parseTags(value: unknown): string[] | undefined;
 export declare const OPENAPI_URL = "https://aximo.autify.com/openapi.yaml";
 export declare class JsonBodyError extends Error {

package/dist/validate.js

@@ -56,6 +56,52 @@ export function parseFileType(value) {
     }
     return value;
 }
+const EXECUTION_MODES = new Set(["parallel", "sequential"]);
+export function parseExecutionMode(value) {
+    if (value === undefined || value === "")
+        return undefined;
+    if (typeof value !== "string" || !EXECUTION_MODES.has(value)) {
+        throw new Error(`executionMode must be parallel or sequential (got ${String(value)})`);
+    }
+    return value;
+}
+const CASE_TYPES = new Set(["web", "mobile", "desktop", "multi_device"]);
+export function parseCaseType(value) {
+    if (value === undefined || value === "")
+        return undefined;
+    if (typeof value !== "string" || !CASE_TYPES.has(value)) {
+        throw new Error(`type must be web, mobile, desktop, or multi_device (got ${String(value)})`);
+    }
+    return value;
+}
+// save-as-case's server schema accepts a narrower set than case create/update.
+export function parseSaveAsCaseType(value) {
+    const parsed = parseCaseType(value);
+    if (parsed === "multi_device") {
+        throw new Error(`type must be web, mobile, or desktop (got ${String(value)})`);
+    }
+    return parsed;
+}
+const CASE_FORMATS = new Set(["gherkin", "markdown", "plain_text"]);
+export function parseCaseFormat(value) {
+    if (value === undefined || value === "")
+        return undefined;
+    if (typeof value !== "string" || !CASE_FORMATS.has(value)) {
+        throw new Error(`format must be gherkin, markdown, or plain_text (got ${String(value)})`);
+    }
+    return value;
+}
+// Tri-state boolean for PATCH-style flags: absent means "leave unchanged",
+// so a citty boolean (which defaults to false) would silently overwrite.
+export function parseOptionalBoolean(name, value) {
+    if (value === undefined || value === "")
+        return undefined;
+    if (value === true || value === "true")
+        return true;
+    if (value === false || value === "false")
+        return false;
+    throw new Error(`${name} must be true or false (got ${String(value)})`);
+}
 export function parseTags(value) {
     return parseStringList("tags", value);
 }

package/dist/validate.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { requireString, requireId, parsePlatform, parseFileType, parseTags, parseJsonObject, parseJsonBody, JsonBodyError, } from "./validate.js";
+import { requireString, requireId, parseCaseFormat, parseCaseType, parsePlatform, parseSaveAsCaseType, parseFileType, parseTags, parseJsonObject, parseJsonBody, JsonBodyError, } from "./validate.js";
 describe("requireId", () => {
     it("accepts plain IDs", () => {
         expect(requireId("sessionId", "abc123_-")).toBe("abc123_-");
@@ -94,3 +94,41 @@ describe("parseJsonObject", () => {
         expect(parseJsonObject("x", "")).toBeUndefined();
     });
 });
+describe("parseCaseType", () => {
+    it("accepts all case types", () => {
+        expect(parseCaseType("web")).toBe("web");
+        expect(parseCaseType("mobile")).toBe("mobile");
+        expect(parseCaseType("desktop")).toBe("desktop");
+        expect(parseCaseType("multi_device")).toBe("multi_device");
+    });
+    it("returns undefined for absent values", () => {
+        expect(parseCaseType(undefined)).toBeUndefined();
+        expect(parseCaseType("")).toBeUndefined();
+    });
+    it("rejects unknown values", () => {
+        expect(() => parseCaseType("banana")).toThrow(/must be web, mobile, desktop/);
+    });
+});
+describe("parseSaveAsCaseType", () => {
+    it("accepts the narrower save-as-case set", () => {
+        expect(parseSaveAsCaseType("web")).toBe("web");
+        expect(parseSaveAsCaseType("desktop")).toBe("desktop");
+    });
+    it("rejects multi_device, which the save-as-case endpoint does not accept", () => {
+        expect(() => parseSaveAsCaseType("multi_device")).toThrow(/must be web, mobile, or desktop/);
+    });
+});
+describe("parseCaseFormat", () => {
+    it("accepts all formats", () => {
+        expect(parseCaseFormat("gherkin")).toBe("gherkin");
+        expect(parseCaseFormat("markdown")).toBe("markdown");
+        expect(parseCaseFormat("plain_text")).toBe("plain_text");
+    });
+    it("returns undefined for absent values", () => {
+        expect(parseCaseFormat(undefined)).toBeUndefined();
+        expect(parseCaseFormat("")).toBeUndefined();
+    });
+    it("rejects unknown values", () => {
+        expect(() => parseCaseFormat("klingon")).toThrow(/must be gherkin, markdown, or plain_text/);
+    });
+});

package/package.json

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