@likec4/core 1.17.1 → 1.18.0

package/src/model/LikeC4DiagramModel.ts

@@ -1,338 +0,0 @@
-import { isNullish } from 'remeda'
-import { nonNullable } from '../errors'
-import {
-  type ElementKind as C4ElementKind,
-  type ElementShape as C4ElementShape,
-  type Tag as C4Tag
-} from '../types/element'
-import { DefaultRelationshipColor } from '../types/relation'
-import type { Color as C4Color } from '../types/theme'
-import type { ComputedElementView, DiagramEdge, DiagramNode, DiagramView } from '../types/view'
-import type { LikeC4Model } from './LikeC4Model'
-import { type EdgeId, type ElementOrFqn, type Fqn, getId, type IncomingFilter, type OutgoingFilter } from './types'
-
-/**
- * All methods are view-scoped, i.e. only return elements and connections in the view.
- */
-export class LikeC4DiagramModel {
-  private readonly _rootElements = new Set<LikeC4DiagramModel.Element>()
-
-  private readonly _elements = new Map<Fqn, LikeC4DiagramModel.Element>()
-
-  private readonly _connections: Map<EdgeId, LikeC4DiagramModel.Connection>
-
-  constructor(
-    public readonly view: DiagramView,
-    public readonly model: LikeC4Model.Layouted
-  ) {
-    for (const node of view.nodes) {
-      const el = new LikeC4DiagramModel.Element(node, this)
-      this._elements.set(node.id, el)
-      if (isNullish(node.parent)) {
-        this._rootElements.add(el)
-      }
-    }
-    this._connections = new Map(view.edges.map(e => [e.id, new LikeC4DiagramModel.Connection(e, this)]))
-  }
-
-  get isDynamic() {
-    return this.view.__ === 'dynamic'
-  }
-
-  get id() {
-    return this.view.id
-  }
-
-  get title() {
-    return this.view.title
-  }
-
-  get viewOf() {
-    if (isNullish(this.view.__) || this.view.__ === 'element') {
-      const computedView = this.view as ComputedElementView
-      return computedView.viewOf ? this.model.element(computedView.viewOf) : null
-    }
-    return null
-  }
-
-  get tags(): C4Tag[] {
-    return this.view.tags ?? []
-  }
-
-  public roots(): ReadonlyArray<LikeC4DiagramModel.Element> {
-    return [...this._rootElements]
-  }
-
-  public elements(): ReadonlyArray<LikeC4DiagramModel.Element> {
-    return [...this._elements.values()]
-  }
-
-  public element(id: Fqn): LikeC4DiagramModel.Element {
-    return nonNullable(this._elements.get(id), `LikeC4DiagramModel.Element ${id} in view ${this.view.id} not found`)
-  }
-
-  public hasElement(id: Fqn): boolean {
-    return this._elements.has(id)
-  }
-
-  public connections(): ReadonlyArray<LikeC4DiagramModel.Connection> {
-    return [...this._connections.values()]
-  }
-
-  public connection(id: EdgeId): LikeC4DiagramModel.Connection {
-    return nonNullable(this._connections.get(id), `Connection ${id} in view ${this.view.id}  not found`)
-  }
-
-  public findConnections(
-    source: ElementOrFqn,
-    target: ElementOrFqn,
-    direction: 'both' | 'direct' = 'direct'
-  ): ReadonlyArray<LikeC4DiagramModel.Connection> {
-    const sourceId = getId(source)
-    const targetId = getId(target)
-    return this.connections().filter(c =>
-      (c.source.id === sourceId && c.target.id === targetId)
-      || (direction === 'both' && c.source.id === targetId && c.target.id === sourceId)
-    )
-  }
-
-  public parent(element: ElementOrFqn): LikeC4DiagramModel.Element | null {
-    const el = this.element(getId(element))
-    return el.node.parent ? this.element(el.node.parent) : null
-  }
-
-  public children(element: ElementOrFqn): ReadonlyArray<LikeC4DiagramModel.Element> {
-    const el = this.element(getId(element))
-    return el.node.children.map(c => this.element(c))
-  }
-
-  // Get all sibling (i.e. same parent)
-  public siblings(element: ElementOrFqn): ReadonlyArray<LikeC4DiagramModel.Element> {
-    const id = getId(element)
-    const parent = this.parent(id)
-    const siblings = parent ? this.children(parent) : this.roots()
-    return siblings.filter(e => e.id !== id)
-  }
-
-  /**
-   * Get all ancestor elements (i.e. parent, parent’s parent, etc.)
-   * (from closest to root)
-   */
-  public ancestors(element: ElementOrFqn): ReadonlyArray<LikeC4DiagramModel.Element> {
-    let id = getId(element)
-    const result = [] as LikeC4DiagramModel.Element[]
-    let parent
-    while (parent = this.parent(id)) {
-      result.push(parent)
-      id = parent.id
-    }
-    return result
-  }
-
-  public descendants(element: ElementOrFqn): ReadonlyArray<LikeC4DiagramModel.Element> {
-    const children = this.children(element)
-    return children.flatMap(c => [c, ...this.descendants(c.id)])
-  }
-
-  public incoming(
-    element: ElementOrFqn,
-    filter: IncomingFilter = 'all'
-  ): ReadonlyArray<LikeC4DiagramModel.Connection> {
-    const el = this.element(getId(element))
-    const edges = el.node.inEdges.map(e => this.connection(e))
-
-    if (filter === 'all' || edges.length === 0) {
-      return edges
-    }
-
-    return edges.filter(rel => {
-      if (filter === 'direct') {
-        return rel.target.id === el.id
-      }
-      return rel.target.id !== el.id
-    })
-  }
-
-  public incomers(
-    element: ElementOrFqn,
-    filter: IncomingFilter = 'all'
-  ): ReadonlyArray<LikeC4DiagramModel.Element> {
-    return this.incoming(element, filter).map(r => r.source)
-  }
-
-  /**
-   * Outgoing relationships from the element and its descendants
-   */
-  public outgoing(
-    element: ElementOrFqn,
-    filter: OutgoingFilter = 'all'
-  ): ReadonlyArray<LikeC4DiagramModel.Connection> {
-    const el = this.element(getId(element))
-    const edges = el.node.outEdges.map(e => this.connection(e))
-
-    if (filter === 'all' || edges.length === 0) {
-      return edges
-    }
-
-    return edges.filter(rel => {
-      if (filter === 'direct') {
-        return rel.source.id === el.id
-      }
-      return rel.source.id !== el.id
-    })
-  }
-
-  public outgoers(
-    element: ElementOrFqn,
-    filter: OutgoingFilter = 'all'
-  ): ReadonlyArray<LikeC4DiagramModel.Element> {
-    return this.outgoing(element, filter).map(r => r.target)
-  }
-}
-
-export namespace LikeC4DiagramModel {
-  /**
-   * Represents an element in the view. (Diagram node)
-   * All methods are view-scoped, i.e. `children` returns only children of the element in the view.
-   */
-  export class Element {
-    constructor(
-      public readonly node: DiagramNode,
-      private readonly view: LikeC4DiagramModel
-    ) {
-    }
-
-    get id() {
-      return this.node.id
-    }
-
-    get title() {
-      return this.node.title
-    }
-
-    get kind(): C4ElementKind {
-      return this.node.kind
-    }
-
-    get isRoot(): boolean {
-      return isNullish(this.node.parent)
-    }
-
-    get hasNested(): boolean {
-      return this.node.children.length > 0
-    }
-
-    get shape(): C4ElementShape {
-      return this.node.shape
-    }
-
-    get color(): C4Color {
-      return this.node.color
-    }
-
-    get tags(): C4Tag[] {
-      return this.node.tags ?? []
-    }
-
-    get level(): number {
-      return this.node.level
-    }
-
-    get depth(): number {
-      return this.node.depth ?? 0
-    }
-
-    public model(): LikeC4Model.ElementModel<LikeC4DiagramModel> {
-      return this.view.model.element(this.id)
-    }
-
-    public parent(): LikeC4DiagramModel.Element | null {
-      return this.node.parent ? this.view.element(this.node.parent) : null
-    }
-
-    public metadata(key: string): string | undefined
-    public metadata(key: string, defaultValue: string): string
-    public metadata(key: string, defaultValue?: string): string | undefined {
-      return this.model().metadata(key) ?? defaultValue
-    }
-
-    public hasMetadata(key: string): boolean {
-      return this.model().hasMetadata(key)
-    }
-
-    public ancestors(): ReadonlyArray<LikeC4DiagramModel.Element> {
-      return this.view.ancestors(this)
-    }
-
-    public siblings(): ReadonlyArray<LikeC4DiagramModel.Element> {
-      return this.view.siblings(this)
-    }
-
-    public descendants(): ReadonlyArray<LikeC4DiagramModel.Element> {
-      return this.view.descendants(this)
-    }
-
-    public children(): ReadonlyArray<LikeC4DiagramModel.Element> {
-      return this.view.children(this)
-    }
-
-    public incoming(filter: IncomingFilter = 'all'): ReadonlyArray<LikeC4DiagramModel.Connection> {
-      return this.view.incoming(this, filter)
-    }
-
-    public incomers(filter: IncomingFilter = 'all'): ReadonlyArray<LikeC4DiagramModel.Element> {
-      return this.view.incomers(this, filter)
-    }
-
-    public outgoing(filter: OutgoingFilter = 'all'): ReadonlyArray<LikeC4DiagramModel.Connection> {
-      return this.view.outgoing(this, filter)
-    }
-
-    public outgoers(filter: OutgoingFilter = 'all'): ReadonlyArray<LikeC4DiagramModel.Element> {
-      return this.view.outgoers(this, filter)
-    }
-
-    public connectionsTo(target: Fqn | LikeC4DiagramModel.Element): ReadonlyArray<LikeC4DiagramModel.Connection> {
-      return this.view.findConnections(this, target)
-    }
-  }
-
-  /**
-   * Represents a connection between two elements.
-   * May be source from multiple model relationships.
-   */
-  export class Connection {
-    constructor(
-      public readonly edge: DiagramEdge,
-      private readonly view: LikeC4DiagramModel
-    ) {
-    }
-
-    get id() {
-      return this.edge.id
-    }
-
-    get source(): LikeC4DiagramModel.Element {
-      return this.view.element(this.edge.source)
-    }
-
-    get target(): LikeC4DiagramModel.Element {
-      return this.view.element(this.edge.target)
-    }
-
-    get tags(): C4Tag[] {
-      return this.edge.tags ?? []
-    }
-
-    get color(): C4Color {
-      return this.edge.color ?? DefaultRelationshipColor
-    }
-
-    /**
-     * Model relationships
-     */
-    relationships(): ReadonlyArray<LikeC4Model.Relationship<LikeC4DiagramModel>> {
-      return this.edge.relations.map(r => nonNullable(this.view.model.relationship(r)))
-    }
-  }
-}

package/src/model/LikeC4ViewModel.ts

@@ -1,320 +0,0 @@
-import { isNullish } from 'remeda'
-import { nonNullable } from '../errors'
-import {
-  type ElementKind as C4ElementKind,
-  type ElementShape as C4ElementShape,
-  type Tag as C4Tag
-} from '../types/element'
-import type { Color as C4Color } from '../types/theme'
-import type { ComputedEdge, ComputedNode, ComputedView } from '../types/view'
-import type { LikeC4Model } from './LikeC4Model'
-import { type EdgeId, type ElementOrFqn, type Fqn, getId, type IncomingFilter, type OutgoingFilter } from './types'
-
-/**
- * All methods are view-scoped, i.e. only return elements and connections in the view.
- */
-export class LikeC4ViewModel {
-  private readonly _rootElements = new Set<LikeC4ViewModel.Element>()
-
-  private readonly _elements = new Map<Fqn, LikeC4ViewModel.Element>()
-
-  private readonly _connections: Map<EdgeId, LikeC4ViewModel.Connection>
-
-  constructor(
-    public readonly view: ComputedView,
-    public readonly model: LikeC4Model<LikeC4ViewModel>
-  ) {
-    for (const node of view.nodes) {
-      const el = new LikeC4ViewModel.Element(node, this)
-      this._elements.set(node.id, el)
-      if (isNullish(node.parent)) {
-        this._rootElements.add(el)
-      }
-    }
-    this._connections = new Map(view.edges.map(e => [e.id, new LikeC4ViewModel.Connection(e, this)]))
-  }
-
-  get id() {
-    return this.view.id
-  }
-
-  get title() {
-    return this.view.title
-  }
-
-  get viewOf() {
-    if (this.view.__ !== 'dynamic') {
-      return this.view.viewOf ? this.model.element(this.view.viewOf) : null
-    }
-    return null
-  }
-
-  get tags(): C4Tag[] {
-    return this.view.tags ?? []
-  }
-
-  public roots(): ReadonlyArray<LikeC4ViewModel.Element> {
-    return [...this._rootElements]
-  }
-
-  public elements(): ReadonlyArray<LikeC4ViewModel.Element> {
-    return [...this._elements.values()]
-  }
-
-  public element(id: Fqn): LikeC4ViewModel.Element {
-    return nonNullable(this._elements.get(id), `LikeC4ViewModel.Element ${id} in view ${this.id} not found`)
-  }
-
-  public hasElement(id: Fqn): boolean {
-    return this._elements.has(id)
-  }
-
-  public connections(): ReadonlyArray<LikeC4ViewModel.Connection> {
-    return [...this._connections.values()]
-  }
-
-  public connection(id: EdgeId): LikeC4ViewModel.Connection {
-    return nonNullable(this._connections.get(id), `Connection ${id} in view ${this.id}  not found`)
-  }
-
-  public findConnections(
-    source: ElementOrFqn,
-    target: ElementOrFqn,
-    direction: 'both' | 'direct' = 'direct'
-  ): ReadonlyArray<LikeC4ViewModel.Connection> {
-    const sourceId = getId(source)
-    const targetId = getId(target)
-    return this.connections().filter(c =>
-      (c.source.id === sourceId && c.target.id === targetId)
-      || (direction === 'both' && c.source.id === targetId && c.target.id === sourceId)
-    )
-  }
-
-  public parent(element: ElementOrFqn): LikeC4ViewModel.Element | null {
-    const el = this.element(getId(element))
-    return el.node.parent ? this.element(el.node.parent) : null
-  }
-
-  public children(element: ElementOrFqn): ReadonlyArray<LikeC4ViewModel.Element> {
-    const el = this.element(getId(element))
-    return el.node.children.map(c => this.element(c))
-  }
-
-  // Get all sibling (i.e. same parent)
-  public siblings(element: ElementOrFqn): ReadonlyArray<LikeC4ViewModel.Element> {
-    const id = getId(element)
-    const parent = this.parent(id)
-    const siblings = parent ? this.children(parent) : this.roots()
-    return siblings.filter(e => e.id !== id)
-  }
-
-  /**
-   * Get all ancestor elements (i.e. parent, parent’s parent, etc.)
-   * (from closest to root)
-   */
-  public ancestors(element: ElementOrFqn): ReadonlyArray<LikeC4ViewModel.Element> {
-    let id = getId(element)
-    const result = [] as LikeC4ViewModel.Element[]
-    let parent
-    while (parent = this.parent(id)) {
-      result.push(parent)
-      id = parent.id
-    }
-    return result
-  }
-
-  public descendants(element: ElementOrFqn): ReadonlyArray<LikeC4ViewModel.Element> {
-    const children = this.children(element)
-    return children.flatMap(c => [c, ...this.descendants(c.id)])
-  }
-
-  public incoming(
-    element: ElementOrFqn,
-    filter: IncomingFilter = 'all'
-  ): ReadonlyArray<LikeC4ViewModel.Connection> {
-    const el = this.element(getId(element))
-    const edges = el.node.inEdges.map(e => nonNullable(this._connections.get(e), `Edge ${e} not found`))
-
-    if (filter === 'all' || edges.length === 0) {
-      return edges
-    }
-
-    return edges.filter(rel => {
-      if (filter === 'direct') {
-        return rel.target.id === el.id
-      }
-      return rel.target.id !== el.id
-    })
-  }
-
-  public incomers(
-    element: ElementOrFqn,
-    filter: IncomingFilter = 'all'
-  ): ReadonlyArray<LikeC4ViewModel.Element> {
-    return [...new Set(this.incoming(element, filter).map(r => r.source))]
-  }
-
-  /**
-   * Outgoing relationships from the element and its descendants
-   */
-  public outgoing(
-    element: ElementOrFqn,
-    filter: OutgoingFilter = 'all'
-  ): ReadonlyArray<LikeC4ViewModel.Connection> {
-    const el = this.element(getId(element))
-    const edges = el.node.outEdges.map(e => nonNullable(this._connections.get(e), `Edge ${e} not found`))
-
-    if (filter === 'all' || edges.length === 0) {
-      return edges
-    }
-
-    return edges.filter(rel => {
-      if (filter === 'direct') {
-        return rel.source.id === el.id
-      }
-      return rel.source.id !== el.id
-    })
-  }
-
-  public outgoers(
-    element: ElementOrFqn,
-    filter: OutgoingFilter = 'all'
-  ): ReadonlyArray<LikeC4ViewModel.Element> {
-    return [...new Set(this.outgoing(element, filter).map(r => r.target))]
-  }
-}
-
-export namespace LikeC4ViewModel {
-  /**
-   * Represents an element in the view. (Diagram node)
-   * All methods are view-scoped, i.e. `children` returns only children of the element in the view.
-   */
-  export class Element {
-    constructor(
-      public readonly node: ComputedNode,
-      private readonly viewmodel: LikeC4ViewModel
-    ) {
-    }
-
-    get id() {
-      return this.node.id
-    }
-
-    get title() {
-      return this.node.title
-    }
-
-    get kind(): C4ElementKind {
-      return this.node.kind
-    }
-
-    get isRoot(): boolean {
-      return isNullish(this.node.parent)
-    }
-
-    get hasNested(): boolean {
-      return this.node.children.length > 0
-    }
-
-    get shape(): C4ElementShape {
-      return this.node.shape
-    }
-
-    get color(): C4Color {
-      return this.node.color
-    }
-
-    get tags(): C4Tag[] {
-      return this.node.tags ?? []
-    }
-
-    public model(): LikeC4Model.ElementModel<LikeC4ViewModel> {
-      return this.viewmodel.model.element(this.id)
-    }
-
-    public parent(): LikeC4ViewModel.Element | null {
-      return this.node.parent ? this.viewmodel.element(this.node.parent) : null
-    }
-
-    public metadata(key: string): string | undefined
-    public metadata(key: string, defaultValue: string): string
-    public metadata(key: string, defaultValue?: string): string | undefined {
-      return this.model().metadata(key) ?? defaultValue
-    }
-
-    public hasMetadata(key: string): boolean {
-      return this.model().hasMetadata(key)
-    }
-
-    public ancestors(): ReadonlyArray<LikeC4ViewModel.Element> {
-      return this.viewmodel.ancestors(this)
-    }
-
-    public siblings(): ReadonlyArray<LikeC4ViewModel.Element> {
-      return this.viewmodel.siblings(this)
-    }
-
-    public descendants(): ReadonlyArray<LikeC4ViewModel.Element> {
-      return this.viewmodel.descendants(this)
-    }
-
-    public children(): ReadonlyArray<LikeC4ViewModel.Element> {
-      return this.viewmodel.children(this)
-    }
-
-    public incoming(filter: 'all' | 'direct' | 'to-descendants' = 'all'): ReadonlyArray<LikeC4ViewModel.Connection> {
-      return this.viewmodel.incoming(this, filter)
-    }
-
-    public incomers(filter: 'all' | 'direct' | 'to-descendants' = 'all'): ReadonlyArray<LikeC4ViewModel.Element> {
-      return this.viewmodel.incomers(this, filter)
-    }
-
-    public outgoing(filter: OutgoingFilter = 'all'): ReadonlyArray<LikeC4ViewModel.Connection> {
-      return this.viewmodel.outgoing(this, filter)
-    }
-
-    public outgoers(filter: OutgoingFilter = 'all'): ReadonlyArray<LikeC4ViewModel.Element> {
-      return this.viewmodel.outgoers(this, filter)
-    }
-
-    public connectionsTo(target: Fqn | LikeC4ViewModel.Element): ReadonlyArray<LikeC4ViewModel.Connection> {
-      return this.viewmodel.findConnections(this, target)
-    }
-  }
-
-  /**
-   * Represents a connection between two elements.
-   * May be source from multiple model relationships.
-   */
-  export class Connection {
-    constructor(
-      public readonly edge: ComputedEdge,
-      private readonly viewmodel: LikeC4ViewModel
-    ) {
-    }
-
-    get id() {
-      return this.edge.id
-    }
-
-    get source(): LikeC4ViewModel.Element {
-      return this.viewmodel.element(this.edge.source)
-    }
-
-    get target(): LikeC4ViewModel.Element {
-      return this.viewmodel.element(this.edge.target)
-    }
-
-    get tags(): C4Tag[] {
-      return this.edge.tags ?? []
-    }
-
-    /**
-     * Model relationships
-     */
-    relationships(): ReadonlyArray<LikeC4Model.Relationship<LikeC4ViewModel>> {
-      return this.edge.relations.map(r => nonNullable(this.viewmodel.model.relationship(r)))
-    }
-  }
-}