rapida-partner 1.9.0 → 1.10.1

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

@@ -12,10 +12,10 @@ export const characterForm: IForm = {
       endpoint: "/characters",
       actions: ["create", "get", "getById", "update", "delete"],
       request: {
-        entity: "Character",
+        entity: "characters",
         description: "Represents a character in a story or narrative.",
         fields: [
-          { name: "_id", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, isPrimaryKey: true },
+          { name: "id", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, isPrimaryKey: true },
           { name: "characterName", dataType: EDataType.NVARCHAR, isRequired: true },
           { name: "characterImage", dataType: EDataType.NVARCHAR, isRequired: false },
           { name: "characterDescription", dataType: EDataType.LONGTEXT, isRequired: false },

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

@@ -5,33 +5,6 @@ export const movieForm: IForm = {
   title: "Gerenciar filme",
   userStory: `Como um usuário autorizado, eu quero usar o formulário de gerenciamento de filmes para cadastrar e editar filmes, incluindo a foto, o nome, a descrição, a data de lançamento, a pontuação no IMDb e os gêneros associados. Quero também ter a opção de adicionar e gerenciar episódios, incluindo seus títulos, descrições, datas de lançamento e personagens relacionados. Isso me permite manter um registro completo e detalhado do conteúdo audiovisual no sistema.`,
   componentType: "form",
-  contracts: [
-    {
-      id: "movies",
-      endpoint: "/movies",
-      actions: ["create", "update", "getById", "get", "delete"],
-      request: {
-        entity: "Movie",
-        description: "Represents a movie or TV series in the system.",
-        fields: [
-          { name: "_id", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, isPrimaryKey: true },
-          { name: "pictureFile", dataType: EDataType.NVARCHAR, isRequired: false },
-          { name: "name", dataType: EDataType.NVARCHAR, isRequired: true },
-          { name: "description", dataType: EDataType.LONGTEXT, isRequired: true },
-          { name: "releaseDate", dataType: EDataType.DATE, isRequired: true },
-          { name: "imdbRating", dataType: EDataType.DECIMAL, isRequired: true },
-          { name: "movieGenres", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, foreignKey: {
-            entity: "MovieGenre",
-            connectionAttribute: "_id",
-            relationship: "many-to-many"
-          } },
-          { name: "link1", dataType: EDataType.NVARCHAR, isRequired: true },
-          { name: "link2", dataType: EDataType.NVARCHAR, isRequired: false },
-          { name: "link3", dataType: EDataType.NVARCHAR, isRequired: false },
-        ],
-      }
-    }
-  ],
   id: "movieForm",
   guards: "isAuthorized",
   elements: [
@@ -122,4 +95,55 @@ export const movieForm: IForm = {
       ],
     },
   ],
+  contracts: [
+    {
+      id: "movies",
+      endpoint: "/movies",
+      actions: ["create", "update", "getById", "get", "delete"],
+      request: {
+        entity: "Movie",
+        description: "Represents a movie or TV series in the system.",
+        fields: [
+          { name: "id", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, isPrimaryKey: true },
+          { name: "pictureFile", dataType: EDataType.NVARCHAR, isRequired: false },
+          { name: "name", dataType: EDataType.NVARCHAR, isRequired: true },
+          { name: "description", dataType: EDataType.LONGTEXT, isRequired: true },
+          { name: "releaseDate", dataType: EDataType.DATE, isRequired: true },
+          { name: "imdbRating", dataType: EDataType.DECIMAL, isRequired: true },
+          { name: "movieGenres", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, foreignKey: {
+            entity: "MovieGenre",
+            connectionAttribute: "_id",
+            relationship: "many-to-many"
+          } },
+          { name: "link1", dataType: EDataType.NVARCHAR, isRequired: true },
+          { name: "link2", dataType: EDataType.NVARCHAR, isRequired: false },
+          { name: "link3", dataType: EDataType.NVARCHAR, isRequired: false },
+        ],
+      }
+    }
+  ],
+  flowChart: {
+    actors: [
+      {
+        name: "Usuário",
+        actionsWithElements: [
+          {
+            verb: "create",
+          },
+          {
+            verb: "update",
+          },
+          {
+            verb: "get",
+          },
+          {
+            verb: "getById",
+          },
+          {
+            verb: "delete",
+          }
+        ],
+      }
+    ]
+  }
 };

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

@@ -5,64 +5,36 @@ export const movieEpisodeForm: IForm = {
   title: "Gerenciar episódio",
   componentType: "form",
   id: "movieEpisodeForm",
-  contracts: [
-    {
-      id: "moviesEpisodes",
-      endpoint: "/movies-episodes",
-      actions: ["create", "get", "getById", "update", "delete"],
-      request: {
-        entity: "MovieEpisode",
-        description: "Represents an episode of a TV series or show.",
-        fields: [
-          { name: "_id", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, isPrimaryKey: true },
-          { name: "movieId", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, foreignKey: {
-            entity: "Movie",
-            connectionAttribute: "_id",
-            relationship: "one-to-many"
-          } },
-          { name: "title", dataType: EDataType.NVARCHAR, isRequired: true },
-          { name: "description", dataType: EDataType.LONGTEXT, isRequired: true },
-          { name: "releaseDate", dataType: EDataType.DATETIME2, isRequired: true },
-          { name: "characters", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: false, foreignKey: {
-            entity: "Character",
-            connectionAttribute: "_id",
-            relationship: "many-to-many"
-          } },
-        ],
-      }
-    },
-  ],
   elements: [
     {
-      type: "array",
-      id: "episodes",
+      label: "Episódio",
       name: "episodes",
-      title: "Episódio",
+      type: EDataType.ARRAY,
       elements: [
         {
-          type: "input",
-          dataType: EDataType.TEXT,
           label: "Título do episódio",
           name: "episodeTitle",
+          type: "input",
+          dataType: EDataType.TEXT,
           isRequired: true,
         },
         {
-          type: "input",
-          dataType: EDataType.WYSIWYG,
           label: "Descrição do episódio",
           name: "episodeDescription",
+          type: "input",
+          dataType: EDataType.WYSIWYG,
         },
         {
-          type: "input",
-          dataType: EDataType.DATE,
           label: "Data de lançamento do episódio",
           name: "episodeReleaseDate",
+          type: "input",
+          dataType: EDataType.DATE,
         },
         {
-          type: "autocomplete",
-          dataType: EDataType.TEXT,
           name: "charactersId",
           label: "Personagens no episódio",
+          type: "autocomplete",
+          dataType: EDataType.TEXT,
           optionsApi: {
             endpoint: "/characters",
             labelField: ["characterName"],
@@ -75,4 +47,31 @@ export const movieEpisodeForm: IForm = {
       ],
     },
   ],
+  contracts: [
+    {
+      id: "moviesEpisodes",
+      endpoint: "/movies-episodes",
+      actions: ["create", "get", "getById", "update", "delete"],
+      request: {
+        entity: "MovieEpisode",
+        description: "Represents an episode of a TV series or show.",
+        fields: [
+          { name: "_id", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, isPrimaryKey: true },
+          { name: "movieId", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, foreignKey: {
+            entity: "Movie",
+            connectionAttribute: "_id",
+            relationship: "one-to-many"
+          } },
+          { name: "title", dataType: EDataType.NVARCHAR, isRequired: true },
+          { name: "description", dataType: EDataType.LONGTEXT, isRequired: true },
+          { name: "releaseDate", dataType: EDataType.DATETIME2, isRequired: true },
+          { name: "characters", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: false, foreignKey: {
+            entity: "Character",
+            connectionAttribute: "_id",
+            relationship: "many-to-many"
+          } },
+        ],
+      }
+    },
+  ],
 }

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

@@ -5,6 +5,24 @@ export const movieGenreForm: IForm = {
   title: "Gerenciar gênero de filme",
   userStory: `Como um usuário autorizado, eu quero usar o formulário de gerenciamento de gênero de filme para criar e editar gêneros de filmes, fornecendo um nome e uma descrição para cada um. Isso me permite organizar e categorizar filmes de forma precisa no sistema.`,
   componentType: "form",
+  id: "movieGenreForm",
+  guards: "isAuthorized",
+  elements: [
+    {
+      type: "input",
+      dataType: EDataType.TEXT,
+      label: "Nome",
+      name: "name",
+      isRequired: true,
+    },
+    {
+      type: "input",
+      dataType: EDataType.WYSIWYG,
+      label: "Descrição",
+      name: "description",
+      isRequired: true,
+    },
+  ],
   contracts: [
     {
       id: "moviesGenres",
@@ -30,22 +48,4 @@ export const movieGenreForm: IForm = {
       }
     }
   ],
-  id: "movieGenreForm",
-  guards: "isAuthorized",
-  elements: [
-    {
-      type: "input",
-      dataType: EDataType.TEXT,
-      label: "Nome",
-      name: "name",
-      isRequired: true,
-    },
-    {
-      type: "input",
-      dataType: EDataType.WYSIWYG,
-      label: "Descrição",
-      name: "description",
-      isRequired: true,
-    },
-  ],
 };

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

@@ -0,0 +1,125 @@
+import { EDataType } from "../../../enums/form.enum";
+import type { IForm } from "../../../interfaces/form.interface";
+
+export const testForm: IForm = {
+  title: "Formulário teste",
+  componentType: "form",
+  id: "testFormForm",
+  guards: "isAuthorized",
+  elements: [
+    {
+      id: "testFormTab",
+      type: "tab",
+      tabs: [
+        {
+          title: "Dados principais",
+          id: "mainDataTab",
+          elements: [
+            {
+              label: "Nome",
+              name: "name",
+              type: "input",
+              dataType: EDataType.TEXT,
+            },
+            {
+              title: "Coisa aleatória",
+              id: "randomThingFieldset",
+              type: "fieldset",
+              elements: [
+                {
+                  label: "Qualquer coisa*",
+                  name: "anything",
+                  type: "select",
+                  dataType: EDataType.TEXT,
+                  isRequired: true,
+                  options: [
+                    { label: "Rótulo para a opção 1", value: "optionOneLabel" },
+                    { label: "Rótulo para a opção 2", value: "optionTwoLabel" },
+                    { label: "Rótulo para a opção 3", value: "optionThreeLabel" },
+                  ],
+                },
+                {
+                  label: "Outras coisas para escolher*",
+                  name: "otherThingsToChoose",
+                  type: "select",
+                  dataType: EDataType.TEXT,
+                  isRequired: true,
+                  isMultiple: true,
+                  options: [
+                    { label: "Rótulo para a opção 1", value: "optionOneLabel" },
+                    { label: "Rótulo para a opção 2", value: "optionTwoLabel" },
+                    { label: "Rótulo para a opção 3", value: "optionThreeLabel" },
+                  ],
+                },
+                {
+                  label: "Uma terceira coisa*",
+                  name: "aThirdThingId",
+                  type: "autocomplete",
+                  dataType: EDataType.TEXT,
+                  isRequired: true,
+                  optionsApi: {
+                    endpoint: "/endpoint-to-use",
+                    // leave it blank so documenter will be forced to check it
+                  },
+                },
+              ],
+            },
+            {
+              label: "Hobbies",
+              name: "hobbiesId",
+              type: "autocomplete",
+              dataType: EDataType.TEXT,
+              isMultiple: true,
+              optionsApi: {
+                endpoint: "/endpoint-to-use",
+                // leave it blank so documenter will be forced to check it
+              },
+            },
+          ],
+        },
+        {
+          title: "Dados secundários",
+          id: "secondaryDataTab",
+          elements: [
+            {
+              label: "Data de nascimento*",
+              name: "dateOfBirth",
+              type: "input",
+              dataType: EDataType.DATE,
+              isRequired: true,
+            },
+            {
+              label: "Adicionar mais coisas",
+              name: "addMoreThingsArray",
+              type: "array",
+              elements: [
+                {
+                  label: "Rótulo de input de arquivo",
+                  name: "fileInputLabelUrl",
+                  type: "file",
+                  dataType: EDataType.TEXT,
+                  storageConfig: {
+                    fileNameStrategy: "uuid",
+                    // leave it blank so documenter will be forced to check it
+                  },
+                },
+                {
+                  label: "Rótulo de input de senha",
+                  name: "passwordInputLabel",
+                  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

@@ -1,3 +1,4 @@
+import { EDataType } from "../../../enums/form.enum";
 import type { IList } from "../../../interfaces/list.interface";
 
 export const characterList: IList = {
@@ -11,8 +12,8 @@ export const characterList: IList = {
     hasAuthentication: true,
   },
   properties: [
-    { label: "Nome", property: "characterName", type: "title" },
-    { label: "Descrição", property: "characterDescription", type: "description", isHtml: true, },
+    { label: "Nome", property: "characterName", type: "title", dataType: EDataType.NVARCHAR },
+    { label: "Descrição", property: "characterDescription", type: "description", isHtml: true, dataType: EDataType.LONGTEXT },
   ],
   callsToActionMenu: [
     {
@@ -43,5 +44,24 @@ export const characterList: IList = {
         }
       },
     }
-  ]
+  ],
+  contracts: [
+    {
+      id: "characters",
+      endpoint: "/characters",
+      actions: ["get", "getById"],
+      request: {
+        entity: "characters",
+        description: "Represents a character in a story or narrative.",
+        fields: [
+          { name: "id", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, isPrimaryKey: true },
+          { name: "characterName", dataType: EDataType.NVARCHAR, isRequired: true },
+          { name: "characterImage", dataType: EDataType.NVARCHAR, isRequired: false },
+          { name: "characterDescription", dataType: EDataType.LONGTEXT, isRequired: false },
+          { name: "characterType", dataType: EDataType.NVARCHAR, enum: ["protagonist", "antagonist", "hero", "villain", "sidekick", "supporting"], isRequired: false },
+          { name: "characterGender", dataType: EDataType.NVARCHAR, enum: ["male", "female", "other"], isRequired: false },
+        ],
+      },
+    }
+  ],
 };

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

@@ -1,3 +1,4 @@
+import { EDataType } from "../../../enums/form.enum";
 import type { IList } from "../../../interfaces/list.interface";
 
 export const movieList: IList = {
@@ -12,19 +13,19 @@ export const movieList: IList = {
   },
   properties: [
     {
-      property: "pictureFile", type: "image", label: "Cartaz",
+      property: "pictureFile", type: "image", label: "Cartaz", dataType: EDataType.NVARCHAR,
     },
     {
-      property: "name", type: "title", label: "Nome",
+      property: "name", type: "title", label: "Nome", dataType: EDataType.NVARCHAR,
     },
     {
-      property: "releaseDate", type: "subtitle", label: "Data de lançamento",
+      property: "releaseDate", type: "subtitle", label: "Data de lançamento", dataType: EDataType.DATETIME2,
     },
     {
-      property: "movieGenres.name", type: "subtitle", label: "Gênero",
+      property: "movieGenres.name", type: "subtitle", label: "Gênero", dataType: EDataType.NVARCHAR,
     },
     {
-      property: "description", type: "description", label: "Descrição", isHtml: true,
+      property: "description", type: "description", label: "Descrição", isHtml: true, dataType: EDataType.LONGTEXT
     },
   ],
   callsToActionMenu: [
@@ -56,5 +57,32 @@ export const movieList: IList = {
         }
       },
     }
-  ]
+  ],
+  contracts: [
+    {
+      id: "movies",
+      endpoint: "/movies",
+      actions: ["create", "update", "getById", "get", "delete"],
+      request: {
+        entity: "Movie",
+        description: "Represents a movie or TV series in the system.",
+        fields: [
+          { name: "id", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, isPrimaryKey: true },
+          { name: "pictureFile", dataType: EDataType.NVARCHAR, isRequired: false },
+          { name: "name", dataType: EDataType.NVARCHAR, isRequired: true },
+          { name: "description", dataType: EDataType.LONGTEXT, isRequired: true },
+          { name: "releaseDate", dataType: EDataType.DATETIME2, isRequired: true },
+          { name: "imdbRating", dataType: EDataType.FLOAT, isRequired: true },
+          { name: "movieGenres", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, foreignKey: {
+            entity: "MovieGenre",
+            connectionAttribute: "_id",
+            relationship: "many-to-many"
+          } },
+          { name: "link1", dataType: EDataType.NVARCHAR, isRequired: true },
+          { name: "link2", dataType: EDataType.NVARCHAR, isRequired: false },
+          { name: "link3", dataType: EDataType.NVARCHAR, isRequired: false },
+        ],
+      }
+    }
+  ],
 };

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

@@ -1,3 +1,4 @@
+import { EDataType } from "../../../enums/form.enum";
 import type { IList } from "../../../interfaces/list.interface";
 
 export const movieEpisodeList: IList = {
@@ -12,10 +13,10 @@ export const movieEpisodeList: IList = {
   },
   properties: [
     {
-      property: "episodeTitle", type: "title", label: "Título",
+      property: "episodeTitle", type: "title", label: "Título", dataType: EDataType.NVARCHAR,
     },
     {
-      property: "episodeDescription", type: "description", label: "Descrição",
+      property: "episodeDescription", type: "description", label: "Descrição", isHtml: true, dataType: EDataType.LONGTEXT,
     },
   ],
   callsToActionMenu: [
@@ -47,5 +48,32 @@ export const movieEpisodeList: IList = {
         }
       },
     }
-  ]
+  ],
+  contracts: [
+    {
+      id: "moviesEpisodes",
+      endpoint: "/movies-episodes",
+      actions: ["create", "get", "getById", "update", "delete"],
+      request: {
+        entity: "MovieEpisode",
+        description: "Represents an episode of a TV series or show.",
+        fields: [
+          { name: "_id", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, isPrimaryKey: true },
+          { name: "movieId", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: true, foreignKey: {
+            entity: "Movie",
+            connectionAttribute: "_id",
+            relationship: "one-to-many"
+          } },
+          { name: "title", dataType: EDataType.NVARCHAR, isRequired: true },
+          { name: "description", dataType: EDataType.LONGTEXT, isRequired: true },
+          { name: "releaseDate", dataType: EDataType.DATETIME2, isRequired: true },
+          { name: "characters", dataType: EDataType.UNIQUEIDENTIFIER, isRequired: false, foreignKey: {
+            entity: "Character",
+            connectionAttribute: "_id",
+            relationship: "many-to-many"
+          } },
+        ],
+      }
+    },
+  ],
 };

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

@@ -1,3 +1,4 @@
+import { EDataType } from "../../../enums/form.enum";
 import type { IList } from "../../../interfaces/list.interface";
 
 export const movieGenreList: IList = {
@@ -12,10 +13,10 @@ export const movieGenreList: IList = {
   },
   properties: [
     {
-      property: "name", type: "title", label: "Nome",
+      property: "name", type: "title", label: "Nome", dataType: EDataType.NVARCHAR,
     },
     {
-      property: "description", type: "description", label: "Descrição",
+      property: "description", type: "description", label: "Descrição", isHtml: true, dataType: EDataType.LONGTEXT,
     },
   ],
   callsToActionMenu: [
@@ -47,5 +48,30 @@ export const movieGenreList: IList = {
         }
       },
     }
-  ]
+  ],
+  contracts: [
+    {
+      id: "moviesGenres",
+      endpoint: "/movie-genres",
+      actions: ["create", "get", "getById", "update", "delete"],
+      request : {
+        entity: "moviesGenres",
+        description: "",
+        fields: [
+          {
+            name: "name",
+            dataType: EDataType.TEXT,
+            isRequired: true,
+            maxSize: 255,
+          },
+          {
+            name: "description",
+            dataType: EDataType.TEXT,
+            isRequired: true,
+            maxSize: 255,
+          }
+        ]
+      }
+    }
+  ],
 };

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/form-array.interface.ts

@@ -5,7 +5,7 @@ import type { IBusinessRule } from "./project.interface";
 export interface IFormArray {
   type: "array";
   name: string;
-  title: string;
+  label: string;
   elements: IFormElement[];
   conditions?: IFormCondition[];
   todo?: string;

package/src/interfaces/form-flowchart.interface.ts

@@ -0,0 +1,22 @@
+import type { IBusinessRule } from "./project.interface";
+
+export interface IFlowChart {
+  actors: IActor[];
+}
+
+export interface IActor {
+  name: string;
+  actionsWithElements: IActionWithElement[];
+  businessRules?: IBusinessRule[];
+}
+
+export interface IActionWithElement {
+  verb: "create" | "get" | "getById" | "update" | "delete" | "clone" | "sendEmail";
+  elements?: IFlowChartElement[];
+  businessRules?: IBusinessRule[];
+}
+
+export interface IFlowChartElement {
+  name: string;
+  businessRules?: IBusinessRule[];
+}

package/src/interfaces/form.interface.ts

@@ -11,6 +11,7 @@ import type { IFormInput } from "./form-input.interface";
 import type { IFormSelect } from "./form-select.interface";
 import type { IFormTab } from "./form-tab.interface";
 import type { IBusinessRule } from "./project.interface";
+import type { IActor, IFlowChart } from "./form-flowchart.interface";
 
 export interface IForm {
   componentType: "form";
@@ -30,6 +31,11 @@ export interface IForm {
     businessRules?: IBusinessRule[];
     userStory?: string;
   }[];
+  flowChart?: IFlowChart;
+}
+
+export interface IContract {
+  id: string;
   kanban?: {
     status: "toDo" | "inProgress" | "done";
     assigneesIds?: string[];