@persei/perseed-api 4.34.2

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

@@ -0,0 +1,486 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/UpdateDashboardPayload",
+  "definitions": {
+    "UpdateDashboardPayload": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string"
+        },
+        "active": {
+          "type": "boolean"
+        },
+        "config": {
+          "$ref": "#/definitions/DashboardConfig"
+        },
+        "icon": {
+          "type": ["string", "null"]
+        },
+        "weight": {
+          "type": "number"
+        }
+      },
+      "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/widgets/PatientListProps.d.ts

@@ -0,0 +1,9 @@
+export interface PatientListProps {
+    loadUserProfiles?: boolean;
+    loadAdherence?: boolean;
+    extraFields?: string[];
+    loadPushTokens?: boolean;
+    loadUserAccessData?: boolean;
+    programId?: number | null;
+    prevAdherenceDays?: number | null;
+}

package/dist/schemas/dashboard/widgets/SectionCardProps.d.ts

@@ -0,0 +1,9 @@
+import { Widget } from '../types';
+import { I18nTextTranslation } from '../i18n';
+export interface SectionCardProps {
+    icon: string;
+    background?: string;
+    titleBackground?: string;
+    title: I18nTextTranslation;
+    widgets: Widget[];
+}

package/dist/schemas/dashboard/widgets/ValueCardProps.d.ts

@@ -0,0 +1,13 @@
+import { I18nTextTranslation } from '../i18n';
+import { WidgetDataLoader } from '../types';
+import { WidgetOutcomesDataLoader } from '../data_loaders/Outcomes';
+export interface ValueCardProps {
+    title: I18nTextTranslation;
+    icon: string;
+    text: I18nTextTranslation;
+    subtext?: I18nTextTranslation;
+    titleTextColor?: string;
+    bodyTextColor?: string;
+    data?: Record<string, any>;
+    dataLoader?: WidgetDataLoader<WidgetOutcomesDataLoader>;
+}

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

@@ -0,0 +1,3 @@
+export * from './PatientListProps';
+export * from './SectionCardProps';
+export * from './ValueCardProps';

package/dist/schemas/forms/create.schema.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "schema for create form",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "additionalProperties": {
+      "type": ["integer", "string", "boolean", "null", "array", "object"]
+    }
+  },
+  "maxLength": 1
+}

package/dist/schemas/forms/update.schema.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "validation update form",
+  "anyOf": [
+    {
+      "type": "object",
+      "additionalProperties": {
+        "type": ["integer", "string", "boolean", "null", "array", "object"]
+      }
+    },
+    {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": {
+          "type": ["integer", "string", "boolean", "null", "array", "object"]
+        }
+      },
+      "maxLength": 1
+    }
+  ]
+}

package/dist/schemas/hospital/create.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "validation create hospital",
+  "anyOf": [
+    {
+      "type": "object",
+      "patternProperties": {
+        "^[0-9a-z_]+$": { "type": ["string", "null", "number"] }
+      },
+      "additionalProperties": false
+    },
+    {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "patternProperties": {
+          "^[0-9a-z_]+$": { "type": ["string", "null", "number"] }
+        },
+        "additionalProperties": false
+      }
+    }
+  ]
+}

package/dist/schemas/index.d.ts

@@ -0,0 +1,15 @@
+import * as dashboard from './dashboard';
+import * as authentication_security from './authentication_security';
+import * as notification_configuration from './notification_configuration';
+import * as outcomes from './outcomes';
+import * as questionnaire from './questionnaire';
+import * as user_settings from './user_settings';
+declare const schemas: {
+    dashboard: typeof dashboard;
+    authentication_security: typeof authentication_security;
+    notification_configuration: typeof notification_configuration;
+    outcomes: typeof outcomes;
+    questionnaire: typeof questionnaire;
+    user_settings: typeof user_settings;
+};
+export default schemas;

package/dist/schemas/mfa/mfa-login-data.schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/ReqBodyWithMFA",
+  "definitions": {
+    "ReqBodyWithMFA": {
+      "type": "object",
+      "properties": {
+        "mfa": {
+          "$ref": "#/definitions/MFALoginData"
+        }
+      },
+      "description": "req.body object mfa validation"
+    },
+    "MFALoginData": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "$ref": "#/definitions/MFAMethodCode"
+        },
+        "value": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "value"],
+      "additionalProperties": false
+    },
+    "MFAMethodCode": {
+      "type": "string",
+      "enum": ["sms", "email"],
+      "description": "Available MFA methods"
+    }
+  }
+}

package/dist/schemas/mobile/searchnotificationstatus.schema.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "schema for create new patient endpoint",
+  "type": "array",
+  "items": {
+    "type": "string",
+    "pattern": "^[0-9]+$"
+  }
+}