@c8y/ngx-components 1024.14.0 → 1024.15.0

package/types/c8y-ngx-components.d.ts

@@ -209,7 +209,11 @@ declare class ApplicationOptions implements ApplicationOptions$1 {
     companyName?: string;
     /** URL template for documentation links (default: `'${docsBaseUrl}${partialUrl}'`). */
     guideHrefTemplate?: string;
-    /** Base URL for documentation links (include `{{ version }}` placeholder, if you want versioned links). */
+    /**
+     * Base URL for documentation links (include `{{ version }}` placeholder, if you want versioned
+     * links). Set it to `null` or to an empty string to hide all documentation links, or to `'/'` to
+     * link to documentation served from the same host as the application.
+     */
     docsBaseUrl?: string;
     /** CSP string to be applied to `index.html` by replacing default values. */
     contentSecurityPolicy?: string;
@@ -2884,6 +2888,25 @@ declare class AssetHierarchyService {
      *          Returns an empty array if the asset is not found or an error occurs.
      */
     getAncestorPaths(assetId: string): Promise<IManagedObject[][]>;
+    /**
+     * Resolves ancestor paths only when the asset has at most one direct parent
+     * (the cheap, common single-path case). Returns null when the asset is directly
+     * assigned to multiple parents — the caller should keep the lazy click-to-load
+     * flow rather than auto-paying the full hierarchy traversal.
+     *
+     * Costs a single `inventory.detail` call to count direct parents; only proceeds
+     * to the heavier `inventory.list` traversal for single-parent assets.
+     *
+     * @param assetId - The ID of the target asset
+     * @returns Ancestor paths (root → asset) for single-parent assets, or `null`
+     *          when the asset has multiple direct parents.
+     */
+    getAncestorPathsForSingleParent(assetId: string): Promise<IManagedObject[][] | null>;
+    /**
+     * Fetches the given parents and walks every path from each root down to the
+     * target asset.
+     */
+    private resolvePathsFromParents;
     /**
      * Gets all parent IDs of a managed object.
      */
@@ -8136,12 +8159,12 @@ declare class BreadcrumbService extends ExtensionPointForPlugins<Breadcrumb> {
     constructor(rootInjector: Injector, router: Router, plugins: PluginsResolveService);
     get state(): Set<Breadcrumb>;
     /**
-     * Adds a new item to the action bar in the header.
+     * Adds a breadcrumb path to the breadcrumb trail.
      * @param item The item to add.
      */
     add(item: Breadcrumb): void;
     /**
-     * Removes an action bar item from the header.
+     * Removes a breadcrumb path from the breadcrumb trail.
      * @param item The item to remove.
      */
     remove(item: Breadcrumb): void;
@@ -8152,6 +8175,18 @@ declare class BreadcrumbService extends ExtensionPointForPlugins<Breadcrumb> {
     selectPreferredByPath(path: string): void;
     sortByPreferredPath(breadcrumbs: Breadcrumb[]): Breadcrumb[];
     protected setupItemsObservable(): Observable<Breadcrumb[]>;
+    /**
+     * Removes breadcrumbs that resolve to the same crumbs. The same factory can be
+     * picked up from more than one injector (e.g. provided directly and via a plugin
+     * module), which would otherwise surface as duplicate paths in the dropdown.
+     * Genuinely distinct paths (a node reachable through different parents) are kept.
+     *
+     * Only fully label-based crumbs are de-duplicated. Crumbs carrying a `component`
+     * or `template` item are always kept: a `Type` or `TemplateRef` has no stable,
+     * comparable identity here (minified differently across bundles, or a fresh
+     * reference per render), so they cannot be reliably matched.
+     */
+    private dedupeByContent;
     static ɵfac: i0.ɵɵFactoryDeclaration<BreadcrumbService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<BreadcrumbService>;
 }
@@ -8272,6 +8307,16 @@ declare class DocsService extends ExtensionPointWithoutStateForPlugins<DocLink>
      */
     readonly DEFAULT_DOCS_BASE_URL = "https://cumulocity.com";
     constructor(options: OptionsService, app: AppStateService, rootInjector: Injector, router: Router, plugins: PluginsResolveService);
+    /**
+     * Indicates whether documentation links should be displayed at all. Setting `docsBaseUrl` to
+     * `null` or to an empty string switches the links off, whereas `'/'` keeps them enabled and
+     * resolves to links relative to the host the application is served from.
+     */
+    isDocsEnabled(): boolean;
+    /**
+     * Returns the base URL for documentation links, or `null` if the links are switched off with
+     * `docsBaseUrl: null`.
+     */
     getBaseUrl(uiVersion?: string | {
         ngx: string;
     }): string;
@@ -8286,6 +8331,10 @@ declare class DocsService extends ExtensionPointWithoutStateForPlugins<DocLink>
         ngx: string;
     }): string;
     get templateStr(): string;
+    /**
+     * Builds a link to a documentation page, or returns `null` if documentation links are switched
+     * off. Absolute links are returned as they are.
+     */
     getUserGuideLink(link: any): any;
     list(): Promise<DocLink[]>;
     get(): DocLink[];
@@ -12067,7 +12116,7 @@ declare class CoreSearchModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<CoreSearchModule>;
 }
 
-declare class BreadcrumbComponent implements Breadcrumb {
+declare class BreadcrumbComponent implements Breadcrumb, AfterViewInit, OnDestroy {
     private breadcrumbService;
     items: BreadcrumbItem[];
     private contentChildItems;
@@ -12098,24 +12147,39 @@ declare class BreadcrumbItemComponent {
      */
     path: string;
     injector: Injector;
-    template: any;
+    template: TemplateRef<unknown>;
     constructor(_injector: EnvironmentInjector);
     static ɵfac: i0.ɵɵFactoryDeclaration<BreadcrumbItemComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<BreadcrumbItemComponent, "c8y-breadcrumb-item", never, { "icon": { "alias": "icon"; "required": false; }; "translate": { "alias": "translate"; "required": false; }; "label": { "alias": "label"; "required": false; }; "path": { "alias": "path"; "required": false; }; "injector": { "alias": "injector"; "required": false; }; }, {}, never, ["*"], true, never>;
 }
 
 declare class BreadcrumbOutletComponent {
-    showAll: boolean;
-    breadcrumbs: Breadcrumb[];
-    dropdownOpen: boolean;
+    readonly breadcrumbs: i0.InputSignal<Breadcrumb[]>;
     readonly GROUP_ICON = "c8y-group";
+    /**
+     * Breadcrumbs that represent a fully resolved path (every crumb has a label).
+     * The group breadcrumb factory also emits an un-resolved breadcrumb that carries
+     * a component placeholder (the "…" ellipsis) instead of labels; that one is not a
+     * real alternate path and must not count towards the dropdown.
+     */
+    protected readonly resolvedBreadcrumbs: i0.Signal<Breadcrumb[]>;
+    /**
+     * The breadcrumb shown inline. Prefers a resolved path; falls back to the first
+     * breadcrumb (the ellipsis breadcrumb) while ancestors are not loaded yet.
+     */
+    protected readonly inlineBreadcrumb: i0.Signal<Breadcrumb>;
+    /** Resolved breadcrumbs other than the inline one — these populate the dropdown. */
+    protected readonly alternateBreadcrumbs: i0.Signal<Breadcrumb[]>;
+    /** The toggle is only relevant when the node belongs to more than one path. */
+    protected readonly showToggle: i0.Signal<boolean>;
+    protected readonly dropdownOpen: i0.Signal<boolean>;
     /**
      * For upgrade only. Old angularjs routes start with hash, new ones not.
      */
-    normalizePath(path: any): any;
-    ngOnChanges(): void;
+    normalizePath(path: string | undefined): string;
+    private isResolvedPath;
     static ɵfac: i0.ɵɵFactoryDeclaration<BreadcrumbOutletComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<BreadcrumbOutletComponent, "c8y-breadcrumb-outlet", never, { "breadcrumbs": { "alias": "breadcrumbs"; "required": false; }; "dropdownOpen": { "alias": "dropdownOpen"; "required": false; }; }, {}, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<BreadcrumbOutletComponent, "c8y-breadcrumb-outlet", never, { "breadcrumbs": { "alias": "breadcrumbs"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 /**
@@ -16954,22 +17018,26 @@ declare class LegalNoticesOutletModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<LegalNoticesOutletModule>;
 }
 
-declare class GuideHrefDirective {
+declare class GuideHrefDirective implements OnChanges {
     private elementRef;
+    private docsService;
     c8yGuideHref: any;
     private htmlAnchor;
-    set baseHref(href: any);
-    constructor(elementRef: ElementRef);
+    constructor(elementRef: ElementRef, docsService: DocsService);
+    ngOnChanges(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GuideHrefDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<GuideHrefDirective, "[c8y-guide-href]", never, { "c8yGuideHref": { "alias": "c8y-guide-href"; "required": false; }; }, {}, never, never, true, never>;
 }
 
-declare class GuideDocsComponent implements OnInit, AfterContentInit, OnDestroy {
+declare class GuideDocsComponent implements AfterContentInit, OnDestroy {
     private docs;
     private el;
     private renderer;
-    baseUrl: string;
-    links: QueryList<GuideHrefDirective>;
+    /**
+     * Whether the projected content should be displayed. It only becomes `true` once the anchor
+     * attributes have been resolved, and stays `false` if documentation links are switched off.
+     */
+    protected ready: boolean;
     /**
      * Provides access to translate directive, so it is possible to adjust anchor html tags, after
      * content is translated.
@@ -16979,7 +17047,6 @@ declare class GuideDocsComponent implements OnInit, AfterContentInit, OnDestroy
     set translateDirective(value: C8yTranslateDirective);
     private destroyed$;
     constructor(docs: DocsService, el: ElementRef, renderer: Renderer2, translateDirective: C8yTranslateDirective);
-    ngOnInit(): void;
     /**
      * After content is initialized we subscribe for translation events, then we are able to modify
      * anchor just as C8yGuideHrefDirective does.
@@ -16995,7 +17062,7 @@ declare class GuideDocsComponent implements OnInit, AfterContentInit, OnDestroy
     findGuideAnchors(el: HTMLElement): HTMLElement[];
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GuideDocsComponent, [null, null, null, { optional: true; }]>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<GuideDocsComponent, "[c8y-guide-docs]", never, {}, {}, ["translateDirective", "links"], ["*"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<GuideDocsComponent, "[c8y-guide-docs]", never, {}, {}, ["translateDirective"], ["*"], true, never>;
 }
 
 declare class DocsModule {