@greatapps/greatagents 0.0.1

package/docs/README.md

@@ -0,0 +1,630 @@
+# Documentação de Schemas
+
+## Índice
+
+- [Introdução](#introdução)
+- [Estrutura Básica](#estrutura-básica)
+  - [Elementos Principais](#elementos-principais)
+- [Definição de Propriedades](#definição-de-propriedades)
+  - [Atributos Básicos](#atributos-básicos)
+  - [Propriedades Automáticas](#propriedades-automáticas)
+  - [Validações](#validações)
+  - [Opções Predefinidas](#opções-predefinidas)
+  - [Referências](#referências)
+  - [Interface de Usuário](#interface-de-usuário)
+  - [Configuração de Arquivos](#configuração-de-arquivos)
+- [Tipos de Dados](#tipos-de-dados)
+  - [String](#string)
+  - [Number](#number)
+  - [Boolean](#boolean)
+  - [Date](#date)
+  - [Object](#object)
+  - [Array](#array)
+  - [Image](#image)
+- [Componentes de Interface](#componentes-de-interface)
+- [Recursos Avançados](#recursos-avançados)
+  - [Valores Dinâmicos](#valores-dinâmicos)
+  - [Filtros Dinâmicos](#filtros-dinâmicos)
+  - [Propriedades Aninhadas](#propriedades-aninhadas)
+- [Definição de Rotas](#definição-de-rotas)
+  - [Estrutura de Rotas](#estrutura-de-rotas)
+  - [Parâmetros de Rota](#parâmetros-de-rota)
+  - [Métodos HTTP](#métodos-http)
+  - [Parâmetros de Consulta](#parâmetros-de-consulta)
+  - [Respostas](#respostas)
+
+## Introdução
+
+Este documento descreve como criar e configurar schemas para produtos Great. Os schemas definem a estrutura de dados, validações, relacionamentos, interfaces de usuário e rotas de API para as coleções do sistema.
+
+Sempre que atualizar um schema, atualize também o r1-api-postgresql e r3-api para refletir as mudanças.
+
+## Estrutura Básica
+
+Um schema possui a seguinte estrutura básica:
+
+```json
+{
+  "product": "greatagents",
+  "name": "nome_do_module",
+  "summary": "Descrição breve da coleção",
+  "params": ["parametro1", "parametro2"],
+  "description": "Descrição detalhada da coleção",
+  "properties": {
+    "propriedade1": {
+      "type": "string",
+      "required": true,
+      // outras configurações
+    },
+    "propriedade2": {
+      "type": "number",
+      // outras configurações
+    }
+    // mais propriedades
+  },
+  "routes": {
+    // definição de rotas
+  }
+}
+```
+
+### Elementos Principais
+
+| Elemento | Descrição |
+|----------|-----------|
+| `product` | Identifica o produto ao qual a coleção pertence (geralmente "greatagents") |
+| `name` | Nome do módulo |
+| `summary` | Descrição breve da finalidade da coleção |
+| `params` | Array de parâmetros obrigatórios para filtrar a coleção (opcional) |
+| `description` | Descrição detalhada da coleção |
+| `properties` | Objeto contendo todas as propriedades da coleção |
+| `routes` | Objeto contendo todas as rotas da API relacionadas à coleção |
+
+## Definição de Propriedades
+
+Cada propriedade é definida como um objeto com diversos atributos:
+
+```json
+"nome_propriedade": {
+  "type": "string",
+  "required": true,
+  "default": "valor_padrao",
+  "filterable": true,
+  "searchable": true,
+  "updatable": false,
+  "description": "Descrição da propriedade",
+  "options": [],
+  "reference": {},
+  "interface": {}
+}
+```
+
+### Atributos Básicos
+
+| Atributo | Tipo | Descrição |
+|----------|------|-----------|
+| `type` | String | Tipo de dado (string, number, boolean, date, object, array, image) |
+| `required` | Boolean | Define se o campo é obrigatório |
+| `default` | Any | Valor padrão para o campo |
+| `updatable` | Boolean | Define se o campo pode ser atualizado após criação |
+| `creatable` | Boolean | Define se o campo pode ser definido na criação |
+| `filterable` | Boolean | Define se o campo pode ser usado em filtros |
+| `searchable` | Boolean | Define se o campo pode ser usado em buscas textuais |
+| `unique` | Boolean | Define se o valor deve ser único na coleção |
+| `description` | String | Descrição do propósito do campo |
+| `autoIncrement` | Boolean | Define se o campo é auto-incrementado |
+| `index` | Boolean | Define se o campo deve ser indexado |
+
+
+### Propriedades Automáticas
+
+As seguintes propriedades serão criadas e configuradas automaticamente no banco de dados, mesmo que não sejam explicitamente definidas no schema:
+
+| Propriedade | Tipo | Descrição |
+|-------------|------|-----------|
+| `id` | Number | Identificador único do registro, auto-incrementado |
+| `deleted` | Boolean | Indica se o registro foi marcado como excluído (exclusão lógica) |
+| `datetime_alt` | Date | Data e hora da última alteração do registro |
+| `datetime_del` | Date | Data e hora da exclusão lógica do registro |
+| `datetime_add` | Date | Data e hora da criação do registro |
+
+Estas propriedades são gerenciadas automaticamente pelo sistema:
+
+- `id`: Gerado automaticamente na criação do registro
+- `deleted`: Definido como `false` por padrão, atualizado para `true` quando o registro é excluído logicamente
+- `datetime_alt`: Atualizado automaticamente sempre que o registro é modificado
+- `datetime_del`: Preenchido automaticamente quando o registro é excluído logicamente
+- `datetime_add`: Preenchido automaticamente com a data e hora atual na criação do registro
+
+Não é necessário definir estas propriedades explicitamente em seus schemas, mas se desejar personalizar algum aspecto delas (como adicionar filtros ou índices), você pode incluí-las normalmente.
+
+### Validações
+
+| Atributo | Tipo | Descrição |
+|----------|------|-----------|
+| `minLength` | Number | Comprimento mínimo para strings |
+| `maxLength` | Number | Comprimento máximo para strings |
+| `min` | Number | Valor mínimo para números |
+| `max` | Number | Valor máximo para números |
+| `match` | String | Expressão regular para validação de strings |
+| `options` | Array | Lista de valores permitidos |
+| `format` | String | Formato específico (email, url, json, etc.) |
+| `value` | Any | Valor fixo |
+| `default` | Any | Valor padrão |
+
+Exemplo de validações:
+
+```json
+"email": {
+  "type": "string",
+  "required": true,
+  "minLength": 5,
+  "maxLength": 100,
+  "match": "^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$",
+  "unique": true,
+  "format": "email"
+}
+```
+
+### Opções Predefinidas
+
+Para propriedades que possuem valores predefinidos, utilize o atributo `options`:
+
+```json
+"options": [
+  {
+    "value": "valor1",
+    "icon": "icone_opcional",
+    "title": {
+      "pt-br": "Título em Português",
+      "en": "Título em Inglês"
+    },
+    "description": "Descrição opcional",
+    "style": "Estilo opcional"
+  },
+  // Mais opções...
+]
+```
+
+Exemplo de propriedade com opções:
+
+```json
+"payment_method": {
+  "type": "number",
+  "options": [
+    {
+      "value": 1,
+      "title": {
+        "pt-br": "Cartão de Crédito",
+        "en": "Credit Card"
+      }
+    },
+    {
+      "value": 2,
+      "title": {
+        "pt-br": "Boleto Bancário",
+        "en": "Bank Slip"
+      }
+    }
+  ],
+  "interface": {
+    "label": {
+      "pt-br": "Forma de Pagamento",
+      "en": "Payment Method"
+    },
+    "component": "select"
+  }
+}
+```
+
+### Referências
+
+Para criar relacionamentos entre coleções:
+
+```json
+"reference": {
+  "name": "nome_da_colecao",
+  "field": "campo_id",
+  "filter": { "campo": "valor" },
+  "label": "campo_exibido",
+  "value": "campo_valor",
+  "disabled": false
+}
+```
+
+| Atributo | Descrição |
+|----------|-----------|
+| `name` | Nome da coleção referenciada |
+| `field` | Campo na coleção referenciada (geralmente "id") |
+| `filter` | Filtro aplicado à coleção referenciada |
+| `label` | Campo usado como rótulo na interface |
+| `value` | Campo usado como valor |
+| `disabled` | Define se a referência é editável |
+
+Exemplo de propriedade com referência:
+
+```json
+"id_product": {
+  "type": "number",
+  "filterable": true,
+  "reference": {
+    "name": "products",
+    "field": "id",
+    "label": "name",
+    "value": "id"
+  },
+  "interface": {
+    "label": {
+      "pt-br": "Produto",
+      "en": "Product"
+    },
+    "component": "select"
+  }
+}
+```
+
+### Interface de Usuário
+
+Configurações para a interface de usuário:
+
+```json
+"interface": {
+  "label": {
+    "pt-br": "Nome",
+    "en": "Name"
+  },
+  "description": {
+    "pt-br": "Informe seu nome",
+    "en": "Enter your name"
+  },
+  "placeholder": {
+    "pt-br": "Nome",
+    "en": "Name"
+  },
+  "component": "input",
+  "disabled": false,
+  "format": "email",
+  "mask": "phone",
+  "class": "classe_css_opcional"
+}
+```
+
+| Atributo | Descrição |
+|----------|-----------|
+| `label` | Rótulo do campo (com suporte a múltiplos idiomas) |
+| `description` | Descrição/ajuda do campo |
+| `placeholder` | Texto de placeholder |
+| `component` | Tipo de componente (input, select, radio, checkbox, textarea, date, image) |
+| `disabled` | Define se o campo está desabilitado |
+| `format` | Formato especial (email, url, cep, cpf, cnpj, currency, password) |
+| `mask` | Máscara de entrada (phone, cep, cpf, cnpj, int, card, card_date) |
+| `class` | Classes CSS adicionais (ex: "editor", "color-picker") |
+
+### Configuração de Arquivos
+
+Para propriedades do tipo `image`, utilize o atributo `file`:
+
+```json
+"photo": {
+  "type": "image",
+  "file": {
+    "types": ["png", "jpg", "jpeg", "gif", "svg", "webp"],
+    "storage": "nome-do-bucket",
+    "width": 160,
+    "height": 160
+  },
+  "interface": {
+    "label": {
+      "pt-br": "Foto",
+      "en": "Photo"
+    },
+    "component": "image"
+  }
+}
+```
+
+| Atributo | Descrição |
+|----------|-----------|
+| `types` | Array com os tipos de arquivo permitidos |
+| `storage` | Nome do bucket de armazenamento |
+| `width` | Largura da imagem |
+| `height` | Altura da imagem |
+
+## Tipos de Dados
+
+### String
+
+```json
+"name": {
+  "type": "string",
+  "required": true,
+  "minLength": 2,
+  "maxLength": 100,
+  "searchable": true
+}
+```
+
+### Number
+
+```json
+"age": {
+  "type": "number",
+  "min": 18,
+  "max": 120,
+  "default": 18
+}
+```
+
+### Boolean
+
+```json
+"active": {
+  "type": "boolean",
+  "default": true,
+  "filterable": true
+}
+```
+
+### Date
+
+```json
+"birth_date": {
+  "type": "date",
+  "filterable": true
+}
+```
+
+### Object
+
+```json
+"address": {
+  "type": "object",
+  "properties": {
+    "street": { "type": "string" },
+    "number": { "type": "string" },
+    "city": { "type": "string" }
+  }
+}
+```
+
+### Array
+
+```json
+"tags": {
+  "type": "array",
+}
+```
+
+### Image
+
+```json
+"photo": {
+  "type": "image",
+  "file": {
+    "types": ["png", "jpg", "jpeg"],
+    "storage": "user-photos",
+    "width": 200,
+    "height": 200
+  }
+}
+```
+
+## Componentes de Interface
+
+| Componente | Descrição | Exemplo |
+|------------|-----------|---------|
+| `input` | Campo de entrada de texto | `"component": "input"` |
+| `select` | Menu de seleção | `"component": "select"` |
+| `radio` | Botões de opção | `"component": "radio"` |
+| `checkbox` | Caixas de seleção | `"component": "checkbox"` |
+| `textarea` | Área de texto | `"component": "textarea"` |
+| `date` | Seletor de data | `"component": "date"` |
+| `image` | Seletor de imagem | `"component": "image"` |
+
+### Formatos e Máscaras
+
+| Formato/Máscara | Descrição |
+|-----------------|-----------|
+| `email` | Formato de e-mail |
+| `url` | Formato de URL |
+| `cep` | Máscara de CEP |
+| `cpf` | Máscara de CPF |
+| `cnpj` | Máscara de CNPJ |
+| `phone` | Máscara de telefone |
+| `int` | Máscara de número inteiro |
+| `currency` | Formato de moeda |
+| `password` | Campo de senha |
+
+## Recursos Avançados
+
+### Valores Dinâmicos
+
+O sistema suporta valores dinâmicos para alguns atributos:
+
+- `"default": "$id"` - Utiliza o ID do documento
+- `"default": "Date()"` - Utiliza a data atual
+
+### Filtros Dinâmicos
+
+É possível usar valores dinâmicos em filtros de referência:
+
+```json
+"reference": {
+  "name": "accounts",
+  "filter": { "id_wl": "$id_wl" },
+  "label": "name",
+  "value": "id"
+}
+```
+
+## Definição de Rotas
+
+### Estrutura de Rotas
+
+As rotas são definidas no atributo `routes` do schema:
+
+```json
+"routes": {
+  "/pt-br/:id_wl/account/:id_account/name/action/:param": {
+    "parameters": {
+      // parâmetros de rota
+    },
+    "get": {
+      // configuração do método GET
+    },
+    "post": {
+      // configuração do método POST
+    },
+    "put": {
+      // configuração do método PUT
+    },
+    "delete": {
+      // configuração do método DELETE
+    }
+  }
+}
+```
+
+### Parâmetros de Rota
+
+Os parâmetros de rota são definidos no atributo `parameters`:
+
+São obrigatórios.
+
+```json
+"parameters": {
+  "id_wl": {
+    "type": "string",
+    "example": "1",
+    "description": "ID do whitelabel"
+  },
+  "id_account": {
+    "type": "string",
+    "example": "1",
+    "description": "ID da conta"
+  },
+  "id_page": {
+    "type": "string",
+    "example": "10984"
+  }
+}
+```
+
+### Métodos HTTP
+
+Cada rota pode suportar um ou mais métodos HTTP (GET, POST, PUT, DELETE):
+
+```json
+"get": {
+  "summary": "Obter dados",
+  "description": "Descrição detalhada da operação",
+  "query": {
+    // parâmetros de consulta
+  },
+  "responses": {
+    // respostas possíveis
+  }
+}
+```
+
+### Parâmetros de Consulta
+
+Os parâmetros de consulta são definidos no atributo `query`:
+
+São opcionais.
+
+```json
+"query": {
+  "date_start": {
+    "type": "string",
+    "example": "2024-07-01",
+    "description": "Data inicial (formato YYYY-MM-DD)",
+    "required": true
+  },
+  "date_end": {
+    "type": "string",
+    "example": "2024-07-25",
+    "description": "Data final (formato YYYY-MM-DD)",
+    "required": true
+  },
+  "sort": {
+    "type": "string",
+    "example": "datetime_resume:desc",
+    "description": "Campo e direção de ordenação",
+    "default": "datetime_resume:desc"
+  },
+  "page": {
+    "type": "number",
+    "example": 1,
+    "description": "Número da página",
+    "default": 1
+  },
+  "limit": {
+    "type": "number",
+    "example": 100,
+    "description": "Número máximo de registros",
+    "default": 50
+  }
+}
+```
+
+### Respostas
+
+As respostas são definidas no atributo `responses`:
+
+```json
+"responses": {
+  "200": {
+    "description": "Sucesso",
+    "content": {
+      "application/json": {}
+    }
+  },
+  "400": {
+    "description": "Requisição inválida"
+  },
+  "401": {
+    "description": "Não autorizado"
+  },
+  "403": {
+    "description": "Acesso proibido"
+  },
+  "404": {
+    "description": "Não encontrado"
+  },
+  "500": {
+    "description": "Erro interno do servidor"
+  }
+}
+```
+
+## Boas Práticas
+
+1. **Nomenclatura**: Use nomes descritivos para propriedades
+   - Prefixe IDs de referência com `id_` (ex: `id_account`, `id_page`)
+   - Use nomes em inglês e em snake_case (ex: `first_name`, `birth_date`)
+
+2. **Validações**: Sempre defina validações apropriadas para garantir a integridade dos dados
+   - Defina `minLength` e `maxLength` para strings
+   - Defina `min` e `max` para números
+   - Use `match` para validar formatos específicos (email, URL, etc.)
+
+3. **Internacionalização**: Forneça labels em múltiplos idiomas quando possível
+   - Sempre inclua pelo menos português (`pt-br`) e inglês (`en`)
+
+4. **Documentação**: Adicione campos `summary` e `description` para descrever a finalidade da coleção
+   - Use `description` em propriedades para explicar seu propósito
+
+5. **Referências**: Use referências para manter relacionamentos entre coleções
+   - Aplique filtros apropriados para limitar as opções
+
+6. **Defaults**: Defina valores padrão quando apropriado
+   - Use valores dinâmicos quando necessário (`$id`, `Date()`)
+
+7. **Filtros e Busca**: 
+   - Marque como `filterable` campos que serão usados em consultas frequentes
+   - Marque como `searchable` campos que serão usados em buscas textuais
+
+8. **Organização**:
+   - Agrupe propriedades relacionadas
+   - Mantenha a consistência entre schemas similares

package/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@greatapps/greatagents",
+  "version": "0.0.1",
+  "description": "Schemas para GreatAgents",
+  "main": "./src/product.js",
+  "type": "module"
+}

package/src/modules/base_domains/index.js

@@ -0,0 +1,10 @@
+import { properties } from "./properties.js";
+
+export default {
+	product: "greatpages",
+	name: "base_domains",
+	cache: { ttlView: 30, ttlList: 0 },
+	params: [ "id_wl" ],
+	properties: properties,
+	routes: {}
+};

package/src/modules/base_domains/properties.js

@@ -0,0 +1,61 @@
+export const properties = {
+	id: {
+		type: "number",
+		filterable: true,
+		unique: true,
+		autoIncrement: true,
+		index: true
+	},
+	id_wl: {
+		type: "number",
+		required: true,
+		updatable: false,
+		filterable: true,
+		index: true,
+		interface: {
+			label: {
+				"pt-br": "Whitelabel",
+				"en": "Whitelabel"
+			},
+			component: "select",
+			disabled: true
+		}
+	},
+	domain: {
+		type: "string",
+		required: true,
+		searchable: true,
+		filterable: true,
+		maxLength: 255,
+		interface: {
+			label: {
+				"pt-br": "Domínio",
+				"en": "Domain"
+			},
+			component: "input",
+			placeholder: {
+				"pt-br": "exemplo.com",
+				"en": "example.com"
+			}
+		}
+	},
+	deleted: {
+		type: "boolean",
+		default: false,
+		filterable: true
+	},
+	datetime_alt: {
+		type: "date",
+		filterable: true,
+		updatable: true
+	},
+	datetime_del: {
+		type: "date",
+		filterable: true
+	},
+	datetime_add: {
+		type: "date",
+		filterable: true,
+		updatable: false
+	}
+};