@budiauktioner/buildi-primitives 0.1.0

package/dist/swedish-swish-number-DDG3mNDg.d.ts

@@ -0,0 +1,397 @@
+import { P as PrimitiveTypeInfo, T as TextCandidate } from './text-candidate-qg2bD9PY.js';
+import { ValidationResult } from './validation/index.js';
+import { a as PhoneNumber } from './phone-number-C24--ggy.js';
+
+/**
+ * The International Bank Account Number (ISO 13616), e.g. `SE4550000000058398257466`.
+ * Validated using MOD-97 check digits.
+ */
+declare class Iban {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    static readonly displayName = "IBAN";
+    static readonly displayNameShort = "IBAN";
+    /** Normalized IBAN without spaces, e.g. `SE4550000000058398257466`. */
+    readonly value: string;
+    /** ISO 3166-1 alpha-2 country code, e.g. `SE`. */
+    readonly countryCode: string;
+    /** Display form grouped in blocks of four characters, e.g. `SE45 5000 0000 0583 9825 7466`. */
+    readonly formatted: string;
+    private constructor();
+    static tryParse(input: string | null | undefined): Iban | null;
+    static tryParse(input: string | null | undefined, countryCode: string): Iban | null;
+    static parse(input: string): Iban;
+    static isValid(input: string | null | undefined): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    toNormalizedString(): string;
+    toDisplayString(): string;
+    toShortDisplayString(): string;
+    toString(): string;
+    static validate(input: string | null | undefined): ValidationResult;
+    static findCandidatesInText(text: string): readonly TextCandidate<Iban>[];
+    equals(other: Iban | null | undefined): boolean;
+    compareTo(other: Iban | null | undefined): number;
+}
+/**
+ * Returns a masked IBAN preserving the country code and check digits,
+ * e.g. `SE45 **** **** **** **** ****`.
+ */
+declare function maskIban(iban: Iban): string;
+
+/**
+ * A BIC (Business Identifier Code / SWIFT code) per ISO 9362.
+ * 8 or 11 uppercase characters, e.g. `NDEASESS` or `NDEASESSXXX`.
+ */
+declare class Bic {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    /** Normalized 8 or 11 uppercase characters, e.g. `NDEASESS`. */
+    readonly code: string;
+    readonly institutionCode: string;
+    readonly countryCode: string;
+    readonly locationCode: string;
+    readonly branchCode: string | null;
+    /** True when the BIC has no branch code (or the branch code is the head office). */
+    get isPrimaryOffice(): boolean;
+    private constructor();
+    static tryParse(input: string | null | undefined): Bic | null;
+    static parse(input: string): Bic;
+    static isValid(input: string | null | undefined): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    toNormalizedString(): string;
+    toString(): string;
+    static validate(input: string | null | undefined): ValidationResult;
+    static findCandidatesInText(text: string): readonly TextCandidate<Bic>[];
+    equals(other: Bic | null | undefined): boolean;
+    compareTo(other: Bic | null | undefined): number;
+}
+/**
+ * Returns a masked BIC showing the country code, e.g. `NDEASESS` → `****SE**`.
+ */
+declare function maskBic(bic: Bic): string;
+
+/**
+ * Known Swedish banks, identified by clearing number ranges.
+ *
+ * Equivalent of the .NET `SwedishBank` enum.
+ */
+declare const SwedishBank: {
+    readonly Unknown: "Unknown";
+    readonly SverigesRiksbank: "SverigesRiksbank";
+    readonly Nordea: "Nordea";
+    readonly NordeaPersonkonto: "NordeaPersonkonto";
+    readonly NordeaPlusgirot: "NordeaPlusgirot";
+    readonly DanskeBank: "DanskeBank";
+    readonly Handelsbanken: "Handelsbanken";
+    readonly SEB: "SEB";
+    readonly Swedbank: "Swedbank";
+    readonly Lansforsakringar: "Lansforsakringar";
+    readonly IcaBanken: "IcaBanken";
+    readonly Skandiabanken: "Skandiabanken";
+    readonly SBABBank: "SBABBank";
+    readonly AvanzaBank: "AvanzaBank";
+    readonly AionBank: "AionBank";
+    readonly BnpParibas: "BnpParibas";
+    readonly CitibankEurope: "CitibankEurope";
+    readonly HSBBank: "HSBBank";
+    readonly CalyonBank: "CalyonBank";
+    readonly RoyalBankOfScotland: "RoyalBankOfScotland";
+    readonly DNBSverige: "DNBSverige";
+    readonly Ekobanken: "Ekobanken";
+    readonly EnityBankGroup: "EnityBankGroup";
+    readonly EpBank: "EpBank";
+    readonly IkanoBank: "IkanoBank";
+    readonly JAKMedlemsbank: "JAKMedlemsbank";
+    readonly KlarnaBank: "KlarnaBank";
+    readonly LandshypotekBank: "LandshypotekBank";
+    readonly LunarBank: "LunarBank";
+    readonly LanOchSparBank: "LanOchSparBank";
+    readonly MarginalenBank: "MarginalenBank";
+    readonly MultitudeBank: "MultitudeBank";
+    readonly NobaBankGroup: "NobaBankGroup";
+    readonly NordnetBank: "NordnetBank";
+    readonly NorthmillBank: "NorthmillBank";
+    readonly ResursBank: "ResursBank";
+    readonly Santander: "Santander";
+    readonly SparbankenSyd: "SparbankenSyd";
+    readonly SveaBank: "SveaBank";
+    readonly Alandsbanken: "Alandsbanken";
+    readonly VolvofinansBank: "VolvofinansBank";
+    readonly StadshypotekBank: "StadshypotekBank";
+    readonly GjensidigeNorSparebank: "GjensidigeNorSparebank";
+    readonly ParetoOhman: "ParetoOhman";
+    readonly Forex: "Forex";
+    readonly ParexBank: "ParexBank";
+    readonly BriteAb: "BriteAb";
+    readonly BankingCircle: "BankingCircle";
+    readonly BankOfChinaLuxembourg: "BankOfChinaLuxembourg";
+    readonly MedMeraBank: "MedMeraBank";
+    readonly Folkia: "Folkia";
+    readonly NetfondsBank: "NetfondsBank";
+    readonly NasdaqOmx: "NasdaqOmx";
+    readonly Riksgalden: "Riksgalden";
+    readonly Privatgirot: "Privatgirot";
+    readonly Intergiro: "Intergiro";
+    readonly Nykredit: "Nykredit";
+    readonly TellerBranchNorway: "TellerBranchNorway";
+    readonly BankernasAutomatbolag: "BankernasAutomatbolag";
+    readonly TellerBranchSweden: "TellerBranchSweden";
+    readonly KortacceptNordic: "KortacceptNordic";
+    readonly Kommuninvest: "Kommuninvest";
+    readonly VpSecurities: "VpSecurities";
+};
+type SwedishBank = (typeof SwedishBank)[keyof typeof SwedishBank];
+
+/**
+ * A Swedish clearing number (`clearingnummer`), 4 digits (or 5 starting with `8` for Swedbank).
+ */
+declare class SwedishBankClearingNumber {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    readonly digits: string;
+    readonly bank: SwedishBank;
+    readonly bankName: string;
+    private constructor();
+    static tryParse(input: string | null | undefined): SwedishBankClearingNumber | null;
+    static parse(input: string): SwedishBankClearingNumber;
+    static isValid(input: string | null | undefined): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    toNormalizedString(): string;
+    toString(): string;
+    static validate(input: string | null | undefined): ValidationResult;
+    equals(other: SwedishBankClearingNumber | null | undefined): boolean;
+    compareTo(other: SwedishBankClearingNumber | null | undefined): number;
+}
+/** Returns a masked clearing number showing the bank identifier (first digit), e.g. `5001` → `5***`. */
+declare function maskSwedishBankClearingNumber(c: SwedishBankClearingNumber): string;
+
+/**
+ * A Swedish bank account, identified by clearing number + account number with
+ * bank-specific length rules.
+ */
+declare class SwedishBankAccount {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    static readonly displayName = "Bankkonto";
+    readonly clearing: SwedishBankClearingNumber;
+    readonly accountNumber: string;
+    readonly formatted: string;
+    get clearingNumber(): string;
+    get bankName(): string | null;
+    get bank(): SwedishBank | null;
+    private constructor();
+    static tryParse(input: string | null | undefined): SwedishBankAccount | null;
+    static parse(input: string): SwedishBankAccount;
+    static isValid(input: string | null | undefined): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    toNormalizedString(): string;
+    toDisplayString(): string;
+    toString(): string;
+    static validate(input: string | null | undefined): ValidationResult;
+    static findCandidatesInText(text: string): readonly TextCandidate<SwedishBankAccount>[];
+    equals(other: SwedishBankAccount | null | undefined): boolean;
+    compareTo(other: SwedishBankAccount | null | undefined): number;
+}
+/**
+ * Returns a masked bank account showing the clearing number, e.g. `5100-*******`.
+ * Pass `maskClearingNumber: true` to also mask the clearing number.
+ */
+declare function maskSwedishBankAccount(account: SwedishBankAccount, options?: {
+    maskClearingNumber?: boolean;
+}): string;
+
+/**
+ * A Swedish Bankgiro number (`bankgironummer`), e.g. `5805-6201`.
+ * 7 or 8 digits with Luhn check digit.
+ */
+declare class SwedishBankgiroNumber {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    static readonly displayName = "Bankgiro";
+    static readonly displayNameShort = "BG";
+    /** Digit-only value, e.g. `58056201`. */
+    readonly digits: string;
+    /** Hyphenated display form, e.g. `5805-6201`. */
+    readonly formatted: string;
+    private constructor();
+    static tryParse(input: string | null | undefined): SwedishBankgiroNumber | null;
+    static parse(input: string): SwedishBankgiroNumber;
+    static isValid(input: string | null | undefined): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    toNormalizedString(): string;
+    toDisplayString(): string;
+    toShortDisplayString(): string;
+    toString(): string;
+    static validate(input: string | null | undefined): ValidationResult;
+    static findCandidatesInText(text: string): readonly TextCandidate<SwedishBankgiroNumber>[];
+    equals(other: SwedishBankgiroNumber | null | undefined): boolean;
+    compareTo(other: SwedishBankgiroNumber | null | undefined): number;
+}
+/** Returns the Bankgirot search URL for this Bankgiro number. */
+declare function getBankgirotUrl(bg: SwedishBankgiroNumber): string;
+/**
+ * Returns a masked Bankgiro number, e.g. `****-6201` (default) or `5805-****` when
+ * `showLastDigits` is `false`.
+ */
+declare function maskSwedishBankgiroNumber(bg: SwedishBankgiroNumber, options?: {
+    showLastDigits?: boolean;
+}): string;
+
+/** OCR reference control type. */
+declare const OcrReferenceControlType: {
+    readonly CheckDigitOnly: "CheckDigitOnly";
+    readonly VariableLengthDigit: "VariableLengthDigit";
+    readonly FixedLength: "FixedLength";
+};
+type OcrReferenceControlType = (typeof OcrReferenceControlType)[keyof typeof OcrReferenceControlType];
+/** Options controlling OCR reference parsing. */
+declare class OcrReferenceOptions {
+    static readonly Default: OcrReferenceOptions;
+    static readonly VariableLengthDigit: OcrReferenceOptions;
+    readonly controlType: OcrReferenceControlType;
+    readonly allowedLengths: readonly number[];
+    constructor(controlType?: OcrReferenceControlType, allowedLengths?: readonly number[]);
+    static fixedLength(...allowedLengths: number[]): OcrReferenceOptions;
+}
+/**
+ * A Swedish OCR reference number (`OCR-nummer`), used in payment flows.
+ * 2–25 digits with Luhn check digit; optional length-digit and fixed-length variants.
+ */
+declare class SwedishOcrReferenceNumber {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    static readonly displayName = "OCR";
+    static readonly displayNameShort = "OCR";
+    readonly value: string;
+    readonly formatted: string;
+    readonly lengthDigit: number | null;
+    get length(): number;
+    get checkDigit(): number;
+    private constructor();
+    static tryParse(input: string | null | undefined, options?: OcrReferenceOptions): SwedishOcrReferenceNumber | null;
+    static tryParseVariableLengthDigit(input: string | null | undefined): SwedishOcrReferenceNumber | null;
+    static tryParseFixedLength(input: string | null | undefined, fixedLengths: number | readonly number[]): SwedishOcrReferenceNumber | null;
+    static parse(input: string, options?: OcrReferenceOptions): SwedishOcrReferenceNumber;
+    static isValid(input: string | null | undefined, options?: OcrReferenceOptions): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    toNormalizedString(): string;
+    toDisplayString(): string;
+    toShortDisplayString(): string;
+    toString(): string;
+    static validate(input: string | null | undefined): ValidationResult;
+    static findCandidatesInText(text: string): readonly TextCandidate<SwedishOcrReferenceNumber>[];
+    equals(other: SwedishOcrReferenceNumber | null | undefined): boolean;
+    compareTo(other: SwedishOcrReferenceNumber | null | undefined): number;
+}
+/** Returns a fully masked OCR reference, e.g. `12345678901` → `***********`. */
+declare function maskSwedishOcrReferenceNumber(ocr: SwedishOcrReferenceNumber): string;
+
+/**
+ * A Swedish Plusgiro number (`plusgironummer`), e.g. `1234567-9`.
+ * 2–8 digits with Luhn check digit.
+ */
+declare class SwedishPostgiroNumber {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    static readonly displayName = "Plusgiro";
+    static readonly displayNameShort = "PG";
+    /** Digit-only value, e.g. `41313008`. */
+    readonly digits: string;
+    /** Hyphenated display form, e.g. `4131300-8`. */
+    readonly formatted: string;
+    private constructor();
+    static tryParse(input: string | null | undefined): SwedishPostgiroNumber | null;
+    static parse(input: string): SwedishPostgiroNumber;
+    static isValid(input: string | null | undefined): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    toNormalizedString(): string;
+    toDisplayString(): string;
+    toShortDisplayString(): string;
+    toString(): string;
+    static validate(input: string | null | undefined): ValidationResult;
+    static findCandidatesInText(text: string): readonly TextCandidate<SwedishPostgiroNumber>[];
+    equals(other: SwedishPostgiroNumber | null | undefined): boolean;
+    compareTo(other: SwedishPostgiroNumber | null | undefined): number;
+}
+/**
+ * Returns a masked Plusgiro number, e.g. `******-9` (default, showing the control digit) or
+ * `123456-*` when `showControlDigit` is `false`.
+ */
+declare function maskSwedishPostgiroNumber(pg: SwedishPostgiroNumber, options?: {
+    showControlDigit?: boolean;
+}): string;
+
+/**
+ * A Swedish Swish payment number (`Swish-nummer`).
+ * Accepts:
+ * - Swish 123 numbers (10 digits starting with `123`)
+ * - 90-numbers (7 digits starting with `90X`, expanded to `123` + 7 digits)
+ * - Swedish mobile phone numbers
+ */
+declare class SwedishSwishNumber {
+    static readonly typeInfo: PrimitiveTypeInfo;
+    readonly value: string;
+    readonly formatted: string;
+    readonly isSwish123: boolean;
+    readonly isMobileNumber: boolean;
+    readonly is90Number: boolean;
+    readonly phoneNumber: PhoneNumber | null;
+    private constructor();
+    static tryParse(input: string | null | undefined): SwedishSwishNumber | null;
+    static parse(input: string): SwedishSwishNumber;
+    static isValid(input: string | null | undefined): boolean;
+    static format(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static normalize(input: string | null | undefined, options?: {
+        fallbackToTrimmedInputWhenInvalid?: boolean;
+    }): string | null;
+    static isNormalized(input: string | null | undefined): boolean;
+    toNormalizedString(): string;
+    toString(): string;
+    static findCandidatesInText(text: string): readonly TextCandidate<SwedishSwishNumber>[];
+    equals(other: SwedishSwishNumber | null | undefined): boolean;
+    compareTo(other: SwedishSwishNumber | null | undefined): number;
+}
+/**
+ * Returns a masked Swish number, e.g. `123-*** ** **` for 123-numbers,
+ * `9** ** **` for 90-numbers.
+ */
+declare function maskSwedishSwishNumber(swish: SwedishSwishNumber): string;
+
+export { Bic as B, Iban as I, OcrReferenceControlType as O, SwedishBank as S, OcrReferenceOptions as a, SwedishBankAccount as b, SwedishBankClearingNumber as c, SwedishBankgiroNumber as d, SwedishOcrReferenceNumber as e, SwedishPostgiroNumber as f, SwedishSwishNumber as g, getBankgirotUrl as h, maskIban as i, maskSwedishBankAccount as j, maskSwedishBankClearingNumber as k, maskSwedishBankgiroNumber as l, maskBic as m, maskSwedishOcrReferenceNumber as n, maskSwedishPostgiroNumber as o, maskSwedishSwishNumber as p };

package/dist/text-candidate-qg2bD9PY.d.cts

@@ -0,0 +1,110 @@
+/**
+ * Metadata describing a primitive value-object type — its human-readable
+ * names, representative emoji, and reference source URLs.
+ *
+ * The .NET equivalent is `Buildi.Primitives.PrimitiveTypeInfo` (a `record`).
+ */
+interface PrimitiveTypeInfo {
+    readonly englishName: string;
+    readonly localizedName: string;
+    readonly emoji: string;
+    readonly sources: readonly string[];
+}
+
+/**
+ * Broad classification of a {@link TextCandidate} for filtering and selective
+ * masking.
+ */
+declare const TextCandidateCategory: {
+    readonly PersonalIdentifier: "PersonalIdentifier";
+    readonly OrganizationIdentifier: "OrganizationIdentifier";
+    readonly Financial: "Financial";
+    readonly Contact: "Contact";
+    readonly Vehicle: "Vehicle";
+    readonly Property: "Property";
+    readonly Product: "Product";
+    readonly Geography: "Geography";
+    readonly Measurement: "Measurement";
+};
+type TextCandidateCategory = (typeof TextCandidateCategory)[keyof typeof TextCandidateCategory];
+
+/**
+ * Indicates the confidence level of a candidate found by text scanning.
+ * Higher confidence means stronger structural evidence, but no level guarantees
+ * the absence of false positives.
+ */
+declare const TextMatchConfidence: {
+    /**
+     * Pattern match only. High false-positive risk — the matched text merely
+     * fits a syntactic pattern (e.g. a run of digits that happens to be the
+     * right length).
+     */
+    readonly Low: 0;
+    /**
+     * Structural match with partial validation — the format is correct but no
+     * checksum or strong distinguishing feature confirms the match.
+     */
+    readonly Medium: 1;
+    /**
+     * Strong match with checksum or format-specific validation (e.g. a personal
+     * identity number with a valid Luhn check digit and plausible date, or an
+     * IBAN with valid MOD-97).
+     */
+    readonly High: 2;
+};
+type TextMatchConfidence = (typeof TextMatchConfidence)[keyof typeof TextMatchConfidence];
+
+/**
+ * A potential match of a structured type found in unstructured text.
+ *
+ * Text scanning is heuristic-based. Candidates may be false positives, and
+ * valid occurrences may be missed. No guarantee is made that the matched text
+ * actually represents the identified type in its original context.
+ */
+declare class TextCandidate<T = unknown> {
+    /** Zero-based start position in the scanned text. */
+    readonly startIndex: number;
+    /** Number of characters in the original matched span. */
+    readonly length: number;
+    /** The raw substring from the input text that was matched. */
+    readonly originalText: string;
+    /**
+     * Short type name, e.g. `EmailAddress` or `SwedishPersonalIdentityNumber`.
+     */
+    readonly typeName: string;
+    /** Broad category of the matched type. */
+    readonly category: TextCandidateCategory;
+    /** Machine-comparable canonical form of the matched value. */
+    readonly normalizedForm: string;
+    /** Human-readable display form of the matched value. */
+    readonly formattedForm: string;
+    /**
+     * Display form with sensitive content masked (e.g. `990807-****`).
+     * Produced by the type's `toMaskedString()` helper.
+     */
+    readonly maskedForm: string;
+    /** Heuristic confidence level. */
+    readonly confidence: TextMatchConfidence;
+    /** The successfully parsed instance of the matched type. */
+    readonly value: T;
+    constructor(opts: {
+        startIndex: number;
+        length: number;
+        originalText: string;
+        typeName: string;
+        category: TextCandidateCategory;
+        normalizedForm: string;
+        formattedForm: string;
+        maskedForm: string;
+        confidence: TextMatchConfidence;
+        value: T;
+    });
+    /** Exclusive end position (`startIndex + length`). */
+    get endIndex(): number;
+    /** Returns `true` if this candidate's span overlaps with `other`. */
+    overlaps(other: TextCandidate): boolean;
+    /** Returns `true` if this candidate's span fully contains `other`. */
+    contains(other: TextCandidate): boolean;
+}
+
+export { type PrimitiveTypeInfo as P, TextCandidate as T, TextCandidateCategory as a, TextMatchConfidence as b };

package/dist/text-candidate-qg2bD9PY.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Metadata describing a primitive value-object type — its human-readable
+ * names, representative emoji, and reference source URLs.
+ *
+ * The .NET equivalent is `Buildi.Primitives.PrimitiveTypeInfo` (a `record`).
+ */
+interface PrimitiveTypeInfo {
+    readonly englishName: string;
+    readonly localizedName: string;
+    readonly emoji: string;
+    readonly sources: readonly string[];
+}
+
+/**
+ * Broad classification of a {@link TextCandidate} for filtering and selective
+ * masking.
+ */
+declare const TextCandidateCategory: {
+    readonly PersonalIdentifier: "PersonalIdentifier";
+    readonly OrganizationIdentifier: "OrganizationIdentifier";
+    readonly Financial: "Financial";
+    readonly Contact: "Contact";
+    readonly Vehicle: "Vehicle";
+    readonly Property: "Property";
+    readonly Product: "Product";
+    readonly Geography: "Geography";
+    readonly Measurement: "Measurement";
+};
+type TextCandidateCategory = (typeof TextCandidateCategory)[keyof typeof TextCandidateCategory];
+
+/**
+ * Indicates the confidence level of a candidate found by text scanning.
+ * Higher confidence means stronger structural evidence, but no level guarantees
+ * the absence of false positives.
+ */
+declare const TextMatchConfidence: {
+    /**
+     * Pattern match only. High false-positive risk — the matched text merely
+     * fits a syntactic pattern (e.g. a run of digits that happens to be the
+     * right length).
+     */
+    readonly Low: 0;
+    /**
+     * Structural match with partial validation — the format is correct but no
+     * checksum or strong distinguishing feature confirms the match.
+     */
+    readonly Medium: 1;
+    /**
+     * Strong match with checksum or format-specific validation (e.g. a personal
+     * identity number with a valid Luhn check digit and plausible date, or an
+     * IBAN with valid MOD-97).
+     */
+    readonly High: 2;
+};
+type TextMatchConfidence = (typeof TextMatchConfidence)[keyof typeof TextMatchConfidence];
+
+/**
+ * A potential match of a structured type found in unstructured text.
+ *
+ * Text scanning is heuristic-based. Candidates may be false positives, and
+ * valid occurrences may be missed. No guarantee is made that the matched text
+ * actually represents the identified type in its original context.
+ */
+declare class TextCandidate<T = unknown> {
+    /** Zero-based start position in the scanned text. */
+    readonly startIndex: number;
+    /** Number of characters in the original matched span. */
+    readonly length: number;
+    /** The raw substring from the input text that was matched. */
+    readonly originalText: string;
+    /**
+     * Short type name, e.g. `EmailAddress` or `SwedishPersonalIdentityNumber`.
+     */
+    readonly typeName: string;
+    /** Broad category of the matched type. */
+    readonly category: TextCandidateCategory;
+    /** Machine-comparable canonical form of the matched value. */
+    readonly normalizedForm: string;
+    /** Human-readable display form of the matched value. */
+    readonly formattedForm: string;
+    /**
+     * Display form with sensitive content masked (e.g. `990807-****`).
+     * Produced by the type's `toMaskedString()` helper.
+     */
+    readonly maskedForm: string;
+    /** Heuristic confidence level. */
+    readonly confidence: TextMatchConfidence;
+    /** The successfully parsed instance of the matched type. */
+    readonly value: T;
+    constructor(opts: {
+        startIndex: number;
+        length: number;
+        originalText: string;
+        typeName: string;
+        category: TextCandidateCategory;
+        normalizedForm: string;
+        formattedForm: string;
+        maskedForm: string;
+        confidence: TextMatchConfidence;
+        value: T;
+    });
+    /** Exclusive end position (`startIndex + length`). */
+    get endIndex(): number;
+    /** Returns `true` if this candidate's span overlaps with `other`. */
+    overlaps(other: TextCandidate): boolean;
+    /** Returns `true` if this candidate's span fully contains `other`. */
+    contains(other: TextCandidate): boolean;
+}
+
+export { type PrimitiveTypeInfo as P, TextCandidate as T, TextCandidateCategory as a, TextMatchConfidence as b };