@isvalid-dev/sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,808 @@
+interface RetryConfig {
+    maxRetries?: number;
+    initialDelayMs?: number;
+    maxDelayMs?: number;
+    retryOn?: number[];
+}
+interface IsValidConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+    retry?: RetryConfig | false;
+}
+
+interface LeiEntity {
+    legalName: string;
+    country: string | null;
+    entityStatus: string | null;
+    registrationStatus: string | null;
+    category: string | null;
+    initialRegistrationDate: string | null;
+    lastUpdate: string | null;
+    nextRenewal: string | null;
+    managingLou: string | null;
+}
+interface LeiLou {
+    lei: string;
+    name: string;
+    country: string | null;
+    status: string | null;
+}
+type LeiResponse = {
+    valid: false;
+} | {
+    valid: true;
+    lei: string;
+    louCode: string;
+    checkDigits: string;
+    found: boolean | null;
+    dataSource: 'gleif-db' | 'gleif-api' | null;
+    entity: LeiEntity | null;
+    lou: LeiLou | null;
+};
+interface LeiSearchOptions {
+    country?: string;
+    entityStatus?: string;
+    page?: number;
+    limit?: number;
+}
+interface LeiSearchResult {
+    lei: string;
+    legalName: string;
+    country: string | null;
+    entityStatus: string | null;
+    registrationStatus: string | null;
+    category: string | null;
+}
+interface LeiSearchResponse {
+    results: LeiSearchResult[];
+    page: number;
+    limit: number;
+    total: number;
+}
+interface LeiLouItem {
+    louCode: string;
+    lei: string;
+    name: string;
+    country: string | null;
+    status: string | null;
+}
+interface LeiLousResponse {
+    lous: LeiLouItem[];
+    total: number;
+}
+
+interface LeiNamespace {
+    (value: string): Promise<LeiResponse>;
+    search(query: string, opts?: LeiSearchOptions): Promise<LeiSearchResponse>;
+    lous(): Promise<LeiLousResponse>;
+}
+
+type CountryResponse = {
+    valid: false;
+} | {
+    valid: true;
+    value: string;
+    format: 'alpha-2' | 'alpha-3' | 'numeric';
+    alpha2: string;
+    alpha3: string;
+    numeric: string;
+    name: string;
+};
+interface CountryListItem {
+    alpha2: string;
+    alpha3: string;
+    numeric: string;
+    name: string;
+}
+
+interface CountryNamespace {
+    (value: string): Promise<CountryResponse>;
+    list(): Promise<CountryListItem[]>;
+}
+
+type CurrencyResponse = {
+    valid: false;
+} | {
+    valid: true;
+    format: 'alpha' | 'numeric';
+    code: string;
+    numericCode: string;
+    name: string;
+    minorUnit: number | null;
+};
+interface CurrencyListItem {
+    code: string;
+    numericCode: string;
+    name: string;
+    minorUnit: number | null;
+}
+
+interface CurrencyNamespace {
+    (value: string): Promise<CurrencyResponse>;
+    list(): Promise<CurrencyListItem[]>;
+}
+
+type LanguageResponse = {
+    valid: false;
+} | {
+    valid: true;
+    format: 'alpha-2' | 'alpha-3';
+    alpha2: string | null;
+    alpha3: string;
+    name: string;
+};
+interface LanguageListItem {
+    alpha2: string | null;
+    alpha3: string;
+    name: string;
+}
+
+interface LanguageNamespace {
+    (value: string): Promise<LanguageResponse>;
+    list(): Promise<LanguageListItem[]>;
+}
+
+type IataFlightResponse = {
+    valid: false;
+} | {
+    valid: true;
+    airlineCode: string;
+    flightNumber: string;
+    suffix: string | null;
+};
+type IataAirlineResponse = {
+    valid: false;
+} | {
+    valid: true;
+    found: boolean;
+    iataCode?: string;
+    icaoCode?: string | null;
+    name?: string;
+    country?: string | null;
+};
+interface IataAirlineListItem {
+    iataCode: string;
+    icaoCode: string | null;
+    name: string;
+    country: string | null;
+}
+type IataAirportResponse = {
+    valid: false;
+} | {
+    valid: true;
+    found: boolean;
+    iataCode?: string;
+    name?: string;
+    city?: string | null;
+    country?: string | null;
+};
+
+interface IataAirlineNamespace {
+    (value: string): Promise<IataAirlineResponse>;
+    list(): Promise<IataAirlineListItem[]>;
+}
+interface IataNamespace {
+    flight(value: string): Promise<IataFlightResponse>;
+    airline: IataAirlineNamespace;
+    airport(value: string): Promise<IataAirportResponse>;
+}
+
+type IpResponse = {
+    valid: false;
+} | {
+    valid: true;
+    version: 4 | 6;
+    type: string;
+    expanded?: string;
+};
+type MacResponse = {
+    valid: false;
+} | {
+    valid: true;
+    normalized: string;
+    type: string;
+    isLocal: boolean;
+    isBroadcast: boolean;
+};
+
+interface NetNamespace {
+    ip(value: string): Promise<IpResponse>;
+    mac(value: string): Promise<MacResponse>;
+}
+
+type PeselResponse = {
+    valid: false;
+} | {
+    valid: true;
+    birthDate: string;
+    gender: 'male' | 'female';
+    isOver15: boolean;
+    isOver18: boolean;
+    isOver21: boolean;
+};
+interface RegonLookup {
+    checked: boolean;
+    found?: boolean;
+    reason?: string;
+    name?: string | null;
+    nip?: string | null;
+    voivodeship?: string | null;
+    district?: string | null;
+    community?: string | null;
+    city?: string | null;
+    postalCode?: string | null;
+    street?: string | null;
+    houseNumber?: string | null;
+    flatNumber?: string | null;
+    activityEndDate?: string | null;
+}
+type RegonResponse = {
+    valid: false;
+} | {
+    valid: true;
+    type: 'entity' | 'local-unit';
+    regon?: RegonLookup;
+};
+interface KrsAddress {
+    city: string | null;
+    voivodeship: string | null;
+    street: string | null;
+    houseNumber: string | null;
+    flatNumber: string | null;
+    postalCode: string | null;
+    country: string | null;
+    website: string | null;
+}
+interface KrsLookup {
+    checked: boolean;
+    found?: boolean;
+    reason?: string;
+    krs?: string | null;
+    registry?: string;
+    name?: string | null;
+    legalForm?: string | null;
+    nip?: string | null;
+    regon?: string | null;
+    hasOppStatus?: boolean | null;
+    registeredAt?: string | null;
+    dataAsOf?: string | null;
+    lastEntryAt?: string | null;
+    address?: KrsAddress | null;
+}
+type KrsResponse = {
+    valid: false;
+} | {
+    valid: true;
+    number: string;
+    krs?: KrsLookup;
+};
+
+interface PlNamespace {
+    pesel(value: string): Promise<PeselResponse>;
+    regon(value: string, opts?: {
+        lookup?: boolean;
+    }): Promise<RegonResponse>;
+    krs(value: string, opts?: {
+        lookup?: boolean;
+    }): Promise<KrsResponse>;
+}
+
+type CnpjResponse = {
+    valid: false;
+} | {
+    valid: true;
+    normalized: string;
+    type: 'matriz' | 'filial';
+};
+type CpfResponse = {
+    valid: false;
+} | {
+    valid: true;
+    normalized: string;
+};
+
+interface BrNamespace {
+    cnpj(value: string): Promise<CnpjResponse>;
+    cpf(value: string): Promise<CpfResponse>;
+}
+
+type AbnResponse = {
+    valid: false;
+} | {
+    valid: true;
+    normalized: string;
+};
+
+interface AuNamespace {
+    abn(value: string): Promise<AbnResponse>;
+}
+
+type NifResponse = {
+    valid: false;
+} | {
+    valid: true;
+    type: string;
+    normalized: string;
+};
+
+interface EsNamespace {
+    nif(value: string): Promise<NifResponse>;
+}
+
+type GstinResponse = {
+    valid: false;
+} | {
+    valid: true;
+    stateCode: string;
+    stateName: string | null;
+    pan: string;
+    entityType: string;
+    checkDigit: string;
+};
+
+interface InNamespace {
+    gstin(value: string): Promise<GstinResponse>;
+}
+
+type NpiResponse = {
+    valid: false;
+} | {
+    valid: true;
+    normalized: string;
+};
+
+interface UsNamespace {
+    npi(value: string): Promise<NpiResponse>;
+}
+
+type SortCodeResponse = {
+    valid: false;
+} | {
+    valid: true;
+    normalized: string;
+    formatted: string;
+};
+
+interface GbNamespace {
+    sortCode(value: string): Promise<SortCodeResponse>;
+}
+
+type EmailResponse = {
+    valid: false;
+} | {
+    valid: true;
+    local: string;
+    domain: string;
+    mxValid?: boolean;
+};
+type IbanResponse = {
+    valid: false;
+} | {
+    valid: true;
+    countryCode: string;
+    countryName: string;
+    bban: string;
+    isEU: boolean;
+    formatted: string;
+    bankCode: string | null;
+    bankName: string | null;
+    bankBic: string | null;
+};
+type IsinResponse = {
+    valid: false;
+} | {
+    valid: true;
+    countryCode: string;
+    countryName: string | null;
+    nsin: string;
+    cusip: string | null;
+    checkDigit: string;
+    found: boolean | null;
+    dataSource?: 'firds' | 'openfigi' | 'firds+openfigi';
+    name?: string | null;
+    fisn?: string | null;
+    cfiCode?: string | null;
+    currency?: string | null;
+    tradingVenue?: string | null;
+    issuerLei?: string | null;
+    maturityDate?: string | null;
+    status?: string | null;
+    ticker?: string | null;
+    exchCode?: string | null;
+    securityType?: string | null;
+    marketSector?: string | null;
+    figi?: string | null;
+    compositeFIGI?: string | null;
+};
+type DtiResponse = {
+    valid: false;
+} | {
+    valid: true;
+    normalized: string;
+    payload: string;
+    checkChar: string;
+    found: boolean | null;
+    identifierType?: string;
+    name?: string | null;
+    shortName?: string | null;
+    dtiType?: number | null;
+};
+type VatResponse = {
+    valid: false;
+} | {
+    valid: true;
+    normalized: string;
+    countryCode: string;
+    countryName: string;
+    isEU: boolean;
+    vies?: {
+        checked: boolean;
+        valid?: boolean;
+        name?: string | null;
+        address?: string | null;
+        reason?: string;
+    };
+};
+type GpsResponse = {
+    valid: false;
+} | {
+    valid: true;
+    format: 'dd' | 'dms' | 'ddm' | 'geo-uri';
+    lat: number;
+    lon: number;
+    latDir: 'N' | 'S';
+    lonDir: 'E' | 'W';
+    dms: {
+        lat: string;
+        lon: string;
+    };
+};
+type PhoneResponse = {
+    valid: false;
+} | {
+    valid: true;
+    countryCode: string | null;
+    callingCode: string;
+    nationalNumber: string;
+    type: string;
+    e164: string;
+    national: string;
+    international: string;
+};
+type UrlResponse = {
+    valid: false;
+} | {
+    valid: true;
+    protocol: string;
+    domain: string;
+    path: string;
+    query: Record<string, string | string[]>;
+    port: string | null;
+    hash: string | null;
+};
+type EanResponse = {
+    valid: false;
+} | {
+    valid: true;
+    format: string;
+    prefix?: string;
+    prefixCountry?: string;
+    upcA?: string;
+    indicator?: string;
+};
+type IsbnResponse = {
+    valid: false;
+} | {
+    valid: true;
+    format: 'ISBN-10' | 'ISBN-13';
+    isbn10: string | null;
+    isbn13: string;
+};
+type IssnResponse = {
+    valid: false;
+} | {
+    valid: true;
+    issn: string;
+};
+type BicResponse = {
+    valid: false;
+} | {
+    valid: true;
+    bankCode: string;
+    countryCode: string;
+    countryName: string | null;
+    locationCode: string;
+    branchCode: string | null;
+    bankName: string | null;
+    city: string | null;
+    branch: string | null;
+};
+type CusipResponse = {
+    valid: false;
+} | {
+    valid: true;
+    issuerNumber: string;
+    issueNumber: string;
+    checkDigit: string;
+};
+type CfiResponse = {
+    valid: false;
+} | {
+    valid: true;
+    cfi: string;
+    category: string;
+    categoryName: string;
+    group: string;
+    groupName: string | null;
+    attributes: Array<{
+        position: number;
+        code: string;
+        name: string | null;
+        value: string | null;
+    }>;
+};
+type MicResponse = {
+    valid: false;
+} | {
+    valid: true;
+    found: boolean;
+    mic?: string;
+    operatingMic?: string;
+    name?: string;
+    type?: string;
+    status?: string;
+    countryCode?: string;
+    countryName?: string | null;
+    city?: string;
+    website?: string | null;
+};
+type NutsResponse = {
+    valid: false;
+} | {
+    valid: true;
+    code: string;
+    level: number;
+    country: string;
+    countryName: string | null;
+    regionName: string | null;
+};
+type UuidResponse = {
+    valid: false;
+} | {
+    valid: true;
+    version: number;
+};
+type JwtResponse = {
+    valid: false;
+} | {
+    valid: true;
+    algorithm: string;
+    header: Record<string, unknown>;
+    payload: Record<string, unknown>;
+    issuedAt: string | null;
+    expiresAt: string | null;
+    expired: boolean | null;
+};
+type VinResponse = {
+    valid: false;
+} | {
+    valid: true;
+    wmi: string;
+    vds: string;
+    checkDigit: string;
+    vin: string;
+    country: string | null;
+    region: string | null;
+    manufacturer: string | null;
+    modelYearCandidates: number[];
+    serialNumber: string;
+};
+type ImeiResponse = {
+    valid: false;
+} | {
+    valid: true;
+    tac: string;
+    snr: string;
+    checkDigit: string;
+};
+type SemverResponse = {
+    valid: false;
+} | {
+    valid: true;
+    major: number;
+    minor: number;
+    patch: number;
+    prerelease: string[] | null;
+    build: string[] | null;
+};
+type ColorResponse = {
+    valid: false;
+} | {
+    valid: true;
+    format: string;
+    r: number;
+    g: number;
+    b: number;
+    h: number;
+    s: number;
+    l: number;
+    alpha: number;
+    hex: string;
+};
+type BooleanResponse = {
+    valid: false;
+} | {
+    valid: true;
+    normalized: boolean;
+};
+type DateResponse = {
+    valid: false;
+} | {
+    valid: true;
+    iso: string;
+};
+type BtcAddressResponse = {
+    valid: false;
+} | {
+    valid: true;
+    type: string;
+};
+type PostalCodeResponse = {
+    valid: false;
+} | {
+    valid: true;
+    country?: string;
+    countryName?: string | null;
+    format?: string;
+    location?: {
+        city: string;
+        region: string | null;
+        subregion: string | null;
+        lat: number | null;
+        lon: number | null;
+    } | null;
+    matchingCountries?: Array<{
+        country: string;
+        countryName: string | null;
+        format: string;
+    }>;
+};
+type AbaResponse = {
+    valid: false;
+} | {
+    valid: true;
+    routingNumber: string;
+    checkDigit: string;
+};
+type Iso6346Response = {
+    valid: false;
+} | {
+    valid: true;
+    ownerCode: string;
+    equipmentCategory: string;
+    serialNumber: string;
+    checkDigit: string;
+};
+type SsccResponse = {
+    valid: false;
+} | {
+    valid: true;
+    extensionDigit: string;
+    gsPrefix: string;
+    serialRef: string;
+    checkDigit: string;
+};
+type GlnResponse = {
+    valid: false;
+} | {
+    valid: true;
+    prefix: string;
+    locationRef: string;
+    checkDigit: string;
+};
+type QrResponse = {
+    valid: boolean;
+    format?: string;
+    data?: Record<string, unknown>;
+    error?: string;
+};
+type CreditCardResponse = {
+    valid: false;
+} | {
+    valid: true;
+    type: string;
+};
+
+declare class IsValidError extends Error {
+    readonly status: number;
+    readonly body: {
+        error: string;
+    };
+    constructor(status: number, body: {
+        error: string;
+    });
+}
+declare class IsValidAuthError extends IsValidError {
+    constructor(body: {
+        error: string;
+    });
+}
+declare class IsValidRateLimitError extends IsValidError {
+    readonly retryAfter: number | null;
+    constructor(body: {
+        error: string;
+    }, retryAfter?: number | null);
+}
+
+type InvalidResponse = {
+    valid: false;
+};
+
+declare class IsValid {
+    private readonly client;
+    readonly lei: LeiNamespace;
+    readonly country: CountryNamespace;
+    readonly currency: CurrencyNamespace;
+    readonly language: LanguageNamespace;
+    readonly iata: IataNamespace;
+    readonly net: NetNamespace;
+    readonly pl: PlNamespace;
+    readonly br: BrNamespace;
+    readonly au: AuNamespace;
+    readonly es: EsNamespace;
+    readonly in: InNamespace;
+    readonly us: UsNamespace;
+    readonly gb: GbNamespace;
+    constructor(config: IsValidConfig);
+    email(value: string, opts?: {
+        checkMx?: boolean;
+    }): Promise<EmailResponse>;
+    iban(value: string, opts?: {
+        countryCode?: string;
+    }): Promise<IbanResponse>;
+    isin(value: string): Promise<IsinResponse>;
+    dti(value: string): Promise<DtiResponse>;
+    vat(value: string, opts?: {
+        countryCode?: string;
+        checkVies?: boolean;
+    }): Promise<VatResponse>;
+    gps(value: string): Promise<GpsResponse>;
+    phone(value: string, opts?: {
+        countryCode?: string;
+    }): Promise<PhoneResponse>;
+    url(value: string): Promise<UrlResponse>;
+    ean(value: string): Promise<EanResponse>;
+    isbn(value: string): Promise<IsbnResponse>;
+    issn(value: string): Promise<IssnResponse>;
+    bic(value: string): Promise<BicResponse>;
+    cusip(value: string): Promise<CusipResponse>;
+    cfi(value: string): Promise<CfiResponse>;
+    mic(value: string): Promise<MicResponse>;
+    nuts(value: string): Promise<NutsResponse>;
+    uuid(value: string, opts?: {
+        version?: number;
+    }): Promise<UuidResponse>;
+    jwt(value: string): Promise<JwtResponse>;
+    vin(value: string): Promise<VinResponse>;
+    imei(value: string): Promise<ImeiResponse>;
+    semver(value: string): Promise<SemverResponse>;
+    color(value: string): Promise<ColorResponse>;
+    boolean(value: string): Promise<BooleanResponse>;
+    date(value: string, opts?: {
+        format?: string;
+    }): Promise<DateResponse>;
+    btcAddress(value: string): Promise<BtcAddressResponse>;
+    postalCode(value: string, opts?: {
+        countryCode?: string;
+    }): Promise<PostalCodeResponse>;
+    aba(value: string): Promise<AbaResponse>;
+    iso6346(value: string): Promise<Iso6346Response>;
+    sscc(value: string): Promise<SsccResponse>;
+    gln(value: string): Promise<GlnResponse>;
+    qr(value: string): Promise<QrResponse>;
+    creditCard(number: string): Promise<CreditCardResponse>;
+}
+declare function createClient(config: IsValidConfig): IsValid;
+
+export { type AbaResponse, type AbnResponse, type AuNamespace, type BicResponse, type BooleanResponse, type BrNamespace, type BtcAddressResponse, type CfiResponse, type CnpjResponse, type ColorResponse, type CountryListItem, type CountryNamespace, type CountryResponse, type CpfResponse, type CreditCardResponse, type CurrencyListItem, type CurrencyNamespace, type CurrencyResponse, type CusipResponse, type DateResponse, type DtiResponse, type EanResponse, type EmailResponse, type EsNamespace, type GbNamespace, type GlnResponse, type GpsResponse, type GstinResponse, type IataAirlineListItem, type IataAirlineNamespace, type IataAirlineResponse, type IataAirportResponse, type IataFlightResponse, type IataNamespace, type IbanResponse, type ImeiResponse, type InNamespace, type InvalidResponse, type IpResponse, IsValid, IsValidAuthError, type IsValidConfig, IsValidError, IsValidRateLimitError, type IsbnResponse, type IsinResponse, type Iso6346Response, type IssnResponse, type JwtResponse, type KrsAddress, type KrsLookup, type KrsResponse, type LanguageListItem, type LanguageNamespace, type LanguageResponse, type LeiEntity, type LeiLou, type LeiLouItem, type LeiLousResponse, type LeiNamespace, type LeiResponse, type LeiSearchOptions, type LeiSearchResponse, type LeiSearchResult, type MacResponse, type MicResponse, type NetNamespace, type NifResponse, type NpiResponse, type NutsResponse, type PeselResponse, type PhoneResponse, type PlNamespace, type PostalCodeResponse, type QrResponse, type RegonLookup, type RegonResponse, type RetryConfig, type SemverResponse, type SortCodeResponse, type SsccResponse, type UrlResponse, type UsNamespace, type UuidResponse, type VatResponse, type VinResponse, createClient };