@nhvbeauty/tpl 0.1.4 → 0.3.0

package/README.md

@@ -0,0 +1,168 @@
+# @nhvbeauty/tpl
+
+SDK TypeScript para integração com a API da TPL (`https://oms.tpl.com.br/api`).
+
+## Instalação
+
+```bash
+npm install @nhvbeauty/tpl
+```
+
+## Uso rápido
+
+```ts
+import { Tpl } from '@nhvbeauty/tpl'
+
+const client = new Tpl()
+
+const auth = await client.auth.login({
+  apikey: 'SUA_API_KEY',
+  token: 'SEU_TOKEN',
+  email: 'seu-email@dominio.com',
+})
+
+const authedClient = new Tpl(auth.token)
+```
+
+## Cliente
+
+```ts
+const client = new Tpl(authToken?, baseUrl?)
+```
+
+- `authToken` (opcional): token retornado em `auth.login`.
+- `baseUrl` (opcional): padrão `https://oms.tpl.com.br/api`.
+
+## Módulos disponíveis
+
+### `auth`
+
+#### `login(body)`
+
+Endpoint: `POST /get/auth`
+
+```ts
+const result = await client.auth.login({
+  apikey: 'SUA_API_KEY',
+  token: 'SEU_TOKEN',
+  email: 'seu-email@dominio.com',
+})
+```
+
+### `orders`
+
+#### `find(params)`
+
+Endpoint: `POST /get/orderdetail`
+
+Aceita um dos formatos:
+- `{ id: number | bigint }`
+- `{ number: string }`
+
+```ts
+const byId = await client.orders.find({ id: 12345 })
+const byNumber = await client.orders.find({ number: 'PED-12345' })
+```
+
+### `shipping`
+
+#### `validateZipcode(params)`
+
+Endpoint: `POST /get/valid-zipcode`
+
+Payload:
+- `{ zipcode: string }`
+
+```ts
+const zipcode = await client.shipping.validateZipcode({
+  zipcode: '13270000',
+})
+```
+
+Resposta de sucesso:
+
+```json
+{
+  "code": 200,
+  "message": "Sucesso",
+  "dados": [
+    {
+      "cidade": "Valinhos",
+      "logradouro": "",
+      "bairro": "Centro",
+      "uf": "SP"
+    }
+  ]
+}
+```
+
+Quando o CEP não é encontrado, a API responde `404` (ex.: `{ "code": 404, "message": "CEP nao encontrado" }`) e o SDK lança erro.
+
+#### `getFreight(params)`
+
+Endpoint: `POST /get/freight`
+
+Payload nesta versão:
+- `identification?: string`
+- `to: string`
+- `weight: number` (gramas)
+- `value: number` (valor do pedido sem frete)
+
+```ts
+const freight = await client.shipping.getFreight({
+  identification: '12345678901',
+  to: '13270000',
+  weight: 1200,
+  value: 199.9,
+})
+```
+
+Resposta (exemplo real):
+
+```json
+[
+  {
+    "shipmentCompany": "Loggi (4 dias)",
+    "deadline": 4,
+    "value": "9.90",
+    "originalvalue": "8.20",
+    "region": "INTERIOR",
+    "observation": "",
+    "safe": 0,
+    "cost": 0,
+    "safecost": 0,
+    "role": "0",
+    "extra": 0,
+    "extraWeight": "0",
+    "extraValue": "0.00",
+    "icms": 0.88,
+    "iss": "0",
+    "aplicou": 0,
+    "weightVolume": 15,
+    "weightm3": -1,
+    "shipmentId": "3",
+    "state": "SP",
+    "cubageFactor": "167.00"
+  }
+]
+```
+
+Observação: no retorno de frete, campos numéricos podem vir como `string` ou `number` dependendo da regra aplicada pela API.
+
+## Tratamento de erros
+
+Para respostas HTTP fora de `2xx`, o SDK lança erro contendo:
+- `message`
+- `statusCode`
+- `response` (quando retornado pela API)
+
+```ts
+try {
+  await client.shipping.validateZipcode({ zipcode: '00000000' })
+}
+catch (error: any) {
+  console.error(error.statusCode)
+  console.error(error.response)
+}
+```
+

package/lib/entities/products/index.d.ts

@@ -0,0 +1,5 @@
+import type { IProductsResponse } from './interfaces/products.interface';
+import { Entity } from '../@shared/entity';
+export declare class Products extends Entity {
+    find(skus?: string[]): Promise<IProductsResponse>;
+}

package/lib/entities/products/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Products = void 0;
+const entity_1 = require("../@shared/entity");
+class Products extends entity_1.Entity {
+    find(skus) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const skuList = !skus || skus.length === 0
+                ? [{ sku: '*' }]
+                : skus.map((sku) => ({ sku }));
+            return yield this.repository.request({
+                endpoint: '/get/products',
+                body: { skus: skuList },
+            });
+        });
+    }
+}
+exports.Products = Products;
+//# sourceMappingURL=index.js.map

package/lib/entities/products/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/entities/products/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,8CAA0C;AAE1C,MAAa,QAAS,SAAQ,eAAM;IACrB,IAAI,CAAC,IAAe;;YAC/B,MAAM,OAAO,GACX,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;gBACxB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;gBAChB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YAElC,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBACnC,QAAQ,EAAE,eAAe;gBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;aACxB,CAAC,CAAA;QACJ,CAAC;KAAA;CACF;AAZD,4BAYC"}

package/lib/entities/products/interfaces/products.interface.d.ts

@@ -0,0 +1,28 @@
+export interface IProductsBody {
+    skus: Array<{
+        sku: string;
+    }>;
+}
+export interface IProductComposition {
+    sku: string;
+    ean: string;
+    descricao: string;
+    unidade: string | null;
+    use: number;
+    amount: number;
+}
+export interface IProduct {
+    type: 'P' | 'K';
+    ean: string;
+    sku: string;
+    kit: string;
+    descricao: string;
+    unidade: string | null;
+    code: number;
+    amount: number;
+    composition: IProductComposition[];
+}
+export interface IProductsResponse {
+    code: number;
+    stock: IProduct[];
+}

package/lib/entities/products/interfaces/products.interface.js

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

package/lib/entities/products/interfaces/products.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.interface.js","sourceRoot":"","sources":["../../../../src/entities/products/interfaces/products.interface.ts"],"names":[],"mappings":""}

package/lib/entities/shipping/index.d.ts

@@ -0,0 +1,7 @@
+import type { IGetFreightBody, IGetFreightResponse } from './interfaces/get-freight.interface';
+import type { IValidateZipcodeBody, IValidateZipcodeResponse } from './interfaces/validate-zipcode.interface';
+import { Entity } from '../@shared/entity';
+export declare class Shipping extends Entity {
+    validateZipcode(params: IValidateZipcodeBody): Promise<IValidateZipcodeResponse>;
+    getFreight(params: IGetFreightBody): Promise<IGetFreightResponse>;
+}

package/lib/entities/shipping/index.js

@@ -0,0 +1,35 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Shipping = void 0;
+const entity_1 = require("../@shared/entity");
+class Shipping extends entity_1.Entity {
+    validateZipcode(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.repository.request({
+                endpoint: '/get/valid-zipcode',
+                body: {
+                    zipcode: params.zipcode,
+                },
+            });
+        });
+    }
+    getFreight(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.repository.request({
+                endpoint: '/get/freight',
+                body: params,
+            });
+        });
+    }
+}
+exports.Shipping = Shipping;
+//# sourceMappingURL=index.js.map

package/lib/entities/shipping/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/entities/shipping/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,8CAA0C;AAE1C,MAAa,QAAS,SAAQ,eAAM;IACrB,eAAe,CAC1B,MAA4B;;YAE5B,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBACnC,QAAQ,EAAE,oBAAoB;gBAC9B,IAAI,EAAE;oBACJ,OAAO,EAAE,MAAM,CAAC,OAAO;iBACxB;aACF,CAAC,CAAA;QACJ,CAAC;KAAA;IAEY,UAAU,CACrB,MAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBACnC,QAAQ,EAAE,cAAc;gBACxB,IAAI,EAAE,MAAM;aACb,CAAC,CAAA;QACJ,CAAC;KAAA;CACF;AApBD,4BAoBC"}

package/lib/entities/shipping/interfaces/get-freight.interface.d.ts

@@ -0,0 +1,30 @@
+export interface IGetFreightBody {
+    identification?: string;
+    to: string;
+    weight: number;
+    value: number;
+}
+export interface IGetFreightItem {
+    shipmentCompany: string;
+    deadline: number;
+    value: string | number;
+    originalvalue?: string | number;
+    region?: string;
+    observation: string;
+    safe: string | number;
+    cost: string | number;
+    safecost: string | number;
+    role: string | number;
+    extra: string | number;
+    extraWeight: string | number;
+    extraValue: string | number;
+    icms: string | number;
+    iss: string | number;
+    aplicou: 0 | 1 | number;
+    weightVolume?: string | number;
+    weightm3: string | number;
+    shipmentId: string | number;
+    state: string;
+    cubageFactor: string | number;
+}
+export type IGetFreightResponse = IGetFreightItem[];

package/lib/entities/shipping/interfaces/get-freight.interface.js

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

package/lib/entities/shipping/interfaces/get-freight.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-freight.interface.js","sourceRoot":"","sources":["../../../../src/entities/shipping/interfaces/get-freight.interface.ts"],"names":[],"mappings":""}

package/lib/entities/shipping/interfaces/validate-zipcode.interface.d.ts

@@ -0,0 +1,13 @@
+export interface IValidateZipcodeBody {
+    zipcode: string;
+}
+export interface IValidateZipcodeResponse {
+    code: number;
+    message: string;
+    dados: {
+        cidade: string;
+        logradouro: string;
+        bairro: string;
+        uf: string;
+    }[];
+}

package/lib/entities/shipping/interfaces/validate-zipcode.interface.js

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

package/lib/entities/shipping/interfaces/validate-zipcode.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-zipcode.interface.js","sourceRoot":"","sources":["../../../../src/entities/shipping/interfaces/validate-zipcode.interface.ts"],"names":[],"mappings":""}

package/lib/tpl.d.ts

@@ -1,9 +1,13 @@
 import { Auth } from './entities/auth';
 import { Orders } from './entities/orders';
+import { Products } from './entities/products';
+import { Shipping } from './entities/shipping';
 export declare class Tpl {
     #private;
     constructor(authToken?: string, baseUrl?: string);
     private getModule;
     get auth(): Auth;
     get orders(): Orders;
+    get shipping(): Shipping;
+    get products(): Products;
 }

package/lib/tpl.js

@@ -15,6 +15,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tpl = void 0;
 const auth_1 = require("./entities/auth");
 const orders_1 = require("./entities/orders");
+const products_1 = require("./entities/products");
+const shipping_1 = require("./entities/shipping");
 const ioc_1 = require("./providers/ioc");
 class Tpl {
     constructor(authToken, baseUrl = 'https://oms.tpl.com.br/api') {
@@ -35,6 +37,12 @@ class Tpl {
     get orders() {
         return this.getModule(orders_1.Orders);
     }
+    get shipping() {
+        return this.getModule(shipping_1.Shipping);
+    }
+    get products() {
+        return this.getModule(products_1.Products);
+    }
 }
 exports.Tpl = Tpl;
 _Tpl_repository = new WeakMap(), _Tpl_modules = new WeakMap();

package/lib/tpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"tpl.js","sourceRoot":"","sources":["../src/tpl.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAGA,0CAAsC;AACtC,8CAA0C;AAC1C,yCAA+C;AAE/C,MAAa,GAAG;IAmBd,YACE,SAAkB,EAClB,UAAkB,4BAA4B;QApBhD,kCAA2B;QAC3B,+BAA4C;QAqB1C,uBAAA,IAAI,mBAAe,IAAA,mBAAa,EAAC,SAAS,IAAI,SAAS,EAAE,OAAO,CAAC,MAAA,CAAA;QACjE,uBAAA,IAAI,gBAAY,EAAE,MAAA,CAAA;IACpB,CAAC;IAQO,SAAS,CAAmB,WAAuB;QACzD,IAAI,CAAC,uBAAA,IAAI,oBAAS,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,uBAAA,IAAI,oBAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,WAAW,CAAC,uBAAA,IAAI,uBAAY,CAAC,CAAA;QACrE,CAAC;QACD,OAAO,uBAAA,IAAI,oBAAS,CAAC,WAAW,CAAC,IAAI,CAAM,CAAA;IAC7C,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,WAAI,CAAC,CAAA;IAC7B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,eAAM,CAAC,CAAA;IAC/B,CAAC;CACF;AA/CD,kBA+CC"}
+{"version":3,"file":"tpl.js","sourceRoot":"","sources":["../src/tpl.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAGA,0CAAsC;AACtC,8CAA0C;AAC1C,kDAA8C;AAC9C,kDAA8C;AAC9C,yCAA+C;AAE/C,MAAa,GAAG;IAmBd,YACE,SAAkB,EAClB,UAAkB,4BAA4B;QApBhD,kCAA2B;QAC3B,+BAA4C;QAqB1C,uBAAA,IAAI,mBAAe,IAAA,mBAAa,EAAC,SAAS,IAAI,SAAS,EAAE,OAAO,CAAC,MAAA,CAAA;QACjE,uBAAA,IAAI,gBAAY,EAAE,MAAA,CAAA;IACpB,CAAC;IAQO,SAAS,CAAmB,WAAuB;QACzD,IAAI,CAAC,uBAAA,IAAI,oBAAS,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,uBAAA,IAAI,oBAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,WAAW,CAAC,uBAAA,IAAI,uBAAY,CAAC,CAAA;QACrE,CAAC;QACD,OAAO,uBAAA,IAAI,oBAAS,CAAC,WAAW,CAAC,IAAI,CAAM,CAAA;IAC7C,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,WAAI,CAAC,CAAA;IAC7B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,eAAM,CAAC,CAAA;IAC/B,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,mBAAQ,CAAC,CAAA;IACjC,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,mBAAQ,CAAC,CAAA;IACjC,CAAC;CACF;AAvDD,kBAuDC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhvbeauty/tpl",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "description": "Pacote de integração com a API da TPL",
   "directories": {
     "test": "test"
@@ -26,11 +26,14 @@
   ],
   "main": "lib/index.js",
   "files": [
+    "README.md",
     "lib/**/*"
   ],
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
+    "clean": "rm -rf lib",
+    "build": "npm run clean && tsc --project tsconfig.build.json",
     "lint": "eslint --fix 'src/**/*.ts'",
+    "prepublishOnly": "npm run build",
     "test": "npm run build && jest --config jest.config.ts",
     "test:coverage": "jest --config jest.config.ts --coverage"
   },