@tresjs/nuxt 1.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present, (alvarosabu) Alvaro Saburido and Tres 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,89 @@
+![Repo banner](public/nuxt-tres-banner.png)
+
+# @tresjs/nuxt
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+Official Nuxt module for TresJS. Build 3D scenes as they were Vue components.
+
+- [✨  Release Notes](/CHANGELOG.md)
+  <!-- - [🏀 Online playground](https://stackblitz.com/github/@tresjs/nuxt?file=playground%2Fapp.vue) -->
+  <!-- - [📖 &nbsp;Documentation](https://example.com) -->
+
+## Features
+
+- 🤓 Auto-import components and composables from the [TresJS ecosystem](https://github.com/orgs/Tresjs/repositories)
+- `TresCanvas` client only, you don't need of adding `.client` to the component name or `<ClientOnly />`
+- All the DX Magic that comes with Nuxt ✨
+
+## Quick Setup
+
+1. Add `@tresjs/nuxt` dependency to your project
+
+```bash
+# Using pnpm
+pnpm add -D @tresjs/nuxt
+
+# Using yarn
+yarn add --dev @tresjs/nuxt
+
+# Using npm
+npm install --save-dev @tresjs/nuxt
+```
+
+2. Add `@tresjs/nuxt` to the `modules` section of `nuxt.config.ts`
+
+```js
+export default defineNuxtConfig({
+  modules: ["@tresjs/nuxt"],
+});
+```
+
+That's it! You can now use `@tresjs/nuxt` in your Nuxt app ✨
+
+If you want to use the any package from the TresJS ecosystem, you can install the packages you want to use and they will be auto-imported by the module 🧙🏼‍♂️.
+
+```bash
+# Using pnpm
+pnpm add @tresjs/cientos @tresjs/post-processing
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Generate type stubs
+npm run dev:prepare
+
+# Develop with the playground
+npm run dev
+
+# Build the playground
+npm run dev:build
+
+# Run ESLint
+npm run lint
+
+# Run Vitest
+npm run test
+npm run test:watch
+
+# Release new version
+npm run release
+```
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@tresjs/nuxt/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@tresjs/nuxt
+[npm-downloads-src]: https://img.shields.io/npm/dm/@tresjs/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/@tresjs/nuxt
+[license-src]: https://img.shields.io/npm/l/@tresjs/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://npmjs.com/package/@tresjs/nuxt
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.ts

@@ -0,0 +1,8 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    modules: string[];
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { ModuleOptions, _default as default };

package/dist/module.json

@@ -0,0 +1,5 @@
+{
+  "name": "@tresjs/nuxt",
+  "configKey": "tres",
+  "version": "1.0.0-alpha.0"
+}

package/dist/module.mjs

@@ -0,0 +1,69 @@
+import { defineNuxtModule, createResolver, addComponent, addImports } from '@nuxt/kit';
+import * as core from '@tresjs/core';
+import { readPackageJSON } from 'pkg-types';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "@tresjs/nuxt",
+    configKey: "tres"
+  },
+  defaults: {
+    modules: []
+  },
+  async setup(options, nuxt) {
+    const resolver = createResolver(import.meta.url);
+    addComponent({
+      filePath: resolver.resolve("./runtime/components/TresCanvas.vue"),
+      name: "TresCanvas"
+    });
+    nuxt.options.build.transpile.push(/@tresjs/, "postprocessing");
+    for (const name in core) {
+      if (name.match(/^use/)) {
+        addImports({
+          from: "@tresjs/core",
+          name
+        });
+      }
+    }
+    addImports([
+      {
+        from: "@tresjs/core",
+        name: "extend",
+        as: "extendTres"
+      },
+      {
+        from: "@tresjs/core",
+        type: true,
+        name: "TresObject"
+      }
+    ]);
+    nuxt.hook("prepare:types", ({ references }) => {
+      references.push({ types: "@tresjs/core" });
+    });
+    const isCustomElement = nuxt.options.vue.compilerOptions.isCustomElement;
+    nuxt.options.vue.compilerOptions.isCustomElement = (tag) => {
+      return tag.startsWith("Tres") && tag !== "TresCanvas" || tag === "primitive" || isCustomElement?.(tag);
+    };
+    const pkg = await readPackageJSON(nuxt.options.rootDir);
+    const coreDeps = Object.keys({ ...pkg.dependencies, ...pkg.devDependencies }).filter((d) => d.startsWith("@tresjs/"));
+    for (const mod of /* @__PURE__ */ new Set([...options.modules, ...coreDeps])) {
+      const imports = await import(mod);
+      for (const name in imports) {
+        if (name.match(/^[a-z]/)) {
+          addImports({
+            from: mod,
+            name
+          });
+        } else {
+          addComponent({
+            name,
+            filePath: mod,
+            export: name
+          });
+        }
+      }
+    }
+  }
+});
+
+export { module as default };

package/dist/runtime/components/TresCanvas.vue

@@ -0,0 +1,12 @@
+<script setup lang="ts">
+import { TresCanvas as TC, TresCanvasProps } from '@tresjs/core';
+defineProps<TresCanvasProps>()
+</script>
+
+<template>
+  <ClientOnly>
+    <TC v-bind="$props">
+      <slot />
+    </TC>
+  </ClientOnly>
+</template>

package/dist/types.d.ts

@@ -0,0 +1,15 @@
+
+import { ModuleOptions } from './module'
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['tres']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['tres']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['tres']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['tres']?: ModuleOptions }
+}
+
+
+export { ModuleOptions, default } from './module'

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@tresjs/nuxt",
+  "type": "module",
+  "packageManager": "pnpm@8.6.2",
+  "version": "1.0.0-alpha.0",
+  "description": "TresJS integration for Nuxt.",
+  "repository": "@tresjs/nuxt",
+  "author": "Daniel Roe (https://github.com/danielroe/)",
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
+    "release": "release-it",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.5.2",
+    "@tresjs/cientos": "^2.1.3",
+    "@tresjs/core": "^2.1.2",
+    "@tresjs/post-processing": "^0.2.0",
+    "@types/three": "^0.152.1",
+    "pkg-types": "^1.0.3",
+    "three": "^0.153.0"
+  },
+  "devDependencies": {
+    "@nuxt/eslint-config": "^0.1.1",
+    "@nuxt/module-builder": "^0.4.0",
+    "@nuxt/schema": "^3.5.2",
+    "@nuxt/test-utils": "^3.5.1",
+    "@release-it/conventional-changelog": "^5.1.1",
+    "@types/node": "^18",
+    "changelogen": "^0.5.3",
+    "eslint": "^8.42.0",
+    "nuxt": "^3.5.1",
+    "playwright": "^1.35.0",
+    "release-it": "^15.11.0",
+    "vitest": "^0.31.4"
+  }
+}