@meltemi/diagrams-model 0.0.0-stage → 1.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Architecture Studio contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,49 @@
-# Temporary Holding Version
+# @meltemi/diagrams-model
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The typed intermediate model of `.meltemi` documents: compilation of the flow, free, sequence
+and C4 profiles, models, stories and export profiles, validation with stable diagnostics, and the
+model JSON interchange format.
+
+It is part of [Meltemi Diagrams](https://github.com/askenaz-dev/meltemi-diagrams#readme), diagrams as code with a canvas, motion and
+exports. Every package of the product has the same version.
+
+## Install
+
+```bash
+npm install @meltemi/diagrams-model
+```
+
+Node 22.12.0 or later. The package is an ES module with type declarations.
+
+## Use
+
+```ts
+import { compile, toJson } from "@meltemi/diagrams-model";
+
+const text = `language "0.2"
+
+diagram shop: flow {
+  web["Web shop"]
+  api["Orders API"]
+  db[("Orders")]
+  web -> api: "HTTPS" as call
+  api -> db: "SQL" as store
+}
+`;
+
+const compilation = compile(text);
+console.log(compilation.diagnostics); // []
+const diagram = compilation.document.diagrams[0]!;
+console.log(diagram.id, diagram.elements.length, diagram.relations.length); // shop 3 2
+console.log(toJson(compilation).format); // the model JSON format name
+```
+
+## Documentation
+
+- [Model JSON](https://github.com/askenaz-dev/meltemi-diagrams/blob/main/docs/language/model-json.md)
+- [Grammar](https://github.com/askenaz-dev/meltemi-diagrams/blob/main/docs/language/grammar-0.2.md)
+- [All documentation](https://github.com/askenaz-dev/meltemi-diagrams/blob/main/docs/README.md)
+
+## Licence
+
+MIT. Third-party components and their licences are listed in [THIRD_PARTY_LICENSES.md](https://github.com/askenaz-dev/meltemi-diagrams/blob/main/THIRD_PARTY_LICENSES.md).

package/dist/c4.d.ts

@@ -0,0 +1,44 @@
+import { type DiagnosticBag, type DiagramBlock, type LineIndex, type QualifiedRef, type Token } from "@meltemi/diagrams-language";
+import { isAncestorPath } from "./model.js";
+import type { C4Level, C4View, EntityKind, EntityReference, FlowDiagram, ModelDefinition, ModelEntity, ResolvedModel } from "./types.js";
+/** The model a view uses, as compile found it. */
+export interface ViewModel {
+    /** The name written after `using`. */
+    readonly name: string;
+    readonly ref: QualifiedRef;
+    /** The model, or null when the name does not resolve. */
+    readonly resolved: ResolvedModel | null;
+    /** True when the name goes through an import that the host did not resolve: stay silent. */
+    readonly pending: boolean;
+}
+/** Analyzes `diagram <id>: c4 using <model> { }` into a view. */
+export declare function analyzeC4View(node: DiagramBlock, id: Token, lines: LineIndex, bag: DiagnosticBag, model: ViewModel): {
+    diagram: FlowDiagram;
+    errors: number;
+};
+/**
+ * The entities a C4 view of a level and scope may draw: persons and systems at the context level;
+ * the scope's containers and datastores, persons and other systems at the container level; the
+ * scope's components, the other containers of its system, persons and other systems at the
+ * component level.
+ */
+export declare function allowedEntities(model: ModelDefinition, level: C4Level, scopePath: string | null): Set<string>;
+/**
+ * The level of the view that opens an entity of a kind: a system opens a container view scoped
+ * to it, a container a component view scoped to it; persons, datastores and components open
+ * nothing.
+ */
+export declare function childLevel(kind: EntityKind): C4Level | null;
+/**
+ * Whether a compiled C4 view is the child view of an entity: it uses the same model (the model's
+ * file and id; `owner` is the view's own file, standing for a model resolved in that file), has
+ * the level `childLevel` gives the entity's kind, and is scoped to the entity. A context view
+ * scoped to a system is not its child view.
+ */
+export declare function isChildView(view: C4View, owner: string | null, model: {
+    readonly file: string | null;
+    readonly id: string;
+}, entity: Pick<ModelEntity, "kind" | "path">): boolean;
+export type { EntityReference };
+export { isAncestorPath };
+//# sourceMappingURL=c4.d.ts.map

package/dist/c4.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"c4.d.ts","sourceRoot":"","sources":["../src/c4.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,aAAa,EAClB,KAAK,YAAY,EAEjB,KAAK,SAAS,EACd,KAAK,YAAY,EAGjB,KAAK,KAAK,EACX,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EAAc,cAAc,EAAE,MAAM,YAAY,CAAC;AAGxD,OAAO,KAAK,EACV,OAAO,EACP,MAAM,EACN,UAAU,EACV,eAAe,EAEf,WAAW,EAEX,eAAe,EACf,WAAW,EAEX,aAAa,EAGd,MAAM,YAAY,CAAC;AAEpB,kDAAkD;AAClD,MAAM,WAAW,SAAS;IACxB,sCAAsC;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC;IAC3B,yDAAyD;IACzD,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IACxC,4FAA4F;IAC5F,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,iEAAiE;AACjE,wBAAgB,aAAa,CAC3B,IAAI,EAAE,YAAY,EAClB,EAAE,EAAE,KAAK,EACT,KAAK,EAAE,SAAS,EAChB,GAAG,EAAE,aAAa,EAClB,KAAK,EAAE,SAAS,GACf;IAAE,OAAO,EAAE,WAAW,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAG1C;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,eAAe,EACtB,KAAK,EAAE,OAAO,EACd,SAAS,EAAE,MAAM,GAAG,IAAI,GACvB,GAAG,CAAC,MAAM,CAAC,CA+Bb;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,GAAG,IAAI,CAI3D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,KAAK,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CAAE,EAC5D,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,GACzC,OAAO,CAMT;AAiyBD,YAAY,EAAE,eAAe,EAAE,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,CAAC"}