@persei/perseed-api 4.34.2

package/dist/schemas/dashboard/create_dashboard_payload.schema.json

@@ -0,0 +1,487 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/CreateDashboardPayload",
+  "definitions": {
+    "CreateDashboardPayload": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string"
+        },
+        "active": {
+          "type": "boolean"
+        },
+        "config": {
+          "$ref": "#/definitions/DashboardConfig"
+        },
+        "icon": {
+          "type": ["string", "null"]
+        },
+        "weight": {
+          "type": "number"
+        }
+      },
+      "required": ["title"],
+      "additionalProperties": false
+    },
+    "DashboardConfig": {
+      "type": "object",
+      "properties": {
+        "widgets": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Widget"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "Widget": {
+      "anyOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "SectionCard"
+            },
+            "params": {
+              "$ref": "#/definitions/SectionCardProps"
+            },
+            "size": {
+              "anyOf": [
+                {
+                  "type": "number"
+                },
+                {
+                  "$ref": "#/definitions/ColProps"
+                }
+              ]
+            }
+          },
+          "required": ["params", "type"]
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "ValueCard"
+            },
+            "params": {
+              "$ref": "#/definitions/ValueCardProps"
+            },
+            "size": {
+              "anyOf": [
+                {
+                  "type": "number"
+                },
+                {
+                  "$ref": "#/definitions/ColProps"
+                }
+              ]
+            }
+          },
+          "required": ["params", "type"]
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "PatientList"
+            },
+            "params": {
+              "$ref": "#/definitions/PatientListProps"
+            },
+            "size": {
+              "anyOf": [
+                {
+                  "type": "number"
+                },
+                {
+                  "$ref": "#/definitions/ColProps"
+                }
+              ]
+            }
+          },
+          "required": ["params", "type"]
+        }
+      ]
+    },
+    "SectionCardProps": {
+      "type": "object",
+      "properties": {
+        "icon": {
+          "type": "string"
+        },
+        "background": {
+          "type": "string"
+        },
+        "titleBackground": {
+          "type": "string"
+        },
+        "title": {
+          "$ref": "#/definitions/I18nTextTranslation"
+        },
+        "widgets": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Widget"
+          }
+        }
+      },
+      "required": ["icon", "title", "widgets"],
+      "additionalProperties": false
+    },
+    "I18nTextTranslation": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "default": {
+              "type": "string"
+            }
+          },
+          "required": ["default"],
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "ColProps": {
+      "type": "object",
+      "properties": {
+        "flex": {
+          "$ref": "#/definitions/FlexType"
+        },
+        "span": {
+          "$ref": "#/definitions/ColSpanType"
+        },
+        "order": {
+          "$ref": "#/definitions/ColSpanType"
+        },
+        "offset": {
+          "$ref": "#/definitions/ColSpanType"
+        },
+        "push": {
+          "$ref": "#/definitions/ColSpanType"
+        },
+        "pull": {
+          "$ref": "#/definitions/ColSpanType"
+        },
+        "xs": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ColSpanType"
+            },
+            {
+              "$ref": "#/definitions/ColSize"
+            }
+          ]
+        },
+        "sm": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ColSpanType"
+            },
+            {
+              "$ref": "#/definitions/ColSize"
+            }
+          ]
+        },
+        "md": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ColSpanType"
+            },
+            {
+              "$ref": "#/definitions/ColSize"
+            }
+          ]
+        },
+        "lg": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ColSpanType"
+            },
+            {
+              "$ref": "#/definitions/ColSize"
+            }
+          ]
+        },
+        "xl": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ColSpanType"
+            },
+            {
+              "$ref": "#/definitions/ColSize"
+            }
+          ]
+        },
+        "xxl": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ColSpanType"
+            },
+            {
+              "$ref": "#/definitions/ColSize"
+            }
+          ]
+        },
+        "prefixCls": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "FlexType": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "string",
+          "const": "none"
+        },
+        {
+          "type": "string",
+          "const": "auto"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "ColSpanType": {
+      "type": ["number", "string"]
+    },
+    "ColSize": {
+      "type": "object",
+      "properties": {
+        "flex": {
+          "$ref": "#/definitions/FlexType"
+        },
+        "span": {
+          "$ref": "#/definitions/ColSpanType"
+        },
+        "order": {
+          "$ref": "#/definitions/ColSpanType"
+        },
+        "offset": {
+          "$ref": "#/definitions/ColSpanType"
+        },
+        "push": {
+          "$ref": "#/definitions/ColSpanType"
+        },
+        "pull": {
+          "$ref": "#/definitions/ColSpanType"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ValueCardProps": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "$ref": "#/definitions/I18nTextTranslation"
+        },
+        "icon": {
+          "type": "string"
+        },
+        "text": {
+          "$ref": "#/definitions/I18nTextTranslation"
+        },
+        "subtext": {
+          "$ref": "#/definitions/I18nTextTranslation"
+        },
+        "titleTextColor": {
+          "type": "string"
+        },
+        "bodyTextColor": {
+          "type": "string"
+        },
+        "data": {
+          "type": "object"
+        },
+        "dataLoader": {
+          "$ref": "#/definitions/WidgetDataLoader%3CWidgetOutcomesDataLoader%3E"
+        }
+      },
+      "required": ["title", "icon", "text"],
+      "additionalProperties": false
+    },
+    "WidgetDataLoader<WidgetOutcomesDataLoader>": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "outcomes"
+        },
+        "params": {
+          "type": "object",
+          "properties": {
+            "ecosystem": {
+              "type": "string"
+            },
+            "projectName": {
+              "type": "string"
+            },
+            "clinicId": {
+              "type": "number"
+            },
+            "name": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            },
+            "identifier": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            },
+            "from": {
+              "type": "string"
+            },
+            "to": {
+              "type": "string"
+            },
+            "datesContained": {
+              "type": "boolean"
+            },
+            "aggType": {
+              "type": "string",
+              "enum": ["avg", "count", "max", "min", "sum"]
+            },
+            "groupBy": {
+              "anyOf": [
+                {
+                  "$ref": "#/definitions/OutcomesGroupBy"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/definitions/OutcomesGroupBy"
+                  }
+                }
+              ]
+            },
+            "limit": {
+              "type": "number"
+            },
+            "orderBy": {
+              "type": "string"
+            },
+            "orderDir": {
+              "type": "string",
+              "enum": ["asc", "desc"],
+              "description": "Any changes here may need changes in Caaring-js packages/perseed-api-client/src/PerseedApiClient.ts"
+            }
+          },
+          "required": ["ecosystem", "projectName", "name"],
+          "additionalProperties": false
+        }
+      },
+      "required": ["type", "params"],
+      "additionalProperties": false
+    },
+    "OutcomesGroupBy": {
+      "type": "string",
+      "enum": [
+        "name",
+        "identifier",
+        "value",
+        "from",
+        "to",
+        "from.date",
+        "from.day",
+        "from.dayname",
+        "from.dayofmonth",
+        "from.dayofweek",
+        "from.dayofyear",
+        "from.hour",
+        "from.minute",
+        "from.month",
+        "from.monthname",
+        "from.time",
+        "from.second",
+        "from.week",
+        "from.weekday",
+        "from.weekofyear",
+        "from.year",
+        "from.yearweek",
+        "to.date",
+        "to.day",
+        "to.dayname",
+        "to.dayofmonth",
+        "to.dayofweek",
+        "to.dayofyear",
+        "to.hour",
+        "to.minute",
+        "to.month",
+        "to.monthname",
+        "to.time",
+        "to.second",
+        "to.week",
+        "to.weekday",
+        "to.weekofyear",
+        "to.year",
+        "to.yearweek"
+      ]
+    },
+    "PatientListProps": {
+      "type": "object",
+      "properties": {
+        "loadUserProfiles": {
+          "type": "boolean"
+        },
+        "loadAdherence": {
+          "type": "boolean"
+        },
+        "extraFields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "loadPushTokens": {
+          "type": "boolean"
+        },
+        "loadUserAccessData": {
+          "type": "boolean"
+        },
+        "programId": {
+          "type": ["number", "null"]
+        },
+        "prevAdherenceDays": {
+          "type": ["number", "null"]
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/dist/schemas/dashboard/data_loaders/Outcomes.d.ts

@@ -0,0 +1,6 @@
+import { DataLoaderType } from '../types';
+import { OutcomesParams } from '../../outcomes/types';
+export interface WidgetOutcomesDataLoader {
+    type: DataLoaderType.OUTCOMES;
+    params: OutcomesParams;
+}

package/dist/schemas/dashboard/data_loaders/index.d.ts

@@ -0,0 +1 @@
+export * from './Outcomes';

package/dist/schemas/dashboard/i18n.d.ts

@@ -0,0 +1,6 @@
+interface I18nTextLocales {
+    [locale: string]: string;
+    default: string;
+}
+export type I18nTextTranslation = I18nTextLocales | string;
+export {};

package/dist/schemas/dashboard/index.d.ts

@@ -0,0 +1,10 @@
+import * as data_loaders from './data_loaders';
+import * as widgets from './widgets';
+export * from './types';
+export * from './i18n';
+export * from './col.d';
+declare const dashboard: {
+    data_loaders: typeof data_loaders;
+    widgets: typeof widgets;
+};
+export default dashboard;

package/dist/schemas/dashboard/types.d.ts

@@ -0,0 +1,51 @@
+import { ColProps } from './col';
+import { PatientListProps } from './widgets/PatientListProps';
+import { SectionCardProps } from './widgets/SectionCardProps';
+import { ValueCardProps } from './widgets/ValueCardProps';
+/**
+ * Any changes here may need changes in Caaring-js packages/perseed-react-ui-components/src/dashboards/types.ts
+ */
+export declare enum DataLoaderType {
+    OUTCOMES = "outcomes"
+}
+export interface GenericWidgetDataLoader {
+    type: DataLoaderType;
+    params: Record<string, any>;
+}
+export type WidgetDataLoader<T> = T extends {
+    type: infer Type;
+    params: infer Params;
+} ? {
+    type: Type;
+    params: Params;
+} : never;
+interface BaseWidget {
+    size?: number | ColProps;
+}
+export declare enum DashboardWidgetType {
+    VALUECARD = "ValueCard",
+    SECTIONCARD = "SectionCard",
+    PATIENTLIST = "PatientList"
+}
+export type Widget = BaseWidget & ({
+    type: DashboardWidgetType.SECTIONCARD;
+    params: SectionCardProps;
+} | {
+    type: DashboardWidgetType.VALUECARD;
+    params: ValueCardProps;
+} | {
+    type: DashboardWidgetType.PATIENTLIST;
+    params: PatientListProps;
+});
+export interface DashboardConfig {
+    widgets?: Widget[];
+}
+export interface CreateDashboardPayload {
+    title: string;
+    active?: boolean;
+    config?: DashboardConfig;
+    icon?: string | null;
+    weight?: number;
+}
+export type UpdateDashboardPayload = Partial<CreateDashboardPayload>;
+export {};