@nowline/embed 0.2.5 → 0.4.1

package/src/pipeline.ts

@@ -1,20 +1,28 @@
-// Render pipeline shared by `nowline.render(source)` and the auto-scan
-// path. Mirrors the shape of `packages/vscode-extension/src/preview/
-// render-pipeline.ts` but stripped of every Node-only dependency: no
-// `fs`, no `path`, no asset resolver. Includes are resolved against a
-// no-op `readFile` so a file containing `include "./other.nowline"`
-// renders the parts that survive without a network fetch.
+// Thin shim around `@nowline/browser`'s pipeline. The browser package
+// owns parse / resolveIncludes / layout / render; the embed layers two
+// embed-specific behaviours on top:
+//
+//  - Throws `EmbedRenderError` on failure instead of returning a
+//    discriminated union. The Mermaid-compatible `nowline.render(source)`
+//    surface promises a string; throwing matches the documented v1
+//    contract and keeps the auto-scan path's per-block error handling
+//    simple.
+//  - Latches a once-per-page-load `console.warn` the first time an
+//    `include` directive is encountered. The browser pipeline emits a
+//    structured callback for each skip; the embed converts that into a
+//    single, deduped user-visible message.
 
 import {
-    createNowlineServices,
-    type NowlineFile,
-    type NowlineServices,
-    resolveIncludes,
-} from '@nowline/core';
-import { layoutRoadmap, type ThemeName } from '@nowline/layout';
-import { renderSvg } from '@nowline/renderer';
-import { URI } from 'langium';
-import { isNoOpIncludeDiagnosticMessage, noOpIncludeReadFile } from './no-op-include-resolver.js';
+    __resetBrowserPipelineForTests,
+    type RenderOptions as BrowserRenderOptions,
+    parseSource as browserParseSource,
+    renderSource as browserRenderSource,
+    type DiagnosticRow,
+    type ParseResult,
+} from '@nowline/browser';
+import type { ThemeName } from '@nowline/layout';
+
+const EMBED_SOURCE_PATH = '/embed.nowline';
 
 export interface EmbedRenderOptions {
     theme?: ThemeName;
@@ -31,96 +39,52 @@ export interface EmbedRenderOptions {
 }
 
 export interface EmbedParseResult {
-    ast: NowlineFile;
+    ast: ParseResult['ast'];
     /** Lexer + parser + Langium validation diagnostics, normalized to strings. */
     errors: string[];
 }
 
-interface CachedServices {
-    shared: ReturnType<typeof createNowlineServices>['shared'];
-    Nowline: NowlineServices;
-}
-
-let cachedServices: CachedServices | undefined;
-let docCounter = 0;
 let includeWarningEmitted = false;
 
-function getServices(): CachedServices {
-    if (!cachedServices) cachedServices = createNowlineServices();
-    return cachedServices;
-}
-
-function freshUri(): URI {
-    return URI.parse(`memory:///nowline-embed-${++docCounter}.nowline`);
-}
-
 export async function parseSource(source: string): Promise<EmbedParseResult> {
-    const services = getServices();
-    const docFactory = services.shared.workspace.LangiumDocumentFactory;
-    const doc = docFactory.fromString<NowlineFile>(source, freshUri());
-    await services.shared.workspace.DocumentBuilder.build([doc], { validation: true });
-
-    const errors: string[] = [];
-    for (const e of doc.parseResult.lexerErrors) errors.push(e.message);
-    for (const e of doc.parseResult.parserErrors) errors.push(e.message);
-    for (const d of doc.diagnostics ?? []) {
-        if (d.severity === 1) errors.push(d.message);
-    }
-    return { ast: doc.parseResult.value, errors };
+    const { ast, diagnostics } = await browserParseSource(source, {
+        filePath: EMBED_SOURCE_PATH,
+    });
+    return {
+        ast,
+        errors: diagnostics
+            .filter((d: DiagnosticRow) => d.severity === 'error')
+            .map((d) => d.message),
+    };
 }
 
 export async function renderSource(
     source: string,
     options: EmbedRenderOptions = {},
 ): Promise<string> {
-    const parsed = await parseSource(source);
-    if (parsed.errors.length > 0) {
-        throw new EmbedRenderError(
-            `Failed to parse Nowline source: ${parsed.errors.join('; ')}`,
-            parsed.errors,
-        );
-    }
-
-    const services = getServices();
-    const resolved = await resolveIncludes(parsed.ast, '/embed.nowline', {
-        services: services.Nowline,
-        readFile: noOpIncludeReadFile,
-    });
-
-    let sawIncludeWarning = false;
-    const blockingErrors: string[] = [];
-    for (const diag of resolved.diagnostics) {
-        if (diag.severity !== 'error') continue;
-        if (isNoOpIncludeDiagnosticMessage(diag.message)) {
-            sawIncludeWarning = true;
-            continue;
-        }
-        blockingErrors.push(diag.message);
-    }
-    if (blockingErrors.length > 0) {
-        throw new EmbedRenderError(
-            `Failed to resolve Nowline source: ${blockingErrors.join('; ')}`,
-            blockingErrors,
-        );
-    }
-    if (sawIncludeWarning && !includeWarningEmitted) {
-        includeWarningEmitted = true;
-        console.warn(
-            'nowline: `include` directives are skipped in the browser embed (single-file mode). ' +
-                'Render multi-file roadmaps with the CLI or the GitHub Action.',
-        );
-    }
-
-    const model = layoutRoadmap(parsed.ast, resolved, {
+    const browserOptions: BrowserRenderOptions = {
+        filePath: EMBED_SOURCE_PATH,
         theme: options.theme,
         today: options.today,
         locale: options.locale,
         width: options.width,
-    });
-
-    return renderSvg(model, {
         idPrefix: options.idPrefix,
-    });
+        onSkippedInclude: () => {
+            if (!includeWarningEmitted) {
+                includeWarningEmitted = true;
+                console.warn(
+                    'nowline: `include` directives are skipped in the browser embed (single-file mode). ' +
+                        'Render multi-file roadmaps with the CLI or the GitHub Action.',
+                );
+            }
+        },
+    };
+
+    const result = await browserRenderSource(source, browserOptions);
+    if (result.kind === 'svg') return result.svg;
+
+    const messages = result.diagnostics.filter((d) => d.severity === 'error').map((d) => d.message);
+    throw new EmbedRenderError(`Failed to render Nowline source: ${messages.join('; ')}`, messages);
 }
 
 export class EmbedRenderError extends Error {
@@ -138,6 +102,5 @@ export class EmbedRenderError extends Error {
 // reset the latch between cases.
 export function __resetEmbedPipelineForTests(): void {
     includeWarningEmitted = false;
-    cachedServices = undefined;
-    docCounter = 0;
+    __resetBrowserPipelineForTests();
 }

package/dist/no-op-include-resolver.d.ts

@@ -1,4 +0,0 @@
-export declare const NOWLINE_EMBED_NOOP_INCLUDE_TAG = "__nowline_embed_noop_include__";
-export declare function noOpIncludeReadFile(absPath: string): Promise<string>;
-export declare function isNoOpIncludeDiagnosticMessage(message: string): boolean;
-//# sourceMappingURL=no-op-include-resolver.d.ts.map

package/dist/no-op-include-resolver.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"no-op-include-resolver.d.ts","sourceRoot":"","sources":["../src/no-op-include-resolver.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,8BAA8B,mCAAmC,CAAC;AAE/E,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAI1E;AAED,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAEvE"}

package/dist/no-op-include-resolver.js

@@ -1,18 +0,0 @@
-// Browser-side `readFile` that always rejects with a stable, sniff-able
-// error. The render pipeline catches matching diagnostics and converts
-// them into a single `console.warn` (deduped), so authors notice when
-// they ship a file with `include` directives that the embed cannot
-// satisfy without a network fetch.
-//
-// A real HTTP-fetch resolver is intentionally out of scope for m4 (see
-// `specs/handoffs/handoff-m4-embed.md`): CORS, relative-URL semantics,
-// and waterfall performance each warrant their own decision and are
-// best handled behind an opt-in flag in a follow-up.
-export const NOWLINE_EMBED_NOOP_INCLUDE_TAG = '__nowline_embed_noop_include__';
-export async function noOpIncludeReadFile(absPath) {
-    throw new Error(`${NOWLINE_EMBED_NOOP_INCLUDE_TAG}: include "${absPath}" was skipped — the embed runs in single-file mode.`);
-}
-export function isNoOpIncludeDiagnosticMessage(message) {
-    return message.includes(NOWLINE_EMBED_NOOP_INCLUDE_TAG);
-}
-//# sourceMappingURL=no-op-include-resolver.js.map

package/dist/no-op-include-resolver.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"no-op-include-resolver.js","sourceRoot":"","sources":["../src/no-op-include-resolver.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,uEAAuE;AACvE,sEAAsE;AACtE,mEAAmE;AACnE,mCAAmC;AACnC,EAAE;AACF,uEAAuE;AACvE,uEAAuE;AACvE,oEAAoE;AACpE,qDAAqD;AAErD,MAAM,CAAC,MAAM,8BAA8B,GAAG,gCAAgC,CAAC;AAE/E,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,OAAe;IACrD,MAAM,IAAI,KAAK,CACX,GAAG,8BAA8B,cAAc,OAAO,qDAAqD,CAC9G,CAAC;AACN,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,OAAe;IAC1D,OAAO,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC;AAC5D,CAAC"}

package/src/no-op-include-resolver.ts

@@ -1,22 +0,0 @@
-// Browser-side `readFile` that always rejects with a stable, sniff-able
-// error. The render pipeline catches matching diagnostics and converts
-// them into a single `console.warn` (deduped), so authors notice when
-// they ship a file with `include` directives that the embed cannot
-// satisfy without a network fetch.
-//
-// A real HTTP-fetch resolver is intentionally out of scope for m4 (see
-// `specs/handoffs/handoff-m4-embed.md`): CORS, relative-URL semantics,
-// and waterfall performance each warrant their own decision and are
-// best handled behind an opt-in flag in a follow-up.
-
-export const NOWLINE_EMBED_NOOP_INCLUDE_TAG = '__nowline_embed_noop_include__';
-
-export async function noOpIncludeReadFile(absPath: string): Promise<string> {
-    throw new Error(
-        `${NOWLINE_EMBED_NOOP_INCLUDE_TAG}: include "${absPath}" was skipped — the embed runs in single-file mode.`,
-    );
-}
-
-export function isNoOpIncludeDiagnosticMessage(message: string): boolean {
-    return message.includes(NOWLINE_EMBED_NOOP_INCLUDE_TAG);
-}