@persei/perseed-api 4.34.4 → 4.34.6

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

@@ -140,22 +140,25 @@
     "I18nTextTranslation": {
       "anyOf": [
         {
-          "type": "object",
-          "properties": {
-            "default": {
-              "type": "string"
-            }
-          },
-          "required": ["default"],
-          "additionalProperties": {
-            "type": "string"
-          }
+          "$ref": "#/definitions/I18nTextLocales"
         },
         {
           "type": "string"
         }
       ]
     },
+    "I18nTextLocales": {
+      "type": "object",
+      "properties": {
+        "default": {
+          "type": "string"
+        }
+      },
+      "required": ["default"],
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
     "ColProps": {
       "type": "object",
       "properties": {
@@ -374,8 +377,7 @@
               "type": "boolean"
             },
             "aggType": {
-              "type": "string",
-              "enum": ["avg", "count", "max", "min", "sum"]
+              "$ref": "#/definitions/AggFunction"
             },
             "groupBy": {
               "anyOf": [
@@ -397,9 +399,7 @@
               "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"
+              "$ref": "#/definitions/OrderDir"
             }
           },
           "required": ["ecosystem", "projectName", "name"],
@@ -409,14 +409,39 @@
       "required": ["type", "params"],
       "additionalProperties": false
     },
+    "AggFunction": {
+      "type": "string",
+      "enum": ["avg", "count", "max", "min", "sum"]
+    },
     "OutcomesGroupBy": {
+      "anyOf": [
+        {
+          "type": "string",
+          "const": "name"
+        },
+        {
+          "type": "string",
+          "const": "identifier"
+        },
+        {
+          "type": "string",
+          "const": "value"
+        },
+        {
+          "$ref": "#/definitions/OutcomesDateFields"
+        },
+        {
+          "$ref": "#/definitions/OutcomeDateField"
+        }
+      ]
+    },
+    "OutcomesDateFields": {
+      "type": "string",
+      "enum": ["from", "to"]
+    },
+    "OutcomeDateField": {
       "type": "string",
       "enum": [
-        "name",
-        "identifier",
-        "value",
-        "from",
-        "to",
         "from.date",
         "from.day",
         "from.dayname",
@@ -453,6 +478,11 @@
         "to.yearweek"
       ]
     },
+    "OrderDir": {
+      "type": "string",
+      "enum": ["asc", "desc"],
+      "description": "Any changes here may need changes in Caaring-js packages/perseed-api-client/src/PerseedApiClient.ts"
+    },
     "PatientListProps": {
       "type": "object",
       "properties": {

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

@@ -139,22 +139,25 @@
     "I18nTextTranslation": {
       "anyOf": [
         {
-          "type": "object",
-          "properties": {
-            "default": {
-              "type": "string"
-            }
-          },
-          "required": ["default"],
-          "additionalProperties": {
-            "type": "string"
-          }
+          "$ref": "#/definitions/I18nTextLocales"
         },
         {
           "type": "string"
         }
       ]
     },
+    "I18nTextLocales": {
+      "type": "object",
+      "properties": {
+        "default": {
+          "type": "string"
+        }
+      },
+      "required": ["default"],
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
     "ColProps": {
       "type": "object",
       "properties": {
@@ -373,8 +376,7 @@
               "type": "boolean"
             },
             "aggType": {
-              "type": "string",
-              "enum": ["avg", "count", "max", "min", "sum"]
+              "$ref": "#/definitions/AggFunction"
             },
             "groupBy": {
               "anyOf": [
@@ -396,9 +398,7 @@
               "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"
+              "$ref": "#/definitions/OrderDir"
             }
           },
           "required": ["ecosystem", "projectName", "name"],
@@ -408,14 +408,39 @@
       "required": ["type", "params"],
       "additionalProperties": false
     },
+    "AggFunction": {
+      "type": "string",
+      "enum": ["avg", "count", "max", "min", "sum"]
+    },
     "OutcomesGroupBy": {
+      "anyOf": [
+        {
+          "type": "string",
+          "const": "name"
+        },
+        {
+          "type": "string",
+          "const": "identifier"
+        },
+        {
+          "type": "string",
+          "const": "value"
+        },
+        {
+          "$ref": "#/definitions/OutcomesDateFields"
+        },
+        {
+          "$ref": "#/definitions/OutcomeDateField"
+        }
+      ]
+    },
+    "OutcomesDateFields": {
+      "type": "string",
+      "enum": ["from", "to"]
+    },
+    "OutcomeDateField": {
       "type": "string",
       "enum": [
-        "name",
-        "identifier",
-        "value",
-        "from",
-        "to",
         "from.date",
         "from.day",
         "from.dayname",
@@ -452,6 +477,11 @@
         "to.yearweek"
       ]
     },
+    "OrderDir": {
+      "type": "string",
+      "enum": ["asc", "desc"],
+      "description": "Any changes here may need changes in Caaring-js packages/perseed-api-client/src/PerseedApiClient.ts"
+    },
     "PatientListProps": {
       "type": "object",
       "properties": {

package/dist/schemas/notification_configuration/create_trigger_payload.schema.json

@@ -160,7 +160,7 @@
     },
     "ApiAction": {
       "type": "string",
-      "enum": ["questionnaire.create", "crf.create", "crf.update", "crf.delete"]
+      "enum": ["questionnaire.create", "crf.create", "crf.update", "crf.delete", "external_api_call"]
     },
     "ConditionsFormat": {
       "type": "string",

package/dist/schemas/notification_configuration/update_trigger_payload.schema.json

@@ -159,7 +159,7 @@
     },
     "ApiAction": {
       "type": "string",
-      "enum": ["questionnaire.create", "crf.create", "crf.update", "crf.delete"]
+      "enum": ["questionnaire.create", "crf.create", "crf.update", "crf.delete", "external_api_call"]
     },
     "ConditionsFormat": {
       "type": "string",

package/package.json

@@ -1,22 +1,16 @@
 {
   "name": "@persei/perseed-api",
-  "version": "4.34.4",
+  "version": "4.34.6",
   "private": false,
   "main": "./dist/perseed-api.umd.cjs",
   "module": "./dist/perseed-api.js",
   "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/perseed-api.js",
-      "require": "./dist/perseed-api.umd.cjs"
-    }
-  },
   "files": [
     "dist"
   ],
   "scripts": {
-    "publish": "npm run precommit && npm run build && npm publish",
-    "build": "tsc && vite build",
+    "publish_package": "npm run precommit && npm run build && npm publish",
+    "build": "tsc --noEmit && vite build",
     "start": "ts-node src/server.ts",
     "lint": "npm run test:lint",
     "jshint": "jshint . > report.txt || true",

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

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

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

@@ -1,29 +0,0 @@
-/**
- * Available MFA methods
- */
-export type MFAMethodCode = 'sms' | 'email';
-/**
- * MFA method definition and configuration
- */
-export interface MFAMethod {
-    code: MFAMethodCode;
-}
-/**
- * Global authentication security definition
- */
-export interface AuthenticationSecurityDefinition {
-    mfaMethods?: MFAMethod[];
-    required?: boolean;
-    default?: MFAMethodCode;
-}
-export interface MFALoginData {
-    type: MFAMethodCode;
-    value: string;
-}
-/**
- * req.body object mfa validation
- */
-export interface ReqBodyWithMFA {
-    mfa?: MFALoginData;
-    [key: string]: any;
-}

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

@@ -1,6 +0,0 @@
-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

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

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

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

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

@@ -1,10 +0,0 @@
-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

@@ -1,51 +0,0 @@
-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 {};

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

@@ -1,16 +0,0 @@
-export interface PatientListProps {
-    loadUserProfiles?: boolean;
-    loadAdherence?: boolean;
-    extraFields?: string[];
-    loadPushTokens?: boolean;
-    loadUserAccessData?: boolean;
-    programId?: number | null;
-    prevAdherenceDays?: number | null;
-    filter?: FilterParams;
-}
-export interface FilterParams {
-    conditions?: Record<string, unknown>;
-    relatedData?: {
-        join?: string[];
-    };
-}

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

@@ -1,9 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

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

package/dist/schemas/index.d.ts

@@ -1,6 +0,0 @@
-export * from './dashboard';
-export * from './authentication_security';
-export * from './notification_configuration';
-export * from './outcomes';
-export * from './questionnaire';
-export * from './user_settings';

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

@@ -1,2 +0,0 @@
-export * from './types';
-export * from './introspectionShema';

package/dist/schemas/notification_configuration/introspectionShema.d.ts

@@ -1,3 +0,0 @@
-import { TFunction } from 'i18next';
-import { IntrospectionSchema } from './types';
-export declare function getIntrospectionSchema(t: TFunction): IntrospectionSchema;

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

@@ -1,91 +0,0 @@
-type ModelName = string;
-export declare enum ApiAction {
-    QUESTIONNAIRE_CREATE = "questionnaire.create",
-    CRF_CREATE = "crf.create",
-    CRF_UPDATE = "crf.update",
-    CRF_DELETE = "crf.delete"
-}
-export type NotifiedAboutType = `model_${ModelName}` | `model_displayer_${ModelName}` | `model_${ModelName}_${TriggerAction}` | `model_displayer_${ModelName}_${TriggerAction}`;
-export interface CreateTriggerPayload {
-    notified_about: NotifiedAboutType;
-    text_content?: string;
-    configuration?: NotificationConfigurationConf;
-}
-export type UpdateTriggerPayload = Partial<CreateTriggerPayload>;
-export interface ConditionExpression {
-    [field: string]: ConditionValue;
-}
-export interface ConditionOperator {
-    AND?: Conditions[];
-    OR?: Conditions[];
-    NOT?: Conditions[];
-    JQ?: string;
-}
-export type Conditions = ConditionExpression | ConditionOperator;
-export interface ConditionValue {
-    equal?: string | number | boolean;
-    not_equal?: string | number | boolean;
-    contains?: string;
-    not_contains?: string;
-    greater_than?: string | number;
-    less_than?: string | number;
-    empty?: string | number | boolean;
-    not_empty?: string | number | boolean;
-    parseValue?: boolean;
-    operator?: 'AND' | 'OR';
-}
-interface LoadPatientDataType {
-    join?: string[];
-    where: Record<string, string> | 'auto';
-}
-export declare enum ConditionsFormat {
-    JSON_LOGIC = "jsonLogic",
-    CUSTOM = "custom"
-}
-/**
- * Importing the types from json-logic-js makes the process of generating schema.json fails so we use any instead
- */
-export type ConditionsRules = Conditions | any;
-export interface NotificationConfigurationConf {
-    conditions?: ConditionsRules;
-    join?: string[];
-    load_patient?: LoadPatientDataType;
-    action?: ApiAction;
-    conditionsFormat?: ConditionsFormat;
-}
-export declare enum TriggerAction {
-    CREATION = "creation",
-    UPDATE = "update"
-}
-export declare enum IntrospectionSchemaType {
-    TEXT = "text",
-    DATE = "date",
-    TIME = "time",
-    BOOLEAN = "boolean",
-    NUMBER = "number",
-    SELECT = "select",
-    MULTISELECT = "multiselect"
-}
-export interface IntrospectionField {
-    name: string;
-    type: IntrospectionSchemaType;
-    options?: {
-        value: string;
-        title: string;
-    }[];
-    label: string;
-}
-export interface IntrospectionOption {
-    value: string;
-    label: string;
-}
-export interface IntrospectionSchemaModel {
-    label: string;
-    fields: IntrospectionField[];
-    relations?: IntrospectionOption[];
-    canJoinPatient?: boolean;
-}
-export interface IntrospectionSchema {
-    models: Record<string, IntrospectionSchemaModel>;
-}
-export {};

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

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

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

@@ -1,35 +0,0 @@
-/**
- * Any changes here may need changes in Caaring-js packages/perseed-api-client/src/PerseedApiClient.ts
- */
-type OrderDir = 'asc' | 'desc';
-type AggFunction = 'avg' | 'count' | 'max' | 'min' | 'sum';
-type OutcomesDateFields = 'from' | 'to';
-type OutcomesDateFunctions = 'date' | 'day' | 'dayname' | 'dayofmonth' | 'dayofweek' | 'dayofyear' | 'hour' | 'minute' | 'month' | 'monthname' | 'time' | 'second' | 'week' | 'weekday' | 'weekofyear' | 'year' | 'yearweek';
-type OutcomeDateField = `${OutcomesDateFields}.${OutcomesDateFunctions}`;
-export type OutcomesGroupBy = 'name' | 'identifier' | 'value' | OutcomesDateFields | OutcomeDateField;
-interface OutcomeDateGroup {
-    [dateGroup: string]: string;
-}
-export type Outcome = OutcomeDateGroup & {
-    name: string;
-    identifier: string;
-    from: string;
-    to: string;
-    value: number;
-};
-export interface OutcomesParams {
-    ecosystem: string;
-    projectName: string;
-    clinicId?: number;
-    name: string | string[];
-    identifier?: string | string[];
-    from?: string;
-    to?: string;
-    datesContained?: boolean;
-    aggType?: AggFunction;
-    groupBy?: OutcomesGroupBy | OutcomesGroupBy[];
-    limit?: number;
-    orderBy?: string;
-    orderDir?: OrderDir;
-}
-export {};

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

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

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

@@ -1,7 +0,0 @@
-export interface CreateQuestionnairePayload {
-    patientId?: number;
-    type: 'unique' | 'periodic';
-    date: string;
-    untilDate?: string;
-    formName: string;
-}

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

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

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

@@ -1,5 +0,0 @@
-/**
- * App font factor
- */
-export type AppFontFactor = number;
-export type GenericBooleanSetting = boolean;