@streamline-pulse/formkrafter-core 0.28.0 → 0.29.0

package/dist/brick/brick.d.ts

@@ -15,6 +15,8 @@ export interface BrickProps<DataType, Configs extends BrickBaseConfigs, Styles>
     dataMap?: Record<string, unknown>;
     rootSpec?: BrickSpec;
     onDataChange?: (value?: DataType) => void;
+    /** Sets several form keys at once (a brick that fills other fields, e.g. from a document). */
+    onDataPatch?: (patch: Record<string, unknown>) => void;
     onMove?: (from: string, to: string) => void;
     onDuplicate?: (path: string) => void;
     onDelete?: (path: string) => void;

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export { FieldDescriptor, CollectFieldsOptions, collectFields } from "./utils/fi
 export { IdentityFormat, IDENTITY_FORMATS, checkIdentity, checkFrNir, checkBjNpi, checkDigits, checkLuhn, checkFrSiren, checkFrSiret, checkBjIfu, checkIban, formatIban } from "./utils/identity.js";
 export { MrzResult, parseMrz, mrzLines, mrzCheckDigit } from "./utils/mrz.js";
 export { Slot, SlotRules, generateSlots, readSlots, groupSlotsByDay, slotDate } from "./utils/slots.js";
+export { DocumentField, parseDocumentFields, parseDocumentFills, documentFillPatch } from "./utils/documents.js";
 export { FieldAnnotation, FieldAnnotations, flaggedKeys } from "./review.js";
 export { SpecIssue, SpecIssueCode, lintSpec } from "./utils/lint-spec.js";
 export { ensureBrickUids, stripBrickUids, stripUidsFromPatches } from "./ops/uids.js";
@@ -43,4 +44,5 @@ export type { ExpandSpecOptions } from "./utils/expand-spec.js";
 export { FetchSpecSourceService } from "./services/spec_source_service.js";
 export type { SpecSourceService, FetchSpecSourceDefaults } from "./services/spec_source_service.js";
 export { FetchOptionSourceService } from "./services/option_source_service.js";
+export { DocumentReading, DocumentReadOptions, DocumentReaderService, FetchDocumentReaderDefaults, FetchDocumentReaderService, readDocumentReading, } from "./services/document_reader_service.js";
 export type { OptionSourceService, FetchOptionSourceDefaults } from "./services/option_source_service.js";

package/dist/index.js

@@ -7309,6 +7309,26 @@ var en = {
   "slots.picked": "Chosen slot:",
   "range.from": "From",
   "range.to": "To",
+  "category.Documents": "Documents",
+  "brick.document.name": "Document reading",
+  "document.choose": "Choose a document…",
+  "document.capture": "Take a photo",
+  "document.reading": "Reading the document…",
+  "document.read": "Document read",
+  "document.none": "No document",
+  "document.text": "Text read",
+  "document.fields": "Fields read",
+  "document.notFound": "not found",
+  "document.remove": "Remove document",
+  "document.noReader": "No document reader configured",
+  "document.failed": "The document could not be read",
+  "document.filled": "Fields filled from the document:",
+  "panel.readUrl": "Reader URL (empty = host default)",
+  "panel.documentFields": "Fields to read (key|Label per line)",
+  "panel.documentFills": "Fill the form (field=formKey per line)",
+  "panel.documentLanguage": "Document language (fr, en…)",
+  "panel.cfg.capture": "Offer the camera on mobile",
+  "panel.cfg.keepFile": "Keep the file in the answer",
   "panel.slotsUrl": "Slots URL (empty = opening rules)",
   "panel.slotDays": "Open days (1 = Monday … 7 = Sunday)",
   "panel.slotFrom": "Opens at",
@@ -7514,6 +7534,26 @@ var frFkTranslations = {
   "slots.picked": "Créneau choisi :",
   "range.from": "Du",
   "range.to": "Au",
+  "category.Documents": "Documents",
+  "brick.document.name": "Lecture de document",
+  "document.choose": "Choisir un document…",
+  "document.capture": "Prendre une photo",
+  "document.reading": "Lecture du document…",
+  "document.read": "Document lu",
+  "document.none": "Aucun document",
+  "document.text": "Texte lu",
+  "document.fields": "Champs lus",
+  "document.notFound": "non trouvé",
+  "document.remove": "Retirer le document",
+  "document.noReader": "Aucun lecteur de document configuré",
+  "document.failed": "Le document n’a pas pu être lu",
+  "document.filled": "Champs remplis depuis le document :",
+  "panel.readUrl": "URL du lecteur (vide = celle de l’hôte)",
+  "panel.documentFields": "Champs à lire (clé|Libellé par ligne)",
+  "panel.documentFills": "Remplir le formulaire (champ=cléFormulaire par ligne)",
+  "panel.documentLanguage": "Langue du document (fr, en…)",
+  "panel.cfg.capture": "Proposer l’appareil photo sur mobile",
+  "panel.cfg.keepFile": "Conserver le fichier dans la réponse",
   "panel.slotsUrl": "URL des créneaux (vide = règles d’ouverture)",
   "panel.slotDays": "Jours ouverts (1 = lundi … 7 = dimanche)",
   "panel.slotFrom": "Ouverture",
@@ -8127,6 +8167,67 @@ class FetchOptionSourceService {
   }
 }
 
+// lib/services/document_reader_service.ts
+var asRecord = (value) => value && typeof value === "object" && !Array.isArray(value) ? value : undefined;
+function readDocumentReading(payload) {
+  const root = asRecord(payload) ?? {};
+  const data = asRecord(root.data) ?? root;
+  const text = typeof data.text === "string" ? data.text : typeof data.md_content === "string" ? data.md_content : typeof data.content === "string" ? data.content : undefined;
+  const reading = {};
+  if (text !== undefined)
+    reading.text = text;
+  const fields = asRecord(data.fields);
+  if (fields)
+    reading.fields = fields;
+  if (typeof data.pages === "number")
+    reading.pages = data.pages;
+  if (typeof data.engine === "string")
+    reading.engine = data.engine;
+  if (typeof data.confidence === "number")
+    reading.confidence = data.confidence;
+  if (Array.isArray(data.warnings))
+    reading.warnings = data.warnings.filter((w) => typeof w === "string");
+  return reading;
+}
+
+class FetchDocumentReaderService {
+  defaults;
+  constructor(defaults = {}) {
+    this.defaults = defaults;
+  }
+  async read(file, options = {}) {
+    const url = options.url || this.defaults.url;
+    if (!url)
+      throw new Error("No document reader URL configured");
+    const body = new FormData;
+    const blob = file instanceof Blob ? file : new Blob([await file.arrayBuffer()], { type: file.type });
+    body.append(this.defaults.fieldName ?? "file", blob, file.name);
+    if (options.fields?.length)
+      body.append("fields", options.fields.map((field) => field.key).join(","));
+    if (options.fields?.length)
+      body.append("fieldLabels", JSON.stringify(Object.fromEntries(options.fields.map((f) => [f.key, f.label ?? f.key]))));
+    if (options.language)
+      body.append("language", options.language);
+    const doFetch = this.defaults.fetch ?? globalThis.fetch.bind(globalThis);
+    const response = await doFetch(url, {
+      method: "POST",
+      body,
+      credentials: this.defaults.credentials,
+      headers: { accept: "application/json", ...this.defaults.headers, ...options.headers }
+    });
+    if (!response.ok) {
+      let message = `Document reading failed (${response.status})`;
+      try {
+        const payload = await response.json();
+        if (payload?.message)
+          message = payload.message;
+      } catch {}
+      throw new Error(message);
+    }
+    return readDocumentReading(await response.json());
+  }
+}
+
 // lib/services/index.ts
 var GLOBAL_KEY2 = Symbol.for("formkrafter.core.services");
 var globalStore2 = globalThis;
@@ -8135,10 +8236,12 @@ var services = globalStore2[GLOBAL_KEY2] ??= {
   dataSourceService: new FetchDataSourceService,
   fileUploadService: new Base64FileUploadService,
   specSourceService: new FetchSpecSourceService,
-  optionSourceService: new FetchOptionSourceService
+  optionSourceService: new FetchOptionSourceService,
+  documentReaderService: new FetchDocumentReaderService
 };
 services.specSourceService ??= new FetchSpecSourceService;
 services.optionSourceService ??= new FetchOptionSourceService;
+services.documentReaderService ??= new FetchDocumentReaderService;
 
 // lib/brick/utils.ts
 var evalBrickCode = (code, data) => {
@@ -8576,6 +8679,58 @@ function groupSlotsByDay(slots) {
   }
   return [...byDay.entries()].map(([day, list]) => ({ day, slots: list }));
 }
+// lib/utils/documents.ts
+function parseDocumentFields(source) {
+  if (Array.isArray(source))
+    return source.filter((item) => !!item && typeof item === "object" && typeof item.key === "string").map((item) => ({ key: item.key.trim(), ...item.label ? { label: item.label } : {} })).filter((item) => item.key);
+  if (typeof source !== "string")
+    return [];
+  const out = [];
+  const seen = new Set;
+  for (const raw of source.split(/\r?\n/)) {
+    const line = raw.trim();
+    if (!line || line.startsWith("#"))
+      continue;
+    const [keyPart, ...labelParts] = line.split("|");
+    const key = (keyPart ?? "").trim();
+    if (!key || seen.has(key))
+      continue;
+    seen.add(key);
+    const label = labelParts.join("|").trim();
+    out.push(label ? { key, label } : { key });
+  }
+  return out;
+}
+function parseDocumentFills(source) {
+  if (typeof source !== "string")
+    return {};
+  const out = {};
+  for (const raw of source.split(/\r?\n/)) {
+    const line = raw.trim();
+    if (!line || line.startsWith("#"))
+      continue;
+    const index = line.indexOf("=");
+    if (index === -1)
+      continue;
+    const field = line.slice(0, index).trim();
+    const target = line.slice(index + 1).trim();
+    if (field && target)
+      out[field] = target;
+  }
+  return out;
+}
+function documentFillPatch(fields, fills) {
+  const patch = {};
+  if (!fields)
+    return patch;
+  for (const [field, target] of Object.entries(fills)) {
+    const value = fields[field];
+    if (value === undefined || value === null || value === "")
+      continue;
+    patch[target] = value;
+  }
+  return patch;
+}
 // lib/review.ts
 var flaggedKeys = (annotations) => Object.entries(annotations ?? {}).filter(([, annotation]) => annotation?.incorrect === true).map(([key]) => key);
 // lib/utils/lint-spec.ts
@@ -9682,6 +9837,7 @@ export {
   Base64FileUploadService,
   Brick,
   FetchDataSourceService,
+  FetchDocumentReaderService,
   FetchOptionSourceService,
   FetchSpecSourceService,
   IDENTITY_FORMATS,
@@ -9706,6 +9862,7 @@ export {
   convertFormioForm,
   defaultFormData,
   defaultValidationMessage,
+  documentFillPatch,
   duplicateBrick,
   ensureBrickUids,
   evalBrickCode,
@@ -9730,9 +9887,12 @@ export {
   mrzCheckDigit,
   mrzLines,
   normalizeOptions,
+  parseDocumentFields,
+  parseDocumentFills,
   parseHeaderLines,
   parseMrz,
   pointerFromPath,
+  readDocumentReading,
   readSlots,
   registerValidationMessages,
   removeBrick,
@@ -9754,5 +9914,5 @@ export {
   wrapBrickData
 };
 
-//# debugId=30A49B7E74D3EC6964756E2164756E21
+//# debugId=A730893582334E9064756E2164756E21
 //# sourceMappingURL=index.js.map