@isvalid-dev/sdk 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -205,10 +205,32 @@ type MacResponse = {
     isLocal: boolean;
     isBroadcast: boolean;
 };
+type NetPortResponse = {
+    valid: false;
+} | {
+    valid: true;
+    port: number;
+    range: string;
+    wellKnown: boolean;
+    serviceName: string | null;
+    protocol: string | null;
+    description: string | null;
+};
+type NetPortListItem = {
+    port: number;
+    serviceName: string;
+    protocol: string;
+    description: string;
+};
 
+interface NetPortNamespace {
+    (value: string): Promise<NetPortResponse>;
+    list(): Promise<NetPortListItem[]>;
+}
 interface NetNamespace {
     ip(value: string): Promise<IpResponse>;
     mac(value: string): Promise<MacResponse>;
+    port: NetPortNamespace;
 }
 
 type PeselResponse = {
@@ -368,6 +390,245 @@ interface GbNamespace {
     sortCode(value: string): Promise<SortCodeResponse>;
 }
 
+type HsCodeResponse = {
+    valid: false;
+    code?: string;
+    level?: string;
+    error?: string;
+} | {
+    valid: true;
+    code: string;
+    level: string;
+    description: string;
+    formatted: string;
+    chapter?: {
+        code: string;
+        description: string;
+    } | null;
+    heading?: {
+        code: string;
+        description: string;
+    } | null;
+};
+interface HsCodeListItem {
+    code: string;
+    level: string;
+    description: string;
+}
+type HsCodeListResponse = HsCodeListItem[];
+
+interface HsCodeNamespace {
+    (value: string): Promise<HsCodeResponse>;
+    list(opts?: {
+        chapter?: string;
+        level?: string;
+    }): Promise<HsCodeListResponse>;
+}
+
+type Gs1PrefixResponse = {
+    valid: false;
+    prefix?: string;
+    error?: string;
+} | {
+    valid: true;
+    prefix: string;
+    country: string;
+    inputType?: string;
+};
+interface Gs1PrefixListItem {
+    rangeStart: string;
+    rangeEnd: string;
+    country: string;
+}
+type Gs1PrefixListResponse = Gs1PrefixListItem[];
+
+interface Gs1PrefixNamespace {
+    (value: string): Promise<Gs1PrefixResponse>;
+    list(): Promise<Gs1PrefixListResponse>;
+}
+
+type IndustryResponse = {
+    valid: false;
+    error?: string;
+    suggestedSystem?: string;
+} | {
+    valid: true;
+    system: string;
+    edition: string;
+    code: string;
+    description: string;
+    level: string;
+    parent: string | null;
+    hierarchy: Array<{
+        code: string;
+        description: string;
+    }>;
+};
+interface IndustryListItem {
+    code: string;
+    level: string;
+    parent: string | null;
+    description: string;
+}
+type IndustryListResponse = IndustryListItem[];
+
+interface IndustryNamespace {
+    (value: string, opts?: {
+        system?: string;
+    }): Promise<IndustryResponse>;
+    list(opts: {
+        system: string;
+        level?: string;
+        parent?: string;
+    }): Promise<IndustryListResponse>;
+}
+
+type TimezoneResponse = {
+    valid: false;
+} | {
+    valid: true;
+    timezone: string;
+    region: string | null;
+    utcOffset: string;
+    abbreviation: string | null;
+    isDST: boolean;
+};
+type TimezoneListItem = {
+    timezone: string;
+    region: string | null;
+    utcOffset: string;
+    abbreviation: string | null;
+    isDST: boolean;
+};
+
+interface TimezoneNamespace {
+    (value: string): Promise<TimezoneResponse>;
+    list(opts?: {
+        region?: string;
+    }): Promise<TimezoneListItem[]>;
+}
+
+type MimeTypeResponse = {
+    valid: false;
+    type?: string;
+    subtype?: string;
+} | {
+    valid: true;
+    mime: string;
+    type: string;
+    subtype: string;
+    extensions: string[];
+    compressible: boolean | null;
+    charset: string | null;
+    source: string | null;
+};
+type MimeTypeExtResponse = {
+    valid: false;
+    extension?: string;
+} | {
+    valid: true;
+    extension: string;
+    mimeTypes: Array<{
+        mime: string;
+        type: string;
+        subtype: string;
+        extensions: string[];
+        compressible: boolean | null;
+        charset: string | null;
+        source: string | null;
+    }>;
+};
+type MimeTypeListItem = {
+    mime: string;
+    type: string;
+    subtype: string;
+    extensions: string[];
+};
+
+interface MimeTypeNamespace {
+    (value: string): Promise<MimeTypeResponse>;
+    ext(value: string): Promise<MimeTypeExtResponse>;
+    list(opts?: {
+        type?: string;
+    }): Promise<MimeTypeListItem[]>;
+}
+
+type HttpStatusResponse = {
+    valid: false;
+} | {
+    valid: true;
+    code: number;
+    reasonPhrase: string;
+    category: string;
+};
+type HttpStatusListItem = {
+    code: number;
+    reasonPhrase: string;
+    category: string;
+};
+
+interface HttpStatusNamespace {
+    (value: string): Promise<HttpStatusResponse>;
+    list(): Promise<HttpStatusListItem[]>;
+}
+
+type SwiftMtResponse = {
+    valid: false;
+} | {
+    valid: true;
+    type: string;
+    category: number;
+    group: string;
+    description: string;
+};
+type SwiftMtListItem = {
+    type: string;
+    category: number;
+    group: string;
+    description: string;
+};
+
+interface SwiftMtNamespace {
+    (value: string): Promise<SwiftMtResponse>;
+    list(opts?: {
+        category?: number;
+    }): Promise<SwiftMtListItem[]>;
+}
+
+type LocodeResponse = {
+    valid: false;
+} | {
+    valid: true;
+    locode: string;
+    country: string;
+    location: string;
+    name: string | null;
+    nameAscii: string | null;
+    subdivision: string | null;
+    functions: string[];
+    iata: string | null;
+    coordinates: string | null;
+    found: boolean;
+};
+type LocodeListItem = {
+    locode: string;
+    country: string;
+    location: string;
+    name: string;
+    nameAscii: string;
+    subdivision: string | null;
+    functions: string[];
+    iata: string | null;
+    coordinates: string | null;
+};
+
+interface LocodeNamespace {
+    (value: string): Promise<LocodeResponse>;
+    list(opts: {
+        country: string;
+    }): Promise<LocodeListItem[]>;
+}
+
 type EmailResponse = {
     valid: false;
 } | {
@@ -713,6 +974,132 @@ type CreditCardResponse = {
     valid: true;
     type: string;
 };
+type CasResponse = {
+    valid: false;
+    error?: string;
+} | {
+    valid: true;
+    formatted: string;
+};
+type EoriResponse = {
+    valid: false;
+    countryCode?: string;
+    country?: string;
+    error?: string;
+} | {
+    valid: true;
+    countryCode: string;
+    country: string;
+    identifier: string;
+    formatted: string;
+    ec?: {
+        checked: boolean;
+        valid?: boolean;
+        statusDescr?: string | null;
+        name?: string | null;
+        street?: string | null;
+        postalCode?: string | null;
+        city?: string | null;
+        reason?: string;
+    };
+};
+type OrcidResponse = {
+    valid: false;
+    error?: string;
+} | {
+    valid: true;
+    formatted: string;
+    uri: string;
+    profile?: {
+        found: boolean;
+        givenNames?: string | null;
+        familyName?: string | null;
+        organization?: string | null;
+        reason?: string;
+    };
+};
+type DoiResponse = {
+    valid: false;
+    error?: string;
+} | {
+    valid: true;
+    doi: string;
+    prefix: string;
+    suffix: string;
+    registrantCode: string;
+    registrant?: string;
+    url: string;
+    metadata?: {
+        found: boolean;
+        title?: string | null;
+        authors?: string[] | null;
+        publisher?: string | null;
+        type?: string | null;
+        issued?: unknown;
+        reason?: string;
+    };
+};
+type BarcodeResponse = {
+    valid: false;
+    error?: string;
+} | {
+    valid: true;
+    type: string;
+    data: string;
+    hasCheckDigit?: boolean;
+    checkDigitValid?: boolean | null;
+    encoding?: string;
+    indicator?: string;
+    length?: number;
+};
+type Base64Response = {
+    valid: false;
+    error?: string;
+} | {
+    valid: true;
+    variant: 'standard' | 'url-safe' | 'ambiguous';
+    isPadded: boolean;
+    decodedLength: number;
+};
+type EthAddressResponse = {
+    valid: false;
+} | {
+    valid: true;
+    address: string;
+    isChecksumValid: boolean;
+};
+type CronResponse = {
+    valid: false;
+} | {
+    valid: true;
+    expression: string;
+    fields: number;
+    hasSeconds: boolean;
+    humanReadable: string | null;
+    nextRun: string;
+    nextRuns: string[];
+};
+type DomainResponse = {
+    valid: false;
+} | {
+    valid: true;
+    domain: string;
+    tld: string;
+    sld: string | null;
+    isIDN: boolean;
+    dnsValid: boolean;
+    hasA: boolean;
+    hasAAAA: boolean;
+};
+type RegexResponse = {
+    valid: false;
+    error?: string;
+} | {
+    valid: true;
+    pattern: string;
+    flags: string | null;
+    namedGroups: string[];
+};
 
 declare class IsValidError extends Error {
     readonly status: number;
@@ -754,6 +1141,14 @@ declare class IsValid {
     readonly in: InNamespace;
     readonly us: UsNamespace;
     readonly gb: GbNamespace;
+    readonly hsCode: HsCodeNamespace;
+    readonly gs1Prefix: Gs1PrefixNamespace;
+    readonly industry: IndustryNamespace;
+    readonly timezone: TimezoneNamespace;
+    readonly mimeType: MimeTypeNamespace;
+    readonly httpStatus: HttpStatusNamespace;
+    readonly swiftMt: SwiftMtNamespace;
+    readonly locode: LocodeNamespace;
     constructor(config: IsValidConfig);
     email(value: string, opts?: {
         checkMx?: boolean;
@@ -802,7 +1197,27 @@ declare class IsValid {
     gln(value: string): Promise<GlnResponse>;
     qr(value: string): Promise<QrResponse>;
     creditCard(number: string): Promise<CreditCardResponse>;
+    cas(value: string): Promise<CasResponse>;
+    eori(value: string, opts?: {
+        check?: boolean;
+    }): Promise<EoriResponse>;
+    orcid(value: string, opts?: {
+        lookup?: boolean;
+    }): Promise<OrcidResponse>;
+    doi(value: string, opts?: {
+        lookup?: boolean;
+    }): Promise<DoiResponse>;
+    barcode(value: string, opts?: {
+        type?: string;
+    }): Promise<BarcodeResponse>;
+    base64(value: string): Promise<Base64Response>;
+    ethAddress(value: string): Promise<EthAddressResponse>;
+    cron(value: string): Promise<CronResponse>;
+    domain(value: string): Promise<DomainResponse>;
+    regex(pattern: string, opts?: {
+        flags?: string;
+    }): Promise<RegexResponse>;
 }
 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 ContainerCodeResponse, 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 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 };
+export { type AbaResponse, type AbnResponse, type AuNamespace, type BarcodeResponse, type Base64Response, type BicResponse, type BooleanResponse, type BrNamespace, type BtcAddressResponse, type CasResponse, type CfiResponse, type CnpjResponse, type ColorResponse, type ContainerCodeResponse, type CountryListItem, type CountryNamespace, type CountryResponse, type CpfResponse, type CreditCardResponse, type CronResponse, type CurrencyListItem, type CurrencyNamespace, type CurrencyResponse, type CusipResponse, type DateResponse, type DoiResponse, type DomainResponse, type DtiResponse, type EanResponse, type EmailResponse, type EoriResponse, type EsNamespace, type EthAddressResponse, type GbNamespace, type GlnResponse, type GpsResponse, type Gs1PrefixListItem, type Gs1PrefixListResponse, type Gs1PrefixNamespace, type Gs1PrefixResponse, type GstinResponse, type HsCodeListItem, type HsCodeListResponse, type HsCodeNamespace, type HsCodeResponse, type HttpStatusListItem, type HttpStatusNamespace, type HttpStatusResponse, type IataAirlineListItem, type IataAirlineNamespace, type IataAirlineResponse, type IataAirportResponse, type IataFlightResponse, type IataNamespace, type IbanResponse, type ImeiResponse, type InNamespace, type IndustryListItem, type IndustryListResponse, type IndustryNamespace, type IndustryResponse, type InvalidResponse, type IpResponse, IsValid, IsValidAuthError, type IsValidConfig, IsValidError, IsValidRateLimitError, type IsbnResponse, type IsinResponse, 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 LocodeListItem, type LocodeNamespace, type LocodeResponse, type MacResponse, type MicResponse, type MimeTypeExtResponse, type MimeTypeListItem, type MimeTypeNamespace, type MimeTypeResponse, type NetNamespace, type NetPortListItem, type NetPortNamespace, type NetPortResponse, type NifResponse, type NpiResponse, type NutsResponse, type OrcidResponse, type PeselResponse, type PhoneResponse, type PlNamespace, type PostalCodeResponse, type QrResponse, type RegexResponse, type RegonLookup, type RegonResponse, type RetryConfig, type SemverResponse, type SortCodeResponse, type SsccResponse, type SwiftMtListItem, type SwiftMtNamespace, type SwiftMtResponse, type TimezoneListItem, type TimezoneNamespace, type TimezoneResponse, type UrlResponse, type UsNamespace, type UuidResponse, type VatResponse, type VinResponse, createClient };