@axis-backstage/plugin-statuspage-common 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @axis-backstage/plugin-statuspage-common
+
+## 0.2.0
+
+### Minor Changes
+
+- b445aaa: Initial Release of the Statuspage Plugin

package/README.md

@@ -0,0 +1,5 @@
+# plugin-statuspage-common
+
+Welcome to the common package for the statuspage plugin!
+
+Contains common types shared between frontend and backend plugins.

package/dist/index.cjs.js

@@ -0,0 +1,8 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const STATUSPAGE_ANNOTATION = "statuspage.io/components";
+
+exports.STATUSPAGE_ANNOTATION = STATUSPAGE_ANNOTATION;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/annotations.ts"],"sourcesContent":["/**\n * Annotation used by Entities that will embed statuspage.io components and\n * component groups.\n *\n * @public\n */\nexport const STATUSPAGE_ANNOTATION = 'statuspage.io/components';\n"],"names":[],"mappings":";;;;AAMO,MAAM,qBAAwB,GAAA;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Represents the detailed status of a page, including various timestamps,
+ * status information, and related metadata.
+ *
+ * @public
+ */
+type Incident = {
+    name: string;
+    status: IncidentStatus;
+    created_at: Date;
+    updated_at: Date;
+    monitoring_at: Date | null;
+    resolved_at: Date;
+    impact: string;
+    shortlink: string;
+    scheduled_for: Date | null;
+    scheduled_until: Date | null;
+    scheduled_remind_prior: boolean;
+    scheduled_reminded_at: Date | null;
+    impact_override: null;
+    scheduled_auto_in_progress: boolean;
+    scheduled_auto_completed: boolean;
+    metadata: any;
+    started_at: Date;
+    reminder_intervals: null;
+    id: string;
+    page_id: string;
+    incident_updates: IncidentUpdate[];
+    postmortem_body: null | string;
+    postmortem_body_last_updated_at: Date | null;
+    postmortem_ignored: boolean;
+    postmortem_published_at: Date | null;
+    postmortem_notified_subscribers: boolean;
+    postmortem_notified_twitter: boolean;
+    components: Component[];
+};
+/**
+ * Describes a component within a Statuspage, including its status,
+ * descriptive information, and related timestamps.
+ *
+ * @public
+ */
+type Component = {
+    id: string;
+    page_id: string;
+    group_id: null | string;
+    created_at: Date;
+    updated_at: Date;
+    group: boolean;
+    name: string;
+    description: null | string;
+    position: number;
+    status: ComponentStatus;
+    showcase: boolean;
+    only_show_if_degraded: boolean;
+    automation_email: string;
+    start_date: Date | null;
+};
+/**
+ * Enumerates the possible status values for a component or service,
+ * indicating its operational state.
+ *
+ * @public
+ */
+type ComponentStatus = 'under_maintenance' | 'operational' | 'degraded_performance' | 'partial_outage' | 'major_outage';
+/**
+ * Contains information about an update to an incident, including
+ * the update's status, content, and relevant timestamps.
+ *
+ * @public
+ */
+type IncidentUpdate = {
+    status: string;
+    body: string;
+    created_at: Date;
+    wants_twitter_update: boolean;
+    twitter_updated_at: null;
+    updated_at: Date;
+    display_at: Date | null;
+    deliver_notifications: boolean;
+    tweet_id: null;
+    id: string;
+    incident_id: string;
+    custom_tweet: null;
+    affected_components: AffectedComponent[] | null;
+};
+/**
+ * Details a component affected by an incident, including its status
+ * before and after the incident.
+ *
+ * @public
+ */
+type AffectedComponent = {
+    code: string;
+    name: string;
+    old_status: ComponentStatus;
+    new_status: ComponentStatus;
+};
+/**
+ * Status of an incident.
+ *
+ * @public
+ */
+type IncidentStatus = 'completed' | 'resolved' | 'postmortem';
+/**
+ * Type that describes an ComponentGroup.
+ *
+ * @public
+ */
+type ComponentGroup = {
+    id: string;
+    page_id: string;
+    name: string;
+    description: null | string;
+    components: string[];
+    position: number;
+    created_at: Date;
+    updated_at: Date;
+};
+
+/**
+ * Annotation used by Entities that will embed statuspage.io components and
+ * component groups.
+ *
+ * @public
+ */
+declare const STATUSPAGE_ANNOTATION = "statuspage.io/components";
+
+export { AffectedComponent, Component, ComponentGroup, ComponentStatus, Incident, IncidentStatus, IncidentUpdate, STATUSPAGE_ANNOTATION };

package/dist/index.esm.js

@@ -0,0 +1,4 @@
+const STATUSPAGE_ANNOTATION = "statuspage.io/components";
+
+export { STATUSPAGE_ANNOTATION };
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/annotations.ts"],"sourcesContent":["/**\n * Annotation used by Entities that will embed statuspage.io components and\n * component groups.\n *\n * @public\n */\nexport const STATUSPAGE_ANNOTATION = 'statuspage.io/components';\n"],"names":[],"mappings":"AAMO,MAAM,qBAAwB,GAAA;;;;"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@axis-backstage/plugin-statuspage-common",
+  "description": "Common functionalities for the statuspage plugin",
+  "version": "0.2.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "common-library"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.25.1"
+  },
+  "files": [
+    "dist"
+  ],
+  "module": "dist/index.esm.js"
+}