@likec4/core 1.7.4 → 1.8.1

package/dist/types/_common.d.ts

@@ -1,5 +1,5 @@
 import type { Opaque } from './opaque';
-export type NonEmptyArray<T> = [T, ...T[]] | [...T[], T];
+export type NonEmptyArray<T> = [T, ...T[]];
 export type IconUrl = Opaque<string, 'IconUrl'>;
 export type Point = readonly [x: number, y: number];
 export interface XYPoint {

package/dist/types/element.d.ts

@@ -19,6 +19,10 @@ export interface TagSpec {
     readonly id: Tag;
     readonly style: ElementStyle;
 }
+export interface Link {
+    readonly title?: string;
+    readonly url: string;
+}
 export interface Element {
     readonly id: Fqn;
     readonly kind: ElementKind;
@@ -26,10 +30,26 @@ export interface Element {
     readonly description: string | null;
     readonly technology: string | null;
     readonly tags: NonEmptyArray<Tag> | null;
-    readonly links: NonEmptyArray<string> | null;
+    readonly links: NonEmptyArray<Link> | null;
     readonly icon?: IconUrl;
     readonly shape?: ElementShape;
     readonly color?: ThemeColor;
     readonly style?: ElementStyle;
+    readonly notation?: string;
+    readonly metadata?: {
+        [key: string]: string;
+    };
+}
+export interface ElementKindSpecificationStyle {
+    shape?: ElementShape;
+    icon?: IconUrl;
+    color?: ThemeColor;
+    border?: BorderStyle;
+    opacity?: number;
+}
+export interface ElementKindSpecification {
+    readonly technology?: string;
+    readonly notation?: string;
+    readonly style: ElementKindSpecificationStyle;
 }
 //# sourceMappingURL=element.d.ts.map

package/dist/types/expression.d.ts

@@ -36,6 +36,7 @@ export interface CustomElementExpr extends Omit<BaseExpr, 'custom'> {
         title?: string;
         description?: string;
         technology?: string;
+        notation?: string;
         shape?: ElementShape;
         color?: ThemeColor;
         icon?: IconUrl;
@@ -103,6 +104,7 @@ export interface CustomRelationExpr extends Omit<BaseExpr, 'customRelation'> {
         title?: string;
         description?: string;
         technology?: string;
+        notation?: string;
         color?: ThemeColor;
         line?: RelationshipLineType;
         head?: RelationshipArrowType;

package/dist/types/index.d.ts

@@ -4,9 +4,11 @@ export * from './expression';
 export * from './model';
 export * from './opaque';
 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 * as Expr from './expression';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.js

@@ -4,9 +4,11 @@ export * from './expression';
 export * from './model';
 export * from './opaque';
 export * from './operators';
+export * from './overview-graph';
 export * from './relation';
 export * from './theme';
 export * from './view';
 export * from './view-changes';
+export * from './view-notation';
 import * as Expr_1 from './expression';
 export { Expr_1 as Expr };

package/dist/types/overview-graph.d.ts

@@ -0,0 +1,41 @@
+import type { NonEmptyArray, Point, XYPoint } from './_common';
+import type { BBox, ViewID } from './view';
+/**
+ * OverviewGraph is a graph representation of all views in a model
+ */
+export declare namespace OverviewGraph {
+    type Node = {
+        id: string;
+        type: 'folder' | 'file';
+        path: string;
+        label: string;
+        parentId: string | null;
+        position: XYPoint;
+        width: number;
+        height: number;
+    } | {
+        id: string;
+        type: 'view';
+        viewId: ViewID;
+        label: string;
+        parentId: string | null;
+        position: XYPoint;
+        width: number;
+        height: number;
+    };
+    /**
+     * Edge represents a navigational link from one view to another
+     */
+    type Edge = {
+        id: string;
+        source: string;
+        target: string;
+        points: NonEmptyArray<Point>;
+    };
+}
+export interface OverviewGraph {
+    nodes: OverviewGraph.Node[];
+    edges: OverviewGraph.Edge[];
+    bounds: BBox;
+}
+//# sourceMappingURL=overview-graph.d.ts.map

package/dist/types/overview-graph.js

@@ -0,0 +1 @@
+export {};

package/dist/types/relation.d.ts

@@ -1,5 +1,5 @@
 import type { NonEmptyArray } from './_common';
-import type { Fqn, Tag } from './element';
+import type { Fqn, Link, Tag } from './element';
 import type { Opaque } from './opaque';
 import type { ThemeColor } from './theme';
 export type RelationID = Opaque<string, 'RelationID'>;
@@ -22,6 +22,9 @@ export interface Relation {
     readonly line?: RelationshipLineType;
     readonly head?: RelationshipArrowType;
     readonly tail?: RelationshipArrowType;
-    readonly links?: NonEmptyArray<string>;
+    readonly links?: NonEmptyArray<Link>;
+    readonly metadata?: {
+        [key: string]: string;
+    };
 }
 //# sourceMappingURL=relation.d.ts.map

package/dist/types/view-notation.d.ts

@@ -0,0 +1,9 @@
+import type { ElementKind, ElementShape } from './element';
+import type { ThemeColor } from './theme';
+export type ElementNotation = {
+    kinds: ElementKind[];
+    shape: ElementShape;
+    color: ThemeColor;
+    title: string;
+};
+//# sourceMappingURL=view-notation.d.ts.map

package/dist/types/view-notation.js

@@ -0,0 +1 @@
+export {};

package/dist/types/view.d.ts

@@ -1,9 +1,10 @@
 import type { IconUrl, NonEmptyArray, Point, XYPoint } from './_common';
-import type { ElementKind, ElementShape, ElementStyle, Fqn, Tag } from './element';
+import type { ElementKind, ElementShape, ElementStyle, Fqn, Link, Tag } from './element';
 import type { ElementExpression, ElementPredicateExpression, Expression } from './expression';
 import type { Opaque } from './opaque';
 import type { RelationID, RelationshipArrowType, RelationshipKind, RelationshipLineType } from './relation';
 import type { ThemeColor } from './theme';
+import type { ElementNotation } from './view-notation';
 export type ViewID = Opaque<string, 'ViewID'>;
 export type ViewRulePredicate = {
     include: Expression[];
@@ -15,6 +16,7 @@ export type ViewRulePredicate = {
 export declare function isViewRulePredicate(rule: ViewRule): rule is ViewRulePredicate;
 export interface ViewRuleStyle {
     targets: ElementExpression[];
+    notation?: string;
     style: ElementStyle & {
         color?: ThemeColor;
         shape?: ElementShape;
@@ -34,7 +36,7 @@ export interface BasicView<ViewType extends 'element' | 'dynamic'> {
     readonly title: string | null;
     readonly description: string | null;
     readonly tags: NonEmptyArray<Tag> | null;
-    readonly links: NonEmptyArray<string> | null;
+    readonly links: NonEmptyArray<Link> | null;
     /**
      * URI to the source file of this view.
      * Undefined if the view is auto-generated.
@@ -71,6 +73,7 @@ export interface DynamicViewStep {
     readonly title: string | null;
     readonly description?: string;
     readonly technology?: string;
+    readonly notation?: string;
     readonly color?: ThemeColor;
     readonly line?: RelationshipLineType;
     readonly head?: RelationshipArrowType;
@@ -106,8 +109,9 @@ export interface ComputedNode {
     title: string;
     description: string | null;
     technology: string | null;
+    notation?: string;
     tags: NonEmptyArray<Tag> | null;
-    links: NonEmptyArray<string> | null;
+    links: NonEmptyArray<Link> | null;
     children: NodeId[];
     inEdges: EdgeId[];
     outEdges: EdgeId[];
@@ -154,31 +158,33 @@ export interface ComputedEdge {
      */
     dir?: 'forward' | 'back';
 }
-export interface ComputedElementView extends Omit<ElementView, 'rules' | 'docUri'> {
+export interface ViewWithHash {
+    /**
+     * Hash of the view object.
+     * This is used to detect changes in layout
+     */
+    hash: string;
+}
+export interface ViewWithNotation {
+    notation?: {
+        elements: ElementNotation[];
+    };
+}
+export interface ComputedElementView extends Omit<ElementView, 'rules' | 'docUri'>, ViewWithHash, ViewWithNotation {
     readonly extends?: ViewID;
     readonly autoLayout: ViewRuleAutoLayout['autoLayout'];
     readonly nodes: ComputedNode[];
     readonly edges: ComputedEdge[];
     rules?: never;
     docUri?: never;
-    /**
-     * Hash of the view object.
-     * This is used to detect changes in layout
-     */
-    hash: string;
 }
-export interface ComputedDynamicView extends Omit<DynamicView, 'rules' | 'steps' | 'docUri'> {
+export interface ComputedDynamicView extends Omit<DynamicView, 'rules' | 'steps' | 'docUri'>, ViewWithHash, ViewWithNotation {
     readonly autoLayout: ViewRuleAutoLayout['autoLayout'];
     readonly nodes: ComputedNode[];
     readonly edges: ComputedEdge[];
     steps?: never;
     rules?: never;
     docUri?: never;
-    /**
-     * Hash of the view object.
-     * This is used to detect changes in layout
-     */
-    hash: string;
 }
 export declare function isComputedDynamicView(view: ComputedView): view is ComputedDynamicView;
 export type ComputedView = ComputedElementView | ComputedDynamicView;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@likec4/core",
-  "version": "1.7.4",
+  "version": "1.8.1",
   "license": "MIT",
   "homepage": "https://likec4.dev",
   "author": "Denis Davydkov <denis@davydkov.com>",
@@ -66,14 +66,14 @@
     }
   },
   "dependencies": {
-    "remeda": "^2.3.0",
+    "remeda": "^2.11.0",
     "ts-custom-error": "^3.3.1",
     "type-fest": "^4.21.0"
   },
   "devDependencies": {
-    "@likec4/tsconfig": "1.7.4",
+    "@likec4/tsconfig": "1.8.1",
     "@total-typescript/ts-reset": "^0.5.1",
-    "execa": "^9.3.0",
+    "execa": "^9.3.1",
     "typescript": "^5.5.4",
     "vitest": "~2.0.5"
   },

package/src/types/_common.ts

@@ -1,6 +1,6 @@
 import type { Opaque } from './opaque'
 
-export type NonEmptyArray<T> = [T, ...T[]] | [...T[], T]
+export type NonEmptyArray<T> = [T, ...T[]]
 
 export type IconUrl = Opaque<string, 'IconUrl'>
 

package/src/types/element.ts

@@ -41,6 +41,11 @@ export interface TagSpec {
   readonly style: ElementStyle
 }
 
+export interface Link {
+  readonly title?: string,
+  readonly url: string
+}
+
 export interface Element {
   readonly id: Fqn
   readonly kind: ElementKind
@@ -48,9 +53,24 @@ export interface Element {
   readonly description: string | null
   readonly technology: string | null
   readonly tags: NonEmptyArray<Tag> | null
-  readonly links: NonEmptyArray<string> | null
+  readonly links: NonEmptyArray<Link> | null
   readonly icon?: IconUrl
   readonly shape?: ElementShape
   readonly color?: ThemeColor
   readonly style?: ElementStyle
+  readonly notation?: string
+  readonly metadata?: { [key: string]: string }
+}
+
+export interface ElementKindSpecificationStyle {
+  shape?: ElementShape
+  icon?: IconUrl
+  color?: ThemeColor
+  border?: BorderStyle
+  opacity?: number
+}
+export interface ElementKindSpecification {
+  readonly technology?: string
+  readonly notation?: string
+  readonly style: ElementKindSpecificationStyle
 }

package/src/types/expression.ts

@@ -44,6 +44,7 @@ export interface CustomElementExpr extends Omit<BaseExpr, 'custom'> {
     title?: string
     description?: string
     technology?: string
+    notation?: string
     shape?: ElementShape
     color?: ThemeColor
     icon?: IconUrl
@@ -159,6 +160,7 @@ export interface CustomRelationExpr extends Omit<BaseExpr, 'customRelation'> {
     title?: string
     description?: string
     technology?: string
+    notation?: string
     color?: ThemeColor
     line?: RelationshipLineType
     head?: RelationshipArrowType

package/src/types/index.ts

@@ -4,9 +4,11 @@ export * from './expression'
 export * from './model'
 export * from './opaque'
 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 * as Expr from './expression'

package/src/types/overview-graph.ts

@@ -0,0 +1,43 @@
+import type { NonEmptyArray, Point, XYPoint } from './_common'
+import type { BBox, ViewID } from './view'
+
+/**
+ * OverviewGraph is a graph representation of all views in a model
+ */
+export namespace OverviewGraph {
+  export type Node = {
+    id: string
+    type: 'folder' | 'file'
+    path: string
+    label: string
+    parentId: string | null
+    position: XYPoint
+    width: number
+    height: number
+  } | {
+    id: string
+    type: 'view'
+    viewId: ViewID
+    label: string
+    parentId: string | null
+    position: XYPoint
+    width: number
+    height: number
+  }
+
+  /**
+   * Edge represents a navigational link from one view to another
+   */
+  export type Edge = {
+    id: string
+    source: string
+    target: string
+    points: NonEmptyArray<Point>
+  }
+}
+
+export interface OverviewGraph {
+  nodes: OverviewGraph.Node[]
+  edges: OverviewGraph.Edge[]
+  bounds: BBox
+}

package/src/types/relation.ts

@@ -1,5 +1,5 @@
 import type { NonEmptyArray } from './_common'
-import type { Fqn, Tag } from './element'
+import type { Fqn, Link, Tag } from './element'
 import type { Opaque } from './opaque'
 import type { ThemeColor } from './theme'
 
@@ -38,5 +38,6 @@ export interface Relation {
   readonly line?: RelationshipLineType
   readonly head?: RelationshipArrowType
   readonly tail?: RelationshipArrowType
-  readonly links?: NonEmptyArray<string>
+  readonly links?: NonEmptyArray<Link>
+  readonly metadata?: { [key: string]: string }
 }

package/src/types/view-notation.ts

@@ -0,0 +1,10 @@
+import type { RequireAtLeastOne } from 'type-fest'
+import type { BorderStyle, ElementKind, ElementShape } from './element'
+import type { ThemeColor } from './theme'
+
+export type ElementNotation = {
+  kinds: ElementKind[]
+  shape: ElementShape
+  color: ThemeColor
+  title: string
+}

package/src/types/view.ts

@@ -1,10 +1,11 @@
 import { isNullish } from 'remeda'
 import type { IconUrl, NonEmptyArray, Point, XYPoint } from './_common'
-import type { ElementKind, ElementShape, ElementStyle, Fqn, Tag } from './element'
+import type { ElementKind, ElementShape, ElementStyle, Fqn, Link, Tag } from './element'
 import type { ElementExpression, ElementPredicateExpression, Expression } from './expression'
 import type { Opaque } from './opaque'
 import type { RelationID, RelationshipArrowType, RelationshipKind, RelationshipLineType } from './relation'
 import type { ThemeColor } from './theme'
+import type { ElementNotation } from './view-notation'
 
 // Full-qualified-name
 export type ViewID = Opaque<string, 'ViewID'>
@@ -27,6 +28,7 @@ export function isViewRulePredicate(rule: ViewRule): rule is ViewRulePredicate {
 
 export interface ViewRuleStyle {
   targets: ElementExpression[]
+  notation?: string
   style: ElementStyle & {
     color?: ThemeColor
     shape?: ElementShape
@@ -53,7 +55,7 @@ export interface BasicView<ViewType extends 'element' | 'dynamic'> {
   readonly title: string | null
   readonly description: string | null
   readonly tags: NonEmptyArray<Tag> | null
-  readonly links: NonEmptyArray<string> | null
+  readonly links: NonEmptyArray<Link> | null
 
   /**
    * URI to the source file of this view.
@@ -95,6 +97,7 @@ export interface DynamicViewStep {
   readonly title: string | null
   readonly description?: string
   readonly technology?: string
+  readonly notation?: string
   readonly color?: ThemeColor
   readonly line?: RelationshipLineType
   readonly head?: RelationshipArrowType
@@ -162,8 +165,9 @@ export interface ComputedNode {
   title: string
   description: string | null
   technology: string | null
+  notation?: string
   tags: NonEmptyArray<Tag> | null
-  links: NonEmptyArray<string> | null
+  links: NonEmptyArray<Link> | null
   children: NodeId[]
   inEdges: EdgeId[]
   outEdges: EdgeId[]
@@ -213,33 +217,37 @@ export interface ComputedEdge {
   dir?: 'forward' | 'back'
 }
 
-export interface ComputedElementView extends Omit<ElementView, 'rules' | 'docUri'> {
+export interface ViewWithHash {
+  /**
+   * Hash of the view object.
+   * This is used to detect changes in layout
+   */
+  hash: string
+}
+
+export interface ViewWithNotation {
+  notation?: {
+    elements: ElementNotation[]
+  }
+}
+
+export interface ComputedElementView extends Omit<ElementView, 'rules' | 'docUri'>, ViewWithHash, ViewWithNotation {
   readonly extends?: ViewID
   readonly autoLayout: ViewRuleAutoLayout['autoLayout']
   readonly nodes: ComputedNode[]
   readonly edges: ComputedEdge[]
   rules?: never
   docUri?: never
-
-  /**
-   * Hash of the view object.
-   * This is used to detect changes in layout
-   */
-  hash: string
 }
-export interface ComputedDynamicView extends Omit<DynamicView, 'rules' | 'steps' | 'docUri'> {
+export interface ComputedDynamicView
+  extends Omit<DynamicView, 'rules' | 'steps' | 'docUri'>, ViewWithHash, ViewWithNotation
+{
   readonly autoLayout: ViewRuleAutoLayout['autoLayout']
   readonly nodes: ComputedNode[]
   readonly edges: ComputedEdge[]
   steps?: never
   rules?: never
   docUri?: never
-
-  /**
-   * Hash of the view object.
-   * This is used to detect changes in layout
-   */
-  hash: string
 }
 export function isComputedDynamicView(view: ComputedView): view is ComputedDynamicView {
   return view.__ === 'dynamic'