@parseapi/sdk 0.1.1 → 0.1.3

package/dist/index.d.ts

@@ -15,6 +15,7 @@ interface IpDeep {
     datacenter: boolean;
     relay: boolean;
     tor: boolean;
+    vpn: boolean;
     provider: string;
 }
 interface Ip {
@@ -38,11 +39,29 @@ interface Continent {
 interface ContinentCountryItem {
     country: string;
     name: string;
+    emoji?: string | null;
+    calling_code?: string | null;
 }
 interface ContinentCountries {
     continent: string;
     countries: ContinentCountryItem[];
 }
+interface Bloc {
+    bloc: string;
+    name: string;
+    /** Current member count. An entity fact, not a list-length field. */
+    members: number;
+}
+interface BlocCountryItem {
+    country: string;
+    name: string;
+    emoji?: string | null;
+    calling_code?: string | null;
+}
+interface BlocCountries {
+    bloc: string;
+    countries: BlocCountryItem[];
+}
 interface Country {
     country: string;
     iso3: string;
@@ -52,6 +71,8 @@ interface Country {
     local_name: string | null;
     demonym: string | null;
     capital: string | null;
+    capital_lat: number | null;
+    capital_lon: number | null;
     continent: string;
     region: string | null;
     subregion: string | null;
@@ -61,9 +82,12 @@ interface Country {
     currency_name: string | null;
     currency_symbol: string | null;
     tld: string | null;
+    calling_code: string | null;
     emoji: string | null;
     languages: string[];
     borders: string[];
+    /** Bloc memberships (EU, SCHENGEN, NATO, ...). Empty when none. */
+    blocs: string[];
 }
 interface CountryStateItem {
     state: string;
@@ -86,6 +110,13 @@ interface State {
     population: number | null;
     area: number | null;
     timezone: string | null;
+    timezones: string[];
+    iso_3166_2: string | null;
+    fips: string | null;
+    capital: string | null;
+    area_codes: string[];
+    tax: string | null;
+    tax_rate: number | null;
 }
 interface StateDistrictItem {
     district: string;
@@ -112,16 +143,28 @@ interface District {
     population: number | null;
     land_area: number | null;
     water_area: number | null;
+    seat: string | null;
+    timezone: string | null;
+    timezones: string[];
 }
 interface City {
     name: string;
     local_name: string | null;
+    type: string | null;
+    capital: 'country' | 'state' | null;
     state: string | null;
     state_name: string | null;
+    district: string | null;
+    district_name: string | null;
     country: string;
+    country_name: string | null;
     latitude: number | null;
     longitude: number | null;
+    elevation: number | null;
+    elevation_ft: number | null;
     population: number | null;
+    land_area: number | null;
+    water_area: number | null;
     timezone: string | null;
     /** Minted parse id (`city_` + 12 chars). Stable pin via `/city/id/{id}`. */
     id: string;
@@ -137,6 +180,14 @@ interface CitySearch {
     state?: string;
     cities: City[];
 }
+interface CityNearby {
+    city: string;
+    state: string | null;
+    country: string;
+    radius: number;
+    unit: string;
+    nearby: CityNearest[];
+}
 interface Postal {
     postal: string;
     city: string | null;
@@ -148,11 +199,14 @@ interface Postal {
     state_name: string | null;
     state_name_local: string | null;
     country: string;
+    country_name: string | null;
     latitude: number | null;
     longitude: number | null;
     elevation: number | null;
     elevation_ft: number | null;
     population: number | null;
+    land_area: number | null;
+    water_area: number | null;
     timezone: string | null;
     currency: string | null;
     neighbors: string[];
@@ -189,6 +243,7 @@ interface EmailDeep {
 }
 interface Email {
     email: string;
+    didyoumean: string | null;
     valid: boolean;
     domain: string | null;
     domain_valid: boolean | null;
@@ -196,17 +251,94 @@ interface Email {
     disposable: boolean;
     deep?: Deep<EmailDeep>;
 }
-interface PhoneDeep {
-    type: 'mobile' | 'landline' | 'toll_free' | 'unknown';
-    region: string;
+interface VatAddress {
+    street: string | null;
+    city: string | null;
+    postal: string | null;
+    country: string | null;
+}
+interface VatDeep {
+    registered: boolean | null;
+    name: string | null;
+    address: VatAddress | null;
+    consultation: string | null;
+    consulted: string | null;
+}
+interface Vat {
+    vat: string | null;
+    valid: boolean;
+    country: string | null;
+    from?: string;
+    deep?: Deep<VatDeep>;
+}
+interface Iban {
+    iban: string | null;
+    valid: boolean;
+    country: string | null;
+    /** Print form in groups of four, for display. Null when invalid. */
+    formatted: string | null;
+    /** Two check digits as a string, keeping a leading zero. */
+    checksum: string | null;
+    /** Bank identifier parsed from the number, not a name. */
+    bank: string | null;
+    /** Branch identifier when that country has one. */
+    branch: string | null;
+    account: string | null;
 }
 interface Phone {
+    phone: string | null;
     valid: boolean;
-    e164: string | null;
+    /** What the numbering plan can see. Never voip (that is the carrier field's word). Present when valid. */
+    type?: 'mobile' | 'landline' | 'toll_free' | 'unknown';
+    /** NPA-derived state code (US/CA). Present when valid. */
+    state?: string | null;
+    state_name?: string | null;
     country: string | null;
-    national: string | null;
-    international: string | null;
-    deep?: Deep<PhoneDeep>;
+    national?: string | null;
+    international?: string | null;
+    /** Always empty. The metered proves are their own endpoints: carrier, caller, hlr. */
+    deep?: Record<string, never>;
+}
+interface Carrier {
+    phone: string | null;
+    valid: boolean;
+    country: string | null;
+    /** The network's word, including voip. Present when valid. */
+    type?: 'mobile' | 'landline' | 'voip' | 'toll_free' | 'unknown';
+    /** Current carrier display name. Null when the probe had no answer. */
+    carrier?: string | null;
+    /** Carrier is a known burner number app. Null when carrier is unknown. */
+    burner?: boolean | null;
+    /** Issuing rate-center city. */
+    city?: string | null;
+    state?: string | null;
+    state_name?: string | null;
+}
+interface Caller {
+    phone: string | null;
+    valid: boolean;
+    country: string | null;
+    /** CNAM record verbatim (all-caps telco artifact). Null when no record or outside NANP. Present when valid. */
+    caller?: string | null;
+}
+interface Hlr {
+    phone: string | null;
+    valid: boolean;
+    country: string | null;
+    /** Assigned to a subscriber. Present when valid. */
+    live?: boolean | null;
+    /** Handset reachable right now. Null means unconfirmed, never no. */
+    connected?: boolean | null;
+    /** The six network extras fill on live HLR dips only. Null elsewhere (NANP, failover). */
+    roaming?: boolean | null;
+    roaming_network?: string | null;
+    /** ISO2, uppercase. */
+    roaming_country?: string | null;
+    /** Current serving network name. */
+    network?: string | null;
+    original_network?: string | null;
+    mcc?: string | null;
+    mnc?: string | null;
 }
 interface MxRecord {
     priority: number;
@@ -227,7 +359,7 @@ interface DomainDeep {
     ns: string[];
     mx: MxRecord[];
     txt: string[];
-    provider: string;
+    mailhost: string;
     registration: DomainRegistration;
 }
 interface Domain {
@@ -303,11 +435,27 @@ interface Language {
     direction: 'ltr' | 'rtl' | string;
     countries: string[];
 }
+/** A parsed person name. Junk input returns valid: false, never an error. Gender comes from dictionary data and is null when the data does not decide. */
+interface Name {
+    name: string;
+    valid: boolean;
+    prefix: string | null;
+    first: string | null;
+    middle: string | null;
+    last: string | null;
+    suffix: string | null;
+    gender: 'male' | 'female' | null;
+    salutation: 'Mr' | 'Ms' | null;
+}
 interface CurrencyRate {
     base: string;
     quote: string;
     rate: number;
     date: string;
+    /** With amount= only: echo of the amount asked. */
+    amount?: number;
+    /** With amount= only: amount times rate, rounded to the quote currency minor-unit digits. */
+    converted?: number;
     source?: string;
 }
 interface TimezoneNextDst {
@@ -317,13 +465,58 @@ interface TimezoneNextDst {
     abbreviation: string;
 }
 interface Timezone {
+    latitude?: number;
+    longitude?: number;
+    timezone: string | null;
+    name: string | null;
+    abbreviation: string | null;
+    offset: string | null;
+    offset_minutes: number | null;
+    dst: boolean | null;
+    next_dst: TimezoneNextDst | null;
+    /** With to= only: the resolved wall time in the from zone, ISO with its UTC offset. */
+    at?: string;
+    /** With to= only: the other zone at the same instant. to.at is the converted time. */
+    to?: TimezoneConversionTarget;
+}
+/** The other side of a timezone conversion. `at` is the converted wall time. */
+interface TimezoneConversionTarget {
     timezone: string;
     name: string | null;
-    abbreviation: string;
+    abbreviation: string | null;
     offset: string;
     offset_minutes: number;
     dst: boolean;
-    next_dst: TimezoneNextDst | null;
+    at: string;
+}
+/**
+ * Calendar facts for one date. Junk or ambiguous input returns valid: false,
+ * never an error. `to` and `days` appear only when a to= date was passed.
+ */
+interface DateInfo {
+    date: string;
+    valid: boolean;
+    year: number | null;
+    month: number | null;
+    month_name: string | null;
+    day: number | null;
+    /** ISO weekday, Monday 1 to Sunday 7. */
+    weekday: number | null;
+    weekday_name: string | null;
+    /** ISO 8601 week number. */
+    week: number | null;
+    /** The year that ISO week belongs to. Differs from year around January 1. */
+    week_year: number | null;
+    day_of_year: number | null;
+    quarter: number | null;
+    leap: boolean | null;
+    days_in_month: number | null;
+    /** Unix time at midnight UTC of that date, seconds. */
+    unix: number | null;
+    /** With to= only: the other date, normalized ISO. */
+    to?: string;
+    /** With to= only: signed days to the other date. Future positive. */
+    days?: number | null;
 }
 interface Holiday {
     date: string;
@@ -352,8 +545,8 @@ interface Elevation {
     resolution: number | null;
 }
 interface PointDeep {
-    city: CityNearest;
-    timezone: Timezone;
+    city: CityNearest | null;
+    timezone: Timezone | null;
 }
 interface Point {
     latitude: number;
@@ -392,13 +585,79 @@ interface WeatherAlert {
     onset: string | null;
     expires: string | null;
 }
-interface WeatherDeep {
-    forecast: WeatherForecastPeriod[];
-    alerts: WeatherAlert[];
+interface WeatherHour {
+    at: string | null;
+    daytime: boolean | null;
+    temperature: number | null;
+    temperature_f: number | null;
+    feels_like: number | null;
+    feels_like_f: number | null;
+    humidity: number | null;
+    precipitation_chance: number | null;
+    wind_speed: number | null;
+    wind_speed_mph: number | null;
+    wind_gust: number | null;
+    wind_gust_mph: number | null;
+    wind_direction: number | null;
+    condition: string | null;
+    condition_name: string | null;
+    condition_emoji: string | null;
 }
-interface Weather {
-    latitude: number;
-    longitude: number;
+interface WeatherMinute {
+    at: string;
+    precipitation: number | null;
+    precipitation_in: number | null;
+    type: string | null;
+}
+interface WeatherDay {
+    date: string;
+    high: number | null;
+    high_f: number | null;
+    low: number | null;
+    low_f: number | null;
+    precipitation_chance: number | null;
+    condition: string | null;
+    condition_name: string | null;
+    condition_emoji: string | null;
+    sunrise: string | null;
+    sunset: string | null;
+    moon_phase: string | null;
+    moon_phase_name: string | null;
+    moon_phase_emoji: string | null;
+}
+interface WeatherAir {
+    aqi: number | null;
+    aqi_name: string | null;
+    pm2_5: number | null;
+    pm10: number | null;
+}
+interface WeatherHistory {
+    date: string;
+    high: number | null;
+    high_f: number | null;
+    low: number | null;
+    low_f: number | null;
+    precipitation: number | null;
+    precipitation_in: number | null;
+    wind_max: number | null;
+    wind_max_mph: number | null;
+    sunrise: string | null;
+    sunset: string | null;
+    moon_phase: string | null;
+    moon_phase_name: string | null;
+    moon_phase_emoji: string | null;
+}
+interface WeatherDeep {
+    forecast: WeatherForecastPeriod[] | null;
+    alerts: WeatherAlert[] | null;
+    minutes: WeatherMinute[] | null;
+    hours: WeatherHour[] | null;
+    days: WeatherDay[] | null;
+    air: WeatherAir | null;
+    /** Only present when the call carried ?date=. */
+    history?: WeatherHistory | null;
+}
+interface WeatherCurrent {
     temperature: number | null;
     temperature_f: number | null;
     feels_like: number | null;
@@ -419,12 +678,23 @@ interface Weather {
     condition_name: string | null;
     condition_emoji: string | null;
     observed_at: string | null;
-    station: string;
-    station_name: string | null;
-    station_distance: number;
-    station_distance_mi: number;
-    source: string;
-    source_name: string | null;
+}
+interface WeatherStation {
+    id: string;
+    name: string | null;
+    distance: number | null;
+    distance_mi: number | null;
+}
+interface WeatherSource {
+    id: string;
+    name: string | null;
+}
+interface Weather {
+    latitude: number;
+    longitude: number;
+    current: WeatherCurrent;
+    station: WeatherStation | null;
+    source: WeatherSource;
     deep?: Deep<WeatherDeep>;
 }
 interface EmojiSkin {
@@ -483,18 +753,22 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
     continent: ((code: string) => Promise<Continent>) & {
         countries: (code: string) => Promise<ContinentCountries>;
     };
+    bloc: ((code: string) => Promise<Bloc>) & {
+        countries: (code: string) => Promise<BlocCountries>;
+    };
     country: ((code: string) => Promise<Country>) & {
         states: (code: string) => Promise<CountryStates>;
     };
-    state: ((code: string, opts: {
-        country: string;
+    state: ((code: string, opts?: {
+        country?: string;
     }) => Promise<State>) & {
-        districts: (code: string, opts: {
-            country: string;
+        districts: (code: string, opts?: {
+            country?: string;
         }) => Promise<StateDistricts>;
     };
     district: (code: string, opts?: {
         country?: string;
+        state?: string;
     }) => Promise<District>;
     city: ((name: string, opts?: {
         country?: string;
@@ -507,33 +781,74 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
             limit?: number;
         }) => Promise<CitySearch>;
         nearest: (lat: number, lon: number) => Promise<CityNearest>;
+        nearby: (name: string, opts?: {
+            radius?: number;
+            unit?: "km" | "mi";
+            country?: string;
+            state?: string;
+            limit?: number;
+        }) => Promise<CityNearby>;
     };
-    postal: ((code: string, opts: {
-        country: string;
+    postal: ((code: string, opts?: {
+        country?: string;
     }) => Promise<Postal>) & {
-        nearby: (code: string, opts: {
-            country: string;
+        nearby: (code: string, opts?: {
+            country?: string;
             radius?: number;
             unit?: "km" | "mi";
         }) => Promise<PostalNearby>;
-        distance: (from: string, to: string, opts: {
-            country: string;
+        distance: (from: string, to: string, opts?: {
+            country?: string;
         }) => Promise<PostalDistance>;
     };
     email: (email: string, opts?: DeepOption) => Promise<Email>;
+    vat: (number: string, opts?: {
+        country?: string;
+        from?: string;
+    } & DeepOption) => Promise<Vat>;
+    iban: (iban: string, opts?: {
+        country?: string;
+    }) => Promise<Iban>;
     phone: (number: string, opts?: {
         country?: string;
     } & DeepOption) => Promise<Phone>;
+    carrier: (number: string, opts?: {
+        country?: string;
+    }) => Promise<Carrier>;
+    caller: (number: string, opts?: {
+        country?: string;
+    }) => Promise<Caller>;
+    hlr: (number: string, opts?: {
+        country?: string;
+    }) => Promise<Hlr>;
     domain: (domain: string, opts?: DeepOption) => Promise<Domain>;
     mx: (domain: string) => Promise<Mx>;
     useragent: (ua: string, opts?: DeepOption) => Promise<Useragent>;
     currency: ((code: string) => Promise<Currency>) & {
-        rate: (base: string, quote: string) => Promise<CurrencyRate>;
+        rate: (base: string, quote: string, opts?: {
+            date?: string;
+            amount?: number;
+        }) => Promise<CurrencyRate>;
     };
     language: (code: string) => Promise<Language>;
-    timezone: (id: string, opts?: {
-        at?: string;
-    }) => Promise<Timezone>;
+    name: (name: string) => Promise<Name>;
+    timezone: {
+        (id: string, opts?: {
+            at?: string;
+            to?: string;
+        }): Promise<Timezone>;
+        (lat: number, lon: number, opts?: {
+            at?: string;
+        }): Promise<Timezone>;
+    };
+    date: ((date: string, opts?: {
+        format?: "mdy" | "dmy";
+        to?: string;
+    }) => Promise<DateInfo>) & {
+        today: (opts?: {
+            to?: string;
+        }) => Promise<DateInfo>;
+    };
     holiday: ((country: string, opts?: {
         year?: number;
     }) => Promise<HolidayYear>) & {
@@ -541,7 +856,9 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
     };
     elevation: (lat: number, lon: number) => Promise<Elevation>;
     point: (lat: number, lon: number, opts?: DeepOption) => Promise<Point>;
-    weather: (lat: number, lon: number, opts?: DeepOption) => Promise<Weather>;
+    weather: (lat: number, lon: number, opts?: DeepOption & {
+        date?: string;
+    }) => Promise<Weather>;
     emoji: ((emoji: string) => Promise<Emoji>) & {
         search: (q: string, opts?: {
             limit?: number;
@@ -550,4 +867,4 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
 };
 type ParseAPIClient = ReturnType<typeof parseAPI>;
 
-export { type City, type CityNearest, type CitySearch, type Continent, type ContinentCountries, type ContinentCountryItem, type Country, type CountryStateItem, type CountryStates, type Currency, type CurrencyRate, type Deep, type District, type Domain, type DomainDeep, type DomainRegistration, type Elevation, type Email, type EmailDeep, type Emoji, type EmojiSearch, type EmojiSkin, type Holiday, type HolidayDate, type HolidayYear, type Ip, type IpDeep, type Language, type Mx, type MxRecord, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type PhoneDeep, type Point, type PointDeep, type Postal, type PostalDistance, type PostalDistanceEnd, type PostalNearby, type PostalNearbyItem, type State, type StateDistrictItem, type StateDistricts, type Timezone, type TimezoneNextDst, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOsDeep, type Weather, type WeatherAlert, type WeatherDeep, type WeatherForecastPeriod, parseAPI };
+export { type Bloc, type BlocCountries, type BlocCountryItem, type Caller, type Carrier, type City, type CityNearby, type CityNearest, type CitySearch, type Continent, type ContinentCountries, type ContinentCountryItem, type Country, type CountryStateItem, type CountryStates, type Currency, type CurrencyRate, type DateInfo, type Deep, type District, type Domain, type DomainDeep, type DomainRegistration, type Elevation, type Email, type EmailDeep, type Emoji, type EmojiSearch, type EmojiSkin, type Hlr, type Holiday, type HolidayDate, type HolidayYear, type Iban, type Ip, type IpDeep, type Language, type Mx, type MxRecord, type Name, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type Point, type PointDeep, type Postal, type PostalDistance, type PostalDistanceEnd, type PostalNearby, type PostalNearbyItem, type State, type StateDistrictItem, type StateDistricts, type Timezone, type TimezoneConversionTarget, type TimezoneNextDst, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOsDeep, type Vat, type VatAddress, type VatDeep, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherSource, type WeatherStation, parseAPI };