@databolsa/sdk 1.0.9 → 1.0.11

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, DocumentSearchResponse, PortfolioResponse, Query, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
+import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, DocumentSearchResponse, PortfolioResponse, CommunityBotsResponse, CommunityBotPostInput, CommunityBotPostResponse, CommunityBotReplyResponse, CommunityFeedParams, CommunityFeedResponse, CommunityPostResponse, RegisterCommunityBotInput, RegisterCommunityBotResponse, Query, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse, AddPortfolioTransactionResponse, CreatePortfolioResponse, PortfolioAssetRef, PortfolioDetail, PortfolioHistoryResponse, PortfolioImportInput, PortfolioImportRowsResponse, PortfolioImportsResponse, PortfolioImportSummary, PortfolioPatch, PortfolioRfContract, PortfolioTransaction, PortfolioTransactionInput, PortfolioTransactionPatch, PortfoliosResponse, PortfolioTransactionsResponse } from "./types";
 /** Filtros do screener de ações — derivados de `GET /v1/screener/stocks`. */
 export type ScreenStocksParams = Query<"screenStocks">;
 /**
@@ -192,13 +192,85 @@ export interface DataBolsaClient {
      * Escopada ao dono da chave de API (a mesma da conta) — passe sua chave por usuário.
      */
     getPortfolio(): Promise<PortfolioResponse>;
+    /** Histórico mensal consolidado da carteira (patrimônio × aporte × proventos × realizado). */
+    getPortfolioHistory(): Promise<PortfolioHistoryResponse>;
     /** Seu perfil de investidor (suitability). `profile` é nulo se ainda não definido. */
     getSuitability(): Promise<SuitabilityResponse>;
+    /** Lista as suas carteiras (id, nome, nº de ativos). */
+    listPortfolios(): Promise<PortfoliosResponse>;
+    /** Cria uma carteira. O número de carteiras depende do plano (erro 402 no teto). */
+    createPortfolio(name: string, visibility?: "private" | "unlisted" | "public"): Promise<CreatePortfolioResponse>;
+    /** Uma carteira computada: posições, preço médio, P&L, alocação. */
+    getPortfolioDetail(id: string): Promise<PortfolioDetail>;
+    /** Renomeia, muda visibilidade e/ou marca como simulação. */
+    updatePortfolio(id: string, patch: PortfolioPatch): Promise<unknown>;
+    /** APAGA a carteira com todos os ativos e transações (irreversível). */
+    deletePortfolio(id: string): Promise<{
+        deleted?: boolean;
+    }>;
+    /** Histórico mensal de UMA carteira. */
+    getPortfolioHistoryById(id: string): Promise<PortfolioHistoryResponse>;
+    /** Adiciona um ativo à carteira (idempotente; sem transações = watchlist). */
+    addPortfolioAsset(id: string, asset: PortfolioAssetRef): Promise<unknown>;
+    /** Remove um ativo da carteira, APAGANDO o ledger dele nela (irreversível). */
+    removePortfolioAsset(id: string, asset: PortfolioAssetRef): Promise<unknown>;
+    /** Define a taxa contratada de uma posição de renda fixa (indexer "none" limpa). */
+    updatePortfolioAsset(id: string, asset: PortfolioAssetRef, rf: PortfolioRfContract): Promise<unknown>;
+    /** Ledger (transações) de um ativo da carteira. */
+    listPortfolioTransactions(id: string, asset: PortfolioAssetRef): Promise<PortfolioTransactionsResponse>;
+    /** Lança uma transação; o ativo é adicionado automaticamente se preciso. */
+    addPortfolioTransaction(id: string, asset: PortfolioAssetRef, tx: PortfolioTransactionInput): Promise<AddPortfolioTransactionResponse>;
+    /** Edita uma transação (patch parcial). */
+    updatePortfolioTransaction(id: string, txId: string, patch: PortfolioTransactionPatch): Promise<PortfolioTransaction>;
+    /** Remove uma transação do ledger (irreversível). */
+    deletePortfolioTransaction(id: string, txId: string): Promise<{
+        deleted?: boolean;
+    }>;
+    /**
+     * Importa uma planilha (Negociação/Movimentação da B3 em .xlsx, ou o template
+     * manual em .csv/.xlsx) para a carteira. Idempotente: reenviar o mesmo arquivo
+     * não duplica lançamentos. Retorna o resumo (importadas/duplicadas/avisos).
+     */
+    importPortfolioFile(id: string, input: PortfolioImportInput): Promise<PortfolioImportSummary>;
+    /** Histórico de imports da carteira. */
+    listPortfolioImports(id: string): Promise<PortfolioImportsResponse>;
+    /** Linhas de um import, com status (imported/ignored/duplicate/error) e motivo. */
+    listPortfolioImportRows(id: string, importId: string, params?: {
+        status?: "imported" | "ignored" | "duplicate" | "error";
+        limit?: number;
+        offset?: number;
+    }): Promise<PortfolioImportRowsResponse>;
+    /** Template CSV do import manual (texto). */
+    getPortfolioImportTemplate(): Promise<string>;
+    /** Reconcilia a posição de um ativo à quantidade declarada pela B3 (ajuste idempotente). */
+    reconcilePortfolioAsset(id: string, asset: PortfolioAssetRef, targetQty: number, asOf: string): Promise<unknown>;
     /**
      * Busca semântica no texto de documentos CVM/B3 (fatos relevantes, releases,
      * balanços, relatórios de FII, atas). Filtre por papel/categoria/ano quando souber.
      */
     searchDocuments(q: string, params?: SearchDocumentsParams): Promise<DocumentSearchResponse>;
+    /** Lista os bots de comunidade registrados pela sua conta. */
+    listCommunityBots(): Promise<CommunityBotsResponse>;
+    /**
+     * Registra um bot de comunidade (perfil público @handle que publica via API,
+     * com selo BOT). O número de bots por conta depende do plano.
+     */
+    registerCommunityBot(input: RegisterCommunityBotInput): Promise<RegisterCommunityBotResponse>;
+    /** Desativa um bot da conta (publicações antigas permanecem, rotuladas BOT). */
+    deleteCommunityBot(handle: string): Promise<{
+        ok?: boolean;
+    }>;
+    /**
+     * Publica um post na comunidade em nome do bot (público, com selo BOT).
+     * Moderação automática: conteúdo reprovado vira erro 422 com o motivo.
+     */
+    createCommunityBotPost(handle: string, input: CommunityBotPostInput): Promise<CommunityBotPostResponse>;
+    /** Publica uma resposta em nome do bot num post existente (mesma moderação). */
+    createCommunityBotReply(handle: string, postId: string, body: string): Promise<CommunityBotReplyResponse>;
+    /** Feed público da comunidade, paginado por cursor. */
+    getCommunityFeed(params?: CommunityFeedParams): Promise<CommunityFeedResponse>;
+    /** Um post da comunidade com a discussão completa. */
+    getCommunityPost(id: string): Promise<CommunityPostResponse>;
 }
 export declare class NotInPreviewError extends Error {
     readonly entity: string;

package/dist/http-client.d.ts

@@ -1,5 +1,5 @@
 import { type DataBolsaClient, type LiveQuotesParams, type ScreenFiisParams, type ScreenFundsParams, type ScreenStocksParams } from "./client";
-import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentSearchResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, PortfolioResponse, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
+import type { AddPortfolioTransactionResponse, CreatePortfolioResponse, PortfolioAssetRef, PortfolioDetail, PortfolioHistoryResponse, PortfolioImportInput, PortfolioImportRowsResponse, PortfolioImportsResponse, PortfolioImportSummary, PortfolioPatch, PortfolioRfContract, PortfolioTransaction, PortfolioTransactionInput, PortfolioTransactionPatch, PortfoliosResponse, PortfolioTransactionsResponse, CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentSearchResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, PortfolioResponse, CommunityBotsResponse, CommunityBotPostInput, CommunityBotPostResponse, CommunityBotReplyResponse, CommunityFeedParams, CommunityFeedResponse, CommunityPostResponse, RegisterCommunityBotInput, RegisterCommunityBotResponse, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
 /**
  * Cliente HTTP da Serving API do DataBolsa. Os métodos públicos espelham os
  * operationIds do OpenAPI e retornam tipos gerados.
@@ -22,6 +22,8 @@ export declare class HttpClient implements DataBolsaClient {
     private readonly getToken?;
     constructor(baseUrl: string, opts?: HttpClientOptions);
     private request;
+    /** Como `request`, mas p/ respostas de TEXTO (ex.: o template CSV de import). */
+    private requestText;
     /** Extrai `detail`/`title` de um application/problem+json, se houver. */
     private problemDetail;
     getHealth(): Promise<HealthResponse>;
@@ -164,4 +166,40 @@ export declare class HttpClient implements DataBolsaClient {
     getPortfolio(): Promise<PortfolioResponse>;
     getSuitability(): Promise<SuitabilityResponse>;
     searchDocuments(q: string, params?: SearchDocumentsParams): Promise<DocumentSearchResponse>;
+    listCommunityBots(): Promise<CommunityBotsResponse>;
+    registerCommunityBot(input: RegisterCommunityBotInput): Promise<RegisterCommunityBotResponse>;
+    deleteCommunityBot(handle: string): Promise<{
+        ok?: boolean;
+    }>;
+    createCommunityBotPost(handle: string, input: CommunityBotPostInput): Promise<CommunityBotPostResponse>;
+    createCommunityBotReply(handle: string, postId: string, body: string): Promise<CommunityBotReplyResponse>;
+    getCommunityFeed(params?: CommunityFeedParams): Promise<CommunityFeedResponse>;
+    getCommunityPost(id: string): Promise<CommunityPostResponse>;
+    getPortfolioHistory(): Promise<PortfolioHistoryResponse>;
+    listPortfolios(): Promise<PortfoliosResponse>;
+    createPortfolio(name: string, visibility?: "private" | "unlisted" | "public"): Promise<CreatePortfolioResponse>;
+    getPortfolioDetail(id: string): Promise<PortfolioDetail>;
+    updatePortfolio(id: string, patch: PortfolioPatch): Promise<unknown>;
+    deletePortfolio(id: string): Promise<{
+        deleted?: boolean;
+    }>;
+    getPortfolioHistoryById(id: string): Promise<PortfolioHistoryResponse>;
+    addPortfolioAsset(id: string, asset: PortfolioAssetRef): Promise<unknown>;
+    removePortfolioAsset(id: string, asset: PortfolioAssetRef): Promise<unknown>;
+    updatePortfolioAsset(id: string, asset: PortfolioAssetRef, rf: PortfolioRfContract): Promise<unknown>;
+    listPortfolioTransactions(id: string, asset: PortfolioAssetRef): Promise<PortfolioTransactionsResponse>;
+    addPortfolioTransaction(id: string, asset: PortfolioAssetRef, tx: PortfolioTransactionInput): Promise<AddPortfolioTransactionResponse>;
+    updatePortfolioTransaction(id: string, txId: string, patch: PortfolioTransactionPatch): Promise<PortfolioTransaction>;
+    deletePortfolioTransaction(id: string, txId: string): Promise<{
+        deleted?: boolean;
+    }>;
+    importPortfolioFile(id: string, input: PortfolioImportInput): Promise<PortfolioImportSummary>;
+    listPortfolioImports(id: string): Promise<PortfolioImportsResponse>;
+    listPortfolioImportRows(id: string, importId: string, params?: {
+        status?: "imported" | "ignored" | "duplicate" | "error";
+        limit?: number;
+        offset?: number;
+    }): Promise<PortfolioImportRowsResponse>;
+    getPortfolioImportTemplate(): Promise<string>;
+    reconcilePortfolioAsset(id: string, asset: PortfolioAssetRef, targetQty: number, asOf: string): Promise<unknown>;
 }

package/dist/index.js

@@ -19,7 +19,7 @@ class HttpClient {
     this.base = `${origin}/v1`;
     this.getToken = opts.getToken ?? (opts.apiKey ? () => opts.apiKey : undefined);
   }
-  async request(path, query) {
+  async request(path, query, opts) {
     const url = new URL(this.base + path);
     if (query) {
       for (const [k, v] of Object.entries(query)) {
@@ -31,9 +31,15 @@ class HttpClient {
     const token = this.getToken?.();
     if (token)
       headers.authorization = `Bearer ${token}`;
+    if (opts?.body !== undefined)
+      headers["content-type"] = "application/json";
     let res;
     try {
-      res = await fetch(url, { headers });
+      res = await fetch(url, {
+        method: opts?.method ?? "GET",
+        headers,
+        ...opts?.body !== undefined ? { body: JSON.stringify(opts.body) } : {}
+      });
     } catch (cause) {
       throw new Error(`Falha de rede ao chamar ${path}`, { cause });
     }
@@ -45,6 +51,26 @@ class HttpClient {
     const detail = await this.problemDetail(res);
     throw new Error(`API ${res.status} em ${path}${detail ? `: ${detail}` : ""}`);
   }
+  async requestText(path) {
+    const url = new URL(this.base + path);
+    const headers = { accept: "text/csv, text/plain" };
+    const token = this.getToken?.();
+    if (token)
+      headers.authorization = `Bearer ${token}`;
+    let res;
+    try {
+      res = await fetch(url, { headers });
+    } catch (cause) {
+      throw new Error(`Falha de rede ao chamar ${path}`, { cause });
+    }
+    if (res.ok)
+      return res.text();
+    if (res.status === 501 || res.status === 404) {
+      throw new NotInPreviewError(decodeURIComponent(path.replace(/^\//, "")));
+    }
+    const detail = await this.problemDetail(res);
+    throw new Error(`API ${res.status} em ${path}${detail ? `: ${detail}` : ""}`);
+  }
   async problemDetail(res) {
     try {
       const body = await res.json();
@@ -372,6 +398,143 @@ class HttpClient {
       limit: params?.limit
     });
   }
+  listCommunityBots() {
+    return this.request("/community/bots");
+  }
+  registerCommunityBot(input) {
+    return this.request("/community/bots", undefined, {
+      method: "POST",
+      body: { handle: input.handle, display_name: input.displayName, bio: input.bio }
+    });
+  }
+  deleteCommunityBot(handle) {
+    return this.request(`/community/bots/${enc(handle)}`, undefined, { method: "DELETE" });
+  }
+  createCommunityBotPost(handle, input) {
+    return this.request(`/community/bots/${enc(handle)}/posts`, undefined, {
+      method: "POST",
+      body: { body: input.body, title: input.title, ticker: input.ticker, asset_type: input.assetType }
+    });
+  }
+  createCommunityBotReply(handle, postId, body) {
+    return this.request(`/community/bots/${enc(handle)}/replies`, undefined, {
+      method: "POST",
+      body: { post_id: postId, body }
+    });
+  }
+  getCommunityFeed(params) {
+    return this.request("/community/feed", {
+      tab: params?.tab,
+      ticker: params?.ticker,
+      q: params?.q,
+      cursor: params?.cursor
+    });
+  }
+  getCommunityPost(id) {
+    return this.request(`/community/posts/${enc(id)}`);
+  }
+  getPortfolioHistory() {
+    return this.request("/portfolio/history");
+  }
+  listPortfolios() {
+    return this.request("/portfolios");
+  }
+  createPortfolio(name, visibility) {
+    return this.request("/portfolios", undefined, { method: "POST", body: { name, visibility } });
+  }
+  getPortfolioDetail(id) {
+    return this.request(`/portfolios/${enc(id)}`);
+  }
+  updatePortfolio(id, patch) {
+    return this.request(`/portfolios/${enc(id)}`, undefined, {
+      method: "PATCH",
+      body: { name: patch.name, visibility: patch.visibility, exclude_from_consolidated: patch.excludeFromConsolidated }
+    });
+  }
+  deletePortfolio(id) {
+    return this.request(`/portfolios/${enc(id)}`, undefined, { method: "DELETE" });
+  }
+  getPortfolioHistoryById(id) {
+    return this.request(`/portfolios/${enc(id)}/history`);
+  }
+  addPortfolioAsset(id, asset) {
+    return this.request(`/portfolios/${enc(id)}/assets`, undefined, {
+      method: "POST",
+      body: { asset_type: asset.assetType, symbol: asset.symbol }
+    });
+  }
+  removePortfolioAsset(id, asset) {
+    return this.request(`/portfolios/${enc(id)}/assets`, { asset_type: asset.assetType, symbol: asset.symbol }, { method: "DELETE" });
+  }
+  updatePortfolioAsset(id, asset, rf) {
+    return this.request(`/portfolios/${enc(id)}/assets`, { asset_type: asset.assetType, symbol: asset.symbol }, { method: "PATCH", body: { rf_indexer: rf.indexer, rf_rate: rf.rate } });
+  }
+  listPortfolioTransactions(id, asset) {
+    return this.request(`/portfolios/${enc(id)}/transactions`, {
+      asset_type: asset.assetType,
+      symbol: asset.symbol
+    });
+  }
+  addPortfolioTransaction(id, asset, tx) {
+    return this.request(`/portfolios/${enc(id)}/transactions`, undefined, {
+      method: "POST",
+      body: {
+        asset_type: asset.assetType,
+        symbol: asset.symbol,
+        kind: tx.kind,
+        trade_date: tx.tradeDate,
+        quantity: tx.quantity,
+        price: tx.price,
+        fees: tx.fees,
+        ratio: tx.ratio,
+        note: tx.note
+      }
+    });
+  }
+  updatePortfolioTransaction(id, txId, patch) {
+    return this.request(`/portfolios/${enc(id)}/transactions/${enc(txId)}`, undefined, {
+      method: "PATCH",
+      body: {
+        kind: patch.kind,
+        trade_date: patch.tradeDate,
+        quantity: patch.quantity,
+        price: patch.price,
+        fees: patch.fees,
+        ratio: patch.ratio,
+        note: patch.note
+      }
+    });
+  }
+  deletePortfolioTransaction(id, txId) {
+    return this.request(`/portfolios/${enc(id)}/transactions/${enc(txId)}`, undefined, {
+      method: "DELETE"
+    });
+  }
+  importPortfolioFile(id, input) {
+    return this.request(`/portfolios/${enc(id)}/imports`, undefined, {
+      method: "POST",
+      body: { content_base64: input.contentBase64, filename: input.filename }
+    });
+  }
+  listPortfolioImports(id) {
+    return this.request(`/portfolios/${enc(id)}/imports`);
+  }
+  listPortfolioImportRows(id, importId, params) {
+    return this.request(`/portfolios/${enc(id)}/imports/${enc(importId)}/rows`, {
+      status: params?.status,
+      limit: params?.limit,
+      offset: params?.offset
+    });
+  }
+  getPortfolioImportTemplate() {
+    return this.requestText("/portfolios/import-template");
+  }
+  reconcilePortfolioAsset(id, asset, targetQty, asOf) {
+    return this.request(`/portfolios/${enc(id)}/reconcile`, undefined, {
+      method: "POST",
+      body: { asset_type: asset.assetType, symbol: asset.symbol, target_qty: targetQty, as_of: asOf }
+    });
+  }
 }
 function enc(segment) {
   return encodeURIComponent(segment);