@stackin-io/stackin-node-sdk 0.21.0 → 0.23.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/dist/items.js ADDED
@@ -0,0 +1,148 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Items = void 0;
4
+ const client_1 = require("./client");
5
+ const product_1 = require("./br/product");
6
+ const reference_1 = require("./reference");
7
+ const WIRE_NAMES = {
8
+ kind: "kind",
9
+ description: "description",
10
+ code: "code",
11
+ unitPrice: "unit_price",
12
+ unit: "unit",
13
+ externalReference: "external_reference",
14
+ notes: "notes",
15
+ source: "source",
16
+ ncm: "ncm",
17
+ cfop: "cfop",
18
+ taxSituation: "tax_situation",
19
+ origin: "origin",
20
+ cest: "cest",
21
+ gtin: "gtin",
22
+ serviceCode: "service_code",
23
+ issRetained: "iss_retained",
24
+ isActive: "is_active",
25
+ };
26
+ function wireBody(fields, keepNull) {
27
+ const body = {};
28
+ for (const [key, value] of Object.entries(fields)) {
29
+ const wire = WIRE_NAMES[key];
30
+ if (!wire) {
31
+ throw new Error(`unknown item field: ${key}`);
32
+ }
33
+ if (value === undefined)
34
+ continue;
35
+ if (value === null && !keepNull)
36
+ continue;
37
+ body[wire] =
38
+ key === "unitPrice" && value !== null
39
+ ? (0, product_1.priceString)(value)
40
+ : value;
41
+ }
42
+ return body;
43
+ }
44
+ /**
45
+ * The company's catalog of products and services: what it sells, kept
46
+ * once and named on an issue line by itemId.
47
+ *
48
+ * Company data, like everything on Invoice, so every call takes a
49
+ * company over the client's own. Reading needs invoice:read; saving,
50
+ * editing and deactivating need invoice:issue.
51
+ */
52
+ class Items extends client_1.Client {
53
+ constructor(options = {}) {
54
+ super(options);
55
+ }
56
+ /** A page of the company's items, by description unless sortBy says otherwise. */
57
+ async list(query = {}) {
58
+ const params = {};
59
+ if (query.kind !== undefined)
60
+ params.kind = query.kind;
61
+ if (query.search)
62
+ params.search = query.search;
63
+ if (query.source !== undefined)
64
+ params.source = query.source;
65
+ if (query.isActive !== undefined)
66
+ params.is_active = String(query.isActive);
67
+ if (query.limit !== undefined)
68
+ params.limit = String(query.limit);
69
+ if (query.offset !== undefined)
70
+ params.offset = String(query.offset);
71
+ if (query.sortBy !== undefined)
72
+ params.sort_by = query.sortBy;
73
+ if (query.orderBy !== undefined)
74
+ params.order_by = query.orderBy;
75
+ return this.request("GET", "/items", {
76
+ query: params,
77
+ company: query.company,
78
+ });
79
+ }
80
+ /** One item, deactivated or not. Another company's is a 404. */
81
+ async get(itemId, options = {}) {
82
+ return (await this.request("GET", `/items/${(0, reference_1.segment)(itemId)}`, {
83
+ company: options.company,
84
+ }));
85
+ }
86
+ /**
87
+ * Saves an item (POST /items), and it is an upsert. It updates the company's item with the same
88
+ * externalReference (or, when none is sent, the same code) with only
89
+ * the fields given, and otherwise creates one, so the same call twice
90
+ * never makes two items. The item keeps its source and isActive.
91
+ * Answers the item alone; upsert also says whether it was created.
92
+ */
93
+ async create(fields, options = {}) {
94
+ return (await this.upsert(fields, options)).item;
95
+ }
96
+ /**
97
+ * Like create, but answers { item, created }: created is true for a
98
+ * 201 (a new item) and false for a 200 (an existing one, updated).
99
+ */
100
+ async upsert(fields, options = {}) {
101
+ const response = await this.send("POST", "/items", {
102
+ body: wireBody(fields, false),
103
+ company: options.company,
104
+ });
105
+ const text = await response.text();
106
+ let body = {};
107
+ if (text) {
108
+ try {
109
+ body = JSON.parse(text);
110
+ }
111
+ catch {
112
+ body = {};
113
+ }
114
+ }
115
+ const item = body.result ?? body;
116
+ return {
117
+ item: item,
118
+ created: response.status === 201,
119
+ };
120
+ }
121
+ /**
122
+ * Changes only the fields given. The API checks the item as a whole,
123
+ * so turning a product into a service while it still has an ncm is
124
+ * refused; taking another item's code is an ItemAlreadyExistsError.
125
+ */
126
+ async update(itemId, changes, options = {}) {
127
+ return (await this.request("PATCH", `/items/${(0, reference_1.segment)(itemId)}`, {
128
+ body: wireBody(changes, true),
129
+ company: options.company,
130
+ }));
131
+ }
132
+ /**
133
+ * Deactivates an item: kept, left out of list by default, still
134
+ * holding its code, and refused on issue until reactivate brings it
135
+ * back.
136
+ */
137
+ async deactivate(itemId, options = {}) {
138
+ await this.send("DELETE", `/items/${(0, reference_1.segment)(itemId)}`, {
139
+ company: options.company,
140
+ });
141
+ }
142
+ /** Brings a deactivated item back, and returns it. */
143
+ async reactivate(itemId, options = {}) {
144
+ return this.update(itemId, { isActive: true }, options);
145
+ }
146
+ }
147
+ exports.Items = Items;
148
+ //# sourceMappingURL=items.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"items.js","sourceRoot":"","sources":["../src/items.ts"],"names":[],"mappings":";;;AAAA,qCAAgE;AAChE,0CAA2C;AAC3C,2CAAsC;AAyHtC,MAAM,UAAU,GAA2B;IACzC,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,YAAY;IACvB,IAAI,EAAE,MAAM;IACZ,iBAAiB,EAAE,oBAAoB;IACvC,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,eAAe;IAC7B,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,cAAc;IAC3B,WAAW,EAAE,cAAc;IAC3B,QAAQ,EAAE,WAAW;CACtB,CAAC;AAEF,SAAS,QAAQ,CAAC,MAAc,EAAE,QAAiB;IACjD,MAAM,IAAI,GAA4B,EAAE,CAAC;IACzC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,EAAE,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,QAAQ;YAAE,SAAS;QAC1C,IAAI,CAAC,IAAI,CAAC;YACR,GAAG,KAAK,WAAW,IAAI,KAAK,KAAK,IAAI;gBACnC,CAAC,CAAC,IAAA,qBAAW,EAAC,KAAwB,CAAC;gBACvC,CAAC,CAAC,KAAK,CAAC;IACd,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAa,KAAM,SAAQ,eAAM;IAC/B,YAAY,UAAyB,EAAE;QACrC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,kFAAkF;IAClF,KAAK,CAAC,IAAI,CAAC,QAAuB,EAAE;QAClC,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvD,IAAI,KAAK,CAAC,MAAM;YAAE,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC/C,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC7D,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS;YAC9B,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClE,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrE,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;QAC9D,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;YAAE,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAEjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE;YACnC,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IAChE,KAAK,CAAC,GAAG,CACP,MAAc,EACd,UAAyB,EAAE;QAE3B,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,IAAA,mBAAO,EAAC,MAAM,CAAC,EAAE,EAAE;YAC7D,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAA2B,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,MAAkB,EAClB,UAAyB,EAAE;QAE3B,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,MAAkB,EAClB,UAAyB,EAAE;QAE3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE;YACjD,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC;YAC7B,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,IAAI,GAA4B,EAAE,CAAC;QACvC,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC;gBACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAA4B,CAAC;YACrD,CAAC;YAAC,MAAM,CAAC;gBACP,IAAI,GAAG,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;QACD,MAAM,IAAI,GAAI,IAAI,CAAC,MAAkC,IAAI,IAAI,CAAC;QAC9D,OAAO;YACL,IAAI,EAAE,IAA8B;YACpC,OAAO,EAAE,QAAQ,CAAC,MAAM,KAAK,GAAG;SACjC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,MAAc,EACd,OAAoB,EACpB,UAAyB,EAAE;QAE3B,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,IAAA,mBAAO,EAAC,MAAM,CAAC,EAAE,EAAE;YAC/D,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;YAC7B,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAA2B,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CACd,MAAc,EACd,UAAyB,EAAE;QAE3B,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,IAAA,mBAAO,EAAC,MAAM,CAAC,EAAE,EAAE;YACrD,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAC;IACL,CAAC;IAED,sDAAsD;IACtD,KAAK,CAAC,UAAU,CACd,MAAc,EACd,UAAyB,EAAE;QAE3B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF;AAjHD,sBAiHC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stackin-io/stackin-node-sdk",
3
- "version": "0.21.0",
3
+ "version": "0.23.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",