rapida-partner 1.2.0 → 1.3.0

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

@@ -0,0 +1,108 @@
+import { EFormContractDataType } from "../../../enums/form-contract.enum";
+import { EDataType } from "../../../enums/form.enum";
+import type { IForm } from "../../../interfaces/form.interface";
+import { companyForm } from "./company.form";
+import { personForm } from "./person.form";
+
+export const customerForm: IForm = {
+  title: "Gerenciar cliente",
+  id: "customerForm",
+  componentType: "form",
+  contracts: [
+    {
+      endpoint: "/customers/people",
+      actions: ["create", "update", "get", "getById", "delete"],
+      request: {
+        entity: "Customers",
+        relatedEntity: "People",
+        fields: [
+          ...(personForm.contracts[0].request?.fields || []), 
+          { name: "entityId", dataType: EFormContractDataType.UNIQUEIDENTIFIER },
+          { name: "entityRelated", dataType: EFormContractDataType.NVARCHAR }
+        ]
+      },
+      conditions: [
+        {
+          type: "form",
+          elements: [
+            {
+              key: "entityRelated",
+              comparisonOperator: "===",
+              value: "People"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      endpoint: "/customers/companies",
+      actions: ["create", "update", "get", "getById", "delete"],
+      request: {
+        entity: "Customers",
+        relatedEntity: "Companies",
+        fields: [
+          ...(companyForm.contracts[0].request?.fields || []), 
+          { name: "entityId", dataType: EFormContractDataType.UNIQUEIDENTIFIER },
+          { name: "entityRelated", dataType: EFormContractDataType.NVARCHAR }
+        ]
+      },
+      conditions: [
+        {
+          type: "form",
+          elements: [
+            {
+              key: "entityRelated",
+              comparisonOperator: "===",
+              value: "Companies"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  elements: [
+    {
+      type: "select",
+      dataType: EDataType.NVARCHAR,
+      label: "Tipo de cliente",
+      name: "entityRelated",
+      options: [
+        { label: "Pessoa", value: "People" },
+        { label: "Empresa", value: "Companies" }
+      ],
+      isDisabledOnUpdate: true,
+    },
+    {
+      type: "inheritance",
+      form: personForm,
+      conditions: [
+        {
+          type: "form",
+          elements: [
+            {
+              key: "entityRelated",
+              comparisonOperator: "===",
+              value: "People"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      type: "inheritance",
+      form: companyForm,
+      conditions: [
+        {
+          type: "form",
+          elements: [
+            {
+              key: "entityRelated",
+              comparisonOperator: "===",
+              value: "Companies"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

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

@@ -0,0 +1,50 @@
+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/modules/customer.ts

@@ -0,0 +1,13 @@
+import type { IModule } from "../../interfaces/project.interface";
+import { customerForm } from "../components/forms/customer.form";
+import { customerList } from "../components/lists/customer.list";
+
+export const customerModule: IModule = {
+  title: "Cliente",
+  id: "customerModule",
+  icon: "UserIcon",
+  components: [
+    customerForm,
+    customerList,
+  ]
+}

package/src/examples/projects/movieBackoffice.ts

@@ -1,6 +1,7 @@
 import type { IProject } from "../../interfaces/project.interface";
 import { characterModule } from "../modules/character";
 import { companyModule } from "../modules/company";
+import { customerModule } from "../modules/customer";
 import { movieModule } from "../modules/movie";
 import { personModule } from "../modules/person";
 
@@ -60,6 +61,7 @@ export const movieBackoffice: IProject = {
     baseUrl: "http://localhost:5173",
   },
   modules: [
+    customerModule,
     personModule,
     companyModule,
     movieModule,

package/src/interfaces/{form-condition.interface.ts → condition.interface.ts}

@@ -1,7 +1,7 @@
 import type { IBusinessRule } from "./project.interface";
 
 export interface IFormCondition {
-  type: "form" | "code" | "array" | "button";
+  type: "property" | "enum" | "form" | "code" | "array" | "button";
   elements?: IConditionElement[];
   code?: IConditionCode;
   businessRules?: IBusinessRule[];

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IFormElement } from "./form.interface";
 import type { IBusinessRule } from "./project.interface";
 

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

@@ -1,5 +1,5 @@
 import type { EDataType } from "../enums/form.enum";
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IBusinessRule } from "./project.interface";
 
 export interface IFormAutocomplete {

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IApiRequest } from "./form-input.interface";
 import type { IForm } from "./form.interface";
 import type { IBusinessRule } from "./project.interface";

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IBusinessRule } from "./project.interface";
 
 export interface IFormDatePicker {

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IFormElement } from "./form.interface";
 import type { IBusinessRule } from "./project.interface";
 

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

@@ -1,5 +1,5 @@
 import type { EDataType } from "../enums/form.enum";
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IBusinessRule } from "./project.interface";
 
 interface IStorageConfig {

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IForm } from "./form.interface";
 import type { IBusinessRule } from "./project.interface";
 

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

@@ -3,7 +3,7 @@ import type {
   IApiResponseField,
   IApiResponseFieldFilter,
 } from "./form-autocomplete.interface";
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IBusinessRule } from "./project.interface";
 
 export interface IFormInput {

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IBusinessRule } from "./project.interface";
 
 export interface IFormNumericInput {

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IBusinessRule } from "./project.interface";
 
 export interface IFormPatternInput {

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IBusinessRule } from "./project.interface";
 
 interface IRadioOption {

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IOptionsApi } from "./form-autocomplete.interface";
 import type { IBusinessRule } from "./project.interface";
 import type { EDataType } from "../enums/form.enum";

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IBusinessRule } from "./project.interface";
 
 export interface IFormSwitch {

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

@@ -1,4 +1,4 @@
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IFormElement } from "./form.interface";
 import type { IBusinessRule } from "./project.interface";
 

package/src/interfaces/form.interface.ts

@@ -3,7 +3,7 @@ import type { EDataType } from "../enums/form.enum";
 import type { IFormArray } from "./form-array.interface";
 import type { IFormAutocomplete } from "./form-autocomplete.interface";
 import type { IFormButton } from "./form-button.interface";
-import type { IFormCondition } from "./form-condition.interface";
+import type { IFormCondition } from "./condition.interface";
 import type { IFormDatePicker } from "./form-datepicker.interface";
 import type { IFormFieldset } from "./form-fieldset.interface";
 import type { IFormFile } from "./form-file.interface";

package/src/interfaces/list.interface.ts

@@ -1,3 +1,4 @@
+import type { IFormCondition } from "./condition.interface";
 import type { IApiRequest } from "./form-input.interface";
 import type { IBusinessRule } from "./project.interface";
 
@@ -20,6 +21,7 @@ export interface IList {
             link: string; // e.g.: "/user"
             usePropertyAsQuery?: boolean; // if true then "/user/<email>"
         };
+        conditions?: IFormCondition[];
     }[]; // properties taken from dataSource
     cardAsALink?: {
         link: string; // e.g.: "/user"

package/src/schemas/{form-condition.ref.json → condition.ref.json}

@@ -1,12 +1,12 @@
 {
-  "$id": "form-condition.ref.json",
+  "$id": "condition.ref.json",
   "type": "array",
   "items": {
     "type": "object",
     "properties": {
       "type": {
         "type": "string",
-        "enum": ["form", "code", "array", "button"]
+        "enum": ["property", "enum", "form", "code", "array", "button"]
       },
       "elements": {
         "type": "array",

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

@@ -6,7 +6,7 @@
       "const": "array"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "todo": {
       "type": "string"

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

@@ -40,7 +40,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "validators": {
       "type": "array",
@@ -96,7 +96,7 @@
           "type": "boolean"
         },
         "conditions": {
-          "$ref": "form-condition.ref.json"
+          "$ref": "condition.ref.json"
         },
         "rawQuery": {
           "type": "string"
@@ -157,7 +157,7 @@
             "type": "boolean"
           },
           "conditions": {
-            "$ref": "form-condition.ref.json"
+            "$ref": "condition.ref.json"
           },
           "rawQuery": {
             "type": "string"

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

@@ -39,7 +39,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "apiRequest": {
       "$ref": "form-common-api-request.ref.json"

package/src/schemas/form-common-api-request.ref.json

@@ -19,7 +19,7 @@
       "$ref": "form-common-form-fields-filled-by-api-response.ref.json"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "hasAuthentication": {
       "type": "boolean"

package/src/schemas/form-common-filters-from-other-form-fields.ref.json

@@ -11,7 +11,7 @@
                 "type": "string"
             },
             "conditions": {
-              "$ref": "form-condition.ref.json"
+              "$ref": "condition.ref.json"
             }
         },
         "required": [

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

@@ -40,7 +40,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "todo": {
       "type": "string"

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

@@ -6,7 +6,7 @@
       "const": "fieldset"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "todo": {
       "type": "string"

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

@@ -50,7 +50,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "todo": {
       "type": "string"

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

@@ -11,7 +11,7 @@
       "$ref": "form.ref.json"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "todo": {
       "type": "string"

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

@@ -40,7 +40,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "validators": {
       "type": "array",

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

@@ -50,7 +50,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "todo": {
       "type": "string"

package/src/schemas/form-one-of.ref.json

@@ -16,7 +16,8 @@
       { "$ref": "form-pattern.ref.json" },
       { "$ref": "form-datepicker.ref.json" },
       { "$ref": "form-radiogroup.ref.json" },
-      { "$ref": "form-switch.ref.json" }
+      { "$ref": "form-switch.ref.json" },
+      { "$ref": "form-inheritance.ref.json" }
     ]
   }
-}
+}

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

@@ -29,7 +29,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "todo": {
       "type": "string"

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

@@ -54,7 +54,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "todo": {
       "type": "string"

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

@@ -40,7 +40,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "validators": {
       "type": "array",

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

@@ -29,7 +29,7 @@
       "type": "boolean"
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     },
     "businessRules": {
       "$ref": "business-rules.ref.json"

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

@@ -29,7 +29,7 @@
             "$ref": "form-one-of.ref.json"
           },
           "conditions": {
-            "$ref": "form-condition.ref.json"
+            "$ref": "condition.ref.json"
           }
         },
         "required": [
@@ -40,7 +40,7 @@
       }
     },
     "conditions": {
-      "$ref": "form-condition.ref.json"
+      "$ref": "condition.ref.json"
     }
   },
   "required": [

package/src/schemas/form.ref.json

@@ -125,7 +125,7 @@
             "required": ["entity", "fields"]
           },
           "conditions": {
-            "$ref": "form-condition.ref.json"
+            "$ref": "condition.ref.json"
           }
         },
         "required": ["endpoint", "actions"]

package/src/schemas/list.ref.json

@@ -75,6 +75,9 @@
               }
             },
             "required": ["link"]
+          },
+          "conditions": {
+            "$ref": "condition.ref.json"            
           }
         },
         "required": ["property"]