@qawolf/ci-sdk 2.2.0 → 2.6.0

package/dist/index.d.ts

@@ -1,557 +1,4 @@
-import { LogDriver } from '@qawolf/ci-utils';
-export { LogDriver } from '@qawolf/ci-utils';
-
-type ApiConfig = {
-    apiKey: string;
-    serviceBase: string;
-    userAgent: string;
-};
-
-type FetchDriver = typeof fetch;
-type SdkDependencies = {
-    fetch: FetchDriver;
-    log: LogDriver;
-};
-
-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";
-};
-type CiGreenlightBugData = {
-    /**
-     * The count of blocking bugs reproduced in the run.
-     */
-    blockingBugsCount: number;
-    /**
-     * The count of non-blocking bugs reproduced in the run.
-     */
-    nonBlockingBugsCount: number;
-    /**
-     * Blocking bugs that were not reproduced in this run, but are still
-     * opened in the run environment. This may happen when the run only covers a
-     * subset of the workflows in environment.
-     */
-    otherBlockingBugsInEnvironment: CiGreenlightBugDetails[];
-    /**
-     * Bugs that were reproduced in this run. This includes newly found bugs.
-     * Filter by `isBlocking` and read `applicationUrl` for blocking /
-     * non-blocking bug URLs.
-     */
-    reproducedBugs: CiGreenlightBugDetails[];
-};
-
-type CiGreenlightStatusBase = {
-    relevantRunId: string;
-    relevantRunUrl: string;
-    rootRunId: string;
-    rootRunUrl: string;
-};
-type CiGreenlightStatusExtended = {
-    relevantRunWithBugsUrl: 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
- */
-type CiGreenlightStatus = CiGreenlightStatusBase & (({
-    greenlight: boolean;
-    runStage: "completed";
-} & CiGreenlightBugData & CiGreenlightStatusExtended) | ({
-    greenlight: false;
-    runStage: "underReview";
-} & CiGreenlightBugData & CiGreenlightStatusExtended) | ({
-    greenlight: false;
-    runStage: "initializing";
-} & Partial<CiGreenlightStatusExtended>) | ({
-    greenlight: false;
-    /**
-     * Human-readable copy explaining why the run was canceled, when the
-     * server provides it.
-     */
-    message?: string;
-    /**
-     * Stable, machine-readable code for why the run was canceled, when the
-     * server provides it. Treat as an open set of values.
-     */
-    reason?: string;
-    runStage: "canceled";
-} & Partial<CiGreenlightStatusExtended>));
-
-type GenerateSignedUrlStatus = {
-    fileLocation?: string;
-    playgroundFileLocation?: string;
-    success: true;
-    uploadUrl?: string;
-} | {
-    abortReason: GenerateSignedUrlAbortReason$1;
-    httpStatus?: number;
-    success: false;
-};
-type GenerateSignedUrlAbortReason$1 = "client-network-error" | "sdk-argument-validation-failed" | "400-invalid-request" | "401-invalid-credentials" | "403-forbidden" | "5XX-server-error" | "XXX-other-http-code";
-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;
-};
-type GenerateSignedUrlResponse = {
-    errorMessage?: string;
-    fileLocation?: string;
-    httpStatus: number;
-    playgroundFileLocation?: string;
-    signedUrl?: string;
-    success: boolean;
-};
-
-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;
-};
-type GitHubDeployConfig = BaseDeployConfig & {
-    hostingService: "GitHub" | undefined;
-    pullRequestNumber: number | undefined;
-    repository: {
-        name: string;
-        owner: string;
-    } | undefined;
-};
-type GitLabDeployConfig = BaseDeployConfig & {
-    hostingService: "GitLab" | undefined;
-    mergeRequestNumber: number | undefined;
-    repository: {
-        name: string;
-        namespace: string;
-    } | undefined;
-};
-type EphemeralDeployConfig = BaseDeployConfig & {
-    deploymentUrl: string;
-    ephemeralEnvironment: true;
-};
-type DeployConfig = GitHubDeployConfig | GitLabDeployConfig | EphemeralDeployConfig;
-
-type WireSuiteResult = {
-    created_suite_id: string;
-    trigger_id: string;
-} | {
-    failure_reason: string;
-    trigger_id: string;
-} | {
-    duplicate_suite_id: string;
-    skip_reason: string;
-    trigger_id: string;
-} | {
-    trigger_id: string;
-};
-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;
-    }[];
-};
-
-type DeploySuccessSuiteCreatedResult = {
-    createdSuiteId: string;
-    triggerId: string;
-};
-type DeploySuccessSuiteCreationFailureResult = {
-    failureReason: string;
-    triggerId: string;
-};
-type DeploySuccessSuiteAlreadyExistsResult = {
-    duplicateSuiteId: string;
-    skipReason: string;
-    triggerId: string;
-};
-type DeploySuccessSuiteUnrecognizedResult = {
-    triggerId: string;
-    unrecognized: true;
-};
-type DeploySuccessSuiteResult = DeploySuccessSuiteCreatedResult | DeploySuccessSuiteCreationFailureResult | DeploySuccessSuiteAlreadyExistsResult | DeploySuccessSuiteUnrecognizedResult;
-type DeploySuccessSkippedTrigger = {
-    environmentId: string;
-    message: string;
-    reason: string;
-    triggerId: string;
-};
-type DeploySuccessDeploymentSkipped = {
-    message: string;
-    reason: string;
-};
-type DeployStatus = {
-    environment: {
-        alias?: string;
-        id: string;
-        isStatic: boolean;
-    } | undefined;
-    results: Array<DeploySuccessSuiteResult>;
-    skippedDeployment?: DeploySuccessDeploymentSkipped;
-    skippedTriggers?: DeploySuccessSkippedTrigger[];
-};
-type DeployStatusSuccessResponse = {
-    data: DeployStatus;
-    ok: true;
-    status: number;
-};
-type DeployStatusErrorResponse = {
-    data: undefined;
-    ok: false;
-    status: number | undefined;
-};
-type DeployStatusResponse = DeployStatusSuccessResponse | DeployStatusErrorResponse;
-type AttemptDeployHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "5XX-server-error" | "network-error";
-type AttemptDeployNonHttpAbortReason = "network-error" | "invalid-response-body";
-type AttemptDeployAbortReason = AttemptDeployHttpAbortReason | AttemptDeployNonHttpAbortReason;
-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";
-};
-type AttemptDeployFailedReason = Extract<NotifyDeployStatus, {
-    outcome: "failed";
-}>["failReason"];
-
-/**
- * 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;
-};
-type NotifyTerminatedEphemeralEnvironmentInput = {
-    environmentId: string;
-} | ({
-    deploymentUrl: string;
-} & WorkspaceLookup) | ({
-    environmentAlias: string;
-} & WorkspaceLookup);
-type NotifyTerminatedEphemeralEnvironmentFailedReason = "environmentNotFound" | "missingLookup" | "alreadyTerminated";
-type NotifyTerminatedEphemeralEnvironmentHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "409-conflict" | "5XX-server-error" | "network-error";
-type NotifyTerminatedEphemeralEnvironmentNonHttpAbortReason = "network-error";
-type NotifyTerminatedEphemeralEnvironmentAbortReason = NotifyTerminatedEphemeralEnvironmentHttpAbortReason | NotifyTerminatedEphemeralEnvironmentNonHttpAbortReason;
-type TerminatedEphemeralEnvironmentSuccessResult = {
-    environmentId: string;
-};
-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";
-};
-
-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;
-};
-type PollCiGreenlightHttpAbortReason = "4XX-client-error" | "404-run-not-found" | "5XX-server-error" | "XXX-other-http-code";
-type PollCiGreenlightNonHttpAbortReason = "poll-timed-out" | "run-canceled" | "network-error" | "superseded-run";
-type PollCiGreenlightAbortReason = PollCiGreenlightNonHttpAbortReason | PollCiGreenlightHttpAbortReason;
-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";
-};
-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
- */
-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)
- */
-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, superseded)
- */
-type PollCiGreenlightIteratorNonHttpAborted = {
-    abortReason: Exclude<PollCiGreenlightNonHttpAbortReason, "superseded-run">;
-    elapsedMs: number;
-    httpStatus: undefined;
-    /**
-     * True when the iterator was aborted
-     */
-    isAborted: true;
-};
-/**
- * Yielded value from the async generator - either a status update or a terminal abort condition
- */
-type PollCiGreenlightIteration = PollCiGreenlightStatusIteration | PollCiGreenlightIteratorHttpAborted | PollCiGreenlightIteratorNonHttpAborted;
-/**
- * Parameters for the async generator
- */
-type MakePollCiGreenlightStatusIteratorParams = {
-    runId: string;
-} & Partial<PollCiGreenlightPollConfig>;
-
-type GenerateSignedUrlAbortReason = "client-network-error" | "sdk-argument-validation-failed" | "400-invalid-request" | "401-invalid-credentials" | "403-forbidden" | "5XX-server-error" | "XXX-other-http-code";
-
-declare function attemptNotifyDeploy(deps: SdkDependencies, apiConfig: ApiConfig, config: Partial<DeployConfig>): Promise<NotifyDeployStatus>;
-
-declare function makeQaWolfSdk({ apiKey, serviceBase, userAgent, }: {
-    apiKey: string;
-    serviceBase?: string;
-    userAgent?: string;
-}, { fetch, log, }?: Partial<SdkDependencies>): {
-    attemptNotifyDeploy: (config: Partial<DeployConfig>) => Promise<NotifyDeployStatus>;
-    generateSignedUrlForRunInputsExecutablesStorage: (config: GenerateSignedUrlConfig) => Promise<GenerateSignedUrlStatus>;
-    generateSignedUrlForTempTeamStorage: (config: GenerateSignedUrlConfig) => Promise<{
-        fileLocation?: string;
-        playgroundFileLocation?: string;
-        success: true;
-        uploadUrl?: string;
-    } | {
-        abortReason: GenerateSignedUrlAbortReason;
-        httpStatus?: number;
-        success: false;
-    }>;
-    makePollCiGreenlightStatusIterator: (args_0: MakePollCiGreenlightStatusIteratorParams) => AsyncGenerator<PollCiGreenlightIteration, void, unknown>;
-    notifyTerminatedEphemeralEnvironment: (config: NotifyTerminatedEphemeralEnvironmentInput) => Promise<NotifyTerminatedEphemeralEnvironmentResult>;
-    pollCiGreenlightStatus: (args_0: PollCiGreenlightParams) => Promise<PollCiGreenlightStatus>;
-};
-
-export { type AttemptDeployAbortReason, type AttemptDeployFailedReason, type AttemptDeployHttpAbortReason, type AttemptDeployNonHttpAbortReason, type CiGreenlightStatus, type CiGreenlightStatusBase, type DeployConfig, type DeployStatus, type DeployStatusErrorResponse, type DeployStatusResponse, type DeployStatusSuccessResponse, type DeploySuccessDeploymentSkipped, type DeploySuccessSkippedTrigger, type DeploySuccessSuiteAlreadyExistsResult, type DeploySuccessSuiteCreatedResult, type DeploySuccessSuiteCreationFailureResult, type DeploySuccessSuiteResult, type DeploySuccessSuiteUnrecognizedResult, type DeploySuccessWireResponse, type EphemeralDeployConfig, type FetchDriver, type GenerateSignedUrlAbortReason$1 as GenerateSignedUrlAbortReason, type GenerateSignedUrlConfig, type GenerateSignedUrlResponse, type GenerateSignedUrlStatus, type GitHubDeployConfig, type GitLabDeployConfig, type MakePollCiGreenlightStatusIteratorParams, type NotifyDeployStatus, type NotifyTerminatedEphemeralEnvironmentAbortReason, type NotifyTerminatedEphemeralEnvironmentFailedReason, type NotifyTerminatedEphemeralEnvironmentHttpAbortReason, type NotifyTerminatedEphemeralEnvironmentInput, type NotifyTerminatedEphemeralEnvironmentNonHttpAbortReason, type NotifyTerminatedEphemeralEnvironmentResult, type PollCiGreenlightAbortReason, type PollCiGreenlightHttpAbortReason, type PollCiGreenlightIteration, type PollCiGreenlightIteratorHttpAborted, type PollCiGreenlightIteratorNonHttpAborted, type PollCiGreenlightNonHttpAbortReason, type PollCiGreenlightParams, type PollCiGreenlightPollConfig, type PollCiGreenlightStatus, type PollCiGreenlightStatusIteration, type SdkDependencies, type TerminatedEphemeralEnvironmentSuccessResult, attemptNotifyDeploy, makeQaWolfSdk };
+export type { CiGreenlightStatus, CiGreenlightStatusBase, } from "./lib/api/index.js";
+export * from "./lib/sdk/dependencies.js";
+export * from "./lib/sdk/domain/attemptDeploy/types.js";
+export * from "./lib/sdk/index.js";