@adobe-commerce/recaptcha 1.2.2 → 1.3.0-alpha-20260818101543

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @adobe-commerce/recaptcha
 
+## 1.3.0-alpha-20260818101543
+
+### Minor Changes
+
+- 383aafe: reCAPTCHA form types are now configurable via feature flag. COMPANY_CREATE is no
+  longer in the default form-type map. B2B storefronts pass `{ b2bEnabled: true }`
+  to `setConfig()` to include it in the configuration query.
+
 ## 1.2.2
 
 ### Patch Changes
@@ -19,6 +27,7 @@
   ## What changed
 
   ### TypeScript 4.7 → 6.0
+
   - `tsconfig-base.json` updated with correct TS 6 defaults. Two new-default opt-outs are deferred as tech debt: `exactOptionalPropertyTypes` and `verbatimModuleSyntax`.
   - `moduleResolution` changed from `"nodenext"` to `"bundler"` across all packages — the correct pairing for `module: "esnext"` in a Vite monorepo. Only `packages/elsie` keeps `"NodeNext"` (paired with `module: "NodeNext"` for its dual CJS/ESM output).
   - `baseUrl` removed from all tsconfigs (deprecated in TS 6; `paths` resolves relative to the tsconfig file directly).
@@ -28,6 +37,7 @@
   - `noUncheckedIndexedAccess` enabled — violations were few enough to fix in source.
 
   ### ESLint 8 → 9 (flat config)
+
   - `@typescript-eslint/parser` and `@typescript-eslint/eslint-plugin` (v5) removed; replaced by the unified `typescript-eslint` v8 package.
   - `eslint-config-preact` bumped to `^2.0.0` (ESLint 9 support).
   - `eslint-config-prettier` bumped to `^10.0.0`.
@@ -88,6 +98,7 @@
   ## What changed
 
   ### TypeScript 4.7 → 6.0
+
   - `tsconfig-base.json` updated with correct TS 6 defaults. Two new-default opt-outs are deferred as tech debt: `exactOptionalPropertyTypes` and `verbatimModuleSyntax`.
   - `moduleResolution` changed from `"nodenext"` to `"bundler"` across all packages — the correct pairing for `module: "esnext"` in a Vite monorepo. Only `packages/elsie` keeps `"NodeNext"` (paired with `module: "NodeNext"` for its dual CJS/ESM output).
   - `baseUrl` removed from all tsconfigs (deprecated in TS 6; `paths` resolves relative to the tsconfig file directly).
@@ -97,6 +108,7 @@
   - `noUncheckedIndexedAccess` enabled — violations were few enough to fix in source.
 
   ### ESLint 8 → 9 (flat config)
+
   - `@typescript-eslint/parser` and `@typescript-eslint/eslint-plugin` (v5) removed; replaced by the unified `typescript-eslint` v8 package.
   - `eslint-config-preact` bumped to `^2.0.0` (ESLint 9 support).
   - `eslint-config-prettier` bumped to `^10.0.0`.

package/README.md

@@ -36,21 +36,24 @@ const token = await verifyReCaptcha();
 
 Sets the GraphQL endpoint URL used to fetch reCAPTCHA configuration.
 
-### `setConfig(configList: PropsFormTypes[])`
+### `setConfig(configList: PropsFormTypes[], options?: { b2bEnabled?: boolean })`
 
 Fetches reCAPTCHA configuration from the backend via `recaptchaFormConfig` and stores it in session storage.
 
-- Queries all known form types and determines which are enabled
+- Queries all default form types and determines which are enabled
+- When `options.b2bEnabled` is `true`, includes `COMPANY_CREATE` in the query —
+  this form type is **not** included by default
 - Normalizes the response into a unified config shape
 - Detects the reCAPTCHA type (v3 or Enterprise) from the `re_captcha_type` field
 - Skips forms with empty `website_key`
 - Warns and disables reCAPTCHA if mixed types (both v3 and Enterprise) are detected across forms
 
 ```typescript
-await setConfig([
-  { badgeId: 'generateCustomerToken' },
-  { badgeId: 'contactUs' },
-]);
+// B2C storefront (default)
+await setConfig([{ badgeId: 'generateCustomerToken' }]);
+
+// B2B storefront
+await setConfig([], { b2bEnabled: true });
 ```
 
 ### `initReCaptcha(lazyLoadTimeout?: number)`
@@ -79,22 +82,33 @@ Enables or disables debug logging. When enabled, logs are prefixed with `[ReCapt
 - Token generation attempts
 - Warnings for skipped forms (missing keys) or mixed type configurations
 
-## Supported Form Types
-
-The module queries these form types from the backend:
-
-| Form Type | Badge ID |
-|---|---|
-| `PLACE_ORDER` | `placeOrder` |
-| `CONTACT` | `contactUs` |
-| `CUSTOMER_LOGIN` | `generateCustomerToken` |
-| `CUSTOMER_FORGOT_PASSWORD` | `requestPasswordResetEmail` |
-| `CUSTOMER_CREATE` | `createCustomerV2` |
-| `CUSTOMER_EDIT` | `updateCustomerV2` |
-| `NEWSLETTER` | `subscribeEmailToNewsletter` |
-| `PRODUCT_REVIEW` | `createProductReview` |
-| `SENDFRIEND` | `SENDFRIEND` |
-| `BRAINTREE` | `BRAINTREE` |
+## Default Form Types
+
+These form types are queried by default (no additional configuration needed):
+
+| Form Type                  | Badge ID                     |
+| -------------------------- | ---------------------------- |
+| `PLACE_ORDER`              | `placeOrder`                 |
+| `CONTACT`                  | `contactUs`                  |
+| `CUSTOMER_LOGIN`           | `generateCustomerToken`      |
+| `CUSTOMER_FORGOT_PASSWORD` | `requestPasswordResetEmail`  |
+| `CUSTOMER_CREATE`          | `createCustomerV2`           |
+| `CUSTOMER_EDIT`            | `updateCustomerV2`           |
+| `NEWSLETTER`               | `subscribeEmailToNewsletter` |
+| `PRODUCT_REVIEW`           | `createProductReview`        |
+| `SENDFRIEND`               | `SENDFRIEND`                 |
+| `BRAINTREE`                | `BRAINTREE`                  |
+
+## B2B Form Types
+
+B2B storefronts should pass `{ b2bEnabled: true }` to include `COMPANY_CREATE`
+in the reCAPTCHA query:
+
+```typescript
+await setConfig([], { b2bEnabled: true });
+```
+
+This requires the backend to expose `COMPANY_CREATE` in `ReCaptchaFormEnum`.
 
 ## Mixed Type Configuration
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe-commerce/recaptcha",
-  "version": "1.2.2",
+  "version": "1.3.0-alpha-20260818101543",
   "license": "SEE LICENSE IN LICENSE.md",
   "description": "Module allows to efficiently verify that users are humans, not bots or spammers",
   "type": "module",

package/src/configs/typeForms.config.ts

@@ -7,7 +7,12 @@
  * accompanying it. 
  *******************************************************************/
 
-export const typeDefaultForm: Record<string, string> = {
+/**
+ * All known reCAPTCHA form types and their associated GraphQL mutation names.
+ * Keys = form type identifiers (matching ReCaptchaFormEnum on the backend).
+ * Values = mutation names used for badge mapping.
+ */
+export const RECAPTCHA_FORMS = {
   PLACE_ORDER: 'placeOrder',
   CONTACT: 'contactUs',
   CUSTOMER_LOGIN: 'generateCustomerToken',
@@ -18,4 +23,23 @@ export const typeDefaultForm: Record<string, string> = {
   PRODUCT_REVIEW: 'createProductReview',
   SENDFRIEND: 'SENDFRIEND',
   BRAINTREE: 'BRAINTREE',
+  COMPANY_CREATE: 'createCompany',
+} as const;
+
+/**
+ * Default form-type → mutation mapping.
+ * Only base (non-B2B) forms live here. B2B forms are included conditionally
+ * via the `b2bEnabled` option in `setConfig()`.
+ */
+export const typeDefaultForm: Record<string, string> = {
+  PLACE_ORDER: RECAPTCHA_FORMS.PLACE_ORDER,
+  CONTACT: RECAPTCHA_FORMS.CONTACT,
+  CUSTOMER_LOGIN: RECAPTCHA_FORMS.CUSTOMER_LOGIN,
+  CUSTOMER_FORGOT_PASSWORD: RECAPTCHA_FORMS.CUSTOMER_FORGOT_PASSWORD,
+  CUSTOMER_CREATE: RECAPTCHA_FORMS.CUSTOMER_CREATE,
+  CUSTOMER_EDIT: RECAPTCHA_FORMS.CUSTOMER_EDIT,
+  NEWSLETTER: RECAPTCHA_FORMS.NEWSLETTER,
+  PRODUCT_REVIEW: RECAPTCHA_FORMS.PRODUCT_REVIEW,
+  SENDFRIEND: RECAPTCHA_FORMS.SENDFRIEND,
+  BRAINTREE: RECAPTCHA_FORMS.BRAINTREE,
 };

package/src/index.ts

@@ -17,6 +17,7 @@ import {
   recaptchaMessage,
   recaptchaBadgeSelector,
   typeDefaultForm,
+  RECAPTCHA_FORMS,
 } from './configs';
 import {
   extendConfig,
@@ -203,9 +204,16 @@ export class RecaptchaModule {
     }
   }
 
-  async _fetchStoreConfig(): Promise<ReCaptchaResponse | undefined> {
+  async _fetchStoreConfig(options?: {
+    b2bEnabled?: boolean;
+  }): Promise<ReCaptchaResponse | undefined> {
     try {
-      const formTypes = Object.keys(typeDefaultForm);
+      const formTypes = Object.keys({
+        ...typeDefaultForm,
+        ...(options?.b2bEnabled
+          ? { COMPANY_CREATE: RECAPTCHA_FORMS.COMPANY_CREATE }
+          : {}),
+      });
       const query = buildRecaptchaFormConfigQuery(formTypes);
 
       this._log(`Fetching config for forms: ${formTypes.join(', ')}`);
@@ -248,9 +256,12 @@ export class RecaptchaModule {
     recaptchaFetchApi.setEndpoint(url);
   }
 
-  async setConfig(configList: PropsFormTypes[]) {
+  async setConfig(
+    configList: PropsFormTypes[],
+    options?: { b2bEnabled?: boolean },
+  ) {
     try {
-      const config = await this._fetchStoreConfig();
+      const config = await this._fetchStoreConfig(options);
 
       if (!config?.data?.recaptchaConfig) {
         this._log('No reCAPTCHA config returned, clearing storage');
@@ -367,3 +378,4 @@ const { initReCaptcha, verifyReCaptcha, setEndpoint, setConfig, enableLogger } =
   recaptcha.getMethods();
 
 export { setEndpoint, setConfig, initReCaptcha, verifyReCaptcha, enableLogger };
+export { RECAPTCHA_FORMS };

package/src/lib/_extendConfig.ts

@@ -8,7 +8,7 @@
  *******************************************************************/
 
 import { ReCaptchaModel } from '../types/recaptcha.types';
-import { typeDefaultForm } from '../configs/typeForms.config';
+import { typeDefaultForm, RECAPTCHA_FORMS } from '../configs/typeForms.config';
 
 export const extendConfig = (
   config: ReCaptchaModel,
@@ -19,7 +19,9 @@ export const extendConfig = (
       if (typeof el !== 'string') return { ...el, enabledBadgePlace: false };
 
       return {
-        badgeId: typeDefaultForm[el],
+        badgeId:
+          typeDefaultForm[el] ??
+          RECAPTCHA_FORMS[el as keyof typeof RECAPTCHA_FORMS],
         enabledBadgePlace: false,
       };
     });