@factorialco/api-client 1.0.0

package/dist/cjs/generated/types.gen.js

@@ -0,0 +1,4 @@
+"use strict";
+// This file is auto-generated by @hey-api/openapi-ts
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.gen.js.map

package/dist/cjs/generated/types.gen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.gen.js","sourceRoot":"","sources":["../../../src/generated/types.gen.ts"],"names":[],"mappings":";AAAA,qDAAqD"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,5 @@
+export { FactorialClient } from "./sdk.js";
+export type { FactorialClientConfig } from "./sdk.js";
+export type { PagedMeta, PaginateOptions } from "./pagination.js";
+export * from "./generated/types.gen.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,YAAY,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACtD,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClE,cAAc,0BAA0B,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FactorialClient = void 0;
+// Public entry point for @factorialco/api-client.
+// Import FactorialClient to get started:
+//   import { FactorialClient } from "@factorialco/api-client";
+var sdk_js_1 = require("./sdk.js");
+Object.defineProperty(exports, "FactorialClient", { enumerable: true, get: function () { return sdk_js_1.FactorialClient; } });
+__exportStar(require("./generated/types.gen.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,kDAAkD;AAClD,yCAAyC;AACzC,+DAA+D;AAC/D,mCAA2C;AAAlC,yGAAA,eAAe,OAAA;AAGxB,2DAAyC"}

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/dist/cjs/pagination.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Pagination utilities for the Factorial API.
+ *
+ * The Factorial API uses cursor-based pagination. Every list endpoint returns:
+ *   { data: T[], meta: PagedMeta }
+ *
+ * To fetch the next page, pass `after_id` equal to the `end_cursor` from the
+ * previous response's `meta`. The maximum page size is 100 (the default).
+ */
+/** Pagination metadata returned by every list endpoint. */
+export type PagedMeta = {
+    /** Cursor pointing to the first item in the current page. */
+    start_cursor?: string;
+    /** Cursor pointing to the last item in the current page. Pass as `after_id` to fetch the next page. */
+    end_cursor?: string;
+    /** Whether there is a previous page. */
+    has_previous_page: boolean;
+    /** Whether there is a next page. */
+    has_next_page: boolean;
+    /** Number of items in the current page. */
+    limit: number;
+    /** Total number of items across all pages. */
+    total: number;
+};
+/** Shape of a paged API response. */
+export type PagedResponse<T> = {
+    data?: T[];
+    meta?: PagedMeta;
+};
+/** Options for pagination helpers. */
+export type PaginateOptions = {
+    /**
+     * Maximum number of items to fetch in total across all pages.
+     * Useful as a safety cap when consuming large datasets.
+     * Defaults to no limit.
+     */
+    maxItems?: number;
+    /**
+     * Number of items per page (max 100, Factorial default is 100).
+     */
+    limit?: number;
+};
+/** Parameters passed to the underlying fetcher on each page request. */
+type FetchParams = {
+    limit?: number;
+    after_id?: string;
+};
+/**
+ * Async generator that auto-paginates through all pages of a list endpoint,
+ * yielding one item at a time.
+ *
+ * @param fetcher - A function that accepts pagination params and returns a paged response.
+ * @param options - Optional limit and maxItems cap.
+ *
+ * @example
+ * ```ts
+ * // Used internally by resource classes — prefer client.employees.employees.paginate()
+ * for await (const employee of client.employees.employees.paginate()) {
+ *   console.log(employee.full_name);
+ * }
+ * ```
+ */
+export declare function paginate<T>(fetcher: (params: FetchParams) => Promise<{
+    data: PagedResponse<T> | undefined;
+    error: unknown;
+}>, options?: PaginateOptions): AsyncGenerator<T>;
+/**
+ * Collects all items from an async generator into a plain array.
+ *
+ * @example
+ * ```ts
+ * // Used internally by resource classes — prefer client.employees.employees.all()
+ * const employees = await client.employees.employees.all({ maxItems: 500 });
+ * ```
+ */
+export declare function collectAll<T>(generator: AsyncGenerator<T>): Promise<T[]>;
+export {};
+//# sourceMappingURL=pagination.d.ts.map

package/dist/cjs/pagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../src/pagination.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,2DAA2D;AAC3D,MAAM,MAAM,SAAS,GAAG;IACtB,6DAA6D;IAC7D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uGAAuG;IACvG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,oCAAoC;IACpC,aAAa,EAAE,OAAO,CAAC;IACvB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,qCAAqC;AACrC,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAC7B,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;IACX,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF,sCAAsC;AACtC,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wEAAwE;AACxE,KAAK,WAAW,GAAG;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAuB,QAAQ,CAAC,CAAC,EAC/B,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC;IAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC,EACjG,OAAO,GAAE,eAAoB,GAC5B,cAAc,CAAC,CAAC,CAAC,CA6BnB;AAED;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAAC,CAAC,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAM9E"}

package/dist/cjs/pagination.js

@@ -0,0 +1,73 @@
+"use strict";
+/**
+ * Pagination utilities for the Factorial API.
+ *
+ * The Factorial API uses cursor-based pagination. Every list endpoint returns:
+ *   { data: T[], meta: PagedMeta }
+ *
+ * To fetch the next page, pass `after_id` equal to the `end_cursor` from the
+ * previous response's `meta`. The maximum page size is 100 (the default).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginate = paginate;
+exports.collectAll = collectAll;
+/**
+ * Async generator that auto-paginates through all pages of a list endpoint,
+ * yielding one item at a time.
+ *
+ * @param fetcher - A function that accepts pagination params and returns a paged response.
+ * @param options - Optional limit and maxItems cap.
+ *
+ * @example
+ * ```ts
+ * // Used internally by resource classes — prefer client.employees.employees.paginate()
+ * for await (const employee of client.employees.employees.paginate()) {
+ *   console.log(employee.full_name);
+ * }
+ * ```
+ */
+async function* paginate(fetcher, options = {}) {
+    const { maxItems, limit } = options;
+    let afterId;
+    let totalYielded = 0;
+    while (true) {
+        const params = {};
+        if (limit !== undefined)
+            params.limit = limit;
+        if (afterId !== undefined)
+            params.after_id = afterId;
+        const response = await fetcher(params);
+        if (response.error) {
+            throw response.error;
+        }
+        const paged = response.data;
+        if (!paged || !paged.data?.length)
+            break;
+        for (const item of paged.data) {
+            yield item;
+            totalYielded++;
+            if (maxItems !== undefined && totalYielded >= maxItems)
+                return;
+        }
+        if (!paged.meta?.has_next_page || !paged.meta?.end_cursor)
+            break;
+        afterId = paged.meta.end_cursor;
+    }
+}
+/**
+ * Collects all items from an async generator into a plain array.
+ *
+ * @example
+ * ```ts
+ * // Used internally by resource classes — prefer client.employees.employees.all()
+ * const employees = await client.employees.employees.all({ maxItems: 500 });
+ * ```
+ */
+async function collectAll(generator) {
+    const results = [];
+    for await (const item of generator) {
+        results.push(item);
+    }
+    return results;
+}
+//# sourceMappingURL=pagination.js.map

package/dist/cjs/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../src/pagination.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;AA2DH,4BAgCC;AAWD,gCAMC;AAhED;;;;;;;;;;;;;;GAcG;AACI,KAAK,SAAS,CAAC,CAAC,QAAQ,CAC7B,OAAiG,EACjG,UAA2B,EAAE;IAE7B,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACpC,IAAI,OAA2B,CAAC;IAChC,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAC9C,IAAI,OAAO,KAAK,SAAS;YAAE,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC;QAErD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAEvC,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,QAAQ,CAAC,KAAK,CAAC;QACvB,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM;YAAE,MAAM;QAEzC,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAC;YACX,YAAY,EAAE,CAAC;YACf,IAAI,QAAQ,KAAK,SAAS,IAAI,YAAY,IAAI,QAAQ;gBAAE,OAAO;QACjE,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,aAAa,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU;YAAE,MAAM;QAEjE,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;IAClC,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,UAAU,CAAI,SAA4B;IAC9D,MAAM,OAAO,GAAQ,EAAE,CAAC;IACxB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}