@likec4/core 1.1.1 → 1.2.0

package/dist/types/index.d.ts

@@ -1,6 +1,4 @@
 export * from './_common';
-export * from './computed-view';
-export * from './diagram';
 export * from './element';
 export * from './expression';
 export * from './model';

package/dist/types/index.js

@@ -1,6 +1,4 @@
 export * from './_common';
-export * from './computed-view';
-export * from './diagram';
 export * from './element';
 export * from './expression';
 export * from './model';

package/dist/types/model.d.ts

@@ -1,11 +1,10 @@
-import type { ComputedView } from './computed-view';
 import type { Element, Fqn } from './element';
 import type { Relation, RelationID } from './relation';
-import type { ElementView, ViewID } from './view';
+import type { ComputedView, View, ViewID } from './view';
 export interface LikeC4Model {
     elements: Record<Fqn, Element>;
     relations: Record<RelationID, Relation>;
-    views: Record<ViewID, ElementView>;
+    views: Record<ViewID, View>;
 }
 export interface LikeC4ComputedModel {
     elements: Record<Fqn, Element>;

package/dist/types/view.d.ts

@@ -1,8 +1,9 @@
 import type { IconUrl, NonEmptyArray } from './_common';
-import type { ElementShape, ElementStyle, Fqn, Tag } from './element';
-import type { ElementExpression, Expression } from './expression';
+import type { ElementKind, ElementShape, ElementStyle, Fqn, Tag } from './element';
+import type { CustomElementExpr, ElementExpression, Expression } from './expression';
 import type { Opaque } from './opaque';
-import type { ThemeColor } from './theme';
+import type { RelationID, RelationshipArrowType, RelationshipLineType } from './relation';
+import type { ColorLiteral, ThemeColor } from './theme';
 export type ViewID = Opaque<string, 'ViewID'>;
 export type ViewRuleExpression = {
     include: Expression[];
@@ -27,14 +28,13 @@ export interface ViewRuleAutoLayout {
 }
 export declare function isViewRuleAutoLayout(rule: ViewRule): rule is ViewRuleAutoLayout;
 export type ViewRule = ViewRuleExpression | ViewRuleStyle | ViewRuleAutoLayout;
-export interface BasicElementView {
+export interface BasicView<ViewType extends 'element' | 'dynamic' = 'element' | 'dynamic'> {
+    readonly __?: ViewType;
     readonly id: ViewID;
-    readonly viewOf?: Fqn;
     readonly title: string | null;
     readonly description: string | null;
     readonly tags: NonEmptyArray<Tag> | null;
     readonly links: NonEmptyArray<string> | null;
-    readonly rules: ViewRule[];
     /**
      * URI to the source file of this view.
      * Undefined if the view is auto-generated.
@@ -51,12 +51,136 @@ export interface BasicElementView {
      */
     readonly relativePath?: string;
 }
+export interface BasicElementView extends BasicView<'element'> {
+    readonly viewOf?: Fqn;
+    readonly rules: ViewRule[];
+}
 export interface StrictElementView extends BasicElementView {
     readonly viewOf: Fqn;
 }
-export declare function isStrictElementView(view: ElementView): view is StrictElementView;
 export interface ExtendsElementView extends BasicElementView {
     readonly extends: ViewID;
 }
-export declare function isExtendsElementView(view: ElementView): view is ExtendsElementView;
 export type ElementView = StrictElementView | ExtendsElementView | BasicElementView;
+export interface DynamicViewStep {
+    readonly source: Fqn;
+    readonly target: Fqn;
+    readonly title: string | null;
+    readonly isBackward?: boolean;
+}
+export type DynamicViewIncludeRule = {
+    include: (ElementExpression | CustomElementExpr)[];
+};
+export declare function isDynamicViewIncludeRule(rule: DynamicViewRule): rule is DynamicViewIncludeRule;
+export type DynamicViewRule = DynamicViewIncludeRule | ViewRuleStyle | ViewRuleAutoLayout;
+export interface DynamicView extends BasicView<'dynamic'> {
+    readonly __: 'dynamic';
+    readonly steps: DynamicViewStep[];
+    readonly rules: DynamicViewRule[];
+}
+export type View = ElementView | DynamicView;
+export declare function isDynamicView(view: View): view is DynamicView;
+export declare function isElementView(view: View): view is ElementView;
+export declare function isExtendsElementView(view: View): view is ExtendsElementView;
+export declare function isStrictElementView(view: View): view is StrictElementView;
+export type NodeId = Fqn;
+export type EdgeId = Opaque<string, 'EdgeId'>;
+export type StepEdgeIdLiteral = `step-${number}`;
+export type StepEdgeId = Opaque<StepEdgeIdLiteral, 'EdgeId'>;
+export declare function StepEdgeId(step: number): StepEdgeId;
+export declare function isStepEdgeId(id: string): id is StepEdgeId;
+export declare function extractStep(id: EdgeId): number;
+export interface ComputedNode {
+    id: NodeId;
+    kind: ElementKind;
+    parent: NodeId | null;
+    title: string;
+    description: string | null;
+    technology: string | null;
+    tags: NonEmptyArray<Tag> | null;
+    links: NonEmptyArray<string> | null;
+    children: NodeId[];
+    inEdges: EdgeId[];
+    outEdges: EdgeId[];
+    shape: ElementShape;
+    /**
+     * @deprecated Use `style` instead
+     */
+    color: ThemeColor;
+    /**
+     * @deprecated Use `style` instead
+     */
+    icon?: IconUrl;
+    style: ElementStyle;
+    navigateTo?: ViewID;
+    level: number;
+    depth?: number;
+}
+export interface ComputedEdge {
+    id: EdgeId;
+    parent: NodeId | null;
+    source: NodeId;
+    target: NodeId;
+    label: string | null;
+    relations: RelationID[];
+    color?: ThemeColor;
+    line?: RelationshipLineType;
+    head?: RelationshipArrowType;
+    tail?: RelationshipArrowType;
+    /**
+     * For layouting purposes
+     * @default 'forward'
+     */
+    dir?: 'forward' | 'back';
+}
+export interface ComputedElementView extends Omit<ElementView, 'rules'> {
+    readonly extends?: ViewID;
+    readonly autoLayout: ViewRuleAutoLayout['autoLayout'];
+    readonly nodes: ComputedNode[];
+    readonly edges: ComputedEdge[];
+}
+export interface ComputedDynamicView extends Omit<DynamicView, 'rules' | 'steps'> {
+    readonly autoLayout: ViewRuleAutoLayout['autoLayout'];
+    readonly nodes: ComputedNode[];
+    readonly edges: ComputedEdge[];
+}
+export declare function isComputedDynamicView(view: ComputedView): view is ComputedDynamicView;
+export type ComputedView = ComputedElementView | ComputedDynamicView;
+export declare function isComputedElementView(view: ComputedView): view is ComputedElementView;
+export type Point = readonly [x: number, y: number];
+export type BBox = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export interface DiagramLabel {
+    align: 'left' | 'right' | 'center';
+    fontStyle?: 'bold' | 'normal';
+    color?: ColorLiteral;
+    fontSize: number;
+    pt: Point;
+    width: number;
+    text: string;
+}
+export interface DiagramNode extends ComputedNode {
+    width: number;
+    height: number;
+    position: Point;
+    labels: DiagramLabel[];
+}
+export interface DiagramEdge extends ComputedEdge {
+    points: NonEmptyArray<Point>;
+    headArrow?: NonEmptyArray<Point>;
+    headArrowPoint?: Point;
+    tailArrow?: NonEmptyArray<Point>;
+    tailArrowPoint?: Point;
+    labels?: NonEmptyArray<DiagramLabel>;
+    labelBBox?: BBox;
+}
+export interface DiagramView extends Omit<ComputedView, 'nodes' | 'edges'> {
+    readonly nodes: DiagramNode[];
+    readonly edges: DiagramEdge[];
+    readonly width: number;
+    readonly height: number;
+}

package/dist/types/view.js

@@ -1,3 +1,4 @@
+import { isNullish } from 'remeda';
 export function isViewRuleExpression(rule) {
     return (('include' in rule && Array.isArray(rule.include))
         || ('exclude' in rule && Array.isArray(rule.exclude)));
@@ -8,9 +9,36 @@ export function isViewRuleStyle(rule) {
 export function isViewRuleAutoLayout(rule) {
     return 'autoLayout' in rule;
 }
-export function isStrictElementView(view) {
-    return 'viewOf' in view;
+export function isDynamicViewIncludeRule(rule) {
+    return 'include' in rule && Array.isArray(rule.include);
+}
+export function isDynamicView(view) {
+    return view.__ === 'dynamic';
+}
+export function isElementView(view) {
+    return isNullish(view.__) || view.__ === 'element';
 }
 export function isExtendsElementView(view) {
-    return 'extends' in view;
+    return isElementView(view) && 'extends' in view;
+}
+export function isStrictElementView(view) {
+    return isElementView(view) && 'viewOf' in view;
+}
+export function StepEdgeId(step) {
+    return `step-${String(step).padStart(3, '0')}`;
+}
+export function isStepEdgeId(id) {
+    return id.startsWith('step-');
+}
+export function extractStep(id) {
+    if (!isStepEdgeId(id)) {
+        throw new Error(`Invalid step edge id: ${id}`);
+    }
+    return Number(id.slice('step-'.length));
+}
+export function isComputedDynamicView(view) {
+    return view.__ === 'dynamic';
+}
+export function isComputedElementView(view) {
+    return isNullish(view.__) || view.__ === 'element';
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@likec4/core",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "license": "MIT",
   "homepage": "https://likec4.dev",
   "author": "Denis Davydkov <denis@davydkov.com>",
@@ -11,7 +11,7 @@
   },
   "bugs": "https://github.com/likec4/likec4/issues",
   "scripts": {
-    "typecheck": "tsc --noEmit",
+    "typecheck": "tsc -b",
     "build": "tsc",
     "prepack": "tsc -p tsconfig.build.json",
     "lint": "run -T eslint src/ --fix",
@@ -76,5 +76,5 @@
     "typescript": "^5.4.5",
     "vitest": "~1.5.2"
   },
-  "packageManager": "yarn@4.2.2"
+  "packageManager": "yarn@4.3.0"
 }

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

@@ -1,52 +0,0 @@
-import type { IconUrl, NonEmptyArray } from './_common';
-import type { ElementKind, ElementShape, ElementStyle, Fqn, Tag } from './element';
-import type { Opaque } from './opaque';
-import type { RelationID, RelationshipArrowType, RelationshipLineType } from './relation';
-import type { ThemeColor } from './theme';
-import type { BasicElementView, ViewID, ViewRuleAutoLayout } from './view';
-export type NodeId = Fqn;
-export type EdgeId = Opaque<string, 'EdgeId'>;
-export interface ComputedNode {
-    id: NodeId;
-    kind: ElementKind;
-    parent: NodeId | null;
-    title: string;
-    description: string | null;
-    technology: string | null;
-    tags: NonEmptyArray<Tag> | null;
-    links: NonEmptyArray<string> | null;
-    children: NodeId[];
-    inEdges: EdgeId[];
-    outEdges: EdgeId[];
-    shape: ElementShape;
-    /**
-     * @deprecated Use `style` instead
-     */
-    color: ThemeColor;
-    /**
-     * @deprecated Use `style` instead
-     */
-    icon?: IconUrl;
-    style: ElementStyle;
-    navigateTo?: ViewID;
-    level: number;
-    depth?: number;
-}
-export interface ComputedEdge {
-    id: EdgeId;
-    parent: NodeId | null;
-    source: NodeId;
-    target: NodeId;
-    label: string | null;
-    relations: RelationID[];
-    color?: ThemeColor;
-    line?: RelationshipLineType;
-    head?: RelationshipArrowType;
-    tail?: RelationshipArrowType;
-}
-export interface ComputedView extends Omit<BasicElementView, 'rules'> {
-    readonly extends?: ViewID;
-    readonly autoLayout: ViewRuleAutoLayout['autoLayout'];
-    readonly nodes: ComputedNode[];
-    readonly edges: ComputedEdge[];
-}

package/dist/types/computed-view.js

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

package/dist/types/diagram.d.ts

@@ -1,40 +0,0 @@
-import type { NonEmptyArray } from './_common';
-import type { ComputedEdge, ComputedNode, ComputedView } from './computed-view';
-import type { ColorLiteral } from './theme';
-export type Point = readonly [x: number, y: number];
-export type BBox = {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-};
-export interface DiagramLabel {
-    align: 'left' | 'right' | 'center';
-    fontStyle?: 'bold' | 'normal';
-    color?: ColorLiteral;
-    fontSize: number;
-    pt: Point;
-    width: number;
-    text: string;
-}
-export interface DiagramNode extends ComputedNode {
-    width: number;
-    height: number;
-    position: Point;
-    labels: DiagramLabel[];
-}
-export interface DiagramEdge extends ComputedEdge {
-    points: NonEmptyArray<Point>;
-    headArrow?: NonEmptyArray<Point>;
-    headArrowPoint?: Point;
-    tailArrow?: NonEmptyArray<Point>;
-    tailArrowPoint?: Point;
-    labels?: NonEmptyArray<DiagramLabel>;
-    labelBBox?: BBox;
-}
-export interface DiagramView extends Omit<ComputedView, 'nodes' | 'edges'> {
-    readonly nodes: DiagramNode[];
-    readonly edges: DiagramEdge[];
-    readonly width: number;
-    readonly height: number;
-}

package/dist/types/diagram.js

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