checkly 3.1.1 → 4.0.1

package/dist/constructs/project.d.ts

@@ -0,0 +1,57 @@
+import { CheckConfigDefaults } from '../services/checkly-config-loader';
+import { Construct } from './construct';
+import type { Runtime } from '../rest/runtimes';
+import { Check } from './check';
+import { CheckGroup } from './check-group';
+import { AlertChannel } from './alert-channel';
+import { AlertChannelSubscription } from './alert-channel-subscription';
+import { ResourceSync } from '../rest/projects';
+export interface ProjectProps {
+    /**
+     * Friendly name for your project.
+     */
+    name: string;
+    /**
+     * Git repository URL.
+     */
+    repoUrl?: string;
+}
+export interface ProjectData {
+    check: Record<string, Check>;
+    'check-group': Record<string, CheckGroup>;
+    'alert-channel': Record<string, AlertChannel>;
+    'alert-channel-subscription': Record<string, AlertChannelSubscription>;
+}
+export declare class Project extends Construct {
+    name: string;
+    repoUrl?: string;
+    logicalId: string;
+    data: ProjectData;
+    static readonly __checklyType = "project";
+    /**
+     * Constructs the Project instance
+     *
+     * @param logicalId unique project identifier
+     * @param props project configuration properties
+     */
+    constructor(logicalId: string, props: ProjectProps);
+    addResource(type: string, logicalId: string, resource: Construct): void;
+    synthesize(addTestOnly?: boolean): {
+        project: Pick<Project, 'logicalId' | 'name' | 'repoUrl'>;
+        resources: Array<ResourceSync>;
+    };
+    private synthesizeRecord;
+}
+export declare class Session {
+    static project?: Project;
+    static basePath?: string;
+    static checkDefaults?: CheckConfigDefaults;
+    static browserCheckDefaults?: CheckConfigDefaults;
+    static checkFilePath?: string;
+    static checkFileAbsolutePath?: string;
+    static availableRuntimes: Record<string, Runtime>;
+    static loadingChecklyConfigFile: boolean;
+    static checklyConfigFileConstructs?: Construct[];
+    static registerConstruct(construct: Construct): void;
+    static validateCreateConstruct(construct: Construct): void;
+}

package/dist/constructs/project.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Session = exports.Project = void 0;
+const construct_1 = require("./construct");
+const validator_error_1 = require("./validator-error");
+const check_1 = require("./check");
+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': {},
+        };
+        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']),
+            ],
+        };
+    }
+    synthesizeRecord(record, addTestOnly = true) {
+        return Object.entries(record)
+            .filter(([, construct]) => construct instanceof check_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.`);
+        }
+    }
+}
+exports.Session = Session;
+//# 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":";;;AACA,2CAAuC;AACvC,uDAAmD;AAGnD,mCAA+B;AAwB/B,MAAa,OAAQ,SAAQ,qBAAS;IAapC;;;;;OAKG;IACH,YAAa,SAAiB,EAAE,KAAmB;QACjD,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QAhBzC,SAAI,GAAgB;YAClB,KAAK,EAAE,EAAE;YACT,aAAa,EAAE,EAAE;YACjB,eAAe,EAAE,EAAE;YACnB,4BAA4B,EAAE,EAAE;SACjC,CAAA;QAYC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;YACf,yGAAyG;YACzG,MAAM,IAAI,iCAAe,CAAC,yDAAyD,CAAC,CAAA;SACrF;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;YACnD,MAAM,IAAI,KAAK,CAAC,qBAAqB,IAAI,sBAAsB,SAAS,mBAAmB,CAAC,CAAA;SAC7F;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;aAClE;SACF,CAAA;IACH,CAAC;IAEO,gBAAgB,CAAE,MAA8E,EACtG,WAAW,GAAG,IAAI;QAClB,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;aAC1B,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,YAAY,aAAK,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;;AArEH,0BAsEC;AA3DiB,qBAAa,GAAG,SAAS,CAAA;AA6D3C,MAAa,OAAO;IAWlB,MAAM,CAAC,iBAAiB,CAAE,SAAoB;QAC5C,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;SAC5E;aAAM,IAAI,OAAO,CAAC,wBAAwB,IAAI,SAAS,CAAC,oBAAoB,EAAE,EAAE;YAC/E,OAAO,CAAC,2BAA4B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;SACrD;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,mIAAmI,CAAC,CAAA;SACrJ;IACH,CAAC;IAED,MAAM,CAAC,uBAAuB,CAAE,SAAoB;QAClD,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;YACrD,MAAM,IAAI,iCAAe,CAAC,4FAA4F,SAAS,CAAC,SAAS,IAAI,CAAC,CAAA;SAC/I;QAED,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,aAAa,EAAE;YAC5C,kEAAkE;SACnE;aAAM,IAAI,OAAO,CAAC,OAAO,EAAE;YAC1B,mFAAmF;SACpF;aAAM,IAAI,OAAO,CAAC,wBAAwB,IAAI,SAAS,CAAC,oBAAoB,EAAE,EAAE;YAC/E,0FAA0F;SAC3F;aAAM,IAAI,OAAO,CAAC,wBAAwB,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,cAAc,SAAS,CAAC,WAAW,CAAC,IAAI,wDAAwD,CAAC,CAAA;SAClH;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,iCAAiC,SAAS,CAAC,WAAW,CAAC,IAAI,kCAAkC,CAAC,CAAA;SAC/G;IACH,CAAC;CACF;AAtCD,0BAsCC"}

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/slack-alert-channel.d.ts

@@ -0,0 +1,26 @@
+import { AlertChannel, AlertChannelProps } from './alert-channel';
+export interface SlackAlertChannelProps extends AlertChannelProps {
+    url: URL;
+    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;
+    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/#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/#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,27 @@
+import { AlertChannel, AlertChannelProps } from './alert-channel';
+export interface SmsAlertChannelProps extends AlertChannelProps {
+    /**
+     * The phone number where to send the alert notifications.
+     */
+    phoneNumber: string;
+}
+/**
+ * Creates a SMS Alert Channel
+ *
+ * @remarks
+ *
+ * This class make use of the Alert Channel endpoints.
+ */
+export declare class SmsAlertChannel extends AlertChannel {
+    phoneNumber: 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/#smsalertchannel Read more in the docs}
+     */
+    constructor(logicalId: string, props: SmsAlertChannelProps);
+    synthesize(): any;
+}

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

@@ -0,0 +1,38 @@
+"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/#smsalertchannel Read more in the docs}
+     */
+    constructor(logicalId, props) {
+        super(logicalId, props);
+        this.phoneNumber = props.phoneNumber;
+        project_1.Session.registerConstruct(this);
+    }
+    synthesize() {
+        return {
+            ...super.synthesize(),
+            type: 'SMS',
+            config: {
+                number: this.phoneNumber,
+            },
+        };
+    }
+}
+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;AASnC;;;;;;GAMG;AACH,MAAa,eAAgB,SAAQ,4BAAY;IAE/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,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;aACzB;SACF,CAAA;IACH,CAAC;CACF;AAzBD,0CAyBC"}

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,59 @@
+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;
+    /**
+     * 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>;
+}
+/**
+ * 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;
+    template?: string;
+    method?: HttpRequestMethod;
+    headers?: Array<HttpHeader>;
+    queryParameters?: Array<QueryParam>;
+    /**
+     * 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/#webhookalertchannel Read more in the docs}
+     */
+    constructor(logicalId: string, props: WebhookAlertChannelProps);
+    synthesize(): any;
+}

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

@@ -0,0 +1,50 @@
+"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/#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;
+        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,
+            },
+        };
+    }
+}
+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;AAgCnC;;;;;;GAMG;AACH,MAAa,mBAAoB,SAAQ,4BAAY;IAQnD;;;;;;;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,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;aACtC;SACF,CAAA;IACH,CAAC;CACF;AA3CD,kDA2CC"}

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,4 @@
+import { Help } from '@oclif/core';
+export default class ChecklyHelpClass extends Help {
+    showRootHelp(): Promise<void>;
+}

package/dist/help/help-extension.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const examples_1 = require("./examples");
+class ChecklyHelpClass extends core_1.Help {
+    showRootHelp() {
+        var _a, _b;
+        // start copy & paste from standard showRootHelp implementation
+        let rootTopics = this.sortedTopics;
+        let rootCommands = this.sortedCommands;
+        const state = (_b = (_a = this.config.pjson) === null || _a === void 0 ? void 0 : _a.oclif) === null || _b === void 0 ? void 0 : _b.state;
+        if (state) {
+            this.log(state === 'deprecated'
+                ? `${this.config.bin} is deprecated`
+                : `${this.config.bin} is in ${state}.\n`);
+        }
+        this.log(this.formatRoot());
+        this.log('');
+        if (!this.opts.all) {
+            rootTopics = rootTopics.filter(t => !t.name.includes(':'));
+            rootCommands = rootCommands.filter(c => !c.id.includes(':'));
+        }
+        if (rootTopics.length > 0) {
+            this.log(this.formatTopics(rootTopics));
+            this.log('');
+        }
+        if (rootCommands.length > 0) {
+            rootCommands = rootCommands.filter(c => c.id);
+            this.log(this.formatCommands(rootCommands));
+            this.log('');
+        }
+        // end
+        const examplesString = examples_1.default.reduce((accumulator, example) => {
+            return accumulator + `\n- ${example.description}\n\n${this.indent('$ ' + example.command)}\n`;
+        }, '');
+        this.log(this.section('EXAMPLES', examplesString));
+        return Promise.resolve();
+    }
+}
+exports.default = ChecklyHelpClass;
+//# sourceMappingURL=help-extension.js.map

package/dist/help/help-extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help-extension.js","sourceRoot":"","sources":["../../src/help/help-extension.ts"],"names":[],"mappings":";;AAAA,sCAAkC;AAElC,yCAAiC;AAEjC,MAAqB,gBAAiB,SAAQ,WAAI;IACzC,YAAY;;QACjB,+DAA+D;QAC/D,IAAI,UAAU,GAAG,IAAI,CAAC,YAAY,CAAA;QAClC,IAAI,YAAY,GAAG,IAAI,CAAC,cAAc,CAAA;QAEtC,MAAM,KAAK,GAAG,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,0CAAE,KAAK,0CAAE,KAAK,CAAA;QAC7C,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,GAAG,CACN,KAAK,KAAK,YAAY;gBACpB,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,gBAAgB;gBACpC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,UAAU,KAAK,KAAK,CAC3C,CAAA;SACF;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QAC3B,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QAEZ,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YAClB,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;YAC1D,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;SAC7D;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAA;YACvC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;SACb;QAED,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YAC3B,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;YAC7C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAA;YAC3C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;SACb;QACD,MAAM;QAEN,MAAM,cAAc,GAAG,kBAAQ,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,EAAE;YAC9D,OAAO,WAAW,GAAG,OAAO,OAAO,CAAC,WAAW,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAA;QAC/F,CAAC,EAAE,EAAE,CAAC,CAAA;QAEN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,CAAA;QAClD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC1B,CAAC;CACF;AA1CD,mCA0CC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * as constructs from './constructs';
+export { defineConfig } from './config';
+export type { ChecklyConfig } from './services/checkly-config-loader';

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineConfig = exports.constructs = void 0;
+exports.constructs = require("./constructs");
+var config_1 = require("./config");
+Object.defineProperty(exports, "defineConfig", { enumerable: true, get: function () { return config_1.defineConfig; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAC1C,mCAAuC;AAA9B,sGAAA,YAAY,OAAA"}

package/dist/messages/common-messages.d.ts

@@ -0,0 +1,5 @@
+declare const commonMessages: {
+    forceMode: string;
+    configFile: string;
+};
+export default commonMessages;

package/dist/messages/common-messages.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commonMessages = {
+    forceMode: 'Force mode. Skips the confirmation dialog.',
+    configFile: 'The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current' +
+        ' directory.',
+};
+exports.default = commonMessages;
+//# sourceMappingURL=common-messages.js.map

package/dist/messages/common-messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-messages.js","sourceRoot":"","sources":["../../src/messages/common-messages.ts"],"names":[],"mappings":";;AAAA,MAAM,cAAc,GAAG;IACrB,SAAS,EAAE,4CAA4C;IACvD,UAAU,EAAE,sGAAsG;QAC9G,aAAa;CAClB,CAAA;AAED,kBAAe,cAAc,CAAA"}

package/dist/reporters/abstract-list.d.ts

@@ -0,0 +1,34 @@
+import { Reporter } from './reporter';
+import type { RunLocation, CheckRunId } from '../services/abstract-check-runner';
+import { Check } from '../constructs/check';
+export type checkFilesMap = Map<string | undefined, Map<CheckRunId, {
+    check?: Check;
+    result?: any;
+    titleString: string;
+    testResultId?: string;
+}>>;
+export default abstract class AbstractListReporter implements Reporter {
+    _clearString: string;
+    runLocation: RunLocation;
+    checkFilesMap?: checkFilesMap;
+    numChecks?: number;
+    verbose: boolean;
+    testSessionId?: string;
+    constructor(runLocation: RunLocation, verbose: boolean);
+    abstract onBeginStatic(): void;
+    onBegin(checks: Array<{
+        check: any;
+        checkRunId: CheckRunId;
+        testResultId?: string;
+    }>, testSessionId?: string): void;
+    abstract onEnd(): void;
+    onCheckEnd(checkRunId: CheckRunId, checkResult: any): void;
+    onError(err: Error): void;
+    _clearSummary(): void;
+    _printSummary(opts?: {
+        skipCheckCount?: boolean;
+    }): void;
+    _printBriefSummary(): void;
+    _printTestSessionsUrl(): void;
+    _runLocationString(): string;
+}