@factorialco/api-client 3.0.0-beta.2026100139 → 3.0.0

package/dist/cjs/generated/types.gen.d.ts

@@ -12974,7 +12974,7 @@ export type GetApi20261001ResourcesCompensationsPayrollResultsByIdResponse = Get
 export type PostApi20261001ResourcesCompensationsPayrollResultsBulkCreateData = {
     body?: {
         /**
-         * Parent payroll run id, refers to compensations/payroll_runs endpoint.
+         * Parent payroll run id, refers to compensations/payroll_runs endpoint. The run must already exist; find it through compensations/cycles and compensations/payroll_runs.
          */
         payroll_run_id: string;
         /**
@@ -12982,7 +12982,7 @@ export type PostApi20261001ResourcesCompensationsPayrollResultsBulkCreateData =
          */
         results: Array<{
             /**
-             * Employee id, refers to employees/employees endpoint.
+             * Employee id, refers to employees/employees endpoint. Must be part of the payroll run.
              */
             employee_id: string;
             /**
@@ -12994,7 +12994,7 @@ export type PostApi20261001ResourcesCompensationsPayrollResultsBulkCreateData =
                  */
                 payroll_concept_id: string;
                 /**
-                 * Signed amount in the concept's minor unit (cents for money concepts)
+                 * Signed amount in the concept's minor unit (cents for money concepts), between -2147483648 and 2147483647
                  */
                 amount: number;
             }>;

package/dist/cjs/index.d.ts

@@ -1,6 +1,8 @@
 export { FactorialClient } from "./sdk.js";
 export type { FactorialClientConfig } from "./sdk.js";
 export type { PagedMeta, PaginateOptions } from "./pagination.js";
+export { FactorialApiError, isFactorialApiError } from "./errors.js";
+export type { FactorialApiErrorInit } from "./errors.js";
 export * from "./generated/types.gen.js";
 export * from "./webhooks.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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;AAGzC,cAAc,eAAe,CAAC"}
+{"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;AAGlE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACrE,YAAY,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACzD,cAAc,0BAA0B,CAAC;AAGzC,cAAc,eAAe,CAAC"}

package/dist/cjs/index.js

@@ -14,12 +14,17 @@ 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;
+exports.isFactorialApiError = exports.FactorialApiError = 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; } });
+// Every non-2xx response is thrown as a FactorialApiError; transport failures
+// (e.g. a fetch TypeError) propagate untouched.
+var errors_js_1 = require("./errors.js");
+Object.defineProperty(exports, "FactorialApiError", { enumerable: true, get: function () { return errors_js_1.FactorialApiError; } });
+Object.defineProperty(exports, "isFactorialApiError", { enumerable: true, get: function () { return errors_js_1.isFactorialApiError; } });
 __exportStar(require("./generated/types.gen.js"), exports);
 // Typed webhook catalog: per-event payload aliases, WebhookSubscriptionType,
 // WebhookPayloadMap, and the runtime WEBHOOK_CATALOG.

package/dist/cjs/index.js.map

@@ -1 +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;AACzC,6EAA6E;AAC7E,sDAAsD;AACtD,gDAA8B"}
+{"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,8EAA8E;AAC9E,gDAAgD;AAChD,yCAAqE;AAA5D,8GAAA,iBAAiB,OAAA;AAAE,gHAAA,mBAAmB,OAAA;AAE/C,2DAAyC;AACzC,6EAA6E;AAC7E,sDAAsD;AACtD,gDAA8B"}

package/dist/cjs/pagination.d.ts

@@ -49,7 +49,10 @@ type FetchParams = {
  * 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 fetcher - A function that accepts pagination params and resolves to a
+ *   paged response. It must *reject* on failure rather than reporting the error
+ *   in its result: `FactorialClient` methods throw a `FactorialApiError`, which
+ *   propagates out of the generator to the caller.
  * @param options - Optional limit and maxItems cap.
  *
  * @example
@@ -61,8 +64,7 @@ type FetchParams = {
  * ```
  */
 export declare function paginate<T>(fetcher: (params: FetchParams) => Promise<{
-    data: PagedResponse<T> | undefined;
-    error: unknown;
+    data?: PagedResponse<T>;
 }>, options?: PaginateOptions): AsyncGenerator<T>;
 /**
  * Collects all items from an async generator into a plain array.

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

@@ -1 +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"}
+{"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;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAuB,QAAQ,CAAC,CAAC,EAC/B,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC;IAAE,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;CAAE,CAAC,EACtE,OAAO,GAAE,eAAoB,GAC5B,cAAc,CAAC,CAAC,CAAC,CAuBnB;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

@@ -15,7 +15,10 @@ 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 fetcher - A function that accepts pagination params and resolves to a
+ *   paged response. It must *reject* on failure rather than reporting the error
+ *   in its result: `FactorialClient` methods throw a `FactorialApiError`, which
+ *   propagates out of the generator to the caller.
  * @param options - Optional limit and maxItems cap.
  *
  * @example
@@ -36,11 +39,7 @@ async function* paginate(fetcher, options = {}) {
             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;
+        const { data: paged } = await fetcher(params);
         if (!paged || !paged.data?.length)
             break;
         for (const item of paged.data) {

package/dist/cjs/pagination.js.map

@@ -1 +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"}
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../src/pagination.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;AA8DH,4BA0BC;AAWD,gCAMC;AA7DD;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,SAAS,CAAC,CAAC,QAAQ,CAC7B,OAAsE,EACtE,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,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9C,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"}