@persei/perseed-api 4.34.2

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

@@ -0,0 +1,170 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/CreateTriggerPayload",
+  "definitions": {
+    "CreateTriggerPayload": {
+      "type": "object",
+      "properties": {
+        "notified_about": {
+          "$ref": "#/definitions/NotifiedAboutType"
+        },
+        "text_content": {
+          "type": "string"
+        },
+        "configuration": {
+          "$ref": "#/definitions/NotificationConfigurationConf"
+        }
+      },
+      "required": ["notified_about"],
+      "additionalProperties": false
+    },
+    "NotifiedAboutType": {
+      "type": ["string"]
+    },
+    "NotificationConfigurationConf": {
+      "type": "object",
+      "properties": {
+        "conditions": {
+          "$ref": "#/definitions/ConditionsRules"
+        },
+        "join": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "load_patient": {
+          "type": "object",
+          "properties": {
+            "join": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "where": {
+              "anyOf": [
+                {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "string",
+                  "const": "auto"
+                }
+              ]
+            }
+          },
+          "required": ["where"],
+          "additionalProperties": false
+        },
+        "action": {
+          "$ref": "#/definitions/ApiAction"
+        },
+        "conditionsFormat": {
+          "$ref": "#/definitions/ConditionsFormat"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ConditionsRules": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Conditions"
+        },
+        {}
+      ],
+      "description": "Importing the types from json-logic-js makes the process of generating schema.json fails so we use any instead"
+    },
+    "Conditions": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/ConditionExpression"
+        },
+        {
+          "$ref": "#/definitions/ConditionOperator"
+        }
+      ]
+    },
+    "ConditionExpression": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/ConditionValue"
+      }
+    },
+    "ConditionValue": {
+      "type": "object",
+      "properties": {
+        "equal": {
+          "type": ["string", "number", "boolean"]
+        },
+        "not_equal": {
+          "type": ["string", "number", "boolean"]
+        },
+        "contains": {
+          "type": "string"
+        },
+        "not_contains": {
+          "type": "string"
+        },
+        "greater_than": {
+          "type": ["string", "number"]
+        },
+        "less_than": {
+          "type": ["string", "number"]
+        },
+        "empty": {
+          "type": ["string", "number", "boolean"]
+        },
+        "not_empty": {
+          "type": ["string", "number", "boolean"]
+        },
+        "parseValue": {
+          "type": "boolean"
+        },
+        "operator": {
+          "type": "string",
+          "enum": ["AND", "OR"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "ConditionOperator": {
+      "type": "object",
+      "properties": {
+        "AND": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Conditions"
+          }
+        },
+        "OR": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Conditions"
+          }
+        },
+        "NOT": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Conditions"
+          }
+        },
+        "JQ": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ApiAction": {
+      "type": "string",
+      "enum": ["questionnaire.create", "crf.create", "crf.update", "crf.delete"]
+    },
+    "ConditionsFormat": {
+      "type": "string",
+      "enum": ["jsonLogic", "custom"]
+    }
+  }
+}

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

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

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

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

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

@@ -0,0 +1,91 @@
+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/notification_configuration/update_trigger_payload.schema.json

@@ -0,0 +1,169 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/UpdateTriggerPayload",
+  "definitions": {
+    "UpdateTriggerPayload": {
+      "type": "object",
+      "properties": {
+        "notified_about": {
+          "$ref": "#/definitions/NotifiedAboutType"
+        },
+        "text_content": {
+          "type": "string"
+        },
+        "configuration": {
+          "$ref": "#/definitions/NotificationConfigurationConf"
+        }
+      },
+      "additionalProperties": false
+    },
+    "NotifiedAboutType": {
+      "type": ["string"]
+    },
+    "NotificationConfigurationConf": {
+      "type": "object",
+      "properties": {
+        "conditions": {
+          "$ref": "#/definitions/ConditionsRules"
+        },
+        "join": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "load_patient": {
+          "type": "object",
+          "properties": {
+            "join": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "where": {
+              "anyOf": [
+                {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "string",
+                  "const": "auto"
+                }
+              ]
+            }
+          },
+          "required": ["where"],
+          "additionalProperties": false
+        },
+        "action": {
+          "$ref": "#/definitions/ApiAction"
+        },
+        "conditionsFormat": {
+          "$ref": "#/definitions/ConditionsFormat"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ConditionsRules": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Conditions"
+        },
+        {}
+      ],
+      "description": "Importing the types from json-logic-js makes the process of generating schema.json fails so we use any instead"
+    },
+    "Conditions": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/ConditionExpression"
+        },
+        {
+          "$ref": "#/definitions/ConditionOperator"
+        }
+      ]
+    },
+    "ConditionExpression": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/ConditionValue"
+      }
+    },
+    "ConditionValue": {
+      "type": "object",
+      "properties": {
+        "equal": {
+          "type": ["string", "number", "boolean"]
+        },
+        "not_equal": {
+          "type": ["string", "number", "boolean"]
+        },
+        "contains": {
+          "type": "string"
+        },
+        "not_contains": {
+          "type": "string"
+        },
+        "greater_than": {
+          "type": ["string", "number"]
+        },
+        "less_than": {
+          "type": ["string", "number"]
+        },
+        "empty": {
+          "type": ["string", "number", "boolean"]
+        },
+        "not_empty": {
+          "type": ["string", "number", "boolean"]
+        },
+        "parseValue": {
+          "type": "boolean"
+        },
+        "operator": {
+          "type": "string",
+          "enum": ["AND", "OR"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "ConditionOperator": {
+      "type": "object",
+      "properties": {
+        "AND": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Conditions"
+          }
+        },
+        "OR": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Conditions"
+          }
+        },
+        "NOT": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Conditions"
+          }
+        },
+        "JQ": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ApiAction": {
+      "type": "string",
+      "enum": ["questionnaire.create", "crf.create", "crf.update", "crf.delete"]
+    },
+    "ConditionsFormat": {
+      "type": "string",
+      "enum": ["jsonLogic", "custom"]
+    }
+  }
+}

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

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

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

@@ -0,0 +1,35 @@
+/**
+ * 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/patient/createFullPatient.schema.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "schema for create new full patient (all forms at once)",
+  "type": "object",
+  "required": ["patient"],
+  "properties": {
+    "patient": {
+      "type": "object",
+      "additionalProperties": {
+        "type": ["integer", "string", "boolean", "null", "array", "object"]
+      }
+    }
+  },
+  "additionalProperties": {
+    "type": ["object", "array"]
+  }
+}

package/dist/schemas/patient/createPatient.schema.json

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

package/dist/schemas/project/createCategory.schema.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "schema for create a new Category of Documents Upload",
+  "type": "object",
+  "required": ["name"],
+  "properties": {
+    "name": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}

package/dist/schemas/project/export.schema.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "schema for request a DB exportation to microservice",
+  "type": "object",
+  "required": ["exportFormat"],
+  "properties": {
+    "exportID": {
+      "type": ["null", "integer"]
+    },
+    "filterID": {
+      "type": ["null", "integer"]
+    },
+    "exportRaw": {
+      "type": ["null", "integer"]
+    },
+    "exportFormat": {
+      "type": "string",
+      "enum": ["xls", "csv", "spss"]
+    },
+    "selectedClinics": {
+      "type": ["null", "string"]
+    }
+  },
+  "additionalProperties": false
+}

package/dist/schemas/project/uploadDocument.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "schema for upload a file to document seed inside a project",
+  "type": "object",
+  "required": ["document_name", "url"],
+  "properties": {
+    "document_name": {
+      "type": "string"
+    },
+    "category_id": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "url": {
+      "type": "string"
+    },
+    "clinic_id": {
+      "type": ["null", "integer"],
+      "minimum": 0
+    }
+  },
+  "additionalProperties": false
+}

package/dist/schemas/query/patch.schema.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "schema for patch query endpoints",
+  "type": "object",
+  "required": ["description"],
+  "properties": {
+    "description": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["type", "actions", "content"],
+        "properties": {
+          "type": { "type": "string" },
+          "actions": { "type": "string" },
+          "content": { "type": "string" }
+        },
+        "additionalProperties": false
+      },
+      "minItems": 1
+    }
+  }
+}

package/dist/schemas/questionnaire/createQuestionnaire.schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/CreateQuestionnairePayload",
+  "definitions": {
+    "CreateQuestionnairePayload": {
+      "type": "object",
+      "properties": {
+        "patientId": {
+          "type": "number"
+        },
+        "type": {
+          "type": "string",
+          "enum": ["unique", "periodic"]
+        },
+        "date": {
+          "type": "string"
+        },
+        "untilDate": {
+          "type": "string"
+        },
+        "formName": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "date", "formName"],
+      "additionalProperties": false
+    }
+  }
+}

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

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

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

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

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

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

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

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

package/dist/schemas/user_settings/APP_FONT_FACTOR.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/AppFontFactor",
+  "definitions": {
+    "AppFontFactor": {
+      "type": "number",
+      "description": "App font factor"
+    }
+  }
+}