@persei/perseed-api 4.34.18 → 4.34.20

package/README.md

@@ -10,6 +10,7 @@
 8. [Redis cache and queue](#8-redis-cache-and-queue)
 9. [Generating json schema from ts definitions](#9-generating-json-schema-from-ts-definitions)
 10. [Add a new language](#10-add-a-new-language)
+11. [Lib package build](#11-lib-package-build)
 
 # 1 - Perseed API - NodeJs
 
@@ -258,3 +259,10 @@ To add a new language:
 * Run `npm run i18n:generate` to generate the new locale file with the default values (in english). This file should be translated.
 * Done!
 
+## 11 Lib package build
+
+To build the lib package:
+* Increase the package.json version
+* Run `npm run lib:build`
+* Commit changes
+* Run `npm publish`

package/dist/index.d.ts

@@ -78,16 +78,16 @@ export declare type BaseApiServicePayload = {
     ctx?: RequestContext;
 } & Partial<ApiActionContextData>;
 
-export declare type BaseDashboardWidget = (BaseDashboardWidgetPayload & {
+export declare type BaseDashboardWidget = BaseDashboardWidgetPayload & ({
     type: DashboardWidgetType.SECTIONCARD;
     params: SectionCardProps;
-}) | (BaseDashboardWidgetPayload & {
+} | {
     type: DashboardWidgetType.VALUECARD;
     params: ValueCardProps;
-}) | (BaseDashboardWidgetPayload & {
+} | {
     type: DashboardWidgetType.PATIENTLIST;
     params: PatientListProps;
-}) | (BaseDashboardWidgetPayload & {
+} | {
     type: DashboardWidgetType.DASHBOARD;
     params: DashboardProps;
 });
@@ -96,7 +96,6 @@ export declare type BaseDashboardWidgetPayload<T extends DashboardWidgetType | u
     id?: number;
     title: string;
     description?: string;
-    size?: number | ColProps;
     type: T | DashboardWidgetType;
     library: boolean;
     config?: WidgetBlockConfig;
@@ -121,6 +120,12 @@ declare interface CacheOptions {
     tags: Record<string, any>;
 }
 
+export declare interface CalculatedColumn {
+    key: string;
+    label: string;
+    template: string;
+}
+
 declare class Clinic extends BaseModel {
     name: string;
     country: string;
@@ -440,16 +445,16 @@ export declare const CORE: {
 
 export declare const CountryPhoneCodes: {};
 
-export declare type CreateDashboardWidgetPayload = (DashboardBaseWidgetPayload & {
+export declare type CreateDashboardWidgetPayload = DashboardBaseWidgetPayload & ({
     type: DashboardWidgetType.SECTIONCARD;
     params: SectionCardProps;
-}) | (DashboardBaseWidgetPayload & {
+} | {
     type: DashboardWidgetType.VALUECARD;
     params: ValueCardProps;
-}) | (DashboardBaseWidgetPayload & {
+} | {
     type: DashboardWidgetType.PATIENTLIST;
     params: PatientListProps;
-}) | (DashboardBaseWidgetPayload & {
+} | {
     type: DashboardWidgetType.DASHBOARD;
     params: DashboardProps;
 });
@@ -484,13 +489,19 @@ declare class CustomQueryBuilder<M extends Model = Model, R = M[]> extends Query
 
 export declare type DashboardBaseWidgetPayload = {
     title: string;
-    description?: string;
+    description?: string | null;
     weight?: number;
     size?: number | ColProps;
     library?: boolean;
     widgetsBlocks?: DashboardWidgetBlockCreatePayload[];
 };
 
+export declare type DashboardChildrenWidget<T extends DashboardWidgetType | undefined = undefined> = DashboardBaseWidgetPayload & BaseDashboardWidgetPayload<T> & {
+    id: number;
+    type: DashboardWidgetType;
+    params: GenericParams;
+};
+
 export declare interface DashboardProps {
     active?: boolean;
     config?: any;
@@ -499,18 +510,18 @@ export declare interface DashboardProps {
 
 export declare type DashboardWidget<T extends DashboardWidgetType | undefined = undefined> = T extends DashboardWidgetType ? {
     id: number;
-    widgets?: BaseDashboardWidgetPayload[];
+    widgets?: DashboardChildrenWidget[];
 } & DashboardWidgetTypeToParams[T] & BaseDashboardWidgetPayload<T> : {
     id: number;
     params: any;
-    widgets?: BaseDashboardWidgetPayload[];
+    widgets?: DashboardChildrenWidget[];
 } & BaseDashboardWidgetPayload<T>;
 
 export declare type DashboardWidgetBlockCreatePayload = {
     parent_id: number | string;
     child_id: number;
     position: number;
-    config?: WidgetBlockConfig;
+    config?: WidgetBlockConfig | null;
 };
 
 export declare type DashboardWidgetDataLoader<T> = T extends {
@@ -792,9 +803,6 @@ export declare const FIELDS: {
 
 export declare interface FilterParams {
     conditions?: Record<string, unknown>;
-    relatedData?: {
-        join?: string[];
-    };
 }
 
 export declare type FlexType = number | 'none' | 'auto' | string;
@@ -826,6 +834,8 @@ export declare interface GenericDashboardWidgetDataLoader {
     params: Record<string, any>;
 }
 
+export declare type GenericParams = SectionCardProps | ValueCardProps | PatientListProps | DashboardProps;
+
 export declare const HISTORY: {
     PERMANENT: string;
     TEMPORARY: string;
@@ -1092,20 +1102,25 @@ export declare interface OutcomesParams {
 
 export declare const PATIENT_CREATION_ABOUT = "Patient Creation";
 
+export declare interface PatientListColumn {
+    hidden?: boolean;
+    position?: number;
+    label?: string;
+    key: string;
+}
+
 export declare interface PatientListProps {
     loadUserProfiles?: boolean;
     loadAdherence?: boolean;
     extraFields?: string[];
     loadPushTokens?: boolean;
     loadUserAccessData?: boolean;
-    programId?: number;
-    prevAdherenceDays?: number;
-    relatedData?: {
-        join?: string[];
-    };
-    filter?: {
-        conditions?: Record<string, unknown>;
-    };
+    programId?: number | null;
+    prevAdherenceDays?: number | null;
+    filter?: FilterParams;
+    relatedData?: RelatedDataParams;
+    calculatedColumns?: CalculatedColumn[];
+    columns?: PatientListColumn[];
 }
 
 declare class Profiling extends BaseModel {
@@ -1584,6 +1599,10 @@ export declare interface QuestionnaireInfoUpdateOptions {
 
 export declare type QuestionnaireTypeValue = 'QoL' | 'Task';
 
+export declare interface RelatedDataParams {
+    join?: string[];
+}
+
 /**
  * req.body object mfa validation
  */

package/dist/schemas/dashboard_widget/create_widget_payload.schema.json

@@ -19,7 +19,7 @@
               "type": "string"
             },
             "description": {
-              "type": "string"
+              "type": ["string", "null"]
             },
             "weight": {
               "type": "number"
@@ -61,7 +61,7 @@
               "type": "string"
             },
             "description": {
-              "type": "string"
+              "type": ["string", "null"]
             },
             "weight": {
               "type": "number"
@@ -103,7 +103,7 @@
               "type": "string"
             },
             "description": {
-              "type": "string"
+              "type": ["string", "null"]
             },
             "weight": {
               "type": "number"
@@ -145,7 +145,7 @@
               "type": "string"
             },
             "description": {
-              "type": "string"
+              "type": ["string", "null"]
             },
             "weight": {
               "type": "number"
@@ -335,7 +335,14 @@
           "type": "number"
         },
         "config": {
-          "$ref": "#/definitions/WidgetBlockConfig"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/WidgetBlockConfig"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "required": ["parent_id", "child_id", "position"],
@@ -589,34 +596,87 @@
           "type": "boolean"
         },
         "programId": {
-          "type": "number"
+          "type": ["number", "null"]
         },
         "prevAdherenceDays": {
-          "type": "number"
+          "type": ["number", "null"]
+        },
+        "filter": {
+          "$ref": "#/definitions/FilterParams"
         },
         "relatedData": {
-          "type": "object",
-          "properties": {
-            "join": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            }
-          },
-          "additionalProperties": false
+          "$ref": "#/definitions/RelatedDataParams"
         },
-        "filter": {
+        "calculatedColumns": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CalculatedColumn"
+          }
+        },
+        "columns": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PatientListColumn"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "FilterParams": {
+      "type": "object",
+      "properties": {
+        "conditions": {
           "type": "object",
-          "properties": {
-            "conditions": {
-              "type": "object",
-              "additionalProperties": {}
-            }
-          },
-          "additionalProperties": false
+          "additionalProperties": {}
+        }
+      },
+      "additionalProperties": false
+    },
+    "RelatedDataParams": {
+      "type": "object",
+      "properties": {
+        "join": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "CalculatedColumn": {
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "template": {
+          "type": "string"
+        }
+      },
+      "required": ["key", "label", "template"],
+      "additionalProperties": false
+    },
+    "PatientListColumn": {
+      "type": "object",
+      "properties": {
+        "hidden": {
+          "type": "boolean"
+        },
+        "position": {
+          "type": "number"
+        },
+        "label": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
         }
       },
+      "required": ["key"],
       "additionalProperties": false
     },
     "DashboardProps": {

package/dist/schemas/dashboard_widget/update_widget_payload.schema.json

@@ -9,7 +9,7 @@
           "type": "string"
         },
         "description": {
-          "type": "string"
+          "type": ["string", "null"]
         },
         "weight": {
           "type": "number"
@@ -217,7 +217,14 @@
           "type": "number"
         },
         "config": {
-          "$ref": "#/definitions/WidgetBlockConfig"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/WidgetBlockConfig"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "required": ["parent_id", "child_id", "position"],
@@ -487,34 +494,87 @@
           "type": "boolean"
         },
         "programId": {
-          "type": "number"
+          "type": ["number", "null"]
         },
         "prevAdherenceDays": {
-          "type": "number"
+          "type": ["number", "null"]
+        },
+        "filter": {
+          "$ref": "#/definitions/FilterParams"
         },
         "relatedData": {
-          "type": "object",
-          "properties": {
-            "join": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            }
-          },
-          "additionalProperties": false
+          "$ref": "#/definitions/RelatedDataParams"
         },
-        "filter": {
+        "calculatedColumns": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CalculatedColumn"
+          }
+        },
+        "columns": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PatientListColumn"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "FilterParams": {
+      "type": "object",
+      "properties": {
+        "conditions": {
           "type": "object",
-          "properties": {
-            "conditions": {
-              "type": "object",
-              "additionalProperties": {}
-            }
-          },
-          "additionalProperties": false
+          "additionalProperties": {}
+        }
+      },
+      "additionalProperties": false
+    },
+    "RelatedDataParams": {
+      "type": "object",
+      "properties": {
+        "join": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "CalculatedColumn": {
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "template": {
+          "type": "string"
+        }
+      },
+      "required": ["key", "label", "template"],
+      "additionalProperties": false
+    },
+    "PatientListColumn": {
+      "type": "object",
+      "properties": {
+        "hidden": {
+          "type": "boolean"
+        },
+        "position": {
+          "type": "number"
+        },
+        "label": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
         }
       },
+      "required": ["key"],
       "additionalProperties": false
     },
     "DashboardProps": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@persei/perseed-api",
-  "version": "4.34.18",
+  "version": "4.34.20",
   "private": false,
   "main": "./dist/perseed-api.umd.js",
   "module": "./dist/perseed-api.mjs",
@@ -9,8 +9,7 @@
     "dist"
   ],
   "scripts": {
-    "_prepare": "npm run precommit && npm run build",
-    "build": "tsc --noEmit && vite build",
+    "lib:build": "npm run precommit && tsc --noEmit && vite build",
     "start": "ts-node src/server.ts",
     "lint": "npm run test:lint",
     "jshint": "jshint . > report.txt || true",
@@ -29,10 +28,10 @@
     "security-packages-report": "npm audit --json | npm-audit-html --output reports/packages-security-report.html",
     "test:lint": "eslint src/ && prettier --ignore-path .prettierignorefile --check src/",
     "test:types": "tsc --noEmit",
-    "test:docs": "pip install esprima && python3 swagger_gen.py",
-    "dest:docs-unsafe": "pip install esprima --break-system-packages && python3 swagger_gen.py",
-    "test:security": "pipx install njsscan && pipx install semgrep && njsscan ./src/",
-    "test:security:report": "pipx install njsscan && pipx install semgrep && njsscan --html -o reports/security-report.html ./src/",
+    "test:dependencies": "pipx install njsscan semgrep esprima",
+    "test:docs": "python3 swagger_gen.py",
+    "test:security": "njsscan ./src/",
+    "test:security:report": "njsscan --html -o reports/security-report.html ./src/",
     "test:security:report2": "./bin/bearer scan perseed-api/src  --scanner=sast,secrets --report security --format html --output reports/bearer_api_report",
     "precommit": "npm run schemas:generate && prettier --ignore-path .prettierignorefile src/ --write && npm run eslintfix && npm run i18n:generate && npm run test:types && npm run test-unit && npm run test:security",
     "i18n:generate": "npx rimraf src/i18n/api/en.json && i18next && i18next --config i18next-parser.config.js",
@@ -61,6 +60,7 @@
     }
   },
   "dependencies": {
+    "@aws-sdk/client-sns": "^3.803.0",
     "@paralleldrive/cuid2": "^2.2.2",
     "@persei/debug": "^2.0.0",
     "@sentry/node": "^6.19.6",