@prosopo/config 3.3.1 → 3.3.3

package/src/vite/vite-plugin-copy.ts

@@ -0,0 +1,67 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import fs from "node:fs";
+import path from "node:path";
+import fg from "fast-glob";
+import type { Plugin } from "vite";
+
+interface CopyPluginOptions {
+	srcDir: string;
+	destDir: string;
+	include?: string[]; // Optional: glob patterns for files to include
+	exclude?: string[]; // Optional: glob patterns for files to exclude
+}
+
+function ensureDirExists(filePath: string) {
+	const dir = path.dirname(filePath);
+	if (!fs.existsSync(dir)) {
+		fs.mkdirSync(dir, { recursive: true });
+	}
+}
+
+export default function VitePluginCopy(options: CopyPluginOptions): Plugin {
+	const __dirname = path.resolve();
+	return {
+		name: "copy-plugin",
+		async closeBundle() {
+			const srcAbs = path.resolve(__dirname, options.srcDir);
+			const destAbs = path.resolve(__dirname, options.destDir);
+			const include =
+				options.include && options.include.length > 0
+					? options.include
+					: undefined;
+			const exclude = options.exclude || [];
+			if (!include) {
+				console.info(
+					"[copy-plugin] No include globs specified, nothing to copy.",
+				);
+				return;
+			}
+			const files = await fg(include, {
+				cwd: srcAbs,
+				ignore: exclude,
+				onlyFiles: true,
+				absolute: false,
+			});
+			for (const relFile of files) {
+				const srcFile = path.join(srcAbs, relFile);
+				const destFile = path.join(destAbs, relFile);
+				ensureDirExists(destFile);
+				console.info(`[copy-plugin] copying ${srcFile} to ${destFile}`);
+				fs.copyFileSync(srcFile, destFile);
+			}
+		},
+	};
+}

package/src/vite/vite-plugin-fix-absolute-imports.ts

@@ -0,0 +1,40 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { builtinModules } from "node:module";
+import type { Plugin } from "vite";
+
+export default function VitePluginFixAbsoluteImports(): Plugin {
+	return {
+		name: "fix-absolute-imports",
+		transform(code: string, id: string) {
+			for (const module of builtinModules) {
+				const moduleImportRegex = new RegExp(
+					`from "(${module}(/.*)*/.*.js)";`,
+					"g",
+				);
+				// if matches, replace match with _module
+				const matches = code.match(moduleImportRegex);
+				if (matches) {
+					for (const match of matches) {
+						code = code.replace(match, `from "${module}";`);
+					}
+				}
+			}
+			return {
+				code,
+			};
+		},
+		enforce: "post",
+	};
+}

package/src/vite/vite-plugin-remove-unused-translations.ts

@@ -0,0 +1,128 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import fs from "node:fs/promises";
+import glob from "fast-glob";
+import type { Plugin } from "vite";
+
+const used = new Set<string>();
+
+export const flatten = (obj: object, prefix = ""): Record<string, string> => {
+	const flattenedObj: Record<string, string> = {};
+	for (const [key, value] of Object.entries(obj)) {
+		if (value instanceof Object) {
+			Object.assign(flattenedObj, flatten(value, `${prefix + key}.`));
+		} else {
+			flattenedObj[prefix + key] = value;
+		}
+	}
+	return flattenedObj;
+};
+
+type UnflattenObject =
+	| Record<string, string | number | boolean | undefined>
+	| string[]
+	| number[]
+	| boolean[];
+
+export const unflatten = (
+	obj: Record<string, string | number | boolean>,
+): Record<string, string | number | boolean | UnflattenObject> => {
+	const result: Record<string, string | number | boolean | UnflattenObject> =
+		{};
+
+	for (const [key, value] of Object.entries(obj)) {
+		const keys = key.split(".");
+		keys.reduce((acc, k, i) => {
+			if (i === keys.length - 1) {
+				(acc as Record<string, string | number | boolean | UnflattenObject>)[
+					k
+				] = value;
+			} else {
+				if (!acc[k]) {
+					acc[k] = Number.isNaN(Number(keys[i + 1])) ? {} : [];
+				}
+			}
+			return acc[k] as Record<
+				string,
+				string | number | boolean | UnflattenObject
+			>;
+		}, result);
+	}
+
+	return result;
+};
+
+export default function VitePluginRemoveUnusedTranslations(
+	translationKeys: string[],
+	jsonPattern: string,
+): Plugin {
+	return {
+		name: "remove-unused-translations",
+		transform(code: string) {
+			// Collect translation keys used in the source files
+			for (const key of translationKeys) {
+				if (code.includes(key) && !used.has(key)) {
+					console.info(`Found key: ${key}`);
+					used.add(key);
+				}
+			}
+			return { code };
+		},
+		enforce: "post",
+
+		async writeBundle() {
+			// Find all matching JSON files
+			const jsonFiles = await glob(jsonPattern, { absolute: true });
+
+			console.info(`Found ${jsonFiles.length} JSON files at ${jsonPattern}`);
+
+			const filePromises = [];
+			for (const filePath of jsonFiles) {
+				try {
+					const content = await fs.readFile(filePath, "utf-8");
+					const jsonData = JSON.parse(content);
+					const jsonDataFlattened = flatten(jsonData);
+
+					// Remove keys that are not in `used`
+					const filteredData = Object.fromEntries(
+						Object.entries(jsonDataFlattened).filter(([key]) => used.has(key)),
+					);
+
+					const unflattened = unflatten(filteredData);
+
+					// log.info(unflattened);
+
+					// Write back the filtered JSON
+					filePromises.push(
+						fs
+							.writeFile(
+								filePath,
+								JSON.stringify(unflattened, null, 2),
+								"utf-8",
+							)
+							.then(() => {
+								console.info(`Updated ${filePath}`);
+							})
+							.catch((e) => {
+								console.error(`Failed to update ${filePath}:`, e);
+							}),
+					);
+				} catch (error: unknown) {
+					console.error(`Failed to process ${filePath}:`, error);
+				}
+			}
+			await Promise.all(filePromises);
+		},
+	};
+}

package/src/vite/vite-plugin-sourcemap-exclude.ts

@@ -0,0 +1,36 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import type { Plugin } from "vite";
+
+interface SourcemapExclude {
+	excludeNodeModules?: boolean;
+}
+// Taken from https://github.com/vitejs/vite/issues/2433#issuecomment-1487472995 to prevent memory leaks
+export default function VitePluginSourcemapExclude(
+	opts?: SourcemapExclude,
+): Plugin {
+	return {
+		name: "sourcemap-exclude",
+		transform(code: string, id: string) {
+			if (opts?.excludeNodeModules && id.includes("node_modules")) {
+				return {
+					code,
+					// https://github.com/rollup/rollup/blob/master/docs/plugin-development/index.md#source-code-transformations
+					map: { mappings: "" },
+				};
+			}
+			return;
+		},
+	};
+}

package/src/vite/vite.backend.config.ts

@@ -0,0 +1,148 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { builtinModules } from "node:module";
+import path from "node:path";
+import { wasm } from "@rollup/plugin-wasm";
+import type { Drop } from "esbuild";
+import css from "rollup-plugin-import-css";
+import type { UserConfig } from "vite";
+import { filterDependencies, getDependencies } from "../dependencies.js";
+import { default as ClosePlugin } from "./vite-plugin-close-and-copy.js";
+import VitePluginFixAbsoluteImports from "./vite-plugin-fix-absolute-imports.js";
+
+export default async function (
+	packageName: string,
+	packageVersion: string,
+	bundleName: string,
+	packageDir: string,
+	entry: string | string[] | Record<string, string>,
+	command?: string,
+	mode?: string,
+	outputDir?: string,
+): Promise<UserConfig> {
+	const isProduction = mode === "production";
+
+	// Get all dependencies of the current package
+	const { dependencies: deps, optionalPeerDependencies } =
+		await getDependencies(packageName, true);
+
+	// Output directory is custom or relative to directory of the package
+	const outDir = outputDir
+		? path.resolve(outputDir)
+		: path.resolve(packageDir, "dist/bundle");
+
+	// Get rid of any dependencies we don't want to bundle
+	const { external, internal } = filterDependencies(deps, [
+		"aws",
+		"webpack",
+		"vite",
+		"biome",
+	]);
+
+	// Add the node builtins (path, fs, os, etc.) to the external list
+	const allExternal = [
+		...builtinModules,
+		...builtinModules.map((m) => `node:${m}`),
+		...external,
+		...optionalPeerDependencies,
+	];
+
+	console.info(
+		`Bundling. ${JSON.stringify(internal.slice(0, 10), null, 2)}... ${internal.length} deps`,
+	);
+
+	const define = {
+		"process.env.WS_NO_BUFFER_UTIL": "true",
+		"process.env.WS_NO_UTF_8_VALIDATE": "true",
+		"process.env.PROSOPO_PACKAGE_VERSION": JSON.stringify(packageVersion),
+		"process.env.NODE_ENV": JSON.stringify(process.env.NODE_ENV || mode),
+		...(process.env.PROSOPO_DEFAULT_ENVIRONMENT && {
+			"process.env.PROSOPO_DEFAULT_ENVIRONMENT": JSON.stringify(
+				process.env.PROSOPO_DEFAULT_ENVIRONMENT,
+			),
+		}),
+	};
+
+	console.info(`Defined vars ${JSON.stringify(define, null, 2)}`);
+
+	let entriesAbsolute: string[];
+	if (typeof entry === "string") {
+		entriesAbsolute = [path.resolve(packageDir, entry)];
+	} else if (Array.isArray(entry)) {
+		entriesAbsolute = entry.map((e) => path.resolve(packageDir, e));
+	} else {
+		entriesAbsolute = Object.fromEntries(
+			Object.entries(entry).map(([key, value]) => [
+				key,
+				path.resolve(packageDir, value),
+			]),
+		) as unknown as string[];
+	}
+
+	// drop console logs if in production mode
+	const drop: Drop[] | undefined =
+		mode === "production" ? ["console", "debugger"] : undefined;
+
+	return {
+		ssr: {
+			noExternal: true,
+			external: allExternal,
+		},
+		optimizeDeps: {
+			include: ["linked-dep", "node_modules"],
+			esbuildOptions: {
+				loader: {
+					".node": "file",
+				},
+			},
+		},
+		esbuild: {
+			platform: "node",
+			target: "node24",
+			// drop,
+			legalComments: "none",
+		},
+		define,
+		build: {
+			outDir,
+			minify: isProduction,
+			ssr: true,
+			target: "node24",
+			lib: {
+				entry: entriesAbsolute,
+				name: bundleName,
+				fileName: `${bundleName}.[name].bundle.js`,
+				formats: ["es"],
+			},
+			modulePreload: { polyfill: false },
+			rollupOptions: {
+				treeshake: "smallest",
+				external: allExternal,
+				watch: false,
+				output: {
+					entryFileNames: `${bundleName}.[name].bundle.js`,
+				},
+				// biome-ignore lint/suspicious/noExplicitAny: has to be any to represent object prototype
+				plugins: [css() as any, wasm() as any],
+			},
+		},
+		plugins: [
+			// plugin to replace stuff like import blah from string_encoder/lib/string_encoder.js with import blah from string_encoder
+			VitePluginFixAbsoluteImports(),
+			// plugin to close the bundle after build if not in serve mode
+			command !== "serve" ? ClosePlugin() : undefined,
+		],
+	};
+}

package/src/vite/vite.commonjs.config.ts

@@ -0,0 +1,96 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { builtinModules } from "node:module";
+import path from "node:path";
+import { type UserConfig, defineConfig } from "vite";
+import { default as noBundlePlugin } from "vite-plugin-no-bundle";
+import tsconfigPaths from "vite-tsconfig-paths";
+import { getExternalsFromReferences } from "../dependencies.js";
+import VitePluginCloseAndCopy from "./vite-plugin-close-and-copy.js";
+import VitePluginCopy from "./vite-plugin-copy.js";
+
+export default async function (
+	name: string,
+	tsConfigPath: string,
+	entry?: string | string[] | Record<string, string>,
+): Promise<UserConfig> {
+	console.info(`ViteCommonJSConfig: ${name}`);
+	const projectExternal = await getExternalsFromReferences(tsConfigPath, [
+		/dev/,
+	]);
+	const allExternal = [
+		...builtinModules,
+		...builtinModules.map((m) => `node:${m}`),
+		...projectExternal,
+	];
+	return defineConfig({
+		ssr: { external: allExternal },
+		plugins: [
+			// @ts-ignore
+			{
+				name: "string-replace-import.meta.url",
+				generateBundle(_, bundle) {
+					for (const fileName in bundle) {
+						const chunk = bundle[fileName];
+						if (
+							chunk &&
+							chunk.type === "chunk" &&
+							"code" in chunk &&
+							chunk.code
+						) {
+							chunk.code = chunk.code.replace(
+								/import\.meta\.url/g,
+								"require('url').pathToFileURL(__filename).href",
+							);
+						}
+					}
+				},
+			},
+			// @ts-ignore
+			noBundlePlugin({
+				root: "src",
+				copy: "**/*.css",
+			}),
+			VitePluginCopy({
+				srcDir: "src",
+				destDir: "dist",
+				include: ["**/*.json"],
+			}),
+			tsconfigPaths({ projects: [path.resolve(tsConfigPath)] }),
+			VitePluginCloseAndCopy(),
+		],
+		build: {
+			emptyOutDir: false,
+			ssr: true,
+			target: "node24",
+			outDir: "dist/cjs",
+			lib: {
+				name,
+				formats: ["cjs"],
+				entry: entry || "src/index.ts", // required
+			},
+			rollupOptions: {
+				treeshake: false,
+				external: allExternal,
+			},
+		},
+		esbuild: {
+			jsx: "automatic",
+			// Use standard React JSX for library packages
+			// Frontend apps using ViteFrontendConfig will override to Emotion
+			jsxDev: process.env.NODE_ENV === "development",
+		},
+	});
+}

package/src/vite/vite.esm.config.ts

@@ -0,0 +1,87 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { builtinModules } from "node:module";
+import path from "node:path";
+import { type UserConfig, defineConfig } from "vite";
+import { default as noBundlePlugin } from "vite-plugin-no-bundle";
+import tsconfigPaths from "vite-tsconfig-paths";
+import { getExternalsFromReferences } from "../dependencies.js";
+import VitePluginCloseAndCopy from "./vite-plugin-close-and-copy.js";
+import VitePluginCopy from "./vite-plugin-copy.js";
+
+export default async function (
+	name: string,
+	tsConfigPath: string,
+	entry?: string | string[] | Record<string, string>,
+): Promise<UserConfig> {
+	console.info(`ViteEsmConfig: ${name}`);
+	const projectExternal = await getExternalsFromReferences(tsConfigPath, [
+		/dev/,
+	]);
+	const allExternal = [
+		...builtinModules,
+		...builtinModules.map((m) => `node:${m}`),
+		...projectExternal,
+		// Webpack dependencies - should not be bundled by Vite
+		"html-webpack-plugin",
+		"mini-css-extract-plugin",
+		"node-polyfill-webpack-plugin",
+		"terser-webpack-plugin",
+		"webpack",
+		"webpack-dev-server",
+		"webpack-json-access-optimizer",
+		"babel-loader",
+		"css-loader",
+		"string-replace-loader",
+	];
+	return defineConfig({
+		ssr: { external: allExternal },
+		plugins: [
+			// @ts-ignore
+			noBundlePlugin({
+				root: "src",
+				copy: "**/*.css",
+			}),
+			VitePluginCopy({
+				srcDir: "src",
+				destDir: "dist",
+				include: ["**/*.json"],
+			}),
+			tsconfigPaths({ projects: [path.resolve(tsConfigPath)] }),
+			VitePluginCloseAndCopy(),
+		],
+		build: {
+			emptyOutDir: false,
+			ssr: true,
+			target: "node24",
+			outDir: "dist",
+			lib: {
+				name,
+				formats: ["es"],
+				entry: entry || "src/index.ts", // required
+			},
+			rollupOptions: {
+				treeshake: false,
+				external: allExternal,
+			},
+		},
+		esbuild: {
+			jsx: "automatic",
+			// Use standard React JSX for library packages
+			// Frontend apps using ViteFrontendConfig will override to Emotion
+			jsxDev: process.env.NODE_ENV === "development",
+		},
+	});
+}