@qawolf/ci-sdk 3.0.0 → 3.1.0

package/dist/lib/sdk/index.d.ts

@@ -4,7 +4,37 @@ export declare function makeQaWolfSdk({ apiKey, serviceBase, userAgent, }: {
     serviceBase?: string;
     userAgent?: string;
 }, { fetch, log, }?: Partial<SdkDependencies>): {
+    /**
+     * @deprecated Reports through the legacy `deploy_success` webhook, which
+     * triggers do not see. Use `deployment.reportStatus` instead.
+     */
     attemptNotifyDeploy: (config: Partial<import("./domain/attemptDeploy/deployConfig.js").DeployConfig>) => Promise<import("./domain/attemptDeploy/types.js").NotifyDeployStatus>;
+    deployment: {
+        reportStatus: (params: {
+            providerDeploymentId: string;
+            status: "success" | "pending" | "failure" | "inactive";
+            workspaceId: string;
+            deployTarget?: string | undefined;
+            environment?: {
+                id: string;
+            } | {
+                name: string;
+                baseEphemeralEnvironment?: string | undefined;
+                ephemeral?: boolean | undefined;
+            } | undefined;
+            environmentVariables?: Record<string, string> | undefined;
+            metadata?: {
+                commitAuthorName?: string | undefined;
+                commitMessage?: string | undefined;
+                commitSha?: string | undefined;
+                commitUrl?: string | undefined;
+                pullRequestNumber?: number | undefined;
+                ref?: string | undefined;
+                repository?: string | undefined;
+            } | undefined;
+            service?: string | undefined;
+        }) => Promise<import("./domain/reportDeployment/types.js").ReportDeploymentResult>;
+    };
     generateSignedUrlForRunInputsExecutablesStorage: (config: import("./domain/generateSignedUrls/types.js").GenerateSignedUrlConfig) => Promise<import("./domain/generateSignedUrls/types.js").GenerateSignedUrlStatus>;
     generateSignedUrlForTempTeamStorage: (config: import("./domain/generateSignedUrls/types.js").GenerateSignedUrlConfig) => Promise<{
         fileLocation?: string;
@@ -19,9 +49,14 @@ export declare function makeQaWolfSdk({ apiKey, serviceBase, userAgent, }: {
     }>;
     makePollCiGreenlightStatusIterator: (args_0: import("./domain/pollCiGreenlight/types.js").MakePollCiGreenlightStatusIteratorParams) => AsyncGenerator<import("./domain/pollCiGreenlight/types.js").PollCiGreenlightIteration, void, unknown>;
     notifyTerminatedEphemeralEnvironment: (config: import("./domain/notifyTerminatedEphemeralEnvironment/types.js").NotifyTerminatedEphemeralEnvironmentInput) => Promise<import("./domain/notifyTerminatedEphemeralEnvironment/types.js").NotifyTerminatedEphemeralEnvironmentResult>;
+    /**
+     * @deprecated Polls a run id that only `attemptNotifyDeploy` returns, so it
+     * keeps the pipeline on the legacy `deploy_success` webhook.
+     */
     pollCiGreenlightStatus: (args_0: import("./domain/pollCiGreenlight/types.js").PollCiGreenlightParams) => Promise<import("./domain/pollCiGreenlight/types.js").PollCiGreenlightStatus>;
 };
 export type * from "./domain/attemptDeploy/index.js";
 export type * from "./domain/generateSignedUrls/types.js";
 export type * from "./domain/notifyTerminatedEphemeralEnvironment/types.js";
 export type * from "./domain/pollCiGreenlight/types.js";
+export type * from "./domain/reportDeployment/types.js";

package/dist/lib/sdk/publicApi/callContract.d.ts

@@ -0,0 +1,39 @@
+import type { z } from "zod";
+import type { ApiConfig } from "../../api-types.js";
+import type { SdkDependencies } from "../dependencies.js";
+/**
+ * The structural shape of a `@qawolf/api-contracts` contract. Declared here
+ * because the package exports the contracts but not the type describing them.
+ */
+export type PublicApiContract<InputData = unknown, OutputData = unknown> = {
+    input: z.ZodType<unknown, InputData>;
+    name: string;
+    output: z.ZodType<OutputData>;
+};
+export type PublicApiCallFailure = {
+    /** The QA Wolf incident id to quote to support, when the server sent one. */
+    eventId: string | undefined;
+    httpStatus: number;
+    /** The server's explanation of the refusal, when it sent one. */
+    message: string | undefined;
+    outcome: "http-error";
+} | {
+    outcome: "network-error";
+}
+/** The server answered 2xx with a body the contract's output rejects. */
+ | {
+    outcome: "invalid-response-body";
+};
+export type PublicApiCallResult<Data> = {
+    data: Data;
+    outcome: "ok";
+} | PublicApiCallFailure;
+/**
+ * Calls one public API contract and validates the answer with that contract's
+ * own output schema, so a caller reads the contract's types rather than a
+ * hand-written copy of them.
+ */
+export declare function callPublicContract<InputData, OutputData>({ fetch: localFetch, log }: SdkDependencies, apiConfig: ApiConfig, { contract, input, }: {
+    contract: PublicApiContract<InputData, OutputData>;
+    input: InputData;
+}): Promise<PublicApiCallResult<OutputData>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qawolf/ci-sdk",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "private": false,
   "description": "A simple SDK for interacting with QAWolf in CI scripts.",
   "keywords": [],
@@ -23,18 +23,20 @@
     "lint:ci": "npm run lint:first-half; FIRST_HALF_EXIT=$?; npm run lint:second-half && exit $FIRST_HALF_EXIT",
     "lint:dev": "npm run lint:first-half",
     "lint:first-half": "oxlint . --fix --quiet --report-unused-disable-directives --type-aware && oxfmt --write .",
-    "lint:second-half": "dpdm --exit-code circular:1 --no-tree --no-warning --transform --include='.*' --exclude='/(dist|node_modules)/' '**/*'",
+    "lint:second-half": "rev-dep config run",
     "prepublishOnly": "nx run ci-sdk:build",
     "test": "NODE_OPTIONS=\"--experimental-vm-modules\" NODE_NO_WARNINGS=1 jest",
     "tsc:check": "tsc --noEmit"
   },
   "dependencies": {
+    "@qawolf/api-contracts": ">=0.68.0",
     "@qawolf/ci-utils": "^2.0.0",
     "@sinonjs/fake-timers": "^10.3.0",
-    "tslib": "^2.6.2"
+    "tslib": "^2.6.2",
+    "zod": "^4.1.11"
   },
   "devDependencies": {
-    "@qawolf/platform-builder": "^1.2.3",
+    "@qawolf/platform-builder": "^1.2.7",
     "tsx": "^4.19.4",
     "typescript": "^5.9.3"
   },