@likec4/language-server 1.17.1 → 1.19.0

package/src/ast.ts

@@ -1,15 +1,15 @@
-import { DefaultArrowType, DefaultLineStyle, DefaultRelationshipColor, nonexhaustive } from '@likec4/core'
 import type * as c4 from '@likec4/core'
+import { DefaultArrowType, DefaultLineStyle, DefaultRelationshipColor, LinkedList, nonexhaustive } from '@likec4/core'
 import type { AstNode, AstNodeDescription, DiagnosticInfo, LangiumDocument, MultiMap } from 'langium'
 import { DocumentState } from 'langium'
 import { clamp, isDefined, isNullish, isTruthy } from 'remeda'
-import type { ConditionalPick, SetRequired, ValueOf } from 'type-fest'
+import type { ConditionalPick, SetRequired, ValueOf, Writable } from 'type-fest'
 import type { Diagnostic } from 'vscode-languageserver-types'
-import { DiagnosticSeverity } from 'vscode-languageserver-types'
-import { elementRef } from './elementRef'
 import type { LikeC4Grammar } from './generated/ast'
 import * as ast from './generated/ast'
 import { LikeC4LanguageMetaData } from './generated/module'
+import { elementRef } from './utils/elementRef'
+import type { IsValidFn } from './validation'
 
 export { ast }
 
@@ -20,10 +20,19 @@ declare module './generated/ast' {
     [idattr]?: c4.Fqn | undefined
   }
   export interface ElementView {
-    [idattr]?: c4.ViewID | undefined
+    [idattr]?: c4.ViewId | undefined
   }
   export interface DynamicView {
-    [idattr]?: c4.ViewID | undefined
+    [idattr]?: c4.ViewId | undefined
+  }
+  export interface DeploymentView {
+    [idattr]?: c4.ViewId | undefined
+  }
+  export interface DeploymentNode {
+    [idattr]?: c4.Fqn | undefined
+  }
+  export interface DeployedInstance {
+    [idattr]?: c4.Fqn | undefined
   }
 }
 
@@ -59,6 +68,7 @@ export interface ParsedAstSpecification {
       color: c4.HexColorLiteral
     }
   >
+  deployments: Record<c4.DeploymentNodeKind, c4.DeploymentNodeKindSpecification>
 }
 
 export interface ParsedAstElement {
@@ -75,7 +85,7 @@ export interface ParsedAstElement {
 }
 
 export interface ParsedAstRelation {
-  id: c4.RelationID
+  id: c4.RelationId
   astPath: string
   source: c4.Fqn
   target: c4.Fqn
@@ -89,23 +99,28 @@ export interface ParsedAstRelation {
   head?: c4.RelationshipArrowType
   tail?: c4.RelationshipArrowType
   links?: c4.NonEmptyArray<ParsedLink>
-  navigateTo?: c4.ViewID
+  navigateTo?: c4.ViewId
   metadata?: { [key: string]: string }
 }
 
-// export interface ParsedAstGlobals {
-//   predicates: Record<c4.GlobalElRelID, c4.NonEmptyArray<c4.ViewRulePredicate>>
-//   dynamicPredicates: Record<c4.GlobalElRelID, c4.NonEmptyArray<c4.DynamicViewIncludeRule>>
-//   styles: Record<c4.GlobalStyleID, c4.NonEmptyArray<c4.ViewRuleStyle>>
-// }
+// Alias for easier refactoring
+export type ParsedAstDeployment = c4.DeploymentElement
+export namespace ParsedAstDeployment {
+  export type Node = c4.DeploymentNode
+  export type Instance = c4.DeployedInstance
+}
+export type ParsedAstDeploymentRelation = c4.DeploymentRelation & {
+  astPath: string
+}
+
 // Alias for refactoring
-export type ParsedAstGlobals = c4.ModelGlobals
+export type ParsedAstGlobals = Writable<c4.ModelGlobals>
 
 export interface ParsedAstElementView {
   __: 'element'
-  id: c4.ViewID
+  id: c4.ViewId
   viewOf?: c4.Fqn
-  extends?: c4.ViewID
+  extends?: c4.ViewId
   astPath: string
   title: string | null
   description: string | null
@@ -117,7 +132,7 @@ export interface ParsedAstElementView {
 
 export interface ParsedAstDynamicView {
   __: 'dynamic'
-  id: c4.ViewID
+  id: c4.ViewId
   astPath: string
   title: string | null
   description: string | null
@@ -128,15 +143,26 @@ export interface ParsedAstDynamicView {
   manualLayout?: c4.ViewManualLayout
 }
 
-export type ParsedAstView = ParsedAstElementView | ParsedAstDynamicView
+export interface ParsedAstDeploymentView {
+  __: 'deployment'
+  id: c4.ViewId
+  astPath: string
+  title: string | null
+  description: string | null
+  tags: c4.NonEmptyArray<c4.Tag> | null
+  links: c4.NonEmptyArray<ParsedLink> | null
+  rules: Array<c4.DeploymentViewRule>
+}
+
+export type ParsedAstView = ParsedAstElementView | ParsedAstDynamicView | ParsedAstDeploymentView
 export const ViewOps = {
-  writeId<T extends ast.LikeC4View>(node: T, id: c4.ViewID): T {
+  writeId<T extends ast.LikeC4View>(node: T, id: c4.ViewId): T {
     node[idattr] = id
     return node
   },
-  readId(node: ast.LikeC4View): c4.ViewID | undefined {
+  readId(node: ast.LikeC4View): c4.ViewId | undefined {
     return node[idattr]
-  }
+  },
 }
 
 export interface ParsedLink {
@@ -145,7 +171,7 @@ export interface ParsedLink {
 }
 
 export const ElementOps = {
-  writeId(node: ast.Element, id: c4.Fqn | null) {
+  writeId(node: ast.Element | ast.DeploymentElement, id: c4.Fqn | null) {
     if (isNullish(id)) {
       node[idattr] = undefined
     } else {
@@ -153,15 +179,20 @@ export const ElementOps = {
     }
     return node
   },
-  readId(node: ast.Element) {
+  readId(node: ast.Element | ast.DeploymentElement) {
     return node[idattr]
-  }
+  },
 }
 
 export interface DocFqnIndexAstNodeDescription extends AstNodeDescription {
   fqn: c4.Fqn
 }
 
+export interface DeploymentAstNodeDescription extends AstNodeDescription {
+  // Fullname of the artifact or node
+  fqn: string
+}
+
 // export type LikeC4AstNode = ast.LikeC4AstType[keyof ast.LikeC4AstType]
 export type LikeC4AstNode = ValueOf<ConditionalPick<ast.LikeC4AstType, AstNode>>
 type LikeC4DocumentDiagnostic = Diagnostic & DiagnosticInfo<LikeC4AstNode>
@@ -173,41 +204,18 @@ export interface LikeC4DocumentProps {
   c4Relations?: ParsedAstRelation[]
   c4Globals?: ParsedAstGlobals
   c4Views?: ParsedAstView[]
+  c4Deployments?: ParsedAstDeployment[]
+  c4DeploymentRelations?: ParsedAstDeploymentRelation[]
   // Fqn -> Element
   c4fqnIndex?: MultiMap<c4.Fqn, DocFqnIndexAstNodeDescription>
 }
 
-export interface LikeC4LangiumDocument
-  extends Omit<LangiumDocument<LikeC4Grammar>, 'diagnostics'>, LikeC4DocumentProps
-{}
-export interface FqnIndexedDocument
-  extends Omit<LangiumDocument<LikeC4Grammar>, 'diagnostics'>, SetRequired<LikeC4DocumentProps, 'c4fqnIndex'>
-{}
-
-// export type ParsedLikeC4LangiumDocument = SetRequired<FqnIndexedDocument, keyof  LikeC4DocumentProps>
-export interface ParsedLikeC4LangiumDocument
-  extends Omit<LangiumDocument<LikeC4Grammar>, 'diagnostics'>, Required<LikeC4DocumentProps>
-{}
-
-export function cleanParsedModel(doc: LikeC4LangiumDocument) {
-  const props: Required<Omit<LikeC4DocumentProps, 'c4fqnIndex' | 'diagnostics'>> = {
-    c4Specification: {
-      tags: new Set(),
-      elements: {},
-      relationships: {},
-      colors: {}
-    },
-    c4Elements: [],
-    c4Relations: [],
-    c4Globals: {
-      predicates: {},
-      dynamicPredicates: {},
-      styles: {}
-    },
-    c4Views: []
-  }
-  return Object.assign(doc, props) as ParsedLikeC4LangiumDocument
-}
+type LikeC4GrammarDocument = Omit<LangiumDocument<LikeC4Grammar>, 'diagnostics'>
+
+export interface LikeC4LangiumDocument extends LikeC4GrammarDocument, LikeC4DocumentProps {}
+export interface FqnIndexedDocument extends SetRequired<LikeC4LangiumDocument, 'c4fqnIndex'> {}
+
+export interface ParsedLikeC4LangiumDocument extends LikeC4GrammarDocument, Required<LikeC4DocumentProps> {}
 
 export function isLikeC4LangiumDocument(doc: LangiumDocument): doc is LikeC4LangiumDocument {
   return doc.textDocument.languageId === LikeC4LanguageMetaData.languageId
@@ -218,7 +226,7 @@ export function isFqnIndexedDocument(doc: LangiumDocument): doc is FqnIndexedDoc
 }
 
 export function isParsedLikeC4LangiumDocument(
-  doc: LangiumDocument
+  doc: LangiumDocument,
 ): doc is ParsedLikeC4LangiumDocument {
   return (
     isLikeC4LangiumDocument(doc)
@@ -228,110 +236,59 @@ export function isParsedLikeC4LangiumDocument(
     && !!doc.c4Relations
     && !!doc.c4Views
     && !!doc.c4fqnIndex
+    && !!doc.c4Deployments
+    && !!doc.c4DeploymentRelations
   )
 }
 
-type Guard<N extends AstNode> = (n: AstNode) => n is N
-type Guarded<G> = G extends Guard<infer N> ? N : never
-
-function validatableAstNodeGuards<const Predicates extends Guard<AstNode>[]>(
-  predicates: Predicates
-) {
-  return (n: AstNode): n is Guarded<Predicates[number]> => predicates.some(p => p(n))
-}
-const isValidatableAstNode = validatableAstNodeGuards([
-  ast.isGlobals,
-  ast.isGlobalPredicateGroup,
-  ast.isGlobalDynamicPredicateGroup,
-  ast.isGlobalStyle,
-  ast.isGlobalStyleGroup,
-  ast.isDynamicViewPredicateIterator,
-  ast.isElementPredicateWith,
-  ast.isRelationPredicateWith,
-  ast.isElementExpression,
-  ast.isRelationExpression,
-  ast.isDynamicViewParallelSteps,
-  ast.isDynamicViewStep,
-  ast.isViewProperty,
-  ast.isStyleProperty,
-  ast.isTags,
-  ast.isViewRule,
-  ast.isDynamicViewRule,
-  ast.isElementViewBody,
-  ast.isDynamicViewBody,
-  ast.isLikeC4View,
-  ast.isRelationProperty,
-  ast.isRelationBody,
-  ast.isRelation,
-  ast.isElementProperty,
-  ast.isElementBody,
-  ast.isElement,
-  ast.isExtendElementBody,
-  ast.isExtendElement,
-  ast.isSpecificationElementKind,
-  ast.isSpecificationRelationshipKind,
-  ast.isSpecificationTag,
-  ast.isSpecificationColor,
-  ast.isSpecificationRule,
-  ast.isModelViews,
-  ast.isModel
-])
-type ValidatableAstNode = Guarded<typeof isValidatableAstNode>
-
-const findInvalidContainer = (node: LikeC4AstNode): ValidatableAstNode | undefined => {
-  let nd = node as LikeC4AstNode['$container']
-  while (nd) {
-    if (isValidatableAstNode(nd)) {
-      return nd
-    }
-    nd = nd.$container
-  }
-  return undefined
-}
-
-export function checksFromDiagnostics(doc: LikeC4LangiumDocument) {
-  const errors = doc.diagnostics?.filter(d => d.severity === DiagnosticSeverity.Error) ?? []
-  const invalidNodes = new WeakSet(
-    errors.flatMap(d => {
-      return findInvalidContainer(d.node) ?? []
-    })
-  )
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const isValid = (n: ValidatableAstNode) => !invalidNodes.has(n)
-  return {
-    isValid,
-    invalidNodes
-  }
-}
-export type ChecksFromDiagnostics = ReturnType<typeof checksFromDiagnostics>
-export type IsValidFn = ChecksFromDiagnostics['isValid']
-
-export function* streamModel(doc: LikeC4LangiumDocument, isValid: IsValidFn) {
-  const traverseStack = doc.parseResult.value.models.flatMap(m => m.elements)
+export function* streamModel(doc: LikeC4LangiumDocument) {
+  const traverseStack = LinkedList.from(doc.parseResult.value.models.flatMap(m => m.elements))
   const relations = [] as ast.Relation[]
   let el
   while ((el = traverseStack.shift())) {
-    if (!isValid(el)) {
-      continue
-    }
     if (ast.isRelation(el)) {
       relations.push(el)
       continue
     }
     if (ast.isExtendElement(el)) {
       if (el.body && el.body.elements.length > 0) {
-        traverseStack.push(...el.body.elements)
+        for (const child of el.body.elements) {
+          traverseStack.push(child)
+        }
       }
       continue
     }
     if (el.body && el.body.elements.length > 0) {
-      traverseStack.push(...el.body.elements)
+      for (const child of el.body.elements) {
+        traverseStack.push(child)
+      }
     }
     yield el
   }
-  for (const relation of relations) {
-    yield relation
+  yield* relations
+  return
+}
+
+export function* streamDeploymentModel(doc: LikeC4LangiumDocument) {
+  const traverseStack = LinkedList.from<ast.DeploymentRelation | ast.DeploymentElement>(
+    doc.parseResult.value.deployments.flatMap(m => m.elements),
+  )
+  const relations = [] as ast.DeploymentRelation[]
+  let el
+  while ((el = traverseStack.shift())) {
+    if (ast.isDeploymentRelation(el)) {
+      relations.push(el)
+      continue
+    }
+    if (ast.isDeploymentNode(el) && el.body && el.body.elements.length > 0) {
+      for (const child of el.body.elements) {
+        traverseStack.push(child)
+      }
+    }
+    yield el
   }
+  yield* relations
+  return
 }
 
 export function resolveRelationPoints(node: ast.Relation): {
@@ -349,7 +306,7 @@ export function resolveRelationPoints(node: ast.Relation): {
     }
     return {
       source,
-      target
+      target,
     }
   }
   if (!ast.isElementBody(node.$container)) {
@@ -357,7 +314,7 @@ export function resolveRelationPoints(node: ast.Relation): {
   }
   return {
     source: node.$container.$container,
-    target
+    target,
   }
 }
 
@@ -407,14 +364,13 @@ export function toElementStyle(props: Array<ast.StyleProperty> | undefined, isVa
         break
       }
       default:
-        // @ts-expect-error
-        nonexhaustive(prop.$type)
+        nonexhaustive(prop)
     }
   }
   return result
 }
 
-export function toRelationshipStyle(props?: ast.RelationshipStyleProperty[]) {
+export function toRelationshipStyle(props: ast.RelationshipStyleProperty[] | undefined, isValid: IsValidFn) {
   const result = {} as {
     color?: c4.Color
     line?: c4.RelationshipLineType
@@ -425,47 +381,55 @@ export function toRelationshipStyle(props?: ast.RelationshipStyleProperty[]) {
     return result
   }
   for (const prop of props) {
-    if (ast.isColorProperty(prop)) {
-      const color = toColor(prop)
-      if (isTruthy(color)) {
-        result.color = color
-      }
-      continue
-    }
-    if (ast.isLineProperty(prop)) {
-      result.line = prop.value
+    if (!isValid(prop)) {
       continue
     }
-    if (ast.isArrowProperty(prop)) {
-      switch (prop.key) {
-        case 'head': {
-          result.head = prop.value
-          break
-        }
-        case 'tail': {
-          result.tail = prop.value
-          break
+    switch (true) {
+      case ast.isColorProperty(prop): {
+        const color = toColor(prop)
+        if (isTruthy(color)) {
+          result.color = color
         }
-        default: {
-          nonexhaustive(prop)
+        break
+      }
+      case ast.isLineProperty(prop): {
+        result.line = prop.value
+        break
+      }
+      case ast.isArrowProperty(prop): {
+        switch (prop.key) {
+          case 'head': {
+            result.head = prop.value
+            break
+          }
+          case 'tail': {
+            result.tail = prop.value
+            break
+          }
+          default: {
+            nonexhaustive(prop)
+          }
         }
+        break
+      }
+      default: {
+        nonexhaustive(prop)
       }
-      continue
     }
-    nonexhaustive(prop)
   }
   return result
 }
 
 export function toRelationshipStyleExcludeDefaults(
-  props?: ast.SpecificationRelationshipKind['props']
+  props: ast.SpecificationRelationshipKind['props'] | undefined,
+  isValid: IsValidFn,
 ) {
-  const { color, line, head, tail } = toRelationshipStyle(props?.filter(ast.isRelationshipStyleProperty))
+  const { color, line, head, tail } = toRelationshipStyle(props?.filter(ast.isRelationshipStyleProperty), isValid)
   return {
     ...(color && color !== DefaultRelationshipColor ? { color } : {}),
     ...(line && line !== DefaultLineStyle ? { line } : {}),
     ...(head && head !== DefaultArrowType ? { head } : {}),
-    ...(tail ? { tail } : {})
+    ...(tail ? { tail } : {}),
   }
 }
 
@@ -474,7 +438,7 @@ export function toColor(astNode: ast.ColorProperty): c4.Color | undefined {
 }
 
 export function toAutoLayout(
-  rule: ast.ViewRuleAutoLayout
+  rule: ast.ViewRuleAutoLayout,
 ): c4.ViewRuleAutoLayout {
   const rankSep = rule.rankSep
   const nodeSep = rule.nodeSep
@@ -504,7 +468,7 @@ export function toAutoLayout(
   return {
     direction,
     ...(nodeSep && { nodeSep }),
-    ...(rankSep && { rankSep })
+    ...(rankSep && { rankSep }),
   }
 }
 

package/src/browser.ts

@@ -1,18 +1,22 @@
 import { startLanguageServer as startLanguim } from 'langium/lsp'
 import { BrowserMessageReader, BrowserMessageWriter, createConnection } from 'vscode-languageserver/browser'
-import { createLanguageServices } from './module'
+import { type LikeC4Services, type LikeC4SharedServices, createLanguageServices } from './module'
+
+export { logger as lspLogger, setLogLevel } from './logger'
+export type { DocumentParser, LikeC4ModelBuilder, LikeC4ModelLocator, LikeC4ModelParser } from './model'
 
-export { setLogLevel } from './logger'
-export type * from './model'
-export type * from './module'
 export { createCustomLanguageServices, createLanguageServices, LikeC4Module } from './module'
+export type { LikeC4Services, LikeC4SharedServices } from './module'
 
 // This is an example copied as is from here:
 // https://github.com/microsoft/vscode-extension-samples/blob/main/lsp-web-extension-sample/server/src/browserServerMain.ts
 // the only addition is the following line:
 declare const self: DedicatedWorkerGlobalScope
 
-export function startLanguageServer() {
+export function startLanguageServer(): {
+  shared: LikeC4SharedServices
+  likec4: LikeC4Services
+} {
   /* browser specific setup code */
 
   const messageReader = new BrowserMessageReader(self)
@@ -26,10 +30,5 @@ export function startLanguageServer() {
   // Start the language server with the shared services
   startLanguim(services.shared)
 
-  return {
-    ...services,
-    connection,
-    messageReader,
-    messageWriter
-  }
+  return services
 }