@likec4/core 1.18.0 → 1.19.0

package/src/builder/__snapshots__/Builder.spec.ts.snap

@@ -0,0 +1,374 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Builder > should build nested elements and relTo 1`] = `
+{
+  "deployments": {
+    "elements": {},
+    "relations": {},
+  },
+  "elements": {
+    "s1": {
+      "color": "green",
+      "description": null,
+      "id": "s1",
+      "kind": "system",
+      "links": null,
+      "shape": "rectangle",
+      "style": {
+        "opacity": 10,
+      },
+      "tags": null,
+      "technology": null,
+      "title": "s1",
+    },
+    "s1.1": {
+      "color": "primary",
+      "description": null,
+      "id": "s1.1",
+      "kind": "component",
+      "links": null,
+      "shape": "browser",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "1",
+    },
+    "s2": {
+      "color": "green",
+      "description": null,
+      "id": "s2",
+      "kind": "system",
+      "links": null,
+      "shape": "rectangle",
+      "style": {
+        "opacity": 10,
+      },
+      "tags": null,
+      "technology": null,
+      "title": "s2",
+    },
+    "s2.1": {
+      "color": "primary",
+      "description": null,
+      "id": "s2.1",
+      "kind": "component",
+      "links": null,
+      "shape": "browser",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "Component s2.1",
+    },
+    "s2.1.2": {
+      "color": "primary",
+      "description": null,
+      "id": "s2.1.2",
+      "kind": "component",
+      "links": null,
+      "shape": "browser",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "Component s2.1.2",
+    },
+    "s2.1.2.3": {
+      "color": "primary",
+      "description": null,
+      "id": "s2.1.2.3",
+      "kind": "component",
+      "links": null,
+      "shape": "browser",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "3",
+    },
+  },
+  "globals": {
+    "dynamicPredicates": {},
+    "predicates": {},
+    "styles": {},
+  },
+  "relations": {
+    "rel1": {
+      "id": "rel1",
+      "source": "s2.1.2.3",
+      "target": "s1.1",
+      "title": "relation from s2.1.2.3 to s1.1",
+    },
+    "rel2": {
+      "id": "rel2",
+      "source": "s2.1",
+      "target": "s1.1",
+      "title": "relation from s2.1 to s1.1",
+    },
+    "rel3": {
+      "id": "rel3",
+      "source": "s1.1",
+      "target": "s2.1.2",
+      "title": "relation from s1.1 to s2.1.2",
+    },
+  },
+  "specification": {
+    "deployments": {},
+    "elements": {
+      "component": {
+        "style": {
+          "shape": "browser",
+        },
+      },
+      "system": {
+        "style": {
+          "color": "green",
+          "opacity": 10,
+        },
+      },
+    },
+    "relationships": {},
+    "tags": [],
+  },
+  "views": {},
+}
+`;
+
+exports[`Builder > should build view  1`] = `
+{
+  "deployments": {
+    "elements": {},
+    "relations": {},
+  },
+  "elements": {
+    "1": {
+      "color": "primary",
+      "description": null,
+      "id": "1",
+      "kind": "component",
+      "links": null,
+      "shape": "rectangle",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "1",
+    },
+    "2": {
+      "color": "primary",
+      "description": null,
+      "id": "2",
+      "kind": "component",
+      "links": null,
+      "shape": "rectangle",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "2",
+    },
+    "3": {
+      "color": "primary",
+      "description": null,
+      "id": "3",
+      "kind": "component",
+      "links": null,
+      "shape": "rectangle",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "3",
+    },
+  },
+  "globals": {
+    "dynamicPredicates": {},
+    "predicates": {},
+    "styles": {},
+  },
+  "relations": {},
+  "specification": {
+    "deployments": {},
+    "elements": {
+      "component": {},
+    },
+    "relationships": {},
+    "tags": [],
+  },
+  "views": {
+    "1": {
+      "__": "element",
+      "customColorDefinitions": {},
+      "description": null,
+      "id": "1",
+      "links": null,
+      "rules": [
+        {
+          "include": [
+            {
+              "wildcard": true,
+            },
+          ],
+        },
+      ],
+      "tags": null,
+      "title": "View 1",
+    },
+    "2": {
+      "__": "element",
+      "customColorDefinitions": {},
+      "description": null,
+      "id": "2",
+      "links": null,
+      "rules": [
+        {
+          "include": [
+            {
+              "wildcard": true,
+            },
+          ],
+        },
+        {
+          "include": [
+            {
+              "element": "2",
+              "isChildren": true,
+            },
+          ],
+        },
+      ],
+      "tags": null,
+      "title": "view 2",
+    },
+    "3": {
+      "__": "element",
+      "customColorDefinitions": {},
+      "description": null,
+      "id": "3",
+      "links": null,
+      "rules": [
+        {
+          "include": [
+            {
+              "expanded": "3",
+            },
+          ],
+        },
+      ],
+      "tags": null,
+      "title": "",
+    },
+  },
+}
+`;
+
+exports[`Builder > should build viewOf  1`] = `
+{
+  "deployments": {
+    "elements": {},
+    "relations": {},
+  },
+  "elements": {
+    "1": {
+      "color": "primary",
+      "description": null,
+      "id": "1",
+      "kind": "component",
+      "links": null,
+      "shape": "rectangle",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "1",
+    },
+    "2": {
+      "color": "primary",
+      "description": null,
+      "id": "2",
+      "kind": "component",
+      "links": null,
+      "shape": "rectangle",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "2",
+    },
+    "2.3": {
+      "color": "primary",
+      "description": null,
+      "id": "2.3",
+      "kind": "component",
+      "links": null,
+      "shape": "rectangle",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "3",
+    },
+    "2.3.4": {
+      "color": "primary",
+      "description": null,
+      "id": "2.3.4",
+      "kind": "component",
+      "links": null,
+      "shape": "rectangle",
+      "style": {},
+      "tags": null,
+      "technology": null,
+      "title": "4",
+    },
+  },
+  "globals": {
+    "dynamicPredicates": {},
+    "predicates": {},
+    "styles": {},
+  },
+  "relations": {},
+  "specification": {
+    "deployments": {},
+    "elements": {
+      "component": {},
+    },
+    "relationships": {},
+    "tags": [],
+  },
+  "views": {
+    "1": {
+      "__": "element",
+      "customColorDefinitions": {},
+      "description": null,
+      "id": "1",
+      "links": null,
+      "rules": [
+        {
+          "include": [
+            {
+              "wildcard": true,
+            },
+          ],
+        },
+        {
+          "include": [
+            {
+              "inout": {
+                "element": "2.3",
+                "isChildren": true,
+              },
+            },
+          ],
+        },
+        {
+          "exclude": [
+            {
+              "source": {
+                "expanded": "1",
+              },
+              "target": {
+                "element": "2.3",
+                "isChildren": true,
+              },
+            },
+          ],
+        },
+      ],
+      "tags": null,
+      "title": "View 1",
+      "viewOf": "2",
+    },
+  },
+}
+`;

package/src/builder/_types.ts

@@ -1,4 +1,5 @@
-import type { IfNever, IsLiteral, Tagged, TupleToUnion } from 'type-fest'
+import type { IfNever, IsLiteral, IsStringLiteral, Tagged, TupleToUnion } from 'type-fest'
+import type { LikeC4Model } from '../model/LikeC4Model'
 import type {
   BorderStyle,
   Color,
@@ -10,8 +11,11 @@ import type {
   ParsedLikeC4Model,
   RelationshipArrowType,
   RelationshipKindSpecification,
-  RelationshipLineType
+  RelationshipLineType,
 } from '../types'
+import type { ExpressionV2 } from '../types/expression-v2'
+import type { Builder } from './Builder'
+import type { DeploymentRulesBuilderOp } from './Builder.view-deployment'
 
 export type BuilderSpecification = {
   elements: {
@@ -88,6 +92,12 @@ export type Invalid<Message extends string> = Tagged<Message, 'Error'>
 export type Warn<Id, Existing> = IsLiteral<Existing> extends true ? Id extends Existing ? Invalid<'Already exists'> : Id
   : Id
 
+export type ValidId<Id> =
+  // Id extends `${string}.${string}` ? Invalid<'Id must not contain dot'>
+  Id extends `${number}${string}` ? Invalid<'Id must not start with number'>
+    : IsStringLiteral<Id> extends true ? Id
+    : Invalid<'Id must be a literal'>
+
 /**
  * Auxilary type to keep track of the types in builder
  */
@@ -99,7 +109,7 @@ export interface Types<
   Tag extends string,
   MetadataKey extends string,
   DeploymentKind extends string,
-  DeploymentFqn extends string
+  DeploymentFqn extends string,
 > {
   ElementKind: ElementKind
   Fqn: Fqn
@@ -132,7 +142,7 @@ export interface TypesNested<
   Tag extends string,
   MetadataKey extends string,
   DeploymentKind extends string,
-  DeploymentFqn extends string
+  DeploymentFqn extends string,
 > extends
   Types<
     ElementKind,
@@ -261,7 +271,20 @@ export namespace Types {
       T['RelationshipKind'],
       T['Tag'],
       T['Fqn'],
-      T['ViewId']
+      T['ViewId'],
+      T['DeploymentFqn']
     >
     : never
+
+  export type ToLikeC4Model<T extends AnyTypes> = LikeC4Model.Computed<
+    T['Fqn'],
+    T['DeploymentFqn'],
+    T['ViewId']
+  >
+
+  export type ToExpression<T> = T extends AnyTypes ? ExpressionV2<T['DeploymentFqn'], T['Fqn']> : never
+
+  export type From<B> = B extends Builder<infer T> ? B['Types'] extends AnyTypes ? T : AnyTypes : never
+
+  export type DeploymentRules<B> = DeploymentRulesBuilderOp<From<B>>
 }

package/src/builder/index.ts

@@ -1,5 +1,11 @@
-export type { AnyTypes, AnyTypesNested, BuilderSpecification, Types, TypesNested } from './_types'
+export type * from './_types'
 export { Builder } from './Builder'
-export type { ModelBuilder, ModelHelpers } from './Builder.model'
-export type { ViewBuilder, ViewHelpers } from './Builder.view'
-export type { ViewsBuilder } from './Builder.views'
+export type * from './Builder.deployment'
+export type * from './Builder.deploymentModel'
+export type * from './Builder.element'
+export type * from './Builder.model'
+export type * from './Builder.view-common'
+export type * from './Builder.view-deployment'
+export type * from './Builder.view-element'
+export type * from './Builder.views'
+export type * from './Builder.with'

package/src/colors/index.ts

@@ -3,12 +3,12 @@ import type { HexColorLiteral, LikeC4Theme, ThemeColorValues } from '../types/th
 import { ElementColors } from './element'
 import { RelationshipColors } from './relationships'
 
-export const defaultTheme = {
+export const defaultTheme: LikeC4Theme = {
   elements: ElementColors,
   relationships: RelationshipColors,
   font: 'Arial',
   shadow: '#0a0a0a'
-} satisfies LikeC4Theme
+}
 
 export function computeColorValues(color: HexColorLiteral): ThemeColorValues {
   if (color.match(/^#([0-9a-f]{3}){1,2}$/i)) {

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

@@ -1,9 +1,8 @@
 import { mapValues } from 'remeda'
-import type { SetOptional } from 'type-fest'
 import { nonexhaustive } from '../errors'
 import { LikeC4Model } from '../model'
 import {
-  type ComputedLikeC4ModelFromParsed,
+  type ComputedLikeC4Model,
   type ComputedView,
   isDeploymentView,
   isDynamicView,
@@ -12,11 +11,10 @@ import {
   type ParsedLikeC4Model
 } from '../types'
 import { computeDeploymentView } from './deployment-view/compute'
-import { DynamicViewComputeCtx } from './dynamic-view/compute'
-import { ComputeCtx } from './element-view/compute'
-import { LikeC4ModelGraph } from './LikeC4ModelGraph'
+import { computeDynamicView } from './dynamic-view/compute'
+import { computeElementView } from './element-view/compute'
 
-type ComputeViewResult<V extends ComputedView = ComputedView> =
+export type ComputeViewResult<V extends ComputedView = ComputedView> =
   | {
     isSuccess: true
     error?: undefined
@@ -28,56 +26,49 @@ type ComputeViewResult<V extends ComputedView = ComputedView> =
     view: undefined
   }
 
-type ComputeViewFn = <V extends LikeC4View>(viewsource: V) => ComputeViewResult<ComputedView>
-
-type Params = SetOptional<ParsedLikeC4Model, 'views'>
-export function mkComputeView(model: Params): ComputeViewFn {
-  const index = new LikeC4ModelGraph(model)
-  let likec4model: LikeC4Model
-
-  return function computeView(viewsource) {
-    try {
-      switch (true) {
-        case isDeploymentView(viewsource): {
-          likec4model ??= LikeC4Model.create({
-            ...model,
-            views: {}
-          })
-          return {
-            isSuccess: true,
-            view: computeDeploymentView(likec4model, viewsource)
-          }
-        }
-        case isDynamicView(viewsource):
-          return {
-            isSuccess: true,
-            view: DynamicViewComputeCtx.compute(viewsource, index)
-          }
-        case isElementView(viewsource):
-          return {
-            isSuccess: true,
-            view: ComputeCtx.elementView(viewsource, index)
-          }
+export function unsafeComputeView(
+  viewsource: LikeC4View,
+  likec4model: LikeC4Model
+): ComputedView {
+  switch (true) {
+    case isDeploymentView(viewsource): {
+      return computeDeploymentView(likec4model, viewsource)
+    }
+    case isDynamicView(viewsource):
+      return computeDynamicView(likec4model, viewsource)
+    case isElementView(viewsource):
+      return computeElementView(likec4model, viewsource)
+    default:
+      nonexhaustive(viewsource)
+  }
+}
 
-        default:
-          nonexhaustive(viewsource)
-      }
-    } catch (e) {
-      return {
-        isSuccess: false,
-        error: e instanceof Error ? e : new Error(`Unknown error: ${e}`),
-        view: undefined
-      }
+export function computeView<V extends LikeC4View>(
+  viewsource: V,
+  likec4model: LikeC4Model
+): ComputeViewResult {
+  try {
+    return {
+      isSuccess: true,
+      view: unsafeComputeView(viewsource, likec4model)
+    }
+  } catch (e) {
+    return {
+      isSuccess: false,
+      error: e instanceof Error ? e : new Error(`Unknown error: ${e}`),
+      view: undefined
     }
   }
 }
 
-export function computeViews<const P extends ParsedLikeC4Model<any, any, any, any, any, any>>(
-  parsed: P
-): ComputedLikeC4ModelFromParsed<P> {
-  const _computeView = mkComputeView(parsed)
-  const computeView = (source: LikeC4View): ComputedView => {
-    const result = _computeView(source)
+export function computeViews<P extends ParsedLikeC4Model>(parsed: P): ComputedLikeC4Model {
+  const { views, ...rest } = parsed as Omit<P, '__'>
+  const likec4model = LikeC4Model.create({
+    ...rest,
+    views: {}
+  })
+  const compute = (source: LikeC4View): ComputedView => {
+    const result = computeView(source, likec4model)
     if (result.isSuccess) {
       return result.view
     } else {
@@ -85,8 +76,8 @@ export function computeViews<const P extends ParsedLikeC4Model<any, any, any, an
     }
   }
   return {
+    ...rest,
     __: 'computed',
-    ...parsed,
-    views: mapValues(parsed.views, computeView)
-  } as any // TODO: fix this
+    views: mapValues(parsed.views, compute)
+  }
 }