checkly 0.0.0-canary.58c867e

package/dist/constructs/dashboard.d.ts

@@ -0,0 +1,226 @@
+import { Construct, Content, Entrypoint } from './construct.js';
+import { Diagnostics } from './diagnostics.js';
+import { DashboardBundle } from './dashboard-bundle.js';
+import { Bundler } from '../services/check-parser/bundler.js';
+/**
+ * Configuration properties for dashboards.
+ * Dashboards provide a public status page showing the health of your checks.
+ *
+ * @example
+ * ```typescript
+ * const dashboard = new Dashboard('status-dashboard', {
+ *   customUrl: 'my-company-status',
+ *   header: 'My Company Status',
+ *   description: 'Service availability and performance monitoring',
+ *   tags: ['production', 'api'],
+ *   refreshRate: 60,
+ *   checksPerPage: 10,
+ *   enableIncidents: true
+ * })
+ * ```
+ */
+export interface DashboardProps {
+    /**
+     * A list of one or more tags that filter what checks will be shown in the dashboard.
+     * All checks are included if no tag is specified.
+     *
+     * @example ['production', 'api', 'critical']
+     */
+    tags?: Array<string>;
+    /**
+     * A subdomain name under "checklyhq.com". Needs to be unique across all users.
+     * This is required if 'customDomain' is not specified.
+     *
+     * @example 'my-company-status' // Creates https://my-company-status.checklyhq.com
+     */
+    customUrl?: string;
+    /**
+     * A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
+     * This is required if 'customUrl' is not specified.
+     *
+     * @example 'status.example.com'
+     * @see {@link https://www.checklyhq.com/docs/communicate/dashboards/configuration/#custom-domain | Custom Domain Setup}
+     */
+    customDomain?: string;
+    /**
+     * A URL pointing to an image file for the dashboard logo.
+     *
+     * @example 'https://example.com/logo.png'
+     */
+    logo?: string;
+    /**
+     * A URL pointing to an image file used as dashboard favicon.
+     *
+     * @example 'https://example.com/favicon.ico'
+     */
+    favicon?: string;
+    /**
+     * A URL link to redirect when dashboard logo is clicked on.
+     *
+     * @example 'https://example.com'
+     */
+    link?: string;
+    /**
+     * A piece of text displayed at the top of your dashboard.
+     *
+     * @example 'My Company Service Status'
+     */
+    header?: string;
+    /**
+     * A piece of text displayed below the header or title of your dashboard.
+     *
+     * @example 'Real-time status of our services and APIs'
+     */
+    description?: string;
+    /**
+     * Determines whether to use the full screen or focus in the center.
+     *
+     * @defaultValue 'FULL'
+     */
+    width?: 'FULL' | '960PX';
+    /**
+     * How often to refresh the dashboard in seconds.
+     *
+     * @defaultValue 60
+     */
+    refreshRate?: 60 | 300 | 600;
+    /**
+     * Determines if pagination is on or off.
+     * When enabled, checks are split across multiple pages.
+     *
+     * @defaultValue true
+     */
+    paginate?: boolean;
+    /**
+     * How often to trigger pagination in seconds.
+     * Controls how frequently the dashboard cycles through pages.
+     *
+     * @defaultValue 60
+     */
+    paginationRate?: 30 | 60 | 300;
+    /**
+     * Number of checks displayed per page.
+     *
+     * @defaultValue 15
+     * @minimum 1
+     * @maximum 20
+     */
+    checksPerPage?: number;
+    /**
+     * When to use AND operator for tags lookup.
+     * If true, checks must have ALL specified tags. If false, checks with ANY specified tag are shown.
+     *
+     * @defaultValue false
+     */
+    useTagsAndOperator?: boolean;
+    /**
+     * Show or hide the tags on the dashboard.
+     *
+     * @defaultValue false
+     */
+    hideTags?: boolean;
+    /**
+     * Enable or disable incidents on the dashboard.
+     * Allows manual incident creation and management on the status page.
+     *
+     * @defaultValue false
+     * @remarks Only paid accounts can enable this feature
+     * @see {@link https://www.checklyhq.com/docs/communicate/dashboards/incidents/ | Dashboard Incidents}
+     */
+    enableIncidents?: boolean;
+    /**
+     * Expand or collapse checks on the dashboard.
+     *
+     * @defaultValue false
+     */
+    expandChecks?: boolean;
+    /**
+     * Show or hide header and description on the dashboard.
+     *
+     * @defaultValue true
+     */
+    showHeader?: boolean;
+    /**
+     * Custom CSS to be applied to the dashboard.
+     * Allows customization of the dashboard appearance with your own styling.
+     *
+     * @example
+     * ```typescript
+     * // Using external CSS file
+     * customCSS: { entrypoint: './dashboard.css' }
+     *
+     * // Using inline CSS
+     * customCSS: {
+     *   content: '.header { background: #blue; }'
+     * }
+     * ```
+     */
+    customCSS?: Content | Entrypoint;
+    /**
+     * Determines if the dashboard is public or private.
+     * Private dashboards require authentication to view.
+     *
+     * @defaultValue false
+     * @remarks Only paid accounts can enable this feature
+     */
+    isPrivate?: boolean;
+    /**
+     * Show or hide the P95 stats on the dashboard.
+     * P95 represents the 95th percentile response time.
+     *
+     * @defaultValue true
+     */
+    showP95?: boolean;
+    /**
+     * Show or hide the P99 stats on the dashboard.
+     * P99 represents the 99th percentile response time.
+     *
+     * @defaultValue true
+     */
+    showP99?: boolean;
+}
+/**
+ * Creates a Dashboard
+ *
+ * @remarks
+ *
+ * This class make use of the Dashboard endpoints.
+ */
+export declare class Dashboard extends Construct {
+    readonly tags?: Array<string>;
+    readonly customUrl?: string;
+    readonly customDomain?: string;
+    readonly logo?: string;
+    readonly favicon?: string;
+    readonly link?: string;
+    readonly header?: string;
+    readonly description?: string;
+    readonly width?: 'FULL' | '960PX';
+    readonly refreshRate?: 60 | 300 | 600;
+    readonly paginate?: boolean;
+    readonly paginationRate?: 30 | 60 | 300;
+    readonly checksPerPage?: number;
+    readonly useTagsAndOperator?: boolean;
+    readonly hideTags?: boolean;
+    readonly enableIncidents?: boolean;
+    readonly expandChecks?: boolean;
+    readonly showHeader?: boolean;
+    readonly customCSS?: Content | Entrypoint;
+    readonly isPrivate?: boolean;
+    readonly showP95?: boolean;
+    readonly showP99?: boolean;
+    static readonly __checklyType = "dashboard";
+    /**
+     * Constructs the Dashboard instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props dashboard configuration properties
+     *
+     * {@link https://www.checklyhq.com/docs/constructs/dashboard/ Read more in the docs}
+     */
+    constructor(logicalId: string, props: DashboardProps);
+    describe(): string;
+    validate(diagnostics: Diagnostics): Promise<void>;
+    bundle(bundler: Bundler): Promise<DashboardBundle>;
+    synthesize(): any | null;
+}

package/dist/constructs/dashboard.js

@@ -0,0 +1,140 @@
+import fs from 'node:fs/promises';
+import { Construct, isContent, isEntrypoint } from './construct.js';
+import { Session } from './session.js';
+import { InvalidPropertyValueDiagnostic } from './construct-diagnostics.js';
+import { DashboardBundle } from './dashboard-bundle.js';
+/**
+ * Creates a Dashboard
+ *
+ * @remarks
+ *
+ * This class make use of the Dashboard endpoints.
+ */
+export class Dashboard extends Construct {
+    tags;
+    customUrl;
+    customDomain;
+    logo;
+    favicon;
+    link;
+    header;
+    description;
+    width;
+    refreshRate;
+    paginate;
+    paginationRate;
+    checksPerPage;
+    useTagsAndOperator;
+    hideTags;
+    enableIncidents;
+    expandChecks;
+    showHeader;
+    customCSS;
+    isPrivate;
+    showP95;
+    showP99;
+    static __checklyType = 'dashboard';
+    /**
+     * Constructs the Dashboard instance
+     *
+     * @param logicalId unique project-scoped resource name identification
+     * @param props dashboard configuration properties
+     *
+     * {@link https://www.checklyhq.com/docs/constructs/dashboard/ Read more in the docs}
+     */
+    constructor(logicalId, props) {
+        super(Dashboard.__checklyType, logicalId);
+        this.tags = props.tags;
+        this.customUrl = props.customUrl;
+        this.customDomain = props.customDomain;
+        this.logo = props.logo;
+        this.favicon = props.favicon;
+        this.link = props.link;
+        this.header = props.header;
+        this.description = props.description;
+        this.width = props.width;
+        this.refreshRate = props.refreshRate;
+        this.paginate = props.paginate;
+        this.paginationRate = props.paginationRate;
+        this.checksPerPage = props.checksPerPage;
+        this.useTagsAndOperator = props.useTagsAndOperator;
+        this.hideTags = props.hideTags;
+        this.enableIncidents = props.enableIncidents;
+        this.expandChecks = props.expandChecks;
+        this.showHeader = props.showHeader;
+        this.isPrivate = props.isPrivate;
+        this.showP95 = props.showP95;
+        this.showP99 = props.showP99;
+        this.customCSS = props.customCSS;
+        Session.registerConstruct(this);
+    }
+    describe() {
+        return `Dashboard:${this.logicalId}`;
+    }
+    async validate(diagnostics) {
+        await super.validate(diagnostics);
+        if (!this.customUrl && !this.customDomain) {
+            diagnostics.add(new InvalidPropertyValueDiagnostic('customUrl', new Error(`Required unless "customDomain" is set.`)));
+            diagnostics.add(new InvalidPropertyValueDiagnostic('customDomain', new Error(`Required unless "customUrl" is set.`)));
+        }
+        if (this.customCSS) {
+            if (!isEntrypoint(this.customCSS) && !isContent(this.customCSS)) {
+                diagnostics.add(new InvalidPropertyValueDiagnostic('customCSS', new Error(`Either "entrypoint" or "content" is required.`)));
+            }
+            else if (isEntrypoint(this.customCSS) && isContent(this.customCSS)) {
+                diagnostics.add(new InvalidPropertyValueDiagnostic('customCSS', new Error(`Provide exactly one of "entrypoint" or "content", but not both.`)));
+            }
+            else if (isEntrypoint(this.customCSS)) {
+                const entrypoint = this.resolveContentFilePath(this.customCSS.entrypoint);
+                try {
+                    await fs.access(entrypoint, fs.constants.R_OK);
+                }
+                catch (err) {
+                    diagnostics.add(new InvalidPropertyValueDiagnostic('customCSS', new Error(`Unable to access file "${entrypoint}": ${err.message}`, { cause: err })));
+                }
+            }
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async bundle(bundler) {
+        const customCSS = await (async () => {
+            if (this.customCSS) {
+                if (isEntrypoint(this.customCSS)) {
+                    const entrypoint = this.resolveContentFilePath(this.customCSS.entrypoint);
+                    const content = await fs.readFile(entrypoint);
+                    return content.toString('utf8');
+                }
+                return this.customCSS.content;
+            }
+        })();
+        return new DashboardBundle(this, {
+            customCSS,
+        });
+    }
+    synthesize() {
+        return {
+            tags: this.tags,
+            customUrl: this.customUrl,
+            customDomain: this.customDomain,
+            logo: this.logo,
+            favicon: this.favicon,
+            link: this.link,
+            header: this.header,
+            description: this.description,
+            width: this.width,
+            refreshRate: this.refreshRate,
+            paginate: this.paginate,
+            paginationRate: this.paginationRate,
+            checksPerPage: this.checksPerPage,
+            useTagsAndOperator: this.useTagsAndOperator,
+            hideTags: this.hideTags,
+            enableIncidents: this.enableIncidents,
+            expandChecks: this.expandChecks,
+            showHeader: this.showHeader,
+            isPrivate: this.isPrivate,
+            showP95: this.showP95,
+            showP99: this.showP99,
+        };
+    }
+}
+//# sourceMappingURL=dashboard.js.map

package/dist/constructs/dashboard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashboard.js","sourceRoot":"","sources":["../../src/constructs/dashboard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAEjC,OAAO,EAAE,SAAS,EAAuB,SAAS,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AACxF,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAEtC,OAAO,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAA;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AA0MvD;;;;;;GAMG;AACH,MAAM,OAAO,SAAU,SAAQ,SAAS;IAC7B,IAAI,CAAgB;IACpB,SAAS,CAAS;IAClB,YAAY,CAAS;IACrB,IAAI,CAAS;IACb,OAAO,CAAS;IAChB,IAAI,CAAS;IACb,MAAM,CAAS;IACf,WAAW,CAAS;IACpB,KAAK,CAAmB;IACxB,WAAW,CAAiB;IAC5B,QAAQ,CAAU;IAClB,cAAc,CAAgB;IAC9B,aAAa,CAAS;IACtB,kBAAkB,CAAU;IAC5B,QAAQ,CAAU;IAClB,eAAe,CAAU;IACzB,YAAY,CAAU;IACtB,UAAU,CAAU;IACpB,SAAS,CAAuB;IAChC,SAAS,CAAU;IACnB,OAAO,CAAU;IACjB,OAAO,CAAU;IAE1B,MAAM,CAAU,aAAa,GAAG,WAAW,CAAA;IAE3C;;;;;;;OAOG;IACH,YAAa,SAAiB,EAAE,KAAqB;QACnD,KAAK,CAAC,SAAS,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QACzC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;QACtC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;QACxB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;QAC1C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAA;QAClD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAA;QAC5C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;QACtC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;QAClC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAEhC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,QAAQ;QACN,OAAO,aAAa,IAAI,CAAC,SAAS,EAAE,CAAA;IACtC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,WAAwB;QACtC,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QAEjC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAC1C,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,WAAW,EACX,IAAI,KAAK,CAAC,wCAAwC,CAAC,CACpD,CAAC,CAAA;YAEF,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,cAAc,EACd,IAAI,KAAK,CAAC,qCAAqC,CAAC,CACjD,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChE,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,WAAW,EACX,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAC3D,CAAC,CAAA;YACJ,CAAC;iBAAM,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBACrE,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,WAAW,EACX,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAC7E,CAAC,CAAA;YACJ,CAAC;iBAAM,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBACxC,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;gBACzE,IAAI,CAAC;oBACH,MAAM,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;gBAChD,CAAC;gBAAC,OAAO,GAAQ,EAAE,CAAC;oBAClB,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,WAAW,EACX,IAAI,KAAK,CAAC,0BAA0B,UAAU,MAAM,GAAG,CAAC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CACnF,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,MAAM,CAAE,OAAgB;QAC5B,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACnB,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;oBACjC,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;oBACzE,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;oBAC7C,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;gBACjC,CAAC;gBAED,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAA;YAC/B,CAAC;QACH,CAAC,CAAC,EAAE,CAAA;QAEJ,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,SAAS;SACV,CAAC,CAAA;IACJ,CAAC;IAED,UAAU;QACR,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;IACH,CAAC"}

package/dist/constructs/diagnostics.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Options for creating diagnostic messages.
+ */
+export interface DiagnosticOptions {
+    /** The title/summary of the diagnostic */
+    title: string;
+    /** Detailed message describing the diagnostic */
+    message: string;
+}
+/**
+ * Abstract base class for diagnostic messages.
+ * Diagnostics are used to report issues during validation and processing.
+ */
+export declare abstract class Diagnostic {
+    /** The title/summary of the diagnostic */
+    title: string;
+    /** Detailed message describing the diagnostic */
+    message: string;
+    /**
+     * Creates a new diagnostic instance.
+     * @param options The diagnostic configuration
+     */
+    constructor(options: DiagnosticOptions);
+    /**
+     * Determines if this diagnostic represents a fatal error.
+     * @returns true if this diagnostic is fatal and should stop processing
+     */
+    abstract isFatal(): boolean;
+    /**
+     * Determines if this diagnostic is benign and can be ignored.
+     * @returns true if this diagnostic is informational only
+     */
+    abstract isBenign(): boolean;
+}
+export interface ErrorDiagnosticOptions extends DiagnosticOptions {
+    error: any;
+}
+export declare class ErrorDiagnostic extends Diagnostic {
+    error: any;
+    constructor(options: ErrorDiagnosticOptions);
+    isFatal(): boolean;
+    isBenign(): boolean;
+}
+export declare class WarningDiagnostic extends Diagnostic {
+    isFatal(): boolean;
+    isBenign(): boolean;
+}
+export declare class NoticeDiagnostic extends Diagnostic {
+    isFatal(): boolean;
+    isBenign(): boolean;
+}
+export declare class Diagnostics {
+    #private;
+    observations: Diagnostic[];
+    isFatal(): boolean;
+    isBenign(): boolean;
+    add(diagnostic: Diagnostic): void;
+    extend(...diagnostics: Diagnostics[]): void;
+}

package/dist/constructs/diagnostics.js

@@ -0,0 +1,71 @@
+/**
+ * Abstract base class for diagnostic messages.
+ * Diagnostics are used to report issues during validation and processing.
+ */
+export class Diagnostic {
+    /** The title/summary of the diagnostic */
+    title;
+    /** Detailed message describing the diagnostic */
+    message;
+    /**
+     * Creates a new diagnostic instance.
+     * @param options The diagnostic configuration
+     */
+    constructor(options) {
+        this.title = options.title;
+        this.message = options.message;
+    }
+}
+export class ErrorDiagnostic extends Diagnostic {
+    error;
+    constructor(options) {
+        super(options);
+        this.error = options.error;
+    }
+    isFatal() {
+        return true;
+    }
+    isBenign() {
+        return false;
+    }
+}
+export class WarningDiagnostic extends Diagnostic {
+    isFatal() {
+        return false;
+    }
+    isBenign() {
+        return false;
+    }
+}
+export class NoticeDiagnostic extends Diagnostic {
+    isFatal() {
+        return false;
+    }
+    isBenign() {
+        return true;
+    }
+}
+export class Diagnostics {
+    observations = [];
+    #fatal = false;
+    #benign = true;
+    isFatal() {
+        return this.#fatal;
+    }
+    isBenign() {
+        return this.#benign;
+    }
+    add(diagnostic) {
+        this.observations.push(diagnostic);
+        this.#fatal ||= diagnostic.isFatal();
+        this.#benign &&= diagnostic.isBenign();
+    }
+    extend(...diagnostics) {
+        for (const diags of diagnostics) {
+            for (const observation of diags.observations) {
+                this.add(observation);
+            }
+        }
+    }
+}
+//# sourceMappingURL=diagnostics.js.map

package/dist/constructs/diagnostics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostics.js","sourceRoot":"","sources":["../../src/constructs/diagnostics.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,MAAM,OAAgB,UAAU;IAC9B,0CAA0C;IAC1C,KAAK,CAAQ;IACb,iDAAiD;IACjD,OAAO,CAAQ;IAEf;;;OAGG;IACH,YAAa,OAA0B;QACrC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;IAChC,CAAC;CAaF;AAMD,MAAM,OAAO,eAAgB,SAAQ,UAAU;IAC7C,KAAK,CAAK;IAEV,YAAa,OAA+B;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;IAC5B,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAA;IACb,CAAC;IAED,QAAQ;QACN,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAC/C,OAAO;QACL,OAAO,KAAK,CAAA;IACd,CAAC;IAED,QAAQ;QACN,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,UAAU;IAC9C,OAAO;QACL,OAAO,KAAK,CAAA;IACd,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,MAAM,OAAO,WAAW;IACtB,YAAY,GAAiB,EAAE,CAAA;IAC/B,MAAM,GAAG,KAAK,CAAA;IACd,OAAO,GAAG,IAAI,CAAA;IAEd,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,GAAG,CAAE,UAAsB;QACzB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAClC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,OAAO,EAAE,CAAA;QACpC,IAAI,CAAC,OAAO,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAA;IACxC,CAAC;IAED,MAAM,CAAE,GAAG,WAA0B;QACnC,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;YAChC,KAAK,MAAM,WAAW,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;gBAC7C,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;YACvB,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

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

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

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

@@ -0,0 +1,26 @@
+import { valueForGeneralAssertion, valueForNumericAssertion } from './internal/assertion-codegen.js';
+export function valueForDnsAssertion(genfile, assertion) {
+    genfile.namedImport('DnsAssertionBuilder', 'checkly/constructs');
+    switch (assertion.source) {
+        case 'RESPONSE_CODE':
+            return valueForGeneralAssertion('DnsAssertionBuilder', 'responseCode', assertion, {
+                hasProperty: false,
+                hasRegex: false,
+            });
+        case 'RESPONSE_TIME':
+            return valueForNumericAssertion('DnsAssertionBuilder', 'responseTime', assertion);
+        case 'TEXT_ANSWER':
+            return valueForGeneralAssertion('DnsAssertionBuilder', 'textAnswer', assertion, {
+                hasProperty: true,
+                hasRegex: false,
+            });
+        case 'JSON_ANSWER':
+            return valueForGeneralAssertion('DnsAssertionBuilder', 'jsonAnswer', assertion, {
+                hasProperty: true,
+                hasRegex: false,
+            });
+        default:
+            throw new Error(`Unsupported DNS assertion source ${assertion.source}`);
+    }
+}
+//# sourceMappingURL=dns-assertion-codegen.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dns-assertion-codegen.js","sourceRoot":"","sources":["../../src/constructs/dns-assertion-codegen.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAGpG,MAAM,UAAU,oBAAoB,CAAE,OAAsB,EAAE,SAAuB;IACnF,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,oBAAoB,CAAC,CAAA;IAEhE,QAAQ,SAAS,CAAC,MAAM,EAAE,CAAC;QACzB,KAAK,eAAe;YAClB,OAAO,wBAAwB,CAAC,qBAAqB,EAAE,cAAc,EAAE,SAAS,EAAE;gBAChF,WAAW,EAAE,KAAK;gBAClB,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAA;QACJ,KAAK,eAAe;YAClB,OAAO,wBAAwB,CAAC,qBAAqB,EAAE,cAAc,EAAE,SAAS,CAAC,CAAA;QACnF,KAAK,aAAa;YAChB,OAAO,wBAAwB,CAAC,qBAAqB,EAAE,YAAY,EAAE,SAAS,EAAE;gBAC9E,WAAW,EAAE,IAAI;gBACjB,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAA;QACJ,KAAK,aAAa;YAChB,OAAO,wBAAwB,CAAC,qBAAqB,EAAE,YAAY,EAAE,SAAS,EAAE;gBAC9E,WAAW,EAAE,IAAI;gBACjB,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAA;QACJ;YACE,MAAM,IAAI,KAAK,CAAC,oCAAoC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAA;IAC3E,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,49 @@
+import { Assertion as CoreAssertion, NumericAssertionBuilder, GeneralAssertionBuilder } from './internal/assertion.js';
+type DnsAssertionSource = 'RESPONSE_CODE' | 'RESPONSE_TIME' | 'TEXT_ANSWER' | 'JSON_ANSWER';
+export type DnsAssertion = CoreAssertion<DnsAssertionSource>;
+/**
+ * Builder class for creating DNS monitor assertions.
+ * Provides methods to create assertions for DNS query responses.
+ *
+ * @example
+ * ```typescript
+ * // Response time assertions
+ * DnsAssertionBuilder.responseTime().lessThan(1000)
+ * DnsAssertionBuilder.responseTime().greaterThan(100)
+ *
+ * // Response code assertions
+ * DnsAssertionBuilder.responseCode().equals('NOERROR')
+ * DnsAssertionBuilder.responseCode().equals('NXDOMAIN')
+ *
+ * // HTTPS record assertions (HTTP/3 advertisement)
+ * DnsAssertionBuilder.textAnswer('alpn="([^"]*)"').contains('h3')
+ * DnsAssertionBuilder.jsonAnswer('$.Answer[0].data').contains('h3')
+ * ```
+ */
+export declare class DnsAssertionBuilder {
+    /**
+     * Creates an assertion builder for DNS response codes.
+     * @returns A general assertion builder for the response code.
+     */
+    static responseCode(): GeneralAssertionBuilder<DnsAssertionSource>;
+    /**
+     * Creates an assertion builder for DNS response time.
+     * @returns A numeric assertion builder for response time in milliseconds.
+     */
+    static responseTime(): NumericAssertionBuilder<DnsAssertionSource, string>;
+    /**
+     * Creates an assertion builder for the answer in common plain text format.
+     * @param regex An optional regular expression with at least one capture
+     * group. If set, assertion operators will apply against the value of the
+     * first capture group instead of the entire answer.
+     * @returns A general assertion builder for the answer.
+     */
+    static textAnswer(regex?: string): GeneralAssertionBuilder<DnsAssertionSource>;
+    /**
+     * Creates an assertion builder for the JSON formatted answer.
+     * @param property Optional JSON path to specific property (e.g., '$.Answer[0].data')
+     * @returns A general assertion builder for the JSON formatted answer.
+     */
+    static jsonAnswer(property?: string): GeneralAssertionBuilder<DnsAssertionSource>;
+}
+export {};

package/dist/constructs/dns-assertion.js

@@ -0,0 +1,55 @@
+import { NumericAssertionBuilder, GeneralAssertionBuilder } from './internal/assertion.js';
+/**
+ * Builder class for creating DNS monitor assertions.
+ * Provides methods to create assertions for DNS query responses.
+ *
+ * @example
+ * ```typescript
+ * // Response time assertions
+ * DnsAssertionBuilder.responseTime().lessThan(1000)
+ * DnsAssertionBuilder.responseTime().greaterThan(100)
+ *
+ * // Response code assertions
+ * DnsAssertionBuilder.responseCode().equals('NOERROR')
+ * DnsAssertionBuilder.responseCode().equals('NXDOMAIN')
+ *
+ * // HTTPS record assertions (HTTP/3 advertisement)
+ * DnsAssertionBuilder.textAnswer('alpn="([^"]*)"').contains('h3')
+ * DnsAssertionBuilder.jsonAnswer('$.Answer[0].data').contains('h3')
+ * ```
+ */
+export class DnsAssertionBuilder {
+    /**
+     * Creates an assertion builder for DNS response codes.
+     * @returns A general assertion builder for the response code.
+     */
+    static responseCode() {
+        return new GeneralAssertionBuilder('RESPONSE_CODE');
+    }
+    /**
+     * Creates an assertion builder for DNS response time.
+     * @returns A numeric assertion builder for response time in milliseconds.
+     */
+    static responseTime() {
+        return new NumericAssertionBuilder('RESPONSE_TIME');
+    }
+    /**
+     * Creates an assertion builder for the answer in common plain text format.
+     * @param regex An optional regular expression with at least one capture
+     * group. If set, assertion operators will apply against the value of the
+     * first capture group instead of the entire answer.
+     * @returns A general assertion builder for the answer.
+     */
+    static textAnswer(regex) {
+        return new GeneralAssertionBuilder('TEXT_ANSWER', regex);
+    }
+    /**
+     * Creates an assertion builder for the JSON formatted answer.
+     * @param property Optional JSON path to specific property (e.g., '$.Answer[0].data')
+     * @returns A general assertion builder for the JSON formatted answer.
+     */
+    static jsonAnswer(property) {
+        return new GeneralAssertionBuilder('JSON_ANSWER', property);
+    }
+}
+//# sourceMappingURL=dns-assertion.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dns-assertion.js","sourceRoot":"","sources":["../../src/constructs/dns-assertion.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAA;AAUtH;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;OAGG;IACH,MAAM,CAAC,YAAY;QACjB,OAAO,IAAI,uBAAuB,CAAqB,eAAe,CAAC,CAAA;IACzE,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,YAAY;QACjB,OAAO,IAAI,uBAAuB,CAAqB,eAAe,CAAC,CAAA;IACzE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAE,KAAc;QAC/B,OAAO,IAAI,uBAAuB,CAAqB,aAAa,EAAE,KAAK,CAAC,CAAA;IAC9E,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAE,QAAiB;QAClC,OAAO,IAAI,uBAAuB,CAAqB,aAAa,EAAE,QAAQ,CAAC,CAAA;IACjF,CAAC;CACF"}

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

@@ -0,0 +1,13 @@
+import { Codegen, Context } from './internal/codegen/index.js';
+import { MonitorResource } from './monitor-codegen.js';
+import { DnsRequest } from './dns-request.js';
+export interface DnsMonitorResource extends MonitorResource {
+    checkType: 'DNS';
+    request: DnsRequest;
+    degradedResponseTime?: number;
+    maxResponseTime?: number;
+}
+export declare class DnsMonitorCodegen extends Codegen<DnsMonitorResource> {
+    describe(resource: DnsMonitorResource): string;
+    gencode(logicalId: string, resource: DnsMonitorResource, context: Context): void;
+}