lazo-sdk 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # lazo-sdk
 
-TypeScript SDK for the [Lazo](../lazo-3) CRM API.
+TypeScript SDK for the [Lazo Digital](https://lazo.digital) API.
 
 ```ts
 import { LazoClient } from "lazo-sdk";

package/dist/index.d.ts

@@ -1,21 +1,48 @@
-/** Lazo CRM SDK — phase 1: create records via the Lazo API. */
+/** Lazo CRM SDK — create and list records via the Lazo API. */
 export interface LazoClientOptions {
     /** API token from Lazo (starts with `lazo_`). */
     apiToken: string;
-    /** Base URL of the Lazo instance, e.g. https://app.lazo.com */
+    /** Base URL of the Lazo instance, e.g. https://app.lazo.digital */
     baseUrl: string;
 }
 export declare class LazoError extends Error {
     status: number;
     constructor(status: number, message: string);
 }
+/**
+ * Search records by custom field (exact-match).
+ */
+export type SearchRecordsOptions = Record<string, string | number | boolean>;
+/** Options for listing records. */
+export interface ListRecordsOptions {
+    page?: number;
+    limit?: number;
+    sort?: "createdAt" | "updatedAt";
+    order?: "asc" | "desc";
+    deleted?: boolean;
+}
+/** Paginated list response from GET /api/{resource}. */
+export interface ListRecordsResponse<T = Record<string, unknown>> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+}
 export declare class LazoClient {
     private readonly apiToken;
     private readonly baseUrl;
     constructor(options: LazoClientOptions);
     /**
      * Create a record for the given resource (e.g. "contacts", "deals").
-     * Maps to POST /api/{resource} on the Lazo API.
      */
     createRecord<T = Record<string, unknown>>(resource: string, data: Record<string, unknown>): Promise<T>;
+    /**
+     * List records for the given resource, paginated with `options` and filtered by `search`.
+     */
+    listRecords<T = Record<string, unknown>>(resource: string, search?: SearchRecordsOptions, options?: ListRecordsOptions): Promise<ListRecordsResponse<T>>;
+    /**
+     * Fetch a single record by id.
+     */
+    getRecord<T = Record<string, unknown>>(resource: string, id: string): Promise<T>;
+    private request;
 }

package/dist/index.js

@@ -1,4 +1,4 @@
-/** Lazo CRM SDK — phase 1: create records via the Lazo API. */
+/** Lazo CRM SDK — create and list records via the Lazo API. */
 export class LazoError extends Error {
     status;
     constructor(status, message) {
@@ -20,16 +20,44 @@ export class LazoClient {
     }
     /**
      * Create a record for the given resource (e.g. "contacts", "deals").
-     * Maps to POST /api/{resource} on the Lazo API.
      */
     async createRecord(resource, data) {
-        const res = await fetch(`${this.baseUrl}/api/${resource}`, {
+        return this.request(`/api/${resource}`, {
             method: "POST",
+            body: JSON.stringify(data),
+        });
+    }
+    /**
+     * List records for the given resource, paginated with `options` and filtered by `search`.
+     */
+    async listRecords(resource, search = {}, options = {}) {
+        const params = new URLSearchParams();
+        for (const [k, v] of Object.entries(options)) {
+            if (v !== undefined)
+                params.set(k, String(v));
+        }
+        for (const [k, v] of Object.entries(search)) {
+            if (v !== undefined)
+                params.set(k, String(v));
+        }
+        const query = params.toString();
+        const suffix = query ? `?${query}` : "";
+        return this.request(`/api/resources/${resource}${suffix}`);
+    }
+    /**
+     * Fetch a single record by id.
+     */
+    async getRecord(resource, id) {
+        return this.request(`/api/${resource}/${encodeURIComponent(id)}`);
+    }
+    async request(path, init = {}) {
+        const res = await fetch(`${this.baseUrl}${path}`, {
+            ...init,
             headers: {
                 Authorization: `Bearer ${this.apiToken}`,
                 "Content-Type": "application/json",
+                ...init.headers,
             },
-            body: JSON.stringify(data),
         });
         if (!res.ok) {
             const body = await res.json().catch(() => ({}));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "lazo-sdk",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"description": "TypeScript SDK for the Lazo CRM API",
 	"author": "Juan Daniel <juan.sanchez@stallionstudios.net>",
 	"repository": {
@@ -13,7 +13,9 @@
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
-	"files": ["dist"],
+	"files": [
+		"dist"
+	],
 	"scripts": {
 		"build": "tsc",
 		"test": "node --import tsx --test test/*.test.ts"