@likec4/core 1.48.0 → 1.50.0

package/dist/_chunks/index5.d.mts

@@ -1,42 +1,404 @@
-import { n as Any } from "./_aux.mjs";
-import { C as ElementModel, S as NodeModel, T as RelationshipModel, a as DeploymentNodeModel, c as NestedElementOfDeployedInstanceModel, i as DeploymentElementModel, r as DeployedInstanceModel, s as DeploymentRelationModel, w as AnyRelationshipModel, x as EdgeModel, y as LikeC4ViewModel } from "./LikeC4Model.mjs";
+import { $i as IterableContainer, bi as Fqn, ea as IteratorLike, ia as NonEmptyArray, sa as ReorderedArray } from "./index.mjs";
 
-//#region src/model/guards.d.ts
-type AnyModel<A extends Any> = DeploymentNodeModel<A> | DeployedInstanceModel<A> | DeploymentRelationModel<A> | AnyRelationshipModel<A> | NestedElementOfDeployedInstanceModel<A> | ElementModel<A> | RelationshipModel<A> | LikeC4ViewModel<A> | NodeModel<A> | EdgeModel<A>;
-declare function isDeploymentNodeModel<M extends Any>(model: AnyModel<M>): model is DeploymentNodeModel<M>;
-declare function isDeployedInstanceModel<M extends Any>(model: AnyModel<M>): model is DeployedInstanceModel<M>;
-declare function isDeploymentElementModel<M extends Any>(model: AnyModel<M>): model is DeploymentElementModel<M>;
-declare function isNestedElementOfDeployedInstanceModel<M extends Any>(model: AnyModel<M>): model is NestedElementOfDeployedInstanceModel<M>;
-declare function isDeploymentRelationModel<M extends Any>(x: AnyModel<M>): x is DeploymentRelationModel<M>;
-declare function isRelationModel<M extends Any>(x: AnyModel<M>): x is RelationshipModel<M>;
-declare function isElementModel<M extends Any>(element: AnyModel<M>): element is ElementModel<M>;
-declare function isLikeC4ViewModel<M extends Any>(view: AnyModel<M>): view is LikeC4ViewModel<M>;
-declare function isNodeModel<M extends Any>(node: AnyModel<M>): node is NodeModel<M>;
-declare function isEdgeModel<M extends Any>(edge: AnyModel<M>): edge is EdgeModel<M>;
+//#region src/utils/invariant.d.ts
+declare function nonNullable<T>(value: T, message?: string | (() => string)): NonNullable<T>;
+declare function invariant(condition: any, message?: string): asserts condition;
+declare function nonexhaustive(value: never): never;
 //#endregion
-//#region src/model/utils/view-title-path.d.ts
-declare const VIEW_FOLDERS_SEPARATOR = "/";
+//#region src/utils/common-head.d.ts
 /**
- * Normalizes view path by removing spaces from segments, removing empty segments,
- * and removing leading/trailing slashes
+ * Common head of two arrays
+ *
+ * @param equals - Equality function, defaults to `Object.is`
+ */
+declare function commonHead<T>(sources: ReadonlyArray<T>, targets: ReadonlyArray<T>, equals?: (a: T, b: T) => boolean): T[];
+//#endregion
+//#region src/utils/compare-natural.d.ts
+declare function compareNatural(a: string | undefined, b: string | undefined): -1 | 0 | 1;
+declare function sortNatural(): <T extends IterableContainer<string>>(elements: T) => ReorderedArray<T>;
+declare function sortNatural<T extends IterableContainer<string>>(elements: T): ReorderedArray<T>;
+/**
+ * Compares two strings lexicographically first, then hierarchically based on their depth.\
+ * From parent nodes to leaves
+ *
+ * @example
+ * const lines = [
+ *   'b.c',
+ *   'b',
+ *   'a.b.c',
+ * ]
+ * lines.sort(compareNaturalHierarchically('.'))
+ * // [
+ * //   'a.b.c',
+ * //   'b',
+ * //   'b.c',
+ * // ]
+ */
+declare function compareNaturalHierarchically(separator?: string, deepestFirst?: boolean): (a: string | undefined, b: string | undefined) => number;
+//#endregion
+//#region src/utils/fqn.d.ts
+declare function parentFqn<E extends string>(fqn: E): E | null;
+declare function nameFromFqn<E extends string>(fqn: E): string;
+/**
+ * Check if one element is an ancestor of another
+ * Composable version
+ * @signature
+ *  isAncestor(another)(ancestor)
+ */
+declare function isAncestor<A extends string | {
+  id: string;
+}>(another: NoInfer<A>): (ancestor: A) => boolean;
+/**
+ * Check if one element is an ancestor of another
+ * @signature
+ *   isAncestor(ancestor, another)
+ */
+declare function isAncestor<A extends string | {
+  id: string;
+}>(ancestor: A, another: A): boolean;
+declare function isSameHierarchy<T extends string>(one: NoInfer<T> | WithId<NoInfer<T>>): (another: T | WithId<T>) => boolean;
+declare function isSameHierarchy<T extends string>(one: T | WithId<T>, another: T | WithId<T>): boolean;
+type WithId<T = string> = {
+  id: T;
+};
+declare function isDescendantOf<T extends string>(ancestor: WithId<T>): (descedant: WithId<T>) => boolean;
+declare function isDescendantOf<T extends string>(descedant: WithId<T>, ancestor: WithId<T>): boolean;
+/**
+ * How deep in the hierarchy the element is.
+ * Root element has depth 1
+ */
+declare function hierarchyLevel<E extends string | {
+  id: Fqn;
+}>(elementOfFqn: E): number;
+/**
+ * Calculate the distance as number of steps from one element to another, i.e.
+ * going up to the common ancestor, then going down to the other element.
+ * Sibling distance is always 1
+ *
+ * Can be used for hierarchical clustering
+ */
+declare function hierarchyDistance<E extends string | {
+  id: Fqn;
+}>(one: E, another: E): number;
+declare function commonAncestor<E extends string>(first: E, second: E): E | null;
+/**
+ * Get all ancestor elements (i.e. parent, parent’s parent, etc.)
+ * going up from parent to the root
  * @example
- * normalizeViewPath('One / Tw o / Thre e') === 'One/Tw o/Thre e'
+ * ```ts
+ * ancestorsFqn('a.b.c.d')
+ * // ['a.b.c', 'a.b', 'a']
+ * ```
+ */
+declare function ancestorsFqn<Id extends string>(fqn: Id): Id[];
+/**
+ * Compares two fully qualified names (fqns) hierarchically based on their depth.
+ * From parent nodes to leaves
+ *
+ * @param {string} a - The first fqn to compare.
+ * @param {string} b - The second fqn to compare.
+ * @returns {number} - 0 if the fqns have the same depth.
+ *                    - Positive number if a is deeper than b.
+ *                    - Negative number if b is deeper than a.
  */
-declare const normalizeViewPath: (title: string) => string;
+declare function compareFqnHierarchically<T extends string = string>(a: T, b: T): -1 | 0 | 1;
+declare function compareByFqnHierarchically<T extends {
+  id: string;
+}>(a: T, b: T): -1 | 0 | 1;
 /**
- * Returns view group path if it is used as a path
- * Returns empty string if it is not a path
+ * Sorts an array of objects hierarchically based on their fully qualified names (FQN).
+ * Objects are sorted by the number of segments in their FQN (defined by dot-separated ID).
+ *
+ * @typeParam T - Object type that contains an 'id' string property
+ * @typeParam A - Type extending IterableContainer of T
+ *
+ * @param array - Array of objects to be sorted
+ * @returns A new array with items sorted by their FQN hierarchy depth (number of segments)
+ *
  * @example
- * getViewFolderPath('One / Tw o / Thre e') === 'One/Tw o'
- * getViewFolderPath('One') === ''
+ * ```ts
+ * const items = [
+ *   { id: "a.b.c" },
+ *   { id: "a" },
+ *   { id: "a.b" }
+ * ];
+ * sortByFqnHierarchically(items);
+ * // Result: [
+ * //   { id: "a" },
+ * //   { id: "a.b" },
+ * //   { id: "a.b.c" }
+ * // ]
+ * ```
+ */
+declare function sortByFqnHierarchically<T extends {
+  id: string;
+}, A extends IterableContainer<T>>(array: A): ReorderedArray<A>;
+/**
+ * Keeps initial order of the elements, but ensures that parents are before children
+ *
+ * @example
+ * ```ts
+ * const items = [
+ *   {id: 'a.c'},
+ *   {id: 'a'},
+ *   {id: 'a.b.c'},
+ *   {id: 'a.b'},
+ * ];
+ * sortParentsFirst(items);
+ * // Result: [
+ * //   { id: "a" },
+ * //   { id: "a.c" }, // because of initial order
+ * //   { id: "a.b" },
+ * //   { id: "a.b.c" },
+ * // ]
+ * ```
+ */
+declare function sortParentsFirst<T extends WithId<string>, A extends IterableContainer<T>>(array: A): ReorderedArray<A>;
+/**
+ * Sorts an array of objects naturally by their fully qualified name (FQN) identifier.
+ *
+ * @template T - Type of objects containing an 'id' string property
+ * @template A - Type extending IterableContainer of T
+ *
+ * @param first - Optional. Either the array to sort or the sort direction ('asc'|'desc')
+ * @param sort - Optional. The sort direction ('asc'|'desc'). Defaults to 'asc' if not specified
+ *
+ * @example
+ * // As a function that returns a sorting function
+ * const sorted = sortNaturalByFqn('desc')(myArray);
+ *
+ * // Direct array sorting
+ * const sorted = sortNaturalByFqn(myArray, 'desc');
+ */
+declare function sortNaturalByFqn(sort?: 'asc' | 'desc'): <I extends WithId<string>, A extends IterableContainer<I>>(array: A) => ReorderedArray<A>;
+declare function sortNaturalByFqn<A extends IterableContainer<WithId>>(array: A, sort?: 'asc' | 'desc'): ReorderedArray<A>;
+//#endregion
+//#region src/utils/getOrCreate.d.ts
+declare function getOrCreate<K, V>(map: Map<K, V>, key: K, create: (key: K) => V): V;
+declare function getOrCreate<K extends WeakKey, V>(map: WeakMap<K, V>, key: K, create: (key: K) => V): V;
+//#endregion
+//#region src/utils/iterable/_types.d.ts
+declare function isIterable<T, I extends Iterable<T>>(something: I | unknown): something is Iterable<T>;
+//#endregion
+//#region src/utils/iterable/filter.d.ts
+/**
+ * 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>;
+//#endregion
+//#region src/utils/iterable/find.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/utils/iterable/first.d.ts
+/**
+ * Takes the first N elements from an iterable.
+ * Composable first version of `ifirst`.
+ * @signature
+ *   ifirst(count)(data)
+ */
+declare function ifirst<T>(count: number): (iterable: Iterable<T>) => IteratorLike<T>;
+/**
+ * Takes the first N elements from an iterable.
+ * Data first version of `ifirst`.
+ * @signature
+ *   ifirst(data, count)
+ * @example
+ *   ifirst([1, 2, 3, 4, 5], 3) // => Iterable<[1, 2, 3]>
+ */
+declare function ifirst<T>(iterable: Iterable<T>, count: number): IteratorLike<T>;
+//#endregion
+//#region src/utils/iterable/flat.d.ts
+declare function iflat(): <T>(iterable: Iterable<IteratorLike<T>>) => IteratorLike<T>;
+declare function iflat<T>(iterable: Iterable<IteratorLike<T>>): IteratorLike<T>;
+//#endregion
+//#region src/utils/iterable/flatMap.d.ts
+type FlatMapFunction<T, S> = (item: T) => Iterable<S>;
+/**
+ * Maps an iterable using a mapper function and flattens the result by one level.
+ * Composable first version of `iflatMap`.
+ * @signature
+ *   iflatMap(mapper)(data)
+ */
+declare function iflatMap<T, S>(mapper: FlatMapFunction<T, S>): (iterable: Iterable<T>) => IteratorLike<S>;
+/**
+ * Maps an iterable using a mapper function and flattens the result by one level.
+ * Data first version of `iflatMap`.
+ * @signature
+ *   iflatMap(data, mapper)
+ */
+declare function iflatMap<T, S>(iterable: Iterable<T>, mapper: FlatMapFunction<T, S>): IteratorLike<S>;
+//#endregion
+//#region src/utils/iterable/head.d.ts
+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;
+//#endregion
+//#region src/utils/iterable/map.d.ts
+type MapFunction<T, S> = (item: T) => S;
+/**
+ * Maps an iterable using a mapper function.
+ * Composable first version of `imap`.
+ * @signature
+ *   imap(mapper)(data)
  */
-declare const getViewFolderPath: (title: string) => string | null;
+declare function imap<T, S>(mapper: MapFunction<T, S>): (iterable: Iterable<T>) => IteratorLike<S>;
 /**
- * Returns view title if it is used as a path
+ * 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>;
+//#endregion
+//#region src/utils/iterable/reduce.d.ts
+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;
+//#endregion
+//#region src/utils/iterable/some.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/utils/iterable/to.d.ts
+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>;
+//#endregion
+//#region src/utils/iterable/unique.d.ts
+/**
+ * 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>;
+//#endregion
+//#region src/utils/memoize-prop.d.ts
+/**
+ * Saves the value returned by fn() in a hidden property tag of obj object, so next time memoizeProp() is called,
+ * that value will be returned, and fn won't be called.
+ *
  * @example
- * getViewTitleFromPath('One / Tw o / Thre e') === 'Thre e'
- * getViewTitleFromPath('One') === 'One'
+ * ```ts
+ * class Model {
+ *   // using same Symbol
+ *   get computed1() {
+ *     return memoizeProp(this, Symbol.for('computed1'), () => doOnce())
+ *   }
+ *   // using string
+ *   get computed2() {
+ *     return memoizeProp(this, 'computed2', () => doOnce())
+ *   }
+ *
+ * }
+ * ```
+ */
+declare function memoizeProp<Tag extends symbol | string, Res>(obj: object, tag: Tag, fn: () => Res): Res;
+//#endregion
+//#region src/utils/promises.d.ts
+declare function delay(): Promise<string>;
+declare function delay(ms: number): Promise<string>;
+declare function delay(randomFrom: number, randomTo: number): Promise<string>;
+declare function promiseNextTick(): Promise<void>;
+declare function onNextTick(fn: () => Promise<void> | void): void;
+//#endregion
+//#region src/utils/relations.d.ts
+type RelationshipLike = {
+  source: {
+    id: string;
+  };
+  target: {
+    id: string;
+  };
+};
+/**
+ * Compares two relations hierarchically.
+ * From the most general (implicit) to the most specific (deepest in the tree)
+ */
+declare const compareRelations: <T extends RelationshipLike>(a: T, b: T) => number;
+//#endregion
+//#region src/utils/set.d.ts
+/**
+ * Returns new set as a union of given sets
+ * Keeps order of elements
+ */
+declare function union<T>(...sets: ReadonlySet<T>[]): Set<T>;
+/**
+ * Returns new set as an intersection of all sets
+ * Keeps order from the first set
+ */
+declare function intersection<T>(first: ReadonlySet<T>, ...sets: NonEmptyArray<ReadonlySet<NoInfer<T>>>): Set<T>;
+/**
+ * Returns new set as a difference of two sets (A-B)
+ * Keeps order from the first set
+ */
+declare function difference<T>(a: ReadonlySet<T>, b: ReadonlySet<NoInfer<T>>): Set<T>;
+declare function equals<T>(a: ReadonlySet<T>, b: ReadonlySet<T>): boolean;
+declare function symmetricDifference<T>(a: ReadonlySet<T>, b: ReadonlySet<T>): Set<T>;
+//#endregion
+//#region src/utils/object-hash.d.ts
+declare function objectHash(value: any): string;
+//#endregion
+//#region src/utils/string-hash.d.ts
+/**
+ * @see https://gist.github.com/victor-homyakov/bcb7d7911e4a388b1c810f8c3ce17bcf
+ */
+declare function stringHash(str: string): string;
+//#endregion
+//#region src/utils/markdown/to-html.d.ts
+declare function markdownToHtml(markdown: string): string;
+//#endregion
+//#region src/utils/markdown/to-text.d.ts
+/**
+ * Converts markdown to plain text, removing any markdown formatting.
+ * @param markdown - The markdown to convert.
+ * @returns The plain text.
  */
-declare const extractViewTitleFromPath: (title: string) => string;
+declare function markdownToText(markdown: string): string;
 //#endregion
-export { isDeployedInstanceModel as a, isDeploymentRelationModel as c, isLikeC4ViewModel as d, isNestedElementOfDeployedInstanceModel as f, normalizeViewPath as i, isEdgeModel as l, isRelationModel as m, extractViewTitleFromPath as n, isDeploymentElementModel as o, isNodeModel as p, getViewFolderPath as r, isDeploymentNodeModel as s, VIEW_FOLDERS_SEPARATOR as t, isElementModel as u };
+export { commonAncestor as A, sortByFqnHierarchically as B, iflat as C, isIterable as D, ifilter as E, isAncestor as F, sortNatural as G, sortParentsFirst as H, isDescendantOf as I, nonNullable as J, commonHead as K, isSameHierarchy as L, compareFqnHierarchically as M, hierarchyDistance as N, getOrCreate as O, hierarchyLevel as P, nameFromFqn as R, iflatMap as S, ifind as T, compareNatural as U, sortNaturalByFqn as V, compareNaturalHierarchically as W, nonexhaustive as Y, toSet as _, difference as a, imap as b, symmetricDifference as c, delay as d, onNextTick as f, toArray as g, iunique as h, objectHash as i, compareByFqnHierarchically as j, ancestorsFqn as k, union as l, memoizeProp as m, markdownToHtml as n, equals as o, promiseNextTick as p, invariant as q, stringHash as r, intersection as s, markdownToText as t, compareRelations as u, isome as v, ifirst as w, ihead as x, ireduce as y, parentFqn as z };