@parseapi/sdk 0.3.2 → 0.4.0

package/README.md

@@ -15,6 +15,34 @@ const country = await parse.country('US');
 
 Get a key at [parseapi.com](https://parseapi.com). The client also reads `PARSEAPI_KEY` from the environment.
 
+## API versions
+
+Choose your team's API version in [Dashboard → API version](https://parseapi.com/dashboard/versions). One setting applies to every key, including new and replacement keys. Existing teams keep `1.0.0`; new teams start on `2.0.0`. Keep the same keys and lookup URLs. Installing or upgrading the package does not change the team's setting.
+
+Published SDK `0.3.2` matches API `1.0.0`. The examples and response types in this source tree target API `2.0.0`, including changes that are not in `0.3.2`. Use a package release documented for your team's version. These types do not model every historical response; moving to `2.0.0` may require updating code that reads renamed, moved or removed fields.
+
+Test the target contract in a separate development team before changing your production team's version. A change applies to every integration in that team. See [API versions and migration](https://parseapi.com/docs/versioning).
+
+## Weather from a postal code
+
+Start with the postal code, then pass its coordinates to weather. Reuse the client from the example above.
+
+```ts
+const place = await parse.postal('28202', { country: 'US' });
+if (place.latitude != null && place.longitude != null) {
+  const weather = await parse.weather(place.latitude, place.longitude);
+  console.log(weather);
+}
+```
+
+The coordinates represent the postal area. Weather is for that point. Missing coordinates skip the weather lookup. This composition performs two ordinary lookups when coordinates are available, with the retry policy below.
+
+## Supply the context you know
+
+Pass `country` when a postal code or national phone number needs disambiguation. A complete international phone number already carries its country context. For a numeric date such as `03/04/2026`, supply the intended `format`. Defaults resolve what the input establishes. Ambiguous input needs your context.
+
+Results are plain data. Pass a returned code or coordinate to another operation when the task needs it. Check nullable values before composing the next call.
+
 ## Calls
 
 One method per endpoint, named after the route.
@@ -25,6 +53,7 @@ await parse.ip.self();
 await parse.email('hello@gmail.com');
 await parse.vat('DE136695976');
 await parse.iban('DE89370400440532013000');
+await parse.bin('424242');
 await parse.npi('1881018208');
 await parse.phone('+14155552671');
 await parse.carrier('+14155552671');
@@ -57,8 +86,11 @@ await parse.currency('USD');
 await parse.currency.rate('USD', 'EUR');
 await parse.language('en');
 await parse.name('BILLY OSHALL');
-await parse.timezone('America/New_York');
-await parse.timezone.at(40.7128, -74.006);
+await parse.name('Andrea', { country: 'IT', deep: true });
+await parse.time(); // UTC now
+await parse.time('America/New_York');
+await parse.time('America/New_York', { at: '2026-09-05T15:00:00', to: 'Asia/Tokyo' });
+await parse.time.at(40.7128, -74.006);
 await parse.date('03/04/2026', { format: 'mdy' });
 await parse.date.today();
 await parse.holiday('US', { year: 2026 });
@@ -70,19 +102,90 @@ await parse.domain('example.com');
 await parse.asn('AS13335');
 await parse.mac('00:1B:63:84:45:E6');
 await parse.mx('example.com');
+await parse.dns('example.com');
+await parse.dns('_dmarc.example.com', { type: 'TXT' });
 await parse.useragent(uaString);
 await parse.vin('1HGCM82633A004352');
+await parse.naics('541511');
+await parse.naics.search('coffee shop', { limit: 5 });
 await parse.tariff('8471.30.01.00');
 await parse.tariff.search('sunglasses');
 await parse.emoji('rocket');
 await parse.emoji.search('fire');
 ```
 
+NAICS paid deep records include classification `deep.exclusions`, each with a description and linked codes. Generic exclusions can have no linked codes. Omitted or null exclusions in older responses remain unknown. Search results also include `match`: the matched `field` (`name`, `term` or `naics`) and `text`, plus `corrections` with `from` and `to` tokens for typo fallback. Corrections are empty for exact, plural and prefix matches. Direct code lookups omit `match`. Older responses may omit it.
+
 Responses are typed, plain JSON data. `country.states('US')` requests the states directly; it does not fetch a country first. Optional arguments go in the final options object, so new options can be added without changing your existing calls.
 
+DNS uses pooled requests on every plan. Omit `type` to check A, AAAA, CNAME, MX, NS, TXT, SOA, CAA, SRV and PTR. Records contain `name`, `type`, `ttl` in seconds and a DNS presentation `value`. TXT values retain quoting and chunk boundaries. A selected question can include its CNAME chain. Empty records mean no records. Lookup failures remain errors.
+
+## Time
+
+`time` returns local ISO `at` with its UTC offset and integer Unix seconds in `unix`. The core `offset` preserves exact precision. Optional `deep.offset_seconds` gives the numeric offset, while `deep.offset_minutes` gives whole minutes. Historical offsets and ISO times can include offset seconds. Omitted `at` means now. With `to`, an offsetless `at` is source wall time. Otherwise it is UTC. Include an offset for repeated local times around a clock change. Current time and conversion use pooled requests on every plan. Coordinate clock fields can be null when the timezone is unknown. Existing `timezone` methods remain supported.
+
+## Measurements
+
+```ts
+const result = await parse.measure('5 ft 11 in', { to: 'cm' });
+const units = await parse.measure.units({ unit: 'm' });
+```
+
+`amount` is a decimal string, such as `"180.34"`. Without `to`, the API returns the canonical unit for the measurement type. Pass `locale` for number formatting and `system` (`us` or `imperial`) when a customary unit needs context. Ambiguous input returns `valid: false`, a `reason`, and available `choices`. Invalid or incompatible target units use the normal API error.
+
+Unit discovery accepts optional `query`, `type`, and `unit` filters. `unit` selects compatible targets. Omit the filters for the reviewed catalog. Both operations use pooled requests.
+
+## Place statistics and optional detail
+
+Postal and District paid profiles include `deep.property_tax` where supported. It contains `annual_median`, `currency` and `period`: median annual property tax payable on owner-occupied homes in the statistical area. The amount is adjusted to the final year of the reporting period (`YYYY-YYYY`). This is an area statistic, not a rate or an individual property bill. Unsupported, missing and censored estimates are null.
+
+```ts
+const place = await parse.postal('28202', { country: 'US', deep: true });
+const propertyTax = place.deep?.property_tax;
+```
+
+Read `population_period` alongside `population`: a reporting year (`YYYY`) or period (`YYYY-YYYY`), null when unknown or unverifiable. Keep missing or null values unknown and preserve a known zero. These fields belong to full place profiles. State district lists include each district's population and period. Postal nearby and distance detail remains metropolitan associations only. Continent population and its period remain in core.
+
+Point returns the timezone ID with the core location. Its optional deep detail adds terrain and compact nearest-city context on every plan. A nearest city is null when none is within 200 km.
+
+Weather returns current conditions by default. Paid deep adds specialist current measurements, forecasts and related detail. A past `date` is a UTC day and requires deep: it adds `deep.history` alongside current conditions. Date alone does not request history.
+
+```ts
+await parse.weather(40.7128, -74.006, { deep: true, date: '2026-08-15' });
+```
+
+Tariff starts with the general schedule line. Paid deep adds units and the special and other schedule columns. An optional origin then resolves country-specific measures. The three calls below show those successive choices. Without origin, schedule detail is still returned and origin-dependent fields are null. A null effective rate is not a zero rate.
+
+```ts
+await parse.tariff('8471.30.01.00');
+await parse.tariff('8471.30.01.00', { deep: true });
+await parse.tariff('8471.30.01.00', { deep: true, origin: 'CN' });
+```
+
+Address search uses context from the form: prefer postal, or city and state. An optional end-user `ip` is a locality hint for server-side calls. An empty result explains itself with `reason`: `more_input`, `missing_context` or `no_matches`. With suggestions, reason is null. Older responses may omit it, and future reasons remain strings. Catalog and lookup failures use the existing API errors.
+
+HLR reports status at the last check. `live` means assigned and `connected` means reachable at that check. Cached results may be returned. Null means unconfirmed. Deep diagnostics stay within the same metered lookup.
+
 ## Deep
 
-Pass `deep: true` to include the nested `deep` object with richer fields.
+Choose enrichment for the question you need answered.
+
+| Operation | What `deep` requests |
+|---|---|
+| IP | Richer IP fields included with a paid plan. No separate check meter. |
+| Domain | Registration dates, registrar, status and DNSSEC, included with a paid plan. Use `dns` for DNS records and `mx` for mail routing. |
+| Email | A metered deliverability check, using included email checks or enabled on-demand usage. |
+| VAT | A metered registry check where supported, using included VAT checks or enabled on-demand usage. |
+| Phone, Time, Date, Currency, Language, Emoji, IBAN, Point | Optional detail in the same pooled request on every plan. |
+| Country, State, District, City, Postal | The place profile on paid plans, including demographic and tax facts where held. |
+| Name, NAICS | Name evidence or the industry definition profile on paid plans. |
+| VIN, NPI, Tariff, Company | The complete product detail bag on paid plans. |
+| Weather | Specialist current measurements and the existing forecast, alert, air and history bag on paid plans. |
+| Carrier, HLR | Optional diagnostic detail within the same metered core unit, including Free allowance units. No second gate or additional check. |
+
+Carrier, caller, and HLR are separate metered operations. Choose them explicitly when you need their answers. Ordinary lookups retry twice by default. Metered checks use one attempt by default. Setting retries explicitly can repeat paid usage.
+
+Without `deep`, the response omits that key. When requested, it is an empty object if access is locked or the operation has no deep fields. Otherwise it contains the available fields. A missing or null field means unknown.
 
 ```ts
 const ip = await parse.ip('52.94.76.10', { deep: true });
@@ -131,3 +234,16 @@ An explicit `retries` setting on the client or call overrides those defaults. An
 ## Docs
 
 Full field reference for every endpoint: [parseapi.com/docs](https://parseapi.com/docs)
+
+BIN lookup accepts 6-11 digits as a string, including leading zeros. Spaces and hyphens are accepted. `prefix` is the actual longest match and can be shorter than the input. Unknown reference fields are null. `deep` adds an empty object on every plan.
+
+
+## Optional detail
+
+The default response answers the common task. Ask for `deep` when you need more detail about that same result. Core fields stay equal. City, NAICS and Emoji searches put detail inside each result. Postal nearby and distance put metropolitan detail beside the entity it describes. Time conversion keeps target detail in `to.deep`; only the source has `deep.next_dst`.
+
+```ts
+const basic = await parse.time('America/New_York');
+const detail = await parse.time('America/New_York', { deep: true });
+console.log(basic.at, detail.deep?.next_dst);
+```

package/dist/index.cjs

@@ -24,7 +24,7 @@ __export(index_exports, {
   parseAPI: () => parseAPI
 });
 module.exports = __toCommonJS(index_exports);
-var VERSION = "0.3.2";
+var VERSION = "0.4.0";
 var DEFAULT_BASE_URL = "https://api.parseapi.com";
 var DEFAULT_TIMEOUT_MS = 1e4;
 var DEFAULT_RETRIES = 2;
@@ -179,9 +179,11 @@ function parseAPI(apiKey, options = {}) {
   const enc = encodeURIComponent;
   const deepQuery = (opts) => opts?.deep ? { deep: true } : {};
   return {
+    /** Look up an IP. `deep: true` adds enrichment included with a paid plan, without a separate check meter. */
     ip: Object.assign(
       (ip, opts) => request(`/ip/${enc(ip)}`, deepQuery(opts), void 0, opts),
       {
+        /** Look up the public IP making this request. On a server, this is the server's IP. */
         self: (opts) => request("/ip", deepQuery(opts), void 0, opts)
       }
     ),
@@ -198,69 +200,104 @@ function parseAPI(apiKey, options = {}) {
       }
     ),
     country: Object.assign(
-      (code, opts) => request(`/country/${enc(code)}`, void 0, void 0, opts),
+      (code, opts) => request(`/country/${enc(code)}`, deepQuery(opts), void 0, opts),
       {
         states: (code, opts) => request(`/country/${enc(code)}/states`, void 0, void 0, opts)
       }
     ),
     state: Object.assign(
-      (code, opts) => request(`/state/${enc(code)}`, { country: opts?.country }, void 0, opts),
+      (code, opts) => request(`/state/${enc(code)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
       {
-        districts: (code, opts) => request(`/state/${enc(code)}/districts`, { country: opts?.country }, void 0, opts)
+        districts: (code, opts) => request(`/state/${enc(code)}/districts`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts)
       }
     ),
-    district: (code, opts) => request(`/district/${enc(code)}`, { country: opts?.country, state: opts?.state }, void 0, opts),
+    district: (code, opts) => request(`/district/${enc(code)}`, { country: opts?.country, state: opts?.state, ...deepQuery(opts) }, void 0, opts),
     city: Object.assign(
-      (name, opts) => request(`/city/${enc(name)}`, { country: opts?.country, state: opts?.state }, void 0, opts),
+      (name, opts) => request(`/city/${enc(name)}`, { country: opts?.country, state: opts?.state, ...deepQuery(opts) }, void 0, opts),
       {
-        id: (id, opts) => request(`/city/id/${enc(id)}`, void 0, void 0, opts),
-        search: (query, opts) => request("/city", { q: query, country: opts?.country, state: opts?.state, limit: opts?.limit }, void 0, opts),
-        nearest: (lat, lon, opts) => request("/city", { lat, lon }, void 0, opts),
+        id: (id, opts) => request(`/city/id/${enc(id)}`, deepQuery(opts), void 0, opts),
+        search: (query, opts) => request("/city", { q: query, country: opts?.country, state: opts?.state, limit: opts?.limit, ...deepQuery(opts) }, void 0, opts),
+        nearest: (lat, lon, opts) => request("/city", { lat, lon, ...deepQuery(opts) }, void 0, opts),
         nearby: (name, opts) => request(`/city/${enc(name)}/nearby`, {
           radius: opts?.radius,
           unit: opts?.unit,
           country: opts?.country,
           state: opts?.state,
-          limit: opts?.limit
+          limit: opts?.limit,
+          ...deepQuery(opts)
         }, void 0, opts)
       }
     ),
+    /** Look up a postal area. Pass country when known. Check nullable latitude/longitude before another location lookup. */
     postal: Object.assign(
-      (code, opts) => request(`/postal/${enc(code)}`, { country: opts?.country }, void 0, opts),
+      (code, opts) => request(`/postal/${enc(code)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
       {
         nearby: (code, opts) => request(`/postal/${enc(code)}/nearby`, {
           country: opts?.country,
           radius: opts?.radius,
-          unit: opts?.unit
+          unit: opts?.unit,
+          ...deepQuery(opts)
         }, void 0, opts),
-        distance: (from, to, opts) => request(`/postal/${enc(from)}/distance/${enc(to)}`, { country: opts?.country }, void 0, opts)
+        distance: (from, to, opts) => request(`/postal/${enc(from)}/distance/${enc(to)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts)
       }
     ),
     address: Object.assign(
       (address, opts) => request(`/address/${enc(address)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
       {
+        /** Find address suggestions using the context supplied. Prefer postal, or city and state, from the form. ip is an optional end-user locality hint for server-side calls. An empty result has reason more_input, missing_context or no_matches. Suggestions have reason null. Operational failures are errors. */
         search: (query, opts) => request("/address", { q: query, country: opts?.country, postal: opts?.postal, city: opts?.city, state: opts?.state, ip: opts?.ip }, void 0, opts)
       }
     ),
     company: (number, opts) => request(`/company/${enc(number)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
+    /**
+     * Parse an email and check its format and domain.
+     * `deep: true` explicitly requests a metered deliverability check using included checks or enabled on-demand usage.
+     * Deep checks default to one attempt. An explicit retry count can repeat paid usage.
+     */
     email: (email, opts) => request(`/email/${enc(email)}`, deepQuery(opts), void 0, opts),
+    /** Check VAT format and checksum. `deep: true` requests a metered registry check where supported, with no automatic retries by default. */
     vat: (number, opts) => request(`/vat/${enc(number)}`, {
       country: opts?.country,
       from: opts?.from,
       ...deepQuery(opts)
     }, void 0, opts),
-    iban: (iban, opts) => request(`/iban/${enc(iban)}`, { country: opts?.country }, void 0, opts),
+    iban: (iban, opts) => request(`/iban/${enc(iban)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
     npi: (npi, opts) => request(`/npi/${enc(npi)}`, deepQuery(opts), void 0, opts),
+    /** Parse a phone number and its formats. Pass country for national numbers when needed. Deep adds numbering-plan geography. */
     phone: (number, opts) => request(`/phone/${enc(number)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
-    carrier: (number, opts) => request(`/carrier/${enc(number)}`, { country: opts?.country }, void 0, opts),
+    /** Request a metered carrier lookup. No automatic retries by default. */
+    carrier: (number, opts) => request(`/carrier/${enc(number)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
+    /** Request a metered caller-name lookup for a NANP number. No automatic retries by default. */
     caller: (number, opts) => request(`/caller/${enc(number)}`, { country: opts?.country }, void 0, opts),
-    hlr: (number, opts) => request(`/hlr/${enc(number)}`, { country: opts?.country }, void 0, opts),
+    /** Look up phone status at the last check. Live means assigned and connected means reachable at that check. Cached results may be returned. Null means unconfirmed. Deep adds network diagnostics within the same metered lookup. No automatic retries by default. */
+    hlr: (number, opts) => request(`/hlr/${enc(number)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
+    /** Check whether a domain is registered. Deep adds registration dates, registrar, status and DNSSEC on paid plans. */
     domain: (domain, opts) => request(`/domain/${enc(domain)}`, deepQuery(opts), void 0, opts),
     asn: (asn, opts) => request(`/asn/${enc(asn)}`, void 0, void 0, opts),
     mac: (mac, opts) => request(`/mac/${enc(mac)}`, void 0, void 0, opts),
+    /** Look up a 6-11 digit card prefix. Keep leading zeros in the input string. */
+    bin: (bin, opts) => request(`/bin/${enc(bin)}`, { deep: opts?.deep }, void 0, opts),
+    /** Parse a measurement or convert it to `to`. Without `to`, use its type's canonical unit. Invalid input is plain data with `valid: false`. */
+    measure: Object.assign(
+      (measure, opts) => request(`/measure/${enc(measure)}`, { to: opts?.to, locale: opts?.locale, system: opts?.system }, void 0, opts),
+      {
+        /** Discover reviewed units. Pass `unit` to find compatible conversion targets. */
+        units: (opts) => request("/measure/units", { q: opts?.query, type: opts?.type, unit: opts?.unit }, void 0, opts)
+      }
+    ),
+    /** Look up DNS records with TTLs. Type selects the question and may include its CNAME chain. Pooled on every plan. */
+    dns: (domain, opts) => request(`/dns/${enc(domain)}`, { type: opts?.type }, void 0, opts),
     mx: (domain, opts) => request(`/mx/${enc(domain)}`, void 0, void 0, opts),
     useragent: (ua, opts) => request("/useragent", deepQuery(opts), { "User-Agent": ua }, opts),
     vin: (vin, opts) => request(`/vin/${enc(vin)}`, deepQuery(opts), void 0, opts),
+    /** US NAICS 2022 definitions and hierarchy. */
+    naics: Object.assign(
+      (code, opts) => request(`/naics/${enc(code)}`, deepQuery(opts), void 0, opts),
+      {
+        search: (query, opts) => request("/naics", { q: query, limit: opts?.limit, ...deepQuery(opts) }, void 0, opts)
+      }
+    ),
+    /** Look up the general US duty schedule line. Paid deep adds units and the special and other schedule columns. Add origin with deep to resolve country-specific measures. Without origin, schedule detail remains available and origin-dependent fields are null. A null effective rate is not a zero rate. */
     tariff: Object.assign(
       (code, opts) => request(`/tariff/${enc(code)}`, { origin: opts?.origin, ...deepQuery(opts) }, void 0, opts),
       {
@@ -268,7 +305,7 @@ function parseAPI(apiKey, options = {}) {
       }
     ),
     currency: Object.assign(
-      (code, opts) => request(`/currency/${enc(code)}`, void 0, void 0, opts),
+      (code, opts) => request(`/currency/${enc(code)}`, deepQuery(opts), void 0, opts),
       {
         rate: (base, quote, opts) => request(`/currency/${enc(base)}/${enc(quote)}`, {
           date: opts?.date,
@@ -276,18 +313,25 @@ function parseAPI(apiKey, options = {}) {
         }, void 0, opts)
       }
     ),
-    language: (code, opts) => request(`/language/${enc(code)}`, void 0, void 0, opts),
-    name: (name, opts) => request(`/name/${enc(name)}`, void 0, void 0, opts),
+    language: (code, opts) => request(`/language/${enc(code)}`, deepQuery(opts), void 0, opts),
+    name: (name, opts) => request(`/name/${enc(name)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
+    /** Current local time, UTC by default. With to, offsetless at is source wall time. */
+    time: Object.assign(
+      (timezone, opts) => request(timezone === void 0 ? "/time" : `/time/${enc(timezone)}`, { at: opts?.at, to: opts?.to, ...deepQuery(opts) }, void 0, opts),
+      {
+        at: (lat, lon, opts) => request("/time", { lat, lon, at: opts?.at, to: opts?.to, ...deepQuery(opts) }, void 0, opts)
+      }
+    ),
     timezone: Object.assign(
-      (id, opts) => request(`/timezone/${enc(id)}`, { at: opts?.at, to: opts?.to }, void 0, opts),
+      (id, opts) => request(`/timezone/${enc(id)}`, { at: opts?.at, to: opts?.to, ...deepQuery(opts) }, void 0, opts),
       {
-        at: (lat, lon, opts) => request("/timezone", { lat, lon, at: opts?.at }, void 0, opts)
+        at: (lat, lon, opts) => request("/timezone", { lat, lon, at: opts?.at, ...deepQuery(opts) }, void 0, opts)
       }
     ),
     date: Object.assign(
-      (date, opts) => request(`/date/${enc(date)}`, { format: opts?.format, to: opts?.to }, void 0, opts),
+      (date, opts) => request(`/date/${enc(date)}`, { format: opts?.format, to: opts?.to, ...deepQuery(opts) }, void 0, opts),
       {
-        today: (opts) => request("/date", { to: opts?.to }, void 0, opts)
+        today: (opts) => request("/date", { to: opts?.to, ...deepQuery(opts) }, void 0, opts)
       }
     ),
     holiday: Object.assign(
@@ -297,12 +341,14 @@ function parseAPI(apiKey, options = {}) {
       }
     ),
     elevation: (lat, lon, opts) => request("/elevation", { lat, lon }, void 0, opts),
+    /** Resolve the country, state, district and timezone at coordinates. Deep adds terrain and compact nearest-city context on every plan. The timezone ID stays in core. The nearest city is null when none is within 200 km. */
     point: (lat, lon, opts) => request("/point", { lat, lon, ...deepQuery(opts) }, void 0, opts),
+    /** Get current conditions in metric and imperial units. Paid deep adds specialist current measurements, forecasts and related detail. With deep, date selects a past UTC day (YYYY-MM-DD) in deep.history alongside current conditions. Date alone does not request history. */
     weather: (lat, lon, opts) => request("/weather", { lat, lon, date: opts?.date, ...deepQuery(opts) }, void 0, opts),
     emoji: Object.assign(
-      (emoji, opts) => request(`/emoji/${enc(emoji)}`, void 0, void 0, opts),
+      (emoji, opts) => request(`/emoji/${enc(emoji)}`, deepQuery(opts), void 0, opts),
       {
-        search: (query, opts) => request("/emoji", { q: query, limit: opts?.limit }, void 0, opts)
+        search: (query, opts) => request("/emoji", { q: query, limit: opts?.limit, ...deepQuery(opts) }, void 0, opts)
       }
     )
   };
@@ -312,3 +358,4 @@ function parseAPI(apiKey, options = {}) {
   ParseAPIError,
   parseAPI
 });
+/*! You found Dev. https://parseapi.com/dev */