mitra-sdk 1.0.1 → 1.0.2

package/README.md

@@ -16,76 +16,198 @@ import { configureSdkMitra } from 'mitra-sdk';
 configureSdkMitra({
   baseURL: 'https://api.mitra.com',
   token: 'seu-jwt-token',
-  projectId: 123
+  timeout: 30000  // Opcional, padrão: 30000ms
 });
 ```
 
 ## Métodos incluídos do mitra-interactions-sdk
 
-- `runQueryMitra` - Executa query SQL
-- `executeDbActionMitra` - Executa DBAction
-- `executeActionMitra` - Executa Action
+- `runQueryMitra` - Executa query SQL (SELECT)
+- `executeDbActionMitra` - Executa DBAction (DML)
+- `executeActionMitra` - Executa Action (fluxo)
 - `executeServerFunctionMitra` - Executa Server Function
 - `setFileStatusMitra` - Move arquivo para PUBLIC/LOADABLE
 - `setVariableMitra` - Cria/atualiza variável
 
+> Para exemplos detalhados destes métodos, consulte a documentação do [mitra-interactions-sdk](https://www.npmjs.com/package/mitra-interactions-sdk).
+
 ## Métodos do Mitra SDK
 
 ### Navegação
 
-- `listWorkspacesMitra` - Lista workspaces
-- `listProjectsMitra` - Lista projetos de um workspace
-- `createProjectMitra` - Cria um projeto
-- `getProjectContextMitra` - Detalhes de um projeto
+- `listWorkspacesMitra()` - Lista workspaces
+- `listProjectsMitra({ workspaceId })` - Lista projetos de um workspace
+- `createProjectMitra({ workspaceId, name, description? })` - Cria um projeto
+- `getProjectContextMitra({ projectId })` - Detalhes e inventário de um projeto
+
+```typescript
+import { listWorkspacesMitra, listProjectsMitra } from 'mitra-sdk';
+
+const workspaces = await listWorkspacesMitra();
+const projects = await listProjectsMitra({ workspaceId: 1 });
+```
 
 ### Variáveis
 
-- `listVariablesMitra` - Lista variáveis de um projeto
-- `getVariableMitra` - Obtém uma variável por key
-- `deleteVariableMitra` - Deleta uma variável
+- `listVariablesMitra({ projectId })` - Lista variáveis
+- `getVariableMitra({ projectId, key })` - Obtém variável por key
+- `deleteVariableMitra({ projectId, key })` - Deleta variável
+
+```typescript
+import { listVariablesMitra, getVariableMitra } from 'mitra-sdk';
+
+const vars = await listVariablesMitra({ projectId: 123 });
+const v = await getVariableMitra({ projectId: 123, key: 'minhaVar' });
+```
 
 ### JDBC
 
-- `listJdbcConnectionsMitra` - Lista conexões JDBC
-- `createJdbcConnectionMitra` - Cria conexão JDBC
-- `updateJdbcConnectionMitra` - Atualiza conexão JDBC
+- `listJdbcConnectionsMitra({ projectId })` - Lista conexões JDBC
+- `createJdbcConnectionMitra({ projectId, name, type, host, port, database, user, password })` - Cria conexão
+- `updateJdbcConnectionMitra({ projectId, jdbcId, name, type, host, port, database, user, password })` - Atualiza conexão
+
+```typescript
+import { createJdbcConnectionMitra } from 'mitra-sdk';
+
+const result = await createJdbcConnectionMitra({
+  projectId: 123,
+  name: 'Meu Banco',
+  type: 'PostgreSQL',
+  host: 'localhost',
+  port: 5432,
+  database: 'mydb',
+  user: 'admin',
+  password: 'senha123'
+});
+```
 
 ### SQL
 
-- `runDdlMitra` - Executa DDL (CREATE, ALTER, DROP)
-- `runDmlMitra` - Executa DML (INSERT, UPDATE, DELETE)
-- `createOnlineTableMitra` - Cria online table
-- `updateOnlineTableMitra` - Atualiza online table
+- `runDdlMitra({ projectId, sql, jdbcId? })` - Executa DDL (CREATE, ALTER, DROP)
+- `runDmlMitra({ projectId, sql, jdbcId? })` - Executa DML (INSERT, UPDATE, DELETE)
+- `createOnlineTableMitra({ projectId, jdbcId, name, sql_query })` - Cria online table
+- `updateOnlineTableMitra({ projectId, tableName, sql_query })` - Atualiza online table
+
+```typescript
+import { runDdlMitra, runDmlMitra } from 'mitra-sdk';
+
+await runDdlMitra({ projectId: 123, sql: 'CREATE TABLE users (id INT, name VARCHAR(100))' });
+await runDmlMitra({ projectId: 123, sql: "INSERT INTO users VALUES (1, 'João')" });
+```
 
 ### DBActions
 
-- `listDbActionsMitra` - Lista DBActions
-- `createDbActionMitra` - Cria DBAction
-- `updateDbActionMitra` - Atualiza DBAction
-- `deleteDbActionMitra` - Deleta DBAction
+- `listDbActionsMitra({ projectId })` - Lista DBActions
+- `createDbActionMitra({ projectId, name, sql })` - Cria DBAction
+- `updateDbActionMitra({ projectId, dbactionId, sql })` - Atualiza DBAction
+- `deleteDbActionMitra({ projectId, dbactionId })` - Deleta DBAction
+
+```typescript
+import { createDbActionMitra } from 'mitra-sdk';
+
+const result = await createDbActionMitra({
+  projectId: 123,
+  name: 'Inserir Usuário',
+  sql: "INSERT INTO users (name) VALUES (':VAR_NOME')"
+});
+```
 
 ### Actions
 
-- `listActionsMitra` - Lista Actions
-- `createActionMitra` - Cria Action
-- `updateActionStepsMitra` - Atualiza steps de uma Action
-- `deleteActionMitra` - Deleta Action
+- `listActionsMitra({ projectId })` - Lista Actions com steps
+- `createActionMitra({ projectId, name, steps?, params? })` - Cria Action
+- `updateActionStepsMitra({ projectId, actionId, steps?, params? })` - Atualiza steps
+- `deleteActionMitra({ projectId, actionId })` - Deleta Action
+
+```typescript
+import { createActionMitra } from 'mitra-sdk';
+
+const result = await createActionMitra({
+  projectId: 123,
+  name: 'Fluxo de Cadastro',
+  steps: [
+    { type: 'DB_ACTION', dmlActionsIds: [1, 2] },
+    { type: 'SHOW_MESSAGE', message: 'Cadastro realizado!', title: 'Sucesso' }
+  ]
+});
+```
 
 ### Screens
 
-- `listScreensMitra` - Lista telas
-- `deleteScreenMitra` - Deleta tela
-- `updateScreenMetadataMitra` - Atualiza metadados de uma tela
-- `createScreenNativeMitra` - Cria tela nativa
-- `updateScreenNativeMitra` - Atualiza tela nativa
-- `getScreenStructureMitra` - Obtém estrutura de uma tela
-- `listAvailableComponentsMitra` - Lista componentes disponíveis
+- `listScreensMitra({ projectId })` - Lista telas
+- `deleteScreenMitra({ projectId, screenId })` - Deleta tela
+- `updateScreenMetadataMitra({ projectId, screenId, name?, public? })` - Atualiza metadados
+- `createScreenNativeMitra({ projectId, name, public?, moduleId? })` - Cria tela nativa
+- `updateScreenNativeMitra({ projectId, screenId, name, moduleId?, public? })` - Atualiza tela nativa
+- `getScreenStructureMitra({ projectId, screenId })` - Obtém estrutura (árvore de componentes)
+- `listAvailableComponentsMitra()` - Lista tipos de componentes disponíveis
+
+```typescript
+import { createScreenNativeMitra, getScreenStructureMitra } from 'mitra-sdk';
+
+const screen = await createScreenNativeMitra({ projectId: 123, name: 'Dashboard', public: true });
+const structure = await getScreenStructureMitra({ projectId: 123, screenId: 1 });
+```
 
 ### Componentes
 
-- `addComponentMitra` - Adiciona componente a uma tela
-- `updateComponentMitra` - Atualiza componente
-- `deleteComponentMitra` - Deleta componente
+- `addComponentMitra({ projectId, screenId, type, props?, sizes? })` - Adiciona componente
+- `updateComponentMitra({ projectId, componentId, props?, sizes? })` - Atualiza componente
+- `deleteComponentMitra({ projectId, componentId })` - Deleta componente
+
+```typescript
+import { addComponentMitra } from 'mitra-sdk';
+
+const result = await addComponentMitra({
+  projectId: 123,
+  screenId: 1,
+  type: 'CARD_GROUP',
+  props: {
+    query: "SELECT 1 AS ID, 'Vendas' AS DESC, COUNT(*) AS VALOR FROM VENDAS",
+    jdbcId: 1,
+    idColumn: 'ID',
+    cardTitle: 'VALOR',
+    cardDescription: 'DESC'
+  },
+  sizes: { left: '10px', top: '10px', width: '600px', height: '150px', z: 1 }
+});
+```
+
+### Arquivos
+
+- `listProjectFilesMitra({ projectId })` - Lista arquivos do projeto (CHAT, PUBLIC, LOADABLE)
+- `getFilePreviewMitra({ projectId, fileName, maxLines? })` - Preview de arquivo (CSV, texto, imagem)
+
+```typescript
+import { listProjectFilesMitra, getFilePreviewMitra } from 'mitra-sdk';
+
+const files = await listProjectFilesMitra({ projectId: 123 });
+const preview = await getFilePreviewMitra({ projectId: 123, fileName: 'dados.csv', maxLines: 10 });
+```
+
+### Formulários
+
+- `listFormsMitra({ projectId })` - Lista formulários
+- `getFormDetailsMitra({ projectId, formId })` - Detalhes de um formulário (campos, botões)
+
+```typescript
+import { listFormsMitra, getFormDetailsMitra } from 'mitra-sdk';
+
+const forms = await listFormsMitra({ projectId: 123 });
+const details = await getFormDetailsMitra({ projectId: 123, formId: 1 });
+```
+
+### Tabelas
+
+- `listTablesMitra({ projectId })` - Lista tabelas físicas com colunas e tipos
+- `listOnlineTablesMitra({ projectId })` - Lista tabelas online (QueryAlias) com queries
+
+```typescript
+import { listTablesMitra, listOnlineTablesMitra } from 'mitra-sdk';
+
+const tables = await listTablesMitra({ projectId: 123 });
+const onlineTables = await listOnlineTablesMitra({ projectId: 123 });
+```
 
 ## Licença
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mitra-sdk",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "SDK completo para a plataforma Mitra ECP",
   "main": "dist/index.js",
   "module": "dist/index.mjs",