feat: support status pages and services

Author: Antoine-C

packages/cli/src/constructs/index.ts

@@ -29,3 +29,5 @@ export * from './tcp-check'
 export * from './incidentio-alert-channel'
 export * from './msteams-alert-channel'
 export * from './telegram-alert-channel'
+export * from './status-page'
+export * from './status-pages-service'

packages/cli/src/constructs/project.ts

@@ -8,6 +8,7 @@ import type { Runtime } from '../rest/runtimes'
 import {
   Check, AlertChannelSubscription, AlertChannel, CheckGroup, MaintenanceWindow, Dashboard,
   PrivateLocation, HeartbeatCheck, PrivateLocationCheckAssignment, PrivateLocationGroupAssignment,
+  StatusPage, StatusPagesService,
 } from './'
 import { ResourceSync } from '../rest/projects'
 import { PrivateLocationApi } from '../rest/private-locations'
@@ -33,6 +34,8 @@ export interface ProjectData {
   'private-location-check-assignment': Record<string, PrivateLocationCheckAssignment>,
   'private-location-group-assignment': Record<string, PrivateLocationGroupAssignment>,
   dashboard: Record<string, Dashboard>,
+  'status-page': Record<string, StatusPage>,
+  'status-page-service': Record<string, StatusPagesService>,
 }
 
 export class Project extends Construct {
@@ -49,6 +52,8 @@ export class Project extends Construct {
     'private-location-check-assignment': {},
     'private-location-group-assignment': {},
     dashboard: {},
+    'status-page': {},
+    'status-page-service': {},
   }
 
   static readonly __checklyType = 'project'
@@ -99,6 +104,8 @@ export class Project extends Construct {
         ...this.synthesizeRecord(this.data['private-location-check-assignment']),
         ...this.synthesizeRecord(this.data['private-location-group-assignment']),
         ...this.synthesizeRecord(this.data.dashboard),
+        ...this.synthesizeRecord(this.data['status-page-service']),
+        ...this.synthesizeRecord(this.data['status-page']),
       ],
     }
   }

packages/cli/src/constructs/status-page.ts

@@ -0,0 +1,93 @@
+import { Construct } from './construct'
+import { Session } from './project'
+import { StatusPagesService } from './status-pages-service'
+import { Ref } from './ref'
+
+export interface StatusPagesCardProps {
+  name: string
+  services?: Array<StatusPagesService>
+}
+
+export interface StatusPageProps {
+  name: string
+  url?: string
+  cards?: StatusPagesCardProps[]
+  /**
+   * A subdomain name under "checklyhq.com". Needs to be unique across all users.
+   * This is required if 'customDomain' is not specified.
+   */
+  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.
+   */
+  customDomain?: string
+  /**
+   * A URL pointing to an image file.
+   */
+  logo?: string
+  /**
+   * A URL pointing to an image file used as dashboard favicon.
+   */
+  favicon?: string
+}
+
+/**
+ * Creates a Dashboard
+ *
+ * @remarks
+ *
+ * This class make use of the Dashboard endpoints.
+ */
+export class StatusPage extends Construct {
+  name: string
+  cardsServices?: null | Array<{name: string, services: Array<{ref: Ref}>}>
+  cards?: StatusPagesCardProps[]
+  url?: string
+  customDomain?: string
+  logo?: string
+  favicon?: string
+
+  static readonly __checklyType = 'status-page'
+
+  /**
+   * Constructs the Dashboard instance
+   *
+   * @param logicalId unique project-scoped resource name identification
+   * @param props dashboard configuration properties
+   *
+   * {@link https://checklyhq.com/docs/cli/constructs-reference/#dashboard Read more in the docs}
+   */
+  constructor (logicalId: string, props: StatusPageProps) {
+    super(StatusPage.__checklyType, logicalId)
+    this.name = props.name
+    this.url = props.url
+    this.cards = props.cards
+    this.customDomain = props.customDomain
+    this.logo = props.logo
+    this.favicon = props.favicon
+    this.cardsServices = null
+
+    if (!props.url && !props.customDomain) {
+      throw new Error('Either a "customUrl" or "customDomain" must be specified.')
+    }
+
+    Session.registerConstruct(this)
+  }
+
+  synthesize (): any|null {
+    return {
+      name: this.name,
+      url: this.url,
+      customDomain: this.customDomain,
+      logo: this.logo,
+      favicon: this.favicon,
+      cards: this.cards?.map(card => ({
+        name: card.name,
+        services: card
+          .services
+          ?.map((service) => Ref.from(service.logicalId)),
+      })),
+    }
+  }
+}

packages/cli/src/constructs/status-pages-service.ts

@@ -0,0 +1,40 @@
+import { Construct } from './construct'
+import { Session } from './project'
+
+export interface StatusPagesServiceProps {
+  name: string
+}
+
+/**
+ * Creates a Dashboard
+ *
+ * @remarks
+ *
+ * This class make use of the Dashboard endpoints.
+ */
+export class StatusPagesService extends Construct {
+  name: string
+
+  static readonly __checklyType = 'status-page-service'
+
+  /**
+   * Constructs the Dashboard instance
+   *
+   * @param logicalId unique project-scoped resource name identification
+   * @param props dashboard configuration properties
+   *
+   * {@link https://checklyhq.com/docs/cli/constructs-reference/#dashboard Read more in the docs}
+   */
+  constructor (logicalId: string, props: StatusPagesServiceProps) {
+    super(StatusPagesService.__checklyType, logicalId)
+    this.name = props.name
+
+    Session.registerConstruct(this)
+  }
+
+  synthesize (): any|null {
+    return {
+      name: this.name,
+    }
+  }
+}