checkly 0.0.0-canary.7b9cf29

package/dist/constructs/http-header.d.ts

@@ -0,0 +1,18 @@
+import KeyValuePair from './key-value-pair.js';
+/**
+ * Represents an HTTP header for API checks.
+ *
+ * @example
+ * ```typescript
+ * const authHeader: HttpHeader = {
+ *   key: 'Authorization',
+ *   value: 'Bearer {{API_TOKEN}}'
+ * }
+ *
+ * const contentTypeHeader: HttpHeader = {
+ *   key: 'Content-Type',
+ *   value: 'application/json'
+ * }
+ * ```
+ */
+export type HttpHeader = KeyValuePair;

package/dist/constructs/http-header.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=http-header.js.map

package/dist/constructs/http-header.js.map

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

package/dist/constructs/http-request.d.ts

@@ -0,0 +1,2 @@
+/** HTTP request methods supported by API checks */
+export type HttpRequestMethod = 'get' | 'GET' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'head' | 'HEAD' | 'delete' | 'DELETE' | 'options' | 'OPTIONS';

package/dist/constructs/http-request.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=http-request.js.map

package/dist/constructs/http-request.js.map

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

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

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

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

@@ -0,0 +1,18 @@
+import { valueForGeneralAssertion, valueForNumericAssertion } from './internal/assertion-codegen.js';
+export function valueForIcmpAssertion(genfile, assertion) {
+    genfile.namedImport('IcmpAssertionBuilder', 'checkly/constructs');
+    switch (assertion.source) {
+        case 'LATENCY':
+            return valueForNumericAssertion('IcmpAssertionBuilder', 'latency', assertion, {
+                hasProperty: true,
+            });
+        case 'JSON_RESPONSE':
+            return valueForGeneralAssertion('IcmpAssertionBuilder', 'jsonResponse', assertion, {
+                hasProperty: true,
+                hasRegex: false,
+            });
+        default:
+            throw new Error(`Unsupported ICMP assertion source ${assertion.source}`);
+    }
+}
+//# sourceMappingURL=icmp-assertion-codegen.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"icmp-assertion-codegen.js","sourceRoot":"","sources":["../../src/constructs/icmp-assertion-codegen.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAGpG,MAAM,UAAU,qBAAqB,CAAE,OAAsB,EAAE,SAAwB;IACrF,OAAO,CAAC,WAAW,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAA;IAEjE,QAAQ,SAAS,CAAC,MAAM,EAAE,CAAC;QACzB,KAAK,SAAS;YACZ,OAAO,wBAAwB,CAAC,sBAAsB,EAAE,SAAS,EAAE,SAAS,EAAE;gBAC5E,WAAW,EAAE,IAAI;aAClB,CAAC,CAAA;QACJ,KAAK,eAAe;YAClB,OAAO,wBAAwB,CAAC,sBAAsB,EAAE,cAAc,EAAE,SAAS,EAAE;gBACjF,WAAW,EAAE,IAAI;gBACjB,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAA;QACJ;YACE,MAAM,IAAI,KAAK,CAAC,qCAAqC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAA;IAC5E,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,56 @@
+import { Assertion as CoreAssertion, NumericAssertionBuilder, GeneralAssertionBuilder } from './internal/assertion.js';
+type IcmpAssertionSource = 'LATENCY' | 'JSON_RESPONSE';
+export type IcmpAssertion = CoreAssertion<IcmpAssertionSource>;
+export type IcmpLatencyProperty = 'avg' | 'min' | 'max' | 'stdDev';
+/**
+ * Builder class for creating ICMP monitor assertions.
+ * Provides methods to create assertions for ICMP ping responses.
+ *
+ * @example
+ * ```typescript
+ * // Latency assertions
+ * IcmpAssertionBuilder.latency('avg').lessThan(100)
+ * IcmpAssertionBuilder.latency('max').lessThan(200)
+ * IcmpAssertionBuilder.latency('stdDev').lessThan(50)
+ *
+ * // JSON response assertions
+ * IcmpAssertionBuilder.jsonResponse('$.packetLoss').lessThan(10)
+ * IcmpAssertionBuilder.jsonResponse('$.packetsReceived').greaterThan(8)
+ * ```
+ */
+export declare class IcmpAssertionBuilder {
+    /**
+     * Creates an assertion builder for ICMP latency metrics.
+     * @param property The latency property to assert against:
+     *   - `avg`: Average round-trip time in milliseconds
+     *   - `min`: Minimum round-trip time in milliseconds
+     *   - `max`: Maximum round-trip time in milliseconds
+     *   - `stdDev`: Standard deviation of round-trip times
+     * @returns A numeric assertion builder for the specified latency metric.
+     */
+    static latency(property: IcmpLatencyProperty): NumericAssertionBuilder<IcmpAssertionSource, IcmpLatencyProperty>;
+    /**
+     * Creates an assertion builder for the JSON formatted response.
+     * Use JSONPath expressions to access specific response fields.
+     *
+     * Available fields include:
+     * - `$.hostname`: The target host that was pinged
+     * - `$.resolvedIp`: The resolved IP address (if host was a domain name)
+     * - `$.ipFamily`: IP family used ('IPv4' or 'IPv6')
+     * - `$.pingCount`: Number of pings configured
+     * - `$.packetsSent`: Number of ICMP echo requests sent
+     * - `$.packetsReceived`: Number of ICMP echo replies received
+     * - `$.packetLoss`: Percentage of packets lost (0-100)
+     * - `$.latency.avg`: Average round-trip time in milliseconds
+     * - `$.latency.min`: Minimum round-trip time in milliseconds
+     * - `$.latency.max`: Maximum round-trip time in milliseconds
+     * - `$.latency.stdDev`: Standard deviation of round-trip times
+     * - `$.pingResults[*].rtt`: Round-trip time for each ping
+     * - `$.pingResults[*].ttl`: Time-to-live for each ping
+     *
+     * @param property Optional JSONPath to specific property (e.g., '$.packetLoss')
+     * @returns A general assertion builder for the JSON formatted response.
+     */
+    static jsonResponse(property?: string): GeneralAssertionBuilder<IcmpAssertionSource>;
+}
+export {};

package/dist/constructs/icmp-assertion.js

@@ -0,0 +1,57 @@
+import { NumericAssertionBuilder, GeneralAssertionBuilder } from './internal/assertion.js';
+/**
+ * Builder class for creating ICMP monitor assertions.
+ * Provides methods to create assertions for ICMP ping responses.
+ *
+ * @example
+ * ```typescript
+ * // Latency assertions
+ * IcmpAssertionBuilder.latency('avg').lessThan(100)
+ * IcmpAssertionBuilder.latency('max').lessThan(200)
+ * IcmpAssertionBuilder.latency('stdDev').lessThan(50)
+ *
+ * // JSON response assertions
+ * IcmpAssertionBuilder.jsonResponse('$.packetLoss').lessThan(10)
+ * IcmpAssertionBuilder.jsonResponse('$.packetsReceived').greaterThan(8)
+ * ```
+ */
+export class IcmpAssertionBuilder {
+    /**
+     * Creates an assertion builder for ICMP latency metrics.
+     * @param property The latency property to assert against:
+     *   - `avg`: Average round-trip time in milliseconds
+     *   - `min`: Minimum round-trip time in milliseconds
+     *   - `max`: Maximum round-trip time in milliseconds
+     *   - `stdDev`: Standard deviation of round-trip times
+     * @returns A numeric assertion builder for the specified latency metric.
+     */
+    static latency(property) {
+        return new NumericAssertionBuilder('LATENCY', property);
+    }
+    /**
+     * Creates an assertion builder for the JSON formatted response.
+     * Use JSONPath expressions to access specific response fields.
+     *
+     * Available fields include:
+     * - `$.hostname`: The target host that was pinged
+     * - `$.resolvedIp`: The resolved IP address (if host was a domain name)
+     * - `$.ipFamily`: IP family used ('IPv4' or 'IPv6')
+     * - `$.pingCount`: Number of pings configured
+     * - `$.packetsSent`: Number of ICMP echo requests sent
+     * - `$.packetsReceived`: Number of ICMP echo replies received
+     * - `$.packetLoss`: Percentage of packets lost (0-100)
+     * - `$.latency.avg`: Average round-trip time in milliseconds
+     * - `$.latency.min`: Minimum round-trip time in milliseconds
+     * - `$.latency.max`: Maximum round-trip time in milliseconds
+     * - `$.latency.stdDev`: Standard deviation of round-trip times
+     * - `$.pingResults[*].rtt`: Round-trip time for each ping
+     * - `$.pingResults[*].ttl`: Time-to-live for each ping
+     *
+     * @param property Optional JSONPath to specific property (e.g., '$.packetLoss')
+     * @returns A general assertion builder for the JSON formatted response.
+     */
+    static jsonResponse(property) {
+        return new GeneralAssertionBuilder('JSON_RESPONSE', property);
+    }
+}
+//# sourceMappingURL=icmp-assertion.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"icmp-assertion.js","sourceRoot":"","sources":["../../src/constructs/icmp-assertion.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAA;AAUtH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,oBAAoB;IAC/B;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,CAAE,QAA6B;QAC3C,OAAO,IAAI,uBAAuB,CAA2C,SAAS,EAAE,QAAQ,CAAC,CAAA;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,YAAY,CAAE,QAAiB;QACpC,OAAO,IAAI,uBAAuB,CAAsB,eAAe,EAAE,QAAQ,CAAC,CAAA;IACpF,CAAC;CACF"}

package/dist/constructs/icmp-monitor-codegen.d.ts

@@ -0,0 +1,13 @@
+import { Codegen, Context } from './internal/codegen/index.js';
+import { MonitorResource } from './monitor-codegen.js';
+import { IcmpRequest } from './icmp-request.js';
+export interface IcmpMonitorResource extends MonitorResource {
+    checkType: 'ICMP';
+    request: IcmpRequest;
+    degradedPacketLossThreshold?: number;
+    maxPacketLossThreshold?: number;
+}
+export declare class IcmpMonitorCodegen extends Codegen<IcmpMonitorResource> {
+    describe(resource: IcmpMonitorResource): string;
+    gencode(logicalId: string, resource: IcmpMonitorResource, context: Context): void;
+}

package/dist/constructs/icmp-monitor-codegen.js

@@ -0,0 +1,34 @@
+import { Codegen } from './internal/codegen/index.js';
+import { expr, ident } from '../sourcegen/index.js';
+import { buildMonitorProps } from './monitor-codegen.js';
+import { valueForIcmpRequest } from './icmp-request-codegen.js';
+const construct = 'IcmpMonitor';
+export class IcmpMonitorCodegen extends Codegen {
+    describe(resource) {
+        return `ICMP Monitor: ${resource.name}`;
+    }
+    gencode(logicalId, resource, context) {
+        const filePath = context.filePath('resources/icmp-monitors', resource.name, {
+            tags: resource.tags,
+            unique: true,
+        });
+        const file = this.program.generatedConstructFile(filePath.fullPath);
+        file.namedImport(construct, 'checkly/constructs');
+        file.section(expr(ident(construct), builder => {
+            builder.new(builder => {
+                builder.string(logicalId);
+                builder.object(builder => {
+                    builder.value('request', valueForIcmpRequest(this.program, file, context, resource.request));
+                    if (resource.degradedPacketLossThreshold !== undefined) {
+                        builder.number('degradedPacketLossThreshold', resource.degradedPacketLossThreshold);
+                    }
+                    if (resource.maxPacketLossThreshold !== undefined) {
+                        builder.number('maxPacketLossThreshold', resource.maxPacketLossThreshold);
+                    }
+                    buildMonitorProps(this.program, file, builder, resource, context);
+                });
+            });
+        }));
+    }
+}
+//# sourceMappingURL=icmp-monitor-codegen.js.map

package/dist/constructs/icmp-monitor-codegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icmp-monitor-codegen.js","sourceRoot":"","sources":["../../src/constructs/icmp-monitor-codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAW,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,iBAAiB,EAAmB,MAAM,sBAAsB,CAAA;AAEzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAS/D,MAAM,SAAS,GAAG,aAAa,CAAA;AAE/B,MAAM,OAAO,kBAAmB,SAAQ,OAA4B;IAClE,QAAQ,CAAE,QAA6B;QACrC,OAAO,iBAAiB,QAAQ,CAAC,IAAI,EAAE,CAAA;IACzC,CAAC;IAED,OAAO,CAAE,SAAiB,EAAE,QAA6B,EAAE,OAAgB;QACzE,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,yBAAyB,EAAE,QAAQ,CAAC,IAAI,EAAE;YAC1E,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,IAAI;SACb,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAEnE,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAA;QAEjD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE;YAC5C,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBACpB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;gBACzB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;oBACvB,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;oBAE5F,IAAI,QAAQ,CAAC,2BAA2B,KAAK,SAAS,EAAE,CAAC;wBACvD,OAAO,CAAC,MAAM,CAAC,6BAA6B,EAAE,QAAQ,CAAC,2BAA2B,CAAC,CAAA;oBACrF,CAAC;oBAED,IAAI,QAAQ,CAAC,sBAAsB,KAAK,SAAS,EAAE,CAAC;wBAClD,OAAO,CAAC,MAAM,CAAC,wBAAwB,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAA;oBAC3E,CAAC;oBAED,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;gBACnE,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAC,CAAA;IACL,CAAC;CACF"}

package/dist/constructs/icmp-monitor.d.ts

@@ -0,0 +1,83 @@
+import { Monitor, MonitorProps } from './monitor.js';
+import { Diagnostics } from './diagnostics.js';
+import { IcmpRequest } from './icmp-request.js';
+export interface IcmpMonitorProps extends MonitorProps {
+    /**
+     * Determines the request that the monitor is going to run.
+     */
+    request: IcmpRequest;
+    /**
+     * The percentage of packet loss where the monitor should be considered
+     * degraded.
+     *
+     * @defaultValue 10
+     * @minimum 0
+     * @maximum 100
+     * @example
+     * ```typescript
+     * degradedPacketLossThreshold: 10  // Alert when 10% or more packets are lost
+     * ```
+     */
+    degradedPacketLossThreshold?: number;
+    /**
+     * The percentage of packet loss where the monitor should be considered
+     * failing.
+     *
+     * @defaultValue 20
+     * @minimum 0
+     * @maximum 100
+     * @example
+     * ```typescript
+     * maxPacketLossThreshold: 20  // Fail if 20% or more packets are lost
+     * ```
+     */
+    maxPacketLossThreshold?: number;
+}
+/**
+ * Creates an ICMP Monitor
+ */
+export declare class IcmpMonitor extends Monitor {
+    request: IcmpRequest;
+    degradedPacketLossThreshold?: number;
+    maxPacketLossThreshold?: number;
+    /**
+     * Constructs the ICMP Monitor instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props configuration properties
+     *
+     * {@link https://www.checklyhq.com/docs/constructs/icmp-monitor/ Read more in the docs}
+     */
+    constructor(logicalId: string, props: IcmpMonitorProps);
+    describe(): string;
+    validate(diagnostics: Diagnostics): Promise<void>;
+    synthesize(): {
+        checkType: string;
+        request: IcmpRequest;
+        degradedPacketLossThreshold: number | undefined;
+        maxPacketLossThreshold: number | undefined;
+        doubleCheck: boolean;
+        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;
+        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/icmp-monitor.js

@@ -0,0 +1,43 @@
+import { Monitor } from './monitor.js';
+import { Session } from './session.js';
+/**
+ * Creates an ICMP Monitor
+ */
+export class IcmpMonitor extends Monitor {
+    request;
+    degradedPacketLossThreshold;
+    maxPacketLossThreshold;
+    /**
+     * Constructs the ICMP Monitor instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props configuration properties
+     *
+     * {@link https://www.checklyhq.com/docs/constructs/icmp-monitor/ Read more in the docs}
+     */
+    constructor(logicalId, props) {
+        super(logicalId, props);
+        this.request = props.request;
+        this.degradedPacketLossThreshold = props.degradedPacketLossThreshold;
+        this.maxPacketLossThreshold = props.maxPacketLossThreshold;
+        Session.registerConstruct(this);
+        this.addSubscriptions();
+        this.addPrivateLocationCheckAssignments();
+    }
+    describe() {
+        return `IcmpMonitor:${this.logicalId}`;
+    }
+    async validate(diagnostics) {
+        await super.validate(diagnostics);
+    }
+    synthesize() {
+        return {
+            ...super.synthesize(),
+            checkType: 'ICMP',
+            request: this.request,
+            degradedPacketLossThreshold: this.degradedPacketLossThreshold,
+            maxPacketLossThreshold: this.maxPacketLossThreshold,
+        };
+    }
+}
+//# sourceMappingURL=icmp-monitor.js.map

package/dist/constructs/icmp-monitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icmp-monitor.js","sourceRoot":"","sources":["../../src/constructs/icmp-monitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAgB,MAAM,cAAc,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAuCtC;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,OAAO;IACtC,OAAO,CAAa;IACpB,2BAA2B,CAAS;IACpC,sBAAsB,CAAS;IAE/B;;;;;;;OAOG;IAEH,YAAa,SAAiB,EAAE,KAAuB;QACrD,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QAEvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,IAAI,CAAC,2BAA2B,GAAG,KAAK,CAAC,2BAA2B,CAAA;QACpE,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC,sBAAsB,CAAA;QAE1D,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC/B,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,IAAI,CAAC,kCAAkC,EAAE,CAAA;IAC3C,CAAC;IAED,QAAQ;QACN,OAAO,eAAe,IAAI,CAAC,SAAS,EAAE,CAAA;IACxC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,WAAwB;QACtC,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;IACnC,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,KAAK,CAAC,UAAU,EAAE;YACrB,SAAS,EAAE,MAAM;YACjB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;YAC7D,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;SACpD,CAAA;IACH,CAAC;CACF"}

package/dist/constructs/icmp-request-codegen.d.ts

@@ -0,0 +1,4 @@
+import { GeneratedFile, Program, Value } from '../sourcegen/index.js';
+import { IcmpRequest } from './icmp-request.js';
+import { Context } from './internal/codegen/index.js';
+export declare function valueForIcmpRequest(program: Program, genfile: GeneratedFile, context: Context, request: IcmpRequest): Value;

package/dist/constructs/icmp-request-codegen.js

@@ -0,0 +1,24 @@
+import { object } from '../sourcegen/index.js';
+import { valueForIcmpAssertion } from './icmp-assertion-codegen.js';
+export function valueForIcmpRequest(program, genfile, context, request) {
+    return object(builder => {
+        builder.string('hostname', request.hostname);
+        if (request.ipFamily && request.ipFamily !== 'IPv4') {
+            builder.string('ipFamily', request.ipFamily);
+        }
+        if (request.pingCount !== undefined) {
+            builder.number('pingCount', request.pingCount);
+        }
+        if (request.assertions) {
+            const assertions = request.assertions;
+            if (assertions.length > 0) {
+                builder.array('assertions', builder => {
+                    for (const assertion of assertions) {
+                        builder.value(valueForIcmpAssertion(genfile, assertion));
+                    }
+                });
+            }
+        }
+    });
+}
+//# sourceMappingURL=icmp-request-codegen.js.map

package/dist/constructs/icmp-request-codegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icmp-request-codegen.js","sourceRoot":"","sources":["../../src/constructs/icmp-request-codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,MAAM,EAAkB,MAAM,uBAAuB,CAAA;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AAInE,MAAM,UAAU,mBAAmB,CACjC,OAAgB,EAChB,OAAsB,EACtB,OAAgB,EAChB,OAAoB;IAEpB,OAAO,MAAM,CAAC,OAAO,CAAC,EAAE;QACtB,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;QAE5C,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YACpD,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9C,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;QAChD,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;YACrC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,EAAE;oBACpC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;wBACnC,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAA;oBAC1D,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/constructs/icmp-request.d.ts

@@ -0,0 +1,37 @@
+import { IcmpAssertion } from './icmp-assertion.js';
+import { IPFamily } from './ip.js';
+/**
+ * Configuration for ICMP ping requests.
+ * Defines the target host and ping parameters.
+ */
+export interface IcmpRequest {
+    /**
+     * The domain name or IP address to ping.
+     *
+     * @example "www.example.com"
+     * @example "199.43.133.53"
+     */
+    hostname: string;
+    /**
+     * The IP protocol version to use for pinging.
+     *
+     * @example "IPv4"
+     * @example "IPv6"
+     * @default "IPv4"
+     */
+    ipFamily?: IPFamily;
+    /**
+     * The number of ICMP echo requests (pings) to send. This allows you to see
+     * and assert how many packets were received.
+     *
+     * @minimum 1
+     * @maximum 50
+     * @example 10
+     * @default 10
+     */
+    pingCount?: number;
+    /**
+     * Assertions to validate the ICMP response.
+     */
+    assertions?: Array<IcmpAssertion>;
+}

package/dist/constructs/icmp-request.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=icmp-request.js.map

package/dist/constructs/icmp-request.js.map

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

package/dist/constructs/incident.d.ts

@@ -0,0 +1,15 @@
+import { StatusPageService } from './status-page-service.js';
+type IncidentSeverity = 'MINOR' | 'MEDIUM' | 'MAJOR' | 'CRITICAL';
+export interface IncidentTrigger {
+    /** The status page service that this incident will be associated with. */
+    service: StatusPageService;
+    /** The severity level of the incident. */
+    severity: IncidentSeverity;
+    /** The name of the incident. */
+    name: string;
+    /** A detailed description of the incident. */
+    description: string;
+    /** Whether to notify subscribers when the incident is triggered. */
+    notifySubscribers: boolean;
+}
+export {};

package/dist/constructs/incident.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=incident.js.map

package/dist/constructs/incident.js.map

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

package/dist/constructs/incidentio-alert-channel-codegen.d.ts

@@ -0,0 +1,13 @@
+import { Codegen, Context } from './internal/codegen/index.js';
+import { WebhookAlertChannelResource, WebhookAlertChannelResourceConfig } from './webhook-alert-channel-codegen.js';
+export interface IncidentioAlertChannelResource extends WebhookAlertChannelResource {
+    config: WebhookAlertChannelResourceConfig & {
+        webhookType: 'WEBHOOK_INCIDENTIO';
+    };
+}
+export declare class IncidentioAlertChannelCodegen extends Codegen<IncidentioAlertChannelResource> {
+    validateSafety(resource: IncidentioAlertChannelResource): void;
+    describe(resource: IncidentioAlertChannelResource): string;
+    prepare(logicalId: string, resource: IncidentioAlertChannelResource, context: Context): void;
+    gencode(logicalId: string, resource: IncidentioAlertChannelResource, context: Context): void;
+}

package/dist/constructs/incidentio-alert-channel-codegen.js

@@ -0,0 +1,85 @@
+import { Codegen, ImportSafetyViolation } from './internal/codegen/index.js';
+import { decl, expr, ident } from '../sourcegen/index.js';
+import { buildAlertChannelProps } from './alert-channel-codegen.js';
+import { IncidentioAlertChannel } from './incidentio-alert-channel.js';
+function apiKeyFromHeaders(headers) {
+    for (const header of headers) {
+        if (header.key.toLocaleLowerCase() !== 'authorization') {
+            continue;
+        }
+        if (!header.value.startsWith('Bearer ')) {
+            continue;
+        }
+        return header.value.replace('Bearer ', '');
+    }
+}
+const construct = 'IncidentioAlertChannel';
+export class IncidentioAlertChannelCodegen extends Codegen {
+    validateSafety(resource) {
+        const { config } = resource;
+        if (config.method !== 'POST') {
+            throw new ImportSafetyViolation(`Unsupported value for property 'method' (expected 'POST')`);
+        }
+        if (config.headers === undefined) {
+            throw new ImportSafetyViolation(`Unsupported value for property 'headers' (expected a single 'authorization' header)`);
+        }
+        if (config.headers.length !== 1) {
+            throw new ImportSafetyViolation(`Unsupported value for property 'headers' (expected a single 'authorization' header)`);
+        }
+        if (config.headers[0].key.toLowerCase() !== 'authorization') {
+            throw new ImportSafetyViolation(`Unsupported value for property 'headers' (expected a single 'authorization' header)`);
+        }
+        if (config.queryParameters !== undefined && config.queryParameters.length !== 0) {
+            throw new ImportSafetyViolation(`Unsupported value for property 'queryParameters' (expected no value or an empty array)`);
+        }
+        if (config.webhookSecret) {
+            throw new ImportSafetyViolation(`Unsupported value for property 'webhookSecret' (expected no value)`);
+        }
+    }
+    describe(resource) {
+        this.validateSafety(resource);
+        return `Incident.io Alert Channel: ${resource.config.name}`;
+    }
+    prepare(logicalId, resource, context) {
+        this.validateSafety(resource);
+        const { name } = resource.config;
+        const filename = context.filePath('resources/alert-channels/incident-io', name, {
+            unique: true,
+        });
+        context.registerAlertChannel(resource.id, `${name} incidentio`, this.program.generatedConstructFile(filename.fullPath));
+    }
+    gencode(logicalId, resource, context) {
+        this.validateSafety(resource);
+        const { id, file } = context.lookupAlertChannel(resource.id);
+        file.namedImport(construct, 'checkly/constructs');
+        const { config } = resource;
+        file.section(decl(id, builder => {
+            builder.variable(expr(ident(construct), builder => {
+                builder.new(builder => {
+                    builder.string(logicalId);
+                    builder.object(builder => {
+                        builder.string('name', config.name);
+                        builder.string('url', config.url);
+                        if (config.headers) {
+                            const apiKey = apiKeyFromHeaders(config.headers);
+                            if (apiKey) {
+                                builder.string('apiKey', apiKey);
+                            }
+                            else {
+                                throw new Error(`Failed to extract incident.io API Key from webhook headers`);
+                            }
+                        }
+                        if (config.template) {
+                            if (config.template !== IncidentioAlertChannel.DEFAULT_PAYLOAD) {
+                                builder.string('payload', config.template);
+                            }
+                        }
+                        buildAlertChannelProps(builder, resource);
+                    });
+                });
+            }));
+            builder.export();
+        }));
+    }
+}
+//# sourceMappingURL=incidentio-alert-channel-codegen.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"incidentio-alert-channel-codegen.js","sourceRoot":"","sources":["../../src/constructs/incidentio-alert-channel-codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAW,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AACrF,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AAGnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AAQtE,SAAS,iBAAiB,CAAE,OAAqB;IAC/C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,eAAe,EAAE,CAAC;YACvD,SAAQ;QACV,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YACxC,SAAQ;QACV,CAAC;QAED,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC;AAED,MAAM,SAAS,GAAG,wBAAwB,CAAA;AAE1C,MAAM,OAAO,6BAA8B,SAAQ,OAAuC;IACxF,cAAc,CAAE,QAAwC;QACtD,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAA;QAE3B,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC7B,MAAM,IAAI,qBAAqB,CAAC,2DAA2D,CAAC,CAAA;QAC9F,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,IAAI,qBAAqB,CAAC,qFAAqF,CAAC,CAAA;QACxH,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,qBAAqB,CAAC,qFAAqF,CAAC,CAAA;QACxH,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,eAAe,EAAE,CAAC;YAC5D,MAAM,IAAI,qBAAqB,CAAC,qFAAqF,CAAC,CAAA;QACxH,CAAC;QAED,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,IAAI,MAAM,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChF,MAAM,IAAI,qBAAqB,CAAC,wFAAwF,CAAC,CAAA;QAC3H,CAAC;QAED,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACzB,MAAM,IAAI,qBAAqB,CAAC,oEAAoE,CAAC,CAAA;QACvG,CAAC;IACH,CAAC;IAED,QAAQ,CAAE,QAAwC;QAChD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAA;QAE7B,OAAO,8BAA8B,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;IAC7D,CAAC;IAED,OAAO,CAAE,SAAiB,EAAE,QAAwC,EAAE,OAAgB;QACpF,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAA;QAE7B,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAA;QAEhC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,sCAAsC,EAAE,IAAI,EAAE;YAC9E,MAAM,EAAE,IAAI;SACb,CAAC,CAAA;QAEF,OAAO,CAAC,oBAAoB,CAC1B,QAAQ,CAAC,EAAE,EACX,GAAG,IAAI,aAAa,EACpB,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACvD,CAAA;IACH,CAAC;IAED,OAAO,CAAE,SAAiB,EAAE,QAAwC,EAAE,OAAgB;QACpF,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAA;QAE7B,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QAE5D,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAA;QAEjD,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAA;QAE3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE;YAC9B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE;gBAChD,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;oBACpB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;oBACzB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;wBACvB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;wBACnC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,CAAA;wBAEjC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;4BACnB,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;4BAChD,IAAI,MAAM,EAAE,CAAC;gCACX,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;4BAClC,CAAC;iCAAM,CAAC;gCACN,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAA;4BAC/E,CAAC;wBACH,CAAC;wBAED,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;4BACpB,IAAI,MAAM,CAAC,QAAQ,KAAK,sBAAsB,CAAC,eAAe,EAAE,CAAC;gCAC/D,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;4BAC5C,CAAC;wBACH,CAAC;wBAED,sBAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;oBAC3C,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAC,CAAA;YAEH,OAAO,CAAC,MAAM,EAAE,CAAA;QAClB,CAAC,CAAC,CAAC,CAAA;IACL,CAAC;CACF"}

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

@@ -0,0 +1,44 @@
+import { WebhookAlertChannel } from './webhook-alert-channel.js';
+import { AlertChannelProps } from './alert-channel.js';
+export interface IncidentioAlertChannelProps extends AlertChannelProps {
+    /**
+     * Friendly name to recognise the integration.
+     */
+    name: string;
+    /**
+     * The unique URL created by installing the Checkly integration in Incident.io.
+     * {@link https://www.checklyhq.com/docs/integrations/incident-management/incidentio/}
+     */
+    url: URL | string;
+    /**
+     * The API key created by installing the Checkly integration in Incident.io.
+     * {@link https://www.checklyhq.com/docs/integrations/incident-management/incidentio/}
+     */
+    apiKey: string;
+    /**
+     * An optional custom payload. If not given,
+     * `IncidentioAlertChannel.DEFAULT_PAYLOAD` will be used.
+     */
+    payload?: string;
+}
+/**
+ * Creates an Incident.io Alert Channel
+ *
+ * @remarks
+ *
+ * This class make use of the Alert Channel endpoints.
+ */
+export declare class IncidentioAlertChannel extends WebhookAlertChannel {
+    static DEFAULT_PAYLOAD: string;
+    /**
+     * Constructs the Incident.io Alert Channel instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props Incident.io alert channel configuration properties
+     *
+     * {@link https://www.checklyhq.com/docs/integrations/incident-management/incidentio/ Read more in the docs}
+     */
+    constructor(logicalId: string, props: IncidentioAlertChannelProps);
+    describe(): string;
+    synthesize(): any;
+}