@likec4/core 1.17.1 → 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,27 +1,37 @@
-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,
+  DeploymentNodeKindSpecification,
   ElementKindSpecification,
   ElementShape,
+  KeysOf,
+  NonEmptyArray,
   ParsedLikeC4Model,
   RelationshipArrowType,
   RelationshipKindSpecification,
-  RelationshipLineType
+  RelationshipLineType,
 } from '../types'
-
-type KeysOf<T> = keyof T extends infer K extends string ? K : never
+import type { ExpressionV2 } from '../types/expression-v2'
+import type { Builder } from './Builder'
+import type { DeploymentRulesBuilderOp } from './Builder.view-deployment'
 
 export type BuilderSpecification = {
   elements: {
     [kind: string]: Partial<ElementKindSpecification>
   }
-  relationships?: Record<string, Partial<RelationshipKindSpecification>>
+  relationships?: {
+    [kind: string]: Partial<RelationshipKindSpecification>
+  }
+  deployments?: {
+    [kind: string]: Partial<DeploymentNodeKindSpecification>
+  }
   tags?: [string, ...string[]]
   metadataKeys?: [string, ...string[]]
 }
 
-type Metadata<MetadataKey extends string> = IfNever<MetadataKey, never, Record<MetadataKey, string>>
+export type Metadata<MetadataKey extends string> = IfNever<MetadataKey, never, Record<MetadataKey, string>>
 
 export type NewElementProps<Tag, Metadata> = {
   title?: string
@@ -40,6 +50,23 @@ export type NewElementProps<Tag, Metadata> = {
   }
 }
 
+export type NewDeploymentNodeProps<Tag, Metadata> = {
+  title?: string
+  description?: string
+  technology?: string
+  tags?: IfNever<Tag, never, [Tag, ...Tag[]]>
+  metadata?: Metadata
+  icon?: string
+  shape?: ElementShape
+  color?: Color
+  links?: NonEmptyArray<string | { title?: string; url: string }>
+  style?: {
+    border?: BorderStyle
+    // 0-100
+    opacity?: number
+  }
+}
+
 export type NewViewProps<Tag> = {
   title?: string
   description?: string
@@ -58,13 +85,19 @@ export type NewRelationProps<Kind, Tag, Metadata> = {
   tail?: RelationshipArrowType
   line?: RelationshipLineType
   color?: Color
-  links?: Array<string | { title?: string; url: string }>
+  links?: NonEmptyArray<string | { title?: string; url: string }>
 }
 
 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
  */
@@ -74,7 +107,9 @@ export interface Types<
   ViewId extends string,
   RelationshipKind extends string,
   Tag extends string,
-  MetadataKey extends string
+  MetadataKey extends string,
+  DeploymentKind extends string,
+  DeploymentFqn extends string,
 > {
   ElementKind: ElementKind
   Fqn: Fqn
@@ -82,6 +117,8 @@ export interface Types<
   RelationshipKind: RelationshipKind
   Tag: Tag
   MetadataKey: MetadataKey
+  DeploymentKind: DeploymentKind
+  DeploymentFqn: DeploymentFqn
 
   Tags: IfNever<Tag, never, [Tag, ...Tag[]]>
   // Metadata: Metadata<MetadataKey>
@@ -89,6 +126,8 @@ export interface Types<
   NewElementProps: NewElementProps<Tag, Metadata<MetadataKey>>
   NewRelationshipProps: NewRelationProps<RelationshipKind, Tag, Metadata<MetadataKey>>
   NewViewProps: NewViewProps<Tag>
+
+  NewDeploymentNodeProps: NewDeploymentNodeProps<Tag, Metadata<MetadataKey>>
 }
 
 /**
@@ -101,7 +140,9 @@ export interface TypesNested<
   ViewId extends string,
   RelationshipKind extends string,
   Tag extends string,
-  MetadataKey extends string
+  MetadataKey extends string,
+  DeploymentKind extends string,
+  DeploymentFqn extends string,
 > extends
   Types<
     ElementKind,
@@ -109,7 +150,9 @@ export interface TypesNested<
     ViewId,
     RelationshipKind,
     Tag,
-    MetadataKey
+    MetadataKey,
+    DeploymentKind,
+    DeploymentFqn
   >
 {
   Parent: Parent
@@ -121,6 +164,8 @@ export type AnyTypes = Types<
   any,
   any,
   any,
+  any,
+  any,
   any
 >
 
@@ -131,6 +176,8 @@ export type AnyTypesNested = TypesNested<
   any,
   any,
   any,
+  any,
+  any,
   any
 >
 
@@ -141,18 +188,23 @@ export namespace Types {
       never,
       KeysOf<Spec['relationships']>,
       TupleToUnion<Spec['tags']>,
-      TupleToUnion<Spec['metadataKeys']>
+      TupleToUnion<Spec['metadataKeys']>,
+      KeysOf<Spec['deployments']>,
+      never
     >
     : never
 
-  export type AddFqn<T, Id extends string> = T extends TypesNested<infer P, any, any, any, any, any, any> ? TypesNested<
+  export type AddFqn<T, Id extends string> = T extends TypesNested<infer P, any, any, any, any, any, any, any, any>
+    ? TypesNested<
       P,
       T['ElementKind'],
       `${P}.${Id}` | T['Fqn'],
       T['ViewId'],
       T['RelationshipKind'],
       T['Tag'],
-      T['MetadataKey']
+      T['MetadataKey'],
+      T['DeploymentKind'],
+      T['DeploymentFqn']
     >
     : T extends AnyTypes ? Types<
         T['ElementKind'],
@@ -160,11 +212,37 @@ export namespace Types {
         T['ViewId'],
         T['RelationshipKind'],
         T['Tag'],
-        T['MetadataKey']
+        T['MetadataKey'],
+        T['DeploymentKind'],
+        T['DeploymentFqn']
+      >
+    : never
+
+  export type AddDeploymentFqn<T, Id extends string> = T extends
+    TypesNested<infer P, any, any, any, any, any, any, any, any> ? TypesNested<
+      P,
+      T['ElementKind'],
+      T['Fqn'],
+      T['ViewId'],
+      T['RelationshipKind'],
+      T['Tag'],
+      T['MetadataKey'],
+      T['DeploymentKind'],
+      `${P}.${Id}` | T['DeploymentFqn']
+    >
+    : T extends AnyTypes ? Types<
+        T['ElementKind'],
+        T['Fqn'],
+        T['ViewId'],
+        T['RelationshipKind'],
+        T['Tag'],
+        T['MetadataKey'],
+        T['DeploymentKind'],
+        Id | T['DeploymentFqn']
       >
     : never
 
-  export type AddView<T, Id extends string> = T extends TypesNested<infer P, any, any, any, any, any, any>
+  export type AddView<T, Id extends string> = T extends TypesNested<infer P, any, any, any, any, any, any, any, any>
     ? TypesNested<
       P,
       T['ElementKind'],
@@ -172,7 +250,9 @@ export namespace Types {
       Id | T['ViewId'],
       T['RelationshipKind'],
       T['Tag'],
-      T['MetadataKey']
+      T['MetadataKey'],
+      T['DeploymentKind'],
+      T['DeploymentFqn']
     >
     : T extends AnyTypes ? Types<
         T['ElementKind'],
@@ -180,7 +260,9 @@ export namespace Types {
         Id | T['ViewId'],
         T['RelationshipKind'],
         T['Tag'],
-        T['MetadataKey']
+        T['MetadataKey'],
+        T['DeploymentKind'],
+        T['DeploymentFqn']
       >
     : never
 
@@ -189,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)) {