checkly 0.0.0-pr.1006.2fb1ffc

package/dist/constructs/alert-escalation-policy.d.ts

@@ -0,0 +1,34 @@
+declare enum AlertEscalationType {
+    RUN = "RUN_BASED",
+    TIME = "TIME_BASED"
+}
+export type Reminders = {
+    amount?: number;
+    interval?: number;
+};
+export type ParallelRunFailureThreshold = {
+    enabled?: boolean;
+    percentage?: number;
+};
+export interface AlertEscalation {
+    escalationType?: AlertEscalationType;
+    runBasedEscalation?: {
+        failedRunThreshold?: number;
+    };
+    timeBasedEscalation?: {
+        minutesFailingThreshold?: number;
+    };
+    reminders?: Reminders;
+    parallelRunFailureThreshold?: ParallelRunFailureThreshold;
+}
+export type AlertEscalationOptions = Pick<AlertEscalation, 'runBasedEscalation' | 'timeBasedEscalation' | 'reminders' | 'parallelRunFailureThreshold'>;
+export declare class AlertEscalationBuilder {
+    private static DEFAULT_RUN_BASED_ESCALATION;
+    private static DEFAULT_TIME_BASED_ESCALATION;
+    private static DEFAULT_REMINDERS;
+    private static DEFAULT_PARALLEL_RUN_FAILURE_THRESHOLD;
+    static runBasedEscalation(failedRunThreshold: number, reminders?: Reminders, parallelRunFailureThreshold?: ParallelRunFailureThreshold): AlertEscalation;
+    static timeBasedEscalation(minutesFailingThreshold: number, reminders?: Reminders, parallelRunFailureThreshold?: ParallelRunFailureThreshold): AlertEscalation;
+    private static alertEscalation;
+}
+export {};

package/dist/constructs/alert-escalation-policy.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertEscalationBuilder = void 0;
+// eslint-disable-next-line no-restricted-syntax
+var AlertEscalationType;
+(function (AlertEscalationType) {
+    AlertEscalationType["RUN"] = "RUN_BASED";
+    AlertEscalationType["TIME"] = "TIME_BASED";
+})(AlertEscalationType || (AlertEscalationType = {}));
+class AlertEscalationBuilder {
+    static runBasedEscalation(failedRunThreshold, reminders, parallelRunFailureThreshold) {
+        const options = {
+            runBasedEscalation: {
+                failedRunThreshold,
+            },
+            reminders,
+            parallelRunFailureThreshold,
+        };
+        return this.alertEscalation(AlertEscalationType.RUN, options);
+    }
+    static timeBasedEscalation(minutesFailingThreshold, reminders, parallelRunFailureThreshold) {
+        const options = {
+            timeBasedEscalation: {
+                minutesFailingThreshold,
+            },
+            reminders,
+            parallelRunFailureThreshold,
+        };
+        return this.alertEscalation(AlertEscalationType.TIME, options);
+    }
+    static alertEscalation(escalationType, options) {
+        var _a, _b, _c, _d;
+        return {
+            escalationType,
+            runBasedEscalation: (_a = options.runBasedEscalation) !== null && _a !== void 0 ? _a : this.DEFAULT_RUN_BASED_ESCALATION,
+            timeBasedEscalation: (_b = options.timeBasedEscalation) !== null && _b !== void 0 ? _b : this.DEFAULT_TIME_BASED_ESCALATION,
+            reminders: (_c = options.reminders) !== null && _c !== void 0 ? _c : this.DEFAULT_REMINDERS,
+            parallelRunFailureThreshold: (_d = options.parallelRunFailureThreshold) !== null && _d !== void 0 ? _d : this.DEFAULT_PARALLEL_RUN_FAILURE_THRESHOLD,
+        };
+    }
+}
+exports.AlertEscalationBuilder = AlertEscalationBuilder;
+AlertEscalationBuilder.DEFAULT_RUN_BASED_ESCALATION = { failedRunThreshold: 1 };
+AlertEscalationBuilder.DEFAULT_TIME_BASED_ESCALATION = { minutesFailingThreshold: 5 };
+AlertEscalationBuilder.DEFAULT_REMINDERS = { amount: 0, interval: 5 };
+AlertEscalationBuilder.DEFAULT_PARALLEL_RUN_FAILURE_THRESHOLD = { enabled: false, percentage: 10 };
+//# sourceMappingURL=alert-escalation-policy.js.map

package/dist/constructs/alert-escalation-policy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alert-escalation-policy.js","sourceRoot":"","sources":["../../src/constructs/alert-escalation-policy.ts"],"names":[],"mappings":";;;AAAA,gDAAgD;AAChD,IAAK,mBAGJ;AAHD,WAAK,mBAAmB;IACtB,wCAAiB,CAAA;IACjB,0CAAmB,CAAA;AACrB,CAAC,EAHI,mBAAmB,KAAnB,mBAAmB,QAGvB;AA0BD,MAAa,sBAAsB;IAMjC,MAAM,CAAC,kBAAkB,CACvB,kBAA0B,EAC1B,SAAqB,EACrB,2BAAyD;QAEzD,MAAM,OAAO,GAA2B;YACtC,kBAAkB,EAAE;gBAClB,kBAAkB;aACnB;YACD,SAAS;YACT,2BAA2B;SAC5B,CAAA;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAC/D,CAAC;IAED,MAAM,CAAC,mBAAmB,CACxB,uBAA+B,EAC/B,SAAqB,EACrB,2BAAyD;QAEzD,MAAM,OAAO,GAA2B;YACtC,mBAAmB,EAAE;gBACnB,uBAAuB;aACxB;YACD,SAAS;YACT,2BAA2B;SAC5B,CAAA;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAChE,CAAC;IAEO,MAAM,CAAC,eAAe,CAAE,cAAmC,EACjE,OAA+B;;QAC/B,OAAO;YACL,cAAc;YACd,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,IAAI,CAAC,4BAA4B;YACnF,mBAAmB,EAAE,MAAA,OAAO,CAAC,mBAAmB,mCAAI,IAAI,CAAC,6BAA6B;YACtF,SAAS,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,IAAI,CAAC,iBAAiB;YACtD,2BAA2B,EAAE,MAAA,OAAO,CAAC,2BAA2B,mCAAI,IAAI,CAAC,sCAAsC;SAChH,CAAA;IACH,CAAC;;AA7CH,wDA8CC;AA7CgB,mDAA4B,GAAG,EAAE,kBAAkB,EAAE,CAAC,EAAE,CAAA;AACxD,oDAA6B,GAAG,EAAE,uBAAuB,EAAE,CAAC,EAAE,CAAA;AAC9D,wCAAiB,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAA;AAC9C,6DAAsC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA"}

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

@@ -0,0 +1,187 @@
+import { Check, CheckProps } from './check';
+import { HttpHeader } from './http-header';
+import { QueryParam } from './query-param';
+import { Content, Entrypoint } from './construct';
+declare enum AssertionSource {
+    STATUS_CODE = "STATUS_CODE",
+    JSON_BODY = "JSON_BODY",
+    HEADERS = "HEADERS",
+    TEXT_BODY = "TEXT_BODY",
+    RESPONSE_TIME = "RESPONSE_TIME"
+}
+export interface Assertion {
+    source: string;
+    property: string;
+    comparison: string;
+    target: string;
+    regex: string | null;
+}
+export declare class AssertionBuilder {
+    static statusCode(): NumericAssertionBuilder;
+    static jsonBody(property?: string): GeneralAssertionBuilder;
+    static headers(property?: string, regex?: string): GeneralAssertionBuilder;
+    static textBody(property?: string): GeneralAssertionBuilder;
+    /** @deprecated Use responseTime() instead */
+    static responseTme(): NumericAssertionBuilder;
+    static responseTime(): NumericAssertionBuilder;
+}
+declare class NumericAssertionBuilder {
+    source: AssertionSource;
+    constructor(source: AssertionSource);
+    equals(target: number): Assertion;
+    notEquals(target: number): Assertion;
+    lessThan(target: number): Assertion;
+    greaterThan(target: number): Assertion;
+    /** @private */
+    private _toAssertion;
+}
+declare class GeneralAssertionBuilder {
+    source: AssertionSource;
+    property?: string;
+    regex?: string;
+    constructor(source: AssertionSource, property?: string, regex?: string);
+    equals(target: string | number | boolean): Assertion;
+    notEquals(target: string | number | boolean): Assertion;
+    hasKey(target: string): Assertion;
+    notHasKey(target: string): Assertion;
+    hasValue(target: string | number | boolean): Assertion;
+    notHasValue(target: string | number | boolean): Assertion;
+    isEmpty(): Assertion;
+    notEmpty(): Assertion;
+    lessThan(target: string | number | boolean): Assertion;
+    greaterThan(target: string | number | boolean): Assertion;
+    contains(target: string): Assertion;
+    notContains(target: string): Assertion;
+    isNull(): Assertion;
+    isNotNull(): Assertion;
+    /** @private */
+    private _toAssertion;
+}
+export type BodyType = 'JSON' | 'FORM' | 'RAW' | 'GRAPHQL' | 'NONE';
+export type HttpRequestMethod = 'get' | 'GET' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'head' | 'HEAD' | 'delete' | 'DELETE' | 'options' | 'OPTIONS';
+export type IPFamily = 'IPv4' | 'IPv6';
+export interface BasicAuth {
+    username: string;
+    password: string;
+}
+export type ApiCheckDefaultConfig = {
+    url?: string;
+    headers?: Array<HttpHeader>;
+    queryParameters?: Array<QueryParam>;
+    basicAuth?: BasicAuth;
+};
+export interface Request {
+    url: string;
+    method: HttpRequestMethod;
+    ipFamily?: IPFamily;
+    followRedirects?: boolean;
+    skipSSL?: boolean;
+    /**
+     * 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>;
+    body?: string;
+    bodyType?: BodyType;
+    headers?: Array<HttpHeader>;
+    queryParameters?: Array<QueryParam>;
+    basicAuth?: BasicAuth;
+}
+export interface ScriptDependency {
+    path: string;
+    content: string;
+}
+export interface ApiCheckProps extends CheckProps {
+    /**
+     *  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.
+     */
+    degradedResponseTime?: number;
+    /**
+     * The response time in milliseconds where a check should be considered failing.
+     */
+    maxResponseTime?: number;
+}
+/**
+ * Creates an API Check
+ *
+ * @remarks
+ *
+ * This class make use of the API Checks endpoints.
+ */
+export declare class ApiCheck extends Check {
+    request: Request;
+    localSetupScript?: string;
+    localTearDownScript?: string;
+    degradedResponseTime?: number;
+    maxResponseTime?: number;
+    private readonly setupScriptDependencies?;
+    private readonly tearDownScriptDependencies?;
+    private readonly setupScriptPath?;
+    private readonly tearDownScriptPath?;
+    /**
+     * Constructs the API Check instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props check configuration properties
+     *
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#apicheck Read more in the docs}
+     */
+    constructor(logicalId: string, props: ApiCheckProps);
+    static bundle(entrypoint: string, runtimeId: string): {
+        script: string;
+        scriptPath: string;
+        dependencies: ScriptDependency[];
+    };
+    synthesize(): {
+        checkType: string;
+        request: Request;
+        localSetupScript: string | undefined;
+        setupScriptPath: string | undefined;
+        setupScriptDependencies: ScriptDependency[] | undefined;
+        localTearDownScript: string | undefined;
+        tearDownScriptPath: string | undefined;
+        tearDownScriptDependencies: ScriptDependency[] | undefined;
+        degradedResponseTime: number | undefined;
+        maxResponseTime: number | undefined;
+        name: string;
+        activated: boolean | undefined;
+        muted: boolean | undefined;
+        shouldFail: boolean | undefined;
+        runtimeId: string | undefined;
+        locations: (keyof import("..").Region)[] | undefined;
+        privateLocations: undefined;
+        tags: string[] | undefined;
+        frequency: number | undefined;
+        frequencyOffset: number | undefined;
+        groupId: import("./ref").Ref | undefined;
+        environmentVariables: import("./key-value-pair").default[] | undefined;
+        retryStrategy: import("./retry-strategy").RetryStrategy | null | undefined;
+        doubleCheck: boolean | undefined;
+        alertSettings: import("./alert-escalation-policy").AlertEscalation | undefined;
+        useGlobalAlertSettings: boolean | undefined;
+        runParallel: boolean | undefined;
+    };
+}
+export {};

package/dist/constructs/api-check.js

@@ -0,0 +1,279 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiCheck = exports.AssertionBuilder = void 0;
+const path = __importStar(require("path"));
+const check_1 = require("./check");
+const project_1 = require("./project");
+const parser_1 = require("../services/check-parser/parser");
+const util_1 = require("../services/util");
+const util_2 = require("../reporters/util");
+// eslint-disable-next-line no-restricted-syntax
+var AssertionSource;
+(function (AssertionSource) {
+    AssertionSource["STATUS_CODE"] = "STATUS_CODE";
+    AssertionSource["JSON_BODY"] = "JSON_BODY";
+    AssertionSource["HEADERS"] = "HEADERS";
+    AssertionSource["TEXT_BODY"] = "TEXT_BODY";
+    AssertionSource["RESPONSE_TIME"] = "RESPONSE_TIME";
+})(AssertionSource || (AssertionSource = {}));
+// eslint-disable-next-line no-restricted-syntax
+var AssertionComparison;
+(function (AssertionComparison) {
+    AssertionComparison["EQUALS"] = "EQUALS";
+    AssertionComparison["NOT_EQUALS"] = "NOT_EQUALS";
+    AssertionComparison["HAS_KEY"] = "HAS_KEY";
+    AssertionComparison["NOT_HAS_KEY"] = "NOT_HAS_KEY";
+    AssertionComparison["HAS_VALUE"] = "HAS_VALUE";
+    AssertionComparison["NOT_HAS_VALUE"] = "NOT_HAS_VALUE";
+    AssertionComparison["IS_EMPTY"] = "IS_EMPTY";
+    AssertionComparison["NOT_EMPTY"] = "NOT_EMPTY";
+    AssertionComparison["GREATER_THAN"] = "GREATER_THAN";
+    AssertionComparison["LESS_THAN"] = "LESS_THAN";
+    AssertionComparison["CONTAINS"] = "CONTAINS";
+    AssertionComparison["NOT_CONTAINS"] = "NOT_CONTAINS";
+    AssertionComparison["IS_NULL"] = "IS_NULL";
+    AssertionComparison["NOT_NULL"] = "NOT_NULL";
+})(AssertionComparison || (AssertionComparison = {}));
+class AssertionBuilder {
+    static statusCode() {
+        return new NumericAssertionBuilder(AssertionSource.STATUS_CODE);
+    }
+    static jsonBody(property) {
+        return new GeneralAssertionBuilder(AssertionSource.JSON_BODY, property);
+    }
+    static headers(property, regex) {
+        return new GeneralAssertionBuilder(AssertionSource.HEADERS, property, regex);
+    }
+    static textBody(property) {
+        return new GeneralAssertionBuilder(AssertionSource.TEXT_BODY, property);
+    }
+    /** @deprecated Use responseTime() instead */
+    static responseTme() {
+        return new NumericAssertionBuilder(AssertionSource.RESPONSE_TIME);
+    }
+    static responseTime() {
+        return new NumericAssertionBuilder(AssertionSource.RESPONSE_TIME);
+    }
+}
+exports.AssertionBuilder = AssertionBuilder;
+class NumericAssertionBuilder {
+    constructor(source) {
+        this.source = source;
+    }
+    equals(target) {
+        return this._toAssertion(AssertionComparison.EQUALS, target);
+    }
+    notEquals(target) {
+        return this._toAssertion(AssertionComparison.NOT_EQUALS, target);
+    }
+    lessThan(target) {
+        return this._toAssertion(AssertionComparison.LESS_THAN, target);
+    }
+    greaterThan(target) {
+        return this._toAssertion(AssertionComparison.GREATER_THAN, target);
+    }
+    /** @private */
+    _toAssertion(comparison, target) {
+        return { source: this.source, comparison, property: '', target: target.toString(), regex: null };
+    }
+}
+class GeneralAssertionBuilder {
+    constructor(source, property, regex) {
+        this.source = source;
+        this.property = property;
+        this.regex = regex;
+    }
+    equals(target) {
+        return this._toAssertion(AssertionComparison.EQUALS, target);
+    }
+    notEquals(target) {
+        return this._toAssertion(AssertionComparison.NOT_EQUALS, target);
+    }
+    hasKey(target) {
+        return this._toAssertion(AssertionComparison.HAS_KEY, target);
+    }
+    notHasKey(target) {
+        return this._toAssertion(AssertionComparison.NOT_HAS_KEY, target);
+    }
+    hasValue(target) {
+        return this._toAssertion(AssertionComparison.HAS_VALUE, target);
+    }
+    notHasValue(target) {
+        return this._toAssertion(AssertionComparison.NOT_HAS_VALUE, target);
+    }
+    isEmpty() {
+        return this._toAssertion(AssertionComparison.IS_EMPTY);
+    }
+    notEmpty() {
+        return this._toAssertion(AssertionComparison.NOT_EMPTY);
+    }
+    lessThan(target) {
+        return this._toAssertion(AssertionComparison.LESS_THAN, target);
+    }
+    greaterThan(target) {
+        return this._toAssertion(AssertionComparison.GREATER_THAN, target);
+    }
+    contains(target) {
+        return this._toAssertion(AssertionComparison.CONTAINS, target);
+    }
+    notContains(target) {
+        return this._toAssertion(AssertionComparison.NOT_CONTAINS, target);
+    }
+    isNull() {
+        return this._toAssertion(AssertionComparison.IS_NULL);
+    }
+    isNotNull() {
+        return this._toAssertion(AssertionComparison.NOT_NULL);
+    }
+    /** @private */
+    _toAssertion(comparison, target) {
+        var _a, _b, _c;
+        return {
+            source: this.source,
+            comparison,
+            property: (_a = this.property) !== null && _a !== void 0 ? _a : '',
+            target: (_b = target === null || target === void 0 ? void 0 : target.toString()) !== null && _b !== void 0 ? _b : '',
+            regex: (_c = this.regex) !== null && _c !== void 0 ? _c : null,
+        };
+    }
+}
+function _printWarning(path) {
+    (0, util_2.printDeprecationWarning)(`API check "${path}" is probably providing a setup ` +
+        'or tearDown script using the "localSetupScript" or "localTearDownScript" property. Please update your API checks to ' +
+        'reference any setup / tearDown using the "setupScript" and "tearDownScript" properties See the docs at ' +
+        'https://checklyhq.com/docs/cli/constructs-reference#apicheck');
+}
+/**
+ * Creates an API Check
+ *
+ * @remarks
+ *
+ * This class make use of the API Checks endpoints.
+ */
+class ApiCheck extends check_1.Check {
+    /**
+     * Constructs the API Check instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props check configuration properties
+     *
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#apicheck Read more in the docs}
+     */
+    constructor(logicalId, props) {
+        super(logicalId, props);
+        if (props.setupScript) {
+            if ('entrypoint' in props.setupScript) {
+                const { script, scriptPath, dependencies } = ApiCheck.bundle(props.setupScript.entrypoint, this.runtimeId);
+                this.localSetupScript = script;
+                this.setupScriptPath = scriptPath;
+                this.setupScriptDependencies = dependencies;
+            }
+            else if ('content' in props.setupScript) {
+                this.localSetupScript = props.setupScript.content;
+            }
+            else {
+                throw new Error('Unrecognized type for the "setupScript" property. A "setupScript" should have either a "content" ' +
+                    'or "entrypoint" property.');
+            }
+        }
+        if (props.localSetupScript) {
+            _printWarning(project_1.Session.checkFilePath);
+            this.localSetupScript = props.localSetupScript;
+        }
+        if (props.tearDownScript) {
+            if ('entrypoint' in props.tearDownScript) {
+                const { script, scriptPath, dependencies } = ApiCheck.bundle(props.tearDownScript.entrypoint, this.runtimeId);
+                this.localTearDownScript = script;
+                this.tearDownScriptPath = scriptPath;
+                this.tearDownScriptDependencies = dependencies;
+            }
+            else if ('content' in props.tearDownScript) {
+                this.localTearDownScript = props.tearDownScript.content;
+            }
+        }
+        if (props.localTearDownScript) {
+            _printWarning(project_1.Session.checkFilePath);
+            this.localTearDownScript = props.localTearDownScript;
+        }
+        this.request = props.request;
+        this.degradedResponseTime = props.degradedResponseTime;
+        this.maxResponseTime = props.maxResponseTime;
+        project_1.Session.registerConstruct(this);
+        this.addSubscriptions();
+        this.addPrivateLocationCheckAssignments();
+    }
+    static bundle(entrypoint, runtimeId) {
+        let absoluteEntrypoint = null;
+        if (path.isAbsolute(entrypoint)) {
+            absoluteEntrypoint = entrypoint;
+        }
+        else {
+            if (!project_1.Session.checkFileAbsolutePath) {
+                throw new Error('You cant use relative paths without the checkFileAbsolutePath in session');
+            }
+            absoluteEntrypoint = path.join(path.dirname(project_1.Session.checkFileAbsolutePath), entrypoint);
+        }
+        const runtime = project_1.Session.availableRuntimes[runtimeId];
+        if (!runtime) {
+            throw new Error(`${runtimeId} is not supported`);
+        }
+        const parser = new parser_1.Parser({
+            supportedNpmModules: Object.keys(runtime.dependencies),
+            checkUnsupportedModules: project_1.Session.verifyRuntimeDependencies,
+        });
+        const parsed = parser.parse(absoluteEntrypoint);
+        // Maybe we can get the parsed deps with the content immediately
+        const deps = [];
+        for (const { filePath, content } of parsed.dependencies) {
+            deps.push({
+                path: (0, util_1.pathToPosix)(path.relative(project_1.Session.basePath, filePath)),
+                content,
+            });
+        }
+        return {
+            script: parsed.entrypoint.content,
+            scriptPath: (0, util_1.pathToPosix)(path.relative(project_1.Session.basePath, parsed.entrypoint.filePath)),
+            dependencies: deps,
+        };
+    }
+    synthesize() {
+        return {
+            ...super.synthesize(),
+            checkType: 'API',
+            request: this.request,
+            localSetupScript: this.localSetupScript,
+            setupScriptPath: this.setupScriptPath,
+            setupScriptDependencies: this.setupScriptDependencies,
+            localTearDownScript: this.localTearDownScript,
+            tearDownScriptPath: this.tearDownScriptPath,
+            tearDownScriptDependencies: this.tearDownScriptDependencies,
+            degradedResponseTime: this.degradedResponseTime,
+            maxResponseTime: this.maxResponseTime,
+        };
+    }
+}
+exports.ApiCheck = ApiCheck;
+//# 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,2CAA4B;AAC5B,mCAA2C;AAE3C,uCAAmC;AAEnC,4DAAwD;AACxD,2CAA8C;AAC9C,4CAA2D;AAG3D,gDAAgD;AAChD,IAAK,eAMJ;AAND,WAAK,eAAe;IAClB,8CAA2B,CAAA;IAC3B,0CAAuB,CAAA;IACvB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,kDAA+B,CAAA;AACjC,CAAC,EANI,eAAe,KAAf,eAAe,QAMnB;AAED,gDAAgD;AAChD,IAAK,mBAeJ;AAfD,WAAK,mBAAmB;IACtB,wCAAiB,CAAA;IACjB,gDAAyB,CAAA;IACzB,0CAAmB,CAAA;IACnB,kDAA2B,CAAA;IAC3B,8CAAuB,CAAA;IACvB,sDAA+B,CAAA;IAC/B,4CAAqB,CAAA;IACrB,8CAAuB,CAAA;IACvB,oDAA6B,CAAA;IAC7B,8CAAuB,CAAA;IACvB,4CAAqB,CAAA;IACrB,oDAA6B,CAAA;IAC7B,0CAAmB,CAAA;IACnB,4CAAqB,CAAA;AACvB,CAAC,EAfI,mBAAmB,KAAnB,mBAAmB,QAevB;AAUD,MAAa,gBAAgB;IAC3B,MAAM,CAAC,UAAU;QACf,OAAO,IAAI,uBAAuB,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;IACjE,CAAC;IAED,MAAM,CAAC,QAAQ,CAAE,QAAiB;QAChC,OAAO,IAAI,uBAAuB,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;IACzE,CAAC;IAED,MAAM,CAAC,OAAO,CAAE,QAAiB,EAAE,KAAc;QAC/C,OAAO,IAAI,uBAAuB,CAAC,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;IAC9E,CAAC;IAED,MAAM,CAAC,QAAQ,CAAE,QAAiB;QAChC,OAAO,IAAI,uBAAuB,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAA;IACzE,CAAC;IAED,6CAA6C;IAC7C,MAAM,CAAC,WAAW;QAChB,OAAO,IAAI,uBAAuB,CAAC,eAAe,CAAC,aAAa,CAAC,CAAA;IACnE,CAAC;IAED,MAAM,CAAC,YAAY;QACjB,OAAO,IAAI,uBAAuB,CAAC,eAAe,CAAC,aAAa,CAAC,CAAA;IACnE,CAAC;CACF;AAzBD,4CAyBC;AAED,MAAM,uBAAuB;IAE3B,YAAa,MAAuB;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,MAAM,CAAE,MAAc;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9D,CAAC;IAED,SAAS,CAAE,MAAc;QACvB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IAClE,CAAC;IAED,QAAQ,CAAE,MAAc;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IACjE,CAAC;IAED,WAAW,CAAE,MAAc;QACzB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;IACpE,CAAC;IAED,eAAe;IACP,YAAY,CAAE,UAA+B,EAAE,MAAc;QACnE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;IAClG,CAAC;CACF;AAED,MAAM,uBAAuB;IAI3B,YAAa,MAAuB,EAAE,QAAiB,EAAE,KAAc;QACrE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED,MAAM,CAAE,MAA6B;QACnC,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9D,CAAC;IAED,SAAS,CAAE,MAA6B;QACtC,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IAClE,CAAC;IAED,MAAM,CAAE,MAAc;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAC/D,CAAC;IAED,SAAS,CAAE,MAAc;QACvB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;IACnE,CAAC;IAED,QAAQ,CAAE,MAA6B;QACrC,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IACjE,CAAC;IAED,WAAW,CAAE,MAA6B;QACxC,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;IACrE,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAA;IACxD,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACzD,CAAC;IAED,QAAQ,CAAE,MAA6B;QACrC,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IACjE,CAAC;IAED,WAAW,CAAE,MAA6B;QACxC,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;IACpE,CAAC;IAED,QAAQ,CAAE,MAAc;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAChE,CAAC;IAED,WAAW,CAAE,MAAc;QACzB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;IACpE,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAA;IACvD,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAA;IACxD,CAAC;IAED,eAAe;IACP,YAAY,CAAE,UAA+B,EAAE,MAA8B;;QACnF,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU;YACV,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,EAAE;YAC7B,MAAM,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,EAAE,mCAAI,EAAE;YAChC,KAAK,EAAE,MAAA,IAAI,CAAC,KAAK,mCAAI,IAAI;SAC1B,CAAA;IACH,CAAC;CACF;AAED,SAAS,aAAa,CAAE,IAAwB;IAC9C,IAAA,8BAAuB,EAAC,cAAc,IAAI,kCAAkC;QAC5E,sHAAsH;QACtH,yGAAyG;QACzG,8DAA8D,CAAC,CAAA;AACjE,CAAC;AAkFD;;;;;;GAMG;AACH,MAAa,QAAS,SAAQ,aAAK;IAWjC;;;;;;;OAOG;IAEH,YAAa,SAAiB,EAAE,KAAoB;QAClD,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QAEvB,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,YAAY,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;gBACtC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,SAAU,CAAC,CAAA;gBAC3G,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAA;gBAC9B,IAAI,CAAC,eAAe,GAAG,UAAU,CAAA;gBACjC,IAAI,CAAC,uBAAuB,GAAG,YAAY,CAAA;YAC7C,CAAC;iBAAM,IAAI,SAAS,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;gBAC1C,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAA;YACnD,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,mGAAmG;oBAC/G,2BAA2B,CAAC,CAAA;YAClC,CAAC;QACH,CAAC;QAED,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;YAC3B,aAAa,CAAC,iBAAO,CAAC,aAAa,CAAC,CAAA;YACpC,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAA;QAChD,CAAC;QAED,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;YACzB,IAAI,YAAY,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBACzC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,SAAU,CAAC,CAAA;gBAC9G,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAA;gBACjC,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAA;gBACpC,IAAI,CAAC,0BAA0B,GAAG,YAAY,CAAA;YAChD,CAAC;iBAAM,IAAI,SAAS,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBAC7C,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,cAAc,CAAC,OAAO,CAAA;YACzD,CAAC;QACH,CAAC;QAED,IAAI,KAAK,CAAC,mBAAmB,EAAE,CAAC;YAC9B,aAAa,CAAC,iBAAO,CAAC,aAAa,CAAC,CAAA;YACpC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAA;QACtD,CAAC;QAED,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,iBAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC/B,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,IAAI,CAAC,kCAAkC,EAAE,CAAA;IAC3C,CAAC;IAED,MAAM,CAAC,MAAM,CAAE,UAAkB,EAAE,SAAiB;QAClD,IAAI,kBAAkB,GAAG,IAAI,CAAA;QAC7B,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,kBAAkB,GAAG,UAAU,CAAA;QACjC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,iBAAO,CAAC,qBAAqB,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAA;YAC7F,CAAC;YACD,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAO,CAAC,qBAAqB,CAAC,EAAE,UAAU,CAAC,CAAA;QACzF,CAAC;QAED,MAAM,OAAO,GAAG,iBAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;QACpD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAA;QAClD,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC;YACxB,mBAAmB,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YACtD,uBAAuB,EAAE,iBAAO,CAAC,yBAAyB;SAC3D,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAA;QAC/C,gEAAgE;QAEhE,MAAM,IAAI,GAAuB,EAAE,CAAA;QACnC,KAAK,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxD,IAAI,CAAC,IAAI,CAAC;gBACR,IAAI,EAAE,IAAA,kBAAW,EAAC,IAAI,CAAC,QAAQ,CAAC,iBAAO,CAAC,QAAS,EAAE,QAAQ,CAAC,CAAC;gBAC7D,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;QACD,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO;YACjC,UAAU,EAAE,IAAA,kBAAW,EAAC,IAAI,CAAC,QAAQ,CAAC,iBAAO,CAAC,QAAS,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACrF,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,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;YACrD,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,eAAe,EAAE,IAAI,CAAC,eAAe;SACtC,CAAA;IACH,CAAC;CACF;AAtHD,4BAsHC"}

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

@@ -0,0 +1,90 @@
+import { Check, CheckProps } from './check';
+import { Content, Entrypoint } from './construct';
+import { Snapshot } from '../services/snapshot-service';
+import { PlaywrightConfig } from './playwright-config';
+export interface CheckDependency {
+    path: string;
+    content: string;
+}
+export interface BrowserCheckProps extends CheckProps {
+    /**
+     * A valid piece of Node.js javascript code describing a browser interaction
+     * with the Puppeteer or Playwright frameworks.
+     */
+    code: Content | Entrypoint;
+    /**
+     * A valid fully qualified domain name (FQDN) to check for SSL certificate
+     * expiration. For example, 'app.checklyhq.com'.
+     */
+    sslCheckDomain?: string;
+    /**
+     * A valid playwright config object, same format and keys as you would use on
+     * playwright.config.ts
+     */
+    playwrightConfig?: PlaywrightConfig;
+}
+/**
+ * Creates a Browser Check
+ *
+ * @remarks
+ *
+ * This class make use of the Browser Checks endpoints.
+ */
+export declare class BrowserCheck extends Check {
+    script: string;
+    scriptPath?: string;
+    dependencies?: Array<CheckDependency>;
+    sslCheckDomain?: string;
+    rawSnapshots?: Array<{
+        absolutePath: string;
+        path: string;
+    }>;
+    snapshots?: Array<Snapshot>;
+    playwrightConfig?: PlaywrightConfig;
+    /**
+     * Constructs the Browser Check instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props check configuration properties
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#browsercheck Read more in the docs}
+     */
+    constructor(logicalId: string, props: BrowserCheckProps);
+    private static applyDefaultBrowserCheckGroupConfig;
+    private static applyDefaultBrowserCheckConfig;
+    static bundle(entry: string, runtimeId: string): {
+        script: string;
+        scriptPath: string;
+        dependencies: CheckDependency[];
+        snapshots: {
+            absolutePath: string;
+            path: string;
+        }[];
+    };
+    getSourceFile(): string | undefined;
+    synthesize(): {
+        checkType: string;
+        script: string;
+        scriptPath: string | undefined;
+        dependencies: CheckDependency[] | undefined;
+        sslCheckDomain: string | null;
+        snapshots: Snapshot[] | undefined;
+        playwrightConfig: PlaywrightConfig | undefined;
+        name: string;
+        activated: boolean | undefined;
+        muted: boolean | undefined;
+        shouldFail: boolean | undefined;
+        runtimeId: string | undefined;
+        locations: (keyof import("..").Region)[] | undefined;
+        privateLocations: undefined;
+        tags: string[] | undefined;
+        frequency: number | undefined;
+        frequencyOffset: number | undefined;
+        groupId: import("./ref").Ref | undefined;
+        environmentVariables: import("./key-value-pair").default[] | undefined;
+        retryStrategy: import("./retry-strategy").RetryStrategy | null | undefined;
+        doubleCheck: boolean | undefined;
+        alertSettings: import("./alert-escalation-policy").AlertEscalation | undefined;
+        useGlobalAlertSettings: boolean | undefined;
+        runParallel: boolean | undefined;
+    };
+}