nuxt-cap 0.1.1 → 1.0.0

package/README.md

@@ -12,6 +12,11 @@
       <img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67" alt="Gitmoji"/>
    </a>
 </p>
+<h2 align="center">
+   <a href="https://nuxt-cap.pages.dev/">
+      📚 Full Documentation
+   </a>
+</h2>
 
 ## 🚀 Setup
 
@@ -21,6 +26,25 @@ Install `nuxt-cap` dependency to your project:
 npx nuxt module add nuxt-cap
 ```
 
+Or manually
+
+1. Install with your favorite package manager:
+   - **bun** : `bun add nuxt-cap`
+   - npm : `npm i nuxt-cap`
+   - pnpm : `pnpm add nuxt-cap`
+   - yarn : `yarn add nuxt-cap`
+
+2. Add it to your `modules` section in your `nuxt.config`:
+
+```ts
+export default defineNuxtConfig({
+  modules: ['nuxt-cap'],
+  cap: {
+    // ...configs
+  },
+})
+```
+
 ## ⚙️ Configuration
 
 You can configure **nuxt-cap** in two ways:
@@ -55,8 +79,6 @@ This module auto-imports a component called:
 <Cap />
 ```
 
----
-
 ## 📡 Emits
 
 The component exposes four events:
@@ -70,13 +92,6 @@ The component exposes four events:
 
 ```vue
 <script setup lang="ts">
-  import type {
-    CapErrorEvent,
-    CapProgressEvent,
-    CapResetEvent,
-    CapSolveEvent,
-  } from '@cap.js/widget'
-
   function onSolve(event: CapSolveEvent): void {
     console.log('Solved:', event)
   }
@@ -181,9 +196,9 @@ resetCap()
 
 Calling `resetCap()` will reset the current widget state, allowing the challenge to be solved again.
 
-## 👻 Invisible Mode
+## 🪄 useCap composable
 
-For invisible mode, you can use the `useCap()` composable.
+You can use the `useCap()` composable for invisible mode.
 
 It returns a Cap instance, similar to the one described in the official invisible guide:
 

package/dist/module.d.mts

@@ -8,6 +8,7 @@ declare module 'nuxt/schema' {
     }
 }
 interface ModuleOptions {
+    enabled?: boolean;
     apiEndpoint?: string;
 }
 declare const module$1: NuxtModule<ModuleOptions>;

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": ">=3.0.0"
   },
-  "version": "0.1.0",
+  "version": "0.1.2",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -2,7 +2,11 @@ import { defineNuxtModule, createResolver, addPlugin, addImports, addComponent }
 
 const module$1 = defineNuxtModule({
   meta: { name: "cap", configKey: "cap", compatibility: { nuxt: ">=3.0.0" } },
-  setup({ apiEndpoint }, nuxt) {
+  defaults: { enabled: true, apiEndpoint: "" },
+  setup({ enabled, apiEndpoint }, nuxt) {
+    if (!enabled) {
+      return;
+    }
     const resolver = createResolver(import.meta.url);
     const { runtimeConfig } = nuxt.options;
     runtimeConfig.public.cap ??= {};
@@ -10,7 +14,15 @@ const module$1 = defineNuxtModule({
     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") }
+      { name: "resetCap", from: resolver.resolve("./runtime/utils/resetCap") },
+      { name: "CapConfig", from: resolver.resolve("./runtime/types/Cap.d"), type: true },
+      { name: "CapInstance", from: resolver.resolve("./runtime/types/Cap.d"), type: true },
+      { name: "CapClass", from: resolver.resolve("./runtime/types/Cap.d"), type: true },
+      { name: "CapWidget", from: resolver.resolve("./runtime/types/Cap.d"), type: true },
+      { name: "CapErrorEvent", from: resolver.resolve("./runtime/types/Cap.d"), type: true },
+      { name: "CapProgressEvent", from: resolver.resolve("./runtime/types/Cap.d"), type: true },
+      { name: "CapResetEvent", from: resolver.resolve("./runtime/types/Cap.d"), type: true },
+      { name: "CapSolveEvent", from: resolver.resolve("./runtime/types/Cap.d"), type: true }
     ]);
     addComponent({
       name: "Cap",

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

@@ -1,5 +1,5 @@
 import type { PropType } from 'vue';
-import type { CapErrorEvent, CapProgressEvent, CapResetEvent, CapSolveEvent } from '@cap.js/widget';
+import type { CapErrorEvent, CapProgressEvent, CapResetEvent, CapSolveEvent } from '../types/Cap.js';
 declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     workerCount: {
         type: NumberConstructor;

package/dist/runtime/components/Cap.vue

@@ -9,6 +9,7 @@ const props = defineProps({
   }
 });
 const emit = defineEmits(["solve", "error", "reset", "progress"]);
+const { cap } = useRuntimeConfig().public;
 const capEl = ref();
 function solve(event) {
   emit("solve", event);
@@ -23,6 +24,11 @@ function progress(event) {
   emit("progress", event);
 }
 onNuxtReady(() => {
+  if (!cap?.apiEndpoint) {
+    throw new Error(
+      '[Cap] No API endpoint provided. Please set the "cap.apiEndpoint" runtime config or provide it in nuxt config.'
+    );
+  }
   const el = capEl.value;
   if (!el) return;
   el.addEventListener("solve", solve);
@@ -38,7 +44,6 @@ onUnmounted(() => {
   el.removeEventListener("reset", reset);
   el.removeEventListener("progress", progress);
 });
-const { cap } = useRuntimeConfig().public;
 </script>
 
 <template>

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

@@ -1,5 +1,5 @@
 import type { PropType } from 'vue';
-import type { CapErrorEvent, CapProgressEvent, CapResetEvent, CapSolveEvent } from '@cap.js/widget';
+import type { CapErrorEvent, CapProgressEvent, CapResetEvent, CapSolveEvent } from '../types/Cap.js';
 declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     workerCount: {
         type: NumberConstructor;

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

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

package/dist/runtime/composables/useCap.js

@@ -3,6 +3,12 @@ export function useCap(config, el) {
   const { $cap } = useNuxtApp();
   const { cap } = useRuntimeConfig().public;
   if (!import.meta.client || !$cap) return;
+  if (!cap?.apiEndpoint && !config?.apiEndpoint) {
+    console.error(
+      '[useCap] No API endpoint provided. Please set the "cap.apiEndpoint" runtime config or provide it in the config parameter.'
+    );
+    return;
+  }
   const capInstance = new $cap({ apiEndpoint: cap?.apiEndpoint, ...config }, el);
   return capInstance;
 }

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

@@ -1,11 +1,11 @@
-import type CapClass from '@cap.js/widget';
+import type { CapClass } from '../types/Cap.js';
 import '@cap.js/widget';
 declare global {
-    var Cap: typeof CapClass;
+    var Cap: CapClass | undefined;
 }
 declare const _default: import("nuxt/app").Plugin<{
-    cap: typeof CapClass;
+    cap: typeof import("#imports").CapInstance | undefined;
 }> & import("nuxt/app").ObjectPlugin<{
-    cap: typeof CapClass;
+    cap: typeof import("#imports").CapInstance | undefined;
 }>;
 export default _default;

package/dist/runtime/types/Cap.d.ts

@@ -0,0 +1,22 @@
+import type {
+  CapConfig,
+  CapErrorEvent,
+  Cap as CapInstance,
+  CapProgressEvent,
+  CapResetEvent,
+  CapSolveEvent,
+  CapWidget,
+} from '@cap.js/widget'
+
+type CapClass = typeof CapInstance
+
+export type {
+  CapConfig,
+  CapInstance,
+  CapClass,
+  CapWidget,
+  CapErrorEvent,
+  CapProgressEvent,
+  CapResetEvent,
+  CapSolveEvent,
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-cap",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "description": "🧢 Integrate Cap into your Nuxt websites/applications.",
   "keywords": [
     "cbpf",
@@ -44,6 +44,8 @@
     "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
     "dev:build": "nuxi build playground",
     "build": "nuxt-module-build build",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
     "fmt": "oxfmt --check",
     "fmt:fix": "oxfmt",
     "lint": "oxlint --type-aware",
@@ -57,13 +59,15 @@
     "@nuxt/kit": "^4.3.1"
   },
   "devDependencies": {
-    "@dethdkn/ox-config": "^1.0.10",
+    "@dethdkn/ox-config": "^1.0.12",
     "@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",
+    "vitepress": "^1.6.4",
     "vue-tsc": "^3.2.4"
-  }
+  },
+  "packageManager": "bun@1.3.9"
 }