doc-nis-2 2.1.2 → 2.2.0

package/.env.example

@@ -0,0 +1,47 @@
+# APP
+NODE_ENV = "test" # or "dev" "prod"
+URL = 'https://demo.doc-nis-2.com' # if you are behind a reverse proxy, specify the external URL
+PORT = 4000
+
+PLANTUML_SERVER = 'http://127.0.0.1:8080' # in order to serve the /plantuml route. ideally should be served by the reverse proxy
+
+#CONFIG BDD DOC_IT
+DB_DOC_IT_HOST = "127.0.0.1"
+DB_DOC_IT_USER = "root"
+DB_DOC_IT_PORT = 3306
+DB_DOC_IT_PASSWORD = "mysqlroot"
+DB_DOC_IT_NAME = "doc_nis_2_test"
+BD_DOC_IT_CONNECTION_LIMIT = 20
+
+# migration system 0=only ckeck 1= do Migrations if needed
+DO_MIGRATIONS = 0  
+
+# AUTHENTIFICATION GOOGLE
+GOOGLE_CLIENT_ID = ""
+GOOGLE_CLIENT_SECRET = ""
+
+# CREATION TOKEN
+JWT_SECRET = # PUT HERE your own random value should be at least 32 char long ideally created with a password generator
+JWT_EXPIRES_IN = 86400000
+TWT_PASSWORD_RESET_EXPIRES_IN = 600000 
+
+# MAIL FOR FORGET MY PASSWORD
+ADMIN_MAIL = 
+ADMIN_MAIL_PASSWORD = 
+ADMIN_MAIL_SMTP = 
+ADMIN_MAIL_PORT =
+ADMIN_MAIL_REQUIRE_TLS = # 1= force using TLS  0 by default
+
+# LOGGER
+LOGGER_LEVEL = "debug" # "trace" to track a problem,  "info for production"
+
+# UPLOADS
+UPLOADS = # a path where to store document uploads
+
+# FEATURES
+## ONBOARDING new Users 1=new users can selt create an account and a repository
+##                      0=users have to be invited by an existing user that has the rights
+ONBOARDING = 0
+
+## DO_MIGRATIONS = 1 will migrate if needed;  0 = only check if all migrations are done
+DO_MIGRATIONS = 1

package/README.md

@@ -1,73 +1,185 @@
-# Doc-NIS-2
-
-the [NIS-2 directive](https://eur-lex.europa.eu/EN/legal-content/summary/cybersecurity-of-network-and-information-systems.html) 
-will force thousands of companies accross Europe to become more resillient on cyber threats
-
-For many of those meddium size buisnesses this is both a treat and an opportunity
-* a threat because they are not used to have a proper documentation (if any exists outside of the heads of the people)
-  * creating such a documentation is a real challenge
-  * existing tools are 
-    1) very expensive 
-    2) intended for larger organisations
-    3) have a steep learning curve, needing often a dedicated team
-* an opportunity because eventually not only they will be more resillient, but also will bet a better
-  understanding of their Information System
-
-with that in mind `Doc-NIS-2` is born after beeing fully rewritten from a private tool made during the COVID in order to help
-a company
-
-The main goals of `Doc-NIS-2` are
-* document an Information System
-* document the major processes of a company and describe the applications supporting thoses processes
-* document the risks using [EBOIS](https://cyber.gouv.fr/en/publications/ebios-risk-manager-method)
-* **user friendly**, **minimum of effort** and **collaborative**
-* **open source**
-
-The main principles are
-* every **element** of the system (actors, applications, servers, clouds, processes...) are described in a database
-* every **link** between thoses elements (an application uses another application... ) are also described
-* partial graphs are **automatically** created and represented using [plantuml](https://plantuml.com/). All graphs are enhanced in order to make them interactive.
-* all users can **collaborate** at the same time, each user having rights on each class of element
-
-![](./_front/user-docs/en/screenshots/deployment-edit-element-name.png)
-
-
-## installation
-
-`Doc-NIS-2` is a web application written in [Vue](https://vuejs.org/) for the front and [node](https://nodejs.org/) for the back
-
-It needs a [mariadb](https://mariadb.com/docs) for the database
-
-So it can be deployed easily on Linux or Windows
-
-### install mariadb 
-if needed, install mariadb. the community version is fully ok for this application
-
-#### create database
-
-create as many database that you need `doc_nis_2_prod` (and if you want a test environnement `doc_nis_2_test`)
-
-
-#### user for the migrations
-
-In order to create the database (and for future migrations) we need to have a user that has
-higher rights than in production in order to create the schema. This user must at least have
-
-```sql
-SHOW GRANTS FOR 'doc-nis-2-migrate'@'localhost'
-```
-| Grants for doc-nis-2-migrate@localhost | 
-| --- | 
-| GRANT USAGE ON *.* TO `doc-nis-2-migrate`@`localhost` IDENTIFIED BY PASSWORD '*566B7C98855895F9B303B58D292E191D03B8FFF8' | 
-| GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER, EXECUTE, CREATE VIEW, CREATE ROUTINE, ALTER ROUTINE, TRIGGER ON `doc\_it2\_dev`.* TO `doc-nis-2-migrate`@`localhost` | 
-
-#### user for production
-```sql
-SHOW GRANTS FOR 'doc-nis-2'@'localhost'
-
-```
-| Grants for doc-nis-2@localhost | 
-| --- | 
-| GRANT USAGE ON *.* TO `doc-nis-2`@`localhost` IDENTIFIED BY PASSWORD '*A8B2ACD89C87A533D5077B928E8AF0BC87ED4FF4' | 
-| GRANT SELECT, INSERT, UPDATE, DELETE, EXECUTE ON `doc\_it2\_dev`.* TO `doc-nis-2`@`localhost` | 
-
+<div align="center">
+  <img alt="latest" aria-hidden="" class="project-badge" src="https://gitlab.com/nicole_innovation/doc-nis-2/-/badges/release.svg">
+  <img alt="coverage" aria-hidden="" class="project-badge" src="https://gitlab.com/nicole_innovation/doc-nis-2/badges/master/coverage.svg">
+</div>
+
+# Doc-NIS-2
+
+the [NIS-2 directive](https://eur-lex.europa.eu/EN/legal-content/summary/cybersecurity-of-network-and-information-systems.html) 
+will force thousands of companies accross Europe to become more resillient on cyber threats
+
+For many of those meddium size buisnesses this is both a treat and an opportunity
+* a threat because they are not used to have a proper documentation (if any exists outside of the heads of the people)
+  * creating such a documentation is a real challenge
+  * existing tools are 
+    1) very expensive 
+    2) intended for larger organisations
+    3) have a steep learning curve, needing often a dedicated team
+* an opportunity because eventually not only they will be more resillient, but also will bet a better
+  understanding of their Information System
+
+with that in mind `Doc-NIS-2` is born after beeing fully rewritten from a private tool made during the COVID in order to help
+a company
+
+The main goals of `Doc-NIS-2` are
+* document an Information System
+* document the major processes of a company and describe the applications supporting thoses processes
+* document the risks using [EBOIS](https://cyber.gouv.fr/en/publications/ebios-risk-manager-method)
+* **user friendly**, **minimum of effort** and **collaborative**
+* **open source**
+
+The main principles are
+* every **element** of the system (actors, applications, servers, clouds, processes...) are described in a database
+* every **link** between thoses elements (an application uses another application... ) are also described
+* partial graphs are **automatically** created and represented using [plantuml](https://plantuml.com/). All graphs are enhanced in order to make them interactive.
+* all users can **collaborate** at the same time, each user having rights on each class of element
+
+![](./_front/user-docs/en/screenshots/deployment-edit-element-name.png)
+
+
+
+## installation
+
+the simplified installation is the following
+```plantuml
+@startuml
+actor user
+[browser]
+[doc-nis-2]
+database mariadb
+user --> browser
+[browser] --> [doc-nis-2]
+[doc-nis-2] --> mariadb
+[doc-nis-2] --> [plantuml]
+@enduml
+```
+
+`Doc-NIS-2` is a web application written in [Vue](https://vuejs.org/) for the front and [node](https://nodejs.org/) for the back
+
+It needs a [mariadb](https://mariadb.com/docs) for the database
+
+So it can be deployed easily on Linux or Windows
+
+### install mariadb 
+if needed, [install mariadb](https://mariadb.com/downloads/?utm_source=header&utm_medium=website). the community version is fully ok for this application. It has been tested with `11.8.5` and `10.11.15`
+
+#### create database
+
+create as many database that you need `doc_nis_2_prod` (and if you want a test environnement `doc_nis_2_test`).
+Just create an empty database. The migration system of doc-nis-2 will do the rest
+
+
+#### user for the migrations
+
+In order to create the database (and for future migrations) we need to have a user that has
+higher rights than in production in order to create the schema. This user must at least have
+
+```sql
+SHOW GRANTS FOR 'doc-nis-2-migrate'@'localhost'
+```
+| Grants for doc-nis-2-migrate@localhost | 
+| --- | 
+| GRANT USAGE ON *.* TO `doc-nis-2-migrate`@`localhost` IDENTIFIED BY PASSWORD '*566B7C98855895F9B303B58D292E191D03B8FFF8' | 
+| GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER, EXECUTE, CREATE VIEW, CREATE ROUTINE, ALTER ROUTINE, TRIGGER ON `doc\_it2\_dev`.* TO `doc-nis-2-migrate`@`localhost` | 
+
+#### user for production
+```sql
+SHOW GRANTS FOR 'doc-nis-2'@'localhost'
+
+```
+| Grants for doc-nis-2@localhost | 
+| --- | 
+| GRANT USAGE ON *.* TO `doc-nis-2`@`localhost` IDENTIFIED BY PASSWORD '*A8B2ACD89C87A533D5077B928E8AF0BC87ED4FF4' | 
+| GRANT SELECT, INSERT, UPDATE, DELETE, EXECUTE ON `doc\_it2\_dev`.* TO `doc-nis-2`@`localhost` | 
+
+### install node
+
+we use node `25.8.2` but should be of with node > `20`
+
+### install doc-nis-2
+
+create a new folder where you want doc-nis-2 to be installed
+
+```bash
+npm install doc-nis-2
+```
+
+### create a .env file
+
+the file must be `.env.dev` for the dev environnement (default), `.env.prod` for the prod env etc..
+
+**example of .env.test**
+
+```ini
+# APP
+NODE_ENV = "test" # or "dev" "prod"
+URL = 'http://localhost' # if you are behind a reverse proxy, specify the external URL
+PORT = 4000
+
+PLANTUML_SERVER = 'http://127.0.0.1:8080' # in order to serve the /plantuml route. ideally should be served by the reverse proxy
+
+#CONFIG BDD DOC_IT
+DB_DOC_IT_HOST = "127.0.0.1"
+DB_DOC_IT_USER = "doc-nis-2-migrate"
+DB_DOC_IT_PORT = 3306
+DB_DOC_IT_PASSWORD = "xxxxxx"
+DB_DOC_IT_NAME = "doc_nis_2_test"
+BD_DOC_IT_CONNECTION_LIMIT = 20
+
+# migration system 0=only ckeck; 1=do Migrations if needed
+DO_MIGRATIONS = 1
+
+# CREATION TOKEN
+JWT_SECRET = # PUT HERE your own random value should be at least 32 char long ideally created with a password generator
+JWT_EXPIRES_IN = 86400000
+TWT_PASSWORD_RESET_EXPIRES_IN = 600000 
+
+# MAIL FOR FORGET MY PASSWORD
+ADMIN_MAIL = 
+ADMIN_MAIL_PASSWORD = 
+ADMIN_MAIL_SMTP = 
+ADMIN_MAIL_PORT =
+ADMIN_MAIL_REQUIRE_TLS = 1 # 1= force using TLS  0 by default
+
+# LOGGER
+LOGGER_LEVEL = "debug" # "trace" to track a problem,  "info for production"
+
+# UPLOADS
+UPLOADS = # a path where to store document uploads
+
+# FEATURES
+## ONBOARDING new Users 1=new users can self create an account and a repository
+##                      0=users have to be invited by an existing user that has the rights
+ONBOARDING = 0
+
+## DO_MIGRATIONS = 1 will migrate if needed;  0 = only check if all migrations are done
+DO_MIGRATIONS = 1
+```
+
+at the beginning use the `doc-nis-2-migrate` user as it will have to apply all migrations.
+
+For a demontrator, this is fine to play with that user, but in production this is safer to use
+a more restricted user in order to increase safety.
+
+### install plantuml
+
+doc-nis-2 package comes with the last version that has been tested. It is unsafe to use https://plantuml.com since it can change without notice 
+and doc-nis-2 expect given pattern in order to highlight the graphs.
+
+plantuml needs java, so please [install java](https://www.oracle.com/java/technologies/) first
+
+## lauch
+
+open a first terminal and lauch plantuml
+```bash
+java -DPLANTUML_LIMIT_SIZE=8192 -jar ./node_modules/doc-nis-2/plantuml/plantuml-1.2025.4.jar -picoweb
+```
+
+in a separate terminal, lauch 
+```bash
+NODE_ENV=test npx doc-nis-2
+```
+NODE_ENV=xxx sets the env
+
+
+

package/db-migrations/20240112163555-init-down.sql

@@ -0,0 +1,3 @@
+DROP TABLE `rights`;
+DROP TABLE `users`;
+DROP TABLE `repositories`;

package/db-migrations/20240112163555-init-up.sql

@@ -0,0 +1,47 @@
+/* initial creation of the database */
+
+CREATE TABLE `repositories` (
+  `id` INT(11) NOT NULL AUTO_INCREMENT,
+	`name` VARCHAR(50) NOT NULL,
+	`createdAt` DATETIME NOT NULL DEFAULT NOW(),
+	`updatedAt` DATETIME NOT NULL DEFAULT NOW() ON UPDATE NOW(),
+	`deleted` TINYINT NOT NULL DEFAULT 0,
+	PRIMARY KEY (`id`) USING BTREE,
+  UNIQUE INDEX `name_UNIQUE` (`name`) USING BTREE
+)
+COMMENT='a repository is likely to be a company. An repository is isolated from another repository.\r\nMost tables have a FK on repId. \r\nusers can have rights on multiples repositories'
+COLLATE='utf8_general_ci';
+
+CREATE TABLE `users` (
+	`id` INT(11) NOT NULL AUTO_INCREMENT,
+	`name` VARCHAR(50) NOT NULL,
+	`firstname` VARCHAR(50) NOT NULL,
+	`email` VARCHAR(50) NOT NULL,
+	`password` VARCHAR(200) NOT NULL,
+	`role` VARCHAR(15) NULL DEFAULT NULL,
+	`deleted` TINYINT(1) NULL DEFAULT 0,
+	`createdAt` DATETIME NULL DEFAULT NOW(),
+	`updatedAt` DATETIME NULL DEFAULT NOW() ON UPDATE NOW(),
+	PRIMARY KEY (`id`) USING BTREE,
+	UNIQUE INDEX `email_UNIQUE` (`email`) USING BTREE
+)
+COMMENT='a user should be a real person. He can be either admin or has specific rights'
+COLLATE='utf8mb4_general_ci';
+
+CREATE TABLE `rights` (
+	`id` INT(11) NOT NULL AUTO_INCREMENT,
+	`userId` INT(11) NOT NULL,
+	`repId` INT(11) NOT NULL,
+	`moduleId` INT(11) NOT NULL,
+	`permission` INT(11) NULL DEFAULT NULL,
+	`deleted` TINYINT NOT NULL DEFAULT 0,
+	`createdAt` DATETIME NOT NULL DEFAULT NOW(),
+	`updatedAt` DATETIME NOT NULL DEFAULT NOW() ON UPDATE NOW(),
+	PRIMARY KEY (`id`) USING BTREE,
+	CONSTRAINT `FK_right_user` FOREIGN KEY (`userId`) REFERENCES `users` (`id`),
+	CONSTRAINT `FK_right_env` FOREIGN KEY (`repId`) REFERENCES `repositories` (`id`)
+)
+COMMENT='a right is for a user in a repository, what he can do on a module'
+COLLATE='utf8mb4_general_ci';
+
+

package/db-migrations/20240209172146-elements-links-down.sql

@@ -0,0 +1,3 @@
+DROP TABLE `links`;
+DROP TABLE `elements`;
+DROP TABLE `layers`;

package/db-migrations/20240209172146-elements-links-up.sql

@@ -0,0 +1,65 @@
+
+CREATE TABLE `layers` (
+	`id` INT NOT NULL AUTO_INCREMENT,
+	`name` VARCHAR(255) NOT NULL,
+	`repId` INT NULL DEFAULT NULL,
+	`color` VARCHAR(20) NOT NULL,
+	`mdDescription` MEDIUMTEXT NOT NULL DEFAULT '',
+	`fields` JSON NULL DEFAULT NULL,
+	`deleted` TINYINT NOT NULL DEFAULT 0,
+	`createdAt` DATETIME NOT NULL DEFAULT current_timestamp(),
+	`updatedAt` DATETIME NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp(),
+  PRIMARY KEY (`id`) USING BTREE,
+  INDEX `FK_layer_rep` (`repId`) USING BTREE,
+  CONSTRAINT `FK_layer_rep` FOREIGN KEY (`repId`) REFERENCES `repositories` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT
+)
+COLLATE='utf8_general_ci'
+;
+
+
+CREATE TABLE `elements` (
+	`id` INT NOT NULL AUTO_INCREMENT,
+	`name` VARCHAR(255) NOT NULL DEFAULT '',
+	`repId` INT NULL DEFAULT NULL,
+	`layerId` INT NULL DEFAULT NULL,
+	`className` VARCHAR(20) NOT NULL,
+	`mdDescription` MEDIUMTEXT NOT NULL DEFAULT '',
+	`fields` JSON NULL DEFAULT NULL,
+	`deleted` TINYINT NOT NULL DEFAULT 0,
+ 	`createdAt` DATETIME NOT NULL DEFAULT current_timestamp(),
+	`updatedAt` DATETIME NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp(),
+  PRIMARY KEY (`id`) USING BTREE,
+  INDEX `FK_element_rep` (`repId`) USING BTREE,
+  CONSTRAINT `FK_element_rep` FOREIGN KEY (`repId`) REFERENCES `repositories` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT,
+
+  INDEX `FK_element_layer` (`layerId`) USING BTREE,
+  CONSTRAINT `FK_element_layer` FOREIGN KEY (`layerId`) REFERENCES .`layers` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT
+)
+COLLATE='utf8_general_ci'
+;
+
+CREATE TABLE `links` (
+	`id` INT NOT NULL AUTO_INCREMENT,
+	`name` VARCHAR(255) NOT NULL DEFAULT '',
+  `sourceId` INT NOT NULL,
+  `destId` INT NOT NULL,
+	`repId` INT NULL DEFAULT NULL,
+	`className` VARCHAR(20) NOT NULL,
+	`mdDescription` MEDIUMTEXT NOT NULL DEFAULT '',
+	`fields` JSON NULL DEFAULT NULL,
+  `dir` TINYINT NOT NULL DEFAULT 0,
+	`deleted` TINYINT NOT NULL DEFAULT 0,
+ 	`createdAt` DATETIME NOT NULL DEFAULT current_timestamp(),
+	`updatedAt` DATETIME NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp(),
+  PRIMARY KEY (`id`) USING BTREE,
+  INDEX `FK_link_rep` (`repId`) USING BTREE,
+  CONSTRAINT `FK_link_rep` FOREIGN KEY (`repId`) REFERENCES `repositories` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT,
+
+  INDEX `FK_source_element` (`sourceId`) USING BTREE,
+  CONSTRAINT `FK_source_element` FOREIGN KEY (`sourceId`) REFERENCES `elements` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT,
+
+  INDEX `FK_dest_element` (`destId`) USING BTREE,
+  CONSTRAINT `FK_dest_element` FOREIGN KEY (`destId`) REFERENCES `elements` (`id`) ON UPDATE RESTRICT ON DELETE RESTRICT
+)
+COLLATE='utf8_general_ci'
+;

package/db-migrations/20240220215714-createElement-down.sql

@@ -0,0 +1 @@
+DROP PROCEDURE `createElement`

package/db-migrations/20240220215714-createElement-up.sql

@@ -0,0 +1,19 @@
+CREATE PROCEDURE `createElement`(
+	IN `p_name` VARCHAR(255),
+	IN `p_repId` INT,
+	IN `p_layerId` INT,
+	IN `p_className` VARCHAR(20),
+	IN `p_mdDescription` MEDIUMTEXT,
+	IN `p_fields` JSON
+)
+LANGUAGE SQL
+NOT DETERMINISTIC
+CONTAINS SQL
+SQL SECURITY DEFINER
+COMMENT ''
+BEGIN
+  INSERT INTO elements
+    (`name`,`repId`,`layerId`,`className`,`mdDescription`,`fields`) VALUES
+    (p_name,p_repId,p_layerId,p_className,p_mdDescription,p_fields);
+  SELECT * FROM elements WHERE id = LAST_INSERT_ID();
+END

package/db-migrations/20240221194852-createLink-down.sql

@@ -0,0 +1 @@
+DROP PROCEDURE createLink

package/db-migrations/20240221194852-createLink-up.sql

@@ -0,0 +1,21 @@
+CREATE PROCEDURE `createLink`(
+  IN `p_name` VARCHAR(255),
+  IN `p_sourceId` INT,
+  IN `p_destId` INT,
+  IN `p_repId` INT,
+  IN `p_className` VARCHAR(20),
+  IN `p_mdDescription` MEDIUMTEXT,
+  IN `p_fields` JSON,
+  IN `p_dir` TINYINT
+)
+LANGUAGE SQL
+NOT DETERMINISTIC
+CONTAINS SQL
+SQL SECURITY DEFINER
+COMMENT ''
+BEGIN
+  INSERT INTO links
+    (`name`,`sourceId`,`destId`,`repId`,`className`,`mdDescription`,`fields`,`dir`) VALUES
+    (p_name,p_sourceId,p_destId,p_repId,p_className,p_mdDescription,p_fields,p_dir);
+  SELECT * FROM links WHERE id = LAST_INSERT_ID();
+END

package/db-migrations/20240223180214-getUpdatedData-down.sql

@@ -0,0 +1 @@
+DROP PROCEDURE `getUpdatedData`;

package/db-migrations/20240223180214-getUpdatedData-up.sql

@@ -0,0 +1,17 @@
+CREATE PROCEDURE `getUpdatedData`(
+	IN `p_repId` INT,
+	IN `p_since` DATETIME
+)
+LANGUAGE SQL
+NOT DETERMINISTIC
+CONTAINS SQL
+SQL SECURITY DEFINER
+COMMENT ''
+BEGIN
+  DECLARE lastUpdate DATETIME DEFAULT NOW();
+  SELECT lastUpdate;
+  SELECT * FROM repositories WHERE id = p_repId;
+  SELECT * FROM elements WHERE repId = p_repId AND updatedAt BETWEEN p_since AND lastUpdate;
+  SELECT * FROM links WHERE repId = p_repId AND updatedAt BETWEEN p_since AND lastUpdate;
+  SELECT * FROM layers WHERE repId = p_repId AND updatedAt BETWEEN p_since AND lastUpdate;
+END

package/db-migrations/20240307182656-createLayer-down.sql

@@ -0,0 +1 @@
+DROP PROCEDURE createLayer;

package/db-migrations/20240307182656-createLayer-up.sql

@@ -0,0 +1,18 @@
+CREATE PROCEDURE `createLayer`(
+	IN `p_name` VARCHAR(255),
+	IN `p_repId` INT,
+	IN `p_color` VARCHAR(20),
+	IN `p_mdDescription` MEDIUMTEXT,
+	IN `p_fields` JSON
+)
+LANGUAGE SQL
+NOT DETERMINISTIC
+CONTAINS SQL
+SQL SECURITY DEFINER
+COMMENT 'create a new layer and return it as result'
+BEGIN
+  INSERT INTO layers
+    (`name`,`repId`,`color`,`mdDescription`) VALUES
+    (p_name,p_repId,p_color,p_mdDescription);
+  SELECT * FROM layers WHERE id = LAST_INSERT_ID();
+END

package/db-migrations/20240426171507-inviteUser-down.sql

@@ -0,0 +1 @@
+DROP PROCEDURE `inviteUser`

package/db-migrations/20240426171507-inviteUser-up.sql

@@ -0,0 +1,33 @@
+CREATE PROCEDURE `inviteUser`(
+	IN `p_email` VARCHAR(255),
+	IN `p_repId` INT
+)
+LANGUAGE SQL
+NOT DETERMINISTIC
+CONTAINS SQL
+SQL SECURITY DEFINER
+COMMENT 'invite a user to a repository (and create it if the email is not existing); set a read right to the repository'
+
+
+BEGIN
+  DECLARE v_userId INT DEFAULT 0;
+  DECLARE v_rightId INT DEFAULT 0;
+  DECLARE v_permission INT DEFAULT 0;
+
+  SELECT id INTO v_userId FROM users WHERE email = p_email;
+  IF v_userId = 0 THEN
+    INSERT INTO users
+      (`name`,`firstname`,`email`,`password`,                  `role`) VALUES
+      ('',    '',         p_email,' Password not initialized ','user'); -- password is unvalid since not 60 chars ==> no password can match this "hash"
+    SET v_userId = LAST_INSERT_ID();
+  END IF;
+
+  -- look for existing right for REPOSITORY
+  SELECT id INTO v_rightId FROM rights WHERE userId = v_userId AND repId = p_repId AND moduleId = 2;
+
+  IF v_rightId = 0 THEN
+    INSERT INTO rights (userId,repId,moduleId,permission) VALUES (v_userId,p_repId,2,1);  -- read permission
+  END IF;
+
+  SELECT `id`,`name`,`firstname`,`email`,`role`,`deleted`,`createdAt`,`updatedAt` FROM users WHERE id = v_userId;
+END

package/db-migrations/20240429075201-createRight-down.sql

@@ -0,0 +1 @@
+DROP PROCEDURE `createRight`;

package/db-migrations/20240429075201-createRight-up.sql

@@ -0,0 +1,18 @@
+CREATE PROCEDURE `createRight`(
+  IN `p_userId` INT,
+	IN `p_repId` INT,
+  IN `p_moduleId` INT,
+  IN `p_permission` INT
+)
+LANGUAGE SQL
+NOT DETERMINISTIC
+CONTAINS SQL
+SQL SECURITY DEFINER
+COMMENT 'create a new right and return it as result'
+BEGIN
+  INSERT INTO rights
+    (userId,repId,moduleId,permission)
+     VALUES
+    (p_userId,p_repId,p_moduleId,p_permission);
+  SELECT * FROM rights WHERE id = LAST_INSERT_ID();
+END

package/db-migrations/20240704195520-history-down.sql

@@ -0,0 +1 @@
+DROP TABLE history;

package/db-migrations/20240704195520-history-up.sql

@@ -0,0 +1,30 @@
+CREATE TABLE `history` (
+	`id` INT NOT NULL AUTO_INCREMENT,
+	`createdAt` DATETIME NOT NULL DEFAULT NOW(),
+	`updatedAt` DATETIME NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp(),
+	`userId` INT NOT NULL,
+	`operation` INT NOT NULL COMMENT '0=update element 1=comment element 100=update link ',
+	`data` JSON NULL DEFAULT NULL,
+	`repId` INT AS (JSON_VALUE(`data`,'$.repId')) VIRTUAL,
+	`elementId` INT AS (CASE  WHEN `operation` <100 THEN JSON_VALUE(`data`,'$.id') ELSE NULL END) VIRTUAL,
+	`linkId` INT AS (CASE `operation` WHEN 100 THEN JSON_VALUE(`data`,'$.id') ELSE NULL END) VIRTUAL,
+	`sourceId` INT AS (JSON_VALUE(`data`,'$.sourceId')) VIRTUAL,
+	`destId` INT AS (JSON_VALUE(`data`,'$.destId')) VIRTUAL,
+	PRIMARY KEY (`id`),
+	INDEX `IDX_createdAt` (`createdAt`),
+	CONSTRAINT `FK__users` FOREIGN KEY (`userId`) REFERENCES `users` (`id`),
+	CONSTRAINT `FK__elements` FOREIGN KEY (`elementId`) REFERENCES `elements` (`id`),
+	CONSTRAINT `FK__sourceId` FOREIGN KEY (`sourceId`) REFERENCES `elements` (`id`),
+	CONSTRAINT `FK__destId` FOREIGN KEY (`destId`) REFERENCES `elements` (`id`),
+	CONSTRAINT `FK__links` FOREIGN KEY (`linkId`) REFERENCES `links` (`id`)
+)
+COLLATE='utf8_general_ci'
+;
+
+INSERT INTO history (userId,operation,`data`)
+SELECT 1,0,json_object("id",id,"name",`name`,"repId",repId,"layerId",layerId,"className",className,"mdDescription",mdDescription,"fields",fields,"deleted",deleted,"createdAt",createdAt,"updatedAt",updatedAt)
+FROM elements;
+
+INSERT INTO history (userId,operation,`data`)
+SELECT 1,100,json_object("id",id,"name",`name`,"repId",repId,"sourceId",sourceId,"destId",destId,"className",className,"mdDescription",mdDescription,"fields",fields,"deleted",deleted,"createdAt",createdAt,"updatedAt",updatedAt)
+FROM links;

package/db-migrations/20240731182807-fix-repository-update-down.sql

@@ -0,0 +1 @@
+/* Replace with your SQL commands */

package/db-migrations/20240731182807-fix-repository-update-up.sql

@@ -0,0 +1,26 @@
+ALTER TABLE `elements`
+	CHANGE COLUMN `updatedAt` `updatedAt` DATETIME(3) NOT NULL DEFAULT current_timestamp(3) ON UPDATE current_timestamp(3) AFTER `createdAt`;
+
+ALTER TABLE `links`
+	CHANGE COLUMN `updatedAt` `updatedAt` DATETIME(3) NOT NULL DEFAULT current_timestamp(3) ON UPDATE current_timestamp(3) AFTER `createdAt`;
+
+ALTER TABLE `layers`
+	CHANGE COLUMN `updatedAt` `updatedAt` DATETIME(3) NOT NULL DEFAULT current_timestamp(3) ON UPDATE current_timestamp(3) AFTER `createdAt`;
+
+CREATE OR REPLACE PROCEDURE `getUpdatedData`(
+	IN `p_repId` INT,
+	IN `p_since` DATETIME(3)
+)
+LANGUAGE SQL
+NOT DETERMINISTIC
+CONTAINS SQL
+SQL SECURITY DEFINER
+COMMENT ''
+BEGIN
+  DECLARE lastUpdate DATETIME(3) DEFAULT NOW(3);
+  SELECT lastUpdate;
+  SELECT * FROM repositories WHERE id = p_repId;
+  SELECT * FROM elements WHERE repId = p_repId AND updatedAt > p_since;
+  SELECT * FROM links WHERE repId = p_repId AND updatedAt > p_since;
+  SELECT * FROM layers WHERE repId = p_repId AND updatedAt > p_since;
+END

package/db-migrations/20240808163906-repository-config-down.sql

@@ -0,0 +1 @@
+/* Replace with your SQL commands */

package/db-migrations/20240808163906-repository-config-up.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `repositories`
+	ADD COLUMN `config` JSON NOT NULL DEFAULT '{}' AFTER `deleted`;