euredact 0.6.0 → 0.7.1

package/dist/cjs/rules/cues.js

@@ -95,7 +95,7 @@ exports.CUES = [
         /(?<![A-Za-z0-9_])(?:phone|tel|telephone|téléphone|telefoon|telefon|telefono|teléfono|tlf|mobil|mobile|gsm|handy|sími|puh|móvil|cell|tālrunis|τηλέφωνο|τηλ)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     // National identity number.
     [types_js_1.EntityType.NATIONAL_ID,
-        /(?<![A-Za-z0-9_])(?:bsn|burgerservicenummer(?:\s*\(bsn\))?|personnummer|rijksregisternummer|nationaal\s*nummer|numéro\s*national|national\s*(?:id|number)|identiteitsnummer|henkilötunnus|kennitala|cpr(?:-?nummer)?|nif|nie|dni|rr|nn|nir|insz|niss|nis|matricule|ausweisnummer|personalausweis|osobní\s*číslo|ЕГН|EGN)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
+        /(?<![A-Za-z0-9_])(?:bsn(?!r)|burgerservicenummer(?:\s*\(bsn\))?|personnummer|rijksregisternummer|nationaal\s*nummer|numéro\s*national|national\s*(?:id|number)|identiteitsnummer|henkilötunnus|kennitala|cpr(?:-?nummer)?|nif|nie|dnie?(?![A-Za-z]|[^\x00-\x7F])|rr|nn|nir|insz|niss|nis|matricule|id\s*card(?:\s*(?:no|nr|number))?|ausweisnummer|personalausweis|osobní\s*číslo|ЕГН|EGN|dow[óo]d(?:u|em)?\s*osobist(?:y|ego|ym)|nr\s*dowodu|ahv(?:-?(?:nr|nummer))?|avs)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     // Cyprus: "ID number" in both official languages, plus the Greek abbreviation
     // ΑΔΤ (Αστυνομική Ταυτότητα). Neither has a phone reading.
     [types_js_1.EntityType.NATIONAL_ID,
@@ -116,16 +116,16 @@ exports.CUES = [
         /(?<![A-Za-z0-9_])(?:αφμ|α\.φ\.μ\.|steuerliche\s*identifikations-?nummer|steuer-?identifikations-?nummer|steuer-?id-?nr\.?|steuer-?id|steuernummer|st\.?-?nr|stnr|tin|finanzamt\s+ist|tax\s*(?:id|no|number)|daňové\s*číslo|numer\s*podatkowy)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     // Health insurance: the insured person.
     [types_js_1.EntityType.HEALTH_INSURANCE,
-        /(?<![A-Za-z0-9_])(?:versichertennummer|krankenversicherung|kvnr|kv-?nr|mutualité|ziekenfonds|aansluitingsnummer|medical\s*card(?:\s*(?:no|number))?)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
+        /(?<![A-Za-z0-9_])(?:versichertennummer|krankenversicherung|kvnr|kv-?nr|mutualité|ziekenfonds|aansluitingsnummer|medical\s*card(?:\s*(?:no|number))?|nhs(?:\s*(?:no|number))?)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     // Healthcare provider: the clinician or practice, not the patient — the Dutch
     // AGB-code, the German LANR, the UK GMC number.
     [types_js_1.EntityType.HEALTHCARE_PROVIDER,
-        /(?<![A-Za-z0-9_])(?:agb-?code|lanr|bsnr|gmc(?:\s*(?:no|number|reg))?|big-?nummer|zorgverlener(?:snummer)?)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
+        /(?<![A-Za-z0-9_])(?:agb-?code|lanr|bsnr|gmc(?:\s*(?:no|number|reg))?|big(?:-?registratie)?-?(?:nummer|nr)|zorgverlener(?:snummer)?|lebenslange\s*arztnummer|betriebsst[äa]ttennummer|rpps|adeli|pwz)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     // Company / trade register. "Companies House" and "Company Registration
     // Number" are written out: the tail allows a run-on *or* one qualifier word,
     // never a second word, so a three-word label needs to be spelled.
     [types_js_1.EntityType.CHAMBER_OF_COMMERCE,
-        /(?<![A-Za-z0-9_])(?:siren|siret|kbo|bce|kvk|ondernemingsnummer|ondernemingen\s+onder\s+nummer|kruispuntbank|numéro\s*d'entreprise|enterprise\s*number|handelsregister|companies\s*house(?:\s*(?:registration|reg|no|number))?|company\s*registration(?:\s*(?:number|no))?|company\s*(?:no|number|reg)|organisationsnummer|orgnr|i[čc]o|identifikační\s*číslo|ЕИК|eik|bulstat|cvr(?:-?nummer)?|virksomhedsnummer)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
+        /(?<![A-Za-z0-9_])(?:siren|siret|kbo|bce|kvk|ondernemingsnummer|ondernemingen\s+onder\s+nummer|kruispuntbank|numéro\s*d'entreprise|enterprise\s*number|handelsregister|companies\s*house(?:\s*(?:registration|reg|no|number))?|company\s*registration(?:\s*(?:number|no))?|company\s*(?:no|number|reg)|organisationsnummer|orgnr|i[čc]o|identifikační\s*číslo|ЕИК|eik|bulstat|cvr(?:-?nummer)?|virksomhedsnummer|regon|krs)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     // VAT.
     [types_js_1.EntityType.VAT,
         /(?<![A-Za-z0-9_])(?:vat|btw|tva|ust|iva|moms|alv|mwst|dič|vsk)(?:(?:[A-Za-z0-9_.\-]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
@@ -135,6 +135,15 @@ exports.CUES = [
     [types_js_1.EntityType.BANK_ACCOUNT,
         /(?<![A-Za-z0-9_])(?:sort\s*code|account\s*(?:no|number)|rekeningnummer|kontonummer|numéro\s*de\s*compte|sort-?code)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     // Passport.
+    // Residence permit. No permit patterns exist, so a permit number was filed
+    // under whichever ID, passport or phone pattern fitted it (rules-engine#53).
+    // The tail admits the Belgian card category ("nr. B 565992336"), unmasked.
+    [types_js_1.EntityType.RESIDENCE_PERMIT,
+        /(?<![A-Za-z0-9_])(?:aufenthalts(?:titel|erlaubnis|karte|gestattung)|niederlassungs(?:erlaubnis|bewilligung)|verblijfs(?:vergunning|kaart|document|titel)|titre\s*de\s*s[ée]jour|carte\s*de\s*s[ée]jour|permis\s*de\s*s[ée]jour|carte\s*de\s*r[ée]sident|residence\s*(?:permit|card|document)|biometric\s*residence\s*permit|permesso\s*di\s*soggiorno|carta\s*di\s*soggiorno|kart(?:a|y|ę|ą)\s*pobytu(?:\s*cukr)?|naklejk(?:a|i|ę|ą)\s*wizow(?:a|ej|ą)|uppehållstillstånd|opholdstilladelse|oppholdstillatelse|oleskelulupa)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*(?:[A-Z]\s+)?$/i],
+    // Driving licence: Polish labels; the document number has the passport
+    // shape, so without this cue it lost the span to the passport rule (rules-engine#77).
+    [types_js_1.EntityType.DRIVERS_LICENSE,
+        /(?<![A-Za-z0-9_])(?:(?:nr\s*dokumentu\s*)?(?:prawo|prawa|prawem)\s*jazdy|numer\s*blankietu\s*prawa\s*jazdy)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     [types_js_1.EntityType.PASSPORT,
         /(?<![A-Za-z0-9_])(?:passport(?:\s*(?:no|number))?|paspoort(?:nummer)?|reisepass(?:nummer)?|passeport|passnummer)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     // BIC / SWIFT.
@@ -151,7 +160,7 @@ exports.CUES = [
     // only thing that identifies one, which is why the engine emits this type
     // from here and nowhere else.
     [types_js_1.EntityType.INTERNAL_ID,
-        /(?<![A-Za-z0-9_])(?:medarbejdernummer|ansattnummer|anställningsnummer|personalnummer|personeelsnummer|matricule\s*salarié|employee\s*(?:no|number|id)|badge(?:\s*(?:no|number))?|betriebsstätten(?:nr|nummer)|grundstücks(?:nr|nummer)|dossier-?(?:nr|nummer)|aktenzeichen|osobní\s*(?:číslo\s*)?zaměstnance)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
+        /(?<![A-Za-z0-9_])(?:medarbejdernummer|ansattnummer|anställningsnummer|personalnummer|personeelsnummer|matricule\s*salarié|employee\s*(?:no|number|id)|badge(?:\s*(?:no|number))?|betriebsstätten(?:nr|nummer)|grundstücks(?:nr|nummer)|dossier-?(?:nr|nummer)|aktenzeichen|schade(?:claim|nummer|dossier)|schadens?-?(?:nummer|nr)|num[ée]ro\s*de\s*sinistre|numero\s*(?:di\s*)?sinistro|n[úu]mero\s*de\s*siniestro|skade(?:nummer|sag)|claim\s*(?:no|number|id)|collar|osobní\s*(?:číslo\s*)?zaměstnance)(?:(?:[A-Za-z0-9_]|[^\x00-\x7F])*|\s+[^\s:.\-\d,;()\/]{2,20})\s*\)?\s*[:.\-]*\s*$/i],
     // Credential. Typed SECRET because that is the type this SDK has; the
     // training pipeline's report asks for CREDENTIAL, which does not exist here.
     [types_js_1.EntityType.SECRET,
@@ -197,6 +206,13 @@ const RETYPABLE = new Set([
  * "Betriebsstättennr. 260326822" both landed, each reported as Czech.
  */
 const RETYPABLE_UNCORROBORATED = new Set([types_js_1.EntityType.NATIONAL_ID]);
+/**
+ * Retypable to RESIDENCE_PERMIT by a permit label touching the span, whatever
+ * the country support: a German eAT number fits the identity-card pattern and a
+ * Dutch permit number the passport pattern (rules-engine#53). Not a Spanish
+ * NIE, which the canon keeps NATIONAL_ID.
+ */
+const RETYPABLE_BY_PERMIT_LABEL = new Set([types_js_1.EntityType.NATIONAL_ID, types_js_1.EntityType.PASSPORT]);
 /**
  * Types a label can assert on its own.
  *
@@ -210,7 +226,7 @@ exports.CUE_TARGETS = new Set([
     types_js_1.EntityType.HEALTH_INSURANCE, types_js_1.EntityType.HEALTHCARE_PROVIDER,
     types_js_1.EntityType.CHAMBER_OF_COMMERCE, types_js_1.EntityType.VAT, types_js_1.EntityType.POSTAL_CODE,
     types_js_1.EntityType.PASSPORT, types_js_1.EntityType.INTERNAL_ID, types_js_1.EntityType.BANK_ACCOUNT,
-    types_js_1.EntityType.SECRET,
+    types_js_1.EntityType.SECRET, types_js_1.EntityType.RESIDENCE_PERMIT,
 ]);
 /**
  * Which of those a label may also *rescue* — re-admit after its checksum
@@ -247,13 +263,17 @@ exports.RESCUE_TARGETS = new Set([
  * `countryScore` is the document's support for the country the winning pattern
  * came from; see RETYPABLE_UNCORROBORATED.
  */
-function retypedBy(text, start, entityType, countryScore) {
+function retypedBy(text, start, entityType, countryScore, country = null) {
     const type = String(entityType);
-    if (!RETYPABLE.has(type)
-        && !(RETYPABLE_UNCORROBORATED.has(type) && countryScore === 0))
+    const general = RETYPABLE.has(type)
+        || (RETYPABLE_UNCORROBORATED.has(type) && countryScore === 0);
+    const byPermit = RETYPABLE_BY_PERMIT_LABEL.has(type) && country !== "ES";
+    if (!general && !byPermit)
         return null;
     const cued = cuedType(text, start);
     if (cued === null || cued === entityType || !exports.CUE_TARGETS.has(String(cued)))
         return null;
+    if (!general && cued !== types_js_1.EntityType.RESIDENCE_PERMIT)
+        return null;
     return cued;
 }

package/dist/cjs/rules/engine.js

@@ -280,12 +280,20 @@ class RuleEngine {
             if (this.matcher.validate(m)) {
                 validated.push({ match: m, hasValidValidator: m.patternDef.validator !== null });
             }
-            else if (m.patternDef.validator !== null && !m.patternDef.requiresContext) {
-                failedSpans.push({ start: m.start, end: m.end, code: m.countryCode,
-                    etype: String(m.patternDef.entityType) });
-                if (cues_js_1.RESCUE_TARGETS.has(String(m.patternDef.entityType))
-                    && (0, cues_js_1.cuedType)(text, m.start) === m.patternDef.entityType)
+            else if (m.patternDef.validator !== null) {
+                const cued = cues_js_1.RESCUE_TARGETS.has(String(m.patternDef.entityType))
+                    && (0, cues_js_1.cuedType)(text, m.start) === m.patternDef.entityType;
+                if (!m.patternDef.requiresContext) {
+                    failedSpans.push({ start: m.start, end: m.end, code: m.countryCode,
+                        etype: String(m.patternDef.entityType) });
+                    if (cued)
+                        rescued.push(m);
+                }
+                else if (cued) {
+                    // A label-gated pattern is rescued too, but only by a cue touching the
+                    // value; it casts no demotion zone (rules-engine#75).
                     rescued.push(m);
+                }
             }
         }
         // Evidence pass: work out which countries this document belongs to, from
@@ -495,7 +503,7 @@ class RuleEngine {
             // the value is filed as a Cypriot identity number. Dropping it also clears
             // outOfScope, which would otherwise claim the detection belongs to a
             // country the caller did not declare while naming no country at all.
-            const retyped = (0, cues_js_1.retypedBy)(text, match.start, entityType, countryScores.get(match.countryCode) ?? 0);
+            const retyped = (0, cues_js_1.retypedBy)(text, match.start, entityType, countryScores.get(match.countryCode) ?? 0, match.countryCode);
             if (retyped !== null) {
                 entityType = retyped;
                 country = null;