@sumaris-net/ngx-components 18.27.2 → 18.27.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sumaris-net/ngx-components",
   "description": "SUMARiS Angular components",
-  "version": "18.27.2",
+  "version": "18.27.3",
   "author": "contact@e-is.pro",
   "license": "AGPL-3.0",
   "readmeFilename": "README.md",

package/public_api.d.ts

@@ -167,6 +167,7 @@ export * from './src/app/shared/markdown/markdown.directive';
 export * from './src/app/shared/markdown/markdown.component';
 export * from './src/app/shared/markdown/markdown.modal';
 export * from './src/app/shared/print/print.service';
+export * from './src/app/shared/gitlab/gitlab.utils';
 export * from './src/app/core/core.module';
 export * from './src/app/core/services/model/account.model';
 export * from './src/app/core/services/model/token.model';

package/src/app/core/about/about.modal.d.ts

@@ -7,6 +7,8 @@ import { Configuration } from '../services/model/config.model';
 import { Observable } from 'rxjs';
 import { NetworkService } from '../services/network.service';
 import { NodeInfo } from '../services/network.utils';
+import { HttpClient } from '@angular/common/http';
+import { PlatformService } from '../services/platform.service';
 import * as i0 from "@angular/core";
 export declare const APP_ABOUT_DEVELOPERS: InjectionToken<Partial<Department>[]>;
 export declare const APP_ABOUT_PARTNERS: InjectionToken<Partial<Department>[]>;
@@ -15,6 +17,8 @@ export declare class AboutModal implements OnInit, OnDestroy {
     protected modalController: ModalController;
     protected configService: ConfigService;
     protected networkService: NetworkService;
+    protected platformService: PlatformService;
+    protected http: HttpClient;
     protected cd: ChangeDetectorRef;
     protected environment: any;
     developers: Partial<Department>[];
@@ -33,14 +37,15 @@ export declare class AboutModal implements OnInit, OnDestroy {
     protected nodeInfo: NodeInfo;
     protected buildDate: string;
     protected get allowVersionDetails(): boolean;
-    constructor(translate: TranslateService, modalController: ModalController, configService: ConfigService, networkService: NetworkService, cd: ChangeDetectorRef, environment: any, developers: Partial<Department>[], partners: Partial<Department>[]);
+    constructor(translate: TranslateService, modalController: ModalController, configService: ConfigService, networkService: NetworkService, platformService: PlatformService, http: HttpClient, cd: ChangeDetectorRef, environment: any, developers: Partial<Department>[], partners: Partial<Department>[]);
     ngOnInit(): void;
     ngOnDestroy(): void;
     close(): Promise<void>;
     protected setConfig(config?: Configuration): void;
-    protected openChangelog(event: Event): Promise<void>;
+    protected getChangelogUrl(config?: Configuration): any;
+    protected openChangelog(event: Event): Promise<void | import("@ionic/core").OverlayEventDetail<any>>;
     protected loadNodeInfo(): Promise<void>;
     protected getNodeInfo(): Promise<NodeInfo>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AboutModal, [null, null, null, null, null, { optional: true; }, { optional: true; }, { optional: true; }]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AboutModal, [null, null, null, null, null, null, null, { optional: true; }, { optional: true; }, { optional: true; }]>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AboutModal, "app-about-modal", never, {}, {}, never, never, false, never>;
 }

package/src/app/shared/alerts.d.ts

@@ -9,8 +9,14 @@ export declare class Alerts {
      * @param alertCtrl
      * @param translate
      * @param event
+     * @param opts
+     * @param opts.backdropDismiss Whether the alert can be dismissed by clicking the backdrop (default: true)
+     * @param opts.keyboardClose Whether the alert can be dismissed by pressing the back button (default: true)
      */
-    static askSaveBeforeLeave(alertCtrl: AlertController, translate: TranslateService, event?: Event): Promise<boolean | undefined>;
+    static askSaveBeforeLeave(alertCtrl: AlertController, translate: TranslateService, event?: Event, opts?: {
+        backdropDismiss?: boolean;
+        keyboardClose?: boolean;
+    }): Promise<boolean | undefined>;
     /**
      * Ask the user to conform an action. If return undefined: user has cancelled
      *
@@ -19,8 +25,15 @@ export declare class Alerts {
      * @param immediate is action has an immediate effect ?
      * @param event
      * @param interpolateParams
+     * @param opts
+     * @param opts.backdropDismiss Whether the alert can be dismissed by clicking the backdrop (default: true)
+     * @param opts.keyboardClose Whether the alert can be dismissed by pressing the back button (default: true)
      */
-    static askActionConfirmation(alertCtrl: AlertController, translate: TranslateService, immediate?: boolean, event?: Event, interpolateParams?: any): Promise<boolean | undefined>;
+    static askActionConfirmation(alertCtrl: AlertController, translate: TranslateService, immediate?: boolean, event?: Event, opts?: {
+        backdropDismiss?: boolean;
+        keyboardClose?: boolean;
+        [key: string]: any;
+    }, interpolateParams?: any): Promise<boolean | undefined>;
     /**
      * Ask the user to confirm. If return undefined: user has cancelled
      *
@@ -30,8 +43,17 @@ export declare class Alerts {
      * @param translate
      * @param event
      * @param interpolateParams
+     * @param opts
+     * @param opts.backdropDismiss Whether the alert can be dismissed by clicking the backdrop (default: true)
+     * @param opts.keyboardClose Whether the alert can be dismissed by pressing the back button (default: true)
+     *
+     * Note: interpolateParams and opts are merged for translation for compatibility
      */
-    static askConfirmation(messageKey: string, alertCtrl: AlertController, translate: TranslateService, event?: Event, interpolateParams?: any): Promise<boolean | undefined>;
+    static askConfirmation(messageKey: string, alertCtrl: AlertController, translate: TranslateService, event?: Event, opts?: {
+        backdropDismiss?: boolean;
+        keyboardClose?: boolean;
+        [key: string]: any;
+    }, interpolateParams?: any): Promise<boolean | undefined>;
     /**
      * Ask the user to save before leaving. If return undefined: user has cancelled
      *
@@ -39,17 +61,30 @@ export declare class Alerts {
      * @param translate
      * @param event
      * @param interpolateParams
+     * @param opts
+     * @param opts.backdropDismiss Whether the alert can be dismissed by clicking the backdrop (default: true)
+     * @param opts.keyboardClose Whether the alert can be dismissed by pressing the back button (default: true)
+     *
+     * Note: interpolateParams and opts are merged for translation for compatibility
      */
-    static askDeleteConfirmation(alertCtrl: AlertController, translate: TranslateService, event?: Event, interpolateParams?: any): Promise<boolean | undefined>;
+    static askDeleteConfirmation(alertCtrl: AlertController, translate: TranslateService, event?: Event, opts?: {
+        backdropDismiss?: boolean;
+        keyboardClose?: boolean;
+        [key: string]: any;
+    }, interpolateParams?: any): Promise<boolean | undefined>;
     static askSaveBeforeAction(alertCtrl: AlertController, translate: TranslateService, opts?: {
         valid?: boolean;
         validMessageI18n?: string;
         invalidMessageI18n?: string;
+        backdropDismiss?: boolean;
+        keyboardClose?: boolean;
     }, interpolateParams?: any): Promise<{
         confirmed: boolean;
         save: boolean;
     } | undefined>;
     static showError(messageKey: string, alertCtrl: AlertController, translate: TranslateService, opts?: {
         titleKey?: string;
+        backdropDismiss?: boolean;
+        keyboardClose?: boolean;
     }, interpolateParams?: any): Promise<void>;
 }

package/src/app/shared/gitlab/gitlab.utils.d.ts

@@ -0,0 +1,109 @@
+import { HttpClient } from '@angular/common/http';
+export interface IGitlabRelease {
+    name: string;
+    tag_name: string;
+    description: string;
+}
+export declare class GitlabUtils {
+    static API_V4_PATH: string;
+    static API_V4_PROJECTS_PATH: string;
+    /**
+     * Checks whether a URL points to a Gitlab instance.
+     *
+     * A URL is considered a Gitlab URL either when its host starts with 'gitlab.'
+     * (e.g. 'https://gitlab.ifremer.fr/...'), or when it is a repository file URL
+     * (see {@link isRepoFileUrl}) - in which case the host is NOT checked, since
+     * a self-hosted Gitlab instance may use a custom domain name.
+     *
+     * @example
+     * GitlabUtils.isGitlabUrl('https://gitlab.ifremer.fr/sih-public/sumaris/sumaris-app'); // true
+     * GitlabUtils.isGitlabUrl('https://my-custom-domain.com/foo/-/raw/master/README.md'); // true (repo file URL)
+     * GitlabUtils.isGitlabUrl('https://github.com/foo/bar'); // false
+     */
+    static isGitlabUrl(url: string): boolean;
+    /**
+     * Checks whether a URL is a Gitlab repository file URL, i.e. a URL used to
+     * view a single file in a repository ('/-/blob/') or to download its raw
+     * content ('/-/raw/').
+     *
+     * @example
+     * GitlabUtils.isRepoFileUrl('https://gitlab.ifremer.fr/a/b/-/raw/master/README.md'); // true
+     * GitlabUtils.isRepoFileUrl('https://gitlab.ifremer.fr/a/b/-/blob/master/README.md'); // true
+     * GitlabUtils.isRepoFileUrl('https://gitlab.ifremer.fr/api/v4/projects/a%2Fb'); // false
+     */
+    static isRepoFileUrl(url: string): boolean;
+    /**
+     * Converts a repository file URL into its 'raw content' equivalent, by
+     * replacing the '/-/blob/' (file viewer) or '/-/tree/' (directory viewer)
+     * segment with '/-/raw/'.
+     *
+     * If the URL is not a repository file URL (see {@link isRepoFileUrl}), it is
+     * returned unchanged.
+     *
+     * @example
+     * GitlabUtils.getRawRepoFileUrl('https://gitlab.ifremer.fr/a/b/-/blob/master/README.md');
+     * // 'https://gitlab.ifremer.fr/a/b/-/raw/master/README.md'
+     */
+    static getRawRepoFileUrl(url: string): string;
+    /**
+     * Checks whether a URL targets the Gitlab REST API (any endpoint under
+     * '/api/v4/'). Repository file URLs (see {@link isRepoFileUrl}) are always
+     * excluded, even if they happen to contain '/api/v4/' somewhere in their path.
+     */
+    static isApiUrl(url: string): boolean;
+    /**
+     * Checks whether a URL targets the Gitlab 'projects' REST API (any endpoint
+     * under '/api/v4/projects/'), e.g. project releases, branches, etc.
+     */
+    static isApiProjectsUrl(url: string): boolean;
+    /**
+     * Checks whether a URL targets the Gitlab project releases REST API, e.g.
+     * 'https://gitlab.ifremer.fr/api/v4/projects/{id}/releases' (all releases)
+     * or 'https://gitlab.ifremer.fr/api/v4/projects/{id}/releases/{tag_name}'
+     * (a single release).
+     */
+    static isProjectReleasesApiUrl(url: string): boolean;
+    /**
+     * Fetches releases from the Gitlab project releases REST API.
+     *
+     * The given URL can either target the collection endpoint
+     * ('.../releases', returning all releases), or a single release endpoint
+     * ('.../releases/{tag_name}', returning one release, wrapped into an array).
+     *
+     * @return the list of releases, an empty array if the API call failed for a
+     *   single release, or `null` if the URL is not a project releases API URL.
+     */
+    static getProjectReleases(http: HttpClient, url: string): Promise<IGitlabRelease[]>;
+    /**
+     * Extracts the URL-encoded project path (e.g. 'group%2Fsubgroup%2Fproject')
+     * from a Gitlab 'projects' API URL. The returned value is NOT decoded, so it
+     * still contains '%2F' in place of '/'.
+     *
+     * @example
+     * GitlabUtils.getProjectNameFromApiUrl('https://gitlab.ifremer.fr/api/v4/projects/sih-public%2Fsumaris%2Fsumaris-app/releases');
+     * // 'sih-public%2Fsumaris%2Fsumaris-app'
+     */
+    static getProjectNameFromApiUrl(url: string): string;
+    /**
+     * Resolves the Gitlab web page associated to a URL:
+     * - for an API 'projects' URL (see {@link isApiUrl}), this is the project's
+     *   home page, e.g. 'https://gitlab.ifremer.fr/sih-public/sumaris/sumaris-app';
+     * - for a repository file URL (see {@link isRepoFileUrl}), this is the
+     *   project's raw content base path (e.g. '.../my-project/-/raw/'), since
+     *   the project path cannot be reliably distinguished from the file path
+     *   once slashes are un-encoded.
+     *
+     * @return `null` if the project page cannot be resolved from the given URL.
+     */
+    static getProjectPage(url: string): string;
+    /**
+     * Builds the URL of the Gitlab web page listing a project's releases (e.g.
+     * 'https://gitlab.ifremer.fr/sih-public/sumaris/sumaris-app/-/releases'),
+     * optionally anchored on a specific version/tag.
+     *
+     * @param url any URL from which the project page can be resolved (see {@link getProjectPage})
+     * @param version optional tag name (e.g. '2.16.2') appended to the releases page
+     * @return `null` if the project page cannot be resolved from the given URL.
+     */
+    static getProjectReleasePage(url: string, version?: string): string;
+}

package/src/app/shared/markdown/markdown.utils.d.ts

@@ -20,7 +20,5 @@ export declare class MarkdownUtils {
     static resolveRelativeUrl(baseUrl: string, relativePath: string, opts?: {
         absoluteByDefault: boolean;
     }): string;
-    static isGitlabUrl(url: string): boolean;
-    static fixGitlabUrlToRaw(url: string): string;
     static getRootUrl(url: string): string;
 }

package/src/app/shared/upload-file/upload-file-popover.component.d.ts

@@ -11,7 +11,9 @@ export interface UploadFilePopoverOptions<T> {
     instantUpload?: boolean;
     uniqueFile?: boolean;
     fileExtension?: string;
+    fileExtensionsExcluded?: string[];
     maxParallelUpload?: number;
+    maxFileSizeMb?: number;
     autoHideDropArea?: boolean;
     okButtonText?: string;
     cancelButtonText?: string;
@@ -26,12 +28,14 @@ export declare class UploadFilePopover implements UploadFilePopoverOptions<any>
     protected cd: ChangeDetectorRef;
     uploader: UploadFileComponent;
     fileExtension: string;
+    fileExtensionsExcluded: string[];
     title: string;
     uniqueFile: boolean;
     instantUpload: boolean;
     uploadFn: FileUploadFn<any>;
     deleteFn: FileDeleteFn<any>;
     maxParallelUpload: number;
+    maxFileSizeMb: number;
     autoHideDropArea: boolean;
     okButtonText: string;
     cancelButtonText: string;
@@ -45,5 +49,5 @@ export declare class UploadFilePopover implements UploadFilePopoverOptions<any>
     cancel(): Promise<boolean>;
     protected resetError(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<UploadFilePopover, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<UploadFilePopover, "app-upload-file-popover", never, { "fileExtension": { "alias": "fileExtension"; "required": false; }; "title": { "alias": "title"; "required": false; }; "uniqueFile": { "alias": "uniqueFile"; "required": false; }; "instantUpload": { "alias": "instantUpload"; "required": false; }; "uploadFn": { "alias": "uploadFn"; "required": false; }; "deleteFn": { "alias": "deleteFn"; "required": false; }; "maxParallelUpload": { "alias": "maxParallelUpload"; "required": false; }; "autoHideDropArea": { "alias": "autoHideDropArea"; "required": false; }; "okButtonText": { "alias": "okButtonText"; "required": false; }; "cancelButtonText": { "alias": "cancelButtonText"; "required": false; }; }, {}, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<UploadFilePopover, "app-upload-file-popover", never, { "fileExtension": { "alias": "fileExtension"; "required": false; }; "fileExtensionsExcluded": { "alias": "fileExtensionsExcluded"; "required": false; }; "title": { "alias": "title"; "required": false; }; "uniqueFile": { "alias": "uniqueFile"; "required": false; }; "instantUpload": { "alias": "instantUpload"; "required": false; }; "uploadFn": { "alias": "uploadFn"; "required": false; }; "deleteFn": { "alias": "deleteFn"; "required": false; }; "maxParallelUpload": { "alias": "maxParallelUpload"; "required": false; }; "maxFileSizeMb": { "alias": "maxFileSizeMb"; "required": false; }; "autoHideDropArea": { "alias": "autoHideDropArea"; "required": false; }; "okButtonText": { "alias": "okButtonText"; "required": false; }; "cancelButtonText": { "alias": "cancelButtonText"; "required": false; }; }, {}, never, never, false, never>;
 }

package/src/app/shared/upload-file/upload-file.component.d.ts

@@ -1,6 +1,6 @@
 import { ChangeDetectorRef, ElementRef } from '@angular/core';
 import { TranslateService } from '@ngx-translate/core';
-import { FileDeleteFn, FileUploadFn, UploadFile } from './upload-file.model';
+import { FileCheck, FileDeleteFn, FileUploadFn, UploadFile } from './upload-file.model';
 import { WaitForOptions } from '../observables';
 import * as i0 from "@angular/core";
 export declare class UploadFileComponent {
@@ -8,14 +8,17 @@ export declare class UploadFileComponent {
     protected translate: TranslateService;
     fileDropEl: ElementRef;
     fileExtension: string;
+    fileExtensionsExcluded: string[];
     uniqueFile: boolean;
     instantUpload: boolean;
     uploadFn: FileUploadFn<any>;
     deleteFn: FileDeleteFn<any>;
     maxParallelUpload: number;
+    maxFileSizeMb: number;
     autoHideDropArea: boolean;
     files: UploadFile<any>[];
     uploading: boolean;
+    checks: FileCheck[];
     get processingFiles(): UploadFile<any>[];
     get processedFiles(): UploadFile<any>[];
     get processingFilesCount(): number;
@@ -40,11 +43,12 @@ export declare class UploadFileComponent {
      * @param files (Files List)
      */
     prepareFilesList(files: FileList | File[]): void;
+    checkFiles(): void;
     /**
      * Execute upload
      */
     uploadFiles(files?: File[]): Promise<UploadFile<any>[]>;
     waitIdle(opts?: WaitForOptions): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<UploadFileComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<UploadFileComponent, "app-upload-file", never, { "fileExtension": { "alias": "fileExtension"; "required": false; }; "uniqueFile": { "alias": "uniqueFile"; "required": false; }; "instantUpload": { "alias": "instantUpload"; "required": false; }; "uploadFn": { "alias": "uploadFn"; "required": false; }; "deleteFn": { "alias": "deleteFn"; "required": false; }; "maxParallelUpload": { "alias": "maxParallelUpload"; "required": false; }; "autoHideDropArea": { "alias": "autoHideDropArea"; "required": false; }; }, {}, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<UploadFileComponent, "app-upload-file", never, { "fileExtension": { "alias": "fileExtension"; "required": false; }; "fileExtensionsExcluded": { "alias": "fileExtensionsExcluded"; "required": false; }; "uniqueFile": { "alias": "uniqueFile"; "required": false; }; "instantUpload": { "alias": "instantUpload"; "required": false; }; "uploadFn": { "alias": "uploadFn"; "required": false; }; "deleteFn": { "alias": "deleteFn"; "required": false; }; "maxParallelUpload": { "alias": "maxParallelUpload"; "required": false; }; "maxFileSizeMb": { "alias": "maxFileSizeMb"; "required": false; }; "autoHideDropArea": { "alias": "autoHideDropArea"; "required": false; }; }, {}, never, never, false, never>;
 }

package/src/app/shared/upload-file/upload-file.model.d.ts

@@ -6,6 +6,13 @@ export declare class UploadFile<T> extends File {
     error?: string;
     response?: FileResponse<T> | HttpResponse<T>;
 }
+export type FileCheckEnabledFn = () => boolean;
+export type FileHasErrorFn = (file: UploadFile<any>) => boolean;
+export interface FileCheck {
+    isEnabled: FileCheckEnabledFn;
+    hasError: FileHasErrorFn;
+    error: string;
+}
 export type FileUploadFn<T> = (file: File) => Observable<FileEvent<T> | HttpEvent<T>>;
 export type FileDeleteFn<T> = (file: UploadFile<T>) => Promise<boolean>;
 export interface FileProgressEvent {

package/src/assets/i18n/en-US.json

@@ -649,6 +649,8 @@
       "IMPORTING": "Import in progress",
       "BTN_IMPORT_POLICY_DOTS": "Import policy...",
       "ERROR": "Error while uploading file",
+      "MAX_FILE_SIZE_ERROR": "The file size is too large to be uploaded ({{maxFileSizeMb}} MB max)",
+      "EXTENSION_NOT_ALLOWED_ERROR": "The file extension is not allowed ({{fileExtensionsExcluded}} excluded)",
       "IMPORT_POLICY": {
         "TITLE": "Import options",
         "INSERT-ONLY": "Inserts only",

package/src/assets/i18n/en.json

@@ -649,6 +649,8 @@
       "IMPORTING": "Import in progress",
       "BTN_IMPORT_POLICY_DOTS": "Import policy...",
       "ERROR": "Error while uploading file",
+      "MAX_FILE_SIZE_ERROR": "The file size is too large to be uploaded ({{maxFileSizeMb}} MB max)",
+      "EXTENSION_NOT_ALLOWED_ERROR": "The file extension is not allowed ({{fileExtensionsExcluded}} excluded)",
       "IMPORT_POLICY": {
         "TITLE": "Import options",
         "INSERT-ONLY": "Inserts only",

package/src/assets/i18n/fr.json

@@ -651,6 +651,8 @@
       "IMPORTING": "Importation en cours",
       "BTN_IMPORT_POLICY_DOTS": "Stratégie d'importation...",
       "ERROR": "Erreur durant l'envoi de fichier",
+      "MAX_FILE_SIZE_ERROR": "La taille du fichier est trop importante pour être téléversé ({{maxFileSizeMb}} Mo max).",
+      "EXTENSION_NOT_ALLOWED_ERROR": "L'extension du fichier n'est pas autorisée ({{fileExtensionsExcluded}} exclus).",
       "IMPORT_POLICY": {
         "TITLE": "Stratégie d'importation",
         "INSERT-ONLY": "Insertions uniquement",

package/src/assets/manifest.json

@@ -2,7 +2,7 @@
   "name": "ngx-sumaris-components",
   "short_name": "ngx-sumaris-components",
   "manifest_version": 1,
-  "version": "18.27.2",
+  "version": "18.27.3",
   "default_locale": "fr",
   "description": "Angular components for building beautiful and responsive Apps",
   "icons": [{

package/testing/package.json

@@ -1,3 +0,0 @@
-{
-  "module": "../fesm2022/sumaris-net-ngx-components-testing.mjs"
-}