@qawolf/ci-sdk 0.13.0 → 0.15.0

package/.eslintrc.json

@@ -0,0 +1,27 @@
+/**
+ * ESLint config files allow comments, so please comment all changes you make here.
+ * Unless you are changing a rule for reasons very specific to this project, you
+ * should consider making the change in our @qawolf base config instead. There is
+ * also a `.eslintrc.json` file in this repo root folder for any rules that we want
+ * in this repo but not necessarily in other repos that use our @qawolf base config.
+ */
+{
+  "root": true,
+  "rules": {
+    "no-restricted-imports": [
+      "error",
+      {
+        // playground-* and runner-* packages are only to be
+        // imported by playgrounds and runners and their packages
+        "patterns": ["@qawolf/playground-*", "@qawolf/runner-*"]
+      }
+    ]
+  },
+  "extends": [
+    "@qawolf",
+    "plugin:react/recommended",
+    "plugin:react-hooks/recommended",
+    "../../.eslintrc.json"
+  ],
+  "ignorePatterns": ["!**/*", "/**/*.js", "/**/*.d.ts", "dist", "node_modules"]
+}

package/README.md

@@ -83,6 +83,36 @@ const { pollCiGreenlightStatus } = makeQaWolfSdk({
 })();
 ```
 
+## Example: pull request testing
+
+> :warning: This section is not covered by SemVer and will change.
+
+```ts
+const details: {
+  baseEnvironmentId: string | undefined;
+  branch: string;
+  commitUrl: string;
+  deploymentUrl: string | undefined;
+  pr: { number: number; title: string } | undefined;
+  qaWolfTeamId: string;
+  // company/repository
+  repoFullName: string;
+  sha: string;
+  variables: { [key: string]: string };
+} = {};
+const result = await sdk.experimental_testPreview(detail);
+if (result.outcome !== "success") {
+  console.error(result);
+  throw Error("Creating a test failed");
+}
+```
+
+Then, after the PR has been closed:
+
+```js
+await sdk.experimental_removeEnvironment({ branch: "" });
+```
+
 ## Versioning
 
 This package follows the [SemVer](https://semver.org/) versioning scheme. Additional notes:
@@ -101,6 +131,16 @@ an up-to-date API usage version.
 
 # Changelog
 
+## v0.15.0
+
+- New `experimental_testPreview` and `experimental_deleteEnvironment` methods.
+
+## v0.14.0
+
+- New `failReason`, `abortReason` and `httpStatus` fields added to the `attemptNotifyDeploy`
+  function result object to provide more context on why the operation failed or was aborted.
+- Exported missing TypeScript typings describing result objects and fields for both functions.
+
 ## v0.13.0
 
 - New `pollTimeout` parameter for `pollCiGreenlightStatus` to allow for a custom
@@ -138,7 +178,7 @@ BREAKING CHANGES:
 
 BREAKING CHANGES:
 
-- Renamed `attemptDeploy` to `attemptNotifyDeploy`.
+- Renamed `attemptDeploy` to `attemptNotifyDeploy` .
 
 ## v0.10.2
 

package/dist/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./lib/sdk/index.js";
+export * from "./lib/sdk/dependencies.js";
+export type { CiGreenlightStatus, CiGreenlightStatusBase, DeployConfig, DeployStatus, } from "./lib/api/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,YAAY,EACV,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,EACZ,YAAY,GACb,MAAM,oBAAoB,CAAC"}

package/dist/cjs/index.js

@@ -1,18 +1,6 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./lib/sdk/index.js"), exports);
-__exportStar(require("./lib/sdk/dependencies.js"), exports);
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/sdk/index.js"), exports);
+tslib_1.__exportStar(require("./lib/sdk/dependencies.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,oEAA0C"}

package/dist/cjs/lib/api/ci-greenlight.d.ts

@@ -0,0 +1,114 @@
+import { type ApiConfig } from "../api-types.js";
+import { type SdkDependencies } from "../sdk/dependencies.js";
+export type CiGreenlightBugDetails = {
+    /**
+     * The URL of this BR in the QAWolf application.
+     */
+    applicationUrl: string;
+    /**
+     * If this bug report is linked to an external issue, it will
+     * show up here.
+     */
+    externalIssue: {
+        /**
+         * The URL of the external issue in the external platform
+         * application.
+         */
+        applicationUrl: string;
+        /**
+         * The ID of this issue in the external platform.
+         */
+        externalIssueId: string;
+        /**
+         * Lowercase platform name (e.g. "jira").
+         */
+        platform: string;
+    } | undefined;
+    /**
+     * True if the bug is blocking.
+     */
+    isBlocking: boolean;
+    /**
+     * True if the bug has been found in this run.
+     */
+    isNew: boolean;
+    /**
+     * The name of this bug.
+     */
+    name: string;
+    /**
+     * The bug number.
+     */
+    number: number;
+    /**
+     * The priority of this bug.
+     */
+    priority: "medium" | "unprioritized" | "low" | "high" | "urgent";
+};
+export type CiGreenlightCompletedSuiteDetails = {
+    blockingBugsCount: number;
+    blockingBugUrls: string[];
+    nonBlockingBugsCount: number;
+    nonBlockingBugUrls: string[];
+    reproducedBugs: CiGreenlightBugDetails[];
+};
+export type CiGreenlightStatusBase = {
+    relevantRunId: string;
+    relevantRunUrl: string;
+    relevantRunWithBugsUrl: string;
+    rootRunId: string;
+    rootRunUrl: string;
+    workflowsDisabledAfterRunCount: number;
+    workflowsInRunCount: number;
+    workflowsUnderInvestigationCount: number;
+};
+/**
+ * The status of a CI greenlight run. See the API documentation here for
+ * more details: https://qawolf.notion.site/1b170576efea411fa785842a71e7c99e
+ */
+export type CiGreenlightStatus = CiGreenlightStatusBase & ({
+    blockingBugsCount: number;
+    blockingBugUrls: string[];
+    greenlight: boolean;
+    nonBlockingBugsCount: number;
+    nonBlockingBugUrls: string[];
+    reproducedBugs: CiGreenlightBugDetails[];
+    runStage: "completed";
+} | {
+    greenlight: false;
+    runStage: "initializing" | "underReview" | "canceled";
+});
+export declare function fetchCiGreenlightStatus({ serviceBase, apiKey }: ApiConfig, { runId, }: {
+    runId: string;
+}, { fetch: localFetch }: SdkDependencies): Promise<{
+    readonly greenlightStatus: CiGreenlightStatus;
+    readonly httpStatus: number;
+    readonly ok: true;
+    readonly canRetry?: undefined;
+    readonly errorType?: undefined;
+} | {
+    readonly canRetry: true;
+    readonly errorType: "not-found";
+    readonly httpStatus: 404;
+    readonly ok: false;
+    readonly greenlightStatus?: undefined;
+} | {
+    readonly canRetry: true;
+    readonly errorType: "server";
+    readonly httpStatus: number;
+    readonly ok: false;
+    readonly greenlightStatus?: undefined;
+} | {
+    readonly canRetry: false;
+    readonly errorType: "client";
+    readonly httpStatus: number;
+    readonly ok: false;
+    readonly greenlightStatus?: undefined;
+} | {
+    readonly canRetry: true;
+    readonly errorType: "network";
+    readonly httpStatus: 0;
+    readonly ok: false;
+    readonly greenlightStatus?: undefined;
+}>;
+//# sourceMappingURL=ci-greenlight.d.ts.map

package/dist/cjs/lib/api/ci-greenlight.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ci-greenlight.d.ts","sourceRoot":"","sources":["../../../../src/lib/api/ci-greenlight.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,aAAa,EACT;QACE;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QACvB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QACxB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB,GACD,SAAS,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,eAAe,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;CAClE,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,cAAc,EAAE,sBAAsB,EAAE,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B,EAAE,MAAM,CAAC;IACvC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,gCAAgC,EAAE,MAAM,CAAC;CAC1C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,sBAAsB,GACrD,CACI;IACE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,UAAU,EAAE,OAAO,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,cAAc,EAAE,sBAAsB,EAAE,CAAC;IACzC,QAAQ,EAAE,WAAW,CAAC;CACvB,GACD;IACE,UAAU,EAAE,KAAK,CAAC;IAClB,QAAQ,EAAE,cAAc,GAAG,aAAa,GAAG,UAAU,CAAC;CACvD,CACJ,CAAC;AAEJ,wBAAsB,uBAAuB,CAC3C,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,SAAS,EAClC,EACE,KAAK,GACN,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;CACf,EACD,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDvC"}

package/dist/cjs/lib/api/ci-greenlight.js

@@ -34,6 +34,7 @@ async function fetchCiGreenlightStatus({ serviceBase, apiKey }, { runId, }, { fe
         }
         return {
             canRetry: false,
+            errorType: "client",
             httpStatus: resp.status,
             ok: false,
         };
@@ -48,3 +49,4 @@ async function fetchCiGreenlightStatus({ serviceBase, apiKey }, { runId, }, { fe
     }
 }
 exports.fetchCiGreenlightStatus = fetchCiGreenlightStatus;
+//# sourceMappingURL=ci-greenlight.js.map

package/dist/cjs/lib/api/ci-greenlight.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ci-greenlight.js","sourceRoot":"","sources":["../../../../src/lib/api/ci-greenlight.ts"],"names":[],"mappings":";;;AA2FO,KAAK,UAAU,uBAAuB,CAC3C,EAAE,WAAW,EAAE,MAAM,EAAa,EAClC,EACE,KAAK,GAGN,EACD,EAAE,KAAK,EAAE,UAAU,EAAmB;IAEtC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,UAAU,CAC3B,IAAI,GAAG,CACL,yBAAyB,kBAAkB,CAAC,KAAK,CAAC,EAAE,EACpD,WAAW,CACZ,EACD;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,MAAM,EAAE;aAClC;SACF,CACF,CAAC;QAEF,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,gBAAgB,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAuB,CAAC;YACnE,OAAO;gBACL,gBAAgB;gBAChB,UAAU,EAAE,IAAI,CAAC,MAAM;gBACvB,EAAE,EAAE,IAAI;aACA,CAAC;QACb,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACxB,OAAO;gBACL,QAAQ,EAAE,IAAI;gBACd,SAAS,EAAE,WAAW;gBACtB,UAAU,EAAE,IAAI,CAAC,MAAM;gBACvB,EAAE,EAAE,KAAK;aACD,CAAC;QACb,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACvB,OAAO;gBACL,QAAQ,EAAE,IAAI;gBACd,SAAS,EAAE,QAAQ;gBACnB,UAAU,EAAE,IAAI,CAAC,MAAM;gBACvB,EAAE,EAAE,KAAK;aACD,CAAC;QACb,CAAC;QACD,OAAO;YACL,QAAQ,EAAE,KAAK;YACf,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE,IAAI,CAAC,MAAM;YACvB,EAAE,EAAE,KAAK;SACD,CAAC;IACb,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO;YACL,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,CAAC;YACb,EAAE,EAAE,KAAK;SACD,CAAC;IACb,CAAC;AACH,CAAC;AA5DD,0DA4DC"}

package/dist/cjs/lib/api/deploy.d.ts

@@ -0,0 +1,72 @@
+import { type ApiConfig } from "../api-types.js";
+import { type SdkDependencies } from "../sdk/dependencies.js";
+/**
+ * Refer to our official documentation for more information:
+ * https://qawolf.notion.site/dd72e46ceb7f451dae4e9ef06f64a2cc
+ */
+export type DeployConfig = {
+    branch: string | undefined;
+    commitUrl: string | undefined;
+    deduplicationKey: string | undefined;
+    deploymentType: string | undefined;
+    deploymentUrl: string | undefined;
+    hostingService: "GitHub" | "GitLab" | undefined;
+    sha: string | undefined;
+    variables: Record<string, string> | undefined;
+};
+export type DeployStatus = {
+    results: Array<{
+        created_suite_id?: string;
+        failure_reason?: string;
+    }>;
+};
+export declare function postDeploySuccess({ apiKey, serviceBase }: ApiConfig, { branch, commitUrl, deduplicationKey, deploymentType, deploymentUrl, hostingService, sha, variables, }: Partial<DeployConfig>, { fetch: localFetch }: SdkDependencies): Promise<{
+    readonly failureReason: "no-matched-trigger";
+    readonly success: false;
+    readonly details?: undefined;
+    readonly runId?: undefined;
+    readonly httpStatus?: undefined;
+} | {
+    readonly details: string;
+    readonly failureReason: "run-could-not-be-created";
+    readonly success: false;
+    readonly runId?: undefined;
+    readonly httpStatus?: undefined;
+} | {
+    readonly runId: string;
+    readonly success: true;
+    readonly failureReason?: undefined;
+    readonly details?: undefined;
+    readonly httpStatus?: undefined;
+} | {
+    readonly failureReason: "5XX-server-error";
+    readonly httpStatus: number;
+    readonly success: false;
+    readonly details?: undefined;
+    readonly runId?: undefined;
+} | {
+    readonly failureReason: "401-unauthorized";
+    readonly httpStatus: 401;
+    readonly success: false;
+    readonly details?: undefined;
+    readonly runId?: undefined;
+} | {
+    readonly failureReason: "403-forbidden";
+    readonly httpStatus: 403;
+    readonly success: false;
+    readonly details?: undefined;
+    readonly runId?: undefined;
+} | {
+    readonly failureReason: "4XX-client-error";
+    readonly httpStatus: number;
+    readonly success: false;
+    readonly details?: undefined;
+    readonly runId?: undefined;
+} | {
+    readonly failureReason: "network-error";
+    readonly success: false;
+    readonly details?: undefined;
+    readonly runId?: undefined;
+    readonly httpStatus?: undefined;
+}>;
+//# sourceMappingURL=deploy.d.ts.map

package/dist/cjs/lib/api/deploy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../../src/lib/api/deploy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,cAAc,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IAChD,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,KAAK,CAAC;QAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACxE,CAAC;AAEF,wBAAsB,iBAAiB,CACrC,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,SAAS,EAClC,EACE,MAAM,EACN,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,cAAc,EACd,GAAG,EACH,SAAS,GACV,EAAE,OAAO,CAAC,YAAY,CAAC,EACxB,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuFvC"}

package/dist/cjs/lib/api/deploy.js

@@ -49,27 +49,27 @@ async function postDeploySuccess({ apiKey, serviceBase }, { branch, commitUrl, d
         else {
             if (response.status >= 500) {
                 return {
-                    failureReason: "server-error",
+                    failureReason: "5XX-server-error",
                     httpStatus: response.status,
                     success: false,
                 };
             }
             if (response.status === 401) {
                 return {
-                    failureReason: "unauthorized",
+                    failureReason: "401-unauthorized",
                     httpStatus: response.status,
                     success: false,
                 };
             }
             if (response.status === 403) {
                 return {
-                    failureReason: "forbidden",
+                    failureReason: "403-forbidden",
                     httpStatus: response.status,
                     success: false,
                 };
             }
             return {
-                failureReason: "unrecoverable-error",
+                failureReason: "4XX-client-error",
                 httpStatus: response.status,
                 success: false,
             };
@@ -83,3 +83,4 @@ async function postDeploySuccess({ apiKey, serviceBase }, { branch, commitUrl, d
     }
 }
 exports.postDeploySuccess = postDeploySuccess;
+//# sourceMappingURL=deploy.js.map

package/dist/cjs/lib/api/deploy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../../src/lib/api/deploy.ts"],"names":[],"mappings":";;;AAsBO,KAAK,UAAU,iBAAiB,CACrC,EAAE,MAAM,EAAE,WAAW,EAAa,EAClC,EACE,MAAM,EACN,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,cAAc,EACd,GAAG,EACH,SAAS,GACa,EACxB,EAAE,KAAK,EAAE,UAAU,EAAmB;IAEtC,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,UAAU,CAC/B,IAAI,GAAG,CAAC,8BAA8B,EAAE,WAAW,CAAC,EACpD;YACE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,MAAM;gBACN,UAAU,EAAE,SAAS;gBACrB,iBAAiB,EAAE,gBAAgB;gBACnC,eAAe,EAAE,cAAc;gBAC/B,cAAc,EAAE,aAAa;gBAC7B,eAAe,EAAE,cAAc;gBAC/B,GAAG;gBACH,SAAS;aACV,CAAC;YACF,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,MAAM,EAAE;gBACjC,cAAc,EAAE,kBAAkB;aACnC;YACD,MAAM,EAAE,MAAM;SACf,CACF,CAAC;QAEF,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YAChB,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAiB,CAAC;YAC5D,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAChC,CAAC,CAAC,EAAmC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAC3D,CAAC;YACF,MAAM,iBAAiB,GAAG,OAAO,CAAC,IAAI,CACpC,CAAC,CAAC,EAAqC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAC/D,CAAC;YACF,IAAI,iBAAiB,IAAI,IAAI,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;gBACvD,OAAO;oBACL,aAAa,EAAE,oBAAoB;oBACnC,OAAO,EAAE,KAAK;iBACN,CAAC;YACb,CAAC;YACD,IAAI,aAAa,EAAE,CAAC;gBAClB,OAAO;oBACL,OAAO,EAAE,aAAa,CAAC,cAAc;oBACrC,aAAa,EAAE,0BAA0B;oBACzC,OAAO,EAAE,KAAK;iBACN,CAAC;YACb,CAAC;YACD,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvB,OAAO;oBACL,aAAa,EAAE,oBAAoB;oBACnC,OAAO,EAAE,KAAK;iBACN,CAAC;YACb,CAAC;YACD,MAAM,KAAK,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;YACjD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAW,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;gBAC3B,OAAO;oBACL,aAAa,EAAE,kBAAkB;oBACjC,UAAU,EAAE,QAAQ,CAAC,MAAM;oBAC3B,OAAO,EAAE,KAAK;iBACN,CAAC;YACb,CAAC;YACD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,OAAO;oBACL,aAAa,EAAE,kBAAkB;oBACjC,UAAU,EAAE,QAAQ,CAAC,MAAM;oBAC3B,OAAO,EAAE,KAAK;iBACN,CAAC;YACb,CAAC;YACD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,OAAO;oBACL,aAAa,EAAE,eAAe;oBAC9B,UAAU,EAAE,QAAQ,CAAC,MAAM;oBAC3B,OAAO,EAAE,KAAK;iBACN,CAAC;YACb,CAAC;YACD,OAAO;gBACL,aAAa,EAAE,kBAAkB;gBACjC,UAAU,EAAE,QAAQ,CAAC,MAAM;gBAC3B,OAAO,EAAE,KAAK;aACN,CAAC;QACb,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO;YACL,aAAa,EAAE,eAAe;YAC9B,OAAO,EAAE,KAAK;SACN,CAAC;IACb,CAAC;AACH,CAAC;AAnGD,8CAmGC"}

package/dist/cjs/lib/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./ci-greenlight.js";
+export * from "./deploy.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/lib/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC"}

package/dist/cjs/lib/api/index.js

@@ -1,18 +1,6 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ci-greenlight.js"), exports);
-__exportStar(require("./deploy.js"), exports);
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./ci-greenlight.js"), exports);
+tslib_1.__exportStar(require("./deploy.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/lib/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/api/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,sDAA4B"}

package/dist/cjs/lib/api-types.d.ts

@@ -0,0 +1,5 @@
+export type ApiConfig = {
+    apiKey: string;
+    serviceBase: string;
+};
+//# sourceMappingURL=api-types.d.ts.map

package/dist/cjs/lib/api-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-types.d.ts","sourceRoot":"","sources":["../../../src/lib/api-types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/cjs/lib/api-types.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-types.js.map

package/dist/cjs/lib/api-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-types.js","sourceRoot":"","sources":["../../../src/lib/api-types.ts"],"names":[],"mappings":""}

package/dist/cjs/lib/sdk/dependencies.d.ts

@@ -0,0 +1,11 @@
+export interface LogDriver {
+    error(message: string, error?: unknown): void;
+    info(message: string): void;
+    warn(message: string): void;
+}
+export type FetchDriver = typeof fetch;
+export type SdkDependencies = {
+    fetch: FetchDriver;
+    log: LogDriver;
+};
+//# sourceMappingURL=dependencies.d.ts.map

package/dist/cjs/lib/sdk/dependencies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencies.d.ts","sourceRoot":"","sources":["../../../../src/lib/sdk/dependencies.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9C,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,MAAM,WAAW,GAAG,OAAO,KAAK,CAAC;AAEvC,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,WAAW,CAAC;IACnB,GAAG,EAAE,SAAS,CAAC;CAChB,CAAC"}

package/dist/cjs/lib/sdk/dependencies.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dependencies.js.map

package/dist/cjs/lib/sdk/dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencies.js","sourceRoot":"","sources":["../../../../src/lib/sdk/dependencies.ts"],"names":[],"mappings":""}

package/dist/cjs/lib/sdk/domain/attempt-deploy.d.ts

@@ -0,0 +1,36 @@
+import { type DeployConfig } from "../../api/deploy.js";
+import { type ApiConfig } from "../../api-types.js";
+import { type SdkDependencies } from "../dependencies.js";
+export type AttemptDeployFailedReason = "no-matched-trigger" | "run-could-not-be-created";
+export type AttemptDeployHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "5XX-server-error";
+export type AttemptDeployNonHttpAbortReason = "network-error";
+export type AttemptDeployAbortReason = AttemptDeployHttpAbortReason | AttemptDeployNonHttpAbortReason;
+export type NotifyDeployStatus = {
+    /**
+     * A run was successfully created.
+     */
+    outcome: "success";
+    runId: string;
+} | {
+    failReason: AttemptDeployFailedReason;
+    /**
+     * A run could not be created.
+     */
+    outcome: "failed";
+} | {
+    abortReason: AttemptDeployNonHttpAbortReason;
+    httpStatus: undefined;
+    /**
+     * An unrecoverable error occurred.
+     */
+    outcome: "aborted";
+} | {
+    abortReason: AttemptDeployHttpAbortReason;
+    httpStatus: number;
+    /**
+     * An unrecoverable HTTP error occurred.
+     */
+    outcome: "aborted";
+};
+export declare function attemptNotifyDeploy(deps: SdkDependencies, apiConfig: ApiConfig, config: Partial<DeployConfig>): Promise<NotifyDeployStatus>;
+//# sourceMappingURL=attempt-deploy.d.ts.map

package/dist/cjs/lib/sdk/domain/attempt-deploy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attempt-deploy.d.ts","sourceRoot":"","sources":["../../../../../src/lib/sdk/domain/attempt-deploy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAqB,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAE1D,MAAM,MAAM,yBAAyB,GACjC,oBAAoB,GACpB,0BAA0B,CAAC;AAE/B,MAAM,MAAM,4BAA4B,GACpC,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,kBAAkB,CAAC;AAEvB,MAAM,MAAM,+BAA+B,GAAG,eAAe,CAAC;AAE9D,MAAM,MAAM,wBAAwB,GAChC,4BAA4B,GAC5B,+BAA+B,CAAC;AAEpC,MAAM,MAAM,kBAAkB,GAC1B;IACE;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf,GACD;IACE,UAAU,EAAE,yBAAyB,CAAC;IACtC;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;CACnB,GACD;IACE,WAAW,EAAE,+BAA+B,CAAC;IAC7C,UAAU,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC;CACpB,GACD;IACE,WAAW,EAAE,4BAA4B,CAAC;IAC1C,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC;CACpB,CAAC;AAEN,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,eAAe,EACrB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAC5B,OAAO,CAAC,kBAAkB,CAAC,CAsD7B"}

package/dist/cjs/lib/sdk/domain/attempt-deploy.js

@@ -9,29 +9,40 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
     if (!responseState.success) {
         if (responseState.failureReason === "no-matched-trigger") {
             log.error(`🚫 No trigger matched the request. Please contact support.`);
-            return { outcome: "failed" };
+            return { failReason: "no-matched-trigger", outcome: "failed" };
         }
         else if (responseState.failureReason === "run-could-not-be-created") {
             log.error(`🚫 Run could not be created. Reason: "${responseState.details}". Please contact support.`);
-            return { outcome: "failed" };
+            return { failReason: "run-could-not-be-created", outcome: "failed" };
         }
         if (responseState.failureReason === "network-error")
             log.error(`🚫 Network error from deploy_success, aborting.`);
-        else if (responseState.failureReason === "server-error")
+        else if (responseState.failureReason === "5XX-server-error")
             log.error(`🚫 Server error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
-        else if (responseState.failureReason === "unrecoverable-error") {
+        else if (responseState.failureReason === "4XX-client-error") {
             log.error(`🚫 Unrecoverable error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
         }
-        else if (responseState.failureReason === "forbidden") {
+        else if (responseState.failureReason === "403-forbidden") {
             log.error(`🚫 Forbidden error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
         }
-        else if (responseState.failureReason === "unauthorized") {
+        else if (responseState.failureReason === "401-unauthorized") {
             log.error(`🚫 Unauthorized error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
         }
         else {
             (0, utils_js_1.assertType)(responseState);
         }
-        return { outcome: "aborted" };
+        if (responseState.failureReason === "network-error") {
+            return {
+                abortReason: "network-error",
+                httpStatus: undefined,
+                outcome: "aborted",
+            };
+        }
+        return {
+            abortReason: responseState.failureReason,
+            httpStatus: responseState.httpStatus,
+            outcome: "aborted",
+        };
     }
     log.info(`✅ Run created with ID: ${responseState.runId}`);
     return {
@@ -40,3 +51,4 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
     };
 }
 exports.attemptNotifyDeploy = attemptNotifyDeploy;
+//# sourceMappingURL=attempt-deploy.js.map

package/dist/cjs/lib/sdk/domain/attempt-deploy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attempt-deploy.js","sourceRoot":"","sources":["../../../../../src/lib/sdk/domain/attempt-deploy.ts"],"names":[],"mappings":";;;AAAA,mDAA2E;AAE3E,6CAA4C;AAmDrC,KAAK,UAAU,mBAAmB,CACvC,IAAqB,EACrB,SAAoB,EACpB,MAA6B;IAE7B,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACrB,MAAM,aAAa,GAAG,MAAM,IAAA,6BAAiB,EAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACvE,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;QAC3B,IAAI,aAAa,CAAC,aAAa,KAAK,oBAAoB,EAAE,CAAC;YACzD,GAAG,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAC;YACxE,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;QACjE,CAAC;aAAM,IAAI,aAAa,CAAC,aAAa,KAAK,0BAA0B,EAAE,CAAC;YACtE,GAAG,CAAC,KAAK,CACP,yCAAyC,aAAa,CAAC,OAAO,4BAA4B,CAC3F,CAAC;YACF,OAAO,EAAE,UAAU,EAAE,0BAA0B,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;QACvE,CAAC;QAED,IAAI,aAAa,CAAC,aAAa,KAAK,eAAe;YACjD,GAAG,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;aAC1D,IAAI,aAAa,CAAC,aAAa,KAAK,kBAAkB;YACzD,GAAG,CAAC,KAAK,CACP,+CAA+C,aAAa,CAAC,UAAU,sCAAsC,CAC9G,CAAC;aACC,IAAI,aAAa,CAAC,aAAa,KAAK,kBAAkB,EAAE,CAAC;YAC5D,GAAG,CAAC,KAAK,CACP,sDAAsD,aAAa,CAAC,UAAU,sCAAsC,CACrH,CAAC;QACJ,CAAC;aAAM,IAAI,aAAa,CAAC,aAAa,KAAK,eAAe,EAAE,CAAC;YAC3D,GAAG,CAAC,KAAK,CACP,kDAAkD,aAAa,CAAC,UAAU,sCAAsC,CACjH,CAAC;QACJ,CAAC;aAAM,IAAI,aAAa,CAAC,aAAa,KAAK,kBAAkB,EAAE,CAAC;YAC9D,GAAG,CAAC,KAAK,CACP,qDAAqD,aAAa,CAAC,UAAU,sCAAsC,CACpH,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAA,qBAAU,EAAQ,aAAa,CAAC,CAAC;QACnC,CAAC;QACD,IAAI,aAAa,CAAC,aAAa,KAAK,eAAe,EAAE,CAAC;YACpD,OAAO;gBACL,WAAW,EAAE,eAAe;gBAC5B,UAAU,EAAE,SAAS;gBACrB,OAAO,EAAE,SAAS;aACnB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,WAAW,EAAE,aAAa,CAAC,aAAa;YACxC,UAAU,EAAE,aAAa,CAAC,UAAU;YACpC,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,0BAA0B,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC;IAC1D,OAAO;QACL,OAAO,EAAE,SAAS;QAClB,KAAK,EAAE,aAAa,CAAC,KAAK;KAC3B,CAAC;AACJ,CAAC;AA1DD,kDA0DC"}

package/dist/cjs/lib/sdk/domain/poll-ci-greenlight.d.ts

@@ -0,0 +1,78 @@
+import { type CiGreenlightStatus } from "../../api/ci-greenlight.js";
+import { type ApiConfig } from "../../api-types.js";
+import { type SdkDependencies } from "../dependencies.js";
+export type PollCiGreenlightPollConfig = {
+    /**
+     * Maximum number of network operations retries before aborting the job.
+     *
+     * @default 10
+     */
+    maxRetries: number;
+    /**
+     * Timeout in milliseconds before aborting this polling operation.
+     *
+     * @default 120 minutes
+     */
+    pollTimeout: number;
+    /**
+     * Interval in milliseconds between network operations retries.
+     *
+     * @default 10 seconds
+     */
+    retryInterval: number;
+    /**
+     * Interval in milliseconds between polling for a run in progress.
+     *
+     * @default 30 seconds
+     */
+    runInProgressInterval: number;
+    /**
+     * Interval in milliseconds between polling for a run under review.
+     *
+     * @default 60 minutes
+     */
+    runUnderReviewInterval: number;
+};
+export type PollCiGreenlightHttpAbortReason = "4XX-client-error" | "404-run-not-found" | "5XX-server-error" | "XXX-other-http-code";
+export type PollCiGreenlightNonHttpAbortReason = "poll-timed-out" | "run-canceled" | "network-error";
+export type PollCiGreenlightAbortReason = PollCiGreenlightNonHttpAbortReason | PollCiGreenlightHttpAbortReason;
+export type PollCiGreenlightStatus = {
+    greenlightStatus: Extract<CiGreenlightStatus, {
+        runStage: "completed";
+    }>;
+    /**
+     * No blocking bugs were found in the run.
+     */
+    outcome: "success";
+} | {
+    greenlightStatus: Extract<CiGreenlightStatus, {
+        runStage: "completed";
+    }>;
+    /**
+     * Blocking bugs were found in the run.
+     */
+    outcome: "failed";
+} | {
+    abortReason: PollCiGreenlightHttpAbortReason;
+    httpStatus: number;
+    /**
+     * The run was aborted due to an unrecoverable error.
+     */
+    outcome: "aborted";
+} | {
+    abortReason: PollCiGreenlightNonHttpAbortReason;
+    httpStatus: undefined;
+    /**
+     * The run was aborted due to an unrecoverable error.
+     */
+    outcome: "aborted";
+};
+export type PollCiGreenlightParams = {
+    /**
+     * Callback to be called when the lifecycle stage of the run changes.
+     */
+    onRunStageChanged?: (current: CiGreenlightStatus, previous: CiGreenlightStatus | undefined) => unknown | Promise<unknown>;
+    runId: string;
+} & Partial<PollCiGreenlightPollConfig>;
+export declare function pollCiGreenlightStatus(deps: SdkDependencies, apiConfig: ApiConfig, { runId, onRunStageChanged: onRunStageChanged, ...pollConfig }: PollCiGreenlightParams): Promise<PollCiGreenlightStatus>;
+//# sourceMappingURL=poll-ci-greenlight.d.ts.map