@likec4/core 1.18.0 → 1.19.0

package/src/types/index.ts

@@ -1,13 +1,220 @@
-export * from './_common'
-export * from './deployments'
-export * from './element'
-export * from './expression'
-export * from './global'
-export * from './model'
-export * from './operators'
-export * from './overview-graph'
-export * from './relation'
-export * from './theme'
-export * from './view'
-export * from './view-changes'
-export * from './view-notation'
+export type {
+  CustomColor,
+  ExclusiveUnion,
+  IconUrl,
+  IteratorLike,
+  KeysOf,
+  NonEmptyArray,
+  NonEmptyReadonlyArray,
+  NTuple,
+  Point,
+  Predicate,
+  XYPoint,
+} from './_common'
+
+export { DeploymentElement } from './deployments'
+export type {
+  DeployedInstance,
+  DeploymentElementStyle,
+  DeploymentNode,
+  DeploymentNodeKind,
+  DeploymentNodeKindSpecification,
+  DeploymentRef,
+  DeploymentRelation,
+  PredicateSelector,
+} from './deployments'
+
+export {
+  AsFqn,
+  BorderStyles,
+  DefaultElementShape,
+  DefaultThemeColor,
+  ElementKind,
+  ElementShapes,
+} from './element'
+export type {
+  BorderStyle,
+  Element,
+  ElementKindSpecification,
+  ElementKindSpecificationStyle,
+  ElementShape,
+  ElementStyle,
+  Fqn,
+  Link,
+  Tag,
+  TagSpec,
+  TypedElement,
+} from './element'
+
+export {
+  isCustomElement,
+  isCustomRelationExpr,
+  isElement,
+  isElementKindExpr,
+  isElementPredicateExpr,
+  isElementRef,
+  isElementTagExpr,
+  isElementWhere,
+  isExpandedElementExpr,
+  isIncoming,
+  isInOut,
+  isOutgoing,
+  isRelation,
+  isRelationExpression,
+  isRelationPredicateExpr,
+  isRelationWhere,
+  isWildcard,
+} from './expression'
+export type {
+  CustomElementExpr,
+  CustomRelationExpr,
+  DirectRelationExpr,
+  ElementExpression,
+  ElementKindExpr,
+  ElementPredicateExpression,
+  ElementRefExpr,
+  ElementTagExpr,
+  ElementWhereExpr,
+  ExpandedElementExpr,
+  Expression,
+  IncomingExpr,
+  InOutExpr,
+  NonWilcard,
+  OutgoingExpr,
+  RelationExpression,
+  RelationPredicateExpression,
+  RelationWhereExpr,
+  WildcardExpr,
+} from './expression'
+
+export { ExpressionV2, FqnExpr, FqnRef, RelationExpr } from './expression-v2'
+
+export type {
+  GlobalDynamicPredicates,
+  GlobalPredicateId,
+  GlobalPredicates,
+  GlobalStyleID,
+  GlobalStyles,
+  ModelGlobals,
+} from './global'
+
+export type {
+  AnyParsedLikeC4Model,
+  ComputedLikeC4Model,
+  GenericLikeC4Model,
+  LayoutedLikeC4Model,
+  LikeC4ModelDump,
+  ParsedLikeC4Model,
+} from './model'
+
+export {
+  isAndOperator,
+  isKindEqual,
+  isNotOperator,
+  isOrOperator,
+  isTagEqual,
+  whereOperatorAsPredicate,
+} from './operators'
+export type {
+  AndOperator,
+  EqualOperator,
+  Filterable,
+  KindEqual,
+  NotOperator,
+  OrOperator,
+  TagEqual,
+  WhereOperator,
+} from './operators'
+export type { OverviewGraph } from './overview-graph'
+export { DefaultArrowType, DefaultLineStyle, DefaultRelationshipColor } from './relation'
+export type {
+  AbstractRelation,
+  ModelRelation,
+  RelationId,
+  RelationshipArrowType,
+  RelationshipKind,
+  RelationshipKindSpecification,
+  RelationshipLineType,
+} from './relation'
+export { isThemeColor } from './theme'
+export type {
+  Color,
+  ColorLiteral,
+  ElementThemeColors,
+  ElementThemeColorValues,
+  HexColorLiteral,
+  LikeC4Theme,
+  RelationshipThemeColors,
+  RelationshipThemeColorValues,
+  ThemeColor,
+  ThemeColorValues,
+} from './theme'
+export {
+  ComputedNode, // namespace
+  ComputedView, // namespace
+  DiagramNode, // namespace
+  extractStep,
+  getBBoxCenter,
+  getParallelStepsPrefix,
+  isAutoLayoutDirection,
+  isDeploymentView,
+  isDynamicView,
+  isDynamicViewParallelSteps,
+  isElementView,
+  isExtendsElementView,
+  isScopedElementView,
+  isStepEdgeId,
+  isViewRuleAutoLayout,
+  isViewRuleGlobalPredicateRef,
+  isViewRuleGlobalStyle,
+  isViewRuleGroup,
+  isViewRulePredicate,
+  isViewRuleStyle,
+  stepEdgeId,
+} from './view'
+export type {
+  AutoLayoutDirection,
+  BasicElementView,
+  BasicView,
+  BBox,
+  ComputedDeploymentView,
+  ComputedDynamicView,
+  ComputedEdge,
+  ComputedElementView,
+  CustomColorDefinitions,
+  DeploymentView,
+  DeploymentViewRule,
+  DeploymentViewRulePredicate,
+  DeploymentViewRuleStyle,
+  DiagramEdge,
+  DiagramView,
+  DynamicView,
+  DynamicViewIncludeRule,
+  DynamicViewParallelSteps,
+  DynamicViewRule,
+  DynamicViewStep,
+  DynamicViewStepOrParallel,
+  EdgeId,
+  ElementView,
+  ExtendsElementView,
+  LikeC4View,
+  NodeId,
+  ScopedElementView,
+  StepEdgeId,
+  StepEdgeIdLiteral,
+  ViewAutoLayout,
+  ViewId,
+  ViewManualLayout,
+  ViewRule,
+  ViewRuleAutoLayout,
+  ViewRuleGlobalPredicateRef,
+  ViewRuleGlobalStyle,
+  ViewRuleGroup,
+  ViewRulePredicate,
+  ViewRuleStyle,
+  ViewRuleStyleOrGlobalRef,
+  ViewWithHash,
+  ViewWithNotation,
+} from './view'
+export type { ViewChange } from './view-changes'
+export type { ElementNotation } from './view-notation'

package/src/types/model.ts

@@ -1,4 +1,3 @@
-import type { KeysOf } from './_common'
 import type {
   DeploymentElement,
   DeploymentNodeKind,
@@ -7,11 +6,22 @@ import type {
 } from './deployments'
 import type { ElementKindSpecification, Tag, TypedElement } from './element'
 import type { ModelGlobals } from './global'
-import type { Relation, RelationId, RelationshipKindSpecification } from './relation'
+import type { ModelRelation, RelationId, RelationshipKindSpecification } from './relation'
 import type { ComputedView, DiagramView, LikeC4View } from './view'
 
 /**
- * Parsed elements, relations, and views.
+ * Represents a LikeC4 model with customizable type parameters,
+ * parsed from DSL or result from Builder
+ *
+ * !IMPORTANT: This is a low-level type, use `LikeC4Model` instead.
+ * !NOTE: Views are not computed yet.
+ *
+ * @typeParam ElementKinds - Types of elements in the model (defaults to string)
+ * @typeParam RelationKinds - Types of relationships (defaults to string)
+ * @typeParam Tags - Types of tags that can be applied (defaults to string)
+ * @typeParam Fqns - Fully Qualified Names for elements (defaults to string)
+ * @typeParam Views - Types of views in the model (defaults to string)
+ * @typeParam DeploymentFqns - Fully Qualified Names for deployment nodes (defaults to string)
  */
 export interface ParsedLikeC4Model<
   ElementKinds extends string = string,
@@ -21,6 +31,8 @@ export interface ParsedLikeC4Model<
   Views extends string = string,
   DeploymentFqns extends string = string
 > {
+  // To prevent accidental use of this type
+  __?: never
   specification: {
     tags: Tag<Tags>[]
     elements: Record<ElementKinds, ElementKindSpecification>
@@ -28,7 +40,7 @@ export interface ParsedLikeC4Model<
     relationships: Record<RelationKinds, RelationshipKindSpecification>
   }
   elements: Record<Fqns, TypedElement<Fqns, ElementKinds, Tags>>
-  relations: Record<RelationId, Relation>
+  relations: Record<RelationId, ModelRelation>
   globals: ModelGlobals
   views: Record<Views, LikeC4View<Views, Tags>>
   /**
@@ -39,10 +51,12 @@ export interface ParsedLikeC4Model<
     relations: Record<RelationId, DeploymentRelation>
   }
 }
+
+export type AnyParsedLikeC4Model = ParsedLikeC4Model<any, any, any, any, any, any>
 /**
  * Hook to get types from dump
  */
-export type ParsedLikeC4ModelDump = {
+export type LikeC4ModelDump = {
   elements: {
     [kind: string]: object
   }
@@ -56,45 +70,35 @@ export type ParsedLikeC4ModelDump = {
   }
 }
 
-export interface AnyLikeC4Model<
+/**
+ * Same as {@link ParsedLikeC4Model}, but with computed views or layouted views.
+ */
+export interface GenericLikeC4Model<
   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'> {
+> extends Omit<ParsedLikeC4Model<string, string, Tags, Fqns, Views, DeploymentFqns>, 'views' | '__'> {
   __?: T
-  views: Record<Views, ComputedView | DiagramView>
+  views: Record<Views, ComputedView<Views> | DiagramView<Views>>
 }
 
-/**
- * Same as `ParsedLikeC4Model` but with computed views.
- */
 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>
+> extends Omit<GenericLikeC4Model<Fqns, DeploymentFqns, Views, Tags, 'computed'>, 'views'> {
+  views: Record<Views, ComputedView<Views>>
 }
 
-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<
   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'> {
+> extends Omit<GenericLikeC4Model<Fqns, DeploymentFqns, Views, Tags, 'layouted'>, 'views'> {
   __: 'layouted'
   views: Record<Views, DiagramView<Views, Tags>>
 }

package/src/types/operators.ts

@@ -64,7 +64,7 @@ export type Filterable<
   FTag extends string = string,
   FKind extends string = string
 > = {
-  tags?: FTag[] | null
+  tags?: readonly FTag[] | null
   kind?: FKind
 }
 

package/src/types/relation.ts

@@ -22,30 +22,34 @@ export type RelationshipArrowType =
   | 'open'
   | 'vee'
 
-export const DefaultLineStyle = 'dashed' satisfies RelationshipLineType
-export const DefaultArrowType = 'normal' satisfies RelationshipArrowType
-export const DefaultRelationshipColor = 'gray' satisfies ThemeColor
+export const DefaultLineStyle: RelationshipLineType = 'dashed'
+export const DefaultArrowType: RelationshipArrowType = 'normal'
+export const DefaultRelationshipColor: ThemeColor = 'gray'
 
-// TODO: rename to Relationship
-export interface Relation {
+export interface AbstractRelation {
   readonly id: RelationId
-  readonly source: Fqn
-  readonly target: Fqn
-  readonly title: string
+  readonly title?: string
   readonly description?: string
   readonly technology?: string
-  readonly tags?: NonEmptyArray<Tag>
+  readonly tags?: NonEmptyArray<Tag> | null
   readonly kind?: RelationshipKind
   readonly color?: Color
   readonly line?: RelationshipLineType
   readonly head?: RelationshipArrowType
   readonly tail?: RelationshipArrowType
-  readonly links?: NonEmptyArray<Link>
+  readonly links?: NonEmptyArray<Link> | null
   // Link to dynamic view
   readonly navigateTo?: ViewId
   readonly metadata?: { [key: string]: string }
 }
 
+// TODO: rename to Relationship
+export interface ModelRelation extends AbstractRelation {
+  readonly source: Fqn
+  readonly target: Fqn
+  readonly title: string
+}
+
 export interface RelationshipKindSpecification {
   readonly technology?: string
   readonly notation?: string

package/src/types/theme.ts

@@ -1,5 +1,4 @@
 import type { LiteralUnion } from 'type-fest'
-import type { CustomColor } from './_common'
 
 const ThemeColors = [
   'amber',

package/src/types/view.ts

@@ -1,7 +1,6 @@
 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,
@@ -9,9 +8,10 @@ import {
   type ElementStyle,
   type Fqn,
   type Link,
-  type Tag
+  type Tag,
 } from './element'
 import type { ElementExpression, ElementPredicateExpression, Expression } from './expression'
+import type { ExpressionV2, FqnExpr } from './expression-v2'
 import type { GlobalPredicateId, GlobalStyleID } from './global'
 import type { RelationId, RelationshipArrowType, RelationshipKind, RelationshipLineType } from './relation'
 import type { Color, ThemeColorValues } from './theme'
@@ -82,7 +82,7 @@ export interface ViewRuleAutoLayout {
 }
 
 export function isViewRuleAutoLayout(
-  rule: DeploymentViewRule | DynamicViewRule | ViewRule
+  rule: DeploymentViewRule | DynamicViewRule | ViewRule,
 ): rule is ViewRuleAutoLayout {
   return 'direction' in rule
 }
@@ -111,7 +111,7 @@ export type ViewRule =
 export interface BasicView<
   ViewType extends 'element' | 'dynamic' | 'deployment',
   ViewIDs extends string,
-  Tags extends string
+  Tags extends string,
 > {
   readonly __?: ViewType
   readonly id: ViewId<ViewIDs>
@@ -162,7 +162,7 @@ export interface ExtendsElementView<ViewIDs extends string, Tags extends string>
 }
 export type ElementView<
   ViewIDs extends string = string,
-  Tags extends string = string
+  Tags extends string = string,
 > =
   | ScopedElementView<ViewIDs, Tags>
   | ExtendsElementView<ViewIDs, Tags>
@@ -205,7 +205,7 @@ export type DynamicViewRule =
   | ViewRuleAutoLayout
 export interface DynamicView<
   ViewIDs extends string = string,
-  Tags extends string = string
+  Tags extends string = string,
 > extends BasicView<'dynamic', ViewIDs, Tags> {
   readonly __: 'dynamic'
 
@@ -222,15 +222,15 @@ export type CustomColorDefinitions = { [key: string]: ThemeColorValues }
 
 export type DeploymentViewRulePredicate =
   | {
-    include: DeploymentExpression[]
+    include: ExpressionV2[]
     exclude?: never
   }
   | {
     include?: never
-    exclude: DeploymentExpression[]
+    exclude: ExpressionV2[]
   }
 export type DeploymentViewRuleStyle = {
-  targets: DeploymentExpression[]
+  targets: FqnExpr[]
   notation?: string
   style: ElementStyle & {
     color?: Color
@@ -242,7 +242,7 @@ export type DeploymentViewRule = DeploymentViewRulePredicate | ViewRuleAutoLayou
 
 export interface DeploymentView<
   ViewIDs extends string = string,
-  Tags extends string = string
+  Tags extends string = string,
 > extends BasicView<'deployment', ViewIDs, Tags> {
   readonly __: 'deployment'
   readonly rules: DeploymentViewRule[]
@@ -250,7 +250,7 @@ export interface DeploymentView<
 
 export type LikeC4View<
   ViewIDs extends string = string,
-  Tags extends string = string
+  Tags extends string = string,
 > = ElementView<ViewIDs, Tags> | DynamicView<ViewIDs, Tags> | DeploymentView<ViewIDs, Tags>
 
 export function isDeploymentView(view: LikeC4View): view is DeploymentView
@@ -258,9 +258,11 @@ 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'
 }
+
 export function isElementView(view: LikeC4View): view is ElementView {
   return isNullish(view.__) || view.__ === 'element'
 }
@@ -408,7 +410,7 @@ export interface ViewAutoLayout {
 }
 export interface ComputedElementView<
   ViewIDs extends string = string,
-  Tags extends string = string
+  Tags extends string = string,
 > extends Omit<ElementView<ViewIDs, Tags>, 'rules' | 'docUri'>, ViewWithHash, ViewWithNotation {
   readonly extends?: ViewId<ViewIDs>
   readonly autoLayout: ViewAutoLayout
@@ -419,7 +421,7 @@ export interface ComputedElementView<
 }
 export interface ComputedDynamicView<
   ViewIDs extends string = string,
-  Tags extends string = string
+  Tags extends string = string,
 > extends Omit<DynamicView<ViewIDs, Tags>, 'rules' | 'steps' | 'docUri'>, ViewWithHash, ViewWithNotation {
   readonly autoLayout: ViewAutoLayout
   readonly nodes: ComputedNode[]
@@ -431,7 +433,7 @@ export interface ComputedDynamicView<
 
 export interface ComputedDeploymentView<
   ViewIDs extends string = string,
-  Tags extends string = string
+  Tags extends string = string,
 > extends Omit<DeploymentView<ViewIDs, Tags>, 'rules' | 'docUri'>, ViewWithHash, ViewWithNotation {
   readonly autoLayout: ViewAutoLayout
   readonly nodes: ComputedNode[]
@@ -442,7 +444,7 @@ export interface ComputedDeploymentView<
 
 export type ComputedView<
   ViewIDs extends string = string,
-  Tags extends string = string
+  Tags extends string = string,
 > = ComputedElementView<ViewIDs, Tags> | ComputedDynamicView<ViewIDs, Tags> | ComputedDeploymentView<ViewIDs, Tags>
 
 export namespace ComputedView {
@@ -469,11 +471,11 @@ export function getBBoxCenter({
   x,
   y,
   width,
-  height
+  height,
 }: BBox): XYPoint {
   return {
     x: x + width / 2,
-    y: y + height / 2
+    y: y + height / 2,
   }
 }
 
@@ -513,7 +515,7 @@ export interface DiagramEdge extends ComputedEdge {
 
 export interface DiagramView<
   ViewIDs extends string = string,
-  Tags extends string = string
+  Tags extends string = string,
 > extends Omit<ComputedView<ViewIDs, Tags>, 'nodes' | 'edges' | 'manualLayout'> {
   readonly nodes: DiagramNode[]
   readonly edges: DiagramEdge[]

package/src/utils/const.ts

@@ -0,0 +1 @@
+export const customInspectSymbol = Symbol.for('nodejs.util.inspect.custom')