@formicoidea/labre-framework-uml 0.42.0

package/dist/xmi.d.ts

@@ -0,0 +1,61 @@
+import { type UmlModel } from './model.js';
+/**
+ * The diagrams as an **XMI 2.5.1 document** — the interchange file every UML
+ * tool reads.
+ *
+ * ## Which XMI, exactly
+ *
+ * The one a 2016 UML tool writes and reads, and the three strings that say so
+ * (Annex E of UML 2.5.1 gives the namespaces; the XMI version is XMI 2.5.1's
+ * own):
+ *
+ *  - `xmi:version="20131001"` with `xmlns:xmi="http://www.omg.org/spec/XMI/20131001"`;
+ *  - `xmlns:uml="http://www.omg.org/spec/UML/20161101"` — the UML 2.5.1
+ *    metamodel namespace;
+ *  - `PrimitiveTypes.xmi` under the same base, which is where `String`,
+ *    `Integer`, `Boolean`, `Real` and `UnlimitedNatural` live.
+ *
+ * Getting these wrong is the difference between a file Papyrus opens and a file
+ * it refuses, which is why they are constants with a citation rather than
+ * literals in a template.
+ *
+ * ## No diagram interchange
+ *
+ * Not one coordinate is written. UML's DI is a second metamodel with its own
+ * namespace, and every tool lays a model out its own way on import anyway — so a
+ * half-DI would be a promise the file cannot keep, and a full one is a chantier
+ * of its own. What the file carries is the MODEL: the classifiers, their
+ * features, and the relationships between them. The picture stays in Labre.
+ *
+ * The one thing geometry still decides is CONTAINMENT — which package a class is
+ * drawn inside, which subject a use case sits in — because on a UML diagram that
+ * is not layout, it is the statement (§12.2.4, §18.1.4).
+ *
+ * ## Deterministic ids
+ *
+ * `_1`, `_2`, … minted in document order, never a hash and never a random id:
+ * the same model exports to the same bytes, so a golden test is a diff and a
+ * re-export is not a spurious change in someone's version control.
+ *
+ * ## Pure
+ *
+ * A model in, a string out. No `std`, no DOM, no clock — `docs/adr/0012` P3.
+ */
+export declare const XMI_VERSION = "20131001";
+export declare const XMI_NAMESPACE = "http://www.omg.org/spec/XMI/20131001";
+export declare const UML_NAMESPACE = "http://www.omg.org/spec/UML/20161101";
+export declare const UML_PRIMITIVE_TYPES = "http://www.omg.org/spec/UML/20161101/PrimitiveTypes.xmi";
+export interface UmlXmiOptions {
+    /** The `uml:Model`'s own name — the caller's document name. */
+    name?: string;
+}
+/**
+ * Every diagram as one XMI document — one `uml:Model`, one package per diagram.
+ *
+ * A LIST rather than a single model, because that is what the format wants: XMI
+ * carries a whole model, and four sheets of one architecture are four packages
+ * of it, not four files. Exporting one diagram is `exportXmi([model])` and
+ * produces the same shape, which is what keeps a one-diagram file and a
+ * four-diagram file readable by the same importer.
+ */
+export declare function exportXmi(models: readonly UmlModel[], options?: UmlXmiOptions): string;