@persei/perseed-api 4.34.2

package/README.md

@@ -0,0 +1,260 @@
+# Table of contents
+
+1. [Perseed API - NodeJS](#1-perseed-api-nodejs)
+2. [Requirements](#2-requirements)
+3. [Installation overview](#3-installation-overview)
+4. [Tunneling database connection](#4-tunneling-database-connection)
+5. [Local development without docker - NOT RECOMMENDED](#5-local-development-without-docker-not-recommended)
+6. [Local development with docker-compose (with auto reload via nodemon) - RECOMMENDED](#6-local-development-with-docker-compose-with-auto-reload-via-nodemon-recommended)
+7. [API documentation](#7-api-documentation)
+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)
+
+# 1 - Perseed API - NodeJs
+
+The perseed API (node js) provides a series of endpoints for clients to communicate
+to the Perseed ecosystem.
+
+As client, we understand that it can be:
+
+1. A third party that is integrating with the API.
+2. Internal or external mobile applications that want to consume the data provided by the API.
+
+This readme provides the basic guidance to get started.
+
+# 2 - Requirements
+
+For local development without docker:
+
+- NodeJs 10+ (Installation instructions [here](https://nodejs.org/en/download/package-manager)
+- NPM 6+
+
+For local development with docker and docker-compose:
+
+- docker engine installed (Installation instructions can be found [here](https://docs.docker.com/install))
+- docker-compose installed (Installation instructions can be found [here](https://docs.docker.com/compose/install))
+
+## 2.1 - Setting up credentials file
+
+Disclaimer: this section is required for local setup with or without docker.
+
+1. Copy the file ´config.local.example´ from the root of the project and past it in the credentials folder `config/credentials` as `local.js` (`cp config.local.example config/credentials/local.js`)
+2. Copy the file ´config.local.example´ from the root of the project and past it in the credentials folder `config/credentials` as `test.js` (`cp config.local.example config/credentials/test.js`)
+3. Copy the file ´~/.ssh/id_rsa.pub´ and paste it in the key folder `config/apiPublicKey` as `public.pem` (`cp ~/.ssh/id_rsa.pub config/apiPublicKey/public.pem`)
+
+# 3 - Installation overview
+
+Once cloned this repository, a few steps are required in order to get the API
+up and running, and they are as follows:
+
+- set up a local credentials file, it includes the js files with secrets as well as the public key file.
+- Install dependencies
+- Start database tunneling
+- Start the API process
+
+For each item mentioned above, there is a section that follows what is needed to completed each step.
+
+# 4 - Tunneling database connection - NOT RECOMMENDED
+
+As a suggested approach to not setup projects into local database, a ssh tunnel
+is the way to go, the following command can create a connection from the database
+to a local port:
+
+```
+ssh perseedweb00-dev -L 3306:10.150.128.151:3306
+```
+
+The command above exposes the port 3306 from the server (**10.150.128.151**) to the port 3306
+on the localhost. In this example, the IP **10.150.128.151** is the staging database,
+or as it is most common called in perseed, the TMP database serve.
+
+Quick note on tunneling connections: probably if your using a tunnel you would also like
+to set up the `/etc/hosts` accordingly, assuming the TMP database above, you should add the
+following entry on the hosts file:
+
+```
+127.0.0.1       perseeddb00-dev.internal.persei.com.es
+```
+
+# 5 - Local development without docker - NOT RECOMMENDED
+
+## 5.1 - Install the dependencies
+
+The preferred way to install the project dependencies is through NPM, running the following command:
+
+`npm install`
+
+In order to proceed to the API launch this command must exit with status 0, in other words, successfully.
+
+## 5.2 - Start the api process (non development - without autoreload)
+
+Once the previous two steps have been completed successfully, the api can be started running the following command:
+
+`npm run start`
+
+# 6 - Local development with docker-compose (with auto reload via nodemon) - RECOMMENDED
+
+The preferred command to use docker is through the `docker-compose` itself,
+the setup used by docker-compose, deploys two containers: nginx and the node js.
+
+To a clean installation make sure that there is no **node_modules** folder
+created in the root directory, then proceed to execute the first command
+to install the dependencies:
+
+Also this setup assumes that you are **NOT** using the tunneling approach, for
+tunneling, have a look at the command in the section 6.1.
+
+```
+docker-compose -f docker-compose-dev.yml run --rm nodejs npm install --target_arch=x64 --target_platform=linux
+```
+
+Once the command is finished, then, lunch the services (note: it will
+keep showing up logs in the terminal):
+
+```
+docker-compose -f docker-compose-dev.yml up
+```
+
+To double-check the setup, and in a new terminal window, run the following test
+suite:
+
+```
+docker-compose -f docker-compose-dev.yml run --rm nodejs npm run test-unit
+```
+
+Besides that, the docker-compose setup comes with one single ecosystem (reseaarch) and
+the credentials are as follows:
+
+- Ecosystem admin (used to generate the JWT token):
+
+```
+username: ecoadmin
+password: 1CarefulWithPersonalInfo2
+```
+
+## 6.1 Local development with docker with tunneling
+
+For more advanced developers that want to play with the raw image through docker
+a friendly command is provided below. For more information about the image
+please refer to the `Dockerfile` in the repository root directory.
+
+```
+ docker build . -t perseed_api && docker run -p 3005:3005 -it --net=host -v $(pwd):/var/www/perseed_api perseed_api npm run dev
+```
+
+The command above will build the image, install npm dependencies and run the
+api. It is important to note that the `--net` is used explicitly for the tunneling,
+this way docker does not blocks the tunnel port. On the other hand, the docker
+compose file uses the network mode as host, which should change in the future.
+
+# 7 - API documentation
+
+The API documentation is build thanks to Swagger Tools that takes an OpenAPI Specification file (.yaml or .json) and generates code for Server and Client.
+
+In our case, we build the OpenAPI Spec file (swagger.yaml) directly from the API code comments using the **swagger_gen.py** script that can be found in this git repository.
+
+- This script goes through all the jsdocs files in the "routes" directory and parses all the comments that document the endpoints
+
+
+## 7.1 How to document an endpoint directly in the API code comments:
+More info in confluence at [How To Document The API](https://confluence.persei.com.es/display/TBDC/How+to+document+the+API)
+
+To document an endpoint the comment should be right above of endpoint. It is important **follow the next template**:
+
+-----------------
+#### 1. The Body Request *IS A MODEL*:
+```ruby
+    /*@PA <endpoint_path>
+	 method: <HTTP_method>
+	 summary: <What_the_endpoint_does>
+	 tags: [<tag1>,...,<tagN>]
+	 responses: #/<Response_Content (has to be JSON format)>/#
+	 body: model <model> - <description>
+	 */
+```
+
+#### 2. The Body Request is a *NOT A MODEL*:
+```ruby
+ 	/* @PA <endpoint_path>
+	 method: <HTTP_method>
+	 summary: <What_the_endpoint_does>
+	 tags: [<tag1>,...,<tagN>]
+	 responses:  #/<Response_Content (has to be JSON format)>/#
+	 body: {<Body_Content>} - <description>
+	required: [required_field1,...,required_fieldN]
+```
+-------------------
+The API can return a response in two ways:
+
+1. Returning as a response body ***A MODEL THAT ALREADY EXISTS***:
+2. Returning as a response body ***A JSON (not extracted from a model)***:
+
+>#### (1)
+>>responses:
+>>>**#/**{*“<HTTP_code_response1>”* : {**“content-type”** : *”<content_type>”*, **“model_content”** : *“<model_name>”*, **“description”** :  *“<description>”*},............................................................................................................................................................................
+
+
+>#### (2)
+>>>...........,*“<HTTP_code_responseN>”* : {**“content-type”** : *”<content_type>”*,**”json_content”** : *<JSON>*, **“description”** : *“<description>”*}}**/#**
+
+>#### (1) y (2)
+
+>>responses:
+>>>**#/**{*“<HTTP_code_response1>”* : {**“content-type”** : *”<content_type>”*, **“model_content”** : *“<model_name>”*, **“description”** : *“<description>”*} ,.........,
+*“<HTTP_code_responseN>”* : {**“content-type”** : *”<content_type>”*, **”json_content”** : *<JSON>*, **“description”** : *“<description>”*}}**/#**
+
+## 7.2 Recommendations:
+
+   1. The code was developed specifically for this type and format of comments.
+
+   2. Be sure that the comment starts with : **/\* @PA** and ends with: **\*/**
+
+   3. Just in case you want to check if you are formatting the comments correctly: [Regex Help](https://regexr.com/)
+
+- 3.1 body field (NOT A MODEL):
+
+>`body:(?:.||\n.*){((?:.|\n)*)}(?:.*-|-|)(.*)`
+
+- 3.2 body field (MODEL):
+
+>`body: model(.*)`
+
+- 3.3 responses field:
+
+>`responses:(?:.|\n)*?#\/((?:.|\n*.*){(?:.|\n)*})(?:(?:.|\n)*)\/#`
+
+- 3.4 tags field:
+
+>`tags:.*\[(.*)\]`
+
+- 3.5 required field:
+
+>`required:.*\[((?:.|\n)*)\]`
+
+## 8 Redis cache and queue
+
+The API can be configured to use a cache and/or queue system. Both are optional.
+
+To configure only redis cache set the env var REDIS_CACHE_URL with the connection url to redis server (for example redis://user:pass@host:6379/1).
+
+To configure only redis queue set the env var REDIS_QUEUE_URL with the connection url to redis server.
+
+To configure both at once set the env var REDIS_URL with the connection url to redis server.
+
+## 9 Generating json schema from ts definitions
+
+The schema can be generated manually:
+
+`npx ts-json-schema-generator --path 'my/project/**/*.ts' --type 'My.Type.Name'`
+
+Or added to /schemas.json to be generated automatically on every precommit
+
+## 10 Add a new language
+
+To add a new language:
+
+* Add to the `locales` array in `/i18next-parser.config.js`
+* Run `npm run i18n:generate` to generate the new locale file with the default values (in english). This file should be translated.
+* Done!
+

package/dist/perseed-api.mjs

@@ -0,0 +1,177 @@
+const n = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" })), c = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" }));
+var a = /* @__PURE__ */ ((e) => (e.OUTCOMES = "outcomes", e))(a || {}), o = /* @__PURE__ */ ((e) => (e.VALUECARD = "ValueCard", e.SECTIONCARD = "SectionCard", e.PATIENTLIST = "PatientList", e))(o || {});
+const m = {
+  data_loaders: n,
+  widgets: c
+}, i = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  DashboardWidgetType: o,
+  DataLoaderType: a,
+  default: m
+}, Symbol.toStringTag, { value: "Module" })), d = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" }));
+var s = /* @__PURE__ */ ((e) => (e.QUESTIONNAIRE_CREATE = "questionnaire.create", e.CRF_CREATE = "crf.create", e.CRF_UPDATE = "crf.update", e.CRF_DELETE = "crf.delete", e))(s || {}), r = /* @__PURE__ */ ((e) => (e.JSON_LOGIC = "jsonLogic", e.CUSTOM = "custom", e))(r || {}), l = /* @__PURE__ */ ((e) => (e.CREATION = "creation", e.UPDATE = "update", e))(l || {}), t = /* @__PURE__ */ ((e) => (e.TEXT = "text", e.DATE = "date", e.TIME = "time", e.BOOLEAN = "boolean", e.NUMBER = "number", e.SELECT = "select", e.MULTISELECT = "multiselect", e))(t || {});
+function u(e) {
+  return {
+    models: {
+      user: {
+        label: e("introspection-schema.models.user.label", "User"),
+        relations: [],
+        canJoinPatient: !0,
+        fields: [
+          {
+            name: "username",
+            type: t.TEXT,
+            label: e("introspection-schema.models.user.username", "Username")
+          },
+          {
+            name: "created_user",
+            type: t.TEXT,
+            label: e("introspection-schema.models.user.created_user", "Created user")
+          },
+          {
+            name: "created_mode",
+            type: t.TEXT,
+            label: e("introspection-schema.models.user.created_mode", "Created mode")
+          },
+          {
+            name: "mod_user",
+            type: t.NUMBER,
+            label: e("introspection-schema.models.user.mod_user", "User modified")
+          },
+          {
+            name: "mod_time",
+            type: t.DATE,
+            label: e("introspection-schema.models.user.time", "Update date")
+          },
+          {
+            name: "email",
+            type: t.TEXT,
+            label: e("introspection-schema.models.user.email", "Email")
+          },
+          {
+            name: "password",
+            type: t.TEXT,
+            label: e("introspection-schema.models.user.password", "Password")
+          },
+          {
+            name: "displayName",
+            type: t.TEXT,
+            label: e("introspection-schema.models.user.display-name", "Display name")
+          },
+          {
+            name: "blocked",
+            type: t.BOOLEAN,
+            label: e("introspection-schema.models.user.blocked", "Blocked")
+          },
+          {
+            name: "timestamp",
+            type: t.DATE,
+            label: e("introspection-schema.models.user.timestamp", "Creation date")
+          },
+          {
+            name: "state",
+            type: t.BOOLEAN,
+            label: e("introspection-schema.models.user.state", "State")
+          },
+          {
+            name: "newRegister",
+            type: t.BOOLEAN,
+            label: e("introspection-schema.models.user.new-register", "New register")
+          },
+          {
+            name: "password_changed_date",
+            type: t.DATE,
+            label: e("introspection-schema.models.user.password-changed-date", "Password changed date")
+          },
+          {
+            name: "token",
+            type: t.TEXT,
+            label: e("introspection-schema.models.user.token", "Token")
+          },
+          {
+            name: "type",
+            type: t.TEXT,
+            label: e("introspection-schema.models.user.type", "Type")
+          },
+          {
+            name: "expiry_date",
+            type: t.DATE,
+            label: e("introspection-schema.models.user.expiry-date", "Expiry date")
+          },
+          {
+            name: "allow_upload",
+            type: t.BOOLEAN,
+            label: e("introspection-schema.models.user.allow-upload", "Allow upload")
+          },
+          {
+            name: "allow_change_color",
+            type: t.BOOLEAN,
+            label: e("introspection-schema.models.user.allow-change-color", "Allow change color")
+          },
+          {
+            name: "clinic_request",
+            type: t.BOOLEAN,
+            label: e("introspection-schema.models.user.clinic-request", "Clinic request")
+          },
+          {
+            name: "favourite",
+            type: t.BOOLEAN,
+            label: e("introspection-schema.models.user.favourite", "Favourite")
+          },
+          {
+            name: "last_access",
+            type: t.DATE,
+            label: e("introspection-schema.models.user.last-access", "Last access")
+          },
+          {
+            name: "temporary_password",
+            type: t.TEXT,
+            label: e("introspection-schema.models.user.temporary-password", "Temporary password")
+          },
+          {
+            name: "currentFailedCount",
+            type: t.NUMBER,
+            label: e("introspection-schema.models.user.current-failed-count", "Current failed count")
+          },
+          {
+            name: "tokenDate",
+            type: t.DATE,
+            label: e("introspection-schema.models.user.token-date", "Token date")
+          }
+        ]
+      }
+    }
+  };
+}
+const p = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  ApiAction: s,
+  ConditionsFormat: r,
+  IntrospectionSchemaType: t,
+  TriggerAction: l,
+  getIntrospectionSchema: u
+}, Symbol.toStringTag, { value: "Module" })), _ = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" })), b = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" })), E = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" })), T = {
+  dashboard: i,
+  authentication_security: d,
+  notification_configuration: p,
+  outcomes: _,
+  questionnaire: b,
+  user_settings: E
+}, y = {
+  schemas: T
+};
+export {
+  y as default
+};

package/dist/perseed-api.umd.js

@@ -0,0 +1 @@
+(function(o,a){typeof exports=="object"&&typeof module<"u"?module.exports=a():typeof define=="function"&&define.amd?define(a):(o=typeof globalThis<"u"?globalThis:o||self,o["perseed-api"]=a())})(this,function(){"use strict";const o=Object.freeze(Object.defineProperty({__proto__:null},Symbol.toStringTag,{value:"Module"})),a=Object.freeze(Object.defineProperty({__proto__:null},Symbol.toStringTag,{value:"Module"}));var s=(e=>(e.OUTCOMES="outcomes",e))(s||{}),r=(e=>(e.VALUECARD="ValueCard",e.SECTIONCARD="SectionCard",e.PATIENTLIST="PatientList",e))(r||{});const c=Object.freeze(Object.defineProperty({__proto__:null,DashboardWidgetType:r,DataLoaderType:s,default:{data_loaders:o,widgets:a}},Symbol.toStringTag,{value:"Module"})),d=Object.freeze(Object.defineProperty({__proto__:null},Symbol.toStringTag,{value:"Module"}));var n=(e=>(e.QUESTIONNAIRE_CREATE="questionnaire.create",e.CRF_CREATE="crf.create",e.CRF_UPDATE="crf.update",e.CRF_DELETE="crf.delete",e))(n||{}),l=(e=>(e.JSON_LOGIC="jsonLogic",e.CUSTOM="custom",e))(l||{}),i=(e=>(e.CREATION="creation",e.UPDATE="update",e))(i||{}),t=(e=>(e.TEXT="text",e.DATE="date",e.TIME="time",e.BOOLEAN="boolean",e.NUMBER="number",e.SELECT="select",e.MULTISELECT="multiselect",e))(t||{});function m(e){return{models:{user:{label:e("introspection-schema.models.user.label","User"),relations:[],canJoinPatient:!0,fields:[{name:"username",type:t.TEXT,label:e("introspection-schema.models.user.username","Username")},{name:"created_user",type:t.TEXT,label:e("introspection-schema.models.user.created_user","Created user")},{name:"created_mode",type:t.TEXT,label:e("introspection-schema.models.user.created_mode","Created mode")},{name:"mod_user",type:t.NUMBER,label:e("introspection-schema.models.user.mod_user","User modified")},{name:"mod_time",type:t.DATE,label:e("introspection-schema.models.user.time","Update date")},{name:"email",type:t.TEXT,label:e("introspection-schema.models.user.email","Email")},{name:"password",type:t.TEXT,label:e("introspection-schema.models.user.password","Password")},{name:"displayName",type:t.TEXT,label:e("introspection-schema.models.user.display-name","Display name")},{name:"blocked",type:t.BOOLEAN,label:e("introspection-schema.models.user.blocked","Blocked")},{name:"timestamp",type:t.DATE,label:e("introspection-schema.models.user.timestamp","Creation date")},{name:"state",type:t.BOOLEAN,label:e("introspection-schema.models.user.state","State")},{name:"newRegister",type:t.BOOLEAN,label:e("introspection-schema.models.user.new-register","New register")},{name:"password_changed_date",type:t.DATE,label:e("introspection-schema.models.user.password-changed-date","Password changed date")},{name:"token",type:t.TEXT,label:e("introspection-schema.models.user.token","Token")},{name:"type",type:t.TEXT,label:e("introspection-schema.models.user.type","Type")},{name:"expiry_date",type:t.DATE,label:e("introspection-schema.models.user.expiry-date","Expiry date")},{name:"allow_upload",type:t.BOOLEAN,label:e("introspection-schema.models.user.allow-upload","Allow upload")},{name:"allow_change_color",type:t.BOOLEAN,label:e("introspection-schema.models.user.allow-change-color","Allow change color")},{name:"clinic_request",type:t.BOOLEAN,label:e("introspection-schema.models.user.clinic-request","Clinic request")},{name:"favourite",type:t.BOOLEAN,label:e("introspection-schema.models.user.favourite","Favourite")},{name:"last_access",type:t.DATE,label:e("introspection-schema.models.user.last-access","Last access")},{name:"temporary_password",type:t.TEXT,label:e("introspection-schema.models.user.temporary-password","Temporary password")},{name:"currentFailedCount",type:t.NUMBER,label:e("introspection-schema.models.user.current-failed-count","Current failed count")},{name:"tokenDate",type:t.DATE,label:e("introspection-schema.models.user.token-date","Token date")}]}}}}return{schemas:{dashboard:c,authentication_security:d,notification_configuration:Object.freeze(Object.defineProperty({__proto__:null,ApiAction:n,ConditionsFormat:l,IntrospectionSchemaType:t,TriggerAction:i,getIntrospectionSchema:m},Symbol.toStringTag,{value:"Module"})),outcomes:Object.freeze(Object.defineProperty({__proto__:null},Symbol.toStringTag,{value:"Module"})),questionnaire:Object.freeze(Object.defineProperty({__proto__:null},Symbol.toStringTag,{value:"Module"})),user_settings:Object.freeze(Object.defineProperty({__proto__:null},Symbol.toStringTag,{value:"Module"}))}}});

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

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

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

@@ -0,0 +1,29 @@
+/**
+ * Available MFA methods
+ */
+export type MFAMethodCode = 'sms' | 'email';
+/**
+ * MFA method definition and configuration
+ */
+export interface MFAMethod {
+    code: MFAMethodCode;
+}
+/**
+ * Global authentication security definition
+ */
+export interface AuthenticationSecurityDefinition {
+    mfaMethods?: MFAMethod[];
+    required?: boolean;
+    default?: MFAMethodCode;
+}
+export interface MFALoginData {
+    type: MFAMethodCode;
+    value: string;
+}
+/**
+ * req.body object mfa validation
+ */
+export interface ReqBodyWithMFA {
+    mfa?: MFALoginData;
+    [key: string]: any;
+}