rapida-partner 1.8.0 → 1.10.0

package/src/interfaces/list.interface.ts

@@ -1,5 +1,7 @@
+import type { EDataType } from "../enums/form.enum";
 import type { IFormCondition } from "./condition.interface";
 import type { IApiRequest } from "./form-input.interface";
+import type { IContractRequest } from "./form.interface";
 import type { IBusinessRule } from "./project.interface";
 
 export interface IList {
@@ -21,6 +23,7 @@ export interface IList {
             link: string; // e.g.: "/user"
             usePropertyAsQuery?: boolean; // if true then "/user/<email>"
         };
+        dataType: EDataType;
         conditions?: IFormCondition[];
     }[]; // properties taken from dataSource
     cardAsALink?: {
@@ -49,4 +52,13 @@ export interface IList {
             };
         };
     }[];
+    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

@@ -17,9 +17,9 @@ export interface IProject {
   businessPlan?: IBusinessPLan;
   businessRules?: IBusinessRule[];
   flow:
-  | "backofficeByInvitationWithoutPermissions"
-  | "backofficeByInvitationAndPermissionsByComponent"
-  | "backofficeOpenedWithoutPermissions"
+    | "backofficeByInvitationWithoutPermissions"
+    | "backofficeByInvitationAndPermissionsByComponent"
+    | "backofficeOpenedWithoutPermissions"
     | "backofficeOpenedAndPermissionsByComponent"
     | "marketplace"
     | "landingPage"

package/src/schemas/form-array.ref.json

@@ -20,15 +20,18 @@
     "name": {
       "type": "string"
     },
-    "title": {
+    "label": {
       "type": "string"
     },
     "elements": {
       "$ref": "form-one-of.ref.json"
+    },
+    "isRequired": {
+      "type": "boolean"
     }
   },
   "required": [
     "type",
-    "title"
+    "label"
   ]
 }

package/src/schemas/form-flowchart-action-with-element.ref.json

@@ -0,0 +1,29 @@
+{
+  "$id": "form-flowchart-action-with-element.ref.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "verb": {
+      "type": "string",
+      "enum": [
+        "create",
+        "get",
+        "getById",
+        "update",
+        "delete",
+        "clone",
+        "sendEmail"
+      ]
+    },
+    "elements": {
+      "type": "array",
+      "items": {
+        "$ref": "form-flowchart-element.ref.json"
+      }
+    },
+    "businessRules": {
+      "$ref": "business-rules.ref.json"
+    }
+  },
+  "required": ["verb"]
+}

package/src/schemas/form-flowchart-actor.ref.json

@@ -0,0 +1,20 @@
+{
+  "$id": "form-flowchart-actor.ref.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "actionsWithElements": {
+      "type": "array",
+      "items": {
+        "$ref": "form-flowchart-action-with-element.ref.json"
+      }
+    },
+    "businessRules": {
+      "$ref": "business-rules.ref.json"
+    }
+  },
+  "required": ["name", "actionsWithElements"]
+}

package/src/schemas/form-flowchart-element.ref.json

@@ -0,0 +1,14 @@
+{
+  "$id": "form-flowchart-element.ref.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "businessRules": {
+      "$ref": "business-rules.ref.json"
+    }
+  },
+  "required": ["name", "businessRules"]
+}

package/src/schemas/form-flowchart.ref.json

@@ -0,0 +1,14 @@
+{
+  "$id": "form-flowchart.ref.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "actors": {
+      "type": "array",
+      "items": {
+        "$ref": "form-flowchart-actor.ref.json"
+      }
+    }
+  },
+  "required": ["actors"]
+}

package/src/schemas/form.ref.json

@@ -234,6 +234,9 @@
         "required": ["id", "endpoint", "actions"]
       }
     },
+    "flowChart": {
+      "$ref": "form-flowchart.ref.json"
+    },
     "kanban": {
       "type": "object",
       "properties": {

package/src/schemas/list.ref.json

@@ -53,6 +53,10 @@
               "icon"
             ]
           },
+          "dataType": {
+            "type": "string",
+            "$ref": "types-datatype.ref.json"
+          },
           "isHtml": {
             "type": "boolean"
           },
@@ -77,7 +81,7 @@
             "required": ["link"]
           },
           "conditions": {
-            "$ref": "condition.ref.json"            
+            "$ref": "condition.ref.json"
           }
         },
         "required": ["property"]
@@ -193,7 +197,228 @@
         },
         "required": ["icon", "label", "action"]
       }
+    },
+    "contracts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "endpoint": {
+            "type": "string"
+          },
+          "actions": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "create",
+                "get",
+                "getById",
+                "update",
+                "delete",
+                "clone",
+                "sendEmail"
+              ]
+            }
+          },
+          "request": {
+            "type": "object",
+            "properties": {
+              "entity": {
+                "type": "string"
+              },
+              "description": {
+                "type": "string"
+              },
+              "fields": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    },
+                    "dataType": {
+                      "$ref": "types-datatype.ref.json"
+                    },
+                    "isRequired": {
+                      "type": "boolean"
+                    },
+                    "requiredOneOf": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "isHidden": {
+                      "type": "boolean",
+                      "description": "If true, the attribute will not be exposed in the API."
+                    },
+                    "foreignKey": {
+                      "type": "object",
+                      "properties": {
+                        "entity": {
+                          "type": "string"
+                        },
+                        "connectionAttribute": {
+                          "type": "string"
+                        },
+                        "relationship": {
+                          "type": "string",
+                          "enum": ["one-to-one", "one-to-many", "many-to-many"]
+                        },
+                        "fields": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "name": {
+                                "type": "string"
+                              },
+                              "dataType": {
+                                "$ref": "types-datatype.ref.json"
+                              }
+                            },
+                            "required": ["name", "dataType"]
+                          }
+                        },
+                        "isHidden": {
+                          "type": "boolean",
+                          "description": "If true, the connection attribute will not be exposed in the API."
+                        }
+                      },
+                      "required": [
+                        "entity",
+                        "connectionAttribute",
+                        "relationship"
+                      ]
+                    },
+                    "isPrimaryKey": {
+                      "type": "boolean"
+                    },
+                    "minSize": {
+                      "type": "number"
+                    },
+                    "maxSize": {
+                      "type": "number"
+                    },
+                    "enum": {
+                      "type": "array",
+                      "items": {
+                        "oneOf": [
+                          {
+                            "type": "string"
+                          },
+                          {
+                            "type": "number"
+                          }
+                        ]
+                      }
+                    },
+                    "isUnique": {
+                      "type": "boolean"
+                    },
+                    "uniqueComposedFields": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "actionsExceptions": {
+                      "type": "array",
+                      "items": {
+                        "type": "string",
+                        "enum": [
+                          "create",
+                          "get",
+                          "getById",
+                          "update",
+                          "delete",
+                          "clone",
+                          "sendEmail"
+                        ]
+                      }
+                    }
+                  },
+                  "required": ["name", "dataType"]
+                }
+              },
+              "relatedEntity": {
+                "type": "object",
+                "properties": {
+                  "entity": {
+                    "type": "string",
+                    "description": "An attribute called 'relatedEntity' will be created in the main entity to refer to an entity that will be related to the main one."
+                  },
+                  "connectionAttribute": {
+                    "type": "string",
+                    "description": "An attribute called 'relatedEntityId' will be created in the main entity to set the value of the id over 'relatedEntity' to make the connection."
+                  },
+                  "fieldsFromEntity": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "fields": {
+                          "$ref": "form.ref.json"
+                        },
+                        "contractId": {
+                          "type": "string"
+                        }
+                      }
+                    },
+                    "required": ["fields", "contractId"]
+                  }
+                },
+                "required": [
+                  "entity",
+                  "connectionAttribute",
+                  "fieldsFromEntity"
+                ]
+              },
+              "uniqueConstraints": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    },
+                    "fields": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "required": ["entity", "fields"]
+          },
+          "conditions": {
+            "$ref": "condition.ref.json"
+          },
+          "businessRules": {
+            "$ref": "business-rules.ref.json"
+          },
+          "userStory": {
+            "type": "string"
+          }
+        },
+        "required": ["id", "endpoint", "actions"]
+      }
     }
   },
-  "required": ["componentType", "id", "title", "dataSource", "properties"]
+  "required": [
+    "componentType",
+    "id",
+    "title",
+    "dataSource",
+    "properties",
+    "contracts"
+  ]
 }

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

@@ -1,49 +0,0 @@
-import type { IList } from "../../../interfaces/list.interface";
-
-export const companyList: IList = {
-  componentType: "list",
-  id: "companyList",
-  title: "Lista de empresas",
-  guards: ["isAuthorized"],
-  dataSource: {
-    endpoint: "/companies",
-    paramType: "query",
-    hasAuthentication: true,
-  },
-  properties: [
-    { label: "CNPJ", property: "companyCnpj", type: "title" },
-    { label: "Nome", property: "companyName", type: "title" },
-    { label: "Telefone", property: "companyPhoneOne", type: "subtitle" },
-    { label: "E-mail", property: "companyEmailOne", type: "subtitle" },
-  ],
-  callsToActionMenu: [
-    {
-      label: "Editar",
-      icon: "pencil",
-      action: {
-        link: {
-          endpoint: "/company-form",
-          propertiesAsQueryParam: ["_id"],
-        },
-      },
-    },
-    {
-      label: "Excluir",
-      icon: "delete",
-      action: {
-        link: {
-          endpoint: "/company-list",
-        },
-        request: {
-          endpoint: "/companies",
-          verb: "delete",
-          propertiesAsPathParam: ["_id"],
-          dialog: {
-            title: "Excluir empresa",
-            message: "Deseja realmente excluir essa empresa?",
-          }
-        }
-      },
-    }
-  ]
-};

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

@@ -1,50 +0,0 @@
-import type { IList } from "../../../interfaces/list.interface";
-
-export const customerList: IList = {
-  title: "Lista de clientes",
-  id: "customerList",
-  componentType: "list",
-  dataSource: {
-    endpoint: "/customers",
-    paramType: "query",
-  },
-  properties: [
-    { label: "Tipo", property: "entityRelated", type: "title", },
-    { label: "Nome", property: "People.name", type: "subtitle", conditions: [{ type: "property", elements: [{ key: "entityRelated", comparisonOperator: "===", value: "People" }] }] },
-    { label: "Telefone", property: "People.phoneOne", type: "subtitle", conditions: [{ type: "property", elements: [{ key: "entityRelated", comparisonOperator: "===", value: "People" }] }] },
-    { label: "E-mail", property: "People.emailOne", type: "subtitle", conditions: [{ type: "property", elements: [{ key: "entityRelated", comparisonOperator: "===", value: "People" }] }] },
-    { label: "Nome", property: "Companies.companyName", type: "subtitle", conditions: [{ type: "property", elements: [{ key: "entityRelated", comparisonOperator: "===", value: "Companies" }] }] },
-    { label: "Telefone", property: "Companies.phoneOne", type: "subtitle", conditions: [{ type: "property", elements: [{ key: "entityRelated", comparisonOperator: "===", value: "Companies" }] }] },
-    { label: "E-mail", property: "Companies.emailOne", type: "subtitle", conditions: [{ type: "property", elements: [{ key: "entityRelated", comparisonOperator: "===", value: "Companies" }] }] },
-  ],
-  callsToActionMenu: [
-    {
-      label: "Editar",
-      icon: "pencil",
-      action: {
-        link: {
-          endpoint: "/customer-form",
-          propertiesAsQueryParam: ["_id"],
-        },
-      },
-    },
-    {
-      label: "Excluir",
-      icon: "delete",
-      action: {
-        link: {
-          endpoint: "/customer-list",
-        },
-        request: {
-          endpoint: "/customers",
-          verb: "delete",
-          propertiesAsPathParam: ["_id"],
-          dialog: {
-            title: "Excluir conteúdo",
-            message: "Deseja realmente excluir esse conteúdo?",
-          }
-        }
-      },
-    }
-  ]
-}

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

@@ -1,50 +0,0 @@
-import type { IList } from "../../../interfaces/list.interface";
-
-export const personList: IList = {
-  componentType: "list",
-  id: "personList",
-  title: "Lista de pessoas",
-  guards: ["isAuthorized"],
-  dataSource: {
-    endpoint: "/people",
-    paramType: "query",
-    hasAuthentication: true,
-  },
-  properties: [
-    { label: "Foto", property: "personPicture", type: "image" },
-    { label: "CPF", property: "personCpf", type: "title" },
-    { label: "Nome", property: "personName", type: "title" },
-    { label: "Telefone", property: "personPhoneOne", type: "subtitle" },
-    { label: "E-mail", property: "personEmailOne", type: "subtitle" },
-  ],
-  callsToActionMenu: [
-    {
-      label: "Editar",
-      icon: "pencil",
-      action: {
-        link: {
-          endpoint: "/person-form",
-          propertiesAsQueryParam: ["_id"],
-        },
-      },
-    },
-    {
-      label: "Excluir",
-      icon: "delete",
-      action: {
-        link: {
-          endpoint: "/person-list",
-        },
-        request: {
-          endpoint: "/people",
-          verb: "delete",
-          propertiesAsPathParam: ["_id"],
-          dialog: {
-            title: "Excluir pessoa",
-            message: "Deseja realmente excluir essa pessoa?",
-          }
-        }
-      },
-    }
-  ]
-};