checkly 0.0.0-canary.7b9cf29

package/dist/constructs/api-check-codegen.js

@@ -0,0 +1,83 @@
+import { Codegen, validateScript } from './internal/codegen/index.js';
+import { expr, ident } from '../sourcegen/index.js';
+import { buildRuntimeCheckProps } from './check-codegen.js';
+import { valueForRequest } from './api-request-codegen.js';
+const construct = 'ApiCheck';
+export class ApiCheckCodegen extends Codegen {
+    describe(resource) {
+        return `API Check: ${resource.name}`;
+    }
+    gencode(logicalId, resource, context) {
+        const filePath = context.filePath('resources/api-checks', resource.name, {
+            tags: resource.tags,
+            isolate: true,
+            unique: true,
+        });
+        const file = this.program.generatedConstructFile(filePath.fullPath);
+        file.namedImport(construct, 'checkly/constructs');
+        file.section(expr(ident(construct), builder => {
+            builder.new(builder => {
+                builder.string(logicalId);
+                builder.object(builder => {
+                    if (resource.localSetupScript) {
+                        const content = resource.localSetupScript;
+                        validateScript(content);
+                        const snippetFiles = context.findScriptSnippetFiles(content);
+                        for (const snippetFile of snippetFiles) {
+                            const localSnippetFile = this.program.generatedSupportFile(`${file.dirname}/snippets/${snippetFile.basename}`);
+                            localSnippetFile.plainImport(localSnippetFile.relativePath(snippetFile));
+                        }
+                        builder.object('setupScript', builder => {
+                            const scriptFile = this.program.staticSupportFile(`${file.dirname}/setup-script`, content);
+                            builder.string('entrypoint', file.relativePath(scriptFile));
+                        });
+                    }
+                    else if (resource.setupSnippetId) {
+                        const snippetFile = context.lookupAuxiliarySnippetFile(resource.setupSnippetId);
+                        if (!snippetFile) {
+                            throw new Error(`Setup script refers to snippet #${resource.setupSnippetId} which is missing`);
+                        }
+                        const scriptFile = this.program.generatedSupportFile(`${file.dirname}/setup-script`);
+                        scriptFile.plainImport(scriptFile.relativePath(snippetFile));
+                        builder.object('setupScript', builder => {
+                            builder.string('entrypoint', file.relativePath(scriptFile));
+                        });
+                    }
+                    if (resource.localTearDownScript) {
+                        const content = resource.localTearDownScript;
+                        validateScript(content);
+                        const snippetFiles = context.findScriptSnippetFiles(content);
+                        for (const snippetFile of snippetFiles) {
+                            const aliasFile = this.program.generatedSupportFile(`${file.dirname}/snippets/${snippetFile.basename}`);
+                            aliasFile.plainImport(aliasFile.relativePath(snippetFile));
+                        }
+                        builder.object('tearDownScript', builder => {
+                            const scriptFile = this.program.staticSupportFile(`${file.dirname}/teardown-script`, content);
+                            builder.string('entrypoint', file.relativePath(scriptFile));
+                        });
+                    }
+                    else if (resource.tearDownSnippetId) {
+                        const snippetFile = context.lookupAuxiliarySnippetFile(resource.tearDownSnippetId);
+                        if (!snippetFile) {
+                            throw new Error(`Teardown script refers to snippet #${resource.tearDownSnippetId} which is missing`);
+                        }
+                        const scriptFile = this.program.generatedSupportFile(`${file.dirname}/teardown-script`);
+                        scriptFile.plainImport(scriptFile.relativePath(snippetFile));
+                        builder.object('tearDownScript', builder => {
+                            builder.string('entrypoint', file.relativePath(scriptFile));
+                        });
+                    }
+                    if (resource.degradedResponseTime !== undefined) {
+                        builder.number('degradedResponseTime', resource.degradedResponseTime);
+                    }
+                    if (resource.maxResponseTime !== undefined) {
+                        builder.number('maxResponseTime', resource.maxResponseTime);
+                    }
+                    buildRuntimeCheckProps(this.program, file, builder, resource, context);
+                    builder.value('request', valueForRequest(this.program, file, context, resource.request));
+                });
+            });
+        }));
+    }
+}
+//# sourceMappingURL=api-check-codegen.js.map

package/dist/constructs/api-check-codegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-check-codegen.js","sourceRoot":"","sources":["../../src/constructs/api-check-codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAW,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC9E,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,sBAAsB,EAAwB,MAAM,oBAAoB,CAAA;AAEjF,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAe1D,MAAM,SAAS,GAAG,UAAU,CAAA;AAE5B,MAAM,OAAO,eAAgB,SAAQ,OAAyB;IAC5D,QAAQ,CAAE,QAA0B;QAClC,OAAO,cAAc,QAAQ,CAAC,IAAI,EAAE,CAAA;IACtC,CAAC;IAED,OAAO,CAAE,SAAiB,EAAE,QAA0B,EAAE,OAAgB;QACtE,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,sBAAsB,EAAE,QAAQ,CAAC,IAAI,EAAE;YACvE,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,IAAI;SACb,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAEnE,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAA;QAEjD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE;YAC5C,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBACpB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;gBACzB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;oBACvB,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;wBAC9B,MAAM,OAAO,GAAG,QAAQ,CAAC,gBAAgB,CAAA;wBACzC,cAAc,CAAC,OAAO,CAAC,CAAA;wBAEvB,MAAM,YAAY,GAAG,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAA;wBAC5D,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;4BACvC,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,OAAO,aAAa,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAA;4BAC9G,gBAAgB,CAAC,WAAW,CAAC,gBAAgB,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAA;wBAC1E,CAAC;wBAED,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;4BACtC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,OAAO,CAAC,CAAA;4BAC1F,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAA;wBAC7D,CAAC,CAAC,CAAA;oBACJ,CAAC;yBAAM,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;wBACnC,MAAM,WAAW,GAAG,OAAO,CAAC,0BAA0B,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;wBAC/E,IAAI,CAAC,WAAW,EAAE,CAAC;4BACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,CAAC,cAAc,mBAAmB,CAAC,CAAA;wBAChG,CAAC;wBAED,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,OAAO,eAAe,CAAC,CAAA;wBACpF,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAA;wBAE5D,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;4BACtC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAA;wBAC7D,CAAC,CAAC,CAAA;oBACJ,CAAC;oBAED,IAAI,QAAQ,CAAC,mBAAmB,EAAE,CAAC;wBACjC,MAAM,OAAO,GAAG,QAAQ,CAAC,mBAAmB,CAAA;wBAC5C,cAAc,CAAC,OAAO,CAAC,CAAA;wBAEvB,MAAM,YAAY,GAAG,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAA;wBAC5D,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;4BACvC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,OAAO,aAAa,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAA;4BACvG,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAA;wBAC5D,CAAC;wBAED,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,OAAO,CAAC,EAAE;4BACzC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,OAAO,kBAAkB,EAAE,OAAO,CAAC,CAAA;4BAC7F,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAA;wBAC7D,CAAC,CAAC,CAAA;oBACJ,CAAC;yBAAM,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;wBACtC,MAAM,WAAW,GAAG,OAAO,CAAC,0BAA0B,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAA;wBAClF,IAAI,CAAC,WAAW,EAAE,CAAC;4BACjB,MAAM,IAAI,KAAK,CAAC,sCAAsC,QAAQ,CAAC,iBAAiB,mBAAmB,CAAC,CAAA;wBACtG,CAAC;wBAED,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAAA;wBACvF,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAA;wBAE5D,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,OAAO,CAAC,EAAE;4BACzC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAA;wBAC7D,CAAC,CAAC,CAAA;oBACJ,CAAC;oBAED,IAAI,QAAQ,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;wBAChD,OAAO,CAAC,MAAM,CAAC,sBAAsB,EAAE,QAAQ,CAAC,oBAAoB,CAAC,CAAA;oBACvE,CAAC;oBAED,IAAI,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;wBAC3C,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAA;oBAC7D,CAAC;oBAED,sBAAsB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;oBAEtE,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;gBAC1F,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAC,CAAA;IACL,CAAC;CACF"}

package/dist/constructs/api-check.d.ts

@@ -0,0 +1,193 @@
+import { RuntimeCheck, RuntimeCheckProps } from './check.js';
+import { HttpHeader } from './http-header.js';
+import { BasicAuth, Request } from './api-request.js';
+import { QueryParam } from './query-param.js';
+import { Content, Entrypoint } from './construct.js';
+import { Diagnostics } from './diagnostics.js';
+import { ApiCheckBundle } from './api-check-bundle.js';
+import { Assertion } from './api-assertion.js';
+import { Bundler } from '../services/check-parser/bundler.js';
+/**
+ * Default configuration that can be applied to API checks.
+ * Used for setting common defaults across multiple checks.
+ */
+export type ApiCheckDefaultConfig = {
+    /** Default URL for API requests */
+    url?: string;
+    /** Default HTTP headers to include */
+    headers?: Array<HttpHeader>;
+    /** Default query parameters to include */
+    queryParameters?: Array<QueryParam>;
+    /** Default basic authentication credentials */
+    basicAuth?: BasicAuth;
+    /** Default assertions to apply */
+    assertions?: Array<Assertion>;
+};
+export interface ApiCheckProps extends RuntimeCheckProps {
+    /**
+     *  Determines the request that the check is going to run.
+     */
+    request: Request;
+    /**
+     * A valid piece of Node.js code to run in the setup phase.
+     * @deprecated use the "setupScript" property instead
+     */
+    localSetupScript?: string;
+    /**
+     * A valid piece of Node.js code to run in the setup phase.
+     */
+    setupScript?: Content | Entrypoint;
+    /**
+     * A valid piece of Node.js code to run in the teardown phase.
+     * @deprecated use the "tearDownScript" property instead
+     */
+    localTearDownScript?: string;
+    /**
+     * A valid piece of Node.js code to run in the teardown phase.
+     */
+    tearDownScript?: Content | Entrypoint;
+    /**
+     * The response time in milliseconds where a check should be considered degraded.
+     * Used for performance monitoring and alerting on slow responses.
+     *
+     * @defaultValue 10000
+     * @minimum 0
+     * @maximum 30000
+     * @example
+     * ```typescript
+     * degradedResponseTime: 2000  // Alert when API responds slower than 2 seconds
+     * ```
+     */
+    degradedResponseTime?: number;
+    /**
+     * The response time in milliseconds where a check should be considered failing.
+     * The check fails if the response takes longer than this threshold.
+     *
+     * @defaultValue 20000
+     * @minimum 0
+     * @maximum 30000
+     * @example
+     * ```typescript
+     * maxResponseTime: 5000  // Fail check if API takes longer than 5 seconds
+     * ```
+     */
+    maxResponseTime?: number;
+}
+/**
+ * Creates an API Check to monitor HTTP endpoints and APIs.
+ *
+ * API checks allow you to monitor REST APIs, GraphQL endpoints, and any HTTP-based service.
+ * You can validate response status codes, response times, headers, and response body content.
+ *
+ * @example
+ * ```typescript
+ * // Basic API check
+ * new ApiCheck('hello-api', {
+ *   name: 'Hello API',
+ *   request: {
+ *     method: 'GET',
+ *     url: 'https://api.example.com/hello',
+ *     assertions: [
+ *       AssertionBuilder.statusCode().equals(200)
+ *     ]
+ *   }
+ * })
+ *
+ * // Advanced API check with POST request
+ * new ApiCheck('user-api', {
+ *   name: 'User API Check',
+ *   frequency: Frequency.EVERY_5M,
+ *   locations: ['us-east-1', 'eu-west-1'],
+ *   request: {
+ *     method: 'POST',
+ *     url: 'https://api.example.com/users',
+ *     headers: [{ key: 'Content-Type', value: 'application/json' }],
+ *     body: JSON.stringify({ name: 'test-user' }),
+ *     bodyType: 'JSON',
+ *     assertions: [
+ *       AssertionBuilder.statusCode().equals(201),
+ *       AssertionBuilder.jsonBody('$.id').isNotNull(),
+ *       AssertionBuilder.responseTime().lessThan(1000)
+ *     ]
+ *   },
+ *   maxResponseTime: 5000,
+ *   degradedResponseTime: 2000
+ * })
+ *
+ * // Error validation check (shouldFail required for error status checks)
+ * new ApiCheck('not-found-check', {
+ *   name: 'Not Found Check',
+ *   shouldFail: true,
+ *   request: {
+ *     method: 'GET',
+ *     url: 'https://api.example.com/nonexistent',
+ *     assertions: [
+ *       AssertionBuilder.statusCode().equals(404)
+ *     ]
+ *   }
+ * })
+ * ```
+ *
+ * @see {@link https://www.checklyhq.com/docs/constructs/api-check/ | ApiCheck API Reference}
+ * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/overview/ | API Checks Documentation}
+ */
+export declare class ApiCheck extends RuntimeCheck {
+    readonly request: Request;
+    readonly localSetupScript?: string;
+    readonly setupScript?: Content | Entrypoint;
+    readonly localTearDownScript?: string;
+    readonly tearDownScript?: Content | Entrypoint;
+    readonly degradedResponseTime?: number;
+    readonly maxResponseTime?: number;
+    /**
+     * Constructs the API Check instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props check configuration properties
+     *
+     * {@link https://www.checklyhq.com/docs/constructs/api-check/ Read more in the docs}
+     */
+    constructor(logicalId: string, props: ApiCheckProps);
+    describe(): string;
+    protected supportsOnlyOnNetworkErrorRetryStrategy(): boolean;
+    validate(diagnostics: Diagnostics): Promise<void>;
+    bundle(bundler: Bundler): Promise<ApiCheckBundle>;
+    static bundle(bundler: Bundler, entrypoint: string, runtimeId?: string): Promise<{
+        script: string;
+        scriptPath: string;
+        dependencies: number[];
+    }>;
+    synthesize(): {
+        checkType: string;
+        request: Request;
+        localSetupScript: string | undefined;
+        localTearDownScript: string | undefined;
+        degradedResponseTime: number | undefined;
+        maxResponseTime: number | undefined;
+        runtimeId: string | undefined;
+        environmentVariables: import("./key-value-pair.js").default[] | undefined;
+        activated: boolean | undefined;
+        muted: boolean | undefined;
+        shouldFail: boolean | undefined;
+        locations: (keyof import("../index.js").Region)[] | undefined;
+        privateLocations: undefined;
+        tags: string[] | undefined;
+        frequency: number | undefined;
+        frequencyOffset: number | undefined;
+        groupId: import("./ref.js").Ref | null;
+        retryStrategy: import("./retry-strategy.js").LinearRetryStrategy | import("./retry-strategy.js").ExponentialRetryStrategy | import("./retry-strategy.js").FixedRetryStrategy | import("./retry-strategy.js").SingleRetryRetryStrategy | null | undefined;
+        doubleCheck: boolean | undefined;
+        alertSettings: import("./alert-escalation-policy.js").AlertEscalation | undefined;
+        useGlobalAlertSettings: boolean | undefined;
+        runParallel: boolean | undefined;
+        triggerIncident: {
+            serviceId: import("./ref.js").Ref;
+            severity: "MINOR" | "MEDIUM" | "MAJOR" | "CRITICAL";
+            name: string;
+            description: string;
+            notifySubscribers: boolean;
+        } | undefined;
+        description?: string | undefined;
+        name: string;
+    };
+}

package/dist/constructs/api-check.js

@@ -0,0 +1,219 @@
+import fs from 'node:fs/promises';
+import { RuntimeCheck } from './check.js';
+import { Session } from './session.js';
+import { isContent, isEntrypoint } from './construct.js';
+import { DeprecatedPropertyDiagnostic, InvalidPropertyValueDiagnostic } from './construct-diagnostics.js';
+import { ApiCheckBundle } from './api-check-bundle.js';
+import { validateResponseTimes } from './internal/common-diagnostics.js';
+/**
+ * Creates an API Check to monitor HTTP endpoints and APIs.
+ *
+ * API checks allow you to monitor REST APIs, GraphQL endpoints, and any HTTP-based service.
+ * You can validate response status codes, response times, headers, and response body content.
+ *
+ * @example
+ * ```typescript
+ * // Basic API check
+ * new ApiCheck('hello-api', {
+ *   name: 'Hello API',
+ *   request: {
+ *     method: 'GET',
+ *     url: 'https://api.example.com/hello',
+ *     assertions: [
+ *       AssertionBuilder.statusCode().equals(200)
+ *     ]
+ *   }
+ * })
+ *
+ * // Advanced API check with POST request
+ * new ApiCheck('user-api', {
+ *   name: 'User API Check',
+ *   frequency: Frequency.EVERY_5M,
+ *   locations: ['us-east-1', 'eu-west-1'],
+ *   request: {
+ *     method: 'POST',
+ *     url: 'https://api.example.com/users',
+ *     headers: [{ key: 'Content-Type', value: 'application/json' }],
+ *     body: JSON.stringify({ name: 'test-user' }),
+ *     bodyType: 'JSON',
+ *     assertions: [
+ *       AssertionBuilder.statusCode().equals(201),
+ *       AssertionBuilder.jsonBody('$.id').isNotNull(),
+ *       AssertionBuilder.responseTime().lessThan(1000)
+ *     ]
+ *   },
+ *   maxResponseTime: 5000,
+ *   degradedResponseTime: 2000
+ * })
+ *
+ * // Error validation check (shouldFail required for error status checks)
+ * new ApiCheck('not-found-check', {
+ *   name: 'Not Found Check',
+ *   shouldFail: true,
+ *   request: {
+ *     method: 'GET',
+ *     url: 'https://api.example.com/nonexistent',
+ *     assertions: [
+ *       AssertionBuilder.statusCode().equals(404)
+ *     ]
+ *   }
+ * })
+ * ```
+ *
+ * @see {@link https://www.checklyhq.com/docs/constructs/api-check/ | ApiCheck API Reference}
+ * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/overview/ | API Checks Documentation}
+ */
+export class ApiCheck extends RuntimeCheck {
+    request;
+    localSetupScript;
+    setupScript;
+    localTearDownScript;
+    tearDownScript;
+    degradedResponseTime;
+    maxResponseTime;
+    /**
+     * Constructs the API Check instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props check configuration properties
+     *
+     * {@link https://www.checklyhq.com/docs/constructs/api-check/ Read more in the docs}
+     */
+    constructor(logicalId, props) {
+        super(logicalId, props);
+        this.setupScript = props.setupScript;
+        this.localSetupScript = props.localSetupScript;
+        this.tearDownScript = props.tearDownScript;
+        this.localTearDownScript = props.localTearDownScript;
+        this.request = props.request;
+        this.degradedResponseTime = props.degradedResponseTime;
+        this.maxResponseTime = props.maxResponseTime;
+        Session.registerConstruct(this);
+        this.addSubscriptions();
+        this.addPrivateLocationCheckAssignments();
+    }
+    describe() {
+        return `ApiCheck:${this.logicalId}`;
+    }
+    supportsOnlyOnNetworkErrorRetryStrategy() {
+        return true;
+    }
+    async validate(diagnostics) {
+        await super.validate(diagnostics);
+        if (this.setupScript) {
+            if (!isEntrypoint(this.setupScript) && !isContent(this.setupScript)) {
+                diagnostics.add(new InvalidPropertyValueDiagnostic('setupScript', new Error(`Either "entrypoint" or "content" is required.`)));
+            }
+            else if (isEntrypoint(this.setupScript) && isContent(this.setupScript)) {
+                diagnostics.add(new InvalidPropertyValueDiagnostic('setupScript', new Error(`Provide exactly one of "entrypoint" or "content", but not both.`)));
+            }
+            else if (isEntrypoint(this.setupScript)) {
+                const entrypoint = this.resolveContentFilePath(this.setupScript.entrypoint);
+                try {
+                    await fs.access(entrypoint, fs.constants.R_OK);
+                }
+                catch (err) {
+                    diagnostics.add(new InvalidPropertyValueDiagnostic('setupScript', new Error(`Unable to access entrypoint file "${entrypoint}": ${err.message}`, { cause: err })));
+                }
+            }
+        }
+        if (this.localSetupScript) {
+            diagnostics.add(new DeprecatedPropertyDiagnostic('localSetupScript', new Error(`Use "setupScript" instead.`)));
+        }
+        if (this.tearDownScript) {
+            if (!isEntrypoint(this.tearDownScript) && !isContent(this.tearDownScript)) {
+                diagnostics.add(new InvalidPropertyValueDiagnostic('tearDownScript', new Error(`Either "entrypoint" or "content" is required.`)));
+            }
+            else if (isEntrypoint(this.tearDownScript) && isContent(this.tearDownScript)) {
+                diagnostics.add(new InvalidPropertyValueDiagnostic('tearDownScript', new Error(`Provide exactly one of "entrypoint" or "content", but not both.`)));
+            }
+            else if (isEntrypoint(this.tearDownScript)) {
+                const entrypoint = this.resolveContentFilePath(this.tearDownScript.entrypoint);
+                try {
+                    await fs.access(entrypoint, fs.constants.R_OK);
+                }
+                catch (err) {
+                    diagnostics.add(new InvalidPropertyValueDiagnostic('tearDownScript', new Error(`Unable to access entrypoint file "${entrypoint}": ${err.message}`, { cause: err })));
+                }
+            }
+        }
+        if (this.localTearDownScript) {
+            diagnostics.add(new DeprecatedPropertyDiagnostic('localTearDownScript', new Error(`Use "tearDownScript" instead.`)));
+        }
+        if (this.runtimeId) {
+            const runtime = Session.getRuntime(this.runtimeId);
+            if (!runtime) {
+                diagnostics.add(new InvalidPropertyValueDiagnostic('runtimeId', new Error(`"${this.runtimeId}" is not a known runtime.`)));
+            }
+        }
+        await validateResponseTimes(diagnostics, this, {
+            degradedResponseTime: 30_000,
+            maxResponseTime: 30_000,
+        });
+    }
+    async bundle(bundler) {
+        const props = {};
+        if (this.localSetupScript) {
+            props.localSetupScript = this.localSetupScript;
+        }
+        if (this.setupScript) {
+            if (isEntrypoint(this.setupScript)) {
+                const { script, scriptPath, dependencies } = await ApiCheck.bundle(bundler, this.resolveContentFilePath(this.setupScript.entrypoint), this.runtimeId);
+                props.localSetupScript = script;
+                props.setupScriptPath = scriptPath;
+                props.setupScriptDependencies = dependencies;
+            }
+            else {
+                props.localSetupScript = this.setupScript.content;
+            }
+        }
+        if (this.localTearDownScript) {
+            props.localTearDownScript = this.localTearDownScript;
+        }
+        if (this.tearDownScript) {
+            if (isEntrypoint(this.tearDownScript)) {
+                const { script, scriptPath, dependencies } = await ApiCheck.bundle(bundler, this.resolveContentFilePath(this.tearDownScript.entrypoint), this.runtimeId);
+                props.localTearDownScript = script;
+                props.tearDownScriptPath = scriptPath;
+                props.tearDownScriptDependencies = dependencies;
+            }
+            else {
+                props.localTearDownScript = this.tearDownScript.content;
+            }
+        }
+        return new ApiCheckBundle(this, props);
+    }
+    static async bundle(bundler, entrypoint, runtimeId) {
+        const runtime = Session.getRuntime(runtimeId);
+        if (!runtime) {
+            throw new Error(`${runtimeId} is not supported`);
+        }
+        const parser = Session.getParser(runtime);
+        const parsed = await parser.parse(entrypoint);
+        // Maybe we can get the parsed deps with the content immediately
+        const deps = [];
+        for (const { filePath, content } of parsed.dependencies) {
+            deps.push(Session.registerSharedFile({
+                path: Session.relativePosixPath(filePath),
+                content,
+            }));
+        }
+        return {
+            script: parsed.entrypoint.content,
+            scriptPath: Session.relativePosixPath(parsed.entrypoint.filePath),
+            dependencies: deps,
+        };
+    }
+    synthesize() {
+        return {
+            ...super.synthesize(),
+            checkType: 'API',
+            request: this.request,
+            localSetupScript: this.localSetupScript,
+            localTearDownScript: this.localTearDownScript,
+            degradedResponseTime: this.degradedResponseTime,
+            maxResponseTime: this.maxResponseTime,
+        };
+    }
+}
+//# sourceMappingURL=api-check.js.map

package/dist/constructs/api-check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-check.js","sourceRoot":"","sources":["../../src/constructs/api-check.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAEjC,OAAO,EAAE,YAAY,EAAqB,MAAM,YAAY,CAAA;AAG5D,OAAO,EAAE,OAAO,EAAiB,MAAM,cAAc,CAAA;AAErD,OAAO,EAAuB,SAAS,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7E,OAAO,EAAE,4BAA4B,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAA;AACzG,OAAO,EAAE,cAAc,EAAuB,MAAM,uBAAuB,CAAA;AAE3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAA;AAwExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,MAAM,OAAO,QAAS,SAAQ,YAAY;IAC/B,OAAO,CAAS;IAChB,gBAAgB,CAAS;IACzB,WAAW,CAAuB;IAClC,mBAAmB,CAAS;IAC5B,cAAc,CAAuB;IACrC,oBAAoB,CAAS;IAC7B,eAAe,CAAS;IAEjC;;;;;;;OAOG;IAEH,YAAa,SAAiB,EAAE,KAAoB;QAClD,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QAEvB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAA;QAC9C,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;QAC1C,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAA;QACpD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,CAAA;QACtD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAA;QAE5C,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC/B,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,IAAI,CAAC,kCAAkC,EAAE,CAAA;IAC3C,CAAC;IAED,QAAQ;QACN,OAAO,YAAY,IAAI,CAAC,SAAS,EAAE,CAAA;IACrC,CAAC;IAES,uCAAuC;QAC/C,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,WAAwB;QACtC,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QAEjC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBACpE,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,aAAa,EACb,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAC3D,CAAC,CAAA;YACJ,CAAC;iBAAM,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBACzE,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,aAAa,EACb,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAC7E,CAAC,CAAA;YACJ,CAAC;iBAAM,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAA;gBAC3E,IAAI,CAAC;oBACH,MAAM,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;gBAChD,CAAC;gBAAC,OAAO,GAAQ,EAAE,CAAC;oBAClB,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,aAAa,EACb,IAAI,KAAK,CAAC,qCAAqC,UAAU,MAAM,GAAG,CAAC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAC9F,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,WAAW,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAC9C,kBAAkB,EAClB,IAAI,KAAK,CAAC,4BAA4B,CAAC,CACxC,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC1E,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,gBAAgB,EAChB,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAC3D,CAAC,CAAA;YACJ,CAAC;iBAAM,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC/E,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,gBAAgB,EAChB,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAC7E,CAAC,CAAA;YACJ,CAAC;iBAAM,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;gBAC9E,IAAI,CAAC;oBACH,MAAM,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;gBAChD,CAAC;gBAAC,OAAO,GAAQ,EAAE,CAAC;oBAClB,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,gBAAgB,EAChB,IAAI,KAAK,CAAC,qCAAqC,UAAU,MAAM,GAAG,CAAC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAC9F,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,WAAW,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAC9C,qBAAqB,EACrB,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAC3C,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAClD,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,WAAW,EACX,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,2BAA2B,CAAC,CACzD,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,MAAM,qBAAqB,CAAC,WAAW,EAAE,IAAI,EAAE;YAC7C,oBAAoB,EAAE,MAAM;YAC5B,eAAe,EAAE,MAAM;SACxB,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAE,OAAgB;QAC5B,MAAM,KAAK,GAAwB,EAAE,CAAA;QAErC,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAA;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBACnC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAChE,OAAO,EACP,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EACxD,IAAI,CAAC,SAAS,CACf,CAAA;gBACD,KAAK,CAAC,gBAAgB,GAAG,MAAM,CAAA;gBAC/B,KAAK,CAAC,eAAe,GAAG,UAAU,CAAA;gBAClC,KAAK,CAAC,uBAAuB,GAAG,YAAY,CAAA;YAC9C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAA;YACnD,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAA;QACtD,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;gBACtC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAChE,OAAO,EACP,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAC3D,IAAI,CAAC,SAAS,CACf,CAAA;gBACD,KAAK,CAAC,mBAAmB,GAAG,MAAM,CAAA;gBAClC,KAAK,CAAC,kBAAkB,GAAG,UAAU,CAAA;gBACrC,KAAK,CAAC,0BAA0B,GAAG,YAAY,CAAA;YACjD,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAA;YACzD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IACxC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,MAAM,CAAE,OAAgB,EAAE,UAAkB,EAAE,SAAkB;QAC3E,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;QAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAA;QAClD,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QACzC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAC7C,gEAAgE;QAEhE,MAAM,IAAI,GAAoB,EAAE,CAAA;QAChC,KAAK,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;gBACnC,IAAI,EAAE,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC;gBACzC,OAAO;aACR,CAAC,CAAC,CAAA;QACL,CAAC;QACD,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO;YACjC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;YACjE,YAAY,EAAE,IAAI;SACnB,CAAA;IACH,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,KAAK,CAAC,UAAU,EAAE;YACrB,SAAS,EAAE,KAAK;YAChB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,eAAe,EAAE,IAAI,CAAC,eAAe;SACtC,CAAA;IACH,CAAC;CACF"}

package/dist/constructs/api-request-codegen.d.ts

@@ -0,0 +1,4 @@
+import { GeneratedFile, Program, Value } from '../sourcegen/index.js';
+import { Request } from './api-request.js';
+import { Context } from './internal/codegen/index.js';
+export declare function valueForRequest(program: Program, genfile: GeneratedFile, context: Context, request: Request): Value;

package/dist/constructs/api-request-codegen.js

@@ -0,0 +1,64 @@
+import { object } from '../sourcegen/index.js';
+import { valueForAssertion } from './api-assertion-codegen.js';
+import { valueForKeyValuePair } from './key-value-pair-codegen.js';
+export function valueForRequest(program, genfile, context, request) {
+    return object(builder => {
+        builder.string('url', request.url);
+        builder.string('method', request.method);
+        if (request.ipFamily && request.ipFamily !== 'IPv4') {
+            builder.string('ipFamily', request.ipFamily);
+        }
+        if (request.followRedirects === false) {
+            builder.boolean('followRedirects', request.followRedirects);
+        }
+        if (request.skipSSL === true) {
+            builder.boolean('skipSSL', request.skipSSL);
+        }
+        if (request.body !== undefined && request.body !== '') {
+            builder.string('body', request.body);
+        }
+        if (request.bodyType && request.bodyType !== 'NONE') {
+            builder.string('bodyType', request.bodyType);
+        }
+        if (request.headers) {
+            const headers = request.headers;
+            if (headers.length > 0) {
+                builder.array('headers', builder => {
+                    for (const header of headers) {
+                        builder.value(valueForKeyValuePair(program, genfile, context, header));
+                    }
+                });
+            }
+        }
+        if (request.queryParameters) {
+            const queryParameters = request.queryParameters;
+            if (queryParameters.length > 0) {
+                builder.array('queryParameters', builder => {
+                    for (const param of queryParameters) {
+                        builder.value(valueForKeyValuePair(program, genfile, context, param));
+                    }
+                });
+            }
+        }
+        if (request.basicAuth) {
+            const basicAuth = request.basicAuth;
+            if (basicAuth.username !== '' && basicAuth.password !== '') {
+                builder.object('basicAuth', builder => {
+                    builder.string('username', basicAuth.username);
+                    builder.string('password', basicAuth.password);
+                });
+            }
+        }
+        if (request.assertions) {
+            const assertions = request.assertions;
+            if (assertions.length > 0) {
+                builder.array('assertions', builder => {
+                    for (const assertion of assertions) {
+                        builder.value(valueForAssertion(genfile, assertion));
+                    }
+                });
+            }
+        }
+    });
+}
+//# sourceMappingURL=api-request-codegen.js.map

package/dist/constructs/api-request-codegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-request-codegen.js","sourceRoot":"","sources":["../../src/constructs/api-request-codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,MAAM,EAAkB,MAAM,uBAAuB,CAAA;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAG9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAElE,MAAM,UAAU,eAAe,CAC7B,OAAgB,EAChB,OAAsB,EACtB,OAAgB,EAChB,OAAgB;IAEhB,OAAO,MAAM,CAAC,OAAO,CAAC,EAAE;QACtB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAA;QAClC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QAExC,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YACpD,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9C,CAAC;QAED,IAAI,OAAO,CAAC,eAAe,KAAK,KAAK,EAAE,CAAC;YACtC,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAA;QAC7D,CAAC;QAED,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YAC7B,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;QAC7C,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;YACtD,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;QACtC,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YACpD,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9C,CAAC;QAED,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;YAC/B,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE;oBACjC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;wBAC7B,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;oBACxE,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;YAC5B,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;YAC/C,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC/B,OAAO,CAAC,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,EAAE;oBACzC,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE,CAAC;wBACpC,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;oBACvE,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;YACnC,IAAI,SAAS,CAAC,QAAQ,KAAK,EAAE,IAAI,SAAS,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;gBAC3D,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE;oBACpC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;oBAC9C,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;gBAChD,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;YACrC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,EAAE;oBACpC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;wBACnC,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAA;oBACtD,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/constructs/api-request.d.ts

@@ -0,0 +1,67 @@
+import { Assertion } from './api-assertion.js';
+import { HttpHeader } from './http-header.js';
+import { HttpRequestMethod } from './http-request.js';
+import { IPFamily } from './ip.js';
+import { QueryParam } from './query-param.js';
+/** HTTP request body types supported by API checks */
+export type BodyType = 'JSON' | 'FORM' | 'RAW' | 'GRAPHQL' | 'NONE';
+/**
+ * Basic authentication credentials for HTTP requests.
+ */
+export interface BasicAuth {
+    /** Username for basic authentication */
+    username: string;
+    /** Password for basic authentication */
+    password: string;
+}
+/**
+ * Configuration for an HTTP request in an API check.
+ * Defines all aspects of the HTTP request to be made.
+ */
+export interface Request {
+    /**
+     * The URL to make the request to.
+     * @maxLength 2048
+     * @example 'https://api.example.com/users'
+     */
+    url: string;
+    /**
+     * The HTTP method to use.
+     * Supported methods: GET, POST, PUT, HEAD, DELETE, PATCH
+     */
+    method: HttpRequestMethod;
+    /**
+     * IP family version to use for network requests.
+     * @defaultValue 'IPv4'
+     */
+    ipFamily?: IPFamily;
+    /**
+     * Whether to follow HTTP redirects automatically.
+     * @defaultValue true
+     */
+    followRedirects?: boolean;
+    /**
+     * Whether to skip SSL certificate verification.
+     * @defaultValue false
+     */
+    skipSSL?: boolean;
+    /**
+     * Assertions to validate the HTTP response.
+     * Check the main Checkly documentation on assertions for specific values like regular expressions
+     * and JSON path descriptors you can use in the "property" field.
+     */
+    assertions?: Array<Assertion>;
+    /** The request body content */
+    body?: string;
+    /**
+     * The type of the request body.
+     * @defaultValue 'NONE'
+     */
+    bodyType?: BodyType;
+    /** HTTP headers to include in the request */
+    headers?: Array<HttpHeader>;
+    /** Query parameters to include in the request URL */
+    queryParameters?: Array<QueryParam>;
+    /** Basic authentication credentials */
+    basicAuth?: BasicAuth;
+}

package/dist/constructs/api-request.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api-request.js.map