@prosopo/config 3.3.0 → 3.3.2

package/src/vite/NodejsPolarsNativeFilePlugin.ts

@@ -0,0 +1,83 @@
+// 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";
+
+export const nodejsPolarsNativeFilePlugin = (
+	nodeFiles: string[],
+	outDir: string,
+) => {
+	const name = "nodejs-polars-native-file-plugin";
+	return {
+		name,
+		// biome-ignore lint/suspicious/noExplicitAny: TODO not sure of options type
+		resolveId(source: string, importer: string | undefined, options: any) {
+			// return the id if this plugin can resolve the import
+			for (const file of nodeFiles) {
+				if (path.basename(source) === path.basename(file)) {
+					console.debug(name, "resolves", source, "imported by", importer);
+					return source;
+				}
+			}
+			return null; // otherwise return null indicating that this plugin can't handle the import
+		},
+		transform(code: string, id: string) {
+			for (const file of nodeFiles) {
+				// rewrite the code to import the .node file
+				if (path.basename(id) === path.basename(file)) {
+					console.debug(name, "transform", id);
+					// https://stackoverflow.com/questions/66378682/nodejs-loading-es-modules-and-native-addons-in-the-same-project
+					// this makes the .node file load at runtime from an esm context. .node files aren't native to esm, so we have to create a custom require function to load them. The custom require function is equivalent to the require function in commonjs, thus allowing the .node file to be loaded.
+					return `
+                        // create a custom require function to load .node files
+                        import { createRequire } from 'module';
+                        const customRequire = createRequire(import.meta.url)
+    
+                        // load the .node file expecting it to be in the same directory as the output bundle
+                        const content = customRequire('./${file}')
+    
+                        // export the content straight back out again
+                        export default content
+                        `;
+				}
+			}
+			return code;
+		},
+		load(id: string) {
+			for (const file of nodeFiles) {
+				if (path.basename(id) === path.basename(file)) {
+					console.debug(name, "load", id);
+					// whenever we encounter an import of the .node file, we return an empty string. This makes it look like the .node file is empty to the bundler. This is because we're going to copy the .node file to the output directory ourselves, so we don't want the bundler to include it in the output bundle (also because the bundler can't handle .node files, it tries to read them as js and then complains that it's invalid js)
+					const newCode = "";
+					return newCode;
+				}
+			}
+			return null;
+		},
+		// biome-ignore lint/suspicious/noExplicitAny: TODO not sure of options/bundle type
+		generateBundle(options: any, bundle: any) {
+			for (const fileAbs of nodeFiles) {
+				const file = path.basename(fileAbs);
+				// copy the .node file to the output directory
+				const out = `${outDir}/${file}`;
+				const src = `${fileAbs}`;
+				console.debug(name, "copy", src, "to", out);
+				const nodeFile = fs.readFileSync(src);
+				fs.mkdirSync(path.dirname(out), { recursive: true });
+				fs.writeFileSync(out, nodeFile);
+			}
+		},
+	};
+};

package/src/vite/TsNoCheckPlugin.ts

@@ -0,0 +1,27 @@
+// 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.
+export function tsNoCheckPlugin() {
+	return {
+		name: "vite-plugin-ts-nocheck",
+		// biome-ignore lint/suspicious/noExplicitAny: TODO not sure of options/bundle type (same as NodejsPolarsNativeFilePlugin)
+		generateBundle(_: any, bundle: any) {
+			for (const fileName in bundle) {
+				const chunk = bundle[fileName];
+				if (chunk.type === "chunk" && chunk.code) {
+					chunk.code = `// @ts-nocheck\n${chunk.code}`;
+				}
+			}
+		},
+	};
+}

package/src/vite/index.ts

@@ -0,0 +1,25 @@
+// 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.
+export { default as VitePluginCloseAndCopy } from "./vite-plugin-close-and-copy.js";
+export { default as ViteTestConfig } from "./vite.test.config.js";
+export { default as ViteThreadsTestConfig } from "./vite.threads.test.config.js";
+export { default as VitePluginSourceMapExclude } from "./vite-plugin-sourcemap-exclude.js";
+export { default as ViteFrontendConfig } from "./vite.frontend.config.js";
+export { default as ViteBackendConfig } from "./vite.backend.config.js";
+export { default as VitePluginFixAbsoluteImports } from "./vite-plugin-fix-absolute-imports.js";
+export { default as ViteCommonJSConfig } from "./vite.commonjs.config.js";
+export { default as ViteEsmConfig } from "./vite.esm.config.js";
+export { default as VitePluginRemoveUnusedTranslations } from "./vite-plugin-remove-unused-translations.js";
+export * from "./TsNoCheckPlugin.js";
+export { default as VitePluginCopy } from "./vite-plugin-copy.js";

package/src/vite/types.ts

@@ -0,0 +1,13 @@
+// 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.

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

@@ -0,0 +1,76 @@
+// 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 type { Plugin } from "vite";
+
+export interface ClosePluginOptions {
+	srcDir: string;
+	destDir: string[];
+}
+
+/**
+ *   description: Closes Vite after the bundle has been build. Optionally copies the bundle to a different directory.
+ *   @param { ClosePluginOptions } options - The options object
+ **/
+export default function VitePluginCloseAndCopy(
+	options?: ClosePluginOptions,
+): Plugin {
+	const __dirname = path.resolve();
+	return {
+		name: "close-plugin", // required, will show up in warnings and errors
+		buildStart() {
+			console.info("Bundle build started");
+		},
+		buildEnd(error) {
+			console.info("Build end");
+			if (error) {
+				console.log(error);
+				console.error(error);
+			}
+		},
+		closeBundle() {
+			if (options) {
+				for (const destDir of options.destDir) {
+					clearOutputDirJS(__dirname, destDir);
+					console.info(`Bundle cleared from ${options.destDir}`);
+					copyBundle(__dirname, options.srcDir, destDir);
+					console.info(`Bundle copied to ${options.destDir}`);
+				}
+				console.info("Bundle closed");
+			}
+		},
+	};
+}
+
+const clearOutputDirJS = (__dirname: string, destDir: string) =>
+	fs
+		.readdirSync(path.resolve(__dirname, destDir))
+		.filter((file) => file.endsWith("js"))
+		.map((file) => {
+			fs.rmSync(path.resolve(__dirname, destDir, file));
+		});
+
+const copyBundle = (__dirname: string, srcDir: string, destDir: string) => {
+	console.info(
+		"Copying",
+		path.resolve(__dirname, srcDir),
+		"to",
+		path.resolve(__dirname, destDir),
+	);
+	fs.cpSync(path.resolve(__dirname, srcDir), path.resolve(__dirname, destDir), {
+		recursive: true,
+	});
+};

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,
+		],
+	};
+}