npm - radar-sdk-js - Versions diffs - 5.0.0-beta.4 → 5.0.0-beta.6 - Mend

radar-sdk-js 5.0.0-beta.4 → 5.0.0-beta.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (48) hide show

package/README.md CHANGED Viewed

@@ -21,16 +21,18 @@
 </p>
 🔥 Try it! 🔥
-* <a href="https://radar.com/demo/js">Geofencing</a>
-* <a href="https://radar.com/demo/api">Maps APIs</a>
-* <a href="https://radar.com/documentation/maps/maps">Maps UI</a>
-* <a href="https://radar.com/documentation/maps/autocomplete">Autocomplete UI</a>
+- <a href="https://radar.com/demo/js">Geofencing</a>
+- <a href="https://radar.com/demo/api">Maps APIs</a>
+- <a href="https://radar.com/documentation/maps/maps">Maps UI</a>
+- <a href="https://radar.com/documentation/maps/autocomplete">Autocomplete UI</a>
 ## 🚀 Installation and Usage
 ### With npm
 Install the core SDK:
 ```bash
 # with npm
 npm install radar-sdk-js
@@ -40,21 +42,27 @@ yarn add radar-sdk-js
 ```
 Then import and initialize:
 ```js
 import Radar from 'radar-sdk-js';
 // initialize with your test or live publishable key
-Radar.initialize('prj_test_pk_...', { /* options */ });
+Radar.initialize('prj_test_pk_...', {
+  /* options */
+});
 ```
 ### With a script tag
 Add the following to your HTML:
 ```html
-<script src="https://js.radar.com/v5.0.0-beta.4/radar.min.js"></script>
+<script src="https://js.radar.com/v5.0.0-beta.6/radar.min.js"></script>
 <script>
-  Radar.initialize('prj_test_pk_...', { /* options */ });
+  Radar.initialize('prj_test_pk_...', {
+    /* options */
+  });
 </script>
 ```
@@ -99,19 +107,21 @@ Radar.initialize('prj_test_pk_...');
 Radar.ui.autocomplete({
   container: 'autocomplete',
-  onSelection: (result) => { console.log(result); },
+  onSelection: (result) => {
+    console.log(result);
+  },
 });
 ```
 ### Fraud plugin (npm)
 ```bash
-npm install @radarlabs/fraud-plugin
+npm install @radarlabs/plugin-fraud
 ```
 ```js
 import Radar from 'radar-sdk-js';
-import { createFraudPlugin } from '@radarlabs/fraud-plugin';
+import { createFraudPlugin } from '@radarlabs/plugin-fraud';
 Radar.registerPlugin(createFraudPlugin());
 Radar.initialize('prj_live_pk_...');
@@ -125,10 +135,10 @@ Plugin CDN bundles auto-register with the core SDK when loaded. Load
 the core SDK first, then any plugins you need:
 ```html
-<link href="https://js.radar.com/maps/v5.0.0-beta.4/radar-maps.css" rel="stylesheet">
-<link href="https://js.radar.com/autocomplete/v5.0.0-beta.4/radar-autocomplete.css" rel="stylesheet">
+<link href="https://js.radar.com/maps/v5.0.0-beta.4/radar-maps.css" rel="stylesheet" />
+<link href="https://js.radar.com/autocomplete/v5.0.0-beta.4/radar-autocomplete.css" rel="stylesheet" />
-<script src="https://js.radar.com/v5.0.0-beta.4/radar.min.js"></script>
+<script src="https://js.radar.com/v5.0.0-beta.6/radar.min.js"></script>
 <script src="https://js.radar.com/maps/v5.0.0-beta.4/radar-maps.min.js"></script>
 <script src="https://js.radar.com/autocomplete/v5.0.0-beta.4/radar-autocomplete.min.js"></script>
 <script src="https://js.radar.com/fraud/v5.0.0-beta.1/radar-fraud.min.js"></script>
@@ -144,8 +154,8 @@ by ID or element reference.
 ```html
 <html>
   <head>
-    <link href="https://js.radar.com/maps/v5.0.0-beta.4/radar-maps.css" rel="stylesheet">
-    <script src="https://js.radar.com/v5.0.0-beta.4/radar.min.js"></script>
+    <link href="https://js.radar.com/maps/v5.0.0-beta.4/radar-maps.css" rel="stylesheet" />
+    <script src="https://js.radar.com/v5.0.0-beta.6/radar.min.js"></script>
     <script src="https://js.radar.com/maps/v5.0.0-beta.4/radar-maps.min.js"></script>
   </head>
@@ -171,8 +181,8 @@ by ID or element reference.
 ```html
 <html>
   <head>
-    <link href="https://js.radar.com/autocomplete/v5.0.0-beta.4/radar-autocomplete.css" rel="stylesheet">
-    <script src="https://js.radar.com/v5.0.0-beta.4/radar.min.js"></script>
+    <link href="https://js.radar.com/autocomplete/v5.0.0-beta.4/radar-autocomplete.css" rel="stylesheet" />
+    <script src="https://js.radar.com/v5.0.0-beta.6/radar.min.js"></script>
     <script src="https://js.radar.com/autocomplete/v5.0.0-beta.4/radar-autocomplete.min.js"></script>
   </head>
@@ -182,7 +192,6 @@ by ID or element reference.
     <script>
       Radar.initialize('<RADAR_PUBLISHABLE_KEY>');
       // create autocomplete widget
       Radar.ui.autocomplete({
         container: 'autocomplete', // OR document.getElementById('autocomplete')
@@ -206,17 +215,16 @@ are needed for geofencing.
 ```html
 <html>
   <head>
-    <script src="https://js.radar.com/v5.0.0-beta.4/radar.min.js"></script>
+    <script src="https://js.radar.com/v5.0.0-beta.6/radar.min.js"></script>
   </head>
   <body>
     <script>
       Radar.initialize('<RADAR_PUBLISHABLE_KEY>');
-      Radar.trackOnce({ userId: 'example-user-id' })
-        .then(({ location, user, events }) => {
-          // do something with user location or events
-        });
+      Radar.trackOnce({ userId: 'example-user-id' }).then(({ location, user, events }) => {
+        // do something with user location or events
+      });
     </script>
   </body>
 </html>
@@ -224,12 +232,12 @@ are needed for geofencing.
 ## Packages
-| Package | npm | Description |
-|---------|-----|-------------|
-| `radar-sdk-js` | [![npm](https://img.shields.io/npm/v/radar-sdk-js.svg)](https://www.npmjs.com/package/radar-sdk-js) | Core SDK — tracking, geocoding, search, routing |
-| `@radarlabs/plugin-maps` | [![npm](https://img.shields.io/npm/v/@radarlabs/plugin-maps.svg)](https://www.npmjs.com/package/@radarlabs/plugin-maps) | Maps UI — RadarMap, RadarMarker, RadarPopup (MapLibre GL) |
-| `@radarlabs/plugin-autocomplete` | [![npm](https://img.shields.io/npm/v/@radarlabs/plugin-autocomplete.svg)](https://www.npmjs.com/package/@radarlabs/plugin-autocomplete) | Autocomplete UI widget |
-| `@radarlabs/fraud-plugin` | — | Fraud detection — verified tracking, location tokens |
+| Package                          | npm                                                                                                                                     | Description                                               |
+| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| `radar-sdk-js`                   | [![npm](https://img.shields.io/npm/v/radar-sdk-js.svg)](https://www.npmjs.com/package/radar-sdk-js)                                     | Core SDK — tracking, geocoding, search, routing           |
+| `@radarlabs/plugin-maps`         | [![npm](https://img.shields.io/npm/v/@radarlabs/plugin-maps.svg)](https://www.npmjs.com/package/@radarlabs/plugin-maps)                 | Maps UI — RadarMap, RadarMarker, RadarPopup (MapLibre GL) |
+| `@radarlabs/plugin-autocomplete` | [![npm](https://img.shields.io/npm/v/@radarlabs/plugin-autocomplete.svg)](https://www.npmjs.com/package/@radarlabs/plugin-autocomplete) | Autocomplete UI widget                                    |
+| `@radarlabs/plugin-fraud`        | [![npm](https://img.shields.io/npm/v/@radarlabs/plugin-fraud.svg)](https://www.npmjs.com/package/@radarlabs/plugin-fraud)               | Fraud detection — verified tracking, location tokens      |
 ## Plugin system
@@ -241,7 +249,7 @@ plugins before or after calling `Radar.initialize()`:
 import Radar from 'radar-sdk-js';
 import { createMapsPlugin } from '@radarlabs/plugin-maps';
 import { createAutocompletePlugin } from '@radarlabs/plugin-autocomplete';
-import { createFraudPlugin } from '@radarlabs/fraud-plugin';
+import { createFraudPlugin } from '@radarlabs/plugin-fraud';
 Radar.registerPlugin(createMapsPlugin());
 Radar.registerPlugin(createAutocompletePlugin());
@@ -257,6 +265,7 @@ import type { RadarPlugin, RadarPluginContext } from 'radar-sdk-js/plugin';
 ```
 ## 🔗 Other links
 - [Contributing](CONTRIBUTING.md)
 - [Migrating from 3.x to 4.x](https://github.com/radarlabs/radar-sdk-js/blob/v4-beta/MIGRATION.md)
 - [Migrating from 4.x to 5.x](MIGRATION.md)

package/dist/api/addresses.d.ts CHANGED Viewed

@@ -1,5 +1,11 @@
 import type { RadarValidateAddressParams, RadarValidateAddressResponse } from '../types';
+/** @internal address validation API — use {@link Radar.validateAddress} instead */
 declare class AddressesAPI {
+    /**
+     * validate a structured address
+     * @param params - address fields to validate
+     * @returns validated address and verification result
+     */
     static validateAddress(params: RadarValidateAddressParams): Promise<RadarValidateAddressResponse>;
 }
 export default AddressesAPI;

package/dist/api/config.d.ts CHANGED Viewed

@@ -1,5 +1,10 @@
 import type { RadarTrackParams } from '../types';
+/** @internal SDK configuration API for fetching remote config */
 declare class ConfigAPI {
+    /**
+     * fetch remote SDK configuration from the Radar API
+     * @param params - optional tracking params for device/session identification
+     */
     static getConfig(params?: RadarTrackParams): Promise<void>;
 }
 export default ConfigAPI;

package/dist/api/context.d.ts CHANGED Viewed

@@ -1,5 +1,11 @@
 import type { RadarContextResponse, Location } from '../types';
+/** @internal context API — use {@link Radar.getContext} instead */
 declare class ContextAPI {
+    /**
+     * get context (geofences, place, region) for a location
+     * @param location - coordinates to get context for
+     * @returns geofences, place, country, state, DMA, and postal code
+     */
     static getContext(location: Location): Promise<RadarContextResponse>;
 }
 export default ContextAPI;

package/dist/api/conversions.d.ts CHANGED Viewed

@@ -1,5 +1,11 @@
 import type { RadarConversionParams, RadarConversionResponse } from '../types';
+/** @internal conversions API — use {@link Radar.logConversion} instead */
 declare class ConversionsAPI {
+    /**
+     * log a conversion event
+     * @param params - conversion name, user info, and optional metadata/revenue
+     * @returns the created event
+     */
     static logConversion(params: RadarConversionParams): Promise<RadarConversionResponse>;
 }
 export default ConversionsAPI;

package/dist/api/geocoding.d.ts CHANGED Viewed

@@ -1,7 +1,22 @@
-import { RadarForwardGeocodeParams, RadarReverseGeocodeParams, RadarGeocodeResponse, RadarIPGeocodeResponse } from '../types';
+import type { RadarForwardGeocodeParams, RadarReverseGeocodeParams, RadarGeocodeResponse, RadarIPGeocodeResponse } from '../types';
+/** @internal geocoding API — use Radar.forwardGeocode / reverseGeocode / ipGeocode instead */
 declare class Geocoding {
+    /**
+     * geocode an address or place name to coordinates
+     * @param params - query string, optional layers and country filter
+     * @returns matching addresses
+     */
     static forwardGeocode(params: RadarForwardGeocodeParams): Promise<RadarGeocodeResponse>;
+    /**
+     * reverse geocode coordinates to addresses
+     * @param params - latitude/longitude, optional layers filter
+     * @returns matching addresses
+     */
     static reverseGeocode(params: RadarReverseGeocodeParams): Promise<RadarGeocodeResponse>;
+    /**
+     * geocode the device's IP address to a rough location
+     * @returns IP address, approximate address, and proxy info
+     */
     static ipGeocode(): Promise<RadarIPGeocodeResponse>;
 }
 export default Geocoding;

package/dist/api/routing.d.ts CHANGED Viewed

@@ -1,6 +1,17 @@
 import type { RadarDistanceParams, RadarRouteResponse, RadarMatrixParams, RadarMatrixResponse } from '../types';
+/** @internal routing API — use Radar.distance / matrix instead */
 declare class RoutingAPI {
+    /**
+     * calculate travel distance and duration between two points
+     * @param params - origin, destination, modes, and units
+     * @returns routes with distance and duration per mode
+     */
     static distance(params: RadarDistanceParams): Promise<RadarRouteResponse>;
+    /**
+     * calculate a distance matrix between multiple origins and destinations
+     * @param params - origins, destinations, mode, and units
+     * @returns matrix of distances and durations
+     */
     static matrix(params: RadarMatrixParams): Promise<RadarMatrixResponse>;
 }
 export default RoutingAPI;

package/dist/api/search.d.ts CHANGED Viewed

@@ -1,7 +1,24 @@
 import type { RadarAutocompleteParams, RadarAutocompleteResponse, RadarSearchPlacesParams, RadarSearchPlacesResponse, RadarSearchGeofencesParams, RadarSearchGeofencesResponse } from '../types';
+/** @internal search API — use Radar.autocomplete / searchGeofences / searchPlaces instead */
 declare class SearchAPI {
+    /**
+     * autocomplete partial addresses and place names
+     * @param params - query and search configuration
+     * @param requestId - optional ID for deduplicating in-flight requests
+     * @returns matching addresses
+     */
     static autocomplete(params: RadarAutocompleteParams, requestId?: string): Promise<RadarAutocompleteResponse>;
+    /**
+     * search for geofences near a location
+     * @param params - location, radius, tags, and filters
+     * @returns matching geofences
+     */
     static searchGeofences(params: RadarSearchGeofencesParams): Promise<RadarSearchGeofencesResponse>;
+    /**
+     * search for places near a location
+     * @param params - location, radius, chains, categories, and groups
+     * @returns matching places
+     */
     static searchPlaces(params: RadarSearchPlacesParams): Promise<RadarSearchPlacesResponse>;
 }
 export default SearchAPI;

package/dist/api/track.d.ts CHANGED Viewed

@@ -1,5 +1,11 @@
 import type { RadarTrackParams, RadarTrackResponse } from '../types';
+/** @internal tracking API — use {@link Radar.trackOnce} instead */
 declare class TrackAPI {
+    /**
+     * track the user's current location once
+     * @param params - tracking parameters (location, user info, trip options)
+     * @returns tracked user, events, and location
+     */
     static trackOnce(params: RadarTrackParams): Promise<RadarTrackResponse>;
 }
 export default TrackAPI;

package/dist/api/trips.d.ts CHANGED Viewed

@@ -1,11 +1,28 @@
 import type { RadarTripOptions, RadarTripStatus, RadarTripResponse } from '../types';
+/** @internal trips API — use Radar.startTrip / updateTrip / completeTrip / cancelTrip instead */
 declare class TripsAPI {
+    /** save trip options to localStorage, pass `undefined` to clear */
     static setTripOptions(tripOptions?: RadarTripOptions): void;
+    /** get saved trip options from localStorage */
     static getTripOptions(): RadarTripOptions;
+    /** remove saved trip options from localStorage */
     static clearTripOptions(): void;
+    /**
+     * start a new trip
+     * @param tripOptions - trip configuration and destination
+     * @returns the created trip and any triggered events
+     */
     static startTrip(tripOptions: RadarTripOptions): Promise<RadarTripResponse>;
+    /**
+     * update an in-progress trip
+     * @param tripOptions - updated trip configuration
+     * @param status - optional trip status override
+     * @returns the updated trip and any triggered events
+     */
     static updateTrip(tripOptions: RadarTripOptions, status?: RadarTripStatus): Promise<RadarTripResponse>;
+    /** complete the current trip and clear local trip options */
     static completeTrip(): Promise<RadarTripResponse>;
+    /** cancel the current trip and clear local trip options */
     static cancelTrip(): Promise<RadarTripResponse>;
 }
 export default TripsAPI;

package/dist/api.d.ts CHANGED Viewed

@@ -1,37 +1,80 @@
-import { RadarError } from './errors';
+import type { RadarError } from './errors';
 import type { RadarPlugin } from './plugin';
 import type { Location, NavigatorPosition, RadarAutocompleteParams, RadarAutocompleteResponse, RadarContextResponse, RadarConversionParams, RadarConversionResponse, RadarDistanceParams, RadarForwardGeocodeParams, RadarGeocodeResponse, RadarIPGeocodeResponse, RadarMatrixParams, RadarMatrixResponse, RadarMetadata, RadarOptions, RadarReverseGeocodeParams, RadarRouteResponse, RadarSearchGeofencesParams, RadarSearchGeofencesResponse, RadarSearchPlacesParams, RadarSearchPlacesResponse, RadarTrackParams, RadarTrackResponse, RadarTripOptions, RadarTripResponse, RadarValidateAddressParams, RadarValidateAddressResponse } from './types';
+/**
+ * main entry point for the Radar SDK. all methods are static — do not instantiate.
+ *
+ * @example
+ * ```ts
+ * Radar.initialize('prj_test_pk_...');
+ * const { user, events } = await Radar.trackOnce();
+ * ```
+ */
 declare class Radar {
     private static _plugins;
+    /** current SDK version string */
     static get VERSION(): string;
+    /** register one or more plugins (e.g. maps, autocomplete, fraud) */
     static registerPlugin(...plugins: RadarPlugin[]): void;
     private static _getPluginContext;
+    /**
+     * initialize the SDK with a publishable key. must be called before any other method.
+     * @param publishableKey - your Radar publishable key (starts with `prj_test_pk_` or `prj_live_pk_`)
+     * @param options - optional SDK configuration
+     * @throws {RadarPublishableKeyError} if the key is missing or is a secret key
+     */
     static initialize(publishableKey: string, options?: RadarOptions): void;
+    /** clear all SDK state and configuration */
     static clear(): void;
+    /** set the user ID for tracking. pass `undefined` to clear. */
     static setUserId(userId?: string): void;
+    /** set a description for the current user. pass `undefined` to clear. */
     static setDescription(description?: string): void;
+    /** set custom metadata for the current user. pass `undefined` to clear. */
     static setMetadata(metadata?: RadarMetadata): void;
+    /** get the device's current location using the browser geolocation API */
     static getLocation(): Promise<NavigatorPosition>;
+    /** track the user's current location once, returning location context and events */
     static trackOnce(params?: RadarTrackParams): Promise<RadarTrackResponse>;
+    /** get context (geofences, place, regions) for a location without tracking */
     static getContext(params: Location): Promise<RadarContextResponse>;
+    /** save trip options for tracking. pass `undefined` to clear */
     static setTripOptions(tripOptions?: RadarTripOptions): void;
+    /** clear saved trip options */
     static clearTripOptions(): void;
+    /** get the currently saved trip options */
     static getTripOptions(): RadarTripOptions;
+    /** start a new trip with the given options */
     static startTrip(tripOptions: RadarTripOptions): Promise<RadarTripResponse>;
+    /** update an in-progress trip */
     static updateTrip(tripOptions: RadarTripOptions): Promise<RadarTripResponse>;
+    /** complete the current trip and clear local trip options */
     static completeTrip(): Promise<RadarTripResponse>;
+    /** cancel the current trip and clear local trip options */
     static cancelTrip(): Promise<RadarTripResponse>;
+    /** log a conversion event */
     static logConversion(params: RadarConversionParams): Promise<RadarConversionResponse>;
+    /** set the product identifier for tracking requests. pass `undefined` to clear */
     static setProduct(product?: string): void;
+    /** register a global error callback invoked on SDK errors */
     static onError(callback: (error: RadarError) => void): void;
+    /** geocode an address or place name to coordinates */
     static forwardGeocode(params: RadarForwardGeocodeParams): Promise<RadarGeocodeResponse>;
+    /** reverse geocode coordinates to addresses */
     static reverseGeocode(params: RadarReverseGeocodeParams): Promise<RadarGeocodeResponse>;
+    /** geocode the device's IP address to a rough location */
     static ipGeocode(): Promise<RadarIPGeocodeResponse>;
+    /** autocomplete partial addresses and place names */
     static autocomplete(params: RadarAutocompleteParams): Promise<RadarAutocompleteResponse>;
+    /** search for geofences near a location */
     static searchGeofences(params: RadarSearchGeofencesParams): Promise<RadarSearchGeofencesResponse>;
+    /** search for places (POIs) near a location */
     static searchPlaces(params: RadarSearchPlacesParams): Promise<RadarSearchPlacesResponse>;
+    /** validate a structured address */
     static validateAddress(params: RadarValidateAddressParams): Promise<RadarValidateAddressResponse>;
+    /** calculate travel distance and duration between two points */
     static distance(params: RadarDistanceParams): Promise<RadarRouteResponse>;
+    /** calculate a distance matrix between multiple origins and destinations */
     static matrix(params: RadarMatrixParams): Promise<RadarMatrixResponse>;
 }
 export default Radar;

package/dist/config.d.ts CHANGED Viewed

@@ -1,8 +1,12 @@
-import { RadarError } from './errors';
+import type { RadarError } from './errors';
 import type { RadarOptions } from './types';
+/** global SDK configuration singleton */
 declare class Config {
+    /** current SDK options */
     static options: RadarOptions;
+    /** registered error callback, if any */
     static errorCallback: ((error: RadarError) => void) | null;
+    /** default option values applied during initialization */
     static defaultOptions: {
         live: boolean;
         logLevel: string;
@@ -10,10 +14,15 @@ declare class Config {
         version: string;
         debug: boolean;
     };
+    /** store SDK options (called by Radar.initialize) */
     static setup(options?: RadarOptions): void;
+    /** get the current SDK options */
     static get(): RadarOptions;
+    /** clear all SDK options and error callback */
     static clear(): void;
+    /** register a callback invoked on SDK errors */
     static onError(callback: (error: RadarError) => void): void;
+    /** dispatch an error to the registered callback */
     static sendError(error: any): void;
 }
 export default Config;

package/dist/device.d.ts CHANGED Viewed

@@ -1,5 +1,14 @@
+/** device and install ID manager backed by localStorage */
 declare class Device {
+    /**
+     * get or generate a persistent device ID
+     * @returns the device UUID (persisted in localStorage)
+     */
     static getDeviceId(): string;
+    /**
+     * get or generate a persistent install ID
+     * @returns the install UUID (persisted in localStorage)
+     */
     static getInstallId(): string;
 }
 export default Device;

package/dist/errors.d.ts CHANGED Viewed

@@ -1,55 +1,71 @@
+import type { RadarResponse } from './http';
+/** base error class for all Radar SDK errors */
 export declare class RadarError extends Error {
+    /** legacy status code string (e.g. `'ERROR_PUBLISHABLE_KEY'`) */
     status: string;
     constructor(message: string);
 }
+/** thrown when a publishable key is missing or invalid (e.g. secret key used) */
 export declare class RadarPublishableKeyError extends RadarError {
     constructor(message: string);
 }
+/** thrown when the device location cannot be determined */
 export declare class RadarLocationError extends RadarError {
     constructor(message: string);
 }
+/** thrown when location permissions are denied by the browser */
 export declare class RadarPermissionsError extends RadarError {
     constructor(message: string);
 }
+/** thrown on HTTP 400 Bad Request responses */
 export declare class RadarBadRequestError extends RadarError {
     code: number;
-    response?: any;
-    constructor(response?: any);
+    response?: RadarResponse;
+    constructor(response?: RadarResponse);
 }
+/** thrown on HTTP 401 Unauthorized responses */
 export declare class RadarUnauthorizedError extends RadarError {
     code: number;
-    response?: any;
-    constructor(response?: any);
+    response?: RadarResponse;
+    constructor(response?: RadarResponse);
 }
+/** thrown on HTTP 402 Payment Required responses */
 export declare class RadarPaymentRequiredError extends RadarError {
     code: number;
-    response?: any;
-    constructor(response?: any);
+    response?: RadarResponse;
+    constructor(response?: RadarResponse);
 }
+/** thrown on HTTP 403 Forbidden responses */
 export declare class RadarForbiddenError extends RadarError {
     code: number;
-    response?: any;
-    constructor(response?: any);
+    response?: RadarResponse;
+    constructor(response?: RadarResponse);
 }
+/** thrown on HTTP 404 Not Found responses */
 export declare class RadarNotFoundError extends RadarError {
     code: number;
-    response?: any;
-    constructor(response?: any);
+    response?: RadarResponse;
+    constructor(response?: RadarResponse);
 }
+/** thrown on HTTP 429 Rate Limit responses */
 export declare class RadarRateLimitError extends RadarError {
     code: number;
-    response?: any;
-    type: string;
-    constructor(response?: any);
+    response?: RadarResponse;
+    /** rate limit type from the API response (e.g. `'hourly'`) */
+    type?: string;
+    constructor(response?: RadarResponse);
 }
+/** thrown on HTTP 5xx server errors */
 export declare class RadarServerError extends RadarError {
-    response?: any;
-    constructor(response?: any);
+    response?: RadarResponse;
+    constructor(response?: RadarResponse);
 }
+/** thrown when a request times out or the network is unavailable */
 export declare class RadarNetworkError extends RadarError {
     constructor();
 }
+/** thrown for unexpected/unclassified errors */
 export declare class RadarUnknownError extends RadarError {
-    response?: any;
-    constructor(response?: any);
+    response?: RadarResponse;
+    constructor(response?: RadarResponse);
 }

package/dist/http.d.ts CHANGED Viewed

@@ -1,20 +1,58 @@
-export type HttpMethod = 'GET' | 'PUT' | 'PATCH' | 'POST' | 'DELETE';
-interface HttpResponse {
+/** HTTP methods supported by the SDK */
+type HttpMethod = 'GET' | 'PUT' | 'PATCH' | 'POST' | 'DELETE';
+/** Shape of the `meta` field present in all Radar API responses */
+interface RadarApiMeta {
+    error?: string;
+    message?: string;
+    type?: string;
+}
+/** Base shape all Radar API JSON responses share */
+interface RadarApiResponse {
+    meta?: RadarApiMeta;
+    [key: string]: unknown;
+}
+/** Blob response shape returned when responseType is 'blob' */
+interface RadarBlobResponse {
+    meta?: undefined;
     code: number;
-    data: any;
+    data: Blob;
+}
+export type RadarResponse = RadarApiResponse | RadarBlobResponse;
+/** Request configuration for Http.request */
+interface HttpRequestOptions {
+    method: HttpMethod;
+    path: string;
+    data?: Record<string, any>;
+    host?: string;
+    version?: string;
+    headers?: Record<string, string>;
+    responseType?: 'blob' | 'json';
+    requestId?: string;
 }
+/** fetch-based HTTP client for Radar API requests */
 declare class Http {
+    /** map of host patterns to custom error factories for intercepting network errors */
     static errorInterceptors: Map<string, (online: boolean) => Error>;
+    /**
+     * register a custom error factory for network errors matching a host pattern
+     * @param hostPattern - substring matched against the request host
+     * @param handler - factory that receives online status and returns an error
+     */
     static registerErrorInterceptor(hostPattern: string, handler: (online: boolean) => Error): void;
-    static request({ method, path, data, host, version, headers, responseType, requestId, }: {
-        method: HttpMethod;
-        path: string;
-        data?: any;
-        host?: string;
-        version?: string;
-        headers?: Record<string, string>;
-        responseType?: XMLHttpRequestResponseType;
-        requestId?: string;
-    }): Promise<HttpResponse>;
+    /**
+     * send an HTTP request to the Radar API
+     * @param options - request configuration
+     * @returns parsed response body, typed as `T`
+     * @throws {RadarPublishableKeyError} if publishable key is not set
+     * @throws {RadarBadRequestError} on 400 responses
+     * @throws {RadarUnauthorizedError} on 401 responses
+     * @throws {RadarNetworkError} on network failures
+     */
+    static request(options: HttpRequestOptions & {
+        responseType: 'blob';
+    }): Promise<RadarBlobResponse>;
+    static request<T extends Record<string, any> = RadarApiResponse>(options: HttpRequestOptions): Promise<T & {
+        meta?: RadarApiMeta;
+    }>;
 }
 export default Http;

package/dist/iife-entry.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import RadarBase, { RadarError } from ".";
+import RadarBase, { RadarError } from '.';
 declare class Radar extends RadarBase {
     static RadarError: typeof RadarError;
 }

package/dist/logger.d.ts CHANGED Viewed

@@ -1,7 +1,12 @@
+/** leveled console logger controlled by SDK config */
 declare class Logger {
+    /** log a debug-level message (only when debug mode is enabled) */
     static debug(message: string, options?: any): void;
+    /** log an info-level message */
     static info(message: string): void;
+    /** log a warning-level message */
     static warn(message: string): void;
+    /** log an error-level message */
     static error(message: string): void;
 }
 export default Logger;