rapida-partner 1.16.10 → 1.16.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/package.json +1 -1
  2. package/rapidaObject.json +1 -1
  3. package/src/interfaces/form.interface.ts +10 -0
  4. package/src/interfaces/list.interface.ts +10 -0
  5. package/src/schemas/form.ref.json +307 -13
  6. package/src/schemas/list.ref.json +311 -17
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rapida-partner",
3
- "version": "1.16.10",
3
+ "version": "1.16.12",
4
4
  "main": "dist/index.js",
5
5
  "module": "index.ts",
6
6
  "files": [
package/rapidaObject.json CHANGED
@@ -1 +1 @@
1
- {"title":"Fundamento","id":"fundamento","flow":"backofficeByInvitationAndPermissionsByComponent","description":"Backoffice para criação de dados que serão utilizados em diversas outras soluções da Cooperativa Kunlatek, como NCM, CBO ou memso produtos, localizações, animais. Podendo também ser utilizado como um SaaS para quem quiser utilizar estes dados.","frontend":{"framework":"react","uiKit":"flowbite"},"backend":{"framework":"nest","jwtSecret":"Kunl4t3kw1llN3v3rD13M0th3rFudg3r","database":{"provider":"mongodb","connectionString":"mongodb+srv://kunlatek:Kunl4t3kw1llN3v3rD132025@cluster0.b0pfr.mongodb.net/fundamento-v1","credentials":{"databaseName":"fundamento-v1","username":"kunlatek","password":"Kunl4t3kw1llN3v3rD132025","host":"cluster0.b0pfr.mongodb.net"}},"storage":{"provider":"gcs","credentials":{"clientEmail":"rapida-personal@rapida-personal-projects.iam.gserviceaccount.com","privateKey":"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDCDEQRUfKKxYUj\nVorX+aiEHhPRrrcNHVw40qq517wP7IgIp2UlA5uf0rV2cdn1njA9RMQxp6l7Qt+0\nBZg1JZM8l9Uv1SckRlkKST4k2B3MDOEl1riAPxIE/jBCUT9l2DCbir0Nu+CqGhGD\nUXOMpF0XWYL9GIBRo8Paf//yU0b86VBDfQGgnFkMKFq3bVDkPd8hQTBgTFT5F1Rh\nDcoUpAp/n3SYxkAK1V7Je+fnChF1DQPj8Nd5CLm4DsCM1B+HtaegsaE1ulXwhi1J\nlIFFGv49g0f2qOs3hytTPt0d8UpxFd9/Oq0tmcjuzK4bYzJdVZZPf+4xflHz+6R8\n2o7grTeDAgMBAAECggEABHdsz6s/tnMCdARHcN41w0i/8wke/IXK/CHZPSrakNFE\ndlKIEPiKyfx7Ic1QE4e/G4HsNCpkS8qHxKiGTt7dCz2BcjbpTjvyS7rQ298/nFVF\nj23oVEdfXk8NhFFDcNAvmjzwyhKjgrbT5V5oFvonjGSKj9HTDk4DMZHVrdm93g9k\nZ9XJBVeLh14/rkZLMDZ9DVjUMiQ6xElMH3IQD4MwEcul9eqM8bs2APgZlzzfO76m\nAuq20l4JqOcJJl8wzC7z12eNDNJrQNh2sHsT9zV5PabfNoQhnU6fDvKr0PG0PGRR\nS5PTDeiMY47rJVPgwxthSke3abtdgA9SNie8OqZl6QKBgQD+yFT+ndFYKvHg2WNi\ns0jK0QqFQB84LQtOX2YhQ0137mtSv0z7wO90e28dfUqsjax4DxPMp+AW0cC3SBEv\n2T8/rJrgzGucPt4Jzml5HYl2NgCkNAtHIJ1vtXJdX5d3WmYhH7cUTPmV6nMS8OlF\nheSyfudCiOo89phQf0pI6lhQKwKBgQDC+aOU2cxMVA5VH0txX0G9tPQjBvzY09ev\nVLGrxlmdAcQVXYCWdoESEfTv3E4JPklAz5B2/XnALxM5ewJgjoP6buOCJrQcgJNC\nSsG9Ll3zF4c+opFmaYTzcAY9HWHa4Pc+GAxFrrcPGzVBLjSrl7FPdykkPiBNxNJa\nnOzzrL4yCQKBgQC7b/pHjycx6/YiawuY0zjcLMnGmhPdqhXFRJ3IHtFhR/+g0qf6\nFkiTszNdyI0lQNz/PmhciaxsXUegDt7GCtdjKsKOWxVXz1BeeoJR3g8A7l2ub7NU\nUoRAaIaIdwjhf5nfCIwR3UdIqUCbUKzsvsIvJvlPk5Zv3yLTJbIqzmzGHQKBgBiQ\nnUSGwE+pk3i0DaxGBSFiqBO1sKuc3SLQ9+WdgvLeIxdSBX5vhcmCC6sgxZAykcYh\noKDtRKarB7AJSH5j1kr6J53hRHYG2QbUJl6wddPH1hlVIB6YEtEc/xw6FHcgOuZO\n31T0M0oq8mW47Zfk78kESWGwlh9WOe6CsPPugrQJAoGBAP3o8DqH1Pb7vlowsz78\n8fsCuydEJgsPSwHHqBveeUHBQLGSiGIIKRXWR1a13mWXQTqQkROZCwvVCMX6FHZZ\nKv3rzgsTkaaoqM0RVLcQSSDoyu2yP/JJv+VYsvMf2S3dUkDAeYDZFizPeFF42t92\n+MSId41OkBvJ/JvqsBWlWFYK\n-----END PRIVATE KEY-----\n","projectId":"rapida-personal-projects"},"publicBucketName":"rapida-public-files","privateBucketName":"rapida-private-files"},"logging":{"discordWebhookUrl":"https://discord.com/api/webhooks/1370095507959054429/Ay8pIM-sinbjsLMAAWGrRDFT-oyBD3xu7yB2Ke0Bx6RxpKN882taB4_tkD2xsdk8MirZ"},"email":{"smtpUser":"noreply.rapida@gmail.com","smtpPass":"ekgwxlazvjjllfxf","smtpFrom":"noreply@kunlatek.com"},"baseUrl":"http://localhost:5173"},"modules":[{"id":"testModule","title":"Test","icon":"test","components":[{"title":"Gerenciar teste","id":"testForm","componentType":"form","elements":[{"type":"autocomplete","dataType":"uniqueidentifier","label":"Seção do NCM","name":"ncmSectionId","optionsApi":{"relatedEntity":"NcmSection","labelField":["code","description"],"valueField":"_id","paramsToFilter":["description","code"],"paramType":"query","endpoint":"/ncm-sections"}},{"type":"autocomplete","dataType":"uniqueidentifier","label":"Posição do NCM","name":"ncmPositionId","optionsApi":{"relatedEntity":"NcmPosition","labelField":["code","description"],"valueField":"_id","paramsToFilter":["description","code"],"paramType":"query","endpoint":"/ncm-positions","filtersFromOtherFormFields":[{"formFieldName":"ncmSectionId","filterPropertyName":"sectionId"}]}},{"type":"autocomplete","dataType":"uniqueidentifier","label":"Subposição do NCM","name":"ncmSubPositionId","optionsApi":{"relatedEntity":"NcmSubPosition","labelField":["code","description"],"valueField":"_id","paramsToFilter":["description","code"],"paramType":"query","endpoint":"/ncm-sub-positions","filtersFromOtherFormFields":[{"formFieldName":"ncmPositionId","filterPropertyName":"positionId"}]}}],"contracts":[{"id":"tests","endpoint":"/tests","actions":["create","get","getById","update","softDelete"],"request":{"entity":"Tests","fields":[]}}]},{"title":"Listar testes","id":"testList","componentType":"list","dataSource":{"endpoint":"/tests","paramType":"query"},"listItems":[{"label":"Seção do NCM","property":"ncmSection.description","dataType":"nvarchar","type":"title"},{"label":"Posição do NCM","property":"ncmPosition.description","dataType":"nvarchar","type":"subtitle"},{"label":"Subposição do NCM","property":"ncmSubPosition.description","dataType":"nvarchar","type":"subtitle"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/test-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/test-list"},"request":{"endpoint":"/tests","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir item","message":"Deseja realmente excluir esse item?"}}}}],"contracts":[]}]},{"id":"ncmModule","title":"NCM","icon":"inventory_2","components":[{"title":"Gerenciar da NCM","id":"ncmSectionForm","componentType":"form","elements":[{"label":"Descrição","name":"description","type":"input","dataType":"nvarchar","isRequired":true},{"label":"Código","name":"code","type":"input","dataType":"nvarchar","isRequired":true,"isUnique":true}],"contracts":[{"id":"ncmSections","endpoint":"/ncm-sections","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmSections","fields":[]}}]},{"title":"Gerenciar da NCM","id":"ncmPositionForm","componentType":"form","elements":[{"type":"autocomplete","label":"Seção","name":"ncmSectionId","dataType":"uniqueidentifier","isRequired":true,"optionsApi":{"relatedEntity":"NcmSections","paramType":"query","endpoint":"/ncm-sections","labelField":["description"],"valueField":"_id","paramsToFilter":["description"]}},{"label":"Descrição","name":"description","type":"input","dataType":"nvarchar","isRequired":true},{"label":"Código","name":"code","type":"input","dataType":"nvarchar","isRequired":true,"isUnique":true}],"contracts":[{"id":"ncmPositions","endpoint":"/ncm-positions","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmPositions","fields":[]}}]},{"title":"Gerenciar subposição da NCM","id":"ncmSubpositionForm","componentType":"form","guards":"isAuthorized","elements":[{"type":"autocomplete","label":"Posição","name":"ncmPositionId","dataType":"uniqueidentifier","isRequired":true,"optionsApi":{"relatedEntity":"NcmPositions","paramType":"query","endpoint":"/ncm-positions","labelField":["code","description"],"valueField":"_id","paramsToFilter":["code","description"]}},{"type":"input","dataType":"nvarchar","label":"Descrição","name":"description","isRequired":true},{"type":"input","dataType":"nvarchar","label":"Código","name":"code","isUnique":true}],"contracts":[{"id":"ncmSubpositions","endpoint":"/ncm-subpositions","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmSubpositions","fields":[]}}]},{"title":"Gerenciar item da NCM","id":"ncmItemForm","componentType":"form","guards":"isAuthorized","elements":[{"type":"autocomplete","label":"Subposição","name":"ncmSubpositionId","dataType":"uniqueidentifier","isRequired":true,"optionsApi":{"relatedEntity":"NcmSubpositions","paramType":"query","endpoint":"/ncm-subpositions","labelField":["code","description"],"valueField":"_id","paramsToFilter":["code","description"]}},{"type":"input","dataType":"nvarchar","label":"Descrição","name":"description","isRequired":true},{"type":"input","dataType":"nvarchar","label":"Código","name":"code","isUnique":true}],"contracts":[{"id":"ncmItems","endpoint":"/ncm-items","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmItems","fields":[]}}]},{"title":"Gerenciar subitem da NCM","id":"ncmSubitemForm","componentType":"form","guards":"isAuthorized","elements":[{"type":"autocomplete","label":"Item","name":"ncmItemId","dataType":"uniqueidentifier","isRequired":true,"optionsApi":{"relatedEntity":"NcmItems","paramType":"query","endpoint":"/ncm-items","labelField":["code","description"],"valueField":"_id","paramsToFilter":["code","description"]}},{"type":"input","dataType":"nvarchar","label":"Descrição","name":"description","isRequired":true},{"type":"input","dataType":"nvarchar","label":"Código","name":"code","isUnique":true}],"contracts":[{"id":"ncmSubitems","endpoint":"/ncm-subitems","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmSubitems","fields":[]}}]},{"componentType":"list","id":"ncmSectionList","title":"Lista de seções da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-sections","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-section-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-section-list"},"request":{"endpoint":"/ncm-sections","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]},{"componentType":"list","id":"ncmPositionList","title":"Lista de posições da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-positions","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"},{"property":"ncmSection.code","type":"title","label":"Código da seção","dataType":"nvarchar"},{"property":"ncmSection.description","type":"subtitle","label":"Descrição da seção","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-position-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-position-list"},"request":{"endpoint":"/ncm-positions","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]},{"componentType":"list","id":"ncmSubpositionList","title":"Lista de subposições da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-subpositions","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"},{"property":"ncmPosition.code","type":"title","label":"Código da posição","dataType":"nvarchar"},{"property":"ncmPosition.description","type":"subtitle","label":"Descrição da posição","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-subposition-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-subposition-list"},"request":{"endpoint":"/ncm-subpositions","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]},{"componentType":"list","id":"ncmItemList","title":"Lista de itens da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-items","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"},{"property":"ncmSubposition.code","type":"title","label":"Código da subposição","dataType":"nvarchar"},{"property":"ncmSubposition.description","type":"subtitle","label":"Descrição da subposição","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-subposition-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-subposition-list"},"request":{"endpoint":"/ncm-subpositions","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]},{"componentType":"list","id":"ncmSubitemList","title":"Lista de subitens da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-subitems","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"},{"property":"ncmItem.code","type":"title","label":"Código do item","dataType":"nvarchar"},{"property":"ncmItem.description","type":"subtitle","label":"Descrição do item","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-subposition-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-subposition-list"},"request":{"endpoint":"/ncm-subpositions","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]}]}]}
1
+ {"title":"Fundamento","id":"fundamento","flow":"backofficeByInvitationAndPermissionsByComponent","description":"Backoffice para criação de dados que serão utilizados em diversas outras soluções da Cooperativa Kunlatek, como NCM, CBO ou memso produtos, localizações, animais. Podendo também ser utilizado como um SaaS para quem quiser utilizar estes dados.","frontend":{"framework":"react","uiKit":"flowbite"},"backend":{"framework":"nest","jwtSecret":"Kunl4t3kw1llN3v3rD13M0th3rFudg3r","database":{"provider":"mongodb","connectionString":"mongodb+srv://kunlatek:Kunl4t3kw1llN3v3rD132025@cluster0.b0pfr.mongodb.net/fundamento-v1","credentials":{"databaseName":"fundamento-v1","username":"kunlatek","password":"Kunl4t3kw1llN3v3rD132025","host":"cluster0.b0pfr.mongodb.net"}},"storage":{"provider":"gcs","credentials":{"clientEmail":"rapida-personal@rapida-personal-projects.iam.gserviceaccount.com","privateKey":"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDCDEQRUfKKxYUj\nVorX+aiEHhPRrrcNHVw40qq517wP7IgIp2UlA5uf0rV2cdn1njA9RMQxp6l7Qt+0\nBZg1JZM8l9Uv1SckRlkKST4k2B3MDOEl1riAPxIE/jBCUT9l2DCbir0Nu+CqGhGD\nUXOMpF0XWYL9GIBRo8Paf//yU0b86VBDfQGgnFkMKFq3bVDkPd8hQTBgTFT5F1Rh\nDcoUpAp/n3SYxkAK1V7Je+fnChF1DQPj8Nd5CLm4DsCM1B+HtaegsaE1ulXwhi1J\nlIFFGv49g0f2qOs3hytTPt0d8UpxFd9/Oq0tmcjuzK4bYzJdVZZPf+4xflHz+6R8\n2o7grTeDAgMBAAECggEABHdsz6s/tnMCdARHcN41w0i/8wke/IXK/CHZPSrakNFE\ndlKIEPiKyfx7Ic1QE4e/G4HsNCpkS8qHxKiGTt7dCz2BcjbpTjvyS7rQ298/nFVF\nj23oVEdfXk8NhFFDcNAvmjzwyhKjgrbT5V5oFvonjGSKj9HTDk4DMZHVrdm93g9k\nZ9XJBVeLh14/rkZLMDZ9DVjUMiQ6xElMH3IQD4MwEcul9eqM8bs2APgZlzzfO76m\nAuq20l4JqOcJJl8wzC7z12eNDNJrQNh2sHsT9zV5PabfNoQhnU6fDvKr0PG0PGRR\nS5PTDeiMY47rJVPgwxthSke3abtdgA9SNie8OqZl6QKBgQD+yFT+ndFYKvHg2WNi\ns0jK0QqFQB84LQtOX2YhQ0137mtSv0z7wO90e28dfUqsjax4DxPMp+AW0cC3SBEv\n2T8/rJrgzGucPt4Jzml5HYl2NgCkNAtHIJ1vtXJdX5d3WmYhH7cUTPmV6nMS8OlF\nheSyfudCiOo89phQf0pI6lhQKwKBgQDC+aOU2cxMVA5VH0txX0G9tPQjBvzY09ev\nVLGrxlmdAcQVXYCWdoESEfTv3E4JPklAz5B2/XnALxM5ewJgjoP6buOCJrQcgJNC\nSsG9Ll3zF4c+opFmaYTzcAY9HWHa4Pc+GAxFrrcPGzVBLjSrl7FPdykkPiBNxNJa\nnOzzrL4yCQKBgQC7b/pHjycx6/YiawuY0zjcLMnGmhPdqhXFRJ3IHtFhR/+g0qf6\nFkiTszNdyI0lQNz/PmhciaxsXUegDt7GCtdjKsKOWxVXz1BeeoJR3g8A7l2ub7NU\nUoRAaIaIdwjhf5nfCIwR3UdIqUCbUKzsvsIvJvlPk5Zv3yLTJbIqzmzGHQKBgBiQ\nnUSGwE+pk3i0DaxGBSFiqBO1sKuc3SLQ9+WdgvLeIxdSBX5vhcmCC6sgxZAykcYh\noKDtRKarB7AJSH5j1kr6J53hRHYG2QbUJl6wddPH1hlVIB6YEtEc/xw6FHcgOuZO\n31T0M0oq8mW47Zfk78kESWGwlh9WOe6CsPPugrQJAoGBAP3o8DqH1Pb7vlowsz78\n8fsCuydEJgsPSwHHqBveeUHBQLGSiGIIKRXWR1a13mWXQTqQkROZCwvVCMX6FHZZ\nKv3rzgsTkaaoqM0RVLcQSSDoyu2yP/JJv+VYsvMf2S3dUkDAeYDZFizPeFF42t92\n+MSId41OkBvJ/JvqsBWlWFYK\n-----END PRIVATE KEY-----\n","projectId":"rapida-personal-projects"},"publicBucketName":"rapida-public-files","privateBucketName":"rapida-private-files"},"logging":{"discordWebhookUrl":"https://discord.com/api/webhooks/1370095507959054429/Ay8pIM-sinbjsLMAAWGrRDFT-oyBD3xu7yB2Ke0Bx6RxpKN882taB4_tkD2xsdk8MirZ"},"email":{"smtpUser":"noreply.rapida@gmail.com","smtpPass":"ekgwxlazvjjllfxf","smtpFrom":"noreply@kunlatek.com"},"baseUrl":"http://localhost:5173"},"modules":[{"id":"testModule","title":"Test","icon":"test","components":[{"title":"Gerenciar teste","id":"testForm","componentType":"form","elements":[{"type":"autocomplete","dataType":"uniqueidentifier","label":"Seção do NCM","name":"ncmSectionId","optionsApi":{"relatedEntity":"NcmSection","labelField":["code","description"],"valueField":"_id","paramsToFilter":["description","code"],"paramType":"query","endpoint":"/ncm-sections"},"elementsToClearOnValueChange":["ncmPositionId","ncmSubPositionId"]},{"type":"autocomplete","dataType":"uniqueidentifier","label":"Posição do NCM","name":"ncmPositionId","optionsApi":{"relatedEntity":"NcmPosition","labelField":["code","description"],"valueField":"_id","paramsToFilter":["description","code"],"paramType":"query","endpoint":"/ncm-positions","filtersFromOtherFormFields":[{"formFieldName":"ncmSectionId","filterPropertyName":"ncmSectionId"}]},"elementsToClearOnValueChange":["ncmSubPositionId"]},{"type":"autocomplete","dataType":"uniqueidentifier","label":"Subposição do NCM","name":"ncmSubPositionId","optionsApi":{"relatedEntity":"NcmSubPosition","labelField":["code","description"],"valueField":"_id","paramsToFilter":["description","code"],"paramType":"query","endpoint":"/ncm-subpositions","filtersFromOtherFormFields":[{"formFieldName":"ncmPositionId","filterPropertyName":"ncmPositionId"}]}}],"contracts":[{"id":"tests","endpoint":"/tests","actions":["create","get","getById","update","softDelete"],"request":{"entity":"Tests","fields":[]}}]},{"title":"Listar testes","id":"testList","componentType":"list","dataSource":{"endpoint":"/tests","paramType":"query"},"listItems":[{"label":"Seção do NCM","property":"ncmSection.description","dataType":"nvarchar","type":"title"},{"label":"Posição do NCM","property":"ncmPosition.description","dataType":"nvarchar","type":"subtitle"},{"label":"Subposição do NCM","property":"ncmSubPosition.description","dataType":"nvarchar","type":"subtitle"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/test-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/test-list"},"request":{"endpoint":"/tests","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir item","message":"Deseja realmente excluir esse item?"}}}}],"contracts":[]}]},{"id":"ncmModule","title":"NCM","icon":"inventory_2","components":[{"title":"Gerenciar da NCM","id":"ncmSectionForm","componentType":"form","elements":[{"label":"Descrição","name":"description","type":"input","dataType":"nvarchar","isRequired":true},{"label":"Código","name":"code","type":"input","dataType":"nvarchar","isRequired":true,"isUnique":true}],"contracts":[{"id":"ncmSections","endpoint":"/ncm-sections","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmSections","fields":[]}}]},{"title":"Gerenciar da NCM","id":"ncmPositionForm","componentType":"form","elements":[{"type":"autocomplete","label":"Seção","name":"ncmSectionId","dataType":"uniqueidentifier","isRequired":true,"optionsApi":{"relatedEntity":"NcmSections","paramType":"query","endpoint":"/ncm-sections","labelField":["description"],"valueField":"_id","paramsToFilter":["description"]}},{"label":"Descrição","name":"description","type":"input","dataType":"nvarchar","isRequired":true},{"label":"Código","name":"code","type":"input","dataType":"nvarchar","isRequired":true,"isUnique":true}],"contracts":[{"id":"ncmPositions","endpoint":"/ncm-positions","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmPositions","fields":[]}}]},{"title":"Gerenciar subposição da NCM","id":"ncmSubpositionForm","componentType":"form","guards":"isAuthorized","elements":[{"type":"autocomplete","label":"Posição","name":"ncmPositionId","dataType":"uniqueidentifier","isRequired":true,"optionsApi":{"relatedEntity":"NcmPositions","paramType":"query","endpoint":"/ncm-positions","labelField":["code","description"],"valueField":"_id","paramsToFilter":["code","description"]}},{"type":"input","dataType":"nvarchar","label":"Descrição","name":"description","isRequired":true},{"type":"input","dataType":"nvarchar","label":"Código","name":"code","isUnique":true}],"contracts":[{"id":"ncmSubpositions","endpoint":"/ncm-subpositions","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmSubpositions","fields":[]}}]},{"title":"Gerenciar item da NCM","id":"ncmItemForm","componentType":"form","guards":"isAuthorized","elements":[{"type":"autocomplete","label":"Subposição","name":"ncmSubpositionId","dataType":"uniqueidentifier","isRequired":true,"optionsApi":{"relatedEntity":"NcmSubpositions","paramType":"query","endpoint":"/ncm-subpositions","labelField":["code","description"],"valueField":"_id","paramsToFilter":["code","description"]}},{"type":"input","dataType":"nvarchar","label":"Descrição","name":"description","isRequired":true},{"type":"input","dataType":"nvarchar","label":"Código","name":"code","isUnique":true}],"contracts":[{"id":"ncmItems","endpoint":"/ncm-items","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmItems","fields":[]}}]},{"title":"Gerenciar subitem da NCM","id":"ncmSubitemForm","componentType":"form","guards":"isAuthorized","elements":[{"type":"autocomplete","label":"Item","name":"ncmItemId","dataType":"uniqueidentifier","isRequired":true,"optionsApi":{"relatedEntity":"NcmItems","paramType":"query","endpoint":"/ncm-items","labelField":["code","description"],"valueField":"_id","paramsToFilter":["code","description"]}},{"type":"input","dataType":"nvarchar","label":"Descrição","name":"description","isRequired":true},{"type":"input","dataType":"nvarchar","label":"Código","name":"code","isUnique":true}],"contracts":[{"id":"ncmSubitems","endpoint":"/ncm-subitems","actions":["create","update","get","getById","softDelete"],"request":{"entity":"NcmSubitems","fields":[]}}]},{"componentType":"list","id":"ncmSectionList","title":"Lista de seções da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-sections","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-section-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-section-list"},"request":{"endpoint":"/ncm-sections","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]},{"componentType":"list","id":"ncmPositionList","title":"Lista de posições da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-positions","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"},{"property":"ncmSection.code","type":"title","label":"Código da seção","dataType":"nvarchar"},{"property":"ncmSection.description","type":"subtitle","label":"Descrição da seção","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-position-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-position-list"},"request":{"endpoint":"/ncm-positions","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]},{"componentType":"list","id":"ncmSubpositionList","title":"Lista de subposições da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-subpositions","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"},{"property":"ncmPosition.code","type":"title","label":"Código da posição","dataType":"nvarchar"},{"property":"ncmPosition.description","type":"subtitle","label":"Descrição da posição","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-subposition-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-subposition-list"},"request":{"endpoint":"/ncm-subpositions","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]},{"componentType":"list","id":"ncmItemList","title":"Lista de itens da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-items","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"},{"property":"ncmSubposition.code","type":"title","label":"Código da subposição","dataType":"nvarchar"},{"property":"ncmSubposition.description","type":"subtitle","label":"Descrição da subposição","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-subposition-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-subposition-list"},"request":{"endpoint":"/ncm-subpositions","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]},{"componentType":"list","id":"ncmSubitemList","title":"Lista de subitens da NCM","guards":["isAuthorized"],"dataSource":{"endpoint":"/ncm-subitems","paramType":"query","hasAuthentication":true},"listItems":[{"property":"code","type":"title","label":"Código","dataType":"nvarchar"},{"property":"description","type":"subtitle","label":"Descrição","dataType":"nvarchar"},{"property":"ncmItem.code","type":"title","label":"Código do item","dataType":"nvarchar"},{"property":"ncmItem.description","type":"subtitle","label":"Descrição do item","dataType":"nvarchar"}],"callsToActionMenu":[{"label":"Editar","icon":"pencil","action":{"link":{"endpoint":"/ncm-subposition-form","propertiesAsQueryParam":["id"]}}},{"label":"Excluir","icon":"trash","action":{"link":{"endpoint":"/ncm-subposition-list"},"request":{"endpoint":"/ncm-subpositions","verb":"softDelete","propertiesAsPathParam":["id"],"dialog":{"title":"Excluir conteúdo","message":"Deseja realmente excluir esse conteúdo?"}}}}],"contracts":[]}]}]}
package/src/interfaces/form.interface.ts CHANGED
@@ -31,6 +31,16 @@ export interface IForm {
31
31
  businessRules?: IBusinessRule[];
32
32
  userStory?: string;
33
33
  }[];
34
+ publicContracts: {
35
+ id: string;
36
+ endpoint: string;
37
+ actions: ("create" | "get" | "getById" | "update" | "softDelete" | "hardDelete" | "clone" | "sendEmail")[];
38
+ permissionedUrls: string[];
39
+ request?: IContractRequest;
40
+ conditions?: IFormCondition;
41
+ businessRules?: IBusinessRule[];
42
+ userStory?: string;
43
+ }[];
34
44
  flowChart?: IFlowChart;
35
45
  }
36
46
 
package/src/interfaces/list.interface.ts CHANGED
@@ -90,4 +90,14 @@ export interface IList {
90
90
  businessRules?: IBusinessRule[];
91
91
  userStory?: string;
92
92
  }[];
93
+ publicContracts: {
94
+ id: string;
95
+ endpoint: string;
96
+ actions: ("create" | "get" | "getById" | "update" | "softDelete" | "hardDelete" | "clone" | "sendEmail")[];
97
+ permissionedUrls: string[];
98
+ request?: IContractRequest;
99
+ conditions?: IFormCondition;
100
+ businessRules?: IBusinessRule[];
101
+ userStory?: string;
102
+ }[];
93
103
  }
package/src/schemas/form.ref.json CHANGED
@@ -17,7 +17,10 @@
17
17
  },
18
18
  "guards": {
19
19
  "type": "string",
20
- "enum": ["isAuthenticated", "isAuthorized"]
20
+ "enum": [
21
+ "isAuthenticated",
22
+ "isAuthorized"
23
+ ]
21
24
  },
22
25
  "businessRules": {
23
26
  "$ref": "business-rules.ref.json"
@@ -43,7 +46,16 @@
43
46
  "type": "array",
44
47
  "items": {
45
48
  "type": "string",
46
- "enum": ["create", "get", "getById", "update", "softDelete", "hardDelete", "clone", "sendEmail"]
49
+ "enum": [
50
+ "create",
51
+ "get",
52
+ "getById",
53
+ "update",
54
+ "softDelete",
55
+ "hardDelete",
56
+ "clone",
57
+ "sendEmail"
58
+ ]
47
59
  }
48
60
  },
49
61
  "request": {
@@ -90,7 +102,11 @@
90
102
  },
91
103
  "relationship": {
92
104
  "type": "string",
93
- "enum": ["one-to-one", "one-to-many", "many-to-many"]
105
+ "enum": [
106
+ "one-to-one",
107
+ "one-to-many",
108
+ "many-to-many"
109
+ ]
94
110
  },
95
111
  "fields": {
96
112
  "type": "array",
@@ -104,7 +120,10 @@
104
120
  "$ref": "types-datatype.ref.json"
105
121
  }
106
122
  },
107
- "required": ["name", "dataType"]
123
+ "required": [
124
+ "name",
125
+ "dataType"
126
+ ]
108
127
  }
109
128
  },
110
129
  "isHidden": {
@@ -169,7 +188,10 @@
169
188
  "$ref": "business-rules.ref.json"
170
189
  }
171
190
  },
172
- "required": ["name", "dataType"]
191
+ "required": [
192
+ "name",
193
+ "dataType"
194
+ ]
173
195
  }
174
196
  },
175
197
  "relatedEntity": {
@@ -196,7 +218,10 @@
196
218
  }
197
219
  }
198
220
  },
199
- "required": ["fields", "contractId"]
221
+ "required": [
222
+ "fields",
223
+ "contractId"
224
+ ]
200
225
  }
201
226
  },
202
227
  "required": [
@@ -223,7 +248,10 @@
223
248
  }
224
249
  }
225
250
  },
226
- "required": ["entity", "fields"]
251
+ "required": [
252
+ "entity",
253
+ "fields"
254
+ ]
227
255
  },
228
256
  "conditions": {
229
257
  "$ref": "condition.ref.json"
@@ -235,7 +263,256 @@
235
263
  "type": "string"
236
264
  }
237
265
  },
238
- "required": ["id", "endpoint", "actions"]
266
+ "required": [
267
+ "id",
268
+ "endpoint",
269
+ "actions"
270
+ ]
271
+ }
272
+ },
273
+ "publicContracts": {
274
+ "type": "array",
275
+ "items": {
276
+ "type": "object",
277
+ "properties": {
278
+ "id": {
279
+ "type": "string"
280
+ },
281
+ "endpoint": {
282
+ "type": "string"
283
+ },
284
+ "actions": {
285
+ "type": "array",
286
+ "items": {
287
+ "type": "string",
288
+ "enum": [
289
+ "create",
290
+ "get",
291
+ "getById",
292
+ "update",
293
+ "softDelete",
294
+ "hardDelete",
295
+ "clone",
296
+ "sendEmail"
297
+ ]
298
+ }
299
+ },
300
+ "permissionedUrls": {
301
+ "type": "array",
302
+ "items": {
303
+ "type": "string"
304
+ }
305
+ },
306
+ "request": {
307
+ "type": "object",
308
+ "properties": {
309
+ "entity": {
310
+ "type": "string"
311
+ },
312
+ "description": {
313
+ "type": "string"
314
+ },
315
+ "fields": {
316
+ "type": "array",
317
+ "items": {
318
+ "type": "object",
319
+ "properties": {
320
+ "name": {
321
+ "type": "string"
322
+ },
323
+ "dataType": {
324
+ "$ref": "types-datatype.ref.json"
325
+ },
326
+ "isRequired": {
327
+ "type": "boolean"
328
+ },
329
+ "requiredOneOf": {
330
+ "type": "array",
331
+ "items": {
332
+ "type": "string"
333
+ }
334
+ },
335
+ "isHidden": {
336
+ "type": "boolean",
337
+ "description": "If true, the attribute will not be exposed in the API."
338
+ },
339
+ "foreignKey": {
340
+ "type": "object",
341
+ "properties": {
342
+ "entity": {
343
+ "type": "string"
344
+ },
345
+ "connectionAttribute": {
346
+ "type": "string"
347
+ },
348
+ "relationship": {
349
+ "type": "string",
350
+ "enum": [
351
+ "one-to-one",
352
+ "one-to-many",
353
+ "many-to-many"
354
+ ]
355
+ },
356
+ "fields": {
357
+ "type": "array",
358
+ "items": {
359
+ "type": "object",
360
+ "properties": {
361
+ "name": {
362
+ "type": "string"
363
+ },
364
+ "dataType": {
365
+ "$ref": "types-datatype.ref.json"
366
+ }
367
+ },
368
+ "required": [
369
+ "name",
370
+ "dataType"
371
+ ]
372
+ }
373
+ },
374
+ "isHidden": {
375
+ "type": "boolean",
376
+ "description": "If true, the connection attribute will not be exposed in the API."
377
+ }
378
+ },
379
+ "required": [
380
+ "entity",
381
+ "connectionAttribute",
382
+ "relationship"
383
+ ]
384
+ },
385
+ "isPrimaryKey": {
386
+ "type": "boolean"
387
+ },
388
+ "minSize": {
389
+ "type": "number"
390
+ },
391
+ "maxSize": {
392
+ "type": "number"
393
+ },
394
+ "enum": {
395
+ "type": "array",
396
+ "items": {
397
+ "oneOf": [
398
+ {
399
+ "type": "string"
400
+ },
401
+ {
402
+ "type": "number"
403
+ }
404
+ ]
405
+ }
406
+ },
407
+ "isUnique": {
408
+ "type": "boolean"
409
+ },
410
+ "uniqueComposedFields": {
411
+ "type": "array",
412
+ "items": {
413
+ "type": "string"
414
+ }
415
+ },
416
+ "actionsExceptions": {
417
+ "type": "array",
418
+ "items": {
419
+ "type": "string",
420
+ "enum": [
421
+ "create",
422
+ "get",
423
+ "getById",
424
+ "update",
425
+ "softDelete",
426
+ "hardDelete",
427
+ "clone",
428
+ "sendEmail"
429
+ ]
430
+ }
431
+ },
432
+ "businessRules": {
433
+ "$ref": "business-rules.ref.json"
434
+ }
435
+ },
436
+ "required": [
437
+ "name",
438
+ "dataType"
439
+ ]
440
+ }
441
+ },
442
+ "relatedEntity": {
443
+ "type": "object",
444
+ "properties": {
445
+ "entity": {
446
+ "type": "string",
447
+ "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."
448
+ },
449
+ "connectionAttribute": {
450
+ "type": "string",
451
+ "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."
452
+ },
453
+ "fieldsFromEntity": {
454
+ "type": "array",
455
+ "items": {
456
+ "type": "object",
457
+ "properties": {
458
+ "fields": {
459
+ "$ref": "form.ref.json"
460
+ },
461
+ "contractId": {
462
+ "type": "string"
463
+ }
464
+ }
465
+ },
466
+ "required": [
467
+ "fields",
468
+ "contractId"
469
+ ]
470
+ }
471
+ },
472
+ "required": [
473
+ "entity",
474
+ "connectionAttribute",
475
+ "fieldsFromEntity"
476
+ ]
477
+ },
478
+ "uniqueConstraints": {
479
+ "type": "array",
480
+ "items": {
481
+ "type": "object",
482
+ "properties": {
483
+ "name": {
484
+ "type": "string"
485
+ },
486
+ "fields": {
487
+ "type": "array",
488
+ "items": {
489
+ "type": "string"
490
+ }
491
+ }
492
+ }
493
+ }
494
+ }
495
+ },
496
+ "required": [
497
+ "entity",
498
+ "fields"
499
+ ]
500
+ },
501
+ "conditions": {
502
+ "$ref": "condition.ref.json"
503
+ },
504
+ "businessRules": {
505
+ "$ref": "business-rules.ref.json"
506
+ },
507
+ "userStory": {
508
+ "type": "string"
509
+ }
510
+ },
511
+ "required": [
512
+ "id",
513
+ "endpoint",
514
+ "actions"
515
+ ]
239
516
  }
240
517
  },
241
518
  "flowChart": {
@@ -246,7 +523,11 @@
246
523
  "properties": {
247
524
  "status": {
248
525
  "type": "string",
249
- "enum": ["toDo", "inProgress", "done"]
526
+ "enum": [
527
+ "toDo",
528
+ "inProgress",
529
+ "done"
530
+ ]
250
531
  },
251
532
  "assignesIds": {
252
533
  "type": "array",
@@ -272,15 +553,28 @@
272
553
  },
273
554
  "priority": {
274
555
  "type": "string",
275
- "enum": ["low", "medium", "high", "urgent"]
556
+ "enum": [
557
+ "low",
558
+ "medium",
559
+ "high",
560
+ "urgent"
561
+ ]
276
562
  },
277
563
  "storyPoints": {
278
564
  "type": "number",
279
565
  "minimum": 0
280
566
  }
281
567
  },
282
- "required": ["status"]
568
+ "required": [
569
+ "status"
570
+ ]
283
571
  }
284
572
  },
285
- "required": ["componentType", "id", "title", "elements", "contracts"]
286
- }
573
+ "required": [
574
+ "componentType",
575
+ "id",
576
+ "title",
577
+ "elements",
578
+ "contracts"
579
+ ]
580
+ }
package/src/schemas/list.ref.json CHANGED
@@ -53,7 +53,7 @@
53
53
  "video",
54
54
  "image",
55
55
  "images",
56
- "icon",
56
+ "icon",
57
57
  "badge"
58
58
  ]
59
59
  },
@@ -88,7 +88,9 @@
88
88
  "description": "if true then '/user/<email>'"
89
89
  }
90
90
  },
91
- "required": ["link"]
91
+ "required": [
92
+ "link"
93
+ ]
92
94
  },
93
95
  "conditions": {
94
96
  "$ref": "condition.ref.json"
@@ -124,7 +126,9 @@
124
126
  "description": "if, for example, ['_id', 'email'], then '/user/<_id>/<email>'"
125
127
  }
126
128
  },
127
- "required": ["link"]
129
+ "required": [
130
+ "link"
131
+ ]
128
132
  },
129
133
  "callsToActionMenu": {
130
134
  "type": "array",
@@ -164,7 +168,9 @@
164
168
  "description": "if, for example, ['_id', 'email'], then '/user/<_id>/<email>'"
165
169
  }
166
170
  },
167
- "required": ["endpoint"]
171
+ "required": [
172
+ "endpoint"
173
+ ]
168
174
  },
169
175
  "request": {
170
176
  "type": "object",
@@ -189,7 +195,12 @@
189
195
  },
190
196
  "verb": {
191
197
  "type": "string",
192
- "enum": ["get", "post", "put", "softDelete"]
198
+ "enum": [
199
+ "get",
200
+ "post",
201
+ "put",
202
+ "softDelete"
203
+ ]
193
204
  },
194
205
  "dialog": {
195
206
  "type": "object",
@@ -201,13 +212,21 @@
201
212
  "type": "string"
202
213
  }
203
214
  },
204
- "required": ["title", "message"]
215
+ "required": [
216
+ "title",
217
+ "message"
218
+ ]
205
219
  }
206
220
  },
207
- "required": ["endpoint", "verb"]
221
+ "required": [
222
+ "endpoint",
223
+ "verb"
224
+ ]
208
225
  }
209
226
  },
210
- "required": ["link"]
227
+ "required": [
228
+ "link"
229
+ ]
211
230
  },
212
231
  "businessRules": {
213
232
  "$ref": "business-rules.ref.json"
@@ -219,7 +238,11 @@
219
238
  "type": "string"
220
239
  }
221
240
  },
222
- "required": ["icon", "label", "action"]
241
+ "required": [
242
+ "icon",
243
+ "label",
244
+ "action"
245
+ ]
223
246
  }
224
247
  },
225
248
  "listActions": {
@@ -299,7 +322,11 @@
299
322
  },
300
323
  "relationship": {
301
324
  "type": "string",
302
- "enum": ["one-to-one", "one-to-many", "many-to-many"]
325
+ "enum": [
326
+ "one-to-one",
327
+ "one-to-many",
328
+ "many-to-many"
329
+ ]
303
330
  },
304
331
  "fields": {
305
332
  "type": "array",
@@ -313,7 +340,10 @@
313
340
  "$ref": "types-datatype.ref.json"
314
341
  }
315
342
  },
316
- "required": ["name", "dataType"]
343
+ "required": [
344
+ "name",
345
+ "dataType"
346
+ ]
317
347
  }
318
348
  },
319
349
  "isHidden": {
@@ -375,7 +405,10 @@
375
405
  }
376
406
  }
377
407
  },
378
- "required": ["name", "dataType"]
408
+ "required": [
409
+ "name",
410
+ "dataType"
411
+ ]
379
412
  }
380
413
  },
381
414
  "relatedEntity": {
@@ -401,8 +434,256 @@
401
434
  "type": "string"
402
435
  }
403
436
  },
404
- "required": ["fields", "contractId"]
437
+ "required": [
438
+ "fields",
439
+ "contractId"
440
+ ]
441
+ }
442
+ }
443
+ },
444
+ "required": [
445
+ "entity",
446
+ "connectionAttribute",
447
+ "fieldsFromEntity"
448
+ ]
449
+ },
450
+ "uniqueConstraints": {
451
+ "type": "array",
452
+ "items": {
453
+ "type": "object",
454
+ "properties": {
455
+ "name": {
456
+ "type": "string"
457
+ },
458
+ "fields": {
459
+ "type": "array",
460
+ "items": {
461
+ "type": "string"
462
+ }
463
+ }
464
+ }
465
+ }
466
+ }
467
+ },
468
+ "required": [
469
+ "entity",
470
+ "fields"
471
+ ]
472
+ },
473
+ "conditions": {
474
+ "$ref": "condition.ref.json"
475
+ },
476
+ "businessRules": {
477
+ "$ref": "business-rules.ref.json"
478
+ },
479
+ "userStory": {
480
+ "type": "string"
481
+ }
482
+ },
483
+ "required": [
484
+ "id",
485
+ "endpoint",
486
+ "actions"
487
+ ]
488
+ }
489
+ },
490
+ "publicContracts": {
491
+ "type": "array",
492
+ "items": {
493
+ "type": "object",
494
+ "properties": {
495
+ "id": {
496
+ "type": "string"
497
+ },
498
+ "endpoint": {
499
+ "type": "string"
500
+ },
501
+ "actions": {
502
+ "type": "array",
503
+ "items": {
504
+ "type": "string",
505
+ "enum": [
506
+ "create",
507
+ "get",
508
+ "getById",
509
+ "update",
510
+ "softDelete",
511
+ "hardDelete",
512
+ "clone",
513
+ "sendEmail"
514
+ ]
515
+ }
516
+ },
517
+ "permissionedUrls": {
518
+ "type": "array",
519
+ "items": {
520
+ "type": "string"
521
+ }
522
+ },
523
+ "request": {
524
+ "type": "object",
525
+ "properties": {
526
+ "entity": {
527
+ "type": "string"
528
+ },
529
+ "description": {
530
+ "type": "string"
531
+ },
532
+ "fields": {
533
+ "type": "array",
534
+ "items": {
535
+ "type": "object",
536
+ "properties": {
537
+ "name": {
538
+ "type": "string"
539
+ },
540
+ "dataType": {
541
+ "$ref": "types-datatype.ref.json"
542
+ },
543
+ "isRequired": {
544
+ "type": "boolean"
545
+ },
546
+ "requiredOneOf": {
547
+ "type": "array",
548
+ "items": {
549
+ "type": "string"
550
+ }
551
+ },
552
+ "isHidden": {
553
+ "type": "boolean",
554
+ "description": "If true, the attribute will not be exposed in the API."
555
+ },
556
+ "foreignKey": {
557
+ "type": "object",
558
+ "properties": {
559
+ "entity": {
560
+ "type": "string"
561
+ },
562
+ "connectionAttribute": {
563
+ "type": "string"
564
+ },
565
+ "relationship": {
566
+ "type": "string",
567
+ "enum": [
568
+ "one-to-one",
569
+ "one-to-many",
570
+ "many-to-many"
571
+ ]
572
+ },
573
+ "fields": {
574
+ "type": "array",
575
+ "items": {
576
+ "type": "object",
577
+ "properties": {
578
+ "name": {
579
+ "type": "string"
580
+ },
581
+ "dataType": {
582
+ "$ref": "types-datatype.ref.json"
583
+ }
584
+ },
585
+ "required": [
586
+ "name",
587
+ "dataType"
588
+ ]
589
+ }
590
+ },
591
+ "isHidden": {
592
+ "type": "boolean",
593
+ "description": "If true, the connection attribute will not be exposed in the API."
594
+ }
595
+ },
596
+ "required": [
597
+ "entity",
598
+ "connectionAttribute",
599
+ "relationship"
600
+ ]
601
+ },
602
+ "isPrimaryKey": {
603
+ "type": "boolean"
604
+ },
605
+ "minSize": {
606
+ "type": "number"
607
+ },
608
+ "maxSize": {
609
+ "type": "number"
610
+ },
611
+ "enum": {
612
+ "type": "array",
613
+ "items": {
614
+ "oneOf": [
615
+ {
616
+ "type": "string"
617
+ },
618
+ {
619
+ "type": "number"
620
+ }
621
+ ]
622
+ }
623
+ },
624
+ "isUnique": {
625
+ "type": "boolean"
626
+ },
627
+ "uniqueComposedFields": {
628
+ "type": "array",
629
+ "items": {
630
+ "type": "string"
631
+ }
632
+ },
633
+ "actionsExceptions": {
634
+ "type": "array",
635
+ "items": {
636
+ "type": "string",
637
+ "enum": [
638
+ "create",
639
+ "get",
640
+ "getById",
641
+ "update",
642
+ "softDelete",
643
+ "hardDelete",
644
+ "clone",
645
+ "sendEmail"
646
+ ]
647
+ }
648
+ },
649
+ "businessRules": {
650
+ "$ref": "business-rules.ref.json"
405
651
  }
652
+ },
653
+ "required": [
654
+ "name",
655
+ "dataType"
656
+ ]
657
+ }
658
+ },
659
+ "relatedEntity": {
660
+ "type": "object",
661
+ "properties": {
662
+ "entity": {
663
+ "type": "string",
664
+ "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."
665
+ },
666
+ "connectionAttribute": {
667
+ "type": "string",
668
+ "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."
669
+ },
670
+ "fieldsFromEntity": {
671
+ "type": "array",
672
+ "items": {
673
+ "type": "object",
674
+ "properties": {
675
+ "fields": {
676
+ "$ref": "form.ref.json"
677
+ },
678
+ "contractId": {
679
+ "type": "string"
680
+ }
681
+ }
682
+ },
683
+ "required": [
684
+ "fields",
685
+ "contractId"
686
+ ]
406
687
  }
407
688
  },
408
689
  "required": [
@@ -429,7 +710,10 @@
429
710
  }
430
711
  }
431
712
  },
432
- "required": ["entity", "fields"]
713
+ "required": [
714
+ "entity",
715
+ "fields"
716
+ ]
433
717
  },
434
718
  "conditions": {
435
719
  "$ref": "condition.ref.json"
@@ -441,9 +725,19 @@
441
725
  "type": "string"
442
726
  }
443
727
  },
444
- "required": ["id", "endpoint", "actions"]
728
+ "required": [
729
+ "id",
730
+ "endpoint",
731
+ "actions"
732
+ ]
445
733
  }
446
734
  }
447
735
  },
448
- "required": ["componentType", "id", "title", "dataSource", "contracts"]
449
- }
736
+ "required": [
737
+ "componentType",
738
+ "id",
739
+ "title",
740
+ "dataSource",
741
+ "contracts"
742
+ ]
743
+ }