@forgerock/protect 0.0.0-beta-20251124184351 → 0.0.0-beta-20251222204813

package/README.md

@@ -2,8 +2,6 @@
 
 The Ping Protect module provides an API for interacting with the PingOne Signals (Protect) SDK to perform risk evaluations. It can be used with either a PingOne AIC/PingAM authentication journey with Protect callbacks or with a PingOne DaVinci flow with Protect collectors.
 
-**IMPORTANT NOTE**: This module is not yet published. For the current published Ping Protect package please visit https://github.com/ForgeRock/forgerock-javascript-sdk/tree/develop/packages/ping-protect
-
 ## Full API
 
 ```js

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/protect.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AASA,cAAc,kBAAkB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,10 @@
+/*
+ *
+ * Copyright © 2025 Ping Identity Corporation. All right reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ *
+ */
+export * from './lib/protect.js';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,kBAAkB,CAAC"}

package/dist/src/lib/protect.d.ts

@@ -0,0 +1,19 @@
+import { Protect, ProtectConfig } from './protect.types.js';
+declare global {
+    interface Window {
+        _pingOneSignals: {
+            init: (initParams?: ProtectConfig) => Promise<void>;
+            getData: () => Promise<string>;
+            pauseBehavioralData: () => void;
+            resumeBehavioralData: () => void;
+        };
+    }
+}
+/**
+ * @async
+ * @function protect - returns a set of methods to interact with the PingOne Signals SDK
+ * @param {ProtectConfig} options - the configuration options for the PingOne Signals SDK
+ * @returns {Promise<Protect>} - a set of methods to interact with the PingOne Signals SDK
+ */
+export declare function protect(options: ProtectConfig): Protect;
+//# sourceMappingURL=protect.d.ts.map

package/dist/src/lib/protect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protect.d.ts","sourceRoot":"","sources":["../../../src/lib/protect.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAG5D,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,eAAe,EAAE;YACf,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;YAC/B,mBAAmB,EAAE,MAAM,IAAI,CAAC;YAChC,oBAAoB,EAAE,MAAM,IAAI,CAAC;SAClC,CAAC;KACH;CACF;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAkEvD"}

package/dist/src/lib/protect.js

@@ -0,0 +1,81 @@
+/*
+ *
+ * Copyright © 2025 Ping Identity Corporation. All right reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ *
+ */
+/**
+ * @async
+ * @function protect - returns a set of methods to interact with the PingOne Signals SDK
+ * @param {ProtectConfig} options - the configuration options for the PingOne Signals SDK
+ * @returns {Promise<Protect>} - a set of methods to interact with the PingOne Signals SDK
+ */
+export function protect(options) {
+    let protectApiInitialized = false;
+    return {
+        start: async () => {
+            try {
+                /*
+                 * Load the Ping Signals SDK
+                 * this automatically pollutes the window
+                 * there are no exports of this module
+                 */
+                await import('./signals-sdk.js');
+                protectApiInitialized = true;
+            }
+            catch (err) {
+                console.error('error loading ping signals', err);
+                return { error: 'Failed to load PingOne Signals SDK' };
+            }
+            try {
+                await window._pingOneSignals.init(options);
+                if (options.behavioralDataCollection === true) {
+                    window._pingOneSignals.resumeBehavioralData();
+                }
+            }
+            catch (err) {
+                console.error('error initializing ping protect', err);
+                return { error: 'Failed to initialize PingOne Signals SDK' };
+            }
+        },
+        getData: async () => {
+            if (!protectApiInitialized) {
+                return { error: 'PingOne Signals SDK is not initialized' };
+            }
+            try {
+                return await window._pingOneSignals.getData();
+            }
+            catch (err) {
+                console.error('error getting data from ping protect', err);
+                return { error: 'Failed to get data from Protect' };
+            }
+        },
+        pauseBehavioralData: () => {
+            if (!protectApiInitialized) {
+                return { error: 'PingOne Signals SDK is not initialized' };
+            }
+            try {
+                window._pingOneSignals.pauseBehavioralData();
+            }
+            catch (err) {
+                console.error('error pausing behavioral data in ping protect', err);
+                return { error: 'Failed to pause behavioral data in Protect' };
+            }
+        },
+        resumeBehavioralData: () => {
+            if (!protectApiInitialized) {
+                return { error: 'PingOne Signals SDK is not initialized' };
+            }
+            try {
+                window._pingOneSignals.resumeBehavioralData();
+            }
+            catch (err) {
+                console.error('error resuming behavioral data in ping protect', err);
+                return { error: 'Failed to resume behavioral data in Protect' };
+            }
+        },
+    };
+}
+//# sourceMappingURL=protect.js.map

package/dist/src/lib/protect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protect.js","sourceRoot":"","sources":["../../../src/lib/protect.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAgBH;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,OAAsB;IAC5C,IAAI,qBAAqB,GAAG,KAAK,CAAC;IAElC,OAAO;QACL,KAAK,EAAE,KAAK,IAAuC,EAAE;YACnD,IAAI,CAAC;gBACH;;;;mBAIG;gBACH,MAAM,MAAM,CAAC,kBAA4B,CAAC,CAAC;gBAC3C,qBAAqB,GAAG,IAAI,CAAC;YAC/B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC;gBACjD,OAAO,EAAE,KAAK,EAAE,oCAAoC,EAAE,CAAC;YACzD,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAE3C,IAAI,OAAO,CAAC,wBAAwB,KAAK,IAAI,EAAE,CAAC;oBAC9C,MAAM,CAAC,eAAe,CAAC,oBAAoB,EAAE,CAAC;gBAChD,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAC;gBACtD,OAAO,EAAE,KAAK,EAAE,0CAA0C,EAAE,CAAC;YAC/D,CAAC;QACH,CAAC;QACD,OAAO,EAAE,KAAK,IAAyC,EAAE;YACvD,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC3B,OAAO,EAAE,KAAK,EAAE,wCAAwC,EAAE,CAAC;YAC7D,CAAC;YAED,IAAI,CAAC;gBACH,OAAO,MAAM,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;YAChD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAC;gBAC3D,OAAO,EAAE,KAAK,EAAE,iCAAiC,EAAE,CAAC;YACtD,CAAC;QACH,CAAC;QACD,mBAAmB,EAAE,GAA6B,EAAE;YAClD,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC3B,OAAO,EAAE,KAAK,EAAE,wCAAwC,EAAE,CAAC;YAC7D,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;YAC/C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,+CAA+C,EAAE,GAAG,CAAC,CAAC;gBACpE,OAAO,EAAE,KAAK,EAAE,4CAA4C,EAAE,CAAC;YACjE,CAAC;QACH,CAAC;QACD,oBAAoB,EAAE,GAA6B,EAAE;YACnD,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC3B,OAAO,EAAE,KAAK,EAAE,wCAAwC,EAAE,CAAC;YAC7D,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,CAAC,eAAe,CAAC,oBAAoB,EAAE,CAAC;YAChD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,gDAAgD,EAAE,GAAG,CAAC,CAAC;gBACrE,OAAO,EAAE,KAAK,EAAE,6CAA6C,EAAE,CAAC;YAClE,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/src/lib/protect.types.d.ts

@@ -0,0 +1,92 @@
+/**
+ * @interface ProtectConfig - Interface for the Protect module configuration parameters
+ * @description - envId is required. All other parameters are optional.
+ */
+export interface ProtectConfig {
+    /**
+     * @property {string} envId - the environment id from your PingOne tenant
+     */
+    envId: string;
+    /**
+     * @property {boolean} [waitForWindowLoad] - true to init the SDK on load event, instead of DOMContentLoaded event. default is true
+     */
+    waitForWindowLoad?: boolean;
+    /**
+     * @property {string} [hubUrl] - iframe url for cross-storage device ID
+     */
+    hubUrl?: string;
+    /**
+     * @property {boolean} [disableHub] - when true, the SDK store the deviceId to the localStorage only and won't use an iframe (hub). default is false
+     */
+    disableHub?: boolean;
+    /**
+     * @property {string[]} [deviceAttributesToIgnore] - metadata blacklist
+     */
+    deviceAttributesToIgnore?: string[];
+    /**
+     * @property {boolean} [behavioralDataCollection] - true to collect behavioral data. default is true
+     */
+    behavioralDataCollection?: boolean;
+    /**
+     * @property {boolean} [disableTags] - true to skip tag collection. default is false
+     */
+    disableTags?: boolean;
+    /**
+     * @property {Record<string, string>} [externalIdentifiers] - optional customer external identifiers that should be reflected on a device entity
+     */
+    externalIdentifiers?: Record<string, string>;
+    /**
+     * @property {boolean} [universalDeviceIdentification] - set to true if you want the device data in the SDK payload to be provided as a signed JWT
+     */
+    universalDeviceIdentification?: boolean;
+    /**
+     * @property {boolean} [agentIdentification] - set to true if you are using risk policies that contain the PingID Device Trust predictor. default is false
+     */
+    agentIdentification?: boolean;
+    /**
+     * @property {number} [agentTimeout] - If agentIdentification is true, use agentTimeout to specify the timeout the trust agent should use if you don't want to use the default timeout setting. Can be between 200 and 10,000 milliseconds. Default is 5000.
+     */
+    agentTimeout?: number;
+    /**
+     * @property {number} [agentPort] - If agentIdentification is true, use agentPort to specify the port to use when connecting to the trust agent if you don't want to use the default port. Default is 9400.
+     */
+    agentPort?: number;
+}
+/**
+ * @interface Protect - Interface for methods to interact with the PingOne Signals SDK
+ */
+export interface Protect {
+    /**
+     * @async
+     * @method start - Method to initialize and start the PingOne Signals SDK
+     * @returns {Promise<void | { error: string }>} - Returns an error if PingOne Signals SDK failed to load
+     */
+    start: () => Promise<void | {
+        error: string;
+    }>;
+    /**
+     * @async
+     * @method getData - Method to get the device data
+     * @returns {Promise<string | { error: string }>} - Returns the device data or an error if PingOne Signals SDK failed to load
+     */
+    getData: () => Promise<string | {
+        error: string;
+    }>;
+    /**
+     * @method pauseBehavioralData - Method to pause the behavioral data collection
+     * @returns {void | { error: string }} - Returns an error if PingOne Signals SDK failed to load
+     * @description Pause the behavioral data collection only; device profile data will still be collected
+     */
+    pauseBehavioralData: () => void | {
+        error: string;
+    };
+    /**
+     * @method resumeBehavioralData - Method to resume the behavioral data collection
+     * @returns {void | { error: string }} - Returns an error if PingOne Signals SDK failed to load
+     * @description Resume the behavioral data collection
+     */
+    resumeBehavioralData: () => void | {
+        error: string;
+    };
+}
+//# sourceMappingURL=protect.types.d.ts.map

package/dist/src/lib/protect.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protect.types.d.ts","sourceRoot":"","sources":["../../../src/lib/protect.types.ts"],"names":[],"mappings":"AASA;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE7C;;OAEG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAExC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;;;OAIG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAE/C;;;;OAIG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAEnD;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,IAAI,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAEpD;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,IAAI,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CACtD"}

package/dist/src/lib/protect.types.js

@@ -0,0 +1,10 @@
+/*
+ *
+ * Copyright © 2025 Ping Identity Corporation. All right reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ *
+ */
+export {};
+//# sourceMappingURL=protect.types.js.map

package/dist/src/lib/protect.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protect.types.js","sourceRoot":"","sources":["../../../src/lib/protect.types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}

package/dist/src/lib/signals-sdk.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=signals-sdk.d.ts.map

package/dist/src/lib/signals-sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signals-sdk.d.ts","sourceRoot":"","sources":["../../../src/lib/signals-sdk.js"],"names":[],"mappings":""}