@likec4/core 0.37.0 → 0.40.0

package/dist/cjs/errors/index.d.ts

@@ -0,0 +1,45 @@
+import { CustomError } from 'ts-custom-error';
+export interface BaseErrorOptions {
+    cause?: unknown;
+}
+/**
+ * Base class for all errors in the LikeC4 library.
+ */
+export declare class BaseError extends CustomError {
+    constructor(message: string, options?: BaseErrorOptions);
+}
+export declare class InvalidArgError extends BaseError {
+    constructor(message: string, options?: BaseErrorOptions);
+}
+/**
+ * Unknown error, mosly probably a bug, unhandled case or coming from a third-party library.
+ */
+export declare class UnknownError extends BaseError {
+    constructor(message: string, options?: BaseErrorOptions);
+}
+export declare class NullableError extends BaseError {
+    constructor(message: string, options?: BaseErrorOptions);
+}
+export declare class InvariantError extends BaseError {
+    constructor(message: string, options?: BaseErrorOptions);
+}
+export declare function nonNullable<T>(value: T, message?: string): T & {};
+export declare class RelationRefError extends BaseError {
+    constructor(message: string, options?: BaseErrorOptions);
+}
+export declare function normalizeError(e: unknown): BaseError;
+export declare function serializeError(e: unknown): {
+    name: string;
+    message: string;
+    error: BaseError;
+};
+export declare function throwNormalizedError(e: unknown): never;
+export declare function invariant(condition: any, message?: string): asserts condition;
+export declare class NonExhaustiveError extends BaseError {
+    constructor(message: string, options?: BaseErrorOptions);
+}
+export declare function nonexhaustive(value: never): never;
+export declare class InvalidModelError extends BaseError {
+    constructor(message: string, options?: BaseErrorOptions);
+}
+export declare function ensureModel(condition: any, message?: string): asserts condition;

package/dist/cjs/errors/index.js

@@ -0,0 +1,137 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UnknownError = exports.RelationRefError = exports.NullableError = exports.NonExhaustiveError = exports.InvariantError = exports.InvalidModelError = exports.InvalidArgError = exports.BaseError = void 0;
+exports.ensureModel = ensureModel;
+exports.invariant = invariant;
+exports.nonNullable = nonNullable;
+exports.nonexhaustive = nonexhaustive;
+exports.normalizeError = normalizeError;
+exports.serializeError = serializeError;
+exports.throwNormalizedError = throwNormalizedError;
+var _safeStableStringify = _interopRequireDefault(require("safe-stable-stringify"));
+var _tsCustomError = require("ts-custom-error");
+var _guards = require("../utils/guards");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+class BaseError extends _tsCustomError.CustomError {
+  constructor(message, options) {
+    super(message, options);
+    Object.defineProperty(this, "name", {
+      value: "BaseError"
+    });
+  }
+}
+exports.BaseError = BaseError;
+class InvalidArgError extends BaseError {
+  constructor(message, options) {
+    super(message, options);
+    Object.defineProperty(this, "name", {
+      value: "InvalidArgError"
+    });
+  }
+}
+exports.InvalidArgError = InvalidArgError;
+class UnknownError extends BaseError {
+  constructor(message, options) {
+    super(message, options);
+    Object.defineProperty(this, "name", {
+      value: "UnknownError"
+    });
+  }
+}
+exports.UnknownError = UnknownError;
+class NullableError extends BaseError {
+  constructor(message, options) {
+    super(message, options);
+    Object.defineProperty(this, "name", {
+      value: "NullableError"
+    });
+  }
+}
+exports.NullableError = NullableError;
+class InvariantError extends BaseError {
+  constructor(message, options) {
+    super(message, options);
+    Object.defineProperty(this, "name", {
+      value: "InvariantError"
+    });
+  }
+}
+exports.InvariantError = InvariantError;
+function nonNullable(value, message) {
+  if (typeof value === "undefined" || value == null) {
+    throw new NullableError(message ?? `Expected defined value, but received ${value}`);
+  }
+  return value;
+}
+class RelationRefError extends BaseError {
+  constructor(message, options) {
+    super(message, options);
+    Object.defineProperty(this, "name", {
+      value: "RelationRefError"
+    });
+  }
+}
+exports.RelationRefError = RelationRefError;
+function normalizeError(e) {
+  if (e instanceof BaseError) {
+    return e;
+  }
+  if (e instanceof Error) {
+    return new UnknownError(e.message, {
+      cause: e
+    });
+  }
+  if (e === null || e === void 0) {
+    return new UnknownError("Undefined error");
+  }
+  const message = (0, _guards.isString)(e) ? e : (0, _safeStableStringify.default)(e);
+  return new UnknownError(message);
+}
+function serializeError(e) {
+  const error = normalizeError(e);
+  return {
+    name: error.name,
+    message: error.stack ? error.stack : `${error.name}: ${error.message}`,
+    error
+  };
+}
+function throwNormalizedError(e) {
+  throw normalizeError(e);
+}
+function invariant(condition, message) {
+  if (condition) {
+    return;
+  }
+  throw new InvariantError(message ?? "Invariant failed");
+}
+class NonExhaustiveError extends BaseError {
+  constructor(message, options) {
+    super(message, options);
+    Object.defineProperty(this, "name", {
+      value: "NonExhaustiveError"
+    });
+  }
+}
+exports.NonExhaustiveError = NonExhaustiveError;
+function nonexhaustive(value) {
+  const val = typeof value === "string" ? value : (0, _safeStableStringify.default)(value);
+  throw new NonExhaustiveError(`NonExhaustive value: ${val}`);
+}
+class InvalidModelError extends BaseError {
+  constructor(message, options) {
+    super(message, options);
+    Object.defineProperty(this, "name", {
+      value: "InvalidModelError"
+    });
+  }
+}
+exports.InvalidModelError = InvalidModelError;
+function ensureModel(condition, message) {
+  if (condition) {
+    return;
+  }
+  throw new InvalidModelError(message ?? "ModelIndex Invariant failed");
+}

package/dist/{index.cjs → cjs/index.js}

@@ -3,69 +3,69 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _types = require("./types/index.cjs");
-Object.keys(_types).forEach(function (key) {
+var _colors = require("./colors");
+Object.keys(_colors).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _types[key]) return;
+  if (key in exports && exports[key] === _colors[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _types[key];
+      return _colors[key];
     }
   });
 });
-var _utils = require("./utils/index.cjs");
-Object.keys(_utils).forEach(function (key) {
+var _computeView = require("./compute-view");
+Object.keys(_computeView).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _utils[key]) return;
+  if (key in exports && exports[key] === _computeView[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _utils[key];
+      return _computeView[key];
     }
   });
 });
-var _modelIndex = require("./model-index/index.cjs");
-Object.keys(_modelIndex).forEach(function (key) {
+var _errors = require("./errors");
+Object.keys(_errors).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _modelIndex[key]) return;
+  if (key in exports && exports[key] === _errors[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _modelIndex[key];
+      return _errors[key];
     }
   });
 });
-var _computeView = require("./compute-view/index.cjs");
-Object.keys(_computeView).forEach(function (key) {
+var _modelIndex = require("./model-index");
+Object.keys(_modelIndex).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _computeView[key]) return;
+  if (key in exports && exports[key] === _modelIndex[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _computeView[key];
+      return _modelIndex[key];
     }
   });
 });
-var _colors = require("./colors.cjs");
-Object.keys(_colors).forEach(function (key) {
+var _types = require("./types");
+Object.keys(_types).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _colors[key]) return;
+  if (key in exports && exports[key] === _types[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _colors[key];
+      return _types[key];
     }
   });
 });
-var _errors = require("./errors/index.cjs");
-Object.keys(_errors).forEach(function (key) {
+var _utils = require("./utils");
+Object.keys(_utils).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _errors[key]) return;
+  if (key in exports && exports[key] === _utils[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _errors[key];
+      return _utils[key];
     }
   });
 });

package/dist/{model-index/ModelIndex.cjs → cjs/model-index/ModelIndex.js}

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 module.exports = void 0;
 var _remeda = require("remeda");
-var _errors = require("../errors/index.cjs");
-var _utils = require("../utils/index.cjs");
+var _errors = require("../errors");
+var _utils = require("../utils");
 function childrenOf(trie) {
   const children = [];
   for (const {
@@ -40,8 +40,7 @@ class ModelIndex {
     relations
   }) {
     const index = new ModelIndex();
-    const sortedElements = (0, _remeda.pipe)((0, _remeda.values)(elements), (0, _remeda.sort)(_utils.compareByFqnHierarchically));
-    for (const el of sortedElements) {
+    for (const el of (0, _remeda.values)(elements)) {
       index.addElement(el);
     }
     for (const rel of (0, _remeda.values)(relations)) {

package/dist/{model-index/index.cjs → cjs/model-index/index.js}

@@ -9,5 +9,5 @@ Object.defineProperty(exports, "ModelIndex", {
     return _ModelIndex.default;
   }
 });
-var _ModelIndex = _interopRequireDefault(require("./ModelIndex.cjs"));
+var _ModelIndex = _interopRequireDefault(require("./ModelIndex"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/{types → cjs/types}/computed-view.d.ts

@@ -22,6 +22,7 @@ export interface ComputedNode {
     color: ThemeColor;
     icon?: IconUrl;
     navigateTo?: ViewID;
+    level: number;
 }
 export interface ComputedEdge {
     id: EdgeId;

package/dist/{types → cjs/types}/diagram.d.ts

@@ -17,6 +17,7 @@ export interface DiagramNode extends ComputedNode {
     };
     labels: DiagramLabel[];
     position: Point;
+    depth?: number;
 }
 export interface DiagramEdge extends ComputedEdge {
     points: Point[];
@@ -28,10 +29,4 @@ export interface DiagramView extends Omit<ComputedView, 'nodes' | 'edges'> {
     readonly edges: DiagramEdge[];
     width: number;
     height: number;
-    boundingBox: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
 }

package/dist/{types/index.cjs → cjs/types/index.js}

@@ -7,7 +7,7 @@ var _exportNames = {
   Expr: true
 };
 exports.Expr = void 0;
-var _opaque = require("./opaque.cjs");
+var _opaque = require("./opaque");
 Object.keys(_opaque).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -19,7 +19,7 @@ Object.keys(_opaque).forEach(function (key) {
     }
   });
 });
-var _common = require("./_common.cjs");
+var _common = require("./_common");
 Object.keys(_common).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -31,7 +31,7 @@ Object.keys(_common).forEach(function (key) {
     }
   });
 });
-var _theme = require("./theme.cjs");
+var _theme = require("./theme");
 Object.keys(_theme).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -43,7 +43,7 @@ Object.keys(_theme).forEach(function (key) {
     }
   });
 });
-var _element = require("./element.cjs");
+var _element = require("./element");
 Object.keys(_element).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -55,7 +55,7 @@ Object.keys(_element).forEach(function (key) {
     }
   });
 });
-var _relation = require("./relation.cjs");
+var _relation = require("./relation");
 Object.keys(_relation).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -67,7 +67,7 @@ Object.keys(_relation).forEach(function (key) {
     }
   });
 });
-var _model = require("./model.cjs");
+var _model = require("./model");
 Object.keys(_model).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -79,7 +79,7 @@ Object.keys(_model).forEach(function (key) {
     }
   });
 });
-var _view = require("./view.cjs");
+var _view = require("./view");
 Object.keys(_view).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -91,7 +91,7 @@ Object.keys(_view).forEach(function (key) {
     }
   });
 });
-var _Expr = _interopRequireWildcard(require("./expression.cjs"));
+var _Expr = _interopRequireWildcard(require("./expression"));
 exports.Expr = _Expr;
 Object.keys(_Expr).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -104,7 +104,7 @@ Object.keys(_Expr).forEach(function (key) {
     }
   });
 });
-var _computedView = require("./computed-view.cjs");
+var _computedView = require("./computed-view");
 Object.keys(_computedView).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -116,7 +116,7 @@ Object.keys(_computedView).forEach(function (key) {
     }
   });
 });
-var _diagram = require("./diagram.cjs");
+var _diagram = require("./diagram");
 Object.keys(_diagram).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;

package/dist/{types → cjs/types}/theme.d.ts

@@ -1,6 +1,12 @@
 export type ThemeColor = 'amber' | 'blue' | 'gray' | 'slate' | 'green' | 'indigo' | 'muted' | 'primary' | 'red' | 'secondary' | 'sky';
 export type HexColorLiteral = `#${string}`;
 export type ColorLiteral = HexColorLiteral;
+export type InteractiveColor = HexColorLiteral | [
+    HexColorLiteral,
+    {
+        onHover: HexColorLiteral;
+    }
+];
 export interface ThemeColorValues {
     fill: ColorLiteral;
     stroke: ColorLiteral;
@@ -11,8 +17,8 @@ export type ThemeColors = {
     [key in ThemeColor]: ThemeColorValues;
 };
 export interface ThemeRelationColors {
-    lineColor: ColorLiteral;
-    labelColor: ColorLiteral;
+    lineColor: InteractiveColor;
+    labelColor: InteractiveColor;
 }
 export interface LikeC4Theme {
     font: 'Helvetica';

package/dist/{types → cjs/types}/view.d.ts

@@ -31,6 +31,21 @@ export interface BasicElementView {
     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.
+     */
+    readonly docUri?: string;
+    /**
+     * For all views we find common ancestor path.
+     * This is used to generate relative paths, i.e.:
+     * - "" for views in the common ancestor directory (or root)
+     * - "subdir" for views in "<root>/subdir"
+     * - "subdir/subdir1" for views in "<root>/subdir/subdir1"
+     *
+     * Undefined if the view is auto-generated.
+     */
+    readonly relativePath?: string;
 }
 export interface StrictElementView extends BasicElementView {
     readonly viewOf: Fqn;

package/dist/{utils/compute-node-levels.cjs → cjs/utils/compute-node-levels.js}

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.computeNodeLevels = void 0;
-var _errors = require("../errors/index.cjs");
+var _errors = require("../errors");
 const computeNodeLevels = ({
   nodes
 }) => {

package/dist/{utils/fqn.cjs → cjs/utils/fqn.js}

@@ -13,7 +13,7 @@ exports.nameFromFqn = nameFromFqn;
 exports.notDescendantOf = notDescendantOf;
 exports.parentFqn = parentFqn;
 var _remeda = require("remeda");
-var _guards = require("./guards.cjs");
+var _guards = require("./guards");
 function nameFromFqn(fqn) {
   const lastDot = fqn.lastIndexOf(".");
   if (lastDot > 0) {

package/dist/{utils → cjs/utils}/guards.d.ts

@@ -1,5 +1,3 @@
 import type { NonEmptyArray } from '../types';
 export declare function isString(value: unknown): value is string;
-export declare function failUnexpected(arg: never): never;
-export declare function ignoreNeverInRuntime(arg: never): void;
 export declare function isNonEmptyArray<A>(arr: ArrayLike<A>): arr is NonEmptyArray<A>;

package/dist/cjs/utils/guards.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isNonEmptyArray = isNonEmptyArray;
+exports.isString = isString;
+function isString(value) {
+  return value != null && typeof value === "string";
+}
+function isNonEmptyArray(arr) {
+  return arr.length > 0;
+}

package/dist/{utils/index.cjs → cjs/utils/index.js}

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _fqn = require("./fqn.cjs");
+var _fqn = require("./fqn");
 Object.keys(_fqn).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _fqn[key]) return;
@@ -14,7 +14,7 @@ Object.keys(_fqn).forEach(function (key) {
     }
   });
 });
-var _guards = require("./guards.cjs");
+var _guards = require("./guards");
 Object.keys(_guards).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _guards[key]) return;
@@ -25,7 +25,7 @@ Object.keys(_guards).forEach(function (key) {
     }
   });
 });
-var _computeNodeLevels = require("./compute-node-levels.cjs");
+var _computeNodeLevels = require("./compute-node-levels");
 Object.keys(_computeNodeLevels).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _computeNodeLevels[key]) return;
@@ -36,7 +36,7 @@ Object.keys(_computeNodeLevels).forEach(function (key) {
     }
   });
 });
-var _relations = require("./relations.cjs");
+var _relations = require("./relations");
 Object.keys(_relations).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _relations[key]) return;

package/dist/{utils/relations.cjs → cjs/utils/relations.js}

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.compareRelations = exports.Relations = void 0;
-var _fqn = require("./fqn.cjs");
+var _fqn = require("./fqn");
 var _rambdax = require("rambdax");
 const compareRelations = (a, b) => {
   return (0, _fqn.compareFqnHierarchically)(a.source, b.source) || (0, _fqn.compareFqnHierarchically)(a.target, b.target);