@samva/vite 0.10.0 → 0.11.0

package/dist/project.d.ts

@@ -1,2 +1,192 @@
-import { A as loadBrandEnv, C as renderChannelFixture, D as BrandSnapshot, E as BrandResolution, F as discoverEntries, I as readProjectFiles, L as templateDirectories, M as DEFAULT_TEMPLATE_DIRS, N as ProjectFiles, O as BrandWarning, P as SAMVA_DIR, S as hasErrors, T as BRAND_SNAPSHOT_DIR, _ as TemplateChannel, a as ProjectOptions, b as emailCompatibility, c as exportProject, d as CompileProjectInput, f as CompiledEntry, g as RenderedFixture, h as RenderedChannel, i as ProjectExportReceipt, j as resolveProjectBrand, k as ResolvedBrand, l as loadProject, m as FailedEntry, n as ExportedFixture, o as ProjectSession, p as CompiledProject, r as LoadedProject, s as createProjectSession, t as DEFAULT_EXPORT_ASSET_BASE, u as projectRoot, v as channelsOf, w as renderEmailFixtures, x as finding, y as compileProject } from "./project-CRqjs-wV.js";
-export { BRAND_SNAPSHOT_DIR, type BrandResolution, type BrandSnapshot, type BrandWarning, CompileProjectInput, CompiledEntry, CompiledProject, DEFAULT_EXPORT_ASSET_BASE, DEFAULT_TEMPLATE_DIRS, ExportedFixture, FailedEntry, LoadedProject, ProjectExportReceipt, type ProjectFiles, ProjectOptions, ProjectSession, RenderedChannel, RenderedFixture, type ResolvedBrand, SAMVA_DIR, TemplateChannel, channelsOf, compileProject, createProjectSession, discoverEntries, emailCompatibility, exportProject, finding, hasErrors, loadBrandEnv, loadProject, projectRoot, readProjectFiles, renderChannelFixture, renderEmailFixtures, resolveProjectBrand, templateDirectories };
+import { a as DEFAULT_TEMPLATE_DIRS, c as discoverEntries, i as ResolvedBrand, l as readProjectFiles, n as BrandResolver, o as ProjectFiles, r as BrandWarning, s as SAMVA_DIR, t as BrandResolution, u as templateDirectories } from "./brand-BkXQMGgY.js";
+import { RenderOptions, RenderedIrEmail, RenderedIrWhatsApp, TemplateIr } from "@samva/markup/render";
+import { AssetEntry, BrandPlugin } from "@samva/markup/brand";
+import { EmailDiagnostic } from "@samva/markup/diagnostics";
+//#region src/compile.d.ts
+type TemplateChannel = "email" | "sms" | "whatsapp";
+/** The channels a compiled template declares, in a fixed order. */
+declare const channelsOf: (ir: TemplateIr) => readonly TemplateChannel[];
+declare const finding: (code: string, severity: EmailDiagnostic["severity"], message: string, extra?: Partial<EmailDiagnostic>) => EmailDiagnostic;
+/** One entry that declares a template and compiled. */
+interface CompiledEntry {
+  /** The identity the definition declares for itself (`ir.template`). */
+  readonly id: string;
+  /** Project-relative path of the authored entry. */
+  readonly entryPath: string;
+  readonly ir: TemplateIr;
+  readonly fixtures: Readonly<Record<string, unknown>>;
+  readonly assets: readonly AssetEntry[];
+  /** Compile warnings. Errors leave no IR, so they are on a `FailedEntry` instead. */
+  readonly diagnostics: readonly EmailDiagnostic[];
+  readonly channels: readonly TemplateChannel[];
+  readonly brandPlugin?: BrandPlugin | undefined;
+}
+/** An entry that is a template but did not compile. */
+interface FailedEntry {
+  readonly entryPath: string;
+  readonly diagnostics: readonly EmailDiagnostic[];
+}
+interface CompiledProject {
+  /** Sorted by id. */
+  readonly templates: readonly CompiledEntry[];
+  /** Entries that declare a template and did not compile, sorted by path. */
+  readonly failures: readonly FailedEntry[];
+  /** Candidate entries that declare no template: ordinary modules, partials and components. */
+  readonly helpers: readonly string[];
+  /** Project-level findings: a duplicate id. */
+  readonly diagnostics: readonly EmailDiagnostic[];
+  /** Every asset the templates import, deduplicated by content. */
+  readonly assets: readonly AssetEntry[];
+}
+interface CompileProjectInput {
+  readonly files: ProjectFiles;
+  /** Candidate entries, project-relative. */
+  readonly entries: readonly string[];
+  /**
+   * Where imported assets are served from. Empty is deliberately invalid for
+   * assets: no invented serving origin. A project that imports none needs none.
+   */
+  readonly assetBase: string;
+  readonly theme?: {
+    readonly css: string;
+    readonly path: string;
+  } | undefined;
+  readonly brand?: ResolvedBrand | undefined;
+  readonly brandPlugin?: BrandPlugin | undefined;
+}
+/**
+ * Compile every candidate entry. An entry the compiler reports `no-template`
+ * for is a helper module, not a template; that is how a partial is told apart
+ * from a template without evaluating either. One failure stays with its entry.
+ */
+declare const compileProject: (input: CompileProjectInput) => Promise<CompiledProject>;
+/** One fixture rendered through the email channel of the template it belongs to. */
+interface RenderedFixture {
+  readonly templateId: string;
+  readonly fixture: string;
+  readonly rendered: RenderedIrEmail | undefined;
+  readonly diagnostics: readonly EmailDiagnostic[];
+}
+/**
+ * Render every fixture a template declares through its email channel. A fixture
+ * the renderer refuses is a finding on that fixture, never a thrown error, so
+ * one bad input does not take the rest of the catalog with it.
+ */
+declare const renderEmailFixtures: (entry: Pick<CompiledEntry, "id" | "ir" | "fixtures" | "brandPlugin">, options?: RenderOptions) => readonly RenderedFixture[];
+/** Client-matrix findings across the fixtures that rendered. */
+declare const emailCompatibility: (entry: Pick<CompiledEntry, "ir" | "fixtures">, rendered: readonly RenderedFixture[]) => readonly EmailDiagnostic[];
+/** A channel's rendered output for one fixture, or the findings that stopped it. */
+type RenderedChannel = {
+  readonly ok: true;
+  readonly channel: "sms";
+  readonly text: string;
+} | {
+  readonly ok: true;
+  readonly channel: "whatsapp";
+  readonly message: RenderedIrWhatsApp;
+} | {
+  readonly ok: false;
+  readonly diagnostics: readonly EmailDiagnostic[];
+};
+/** Render the SMS or WhatsApp channel of one fixture. */
+declare const renderChannelFixture: (entry: Pick<CompiledEntry, "id" | "ir" | "fixtures" | "brandPlugin">, channel: "sms" | "whatsapp", fixture: string, options?: RenderOptions) => RenderedChannel;
+declare const hasErrors: (diagnostics: readonly EmailDiagnostic[]) => boolean;
+//#endregion
+//#region src/project.d.ts
+interface ProjectOptions {
+  /** The project root: `theme.css`, shared imports and `.samva/` live here. Default: the working directory. */
+  readonly root?: string | undefined;
+  /**
+   * The templates directory, relative to `root` (or absolute, inside it). When set, only it is
+   * scanned; otherwise `templates/` and `emails/` are, whichever exist.
+   */
+  readonly dir?: string | undefined;
+  /** Host-owned brand resolution. Brand imports fail when no resolver is supplied. */
+  readonly brandResolver?: BrandResolver | undefined;
+  /** Brand import specifier and footer markers passed to the compiler. */
+  readonly brandPlugin?: BrandPlugin | undefined;
+  /** Theme stylesheet relative to `root`; `false` compiles with no project theme. Default `theme.css`. */
+  readonly theme?: string | false | undefined;
+  /**
+   * Where imported assets are served from. A template that imports none needs none; an import
+   * with no base is a finding.
+   */
+  readonly assetBase?: string | undefined;
+}
+/** A project compiled: its catalog, and the findings about the project as a whole. */
+interface LoadedProject {
+  readonly root: string;
+  readonly files: ProjectFiles;
+  readonly catalog: CompiledProject;
+  /** The theme path, project-relative; `undefined` when theming is off or the file is absent. */
+  readonly themePath: string | undefined;
+  readonly brand: BrandResolution;
+  /** Brand findings and project-level findings (a duplicate id). */
+  readonly diagnostics: readonly EmailDiagnostic[];
+}
+/** Resolve the root a set of options names. */
+declare const projectRoot: (options: Pick<ProjectOptions, "root">) => string;
+/**
+ * Read, resolve the brand of, and compile every template in a project. `only`
+ * limits compilation to the named project-relative entries.
+ */
+declare const loadProject: (options?: ProjectOptions, only?: readonly string[] | undefined) => Promise<LoadedProject>;
+/** A live project over a directory, reloaded when its source changes. */
+interface ProjectSession {
+  readonly load: () => Promise<LoadedProject>;
+  readonly current: () => LoadedProject | undefined;
+  /** Called with the project-relative path of each changed file; `.samva/` and `node_modules` are ignored. */
+  readonly subscribe: (listener: (path: string) => void) => () => void;
+  readonly close: () => Promise<void>;
+}
+/**
+ * The authoring loop: one watcher, one brand resolver, a catalog reloaded on
+ * demand. Each `load` re-reads the project and recompiles every template, so a
+ * partial that changed reaches every template that imports it.
+ */
+declare const createProjectSession: (options?: ProjectOptions) => ProjectSession;
+interface ExportedFixture {
+  readonly fixture: string;
+  readonly html?: string | undefined;
+  readonly text?: string | undefined;
+  readonly sms?: string | undefined;
+  readonly whatsapp?: string | undefined;
+}
+interface ProjectExportReceipt {
+  readonly templates: readonly {
+    readonly id: string;
+    readonly entryPath: string;
+    readonly fixtures: readonly ExportedFixture[];
+  }[];
+  readonly assets: {
+    readonly base: string;
+    readonly assets: readonly AssetEntry[];
+  };
+  readonly diagnostics: readonly EmailDiagnostic[];
+}
+/**
+ * Where an export serves its assets from when the caller names no origin.
+ *
+ * An export writes one page at `templates/<id>/<fixture>.html` and every asset
+ * once at `assets/<content address>`, so the base a page resolves against is
+ * the path from its own directory back to that one. A template id is one path
+ * segment, so every page sits at the same depth and one base serves them all.
+ */
+declare const DEFAULT_EXPORT_ASSET_BASE = "../../assets";
+/**
+ * Render every template's fixtures to files beside the bytes of every asset they
+ * reference, with the manifest that maps each address to its file. Email
+ * fixtures write `<fixture>.html` and `<fixture>.txt`; a template's SMS and
+ * WhatsApp channels write `<fixture>.sms.txt` and `<fixture>.whatsapp.json`.
+ *
+ * A relative `assetBase` is accepted, and the written page resolves its images
+ * from the directory it sits in. Delivery keeps refusing relative references,
+ * because an inbox has no directory to resolve one against, so an export
+ * destined for sending names the https origin it will be served from instead.
+ */
+declare const exportProject: (input: ProjectOptions & {
+  readonly out: string;
+}) => Promise<ProjectExportReceipt>;
+//#endregion
+export { type BrandResolution, type BrandResolver, type BrandWarning, CompileProjectInput, CompiledEntry, CompiledProject, DEFAULT_EXPORT_ASSET_BASE, DEFAULT_TEMPLATE_DIRS, ExportedFixture, FailedEntry, LoadedProject, ProjectExportReceipt, type ProjectFiles, ProjectOptions, ProjectSession, RenderedChannel, RenderedFixture, type ResolvedBrand, SAMVA_DIR, TemplateChannel, channelsOf, compileProject, createProjectSession, discoverEntries, emailCompatibility, exportProject, finding, hasErrors, loadProject, projectRoot, readProjectFiles, renderChannelFixture, renderEmailFixtures, templateDirectories };
+//# sourceMappingURL=project.d.ts.map

package/dist/project.js

@@ -1,2 +1,2 @@
-import { C as discoverEntries, D as readProjectFiles, O as templateDirectories, S as SAMVA_DIR, a as projectRoot, b as resolveProjectBrand, d as emailCompatibility, f as finding, g as BRAND_SNAPSHOT_DIR, h as renderEmailFixtures, i as loadProject, l as channelsOf, m as renderChannelFixture, n as createProjectSession, p as hasErrors, r as exportProject, t as DEFAULT_EXPORT_ASSET_BASE, u as compileProject, x as DEFAULT_TEMPLATE_DIRS, y as loadBrandEnv } from "./project-Ut6wra0r.js";
-export { BRAND_SNAPSHOT_DIR, DEFAULT_EXPORT_ASSET_BASE, DEFAULT_TEMPLATE_DIRS, SAMVA_DIR, channelsOf, compileProject, createProjectSession, discoverEntries, emailCompatibility, exportProject, finding, hasErrors, loadBrandEnv, loadProject, projectRoot, readProjectFiles, renderChannelFixture, renderEmailFixtures, resolveProjectBrand, templateDirectories };
+import { C as renderEmailFixtures, S as renderChannelFixture, _ as channelsOf, a as projectRoot, b as finding, d as discoverEntries, g as templateDirectories, h as readProjectFiles, i as loadProject, l as DEFAULT_TEMPLATE_DIRS, n as createProjectSession, r as exportProject, t as DEFAULT_EXPORT_ASSET_BASE, u as SAMVA_DIR, v as compileProject, x as hasErrors, y as emailCompatibility } from "./project-DwbOoPDk.js";
+export { DEFAULT_EXPORT_ASSET_BASE, DEFAULT_TEMPLATE_DIRS, SAMVA_DIR, channelsOf, compileProject, createProjectSession, discoverEntries, emailCompatibility, exportProject, finding, hasErrors, loadProject, projectRoot, readProjectFiles, renderChannelFixture, renderEmailFixtures, templateDirectories };

package/dist/render.d.ts

@@ -1,4 +1,4 @@
-import { a as ProjectOptions } from "./project-CRqjs-wV.js";
+import { ProjectOptions } from "./project.js";
 import { RenderedIrWhatsApp } from "@samva/markup/render";
 import { EmailDiagnostic } from "@samva/markup/diagnostics";
 //#region src/render.d.ts

package/dist/render.js

@@ -1,9 +1,9 @@
-import { _ as brandDiagnostics, f as finding, h as renderEmailFixtures, i as loadProject, m as renderChannelFixture, p as hasErrors } from "./project-Ut6wra0r.js";
+import { C as renderEmailFixtures, S as renderChannelFixture, b as finding, i as loadProject, w as brandDiagnostics, x as hasErrors } from "./project-DwbOoPDk.js";
 //#region src/render.ts
 /** Compile just enough of the project to find and build the named template. */
 const locate = async (input) => {
 	const byPath = input.template.endsWith(".tsx");
-	const project = await loadProject(input, void 0, byPath ? [input.template.replace(/^\.\//, "")] : void 0);
+	const project = await loadProject(input, byPath ? [input.template.replace(/^\.\//, "")] : void 0);
 	const { catalog } = project;
 	const entry = catalog.templates.find((candidate) => byPath ? candidate.entryPath === input.template.replace(/^\.\//, "") : candidate.id === input.template);
 	const brand = brandDiagnostics(project.brand);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samva/vite",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Local editor, dev server and build for Samva email, SMS and WhatsApp templates",
   "keywords": [
     "email",
@@ -70,15 +70,15 @@
     "test:browser:cross": "turbo run build --filter=@samva/vite && playwright test --config playwright.config.ts"
   },
   "dependencies": {
-    "@samva/markup": "^0.10.0"
+    "@samva/markup": "^0.11.0"
   },
   "devDependencies": {
-    "@effect/vitest": "4.0.0-rc.117",
+    "@effect/vitest": "4.0.0",
     "@playwright/test": "^1.63.0",
     "tsdown": "^0.22.13",
     "typescript": "^7.0.2",
     "vite": "~8.3.0",
-    "vitest": "^4.1.11"
+    "vitest": "^5.0.3"
   },
   "peerDependencies": {
     "vite": "^8.2.2"