common-qa-mcp 0.2.0 → 0.3.0

package/dist/adapters/simplifyqa/adapter.d.ts

@@ -0,0 +1,154 @@
+import type { ConnectedQaConfig } from '../../config.js';
+import type { MakeClientOptions } from '../http.js';
+import type { ProjectInfo } from '../types.js';
+import type { ActionDef, CloudRunner, DatasetInfo, DefaultIteration, EntityRef, EnvInfo, Formula, FormulaCall, JournalOp, JournalView, LocalAgent, MemberOp, ModuleSummary, ObjectQuery, ProjectSummary, QaObject, ReleaseQuery, ReleaseSummary, RunOptions, RunRef, RunStatus, RunTarget, SaveGeneratedIterations, SaveGeneratedIterationsResult, SavedRef, SprintQuery, SprintSummary, Story, StoryQuery, StorySummary, Suite, SuiteSummary, TcQuery, TcSummary, TestCase } from '../../domain/types.js';
+/** Test seam identical to WalnutAdapter's — swap transport, keep real headers. */
+export type SimplifyQaTransport = Pick<MakeClientOptions, 'fetchImpl' | 'FormDataImpl' | 'BlobImpl'>;
+/**
+ * SimplifyQaAdapter — DIRECT-to-backend REST driver for SimplifyQA, mirroring WalnutAdapter's
+ * design. Reads (list/get for projects/testcases/suites/stories/modules/releases/sprints/objects)
+ * hit the SQA TM backend REST directly via a `QaHttp` bound to `cfg.baseUrl`. Anything not yet
+ * ported (writes, testdata, run dispatch, marketplace, and the recording surface) delegates to
+ * the LOCAL AGENT's `/mcp` (`cfg.url`) via a lazily-built RemoteMcpAdapter — same "graceful hop"
+ * pattern walnut uses for recording. When the hop is not configured, unported ops surface a clear
+ * error instead of failing silently.
+ *
+ * This class deliberately does not `implements ProviderAdapter` (walnut trick): the factory casts
+ * it, and tools that call ported methods get direct REST; tools that call unported methods get
+ * the hop (or a clear error). Each porting step replaces one more delegation with a direct call.
+ */
+export declare class SimplifyQaAdapter {
+    private readonly cfg;
+    private readonly http;
+    private agentHop;
+    private formulaCache;
+    constructor(cfg: ConnectedQaConfig, transport?: SimplifyQaTransport);
+    private headers;
+    private requireProjectId;
+    private searchBody;
+    /** Validates baseUrl + token + (optional) project by running the same list_projects search the
+     *  Java `infoResult` uses to resolve the project name — no separate /info endpoint on SQA. */
+    info(): Promise<ProjectInfo>;
+    /** `POST /pm/project/search` — projects the token can see. NOT project-scoped. */
+    listProjects(): Promise<ProjectSummary[]>;
+    listTestCases(q: TcQuery): Promise<TcSummary[]>;
+    /** Neutral test case, steps included. Accepts numeric id or business code (`TC_123`). */
+    getTestCase(id: string): Promise<TestCase>;
+    private fetchRawTestcase;
+    private fetchStepsCollection;
+    listSuites(): Promise<SuiteSummary[]>;
+    getSuite(id: string): Promise<Suite>;
+    listStories(q: StoryQuery): Promise<StorySummary[]>;
+    getStory(id: string): Promise<Story>;
+    /** A US_XXX business key → the numeric userstoryId via `/pm/userstory/search`. Numeric passes
+     *  through. SQA's GET-by-id parseInts the path, so a raw key would 404. */
+    private resolveStoryNumericId;
+    listModules(): Promise<ModuleSummary[]>;
+    listReleases(q: ReleaseQuery): Promise<ReleaseSummary[]>;
+    listSprints(q: SprintQuery): Promise<SprintSummary[]>;
+    getObject(id: string): Promise<QaObject>;
+    productUrlFor(entity: EntityRef): string;
+    private hop;
+    private requireHop;
+    /** Recording tool schemas from the SQA agent — mirrored so the recording passthrough can register
+     *  them. No agent configured → `[]`, so no recording tools get registered. */
+    listAgentTools(): Promise<Array<{
+        name: string;
+        description?: string;
+        inputSchema?: Record<string, unknown>;
+    }>>;
+    /** Forward a recording-tool call to the agent /mcp. Same behavior as walnut. */
+    callRaw(name: string, args: Record<string, unknown>): Promise<unknown>;
+    /** Two-step create: (1) resolve every `${name}` token in the steps to a project-scoped parameter id
+     *  (get-or-create), (2) POST /tm/testcase multipart with the assembled `testcaseObj`. */
+    createTestCase(tc: TestCase): Promise<SavedRef>;
+    /** Same shape as create, but with `tcfnObj.id` set and operation:'UPDATE'. */
+    updateTestCase(id: string, tc: TestCase): Promise<SavedRef>;
+    /** Soft-delete (recoverable via recycle bin). `isDelete:true` = delete; `false` = restore. */
+    deleteTestCase(id: string): Promise<void>;
+    /** Never throw on unresolvable storyRef — the Java code logs and moves on so the save still lands. */
+    private resolveStoryNumericIdOrNull;
+    /** Resolve every `${name}` token across every step to a SQA parameter id via get-or-create.
+     *  Name-uniqueness is project-wide on the backend; get-or-create means every TC using
+     *  `${appUrl}` links to the same parameter row. */
+    private resolveParamIds;
+    /** Case-insensitive project-scoped exact-name lookup. Backend duplicate-name check uses Mongo
+     *  collation strength:2, so a case-sensitive search here misses params stored under different
+     *  casing — the next POST then trips "Duplicate Name Error". Returns null when not found. */
+    private findParameterId;
+    private getOrCreateParameter;
+    createSuite(s: Suite): Promise<SavedRef>;
+    /** Fetch raw suite, apply add/remove/reorder ops in memory, then PUT the whole doc back with a
+     *  STRICT allow-listed payload (the SQA update validator rejects unknown keys on both suite-level
+     *  and testCases[] entries). */
+    updateSuiteMembers(id: string, ops: MemberOp[]): Promise<Suite>;
+    /** Soft-delete via `isDelete:true`. `isDelete:false` restores. */
+    deleteSuite(id: string): Promise<void>;
+    private fetchRawSuite;
+    /** Assemble the strict allow-listed suite entry for an ADD op. Required fields per the SQA
+     *  validator: testcaseId, code, seq (set by the caller), version, versionId, tcType. */
+    private buildSuiteEntryFromTestcase;
+    searchObjects(q: ObjectQuery): Promise<QaObject[]>;
+    createObject(o: QaObject): Promise<QaObject>;
+    actionsCatalog(platform?: string): Promise<ActionDef[]>;
+    /** Fetch the default (template) iteration row for a TC. Fills gaps from the raw TC:
+     *   - versionId: falls back through versionId → selectedVersionId → versionsDetails.id → versions[0].id
+     *   - executionType (required by the backend Mongo filter): read from raw TC, default AUTOMATION
+     *   - environmentType: caller value wins; else /pm/fields/8 first configured env; else 'general' */
+    getDefaultIteration(q: {
+        tcId: string;
+        versionId?: string;
+        environmentType?: string;
+    }): Promise<DefaultIteration>;
+    /** Persist N generated iteration rows. Rebuilds the name → paramId map from a fresh template
+     *  fetch — no cache, because a stale id would silently write to the wrong parameter. */
+    saveGeneratedIterations(payload: SaveGeneratedIterations): Promise<SaveGeneratedIterationsResult>;
+    /** Environment key: caller wins; else fetch the project's configured envs and pick the first;
+     *  else 'general' (matches the SQA UI fallback). */
+    private resolveEnvironment;
+    /** Parameter name lookup for paramId → name enrichment. Null when the parameter is deleted or
+     *  belongs to a different project. */
+    private fetchParameterName;
+    /** List every formula the current project can use — DEFAULT (customer-wide prefabs) unioned with
+     *  CUSTOM entries scoped to the customer or this project. The backend endpoint already returns the
+     *  union when called with `projectId`; we just normalise the doc shape and derive `scope` from
+     *  (type + projectId). Cached per adapter instance. */
+    listFormulas(): Promise<Formula[]>;
+    /** Evaluate one formula call and return { value, expression }. Order args by the formula's declared
+     *  parameter list so the stored `formulaValue` string is positional (`=NAME("a","b")`) — that's
+     *  what the SQA UI writes, and the backend just reads it verbatim on save. */
+    evaluateFormula(call: FormulaCall): Promise<{
+        value: string;
+        expression: string;
+    }>;
+    /** Real status of a run — reads step-level results direct from SQA REST because the desktop agent's
+     *  get_run only returns queue state (often stale). start/stop still hop for v1. */
+    getRun(runId: string): Promise<RunStatus>;
+    startRun(target: RunTarget, opts: RunOptions): Promise<RunRef>;
+    stopRun(runId: string): Promise<void>;
+    listCloudRunners(): Promise<CloudRunner[]>;
+    listLocalAgents(): Promise<LocalAgent[]>;
+    /**
+     * Pick THE ACTING USER'S OWN active agent — never row [0] of a shared-tenant roster (which
+     * would silently dispatch a local run to a teammate's box, and the run would sit queued until
+     * TTL because it lands in a Redis key that no local agent on the caller's machine polls).
+     *
+     * SQA's `machineRegistration` row carries no owner_user_id column (unlike walnut, which matches
+     * the JWT `id` claim to `owner_user_id`), so we identify "your" agent by hostname: common-mcp
+     * runs on the caller's own box in the typical MCP setup, and SQA `machineName` is either the
+     * bare OS hostname or a bracketed display form (`USER.NAME [ Hostname.local ]`) — both contain
+     * `os.hostname()`. Filter → active only → hostname substring match → return the single hit.
+     * Zero/many matches refuse honestly; a silent guess would just repeat the exact bug we're fixing.
+     *
+     * ponytail: hostname heuristic. Upgrade to owner-user-id match if the backend adds that column
+     * to machineRegistration (mirror walnut's `resolveLocalAgentCredential` at that point).
+     */
+    private resolveLocalAgentId;
+    private detectExecutionOS;
+    private buildRunPlatform;
+    listEnvironments(): Promise<EnvInfo[]>;
+    listDatasets(tcId?: string): Promise<DatasetInfo[]>;
+    readJournal(tcId: string): Promise<JournalView>;
+    editJournal(tcId: string, ops: JournalOp[]): Promise<JournalView>;
+}
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapters/simplifyqa/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/simplifyqa/adapter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAU,MAAM,YAAY,CAAC;AAE5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EACV,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,gBAAgB,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAC/F,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,cAAc,EAAE,QAAQ,EAClG,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,uBAAuB,EAC/F,6BAA6B,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,EACtF,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAChE,MAAM,uBAAuB,CAAC;AAS/B,kFAAkF;AAClF,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,iBAAiB,EAAE,WAAW,GAAG,cAAc,GAAG,UAAU,CAAC,CAAC;AAyFrG;;;;;;;;;;;;GAYG;AACH,qBAAa,iBAAiB;IAY1B,OAAO,CAAC,QAAQ,CAAC,GAAG;IAXtB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAiC;IAOjD,OAAO,CAAC,YAAY,CAAmC;gBAGpC,GAAG,EAAE,iBAAiB,EACvC,SAAS,CAAC,EAAE,mBAAmB;IAgBjC,OAAO,CAAC,OAAO;IAQf,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,UAAU;IAmBlB;kGAC8F;IACxF,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC;IAWlC,kFAAkF;IAC5E,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAezC,aAAa,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAkBrD,yFAAyF;IACnF,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;YAmBlC,gBAAgB;YAOhB,oBAAoB;IA0B5B,UAAU,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAWrC,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IASpC,WAAW,CAAC,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAgBnD,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAS1C;+EAC2E;YAC7D,qBAAqB;IAY7B,WAAW,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAcvC,YAAY,CAAC,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IASxD,WAAW,CAAC,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAWrD,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAS9C,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAUxC,OAAO,CAAC,GAAG;IAMX,OAAO,CAAC,UAAU;IAMlB;kFAC8E;IACxE,cAAc,IAAI,OAAO,CAAC,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAAC;IAKrH,gFAAgF;IAC1E,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAY5E;6FACyF;IACnF,cAAc,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAgBrD,8EAA8E;IACxE,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkBjE,8FAA8F;IACxF,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS/C,sGAAsG;YACxF,2BAA2B;IAUzC;;uDAEmD;YACrC,eAAe;IAe7B;;iGAE6F;YAC/E,eAAe;YAuBf,oBAAoB;IA6C5B,WAAW,CAAC,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC;IAS9C;;oCAEgC;IAC1B,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;IAgDrE,kEAAkE;IAC5D,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAS9B,aAAa;IAO3B;4FACwF;YAC1E,2BAA2B;IAyBnC,aAAa,CAAC,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAClD,YAAY,CAAC,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAG5C,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAM7D;;;wGAGoG;IAC9F,mBAAmB,CAAC,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA8CvH;4FACwF;IAClF,uBAAuB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAgEvG;wDACoD;YACtC,kBAAkB;IAYhC;0CACsC;YACxB,kBAAkB;IAahC;;;2DAGuD;IACjD,YAAY,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAqBxC;;kFAE8E;IACxE,eAAe,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAiCxF;uFACmF;IAC7E,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAiEzC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IA4H9D,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYrC,gBAAgB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAE1C,eAAe,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAuB9C;;;;;;;;;;;;;;OAcG;YACW,mBAAmB;IAiCjC,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,gBAAgB;IA8BlB,gBAAgB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAItC,YAAY,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAMnD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAG/C,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC;CAIxE"}