@needle-tools/engine 4.16.0 → 4.16.1-next.ad85c25

package/plugins/vite/local-files-analysis.d.ts

@@ -0,0 +1,95 @@
+/**
+ * @param {"build" | "serve"} command
+ * @param {unknown} _config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
+ */
+export function needleLocalFilesSceneAnalysis(command: "build" | "serve", _config: unknown, userSettings: import("../types").userSettings): import("vite").Plugin | null;
+/**
+ * @param {string} projectDir
+ * @returns {AutoPolicy | null}
+ */
+export function getLocalFilesAutoPolicy(projectDir: string): AutoPolicy | null;
+/**
+ * @param {import('../types').userSettings | undefined | null} userSettings
+ * @returns {boolean}
+ */
+export function makeFilesLocalIsEnabled(userSettings: import("../types").userSettings | undefined | null): boolean;
+/**
+ * @param {import('../types').userSettings | undefined | null} userSettings
+ * @returns {LocalizationOptions}
+ */
+export function resolveOptions(userSettings: import("../types").userSettings | undefined | null): LocalizationOptions;
+/**
+ * @param {string | string[] | undefined} features
+ * @returns {boolean}
+ */
+export function hasAutoFeatureSelection(features: string | string[] | undefined): boolean;
+/**
+ * @param {LocalizationOptions} options
+ * @param {string} projectDir
+ * @returns {AutoPolicy | null}
+ */
+export function buildAutoPolicy(options: LocalizationOptions, projectDir: string): AutoPolicy | null;
+/**
+ * @param {string} projectDir
+ * @param {LocalizationOptions} options
+ * @param {SceneAnalysisReport | null} [cachedAnalysis]
+ * @returns {AutoPolicy}
+ */
+export function detectAutoPolicy(projectDir: string, options: LocalizationOptions, cachedAnalysis?: SceneAnalysisReport | null): AutoPolicy;
+/**
+ * @param {string} projectDir
+ * @returns {SceneAnalysisReport}
+ */
+export function analyzeProjectGlbs(projectDir: string): SceneAnalysisReport;
+/**
+ * @param {string} projectDir
+ * @returns {string[]}
+ */
+export function collectAssetGlbs(projectDir: string): string[];
+/**
+ * @param {string} filePath
+ * @returns {Record<string, unknown>}
+ */
+export function readGlbJsonChunk(filePath: string): Record<string, unknown>;
+/**
+ * @param {unknown} json
+ * @returns {string[]}
+ */
+export function collectNeedleComponentExtensionBlobs(json: unknown): string[];
+/**
+ * @param {string} indexHtml
+ * @returns {Set<string>}
+ */
+export function collectIndexHtmlSkyboxUrls(indexHtml: string): Set<string>;
+/**
+ * @param {string | string[] | undefined | null} skyboxOption
+ * @param {Set<string>} indexSkyboxUrls
+ * @returns {Set<string> | null}
+ */
+export function resolveSkyboxSelectionUrls(skyboxOption: string | string[] | undefined | null, indexSkyboxUrls: Set<string>): Set<string> | null;
+/**
+ * @param {string | null | undefined} value
+ * @returns {string | null}
+ */
+export function resolveSkyboxValueToUrl(value: string | null | undefined): string | null;
+/**
+ * @param {string | undefined} mode
+ * @returns {string[]}
+ */
+export function getWebXRProfilesForMode(mode: string | undefined): string[];
+/**
+ * @param {string} url
+ * @param {UrlHandler} handler
+ * @param {LocalizationContext} context
+ * @returns {boolean}
+ */
+export function shouldHandleUrlInAutoMode(url: string, handler: UrlHandler, context: LocalizationContext): boolean;
+export const SKYBOX_MAGIC_KEYWORDS: string[];
+export type LocalizationOptions = import("./local-files-types.js").LocalizationOptions;
+export type AutoPolicy = import("./local-files-types.js").AutoPolicy;
+export type SceneAnalysisReport = import("./local-files-types.js").SceneAnalysisReport;
+export type SceneFile = import("./local-files-types.js").SceneFile;
+export type UrlHandler = import("./local-files-types.js").UrlHandler;
+export type LocalizationContext = import("./local-files-types.js").LocalizationContext;

package/plugins/vite/local-files-analysis.js

@@ -19,9 +19,10 @@ const HLS_CDN_SEGMENT = "/npm/hls.js@";
 const analysisByProject = new Map();
 
 /**
- * @param {string} command
+ * @param {"build" | "serve"} command
  * @param {unknown} _config
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
  */
 export function needleLocalFilesSceneAnalysis(command, _config, userSettings) {
     if (!makeFilesLocalIsEnabled(userSettings)) return null;

package/plugins/vite/local-files-core.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @param {"build" | "serve"} command
+ * @param {unknown} _config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
+ */
+export function needleMakeFilesLocal(command: "build" | "serve", _config: unknown, userSettings: import("../types").userSettings): import("vite").Plugin | null;
+/**
+ * @param {LocalizationOptions} options
+ * @param {AutoPolicy | null} autoPolicy
+ * @returns {UrlHandler[]}
+ */
+export function getActiveHandlers(options: LocalizationOptions, autoPolicy: AutoPolicy | null): UrlHandler[];
+/**
+ * @param {string} src
+ * @param {string} basePath
+ * @param {string} currentDir
+ * @param {LocalizationContext} context
+ * @param {UrlHandler[]} [handlers]
+ * @returns {Promise<string>}
+ */
+export function makeLocal(src: string, basePath: string, currentDir: string, context: LocalizationContext, handlers?: UrlHandler[]): Promise<string>;
+/**
+ * @param {string} html
+ * @param {string} basePath
+ * @param {LocalizationContext} context
+ * @param {UrlHandler[]} [handlers]
+ * @returns {Promise<string>}
+ */
+export function makeLocalHtml(html: string, basePath: string, context: LocalizationContext, handlers?: UrlHandler[]): Promise<string>;
+/**
+ * @param {string} basePath
+ * @param {string} feature
+ * @returns {string}
+ */
+export function getFeatureBasePath(basePath: string, feature: string): string;
+/**
+ * @param {string} baseUrl
+ * @param {string} basePath
+ * @param {string} currentDir
+ * @param {LocalizationContext} context
+ * @returns {Promise<string>}
+ */
+export function handleWebXRProfiles(baseUrl: string, basePath: string, currentDir: string, context: LocalizationContext): Promise<string>;
+export { makeFilesLocalIsEnabled };
+export type LocalizationContext = import("./local-files-types.js").LocalizationContext;
+export type LocalizationOptions = import("./local-files-types.js").LocalizationOptions;
+export type LocalizationStats = import("./local-files-types.js").LocalizationStats;
+export type AutoPolicy = import("./local-files-types.js").AutoPolicy;
+export type UrlHandler = import("./local-files-types.js").UrlHandler;
+import { makeFilesLocalIsEnabled } from './local-files-analysis.js';

package/plugins/vite/local-files-core.js

@@ -213,7 +213,7 @@ function recordLocalizedAsset(stats, url, sizeBytes, mimeType) {
  * @param {import('../types').userSettings} userSettings
  * @returns {import('vite').Plugin | null}
  */
-export const needleMakeFilesLocal = (command, _config, userSettings) => {
+export function needleMakeFilesLocal(command, _config, userSettings) {
     if (!makeFilesLocalIsEnabled(userSettings)) {
         return null;
     }
@@ -373,7 +373,7 @@ export const needleMakeFilesLocal = (command, _config, userSettings) => {
         }
     });
     return plugin;
-};
+}
 
 /**
  * @param {LocalizationOptions} options

package/plugins/vite/local-files-internals.d.ts

@@ -0,0 +1,3 @@
+export { getActiveHandlers, getFeatureBasePath, handleWebXRProfiles, makeLocal, makeLocalHtml } from "./local-files-core.js";
+export { analyzeProjectGlbs, buildAutoPolicy, collectAssetGlbs, collectIndexHtmlSkyboxUrls, collectNeedleComponentExtensionBlobs, detectAutoPolicy, getWebXRProfilesForMode, hasAutoFeatureSelection, readGlbJsonChunk, resolveSkyboxSelectionUrls, resolveSkyboxValueToUrl, shouldHandleUrlInAutoMode } from "./local-files-analysis.js";
+export { fixDracoRangeQueryProbe, fixRelativeNewURL, getRelativeToBasePath } from "./local-files-utils.js";

package/plugins/vite/local-files-utils.d.ts

@@ -0,0 +1,77 @@
+export function finishMakeLocalProgress(): void;
+/**
+ * @param {string} src
+ * @param {string} search
+ * @param {string} replacement
+ * @returns {string}
+ */
+export function replaceAll(src: string, search: string, replacement: string): string;
+/**
+ * @param {string} path
+ * @param {string} basePath
+ * @returns {string}
+ */
+export function getRelativeToBasePath(path: string, basePath: string): string;
+/**
+ * @param {string} path
+ * @returns {string}
+ */
+export function normalizeWebPath(path: string): string;
+/**
+ * @param {string} path
+ * @returns {string}
+ */
+export function ensureTrailingSlash(path: string): string;
+/**
+ * @param {string} src
+ * @returns {string}
+ */
+export function fixRelativeNewURL(src: string): string;
+/**
+ * @param {string} src
+ * @returns {string}
+ */
+export function fixDracoRangeQueryProbe(src: string): string;
+/**
+ * @param {string} path
+ * @param {string|Buffer} content
+ * @returns {string}
+ */
+export function getValidFilename(path: string, content: string | Buffer): string;
+/**
+ * @param {string} url
+ * @returns {Promise<string>}
+ */
+export function downloadText(url: string): Promise<string>;
+/**
+ * @param {string} url
+ * @returns {Promise<Buffer>}
+ */
+export function downloadBinary(url: string): Promise<Buffer>;
+/**
+ * @param {LocalizationContext} context
+ * @param {string} url
+ * @param {unknown} err
+ */
+export function recordFailedDownload(context: LocalizationContext, url: string, err: unknown): void;
+/**
+ * @param {string} url
+ * @returns {string}
+ */
+export function getShortUrlName(url: string): string;
+export class Cache {
+    /** @type {Map<string, Buffer|string>} */
+    __cache: Map<string, Buffer | string>;
+    /**
+     * @param {string} key
+     * @param {Buffer|string} value
+     */
+    addToCache(key: string, value: Buffer | string): void;
+    /**
+     * @param {string} key
+     * @returns {Buffer|string|null}
+     */
+    getFromCache(key: string): Buffer | string | null;
+    get map(): Map<string, string | Buffer<ArrayBufferLike>>;
+}
+export type LocalizationContext = import("./local-files-types.js").LocalizationContext;

package/plugins/vite/local-files.d.ts

@@ -0,0 +1,2 @@
+export { needleLocalFilesSceneAnalysis } from "./local-files-analysis.js";
+export { needleMakeFilesLocal, makeFilesLocalIsEnabled } from "./local-files-core.js";

package/plugins/vite/logger.d.ts

@@ -0,0 +1,8 @@
+/**
+ * write logs to local file
+ * @param {string} command
+ * @param {unknown} _config
+ * @param {import('../types/userconfig.js').userSettings} userSettings
+ * @returns {import('vite').Plugin | null}
+ */
+export function needleLogger(command: string, _config: unknown, userSettings: import("../types/userconfig.js").userSettings): import("vite").Plugin | null;

package/plugins/vite/logger.js

@@ -15,7 +15,7 @@ const __dirname = path.dirname(__filename);
  * @param {import('../types/userconfig.js').userSettings} userSettings
  * @returns {import('vite').Plugin | null}
  */
-export const needleLogger = (command, _config, userSettings) => {
+export function needleLogger(command, _config, userSettings) {
 
     if (userSettings?.disableLogging === true) {
         return null;

package/plugins/vite/logging.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Resets the sticky-header state so the next needleLog call always emits its
+ * [plugin-name] header. Call this at the start of a new build or any logical
+ * output section where you want a guaranteed fresh header.
+ */
+export function resetLastLoggedPlugin(): void;
+/**
+ * @param {string} pluginName
+ * @param {string | string[]} message
+ * @param {'log' | 'warn' | 'error'} [level='log']
+ * @param {{ dimBody?: boolean, leadingNewline?: boolean, showHeader?: boolean }} [options]
+ */
+export function needleLog(pluginName: string, message: string | string[], level?: "log" | "warn" | "error", options?: {
+    dimBody?: boolean;
+    leadingNewline?: boolean;
+    showHeader?: boolean;
+}): void;
+/**
+ * @param {string} pluginName
+ * @param {string[]} lines
+ * @param {'log' | 'warn' | 'error'} [level='log']
+ */
+export function needleLogLines(pluginName: string, lines: string[], level?: "log" | "warn" | "error"): void;
+export function needleSupportsColor(): boolean;
+export function needleBlue(text: any): string;
+export function needleDim(text: any): string;
+export function needleGreenBold(text: any): string;
+/**
+ * @param {(() => void) | null} cleaner
+ */
+export function setTransientLogLineCleaner(cleaner: (() => void) | null): void;

package/plugins/vite/meta.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin}
+ */
+export function needleMeta(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null, userSettings: import("../types").userSettings): import("vite").Plugin;

package/plugins/vite/meta.js

@@ -6,11 +6,12 @@ import { getPosterPath } from './poster.js';
 import { needleGreenBold, needleLog } from './logging.js';
 
 /**
- * @param {string} command
- * @param {import('../types').needleMeta | null} config
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null} config
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin}
  */
-export const needleMeta = (command, config, userSettings) => {
+export function needleMeta(command, config, userSettings) {
 
     // we can check if this is a build
     const isBuild = command === 'build';

package/plugins/vite/needle-app.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {'serve' | 'build'} command
+ * @param {{} | undefined | null} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin[] | null}
+ */
+export function needleApp(command: "serve" | "build", config: {} | undefined | null, userSettings: import("../types").userSettings): import("vite").Plugin[] | null;

package/plugins/vite/needle-app.js

@@ -10,7 +10,7 @@ import { needleLog } from './logging.js';
  * @param {import('../types').userSettings} userSettings
  * @returns {import('vite').Plugin[] | null}
  */
-export const needleApp = (command, config, userSettings) => {
+export function needleApp(command, config, userSettings) {
 
     if (command !== "build") {
         return null;

package/plugins/vite/npm.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
+export function needleNPM(command: any, config: any, userSettings: import("../types").userSettings): void;

package/plugins/vite/npm.js

@@ -3,6 +3,6 @@ import { ensureNpmDirectoryExists } from '../common/npm.js';
 /**
  * @param {import('../types').userSettings} userSettings
  */
-export const needleNPM = (command, config, userSettings) => {
+export function needleNPM(command, config, userSettings) {
     ensureNpmDirectoryExists();
 }

package/plugins/vite/peer.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import("vite").Plugin | undefined}
+ */
+export function needlePeerjs(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin | undefined;

package/plugins/vite/peer.js

@@ -2,10 +2,12 @@ const peerjsString = `/* needle: fix for peerjs */ window.global = window; var p
 import { needleLog } from './logging.js';
 
 /**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
  * @param {import('../types').userSettings} userSettings
  * @returns {import("vite").Plugin | undefined}
  */
-export const needlePeerjs = (command, config, userSettings) => {
+export function needlePeerjs(command, config, userSettings) {
 
     if (userSettings.noPeer === true) return;
 

package/plugins/vite/poster-client.d.ts

@@ -0,0 +1 @@
+export {};

package/plugins/vite/poster.d.ts

@@ -0,0 +1,8 @@
+export function getPosterPath(): string;
+/**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | undefined}
+ */
+export function needlePoster(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin | undefined;

package/plugins/vite/poster.js

@@ -10,9 +10,12 @@ export function getPosterPath() {
 }
 
 /**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | undefined}
  */
-export const needlePoster = (command, config, userSettings) => {
+export function needlePoster(command, config, userSettings) {
     // only relevant for local development
     if (command === 'build') return [];
 
@@ -76,4 +79,4 @@ export const needlePoster = (command, config, userSettings) => {
             },
         },
     }
-};
+}

package/plugins/vite/pwa.d.ts

@@ -0,0 +1,7 @@
+/** Provides reasonable defaults for a PWA manifest and workbox settings.
+ * @param {"build" | "serve"} command
+ * @param {import("../types/needleConfig").needleMeta | null} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | undefined}
+ */
+export function needlePWA(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null, userSettings: import("../types").userSettings): import("vite").Plugin | undefined;

package/plugins/vite/pwa.js

@@ -8,12 +8,12 @@ import { needleLog } from './logging.js';
 const pwaErrorWithInstructions = "It seems that you're trying to build a PWA using 'vite-plugin-pwa'!\nNeedle can manage PWA settings for you – just pass the same 'pwaOptions' to the needlePlugins and VitePWA plugins:\n\n1. Install the vite PWA plugin: npm install vite-plugin-pwa --save-dev\n\n2. Then update your vite.config.js:\n\n    import { VitePWA } from 'vite-plugin-pwa';\n    ...\n    needlePlugins(command, needleConfig, { pwa: pwaOptions }),\n    VitePWA(pwaOptions),\n\nIf you want to manage PWA building yourself and skip this check, please pass '{ pwa: false }' to needlePlugins.";
 
 /** Provides reasonable defaults for a PWA manifest and workbox settings.
- * @param {string} command
- * @param {import('../types').userSettings} userSettings
+ * @param {"build" | "serve"} command
  * @param {import("../types/needleConfig").needleMeta | null} config
- * @returns {import('vite').Plugin | void}
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | undefined}
  */
-export const needlePWA = (command, config, userSettings) => {
+export function needlePWA(command, config, userSettings) {
     // @ts-ignore // TODO correctly type the userSettings.pwaOptions object
     /** @type {import("vite-plugin-pwa").VitePWAOptions | false} */
     const pwaOptions = userSettings.pwa === true

package/plugins/vite/reload-client.d.ts

@@ -0,0 +1 @@
+export {};

package/plugins/vite/reload.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | undefined}
+ */
+export function needleReload(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null, userSettings: import("../types").userSettings): import("vite").Plugin | undefined;

package/plugins/vite/reload.js

@@ -16,10 +16,11 @@ let assetsDirectory = "";
 
 /**
  * @param {"build" | "serve"} command
- * @param {import('../types').userSettings | null} config
+ * @param {import('../types/needleConfig').needleMeta | null} config
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | undefined}
  */
-export const needleReload = (command, config, userSettings) => {
+export function needleReload(command, config, userSettings) {
     if (command === "build") return undefined;
 
     if (userSettings?.noReload === true) return undefined;
@@ -31,7 +32,7 @@ export const needleReload = (command, config, userSettings) => {
         isUpdatingConfig = true;
         const res = await loadConfig();
         isUpdatingConfig = false;
-        if (res) config = /** @type {import('../types').userSettings} */ (res);
+        if (res) config = /** @type {import('../types/needleConfig').needleMeta} */ (res);
     }
 
     const projectConfig = tryLoadProjectConfig();
@@ -61,7 +62,7 @@ export const needleReload = (command, config, userSettings) => {
             if (userSettings?.debug === true)
                 setTimeout(() => needleLog("needle-reload", "Updated server ignore patterns: " + JSON.stringify(config.server?.watch?.ignored)), 100);
         },
-        /** @param {{file: string, server: import('vite').ViteDevServer, modules: unknown[], read: (file?: string) => Promise<string>, buildDirectory?: string}} args */
+        /** @param {import('vite').HmrContext & {buildDirectory?: string}} args */
         handleHotUpdate(args) {
             args.buildDirectory = buildDirectory;
             return handleReload(args);
@@ -118,7 +119,7 @@ function notifyClientWillReload(server, file) {
 }
 
 /**
- * @param {{file: string, server: import('vite').ViteDevServer, modules: unknown[], read: (file?: string) => Promise<string>, buildDirectory?: string}} param0
+ * @param {import('vite').HmrContext & {buildDirectory?: string}} param0
  * @returns {Promise<any>}
  */
 async function handleReload({ file, server, modules: _modules, read, buildDirectory }) {
@@ -255,7 +256,7 @@ function getFileNameLog(file) {
 const hashes = new Map();
 const hash256 = crypto.createHash('sha256');
 
-/** @param {string} file @param {(file?: string) => Promise<string>} read @returns {Promise<boolean>} */
+/** @param {string} file @param {(file?: string) => string | Promise<string>} read @returns {Promise<boolean>} */
 async function testIfFileContentChanged(file, read) {
     let content = await read(file);
     content = removeVersionQueryArgument(content);

package/plugins/vite/server.d.ts

@@ -0,0 +1,7 @@
+/** Can open the network server in the browser.
+ * @param {"build" | "serve"} command
+ * @param {import('../types').needleMeta | null} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin}
+ */
+export function needleServer(command: "build" | "serve", config: import("../types").needleMeta | null, userSettings: import("../types").userSettings): import("vite").Plugin;

package/plugins/vite/server.js

@@ -1,10 +1,10 @@
-/**
- * Can open the network server in the browser
- * @param {string} command
+/** Can open the network server in the browser.
+ * @param {"build" | "serve"} command
  * @param {import('../types').needleMeta | null} config
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin}
  */
-export const needleServer = (command, config, userSettings) => {
+export function needleServer(command, config, userSettings) {
 
     const shouldOpenBrowser = userSettings.openBrowser === true;
 
@@ -64,4 +64,4 @@ export const needleServer = (command, config, userSettings) => {
             }
         },
     }
-};
+}

package/plugins/vite/transform-codegen.d.ts

@@ -0,0 +1,8 @@
+/** Modify the glb load path in codegen files.
+ * This is necessary if the assets directory is not the default (changed by the user in needle.config.json).
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | undefined}
+ */
+export function needleTransformCodegen(command: "build" | "serve", config: import("../types/needleConfig").needleMeta | null | undefined, userSettings: import("../types").userSettings): import("vite").Plugin | undefined;

package/plugins/vite/transform-codegen.js

@@ -1,11 +1,13 @@
 import { builtAssetsDirectory, tryLoadProjectConfig } from './config.js';
 
-/** 
- * modify the glb load path in codegen files
- * this is necessary if the assets directory is not the default (changed by the user in needle.config.json)
+/** Modify the glb load path in codegen files.
+ * This is necessary if the assets directory is not the default (changed by the user in needle.config.json).
+ * @param {"build" | "serve"} command
+ * @param {import('../types/needleConfig').needleMeta | null | undefined} config
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin | undefined}
  */
-export const needleTransformCodegen = (command, config, userSettings) => {
+export function needleTransformCodegen(command, config, userSettings) {
 
     if (config?.noCodegenTransform === true || userSettings?.noCodegenTransform === true) {
         return;

package/plugins/vite/transform.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin[]}
+ */
+export function needleTransformCode(command: any, config: any, userSettings: import("../types").userSettings): import("vite").Plugin[];

package/plugins/vite/transform.js

@@ -5,7 +5,7 @@
  * @param {import('../types').userSettings} userSettings
  * @returns {import('vite').Plugin[]}
  */
-export const needleTransformCode = (command, config, userSettings) => {
+export function needleTransformCode(command, config, userSettings) {
 
     return [
         {

package/plugins/vite/vite-4.4-hack.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Make sure we dont have vite 4.4.x installed when needle engine is used locally
+ * @param {import('../types').userSettings} userSettings
+ */
+export function vite_4_4_hack(command: any, config: any, userSettings: import("../types").userSettings): {
+    name: string;
+    configureServer(server: any): Promise<void>;
+};

package/plugins/vite/vite-4.4-hack.js

@@ -6,7 +6,7 @@ import { execSync } from 'child_process';
  * Make sure we dont have vite 4.4.x installed when needle engine is used locally
  * @param {import('../types').userSettings} userSettings
  */
-export const vite_4_4_hack = (command, config, userSettings) => {
+export function vite_4_4_hack(command, config, userSettings) {
     if (userSettings.vite44Hack === false) return;
     return {
         name: "needle-vite-4.4-hack",

package/src/engine/engine_context.ts

@@ -613,6 +613,7 @@ export class Context implements IContext {
 					console.log("Using canvas from shadow root", canvas);
 				}
 			}
+			else if(debug) console.warn("No canvas found in shadow root, creating new canvas. This may cause input events to not work correctly. To fix this, make sure to use the canvas provided by the Needle Engine Web Component (e.g. by using context.createNewRenderer() without parameters or passing the canvas from the shadow root explicitly).")
 		}
 		if (debug) console.log("Using Renderer Parameters:", params, this.domElement)