@likec4/core 1.17.1 → 1.18.0

package/src/types/expression.ts

@@ -3,7 +3,7 @@ import type { BorderStyle, ElementKind, ElementShape, Fqn, Tag } from './element
 import type { WhereOperator } from './operators'
 import type { RelationshipArrowType, RelationshipLineType } from './relation'
 import type { Color } from './theme'
-import type { ViewID } from './view'
+import type { ViewId } from './view'
 
 interface BaseExpr {
   where?: never
@@ -13,7 +13,8 @@ interface BaseExpr {
   elementKind?: never
   elementTag?: never
   isEqual?: never
-  isDescedants?: never
+  isChildren?: never
+  isDescendants?: never
   wildcard?: never
   source?: never
   target?: never
@@ -23,9 +24,10 @@ interface BaseExpr {
   customRelation?: never
 }
 
-export interface ElementRefExpr extends Omit<BaseExpr, 'element' | 'isDescedants'> {
+export interface ElementRefExpr extends Omit<BaseExpr, 'element' | 'isChildren' | 'isDescendants'> {
   element: Fqn
-  isDescedants?: boolean
+  isChildren?: boolean
+  isDescendants?: boolean
 }
 export function isElementRef(expr: Expression): expr is ElementRefExpr {
   return 'element' in expr
@@ -50,7 +52,7 @@ export interface CustomElementExpr extends Omit<BaseExpr, 'custom'> {
     icon?: IconUrl
     border?: BorderStyle
     opacity?: number
-    navigateTo?: ViewID
+    navigateTo?: ViewId
   }
 }
 
@@ -162,7 +164,7 @@ export interface CustomRelationExpr extends Omit<BaseExpr, 'customRelation'> {
     technology?: string
     notation?: string
     // Link to dynamic view
-    navigateTo?: ViewID
+    navigateTo?: ViewId
     // Notes for walkthrough
     notes?: string
     color?: Color

package/src/types/index.ts

@@ -1,4 +1,5 @@
 export * from './_common'
+export * from './deployments'
 export * from './element'
 export * from './expression'
 export * from './global'

package/src/types/model.ts

@@ -1,7 +1,14 @@
+import type { KeysOf } from './_common'
+import type {
+  DeploymentElement,
+  DeploymentNodeKind,
+  DeploymentNodeKindSpecification,
+  DeploymentRelation
+} from './deployments'
 import type { ElementKindSpecification, Tag, TypedElement } from './element'
 import type { ModelGlobals } from './global'
-import type { Relation, RelationID, RelationshipKindSpecification } from './relation'
-import type { ComputedView, DiagramView, LikeC4View, ViewID } from './view'
+import type { Relation, RelationId, RelationshipKindSpecification } from './relation'
+import type { ComputedView, DiagramView, LikeC4View } from './view'
 
 /**
  * Parsed elements, relations, and views.
@@ -11,31 +18,83 @@ export interface ParsedLikeC4Model<
   RelationKinds extends string = string,
   Tags extends string = string,
   Fqns extends string = string,
-  Views extends string = string
+  Views extends string = string,
+  DeploymentFqns extends string = string
 > {
   specification: {
     tags: Tag<Tags>[]
     elements: Record<ElementKinds, ElementKindSpecification>
+    deployments: Record<DeploymentNodeKind, DeploymentNodeKindSpecification>
     relationships: Record<RelationKinds, RelationshipKindSpecification>
   }
   elements: Record<Fqns, TypedElement<Fqns, ElementKinds, Tags>>
-  relations: Record<RelationID, Relation>
+  relations: Record<RelationId, Relation>
   globals: ModelGlobals
   views: Record<Views, LikeC4View<Views, Tags>>
+  /**
+   * Deployment Model.
+   */
+  deployments: {
+    elements: Record<DeploymentFqns, DeploymentElement>
+    relations: Record<RelationId, DeploymentRelation>
+  }
+}
+/**
+ * Hook to get types from dump
+ */
+export type ParsedLikeC4ModelDump = {
+  elements: {
+    [kind: string]: object
+  }
+  deployments: {
+    elements: {
+      [kind: string]: object
+    }
+  }
+  views: {
+    [kind: string]: object
+  }
+}
+
+export interface AnyLikeC4Model<
+  Fqns extends string = string,
+  DeploymentFqns extends string = string,
+  Views extends string = string,
+  Tags extends string = string,
+  T = 'computed' | 'layouted'
+> extends Omit<ParsedLikeC4Model<string, string, Tags, Fqns, Views, DeploymentFqns>, 'views'> {
+  __?: T
+  views: Record<Views, ComputedView | DiagramView>
 }
 
 /**
  * Same as `ParsedLikeC4Model` but with computed views.
  */
-export interface ComputedLikeC4Model extends Omit<ParsedLikeC4Model, 'views'> {
-  __?: never
-  views: Record<ViewID, ComputedView>
+export interface ComputedLikeC4Model<
+  Fqns extends string = string,
+  DeploymentFqns extends string = string,
+  Views extends string = string,
+  Tags extends string = string
+> extends Omit<AnyLikeC4Model<Fqns, DeploymentFqns, Views, Tags, 'computed'>, 'views'> {
+  views: Record<Views, ComputedView>
 }
 
+export type ComputedLikeC4ModelFromParsed<M> = M extends ParsedLikeC4Model ? ComputedLikeC4Model<
+    KeysOf<M['elements']>,
+    KeysOf<M['deployments']['elements']>,
+    KeysOf<M['views']>
+  >
+  : ComputedLikeC4Model
+
 /**
  * Same as `ParsedLikeC4Model` but with layouted views (DiagramView)
  */
-export interface LayoutedLikeC4Model extends Omit<ParsedLikeC4Model, 'views'> {
+export interface LayoutedLikeC4Model<
+  Fqns extends string = string,
+  DeploymentFqns extends string = string,
+  Views extends string = string,
+  Tags extends string = string
+> extends Omit<AnyLikeC4Model<Fqns, DeploymentFqns, Views, Tags, 'layouted'>, 'views'> {
   __: 'layouted'
-  views: Record<ViewID, DiagramView>
+  views: Record<Views, DiagramView<Views, Tags>>
 }

package/src/types/overview-graph.ts

@@ -1,5 +1,5 @@
 import type { NonEmptyArray, Point, XYPoint } from './_common'
-import type { BBox, ViewID } from './view'
+import type { BBox, ViewId } from './view'
 
 /**
  * OverviewGraph is a graph representation of all views in a model
@@ -17,7 +17,7 @@ export namespace OverviewGraph {
   } | {
     id: string
     type: 'view'
-    viewId: ViewID
+    viewId: ViewId
     label: string
     parentId: string | null
     position: XYPoint

package/src/types/relation.ts

@@ -2,9 +2,9 @@ import type { Tagged } from 'type-fest'
 import type { NonEmptyArray } from './_common'
 import type { Fqn, Link, Tag } from './element'
 import type { Color, ThemeColor } from './theme'
-import type { ViewID } from './view'
+import type { ViewId } from './view'
 
-export type RelationID = Tagged<string, 'RelationID'>
+export type RelationId = Tagged<string, 'RelationID'>
 export type RelationshipKind<Kinds extends string = string> = Tagged<Kinds, 'RelationshipKind'>
 
 export type RelationshipLineType = 'dashed' | 'solid' | 'dotted'
@@ -28,7 +28,7 @@ export const DefaultRelationshipColor = 'gray' satisfies ThemeColor
 
 // TODO: rename to Relationship
 export interface Relation {
-  readonly id: RelationID
+  readonly id: RelationId
   readonly source: Fqn
   readonly target: Fqn
   readonly title: string
@@ -42,7 +42,7 @@ export interface Relation {
   readonly tail?: RelationshipArrowType
   readonly links?: NonEmptyArray<Link>
   // Link to dynamic view
-  readonly navigateTo?: ViewID
+  readonly navigateTo?: ViewId
   readonly metadata?: { [key: string]: string }
 }
 

package/src/types/view-notation.ts

@@ -1,8 +1,8 @@
-import type { ElementKind, ElementShape } from './element'
+import type { ElementShape } from './element'
 import type { Color } from './theme'
 
 export type ElementNotation = {
-  kinds: ElementKind[]
+  kinds: string[]
   shape: ElementShape
   color: Color
   title: string

package/src/types/view.ts

@@ -1,6 +1,7 @@
 import { isArray, isNullish } from 'remeda'
 import type { Tagged } from 'type-fest'
 import type { IconUrl, NonEmptyArray, Point, XYPoint } from './_common'
+import type { DeploymentExpression } from './deployments'
 import {
   type BorderStyle,
   ElementKind,
@@ -12,11 +13,11 @@ import {
 } from './element'
 import type { ElementExpression, ElementPredicateExpression, Expression } from './expression'
 import type { GlobalPredicateId, GlobalStyleID } from './global'
-import type { RelationID, RelationshipArrowType, RelationshipKind, RelationshipLineType } from './relation'
+import type { RelationId, RelationshipArrowType, RelationshipKind, RelationshipLineType } from './relation'
 import type { Color, ThemeColorValues } from './theme'
 import type { ElementNotation } from './view-notation'
 
-export type ViewID<Id extends string = string> = Tagged<Id, 'ViewID'>
+export type ViewId<Id extends string = string> = Tagged<Id, 'ViewID'>
 
 export type ViewRulePredicate =
   | {
@@ -27,7 +28,11 @@ export type ViewRulePredicate =
     include?: never
     exclude: Expression[]
   }
-export function isViewRulePredicate(rule: ViewRule): rule is ViewRulePredicate {
+
+export function isViewRulePredicate(rule: DeploymentViewRule): rule is DeploymentViewRulePredicate
+export function isViewRulePredicate(rule: DynamicViewRule): rule is DynamicViewIncludeRule
+export function isViewRulePredicate(rule: ViewRule): rule is ViewRulePredicate
+export function isViewRulePredicate(rule: object) {
   return (
     ('include' in rule && Array.isArray(rule.include))
     || ('exclude' in rule && Array.isArray(rule.exclude))
@@ -50,8 +55,10 @@ export interface ViewRuleStyle {
     icon?: IconUrl
   }
 }
-export function isViewRuleStyle(rule: ViewRule): rule is ViewRuleStyle {
-  return 'style' in rule && 'targets' in rule
+export function isViewRuleStyle(rule: DeploymentViewRule): rule is DeploymentViewRuleStyle
+export function isViewRuleStyle(rule: ViewRule): rule is ViewRuleStyle
+export function isViewRuleStyle(rule: object) {
+  return 'style' in rule && 'targets' in rule && Array.isArray(rule.targets)
 }
 
 export interface ViewRuleGlobalStyle {
@@ -73,7 +80,10 @@ export interface ViewRuleAutoLayout {
   nodeSep?: number
   rankSep?: number
 }
-export function isViewRuleAutoLayout(rule: ViewRule): rule is ViewRuleAutoLayout {
+
+export function isViewRuleAutoLayout(
+  rule: DeploymentViewRule | DynamicViewRule | ViewRule
+): rule is ViewRuleAutoLayout {
   return 'direction' in rule
 }
 
@@ -99,12 +109,12 @@ export type ViewRule =
   | ViewRuleAutoLayout
 
 export interface BasicView<
-  ViewType extends 'element' | 'dynamic',
+  ViewType extends 'element' | 'dynamic' | 'deployment',
   ViewIDs extends string,
   Tags extends string
 > {
   readonly __?: ViewType
-  readonly id: ViewID<ViewIDs>
+  readonly id: ViewId<ViewIDs>
   readonly title: string | null
   readonly description: string | null
   readonly tags: NonEmptyArray<Tag<Tags>> | null
@@ -148,7 +158,7 @@ export interface ScopedElementView<ViewIDs extends string, Tags extends string>
 export interface ExtendsElementView<ViewIDs extends string, Tags extends string>
   extends BasicElementView<ViewIDs, Tags>
 {
-  readonly extends: ViewID<ViewIDs>
+  readonly extends: ViewId<ViewIDs>
 }
 export type ElementView<
   ViewIDs extends string = string,
@@ -173,7 +183,7 @@ export interface DynamicViewStep {
   readonly tail?: RelationshipArrowType
   readonly isBackward?: boolean
   // Link to dynamic view
-  readonly navigateTo?: ViewID
+  readonly navigateTo?: ViewId
   __parallel?: never
 }
 
@@ -187,10 +197,6 @@ export type DynamicViewIncludeRule = {
   include: ElementPredicateExpression[]
 }
 
-export function isDynamicViewIncludeRule(rule: DynamicViewRule): rule is DynamicViewIncludeRule {
-  return 'include' in rule && Array.isArray(rule.include)
-}
-
 export type DynamicViewRule =
   | DynamicViewIncludeRule
   | ViewRuleGlobalPredicateRef
@@ -214,11 +220,44 @@ export function isDynamicViewParallelSteps(step: DynamicViewStepOrParallel): ste
 
 export type CustomColorDefinitions = { [key: string]: ThemeColorValues }
 
+export type DeploymentViewRulePredicate =
+  | {
+    include: DeploymentExpression[]
+    exclude?: never
+  }
+  | {
+    include?: never
+    exclude: DeploymentExpression[]
+  }
+export type DeploymentViewRuleStyle = {
+  targets: DeploymentExpression[]
+  notation?: string
+  style: ElementStyle & {
+    color?: Color
+    shape?: ElementShape
+    icon?: IconUrl
+  }
+}
+export type DeploymentViewRule = DeploymentViewRulePredicate | ViewRuleAutoLayout | DeploymentViewRuleStyle
+
+export interface DeploymentView<
+  ViewIDs extends string = string,
+  Tags extends string = string
+> extends BasicView<'deployment', ViewIDs, Tags> {
+  readonly __: 'deployment'
+  readonly rules: DeploymentViewRule[]
+}
+
 export type LikeC4View<
   ViewIDs extends string = string,
   Tags extends string = string
-> = ElementView<ViewIDs, Tags> | DynamicView<ViewIDs, Tags>
+> = ElementView<ViewIDs, Tags> | DynamicView<ViewIDs, Tags> | DeploymentView<ViewIDs, Tags>
 
+export function isDeploymentView(view: LikeC4View): view is DeploymentView
+export function isDeploymentView<V extends { __?: string }>(view: V): boolean
+export function isDeploymentView(view: LikeC4View): view is DeploymentView {
+  return view.__ === 'deployment'
+}
 export function isDynamicView(view: LikeC4View): view is DynamicView {
   return view.__ === 'dynamic'
 }
@@ -239,7 +278,7 @@ export type NodeId<IDs extends string = string> = Tagged<IDs, 'Fqn'>
 export type EdgeId = Tagged<string, 'EdgeId'>
 export type StepEdgeIdLiteral = `step-${number}` | `step-${number}.${number}`
 export type StepEdgeId = Tagged<StepEdgeIdLiteral, 'EdgeId'>
-export function StepEdgeId(step: number, parallelStep?: number): StepEdgeId {
+export function stepEdgeId(step: number, parallelStep?: number): StepEdgeId {
   const id = `step-${String(step).padStart(2, '0')}` as StepEdgeId
   return parallelStep ? `${id}.${parallelStep}` as StepEdgeId : id
 }
@@ -266,8 +305,18 @@ export function getParallelStepsPrefix(id: string): string | null {
 
 export interface ComputedNode {
   id: NodeId
-  kind: ElementKind
+  kind: string // TODO: fix ElementKind | DeploymentNodeKind
   parent: NodeId | null
+  /**
+   * Reference to model element
+   * If 1 - node id is a reference
+   */
+  modelRef?: 1 | Fqn
+  /**
+   * Reference to deployment element
+   * If 1 - node id is a reference
+   */
+  deploymentRef?: 1 | Fqn
   title: string
   description: string | null
   technology: string | null
@@ -278,16 +327,13 @@ export interface ComputedNode {
   inEdges: EdgeId[]
   outEdges: EdgeId[]
   shape: ElementShape
-  /**
-   * @deprecated Use `style` instead
-   */
   color: Color
   /**
    * @deprecated Use `style` instead
    */
   icon?: IconUrl
   style: ElementStyle
-  navigateTo?: ViewID
+  navigateTo?: ViewId
   level: number
   // For compound nodes, the max depth of nested nodes
   depth?: number
@@ -297,6 +343,12 @@ export interface ComputedNode {
   isCustomized?: boolean
 }
 export namespace ComputedNode {
+  export function modelRef(node: ComputedNode): Fqn | null {
+    return node.modelRef === 1 ? node.id : (node.modelRef ?? null)
+  }
+  export function deploymentRef(node: ComputedNode): Fqn | null {
+    return node.deploymentRef === 1 ? node.id : (node.deploymentRef ?? null)
+  }
   /**
    * Nodes group is a special kind of node, exisiting only in view
    */
@@ -313,7 +365,7 @@ export interface ComputedEdge {
   label: string | null
   description?: string
   technology?: string
-  relations: RelationID[]
+  relations: RelationId[]
   kind?: RelationshipKind
   notation?: string
   // Notes for walkthrough
@@ -324,7 +376,7 @@ export interface ComputedEdge {
   tail?: RelationshipArrowType
   tags?: NonEmptyArray<Tag>
   // Link to dynamic view
-  navigateTo?: ViewID
+  navigateTo?: ViewId
   /**
    * If this edge is derived from custom relationship predicate
    */
@@ -333,7 +385,7 @@ export interface ComputedEdge {
    * For layouting purposes
    * @default 'forward'
    */
-  dir?: 'forward' | 'back'
+  dir?: 'forward' | 'back' | 'both'
 }
 
 export interface ViewWithHash {
@@ -358,7 +410,7 @@ export interface ComputedElementView<
   ViewIDs extends string = string,
   Tags extends string = string
 > extends Omit<ElementView<ViewIDs, Tags>, 'rules' | 'docUri'>, ViewWithHash, ViewWithNotation {
-  readonly extends?: ViewID<ViewIDs>
+  readonly extends?: ViewId<ViewIDs>
   readonly autoLayout: ViewAutoLayout
   readonly nodes: ComputedNode[]
   readonly edges: ComputedEdge[]
@@ -376,17 +428,33 @@ export interface ComputedDynamicView<
   rules?: never
   docUri?: never
 }
-export function isComputedDynamicView(view: ComputedView): view is ComputedDynamicView {
-  return view.__ === 'dynamic'
+
+export interface ComputedDeploymentView<
+  ViewIDs extends string = string,
+  Tags extends string = string
+> extends Omit<DeploymentView<ViewIDs, Tags>, 'rules' | 'docUri'>, ViewWithHash, ViewWithNotation {
+  readonly autoLayout: ViewAutoLayout
+  readonly nodes: ComputedNode[]
+  readonly edges: ComputedEdge[]
+  rules?: never
+  docUri?: never
 }
 
 export type ComputedView<
   ViewIDs extends string = string,
   Tags extends string = string
-> = ComputedElementView<ViewIDs, Tags> | ComputedDynamicView<ViewIDs, Tags>
+> = ComputedElementView<ViewIDs, Tags> | ComputedDynamicView<ViewIDs, Tags> | ComputedDeploymentView<ViewIDs, Tags>
 
-export function isComputedElementView(view: ComputedView): view is ComputedElementView {
-  return isNullish(view.__) || view.__ === 'element'
+export namespace ComputedView {
+  export function isDeployment(view: ComputedView): view is ComputedDeploymentView {
+    return view.__ === 'deployment'
+  }
+  export function isDynamic(view: ComputedView): view is ComputedDynamicView {
+    return view.__ === 'dynamic'
+  }
+  export function isElement(view: ComputedView): view is ComputedElementView {
+    return isNullish(view.__) || view.__ === 'element'
+  }
 }
 
 // Bounding box
@@ -418,6 +486,12 @@ export interface DiagramNode extends ComputedNode {
 }
 
 export namespace DiagramNode {
+  export function modelRef(node: DiagramNode): Fqn | null {
+    return node.modelRef === 1 ? node.id : (node.modelRef ?? null)
+  }
+  export function deploymentRef(node: DiagramNode): Fqn | null {
+    return node.deploymentRef === 1 ? node.id : (node.deploymentRef ?? null)
+  }
   /**
    * Nodes group is a special kind of node, exisiting only in view
    */

package/src/utils/{commonHead.ts → common-head.ts}

@@ -2,6 +2,8 @@ import { map, pipe, takeWhile, zip } from 'remeda'
 
 /**
  * Common head of two arrays
+ *
+ * @param equals - Equality function, defaults to `Object.is`
  */
 export function commonHead<T>(
   sources: ReadonlyArray<T>,