@likec4/core 1.32.2 → 1.33.0

package/dist/utils/iterable/index.d.mts

@@ -0,0 +1,100 @@
+import { I as IteratorLike } from '../../shared/core.DuSLYTG6.mjs';
+import 'type-fest';
+
+declare function isIterable<T, I extends Iterable<T>>(something: I | unknown): something is Iterable<T>;
+
+/**
+ * Filters an iterable based on a predicate.
+ * Composabel first version of `ifilter`.
+ * @signature
+ *    ifilter(predicate)(data)
+ */
+declare function ifilter<T, S extends T>(predicate: (v: T) => v is S): (iterable: Iterable<T>) => IteratorLike<S>;
+declare function ifilter<T>(predicate: (v: T) => boolean): (iterable: Iterable<T>) => IteratorLike<T>;
+/**
+ * Filters an iterable based on a predicate.
+ * Data first version of `ifilter`.
+ * @signature
+ *    ifilter(data, predicate)
+ * @example
+ *    ifilter(new Set([1, 2, 3]), x => x % 2 === 1) // => Iterable<[1, 3]>
+ */
+declare function ifilter<T, S extends T>(iterable: Iterable<T>, predicate: (v: T) => v is S): IteratorLike<S>;
+declare function ifilter<T>(iterable: Iterable<T>, predicate: (v: T) => boolean): IteratorLike<T>;
+
+/**
+ * Finds the first element in the iterable that satisfies the predicate.
+ * Composable first version of `find`.
+ * @signature
+ *   ifind(predicate)(data)
+ */
+declare function ifind<T, S extends T>(predicate: (item: T) => item is S): (iterable: Iterable<T>) => S | undefined;
+declare function ifind<T>(predicate: (item: T) => boolean): (iterable: Iterable<T>) => T | undefined;
+/**
+ * Finds the first element in the iterable that satisfies the predicate.
+ * Data first version of `find`.
+ * @signature
+ *  ifind(data, predicate)
+ */
+declare function ifind<T, S extends T>(iterable: Iterable<T>, predicate: (item: T) => item is S): S | undefined;
+declare function ifind<T>(iterable: Iterable<T>, predicate: (item: T) => boolean): T | undefined;
+
+declare function iflat(): <T>(iterable: Iterable<IteratorLike<T>>) => IteratorLike<T>;
+declare function iflat<T>(iterable: Iterable<IteratorLike<T>>): IteratorLike<T>;
+
+declare function ihead<T>(): (iterable: Iterable<T>) => T | undefined;
+/**
+ * Finds the first element in the iterable that satisfies the predicate.
+ * Data first version of `find`.
+ * @signature
+ *  ifind(data, predicate)
+ */
+declare function ihead<T>(iterable: Iterable<T>): T | undefined;
+
+type MapFunction<T, S> = (item: T) => S;
+/**
+ * Maps an iterable using a mapper function.
+ * Composable first version of `imap`.
+ * @signature
+ *   imap(mapper)(data)
+ */
+declare function imap<T, S>(mapper: MapFunction<T, S>): (iterable: Iterable<T>) => IteratorLike<S>;
+/**
+ * Maps an iterable using a mapper function.
+ * Data first version of `imap`.
+ * @signature
+ *   imap(data, mapper)
+ */
+declare function imap<T, S>(iterable: Iterable<T>, mapper: MapFunction<T, S>): IteratorLike<S>;
+
+declare function ireduce<T, R>(reducer: (acc: R, item: T) => R, initialValue: R): (iterable: Iterable<T>) => R;
+declare function ireduce<T, R>(iterable: Iterable<T>, reducer: (acc: R, item: T) => R, initialValue: R): R;
+
+/**
+ * Checks if at least one element in the iterable satisfies the predicate.
+ * Composable first version of `some`.
+ * @signature
+ *   isome(predicate)(data)
+ */
+declare function isome<T>(predicate: (item: T) => boolean): (iterable: Iterable<T>) => boolean;
+/**
+ * Checks if at least one element in the iterable satisfies the predicate.
+ * Data first version of `some`.
+ * @signature
+ *  isome(data, predicate)
+ */
+declare function isome<T>(iterable: Iterable<T>, predicate: (item: T) => boolean): boolean;
+
+declare function toArray(): <T>(iterable: Iterable<T> | ArrayLike<T>) => T[];
+declare function toArray<T>(iterable: Iterable<T> | ArrayLike<T>): T[];
+declare function toSet(): <T>(iterable: Iterable<T>) => Set<T>;
+declare function toSet<T>(iterable: Iterable<T>): Set<T>;
+
+/**
+ * Returns an iterable that yields only unique values.
+ * It uses a Set to keep track of the values.
+ */
+declare function iunique(): <T>(iterable: Iterable<T>) => IteratorLike<T>;
+declare function iunique<T>(iterable: Iterable<T>): IteratorLike<T>;
+
+export { ifilter, ifind, iflat, ihead, imap, ireduce, isIterable, isome, iunique, toArray, toSet };

package/dist/utils/iterable/index.mjs

@@ -0,0 +1,24 @@
+import { n } from '../../shared/core.8KM0D6va.mjs';
+export { i as iflat, a as isIterable, b as iunique } from '../../shared/core.8KM0D6va.mjs';
+import { t } from '../../shared/core.BH9nN-_I.mjs';
+export { i as ifilter } from '../../shared/core.BH9nN-_I.mjs';
+export { i as ifind, a as ihead } from '../../shared/core.DsMrjY2q.mjs';
+export { i as imap, t as toArray, a as toSet } from '../../shared/core.Btl47GOn.mjs';
+import { i as invariant } from '../../shared/core.D4npX2q8.mjs';
+export { i as isome } from '../../shared/core.BoyJPEen.mjs';
+
+function ireduce(arg1, arg2, arg3) {
+  const reducer = n(arg3) ? arg2 : arg1;
+  const initialValue = arg3 ?? arg2;
+  invariant(t(reducer));
+  function _reduce(iter) {
+    let acc = initialValue;
+    for (const value of iter) {
+      acc = reducer(acc, value);
+    }
+    return acc;
+  }
+  return n(arg3) ? _reduce(arg1) : _reduce;
+}
+
+export { ireduce };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@likec4/core",
-  "version": "1.32.2",
+  "version": "1.33.0",
   "license": "MIT",
   "homepage": "https://likec4.dev",
   "author": "Denis Davydkov <denis@davydkov.com>",
@@ -93,16 +93,31 @@
     "access": "public"
   },
   "dependencies": {
-    "type-fest": "^4.41.0"
+    "mdast-util-from-markdown": "^2.0.2",
+    "mdast-util-to-string": "^4.0.0",
+    "rehype-format": "5.0.1",
+    "rehype-raw": "7.0.0",
+    "rehype-sanitize": "^6.0.0",
+    "rehype-stringify": "10.0.1",
+    "remark-gfm": "4.0.1",
+    "remark-parse": "11.0.0",
+    "remark-rehype": "11.1.2",
+    "type-fest": "^4.41.0",
+    "unified": "11.0.5"
   },
   "devDependencies": {
     "@dagrejs/dagre": "1.1.4",
-    "@mantine/colors-generator": "8.1.0",
+    "@mantine/colors-generator": "8.1.1",
+    "@types/extend": "3.0.0",
+    "@types/hast": "3.0.0",
+    "@types/mdast": "4.0.0",
     "@types/natural-compare-lite": "^1.4.2",
     "@types/object-hash": "^3.0.6",
+    "@types/unist": "3.0.0",
+    "@types/node": "~20.19.1",
     "chroma-js": "^3.1.2",
     "defu": "^6.1.4",
-    "fdir": "^6.4.4",
+    "fdir": "6.4.6",
     "graphology": "^0.25.4",
     "graphology-dag": "^0.4.1",
     "graphology-types": "^0.24.8",
@@ -110,17 +125,18 @@
     "natural-compare-lite": "^1.4.0",
     "object-hash": "^3.0.0",
     "obliterator": "^2.0.5",
-    "remeda": "^2.23.0",
+    "remeda": "^2.23.1",
     "turbo": "2.5.4",
     "typescript": "5.8.3",
     "unbuild": "3.5.0",
-    "vitest": "3.2.3",
-    "@likec4/tsconfig": "1.32.2"
+    "vitest": "3.2.4",
+    "@likec4/tsconfig": "1.33.0"
   },
   "scripts": {
     "typecheck": "tsc -b --verbose",
     "build": "unbuild",
     "lint": "run -T eslint src/ --fix",
+    "lint:package": "pnpx publint ./package.tgz",
     "test": "vitest run --no-isolate",
     "test:watch": "vitest",
     "clean": "pnpm rimraf dist lib",

package/src/builder/Builder.ts

@@ -275,11 +275,10 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
     return [{
       id: id as any,
       title,
-      description,
+      description: description ? { txt: description } : null,
       tags,
       links,
       _stage: 'parsed',
-      // customColorDefinitions: {},
       ...props,
     }, builder]
   }
@@ -438,6 +437,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
             const {
               title = '',
               links: _links = [],
+              description = null,
               ...props
             } = defu(
               typeof _props === 'string' ? { title: _props } : { ..._props },
@@ -452,6 +452,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
                 model: target,
               },
               title,
+              ...(description && { description: { txt: description } }),
               ...(links && { links }),
               ...props,
             })
@@ -463,6 +464,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
             const {
               title = '',
               links: _links = [],
+              description = null,
               ...props
             } = defu(
               typeof _props === 'string' ? { title: _props } : { ..._props },
@@ -474,6 +476,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
                 model: target,
               },
               title,
+              ...(description && { description: { txt: description } }),
               ...(links && { links }),
               ...props,
             })
@@ -493,6 +496,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
                 icon: _icon,
                 style,
                 title,
+                description = null,
                 ...props
               } = typeof _props === 'string' ? { title: _props } : { ..._props }
 
@@ -506,7 +510,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
                 id: _id,
                 kind: kind as any,
                 title: title ?? nameFromFqn(_id),
-                description: null,
+                ...(description && { description: { txt: description } }),
                 technology: null,
                 tags: [],
                 color: specStyle?.color ?? DefaultThemeColor as Color,
@@ -686,6 +690,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
             const {
               links,
               title,
+              description = null,
               ...props
             } = typeof _props === 'string' ? { title: _props } : { ..._props }
             const _id = b.__deploymentFqn(id)
@@ -694,6 +699,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
               id: _id,
               element: target as Fqn,
               ...title && { title },
+              ...(description && { description: { txt: description } }),
               ...links && { links: mapLinks(links) },
               ...props,
             } as DeployedInstance)
@@ -705,6 +711,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
             const {
               title = null,
               links,
+              description = null,
               ...props
             } = typeof _props === 'string' ? { title: _props } : { ..._props }
 
@@ -716,6 +723,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
                 deployment: target as any,
               },
               title,
+              ...description && { description: { txt: description } },
               ...links && { links: mapLinks(links) },
               ...props,
             })
@@ -735,6 +743,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
                 icon: _icon,
                 style,
                 title,
+                description = null,
                 ...props
               } = typeof _props === 'string' ? { title: _props } : { ..._props }
 
@@ -746,7 +755,7 @@ function builder<Spec extends BuilderSpecification, T extends AnyTypes>(
                 id: _id,
                 kind: kind as any,
                 title: title ?? nameFromFqn(_id),
-                description: null,
+                ...(description && { description: { txt: description } }),
                 technology: null,
                 tags: null,
                 style: {

package/src/builder/__snapshots__/Builder-style1.spec.ts.snap

@@ -10,7 +10,6 @@ exports[`Builder (style1) > should build nested elements and relTo 1`] = `
   "elements": {
     "s1": {
       "color": "green",
-      "description": null,
       "id": "s1",
       "kind": "system",
       "links": null,
@@ -25,7 +24,6 @@ exports[`Builder (style1) > should build nested elements and relTo 1`] = `
     },
     "s1.c1": {
       "color": "primary",
-      "description": null,
       "id": "s1.c1",
       "kind": "component",
       "links": null,
@@ -39,7 +37,6 @@ exports[`Builder (style1) > should build nested elements and relTo 1`] = `
     },
     "s2": {
       "color": "green",
-      "description": null,
       "id": "s2",
       "kind": "system",
       "links": null,
@@ -54,7 +51,6 @@ exports[`Builder (style1) > should build nested elements and relTo 1`] = `
     },
     "s2.c1": {
       "color": "primary",
-      "description": null,
       "id": "s2.c1",
       "kind": "component",
       "links": null,
@@ -68,7 +64,6 @@ exports[`Builder (style1) > should build nested elements and relTo 1`] = `
     },
     "s2.c1.c2": {
       "color": "primary",
-      "description": null,
       "id": "s2.c1.c2",
       "kind": "component",
       "links": null,
@@ -82,7 +77,6 @@ exports[`Builder (style1) > should build nested elements and relTo 1`] = `
     },
     "s2.c1.c2.c3": {
       "color": "primary",
-      "description": null,
       "id": "s2.c1.c2.c3",
       "kind": "component",
       "links": null,
@@ -176,7 +170,6 @@ exports[`Builder (style1) > should build view  1`] = `
   "elements": {
     "c1": {
       "color": "primary",
-      "description": null,
       "id": "c1",
       "kind": "component",
       "links": null,
@@ -188,7 +181,6 @@ exports[`Builder (style1) > should build view  1`] = `
     },
     "c2": {
       "color": "primary",
-      "description": null,
       "id": "c2",
       "kind": "component",
       "links": null,
@@ -200,7 +192,6 @@ exports[`Builder (style1) > should build view  1`] = `
     },
     "c3": {
       "color": "primary",
-      "description": null,
       "id": "c3",
       "kind": "component",
       "links": null,
@@ -310,7 +301,6 @@ exports[`Builder (style1) > should build viewOf  1`] = `
   "elements": {
     "c1": {
       "color": "primary",
-      "description": null,
       "id": "c1",
       "kind": "component",
       "links": null,
@@ -322,7 +312,6 @@ exports[`Builder (style1) > should build viewOf  1`] = `
     },
     "c2": {
       "color": "primary",
-      "description": null,
       "id": "c2",
       "kind": "component",
       "links": null,
@@ -334,7 +323,6 @@ exports[`Builder (style1) > should build viewOf  1`] = `
     },
     "c2.c3": {
       "color": "primary",
-      "description": null,
       "id": "c2.c3",
       "kind": "component",
       "links": null,
@@ -346,7 +334,6 @@ exports[`Builder (style1) > should build viewOf  1`] = `
     },
     "c2.c3.c4": {
       "color": "primary",
-      "description": null,
       "id": "c2.c3.c4",
       "kind": "component",
       "links": null,

package/src/builder/__snapshots__/Builder-style2.compute-model.json5

@@ -7,7 +7,6 @@
   "elements": {
     "cloud": {
       "color": "primary",
-      "description": null,
       "id": "cloud",
       "kind": "system",
       "links": null,
@@ -22,7 +21,6 @@
     },
     "cloud.api": {
       "color": "primary",
-      "description": null,
       "id": "cloud.api",
       "kind": "component",
       "links": null,
@@ -34,7 +32,6 @@
     },
     "cloud.ui": {
       "color": "primary",
-      "description": null,
       "id": "cloud.ui",
       "kind": "component",
       "links": null,
@@ -46,7 +43,6 @@
     },
     "customer": {
       "color": "primary",
-      "description": null,
       "id": "customer",
       "kind": "actor",
       "links": null,
@@ -167,7 +163,7 @@
           "target": "cloud.api",
         },
       ],
-      "hash": "e2efe9f71b40357a84c900d60e5332c97d0af742",
+      "hash": "f58aa16b81d32de0caf9a0de33a3abc82b18475f",
       "id": "cloudui",
       "links": null,
       "nodes": [
@@ -262,7 +258,7 @@
           "target": "cloud",
         },
       ],
-      "hash": "717ea7de18ab0b5f85bb78a612ad1644052ad367",
+      "hash": "31dda554df38c831c5949a7a9e8add1e0810ca18",
       "id": "index",
       "links": null,
       "nodes": [

package/src/builder/__snapshots__/Builder-style2.spec.ts.snap

@@ -6,7 +6,6 @@ exports[`Builder (style 2) > should build  1`] = `
   "deployments": {
     "elements": {
       "dev": {
-        "description": null,
         "id": "dev",
         "kind": "env",
         "style": {
@@ -19,7 +18,6 @@ exports[`Builder (style 2) > should build  1`] = `
         "title": "dev",
       },
       "dev.local": {
-        "description": null,
         "id": "dev.local",
         "kind": "node",
         "style": {
@@ -31,7 +29,6 @@ exports[`Builder (style 2) > should build  1`] = `
         "title": "local",
       },
       "prod": {
-        "description": null,
         "id": "prod",
         "kind": "env",
         "style": {
@@ -44,7 +41,6 @@ exports[`Builder (style 2) > should build  1`] = `
         "title": "prod",
       },
       "prod.eu": {
-        "description": null,
         "id": "prod.eu",
         "kind": "node",
         "style": {
@@ -65,7 +61,6 @@ exports[`Builder (style 2) > should build  1`] = `
   "elements": {
     "cloud": {
       "color": "primary",
-      "description": null,
       "id": "cloud",
       "kind": "system",
       "links": null,
@@ -80,7 +75,6 @@ exports[`Builder (style 2) > should build  1`] = `
     },
     "cloud.ui": {
       "color": "primary",
-      "description": null,
       "id": "cloud.ui",
       "kind": "component",
       "links": null,
@@ -92,7 +86,6 @@ exports[`Builder (style 2) > should build  1`] = `
     },
     "customer": {
       "color": "primary",
-      "description": null,
       "id": "customer",
       "kind": "actor",
       "links": null,

package/src/compute-view/deployment-view/__test__/fixture.ts

@@ -79,8 +79,12 @@ export const builder = b
       }),
       system('cloud').with(
         component('frontend').with(
-          webapp('dashboard'),
-          mobile('mobile'),
+          webapp('dashboard', {
+            title: 'Dashboard',
+          }),
+          mobile('mobile', {
+            title: 'Mobile',
+          }),
         ),
         component('auth'),
         component('backend').with(
@@ -140,11 +144,15 @@ export const builder = b
         zone('eu').with(
           zone('zone1').with(
             instanceOf('api', 'cloud.backend.api'),
-            instanceOf('ui', 'cloud.frontend.dashboard'),
+            instanceOf('ui', 'cloud.frontend.dashboard', {
+              title: 'prod.eu.zone1/dashboard',
+            }),
           ),
           zone('zone2').with(
             instanceOf('api', 'cloud.backend.api'),
-            instanceOf('ui', 'cloud.frontend.dashboard'),
+            instanceOf('ui', 'cloud.frontend.dashboard', {
+              title: 'prod.eu.zone2/dashboard',
+            }),
           ),
           instanceOf('auth', 'cloud.auth'),
           instanceOf('media', 'cloud.media'),
@@ -153,7 +161,9 @@ export const builder = b
         zone('us').with(
           zone('zone1').with(
             instanceOf('api', 'cloud.backend.api'),
-            instanceOf('ui', 'cloud.frontend.dashboard'),
+            instanceOf('ui', 'cloud.frontend.dashboard', {
+              title: 'prod.us.zone1/dashboard',
+            }),
           ),
           instanceOf('db', 'aws.rds'),
         ),

package/src/compute-view/deployment-view/utils.ts

@@ -140,16 +140,18 @@ export function toNodeSource<A extends AnyAux>(
 ): ComputedNodeSource<A> {
   if (el.isDeploymentNode()) {
     const onlyOneInstance = el.onlyOneInstance()
-    let { title, kind, id, ...$node } = el.$node
+    let { title, kind, id, description, ...$node } = el.$node
     const { icon, color, shape, ...style } = el.$node.style ?? {}
     let tags = [...el.tags]
+    // let description
     // If there is only one instance
     if (onlyOneInstance) {
       tags = unique([...tags, ...onlyOneInstance.tags])
-      // If title was not overriden
+      // If title was not overriden, take title from the instance
       if (title === nameFromFqn(el.id)) {
         title = onlyOneInstance.title
       }
+      description = onlyOneInstance.description.$source ?? description
     }
 
     return {
@@ -162,6 +164,7 @@ export function toNodeSource<A extends AnyAux>(
       ...(icon && { icon }),
       ...(color && { color }),
       ...(shape && { shape }),
+      ...(description && { description }),
       tags,
       style: {
         ...style,
@@ -174,10 +177,7 @@ export function toNodeSource<A extends AnyAux>(
   invariant(el.isInstance(), 'Expected Instance')
   const instance = el.$instance
   const element = el.element
-
-  const icon = instance.style?.icon ?? element.icon
-  const color = instance.style?.color ?? element.color
-  const shape = instance.style?.shape ?? element.shape
+  const { icon, color, shape, ...style } = el.style
 
   const links = [
     ...element.links,
@@ -191,21 +191,21 @@ export function toNodeSource<A extends AnyAux>(
 
   const notation = instance.notation ?? element.$element.notation
 
+  let description = el.description.$source
+  let technology = instance.technology ?? element.technology
+
   return {
     id: el.id as scalar.NodeId,
     kind: 'instance' as unknown as aux.DeploymentKind<A>,
-    title: instance.title ?? element.title,
-    description: instance.description ?? element.description,
-    technology: instance.technology ?? element.technology,
+    title: el.title,
+    ...(description && { description }),
+    ...(technology && { technology }),
     tags: [...el.tags],
     links: hasAtLeast(links, 1) ? links : null,
     ...icon && { icon },
     ...color && { color },
     ...shape && { shape },
-    style: {
-      ...element.style,
-      ...instance.style,
-    },
+    style,
     deploymentRef: instance.id,
     modelRef: element.id,
     ...notation && { notation },

package/src/compute-view/dynamic-view/compute.ts

@@ -154,7 +154,7 @@ class DynamicViewCompute<A extends AnyAux> {
       [...this.explicits].map(elementModelToNodeSource),
     )
 
-    const edges = this.steps.map(({ id, source, target, relations, title, isBackward, tags, ...step }) => {
+    const edges = this.steps.map(({ id, source, target, relations, title, description, isBackward, tags, ...step }) => {
       const sourceNode = nonNullable(nodesMap.get(source.id as scalar.NodeId), `Source node ${source.id} not found`)
       const targetNode = nonNullable(nodesMap.get(target.id as scalar.NodeId), `Target node ${target.id} not found`)
       const edge: ComputedEdge<A> = {
@@ -164,6 +164,7 @@ class DynamicViewCompute<A extends AnyAux> {
         target: targetNode.id,
         label: title,
         relations,
+        description: description ? { txt: description } : null,
         color: DefaultRelationshipColor,
         line: DefaultLineStyle,
         head: DefaultArrowType,

package/src/compute-view/element-view/__test__/__snapshots__/legacy.spec.ts.snap

@@ -76,7 +76,7 @@ exports[`compute-element-view > view of cloud 1`] = `
       "target": "amazon",
     },
   ],
-  "hash": "6df052156ae59d91622677537c2d657e4946d803",
+  "hash": "222934c5cc26fad8c43658376bc4e475e47c666f",
   "id": "index",
   "links": null,
   "nodes": [
@@ -308,7 +308,7 @@ exports[`compute-element-view > view of cloud.frontend 1`] = `
       "target": "cloud.backend",
     },
   ],
-  "hash": "388ed63a4179b91d2953e5c4908c651e3e826eb0",
+  "hash": "3d2473dacefacc5be93c73cfe3b1c20824c1b57f",
   "id": "index",
   "links": null,
   "nodes": [

package/src/compute-view/relationships-view/layout.ts

@@ -317,7 +317,7 @@ export function layoutRelationshipsView(data: RelationshipsViewData): Pick<Diagr
       title: element.title,
       ...position,
       position: [position.x, position.y],
-      description: element.description,
+      description: element.description?.$source ?? null,
       technology: element.technology,
       tags: [],
       links: null,