@persei/perseed-api 4.34.23 → 4.34.25

package/dist/index.d.ts

@@ -123,8 +123,10 @@ declare interface CacheOptions {
 
 export declare interface CalculatedColumn {
     key: string;
-    label: string;
+    label?: string;
     template: string;
+    notVisible?: boolean;
+    type: ColumnType;
 }
 
 declare class Clinic extends BaseModel {
@@ -229,6 +231,15 @@ export declare interface ColSize {
 
 export declare type ColSpanType = number | string;
 
+export declare enum ColumnType {
+    TEXT = "text",
+    NUMBER = "number",
+    BOOLEAN = "boolean",
+    DATE = "date",
+    TIME = "time",
+    DATETIME = "datetime"
+}
+
 export declare interface ConditionExpression {
     [field: string]: ConditionValue;
 }
@@ -861,6 +872,32 @@ declare interface I18nTextLocales {
 
 declare type I18nTextTranslation = I18nTextLocales | string;
 
+export declare enum IconPosition {
+    UP = "up",
+    DOWN = "down",
+    LEFT = "left",
+    RIGHT = "right"
+}
+
+export declare interface IconPresentationWidgetFields {
+    icon: string;
+    iconColor?: string;
+    bgColor?: string;
+}
+
+export declare type IconPresentationWidgetProps = PresentationWidgetWithConditionalProps<IconPresentationWidgetFields>;
+
+export declare interface IconTextPresentationWidgetFields {
+    template: string;
+    textColor?: string;
+    icon: string;
+    iconColor?: string;
+    iconPosition: IconPosition;
+    bgColor?: string;
+}
+
+export declare type IconTextPresentationWidgetProps = PresentationWidgetWithConditionalProps<IconTextPresentationWidgetFields>;
+
 declare interface IdRefForm {
     syncId?: number;
     id: number;
@@ -1063,8 +1100,18 @@ export declare const OBJECT_TYPE: string[];
 
 declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 
+export declare interface Order {
+    order: OrderType;
+    orderBy: string;
+}
+
 export declare type OrderDir = 'asc' | 'desc';
 
+export declare enum OrderType {
+    ASC = "asc",
+    DESC = "desc"
+}
+
 export declare type Outcome = OutcomeDateGroup & {
     name: string;
     identifier: string;
@@ -1103,11 +1150,25 @@ export declare interface OutcomesParams {
 
 export declare const PATIENT_CREATION_ABOUT = "Patient Creation";
 
+export declare interface PatientListAppearance {
+    backgroundColor?: PatientListBackgroundColor[];
+    order?: Order[];
+}
+
+export declare interface PatientListBackgroundColor {
+    conditions: ConditionsRules;
+    backgroundColor: string;
+    continueEvaluate?: boolean;
+}
+
 export declare interface PatientListColumn {
     hidden?: boolean;
     position?: number;
     label?: string;
     key: string;
+    notVisible?: boolean;
+    presentationWidget?: PresentationWidget;
+    presentationWidgetSettings?: PresentationWidgetSettings;
 }
 
 export declare interface PatientListProps {
@@ -1122,8 +1183,26 @@ export declare interface PatientListProps {
     relatedData?: RelatedDataParams;
     calculatedColumns?: CalculatedColumn[];
     columns?: PatientListColumn[];
+    appearance?: PatientListAppearance;
+}
+
+export declare enum PresentationWidget {
+    TEXT = "text",
+    ICON = "icon",
+    ICON_TEXT = "icon_text"
 }
 
+export declare interface PresentationWidgetConditionalPropsConfig<T extends Record<string, any>> {
+    conditionalProps?: (T & {
+        conditions: any;
+        continueEvaluate?: boolean;
+    })[];
+}
+
+export declare type PresentationWidgetSettings = TextPresentationWidgetProps | IconPresentationWidgetProps | IconTextPresentationWidgetProps;
+
+export declare type PresentationWidgetWithConditionalProps<T extends Record<string, any>> = T & PresentationWidgetConditionalPropsConfig<T>;
+
 declare class Profiling extends BaseModel {
     name: string;
     description: string;
@@ -2011,6 +2090,14 @@ declare class SubformReference extends BaseModel {
     $beforeInsert(queryContext: any): Promise<void>;
 }
 
+export declare interface TextPresentationWidgetFields {
+    template: string;
+    textColor?: string;
+    bgColor?: string;
+}
+
+export declare type TextPresentationWidgetProps = PresentationWidgetWithConditionalProps<TextPresentationWidgetFields>;
+
 export declare const TIME_FORMAT = "HH:mm:ss";
 
 export declare const TIME_SCHEMA = "^[0-1][0-9]:[0-5][0-9]$|^[0-2][0-3]:[0-5][0-9]$";
@@ -2343,6 +2430,10 @@ declare class User extends BaseModel {
     checkDisplayPatientListPermissions(projectId: number): boolean;
     checkOnlyUpdatePatientsPermissions(projectName: string): boolean;
     checkPermission(ctx: RequestContext, privilege: SEED_PRIVILEGES): boolean;
+    /**
+     * Retrieves a list of profiling IDs that have the specified privilege within the given context.
+     */
+    getProfilingsIdsWithPrivilege(ctx: RequestContext, privilege: SEED_PRIVILEGES): number[] | undefined;
     checkUserProject(projectId: number): boolean;
     isPerseedAdmin(): boolean;
     isEcosystemAdmin(): boolean;

package/dist/perseed-api.mjs

@@ -1,4 +1,4 @@
-const A = "YYYY-MM-DD", M = "HH:mm:ss", C = "HH:mm", p = "YYYY-MM-DD HH:mm", D = A, g = "YYYY-MM-DD HH:mm:ss", h = {
+const A = "YYYY-MM-DD", g = "HH:mm:ss", h = "HH:mm", f = "YYYY-MM-DD HH:mm", b = A, U = "YYYY-MM-DD HH:mm:ss", P = {
   PENDING: "IN_PROGRESS",
   ERROR: "ERROR",
   SUCCESS: "COMPLETED",
@@ -59,7 +59,7 @@ const A = "YYYY-MM-DD", M = "HH:mm:ss", C = "HH:mm", p = "YYYY-MM-DD HH:mm", D =
   FILE_NAME: "file"
 };
 var l = /* @__PURE__ */ ((a) => (a[a.STATIC = 0] = "STATIC", a[a.STANDARD = 1] = "STANDARD", a[a.FOLLOW_UP = 2] = "FOLLOW_UP", a[a.ADVERSE_EVENT = 3] = "ADVERSE_EVENT", a[a.QUESTIONNAIRE = 5] = "QUESTIONNAIRE", a[a.STUDY = 6] = "STUDY", a))(l || {});
-const f = () => {
+const v = () => {
   let a = {};
   return Object.keys(r).forEach((e) => {
     a = {
@@ -67,7 +67,7 @@ const f = () => {
       [r[e]]: i[`${e}_NAME`]
     };
   }), a;
-}, b = ["number", i.DECIMAL_NAME, i.INTEGER_NAME], P = ["date"], U = ["object", i.SCAN_CODE_NAME], T = {
+}, k = ["number", i.DECIMAL_NAME, i.INTEGER_NAME], y = ["date"], F = ["object", i.SCAN_CODE_NAME], T = {
   CREATION_TIME: "creation_time",
   CREATION_USER: "creation_user",
   CRF_NAME: "crf_name",
@@ -94,23 +94,23 @@ const f = () => {
   VERSION: "version",
   REFERENCE: "reference",
   SUBFORM_ID: "subform_id"
-}, y = Object.values(T), v = {
+}, B = Object.values(T), G = {
   added: "A",
   edited: "E",
   deleted: "D"
-}, k = {
+}, H = {
   PATIENT: "patient",
   SEPARATOR: "_"
-}, F = {
+}, Y = {
   AUDIT: "audit"
-}, B = "~", G = "_status", H = "_status", Y = {
+}, w = "~", z = "_status", x = "_status", V = {
   filled: "filled",
   unk: "UNK",
   na: "NA",
   nd: "ND"
-}, u = /^[0-9a-f]{33}_status$/, w = function(a) {
+}, u = /^[0-9a-f]{33}_status$/, K = function(a) {
   return !u.test(a);
-}, z = ["UNK", "NA", "ND"], V = "^[0-1][0-9]:[0-5][0-9]$|^[0-2][0-3]:[0-5][0-9]$", x = {
+}, q = ["UNK", "NA", "ND"], W = "^[0-1][0-9]:[0-5][0-9]$|^[0-2][0-3]:[0-5][0-9]$", j = {
   DEPENDENT_SOURCE: "dependent_source",
   ENCRYPTED: "encrypted",
   ENCRYPTED_LEVEL: "encrypted_level",
@@ -174,34 +174,34 @@ const f = () => {
   WINDOW_BEFORE: "window_before",
   WINDOW_AFTER: "window_after",
   WINDOW_PERIOD: "window_period"
-}, K = {
+}, X = {
   STRICT: "strict",
   FLEXIBLE: "flexible"
-}, q = {
+}, Z = {
   ACTIVE: "1"
-}, W = {
+}, Q = {
   SLIDER: "slider",
   DROPDOWN: "dropdown",
   RADIO_BUTTON: "radio_button",
   CHECK_BOX: "check_box"
-}, t = {
+}, n = {
   STARS: "0",
   SCALE_RATING: "1",
   IMAGES: "2"
-}, j = {
-  [t.STARS]: "stars",
-  [t.SCALE_RATING]: "scale",
-  [t.IMAGES]: "images"
+}, J = {
+  [n.STARS]: "stars",
+  [n.SCALE_RATING]: "scale",
+  [n.IMAGES]: "images"
 }, s = {
   HORIZONTAL: "0",
   VERTICAL: "1"
-}, Z = {
+}, $ = {
   [s.HORIZONTAL]: "horizontal",
   [s.VERTICAL]: "vertical"
-}, Q = {
+}, aa = {
   NEW_WINDOW: "newwindow",
   EMBEDDED_HTML: "embeddedhtml"
-}, X = {
+}, ea = {
   1: ["image/jpg", "image/jpeg", "image/bmp", "image/gif", "image/png"],
   // Images
   2: [
@@ -249,7 +249,7 @@ const f = () => {
     "video/x-flv"
   ]
   // Video
-}, J = [
+}, _a = [
   {
     id: "1",
     name: "patient_number",
@@ -277,14 +277,14 @@ const f = () => {
     crf_name: "",
     status: "1"
   }
-], $ = {
+], ia = {
   EMAIL: 1,
   MOBILE: 2,
   PLATFORM: 3,
   SMS: 4,
   HL7: 5,
   ALL: ["1", "2", "3", "4", "5"]
-}, c = [
+}, N = [
   ["Afghanistan (‫افغانستان‬‎)", "af", "93"],
   ["Albania (Shqipëri)", "al", "355"],
   ["Algeria (‫الجزائر‬‎)", "dz", "213"],
@@ -578,34 +578,34 @@ const f = () => {
   ["Zambia", "zm", "260"],
   ["Zimbabwe", "zw", "263"],
   ["Åland Islands", "ax", "358", 1, ["18"]]
-], aa = c.reduce((a, e) => {
-  const n = e[1];
-  return a[n] = e[2], a;
+], ta = N.reduce((a, e) => {
+  const t = e[1];
+  return a[t] = e[2], a;
 }, {});
-var N = /* @__PURE__ */ ((a) => (a.CLOSED = "Closed", a.OPEN = "Open", a.COMING_SOON = "Coming soon", a))(N || {});
-const o = {
+var c = /* @__PURE__ */ ((a) => (a.CLOSED = "Closed", a.OPEN = "Open", a.COMING_SOON = "Coming soon", a))(c || {});
+const E = {
   PERMANENT: "Permanent",
   TEMPORARY: "Temporary"
-}, E = {
+}, o = {
   QOL: "QoL",
   TASK: "Task"
-}, ea = {
-  0: E.QOL,
-  1: E.TASK
-}, _a = {
-  0: o.PERMANENT,
-  1: o.TEMPORARY
-}, ia = {
+}, na = {
+  0: o.QOL,
+  1: o.TASK
+}, ra = {
+  0: E.PERMANENT,
+  1: E.TEMPORARY
+}, sa = {
   DATE: "date_of_questionnaire",
   TIME: "time_of_questionnaire"
-}, na = {
+}, Ea = {
   TYPE: "type_of_questionnaire"
-}, ta = {
+}, oa = {
   PERSEED_ADMIN: "PerseedAdmin",
   ECOSYSTEM_ADMIN: "EcosystemAdmin",
   USER: "Users",
   SALE: "Sales"
-}, ra = {
+}, Aa = {
   ADD_PATIENT: "add_patient",
   ADD_REPEATABLE_CRF: "add_repeat_crf",
   ADVANCED_FILTER: "advanced_filter",
@@ -647,7 +647,7 @@ const o = {
   DASHBOARD_FOLLOWUP_ALL: "dashboard_followup_access_all",
   DASHBOARD_FOLLOWUP_OWN: "dashboard_followup_access_own",
   DASHBOARD_FOLLOWUP_ASSIGNED: "dashboard_followup_access_assigned"
-}, sa = [
+}, la = [
   "Etc/GMT+12",
   "Pacific/Midway",
   "Pacific/Honolulu",
@@ -724,7 +724,7 @@ const o = {
   "Pacific/Fiji",
   "Pacific/Auckland",
   "Pacific/Tongatapu"
-], oa = [
+], Ta = [
   "ab",
   "aa",
   "af",
@@ -914,7 +914,7 @@ const o = {
   "yo",
   "za",
   "zu"
-], Ea = [
+], ua = [
   "af_ZA",
   "am_ET",
   "ar_AE",
@@ -1126,9 +1126,9 @@ const o = {
   "zh_TW",
   "zu_ZA",
   "fi_FI"
-], Aa = "forms", la = "history";
-var d = /* @__PURE__ */ ((a) => (a.VALUECARD = "ValueCard", a.SECTIONCARD = "SectionCard", a.PATIENTLIST = "PatientList", a.DASHBOARD = "Dashboard", a))(d || {}), I = /* @__PURE__ */ ((a) => (a.OUTCOMES = "outcomes", a))(I || {}), S = /* @__PURE__ */ ((a) => (a.QUESTIONNAIRE_CREATE = "questionnaire.create", a.CRF_CREATE = "crf.create", a.CRF_UPDATE = "crf.update", a.CRF_DELETE = "crf.delete", a.EXTERNAL_API_CALL = "external_api_call", a))(S || {}), m = /* @__PURE__ */ ((a) => (a.JSON_LOGIC = "jsonLogic", a.CUSTOM = "custom", a))(m || {}), _ = /* @__PURE__ */ ((a) => (a.CREATION = "creation", a.UPDATE = "update", a))(_ || {}), R = /* @__PURE__ */ ((a) => (a.TEXT = "text", a.DATE = "date", a.TIME = "time", a.BOOLEAN = "boolean", a.NUMBER = "number", a.SELECT = "select", a.MULTISELECT = "multiselect", a.HIDDEN = "hidden", a))(R || {});
-class Ta {
+], Na = "forms", ca = "history";
+var d = /* @__PURE__ */ ((a) => (a.VALUECARD = "ValueCard", a.SECTIONCARD = "SectionCard", a.PATIENTLIST = "PatientList", a.DASHBOARD = "Dashboard", a))(d || {}), I = /* @__PURE__ */ ((a) => (a.OUTCOMES = "outcomes", a))(I || {}), S = /* @__PURE__ */ ((a) => (a.TEXT = "text", a.NUMBER = "number", a.BOOLEAN = "boolean", a.DATE = "date", a.TIME = "time", a.DATETIME = "datetime", a))(S || {}), m = /* @__PURE__ */ ((a) => (a.ASC = "asc", a.DESC = "desc", a))(m || {}), R = /* @__PURE__ */ ((a) => (a.TEXT = "text", a.ICON = "icon", a.ICON_TEXT = "icon_text", a))(R || {}), O = /* @__PURE__ */ ((a) => (a.UP = "up", a.DOWN = "down", a.LEFT = "left", a.RIGHT = "right", a))(O || {}), L = /* @__PURE__ */ ((a) => (a.QUESTIONNAIRE_CREATE = "questionnaire.create", a.CRF_CREATE = "crf.create", a.CRF_UPDATE = "crf.update", a.CRF_DELETE = "crf.delete", a.EXTERNAL_API_CALL = "external_api_call", a))(L || {}), M = /* @__PURE__ */ ((a) => (a.JSON_LOGIC = "jsonLogic", a.CUSTOM = "custom", a))(M || {}), _ = /* @__PURE__ */ ((a) => (a.CREATION = "creation", a.UPDATE = "update", a))(_ || {}), C = /* @__PURE__ */ ((a) => (a.TEXT = "text", a.DATE = "date", a.TIME = "time", a.BOOLEAN = "boolean", a.NUMBER = "number", a.SELECT = "select", a.MULTISELECT = "multiselect", a.HIDDEN = "hidden", a))(C || {});
+class da {
   constructor(e) {
     this.notified_about = e;
   }
@@ -1139,7 +1139,7 @@ class Ta {
     return this.notified_about.toLowerCase().endsWith(_.UPDATE) ? _.UPDATE : this.notified_about.toLowerCase().endsWith(_.CREATION) ? _.CREATION : null;
   }
   isCrfTrigger() {
-    return this.notified_about === O || this.notified_about.startsWith("crf_");
+    return this.notified_about === D || this.notified_about.startsWith("crf_");
   }
   isModelTrigger() {
     return this.notified_about.startsWith("model_");
@@ -1154,8 +1154,8 @@ class Ta {
     if (this.isModelTrigger() && !this.isDisplayerTrigger())
       return this.notified_about.split("_")[1];
     if (this.isDisplayerTrigger()) {
-      const e = this.notified_about.split("_"), n = e[e.length - 1];
-      return Object.values(_).includes(n) && e.pop(), e.slice(2).join("_");
+      const e = this.notified_about.split("_"), t = e[e.length - 1];
+      return Object.values(_).includes(t) && e.pop(), e.slice(2).join("_");
     }
   }
   getModelTriggerAction() {
@@ -1163,71 +1163,75 @@ class Ta {
     return e && this.isDisplayerTrigger() ? this.notified_about.replace(`model_displayer_${e}_`, "").replace(`model_displayer_${e}`, "") : e && this.isModelTrigger() ? this.notified_about.replace(`model_${e}_`, "").replace(`model_${e}`, "") : null;
   }
 }
-const O = "Patient Creation";
-var L = /* @__PURE__ */ ((a) => (a[a.START_OVER = 0] = "START_OVER", a[a.RESUME = 1] = "RESUME", a))(L || {});
+const D = "Patient Creation";
+var p = /* @__PURE__ */ ((a) => (a[a.START_OVER = 0] = "START_OVER", a[a.RESUME = 1] = "RESUME", a))(p || {});
 export {
-  v as AUDIT_FLAGS,
-  S as ApiAction,
+  G as AUDIT_FLAGS,
+  L as ApiAction,
   T as CORE,
-  m as ConditionsFormat,
-  aa as CountryPhoneCodes,
-  p as DATETIME_SHORT_FORMAT,
+  S as ColumnType,
+  M as ConditionsFormat,
+  ta as CountryPhoneCodes,
+  f as DATETIME_SHORT_FORMAT,
   A as DATE_FORMAT,
-  P as DATE_TYPE,
-  J as DEFAULT_CONFIGURATION_PATIENT_LIST,
-  X as DYNAMIC_FILE_VALID_FORMATS,
+  y as DATE_TYPE,
+  _a as DEFAULT_CONFIGURATION_PATIENT_LIST,
+  ea as DYNAMIC_FILE_VALID_FORMATS,
   d as DashboardWidgetType,
   I as DataLoaderType,
-  y as EXCLUDE_FIELDS,
-  h as Exporter,
+  B as EXCLUDE_FIELDS,
+  P as Exporter,
   r as FIELDS,
   i as FIELD_NAMES,
-  f as FIELD_NAMES_MAP,
-  Y as FIELD_STATUS,
-  G as FIELD_SUFFIX,
-  Aa as FORMS_VIEW,
-  k as FORM_NAMES,
-  F as FORM_SUFFIX,
+  v as FIELD_NAMES_MAP,
+  V as FIELD_STATUS,
+  z as FIELD_SUFFIX,
+  Na as FORMS_VIEW,
+  H as FORM_NAMES,
+  Y as FORM_SUFFIX,
   l as FORM_TYPES,
-  o as HISTORY,
-  _a as HISTORY_TYPE_OPTIONS,
-  la as HISTORY_VIEW,
-  Q as HREF_TYPE,
-  R as IntrospectionSchemaFieldType,
-  oa as LANG_CODES,
-  Ea as LOCALE_LANG_CODES,
-  x as META_NAMES,
-  K as META_RESTRICTION,
-  q as META_STATUS,
-  sa as MINIMIAL_TIMEZONE_LIST,
-  B as MULTIPLE_SELECTION_SEPARATOR,
-  g as MYSQL_DATETIME_FORMAT,
-  D as MYSQL_DATE_FORMAT,
-  $ as NOTIFIED_TYPES,
-  z as NO_FILL_STATUS,
-  b as NUMBER_TYPE,
-  Ta as NotifiedAboutInfo,
-  U as OBJECT_TYPE,
-  O as PATIENT_CREATION_ABOUT,
-  ia as QUESTIONNAIRE_DATE,
-  na as QUESTIONNAIRE_TYPE,
-  ea as QUESTIONNAIRE_TYPE_OPTIONS,
-  L as QuestionnaireInfoUpdateMode,
-  ta as ROLES,
-  ra as SEED_PRIVILEGE,
-  W as SELECTOR_TYPE,
-  C as SHORT_TIME_FORMAT,
-  Z as SLIDER_SCALE_ORIENTATION_TYPE,
+  E as HISTORY,
+  ra as HISTORY_TYPE_OPTIONS,
+  ca as HISTORY_VIEW,
+  aa as HREF_TYPE,
+  O as IconPosition,
+  C as IntrospectionSchemaFieldType,
+  Ta as LANG_CODES,
+  ua as LOCALE_LANG_CODES,
+  j as META_NAMES,
+  X as META_RESTRICTION,
+  Z as META_STATUS,
+  la as MINIMIAL_TIMEZONE_LIST,
+  w as MULTIPLE_SELECTION_SEPARATOR,
+  U as MYSQL_DATETIME_FORMAT,
+  b as MYSQL_DATE_FORMAT,
+  ia as NOTIFIED_TYPES,
+  q as NO_FILL_STATUS,
+  k as NUMBER_TYPE,
+  da as NotifiedAboutInfo,
+  F as OBJECT_TYPE,
+  m as OrderType,
+  D as PATIENT_CREATION_ABOUT,
+  R as PresentationWidget,
+  sa as QUESTIONNAIRE_DATE,
+  Ea as QUESTIONNAIRE_TYPE,
+  na as QUESTIONNAIRE_TYPE_OPTIONS,
+  p as QuestionnaireInfoUpdateMode,
+  oa as ROLES,
+  Aa as SEED_PRIVILEGE,
+  Q as SELECTOR_TYPE,
+  h as SHORT_TIME_FORMAT,
+  $ as SLIDER_SCALE_ORIENTATION_TYPE,
   s as SLIDER_SCALE_TYPE,
-  j as SLIDER_SELECTOR_TYPE,
-  t as SLIDER_TYPE,
-  N as STATUS,
+  J as SLIDER_SELECTOR_TYPE,
+  n as SLIDER_TYPE,
+  c as STATUS,
   u as STATUS_FIELD_REGEXP,
-  H as STATUS_SUFFIX,
-  M as TIME_FORMAT,
-  V as TIME_SCHEMA,
-  E as TYPE,
+  x as STATUS_SUFFIX,
+  g as TIME_FORMAT,
+  W as TIME_SCHEMA,
+  o as TYPE,
   _ as TriggerAction,
-  c as allCountries,
-  w as isNotStatusField
+  N as allCountries,
+  K as isNotStatusField
 };