CaptchaHub Core

CaptchaHub Core is a TypeScript library that serves as the foundational package for the CaptchaHub ecosystem, providing essential classes, interfaces, and tools for handling and processing captchas within web applications. This package enables seamless integration with various captcha providers, including ReCaptcha, HCaptcha, and Turnstile, ensuring a consistent and streamlined approach to captcha implementation.

Installation

Install the package using pnpm:

pnpm add @captchahub/core

Features

• Unified Integration: CaptchaHub Core provides a unified interface for integrating multiple captcha providers.
• Extensible: Easily extend the core functionality to support additional captcha services.
• Nodeless (Serverless) Support: Designed to work seamlessly in nodeless (serverless) environments, making it ideal for modern web applications.

Usage

Getting the Captcha Script

The getCaptchaScript function can be used as follows:

import { getCaptchaScript } from '@captchahub/core';

const config = {
    CAPTCHA_PROVIDER: 'your-provider', // Specify the captcha provider
    // Additional provider-specific configuration can go here
};

const CaptchaComponent = () => {
    const CaptchaScript = getCaptchaScript(config);

    return (
        <div>
            <CaptchaScript />
            {/* Additional form elements */}
        </div>
    );
};

Getting the Captcha Form Element

The getCaptchaFormElement function can be used as follows:

import { getCaptchaFormElement } from '@captchahub/core';

const config = {
    CAPTCHA_PROVIDER: 'your-provider', // Specify the captcha provider
    // Additional provider-specific configuration can go here
};

const CaptchaFormComponent = () => {
    const CaptchaFormElement = getCaptchaFormElement(config);

    return (
        <div>
            <CaptchaFormElement />
            {/* Additional form elements */}
        </div>
    );
};

Verifying the Captcha

The verifyCaptcha function can be used as follows:

import { verifyCaptcha } from '@captchahub/core';

const config = {
    CAPTCHA_PROVIDER: 'your-provider', // Specify the captcha provider
    // Additional provider-specific configuration can go here
};

const formFieldValues = {
    // Your form field values that need to be verified
};

const isValid = await verifyCaptcha(formFieldValues, config);
if (isValid) {
    console.log('Captcha verified successfully!');
} else {
    console.error('Captcha verification failed.');
}

Configuration

Configuration for the captcha provider can be defined in a configuration object passed to the factory when creating the captcha instance. The configuration object must include the CAPTCHA_PROVIDER property to specify which captcha provider to use. Additional properties may be required depending on the specific provider.

Adding New Providers

To add a new captcha provider, you can implement the CaptchaInterface. Here’s a brief example of how to implement a new provider:

1. Create a New Folder: Create a new folder for your provider (e.g., packages/myprovider).

2. Implement the Interface: Create a class that implements the CaptchaInterface. This class should handle the logic for verifying captchas and rendering the captcha elements.

   Example:

   import type { CaptchaInterface } from '@captchahub/core';
   
   export class MyProviderCaptcha implements CaptchaInterface {
       async verifyCaptcha(formFieldValues: Record<string, any>): Promise<boolean> {
           // Implement the logic to verify the captcha
       }
   
       getCaptchaScript(): React.FC {
           // Return the captcha script as a React component
       }
   
       getCaptchaFormElement(): React.FC {
           // Return the captcha form element as a React component
       }
   }

3. Self-Registering the Package: To make your package self-registering, ensure your package registers the factory with the CaptchaFactoryRegistry and exports the factory class as the default export in index.tsx. For example:

import { CaptchaFactoryRegistry } from '@captchahub/core';
import { MyProviderCaptchaFactory } from './Factory';

CaptchaFactoryRegistry.registerCaptchaFactory('my-provider', new MyProviderCaptchaFactory());

// default export so that core factory can use it directly
export default MyProviderCaptchaFactory;

Rationale

The CaptchaHub Core package is designed to provide a consistent and extensible foundation for managing captcha workflows in TypeScript applications. By using well-defined interfaces and tools, developers can easily integrate captcha capabilities into their web applications.

Contributing

Contributions are welcome! Feel free to fork this project and submit pull requests. Before submitting, please ensure your code passes all linting and unit tests.

You can format code using:

pnpm format

You can run unit tests using:

pnpm test