@abyss-project/tools 2.17.0 → 2.18.0

package/dist/constants/extract.constants.d.ts

@@ -0,0 +1,4 @@
+import { DocumentType } from '../types/enum/document-type.enum';
+import { ExtractFieldFormat } from '../types/enum/extract-field-format.enum';
+import { ExtractFieldKey } from '../types/enum/extract-field-key.enum';
+export declare const EXTRACT_PUBLISHABLE_FIELDS: Readonly<Record<Exclude<DocumentType, DocumentType.GENERIC>, Readonly<Partial<Record<ExtractFieldKey, ExtractFieldFormat>>>>>;

package/dist/constants/extract.constants.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXTRACT_PUBLISHABLE_FIELDS = void 0;
+const document_type_enum_1 = require("../types/enum/document-type.enum");
+const extract_field_format_enum_1 = require("../types/enum/extract-field-format.enum");
+const extract_field_key_enum_1 = require("../types/enum/extract-field-key.enum");
+const { AMOUNT, DATE, PERCENT, BOOLEAN, TEXT } = extract_field_format_enum_1.ExtractFieldFormat;
+exports.EXTRACT_PUBLISHABLE_FIELDS = Object.freeze({
+    [document_type_enum_1.DocumentType.BANK_STATEMENT]: Object.freeze({
+        [extract_field_key_enum_1.ExtractFieldKey.IBAN]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.BIC]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.BANK_NAME]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.OPENING_BALANCE]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.CLOSING_BALANCE]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.PERIOD_START]: DATE,
+        [extract_field_key_enum_1.ExtractFieldKey.PERIOD_END]: DATE,
+        [extract_field_key_enum_1.ExtractFieldKey.CURRENCY]: TEXT,
+    }),
+    [document_type_enum_1.DocumentType.INVOICE]: Object.freeze({
+        [extract_field_key_enum_1.ExtractFieldKey.TOTAL_TTC]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.TOTAL_HT]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.TOTAL_VAT]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.INVOICE_DATE]: DATE,
+        [extract_field_key_enum_1.ExtractFieldKey.DUE_DATE]: DATE,
+        [extract_field_key_enum_1.ExtractFieldKey.INVOICE_NUMBER]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.SUPPLIER]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.SUPPLIER_LEGAL_NAME]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.MARKETPLACE]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.SIRET]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.SIREN]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.VAT_NUMBER]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.IBAN]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.BIC]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.CURRENCY]: TEXT,
+    }),
+    [document_type_enum_1.DocumentType.RECEIPT]: Object.freeze({
+        [extract_field_key_enum_1.ExtractFieldKey.TOTAL]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.VAT]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.DATE]: DATE,
+        [extract_field_key_enum_1.ExtractFieldKey.MERCHANT]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.CURRENCY]: TEXT,
+    }),
+    [document_type_enum_1.DocumentType.ID_CARD]: Object.freeze({
+        [extract_field_key_enum_1.ExtractFieldKey.LAST_NAME]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.FIRST_NAMES]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.BIRTH_DATE]: DATE,
+        [extract_field_key_enum_1.ExtractFieldKey.EXPIRY_DATE]: DATE,
+        [extract_field_key_enum_1.ExtractFieldKey.ISSUE_DATE]: DATE,
+        [extract_field_key_enum_1.ExtractFieldKey.DOCUMENT_NUMBER]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.SEX]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.NATIONALITY]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.ISSUING_COUNTRY]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.DOCUMENT_KIND]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.MRZ_VALID]: BOOLEAN,
+    }),
+    [document_type_enum_1.DocumentType.RIB]: Object.freeze({
+        [extract_field_key_enum_1.ExtractFieldKey.IBAN]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.BIC]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.HOLDER_NAME]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.BANK_NAME]: TEXT,
+    }),
+    [document_type_enum_1.DocumentType.FINANCIAL_STATEMENT]: Object.freeze({
+        [extract_field_key_enum_1.ExtractFieldKey.COMPANY]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.SIREN]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.REGISTRATION_NUMBER]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.FISCAL_YEAR_END]: DATE,
+        [extract_field_key_enum_1.ExtractFieldKey.TOTAL_ACTIF]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.TOTAL_PASSIF]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.FIXED_ASSETS]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.CURRENT_ASSETS]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.CREDITORS_WITHIN_ONE_YEAR]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.NET_CURRENT_LIABILITIES]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.TOTAL_ASSETS_LESS_CURRENT_LIABILITIES]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.NET_ASSETS]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.CALLED_UP_SHARE_CAPITAL]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.PROFIT_AND_LOSS_ACCOUNT]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.TOTAL_SHAREHOLDERS_FUNDS]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.CURRENCY]: TEXT,
+    }),
+    [document_type_enum_1.DocumentType.PAYSLIP]: Object.freeze({
+        [extract_field_key_enum_1.ExtractFieldKey.EMPLOYER]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.PERIOD]: TEXT,
+        [extract_field_key_enum_1.ExtractFieldKey.GROSS_CENTS]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.NET_CENTS]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.NET_TAXABLE_CENTS]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.PAS_AMOUNT_CENTS]: AMOUNT,
+        [extract_field_key_enum_1.ExtractFieldKey.PAS_RATE_PCT]: PERCENT,
+        [extract_field_key_enum_1.ExtractFieldKey.CURRENCY]: TEXT,
+    }),
+});
+//# sourceMappingURL=extract.constants.js.map

package/dist/constants/extract.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract.constants.js","sourceRoot":"","sources":["../../src/constants/extract.constants.ts"],"names":[],"mappings":";;;AAAA,yEAAgE;AAChE,uFAA6E;AAC7E,iFAAuE;AAEvE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,8CAAkB,CAAC;AAiBvD,QAAA,0BAA0B,GAKnC,MAAM,CAAC,MAAM,CAAC;IAChB,CAAC,iCAAY,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC3C,CAAC,wCAAe,CAAC,IAAI,CAAC,EAAE,IAAI;QAC5B,CAAC,wCAAe,CAAC,GAAG,CAAC,EAAE,IAAI;QAC3B,CAAC,wCAAe,CAAC,SAAS,CAAC,EAAE,IAAI;QACjC,CAAC,wCAAe,CAAC,eAAe,CAAC,EAAE,MAAM;QACzC,CAAC,wCAAe,CAAC,eAAe,CAAC,EAAE,MAAM;QACzC,CAAC,wCAAe,CAAC,YAAY,CAAC,EAAE,IAAI;QACpC,CAAC,wCAAe,CAAC,UAAU,CAAC,EAAE,IAAI;QAClC,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,IAAI;KACjC,CAAC;IACF,CAAC,iCAAY,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACpC,CAAC,wCAAe,CAAC,SAAS,CAAC,EAAE,MAAM;QACnC,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,MAAM;QAClC,CAAC,wCAAe,CAAC,SAAS,CAAC,EAAE,MAAM;QACnC,CAAC,wCAAe,CAAC,YAAY,CAAC,EAAE,IAAI;QACpC,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,IAAI;QAChC,CAAC,wCAAe,CAAC,cAAc,CAAC,EAAE,IAAI;QACtC,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,IAAI;QAChC,CAAC,wCAAe,CAAC,mBAAmB,CAAC,EAAE,IAAI;QAC3C,CAAC,wCAAe,CAAC,WAAW,CAAC,EAAE,IAAI;QACnC,CAAC,wCAAe,CAAC,KAAK,CAAC,EAAE,IAAI;QAC7B,CAAC,wCAAe,CAAC,KAAK,CAAC,EAAE,IAAI;QAC7B,CAAC,wCAAe,CAAC,UAAU,CAAC,EAAE,IAAI;QAClC,CAAC,wCAAe,CAAC,IAAI,CAAC,EAAE,IAAI;QAC5B,CAAC,wCAAe,CAAC,GAAG,CAAC,EAAE,IAAI;QAC3B,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,IAAI;KACjC,CAAC;IACF,CAAC,iCAAY,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACpC,CAAC,wCAAe,CAAC,KAAK,CAAC,EAAE,MAAM;QAC/B,CAAC,wCAAe,CAAC,GAAG,CAAC,EAAE,MAAM;QAC7B,CAAC,wCAAe,CAAC,IAAI,CAAC,EAAE,IAAI;QAC5B,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,IAAI;QAChC,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,IAAI;KACjC,CAAC;IACF,CAAC,iCAAY,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACpC,CAAC,wCAAe,CAAC,SAAS,CAAC,EAAE,IAAI;QACjC,CAAC,wCAAe,CAAC,WAAW,CAAC,EAAE,IAAI;QACnC,CAAC,wCAAe,CAAC,UAAU,CAAC,EAAE,IAAI;QAClC,CAAC,wCAAe,CAAC,WAAW,CAAC,EAAE,IAAI;QACnC,CAAC,wCAAe,CAAC,UAAU,CAAC,EAAE,IAAI;QAClC,CAAC,wCAAe,CAAC,eAAe,CAAC,EAAE,IAAI;QACvC,CAAC,wCAAe,CAAC,GAAG,CAAC,EAAE,IAAI;QAC3B,CAAC,wCAAe,CAAC,WAAW,CAAC,EAAE,IAAI;QACnC,CAAC,wCAAe,CAAC,eAAe,CAAC,EAAE,IAAI;QACvC,CAAC,wCAAe,CAAC,aAAa,CAAC,EAAE,IAAI;QACrC,CAAC,wCAAe,CAAC,SAAS,CAAC,EAAE,OAAO;KACrC,CAAC;IACF,CAAC,iCAAY,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAChC,CAAC,wCAAe,CAAC,IAAI,CAAC,EAAE,IAAI;QAC5B,CAAC,wCAAe,CAAC,GAAG,CAAC,EAAE,IAAI;QAC3B,CAAC,wCAAe,CAAC,WAAW,CAAC,EAAE,IAAI;QACnC,CAAC,wCAAe,CAAC,SAAS,CAAC,EAAE,IAAI;KAClC,CAAC;IACF,CAAC,iCAAY,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAChD,CAAC,wCAAe,CAAC,OAAO,CAAC,EAAE,IAAI;QAC/B,CAAC,wCAAe,CAAC,KAAK,CAAC,EAAE,IAAI;QAC7B,CAAC,wCAAe,CAAC,mBAAmB,CAAC,EAAE,IAAI;QAC3C,CAAC,wCAAe,CAAC,eAAe,CAAC,EAAE,IAAI;QACvC,CAAC,wCAAe,CAAC,WAAW,CAAC,EAAE,MAAM;QACrC,CAAC,wCAAe,CAAC,YAAY,CAAC,EAAE,MAAM;QACtC,CAAC,wCAAe,CAAC,YAAY,CAAC,EAAE,MAAM;QACtC,CAAC,wCAAe,CAAC,cAAc,CAAC,EAAE,MAAM;QACxC,CAAC,wCAAe,CAAC,yBAAyB,CAAC,EAAE,MAAM;QACnD,CAAC,wCAAe,CAAC,uBAAuB,CAAC,EAAE,MAAM;QACjD,CAAC,wCAAe,CAAC,qCAAqC,CAAC,EAAE,MAAM;QAC/D,CAAC,wCAAe,CAAC,UAAU,CAAC,EAAE,MAAM;QACpC,CAAC,wCAAe,CAAC,uBAAuB,CAAC,EAAE,MAAM;QACjD,CAAC,wCAAe,CAAC,uBAAuB,CAAC,EAAE,MAAM;QACjD,CAAC,wCAAe,CAAC,wBAAwB,CAAC,EAAE,MAAM;QAClD,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,IAAI;KACjC,CAAC;IACF,CAAC,iCAAY,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACpC,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,IAAI;QAChC,CAAC,wCAAe,CAAC,MAAM,CAAC,EAAE,IAAI;QAC9B,CAAC,wCAAe,CAAC,WAAW,CAAC,EAAE,MAAM;QACrC,CAAC,wCAAe,CAAC,SAAS,CAAC,EAAE,MAAM;QACnC,CAAC,wCAAe,CAAC,iBAAiB,CAAC,EAAE,MAAM;QAC3C,CAAC,wCAAe,CAAC,gBAAgB,CAAC,EAAE,MAAM;QAC1C,CAAC,wCAAe,CAAC,YAAY,CAAC,EAAE,OAAO;QACvC,CAAC,wCAAe,CAAC,QAAQ,CAAC,EAAE,IAAI;KACjC,CAAC;CACH,CAAC,CAAC"}

package/dist/constants/index.d.ts

@@ -3,3 +3,4 @@ export * from './board.constants';
 export * from './short-link.constants';
 export * from './tag.constants';
 export * from './beam.constants';
+export * from './extract.constants';

package/dist/constants/index.js

@@ -19,4 +19,5 @@ __exportStar(require("./board.constants"), exports);
 __exportStar(require("./short-link.constants"), exports);
 __exportStar(require("./tag.constants"), exports);
 __exportStar(require("./beam.constants"), exports);
+__exportStar(require("./extract.constants"), exports);
 //# sourceMappingURL=index.js.map

package/dist/constants/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,oDAAkC;AAClC,yDAAuC;AACvC,kDAAgC;AAChC,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,oDAAkC;AAClC,yDAAuC;AACvC,kDAAgC;AAChC,mDAAiC;AACjC,sDAAoC"}

package/dist/types/enum/extract-field-format.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum ExtractFieldFormat {
+    AMOUNT = "amount",
+    DATE = "date",
+    PERCENT = "percent",
+    BOOLEAN = "boolean",
+    TEXT = "text"
+}

package/dist/types/enum/extract-field-format.enum.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractFieldFormat = void 0;
+var ExtractFieldFormat;
+(function (ExtractFieldFormat) {
+    ExtractFieldFormat["AMOUNT"] = "amount";
+    ExtractFieldFormat["DATE"] = "date";
+    ExtractFieldFormat["PERCENT"] = "percent";
+    ExtractFieldFormat["BOOLEAN"] = "boolean";
+    ExtractFieldFormat["TEXT"] = "text";
+})(ExtractFieldFormat || (exports.ExtractFieldFormat = ExtractFieldFormat = {}));
+//# sourceMappingURL=extract-field-format.enum.js.map

package/dist/types/enum/extract-field-format.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-field-format.enum.js","sourceRoot":"","sources":["../../../src/types/enum/extract-field-format.enum.ts"],"names":[],"mappings":";;;AAKA,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAE5B,uCAAiB,CAAA;IAEjB,mCAAa,CAAA;IAEb,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IAEnB,mCAAa,CAAA;AACf,CAAC,EAVW,kBAAkB,kCAAlB,kBAAkB,QAU7B"}

package/dist/types/enum/extract-field-key.enum.d.ts

@@ -0,0 +1,59 @@
+export declare enum ExtractFieldKey {
+    TOTAL_TTC = "totalTtc",
+    TOTAL_HT = "totalHt",
+    TOTAL_VAT = "totalVat",
+    TOTAL = "total",
+    VAT = "vat",
+    OPENING_BALANCE = "openingBalance",
+    CLOSING_BALANCE = "closingBalance",
+    TOTAL_ACTIF = "totalActif",
+    TOTAL_PASSIF = "totalPassif",
+    FIXED_ASSETS = "fixedAssets",
+    CURRENT_ASSETS = "currentAssets",
+    CREDITORS_WITHIN_ONE_YEAR = "creditorsWithinOneYear",
+    NET_CURRENT_LIABILITIES = "netCurrentLiabilities",
+    TOTAL_ASSETS_LESS_CURRENT_LIABILITIES = "totalAssetsLessCurrentLiabilities",
+    NET_ASSETS = "netAssets",
+    CALLED_UP_SHARE_CAPITAL = "calledUpShareCapital",
+    PROFIT_AND_LOSS_ACCOUNT = "profitAndLossAccount",
+    TOTAL_SHAREHOLDERS_FUNDS = "totalShareholdersFunds",
+    NET_CENTS = "netCents",
+    GROSS_CENTS = "grossCents",
+    NET_TAXABLE_CENTS = "netTaxableCents",
+    PAS_AMOUNT_CENTS = "pasAmountCents",
+    INVOICE_DATE = "invoiceDate",
+    DUE_DATE = "dueDate",
+    DATE = "date",
+    PERIOD_START = "periodStart",
+    PERIOD_END = "periodEnd",
+    FISCAL_YEAR_END = "fiscalYearEnd",
+    BIRTH_DATE = "birthDate",
+    EXPIRY_DATE = "expiryDate",
+    ISSUE_DATE = "issueDate",
+    PAS_RATE_PCT = "pasRatePct",
+    IBAN = "iban",
+    BIC = "bic",
+    SIRET = "siret",
+    SIREN = "siren",
+    VAT_NUMBER = "vatNumber",
+    INVOICE_NUMBER = "invoiceNumber",
+    DOCUMENT_NUMBER = "documentNumber",
+    REGISTRATION_NUMBER = "registrationNumber",
+    SUPPLIER = "supplier",
+    SUPPLIER_LEGAL_NAME = "supplierLegalName",
+    MARKETPLACE = "marketplace",
+    MERCHANT = "merchant",
+    HOLDER_NAME = "holderName",
+    BANK_NAME = "bankName",
+    COMPANY = "company",
+    EMPLOYER = "employer",
+    LAST_NAME = "lastName",
+    FIRST_NAMES = "firstNames",
+    NATIONALITY = "nationality",
+    CURRENCY = "currency",
+    PERIOD = "period",
+    SEX = "sex",
+    ISSUING_COUNTRY = "issuingCountry",
+    DOCUMENT_KIND = "documentKind",
+    MRZ_VALID = "mrzValid"
+}

package/dist/types/enum/extract-field-key.enum.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractFieldKey = void 0;
+var ExtractFieldKey;
+(function (ExtractFieldKey) {
+    ExtractFieldKey["TOTAL_TTC"] = "totalTtc";
+    ExtractFieldKey["TOTAL_HT"] = "totalHt";
+    ExtractFieldKey["TOTAL_VAT"] = "totalVat";
+    ExtractFieldKey["TOTAL"] = "total";
+    ExtractFieldKey["VAT"] = "vat";
+    ExtractFieldKey["OPENING_BALANCE"] = "openingBalance";
+    ExtractFieldKey["CLOSING_BALANCE"] = "closingBalance";
+    ExtractFieldKey["TOTAL_ACTIF"] = "totalActif";
+    ExtractFieldKey["TOTAL_PASSIF"] = "totalPassif";
+    ExtractFieldKey["FIXED_ASSETS"] = "fixedAssets";
+    ExtractFieldKey["CURRENT_ASSETS"] = "currentAssets";
+    ExtractFieldKey["CREDITORS_WITHIN_ONE_YEAR"] = "creditorsWithinOneYear";
+    ExtractFieldKey["NET_CURRENT_LIABILITIES"] = "netCurrentLiabilities";
+    ExtractFieldKey["TOTAL_ASSETS_LESS_CURRENT_LIABILITIES"] = "totalAssetsLessCurrentLiabilities";
+    ExtractFieldKey["NET_ASSETS"] = "netAssets";
+    ExtractFieldKey["CALLED_UP_SHARE_CAPITAL"] = "calledUpShareCapital";
+    ExtractFieldKey["PROFIT_AND_LOSS_ACCOUNT"] = "profitAndLossAccount";
+    ExtractFieldKey["TOTAL_SHAREHOLDERS_FUNDS"] = "totalShareholdersFunds";
+    ExtractFieldKey["NET_CENTS"] = "netCents";
+    ExtractFieldKey["GROSS_CENTS"] = "grossCents";
+    ExtractFieldKey["NET_TAXABLE_CENTS"] = "netTaxableCents";
+    ExtractFieldKey["PAS_AMOUNT_CENTS"] = "pasAmountCents";
+    ExtractFieldKey["INVOICE_DATE"] = "invoiceDate";
+    ExtractFieldKey["DUE_DATE"] = "dueDate";
+    ExtractFieldKey["DATE"] = "date";
+    ExtractFieldKey["PERIOD_START"] = "periodStart";
+    ExtractFieldKey["PERIOD_END"] = "periodEnd";
+    ExtractFieldKey["FISCAL_YEAR_END"] = "fiscalYearEnd";
+    ExtractFieldKey["BIRTH_DATE"] = "birthDate";
+    ExtractFieldKey["EXPIRY_DATE"] = "expiryDate";
+    ExtractFieldKey["ISSUE_DATE"] = "issueDate";
+    ExtractFieldKey["PAS_RATE_PCT"] = "pasRatePct";
+    ExtractFieldKey["IBAN"] = "iban";
+    ExtractFieldKey["BIC"] = "bic";
+    ExtractFieldKey["SIRET"] = "siret";
+    ExtractFieldKey["SIREN"] = "siren";
+    ExtractFieldKey["VAT_NUMBER"] = "vatNumber";
+    ExtractFieldKey["INVOICE_NUMBER"] = "invoiceNumber";
+    ExtractFieldKey["DOCUMENT_NUMBER"] = "documentNumber";
+    ExtractFieldKey["REGISTRATION_NUMBER"] = "registrationNumber";
+    ExtractFieldKey["SUPPLIER"] = "supplier";
+    ExtractFieldKey["SUPPLIER_LEGAL_NAME"] = "supplierLegalName";
+    ExtractFieldKey["MARKETPLACE"] = "marketplace";
+    ExtractFieldKey["MERCHANT"] = "merchant";
+    ExtractFieldKey["HOLDER_NAME"] = "holderName";
+    ExtractFieldKey["BANK_NAME"] = "bankName";
+    ExtractFieldKey["COMPANY"] = "company";
+    ExtractFieldKey["EMPLOYER"] = "employer";
+    ExtractFieldKey["LAST_NAME"] = "lastName";
+    ExtractFieldKey["FIRST_NAMES"] = "firstNames";
+    ExtractFieldKey["NATIONALITY"] = "nationality";
+    ExtractFieldKey["CURRENCY"] = "currency";
+    ExtractFieldKey["PERIOD"] = "period";
+    ExtractFieldKey["SEX"] = "sex";
+    ExtractFieldKey["ISSUING_COUNTRY"] = "issuingCountry";
+    ExtractFieldKey["DOCUMENT_KIND"] = "documentKind";
+    ExtractFieldKey["MRZ_VALID"] = "mrzValid";
+})(ExtractFieldKey || (exports.ExtractFieldKey = ExtractFieldKey = {}));
+//# sourceMappingURL=extract-field-key.enum.js.map

package/dist/types/enum/extract-field-key.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-field-key.enum.js","sourceRoot":"","sources":["../../../src/types/enum/extract-field-key.enum.ts"],"names":[],"mappings":";;;AASA,IAAY,eAmEX;AAnED,WAAY,eAAe;IAEzB,yCAAsB,CAAA;IACtB,uCAAoB,CAAA;IACpB,yCAAsB,CAAA;IACtB,kCAAe,CAAA;IACf,8BAAW,CAAA;IACX,qDAAkC,CAAA;IAClC,qDAAkC,CAAA;IAClC,6CAA0B,CAAA;IAC1B,+CAA4B,CAAA;IAC5B,+CAA4B,CAAA;IAC5B,mDAAgC,CAAA;IAChC,uEAAoD,CAAA;IACpD,oEAAiD,CAAA;IACjD,8FAA2E,CAAA;IAC3E,2CAAwB,CAAA;IACxB,mEAAgD,CAAA;IAChD,mEAAgD,CAAA;IAChD,sEAAmD,CAAA;IACnD,yCAAsB,CAAA;IACtB,6CAA0B,CAAA;IAC1B,wDAAqC,CAAA;IACrC,sDAAmC,CAAA;IAEnC,+CAA4B,CAAA;IAC5B,uCAAoB,CAAA;IACpB,gCAAa,CAAA;IACb,+CAA4B,CAAA;IAC5B,2CAAwB,CAAA;IACxB,oDAAiC,CAAA;IACjC,2CAAwB,CAAA;IACxB,6CAA0B,CAAA;IAC1B,2CAAwB,CAAA;IAExB,8CAA2B,CAAA;IAE3B,gCAAa,CAAA;IACb,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,2CAAwB,CAAA;IACxB,mDAAgC,CAAA;IAChC,qDAAkC,CAAA;IAClC,6DAA0C,CAAA;IAE1C,wCAAqB,CAAA;IACrB,4DAAyC,CAAA;IACzC,8CAA2B,CAAA;IAC3B,wCAAqB,CAAA;IACrB,6CAA0B,CAAA;IAC1B,yCAAsB,CAAA;IACtB,sCAAmB,CAAA;IACnB,wCAAqB,CAAA;IACrB,yCAAsB,CAAA;IACtB,6CAA0B,CAAA;IAC1B,8CAA2B,CAAA;IAE3B,wCAAqB,CAAA;IAErB,oCAAiB,CAAA;IAEjB,8BAAW,CAAA;IACX,qDAAkC,CAAA;IAClC,iDAA8B,CAAA;IAE9B,yCAAsB,CAAA;AACxB,CAAC,EAnEW,eAAe,+BAAf,eAAe,QAmE1B"}

package/dist/types/enum/extraction-warning.enum.d.ts

@@ -5,5 +5,6 @@ export declare enum ExtractionWarningCode {
     BALANCE_MISMATCH = "balance_mismatch",
     ADAPTER_VALIDATION_ERROR = "adapter_validation_error",
     FIELD_BELOW_PUBLISH_FLOOR = "field_below_publish_floor",
-    FIELD_FORMAT_ONLY_DATE = "field_format_only_date"
+    FIELD_FORMAT_ONLY_DATE = "field_format_only_date",
+    FIELD_MRZ_OUT_OF_DOMAIN = "field_mrz_out_of_domain"
 }

package/dist/types/enum/extraction-warning.enum.js

@@ -10,5 +10,6 @@ var ExtractionWarningCode;
     ExtractionWarningCode["ADAPTER_VALIDATION_ERROR"] = "adapter_validation_error";
     ExtractionWarningCode["FIELD_BELOW_PUBLISH_FLOOR"] = "field_below_publish_floor";
     ExtractionWarningCode["FIELD_FORMAT_ONLY_DATE"] = "field_format_only_date";
+    ExtractionWarningCode["FIELD_MRZ_OUT_OF_DOMAIN"] = "field_mrz_out_of_domain";
 })(ExtractionWarningCode || (exports.ExtractionWarningCode = ExtractionWarningCode = {}));
 //# sourceMappingURL=extraction-warning.enum.js.map

package/dist/types/enum/extraction-warning.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"extraction-warning.enum.js","sourceRoot":"","sources":["../../../src/types/enum/extraction-warning.enum.ts"],"names":[],"mappings":";;;AAMA,IAAY,qBAiDX;AAjDD,WAAY,qBAAqB;IAC/B,kDAAyB,CAAA;IACzB,4CAAmB,CAAA;IACnB,oDAA2B,CAAA;IAC3B,8DAAqC,CAAA;IASrC,8EAAqD,CAAA;IAgBrD,gFAAuD,CAAA;IAmBvD,0EAAiD,CAAA;AACnD,CAAC,EAjDW,qBAAqB,qCAArB,qBAAqB,QAiDhC"}
+{"version":3,"file":"extraction-warning.enum.js","sourceRoot":"","sources":["../../../src/types/enum/extraction-warning.enum.ts"],"names":[],"mappings":";;;AAMA,IAAY,qBAuEX;AAvED,WAAY,qBAAqB;IAC/B,kDAAyB,CAAA;IACzB,4CAAmB,CAAA;IACnB,oDAA2B,CAAA;IAC3B,8DAAqC,CAAA;IASrC,8EAAqD,CAAA;IAgBrD,gFAAuD,CAAA;IAmBvD,0EAAiD,CAAA;IAsBjD,4EAAmD,CAAA;AACrD,CAAC,EAvEW,qBAAqB,qCAArB,qBAAqB,QAuEhC"}

package/dist/types/enum/index.d.ts

@@ -7,6 +7,8 @@ export * from './document-type.enum';
 export * from './pdf-operation.enum';
 export * from './rcb-bank.enum';
 export * from './extraction-warning.enum';
+export * from './extract-field-key.enum';
+export * from './extract-field-format.enum';
 export * from './extraction-feedback-issue-type.enum';
 export * from './provider-kind.enum';
 export * from './interpreter-kind.enum';

package/dist/types/enum/index.js

@@ -23,6 +23,8 @@ __exportStar(require("./document-type.enum"), exports);
 __exportStar(require("./pdf-operation.enum"), exports);
 __exportStar(require("./rcb-bank.enum"), exports);
 __exportStar(require("./extraction-warning.enum"), exports);
+__exportStar(require("./extract-field-key.enum"), exports);
+__exportStar(require("./extract-field-format.enum"), exports);
 __exportStar(require("./extraction-feedback-issue-type.enum"), exports);
 __exportStar(require("./provider-kind.enum"), exports);
 __exportStar(require("./interpreter-kind.enum"), exports);

package/dist/types/enum/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/enum/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,wDAAsC;AACtC,2DAAyC;AACzC,uDAAqC;AACrC,8CAA4B;AAC5B,uDAAqC;AACrC,uDAAqC;AACrC,kDAAgC;AAChC,4DAA0C;AAC1C,wEAAsD;AACtD,uDAAqC;AACrC,0DAAwC;AACxC,0DAAwC;AACxC,gEAA8C;AAC9C,oDAAkC;AAClC,0DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/enum/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,wDAAsC;AACtC,2DAAyC;AACzC,uDAAqC;AACrC,8CAA4B;AAC5B,uDAAqC;AACrC,uDAAqC;AACrC,kDAAgC;AAChC,4DAA0C;AAC1C,2DAAyC;AACzC,8DAA4C;AAC5C,wEAAsD;AACtD,uDAAqC;AACrC,0DAAwC;AACxC,0DAAwC;AACxC,gEAA8C;AAC9C,oDAAkC;AAClC,0DAAwC"}

package/dist/types/interface/models/extraction.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"extraction.dto.js","sourceRoot":"","sources":["../../../../src/types/interface/models/extraction.dto.ts"],"names":[],"mappings":";;;AAKA,yFAAoF;AA8G3E,sGA9GA,+CAAqB,OA8GA;AA7G9B,iHAAsG;AAW7F,4GAXA,iEAA2B,OAWA;AAsTpC,IAAY,sBAYX;AAZD,WAAY,sBAAsB;IAChC,qEAA2C,CAAA;IAC3C,+DAAqC,CAAA;IACrC,+EAAqD,CAAA;IACrD,uEAA6C,CAAA;IAC7C,6DAAmC,CAAA;IACnC,2DAAiC,CAAA;IACjC,6DAAmC,CAAA;IACnC,uEAA6C,CAAA;IAC7C,uDAA6B,CAAA;IAC7B,mEAAyC,CAAA;IACzC,6DAAmC,CAAA;AACrC,CAAC,EAZW,sBAAsB,sCAAtB,sBAAsB,QAYjC;AAEY,QAAA,yBAAyB,GACpC,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAuCxC,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACrC,4CAAa,CAAA;IACb,0CAAW,CAAA;AACb,CAAC,EAHW,2BAA2B,2CAA3B,2BAA2B,QAGtC"}
+{"version":3,"file":"extraction.dto.js","sourceRoot":"","sources":["../../../../src/types/interface/models/extraction.dto.ts"],"names":[],"mappings":";;;AAKA,yFAAoF;AA8G3E,sGA9GA,+CAAqB,OA8GA;AA7G9B,iHAAsG;AAW7F,4GAXA,iEAA2B,OAWA;AAuTpC,IAAY,sBAYX;AAZD,WAAY,sBAAsB;IAChC,qEAA2C,CAAA;IAC3C,+DAAqC,CAAA;IACrC,+EAAqD,CAAA;IACrD,uEAA6C,CAAA;IAC7C,6DAAmC,CAAA;IACnC,2DAAiC,CAAA;IACjC,6DAAmC,CAAA;IACnC,uEAA6C,CAAA;IAC7C,uDAA6B,CAAA;IAC7B,mEAAyC,CAAA;IACzC,6DAAmC,CAAA;AACrC,CAAC,EAZW,sBAAsB,sCAAtB,sBAAsB,QAYjC;AAEY,QAAA,yBAAyB,GACpC,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAuCxC,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACrC,4CAAa,CAAA;IACb,0CAAW,CAAA;AACb,CAAC,EAHW,2BAA2B,2CAA3B,2BAA2B,QAGtC"}

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "@abyss-project/tools",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Core package to interact with Abyss-Project Tools",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "engines": {
-    "node": ">=19.8"
-  },
   "repository": {
     "type": "git",
     "url": "https://gitlab.com/abyss-group"
@@ -14,6 +11,9 @@
   "keywords": [],
   "author": "scylla",
   "license": "ISC",
+  "engines": {
+    "node": ">=19.8"
+  },
   "dependencies": {
     "axios": "^1.6.0",
     "axios-retry": "^4.5.0",

package/src/constants/extract.constants.ts

@@ -0,0 +1,109 @@
+import { DocumentType } from '../types/enum/document-type.enum';
+import { ExtractFieldFormat } from '../types/enum/extract-field-format.enum';
+import { ExtractFieldKey } from '../types/enum/extract-field-key.enum';
+
+const { AMOUNT, DATE, PERCENT, BOOLEAN, TEXT } = ExtractFieldFormat;
+
+// ──────────────────────────────────────────────
+// EXTRACT_PUBLISHABLE_FIELDS — the fields the built-in algorithmic
+// interpreter of AbyssExtract can publish, per document type, with the format
+// of their value. A field listed here may be absent from a given result (not
+// found, or below its publish floor); a field not listed here is never
+// published for that type by that interpreter. A learned template
+// (spatial-template interpreter) publishes the keys its client defined, on any
+// type.
+//
+// One exception: a valid machine-readable zone publishes its fields and
+// `mrzValid` whatever the document type (listed here under `id_card` only).
+//
+// `generic` is absent: its fields are defined by the client. The extraction API
+// tests that this list equals what its engine serves, type by type.
+// ──────────────────────────────────────────────
+export const EXTRACT_PUBLISHABLE_FIELDS: Readonly<
+  Record<
+    Exclude<DocumentType, DocumentType.GENERIC>,
+    Readonly<Partial<Record<ExtractFieldKey, ExtractFieldFormat>>>
+  >
+> = Object.freeze({
+  [DocumentType.BANK_STATEMENT]: Object.freeze({
+    [ExtractFieldKey.IBAN]: TEXT,
+    [ExtractFieldKey.BIC]: TEXT,
+    [ExtractFieldKey.BANK_NAME]: TEXT,
+    [ExtractFieldKey.OPENING_BALANCE]: AMOUNT,
+    [ExtractFieldKey.CLOSING_BALANCE]: AMOUNT,
+    [ExtractFieldKey.PERIOD_START]: DATE,
+    [ExtractFieldKey.PERIOD_END]: DATE,
+    [ExtractFieldKey.CURRENCY]: TEXT,
+  }),
+  [DocumentType.INVOICE]: Object.freeze({
+    [ExtractFieldKey.TOTAL_TTC]: AMOUNT,
+    [ExtractFieldKey.TOTAL_HT]: AMOUNT,
+    [ExtractFieldKey.TOTAL_VAT]: AMOUNT,
+    [ExtractFieldKey.INVOICE_DATE]: DATE,
+    [ExtractFieldKey.DUE_DATE]: DATE,
+    [ExtractFieldKey.INVOICE_NUMBER]: TEXT,
+    [ExtractFieldKey.SUPPLIER]: TEXT,
+    [ExtractFieldKey.SUPPLIER_LEGAL_NAME]: TEXT,
+    [ExtractFieldKey.MARKETPLACE]: TEXT,
+    [ExtractFieldKey.SIRET]: TEXT,
+    [ExtractFieldKey.SIREN]: TEXT,
+    [ExtractFieldKey.VAT_NUMBER]: TEXT,
+    [ExtractFieldKey.IBAN]: TEXT,
+    [ExtractFieldKey.BIC]: TEXT,
+    [ExtractFieldKey.CURRENCY]: TEXT,
+  }),
+  [DocumentType.RECEIPT]: Object.freeze({
+    [ExtractFieldKey.TOTAL]: AMOUNT,
+    [ExtractFieldKey.VAT]: AMOUNT,
+    [ExtractFieldKey.DATE]: DATE,
+    [ExtractFieldKey.MERCHANT]: TEXT,
+    [ExtractFieldKey.CURRENCY]: TEXT,
+  }),
+  [DocumentType.ID_CARD]: Object.freeze({
+    [ExtractFieldKey.LAST_NAME]: TEXT,
+    [ExtractFieldKey.FIRST_NAMES]: TEXT,
+    [ExtractFieldKey.BIRTH_DATE]: DATE,
+    [ExtractFieldKey.EXPIRY_DATE]: DATE,
+    [ExtractFieldKey.ISSUE_DATE]: DATE,
+    [ExtractFieldKey.DOCUMENT_NUMBER]: TEXT,
+    [ExtractFieldKey.SEX]: TEXT,
+    [ExtractFieldKey.NATIONALITY]: TEXT,
+    [ExtractFieldKey.ISSUING_COUNTRY]: TEXT,
+    [ExtractFieldKey.DOCUMENT_KIND]: TEXT,
+    [ExtractFieldKey.MRZ_VALID]: BOOLEAN,
+  }),
+  [DocumentType.RIB]: Object.freeze({
+    [ExtractFieldKey.IBAN]: TEXT,
+    [ExtractFieldKey.BIC]: TEXT,
+    [ExtractFieldKey.HOLDER_NAME]: TEXT,
+    [ExtractFieldKey.BANK_NAME]: TEXT,
+  }),
+  [DocumentType.FINANCIAL_STATEMENT]: Object.freeze({
+    [ExtractFieldKey.COMPANY]: TEXT,
+    [ExtractFieldKey.SIREN]: TEXT,
+    [ExtractFieldKey.REGISTRATION_NUMBER]: TEXT,
+    [ExtractFieldKey.FISCAL_YEAR_END]: DATE,
+    [ExtractFieldKey.TOTAL_ACTIF]: AMOUNT,
+    [ExtractFieldKey.TOTAL_PASSIF]: AMOUNT,
+    [ExtractFieldKey.FIXED_ASSETS]: AMOUNT,
+    [ExtractFieldKey.CURRENT_ASSETS]: AMOUNT,
+    [ExtractFieldKey.CREDITORS_WITHIN_ONE_YEAR]: AMOUNT,
+    [ExtractFieldKey.NET_CURRENT_LIABILITIES]: AMOUNT,
+    [ExtractFieldKey.TOTAL_ASSETS_LESS_CURRENT_LIABILITIES]: AMOUNT,
+    [ExtractFieldKey.NET_ASSETS]: AMOUNT,
+    [ExtractFieldKey.CALLED_UP_SHARE_CAPITAL]: AMOUNT,
+    [ExtractFieldKey.PROFIT_AND_LOSS_ACCOUNT]: AMOUNT,
+    [ExtractFieldKey.TOTAL_SHAREHOLDERS_FUNDS]: AMOUNT,
+    [ExtractFieldKey.CURRENCY]: TEXT,
+  }),
+  [DocumentType.PAYSLIP]: Object.freeze({
+    [ExtractFieldKey.EMPLOYER]: TEXT,
+    [ExtractFieldKey.PERIOD]: TEXT,
+    [ExtractFieldKey.GROSS_CENTS]: AMOUNT,
+    [ExtractFieldKey.NET_CENTS]: AMOUNT,
+    [ExtractFieldKey.NET_TAXABLE_CENTS]: AMOUNT,
+    [ExtractFieldKey.PAS_AMOUNT_CENTS]: AMOUNT,
+    [ExtractFieldKey.PAS_RATE_PCT]: PERCENT,
+    [ExtractFieldKey.CURRENCY]: TEXT,
+  }),
+});

package/src/constants/index.ts

@@ -3,3 +3,4 @@ export * from './board.constants';
 export * from './short-link.constants';
 export * from './tag.constants';
 export * from './beam.constants';
+export * from './extract.constants';

package/src/types/enum/extract-field-format.enum.ts

@@ -0,0 +1,16 @@
+// ──────────────────────────────────────────────
+// ExtractFieldFormat — the shape of a published field value, so a client can
+// display it without knowing each key.
+// ──────────────────────────────────────────────
+
+export enum ExtractFieldFormat {
+  /** Integer amount in cents; the currency is the `currency` field. */
+  AMOUNT = 'amount',
+  /** ISO 8601 date (`YYYY-MM-DD`). */
+  DATE = 'date',
+  /** The percent itself: `9` for 9 %. */
+  PERCENT = 'percent',
+  BOOLEAN = 'boolean',
+  /** Free text or identifier (IBAN, SIRET, VAT number…), to display as is. */
+  TEXT = 'text',
+}

package/src/types/enum/extract-field-key.enum.ts

@@ -0,0 +1,77 @@
+// ──────────────────────────────────────────────
+// ExtractFieldKey — every field key AbyssExtract can publish for a known
+// document type (`generic` excluded: its fields are defined by the client).
+// The value is the key found in `fields` of an extraction result. Which type
+// publishes which key, and in which format: `EXTRACT_PUBLISHABLE_FIELDS`.
+// A valid machine-readable zone publishes its fields and `mrzValid` whatever
+// the document type.
+// ──────────────────────────────────────────────
+
+export enum ExtractFieldKey {
+  // Amounts
+  TOTAL_TTC = 'totalTtc',
+  TOTAL_HT = 'totalHt',
+  TOTAL_VAT = 'totalVat',
+  TOTAL = 'total',
+  VAT = 'vat',
+  OPENING_BALANCE = 'openingBalance',
+  CLOSING_BALANCE = 'closingBalance',
+  TOTAL_ACTIF = 'totalActif',
+  TOTAL_PASSIF = 'totalPassif',
+  FIXED_ASSETS = 'fixedAssets',
+  CURRENT_ASSETS = 'currentAssets',
+  CREDITORS_WITHIN_ONE_YEAR = 'creditorsWithinOneYear',
+  NET_CURRENT_LIABILITIES = 'netCurrentLiabilities',
+  TOTAL_ASSETS_LESS_CURRENT_LIABILITIES = 'totalAssetsLessCurrentLiabilities',
+  NET_ASSETS = 'netAssets',
+  CALLED_UP_SHARE_CAPITAL = 'calledUpShareCapital',
+  PROFIT_AND_LOSS_ACCOUNT = 'profitAndLossAccount',
+  TOTAL_SHAREHOLDERS_FUNDS = 'totalShareholdersFunds',
+  NET_CENTS = 'netCents',
+  GROSS_CENTS = 'grossCents',
+  NET_TAXABLE_CENTS = 'netTaxableCents',
+  PAS_AMOUNT_CENTS = 'pasAmountCents',
+  // Dates
+  INVOICE_DATE = 'invoiceDate',
+  DUE_DATE = 'dueDate',
+  DATE = 'date',
+  PERIOD_START = 'periodStart',
+  PERIOD_END = 'periodEnd',
+  FISCAL_YEAR_END = 'fiscalYearEnd',
+  BIRTH_DATE = 'birthDate',
+  EXPIRY_DATE = 'expiryDate',
+  ISSUE_DATE = 'issueDate',
+  // Percentages
+  PAS_RATE_PCT = 'pasRatePct',
+  // Identifiers
+  IBAN = 'iban',
+  BIC = 'bic',
+  SIRET = 'siret',
+  SIREN = 'siren',
+  VAT_NUMBER = 'vatNumber',
+  INVOICE_NUMBER = 'invoiceNumber',
+  DOCUMENT_NUMBER = 'documentNumber',
+  REGISTRATION_NUMBER = 'registrationNumber',
+  // Names and labels
+  SUPPLIER = 'supplier',
+  SUPPLIER_LEGAL_NAME = 'supplierLegalName',
+  MARKETPLACE = 'marketplace',
+  MERCHANT = 'merchant',
+  HOLDER_NAME = 'holderName',
+  BANK_NAME = 'bankName',
+  COMPANY = 'company',
+  EMPLOYER = 'employer',
+  LAST_NAME = 'lastName',
+  FIRST_NAMES = 'firstNames',
+  NATIONALITY = 'nationality',
+  /** ISO 4217 code of the published amounts. */
+  CURRENCY = 'currency',
+  /** Payslip period label: an ISO month (`2026-06`) or a day range (`2026-06-01..2026-06-30`). */
+  PERIOD = 'period',
+  // Machine-readable zone of an identity document
+  SEX = 'sex',
+  ISSUING_COUNTRY = 'issuingCountry',
+  DOCUMENT_KIND = 'documentKind',
+  /** Whether the check digits of the machine-readable zone are correct. */
+  MRZ_VALID = 'mrzValid',
+}

package/src/types/enum/extraction-warning.enum.ts

@@ -53,4 +53,26 @@ export enum ExtractionWarningCode {
    * is neither persisted nor returned to the client — only this warning is.
    */
   FIELD_FORMAT_ONLY_DATE = 'field_format_only_date',
+  /**
+   * A field of an identity document's machine-readable zone was read but NOT
+   * published, because its value lies outside the domain the zone allows
+   * (#614): a sex other than `M`, `F` or `X`, or a nationality or issuing
+   * state that is neither an ISO 3166-1 alpha-3 code nor one of the special
+   * codes of ICAO Doc 9303 part 3 (`D`, `UNO`, `XXA`, `RKS`…).
+   *
+   * These three fields are covered by no check digit, not even the composite
+   * one: a misread letter there leaves every key closing. The domain is the
+   * only check the zone itself offers for them, and a value that fails it is
+   * withheld rather than published at full confidence.
+   *
+   * This is deliberately its own code: the zone is valid and its other fields
+   * are published, so neither `FIELD_BELOW_PUBLISH_FLOOR` nor an
+   * `ADAPTER_VALIDATION_ERROR` of type `MRZ_INVALID` would tell the client why
+   * this one field is missing.
+   *
+   * `data.fieldKey` names the field. The value itself is never in the warning:
+   * it stays in internal traceability only (`suppressedFields`, reason
+   * `mrz_out_of_domain`), which is neither persisted nor returned to the client.
+   */
+  FIELD_MRZ_OUT_OF_DOMAIN = 'field_mrz_out_of_domain',
 }

package/src/types/enum/index.ts

@@ -7,6 +7,8 @@ export * from './document-type.enum';
 export * from './pdf-operation.enum';
 export * from './rcb-bank.enum';
 export * from './extraction-warning.enum';
+export * from './extract-field-key.enum';
+export * from './extract-field-format.enum';
 export * from './extraction-feedback-issue-type.enum';
 export * from './provider-kind.enum';
 export * from './interpreter-kind.enum';

package/src/types/interface/models/extraction.dto.ts

@@ -132,7 +132,8 @@ export interface IExtractionWarning {
     message?: string;
     /**
      * The withheld field's name. Present for the per-field withdrawal codes
-     * (`FIELD_BELOW_PUBLISH_FLOOR`, `FIELD_FORMAT_ONLY_DATE`, #575).
+     * (`FIELD_BELOW_PUBLISH_FLOOR`, `FIELD_FORMAT_ONLY_DATE` #575,
+     * `FIELD_MRZ_OUT_OF_DOMAIN` #614).
      */
     fieldKey?: string;
     /**
@@ -142,9 +143,9 @@ export interface IExtractionWarning {
     confidence?: number;
     /**
      * The publish floor the field missed. Present only for
-     * `FIELD_BELOW_PUBLISH_FLOOR` — a `FIELD_FORMAT_ONLY_DATE` withdrawal is
-     * not a floor comparison, and its confidence can sit above the field's
-     * floor.
+     * `FIELD_BELOW_PUBLISH_FLOOR` — neither a `FIELD_FORMAT_ONLY_DATE` nor a
+     * `FIELD_MRZ_OUT_OF_DOMAIN` withdrawal is a floor comparison, and their
+     * confidence can sit above the field's floor.
      */
     floor?: number;
   };