@openstatus/sdk-node 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/README.md +345 -10
  2. package/esm/gen/openstatus/status_page/v1/page_component_pb.d.ts +150 -0
  3. package/esm/gen/openstatus/status_page/v1/page_component_pb.d.ts.map +1 -0
  4. package/esm/gen/openstatus/status_page/v1/page_component_pb.js +42 -0
  5. package/esm/gen/openstatus/status_page/v1/page_subscriber_pb.d.ts +61 -0
  6. package/esm/gen/openstatus/status_page/v1/page_subscriber_pb.d.ts.map +1 -0
  7. package/esm/gen/openstatus/status_page/v1/page_subscriber_pb.js +13 -0
  8. package/esm/gen/openstatus/status_page/v1/service_pb.d.ts +1043 -0
  9. package/esm/gen/openstatus/status_page/v1/service_pb.d.ts.map +1 -0
  10. package/esm/gen/openstatus/status_page/v1/service_pb.js +202 -0
  11. package/esm/gen/openstatus/status_page/v1/status_page_pb.d.ts +298 -0
  12. package/esm/gen/openstatus/status_page/v1/status_page_pb.d.ts.map +1 -0
  13. package/esm/gen/openstatus/status_page/v1/status_page_pb.js +119 -0
  14. package/esm/mod.d.ts +37 -0
  15. package/esm/mod.d.ts.map +1 -1
  16. package/esm/mod.js +8 -0
  17. package/package.json +1 -1
  18. package/script/gen/openstatus/status_page/v1/page_component_pb.d.ts +150 -0
  19. package/script/gen/openstatus/status_page/v1/page_component_pb.d.ts.map +1 -0
  20. package/script/gen/openstatus/status_page/v1/page_component_pb.js +45 -0
  21. package/script/gen/openstatus/status_page/v1/page_subscriber_pb.d.ts +61 -0
  22. package/script/gen/openstatus/status_page/v1/page_subscriber_pb.d.ts.map +1 -0
  23. package/script/gen/openstatus/status_page/v1/page_subscriber_pb.js +16 -0
  24. package/script/gen/openstatus/status_page/v1/service_pb.d.ts +1043 -0
  25. package/script/gen/openstatus/status_page/v1/service_pb.d.ts.map +1 -0
  26. package/script/gen/openstatus/status_page/v1/service_pb.js +205 -0
  27. package/script/gen/openstatus/status_page/v1/status_page_pb.d.ts +298 -0
  28. package/script/gen/openstatus/status_page/v1/status_page_pb.d.ts.map +1 -0
  29. package/script/gen/openstatus/status_page/v1/status_page_pb.js +122 -0
  30. package/script/mod.d.ts +37 -0
  31. package/script/mod.d.ts.map +1 -1
  32. package/script/mod.js +15 -3
package/README.md CHANGED
@@ -4,14 +4,21 @@
4
4
  [![npm](https://img.shields.io/npm/v/@openstatus/sdk-node)](https://www.npmjs.com/package/@openstatus/sdk-node)
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
6
 
7
- Official Node.js SDK for [OpenStatus](https://openstatus.dev) - The open-source status page with uptime monitoring.
7
+ Official Node.js SDK for [OpenStatus](https://openstatus.dev) - The open-source
8
+ status page with uptime monitoring.
8
9
 
9
10
  ## Features
10
11
 
11
12
  ### Status Page
12
- - **Status Reports** - Manage incident and maintenance reports with update timelines
13
+
14
+ - **Status Pages** - Create and manage public status pages with custom domains
15
+ - **Page Components** - Add monitor-based or static components with grouping
16
+ - **Subscribers** - Manage email subscriptions for status updates
17
+ - **Status Reports** - Manage incident and maintenance reports with update
18
+ timelines
13
19
 
14
20
  ### Monitoring
21
+
15
22
  - **HTTP Monitoring** - Monitor websites and APIs with customizable assertions
16
23
  - **TCP Monitoring** - Check database connections and other TCP services
17
24
  - **DNS Monitoring** - Verify DNS records and resolution
@@ -380,7 +387,10 @@ const { statusReports, totalSize } = await openstatus.statusReport.v1
380
387
  {
381
388
  limit: 10,
382
389
  offset: 0,
383
- statuses: [StatusReportStatus.INVESTIGATING, StatusReportStatus.IDENTIFIED],
390
+ statuses: [
391
+ StatusReportStatus.INVESTIGATING,
392
+ StatusReportStatus.IDENTIFIED,
393
+ ],
384
394
  },
385
395
  { headers },
386
396
  );
@@ -428,7 +438,8 @@ const { statusReport } = await openstatus.statusReport.v1.StatusReportService
428
438
  {
429
439
  statusReportId: "sr_123",
430
440
  status: StatusReportStatus.IDENTIFIED,
431
- message: "The issue has been identified as a database connection problem.",
441
+ message:
442
+ "The issue has been identified as a database connection problem.",
432
443
  date: "2024-01-15T11:00:00", // optional, defaults to current time
433
444
  notify: true,
434
445
  },
@@ -438,13 +449,337 @@ const { statusReport } = await openstatus.statusReport.v1.StatusReportService
438
449
 
439
450
  ### Status Report Status
440
451
 
441
- | Enum Value | Description |
442
- | --------------- | ------------------------------- |
443
- | `UNSPECIFIED` | Default/unspecified status |
452
+ | Enum Value | Description |
453
+ | --------------- | -------------------------------- |
454
+ | `UNSPECIFIED` | Default/unspecified status |
444
455
  | `INVESTIGATING` | Actively investigating the issue |
445
- | `IDENTIFIED` | Root cause has been identified |
446
- | `MONITORING` | Fix deployed, monitoring |
447
- | `RESOLVED` | Issue fully resolved |
456
+ | `IDENTIFIED` | Root cause has been identified |
457
+ | `MONITORING` | Fix deployed, monitoring |
458
+ | `RESOLVED` | Issue fully resolved |
459
+
460
+ ### Status Page Service
461
+
462
+ Manage status pages, components, and subscribers.
463
+
464
+ #### `createStatusPage(request, options)`
465
+
466
+ Create a new status page.
467
+
468
+ ```typescript
469
+ const { statusPage } = await openstatus.statusPage.v1.StatusPageService
470
+ .createStatusPage(
471
+ {
472
+ title: "My Service Status",
473
+ slug: "my-service",
474
+ description: "Status page for My Service",
475
+ homepageUrl: "https://example.com",
476
+ contactUrl: "https://example.com/contact",
477
+ },
478
+ { headers },
479
+ );
480
+
481
+ console.log(`Status page created: ${statusPage?.id}`);
482
+ ```
483
+
484
+ #### `getStatusPage(request, options)`
485
+
486
+ Get a status page by ID.
487
+
488
+ ```typescript
489
+ const { statusPage } = await openstatus.statusPage.v1.StatusPageService
490
+ .getStatusPage(
491
+ { id: "page_123" },
492
+ { headers },
493
+ );
494
+ ```
495
+
496
+ #### `listStatusPages(request, options)`
497
+
498
+ List all status pages with pagination.
499
+
500
+ ```typescript
501
+ const { statusPages, totalSize } = await openstatus.statusPage.v1
502
+ .StatusPageService.listStatusPages(
503
+ { limit: 10, offset: 0 },
504
+ { headers },
505
+ );
506
+
507
+ console.log(`Found ${totalSize} status pages`);
508
+ ```
509
+
510
+ #### `updateStatusPage(request, options)`
511
+
512
+ Update a status page.
513
+
514
+ ```typescript
515
+ const { statusPage } = await openstatus.statusPage.v1.StatusPageService
516
+ .updateStatusPage(
517
+ {
518
+ id: "page_123",
519
+ title: "Updated Title",
520
+ description: "Updated description",
521
+ },
522
+ { headers },
523
+ );
524
+ ```
525
+
526
+ #### `deleteStatusPage(request, options)`
527
+
528
+ Delete a status page.
529
+
530
+ ```typescript
531
+ const { success } = await openstatus.statusPage.v1.StatusPageService
532
+ .deleteStatusPage(
533
+ { id: "page_123" },
534
+ { headers },
535
+ );
536
+ ```
537
+
538
+ #### `addMonitorComponent(request, options)`
539
+
540
+ Add a monitor-based component to a status page.
541
+
542
+ ```typescript
543
+ const { component } = await openstatus.statusPage.v1.StatusPageService
544
+ .addMonitorComponent(
545
+ {
546
+ pageId: "page_123",
547
+ monitorId: "mon_456",
548
+ name: "API Server",
549
+ description: "Main API endpoint",
550
+ order: 1,
551
+ },
552
+ { headers },
553
+ );
554
+ ```
555
+
556
+ #### `addStaticComponent(request, options)`
557
+
558
+ Add a static component (not linked to a monitor).
559
+
560
+ ```typescript
561
+ const { component } = await openstatus.statusPage.v1.StatusPageService
562
+ .addStaticComponent(
563
+ {
564
+ pageId: "page_123",
565
+ name: "Third-party Service",
566
+ description: "External dependency",
567
+ order: 2,
568
+ },
569
+ { headers },
570
+ );
571
+ ```
572
+
573
+ #### `updateComponent(request, options)`
574
+
575
+ Update a component.
576
+
577
+ ```typescript
578
+ const { component } = await openstatus.statusPage.v1.StatusPageService
579
+ .updateComponent(
580
+ {
581
+ id: "comp_123",
582
+ name: "Updated Component Name",
583
+ order: 3,
584
+ },
585
+ { headers },
586
+ );
587
+ ```
588
+
589
+ #### `removeComponent(request, options)`
590
+
591
+ Remove a component from a status page.
592
+
593
+ ```typescript
594
+ const { success } = await openstatus.statusPage.v1.StatusPageService
595
+ .removeComponent(
596
+ { id: "comp_123" },
597
+ { headers },
598
+ );
599
+ ```
600
+
601
+ #### `createComponentGroup(request, options)`
602
+
603
+ Create a component group.
604
+
605
+ ```typescript
606
+ const { group } = await openstatus.statusPage.v1.StatusPageService
607
+ .createComponentGroup(
608
+ {
609
+ pageId: "page_123",
610
+ name: "Core Services",
611
+ },
612
+ { headers },
613
+ );
614
+ ```
615
+
616
+ #### `updateComponentGroup(request, options)`
617
+
618
+ Update a component group.
619
+
620
+ ```typescript
621
+ const { group } = await openstatus.statusPage.v1.StatusPageService
622
+ .updateComponentGroup(
623
+ {
624
+ id: "group_123",
625
+ name: "Updated Group Name",
626
+ },
627
+ { headers },
628
+ );
629
+ ```
630
+
631
+ #### `deleteComponentGroup(request, options)`
632
+
633
+ Delete a component group.
634
+
635
+ ```typescript
636
+ const { success } = await openstatus.statusPage.v1.StatusPageService
637
+ .deleteComponentGroup(
638
+ { id: "group_123" },
639
+ { headers },
640
+ );
641
+ ```
642
+
643
+ #### `subscribeToPage(request, options)`
644
+
645
+ Subscribe an email to status page updates.
646
+
647
+ ```typescript
648
+ const { subscriber } = await openstatus.statusPage.v1.StatusPageService
649
+ .subscribeToPage(
650
+ {
651
+ pageId: "page_123",
652
+ email: "user@example.com",
653
+ },
654
+ { headers },
655
+ );
656
+ ```
657
+
658
+ #### `unsubscribeFromPage(request, options)`
659
+
660
+ Unsubscribe from a status page.
661
+
662
+ ```typescript
663
+ // By email
664
+ const { success } = await openstatus.statusPage.v1.StatusPageService
665
+ .unsubscribeFromPage(
666
+ {
667
+ pageId: "page_123",
668
+ identifier: { case: "email", value: "user@example.com" },
669
+ },
670
+ { headers },
671
+ );
672
+
673
+ // Or by subscriber ID
674
+ const { success: success2 } = await openstatus.statusPage.v1.StatusPageService
675
+ .unsubscribeFromPage(
676
+ {
677
+ pageId: "page_123",
678
+ identifier: { case: "id", value: "sub_456" },
679
+ },
680
+ { headers },
681
+ );
682
+ ```
683
+
684
+ #### `listSubscribers(request, options)`
685
+
686
+ List all subscribers for a status page.
687
+
688
+ ```typescript
689
+ const { subscribers, totalSize } = await openstatus.statusPage.v1
690
+ .StatusPageService.listSubscribers(
691
+ {
692
+ pageId: "page_123",
693
+ limit: 50,
694
+ offset: 0,
695
+ includeUnsubscribed: false,
696
+ },
697
+ { headers },
698
+ );
699
+ ```
700
+
701
+ #### `getStatusPageContent(request, options)`
702
+
703
+ Get full status page content including components, groups, and active reports.
704
+
705
+ ```typescript
706
+ const content = await openstatus.statusPage.v1.StatusPageService
707
+ .getStatusPageContent(
708
+ { identifier: { case: "slug", value: "my-service" } },
709
+ { headers },
710
+ );
711
+
712
+ console.log(`Page: ${content.statusPage?.title}`);
713
+ console.log(`Components: ${content.components.length}`);
714
+ console.log(`Active reports: ${content.statusReports.length}`);
715
+ ```
716
+
717
+ #### `getOverallStatus(request, options)`
718
+
719
+ Get the aggregated status of a status page.
720
+
721
+ ```typescript
722
+ import { OverallStatus } from "@openstatus/sdk-node";
723
+
724
+ const { overallStatus, componentStatuses } = await openstatus.statusPage.v1
725
+ .StatusPageService.getOverallStatus(
726
+ { identifier: { case: "id", value: "page_123" } },
727
+ { headers },
728
+ );
729
+
730
+ console.log(`Overall: ${OverallStatus[overallStatus]}`);
731
+ for (const { componentId, status } of componentStatuses) {
732
+ console.log(` ${componentId}: ${OverallStatus[status]}`);
733
+ }
734
+ ```
735
+
736
+ ### Status Page Options
737
+
738
+ | Option | Type | Required | Description |
739
+ | ------------- | ------ | -------- | ---------------------------------------- |
740
+ | `title` | string | Yes | Title of the status page (max 256 chars) |
741
+ | `slug` | string | Yes | URL-friendly slug (lowercase, hyphens) |
742
+ | `description` | string | No | Description (max 2048 chars) |
743
+ | `homepageUrl` | string | No | Link to your homepage |
744
+ | `contactUrl` | string | No | Link to your contact page |
745
+
746
+ ### Page Access Type
747
+
748
+ | Enum Value | Description |
749
+ | -------------------- | ----------------------- |
750
+ | `UNSPECIFIED` | Default/unspecified |
751
+ | `PUBLIC` | Publicly accessible |
752
+ | `PASSWORD_PROTECTED` | Requires password |
753
+ | `AUTHENTICATED` | Requires authentication |
754
+
755
+ ### Page Theme
756
+
757
+ | Enum Value | Description |
758
+ | ------------- | ------------------- |
759
+ | `UNSPECIFIED` | Default/unspecified |
760
+ | `SYSTEM` | Follow system theme |
761
+ | `LIGHT` | Light theme |
762
+ | `DARK` | Dark theme |
763
+
764
+ ### Overall Status
765
+
766
+ | Enum Value | Description |
767
+ | ---------------- | --------------------------- |
768
+ | `UNSPECIFIED` | Default/unspecified |
769
+ | `OPERATIONAL` | All systems operational |
770
+ | `DEGRADED` | Performance is degraded |
771
+ | `PARTIAL_OUTAGE` | Some systems are down |
772
+ | `MAJOR_OUTAGE` | Major systems are down |
773
+ | `MAINTENANCE` | Scheduled maintenance |
774
+ | `UNKNOWN` | Status cannot be determined |
775
+
776
+ ### Page Component Type
777
+
778
+ | Enum Value | Description |
779
+ | ------------- | ------------------------- |
780
+ | `UNSPECIFIED` | Default/unspecified |
781
+ | `MONITOR` | Linked to a monitor |
782
+ | `STATIC` | Static component (manual) |
448
783
 
449
784
  ## Monitor Options
450
785
 
@@ -0,0 +1,150 @@
1
+ import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
2
+ import type { Message } from "@bufbuild/protobuf";
3
+ /**
4
+ * Describes the file openstatus/status_page/v1/page_component.proto.
5
+ */
6
+ export declare const file_openstatus_status_page_v1_page_component: GenFile;
7
+ /**
8
+ * PageComponent represents a component displayed on a status page.
9
+ *
10
+ * @generated from message openstatus.status_page.v1.PageComponent
11
+ */
12
+ export type PageComponent = Message<"openstatus.status_page.v1.PageComponent"> & {
13
+ /**
14
+ * Unique identifier for the component.
15
+ *
16
+ * @generated from field: string id = 1;
17
+ */
18
+ id: string;
19
+ /**
20
+ * ID of the status page this component belongs to.
21
+ *
22
+ * @generated from field: string page_id = 2;
23
+ */
24
+ pageId: string;
25
+ /**
26
+ * Display name of the component.
27
+ *
28
+ * @generated from field: string name = 3;
29
+ */
30
+ name: string;
31
+ /**
32
+ * Description of the component (optional).
33
+ *
34
+ * @generated from field: string description = 4;
35
+ */
36
+ description: string;
37
+ /**
38
+ * Type of the component (monitor or static).
39
+ *
40
+ * @generated from field: openstatus.status_page.v1.PageComponentType type = 5;
41
+ */
42
+ type: PageComponentType;
43
+ /**
44
+ * ID of the monitor if type is MONITOR (optional).
45
+ *
46
+ * @generated from field: string monitor_id = 6;
47
+ */
48
+ monitorId: string;
49
+ /**
50
+ * Display order of the component.
51
+ *
52
+ * @generated from field: int32 order = 7;
53
+ */
54
+ order: number;
55
+ /**
56
+ * ID of the group this component belongs to (optional).
57
+ *
58
+ * @generated from field: string group_id = 8;
59
+ */
60
+ groupId: string;
61
+ /**
62
+ * Order within the group if grouped.
63
+ *
64
+ * @generated from field: int32 group_order = 9;
65
+ */
66
+ groupOrder: number;
67
+ /**
68
+ * Timestamp when the component was created (RFC 3339 format).
69
+ *
70
+ * @generated from field: string created_at = 10;
71
+ */
72
+ createdAt: string;
73
+ /**
74
+ * Timestamp when the component was last updated (RFC 3339 format).
75
+ *
76
+ * @generated from field: string updated_at = 11;
77
+ */
78
+ updatedAt: string;
79
+ };
80
+ /**
81
+ * Describes the message openstatus.status_page.v1.PageComponent.
82
+ * Use `create(PageComponentSchema)` to create a new message.
83
+ */
84
+ export declare const PageComponentSchema: GenMessage<PageComponent>;
85
+ /**
86
+ * PageComponentGroup represents a group of components on a status page.
87
+ *
88
+ * @generated from message openstatus.status_page.v1.PageComponentGroup
89
+ */
90
+ export type PageComponentGroup = Message<"openstatus.status_page.v1.PageComponentGroup"> & {
91
+ /**
92
+ * Unique identifier for the group.
93
+ *
94
+ * @generated from field: string id = 1;
95
+ */
96
+ id: string;
97
+ /**
98
+ * ID of the status page this group belongs to.
99
+ *
100
+ * @generated from field: string page_id = 2;
101
+ */
102
+ pageId: string;
103
+ /**
104
+ * Display name of the group.
105
+ *
106
+ * @generated from field: string name = 3;
107
+ */
108
+ name: string;
109
+ /**
110
+ * Timestamp when the group was created (RFC 3339 format).
111
+ *
112
+ * @generated from field: string created_at = 4;
113
+ */
114
+ createdAt: string;
115
+ /**
116
+ * Timestamp when the group was last updated (RFC 3339 format).
117
+ *
118
+ * @generated from field: string updated_at = 5;
119
+ */
120
+ updatedAt: string;
121
+ };
122
+ /**
123
+ * Describes the message openstatus.status_page.v1.PageComponentGroup.
124
+ * Use `create(PageComponentGroupSchema)` to create a new message.
125
+ */
126
+ export declare const PageComponentGroupSchema: GenMessage<PageComponentGroup>;
127
+ /**
128
+ * PageComponentType defines the type of a component on a status page.
129
+ *
130
+ * @generated from enum openstatus.status_page.v1.PageComponentType
131
+ */
132
+ export declare enum PageComponentType {
133
+ /**
134
+ * @generated from enum value: PAGE_COMPONENT_TYPE_UNSPECIFIED = 0;
135
+ */
136
+ UNSPECIFIED = 0,
137
+ /**
138
+ * @generated from enum value: PAGE_COMPONENT_TYPE_MONITOR = 1;
139
+ */
140
+ MONITOR = 1,
141
+ /**
142
+ * @generated from enum value: PAGE_COMPONENT_TYPE_STATIC = 2;
143
+ */
144
+ STATIC = 2
145
+ }
146
+ /**
147
+ * Describes the enum openstatus.status_page.v1.PageComponentType.
148
+ */
149
+ export declare const PageComponentTypeSchema: GenEnum<PageComponentType>;
150
+ //# sourceMappingURL=page_component_pb.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"page_component_pb.d.ts","sourceRoot":"","sources":["../../../../../src/gen/openstatus/status_page/v1/page_component_pb.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,UAAU,EACX,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,6CAA6C,EACxD,OAGC,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,aAAa,GACrB,OAAO,CAAC,yCAAyC,CAAC,GAClD;IACA;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,IAAI,EAAE,iBAAiB,CAAC;IAExB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,UAAU,CAAC,aAAa,CACK,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,OAAO,CAAC,8CAA8C,CAAC,GACvD;IACA;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;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,CAE2C,CAAC;AAEhE;;;;GAIG;AACH,oBAAY,iBAAiB;IAC3B;;OAEG;IACH,WAAW,IAAI;IAEf;;OAEG;IACH,OAAO,IAAI;IAEX;;OAEG;IACH,MAAM,IAAI;CACX;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,OAAO,CAAC,iBAAiB,CACH,CAAC"}
@@ -0,0 +1,42 @@
1
+ // @generated by protoc-gen-es v2.11.0 with parameter "target=ts,import_extension=ts"
2
+ // @generated from file openstatus/status_page/v1/page_component.proto (package openstatus.status_page.v1, syntax proto3)
3
+ /* eslint-disable */
4
+ import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
5
+ /**
6
+ * Describes the file openstatus/status_page/v1/page_component.proto.
7
+ */
8
+ export const file_openstatus_status_page_v1_page_component = /*@__PURE__*/ fileDesc("Ci5vcGVuc3RhdHVzL3N0YXR1c19wYWdlL3YxL3BhZ2VfY29tcG9uZW50LnByb3RvEhlvcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxIv0BCg1QYWdlQ29tcG9uZW50EgoKAmlkGAEgASgJEg8KB3BhZ2VfaWQYAiABKAkSDAoEbmFtZRgDIAEoCRITCgtkZXNjcmlwdGlvbhgEIAEoCRI6CgR0eXBlGAUgASgOMiwub3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MS5QYWdlQ29tcG9uZW50VHlwZRISCgptb25pdG9yX2lkGAYgASgJEg0KBW9yZGVyGAcgASgFEhAKCGdyb3VwX2lkGAggASgJEhMKC2dyb3VwX29yZGVyGAkgASgFEhIKCmNyZWF0ZWRfYXQYCiABKAkSEgoKdXBkYXRlZF9hdBgLIAEoCSJnChJQYWdlQ29tcG9uZW50R3JvdXASCgoCaWQYASABKAkSDwoHcGFnZV9pZBgCIAEoCRIMCgRuYW1lGAMgASgJEhIKCmNyZWF0ZWRfYXQYBCABKAkSEgoKdXBkYXRlZF9hdBgFIAEoCSp5ChFQYWdlQ29tcG9uZW50VHlwZRIjCh9QQUdFX0NPTVBPTkVOVF9UWVBFX1VOU1BFQ0lGSUVEEAASHwobUEFHRV9DT01QT05FTlRfVFlQRV9NT05JVE9SEAESHgoaUEFHRV9DT01QT05FTlRfVFlQRV9TVEFUSUMQAkJaWlhnaXRodWIuY29tL29wZW5zdGF0dXNocS9vcGVuc3RhdHVzL3BhY2thZ2VzL3Byb3RvL29wZW5zdGF0dXMvc3RhdHVzX3BhZ2UvdjE7c3RhdHVzcGFnZXYxYgZwcm90bzM");
9
+ /**
10
+ * Describes the message openstatus.status_page.v1.PageComponent.
11
+ * Use `create(PageComponentSchema)` to create a new message.
12
+ */
13
+ export const PageComponentSchema = /*@__PURE__*/ messageDesc(file_openstatus_status_page_v1_page_component, 0);
14
+ /**
15
+ * Describes the message openstatus.status_page.v1.PageComponentGroup.
16
+ * Use `create(PageComponentGroupSchema)` to create a new message.
17
+ */
18
+ export const PageComponentGroupSchema = /*@__PURE__*/ messageDesc(file_openstatus_status_page_v1_page_component, 1);
19
+ /**
20
+ * PageComponentType defines the type of a component on a status page.
21
+ *
22
+ * @generated from enum openstatus.status_page.v1.PageComponentType
23
+ */
24
+ export var PageComponentType;
25
+ (function (PageComponentType) {
26
+ /**
27
+ * @generated from enum value: PAGE_COMPONENT_TYPE_UNSPECIFIED = 0;
28
+ */
29
+ PageComponentType[PageComponentType["UNSPECIFIED"] = 0] = "UNSPECIFIED";
30
+ /**
31
+ * @generated from enum value: PAGE_COMPONENT_TYPE_MONITOR = 1;
32
+ */
33
+ PageComponentType[PageComponentType["MONITOR"] = 1] = "MONITOR";
34
+ /**
35
+ * @generated from enum value: PAGE_COMPONENT_TYPE_STATIC = 2;
36
+ */
37
+ PageComponentType[PageComponentType["STATIC"] = 2] = "STATIC";
38
+ })(PageComponentType || (PageComponentType = {}));
39
+ /**
40
+ * Describes the enum openstatus.status_page.v1.PageComponentType.
41
+ */
42
+ export const PageComponentTypeSchema = /*@__PURE__*/ enumDesc(file_openstatus_status_page_v1_page_component, 0);
@@ -0,0 +1,61 @@
1
+ import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
2
+ import type { Message } from "@bufbuild/protobuf";
3
+ /**
4
+ * Describes the file openstatus/status_page/v1/page_subscriber.proto.
5
+ */
6
+ export declare const file_openstatus_status_page_v1_page_subscriber: GenFile;
7
+ /**
8
+ * PageSubscriber represents a subscriber to a status page.
9
+ *
10
+ * @generated from message openstatus.status_page.v1.PageSubscriber
11
+ */
12
+ export type PageSubscriber = Message<"openstatus.status_page.v1.PageSubscriber"> & {
13
+ /**
14
+ * Unique identifier for the subscriber.
15
+ *
16
+ * @generated from field: string id = 1;
17
+ */
18
+ id: string;
19
+ /**
20
+ * ID of the status page the user is subscribed to.
21
+ *
22
+ * @generated from field: string page_id = 2;
23
+ */
24
+ pageId: string;
25
+ /**
26
+ * Email address of the subscriber.
27
+ *
28
+ * @generated from field: string email = 3;
29
+ */
30
+ email: string;
31
+ /**
32
+ * Timestamp when the subscription was accepted/confirmed (RFC 3339 format, optional).
33
+ *
34
+ * @generated from field: string accepted_at = 4;
35
+ */
36
+ acceptedAt: string;
37
+ /**
38
+ * Timestamp when the user unsubscribed (RFC 3339 format, optional).
39
+ *
40
+ * @generated from field: string unsubscribed_at = 5;
41
+ */
42
+ unsubscribedAt: string;
43
+ /**
44
+ * Timestamp when the subscription was created (RFC 3339 format).
45
+ *
46
+ * @generated from field: string created_at = 6;
47
+ */
48
+ createdAt: string;
49
+ /**
50
+ * Timestamp when the subscription was last updated (RFC 3339 format).
51
+ *
52
+ * @generated from field: string updated_at = 7;
53
+ */
54
+ updatedAt: string;
55
+ };
56
+ /**
57
+ * Describes the message openstatus.status_page.v1.PageSubscriber.
58
+ * Use `create(PageSubscriberSchema)` to create a new message.
59
+ */
60
+ export declare const PageSubscriberSchema: GenMessage<PageSubscriber>;
61
+ //# sourceMappingURL=page_subscriber_pb.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"page_subscriber_pb.d.ts","sourceRoot":"","sources":["../../../../../src/gen/openstatus/status_page/v1/page_subscriber_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,8CAA8C,EACzD,OAGC,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB,OAAO,CAAC,0CAA0C,CAAC,GACnD;IACA;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,UAAU,CAAC,cAAc,CACI,CAAC"}
@@ -0,0 +1,13 @@
1
+ // @generated by protoc-gen-es v2.11.0 with parameter "target=ts,import_extension=ts"
2
+ // @generated from file openstatus/status_page/v1/page_subscriber.proto (package openstatus.status_page.v1, syntax proto3)
3
+ /* eslint-disable */
4
+ import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
5
+ /**
6
+ * Describes the file openstatus/status_page/v1/page_subscriber.proto.
7
+ */
8
+ export const file_openstatus_status_page_v1_page_subscriber = /*@__PURE__*/ fileDesc("Ci9vcGVuc3RhdHVzL3N0YXR1c19wYWdlL3YxL3BhZ2Vfc3Vic2NyaWJlci5wcm90bxIZb3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MSKSAQoOUGFnZVN1YnNjcmliZXISCgoCaWQYASABKAkSDwoHcGFnZV9pZBgCIAEoCRINCgVlbWFpbBgDIAEoCRITCgthY2NlcHRlZF9hdBgEIAEoCRIXCg91bnN1YnNjcmliZWRfYXQYBSABKAkSEgoKY3JlYXRlZF9hdBgGIAEoCRISCgp1cGRhdGVkX2F0GAcgASgJQlpaWGdpdGh1Yi5jb20vb3BlbnN0YXR1c2hxL29wZW5zdGF0dXMvcGFja2FnZXMvcHJvdG8vb3BlbnN0YXR1cy9zdGF0dXNfcGFnZS92MTtzdGF0dXNwYWdldjFiBnByb3RvMw");
9
+ /**
10
+ * Describes the message openstatus.status_page.v1.PageSubscriber.
11
+ * Use `create(PageSubscriberSchema)` to create a new message.
12
+ */
13
+ export const PageSubscriberSchema = /*@__PURE__*/ messageDesc(file_openstatus_status_page_v1_page_subscriber, 0);