@qawolf/ci-sdk 0.23.0 → 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,352 @@
+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 URLs of the blocking bugs.
+     *
+     * @deprecated This field will be removed in the next major version.
+     * Prefer using `reproducedBugs` filtered by `isBlocking: true`, reading
+     * the `applicationUrl` field.
+     */
+    blockingBugUrls: string[];
+    /**
+     * The count of non-blocking bugs reproduced in the run.
+     */
+    nonBlockingBugsCount: number;
+    /**
+     * The URLs of the non-blocking bugs.
+     *
+     * @deprecated This field will be removed in the next major version.
+     * Prefer using `reproducedBugs` filtered by `isBlocking: false`, reading
+     * the `applicationUrl` field.
+     */
+    nonBlockingBugUrls: string[];
+    /**
+     * 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.
+     */
+    reproducedBugs: CiGreenlightBugDetails[];
+};
+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
+ */
+type CiGreenlightStatus = CiGreenlightStatusBase & (({
+    greenlight: boolean;
+    runStage: "completed";
+} & CiGreenlightBugData) | ({
+    greenlight: false;
+    runStage: "underReview";
+} & CiGreenlightBugData) | {
+    greenlight: false;
+    runStage: "initializing" | "underReview" | "canceled";
+});
+
+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;
+};
+type GenerateSignedUrlResponse = {
+    errorMessage?: string;
+    fileLocation?: string;
+    httpStatus: number;
+    playgroundFileLocation?: string;
+    signedUrl?: string;
+    success: boolean;
+};
+
+/**
+ * Refer to our official documentation for more information:
+ * https://qawolf.notion.site/dd72e46ceb7f451dae4e9ef06f64a2cc
+ */
+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;
+};
+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 DeployConfig = GitHubDeployConfig | GitLabDeployConfig;
+type DeploySuccessSuiteCreatedResult = {
+    created_suite_id: string;
+    trigger_id: string;
+};
+type DeploySuccessSuiteCreationFailureResult = {
+    failure_reason: string;
+    trigger_id: string;
+};
+type DeploySuccessSuiteAlreadyExistsResult = {
+    duplicate_suite_id: string;
+    skip_reason: string;
+    trigger_id: string;
+};
+type DeploySuccessSuiteResult = DeploySuccessSuiteCreatedResult | DeploySuccessSuiteCreationFailureResult | DeploySuccessSuiteAlreadyExistsResult;
+type DeployStatus = {
+    environment: {
+        alias?: string;
+        id: string;
+        isStatic: boolean;
+    } | undefined;
+    results: Array<DeploySuccessSuiteResult>;
+};
+type DeployStatusSuccessResponse = {
+    data: DeployStatus;
+    ok: true;
+    status: number;
+};
+type DeployStatusErrorResponse = {
+    data: undefined;
+    ok: false;
+    status: number | undefined;
+};
+type DeployStatusResponse = DeployStatusSuccessResponse | DeployStatusErrorResponse;
+type AttemptDeployFailedReason = "no-matched-trigger" | "no-environment" | "run-could-not-be-created" | "duplicate-suite";
+type AttemptDeployHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "5XX-server-error" | "network-error";
+type AttemptDeployNonHttpAbortReason = "network-error";
+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;
+} | {
+    failReason: AttemptDeployFailedReason;
+    /**
+     * 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 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>;
+declare function pollCiGreenlightStatus(deps: SdkDependencies, apiConfig: ApiConfig, { onRunStageChanged: onRunStageChanged, runId, ...pollConfig }: PollCiGreenlightParams): Promise<PollCiGreenlightStatus>;
+
+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;
+    }>;
+    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 DeploySuccessSuiteAlreadyExistsResult, type DeploySuccessSuiteCreatedResult, type DeploySuccessSuiteCreationFailureResult, type DeploySuccessSuiteResult, type FetchDriver, type GenerateSignedUrlAbortReason$1 as GenerateSignedUrlAbortReason, type GenerateSignedUrlConfig, type GenerateSignedUrlResponse, type GenerateSignedUrlStatus, type GitHubDeployConfig, type GitLabDeployConfig, type NotifyDeployStatus, type PollCiGreenlightAbortReason, type PollCiGreenlightHttpAbortReason, type PollCiGreenlightNonHttpAbortReason, type PollCiGreenlightParams, type PollCiGreenlightPollConfig, type PollCiGreenlightStatus, type SdkDependencies, attemptNotifyDeploy, makeQaWolfSdk, pollCiGreenlightStatus };