@cynco/sdk 0.1.0 → 0.2.0

package/README.md

@@ -1,4 +1,4 @@
-# cynco
+# @cynco/sdk
 
 The official TypeScript SDK for the [Cynco](https://cynco.io) REST API.
 
@@ -7,15 +7,15 @@ Cynco is an AI-native business platform for accounting, invoicing, payments, and
 ## Installation
 
 ```bash
-npm install cynco
+npm install @cynco/sdk
 ```
 
 ```bash
-pnpm add cynco
+pnpm add @cynco/sdk
 ```
 
 ```bash
-yarn add cynco
+yarn add @cynco/sdk
 ```
 
 **Requirements:** Node.js 18 or later.
@@ -23,7 +23,7 @@ yarn add cynco
 ## Quick Start
 
 ```typescript
-import Cynco from 'cynco';
+import Cynco from '@cynco/sdk';
 
 const cynco = new Cynco('cak_your_api_key');
 
@@ -270,7 +270,7 @@ import Cynco, {
   ValidationError,
   NotFoundError,
   RateLimitError,
-} from 'cynco';
+} from '@cynco/sdk';
 
 try {
   await cynco.customers.create({ name: '' });
@@ -324,7 +324,7 @@ If a request with the same idempotency key was already processed, the API return
 Verify incoming webhook signatures using the static `Cynco.webhooks` utility. No client instantiation needed.
 
 ```typescript
-import Cynco from 'cynco';
+import Cynco from '@cynco/sdk';
 
 // In your webhook handler (e.g. Express)
 app.post('/webhooks/cynco', (req, res) => {
@@ -393,7 +393,7 @@ import type {
   CustomerListParams,
   PaginatedResponse,
   WebhookEvent,
-} from 'cynco';
+} from '@cynco/sdk';
 ```
 
 ## CommonJS

package/dist/index.cjs

@@ -202,10 +202,10 @@ var CyncoClient = class {
           return { success: true, data: void 0 };
         }
         const json = await response.json();
-        if (rateLimitInfo && typeof json === "object" && json !== null) {
-          const withMeta = json;
-          withMeta["meta"] = {
-            ...withMeta["meta"],
+        json["success"] = true;
+        if (rateLimitInfo) {
+          json["meta"] = {
+            ...json["meta"],
             requestId,
             rateLimit: rateLimitInfo
           };
@@ -459,6 +459,7 @@ var webhookVerifier = {
 
 // src/pagination.ts
 var Page = class _Page {
+  success = true;
   data;
   pagination;
   links;
@@ -482,10 +483,10 @@ var Page = class _Page {
     if (!this.hasMore) {
       return null;
     }
-    const nextOffset = this.pagination.offset + this.pagination.limit;
+    const nextPage = Math.floor(this.pagination.offset / this.pagination.limit) + 2;
     const nextParams = {
       ...this._params,
-      offset: nextOffset
+      page: nextPage
     };
     const response = await this._fetchPage(nextParams);
     return new _Page(response, this._fetchPage, nextParams);
@@ -502,6 +503,7 @@ var Page = class _Page {
   }
 };
 var CursorPage = class _CursorPage {
+  success = true;
   data;
   pagination;
   links;
@@ -540,6 +542,51 @@ var CursorPage = class _CursorPage {
     }
   }
 };
+var PagePromise = class {
+  _promise;
+  constructor(promise) {
+    this._promise = promise;
+  }
+  /** Satisfy PromiseLike so `await` works. */
+  then(onfulfilled, onrejected) {
+    return this._promise.then(onfulfilled, onrejected);
+  }
+  /** Satisfy Promise-like `catch`. */
+  catch(onrejected) {
+    return this._promise.catch(onrejected);
+  }
+  /** Satisfy Promise-like `finally`. */
+  finally(onfinally) {
+    return this._promise.finally(onfinally);
+  }
+  /**
+   * Iterate over all items across all pages.
+   * Fetches the first page lazily, then auto-paginates.
+   */
+  async *[Symbol.asyncIterator]() {
+    const page = await this._promise;
+    yield* page;
+  }
+};
+var CursorPagePromise = class {
+  _promise;
+  constructor(promise) {
+    this._promise = promise;
+  }
+  then(onfulfilled, onrejected) {
+    return this._promise.then(onfulfilled, onrejected);
+  }
+  catch(onrejected) {
+    return this._promise.catch(onrejected);
+  }
+  finally(onfinally) {
+    return this._promise.finally(onfinally);
+  }
+  async *[Symbol.asyncIterator]() {
+    const page = await this._promise;
+    yield* page;
+  }
+};
 
 // src/resources/invoices.ts
 var Invoices = class {
@@ -549,35 +596,35 @@ var Invoices = class {
   /**
    * List invoices with pagination.
    *
-   * Returns a `Page` that can be used as an async iterator for auto-pagination:
+   * Returns a `PagePromise` that can be awaited for a single page or used
+   * directly as an async iterator for auto-pagination:
    * ```ts
+   * // Single page
+   * const page = await cynco.invoices.list({ limit: 20 });
+   * console.log(page.data);
+   *
+   * // Auto-pagination
    * for await (const invoice of cynco.invoices.list({ limit: 50 })) {
    *   console.log(invoice.id);
    * }
    * ```
    */
-  async list(params) {
+  list(params) {
     const fetchPage = async (p) => {
       return this._client.getList("/invoices", p);
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
   /** Retrieve a single invoice by ID. */
   async retrieve(id) {
     const response = await this._client.get(`/invoices/${id}`);
     return response.data;
   }
-  /** Create a new invoice. */
-  async create(data, options) {
-    const response = await this._client.post(
-      "/invoices",
-      data,
-      options
-    );
-    return response.data;
-  }
-  /** Update an existing invoice. */
+  /** Update an existing invoice (memo, paymentTerms, dueDate only). */
   async update(id, data, options) {
     const response = await this._client.patch(
       `/invoices/${id}`,
@@ -640,15 +687,18 @@ var Customers = class {
    * }
    * ```
    */
-  async list(params) {
+  list(params) {
     const fetchPage = async (p) => {
       return this._client.getList(
         "/customers",
         p
       );
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
   /** Retrieve a single customer by ID. */
   async retrieve(id) {
@@ -693,15 +743,18 @@ var Vendors = class {
    * }
    * ```
    */
-  async list(params) {
+  list(params) {
     const fetchPage = async (p) => {
       return this._client.getList(
         "/vendors",
         p
       );
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
   /** Retrieve a single vendor by ID. */
   async retrieve(id) {
@@ -746,26 +799,24 @@ var Bills = class {
    * }
    * ```
    */
-  async list(params) {
+  list(params) {
     const fetchPage = async (p) => {
       return this._client.getList(
         "/bills",
         p
       );
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
   /** Retrieve a single bill by ID. */
   async retrieve(id) {
     const response = await this._client.get(`/bills/${id}`);
     return response.data;
   }
-  /** Create a new bill. */
-  async create(data, options) {
-    const response = await this._client.post("/bills", data, options);
-    return response.data;
-  }
   /** Update an existing bill. */
   async update(id, data, options) {
     const response = await this._client.patch(
@@ -813,15 +864,18 @@ var Items = class {
    * }
    * ```
    */
-  async list(params) {
+  list(params) {
     const fetchPage = async (p) => {
       return this._client.getList(
         "/items",
         p
       );
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
   /** Retrieve a single item by ID. */
   async retrieve(id) {
@@ -854,51 +908,33 @@ var Accounts = class {
     this._client = _client;
   }
   /**
-   * List chart of accounts with pagination.
+   * List chart of accounts.
    *
    * ```ts
-   * for await (const account of cynco.accounts.list({ type: 'revenue' })) {
-   *   console.log(`${account.code} — ${account.name}`);
+   * const page = await cynco.accounts.list({ account_type: 'revenue' });
+   * for (const account of page.data) {
+   *   console.log(`${account.accountCode} — ${account.accountName}`);
    * }
    * ```
    */
-  async list(params) {
+  list(params) {
     const fetchPage = async (p) => {
       return this._client.getList(
         "/accounts",
         p
       );
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
   /** Retrieve a single account by ID. */
   async retrieve(id) {
-    const response = await this._client.get(`/accounts/${id}`);
-    return response.data;
-  }
-  /** Create a new account. */
-  async create(data, options) {
-    const response = await this._client.post(
-      "/accounts",
-      data,
-      options
-    );
+    const response = await this._client.get(`/accounts?id=${encodeURIComponent(id)}`);
     return response.data;
   }
-  /** Update an existing account. */
-  async update(id, data, options) {
-    const response = await this._client.patch(
-      `/accounts/${id}`,
-      data,
-      options
-    );
-    return response.data;
-  }
-  /** Delete an account. Only unused accounts can be deleted. */
-  async delete(id, options) {
-    await this._client.delete(`/accounts/${id}`, options);
-  }
 };
 
 // src/resources/journal-entries.ts
@@ -915,15 +951,18 @@ var JournalEntries = class {
    * }
    * ```
    */
-  async list(params) {
+  list(params) {
     const fetchPage = async (p) => {
       return this._client.getList(
         "/journal-entries",
         p
       );
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
   /** Retrieve a single journal entry by ID. */
   async retrieve(id) {
@@ -988,15 +1027,18 @@ var BankAccounts = class {
    * }
    * ```
    */
-  async list(params) {
+  list(params) {
     const fetchPage = async (p) => {
       return this._client.getList(
         "/bank-accounts",
         p
       );
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
   /** Retrieve a single bank account by ID. */
   async retrieve(id) {
@@ -1036,15 +1078,18 @@ var BankAccounts = class {
    * }
    * ```
    */
-  async listTransactions(bankAccountId, params) {
+  listTransactions(bankAccountId, params) {
     const fetchPage = async (p) => {
       return this._client.getList(
         `/bank-accounts/${bankAccountId}/transactions`,
         p
       );
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
 };
 
@@ -1093,15 +1138,18 @@ var Webhooks = class {
    * }
    * ```
    */
-  async list(params) {
+  list(params) {
     const fetchPage = async (p) => {
       return this._client.getList(
         "/webhooks",
         p
       );
     };
-    const response = await fetchPage(params ?? {});
-    return new Page(response, fetchPage, params ?? {});
+    return new PagePromise(
+      fetchPage(params ?? {}).then(
+        (response) => new Page(response, fetchPage, params ?? {})
+      )
+    );
   }
   /** Retrieve a single webhook endpoint by ID. */
   async retrieve(id) {
@@ -1199,6 +1247,7 @@ exports.Bills = Bills;
 exports.ConflictError = ConflictError;
 exports.ConnectionError = ConnectionError;
 exports.CursorPage = CursorPage;
+exports.CursorPagePromise = CursorPagePromise;
 exports.Customers = Customers;
 exports.Cynco = Cynco;
 exports.CyncoClient = CyncoClient;
@@ -1209,6 +1258,7 @@ exports.Items = Items;
 exports.JournalEntries = JournalEntries;
 exports.NotFoundError = NotFoundError;
 exports.Page = Page;
+exports.PagePromise = PagePromise;
 exports.PermissionError = PermissionError;
 exports.RateLimitError = RateLimitError;
 exports.Reports = Reports;