Mitra SDK

SDK completo para a plataforma Mitra. Inclui todos os métodos do mitra-interactions-sdk e serviços adicionais.

Instalação

``bash
npm install mitra-sdk
`

Configuração

Configure o SDK com seu token da plataforma Mitra.

> Importante: O token é um JWT de autenticação da plataforma Mitra. Nunca deixe o token estático no código. Utilize variáveis de ambiente para armazená-lo de forma segura.

`typescript
import { configureSdkMitra } from 'mitra-sdk';

configureSdkMitra({
baseURL: process.env.MITRA_BASE_URL || 'https://api.mitra.com',
token: process.env.MITRA_TOKEN!
});
`

Exemplo de .env:
`
MITRA_BASE_URL=https://api.mitra.com
MITRA_TOKEN=seu-jwt-token-da-plataforma-mitra
`

Métodos incluídos do mitra-interactions-sdk

- runQueryMitra - Executa query SQL (SELECT)
- executeDbActionMitra - Executa DBAction (DML)
- executeServerFunctionMitra - Executa Server Function
- stopServerFunctionExecutionMitra - Para execução de Server Function
- setFileStatusMitra - Move arquivo para PUBLIC/LOADABLE
- setVariableMitra - Cria/atualiza variável
- listRecordsMitra - Lista registros (Dynamic Schema CRUD)
- getRecordMitra - Busca registro por ID
- createRecordMitra - Cria registro
- updateRecordMitra - Atualiza registro (PUT)
- patchRecordMitra - Atualiza parcialmente (PATCH)
- deleteRecordMitra - Remove registro
- createRecordsBatchMitra - Cria múltiplos registros

> Para exemplos detalhados destes métodos, consulte a documentação do mitra-interactions-sdk.

Métodos do Mitra SDK

$3

- 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 });
`

$3

- 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' });
`

$3

- 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'
});
`

$3

- runDdlMitra({ projectId, sql, jdbcId? }) - Executa DDL (CREATE, ALTER, DROP)
- runDmlMitra({ projectId, sql, jdbcId? }) - Executa DML (INSERT, UPDATE, DELETE)
- createOnlineTableMitra({ projectId, jdbcId, name, sqlQuery }) - Cria online table
- updateOnlineTableMitra({ projectId, tableName, sqlQuery }) - 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')" });
`

$3

- 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')"
});
`

$3

- 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 });
`

$3

- 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 });
`

$3

- listDataLoadersMitra({ projectId }) - Lista rotinas de importação
- createDataLoaderMitra({ projectId, jdbcId, query, name, runWhenCreate? }) - Cria Data Loader (SQL)
- updateDataLoaderMitra({ projectId, dataLoaderId, jdbcId?, query?, name?, runWhenCreate? }) - Atualiza Data Loader
- executeDataLoaderMitra({ projectId, dataLoaderId }) - Executa Data Loader
- deleteDataLoaderMitra({ projectId, dataLoaderId }) - Remove Data Loader

`typescript
import { createDataLoaderMitra, executeDataLoaderMitra } from 'mitra-sdk';

const loader = await createDataLoaderMitra({
projectId: 123,
jdbcId: 1,
query: 'SELECT * FROM vendas_externas',
name: 'Vendas Externas',
runWhenCreate: true
});

await executeDataLoaderMitra({ projectId: 123, dataLoaderId: 1 });
`

$3

- listProjectUsersMitra({ projectId }) - Lista usuários do projeto
- manageUserAccessMitra({ projectId, email, action, type? }) - Convida, remove ou altera tipo de acesso

`typescript
import { listProjectUsersMitra, manageUserAccessMitra } from 'mitra-sdk';

const users = await listProjectUsersMitra({ projectId: 123 });

// Convidar usuário
await manageUserAccessMitra({ projectId: 123, email: 'user@email.com', action: 'INVITE', type: 'dev' });

// Remover usuário
await manageUserAccessMitra({ projectId: 123, email: 'user@email.com', action: 'REMOVE' });

// Alterar tipo de acesso
await manageUserAccessMitra({ projectId: 123, email: 'user@email.com', action: 'CHANGE_TYPE', type: 'business' });
`

$3

- updateProjectSettingsMitra({ projectId, name?, color?, icon?, allowPublicUpload? }) - Atualiza configurações

`typescript
import { updateProjectSettingsMitra } from 'mitra-sdk';

await updateProjectSettingsMitra({
projectId: 123,
name: 'Meu Projeto',
color: '#4F46E5',
icon: 'BarChart',
allowPublicUpload: true
});
`

$3

- listServerFunctionsMitra({ projectId }) - Lista Server Functions do projeto
- readServerFunctionMitra({ projectId, serverFunctionId }) - Detalhes de uma Server Function (incluindo código)
- createServerFunctionMitra({ projectId, name, code, description? }) - Cria Server Function
- updateServerFunctionMitra({ projectId, serverFunctionId, name?, code?, description? }) - Atualiza Server Function
- deleteServerFunctionMitra({ projectId, serverFunctionId }) - Remove Server Function
- getServerFunctionExecutionMitra({ projectId, executionId }) - Consulta resultado de execução

> Nota: Para executar uma Server Function, use executeServerFunctionMitra do mitra-interactions-sdk.

`typescript
import { listServerFunctionsMitra, readServerFunctionMitra, createServerFunctionMitra } from 'mitra-sdk';

// Listar Server Functions
const functions = await listServerFunctionsMitra({ projectId: 123 });

// Ler detalhes (incluindo código)
const fn = await readServerFunctionMitra({ projectId: 123, serverFunctionId: 1 });

// Criar nova Server Function
const result = await createServerFunctionMitra({
projectId: 123,
name: 'calcularTotal',
code: 'return input.valor * 1.1;',
description: 'Calcula total com 10% de acréscimo'
});
``

Licença

MIT