checkly 5.6.0 → 6.0.0-prerelease-541d8e1

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

@@ -0,0 +1,271 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckGroupV1 = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const glob_1 = require("glob");
+const construct_diagnostics_1 = require("./construct-diagnostics");
+const constants_1 = __importDefault(require("../constants"));
+const util_1 = require("../services/util");
+const alert_channel_subscription_1 = require("./alert-channel-subscription");
+const browser_check_1 = require("./browser-check");
+const check_group_ref_1 = require("./check-group-ref");
+const construct_1 = require("./construct");
+const multi_step_check_1 = require("./multi-step-check");
+const private_location_group_assignment_1 = require("./private-location-group-assignment");
+const ref_1 = require("./ref");
+const project_1 = require("./project");
+const defaultApiCheckDefaults = {
+    headers: [],
+    queryParameters: [],
+    url: '',
+    basicAuth: {
+        username: '',
+        password: '',
+    },
+};
+/**
+ * Creates a Check Group (v1).
+ *
+ * We strongly recommend upgrading to {@link CheckGroupV2} instead.
+ *
+ * The original CheckGroup v1 comes with implicit defaults that are not
+ * intuitive and make it impossible to keep check-level behavior for
+ * certain properties.
+ *
+ * The following properties will always use the group's values if set, or
+ * implicit defaults if not set:
+ *
+ *   - {@link CheckGroupV1Props.alertEscalationPolicy}
+ *   - {@link CheckGroupV1Props.retryStrategy}
+ *   - {@link CheckGroupV1Props.runParallel}
+ *
+ * Please check the documentation for the individual properties to see their
+ * behavior.
+ *
+ * For more information regarding the update, please see:
+ *   https://feedback.checklyhq.com/changelog/checkly-groups-update-organize-checks-your-way
+ *
+ * @deprecated Use {@link CheckGroupV2} instead.
+ */
+class CheckGroupV1 extends construct_1.Construct {
+    name;
+    activated;
+    muted;
+    doubleCheck;
+    runtimeId;
+    locations;
+    privateLocations;
+    tags;
+    concurrency;
+    frequency;
+    environmentVariables;
+    alertChannels;
+    localSetupScript;
+    localTearDownScript;
+    apiCheckDefaults;
+    browserChecks;
+    multiStepChecks;
+    retryStrategy;
+    runParallel;
+    alertSettings;
+    useGlobalAlertSettings;
+    static __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, props) {
+        super(CheckGroupV1.__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 = props.locations ?? [];
+        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 = props.environmentVariables ?? [];
+        this.alertChannels = props.alertChannels ?? [];
+        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 (props.browserChecks?.testMatch) {
+            this.__addChecks(fileAbsolutePath, props.browserChecks.testMatch, constants_1.default.BROWSER);
+        }
+        this.multiStepChecks = props.multiStepChecks;
+        if (props.multiStepChecks?.testMatch) {
+            this.__addChecks(fileAbsolutePath, props.multiStepChecks.testMatch, constants_1.default.MULTI_STEP);
+        }
+        project_1.Session.registerConstruct(this);
+        this.__addSubscriptions();
+        this.__addPrivateLocationGroupAssignments();
+    }
+    async onBeforeValidate(diagnostics) {
+        diagnostics.add(new construct_diagnostics_1.DeprecatedConstructDiagnostic('CheckGroup', new Error(`Please update to CheckGroupV2 which has more intuitive behavior.` +
+            `\n\n` +
+            `For more information, please see:\n` +
+            `  https://feedback.checklyhq.com/changelog/checkly-groups-update-organize-checks-your-way`)));
+    }
+    async validateDoubleCheck(diagnostics) {
+        if (this.doubleCheck !== undefined) {
+            if (this.retryStrategy) {
+                diagnostics.add(new construct_diagnostics_1.InvalidPropertyValueDiagnostic('doubleCheck', new Error('Cannot specify both "doubleCheck" and "retryStrategy".')));
+            }
+            if (this.doubleCheck) {
+                diagnostics.add(new construct_diagnostics_1.DeprecatedPropertyDiagnostic('doubleCheck', new Error(`To match the behavior of doubleCheck: true, please use the ` +
+                    `following retryStrategy instead:` +
+                    `\n\n` +
+                    `  RetryStrategyBuilder.fixedStrategy({\n` +
+                    `    maxRetries: 1,\n` +
+                    `    baseBackoffSeconds: 0,\n` +
+                    `    maxDurationSeconds: 600,\n` +
+                    `    sameRegion: false,\n` +
+                    `  })`)));
+            }
+            else {
+                diagnostics.add(new construct_diagnostics_1.DeprecatedPropertyDiagnostic('doubleCheck', new Error(`To match the behavior of doubleCheck: false, please use the ` +
+                    `following retryStrategy instead:` +
+                    `\n\n` +
+                    `  RetryStrategyBuilder.noRetries()`)));
+            }
+        }
+    }
+    async validate(diagnostics) {
+        await this.onBeforeValidate(diagnostics);
+        await this.validateDoubleCheck(diagnostics);
+        if (this.environmentVariables) {
+            this.environmentVariables.forEach(ev => {
+                // only empty string is checked because the KeyValuePair.value doesn't allow undefined or null.
+                if (ev.value === '') {
+                    diagnostics.add(new construct_diagnostics_1.InvalidPropertyValueDiagnostic('environmentVariables', new Error(`Value must not be empty.`)));
+                }
+            });
+        }
+        if (this.localSetupScript) {
+            diagnostics.add(new construct_diagnostics_1.DeprecatedPropertyDiagnostic('localSetupScript', new Error(`Use the setupScript property directly in your ApiChecks instead.`)));
+        }
+        if (this.localTearDownScript) {
+            diagnostics.add(new construct_diagnostics_1.DeprecatedPropertyDiagnostic('localTearDownScript', new Error(`Use the tearDownScript property directly in your ApiChecks instead.`)));
+        }
+    }
+    static fromId(id) {
+        return new check_group_ref_1.CheckGroupRef(`check-group-${id}`, id);
+    }
+    __addChecks(fileAbsolutePath, testMatch, checkType) {
+        const parent = node_path_1.default.dirname(fileAbsolutePath);
+        const matched = glob_1.glob.sync(testMatch, { nodir: true, cwd: parent });
+        for (const match of matched) {
+            const filepath = node_path_1.default.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)(node_path_1.default.relative(project_1.Session.basePath, filepath));
+            if (checkType === constants_1.default.BROWSER) {
+                new browser_check_1.BrowserCheck(checkLogicalId, props);
+            }
+            else {
+                new multi_step_check_1.MultiStepCheck(checkLogicalId, props);
+            }
+        }
+    }
+    __addSubscriptions() {
+        if (!this.alertChannels) {
+            return;
+        }
+        for (const alertChannel of this.alertChannels) {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            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
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            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() {
+        // TODO: investigate if make sense to add all other browser-check's properties
+        return {
+            frequency: this.browserChecks?.frequency,
+        };
+    }
+    getMultiStepCheckDefaults() {
+        return {
+            frequency: this.multiStepChecks?.frequency,
+        };
+    }
+    synthesize() {
+        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: this.retryStrategy?.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 && this.retryStrategy?.type === 'NO_RETRIES'
+                ? false
+                : this.doubleCheck,
+            runParallel: this.runParallel,
+            alertSettings: this.alertSettings,
+            useGlobalAlertSettings: this.useGlobalAlertSettings,
+        };
+    }
+}
+exports.CheckGroupV1 = CheckGroupV1;
+//# sourceMappingURL=check-group-v1.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"check-group-v1.js","sourceRoot":"","sources":["../../src/constructs/check-group-v1.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA4B;AAE5B,+BAA2B;AAe3B,mEAAqI;AACrI,6DAAqC;AAErC,2CAA8C;AAC9C,6EAAuE;AACvE,mDAA8C;AAC9C,uDAAiD;AACjD,2CAAuC;AACvC,yDAAmD;AACnD,2FAAoF;AACpF,+BAA2B;AAC3B,uCAAmC;AAEnC,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;AA2ND;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,YAAa,SAAQ,qBAAS;IACzC,IAAI,CAAQ;IACZ,SAAS,CAAU;IACnB,KAAK,CAAU;IACf,WAAW,CAAU;IACrB,SAAS,CAAS;IAClB,SAAS,CAAqB;IAC9B,gBAAgB,CAAmD;IACnE,IAAI,CAAgB;IACpB,WAAW,CAAS;IACpB,SAAS,CAAqB;IAC9B,oBAAoB,CAA6B;IACjD,aAAa,CAAsC;IACnD,gBAAgB,CAAS;IACzB,mBAAmB,CAAS;IAC5B,gBAAgB,CAAuB;IACvC,aAAa,CAAqB;IAClC,eAAe,CAAuB;IACtC,aAAa,CAAgB;IAC7B,WAAW,CAAU;IACrB,aAAa,CAAkB;IAC/B,sBAAsB,CAAU;IAEhC,MAAM,CAAU,aAAa,GAAG,aAAa,CAAA;IAE7C;;;;;;;OAOG;IACH,YAAa,SAAiB,EAAE,KAAwB;QACtD,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QAC5C,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,KAAK,CAAC,SAAS,IAAI,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,KAAK,CAAC,oBAAoB,IAAI,EAAE,CAAA;QAC5D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,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,KAAK,CAAC,aAAa,EAAE,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,KAAK,CAAC,eAAe,EAAE,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;IAES,KAAK,CAAC,gBAAgB,CAAE,WAAwB;QACxD,WAAW,CAAC,GAAG,CAAC,IAAI,qDAA6B,CAC/C,YAAY,EACZ,IAAI,KAAK,CACP,kEAAkE;YAClE,MAAM;YACN,qCAAqC;YACrC,2FAA2F,CAC5F,CACF,CAAC,CAAA;IACJ,CAAC;IAES,KAAK,CAAC,mBAAmB,CAAE,WAAwB;QAC3D,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,WAAW,CAAC,GAAG,CAAC,IAAI,sDAA8B,CAChD,aAAa,EACb,IAAI,KAAK,CAAC,wDAAwD,CAAC,CACpE,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,WAAW,CAAC,GAAG,CAAC,IAAI,oDAA4B,CAC9C,aAAa,EACb,IAAI,KAAK,CACP,6DAA6D;oBAC7D,kCAAkC;oBAClC,MAAM;oBACN,0CAA0C;oBAC1C,sBAAsB;oBACtB,8BAA8B;oBAC9B,gCAAgC;oBAChC,0BAA0B;oBAC1B,MAAM,CACP,CACF,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,GAAG,CAAC,IAAI,oDAA4B,CAC9C,aAAa,EACb,IAAI,KAAK,CACP,8DAA8D;oBAC9D,kCAAkC;oBAClC,MAAM;oBACN,oCAAoC,CACrC,CACF,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,WAAwB;QACtC,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;QAExC,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAA;QAE3C,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9B,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;gBACrC,+FAA+F;gBAC/F,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC;oBACpB,WAAW,CAAC,GAAG,CAAC,IAAI,sDAA8B,CAChD,sBAAsB,EACtB,IAAI,KAAK,CAAC,0BAA0B,CAAC,CACtC,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,WAAW,CAAC,GAAG,CAAC,IAAI,oDAA4B,CAC9C,kBAAkB,EAClB,IAAI,KAAK,CACP,kEAAkE,CACnE,CACF,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,WAAW,CAAC,GAAG,CAAC,IAAI,oDAA4B,CAC9C,qBAAqB,EACrB,IAAI,KAAK,CACP,qEAAqE,CACtE,CACF,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,MAAM,CAAC,MAAM,CAAE,EAAU;QACvB,OAAO,IAAI,+BAAa,CAAC,eAAe,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;IACnD,CAAC;IAEO,WAAW,CACjB,gBAAwB,EACxB,SAA0B,EAC1B,SAAmE;QAEnE,MAAM,MAAM,GAAG,mBAAI,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,mBAAI,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,mBAAI,CAAC,QAAQ,CAAC,iBAAO,CAAC,QAAS,EAAE,QAAQ,CAAC,CAAC,CAAA;YAC9E,IAAI,SAAS,KAAK,mBAAU,CAAC,OAAO,EAAE,CAAC;gBACrC,IAAI,4BAAY,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;YACzC,CAAC;iBAAM,CAAC;gBACN,IAAI,iCAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;YAC3C,CAAC;QACH,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,6DAA6D;YAC7D,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,6DAA6D;YAC7D,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,IAAI,CAAC,aAAa,EAAE,SAAS;SACzC,CAAA;IACH,CAAC;IAEM,yBAAyB;QAC9B,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,eAAe,EAAE,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,IAAI,CAAC,aAAa,EAAE,IAAI,KAAK,YAAY;gBACtD,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAI,CAAC,aAAa;YACtB,8GAA8G;YAC9G,2GAA2G;YAC3G,WAAW,EAAE,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE,IAAI,KAAK,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;;AA7QH,oCA8QC"}

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

@@ -0,0 +1,120 @@
+import { PrivateLocation, PrivateLocationRef } from './private-location';
+import type { Region } from '..';
+import { type RetryStrategy } from './retry-strategy';
+import { AlertEscalation } from './alert-escalation-policy';
+import { Diagnostics } from './diagnostics';
+import { CheckGroupV1, CheckGroupV1Props } from './check-group-v1';
+export interface CheckGroupV2Props extends Omit<CheckGroupV1Props, 'alertEscalationPolicy'> {
+    /**
+     * This property is no longer supported; use {@link retryStrategy} instead.
+     *
+     * To match the behavior of `doubleCheck: true`, use:
+     *
+     *     retryStrategy: RetryStrategyBuilder.fixedStrategy({
+     *       maxRetries: 1,
+     *       baseBackoffSeconds: 0,
+     *       maxDurationSeconds: 600,
+     *       sameRegion: false,
+     *     })
+     *
+     * To match the behavior of `doubleCheck: false`, use:
+     *
+     *     retryStrategy: RetryStrategyBuilder.noRetries()
+     *
+     * @deprecated Use {@link CheckGroupV2Props.retryStrategy} instead.
+     */
+    doubleCheck?: boolean;
+    /**
+     * An array of one or more data center locations where to run the checks.
+     *
+     * If either {@link CheckGroupV2Props.locations} or
+     * {@link CheckGroupV2Props.privateLocations} is set to a non-empty value, all
+     * checks in the group will use those values instead of their own.
+     */
+    locations?: (keyof Region)[];
+    /**
+     * An array of one or more private locations where to run the checks.
+     *
+     * If either {@link CheckGroupV2Props.locations} or
+     * {@link CheckGroupV2Props.privateLocations} is set to a non-empty value, all
+     * checks in the group will use those values instead of their own.
+     */
+    privateLocations?: (string | PrivateLocation | PrivateLocationRef)[];
+    /**
+     * When {@link AlertEscalation}, all checks in the group will use the
+     * group's alert escalation policy. Use {@link AlertEscalationBuilder} to
+     * build a suitable policy.
+     *
+     * When `"global"`, all checks in the group will use the global alert
+     * escalation policy.
+     *
+     * If not set, individual check settings are used.
+     */
+    alertEscalationPolicy?: AlertEscalation | 'global';
+    /**
+     * Sets a retry policy for the group. Use {@link RetryStrategyBuilder} to
+     * create a retry policy.
+     *
+     * If set, all checks in the group use the group's retry strategy.
+     *
+     * If not set, individual check settings are used.
+     */
+    retryStrategy?: RetryStrategy;
+    /**
+     * Determines whether the checks in the group should run on all selected
+     * locations in parallel or round-robin.
+     *
+     * When `true`, all checks in the group run in parallel regardless of their
+     * individual setting.
+     *
+     * When `false`, all checks in the group run in round-robin regardless of
+     * their individual setting.
+     *
+     * If not set, individual check settings are used.
+     *
+     * See https://www.checklyhq.com/docs/monitoring/global-locations/ to learn
+     * more about scheduling strategies.
+     */
+    runParallel?: boolean;
+}
+/**
+ * Creates a Check Group (v2).
+ *
+ * The following properties have changed since CheckGroupV1:
+ *
+ *   - {@link CheckGroupV2Props.alertEscalationPolicy}
+ *     - The implicit default for this property has been removed, allowing
+ *       individual check settings to take effect.
+ *     - Can be set to `"global"` to match the earlier default behavior.
+ *   - {@link CheckGroupV2Props.retryStrategy}
+ *     - The implicit default for this property has been removed, allowing
+ *       individual check settings to take effect.
+ *   - {@link CheckGroupV2Props.runParallel}
+ *     - The implicit default for this property has been removed, allowing
+ *       individual check settings to take effect.
+ */
+export declare class CheckGroupV2 extends CheckGroupV1 {
+    constructor(logicalId: string, props: CheckGroupV2Props);
+    onBeforeValidate(diagnostics: Diagnostics): Promise<void>;
+    protected validateDoubleCheck(diagnostics: Diagnostics): Promise<void>;
+    synthesize(): {
+        doubleCheck: undefined;
+        v: number;
+        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: import("./api-check").ApiCheckDefaultConfig;
+        environmentVariables: import("./key-value-pair").default[] | undefined;
+        retryStrategy: RetryStrategy | null | undefined;
+        runParallel: boolean | undefined;
+        alertSettings: AlertEscalation | undefined;
+        useGlobalAlertSettings: boolean | undefined;
+    };
+}

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

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckGroupV2 = void 0;
+const check_group_v1_1 = require("./check-group-v1");
+const construct_diagnostics_1 = require("./construct-diagnostics");
+/**
+ * Creates a Check Group (v2).
+ *
+ * The following properties have changed since CheckGroupV1:
+ *
+ *   - {@link CheckGroupV2Props.alertEscalationPolicy}
+ *     - The implicit default for this property has been removed, allowing
+ *       individual check settings to take effect.
+ *     - Can be set to `"global"` to match the earlier default behavior.
+ *   - {@link CheckGroupV2Props.retryStrategy}
+ *     - The implicit default for this property has been removed, allowing
+ *       individual check settings to take effect.
+ *   - {@link CheckGroupV2Props.runParallel}
+ *     - The implicit default for this property has been removed, allowing
+ *       individual check settings to take effect.
+ */
+class CheckGroupV2 extends check_group_v1_1.CheckGroupV1 {
+    constructor(logicalId, props) {
+        const { alertEscalationPolicy, useGlobalAlertSettings } = (() => {
+            const { alertEscalationPolicy } = props;
+            // Do we want to always use the global policy?
+            if (alertEscalationPolicy === 'global') {
+                return {
+                    alertEscalationPolicy: undefined,
+                    useGlobalAlertSettings: true,
+                };
+            }
+            // Do we want to let checks keep their own policies?
+            if (alertEscalationPolicy === undefined) {
+                return {
+                    alertEscalationPolicy,
+                    useGlobalAlertSettings: undefined,
+                };
+            }
+            // The group policy will always apply.
+            return {
+                alertEscalationPolicy,
+                useGlobalAlertSettings: false,
+            };
+        })();
+        super(logicalId, {
+            ...props,
+            alertEscalationPolicy,
+        });
+        // Must override; the V1 constructor will not give us the desired behavior.
+        this.useGlobalAlertSettings = useGlobalAlertSettings;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async onBeforeValidate(diagnostics) {
+        // No-op
+    }
+    async validateDoubleCheck(diagnostics) {
+        if (this.doubleCheck !== undefined) {
+            if (this.doubleCheck) {
+                diagnostics.add(new construct_diagnostics_1.RemovedPropertyDiagnostic('doubleCheck', new Error(`To match the behavior of doubleCheck: true, please use the ` +
+                    `following retryStrategy instead:` +
+                    `\n\n` +
+                    `  RetryStrategyBuilder.fixedStrategy({\n` +
+                    `    maxRetries: 1,\n` +
+                    `    baseBackoffSeconds: 0,\n` +
+                    `    maxDurationSeconds: 600,\n` +
+                    `    sameRegion: false,\n` +
+                    `  })`)));
+            }
+            else {
+                diagnostics.add(new construct_diagnostics_1.RemovedPropertyDiagnostic('doubleCheck', new Error(`To match the behavior of doubleCheck: false, please use the ` +
+                    `following retryStrategy instead:` +
+                    `\n\n` +
+                    `  RetryStrategyBuilder.noRetries()`)));
+            }
+        }
+    }
+    synthesize() {
+        return {
+            ...super.synthesize(),
+            doubleCheck: undefined,
+            v: 2,
+        };
+    }
+}
+exports.CheckGroupV2 = CheckGroupV2;
+//# sourceMappingURL=check-group-v2.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"check-group-v2.js","sourceRoot":"","sources":["../../src/constructs/check-group-v2.ts"],"names":[],"mappings":";;;AAaA,qDAAkE;AAClE,mEAAmE;AAiFnE;;;;;;;;;;;;;;;GAeG;AACH,MAAa,YAAa,SAAQ,6BAAY;IAC5C,YAAa,SAAiB,EAAE,KAAwB;QACtD,MAAM,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,GAAG,CAAC,GAAG,EAAE;YAC9D,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,CAAA;YAEvC,8CAA8C;YAC9C,IAAI,qBAAqB,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO;oBACL,qBAAqB,EAAE,SAAS;oBAChC,sBAAsB,EAAE,IAAI;iBAC7B,CAAA;YACH,CAAC;YAED,oDAAoD;YACpD,IAAI,qBAAqB,KAAK,SAAS,EAAE,CAAC;gBACxC,OAAO;oBACL,qBAAqB;oBACrB,sBAAsB,EAAE,SAAS;iBAClC,CAAA;YACH,CAAC;YAED,sCAAsC;YACtC,OAAO;gBACL,qBAAqB;gBACrB,sBAAsB,EAAE,KAAK;aAC9B,CAAA;QACH,CAAC,CAAC,EAAE,CAAA;QAEJ,KAAK,CAAC,SAAS,EAAE;YACf,GAAG,KAAK;YACR,qBAAqB;SACtB,CAAC,CAAA;QAEF,2EAA2E;QAC3E,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAA;IACtD,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,gBAAgB,CAAE,WAAwB;QAC9C,QAAQ;IACV,CAAC;IAES,KAAK,CAAC,mBAAmB,CAAE,WAAwB;QAC3D,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,WAAW,CAAC,GAAG,CAAC,IAAI,iDAAyB,CAC3C,aAAa,EACb,IAAI,KAAK,CACP,6DAA6D;oBAC7D,kCAAkC;oBAClC,MAAM;oBACN,0CAA0C;oBAC1C,sBAAsB;oBACtB,8BAA8B;oBAC9B,gCAAgC;oBAChC,0BAA0B;oBAC1B,MAAM,CACP,CACF,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,GAAG,CAAC,IAAI,iDAAyB,CAC3C,aAAa,EACb,IAAI,KAAK,CACP,8DAA8D;oBAC9D,kCAAkC;oBAClC,MAAM;oBACN,oCAAoC,CACrC,CACF,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,KAAK,CAAC,UAAU,EAAE;YACrB,WAAW,EAAE,SAAS;YACtB,CAAC,EAAE,CAAC;SACL,CAAA;IACH,CAAC;CACF;AAhFD,oCAgFC"}

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

@@ -1,175 +1,4 @@
-import { Construct } from './construct';
-import { AlertChannel, AlertChannelRef } from './alert-channel';
-import { EnvironmentVariable } from './environment-variable';
-import { PrivateLocation, PrivateLocationRef } 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 | PrivateLocationRef>;
-    /**
-     * 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 | AlertChannelRef>;
-    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 reference to an existing Check Group.
- *
- * References link existing resources to a project without managing them.
- */
-export declare class CheckGroupRef extends Construct {
-    constructor(logicalId: string, physicalId: string | number);
-    getCheckDefaults(): CheckConfigDefaults;
-    getBrowserCheckDefaults(): CheckConfigDefaults;
-    getMultiStepCheckDefaults(): CheckConfigDefaults;
-    synthesize(): null;
-}
-/**
- * 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 | PrivateLocationRef>;
-    tags?: Array<string>;
-    concurrency?: number;
-    frequency?: number | Frequency;
-    environmentVariables?: Array<EnvironmentVariable>;
-    alertChannels?: Array<AlertChannel | AlertChannelRef>;
-    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);
-    static fromId(id: number): CheckGroupRef;
-    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 {};
+export * from './check-group-v1';
+export * from './check-group-v2';
+export * from './check-group-ref';
+export { CheckGroupV1 as CheckGroup, CheckGroupV1Props as CheckGroupProps, } from './check-group-v1';