Cloudflare Turnstile integration for Enonic XP

This library simplifies integration with Cloudflare Turnstile from Enonic XP projects.

Installation

To install this library you need to add a new dependency to your app's build.gradle file.

Gradle

repositories {
  maven { url "https://repo.itemtest.no/releases" }
}

dependencies {
  include "no.item:lib-xp-cloudflare-turnstile:0.0.4"
}

TypeScript

To update the version of enonic-types in package.json using npm, run the following command:

npm i -D @item-enonic-types/lib-cloudflare-turnstile

You can add the following changes to your tsconfig.json to get TypeScript-support.

{
  "compilerOptions": {
+   "baseUrl": "./",
+   "paths": {
+     "/lib/xp/*": ["./node_modules/@enonic-types/lib-*"],
+     "/lib/*": [ "./node_modules/@item-enonic-types/lib-*" ,"./src/main/resources/lib/*"],
+   }
  }
}

Configuration

You can configure the API-keys in one of two ways:

1. As a mixin on site.xml

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <site xmlns="urn:enonic:xp:model:1.0">
     <form>
       <mixin name="cloudflare-turnstile" />
     </form>
   </site>

2. As a configuration on your applications *.cfg file

   # These testing keys will always succeed
   turnstileSiteKey=1x00000000000000000000AA
   turnstileSecretKey=1x0000000000000000000000000000000AA

Usage

import { getSiteKey, verify, TURNSTILE_CLIENT_JS, FIELD_TURNSTILE_RESPONSE } from "/lib/cloudflare-turnstile";
import type { Response } from "@enonic-types/core";

export function get(): Response {
  const turnstileSiteKey = getSiteKey();

  return {
    body: `
      <form method="post">
        <div class="cf-turnstile" data-sitekey="${turnstileSiteKey}"></div>
        <button type="submit">Submit</button>
      </form>
    `,
    pageContributions: {
      headEnd: [`<script src="${TURNSTILE_CLIENT_JS}" async defer></script>`],
    },
  };
}

type FormParams = {
  [FIELD_TURNSTILE_RESPONSE]: string | string[];
};

export function post(req: Request<{ params: FormParams }>): Response {
  const result = verify(req);

  return {
    body: verify.success ? "You have been verified!" : "You are a bot!"
  };
}

Deploying

Building

To build the project, run the following command

enonic project build

Deploying locally

To deploy to a local sandbox, run the following command

enonic project deploy

Deploy to Maven

./gradlew publish -P com.enonic.xp.app.production=true

Deploy to npm

npm publish