@ecodev/natural 55.1.0 → 55.2.0

package/lib/classes/utility.d.ts

@@ -1,5 +1,6 @@
 import { Literal } from '../types/types';
 import type { ReadonlyDeep } from 'type-fest';
+import { PaginationInput, Sorting } from './query-variable-manager';
 /**
  * Very basic formatting to get only date, without time and ignoring entirely the timezone
  *
@@ -57,3 +58,15 @@ export declare function mergeOverrideArray(destValue: any, source: any): any;
  */
 export declare function copyToClipboard(document: Document, text: string): void;
 export declare function deepFreeze<T extends Literal>(o: T): ReadonlyDeep<T>;
+/**
+ * Return a valid PaginationInput from whatever is available from data. Invalid properties/types will be dropped.
+ */
+export declare function validatePagination(data: unknown): PaginationInput | null;
+/**
+ * Return a valid Sortings from whatever is available from data. Invalid properties/types will be dropped.
+ */
+export declare function validateSorting(data: unknown): Array<Sorting> | null;
+/**
+ * Return valid columns from whatever is available from data. Invalid properties/types will be dropped.
+ */
+export declare function validateColumns(data: unknown): string[] | null;

package/lib/modules/common/directives/linkable-tab.directive.d.ts

@@ -6,7 +6,7 @@ import * as i0 from "@angular/core";
 /**
  * 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>
  *     ...

package/lib/modules/common/services/seo.service.d.ts

@@ -18,6 +18,24 @@ export type NaturalSeoBasic = Robots & {
      * If given will be used as page description, otherwise fallback on default value
      */
     description?: string;
+    /**
+     * List of parameters included in the canonical tag's url
+     */
+    canonicalQueryParamsWhitelist?: string[];
+};
+export declare type NaturalLinkDefinition = {
+    charset?: string;
+    crossorigin?: string;
+    href?: string;
+    hreflang?: string;
+    media?: string;
+    rel?: string;
+    rev?: string;
+    sizes?: string;
+    target?: string;
+    type?: string;
+} & {
+    [prop: string]: string;
 };
 /**
  * Typically used for a "dynamic" page where a single object is resolved. So a detail page, such
@@ -56,15 +74,15 @@ export interface NaturalSeoConfig {
     /**
      * The name of the application that will always appear in the page title
      */
-    applicationName: string;
+    readonly applicationName: string;
     /**
      * Default value for description meta that is used for pages without value
      */
-    defaultDescription?: string;
+    readonly defaultDescription?: string;
     /**
      * Default value for robots meta that is used for pages without value
      */
-    defaultRobots?: string;
+    readonly defaultRobots?: string;
     /**
      * If given, the callback will be called for each route and must return a string that will
      * be inserted between the page title and the application name.
@@ -72,7 +90,12 @@ export interface NaturalSeoConfig {
      * It should be used to complete the title with info that are often, but not necessarily always,
      * available throughout the entire application. Typically used for the site/state in OKpilot.
      */
-    extraPart?: (routeData: Data) => string;
+    readonly extraPart?: (routeData: Data) => string;
+    /**
+     * Used to generate alternative tags
+     * <link rel="alternate" hreflang="en" href="https://www.example.com/en/page">
+     */
+    readonly languages?: Readonly<string[]>;
 }
 export declare const NATURAL_SEO_CONFIG: InjectionToken<NaturalSeoConfig>;
 export declare function stripTags(str: string): string;
@@ -95,8 +118,10 @@ export declare class NaturalSeoService {
     private readonly router;
     private readonly titleService;
     private readonly metaTagService;
+    private readonly document;
+    private locale;
     private routeData?;
-    constructor(config: NaturalSeoConfig, router: Router, titleService: Title, metaTagService: Meta);
+    constructor(config: NaturalSeoConfig, router: Router, titleService: Title, metaTagService: Meta, document: Document, locale: string);
     /**
      * Update the SEO with given info. The extra part and app name will be appended automatically.
      *
@@ -107,8 +132,28 @@ export declare class NaturalSeoService {
      * needed. For those cases the Component can inject this service and update the SEO directly.
      */
     update(seo: NaturalSeoBasic): void;
+    updateAlternates(urlParts: {
+        url: string;
+        params: string;
+    }): void;
+    private getUrlParts;
+    /**
+     * Add language between domain and uri https://example.com/fr/folder/page
+     * @param urlParts
+     * @param language
+     * @private
+     */
+    private getUrl;
+    private addLanguageSegment;
     private join;
     private updateTag;
+    private updateLinkTag;
+    /**
+     * Parse tag to create a selector
+     * @param  definition
+     * @return {string} selector to use in querySelector
+     */
+    private _parseSelector;
     /**
      * Returns the data from the most deep/specific activated route
      */

package/lib/modules/panels/panels.service.d.ts

@@ -25,7 +25,7 @@ export declare class NaturalPanelsService {
     /**
      * Stream that emits when all open dialog have finished closing
      */
-    afterAllClosed: Subject<void>;
+    readonly afterAllClosed: Subject<void>;
     /**
      * Cache for panels counter. Works more like an ID.
      * Is used to give an unique identifier to multiple similar panels configurations

package/lib/modules/search/dropdown-container/dropdown-container.component.d.ts

@@ -19,7 +19,7 @@ export declare class NaturalDropdownContainerComponent extends BasePortalOutlet
     /** Current state of the panel animation. */
     panelAnimationState: 'void' | 'enter';
     /** Emits whenever an animation on the menu completes. */
-    private animationDone;
+    private readonly animationDone;
     private focusTrap;
     private elementFocusedBeforeDialogWasOpened;
     constructor(elementRef: ElementRef<HTMLElement>, focusTrapFactory: ConfigurableFocusTrapFactory, data: NaturalDropdownContainerData);

package/lib/modules/search/facet-selector/facet-selector.component.d.ts

@@ -14,7 +14,7 @@ export interface FacetSelectorConfiguration {
 export declare class FacetSelectorComponent implements DropdownComponent {
     data: NaturalDropdownData<FacetSelectorConfiguration>;
     protected dropdownRef: NaturalDropdownRef;
-    renderedValue: BehaviorSubject<string>;
+    readonly renderedValue: BehaviorSubject<string>;
     facets: NaturalSearchFacets;
     selection: Facet | null;
     constructor(data: NaturalDropdownData<FacetSelectorConfiguration>, dropdownRef: NaturalDropdownRef);

package/lib/modules/select/select/select.component.d.ts

@@ -89,7 +89,7 @@ export declare class NaturalSelectComponent<TService extends NaturalAbstractMode
     /**
      * Init search options
      */
-    private variablesManager;
+    private readonly variablesManager;
     /**
      * Whether the value can be changed
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ecodev/natural",
-  "version": "55.1.0",
+  "version": "55.2.0",
   "license": "MIT",
   "repository": "github:Ecodev/natural",
   "sideEffects": false,