@datamoc/mw_games 0.44.2 → 0.45.0

package/tools/vite.mjs

@@ -1,102 +1 @@
-import { existsSync, readFileSync } from 'node:fs';
-import { writeFile } from 'node:fs/promises';
-import { basename, join, resolve } from 'node:path';
-import { emitPage } from './emit-page.mjs';
-import { buildArtifactSbom, serialize, shippedFiles } from './sbom.mjs';
-
-/**
- * The vite side of a `file://` game in one plugin: `plugins: [mwgPage()]` and `vite build` alone
- * writes a folder that opens by double-clicking, the build every example here uses.
- *
- * It sets the configuration that target needs (a classic IIFE bundle named `game.js`, relative
- * urls through `base: './'`, no inlined or copied assets since they are compiled instead) and
- * serves `assets` (default `'assets'`, `false` for none) as the public folder, so an asset path reads the same in `vite` dev as in the
- * build. `assetFiles: ['characters/hero.svg', 'music/theme.ogg']` embeds only those paths;
- * omit it for all assets, or pass [] for none. An unknown entry fails by name. Filtering
- * affects the build only, so the dev server still serves the asset folder normally.
- * An embedded `.sf2` or `.sf3` is subset at build time to the programs the embedded `.mid` files
- * use (`soundFont: false` embeds it whole, `soundFontUsage` names the programs instead).
- * `svgo: true` minifies embedded `.svg` assets (needs the optional `svgo` package).
- * At the end of the build it runs `emitPage` over the output folder with the same
- * options. A setting the game's own config gives explicitly still wins, since vite merges a
- * plugin's `config` result under the user's.
- *
- * It also writes `sbom.cdx.json` into the output folder (`sbom: false` to skip it): a CycloneDX
- * SBOM of what this build ships, the npm packages whose modules reached the bundle, from vite's
- * own module graph, and every shipped file with its SHA-256. That is the inventory a player's
- * copy actually contains, which a lockfile SBOM (`mwg-sbom`) cannot give: the lockfile lists
- * vite and TypeScript, and cannot tell which dependencies tree-shaking kept.
- *
- * @example
- * ```ts
- * // vite.config.ts
- * import { defineConfig } from 'vite';
- * import { mwgPage } from '@datamoc/mw_games/tools/vite';
- *
- * export default defineConfig({ plugins: [mwgPage({ assets: 'assets', singleFile: true })] });
- * ```
- */
-export function mwgPage(options = {}) {
-	const assets = options.assets ?? 'assets';
-	let root = process.cwd();
-	let outDir = 'dist';
-	let building = false;
-	const modules = new Set();
-	return {
-		name: 'mwg-page',
-		config() {
-			return {
-				base: './',
-				publicDir: assets || false,
-				build: {
-					target: 'es2022',
-					assetsInlineLimit: 0,
-					copyPublicDir: false,
-					//emitPage writes real .gz/.br files, so vite need not estimate them in memory
-					reportCompressedSize: false,
-					rollupOptions: {
-						output: { format: 'iife', entryFileNames: 'game.js', assetFileNames: '[name][extname]' },
-						//an iife has no import.meta, and the bundler already swaps it for {} (vite's own
-						//preload helper reads it); the warning on every build is noise, not information
-						onLog(level, log, defaultHandler) {
-							if (log.code !== 'EMPTY_IMPORT_META') defaultHandler(level, log);
-						},
-					},
-				},
-			};
-		},
-		generateBundle(_options, bundle) {
-			for (const chunk of Object.values(bundle))
-				if (chunk.type === 'chunk') for (const id of Object.keys(chunk.modules)) modules.add(id);
-		},
-		configResolved(config) {
-			root = config.root;
-			outDir = config.build.outDir;
-			building = config.command === 'build';
-		},
-		async closeBundle() {
-			//vite also closes the bundle when a dev server stops; only a real build is finished
-			if (!building || this.meta?.watchMode) return;
-			const { assets: _assets, sbom = true, ...emitOptions } = options;
-			const source = assets ? resolve(root, assets) : undefined;
-			const dist = resolve(root, outDir);
-			const page = await emitPage({
-				...emitOptions,
-				dist,
-				assets: source && existsSync(source) ? source : undefined,
-			});
-			if (page.unusedAssets.length > 0)
-				console.warn(
-					`mwg-page: ${page.unusedAssets.length} embedded asset(s) are never named in the game code: ${page.unusedAssets.join(', ')}`,
-				);
-			if (sbom) {
-				const manifest = join(root, 'package.json');
-				const packageJson = existsSync(manifest)
-					? JSON.parse(readFileSync(manifest, 'utf8'))
-					: { name: basename(root), version: '0.0.0' };
-				const bom = buildArtifactSbom({ packageJson, modules: [...modules], files: await shippedFiles(dist) });
-				await writeFile(join(dist, 'sbom.cdx.json'), serialize(bom), 'utf8');
-			}
-		},
-	};
-}
+export * from '@datamoc/mwg/tools/vite';

package/tools/webp-convert.d.mts

@@ -1,8 +1 @@
-export interface ToWebpOptions {
-	lossless?: boolean;
-	quality?: number;
-}
-
-export function toWebp(buffer: Buffer, options?: ToWebpOptions): Promise<Buffer>;
-
-export const WEBP_CONVERTIBLE_EXTENSIONS: Set<string>;
+export * from '@datamoc/mwg/tools/webp-convert';

package/tools/webp-convert.mjs

@@ -1,98 +1 @@
-import { readFile, writeFile, stat } from 'node:fs/promises';
-import { extname, basename, resolve, dirname } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-/**
- * Converts a raster image buffer to WebP - roadmap item 350's "convert pictures to WebP"
- * half, kept as its own module so `tools/compile-resources.mjs` (a published, shipped tool -
- * see `package.json`'s `files`/`exports`) never has to import an image codec itself. This file
- * is *not* shipped: it dynamically imports `sharp`, a devDependency of this repo, so a game
- * that never opts into WebP conversion carries no new dependency at all. A game that does want
- * it installs `sharp` in its own project the same way this repo does.
- *
- * `lossless` (default true) uses WebP's real lossless mode (VP8L), which is what a pixel-art
- * tileset's exact colours need - not "high quality lossy", which is still a DCT approximation
- * at any quality setting. Lossy mode (`lossless: false`, with `quality`) is available for
- * photographic source art where the extra size saving is worth it, but it is never the
- * default: this project does not silently trade fidelity for size.
- */
-
-let sharpModule;
-async function loadSharp() {
-	if (sharpModule) return sharpModule;
-	try {
-		sharpModule = (await import('sharp')).default;
-	} catch (err) {
-		throw new Error(
-			'WebP conversion needs the optional `sharp` package, which is not installed. ' +
-				'Run `npm install --save-dev sharp` in your project to use toWebp, or pass ' +
-				'`toWebp: false` (the default) to skip WebP conversion entirely.',
-			{ cause: err },
-		);
-	}
-	return sharpModule;
-}
-
-/**
- * @param {Buffer} buffer source image bytes (PNG or JPEG)
- * @param {object} [options]
- * @param {boolean} [options.lossless] use WebP's lossless mode (default true)
- * @param {number} [options.quality] 0-100, used only when `lossless` is false (default 90)
- * @returns {Promise<Buffer>} WebP-encoded image bytes
- */
-export async function toWebp(buffer, { lossless = true, quality = 90 } = {}) {
-	const sharp = await loadSharp();
-	return sharp(buffer)
-		.webp(lossless ? { lossless: true } : { quality })
-		.toBuffer();
-}
-
-/**
- * The extensions `compileResources`'s `toWebp` option will attempt to convert. `.gif` (frame
- * animation, which WebP would need to be re-authored to preserve) and `.svg` (already vector,
- * so there is nothing raster to convert) are deliberately left out, along with `.webp` itself.
- */
-export const WEBP_CONVERTIBLE_EXTENSIONS = new Set(['.png', '.jpg', '.jpeg']);
-
-// ---------------------------------------------------------------- CLI
-
-const isMain = process.argv[1] && resolve(process.argv[1]) === fileURLToPath(import.meta.url);
-
-async function runCli() {
-	const args = process.argv.slice(2);
-	const input = args.find((a) => !a.startsWith('--'));
-	if (!input) {
-		console.error('usage: node tools/webp-convert.mjs <file.png|file.jpg> [--lossy[=quality]]');
-		process.exit(1);
-	}
-	const lossyFlag = args.find((a) => a === '--lossy' || a.startsWith('--lossy='));
-	const lossless = !lossyFlag;
-	const quality = lossyFlag && lossyFlag.includes('=') ? Number(lossyFlag.split('=')[1]) : 90;
-
-	const inPath = resolve(input);
-	if (!WEBP_CONVERTIBLE_EXTENSIONS.has(extname(inPath).toLowerCase())) {
-		console.error(`${input}: not a convertible image (expected .png, .jpg or .jpeg)`);
-		process.exit(1);
-	}
-	const source = await readFile(inPath);
-	const converted = await toWebp(source, { lossless, quality });
-	const outPath = resolve(dirname(inPath), basename(inPath, extname(inPath)) + '.webp');
-	await writeFile(outPath, converted);
-
-	const { size: sourceSize } = await stat(inPath);
-	const kb = (n) => (n / 1024).toFixed(1) + ' KB';
-	const pct = Math.round((100 * (sourceSize - converted.length)) / sourceSize);
-	console.log(`  ${outPath}`);
-	console.log(
-		`  ${kb(sourceSize)} -> ${kb(converted.length)} (${pct >= 0 ? '-' : '+'}${Math.abs(pct)}%)` +
-			(lossless ? ' [lossless]' : ` [lossy, quality ${quality}]`),
-	);
-}
-
-//no top-level await: a vite config loaded as CommonJS has to be able to require() this module
-if (isMain) {
-	runCli().catch((error) => {
-		console.error(error);
-		process.exitCode = 1;
-	});
-}
+export * from '@datamoc/mwg/tools/webp-convert';

package/two-d/pixi-interop.d.ts

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/pixi-interop';

package/two-d/pixi-interop.js

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/pixi-interop';

package/two-d/presentation.d.ts

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/presentation';

package/two-d/presentation.js

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/presentation';

package/two-d/render.d.ts

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/render';

package/two-d/render.js

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/render';

package/two-d/stage.d.ts

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/stage';

package/two-d/stage.js

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/stage';

package/two-d/ui.d.ts

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/ui';

package/two-d/ui.js

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d/ui';

package/two-d.d.ts

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d';

package/two-d.js

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/two-d';

package/world.d.ts

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/world';

package/world.js

@@ -0,0 +1 @@
+export * from '@datamoc/mwg/world';