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

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

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 (21) hide show

package/README.md CHANGED Viewed

@@ -57,7 +57,7 @@ Radar.initialize('prj_test_pk_...', {
 Add the following to your HTML:
 ```html
-<script src="https://js.radar.com/v5.0.0-beta.6/radar.min.js"></script>
+<script src="https://js.radar.com/v5.0.0-beta.8/radar.min.js"></script>
 <script>
   Radar.initialize('prj_test_pk_...', {
@@ -138,7 +138,7 @@ the core SDK first, then any plugins you need:
 <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.6/radar.min.js"></script>
+<script src="https://js.radar.com/v5.0.0-beta.8/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>
@@ -155,7 +155,7 @@ by ID or element reference.
 <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.6/radar.min.js"></script>
+    <script src="https://js.radar.com/v5.0.0-beta.8/radar.min.js"></script>
     <script src="https://js.radar.com/maps/v5.0.0-beta.4/radar-maps.min.js"></script>
   </head>
@@ -182,7 +182,7 @@ by ID or element reference.
 <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.6/radar.min.js"></script>
+    <script src="https://js.radar.com/v5.0.0-beta.8/radar.min.js"></script>
     <script src="https://js.radar.com/autocomplete/v5.0.0-beta.4/radar-autocomplete.min.js"></script>
   </head>
@@ -215,7 +215,7 @@ are needed for geofencing.
 ```html
 <html>
   <head>
-    <script src="https://js.radar.com/v5.0.0-beta.6/radar.min.js"></script>
+    <script src="https://js.radar.com/v5.0.0-beta.8/radar.min.js"></script>
   </head>
   <body>

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

@@ -1,10 +1,19 @@
-import type { RadarTrackParams } from '../types';
+import type { RadarConfigResponse, RadarTrackParams } from '../types';
+/** options for customizing the config request (e.g. host, headers) */
+interface ConfigRequestOptions {
+    /** override the API host */
+    host?: string;
+    /** additional headers to include in the request */
+    headers?: Record<string, string>;
+}
 /** @internal SDK configuration API for fetching remote config */
 declare class ConfigAPI {
     /**
-     * fetch remote SDK configuration from the Radar API
+     * fetch remote SDK configuration from the Radar API. Generic so plugins can extend the response shape.
+     *
      * @param params - optional tracking params for device/session identification
+     * @param options - optional request overrides (host, headers)
      */
-    static getConfig(params?: RadarTrackParams): Promise<void>;
+    static getConfig<T extends RadarConfigResponse = RadarConfigResponse>(params?: RadarTrackParams, options?: ConfigRequestOptions): Promise<T>;
 }
 export default ConfigAPI;

package/dist/api.d.ts CHANGED Viewed

@@ -65,7 +65,7 @@ declare class Radar {
     /** 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>;
+    static autocomplete(params: RadarAutocompleteParams, requestId?: string): Promise<RadarAutocompleteResponse>;
     /** search for geofences near a location */
     static searchGeofences(params: RadarSearchGeofencesParams): Promise<RadarSearchGeofencesResponse>;
     /** search for places (POIs) near a location */

package/dist/errors.d.ts CHANGED Viewed

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

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

@@ -1,5 +1,17 @@
-import RadarBase, { RadarError } from '.';
+import RadarBase, * as exports from '.';
 declare class Radar extends RadarBase {
-    static RadarError: typeof RadarError;
+    static RadarError: typeof exports.RadarError;
+    static RadarPublishableKeyError: typeof exports.RadarPublishableKeyError;
+    static RadarLocationError: typeof exports.RadarLocationError;
+    static RadarPermissionsError: typeof exports.RadarPermissionsError;
+    static RadarBadRequestError: typeof exports.RadarBadRequestError;
+    static RadarUnauthorizedError: typeof exports.RadarUnauthorizedError;
+    static RadarPaymentRequiredError: typeof exports.RadarPaymentRequiredError;
+    static RadarForbiddenError: typeof exports.RadarForbiddenError;
+    static RadarNotFoundError: typeof exports.RadarNotFoundError;
+    static RadarRateLimitError: typeof exports.RadarRateLimitError;
+    static RadarServerError: typeof exports.RadarServerError;
+    static RadarNetworkError: typeof exports.RadarNetworkError;
+    static RadarUnknownError: typeof exports.RadarUnknownError;
 }
 export default Radar;

package/dist/index.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
 export { default, default as Radar } from './api';
-export { RadarError } from './errors';
+export * from './errors';
 export type * from './types';
 export type { RadarPlugin, RadarPluginContext } from './plugin';

package/dist/plugin.d.ts CHANGED Viewed

@@ -10,7 +10,6 @@ import type TrackAPI from './api/track';
 import type TripsAPI from './api/trips';
 import type Config from './config';
 import type Device from './device';
-import type * as errors from './errors';
 import type Http from './http';
 import type Logger from './logger';
 import type Navigator from './navigator';
@@ -45,10 +44,6 @@ export interface RadarPluginContext {
     Logger: typeof Logger;
     /** browser geolocation wrapper */
     Navigator: typeof Navigator;
-    /** current SDK version string */
-    SDK_VERSION: string;
-    /** all Radar error classes */
-    errors: typeof errors;
     /** internal API modules for making Radar API calls */
     apis: {
         Addresses: typeof AddressesAPI;

package/dist/radar.js CHANGED Viewed

@@ -39,7 +39,6 @@ Config.defaultOptions = {
 class RadarError extends Error {
     constructor(message) {
         super(message);
-        this.status = ''; // to be overridden (support for legacy status)
     }
 }
 /** thrown when a publishable key is missing or invalid (e.g. secret key used) */
@@ -71,9 +70,9 @@ class RadarBadRequestError extends RadarError {
     constructor(response) {
         super(response?.meta?.message || 'Bad request.');
         this.name = 'RadarBadRequestError';
+        this.status = 'ERROR_BAD_REQUEST';
         this.code = 400;
         this.response = response;
-        this.status = 'ERROR_BAD_REQUEST';
     }
 }
 /** thrown on HTTP 401 Unauthorized responses */
@@ -81,9 +80,9 @@ class RadarUnauthorizedError extends RadarError {
     constructor(response) {
         super(response?.meta?.message || 'Unauthorized.');
         this.name = 'RadarUnauthorizedError';
+        this.status = 'ERROR_UNAUTHORIZED';
         this.code = 401;
         this.response = response;
-        this.status = 'ERROR_UNAUTHORIZED';
     }
 }
 /** thrown on HTTP 402 Payment Required responses */
@@ -91,9 +90,9 @@ class RadarPaymentRequiredError extends RadarError {
     constructor(response) {
         super(response?.meta?.message || 'Payment required.');
         this.name = 'RadarPaymentRequiredError';
+        this.status = 'ERROR_PAYMENT_REQUIRED';
         this.code = 402;
         this.response = response;
-        this.status = 'ERROR_PAYMENT_REQUIRED';
     }
 }
 /** thrown on HTTP 403 Forbidden responses */
@@ -101,9 +100,9 @@ class RadarForbiddenError extends RadarError {
     constructor(response) {
         super(response?.meta?.message || 'Forbidden.');
         this.name = 'RadarForbiddenError';
+        this.status = 'ERROR_FORBIDDEN';
         this.code = 403;
         this.response = response;
-        this.status = 'ERROR_FORBIDDEN';
     }
 }
 /** thrown on HTTP 404 Not Found responses */
@@ -111,9 +110,9 @@ class RadarNotFoundError extends RadarError {
     constructor(response) {
         super(response?.meta?.message || 'Not found.');
         this.name = 'RadarNotFoundError';
+        this.status = 'ERROR_NOT_FOUND';
         this.code = 404;
         this.response = response;
-        this.status = 'ERROR_NOT_FOUND';
     }
 }
 /** thrown on HTTP 429 Rate Limit responses */
@@ -121,10 +120,10 @@ class RadarRateLimitError extends RadarError {
     constructor(response) {
         super(response?.meta?.message || 'Rate limit exceeded.');
         this.name = 'RadarRateLimitError';
+        this.status = 'ERROR_RATE_LIMIT';
         this.code = 429;
         this.response = response;
         this.type = response?.meta?.type;
-        this.status = 'ERROR_RATE_LIMIT';
     }
 }
 /** thrown on HTTP 5xx server errors */
@@ -132,8 +131,8 @@ class RadarServerError extends RadarError {
     constructor(response) {
         super(response?.meta?.message || 'Internal server error.');
         this.name = 'RadarServerError';
-        this.response = response;
         this.status = 'ERROR_SERVER';
+        this.response = response;
     }
 }
 /** thrown when a request times out or the network is unavailable */
@@ -149,28 +148,11 @@ class RadarUnknownError extends RadarError {
     constructor(response) {
         super(response?.meta?.message || 'Something went wrong.');
         this.name = 'RadarUnknownError';
-        this.response = response;
         this.status = 'ERROR_UNKNOWN';
+        this.response = response;
     }
 }
-var errors = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    RadarBadRequestError: RadarBadRequestError,
-    RadarError: RadarError,
-    RadarForbiddenError: RadarForbiddenError,
-    RadarLocationError: RadarLocationError,
-    RadarNetworkError: RadarNetworkError,
-    RadarNotFoundError: RadarNotFoundError,
-    RadarPaymentRequiredError: RadarPaymentRequiredError,
-    RadarPermissionsError: RadarPermissionsError,
-    RadarPublishableKeyError: RadarPublishableKeyError,
-    RadarRateLimitError: RadarRateLimitError,
-    RadarServerError: RadarServerError,
-    RadarUnauthorizedError: RadarUnauthorizedError,
-    RadarUnknownError: RadarUnknownError
-});
 const LOG_LEVELS = {
     none: 0,
     error: 1,
@@ -452,7 +434,7 @@ class Navigator {
     }
 }
-var SDK_VERSION = '5.0.0-beta.6';
+var SDK_VERSION = '5.0.0-beta.8';
 const inFlightRequests = new Map();
 /** fetch-based HTTP client for Radar API requests */
@@ -516,7 +498,8 @@ class Http {
             });
         }
         catch {
-            if (requestId) {
+            // Delete abort controller instance for this request ID if it hasn't yet been replaced with a different one
+            if (requestId && inFlightRequests.get(requestId) === abortController) {
                 inFlightRequests.delete(requestId);
             }
             if (host) {
@@ -528,7 +511,7 @@ class Http {
             }
             throw new RadarNetworkError();
         }
-        if (requestId) {
+        if (requestId && inFlightRequests.get(requestId) === abortController) {
             inFlightRequests.delete(requestId);
         }
         let parsed;
@@ -540,8 +523,17 @@ class Http {
                 parsed = (await response.json());
             }
         }
-        catch {
-            throw new RadarServerError(parsed);
+        catch (err) {
+            if (parsed) {
+                throw new RadarServerError(parsed);
+            }
+            else {
+                if (options.debug) {
+                    Logger.debug(`API call failed: ${url}`);
+                    Logger.debug(String(err));
+                }
+                throw new RadarUnknownError(parsed);
+            }
         }
         if (parsed && typeof parsed === 'object' && 'meta' in parsed) {
             const error = parsed.meta?.error;
@@ -555,7 +547,7 @@ class Http {
                 throw new RadarNetworkError();
             }
         }
-        if (response.status === 200) {
+        if (response.ok) {
             return parsed;
         }
         if (options.debug) {
@@ -692,15 +684,12 @@ class Session {
 /** @internal SDK configuration API for fetching remote config */
 class ConfigAPI {
     /**
-     * fetch remote SDK configuration from the Radar API
+     * fetch remote SDK configuration from the Radar API. Generic so plugins can extend the response shape.
+     *
      * @param params - optional tracking params for device/session identification
+     * @param options - optional request overrides (host, headers)
      */
-    static async getConfig(params = {}) {
-        const options = Config.get();
-        if (options.version != 'v1') {
-            Logger.info('Skipping /config call.');
-            return;
-        }
+    static async getConfig(params = {}, options = {}) {
         const deviceId = params.deviceId || Device.getDeviceId();
         const installId = params.installId || Device.getInstallId();
         const sessionId = Session.getSessionId();
@@ -718,16 +707,13 @@ class ConfigAPI {
             sessionId,
             locationAuthorization,
         };
-        try {
-            await Http.request({
-                method: 'GET',
-                path: 'config',
-                data,
-            });
-        }
-        catch (err) {
-            Logger.warn(`Error calling /config: ${err.message}`);
-        }
+        return Http.request({
+            method: 'GET',
+            path: 'config',
+            data,
+            host: options.host,
+            headers: options.headers,
+        });
     }
 }
@@ -1384,8 +1370,6 @@ class Radar {
             Session,
             Logger,
             Navigator,
-            SDK_VERSION,
-            errors,
             apis: {
                 Addresses: AddressesAPI,
                 Config: ConfigAPI,
@@ -1430,7 +1414,9 @@ class Radar {
         // NOTE(jasonl): this allows us to run jest tests
         // without having to mock the ConfigAPI.getConfig call
         if (!window?.RADAR_TEST_ENV) {
-            void ConfigAPI.getConfig();
+            ConfigAPI.getConfig().catch((err) => {
+                Logger.warn(`Error calling /config: ${err.message}`);
+            });
         }
     }
     /** clear all SDK state and configuration */
@@ -1474,7 +1460,10 @@ class Radar {
             return TrackAPI.trackOnce(params);
         }
         finally {
-            void ConfigAPI.getConfig(params); // call with updated permissions
+            // call with updated permissions
+            ConfigAPI.getConfig(params).catch((err) => {
+                Logger.warn(`Error calling /config: ${err.message}`);
+            });
         }
     }
     /** get context (geofences, place, regions) for a location without tracking */
@@ -1544,8 +1533,8 @@ class Radar {
         return Geocoding.ipGeocode();
     }
     /** autocomplete partial addresses and place names */
-    static autocomplete(params) {
-        return SearchAPI.autocomplete(params);
+    static autocomplete(params, requestId) {
+        return SearchAPI.autocomplete(params, requestId);
     }
     /** search for geofences near a location */
     static searchGeofences(params) {
@@ -1570,5 +1559,5 @@ class Radar {
 }
 Radar._plugins = new Map();
-export { Radar, RadarError, Radar as default };
+export { Radar, RadarBadRequestError, RadarError, RadarForbiddenError, RadarLocationError, RadarNetworkError, RadarNotFoundError, RadarPaymentRequiredError, RadarPermissionsError, RadarPublishableKeyError, RadarRateLimitError, RadarServerError, RadarUnauthorizedError, RadarUnknownError, Radar as default };
 //# sourceMappingURL=radar.js.map