@samva/vite 0.8.0 → 0.9.0

package/dist/build.js

@@ -1,228 +1,103 @@
-import { c as projectThemePath, f as brandDiagnostics, i as isTemplateDefinition, l as readProjectThemeCss, m as loadBrandEnv, o as readEmailProject, p as createBrandResolver, s as renderEmailFixtures, u as resolveThemePath } from "./project-RON2Ei7d.js";
-import { t as discoverTemplateFiles } from "./discovery-D2eR-rzi.js";
-import { COMPILER_VERSION, emitModulePreview } from "./emit.js";
-import { createEmailRenderer } from "./email.js";
-import { dirname, parse, relative, resolve, sep } from "node:path";
+import { d as emailCompatibility, f as finding, h as renderEmailFixtures, i as loadProject, m as renderChannelFixture, n as createProjectSession, p as hasErrors, s as isDeliverableBase } from "./project-Cp8qb3s0.js";
+import markupPackage from "@samva/markup/package.json" with { type: "json" };
 //#region src/build.ts
-/** Execute each email definition's fixtures; compile structured SMS/WhatsApp through their channel compiler. */
-const buildTemplates = async (dir, options = {}) => {
-	const session = await createTemplateBuildSession(dir, options);
-	try {
-		return await session.build();
-	} finally {
-		await session.close();
-	}
-};
-const emailFinding = (code, message) => ({
-	code,
-	severity: "error",
-	message,
-	origins: []
-});
-const emailFailure = (cause, code = "email-build-error") => ({
-	kind: "email",
-	ok: false,
-	compilerVersion: COMPILER_VERSION,
-	templates: [],
-	diagnostics: Array.isArray(cause?.diagnostics) ? cause.diagnostics : [emailFinding(code, cause instanceof Error ? cause.message : String(cause))]
+/** The compiler a build ran, as a publication records it. */
+const COMPILER = `@samva/markup@${markupPackage.version}`;
+/**
+* A build needs an https base for imported assets and reports one finding when it has none, so a
+* template that imports an asset still compiles and renders and the finding is the only noise.
+*/
+const PLACEHOLDER_ORIGIN = "https://assets.invalid";
+const withCompileBase = (options) => ({
+	...options,
+	assetBase: isDeliverableBase(options.assetBase ?? "") ? options.assetBase : PLACEHOLDER_ORIGIN
 });
-/** A watcher and module evaluator over the project's installed authoring toolchain. */
-const createTemplateBuildSession = async (dir, options = {}) => {
-	const templatesDir = resolve(dir);
-	const root = resolve(options.root ?? dirname(templatesDir));
-	const themePath = resolveThemePath(root, options.theme);
-	await discoverTemplateFiles(templatesDir);
-	const server = await createEvaluator(templatesDir);
-	server.watcher.add(root);
-	if (themePath !== void 0) server.watcher.add(themePath);
-	let closed = false;
-	let emailRenderer;
-	let previousTheme;
-	let previousBrand;
-	const brands = createBrandResolver({
-		root,
-		env: await loadBrandEnv(root)
+const assetFindings = (entry, assetBase) => {
+	if (entry.assets.length === 0) return [];
+	if (assetBase === void 0 || assetBase === "") return [finding("missing-asset-base", "error", "Imported email assets require --asset-base with their HTTPS serving origin.")];
+	return /^https:\/\//i.test(assetBase) ? [] : [finding("invalid-asset-base", "error", "Email check and build require an HTTPS --asset-base; relative URLs belong to templates export.")];
+};
+const buildEntry = (entry, assetBase) => {
+	const email = entry.channels.includes("email") ? renderEmailFixtures(entry) : [];
+	const fixtures = Object.entries(entry.fixtures).map(([name, input]) => {
+		const rendered = email.find((result) => result.fixture === name);
+		const sms = entry.channels.includes("sms") ? renderChannelFixture(entry, "sms", name) : void 0;
+		const whatsapp = entry.channels.includes("whatsapp") ? renderChannelFixture(entry, "whatsapp", name) : void 0;
+		const diagnostics = [...rendered?.diagnostics ?? [], ...[sms, whatsapp].flatMap((result) => result?.ok === false ? result.diagnostics : [])];
+		return {
+			name,
+			input,
+			ok: !hasErrors(diagnostics),
+			...rendered?.rendered === void 0 ? {} : { email: {
+				subject: rendered.rendered.subject,
+				preheader: rendered.rendered.preheader,
+				html: rendered.rendered.html,
+				text: rendered.rendered.text
+			} },
+			...sms?.ok === true && sms.channel === "sms" ? { sms: sms.text } : {},
+			...whatsapp?.ok === true && whatsapp.channel === "whatsapp" ? { whatsapp: whatsapp.message } : {},
+			diagnostics
+		};
 	});
-	const build = async () => {
-		server.moduleGraph.invalidateAll();
-		const themeCss = await readProjectThemeCss(themePath);
-		const files = await discoverTemplateFiles(templatesDir);
-		const sourceFiles = await readEmailProject(root);
-		const themeFile = themePath === void 0 ? void 0 : projectThemePath(root, themePath);
-		const brandResolution = await brands.resolve(themeFile === void 0 || themeCss === void 0 ? sourceFiles : {
-			...sourceFiles,
-			[themeFile]: themeCss
-		}, themeFile);
-		const brand = brandResolution.ok ? brandResolution.brand : void 0;
-		const brandFindings = brandDiagnostics(brandResolution);
-		if (emailRenderer !== void 0 && (themeCss !== previousTheme || brand?.digest !== previousBrand)) {
-			await emailRenderer.close();
-			emailRenderer = void 0;
-		}
-		previousTheme = themeCss;
-		previousBrand = brand?.digest;
-		emailRenderer?.invalidate();
-		const entries = [];
-		const emailIds = /* @__PURE__ */ new Map();
-		for (const file of files) {
-			const evaluated = await server.ssrLoadModule(file.path).then((moduleExports) => ({
-				ok: true,
-				moduleExports
-			}), (cause) => ({
-				ok: false,
-				cause
-			}));
-			if (!evaluated.ok) {
-				entries.push({
-					id: file.id,
-					kind: file.kind,
-					preview: emailFailure(evaluated.cause)
-				});
-				continue;
-			}
-			const definition = evaluated.moduleExports.default;
-			if (definition === void 0) continue;
-			if (isTemplateDefinition(definition)) {
-				const entryPath = relative(root, file.path).split(sep).join("/");
-				const previous = emailIds.get(definition.id);
-				if (previous !== void 0) {
-					entries.push({
-						id: file.id,
-						kind: file.kind,
-						preview: emailFailure(`Duplicate template id ${definition.id}: ${previous} and ${file.id}`, "duplicate-template-id")
-					});
-					continue;
-				}
-				emailIds.set(definition.id, file.id);
-				const preview = await (async () => {
-					emailRenderer ??= await createEmailRenderer({
-						assetBase: options.assetBase ?? "",
-						...themeCss === void 0 || themeFile === void 0 ? {} : { tailwind: {
-							css: themeCss,
-							cssPath: themeFile
-						} },
-						...brand === void 0 ? {} : { brand }
-					});
-					const loaded = await emailRenderer.load(sourceFiles, entryPath, entryPath);
-					const template = loaded.template;
-					if (!isTemplateDefinition(template)) return emailFailure(`${file.id} does not export defineEmail`);
-					const fixtures = renderEmailFixtures({
-						id: template.id,
-						entryPath,
-						definition: template,
-						loaded
-					}).map((fixture) => ({
-						name: fixture.fixture,
-						input: template.fixtures[fixture.fixture],
-						ok: fixture.rendered !== void 0 && !fixture.diagnostics.some((finding) => finding.severity === "error"),
-						...fixture.rendered === void 0 ? {} : {
-							subject: fixture.rendered.subject,
-							preheader: fixture.rendered.preheader,
-							html: fixture.rendered.html,
-							text: fixture.rendered.text
-						},
-						diagnostics: fixture.diagnostics
-					}));
-					const diagnostics = [...brandFindings, ...loaded.compiled.diagnostics];
-					if (fixtures.length === 0) diagnostics.push(emailFinding("missing-fixtures", `${template.id} must declare at least one fixture for check and build.`));
-					if (loaded.compiled.assets.length > 0 && options.assetBase === void 0) diagnostics.push(emailFinding("missing-asset-base", "Imported email assets require --asset-base with their HTTPS serving origin."));
-					if (loaded.compiled.assets.length > 0 && options.assetBase !== void 0 && !/^https:\/\//i.test(options.assetBase)) diagnostics.push(emailFinding("invalid-asset-base", "Email check and build require an HTTPS --asset-base; relative URLs belong to templates export."));
-					const ok = !diagnostics.some((finding) => finding.severity === "error") && fixtures.every((fixture) => fixture.ok);
-					return {
-						kind: "email",
-						ok,
-						compilerVersion: COMPILER_VERSION,
-						diagnostics,
-						templates: [{
-							name: template.id,
-							channel: "email",
-							ok,
-							source: String(sourceFiles[entryPath]),
-							inputSchema: template.schema.schema,
-							compiled: loaded.compiled,
-							fixtures
-						}]
-					};
-				})().catch((cause) => {
-					const failure = emailFailure(cause);
-					return {
-						...failure,
-						diagnostics: [...brandFindings, ...failure.diagnostics]
-					};
-				});
-				entries.push({
-					id: file.id,
-					kind: file.kind,
-					preview
-				});
-				continue;
-			}
-			const preview = emitModulePreview(parse(file.id).name, evaluated.moduleExports);
-			if (preview.templates.length === 0) continue;
-			if (preview.templates.some((template) => /^\s*<Email(?:\s|>)/.test(template.source ?? ""))) entries.push({
-				id: file.id,
-				kind: file.kind,
-				preview: emailFailure(`${file.id}: email templates must default-export defineEmail with an input schema and fixtures.`, "email-requires-object-template")
-			});
-			else entries.push({
-				id: file.id,
-				kind: file.kind,
-				preview: {
-					...preview,
-					kind: "structured"
-				}
-			});
-		}
-		return { files: entries };
+	const compatibility = emailCompatibility(entry, email);
+	const diagnostics = [...entry.diagnostics, ...assetFindings(entry, assetBase)];
+	const ok = !hasErrors(diagnostics) && !hasErrors(compatibility) && fixtures.every((fixture) => fixture.ok);
+	const template = {
+		template: entry.id,
+		channels: entry.channels,
+		ok,
+		source: entry.entryPath,
+		inputSchema: entry.ir.schema,
+		ir: entry.ir,
+		fixtures,
+		diagnostics,
+		compatibility
 	};
-	const fileEvents = /* @__PURE__ */ new Set([
-		"add",
-		"change",
-		"unlink"
-	]);
-	const subscribe = (listener) => {
-		const onChange = (event, path) => {
-			if (fileEvents.has(event)) listener(path);
-		};
-		server.watcher.on("all", onChange);
-		return () => server.watcher.off("all", onChange);
+	return {
+		id: entry.entryPath,
+		kind: "tsx",
+		ok,
+		template,
+		diagnostics
 	};
+};
+const summarize = (project, assetBase) => {
+	const built = project.catalog.templates.map((entry) => buildEntry(entry, assetBase));
+	const failed = project.catalog.failures.map((entry) => ({
+		id: entry.entryPath,
+		kind: "tsx",
+		ok: false,
+		diagnostics: entry.diagnostics
+	}));
+	const files = [...built, ...failed].sort((left, right) => left.id < right.id ? -1 : 1);
+	return {
+		compilerVersion: COMPILER,
+		files,
+		diagnostics: project.diagnostics,
+		ok: !hasErrors(project.diagnostics) && files.every((file) => file.ok)
+	};
+};
+/**
+* Compile every template in a project and render every fixture it declares
+* through each of its channels, then check the email fixtures against the
+* client matrix. Nothing is evaluated.
+*/
+const buildTemplates = async (options = {}) => summarize(await loadProject(withCompileBase(options)), options.assetBase);
+/** A watcher and compiler over a project, for `check --watch`. */
+const createTemplateBuildSession = (options = {}) => {
+	const session = createProjectSession(withCompileBase(options));
+	let closed = false;
 	return {
-		build,
-		subscribe,
+		build: async () => summarize(await session.load(), options.assetBase),
+		subscribe: session.subscribe,
 		close: async () => {
 			if (closed) return;
 			closed = true;
-			try {
-				await emailRenderer?.close();
-			} finally {
-				await server.close();
-			}
+			await session.close();
 		}
 	};
 };
-const createEvaluator = async (root) => {
-	const vite = await import("vite").catch(() => void 0);
-	if (vite === void 0) throw new Error("`vite` is required for template authoring. Install it as a dev dependency.");
-	return vite.createServer({
-		root,
-		configFile: false,
-		logLevel: "silent",
-		server: {
-			middlewareMode: true,
-			hmr: false
-		},
-		oxc: { jsx: {
-			runtime: "automatic",
-			importSource: "@samva/markup"
-		} },
-		optimizeDeps: {
-			noDiscovery: true,
-			include: []
-		}
-	});
-};
 //#endregion
-export { buildTemplates, createTemplateBuildSession };
+export { COMPILER, buildTemplates, createTemplateBuildSession };
 
 //# sourceMappingURL=build.js.map

package/dist/dev.d.ts

@@ -0,0 +1,22 @@
+//#region src/dev.d.ts
+interface DevServerOptions {
+  /** The project root. Default: the working directory. */
+  readonly root?: string | undefined;
+  /** The templates directory, relative to `root`. Default: `templates/` and `emails/`, whichever exist. */
+  readonly dir?: string | undefined;
+  readonly port?: number | undefined;
+  /** The interface to listen on. Default: loopback only. */
+  readonly host?: string | undefined;
+  /** Open the editor in a browser once the server is listening. */
+  readonly open?: boolean | undefined;
+}
+interface DevServer {
+  /** Where the editor is served. */
+  readonly url: string;
+  readonly close: () => Promise<void>;
+}
+/** Start the local editor for a template project. */
+declare const startDevServer: (options?: DevServerOptions) => Promise<DevServer>;
+//#endregion
+export { DevServer, DevServerOptions, startDevServer };
+//# sourceMappingURL=dev.d.ts.map

package/dist/dev.js

@@ -0,0 +1,43 @@
+import { t as samvaEditor } from "./editor-Cow7zZ_9.js";
+import { resolve } from "node:path";
+//#region src/dev.ts
+/** Start the local editor for a template project. */
+const startDevServer = async (options = {}) => {
+	const vite = await import("vite").catch(() => void 0);
+	if (vite === void 0) throw new Error("`vite` is required for the template dev server. Install it as a dev dependency.");
+	const root = resolve(options.root ?? process.cwd());
+	const server = await vite.createServer({
+		root,
+		configFile: false,
+		appType: "custom",
+		optimizeDeps: {
+			noDiscovery: true,
+			include: []
+		},
+		server: {
+			...options.port === void 0 ? {} : { port: options.port },
+			...options.host === void 0 ? {} : { host: options.host },
+			open: options.open === true
+		},
+		plugins: [samvaEditor({ ...options.dir === void 0 ? {} : { templatesDir: options.dir } })]
+	});
+	try {
+		await server.listen();
+	} catch (cause) {
+		await server.close();
+		throw cause;
+	}
+	const url = server.resolvedUrls?.local[0] ?? server.resolvedUrls?.network[0];
+	if (url === void 0) {
+		await server.close();
+		throw new Error("The template dev server started without a URL.");
+	}
+	return {
+		url,
+		close: () => server.close()
+	};
+};
+//#endregion
+export { startDevServer };
+
+//# sourceMappingURL=dev.js.map