@c8y/ngx-components 1023.14.203 → 1023.14.206

package/fesm2022/c8y-ngx-components.mjs

@@ -3,7 +3,7 @@ import { Input, Directive, createEnvironmentInjector, InjectionToken, Optional,
 import * as i1$3 from 'ngx-bootstrap/dropdown';
 import { BsDropdownModule, BsDropdownDirective } from 'ngx-bootstrap/dropdown';
 import { CdkTrapFocus, A11yModule } from '@angular/cdk/a11y';
-import { castArray, flatten, uniq, sortBy, groupBy, camelCase, isEqual, isUndefined, throttle as throttle$1, each, mapValues, mapKeys, keys, get, isNaN as isNaN$1, isFinite, forEach, assign, min, every, first, map as map$1, find, negate, upperFirst, memoize as memoize$1, isEmpty, property, some, entries, omitBy, isDate, pick, flatMap, orderBy, filter as filter$2, snakeCase, matches, escape, escapeRegExp, assignWith, set, toNumber, isEqualWith, clone, omit, cloneDeep, uniqBy, has, transform, identity, unset, flow, findIndex as findIndex$1, isNil, chunk, values, union, without, indexOf, kebabCase, forOwn } from 'lodash-es';
+import { castArray, flatten, uniq, sortBy, groupBy, camelCase, isEqual, isUndefined, throttle as throttle$1, each, mapValues, mapKeys, keys, get, isNaN as isNaN$1, isFinite, forEach, assign, min, every, first, map as map$1, find, negate, upperFirst, memoize as memoize$1, isEmpty, property, some, entries, omitBy, isDate, pick, flatMap, orderBy, filter as filter$2, snakeCase, matches, isNil, escape, escapeRegExp, assignWith, set, toNumber, isEqualWith, clone, omit, cloneDeep, uniqBy, has, transform, identity, unset, flow, findIndex as findIndex$1, chunk, values, union, without, indexOf, kebabCase, forOwn } from 'lodash-es';
 import { merge, of, defer, combineLatest, race, isObservable, from, Subject, BehaviorSubject, ReplaySubject, firstValueFrom, lastValueFrom, NEVER, Observable, startWith as startWith$1, filter as filter$1, tap as tap$1, mergeMap, fromEvent, pipe, throwError, concat, map as map$2, fromEventPattern, withLatestFrom, distinctUntilChanged as distinctUntilChanged$1, takeUntil as takeUntil$1, catchError as catchError$1, empty, timer, forkJoin, interval, shareReplay as shareReplay$1, switchMap as switchMap$1 } from 'rxjs';
 import { map, distinctUntilChanged, filter, startWith, switchMap, shareReplay, take, scan, takeUntil, tap, catchError, debounceTime, share, first as first$1, retryWhen, delay, concatMap, debounce, sample, withLatestFrom as withLatestFrom$1, mergeMap as mergeMap$1, every as every$1, toArray, merge as merge$1, expand, mapTo, skip, reduce, finalize, combineLatestWith } from 'rxjs/operators';
 import * as i1 from '@c8y/client';
@@ -13294,8 +13294,24 @@ class DocsService extends ExtensionPointWithoutStateForPlugins {
         this.DEFAULT_DOCS_BASE_URL = 'https://cumulocity.com';
         this.items$ = this.setupItemsObservable();
     }
+    /**
+     * 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() {
+        const docsBaseUrl = this.options.get('docsBaseUrl', this.DEFAULT_DOCS_BASE_URL);
+        return !isNil(docsBaseUrl) && docsBaseUrl !== '';
+    }
+    /**
+     * Returns the base URL for documentation links, or `null` if the links are switched off with
+     * `docsBaseUrl: null`.
+     */
     getBaseUrl(uiVersion) {
         const docsBaseUrl = this.options.get('docsBaseUrl', this.DEFAULT_DOCS_BASE_URL);
+        if (isNil(docsBaseUrl)) {
+            return null;
+        }
         return this.getUrlWithDocsVersion(docsBaseUrl, uiVersion);
     }
     /**
@@ -13316,11 +13332,15 @@ class DocsService extends ExtensionPointWithoutStateForPlugins {
     get templateStr() {
         return this.options.get('guideHrefTemplate', '${docsBaseUrl}${partialUrl}');
     }
+    /**
+     * 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) {
         if (/^https?:/.test(link)) {
             return link;
         }
-        if (this.getBaseUrl === null) {
+        if (!this.isDocsEnabled()) {
             return null;
         }
         return this.getLink(this.templateStr, link);
@@ -13337,7 +13357,7 @@ class DocsService extends ExtensionPointWithoutStateForPlugins {
             ? []
             : documentationItems
                 .map((item) => ({ ...item, url: this.getUserGuideLink(item.url) }))
-                .filter(({ url }) => !excludeDefault.some(e => new RegExp(e).test(url)));
+                .filter(({ url }) => !!url && !excludeDefault.some(e => new RegExp(e).test(url)));
         if (links) {
             // backwards compatibility
             links.map((lnk) => {
@@ -25806,19 +25826,26 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImpo
         }], ctorParameters: () => [{ type: RouterService }] });
 
 class GuideHrefDirective {
-    set baseHref(href) {
-        this.htmlAnchor.href = `${href}/${this.c8yGuideHref}`;
-    }
-    constructor(elementRef) {
+    constructor(elementRef, docsService) {
         this.elementRef = elementRef;
+        this.docsService = docsService;
         this.htmlAnchor = this.elementRef.nativeElement;
         if (!this.htmlAnchor.hasAttribute('target')) {
             this.htmlAnchor.setAttribute('target', '_blank');
             this.htmlAnchor.setAttribute('rel', 'noopener noreferrer');
         }
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: GuideHrefDirective, deps: [{ token: i0.ElementRef }], target: i0.ɵɵFactoryTarget.Directive }); }
-    static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "20.3.25", type: GuideHrefDirective, isStandalone: true, selector: "[c8y-guide-href]", inputs: { c8yGuideHref: ["c8y-guide-href", "c8yGuideHref"] }, ngImport: i0 }); }
+    ngOnChanges() {
+        const guideHref = this.docsService.getUserGuideLink(this.c8yGuideHref);
+        if (!guideHref) {
+            // documentation links are switched off, or no link can be built from `guideHrefTemplate`
+            this.htmlAnchor.removeAttribute('href');
+            return;
+        }
+        this.htmlAnchor.href = guideHref;
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: GuideHrefDirective, deps: [{ token: i0.ElementRef }, { token: DocsService }], target: i0.ɵɵFactoryTarget.Directive }); }
+    static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "20.3.25", type: GuideHrefDirective, isStandalone: true, selector: "[c8y-guide-href]", inputs: { c8yGuideHref: ["c8y-guide-href", "c8yGuideHref"] }, usesOnChanges: true, ngImport: i0 }); }
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: GuideHrefDirective, decorators: [{
             type: Directive,
@@ -25826,7 +25853,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImpo
                     selector: '[c8y-guide-href]',
                     standalone: true
                 }]
-        }], ctorParameters: () => [{ type: i0.ElementRef }], propDecorators: { c8yGuideHref: [{
+        }], ctorParameters: () => [{ type: i0.ElementRef }, { type: DocsService }], propDecorators: { c8yGuideHref: [{
                 type: Input,
                 args: ['c8y-guide-href']
             }] } });
@@ -25845,12 +25872,14 @@ class GuideDocsComponent {
         this.docs = docs;
         this.el = el;
         this.renderer = renderer;
+        /**
+         * 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.
+         */
+        this.ready = false;
         this.destroyed$ = new ReplaySubject(1);
         this.translateDirective = translateDirective;
     }
-    ngOnInit() {
-        this.baseUrl = this.docs.getBaseUrl();
-    }
     /**
      * After content is initialized we subscribe for translation events, then we are able to modify
      * anchor just as C8yGuideHrefDirective does.
@@ -25864,9 +25893,7 @@ class GuideDocsComponent {
         else {
             this.replaceAnchorAttributes();
         }
-        this.links.forEach(guide => {
-            guide.baseHref = this.baseUrl;
-        });
+        this.ready = this.docs.isDocsEnabled();
     }
     /**
      * Find and modify anchor elements
@@ -25874,7 +25901,12 @@ class GuideDocsComponent {
     replaceAnchorAttributes() {
         const anchors = this.findGuideAnchors(this.el.nativeElement);
         anchors.forEach(a => {
-            const guideHref = `${this.baseUrl}/${a.getAttribute('c8y-guide-href')}`;
+            const guideHref = this.docs.getUserGuideLink(a.getAttribute('c8y-guide-href'));
+            if (!guideHref) {
+                // e.g. `guideHrefTemplate` is empty, so no link can be built: keep the text, drop the link
+                this.renderer.removeAttribute(a, 'href');
+                return;
+            }
             this.renderer.setAttribute(a, 'href', guideHref);
             if (!a.hasAttribute('target')) {
                 this.renderer.setAttribute(a, 'target', '_blank');
@@ -25908,17 +25940,14 @@ class GuideDocsComponent {
         this.destroyed$.complete();
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: GuideDocsComponent, deps: [{ token: DocsService }, { token: i0.ElementRef }, { token: i0.Renderer2 }, { token: C8yTranslateDirective, optional: true }], target: i0.ɵɵFactoryTarget.Component }); }
-    static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "20.3.25", type: GuideDocsComponent, isStandalone: true, selector: "[c8y-guide-docs]", queries: [{ propertyName: "translateDirective", first: true, predicate: C8yTranslateDirective, descendants: true, static: true }, { propertyName: "links", predicate: GuideHrefDirective, descendants: true }], ngImport: i0, template: "<ng-container *ngIf=\"!!baseUrl\">\n  <ng-content></ng-content>\n</ng-container>\n", dependencies: [{ kind: "directive", type: NgIf, selector: "[ngIf]", inputs: ["ngIf", "ngIfThen", "ngIfElse"] }] }); }
+    static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "20.3.25", type: GuideDocsComponent, isStandalone: true, selector: "[c8y-guide-docs]", queries: [{ propertyName: "translateDirective", first: true, predicate: C8yTranslateDirective, descendants: true, static: true }], ngImport: i0, template: "@if (ready) {\n  <ng-content></ng-content>\n}\n" }); }
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: GuideDocsComponent, decorators: [{
             type: Component,
-            args: [{ selector: '[c8y-guide-docs]', standalone: true, imports: [NgIf], template: "<ng-container *ngIf=\"!!baseUrl\">\n  <ng-content></ng-content>\n</ng-container>\n" }]
+            args: [{ selector: '[c8y-guide-docs]', standalone: true, template: "@if (ready) {\n  <ng-content></ng-content>\n}\n" }]
         }], ctorParameters: () => [{ type: DocsService }, { type: i0.ElementRef }, { type: i0.Renderer2 }, { type: C8yTranslateDirective, decorators: [{
                     type: Optional
-                }] }], propDecorators: { links: [{
-                type: ContentChildren,
-                args: [GuideHrefDirective, { descendants: true }]
-            }], translateDirective: [{
+                }] }], propDecorators: { translateDirective: [{
                 type: ContentChild,
                 args: [C8yTranslateDirective, { static: true }]
             }] } });