checkly 0.0.0-canary.7b9cf29

package/dist/constructs/construct.d.ts

@@ -0,0 +1,142 @@
+import { Diagnostics } from './diagnostics.js';
+import { Ref } from './ref.js';
+import { Bundler } from '../services/check-parser/bundler.js';
+/**
+ * Base interface for construct-like objects in the Checkly CLI system.
+ * Used for type checking and identifying construct objects.
+ */
+export interface ConstructLike {
+    /** The type identifier of the construct */
+    type: string;
+    /** Unique logical identifier within the project scope */
+    logicalId: string;
+}
+/**
+ * Interface for objects that can be bundled into a synthesizable representation.
+ * Provides the contract for converting constructs into their deployable form.
+ */
+export interface Bundle {
+    /** Synthesizes the construct into its deployable representation */
+    synthesize(): any | null;
+}
+/**
+ * Interface for constructs that can be validated.
+ * Provides the contract for validating construct configuration and reporting issues.
+ */
+export interface Validate {
+    /**
+     * Validates the construct, reporting any issues via the provided diagnostics.
+     * @param diagnostics The diagnostics instance to add any validation issues to
+     */
+    validate(diagnostics: Diagnostics): Promise<void>;
+}
+/**
+ * Abstract base class for all constructs in the Checkly CLI system.
+ * Provides common functionality for validation, bundling, and resource management.
+ *
+ * This class is extended by all built-in constructs like ApiCheck, BrowserCheck, etc.
+ * It should not be extended directly by user code.
+ */
+export declare abstract class Construct implements Validate, Bundle {
+    /** The type identifier of the construct */
+    type: string;
+    /** Unique logical identifier within the project scope */
+    logicalId: string;
+    /** Physical identifier from the Checkly API (if exists) */
+    physicalId?: string | number;
+    /** Whether this construct is a member of the project */
+    member: boolean;
+    /** Absolute path to the check file that created this construct */
+    checkFileAbsolutePath?: string;
+    /**
+     * Creates a new construct instance.
+     *
+     * @param type The type identifier for this construct
+     * @param logicalId Unique logical identifier within the project scope
+     * @param physicalId Optional physical identifier from the Checkly API
+     * @param member Whether this construct is a member of the project
+     */
+    constructor(type: string, logicalId: string, physicalId?: string | number, member?: boolean);
+    /**
+     * @returns A unique description of the Construct instance.
+     */
+    abstract describe(): string;
+    /**
+     * Creates a reference to this construct that can be used in other constructs.
+     *
+     * @returns A reference object that can be used to link to this construct
+     */
+    ref(): Ref;
+    /**
+     * Determines whether this construct is allowed to be referenced in checkly.config.ts.
+     * Most constructs should not be directly referenced in the config file.
+     *
+     * @returns true if this construct can be used in checkly.config.ts, false otherwise
+     */
+    allowInChecklyConfig(): boolean;
+    /**
+     * Resolves a content file path relative to the check file that created this construct.
+     * If the path is already absolute, returns it as-is.
+     *
+     * @param contentPath The relative or absolute path to resolve
+     * @returns The absolute path to the content file
+     * @throws Error if checkFileAbsolutePath is not set and a relative path is provided
+     */
+    resolveContentFilePath(contentPath: string): string;
+    /**
+     * Validates the Construct, allowing multiple issues to be brought into
+     * attention via the provided Diagnostics.
+     *
+     * @param diagnostics The Diagnostics instance that any issues should be added to.
+     * @returns A Promise that resolves when validation is complete.
+     */
+    validate(diagnostics: Diagnostics): Promise<void>;
+    /**
+     * Bundles the Construct into a representation that can be synthesized. By
+     * default, that representation is the Construct itself, but a different
+     * representation may also be returned.
+     *
+     * Can be used to perform heavier tasks that the Construct constructor may
+     * not be suitable for.
+     *
+     * @returns A Promise that resolves to the bundled representation of the Construct.
+     */
+    bundle(bundler: Bundler): Promise<Bundle>;
+    /**
+     * Synthesizes the construct into its deployable representation.
+     * This method must be implemented by all concrete construct classes.
+     *
+     * @returns The synthesized representation of the construct, or null if not applicable
+     */
+    abstract synthesize(): any | null;
+}
+/**
+ * Interface for script configurations that reference an external file.
+ * Used when script code is stored in a separate file rather than inline.
+ */
+export interface Entrypoint {
+    /** Path to the script file, relative to the check file or absolute */
+    entrypoint: string;
+}
+/**
+ * Type guard to check if a value is an Entrypoint object.
+ *
+ * @param value The value to check
+ * @returns true if the value is an Entrypoint, false otherwise
+ */
+export declare function isEntrypoint(value: any): value is Entrypoint;
+/**
+ * Interface for script configurations that contain inline code.
+ * Used when script code is provided directly as a string.
+ */
+export interface Content {
+    /** The inline script content as a string */
+    content: string;
+}
+/**
+ * Type guard to check if a value is a Content object.
+ *
+ * @param value The value to check
+ * @returns true if the value is a Content, false otherwise
+ */
+export declare function isContent(value: any): value is Content;

package/dist/constructs/construct.js

@@ -0,0 +1,120 @@
+import path from 'node:path';
+import { LOGICAL_ID_PATTERN } from '../constants.js';
+import { InvalidPropertyValueDiagnostic } from './construct-diagnostics.js';
+import { Session } from './session.js';
+import { Ref } from './ref.js';
+/**
+ * Abstract base class for all constructs in the Checkly CLI system.
+ * Provides common functionality for validation, bundling, and resource management.
+ *
+ * This class is extended by all built-in constructs like ApiCheck, BrowserCheck, etc.
+ * It should not be extended directly by user code.
+ */
+export class Construct {
+    /** The type identifier of the construct */
+    type;
+    /** Unique logical identifier within the project scope */
+    logicalId;
+    /** Physical identifier from the Checkly API (if exists) */
+    physicalId;
+    /** Whether this construct is a member of the project */
+    member;
+    /** Absolute path to the check file that created this construct */
+    checkFileAbsolutePath;
+    /**
+     * Creates a new construct instance.
+     *
+     * @param type The type identifier for this construct
+     * @param logicalId Unique logical identifier within the project scope
+     * @param physicalId Optional physical identifier from the Checkly API
+     * @param member Whether this construct is a member of the project
+     */
+    constructor(type, logicalId, physicalId, member) {
+        this.logicalId = logicalId;
+        this.type = type;
+        this.physicalId = physicalId;
+        this.member = member ?? true;
+        this.checkFileAbsolutePath = Session.checkFileAbsolutePath;
+        Session.validateCreateConstruct(this);
+    }
+    /**
+     * Creates a reference to this construct that can be used in other constructs.
+     *
+     * @returns A reference object that can be used to link to this construct
+     */
+    ref() {
+        return Ref.from(this.logicalId);
+    }
+    /**
+     * Determines whether this construct is allowed to be referenced in checkly.config.ts.
+     * Most constructs should not be directly referenced in the config file.
+     *
+     * @returns true if this construct can be used in checkly.config.ts, false otherwise
+     */
+    allowInChecklyConfig() {
+        return false;
+    }
+    /**
+     * Resolves a content file path relative to the check file that created this construct.
+     * If the path is already absolute, returns it as-is.
+     *
+     * @param contentPath The relative or absolute path to resolve
+     * @returns The absolute path to the content file
+     * @throws Error if checkFileAbsolutePath is not set and a relative path is provided
+     */
+    resolveContentFilePath(contentPath) {
+        if (path.isAbsolute(contentPath)) {
+            return contentPath;
+        }
+        if (!this.checkFileAbsolutePath) {
+            throw new Error('Internal error: attempting to use relative content file path without checkFileAbsolutePath set');
+        }
+        return path.join(path.dirname(this.checkFileAbsolutePath), contentPath);
+    }
+    /**
+     * Validates the Construct, allowing multiple issues to be brought into
+     * attention via the provided Diagnostics.
+     *
+     * @param diagnostics The Diagnostics instance that any issues should be added to.
+     * @returns A Promise that resolves when validation is complete.
+     */
+    // eslint-disable-next-line require-await
+    async validate(diagnostics) {
+        if (!LOGICAL_ID_PATTERN.test(this.logicalId)) {
+            diagnostics.add(new InvalidPropertyValueDiagnostic('logicalId', new Error(`"${this.logicalId}" contains invalid characters. Only A-Z, a-z, 0-9, _, -, /, #, and . are allowed.`)));
+        }
+    }
+    /**
+     * Bundles the Construct into a representation that can be synthesized. By
+     * default, that representation is the Construct itself, but a different
+     * representation may also be returned.
+     *
+     * Can be used to perform heavier tasks that the Construct constructor may
+     * not be suitable for.
+     *
+     * @returns A Promise that resolves to the bundled representation of the Construct.
+     */
+    // eslint-disable-next-line require-await, @typescript-eslint/no-unused-vars
+    async bundle(bundler) {
+        return this;
+    }
+}
+/**
+ * Type guard to check if a value is an Entrypoint object.
+ *
+ * @param value The value to check
+ * @returns true if the value is an Entrypoint, false otherwise
+ */
+export function isEntrypoint(value) {
+    return 'entrypoint' in Object(value);
+}
+/**
+ * Type guard to check if a value is a Content object.
+ *
+ * @param value The value to check
+ * @returns true if the value is a Content, false otherwise
+ */
+export function isContent(value) {
+    return 'content' in Object(value);
+}
+//# sourceMappingURL=construct.js.map

package/dist/constructs/construct.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"construct.js","sourceRoot":"","sources":["../../src/constructs/construct.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAA;AAE5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAA;AAE3E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAmC9B;;;;;;GAMG;AACH,MAAM,OAAgB,SAAS;IAC7B,2CAA2C;IAC3C,IAAI,CAAQ;IACZ,yDAAyD;IACzD,SAAS,CAAQ;IACjB,2DAA2D;IAC3D,UAAU,CAAkB;IAC5B,wDAAwD;IACxD,MAAM,CAAS;IACf,kEAAkE;IAClE,qBAAqB,CAAS;IAE9B;;;;;;;OAOG;IACH,YAAa,IAAY,EAAE,SAAiB,EAAE,UAA4B,EAAE,MAAgB;QAC1F,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,IAAI,CAAA;QAC5B,IAAI,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAA;QAC1D,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAA;IACvC,CAAC;IAOD;;;;OAIG;IACH,GAAG;QACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACjC,CAAC;IAED;;;;;OAKG;IACH,oBAAoB;QAClB,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CAAE,WAAmB;QACzC,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACjC,OAAO,WAAW,CAAA;QACpB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,gGAAgG,CAAC,CAAA;QACnH,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,EAAE,WAAW,CAAC,CAAA;IACzE,CAAC;IAED;;;;;;OAMG;IACH,yCAAyC;IACzC,KAAK,CAAC,QAAQ,CAAE,WAAwB;QACtC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7C,WAAW,CAAC,GAAG,CAAC,IAAI,8BAA8B,CAChD,WAAW,EACX,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,mFAAmF,CAAC,CACjH,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,4EAA4E;IAC5E,KAAK,CAAC,MAAM,CAAE,OAAgB;QAC5B,OAAO,IAAI,CAAA;IACb,CAAC;CASF;AAWD;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAE,KAAU;IACtC,OAAO,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,CAAA;AACtC,CAAC;AAWD;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAE,KAAU;IACnC,OAAO,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,CAAA;AACnC,CAAC"}

package/dist/constructs/dashboard-bundle.d.ts

@@ -0,0 +1,11 @@
+import { Bundle } from './construct.js';
+import { Dashboard } from './dashboard.js';
+export interface DashboardBundleProps {
+    customCSS?: string;
+}
+export declare class DashboardBundle implements Bundle {
+    dashboard: Dashboard;
+    customCSS?: string;
+    constructor(dashboard: Dashboard, props: DashboardBundleProps);
+    synthesize(): any;
+}

package/dist/constructs/dashboard-bundle.js

@@ -0,0 +1,15 @@
+export class DashboardBundle {
+    dashboard;
+    customCSS;
+    constructor(dashboard, props) {
+        this.dashboard = dashboard;
+        this.customCSS = props.customCSS;
+    }
+    synthesize() {
+        return {
+            ...this.dashboard.synthesize(),
+            customCSS: this.customCSS,
+        };
+    }
+}
+//# sourceMappingURL=dashboard-bundle.js.map

package/dist/constructs/dashboard-bundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashboard-bundle.js","sourceRoot":"","sources":["../../src/constructs/dashboard-bundle.ts"],"names":[],"mappings":"AAOA,MAAM,OAAO,eAAe;IAC1B,SAAS,CAAW;IACpB,SAAS,CAAS;IAElB,YAAa,SAAoB,EAAE,KAA2B;QAC5D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;IAClC,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE;YAC9B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAA;IACH,CAAC;CACF"}

package/dist/constructs/dashboard-codegen.d.ts

@@ -0,0 +1,29 @@
+import { Codegen, Context } from './internal/codegen/index.js';
+export interface DashboardResource {
+    tags?: string[];
+    customUrl?: string;
+    customDomain?: string;
+    logo?: string;
+    favicon?: string;
+    link?: string;
+    header?: string;
+    description?: string;
+    width?: string;
+    refreshRate?: number;
+    paginate?: boolean;
+    paginationRate?: number;
+    checksPerPage?: number;
+    useTagsAndOperator?: boolean;
+    hideTags?: boolean;
+    enableIncidents?: boolean;
+    expandChecks?: boolean;
+    showHeader?: boolean;
+    customCSS?: string;
+    isPrivate?: boolean;
+    showP95?: boolean;
+    showP99?: boolean;
+}
+export declare class DashboardCodegen extends Codegen<DashboardResource> {
+    describe(resource: DashboardResource): string;
+    gencode(logicalId: string, resource: DashboardResource, context: Context): void;
+}

package/dist/constructs/dashboard-codegen.js

@@ -0,0 +1,104 @@
+import { Codegen } from './internal/codegen/index.js';
+import { expr, ident } from '../sourcegen/index.js';
+const construct = 'Dashboard';
+export class DashboardCodegen extends Codegen {
+    describe(resource) {
+        if (resource.header) {
+            return `Dashboard: ${resource.header}`;
+        }
+        return 'Dashboard';
+    }
+    gencode(logicalId, resource, context) {
+        const filePath = context.filePath('resources/dashboards', resource.header ?? logicalId, {
+            isolate: true,
+            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 => {
+                    if (resource.tags) {
+                        const tags = resource.tags;
+                        if (tags.length > 0) {
+                            builder.array('tags', builder => {
+                                for (const tag of tags) {
+                                    builder.string(tag);
+                                }
+                            });
+                        }
+                    }
+                    if (resource.customUrl) {
+                        builder.string('customUrl', resource.customUrl);
+                    }
+                    if (resource.customDomain) {
+                        builder.string('customDomain', resource.customDomain);
+                    }
+                    if (resource.logo) {
+                        builder.string('logo', resource.logo);
+                    }
+                    if (resource.favicon) {
+                        builder.string('favicon', resource.favicon);
+                    }
+                    if (resource.link) {
+                        builder.string('link', resource.link);
+                    }
+                    if (resource.header) {
+                        builder.string('header', resource.header);
+                    }
+                    if (resource.description) {
+                        builder.string('description', resource.description);
+                    }
+                    if (resource.width) {
+                        builder.string('width', resource.width);
+                    }
+                    if (resource.refreshRate) {
+                        builder.number('refreshRate', resource.refreshRate);
+                    }
+                    if (resource.paginate !== undefined) {
+                        builder.boolean('paginate', resource.paginate);
+                    }
+                    if (resource.paginationRate) {
+                        builder.number('paginationRate', resource.paginationRate);
+                    }
+                    if (resource.checksPerPage) {
+                        builder.number('checksPerPage', resource.checksPerPage);
+                    }
+                    if (resource.useTagsAndOperator !== undefined) {
+                        builder.boolean('useTagsAndOperator', resource.useTagsAndOperator);
+                    }
+                    if (resource.hideTags !== undefined) {
+                        builder.boolean('hideTags', resource.hideTags);
+                    }
+                    if (resource.enableIncidents !== undefined) {
+                        builder.boolean('enableIncidents', resource.enableIncidents);
+                    }
+                    if (resource.expandChecks !== undefined) {
+                        builder.boolean('expandChecks', resource.expandChecks);
+                    }
+                    if (resource.showHeader !== undefined) {
+                        builder.boolean('showHeader', resource.showHeader);
+                    }
+                    if (resource.customCSS) {
+                        const content = resource.customCSS;
+                        builder.object('customCSS', builder => {
+                            const cssFile = this.program.staticStyleFile(`${file.dirname}/style`, content);
+                            builder.string('entrypoint', file.relativePath(cssFile));
+                        });
+                    }
+                    if (resource.isPrivate !== undefined) {
+                        builder.boolean('isPrivate', resource.isPrivate);
+                    }
+                    if (resource.showP95 !== undefined) {
+                        builder.boolean('showP95', resource.showP95);
+                    }
+                    if (resource.showP99 !== undefined) {
+                        builder.boolean('showP99', resource.showP99);
+                    }
+                });
+            });
+        }));
+    }
+}
+//# sourceMappingURL=dashboard-codegen.js.map

package/dist/constructs/dashboard-codegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashboard-codegen.js","sourceRoot":"","sources":["../../src/constructs/dashboard-codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAW,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AA2BnD,MAAM,SAAS,GAAG,WAAW,CAAA;AAE7B,MAAM,OAAO,gBAAiB,SAAQ,OAA0B;IAC9D,QAAQ,CAAE,QAA2B;QACnC,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,cAAc,QAAQ,CAAC,MAAM,EAAE,CAAA;QACxC,CAAC;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,OAAO,CAAE,SAAiB,EAAE,QAA2B,EAAE,OAAgB;QACvE,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,sBAAsB,EAAE,QAAQ,CAAC,MAAM,IAAI,SAAS,EAAE;YACtF,OAAO,EAAE,IAAI;YACb,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,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;wBAClB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAA;wBAC1B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BACpB,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;gCAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oCACvB,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gCACrB,CAAC;4BACH,CAAC,CAAC,CAAA;wBACJ,CAAC;oBACH,CAAC;oBAED,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;wBACvB,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;oBACjD,CAAC;oBAED,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;wBAC1B,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;oBACvD,CAAC;oBAED,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;wBAClB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;oBACvC,CAAC;oBAED,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;wBACrB,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;oBAC7C,CAAC;oBAED,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;wBAClB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;oBACvC,CAAC;oBAED,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;wBACpB,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;oBAC3C,CAAC;oBAED,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;wBACzB,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAA;oBACrD,CAAC;oBAED,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;wBACnB,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;oBACzC,CAAC;oBAED,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;wBACzB,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAA;oBACrD,CAAC;oBAED,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;wBACpC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;oBAChD,CAAC;oBAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;wBAC5B,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAA;oBAC3D,CAAC;oBAED,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;wBAC3B,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAA;oBACzD,CAAC;oBAED,IAAI,QAAQ,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;wBAC9C,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAA;oBACpE,CAAC;oBAED,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;wBACpC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;oBAChD,CAAC;oBAED,IAAI,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;wBAC3C,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAA;oBAC9D,CAAC;oBAED,IAAI,QAAQ,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;wBACxC,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;oBACxD,CAAC;oBAED,IAAI,QAAQ,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;wBACtC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;oBACpD,CAAC;oBAED,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;wBACvB,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAA;wBAClC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE;4BACpC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,OAAO,QAAQ,EAAE,OAAO,CAAC,CAAA;4BAC9E,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;wBAC1D,CAAC,CAAC,CAAA;oBACJ,CAAC;oBAED,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;wBACrC,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;oBAClD,CAAC;oBAED,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;wBACnC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;oBAC9C,CAAC;oBAED,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;wBACnC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;oBAC9C,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAC,CAAA;IACL,CAAC;CACF"}

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;
+}