npm - radar-sdk-js - Versions diffs - 5.0.0 → 5.1.0-beta.1 - Mend

radar-sdk-js 5.0.0 → 5.1.0-beta.1

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

package/README.md CHANGED Viewed

@@ -46,10 +46,8 @@ 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 */
-});
+// initialize with your publishable key
+Radar.initialize({ publishableKey: 'prj_test_pk_...' });
 ```
 ### With a script tag
@@ -57,12 +55,10 @@ Radar.initialize('prj_test_pk_...', {
 Add the following to your HTML:
 ```html
-<script src="https://js.radar.com/v5.0.0/radar.min.js"></script>
+<script src="https://js.radar.com/v5.1.0-beta.1/radar.min.js"></script>
 <script>
-  Radar.initialize('prj_test_pk_...', {
-    /* options */
-  });
+  Radar.initialize({ publishableKey: 'prj_test_pk_...' });
 </script>
 ```
@@ -84,7 +80,7 @@ import { createMapsPlugin } from '@radarlabs/plugin-maps';
 import '@radarlabs/plugin-maps/dist/radar-maps.css';
 Radar.registerPlugin(createMapsPlugin());
-Radar.initialize('prj_test_pk_...');
+Radar.initialize({ publishableKey: 'prj_test_pk_...' });
 const map = Radar.ui.map({
   container: 'map',
@@ -103,7 +99,7 @@ import { createAutocompletePlugin } from '@radarlabs/plugin-autocomplete';
 import '@radarlabs/plugin-autocomplete/dist/radar-autocomplete.css';
 Radar.registerPlugin(createAutocompletePlugin());
-Radar.initialize('prj_test_pk_...');
+Radar.initialize({ publishableKey: 'prj_test_pk_...' });
 Radar.ui.autocomplete({
   container: 'autocomplete',
@@ -124,7 +120,7 @@ import Radar from 'radar-sdk-js';
 import { createFraudPlugin } from '@radarlabs/plugin-fraud';
 Radar.registerPlugin(createFraudPlugin());
-Radar.initialize('prj_live_pk_...');
+Radar.initialize({ publishableKey: 'prj_live_pk_...' });
 const { token, user, events } = await Radar.fraud.trackVerified();
 ```
@@ -136,11 +132,11 @@ the core SDK first, then any plugins you need:
 ```html
 <link href="https://js.radar.com/maps/v1.0.0/radar-maps.css" rel="stylesheet" />
-<link href="https://js.radar.com/autocomplete/v1.0.0/radar-autocomplete.css" rel="stylesheet" />
+<link href="https://js.radar.com/autocomplete/v1.1.0/radar-autocomplete.css" rel="stylesheet" />
-<script src="https://js.radar.com/v5.0.0/radar.min.js"></script>
+<script src="https://js.radar.com/v5.1.0-beta.1/radar.min.js"></script>
 <script src="https://js.radar.com/maps/v1.0.0/radar-maps.min.js"></script>
-<script src="https://js.radar.com/autocomplete/v1.0.0/radar-autocomplete.min.js"></script>
+<script src="https://js.radar.com/autocomplete/v1.1.0/radar-autocomplete.min.js"></script>
 <script src="https://js.radar.com/fraud/v1.0.0/radar-fraud.min.js"></script>
 ```
@@ -155,7 +151,7 @@ by ID or element reference.
 <html>
   <head>
     <link href="https://js.radar.com/maps/v1.0.0/radar-maps.css" rel="stylesheet" />
-    <script src="https://js.radar.com/v5.0.0/radar.min.js"></script>
+    <script src="https://js.radar.com/v5.1.0-beta.1/radar.min.js"></script>
     <script src="https://js.radar.com/maps/v1.0.0/radar-maps.min.js"></script>
   </head>
@@ -163,7 +159,7 @@ by ID or element reference.
     <div id="map" style="width: 100%; height: 500px;" />
     <script>
-      Radar.initialize('<RADAR_PUBLISHABLE_KEY>');
+      Radar.initialize({ publishableKey: '<RADAR_PUBLISHABLE_KEY>' });
       const map = Radar.ui.map({
         container: 'map', // OR document.getElementById('map')
@@ -181,16 +177,16 @@ by ID or element reference.
 ```html
 <html>
   <head>
-    <link href="https://js.radar.com/autocomplete/v1.0.0/radar-autocomplete.css" rel="stylesheet" />
-    <script src="https://js.radar.com/v5.0.0/radar.min.js"></script>
-    <script src="https://js.radar.com/autocomplete/v1.0.0/radar-autocomplete.min.js"></script>
+    <link href="https://js.radar.com/autocomplete/v1.1.0/radar-autocomplete.css" rel="stylesheet" />
+    <script src="https://js.radar.com/v5.1.0-beta.1/radar.min.js"></script>
+    <script src="https://js.radar.com/autocomplete/v1.1.0/radar-autocomplete.min.js"></script>
   </head>
   <body>
     <div id="autocomplete" />
     <script>
-      Radar.initialize('<RADAR_PUBLISHABLE_KEY>');
+      Radar.initialize({ publishableKey: '<RADAR_PUBLISHABLE_KEY>' });
       // create autocomplete widget
       Radar.ui.autocomplete({
@@ -215,12 +211,12 @@ are needed for geofencing.
 ```html
 <html>
   <head>
-    <script src="https://js.radar.com/v5.0.0/radar.min.js"></script>
+    <script src="https://js.radar.com/v5.1.0-beta.1/radar.min.js"></script>
   </head>
   <body>
     <script>
-      Radar.initialize('<RADAR_PUBLISHABLE_KEY>');
+      Radar.initialize({ publishableKey: '<RADAR_PUBLISHABLE_KEY>' });
       Radar.trackOnce({ userId: 'example-user-id' }).then(({ location, user, events }) => {
         // do something with user location or events
@@ -254,7 +250,7 @@ import { createFraudPlugin } from '@radarlabs/plugin-fraud';
 Radar.registerPlugin(createMapsPlugin());
 Radar.registerPlugin(createAutocompletePlugin());
 Radar.registerPlugin(createFraudPlugin());
-Radar.initialize('prj_test_pk_...');
+Radar.initialize({ publishableKey: 'prj_test_pk_...' });
 ```
 If you're building a custom plugin, import the plugin types from the

package/dist/api.d.ts CHANGED Viewed

@@ -1,13 +1,13 @@
 import * as errors 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';
+import type { Location, NavigatorPosition, RadarAutocompleteParams, RadarAutocompleteResponse, RadarContextResponse, RadarConversionParams, RadarConversionResponse, RadarDistanceParams, RadarForwardGeocodeParams, RadarGeocodeResponse, RadarIPGeocodeResponse, RadarMatrixParams, RadarMatrixResponse, RadarMetadata, RadarInitOptions, 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_...');
+ * Radar.initialize({ publishableKey: 'prj_test_pk_...' });
  * const { user, events } = await Radar.trackOnce();
  * ```
  */
@@ -20,7 +20,13 @@ declare class Radar {
     static registerPlugin(...plugins: RadarPlugin[]): void;
     private static _getPluginContext;
     /**
-     * initialize the SDK with a publishable key. must be called before any other method.
+     * initialize the SDK with an authToken or publishable key via options object.
+     * @param options - SDK configuration with `authToken` or `publishableKey`
+     * @throws {RadarPublishableKeyError} if credentials are missing or invalid
+     */
+    static initialize(options: RadarInitOptions): void;
+    /**
+     * initialize the SDK with a publishable key string.
      * @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

package/dist/config.d.ts CHANGED Viewed

@@ -24,5 +24,9 @@ declare class Config {
     static onError(callback: (error: RadarError) => void): void;
     /** dispatch an error to the registered callback */
     static sendError(error: any): void;
+    /** build standard Radar request headers (Authorization, Device-Type, SDK-Version).
+     * Callers must ensure credentials are set before calling (e.g. via Radar.initialize).
+     * */
+    static getDefaultHeaders(): Record<string, string>;
 }
 export default Config;

package/dist/dns-over-https.d.ts ADDED Viewed

@@ -0,0 +1,29 @@
+export type DnsProbeResult = {
+    status: 'success';
+    hostname: string;
+    resolver: 'cloudflare-dns.com';
+    dnsStatus: number;
+    ipv4Answers: string[];
+} | {
+    status: 'no_answers';
+    hostname: string;
+    resolver: 'cloudflare-dns.com';
+    dnsStatus: number;
+    answerCount: number;
+    note: string;
+} | {
+    status: 'http_error';
+    hostname: string;
+    resolver: 'cloudflare-dns.com';
+    httpStatus: number;
+} | {
+    status: 'fetch_error';
+    hostname: string;
+    resolver: 'cloudflare-dns.com';
+    errorMessage: string;
+};
+/**
+ * Runs at most one DoH probe per hostname per page load. Returns a promise you can await
+ * from `RadarNetworkError.dnsProbe` — does not block the throwing error path.
+ */
+export declare function scheduleDnsOverHttpsProbe(hostname: string | undefined, correlation: Record<string, unknown>): Promise<DnsProbeResult> | null;

package/dist/errors.d.ts CHANGED Viewed

@@ -1,4 +1,6 @@
+import type { DnsProbeResult } from './dns-over-https';
 import type { RadarResponse } from './http';
+export type { DnsProbeResult };
 /** base error class for all Radar SDK errors */
 export declare abstract class RadarError extends Error {
     /** legacy status code string (e.g. `'ERROR_PUBLISHABLE_KEY'`) */
@@ -81,11 +83,59 @@ export declare class RadarServerError extends RadarError {
     readonly response?: RadarResponse;
     constructor(response?: RadarResponse);
 }
+/**
+ * Diagnostics captured when fetch() rejects before any HTTP response is received.
+ * Safe to stringify for logs — does not include request headers or bodies.
+ */
+export interface RadarNetworkFailureDetails {
+    readonly phase: 'fetch';
+    readonly method: string;
+    readonly url: string;
+    readonly pathname: string;
+    readonly search: string;
+    /** hostname parsed from the request URL */
+    readonly apiHostname?: string;
+    /** document origin when in a browser */
+    readonly pageOrigin?: string;
+    /** document pathname when in a browser */
+    readonly pagePath?: string;
+    /** `navigator.userAgent` when available */
+    readonly userAgent?: string;
+    /** true when API hostname differs from the document hostname */
+    readonly crossSiteApiCall?: boolean;
+    /**
+     * Wall-clock ms from immediately before `fetch()` until it rejected (rounded integer).
+     * Does not include JSON parse time when a response was received.
+     */
+    readonly durationMs: number;
+    /** whether `navigator.onLine` was false at failure time */
+    readonly online: boolean;
+    /** true when failure was triggered by AbortController / user abort */
+    readonly aborted: boolean;
+    readonly errorName: string;
+    readonly errorMessage: string;
+    /** present when the environment threw an Error with a stack */
+    readonly errorStack?: string;
+    readonly connectionEffectiveType?: string;
+    readonly connectionDownlink?: number;
+    readonly connectionRtt?: number;
+    readonly connectionSaveData?: boolean;
+    readonly requestId?: string;
+}
 /** 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();
+    /** set when fetch() fails in the SDK HTTP client (omit for API `ERROR_NETWORK` responses) */
+    readonly details?: RadarNetworkFailureDetails;
+    /** original rejection from fetch; often a `TypeError` or `DOMException` */
+    readonly fetchError?: unknown;
+    /**
+     * Resolves when the optional Cloudflare DNS-over-HTTPS (A record) probe finishes.
+     * Only set for non-aborted fetch failures where a probe was scheduled (`null` if skipped in tests, no hostname, or a probe already ran for this host).
+     */
+    readonly dnsProbe?: Promise<DnsProbeResult>;
+    constructor(message?: string, details?: RadarNetworkFailureDetails, fetchError?: unknown, dnsProbe?: Promise<DnsProbeResult> | null);
 }
 /** thrown for unexpected/unclassified errors */
 export declare class RadarUnknownError extends RadarError {

package/dist/http.d.ts CHANGED Viewed

@@ -43,7 +43,7 @@ declare class Http {
      * 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 {RadarPublishableKeyError} if neither publishable key nor authToken is set
      * @throws {RadarBadRequestError} on 400 responses
      * @throws {RadarUnauthorizedError} on 401 responses
      * @throws {RadarNetworkError} on network failures

package/dist/index.d.ts CHANGED Viewed

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

package/dist/logger.d.ts CHANGED Viewed

@@ -6,7 +6,7 @@ declare class Logger {
     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;
+    /** log an error-level message; optional second argument for structured diagnostics (printed as a separate console.error arg) */
+    static error(message: string, data?: unknown): void;
 }
 export default Logger;