@likec4/core 1.31.0 → 1.32.0

package/src/compute-view/dynamic-view/compute.ts

@@ -1,22 +1,19 @@
 import { filter, findLast, flatMap, hasAtLeast, isTruthy, map, only, pipe, reduce, unique } from 'remeda'
-import { nonNullable } from '../../errors'
-import type { LikeC4Model } from '../../model'
-import { findConnection } from '../../model/connection/model'
-import type { ElementModel } from '../../model/ElementModel'
-import type { AnyAux } from '../../model/types'
+import type { ElementModel, LikeC4Model } from '../../model'
+import { modelConnection } from '../../model'
+import type { AnyAux, aux, scalar } from '../../types'
 import {
   type Color,
   type ComputedDynamicView,
   type ComputedEdge,
-  type DynamicView,
   type DynamicViewStep,
   type NonEmptyArray,
-  type RelationId,
+  type ParsedDynamicView as DynamicView,
   type RelationshipArrowType,
   type RelationshipLineType,
   type StepEdgeId,
-  type Tag,
-  type ViewId,
+  _stage,
+  _type,
   DefaultArrowType,
   DefaultLineStyle,
   DefaultRelationshipColor,
@@ -25,22 +22,25 @@ import {
   isViewRulePredicate,
   stepEdgeId,
 } from '../../types'
+import { nonNullable } from '../../utils'
 import { ancestorsFqn, commonAncestor, parentFqn } from '../../utils/fqn'
 import { applyCustomElementProperties } from '../utils/applyCustomElementProperties'
 import { applyViewRuleStyles } from '../utils/applyViewRuleStyles'
-import { buildComputedNodesFromElements } from '../utils/buildComputedNodes'
+import { buildComputedNodes, elementModelToNodeSource } from '../utils/buildComputedNodes'
 import { buildElementNotations } from '../utils/buildElementNotations'
 import { elementExprToPredicate } from '../utils/elementExpressionToPredicate'
 import { resolveGlobalRulesInDynamicView } from '../utils/resolve-global-rules'
 import { calcViewLayoutHash } from '../utils/view-hash'
 
-type Element = ElementModel
+const { findConnection } = modelConnection
+
+type Element<A extends AnyAux> = ElementModel<A>
 
 namespace DynamicViewCompute {
-  export interface Step {
+  export interface Step<A extends AnyAux> {
     id: StepEdgeId
-    source: Element
-    target: Element
+    source: Element<A>
+    target: Element<A>
     title: string | null
     description?: string
     technology?: string
@@ -48,21 +48,21 @@ namespace DynamicViewCompute {
     line?: RelationshipLineType
     head?: RelationshipArrowType
     tail?: RelationshipArrowType
-    relations: RelationId[]
+    relations: scalar.RelationId[]
     isBackward: boolean
-    navigateTo?: ViewId
-    tags?: NonEmptyArray<Tag>
+    navigateTo?: aux.StrictViewId<A>
+    tags?: aux.Tags<A>
   }
 }
 
-class DynamicViewCompute {
+class DynamicViewCompute<A extends AnyAux> {
   // Intermediate state
-  private explicits = new Set<Element>()
-  private steps = [] as DynamicViewCompute.Step[]
+  private explicits = new Set<Element<A>>()
+  private steps = [] as DynamicViewCompute.Step<A>[]
 
   constructor(
-    protected model: LikeC4Model,
-    protected view: DynamicView,
+    protected model: LikeC4Model<A>,
+    protected view: DynamicView<A>,
   ) {}
 
   private addStep(
@@ -73,7 +73,7 @@ class DynamicViewCompute {
       isBackward,
       navigateTo: stepNavigateTo,
       ...step
-    }: DynamicViewStep,
+    }: DynamicViewStep<A>,
     index: number,
     parent?: number,
   ) {
@@ -110,7 +110,7 @@ class DynamicViewCompute {
     })
   }
 
-  compute(): ComputedDynamicView {
+  compute(): ComputedDynamicView<A> {
     const {
       docUri: _docUri, // exclude docUri
       rules: _rules, // exclude rules
@@ -135,7 +135,7 @@ class DynamicViewCompute {
       stepNum++
     }
 
-    const rules = resolveGlobalRulesInDynamicView(_rules, this.model.globals())
+    const rules = resolveGlobalRulesInDynamicView(_rules, this.model.globals)
 
     for (const rule of rules) {
       if (isViewRulePredicate(rule)) {
@@ -150,21 +150,24 @@ class DynamicViewCompute {
       }
     }
 
-    const elements = [...this.explicits].map(e => e.$element)
-    const nodesMap = buildComputedNodesFromElements(elements)
+    const nodesMap = buildComputedNodes(
+      [...this.explicits].map(elementModelToNodeSource),
+    )
 
-    const edges = this.steps.map(({ source, target, relations, title, isBackward, ...step }) => {
-      const sourceNode = nonNullable(nodesMap.get(source.id), `Source node ${source.id} not found`)
-      const targetNode = nonNullable(nodesMap.get(target.id), `Target node ${target.id} not found`)
-      const edge: ComputedEdge = {
-        parent: commonAncestor(source.id, target.id),
-        source: source.id,
-        target: target.id,
+    const edges = this.steps.map(({ id, source, target, relations, title, isBackward, tags, ...step }) => {
+      const sourceNode = nonNullable(nodesMap.get(source.id as scalar.NodeId), `Source node ${source.id} not found`)
+      const targetNode = nonNullable(nodesMap.get(target.id as scalar.NodeId), `Target node ${target.id} not found`)
+      const edge: ComputedEdge<A> = {
+        id: id as unknown as aux.EdgeId,
+        parent: commonAncestor(source.id, target.id) as scalar.NodeId | null,
+        source: sourceNode.id,
+        target: targetNode.id,
         label: title,
         relations,
         color: DefaultRelationshipColor,
         line: DefaultLineStyle,
         head: DefaultArrowType,
+        tags: tags ?? [],
         ...step,
       }
       if (isBackward) {
@@ -198,16 +201,18 @@ class DynamicViewCompute {
       applyViewRuleStyles(
         rules,
         // Keep order of elements
-        elements.map(e => nonNullable(nodesMap.get(e.id))),
+        [...this.explicits].map(e => nonNullable(nodesMap.get(e.id as scalar.NodeId))),
       ),
     )
 
     const autoLayoutRule = findLast(rules, isViewRuleAutoLayout)
 
-    const elementNotations = buildElementNotations(nodes)
+    const nodeNotations = buildElementNotations(nodes)
 
     return calcViewLayoutHash({
       ...view,
+      [_type]: 'dynamic',
+      [_stage]: 'computed',
       autoLayout: {
         direction: autoLayoutRule?.direction ?? 'LR',
         ...(autoLayoutRule?.nodeSep && { nodeSep: autoLayoutRule.nodeSep }),
@@ -220,19 +225,19 @@ class DynamicViewCompute {
         return n
       }),
       edges,
-      ...(elementNotations.length > 0 && {
+      ...(nodeNotations.length > 0 && {
         notation: {
-          elements: elementNotations,
+          nodes: nodeNotations,
         },
       }),
     })
   }
 
-  private findRelations(source: Element, target: Element): {
+  private findRelations(source: Element<A>, target: Element<A>): {
     title: string | null
-    tags: NonEmptyArray<Tag> | null
-    relations: NonEmptyArray<RelationId> | null
-    navigateTo: ViewId | null
+    tags: aux.Tags<A> | null
+    relations: NonEmptyArray<aux.RelationId> | null
+    navigateTo: aux.StrictViewId<A> | null
     color: Color | null
     line: RelationshipLineType | null
   } {
@@ -252,7 +257,7 @@ class DynamicViewCompute {
       flatMap(r => r.tags),
       filter(isTruthy),
       unique(),
-    )
+    ) as aux.Tags<A>
     const tags = hasAtLeast(alltags, 1) ? alltags : null
     const relations = hasAtLeast(relationships, 1) ? map(relationships, r => r.id) : null
 
@@ -260,14 +265,16 @@ class DynamicViewCompute {
     const relation = only(relationships) || relationships.find(r => r.source === source && r.target === target)
     const relationNavigateTo = relation?.$relationship.navigateTo ?? null
 
-    const navigateTo = relationNavigateTo && relationNavigateTo !== this.view.id ? relationNavigateTo : pipe(
-      relationships,
-      map(r => r.$relationship.navigateTo),
-      filter(isTruthy),
-      filter(v => v !== this.view.id),
-      unique(),
-      only(),
-    )
+    const navigateTo = relationNavigateTo && relationNavigateTo !== this.view.id
+      ? relationNavigateTo as aux.StrictViewId<A>
+      : pipe(
+        relationships,
+        map(r => r.$relationship.navigateTo as aux.StrictViewId<A>),
+        filter(isTruthy),
+        filter(v => v !== this.view.id),
+        unique(),
+        only(),
+      )
 
     const commonProperties = pipe(
       relationships,
@@ -295,7 +302,7 @@ class DynamicViewCompute {
 }
 export function computeDynamicView<M extends AnyAux>(
   model: LikeC4Model<M>,
-  view: DynamicView,
-): ComputedDynamicView {
+  view: DynamicView<M>,
+): ComputedDynamicView<M> {
   return new DynamicViewCompute(model, view).compute()
 }

package/src/compute-view/element-view/__test__/TestHelper.ts

@@ -11,15 +11,24 @@ import {
 } from '../../../builder'
 import * as viewhelpers from '../../../builder/Builder.view-common'
 import { mkViewBuilder } from '../../../builder/Builder.views'
+import type { ConnectionModel, ElementModel, LikeC4Model } from '../../../model'
 import { differenceConnections } from '../../../model/connection'
-import type { ComputedElementView, ElementView, ViewId, ViewRule } from '../../../types'
+import {
+  type Any,
+  type ComputedElementView,
+  type ComputedView,
+  type ParsedElementView as ElementView,
+  type ViewId,
+  type ViewRule,
+  _stage,
+  _type,
+} from '../../../types'
 import { compareNatural } from '../../../utils'
 import { imap, toArray } from '../../../utils/iterable'
 import { difference as differenceSet } from '../../../utils/set'
-import type { CtxConnection, CtxElement } from '../../memory'
 import { withReadableEdges } from '../../utils/with-readable-edges'
 import { processPredicates as processPredicatesImpl } from '../compute'
-import { type Ctx, Memory } from '../memory'
+import { Memory } from '../memory'
 
 type ConnectionExpression<T extends AnyTypes> = `${T['Fqn']} -> ${T['Fqn']}`
 
@@ -38,11 +47,13 @@ type ConnectionEqual<T extends AnyTypes> = [ConnectionsDeepMatcher<ConnectionExp
   ...ConnectionExpression<T>[],
 ]
 
-type Elem = CtxElement<Ctx>
-type Connection = CtxConnection<Ctx>
-
 export class TestHelper<T extends AnyTypes> {
-  model: Types.ToLikeC4Model<T>
+  model: LikeC4Model.Computed<Types.ToAux<T>>
+
+  Aux!: typeof this.model.Aux
+  Elem!: ElementModel<typeof this.Aux>
+  Connection!: ConnectionModel<typeof this.Aux>
+  CompView!: ComputedElementView<typeof this.Aux>
 
   static $include = viewhelpers.$include
   static $exclude = viewhelpers.$exclude
@@ -53,7 +64,10 @@ export class TestHelper<T extends AnyTypes> {
   $exclude = viewhelpers.$exclude
   $style = viewhelpers.$style
 
-  static from<const T extends AnyTypes>(builder: Builder<T>, expect = vitestExpect): TestHelper<T> {
+  static from<const T extends AnyTypes>(
+    builder: Builder<T>,
+    expect = vitestExpect,
+  ): TestHelper<T> {
     return new TestHelper(builder, expect)
   }
 
@@ -61,7 +75,7 @@ export class TestHelper<T extends AnyTypes> {
     private builder: Builder<T>,
     private _expect: ExpectStatic,
   ) {
-    this.model = builder.toLikeC4Model() as Types.ToLikeC4Model<T>
+    this.model = builder.toLikeC4Model()
   }
 
   computeView = (...rules: ElementViewRulesBuilder<T>[]) => {
@@ -71,7 +85,7 @@ export class TestHelper<T extends AnyTypes> {
         .views(_ => _.view('dev').with(...rules))
         .toLikeC4Model()
         .view('dev')
-        .$view as ComputedElementView<'dev'>,
+        .$view,
       ' -> ',
     )
   }
@@ -83,7 +97,7 @@ export class TestHelper<T extends AnyTypes> {
     return ProcessPredicates.executeWithScope(this, scope, ...rules)
   }
 
-  expectView(view: ComputedElementView) {
+  expectView(view: ComputedView) {
     return {
       toHave: (nodesAndEdges: { nodes: Array<T['Fqn']>; edges: Array<ConnectionExpression<T>> }) => {
         const actual = {
@@ -116,17 +130,17 @@ export class TestHelper<T extends AnyTypes> {
       this._expect(map([...memory.final], prop('id'))).toEqual(ids)
     },
     toHaveConnections: (...matchers: ConnectionEqual<T>) => {
-      this.expectConnections(memory.connections).toEqual(...matchers)
+      this.expectConnections(memory.connections as any).toEqual(...matchers)
     },
   })
 
-  expectElements = (elements: ReadonlySet<Elem>) => ({
+  expectElements = (elements: ReadonlySet<ElementModel<Any>>) => ({
     toEqual: <const Id extends ViewPredicate.DeploymentConnectionExpression<T>>(...ids: Id[]) => {
       this._expect(toArray(imap(elements, prop('id')))).toEqual(ids)
     },
   })
 
-  expectConnections = (connections: ReadonlyArray<Connection>) => ({
+  expectConnections = (connections: ReadonlyArray<typeof this.Connection>) => ({
     toBeEmpty: () => {
       this._expect(connections.map(c => c.expression)).to.be.empty
     },
@@ -150,11 +164,18 @@ export class TestHelper<T extends AnyTypes> {
     ...this.expectMemory(step.memory),
   })
 
-  expect(value: ComputedElementView): ReturnType<typeof this['expectView']>
-  expect(value: Set<Elem>): ReturnType<typeof this['expectElements']>
-  expect(value: ReadonlyArray<Connection>): ReturnType<typeof this['expectConnections']>
+  expect(value: typeof this.CompView): ReturnType<typeof this['expectView']>
+  expect(value: Set<ElementModel<Any>>): ReturnType<typeof this['expectElements']>
+  expect(value: ReadonlyArray<typeof this.Connection>): ReturnType<typeof this['expectConnections']>
   expect(value: Memory | ProcessPredicates<T>): ReturnType<typeof this['expectMemory']>
-  expect(value: Memory | ProcessPredicates<T> | Set<Elem> | ComputedElementView | ReadonlyArray<Connection>) {
+  expect(
+    value:
+      | Memory
+      | ProcessPredicates<T>
+      | Set<ElementModel<Any>>
+      | typeof this.CompView
+      | ReadonlyArray<typeof this.Connection>,
+  ) {
     if (value instanceof Memory) {
       return this.expectMemory(value)
     }
@@ -172,11 +193,11 @@ export class TestHelper<T extends AnyTypes> {
 }
 
 class ProcessPredicates<T extends AnyTypes> {
-  static execute<A extends AnyTypes>(
-    test: TestHelper<A>,
-    ...rules: ElementViewRulesBuilder<A>[]
-  ): ProcessPredicates<A> {
-    const processor = new ProcessPredicates(test)
+  static execute<B extends AnyTypes>(
+    test: TestHelper<B>,
+    ...rules: ElementViewRulesBuilder<B>[]
+  ) {
+    const processor = new ProcessPredicates<B>(test)
     processor.next(...rules)
     return processor
   }
@@ -185,13 +206,13 @@ class ProcessPredicates<T extends AnyTypes> {
     test: TestHelper<A>,
     scope: A['Fqn'],
     ...rules: ElementViewRulesBuilder<A>[]
-  ): ProcessPredicates<A> {
-    const processor = new ProcessPredicates(test, scope)
+  ) {
+    const processor = new ProcessPredicates<A>(test, scope)
     processor.next(...rules)
     return processor
   }
 
-  public viewrules: ReadonlyArray<ViewRule> = []
+  public viewrules: ReadonlyArray<ViewRule<typeof this.t.model.Aux>> = []
 
   public previousMemory: Memory = Memory.empty(null)
   public memory: Memory = Memory.empty(null)
@@ -233,9 +254,12 @@ class ProcessPredicates<T extends AnyTypes> {
   next(...predicates: ElementViewRulesBuilder<T>[]): this {
     const view = {
       id: 'test' as ViewId,
-      __: 'element',
+      [_stage]: 'parsed',
+      [_type]: 'element',
       rules: [],
-    } as any as Writable<ElementView>
+      title: null,
+      description: null,
+    } as Writable<ElementView<typeof this.t.model.Aux>>
     let vb = mkViewBuilder(view) as any
     this.predicates = [
       ...this.predicates,
@@ -249,7 +273,7 @@ class ProcessPredicates<T extends AnyTypes> {
     const scope = this.scope ? this.t.model.element(this.scope) : null
     this.memory = processPredicatesImpl(
       this.t.model,
-      Memory.empty(scope),
+      Memory.empty(scope as any),
       view.rules,
     )
     this.age++

package/src/compute-view/element-view/__test__/__snapshots__/legacy.spec.ts.snap

@@ -2,11 +2,11 @@
 
 exports[`compute-element-view > view of cloud 1`] = `
 {
-  "__": "element",
+  "_stage": "computed",
+  "_type": "element",
   "autoLayout": {
     "direction": "TB",
   },
-  "customColorDefinitions": {},
   "description": null,
   "edges": [
     {
@@ -89,14 +89,14 @@ exports[`compute-element-view > view of cloud 1`] = `
       "kind": "actor",
       "level": 0,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "customer",
       "outEdges": [
         "customer:cloud.frontend",
       ],
       "parent": null,
       "shape": "person",
       "style": {},
-      "tags": null,
+      "tags": [],
       "technology": null,
       "title": "customer",
     },
@@ -109,14 +109,14 @@ exports[`compute-element-view > view of cloud 1`] = `
       "kind": "actor",
       "level": 0,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "support",
       "outEdges": [
         "support:cloud.frontend",
       ],
       "parent": null,
       "shape": "person",
       "style": {},
-      "tags": null,
+      "tags": [],
       "technology": null,
       "title": "support",
     },
@@ -136,7 +136,7 @@ exports[`compute-element-view > view of cloud 1`] = `
       "kind": "system",
       "level": 0,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "cloud",
       "outEdges": [
         "cloud.backend:email",
         "cloud.backend:amazon",
@@ -163,14 +163,14 @@ exports[`compute-element-view > view of cloud 1`] = `
       "kind": "container",
       "level": 1,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "cloud.frontend",
       "outEdges": [
         "cloud.frontend:cloud.backend",
       ],
       "parent": "cloud",
       "shape": "browser",
       "style": {},
-      "tags": null,
+      "tags": [],
       "technology": null,
       "title": "frontend",
     },
@@ -185,7 +185,7 @@ exports[`compute-element-view > view of cloud 1`] = `
       "kind": "container",
       "level": 1,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "cloud.backend",
       "outEdges": [
         "cloud.backend:email",
         "cloud.backend:amazon",
@@ -193,7 +193,7 @@ exports[`compute-element-view > view of cloud 1`] = `
       "parent": "cloud",
       "shape": "rectangle",
       "style": {},
-      "tags": null,
+      "tags": [],
       "technology": null,
       "title": "backend",
     },
@@ -208,12 +208,12 @@ exports[`compute-element-view > view of cloud 1`] = `
       "kind": "system",
       "level": 0,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "email",
       "outEdges": [],
       "parent": null,
       "shape": "rectangle",
       "style": {},
-      "tags": null,
+      "tags": [],
       "technology": null,
       "title": "email",
     },
@@ -229,7 +229,7 @@ exports[`compute-element-view > view of cloud 1`] = `
       "kind": "system",
       "level": 0,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "amazon",
       "outEdges": [],
       "parent": null,
       "shape": "rectangle",
@@ -249,11 +249,11 @@ exports[`compute-element-view > view of cloud 1`] = `
 
 exports[`compute-element-view > view of cloud.frontend 1`] = `
 {
-  "__": "element",
+  "_stage": "computed",
+  "_type": "element",
   "autoLayout": {
     "direction": "TB",
   },
-  "customColorDefinitions": {},
   "description": null,
   "edges": [
     {
@@ -321,14 +321,14 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "kind": "actor",
       "level": 0,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "customer",
       "outEdges": [
         "customer:cloud.frontend.dashboard",
       ],
       "parent": null,
       "shape": "person",
       "style": {},
-      "tags": null,
+      "tags": [],
       "technology": null,
       "title": "customer",
     },
@@ -341,14 +341,14 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "kind": "actor",
       "level": 0,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "support",
       "outEdges": [
         "support:cloud.frontend.supportPanel",
       ],
       "parent": null,
       "shape": "person",
       "style": {},
-      "tags": null,
+      "tags": [],
       "technology": null,
       "title": "support",
     },
@@ -368,7 +368,7 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "kind": "container",
       "level": 0,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "cloud.frontend",
       "outEdges": [
         "cloud.frontend.dashboard:cloud.backend",
         "cloud.frontend.supportPanel:cloud.backend",
@@ -376,7 +376,7 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "parent": null,
       "shape": "browser",
       "style": {},
-      "tags": null,
+      "tags": [],
       "technology": null,
       "title": "frontend",
     },
@@ -392,7 +392,7 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "kind": "component",
       "level": 1,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "cloud.frontend.dashboard",
       "outEdges": [
         "cloud.frontend.dashboard:cloud.backend",
       ],
@@ -416,7 +416,7 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "kind": "component",
       "level": 1,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "cloud.frontend.supportPanel",
       "outEdges": [
         "cloud.frontend.supportPanel:cloud.backend",
       ],
@@ -441,12 +441,12 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "kind": "container",
       "level": 0,
       "links": null,
-      "modelRef": 1,
+      "modelRef": "cloud.backend",
       "outEdges": [],
       "parent": null,
       "shape": "rectangle",
       "style": {},
-      "tags": null,
+      "tags": [],
       "technology": null,
       "title": "backend",
     },