@likec4/core 1.32.1 → 1.33.0

package/dist/shared/core.Dy-F3xRP.d.mts

@@ -0,0 +1,83 @@
+import { C as Connection, c as customInspectSymbol } from './core.CeQbbp7K.mjs';
+import { E as ElementModel, R as RelationshipModel } from './core.OLInHaJx.mjs';
+import { A as Any, U as Unknown, B as EdgeId } from './core.De___iBS.mjs';
+
+/**
+ * Connection refers to any relationships between two elements,
+ * both direct and implicit ones (between their nested elements).
+ *
+ * Merges relationships together to an single edge on the diagram.
+ */
+declare class ConnectionModel<A extends Any = Unknown> implements Connection<ElementModel<A>, EdgeId> {
+    readonly source: ElementModel<A>;
+    readonly target: ElementModel<A>;
+    readonly relations: ReadonlySet<RelationshipModel<A>>;
+    readonly id: EdgeId;
+    constructor(source: ElementModel<A>, target: ElementModel<A>, relations?: ReadonlySet<RelationshipModel<A>>);
+    private _boundary;
+    /**
+     * Common ancestor of the source and target elements.
+     * Represents the boundary of the connection.
+     */
+    get boundary(): ElementModel<A> | null;
+    /**
+     * Human readable expression of the connection
+     * Mostly used for testing and debugging
+     */
+    get expression(): string;
+    /**
+     * Returns true if only includes relations between the source and target elements.
+     */
+    get isDirect(): boolean;
+    /**
+     * Returns true if includes relations between nested elements of the source and target elements.
+     */
+    get isImplicit(): boolean;
+    get directRelations(): ReadonlySet<RelationshipModel<A>>;
+    nonEmpty(): boolean;
+    mergeWith(other: ConnectionModel<A>): ConnectionModel<A>;
+    difference(other: ConnectionModel<A>): ConnectionModel<A>;
+    intersect(other: ConnectionModel<A>): ConnectionModel<A>;
+    equals(other: Connection): boolean;
+    /**
+     * Returns a new instance with the updated relations.
+     *
+     * @param relations - A readonly set of `RelationshipModel` instances representing the new relations.
+     * @returns A new `ConnectionModel` instance with the updated relations.
+     */
+    update(relations: ReadonlySet<RelationshipModel<A>>): ConnectionModel<A>;
+    [customInspectSymbol](depth: any, inspectOptions: any, inspect: any): string;
+    toString(): string;
+    /**
+     * Creates a new connection with reversed direction (target becomes source and vice versa)
+     * @param search - When true, attempts to find an existing connection between the reversed nodes
+     */
+    reversed(search?: boolean): ConnectionModel<A>;
+}
+
+/**
+ * Resolve connection from source to target
+ *
+ * @param direction - if 'both', also returns connection from target to source
+ * @default `directed`
+ */
+declare function findConnection<A extends Any>(source: ElementModel<A>, target: ElementModel<A>, direction?: 'directed' | 'both'): [ConnectionModel<A>, ConnectionModel<A>] | [ConnectionModel<A>] | [];
+/**
+ * Resolve all connections between element and others
+ * @param direction - if 'directed', only look for outgoing connections from the element to others
+ * @default `both`
+ */
+declare function findConnectionsBetween<M extends Any>(element: ElementModel<M>, others: Iterable<ElementModel<M>>, direction?: 'directed' | 'both'): readonly ConnectionModel<M>[];
+/**
+ * Resolve all connections within a given set of elements
+ */
+declare function findConnectionsWithin<M extends Any>(elements: Iterable<ElementModel<M>>): readonly ConnectionModel<M>[];
+
+declare const find_findConnection: typeof findConnection;
+declare const find_findConnectionsBetween: typeof findConnectionsBetween;
+declare const find_findConnectionsWithin: typeof findConnectionsWithin;
+declare namespace find {
+  export { find_findConnection as findConnection, find_findConnectionsBetween as findConnectionsBetween, find_findConnectionsWithin as findConnectionsWithin };
+}
+
+export { ConnectionModel as C, findConnection as a, findConnectionsBetween as b, findConnectionsWithin as c, find as f };

package/dist/shared/{core.znRaUX_A.d.mts → core.OLInHaJx.d.mts}

@@ -1,32 +1,30 @@
-import { A as Any, T as Tags, R as RelationKind, j as Metadata, k as MetadataKey, L as LooseTag, F as Fqn, g as ElementId, l as ElementKind, D as DeploymentKind, E as ExtractOnStage, m as RelationId$1, f as _type, n as StrictViewId, o as LooseElementId, p as LooseDeploymentId, q as DeploymentFqn, t as toComputed, r as toLayouted, s as Stage, u as DeploymentId, U as Unknown, V as ViewId, v as Tag, w as toParsed, P as ProjectId$1, x as LooseViewId, b as Aux, S as SpecAux, e as UnknownParsed, c as UnknownComputed, d as UnknownLayouted } from './core.BaYE_r29.mjs';
+import { A as Any, R as RelationKind, T as Tags, h as Metadata, j as MetadataKey, L as LooseTag, F as Fqn, g as ElementId, k as ElementKind, D as DeploymentKind, E as ExtractOnStage, l as RelationId$1, f as _type, m as StrictViewId, n as LooseElementId, o as LooseDeploymentId, p as DeploymentFqn, t as toComputed, q as toLayouted, r as Stage, s as DeploymentId, U as Unknown, V as ViewId, u as Tag, v as toParsed, P as ProjectId$1, w as LooseViewId, b as Aux, S as SpecAux, e as UnknownParsed, c as UnknownComputed, d as UnknownLayouted } from './core.De___iBS.mjs';
 import { D as DefaultMap } from './core.CywrQs86.mjs';
 import { SetRequired } from 'type-fest';
-import { az as Color, av as RelationshipLineType, Y as Relationship, O as Element, ar as ElementShape, N as ElementStyle, aM as ViewWithType, aI as ComputedView, aG as LayoutedView, k as ParsedLikeC4ModelData, l as ComputedLikeC4ModelData, m as LayoutedLikeC4ModelData, b8 as ViewType, c as FqnRef, p as DeployedInstance, D as DeploymentElementStyle, u as DeploymentRelationship, q as DeploymentElement, o as DeploymentNode, x as LikeC4ModelDump, y as AuxFromDump, a2 as Specification, j as ModelGlobals, ah as WhereOperator } from './core.DXzRBkuI.mjs';
-import { I as IteratorLike, R as RelationId, L as Link, P as ProjectId, j as IconUrl, N as NodeId, G as GroupElementKind, E as EdgeId, p as StepEdgeId, V as ViewId$1 } from './core.BuO4ncfY.mjs';
+import { d as RelationId, P as ProjectId, a as IconUrl, N as NodeId, G as GroupElementKind, j as EdgeId, k as StepEdgeId, V as ViewId$1 } from './core.668kXpZq.mjs';
+import { b as RichTextOrEmpty, Y as Relationship, Q as Element, O as ElementStyle, as as ViewWithType, ao as ComputedView, am as LayoutedView, n as ParsedLikeC4ModelData, C as ComputedLikeC4ModelData, L as LayoutedLikeC4ModelData, f as FqnRef, q as DeployedInstance, D as DeploymentElementStyle, v as DeploymentRelationship, r as DeploymentElement, p as DeploymentNode, y as LikeC4ModelDump, z as AuxFromDump, a2 as Specification, m as ModelGlobals, ah as WhereOperator } from './core.1pNeDdRk.mjs';
+import { I as IteratorLike, L as Link } from './core.DuSLYTG6.mjs';
+import { i as Color, R as RelationshipLineType, c as ElementShape } from './core.CzdwsPmY.mjs';
 
 type RelationshipsIterator<A extends Any> = IteratorLike<RelationshipModel<A>>;
 /**
  * A relationship between two elements (in logical or deployment model)
  * use {@link isDeploymentRelationModel} guard to check if the relationship is a deployment relationship
  */
-interface AnyRelationshipModel<A extends Any> {
-    get id(): RelationId;
-    get expression(): string;
-    get title(): string | null;
-    get technology(): string | null;
-    get description(): string | null;
-    get navigateTo(): LikeC4ViewModel<A> | null;
-    get tags(): Tags<A>;
-    get kind(): RelationKind<A> | null;
-    get links(): ReadonlyArray<Link>;
-    get color(): Color;
-    get line(): RelationshipLineType;
+interface AnyRelationshipModel<A extends Any> extends WithTags<A>, WithMetadata<A> {
+    readonly id: RelationId;
+    readonly expression: string;
+    readonly title: string | null;
+    readonly technology: string | null;
+    readonly description: RichTextOrEmpty;
+    readonly navigateTo: LikeC4ViewModel<A> | null;
+    readonly kind: RelationKind<A> | null;
+    readonly links: ReadonlyArray<Link>;
+    readonly color: Color;
+    readonly line: RelationshipLineType;
     isDeploymentRelation(): this is DeploymentRelationModel<A>;
     isModelRelation(): this is RelationshipModel<A>;
-    getMetadata(): Metadata<A>;
-    getMetadata(field: MetadataKey<A>): string | undefined;
     views(): ViewsIterator<A>;
-    isTagged(tag: LooseTag<A>): boolean;
 }
 declare class RelationshipModel<A extends Any = Any> implements AnyRelationshipModel<A> {
     readonly model: LikeC4Model<A>;
@@ -43,7 +41,7 @@ declare class RelationshipModel<A extends Any = Any> implements AnyRelationshipM
     get expression(): string;
     get title(): string | null;
     get technology(): string | null;
-    get description(): string | null;
+    get description(): RichTextOrEmpty;
     get navigateTo(): LikeC4ViewModel<A> | null;
     get tags(): Tags<A>;
     get kind(): RelationKind<A> | null;
@@ -56,6 +54,7 @@ declare class RelationshipModel<A extends Any = Any> implements AnyRelationshipM
     views(): ViewsIterator<A>;
     isDeploymentRelation(): this is DeploymentRelationModel<A>;
     isModelRelation(): this is RelationshipModel<A>;
+    hasMetadata(): boolean;
     getMetadata(): Metadata<A>;
     getMetadata(field: MetadataKey<A>): string | undefined;
     /**
@@ -65,7 +64,7 @@ declare class RelationshipModel<A extends Any = Any> implements AnyRelationshipM
 }
 
 type ElementsIterator<M extends Any> = IteratorLike<ElementModel<M>>;
-declare class ElementModel<A extends Any = Any> {
+declare class ElementModel<A extends Any = Any> implements WithTags<A>, WithMetadata<A> {
     readonly $model: LikeC4Model<A>;
     readonly $element: Element<A>;
     readonly id: Fqn<A>;
@@ -87,12 +86,10 @@ declare class ElementModel<A extends Any = Any> {
      */
     get tags(): Tags<A>;
     get title(): string;
-    get description(): string | null;
+    get description(): RichTextOrEmpty;
     get technology(): string | null;
     get links(): ReadonlyArray<Link>;
-    get defaultView(): LikeC4ViewModel<A, $ViewWithType<A, 'element'> & {
-        viewOf: Fqn<A>;
-    }> | null;
+    get defaultView(): LikeC4ViewModel.ScopedElementView<A> | null;
     get isRoot(): boolean;
     get style(): SetRequired<ElementStyle, 'size'>;
     isAncestorOf(another: ElementModel<A>): boolean;
@@ -139,14 +136,13 @@ declare class ElementModel<A extends Any = Any> {
      * Iterate over all views that scope this element.
      * It is possible that element is not included in the view.
      */
-    scopedViews(): ReadonlySet<LikeC4ViewModel<A, $ViewWithType<A, 'element'> & {
-        viewOf: Fqn<A>;
-    }>>;
+    scopedViews(): ReadonlySet<LikeC4ViewModel.ScopedElementView<A>>;
     /**
      * @returns true if the element is deployed
      */
     isDeployed(): boolean;
     deployments(): DeployedInstancesIterator<A>;
+    hasMetadata(): boolean;
     getMetadata(): Metadata<A>;
     getMetadata(field: MetadataKey<A>): string | undefined;
     /**
@@ -156,7 +152,7 @@ declare class ElementModel<A extends Any = Any> {
 }
 
 type NodesIterator<M extends Any, V extends $View<M>> = IteratorLike<NodeModel<M, V>>;
-declare class NodeModel<A extends Any = Any, V extends $View<A> = $View<A>> {
+declare class NodeModel<A extends Any = Any, V extends $View<A> = $View<A>> implements WithTags<A> {
     #private;
     readonly $view: LikeC4ViewModel<A, V>;
     readonly $node: V['nodes'][number];
@@ -164,7 +160,7 @@ declare class NodeModel<A extends Any = Any, V extends $View<A> = $View<A>> {
     get id(): NodeId;
     get title(): string;
     get kind(): ElementKind<A> | DeploymentKind<A> | typeof GroupElementKind | 'instance';
-    get description(): string | null;
+    get description(): RichTextOrEmpty;
     get technology(): string | null;
     get parent(): NodeModel<A, V> | null;
     get element(): ElementModel<A> | null;
@@ -234,7 +230,7 @@ declare namespace NodeModel {
 }
 
 type EdgesIterator<A extends Any, V extends $View<A>> = IteratorLike<EdgeModel<A, V>>;
-declare class EdgeModel<A extends Any = Any, View extends $View<A> = $View<A>> {
+declare class EdgeModel<A extends Any = Any, View extends $View<A> = $View<A>> implements WithTags<A> {
     #private;
     readonly view: LikeC4ViewModel<A, View>;
     readonly $edge: View['edges'][number];
@@ -244,7 +240,7 @@ declare class EdgeModel<A extends Any = Any, View extends $View<A> = $View<A>> {
     get id(): EdgeId;
     get parent(): NodeModel<A, View> | null;
     get label(): string | null;
-    get description(): string | null;
+    get description(): RichTextOrEmpty;
     get technology(): string | null;
     hasParent(): this is EdgeModel.WithParent<A, View>;
     get tags(): Tags<A>;
@@ -272,7 +268,7 @@ declare namespace EdgeModel {
 }
 
 type ViewsIterator<A extends Any, V extends $View<A> = $View<A>> = IteratorLike<LikeC4ViewModel<A, V>>;
-declare class LikeC4ViewModel<A extends Any = Any, V extends $View<A> = $View<A>> {
+declare class LikeC4ViewModel<A extends Any = Any, V extends $View<A> = $View<A>> implements WithTags<A> {
     #private;
     /**
      * Don't use in runtime, only for type inference
@@ -284,6 +280,7 @@ declare class LikeC4ViewModel<A extends Any = Any, V extends $View<A> = $View<A>
     get _type(): V[_type];
     get id(): StrictViewId<A>;
     get title(): string | null;
+    get description(): RichTextOrEmpty;
     get tags(): Tags<A>;
     get links(): ReadonlyArray<Link>;
     get viewOf(): ElementModel<A> | null;
@@ -350,14 +347,14 @@ declare class LikeC4ViewModel<A extends Any = Any, V extends $View<A> = $View<A>
     isComputed(this: LikeC4ViewModel<any, any>): this is LikeC4ViewModel<toComputed<A>>;
     isDiagram(this: LikeC4ViewModel<any, any>): this is LikeC4ViewModel<toLayouted<A>>;
     isElementView(this: LikeC4ViewModel<any, any>): this is LikeC4ViewModel.ElementView<A, V>;
-    isScopedElementView(this: LikeC4ViewModel<any, any>): this is LikeC4ViewModel.ScopedElementView<A, V>;
+    isScopedElementView(this: LikeC4ViewModel<any, any>): this is LikeC4ViewModel.ScopedElementView<A>;
     isDeploymentView(this: LikeC4ViewModel<any, any>): this is LikeC4ViewModel.DeploymentView<A, V>;
     isDynamicView(this: LikeC4ViewModel<any, any>): this is LikeC4ViewModel.DynamicView<A, V>;
 }
 declare namespace LikeC4ViewModel {
     interface ElementView<A extends Any, V extends $View<A> = $View<A>> extends LikeC4ViewModel<A, ViewWithType<V, 'element'>> {
     }
-    interface ScopedElementView<A extends Any, V extends $View<A> = $View<A>> extends LikeC4ViewModel<A, ViewWithType<V, 'element'> & {
+    interface ScopedElementView<A extends Any> extends LikeC4ViewModel<A, ViewWithType<$View<A>, 'element'> & {
         viewOf: Fqn<A>;
     }> {
         viewOf: ElementModel<A>;
@@ -390,7 +387,6 @@ type $View<A extends Any> = {
     computed: ComputedView<A>;
     layouted: LayoutedView<A>;
 }[Stage<A>];
-type $ViewWithType<A extends Any, V extends ViewType> = ViewWithType<$View<A>, V>;
 type $ViewModel<A extends Any> = {
     parsed: never;
     computed: LikeC4ViewModel<A>;
@@ -401,6 +397,15 @@ type $ModelData<A extends Any> = {
     computed: ComputedLikeC4ModelData<A>;
     layouted: LayoutedLikeC4ModelData<A>;
 }[Stage<A>];
+interface WithTags<A extends Any> {
+    get tags(): Tags<A>;
+    isTagged(tag: LooseTag<A>): boolean;
+}
+interface WithMetadata<A extends Any> {
+    hasMetadata(): boolean;
+    getMetadata(): Metadata<A>;
+    getMetadata(field: MetadataKey<A>): string | undefined;
+}
 
 declare class LikeC4DeploymentModel<A extends Any = Any> {
     #private;
@@ -486,7 +491,7 @@ type DeploymentElementsIterator<A extends Any> = IteratorLike<DeploymentElementM
 type DeployedInstancesIterator<A extends Any> = IteratorLike<DeployedInstanceModel<A>>;
 type DeploymentNodesIterator<A extends Any> = IteratorLike<DeploymentNodeModel<A>>;
 type DeploymentElementModel<A extends Any = Any> = DeploymentNodeModel<A> | DeployedInstanceModel<A>;
-declare abstract class AbstractDeploymentElementModel<A extends Any> {
+declare abstract class AbstractDeploymentElementModel<A extends Any> implements WithTags<A>, WithMetadata<A> {
     abstract readonly id: DeploymentFqn<A>;
     abstract readonly _literalId: DeploymentId<A>;
     abstract readonly parent: DeploymentNodeModel<A> | null;
@@ -498,7 +503,7 @@ declare abstract class AbstractDeploymentElementModel<A extends Any> {
     get style(): SetRequired<DeploymentElementStyle, 'shape' | 'color' | 'size'>;
     get shape(): ElementShape;
     get color(): Color;
-    get description(): string | null;
+    get description(): RichTextOrEmpty;
     get technology(): string | null;
     get links(): ReadonlyArray<Link>;
     /**
@@ -542,6 +547,7 @@ declare abstract class AbstractDeploymentElementModel<A extends Any> {
     abstract incomingModelRelationships(): RelationshipsIterator<A>;
     get allOutgoing(): RelationshipsAccum<A>;
     get allIncoming(): RelationshipsAccum<A>;
+    hasMetadata(): boolean;
     getMetadata(): Metadata<A>;
     getMetadata(field: MetadataKey<A>): string | undefined;
     /**
@@ -606,7 +612,7 @@ declare class DeployedInstanceModel<A extends Any = Any> extends AbstractDeploym
     get color(): Color;
     get tags(): Tags<A>;
     get kind(): ElementKind<A>;
-    get description(): string | null;
+    get description(): RichTextOrEmpty;
     get technology(): string | null;
     get links(): ReadonlyArray<Link>;
     isInstance(): this is DeployedInstanceModel<A>;
@@ -628,7 +634,7 @@ declare class NestedElementOfDeployedInstanceModel<A extends Any = Any> {
     get shape(): ElementShape;
     get color(): Color;
     get title(): string;
-    get description(): string | null;
+    get description(): RichTextOrEmpty;
     get technology(): string | null;
     isDeploymentNode(): this is DeploymentNodeModel<A>;
     isInstance(): this is DeployedInstanceModel<A>;
@@ -645,7 +651,7 @@ declare class DeploymentRelationModel<A extends Any = Any> implements AnyRelatio
     get expression(): string;
     get title(): string | null;
     get technology(): string | null;
-    get description(): string | null;
+    get description(): RichTextOrEmpty;
     get tags(): Tags<A>;
     get kind(): RelationKind<A> | null;
     get navigateTo(): LikeC4ViewModel<A> | null;
@@ -655,6 +661,7 @@ declare class DeploymentRelationModel<A extends Any = Any> implements AnyRelatio
     views(): IteratorLike<LikeC4ViewModel.DeploymentView<A>>;
     isDeploymentRelation(): this is DeploymentRelationModel<A>;
     isModelRelation(): this is RelationshipModel<A>;
+    hasMetadata(): boolean;
     getMetadata(): Metadata<A>;
     getMetadata(field: MetadataKey<A>): string | undefined;
     /**
@@ -917,4 +924,4 @@ declare namespace LikeC4Model {
     type AnyRelation<M = Unknown> = M extends Any ? RelationshipModel<M> | DeploymentRelationModel<M> : never;
 }
 
-export { type AnyRelationshipModel as A, type DeploymentElementModel as D, ElementModel as E, type IncomingFilter as I, LikeC4Model as L, NestedElementOfDeployedInstanceModel as N, type OutgoingFilter as O, RelationshipModel as R, RelationshipsAccum as a, DeploymentNodeModel as b, DeploymentRelationModel as c, DeployedInstanceModel as d, LikeC4ViewModel as e, NodeModel as f, EdgeModel as g, type AnyLikeC4Model as h, type DeploymentRelationEndpoint as i, LikeC4DeploymentModel as j, type DeploymentOrFqn as k, type EdgeOrId as l, type ElementOrFqn as m, type NodeOrId as n };
+export { type AnyRelationshipModel as A, DeploymentNodeModel as D, ElementModel as E, type IncomingFilter as I, LikeC4ViewModel as L, NestedElementOfDeployedInstanceModel as N, type OutgoingFilter as O, RelationshipModel as R, type WithMetadata as W, DeployedInstanceModel as a, DeploymentRelationModel as b, NodeModel as c, EdgeModel as d, type DeploymentElementModel as e, type AnyLikeC4Model as f, LikeC4Model as g, type DeploymentRelationEndpoint as h, RelationshipsAccum as i, LikeC4DeploymentModel as j, type DeploymentOrFqn as k, type EdgeOrId as l, type ElementOrFqn as m, type NodeOrId as n, type WithTags as o };