@gesagro/jaspion-sdk 1.0.11 → 2.0.0

package/README.md

@@ -1,7 +1,66 @@
+# @gesagro/jaspion-sdk
+
+SDK para o Jaspion.
+
+O SDK é agnóstico de transporte: ele não faz requisições HTTP diretamente.
+Em vez disso, você fornece uma implementação de `HttpClient`, que pode ser
+construída sobre qualquer biblioteca HTTP.
+
+## Instalação
+
 ```bash
-npm version x.x.x
+npm install @gesagro/jaspion-sdk
 ```
 
-```bash
-npm publish
+## Uso com axios
+
+### 1. Implemente o `HttpClient`
+
+O contrato é simples: receber um `HttpRequest` e devolver um `HttpResponse`.
+
+```ts
+import axios, { type AxiosInstance } from 'axios'
+import type { HttpClient, HttpRequest, HttpResponse } from '@gesagro/jaspion-sdk'
+
+export class AxiosHttpClient implements HttpClient {
+  constructor(private readonly instance: AxiosInstance) {}
+
+  async request<T>({
+    method,
+    path,
+    body,
+    headers,
+  }: HttpRequest): Promise<HttpResponse<T>> {
+    const response = await this.instance.request<T>({
+      method,
+      url: path,
+      data: body,
+      headers,
+    })
+
+    return {
+      status: response.status,
+      data: response.data,
+    }
+  }
+}
+```
+
+### 2. Instancie o `Jaspion`
+
+A `baseURL` e a autenticação ficam na instância do axios, mantendo o SDK
+focado apenas nos recursos da API.
+
+```ts
+import axios from 'axios'
+import { Jaspion } from '@gesagro/jaspion-sdk'
+import { AxiosHttpClient } from './axios-http-client'
+
+const instance = axios.create({
+  baseURL: 'https://api.jaspion.com',
+})
+
+const jaspion = new Jaspion({
+  http: new AxiosHttpClient(instance),
+})
 ```

package/dist/index.d.mts

@@ -1,9 +1,16 @@
-declare class HttpClient {
-    private readonly baseUrl;
-    private headers;
-    constructor(baseUrl: string);
-    setHeader(key: string, value: string): void;
-    post(path: string, body: unknown): Promise<void>;
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+interface HttpRequest {
+    method: HttpMethod;
+    path: string;
+    body?: unknown;
+    headers?: Record<string, string>;
+}
+interface HttpResponse<T = unknown> {
+    status: number;
+    data: T;
+}
+interface HttpClient {
+    request<T = unknown>(request: HttpRequest): Promise<HttpResponse<T>>;
 }
 
 interface CsvReport {
@@ -1424,12 +1431,12 @@ declare class PigMaster {
     constructor(http: HttpClient);
 }
 
-declare class JaspionClient {
-    private readonly http;
+interface JaspionConfig {
+    http: HttpClient;
+}
+declare class Jaspion {
     readonly pigMaster: PigMaster;
-    constructor(http: HttpClient);
-    setAccessToken(token: string): void;
+    constructor({ http }: JaspionConfig);
 }
-declare function jaspion(baseUrl: string): JaspionClient;
 
-export { jaspion };
+export { type HttpClient, type HttpMethod, type HttpRequest, type HttpResponse, Jaspion, type JaspionConfig };

package/dist/index.d.ts

@@ -1,9 +1,16 @@
-declare class HttpClient {
-    private readonly baseUrl;
-    private headers;
-    constructor(baseUrl: string);
-    setHeader(key: string, value: string): void;
-    post(path: string, body: unknown): Promise<void>;
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+interface HttpRequest {
+    method: HttpMethod;
+    path: string;
+    body?: unknown;
+    headers?: Record<string, string>;
+}
+interface HttpResponse<T = unknown> {
+    status: number;
+    data: T;
+}
+interface HttpClient {
+    request<T = unknown>(request: HttpRequest): Promise<HttpResponse<T>>;
 }
 
 interface CsvReport {
@@ -1424,12 +1431,12 @@ declare class PigMaster {
     constructor(http: HttpClient);
 }
 
-declare class JaspionClient {
-    private readonly http;
+interface JaspionConfig {
+    http: HttpClient;
+}
+declare class Jaspion {
     readonly pigMaster: PigMaster;
-    constructor(http: HttpClient);
-    setAccessToken(token: string): void;
+    constructor({ http }: JaspionConfig);
 }
-declare function jaspion(baseUrl: string): JaspionClient;
 
-export { jaspion };
+export { type HttpClient, type HttpMethod, type HttpRequest, type HttpResponse, Jaspion, type JaspionConfig };