@placeos/ts-client 4.3.1 → 4.4.1

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "4.3.1",
+    "version": "4.4.1",
     "license": "MIT",
     "name": "@placeos/ts-client",
     "author": "Alex Sorafumo <alex@place.tech>",

package/src/alerts/alert.ts

@@ -0,0 +1,44 @@
+import { PlaceResource } from '../resources/resource';
+import { TriggerConditions } from '../triggers/interfaces';
+import { PlaceAlertDashboard } from './dashboard';
+
+export type AlertSeverity = 'low' | 'medium' | 'high' | 'critical';
+export type AlertType = 'threshold' | 'status' | 'custom';
+
+export class PlaceAlert extends PlaceResource {
+    // Dashboard to show this alert on
+    public readonly alert_dashboard_id: string;
+    // Details of the dashboard assigned
+    public readonly alert_dashboard_details: PlaceAlertDashboard | undefined;
+    // Domain authority that the dashboard exists under
+    public readonly authority_id: string;
+    // Description of the dashboard's purpose
+    public readonly description: string;
+    // Whether the dashboard is enabled or not
+    public readonly enabled: boolean;
+    // Conditions for triggering the alert
+    public readonly conditions: TriggerConditions;
+    // Severity of the alert
+    public readonly severity: AlertSeverity;
+    // Type of the alert
+    public readonly alert_type: AlertType;
+    // How often should this alert should be raised when triggered
+    public readonly debounce_period: number;
+
+    constructor(data: Partial<PlaceAlert>) {
+        super(data);
+        this.authority_id = data.authority_id || '';
+        this.description = data.description || '';
+        this.enabled = data.enabled || false;
+        this.conditions = data.conditions || {
+            time_dependents: [],
+            comparisons: [],
+        };
+        this.severity = data.severity || 'low';
+        this.alert_type = data.alert_type || 'threshold';
+        this.debounce_period = data.debounce_period || 0;
+        this.alert_dashboard_id = data.alert_dashboard_id || '';
+        this.alert_dashboard_details =
+            data.alert_dashboard_details || undefined;
+    }
+}

package/src/alerts/dashboard.ts

@@ -0,0 +1,17 @@
+import { PlaceResource } from '../resources/resource';
+
+export class PlaceAlertDashboard extends PlaceResource {
+    // Domain authority that the dashboard exists under
+    public readonly authority_id: string;
+    // Description of the dashboard's purpose
+    public readonly description: string;
+    // Whether the dashboard is enabled or not
+    public readonly enabled: boolean;
+
+    constructor(data: Partial<PlaceAlertDashboard>) {
+        super(data);
+        this.authority_id = data.authority_id || '';
+        this.description = data.description || '';
+        this.enabled = data.enabled || false;
+    }
+}

package/src/alerts/functions.ts

@@ -0,0 +1,197 @@
+import { create, query, remove, show, update } from '../api';
+import { PlaceResourceQueryOptions } from '../resources/interface';
+import { PlaceAlert } from './alert';
+import { PlaceAlertDashboard } from './dashboard';
+
+///////////////////////////////////////////////////////////////
+/////////////////////   Alert Dashboards   ////////////////////
+///////////////////////////////////////////////////////////////
+
+/**
+ * @private
+ */
+const DASHBOARD_PATH = 'alert_dashboards';
+
+/** Convert raw server data to an alert dashboard object */
+function processDashboard(item: Partial<PlaceAlertDashboard>) {
+    return new PlaceAlertDashboard(item);
+}
+
+/**
+ * Query the available alert dashboards
+ * @param query_params Query parameters to add the to request URL
+ */
+export function queryAlertDashboards(
+    query_params: PlaceResourceQueryOptions = {},
+) {
+    return query({
+        query_params,
+        fn: processDashboard,
+        path: DASHBOARD_PATH,
+    });
+}
+
+/**
+ * Get the data for an alert dashboard
+ * @param id ID of the alert dashboard to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export function showAlertDashboard(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return show({
+        id,
+        query_params,
+        fn: processDashboard,
+        path: DASHBOARD_PATH,
+    });
+}
+
+/**
+ * Update the alert dashboard in the database
+ * @param id ID of the alert dashboard
+ * @param form_data New values for the alert dashboard
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export function updateAlertDashboard(
+    id: string,
+    form_data: Partial<PlaceAlertDashboard>,
+    method: 'put' | 'patch' = 'patch',
+) {
+    return update({
+        id,
+        form_data,
+        query_params: {},
+        method,
+        fn: processDashboard,
+        path: DASHBOARD_PATH,
+    });
+}
+
+/**
+ * Add a new alert dashboard to the database
+ * @param form_data Application data
+ * @param query_params Query parameters to add the to request URL
+ */
+export function addAlertDashboard(form_data: Partial<PlaceAlertDashboard>) {
+    return create({
+        form_data,
+        query_params: {},
+        fn: processDashboard,
+        path: DASHBOARD_PATH,
+    });
+}
+
+/**
+ * Remove an alert dashboard from the database
+ * @param id ID of the alert dashboard
+ * @param query_params Query parameters to add the to request URL
+ */
+export function removeAlertDashboard(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return remove({ id, query_params, path: DASHBOARD_PATH });
+}
+
+/**
+ * Get list of alerts for dashbaord
+ * @param id Alert dashboard ID
+ */
+export function listDashboardAlerts(id: string) {
+    return query({
+        query_params: {},
+        fn: processAlert,
+        path: `${DASHBOARD_PATH}/${id}/alerts`,
+    });
+}
+
+///////////////////////////////////////////////////////////////
+//////////////////////////   Alerts   /////////////////////////
+///////////////////////////////////////////////////////////////
+
+/**
+ * @private
+ */
+const ALERT_PATH = 'alerts';
+
+/** Convert raw server data to an alert object */
+function processAlert(item: Partial<PlaceAlert>) {
+    return new PlaceAlert(item);
+}
+
+/**
+ * Query the available alerts
+ * @param query_params Query parameters to add the to request URL
+ */
+export function queryAlerts(query_params: PlaceResourceQueryOptions = {}) {
+    return query({
+        query_params,
+        fn: processAlert,
+        path: ALERT_PATH,
+    });
+}
+
+/**
+ * Get the data for an alert
+ * @param id ID of the alert to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export function showAlert(id: string, query_params: Record<string, any> = {}) {
+    return show({
+        id,
+        query_params,
+        fn: processAlert,
+        path: ALERT_PATH,
+    });
+}
+
+/**
+ * Update the alert in the database
+ * @param id ID of the alert
+ * @param form_data New values for the alert
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export function updateAlert(
+    id: string,
+    form_data: Partial<PlaceAlert>,
+    method: 'put' | 'patch' = 'patch',
+) {
+    return update({
+        id,
+        form_data,
+        query_params: {},
+        method,
+        fn: processAlert,
+        path: ALERT_PATH,
+    });
+}
+
+/**
+ * Add a new alert to the database
+ * @param form_data Application data
+ * @param query_params Query parameters to add the to request URL
+ */
+export function addAlert(form_data: Partial<PlaceAlert>) {
+    return create({
+        form_data,
+        query_params: {},
+        fn: processAlert,
+        path: ALERT_PATH,
+    });
+}
+
+/**
+ * Remove an alert from the database
+ * @param id ID of the alert
+ * @param query_params Query parameters to add the to request URL
+ */
+export function removeAlert(
+    id: string,
+    query_params: Record<string, any> = {},
+) {
+    return remove({ id, query_params, path: ALERT_PATH });
+}

package/src/api.ts

@@ -17,6 +17,22 @@ export {
     setMockNotFoundHandler,
 } from './http/mock';
 
+export { PlaceAlert } from './alerts/alert';
+export { PlaceAlertDashboard } from './alerts/dashboard';
+export {
+    addAlert,
+    addAlertDashboard,
+    listDashboardAlerts,
+    queryAlertDashboards,
+    queryAlerts,
+    removeAlert,
+    removeAlertDashboard,
+    showAlert,
+    showAlertDashboard,
+    updateAlert,
+    updateAlertDashboard,
+} from './alerts/functions';
+
 export { PlaceApplication } from './applications/application';
 export {
     addApplication,
@@ -308,7 +324,11 @@ export type {
     SignageMediaQueryOptions,
     SignageMetrics,
 } from './signage/interfaces';
-export { MediaAnimation, SignageMedia } from './signage/media.class';
+export {
+    MediaAnimation,
+    SignageMedia,
+    type MediaOrientation,
+} from './signage/media.class';
 export {
     SignagePlaylist,
     SignagePlaylistMedia,