@needle-tools/engine/plugins/vite/defines.js

Needle Engine is a web-based runtime for 3D apps. It runs on your machine for development with great integrations into editors like Unity or Blender - and can be deployed onto any device! It is flexible, extensible and networking and XR are built-in.

import { loadConfig } from "./config.js";
import { tryGetNeedleEngineVersion } from "../common/version.js";
import { getPublicIdentifier as getPublicIdentifier } from "../common/license.js";
import { needleLog } from "./logging.js";

// NOTE: ALL DEFINES MUST BE SET HERE! NEVER ADD OR RELY ON DEFINES IN ANY OTHER PLUGIN

/** used to pass config variables into vite.config.define
 * for example "useRapier"
 */

// https://vitejs.dev/config/#using-environment-variables-in-config

/**
 * @param {"build" | "serve"} command
 * @param {import('../types/needleConfig').needleMeta | null | undefined} needleEngineConfig
 * @param {import('../types').userSettings} userSettings
 * @returns {import('vite').Plugin}
 */
export function needleDefines(command, needleEngineConfig, userSettings) {

    if (!userSettings) userSettings = {};

    let useRapier = true;
    if (needleEngineConfig?.useRapier === false || userSettings?.useRapier === false) useRapier = false;

    let usePostProcessing = true;
    if (userSettings.usePostprocessing === false) {
        usePostProcessing = false;
    }

    return {
        name: 'needle:defines',
        enforce: 'pre',
        async config(/** @type {{ define?: Record<string, unknown> }} */ viteConfig) {
            // console.log("Update vite defines -------------------------------------------");
            if (!viteConfig.define) viteConfig.define = {};
            const version = tryGetNeedleEngineVersion();
            needleLog("needle-defines", "Needle Engine Version: " + version + " " + (needleEngineConfig?.generator ?? "(unknown generator)"));
            if (version)
                viteConfig.define.NEEDLE_ENGINE_VERSION = "\"" + version + "\"";
            if (needleEngineConfig)
                viteConfig.define.NEEDLE_ENGINE_GENERATOR = "\"" + needleEngineConfig.generator + "\"";

            if (useRapier && userSettings?.useRapier !== true) {
                const meta = await loadConfig();
                if (meta && meta.useRapier === false) {
                    useRapier = false;
                }
            }
            // console.log("UseRapier?", useRapier);
            if (viteConfig.define.NEEDLE_USE_RAPIER === undefined) {
                viteConfig.define.NEEDLE_USE_RAPIER = useRapier;
            }

            // TODO: this doesn't make postprocessing optional yet
            if (viteConfig.define.NEEDLE_USE_POSTPROCESSING === undefined) {
                viteConfig.define.NEEDLE_USE_POSTPROCESSING = usePostProcessing;
            }

            // this gives a timestamp containing the timezone
            viteConfig.define.NEEDLE_PROJECT_BUILD_TIME = "\"" + new Date().toString() + "\"";

            const projectId = /** @type {string | undefined} */ (undefined); // TODO: this needs to be exported by the integration (if any)
            const publicIdentifier = await getPublicIdentifier(projectId, {
                loglevel: userSettings?.debugLicense === true ? "verbose" : undefined,
            }).catch((/** @type {{ message?: string }} */ err) => {
                needleLog("needle-defines", "Failed to get public identifier: " + err.message, "warn");
            });
            if (publicIdentifier) {
                viteConfig.define.NEEDLE_PUBLIC_KEY = "\"" + publicIdentifier + "\"";
            }
        }
    }
}