@meltemi/diagrams-import 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,40 @@
-# Temporary Holding Version
+# @meltemi/diagrams-import
 
-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.
+Imports Mermaid (`flowchart`, `sequenceDiagram`, `C4*`, `architecture-beta`, `block-beta`) and
+PlantUML (component, deployment, use case, sequence and C4-PlantUML, with the preprocessor) into
+`.meltemi` sheets, with a report that says what was mapped, approximated or dropped, and merges a
+re-import into a sheet that was adjusted since.
+
+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-import
+```
+
+Node 22.12.0 or later. The package is an ES module with type declarations.
+
+## Use
+
+```ts
+import { importText } from "@meltemi/diagrams-import";
+
+const result = importText("flowchart LR\n  shop[Web shop] --> orders[(Orders)]\n");
+console.log(result.status, result.format); // the outcome and "mermaid"
+console.log(result.text); // the .meltemi sheet
+for (const finding of result.findings) console.log(finding);
+```
+
+## Documentation
+
+- [Mermaid coverage](https://github.com/askenaz-dev/meltemi-diagrams/blob/main/docs/import/mermaid.md)
+- [PlantUML coverage](https://github.com/askenaz-dev/meltemi-diagrams/blob/main/docs/import/plantuml.md)
+- [From Mermaid](https://github.com/askenaz-dev/meltemi-diagrams/blob/main/docs/tracks/from-mermaid.md)
+- [From PlantUML](https://github.com/askenaz-dev/meltemi-diagrams/blob/main/docs/tracks/from-plantuml.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,49 @@
+import type { Span } from "@meltemi/diagrams-language";
+import type { FrontContext } from "./front.js";
+import { type CoverageNote } from "./messages/index.js";
+import type { C4Sheet, EntityKind } from "./writer.js";
+export type C4Level = "context" | "container" | "component";
+/** A C4 source line: a macro call, a boundary opening with `{`, or `}`. */
+export interface C4Statement {
+    readonly text: string;
+    readonly span: Span;
+    readonly comments: readonly string[];
+}
+export interface C4Options {
+    /** The level the source states (Mermaid keyword or C4-PlantUML include), if any. */
+    readonly level: C4Level | null;
+    /** Mermaid `C4Dynamic` or C4-PlantUML `C4_Dynamic`. */
+    readonly dynamic: boolean;
+    readonly title?: string;
+    /** The diagram's header, for findings about the whole diagram. */
+    readonly span: Span;
+    /** Prefix for findings: `mermaid.c4` or `plantuml.c4`. */
+    readonly construct: string;
+}
+export interface EntityMacro {
+    kind: EntityKind;
+    external: boolean;
+    /** Positional parameters after alias and label. */
+    params: readonly string[];
+    /**
+     * What the macro loses in the mapping, if anything: the note of the coverage tables that its
+     * finding also reports.
+     */
+    approx?: CoverageNote;
+}
+export declare const ENTITY_MACROS: Readonly<Record<string, EntityMacro>>;
+export declare const BOUNDARY_PARAMS: Readonly<Record<string, readonly string[]>>;
+/** Macros that only style or lay out the picture. */
+export declare const C4_DROPPED_MACROS: ReadonlySet<string>;
+interface ParsedCall {
+    name: string;
+    positional: string[];
+    named: Map<string, string>;
+    opens: boolean;
+}
+/** Reads `Name(a, "b", $x="y") {`. */
+export declare function parseCall(text: string): ParsedCall | null;
+/** Turns C4 macro statements into a model and a view. */
+export declare function readC4(ctx: FrontContext, statements: readonly C4Statement[], options: C4Options): C4Sheet;
+export {};
+//# 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,KAAK,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAY,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,KAAK,EAAwB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE7E,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,WAAW,GAAG,WAAW,CAAC;AAE5D,2EAA2E;AAC3E,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,SAAS;IACxB,oFAAoF;IACpF,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,uDAAuD;IACvD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,kEAAkE;IAClE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B;;;OAGG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAMD,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAwD/D,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAKvE,CAAC;AAKF,qDAAqD;AACrD,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC,MAAM,CA6ChD,CAAC;AAEH,UAAU,UAAU;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,sCAAsC;AACtC,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAWzD;AA0ED,yDAAyD;AACzD,wBAAgB,MAAM,CACpB,GAAG,EAAE,YAAY,EACjB,UAAU,EAAE,SAAS,WAAW,EAAE,EAClC,OAAO,EAAE,SAAS,GACjB,OAAO,CA4LT"}