@lupinum/nuxt-board 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-present Lupinum OG and contributors
+
+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,63 @@
+<p align="center"><img src="https://raw.githubusercontent.com/lupinum-dev/nuxt-board/main/docs/public/app-icon.svg" width="128" alt="Nuxt Board icon"></p>
+
+<h1 align="center">@lupinum/nuxt-board</h1>
+
+<p align="center">Add the Nuxt Board components, composables, helpers, and styles to Nuxt.</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@lupinum/nuxt-board"><img src="https://img.shields.io/npm/v/@lupinum/nuxt-board?label=npm" alt="npm version"></a>
+  <a href="https://github.com/lupinum-dev/nuxt-board/actions/workflows/ci.yml"><img src="https://github.com/lupinum-dev/nuxt-board/actions/workflows/ci.yml/badge.svg" alt="CI status"></a>
+  <a href="https://github.com/lupinum-dev/nuxt-board/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT license"></a>
+</p>
+
+> [!WARNING]
+> This package has not reached a stable release. Review the changelog before each upgrade.
+
+## Purpose
+
+Use this module when a Nuxt application needs board auto-imports and deterministic server rendering.
+
+## Requirements
+
+The module requires Nuxt 3.19 or newer. Install matching versions of the three packages so their public contracts stay aligned.
+
+## Installation
+
+```bash
+pnpm add @lupinum/nuxt-board @lupinum/board-core @lupinum/vue-board
+```
+
+```ts
+export default defineNuxtConfig({
+  modules: ['@lupinum/nuxt-board'],
+})
+```
+
+## Quick start
+
+```vue
+<script setup lang="ts">
+const engine = createBoardEngine({ grid: { size: 24, snap: true } })
+engine.createNode({ type: 'text', x: 64, y: 64, text: 'Nuxt Board' })
+</script>
+
+<template>
+  <BoardRoot :engine="engine" style="height: 480px" />
+</template>
+```
+
+## Exports
+
+The module auto-imports the board components, composables, `createBoardEngine`, and the default styles. Use stable node IDs for setup-time content so server HTML matches client hydration.
+
+## Documentation
+
+Read the [Nuxt module reference](https://nuxt-board.lupinum.com/docs/reference/nuxt-board).
+
+## Support and security
+
+Open a [GitHub issue](https://github.com/lupinum-dev/nuxt-board/issues) for support. Report vulnerabilities through the [private security process](https://github.com/lupinum-dev/nuxt-board/security/policy).
+
+## License
+
+This package uses the [MIT License](https://github.com/lupinum-dev/nuxt-board/blob/main/LICENSE).

package/dist/module.d.mts

@@ -0,0 +1,25 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+/** Configuration for the `@lupinum/nuxt-board` module. */
+interface ModuleOptions {
+    /**
+     * Optional prefix for all auto-imported board exports.
+     * Default: '' (no prefix). Example: 'My' → <MyBoardRoot>, useMyBoardCamera(), createMyBoardEngine()
+     */
+    prefix?: string;
+    /**
+     * Whether to auto-import board components (BoardRoot, BoardNode, etc.).
+     * Default: true
+     */
+    autoImportComponents?: boolean;
+    /**
+     * Whether to auto-import board composables (useBoardEngine, useBoardCamera, etc.).
+     * Default: true
+     */
+    autoImportComposables?: boolean;
+}
+/** Nuxt module that auto-registers the board components and composables. */
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "@lupinum/nuxt-board",
+  "configKey": "board",
+  "compatibility": {
+    "nuxt": "^3.19.0 || ^4.0.0"
+  },
+  "version": "0.1.0",
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "unknown"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,107 @@
+import { defineNuxtModule, addComponent, addImports } from '@nuxt/kit';
+
+const BOARD_COMPONENTS = [
+  "BoardRoot",
+  "BoardViewport",
+  "BoardNode",
+  "BoardNodeHandle",
+  "BoardSelectionToolbar",
+  "BoardGrid",
+  "BoardBoxSelect",
+  "BoardSnapGuides"
+];
+const BOARD_COMPOSABLES = [
+  "useBoardEngine",
+  "useBoardCamera",
+  "useBoardNodes",
+  "useBoardSelection",
+  "useBoardInteraction",
+  "useBoardVisibleBounds",
+  "useBoardVisibleNodes",
+  "useBoardGridStyle",
+  "useBoardNode",
+  "useBoardBoxSelectBounds"
+];
+const BOARD_HELPERS = ["createBoardEngine"];
+const MINIMAP_COMPONENTS = ["BoardMinimap"];
+const MINIMAP_COMPOSABLES = ["useBoardMinimap"];
+function normalizePrefix(prefix) {
+  const value = prefix?.trim() ?? "";
+  const normalized = value ? `${value[0].toUpperCase()}${value.slice(1)}` : "";
+  if (normalized && !/^[A-Z][A-Za-z0-9]*$/.test(normalized)) {
+    throw new Error(
+      "@lupinum/nuxt-board: `board.prefix` must start with a letter and contain only letters or numbers."
+    );
+  }
+  return normalized;
+}
+function getComponentAlias(name, prefix) {
+  return prefix ? `${prefix}${name}` : name;
+}
+function getComposableAlias(name, prefix) {
+  return prefix ? `use${prefix}${name.slice(3)}` : name;
+}
+function getHelperAlias(name, prefix) {
+  return prefix ? `create${prefix}${name.slice(6)}` : name;
+}
+const module$1 = defineNuxtModule({
+  meta: {
+    name: "@lupinum/nuxt-board",
+    configKey: "board",
+    compatibility: {
+      nuxt: "^3.19.0 || ^4.0.0"
+    }
+  },
+  defaults: {
+    prefix: "",
+    autoImportComponents: true,
+    autoImportComposables: true
+  },
+  setup(options, nuxt) {
+    const prefix = normalizePrefix(options.prefix);
+    if (!nuxt.options.css.includes("@lupinum/vue-board/style.css")) {
+      nuxt.options.css.push("@lupinum/vue-board/style.css");
+    }
+    if (options.autoImportComponents !== false) {
+      for (const name of BOARD_COMPONENTS) {
+        addComponent({
+          name: getComponentAlias(name, prefix),
+          export: name,
+          filePath: "@lupinum/vue-board"
+        });
+      }
+      for (const name of MINIMAP_COMPONENTS) {
+        addComponent({
+          name: getComponentAlias(name, prefix),
+          export: name,
+          filePath: "@lupinum/vue-board/minimap"
+        });
+      }
+    }
+    if (options.autoImportComposables !== false) {
+      addImports(
+        BOARD_COMPOSABLES.map((name) => ({
+          name,
+          as: getComposableAlias(name, prefix),
+          from: "@lupinum/vue-board"
+        }))
+      );
+      addImports(
+        MINIMAP_COMPOSABLES.map((name) => ({
+          name,
+          as: getComposableAlias(name, prefix),
+          from: "@lupinum/vue-board/minimap"
+        }))
+      );
+      addImports(
+        BOARD_HELPERS.map((name) => ({
+          name,
+          as: getHelperAlias(name, prefix),
+          from: "@lupinum/board-core"
+        }))
+      );
+    }
+  }
+});
+
+export { module$1 as default };

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,81 @@
+{
+  "name": "@lupinum/nuxt-board",
+  "version": "0.1.0",
+  "description": "Nuxt module for @lupinum/vue-board with board component and composable auto-imports.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lupinum-dev/nuxt-board.git",
+    "directory": "packages/nuxt-board"
+  },
+  "homepage": "https://nuxt-board.lupinum.com",
+  "bugs": {
+    "url": "https://github.com/lupinum-dev/nuxt-board/issues"
+  },
+  "license": "MIT",
+  "author": "Lupinum OG <info@lupinum.com> (https://lupinum.com)",
+  "type": "module",
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "board",
+    "nuxt",
+    "vue",
+    "diagram"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@nuxt/kit": "4.5.1"
+  },
+  "peerDependencies": {
+    "nuxt": "^3.19.0 || ^4.0.0",
+    "@lupinum/board-core": "0.1.0",
+    "@lupinum/vue-board": "0.1.0"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "3.3.1",
+    "@nuxt/eslint-config": "^1.16.0",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "4.5.1",
+    "@nuxt/test-utils": "^4.0.3",
+    "@types/node": "20.19.0",
+    "@vitejs/plugin-vue": "6.0.6",
+    "eslint": "^10.7.0",
+    "nuxt": "4.5.1",
+    "typescript": "~5.9.3",
+    "vite": "7.3.5",
+    "vitest": "^4.1.10",
+    "vue-tsc": "^3.3.7",
+    "@lupinum/board-core": "0.1.0",
+    "@lupinum/vue-board": "0.1.0"
+  },
+  "scripts": {
+    "build": "nuxt-module-build prepare && nuxt-module-build build",
+    "dev": "pnpm run dev:prepare && nuxt dev playground",
+    "dev:build": "nuxt build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt prepare playground",
+    "lint": "eslint .",
+    "test": "pnpm --filter @lupinum/board-core build && pnpm --filter @lupinum/vue-board build && pnpm run dev:prepare && vitest run --root ../.. packages/nuxt-board/test",
+    "test:watch": "vitest watch --root ../.. packages/nuxt-board/test",
+    "test:types": "pnpm run dev:prepare && vue-tsc --noEmit && pnpm exec nuxi typecheck playground && pnpm exec nuxi typecheck test/fixtures/basic && pnpm exec nuxi typecheck test/fixtures/prefixed"
+  }
+}