@openstatus/sdk-node 0.1.0 → 0.1.2

package/README.md

@@ -4,14 +4,21 @@
 [![npm](https://img.shields.io/npm/v/@openstatus/sdk-node)](https://www.npmjs.com/package/@openstatus/sdk-node)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Official Node.js SDK for [OpenStatus](https://openstatus.dev) - The open-source status page with uptime monitoring.
+Official Node.js SDK for [OpenStatus](https://openstatus.dev) - The open-source
+status page with uptime monitoring.
 
 ## Features
 
 ### Status Page
-- **Status Reports** - Manage incident and maintenance reports with update timelines
+
+- **Status Pages** - Create and manage public status pages with custom domains
+- **Page Components** - Add monitor-based or static components with grouping
+- **Subscribers** - Manage email subscriptions for status updates
+- **Status Reports** - Manage incident reports with update timelines
+- **Maintenance Windows** - Schedule and manage planned maintenance periods
 
 ### Monitoring
+
 - **HTTP Monitoring** - Monitor websites and APIs with customizable assertions
 - **TCP Monitoring** - Check database connections and other TCP services
 - **DNS Monitoring** - Verify DNS records and resolution
@@ -380,7 +387,10 @@ const { statusReports, totalSize } = await openstatus.statusReport.v1
     {
       limit: 10,
       offset: 0,
-      statuses: [StatusReportStatus.INVESTIGATING, StatusReportStatus.IDENTIFIED],
+      statuses: [
+        StatusReportStatus.INVESTIGATING,
+        StatusReportStatus.IDENTIFIED,
+      ],
     },
     { headers },
   );
@@ -428,7 +438,8 @@ const { statusReport } = await openstatus.statusReport.v1.StatusReportService
     {
       statusReportId: "sr_123",
       status: StatusReportStatus.IDENTIFIED,
-      message: "The issue has been identified as a database connection problem.",
+      message:
+        "The issue has been identified as a database connection problem.",
       date: "2024-01-15T11:00:00", // optional, defaults to current time
       notify: true,
     },
@@ -438,13 +449,425 @@ const { statusReport } = await openstatus.statusReport.v1.StatusReportService
 
 ### Status Report Status
 
-| Enum Value      | Description                     |
-| --------------- | ------------------------------- |
-| `UNSPECIFIED`   | Default/unspecified status      |
+| Enum Value      | Description                      |
+| --------------- | -------------------------------- |
+| `UNSPECIFIED`   | Default/unspecified status       |
 | `INVESTIGATING` | Actively investigating the issue |
-| `IDENTIFIED`    | Root cause has been identified  |
-| `MONITORING`    | Fix deployed, monitoring        |
-| `RESOLVED`      | Issue fully resolved            |
+| `IDENTIFIED`    | Root cause has been identified   |
+| `MONITORING`    | Fix deployed, monitoring         |
+| `RESOLVED`      | Issue fully resolved             |
+
+### Status Page Service
+
+Manage status pages, components, and subscribers.
+
+#### `createStatusPage(request, options)`
+
+Create a new status page.
+
+```typescript
+const { statusPage } = await openstatus.statusPage.v1.StatusPageService
+  .createStatusPage(
+    {
+      title: "My Service Status",
+      slug: "my-service",
+      description: "Status page for My Service",
+      homepageUrl: "https://example.com",
+      contactUrl: "https://example.com/contact",
+    },
+    { headers },
+  );
+
+console.log(`Status page created: ${statusPage?.id}`);
+```
+
+#### `getStatusPage(request, options)`
+
+Get a status page by ID.
+
+```typescript
+const { statusPage } = await openstatus.statusPage.v1.StatusPageService
+  .getStatusPage(
+    { id: "page_123" },
+    { headers },
+  );
+```
+
+#### `listStatusPages(request, options)`
+
+List all status pages with pagination.
+
+```typescript
+const { statusPages, totalSize } = await openstatus.statusPage.v1
+  .StatusPageService.listStatusPages(
+    { limit: 10, offset: 0 },
+    { headers },
+  );
+
+console.log(`Found ${totalSize} status pages`);
+```
+
+#### `updateStatusPage(request, options)`
+
+Update a status page.
+
+```typescript
+const { statusPage } = await openstatus.statusPage.v1.StatusPageService
+  .updateStatusPage(
+    {
+      id: "page_123",
+      title: "Updated Title",
+      description: "Updated description",
+    },
+    { headers },
+  );
+```
+
+#### `deleteStatusPage(request, options)`
+
+Delete a status page.
+
+```typescript
+const { success } = await openstatus.statusPage.v1.StatusPageService
+  .deleteStatusPage(
+    { id: "page_123" },
+    { headers },
+  );
+```
+
+#### `addMonitorComponent(request, options)`
+
+Add a monitor-based component to a status page.
+
+```typescript
+const { component } = await openstatus.statusPage.v1.StatusPageService
+  .addMonitorComponent(
+    {
+      pageId: "page_123",
+      monitorId: "mon_456",
+      name: "API Server",
+      description: "Main API endpoint",
+      order: 1,
+    },
+    { headers },
+  );
+```
+
+#### `addStaticComponent(request, options)`
+
+Add a static component (not linked to a monitor).
+
+```typescript
+const { component } = await openstatus.statusPage.v1.StatusPageService
+  .addStaticComponent(
+    {
+      pageId: "page_123",
+      name: "Third-party Service",
+      description: "External dependency",
+      order: 2,
+    },
+    { headers },
+  );
+```
+
+#### `updateComponent(request, options)`
+
+Update a component.
+
+```typescript
+const { component } = await openstatus.statusPage.v1.StatusPageService
+  .updateComponent(
+    {
+      id: "comp_123",
+      name: "Updated Component Name",
+      order: 3,
+    },
+    { headers },
+  );
+```
+
+#### `removeComponent(request, options)`
+
+Remove a component from a status page.
+
+```typescript
+const { success } = await openstatus.statusPage.v1.StatusPageService
+  .removeComponent(
+    { id: "comp_123" },
+    { headers },
+  );
+```
+
+#### `createComponentGroup(request, options)`
+
+Create a component group.
+
+```typescript
+const { group } = await openstatus.statusPage.v1.StatusPageService
+  .createComponentGroup(
+    {
+      pageId: "page_123",
+      name: "Core Services",
+    },
+    { headers },
+  );
+```
+
+#### `updateComponentGroup(request, options)`
+
+Update a component group.
+
+```typescript
+const { group } = await openstatus.statusPage.v1.StatusPageService
+  .updateComponentGroup(
+    {
+      id: "group_123",
+      name: "Updated Group Name",
+    },
+    { headers },
+  );
+```
+
+#### `deleteComponentGroup(request, options)`
+
+Delete a component group.
+
+```typescript
+const { success } = await openstatus.statusPage.v1.StatusPageService
+  .deleteComponentGroup(
+    { id: "group_123" },
+    { headers },
+  );
+```
+
+#### `subscribeToPage(request, options)`
+
+Subscribe an email to status page updates.
+
+```typescript
+const { subscriber } = await openstatus.statusPage.v1.StatusPageService
+  .subscribeToPage(
+    {
+      pageId: "page_123",
+      email: "user@example.com",
+    },
+    { headers },
+  );
+```
+
+#### `unsubscribeFromPage(request, options)`
+
+Unsubscribe from a status page.
+
+```typescript
+// By email
+const { success } = await openstatus.statusPage.v1.StatusPageService
+  .unsubscribeFromPage(
+    {
+      pageId: "page_123",
+      identifier: { case: "email", value: "user@example.com" },
+    },
+    { headers },
+  );
+
+// Or by subscriber ID
+const { success: success2 } = await openstatus.statusPage.v1.StatusPageService
+  .unsubscribeFromPage(
+    {
+      pageId: "page_123",
+      identifier: { case: "id", value: "sub_456" },
+    },
+    { headers },
+  );
+```
+
+#### `listSubscribers(request, options)`
+
+List all subscribers for a status page.
+
+```typescript
+const { subscribers, totalSize } = await openstatus.statusPage.v1
+  .StatusPageService.listSubscribers(
+    {
+      pageId: "page_123",
+      limit: 50,
+      offset: 0,
+      includeUnsubscribed: false,
+    },
+    { headers },
+  );
+```
+
+#### `getStatusPageContent(request, options)`
+
+Get full status page content including components, groups, and active reports.
+
+```typescript
+const content = await openstatus.statusPage.v1.StatusPageService
+  .getStatusPageContent(
+    { identifier: { case: "slug", value: "my-service" } },
+    { headers },
+  );
+
+console.log(`Page: ${content.statusPage?.title}`);
+console.log(`Components: ${content.components.length}`);
+console.log(`Active reports: ${content.statusReports.length}`);
+```
+
+#### `getOverallStatus(request, options)`
+
+Get the aggregated status of a status page.
+
+```typescript
+import { OverallStatus } from "@openstatus/sdk-node";
+
+const { overallStatus, componentStatuses } = await openstatus.statusPage.v1
+  .StatusPageService.getOverallStatus(
+    { identifier: { case: "id", value: "page_123" } },
+    { headers },
+  );
+
+console.log(`Overall: ${OverallStatus[overallStatus]}`);
+for (const { componentId, status } of componentStatuses) {
+  console.log(`  ${componentId}: ${OverallStatus[status]}`);
+}
+```
+
+### Maintenance Service
+
+Manage scheduled maintenance windows.
+
+#### `createMaintenance(request, options)`
+
+Create a new maintenance window.
+
+```typescript
+const { maintenance } = await openstatus.maintenance.v1.MaintenanceService
+  .createMaintenance(
+    {
+      title: "Database Upgrade",
+      message: "We will be upgrading our database infrastructure.",
+      from: "2024-01-20T02:00:00Z",
+      to: "2024-01-20T04:00:00Z",
+      pageId: "page_123",
+      pageComponentIds: ["comp_456"],
+      notify: true,
+    },
+    { headers },
+  );
+
+console.log(`Maintenance created: ${maintenance?.id}`);
+```
+
+#### `getMaintenance(request, options)`
+
+Get a maintenance window by ID.
+
+```typescript
+const { maintenance } = await openstatus.maintenance.v1.MaintenanceService
+  .getMaintenance(
+    { id: "maint_123" },
+    { headers },
+  );
+
+console.log(`Title: ${maintenance?.title}`);
+console.log(`From: ${maintenance?.from}`);
+console.log(`To: ${maintenance?.to}`);
+```
+
+#### `listMaintenances(request, options)`
+
+List all maintenance windows with pagination and optional filtering.
+
+```typescript
+const { maintenances, totalSize } = await openstatus.maintenance.v1
+  .MaintenanceService.listMaintenances(
+    {
+      limit: 10,
+      offset: 0,
+      pageId: "page_123", // optional filter
+    },
+    { headers },
+  );
+
+console.log(`Found ${totalSize} maintenance windows`);
+```
+
+#### `updateMaintenance(request, options)`
+
+Update a maintenance window.
+
+```typescript
+const { maintenance } = await openstatus.maintenance.v1.MaintenanceService
+  .updateMaintenance(
+    {
+      id: "maint_123",
+      title: "Extended Database Upgrade",
+      to: "2024-01-20T06:00:00Z",
+    },
+    { headers },
+  );
+```
+
+#### `deleteMaintenance(request, options)`
+
+Delete a maintenance window.
+
+```typescript
+const { success } = await openstatus.maintenance.v1.MaintenanceService
+  .deleteMaintenance(
+    { id: "maint_123" },
+    { headers },
+  );
+```
+
+### Status Page Options
+
+| Option        | Type   | Required | Description                              |
+| ------------- | ------ | -------- | ---------------------------------------- |
+| `title`       | string | Yes      | Title of the status page (max 256 chars) |
+| `slug`        | string | Yes      | URL-friendly slug (lowercase, hyphens)   |
+| `description` | string | No       | Description (max 2048 chars)             |
+| `homepageUrl` | string | No       | Link to your homepage                    |
+| `contactUrl`  | string | No       | Link to your contact page                |
+
+### Page Access Type
+
+| Enum Value           | Description             |
+| -------------------- | ----------------------- |
+| `UNSPECIFIED`        | Default/unspecified     |
+| `PUBLIC`             | Publicly accessible     |
+| `PASSWORD_PROTECTED` | Requires password       |
+| `AUTHENTICATED`      | Requires authentication |
+
+### Page Theme
+
+| Enum Value    | Description         |
+| ------------- | ------------------- |
+| `UNSPECIFIED` | Default/unspecified |
+| `SYSTEM`      | Follow system theme |
+| `LIGHT`       | Light theme         |
+| `DARK`        | Dark theme          |
+
+### Overall Status
+
+| Enum Value       | Description                 |
+| ---------------- | --------------------------- |
+| `UNSPECIFIED`    | Default/unspecified         |
+| `OPERATIONAL`    | All systems operational     |
+| `DEGRADED`       | Performance is degraded     |
+| `PARTIAL_OUTAGE` | Some systems are down       |
+| `MAJOR_OUTAGE`   | Major systems are down      |
+| `MAINTENANCE`    | Scheduled maintenance       |
+| `UNKNOWN`        | Status cannot be determined |
+
+### Page Component Type
+
+| Enum Value    | Description               |
+| ------------- | ------------------------- |
+| `UNSPECIFIED` | Default/unspecified       |
+| `MONITOR`     | Linked to a monitor       |
+| `STATIC`      | Static component (manual) |
 
 ## Monitor Options
 

package/esm/gen/openstatus/maintenance/v1/maintenance_pb.d.ts

@@ -0,0 +1,139 @@
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file openstatus/maintenance/v1/maintenance.proto.
+ */
+export declare const file_openstatus_maintenance_v1_maintenance: GenFile;
+/**
+ * MaintenanceSummary represents metadata for a maintenance window (used in list responses).
+ *
+ * @generated from message openstatus.maintenance.v1.MaintenanceSummary
+ */
+export type MaintenanceSummary = Message<"openstatus.maintenance.v1.MaintenanceSummary"> & {
+    /**
+     * Unique identifier for the maintenance.
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * Title of the maintenance.
+     *
+     * @generated from field: string title = 2;
+     */
+    title: string;
+    /**
+     * Message describing the maintenance.
+     *
+     * @generated from field: string message = 3;
+     */
+    message: string;
+    /**
+     * Start time of the maintenance window (RFC 3339 format).
+     *
+     * @generated from field: string from = 4;
+     */
+    from: string;
+    /**
+     * End time of the maintenance window (RFC 3339 format).
+     *
+     * @generated from field: string to = 5;
+     */
+    to: string;
+    /**
+     * ID of the page this maintenance is associated with.
+     *
+     * @generated from field: string page_id = 6;
+     */
+    pageId: string;
+    /**
+     * IDs of affected page components.
+     *
+     * @generated from field: repeated string page_component_ids = 7;
+     */
+    pageComponentIds: string[];
+    /**
+     * Timestamp when the maintenance was created (RFC 3339 format).
+     *
+     * @generated from field: string created_at = 8;
+     */
+    createdAt: string;
+    /**
+     * Timestamp when the maintenance was last updated (RFC 3339 format).
+     *
+     * @generated from field: string updated_at = 9;
+     */
+    updatedAt: string;
+};
+/**
+ * Describes the message openstatus.maintenance.v1.MaintenanceSummary.
+ * Use `create(MaintenanceSummarySchema)` to create a new message.
+ */
+export declare const MaintenanceSummarySchema: GenMessage<MaintenanceSummary>;
+/**
+ * Maintenance represents a maintenance window with full details.
+ *
+ * @generated from message openstatus.maintenance.v1.Maintenance
+ */
+export type Maintenance = Message<"openstatus.maintenance.v1.Maintenance"> & {
+    /**
+     * Unique identifier for the maintenance.
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * Title of the maintenance.
+     *
+     * @generated from field: string title = 2;
+     */
+    title: string;
+    /**
+     * Message describing the maintenance.
+     *
+     * @generated from field: string message = 3;
+     */
+    message: string;
+    /**
+     * Start time of the maintenance window (RFC 3339 format).
+     *
+     * @generated from field: string from = 4;
+     */
+    from: string;
+    /**
+     * End time of the maintenance window (RFC 3339 format).
+     *
+     * @generated from field: string to = 5;
+     */
+    to: string;
+    /**
+     * ID of the page this maintenance is associated with.
+     *
+     * @generated from field: string page_id = 6;
+     */
+    pageId: string;
+    /**
+     * IDs of affected page components.
+     *
+     * @generated from field: repeated string page_component_ids = 7;
+     */
+    pageComponentIds: string[];
+    /**
+     * Timestamp when the maintenance was created (RFC 3339 format).
+     *
+     * @generated from field: string created_at = 8;
+     */
+    createdAt: string;
+    /**
+     * Timestamp when the maintenance was last updated (RFC 3339 format).
+     *
+     * @generated from field: string updated_at = 9;
+     */
+    updatedAt: string;
+};
+/**
+ * Describes the message openstatus.maintenance.v1.Maintenance.
+ * Use `create(MaintenanceSchema)` to create a new message.
+ */
+export declare const MaintenanceSchema: GenMessage<Maintenance>;
+//# sourceMappingURL=maintenance_pb.d.ts.map

package/esm/gen/openstatus/maintenance/v1/maintenance_pb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maintenance_pb.d.ts","sourceRoot":"","sources":["../../../../../src/gen/openstatus/maintenance/v1/maintenance_pb.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAExE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,0CAA0C,EAAE,OAGtD,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,OAAO,CAAC,8CAA8C,CAAC,GACvD;IACA;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAE3B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAC/C,kBAAkB,CAEwC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,uCAAuC,CAAC,GAAG;IAC3E;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAE3B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,UAAU,CAAC,WAAW,CACM,CAAC"}

package/esm/gen/openstatus/maintenance/v1/maintenance_pb.js

@@ -0,0 +1,18 @@
+// @generated by protoc-gen-es v2.11.0 with parameter "target=ts,import_extension=ts"
+// @generated from file openstatus/maintenance/v1/maintenance.proto (package openstatus.maintenance.v1, syntax proto3)
+/* eslint-disable */
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+/**
+ * Describes the file openstatus/maintenance/v1/maintenance.proto.
+ */
+export const file_openstatus_maintenance_v1_maintenance = /*@__PURE__*/ fileDesc("CitvcGVuc3RhdHVzL21haW50ZW5hbmNlL3YxL21haW50ZW5hbmNlLnByb3RvEhlvcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxIq8BChJNYWludGVuYW5jZVN1bW1hcnkSCgoCaWQYASABKAkSDQoFdGl0bGUYAiABKAkSDwoHbWVzc2FnZRgDIAEoCRIMCgRmcm9tGAQgASgJEgoKAnRvGAUgASgJEg8KB3BhZ2VfaWQYBiABKAkSGgoScGFnZV9jb21wb25lbnRfaWRzGAcgAygJEhIKCmNyZWF0ZWRfYXQYCCABKAkSEgoKdXBkYXRlZF9hdBgJIAEoCSKoAQoLTWFpbnRlbmFuY2USCgoCaWQYASABKAkSDQoFdGl0bGUYAiABKAkSDwoHbWVzc2FnZRgDIAEoCRIMCgRmcm9tGAQgASgJEgoKAnRvGAUgASgJEg8KB3BhZ2VfaWQYBiABKAkSGgoScGFnZV9jb21wb25lbnRfaWRzGAcgAygJEhIKCmNyZWF0ZWRfYXQYCCABKAkSEgoKdXBkYXRlZF9hdBgJIAEoCUJbWllnaXRodWIuY29tL29wZW5zdGF0dXNocS9vcGVuc3RhdHVzL3BhY2thZ2VzL3Byb3RvL29wZW5zdGF0dXMvbWFpbnRlbmFuY2UvdjE7bWFpbnRlbmFuY2V2MWIGcHJvdG8z");
+/**
+ * Describes the message openstatus.maintenance.v1.MaintenanceSummary.
+ * Use `create(MaintenanceSummarySchema)` to create a new message.
+ */
+export const MaintenanceSummarySchema = /*@__PURE__*/ messageDesc(file_openstatus_maintenance_v1_maintenance, 0);
+/**
+ * Describes the message openstatus.maintenance.v1.Maintenance.
+ * Use `create(MaintenanceSchema)` to create a new message.
+ */
+export const MaintenanceSchema = /*@__PURE__*/ messageDesc(file_openstatus_maintenance_v1_maintenance, 1);