@przeslijmi/real-fake-data-playwright 1.1.0 → 1.5.0

package/dist/types.d.ts

@@ -16,7 +16,7 @@ export type PolishLegalForm = 'Sp. z o.o.' | 'Sp. z o.o. sp.k.' | 'P.S.A.' | 'S.
 /** Naming family the company-name generator drew from. */
 export type CompanyNameStrategy = 'morpheme' | 'surname' | 'descriptive' | 'modern';
 /** Kind of vehicle registration plate produced. */
-export type VehicleRegistrationType = 'standard' | 'custom' | 'police' | 'military';
+export type VehicleRegistrationType = 'standard' | 'custom' | 'police' | 'military' | 'historic';
 /** Local-part shape the email generator can produce. */
 export type EmailLocalPattern = 'first.last' | 'firstlast' | 'first_last' | 'first.last.number' | 'flast' | 'initial.last' | 'noun.number';
 /** Provider-domain category the email generator can draw from. */
@@ -145,6 +145,20 @@ export interface LoremOptions extends RequestOptions {
      */
     readonly startWithLorem?: boolean;
 }
+export interface CustomRegexOptions extends RequestOptions {
+    /**
+     * The regular expression (source form, no delimiters) to generate a matching
+     * string for, e.g. `"[A-Z]{2}-\\d{6}"`. Required. Back-references and
+     * look-around assertions are rejected, as are patterns with an over-large
+     * worst-case expansion. Requires the Pro plan or above.
+     */
+    readonly pattern: string;
+    /**
+     * How many times unbounded quantifiers (`*`, `+`, `{n,}`) may expand.
+     * Defaults to 32.
+     */
+    readonly maxRepetition?: number;
+}
 export interface PolishPeselData {
     readonly value: string;
     readonly birthDate: string;
@@ -200,6 +214,186 @@ export interface PolishCompanyData {
     readonly regon: string;
     readonly krs: string | null;
 }
+/**
+ * Options for a country's one-call `company` generator — shared across every
+ * country (the data shape differs per country, but the inputs do not).
+ */
+export interface LocaleCompanyOptions extends RequestOptions {
+    readonly strategy?: CompanyNameStrategy | 'any';
+    /** Country-specific legal form, `'any'` for weighted-random, or `'none'` to omit. */
+    readonly legalForm?: string;
+    /** Corrupt the checksummed identifiers so they fail validation; name unaffected. */
+    readonly invalid?: boolean;
+    /** Restrict output to edge-case values from the rare corners. */
+    readonly edge?: boolean;
+}
+/** One AT company: the name, its legal form, and the matching national identifiers. */
+export interface AtCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly firmenbuchnummer: string;
+    readonly uid: string;
+    readonly steuernummer: string;
+}
+/** One BE company: the name, its legal form, and the matching national identifiers. */
+export interface BeCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly ondernemingsnummer: string;
+}
+/** One BG company: the name, its legal form, and the matching national identifiers. */
+export interface BgCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly eik: string;
+}
+/** One CY company: the name, its legal form, and the matching national identifiers. */
+export interface CyCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly tic: string;
+}
+/** One CZ company: the name, its legal form, and the matching national identifiers. */
+export interface CzCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly ico: string;
+}
+/** One DE company: the name, its legal form, and the matching national identifiers. */
+export interface DeCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly handelsregisternummer: string;
+    readonly ustIdnr: string;
+    readonly wirtschaftsIdnr: string;
+}
+/** One DK company: the name, its legal form, and the matching national identifiers. */
+export interface DkCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly cvr: string;
+}
+/** One EE company: the name, its legal form, and the matching national identifiers. */
+export interface EeCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly registrikood: string;
+    readonly kmkr: string;
+}
+/** One ES company: the name, its legal form, and the matching national identifiers. */
+export interface EsCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly cif: string;
+}
+/** One FI company: the name, its legal form, and the matching national identifiers. */
+export interface FiCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly yTunnus: string;
+}
+/** One FR company: the name, its legal form, and the matching national identifiers. */
+export interface FrCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly siren: string;
+}
+/** One GR company: the name, its legal form, and the matching national identifiers. */
+export interface GrCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly afm: string;
+}
+/** One HR company: the name, its legal form, and the matching national identifiers. */
+export interface HrCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly oib: string;
+}
+/** One HU company: the name, its legal form, and the matching national identifiers. */
+export interface HuCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly cegjegyzekszam: string;
+    readonly adoszam: string;
+}
+/** One IE company: the name, its legal form, and the matching national identifiers. */
+export interface IeCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly cro: string;
+    readonly vat: string;
+}
+/** One IT company: the name, its legal form, and the matching national identifiers. */
+export interface ItCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly partitaIva: string;
+}
+/** One LT company: the name, its legal form, and the matching national identifiers. */
+export interface LtCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly imonesKodas: string;
+    readonly pvm: string;
+}
+/** One LU company: the name, its legal form, and the matching national identifiers. */
+export interface LuCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly tva: string;
+}
+/** One LV company: the name, its legal form, and the matching national identifiers. */
+export interface LvCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly registracijasNumurs: string;
+}
+/** One MT company: the name, its legal form, and the matching national identifiers. */
+export interface MtCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly vat: string;
+}
+/** One NL company: the name, its legal form, and the matching national identifiers. */
+export interface NlCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly kvk: string;
+    readonly rsin: string;
+    readonly btwId: string;
+}
+/** One PT company: the name, its legal form, and the matching national identifiers. */
+export interface PtCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly nif: string;
+}
+/** One RO company: the name, its legal form, and the matching national identifiers. */
+export interface RoCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly cui: string;
+}
+/** One SE company: the name, its legal form, and the matching national identifiers. */
+export interface SeCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly organisationsnummer: string;
+}
+/** One SI company: the name, its legal form, and the matching national identifiers. */
+export interface SiCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly davcnaStevilka: string;
+}
+/** One SK company: the name, its legal form, and the matching national identifiers. */
+export interface SkCompanyData {
+    readonly name: string;
+    readonly legalForm: string | null;
+    readonly ico: string;
+    readonly icDph: string;
+}
 export interface PolishVehicleRegistrationData {
     readonly value: string;
     readonly prefix: string;
@@ -251,6 +445,11 @@ export interface LoremData {
     readonly paragraphs: number;
     readonly startedWithLorem: boolean;
 }
+export interface CustomRegexData {
+    readonly value: string;
+    /** The source pattern the value was generated from, echoed back. */
+    readonly pattern: string;
+}
 /**
  * Options shared by every country's `person-name` generator (`dePersonName`,
  * `itPersonName`, `plPersonName`, …). Only the underlying name pools and
@@ -528,6 +727,17 @@ export interface DkCprData {
     readonly birthDate: string;
     readonly sex: Sex;
 }
+export interface DkPersonOptions extends DkCprOptions {
+    /** Mangle the casing of `name`/`surname` for testing. Defaults to `true`. */
+    readonly caseStrict?: boolean;
+}
+export interface DkPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly cpr: string;
+}
 export interface DkCvrOptions extends RequestOptions {
     readonly format?: 'national' | 'vat';
     readonly invalid?: boolean;
@@ -700,7 +910,7 @@ export interface HuSzemelyiAzonositoOptions extends RequestOptions {
     readonly bornOn?: string;
     readonly bornBefore?: string;
     readonly bornAfter?: string;
-    readonly standard?: 'pre-1997' | 'modern';
+    readonly standard?: 'pre-1997' | 'modern' | 'both';
     readonly invalid?: boolean;
     readonly edge?: boolean;
 }
@@ -731,7 +941,7 @@ export interface HuCegjegyzekszamData {
     readonly digits: string;
 }
 export interface IePpsnOptions extends RequestOptions {
-    readonly standard?: 'pre-2013' | 'modern';
+    readonly standard?: 'pre-2013' | 'modern' | 'both';
     readonly invalid?: boolean;
     readonly edge?: boolean;
 }
@@ -743,7 +953,7 @@ export interface IePpsnData {
 }
 export interface IeVatOptions extends RequestOptions {
     readonly format?: 'national' | 'vat';
-    readonly standard?: 'pre-2013' | 'modern';
+    readonly standard?: 'pre-2013' | 'modern' | 'both';
     readonly invalid?: boolean;
     readonly edge?: boolean;
 }
@@ -794,7 +1004,7 @@ export interface LvPersonasKodsOptions extends RequestOptions {
     readonly bornOn?: string;
     readonly bornBefore?: string;
     readonly bornAfter?: string;
-    readonly standard?: 'legacy' | 'modern';
+    readonly standard?: 'legacy' | 'modern' | 'both';
     readonly format?: 'plain' | 'with-hyphen';
     readonly invalid?: boolean;
     readonly edge?: boolean;
@@ -897,6 +1107,223 @@ export interface NlBsnData {
     readonly value: string;
     readonly digits: string;
 }
+export interface NlPersonOptions extends PersonConstraintOptions {
+    /** Bias the BSN and name shape toward their rare corners. */
+    readonly edge?: boolean;
+    /** Mangle the casing of `name`/`surname` for testing. Defaults to `true`. */
+    readonly caseStrict?: boolean;
+}
+export interface NlPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly bsn: string;
+}
+/**
+ * Options shared by every full-person generator (`bePerson`, `frPerson`,
+ * `itPerson`, …): the person constraints (`sex`, age/birth-date filters,
+ * `invalid`) plus `edge` and `caseStrict`. The matching national number is
+ * carried on each country's own `*PersonData` result.
+ */
+export interface FullPersonOptions extends PersonConstraintOptions {
+    /** Bias the number and name shape toward their rarely-exercised corners. */
+    readonly edge?: boolean;
+    /** Mangle the casing of `name`/`surname` for testing. Defaults to `true`. */
+    readonly caseStrict?: boolean;
+}
+export type BePersonOptions = FullPersonOptions;
+export interface BePersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly rijksregisternummer: string;
+}
+export type BgPersonOptions = FullPersonOptions;
+export interface BgPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly egn: string;
+}
+export type CzPersonOptions = FullPersonOptions;
+export interface CzPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly rodneCislo: string;
+}
+export type EePersonOptions = FullPersonOptions;
+export interface EePersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly isikukood: string;
+}
+export type FiPersonOptions = FullPersonOptions;
+export interface FiPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly henkilotunnus: string;
+}
+export type GrPersonOptions = FullPersonOptions;
+export interface GrPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly amka: string;
+}
+export type HrPersonOptions = FullPersonOptions;
+export interface HrPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly jmbg: string;
+}
+export type HuPersonOptions = FullPersonOptions;
+export interface HuPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly szemelyiAzonosito: string;
+}
+export type LtPersonOptions = FullPersonOptions;
+export interface LtPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly asmensKodas: string;
+}
+export type RoPersonOptions = FullPersonOptions;
+export interface RoPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly cnp: string;
+}
+export type SePersonOptions = FullPersonOptions;
+export interface SePersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly personnummer: string;
+}
+export type SiPersonOptions = FullPersonOptions;
+export interface SiPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly emso: string;
+}
+export type SkPersonOptions = FullPersonOptions;
+export interface SkPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly rodneCislo: string;
+}
+export type AtPersonOptions = FullPersonOptions;
+export interface AtPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly svnr: string;
+}
+export type LuPersonOptions = FullPersonOptions;
+export interface LuPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly matricule: string;
+}
+export type FrPersonOptions = FullPersonOptions;
+export interface FrPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly nir: string;
+}
+export type ItPersonOptions = FullPersonOptions;
+export interface ItPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly codiceFiscale: string;
+}
+export type CyPersonOptions = FullPersonOptions;
+export interface CyPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly tic: string;
+}
+export type DePersonOptions = FullPersonOptions;
+export interface DePersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly steuerId: string;
+}
+export type EsPersonOptions = FullPersonOptions;
+export interface EsPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly dni: string;
+}
+export type IePersonOptions = FullPersonOptions;
+export interface IePersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly ppsn: string;
+}
+export type MtPersonOptions = FullPersonOptions;
+export interface MtPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly idCard: string;
+}
+export type PtPersonOptions = FullPersonOptions;
+export interface PtPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly cartaoCidadao: string;
+}
+export type LvPersonOptions = FullPersonOptions;
+export interface LvPersonData {
+    readonly name: string;
+    readonly surname: string;
+    readonly initials: string;
+    readonly birthDate: string;
+    readonly personasKods: string;
+}
 export interface NlRsinOptions extends RequestOptions {
     readonly invalid?: boolean;
     readonly edge?: boolean;
@@ -906,7 +1333,7 @@ export interface NlRsinData {
     readonly digits: string;
 }
 export interface NlBtwIdOptions extends RequestOptions {
-    readonly standard?: 'legacy' | 'modern';
+    readonly standard?: 'legacy' | 'modern' | 'both';
     readonly invalid?: boolean;
     readonly edge?: boolean;
 }