rapida-partner 1.0.0

package/src/schemas/list.ref.json

@@ -0,0 +1,196 @@
+{
+  "$id": "list.ref.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "componentType": {
+      "const": "list"
+    },
+    "id": {
+      "type": "string",
+      "description": "Named according to component file name (<id>.<componentType>.ts)"
+    },
+    "title": {
+      "type": "string"
+    },
+    "guards": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "dataSource": {
+      "$ref": "form-common-api-request.ref.json"
+    },
+    "userStory": {
+      "type": "string"
+    },
+    "businessRules": {
+      "$ref": "business-rules.ref.json"
+    },
+    "properties": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "property": {
+            "type": "string",
+            "description": "Property name in the response object. e.g.: 'email'"
+          },
+          "label": {
+            "type": "string",
+            "description": "Label to property. e.g.: 'E-mail'"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "title",
+              "subtitle",
+              "description",
+              "video",
+              "image",
+              "images",
+              "icon"
+            ]
+          },
+          "isHtml": {
+            "type": "boolean"
+          },
+          "isLink": {
+            "type": "boolean"
+          },
+          "isTimestamp": {
+            "type": "boolean"
+          },
+          "callToAction": {
+            "type": "object",
+            "properties": {
+              "link": {
+                "type": "string",
+                "description": "e.g.: '/user'"
+              },
+              "usePropertyAsQuery": {
+                "type": "boolean",
+                "description": "if true then '/user/<email>'"
+              }
+            },
+            "required": ["link"]
+          }
+        },
+        "required": ["property"]
+      }
+    },
+    "cardAsALink": {
+      "type": "object",
+      "properties": {
+        "link": {
+          "type": "string",
+          "description": "e.g.: '/user'"
+        },
+        "propertiesAsQueryParam": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "if, for example, ['_id', 'email'], then '/user?_id=value&email=value'"
+        },
+        "propertiesAsPathParam": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "if, for example, ['_id', 'email'], then '/user/<_id>/<email>'"
+        }
+      },
+      "required": ["link"]
+    },
+    "callsToActionMenu": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "icon": {
+            "type": "string",
+            "description": "Material icons e.g: 'pencil'"
+          },
+          "label": {
+            "type": "string",
+            "description": "e.g: 'Editar'"
+          },
+          "action": {
+            "type": "object",
+            "properties": {
+              "link": {
+                "type": "object",
+                "properties": {
+                  "endpoint": {
+                    "type": "string",
+                    "description": "e.g.: '/user'"
+                  },
+                  "propertiesAsQueryParam": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "if, for example, ['_id', 'email'], then '/user?_id=value&email=value'"
+                  },
+                  "propertiesAsPathParam": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "if, for example, ['_id', 'email'], then '/user/<_id>/<email>'"
+                  }
+                },
+                "required": ["endpoint"]
+              },
+              "request": {
+                "type": "object",
+                "properties": {
+                  "endpoint": {
+                    "type": "string",
+                    "description": "e.g.: '/user'"
+                  },
+                  "propertiesAsQueryParam": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "if, for example, ['_id', 'email'], then '/user?_id=value&email=value'"
+                  },
+                  "propertiesAsPathParam": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "if, for example, ['_id', 'email'], then '/user/<_id>/<email>'"
+                  },
+                  "verb": {
+                    "type": "string",
+                    "enum": ["get", "post", "put", "delete"]
+                  },
+                  "dialog": {
+                    "type": "object",
+                    "properties": {
+                      "title": {
+                        "type": "string"
+                      },
+                      "message": {
+                        "type": "string"
+                      }
+                    },
+                    "required": ["title", "message"]
+                  }
+                },
+                "required": ["endpoint", "verb"]
+              }
+            },
+            "required": ["link"]
+          }
+        },
+        "required": ["icon", "label", "action"]
+      }
+    }
+  },
+  "required": ["componentType", "id", "title", "dataSource", "properties"]
+}

package/src/schemas/module.ref.json

@@ -0,0 +1,39 @@
+{
+  "$id": "module.ref.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "properties": {
+      "id": { "type": "string" },
+      "title": { "type": "string" },
+      "icon": { "type": "string" },
+      "components": {
+        "type": "array",
+        "items": {
+          "oneOf": [
+            { "$ref": "form.ref.json" },
+            { "$ref": "list.ref.json" },
+            { "$ref": "data-table.ref.json" },
+            { "$ref": "data-card.ref.json" },
+            { "$ref": "data-grid.ref.json" },
+            { "$ref": "data-detail.ref.json" },
+            { "$ref": "data-chart.ref.json" },
+            { "$ref": "dashboard.ref.json" },
+            { "$ref": "panel.ref.json" }
+          ]
+        }
+      },
+      "businessRules": {
+        "$ref": "business-rules.ref.json"
+      },
+      "todo": {
+        "type": "array",
+        "items": {
+          "$ref": "todo.ref.json"
+        }
+      }
+    },
+    "required": ["id", "title", "icon", "components"]
+  }
+}

package/src/schemas/panel.ref.json

@@ -0,0 +1,127 @@
+{
+  "$id": "panel.ref.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "componentType": { "const": "panel" },
+    "id": { "type": "string" },
+    "title": { "type": "string" },
+    "subtitle": { "type": "string" },
+    "icon": { "type": "string" },
+    "collapsible": { "type": "boolean" },
+    "collapsed": { "type": "boolean" },
+    "userStory": { "type": "string" },
+    "headerActions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "icon": { "type": "string" },
+          "label": { "type": "string" },
+          "action": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": ["link", "request", "event"]
+              },
+              "link": {
+                "type": "object",
+                "properties": {
+                  "route": { "type": "string" }
+                },
+                "required": ["route"]
+              },
+              "request": {
+                "type": "object",
+                "properties": {
+                  "endpoint": { "type": "string" },
+                  "method": {
+                    "type": "string",
+                    "enum": ["GET", "POST", "PUT", "DELETE"]
+                  }
+                },
+                "required": ["endpoint", "method"]
+              },
+              "event": {
+                "type": "object",
+                "properties": {
+                  "name": { "type": "string" },
+                  "data": {}
+                },
+                "required": ["name"]
+              }
+            },
+            "required": ["type"]
+          }
+        },
+        "required": ["action"]
+      }
+    },
+    "content": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["component", "html", "markdown"]
+        },
+        "component": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": ["dataTable", "dataGrid", "dataCard", "dataChart", "form"]
+            },
+            "config": {}
+          },
+          "required": ["type", "config"]
+        },
+        "html": { "type": "string" },
+        "markdown": { "type": "string" }
+      },
+      "required": ["type"],
+      "allOf": [
+        {
+          "if": {
+            "properties": { "type": { "const": "component" } }
+          },
+          "then": {
+            "required": ["component"]
+          }
+        },
+        {
+          "if": {
+            "properties": { "type": { "const": "html" } }
+          },
+          "then": {
+            "required": ["html"]
+          }
+        },
+        {
+          "if": {
+            "properties": { "type": { "const": "markdown" } }
+          },
+          "then": {
+            "required": ["markdown"]
+          }
+        }
+      ]
+    },
+    "styling": {
+      "type": "object",
+      "properties": {
+        "variant": {
+          "type": "string",
+          "enum": ["default", "outlined", "elevated", "flat"]
+        },
+        "padding": {
+          "type": "string",
+          "enum": ["none", "small", "medium", "large"]
+        },
+        "maxHeight": { "type": "string" },
+        "scrollable": { "type": "boolean" }
+      }
+    }
+  },
+  "required": ["componentType", "id", "content"]
+}

package/src/schemas/project.schema.json

@@ -0,0 +1,39 @@
+{
+  "$id": "project.schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "title": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "flow": {
+      "type": "string",
+      "enum": ["autentikigo", "invito", "permeson", "komerco", "labotablo", "reto"]
+    },
+    "businessPlan": {
+      "$ref": "business-plan.ref.json"
+    },
+    "businessRules": {
+      "$ref": "business-rules.ref.json"
+    },
+    "frontend": {
+      "$ref": "frontend.ref.json"
+    },
+    "backend": {
+      "$ref": "backend.ref.json"
+    },
+    "externalApplications": {
+      "$ref": "external-application.ref.json"
+    },
+    "modules": {
+      "$ref": "module.ref.json"
+    }
+  },
+  "required": ["id", "title", "description"]
+}

package/src/schemas/todo.ref.json

@@ -0,0 +1,10 @@
+{
+  "$id": "todo.ref.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "title": { "type": "string" },
+    "description": { "type": "string" }
+  },
+  "required": ["title", "description"]
+}

package/src/utils/email.ts

@@ -0,0 +1,56 @@
+import nodemailer from 'nodemailer';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+interface IEmail {
+    mailer: "smtp";
+    host?: string;
+    service?: string;
+    port: number;
+    username: string;
+    password: string;
+    encryption: "tls";
+    from: string;
+    to: string;
+    subject: string;
+    content: {
+        type: "text" | "html";
+        content: string;
+    }
+}
+
+const sendEmailWithNodemailer = (email: IEmail) => {
+    const transporter = nodemailer.createTransport({
+        service: email.service,
+        auth: {
+            user: email.username,
+            pass: email.password,
+        },
+        port: email.port,
+        secure: email.port === 465, // true for 465, false for other ports
+    });
+
+    const mailOptions = {
+        from: email.from,
+        to: email.to,
+        subject: email.subject,
+        ...(email.content.type === "text" && { text: email.content.content }),
+        ...(email.content.type === "html" && { html: email.content.content }),
+    };
+
+    transporter.sendMail(mailOptions, (error, info) => {
+        if (error) {
+            return console.error(error);
+        }
+        console.info('Email enviado: ' + (info as nodemailer.SentMessageInfo).response);
+    });
+};
+
+export {
+    sendEmailWithNodemailer
+}
+
+export type {
+    IEmail
+}

package/src/utils/env.ts

@@ -0,0 +1,9 @@
+import dotenv from 'dotenv';
+dotenv.config();
+
+const rootPath = process.env.ROOT_PATH;
+const terminalPassword = process.env.TERMINAL_PASSWORD;
+const trelloApiKey = process.env.TRELLO_API_KEY;
+const trelloToken = process.env.TRELLO_TOKEN;
+
+export { rootPath, terminalPassword, trelloApiKey, trelloToken };

package/src/utils/file.ts

@@ -0,0 +1,139 @@
+import chp from "child_process";
+import fs from "fs";
+
+/**
+ * Writes the content of a string to a file, overwriting the file if it already exists.
+ *
+ * @param {string} stringToFile - The string content to be written to the file.
+ * @param {string} filePath - The path of the file to be written.
+ */
+export const writeFile = (stringToFile: string, filePath: string) => {
+  try {
+    fs.rmSync(filePath);
+    fs.writeFileSync(filePath, stringToFile);
+  } catch (error) {
+    fs.writeFileSync(filePath, stringToFile);
+  }
+};
+
+/**
+ * Downloads a file from the specified URL to the provided folder path.
+ *
+ * @param {string} url - The URL of the file to be downloaded.
+ * @param {string} folderPath - The destination folder path where the downloaded file will be saved.
+ * @returns {*} - The result of the download operation.
+ */
+export const download = (url: string, folderPath: string) => {
+  try {
+    const result = chp.execSync(`wget ${url}`, { cwd: folderPath });
+    return result;
+  } catch (error) {
+    console.error(error);
+  }
+};
+
+/**
+ * Modifies the contents of a specified file by adding a string at a specified place.
+ *
+ * @param {string} stringToAdd - The string to be added to the file.
+ * @param {string} filePath - The path to the file that is to be modified.
+ * @param {string} placeToAddString - A substring after which `stringToAdd` will be added. 
+ *                                    The function inserts `stringToAdd` immediately after the first occurrence of this substring.
+ * @returns {void}
+ * 
+ * This function reads the content of the file located at `filePath`. If the file does not already contain `stringToAdd`,
+ * it will insert `stringToAdd` immediately after the first occurrence of `placeToAddString`. If `stringToAdd` already exists
+ * in the file, the function logs a message indicating this and does not modify the file.
+ * 
+ * @example
+ * // To add a new import statement in a JavaScript file
+ * addStringToFile("import newModule from 'new-module';\n", './path/to/file.js', "// Import statements\n");
+ */
+export const addStringToFile = (stringToAdd: string, filePath: string, placeToAddString: string) => {
+  try {
+    const fileContent = fs.readFileSync(filePath).toString();
+    const fileContentToCompare = fileContent.replace(/[\r\n\s]+/g, ' ').trim();
+    const stringToAddToCompare = stringToAdd.replace(/[\r\n\s]+/g, ' ').trim();
+
+    if (!fileContentToCompare.includes(stringToAddToCompare)) {
+      console.info(`Adding code to ${filePath}.`);
+      const fileChanged = fileContent.replace(placeToAddString, `${placeToAddString}${stringToAdd}`);
+      writeFile(fileChanged, filePath);
+    } else {
+      console.info(`Code that would be added already exists in ${filePath}`);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+};
+
+export const addStringToFileForced = (stringToAdd: string, filePath: string, placeToAddString: string) => {
+  try {
+    const fileContent = fs.readFileSync(filePath).toString();
+
+    console.info(`Adding code to ${filePath}.`);
+    const fileChanged = fileContent.replace(placeToAddString, `${placeToAddString}${stringToAdd}`);
+    writeFile(fileChanged, filePath);
+  } catch (error) {
+    console.error(error);
+  }
+};
+
+/**
+ * Reads a file from the specified file path, checks if the specified string to be changed exists in the file,
+ * and replaces it with the new string if it exists. If the string to be changed does not exist in the file,
+ * it logs a message indicating that the change was not made.
+ *
+ * @param {string} stringToChange - The string to replace the existing string with.
+ * @param {string} filePath - The path to the file to be modified.
+ * @param {string} stringToBeChanged - The string to be replaced.
+ */
+export const replaceStringInFile = (stringToChange: string, filePath: string, stringToBeChanged: string) => {
+  try {
+    const fileContent = fs.readFileSync(filePath).toString();
+    const fileContentToCompare = fileContent.replace(/[\r\n\s]+/g, ' ').trim();
+    const stringToChangeToCompare = stringToChange.replace(/[\r\n\s]+/g, ' ').trim();
+
+    if (!fileContentToCompare.includes(stringToChangeToCompare)) {
+      console.info(`Changing code in ${filePath}.`);
+      const fileChanged = fileContent.replace(stringToBeChanged.replace(/[\r\n\s]+/g, ' ').trim(), `${stringToChange}`);
+
+      writeFile(fileChanged, filePath);
+    } else {
+      console.info(`Code that would be changed already exists in ${filePath}`);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+};
+
+export const replaceStringInFileForced = (stringToChange: string, filePath: string, stringToBeChanged: string) => {
+  try {
+    const fileContent = fs.readFileSync(filePath).toString();
+    const fileContentToCompare = fileContent.replace(/[\r\n\s]+/g, ' ').trim();
+    const stringToChangeToCompare = stringToChange.replace(/[\r\n\s]+/g, ' ').trim();
+
+    if (!fileContentToCompare.includes(stringToChangeToCompare) || stringToChange === "") {
+      console.info(`Changing code in ${filePath}.`);
+      const fileChanged = fileContent.replace(stringToBeChanged.replace(/[\r\n\s]+/g, ' ').trim(), `${stringToChange}`);
+      writeFile(fileChanged, filePath);
+    } else {
+      console.info(`Code that would be changed already exists in ${filePath}`);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+};
+
+export const removeStringInFile = (stringToBeRemoved: string, filePath: string) => {
+  try {
+    const fileContent = fs.readFileSync(filePath).toString();
+
+    console.info(`Removing code from ${filePath}.`);
+    const fileChanged = fileContent.replace(stringToBeRemoved, "");
+    writeFile(fileChanged, filePath);
+
+  } catch (error) {
+    console.error(error);
+  }
+};