checkly 0.0.0-canary.7166ed8

package/dist/constructs/alert-channel.js

@@ -0,0 +1,103 @@
+import { Construct } from './construct.js';
+import { validatePhysicalIdIsNumeric } from './internal/common-diagnostics.js';
+import { Session } from './session.js';
+/**
+ * Creates a reference to an existing Alert Channel.
+ *
+ * References link existing resources to a project without managing them.
+ *
+ * Use {@link AlertChannel.fromId()} instead of instantiating this class directly.
+ */
+export class AlertChannelRef extends Construct {
+    constructor(logicalId, physicalId) {
+        super(AlertChannel.__checklyType, logicalId, physicalId, false);
+        Session.registerConstruct(this);
+    }
+    describe() {
+        return `AlertChannelRef:${this.logicalId}`;
+    }
+    async validate(diagnostics) {
+        await super.validate(diagnostics);
+        await validatePhysicalIdIsNumeric(diagnostics, 'AlertChannel', this.physicalId);
+    }
+    allowInChecklyConfig() {
+        return true;
+    }
+    synthesize() {
+        return null;
+    }
+}
+/**
+ * Base class for creating alert channels that notify when checks fail or recover.
+ *
+ * Alert channels define how and when to send notifications when monitoring checks
+ * fail, recover, or enter a degraded state. Checkly supports multiple alert channel types
+ * including email, SMS, Slack, webhooks, and third-party integrations.
+ *
+ * **Plan Limitations:**
+ * - **Hobby**: Up to 50 alert channels
+ * - **Trial**: Up to 200 alert channels
+ * - **Pay-as-you-go**: Up to 200 alert channels
+ * - **Contract**: Up to 500 alert channels
+ *
+ * @example
+ * ```typescript
+ * // Email alert channel
+ * const emailAlert = new EmailAlertChannel('team-email', {
+ *   address: 'alerts@example.com',
+ *   sendFailure: true,
+ *   sendRecovery: true,
+ *   sendDegraded: false
+ * })
+ *
+ * // Slack App alert channel with SSL monitoring
+ * const slackAlert = new SlackAppAlertChannel('team-slack', {
+ *   slackChannels: ['#alerts'],
+ *   sslExpiry: true,
+ *   sslExpiryThreshold: 7  // Alert 7 days before SSL expiry
+ * })
+ * ```
+ *
+ * @see {@link https://www.checklyhq.com/docs/communicate/alerts/channels/ | Alert Channels Documentation}
+ */
+export class AlertChannel extends Construct {
+    sendRecovery;
+    sendFailure;
+    sendDegraded;
+    sslExpiry;
+    sslExpiryThreshold;
+    static __checklyType = 'alert-channel';
+    /**
+     * Constructs the Alert Channel instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props alert channel configuration properties
+     */
+    constructor(logicalId, props) {
+        super(AlertChannel.__checklyType, logicalId);
+        this.sendRecovery = props.sendRecovery;
+        this.sendFailure = props.sendFailure;
+        this.sendDegraded = props.sendDegraded;
+        this.sslExpiry = props.sslExpiry;
+        this.sslExpiryThreshold = props.sslExpiryThreshold;
+    }
+    /**
+     * @param id - The numeric ID of the existing alert channel
+     */
+    static fromId(id) {
+        return new AlertChannelRef(`alert-channel-${id}`, id);
+    }
+    allowInChecklyConfig() {
+        return true;
+    }
+    synthesize() {
+        return {
+            sendRecovery: this.sendRecovery,
+            sendFailure: this.sendFailure,
+            sendDegraded: this.sendDegraded,
+            sslExpiry: this.sslExpiry,
+            sslExpiryThreshold: this.sslExpiryThreshold,
+        };
+    }
+}
+//# sourceMappingURL=alert-channel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"alert-channel.js","sourceRoot":"","sources":["../../src/constructs/alert-channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAA;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAmEtC;;;;;;GAMG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C,YAAa,SAAiB,EAAE,UAAkB;QAChD,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,KAAK,CAAC,CAAA;QAC/D,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,QAAQ;QACN,OAAO,mBAAmB,IAAI,CAAC,SAAS,EAAE,CAAA;IAC5C,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,WAAwB;QACtC,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QACjC,MAAM,2BAA2B,CAAC,WAAW,EAAE,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;IACjF,CAAC;IAED,oBAAoB;QAClB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,OAAgB,YAAa,SAAQ,SAAS;IAClD,YAAY,CAAU;IACtB,WAAW,CAAU;IACrB,YAAY,CAAU;IACtB,SAAS,CAAU;IACnB,kBAAkB,CAAS;IAE3B,MAAM,CAAU,aAAa,GAAG,eAAe,CAAA;IAE/C;;;;;OAKG;IACH,YAAa,SAAiB,EAAE,KAAwB;QACtD,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QAC5C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;QACtC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAA;IACpD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAM,CAAE,EAAU;QACvB,OAAO,IAAI,eAAe,CAAC,iBAAiB,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;IACvD,CAAC;IAED,oBAAoB;QAClB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,UAAU;QACR,OAAO;YACL,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;SAC5C,CAAA;IACH,CAAC"}

package/dist/constructs/alert-escalation-policy-codegen.d.ts

@@ -0,0 +1,4 @@
+import { Value, GeneratedFile } from '../sourcegen/index.js';
+import { AlertEscalation } from './alert-escalation-policy.js';
+export type AlertEscalationResource = AlertEscalation;
+export declare function valueForAlertEscalation(genfile: GeneratedFile, escalation: AlertEscalationResource): Value;

package/dist/constructs/alert-escalation-policy-codegen.js

@@ -0,0 +1,55 @@
+import { expr, ident } from '../sourcegen/index.js';
+export function valueForAlertEscalation(genfile, escalation) {
+    genfile.namedImport('AlertEscalationBuilder', 'checkly/constructs');
+    function appendCommonArguments(escalation, builder) {
+        if (escalation.reminders) {
+            const reminders = escalation.reminders;
+            builder.object(builder => {
+                if (reminders.amount !== undefined) {
+                    builder.number('amount', reminders.amount);
+                }
+                if (reminders.interval !== undefined) {
+                    builder.number('interval', reminders.interval);
+                }
+            });
+        }
+        if (escalation.parallelRunFailureThreshold) {
+            const threshold = escalation.parallelRunFailureThreshold;
+            builder.object(builder => {
+                if (threshold.enabled !== undefined) {
+                    builder.boolean('enabled', threshold.enabled);
+                }
+                if (threshold.percentage !== undefined) {
+                    builder.number('percentage', threshold.percentage);
+                }
+            });
+        }
+    }
+    switch (escalation.escalationType) {
+        case 'RUN_BASED':
+            return expr(ident('AlertEscalationBuilder'), builder => {
+                builder.member(ident('runBasedEscalation'));
+                builder.call(builder => {
+                    const threshold = escalation.runBasedEscalation?.failedRunThreshold;
+                    if (threshold !== undefined) {
+                        builder.number(threshold);
+                    }
+                    appendCommonArguments(escalation, builder);
+                });
+            });
+        case 'TIME_BASED':
+            return expr(ident('AlertEscalationBuilder'), builder => {
+                builder.member(ident('timeBasedEscalation'));
+                builder.call(builder => {
+                    const threshold = escalation.timeBasedEscalation?.minutesFailingThreshold;
+                    if (threshold !== undefined) {
+                        builder.number(threshold);
+                    }
+                    appendCommonArguments(escalation, builder);
+                });
+            });
+        default:
+            throw new Error(`Unsupported alert escalation type ${escalation.escalationType}`);
+    }
+}
+//# sourceMappingURL=alert-escalation-policy-codegen.js.map

package/dist/constructs/alert-escalation-policy-codegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alert-escalation-policy-codegen.js","sourceRoot":"","sources":["../../src/constructs/alert-escalation-policy-codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAA+C,MAAM,uBAAuB,CAAA;AAKhG,MAAM,UAAU,uBAAuB,CAAE,OAAsB,EAAE,UAAmC;IAClG,OAAO,CAAC,WAAW,CAAC,wBAAwB,EAAE,oBAAoB,CAAC,CAAA;IAEnE,SAAS,qBAAqB,CAAE,UAAmC,EAAE,OAA8B;QACjG,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;YACzB,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;YACtC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;gBACvB,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;oBACnC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,MAAM,CAAC,CAAA;gBAC5C,CAAC;gBAED,IAAI,SAAS,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBACrC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;gBAChD,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,2BAA2B,EAAE,CAAC;YAC3C,MAAM,SAAS,GAAG,UAAU,CAAC,2BAA2B,CAAA;YACxD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;gBACvB,IAAI,SAAS,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;oBACpC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;gBAC/C,CAAC;gBAED,IAAI,SAAS,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;oBACvC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,UAAU,CAAC,CAAA;gBACpD,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,QAAQ,UAAU,CAAC,cAAc,EAAE,CAAC;QAClC,KAAK,WAAW;YACd,OAAO,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC,EAAE;gBACrD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAA;gBAC3C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;oBACrB,MAAM,SAAS,GAAG,UAAU,CAAC,kBAAkB,EAAE,kBAAkB,CAAA;oBACnE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;wBAC5B,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;oBAC3B,CAAC;oBAED,qBAAqB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;gBAC5C,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,KAAK,YAAY;YACf,OAAO,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC,EAAE;gBACrD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAA;gBAC5C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;oBACrB,MAAM,SAAS,GAAG,UAAU,CAAC,mBAAmB,EAAE,uBAAuB,CAAA;oBACzE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;wBAC5B,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;oBAC3B,CAAC;oBAED,qBAAqB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;gBAC5C,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ;YACE,MAAM,IAAI,KAAK,CAAC,qCAAqC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAA;IACrF,CAAC;AACH,CAAC"}

package/dist/constructs/alert-escalation-policy.d.ts

@@ -0,0 +1,114 @@
+/** Types of alert escalation strategies */
+declare enum AlertEscalationType {
+    RUN = "RUN_BASED",
+    TIME = "TIME_BASED"
+}
+/**
+ * Configuration for alert reminders.
+ * Defines how often to send reminder notifications after initial alert.
+ */
+export type Reminders = {
+    /**
+     * Number of reminder notifications to send (0 to disable, 100000 for unlimited).
+     * @defaultValue 0
+     * @minimum 0
+     * @maximum 5
+     * @enum [0, 1, 2, 3, 4, 5, 100000]
+     * @example 2  // Send 2 reminder notifications
+     * @example 100000  // Send unlimited reminder notifications
+     */
+    amount?: number;
+    /**
+     * Interval between reminder notifications in minutes.
+     * @defaultValue 5
+     * @enum [1, 2, 3, 4, 5, 10, 15, 30]
+     */
+    interval?: number;
+};
+/**
+ * Configuration for parallel run failure threshold.
+ * Determines when to alert based on percentage of failed parallel runs.
+ */
+export type ParallelRunFailureThreshold = {
+    /**
+     * Whether parallel run failure threshold is enabled.
+     * @defaultValue false
+     */
+    enabled?: boolean;
+    /**
+     * Percentage of runs that must fail to trigger alert.
+     * @defaultValue 10
+     * @minimum 10
+     * @maximum 100
+     * @multipleOf 10
+     * @example 30  // Alert when 30% of parallel runs fail
+     */
+    percentage?: number;
+};
+/**
+ * Configuration for alert escalation policies.
+ * Defines when and how to escalate alerts based on check failures.
+ */
+export interface AlertEscalation {
+    /** The type of escalation strategy to use */
+    escalationType?: AlertEscalationType;
+    /** Configuration for run-based escalation */
+    runBasedEscalation?: {
+        /**
+         * Number of consecutive failed runs before escalating.
+         * @defaultValue 1
+         * @minimum 1
+         * @maximum 5
+         * @example 3  // Escalate after 3 consecutive failures
+         */
+        failedRunThreshold?: number;
+    };
+    /** Configuration for time-based escalation */
+    timeBasedEscalation?: {
+        /**
+         * Minutes that check must be failing before escalating.
+         * @defaultValue 5
+         * @enum [5, 10, 15, 30]
+         * @example 10  // Escalate after 10 minutes of continuous failure
+         */
+        minutesFailingThreshold?: number;
+    };
+    /** Configuration for reminder notifications */
+    reminders?: Reminders;
+    /** Configuration for parallel run failure threshold */
+    parallelRunFailureThreshold?: ParallelRunFailureThreshold;
+}
+/**
+ * Options for configuring alert escalation behavior.
+ * These options can be used with any escalation strategy.
+ */
+export type AlertEscalationOptions = Pick<AlertEscalation, 'runBasedEscalation' | 'timeBasedEscalation' | 'reminders' | 'parallelRunFailureThreshold'>;
+/**
+ * Builder class for creating alert escalation policies.
+ * Provides convenient methods to create different types of escalation strategies.
+ *
+ * @example
+ * ```typescript
+ * // Run-based escalation - alert after 3 consecutive failures
+ * const runBased = AlertEscalationBuilder.runBasedEscalation(3, {
+ *   amount: 2,
+ *   interval: 10
+ * })
+ *
+ * // Time-based escalation - alert after 10 minutes of failure
+ * const timeBased = AlertEscalationBuilder.timeBasedEscalation(10, {
+ *   amount: 1,
+ *   interval: 30
+ * })
+ * ```
+ */
+export declare class AlertEscalationBuilder {
+    private static DEFAULT_RUN_BASED_ESCALATION;
+    private static DEFAULT_TIME_BASED_ESCALATION;
+    private static DEFAULT_REMINDERS;
+    private static DEFAULT_PARALLEL_RUN_FAILURE_THRESHOLD;
+    static runBasedEscalation(failedRunThreshold: number, reminders?: Reminders, parallelRunFailureThreshold?: ParallelRunFailureThreshold): AlertEscalation;
+    static timeBasedEscalation(minutesFailingThreshold: number, reminders?: Reminders, parallelRunFailureThreshold?: ParallelRunFailureThreshold): AlertEscalation;
+    private static alertEscalation;
+}
+export {};

package/dist/constructs/alert-escalation-policy.js

@@ -0,0 +1,62 @@
+/** Types of alert escalation strategies */
+// eslint-disable-next-line no-restricted-syntax
+var AlertEscalationType;
+(function (AlertEscalationType) {
+    AlertEscalationType["RUN"] = "RUN_BASED";
+    AlertEscalationType["TIME"] = "TIME_BASED";
+})(AlertEscalationType || (AlertEscalationType = {}));
+/**
+ * Builder class for creating alert escalation policies.
+ * Provides convenient methods to create different types of escalation strategies.
+ *
+ * @example
+ * ```typescript
+ * // Run-based escalation - alert after 3 consecutive failures
+ * const runBased = AlertEscalationBuilder.runBasedEscalation(3, {
+ *   amount: 2,
+ *   interval: 10
+ * })
+ *
+ * // Time-based escalation - alert after 10 minutes of failure
+ * const timeBased = AlertEscalationBuilder.timeBasedEscalation(10, {
+ *   amount: 1,
+ *   interval: 30
+ * })
+ * ```
+ */
+export class AlertEscalationBuilder {
+    static DEFAULT_RUN_BASED_ESCALATION = { failedRunThreshold: 1 };
+    static DEFAULT_TIME_BASED_ESCALATION = { minutesFailingThreshold: 5 };
+    static DEFAULT_REMINDERS = { amount: 0, interval: 5 };
+    static DEFAULT_PARALLEL_RUN_FAILURE_THRESHOLD = { enabled: false, percentage: 10 };
+    static runBasedEscalation(failedRunThreshold, reminders, parallelRunFailureThreshold) {
+        const options = {
+            runBasedEscalation: {
+                failedRunThreshold,
+            },
+            reminders,
+            parallelRunFailureThreshold,
+        };
+        return this.alertEscalation(AlertEscalationType.RUN, options);
+    }
+    static timeBasedEscalation(minutesFailingThreshold, reminders, parallelRunFailureThreshold) {
+        const options = {
+            timeBasedEscalation: {
+                minutesFailingThreshold,
+            },
+            reminders,
+            parallelRunFailureThreshold,
+        };
+        return this.alertEscalation(AlertEscalationType.TIME, options);
+    }
+    static alertEscalation(escalationType, options) {
+        return {
+            escalationType,
+            runBasedEscalation: options.runBasedEscalation ?? this.DEFAULT_RUN_BASED_ESCALATION,
+            timeBasedEscalation: options.timeBasedEscalation ?? this.DEFAULT_TIME_BASED_ESCALATION,
+            reminders: options.reminders ?? this.DEFAULT_REMINDERS,
+            parallelRunFailureThreshold: options.parallelRunFailureThreshold ?? this.DEFAULT_PARALLEL_RUN_FAILURE_THRESHOLD,
+        };
+    }
+}
+//# sourceMappingURL=alert-escalation-policy.js.map

package/dist/constructs/alert-escalation-policy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alert-escalation-policy.js","sourceRoot":"","sources":["../../src/constructs/alert-escalation-policy.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,gDAAgD;AAChD,IAAK,mBAGJ;AAHD,WAAK,mBAAmB;IACtB,wCAAiB,CAAA;IACjB,0CAAmB,CAAA;AACrB,CAAC,EAHI,mBAAmB,KAAnB,mBAAmB,QAGvB;AAwFD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,sBAAsB;IACzB,MAAM,CAAC,4BAA4B,GAAG,EAAE,kBAAkB,EAAE,CAAC,EAAE,CAAA;IAC/D,MAAM,CAAC,6BAA6B,GAAG,EAAE,uBAAuB,EAAE,CAAC,EAAE,CAAA;IACrE,MAAM,CAAC,iBAAiB,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAA;IACrD,MAAM,CAAC,sCAAsC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA;IAE1F,MAAM,CAAC,kBAAkB,CACvB,kBAA0B,EAC1B,SAAqB,EACrB,2BAAyD;QAEzD,MAAM,OAAO,GAA2B;YACtC,kBAAkB,EAAE;gBAClB,kBAAkB;aACnB;YACD,SAAS;YACT,2BAA2B;SAC5B,CAAA;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAC/D,CAAC;IAED,MAAM,CAAC,mBAAmB,CACxB,uBAA+B,EAC/B,SAAqB,EACrB,2BAAyD;QAEzD,MAAM,OAAO,GAA2B;YACtC,mBAAmB,EAAE;gBACnB,uBAAuB;aACxB;YACD,SAAS;YACT,2BAA2B;SAC5B,CAAA;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAChE,CAAC;IAEO,MAAM,CAAC,eAAe,CAAE,cAAmC,EACjE,OAA+B;QAC/B,OAAO;YACL,cAAc;YACd,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,IAAI,CAAC,4BAA4B;YACnF,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,IAAI,IAAI,CAAC,6BAA6B;YACtF,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,iBAAiB;YACtD,2BAA2B,EAAE,OAAO,CAAC,2BAA2B,IAAI,IAAI,CAAC,sCAAsC;SAChH,CAAA;IACH,CAAC"}

package/dist/constructs/api-assertion-codegen.d.ts

@@ -0,0 +1,3 @@
+import { GeneratedFile, Value } from '../sourcegen/index.js';
+import { Assertion } from './api-assertion.js';
+export declare function valueForAssertion(genfile: GeneratedFile, assertion: Assertion): Value;

package/dist/constructs/api-assertion-codegen.js

@@ -0,0 +1,19 @@
+import { valueForGeneralAssertion, valueForNumericAssertion } from './internal/assertion-codegen.js';
+export function valueForAssertion(genfile, assertion) {
+    genfile.namedImport('AssertionBuilder', 'checkly/constructs');
+    switch (assertion.source) {
+        case 'STATUS_CODE':
+            return valueForNumericAssertion('AssertionBuilder', 'statusCode', assertion);
+        case 'JSON_BODY':
+            return valueForGeneralAssertion('AssertionBuilder', 'jsonBody', assertion);
+        case 'HEADERS':
+            return valueForGeneralAssertion('AssertionBuilder', 'headers', assertion);
+        case 'TEXT_BODY':
+            return valueForGeneralAssertion('AssertionBuilder', 'textBody', assertion);
+        case 'RESPONSE_TIME':
+            return valueForNumericAssertion('AssertionBuilder', 'responseTime', assertion);
+        default:
+            throw new Error(`Unsupported assertion source ${assertion.source}`);
+    }
+}
+//# sourceMappingURL=api-assertion-codegen.js.map

package/dist/constructs/api-assertion-codegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-assertion-codegen.js","sourceRoot":"","sources":["../../src/constructs/api-assertion-codegen.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAEpG,MAAM,UAAU,iBAAiB,CAAE,OAAsB,EAAE,SAAoB;IAC7E,OAAO,CAAC,WAAW,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAA;IAE7D,QAAQ,SAAS,CAAC,MAAM,EAAE,CAAC;QACzB,KAAK,aAAa;YAChB,OAAO,wBAAwB,CAAC,kBAAkB,EAAE,YAAY,EAAE,SAAS,CAAC,CAAA;QAC9E,KAAK,WAAW;YACd,OAAO,wBAAwB,CAAC,kBAAkB,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;QAC5E,KAAK,SAAS;YACZ,OAAO,wBAAwB,CAAC,kBAAkB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAA;QAC3E,KAAK,WAAW;YACd,OAAO,wBAAwB,CAAC,kBAAkB,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;QAC5E,KAAK,eAAe;YAClB,OAAO,wBAAwB,CAAC,kBAAkB,EAAE,cAAc,EAAE,SAAS,CAAC,CAAA;QAChF;YACE,MAAM,IAAI,KAAK,CAAC,gCAAgC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAA;IACvE,CAAC;AACH,CAAC"}

package/dist/constructs/api-assertion.d.ts

@@ -0,0 +1,74 @@
+import { Assertion as CoreAssertion, NumericAssertionBuilder, GeneralAssertionBuilder } from './internal/assertion.js';
+/** Sources that can be used for API check assertions */
+type ApiAssertionSource = 'STATUS_CODE' | 'JSON_BODY' | 'HEADERS' | 'TEXT_BODY' | 'RESPONSE_TIME';
+/**
+ * Assertion configuration for API checks.
+ * Allows validation of different aspects of HTTP responses.
+ */
+export type Assertion = CoreAssertion<ApiAssertionSource>;
+/**
+ * Builder class for creating API check assertions.
+ * Provides convenient methods to create assertions for different parts of HTTP responses.
+ *
+ * @example
+ * ```typescript
+ * // Status code assertions
+ * AssertionBuilder.statusCode().equals(200)
+ * AssertionBuilder.statusCode().greaterThan(199)
+ * AssertionBuilder.statusCode().lessThan(300)
+ *
+ * // JSON body assertions using JSONPath
+ * AssertionBuilder.jsonBody('$.user.name').equals('John')
+ * AssertionBuilder.jsonBody('$.users.length').equals(5)
+ * AssertionBuilder.jsonBody('$.data[0].id').isNotNull()
+ *
+ * // Header assertions
+ * AssertionBuilder.headers('content-type').contains('application/json')
+ * AssertionBuilder.headers('x-rate-limit-remaining').greaterThan(0)
+ *
+ * // Text body assertions
+ * AssertionBuilder.textBody().contains('Welcome to our API')
+ * AssertionBuilder.textBody().notContains('error')
+ *
+ * // Response time assertions
+ * AssertionBuilder.responseTime().lessThan(1000)
+ * AssertionBuilder.responseTime().greaterThan(100)
+ * ```
+ *
+ * @see {@link https://jsonpath.com/ | JSONPath Online Evaluator}
+ * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/assertions/ | API Check Assertions}
+ */
+export declare class AssertionBuilder {
+    /**
+     * Creates an assertion builder for HTTP status codes.
+     * @returns A numeric assertion builder for status codes
+     */
+    static statusCode(): NumericAssertionBuilder<ApiAssertionSource, string>;
+    /**
+     * Creates an assertion builder for JSON response body.
+     * @param property Optional JSON path to specific property (e.g., '$.user.name')
+     * @returns A general assertion builder for JSON body content
+     */
+    static jsonBody(property?: string): GeneralAssertionBuilder<ApiAssertionSource>;
+    /**
+     * Creates an assertion builder for HTTP headers.
+     * @param property Optional header name to target specific header
+     * @param regex Optional regex pattern for header matching
+     * @returns A general assertion builder for headers
+     */
+    static headers(property?: string, regex?: string): GeneralAssertionBuilder<ApiAssertionSource>;
+    /**
+     * Creates an assertion builder for text response body.
+     * @param property Optional property path for text content
+     * @returns A general assertion builder for text body content
+     */
+    static textBody(property?: string): GeneralAssertionBuilder<ApiAssertionSource>;
+    /**
+     * Creates an assertion builder for response time.
+     * @returns A numeric assertion builder for response time in milliseconds
+     */
+    static responseTime(): NumericAssertionBuilder<ApiAssertionSource, string>;
+    /** @deprecated Use {@link responseTime()} instead */
+    static responseTme(): NumericAssertionBuilder<ApiAssertionSource, string>;
+}
+export {};

package/dist/constructs/api-assertion.js

@@ -0,0 +1,81 @@
+import { NumericAssertionBuilder, GeneralAssertionBuilder, } from './internal/assertion.js';
+/**
+ * Builder class for creating API check assertions.
+ * Provides convenient methods to create assertions for different parts of HTTP responses.
+ *
+ * @example
+ * ```typescript
+ * // Status code assertions
+ * AssertionBuilder.statusCode().equals(200)
+ * AssertionBuilder.statusCode().greaterThan(199)
+ * AssertionBuilder.statusCode().lessThan(300)
+ *
+ * // JSON body assertions using JSONPath
+ * AssertionBuilder.jsonBody('$.user.name').equals('John')
+ * AssertionBuilder.jsonBody('$.users.length').equals(5)
+ * AssertionBuilder.jsonBody('$.data[0].id').isNotNull()
+ *
+ * // Header assertions
+ * AssertionBuilder.headers('content-type').contains('application/json')
+ * AssertionBuilder.headers('x-rate-limit-remaining').greaterThan(0)
+ *
+ * // Text body assertions
+ * AssertionBuilder.textBody().contains('Welcome to our API')
+ * AssertionBuilder.textBody().notContains('error')
+ *
+ * // Response time assertions
+ * AssertionBuilder.responseTime().lessThan(1000)
+ * AssertionBuilder.responseTime().greaterThan(100)
+ * ```
+ *
+ * @see {@link https://jsonpath.com/ | JSONPath Online Evaluator}
+ * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/assertions/ | API Check Assertions}
+ */
+// Called AssertionBuilder instead of ApiAssertionBuilder for historical
+// reasons.
+export class AssertionBuilder {
+    /**
+     * Creates an assertion builder for HTTP status codes.
+     * @returns A numeric assertion builder for status codes
+     */
+    static statusCode() {
+        return new NumericAssertionBuilder('STATUS_CODE');
+    }
+    /**
+     * Creates an assertion builder for JSON response body.
+     * @param property Optional JSON path to specific property (e.g., '$.user.name')
+     * @returns A general assertion builder for JSON body content
+     */
+    static jsonBody(property) {
+        return new GeneralAssertionBuilder('JSON_BODY', property);
+    }
+    /**
+     * Creates an assertion builder for HTTP headers.
+     * @param property Optional header name to target specific header
+     * @param regex Optional regex pattern for header matching
+     * @returns A general assertion builder for headers
+     */
+    static headers(property, regex) {
+        return new GeneralAssertionBuilder('HEADERS', property, regex);
+    }
+    /**
+     * Creates an assertion builder for text response body.
+     * @param property Optional property path for text content
+     * @returns A general assertion builder for text body content
+     */
+    static textBody(property) {
+        return new GeneralAssertionBuilder('TEXT_BODY', property);
+    }
+    /**
+     * Creates an assertion builder for response time.
+     * @returns A numeric assertion builder for response time in milliseconds
+     */
+    static responseTime() {
+        return new NumericAssertionBuilder('RESPONSE_TIME');
+    }
+    /** @deprecated Use {@link responseTime()} instead */
+    static responseTme() {
+        return AssertionBuilder.responseTime();
+    }
+}
+//# sourceMappingURL=api-assertion.js.map

package/dist/constructs/api-assertion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-assertion.js","sourceRoot":"","sources":["../../src/constructs/api-assertion.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,yBAAyB,CAAA;AAiBhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wEAAwE;AACxE,WAAW;AACX,MAAM,OAAO,gBAAgB;IAC3B;;;OAGG;IACH,MAAM,CAAC,UAAU;QACf,OAAO,IAAI,uBAAuB,CAAqB,aAAa,CAAC,CAAA;IACvE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAE,QAAiB;QAChC,OAAO,IAAI,uBAAuB,CAAqB,WAAW,EAAE,QAAQ,CAAC,CAAA;IAC/E,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAE,QAAiB,EAAE,KAAc;QAC/C,OAAO,IAAI,uBAAuB,CAAqB,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;IACpF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAE,QAAiB;QAChC,OAAO,IAAI,uBAAuB,CAAqB,WAAW,EAAE,QAAQ,CAAC,CAAA;IAC/E,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,YAAY;QACjB,OAAO,IAAI,uBAAuB,CAAqB,eAAe,CAAC,CAAA;IACzE,CAAC;IAED,qDAAqD;IACrD,MAAM,CAAC,WAAW;QAChB,OAAO,gBAAgB,CAAC,YAAY,EAAE,CAAA;IACxC,CAAC;CACF"}

package/dist/constructs/api-check-bundle.d.ts

@@ -0,0 +1,58 @@
+import { ApiCheck } from './api-check.js';
+import { Bundle } from './construct.js';
+import { SharedFileRef } from './session.js';
+export interface ApiCheckBundleProps {
+    localSetupScript?: string;
+    setupScriptPath?: string;
+    setupScriptDependencies?: SharedFileRef[];
+    localTearDownScript?: string;
+    tearDownScriptPath?: string;
+    tearDownScriptDependencies?: SharedFileRef[];
+}
+export declare class ApiCheckBundle implements Bundle {
+    apiCheck: ApiCheck;
+    localSetupScript?: string;
+    setupScriptPath?: string;
+    setupScriptDependencies?: SharedFileRef[];
+    localTearDownScript?: string;
+    tearDownScriptPath?: string;
+    tearDownScriptDependencies?: SharedFileRef[];
+    constructor(apiCheck: ApiCheck, props: ApiCheckBundleProps);
+    synthesize(): {
+        localSetupScript: string | undefined;
+        setupScriptPath: string | undefined;
+        setupScriptDependencies: number[] | undefined;
+        localTearDownScript: string | undefined;
+        tearDownScriptPath: string | undefined;
+        tearDownScriptDependencies: number[] | undefined;
+        checkType: string;
+        request: import("./api-request.js").Request;
+        degradedResponseTime: number | undefined;
+        maxResponseTime: number | undefined;
+        runtimeId: string | undefined;
+        environmentVariables: import("./key-value-pair.js").default[] | undefined;
+        activated: boolean | undefined;
+        muted: boolean | undefined;
+        shouldFail: boolean | undefined;
+        locations: (keyof import("../index.js").Region)[] | undefined;
+        privateLocations: undefined;
+        tags: string[] | undefined;
+        frequency: number | undefined;
+        frequencyOffset: number | undefined;
+        groupId: import("./ref.js").Ref | null;
+        retryStrategy: import("./retry-strategy.js").LinearRetryStrategy | import("./retry-strategy.js").ExponentialRetryStrategy | import("./retry-strategy.js").FixedRetryStrategy | import("./retry-strategy.js").SingleRetryRetryStrategy | null | undefined;
+        doubleCheck: boolean | undefined;
+        alertSettings: import("./alert-escalation-policy.js").AlertEscalation | undefined;
+        useGlobalAlertSettings: boolean | undefined;
+        runParallel: boolean | undefined;
+        triggerIncident: {
+            serviceId: import("./ref.js").Ref;
+            severity: "MINOR" | "MEDIUM" | "MAJOR" | "CRITICAL";
+            name: string;
+            description: string;
+            notifySubscribers: boolean;
+        } | undefined;
+        description?: string | undefined;
+        name: string;
+    };
+}

package/dist/constructs/api-check-bundle.js

@@ -0,0 +1,30 @@
+export class ApiCheckBundle {
+    apiCheck;
+    localSetupScript;
+    setupScriptPath;
+    setupScriptDependencies;
+    localTearDownScript;
+    tearDownScriptPath;
+    tearDownScriptDependencies;
+    constructor(apiCheck, props) {
+        this.apiCheck = apiCheck;
+        this.localSetupScript = props.localSetupScript;
+        this.setupScriptPath = props.setupScriptPath;
+        this.setupScriptDependencies = props.setupScriptDependencies;
+        this.localTearDownScript = props.localTearDownScript;
+        this.tearDownScriptPath = props.tearDownScriptPath;
+        this.tearDownScriptDependencies = props.tearDownScriptDependencies;
+    }
+    synthesize() {
+        return {
+            ...this.apiCheck.synthesize(),
+            localSetupScript: this.localSetupScript,
+            setupScriptPath: this.setupScriptPath,
+            setupScriptDependencies: this.setupScriptDependencies,
+            localTearDownScript: this.localTearDownScript,
+            tearDownScriptPath: this.tearDownScriptPath,
+            tearDownScriptDependencies: this.tearDownScriptDependencies,
+        };
+    }
+}
+//# sourceMappingURL=api-check-bundle.js.map

package/dist/constructs/api-check-bundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-check-bundle.js","sourceRoot":"","sources":["../../src/constructs/api-check-bundle.ts"],"names":[],"mappings":"AAaA,MAAM,OAAO,cAAc;IACzB,QAAQ,CAAU;IAClB,gBAAgB,CAAS;IACzB,eAAe,CAAS;IACxB,uBAAuB,CAAkB;IACzC,mBAAmB,CAAS;IAC5B,kBAAkB,CAAS;IAC3B,0BAA0B,CAAkB;IAE5C,YAAa,QAAkB,EAAE,KAA0B;QACzD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAA;QAC9C,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAA;QAC5C,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAA;QAC5D,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAA;QACpD,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAA;QAClD,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAA;IACpE,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE;YAC7B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;YACrD,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;SAC5D,CAAA;IACH,CAAC;CACF"}

package/dist/constructs/api-check-codegen.d.ts

@@ -0,0 +1,19 @@
+import { Codegen, Context } from './internal/codegen/index.js';
+import { RuntimeCheckResource } from './check-codegen.js';
+import { Request } from './api-request.js';
+export interface ApiCheckResource extends RuntimeCheckResource {
+    checkType: 'API';
+    request: Request;
+    localSetupScript?: string;
+    setupScriptPath?: string;
+    setupSnippetId?: number | null;
+    localTearDownScript?: string;
+    tearDownScriptPath?: string;
+    tearDownSnippetId?: number | null;
+    degradedResponseTime?: number;
+    maxResponseTime?: number;
+}
+export declare class ApiCheckCodegen extends Codegen<ApiCheckResource> {
+    describe(resource: ApiCheckResource): string;
+    gencode(logicalId: string, resource: ApiCheckResource, context: Context): void;
+}