@persei/perseed-api 4.34.11 → 4.34.14

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { AjvValidator } from 'objection';
+import { Dayjs } from 'dayjs';
 import { default as default_2 } from 'objection';
 import { i18n } from 'i18next';
 import { Knex } from 'knex';
@@ -18,10 +19,10 @@ declare class AbstractDisplayer extends BaseModel {
     creation_time: string;
     mod_user: number;
     mod_time: string;
-    static getModel(ctx: RequestContext): typeof AbstractDisplayer;
     static get QueryBuilder(): typeof CustomQueryBuilder;
     static get uidRefProp(): null;
     static get dbRefProp(): null;
+    static getModel(ctx: RequestContext): typeof AbstractDisplayer;
     getString(value: any): any;
     getNumber(value: any): any;
     $beforeDelete(queryContext: any): Promise<void>;
@@ -34,6 +35,8 @@ declare class AbstractDisplayer extends BaseModel {
 
 export declare type AggFunction = 'avg' | 'count' | 'max' | 'min' | 'sum';
 
+export declare const allCountries: (string | number | string[])[][];
+
 export declare enum ApiAction {
     QUESTIONNAIRE_CREATE = "questionnaire.create",
     CRF_CREATE = "crf.create",
@@ -42,7 +45,7 @@ export declare enum ApiAction {
     EXTERNAL_API_CALL = "external_api_call"
 }
 
-declare interface ApiActionContextData {
+export declare interface ApiActionContextData {
     ctx?: RequestContext;
     requestContextData?: RequestContextData;
     current: Record<string, unknown>;
@@ -71,14 +74,14 @@ export declare interface AuthenticationSecurityDefinition {
     default?: MFAMethodCode;
 }
 
-declare type BaseApiServicePayload = {
+export declare type BaseApiServicePayload = {
     ctx?: RequestContext;
 } & Partial<ApiActionContextData>;
 
 declare class BaseModel extends Model {
     id: number;
-    static createValidator(): AjvValidator;
     static get modelPaths(): string[];
+    static createValidator(): AjvValidator;
     $parseJson(json: any, _opt: any): any;
 }
 
@@ -414,6 +417,8 @@ export declare const CORE: {
     SUBFORM_ID: string;
 };
 
+export declare const CountryPhoneCodes: {};
+
 export declare interface CreateDashboardPayload {
     title: string;
     active?: boolean;
@@ -511,6 +516,17 @@ declare type EcosystemUsers = {
 
 export declare const EXCLUDE_FIELDS: string[];
 
+export declare const Exporter: {
+    PENDING: string;
+    ERROR: string;
+    SUCCESS: string;
+    AVAILABLE_FORMATS: {
+        xls: number;
+        csv: number;
+        spss: number;
+    };
+};
+
 declare class ExternalDisplayerCrf extends BaseModel {
     crf_name: string;
     patient_id: number;
@@ -726,6 +742,8 @@ export declare enum FORM_TYPES {
     STUDY = 6
 }
 
+export declare const FORMS_VIEW = "forms";
+
 export declare type GenericBooleanSetting = boolean;
 
 export declare interface GenericWidgetDataLoader {
@@ -733,7 +751,17 @@ export declare interface GenericWidgetDataLoader {
     params: Record<string, any>;
 }
 
-export declare function getIntrospectionSchema(t: TFunction): IntrospectionSchema;
+export declare const HISTORY: {
+    PERMANENT: string;
+    TEMPORARY: string;
+};
+
+export declare const HISTORY_TYPE_OPTIONS: {
+    '0': string;
+    '1': string;
+};
+
+export declare const HISTORY_VIEW = "history";
 
 export declare const HREF_TYPE: {
     NEW_WINDOW: string;
@@ -741,8 +769,8 @@ export declare const HREF_TYPE: {
 };
 
 export declare interface I18nTextLocales {
-    [locale: string]: string;
     default: string;
+    [locale: string]: string;
 }
 
 export declare type I18nTextTranslation = I18nTextLocales | string;
@@ -796,11 +824,15 @@ export declare interface IntrospectionSchemaModel {
 
 export declare const isNotStatusField: (fieldName: any) => boolean;
 
+export declare const LANG_CODES: string[];
+
 export declare interface LoadPatientDataType {
     join?: string[];
     where: Record<string, string> | 'auto';
 }
 
+export declare const LOCALE_LANG_CODES: string[];
+
 export declare const META_NAMES: {
     DEPENDENT_SOURCE: string;
     ENCRYPTED: string;
@@ -893,6 +925,8 @@ export declare interface MFAMethod {
  */
 export declare type MFAMethodCode = 'sms' | 'email';
 
+export declare const MINIMIAL_TIMEZONE_LIST: string[];
+
 export declare type ModelName = string;
 
 export declare const MULTIPLE_SELECTION_SEPARATOR = "~";
@@ -911,6 +945,15 @@ export declare interface NotificationConfigurationConf {
     conditionsFormat?: ConditionsFormat;
 }
 
+export declare const NOTIFIED_TYPES: {
+    EMAIL: number;
+    MOBILE: number;
+    PLATFORM: number;
+    SMS: number;
+    HL7: number;
+    ALL: string[];
+};
+
 export declare class NotifiedAboutInfo {
     notified_about: string;
     constructor(notifiedAbout: string);
@@ -934,9 +977,6 @@ export declare const OBJECT_TYPE: string[];
 
 declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 
-/**
- * Any changes here may need changes in Caaring-js packages/perseed-api-client/src/PerseedApiClient.ts
- */
 export declare type OrderDir = 'asc' | 'desc';
 
 export declare type Outcome = OutcomeDateGroup & {
@@ -1105,7 +1145,6 @@ declare class Profiling extends BaseModel {
     };
     static getModel(ctx: RequestContext): typeof Profiling;
     static getFirstProProfilingId(ctx: RequestContext, projectId: number): Promise<number | undefined>;
-    isProProfiling(seedPrivileges: SeedPrivilege[]): boolean;
     static hasAddPatient(seedPrivilegeName: string): boolean;
     static hasConfigNotifications(seedPrivilegeName: string): boolean;
     static hasManageUsers(seedPrivilegeName: string): boolean;
@@ -1117,6 +1156,8 @@ declare class Profiling extends BaseModel {
     static hasDeleteDocumentsPermission(seedPrivilegeName: string): boolean;
     static hasDownloadDocumentsPermission(seedPrivilegeName: string): boolean;
     static hasDisplayPatientListPrivilege(seedPrivilegeName: string): boolean;
+    static checkIfProfilingExists(ctx: RequestContext, profilingId?: number): Promise<boolean>;
+    isProProfiling(seedPrivileges: SeedPrivilege[]): boolean;
     hasManageUsersPrivilege(): boolean;
     hasCoreProUserSensitiveInfoPrivilege(): boolean;
     hasUserManagementMyOrganizationsPrivilege(): boolean;
@@ -1135,7 +1176,6 @@ declare class Profiling extends BaseModel {
     hasConnectorAddFieldPrivilege(): boolean;
     hasRawExportPrivilege(): boolean;
     hasExportConfigurationsExplicitAccessOnlyPrivilege(): boolean;
-    static checkIfProfilingExists(ctx: RequestContext, profilingId?: number): Promise<boolean>;
     isPro(): boolean;
     isNonPro(): boolean;
     hasEnabledForm(formName: any): boolean;
@@ -1419,18 +1459,56 @@ declare class Project extends BaseModel {
     static getProjectLabel(ctx: RequestContext, projectName: string): Promise<string | undefined>;
 }
 
-declare enum QuestionnaireInfoUpdateMode {
+export declare const QUESTIONNAIRE_DATE: {
+    DATE: string;
+    TIME: string;
+};
+
+export declare const QUESTIONNAIRE_TYPE: {
+    TYPE: string;
+};
+
+export declare const QUESTIONNAIRE_TYPE_OPTIONS: {
+    '0': string;
+    '1': string;
+};
+
+export declare interface QuestionnaireInfoData extends QuestionnaireInfoPatchData {
+    id: number;
+}
+
+export declare interface QuestionnaireInfoPatchData {
+    crf_name?: string;
+    patient_id: number;
+    number_of_questionaries?: number | null;
+    last_update?: string | null;
+    last_update_form_id?: number | null;
+    procedure_date: string;
+    activation_date?: Dayjs | string | null;
+    end_date?: string | null;
+    next_date?: string | null;
+    finish_date?: string | null;
+    questionaries_not_filled?: number | null;
+    flexible_entry?: number;
+    field_reference_id?: number | null;
+    total_tasks: number;
+    activation_time_tz?: string | null;
+}
+
+export declare enum QuestionnaireInfoUpdateMode {
     START_OVER = 0,
     RESUME = 1
 }
 
-declare interface QuestionnaireInfoUpdateOptions {
+export declare interface QuestionnaireInfoUpdateOptions {
     defaultMode: QuestionnaireInfoUpdateMode;
     referenceFieldIdModes?: {
         [key: string]: QuestionnaireInfoUpdateMode;
     };
 }
 
+export declare type QuestionnaireTypeValue = 'QoL' | 'Task';
+
 /**
  * req.body object mfa validation
  */
@@ -1543,6 +1621,10 @@ declare class RequestContext implements RequestContextData {
         ecosystemName?: string | null;
         projectName?: string | null;
     };
+    private constructor();
+    get userType(): string | undefined;
+    get acceptLanguage(): string;
+    get t(): TFunction<["translation", ...string[]], undefined>;
     static create(data: RequestContextData): Promise<RequestContext>;
     static createFromRequest(req: Request_2): Promise<RequestContext>;
     static getRequestDataWithUser(req: Optional<Request_2, 'ctx'>, u: Partial<UserData>): RequestContextData;
@@ -1559,14 +1641,9 @@ declare class RequestContext implements RequestContextData {
         reqId?: string | undefined;
     };
     getStaticRequestData(): Partial<RequestContextData>;
-    private constructor();
-    private init;
     updateContextData(data: Partial<RequestContextData>): Promise<void>;
-    get userType(): string | undefined;
-    get acceptLanguage(): string;
     getRequestContextData(): RequestContextData;
     cloneWithData(data: Partial<RequestContextData>): Promise<RequestContext>;
-    get t(): TFunction<["translation", ...string[]], undefined>;
     getProjectPool(): Knex;
     getEcosystemPool(): Knex;
     getPerseedPool(): Knex;
@@ -1578,6 +1655,7 @@ declare class RequestContext implements RequestContextData {
     getEcosystemName(): string;
     getEcosystemId(): number;
     getPatientId(): number;
+    private init;
 }
 
 declare interface RequestContextData {
@@ -1614,6 +1692,13 @@ declare class Role extends BaseModel {
     static getIdByRoleId(ctx: RequestContext, roleId: string): Promise<number | undefined>;
 }
 
+export declare const ROLES: {
+    PERSEED_ADMIN: string;
+    ECOSYSTEM_ADMIN: string;
+    USER: string;
+    SALE: string;
+};
+
 export declare interface SectionCardProps {
     icon: string;
     background?: string;
@@ -1625,7 +1710,7 @@ export declare interface SectionCardProps {
 /**
  * Seed Privilege constants
  */
-declare const SEED_PRIVILEGE: {
+export declare const SEED_PRIVILEGE: {
     readonly ADD_PATIENT: "add_patient";
     readonly ADD_REPEATABLE_CRF: "add_repeat_crf";
     readonly ADVANCED_FILTER: "advanced_filter";
@@ -1666,7 +1751,7 @@ declare const SEED_PRIVILEGE: {
 
 declare type SEED_PRIVILEGE_Keys = keyof typeof SEED_PRIVILEGE;
 
-declare type SEED_PRIVILEGES = typeof SEED_PRIVILEGE[SEED_PRIVILEGE_Keys];
+export declare type SEED_PRIVILEGES = typeof SEED_PRIVILEGE[SEED_PRIVILEGE_Keys];
 
 declare class SeedPrivilege extends BaseModel {
     seed_id: number;
@@ -1782,6 +1867,12 @@ export declare const SLIDER_TYPE: {
     IMAGES: string;
 };
 
+export declare enum STATUS {
+    CLOSED = "Closed",
+    OPEN = "Open",
+    COMING_SOON = "Coming soon"
+}
+
 export declare const STATUS_FIELD_REGEXP: RegExp;
 
 export declare const STATUS_SUFFIX = "_status";
@@ -1831,6 +1922,11 @@ export declare enum TriggerAction {
     UPDATE = "update"
 }
 
+export declare const TYPE: {
+    QOL: string;
+    TASK: string;
+};
+
 export declare type UpdateDashboardPayload = Partial<CreateDashboardPayload>;
 
 export declare interface UpdateFormPayload extends BaseApiServicePayload {
@@ -2132,6 +2228,9 @@ declare class User extends BaseModel {
     static logAccess(ctx: RequestContext, userId: number, checkPrevValue?: boolean): Promise<void>;
     static logFailedLogin(ecosystemPool: default_2.TransactionOrKnex, userId: number): Promise<User[]>;
     static resetCurrentFailedCount(ecosystemPool: default_2.TransactionOrKnex, userId: number): Promise<number>;
+    static checkUploadDocumentsPermissions(projectId: number, profilings: Profiling[]): boolean;
+    static checkDeleteDocumentsPermissions(projectId: number, profilings: Profiling[]): boolean;
+    static checkDownloadDocumentsPermissions(projectId: number, profilings: Profiling[]): boolean;
     getCrfFilter(projectName: string): string[] | null;
     getClinics(): Clinic[];
     checkIfAccountIsActivated(activationToken: string): boolean;
@@ -2145,9 +2244,6 @@ declare class User extends BaseModel {
     checkConfigNotificationsPermissions(projectId: number): boolean;
     checkDisplayPatientListPermissions(projectId: number): boolean;
     checkOnlyUpdatePatientsPermissions(projectName: string): boolean;
-    static checkUploadDocumentsPermissions(projectId: number, profilings: Profiling[]): boolean;
-    static checkDeleteDocumentsPermissions(projectId: number, profilings: Profiling[]): boolean;
-    static checkDownloadDocumentsPermissions(projectId: number, profilings: Profiling[]): boolean;
     checkPermission(ctx: RequestContext, privilege: SEED_PRIVILEGES): boolean;
     checkUserProject(projectId: number): boolean;
     isPerseedAdmin(): boolean;