@sumaris-net/ngx-components 18.10.29 → 18.12.0

package/src/environments/environment.class.ts

@@ -0,0 +1,106 @@
+import { FetchPolicy } from '@apollo/client/core';
+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';
+
+export const ENVIRONMENT = new InjectionToken<Environment>('ENV');
+
+export class Environment {
+  name: string;
+  version: string;
+  production: boolean;
+
+  // An URL to load external environment file (e.g. 'assets/environments/environment.json'
+  externalEnvironmentUrl?: string;
+  baseUrl: string;
+  connectionTimeout?: number;
+
+  sameUrlPeer?: boolean;
+
+  // The peer to use (if defined)
+  peer?: { host: string; port: number; useSsl?: boolean; path?: string } | undefined | null;
+
+  // A peer to use at startup (useful on a web site deployment)
+  defaultPeer?: { host: string; port: number; useSsl?: boolean; path?: string } | undefined | null;
+
+  // A list of peers, to select as peer, in settings
+  defaultPeers?: { host: string; port: number; useSsl?: boolean; path?: string }[];
+
+  // Min compatible version for the peer
+  peerMinVersion?: string;
+
+  // Default peer prefix, when fix peer url manually (default: 'https://')
+  peerDefaultPrefix?: string;
+
+  // Allow to select a peer by feature
+  enableSelectPeerByFeature?: boolean;
+
+  // Interval to check if web page must be reload, in millis
+  checkAppVersionIntervalInSeconds?: number;
+
+  // Enable cache persistence ?
+  persistCache?: boolean;
+
+  // Force offline mode ? /!\ For DEV only
+  offline?: boolean;
+
+  // Apollo (graphQL) config
+  apolloFetchPolicy?: FetchPolicy;
+
+  // Default values
+  defaultLocale: string;
+  defaultLatLongFormat?: 'DD' | 'DDMM' | 'DDMMSS';
+  defaultDepartmentId?: number;
+  defaultAppName?: string;
+  defaultAndroidInstallUrl?: string;
+  defaultIOSInstallUrl?: string;
+  defaultDesktopInstallUrl?: string;
+
+  // Route and style
+  useHash?: boolean; // Configure Angular router to use '#' in URL (need by web-ext artifact)
+  allowDarkMode?: boolean;
+  defaultRoute?: string; // Configure the default route ('/' by default)
+  enableMenu?: boolean; // Enable by default
+
+  // Logging
+  logging?: Partial<LoggingServiceConfig>;
+
+  // Storage
+  cache?: Partial<CacheConfig>;
+  storage?: Partial<StorageConfig>;
+  storageSavePeriodMs?: number;
+
+  // About
+  sourceUrl?: string;
+  reportIssueUrl?: string;
+
+  forumUrl?: string; // TODO allow a map by locale ? ex: { [lang: string]: string };
+  helpUrl?: string; // TODO allow a map by locale ?
+  privacyPolicyUrl?: string; // TODO allow a map by locale ?
+  termsOfUseUrl?: string; // TODO allow a map by locale ?
+
+  // Default authentication /!\ For DEV only
+  // (see values in the test database - XML files in Pod's module)
+  defaultAuthValues?: {
+    username?: string;
+    password?: string;
+    token?: string;
+  };
+
+  // Account
+  account?: {
+    showAccountButton?: boolean; // Show account button in home page (if undefined = true)
+    enableListenChanges?: boolean;
+    // If undefined or 0, then listen only changes made by the pod
+    // If greater than 0 : will check concurrent changes in the DB (e.g. changes mde by another software) AND changes made the pod
+    listenIntervalInSeconds?: number;
+  };
+
+  entityEditor?: {
+    enableListenChanges?: boolean;
+    // If undefined or 0, then listen only changes made by the pod
+    // If greater than 0 : will check concurrent changes in the DB (e.g. changes mde by another software) AND changes made the pod
+    listenIntervalInSeconds?: number;
+  };
+}

package/src/environments/environment.loader.ts

@@ -0,0 +1,90 @@
+import { Directive } from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+import { firstValueFrom, of, shareReplay, tap } from 'rxjs';
+import { catchError } from 'rxjs/operators';
+import { Environment } from './environment.class';
+import { isNotNilOrBlank } from '../app/shared/functions';
+
+@Directive()
+export abstract class EnvironmentLoader<T extends Environment = Environment> {
+  abstract load(): Promise<T>;
+
+  abstract get(): T;
+}
+
+export class EnvironmentHttpLoader<T extends Environment = Environment> extends EnvironmentLoader<T> {
+  private readonly _logPrefix = '[environment-loader] ';
+
+  protected _debug: boolean;
+  protected _environment: T;
+  protected _loaded = false;
+  protected readonly _externalEnvironmentUrl: string;
+
+  constructor(
+    protected http: HttpClient,
+    defaultEnvironment?: T
+  ) {
+    super();
+    // Copy default environment (because can be readonly)
+    this._environment = Object.assign({}, defaultEnvironment || <T>{});
+    this._externalEnvironmentUrl = this._environment.externalEnvironmentUrl;
+    this._debug = !this._environment.production;
+  }
+
+  /**
+   * Get the loaded environment. Should be call after loaded
+   */
+  get(): T {
+    if (!this._loaded && isNotNilOrBlank(this._externalEnvironmentUrl)) {
+      console.warn(`${this._logPrefix}EnvironmentHttpLoader.get() should be called AFTER load() finished.`);
+    }
+    return this._environment;
+  }
+
+  async load(): Promise<T> {
+    if (this._loaded) return this._environment; // Already loaded
+
+    try {
+      // If it has an external url
+      if (isNotNilOrBlank(this._externalEnvironmentUrl)) {
+        // DEBUG
+        //await sleep(4000);
+
+        // Load external environment file
+        const json = await this.fetch(this._externalEnvironmentUrl);
+
+        // Patch the existing environment
+        if (json) {
+          Object.assign(this._environment, json);
+        }
+      }
+
+      return this._environment;
+    } finally {
+      this._loaded = true;
+    }
+  }
+
+  /* -- protected function -- */
+
+  protected async fetch(url: string): Promise<Partial<T>> {
+    if (this._debug) console.debug(`${this._logPrefix}Loading external environment from {${url}}...`);
+
+    return firstValueFrom(
+      this.http.get<Partial<T>>(url).pipe(
+        shareReplay(1),
+        tap((json) => {
+          if (this._debug) console.debug(`${this._logPrefix}External environment loaded`, json);
+        }),
+        catchError((error) => {
+          if (error.status === 404) {
+            if (this._debug) console.error(`${this._logPrefix}External environment not found (404)`);
+          } else {
+            console.error(`${this._logPrefix}Failed to load external environment: ${error.message}`, error);
+          }
+          return of(null);
+        })
+      )
+    );
+  }
+}

package/src/environments/environment.prod.ts

@@ -0,0 +1,49 @@
+import { Environment } from './environment.class';
+import { StorageDrivers } from '../app/shared/storage/storage.utils';
+
+/* eslint-disable */
+export const environment = Object.freeze(<Environment>{
+  name: '@sumaris-net/ngx-components',
+  version: undefined, // overridden by ENVIRONMENT token
+  production: true,
+  baseUrl: '/',
+  defaultLocale: 'fr',
+  defaultLatLongFormat: 'DDMM',
+  apolloFetchPolicy: 'cache-first',
+
+  peerMinVersion: '1.0.0',
+  peerDefaultPrefix: 'https://',
+  enableSelectPeerByFeature: false,
+  persistCache: false,
+
+  defaultPeer: undefined,
+  // TODO: remove this
+  /*defaultPeer: {
+    host: '192.168.0.45',
+    port: 8080
+  },*/
+  // Production and public peers
+  defaultPeers: [
+    // No default peer in production
+  ],
+  defaultAppName: 'SUMARiS',
+  defaultAndroidInstallUrl: 'https://play.google.com/store/apps/details?id=net.sumaris.app',
+
+  // Storage
+  storage: {
+    driverOrder: [StorageDrivers.SQLLite, StorageDrivers.IndexedDB, StorageDrivers.WebSQL, StorageDrivers.LocalStorage],
+  },
+
+  // About
+  sourceUrl: 'https://gitlab.ifremer.fr/sih-public/sumaris/ngx-sumaris-components',
+  reportIssueUrl: 'https://gitlab.ifremer.fr/sih-public/sumaris/ngx-sumaris-components/-/issues',
+
+  account: {
+    enableListenChanges: true,
+  },
+
+  entityEditor: {
+    enableListenChanges: false,
+  },
+});
+/* eslint-enable */

package/src/environments/environment.test.ts

@@ -0,0 +1,92 @@
+// This file can be replaced during build by using the `fileReplacements` array.
+// `ng build ---prod` replaces `environment.ts` with `environment.prod.ts`.
+// The list of file replacements can be found in `angular.json`.
+import { StorageDrivers } from '../app/shared/storage/storage.utils';
+
+// Environment to use only with unit tests
+import { Environment } from './environment.class';
+
+/*
+ * In development mode, to ignore zone related error stack frames such as
+ * `zone.run`, `zoneDelegate.invokeTask` for easier debugging, you can
+ * import the following file, but please comment it out in production mode
+ * because it will have performance impact when throw error
+ */
+//import 'zone.js/plugins/zone-error';
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const pkg = require('../../package.json');
+
+export const environment = Object.freeze(<Environment>{
+  name: pkg.name as string,
+  version: pkg.version as string,
+  production: false,
+  externalEnvironmentUrl: 'assets/environments/environment-test.json',
+  baseUrl: '/',
+  defaultLocale: 'fr',
+  defaultLatLongFormat: 'DDMM',
+  apolloFetchPolicy: 'cache-first',
+
+  // FIXME: enable cache
+  persistCache: false,
+
+  peerMinVersion: '1.8.0',
+  peerDefaultPrefix: 'http://',
+  enableSelectPeerByFeature: true,
+
+  defaultPeer: {
+    host: 'localhost',
+    port: 8080,
+  },
+
+  defaultPeers: [
+    {
+      host: 'localhost',
+      port: 8080,
+    },
+    {
+      host: 'localhost',
+      port: 8081,
+    },
+    {
+      host: '192.168.0.45',
+      port: 8080,
+    },
+    {
+      host: 'sih.sfa.sc',
+      port: 80,
+    },
+  ],
+
+  defaultAppName: 'SUMARiS',
+  defaultAndroidInstallUrl: 'https://play.google.com/store/apps/details?id=net.sumaris.app',
+  defaultIOSInstallUrl: 'https://apps.apple.com/us/app/sumaris/id6736747523',
+  defaultDesktopInstallUrl: 'https://gitlab.ifremer.fr/sih-public/sumaris/sumaris-app/-/releases',
+
+  // Storage
+  storage: {
+    driverOrder: [StorageDrivers.SQLLite, StorageDrivers.IndexedDB, StorageDrivers.WebSQL, StorageDrivers.LocalStorage],
+  },
+
+  // About
+  sourceUrl: pkg.repository && (pkg.repository.url as string),
+  reportIssueUrl: pkg.bugs && (pkg.bugs.url as string),
+
+  // Development
+  defaultAuthValues: {
+    // Basic auth (using Person.username)
+    // username: 'admq2', password: 'q22006'
+    // Token auth (using Person.pubkey)
+    //username: 'admin@sumaris.net', password: 'admin',
+  },
+
+  account: {
+    enableListenChanges: true,
+    listenIntervalInSeconds: 60,
+  },
+
+  entityEditor: {
+    enableListenChanges: false,
+    listenIntervalInSeconds: 60,
+  },
+});

package/src/environments/environment.ts

@@ -0,0 +1,126 @@
+// This file can be replaced during build by using the `fileReplacements` array.
+// `ng build ---prod` replaces `environment.ts` with `environment.prod.ts`.
+// The list of file replacements can be found in `angular.json`.
+import { StorageDrivers } from '../app/shared/storage/storage.utils';
+
+import { Environment } from './environment.class';
+/*
+ * In development mode, to ignore zone related error stack frames such as
+ * `zone.run`, `zoneDelegate.invokeTask` for easier debugging, you can
+ * import the following file, but please comment it out in production mode
+ * because it will have performance impact when throw error
+ */
+//import 'zone.js/plugins/zone-error';
+
+export const environment: Environment = Object.freeze(<Environment>{
+  name: '@sumaris-net/ngx-components', // overridden by ENVIRONMENT token
+  version: '1.0', // overridden by ENVIRONMENT token
+
+  // Do NOT set to false - because this value will be used by releases
+  production: true,
+
+  // Do NOT set - because this value will be used by releases
+  //externalEnvironmentUrl: null,
+
+  baseUrl: '/',
+  defaultLocale: 'fr',
+  defaultLatLongFormat: 'DDMM',
+  apolloFetchPolicy: 'cache-first',
+  useHash: false,
+  allowDarkMode: true,
+
+  //defaultRoute: '/home',
+  //enableMenu: true,
+
+  // FIXME: enable cache
+  persistCache: false,
+
+  // TODO: make this works
+  //offline: true,
+
+  peerMinVersion: '1.8.0',
+
+  enableSelectPeerByFeature: true,
+
+  defaultPeer: {
+    host: 'localhost',
+    port: 8081,
+  },
+
+  defaultPeers: [
+    {
+      host: 'localhost',
+      port: 8080,
+    },
+    {
+      host: 'localhost',
+      port: 8081,
+    },
+    {
+      host: '192.168.0.45',
+      port: 8080,
+    },
+    {
+      host: '192.168.0.24',
+      port: 8080,
+    },
+    {
+      host: '192.168.0.29',
+      port: 8080,
+    },
+    {
+      host: '192.168.0.107',
+      port: 8080,
+    },
+    {
+      host: 'sih.sfa.sc',
+      port: 443,
+    },
+    {
+      host: 'test.sumaris.net',
+      port: 443,
+    },
+    {
+      host: 'open.sumaris.net',
+      port: 443,
+    },
+    {
+      host: 'server.e-is.pro',
+      port: 443,
+    },
+  ],
+  defaultAppName: 'SUMARiS',
+  defaultAndroidInstallUrl: 'https://play.google.com/store/apps/details?id=net.sumaris.app',
+  defaultIOSInstallUrl: 'https://apps.apple.com/us/app/sumaris/id6736747523',
+  defaultDesktopInstallUrl: 'https://gitlab.ifremer.fr/sih-public/sumaris/sumaris-app/-/releases',
+
+  // Storage
+  storage: {
+    driverOrder: [StorageDrivers.SQLLite, StorageDrivers.IndexedDB, StorageDrivers.WebSQL, StorageDrivers.LocalStorage],
+  },
+
+  // About
+  sourceUrl: 'https://gitlab.ifremer.fr/sih-public/sumaris/ngx-sumaris-components',
+  reportIssueUrl: 'https://gitlab.ifremer.fr/sih-public/sumaris/ngx-sumaris-components/-/issues',
+  forumUrl: null, //'https://forum.sumaris.net',
+  helpUrl: 'https://gitlab.ifremer.fr/sih-public/sumaris/sumaris-doc/-/blob/master/user-manual/index_fr.md',
+  privacyPolicyUrl: 'https://gitlab.ifremer.fr/sih-public/sumaris/sumaris-app/-/raw/master/doc/privacy_policy_fr.md',
+  termsOfUseUrl: 'https://gitlab.ifremer.fr/sih-public/sumaris/sumaris-app/-/raw/master/doc/terms_of_use_fr.md?ref_type=heads',
+
+  // Development
+  defaultAuthValues: {
+    // Token auth (using Person.pubkey)
+    username: 'admin@sumaris.net',
+    password: 'admin',
+  },
+
+  account: {
+    enableListenChanges: true,
+    listenIntervalInSeconds: 60,
+  },
+
+  entityEditor: {
+    enableListenChanges: true,
+    listenIntervalInSeconds: 60,
+  },
+});

package/src/global.scss

@@ -0,0 +1,13 @@
+@import "theme";
+@import "theme.variables";
+@import "print";
+
+* {
+  @include font-roboto();
+}
+
+:root {
+  ion-icon {
+    pointer-events: none !important;
+  }
+}

package/src/index.html

@@ -0,0 +1,76 @@
+<!doctype html>
+<html lang="en" dir="ltr">
+  <head>
+    <meta charset="utf-8" />
+    <title id="appTitle">Loading...</title>
+
+    <base href="/" />
+
+    <meta name="color-scheme" content="light dark" />
+    <meta name="theme-color" content="#4e8ef7" />
+    <meta
+      name="viewport"
+      content="viewport-fit=cover, width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width, minimal-ui"
+    />
+    <meta name="format-detection" content="telephone=no" />
+    <meta name="msapplication-tap-highlight" content="no" />
+
+    <link id="appFavicon" rel="icon" type="image/x-icon" href="/favicon.ico" />
+
+    <link rel="manifest" href="/manifest.json" />
+
+    <!-- add to homescreen for ios -->
+    <meta name="apple-mobile-web-app-capable" content="yes" />
+    <meta name="apple-mobile-web-app-status-bar-style" content="black" />
+
+    <!-- configure browser cache (need to load new version without reloading) -->
+    <meta http-equiv="Cache-Control" content="max-age=3600, must-revalidate" />
+    <meta http-equiv="Pragma" content="no-cache" />
+    <meta http-equiv="Expires" content="0" />
+    <meta http-equiv="If-Modified-Since" content="0" />
+
+    <!-- Loading (while app is loaded) -->
+    <link href="/assets/css/loading.css" rel="stylesheet" />
+
+    <meta property="og:title" content="SUMARiS App" />
+    <meta property="og:type" content="website" />
+    <meta property="og:description" content="Online database for fisheries data collection." />
+    <meta property="og:image" content="./assets/img/logo-menu2.png" />
+    <meta property="og:image:type" content="image/png" />
+    <meta property="og:image:height" content="211" />
+    <meta property="og:image:width" content="283" />
+    <meta property="og:site_name" content="SUMARiS App" />
+    <meta property="og:locale" content="en_GB" />
+    <meta property="og:locale:alternate" content="en_US" />
+    <meta property="og:locale:alternate" content="fr_FR" />
+  </head>
+
+  <body>
+    <!-- Ionic's root component and where the app will load -->
+    <app-root>
+      <div class="loading-page">
+        <div class="spinner">
+          <p id="loadingText"></p>
+          <div class="sk-cube1 sk-cube"></div>
+          <div class="sk-cube2 sk-cube"></div>
+          <div class="sk-cube4 sk-cube"></div>
+          <div class="sk-cube3 sk-cube"></div>
+        </div>
+      </div>
+
+      <!-- Translate the loading text -->
+      <script type="text/javascript">
+        try {
+          var userLang = navigator.language || navigator['userLanguage'];
+          var loadingText = userLang && userLang.startsWith('fr') ? 'Chargement...' : 'Loading...';
+          var loadingTextEle = document.getElementById('loadingText');
+          var appTitleEle = document.getElementById('appTitle');
+          if (loadingTextEle) loadingTextEle.innerText = loadingText;
+          if (appTitleEle) appTitleEle.innerText = loadingText;
+        } catch (err) {
+          console.error('[index] Cannot override appTitle and loadingText', err);
+        }
+      </script>
+    </app-root>
+  </body>
+</html>

package/src/main.ts

@@ -0,0 +1,18 @@
+import { enableProdMode } from '@angular/core';
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+import { environment } from './environments/environment';
+import { AppModule } from './app/app.module';
+import { defineCustomElements } from '@ionic/pwa-elements/loader';
+import { enableRxStateProdMode } from './app/shared/rx-state/rx-state.decorators';
+
+if (environment.production) {
+  enableProdMode();
+  enableRxStateProdMode();
+}
+
+platformBrowserDynamic()
+  .bootstrapModule(AppModule)
+  .catch((err) => console.log(err));
+
+// Call the element loader after the platform has been bootstrapped
+defineCustomElements(window).catch((err) => console.log(err));

package/src/polyfills.ts

@@ -0,0 +1,34 @@
+/**
+ * This file includes polyfills needed by Angular and is loaded before the app.
+ * You can add your own extra polyfills to this file.
+ *
+ * This file is divided into 2 sections:
+ *   1. Browser polyfills. These are applied before loading ZoneJS and are sorted by browsers.
+ *   2. Application imports. Files imported after ZoneJS that should be loaded before your main
+ *      file.
+ *
+ * The current setup is for so-called "evergreen" browsers; the last versions of browsers that
+ * automatically update themselves. This includes Safari >= 10, Chrome >= 55 (including Opera),
+ * Edge >= 13 on the desktop, and iOS 10 and Chrome on mobile.
+ *
+ * Learn more in https://angular.io/guide/browser-support
+ */
+
+/***************************************************************************************************
+ * BROWSER POLYFILLS
+ */
+
+/***************************************************************************************************
+ * APPLICATION IMPORTS
+ */
+// Import Hammer JS (need to manage 'tap' events)
+import 'hammerjs';
+
+// Force moment-timezone to be loaded here, otherwise moment.tz() will failed
+import 'moment';
+import 'moment-timezone';
+
+// Import swiper
+import { register as registerSwiperElements } from 'swiper/element/bundle';
+
+registerSwiperElements();