@stackin-io/stackin-node-sdk 0.9.0 → 0.10.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 +27 -0
- package/dist/br/product.d.ts +4 -2
- package/dist/br/product.d.ts.map +1 -1
- package/dist/br/product.js +13 -2
- package/dist/br/product.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,6 +20,33 @@ Node/TypeScript SDK for fiscal document issuance — a handful of business field
|
|
|
20
20
|
|
|
21
21
|
**One class, `Invoice`** — `issue()`/`consult()`/`cancel()`/`reissue()`/`correct()`/`invalidate()`/`pdf()`/`received()`/`manifest()`, nothing else to instantiate. Each line item is a `br.Product` — `description`/`amount` are universal, everything else (`ncm`/`cfop`/`cest`/tax groups...) is Brazil-specific and only required for NFE; NFSE ignores it.
|
|
22
22
|
|
|
23
|
+
## What a line item is worth
|
|
24
|
+
|
|
25
|
+
`unitPrice` is the price of **one unit**. `amount` is the **gross total of
|
|
26
|
+
the line's products**, before discount, freight, insurance and other
|
|
27
|
+
expenses. Send either; sending both asserts that they agree.
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
// More than one unit — the note's line is 2 x 120.00 = 240.00
|
|
31
|
+
new br.Product({ description: "Teclado", quantity: 2, unitPrice: 120.0, unit: "UN" });
|
|
32
|
+
|
|
33
|
+
// Legacy: amount alone still means the line's gross total
|
|
34
|
+
new br.Product({ description: "Servico", quantity: 3, amount: 150.0 });
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Amounts that do not add up are refused before the authorizer sees them,
|
|
38
|
+
with a `422` naming the line and both numbers (`ITEM_TOTAL_MISMATCH`).
|
|
39
|
+
|
|
40
|
+
### Migrating
|
|
41
|
+
|
|
42
|
+
```text
|
|
43
|
+
Before: quantity: 3, amount: 150.0
|
|
44
|
+
After: quantity: 3, unitPrice: 50.0
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Nothing has to migrate. `amount` keeps the meaning it always had and is
|
|
48
|
+
not deprecated in this release.
|
|
49
|
+
|
|
23
50
|
## Install
|
|
24
51
|
|
|
25
52
|
```bash
|
package/dist/br/product.d.ts
CHANGED
|
@@ -6,7 +6,8 @@ export interface PresumedCredit {
|
|
|
6
6
|
}
|
|
7
7
|
export interface ProductFields {
|
|
8
8
|
description: string;
|
|
9
|
-
amount
|
|
9
|
+
amount?: number;
|
|
10
|
+
unitPrice?: number;
|
|
10
11
|
unit?: string;
|
|
11
12
|
quantity?: number;
|
|
12
13
|
barcode?: string;
|
|
@@ -37,7 +38,8 @@ export interface ProductFields {
|
|
|
37
38
|
}
|
|
38
39
|
export declare class Product {
|
|
39
40
|
description: string;
|
|
40
|
-
amount
|
|
41
|
+
amount?: number;
|
|
42
|
+
unitPrice?: number;
|
|
41
43
|
unit: string;
|
|
42
44
|
quantity: number;
|
|
43
45
|
barcode?: string;
|
package/dist/br/product.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"product.d.ts","sourceRoot":"","sources":["../../src/br/product.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"product.d.ts","sourceRoot":"","sources":["../../src/br/product.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;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,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,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,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;AAyDD,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,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;IA4CjC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAmClC"}
|
package/dist/br/product.js
CHANGED
|
@@ -46,9 +46,15 @@ const PRODUCT_LEVEL_KEYS = [
|
|
|
46
46
|
function snake(key) {
|
|
47
47
|
return CAMEL_TO_SNAKE[key] ?? key;
|
|
48
48
|
}
|
|
49
|
+
function decimalString(value) {
|
|
50
|
+
return value === undefined
|
|
51
|
+
? undefined
|
|
52
|
+
: value.toFixed(10).replace(/\.?0+$/, "");
|
|
53
|
+
}
|
|
49
54
|
class Product {
|
|
50
55
|
description;
|
|
51
56
|
amount;
|
|
57
|
+
unitPrice;
|
|
52
58
|
unit;
|
|
53
59
|
quantity;
|
|
54
60
|
barcode;
|
|
@@ -80,11 +86,15 @@ class Product {
|
|
|
80
86
|
if (!fields.description || fields.description.length === 0) {
|
|
81
87
|
throw new Error("description must be a non-empty string");
|
|
82
88
|
}
|
|
83
|
-
if (!(fields.amount > 0)) {
|
|
89
|
+
if (fields.amount !== undefined && !(fields.amount > 0)) {
|
|
84
90
|
throw new Error("amount must be greater than 0");
|
|
85
91
|
}
|
|
92
|
+
if (fields.unitPrice !== undefined && !(fields.unitPrice > 0)) {
|
|
93
|
+
throw new Error("unitPrice must be greater than 0");
|
|
94
|
+
}
|
|
86
95
|
this.description = fields.description;
|
|
87
96
|
this.amount = fields.amount;
|
|
97
|
+
this.unitPrice = fields.unitPrice;
|
|
88
98
|
this.unit = fields.unit ?? "UN";
|
|
89
99
|
this.quantity = fields.quantity ?? 1.0;
|
|
90
100
|
this.barcode = fields.barcode;
|
|
@@ -138,7 +148,8 @@ class Product {
|
|
|
138
148
|
}
|
|
139
149
|
return {
|
|
140
150
|
description: this.description,
|
|
141
|
-
amount: this.amount,
|
|
151
|
+
amount: decimalString(this.amount),
|
|
152
|
+
unit_price: decimalString(this.unitPrice),
|
|
142
153
|
product,
|
|
143
154
|
service_code: this.serviceCode,
|
|
144
155
|
discount: this.serviceDiscount,
|
package/dist/br/product.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"product.js","sourceRoot":"","sources":["../../src/br/product.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"product.js","sourceRoot":"","sources":["../../src/br/product.ts"],"names":[],"mappings":";;;AA0CA,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,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,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,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,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,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;AAjHD,0BAiHC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stackin-io/stackin-node-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.10.0",
|
|
4
4
|
"description": "Node/TypeScript SDK for stackin — issue, consult and cancel Brazilian fiscal documents (NF-e, NFS-e) via a single Invoice client. No certificates, XML or SOAP.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"stackin",
|