feat: recaptcha-enterprise-callback

add a recaptcha enterprise callback

Author: ryanbas21

packages/javascript-sdk/src/auth/enums.ts

@@ -36,7 +36,7 @@ enum CallbackType {
   PingOneProtectInitializeCallback = 'PingOneProtectInitializeCallback',
   PollingWaitCallback = 'PollingWaitCallback',
   ReCaptchaCallback = 'ReCaptchaCallback',
-  ReCaptchaEnterpriseCallback = 'ReCaptchaEnterpriseCallback ',
+  ReCaptchaEnterpriseCallback = 'ReCaptchaEnterpriseCallback',
   RedirectCallback = 'RedirectCallback',
   SelectIdPCallback = 'SelectIdPCallback',
   StringAttributeInputCallback = 'StringAttributeInputCallback',

packages/javascript-sdk/src/fr-auth/callbacks/recaptcha-enterprise-callback.test.ts

@@ -0,0 +1,74 @@
+import { describe, expect, it, beforeAll } from 'vitest';
+import ReCaptchaEnterpriseCallback from './recaptcha-enterprise-callback';
+import { CallbackType } from '../../auth/enums';
+import { Callback } from '../../auth/interfaces';
+
+const recaptchaCallback: Callback = {
+  type: 'ReCaptchaEnterpriseCallback' as CallbackType.ReCaptchaEnterpriseCallback,
+  output: [
+    {
+      name: 'recaptchaSiteKey',
+      value: '6LdSu_spAAAAAKz3UhIy4JYQld2lm_WRt7dEhf9T',
+    },
+    {
+      name: 'captchaApiUri',
+      value: 'https://www.google.com/recaptcha/enterprise.js',
+    },
+    {
+      name: 'captchaDivClass',
+      value: 'g-recaptcha',
+    },
+  ],
+  input: [
+    {
+      name: 'IDToken1token',
+      value: '',
+    },
+    {
+      name: 'IDToken1action',
+      value: '',
+    },
+    {
+      name: 'IDToken1clientError',
+      value: '',
+    },
+    {
+      name: 'IDToken1payload',
+      value: '',
+    },
+  ],
+};
+describe('enterprise recaptcha', () => {
+  let callback: ReCaptchaEnterpriseCallback;
+  beforeAll(() => {
+    callback = new ReCaptchaEnterpriseCallback(recaptchaCallback);
+  });
+  it('should get the site key', () => {
+    const siteKey = callback.getSiteKey();
+    expect(siteKey).toEqual('6LdSu_spAAAAAKz3UhIy4JYQld2lm_WRt7dEhf9T');
+  });
+  it('should get captchaApiUri', () => {
+    const url = callback.getApiUrl();
+    expect(url).toEqual('https://www.google.com/recaptcha/enterprise.js');
+  });
+  it('should set the action', () => {
+    callback.setAction('my_action');
+    expect(callback.getInputValue('IDToken1action')).toEqual('my_action');
+  });
+  it('should set the client error', () => {
+    callback.setClientError('error here');
+    expect(callback.getInputValue('IDToken1clientError')).toEqual('error here');
+  });
+  it('should set the payload', () => {
+    callback.setPayload({ test: 'here' });
+    expect(callback.getInputValue('IDToken1payload')).toEqual({ test: 'here' });
+  });
+  it('should set the token', () => {
+    callback.setResult('12345');
+    expect(callback.getInputValue('IDToken1token')).toEqual('12345');
+  });
+  it('should get the class', () => {
+    const className = callback.getElementClass();
+    expect(className).toBe('g-recaptcha');
+  });
+});

packages/javascript-sdk/src/fr-auth/callbacks/recaptcha-enterprise-callback.ts

@@ -10,6 +10,23 @@
 
 import FRCallback from '.';
 import type { Callback } from '../../auth/interfaces';
+//"input": [
+//                    {
+//                        "name": "IDToken1token",
+//                        "value": ""
+//                    },
+//                    {
+//                        "name": "IDToken1action",
+//                        "value": ""
+//                    },
+//                    {
+//                        "name": "IDToken1clientError",
+//                        "value": ""
+//                    },
+//                    {
+//                        "name": "IDToken1payload",
+//                        "value": ""
+//                    }
 
 /**
  * Represents a callback used to integrate reCAPTCHA.
@@ -29,12 +46,45 @@ class ReCaptchaEnterpriseCallback extends FRCallback {
     return this.getOutputByName<string>('recaptchaSiteKey', '');
   }
 
+  /**
+   * Get the api url
+   */
+  public getApiUrl(): string {
+    return this.getOutputByName<string>('captchaApiUri', '');
+  }
+  /**
+   * Get the class name
+   */
+  public getElementClass(): string {
+    return this.getOutputByName<string>('captchaDivClass', '');
+  }
   /**
    * Sets the reCAPTCHA result.
    */
   public setResult(result: string): void {
     this.setInputValue(result);
   }
+
+  /**
+   * Set client client error
+   */
+  public setClientError(error: string) {
+    this.setInputValue(error, 'IDToken1clientError');
+  }
+
+  /**
+   * Set the recaptcha payload
+   */
+  public setPayload(payload: unknown) {
+    this.setInputValue(payload, 'IDToken1payload');
+  }
+
+  /**
+   * Set the recaptcha action
+   */
+  public setAction(action: string) {
+    this.setInputValue(action, 'IDToken1action');
+  }
 }
 
 export default ReCaptchaEnterpriseCallback;

packages/javascript-sdk/src/index.ts

@@ -42,6 +42,7 @@ import { StepType } from './fr-auth/enums';
 import FRLoginFailure from './fr-auth/fr-login-failure';
 import PingOneProtectEvaluationCallback from './fr-auth/callbacks/ping-protect-evaluation-callback';
 import PingOneProtectInitializeCallback from './fr-auth/callbacks/ping-protect-initialize-callback';
+import ReCaptchaEnterpriseCallback from './fr-auth/callbacks/recaptcha-enterprise-callback';
 import FRLoginSuccess from './fr-auth/fr-login-success';
 import type { FRStepHandler } from './fr-auth/fr-step';
 import FRStep from './fr-auth/fr-step';
@@ -140,6 +141,7 @@ export {
   PolicyKey,
   PollingWaitCallback,
   ReCaptchaCallback,
+  ReCaptchaEnterpriseCallback,
   RedirectCallback,
   ResponseType,
   SelectIdPCallback,

packages/javascript-sdk/tsconfig.spec.json

@@ -2,6 +2,11 @@
   "extends": "./tsconfig.json",
   "compilerOptions": {
     "outDir": "../../dist/out-tsc",
+    "module": "ES2020",
+    "target": "ES2020",
+    "esModuleInterop": true,
+    "moduleResolution": "Node16",
+    "lib": ["DOM", "DOM.Iterable", "es2023"],
     "types": [
       "vitest/globals",
       "vitest/importMeta",