@abyss-project/tools 2.15.0 → 2.16.0

package/dist/api/extraction.application.api.d.ts

@@ -1,4 +1,4 @@
-import type { IExtractBody } from '../types';
+import type { IExtractApplicationBody } from '../types';
 import type { IExtractSyncResponse } from '../types';
 import { ExtractCallOptions } from './extraction.api';
-export declare const runExtractionApplication: (applicationId: string, body: IExtractBody, options?: ExtractCallOptions, applicationApiKey?: string) => Promise<IExtractSyncResponse>;
+export declare const runExtractionApplication: (applicationId: string, body: IExtractApplicationBody, options?: ExtractCallOptions, applicationApiKey?: string) => Promise<IExtractSyncResponse>;

package/dist/api/extraction.application.api.js

@@ -12,18 +12,11 @@ const runExtractionApplication = async (applicationId, body, options = {}, appli
         extraHeaders['Idempotency-Key'] = options.idempotencyKey;
     }
     const url = `extract/application/${applicationId}/extract`;
-    if (body.pdf) {
-        const form = (0, extraction_api_1.buildExtractMultipart)(body);
-        return (await __1.AbyssToolsCore.axios.post(url, form, {
-            headers: { ...authHeaderApplication(applicationApiKey), ...extraHeaders },
-            maxBodyLength: Infinity,
-            maxContentLength: Infinity,
-        })).data;
-    }
-    const jsonBody = { ...body };
-    delete jsonBody.pdf;
-    return (await __1.AbyssToolsCore.axios.post(url, jsonBody, {
+    const form = (0, extraction_api_1.buildExtractMultipart)(body);
+    return (await __1.AbyssToolsCore.axios.post(url, form, {
         headers: { ...authHeaderApplication(applicationApiKey), ...extraHeaders },
+        maxBodyLength: Infinity,
+        maxContentLength: Infinity,
     })).data;
 };
 exports.runExtractionApplication = runExtractionApplication;

package/dist/api/extraction.application.api.js.map

@@ -1 +1 @@
-{"version":3,"file":"extraction.application.api.js","sourceRoot":"","sources":["../../src/api/extraction.application.api.ts"],"names":[],"mappings":";;;AAwBA,0BAAgE;AAGhE,qDAA6E;AAE7E,SAAS,qBAAqB,CAAC,iBAA0B;IACvD,OAAO,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,8BAA0B,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACtF,CAAC;AAkBM,MAAM,wBAAwB,GAAG,KAAK,EAC3C,aAAqB,EACrB,IAAkB,EAClB,UAA8B,EAAE,EAChC,iBAA0B,EACK,EAAE;IACjC,MAAM,YAAY,GAA2B,EAAE,CAAC;IAChD,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;QAC3B,YAAY,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAC3D,CAAC;IACD,MAAM,GAAG,GAAG,uBAAuB,aAAa,UAAU,CAAC;IAE3D,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,GAAG,IAAA,sCAAqB,EAAC,IAAI,CAAC,CAAC;QACzC,OAAO,CACL,MAAM,kBAAc,CAAC,KAAK,CAAC,IAAI,CAAuB,GAAG,EAAE,IAAI,EAAE;YAC/D,OAAO,EAAE,EAAE,GAAG,qBAAqB,CAAC,iBAAiB,CAAC,EAAE,GAAG,YAAY,EAAE;YACzE,aAAa,EAAE,QAAQ;YACvB,gBAAgB,EAAE,QAAQ;SAC3B,CAAC,CACH,CAAC,IAAI,CAAC;IACT,CAAC;IAGD,MAAM,QAAQ,GAA8B,EAAE,GAAG,IAAI,EAAE,CAAC;IACxD,OAAQ,QAA8B,CAAC,GAAG,CAAC;IAC3C,OAAO,CACL,MAAM,kBAAc,CAAC,KAAK,CAAC,IAAI,CAAuB,GAAG,EAAE,QAAQ,EAAE;QACnE,OAAO,EAAE,EAAE,GAAG,qBAAqB,CAAC,iBAAiB,CAAC,EAAE,GAAG,YAAY,EAAE;KAC1E,CAAC,CACH,CAAC,IAAI,CAAC;AACT,CAAC,CAAC;AA/BW,QAAA,wBAAwB,4BA+BnC"}
+{"version":3,"file":"extraction.application.api.js","sourceRoot":"","sources":["../../src/api/extraction.application.api.ts"],"names":[],"mappings":";;;AA0BA,0BAAgE;AAGhE,qDAA6E;AAE7E,SAAS,qBAAqB,CAAC,iBAA0B;IACvD,OAAO,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,8BAA0B,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACtF,CAAC;AAgBM,MAAM,wBAAwB,GAAG,KAAK,EAC3C,aAAqB,EACrB,IAA6B,EAC7B,UAA8B,EAAE,EAChC,iBAA0B,EACK,EAAE;IACjC,MAAM,YAAY,GAA2B,EAAE,CAAC;IAChD,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;QAC3B,YAAY,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAC3D,CAAC;IACD,MAAM,GAAG,GAAG,uBAAuB,aAAa,UAAU,CAAC;IAE3D,MAAM,IAAI,GAAG,IAAA,sCAAqB,EAAC,IAAI,CAAC,CAAC;IACzC,OAAO,CACL,MAAM,kBAAc,CAAC,KAAK,CAAC,IAAI,CAAuB,GAAG,EAAE,IAAI,EAAE;QAC/D,OAAO,EAAE,EAAE,GAAG,qBAAqB,CAAC,iBAAiB,CAAC,EAAE,GAAG,YAAY,EAAE;QACzE,aAAa,EAAE,QAAQ;QACvB,gBAAgB,EAAE,QAAQ;KAC3B,CAAC,CACH,CAAC,IAAI,CAAC;AACT,CAAC,CAAC;AApBW,QAAA,wBAAwB,4BAoBnC"}

package/dist/api/extraction.application.api.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/api/extraction.application.api.test.js

@@ -0,0 +1,59 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const api = __importStar(require("./extraction.application.api"));
+const _run = api.runExtractionApplication;
+void _run;
+const _minimal = { pdf, mode: 'auto' };
+const _full = {
+    pdf,
+    mode: 'hint',
+    hint: { bank: 'bnp' },
+    pdf_filename: 'invoice.pdf',
+    user_external_id: 'u-1',
+    user_metadata: { a: 1 },
+    archive: true,
+    force: false,
+    improvementConsent: true,
+};
+const _named = _minimal;
+void _minimal;
+void _full;
+void _named;
+const _noPdf = { mode: 'auto' };
+const _storage = { pdf, mode: 'auto', storage_file_id: 'f' };
+const _templateId = { pdf, mode: 'auto', template_id: 't' };
+const _template = { pdf, mode: 'auto', template: {} };
+const _preset = { pdf, mode: 'auto', plan_preset_id: 'p' };
+const _modeTemplate = { pdf, mode: 'template' };
+const _processing = { pdf, mode: 'auto', processing: 'queue' };
+void _noPdf;
+void _storage;
+void _templateId;
+void _template;
+void _preset;
+void _modeTemplate;
+void _processing;
+//# sourceMappingURL=extraction.application.api.test.js.map

package/dist/api/extraction.application.api.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extraction.application.api.test.js","sourceRoot":"","sources":["../../src/api/extraction.application.api.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAIA,kEAAoD;AAGpD,MAAM,IAAI,GAAwC,GAAG,CAAC,wBAAwB,CAAC;AAC/E,KAAK,IAAI,CAAC;AAMV,MAAM,QAAQ,GAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC7C,MAAM,KAAK,GAAS;IAClB,GAAG;IACH,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;IACrB,YAAY,EAAE,aAAa;IAC3B,gBAAgB,EAAE,KAAK;IACvB,aAAa,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE;IACvB,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,KAAK;IACZ,kBAAkB,EAAE,IAAI;CACzB,CAAC;AACF,MAAM,MAAM,GAA4B,QAAQ,CAAC;AACjD,KAAK,QAAQ,CAAC;AACd,KAAK,KAAK,CAAC;AACX,KAAK,MAAM,CAAC;AAIZ,MAAM,MAAM,GAAS,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAEtC,MAAM,QAAQ,GAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,EAAE,CAAC;AAEnE,MAAM,WAAW,GAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC;AAElE,MAAM,SAAS,GAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;AAE5D,MAAM,OAAO,GAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC;AAEjE,MAAM,aAAa,GAAS,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAEtD,MAAM,WAAW,GAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;AACrE,KAAK,MAAM,CAAC;AACZ,KAAK,QAAQ,CAAC;AACd,KAAK,WAAW,CAAC;AACjB,KAAK,SAAS,CAAC;AACf,KAAK,OAAO,CAAC;AACb,KAAK,aAAa,CAAC;AACnB,KAAK,WAAW,CAAC"}

package/dist/types/interface/api/requests/extraction.request.d.ts

@@ -26,6 +26,18 @@ export interface IExtractBody {
     plan?: IExtractionPlan;
     plan_preset_id?: string;
 }
+export interface IExtractApplicationBody {
+    pdf: Buffer | Uint8Array;
+    mode: Exclude<ExtractionMode, 'template'>;
+    hint?: IExtractionBankHint;
+    pdf_filename?: string;
+    user_external_id?: string;
+    user_metadata?: Record<string, unknown>;
+    archive?: boolean;
+    force?: boolean;
+    improvementConsent?: boolean;
+    plan?: IExtractionPlan;
+}
 export interface IExtractBulkBody {
     items: Array<{
         storage_file_id?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abyss-project/tools",
-  "version": "2.15.0",
+  "version": "2.16.0",
   "description": "Core package to interact with Abyss-Project Tools",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/api/extraction.application.api.test.ts

@@ -0,0 +1,55 @@
+// Type-level compile test for the APPLICATION extract client (#581).
+// No jest runner in this SDK package; compile guard only (mirrors
+// probe-scan.application.api.test.ts). Run: npx tsc --noEmit, or `npm run build`.
+
+import * as api from './extraction.application.api';
+import type { IExtractApplicationBody } from '../types';
+
+const _run: typeof api.runExtractionApplication = api.runExtractionApplication;
+void _run;
+
+type Body = Parameters<typeof api.runExtractionApplication>[1];
+declare const pdf: Buffer;
+
+// What the route accepts: a PDF, mode auto|hint, and the optional fields.
+const _minimal: Body = { pdf, mode: 'auto' };
+const _full: Body = {
+  pdf,
+  mode: 'hint',
+  hint: { bank: 'bnp' },
+  pdf_filename: 'invoice.pdf',
+  user_external_id: 'u-1',
+  user_metadata: { a: 1 },
+  archive: true,
+  force: false,
+  improvementConsent: true,
+};
+const _named: IExtractApplicationBody = _minimal;
+void _minimal;
+void _full;
+void _named;
+
+// What the route refuses with a 4xx must not compile.
+// @ts-expect-error the route only accepts a multipart PDF
+const _noPdf: Body = { mode: 'auto' };
+// @ts-expect-error storage_file_id is refused by the application route
+const _storage: Body = { pdf, mode: 'auto', storage_file_id: 'f' };
+// @ts-expect-error template_id is refused by the application route
+const _templateId: Body = { pdf, mode: 'auto', template_id: 't' };
+// @ts-expect-error template is refused by the application route
+const _template: Body = { pdf, mode: 'auto', template: {} };
+// @ts-expect-error plan_preset_id is refused by the application route
+const _preset: Body = { pdf, mode: 'auto', plan_preset_id: 'p' };
+// @ts-expect-error mode template is refused by the application route
+const _modeTemplate: Body = { pdf, mode: 'template' };
+// @ts-expect-error the application route is synchronous only
+const _processing: Body = { pdf, mode: 'auto', processing: 'queue' };
+void _noPdf;
+void _storage;
+void _templateId;
+void _template;
+void _preset;
+void _modeTemplate;
+void _processing;
+
+export {};

package/src/api/extraction.application.api.ts

@@ -7,11 +7,13 @@
 // API key instead of a personal/org session.
 //
 // Reuses extraction.api.ts's `buildExtractMultipart` (the same global
-// `FormData` + `Blob` multipart body as the personal client) and every
-// request/response TYPE verbatim (`IExtractBody`, `IExtractSyncResponse`) —
-// never redefined here. There is NO scope query param: unlike the
-// personal/org route's `?organization_id=`, an application caller's scope is
-// entirely its `:applicationId` URL segment, resolved server-side by
+// `FormData` + `Blob` multipart body as the personal client) and the
+// response TYPE verbatim (`IExtractSyncResponse`) — never redefined here.
+// The request body is `IExtractApplicationBody`, a narrower type than the
+// personal client's `IExtractBody`: it types exactly what this route accepts
+// (#581) — see extraction.request.ts. There is NO scope query param: unlike
+// the personal/org route's `?organization_id=`, an application caller's scope
+// is entirely its `:applicationId` URL segment, resolved server-side by
 // ApplicationMiddleware (round-trips to abyss-main).
 //
 // `authHeaderApplication` is kept LOCAL and unexported, same convention as the
@@ -23,7 +25,7 @@
 // ──────────────────────────────────────────────
 
 import { AbyssToolsCore, API_KEY_APPLICATION_HEADER } from '..';
-import type { IExtractBody } from '../types';
+import type { IExtractApplicationBody } from '../types';
 import type { IExtractSyncResponse } from '../types';
 import { buildExtractMultipart, ExtractCallOptions } from './extraction.api';
 
@@ -38,18 +40,16 @@ function authHeaderApplication(applicationApiKey?: string): Record<string, strin
  * `body.pdf`, with `body.mode` `auto` or `hint`; `body.plan` (inline, single
  * pass, no OCR, no template pass) and `body.improvementConsent` travel as
  * multipart fields. The route refuses `storage_file_id`, `plan_preset_id`,
- * `template_id` and `template` with a 4xx. A body without `pdf` is sent as
- * JSON and never runs an extraction: the memory watchdog may answer 503 before
- * the route reads the body; past it, the route answers a 4xx — the
- * `storage_file_id` refusal when the body carries one, otherwise "Provide file
- * (multipart pdf)". `options` forwards a Stripe-style
+ * `template_id` and `template` with a 4xx, and any body without `pdf` answers
+ * "Provide file (multipart pdf)" — the memory watchdog may also answer 503
+ * before the route reads the body. `options` forwards a Stripe-style
  * `Idempotency-Key` header (24h replay window) when set — replayed only for
  * the IDENTICAL request; the same key sent with another document or another
  * body answers 422 `IDEMPOTENCY_KEY_REUSED` (see `ExtractCallOptions`).
  */
 export const runExtractionApplication = async (
   applicationId: string,
-  body: IExtractBody,
+  body: IExtractApplicationBody,
   options: ExtractCallOptions = {},
   applicationApiKey?: string,
 ): Promise<IExtractSyncResponse> => {
@@ -59,23 +59,12 @@ export const runExtractionApplication = async (
   }
   const url = `extract/application/${applicationId}/extract`;
 
-  if (body.pdf) {
-    const form = buildExtractMultipart(body);
-    return (
-      await AbyssToolsCore.axios.post<IExtractSyncResponse>(url, form, {
-        headers: { ...authHeaderApplication(applicationApiKey), ...extraHeaders },
-        maxBodyLength: Infinity,
-        maxContentLength: Infinity,
-      })
-    ).data;
-  }
-
-  // Strip `pdf` from the JSON body (only used for the multipart upload above).
-  const jsonBody: Omit<IExtractBody, 'pdf'> = { ...body };
-  delete (jsonBody as { pdf?: unknown }).pdf;
+  const form = buildExtractMultipart(body);
   return (
-    await AbyssToolsCore.axios.post<IExtractSyncResponse>(url, jsonBody, {
+    await AbyssToolsCore.axios.post<IExtractSyncResponse>(url, form, {
       headers: { ...authHeaderApplication(applicationApiKey), ...extraHeaders },
+      maxBodyLength: Infinity,
+      maxContentLength: Infinity,
     })
   ).data;
 };

package/src/types/interface/api/requests/extraction.request.ts

@@ -71,6 +71,28 @@ export interface IExtractBody {
   plan_preset_id?: string;
 }
 
+/**
+ * Body of `POST /extract/application/:applicationId/extract` — exactly what
+ * that route accepts (extraction-extract-application.controller.ts): a
+ * multipart PDF, mode `auto` or `hint`, and the optional fields below. The
+ * route refuses storage_file_id, template_id, template, mode `template`,
+ * plan_preset_id and any body without a PDF (4xx), and is synchronous only,
+ * so none of those are expressible here (#581).
+ */
+export interface IExtractApplicationBody {
+  pdf: Buffer | Uint8Array;
+  mode: Exclude<ExtractionMode, 'template'>;
+  hint?: IExtractionBankHint;
+  pdf_filename?: string;
+  user_external_id?: string;
+  user_metadata?: Record<string, unknown>;
+  archive?: boolean;
+  force?: boolean;
+  improvementConsent?: boolean;
+  /** Inline plan: single pass, no OCR provider, no template pass (checked server-side). */
+  plan?: IExtractionPlan;
+}
+
 export interface IExtractBulkBody {
   items: Array<{
     storage_file_id?: string;