@likec4/core 1.19.1 → 1.20.0

package/dist/shared/core.BRuJ3Wzf.d.mts

@@ -0,0 +1,12 @@
+import { L as LikeC4Model, E as ElementModel, R as RelationshipModel } from './core.jy6z2iRn.mjs';
+import { F as Fqn } from './core.D74xkKkG.mjs';
+
+declare function computeRelationshipsView(subjectId: Fqn, likec4model: LikeC4Model): {
+    incomers: Set<ElementModel<LikeC4Model.Any>>;
+    incoming: Set<RelationshipModel<LikeC4Model.Any>>;
+    subjects: Set<ElementModel<LikeC4Model.Any>>;
+    outgoing: Set<RelationshipModel<LikeC4Model.Any>>;
+    outgoers: Set<ElementModel<LikeC4Model.Any>>;
+};
+
+export { computeRelationshipsView as c };

package/dist/shared/{core.BZ9Msq7w.d.mts → core.BdbFkE_p.d.cts}

@@ -1,6 +1,6 @@
 import { IsStringLiteral, LiteralUnion, Simplify, SetRequired } from 'type-fest';
-import { C as ComputedView, L as LikeC4View, a9 as ParsedLikeC4Model, a as ComputedLikeC4Model, bj as ViewId, at as RelationId, be as NodeId, bb as EdgeId, a6 as GenericLikeC4Model, a7 as LayoutedLikeC4Model, b4 as DiagramView, a8 as LikeC4ModelDump, f as DeploymentNodeKind, aX as ComputedDynamicView, bg as StepEdgeId, aZ as ComputedElementView, aW as ComputedDeploymentView, as as ModelRelation, a5 as AnyParsedLikeC4Model, a4 as ModelGlobals, h as DeploymentRef, d as DeploymentNode, b as DeployedInstance, c as DeploymentElementStyle, i as DeploymentRelation } from './core.CmYMqgha.mjs';
-import { F as Fqn, K as KeysOf, f as ElementKind, l as ElementShape, s as Color, o as Tag, n as Link, a as IteratorLike, x as ThemeColor, i as Element } from './core.D74xkKkG.mjs';
+import { C as ComputedView, L as LikeC4View, a9 as ParsedLikeC4Model, a as ComputedLikeC4Model, bk as ViewId, au as RelationId, bf as NodeId, bc as EdgeId, a6 as GenericLikeC4Model, a7 as LayoutedLikeC4Model, b5 as DiagramView, a8 as LikeC4ModelDump, f as DeploymentNodeKind, aY as ComputedDynamicView, bh as StepEdgeId, a_ as ComputedElementView, aX as ComputedDeploymentView, at as ModelRelation, a5 as AnyParsedLikeC4Model, a4 as ModelGlobals, h as DeploymentRef, d as DeploymentNode, b as DeployedInstance, c as DeploymentElementStyle, i as DeploymentRelation, aw as RelationshipKind } from './core.B72vUaNB.cjs';
+import { F as Fqn, K as KeysOf, f as ElementKind, l as ElementShape, s as Color, I as IconUrl, o as Tag, n as Link, a as IteratorLike, x as ThemeColor, i as Element } from './core.D74xkKkG.cjs';
 
 type ComputeViewResult<V extends ComputedView = ComputedView> = {
     isSuccess: true;
@@ -90,6 +90,7 @@ declare class NodeModel<M extends AnyAux, V extends ComputedView | DiagramView =
     get deployment(): DeploymentElementModel<M> | null;
     get shape(): ElementShape;
     get color(): Color;
+    get icon(): IconUrl | null;
     get tags(): ReadonlyArray<Tag>;
     get links(): ReadonlyArray<Link>;
     get navigateTo(): LikeC4ViewModel<M> | null;
@@ -185,6 +186,7 @@ declare class LikeC4ViewModel<M extends AnyAux, V extends ComputedView | Diagram
      * Find node by id.
      */
     findNode(node: M['NodeOrId']): NodeModel<M, V> | null;
+    findNodeWithElement(fqn: M['Element']): NodeModel.WithElement<M, V> | null;
     /**
      * Iterate over all nodes.
      */
@@ -240,11 +242,13 @@ declare class RelationshipModel<M extends AnyAux = AnyAux> {
     get description(): string | null;
     get navigateTo(): LikeC4ViewModel<M> | null;
     get tags(): ReadonlyArray<Tag>;
+    get kind(): string | null;
     get links(): ReadonlyArray<Link>;
     /**
      * Iterate over all views that include this relationship.
      */
     views(): ViewsIterator<M>;
+    isDeploymentRelation(): this is DeploymentRelationModel<M>;
 }
 
 declare class LikeC4Model<M extends AnyAux = LikeC4Model.Any> {
@@ -325,7 +329,7 @@ declare class LikeC4Model<M extends AnyAux = LikeC4Model.Any> {
      * Returns a specific view by its ID.
      */
     view(viewId: M['View']): LikeC4ViewModel<M>;
-    findView(viewId: M['View']): LikeC4ViewModel<M>;
+    findView(viewId: M['View']): LikeC4ViewModel<M> | null;
     /**
      * Returns the parent element of given element.
      * @see ancestors
@@ -474,6 +478,7 @@ declare abstract class AbstractDeploymentElementModel<M extends AnyAux = AnyAux>
     get shape(): ElementShape;
     get color(): ThemeColor;
     get tags(): ReadonlyArray<Tag>;
+    get kind(): DeploymentNodeKind | string | null;
     get description(): string | null;
     get technology(): string | null;
     get links(): ReadonlyArray<Link>;
@@ -574,6 +579,7 @@ declare class DeployedInstanceModel<M extends AnyAux = AnyAux> extends AbstractD
     get shape(): ElementShape;
     get color(): ThemeColor;
     get tags(): ReadonlyArray<Tag>;
+    get kind(): string | null;
     get description(): string | null;
     get technology(): string | null;
     get links(): ReadonlyArray<Link>;
@@ -614,9 +620,11 @@ declare class DeploymentRelationModel<M extends AnyAux = AnyAux> {
     get technology(): string | null;
     get description(): string | null;
     get tags(): ReadonlyArray<Tag>;
+    get kind(): RelationshipKind | null;
     get navigateTo(): LikeC4ViewModel<M> | null;
     get links(): ReadonlyArray<Link>;
     views(): IteratorLike<LikeC4ViewModel<M, ComputedDeploymentView>>;
+    isDeploymentRelation(): this is DeploymentRelationModel<M>;
 }
 declare class RelationshipsAccum<M extends AnyAux> {
     readonly model: ReadonlySet<RelationshipModel<M>>;
@@ -656,12 +664,14 @@ declare class ElementModel<M extends AnyAux = AnyAux> {
     get kind(): ElementKind;
     get shape(): ElementShape;
     get color(): ThemeColor;
+    get icon(): IconUrl | null;
     get tags(): ReadonlyArray<Tag>;
     get title(): string;
     get description(): string | null;
     get technology(): string | null;
     get links(): ReadonlyArray<Link>;
     get defaultView(): LikeC4ViewModel<M> | null;
+    get isRoot(): boolean;
     isAncestorOf(another: ElementModel<M>): boolean;
     isDescendantOf(another: ElementModel<M>): boolean;
     /**
@@ -716,4 +726,4 @@ declare class ElementModel<M extends AnyAux = AnyAux> {
     deployments(): DeployedInstancesIterator<M>;
 }
 
-export { type AnyAux as A, type ComputeViewResult as C, type DeploymentElementModel as D, ElementModel as E, LikeC4DeploymentModel as L, NodeModel as N, RelationshipsAccum as R, computeViews as a, Aux as b, computeView as c, LikeC4Model as d, LikeC4ViewModel as e, DeploymentNodeModel as f, DeployedInstanceModel as g, RelationshipModel as h, DeploymentRelationModel as i, EdgeModel as j, unsafeComputeView as u };
+export { type AnyAux as A, type ComputeViewResult as C, type DeploymentElementModel as D, ElementModel as E, LikeC4Model as L, NodeModel as N, RelationshipModel as R, computeViews as a, Aux as b, computeView as c, LikeC4DeploymentModel as d, LikeC4ViewModel as e, DeploymentNodeModel as f, DeployedInstanceModel as g, RelationshipsAccum as h, DeploymentRelationModel as i, EdgeModel as j, unsafeComputeView as u };

package/dist/shared/core.BvdNMbcA.d.cts

@@ -0,0 +1,12 @@
+import { L as LikeC4Model, E as ElementModel, R as RelationshipModel } from './core.BdbFkE_p.cjs';
+import { F as Fqn } from './core.D74xkKkG.cjs';
+
+declare function computeRelationshipsView(subjectId: Fqn, likec4model: LikeC4Model): {
+    incomers: Set<ElementModel<LikeC4Model.Any>>;
+    incoming: Set<RelationshipModel<LikeC4Model.Any>>;
+    subjects: Set<ElementModel<LikeC4Model.Any>>;
+    outgoing: Set<RelationshipModel<LikeC4Model.Any>>;
+    outgoers: Set<ElementModel<LikeC4Model.Any>>;
+};
+
+export { computeRelationshipsView as c };

package/dist/shared/{object_hash.CE_oF3I3.js → core.BxvDITEI.mjs}

@@ -1,11 +1,15 @@
-import { u as u$1, i as invariant } from './chunk-RAAYCPUM.M-JWF7SS.js';
+import { u as u$1, i as invariant } from './core.M-JWF7SS.mjs';
 
-function d(...e){return u$1(a$1,e,o$1)}var a$1=(e,n)=>e.length<n.length?e.map((t,r)=>[t,n[r]]):n.map((t,r)=>[e[r],t]),o$1=e=>(n,t)=>({hasNext:!0,next:[n,e[t]],done:t>=e.length-1});
+function getDefaultExportFromCjs (x) {
+	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+}
 
-var e={done:!0,hasNext:!1},s={done:!1,hasNext:!1},a=()=>e;
+var e={done:!0,hasNext:!1},s={done:!1,hasNext:!1},a$1=()=>e;
 
 function x(t,...o){let n=t,u=o.map(e=>"lazy"in e?f(e):void 0),p=0;for(;p<o.length;){if(u[p]===void 0||!B(n)){let i=o[p];n=i(n),p+=1;continue}let r=[];for(let i=p;i<o.length;i++){let l=u[i];if(l===void 0||(r.push(l),l.isSingle))break}let a=[];for(let i of n)if(A(i,a,r))break;let{isSingle:y}=r.at(-1);n=y?a[0]:a,p+=r.length;}return n}function A(t,o,n){if(n.length===0)return o.push(t),!1;let u=t,p=s,e=!1;for(let[r,a]of n.entries()){let{index:y,items:i}=a;if(i.push(u),p=a(u,y,i),a.index+=1,p.hasNext){if(p.hasMany??!1){for(let l of p.next)if(A(l,o,n.slice(r+1)))return !0;return e}u=p.next;}if(!p.hasNext)break;p.done&&(e=!0);}return p.hasNext&&o.push(u),e}function f(t){let{lazy:o,lazyArgs:n}=t,u=o(...n);return Object.assign(u,{isSingle:o.single??!1,index:0,items:[]})}function B(t){return typeof t=="string"||typeof t=="object"&&t!==null&&Symbol.iterator in t}
 
+function d(...e){return u$1(a,e,o$1)}var a=(e,n)=>e.length<n.length?e.map((t,r)=>[t,n[r]]):n.map((t,r)=>[e[r],t]),o$1=e=>(n,t)=>({hasNext:!0,next:[n,e[t]],done:t>=e.length-1});
+
 function i$1(...e){return u$1(r,e)}var r=(e,t)=>e.length>=t;
 
 function u(...e){return u$1(i,e)}function i(e,a){let n=[];for(let[o,r]of e.entries()){if(!a(r,o,e))break;n.push(r);}return n}
@@ -20,384 +24,6 @@ function l(n){return n!=null}
 
 function n(e){return e!==void 0}
 
-function getDefaultExportFromCjs (x) {
-	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
-}
-
-/**
- * Mnemonist DefaultMap
- * =====================
- *
- * JavaScript implementation of a default map that will return a constructed
- * value any time one tries to access an inexisting key. It's quite similar
- * to python's defaultdict.
- */
-
-var defaultMap;
-var hasRequiredDefaultMap;
-
-function requireDefaultMap () {
-	if (hasRequiredDefaultMap) return defaultMap;
-	hasRequiredDefaultMap = 1;
-	/**
-	 * DefaultMap.
-	 *
-	 * @constructor
-	 */
-	function DefaultMap(factory) {
-	  if (typeof factory !== 'function')
-	    throw new Error('mnemonist/DefaultMap.constructor: expecting a function.');
-
-	  this.items = new Map();
-	  this.factory = factory;
-	  this.size = 0;
-	}
-
-	/**
-	 * Method used to clear the structure.
-	 *
-	 * @return {undefined}
-	 */
-	DefaultMap.prototype.clear = function() {
-
-	  // Properties
-	  this.items.clear();
-	  this.size = 0;
-	};
-
-	/**
-	 * Method used to get the value set for given key. If the key does not exist,
-	 * the value will be created using the provided factory.
-	 *
-	 * @param  {any} key - Target key.
-	 * @return {any}
-	 */
-	DefaultMap.prototype.get = function(key) {
-	  var value = this.items.get(key);
-
-	  if (typeof value === 'undefined') {
-	    value = this.factory(key, this.size);
-	    this.items.set(key, value);
-	    this.size++;
-	  }
-
-	  return value;
-	};
-
-	/**
-	 * Method used to get the value set for given key. If the key does not exist,
-	 * a value won't be created.
-	 *
-	 * @param  {any} key - Target key.
-	 * @return {any}
-	 */
-	DefaultMap.prototype.peek = function(key) {
-	  return this.items.get(key);
-	};
-
-	/**
-	 * Method used to set a value for given key.
-	 *
-	 * @param  {any} key   - Target key.
-	 * @param  {any} value - Value.
-	 * @return {DefaultMap}
-	 */
-	DefaultMap.prototype.set = function(key, value) {
-	  this.items.set(key, value);
-	  this.size = this.items.size;
-
-	  return this;
-	};
-
-	/**
-	 * Method used to test the existence of a key in the map.
-	 *
-	 * @param  {any} key   - Target key.
-	 * @return {boolean}
-	 */
-	DefaultMap.prototype.has = function(key) {
-	  return this.items.has(key);
-	};
-
-	/**
-	 * Method used to delete target key.
-	 *
-	 * @param  {any} key   - Target key.
-	 * @return {boolean}
-	 */
-	DefaultMap.prototype.delete = function(key) {
-	  var deleted = this.items.delete(key);
-
-	  this.size = this.items.size;
-
-	  return deleted;
-	};
-
-	/**
-	 * Method used to iterate over each of the key/value pairs.
-	 *
-	 * @param  {function}  callback - Function to call for each item.
-	 * @param  {object}    scope    - Optional scope.
-	 * @return {undefined}
-	 */
-	DefaultMap.prototype.forEach = function(callback, scope) {
-	  scope = arguments.length > 1 ? scope : this;
-
-	  this.items.forEach(callback, scope);
-	};
-
-	/**
-	 * Iterators.
-	 */
-	DefaultMap.prototype.entries = function() {
-	  return this.items.entries();
-	};
-
-	DefaultMap.prototype.keys = function() {
-	  return this.items.keys();
-	};
-
-	DefaultMap.prototype.values = function() {
-	  return this.items.values();
-	};
-
-	/**
-	 * Attaching the #.entries method to Symbol.iterator if possible.
-	 */
-	if (typeof Symbol !== 'undefined')
-	  DefaultMap.prototype[Symbol.iterator] = DefaultMap.prototype.entries;
-
-	/**
-	 * Convenience known methods.
-	 */
-	DefaultMap.prototype.inspect = function() {
-	  return this.items;
-	};
-
-	if (typeof Symbol !== 'undefined')
-	  DefaultMap.prototype[Symbol.for('nodejs.util.inspect.custom')] = DefaultMap.prototype.inspect;
-
-	/**
-	 * Typical factories.
-	 */
-	DefaultMap.autoIncrement = function() {
-	  var i = 0;
-
-	  return function() {
-	    return i++;
-	  };
-	};
-
-	/**
-	 * Exporting.
-	 */
-	defaultMap = DefaultMap;
-	return defaultMap;
-}
-
-var defaultMapExports = requireDefaultMap();
-const DefaultMap = /*@__PURE__*/getDefaultExportFromCjs(defaultMapExports);
-
-/**
- * Obliterator Iterator Class
- * ===========================
- *
- * Simple class representing the library's iterators.
- */
-
-var iterator;
-var hasRequiredIterator;
-
-function requireIterator () {
-	if (hasRequiredIterator) return iterator;
-	hasRequiredIterator = 1;
-	/**
-	 * Iterator class.
-	 *
-	 * @constructor
-	 * @param {function} next - Next function.
-	 */
-	function Iterator(next) {
-	  if (typeof next !== 'function')
-	    throw new Error('obliterator/iterator: expecting a function!');
-
-	  this.next = next;
-	}
-
-	/**
-	 * If symbols are supported, we add `next` to `Symbol.iterator`.
-	 */
-	if (typeof Symbol !== 'undefined')
-	  Iterator.prototype[Symbol.iterator] = function () {
-	    return this;
-	  };
-
-	/**
-	 * Returning an iterator of the given values.
-	 *
-	 * @param  {any...} values - Values.
-	 * @return {Iterator}
-	 */
-	Iterator.of = function () {
-	  var args = arguments,
-	    l = args.length,
-	    i = 0;
-
-	  return new Iterator(function () {
-	    if (i >= l) return {done: true};
-
-	    return {done: false, value: args[i++]};
-	  });
-	};
-
-	/**
-	 * Returning an empty iterator.
-	 *
-	 * @return {Iterator}
-	 */
-	Iterator.empty = function () {
-	  var iterator = new Iterator(function () {
-	    return {done: true};
-	  });
-
-	  return iterator;
-	};
-
-	/**
-	 * Returning an iterator over the given indexed sequence.
-	 *
-	 * @param  {string|Array} sequence - Target sequence.
-	 * @return {Iterator}
-	 */
-	Iterator.fromSequence = function (sequence) {
-	  var i = 0,
-	    l = sequence.length;
-
-	  return new Iterator(function () {
-	    if (i >= l) return {done: true};
-
-	    return {done: false, value: sequence[i++]};
-	  });
-	};
-
-	/**
-	 * Returning whether the given value is an iterator.
-	 *
-	 * @param  {any} value - Value.
-	 * @return {boolean}
-	 */
-	Iterator.is = function (value) {
-	  if (value instanceof Iterator) return true;
-
-	  return (
-	    typeof value === 'object' &&
-	    value !== null &&
-	    typeof value.next === 'function'
-	  );
-	};
-
-	/**
-	 * Exporting.
-	 */
-	iterator = Iterator;
-	return iterator;
-}
-
-var support = {};
-
-var hasRequiredSupport;
-
-function requireSupport () {
-	if (hasRequiredSupport) return support;
-	hasRequiredSupport = 1;
-	support.ARRAY_BUFFER_SUPPORT = typeof ArrayBuffer !== 'undefined';
-	support.SYMBOL_SUPPORT = typeof Symbol !== 'undefined';
-	return support;
-}
-
-/**
- * Obliterator ForEach Function
- * =============================
- *
- * Helper function used to easily iterate over mixed values.
- */
-
-var foreach;
-var hasRequiredForeach;
-
-function requireForeach () {
-	if (hasRequiredForeach) return foreach;
-	hasRequiredForeach = 1;
-	var support = requireSupport();
-
-	var ARRAY_BUFFER_SUPPORT = support.ARRAY_BUFFER_SUPPORT;
-	var SYMBOL_SUPPORT = support.SYMBOL_SUPPORT;
-
-	/**
-	 * Function able to iterate over almost any iterable JS value.
-	 *
-	 * @param  {any}      iterable - Iterable value.
-	 * @param  {function} callback - Callback function.
-	 */
-	foreach = function forEach(iterable, callback) {
-	  var iterator, k, i, l, s;
-
-	  if (!iterable) throw new Error('obliterator/forEach: invalid iterable.');
-
-	  if (typeof callback !== 'function')
-	    throw new Error('obliterator/forEach: expecting a callback.');
-
-	  // The target is an array or a string or function arguments
-	  if (
-	    Array.isArray(iterable) ||
-	    (ARRAY_BUFFER_SUPPORT && ArrayBuffer.isView(iterable)) ||
-	    typeof iterable === 'string' ||
-	    iterable.toString() === '[object Arguments]'
-	  ) {
-	    for (i = 0, l = iterable.length; i < l; i++) callback(iterable[i], i);
-	    return;
-	  }
-
-	  // The target has a #.forEach method
-	  if (typeof iterable.forEach === 'function') {
-	    iterable.forEach(callback);
-	    return;
-	  }
-
-	  // The target is iterable
-	  if (
-	    SYMBOL_SUPPORT &&
-	    Symbol.iterator in iterable &&
-	    typeof iterable.next !== 'function'
-	  ) {
-	    iterable = iterable[Symbol.iterator]();
-	  }
-
-	  // The target is an iterator
-	  if (typeof iterable.next === 'function') {
-	    iterator = iterable;
-	    i = 0;
-
-	    while (((s = iterator.next()), s.done !== true)) {
-	      callback(s.value, i);
-	      i++;
-	    }
-
-	    return;
-	  }
-
-	  // The target is a plain object
-	  for (k in iterable) {
-	    if (iterable.hasOwnProperty(k)) {
-	      callback(iterable[k], k);
-	    }
-	  }
-
-	  return;
-	};
-	return foreach;
-}
-
 function commonHead(sources, targets, equals) {
   if (sources.length === 0 || targets.length === 0) {
     return [];
@@ -683,6 +309,23 @@ function ifilter(arg1, arg2) {
   return _filter(arg1);
 }
 
+function ifind(arg1, arg2) {
+  const pred = arg2 ?? arg1;
+  invariant(t(pred));
+  function _find(iter) {
+    for (const value of iter) {
+      if (pred(value)) {
+        return value;
+      }
+    }
+    return;
+  }
+  if (!arg2) {
+    return _find;
+  }
+  return _find(arg1);
+}
+
 function iflat(iterable) {
   return iterable ? _iflat(iterable) : _iflat;
 }
@@ -739,13 +382,7 @@ function toSet(iterable) {
 }
 
 function iunique(iterable) {
-  if (iterable) {
-    return function* () {
-      yield* _iunique(iterable);
-      return;
-    }();
-  }
-  return _iunique;
+  return iterable ? _iunique(iterable) : _iunique;
 }
 function* _iunique(iterable) {
   const seen = /* @__PURE__ */ new Set();
@@ -1219,4 +856,4 @@ function requireObject_hash () {
 var object_hashExports = requireObject_hash();
 const objectHash = /*@__PURE__*/getDefaultExportFromCjs(object_hashExports);
 
-export { imap as A, isIterable as B, isome as C, DefaultMap as D, iunique as E, toArray as F, toSet as G, difference as H, equals as I, intersection as J, symmetricDifference as K, union as L, stringHash as M, objectHash as N, x as O, s as P, a as Q, getDefaultExportFromCjs as R, requireForeach as S, requireIterator as T, u as U, d as V, n as W, hasIntersection as X, isSameHierarchy as a, t as b, commonHead as c, compareNatural as d, ancestorsFqn as e, commonAncestor as f, compareByFqnHierarchically as g, compareFqnHierarchically as h, i$1 as i, hierarchyDistance as j, hierarchyLevel as k, l, m, nameFromFqn as n, isAncestor as o, parentFqn as p, isDescendantOf as q, sortNaturalByFqn as r, sortByFqnHierarchically as s, t$1 as t, sortParentsFirst as u, getOrCreate as v, isNonEmptyArray as w, isString as x, ifilter as y, iflat as z };
+export { isString as A, ifilter as B, iflat as C, imap as D, isIterable as E, isome as F, iunique as G, toArray as H, difference as I, equals as J, intersection as K, symmetricDifference as L, union as M, stringHash as N, objectHash as O, x as P, s as Q, a$1 as R, u as S, d as T, n as U, hasIntersection as V, i$1 as a, t$1 as b, isSameHierarchy as c, t as d, commonHead as e, compareNatural as f, getDefaultExportFromCjs as g, ancestorsFqn as h, ifind as i, commonAncestor as j, compareByFqnHierarchically as k, l, m, nameFromFqn as n, compareFqnHierarchically as o, parentFqn as p, hierarchyDistance as q, hierarchyLevel as r, isAncestor as s, toSet as t, isDescendantOf as u, sortByFqnHierarchically as v, sortNaturalByFqn as w, sortParentsFirst as x, getOrCreate as y, isNonEmptyArray as z };

package/dist/shared/core.ByNgh-mC.d.cts

@@ -0,0 +1,127 @@
+import { F as Fqn } from './core.D74xkKkG.cjs';
+
+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> = {
+    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
+ */
+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 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;
+type IterableContainer<T = unknown> = ReadonlyArray<T> | readonly [];
+type ReorderedArray<T extends IterableContainer> = {
+    -readonly [P in keyof T]: T[number];
+};
+/**
+ * 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
+ * ```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
+ */
+declare function sortParentsFirst<T extends {
+    id: 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'): <T extends {
+    id: string;
+}, A extends IterableContainer<T>>(array: A) => ReorderedArray<A>;
+declare function sortNaturalByFqn<T extends {
+    id: string;
+}, A extends IterableContainer<T>>(array: A, sort?: 'asc' | 'desc'): ReorderedArray<A>;
+
+export { type IterableContainer as I, type ReorderedArray as R, ancestorsFqn as a, compareByFqnHierarchically as b, commonAncestor as c, compareFqnHierarchically as d, hierarchyLevel as e, isDescendantOf as f, isSameHierarchy as g, hierarchyDistance as h, isAncestor as i, sortNaturalByFqn as j, sortParentsFirst as k, nameFromFqn as n, parentFqn as p, sortByFqnHierarchically as s };