@defarm/sdk 0.1.0 → 0.1.2

package/README.md

@@ -17,6 +17,30 @@ const sdk = new DefarmSdk({ gatewayBaseUrl: "https://gateway.defarm.net" });
 const auth = await sdk.auth.login("email", "senha");
 sdk.setAccessToken(auth.access_token);
 
+const circuits = await sdk.circuits.list();
+console.log(circuits);
+
+const disclosure = await sdk.disclosures.create({
+  item_id: "<item_id>",
+  preset: "finance_basic",
+  audience: "bank_partner",
+});
+console.log(disclosure.receipt_id);
+
+const receipts = await sdk.receipts.list({ receipt_type: "disclosure" });
+console.log(receipts.length);
+```
+
+## Autenticação por API key (parceiro)
+
+```ts
+import { DefarmSdk } from "@defarm/sdk";
+
+const sdk = new DefarmSdk({
+  gatewayBaseUrl: "https://gateway.defarm.net",
+  apiKey: process.env.DEFARM_API_KEY,
+});
+
 const circuits = await sdk.circuits.list();
 console.log(circuits);
 ```

package/dist/client.d.ts

@@ -2,7 +2,9 @@ import { HttpMethod, SdkConfig } from "./types.js";
 export declare class DefarmHttpClient {
     private readonly config;
     private accessToken?;
+    private apiKey?;
     constructor(config: SdkConfig);
     setAccessToken(token?: string): void;
+    setApiKey(apiKey?: string): void;
     request<T>(method: HttpMethod, path: string, body?: unknown): Promise<T>;
 }

package/dist/client.js

@@ -3,15 +3,20 @@ import { DefarmApiError } from "./types.js";
 export class DefarmHttpClient {
     config;
     accessToken;
+    apiKey;
     constructor(config) {
         this.config = {
             timeoutMs: 20000,
             ...config,
         };
+        this.apiKey = config.apiKey;
     }
     setAccessToken(token) {
         this.accessToken = token;
     }
+    setApiKey(apiKey) {
+        this.apiKey = apiKey;
+    }
     async request(method, path, body) {
         const url = `${this.config.gatewayBaseUrl.replace(/\/$/, "")}${path}`;
         const headers = {
@@ -20,6 +25,9 @@ export class DefarmHttpClient {
         if (this.accessToken) {
             headers.authorization = `Bearer ${this.accessToken}`;
         }
+        if (this.apiKey) {
+            headers["x-api-key"] = this.apiKey;
+        }
         const response = await undiciRequest(url, {
             method,
             headers,

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { DefarmHttpClient } from "./client.js";
-import { AuthApi, CircuitsApi, EventsApi, ItemsApi, WorkspaceApi } from "./modules.js";
+import { AuthApi, CircuitsApi, DisclosuresApi, EventsApi, ItemsApi, ReceiptsApi, WorkspaceApi } from "./modules.js";
 import { SdkConfig } from "./types.js";
 export * from "./types.js";
 export declare class DefarmSdk {
@@ -8,7 +8,10 @@ export declare class DefarmSdk {
     readonly circuits: CircuitsApi;
     readonly items: ItemsApi;
     readonly events: EventsApi;
+    readonly disclosures: DisclosuresApi;
+    readonly receipts: ReceiptsApi;
     readonly http: DefarmHttpClient;
     constructor(config: SdkConfig);
     setAccessToken(token?: string): void;
+    setApiKey(apiKey?: string): void;
 }

package/dist/index.js

@@ -1,5 +1,5 @@
 import { DefarmHttpClient } from "./client.js";
-import { AuthApi, CircuitsApi, EventsApi, ItemsApi, WorkspaceApi } from "./modules.js";
+import { AuthApi, CircuitsApi, DisclosuresApi, EventsApi, ItemsApi, ReceiptsApi, WorkspaceApi } from "./modules.js";
 export * from "./types.js";
 export class DefarmSdk {
     auth;
@@ -7,6 +7,8 @@ export class DefarmSdk {
     circuits;
     items;
     events;
+    disclosures;
+    receipts;
     http;
     constructor(config) {
         this.http = new DefarmHttpClient(config);
@@ -15,8 +17,13 @@ export class DefarmSdk {
         this.circuits = new CircuitsApi(this.http);
         this.items = new ItemsApi(this.http);
         this.events = new EventsApi(this.http);
+        this.disclosures = new DisclosuresApi(this.http);
+        this.receipts = new ReceiptsApi(this.http);
     }
     setAccessToken(token) {
         this.http.setAccessToken(token);
     }
+    setApiKey(apiKey) {
+        this.http.setApiKey(apiKey);
+    }
 }

package/dist/modules.d.ts

@@ -1,5 +1,5 @@
 import { DefarmHttpClient } from "./client.js";
-import { AuthResponse, Circuit, Event, Item } from "./types.js";
+import { AuthResponse, Circuit, DisclosureRequest, DisclosureResponse, Event, Item, ReceiptSummary } from "./types.js";
 export declare class AuthApi {
     private readonly http;
     constructor(http: DefarmHttpClient);
@@ -43,3 +43,20 @@ export declare class EventsApi {
     add(payload: Record<string, unknown>): Promise<unknown>;
     update(id: string, payload: Record<string, unknown>): Promise<unknown>;
 }
+export declare class DisclosuresApi {
+    private readonly http;
+    constructor(http: DefarmHttpClient);
+    create(payload: DisclosureRequest): Promise<DisclosureResponse>;
+}
+export declare class ReceiptsApi {
+    private readonly http;
+    constructor(http: DefarmHttpClient);
+    list(params?: {
+        receipt_type?: string;
+        circuit_id?: string;
+        item_id?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<ReceiptSummary[]>;
+    show(id: string): Promise<unknown>;
+}

package/dist/modules.js

@@ -89,3 +89,37 @@ export class EventsApi {
         return this.http.request("PUT", `/api/events/${id}/status`, payload);
     }
 }
+export class DisclosuresApi {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async create(payload) {
+        return this.http.request("POST", "/api/disclosures", payload);
+    }
+}
+export class ReceiptsApi {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async list(params) {
+        const qs = new URLSearchParams();
+        if (params?.receipt_type)
+            qs.set("receipt_type", params.receipt_type);
+        if (params?.circuit_id)
+            qs.set("circuit_id", params.circuit_id);
+        if (params?.item_id)
+            qs.set("item_id", params.item_id);
+        if (params?.limit != null)
+            qs.set("limit", String(params.limit));
+        if (params?.offset != null)
+            qs.set("offset", String(params.offset));
+        const suffix = qs.toString() ? `?${qs.toString()}` : "";
+        const res = await this.http.request("GET", `/api/receipts${suffix}`);
+        return Array.isArray(res) ? res : res.receipts || [];
+    }
+    async show(id) {
+        return this.http.request("GET", `/api/receipts/${id}`);
+    }
+}

package/dist/types.d.ts

@@ -3,6 +3,7 @@ export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
 export interface SdkConfig {
     gatewayBaseUrl: string;
     timeoutMs?: number;
+    apiKey?: string;
 }
 export interface AuthTokens {
     access_token: string;
@@ -50,6 +51,36 @@ export interface Event {
     circuit_id?: string;
     payload?: Record<string, unknown>;
 }
+export interface DisclosureRequest {
+    item_id: string;
+    preset: "finance_basic" | "audit_basic" | "public_basic" | string;
+    audience?: string;
+    expires_in_days?: number;
+}
+export interface DisclosureResponse {
+    receipt_id: string;
+    preset: string;
+    audience?: string;
+    proof_hash: string;
+    expires_at?: string;
+    disclosed_payload: Record<string, unknown>;
+}
+export interface ReceiptSummary {
+    receipt_id: string;
+    receipt_type: "ingestion" | "disclosure" | string;
+    status: string;
+    created_at: string;
+    completed_at?: string;
+    circuit_id?: string;
+    item_id?: string;
+    preset?: string;
+    audience?: string;
+    proof_hash?: string;
+    rows_total?: number;
+    items_created?: number;
+    items_updated?: number;
+    events_created?: number;
+}
 export declare class DefarmApiError extends Error {
     status: number;
     details?: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defarm/sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "DeFarm SDK for CLI and partner integrations",
   "license": "MIT",
   "repository": {