@needle-tools/engine 3.28.7-beta → 3.28.7-beta.1

package/plugins/next/next.js

@@ -1,70 +1,70 @@
-import { fileURLToPath } from 'url';
-import { dirname, resolve } from 'path';
-import { tryGetNeedleEngineVersion } from '../common/version.js';
-import { tryGetGenerator } from '../common/generator.js';
-import { getMeta } from '../common/config.cjs';
-// import { ApplyLicensePlugin } from './license.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-
-/** Pass a nextConfig object in to add the needle specific settings. 
- * Optionally omit nextConfig and it will be created for you.
- * @param {import('next').NextConfig} nextConfig
- * @param {import('../types').userSettings} userSettings
- * @returns {import('next').NextConfig}
- */
-export const needleNext = (nextConfig, userSettings) => {
-    if (!nextConfig) nextConfig = {
-        reactStrictMode: true,
-    };
-
-    // add transpile packages
-    if (!nextConfig.transpilePackages) {
-        nextConfig.transpilePackages = [];
-    }
-    nextConfig.transpilePackages.push("three", "peerjs", "@needle-tools/engine", "three-mesh-ui");
-
-    // add webpack config
-    if (!nextConfig.webpack) nextConfig.webpack = nextWebPack;
-    else {
-        const webpackFn = nextConfig.webpack;
-        nextConfig.webpack = (config, { buildId, dev, isServer, defaultLoaders, webpack }) => {
-            nextWebPack(config, { buildId, dev, isServer, defaultLoaders, webpack });
-            return webpackFn(config, { buildId, dev, isServer, defaultLoaders, webpack });
-        }
-    }
-    /** @param {import ('next').NextConfig config } */
-    function nextWebPack(config, { buildId, dev, isServer, defaultLoaders, webpack }) {
-        const meta = getMeta();
-        let useRapier = true;
-        if (userSettings.useRapier === false) useRapier = false;
-        else if (meta.useRapier === false) useRapier = false;
-        // add defines
-        const webpackModule = userSettings.modules?.webpack;
-        const definePlugin = webpackModule && new webpackModule.DefinePlugin({
-            NEEDLE_ENGINE_VERSION: JSON.stringify(tryGetNeedleEngineVersion() ?? "0.0.0"),
-            NEEDLE_ENGINE_GENERATOR: JSON.stringify(tryGetGenerator() ?? "unknown"),
-            NEEDLE_USE_RAPIER: JSON.stringify(useRapier),
-            // TODO globalThis is not solved via DefinePlugin
-            parcelRequire: undefined,
-        });
-        if (!definePlugin) console.log("WARN: no define plugin provided. Did you miss adding the webpack module to the next config? You can pass it to the Needle plugins via `nextConfig.modules = { webpack };`");
-        else
-            config.plugins.push(definePlugin);
-
-        if (!config.module) config.module = {};
-        if (!config.module.rules) config.module.rules = [];
-        // add license plugin
-        config.module.rules.push({
-            test: /engine_license\.(ts|js)$/,
-            loader: resolve(__dirname, 'license.cjs')
-        });
-
-        return config;
-    }
-
-
-    return nextConfig;
-};
+import { fileURLToPath } from 'url';
+import { dirname, resolve } from 'path';
+import { tryGetNeedleEngineVersion } from '../common/version.js';
+import { tryGetGenerator } from '../common/generator.js';
+import { getMeta } from '../common/config.cjs';
+// import { ApplyLicensePlugin } from './license.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+
+/** Pass a nextConfig object in to add the needle specific settings. 
+ * Optionally omit nextConfig and it will be created for you.
+ * @param {import('next').NextConfig} nextConfig
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('next').NextConfig}
+ */
+export const needleNext = (nextConfig, userSettings) => {
+    if (!nextConfig) nextConfig = {
+        reactStrictMode: true,
+    };
+
+    // add transpile packages
+    if (!nextConfig.transpilePackages) {
+        nextConfig.transpilePackages = [];
+    }
+    nextConfig.transpilePackages.push("three", "peerjs", "@needle-tools/engine", "three-mesh-ui");
+
+    // add webpack config
+    if (!nextConfig.webpack) nextConfig.webpack = nextWebPack;
+    else {
+        const webpackFn = nextConfig.webpack;
+        nextConfig.webpack = (config, { buildId, dev, isServer, defaultLoaders, webpack }) => {
+            nextWebPack(config, { buildId, dev, isServer, defaultLoaders, webpack });
+            return webpackFn(config, { buildId, dev, isServer, defaultLoaders, webpack });
+        }
+    }
+    /** @param {import ('next').NextConfig config } */
+    function nextWebPack(config, { buildId, dev, isServer, defaultLoaders, webpack }) {
+        const meta = getMeta();
+        let useRapier = true;
+        if (userSettings.useRapier === false) useRapier = false;
+        else if (meta.useRapier === false) useRapier = false;
+        // add defines
+        const webpackModule = userSettings.modules?.webpack;
+        const definePlugin = webpackModule && new webpackModule.DefinePlugin({
+            NEEDLE_ENGINE_VERSION: JSON.stringify(tryGetNeedleEngineVersion() ?? "0.0.0"),
+            NEEDLE_ENGINE_GENERATOR: JSON.stringify(tryGetGenerator() ?? "unknown"),
+            NEEDLE_USE_RAPIER: JSON.stringify(useRapier),
+            // TODO globalThis is not solved via DefinePlugin
+            parcelRequire: undefined,
+        });
+        if (!definePlugin) console.log("WARN: no define plugin provided. Did you miss adding the webpack module to the next config? You can pass it to the Needle plugins via `nextConfig.modules = { webpack };`");
+        else
+            config.plugins.push(definePlugin);
+
+        if (!config.module) config.module = {};
+        if (!config.module.rules) config.module.rules = [];
+        // add license plugin
+        config.module.rules.push({
+            test: /engine_license\.(ts|js)$/,
+            loader: resolve(__dirname, 'license.cjs')
+        });
+
+        return config;
+    }
+
+
+    return nextConfig;
+};

package/plugins/types/index.d.ts

@@ -1,2 +1,2 @@
-export * from './userconfig';
+export * from './userconfig';
 export * from "./needleConfig";

package/plugins/types/needleConfig.d.ts

@@ -1,22 +1,22 @@
-export type needleMeta = {
-    needleEditor: string | null,
-    meta: string | null;
-    absolutePath: string | null,
-    sceneName: string | null,
-    deployOnly: boolean,
-    generator: string | null,
-    gzip: boolean,
-    allowHotReload: boolean,
-    license: string | null,
-    useRapier: boolean,
-}
-
-
-/** The content of the needle.config.json in the project directory */
-export type needleConfig = {
-    baseUrL?: string;
-    buildDirectory?: string;
-    assetsDirectory?: string;
-    scriptsDirectory?: string;
-    codegenDirectory?: string;
+export type needleMeta = {
+    needleEditor: string | null,
+    meta: string | null;
+    absolutePath: string | null,
+    sceneName: string | null,
+    deployOnly: boolean,
+    generator: string | null,
+    gzip: boolean,
+    allowHotReload: boolean,
+    license: string | null,
+    useRapier: boolean,
+}
+
+
+/** The content of the needle.config.json in the project directory */
+export type needleConfig = {
+    baseUrL?: string;
+    buildDirectory?: string;
+    assetsDirectory?: string;
+    scriptsDirectory?: string;
+    codegenDirectory?: string;
 }

package/plugins/types/userconfig.d.ts

@@ -1,42 +1,42 @@
-
-
-export type needleModules = {
-    webpack: object | undefined
-}
-
-export type userSettings = {
-    /** disable vite.alias modification */
-    noAlias: boolean;
-    /** disable automatic copying of files to include and output directory (dist) */
-    noCopy: boolean;
-    /** set to false to tree-shake rapier physics engine to the reduce bundle size */
-    useRapier: boolean;
-    noDependencyWatcher: boolean;
-    /** set to false to suppress editor-sync package installation and connection */
-    dontInstallEditor: boolean;
-    /** set to false to prevent meta.html modifications (vite only) */
-    allowMetaPlugin: boolean;
-    /** set to true to prevent injecting peerjs `parcelRequire` global variable declaration */
-    noPeer: boolean;
-    /** set to true to disable reload plugin */
-    noReload: boolean;
-    noCodegenTransform: boolean;
-    noFacebookInstantGames: boolean;
-    /** Set to true to create an imports.log file that shows all module imports. The file is generated when stopping the server. */
-    logModuleImportChains: boolean;
-
-    /** required for @serializable https://github.com/vitejs/vite/issues/13736 */
-    vite44Hack: boolean;
-
-    /** set to true to disable poster generation */
-    noPoster?: boolean;
-    // posterFormat?: "image/webp";// | "image/png";
-    /** 
-     * Use "default" to always generate the poster after 'src' has changed
-     * Use "once" to generate the poster only once, when no poster already exists
-    */
-    posterGenerationMode?: "default" | "once";
-
-    /** used by nextjs config to forward the webpack module */
-    modules: needleModules
-}
+
+
+export type needleModules = {
+    webpack: object | undefined
+}
+
+export type userSettings = {
+    /** disable vite.alias modification */
+    noAlias: boolean;
+    /** disable automatic copying of files to include and output directory (dist) */
+    noCopy: boolean;
+    /** set to false to tree-shake rapier physics engine to the reduce bundle size */
+    useRapier: boolean;
+    noDependencyWatcher: boolean;
+    /** set to false to suppress editor-sync package installation and connection */
+    dontInstallEditor: boolean;
+    /** set to false to prevent meta.html modifications (vite only) */
+    allowMetaPlugin: boolean;
+    /** set to true to prevent injecting peerjs `parcelRequire` global variable declaration */
+    noPeer: boolean;
+    /** set to true to disable reload plugin */
+    noReload: boolean;
+    noCodegenTransform: boolean;
+    noFacebookInstantGames: boolean;
+    /** Set to true to create an imports.log file that shows all module imports. The file is generated when stopping the server. */
+    logModuleImportChains: boolean;
+
+    /** required for @serializable https://github.com/vitejs/vite/issues/13736 */
+    vite44Hack: boolean;
+
+    /** set to true to disable poster generation */
+    noPoster?: boolean;
+    // posterFormat?: "image/webp";// | "image/png";
+    /** 
+     * Use "default" to always generate the poster after 'src' has changed
+     * Use "once" to generate the poster only once, when no poster already exists
+    */
+    posterGenerationMode?: "default" | "once";
+
+    /** used by nextjs config to forward the webpack module */
+    modules: needleModules
+}

package/plugins/vite/alias.js

@@ -1,70 +1,70 @@
-import { existsSync } from 'fs';
-import path from 'path';
-
-const projectDir = process.cwd() + "/";
-
-/** these are alias callbacks as in the vite.alias dictionary
- * the first argument is the already resoled absolute path (it is only invoked if the path was found in node_modules)
- * the 2,3,4 args are the same as in vite.alias (packageName, index, path);
- */
-const packages_to_resolve = {
-    // Handle all previous imports where users did import using @needle-engine/src
-    '@needle-tools/engine/src': (res, packageName, index, path) => {
-        return res + "/../lib";
-    },
-    '@needle-tools/engine': (res, packageName, index, path) => {
-        // Check if the import is something like @needle-tools/engine/engine/engine_utils
-        // in which case we want to resolve into the lib directory
-        if (path.startsWith("@needle-tools/engine/engine")) {
-            return res + "/lib";
-        }
-    },
-    'three': null,
-    'peerjs': null,
-    'websocket-ts': null,
-    'md5': null,
-}
-
-/**
- * @param {import('../types').userSettings} userSettings
- */
-export const needleViteAlias = (command, config, userSettings) => {
-
-    if (config?.noAlias === true || userSettings?.noAlias === true)
-        return;
-
-    return {
-        name: "needle-alias",
-        config(config) {
-            console.log('[needle-alias] ProjectDirectory: ' + projectDir);
-            if (!config.resolve) config.resolve = {};
-            if (!config.resolve.alias) config.resolve.alias = {};
-            const aliasDict = config.resolve.alias;
-            for (const name in packages_to_resolve) {
-                if (!aliasDict[name]) {
-                    addPathResolver(name, aliasDict, packages_to_resolve[name]);
-                }
-            }
-        }
-    }
-
-    function addPathResolver(name, aliasDict, cb) {
-        // If a package at the node_modules path exist we resolve the request there
-        // introduced in 89a50718c38940abb99ee16c5e029065e41d7d65
-        const res = path.resolve(projectDir, 'node_modules', name);
-        if (typeof cb !== "function") cb = null;
-        const isDevEnvironment = process.env.NODE_ENV === "development";
-        if (existsSync(res)) {
-            aliasDict[name] = (packageName, index, path) => {
-                if (cb !== null && !isDevEnvironment) {
-                    const overrideResult = cb(res, packageName, index, path);
-                    if (overrideResult !== undefined)
-                        if (existsSync(overrideResult)) {
-                            return overrideResult;
-                        }
-                }
-                return res;
-            }
-        }
-    }
-};
+import { existsSync } from 'fs';
+import path from 'path';
+
+const projectDir = process.cwd() + "/";
+
+/** these are alias callbacks as in the vite.alias dictionary
+ * the first argument is the already resoled absolute path (it is only invoked if the path was found in node_modules)
+ * the 2,3,4 args are the same as in vite.alias (packageName, index, path);
+ */
+const packages_to_resolve = {
+    // Handle all previous imports where users did import using @needle-engine/src
+    '@needle-tools/engine/src': (res, packageName, index, path) => {
+        return res + "/../lib";
+    },
+    '@needle-tools/engine': (res, packageName, index, path) => {
+        // Check if the import is something like @needle-tools/engine/engine/engine_utils
+        // in which case we want to resolve into the lib directory
+        if (path.startsWith("@needle-tools/engine/engine")) {
+            return res + "/lib";
+        }
+    },
+    'three': null,
+    'peerjs': null,
+    'websocket-ts': null,
+    'md5': null,
+}
+
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
+export const needleViteAlias = (command, config, userSettings) => {
+
+    if (config?.noAlias === true || userSettings?.noAlias === true)
+        return;
+
+    return {
+        name: "needle-alias",
+        config(config) {
+            console.log('[needle-alias] ProjectDirectory: ' + projectDir);
+            if (!config.resolve) config.resolve = {};
+            if (!config.resolve.alias) config.resolve.alias = {};
+            const aliasDict = config.resolve.alias;
+            for (const name in packages_to_resolve) {
+                if (!aliasDict[name]) {
+                    addPathResolver(name, aliasDict, packages_to_resolve[name]);
+                }
+            }
+        }
+    }
+
+    function addPathResolver(name, aliasDict, cb) {
+        // If a package at the node_modules path exist we resolve the request there
+        // introduced in 89a50718c38940abb99ee16c5e029065e41d7d65
+        const res = path.resolve(projectDir, 'node_modules', name);
+        if (typeof cb !== "function") cb = null;
+        const isDevEnvironment = process.env.NODE_ENV === "development";
+        if (existsSync(res)) {
+            aliasDict[name] = (packageName, index, path) => {
+                if (cb !== null && !isDevEnvironment) {
+                    const overrideResult = cb(res, packageName, index, path);
+                    if (overrideResult !== undefined)
+                        if (existsSync(overrideResult)) {
+                            return overrideResult;
+                        }
+                }
+                return res;
+            }
+        }
+    }
+};

package/plugins/vite/build.js

@@ -1,20 +1,20 @@
-
-export const needleBuild = (command, config, userSettings) => {
-
-    // TODO: need to set this when building a dist
-    const isDeployOnlyBuild = config?.deployOnly === true;
-
-    return {
-        name: 'needle-build',
-        config(config) {
-            if (!config.build) {
-                config.build = {};
-            }
-            if (isDeployOnlyBuild)
-            {
-                console.log("Deploy only build - will not empty output directory")
-                config.build.emptyOutDir = false;
-            }
-        }
-    }
+
+export const needleBuild = (command, config, userSettings) => {
+
+    // TODO: need to set this when building a dist
+    const isDeployOnlyBuild = config?.deployOnly === true;
+
+    return {
+        name: 'needle-build',
+        config(config) {
+            if (!config.build) {
+                config.build = {};
+            }
+            if (isDeployOnlyBuild)
+            {
+                console.log("Deploy only build - will not empty output directory")
+                config.build.emptyOutDir = false;
+            }
+        }
+    }
 }

package/plugins/vite/config.js

@@ -1,74 +1,74 @@
-import { existsSync, readFileSync } from 'fs';
-
-let didLogCanNotFindConfig = false;
-
-/**  the codegen meta file
- * @returns {import("../types/needleConfig").needleMeta | null}
- */
-export async function loadConfig(path) {
-    try {
-        // First try to get the path from the config
-        if (!path) {
-            const configJson = tryLoadProjectConfig();
-            if (configJson?.codegenDirectory) {
-                path = configJson.codegenDirectory + "/meta.json";
-            }
-        }
-        // If that fails, try the default path
-        if (!path)
-            path = './src/generated/meta.json';
-
-        if (existsSync(path)) {
-            const text = readFileSync(path, 'utf8');
-            if (!text) return null;
-            /**@type {import("../types/needleConfig").needleMeta} */
-            const meta = JSON.parse(text);
-            return meta;
-        }
-        else {
-            if(!didLogCanNotFindConfig){
-                didLogCanNotFindConfig = true;
-                console.error("Could not find config file at " + path);
-            }
-        }
-        return null;
-    }
-    catch (err) {
-        console.error("Error loading config file");
-        console.error(err);
-        return null;
-    }
-}
-
-/** get the needle.config.json
- * @returns {import("../types/needleConfig").needleConfig | null}
- */
-export function tryLoadProjectConfig() {
-    try {
-        const root = process.cwd();
-        const path = root + '/needle.config.json';
-        if (existsSync(path)) {
-            const text = readFileSync(path);
-            if (!text) return null;
-            const json = JSON.parse(text);
-            return json;
-        }
-    }
-    catch (err) {
-        console.error("Error loading config file");
-        console.error(err);
-    }
-
-    return null;
-}
-
-
-/** "assets" -> the directory name inside the output directory to put e.g. glb files into */
-export function builtAssetsDirectory() {
-    return "assets";
-}
-
-export function getOutputDirectory() {
-    const projectConfig = tryLoadProjectConfig();
-    return process.cwd() + "/" + (projectConfig?.buildDirectory || "dist");
+import { existsSync, readFileSync } from 'fs';
+
+let didLogCanNotFindConfig = false;
+
+/**  the codegen meta file
+ * @returns {import("../types/needleConfig").needleMeta | null}
+ */
+export async function loadConfig(path) {
+    try {
+        // First try to get the path from the config
+        if (!path) {
+            const configJson = tryLoadProjectConfig();
+            if (configJson?.codegenDirectory) {
+                path = configJson.codegenDirectory + "/meta.json";
+            }
+        }
+        // If that fails, try the default path
+        if (!path)
+            path = './src/generated/meta.json';
+
+        if (existsSync(path)) {
+            const text = readFileSync(path, 'utf8');
+            if (!text) return null;
+            /**@type {import("../types/needleConfig").needleMeta} */
+            const meta = JSON.parse(text);
+            return meta;
+        }
+        else {
+            if(!didLogCanNotFindConfig){
+                didLogCanNotFindConfig = true;
+                console.error("Could not find config file at " + path);
+            }
+        }
+        return null;
+    }
+    catch (err) {
+        console.error("Error loading config file");
+        console.error(err);
+        return null;
+    }
+}
+
+/** get the needle.config.json
+ * @returns {import("../types/needleConfig").needleConfig | null}
+ */
+export function tryLoadProjectConfig() {
+    try {
+        const root = process.cwd();
+        const path = root + '/needle.config.json';
+        if (existsSync(path)) {
+            const text = readFileSync(path);
+            if (!text) return null;
+            const json = JSON.parse(text);
+            return json;
+        }
+    }
+    catch (err) {
+        console.error("Error loading config file");
+        console.error(err);
+    }
+
+    return null;
+}
+
+
+/** "assets" -> the directory name inside the output directory to put e.g. glb files into */
+export function builtAssetsDirectory() {
+    return "assets";
+}
+
+export function getOutputDirectory() {
+    const projectConfig = tryLoadProjectConfig();
+    return process.cwd() + "/" + (projectConfig?.buildDirectory || "dist");
 }