checkly 0.0.0-pr.1006.2fb1ffc

package/dist/constructs/browser-check.js

@@ -0,0 +1,151 @@
+"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.BrowserCheck = 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 snapshot_service_1 = require("../services/snapshot-service");
+/**
+ * Creates a Browser Check
+ *
+ * @remarks
+ *
+ * This class make use of the Browser Checks endpoints.
+ */
+class BrowserCheck extends check_1.Check {
+    /**
+     * 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, props) {
+        if (props.group) {
+            BrowserCheck.applyDefaultBrowserCheckGroupConfig(props, props.group.getBrowserCheckDefaults());
+        }
+        BrowserCheck.applyDefaultBrowserCheckConfig(props);
+        super(logicalId, props);
+        this.sslCheckDomain = props.sslCheckDomain;
+        this.playwrightConfig = props.playwrightConfig;
+        if ('content' in props.code) {
+            const script = props.code.content;
+            this.script = script;
+        }
+        else if ('entrypoint' in props.code) {
+            const entrypoint = props.code.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);
+            }
+            // runtimeId will always be set by check or browser check defaults so it is safe to use ! operator
+            const bundle = BrowserCheck.bundle(absoluteEntrypoint, this.runtimeId);
+            if (!bundle.script) {
+                throw new Error(`Browser check "${logicalId}" is not allowed to be empty`);
+            }
+            this.script = bundle.script;
+            this.scriptPath = bundle.scriptPath;
+            this.dependencies = bundle.dependencies;
+            this.rawSnapshots = bundle.snapshots;
+        }
+        else {
+            throw new Error('Unrecognized type for the "code" property. The "code" property should be a string of JS/TS code.');
+        }
+        project_1.Session.registerConstruct(this);
+        this.addSubscriptions();
+        this.addPrivateLocationCheckAssignments();
+    }
+    static applyDefaultBrowserCheckGroupConfig(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 applyDefaultBrowserCheckConfig(props) {
+        var _a;
+        if (!project_1.Session.browserCheckDefaults) {
+            return;
+        }
+        let configKey;
+        for (configKey in project_1.Session.browserCheckDefaults) {
+            const newVal = (_a = props[configKey]) !== null && _a !== void 0 ? _a : project_1.Session.browserCheckDefaults[configKey];
+            props[configKey] = newVal;
+        }
+    }
+    static bundle(entry, runtimeId) {
+        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(entry);
+        // 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,
+            snapshots: (0, snapshot_service_1.detectSnapshots)(project_1.Session.basePath, parsed.entrypoint.filePath),
+        };
+    }
+    getSourceFile() {
+        var _a;
+        return (_a = this.__checkFilePath) !== null && _a !== void 0 ? _a : this.scriptPath;
+    }
+    synthesize() {
+        return {
+            ...super.synthesize(),
+            checkType: 'BROWSER',
+            script: this.script,
+            scriptPath: this.scriptPath,
+            dependencies: this.dependencies,
+            sslCheckDomain: this.sslCheckDomain || null, // empty string is converted to null
+            snapshots: this.snapshots,
+            playwrightConfig: this.playwrightConfig,
+        };
+    }
+}
+exports.BrowserCheck = BrowserCheck;
+//# sourceMappingURL=browser-check.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"browser-check.js","sourceRoot":"","sources":["../../src/constructs/browser-check.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA4B;AAC5B,mCAA2C;AAC3C,uCAAmC;AACnC,4DAAwD;AAExD,2CAA8C;AAE9C,mEAAwE;AA0BxE;;;;;;GAMG;AACH,MAAa,YAAa,SAAQ,aAAK;IAYrC;;;;;;OAMG;IACH,YAAa,SAAiB,EAAE,KAAwB;QACtD,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,YAAY,CAAC,mCAAmC,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,uBAAuB,EAAE,CAAC,CAAA;QAChG,CAAC;QACD,YAAY,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAA;QAClD,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACvB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;QAC1C,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAA;QAC9C,IAAI,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YAC5B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAA;YACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACtB,CAAC;aAAM,IAAI,YAAY,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACtC,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAA;YACxC,IAAI,kBAAkB,GAAG,IAAI,CAAA;YAC7B,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAChC,kBAAkB,GAAG,UAAU,CAAA;YACjC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,iBAAO,CAAC,qBAAqB,EAAE,CAAC;oBACnC,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAA;gBAC/F,CAAC;gBACD,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAO,CAAC,qBAAqB,CAAC,EAAE,UAAU,CAAC,CAAA;YACzF,CAAC;YACD,kGAAkG;YAClG,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAU,CAAC,CAAA;YACvE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,kBAAkB,SAAS,8BAA8B,CAAC,CAAA;YAC5E,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;YAC3B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAA;YACnC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;YACvC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,SAAS,CAAA;QACtC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAA;QACrH,CAAC;QACD,iBAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC/B,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,IAAI,CAAC,kCAAkC,EAAE,CAAA;IAC3C,CAAC;IAEO,MAAM,CAAC,mCAAmC,CAAE,KAA0B,EAAE,UAA+B;;QAC7G,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,8BAA8B,CAAE,KAA0B;;QACvE,IAAI,CAAC,iBAAO,CAAC,oBAAoB,EAAE,CAAC;YAClC,OAAM;QACR,CAAC;QACD,IAAI,SAAoC,CAAA;QACxC,KAAK,SAAS,IAAI,iBAAO,CAAC,oBAAoB,EAAE,CAAC;YAC/C,MAAM,MAAM,GAAQ,MAAA,KAAK,CAAC,SAAS,CAAC,mCAAI,iBAAO,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAA;YAC/E,KAAK,CAAC,SAAS,CAAC,GAAG,MAAM,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,MAAM,CAAC,MAAM,CAAE,KAAa,EAAE,SAAiB;QAC7C,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,KAAK,CAAC,CAAA;QAClC,gEAAgE;QAEhE,MAAM,IAAI,GAAsB,EAAE,CAAA;QAClC,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;YAClB,SAAS,EAAE,IAAA,kCAAe,EAAC,iBAAO,CAAC,QAAS,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;SAC1E,CAAA;IACH,CAAC;IAED,aAAa;;QACX,OAAO,MAAA,IAAI,CAAC,eAAe,mCAAI,IAAI,CAAC,UAAU,CAAA;IAChD,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,KAAK,CAAC,UAAU,EAAE;YACrB,SAAS,EAAE,SAAS;YACpB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI,EAAE,oCAAoC;YACjF,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;SACxC,CAAA;IACH,CAAC;CACF;AAxHD,oCAwHC"}

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

@@ -0,0 +1,162 @@
+import { Construct } from './construct';
+import { AlertChannel } from './alert-channel';
+import { EnvironmentVariable } from './environment-variable';
+import { PrivateLocation } from './private-location';
+import { CheckConfigDefaults } from '../services/checkly-config-loader';
+import { ApiCheckDefaultConfig } from './api-check';
+import type { Region } from '..';
+import type { Frequency } from './frequency';
+import type { RetryStrategy } from './retry-strategy';
+import { AlertEscalation } from './alert-escalation-policy';
+type BrowserCheckConfig = CheckConfigDefaults & {
+    /**
+     * Glob pattern to include multiple files, i.e. all `.spec.ts` files
+     */
+    testMatch: string | string[];
+};
+type MultiStepCheckConfig = CheckConfigDefaults & {
+    /**
+     * Glob pattern to include multiple files, i.e. all `.spec.ts` files
+     */
+    testMatch: string | string[];
+};
+export interface CheckGroupProps {
+    /**
+     * The name of the check group.
+     */
+    name: string;
+    /**
+     * Determines if the checks in the group are running or not.
+     */
+    activated?: boolean;
+    /**
+     * Determines if any notifications will be sent out when a check in this group 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 CheckGroupProps.retryStrategy} instead.
+     */
+    doubleCheck?: boolean;
+    /**
+     * The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.
+     */
+    runtimeId?: string;
+    /**
+     * An array of one or more data center locations where to run the checks.
+     */
+    locations?: Array<keyof Region>;
+    /**
+     * An array of one or more private locations where to run the checks.
+     */
+    privateLocations?: Array<string | PrivateLocation>;
+    /**
+     * Tags for organizing and filtering checks.
+     */
+    tags?: Array<string>;
+    /**
+     * Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.
+     */
+    concurrency?: number;
+    /**
+     * Optional fallback value for checks belonging to the group. How often the check should run in minutes.
+     */
+    frequency?: number | Frequency;
+    environmentVariables?: Array<EnvironmentVariable>;
+    /**
+     * List of alert channels to be alerted when checks in this group fail or recover.
+     */
+    alertChannels?: Array<AlertChannel>;
+    browserChecks?: BrowserCheckConfig;
+    multiStepChecks?: MultiStepCheckConfig;
+    alertEscalationPolicy?: AlertEscalation;
+    /**
+     * A valid piece of Node.js code to run in the setup phase of an API check in this group.
+    * @deprecated use the "ApiCheck.setupScript" property instead and use common JS/TS code
+    * composition to add group specific setup routines.
+    */
+    localSetupScript?: string;
+    /**
+     * A valid piece of Node.js code to run in the teardown phase of an API check in this group.
+    * @deprecated use the "ApiCheck.tearDownScript" property instead and use common JS/TS code
+    * composition to add group specific teardown routines.
+     */
+    localTearDownScript?: string;
+    apiCheckDefaults?: ApiCheckDefaultConfig;
+    /**
+     * Sets a retry policy for the group. Use RetryStrategyBuilder to create a retry policy.
+     */
+    retryStrategy?: RetryStrategy;
+    /**
+     * Determines whether the checks in the group 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;
+}
+/**
+ * Creates a Check Group
+ *
+ * @remarks
+ *
+ * This class make use of the Check Groups endpoints.
+ */
+export declare class CheckGroup extends Construct {
+    name: string;
+    activated?: boolean;
+    muted?: boolean;
+    doubleCheck?: boolean;
+    runtimeId?: string;
+    locations: Array<keyof Region>;
+    privateLocations?: Array<string | PrivateLocation>;
+    tags?: Array<string>;
+    concurrency?: number;
+    frequency?: number | Frequency;
+    environmentVariables?: Array<EnvironmentVariable>;
+    alertChannels?: Array<AlertChannel>;
+    localSetupScript?: string;
+    localTearDownScript?: string;
+    apiCheckDefaults: ApiCheckDefaultConfig;
+    browserChecks?: BrowserCheckConfig;
+    multiStepChecks?: MultiStepCheckConfig;
+    retryStrategy?: RetryStrategy;
+    runParallel?: boolean;
+    alertSettings?: AlertEscalation;
+    useGlobalAlertSettings?: boolean;
+    static readonly __checklyType = "check-group";
+    /**
+     * Constructs the CheckGroup instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props CheckGroup configuration properties
+     *
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#checkgroup Read more in the docs}
+     */
+    constructor(logicalId: string, props: CheckGroupProps);
+    private __addChecks;
+    private __addSubscriptions;
+    private __addPrivateLocationGroupAssignments;
+    getCheckDefaults(): CheckConfigDefaults;
+    getBrowserCheckDefaults(): CheckConfigDefaults;
+    getMultiStepCheckDefaults(): CheckConfigDefaults;
+    synthesize(): {
+        name: string;
+        activated: boolean | undefined;
+        muted: boolean | undefined;
+        tags: string[] | undefined;
+        locations: (keyof Region)[];
+        runtimeId: string | undefined;
+        privateLocations: undefined;
+        concurrency: number | undefined;
+        localSetupScript: string | undefined;
+        localTearDownScript: string | undefined;
+        apiCheckDefaults: ApiCheckDefaultConfig;
+        environmentVariables: import("./key-value-pair").default[] | undefined;
+        retryStrategy: RetryStrategy | null | undefined;
+        doubleCheck: boolean | undefined;
+        runParallel: boolean | undefined;
+        alertSettings: AlertEscalation | undefined;
+        useGlobalAlertSettings: boolean | undefined;
+    };
+}
+export {};

package/dist/constructs/check-group.js

@@ -0,0 +1,208 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckGroup = void 0;
+const path = __importStar(require("path"));
+const glob_1 = require("glob");
+const ref_1 = require("./ref");
+const project_1 = require("./project");
+const construct_1 = require("./construct");
+const browser_check_1 = require("./browser-check");
+const alert_channel_subscription_1 = require("./alert-channel-subscription");
+const private_location_group_assignment_1 = require("./private-location-group-assignment");
+const util_1 = require("../services/util");
+const multi_step_check_1 = require("./multi-step-check");
+const constants_1 = __importDefault(require("../constants"));
+const defaultApiCheckDefaults = {
+    headers: [],
+    queryParameters: [],
+    url: '',
+    basicAuth: {
+        username: '',
+        password: '',
+    },
+};
+/**
+ * Creates a Check Group
+ *
+ * @remarks
+ *
+ * This class make use of the Check Groups endpoints.
+ */
+class CheckGroup extends construct_1.Construct {
+    /**
+     * Constructs the CheckGroup instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props CheckGroup configuration properties
+     *
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#checkgroup Read more in the docs}
+     */
+    constructor(logicalId, props) {
+        var _a, _b, _c, _d, _e;
+        super(CheckGroup.__checklyType, logicalId);
+        this.name = props.name;
+        this.activated = props.activated;
+        this.muted = props.muted;
+        this.doubleCheck = props.doubleCheck;
+        this.tags = props.tags;
+        this.runtimeId = props.runtimeId;
+        this.locations = (_a = props.locations) !== null && _a !== void 0 ? _a : [];
+        this.privateLocations = props.privateLocations;
+        this.concurrency = props.concurrency;
+        // `frequency` is not a CheckGroup resource property. Not present in synthesize()
+        this.frequency = props.frequency;
+        this.apiCheckDefaults = { ...defaultApiCheckDefaults, ...props.apiCheckDefaults };
+        this.alertSettings = props.alertEscalationPolicy;
+        this.useGlobalAlertSettings = !this.alertSettings;
+        this.environmentVariables = (_b = props.environmentVariables) !== null && _b !== void 0 ? _b : [];
+        this.environmentVariables.forEach(ev => {
+            // only empty string is checked because the KeyValuePair.value doesn't allow undefined or null.
+            if (ev.value === '') {
+                throw new Error(`Environment variable "${ev.key}" from check group "${logicalId}" is not allowed to be empty`);
+            }
+        });
+        this.alertChannels = (_c = props.alertChannels) !== null && _c !== void 0 ? _c : [];
+        this.localSetupScript = props.localSetupScript;
+        this.localTearDownScript = props.localTearDownScript;
+        this.retryStrategy = props.retryStrategy;
+        this.runParallel = props.runParallel;
+        // `browserChecks` is not a CheckGroup resource property. Not present in synthesize()
+        this.browserChecks = props.browserChecks;
+        const fileAbsolutePath = project_1.Session.checkFileAbsolutePath;
+        if ((_d = props.browserChecks) === null || _d === void 0 ? void 0 : _d.testMatch) {
+            this.__addChecks(fileAbsolutePath, props.browserChecks.testMatch, constants_1.default.BROWSER);
+        }
+        this.multiStepChecks = props.multiStepChecks;
+        if ((_e = props.multiStepChecks) === null || _e === void 0 ? void 0 : _e.testMatch) {
+            this.__addChecks(fileAbsolutePath, props.multiStepChecks.testMatch, constants_1.default.MULTI_STEP);
+        }
+        project_1.Session.registerConstruct(this);
+        this.__addSubscriptions();
+        this.__addPrivateLocationGroupAssignments();
+    }
+    __addChecks(fileAbsolutePath, testMatch, checkType) {
+        const parent = path.dirname(fileAbsolutePath);
+        const matched = glob_1.glob.sync(testMatch, { nodir: true, cwd: parent });
+        for (const match of matched) {
+            const filepath = path.join(parent, match);
+            const props = {
+                group: this,
+                name: match,
+                code: {
+                    entrypoint: filepath,
+                },
+                // the browserChecks props inherited from the group are applied in BrowserCheck.constructor()
+            };
+            const checkLogicalId = (0, util_1.pathToPosix)(path.relative(project_1.Session.basePath, filepath));
+            checkType === constants_1.default.BROWSER
+                ? new browser_check_1.BrowserCheck(checkLogicalId, props)
+                : new multi_step_check_1.MultiStepCheck(checkLogicalId, props);
+        }
+    }
+    __addSubscriptions() {
+        if (!this.alertChannels) {
+            return;
+        }
+        for (const alertChannel of this.alertChannels) {
+            const subscription = new alert_channel_subscription_1.AlertChannelSubscription(`check-group-alert-channel-subscription#${this.logicalId}#${alertChannel.logicalId}`, {
+                alertChannelId: ref_1.Ref.from(alertChannel.logicalId),
+                groupId: ref_1.Ref.from(this.logicalId),
+                activated: true,
+            });
+        }
+    }
+    __addPrivateLocationGroupAssignments() {
+        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_group_assignment_1.PrivateLocationGroupAssignment(`private-location-group-assignment#${this.logicalId}#${privateLocation.logicalId}`, {
+                privateLocationId: ref_1.Ref.from(privateLocation.logicalId),
+                groupId: ref_1.Ref.from(this.logicalId),
+            });
+        }
+    }
+    getCheckDefaults() {
+        // TODO: investigate if make sense to add all other check's properties
+        return {
+            frequency: this.frequency,
+        };
+    }
+    getBrowserCheckDefaults() {
+        var _a;
+        // TODO: investigate if make sense to add all other browser-check's properties
+        return {
+            frequency: (_a = this.browserChecks) === null || _a === void 0 ? void 0 : _a.frequency,
+        };
+    }
+    getMultiStepCheckDefaults() {
+        var _a;
+        return {
+            frequency: (_a = this.multiStepChecks) === null || _a === void 0 ? void 0 : _a.frequency,
+        };
+    }
+    synthesize() {
+        var _a, _b;
+        return {
+            name: this.name,
+            activated: this.activated,
+            muted: this.muted,
+            tags: this.tags,
+            locations: this.locations,
+            runtimeId: this.runtimeId,
+            // private-location instances are assigned with loadAllPrivateLocations()
+            privateLocations: undefined,
+            concurrency: this.concurrency,
+            localSetupScript: this.localSetupScript,
+            localTearDownScript: this.localTearDownScript,
+            apiCheckDefaults: this.apiCheckDefaults,
+            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,
+            runParallel: this.runParallel,
+            alertSettings: this.alertSettings,
+            useGlobalAlertSettings: this.useGlobalAlertSettings,
+        };
+    }
+}
+exports.CheckGroup = CheckGroup;
+CheckGroup.__checklyType = 'check-group';
+//# sourceMappingURL=check-group.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"check-group.js","sourceRoot":"","sources":["../../src/constructs/check-group.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA4B;AAC5B,+BAA2B;AAC3B,+BAA2B;AAC3B,uCAAmC;AACnC,2CAAuC;AACvC,mDAA8C;AAG9C,6EAAuE;AAEvE,2FAAoF;AAGpF,2CAA8C;AAK9C,yDAAmD;AACnD,6DAAqC;AAErC,MAAM,uBAAuB,GAA0B;IACrD,OAAO,EAAE,EAAE;IACX,eAAe,EAAE,EAAE;IACnB,GAAG,EAAE,EAAE;IACP,SAAS,EAAE;QACT,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,EAAE;KACb;CACF,CAAA;AA2FD;;;;;;GAMG;AACH,MAAa,UAAW,SAAQ,qBAAS;IAyBvC;;;;;;;OAOG;IACH,YAAa,SAAiB,EAAE,KAAsB;;QACpD,KAAK,CAAC,UAAU,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QAC1C,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,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,SAAS,GAAG,MAAA,KAAK,CAAC,SAAS,mCAAI,EAAE,CAAA;QACtC,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAA;QAC9C,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,iFAAiF;QACjF,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,gBAAgB,GAAG,EAAE,GAAG,uBAAuB,EAAE,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAA;QACjF,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,qBAAqB,CAAA;QAChD,IAAI,CAAC,sBAAsB,GAAG,CAAC,IAAI,CAAC,aAAa,CAAA;QACjD,IAAI,CAAC,oBAAoB,GAAG,MAAA,KAAK,CAAC,oBAAoB,mCAAI,EAAE,CAAA;QAC5D,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACrC,+FAA+F;YAC/F,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CAAC,yBAAyB,EAAE,CAAC,GAAG,uBAAuB,SAAS,8BAA8B,CAAC,CAAA;YAChH,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,aAAa,GAAG,MAAA,KAAK,CAAC,aAAa,mCAAI,EAAE,CAAA;QAC9C,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAA;QAC9C,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAA;QACpD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;QACxC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,qFAAqF;QACrF,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;QACxC,MAAM,gBAAgB,GAAG,iBAAO,CAAC,qBAAsB,CAAA;QACvD,IAAI,MAAA,KAAK,CAAC,aAAa,0CAAE,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,EAAE,mBAAU,CAAC,OAAO,CAAC,CAAA;QACvF,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAA;QAC5C,IAAI,MAAA,KAAK,CAAC,eAAe,0CAAE,SAAS,EAAE,CAAC;YACrC,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,SAAS,EAAE,mBAAU,CAAC,UAAU,CAAC,CAAA;QAC5F,CAAC;QACD,iBAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC/B,IAAI,CAAC,kBAAkB,EAAE,CAAA;QACzB,IAAI,CAAC,oCAAoC,EAAE,CAAA;IAC7C,CAAC;IAEO,WAAW,CACjB,gBAAwB,EACxB,SAA0B,EAC1B,SAAmE;QAEnE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;QAC7C,MAAM,OAAO,GAAG,WAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAA;QAClE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;YACzC,MAAM,KAAK,GAAG;gBACZ,KAAK,EAAE,IAAI;gBACX,IAAI,EAAE,KAAK;gBACX,IAAI,EAAE;oBACJ,UAAU,EAAE,QAAQ;iBACrB;gBACD,6FAA6F;aAC9F,CAAA;YACD,MAAM,cAAc,GAAG,IAAA,kBAAW,EAAC,IAAI,CAAC,QAAQ,CAAC,iBAAO,CAAC,QAAS,EAAE,QAAQ,CAAC,CAAC,CAAA;YAC9E,SAAS,KAAK,mBAAU,CAAC,OAAO;gBAC9B,CAAC,CAAC,IAAI,4BAAY,CAAC,cAAc,EAAE,KAAK,CAAC;gBACzC,CAAC,CAAC,IAAI,iCAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;QAC/C,CAAC;IACH,CAAC;IAEO,kBAAkB;QACxB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,OAAM;QACR,CAAC;QACD,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,MAAM,YAAY,GAAG,IAAI,qDAAwB,CAAC,0CAA0C,IAAI,CAAC,SAAS,IAAI,YAAY,CAAC,SAAS,EAAE,EAAE;gBACtI,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;IAEO,oCAAoC;QAC1C,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;IAEM,gBAAgB;QACrB,sEAAsE;QACtE,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAA;IACH,CAAC;IAEM,uBAAuB;;QAC5B,8EAA8E;QAC9E,OAAO;YACL,SAAS,EAAE,MAAA,IAAI,CAAC,aAAa,0CAAE,SAAS;SACzC,CAAA;IACH,CAAC;IAEM,yBAAyB;;QAC9B,OAAO;YACL,SAAS,EAAE,MAAA,IAAI,CAAC,eAAe,0CAAE,SAAS;SAC3C,CAAA;IACH,CAAC;IAED,UAAU;;QACR,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YAEzB,yEAAyE;YACzE,gBAAgB,EAAE,SAAS;YAE3B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,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,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;SACpD,CAAA;IACH,CAAC;;AAtLH,gCAuLC;AAhKiB,wBAAa,GAAG,aAAa,CAAA"}