> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> El paquete **Actions NPM (`@auth0/actions`)** permite usar TypeScript en el desarrollo de proyectos externos, lo que permite a los desarrolladores seguir las prácticas recomendadas y mejorar sus **pruebas unitarias** a partir de las definiciones de TypeScript.

# Prueba unitaria de Actions

<div id="auth0-actions-unit-test">
  # Pruebas unitarias de Auth0 Actions
</div>

El paquete **Actions NPM (`@auth0/actions`)** permite usar TypeScript en proyectos externos, lo que ayuda a los desarrolladores a seguir las prácticas recomendadas y a mejorar sus pruebas unitarias a partir de las definiciones de TypeScript.

***

<div id="how-it-works">
  ## Cómo funciona
</div>

Sigue las pautas de instalación e importación descritas en: [Cómo funciona Actions NPM](/es/docs/customize/actions/actions-npm#how-it-works).

Para realizar pruebas unitarias de una Action, debes crear mocks de los objetos `event` y `api` que recibe la función de tu Action. Puedes crear estos mocks con las definiciones de TypeScript incluidas en `auth0/actions`, lo que garantiza que tus pruebas reflejen con precisión el entorno de producción. Los frameworks de pruebas como Jest son ideales para gestionar los mocks y probar la funcionalidad.

Las pruebas unitarias pueden ejecutarse en un entorno local, en el control de versiones o en un proceso de CI/CD, lo que mejora la garantía general de calidad y las validaciones antes de que los cambios afecten a los Tenants de Auth0.

***

<div id="examples">
  ## Ejemplos
</div>

Los siguientes ejemplos muestran cómo validar una serie de escenarios mediante la simulación de los objetos necesarios.

<Note>
  Los ejemplos usan **Jest** (`https://www.npmjs.com/package/jest`), pero se puede usar cualquier biblioteca de pruebas.
</Note>

<div id="configuration">
  ### Configuración
</div>

En tu `package.json`, define las dependencias de desarrollo para contar con la ayuda de IntelliSense al escribir tu Action.

<Tabs>
  <Tab title="JavaScript">
    ```javascript theme={null}
    {
      "name": "actions-js",
      "version": "1.0.0",
      "description": "Actions JS",
      "main": "example.js",
      "scripts": {
        "test": "jest"
      },
      "author": "John Doe",
      "license": "ISC",
      "devDependencies": {
        "@auth0/actions": "^0.7.1",
        "jest": "^29.7.0"
      }
    }
    ```
  </Tab>

  <Tab title="TypeScript">
    ```typescript theme={null}
    {
      "name": "actions-ts",
      "version": "1.0.0",
      "description": "Actions TS",
      "main": "example.ts",
      "scripts": {
        "test": "jest"
      },
      "author": "John Doe",
      "license": "ISC",
      "devDependencies": {
        "@auth0/actions": "^0.7.1",
        "@types/jest": "^29.5.12",
        "@types/node": "22.14.0",
        "jest": "^29.7.0",
        "ts-jest": "^29.1.2",
        "typescript": "^5.9.2"
      }
    }
    ```

    En tu archivo `tsconfig.json`, define cómo debe funcionar el compilador de TypeScript:

    ```typescript theme={null}
    {
      "compilerOptions": {
        "target": "ES2020",
        "module": "NodeNext",
        "moduleResolution": "nodenext",
        "esModuleInterop": true,
        "allowSyntheticDefaultImports": true,
        "strict": true,
        "outDir": "dist",
        "declaration": true,
        "sourceMap": true,
        "allowJs": true,
        "checkJs": false,
        "resolveJsonModule": true,
        "skipLibCheck": true,
        "forceConsistentCasingInFileNames": true,
        "isolatedModules": true
      },
      "include": [
        "**/*.ts"
      ],
      "exclude": [
        "node_modules",
        "dist"
      ]
    }
    ```

    En tu `jest.config.js`, define la configuración del entorno de `Jest`:

    ```typescript theme={null}
    module.exports = {
      preset: 'ts-jest',
      testEnvironment: 'node',
    };
    ```
  </Tab>
</Tabs>

<div id="pre-user-registration-access-control-and-user-metadata-setup">
  ## Control de acceso antes del registro de usuarios y configuración de metadatos del usuario
</div>

El siguiente ejemplo de Action comprueba si el correo electrónico del usuario pertenece a un dominio de correo electrónico prohibido y llama a `api.access.deny()` si coincide. En caso contrario, verifica si se proporcionó el nombre completo mediante campos adicionales de Custom Prompts y, de ser así, lo establece en `user_metadata` del perfil del usuario; de lo contrario, envía un error de validación a Universal Login.

<Tabs>
  <Tab title="JavaScript">
    ```javascript theme={null}
    /** @import {Event, PreUserRegistrationAPI} from "@auth0/actions/pre-user-registration/v2" */

    /**
    * Controlador que se llamará durante la ejecución de un flujo de PreUserRegistration.
    *
    * @param {Event} event - Detalles sobre el contexto y el usuario que está intentando registrarse.
    * @param {PreUserRegistrationAPI} api - Interfaz cuyos métodos pueden utilizarse para cambiar el comportamiento del registro.
    */
    exports.onExecutePreUserRegistration = async (event, api) => {
      const user = event.user;

      if (user.email?.endsWith('@example.com')) {
        api.access.deny('forbidden', 'Forbidden email domain')
        return;
      }

      const fullName = event.request.body['ulp-fullName'];

      if (fullName === undefined) {
        api.validation.error('invalid_payload', 'Missing full name');
        return;
      }

      api.user.setUserMetadata('full_name', fullName);
    }
    ```
  </Tab>

  <Tab title="TypeScript">
    ```typescript theme={null}
    import type { Event, PreUserRegistrationAPI } from '@auth0/actions/pre-user-registration/v2';

    /**
    * Controlador que se llamará durante la ejecución de un flujo de PreUserRegistration.
    *
    * @param {Event} event - Detalles sobre el contexto y el usuario que está intentando registrarse.
    * @param {PreUserRegistrationAPI} api - Interfaz cuyos métodos pueden utilizarse para cambiar el comportamiento del registro.
    */
    exports.onExecutePreUserRegistration = async (event: Event, api: PreUserRegistrationAPI) => {
      const user = event.user;

      if (user.email?.endsWith('@example.com')) {
        api.access.deny('forbidden', 'Forbidden email domain')
        return;
      }

      const fullName = event.request.body['ulp-fullName'];

      if (fullName === undefined) {
        api.validation.error('invalid_payload', 'Missing full name');
        return;
      }

      api.user.setUserMetadata('full_name', fullName);
    };
    ```
  </Tab>
</Tabs>

La prueba unitaria realiza algunas validaciones para maximizar la cobertura del código, simulando los objetos `event` y `api`.

<Tabs>
  <Tab title="Javascript">
    ```javascript theme={null}
    const { onExecutePreUserRegistration } = require('./preUserRegistration');

    describe('onExecutePreUserRegistration', () => {
      const mockApi = {
        access: {
          deny: jest.fn(),
        },
        user: {
          setUserMetadata: jest.fn(),
        },
        validation: {
          error: jest.fn(),
        },
      };

      beforeEach(() => {
        jest.resetAllMocks();
      });

      afterEach(() => {
        jest.resetAllMocks();
      });

      it('rechaza el dominio del correo electrónico', async () => {
        const mockEvent = {
          user: {
            email: 'johndoe@example.com',
          }
        };

        await onExecutePreUserRegistration(mockEvent, mockApi);

        expect(mockApi.access.deny).toHaveBeenCalledWith('forbidden', 'Dominio de correo electrónico prohibido');
        expect(mockApi.validation.error).not.toHaveBeenCalled();
        expect(mockApi.user.setUserMetadata).not.toHaveBeenCalled();
      });

      it('permite el dominio del correo electrónico sin nombre completo', async () => {
        const mockEvent = {
          request: {
            body: {},
          },
          user: {
            email: 'johndoe@test.com',
          },
        };

        await onExecutePreUserRegistration(mockEvent, mockApi);

        expect(mockApi.access.deny).not.toHaveBeenCalled();
        expect(mockApi.validation.error).toHaveBeenCalledWith('invalid_payload', 'Falta el nombre completo');
        expect(mockApi.user.setUserMetadata).not.toHaveBeenCalled();
      });

      it('permite el dominio del correo electrónico con nombre completo', async () => {
        const mockEvent = {
          request: {
            body: {
              'ulp-fullName': 'John Doe'
            },
          },
          user: {
            email: 'johndoe@test.com',
          },
        };

        await onExecutePreUserRegistration(mockEvent, mockApi);

        expect(mockApi.access.deny).not.toHaveBeenCalled();
        expect(mockApi.validation.error).not.toHaveBeenCalled();
        expect(mockApi.user.setUserMetadata).toHaveBeenCalledWith('full_name', 'John Doe');
      });
    });
    ```
  </Tab>

  <Tab title="TypeScript">
    ```typescript theme={null}
    const { onExecutePreUserRegistration } = require('./preUserRegistration');

    describe('onExecutePreUserRegistration', () => {
      const mockApi = {
        access: {
          deny: jest.fn(),
        },
        user: {
          setUserMetadata: jest.fn(),
        },
        validation: {
          error: jest.fn(),
        },
      };

      beforeEach(() => {
        jest.resetAllMocks();
      });

      afterEach(() => {
        jest.resetAllMocks();
      });

      it('rechaza el dominio del correo electrónico', async () => {
        const mockEvent = {
          user: {
            email: 'johndoe@example.com',
          }
        };

        await onExecutePreUserRegistration(mockEvent, mockApi);

        expect(mockApi.access.deny).toHaveBeenCalledWith('forbidden', 'Dominio de correo electrónico prohibido');
        expect(mockApi.validation.error).not.toHaveBeenCalled();
        expect(mockApi.user.setUserMetadata).not.toHaveBeenCalled();
      });

      it('permite el dominio del correo electrónico sin nombre completo', async () => {
        const mockEvent = {
          request: {
            body: {},
          },
          user: {
            email: 'johndoe@test.com',
          },
        };

        await onExecutePreUserRegistration(mockEvent, mockApi);

        expect(mockApi.access.deny).not.toHaveBeenCalled();
        expect(mockApi.validation.error).toHaveBeenCalledWith('invalid_payload', 'Falta el nombre completo');
        expect(mockApi.user.setUserMetadata).not.toHaveBeenCalled();
      });

      it('permite el dominio del correo electrónico con nombre completo', async () => {
        const mockEvent = {
          request: {
            body: {
              'ulp-fullName': 'John Doe'
            },
          },
          user: {
            email: 'johndoe@test.com',
          },
        };

        await onExecutePreUserRegistration(mockEvent, mockApi);

        expect(mockApi.access.deny).not.toHaveBeenCalled();
        expect(mockApi.validation.error).not.toHaveBeenCalled();
        expect(mockApi.user.setUserMetadata).toHaveBeenCalledWith('full_name', 'John Doe');
      });
    });
    ```
  </Tab>
</Tabs>

<div id="custom-email-provider-and-http-request">
  ## Proveedor personalizado de correo electrónico y solicitud HTTP
</div>

El siguiente ejemplo de Action intenta enviar un mensaje mediante una solicitud HTTP a un servicio externo, gestionando un posible error en la solicitud para descartar la notificación. Usa secretos para la URL del servicio externo y la clave de API de autorización.

<Tabs>
  <Tab title="Javascript">
    ```javascript theme={null}
    /** @import {Event, CustomEmailProviderAPI} from "@auth0/actions/custom-email-provider/v1" */

    /**
    * Manejador que se ejecuta al enviar una notificación por correo electrónico
    *
    * @param {Event} event - Detalles sobre el usuario y el contexto en el que inicia sesión.
    * @param {CustomEmailProviderAPI} api - Métodos y utilidades para modificar el comportamiento del envío de una notificación por correo electrónico.
    */
    exports.onExecuteCustomEmailProvider = async (event, api) => {
      const notification = event.notification;
      const message = {
        body: notification.html
      };

      try {
        await fetch(event.secrets.URL, {
          method: 'POST',
          headers: {
            'X-API-Key': event.secrets.API_KEY,
          },
          body: JSON.stringify(message),
        });
      } catch (err) {
        api.notification.drop('External service failure');
      }
    }

    ```
  </Tab>

  <Tab title="TypeScript">
    ```typescript theme={null}
    /** @import {Event, CustomEmailProviderAPI} from "@auth0/actions/custom-email-provider/v1" */

    /**
    * Manejador que se ejecuta al enviar una notificación por correo electrónico
    *
    * @param {Event} event - Detalles sobre el usuario y el contexto en el que inicia sesión.
    * @param {CustomEmailProviderAPI} api - Métodos y utilidades para modificar el comportamiento del envío de una notificación por correo electrónico.
    */
    exports.onExecuteCustomEmailProvider = async (event, api) => {
      const notification = event.notification;
      const message = {
        body: notification.html
      };

      try {
        await fetch(event.secrets.URL, {
          method: 'POST',
          headers: {
            'X-API-Key': event.secrets.API_KEY,
          },
          body: JSON.stringify(message),
        });
      } catch (err) {
        api.notification.drop('External service failure');
      }
    }

    ```
  </Tab>
</Tabs>

La prueba unitaria realiza algunas validaciones para maximizar la cobertura del código, simulando los objetos event y api, además de la función fetch.

<Tabs>
  <Tab title="Javascript">
    ```javascript theme={null}
    const { onExecuteCustomEmailProvider } = require('./customEmailProvider');

    describe('onExecuteCustomEmailProvider', () => {
      const mockApi = {
        notification: {
          drop: jest.fn(),
        },
      };

      const mockEvent = {
        notification: {
          html: '<h1>Hello world</h1>',
        },
        secrets: {
          URL: 'https://example.com/service',
          API_KEY: 'ApiKeySecret1234.',
        },
        user: {
          email: 'johndoe@example.com',
        },
      };

      beforeEach(() => {
        jest.resetAllMocks();
      });

      afterEach(() => {
        jest.resetAllMocks();
      });

      it('succeeds on external service request', async () => {
        jest.spyOn(global, 'fetch').mockImplementationOnce(() => Promise.resolve({
          ok: true,
          status: 200,
          json: async () => ({ message: 'Success!' }),
        }));

        await onExecuteCustomEmailProvider(mockEvent, mockApi);

        expect(global.fetch).toHaveBeenCalled();
        expect(mockApi.notification.drop).not.toHaveBeenCalled();
      });

      it('fails on external service request', async () => {
        jest.spyOn(global, 'fetch').mockImplementationOnce(() => Promise.reject({
          ok: false,
          status: 500,
          json: async () => ({ error: 'Server Error' }),
        }));

        await onExecuteCustomEmailProvider(mockEvent, mockApi);

        expect(mockApi.notification.drop).toHaveBeenCalledWith('External service failure');
      });
    });

    ```
  </Tab>

  <Tab title="TypeScript">
    ```typescript theme={null}
    const { onExecuteCustomEmailProvider } = require('./customEmailProvider');

    describe('onExecuteCustomEmailProvider', () => {
      const mockApi = {
        notification: {
          drop: jest.fn(),
        },
      };

      const mockEvent = {
        notification: {
          html: '<h1>Hello world</h1>',
        },
        secrets: {
          URL: 'https://example.com/service',
          API_KEY: 'ApiKeySecret1234.',
        },
        user: {
          email: 'johndoe@example.com',
        },
      };

      beforeEach(() => {
        jest.resetAllMocks();
      });

      afterEach(() => {
        jest.resetAllMocks();
      });

      it('succeeds on external service request', async () => {
        jest.spyOn(global, 'fetch').mockImplementationOnce(() => Promise.resolve({
          ok: true,
          status: 200,
          json: async () => ({ message: 'Success!' }),
        } as Response));

        await onExecuteCustomEmailProvider(mockEvent, mockApi);

        expect(global.fetch).toHaveBeenCalled();
        expect(mockApi.notification.drop).not.toHaveBeenCalled();
      });

      it('fails on external service request', async () => {
        jest.spyOn(global, 'fetch').mockImplementationOnce(() => Promise.reject({
          ok: false,
          status: 500,
          json: async () => ({ error: 'Server Error' }),
        } as Response));

        await onExecuteCustomEmailProvider(mockEvent, mockApi);

        expect(mockApi.notification.drop).toHaveBeenCalledWith('External service failure');
      });
    });

    ```
  </Tab>
</Tabs>

Para obtener más información sobre `@auth0/actions`, visita [https://www.npmjs.com/package/@auth0/actions](https://www.npmjs.com/package/@auth0/actions).

Para obtener más información sobre cómo escribir Actions, consulta [Write Your First Action](/es/docs/customize/actions/write-your-first-action).