@likec4/language-server 1.8.1 → 1.10.0

package/src/model/model-parser.ts

@@ -1,7 +1,8 @@
-import { type c4, InvalidModelError, invariant, isNonEmptyArray, nonexhaustive } from '@likec4/core'
+import { type HexColorLiteral, invariant, isNonEmptyArray, nonexhaustive } from '@likec4/core'
+import type * as c4 from '@likec4/core'
 import type { AstNode, LangiumDocument } from 'langium'
 import { AstUtils, CstUtils } from 'langium'
-import { filter, flatMap, isDefined, isNonNullish, isTruthy, mapToObj, pipe } from 'remeda'
+import { filter, first, flatMap, isDefined, isNonNullish, isTruthy, map, mapToObj, pipe } from 'remeda'
 import stripIndent from 'strip-indent'
 import type { Writable } from 'type-fest'
 import type {
@@ -23,6 +24,7 @@ import {
   resolveRelationPoints,
   streamModel,
   toAutoLayout,
+  toColor,
   toElementStyle,
   toRelationshipStyleExcludeDefaults,
   ViewOps
@@ -67,7 +69,7 @@ export class LikeC4ModelParser {
       try {
         result.push(this.parseLikeC4Document(doc))
       } catch (cause) {
-        logError(new InvalidModelError(`Error parsing document ${doc.uri.toString()}`, { cause }))
+        logError(new Error(`Error parsing document ${doc.uri.toString()}`, { cause }))
       }
     }
     return result
@@ -89,20 +91,23 @@ export class LikeC4ModelParser {
     const element_specs = specifications.flatMap(s => s.elements.filter(isValid))
     for (const { kind, props } of element_specs) {
       try {
-        const style = props.find(ast.isElementStyleProperty)
         const kindName = kind.name as c4.ElementKind
-        if (kindName in c4Specification.kinds) {
+        if (!isTruthy(kindName)) {
+          continue
+        }
+        if (kindName in c4Specification.elements) {
           logger.warn(`Element kind "${kindName}" is already defined`)
           continue
         }
+        const style = props.find(ast.isElementStyleProperty)
         const bodyProps = mapToObj(
           props.filter(ast.isSpecificationElementStringProperty).filter(p => isNonNullish(p.value)) ?? [],
-          p => [p.key, removeIndent(p.value)]
+          p => [p.key, removeIndent(p.value)] as const
         )
-        c4Specification.kinds[kindName] = {
+        c4Specification.elements[kindName] = {
           ...bodyProps,
           style: {
-            ...toElementStyle(style?.props)
+            ...toElementStyle(style?.props, isValid)
           }
         }
       } catch (e) {
@@ -114,13 +119,16 @@ export class LikeC4ModelParser {
     for (const { kind, props } of relations_specs) {
       try {
         const kindName = kind.name as c4.RelationshipKind
+        if (!isTruthy(kindName)) {
+          continue
+        }
         if (kindName in c4Specification.relationships) {
           logger.warn(`Relationship kind "${kindName}" is already defined`)
           continue
         }
         const bodyProps = mapToObj(
           props.filter(ast.isSpecificationRelationshipStringProperty).filter(p => isNonNullish(p.value)) ?? [],
-          p => [p.key, p.value]
+          p => [p.key, removeIndent(p.value)]
         )
         c4Specification.relationships[kindName] = {
           ...bodyProps,
@@ -130,13 +138,38 @@ export class LikeC4ModelParser {
         logWarnError(e)
       }
     }
+
+    const tags_specs = specifications.flatMap(s => s.tags.filter(isValid))
+    for (const tagSpec of tags_specs) {
+      const tag = tagSpec.tag.name as c4.Tag
+      if (isTruthy(tag)) {
+        c4Specification.tags.add(tag)
+      }
+    }
+
+    const colors_specs = specifications.flatMap(s => s.colors.filter(isValid))
+    for (const { name, color } of colors_specs) {
+      try {
+        const colorName = name.name as c4.CustomColor
+        if (colorName in c4Specification.colors) {
+          logger.warn(`Custom color "${colorName}" is already defined`)
+          continue
+        }
+
+        c4Specification.colors[colorName] = {
+          color: color as HexColorLiteral
+        }
+      } catch (e) {
+        logWarnError(e)
+      }
+    }
   }
 
   private parseModel(doc: ParsedLikeC4LangiumDocument, isValid: IsValidFn) {
     for (const el of streamModel(doc, isValid)) {
       if (ast.isElement(el)) {
         try {
-          doc.c4Elements.push(this.parseElement(el))
+          doc.c4Elements.push(this.parseElement(el, isValid))
         } catch (e) {
           logWarnError(e)
         }
@@ -154,12 +187,12 @@ export class LikeC4ModelParser {
     }
   }
 
-  private parseElement(astNode: ast.Element): ParsedAstElement {
+  private parseElement(astNode: ast.Element, isValid: IsValidFn): ParsedAstElement {
     const id = this.resolveFqn(astNode)
     const kind = astNode.kind.$refText as c4.ElementKind
     const tags = this.convertTags(astNode.body)
     const stylePropsAst = astNode.body?.props.find(ast.isElementStyleProperty)?.props
-    const style = toElementStyle(stylePropsAst)
+    const style = toElementStyle(stylePropsAst, isValid)
     const metadata = this.getMetadata(astNode.body?.props.find(ast.isMetadataProperty))
     const astPath = this.getAstNodePath(astNode)
 
@@ -214,6 +247,14 @@ export class LikeC4ModelParser {
       p => [p.key, p.value]
     )
 
+    const navigateTo = pipe(
+      astNode.body?.props ?? [],
+      filter(ast.isRelationNavigateToProperty),
+      map(p => p.value.view.ref?.name),
+      filter(isTruthy),
+      first()
+    )
+
     const title = removeIndent(astNode.title ?? bodyProps.title) ?? ''
     const description = removeIndent(bodyProps.description)
     const technology = removeIndent(astNode.technology) ?? toSingleLine(bodyProps.technology)
@@ -236,7 +277,8 @@ export class LikeC4ModelParser {
       ...(kind && { kind }),
       ...(tags && { tags }),
       ...(isNonEmptyArray(links) && { links }),
-      ...toRelationshipStyleExcludeDefaults(styleProp?.props)
+      ...toRelationshipStyleExcludeDefaults(styleProp?.props),
+      ...(navigateTo && { navigateTo: navigateTo as c4.ViewID })
     }
   }
 
@@ -392,8 +434,9 @@ export class LikeC4ModelParser {
           return acc
         }
         if (ast.isColorProperty(prop)) {
-          if (isDefined(prop.value)) {
-            acc.custom[prop.key] = prop.value
+          const value = toColor(prop)
+          if (isDefined(value)) {
+            acc.custom[prop.key] = value
           }
           return acc
         }
@@ -480,7 +523,7 @@ export class LikeC4ModelParser {
     const props = astNode.custom?.props ?? []
     return props.reduce(
       (acc, prop) => {
-        if (ast.isRelationStringProperty(prop)) {
+        if (ast.isRelationStringProperty(prop) || ast.isNotationProperty(prop) || ast.isNotesProperty(prop)) {
           if (isDefined(prop.value)) {
             acc.customRelation[prop.key] = removeIndent(prop.value) ?? ''
           }
@@ -493,8 +536,9 @@ export class LikeC4ModelParser {
           return acc
         }
         if (ast.isColorProperty(prop)) {
-          if (isTruthy(prop.value)) {
-            acc.customRelation[prop.key] = prop.value
+          const value = toColor(prop)
+          if (isTruthy(value)) {
+            acc.customRelation[prop.key] = value
           }
           return acc
         }
@@ -504,9 +548,10 @@ export class LikeC4ModelParser {
           }
           return acc
         }
-        if (ast.isNotationProperty(prop)) {
-          if (isTruthy(prop.value)) {
-            acc.customRelation[prop.key] = removeIndent(prop.value)
+        if (ast.isRelationNavigateToProperty(prop)) {
+          const viewId = prop.value.view.ref?.name
+          if (isTruthy(viewId)) {
+            acc.customRelation.navigateTo = viewId as c4.ViewID
           }
           return acc
         }
@@ -551,7 +596,7 @@ export class LikeC4ModelParser {
       return this.parseViewRulePredicate(astRule, isValid)
     }
     if (ast.isViewRuleStyle(astRule)) {
-      const styleProps = toElementStyle(astRule.props.filter(ast.isStyleProperty))
+      const styleProps = toElementStyle(astRule.props.filter(ast.isStyleProperty), isValid)
       const notation = removeIndent(astRule.props.find(ast.isNotationProperty)?.value)
       const targets = this.parseElementExpressionsIterator(astRule.target)
       return {
@@ -589,6 +634,12 @@ export class LikeC4ModelParser {
     }
   }
 
+  private parseDynamicParallelSteps(node: ast.DynamicViewParallelSteps): c4.DynamicViewParallelSteps {
+    return {
+      __parallel: node.steps.map(step => this.parseDynamicStep(step))
+    }
+  }
+
   private parseDynamicStep(node: ast.DynamicViewStep): c4.DynamicViewStep {
     const sourceEl = elementRef(node.source)
     if (!sourceEl) {
@@ -600,9 +651,7 @@ export class LikeC4ModelParser {
     }
     let source = this.resolveFqn(sourceEl)
     let target = this.resolveFqn(targetEl)
-    const title = removeIndent(
-      node.title ?? node.custom?.props.find((p): p is ast.RelationStringProperty => p.key === 'title')?.value
-    ) ?? ''
+    const title = removeIndent(node.title) ?? null
 
     let step: Writable<c4.DynamicViewStep> = {
       source,
@@ -620,28 +669,35 @@ export class LikeC4ModelParser {
     if (Array.isArray(node.custom?.props)) {
       for (const prop of node.custom.props) {
         try {
-          if (ast.isRelationStringProperty(prop)) {
-            const value = removeIndent(prop.value)
-            if (isTruthy(value) && prop.key !== 'title') {
-              step[prop.key] = value
+          if (ast.isRelationStringProperty(prop) || ast.isNotationProperty(prop) || ast.isNotesProperty(prop)) {
+            if (isDefined(prop.value)) {
+              step[prop.key] = removeIndent(prop.value) ?? ''
             }
             continue
           }
           if (ast.isArrowProperty(prop)) {
-            step[prop.key] = prop.value
+            if (isDefined(prop.value)) {
+              step[prop.key] = prop.value
+            }
             continue
           }
           if (ast.isColorProperty(prop)) {
-            step[prop.key] = prop.value
+            const value = toColor(prop)
+            if (isDefined(value)) {
+              step[prop.key] = value
+            }
             continue
           }
           if (ast.isLineProperty(prop)) {
-            step[prop.key] = prop.value
+            if (isDefined(prop.value)) {
+              step[prop.key] = prop.value
+            }
             continue
           }
-          if (ast.isNotationProperty(prop)) {
-            if (isTruthy(prop.value)) {
-              step[prop.key] = prop.value
+          if (ast.isRelationNavigateToProperty(prop)) {
+            const viewId = prop.value.view.ref?.name
+            if (isTruthy(viewId)) {
+              step.navigateTo = viewId as c4.ViewID
             }
             continue
           }
@@ -778,7 +834,7 @@ export class LikeC4ModelParser {
             return acc
           }
           if (ast.isViewRuleStyle(n)) {
-            const styleProps = toElementStyle(n.props.filter(ast.isStyleProperty))
+            const styleProps = toElementStyle(n.props.filter(ast.isStyleProperty), isValid)
             const notation = removeIndent(n.props.find(ast.isNotationProperty)?.value)
             const targets = this.parseElementExpressionsIterator(n.target)
             if (targets.length > 0) {
@@ -807,13 +863,17 @@ export class LikeC4ModelParser {
       steps: body.steps.reduce((acc, n) => {
         try {
           if (isValid(n)) {
-            acc.push(this.parseDynamicStep(n))
+            if (ast.isDynamicViewParallelSteps(n)) {
+              acc.push(this.parseDynamicParallelSteps(n))
+            } else {
+              acc.push(this.parseDynamicStep(n))
+            }
           }
         } catch (e) {
           logWarnError(e)
         }
         return acc
-      }, [] as c4.DynamicViewStep[]),
+      }, [] as c4.DynamicViewStepOrParallel[]),
       ...(manualLayout && { manualLayout })
     }
   }
@@ -845,7 +905,7 @@ export class LikeC4ModelParser {
     const tags = [] as c4.Tag[]
     while (iter) {
       try {
-        const values = iter.values.map(t => t.ref?.name).filter(Boolean) as c4.Tag[]
+        const values = iter.values.map(t => t.ref?.name).filter(isTruthy) as c4.Tag[]
         if (values.length > 0) {
           tags.unshift(...values)
         }

package/src/model-graph/LikeC4ModelGraph.ts

@@ -3,14 +3,13 @@ import {
   commonAncestor,
   type Element,
   type Fqn,
-  InvalidModelError,
   invariant,
   isSameHierarchy,
-  isString,
   parentFqn,
   type Relation,
   type RelationID
 } from '@likec4/core'
+import { isArray, isString } from 'remeda'
 
 type Params = {
   elements: Record<Fqn, Element>
@@ -25,7 +24,7 @@ type RelationEdge = {
 }
 
 type FqnOrElement = Fqn | Element
-type FqnsOrElements = Fqn[] | Element[]
+type FqnsOrElements = ReadonlyArray<Fqn> | ReadonlyArray<Element>
 
 const RelationsSet = Set<Relation>
 const MapRelations = Map<Fqn, Set<Relation>>
@@ -37,9 +36,16 @@ function intersection<T>(a: Set<T>, b: Set<T>) {
   return new Set([...a].filter(value => b.has(value)))
 }
 
+/**
+ * Used only for views calculations.
+ * Subject to change.
+ */
 export class LikeC4ModelGraph {
   #elements = new Map<Fqn, Element>()
-  #children = new Map<Fqn, Fqn[]>()
+  // Parent element for given FQN
+  #parents = new Map<Fqn, Element>()
+  // Children elements for given FQN
+  #children = new Map<Fqn, Element[]>()
   #rootElements = new Set<Element>()
 
   #relations = new Map<RelationID, Relation>()
@@ -47,7 +53,7 @@ export class LikeC4ModelGraph {
   #incoming = new MapRelations()
   // Outgoing from an element or its descendants
   #outgoing = new MapRelations()
-  // Relationships inside the element descendants
+  // Relationships inside the element, among descendants
   #internal = new MapRelations()
 
   #cacheAscendingSiblings = new Map<Fqn, Element[]>()
@@ -80,7 +86,7 @@ export class LikeC4ModelGraph {
   }
 
   public children(id: Fqn) {
-    return this._childrenOf(id).flatMap(id => this.#elements.get(id) ?? [])
+    return this._childrenOf(id).slice()
   }
 
   // Get children or element itself if no children
@@ -93,19 +99,30 @@ export class LikeC4ModelGraph {
   public siblings(element: Fqn | Element) {
     const id = isString(element) ? element : element.id
     const parent = parentFqn(id)
-    const fqns = parent ? this._childrenOf(parent) : [...this.#rootElements].map(e => e.id)
-    return fqns.flatMap(fqn => (fqn !== id && this.#elements.get(fqn)) || [])
+    const siblings = parent ? this._childrenOf(parent) : this.rootElements
+    return siblings.filter(e => e.id !== id)
   }
 
-  public ancestors(element: Fqn | Element) {
-    const id = isString(element) ? element : element.id
-    return ancestorsFqn(id).flatMap(id => this.#elements.get(id) ?? [])
+  /**
+   * Get all ancestor elements (i.e. parent, parent’s parent, etc.)
+   * (from closest to root)
+   */
+  public ancestors(element: Fqn | Element): Array<Element> {
+    let id = isString(element) ? element : element.id
+    const result = [] as Element[]
+    let parent
+    while (parent = this.#parents.get(id)) {
+      result.push(parent)
+      id = parent.id
+    }
+    return result as Array<Element>
   }
 
   /**
    * Resolve siblings of the element and its ancestors
+   *  (from closest to root)
    */
-  public ascendingSiblings(element: Fqn | Element) {
+  public ascendingSiblings(element: Fqn | Element): Array<Element> {
     const id = isString(element) ? element : element.id
     let siblings = this.#cacheAscendingSiblings.get(id)
     if (!siblings) {
@@ -121,7 +138,10 @@ export class LikeC4ModelGraph {
   /**
    * Resolve all RelationEdges between element and others (any direction)
    */
-  public anyEdgesBetween(_element: Fqn | Element, others: Fqn[] | Element[]): RelationEdge[] {
+  public anyEdgesBetween(
+    _element: Fqn | Element,
+    others: ReadonlyArray<Fqn> | ReadonlyArray<Element>
+  ): Array<RelationEdge> {
     if (others.length === 0) {
       return []
     }
@@ -169,7 +189,7 @@ export class LikeC4ModelGraph {
   /**
    * Resolve all RelationEdges between elements (any direction)
    */
-  public edgesWithin<T extends Fqn[] | Element[]>(elements: T): RelationEdge[] {
+  public edgesWithin<T extends Fqn[] | Element[]>(elements: T): Array<RelationEdge> {
     if (elements.length < 2) {
       return []
     }
@@ -190,8 +210,8 @@ export class LikeC4ModelGraph {
     _sources: FqnOrElement | FqnsOrElements,
     _targets: FqnOrElement | FqnsOrElements
   ) {
-    const sources = Array.isArray(_sources) ? _sources : [_sources]
-    const targets = Array.isArray(_targets) ? _targets : [_targets]
+    const sources = isArray(_sources) ? _sources : [_sources]
+    const targets = isArray(_targets) ? _targets : [_targets]
     if (sources.length === 0 || targets.length === 0) {
       return []
     }
@@ -226,12 +246,13 @@ export class LikeC4ModelGraph {
 
   private addElement(el: Element) {
     if (this.#elements.has(el.id)) {
-      throw new InvalidModelError(`Element ${el.id} already exists`)
+      throw new Error(`Element ${el.id} already exists`)
     }
     this.#elements.set(el.id, el)
-    const parent = parentFqn(el.id)
-    if (parent) {
-      this._childrenOf(parent).push(el.id)
+    const parentId = parentFqn(el.id)
+    if (parentId) {
+      this.#parents.set(el.id, this.element(parentId))
+      this._childrenOf(parentId).push(el)
     } else {
       this.#rootElements.add(el)
     }
@@ -239,7 +260,7 @@ export class LikeC4ModelGraph {
 
   private addRelation(rel: Relation) {
     if (this.#relations.has(rel.id)) {
-      throw new InvalidModelError(`Relation ${rel.id} already exists`)
+      throw new Error(`Relation ${rel.id} already exists`)
     }
     this.#relations.set(rel.id, rel)
     this._incomingTo(rel.target).add(rel)

package/src/model-graph/compute-view/__test__/fixture.ts

@@ -1,5 +1,6 @@
 import {
   type BorderStyle,
+  type Color,
   type ComputedView,
   type CustomElementExpr as C4CustomElementExpr,
   type CustomRelationExpr as C4CustomRelationExpr,
@@ -17,7 +18,6 @@ import {
   type RelationshipLineType,
   type RelationWhereExpr,
   type Tag,
-  type ThemeColor,
   type ViewID,
   type ViewRule,
   type ViewRulePredicate,
@@ -210,28 +210,29 @@ export const fakeElements = {
 
 export type FakeElementIds = keyof typeof fakeElements
 
-const rel = ({
+const rel = <Source extends FakeElementIds, Target extends FakeElementIds>({
   source,
   target,
   title,
   ...props
 }: {
-  source: FakeElementIds
-  target: FakeElementIds
+  source: Source
+  target: Target
   title?: string
   kind?: string
-  color?: ThemeColor
+  color?: Color
   line?: RelationshipLineType
   head?: RelationshipArrowType
   tail?: RelationshipArrowType
   tags?: NonEmptyArray<TestTag>
-}): Relation => ({
-  id: `${source}:${target}` as RelationID,
-  title: title ?? '',
-  source: source as Fqn,
-  target: target as Fqn,
-  ...(props as any)
-})
+}) =>
+  ({
+    id: `${source}:${target}` as RelationID,
+    title: title ?? '',
+    source: source as Fqn,
+    target: target as Fqn,
+    ...(props as any)
+  }) as Omit<Relation, 'id'> & { id: `${Source}:${Target}` }
 
 export const fakeRelations = [
   rel({
@@ -321,7 +322,7 @@ export const fakeRelations = [
   })
 ]
 
-export type FakeRelationIds = keyof typeof fakeRelations
+export type FakeRelationIds = (typeof fakeRelations)[number]['id']
 
 export const fakeModel = new LikeC4ModelGraph({
   elements: fakeElements,
@@ -335,6 +336,7 @@ const emptyView = {
   description: null,
   tags: null,
   links: null,
+  customColorDefinitions: {},
   rules: []
 }
 
@@ -370,7 +372,7 @@ export function $custom(
     description?: string
     technology?: string
     shape?: ElementShape
-    color?: ThemeColor
+    color?: Color
     border?: BorderStyle
     icon?: string
     opacity?: number