@likec4/core 1.34.1 → 1.35.0

package/dist/shared/{core.DrS4Bf4y.d.mts → core.SciGxb--.d.mts}

@@ -1,9 +1,9 @@
-import { A as Any, R as RelationKind, T as Tags, h as Metadata, j as MetadataKey, L as LooseTag, F as Fqn, g as ElementId, k as ElementKind, D as DeploymentKind, E as ExtractOnStage, l as RelationId$1, f as _type, m as StrictViewId, n as LooseElementId, o as LooseDeploymentId, p as DeploymentFqn, t as toComputed, q as toLayouted, r as Stage, s as DeploymentId, U as Unknown, V as ViewId, u as Tag, v as toParsed, P as ProjectId$1, w as LooseViewId, a as Aux, S as SpecAux, d as UnknownParsed, b as UnknownComputed, c as UnknownLayouted } from './core.DAj3LuFH.mjs';
+import { A as Any, R as RelationKind, T as Tags, h as Metadata, j as MetadataKey, L as LooseTag, F as Fqn, g as ElementId, k as ElementKind, D as DeploymentKind, E as ExtractOnStage, l as RelationId$1, m as StrictViewId, f as _type, n as LooseElementId, o as LooseDeploymentId, p as DeploymentFqn, t as toComputed, q as toLayouted, r as Stage, s as DeploymentId, U as Unknown, V as ViewId, u as Tag, v as toParsed, P as ProjectId$1, w as LooseViewId, a as Aux, S as SpecAux, d as UnknownParsed, b as UnknownComputed, c as UnknownLayouted } from './core.DAj3LuFH.mjs';
 import { D as DefaultMap } from './core.CywrQs86.mjs';
 import { SetRequired } from 'type-fest';
 import { d as RelationId, P as ProjectId, a as IconUrl, N as NodeId, G as GroupElementKind, j as EdgeId, k as StepEdgeId, V as ViewId$1 } from './core.668kXpZq.mjs';
-import { b as RichTextOrEmpty, Y as Relationship, Q as Element, O as ElementStyle, as as ViewWithType, ao as ComputedView, am as LayoutedView, n as ParsedLikeC4ModelData, C as ComputedLikeC4ModelData, L as LayoutedLikeC4ModelData, f as FqnRef, q as DeployedInstance, D as DeploymentElementStyle, v as DeploymentRelationship, r as DeploymentElement, p as DeploymentNode, y as LikeC4ModelDump, z as AuxFromDump, a2 as Specification, m as ModelGlobals, ah as WhereOperator } from './core.IWLie-Ma.mjs';
-import { I as IteratorLike, L as Link } from './core.DuSLYTG6.mjs';
+import { b as RichTextOrEmpty, Y as Relationship, Q as Element, O as ElementStyle, as as ViewWithType, ao as ComputedView, am as LayoutedView, n as ParsedLikeC4ModelData, C as ComputedLikeC4ModelData, L as LayoutedLikeC4ModelData, f as FqnRef, q as DeployedInstance, D as DeploymentElementStyle, v as DeploymentRelationship, r as DeploymentElement, p as DeploymentNode, y as LikeC4ModelDump, z as AuxFromDump, a2 as Specification, m as ModelGlobals, ah as WhereOperator } from './core.Ddua-wiI.mjs';
+import { I as IteratorLike, L as Link, N as NonEmptyArray } from './core.DuSLYTG6.mjs';
 import { i as Color, R as RelationshipLineType, c as ElementShape } from './core.CzdwsPmY.mjs';
 
 type RelationshipsIterator<A extends Any> = IteratorLike<RelationshipModel<A>>;
@@ -268,6 +268,80 @@ declare namespace EdgeModel {
     }
 }
 
+declare class LikeC4ViewsFolder<A extends Any = Any> {
+    readonly $model: LikeC4Model<A>;
+    /**
+     * Path to this view folder, processed by {@link normalizeViewPath}
+     *
+     * @example
+     * "Folder 1/Folder 2/Folder 3"
+     */
+    readonly path: string;
+    /**
+     * Title of this view folder.
+     *
+     * @example
+     * // title is the last segment of the path
+     * path = "Folder 1/Folder 2/Folder 3"
+     * title = "Folder 3"
+     */
+    readonly title: string;
+    /**
+     * Whether this is the root view folder.
+     *
+     * !NOTE
+     * Root folder is special folder with an empty path and used only for internal purposes. \
+     * It is not visible to the user and should not be used in the code.
+     */
+    readonly isRoot: boolean;
+    protected readonly parentPath: string | undefined;
+    protected readonly defaultViewId: StrictViewId<A> | undefined;
+    constructor($model: LikeC4Model<A>, path: NonEmptyArray<string>, defaultViewId: StrictViewId<A> | undefined);
+    /**
+     * Default view of this view folder.\
+     * It is for the case when there is a view at the same path as this folder.\
+     * (if there are multiple views at the same path, the first one is chosen)
+     *
+     * @example
+     * ```
+     * // Assume the following views exist:
+     * const views = [
+     *   "Folder 1/ Folder 2 / View",
+     *   "Folder 1/ Folder 2 / View / Subview",
+     * ]
+     * ```
+     * Group with path `Folder 1/ Folder 2 / View`\
+     * will have default view `Folder 1/ Folder 2 / View`
+     */
+    get defaultView(): LikeC4ViewModel<A> | null;
+    /**
+     * Returns path to this view folder as an array of ancestors (excluding root) and this view folder as the last element
+     *
+     * @throws Error if this is the root folder.
+     */
+    get breadcrumbs(): [...LikeC4ViewsFolder<A>[], this];
+    /**
+     * Returns parent folder
+     *
+     * @throws Error if this is the root folder.
+     */
+    get parent(): LikeC4ViewsFolder<A> | null;
+    /**
+     * Returns sorted set of children
+     * - First folders
+     * - Then views
+     */
+    get children(): ReadonlySet<LikeC4ViewsFolder<A> | LikeC4ViewModel<A>>;
+    /**
+     * Returns sorted array of children folders
+     */
+    get folders(): ReadonlyArray<LikeC4ViewsFolder<A>>;
+    /**
+     * Returns all views in this view folder.
+     */
+    get views(): ReadonlyArray<LikeC4ViewModel<A>>;
+}
+
 type ViewsIterator<A extends Any, V extends $View<A> = $View<A>> = IteratorLike<LikeC4ViewModel<A, V>>;
 declare class LikeC4ViewModel<A extends Any = Any, V extends $View<A> = $View<A>> implements WithTags<A> {
     #private;
@@ -277,10 +351,44 @@ declare class LikeC4ViewModel<A extends Any = Any, V extends $View<A> = $View<A>
     readonly Aux: A;
     readonly $view: V;
     readonly $model: LikeC4Model<A>;
-    constructor(model: LikeC4Model<A>, view: V);
+    readonly title: string | null;
+    /**
+     * View folder this view belongs to.
+     * If view is top-level, this is the root folder.
+     */
+    readonly folder: LikeC4ViewsFolder<A>;
+    /**
+     * Path to this view, processed by {@link normalizeViewPath}
+     *
+     * @example
+     * "Group 1/Group 2/View"
+     */
+    readonly viewPath: string;
+    constructor(model: LikeC4Model<A>, view: V, folder: LikeC4ViewsFolder<A>);
     get _type(): V[_type];
     get id(): StrictViewId<A>;
-    get title(): string | null;
+    /**
+     * Returns title if defined, otherwise returns its {@link id}
+     */
+    get titleOrId(): string;
+    /**
+     * Returns title if defined, otherwise returns `Untitled`.
+     */
+    get titleOrUntitled(): string;
+    /**
+     * Returns path to this view as an array of groups and this view as the last element
+     * If view is top-level, returns only this view.
+     *
+     * @example
+     * viewPath = "Group 1/Group 2/View"
+     *
+     * breadcrumbs = [
+     *   "Group 1",             // folder
+     *   "Group 1/Group 2",     // folder
+     *   "Group 1/Group 2/View" // view
+     * ]
+     */
+    get breadcrumbs(): [...LikeC4ViewsFolder<A>[], this];
     get description(): RichTextOrEmpty;
     get tags(): Tags<A>;
     get links(): ReadonlyArray<Link>;
@@ -715,7 +823,10 @@ declare class LikeC4Model<A extends Any = Unknown> {
     protected readonly _outgoing: DefaultMap<Fqn<A>, Set<RelationshipModel<A>>>;
     protected readonly _internal: DefaultMap<Fqn<A>, Set<RelationshipModel<A>>>;
     protected readonly _views: Map<ViewId<A>, LikeC4ViewModel<A, $View<A>>>;
-    protected readonly _allTags: DefaultMap<Tag<A>, Set<ElementModel<A> | LikeC4ViewModel<A, $View<A>> | RelationshipModel<A>>>;
+    protected readonly _rootViewFolder: LikeC4ViewsFolder<A>;
+    protected readonly _viewFolders: Map<string, LikeC4ViewsFolder<A>>;
+    protected readonly _viewFolderItems: DefaultMap<string, Set<LikeC4ViewModel<A, $View<A>> | LikeC4ViewsFolder<A>>>;
+    protected readonly _allTags: DefaultMap<Tag<A>, Set<LikeC4ViewModel<A, $View<A>> | ElementModel<A> | RelationshipModel<A>>>;
     static fromParsed<T extends Any>(model: ParsedLikeC4ModelData<T>): LikeC4Model.Parsed<T>;
     /**
      * Creates a new LikeC4Model instance from the provided model data.
@@ -777,7 +888,31 @@ declare class LikeC4Model<A extends Any = Unknown> {
     get projectId(): ProjectId$1<A>;
     get specification(): Specification<A>;
     get globals(): ModelGlobals;
+    /**
+     * Returns the element with the given FQN.
+     *
+     * @throws Error if element is not found\
+     * Use {@link findElement} if you don't want to throw an error
+     *
+     * @note Method is type-safe for typed model
+  
+     * @example
+     * model.element('cloud.frontend')
+     * // or object with id property of scalar.Fqn
+     * model.element({
+     *   id: 'dashboard',
+     * })
+     */
     element(el: ElementOrFqn<A>): ElementModel<A>;
+    /**
+     * Returns the element with the given FQN.
+     *
+     * @returns Element if found, null otherwise
+     * @note Method is not type-safe as {@link element}
+     *
+     * @example
+     * model.findElement('cloud.frontend')
+     */
     findElement(el: LooseElementId<A>): ElementModel<A> | null;
     /**
      * Returns the root elements of the model.
@@ -808,11 +943,50 @@ declare class LikeC4Model<A extends Any = Unknown> {
     views(): IteratorLike<LikeC4ViewModel<A, $View<A>>>;
     /**
      * Returns a specific view by its ID.
+     * @note Method is type-safe for typed model
+     * @throws Error if view is not found\
+     * Use {@link findView} if you don't want to throw an error
+     *
+     * @example
+     * model.view('index')
+     * // or object with id property of scalar.ViewId
+     * model.view({
+     *   id: 'index',
+     * })
      */
     view(viewId: ViewId<A> | {
         id: ViewId$1<ViewId<A>>;
     }): LikeC4ViewModel<A, $View<A>>;
+    /**
+     * Returns a specific view by its ID.
+     * @note Method is not type-safe as {@link view}
+     *
+     * @example
+     * model.findView('index')
+     */
     findView(viewId: LooseViewId<A>): LikeC4ViewModel<A, $View<A>> | null;
+    /**
+     * Returns a view folder by its path.
+     * Path is extracted from the view title, e.g. "Group 1/Group 2/View" -> "Group 1/Group 2"
+     * @throws Error if view folder is not found.
+     */
+    viewFolder(path: string): LikeC4ViewsFolder<A>;
+    /**
+     * Root folder is a special one with an empty path and used only for internal purposes.
+     * It is not visible to the user and should be used only to get top-level folders and views.
+     */
+    get rootViewFolder(): LikeC4ViewsFolder<A>;
+    /**
+     * Whether the model has any view folders.
+     */
+    get hasViewFolders(): boolean;
+    /**
+     * Returns all children of a view folder.
+     * Path is extracted from the view title, e.g. "Group 1/Group 2/View" -> "Group 1/Group 2"
+     *
+     * @throws Error if view folder is not found.
+     */
+    viewFolderItems(path: string): ReadonlySet<LikeC4ViewsFolder<A> | LikeC4ViewModel<A>>;
     /**
      * Returns the parent element of given element.
      * @see ancestors
@@ -847,7 +1021,8 @@ declare class LikeC4Model<A extends Any = Unknown> {
      */
     outgoing(element: ElementOrFqn<A>, filter?: OutgoingFilter): RelationshipsIterator<A>;
     /**
-     * Returns all tags used in the model, sorted alphabetically.
+     * Returns array of all tags used in the model, sorted naturally.\
+     * Use {@link specification.tags} to get all defined tags
      */
     get tags(): Tags<A>;
     /**
@@ -925,4 +1100,4 @@ declare namespace LikeC4Model {
     type AnyRelation<M = Unknown> = M extends Any ? RelationshipModel<M> | DeploymentRelationModel<M> : never;
 }
 
-export { type AnyRelationshipModel as A, DeploymentNodeModel as D, ElementModel as E, type IncomingFilter as I, LikeC4ViewModel as L, NestedElementOfDeployedInstanceModel as N, type OutgoingFilter as O, RelationshipModel as R, type WithMetadata as W, DeployedInstanceModel as a, DeploymentRelationModel as b, NodeModel as c, EdgeModel as d, type DeploymentElementModel as e, type AnyLikeC4Model as f, LikeC4Model as g, type DeploymentRelationEndpoint as h, RelationshipsAccum as i, LikeC4DeploymentModel as j, type DeploymentOrFqn as k, type EdgeOrId as l, type ElementOrFqn as m, type NodeOrId as n, type WithTags as o };
+export { type AnyRelationshipModel as A, DeploymentNodeModel as D, ElementModel as E, type IncomingFilter as I, LikeC4ViewModel as L, NestedElementOfDeployedInstanceModel as N, type OutgoingFilter as O, RelationshipModel as R, type WithMetadata as W, DeployedInstanceModel as a, DeploymentRelationModel as b, NodeModel as c, EdgeModel as d, type DeploymentElementModel as e, type AnyLikeC4Model as f, LikeC4Model as g, type DeploymentRelationEndpoint as h, RelationshipsAccum as i, LikeC4DeploymentModel as j, LikeC4ViewsFolder as k, type DeploymentOrFqn as l, type EdgeOrId as m, type ElementOrFqn as n, type NodeOrId as o, type WithTags as p };

package/dist/shared/{core.BTnf14gD.mjs → core.Y3j3s-oq.mjs}

@@ -1,9 +1,9 @@
-import { c as customInspectSymbol } from './core.C80Z37Eu.mjs';
+import { c as customInspectSymbol } from './core.C1GV0WWV.mjs';
 import { o } from './core.BgvIuGGU.mjs';
 import { a as intersection, b as stringHash, u as union, d as difference, e as equals } from './core.CpwrZi3D.mjs';
 import { u } from './core.DbRvwARP.mjs';
 import { m } from './core.ByrmCl9I.mjs';
-import { j as isDescendantOf, i as isAncestor, q as isString, C, l as sortNaturalByFqn, k as isSameHierarchy } from './core.C_C-3c1S.mjs';
+import { j as isDescendantOf, i as isAncestor, q as isString, C, l as sortNaturalByFqn, k as isSameHierarchy } from './core.DQj9iv_y.mjs';
 import { i as isome } from './core.BoyJPEen.mjs';
 import { i as ifilter } from './core.BH9nN-_I.mjs';
 import { i as invariant } from './core.D4npX2q8.mjs';

package/dist/shared/{core.XptQjhMA.mjs → core.b2BzqGz0.mjs}

@@ -1,5 +1,5 @@
-import { r as getDefaultExportFromCjs, d as commonAncestor, f as compareFqnHierarchically } from './core.C_C-3c1S.mjs';
-import { r as requireForeach, a as requireIterator } from './core.CtKXPqN_.mjs';
+import { r as getDefaultExportFromCjs, d as commonAncestor, f as compareFqnHierarchically } from './core.DQj9iv_y.mjs';
+import { r as requireForeach, a as requireIterator } from './core.HUONfQfd.mjs';
 
 function o(r,n){let e=Math.ceil(r),t=Math.floor(n);if(t<e)throw new RangeError(`randomInteger: The range [${r.toString()},${n.toString()}] contains no integer`);return Math.floor(Math.random()*(t-e+1)+e)}