@qawolf/ci-sdk 2.2.0 → 2.6.0

package/dist/lib/other.d.ts

@@ -0,0 +1,5 @@
+import type { FetchDriver } from "./sdk/dependencies.js";
+export declare function sleep(ms: number): Promise<void>;
+export declare function pluralize(count: number): "" | "s";
+export declare function getBackoffMs(attemptNumber: number, minWaitMs?: number, maxWaitMs?: number): number;
+export declare const buildFetchWithTimeout: (fetch: FetchDriver, defaultTimeoutMs: number) => (...args: Parameters<FetchDriver>) => Promise<Response>;

package/dist/lib/sdk/defaults/fetch.d.ts

@@ -0,0 +1 @@
+export declare const defaultFetch: typeof fetch;

package/dist/lib/sdk/defaults/log.d.ts

@@ -0,0 +1,2 @@
+import type { LogDriver } from "../dependencies.js";
+export declare const defaultLogDriver: LogDriver;

package/dist/lib/sdk/defaults/serviceBase.d.ts

@@ -0,0 +1 @@
+export declare const defaultServiceBase = "https://app.qawolf.com/";

package/dist/lib/sdk/defaults/userAgent.d.ts

@@ -0,0 +1 @@
+export declare const defaultUserAgent: string;

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

@@ -0,0 +1,7 @@
+import type { LogDriver } from "@qawolf/ci-utils";
+export type { LogDriver };
+export type FetchDriver = typeof fetch;
+export type SdkDependencies = {
+    fetch: FetchDriver;
+    log: LogDriver;
+};

package/dist/lib/sdk/domain/attemptDeploy/deployConfig.d.ts

@@ -0,0 +1,37 @@
+type BaseDeployConfig = {
+    branch: string | undefined;
+    commitUrl: string | undefined;
+    deduplicationKey: string | undefined;
+    deploymentType: string | undefined;
+    deploymentUrl: string | undefined;
+    sha: string | undefined;
+    variables: Record<string, string> | undefined;
+    /**
+     * The workspace this deployment belongs to. Required when authenticating with
+     * an organization API key, which is not tied to a single workspace. Omit it
+     * when authenticating with a workspace API key, which already implies one.
+     */
+    workspaceId?: string;
+};
+export type GitHubDeployConfig = BaseDeployConfig & {
+    hostingService: "GitHub" | undefined;
+    pullRequestNumber: number | undefined;
+    repository: {
+        name: string;
+        owner: string;
+    } | undefined;
+};
+export type GitLabDeployConfig = BaseDeployConfig & {
+    hostingService: "GitLab" | undefined;
+    mergeRequestNumber: number | undefined;
+    repository: {
+        name: string;
+        namespace: string;
+    } | undefined;
+};
+export type EphemeralDeployConfig = BaseDeployConfig & {
+    deploymentUrl: string;
+    ephemeralEnvironment: true;
+};
+export type DeployConfig = GitHubDeployConfig | GitLabDeployConfig | EphemeralDeployConfig;
+export {};

package/dist/lib/sdk/domain/attemptDeploy/deploySuccessWireResponse.d.ts

@@ -0,0 +1,39 @@
+type WireSuiteResult = {
+    created_suite_id: string;
+    outcome: "created";
+    trigger_id: string;
+} | {
+    failure_code?: string;
+    failure_message?: string;
+    failure_reason: string;
+    outcome: "failed";
+    trigger_id: string;
+} | {
+    duplicate_suite_id: string;
+    outcome: "skipped";
+    skip_reason: string;
+    trigger_id: string;
+} | {
+    outcome?: undefined;
+    trigger_id: string;
+};
+export type DeploySuccessWireResponse = {
+    environment: {
+        alias?: string;
+        id: string;
+        isStatic: boolean;
+    } | undefined;
+    results: WireSuiteResult[];
+    skipped_deployment?: {
+        message: string;
+        reason: string;
+    };
+    skipped_triggers?: {
+        environment_id: string;
+        message: string;
+        reason: string;
+        trigger_id: string;
+    }[];
+    warning?: string;
+};
+export {};

package/dist/lib/sdk/domain/attemptDeploy/handleSuccessResponse.d.ts

@@ -0,0 +1,3 @@
+import type { LogDriver } from "../../dependencies.js";
+import type { DeployStatus, NotifyDeployStatus } from "./types.js";
+export declare function handleSuccessResponse(data: DeployStatus, log: LogDriver): Promise<NotifyDeployStatus>;

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

@@ -0,0 +1,4 @@
+import type { ApiConfig } from "../../../api-types.js";
+import type { SdkDependencies } from "../../dependencies.js";
+import type { DeployConfig, NotifyDeployStatus } from "./types.js";
+export declare function attemptNotifyDeploy(deps: SdkDependencies, apiConfig: ApiConfig, config: Partial<DeployConfig>): Promise<NotifyDeployStatus>;

package/dist/lib/sdk/domain/attemptDeploy/mapDeploySuccessResponse.d.ts

@@ -0,0 +1,3 @@
+import type { DeploySuccessWireResponse } from "./deploySuccessWireResponse.js";
+import type { DeployStatus } from "./types.js";
+export declare function mapDeploySuccessResponse(wire: DeploySuccessWireResponse): DeployStatus;

package/dist/lib/sdk/domain/attemptDeploy/parseDeploySuccessWireResponse.d.ts

@@ -0,0 +1,2 @@
+import type { DeploySuccessWireResponse } from "./deploySuccessWireResponse.js";
+export declare function parseDeploySuccessWireResponse(value: unknown): DeploySuccessWireResponse | "invalid";

package/dist/lib/sdk/domain/attemptDeploy/types.d.ts

@@ -0,0 +1,129 @@
+export type { DeployConfig, EphemeralDeployConfig, GitHubDeployConfig, GitLabDeployConfig, } from "./deployConfig.js";
+/**
+ * Refer to our official documentation for more information:
+ * https://qawolf.notion.site/dd72e46ceb7f451dae4e9ef06f64a2cc
+ */
+export type { DeploySuccessWireResponse } from "./deploySuccessWireResponse.js";
+export type DeploySuccessSuiteCreatedResult = {
+    createdSuiteId: string;
+    triggerId: string;
+};
+export type DeploySuccessSuiteCreationFailureResult = {
+    failureCode?: string;
+    failureMessage?: string;
+    /**
+     * @deprecated Read `failureCode` to branch and `failureMessage` to display.
+     * This carries an internal diagnostic whose values change without notice.
+     */
+    failureReason: string;
+    triggerId: string;
+};
+export type DeploySuccessSuiteAlreadyExistsResult = {
+    duplicateSuiteId: string;
+    skipReason: string;
+    triggerId: string;
+};
+export type DeploySuccessSuiteUnrecognizedResult = {
+    triggerId: string;
+    unrecognized: true;
+};
+export type DeploySuccessSuiteResult = DeploySuccessSuiteCreatedResult | DeploySuccessSuiteCreationFailureResult | DeploySuccessSuiteAlreadyExistsResult | DeploySuccessSuiteUnrecognizedResult;
+export type DeploySuccessSkippedTrigger = {
+    environmentId: string;
+    message: string;
+    reason: string;
+    triggerId: string;
+};
+export type DeploySuccessDeploymentSkipped = {
+    message: string;
+    reason: string;
+};
+export type DeployStatus = {
+    environment: {
+        alias?: string;
+        id: string;
+        isStatic: boolean;
+    } | undefined;
+    results: Array<DeploySuccessSuiteResult>;
+    skippedDeployment?: DeploySuccessDeploymentSkipped;
+    skippedTriggers?: DeploySuccessSkippedTrigger[];
+    warning?: string;
+};
+export type DeployStatusSuccessResponse = {
+    data: DeployStatus;
+    ok: true;
+    status: number;
+};
+export type DeployStatusErrorResponse = {
+    data: undefined;
+    ok: false;
+    status: number | undefined;
+};
+export type DeployStatusResponse = DeployStatusSuccessResponse | DeployStatusErrorResponse;
+export type AttemptDeployHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "5XX-server-error" | "network-error";
+export type AttemptDeployNonHttpAbortReason = "network-error" | "invalid-response-body";
+export type AttemptDeployAbortReason = AttemptDeployHttpAbortReason | AttemptDeployNonHttpAbortReason;
+export type NotifyDeployStatus = {
+    /**
+     * Environment ID associated with the deployment.
+     */
+    environmentId: string;
+    /**
+     * Deployment notification successful.
+     */
+    outcome: "success";
+    /**
+     * Run ID might be undefined if the deployment is a preview deployment.
+     */
+    runId: string | undefined;
+} | {
+    /**
+     * One or more triggers matched the deployment but could not run (e.g. the
+     * environment was still syncing). A precondition was not met, so this is a
+     * failure rather than a skip: retrying once the environment is ready may
+     * create a run.
+     */
+    failReason: "trigger-skipped";
+    outcome: "failed";
+    skippedTriggers: DeploySuccessSkippedTrigger[];
+} | {
+    /**
+     * No trigger matched the deployment. This is deterministic given the
+     * current configuration (repeating the request with the same config
+     * yields the same result), so it is a skip rather than a failure, and the
+     * caller should not treat it as an error. `skippedDeployment` carries the
+     * server's reason when it provided one (undefined on older servers or the
+     * legacy arm); there is no separate SDK-level reason code, since
+     * `outcome: "skipped"` only ever means no trigger matched.
+     */
+    outcome: "skipped";
+    skippedDeployment: DeploySuccessDeploymentSkipped | undefined;
+} | {
+    /**
+     * `unknown-result` means the response carried a result arm this SDK
+     * version does not recognize (the backend is newer). The caller should
+     * upgrade the SDK; the outcome could not be classified.
+     */
+    failReason: "no-environment" | "run-could-not-be-created" | "unknown-result";
+    /**
+     * A run could not be created.
+     */
+    outcome: "failed";
+} | {
+    abortReason: AttemptDeployNonHttpAbortReason;
+    httpStatus?: never;
+    /**
+     * An unrecoverable error occurred.
+     */
+    outcome: "aborted";
+} | {
+    abortReason: AttemptDeployHttpAbortReason;
+    httpStatus: number | undefined;
+    /**
+     * An unrecoverable HTTP error occurred.
+     */
+    outcome: "aborted";
+};
+export type AttemptDeployFailedReason = Extract<NotifyDeployStatus, {
+    outcome: "failed";
+}>["failReason"];

package/dist/lib/sdk/domain/generateSignedUrls/generate-signed-url-for-run-inputs-executables.d.ts

@@ -0,0 +1,4 @@
+import type { ApiConfig } from "../../../api-types.js";
+import type { SdkDependencies } from "../../dependencies.js";
+import type { GenerateSignedUrlConfig, GenerateSignedUrlStatus } from "./types.js";
+export declare function generateSignedUrlForRunInputsExecutablesStorage(deps: SdkDependencies, apiConfig: ApiConfig, config: GenerateSignedUrlConfig): Promise<GenerateSignedUrlStatus>;

package/dist/lib/sdk/domain/generateSignedUrls/generate-signed-url-for-team-storage.d.ts

@@ -0,0 +1,16 @@
+import type { ApiConfig } from "../../../api-types.js";
+import type { SdkDependencies } from "../../dependencies.js";
+import type { GenerateSignedUrlConfig } from "./types.js";
+type GenerateSignedUrlStatus = {
+    fileLocation?: string;
+    playgroundFileLocation?: string;
+    success: true;
+    uploadUrl?: string;
+} | {
+    abortReason: GenerateSignedUrlAbortReason;
+    httpStatus?: number;
+    success: false;
+};
+export type GenerateSignedUrlAbortReason = "client-network-error" | "sdk-argument-validation-failed" | "400-invalid-request" | "401-invalid-credentials" | "403-forbidden" | "5XX-server-error" | "XXX-other-http-code";
+export declare function generateSignedUrlForTempTeamStorage(deps: SdkDependencies, apiConfig: ApiConfig, config: GenerateSignedUrlConfig): Promise<GenerateSignedUrlStatus>;
+export {};

package/dist/lib/sdk/domain/generateSignedUrls/types.d.ts

@@ -0,0 +1,28 @@
+export type GenerateSignedUrlStatus = {
+    fileLocation?: string;
+    playgroundFileLocation?: string;
+    success: true;
+    uploadUrl?: string;
+} | {
+    abortReason: GenerateSignedUrlAbortReason;
+    httpStatus?: number;
+    success: false;
+};
+export type GenerateSignedUrlAbortReason = "client-network-error" | "sdk-argument-validation-failed" | "400-invalid-request" | "401-invalid-credentials" | "403-forbidden" | "5XX-server-error" | "XXX-other-http-code";
+export type GenerateSignedUrlConfig = {
+    destinationFilePath: string;
+    /**
+     * The workspace to generate the URL for. Required when authenticating with an
+     * organization API key, which is not tied to a single workspace. Omit it when
+     * authenticating with a workspace API key, which already implies one.
+     */
+    workspaceId?: string;
+};
+export type GenerateSignedUrlResponse = {
+    errorMessage?: string;
+    fileLocation?: string;
+    httpStatus: number;
+    playgroundFileLocation?: string;
+    signedUrl?: string;
+    success: boolean;
+};

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

@@ -0,0 +1,4 @@
+import type { ApiConfig } from "../../../api-types.js";
+import type { SdkDependencies } from "../../dependencies.js";
+import type { NotifyTerminatedEphemeralEnvironmentInput, NotifyTerminatedEphemeralEnvironmentResult } from "./types.js";
+export declare const notifyTerminatedEphemeralEnvironment: (deps: SdkDependencies, apiConfig: ApiConfig, config: NotifyTerminatedEphemeralEnvironmentInput) => Promise<NotifyTerminatedEphemeralEnvironmentResult>;

package/dist/lib/sdk/domain/notifyTerminatedEphemeralEnvironment/types.d.ts

@@ -0,0 +1,48 @@
+/**
+ * The workspace that owns the environment. Required when authenticating with an
+ * organization API key, which is not tied to a single workspace. Omit it when
+ * authenticating with a workspace API key, which already implies one.
+ *
+ * Absent from the `environmentId` lookup, where the environment identifies its
+ * own workspace.
+ */
+type WorkspaceLookup = {
+    workspaceId?: string;
+};
+export type NotifyTerminatedEphemeralEnvironmentInput = {
+    environmentId: string;
+} | ({
+    deploymentUrl: string;
+} & WorkspaceLookup) | ({
+    environmentAlias: string;
+} & WorkspaceLookup);
+export type NotifyTerminatedEphemeralEnvironmentFailedReason = "environmentNotFound" | "missingLookup" | "alreadyTerminated";
+export type NotifyTerminatedEphemeralEnvironmentHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "409-conflict" | "5XX-server-error" | "network-error";
+export type NotifyTerminatedEphemeralEnvironmentNonHttpAbortReason = "network-error";
+export type NotifyTerminatedEphemeralEnvironmentAbortReason = NotifyTerminatedEphemeralEnvironmentHttpAbortReason | NotifyTerminatedEphemeralEnvironmentNonHttpAbortReason;
+export type TerminatedEphemeralEnvironmentSuccessResult = {
+    environmentId: string;
+    warning?: string;
+};
+export type NotifyTerminatedEphemeralEnvironmentResult = {
+    environmentId: string;
+    /**
+     * Environment termination successful.
+     */
+    outcome: "success";
+} | {
+    abortReason: NotifyTerminatedEphemeralEnvironmentAbortReason;
+    httpStatus?: never;
+    /**
+     * An unrecoverable error occurred.
+     */
+    outcome: "aborted";
+} | {
+    abortReason: NotifyTerminatedEphemeralEnvironmentHttpAbortReason;
+    httpStatus: number | undefined;
+    /**
+     * An unrecoverable HTTP error occurred.
+     */
+    outcome: "aborted";
+};
+export {};

package/dist/lib/sdk/domain/pollCiGreenlight/buildCompletedRunResult.d.ts

@@ -0,0 +1,8 @@
+import type { CiGreenlightStatus } from "../../../api/ci-greenlight.js";
+import type { PollCiGreenlightStatus } from "./types.js";
+/**
+ * Build the result for a completed run
+ */
+export declare function buildCompletedRunResult(status: Extract<CiGreenlightStatus, {
+    runStage: "completed";
+}>): PollCiGreenlightStatus;

package/dist/lib/sdk/domain/pollCiGreenlight/consts.d.ts

@@ -0,0 +1,7 @@
+import type { PollCiGreenlightPollConfig } from "./types.js";
+/**
+ * Safe default values for polling configuration.
+ * If you change these values, make sure you update the JSDoc
+ * comments in the PollCiGreenlightPollConfig type.
+ */
+export declare const pollCiGreenlightDefaults: PollCiGreenlightPollConfig;

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

@@ -0,0 +1,4 @@
+import type { ApiConfig } from "../../../api-types.js";
+import type { SdkDependencies } from "../../dependencies.js";
+import type { PollCiGreenlightParams, PollCiGreenlightStatus } from "./types.js";
+export declare function pollCiGreenlightStatus(deps: SdkDependencies, apiConfig: ApiConfig, { onRunStageChanged, runId, ...pollConfig }: PollCiGreenlightParams): Promise<PollCiGreenlightStatus>;

package/dist/lib/sdk/domain/pollCiGreenlight/iterator.d.ts

@@ -0,0 +1,43 @@
+import type { ApiConfig } from "../../../api-types.js";
+import type { SdkDependencies } from "../../dependencies.js";
+import type { MakePollCiGreenlightStatusIteratorParams, PollCiGreenlightIteration } from "./types.js";
+/**
+ * Creates an async generator that yields CI greenlight status updates or abort notifications.
+ *
+ * This low-level API gives you full control over the polling loop, allowing you to:
+ * - Inspect status after each fetch
+ * - Break out of the loop based on custom criteria
+ * - Add custom logging or side effects
+ * - Handle abort conditions without exceptions
+ *
+ * The iterator yields a discriminated union with `isAborted` property:
+ * - `isAborted: false` - Normal status update with run information
+ * - `isAborted: true` - Terminal condition (timeout, error, canceled, etc.)
+ *
+ * Note: This function does not throw errors. All error conditions are yielded as
+ * abort results that you must check and handle.
+ *
+ * @example
+ * ```typescript
+ * const greenlightIterator = makePollCiGreenlightStatusIterator({ runId: "my-run-id" });
+ *
+ * for await (const lastPoll  of greenlightIterator) {
+ *   // Check for abort conditions first
+ *   if (lastPoll.isAborted) {
+ *     console.error(`Aborted: ${lastPoll.abortReason}`);
+ *     process.exit(1);
+ *   }
+ *
+ *   // Handle normal status updates
+ *   const { status } = lastPoll;
+ *   console.log(`Current stage: ${status.runStage}`);
+ *
+ *   // Exit with error if run reached a terminal stage without greenlight
+ *   if (lastPoll.isFailedTerminalStage) {
+ *     process.exit(1);
+ *   }
+ * }
+ * ```
+ *
+ */
+export declare function makePollCiGreenlightStatusIterator(deps: SdkDependencies, apiConfig: ApiConfig, { runId, ...pollConfig }: MakePollCiGreenlightStatusIteratorParams): AsyncGenerator<PollCiGreenlightIteration, void, unknown>;

package/dist/lib/sdk/domain/pollCiGreenlight/logging.d.ts

@@ -0,0 +1,27 @@
+import type { CiGreenlightStatus } from "../../../api/ci-greenlight.js";
+/**
+ * Build log message for successful completed run
+ */
+export declare function buildSuccessLogMessage(status: Extract<CiGreenlightStatus, {
+    runStage: "completed";
+}>): string;
+/**
+ * Build log message for failed completed run
+ */
+export declare function buildFailedLogMessage(status: Extract<CiGreenlightStatus, {
+    runStage: "completed";
+}>): string;
+/**
+ * Build log message for superseded run (aborting)
+ */
+export declare function buildSupersededAbortLogMessage(rootRunUrl: string, relevantRunUrl: string): string;
+/**
+ * Build log message for superseded run (continuing)
+ */
+export declare function buildSupersededContinueLogMessage(rootRunUrl: string, relevantRunUrl: string): string;
+/**
+ * Build log messages for different run stages
+ */
+export declare function buildRunStageLogMessage(status: Exclude<CiGreenlightStatus, {
+    runStage: "completed";
+}>): string;

package/dist/lib/sdk/domain/pollCiGreenlight/mapIteratorAbortToGreenlightStatus.d.ts

@@ -0,0 +1,7 @@
+import type { SdkDependencies } from "../../dependencies.js";
+import type { PollCiGreenlightIteratorHttpAborted, PollCiGreenlightIteratorNonHttpAborted, PollCiGreenlightStatus } from "./types.js";
+/**
+ * Handles aborted iterations from the CI greenlight poll iterator
+ * and converts them to appropriate result objects with logging
+ */
+export declare function mapIteratorAbortToGreenlightStatus(iteration: PollCiGreenlightIteratorHttpAborted | PollCiGreenlightIteratorNonHttpAborted, pollTimeout: number, deps: SdkDependencies): PollCiGreenlightStatus;

package/dist/lib/sdk/domain/pollCiGreenlight/types.d.ts

@@ -0,0 +1,156 @@
+import type { CiGreenlightStatus } from "../../../api/ci-greenlight.js";
+export type PollCiGreenlightPollConfig = {
+    /**
+     * If true, the job will be aborted when a superseding run is detected.
+     *
+     * @default false
+     */
+    abortOnSuperseded: boolean;
+    /**
+     * 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" | "superseded-run";
+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>;
+/**
+ * Successful status iteration containing greenlight status and metadata
+ */
+export type PollCiGreenlightStatusIteration = {
+    /**
+     * Milliseconds elapsed since polling started
+     */
+    elapsedMs: number;
+    /**
+     * False when this is a successful status iteration
+     */
+    isAborted: false;
+    /**
+     * Whether the run reached a terminal stage without greenlight.
+     * True when the run completed without greenlight or was canceled.
+     * You should exit with an error code when this is true.
+     */
+    isFailedTerminalStage: boolean;
+    /**
+     * The previous status, if any
+     */
+    previousStatus: CiGreenlightStatus | undefined;
+    /**
+     * Whether the run stage changed from the previous iteration
+     */
+    stageChanged: boolean;
+    /**
+     * The current greenlight status from the API
+     */
+    status: CiGreenlightStatus;
+};
+/**
+ * Iterator aborted due to unrecoverable HTTP client error (4XX)
+ */
+export type PollCiGreenlightIteratorHttpAborted = {
+    abortReason: PollCiGreenlightHttpAbortReason;
+    elapsedMs: number;
+    httpStatus: number;
+    /**
+     * True when the iterator was aborted
+     */
+    isAborted: true;
+};
+/**
+ * Iterator aborted due to non-HTTP reasons (timeout, canceled, network)
+ */
+export type PollCiGreenlightIteratorNonHttpAborted = {
+    abortReason: Exclude<PollCiGreenlightNonHttpAbortReason, "superseded-run">;
+    elapsedMs: number;
+    httpStatus: undefined;
+    /**
+     * True when the iterator was aborted
+     */
+    isAborted: true;
+    /**
+     * Human-readable copy explaining the cancellation, when the server sent it.
+     * Only a `run-canceled` abort carries it.
+     */
+    message?: string;
+    /**
+     * Stable, machine-readable code for the cancellation, when the server sent
+     * it. Only a `run-canceled` abort carries it, and it is an open set of
+     * values.
+     */
+    reason?: string;
+};
+/**
+ * Yielded value from the async generator - either a status update or a terminal abort condition
+ */
+export type PollCiGreenlightIteration = PollCiGreenlightStatusIteration | PollCiGreenlightIteratorHttpAborted | PollCiGreenlightIteratorNonHttpAborted;
+/**
+ * Parameters for the async generator
+ */
+export type MakePollCiGreenlightStatusIteratorParams = {
+    runId: string;
+} & Partial<PollCiGreenlightPollConfig>;

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

@@ -0,0 +1,26 @@
+import type { SdkDependencies } from "./dependencies.js";
+export declare function makeQaWolfSdk({ apiKey, serviceBase, userAgent, }: {
+    apiKey: string;
+    serviceBase?: string;
+    userAgent?: string;
+}, { fetch, log, }?: Partial<SdkDependencies>): {
+    attemptNotifyDeploy: (config: Partial<import("./domain/attemptDeploy/deployConfig.js").DeployConfig>) => Promise<import("./domain/attemptDeploy/types.js").NotifyDeployStatus>;
+    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;
+        playgroundFileLocation?: string;
+        success: true;
+        uploadUrl?: string;
+    } | {
+        abortReason: import("./domain/generateSignedUrls/generate-signed-url-for-team-storage.js").GenerateSignedUrlAbortReason;
+        httpStatus?: number;
+        success: false;
+    }>;
+    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>;
+    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";