@stackin-io/stackin-node-sdk 0.15.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -126,6 +126,86 @@ await client.issue({
126
126
 
127
127
  `items` is an array of `br.Product` — `description`/`amount` apply to any document type; `ncm`/`cfop` (plus everything else on `Product`: `cest`, tax groups, presumed credits...) are Brazil-specific and required per item for NFE, ignored for NFSE (a service isn't a physical good). `ncm` is the full 8 digits, or `00` for a service line — any other 2-digit chapter is refused with a `ValidationError` when the `Product` is built, since the SEFAZ rejects it with `777`. `barcode` (cEAN) is `"SEM GTIN"` or a GTIN of 8, 12, 13 or 14 digits whose GS1 check digit is right, also checked when the `Product` is built. `recopiNumber` must be the 20-digit RECOPI number; the SDK checks its two modulo-11 check digits (MOC §8.5) before sending. On an NFE, each `description` is at most 120 characters (the layout's `xProd`), checked by `issue()`; an NFSE description has no such limit. Every text an NFE sends — item fields, `clientName`, every `recipientAddress` field, observations, purchase order — must fit ISO-8859-1 (latin1): accents like `ç`/`ã` are fine, and so are tab, newline and CR, which the API folds into a space. Anything the NF-e cannot carry (emoji, CJK, Cyrillic…) is refused, and `issue()` names the first offending field before the request goes out; typographic quotes, dashes, ellipsis, bullet, `€` and `™` are converted by the API, so they are sent as given. NFSE text is not restricted.
128
128
 
129
+ ## Discount, emission time, returns and buyers abroad
130
+
131
+ These `issue()` fields are optional, and each is left out of the request when unset, so a call that does not use them sends exactly what it sent before.
132
+
133
+ ```ts
134
+ import { Direction, Purpose } from "@stackin-io/stackin-node-sdk";
135
+
136
+ // A discount on the whole document, spread by the API over the lines, and an
137
+ // explicit emission moment.
138
+ await client.issue({
139
+ ...request,
140
+ discount: 15.0,
141
+ issuedAt: "2026-11-15T10:30:00-03:00",
142
+ });
143
+
144
+ // A buyer returning goods: an incoming NF-e that references the original.
145
+ await client.issue({
146
+ ...request,
147
+ purpose: Purpose.RETURN,
148
+ direction: Direction.IN,
149
+ referencedKeys: ["35260611111111111111550010000000011000000014"],
150
+ });
151
+
152
+ // A buyer abroad: no taxId, state EX with the BACEN country code, and where the
153
+ // goods leave Brazil.
154
+ await client.issue({
155
+ documentType: DocumentType.NFE,
156
+ clientName: "Acme Inc.",
157
+ foreignId: "P1234567",
158
+ items: [new br.Product({ description: "Couro", unitPrice: 900.0, ncm: "41071200", cfop: "7101" })],
159
+ recipientAddress: new Address({
160
+ street: "5th Avenue",
161
+ number: "350",
162
+ neighborhood: "Midtown",
163
+ city: "New York",
164
+ state: "EX",
165
+ countryCode: "2496",
166
+ countryName: "Estados Unidos",
167
+ }),
168
+ export: { exitState: "SP", place: "Porto de Santos", dispatchPlace: "Alfandega de Santos" },
169
+ });
170
+ ```
171
+
172
+ | Field | Wire name | What it is |
173
+ |---|---|---|
174
+ | `discount` | `discount` | A discount on the whole document in BRL, at least 0; sent as a decimal string like `amount`. |
175
+ | `issuedAt` | `issued_at` | The emission moment. A `Date` is sent as its UTC instant (`toISOString()`); a string must be ISO 8601 with an offset (`Z` or `±hh:mm`), and one without is a `ValidationError` before the request. NF-e: at most 30 days back and 5 minutes ahead; NFS-e: never ahead. The API defaults it to now. |
176
+ | `purpose` | `purpose` | `Purpose.NORMAL`, `COMPLEMENTARY`, `ADJUSTMENT` or `RETURN` (finNFe). NF-e only; the API defaults to `NORMAL`. |
177
+ | `direction` | `direction` | `Direction.OUT` or `IN` (tpNF). `IN` is an incoming NF-e the company issues itself, a sale returned by the buyer say. NF-e only; the API defaults to `OUT`. |
178
+ | `referencedKeys` | `referenced_keys` | Access keys of the NF-e, NFC-e or CF-e this one refers to. Required for `COMPLEMENTARY` (exactly one) and, but for a few CFOPs, for `RETURN`. NF-e only. |
179
+ | `foreignId` | `foreign_id` | The passport or other document of a buyer abroad, 5 to 20 letters, digits or `:.+-/()`. May be left out. |
180
+ | `export` | `export` | `{ exitState, place, dispatchPlace? }`: the Brazilian state and place the goods leave from, and the customs facility. Required on an outgoing NF-e abroad. |
181
+
182
+ A buyer abroad is `recipientAddress.state` = `"EX"`, NF-e only. There `taxId` is left out (the API refuses one, rejection 720), `zipCode` and `cityCode` may be left out (the API writes `9999999` / EXTERIOR), and `countryCode` — the BACEN country code, 1 to 4 digits, anything but 1058 — is required in their place, beside an optional `countryName`. The SDK does not check the BACEN code's check digit: the official table has countries whose digit does not close. Everywhere else `taxId` and `zipCode` stay required, and a missing one is a `ValidationError` before the request.
183
+
184
+ The SDK checks locally only what is unambiguous — types, the two enums, an `issuedAt` without an offset, `export` without `exitState` or `place`. The fiscal rules (the emission window, which purpose needs which keys, when `export` is due) belong to the API, which answers them by name.
185
+
186
+ ### Fuel
187
+
188
+ A product sold under a fuel CFOP needs the NF-e fuel group (`comb`), or the SEFAZ answers 660. Set it as `fuel` on `br.Product`; it is sent under `product.br.fuel` with snake_case keys:
189
+
190
+ ```ts
191
+ new br.Product({
192
+ description: "Oleo diesel B S10",
193
+ unitPrice: 6.29,
194
+ quantity: 1000,
195
+ unit: "L",
196
+ ncm: "27101921",
197
+ cfop: "5656",
198
+ fuel: {
199
+ anpCode: "820101034",
200
+ anpDescription: "OLEO DIESEL B S10 - COMUM",
201
+ consumerState: "SP",
202
+ biodieselPercent: 14,
203
+ },
204
+ });
205
+ ```
206
+
207
+ `anpCode` (9 digits, from the ANP SIMP table), `anpDescription` and `consumerState` are required; `glpPercent`, `naturalGasNationalPercent`, `naturalGasImportedPercent`, `startingValue`, `codif`, `temperatureQuantity` and `biodieselPercent` are optional. Parts of the group `fuel` does not cover (CIDE, encerrante, origComb) still go through `extraGroups.comb` — but never both at once: a `Product` with `fuel` and `extraGroups.comb` is refused with a `ValidationError` when it is built.
208
+
129
209
  ## Retrying safely
130
210
 
131
211
  Issuing is the one call you must not repeat blindly. If the response is lost — a
@@ -291,9 +371,34 @@ Three things worth knowing before you loop:
291
371
 
292
372
  `Taxpayer` has one method and keeps one: the registry holds the names and addresses of real people, so there is no search over it, by design.
293
373
 
374
+ ## One credential, several companies
375
+
376
+ An API key is one company and needs nothing here. A credential that covers several companies (an OAuth connection) has to say which one each call acts on, by company id (UUID) or CNPJ — punctuation is ignored. Set it on the client, or per call; the call's wins. It goes out as the `X-Stackin-Company` header, on every request, lookups included. Unset, no header is sent and the request is exactly what it was before.
377
+
378
+ ```ts
379
+ import { Invoice, DocumentType } from "@stackin-io/stackin-node-sdk";
380
+
381
+ const client = new Invoice({ apiKey: "...", company: "11.222.333/0001-81" });
382
+
383
+ const { environment, companies } = await client.companies();
384
+ // companies: [{ company_id, name, tax_id, permissions: [...] }]
385
+
386
+ await client.consult("ACCESS_KEY...", {
387
+ documentType: DocumentType.NFSE,
388
+ company: companies[1].company_id,
389
+ });
390
+ ```
391
+
392
+ `companies()` (`GET /me/companies`) lists what the credential reaches and with which permissions; an API key lists its one company with every permission. Every `Invoice` method takes `company` among its options (`issue()` in the request). `FiscalReference` and `Taxpayer` take it on the client; the API ignores it there.
393
+
294
394
  ## Errors
295
395
 
296
396
  - `APIError` — the API responded with a non-2xx status (`statusCode`, `detail`) — a 401 here means `apiKey` is missing, wrong, or was rotated.
397
+ - `CompanyRequiredError` (422) — the credential covers several companies and the call named none. `companies` lists them.
398
+ - `CompanyNotInScopeError` (403) — the company named is not one the credential covers. `companies` lists the ones it does.
399
+ - `InsufficientPermissionError` (403) — the credential reaches the company but lacks the permission; `detail` reads `needs X, has Y, company=<id>`.
400
+
401
+ All three extend `APIError` and are never retried: the answer would not change.
297
402
  - `ConnectionFailedError` — the API didn't respond (network/DNS/timeout).
298
403
  - `ValidationError` — `issue()`'s `items` is empty, missing `ncm`/`cfop` on an item for NFE, a missing/incomplete `recipientAddress` on NFE, an NFE item `description` over 120 characters, NFE text the NF-e cannot carry (outside ISO-8859-1, other than the typographic characters the API converts), a missing/incomplete `recipientAddress` on an NFSE with a `taxRetained` item, or a `correct()` access key that is not an NF-e access key (44 characters). Building a `Product` with a malformed `ncm`, `barcode` or `recopiNumber`, or an `Address` with a `street`/`neighborhood` under 2 characters, raises it too.
299
404
 
package/dist/address.d.ts CHANGED
@@ -4,9 +4,21 @@ export interface AddressFields {
4
4
  neighborhood?: string;
5
5
  city?: string;
6
6
  state?: string;
7
+ /** CEP, 8 digits. Required, except for a buyer abroad (state EX). */
7
8
  zipCode?: string;
8
9
  cityCode?: string;
10
+ /**
11
+ * BACEN country code, 1 to 4 digits (2496 United States, 0639
12
+ * Argentina). Brazil (1058) when left out; required, and not 1058,
13
+ * for a buyer abroad (state EX). Its check digit is not checked: the
14
+ * official table has countries whose digit does not close.
15
+ */
16
+ countryCode?: string;
17
+ /** The country's name, printed beside countryCode. */
18
+ countryName?: string;
9
19
  }
20
+ /** The state of an NF-e buyer abroad. */
21
+ export declare const ABROAD_STATE = "EX";
10
22
  export declare class Address {
11
23
  street?: string;
12
24
  number?: string;
@@ -15,6 +27,8 @@ export declare class Address {
15
27
  state?: string;
16
28
  zipCode?: string;
17
29
  cityCode?: string;
30
+ countryCode?: string;
31
+ countryName?: string;
18
32
  constructor(fields?: AddressFields);
19
33
  toJSON(): Record<string, string>;
20
34
  }
@@ -1 +1 @@
1
- {"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../src/address.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAUD,qBAAa,OAAO;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAEN,MAAM,GAAE,aAAkB;IAYtC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAWjC"}
1
+ {"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../src/address.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAID,yCAAyC;AACzC,eAAO,MAAM,YAAY,OAAO,CAAC;AAQjC,qBAAa,OAAO;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;gBAET,MAAM,GAAE,aAAkB;IActC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAajC"}
package/dist/address.js CHANGED
@@ -1,7 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Address = void 0;
3
+ exports.Address = exports.ABROAD_STATE = void 0;
4
4
  const errors_1 = require("./errors");
5
+ /** The state of an NF-e buyer abroad. */
6
+ exports.ABROAD_STATE = "EX";
5
7
  function requireMinLength(field, value) {
6
8
  if (value !== undefined && value !== null && value.trim().length < 2) {
7
9
  throw new errors_1.ValidationError(`${field} must have at least 2 characters`);
@@ -15,6 +17,8 @@ class Address {
15
17
  state;
16
18
  zipCode;
17
19
  cityCode;
20
+ countryCode;
21
+ countryName;
18
22
  constructor(fields = {}) {
19
23
  requireMinLength("street", fields.street);
20
24
  requireMinLength("neighborhood", fields.neighborhood);
@@ -25,6 +29,8 @@ class Address {
25
29
  this.state = fields.state;
26
30
  this.zipCode = fields.zipCode;
27
31
  this.cityCode = fields.cityCode;
32
+ this.countryCode = fields.countryCode;
33
+ this.countryName = fields.countryName;
28
34
  }
29
35
  toJSON() {
30
36
  const out = {};
@@ -42,6 +48,10 @@ class Address {
42
48
  out.zip_code = this.zipCode;
43
49
  if (this.cityCode)
44
50
  out.city_code = this.cityCode;
51
+ if (this.countryCode)
52
+ out.country_code = this.countryCode;
53
+ if (this.countryName)
54
+ out.country_name = this.countryName;
45
55
  return out;
46
56
  }
47
57
  }
@@ -1 +1 @@
1
- {"version":3,"file":"address.js","sourceRoot":"","sources":["../src/address.ts"],"names":[],"mappings":";;;AAUA,qCAA2C;AAE3C,SAAS,gBAAgB,CAAC,KAAa,EAAE,KAAyB;IAChE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrE,MAAM,IAAI,wBAAe,CAAC,GAAG,KAAK,kCAAkC,CAAC,CAAC;IACxE,CAAC;AACH,CAAC;AAED,MAAa,OAAO;IAClB,MAAM,CAAU;IAChB,MAAM,CAAU;IAChB,YAAY,CAAU;IACtB,IAAI,CAAU;IACd,KAAK,CAAU;IACf,OAAO,CAAU;IACjB,QAAQ,CAAU;IAElB,YAAY,SAAwB,EAAE;QACpC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1C,gBAAgB,CAAC,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IAClC,CAAC;IAED,MAAM;QACJ,MAAM,GAAG,GAA2B,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,MAAM;YAAE,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,MAAM;YAAE,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY;YAAE,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5D,IAAI,IAAI,CAAC,IAAI;YAAE,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACpC,IAAI,IAAI,CAAC,KAAK;YAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACvC,IAAI,IAAI,CAAC,OAAO;YAAE,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9C,IAAI,IAAI,CAAC,QAAQ;YAAE,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAhCD,0BAgCC"}
1
+ {"version":3,"file":"address.js","sourceRoot":"","sources":["../src/address.ts"],"names":[],"mappings":";;;AAoBA,qCAA2C;AAE3C,yCAAyC;AAC5B,QAAA,YAAY,GAAG,IAAI,CAAC;AAEjC,SAAS,gBAAgB,CAAC,KAAa,EAAE,KAAyB;IAChE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrE,MAAM,IAAI,wBAAe,CAAC,GAAG,KAAK,kCAAkC,CAAC,CAAC;IACxE,CAAC;AACH,CAAC;AAED,MAAa,OAAO;IAClB,MAAM,CAAU;IAChB,MAAM,CAAU;IAChB,YAAY,CAAU;IACtB,IAAI,CAAU;IACd,KAAK,CAAU;IACf,OAAO,CAAU;IACjB,QAAQ,CAAU;IAClB,WAAW,CAAU;IACrB,WAAW,CAAU;IAErB,YAAY,SAAwB,EAAE;QACpC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1C,gBAAgB,CAAC,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;IACxC,CAAC;IAED,MAAM;QACJ,MAAM,GAAG,GAA2B,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,MAAM;YAAE,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,MAAM;YAAE,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY;YAAE,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5D,IAAI,IAAI,CAAC,IAAI;YAAE,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACpC,IAAI,IAAI,CAAC,KAAK;YAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACvC,IAAI,IAAI,CAAC,OAAO;YAAE,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9C,IAAI,IAAI,CAAC,QAAQ;YAAE,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjD,IAAI,IAAI,CAAC,WAAW;YAAE,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC;QAC1D,IAAI,IAAI,CAAC,WAAW;YAAE,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC;QAC1D,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAtCD,0BAsCC"}
@@ -1,5 +1,5 @@
1
1
  export { Product } from "./product";
2
- export type { IbsCbsFields, PresumedCredit, ProductFields } from "./product";
2
+ export type { FuelFields, IbsCbsFields, PresumedCredit, ProductFields, } from "./product";
3
3
  export { Tax, cofinsAliq, cofinsNt, cofinsOutr, cofinsQtde, cofinsSt, icms00, icms02, icms10, icms15, icms20, icms30, icms40, icms51, icms53, icms60, icms61, icms70, icms90, icmsPart, icmsSn101, icmsSn102, icmsSn201, icmsSn202, icmsSn500, icmsSn900, icmsSt, icmsUfDest, ipi, ipiNt, ipiTrib, pisAliq, pisNt, pisOutr, pisQtde, pisSt, } from "./tax";
4
4
  export type { CofinsAliqFields, CofinsNtFields, CofinsOutrFields, CofinsQtdeFields, CofinsStFields, Icms00Fields, Icms02Fields, Icms10Fields, Icms15Fields, Icms20Fields, Icms30Fields, Icms40Fields, Icms51Fields, Icms53Fields, Icms60Fields, Icms61Fields, Icms70Fields, Icms90Fields, IcmsPartFields, IcmsSn101Fields, IcmsSn102Fields, IcmsSn201Fields, IcmsSn202Fields, IcmsSn500Fields, IcmsSn900Fields, IcmsStFields, IcmsUfDestFields, IpiFields, IpiNtFields, IpiTribFields, PisAliqFields, PisNtFields, PisOutrFields, PisQtdeFields, PisStFields, TaxFields, TaxGroup, } from "./tax";
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/br/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC7E,OAAO,EACL,GAAG,EACH,UAAU,EACV,QAAQ,EACR,UAAU,EACV,UAAU,EACV,QAAQ,EACR,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,QAAQ,EACR,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,MAAM,EACN,UAAU,EACV,GAAG,EACH,KAAK,EACL,OAAO,EACP,OAAO,EACP,KAAK,EACL,OAAO,EACP,OAAO,EACP,KAAK,GACN,MAAM,OAAO,CAAC;AACf,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,WAAW,EACX,aAAa,EACb,aAAa,EACb,WAAW,EACX,aAAa,EACb,aAAa,EACb,WAAW,EACX,SAAS,EACT,QAAQ,GACT,MAAM,OAAO,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/br/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,YAAY,EACV,UAAU,EACV,YAAY,EACZ,cAAc,EACd,aAAa,GACd,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,GAAG,EACH,UAAU,EACV,QAAQ,EACR,UAAU,EACV,UAAU,EACV,QAAQ,EACR,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,QAAQ,EACR,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,MAAM,EACN,UAAU,EACV,GAAG,EACH,KAAK,EACL,OAAO,EACP,OAAO,EACP,KAAK,EACL,OAAO,EACP,OAAO,EACP,KAAK,GACN,MAAM,OAAO,CAAC;AACf,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,WAAW,EACX,aAAa,EACb,aAAa,EACb,WAAW,EACX,aAAa,EACb,aAAa,EACb,WAAW,EACX,SAAS,EACT,QAAQ,GACT,MAAM,OAAO,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/br/index.ts"],"names":[],"mappings":";;;AAAA,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAEhB,6BAqCe;AApCb,0FAAA,GAAG,OAAA;AACH,iGAAA,UAAU,OAAA;AACV,+FAAA,QAAQ,OAAA;AACR,iGAAA,UAAU,OAAA;AACV,iGAAA,UAAU,OAAA;AACV,+FAAA,QAAQ,OAAA;AACR,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,+FAAA,QAAQ,OAAA;AACR,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,6FAAA,MAAM,OAAA;AACN,iGAAA,UAAU,OAAA;AACV,0FAAA,GAAG,OAAA;AACH,4FAAA,KAAK,OAAA;AACL,8FAAA,OAAO,OAAA;AACP,8FAAA,OAAO,OAAA;AACP,4FAAA,KAAK,OAAA;AACL,8FAAA,OAAO,OAAA;AACP,8FAAA,OAAO,OAAA;AACP,4FAAA,KAAK,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/br/index.ts"],"names":[],"mappings":";;;AAAA,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAOhB,6BAqCe;AApCb,0FAAA,GAAG,OAAA;AACH,iGAAA,UAAU,OAAA;AACV,+FAAA,QAAQ,OAAA;AACR,iGAAA,UAAU,OAAA;AACV,iGAAA,UAAU,OAAA;AACV,+FAAA,QAAQ,OAAA;AACR,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,6FAAA,MAAM,OAAA;AACN,+FAAA,QAAQ,OAAA;AACR,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,gGAAA,SAAS,OAAA;AACT,6FAAA,MAAM,OAAA;AACN,iGAAA,UAAU,OAAA;AACV,0FAAA,GAAG,OAAA;AACH,4FAAA,KAAK,OAAA;AACL,8FAAA,OAAO,OAAA;AACP,8FAAA,OAAO,OAAA;AACP,4FAAA,KAAK,OAAA;AACL,8FAAA,OAAO,OAAA;AACP,8FAAA,OAAO,OAAA;AACP,4FAAA,KAAK,OAAA"}
@@ -12,6 +12,33 @@ export interface IbsCbsFields {
12
12
  rate_city: number;
13
13
  rate_federal: number;
14
14
  }
15
+ /**
16
+ * The NF-e fuel group (comb), needed for a CFOP the official table marks
17
+ * as fuel. Groups it does not cover (CIDE, encerrante, origComb) still go
18
+ * through extraGroups.comb, but never both at once.
19
+ */
20
+ export interface FuelFields {
21
+ /** cProdANP: 9 digits, from the ANP SIMP table. */
22
+ anpCode: string;
23
+ /** descANP: the ANP description, 2 to 95 characters. */
24
+ anpDescription: string;
25
+ /** UFCons: the state where it is consumed. */
26
+ consumerState: string;
27
+ /** pGLP, GLP only. */
28
+ glpPercent?: number;
29
+ /** pGNn, GLP only. */
30
+ naturalGasNationalPercent?: number;
31
+ /** pGNi, GLP only. */
32
+ naturalGasImportedPercent?: number;
33
+ /** vPart, GLP only. */
34
+ startingValue?: number;
35
+ /** CODIF, up to 21 digits. */
36
+ codif?: string;
37
+ /** qTemp: the quantity at 20 °C. */
38
+ temperatureQuantity?: number;
39
+ /** pBio. */
40
+ biodieselPercent?: number;
41
+ }
15
42
  export interface ProductFields {
16
43
  description: string;
17
44
  amount?: number;
@@ -43,11 +70,14 @@ export interface ProductFields {
43
70
  ibsCbs?: IbsCbsFields;
44
71
  extraGroups?: Record<string, unknown>;
45
72
  tax?: Record<string, unknown>;
73
+ /** The NF-e fuel group, sent under product.br.fuel. */
74
+ fuel?: FuelFields;
46
75
  serviceCode?: string;
47
76
  serviceDiscount?: number;
48
77
  taxRetained?: boolean;
49
78
  observations?: string;
50
79
  }
80
+ export declare function decimalString(value?: number): string | undefined;
51
81
  export declare class Product {
52
82
  description: string;
53
83
  amount?: number;
@@ -76,6 +106,7 @@ export declare class Product {
76
106
  ibsCbs?: IbsCbsFields;
77
107
  extraGroups?: Record<string, unknown>;
78
108
  tax?: Record<string, unknown>;
109
+ fuel?: FuelFields;
79
110
  serviceCode?: string;
80
111
  serviceDiscount?: number;
81
112
  taxRetained: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"product.d.ts","sourceRoot":"","sources":["../../src/br/product.ts"],"names":[],"mappings":"AA8CA,kDAAkD;AAClD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qFAAqF;IACrF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gGAAgG;IAChG,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,6EAA6E;IAC7E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AA2DD,qBAAa,OAAO;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEV,MAAM,EAAE,aAAa;IAyEjC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAmClC"}
1
+ {"version":3,"file":"product.d.ts","sourceRoot":"","sources":["../../src/br/product.ts"],"names":[],"mappings":"AA8CA,kDAAkD;AAClD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAChB,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAC;IACtB,sBAAsB;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sBAAsB;IACtB,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,sBAAsB;IACtB,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,uBAAuB;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oCAAoC;IACpC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,YAAY;IACZ,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AA8BD,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qFAAqF;IACrF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gGAAgG;IAChG,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,6EAA6E;IAC7E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,uDAAuD;IACvD,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAqDD,wBAAgB,aAAa,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAIhE;AAED,qBAAa,OAAO;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEV,MAAM,EAAE,aAAa;IAuFjC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAoClC"}
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Product = void 0;
4
+ exports.decimalString = decimalString;
4
5
  const errors_1 = require("../errors");
5
6
  const NCM_PATTERN = /^(00|\d{8})$/;
6
7
  const BARCODE_PATTERN = /^(SEM GTIN|\d{8}|\d{12,14})$/;
@@ -34,6 +35,32 @@ function hasValidRecopiCheckDigits(recopi) {
34
35
  return (recopiCheckDigit(digits.slice(0, 18)) === digits[18] &&
35
36
  recopiCheckDigit(digits.slice(0, 19)) === digits[19]);
36
37
  }
38
+ const FUEL_KEYS = {
39
+ anpCode: "anp_code",
40
+ anpDescription: "anp_description",
41
+ consumerState: "consumer_state",
42
+ glpPercent: "glp_percent",
43
+ naturalGasNationalPercent: "natural_gas_national_percent",
44
+ naturalGasImportedPercent: "natural_gas_imported_percent",
45
+ startingValue: "starting_value",
46
+ codif: "codif",
47
+ temperatureQuantity: "temperature_quantity",
48
+ biodieselPercent: "biodiesel_percent",
49
+ };
50
+ const FUEL_REQUIRED = [
51
+ "anpCode",
52
+ "anpDescription",
53
+ "consumerState",
54
+ ];
55
+ function fuelJSON(fuel) {
56
+ const out = {};
57
+ for (const [key, wire] of Object.entries(FUEL_KEYS)) {
58
+ const value = fuel[key];
59
+ if (value !== undefined && value !== null)
60
+ out[wire] = value;
61
+ }
62
+ return out;
63
+ }
37
64
  const BR_KEYS = [
38
65
  "ncm",
39
66
  "cfop",
@@ -114,6 +141,7 @@ class Product {
114
141
  ibsCbs;
115
142
  extraGroups;
116
143
  tax;
144
+ fuel;
117
145
  serviceCode;
118
146
  serviceDiscount;
119
147
  taxRetained;
@@ -148,6 +176,15 @@ class Product {
148
176
  throw new errors_1.ValidationError("recopiNumber has invalid check digits");
149
177
  }
150
178
  }
179
+ if (fields.fuel !== undefined) {
180
+ const missing = FUEL_REQUIRED.filter((key) => !fields.fuel?.[key]);
181
+ if (missing.length > 0) {
182
+ throw new errors_1.ValidationError(`fuel is missing required fields: ${missing.join(", ")}`);
183
+ }
184
+ if (fields.extraGroups && "comb" in fields.extraGroups) {
185
+ throw new errors_1.ValidationError("send the fuel group once: fuel or extraGroups.comb");
186
+ }
187
+ }
151
188
  this.description = fields.description;
152
189
  this.amount = fields.amount;
153
190
  this.unitPrice = fields.unitPrice;
@@ -175,6 +212,7 @@ class Product {
175
212
  this.ibsCbs = fields.ibsCbs;
176
213
  this.extraGroups = fields.extraGroups;
177
214
  this.tax = fields.tax;
215
+ this.fuel = fields.fuel;
178
216
  this.serviceCode = fields.serviceCode;
179
217
  this.serviceDiscount = fields.serviceDiscount;
180
218
  this.taxRetained = fields.taxRetained ?? false;
@@ -200,6 +238,8 @@ class Product {
200
238
  br[snake(key)] = value;
201
239
  }
202
240
  }
241
+ if (this.fuel)
242
+ br.fuel = fuelJSON(this.fuel);
203
243
  if (Object.keys(br).length > 0) {
204
244
  product.br = br;
205
245
  }
@@ -1 +1 @@
1
- {"version":3,"file":"product.js","sourceRoot":"","sources":["../../src/br/product.ts"],"names":[],"mappings":";;;AAAA,sCAA4C;AAE5C,MAAM,WAAW,GAAG,cAAc,CAAC;AACnC,MAAM,eAAe,GAAG,8BAA8B,CAAC;AACvD,MAAM,cAAc,GAAG,UAAU,CAAC;AAElC;;;;GAIG;AACH,SAAS,sBAAsB,CAAC,IAAY;IAC1C,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,EAAY,CAAC;IACrC,MAAM,GAAG,GAAG,MAAM;SACf,OAAO,EAAE;SACT,MAAM,CACL,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,GAAG,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAClE,CAAC,CACF,CAAC;IACJ,OAAO,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,KAAK,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,MAAgB;IACxC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CACvB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,EAChE,CAAC,CACF,CAAC;IACF,MAAM,SAAS,GAAG,GAAG,GAAG,EAAE,CAAC;IAC3B,OAAO,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC;AAC5C,CAAC;AAED,SAAS,yBAAyB,CAAC,MAAc;IAC/C,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvC,OAAO,CACL,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC;QACpD,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC,CACrD,CAAC;AACJ,CAAC;AAyDD,MAAM,OAAO,GAA+B;IAC1C,KAAK;IACL,MAAM;IACN,MAAM;IACN,UAAU;IACV,WAAW;IACX,kBAAkB;IAClB,gBAAgB;IAChB,iBAAiB;IACjB,QAAQ;IACR,4BAA4B;IAC5B,cAAc;IACd,aAAa;IACb,QAAQ;IACR,KAAK;CACN,CAAC;AAEF,MAAM,cAAc,GAA2B;IAC7C,QAAQ,EAAE,WAAW;IACrB,SAAS,EAAE,YAAY;IACvB,gBAAgB,EAAE,mBAAmB;IACrC,cAAc,EAAE,kBAAkB;IAClC,eAAe,EAAE,kBAAkB;IACnC,MAAM,EAAE,SAAS;IACjB,0BAA0B,EAAE,+BAA+B;IAC3D,YAAY,EAAE,eAAe;IAC7B,MAAM,EAAE,SAAS;IACjB,WAAW,EAAE,cAAc;IAC3B,aAAa,EAAE,gBAAgB;IAC/B,gBAAgB,EAAE,oBAAoB;IACtC,aAAa,EAAE,gBAAgB;IAC/B,iBAAiB,EAAE,qBAAqB;CACzC,CAAC;AAEF,MAAM,kBAAkB,GAA+B;IACrD,MAAM;IACN,UAAU;IACV,SAAS;IACT,SAAS;IACT,WAAW;IACX,UAAU;IACV,eAAe;IACf,kBAAkB;IAClB,eAAe;IACf,mBAAmB;CACpB,CAAC;AAEF,SAAS,KAAK,CAAC,GAAW;IACxB,OAAO,cAAc,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC;AACpC,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,KAAK,KAAK,SAAS;QACxB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC9C,CAAC;AAED,MAAa,OAAO;IAClB,WAAW,CAAS;IACpB,MAAM,CAAU;IAChB,SAAS,CAAU;IACnB,IAAI,CAAS;IACb,QAAQ,CAAS;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,SAAS,CAAU;IACnB,QAAQ,CAAU;IAClB,aAAa,CAAU;IACvB,gBAAgB,CAAU;IAC1B,aAAa,CAAU;IACvB,iBAAiB,CAAU;IAE3B,GAAG,CAAU;IACb,IAAI,CAAU;IACd,IAAI,CAAU;IACd,QAAQ,CAAY;IACpB,SAAS,CAAU;IACnB,gBAAgB,CAAU;IAC1B,cAAc,CAAU;IACxB,eAAe,CAAoB;IACnC,MAAM,CAAU;IAChB,0BAA0B,CAAU;IACpC,YAAY,CAAU;IACtB,MAAM,CAAgB;IACtB,WAAW,CAA2B;IACtC,GAAG,CAA2B;IAE9B,WAAW,CAAU;IACrB,eAAe,CAAU;IACzB,WAAW,CAAU;IACrB,YAAY,CAAU;IAEtB,YAAY,MAAqB;QAC/B,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,wBAAe,CACvB,sGAAsG,CACvG,CAAC;QACJ,CAAC;QACD,IACE,MAAM,CAAC,OAAO,KAAK,SAAS;YAC5B,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EACrC,CAAC;YACD,MAAM,IAAI,wBAAe,CACvB,gEAAgE,CACjE,CAAC;QACJ,CAAC;QACD,IACE,MAAM,CAAC,OAAO,KAAK,SAAS;YAC5B,MAAM,CAAC,OAAO,KAAK,UAAU;YAC7B,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,EACvC,CAAC;YACD,MAAM,IAAI,wBAAe,CAAC,yCAAyC,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,wBAAe,CAAC,0CAA0C,CAAC,CAAC;YACxE,CAAC;YACD,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,wBAAe,CAAC,uCAAuC,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,IAAI,KAAK,CAAC;QACzD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QAElD,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,0BAA0B,GAAG,MAAM,CAAC,0BAA0B,CAAC;QACpE,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QAEtB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,KAAK,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;IAC1C,CAAC;IAED,MAAM;QACJ,MAAM,OAAO,GAA4B;YACvC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;YACrC,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,UAAU;gBAAE,SAAS;YACnD,MAAM,KAAK,GAAI,IAA2C,CAAC,GAAG,CAAC,CAAC;YAChE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,MAAM,EAAE,GAA4B,EAAE,CAAC;QACvC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAI,IAA2C,CAAC,GAAG,CAAC,CAAC;YAChE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;YACzB,CAAC;QACH,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;QAClB,CAAC;QAED,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC;YAClC,UAAU,EAAE,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC;YACzC,OAAO;YACP,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,QAAQ,EAAE,IAAI,CAAC,eAAe;YAC9B,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;CACF;AA/ID,0BA+IC"}
1
+ {"version":3,"file":"product.js","sourceRoot":"","sources":["../../src/br/product.ts"],"names":[],"mappings":";;;AAkNA,sCAIC;AAtND,sCAA4C;AAE5C,MAAM,WAAW,GAAG,cAAc,CAAC;AACnC,MAAM,eAAe,GAAG,8BAA8B,CAAC;AACvD,MAAM,cAAc,GAAG,UAAU,CAAC;AAElC;;;;GAIG;AACH,SAAS,sBAAsB,CAAC,IAAY;IAC1C,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,EAAY,CAAC;IACrC,MAAM,GAAG,GAAG,MAAM;SACf,OAAO,EAAE;SACT,MAAM,CACL,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,GAAG,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAClE,CAAC,CACF,CAAC;IACJ,OAAO,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,KAAK,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,MAAgB;IACxC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CACvB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,EAChE,CAAC,CACF,CAAC;IACF,MAAM,SAAS,GAAG,GAAG,GAAG,EAAE,CAAC;IAC3B,OAAO,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC;AAC5C,CAAC;AAED,SAAS,yBAAyB,CAAC,MAAc;IAC/C,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvC,OAAO,CACL,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC;QACpD,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC,CACrD,CAAC;AACJ,CAAC;AA8CD,MAAM,SAAS,GAAqC;IAClD,OAAO,EAAE,UAAU;IACnB,cAAc,EAAE,iBAAiB;IACjC,aAAa,EAAE,gBAAgB;IAC/B,UAAU,EAAE,aAAa;IACzB,yBAAyB,EAAE,8BAA8B;IACzD,yBAAyB,EAAE,8BAA8B;IACzD,aAAa,EAAE,gBAAgB;IAC/B,KAAK,EAAE,OAAO;IACd,mBAAmB,EAAE,sBAAsB;IAC3C,gBAAgB,EAAE,mBAAmB;CACtC,CAAC;AAEF,MAAM,aAAa,GAA4B;IAC7C,SAAS;IACT,gBAAgB;IAChB,eAAe;CAChB,CAAC;AAEF,SAAS,QAAQ,CAAC,IAAgB;IAChC,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAuB,CAAC,CAAC;QAC5C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IAC/D,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AA2CD,MAAM,OAAO,GAA+B;IAC1C,KAAK;IACL,MAAM;IACN,MAAM;IACN,UAAU;IACV,WAAW;IACX,kBAAkB;IAClB,gBAAgB;IAChB,iBAAiB;IACjB,QAAQ;IACR,4BAA4B;IAC5B,cAAc;IACd,aAAa;IACb,QAAQ;IACR,KAAK;CACN,CAAC;AAEF,MAAM,cAAc,GAA2B;IAC7C,QAAQ,EAAE,WAAW;IACrB,SAAS,EAAE,YAAY;IACvB,gBAAgB,EAAE,mBAAmB;IACrC,cAAc,EAAE,kBAAkB;IAClC,eAAe,EAAE,kBAAkB;IACnC,MAAM,EAAE,SAAS;IACjB,0BAA0B,EAAE,+BAA+B;IAC3D,YAAY,EAAE,eAAe;IAC7B,MAAM,EAAE,SAAS;IACjB,WAAW,EAAE,cAAc;IAC3B,aAAa,EAAE,gBAAgB;IAC/B,gBAAgB,EAAE,oBAAoB;IACtC,aAAa,EAAE,gBAAgB;IAC/B,iBAAiB,EAAE,qBAAqB;CACzC,CAAC;AAEF,MAAM,kBAAkB,GAA+B;IACrD,MAAM;IACN,UAAU;IACV,SAAS;IACT,SAAS;IACT,WAAW;IACX,UAAU;IACV,eAAe;IACf,kBAAkB;IAClB,eAAe;IACf,mBAAmB;CACpB,CAAC;AAEF,SAAS,KAAK,CAAC,GAAW;IACxB,OAAO,cAAc,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC;AACpC,CAAC;AAED,SAAgB,aAAa,CAAC,KAAc;IAC1C,OAAO,KAAK,KAAK,SAAS;QACxB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC9C,CAAC;AAED,MAAa,OAAO;IAClB,WAAW,CAAS;IACpB,MAAM,CAAU;IAChB,SAAS,CAAU;IACnB,IAAI,CAAS;IACb,QAAQ,CAAS;IACjB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,SAAS,CAAU;IACnB,QAAQ,CAAU;IAClB,aAAa,CAAU;IACvB,gBAAgB,CAAU;IAC1B,aAAa,CAAU;IACvB,iBAAiB,CAAU;IAE3B,GAAG,CAAU;IACb,IAAI,CAAU;IACd,IAAI,CAAU;IACd,QAAQ,CAAY;IACpB,SAAS,CAAU;IACnB,gBAAgB,CAAU;IAC1B,cAAc,CAAU;IACxB,eAAe,CAAoB;IACnC,MAAM,CAAU;IAChB,0BAA0B,CAAU;IACpC,YAAY,CAAU;IACtB,MAAM,CAAgB;IACtB,WAAW,CAA2B;IACtC,GAAG,CAA2B;IAC9B,IAAI,CAAc;IAElB,WAAW,CAAU;IACrB,eAAe,CAAU;IACzB,WAAW,CAAU;IACrB,YAAY,CAAU;IAEtB,YAAY,MAAqB;QAC/B,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,wBAAe,CACvB,sGAAsG,CACvG,CAAC;QACJ,CAAC;QACD,IACE,MAAM,CAAC,OAAO,KAAK,SAAS;YAC5B,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EACrC,CAAC;YACD,MAAM,IAAI,wBAAe,CACvB,gEAAgE,CACjE,CAAC;QACJ,CAAC;QACD,IACE,MAAM,CAAC,OAAO,KAAK,SAAS;YAC5B,MAAM,CAAC,OAAO,KAAK,UAAU;YAC7B,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,EACvC,CAAC;YACD,MAAM,IAAI,wBAAe,CAAC,yCAAyC,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,wBAAe,CAAC,0CAA0C,CAAC,CAAC;YACxE,CAAC;YACD,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,wBAAe,CAAC,uCAAuC,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACnE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,wBAAe,CACvB,oCAAoC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACzD,CAAC;YACJ,CAAC;YACD,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;gBACvD,MAAM,IAAI,wBAAe,CACvB,oDAAoD,CACrD,CAAC;YACJ,CAAC;QACH,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,IAAI,KAAK,CAAC;QACzD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QAElD,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,0BAA0B,GAAG,MAAM,CAAC,0BAA0B,CAAC;QACpE,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QAExB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,KAAK,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;IAC1C,CAAC;IAED,MAAM;QACJ,MAAM,OAAO,GAA4B;YACvC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;YACrC,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,UAAU;gBAAE,SAAS;YACnD,MAAM,KAAK,GAAI,IAA2C,CAAC,GAAG,CAAC,CAAC;YAChE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,MAAM,EAAE,GAA4B,EAAE,CAAC;QACvC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAI,IAA2C,CAAC,GAAG,CAAC,CAAC;YAChE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;YACzB,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,IAAI;YAAE,EAAE,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;QAClB,CAAC;QAED,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC;YAClC,UAAU,EAAE,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC;YACzC,OAAO;YACP,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,QAAQ,EAAE,IAAI,CAAC,eAAe;YAC9B,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;CACF;AA/JD,0BA+JC"}
package/dist/client.d.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  import { Address } from "./address";
2
2
  import { Product } from "./br/product";
3
- import { DocumentType, Environment, Manifestation } from "./types";
3
+ import { AuthorizedCompanies, Direction, DocumentType, Environment, Manifestation, Purpose } from "./types";
4
4
  export declare const DEFAULT_BASE_URL = "https://sdk.stackin.io";
5
+ export declare const COMPANY_HEADER = "X-Stackin-Company";
5
6
  export interface ClientOptions {
6
7
  apiKey?: string;
7
8
  baseUrl?: string;
@@ -14,12 +15,33 @@ export interface ClientOptions {
14
15
  * carries its issuer's country already.
15
16
  */
16
17
  country?: string;
18
+ /**
19
+ * The company every call acts on, by id (UUID) or CNPJ; the API
20
+ * ignores punctuation. Sent as X-Stackin-Company. Only a credential
21
+ * that covers several companies needs it: an API key is one company
22
+ * already. Unset, no header is sent. A call's own company overrides
23
+ * it.
24
+ */
25
+ company?: string;
17
26
  }
18
27
  export type InvoiceOptions = ClientOptions;
28
+ /** Where the goods leave Brazil: the NF-e exporta group. */
29
+ export interface ExportInfo {
30
+ /** The Brazilian state the goods leave from (UFSaidaPais); never EX. */
31
+ exitState: string;
32
+ /** Place of shipment or border crossing (xLocExporta), up to 60 characters. */
33
+ place: string;
34
+ /** Customs facility of dispatch (xLocDespacho), up to 60 characters. */
35
+ dispatchPlace?: string;
36
+ }
19
37
  export interface IssueRequest {
20
38
  documentType: DocumentType;
21
39
  clientName: string;
22
- taxId: string;
40
+ /**
41
+ * CPF or CNPJ. Required, except on an NF-e to a buyer abroad
42
+ * (recipientAddress.state EX), who is identified by foreignId instead.
43
+ */
44
+ taxId?: string;
23
45
  items: Product[];
24
46
  recipientAddress?: Address;
25
47
  series?: string;
@@ -38,6 +60,48 @@ export interface IssueRequest {
38
60
  * unset.
39
61
  */
40
62
  externalReference?: string;
63
+ /**
64
+ * A discount on the whole document, in BRL, at least 0. The API
65
+ * spreads it over the lines in proportion to each line's amount.
66
+ */
67
+ discount?: number;
68
+ /**
69
+ * The emission moment. A Date is sent as its UTC instant; a string
70
+ * must be ISO 8601 with a timezone offset (Z or ±hh:mm), and one
71
+ * without is refused locally. NF-e: at most 30 days back and 5
72
+ * minutes ahead; NFS-e: never ahead. The API defaults it to now.
73
+ */
74
+ issuedAt?: Date | string;
75
+ /** Why the NF-e is issued (finNFe). NF-e only. */
76
+ purpose?: Purpose;
77
+ /** Outgoing or incoming NF-e (tpNF). NF-e only. */
78
+ direction?: Direction;
79
+ /**
80
+ * Access keys (44 characters) of the NF-e, NFC-e or CF-e this one
81
+ * refers to: required for Purpose.COMPLEMENTARY (exactly one) and,
82
+ * but for a few CFOPs, for Purpose.RETURN. NF-e only.
83
+ */
84
+ referencedKeys?: string[];
85
+ /**
86
+ * Passport or other document of a buyer abroad (idEstrangeiro): 5 to
87
+ * 20 letters, digits or :.+-/(). NF-e to state EX only.
88
+ */
89
+ foreignId?: string;
90
+ /** Where the goods leave Brazil. Required on an outgoing NF-e abroad. */
91
+ export?: ExportInfo;
92
+ /** The company this call acts on; overrides the client's company. */
93
+ company?: string;
94
+ }
95
+ /** Per-call company selection, overriding the client's. */
96
+ export interface CompanyOption {
97
+ /** The company id (UUID) or CNPJ, sent as X-Stackin-Company. */
98
+ company?: string;
99
+ }
100
+ interface RequestOptions {
101
+ body?: unknown;
102
+ query?: Record<string, string>;
103
+ idempotencyKey?: string;
104
+ company?: string;
41
105
  }
42
106
  /**
43
107
  * Where an api key becomes an HTTP call, for every entry point.
@@ -50,25 +114,18 @@ export declare class Client {
50
114
  readonly apiKey?: string;
51
115
  readonly timeoutMs: number;
52
116
  readonly country: string;
117
+ readonly company?: string;
53
118
  protected readonly fetchImpl: typeof fetch;
54
119
  constructor(options?: ClientOptions);
55
- protected headers(idempotencyKey?: string): Record<string, string>;
56
- protected request(method: string, path: string, opts?: {
57
- body?: unknown;
58
- query?: Record<string, string>;
59
- idempotencyKey?: string;
60
- }): Promise<Record<string, unknown>>;
61
- protected send(method: string, path: string, opts?: {
62
- body?: unknown;
63
- query?: Record<string, string>;
64
- idempotencyKey?: string;
65
- }): Promise<Response>;
120
+ protected headers(idempotencyKey?: string, company?: string): Record<string, string>;
121
+ protected request(method: string, path: string, opts?: RequestOptions): Promise<Record<string, unknown>>;
122
+ protected send(method: string, path: string, opts?: RequestOptions): Promise<Response>;
66
123
  }
67
124
  export declare class Invoice extends Client {
68
125
  issue(request: IssueRequest): Promise<Record<string, unknown>>;
69
126
  consult(accessKey: string, options: {
70
127
  documentType: DocumentType;
71
- }): Promise<Record<string, unknown>>;
128
+ } & CompanyOption): Promise<Record<string, unknown>>;
72
129
  /**
73
130
  * Voids an authorized document.
74
131
  *
@@ -83,13 +140,13 @@ export declare class Invoice extends Client {
83
140
  documentType: DocumentType;
84
141
  reason: string;
85
142
  idempotencyKey?: string;
86
- }): Promise<Record<string, unknown>>;
143
+ } & CompanyOption): Promise<Record<string, unknown>>;
87
144
  invalidate(options: {
88
145
  series: string;
89
146
  numberStart: number;
90
147
  numberEnd: number;
91
148
  reason: string;
92
- }): Promise<Record<string, unknown>>;
149
+ } & CompanyOption): Promise<Record<string, unknown>>;
93
150
  /**
94
151
  * Files a correction letter (CC-e) against an authorized NF-e.
95
152
  *
@@ -102,10 +159,10 @@ export declare class Invoice extends Client {
102
159
  correct(accessKey: string, options: {
103
160
  documentType: DocumentType;
104
161
  correction: string;
105
- }): Promise<Record<string, unknown>>;
162
+ } & CompanyOption): Promise<Record<string, unknown>>;
106
163
  reissue(invoiceId: string, options?: {
107
164
  idempotencyKey?: string;
108
- }): Promise<Record<string, unknown>>;
165
+ } & CompanyOption): Promise<Record<string, unknown>>;
109
166
  /**
110
167
  * Documents other companies issued against this one.
111
168
  *
@@ -116,7 +173,7 @@ export declare class Invoice extends Client {
116
173
  received(options?: {
117
174
  limit?: number;
118
175
  offset?: number;
119
- }): Promise<Record<string, unknown>>;
176
+ } & CompanyOption): Promise<Record<string, unknown>>;
120
177
  /**
121
178
  * What this company issued, newest first.
122
179
  *
@@ -130,7 +187,7 @@ export declare class Invoice extends Client {
130
187
  offset?: number;
131
188
  sortBy?: string;
132
189
  orderBy?: string;
133
- }): Promise<Record<string, unknown>>;
190
+ } & CompanyOption): Promise<Record<string, unknown>>;
134
191
  /**
135
192
  * The recipient's formal answer to a received document.
136
193
  *
@@ -141,7 +198,7 @@ export declare class Invoice extends Client {
141
198
  manifest(accessKey: string, options: {
142
199
  manifestation: Manifestation;
143
200
  reason?: string;
144
- }): Promise<Record<string, unknown>>;
201
+ } & CompanyOption): Promise<Record<string, unknown>>;
145
202
  /**
146
203
  * The authorizer's own rendering of an authorized document, as raw
147
204
  * bytes — the only method that does not return a parsed object.
@@ -153,7 +210,7 @@ export declare class Invoice extends Client {
153
210
  */
154
211
  pdf(accessKey: string, options: {
155
212
  documentType: DocumentType;
156
- }): Promise<Uint8Array>;
213
+ } & CompanyOption): Promise<Uint8Array>;
157
214
  /**
158
215
  * Every attempt made for one invoice, with what the authorizer answered.
159
216
  *
@@ -161,6 +218,16 @@ export declare class Invoice extends Client {
161
218
  * like reissue() and unlike everything else, because a rejected document
162
219
  * has no access key to look it up by.
163
220
  */
164
- submissions(invoiceId: string): Promise<Array<Record<string, unknown>>>;
221
+ submissions(invoiceId: string, options?: CompanyOption): Promise<Array<Record<string, unknown>>>;
222
+ /**
223
+ * Which companies this credential reaches, and with what permissions,
224
+ * in the environment it belongs to.
225
+ *
226
+ * The way to learn the ids a multi-company credential may pass as
227
+ * company. It needs no company itself. An API key is one company with
228
+ * every permission, and lists as such.
229
+ */
230
+ companies(): Promise<AuthorizedCompanies>;
165
231
  }
232
+ export {};
166
233
  //# sourceMappingURL=client.d.ts.map