mitra-interactions-sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,15 +1,15 @@
 # Mitra Interactions SDK
 
-SDK agnóstico para interações com a plataforma Mitra ECP. Funciona com JavaScript, TypeScript, Vue, React, Angular, Node.js e browsers.
+SDK para interações com a plataforma Mitra ECP via endpoints `/agentAiShortcut/`.
 
 ## Instalação
 
 ```bash
-npm install @mitra/interactions-sdk
+npm install mitra-interactions-sdk
 # ou
-yarn add @mitra/interactions-sdk
+yarn add mitra-interactions-sdk
 # ou
-pnpm add @mitra/interactions-sdk
+pnpm add mitra-interactions-sdk
 ```
 
 ## Configuração
@@ -17,249 +17,122 @@ pnpm add @mitra/interactions-sdk
 Antes de usar qualquer função, configure o SDK:
 
 ```typescript
-import { configure } from '@mitra/interactions-sdk';
+import { configureSdkMitra } from 'mitra-interactions-sdk';
 
-configure({
+configureSdkMitra({
   baseURL: 'https://api.mitra.com',
   token: 'seu-jwt-token',
-  // Opcionais:
-  screenId: 123,           // ID da tela atual
-  screenComponentId: 456,  // ID do componente
-  timeout: 30000           // Timeout em ms (padrão: 30000)
+  projectId: 123,    // Opcional, pode ser passado em cada chamada
+  timeout: 30000     // Opcional, padrão: 30000ms
 });
 ```
 
-## Uso
+## Métodos Disponíveis
 
-### Query SQL
+### runQueryMitra
 
-```typescript
-import { queryMitra } from '@mitra/interactions-sdk';
-
-// Query direta
-const result = await queryMitra({
-  query: 'SELECT * FROM usuarios WHERE ativo = 1'
-});
-
-console.log(result.headers); // ['id', 'nome', 'email']
-console.log(result.data);    // [[1, 'João', 'joao@email.com'], ...]
-
-// Com conexão específica
-const result = await queryMitra({
-  query: 'SELECT * FROM produtos',
-  jdbcId: 5,
-  onlineTables: true
-});
-
-// Query a partir de variável customizada
-import { getQueryMitra } from '@mitra/interactions-sdk';
-
-const result = await getQueryMitra({
-  query: 'nome_da_variavel_query'
-});
-```
-
-### DBAction (Ações de Banco)
+Executa uma query SQL (SELECT) em um projeto.
 
 ```typescript
-import { dbactionMitra } from '@mitra/interactions-sdk';
+import { runQueryMitra } from 'mitra-interactions-sdk';
 
-// Executa uma ação
-const result = await dbactionMitra({ actionIds: 123 });
-
-// Executa múltiplas ações
-const result = await dbactionMitra({ actionIds: [123, 456, 789] });
-
-// Com filtros de seleção
-const result = await dbactionMitra({
-  actionIds: 123,
-  selection: [
-    { dimensionId: 1, value: 'teste' },
-    { dimensionId: 2, value: 100 }
-  ]
+const result = await runQueryMitra({
+  projectId: 123,
+  sql: 'SELECT * FROM usuarios LIMIT 10',
+  jdbcId: 1  // Opcional, usa autoConnect se não informado
 });
-
-if (result.successfullyExecuted) {
-  console.log('Ações executadas com sucesso!');
-} else {
-  console.log('Erros:', result.executions.map(e => e.errorMessage));
-}
 ```
 
-### Variáveis
+### executeDbActionMitra
 
-```typescript
-import { setVariableMitra, setVariablesBatch } from '@mitra/interactions-sdk';
+Executa uma DBAction (DML) cadastrada.
 
-// Define uma variável
-await setVariableMitra({
-  name: 'filtro_ativo',
-  content: 'sim'
-});
-
-// Define variável com objeto
-await setVariableMitra({
-  name: 'configuracao',
-  content: { tema: 'dark', idioma: 'pt-BR' }
+```typescript
+import { executeDbActionMitra } from 'mitra-interactions-sdk';
+
+const result = await executeDbActionMitra({
+  projectId: 123,
+  dbactionId: 456,
+  params: {           // Opcional
+    campo1: 'valor1',
+    campo2: 'valor2'
+  }
 });
-
-// Define múltiplas variáveis
-await setVariablesBatch([
-  { name: 'var1', content: 'valor1' },
-  { name: 'var2', content: { objeto: true } }
-]);
 ```
 
-### Upload de Arquivos
+### executeActionMitra
 
-```typescript
-import { uploadFileAsPublic, uploadFileAsLoadable } from '@mitra/interactions-sdk';
-
-// Upload público (URL acessível sem autenticação)
-const url = await uploadFileAsPublic(arquivo);
-
-// Upload para IA (arquivos carregáveis)
-const url = await uploadFileAsLoadable(arquivo);
-
-// Com nome customizado
-const url = await uploadFileAsLoadable(arquivo, 'relatorio-2024.xlsx');
-```
-
-### Download de Arquivos
+Executa uma Action (fluxo de ação) cadastrada.
 
 ```typescript
-import { downloadFileMitra, getFileUrl, downloadFile } from '@mitra/interactions-sdk';
-
-// Obtém URL autenticada
-const result = await downloadFileMitra({ fileKey: 'path/to/file.pdf' });
-console.log(result.url);
+import { executeActionMitra } from 'mitra-interactions-sdk';
 
-// Forma simplificada
-const url = getFileUrl('path/to/file.pdf');
-
-// Download como Blob (para manipulação)
-const result = await downloadFileMitra({
-  fileKey: 'path/to/file.pdf',
-  asBlob: true
+const result = await executeActionMitra({
+  projectId: 123,
+  actionId: 789,
+  params: {}  // Opcional
 });
-
-// Dispara download no browser
-await downloadFile('path/to/file.pdf', 'meu-arquivo.pdf');
 ```
 
-## Uso com Classe (OOP)
+### executeServerFunctionMitra
 
-```typescript
-import { MitraSDK, createMitraSDK } from '@mitra/interactions-sdk';
+Executa uma Server Function cadastrada.
 
-// Usando construtor
-const sdk = new MitraSDK({
-  baseURL: 'https://api.mitra.com',
-  token: 'seu-jwt-token'
-});
+```typescript
+import { executeServerFunctionMitra } from 'mitra-interactions-sdk';
 
-// Ou usando factory
-const sdk = createMitraSDK({
-  baseURL: 'https://api.mitra.com',
-  token: 'seu-jwt-token'
+const result = await executeServerFunctionMitra({
+  projectId: 123,
+  serverfunctionId: 101,
+  params: {           // Opcional
+    arg1: 'valor1'
+  }
 });
-
-// Usando métodos
-const result = await sdk.query({ query: 'SELECT * FROM usuarios' });
-await sdk.dbaction({ actionIds: 123 });
-await sdk.setVariable({ name: 'teste', content: 'valor' });
 ```
 
-## Aliases (Compatibilidade)
+### setFileStatusMitra
 
-Para facilitar migração, existem aliases simplificados:
+Move arquivo do chat para PUBLIC ou LOADABLE.
 
 ```typescript
-import { dbaction, setVariable, query, uploadFile } from '@mitra/interactions-sdk';
+import { setFileStatusMitra } from 'mitra-interactions-sdk';
 
-// Forma simplificada
-await dbaction(123);
-await setVariable('nome', 'valor');
-const result = await query('SELECT * FROM tabela');
-const url = await uploadFile(arquivo);
+const result = await setFileStatusMitra({
+  projectId: 123,
+  fileName: 'arquivo.jpg',
+  targetPath: 'PUBLIC'  // 'PUBLIC' ou 'LOADABLE'
+});
 ```
 
-## Uso em Diferentes Frameworks
+### setVariableMitra
 
-### Vue.js
+Cria ou atualiza uma variável customizada.
 
 ```typescript
-// plugins/mitra.ts
-import { configure } from '@mitra/interactions-sdk';
+import { setVariableMitra } from 'mitra-interactions-sdk';
 
-export default {
-  install(app, options) {
-    configure(options);
-  }
-};
-
-// main.ts
-app.use(mitraPlugin, {
-  baseURL: import.meta.env.VITE_API_URL,
-  token: getToken()
+const result = await setVariableMitra({
+  projectId: 123,
+  key: 'minhaVariavel',
+  value: 'meuValor'  // Opcional
 });
-
-// componente.vue
-import { queryMitra } from '@mitra/interactions-sdk';
-
-const dados = await queryMitra({ query: 'SELECT * FROM tabela' });
-```
-
-### React
-
-```typescript
-// hooks/useMitra.ts
-import { useEffect } from 'react';
-import { configure, queryMitra } from '@mitra/interactions-sdk';
-
-export function useMitra(token: string) {
-  useEffect(() => {
-    configure({
-      baseURL: process.env.REACT_APP_API_URL,
-      token
-    });
-  }, [token]);
-
-  return { queryMitra, /* ... */ };
-}
 ```
 
-### Angular
+## Tratamento de Erros
 
 ```typescript
-// mitra.service.ts
-import { Injectable } from '@angular/core';
-import { configure, queryMitra, dbactionMitra } from '@mitra/interactions-sdk';
-
-@Injectable({ providedIn: 'root' })
-export class MitraService {
-  configure(config) {
-    configure(config);
-  }
-
-  query = queryMitra;
-  dbaction = dbactionMitra;
+try {
+  const result = await runQueryMitra({
+    projectId: 123,
+    sql: 'SELECT * FROM tabela'
+  });
+} catch (error) {
+  console.log('Erro:', error.message);
+  console.log('Status:', error.status);
+  console.log('Detalhes:', error.details);
 }
 ```
 
-### Node.js
-
-```typescript
-import { configure, queryMitra } from '@mitra/interactions-sdk';
-
-configure({
-  baseURL: process.env.MITRA_API_URL,
-  token: process.env.MITRA_TOKEN
-});
-
-const result = await queryMitra({ query: 'SELECT * FROM tabela' });
-```
-
 ## Tipos TypeScript
 
 Todos os tipos estão incluídos:
@@ -267,62 +140,13 @@ Todos os tipos estão incluídos:
 ```typescript
 import type {
   MitraConfig,
-  QueryResult,
-  DBActionResult,
-  UploadResult
-} from '@mitra/interactions-sdk';
-```
-
-## Tratamento de Erros
-
-```typescript
-import { queryMitra } from '@mitra/interactions-sdk';
-import type { ApiError } from '@mitra/interactions-sdk';
-
-try {
-  const result = await queryMitra({ query: 'SELECT * FROM tabela' });
-} catch (error) {
-  const apiError = error as ApiError;
-  console.log('Erro:', apiError.message);
-  console.log('Status:', apiError.status);
-  console.log('Detalhes:', apiError.details);
-}
-```
-
-## Cancelamento de Requisições
-
-```typescript
-const controller = new AbortController();
-
-// Inicia a requisição
-const promise = queryMitra({
-  query: 'SELECT * FROM tabela_grande',
-  signal: controller.signal
-});
-
-// Cancela após 5 segundos
-setTimeout(() => controller.abort(), 5000);
-
-try {
-  const result = await promise;
-} catch (error) {
-  if (error.name === 'AbortError') {
-    console.log('Requisição cancelada');
-  }
-}
-```
-
-## Compatibilidade
-
-- **Browsers**: Chrome 67+, Firefox 68+, Safari 14+, Edge 79+
-- **Node.js**: 14+ (18+ para fetch nativo)
-- **Bundlers**: Webpack, Vite, Rollup, esbuild
-- **Frameworks**: Vue 2/3, React, Angular, Svelte, etc.
-
-## Build
-
-```bash
-npm run build
+  RunQueryOptions,
+  ExecuteDbActionOptions,
+  ExecuteActionOptions,
+  ExecuteServerFunctionOptions,
+  SetFileStatusOptions,
+  SetVariableOptions
+} from 'mitra-interactions-sdk';
 ```
 
 ## Licença

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mitra-interactions-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "SDK agnóstico para interações com a plataforma Mitra ECP",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -13,7 +13,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts --clean",