@datamoc/mw_games 0.44.2 → 0.45.0

package/tools/extract-rgssad.mjs

@@ -1,64 +1 @@
-#!/usr/bin/env node
-import fs from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import * as glue from './vendored/rgssad-wasm/rgssad_wasm_bg.js';
-
-/**
- * Extracts an RPG Maker XP/VX `.rgssad` archive to plain files, through the vendored
- * `rgssad-wasm` decoder (MIT, see `vendored/rgssad-wasm/README.md`). A format tool, for someone
- * porting a game whose archive they own; nothing a player receives. Shipped as
- * `@datamoc/mw_games/tools/extract-rgssad` and `mwg-extract-rgssad <archive> <outDir>` (item 389).
- *
- * Entry names come from the archive, so they are untrusted: each is normalised (RPG Maker writes
- * `\\` separators) and refused unless it resolves inside `outDir`, the check that stops an entry
- * named `..\\..\\anything` from writing outside the folder asked for.
- */
-
-// Resolved relative to this script's own location, not the caller's cwd.
-const here = path.dirname(fileURLToPath(import.meta.url));
-let ready = null;
-
-function decoder() {
-	ready ??= WebAssembly.instantiate(fs.readFileSync(path.join(here, 'vendored/rgssad-wasm/rgssad_wasm_bg.wasm')), {
-		'./rgssad_wasm_bg.js': glue,
-	}).then(({ instance }) => {
-		glue.__wbg_set_wasm(instance.exports);
-		if (instance.exports.__wbindgen_start) instance.exports.__wbindgen_start();
-	});
-	return ready;
-}
-
-/** where an archive entry lands under `outDir`, or a thrown error when its name escapes it */
-export function entryPath(outDir, fileName) {
-	const root = path.resolve(outDir);
-	const target = path.resolve(root, fileName.replace(/\\/g, '/'));
-	if (target !== root && !target.startsWith(root + path.sep))
-		throw new Error(`rgssad entry "${fileName}" would be written outside ${root}`);
-	return target;
-}
-
-/** extracts every entry of `archivePath` under `outDir`; returns how many files were written */
-export async function extractRgssad(archivePath, outDir) {
-	await decoder();
-	const data = fs.readFileSync(archivePath);
-	const reader = new glue.Reader(data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength));
-	let count = 0;
-	for (let entry = reader.readEntry(); entry != null; entry = reader.readEntry()) {
-		const outPath = entryPath(outDir, entry.fileName);
-		fs.mkdirSync(path.dirname(outPath), { recursive: true });
-		fs.writeFileSync(outPath, Buffer.from(entry.data));
-		count++;
-	}
-	return count;
-}
-
-//realpath, since an npm `bin` shim reaches this file through a symlink
-if (process.argv[1] && fs.realpathSync(process.argv[1]) === fileURLToPath(import.meta.url)) {
-	const [, , archivePath, outDir] = process.argv;
-	if (!archivePath || !outDir) {
-		console.error('usage: mwg-extract-rgssad <archive.rgssad> <outDir>');
-		process.exit(1);
-	}
-	console.log(`Extracted ${await extractRgssad(archivePath, outDir)} files to ${outDir}`);
-}
+export * from '@datamoc/mwg/tools/extract-rgssad';

package/tools/find-chrome.d.mts

@@ -1,7 +1 @@
-import type { Browser } from 'playwright-core';
-
-/** the Chrome or Chromium to drive: the platform's usual install, then Playwright's own, then PATH */
-export function findChrome(): Promise<string>;
-
-/** headless Chrome set up for `file://` pages; `CHROME_PATH` names the executable, `argsEnv` names the variable holding extra flags */
-export function launchChrome(options?: { argsEnv?: string }): Promise<Browser>;
+export * from '@datamoc/mwg/tools/find-chrome';

package/tools/find-chrome.mjs

@@ -1,106 +1 @@
-import { access, readdir } from 'node:fs/promises';
-import { homedir } from 'node:os';
-import { join } from 'node:path';
-
-/**
- * `playwright-core`, loaded on first use: it is an optional peer of the published package, so a
- * game that never runs a browser check does not need it installed.
- */
-async function playwright() {
-	try {
-		return await import('playwright-core');
-	} catch {
-		throw new Error('the browser checks need playwright-core: npm install --save-dev playwright-core');
-	}
-}
-
-/**
- * The browser to drive: the platform's usual Chrome (or, on Windows, Edge), then a Chromium that
- * Playwright itself installed (`PLAYWRIGHT_BROWSERS_PATH`, common in CI images and containers),
- * then whatever is on PATH. `CHROME_PATH` or `CHROME` overrides all of them.
- */
-export async function findChrome() {
-	const override = process.env.CHROME_PATH || process.env.CHROME;
-	if (override) return override;
-	const candidates =
-		process.platform === 'win32'
-			? [
-					'C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe',
-					'C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe',
-					'C:\\Program Files (x86)\\Microsoft\\Edge\\Application\\msedge.exe',
-				]
-			: process.platform === 'darwin'
-				? [
-						'/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
-						'/Applications/Chromium.app/Contents/MacOS/Chromium',
-					]
-				: ['/usr/bin/google-chrome', '/usr/bin/chromium', '/usr/bin/chromium-browser'];
-
-	for (const candidate of candidates) {
-		try {
-			await access(candidate);
-			return candidate;
-		} catch {}
-	}
-	const bundled = await playwrightChromium();
-	if (bundled) return bundled;
-	return process.platform === 'win32' ? 'chrome.exe' : 'google-chrome';
-}
-
-/**
- * The newest Chromium under Playwright's browsers folder, whatever revision it is: the one
- * `playwright-core` would pick is often not the one a CI image or container installed.
- */
-async function playwrightChromium() {
-	const roots = [
-		process.env.PLAYWRIGHT_BROWSERS_PATH,
-		process.platform === 'win32'
-			? join(process.env.LOCALAPPDATA ?? join(homedir(), 'AppData', 'Local'), 'ms-playwright')
-			: process.platform === 'darwin'
-				? join(homedir(), 'Library', 'Caches', 'ms-playwright')
-				: join(homedir(), '.cache', 'ms-playwright'),
-	].filter(Boolean);
-	const inside = [
-		'chrome-linux64/chrome',
-		'chrome-linux/chrome',
-		'chrome-win64/chrome.exe',
-		'chrome-win/chrome.exe',
-		'chrome-mac-arm64/Chromium.app/Contents/MacOS/Chromium',
-		'chrome-mac/Chromium.app/Contents/MacOS/Chromium',
-	];
-	for (const root of roots) {
-		const revisions = (await readdir(root).catch(() => []))
-			.filter((name) => /^chromium-\d+$/.test(name))
-			.sort((a, b) => Number(b.slice(9)) - Number(a.slice(9)));
-		for (const revision of revisions)
-			for (const path of inside) {
-				const candidate = join(root, revision, path);
-				if (
-					await access(candidate).then(
-						() => true,
-						() => false,
-					)
-				)
-					return candidate;
-			}
-	}
-	return null;
-}
-
-/**
- * Launches headless Chrome for a page loaded from `file://`, the way every tool here wants it:
- * the same discovery, `--allow-file-access-from-files`, and machine-specific flags read from
- * `argsEnv` (a runner with no GPU passes `--use-gl=angle --use-angle=swiftshader` that way,
- * since that is a property of the machine rather than of the tool). Each caller keeps its own
- * page setup and assertions; this is the launch they all had in common.
- */
-export async function launchChrome({ argsEnv = 'MWG_BENCHMARK_CHROME_ARGS' } = {}) {
-	const executablePath = await findChrome();
-	const extraArgs = (process.env[argsEnv] ?? '').split(' ').filter(Boolean);
-	const { chromium } = await playwright();
-	return chromium.launch({
-		executablePath,
-		headless: true,
-		args: ['--allow-file-access-from-files', ...extraArgs],
-	});
-}
+export * from '@datamoc/mwg/tools/find-chrome';

package/tools/i18n-edit.d.mts

@@ -1,29 +1 @@
-import type { Catalog } from '@datamoc/mw_games/i18n';
-import type { MarkdownSpan } from '@datamoc/mw_games/two-d/ui';
-
-export interface LoadedCatalogFile {
-	catalog: Catalog;
-	format: 'json' | 'ftl';
-	typography: boolean | undefined;
-}
-
-export interface SerializedTarget {
-	text: string;
-	flattened: number;
-}
-
-export function loadCatalogFile(path: string): Promise<LoadedCatalogFile>;
-export function serializeTarget(targetPath: string, catalog: Catalog): SerializedTarget;
-export function spansToAnsi(spans: readonly MarkdownSpan[]): string;
-export function truncateAnsi(ansi: string, width: number): string;
-export function placeholderSummary(baseText: string, targetText: string): string;
-export function expectedPlaceholders(baseText: string): string;
-
-export interface PlayerCandidate {
-	cmd: string;
-	args: string[];
-	shell?: boolean;
-}
-
-export function playerCandidates(cuePath: string, platform?: NodeJS.Platform): PlayerCandidate[];
-export function main(argv?: string[]): Promise<void>;
+export * from '@datamoc/mwg/tools/i18n-edit';