yarramate 1.30.1 → 1.32.0

package/dist/adapters/likec4-cli.js

@@ -9,9 +9,8 @@ import { isMainModule, resolveCliWorkspaceSources, versionResult, } from '../cli
 import { deriveChangedSubjects } from '../changed.js';
 import { compileWorkspace } from '../compiler.js';
 import { adapterMappingLocation, loadAdapterMapping, validateAdapterMapping, } from '../adapter-mapping.js';
-import { locateSourcePath } from '../source-document.js';
 import { prepareLikeC4Export, } from './likec4-prepare.js';
-import { exportLikeC4Project, loadLikeC4ProjectDefinition, } from './likec4-project.js';
+import { exportLikeC4ProjectFromSources, inputDigestsOf, ownershipOf, projectNameOf, } from './likec4-project-export.js';
 import generatedProjectSchema from '../../schema/yarramate-likec4-generated-project.schema.json' with { type: 'json'
 };
 import generatedProjectV2Schema from '../../schema/yarramate-likec4-generated-project-v2.schema.json' with { type: 'json'
@@ -515,9 +514,6 @@ const checkGeneratedProject = (cwd, outputDirectory, input) => {
         stderr: '',
     };
 };
-const inputDigestsOf = (inputs) => Object.fromEntries(inputs
-    .map(({ path, source }) => [path, sha256(source)])
-    .sort(([left], [right]) => left.localeCompare(right)));
 export function runLikeC4Cli(args, cwd = process.cwd()) {
     if (args[0] === '--version') {
         return versionResult('yarramate-likec4');
@@ -653,286 +649,10 @@ export function runLikeC4Cli(args, cwd = process.cwd()) {
                 path: projectionPath,
                 source: readFileSync(resolve(cwd, projectionPath), 'utf8'),
             };
-            const loadedProject = loadLikeC4ProjectDefinition(projectSource);
-            if (!loadedProject.ok) {
-                return {
-                    exitCode: 1,
-                    stdout: diagnosticOutput(loadedProject.diagnostics),
-                    stderr: '',
-                };
-            }
             const projectDirectory = dirname(resolve(cwd, projectionPath));
-            const referencedSources = new Map();
-            const referenceDiagnostics = [];
-            const readProjectReference = (path, label, yamlPath, pointer) => {
-                const existing = referencedSources.get(path);
-                if (existing !== undefined)
-                    return existing;
-                try {
-                    const source = {
-                        path,
-                        source: readFileSync(resolve(projectDirectory, path), 'utf8'),
-                    };
-                    referencedSources.set(path, source);
-                    return source;
-                }
-                catch (error) {
-                    const location = locateSourcePath(projectSource.path, loadedProject.document.yaml, loadedProject.document.lineCounter, yamlPath, pointer);
-                    const absent = error instanceof Error &&
-                        'code' in error &&
-                        error.code === 'ENOENT';
-                    referenceDiagnostics.push({
-                        severity: 'error',
-                        code: 'YMLC110',
-                        message: absent
-                            ? `LikeC4 project ${label} "${path}" does not exist`
-                            : `LikeC4 project ${label} "${path}" cannot be read`,
-                        ...location,
-                    });
-                    return undefined;
-                }
-            };
-            const subjectMapping = readProjectReference(loadedProject.document.value.mapping, 'mapping', ['mapping'], '/mapping');
-            const kindMapping = loadedProject.document.value.kindMapping === undefined
-                ? undefined
-                : readProjectReference(loadedProject.document.value.kindMapping, 'kind mapping', ['kindMapping'], '/kindMapping');
-            const projections = loadedProject.document.value.views.map((view, index) => readProjectReference(view.projection, 'projection', ['views', index, 'projection'], `/views/${index}/projection`));
-            if (referenceDiagnostics.length > 0 ||
-                subjectMapping === undefined) {
-                return {
-                    exitCode: 1,
-                    stdout: diagnosticOutput(referenceDiagnostics.sort((left, right) => left.path.localeCompare(right.path) ||
-                        left.line - right.line ||
-                        left.column - right.column ||
-                        left.code.localeCompare(right.code) ||
-                        left.message.localeCompare(right.message))),
-                    stderr: '',
-                };
-            }
-            const preparedViews = loadedProject.document.value.views.map((view, index) => ({
-                view,
-                prepared: prepareLikeC4Export({
-                    sources,
-                    projection: projections[index],
-                    subjectMapping,
-                    ...(loadedProject.document.value.kindMapping === undefined
-                        ? {}
-                        : {
-                            kindMapping: kindMapping,
-                        }),
-                    ...(view.compare === undefined
-                        ? {}
-                        : { comparison: view.compare }),
-                    vocabulary: 'bundled',
-                    requireMappedRelationships: command === 'check',
-                }),
-            }));
-            const failed = preparedViews.find(({ prepared }) => !prepared.ok);
-            if (failed !== undefined && !failed.prepared.ok) {
-                return {
-                    exitCode: 1,
-                    stdout: diagnosticOutput(failed.prepared.diagnostics),
-                    stderr: '',
-                };
-            }
-            const successfulViews = preparedViews.flatMap(({ view, prepared }) => prepared.ok
-                ? [
-                    {
-                        ...(view.id === undefined ? {} : { id: view.id }),
-                        ...(view.folder === undefined
-                            ? {}
-                            : { folder: view.folder }),
-                        prepared,
-                        ...(view.compare === undefined
-                            ? {}
-                            : { comparison: view.compare }),
-                        ...(view.dynamic === undefined
-                            ? {}
-                            : { dynamic: view.dynamic }),
-                        ...(view.deployment === undefined
-                            ? {}
-                            : { deployment: view.deployment }),
-                    },
-                ]
-                : []);
-            const renderedViewIds = new Set();
-            const deploymentIdentities = new Set();
-            for (const [index, view] of successfulViews.entries()) {
-                const deployment = view.deployment;
-                if (deployment !== undefined) {
-                    const nodeIds = new Set();
-                    for (const [nodeIndex, node] of deployment.nodes.entries()) {
-                        const problem = nodeIds.has(node.id)
-                            ? `Deployment node "${node.id}" is duplicated`
-                            : deploymentIdentities.has(node.id)
-                                ? `Deployment identity "${node.id}" is duplicated`
-                                : node.parent === node.id
-                                    ? `Deployment node "${node.id}" cannot parent itself`
-                                    : undefined;
-                        if (problem !== undefined) {
-                            const field = nodeIds.has(node.id) || deploymentIdentities.has(node.id)
-                                ? 'id'
-                                : 'parent';
-                            const pointer = `/views/${index}/deployment/nodes/${nodeIndex}/${field}`;
-                            const location = locateSourcePath(projectSource.path, loadedProject.document.yaml, loadedProject.document.lineCounter, ['views', index, 'deployment', 'nodes', nodeIndex, field], pointer);
-                            return {
-                                exitCode: 1,
-                                stdout: diagnosticOutput([{
-                                        severity: 'error',
-                                        code: 'YMLC109',
-                                        message: problem,
-                                        ...location,
-                                    }]),
-                                stderr: '',
-                            };
-                        }
-                        nodeIds.add(node.id);
-                        deploymentIdentities.add(node.id);
-                    }
-                    for (const [nodeIndex, node] of deployment.nodes.entries()) {
-                        if (node.parent !== undefined &&
-                            !nodeIds.has(node.parent)) {
-                            const pointer = `/views/${index}/deployment/nodes/${nodeIndex}/parent`;
-                            const location = locateSourcePath(projectSource.path, loadedProject.document.yaml, loadedProject.document.lineCounter, [
-                                'views',
-                                index,
-                                'deployment',
-                                'nodes',
-                                nodeIndex,
-                                'parent',
-                            ], pointer);
-                            return {
-                                exitCode: 1,
-                                stdout: diagnosticOutput([{
-                                        severity: 'error',
-                                        code: 'YMLC109',
-                                        message: `Deployment parent "${node.parent}" does not exist`,
-                                        ...location,
-                                    }]),
-                                stderr: '',
-                            };
-                        }
-                        const nodeById = new Map(deployment.nodes.map((candidate) => [
-                            candidate.id,
-                            candidate,
-                        ]));
-                        const ancestors = new Set([node.id]);
-                        let parent = node.parent;
-                        while (parent !== undefined) {
-                            if (ancestors.has(parent)) {
-                                const pointer = `/views/${index}/deployment/nodes/${nodeIndex}/parent`;
-                                const location = locateSourcePath(projectSource.path, loadedProject.document.yaml, loadedProject.document.lineCounter, [
-                                    'views',
-                                    index,
-                                    'deployment',
-                                    'nodes',
-                                    nodeIndex,
-                                    'parent',
-                                ], pointer);
-                                return {
-                                    exitCode: 1,
-                                    stdout: diagnosticOutput([{
-                                            severity: 'error',
-                                            code: 'YMLC109',
-                                            message: `Deployment node "${node.id}" participates in a parent cycle`,
-                                            ...location,
-                                        }]),
-                                    stderr: '',
-                                };
-                            }
-                            ancestors.add(parent);
-                            parent = nodeById.get(parent)?.parent;
-                        }
-                    }
-                    const instanceIds = new Set();
-                    for (const [instanceIndex, instance] of (deployment.instances).entries()) {
-                        const projected = view.prepared.projection.subjects.find(({ id }) => id === instance.subject);
-                        const problem = instanceIds.has(instance.id)
-                            ? `Deployment instance "${instance.id}" is duplicated`
-                            : deploymentIdentities.has(instance.id)
-                                ? `Deployment identity "${instance.id}" is duplicated`
-                                : !nodeIds.has(instance.node)
-                                    ? `Deployment instance node "${instance.node}" does not exist`
-                                    : projected?.type !== 'concept'
-                                        ? `Deployment instance subject "${instance.subject}" is not selected as a concept by its projection`
-                                        : undefined;
-                        if (problem !== undefined) {
-                            const field = instanceIds.has(instance.id) ||
-                                deploymentIdentities.has(instance.id)
-                                ? 'id'
-                                : !nodeIds.has(instance.node)
-                                    ? 'node'
-                                    : 'subject';
-                            const pointer = `/views/${index}/deployment/instances/${instanceIndex}/${field}`;
-                            const location = locateSourcePath(projectSource.path, loadedProject.document.yaml, loadedProject.document.lineCounter, [
-                                'views',
-                                index,
-                                'deployment',
-                                'instances',
-                                instanceIndex,
-                                field,
-                            ], pointer);
-                            return {
-                                exitCode: 1,
-                                stdout: diagnosticOutput([{
-                                        severity: 'error',
-                                        code: 'YMLC109',
-                                        message: problem,
-                                        ...location,
-                                    }]),
-                                stderr: '',
-                            };
-                        }
-                        instanceIds.add(instance.id);
-                        deploymentIdentities.add(instance.id);
-                    }
-                }
-                for (const [stepIndex, step] of (view.dynamic?.steps ?? []).entries()) {
-                    const projected = view.prepared.projection.subjects.find(({ id }) => id === step.relationship);
-                    if (projected?.type !== 'relationship') {
-                        const pointer = `/views/${index}/dynamic/steps/${stepIndex}/relationship`;
-                        const location = locateSourcePath(projectSource.path, loadedProject.document.yaml, loadedProject.document.lineCounter, [
-                            'views',
-                            index,
-                            'dynamic',
-                            'steps',
-                            stepIndex,
-                            'relationship',
-                        ], pointer);
-                        return {
-                            exitCode: 1,
-                            stdout: diagnosticOutput([
-                                {
-                                    severity: 'error',
-                                    code: 'YMLC108',
-                                    message: `Dynamic step relationship "${step.relationship}" is not selected as a relationship by its projection`,
-                                    ...location,
-                                },
-                            ]),
-                            stderr: '',
-                        };
-                    }
-                }
-                const renderedId = view.id ?? view.prepared.projection.projection.split('@')[0];
-                if (renderedViewIds.has(renderedId)) {
-                    const field = view.id === undefined ? 'projection' : 'id';
-                    const pointer = `/views/${index}/${field}`;
-                    const location = locateSourcePath(projectSource.path, loadedProject.document.yaml, loadedProject.document.lineCounter, ['views', index, field], pointer);
-                    return {
-                        exitCode: 1,
-                        stdout: diagnosticOutput([
-                            {
-                                severity: 'error',
-                                code: 'YMLC107',
-                                message: `LikeC4 view identity "${renderedId}" is duplicated`,
-                                ...location,
-                            },
-                        ]),
-                        stderr: '',
-                    };
-                }
-                renderedViewIds.add(renderedId);
-            }
+            // The git-derived review overlay is the CLI's own: it needs a
+            // repository. Everything after it runs the same pure pipeline the
+            // path-free entry runs (ADR 0156).
             let gitChange;
             if (changedRange !== undefined) {
                 const modelDocuments = sources.flatMap((candidate) => {
@@ -958,7 +678,23 @@ export function runLikeC4Cli(args, cwd = process.cwd()) {
                     modified: all.filter((id) => !derived.changed.added.includes(id)),
                 };
             }
-            const exported = exportLikeC4Project(loadedProject.document.value, successfulViews, gitChange === undefined ? {} : { gitChange });
+            const exported = exportLikeC4ProjectFromSources({
+                project: projectSource,
+                sources,
+                readReference: (path) => {
+                    try {
+                        return {
+                            path,
+                            source: readFileSync(resolve(projectDirectory, path), 'utf8'),
+                        };
+                    }
+                    catch {
+                        return undefined;
+                    }
+                },
+                requireMappedRelationships: command === 'check',
+                ...(gitChange === undefined ? {} : { gitChange }),
+            });
             if (!exported.ok) {
                 return {
                     exitCode: 1,
@@ -967,51 +703,26 @@ export function runLikeC4Cli(args, cwd = process.cwd()) {
                 };
             }
             if (command === 'check') {
-                const identity = `${loadedProject.document.value.id}@${loadedProject.document.value.version}`;
                 return {
                     exitCode: 0,
                     stdout: json
                         ? checkJson(true, [])
-                        : `Checked LikeC4 project ${identity}: no errors\n`,
+                        : `Checked LikeC4 project ${exported.projectIdentity}: no errors\n`,
                     stderr: '',
                 };
             }
-            const first = successfulViews[0];
-            const mappingIdentity = `${first.prepared.subjectMapping.id}@${first.prepared.subjectMapping.version}`;
-            const kindMappingIdentity = first.prepared.kindMapping === undefined
-                ? undefined
-                : `${first.prepared.kindMapping.id}@${first.prepared.kindMapping.version}`;
-            const projectIdentity = `${loadedProject.document.value.id}@${loadedProject.document.value.version}`;
-            const inputDigests = inputDigestsOf([
-                projectSource,
-                ...sources,
-                ...referencedSources.values(),
-            ]);
+            const inputDigests = inputDigestsOf(exported.inputs);
             if (checkFreshness) {
                 return checkGeneratedProject(cwd, outputDirectory, {
-                    modelSource: exported.source,
+                    modelSource: exported.modelSource,
                     inputDigests,
                 });
             }
             return publishGeneratedProject(cwd, outputDirectory, {
-                projectName: `yarramate-${projectIdentity}`.replaceAll(/[^A-Za-z0-9_-]/g, '-'),
-                title: loadedProject.document.value.title,
-                modelSource: exported.source,
-                ownership: {
-                    format: 'yarramate/likec4-generated-project/v2',
-                    project: projectIdentity,
-                    mapping: mappingIdentity,
-                    ...(kindMappingIdentity === undefined
-                        ? {}
-                        : { kindMapping: kindMappingIdentity }),
-                    views: successfulViews.map(({ id, prepared, comparison }) => ({
-                        ...(id === undefined ? {} : { id }),
-                        projection: prepared.projection.projection,
-                        ...(comparison === undefined
-                            ? {}
-                            : { comparison }),
-                    })),
-                },
+                projectName: projectNameOf(exported.projectIdentity),
+                title: exported.project.title,
+                modelSource: exported.modelSource,
+                ownership: { ...ownershipOf(exported) },
                 inputDigests,
             });
         }

package/dist/adapters/likec4-export.d.ts

@@ -1,4 +1,5 @@
 import { type AdapterMapping } from '../adapter-mapping.js';
+import { type Branding } from '../branding.js';
 import type { StateComparison } from '../architecture-state.js';
 import type { ProjectionResult } from '../projection.js';
 import type { LikeC4KindMapping } from './likec4-kind-mapping.js';
@@ -21,6 +22,8 @@ export type LikeC4ExportResult = {
 };
 export interface LikeC4ExportOptions {
     readonly comparison?: StateComparison;
+    /** The banner names the host's product (#546, ADR 0158); absent, the engine. */
+    readonly branding?: Branding;
     /** Git-derived review overlay (ADR 0066): subjects new or changed in a
      *  ref range carry metadata and view styling; nothing is authored. */
     readonly gitChange?: GitChangeOverlay;

package/dist/adapters/likec4-export.js

@@ -1,4 +1,5 @@
 import { adapterMappingEntryLocation, adapterMappingLocation, } from '../adapter-mapping.js';
+import { resolveBranding } from '../branding.js';
 import { diagnosticOrder } from '../source-document.js';
 const identifier = /^[A-Za-z_][A-Za-z0-9_-]*$/;
 const valueFor = (claims, subject, predicate) => {
@@ -114,8 +115,10 @@ export function exportLikeC4(projection, mapping, kindMapping, options = {}) {
             diagnostics: diagnostics.sort(diagnosticOrder),
         };
     }
+    const brand = resolveBranding(options.branding);
     const lines = [
-        '// Generated by YarraMate. Edit the native documents, not this file.',
+        `// Generated by ${brand.productName}. Edit the native documents, not this file.`,
+        ...(brand.vendorLine === null ? [] : [`// ${brand.vendorLine}`]),
         'model {',
     ];
     for (const concept of concepts) {

package/dist/adapters/likec4-project-export.d.ts

@@ -0,0 +1,83 @@
+import type { WorkspaceSource } from '../compiler.js';
+import { type Branding } from '../branding.js';
+import { type LikeC4PreparationDiagnostic } from './likec4-prepare.js';
+import type { GitChangeOverlay } from './likec4-export.js';
+import { type LikeC4ProjectDefinition, type PreparedLikeC4ProjectView } from './likec4-project.js';
+/**
+ * A LikeC4 project definition to a generated project, with no filesystem
+ * (ADR 0156). `yarramate-likec4 export-project` reads the definition and
+ * the files it names from disk, runs this, and writes what comes back;
+ * `yarramate/tools` reads them from a store and hands the files to whoever
+ * asked. The checks between preparation and export (deployment nodes,
+ * dynamic steps, duplicate view identities) live here so both callers
+ * refuse the same definitions with the same diagnostics.
+ */
+export interface LikeC4ProjectExportInput {
+    /** The `yarramate/likec4-project/v1` document. */
+    readonly project: WorkspaceSource;
+    /** The workspace's compiler sources: profiles, patterns, documents. */
+    readonly sources: readonly WorkspaceSource[];
+    /**
+     * The mapping, kind mapping and projections the definition names, by the
+     * path written in the definition (relative to its directory). `undefined`
+     * for one the caller cannot find is reported as YMLC110.
+     */
+    readonly readReference: (path: string) => WorkspaceSource | undefined;
+    /** `check` refuses relationships the mapping does not cover; `export` does not. */
+    readonly requireMappedRelationships: boolean;
+    /** The git-derived review overlay, when the CLI derived one. */
+    readonly gitChange?: GitChangeOverlay;
+    /**
+     * The host's branding (#546, ADR 0158): the model banner and the project
+     * name in `likec4.config.json`. The marker file and its digests are
+     * machinery and keep their names.
+     */
+    readonly branding?: Branding;
+}
+export interface LikeC4ProjectExported {
+    readonly ok: true;
+    readonly project: LikeC4ProjectDefinition;
+    readonly views: readonly PreparedLikeC4ProjectView[];
+    /** The `model.likec4` text. */
+    readonly modelSource: string;
+    readonly projectIdentity: string;
+    readonly mappingIdentity: string;
+    readonly kindMappingIdentity?: string;
+    /** Every source that fed the export, for the marker's input digests. */
+    readonly inputs: readonly WorkspaceSource[];
+    /** Echoed from the input so `generatedProjectFiles` names the project for it. */
+    readonly branding?: Branding;
+}
+export type LikeC4ProjectExportResult = LikeC4ProjectExported | {
+    readonly ok: false;
+    readonly diagnostics: readonly LikeC4PreparationDiagnostic[];
+};
+export declare const exportLikeC4ProjectFromSources: (input: LikeC4ProjectExportInput) => LikeC4ProjectExportResult;
+export declare const GENERATED_FILE_NAMES: readonly ['likec4.config.json', 'model.likec4', 'specification.likec4'];
+/** The ownership marker's fields, minus the digests this module computes. */
+export interface GeneratedProjectOwnership {
+    readonly format: 'yarramate/likec4-generated-project/v2';
+    readonly project: string;
+    readonly mapping: string;
+    readonly kindMapping?: string;
+    readonly views: readonly {
+        readonly id?: string;
+        readonly projection: string;
+        readonly comparison?: {
+            readonly from: string;
+            readonly to: string;
+        };
+    }[];
+}
+export declare const ownershipOf: (exported: LikeC4ProjectExported) => GeneratedProjectOwnership;
+export declare const inputDigestsOf: (inputs: readonly WorkspaceSource[]) => Readonly<Record<string, string>>;
+export declare const projectNameOf: (projectIdentity: string, branding?: Branding) => string;
+/**
+ * The four files a generated project holds, exactly as the CLI writes them
+ * under its output directory: the config, the model, the specification the
+ * package ships, and the `yarramate.generated.json` marker with every
+ * digest the freshness check reads back.
+ */
+export declare const generatedProjectFiles: (exported: LikeC4ProjectExported) => readonly WorkspaceSource[];
+/** Whether a source is a project definition rather than a projection. */
+export declare const isLikeC4ProjectDefinition: (source: string) => boolean;