@streamline-pulse/formkrafter-core 0.28.1 → 0.30.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

@@ -10,7 +10,10 @@ export { RecapItem, collectRecapItems } from "./utils/recap.js";
 export { FieldDescriptor, CollectFieldsOptions, collectFields } from "./utils/fields.js";
 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 { MeasureFamily, MeasureUnit, MeasureValue, MEASURE_FAMILIES, measureFamilyOf, measureUnits, unitOf, convertMeasure, measureValue, formatMeasure } from "./utils/units.js";
+export { PLATE_FORMATS, REGISTRY_FORMATS, checkPlate, formatPlate, compactPlate, checkCompanyRegistry, formatCompanyRegistry } from "./utils/registries.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 +46,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

@@ -6924,7 +6924,9 @@ var DEFAULT_MESSAGES = {
     identity: "Invalid identifier for this format",
     iban: "Invalid IBAN",
     dateRange: "The end before the start is not allowed",
-    mrz: "Machine-readable zone unreadable or inconsistent"
+    mrz: "Machine-readable zone unreadable or inconsistent",
+    plate: "Invalid registration plate for this format",
+    registry: "Invalid registration number for this format"
   },
   fr: {
     required: "Ce champ est obligatoire",
@@ -6942,7 +6944,9 @@ var DEFAULT_MESSAGES = {
     identity: "Identifiant invalide pour ce format",
     iban: "IBAN invalide",
     dateRange: "La fin ne peut pas précéder le début",
-    mrz: "Zone de lecture illisible ou incohérente"
+    mrz: "Zone de lecture illisible ou incohérente",
+    plate: "Immatriculation invalide pour ce format",
+    registry: "Numéro d’immatriculation invalide pour ce format"
   }
 };
 function registerValidationMessages(locale, messages) {
@@ -7051,6 +7055,16 @@ function buildValidationSchema(brickSpecs, locale) {
       property.dateRange = true;
       messages.dateRange = defaultValidationMessage("dateRange", locale);
     }
+    if (brick.id === "vehicle-plate") {
+      const format = typeof brick.configs?.plateFormat === "string" && brick.configs.plateFormat ? brick.configs.plateFormat : "generic";
+      property.format = `plate-${format}`;
+      messages.format = defaultValidationMessage("plate", locale);
+    }
+    if (brick.id === "company-registry") {
+      const format = typeof brick.configs?.registryFormat === "string" && brick.configs.registryFormat ? brick.configs.registryFormat : "generic";
+      property.format = `registry-${format}`;
+      messages.format = defaultValidationMessage("registry", locale);
+    }
     if (brick.id === "mrz") {
       property.mrzValid = true;
       messages.mrzValid = defaultValidationMessage("mrz", locale);
@@ -7309,6 +7323,38 @@ 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",
+  "category.Measures": "Measures",
+  "category.Registries": "Vehicles & companies",
+  "brick.measure.name": "Measure",
+  "brick.vehicle-plate.name": "Vehicle plate",
+  "brick.company-registry.name": "Company registration",
+  "measure.value": "Value",
+  "measure.unit": "Unit",
+  "panel.family": "Measure family (length, area, mass, volume, duration)",
+  "panel.units": "Units offered (ids, comma-separated; empty = all)",
+  "panel.unit": "Default unit",
+  "panel.plateFormat": "Plate format (fr, bj, ci, sn, generic)",
+  "panel.registryFormat": "Registration format (ohada-rccm, fr-rcs, generic)",
   "panel.slotsUrl": "Slots URL (empty = opening rules)",
   "panel.slotDays": "Open days (1 = Monday … 7 = Sunday)",
   "panel.slotFrom": "Opens at",
@@ -7514,6 +7560,38 @@ 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",
+  "category.Measures": "Mesures",
+  "category.Registries": "Véhicules & entreprises",
+  "brick.measure.name": "Mesure",
+  "brick.vehicle-plate.name": "Immatriculation",
+  "brick.company-registry.name": "Registre d’entreprise",
+  "measure.value": "Valeur",
+  "measure.unit": "Unité",
+  "panel.family": "Famille de mesure (length, area, mass, volume, duration)",
+  "panel.units": "Unités proposées (identifiants séparés par des virgules ; vide = toutes)",
+  "panel.unit": "Unité par défaut",
+  "panel.plateFormat": "Format d’immatriculation (fr, bj, ci, sn, generic)",
+  "panel.registryFormat": "Format du registre (ohada-rccm, fr-rcs, generic)",
   "panel.slotsUrl": "URL des créneaux (vide = règles d’ouverture)",
   "panel.slotDays": "Jours ouverts (1 = lundi … 7 = dimanche)",
   "panel.slotFrom": "Ouverture",
@@ -8127,6 +8205,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 +8274,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) => {
@@ -8521,6 +8662,150 @@ function parseTd1(l1, l2, l3, raw) {
     errors
   };
 }
+// lib/utils/units.ts
+var MEASURE_FAMILIES = {
+  length: {
+    base: "m",
+    units: [
+      { id: "mm", symbol: "mm", factor: 0.001 },
+      { id: "cm", symbol: "cm", factor: 0.01 },
+      { id: "m", symbol: "m", factor: 1 },
+      { id: "km", symbol: "km", factor: 1000 }
+    ]
+  },
+  area: {
+    base: "m2",
+    units: [
+      { id: "m2", symbol: "m²", factor: 1 },
+      { id: "a", symbol: "a", factor: 100 },
+      { id: "ha", symbol: "ha", factor: 1e4 },
+      { id: "km2", symbol: "km²", factor: 1e6 }
+    ]
+  },
+  mass: {
+    base: "kg",
+    units: [
+      { id: "g", symbol: "g", factor: 0.001 },
+      { id: "kg", symbol: "kg", factor: 1 },
+      { id: "t", symbol: "t", factor: 1000 }
+    ]
+  },
+  volume: {
+    base: "l",
+    units: [
+      { id: "ml", symbol: "ml", factor: 0.001 },
+      { id: "l", symbol: "l", factor: 1 },
+      { id: "m3", symbol: "m³", factor: 1000 }
+    ]
+  },
+  duration: {
+    base: "h",
+    units: [
+      { id: "min", symbol: "min", factor: 1 / 60 },
+      { id: "h", symbol: "h", factor: 1 },
+      { id: "d", symbol: "j", factor: 24 }
+    ]
+  }
+};
+var measureFamilyOf = (value) => typeof value === "string" && (value in MEASURE_FAMILIES) ? value : "length";
+function measureUnits(family, allowed) {
+  const all = MEASURE_FAMILIES[family].units;
+  if (typeof allowed !== "string" || !allowed.trim())
+    return all;
+  const wanted = allowed.split(",").map((id) => id.trim().toLowerCase()).filter(Boolean);
+  const picked = all.filter((unit) => wanted.includes(unit.id));
+  return picked.length ? picked : all;
+}
+function unitOf(family, id) {
+  return MEASURE_FAMILIES[family].units.find((unit) => unit.id === id);
+}
+var round = (n) => Math.round(n * 1e9) / 1e9;
+function convertMeasure(family, value, from, to) {
+  const source = unitOf(family, from);
+  const target = unitOf(family, to);
+  if (!source || !target)
+    return;
+  return round(value * source.factor / target.factor);
+}
+function measureValue(family, value, unit) {
+  const source = unitOf(family, unit);
+  if (!source || !Number.isFinite(value))
+    return;
+  return { value, unit, base: round(value * source.factor) };
+}
+function formatMeasure(family, value, locale) {
+  if (!value)
+    return "";
+  const unit = unitOf(family, value.unit);
+  const number = new Intl.NumberFormat(locale, { maximumFractionDigits: 3 }).format(value.value);
+  return `${number} ${unit?.symbol ?? value.unit}`;
+}
+// lib/utils/registries.ts
+var compact2 = (value) => value.replace(/[\s.-]/g, "").toUpperCase();
+var group = (value, pattern, template) => value.replace(pattern, template);
+var PLATE_FORMATS = [
+  {
+    id: "fr",
+    label: "France · AA-123-AA",
+    test: (v) => /^[A-HJ-NP-Z]{2}\d{3}[A-HJ-NP-Z]{2}$/.test(v),
+    format: (v) => group(v, /^([A-Z]{2})(\d{3})([A-Z]{2})$/, "$1-$2-$3")
+  },
+  {
+    id: "bj",
+    label: "Bénin · AB 1234 RB",
+    test: (v) => /^[A-Z]{1,2}\d{4}[A-Z]{2}$/.test(v),
+    format: (v) => group(v, /^([A-Z]{1,2})(\d{4})([A-Z]{2})$/, "$1 $2 $3")
+  },
+  {
+    id: "ci",
+    label: "Côte d’Ivoire · 1234 AB 01",
+    test: (v) => /^\d{4}[A-Z]{2}\d{2}$/.test(v),
+    format: (v) => group(v, /^(\d{4})([A-Z]{2})(\d{2})$/, "$1 $2 $3")
+  },
+  {
+    id: "sn",
+    label: "Sénégal · AA 123 AA",
+    test: (v) => /^[A-Z]{2}\d{3,4}[A-Z]{1,2}$/.test(v),
+    format: (v) => group(v, /^([A-Z]{2})(\d{3,4})([A-Z]{1,2})$/, "$1 $2 $3")
+  },
+  { id: "generic", label: "Libre (4 à 10 lettres ou chiffres)", test: (v) => /^[A-Z0-9]{4,10}$/.test(v) }
+];
+var REGISTRY_FORMATS = [
+  {
+    id: "ohada-rccm",
+    label: "OHADA · RCCM (RB/COT/01 B 1234)",
+    test: (v) => /^[A-Z]{2}\/[A-Z]{2,4}\/\d{2,4}[A-Z]\d{3,7}$/.test(v.replace(/[\s]/g, "")),
+    format: (v) => v.replace(/^([A-Z]{2}\/[A-Z]{2,4}\/\d{2,4})([A-Z])(\d{3,7})$/, "$1 $2 $3")
+  },
+  {
+    id: "fr-rcs",
+    label: "France · RCS (SIREN + ville)",
+    test: (v) => /^\d{9}RCS[A-Z]{2,}$/.test(v.replace(/[\s]/g, "")),
+    format: (v) => v.replace(/^(\d{3})(\d{3})(\d{3})RCS(.+)$/, "$1 $2 $3 RCS $4")
+  },
+  { id: "generic", label: "Libre (4 à 20 caractères)", test: (v) => /^[A-Z0-9/-]{4,20}$/.test(v) }
+];
+var find = (list, id) => list.find((format) => format.id === id);
+var compactPlate = (value) => compact2(value);
+function checkPlate(format, value) {
+  const rule = find(PLATE_FORMATS, format) ?? find(PLATE_FORMATS, "generic");
+  return rule.test(compact2(value));
+}
+function formatPlate(format, value) {
+  const rule = find(PLATE_FORMATS, format);
+  const compacted = compact2(value);
+  return rule?.format && rule.test(compacted) ? rule.format(compacted) : value.trim().toUpperCase();
+}
+var compactRegistry = (value) => value.replace(/\s+/g, "").toUpperCase();
+function checkCompanyRegistry(format, value) {
+  const rule = find(REGISTRY_FORMATS, format) ?? find(REGISTRY_FORMATS, "generic");
+  return rule.test(compactRegistry(value));
+}
+function formatCompanyRegistry(format, value) {
+  const rule = find(REGISTRY_FORMATS, format);
+  const compacted = compactRegistry(value);
+  return rule?.format && rule.test(compacted) ? rule.format(compacted) : value.trim().toUpperCase();
+}
 // lib/utils/slots.ts
 var pad = (n) => String(n).padStart(2, "0");
 var localIso = (date) => `${date.getFullYear()}-${pad(date.getMonth() + 1)}-${pad(date.getDate())}T${pad(date.getHours())}:${pad(date.getMinutes())}`;
@@ -8576,6 +8861,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
@@ -8737,6 +9074,10 @@ import_ajv_formats.default(ajv, ["email", "uri"]);
 import_ajv_errors.default(ajv);
 for (const format of ["fr-nir", "bj-npi", "fr-siren", "fr-siret", "bj-ifu", "iban", ...Array.from({ length: 20 }, (_, i) => `digits-${i + 1}`)])
   ajv.addFormat(`identity-${format}`, (value) => checkIdentity(format, value));
+for (const { id } of PLATE_FORMATS)
+  ajv.addFormat(`plate-${id}`, (value) => checkPlate(id, value));
+for (const { id } of REGISTRY_FORMATS)
+  ajv.addFormat(`registry-${id}`, (value) => checkCompanyRegistry(id, value));
 ajv.addKeyword({
   keyword: "dateRange",
   type: "object",
@@ -9682,9 +10023,13 @@ export {
   Base64FileUploadService,
   Brick,
   FetchDataSourceService,
+  FetchDocumentReaderService,
   FetchOptionSourceService,
   FetchSpecSourceService,
   IDENTITY_FORMATS,
+  MEASURE_FAMILIES,
+  PLATE_FORMATS,
+  REGISTRY_FORMATS,
   SandboxJsRunnerService,
   SpecHistory,
   UnsafeEvalJsRunnerService,
@@ -9694,6 +10039,7 @@ export {
   buildValidationSchema,
   checkBjIfu,
   checkBjNpi,
+  checkCompanyRegistry,
   checkDigits,
   checkFrNir,
   checkFrSiren,
@@ -9701,11 +10047,15 @@ export {
   checkIban,
   checkIdentity,
   checkLuhn,
+  checkPlate,
   collectFields,
   collectRecapItems,
+  compactPlate,
   convertFormioForm,
+  convertMeasure,
   defaultFormData,
   defaultValidationMessage,
+  documentFillPatch,
   duplicateBrick,
   ensureBrickUids,
   evalBrickCode,
@@ -9713,7 +10063,10 @@ export {
   fkT,
   fkTOr,
   flaggedKeys,
+  formatCompanyRegistry,
   formatIban,
+  formatMeasure,
+  formatPlate,
   frFkTranslations,
   generateSlots,
   getAffectedProperties,
@@ -9726,13 +10079,19 @@ export {
   iterateBricks,
   iterateSchemaBricks,
   lintSpec,
+  measureFamilyOf,
+  measureUnits,
+  measureValue,
   moveBrick,
   mrzCheckDigit,
   mrzLines,
   normalizeOptions,
+  parseDocumentFields,
+  parseDocumentFills,
   parseHeaderLines,
   parseMrz,
   pointerFromPath,
+  readDocumentReading,
   readSlots,
   registerValidationMessages,
   removeBrick,
@@ -9744,6 +10103,7 @@ export {
   slotDate,
   stripBrickUids,
   stripUidsFromPatches,
+  unitOf,
   updateBrickConfigs,
   updateBrickRules,
   updateBrickStyles,
@@ -9754,5 +10114,5 @@ export {
   wrapBrickData
 };
 
-//# debugId=30A49B7E74D3EC6964756E2164756E21
+//# debugId=4C355ABE22E4DDEC64756E2164756E21
 //# sourceMappingURL=index.js.map