tresjs-nuxt 4.3.3 → 4.5.0

package/README.md

@@ -5,25 +5,47 @@
 [![NPM downloads][badge-npm-downloads]][url-npm]
 [![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]
 
-TresJS for Nuxt — a Nuxt module that auto-imports the TresJS core API, registers TresCanvas for client and server, and registers every installed @tresjs package's components and composables, with no devtools UI of its own.
+A Nuxt module for TresJS that auto-imports the TresJS core API and registers TresCanvas for client and server. It registers the components and composables of every installed @tresjs package, and has no devtools UI of its own.
+
+Design notes live in [the specs](https://github.com/Esposter/Esposter/tree/main/openspec/specs/tresjs-nuxt).
 
 ## Table of Contents
 
 - 🚀 [Getting Started](#getting-started)
-- 📖 [Documentation](#documentation)
+- 🧩 [Key Exports](#key-exports)
 - ⚖️ [License](#license)
 
 ---
 
 ## <a name="getting-started">🚀 Getting Started</a>
 
+1. Install the package.
+
 ```bash
 pnpm i tresjs-nuxt
 ```
 
-## <a name="documentation">📖 Documentation</a>
+Check: `package.json` lists `tresjs-nuxt` in its dependencies.
+
+2. Add this to `nuxt.config.ts`.
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: ["tresjs-nuxt"],
+  // Loads the optional vite-plugin-glsl peer, which the app installs itself
+  tres: { glsl: true },
+});
+```
+
+Check: `pnpm dev` starts with no module error.
+
+## <a name="key-exports">🧩 Key Exports</a>
 
-We highly recommend you take a look at the [documentation](https://github.com/Esposter/Esposter/tree/main/openspec/specs/tresjs-nuxt) to level up.
+| Export          | Kind      | Purpose                                                                                                                                 |
+| :-------------- | :-------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
+| `default`       | const     | The Nuxt module. It auto-imports the TresJS core API, and registers `TresCanvas` and the exports of each installed `@tresjs/*` package. |
+| `ModuleOptions` | interface | The `tres` config key. `glsl` loads the `vite-plugin-glsl` peer. `modules` names extra packages whose exports register.                 |
 
 ## <a name="license">⚖️ License</a>
 

package/dist/index.js

@@ -1,5 +1,6 @@
-import { CORE_PACKAGE_NAME, GLSL_PACKAGE_NAME, THREE_PACKAGE_NAME, TRES_CANVAS_NAME } from "./services/constants.js";
+import { MODULE_NAME } from "./runtime/constants.js";
 import { checkIsTresCustomElement } from "./services/checkIsTresCustomElement.js";
+import { CORE_PACKAGE_NAME, GLSL_PACKAGE_NAME, THREE_PACKAGE_NAME, TRES_CANVAS_NAME } from "./services/constants.js";
 import { getExportNames } from "./services/getExportNames.js";
 import { getTresPackageNames } from "./services/getTresPackageNames.js";
 import { addComponent, addImports, addVitePlugin, createResolver, defineNuxtModule, resolvePath } from "@nuxt/kit";
@@ -14,7 +15,7 @@ const tresjsModule = defineNuxtModule({
 	meta: {
 		compatibility: { nuxt: ">=5.0.0-0" },
 		configKey: "tres",
-		name: "tresjs-nuxt"
+		name: MODULE_NAME
 	},
 	async setup(options, nuxt) {
 		const { resolve } = createResolver(import.meta.url);

package/dist/runtime/TresCanvas.client.js

@@ -1,9 +1,10 @@
+import { TRES_CANVAS_NAME } from "../services/constants.js";
 import { TresCanvas } from "@tresjs/core";
 import { defineComponent, h } from "vue";
 // src/runtime/TresCanvas.client.ts
 const tresCanvasClient = defineComponent({
 	inheritAttrs: false,
-	name: "TresCanvas",
+	name: TRES_CANVAS_NAME,
 	setup(_props, { attrs, slots }) {
 		return () => h(TresCanvas, attrs, slots);
 	}

package/dist/runtime/TresCanvas.server.js

@@ -1,7 +1,8 @@
+import { TRES_CANVAS_NAME } from "../services/constants.js";
 import { defineComponent, h } from "vue";
 // src/runtime/TresCanvas.server.ts
 const tresCanvasServer = defineComponent({
-	name: "TresCanvas",
+	name: TRES_CANVAS_NAME,
 	setup: () => () => h("span")
 });
 export { tresCanvasServer as default };

package/dist/runtime/constants.d.ts

@@ -0,0 +1 @@
+export declare const MODULE_NAME = "tresjs-nuxt";

package/dist/runtime/constants.js

@@ -0,0 +1,3 @@
+// src/runtime/constants.ts
+const MODULE_NAME = "tresjs-nuxt";
+export { MODULE_NAME };

package/dist/services/constants.js

@@ -5,7 +5,7 @@ const THREE_PACKAGE_NAME = "three";
 const TRES_CANVAS_NAME = "TresCanvas";
 const TRES_PACKAGE_SCOPE = "@tresjs/";
 const TRES_CORE_COMPONENT_NAMES = [
-	"TresCanvas",
+	TRES_CANVAS_NAME,
 	"TresCanvasContext",
 	"TresLeches",
 	"TresPortal",

package/dist/services/getDependencyNames.js

@@ -0,0 +1,8 @@
+import { readFile } from "node:fs/promises";
+import { join } from "node:path";
+// src/services/getDependencyNames.ts
+const getDependencyNames = async (directory) => {
+	const manifest = JSON.parse(await readFile(join(directory, "package.json"), "utf8"));
+	return [...Object.keys(manifest.dependencies ?? {}), ...Object.keys(manifest.devDependencies ?? {})];
+};
+export { getDependencyNames };

package/dist/services/getTresPackageNames.js

@@ -1,12 +1,8 @@
 import "./constants.js";
-import { readFile } from "node:fs/promises";
-import { existsSync } from "node:fs";
+import { getDependencyNames } from "./getDependencyNames.js";
 import { dirname, join } from "node:path";
+import { existsSync } from "node:fs";
 // src/services/getTresPackageNames.ts
-const getDependencyNames = async (directory) => {
-	const manifest = JSON.parse(await readFile(join(directory, "package.json"), "utf8"));
-	return [...Object.keys(manifest.dependencies ?? {}), ...Object.keys(manifest.devDependencies ?? {})];
-};
 const getTresPackageNames = async (rootDirectory) => {
 	const parentDirectory = dirname(rootDirectory);
 	const directories = existsSync(join(parentDirectory, "package.json")) ? [rootDirectory, parentDirectory] : [rootDirectory];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tresjs-nuxt",
-  "version": "4.3.3",
+  "version": "4.5.0",
   "description": "TresJS for Nuxt — a Nuxt module that auto-imports the TresJS core API, registers TresCanvas for client and server, and registers every installed @tresjs package's components and composables, with no devtools UI of its own.",
   "keywords": [
     "nuxt",
@@ -31,8 +31,6 @@
   },
   "exports": {
     ".": "./dist/index.js",
-    "./runtime/TresCanvas.client": "./dist/runtime/TresCanvas.client.js",
-    "./runtime/TresCanvas.server": "./dist/runtime/TresCanvas.server.js",
     "./package.json": "./package.json"
   },
   "publishConfig": {
@@ -43,7 +41,7 @@
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "vitest",
-    "typecheck": "tsc"
+    "typecheck": "tsrs --fast"
   },
   "dependencies": {
     "@nuxt/kit": "npm:@nuxt/kit-nightly@5x",
@@ -52,14 +50,15 @@
     "mlly": "^1.8.2"
   },
   "devDependencies": {
-    "@esposter/configuration": "4.3.3",
-    "tsdown": "^0.23.1",
+    "@esposter/configuration": "4.5.0",
+    "@types/node": "^26.6.6",
+    "tsdown": "^0.23.5",
     "vite-plugin-glsl": "^1.6.2"
   },
   "peerDependencies": {
-    "@tresjs/core": "^5.9.3",
+    "@tresjs/core": "^5.10.1",
     "nuxt": "npm:nuxt-nightly@5x",
-    "three": "^0.186.1",
+    "three": "^0.187.0",
     "vite-plugin-glsl": "^1.6.2",
     "vue": "^3.5.44"
   },
@@ -68,5 +67,5 @@
       "optional": true
     }
   },
-  "gitHead": "955bbc130ad9b28877fd4ae8efc73a045141ce01"
+  "gitHead": "e30c001f3b4b15693e75fb53092d62a97ade4d2b"
 }