@ecodev/natural 55.1.0 → 55.2.0

package/fesm2022/ecodev-natural.mjs

@@ -1,6 +1,6 @@
 import '@angular/localize/init';
 import * as i0 from '@angular/core';
-import { Directive, Component, Inject, Injectable, HostBinding, HostListener, inject, InjectionToken, TemplateRef, ViewEncapsulation, ViewChild, Injector, Optional, Input, Host, Self, EventEmitter, Output, Pipe, APP_INITIALIZER, ContentChild, createEnvironmentInjector, createComponent, runInInjectionContext, PLATFORM_ID, ErrorHandler, importProvidersFrom } from '@angular/core';
+import { Directive, Component, Inject, Injectable, HostBinding, HostListener, inject, InjectionToken, TemplateRef, ViewEncapsulation, ViewChild, Injector, Optional, Input, Host, Self, EventEmitter, Output, Pipe, LOCALE_ID, APP_INITIALIZER, ContentChild, createEnvironmentInjector, createComponent, runInInjectionContext, PLATFORM_ID, ErrorHandler, importProvidersFrom } from '@angular/core';
 import { Subject, BehaviorSubject, of, timer, switchMap as switchMap$1, endWith, last, EMPTY, merge as merge$1, Observable, first as first$1, combineLatest, catchError, from, ReplaySubject, debounceTime as debounceTime$1, raceWith, take as take$1, mergeMap, shareReplay as shareReplay$1, forkJoin, map as map$1, tap as tap$1, asyncScheduler } from 'rxjs';
 import * as i2$3 from '@angular/forms';
 import { FormGroup, FormArray, Validators, UntypedFormGroup, UntypedFormArray, FormControl, FormsModule, ReactiveFormsModule, UntypedFormControl, FormControlDirective, FormControlName } from '@angular/forms';
@@ -391,6 +391,68 @@ function deepFreeze(o) {
     Object.values(o).forEach(v => Object.isFrozen(v) || deepFreeze(v));
     return Object.freeze(o);
 }
+/**
+ * Return a valid PaginationInput from whatever is available from data. Invalid properties/types will be dropped.
+ */
+function validatePagination(data) {
+    if (!data || typeof data !== 'object' || Array.isArray(data)) {
+        return null;
+    }
+    const pagination = {};
+    if ('offset' in data && (data.offset === null || typeof data.offset === 'number')) {
+        pagination.offset = data.offset;
+    }
+    if ('pageIndex' in data && (data.pageIndex === null || typeof data.pageIndex === 'number')) {
+        pagination.pageIndex = data.pageIndex;
+    }
+    if ('pageSize' in data && (data.pageSize === null || typeof data.pageSize === 'number')) {
+        pagination.pageSize = data.pageSize;
+    }
+    return pagination;
+}
+/**
+ * Return a valid Sortings from whatever is available from data. Invalid properties/types will be dropped.
+ */
+function validateSorting(data) {
+    if (!Array.isArray(data)) {
+        return null;
+    }
+    const result = [];
+    data.forEach(s => {
+        const r = validateOneSorting(s);
+        if (r) {
+            result.push(r);
+        }
+    });
+    return result;
+}
+function validateOneSorting(data) {
+    if (!data || typeof data !== 'object' || !('field' in data)) {
+        return null;
+    }
+    const sorting = { field: data.field };
+    if ('order' in data &&
+        (data.order === SortingOrder.ASC || data.order === SortingOrder.DESC || data.order === null)) {
+        sorting.order = data.order;
+    }
+    if ('nullAsHighest' in data && (data.nullAsHighest === null || typeof data.nullAsHighest === 'boolean')) {
+        sorting.nullAsHighest = data.nullAsHighest;
+    }
+    if ('emptyStringAsHighest' in data &&
+        (data.emptyStringAsHighest === null || typeof data.emptyStringAsHighest === 'boolean')) {
+        sorting.emptyStringAsHighest = data.emptyStringAsHighest;
+    }
+    return sorting;
+}
+/**
+ * Return valid columns from whatever is available from data. Invalid properties/types will be dropped.
+ */
+function validateColumns(data) {
+    if (typeof data !== 'string') {
+        return null;
+    }
+    return data.split(',').filter(string => string);
+}
 
 // Basic; loosely typed structure for graphql-doctrine filters
 // Logical operator to be used in conditions
@@ -3872,19 +3934,19 @@ class NaturalAbstractList extends NaturalAbstractPanel {
         }
         const storageKey = this.getStorageKey();
         // Pagination : pa
-        const pagination = this.persistenceService.get('pa', this.route, storageKey);
+        const pagination = validatePagination(this.persistenceService.get('pa', this.route, storageKey));
         if (pagination) {
             this.variablesManager.set('pagination', { pagination });
         }
         // Sorting : so
-        const sorting = this.persistenceService.get('so', this.route, storageKey);
+        const sorting = validateSorting(this.persistenceService.get('so', this.route, storageKey));
         if (sorting) {
             this.variablesManager.set('sorting', { sorting });
         }
         // Columns
-        const persistedColumns = this.persistenceService.get('col', this.route, storageKey);
-        if (typeof persistedColumns === 'string') {
-            this.selectedColumns = persistedColumns.split(',');
+        const persistedColumns = validateColumns(this.persistenceService.get('col', this.route, storageKey));
+        if (persistedColumns) {
+            this.selectedColumns = persistedColumns;
         }
         // Natural search : ns
         this.naturalSearchSelections = fromUrl(this.persistenceService.get('ns', this.route, storageKey));
@@ -5305,7 +5367,7 @@ function getTabId(tab) {
 /**
  * Usage :
  *
- * <mat-tab-group mat-stretch-tabs="false" [naturalLinkableTab]="!isPanel">
+ * <mat-tab-group [naturalLinkableTab]="!isPanel">
  *     <mat-tab label="Third 1">third 1</mat-tab> // First tab doesn't need id. This keeps url clean on default one
  *     <mat-tab label="Third 2" id="third2">Third 2</mat-tab>
  *     ...
@@ -5730,11 +5792,13 @@ function stripTags(str) {
  * configured for it in the routing.
  */
 class NaturalSeoService {
-    constructor(config, router, titleService, metaTagService) {
+    constructor(config, router, titleService, metaTagService, document, locale) {
         this.config = config;
         this.router = router;
         this.titleService = titleService;
         this.metaTagService = metaTagService;
+        this.document = document;
+        this.locale = locale;
         this.router.events.pipe(filter(event => event instanceof NavigationEnd)).subscribe(() => {
             const root = this.router.routerState.root.snapshot;
             this.routeData = this.getRouteData(root);
@@ -5776,6 +5840,65 @@ class NaturalSeoService {
         // Robots
         const robots = seo?.robots ?? this.config.defaultRobots;
         this.updateTag('robots', robots);
+        // Canonical
+        // Add language in url (after domain) if some languages are provided only
+        const language = this.config.languages?.length && this.locale ? this.locale.split('-')[0] : '';
+        const urlParts = this.getUrlParts(seo.canonicalQueryParamsWhitelist || []);
+        this.updateLinkTag({ rel: 'canonical', href: this.getUrl(urlParts, language) });
+        this.updateAlternates(urlParts);
+    }
+    updateAlternates(urlParts) {
+        this.config.languages?.forEach(language => {
+            this.updateLinkTag({ rel: 'alternate', href: this.getUrl(urlParts, language), hreflang: language });
+        });
+    }
+    getUrlParts(whiteListedParams) {
+        let url = 'https://' + this.document.defaultView?.window.location.hostname;
+        const urlTree = this.router.parseUrl(this.router.url);
+        // need better like something recursive ?
+        if (urlTree.root.hasChildren()) {
+            const segments = urlTree.root.children['primary'].segments;
+            if (segments && segments.length > 0) {
+                url += '/' + segments.map(segment => segment.path).join('/');
+            }
+        }
+        // Query Params
+        let params = '';
+        for (const param in urlTree.queryParams) {
+            if (whiteListedParams.includes(param)) {
+                const key = encodeURIComponent(param);
+                const value = encodeURIComponent(urlTree.queryParams[param]);
+                if (params.length) {
+                    params += '&';
+                }
+                params += `${key}=${value}`;
+            }
+        }
+        if (params.length) {
+            params = '?' + params;
+        }
+        return { url, params };
+    }
+    /**
+     * Add language between domain and uri https://example.com/fr/folder/page
+     * @param urlParts
+     * @param language
+     * @private
+     */
+    getUrl(urlParts, language) {
+        let url = urlParts.url;
+        if (language) {
+            url = this.addLanguageSegment(url, language);
+        }
+        if (urlParts.params) {
+            url += urlParts.params;
+        }
+        return url;
+    }
+    addLanguageSegment(url, language) {
+        const urlObj = new URL(url);
+        const newPath = urlObj.pathname === '/' ? `/${language}` : `/${language}${urlObj.pathname}`;
+        return urlObj.origin + newPath + urlObj.search + urlObj.hash;
     }
     join(parts) {
         return parts.filter(s => !!s).join(' - ');
@@ -5791,6 +5914,29 @@ class NaturalSeoService {
             this.metaTagService.removeTag(`name="${name}"`);
         }
     }
+    updateLinkTag(definition) {
+        const linkElement = this.document.head.querySelector(this._parseSelector(definition)) ||
+            this.document.head.appendChild(this.document.createElement('link'));
+        if (linkElement) {
+            Object.keys(definition).forEach((attribute) => {
+                linkElement.setAttribute(attribute, definition[attribute]);
+            });
+        }
+    }
+    /**
+     * Parse tag to create a selector
+     * @param  definition
+     * @return {string} selector to use in querySelector
+     */
+    _parseSelector(definition) {
+        let attributes = 'link';
+        Object.keys(definition).forEach((attr) => {
+            if (attr !== 'href') {
+                attributes += `[${attr}="${definition[attr]}"]`;
+            }
+        });
+        return attributes;
+    }
     /**
      * Returns the data from the most deep/specific activated route
      */
@@ -5834,7 +5980,7 @@ class NaturalSeoService {
         }
         return seo;
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.1.2", ngImport: i0, type: NaturalSeoService, deps: [{ token: NATURAL_SEO_CONFIG }, { token: i2$4.Router }, { token: i2$5.Title }, { token: i2$5.Meta }], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.1.2", ngImport: i0, type: NaturalSeoService, deps: [{ token: NATURAL_SEO_CONFIG }, { token: i2$4.Router }, { token: i2$5.Title }, { token: i2$5.Meta }, { token: DOCUMENT }, { token: LOCALE_ID }], target: i0.ɵɵFactoryTarget.Injectable }); }
     static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.1.2", ngImport: i0, type: NaturalSeoService, providedIn: 'root' }); }
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.1.2", ngImport: i0, type: NaturalSeoService, decorators: [{
@@ -5845,7 +5991,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.1.2", ngImpor
         }], ctorParameters: function () { return [{ type: undefined, decorators: [{
                     type: Inject,
                     args: [NATURAL_SEO_CONFIG]
-                }] }, { type: i2$4.Router }, { type: i2$5.Title }, { type: i2$5.Meta }]; } });
+                }] }, { type: i2$4.Router }, { type: i2$5.Title }, { type: i2$5.Meta }, { type: Document, decorators: [{
+                    type: Inject,
+                    args: [DOCUMENT]
+                }] }, { type: undefined, decorators: [{
+                    type: Inject,
+                    args: [LOCALE_ID]
+                }] }]; } });
 
 /**
  * Configure and starts `NaturalSeoService`
@@ -11208,5 +11360,5 @@ function graphqlQuerySigner(key) {
  * Generated bundle index. Do not edit.
  */
 
-export { AvatarService, LOCAL_STORAGE, NATURAL_DROPDOWN_DATA, NATURAL_ICONS_CONFIG, NATURAL_PERSISTENCE_VALIDATOR, NATURAL_SEO_CONFIG, NaturalAbstractController, NaturalAbstractDetail, NaturalAbstractEditableList, NaturalAbstractList, NaturalAbstractModelService, NaturalAbstractNavigableList, NaturalAbstractPanel, NaturalAlertService, NaturalAvatarComponent, NaturalCapitalizePipe, NaturalColumnsPickerComponent, NaturalConfirmComponent, NaturalDataSource, NaturalDebounceService, NaturalDetailHeaderComponent, NaturalDialogTriggerComponent, NaturalDropdownRef, NaturalEllipsisPipe, NaturalEnumPipe, NaturalEnumService, NaturalErrorHandler, NaturalFileComponent, NaturalFileDropDirective, NaturalFileSelectDirective, NaturalFileService, NaturalFixedButtonComponent, NaturalFixedButtonDetailComponent, NaturalHierarchicSelectorComponent, NaturalHierarchicSelectorDialogComponent, NaturalHierarchicSelectorDialogService, NaturalHierarchicSelectorService, NaturalHttpPrefixDirective, NaturalIconDirective, NaturalLinkMutationService, NaturalLinkableTabDirective, NaturalLoggerConfigExtra, NaturalLoggerConfigUrl, NaturalMatomoService, NaturalMemoryStorage, NaturalPanelsComponent, NaturalPanelsService, NaturalPersistenceService, NaturalQueryVariablesManager, NaturalRelationsComponent, NaturalSearchComponent, NaturalSelectComponent, NaturalSelectEnumComponent, NaturalSelectHierarchicComponent, NaturalSeoService, NaturalSidenavComponent, NaturalSidenavContainerComponent, NaturalSidenavContentComponent, NaturalSidenavService, NaturalSidenavStackService, NaturalSrcDensityDirective, NaturalStampComponent, NaturalSwissDatePipe, NaturalSwissParsingDateAdapter, NaturalTableButtonComponent, NaturalTimeAgoPipe, PanelsHooksConfig, SESSION_STORAGE, SortingOrder, TypeBooleanComponent, TypeDateComponent, TypeDateRangeComponent, TypeHierarchicSelectorComponent, TypeNaturalSelectComponent, TypeNumberComponent, TypeOptionsComponent, TypeSelectComponent, TypeTextComponent, available, cancellableTimeout, cleanSameValues, collectErrors, copyToClipboard, createHttpLink, debug, decimal, deepFreeze, deliverableEmail, ensureHttpPrefix, fallbackIfNoOpenedPanels, formatIsoDate, formatIsoDateTime, fromUrl, getForegroundColor, graphqlQuerySigner, ifValid, integer, localStorageFactory, localStorageProvider, lowerCaseFirstLetter, makePlural, memoryLocalStorageProvider, memorySessionStorageProvider, mergeOverrideArray, money, naturalPanelsUrlMatcher, naturalProviders, provideErrorHandler, provideIcons, providePanels, provideSeo, relationsToIds, replaceObjectKeepingReference, replaceOperatorByField, replaceOperatorByName, sessionStorageFactory, sessionStorageProvider, toGraphQLDoctrineFilter, toNavigationParameters, toUrl, unique, upperCaseFirstLetter, urlValidator, validTlds, validateAllFormControls, wrapLike };
+export { AvatarService, LOCAL_STORAGE, NATURAL_DROPDOWN_DATA, NATURAL_ICONS_CONFIG, NATURAL_PERSISTENCE_VALIDATOR, NATURAL_SEO_CONFIG, NaturalAbstractController, NaturalAbstractDetail, NaturalAbstractEditableList, NaturalAbstractList, NaturalAbstractModelService, NaturalAbstractNavigableList, NaturalAbstractPanel, NaturalAlertService, NaturalAvatarComponent, NaturalCapitalizePipe, NaturalColumnsPickerComponent, NaturalConfirmComponent, NaturalDataSource, NaturalDebounceService, NaturalDetailHeaderComponent, NaturalDialogTriggerComponent, NaturalDropdownRef, NaturalEllipsisPipe, NaturalEnumPipe, NaturalEnumService, NaturalErrorHandler, NaturalFileComponent, NaturalFileDropDirective, NaturalFileSelectDirective, NaturalFileService, NaturalFixedButtonComponent, NaturalFixedButtonDetailComponent, NaturalHierarchicSelectorComponent, NaturalHierarchicSelectorDialogComponent, NaturalHierarchicSelectorDialogService, NaturalHierarchicSelectorService, NaturalHttpPrefixDirective, NaturalIconDirective, NaturalLinkMutationService, NaturalLinkableTabDirective, NaturalLoggerConfigExtra, NaturalLoggerConfigUrl, NaturalMatomoService, NaturalMemoryStorage, NaturalPanelsComponent, NaturalPanelsService, NaturalPersistenceService, NaturalQueryVariablesManager, NaturalRelationsComponent, NaturalSearchComponent, NaturalSelectComponent, NaturalSelectEnumComponent, NaturalSelectHierarchicComponent, NaturalSeoService, NaturalSidenavComponent, NaturalSidenavContainerComponent, NaturalSidenavContentComponent, NaturalSidenavService, NaturalSidenavStackService, NaturalSrcDensityDirective, NaturalStampComponent, NaturalSwissDatePipe, NaturalSwissParsingDateAdapter, NaturalTableButtonComponent, NaturalTimeAgoPipe, PanelsHooksConfig, SESSION_STORAGE, SortingOrder, TypeBooleanComponent, TypeDateComponent, TypeDateRangeComponent, TypeHierarchicSelectorComponent, TypeNaturalSelectComponent, TypeNumberComponent, TypeOptionsComponent, TypeSelectComponent, TypeTextComponent, available, cancellableTimeout, cleanSameValues, collectErrors, copyToClipboard, createHttpLink, debug, decimal, deepFreeze, deliverableEmail, ensureHttpPrefix, fallbackIfNoOpenedPanels, formatIsoDate, formatIsoDateTime, fromUrl, getForegroundColor, graphqlQuerySigner, ifValid, integer, localStorageFactory, localStorageProvider, lowerCaseFirstLetter, makePlural, memoryLocalStorageProvider, memorySessionStorageProvider, mergeOverrideArray, money, naturalPanelsUrlMatcher, naturalProviders, provideErrorHandler, provideIcons, providePanels, provideSeo, relationsToIds, replaceObjectKeepingReference, replaceOperatorByField, replaceOperatorByName, sessionStorageFactory, sessionStorageProvider, toGraphQLDoctrineFilter, toNavigationParameters, toUrl, unique, upperCaseFirstLetter, urlValidator, validTlds, validateAllFormControls, validateColumns, validatePagination, validateSorting, wrapLike };
 //# sourceMappingURL=ecodev-natural.mjs.map