@abyss-project/tools 3.0.0 → 3.2.0

package/src/api/short-link.admin.api.ts

@@ -15,12 +15,17 @@ export const shortLinkAdminApi = {
   paginate: async (
     query: IPaginateShortLinkAdminQuery,
   ): Promise<IPaginateShortLinkAdminResponse> => {
-    const response = await AbyssToolsCore.axios.get<IPaginateShortLinkAdminResponse>('/admin/short-link/paginate', { params: query });
+    const response = await AbyssToolsCore.axios.get<IPaginateShortLinkAdminResponse>(
+      '/admin/short-link/paginate',
+      { params: query },
+    );
     return response.data;
   },
 
   get: async (params: IGetShortLinkAdminParams): Promise<IGetShortLinkAdminResponse> => {
-    const response = await AbyssToolsCore.axios.get<IGetShortLinkAdminResponse>(`/admin/short-link/${params.shortLinkId}`);
+    const response = await AbyssToolsCore.axios.get<IGetShortLinkAdminResponse>(
+      `/admin/short-link/${params.shortLinkId}`,
+    );
     return response.data;
   },
 
@@ -28,12 +33,17 @@ export const shortLinkAdminApi = {
     params: IUpdateShortLinkAdminParams,
     body: IUpdateShortLinkAdminBody,
   ): Promise<IUpdateShortLinkAdminResponse> => {
-    const response = await AbyssToolsCore.axios.put<IUpdateShortLinkAdminResponse>(`/admin/short-link/${params.shortLinkId}`, body);
+    const response = await AbyssToolsCore.axios.put<IUpdateShortLinkAdminResponse>(
+      `/admin/short-link/${params.shortLinkId}`,
+      body,
+    );
     return response.data;
   },
 
   delete: async (params: IDeleteShortLinkAdminParams): Promise<IDeleteShortLinkAdminResponse> => {
-    const response = await AbyssToolsCore.axios.delete<IDeleteShortLinkAdminResponse>(`/admin/short-link/${params.shortLinkId}`);
+    const response = await AbyssToolsCore.axios.delete<IDeleteShortLinkAdminResponse>(
+      `/admin/short-link/${params.shortLinkId}`,
+    );
     return response.data;
   },
 };

package/src/api/short-link.api.ts

@@ -27,12 +27,17 @@ import type {
 
 export const shortLinkApi = {
   get: async (params: IGetShortLinkParams): Promise<IGetShortLinkResponse> => {
-    const response = await AbyssToolsCore.axios.get<IGetShortLinkResponse>(`/short-link/${params.shortLinkId}`);
+    const response = await AbyssToolsCore.axios.get<IGetShortLinkResponse>(
+      `/short-link/${params.shortLinkId}`,
+    );
     return response.data;
   },
 
   paginate: async (query: IPaginateShortLinkQuery): Promise<IPaginateShortLinkResponse> => {
-    const response = await AbyssToolsCore.axios.get<IPaginateShortLinkResponse>('/short-link/paginate', { params: query });
+    const response = await AbyssToolsCore.axios.get<IPaginateShortLinkResponse>(
+      '/short-link/paginate',
+      { params: query },
+    );
     return response.data;
   },
 
@@ -40,9 +45,12 @@ export const shortLinkApi = {
     params: IPaginateProjectShortLinkParams,
     query: IPaginateShortLinkQuery,
   ): Promise<IPaginateShortLinkResponse> => {
-    const response = await AbyssToolsCore.axios.get<IPaginateShortLinkResponse>(`/short-link/project/${params.projectId}/paginate`, {
-      params: query,
-    });
+    const response = await AbyssToolsCore.axios.get<IPaginateShortLinkResponse>(
+      `/short-link/project/${params.projectId}/paginate`,
+      {
+        params: query,
+      },
+    );
     return response.data;
   },
 
@@ -55,7 +63,10 @@ export const shortLinkApi = {
     params: ICreateForOrganizationShortLinkParams,
     body: ICreateShortLinkBody,
   ): Promise<ICreateShortLinkResponse> => {
-    const response = await AbyssToolsCore.axios.post<ICreateShortLinkResponse>(`/short-link/organization/${params.organizationId}`, body);
+    const response = await AbyssToolsCore.axios.post<ICreateShortLinkResponse>(
+      `/short-link/organization/${params.organizationId}`,
+      body,
+    );
     return response.data;
   },
 
@@ -63,12 +74,17 @@ export const shortLinkApi = {
     params: IUpdateShortLinkParams,
     body: IUpdateShortLinkBody,
   ): Promise<IUpdateShortLinkResponse> => {
-    const response = await AbyssToolsCore.axios.put<IUpdateShortLinkResponse>(`/short-link/${params.shortLinkId}`, body);
+    const response = await AbyssToolsCore.axios.put<IUpdateShortLinkResponse>(
+      `/short-link/${params.shortLinkId}`,
+      body,
+    );
     return response.data;
   },
 
   delete: async (params: IDeleteShortLinkParams): Promise<IDeleteShortLinkResponse> => {
-    const response = await AbyssToolsCore.axios.delete<IDeleteShortLinkResponse>(`/short-link/${params.shortLinkId}`);
+    const response = await AbyssToolsCore.axios.delete<IDeleteShortLinkResponse>(
+      `/short-link/${params.shortLinkId}`,
+    );
     return response.data;
   },
 
@@ -76,9 +92,12 @@ export const shortLinkApi = {
     params: IGetStatsShortLinkParams,
     query?: IGetStatsShortLinkQuery,
   ): Promise<IGetStatsShortLinkResponse> => {
-    const response = await AbyssToolsCore.axios.get<IGetStatsShortLinkResponse>(`/short-link/${params.shortLinkId}/stats`, {
-      params: query,
-    });
+    const response = await AbyssToolsCore.axios.get<IGetStatsShortLinkResponse>(
+      `/short-link/${params.shortLinkId}/stats`,
+      {
+        params: query,
+      },
+    );
     return response.data;
   },
 
@@ -86,9 +105,12 @@ export const shortLinkApi = {
     params: IGetClicksShortLinkParams,
     query?: IGetClicksShortLinkQuery,
   ): Promise<IGetClicksShortLinkResponse> => {
-    const response = await AbyssToolsCore.axios.get<IGetClicksShortLinkResponse>(`/short-link/${params.shortLinkId}/clicks`, {
-      params: query,
-    });
+    const response = await AbyssToolsCore.axios.get<IGetClicksShortLinkResponse>(
+      `/short-link/${params.shortLinkId}/clicks`,
+      {
+        params: query,
+      },
+    );
     return response.data;
   },
 
@@ -114,9 +136,9 @@ export const shortLinkApi = {
     return response.data;
   },
 
-  countOrganization: async (
-    params: { organizationId: string },
-  ): Promise<ICountOrganizationResponse> => {
+  countOrganization: async (params: {
+    organizationId: string;
+  }): Promise<ICountOrganizationResponse> => {
     const response = await AbyssToolsCore.axios.get<ICountOrganizationResponse>(
       `/short-link/organization/${params.organizationId}/count`,
     );

package/src/api/short-link.public.api.ts

@@ -19,7 +19,10 @@ export const shortLinkPublicApi = {
   createAnonymous: async (
     body: ICreateAnonymousShortLinkPublicBody,
   ): Promise<ICreateShortLinkPublicResponse> => {
-    const response = await AbyssToolsCore.axios.post<ICreateShortLinkPublicResponse>('/short-link/public', body);
+    const response = await AbyssToolsCore.axios.post<ICreateShortLinkPublicResponse>(
+      '/short-link/public',
+      body,
+    );
     return response.data;
   },
 
@@ -27,9 +30,12 @@ export const shortLinkPublicApi = {
     params: IRedirectShortLinkPublicParams,
     query?: IRedirectShortLinkPublicQuery,
   ): Promise<IRedirectShortLinkPublicResponse> => {
-    const response = await AbyssToolsCore.axios.get<IRedirectShortLinkPublicResponse>(`/short-link/public/redirect/${params.slug}`, {
-      params: query,
-    });
+    const response = await AbyssToolsCore.axios.get<IRedirectShortLinkPublicResponse>(
+      `/short-link/public/redirect/${params.slug}`,
+      {
+        params: query,
+      },
+    );
     return response.data;
   },
 
@@ -37,9 +43,12 @@ export const shortLinkPublicApi = {
     params: IGetStatsShortLinkPublicParams,
     query?: IGetStatsShortLinkPublicQuery,
   ): Promise<IGetStatsShortLinkPublicResponse> => {
-    const response = await AbyssToolsCore.axios.get<IGetStatsShortLinkPublicResponse>(`/short-link/public/${params.shortLinkId}/stats`, {
-      params: query,
-    });
+    const response = await AbyssToolsCore.axios.get<IGetStatsShortLinkPublicResponse>(
+      `/short-link/public/${params.shortLinkId}/stats`,
+      {
+        params: query,
+      },
+    );
     return response.data;
   },
 
@@ -47,14 +56,19 @@ export const shortLinkPublicApi = {
     params: IGetClicksShortLinkPublicParams,
     query?: IGetClicksShortLinkPublicQuery,
   ): Promise<IGetClicksShortLinkPublicResponse> => {
-    const response = await AbyssToolsCore.axios.get<IGetClicksShortLinkPublicResponse>(`/short-link/public/${params.shortLinkId}/clicks`, {
-      params: query,
-    });
+    const response = await AbyssToolsCore.axios.get<IGetClicksShortLinkPublicResponse>(
+      `/short-link/public/${params.shortLinkId}/clicks`,
+      {
+        params: query,
+      },
+    );
     return response.data;
   },
 
   renew: async (params: IRenewShortLinkPublicParams): Promise<IRenewShortLinkPublicResponse> => {
-    const response = await AbyssToolsCore.axios.post<IRenewShortLinkPublicResponse>(`/short-link/public/${params.shortLinkId}/renew`);
+    const response = await AbyssToolsCore.axios.post<IRenewShortLinkPublicResponse>(
+      `/short-link/public/${params.shortLinkId}/renew`,
+    );
     return response.data;
   },
 };

package/src/api/tag.api.ts

@@ -63,7 +63,9 @@ export const getTagStats = async (query?: ITagStatsQuery): Promise<ITagStatsResp
   return (await AbyssToolsCore.axios.get<ITagStatsResponse>('tag/stats', { params: query })).data;
 };
 
-export const getEntityTags = async (params: IGetEntityTagsParams): Promise<IGetEntityTagsResponse> => {
+export const getEntityTags = async (
+  params: IGetEntityTagsParams,
+): Promise<IGetEntityTagsResponse> => {
   return (
     await AbyssToolsCore.axios.get<IGetEntityTagsResponse>(
       `${params.entityType}/${params.entityId}/tags`,

package/src/constants/atlas.constants.ts

@@ -1,2 +1,2 @@
 export const MAX_DOCUMENTS_PER_ATLAS_PAGE = 20;
-export const MAX_ATLAS_DOCUMENT_SIZE_OCTET = 20 * 1024 * 1024; // 20 MB
+export const MAX_ATLAS_DOCUMENT_SIZE_OCTET = 100 * 1024 * 1024; // 100 MB

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/index.ts

@@ -28,6 +28,7 @@ import * as metricsApi from './api/metrics.api';
 import * as organizationApi from './api/organization.api';
 import * as tagApi from './api/tag.api';
 import * as extractionApi from './api/extraction.api';
+import * as extractionApplicationApi from './api/extraction.application.api';
 import * as extractionSettingsApi from './api/extraction-settings.api';
 import * as extractionPlanPresetApi from './api/extraction-plan-preset.api';
 import * as monitorApi from './api/monitor.api';
@@ -254,6 +255,7 @@ type AbyssToolsCoreSDK = {
     getUploadPreSignedUrl: typeof atlasDocumentApi.getUploadPreSignedUrlAtlasDocument;
     paginate: typeof atlasDocumentApi.paginateAtlasDocument;
     list: typeof atlasDocumentApi.listAtlasDocument;
+    getPublicAccessId: typeof atlasDocumentApi.getPublicAccessIdAtlasDocument;
   };
   shortLink: {
     get: typeof shortLinkApiModule.shortLinkApi.get;
@@ -405,6 +407,19 @@ type AbyssToolsCoreSDK = {
     run: typeof extractionApi.extractSync;
     runQueue: typeof extractionApi.extractQueue;
     runBulk: typeof extractionApi.extractBulk;
+    /**
+     * Application/API-key-auth counterpart — for a backend satellite (e.g.
+     * AbyssBanking) triggering a SYNCHRONOUS extraction server-side with its
+     * APPLICATION api key: the run is OWNED by the application and BILLED to
+     * its resolved owning organization (never an end user). Hits
+     * `/extract/application/:applicationId/extract`, authenticated with the
+     * `abyss-api-key-application` header ({@link API_KEY_APPLICATION_HEADER})
+     * instead of the personal `abyss-api-key`. Does NOT change the personal `run`.
+     */
+    application: {
+      /** `POST /extract/application/:applicationId/extract` — synchronous; owned + billed to the app's org. */
+      run: typeof extractionApplicationApi.runExtractionApplication;
+    };
     files: {
       list: typeof extractionApi.listFiles;
       listShared: typeof extractionApi.listSharedFiles;
@@ -696,6 +711,7 @@ export class AbyssToolsCore {
         getUploadPreSignedUrl: atlasDocumentApi.getUploadPreSignedUrlAtlasDocument,
         paginate: atlasDocumentApi.paginateAtlasDocument,
         list: atlasDocumentApi.listAtlasDocument,
+        getPublicAccessId: atlasDocumentApi.getPublicAccessIdAtlasDocument,
       },
       shortLink: {
         get: shortLinkApiModule.shortLinkApi.get,
@@ -823,6 +839,9 @@ export class AbyssToolsCore {
         run: extractionApi.extractSync,
         runQueue: extractionApi.extractQueue,
         runBulk: extractionApi.extractBulk,
+        application: {
+          run: extractionApplicationApi.runExtractionApplication,
+        },
         files: {
           list: extractionApi.listFiles,
           listShared: extractionApi.listSharedFiles,

package/src/server-sent-events/server-sent-events.manager.ts

@@ -19,11 +19,13 @@ export class ServerSentEventsManager<
   T extends ServerSentEventBaseContext,
   P extends { type: string; payload: unknown },
 > {
-  private channel: string;
   private contexts: Map<string, Set<T>>;
 
-  constructor(channelName: string) {
-    this.channel = channelName;
+  // Le nom du canal est accepte pour ne rien casser chez les appelants, mais il
+  // n'est pas conserve : l'aiguillage se fait par la CLE de la table des
+  // gestionnaires (`AppConfig.sse[SSEChannels.X]`), jamais par un champ porte par
+  // le gestionnaire lui-meme. Le champ qui le stockait n'etait lu nulle part.
+  constructor(_channelName: string) {
     this.contexts = new Map();
   }
 

package/src/types/enum/document-type.enum.ts

@@ -6,5 +6,6 @@ export enum DocumentType {
   ID_CARD = 'id_card',
   RIB = 'rib',
   FINANCIAL_STATEMENT = 'financial_statement',
+  PAYSLIP = 'payslip',
   GENERIC = 'generic',
 }

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

@@ -18,4 +18,61 @@ export enum ExtractionWarningCode {
    * enum for each domain-specific rule.
    */
   ADAPTER_VALIDATION_ERROR = 'adapter_validation_error',
+  /**
+   * A field was extracted but NOT published, because its calibrated confidence
+   * fell below the publish floor for its (documentType, fieldKey).
+   *
+   * This is deliberately its own code rather than an `ADAPTER_VALIDATION_ERROR`
+   * carrying a `data.type`. Suppression is a first-class product behaviour a
+   * client must be able to detect reliably — «did the engine find nothing, or
+   * did it find something it judged not worth sending?» are two different
+   * questions, and a client should not have to parse a free-text field to tell
+   * them apart.
+   *
+   * `data.fieldKey` names the field, `data.confidence` its calibrated value and
+   * `data.floor` the threshold it missed. The value itself is never in the
+   * warning: it stays in `provenance`, flagged `suppressed`.
+   */
+  FIELD_BELOW_PUBLISH_FLOOR = 'field_below_publish_floor',
+  /**
+   * A date field was extracted but NOT published, because nothing besides its
+   * format supported it: no label next to it, and it did not sit in the page
+   * band the document type expects for that field (#575).
+   *
+   * This is deliberately its own code rather than folded into
+   * `FIELD_BELOW_PUBLISH_FLOOR`: the confidence can sit ABOVE the field's
+   * publish floor (corroboration alone can carry a format-only date from 0.42
+   * to 0.565) and still not be published — a client checking only the floor
+   * would see no reason for the field's absence. Suppression is a first-class
+   * product behaviour a client must be able to detect reliably, here as much
+   * as for a below-floor drop.
+   *
+   * `data.fieldKey` names the field, `data.confidence` its calibrated value.
+   * The value itself is never in the warning: it stays in internal
+   * traceability only (`suppressedFields`, reason `format_only_date`), which
+   * 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';