@faable/sdk-base 1.0.12 → 1.0.14

package/README.md

@@ -6,13 +6,13 @@
 </p>
 
 <p align="center">
-  <a aria-label="NPM version" href="https://www.npmjs.com/package/@faable/sdk-generic">
-    <img alt="" src="https://img.shields.io/npm/v/@faable/sdk-generic.svg?style=for-the-badge&labelColor=000000">
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/@faable/sdk-base">
+    <img alt="" src="https://img.shields.io/npm/v/@faable/sdk-base.svg?style=for-the-badge&labelColor=000000">
   </a>
 </p>
 
 ## Install
 
 ```bash
- npm install @faable/sdk-generic
+ npm install @faable/sdk-base
 ```

package/dist/FaableApi.d.ts

@@ -1,11 +1,12 @@
 import { AuthInterface } from "./types/AuthInterface.js";
 import { Fetcher, FetcherCreateParams } from "./fetcher/Fetcher.js";
-import { Paginator } from "./helpers/paginator.js";
+import { Paginator, PaginatorOptions } from "./helpers/paginator.js";
 export type ApiParams = {
     baseURL?: string;
     fetcher?: FetcherCreateParams;
     auth?: AuthInterface<any, any>;
     debug?: boolean;
+    paginator?: Partial<PaginatorOptions>;
 };
 export declare abstract class FaableApi<Params extends ApiParams = ApiParams> {
     protected fetcher: Fetcher;

package/dist/FaableApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FaableApi.d.ts","sourceRoot":"","sources":["../src/FaableApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEpE,OAAO,EAAkB,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnE,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,IAAI,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,8BAAsB,SAAS,CAAC,MAAM,SAAS,SAAS,GAAG,SAAS;IAClE,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC;IAC/B,SAAS,aAAa,MAAM,CAAC,EAAE,MAAM;IAMrC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,QAAQ,MAAM,IAAI,EAAE,MAAM,KAAK,GAAG,EAAE,MAAM,GAAG,GAAG,EACtE,IAAI,EAAE,CAAC,EACP,MAAM,CAAC,EAAE,MAAM,GACd,YAAY,CAAC,CAAC,CAAC;CAInB"}
+{"version":3,"file":"FaableApi.d.ts","sourceRoot":"","sources":["../src/FaableApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEpE,OAAO,EAEL,SAAS,EACT,gBAAgB,EACjB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,IAAI,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACvC,CAAC;AAEF,8BAAsB,SAAS,CAAC,MAAM,SAAS,SAAS,GAAG,SAAS;IAClE,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC;IAC/B,SAAS,aAAa,MAAM,CAAC,EAAE,MAAM;IAMrC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,QAAQ,MAAM,IAAI,EAAE,MAAM,KAAK,GAAG,EAAE,MAAM,GAAG,GAAG,EACtE,IAAI,EAAE,CAAC,EACP,MAAM,CAAC,EAAE,MAAM,GACd,YAAY,CAAC,CAAC,CAAC;CAInB"}

package/dist/FaableApi.js

@@ -1,12 +1,12 @@
 import { fetcher_axios } from "./fetcher/fetcher_axios.js";
-import { buildPaginator } from "./helpers/paginator.js";
+import { buildPaginator, } from "./helpers/paginator.js";
 export class FaableApi {
     fetcher;
     paginator;
     constructor(params) {
         const options = params || {};
         this.fetcher = fetcher_axios(options);
-        this.paginator = buildPaginator(this.fetcher);
+        this.paginator = buildPaginator(this.fetcher, options.paginator);
     }
     static create(params) {
         let Cns = this;

package/dist/helpers/paginator.d.ts

@@ -4,7 +4,10 @@ export interface Page<T> {
     results: T[];
 }
 export type Paginator = ReturnType<typeof buildPaginator>;
-export declare const buildPaginator: (fetcher: Fetcher) => <T>(req: FetcherRequestParams) => {
+export type PaginatorOptions = {
+    limit_pages: number;
+};
+export declare const buildPaginator: (fetcher: Fetcher, options?: Partial<PaginatorOptions>) => <T>(req: FetcherRequestParams) => {
     all: () => Promise<T[]>;
     first: () => Promise<Page<T>>;
     pass: (params?: {

package/dist/helpers/paginator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paginator.d.ts","sourceRoot":"","sources":["../../src/helpers/paginator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAGtE,MAAM,WAAW,IAAI,CAAC,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,CAAC,EAAE,CAAC;CACd;AACD,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAC1D,eAAO,MAAM,cAAc,YACf,OAAO,MAChB,CAAC,OAAO,oBAAoB;;;oBA0BJ;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE;CAU9D,CAAC"}
+{"version":3,"file":"paginator.d.ts","sourceRoot":"","sources":["../../src/helpers/paginator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAGtE,MAAM,WAAW,IAAI,CAAC,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,CAAC,EAAE,CAAC;CACd;AACD,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAE1D,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,cAAc,YAChB,OAAO,YACN,OAAO,CAAC,gBAAgB,CAAC,MAO3B,CAAC,OAAO,oBAAoB;;;oBAoCX;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE;CAWhE,CAAC"}

package/dist/helpers/paginator.js

@@ -1,38 +1,49 @@
 import { FaableApiError } from "./FaableApiError.js";
-export const buildPaginator = (fetcher) => (req) => {
-    return {
-        all: async () => {
-            const pages = [];
-            let data;
-            let nextCurrent = null;
-            do {
-                data = await fetcher.request({
+export const buildPaginator = (fetcher, options) => {
+    const LIMIT_PAGES = options?.limit_pages || 100;
+    if (LIMIT_PAGES < 0) {
+        throw new Error("limit_pages cannot be negative");
+    }
+    return (req) => {
+        return {
+            all: async () => {
+                const pages = [];
+                let data;
+                let nextCurrent;
+                do {
+                    // Upper bound to kill if limit pages reached
+                    if (LIMIT_PAGES > 0 && pages.length >= LIMIT_PAGES) {
+                        throw new FaableApiError(`Cannot fetch more than ${LIMIT_PAGES} pages, update paginator configuration to continue`);
+                    }
+                    // Do request
+                    data = await fetcher.request({
+                        ...req,
+                        params: data?.next
+                            ? { ...req.params, next: data.next }
+                            : req.params,
+                    });
+                    // Next cursor cannot be the same as previous received one. Sanity check the api.
+                    if (data?.next != null && nextCurrent == data?.next) {
+                        throw new FaableApiError("Bad next cursor");
+                    }
+                    nextCurrent = data.next;
+                    // Add to data array
+                    pages.push(data);
+                } while (data.next);
+                return pages.map((page) => page.results).flat();
+            },
+            first: async () => {
+                return fetcher.request(req);
+            },
+            pass: async (params = {}) => {
+                return fetcher.request({
                     ...req,
-                    params: data?.next
-                        ? { ...req.params, next: data.next }
-                        : req.params,
+                    params: {
+                        ...req.params,
+                        ...params,
+                    },
                 });
-                // Next cursor cannot be the same as previous received one. Sanity check the api.
-                if (nextCurrent == data?.next) {
-                    throw new FaableApiError("Bad next cursor");
-                }
-                nextCurrent = data.next;
-                // Add to data array
-                pages.push(data);
-            } while (data.next);
-            return pages.map((page) => page.results).flat();
-        },
-        first: async () => {
-            return fetcher.request(req);
-        },
-        pass: async (params = {}) => {
-            return fetcher.request({
-                ...req,
-                params: {
-                    ...req.params,
-                    ...params,
-                },
-            });
-        },
+            },
+        };
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faable/sdk-base",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "author": "Marc Pomar <marc@faable.com>",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",