@forgerock/protect 0.0.0-beta-20250825180717

package/dist/src/lib/protect.mock.data.js

@@ -0,0 +1,156 @@
+/*
+ *
+ * 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.
+ *
+ */
+import { FRStep } from '@forgerock/javascript-sdk';
+export const standardPingProtectInitializeStep = new FRStep({
+    authId: 'foo',
+    callbacks: [
+        {
+            type: 'MetadataCallback',
+            output: [
+                {
+                    name: 'data',
+                    value: {
+                        _type: 'PingOneProtect',
+                        _action: 'protect_initialize',
+                        envId: 'some_id',
+                        consoleLogEnabled: true,
+                        deviceAttributesToIgnore: [],
+                        customHost: '',
+                        lazyMetadata: true,
+                        behavioralDataCollection: true,
+                        disableHub: true,
+                        deviceKeyRsyncIntervals: 10,
+                        enableTrust: true,
+                        disableTags: true,
+                    },
+                },
+            ],
+        },
+        {
+            type: 'HiddenValueCallback',
+            output: [
+                {
+                    name: 'value',
+                    value: '',
+                },
+                {
+                    name: 'id',
+                    value: 'clientError',
+                },
+            ],
+            input: [
+                {
+                    name: 'IDToken1',
+                    value: 'clientError',
+                },
+            ],
+        },
+    ],
+});
+export const standardPingProtectEvaluationStep = new FRStep({
+    authId: 'foo',
+    callbacks: [
+        {
+            type: 'MetadataCallback',
+            output: [
+                {
+                    name: 'data',
+                    value: {
+                        _type: 'PingOneProtect',
+                        _action: 'protect_risk_evaluation',
+                        envId: 'some_id',
+                        pauseBehavioralData: true,
+                    },
+                },
+            ],
+        },
+        {
+            type: 'HiddenValueCallback',
+            output: [
+                {
+                    name: 'value',
+                    value: '',
+                },
+                {
+                    name: 'id',
+                    value: 'pingone_risk_evaluation_signals',
+                },
+            ],
+            input: [
+                {
+                    name: 'IDToken1',
+                    value: 'pingone_risk_evaluation_signals',
+                },
+            ],
+        },
+        {
+            type: 'HiddenValueCallback',
+            output: [
+                {
+                    name: 'value',
+                    value: '',
+                },
+                {
+                    name: 'id',
+                    value: 'clientError',
+                },
+            ],
+            input: [
+                {
+                    name: 'IDToken1',
+                    value: 'clientError',
+                },
+            ],
+        },
+    ],
+});
+export const noProtectType = new FRStep({
+    authId: 'foo',
+    callbacks: [
+        {
+            type: 'HiddenValueCallback',
+            output: [
+                {
+                    name: 'value',
+                    value: '',
+                },
+                {
+                    name: 'id',
+                    value: 'pingone_risk_evaluation_signals',
+                },
+            ],
+            input: [
+                {
+                    name: 'IDToken1',
+                    value: 'pingone_risk_evaluation_signals',
+                },
+            ],
+        },
+        {
+            type: 'HiddenValueCallback',
+            output: [
+                {
+                    name: 'value',
+                    value: '',
+                },
+                {
+                    name: 'id',
+                    value: 'clientError',
+                },
+            ],
+            input: [
+                {
+                    name: 'IDToken1',
+                    value: 'clientError',
+                },
+            ],
+        },
+    ],
+});
+//# sourceMappingURL=protect.mock.data.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"protect.mock.data.js","sourceRoot":"","sources":["../../../src/lib/protect.mock.data.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAgB,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAEjE,MAAM,CAAC,MAAM,iCAAiC,GAAG,IAAI,MAAM,CAAC;IAC1D,MAAM,EAAE,KAAK;IACb,SAAS,EAAE;QACT;YACE,IAAI,EAAE,kBAAmD;YACzD,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE;wBACL,KAAK,EAAE,gBAAgB;wBACvB,OAAO,EAAE,oBAAoB;wBAC7B,KAAK,EAAE,SAAS;wBAChB,iBAAiB,EAAE,IAAI;wBACvB,wBAAwB,EAAE,EAAE;wBAC5B,UAAU,EAAE,EAAE;wBACd,YAAY,EAAE,IAAI;wBAClB,wBAAwB,EAAE,IAAI;wBAC9B,UAAU,EAAE,IAAI;wBAChB,uBAAuB,EAAE,EAAE;wBAC3B,WAAW,EAAE,IAAI;wBACjB,WAAW,EAAE,IAAI;qBAClB;iBACF;aACF;SACF;QACD;YACE,IAAI,EAAE,qBAAyD;YAC/D,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE;iBACV;gBACD;oBACE,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,aAAa;iBACrB;aACF;YACD,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,aAAa;iBACrB;aACF;SACF;KACF;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iCAAiC,GAAG,IAAI,MAAM,CAAC;IAC1D,MAAM,EAAE,KAAK;IACb,SAAS,EAAE;QACT;YACE,IAAI,EAAE,kBAAmD;YACzD,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE;wBACL,KAAK,EAAE,gBAAgB;wBACvB,OAAO,EAAE,yBAAyB;wBAClC,KAAK,EAAE,SAAS;wBAChB,mBAAmB,EAAE,IAAI;qBAC1B;iBACF;aACF;SACF;QACD;YACE,IAAI,EAAE,qBAAyD;YAC/D,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE;iBACV;gBACD;oBACE,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,iCAAiC;iBACzC;aACF;YACD,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,iCAAiC;iBACzC;aACF;SACF;QACD;YACE,IAAI,EAAE,qBAAyD;YAC/D,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE;iBACV;gBACD;oBACE,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,aAAa;iBACrB;aACF;YACD,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,aAAa;iBACrB;aACF;SACF;KACF;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC;IACtC,MAAM,EAAE,KAAK;IACb,SAAS,EAAE;QACT;YACE,IAAI,EAAE,qBAAyD;YAC/D,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE;iBACV;gBACD;oBACE,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,iCAAiC;iBACzC;aACF;YACD,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,iCAAiC;iBACzC;aACF;SACF;QACD;YACE,IAAI,EAAE,qBAAyD;YAC/D,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE;iBACV;gBACD;oBACE,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,aAAa;iBACrB;aACF;YACD,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,aAAa;iBACrB;aACF;SACF;KACF;CACF,CAAC,CAAC"}

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

@@ -0,0 +1,147 @@
+import FRStep from '@forgerock/javascript-sdk/src/fr-auth/fr-step';
+/**
+ * @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;
+}
+export interface ProtectInitializeConfig {
+    _type: 'PingOneProtect';
+    _action: 'protect_initialize';
+    envId?: string;
+    consoleLogEnabled?: boolean;
+    deviceAttributesToIgnore?: string[];
+    customHost?: string;
+    lazyMetadata?: boolean;
+    behavioralDataCollection?: boolean;
+    deviceKeyRsyncIntervals?: number;
+    enableTrust?: boolean;
+    disableTags?: boolean;
+    disableHub?: boolean;
+}
+export interface ProtectEvaluationConfig {
+    _type: 'PingOneProtect';
+    _action: 'protect_risk_evaluation';
+    envId: string;
+    pauseBehavioralData: boolean;
+}
+export type ProtectType = 'initialize' | 'evaluate' | 'none';
+/**
+ * @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;
+    };
+    /**
+     * @method getPauseBehavioralData
+     * @param {FRStep} step - A journey step
+     * @returns {boolean}
+     * @description - Required when using Ping Protect Marketplace nodes
+     */
+    getPauseBehavioralData: (step: FRStep) => boolean;
+    /**
+     * @method getNodeConfig - Method for getting the Protect intitialization config options
+     * @param {FRStep} step - A journey step
+     * @returns {ProtectInitializeConfig | undefined} - The Protect config options
+     */
+    getNodeConfig: (step: FRStep) => ProtectInitializeConfig | undefined;
+    /**
+     * @method getPingProtectType - Method for getting the type of step in the Protect flow
+     * @param {FRStep} step - A journey step
+     * @returns {ProtectType} - The type of step in the Protect flow
+     */
+    getProtectType: (step: FRStep) => ProtectType;
+    /**
+     * @method setNodeClientError - Method for setting an error on a Ping Protect Marketplace node
+     * @param {FRStep} step - A journey step
+     * @param {string} value - The error message to set
+     * @returns {void}
+     */
+    setNodeClientError: (step: FRStep, value: string) => void;
+    /**
+     * @method setNodeInputValue - Method for setting an input value on a Ping Protect Marketplace node
+     * @param {FRStep} step - A journey step
+     * @param {string} value - The value to set the input to
+     * @returns {void}
+     */
+    setNodeInputValue: (step: FRStep, value: string) => void;
+}
+//# 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,OAAO,MAAM,MAAM,+CAA+C,CAAC;AAEnE;;;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,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,gBAAgB,CAAC;IACxB,OAAO,EAAE,oBAAoB,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,gBAAgB,CAAC;IACxB,OAAO,EAAE,yBAAyB,CAAC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,MAAM,CAAC;AAE7D;;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;IAErD;;;;;OAKG;IACH,sBAAsB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IAElD;;;;OAIG;IACH,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,uBAAuB,GAAG,SAAS,CAAC;IAErE;;;;OAIG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,WAAW,CAAC;IAE9C;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAE1D;;;;;OAKG;IACH,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CAC1D"}

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":""}