mintly-lib 2.13.0-preview → 2.14.0-preview

package/build/clients/report-client.d.ts

@@ -2,10 +2,11 @@ import { ResponseDto } from '../core';
 import type { Headers } from '../core/data/request/headers';
 import type { CashFlowQuery, CashFlowReport } from '../core/data/reports/cash-flow-response';
 import type { ResultQuery, ResultReport } from '../core/data/reports/result-response';
+import type { ExpensesQuery, ExpensesReport } from '../core/data/reports/expenses-response';
 /**
  * Relatórios de leitura (módulos novos). Só GETs próprios — compõe o
- * HttpBaseClient pela conexão, como o FinancialMovementClient. As próximas
- * fatias (result, expenses) entram aqui como métodos.
+ * HttpBaseClient pela conexão, como o FinancialMovementClient. A Visão Geral
+ * entra aqui como método.
  */
 export declare class ReportClient {
     private readonly http;
@@ -13,5 +14,7 @@ export declare class ReportClient {
     cashFlow(query: CashFlowQuery, headers: Headers): Promise<ResponseDto<CashFlowReport>>;
     /** Resultado (DRE) do mês: linhas, composição, ponto de equilíbrio, histórico e insights. */
     result(query: ResultQuery, headers: Headers): Promise<ResponseDto<ResultReport>>;
+    /** Custos & Despesas do mês (fatia A): total, CMV, prime cost, taxa de plataforma e categorias. */
+    expenses(query: ExpensesQuery, headers: Headers): Promise<ResponseDto<ExpensesReport>>;
 }
 //# sourceMappingURL=report-client.d.ts.map

package/build/clients/report-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"report-client.d.ts","sourceRoot":"","sources":["../../src/clients/report-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,MAAM,SAAS,CAAA;AAElD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAA;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAA;AAC5F,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAErF;;;;GAIG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAgD;IAErE,oFAAoF;IAC9E,QAAQ,CAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAK7F,6FAA6F;IACvF,MAAM,CAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;CAIxF"}
+{"version":3,"file":"report-client.d.ts","sourceRoot":"","sources":["../../src/clients/report-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,MAAM,SAAS,CAAA;AAElD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAA;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAA;AAC5F,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAA;AAE3F;;;;GAIG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAgD;IAErE,oFAAoF;IAC9E,QAAQ,CAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAK7F,6FAA6F;IACvF,MAAM,CAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAKvF,mGAAmG;IAC7F,QAAQ,CAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;CAI9F"}

package/build/clients/report-client.js

@@ -5,8 +5,8 @@ const core_1 = require("../core");
 const http_base_client_1 = require("../core/client/http-base-client");
 /**
  * Relatórios de leitura (módulos novos). Só GETs próprios — compõe o
- * HttpBaseClient pela conexão, como o FinancialMovementClient. As próximas
- * fatias (result, expenses) entram aqui como métodos.
+ * HttpBaseClient pela conexão, como o FinancialMovementClient. A Visão Geral
+ * entra aqui como método.
  */
 class ReportClient {
     constructor() {
@@ -22,6 +22,11 @@ class ReportClient {
         const response = await this.http.connection.get('/result', (0, core_1.withHeaders)(headers, { params: query }));
         return response.data;
     }
+    /** Custos & Despesas do mês (fatia A): total, CMV, prime cost, taxa de plataforma e categorias. */
+    async expenses(query, headers) {
+        const response = await this.http.connection.get('/expenses', (0, core_1.withHeaders)(headers, { params: query }));
+        return response.data;
+    }
 }
 exports.ReportClient = ReportClient;
 //# sourceMappingURL=report-client.js.map

package/build/clients/report-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"report-client.js","sourceRoot":"","sources":["../../src/clients/report-client.ts"],"names":[],"mappings":";;;AAAA,kCAAkD;AAClD,sEAAgE;AAKhE;;;;GAIG;AACH,MAAa,YAAY;IAAzB;QACmB,SAAI,GAAG,IAAI,iCAAc,CAAiB,SAAS,CAAC,CAAA;IAavE,CAAC;IAXC,oFAAoF;IACpF,KAAK,CAAC,QAAQ,CAAE,KAAoB,EAAE,OAAgB;QACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAA8B,YAAY,EAAE,IAAA,kBAAW,EAAC,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QACnI,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED,6FAA6F;IAC7F,KAAK,CAAC,MAAM,CAAE,KAAkB,EAAE,OAAgB;QAChD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAA4B,SAAS,EAAE,IAAA,kBAAW,EAAC,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QAC9H,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;CACF;AAdD,oCAcC"}
+{"version":3,"file":"report-client.js","sourceRoot":"","sources":["../../src/clients/report-client.ts"],"names":[],"mappings":";;;AAAA,kCAAkD;AAClD,sEAAgE;AAMhE;;;;GAIG;AACH,MAAa,YAAY;IAAzB;QACmB,SAAI,GAAG,IAAI,iCAAc,CAAiB,SAAS,CAAC,CAAA;IAmBvE,CAAC;IAjBC,oFAAoF;IACpF,KAAK,CAAC,QAAQ,CAAE,KAAoB,EAAE,OAAgB;QACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAA8B,YAAY,EAAE,IAAA,kBAAW,EAAC,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QACnI,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED,6FAA6F;IAC7F,KAAK,CAAC,MAAM,CAAE,KAAkB,EAAE,OAAgB;QAChD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAA4B,SAAS,EAAE,IAAA,kBAAW,EAAC,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QAC9H,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAED,mGAAmG;IACnG,KAAK,CAAC,QAAQ,CAAE,KAAoB,EAAE,OAAgB;QACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAA8B,WAAW,EAAE,IAAA,kBAAW,EAAC,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QAClI,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;CACF;AApBD,oCAoBC"}

package/build/core/data/reports/expenses-response.d.ts

@@ -0,0 +1,86 @@
+import type { CategoryBehavior, DreGroup } from '../financial/financial-category-schema';
+import type { MovementChannel } from '../financial/financial-movement-schema';
+/**
+ * Contrato de GET /reports/expenses (fatia 6). Por competência; número cru;
+ * percentuais e variações como fração (0.311 = 31,1%). Spec:
+ * MintlyApi/specs/modulos-novos/20261013/custos-despesas.md.
+ */
+/** `month` em AAAA-MM (padrão: mês corrente). Sem `channel` = Geral. */
+export interface ExpensesQuery {
+    month?: string;
+    channel?: MovementChannel.DineIn | MovementChannel.Delivery;
+}
+export type ExpenseItemKind = 'category' | 'platformFee';
+/** Linha de "Para onde está indo seu dinheiro": categoria ou taxa de uma conta de plataforma. */
+export interface ExpenseItem {
+    /** categoryId, ou `platformFee:<accountId>`. */
+    key: string;
+    kind: ExpenseItemKind;
+    categoryId: string | null;
+    name: string;
+    behavior: CategoryBehavior;
+    dreGroup: DreGroup | null;
+    amount: number;
+    previous: number;
+    /** Média de M−1..M−3 (desde o primeiro lançamento); `null` sem mês elegível. */
+    average3: number | null;
+    deltaPrevious: number | null;
+    deltaAverage3: number | null;
+    pctOfRevenue: number | null;
+}
+export interface ExpensesTotal {
+    current: number;
+    previous: number;
+    average3: number | null;
+    deltaPrevious: number | null;
+    deltaAverage3: number | null;
+}
+export interface ExpensesPlatformFee {
+    amount: number;
+    previous: number;
+    deltaPrevious: number | null;
+    /** Σ receita bruta de canal efetivo delivery no mês. */
+    deliveryRevenue: number;
+    pctOfDelivery: number | null;
+}
+export interface ExpensesReport {
+    referenceMonth: string;
+    previousMonth: string;
+    channel: MovementChannel | null;
+    revenue: {
+        current: number;
+        previous: number;
+    };
+    total: ExpensesTotal;
+    cmv: {
+        amount: number;
+        pctOfRevenue: number | null;
+        target: {
+            min: number;
+            max: number;
+        };
+    };
+    primeCost: {
+        amount: number;
+        cmv: number;
+        labor: number;
+        pctOfRevenue: number | null;
+        targetMax: number;
+    };
+    platformFee: ExpensesPlatformFee;
+    /** Misto separado (a tela mostra "Misto"). */
+    byBehavior: {
+        fixed: number;
+        variable: number;
+        mixed: number;
+    };
+    items: ExpenseItem[];
+    /** Só com `channel`: Σ saídas de canal efetivo `shared` que ficaram de fora. */
+    sharedExcluded: number | null;
+    /** 6 meses, do mais antigo ao mês de referência. */
+    history: {
+        month: string;
+        total: number;
+    }[];
+}
+//# sourceMappingURL=expenses-response.d.ts.map

package/build/core/data/reports/expenses-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expenses-response.d.ts","sourceRoot":"","sources":["../../../../src/core/data/reports/expenses-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAA;AACxF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAE7E;;;;GAIG;AAEH,wEAAwE;AACxE,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,eAAe,CAAC,MAAM,GAAG,eAAe,CAAC,QAAQ,CAAA;CAC5D;AAED,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,aAAa,CAAA;AAExD,iGAAiG;AACjG,MAAM,WAAW,WAAW;IAC1B,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,eAAe,CAAA;IACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,gFAAgF;IAChF,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,wDAAwD;IACxD,eAAe,EAAE,MAAM,CAAA;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,eAAe,GAAG,IAAI,CAAA;IAC/B,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9C,KAAK,EAAE,aAAa,CAAA;IACpB,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,MAAM,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAA;IAC1F,SAAS,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;IACzG,WAAW,EAAE,mBAAmB,CAAA;IAChC,8CAA8C;IAC9C,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9D,KAAK,EAAE,WAAW,EAAE,CAAA;IACpB,gFAAgF;IAChF,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,oDAAoD;IACpD,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAC5C"}

package/build/core/data/reports/expenses-response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=expenses-response.js.map

package/build/core/data/reports/expenses-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expenses-response.js","sourceRoot":"","sources":["../../../../src/core/data/reports/expenses-response.ts"],"names":[],"mappings":""}

package/build/core/data/reports/index.d.ts

@@ -1,3 +1,4 @@
 export * from './cash-flow-response';
 export * from './result-response';
+export * from './expenses-response';
 //# sourceMappingURL=index.d.ts.map

package/build/core/data/reports/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core/data/reports/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core/data/reports/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA"}

package/build/core/data/reports/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./cash-flow-response"), exports);
 __exportStar(require("./result-response"), exports);
+__exportStar(require("./expenses-response"), exports);
 //# sourceMappingURL=index.js.map

package/build/core/data/reports/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/data/reports/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAoC;AACpC,oDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/data/reports/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAoC;AACpC,oDAAiC;AACjC,sDAAmC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mintly-lib",
-  "version": "2.13.0-preview",
+  "version": "2.14.0-preview",
   "description": "Mintly Library",
   "main": "build/index.js",
   "types": "build/index.d.ts",