@sumaris-net/ngx-components 18.24.24 → 18.25.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sumaris-net/ngx-components",
   "description": "SUMARiS Angular components",
-  "version": "18.24.24",
+  "version": "18.25.1",
   "author": "contact@e-is.pro",
   "license": "AGPL-3.0",
   "readmeFilename": "README.md",
@@ -32,6 +32,7 @@
   "peerDependencies": {
     "@apollo/client": "~3.12.4",
     "@ionic/storage": "~4.0.0",
+    "@playwright/test": "^1.58.2",
     "d3": "~7.6.1",
     "localforage": "~1.10.0",
     "rxjs": "~7.8.2",
@@ -92,6 +93,12 @@
       "esm2022": "./esm2022/sumaris-net.ngx-components.mjs",
       "esm": "./esm2022/sumaris-net.ngx-components.mjs",
       "default": "./fesm2022/sumaris-net.ngx-components.mjs"
+    },
+    "./testing": {
+      "types": "./testing/index.d.ts",
+      "esm2022": "./esm2022/testing/sumaris-net-ngx-components-testing.mjs",
+      "esm": "./esm2022/testing/sumaris-net-ngx-components-testing.mjs",
+      "default": "./fesm2022/sumaris-net-ngx-components-testing.mjs"
     }
   },
   "sideEffects": false

package/public_api.d.ts

@@ -199,6 +199,9 @@ export * from './src/app/core/services/base-entity-service.class';
 export * from './src/app/core/services/storage/entities-storage.service';
 export * from './src/app/core/services/storage/entity-store.class';
 export * from './src/app/core/services/validator/base.validator.class';
+export * from './src/app/core/services/startup.model';
+export { STARTUP_DATA_STORAGE_KEY } from './src/app/core/services/startup.constants';
+export { StartupService, StartupData, createAppStartupInitializer } from './src/app/core/services/startup.service';
 export * from './src/app/core/form/form.class';
 export * from './src/app/core/form/form.utils';
 export * from './src/app/core/form/form-container.class';

package/src/app/core/services/account.service.d.ts

@@ -22,6 +22,7 @@ import { OverlayEventDetail } from '@ionic/core';
 import { ToastController } from '@ionic/angular';
 import { TranslateService } from '@ngx-translate/core';
 import { TokenScope, UserToken } from './model/token.model';
+import { StartupService } from './startup.service';
 import * as i0 from "@angular/core";
 export declare interface AccountDetails {
     loaded: boolean;
@@ -87,6 +88,7 @@ export declare class AccountService extends BaseGraphqlService<Account, any, num
     protected settings: LocalSettingsService;
     protected storage: Storage;
     protected file: FileService;
+    protected startupService: StartupService;
     private translate;
     private toastController;
     protected environment: Environment;
@@ -118,7 +120,7 @@ export declare class AccountService extends BaseGraphqlService<Account, any, num
     get apiTokenEnabled(): boolean;
     set apiTokenEnabled(value: boolean);
     get remoteLocalSettingsKeys(): string[];
-    constructor(network: NetworkService, graphql: GraphqlService, settings: LocalSettingsService, storage: Storage, file: FileService, translate: TranslateService, toastController: ToastController, environment: Environment, options: UserSettingsOptions, accountOptions?: AccountServiceOptions);
+    constructor(network: NetworkService, graphql: GraphqlService, settings: LocalSettingsService, storage: Storage, file: FileService, startupService: StartupService, translate: TranslateService, toastController: ToastController, environment: Environment, options: UserSettingsOptions, accountOptions?: AccountServiceOptions);
     ngOnStart(): Promise<Account>;
     protected ngOnStop(): Promise<void>;
     isLogin(): boolean;
@@ -201,6 +203,7 @@ export declare class AccountService extends BaseGraphqlService<Account, any, num
         fetchPolicy?: FetchPolicy;
     }): Promise<Account>;
     protected listenSettings(): Promise<void>;
+    protected autoLogin(): Promise<boolean>;
     protected restoreLocally(): Promise<Account | undefined>;
     /**
      * Save account into the local storage
@@ -229,7 +232,7 @@ export declare class AccountService extends BaseGraphqlService<Account, any, num
     protected copyIdAndUpdateDateSettings(source: UserSettings | undefined, target: UserSettings): void;
     protected copyIdAndUpdateDateToken(sources: UserToken[] | undefined, targets: UserToken[]): void;
     protected showToast<T = any>(opts: ShowToastOptions): Promise<OverlayEventDetail<T>>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AccountService, [null, null, null, null, null, { optional: true; }, { optional: true; }, null, { optional: true; }, { optional: true; }]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AccountService, [null, null, null, null, null, { optional: true; }, { optional: true; }, { optional: true; }, null, { optional: true; }, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AccountService>;
 }
 export declare function provideAccountService(): Provider;

package/src/app/core/services/startup.constants.d.ts

@@ -0,0 +1 @@
+export declare const STARTUP_DATA_STORAGE_KEY = "__appStartupData";

package/src/app/core/services/startup.model.d.ts

@@ -0,0 +1 @@
+export type StartupMethod = 'url' | 'window' | 'environment';

package/src/app/core/services/startup.service.d.ts

@@ -0,0 +1,31 @@
+import { AuthData } from './account.service';
+import { StorageService } from '../../shared/storage/storage.service';
+import { STARTUP_DATA_STORAGE_KEY } from './startup.constants';
+import * as i0 from "@angular/core";
+export { STARTUP_DATA_STORAGE_KEY };
+export interface StartupData extends AuthData {
+    peerUrl?: string;
+}
+export declare class StartupService {
+    private _data;
+    protected storage: StorageService;
+    protected environment: import("../../../environments/environment.class").Environment;
+    get data(): StartupData;
+    set data(data: StartupData);
+    hasPeer(): boolean;
+    consumePeer(): string | null;
+    hasAuth(): boolean;
+    consumeAuth(): AuthData | null;
+    start(): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<StartupService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<StartupService>;
+}
+/**
+ * Factory function for the app startup initializer.
+ * In Angular 18, this is used with APP_INITIALIZER:
+ *   { provide: APP_INITIALIZER, useFactory: createAppStartupInitializer, multi: true }
+ *
+ * inject() is called during factory execution (in injection context), then the
+ * returned function calls the already-injected service.
+ */
+export declare function createAppStartupInitializer(): () => Promise<void>;

package/src/assets/manifest.json

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

package/src/environments/environment.class.d.ts

@@ -3,6 +3,7 @@ import { StorageConfig } from '@ionic/storage';
 import { InjectionToken } from '@angular/core';
 import { CacheConfig } from 'ionic-cache/lib/interfaces/cache-config.interface';
 import { LoggingServiceConfig } from '../app/shared/logging/logging-service.config';
+import { StartupMethod } from '../app/core/services/startup.model';
 export declare const ENVIRONMENT: InjectionToken<Environment>;
 export declare class Environment {
     name: string;
@@ -65,6 +66,7 @@ export declare class Environment {
         password?: string;
         token?: string;
     };
+    startupOrder?: StartupMethod[];
     account?: {
         showAccountButton?: boolean;
         enableListenChanges?: boolean;

package/testing/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="@sumaris-net/ngx-components/testing" />
+export * from './testing_api';

package/testing/test/login-env.d.ts

@@ -0,0 +1,76 @@
+import { PlaywrightTestArgs } from '@playwright/test';
+/**
+ * Search environments based on provided criteria.
+ *
+ * Use when you need to run tests with one or more environments.
+ * Test can use `testWithEnv` to run tests with a specific environment.
+ * Example :
+ *
+ * ```
+ * test.describe('Sample test with environment', () => {
+ *    withEnvs({
+ *      peerTags: ['local'],
+ *      userTags: ['admin'],
+ *    }).forEach((env) => {
+ *      testWithEnv(env)(`Some test with environment ${env.id}`, async ({ page }) => {
+ *        // Test implementation
+ *      });
+ *    });
+ * });
+ * ```
+ *
+ * Environments are loaded from a JSON config file located at one of four paths :
+ * - `LOGIN_ENVS_PATH` environment variable
+ * - `.environments.json` in the current directory (e.g. `.environments.json`)
+ * - `.environments.json` in the `.local` directory (e.g. `.local/environments.json`)
+ * - `.environments.json` in the `e2e` directory (e.g. `e2e/.environments.json`)
+ *
+ * Example of JSON :
+ *
+ * ```
+ * {
+ *   "peers": [
+ *     {
+ *       "id": "local",
+ *       "tags": ["local"],
+ *       "url": "http://localhost:8080",
+ *       "users": [
+ *         {
+ *           "tags": ["admin"],
+ *           "username": "admin@sumaris.net",
+ *           "password": "***"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * ```
+ *
+ * @see testWithEnv
+ * @param filter Search criteria.
+ */
+export declare function withEnvs(filter: EnvFilter): LoginEnv[];
+/**
+ * Currying function that returns a test function that can be used to run tests with a specific environment.
+ *
+ * ```
+ * testWithEnv(env)(`Some test with environment ${env.id}`, async ({ page }) => {
+ *   // Test implementation
+ * })
+ * ```
+ *
+ * @see withEnvs
+ * @param env Environment to use for the test.
+ */
+export declare function testWithEnv(env: LoginEnv): (title: string, testFn: (args: PlaywrightTestArgs) => Promise<void>) => void;
+export interface EnvFilter {
+    peerId?: string;
+    peerTags?: string[];
+    userTags?: string[];
+}
+export interface LoginEnv {
+    id?: string;
+    peerUrl: string;
+    username: string;
+    password: string;
+}

package/testing/testing_api.d.ts

@@ -0,0 +1,6 @@
+export * from './utils/startup.constants';
+export * from './utils/auth.utils';
+export * from './utils/ionic.utils';
+export * from './utils/material.utils';
+export * from './utils/ui.utils';
+export * from './test/login-env';

package/testing/utils/auth.utils.d.ts

@@ -0,0 +1,21 @@
+import { Page } from 'playwright';
+import { UiHelper } from './ui.utils';
+/**
+ * Helper for authentication in e2e tests.
+ */
+export declare class AuthHelper {
+    private page;
+    protected ui: UiHelper;
+    constructor(page: Page, ui?: UiHelper);
+    /** Login with given test credentials */
+    login(username: string, password: string): Promise<void>;
+    /** Wait until the user is logged in and return the email shown in the side menu */
+    waitForLoggedIn(): Promise<string | null>;
+    /** Setup startup data with provided credentials or environment variables */
+    loginByEnv(opts?: {
+        username?: string;
+        password?: string;
+        offline?: boolean;
+        peerUrl?: string;
+    }): Promise<void>;
+}

package/testing/utils/ionic.utils.d.ts

@@ -0,0 +1,51 @@
+import { Locator, Page } from 'playwright';
+/**
+ * Utility selectors and helpers for Ionic components in e2e tests.
+ */
+export declare const IonicSelectors: {
+    /** Ionic button */
+    button: string;
+    /** Ionic modal */
+    modal: string;
+    /** Ionic content area */
+    content: string;
+    /** Ionic item */
+    item: string;
+    /** Ionic label */
+    label: string;
+    /** Ionic spinner */
+    spinner: string;
+    /** Ionic skeleton text (loading placeholder) */
+    skeletonText: string;
+    /** Ionic back button */
+    backButton: string;
+    /** Ionic toolbar */
+    toolbar: string;
+    /** Ionic footer */
+    footer: string;
+    /** Ionic header */
+    header: string;
+};
+/**
+ * Helper functions for interacting with Ionic components.
+ */
+export declare class IonicHelper {
+    private page;
+    constructor(page: Page);
+    /** Get an Ionic button by text content */
+    buttonByText(text: string | RegExp): Locator;
+    /** Get an Ionic button by CSS selector */
+    button(selector?: string, options?: {
+        hasText?: string | RegExp;
+    }): Locator;
+    /**
+     * Get an Ionic modal by its inner component selector (e.g. 'app-auth-form').
+     * Automatically wraps the selector in `ion-modal:has(...)` so callers
+     * only need to provide the component tag name.
+     */
+    modal(selector: string): Locator;
+    /** Wait for the Ionic app to be ready */
+    waitForAppReady(timeout?: number): Promise<void>;
+    /** Wait for loading spinners to disappear */
+    waitForLoadingComplete(timeout?: number): Promise<void>;
+}

package/testing/utils/material.utils.d.ts

@@ -0,0 +1,57 @@
+import { Locator, Page } from 'playwright';
+/**
+ * Utility selectors and helpers for Angular Material components in e2e tests.
+ */
+export declare const MaterialSelectors: {
+    /** Material table row */
+    row: string;
+    /** Material header row */
+    headerRow: string;
+    /** Material cell */
+    cell: string;
+    /** Material form field */
+    formField: string;
+    /** Material input */
+    input: string;
+    /** Material tab group */
+    tabGroup: string;
+    /** Material tab label */
+    tabLabel: string;
+    /** Material paginator */
+    paginator: string;
+    /** Material icon */
+    icon: string;
+    /** Material autocomplete panel */
+    autocompletePanel: string;
+    /** Material autocomplete option */
+    autocompleteOption: string;
+};
+/**
+ * Helper functions for interacting with Angular Material components.
+ */
+export declare class MaterialHelper {
+    private page;
+    constructor(page: Page);
+    /** Get all visible table rows, optionally scoped to a parent locator */
+    tableRows(scope?: Locator): Locator;
+    /** Get a single table row by index (0-based), optionally scoped to a parent locator */
+    tableRow(index: number, scope?: Locator): Locator;
+    /** Click on a table row by index (0-based), optionally scoped to a parent locator */
+    clickRow(index: number, scope?: Locator): Promise<void>;
+    /** Get a tab by its label text */
+    tabByLabel(text: string | RegExp): Locator;
+    /** Click a tab by its label text */
+    clickTab(text: string | RegExp): Promise<void>;
+    /** Fill a mat-form-field input identified by its formControlName.
+     *  Supports both native inputs with formcontrolname and custom components (e.g. mat-autocomplete-field) wrapping an input. */
+    fillFormControl(formControlName: string, value: string): Promise<void>;
+    /**
+     * Select an option from a mat-select dropdown by formControlName.
+     * Opens the dropdown, waits for options to render, clicks the matching option, then waits for the dropdown to close.
+     */
+    selectMatSelectOption(formControlName: string, optionText: string | RegExp): Promise<void>;
+    /** Select an autocomplete option by text after typing in a form control */
+    selectAutocompleteOption(formControlName: string, searchText: string, optionText: string | RegExp): Promise<void>;
+    /** Wait for table rows to be loaded (at least one row visible), optionally scoped to a parent locator */
+    waitForTableRows(timeout?: number, scope?: Locator): Promise<void>;
+}

package/testing/utils/startup.constants.d.ts

@@ -0,0 +1 @@
+export declare const STARTUP_DATA_STORAGE_KEY = "__appStartupData";

package/testing/utils/ui.utils.d.ts

@@ -0,0 +1,79 @@
+import { Locator, Page } from 'playwright';
+import { IonicHelper } from './ionic.utils';
+import { MaterialHelper } from './material.utils';
+/**
+ * Common UI helper functions to improve readability of e2e tests.
+ * This helper centralizes access to Ionic and Material specific helpers.
+ */
+export declare class UiHelper {
+    protected page: Page;
+    protected ionic: IonicHelper;
+    protected mat: MaterialHelper;
+    constructor(page: Page);
+    /**
+     * Click an element and wait for it to be ready.
+     * @param locator The locator to click.
+     * @param timeout The maximum time to wait.
+     */
+    click(locator: Locator, timeout?: number): Promise<void>;
+    /**
+     * Fill an input and wait for it to be ready.
+     * @param locator The locator to fill.
+     * @param value The value to enter.
+     * @param timeout The maximum time to wait.
+     */
+    fill(locator: Locator, value: string, timeout?: number): Promise<void>;
+    /**
+     * Wait for an element to be visible.
+     * @param locator The locator to wait for.
+     * @param timeout The maximum time to wait.
+     */
+    waitForVisible(locator: Locator, timeout?: number): Promise<void>;
+    /**
+     * Wait for an element to be hidden.
+     * @param locator The locator to wait for.
+     * @param timeout The maximum time to wait.
+     */
+    waitForHidden(locator: Locator, timeout?: number): Promise<void>;
+    /**
+     * Get a button by its text content.
+     * Supports both Ionic and Material buttons.
+     * @param text The text content to match.
+     * @param scope Optional locator to scope the search within.
+     */
+    button(text: string | RegExp, scope?: Locator): Locator;
+    /**
+     * Get an icon button by its icon name.
+     * Supports both Ionic and Material icon buttons.
+     * @param iconName The icon name (e.g. 'mail', 'search', 'ellipsis-horizontal').
+     * @param scope Optional locator to scope the search within.
+     */
+    iconButton(iconName: string, scope?: Locator): Locator;
+    /**
+     * Access to the underlying Playwright Page object.
+     */
+    get pageObj(): Page;
+    /** Get a modal by its selector */
+    modal(selector: string): Locator;
+    /** Get a tab by its label text */
+    tab(text: string | RegExp): Locator;
+    /** Wait for the app to be ready */
+    waitForAppReady(timeout?: number): Promise<void>;
+    /** Wait for loading spinners to disappear */
+    waitForLoadingComplete(timeout?: number): Promise<void>;
+    /** Wait for table rows to be loaded, optionally scoped to a parent locator */
+    waitForTableRows(timeout?: number, scope?: Locator): Promise<void>;
+    /** Get a single table row by index (0-based), optionally scoped to a parent locator */
+    tableRow(index: number, scope?: Locator): Locator;
+    /** Click on a table row by index, optionally scoped to a parent locator */
+    clickRow(index: number, scope?: Locator): Promise<void>;
+    /** Fill a mat-form-field input identified by its formControlName */
+    fillFormControl(formControlName: string, value: string): Promise<void>;
+    /** Select an autocomplete option */
+    selectAutocompleteOption(formControlName: string, searchText: string, optionText: string | RegExp): Promise<void>;
+    /**
+     * Select an option from a mat-select dropdown.
+     * Opens the dropdown, waits for options, clicks the matching one, then waits for the dropdown to close.
+     */
+    selectOption(formControlName: string, optionText: string | RegExp): Promise<void>;
+}