@persei/perseed-api 4.34.17 → 4.34.19

package/dist/index.d.ts

@@ -78,6 +78,30 @@ export declare type BaseApiServicePayload = {
     ctx?: RequestContext;
 } & Partial<ApiActionContextData>;
 
+export declare type BaseDashboardWidget = BaseDashboardWidgetPayload & ({
+    type: DashboardWidgetType.SECTIONCARD;
+    params: SectionCardProps;
+} | {
+    type: DashboardWidgetType.VALUECARD;
+    params: ValueCardProps;
+} | {
+    type: DashboardWidgetType.PATIENTLIST;
+    params: PatientListProps;
+} | {
+    type: DashboardWidgetType.DASHBOARD;
+    params: DashboardProps;
+});
+
+export declare type BaseDashboardWidgetPayload<T extends DashboardWidgetType | undefined = undefined> = {
+    id?: number;
+    title: string;
+    description?: string;
+    type: T | DashboardWidgetType;
+    library: boolean;
+    config?: WidgetBlockConfig;
+    position?: number;
+};
+
 declare class BaseModel extends Model {
     id: number;
     static get modelPaths(): string[];
@@ -415,16 +439,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;
 });
@@ -462,16 +486,38 @@ export declare type DashboardBaseWidgetPayload = {
     description?: string;
     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 {
-    title: string;
     active?: boolean;
     config?: any;
     icon?: string | null;
-    weight?: number;
 }
 
+export declare type DashboardWidget<T extends DashboardWidgetType | undefined = undefined> = T extends DashboardWidgetType ? {
+    id: number;
+    widgets?: DashboardChildrenWidget[];
+} & DashboardWidgetTypeToParams[T] & BaseDashboardWidgetPayload<T> : {
+    id: number;
+    params: any;
+    widgets?: DashboardChildrenWidget[];
+} & BaseDashboardWidgetPayload<T>;
+
+export declare type DashboardWidgetBlockCreatePayload = {
+    parent_id: number | string;
+    child_id: number;
+    position: number;
+    config?: WidgetBlockConfig;
+};
+
 export declare type DashboardWidgetDataLoader<T> = T extends {
     type: infer Type;
     params: infer Params;
@@ -487,6 +533,21 @@ export declare enum DashboardWidgetType {
     DASHBOARD = "Dashboard"
 }
 
+export declare type DashboardWidgetTypeToParams = {
+    [DashboardWidgetType.SECTIONCARD]: {
+        params: SectionCardProps;
+    };
+    [DashboardWidgetType.VALUECARD]: {
+        params: ValueCardProps;
+    };
+    [DashboardWidgetType.PATIENTLIST]: {
+        params: PatientListProps;
+    };
+    [DashboardWidgetType.DASHBOARD]: {
+        params: DashboardProps;
+    };
+};
+
 export declare enum DataLoaderType {
     OUTCOMES = "outcomes"
 }
@@ -770,6 +831,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;
@@ -1722,8 +1785,6 @@ export declare interface SectionCardProps {
     icon: string;
     background?: string;
     titleBackground?: string;
-    title: I18nTextTranslation;
-    widgets: number[];
 }
 
 /**
@@ -2641,7 +2702,6 @@ declare class UserProfile extends BaseModel {
 declare type UserSettingValue = string | number | boolean | Record<string, string | number> | string[] | number[];
 
 export declare interface ValueCardProps {
-    title: I18nTextTranslation;
     icon: string;
     text: I18nTextTranslation;
     subtext?: I18nTextTranslation;
@@ -2651,6 +2711,10 @@ export declare interface ValueCardProps {
     dataLoader?: DashboardWidgetDataLoader<WidgetOutcomesDataLoader>;
 }
 
+export declare type WidgetBlockConfig = {
+    size?: number | ColProps;
+};
+
 export declare interface WidgetOutcomesDataLoader {
     type: DataLoaderType.OUTCOMES;
     params: OutcomesParams;

package/dist/schemas/{dashboardWidget → dashboard_widget}/create_widget_payload.schema.json

@@ -33,6 +33,15 @@
                   "$ref": "#/definitions/ColProps"
                 }
               ]
+            },
+            "library": {
+              "type": "boolean"
+            },
+            "widgetsBlocks": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/DashboardWidgetBlockCreatePayload"
+              }
             }
           },
           "required": ["params", "title", "type"]
@@ -66,6 +75,15 @@
                   "$ref": "#/definitions/ColProps"
                 }
               ]
+            },
+            "library": {
+              "type": "boolean"
+            },
+            "widgetsBlocks": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/DashboardWidgetBlockCreatePayload"
+              }
             }
           },
           "required": ["params", "title", "type"]
@@ -99,6 +117,15 @@
                   "$ref": "#/definitions/ColProps"
                 }
               ]
+            },
+            "library": {
+              "type": "boolean"
+            },
+            "widgetsBlocks": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/DashboardWidgetBlockCreatePayload"
+              }
             }
           },
           "required": ["params", "title", "type"]
@@ -132,6 +159,15 @@
                   "$ref": "#/definitions/ColProps"
                 }
               ]
+            },
+            "library": {
+              "type": "boolean"
+            },
+            "widgetsBlocks": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/DashboardWidgetBlockCreatePayload"
+              }
             }
           },
           "required": ["params", "title", "type"]
@@ -149,42 +185,11 @@
         },
         "titleBackground": {
           "type": "string"
-        },
-        "title": {
-          "$ref": "#/definitions/I18nTextTranslation"
-        },
-        "widgets": {
-          "type": "array",
-          "items": {
-            "type": "number"
-          }
         }
       },
-      "required": ["icon", "title", "widgets"],
+      "required": ["icon"],
       "additionalProperties": false
     },
-    "I18nTextTranslation": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/I18nTextLocales"
-        },
-        {
-          "type": "string"
-        }
-      ]
-    },
-    "I18nTextLocales": {
-      "type": "object",
-      "properties": {
-        "default": {
-          "type": "string"
-        }
-      },
-      "required": ["default"],
-      "additionalProperties": {
-        "type": "string"
-      }
-    },
     "ColProps": {
       "type": "object",
       "properties": {
@@ -317,12 +322,44 @@
       },
       "additionalProperties": false
     },
-    "ValueCardProps": {
+    "DashboardWidgetBlockCreatePayload": {
       "type": "object",
       "properties": {
-        "title": {
-          "$ref": "#/definitions/I18nTextTranslation"
+        "parent_id": {
+          "type": ["number", "string"]
+        },
+        "child_id": {
+          "type": "number"
         },
+        "position": {
+          "type": "number"
+        },
+        "config": {
+          "$ref": "#/definitions/WidgetBlockConfig"
+        }
+      },
+      "required": ["parent_id", "child_id", "position"],
+      "additionalProperties": false
+    },
+    "WidgetBlockConfig": {
+      "type": "object",
+      "properties": {
+        "size": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "$ref": "#/definitions/ColProps"
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
+    "ValueCardProps": {
+      "type": "object",
+      "properties": {
         "icon": {
           "type": "string"
         },
@@ -345,9 +382,31 @@
           "$ref": "#/definitions/DashboardWidgetDataLoader%3CWidgetOutcomesDataLoader%3E"
         }
       },
-      "required": ["title", "icon", "text"],
+      "required": ["icon", "text"],
       "additionalProperties": false
     },
+    "I18nTextTranslation": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/I18nTextLocales"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "I18nTextLocales": {
+      "type": "object",
+      "properties": {
+        "default": {
+          "type": "string"
+        }
+      },
+      "required": ["default"],
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
     "DashboardWidgetDataLoader<WidgetOutcomesDataLoader>": {
       "type": "object",
       "properties": {
@@ -563,21 +622,14 @@
     "DashboardProps": {
       "type": "object",
       "properties": {
-        "title": {
-          "type": "string"
-        },
         "active": {
           "type": "boolean"
         },
         "config": {},
         "icon": {
           "type": ["string", "null"]
-        },
-        "weight": {
-          "type": "number"
         }
       },
-      "required": ["title"],
       "additionalProperties": false
     }
   }

package/dist/schemas/{dashboardWidget → dashboard_widget}/update_widget_payload.schema.json

@@ -24,6 +24,15 @@
             }
           ]
         },
+        "library": {
+          "type": "boolean"
+        },
+        "widgetsBlocks": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DashboardWidgetBlockCreatePayload"
+          }
+        },
         "type": {
           "anyOf": [
             {
@@ -195,59 +204,60 @@
       },
       "additionalProperties": false
     },
-    "SectionCardProps": {
+    "DashboardWidgetBlockCreatePayload": {
       "type": "object",
       "properties": {
-        "icon": {
-          "type": "string"
-        },
-        "background": {
-          "type": "string"
+        "parent_id": {
+          "type": ["number", "string"]
         },
-        "titleBackground": {
-          "type": "string"
+        "child_id": {
+          "type": "number"
         },
-        "title": {
-          "$ref": "#/definitions/I18nTextTranslation"
+        "position": {
+          "type": "number"
         },
-        "widgets": {
-          "type": "array",
-          "items": {
-            "type": "number"
-          }
+        "config": {
+          "$ref": "#/definitions/WidgetBlockConfig"
         }
       },
-      "required": ["icon", "title", "widgets"],
+      "required": ["parent_id", "child_id", "position"],
       "additionalProperties": false
     },
-    "I18nTextTranslation": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/I18nTextLocales"
-        },
-        {
-          "type": "string"
+    "WidgetBlockConfig": {
+      "type": "object",
+      "properties": {
+        "size": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "$ref": "#/definitions/ColProps"
+            }
+          ]
         }
-      ]
+      },
+      "additionalProperties": false
     },
-    "I18nTextLocales": {
+    "SectionCardProps": {
       "type": "object",
       "properties": {
-        "default": {
+        "icon": {
+          "type": "string"
+        },
+        "background": {
+          "type": "string"
+        },
+        "titleBackground": {
           "type": "string"
         }
       },
-      "required": ["default"],
-      "additionalProperties": {
-        "type": "string"
-      }
+      "required": ["icon"],
+      "additionalProperties": false
     },
     "ValueCardProps": {
       "type": "object",
       "properties": {
-        "title": {
-          "$ref": "#/definitions/I18nTextTranslation"
-        },
         "icon": {
           "type": "string"
         },
@@ -270,9 +280,31 @@
           "$ref": "#/definitions/DashboardWidgetDataLoader%3CWidgetOutcomesDataLoader%3E"
         }
       },
-      "required": ["title", "icon", "text"],
+      "required": ["icon", "text"],
       "additionalProperties": false
     },
+    "I18nTextTranslation": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/I18nTextLocales"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "I18nTextLocales": {
+      "type": "object",
+      "properties": {
+        "default": {
+          "type": "string"
+        }
+      },
+      "required": ["default"],
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
     "DashboardWidgetDataLoader<WidgetOutcomesDataLoader>": {
       "type": "object",
       "properties": {
@@ -488,21 +520,14 @@
     "DashboardProps": {
       "type": "object",
       "properties": {
-        "title": {
-          "type": "string"
-        },
         "active": {
           "type": "boolean"
         },
         "config": {},
         "icon": {
           "type": ["string", "null"]
-        },
-        "weight": {
-          "type": "number"
         }
       },
-      "required": ["title"],
       "additionalProperties": false
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@persei/perseed-api",
-  "version": "4.34.17",
+  "version": "4.34.19",
   "private": false,
   "main": "./dist/perseed-api.umd.js",
   "module": "./dist/perseed-api.mjs",
@@ -9,8 +9,7 @@
     "dist"
   ],
   "scripts": {
-    "publish_package": "npm run precommit && npm run build && npm publish",
-    "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",