@opens/gateways 1.0.0

package/README.md

@@ -0,0 +1,48 @@
+# @opens/sdk
+
+SDK leve para acessar gateways de serviços (ex: Customer Service). Projeto organizado para facilitar adição de novos gateways.
+
+## Instalação
+
+Instale via npm:
+
+```bash
+npm install @opens/gateways
+```
+
+
+## Uso básico
+
+O SDK expõe funções para configurar a instância e acessar gateways específicos.
+
+- `configure(params)`: configura o SDK antes do uso.
+- `gateway(service)`: retorna a instância do gateway solicitado.
+
+Exemplo mínimo:
+
+```ts
+import axios from 'axios';
+import { configure, gateway } from '@opens/sdk';
+
+// injete um cliente HTTP (axios) já configurado para facilitar testes
+const axiosClient = axios.create({ headers: { Authorization: 'Bearer TOKEN' } });
+
+configure({
+  axiosClient,
+  apiToken: 'TOKEN',
+  services: { customerService: { baseUrl: 'https://api.example.com' } },
+});
+
+const customerGateway = gateway('customer-service');
+const resp = await customerGateway.getCompanyById('123');
+console.log(resp);
+```
+
+
+## Padrão de acesso a gateways
+
+
+```ts
+const serviceGateway = gateway('nome-do-servico');
+// serviceGateway.metodoDoGateway(...)
+```

package/dist/index.d.mts

@@ -0,0 +1,47 @@
+import { AxiosInstance } from 'axios';
+
+interface CompanyResponse {
+    company: {
+        id: string;
+        name: string;
+        hostname: string;
+        crm_code: string;
+        token: string;
+        status: string;
+        timezone: string;
+        utc: string;
+        check_bad_password: boolean;
+        limit_bad_password: number;
+        watching: boolean;
+        trial: boolean;
+        support_widget_id: string;
+        createdAt: string;
+        updatedAt: string;
+    };
+}
+
+declare class CustomerServiceGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+    getCompanyById(companyId: string): Promise<CompanyResponse>;
+}
+
+interface GatewayClientParams {
+    axiosClient: AxiosInstance;
+    apiToken: string;
+    services: {
+        customerService: {
+            baseUrl: string;
+        };
+    };
+}
+
+declare enum SERVICE_GATEWAYS {
+    CUSTOMER_SERVICE = "customer-service"
+}
+
+declare const configure: (params: GatewayClientParams) => void;
+declare const gateway: (service: SERVICE_GATEWAYS) => CustomerServiceGateway;
+
+export { configure, gateway };

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+import { AxiosInstance } from 'axios';
+
+interface CompanyResponse {
+    company: {
+        id: string;
+        name: string;
+        hostname: string;
+        crm_code: string;
+        token: string;
+        status: string;
+        timezone: string;
+        utc: string;
+        check_bad_password: boolean;
+        limit_bad_password: number;
+        watching: boolean;
+        trial: boolean;
+        support_widget_id: string;
+        createdAt: string;
+        updatedAt: string;
+    };
+}
+
+declare class CustomerServiceGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+    getCompanyById(companyId: string): Promise<CompanyResponse>;
+}
+
+interface GatewayClientParams {
+    axiosClient: AxiosInstance;
+    apiToken: string;
+    services: {
+        customerService: {
+            baseUrl: string;
+        };
+    };
+}
+
+declare enum SERVICE_GATEWAYS {
+    CUSTOMER_SERVICE = "customer-service"
+}
+
+declare const configure: (params: GatewayClientParams) => void;
+declare const gateway: (service: SERVICE_GATEWAYS) => CustomerServiceGateway;
+
+export { configure, gateway };

package/dist/index.js

@@ -0,0 +1,83 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  configure: () => configure,
+  gateway: () => gateway
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/customer-service/index.ts
+var CustomerServiceGateway = class {
+  constructor(httpClient, baseUrl) {
+    this.httpClient = httpClient;
+    this.baseUrl = baseUrl;
+  }
+  httpClient;
+  baseUrl;
+  async getCompanyById(companyId) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/companies/search/${companyId}`);
+    return data;
+  }
+};
+
+// src/@common/client.ts
+var SDKGateways = class {
+  customerService;
+  constructor(customerService) {
+    this.customerService = customerService;
+  }
+};
+function createClient(params) {
+  const httpClient = params.axiosClient;
+  const customerService = new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl);
+  return new SDKGateways(customerService);
+}
+
+// src/index.ts
+var SDK = class {
+  client = null;
+  configure(params) {
+    this.client = createClient(params);
+  }
+};
+var sdk = new SDK();
+var configure = (params) => {
+  sdk.configure(params);
+};
+var gateway = (service) => {
+  if (!sdk.client)
+    throw new Error(
+      "SDK not configured. Please call configure() with the appropriate parameters before using the SDK."
+    );
+  switch (service) {
+    case "customer-service" /* CUSTOMER_SERVICE */:
+      return sdk.client.customerService;
+    default:
+      throw new Error(`Unknown service gateway: ${service}`);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  configure,
+  gateway
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/customer-service/index.ts","../src/@common/client.ts"],"sourcesContent":["import { createClient, SDKGatewaysInterface, GatewayClientParams } from './@common/client';\nimport { SERVICE_GATEWAYS } from './@common/enums';\nclass SDK {\n  client: SDKGatewaysInterface | null = null;\n\n  configure(params: GatewayClientParams) {\n    this.client = createClient(params);\n  }\n}\nconst sdk = new SDK();\n\nexport const configure = (params: GatewayClientParams) => {\n  sdk.configure(params);\n};\n\nexport const gateway = (service: SERVICE_GATEWAYS) => {\n  if (!sdk.client)\n    throw new Error(\n      'SDK not configured. Please call configure() with the appropriate parameters before using the SDK.',\n    );\n\n  switch (service) {\n    case SERVICE_GATEWAYS.CUSTOMER_SERVICE:\n      return sdk.client.customerService;\n    default:\n      throw new Error(`Unknown service gateway: ${service}`);\n  }\n};\n","import type { AxiosInstance } from 'axios';\nimport type { CompanyResponse } from './contracts/company';\n\nexport class CustomerServiceGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  async getCompanyById(companyId: string): Promise<CompanyResponse> {\n    const { data } = await this.httpClient.get<CompanyResponse>(`${this.baseUrl}/companies/search/${companyId}`);\n    return data;\n  }\n}\n\nexport type { CompanyResponse } from './contracts/company';\n","import { CustomerServiceGateway } from '../customer-service';\nimport { AxiosInstance } from 'axios';\n\nexport interface SDKGatewaysInterface {\n  customerService: CustomerServiceGateway;\n}\n\nclass SDKGateways {\n  customerService: CustomerServiceGateway;\n  constructor(customerService: CustomerServiceGateway) {\n    this.customerService = customerService;\n  }\n}\n\nexport interface GatewayClientParams {\n  axiosClient: AxiosInstance;\n  apiToken: string;\n  services: {\n    customerService: {\n      baseUrl: string;\n    };\n  };\n}\n\nexport function createClient(params: GatewayClientParams) {\n  const httpClient = params.axiosClient;\n  const customerService = new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl);\n  return new SDKGateways(customerService);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACGO,IAAM,yBAAN,MAA6B;AAAA,EAClC,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA,EAGnB,MAAM,eAAe,WAA6C;AAChE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAAqB,GAAG,KAAK,OAAO,qBAAqB,SAAS,EAAE;AAC3G,WAAO;AAAA,EACT;AACF;;;ACNA,IAAM,cAAN,MAAkB;AAAA,EAChB;AAAA,EACA,YAAY,iBAAyC;AACnD,SAAK,kBAAkB;AAAA,EACzB;AACF;AAYO,SAAS,aAAa,QAA6B;AACxD,QAAM,aAAa,OAAO;AAC1B,QAAM,kBAAkB,IAAI,uBAAuB,YAAY,OAAO,SAAS,gBAAgB,OAAO;AACtG,SAAO,IAAI,YAAY,eAAe;AACxC;;;AF1BA,IAAM,MAAN,MAAU;AAAA,EACR,SAAsC;AAAA,EAEtC,UAAU,QAA6B;AACrC,SAAK,SAAS,aAAa,MAAM;AAAA,EACnC;AACF;AACA,IAAM,MAAM,IAAI,IAAI;AAEb,IAAM,YAAY,CAAC,WAAgC;AACxD,MAAI,UAAU,MAAM;AACtB;AAEO,IAAM,UAAU,CAAC,YAA8B;AACpD,MAAI,CAAC,IAAI;AACP,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAEF,UAAQ,SAAS;AAAA,IACf;AACE,aAAO,IAAI,OAAO;AAAA,IACpB;AACE,YAAM,IAAI,MAAM,4BAA4B,OAAO,EAAE;AAAA,EACzD;AACF;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,55 @@
+// src/customer-service/index.ts
+var CustomerServiceGateway = class {
+  constructor(httpClient, baseUrl) {
+    this.httpClient = httpClient;
+    this.baseUrl = baseUrl;
+  }
+  httpClient;
+  baseUrl;
+  async getCompanyById(companyId) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/companies/search/${companyId}`);
+    return data;
+  }
+};
+
+// src/@common/client.ts
+var SDKGateways = class {
+  customerService;
+  constructor(customerService) {
+    this.customerService = customerService;
+  }
+};
+function createClient(params) {
+  const httpClient = params.axiosClient;
+  const customerService = new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl);
+  return new SDKGateways(customerService);
+}
+
+// src/index.ts
+var SDK = class {
+  client = null;
+  configure(params) {
+    this.client = createClient(params);
+  }
+};
+var sdk = new SDK();
+var configure = (params) => {
+  sdk.configure(params);
+};
+var gateway = (service) => {
+  if (!sdk.client)
+    throw new Error(
+      "SDK not configured. Please call configure() with the appropriate parameters before using the SDK."
+    );
+  switch (service) {
+    case "customer-service" /* CUSTOMER_SERVICE */:
+      return sdk.client.customerService;
+    default:
+      throw new Error(`Unknown service gateway: ${service}`);
+  }
+};
+export {
+  configure,
+  gateway
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/customer-service/index.ts","../src/@common/client.ts","../src/index.ts"],"sourcesContent":["import type { AxiosInstance } from 'axios';\nimport type { CompanyResponse } from './contracts/company';\n\nexport class CustomerServiceGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  async getCompanyById(companyId: string): Promise<CompanyResponse> {\n    const { data } = await this.httpClient.get<CompanyResponse>(`${this.baseUrl}/companies/search/${companyId}`);\n    return data;\n  }\n}\n\nexport type { CompanyResponse } from './contracts/company';\n","import { CustomerServiceGateway } from '../customer-service';\nimport { AxiosInstance } from 'axios';\n\nexport interface SDKGatewaysInterface {\n  customerService: CustomerServiceGateway;\n}\n\nclass SDKGateways {\n  customerService: CustomerServiceGateway;\n  constructor(customerService: CustomerServiceGateway) {\n    this.customerService = customerService;\n  }\n}\n\nexport interface GatewayClientParams {\n  axiosClient: AxiosInstance;\n  apiToken: string;\n  services: {\n    customerService: {\n      baseUrl: string;\n    };\n  };\n}\n\nexport function createClient(params: GatewayClientParams) {\n  const httpClient = params.axiosClient;\n  const customerService = new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl);\n  return new SDKGateways(customerService);\n}\n","import { createClient, SDKGatewaysInterface, GatewayClientParams } from './@common/client';\nimport { SERVICE_GATEWAYS } from './@common/enums';\nclass SDK {\n  client: SDKGatewaysInterface | null = null;\n\n  configure(params: GatewayClientParams) {\n    this.client = createClient(params);\n  }\n}\nconst sdk = new SDK();\n\nexport const configure = (params: GatewayClientParams) => {\n  sdk.configure(params);\n};\n\nexport const gateway = (service: SERVICE_GATEWAYS) => {\n  if (!sdk.client)\n    throw new Error(\n      'SDK not configured. Please call configure() with the appropriate parameters before using the SDK.',\n    );\n\n  switch (service) {\n    case SERVICE_GATEWAYS.CUSTOMER_SERVICE:\n      return sdk.client.customerService;\n    default:\n      throw new Error(`Unknown service gateway: ${service}`);\n  }\n};\n"],"mappings":";AAGO,IAAM,yBAAN,MAA6B;AAAA,EAClC,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA,EAGnB,MAAM,eAAe,WAA6C;AAChE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAAqB,GAAG,KAAK,OAAO,qBAAqB,SAAS,EAAE;AAC3G,WAAO;AAAA,EACT;AACF;;;ACNA,IAAM,cAAN,MAAkB;AAAA,EAChB;AAAA,EACA,YAAY,iBAAyC;AACnD,SAAK,kBAAkB;AAAA,EACzB;AACF;AAYO,SAAS,aAAa,QAA6B;AACxD,QAAM,aAAa,OAAO;AAC1B,QAAM,kBAAkB,IAAI,uBAAuB,YAAY,OAAO,SAAS,gBAAgB,OAAO;AACtG,SAAO,IAAI,YAAY,eAAe;AACxC;;;AC1BA,IAAM,MAAN,MAAU;AAAA,EACR,SAAsC;AAAA,EAEtC,UAAU,QAA6B;AACrC,SAAK,SAAS,aAAa,MAAM;AAAA,EACnC;AACF;AACA,IAAM,MAAM,IAAI,IAAI;AAEb,IAAM,YAAY,CAAC,WAAgC;AACxD,MAAI,UAAU,MAAM;AACtB;AAEO,IAAM,UAAU,CAAC,YAA8B;AACpD,MAAI,CAAC,IAAI;AACP,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAEF,UAAQ,SAAS;AAAA,IACf;AACE,aAAO,IAAI,OAAO;AAAA,IACpB;AACE,YAAM,IAAI,MAAM,4BAA4B,OAAO,EAAE;AAAA,EACzD;AACF;","names":[]}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "version": "1.0.0",
+  "description": "A simple package to help with some common tasks",
+  "name": "@opens/gateways",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "dev": "tsup --watch",
+    "build": "tsup --dts --format esm,cjs"
+  },
+  "tsup": {
+    "entry": [
+      "src/index.ts"
+    ],
+    "sourcemap": true,
+    "splitting": false
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://bitbucket.org/snepdev/pkg_utils.git"
+  },
+  "author": "Opens Tecnologia",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://bitbucket.org/snepdev/pkg_utils/issues"
+  },
+  "homepage": "https://bitbucket.org/snepdev/pkg_utils#readme",
+  "devDependencies": {
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.7"
+  },
+  "dependencies": {
+    "axios": "^1.16.0"
+  }
+}