tresjs-nuxt 4.3.1 → 4.4.0

package/README.md

@@ -5,12 +5,14 @@
 [![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, registers TresCanvas for client and server, and registers every installed @tresjs package's components and composables, with 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)
 
 ---
@@ -21,9 +23,21 @@ TresJS for Nuxt — a Nuxt module that auto-imports the TresJS core API, registe
 pnpm i tresjs-nuxt
 ```
 
-## <a name="documentation">📖 Documentation</a>
+```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 },
+});
+```
+
+## <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: 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 |
 
 ## <a name="license">⚖️ License</a>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tresjs-nuxt",
-  "version": "4.3.1",
+  "version": "4.4.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,12 +50,12 @@
     "mlly": "^1.8.2"
   },
   "devDependencies": {
-    "@esposter/configuration": "4.3.1",
-    "tsdown": "^0.23.1",
+    "@esposter/configuration": "4.4.0",
+    "tsdown": "0.23.2",
     "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",
     "vite-plugin-glsl": "^1.6.2",
@@ -68,5 +66,5 @@
       "optional": true
     }
   },
-  "gitHead": "777a39636b789c13af33ed13370246ccf6dbaf31"
+  "gitHead": "e1a416c4b91da69cc2aa259b50a4d656f204d272"
 }

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-import { ModuleOptions } from "./models/ModuleOptions.js";
-import { NuxtModule } from "@nuxt/schema";
-//#region src/module.d.ts
-declare const tresjsModule: NuxtModule<ModuleOptions>;
-//#endregion
-export { type ModuleOptions, tresjsModule as default };

package/dist/index.js

@@ -1,78 +0,0 @@
-import { CORE_PACKAGE_NAME, GLSL_PACKAGE_NAME, THREE_PACKAGE_NAME, TRES_CANVAS_NAME } from "./services/constants.js";
-import { checkIsTresCustomElement } from "./services/checkIsTresCustomElement.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";
-//#region 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: "tresjs-nuxt"
-	},
-	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());
-		}
-	}
-});
-//#endregion
-export { tresjsModule as default };

package/dist/models/ModuleOptions.d.ts

@@ -1,6 +0,0 @@
-//#region src/models/ModuleOptions.d.ts
-export interface ModuleOptions {
-  glsl?: boolean;
-  modules?: string[];
-}
-//#endregion

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

@@ -1,5 +0,0 @@
-import { Component } from "vue";
-//#region src/runtime/TresCanvas.client.d.ts
-declare const tresCanvasClient: Component;
-//#endregion
-export { tresCanvasClient as default };

package/dist/runtime/TresCanvas.client.js

@@ -1,12 +0,0 @@
-import { TresCanvas } from "@tresjs/core";
-import { defineComponent, h } from "vue";
-//#region src/runtime/TresCanvas.client.ts
-const tresCanvasClient = defineComponent({
-	inheritAttrs: false,
-	name: "TresCanvas",
-	setup(_props, { attrs, slots }) {
-		return () => h(TresCanvas, attrs, slots);
-	}
-});
-//#endregion
-export { tresCanvasClient as default };

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

@@ -1,5 +0,0 @@
-import { Component } from "vue";
-//#region src/runtime/TresCanvas.server.d.ts
-declare const tresCanvasServer: Component;
-//#endregion
-export { tresCanvasServer as default };

package/dist/runtime/TresCanvas.server.js

@@ -1,8 +0,0 @@
-import { defineComponent, h } from "vue";
-//#region src/runtime/TresCanvas.server.ts
-const tresCanvasServer = defineComponent({
-	name: "TresCanvas",
-	setup: () => () => h("span")
-});
-//#endregion
-export { tresCanvasServer as default };

package/dist/services/checkIsTresCustomElement.js

@@ -1,8 +0,0 @@
-import { TRES_CORE_COMPONENT_NAMES } from "./constants.js";
-//#region 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;
-//#endregion
-export { checkIsTresCustomElement };

package/dist/services/constants.js

@@ -1,15 +0,0 @@
-//#region 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 = [
-	"TresCanvas",
-	"TresCanvasContext",
-	"TresLeches",
-	"TresPortal",
-	"TresScene"
-];
-//#endregion
-export { CORE_PACKAGE_NAME, GLSL_PACKAGE_NAME, THREE_PACKAGE_NAME, TRES_CANVAS_NAME, TRES_CORE_COMPONENT_NAMES, TRES_PACKAGE_SCOPE };

package/dist/services/getExportNames.js

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

package/dist/services/getTresPackageNames.js

@@ -1,17 +0,0 @@
-import "./constants.js";
-import { readFile } from "node:fs/promises";
-import { existsSync } from "node:fs";
-import { dirname, join } from "node:path";
-//#region 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];
-	const dependencyNames = (await Promise.all(directories.map((directory) => getDependencyNames(directory)))).flat();
-	return [...new Set(dependencyNames)].filter((dependencyName) => dependencyName.startsWith("@tresjs/") && dependencyName !== "@tresjs/core");
-};
-//#endregion
-export { getTresPackageNames };