tresjs-nuxt 4.4.0 → 4.6.0

package/README.md

@@ -5,7 +5,7 @@
 [![NPM downloads][badge-npm-downloads]][url-npm]
 [![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]
 
-A Nuxt module for TresJS 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).
 
@@ -19,10 +19,16 @@ Design notes live in [the specs](https://github.com/Esposter/Esposter/tree/main/
 
 ## <a name="getting-started">🚀 Getting Started</a>
 
+1. Install the package.
+
 ```bash
 pnpm i tresjs-nuxt
 ```
 
+Check: `package.json` lists `tresjs-nuxt` in its dependencies.
+
+2. Add this to `nuxt.config.ts`.
+
 ```ts
 // nuxt.config.ts
 export default defineNuxtConfig({
@@ -32,12 +38,14 @@ export default defineNuxtConfig({
 });
 ```
 
+Check: `pnpm dev` starts with no module error.
+
 ## <a name="key-exports">🧩 Key Exports</a>
 
-| Export          | Kind      | Purpose                                                                                                                    |
-| :-------------- | :-------- | :------------------------------------------------------------------------------------------------------------------------- |
-| `default`       | const     | The Nuxt module: auto-imports the TresJS core API, registers `TresCanvas` and each installed `@tresjs/*` package's exports |
-| `ModuleOptions` | interface | The `tres` config key: `glsl` loads the `vite-plugin-glsl` peer, and `modules` names extra packages whose exports register |
+| 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.d.ts

@@ -0,0 +1,4 @@
+import { ModuleOptions } from "./models/ModuleOptions.js";
+import { NuxtModule } from "@nuxt/schema";
+declare const tresjsModule: NuxtModule<ModuleOptions>;
+export { type ModuleOptions, tresjsModule as default };

package/dist/index.js

@@ -0,0 +1,78 @@
+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";
+import { defu } from "defu";
+// src/module.ts
+const LOWERCASE_NAME_REGEX = /^[a-z]/u;
+const tresjsModule = defineNuxtModule({
+	defaults: {
+		glsl: false,
+		modules: []
+	},
+	meta: {
+		compatibility: { nuxt: ">=5.0.0-0" },
+		configKey: "tres",
+		name: MODULE_NAME
+	},
+	async setup(options, nuxt) {
+		const { resolve } = createResolver(import.meta.url);
+		nuxt.options.build.transpile.push(/@tresjs\//u);
+		nuxt.options.vue.compilerOptions.isCustomElement = checkIsTresCustomElement;
+		const coreExportNames = await getExportNames(await resolvePath(CORE_PACKAGE_NAME));
+		addImports([
+			...coreExportNames.filter((name) => name.startsWith("use")).map((name) => ({
+				from: CORE_PACKAGE_NAME,
+				name
+			})),
+			{
+				as: "extendTres",
+				from: CORE_PACKAGE_NAME,
+				name: "extend"
+			},
+			{
+				from: CORE_PACKAGE_NAME,
+				name: "TresObject",
+				type: true
+			}
+		]);
+		nuxt.hook("prepare:types", ({ references }) => {
+			references.push({ types: CORE_PACKAGE_NAME });
+		});
+		const packageNames = /* @__PURE__ */ new Set([...options.modules ?? [], ...await getTresPackageNames(nuxt.options.rootDir)]);
+		const packageExports = await Promise.all(Array.from(packageNames, async (packageName) => {
+			const entryPath = await resolvePath(packageName);
+			if (entryPath === packageName) return [];
+			return (await getExportNames(entryPath)).map((name) => ({
+				name,
+				packageName
+			}));
+		}));
+		for (const { name, packageName } of packageExports.flat()) if (LOWERCASE_NAME_REGEX.test(name)) addImports({
+			from: packageName,
+			name
+		});
+		else addComponent({
+			export: name,
+			filePath: packageName,
+			name
+		});
+		nuxt.options.vite.resolve = defu(nuxt.options.vite.resolve, { dedupe: [THREE_PACKAGE_NAME] });
+		nuxt.options.vite.optimizeDeps = defu(nuxt.options.vite.optimizeDeps, { include: [THREE_PACKAGE_NAME] });
+		addComponent({
+			filePath: await resolvePath(resolve("./runtime/TresCanvas.client")),
+			name: TRES_CANVAS_NAME
+		});
+		addComponent({
+			filePath: await resolvePath(resolve("./runtime/TresCanvas.server")),
+			name: TRES_CANVAS_NAME
+		});
+		if (options.glsl) {
+			const { default: glsl } = await import(GLSL_PACKAGE_NAME);
+			addVitePlugin(glsl());
+		}
+	}
+});
+export { tresjsModule as default };

package/dist/models/ModuleOptions.d.ts

@@ -0,0 +1,4 @@
+export interface ModuleOptions {
+  glsl?: boolean;
+  modules?: string[];
+}

package/dist/runtime/TresCanvas.client.d.ts

@@ -0,0 +1,3 @@
+import { Component } from "vue";
+declare const tresCanvasClient: Component;
+export { tresCanvasClient as default };

package/dist/runtime/TresCanvas.client.js

@@ -0,0 +1,12 @@
+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: TRES_CANVAS_NAME,
+	setup(_props, { attrs, slots }) {
+		return () => h(TresCanvas, attrs, slots);
+	}
+});
+export { tresCanvasClient as default };

package/dist/runtime/TresCanvas.server.d.ts

@@ -0,0 +1,3 @@
+import { Component } from "vue";
+declare const tresCanvasServer: Component;
+export { tresCanvasServer as default };

package/dist/runtime/TresCanvas.server.js

@@ -0,0 +1,8 @@
+import { TRES_CANVAS_NAME } from "../services/constants.js";
+import { defineComponent, h } from "vue";
+// src/runtime/TresCanvas.server.ts
+const tresCanvasServer = defineComponent({
+	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/checkIsTresCustomElement.js

@@ -0,0 +1,7 @@
+import { TRES_CORE_COMPONENT_NAMES } from "./constants.js";
+// src/services/checkIsTresCustomElement.ts
+const PRIMITIVE_TAG_NAME = "primitive";
+const TRES_COMPONENT_NAME_REGEX = /^Tres[A-Z]/u;
+const TRES_ELEMENT_NAME_PREFIX = "tres-";
+const checkIsTresCustomElement = (tagName) => (TRES_COMPONENT_NAME_REGEX.test(tagName) || tagName.startsWith(TRES_ELEMENT_NAME_PREFIX)) && !TRES_CORE_COMPONENT_NAMES.includes(tagName) || tagName === PRIMITIVE_TAG_NAME;
+export { checkIsTresCustomElement };

package/dist/services/constants.js

@@ -0,0 +1,14 @@
+// src/services/constants.ts
+const CORE_PACKAGE_NAME = "@tresjs/core";
+const GLSL_PACKAGE_NAME = "vite-plugin-glsl";
+const THREE_PACKAGE_NAME = "three";
+const TRES_CANVAS_NAME = "TresCanvas";
+const TRES_PACKAGE_SCOPE = "@tresjs/";
+const TRES_CORE_COMPONENT_NAMES = [
+	TRES_CANVAS_NAME,
+	"TresCanvasContext",
+	"TresLeches",
+	"TresPortal",
+	"TresScene"
+];
+export { CORE_PACKAGE_NAME, GLSL_PACKAGE_NAME, THREE_PACKAGE_NAME, TRES_CANVAS_NAME, TRES_CORE_COMPONENT_NAMES, TRES_PACKAGE_SCOPE };

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/getExportNames.js

@@ -0,0 +1,5 @@
+import { findExportNames } from "mlly";
+import { readFile } from "node:fs/promises";
+// src/services/getExportNames.ts
+const getExportNames = async (entryPath) => findExportNames(await readFile(entryPath, "utf8"));
+export { getExportNames };

package/dist/services/getTresPackageNames.js

@@ -0,0 +1,12 @@
+import "./constants.js";
+import { getDependencyNames } from "./getDependencyNames.js";
+import { dirname, join } from "node:path";
+import { existsSync } from "node:fs";
+// src/services/getTresPackageNames.ts
+const getTresPackageNames = async (rootDirectory) => {
+	const parentDirectory = dirname(rootDirectory);
+	const directories = existsSync(join(parentDirectory, "package.json")) ? [rootDirectory, parentDirectory] : [rootDirectory];
+	const dependencyNames = (await Promise.all(directories.map((directory) => getDependencyNames(directory)))).flat();
+	return [...new Set(dependencyNames)].filter((dependencyName) => dependencyName.startsWith("@tresjs/") && dependencyName !== "@tresjs/core");
+};
+export { getTresPackageNames };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tresjs-nuxt",
-  "version": "4.4.0",
+  "version": "4.6.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",
@@ -50,21 +50,22 @@
     "mlly": "^1.8.2"
   },
   "devDependencies": {
-    "@esposter/configuration": "4.4.0",
-    "tsdown": "0.23.2",
+    "@esposter/configuration": "4.6.0",
+    "@types/node": "^26.6.6",
+    "tsdown": "^0.23.7",
     "vite-plugin-glsl": "^1.6.2"
   },
   "peerDependencies": {
     "@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"
+    "vue": "^3.5.45"
   },
   "peerDependenciesMeta": {
     "vite-plugin-glsl": {
       "optional": true
     }
   },
-  "gitHead": "e1a416c4b91da69cc2aa259b50a4d656f204d272"
+  "gitHead": "0ceea3ffbe12ca69413ea5db2d3cfad197a63cba"
 }