@arsedizioni/ars-utils 21.2.208 → 21.2.220

package/fesm2022/arsedizioni-ars-utils-clipper.common.mjs

@@ -1,8 +1,8 @@
 import * as i0 from '@angular/core';
 import { signal, computed, inject, DestroyRef, Injectable, NgModule } from '@angular/core';
+import { HttpClient, HttpHeaders, HttpRequest, HttpErrorResponse } from '@angular/common/http';
 import { BroadcastService, SystemUtils } from '@arsedizioni/ars-utils/core';
 import { EMPTY, throwError, of, catchError as catchError$1 } from 'rxjs';
-import { HttpClient, HttpHeaders, HttpRequest } from '@angular/common/http';
 import { takeUntilDestroyed } from '@angular/core/rxjs-interop';
 import { DialogService } from '@arsedizioni/ars-utils/ui';
 import { catchError, finalize, map } from 'rxjs/operators';
@@ -1586,34 +1586,24 @@ class ClipperChannelSettings {
         this.regions = [];
     }
     /**
-     * Check at least one of sector values is contained in sectors list
-     * @param values : the admitted values
-     * @returns true if at least one value has been found
+     * Returns `true` when the channel is active and at least one of the given sector codes
+     * matches a sector assigned to this channel.
+     * @param values - Array of sector code strings to test against.
      */
     hasAnyOfSectors(values) {
-        if (this.isEnabled === true && this.isActive === true) {
-            for (let i = 0; i < values.length; i++) {
-                if (this.sectors.filter(n => n.value === values[i])?.length > 0) {
-                    return true;
-                }
-            }
-        }
-        return false;
+        if (this.isEnabled !== true || this.isActive !== true)
+            return false;
+        return values.some(v => this.sectors.some(s => s.value === v));
     }
     /**
-     * Check at least one of region values is contained in regions list
-     * @param values : the admitted values
-     * @returns true if at least one value has been found
+     * Returns `true` when the channel is active and at least one of the given region codes
+     * matches a region assigned to this channel.
+     * @param values - Array of region code strings to test against.
      */
     hasAnyOfRegions(values) {
-        if (this.isEnabled === true && this.isActive === true) {
-            for (let i = 0; i < values.length; i++) {
-                if (this.regions.filter(n => n.value === values[i])?.length > 0) {
-                    return true;
-                }
-            }
-        }
-        return false;
+        if (this.isEnabled !== true || this.isActive !== true)
+            return false;
+        return values.some(v => this.regions.some(r => r.value === v));
     }
 }
 var ClipperQueryDocumentFlags;
@@ -1763,49 +1753,46 @@ class ClipperDashboard {
         }, ...(ngDevMode ? [{ debugName: "unreadItemsByModel" }] : /* istanbul ignore next */ []));
     }
     /**
-     * Update unread items
-     * @param module : the module
-     * @param model : the optional model
-     * @param increment : the increment (can be negative)
+     * Increments (or decrements) the unread item counter for the given module or model.
+     * Triggers a signal update so computed values and templates react to the change.
+     * @param module    - The `ClipperModule` whose counter should be adjusted.
+     * @param model     - Optional `ClipperModel` for sub-module granularity.
+     * @param increment - Amount to add (use a negative value to decrement).
      */
     updateUnreadItems(module, model, increment) {
         if (model) {
-            this.items().forEach(item => {
-                let itemModel = item.models?.find(x => x.id === model);
+            for (const item of this.items()) {
+                const itemModel = item.models?.find(x => x.id === model);
                 if (itemModel) {
                     itemModel.unreadItems += increment;
-                    return;
+                    break;
                 }
-            });
+            }
         }
-        let item = this.items()?.find((x) => x.id == module);
+        const item = this.items().find((x) => x.id === module);
         if (item) {
             item.unreadItems += increment;
         }
         this.items.update(values => [...values]);
     }
-    /***
-     * Get the module unread items
-     * @param module: the module
-     * @param model : the optional model
-     * @returns the module unread items
+    /**
+     * Returns the unread-item count for the given module, or for a specific model within it.
+     * @param module - The `ClipperModule` to query.
+     * @param model  - Optional `ClipperModel` for sub-module granularity.
+     * @returns Number of unread items, or `0` when none are found.
      */
     getUnreadItems(module, model) {
         if (model) {
-            return this.unreadItemsByModel()?.find((x) => x[0] === model)?.[1] ?? 0;
+            return this.unreadItemsByModel().find((x) => x[0] === model)?.[1] ?? 0;
         }
-        return this.unreadItems()?.find((x) => x[0] === module)?.[1] ?? 0;
+        return this.unreadItems().find((x) => x[0] === module)?.[1] ?? 0;
     }
     /**
-     * Return total unread items
-     * @returns : the total unread items
+     * Returns the sum of unread items across all tracked modules.
+     * @returns Total unread-item count.
      */
-    gatTotalUnreadItems() {
-        let totalUnread = 0;
-        this.unreadItems().forEach(item => {
-            totalUnread += item[1];
-        });
-        return totalUnread;
+    getTotalUnreadItems() {
+        return this.unreadItems().reduce((acc, item) => acc + item[1], 0);
     }
 }
 class ClipperTeamMemberInfo {
@@ -1892,9 +1879,9 @@ var ClipperArchiveCopyMode;
 })(ClipperArchiveCopyMode || (ClipperArchiveCopyMode = {}));
 class ClipperUtils {
     /**
-     * Check if a model is readable
-     * @param model : the model to check
-     * @returns : true if the model is readable
+     * Returns `true` when the given model corresponds to a readable document type
+     * (i.e., can be opened in the document viewer).
+     * @param model - The `ClipperModel` to test.
      */
     static isClipperModelReadable(model) {
         return model !== ClipperModel.Unknown &&
@@ -1903,9 +1890,9 @@ class ClipperUtils {
             model !== ClipperModel.Segnalazioni;
     }
     /**
-     * Return the Clipper module from a document
-     * @param item: the documenti item
-     * @returns the module id
+     * Returns the `ClipperModule` that owns the given document, derived from its model type.
+     * @param item - The document info object to inspect.
+     * @returns The matching `ClipperModule`, or `undefined` when the model has no direct module mapping.
      */
     static getClipperModuleFromModel(item) {
         switch (item.model) {
@@ -1924,63 +1911,66 @@ class ClipperUtils {
         return undefined;
     }
     /**
-     * Return the Clipper group name
-     * @param value: the group value
-     * @returns the group name
+     * Returns the display name for the given `ClipperModuleGroup`.
+     * @param value - The module group enum value to look up.
+     * @returns The group display name, or an empty string when not found.
      */
     static getClipperModuleGroupName(value) {
-        return ClipperModuleGroups.filter(n => n.value === value)?.[0].name;
+        return ClipperModuleGroups.find(n => n.value === value)?.name ?? '';
     }
     /**
-     * Return the list of modules of a group
-     * @param value: the module name
-     * @returns the list of modules
+     * Returns the list of `ClipperModule` items belonging to the given module group.
+     * @param value - The module group to filter by.
+     * @returns Array of matching `NameValueItem` entries.
      */
     static getClipperModuleGroupItems(value) {
         return ClipperModules.filter(n => n.parentValue === value);
     }
     /**
-     * Check modules against current selected in filter
-     * @param modules : the modules to check for
-     * @param mode : thc check mode: 1) exactly all elements 2) all elements 3) any of the elements specified
-     * @returns true if the check is successfull
+     * Tests a set of modules against the currently selected modules in the search filter.
+     * @param modules        - The modules to test.
+     * @param currentModules - The currently selected modules to check against.
+     * @param mode           - Matching strategy:
+     *   `1` = all and only the specified modules (exact set),
+     *   `2` = all specified modules must be present,
+     *   `3` = at least one specified module must be present.
+     * @returns `true` when the condition defined by `mode` is satisfied.
      */
     static checkModules(modules, currentModules, mode = 1) {
         let ok = false;
         if (mode === 1) {
             // All and only the elements specified
-            for (let i = 0; i < currentModules.length; i++) {
-                ok = (modules.findIndex(x => x === currentModules[i].value) ?? -1) !== -1;
-                if (!ok) {
+            for (const current of currentModules) {
+                ok = modules.findIndex(x => x === current.value) !== -1;
+                if (!ok)
                     break;
-                }
             }
-            ok = ok && modules.length >= (currentModules?.length ?? 0);
+            ok = ok && modules.length >= currentModules.length;
         }
         else if (mode === 2) {
             // All the elements specified
-            for (let i = 0; i < modules.length; i++) {
-                ok = (currentModules?.findIndex(x => x.value === modules[i]) ?? -1) !== -1;
-                if (!ok) {
+            for (const mod of modules) {
+                ok = currentModules.findIndex(x => x.value === mod) !== -1;
+                if (!ok)
                     break;
-                }
             }
         }
         else if (mode === 3) {
-            // Any of the specified elements    
-            for (let i = 0; i < modules.length; i++) {
-                ok = (currentModules?.findIndex(x => x.value === modules[i]) ?? -1) !== -1;
-                if (ok) {
+            // Any of the specified elements
+            for (const mod of modules) {
+                ok = currentModules.findIndex(x => x.value === mod) !== -1;
+                if (ok)
                     break;
-                }
             }
         }
         return ok;
     }
     /**
-     * Return the list of available sort options for a list of modules
-     * @param modules : the modules list
-     * @returns the list of availbale sort options
+     * Returns the sort options available for the given module selection.
+     * Includes the relevance option only when the query contains free text.
+     * @param modules - Currently selected modules (used to determine which date axes are available).
+     * @param params  - Current search params (checked for free-text content).
+     * @returns Array of applicable `NameValueItem<ClipperSort>` sort options.
      */
     static getClipperAvailableSortOptions(modules, params) {
         const options = [
@@ -1991,7 +1981,7 @@ class ClipperUtils {
             { name: "Rilevanza", value: ClipperSort.Relevance },
             //{ name: "Popolarità", value: ClipperSort.Popularity },
         ];
-        let sortOptions = [];
+        const sortOptions = [];
         if (params && ClipperSearchUtils.isTextQuery(params)) {
             sortOptions.push(options[4]);
         }
@@ -2019,8 +2009,8 @@ class ClipperUtils {
 }
 class ClipperSearchUtils {
     /**
-     * Clear the search params object
-     * @param params : the search params to clear
+     * Resets all filter fields of a `ClipperSearchParams` instance to their default (empty) values.
+     * @param params - The search-params object to clear.
      */
     static clear(params) {
         params.sector = undefined;
@@ -2068,14 +2058,14 @@ class ClipperSearchUtils {
         params.modules = undefined;
     }
     /**
-     * Get hte model list related to a list of modules
-     * @param modules: the modules to check
-     * @returns the list fo models
+     * Returns the list of `ClipperModel` values that correspond to the given modules.
+     * @param modules - The selected modules to map to their underlying data models.
+     * @returns Array of `ClipperModel` values matching the provided modules.
      */
     static getModulesModels(modules) {
         const models = [];
-        if ((modules?.length ?? 0) > 0) {
-            modules?.forEach(module => {
+        if (modules && modules.length > 0) {
+            modules.forEach(module => {
                 switch (module.value) {
                     case ClipperModule.ScadenzeESegnalazioni:
                         [ClipperModel.Scadenze, ClipperModel.Segnalazioni].forEach(x => models.push(x));
@@ -2113,18 +2103,18 @@ class ClipperSearchUtils {
         return models;
     }
     /**
-     * Check if current filter is a text based search
-     * @param params : the search params to check
-     * @returns true if is a text based search
+     * Returns `true` when the search params contain a non-empty free-text query.
+     * @param params - The search params to inspect.
      */
     static isTextQuery(params) {
-        return params.text != null && params.text?.length > 0;
+        return params.text != null && params.text.length > 0;
     }
     /**
-     * Try to add a query
-     * @param q : the new query
-     * @param queries : the new query
-            */
+     * Wraps `q` in quotes (if not already quoted) and appends it to `queries`.
+     * @param q       - A single search term to process.
+     * @param queries - The accumulated query string to append to.
+     * @returns The updated `queries` string.
+     */
     static concatTextQuery(q, queries) {
         if (q && q.length > 1) {
             if ((q[0] === '+' || q[0] === '-') && q[1] !== '"') {
@@ -2138,9 +2128,9 @@ class ClipperSearchUtils {
         return queries;
     }
     /**
-     * Normalize text query
-     * @param text : the text query to normalize
-     * @returns : the text normalized or undefined
+     * Normalises a comma-separated search string by wrapping each term in quotes.
+     * @param text - The raw search input to normalise.
+     * @returns The normalised query string, or `undefined` when `text` is empty.
      */
     static normalizeTextQuery(text) {
         if (!text || text.length === 0)
@@ -2159,22 +2149,24 @@ class ClipperSearchUtils {
         return queries;
     }
     /**
-     * Normalize text query 2: adds quotes at the beginning and end of the text
-     * only if there are no quoted elements, no '+', and no ' -' (space followed by minus)
-     * @param text : the text to normalize
-     * @returns : the normalized text
+     * Wraps the entire query in double quotes when it contains no boolean operators
+     * (`"`, `+`, or ` -`), making it an exact-phrase search.
+     * @param text - The query string to normalise.
+     * @returns The normalised query string.
      */
     static normalizeTextQuery2(text) {
+        if (!text)
+            return text;
         // Add quotes only if there are no quoted elements, no '+', and no ' -'
-        if (!text?.includes('"') && !text?.includes('+') && !text?.includes(' -')) {
+        if (!text.includes('"') && !text.includes('+') && !text.includes(' -')) {
             return '"' + text + '"';
         }
         return text;
     }
     /**
-     * Return a rank number from a char value (A, B, C)
-     * @param value : the char value
-     * @returns the rank number (A = 0.71, B = 0.61, C = 0.51)
+     * Maps a letter rank (`A`, `B`, or any other) to a numeric relevance threshold.
+     * @param value - The single-character rank string.
+     * @returns `0.751` for `'A'`, `0.71` for `'B'`, `0.51` for anything else.
      */
     static getRankFromChar(value) {
         switch (value.toUpperCase()) {
@@ -3334,79 +3326,107 @@ class ClipperService {
     getPropertiesTrackingsPending() {
         return this.httpClient.get(this._serviceUri + '/account/properties/trackings/pending');
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: ClipperService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: ClipperService, providedIn: 'root' }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.10", ngImport: i0, type: ClipperService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.10", ngImport: i0, type: ClipperService, providedIn: 'root' }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: ClipperService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.10", ngImport: i0, type: ClipperService, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: 'root',
                 }]
         }] });
 
+/** Minimum milliseconds between consecutive error broadcasts (debounce guard). */
+const ERROR_DEBOUNCE_MS = 5000;
+/**
+ * HTTP interceptor that attaches Clipper authentication headers to every request
+ * targeting the Clipper service, and broadcasts user-friendly error messages
+ * when the server returns an error response.
+ */
 class ClipperAuthInterceptor {
     constructor() {
         this.clipperService = inject(ClipperService);
         this.broadcastService = inject(BroadcastService);
         this.lastErrorTime = -1;
     }
+    /**
+     * Intercepts every outgoing HTTP request.
+     * When the request targets the Clipper service URI, attaches credentials and
+     * a client-ID header, then pipes the response through an error handler.
+     * @param request - The outgoing HTTP request.
+     * @param next    - The next handler in the interceptor chain.
+     * @returns An observable of the HTTP event stream.
+     */
     intercept(request, next) {
-        if (request.url.startsWith(this.clipperService.serviceUri)) {
-            request = request.clone({
-                withCredentials: true,
-                setHeaders: {
-                    'ngsw-bypass': 'ngsw-bypass',
-                    'X-Client-Id': sessionStorage.getItem('clipper_client_id') ?? ''
-                }
-            });
-            return next.handle(request)
-                .pipe(catchError$1(error => {
-                if (error.url.startsWith(this.clipperService.serviceUri)) {
-                    const errorStatus = parseInt(error.status ?? "0");
-                    if ((errorStatus > 0 && errorStatus < 500) || (this.clipperService.flags & ClipperServiceFlags.NotifySystemErrors) > 0) {
-                        const errorTime = new Date().getTime();
-                        if (errorTime - this.lastErrorTime > 5000) {
-                            this.lastErrorTime = errorTime;
-                            let message = "";
-                            switch (errorStatus) {
-                                case 0:
-                                    message = "In questo momento Clipper non è disponibile. Riprova tra qualche minuto.";
-                                    break;
-                                case 403:
-                                    message = "Non hai i permessi necessari per eseguire l'operazione richiesta.";
-                                    break;
-                                default:
-                                    message = (error.error?.message ?? error.message ?? "Impossibile eseguire l'operazione richiesta.").replaceAll("\r\n", "</p><p>");
-                                    break;
-                            }
-                            this.broadcastService.sendMessage(ClipperMessages.ERROR, {
-                                invalidateSession: errorStatus === 405 || errorStatus === 410,
-                                message: message,
-                                title: "Errore in Clipper",
-                                errorStatus: errorStatus,
-                                service: this.clipperService.serviceUri
-                            });
-                        }
-                    }
-                }
-                return throwError(() => error);
-            }));
+        if (!request.url.startsWith(this.clipperService.serviceUri)) {
+            return next.handle(request);
         }
-        return next.handle(request);
+        const authenticatedRequest = request.clone({
+            withCredentials: true,
+            setHeaders: {
+                'ngsw-bypass': 'ngsw-bypass',
+                'X-Client-Id': sessionStorage.getItem('clipper_client_id') ?? ''
+            }
+        });
+        return next.handle(authenticatedRequest).pipe(catchError$1((error) => {
+            this.handleError(error);
+            return throwError(() => error);
+        }));
+    }
+    /**
+     * Processes an HTTP error, broadcasting a user-friendly message when appropriate.
+     * Errors are debounced: only one message is sent per `ERROR_DEBOUNCE_MS` window.
+     * @param error - The raw error value thrown by the HTTP layer.
+     */
+    handleError(error) {
+        if (!(error instanceof HttpErrorResponse))
+            return;
+        if (!error.url?.startsWith(this.clipperService.serviceUri))
+            return;
+        const errorStatus = error.status;
+        const shouldNotify = (errorStatus > 0 && errorStatus < 500) ||
+            (this.clipperService.flags & ClipperServiceFlags.NotifySystemErrors) > 0;
+        if (!shouldNotify)
+            return;
+        const now = Date.now();
+        if (now - this.lastErrorTime <= ERROR_DEBOUNCE_MS)
+            return;
+        this.lastErrorTime = now;
+        let message;
+        switch (errorStatus) {
+            case 0:
+                message = "In questo momento Clipper non è disponibile. Riprova tra qualche minuto.";
+                break;
+            case 403:
+                message = "Non hai i permessi necessari per eseguire l'operazione richiesta.";
+                break;
+            default:
+                message = (error.error?.['message'] ??
+                    error.message ??
+                    "Impossibile eseguire l'operazione richiesta.").replaceAll('\r\n', '</p><p>');
+                break;
+        }
+        this.broadcastService.sendMessage(ClipperMessages.ERROR, {
+            invalidateSession: errorStatus === 405 || errorStatus === 410,
+            message,
+            title: "Errore in Clipper",
+            errorStatus,
+            service: this.clipperService.serviceUri
+        });
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: ClipperAuthInterceptor, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: ClipperAuthInterceptor }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.10", ngImport: i0, type: ClipperAuthInterceptor, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.10", ngImport: i0, type: ClipperAuthInterceptor }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: ClipperAuthInterceptor, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.10", ngImport: i0, type: ClipperAuthInterceptor, decorators: [{
             type: Injectable
         }] });
 
 class ArsClipperCommonModule {
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: ArsClipperCommonModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "21.2.9", ngImport: i0, type: ArsClipperCommonModule }); }
-    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: ArsClipperCommonModule }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.10", ngImport: i0, type: ArsClipperCommonModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
+    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "21.2.10", ngImport: i0, type: ArsClipperCommonModule }); }
+    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "21.2.10", ngImport: i0, type: ArsClipperCommonModule }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.9", ngImport: i0, type: ArsClipperCommonModule, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.10", ngImport: i0, type: ArsClipperCommonModule, decorators: [{
             type: NgModule
         }] });