ping-protect-initialize-callback.ts

/*
 * @forgerock/javascript-sdk
 *
 * ping-protect-initialize-callback.ts
 *
 * Copyright (c) 2024 - 2026 Ping Identity Corporation. All rights reserved.
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

import FRCallback from '.';
import type { Callback } from '../../auth/interfaces';

/**
 * @class - Represents a callback used to initialize and start device and behavioral data collection.
 */
class PingOneProtectInitializeCallback extends FRCallback {
  /**
   * @param payload The raw payload returned by OpenAM
   */
  constructor(public payload: Callback) {
    super(payload);
  }

  /**
   * Get callback's initialization config settings
   */
  public getConfig() {
    const signalsInitializationOptions = this.getOutputByName<Record<string, unknown> | undefined>(
      'signalsInitializationOptions',
      undefined,
    );
    if (
      signalsInitializationOptions !== null &&
      typeof signalsInitializationOptions === 'object' &&
      !Array.isArray(signalsInitializationOptions)
    ) {
      return signalsInitializationOptions;
    }

    const agentIdentification = this.getOutputByName<boolean | undefined>(
      'agentIdentification',
      undefined,
    );
    const agentTimeout = this.getOutputByName<number | undefined>('agentTimeout', undefined);
    const agentPort = this.getOutputByName<number | undefined>('agentPort', undefined);

    const config = {
      // Required parameter
      envId: this.getOutputByName<string>('envId', ''),

      // Optional parameters
      ...(agentIdentification !== undefined ? { agentIdentification } : {}),
      ...(agentTimeout !== undefined ? { agentTimeout } : {}),
      ...(agentPort !== undefined ? { agentPort } : {}),
      behavioralDataCollection: this.getOutputByName<boolean>('behavioralDataCollection', true),
      disableTags: this.getOutputByName<boolean>('disableTags', false),
      universalDeviceIdentification: this.getOutputByName<boolean>(
        'universalDeviceIdentification',
        false,
      ),

      // Deprecated parameters
      consoleLogEnabled: this.getOutputByName<boolean>('consoleLogEnabled', false),
      deviceAttributesToIgnore: this.getOutputByName<string[]>('deviceAttributesToIgnore', []),
      customHost: this.getOutputByName<string>('customHost', ''),
      lazyMetadata: this.getOutputByName<boolean>('lazyMetadata', false),
      deviceKeyRsyncIntervals: this.getOutputByName<number>('deviceKeyRsyncIntervals', 14),
      enableTrust: this.getOutputByName<boolean>('enableTrust', false),
      disableHub: this.getOutputByName<boolean>('disableHub', false),
    };
    return config;
  }

  public setClientError(errorMessage: string): void {
    this.setInputValue(errorMessage, /clientError/);
  }
}

export default PingOneProtectInitializeCallback;