nuxt-cap 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gabriel 'DethDKN' Rosa <https://github.com/dethdkn>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,218 @@
+<h1 align="center">nuxt-cap</h1>
+<p align="center">🧢 Integrate Cap into your Nuxt websites/applications.</p>
+
+<p align="center">
+   <a href="https://rosa.dev.br">
+      <img src="https://img.shields.io/badge/check me!-👻-F28AA9" alt="rosa.dev.br"/>
+   </a>
+   <a href="https://github.com/dethdkn/nuxt-cap/blob/main/LICENSE">
+      <img src="https://img.shields.io/github/license/dethdkn/nuxt-cap?color=%233da639&logo=open%20source%20initiative" alt="License"/>
+  </a>
+   <a href="https://gitmoji.dev">
+      <img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67" alt="Gitmoji"/>
+   </a>
+</p>
+
+## 🚀 Setup
+
+Install `nuxt-cap` dependency to your project:
+
+```sh
+npx nuxt module add nuxt-cap
+```
+
+## ⚙️ Configuration
+
+You can configure **nuxt-cap** in two ways:
+
+### 1️⃣ Using `nuxt.config.ts`
+
+Set the `apiEndpoint` directly in your Nuxt configuration:
+
+```ts
+export default defineNuxtConfig({
+  cap: {
+    apiEndpoint: 'https://cap.example.com/<KEY>/',
+  },
+})
+```
+
+---
+
+### 2️⃣ Using an Environment Variable (Recommended)
+
+```bash
+NUXT_PUBLIC_CAP_API_ENDPOINT="https://cap.example.com/<KEY>/"
+```
+
+Because this uses **Nuxt runtimeConfig**, it supports runtime environment variables — meaning you can change the endpoint **after build time** without rebuilding your application.
+
+## 🧩 `<Cap />` Component
+
+This module auto-imports a component called:
+
+```vue
+<Cap />
+```
+
+---
+
+## 📡 Emits
+
+The component exposes four events:
+
+- `@solve`
+- `@error`
+- `@reset`
+- `@progress`
+
+### Example
+
+```vue
+<script setup lang="ts">
+  import type {
+    CapErrorEvent,
+    CapProgressEvent,
+    CapResetEvent,
+    CapSolveEvent,
+  } from '@cap.js/widget'
+
+  function onSolve(event: CapSolveEvent): void {
+    console.log('Solved:', event)
+  }
+
+  function onError(event: CapErrorEvent): void {
+    console.error('Error:', event)
+  }
+
+  function onReset(event: CapResetEvent): void {
+    console.log('Reset:', event)
+  }
+
+  function onProgress(event: CapProgressEvent): void {
+    console.log('Progress:', event)
+  }
+</script>
+
+<template>
+  <Cap @solve="onSolve" @error="onError" @reset="onReset" @progress="onProgress" />
+</template>
+```
+
+## 🧱 Props
+
+### `workerCount?: number`
+
+Optional.
+
+Defines how many Web Workers Cap should use to solve the proof-of-work challenge.
+
+If not set, Cap defaults to:
+
+```ts
+navigator.hardwareConcurrency || 8
+```
+
+---
+
+### `i18n?: object`
+
+Optional.
+
+Allows you to customize the widget language.
+
+```ts
+{
+  verifyingLabel?: string
+  initialState?: string
+  solvedLabel?: string
+  errorLabel?: string
+  wasmDisabled?: string
+  verifyAriaLabel?: string
+  verifyingAriaLabel?: string
+  verifiedAriaLabel?: string
+  errorAriaLabel?: string
+}
+```
+
+### Example
+
+```vue
+<template>
+  <Cap
+    :worker-count="4"
+    :i18n="{
+      verifyingLabel: 'Verificando...',
+      solvedLabel: 'Verificado',
+      errorLabel: 'Erro',
+    }" />
+</template>
+```
+
+## 🎨 Customizing Appearance
+
+To customize Cap’s appearance, follow the official Cap widget customization guide:
+[Customizing](https://capjs.js.org/guide/widget.html#customizing)
+
+## 🔄 Reset
+
+To reset the Cap widget programmatically, you can use the provided helper function:
+
+```ts
+resetCap()
+```
+
+### Example
+
+```vue
+<script setup lang="ts">
+  function handleReset(): void {
+    // ...anything
+    resetCap()
+  }
+</script>
+
+<template>
+  <button @click="handleReset">Reset Cap</button>
+
+  <Cap />
+</template>
+```
+
+Calling `resetCap()` will reset the current widget state, allowing the challenge to be solved again.
+
+## 👻 Invisible Mode
+
+For invisible mode, you can use the `useCap()` composable.
+
+It returns a Cap instance, similar to the one described in the official invisible guide:
+
+[Guide](https://capjs.js.org/guide/invisible.html)
+
+You can call any available Cap instance method, such as `cap.solve()`.
+
+### Example
+
+```vue
+<script setup lang="ts">
+  const cap = useCap()
+
+  async function testCap(): Promise<void> {
+    if (!cap) return
+
+    const { token } = await cap.solve()
+    console.log(token)
+  }
+</script>
+
+<template>
+  <button @click="testCap">Solve Invisible Cap</button>
+</template>
+```
+
+This allows you to manually trigger the proof-of-work challenge without rendering the `<Cap />` checkbox widget.
+
+## 📝 License
+
+Copyright © 2026 [Gabriel 'DethDKN' Rosa](https://github.com/dethdkn)\
+This project is under [MIT license](https://github.com/dethdkn/nuxt-cap/blob/main/LICENSE)

package/dist/module.d.mts

@@ -0,0 +1,16 @@
+import { NuxtModule } from '@nuxt/schema';
+
+declare module 'nuxt/schema' {
+    interface PublicRuntimeConfig {
+        cap?: {
+            apiEndpoint?: string;
+        };
+    }
+}
+interface ModuleOptions {
+    apiEndpoint?: string;
+}
+declare const module$1: NuxtModule<ModuleOptions>;
+
+export { module$1 as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "cap",
+  "configKey": "cap",
+  "compatibility": {
+    "nuxt": ">=3.0.0"
+  },
+  "version": "0.0.0",
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,22 @@
+import { defineNuxtModule, createResolver, addPlugin, addImports, addComponent } from '@nuxt/kit';
+
+const module$1 = defineNuxtModule({
+  meta: { name: "cap", configKey: "cap", compatibility: { nuxt: ">=3.0.0" } },
+  setup({ apiEndpoint }, nuxt) {
+    const resolver = createResolver(import.meta.url);
+    const { runtimeConfig } = nuxt.options;
+    runtimeConfig.public.cap ??= {};
+    runtimeConfig.public.cap.apiEndpoint ??= apiEndpoint ?? "";
+    addPlugin({ src: resolver.resolve("./runtime/plugins/cap"), mode: "client" });
+    addImports([
+      { name: "useCap", from: resolver.resolve("./runtime/composables/useCap") },
+      { name: "resetCap", from: resolver.resolve("./runtime/utils/resetCap") }
+    ]);
+    addComponent({
+      name: "Cap",
+      filePath: resolver.resolve("./runtime/components/Cap.vue")
+    });
+  }
+});
+
+export { module$1 as default };

package/dist/runtime/components/Cap.d.vue.ts

@@ -0,0 +1,53 @@
+import type { PropType } from 'vue';
+import type { CapErrorEvent, CapProgressEvent, CapResetEvent, CapSolveEvent } from '@cap.js/widget';
+declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    workerCount: {
+        type: NumberConstructor;
+        required: false;
+    };
+    i18n: {
+        type: PropType<{
+            verifyingLabel?: string;
+            initialState?: string;
+            solvedLabel?: string;
+            errorLabel?: string;
+            wasmDisabled?: string;
+            verifyAriaLabel?: string;
+            verifyingAriaLabel?: string;
+            verifiedAriaLabel?: string;
+            errorAriaLabel?: string;
+        }>;
+        required: false;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    solve: (cap: CapSolveEvent) => any;
+    error: (cap: CapErrorEvent) => any;
+    reset: (cap: CapResetEvent) => any;
+    progress: (cap: CapProgressEvent) => any;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    workerCount: {
+        type: NumberConstructor;
+        required: false;
+    };
+    i18n: {
+        type: PropType<{
+            verifyingLabel?: string;
+            initialState?: string;
+            solvedLabel?: string;
+            errorLabel?: string;
+            wasmDisabled?: string;
+            verifyAriaLabel?: string;
+            verifyingAriaLabel?: string;
+            verifiedAriaLabel?: string;
+            errorAriaLabel?: string;
+        }>;
+        required: false;
+    };
+}>> & Readonly<{
+    onSolve?: ((cap: CapSolveEvent) => any) | undefined;
+    onError?: ((cap: CapErrorEvent) => any) | undefined;
+    onReset?: ((cap: CapResetEvent) => any) | undefined;
+    onProgress?: ((cap: CapProgressEvent) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/components/Cap.vue

@@ -0,0 +1,60 @@
+<script setup>
+import { onNuxtReady, useRuntimeConfig } from "#app";
+import { onUnmounted, ref } from "vue";
+const props = defineProps({
+  workerCount: { type: Number, required: false },
+  i18n: {
+    type: Object,
+    required: false
+  }
+});
+const emit = defineEmits(["solve", "error", "reset", "progress"]);
+const capEl = ref();
+function solve(event) {
+  emit("solve", event);
+}
+function error(event) {
+  emit("error", event);
+}
+function reset(event) {
+  emit("reset", event);
+}
+function progress(event) {
+  emit("progress", event);
+}
+onNuxtReady(() => {
+  const el = capEl.value;
+  if (!el) return;
+  el.addEventListener("solve", solve);
+  el.addEventListener("error", error);
+  el.addEventListener("reset", reset);
+  el.addEventListener("progress", progress);
+});
+onUnmounted(() => {
+  const el = capEl.value;
+  if (!el) return;
+  el.removeEventListener("solve", solve);
+  el.removeEventListener("error", error);
+  el.removeEventListener("reset", reset);
+  el.removeEventListener("progress", progress);
+});
+const { cap } = useRuntimeConfig().public;
+</script>
+
+<template>
+  <component
+    is="cap-widget"
+    ref="capEl"
+    id="cap"
+    :data-cap-api-endpoint="cap?.apiEndpoint"
+    :data-cap-worker-count="workerCount"
+    :data-cap-i18n-verifying-label="i18n?.verifyingLabel"
+    :data-cap-i18n-initial-state="i18n?.initialState"
+    :data-cap-i18n-solved-label="i18n?.solvedLabel"
+    :data-cap-i18n-error-label="i18n?.errorLabel"
+    :data-cap-i18n-wasm-disabled="i18n?.wasmDisabled"
+    :data-cap-verify-aria-label="i18n?.verifyAriaLabel"
+    :data-cap-verifying-aria-label="i18n?.verifyingAriaLabel"
+    :data-cap-verified-aria-label="i18n?.verifiedAriaLabel"
+    :data-cap-error-aria-label="i18n?.errorAriaLabel" />
+</template>

package/dist/runtime/components/Cap.vue.d.ts

@@ -0,0 +1,53 @@
+import type { PropType } from 'vue';
+import type { CapErrorEvent, CapProgressEvent, CapResetEvent, CapSolveEvent } from '@cap.js/widget';
+declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    workerCount: {
+        type: NumberConstructor;
+        required: false;
+    };
+    i18n: {
+        type: PropType<{
+            verifyingLabel?: string;
+            initialState?: string;
+            solvedLabel?: string;
+            errorLabel?: string;
+            wasmDisabled?: string;
+            verifyAriaLabel?: string;
+            verifyingAriaLabel?: string;
+            verifiedAriaLabel?: string;
+            errorAriaLabel?: string;
+        }>;
+        required: false;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    solve: (cap: CapSolveEvent) => any;
+    error: (cap: CapErrorEvent) => any;
+    reset: (cap: CapResetEvent) => any;
+    progress: (cap: CapProgressEvent) => any;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    workerCount: {
+        type: NumberConstructor;
+        required: false;
+    };
+    i18n: {
+        type: PropType<{
+            verifyingLabel?: string;
+            initialState?: string;
+            solvedLabel?: string;
+            errorLabel?: string;
+            wasmDisabled?: string;
+            verifyAriaLabel?: string;
+            verifyingAriaLabel?: string;
+            verifiedAriaLabel?: string;
+            errorAriaLabel?: string;
+        }>;
+        required: false;
+    };
+}>> & Readonly<{
+    onSolve?: ((cap: CapSolveEvent) => any) | undefined;
+    onError?: ((cap: CapErrorEvent) => any) | undefined;
+    onReset?: ((cap: CapResetEvent) => any) | undefined;
+    onProgress?: ((cap: CapProgressEvent) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/composables/useCap.d.ts

@@ -0,0 +1,2 @@
+import type { Cap, CapConfig, CapWidget } from '@cap.js/widget';
+export declare function useCap(config?: CapConfig, el?: CapWidget): Cap | undefined;

package/dist/runtime/composables/useCap.js

@@ -0,0 +1,8 @@
+import { useNuxtApp, useRuntimeConfig } from "#app";
+export function useCap(config, el) {
+  if (!import.meta.client) return;
+  const { $cap } = useNuxtApp();
+  const { cap } = useRuntimeConfig().public;
+  const capInstance = new $cap({ apiEndpoint: cap?.apiEndpoint, ...config }, el);
+  return capInstance;
+}

package/dist/runtime/plugins/cap.d.ts

@@ -0,0 +1,7 @@
+import Cap from '@cap.js/widget';
+declare const _default: import("nuxt/app").Plugin<{
+    cap: typeof Cap;
+}> & import("nuxt/app").ObjectPlugin<{
+    cap: typeof Cap;
+}>;
+export default _default;

package/dist/runtime/plugins/cap.js

@@ -0,0 +1,7 @@
+import { defineNuxtPlugin } from "#imports";
+import Cap from "@cap.js/widget";
+export default defineNuxtPlugin(() => ({
+  provide: {
+    cap: Cap
+  }
+}));

package/dist/runtime/utils/resetCap.d.ts

@@ -0,0 +1 @@
+export declare function resetCap(): void;

package/dist/runtime/utils/resetCap.js

@@ -0,0 +1,5 @@
+export function resetCap() {
+  if (!import.meta.client) return;
+  const cap = document.querySelector("#cap");
+  cap?.reset();
+}

package/dist/types.d.mts

@@ -0,0 +1,3 @@
+export { default } from './module.mjs'
+
+export { type ModuleOptions } from './module.mjs'

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "nuxt-cap",
+  "version": "0.1.0",
+  "description": "🧢 Integrate Cap into your Nuxt websites/applications.",
+  "keywords": [
+    "cbpf",
+    "module",
+    "nuxt"
+  ],
+  "homepage": "https://github.com/dethdkn/nuxt-cap",
+  "bugs": "https://github.com/dethdkn/nuxt-cap/issues",
+  "license": "MIT",
+  "author": {
+    "name": "Gabriel 'DethDKN' Rosa",
+    "email": "gabriel@rosa.dev.br",
+    "url": "https://rosa.dev.br"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dethdkn/nuxt-cap.git"
+  },
+  "funding": "https://github.com/sponsors/dethdkn",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "scripts": {
+    "postinstall": "bun run dev:prepare",
+    "dev": "nuxi dev playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "dev:build": "nuxi build playground",
+    "build": "nuxt-module-build build",
+    "fmt": "oxfmt --check",
+    "fmt:fix": "oxfmt",
+    "lint": "oxlint --type-aware",
+    "lint:fix": "oxlint --type-aware --fix",
+    "typecheck": "vue-tsc --noEmit",
+    "prerelease": "bun run fmt && bun run lint && bun run typecheck ",
+    "release": "bun run prerelease && bun run build && bumpp && sudo npm publish"
+  },
+  "dependencies": {
+    "@cap.js/widget": "^0.1.34",
+    "@nuxt/kit": "^4.3.1"
+  },
+  "devDependencies": {
+    "@dethdkn/ox-config": "^1.0.10",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.3.1",
+    "@types/bun": "^1.3.9",
+    "bumpp": "^10.4.1",
+    "nuxt": "^4.3.1",
+    "typescript": "5.9.3",
+    "vue-tsc": "^3.2.4"
+  }
+}