@backstage-community/plugin-ilert 0.2.24

package/dist/index.d.ts

@@ -0,0 +1,441 @@
+/// <reference types="react" />
+import * as react from 'react';
+import react__default from 'react';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+import { IconComponent, ConfigApi, DiscoveryApi } from '@backstage/core-plugin-api';
+import { Entity } from '@backstage/catalog-model';
+
+/** @public */
+declare const ilertPlugin: _backstage_core_plugin_api.BackstagePlugin<{
+    root: _backstage_core_plugin_api.RouteRef<undefined>;
+}, {}, {}>;
+/** @public */
+declare const ILertPage$1: () => react.JSX.Element;
+/** @public */
+declare const EntityILertCard: () => react.JSX.Element;
+
+/** @public */
+declare const ILertPage: () => react__default.JSX.Element;
+
+/** @public */
+declare const isPluginApplicableToEntity: (entity: Entity) => boolean;
+/** @public */
+declare const ILertCard: () => react__default.JSX.Element;
+
+/**
+ * @public
+ */
+declare const ILertIcon: IconComponent;
+
+/** @public */
+interface Alert {
+    id: number;
+    summary: string;
+    details: string;
+    reportTime: string;
+    resolvedOn: string;
+    status: AlertStatus;
+    priority: AlertPriority;
+    alertKey: string;
+    alertSource: AlertSource | null;
+    assignedTo: User | null;
+    responders: Responder[];
+    logEntries: LogEntry[];
+    links: Link[];
+    images: Image[];
+    subscribers: Subscriber[];
+    commentText: string;
+    commentPublishToSubscribers: boolean;
+}
+/** @public */
+declare const PENDING = "PENDING";
+/** @public */
+declare const ACCEPTED = "ACCEPTED";
+/** @public */
+declare const RESOLVED = "RESOLVED";
+/** @public */
+type AlertStatus = typeof PENDING | typeof ACCEPTED | typeof RESOLVED;
+/** @public */
+type AlertPriority = 'HIGH' | 'LOW';
+/** @public */
+interface Link {
+    href: string;
+    text: string;
+}
+/** @public */
+interface Image {
+    src: string;
+    href: string;
+    alt: string;
+}
+/** @public */
+type SubscriberType = 'TEAM' | 'USER';
+/** @public */
+interface Subscriber {
+    id: number;
+    name: string;
+    type: SubscriberType;
+}
+/** @public */
+interface LogEntry {
+    id: number;
+    timestamp: string;
+    logEntryType: string;
+    text: string;
+    alertId?: number;
+    iconName?: string;
+    iconClass?: string;
+    filterTypes?: string[];
+}
+/** @public */
+interface User {
+    id: number;
+    username: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    mobile: Phone;
+    landline: Phone;
+    timezone?: string;
+    language?: Language;
+    role?: UserRole;
+    notificationPreferences?: any[];
+    position: string;
+    department: string;
+}
+/** @public */
+interface Responder {
+    acceptedAt?: string;
+    status: string;
+    user: User;
+}
+/** @public */
+type UserRole = 'USER' | 'ADMIN' | 'STAKEHOLDER' | 'ACCOUNT_OWNER' | 'RESPONDER';
+/** @public */
+type Language = 'de' | 'en';
+/** @public */
+interface Phone {
+    regionCode: string;
+    number: string;
+}
+/** @public */
+interface AlertSource {
+    id: number;
+    name: string;
+    status: AlertSourceStatus;
+    escalationPolicy: EscalationPolicy;
+    integrationType: AlertSourceIntegrationType;
+    integrationKey?: string;
+    iconUrl?: string;
+    lightIconUrl?: string;
+    darkIconUrl?: string;
+    alertCreation?: AlertSourceAlertCreation;
+    alertPriorityRule?: AlertSourceAlertPriorityRule;
+    emailFiltered?: boolean;
+    emailResolveFiltered?: boolean;
+    active?: boolean;
+    emailPredicates?: AlertSourceEmailPredicate[];
+    emailResolvePredicates?: AlertSourceEmailPredicate[];
+    filterOperator?: AlertSourceFilterOperator;
+    resolveFilterOperator?: AlertSourceFilterOperator;
+    supportHours?: AlertSourceSupportHours;
+    heartbeat?: AlertSourceHeartbeat;
+    autotaskMetadata?: AlertSourceAutotaskMetadata;
+    autoResolutionTimeout?: string;
+    teams: TeamShort[];
+}
+/** @public */
+interface TeamShort {
+    id: number;
+    name: string;
+}
+/** @public */
+interface TeamMember {
+    user: User;
+    role: 'STAKEHOLDER' | 'RESPONDER' | 'USER' | 'ADMIN';
+}
+/** @public */
+type AlertSourceStatus = 'PENDING' | 'ALL_ACCEPTED' | 'ALL_RESOLVED' | 'IN_MAINTENANCE' | 'DISABLED';
+/** @public */
+type AlertSourceIntegrationType = 'NAGIOS' | 'ICINGA' | 'EMAIL' | 'SMS' | 'API' | 'CRN' | 'HEARTBEAT' | 'PRTG' | 'PINGDOM' | 'CLOUDWATCH' | 'AWSPHD' | 'STACKDRIVER' | 'INSTANA' | 'ZABBIX' | 'SOLARWINDS' | 'PROMETHEUS' | 'NEWRELIC' | 'GRAFANA' | 'GITHUB' | 'DATADOG' | 'UPTIMEROBOT' | 'APPDYNAMICS' | 'DYNATRACE' | 'TOPDESK' | 'STATUSCAKE' | 'MONITOR' | 'TOOL' | 'CHECKMK' | 'AUTOTASK' | 'AWSBUDGET' | 'KENTIXAM' | 'CONSUL' | 'ZAMMAD' | 'SIGNALFX' | 'SPLUNK' | 'KUBERNETES' | 'SEMATEXT' | 'SENTRY' | 'SUMOLOGIC' | 'RAYGUN' | 'MXTOOLBOX' | 'ESWATCHER' | 'AMAZONSNS' | 'KAPACITOR' | 'CORTEXXSOAR' | string;
+/** @public */
+type AlertSourceAlertCreation = 'ONE_ALERT_PER_EMAIL' | 'ONE_ALERT_PER_EMAIL_SUBJECT' | 'ONE_PENDING_ALERT_ALLOWED' | 'ONE_OPEN_ALERT_ALLOWED' | 'OPEN_RESOLVE_ON_EXTRACTION';
+/** @public */
+type AlertSourceFilterOperator = 'AND' | 'OR';
+/** @public */
+type AlertSourceAlertPriorityRule = 'HIGH' | 'LOW' | 'HIGH_DURING_SUPPORT_HOURS' | 'LOW_DURING_SUPPORT_HOURS';
+/** @public */
+declare const OPERATIONAL = "OPERATIONAL";
+/** @public */
+declare const UNDER_MAINTENANCE = "UNDER_MAINTENANCE";
+/** @public */
+declare const DEGRADED = "DEGRADED";
+/** @public */
+declare const PARTIAL_OUTAGE = "PARTIAL_OUTAGE";
+/** @public */
+declare const MAJOR_OUTAGE = "MAJOR_OUTAGE";
+/** @public */
+type ServiceStatus = typeof OPERATIONAL | typeof UNDER_MAINTENANCE | typeof DEGRADED | typeof PARTIAL_OUTAGE | typeof MAJOR_OUTAGE;
+/** @public */
+declare const PRIVATE = "PRIVATE";
+/** @public */
+declare const PUBLIC = "PUBLIC";
+/** @public */
+type StatusPageVisibility = typeof PRIVATE | typeof PUBLIC;
+/** @public */
+interface AlertSourceEmailPredicate {
+    field: 'EMAIL_FROM' | 'EMAIL_SUBJECT' | 'EMAIL_BODY';
+    criteria: 'CONTAINS_ANY_WORDS' | 'CONTAINS_NOT_WORDS' | 'CONTAINS_STRING' | 'CONTAINS_NOT_STRING' | 'IS_STRING' | 'IS_NOT_STRING' | 'MATCHES_REGEX' | 'MATCHES_NOT_REGEX';
+    value: string;
+}
+/** @public */
+type AlertSourceTimeZone = 'Europe/Berlin' | 'America/New_York' | 'America/Los_Angeles' | 'Asia/Istanbul';
+/** @public */
+interface AlertSourceSupportDay {
+    start: string;
+    end: string;
+}
+/** @public */
+interface AlertSourceSupportHours {
+    timezone: AlertSourceTimeZone;
+    autoRaiseAlerts: boolean;
+    supportDays: {
+        MONDAY: AlertSourceSupportDay;
+        TUESDAY: AlertSourceSupportDay;
+        WEDNESDAY: AlertSourceSupportDay;
+        THURSDAY: AlertSourceSupportDay;
+        FRIDAY: AlertSourceSupportDay;
+        SATURDAY: AlertSourceSupportDay;
+        SUNDAY: AlertSourceSupportDay;
+    };
+}
+/** @public */
+interface AlertSourceHeartbeat {
+    summary: string;
+    intervalSec: number;
+    status: 'OVERDUE' | 'ON_TIME' | 'NEVER_RECEIVED';
+}
+/** @public */
+interface AlertSourceAutotaskMetadata {
+    userName: string;
+    secret: string;
+    apiIntegrationCode: string;
+    webServer: string;
+}
+/** @public */
+interface EscalationPolicy {
+    id: number;
+    name: string;
+    escalationRules: EscalationRule[];
+    newEscalationRule: EscalationRule;
+    repeating?: boolean;
+    frequency?: number;
+    teams: TeamShort[];
+}
+/** @public */
+interface EscalationRule {
+    user: User | null;
+    schedule: Schedule | null;
+    escalationTimeout: number;
+}
+/** @public */
+interface Schedule {
+    id: number;
+    name: string;
+    timezone: string;
+    startsOn: string;
+    currentShift: Shift;
+    nextShift: Shift;
+    shifts: Shift[];
+    overrides: Shift[];
+    teams: TeamShort[];
+}
+/** @public */
+interface Shift {
+    user: User;
+    start: string;
+    end: string;
+}
+/** @public */
+interface AlertResponder {
+    group: 'SUGGESTED' | 'USER' | 'ESCALATION_POLICY' | 'ON_CALL_SCHEDULE';
+    id: number;
+    name: string;
+    disabled: boolean;
+}
+/** @public */
+interface AlertAction {
+    name: string;
+    type: string;
+    webhookId: string;
+    extensionId?: string;
+    history?: AlertActionHistory[];
+}
+/** @public */
+interface AlertActionHistory {
+    id: string;
+    webhookId: string;
+    alertId: number;
+    actor: User;
+    success: boolean;
+}
+/** @public */
+interface OnCall {
+    user: User;
+    escalationPolicy: EscalationPolicy;
+    schedule?: Schedule;
+    start: string;
+    end: string;
+    escalationLevel: number;
+}
+/** @public */
+interface Service {
+    id: number;
+    name: string;
+    status: ServiceStatus;
+    uptime: Uptime;
+}
+/** @public */
+interface Uptime {
+    uptimePercentage: UptimePercentage;
+}
+/** @public */
+interface UptimePercentage {
+    p90: number;
+}
+/** @public */
+interface StatusPage {
+    id: number;
+    name: string;
+    domain: string;
+    subdomain: string;
+    visibility: StatusPageVisibility;
+    status: ServiceStatus;
+}
+
+/** @public */
+type TableState = {
+    page: number;
+    pageSize: number;
+};
+/** @public */
+type GetAlertsOpts = {
+    maxResults?: number;
+    startIndex?: number;
+    states?: AlertStatus[];
+    alertSources?: number[];
+};
+/** @public */
+type GetAlertsCountOpts = {
+    states?: AlertStatus[];
+};
+/** @public */
+type GetServicesOpts = {
+    maxResults?: number;
+    startIndex?: number;
+};
+/** @public */
+type GetStatusPagesOpts = {
+    maxResults?: number;
+    startIndex?: number;
+};
+/** @public */
+type EventRequest = {
+    integrationKey: string;
+    summary: string;
+    details: string;
+    userName: string;
+    source: string;
+};
+/** @public */
+interface ILertApi {
+    fetchAlerts(opts?: GetAlertsOpts): Promise<Alert[]>;
+    fetchAlertsCount(opts?: GetAlertsCountOpts): Promise<number>;
+    fetchAlert(id: number): Promise<Alert>;
+    fetchAlertResponders(alert: Alert): Promise<AlertResponder[]>;
+    fetchAlertActions(alert: Alert): Promise<AlertAction[]>;
+    acceptAlert(alert: Alert, userName: string): Promise<Alert>;
+    resolveAlert(alert: Alert, userName: string): Promise<Alert>;
+    assignAlert(alert: Alert, responder: AlertResponder): Promise<Alert>;
+    createAlert(eventRequest: EventRequest): Promise<boolean>;
+    triggerAlertAction(alert: Alert, action: AlertAction): Promise<void>;
+    fetchAlertSources(): Promise<AlertSource[]>;
+    fetchAlertSource(idOrIntegrationKey: number | string): Promise<AlertSource>;
+    fetchAlertSourceOnCalls(alertSource: AlertSource): Promise<OnCall[]>;
+    enableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
+    disableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
+    addImmediateMaintenance(alertSourceId: number, minutes: number): Promise<void>;
+    fetchOnCallSchedules(): Promise<Schedule[]>;
+    fetchUsers(): Promise<User[]>;
+    overrideShift(scheduleId: number, userId: number, start: string, end: string): Promise<Schedule>;
+    fetchServices(opts?: GetServicesOpts): Promise<Service[]>;
+    fetchStatusPages(opts?: GetStatusPagesOpts): Promise<StatusPage[]>;
+    getAlertDetailsURL(alert: Alert): string;
+    getAlertSourceDetailsURL(alertSource: AlertSource | null): string;
+    getEscalationPolicyDetailsURL(escalationPolicy: EscalationPolicy): string;
+    getScheduleDetailsURL(schedule: Schedule): string;
+    getServiceDetailsURL(service: Service): string;
+    getStatusPageDetailsURL(statusPage: StatusPage): string;
+    getStatusPageURL(statusPage: StatusPage): string;
+    getUserPhoneNumber(user: User | null): string;
+    getUserInitials(user: User | null): string;
+}
+
+/** @public */
+declare const ilertApiRef: _backstage_core_plugin_api.ApiRef<ILertApi>;
+/** @public */
+declare class ILertClient implements ILertApi {
+    private readonly discoveryApi;
+    private readonly proxyPath;
+    private readonly baseUrl;
+    static fromConfig(configApi: ConfigApi, discoveryApi: DiscoveryApi): ILertClient;
+    constructor(opts: {
+        discoveryApi: DiscoveryApi;
+        /**
+         * URL used by users to access iLert web UI.
+         * Example: https://my-org.ilert.com/
+         */
+        baseUrl: string;
+        /**
+         * Path to use for requests via the proxy, defaults to /ilert/api
+         */
+        proxyPath: string;
+    });
+    private fetch;
+    fetchAlerts(opts?: GetAlertsOpts): Promise<Alert[]>;
+    fetchAlertsCount(opts?: GetAlertsCountOpts): Promise<number>;
+    fetchAlert(id: number): Promise<Alert>;
+    fetchAlertResponders(alert: Alert): Promise<AlertResponder[]>;
+    fetchAlertActions(alert: Alert): Promise<AlertAction[]>;
+    acceptAlert(alert: Alert, userName: string): Promise<Alert>;
+    resolveAlert(alert: Alert, userName: string): Promise<Alert>;
+    assignAlert(alert: Alert, responder: AlertResponder): Promise<Alert>;
+    triggerAlertAction(alert: Alert, action: AlertAction): Promise<void>;
+    createAlert(eventRequest: EventRequest): Promise<boolean>;
+    fetchAlertSources(): Promise<AlertSource[]>;
+    fetchAlertSource(idOrIntegrationKey: number | string): Promise<AlertSource>;
+    fetchAlertSourceOnCalls(alertSource: AlertSource): Promise<OnCall[]>;
+    enableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
+    disableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
+    addImmediateMaintenance(alertSourceId: number, minutes: number): Promise<void>;
+    fetchOnCallSchedules(): Promise<Schedule[]>;
+    fetchUsers(): Promise<User[]>;
+    overrideShift(scheduleId: number, userId: number, start: string, end: string): Promise<Schedule>;
+    fetchServices(opts?: GetServicesOpts): Promise<Service[]>;
+    fetchStatusPages(opts?: GetStatusPagesOpts): Promise<StatusPage[]>;
+    getAlertDetailsURL(alert: Alert): string;
+    getAlertSourceDetailsURL(alertSource: AlertSource | null): string;
+    getEscalationPolicyDetailsURL(escalationPolicy: EscalationPolicy): string;
+    getScheduleDetailsURL(schedule: Schedule): string;
+    getServiceDetailsURL(service: Service): string;
+    getStatusPageDetailsURL(statusPage: StatusPage): string;
+    getStatusPageURL(statusPage: StatusPage): string;
+    getUserPhoneNumber(user: User | null): string;
+    getUserInitials(user: User | null): string;
+    private apiUrl;
+}
+
+/** @public */
+declare const iLertRouteRef: _backstage_core_plugin_api.RouteRef<undefined>;
+
+export { ACCEPTED, type Alert, type AlertAction, type AlertActionHistory, type AlertPriority, type AlertResponder, type AlertSource, type AlertSourceAlertCreation, type AlertSourceAlertPriorityRule, type AlertSourceAutotaskMetadata, type AlertSourceEmailPredicate, type AlertSourceFilterOperator, type AlertSourceHeartbeat, type AlertSourceIntegrationType, type AlertSourceStatus, type AlertSourceSupportDay, type AlertSourceSupportHours, type AlertSourceTimeZone, type AlertStatus, DEGRADED, EntityILertCard, type EscalationPolicy, type EscalationRule, type EventRequest, type GetAlertsCountOpts, type GetAlertsOpts, type GetServicesOpts, type GetStatusPagesOpts, type ILertApi, ILertCard, ILertClient, ILertIcon, ILertPage$1 as ILertPage, type Image, type Language, type Link, type LogEntry, MAJOR_OUTAGE, OPERATIONAL, type OnCall, PARTIAL_OUTAGE, PENDING, PRIVATE, PUBLIC, type Phone, RESOLVED, type Responder, ILertPage as Router, type Schedule, type Service, type ServiceStatus, type Shift, type StatusPage, type StatusPageVisibility, type Subscriber, type SubscriberType, type TableState, type TeamMember, type TeamShort, UNDER_MAINTENANCE, type Uptime, type UptimePercentage, type User, type UserRole, iLertRouteRef, ilertApiRef, ilertPlugin, isPluginApplicableToEntity as isILertAvailable, isPluginApplicableToEntity, ilertPlugin as plugin };