Skip to content

fix(ping-protect): fixes type for PIProtect.start() options object #573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tnt-glenn-mccomb wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix(ping-protect): fixes type for PIProtect.start() options object #573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/brave-moose-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@forgerock/ping-protect': patch
---

fixes the type of the options param in `PIProtect.start` so it better aligns with output from `PingOneProtectInitializeCallback.getConfig()` as defined in `javascript-sdk` (importantly it no longer expects `_type` and `_action` fields)
4 changes: 2 additions & 2 deletions packages/ping-protect/src/lib/ping-protect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export type InitParams = Omit<ProtectInitializeConfig, '_type' | '_action'>;
declare global {
interface Window {
_pingOneSignals: {
init: (initParams?: ProtectInitializeConfig) => Promise<void>;
init: (initParams?: InitParams) => Promise<void>;
getData: () => Promise<string>;
pauseBehavioralData: () => void;
resumeBehavioralData: () => void;
Expand Down Expand Up @@ -56,7 +56,7 @@ export abstract class PIProtect {
* @param {InitParams} options - The init parameters
* @returns {Promise<void>} - Returns a promise
*/
public static async start(options: ProtectInitializeConfig): Promise<void> {
public static async start(options: InitParams): Promise<void> {
try {
/*
* Load the Ping Signals SDK
Expand Down