checkly 0.0.0-pr.1006.2fb1ffc

package/dist/constructs/project.js

@@ -0,0 +1,155 @@
+"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.Session = exports.Project = void 0;
+const api = __importStar(require("../rest/api"));
+const construct_1 = require("./construct");
+const validator_error_1 = require("./validator-error");
+const _1 = require("./");
+class Project extends construct_1.Construct {
+    /**
+     * Constructs the Project instance
+     *
+     * @param logicalId unique project identifier
+     * @param props project configuration properties
+     */
+    constructor(logicalId, props) {
+        super(Project.__checklyType, logicalId);
+        this.data = {
+            check: {},
+            'check-group': {},
+            'alert-channel': {},
+            'alert-channel-subscription': {},
+            'maintenance-window': {},
+            'private-location': {},
+            'private-location-check-assignment': {},
+            'private-location-group-assignment': {},
+            dashboard: {},
+        };
+        if (!props.name) {
+            // TODO: Can we collect a list of validation errors and return them all at once? This might be better UX.
+            throw new validator_error_1.ValidationError('Please give your project a name in the "name" property.');
+        }
+        this.name = props.name;
+        this.repoUrl = props.repoUrl;
+        this.logicalId = logicalId;
+    }
+    addResource(type, logicalId, resource) {
+        if (this.data[type][logicalId]) {
+            throw new Error(`Resource of type '${type}' with logical id '${logicalId}' already exists.`);
+        }
+        this.data[type][logicalId] = resource;
+    }
+    synthesize(addTestOnly = true) {
+        const project = {
+            logicalId: this.logicalId,
+            name: this.name,
+            repoUrl: this.repoUrl,
+        };
+        return {
+            project,
+            resources: [
+                ...this.synthesizeRecord(this.data.check, addTestOnly),
+                ...this.synthesizeRecord(this.data['check-group']),
+                ...this.synthesizeRecord(this.data['alert-channel']),
+                ...this.synthesizeRecord(this.data['alert-channel-subscription']),
+                ...this.synthesizeRecord(this.data['maintenance-window']),
+                ...this.synthesizeRecord(this.data['private-location']),
+                ...this.synthesizeRecord(this.data['private-location-check-assignment']),
+                ...this.synthesizeRecord(this.data['private-location-group-assignment']),
+                ...this.synthesizeRecord(this.data.dashboard),
+            ],
+        };
+    }
+    getTestOnlyConstructs() {
+        return Object
+            .values(this.data)
+            .flatMap((record) => Object
+            .values(record)
+            .filter((construct) => construct instanceof _1.Check && construct.testOnly));
+    }
+    getHeartbeatLogicalIds() {
+        return Object
+            .values(this.data.check)
+            .filter((construct) => construct instanceof _1.HeartbeatCheck)
+            .map((construct) => construct.logicalId);
+    }
+    synthesizeRecord(record, addTestOnly = true) {
+        return Object.entries(record)
+            .filter(([, construct]) => construct instanceof _1.Check ? !construct.testOnly || addTestOnly : true)
+            .map(([key, construct]) => ({
+            logicalId: key,
+            type: construct.type,
+            physicalId: construct.physicalId,
+            member: construct.member,
+            payload: construct.synthesize(),
+        }));
+    }
+}
+exports.Project = Project;
+Project.__checklyType = 'project';
+class Session {
+    static registerConstruct(construct) {
+        if (Session.project) {
+            Session.project.addResource(construct.type, construct.logicalId, construct);
+        }
+        else if (Session.loadingChecklyConfigFile && construct.allowInChecklyConfig()) {
+            Session.checklyConfigFileConstructs.push(construct);
+        }
+        else {
+            throw new Error('Internal Error: Session is not properly configured for using a construct. Please contact Checkly support on support@checklyhq.com');
+        }
+    }
+    static validateCreateConstruct(construct) {
+        if (!/^[A-Za-z0-9_\-/#.]+$/.test(construct.logicalId)) {
+            throw new validator_error_1.ValidationError(`The "logicalId" can only include the following characters: [A-Za-z0-9_-/#.]. (logicalId='${construct.logicalId}')`);
+        }
+        if (construct.type === Project.__checklyType) {
+            // Creating the construct is allowed - We're creating the project.
+        }
+        else if (Session.project) {
+            // Creating the construct is allowed - We're in the process of parsing the project.
+        }
+        else if (Session.loadingChecklyConfigFile && construct.allowInChecklyConfig()) {
+            // Creating the construct is allowed - We're in the process of parsing the Checkly config.
+        }
+        else if (Session.loadingChecklyConfigFile) {
+            throw new Error(`Creating a ${construct.constructor.name} construct in the Checkly config file isn't supported.`);
+        }
+        else {
+            throw new Error(`Unable to create a construct '${construct.constructor.name}' outside a Checkly CLI project.`);
+        }
+    }
+    static async getPrivateLocations() {
+        if (!Session.privateLocations) {
+            const { data: privateLocations } = await api.privateLocations.getAll();
+            Session.privateLocations = privateLocations;
+        }
+        return Session.privateLocations;
+    }
+}
+exports.Session = Session;
+Session.verifyRuntimeDependencies = true;
+//# sourceMappingURL=project.js.map

package/dist/constructs/project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.js","sourceRoot":"","sources":["../../src/constructs/project.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAkC;AAElC,2CAAuC;AACvC,uDAAmD;AAGnD,yBAGW;AA2BX,MAAa,OAAQ,SAAQ,qBAAS;IAkBpC;;;;;OAKG;IACH,YAAa,SAAiB,EAAE,KAAmB;QACjD,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QArBzC,SAAI,GAAgB;YAClB,KAAK,EAAE,EAAE;YACT,aAAa,EAAE,EAAE;YACjB,eAAe,EAAE,EAAE;YACnB,4BAA4B,EAAE,EAAE;YAChC,oBAAoB,EAAE,EAAE;YACxB,kBAAkB,EAAE,EAAE;YACtB,mCAAmC,EAAE,EAAE;YACvC,mCAAmC,EAAE,EAAE;YACvC,SAAS,EAAE,EAAE;SACd,CAAA;QAYC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAChB,yGAAyG;YACzG,MAAM,IAAI,iCAAe,CAAC,yDAAyD,CAAC,CAAA;QACtF,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED,WAAW,CAAE,IAAY,EAAE,SAAiB,EAAE,QAAmB;QAC/D,IAAI,IAAI,CAAC,IAAI,CAAC,IAAyB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,qBAAqB,IAAI,sBAAsB,SAAS,mBAAmB,CAAC,CAAA;QAC9F,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,IAAyB,CAAC,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAA;IAC5D,CAAC;IAED,UAAU,CAAE,WAAW,GAAG,IAAI;QAI5B,MAAM,OAAO,GAAG;YACd,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;QACD,OAAO;YACL,OAAO;YACP,SAAS,EAAE;gBACT,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC;gBACtD,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAClD,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBACpD,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;gBACjE,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;gBACzD,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBACvD,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBACxE,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBACxE,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;aAC9C;SACF,CAAA;IACH,CAAC;IAED,qBAAqB;QACnB,OAAO,MAAM;aACV,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;aACjB,OAAO,CAAC,CAAC,MAAiC,EAAE,EAAE,CAC7C,MAAM;aACH,MAAM,CAAC,MAAM,CAAC;aACd,MAAM,CAAC,CAAC,SAAoB,EAAE,EAAE,CAAC,SAAS,YAAY,QAAK,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC5F,CAAC;IAED,sBAAsB;QACpB,OAAO,MAAM;aACV,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;aACvB,MAAM,CAAC,CAAC,SAAoB,EAAE,EAAE,CAAC,SAAS,YAAY,iBAAc,CAAC;aACrE,GAAG,CAAC,CAAC,SAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;IACnD,CAAC;IAEO,gBAAgB,CAAE,MAEsD,EAAE,WAAW,GAAG,IAAI;QAClG,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;aAC1B,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,YAAY,QAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,IAAI,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;aACjG,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;YAC1B,SAAS,EAAE,GAAG;YACd,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,UAAU,EAAE,SAAS,CAAC,UAAU;YAChC,MAAM,EAAE,SAAS,CAAC,MAAM;YACxB,OAAO,EAAE,SAAS,CAAC,UAAU,EAAE;SAChC,CAAC,CAAC,CAAA;IACP,CAAC;;AAhGH,0BAiGC;AAjFiB,qBAAa,GAAG,SAAS,AAAZ,CAAY;AAmF3C,MAAa,OAAO;IAclB,MAAM,CAAC,iBAAiB,CAAE,SAAoB;QAC5C,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;QAC7E,CAAC;aAAM,IAAI,OAAO,CAAC,wBAAwB,IAAI,SAAS,CAAC,oBAAoB,EAAE,EAAE,CAAC;YAChF,OAAO,CAAC,2BAA4B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mIAAmI,CAAC,CAAA;QACtJ,CAAC;IACH,CAAC;IAED,MAAM,CAAC,uBAAuB,CAAE,SAAoB;QAClD,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,iCAAe,CAAC,4FAA4F,SAAS,CAAC,SAAS,IAAI,CAAC,CAAA;QAChJ,CAAC;QAED,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC;YAC7C,kEAAkE;QACpE,CAAC;aAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YAC3B,mFAAmF;QACrF,CAAC;aAAM,IAAI,OAAO,CAAC,wBAAwB,IAAI,SAAS,CAAC,oBAAoB,EAAE,EAAE,CAAC;YAChF,0FAA0F;QAC5F,CAAC;aAAM,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,cAAc,SAAS,CAAC,WAAW,CAAC,IAAI,wDAAwD,CAAC,CAAA;QACnH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,iCAAiC,SAAS,CAAC,WAAW,CAAC,IAAI,kCAAkC,CAAC,CAAA;QAChH,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,mBAAmB;QAC9B,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC9B,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,MAAM,GAAG,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAA;YACtE,OAAO,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QAC7C,CAAC;QACD,OAAO,OAAO,CAAC,gBAAgB,CAAA;IACjC,CAAC;;AAhDH,0BAiDC;AAxCQ,iCAAyB,GAAG,IAAI,CAAA"}

package/dist/constructs/query-param.d.ts

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

package/dist/constructs/query-param.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=query-param.js.map

package/dist/constructs/query-param.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-param.js","sourceRoot":"","sources":["../../src/constructs/query-param.ts"],"names":[],"mappings":""}

package/dist/constructs/ref.d.ts

@@ -0,0 +1,5 @@
+export declare class Ref {
+    ref: string;
+    private constructor();
+    static from(ref: string): Ref;
+}

package/dist/constructs/ref.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ref = void 0;
+class Ref {
+    constructor(ref) {
+        this.ref = ref;
+    }
+    static from(ref) {
+        return new Ref(ref);
+    }
+}
+exports.Ref = Ref;
+//# sourceMappingURL=ref.js.map

package/dist/constructs/ref.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ref.js","sourceRoot":"","sources":["../../src/constructs/ref.ts"],"names":[],"mappings":";;;AAAA,MAAa,GAAG;IAEd,YAAqB,GAAW;QAC9B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM,CAAC,IAAI,CAAE,GAAW;QACtB,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;IACrB,CAAC;CACF;AATD,kBASC"}

package/dist/constructs/retry-strategy.d.ts

@@ -0,0 +1,50 @@
+export type RetryStrategyType = 'LINEAR' | 'EXPONENTIAL' | 'FIXED' | 'NO_RETRIES';
+export interface RetryStrategy {
+    type: RetryStrategyType;
+    /**
+    * The number of seconds to wait before the first retry attempt.
+    */
+    baseBackoffSeconds?: number;
+    /**
+    * The maximum number of attempts to retry the check. Value must be between 1 and 10.
+    */
+    maxRetries?: number;
+    /**
+    * The total amount of time to continue retrying the check (maximum 600 seconds).
+    */
+    maxDurationSeconds?: number;
+    /**
+    * Whether retries should be run in the same region as the initial check run.
+    */
+    sameRegion?: boolean;
+}
+export type RetryStrategyOptions = Pick<RetryStrategy, 'baseBackoffSeconds' | 'maxRetries' | 'maxDurationSeconds' | 'sameRegion'>;
+export declare class RetryStrategyBuilder {
+    private static readonly DEFAULT_BASE_BACKOFF_SECONDS;
+    private static readonly DEFAULT_MAX_RETRIES;
+    private static readonly DEFAULT_MAX_DURATION_SECONDS;
+    private static readonly DEFAULT_SAME_REGION;
+    /**
+     * Each retry is run with the same backoff between attempts.
+     */
+    static fixedStrategy(options?: RetryStrategyOptions): RetryStrategy;
+    /**
+     * The delay between retries increases linearly
+     *
+     * The delay between retries is calculated using `baseBackoffSeconds * attempt`.
+     * For example, retries will be run with a backoff of 10s, 20s, 30s, and so on.
+     */
+    static linearStrategy(options?: RetryStrategyOptions): RetryStrategy;
+    /**
+     * The delay between retries increases exponentially
+     *
+     * The delay between retries is calculated using `baseBackoffSeconds ^ attempt`.
+     * For example, retries will be run with a backoff of 10s, 100s, 1000s, and so on.
+     */
+    static exponentialStrategy(options?: RetryStrategyOptions): RetryStrategy;
+    /**
+     * No retries are performed.
+     */
+    static noRetries(): RetryStrategy;
+    private static retryStrategy;
+}

package/dist/constructs/retry-strategy.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RetryStrategyBuilder = void 0;
+class RetryStrategyBuilder {
+    /**
+     * Each retry is run with the same backoff between attempts.
+     */
+    static fixedStrategy(options) {
+        return RetryStrategyBuilder.retryStrategy('FIXED', options);
+    }
+    /**
+     * The delay between retries increases linearly
+     *
+     * The delay between retries is calculated using `baseBackoffSeconds * attempt`.
+     * For example, retries will be run with a backoff of 10s, 20s, 30s, and so on.
+     */
+    static linearStrategy(options) {
+        return RetryStrategyBuilder.retryStrategy('LINEAR', options);
+    }
+    /**
+     * The delay between retries increases exponentially
+     *
+     * The delay between retries is calculated using `baseBackoffSeconds ^ attempt`.
+     * For example, retries will be run with a backoff of 10s, 100s, 1000s, and so on.
+     */
+    static exponentialStrategy(options) {
+        return RetryStrategyBuilder.retryStrategy('EXPONENTIAL', options);
+    }
+    /**
+     * No retries are performed.
+     */
+    static noRetries() {
+        return RetryStrategyBuilder.retryStrategy('NO_RETRIES');
+    }
+    static retryStrategy(type, options) {
+        var _a, _b, _c, _d;
+        return {
+            type,
+            baseBackoffSeconds: (_a = options === null || options === void 0 ? void 0 : options.baseBackoffSeconds) !== null && _a !== void 0 ? _a : RetryStrategyBuilder.DEFAULT_BASE_BACKOFF_SECONDS,
+            maxRetries: (_b = options === null || options === void 0 ? void 0 : options.maxRetries) !== null && _b !== void 0 ? _b : RetryStrategyBuilder.DEFAULT_MAX_RETRIES,
+            maxDurationSeconds: (_c = options === null || options === void 0 ? void 0 : options.maxDurationSeconds) !== null && _c !== void 0 ? _c : RetryStrategyBuilder.DEFAULT_MAX_DURATION_SECONDS,
+            sameRegion: (_d = options === null || options === void 0 ? void 0 : options.sameRegion) !== null && _d !== void 0 ? _d : RetryStrategyBuilder.DEFAULT_SAME_REGION,
+        };
+    }
+}
+exports.RetryStrategyBuilder = RetryStrategyBuilder;
+RetryStrategyBuilder.DEFAULT_BASE_BACKOFF_SECONDS = 60;
+RetryStrategyBuilder.DEFAULT_MAX_RETRIES = 2;
+RetryStrategyBuilder.DEFAULT_MAX_DURATION_SECONDS = 60 * 10;
+RetryStrategyBuilder.DEFAULT_SAME_REGION = true;
+//# sourceMappingURL=retry-strategy.js.map

package/dist/constructs/retry-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry-strategy.js","sourceRoot":"","sources":["../../src/constructs/retry-strategy.ts"],"names":[],"mappings":";;;AAwBA,MAAa,oBAAoB;IAM/B;;OAEG;IACH,MAAM,CAAC,aAAa,CAAE,OAA8B;QAClD,OAAO,oBAAoB,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAE,OAA8B;QACnD,OAAO,oBAAoB,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAE,OAA8B;QACxD,OAAO,oBAAoB,CAAC,aAAa,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IACnE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAS;QACd,OAAO,oBAAoB,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;IACzD,CAAC;IAEO,MAAM,CAAC,aAAa,CAAE,IAAuB,EAAE,OAA8B;;QACnF,OAAO;YACL,IAAI;YACJ,kBAAkB,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB,mCAAI,oBAAoB,CAAC,4BAA4B;YACpG,UAAU,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,mCAAI,oBAAoB,CAAC,mBAAmB;YAC3E,kBAAkB,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB,mCAAI,oBAAoB,CAAC,4BAA4B;YACpG,UAAU,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,mCAAI,oBAAoB,CAAC,mBAAmB;SAC5E,CAAA;IACH,CAAC;;AAhDH,oDAiDC;AAhDyB,iDAA4B,GAAG,EAAE,CAAA;AACjC,wCAAmB,GAAG,CAAC,CAAA;AACvB,iDAA4B,GAAG,EAAE,GAAG,EAAE,CAAA;AACtC,wCAAmB,GAAG,IAAI,CAAA"}

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

@@ -0,0 +1,26 @@
+import { AlertChannel, AlertChannelProps } from './alert-channel';
+export interface SlackAlertChannelProps extends AlertChannelProps {
+    url: URL | string;
+    channel?: string;
+}
+/**
+ * Creates an Slack Alert Channel
+ *
+ * @remarks
+ *
+ * This class make use of the Alert Channel endpoints.
+ */
+export declare class SlackAlertChannel extends AlertChannel {
+    url: URL | string;
+    channel?: string;
+    /**
+     * Constructs the Slack Alert Channel instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props Slack alert channel configuration properties
+     *
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#slackalertchannel Read more in the docs}
+     */
+    constructor(logicalId: string, props: SlackAlertChannelProps);
+    synthesize(): any;
+}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"slack-alert-channel.js","sourceRoot":"","sources":["../../src/constructs/slack-alert-channel.ts"],"names":[],"mappings":";;;AAAA,mDAAiE;AACjE,uCAAmC;AAOnC;;;;;;GAMG;AACH,MAAa,iBAAkB,SAAQ,4BAAY;IAGjD;;;;;;;OAOG;IACH,YAAa,SAAiB,EAAE,KAA6B;QAC3D,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACvB,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAA;QACpB,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,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB;SACF,CAAA;IACH,CAAC;CACF;AA5BD,8CA4BC"}

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

@@ -0,0 +1,32 @@
+import { AlertChannel, AlertChannelProps } from './alert-channel';
+export interface SmsAlertChannelProps extends AlertChannelProps {
+    /**
+     * The phone number where to send the alert notifications.
+     */
+    phoneNumber: string;
+    /**
+     * The name of the alert channel.
+     */
+    name?: string;
+}
+/**
+ * Creates a SMS Alert Channel
+ *
+ * @remarks
+ *
+ * This class make use of the Alert Channel endpoints.
+ */
+export declare class SmsAlertChannel extends AlertChannel {
+    phoneNumber: string;
+    name?: string;
+    /**
+     * Constructs the SMS Alert Channel instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props SMS alert channel configuration properties
+     *
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#smsalertchannel Read more in the docs}
+     */
+    constructor(logicalId: string, props: SmsAlertChannelProps);
+    synthesize(): any;
+}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"sms-alert-channel.js","sourceRoot":"","sources":["../../src/constructs/sms-alert-channel.ts"],"names":[],"mappings":";;;AAAA,mDAAiE;AACjE,uCAAmC;AAanC;;;;;;GAMG;AACH,MAAa,eAAgB,SAAQ,4BAAY;IAG/C;;;;;;;OAOG;IACH,YAAa,SAAiB,EAAE,KAA2B;QACzD,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACvB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,iBAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,KAAK,CAAC,UAAU,EAAE;YACrB,IAAI,EAAE,KAAK;YACX,MAAM,EAAE;gBACN,MAAM,EAAE,IAAI,CAAC,WAAW;gBACxB,IAAI,EAAE,IAAI,CAAC,IAAI;aAChB;SACF,CAAA;IACH,CAAC;CACF;AA5BD,0CA4BC"}

package/dist/constructs/validator-error.d.ts

@@ -0,0 +1,2 @@
+export declare class ValidationError extends Error {
+}

package/dist/constructs/validator-error.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationError = void 0;
+class ValidationError extends Error {
+}
+exports.ValidationError = ValidationError;
+//# sourceMappingURL=validator-error.js.map

package/dist/constructs/validator-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator-error.js","sourceRoot":"","sources":["../../src/constructs/validator-error.ts"],"names":[],"mappings":";;;AAAA,MAAa,eAAgB,SAAQ,KAAK;CAAG;AAA7C,0CAA6C"}

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

@@ -0,0 +1,67 @@
+import { AlertChannel, AlertChannelProps } from './alert-channel';
+import { HttpHeader } from './http-header';
+import { HttpRequestMethod } from './api-check';
+import { QueryParam } from './query-param';
+export interface WebhookAlertChannelProps extends AlertChannelProps {
+    /**
+     * Friendly name to recognise the integration.
+     */
+    name: string;
+    webhookType?: string;
+    /**
+     * The URL where to send the webhook HTTP request.
+     */
+    url: URL | string;
+    /**
+     * This is commonly a JSON body. You can
+     * use {@link https://www.checklyhq.com/docs/alerting/webhooks/#using-variables Handlebars-style template variables}
+     * to add custom data to the template.
+     */
+    template?: string;
+    /**
+     * Either `GET`, `POST`, `PUT`, `PATCH`, `HEAD`, `DELETE` or 'OPTIONS' just like an API check.
+     */
+    method?: HttpRequestMethod;
+    /**
+     * Key-value elements array with the headers to send in the webhook HTTP request.
+     */
+    headers?: Array<HttpHeader>;
+    /**
+     * Key-value elements array with the query parameters to include in the URL for the webhook HTTP request.
+     */
+    queryParameters?: Array<QueryParam>;
+    /**
+     * An optional value to use as the
+     * {@link https://www.checklyhq.com/docs/alerting-and-retries/webhooks/#webhook-secrets secret for the webhook}.
+     *
+     * You may specify any value that meets your security criteria.
+     */
+    webhookSecret?: string;
+}
+/**
+ * Creates an Webhook Alert Channel
+ *
+ * @remarks
+ *
+ * This class make use of the Alert Channel endpoints.
+ */
+export declare class WebhookAlertChannel extends AlertChannel {
+    name: string;
+    webhookType?: string;
+    url: URL | string;
+    template?: string;
+    method?: HttpRequestMethod;
+    headers?: Array<HttpHeader>;
+    queryParameters?: Array<QueryParam>;
+    webhookSecret?: string;
+    /**
+     * Constructs the Webhook Alert Channel instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props Webhook alert channel configuration properties
+     *
+     * {@link https://checklyhq.com/docs/cli/constructs-reference/#webhookalertchannel Read more in the docs}
+     */
+    constructor(logicalId: string, props: WebhookAlertChannelProps);
+    synthesize(): any;
+}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-alert-channel.js","sourceRoot":"","sources":["../../src/constructs/webhook-alert-channel.ts"],"names":[],"mappings":";;;AAAA,mDAAiE;AAIjE,uCAAmC;AAuCnC;;;;;;GAMG;AACH,MAAa,mBAAoB,SAAQ,4BAAY;IASnD;;;;;;;OAOG;IACH,YAAa,SAAiB,EAAE,KAA+B;QAC7D,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAC1B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAA;QAC5C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;QACxC,iBAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,KAAK,CAAC,UAAU,EAAE;YACrB,IAAI,EAAE,SAAS;YACf,MAAM,EAAE;gBACN,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,aAAa,EAAE,IAAI,CAAC,aAAa;aAClC;SACF,CAAA;IACH,CAAC;CACF;AA9CD,kDA8CC"}

package/dist/help/examples.d.ts

@@ -0,0 +1,6 @@
+type Example = {
+    description: string;
+    command: string;
+};
+declare const examples: Array<Example>;
+export default examples;

package/dist/help/examples.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const examples = [
+    {
+        description: 'Test your checks on Checkly with full logging.',
+        command: 'npx checkly test -v',
+    },
+    {
+        description: 'Pass environment variables to your checks.',
+        command: 'npx checkly test -e SECRET=my-password',
+    },
+    {
+        description: 'Record your test session in Checkly with logs, traces and videos.',
+        command: 'npx checkly test --record',
+    },
+    {
+        description: 'Deploy your project to your Checkly account.',
+        command: 'npx checkly deploy',
+    },
+];
+exports.default = examples;
+//# sourceMappingURL=examples.js.map

package/dist/help/examples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"examples.js","sourceRoot":"","sources":["../../src/help/examples.ts"],"names":[],"mappings":";;AAKA,MAAM,QAAQ,GAAmB;IAC/B;QACE,WAAW,EAAE,gDAAgD;QAC7D,OAAO,EAAE,qBAAqB;KAC/B;IACD;QACE,WAAW,EAAE,4CAA4C;QACzD,OAAO,EAAE,wCAAwC;KAClD;IACD;QACE,WAAW,EAAE,mEAAmE;QAChF,OAAO,EAAE,2BAA2B;KACrC;IACD;QACE,WAAW,EAAE,8CAA8C;QAC3D,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AACD,kBAAe,QAAQ,CAAA"}

package/dist/help/help-extension.d.ts

@@ -0,0 +1,7 @@
+import { Command, Help } from '@oclif/core';
+import { BaseCommandClass } from '../commands/baseCommand';
+import { Topic } from '@oclif/core/lib/interfaces';
+export default class ChecklyHelpClass extends Help {
+    protected formatAllCommands(commands: Array<BaseCommandClass | Command.Loadable | Command.Cached>, topics: Array<Topic>): string;
+    showRootHelp(): Promise<void>;
+}