@orkestrel/scaffold 0.0.73 → 0.0.74

package/dist/src/core/index.cjs

@@ -4,7 +4,7 @@ let _orkestrel_template = require("@orkestrel/template");
 let _orkestrel_emitter = require("@orkestrel/emitter");
 var package_default = {
 	name: "@orkestrel/scaffold",
-	version: "0.0.73",
+	version: "0.0.74",
 	description: "Scaffold workspaces with commands: new, audit, repair, catalog, and overwrite.",
 	keywords: [
 		"audit",
@@ -102,7 +102,7 @@ var package_default = {
 		"@orkestrel/guide": "^0.0.20",
 		"@orkestrel/html": "^0.0.10",
 		"@orkestrel/probe": "^0.0.16",
-		"@orkestrel/test": "^0.0.16",
+		"@orkestrel/test": "^0.0.17",
 		"@types/node": "^26.5.1",
 		"@vitest/browser-playwright": "^4.1.11",
 		"oxfmt": "^0.68.0",
@@ -435,6 +435,8 @@ var SERVICE_SETUP_PATH = "tests/setupService.ts";
 var SERVICE_TEST_INCLUDE = "tests/service/**/*.test.ts";
 /** Names the Vite wrapper whose presence makes a workspace `showcase`. */
 var SHOWCASE_CONFIG_PATH = "configs/app/vite.showcase.config.ts";
+/** Names the Vite wrapper whose presence makes a workspace `journey`. */
+var JOURNEY_CONFIG_PATH = "configs/app/vite.journey.config.ts";
 /** Matches the bare workspace name syntax: lowercase alphanumeric with hyphens, letter first. */
 var NAME_PATTERN = /^[a-z][a-z0-9-]*$/;
 /**
@@ -671,7 +673,7 @@ var CONFIG_TEMPLATES = Object.freeze({
 	"exclude": ["node_modules", "dist", "tmp"]
 }
 `,
-		vite: `import type { PluginOption, UserConfig } from 'vite'
+		vite: `{{journey}}import type { PluginOption, UserConfig } from 'vite'
 import { mergeConfig } from 'vite'
 {{imports}}import { defineConfig } from 'vitest/config'
 import manifest from './package.json' with { type: 'json' }
@@ -945,7 +947,7 @@ function isNamedPlugin(plugin: PluginOption): plugin is { name: string } {
 			root: resolveWorkspacePath('.'),
 			dir: resolveWorkspacePath('.'),
 			include: ['tests/app/browser/**/*.test.ts'],
-			setupFiles: ['./tests/setup.ts', './tests/setupBrowser.ts'],
+{{journeyExclude}}			setupFiles: ['./tests/setup.ts', './tests/setupBrowser.ts'],
 			browser: {
 				enabled: true,
 				provider: playwright(browserOptions),
@@ -956,7 +958,29 @@ function isNamedPlugin(plugin: PluginOption): plugin is { name: string } {
 	}
 	return mergeOverride(project, override)
 }
-{{showcaseFactory}}`,
+{{showcaseFactory}}{{journeyFactory}}`,
+			journey: `
+// Replace the journey fields directly: merging would concatenate the ordinary include
+// and retain the exclusion of the journey suite.
+export function appJourney(variant: JourneyVariant, variants: readonly JourneyVariant[]): UserConfig {
+	const browser = appBrowser()
+	return {
+		...browser,
+		test: {
+			...browser.test,
+			name: { label: \`journey:\${variant.name}\`, color: 'green' },
+			include: ['tests/app/browser/integration.test.ts'],
+			exclude: [],
+			provide: { variant: variant.name, variants, capture },
+			browser: {
+				...browser.test?.browser,
+				enabled: true,
+				viewport: { width: variant.width, height: variant.height },
+			},
+		},
+	}
+}
+`,
 			showcase: `
 export function appShowcase(override?: UserConfig): UserConfig {
 	const output = 'dist/showcase'
@@ -1068,6 +1092,7 @@ export function appShowcase(override?: UserConfig): UserConfig {
 		test: {
 			name: { label: 'setup', color: 'white' },
 			include: ['tests/setup*.test.ts'],
+			exclude: ['tests/setupBrowser.test.ts'],
 			setupFiles: ['./tests/setup.ts'],
 			environment: 'node',
 			browser: { enabled: false },
@@ -1075,6 +1100,23 @@ export function appShowcase(override?: UserConfig): UserConfig {
 	}
 	return mergeOverride(project, override)
 }
+`,
+		browser: `export function setupBrowser(override?: UserConfig): UserConfig {
+	const project: UserConfig = {
+		resolve,
+		test: {
+			name: { label: 'setup:browser', color: 'blue' },
+			include: ['tests/setupBrowser.test.ts'],
+			setupFiles: ['./tests/setup.ts', './tests/setupBrowser.ts'],
+			browser: {
+				enabled: true,
+				provider: playwright(browserOptions),
+				instances: [{ browser: 'chromium', headless: true }],
+			},
+		},
+	}
+	return mergeOverride(project, override)
+}
 `,
 		guides: `export function guides(override?: UserConfig): UserConfig {
 	const project: UserConfig = {
@@ -1407,6 +1449,22 @@ export default defineConfig(appServer())
 import { appShowcase } from '../../vite.config.ts'
 
 export default defineConfig(appShowcase())
+`,
+			journey: `import type { JourneyVariant } from '@orkestrel/test'
+import { defineConfig } from 'vitest/config'
+import { appJourney } from '../../vite.config.ts'
+
+// Rename and extend these viewports for the application. Apply themes through its interface.
+const VARIANTS: readonly JourneyVariant[] = Object.freeze([
+	{ name: 'desktop', width: 1280, height: 800 },
+	{ name: 'compact', width: 390, height: 844 },
+])
+
+export default defineConfig({
+	test: {
+		projects: VARIANTS.map((variant) => () => appJourney(variant, VARIANTS)),
+	},
+})
 `
 		})
 	}),
@@ -1669,7 +1727,7 @@ export function resolveSystemBrowser(
 }
 
 /**
- * Resolves Playwright provider options for whatever browser this host can actually launch.
+ * Resolves Playwright provider options for Chromium on this host.
  *
  * @param pinned - The executable path for Playwright's pinned Chromium revision, when it has one.
  * @param platform - The Node platform whose standard layouts this call probes.
@@ -1689,6 +1747,10 @@ export function resolveSystemBrowser(
  * as well and exists only as a last resort: Windows takes \`msedge\`, which ships with the OS and
  * never collides with a foreground Chrome.
  *
+ * The resolver and the gate cover Chromium alone. Reopen engine selection when another
+ * Playwright engine is installed and launches on the host with a \`captureFrame\` reading
+ * back at its declared size, or when a journey or style divergence is recorded.
+ *
  * @example
  * \`\`\`ts
  * resolveBrowser(resolvePinnedBrowser(), process.platform, process.env)
@@ -3247,14 +3309,15 @@ var isBlueprint = (0, _orkestrel_contract.recordOf)({
 	engines: _orkestrel_contract.isString,
 	overrides: (0, _orkestrel_contract.andOf)(isCollection, (0, _orkestrel_contract.arrayOf)(isOverride)),
 	bin: _orkestrel_contract.isBoolean,
-	setup: _orkestrel_contract.isBoolean,
+	setup: (0, _orkestrel_contract.andOf)(isCollection, (0, _orkestrel_contract.arrayOf)((0, _orkestrel_contract.literalOf)("node", "browser"))),
 	guides: _orkestrel_contract.isBoolean,
 	integration: _orkestrel_contract.isBoolean,
 	conformance: _orkestrel_contract.isBoolean,
 	service: _orkestrel_contract.isBoolean,
 	vendors: (0, _orkestrel_contract.andOf)(isCollection, (0, _orkestrel_contract.arrayOf)(_orkestrel_contract.isString)),
 	global: _orkestrel_contract.isBoolean,
-	showcase: _orkestrel_contract.isBoolean
+	showcase: _orkestrel_contract.isBoolean,
+	journey: _orkestrel_contract.isBoolean
 }, ["description"]);
 /**
 * Narrows a value to an {@link Artifact}.
@@ -4730,7 +4793,7 @@ function blueprintToDevDependencies(blueprint) {
 	const merged = {
 		...BASE_DEV_DEPENDENCIES,
 		...blueprint.src.length > 0 || blueprint.bin ? DECLARATION_DEV_DEPENDENCIES : {},
-		...blueprint.src.includes("browser") ? SOURCE_BROWSER_DEV_DEPENDENCIES : {},
+		...blueprint.src.includes("browser") || blueprint.setup.includes("browser") ? SOURCE_BROWSER_DEV_DEPENDENCIES : {},
 		...blueprint.app.length > 0 ? APP_DEV_DEPENDENCIES : {},
 		...blueprint.app.includes("browser") ? APP_BROWSER_DEV_DEPENDENCIES : {},
 		...blueprint.showcase && blueprint.app.includes("browser") ? SHOWCASE_DEV_DEPENDENCIES : {},
@@ -4809,9 +4872,11 @@ function blueprintToScripts(blueprint) {
 	scripts.test = [
 		...compiles ? ["npm run test:src"] : [],
 		...blueprint.app.length > 0 ? ["npm run test:app"] : [],
+		...blueprint.journey && blueprint.app.includes("browser") ? ["npm run test:journey"] : [],
 		"npm run test:policy",
 		"npm run test:config",
-		...blueprint.setup ? ["npm run test:setup"] : [],
+		...blueprint.setup.includes("node") ? ["npm run test:setup"] : [],
+		...blueprint.setup.includes("browser") ? ["npm run test:setup:browser"] : [],
 		...blueprint.guides ? ["npm run test:guides"] : [],
 		...blueprint.conformance ? ["npm run test:conformance"] : [],
 		...integrates ? ["npm run test:integration"] : [],
@@ -4832,7 +4897,9 @@ function blueprintToScripts(blueprint) {
 	}
 	scripts["test:policy"] = `${vitest} --project policy`;
 	scripts["test:config"] = `${vitest} --project config`;
-	if (blueprint.setup) scripts["test:setup"] = `${vitest} --project setup`;
+	if (blueprint.setup.includes("node")) scripts["test:setup"] = `${vitest} --project setup`;
+	if (blueprint.setup.includes("browser")) scripts["test:setup:browser"] = `${vitest} --project setup:browser`;
+	if (blueprint.journey && blueprint.app.includes("browser")) scripts["test:journey"] = `vitest run --config ${JOURNEY_CONFIG_PATH} --no-cache --reporter=dot`;
 	if (blueprint.guides) scripts["test:guides"] = `node --experimental-strip-types ${GUIDES_TEST_PATH}`;
 	if (blueprint.conformance) scripts["test:conformance"] = `${vitest} --project conformance`;
 	scripts["test:probe"] = "vitest run --config vite.config.ts --no-cache --reporter=verbose --project probe";
@@ -5056,7 +5123,7 @@ function blueprintToManifest(blueprint) {
 function blueprintToMachinery(blueprint) {
 	const hosted = blueprint.app.some((environment) => environment !== "core");
 	return {
-		browser: blueprint.src.includes("browser") || blueprint.app.includes("browser"),
+		browser: blueprint.src.includes("browser") || blueprint.app.includes("browser") || blueprint.setup.includes("browser"),
 		vue: blueprint.app.includes("browser"),
 		output: blueprint.src.length > 0 || blueprint.bin || hosted,
 		showcase: blueprint.showcase && blueprint.app.includes("browser")
@@ -5196,7 +5263,11 @@ function blueprintToRootVite(blueprint) {
 	}
 	if (blueprint.app.includes("browser")) {
 		const showcaseFactory = machinery.showcase ? CONFIG_TEMPLATES.factories.app.showcase : "";
-		factories.push((0, _orkestrel_template.fillTemplate)(CONFIG_TEMPLATES.factories.app.browser, { showcaseFactory }));
+		factories.push((0, _orkestrel_template.fillTemplate)(CONFIG_TEMPLATES.factories.app.browser, {
+			showcaseFactory,
+			journeyFactory: blueprint.journey ? CONFIG_TEMPLATES.factories.app.journey : "",
+			journeyExclude: blueprint.journey ? "			exclude: ['tests/app/browser/integration.test.ts'],\n" : ""
+		}));
 		projects.push("appBrowser");
 	}
 	if (blueprint.app.includes("server")) {
@@ -5207,10 +5278,14 @@ function blueprintToRootVite(blueprint) {
 	projects.push("policy");
 	factories.push(CONFIG_TEMPLATES.factories.config);
 	projects.push("config");
-	if (blueprint.setup) {
+	if (blueprint.setup.includes("node")) {
 		factories.push(CONFIG_TEMPLATES.factories.setup);
 		projects.push("setup");
 	}
+	if (blueprint.setup.includes("browser")) {
+		factories.push(CONFIG_TEMPLATES.factories.browser);
+		projects.push("setupBrowser");
+	}
 	if (blueprint.guides) {
 		factories.push(CONFIG_TEMPLATES.factories.guides);
 		projects.push("guides");
@@ -5244,10 +5319,11 @@ ${projects.map((project) => `\t\t\t${project},`).join("\n")}
 		"outputBoundary"
 	].filter((helper) => body.includes(helper));
 	return (0, _orkestrel_template.fillTemplate)(CONFIG_TEMPLATES.root.vite, {
+		journey: blueprint.journey && machinery.vue ? "import type { JourneyVariant } from '@orkestrel/test'\n" : "",
 		imports: imports.length === 0 ? "" : `${imports.join("\n")}\n`,
 		helpers: helpers.length === 0 ? "" : `import { ${helpers.join(", ")} } from './configs/helpers.js'\n`,
 		browsers: machinery.browser ? "import { resolveBrowser, resolvePinnedBrowser } from './configs/browsers.js'\n" : "",
-		options: machinery.browser ? "const browserOptions = resolveBrowser(resolvePinnedBrowser(), process.platform, process.env)\n\n" : "",
+		options: (machinery.browser ? "const browserOptions = resolveBrowser(resolvePinnedBrowser(), process.platform, process.env)\n\n" : "") + (blueprint.journey && machinery.vue ? "const capture = process.env.CAPTURE === '1'\n\n" : ""),
 		factories: body,
 		projects: projectRows
 	});
@@ -5360,6 +5436,14 @@ ${paths.join("\n")}
 		environment: "browser",
 		content: CONFIG_TEMPLATES.vites.app.showcase
 	});
+	if (blueprint.journey && blueprint.app.includes("browser")) artifacts.push({
+		path: JOURNEY_CONFIG_PATH,
+		group: "configs",
+		ownership: "birth",
+		origin: "template",
+		environment: "browser",
+		content: CONFIG_TEMPLATES.vites.app.journey
+	});
 	return artifacts;
 }
 /**
@@ -5480,7 +5564,7 @@ function blueprintToTestArtifacts(blueprint) {
 		origin: "template",
 		content: ARTIFACT_TEMPLATES.tests.setup
 	}];
-	if (blueprint.src.includes("browser") || blueprint.app.includes("browser")) artifacts.push({
+	if (blueprintToMachinery(blueprint).browser) artifacts.push({
 		path: "tests/setupBrowser.ts",
 		group: "tests",
 		ownership: "birth",
@@ -6529,6 +6613,11 @@ function blueprintToQuestions(blueprint) {
 		message: "showcase projects a browser app, and this workspace declares none, so it emits nothing.",
 		blocking: false
 	});
+	if (blueprint.journey && !blueprint.app.includes("browser")) questions.push({
+		field: "journey",
+		message: "journey projects a browser app, and this workspace declares none, so it emits nothing.",
+		blocking: false
+	});
 	questions.push(...dependenciesToQuestions(blueprint.dependencies, "dependencies", DEPENDENCY_NAME_PATTERN, ORKESTREL_RANGE_PATTERN), ...dependenciesToQuestions(blueprint.peers.filter((peer) => peer.name.startsWith("@orkestrel/")), "peers", DEPENDENCY_NAME_PATTERN, ORKESTREL_RANGE_PATTERN), ...dependenciesToQuestions(blueprint.peers.filter((peer) => !peer.name.startsWith("@orkestrel/")), "peers", FOREIGN_NAME_PATTERN, FLOOR_RANGE_PATTERN), ...dependenciesToQuestions(blueprint.extras, "extras", FOREIGN_NAME_PATTERN, EXTRA_RANGE_PATTERN));
 	const lists = [
 		["dependencies", blueprint.dependencies],
@@ -6736,14 +6825,15 @@ function createBlueprint(name, input) {
 		engines: input?.engines ?? DEFAULT_ENGINES,
 		overrides: input?.overrides ?? [],
 		bin: input?.bin ?? false,
-		setup: input?.setup ?? false,
+		setup: input?.setup ?? [],
 		guides: input?.guides ?? false,
 		integration: input?.integration ?? false,
 		conformance: input?.conformance ?? false,
 		service: input?.service ?? false,
 		vendors: input?.vendors ?? [],
 		global: input?.global ?? false,
-		showcase: input?.showcase ?? false
+		showcase: input?.showcase ?? false,
+		journey: input?.journey ?? false
 	}));
 	if (blueprint === void 0) throw new ScaffoldError("INVALID", "The filled record is not a blueprint.", { name });
 	return blueprint;
@@ -7087,6 +7177,7 @@ exports.HOST_INVENTORY_PATH = HOST_INVENTORY_PATH;
 exports.HOST_PATHS = HOST_PATHS;
 exports.INTEGRATION_TEST_PATH = INTEGRATION_TEST_PATH;
 exports.INVALID_PATH_CHARACTER_PATTERN = INVALID_PATH_CHARACTER_PATTERN;
+exports.JOURNEY_CONFIG_PATH = JOURNEY_CONFIG_PATH;
 exports.MANIFEST_PATH = MANIFEST_PATH;
 exports.MAX_ARTIFACT_BYTES = MAX_ARTIFACT_BYTES;
 exports.MAX_ARTIFACT_HEX_LENGTH = MAX_ARTIFACT_HEX_LENGTH;