@cellaware/utils 7.3.0 → 8.0.0

package/dist/chatwms/alerts.d.ts

@@ -0,0 +1,86 @@
+import { DataContext } from "./client.js";
+import { DatagridCondition, DatagridStateBase } from "./datagrid.js";
+export declare const ALERT_VISIBILITY_PRIVATE = "private";
+export declare const ALERT_VISIBILITY_PUBLIC = "public";
+/**
+ * Alert Strategy
+ *
+ * The strategy influences alert sending behavior when the previous alert execution
+ * resulted in the condition being met/alert being sent. Traditionally, alert systems
+ * will just send notifications over and over while the condition is met. This may be
+ * good sometimes, but could be very annoying otherwise. The strategy allows users to
+ * configure this behavior.
+ *
+ *  - once: will send once when the condition is met and will not send again until the condition
+ *    is no longer met
+ *  - change: if the condition is met, will send if there was a meaningful change in the data
+ *    since last execution
+ *  - always: sends every time as long as the condition is met
+ */
+export declare const ALERT_STRATEGY_ONCE = "once";
+export declare const ALERT_STRATEGY_CHANGE = "change";
+export declare const ALERT_STRATEGY_ALWAYS = "always";
+export interface Alert {
+    alertId: string;
+    alertTitle: string;
+    enabled: boolean;
+    visibility: string;
+    readonly: boolean;
+    folder: string;
+    strategy: string;
+    contentInfo: AlertContentInfo;
+    conditionInfo: DatagridCondition;
+    clientId: string;
+    userId: string;
+}
+export declare function initAlert(): Alert;
+export interface InstanceAlert extends Alert {
+    subscriptions: AlertSubscription[];
+}
+export interface AlertWithSubscriptions extends Alert {
+    subscriptions: AlertSubscriptionType[];
+    lastMet: string;
+    lastSent: string;
+}
+export interface AlertContentInfo extends DatagridStateBase {
+    contextName: DataContext;
+    specification: string;
+    query: string;
+    summary: string;
+    reviewOk?: boolean;
+    reviewConfidence?: string;
+    reviewFeedback?: string;
+    tableGroups?: string[];
+    developer?: boolean;
+}
+export interface AlertTestResult {
+    met: boolean;
+    rows: any[];
+    hashedRows: string[];
+}
+export declare function initAlertTestResult(): AlertTestResult;
+export interface AlertExecution {
+    alertId: string;
+    alertTitle: string;
+    strategy: string;
+    conditionInfo: DatagridCondition;
+    met: boolean;
+    hashedRows: string[];
+    error: string;
+    sent: boolean;
+    clientId: string;
+    customer: string;
+    warehouse: string;
+    userId: string;
+    datetime: Date;
+}
+export type AlertSubscriptionType = 'popup' | 'email' | 'teams';
+export declare const ALERT_SUBSCRIPTION_TYPES: string[];
+export interface AlertSubscription {
+    alertId: string;
+    type: AlertSubscriptionType;
+    clientId: string;
+    userId: string;
+    userDetails: string;
+}
+export declare function initAlertSubscription(): AlertSubscription;

package/dist/chatwms/alerts.js

@@ -0,0 +1,62 @@
+import { CHATWMS_CONTEXT_NAME } from "./client.js";
+import { initDatagridCondition } from "./datagrid.js";
+export const ALERT_VISIBILITY_PRIVATE = 'private';
+export const ALERT_VISIBILITY_PUBLIC = 'public';
+/**
+ * Alert Strategy
+ *
+ * The strategy influences alert sending behavior when the previous alert execution
+ * resulted in the condition being met/alert being sent. Traditionally, alert systems
+ * will just send notifications over and over while the condition is met. This may be
+ * good sometimes, but could be very annoying otherwise. The strategy allows users to
+ * configure this behavior.
+ *
+ *  - once: will send once when the condition is met and will not send again until the condition
+ *    is no longer met
+ *  - change: if the condition is met, will send if there was a meaningful change in the data
+ *    since last execution
+ *  - always: sends every time as long as the condition is met
+ */
+export const ALERT_STRATEGY_ONCE = 'once';
+export const ALERT_STRATEGY_CHANGE = 'change';
+export const ALERT_STRATEGY_ALWAYS = 'always';
+export function initAlert() {
+    return {
+        alertId: '',
+        alertTitle: '',
+        enabled: false,
+        visibility: ALERT_VISIBILITY_PRIVATE,
+        readonly: false,
+        folder: '',
+        strategy: ALERT_STRATEGY_ONCE,
+        contentInfo: initAlertContentInfo(),
+        conditionInfo: initDatagridCondition(),
+        clientId: '',
+        userId: ''
+    };
+}
+function initAlertContentInfo() {
+    return {
+        contextName: CHATWMS_CONTEXT_NAME,
+        specification: '',
+        query: '',
+        summary: ''
+    };
+}
+export function initAlertTestResult() {
+    return {
+        met: false,
+        rows: [],
+        hashedRows: []
+    };
+}
+export const ALERT_SUBSCRIPTION_TYPES = ['popup', 'email', 'teams'];
+export function initAlertSubscription() {
+    return {
+        alertId: '',
+        type: 'email',
+        clientId: '',
+        userId: '',
+        userDetails: ''
+    };
+}

package/dist/chatwms/client.d.ts

@@ -1,4 +1,8 @@
 export declare const CHATWMS_GENERIC_CLIENT_ID = "chatwms";
+export declare const CHATWMS_CONTEXT_NAME = "chatwms";
+export declare const DATABASE_CONTEXT_NAME = "database";
+export declare const COSMOS_CONTEXT_NAME = "cosmos";
+export type DataContext = 'chatwms' | 'database' | 'cosmos';
 export declare function chatwmsGetClientId(customer: string, warehouse: string): string;
 export declare function chatwmsGetWarehouseFromClientId(clientId: string, customer: string): string;
 export declare function chatwmsGetWarehouse(warehouse: string, organization?: string): string;

package/dist/chatwms/client.js

@@ -1,4 +1,7 @@
 export const CHATWMS_GENERIC_CLIENT_ID = 'chatwms';
+export const CHATWMS_CONTEXT_NAME = 'chatwms';
+export const DATABASE_CONTEXT_NAME = 'database';
+export const COSMOS_CONTEXT_NAME = 'cosmos';
 export function chatwmsGetClientId(customer, warehouse) {
     return `${customer}_${warehouse}`;
 }

package/dist/chatwms/dashboards.d.ts

@@ -0,0 +1,80 @@
+import { DataContext } from "./client.js";
+import { DatagridStateBase } from "./datagrid.js";
+export declare const DASHBOARD_VISIBILITY_PRIVATE = "private";
+export declare const DASHBOARD_VISIBILITY_PUBLIC = "public";
+export declare const DASHBOARD_VISIBILITY_GLOBAL = "global";
+export interface DashboardFilter {
+    sequence: number;
+    name: string;
+    sortDescending: boolean;
+    defaultValue: boolean;
+}
+export interface DashboardParameter {
+    sequence: number;
+    name: string;
+    required: boolean;
+    exampleValue: string;
+}
+export interface Dashboard {
+    dashboardId: string;
+    dashboardTitle: string;
+    dashboardRoute: string;
+    visibility: string;
+    readonly: boolean;
+    filters: DashboardFilter[];
+    parameters: DashboardParameter[];
+    folder: string;
+    clientId: string;
+    userId: string;
+}
+export declare function initDashboard(): Dashboard;
+export interface WidgetDashboardFilter {
+    sequence: number;
+    filterName: string;
+    columnName: string;
+}
+export interface WidgetDashboardParameter {
+    sequence: number;
+    parameterName: string;
+    columnName: string;
+}
+export interface DashboardWidgetContentInfo extends DatagridStateBase {
+    visualizationOption: string;
+    dashboardFilters: WidgetDashboardFilter[];
+    dashboardParameters: WidgetDashboardParameter[];
+    contextName: DataContext;
+    specification: string;
+    query: string;
+    summary: string;
+    reviewOk?: boolean;
+    reviewConfidence?: string;
+    reviewFeedback?: string;
+    tableGroups?: string[];
+    developer?: boolean;
+    archive?: boolean;
+    referenceWidgetId?: string;
+}
+export interface DashboardWidgetLayoutInfo {
+    id: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+export interface DashboardWidget {
+    widgetId: string;
+    widgetTitle: string;
+    dashboardId: string;
+    contentInfo: DashboardWidgetContentInfo;
+    layoutInfo: DashboardWidgetLayoutInfo;
+    clientId: string;
+    userId: string;
+}
+export interface DashboardUsage {
+    dashboardId: string;
+    dashboardTitle: string;
+    visibility: string;
+    clientId: string;
+    userId: string;
+    datetime: Date;
+}

package/dist/chatwms/dashboards.js

@@ -0,0 +1,17 @@
+export const DASHBOARD_VISIBILITY_PRIVATE = 'private';
+export const DASHBOARD_VISIBILITY_PUBLIC = 'public';
+export const DASHBOARD_VISIBILITY_GLOBAL = 'global';
+export function initDashboard() {
+    return {
+        dashboardId: '',
+        dashboardTitle: '',
+        dashboardRoute: '',
+        visibility: DASHBOARD_VISIBILITY_PRIVATE,
+        readonly: false,
+        filters: [],
+        parameters: [],
+        folder: '',
+        clientId: '',
+        userId: ''
+    };
+}

package/dist/chatwms/developer.d.ts

@@ -0,0 +1,27 @@
+import { KeyValuePair } from "../util.js";
+import { DataContext } from "./client.js";
+export interface SqlCacheContext {
+    contextName: DataContext;
+    variables: KeyValuePair[];
+    tables: {
+        table_name: string;
+        table_description: string;
+    }[];
+    columns: {
+        table_name: string;
+        column_id: number;
+        column_name: string;
+        data_type: string;
+        column_description: string;
+        column_comment: string;
+    }[];
+    functions: {
+        name: string;
+        type: string;
+        args: string[];
+        description: string;
+    }[];
+    tableMappings: KeyValuePair[];
+    columnMappings: KeyValuePair[];
+}
+export declare function initSqlCacheContext(): SqlCacheContext;

package/dist/chatwms/developer.js

@@ -0,0 +1,12 @@
+import { CHATWMS_CONTEXT_NAME } from "./client.js";
+export function initSqlCacheContext() {
+    return {
+        contextName: CHATWMS_CONTEXT_NAME,
+        variables: [],
+        tables: [],
+        columns: [],
+        functions: [],
+        tableMappings: [],
+        columnMappings: []
+    };
+}

package/dist/chatwms/reports.d.ts

@@ -0,0 +1,66 @@
+import { DataContext } from "./client.js";
+import { DatagridStateBase } from "./datagrid.js";
+export declare const REPORT_VISIBILITY_PRIVATE = "private";
+export declare const REPORT_VISIBILITY_PUBLIC = "public";
+export declare const REPORT_VISIBILITY_GLOBAL = "global";
+export interface ReportParameter {
+    sequence: number;
+    name: string;
+    /** `text` | `number` | `date` | `boolean` */
+    type: string;
+}
+export interface Report {
+    reportId: string;
+    reportTitle: string;
+    reportRoute: string;
+    visibility: string;
+    readonly: boolean;
+    parameters: ReportParameter[];
+    folder: string;
+    brief: string;
+    clientId: string;
+    userId: string;
+}
+export declare function initReport(): Report;
+export interface LineReportParameter {
+    sequence: number;
+    parameterName: string;
+    columnName: string;
+}
+export interface ReportLineContentInfo extends DatagridStateBase {
+    visualizationOption: string;
+    reportParameters: LineReportParameter[];
+    contextName: DataContext;
+    specification: string;
+    query: string;
+    summary: string;
+    reviewOk?: boolean;
+    reviewConfidence?: string;
+    reviewFeedback?: string;
+    tableGroups?: string[];
+    developer?: boolean;
+    archive?: boolean;
+}
+export interface ReportLine {
+    lineId: string;
+    lineTitle: string;
+    reportId: string;
+    contentInfo: ReportLineContentInfo;
+    sequence: number;
+    clientId: string;
+    userId: string;
+}
+export interface ReportLineResult {
+    rows: any[];
+    rowsStr: string;
+    chartRows: any[];
+}
+export declare function initReportLineResult(): ReportLineResult;
+export interface ReportUsage {
+    reportId: string;
+    reportTitle: string;
+    visibility: string;
+    clientId: string;
+    userId: string;
+    datetime: Date;
+}

package/dist/chatwms/reports.js

@@ -0,0 +1,24 @@
+export const REPORT_VISIBILITY_PRIVATE = 'private';
+export const REPORT_VISIBILITY_PUBLIC = 'public';
+export const REPORT_VISIBILITY_GLOBAL = 'global';
+export function initReport() {
+    return {
+        reportId: '',
+        reportTitle: '',
+        reportRoute: '',
+        visibility: REPORT_VISIBILITY_PRIVATE,
+        readonly: false,
+        parameters: [],
+        folder: '',
+        brief: '',
+        clientId: '',
+        userId: ''
+    };
+}
+export function initReportLineResult() {
+    return {
+        rows: [],
+        rowsStr: '',
+        chartRows: []
+    };
+}

package/dist/chatwms/search.d.ts

@@ -0,0 +1,12 @@
+export declare enum SearchRecordType {
+    DASHBOARD = "dashboard",
+    DASHBOARD_WIDGET = "dashboard_widget",
+    DASHBOARD_FOLDER = "dashboard_folder",
+    REPORT = "report",
+    REPORT_LINE = "report_line",
+    REPORT_FOLDER = "report_folder"
+}
+export interface SearchRecord {
+    type: SearchRecordType;
+    data: any;
+}

package/dist/chatwms/search.js

@@ -0,0 +1,9 @@
+export var SearchRecordType;
+(function (SearchRecordType) {
+    SearchRecordType["DASHBOARD"] = "dashboard";
+    SearchRecordType["DASHBOARD_WIDGET"] = "dashboard_widget";
+    SearchRecordType["DASHBOARD_FOLDER"] = "dashboard_folder";
+    SearchRecordType["REPORT"] = "report";
+    SearchRecordType["REPORT_LINE"] = "report_line";
+    SearchRecordType["REPORT_FOLDER"] = "report_folder";
+})(SearchRecordType || (SearchRecordType = {}));

package/dist/util.d.ts

@@ -1,3 +1,7 @@
+export interface KeyValuePair {
+    key: string;
+    value: any;
+}
 export declare function sleep(ms: number): Promise<any>;
 export declare function reverse(str: string): string;
 export declare function base64Encode(str: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cellaware/utils",
-    "version": "7.3.0",
+    "version": "8.0.0",
     "description": "Cellaware Utilities for Node.js",
     "author": "Cellaware Technologies",
     "type": "module",