checkly 0.0.0-pr.1006.b6b3be2

package/dist/constructs/check.d.ts

@@ -0,0 +1,144 @@
+import { Ref } from './ref';
+import { Frequency } from './frequency';
+import { Construct } from './construct';
+import { AlertChannel } from './alert-channel';
+import { EnvironmentVariable } from './environment-variable';
+import type { Region } from '..';
+import type { CheckGroup } from './check-group';
+import { PrivateLocation } from './private-location';
+import { RetryStrategy } from './retry-strategy';
+import { AlertEscalation } from './alert-escalation-policy';
+export interface CheckProps {
+    /**
+     *  The name of the check.
+     */
+    name: string;
+    /**
+     *  Determines whether the check will run periodically or not after being deployed.
+     */
+    activated?: boolean;
+    /**
+     * Determines if any notifications will be sent out when a check fails and/or recovers.
+     */
+    muted?: boolean;
+    /**
+     * Setting this to "true" will trigger a retry when a check fails from the failing region and another,
+     * randomly selected region before marking the check as failed.
+     * @deprecated Use {@link CheckProps.retryStrategy} instead.
+     */
+    doubleCheck?: boolean;
+    /**
+     * Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
+     * This only applies to API Checks.
+     */
+    shouldFail?: boolean;
+    /**
+     * The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.
+     */
+    runtimeId?: string;
+    /**
+     * An array of one or more data center locations where to run this check. The supported regions are:
+     * us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, sa-east-1,
+     * eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, me-south-1,
+     * ap-southeast-1, ap-northeast-1, ap-east-1, ap-southeast-2, ap-southeast-3, ap-northeast-2, ap-northeast-3,
+     * ap-south-1, af-south-1
+     */
+    locations?: Array<keyof Region>;
+    /**
+     * An array of one or more private locations where to run the check.
+     * PrivateLocation instances or slug name strings are allowed.
+     *
+     * `string` slug names are **only** allowed for private locations that **not** belong to the project. Use
+     * PrivateLocation instances references for private locations created within the project.
+     */
+    privateLocations?: Array<string | PrivateLocation>;
+    /**
+     * Tags for organizing and filtering checks.
+     */
+    tags?: Array<string>;
+    /**
+     * How often the check should run in minutes.
+     */
+    frequency?: number | Frequency;
+    environmentVariables?: Array<EnvironmentVariable>;
+    /**
+     * The id of the check group this check is part of. Set this by calling `someGroup.ref()`
+     * @deprecated Use {@link CheckProps.group} instead.
+     */
+    groupId?: Ref;
+    /**
+     * The CheckGroup that this check is part of.
+     */
+    group?: CheckGroup;
+    /**
+     * List of alert channels to notify when the check fails or recovers.
+     * If you don't set at least one, we won't be able to alert you in case something goes wrong with your check.
+     * @link {https://www.checklyhq.com/docs/alerting-and-retries/alert-channels/#alert-channels Alert channels}
+     */
+    alertChannels?: Array<AlertChannel>;
+    /**
+     * Determines the alert escalation policy for that particular check
+     */
+    alertEscalationPolicy?: AlertEscalation;
+    /**
+     * Determines if the check is available only when 'test' runs (not included when 'deploy' is executed).
+     */
+    testOnly?: boolean;
+    /**
+     * Sets a retry policy for the check. Use RetryStrategyBuilder to create a retry policy.
+     */
+    retryStrategy?: RetryStrategy;
+    /**
+     * Determines whether the check should run on all selected locations in parallel or round-robin.
+     * See https://www.checklyhq.com/docs/monitoring/global-locations/ to learn more about scheduling strategies.
+     */
+    runParallel?: boolean;
+}
+export declare abstract class Check extends Construct {
+    name: string;
+    activated?: boolean;
+    muted?: boolean;
+    doubleCheck?: boolean;
+    shouldFail?: boolean;
+    runtimeId?: string;
+    locations?: Array<keyof Region>;
+    privateLocations?: Array<string | PrivateLocation>;
+    tags?: Array<string>;
+    frequency?: number;
+    frequencyOffset?: number;
+    environmentVariables?: Array<EnvironmentVariable>;
+    groupId?: Ref;
+    alertChannels?: Array<AlertChannel>;
+    testOnly?: boolean;
+    retryStrategy?: RetryStrategy;
+    alertSettings?: AlertEscalation;
+    useGlobalAlertSettings?: boolean;
+    runParallel?: boolean;
+    __checkFilePath?: string;
+    static readonly __checklyType = "check";
+    constructor(logicalId: string, props: CheckProps);
+    private static applyDefaultCheckGroupConfig;
+    private static applyDefaultCheckConfig;
+    addSubscriptions(): void;
+    addPrivateLocationCheckAssignments(): void;
+    getSourceFile(): string | undefined;
+    synthesize(): {
+        name: string;
+        activated: boolean | undefined;
+        muted: boolean | undefined;
+        shouldFail: boolean | undefined;
+        runtimeId: string | undefined;
+        locations: (keyof Region)[] | undefined;
+        privateLocations: undefined;
+        tags: string[] | undefined;
+        frequency: number | undefined;
+        frequencyOffset: number | undefined;
+        groupId: Ref | undefined;
+        environmentVariables: import("./key-value-pair").default[] | undefined;
+        retryStrategy: RetryStrategy | null | undefined;
+        doubleCheck: boolean | undefined;
+        alertSettings: AlertEscalation | undefined;
+        useGlobalAlertSettings: boolean | undefined;
+        runParallel: boolean | undefined;
+    };
+}

package/dist/constructs/check.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Check = void 0;
+const ref_1 = require("./ref");
+const frequency_1 = require("./frequency");
+const construct_1 = require("./construct");
+const alert_channel_subscription_1 = require("./alert-channel-subscription");
+const project_1 = require("./project");
+const private_location_check_assignment_1 = require("./private-location-check-assignment");
+// This is an abstract class. It shouldn't be used directly.
+class Check extends construct_1.Construct {
+    constructor(logicalId, props) {
+        var _a, _b, _c, _d, _e, _f;
+        super(Check.__checklyType, logicalId);
+        if (props.group) {
+            Check.applyDefaultCheckGroupConfig(props, props.group.getCheckDefaults());
+        }
+        Check.applyDefaultCheckConfig(props);
+        // TODO: Throw an error if required properties are still missing after applying the defaults.
+        this.name = props.name;
+        this.activated = props.activated;
+        this.muted = props.muted;
+        this.doubleCheck = props.doubleCheck;
+        this.shouldFail = props.shouldFail;
+        this.locations = props.locations;
+        this.privateLocations = props.privateLocations;
+        this.tags = props.tags;
+        if (props.frequency instanceof frequency_1.Frequency) {
+            this.frequency = props.frequency.frequency;
+            this.frequencyOffset = props.frequency.frequencyOffset;
+        }
+        else {
+            this.frequency = props.frequency;
+        }
+        this.runtimeId = props.runtimeId;
+        this.environmentVariables = (_a = props.environmentVariables) !== null && _a !== void 0 ? _a : [];
+        // Alert channel subscriptions will be synthesized separately in the Project construct.
+        // This is due to the way things are organized on the BE.
+        this.alertChannels = (_b = props.alertChannels) !== null && _b !== void 0 ? _b : [];
+        // Prefer the `group` parameter, but support groupId for backwards compatibility.
+        this.groupId = (_d = (_c = props.group) === null || _c === void 0 ? void 0 : _c.ref()) !== null && _d !== void 0 ? _d : props.groupId;
+        // alertSettings, useGlobalAlertSettings, groupId, groupOrder
+        this.testOnly = (_e = props.testOnly) !== null && _e !== void 0 ? _e : false;
+        this.retryStrategy = props.retryStrategy;
+        this.alertSettings = props.alertEscalationPolicy;
+        this.useGlobalAlertSettings = !this.alertSettings;
+        this.runParallel = (_f = props.runParallel) !== null && _f !== void 0 ? _f : false;
+        this.__checkFilePath = project_1.Session.checkFilePath;
+    }
+    static applyDefaultCheckGroupConfig(props, groupProps) {
+        var _a;
+        let configKey;
+        for (configKey in groupProps) {
+            const newVal = (_a = props[configKey]) !== null && _a !== void 0 ? _a : groupProps[configKey];
+            props[configKey] = newVal;
+        }
+    }
+    static applyDefaultCheckConfig(props) {
+        var _a;
+        if (!project_1.Session.checkDefaults) {
+            return;
+        }
+        let configKey;
+        for (configKey in project_1.Session.checkDefaults) {
+            const newVal = (_a = props[configKey]) !== null && _a !== void 0 ? _a : project_1.Session.checkDefaults[configKey];
+            props[configKey] = newVal;
+        }
+    }
+    addSubscriptions() {
+        if (!this.alertChannels || this.testOnly) {
+            return;
+        }
+        for (const alertChannel of this.alertChannels) {
+            const subscription = new alert_channel_subscription_1.AlertChannelSubscription(`check-alert-channel-subscription#${this.logicalId}#${alertChannel.logicalId}`, {
+                alertChannelId: ref_1.Ref.from(alertChannel.logicalId),
+                checkId: ref_1.Ref.from(this.logicalId),
+                activated: true,
+            });
+        }
+    }
+    addPrivateLocationCheckAssignments() {
+        if (!this.privateLocations) {
+            return;
+        }
+        for (const privateLocation of this.privateLocations) {
+            // slugName strings are processed in loadAllPrivateLocations()
+            if (typeof privateLocation === 'string') {
+                continue;
+            }
+            // use private location assignment for instances
+            const assignment = new private_location_check_assignment_1.PrivateLocationCheckAssignment(`private-location-check-assignment#${this.logicalId}#${privateLocation.logicalId}`, {
+                privateLocationId: ref_1.Ref.from(privateLocation.logicalId),
+                checkId: ref_1.Ref.from(this.logicalId),
+            });
+        }
+    }
+    getSourceFile() {
+        return this.__checkFilePath;
+    }
+    synthesize() {
+        var _a, _b;
+        return {
+            name: this.name,
+            activated: this.activated,
+            muted: this.muted,
+            shouldFail: this.shouldFail,
+            runtimeId: this.runtimeId,
+            locations: this.locations,
+            // private-location instances are assigned with loadAllPrivateLocations()
+            privateLocations: undefined,
+            tags: this.tags,
+            frequency: this.frequency,
+            frequencyOffset: this.frequencyOffset,
+            groupId: this.groupId,
+            environmentVariables: this.environmentVariables,
+            // The backend doesn't actually support the `NO_RETRIES` type, it uses `null` instead.
+            retryStrategy: ((_a = this.retryStrategy) === null || _a === void 0 ? void 0 : _a.type) === 'NO_RETRIES'
+                ? null
+                : this.retryStrategy,
+            // When `retryStrategy: NO_RETRIES` and `doubleCheck: undefined`, we want to let the user disable all retries.
+            // The backend has a Joi default of `doubleCheck: true`, though, so we need special handling for this case.
+            doubleCheck: this.doubleCheck === undefined && ((_b = this.retryStrategy) === null || _b === void 0 ? void 0 : _b.type) === 'NO_RETRIES'
+                ? false
+                : this.doubleCheck,
+            alertSettings: this.alertSettings,
+            useGlobalAlertSettings: this.useGlobalAlertSettings,
+            runParallel: this.runParallel,
+        };
+    }
+}
+exports.Check = Check;
+Check.__checklyType = 'check';
+//# sourceMappingURL=check.js.map

package/dist/constructs/check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.js","sourceRoot":"","sources":["../../src/constructs/check.ts"],"names":[],"mappings":";;;AAAA,+BAA2B;AAC3B,2CAAuC;AACvC,2CAAuC;AAGvC,6EAAuE;AACvE,uCAAmC;AAKnC,2FAAoF;AA2FpF,4DAA4D;AAC5D,MAAsB,KAAM,SAAQ,qBAAS;IAwB3C,YAAa,SAAiB,EAAE,KAAiB;;QAC/C,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QACrC,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,KAAK,CAAC,4BAA4B,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAA;QAC3E,CAAC;QACD,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAA;QACpC,6FAA6F;QAC7F,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;QACxB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;QAClC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAA;QAC9C,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,KAAK,CAAC,SAAS,YAAY,qBAAS,EAAE,CAAC;YACzC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,CAAA;YAC1C,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,SAAS,CAAC,eAAe,CAAA;QACxD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAClC,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,oBAAoB,GAAG,MAAA,KAAK,CAAC,oBAAoB,mCAAI,EAAE,CAAA;QAC5D,uFAAuF;QACvF,yDAAyD;QACzD,IAAI,CAAC,aAAa,GAAG,MAAA,KAAK,CAAC,aAAa,mCAAI,EAAE,CAAA;QAC9C,iFAAiF;QACjF,IAAI,CAAC,OAAO,GAAG,MAAA,MAAA,KAAK,CAAC,KAAK,0CAAE,GAAG,EAAE,mCAAI,KAAK,CAAC,OAAO,CAAA;QAClD,6DAA6D;QAE7D,IAAI,CAAC,QAAQ,GAAG,MAAA,KAAK,CAAC,QAAQ,mCAAI,KAAK,CAAA;QACvC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;QACxC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,qBAAqB,CAAA;QAChD,IAAI,CAAC,sBAAsB,GAAG,CAAC,IAAI,CAAC,aAAa,CAAA;QACjD,IAAI,CAAC,WAAW,GAAG,MAAA,KAAK,CAAC,WAAW,mCAAI,KAAK,CAAA;QAC7C,IAAI,CAAC,eAAe,GAAG,iBAAO,CAAC,aAAa,CAAA;IAC9C,CAAC;IAEO,MAAM,CAAC,4BAA4B,CAAE,KAA0B,EAAE,UAA+B;;QACtG,IAAI,SAAoC,CAAA;QACxC,KAAK,SAAS,IAAI,UAAU,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAQ,MAAA,KAAK,CAAC,SAAS,CAAC,mCAAI,UAAU,CAAC,SAAS,CAAC,CAAA;YAC7D,KAAK,CAAC,SAAS,CAAC,GAAG,MAAM,CAAA;QAC3B,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAE,KAA0B;;QAChE,IAAI,CAAC,iBAAO,CAAC,aAAa,EAAE,CAAC;YAC3B,OAAM;QACR,CAAC;QACD,IAAI,SAAoC,CAAA;QACxC,KAAK,SAAS,IAAI,iBAAO,CAAC,aAAa,EAAE,CAAC;YACxC,MAAM,MAAM,GAAQ,MAAA,KAAK,CAAC,SAAS,CAAC,mCAAI,iBAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAA;YACxE,KAAK,CAAC,SAAS,CAAC,GAAG,MAAM,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,gBAAgB;QACd,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzC,OAAM;QACR,CAAC;QACD,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,MAAM,YAAY,GAAG,IAAI,qDAAwB,CAAC,oCAAoC,IAAI,CAAC,SAAS,IAAI,YAAY,CAAC,SAAS,EAAE,EAAE;gBAChI,cAAc,EAAE,SAAG,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;gBAChD,OAAO,EAAE,SAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;gBACjC,SAAS,EAAE,IAAI;aAChB,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,kCAAkC;QAChC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3B,OAAM;QACR,CAAC;QACD,KAAK,MAAM,eAAe,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACpD,8DAA8D;YAC9D,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;gBACxC,SAAQ;YACV,CAAC;YAED,gDAAgD;YAChD,MAAM,UAAU,GAAG,IAAI,kEAA8B,CAAC,qCAAqC,IAAI,CAAC,SAAS,IAAI,eAAe,CAAC,SAAS,EAAE,EAAE;gBACxI,iBAAiB,EAAE,SAAG,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;gBACtD,OAAO,EAAE,SAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;aAClC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,eAAe,CAAA;IAC7B,CAAC;IAED,UAAU;;QACR,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YAEzB,yEAAyE;YACzE,gBAAgB,EAAE,SAAS;YAE3B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,sFAAsF;YACtF,aAAa,EAAE,CAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,IAAI,MAAK,YAAY;gBACtD,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAI,CAAC,aAAa;YACtB,8GAA8G;YAC9G,2GAA2G;YAC3G,WAAW,EAAE,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,CAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,IAAI,MAAK,YAAY;gBACtF,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,IAAI,CAAC,WAAW;YACpB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAA;IACH,CAAC;;AAlJH,sBAmJC;AA7HiB,mBAAa,GAAG,OAAO,CAAA"}

package/dist/constructs/construct.d.ts

@@ -0,0 +1,17 @@
+import { Ref } from './ref';
+export declare abstract class Construct {
+    type: string;
+    logicalId: string;
+    physicalId?: string | number;
+    member: boolean;
+    constructor(type: string, logicalId: string, physicalId?: string | number, member?: boolean);
+    ref(): Ref;
+    allowInChecklyConfig(): boolean;
+    abstract synthesize(): any | null;
+}
+export interface Entrypoint {
+    entrypoint: string;
+}
+export interface Content {
+    content: string;
+}

package/dist/constructs/construct.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Construct = void 0;
+const project_1 = require("./project");
+const ref_1 = require("./ref");
+class Construct {
+    constructor(type, logicalId, physicalId, member) {
+        this.logicalId = logicalId;
+        this.type = type;
+        this.physicalId = physicalId;
+        this.member = member !== null && member !== void 0 ? member : true;
+        project_1.Session.validateCreateConstruct(this);
+    }
+    ref() {
+        return ref_1.Ref.from(this.logicalId);
+    }
+    allowInChecklyConfig() {
+        return false;
+    }
+}
+exports.Construct = Construct;
+//# sourceMappingURL=construct.js.map

package/dist/constructs/construct.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"construct.js","sourceRoot":"","sources":["../../src/constructs/construct.ts"],"names":[],"mappings":";;;AAAA,uCAAmC;AACnC,+BAA2B;AAE3B,MAAsB,SAAS;IAK7B,YAAa,IAAY,EAAE,SAAiB,EAAE,UAA0B,EAAE,MAAgB;QACxF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,IAAI,CAAA;QAC5B,iBAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAA;IACvC,CAAC;IAED,GAAG;QACD,OAAO,SAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACjC,CAAC;IAED,oBAAoB;QAClB,OAAO,KAAK,CAAA;IACd,CAAC;CAGF;AAtBD,8BAsBC"}

package/dist/constructs/dashboard.d.ts

@@ -0,0 +1,138 @@
+import { Construct, Content, Entrypoint } from './construct';
+export interface DashboardProps {
+    /**
+     * A list of one or more tags that filter what checks will be shown in the dashboard.
+     * All checks are included if no tag is specified.
+     */
+    tags?: Array<string>;
+    /**
+     * A subdomain name under "checklyhq.com". Needs to be unique across all users.
+     * This is required if 'customDomain' is not specified.
+     */
+    customUrl?: string;
+    /**
+     * A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
+     * This is required if 'customUrl' is not specified.
+     */
+    customDomain?: string;
+    /**
+     * A URL pointing to an image file.
+     */
+    logo?: string;
+    /**
+     * A URL pointing to an image file used as dashboard favicon.
+     */
+    favicon?: string;
+    /**
+     * A URL link to redirect when dashboard logo is clicked on.
+     */
+    link?: string;
+    /**
+     * A piece of text displayed at the top of your dashboard.
+     */
+    header?: string;
+    /**
+     * A piece of text displayed below the header or title of your dashboard.
+     */
+    description?: string;
+    /**
+     *  Determines whether to use the full screen or focus in the center. Default: 'FULL'.
+     */
+    width?: 'FULL' | '960PX';
+    /**
+     * How often to refresh the dashboard in seconds. Default: 60.
+     */
+    refreshRate?: 60 | 300 | 600;
+    /**
+     * Determines of pagination is on or off. Default: true.
+     */
+    paginate?: boolean;
+    /**
+     *  How often to trigger pagination in seconds. Default: 60.
+     */
+    paginationRate?: 30 | 60 | 300;
+    /**
+     * Number of checks displayed per page, between 1 and 20. Default: 15.
+     */
+    checksPerPage?: number;
+    /**
+     * When to use AND operator for tags lookup. Default: false.
+     */
+    useTagsAndOperator?: boolean;
+    /**
+     * Show or hide the tags on the dashboard. Default: false.
+     */
+    hideTags?: boolean;
+    /**
+     * Enable or disable incidents on the dashboard. Default: false.
+     * @description only paid accounts can enable this feature.
+     */
+    enableIncidents?: boolean;
+    /**
+     * Expand or collapse checks on the dashboard. Default: false.
+     */
+    expandChecks?: boolean;
+    /**
+     * Show or hide header and description on the dashboard. Default: true.
+     */
+    showHeader?: boolean;
+    /**
+     * Custom CSS to be applied to the dashboard.
+     */
+    customCSS?: Content | Entrypoint;
+    /**
+     * Determines if the dashboard is public or private. Default: false.
+     * @description only paid accounts can enable this feature.
+     */
+    isPrivate?: boolean;
+    /**
+     * Show or hide the P95 stats on the dashboard. Default: true.
+     */
+    showP95?: boolean;
+    /**
+     * Show or hide the P99 stats on the dashboard. Default: true.
+     */
+    showP99?: boolean;
+}
+/**
+ * Creates a Dashboard
+ *
+ * @remarks
+ *
+ * This class make use of the Dashboard endpoints.
+ */
+export declare class Dashboard extends Construct {
+    tags?: Array<string>;
+    customUrl?: string;
+    customDomain?: string;
+    logo?: string;
+    favicon?: string;
+    link?: string;
+    header?: string;
+    description?: string;
+    width?: 'FULL' | '960PX';
+    refreshRate?: 60 | 300 | 600;
+    paginate?: boolean;
+    paginationRate?: 30 | 60 | 300;
+    checksPerPage?: number;
+    useTagsAndOperator?: boolean;
+    hideTags?: boolean;
+    enableIncidents?: boolean;
+    expandChecks?: boolean;
+    showHeader?: boolean;
+    customCSS?: string;
+    isPrivate?: boolean;
+    showP95?: boolean;
+    showP99?: boolean;
+    static readonly __checklyType = "dashboard";
+    /**
+     * Constructs the Dashboard instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props dashboard configuration properties
+     *
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#dashboard Read more in the docs}
+     */
+    constructor(logicalId: string, props: DashboardProps);
+    synthesize(): any | null;
+}

package/dist/constructs/dashboard.js

@@ -0,0 +1,126 @@
+"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.Dashboard = void 0;
+const fs = __importStar(require("fs"));
+const construct_1 = require("./construct");
+const project_1 = require("./project");
+const path = __importStar(require("path"));
+/**
+ * Creates a Dashboard
+ *
+ * @remarks
+ *
+ * This class make use of the Dashboard endpoints.
+ */
+class Dashboard extends construct_1.Construct {
+    /**
+     * Constructs the Dashboard instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props dashboard configuration properties
+     *
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#dashboard Read more in the docs}
+     */
+    constructor(logicalId, props) {
+        super(Dashboard.__checklyType, logicalId);
+        this.tags = props.tags;
+        this.customUrl = props.customUrl;
+        this.customDomain = props.customDomain;
+        this.logo = props.logo;
+        this.favicon = props.favicon;
+        this.link = props.link;
+        this.header = props.header;
+        this.description = props.description;
+        this.width = props.width;
+        this.refreshRate = props.refreshRate;
+        this.paginate = props.paginate;
+        this.paginationRate = props.paginationRate;
+        this.checksPerPage = props.checksPerPage;
+        this.useTagsAndOperator = props.useTagsAndOperator;
+        this.hideTags = props.hideTags;
+        this.enableIncidents = props.enableIncidents;
+        this.expandChecks = props.expandChecks;
+        this.showHeader = props.showHeader;
+        this.isPrivate = props.isPrivate;
+        this.showP95 = props.showP95;
+        this.showP99 = props.showP99;
+        if (!props.customUrl && !props.customDomain) {
+            throw new Error('Either a "customUrl" or "customDomain" must be specified.');
+        }
+        if (props.customCSS) {
+            if ('entrypoint' in props.customCSS) {
+                const entrypoint = props.customCSS.entrypoint;
+                let absoluteEntrypoint = null;
+                if (path.isAbsolute(entrypoint)) {
+                    absoluteEntrypoint = entrypoint;
+                }
+                else {
+                    if (!project_1.Session.checkFileAbsolutePath) {
+                        throw new Error('You cannot use relative paths without the checkFileAbsolutePath in session');
+                    }
+                    absoluteEntrypoint = path.join(path.dirname(project_1.Session.checkFileAbsolutePath), entrypoint);
+                }
+                if (!fs.existsSync(absoluteEntrypoint)) {
+                    throw new Error(`Unrecognized CSS code or file not found for 'customCSS' property in dashboard '${logicalId}'.`);
+                }
+                this.customCSS = String(fs.readFileSync(absoluteEntrypoint));
+            }
+            else if ('content' in props.customCSS) {
+                this.customCSS = props.customCSS.content;
+            }
+        }
+        project_1.Session.registerConstruct(this);
+    }
+    synthesize() {
+        return {
+            tags: this.tags,
+            customUrl: this.customUrl,
+            customDomain: this.customDomain,
+            logo: this.logo,
+            favicon: this.favicon,
+            link: this.link,
+            header: this.header,
+            description: this.description,
+            width: this.width,
+            refreshRate: this.refreshRate,
+            paginate: this.paginate,
+            paginationRate: this.paginationRate,
+            checksPerPage: this.checksPerPage,
+            useTagsAndOperator: this.useTagsAndOperator,
+            hideTags: this.hideTags,
+            enableIncidents: this.enableIncidents,
+            expandChecks: this.expandChecks,
+            showHeader: this.showHeader,
+            customCSS: this.customCSS,
+            isPrivate: this.isPrivate,
+            showP95: this.showP95,
+            showP99: this.showP99,
+        };
+    }
+}
+exports.Dashboard = Dashboard;
+Dashboard.__checklyType = 'dashboard';
+//# sourceMappingURL=dashboard.js.map

package/dist/constructs/dashboard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashboard.js","sourceRoot":"","sources":["../../src/constructs/dashboard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAwB;AACxB,2CAA4D;AAC5D,uCAAmC;AACnC,2CAA4B;AAkG5B;;;;;;GAMG;AACH,MAAa,SAAU,SAAQ,qBAAS;IA0BtC;;;;;;;OAOG;IACH,YAAa,SAAiB,EAAE,KAAqB;QACnD,KAAK,CAAC,SAAS,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QACzC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;QACtC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;QACxB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;QAC1C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAA;QAClD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAA;QAC5C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;QACtC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;QAClC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAE5B,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;QAC9E,CAAC;QAED,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,YAAY,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC,UAAU,CAAA;gBAC7C,IAAI,kBAAkB,GAAG,IAAI,CAAA;gBAC7B,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;oBAChC,kBAAkB,GAAG,UAAU,CAAA;gBACjC,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,iBAAO,CAAC,qBAAqB,EAAE,CAAC;wBACnC,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAA;oBAC/F,CAAC;oBACD,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAO,CAAC,qBAAqB,CAAC,EAAE,UAAU,CAAC,CAAA;gBACzF,CAAC;gBAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBACvC,MAAM,IAAI,KAAK,CAAC,kFAAkF,SAAS,IAAI,CAAC,CAAA;gBAClH,CAAC;gBACD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,SAAS,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;gBACxC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAA;YAC1C,CAAC;QACH,CAAC;QAED,iBAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,UAAU;QACR,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;IACH,CAAC;;AAhHH,8BAiHC;AAzFiB,uBAAa,GAAG,WAAW,CAAA"}

package/dist/constructs/email-alert-channel.d.ts

@@ -0,0 +1,26 @@
+import { AlertChannel, AlertChannelProps } from './alert-channel';
+export interface EmailAlertChannelProps extends AlertChannelProps {
+    /**
+     * The email address where to send the alert notifications.
+     */
+    address: string;
+}
+/**
+ * Creates an Email Alert Channel
+ *
+ * @remarks
+ *
+ * This class make use of the Alert Channel endpoints.
+ */
+export declare class EmailAlertChannel extends AlertChannel {
+    address: string;
+    /**
+     * Constructs the Email Alert Channel instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props email alert channel configuration properties
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#emailalertchannel Read more in the docs}
+     */
+    constructor(logicalId: string, props: EmailAlertChannelProps);
+    synthesize(): any;
+}

package/dist/constructs/email-alert-channel.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailAlertChannel = void 0;
+const alert_channel_1 = require("./alert-channel");
+const project_1 = require("./project");
+/**
+ * Creates an Email Alert Channel
+ *
+ * @remarks
+ *
+ * This class make use of the Alert Channel endpoints.
+ */
+class EmailAlertChannel extends alert_channel_1.AlertChannel {
+    /**
+     * Constructs the Email Alert Channel instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props email alert channel configuration properties
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#emailalertchannel Read more in the docs}
+     */
+    constructor(logicalId, props) {
+        super(logicalId, props);
+        this.address = props.address;
+        project_1.Session.registerConstruct(this);
+    }
+    synthesize() {
+        return {
+            ...super.synthesize(),
+            type: 'EMAIL',
+            config: {
+                address: this.address,
+            },
+        };
+    }
+}
+exports.EmailAlertChannel = EmailAlertChannel;
+//# sourceMappingURL=email-alert-channel.js.map

package/dist/constructs/email-alert-channel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-alert-channel.js","sourceRoot":"","sources":["../../src/constructs/email-alert-channel.ts"],"names":[],"mappings":";;;AAAA,mDAAiE;AACjE,uCAAmC;AASnC;;;;;;GAMG;AACH,MAAa,iBAAkB,SAAQ,4BAAY;IAEjD;;;;;;OAMG;IACH,YAAa,SAAiB,EAAE,KAA6B;QAC3D,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,iBAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,KAAK,CAAC,UAAU,EAAE;YACrB,IAAI,EAAE,OAAO;YACb,MAAM,EAAE;gBACN,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB;SACF,CAAA;IACH,CAAC;CACF;AAxBD,8CAwBC"}

package/dist/constructs/environment-variable.d.ts

@@ -0,0 +1,2 @@
+import KeyValuePair from './key-value-pair';
+export type EnvironmentVariable = KeyValuePair;