rapida-partner 1.10.0 → 1.11.0

package/src/examples/components/forms/test.form.ts

@@ -1,37 +1,37 @@
 import { EDataType } from "../../../enums/form.enum";
 import type { IForm } from "../../../interfaces/form.interface";
 
-export const characterForm: IForm = {
-  title: "Título do Formulário",
+export const testForm: IForm = {
+  title: "Formulário teste",
   componentType: "form",
-  id: "formTitleForm", // nome da "id" em camelCase(apenas letras("title" do form em inglês + Sufixo correspondente ao "componentType")) = setToCamelCase(alphabetOnly(translateToEnglish({title}) + {componentType}))
+  id: "testFormForm",
   guards: "isAuthorized",
   elements: [
     {
-      id: "formTitleTab", // nome da "id" em camelCase(apenas letras("title" do form em inglês + Sufixo "tab")) = setToCamelCase(alphabetOnly(translateToEnglish({title}) + "Tab"))
+      id: "testFormTab",
       type: "tab",
       tabs: [
         {
-          title: "Tab title 1",
-          id: "tabTitleOneTab", //nome da "id" em camelCase(apenas letras("title" da tab em inglês + Sufixo "tab")) = setToCamelCase(alphabetOnly(translateToEnglish({title}) + "Tab"))
+          title: "Dados principais",
+          id: "mainDataTab",
           elements: [
             {
-              label: "Rótulo do input",
-              name: "inputLabel", // nome do "name" em camelCase(apenas letras("label" do "element" (input) em inglês)) = setToCamelCase(alphabetOnly(translateToEnglish({label})))
+              label: "Nome",
+              name: "name",
               type: "input",
               dataType: EDataType.TEXT,
             },
             {
-              title: "Título do fieldset",
-              id: "fieldsetTitleFieldset", // nome da "id" em camelCase(apenas letras("title" do "element" (fieldset) em inglês + Sufixo "fieldset")) = setToCamelCase(alphabetOnly(translateToEnglish({title}) + "Fieldset"))
+              title: "Coisa aleatória",
+              id: "randomThingFieldset",
               type: "fieldset",
               elements: [
                 {
-                  label: "Rótulo do select*",
-                  name: "selectLabel", // nome do "name" em camelCase(apenas letras("label" do "element" (select) em inglês)) = setToCamelCase(alphabetOnly(translateToEnglish({label})))
+                  label: "Qualquer coisa*",
+                  name: "anything",
                   type: "select",
                   dataType: EDataType.TEXT,
-                  isRequired: true, // Se tiver "*" ao final do "label" = isRequired: true
+                  isRequired: true,
                   options: [
                     { label: "Rótulo para a opção 1", value: "optionOneLabel" },
                     { label: "Rótulo para a opção 2", value: "optionTwoLabel" },
@@ -39,8 +39,8 @@ export const characterForm: IForm = {
                   ],
                 },
                 {
-                  label: "Rótulo do select múltiplo*",
-                  name: "multipleSelectLabel",
+                  label: "Outras coisas para escolher*",
+                  name: "otherThingsToChoose",
                   type: "select",
                   dataType: EDataType.TEXT,
                   isRequired: true,
@@ -52,8 +52,8 @@ export const characterForm: IForm = {
                   ],
                 },
                 {
-                  label: "Rótulo do autocomplete*",
-                  name: "autocompleteLabelId", // nome do "name" em camelCase(apenas letras("label" do "element" (autocomplete) em inglês + Sufixo "id")) = setToCamelCase(alphabetOnly(translateToEnglish({title}) + {componentType}))
+                  label: "Uma terceira coisa*",
+                  name: "aThirdThingId",
                   type: "autocomplete",
                   dataType: EDataType.TEXT,
                   isRequired: true,
@@ -62,11 +62,11 @@ export const characterForm: IForm = {
                     // leave it blank so documenter will be forced to check it
                   },
                 },
-              ]    
+              ],
             },
             {
-              label: "Rótulo do autocomplete múltiplo",
-              name: "multipleAutocompleteLabelId",
+              label: "Hobbies",
+              name: "hobbiesId",
               type: "autocomplete",
               dataType: EDataType.TEXT,
               isMultiple: true,
@@ -78,25 +78,25 @@ export const characterForm: IForm = {
           ],
         },
         {
-          title: "Tab title 2",
-          id: "tabTitleTwoTab",
+          title: "Dados secundários",
+          id: "secondaryDataTab",
           elements: [
             {
-              label: "Rótulo do input de data*",
-              name: "dateInputLabel",
+              label: "Data de nascimento*",
+              name: "dateOfBirth",
               type: "input",
               dataType: EDataType.DATE,
               isRequired: true,
             },
             {
-              title: "Adicionar array",
-              name: "addArrayArray",              
-              type: EDataType.ARRAY,
+              label: "Adicionar mais coisas",
+              name: "addMoreThingsArray",
+              type: "array",
               elements: [
                 {
                   label: "Rótulo de input de arquivo",
                   name: "fileInputLabelUrl",
-                  type: "file", // nome do "name" em camelCase(apenas letras("label" do "element" (file) em inglês) + sufixo "url") = setToCamelCase(alphabetOnly(translateToEnglish({label}) + "Url"))
+                  type: "file",
                   dataType: EDataType.TEXT,
                   storageConfig: {
                     fileNameStrategy: "uuid",
@@ -109,18 +109,17 @@ export const characterForm: IForm = {
                   type: "input",
                   dataType: EDataType.PASSWORD,
                 },
-            
                 {
                   label: "Rótulo de input de número",
                   name: "numberInputLabel",
                   type: "input",
                   dataType: EDataType.NUMBER,
                 },
-              ]
+              ],
             },
           ],
         },
-      ]
+      ],
     },
   ],
 };

package/src/examples/components/lists/character.list.ts

@@ -11,7 +11,7 @@ export const characterList: IList = {
     paramType: "query",
     hasAuthentication: true,
   },
-  properties: [
+  listItems: [
     { label: "Nome", property: "characterName", type: "title", dataType: EDataType.NVARCHAR },
     { label: "Descrição", property: "characterDescription", type: "description", isHtml: true, dataType: EDataType.LONGTEXT },
   ],

package/src/examples/components/lists/movie.list.ts

@@ -11,7 +11,7 @@ export const movieList: IList = {
     paramType: "query",
     hasAuthentication: true,
   },
-  properties: [
+  listItems: [
     {
       property: "pictureFile", type: "image", label: "Cartaz", dataType: EDataType.NVARCHAR,
     },

package/src/examples/components/lists/movieEpisode.list.ts

@@ -11,7 +11,7 @@ export const movieEpisodeList: IList = {
     paramType: "query",
     hasAuthentication: true,
   },
-  properties: [
+  listItems: [
     {
       property: "episodeTitle", type: "title", label: "Título", dataType: EDataType.NVARCHAR,
     },

package/src/examples/components/lists/movieGenre.list.ts

@@ -11,7 +11,7 @@ export const movieGenreList: IList = {
     paramType: "query",
     hasAuthentication: true,
   },
-  properties: [
+  listItems: [
     {
       property: "name", type: "title", label: "Nome", dataType: EDataType.NVARCHAR,
     },

package/src/examples/modules/movie.ts

@@ -8,7 +8,7 @@ import { movieGenreList } from "../components/lists/movieGenre.list";
 
 export const movieModule: IModule = {
   id: "movieModule",
-  title: "Episódio",
+  title: "Filme",
   icon: "movie",
   components: [
     movieForm,
@@ -18,5 +18,4 @@ export const movieModule: IModule = {
     movieEpisodeForm,
     movieEpisodeList
   ]
-}
-
+}

package/src/examples/projects/movieBackoffice.ts

@@ -9,7 +9,7 @@ export const movieBackoffice: IProject = {
   id: "movieBackoffice",
   title: "Movie Backoffice",
   description: "Sistema de gerenciamento para filmes e personagens.",
-  flow: "backofficeOpenedAndPermissionsByComponent",
+  flow: "backofficeOpenedWithoutPermissions",
   businessPlan: {
     businessValue: "Gerenciar e otimizar as operações do Movie.",
     targetMarket: "Empresas que utilizam o Movie para gerenciar sugestões e feedbacks.",
@@ -20,7 +20,7 @@ export const movieBackoffice: IProject = {
     monetization: "Assinaturas mensais para acesso ao sistema.",
   },
   frontend: {
-    framework: "svelte",
+    framework: "react",
     uiKit: "flowbite",
   },
   backend: {

package/src/interfaces/list.interface.ts

@@ -5,60 +5,79 @@ import type { IContractRequest } from "./form.interface";
 import type { IBusinessRule } from "./project.interface";
 
 export interface IList {
-    componentType: "list";
-    id: string; // named according to component file name (<id>.<componentType>.ts)
-    title: string;
-    userStory?: string;
-    guards?: string[];
-    dataSource: IApiRequest;
+  componentType: "list";
+  id: string; // named according to component file name (<id>.<componentType>.ts)
+  title: string;
+  userStory?: string;
+  guards?: string[];
+  dataSource: IApiRequest;
+  businessRules?: IBusinessRule[];
+  listItems: {
+    property?: string; // property taken from dataSource response. e.g.: "email"
+    label?: string; // label to property. e.g.: "E-mail"
+    type?:
+      | "title"
+      | "subtitle"
+      | "description"
+      | "video"
+      | "image"
+      | "images"
+      | "icon";
+    isHtml?: boolean;
+    isLink?: boolean;
+    isTimestamp?: boolean;
+    callToAction?: {
+      link: string; // e.g.: "/user"
+      usePropertyAsQuery?: boolean; // if true then "/user/<email>"
+    };
+    dataType: EDataType;
+    conditions?: IFormCondition[];
     businessRules?: IBusinessRule[];
-    properties: {
-        property: string; // property taken from dataSource response. e.g.: "email"
-        label?: string; // label to property. e.g.: "E-mail"
-        type?: "title" | "subtitle" | "description" | "video" | "image" | "images" | "icon";
-        isHtml?: boolean;
-        isLink?: boolean;
-        isTimestamp?: boolean;
-        callToAction?: {
-            link: string; // e.g.: "/user"
-            usePropertyAsQuery?: boolean; // if true then "/user/<email>"
-        };
-        dataType: EDataType;
-        conditions?: IFormCondition[];
-    }[]; // properties taken from dataSource
-    cardAsALink?: {
-        link: string; // e.g.: "/user"
+    todo?: string;
+  }[]; // properties taken from dataSource
+  cardAsALink?: {
+    link: string; // e.g.: "/user"
+    propertiesAsQueryParam?: string[]; // if, for example, ["_id", "email"], then "/user?_id=value&email=value"
+    propertiesAsPathParam?: string[]; // if, for example, ["_id", "email"], then "/user/<_id>/<email>"
+  };
+  callsToActionMenu?: {
+    icon: string; // Material icons e.g: "pencil"
+    label: string; // e.g: "Editar"
+    action: {
+      link: {
+        // frontend url to be redirected on action completition
+        endpoint: string; // e.g.: "/user"
         propertiesAsQueryParam?: string[]; // if, for example, ["_id", "email"], then "/user?_id=value&email=value"
         propertiesAsPathParam?: string[]; // if, for example, ["_id", "email"], then "/user/<_id>/<email>"
-    };
-    callsToActionMenu?: {
-        icon: string; // Material icons e.g: "pencil"
-        label: string; // e.g: "Editar"
-        action: {
-            link: { // frontend url to be redirected on action completition
-                endpoint: string; // e.g.: "/user"
-                propertiesAsQueryParam?: string[]; // if, for example, ["_id", "email"], then "/user?_id=value&email=value"
-                propertiesAsPathParam?: string[]; // if, for example, ["_id", "email"], then "/user/<_id>/<email>"
-            };
-            request?: { // backend request endpoint that must be processed before link redirection
-                endpoint: string; // e.g.: "/user"
-                propertiesAsQueryParam?: string[]; // if, for example, ["_id", "email"], then "/user?_id=value&email=value"
-                propertiesAsPathParam?: string[]; // if, for example, ["_id", "email"], then "/user/<_id>/<email>"
-                verb: "get" | "post" | "put" | "delete";
-                dialog?: {
-                    title: string;
-                    message: string;
-                };
-            };
+      };
+      request?: {
+        // backend request endpoint that must be processed before link redirection
+        endpoint: string; // e.g.: "/user"
+        propertiesAsQueryParam?: string[]; // if, for example, ["_id", "email"], then "/user?_id=value&email=value"
+        propertiesAsPathParam?: string[]; // if, for example, ["_id", "email"], then "/user/<_id>/<email>"
+        verb: "get" | "post" | "put" | "delete";
+        dialog?: {
+          title: string;
+          message: string;
         };
-    }[];
-    contracts: {
-        id: string;
-        endpoint: string;
-        actions: ("create" | "get" | "getById" | "update" | "delete" | "clone" | "sendEmail")[];
-        request?: IContractRequest;
-        conditions?: IFormCondition[];
-        businessRules?: IBusinessRule[];
-        userStory?: string;
-    }[];
-}
+      };
+    };
+  }[];
+  contracts: {
+    id: string;
+    endpoint: string;
+    actions: (
+      | "create"
+      | "get"
+      | "getById"
+      | "update"
+      | "delete"
+      | "clone"
+      | "sendEmail"
+    )[];
+    request?: IContractRequest;
+    conditions?: IFormCondition[];
+    businessRules?: IBusinessRule[];
+    userStory?: string;
+  }[];
+}

package/src/interfaces/project.interface.ts

@@ -50,7 +50,15 @@ export interface IBusinessRule {
     description: string;
     subrules?: {
       description: string;
+      implementation?: {
+        type: "frontend" | "backend" | "both";
+        details: string;
+      };
     }[];
+    implementation?: {
+      type: "frontend" | "backend" | "both";
+      details: string;
+    };
   };
 }
 

package/src/schemas/business-rules.ref.json

@@ -11,6 +11,19 @@
           "description": {
             "type": "string"
           },
+          "implementation": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": ["frontend", "backend", "both"]
+              },
+              "details": {
+                "type": "string"
+              }
+            },
+            "required": ["type", "details"]
+          },
           "subrules": {
             "type": "array",
             "items": {
@@ -21,6 +34,19 @@
                   "properties": {
                     "description": {
                       "type": "string"
+                    },
+                    "implementation": {
+                      "type": "object",
+                      "properties": {
+                        "type": {
+                          "type": "string",
+                          "enum": ["frontend", "backend", "both"]
+                        },
+                        "details": {
+                          "type": "string"
+                        }
+                      },
+                      "required": ["type", "details"]
                     }
                   }
                 }
@@ -31,4 +57,4 @@
       }
     }
   }
-}
+}

package/src/schemas/list.ref.json

@@ -28,7 +28,7 @@
     "businessRules": {
       "$ref": "business-rules.ref.json"
     },
-    "properties": {
+    "listItems": {
       "type": "array",
       "items": {
         "type": "object",
@@ -82,9 +82,14 @@
           },
           "conditions": {
             "$ref": "condition.ref.json"
+          },
+          "businessRules": {
+            "$ref": "business-rules.ref.json"
+          },
+          "todo": {
+            "type": "string"
           }
-        },
-        "required": ["property"]
+        }
       }
     },
     "cardAsALink": {