@dsivd/prestations-ng 15.5.13 → 16.0.0-beta10

package/UPGRADING_V16.md

@@ -0,0 +1,471 @@
+# PRESTAKIT : Upgrading from v15 to v16
+
+## PRESTATIONS-NG
+
+The main feature in `prestations-ng` v16 is the update of the `@angular/*` peer dependencies
+to `^15.1.1` and using `node 16+` to build.
+
+### Migrating to ESLint
+
+Follow [our migration guide](ESLINT_MIGRATION_GUIDE.md) to migrate your project from TSLint to ESLint
+
+### Running with node 16+
+#### Switch to node 16+
+##### If you are using our `slave-apps`
+
+Be sure to update your `slave-apps` git repository and then execute
+```bash
+node16
+```
+which should switch your node version to 16+
+
+##### If you are NOT using our `slave-apps`
+
+Be sure to use a node version 16+. To check your version, type the following command
+```bash
+node --version
+```
+which should print out a version 16+ otherwise, install a node 16+
+
+#### In your project
+
+Update your `package.json` to specify node engine
+```json
+{
+    "engines": {
+        "node": ">=16.15.0"
+    }
+}
+```
+
+#### In your build
+
+- Open your `jenkins` folder and update your jenkins files.
+- Define a variable if it does not already exist and add `nodeVersion: 16` then pass it on to the build.
+
+##### UT folder
+```groovy
+def args = [
+    nodeVersion: 16
+]
+
+stage('Build pipeline') {
+    buildPipeline(args)
+}
+```
+
+##### devex > snap folder
+```groovy
+def buildArgs = [
+    nodeVersion     : 16
+]
+
+stage('Snap2Devex Skeleton') {
+    snap2Devex(buildArgs)
+}
+```
+
+##### devex > stable folder
+```groovy
+def args = [
+    nodeVersion     : 16
+]
+
+stage('Stable2Devex') {
+    stable2Devex(args)
+}
+```
+
+### Updating Angular
+
+`prestations-ng` **v16+** now supports **Angular v15**. You can follow the Angular update guide
+at this address:
+
+-   [https://update.angular.io/?l=3&v=13.0-14.0](https://update.angular.io/?l=3&v=13.0-14.0)
+-   [https://update.angular.io/?l=3&v=14.0-15.0](https://update.angular.io/?l=3&v=14.0-15.0)
+
+#### When having migrated to ESLint
+```bash
+yarn global add @angular/cli@14
+ng update @angular/core@14 @angular/cli@14
+
+yarn global add @angular/cli@15
+ng update @angular/core@15 @angular/cli@15 --force
+ng update @angular-eslint/builder@15
+ng update @angular-eslint/eslint-plugin @angular-eslint/eslint-plugin-template @angular-eslint/template-parser
+ng update @typescript-eslint/eslint-plugin @typescript-eslint/parser
+ng update eslint-plugin-import eslint-plugin-jasmine eslint-plugin-jsdoc eslint-plugin-rxjs-angular
+ng update eslint
+ng update eslint-plugin-rxjs@5
+ng update \
+    @types/jasmine \
+    @types/node@16 \
+    ts-node@10
+ng update @dsivd/prestations-ng@latest
+
+yarn remove eslint-plugin-prefer-arrow
+yarn add eslint-plugin-simple-import-sort --dev
+yarn add eslint-import-resolver-typescript --dev
+# Remove your resolutions in package.json before executing 'yarn upgrade'
+yarn upgrade
+```
+
+### Update "package.json" file to replace tilde(~) by caret(^) on following dependencies to be aligned with prestations-ng library
+
+- core-js
+- dayjs
+- ng-http-loader
+- ngx-image-cropper
+- rxjs
+- zone.js
+
+Then run
+```bash
+yarn install
+```
+
+### Update ".eslintrc.json" file if your project was already migrated to ESLint
+
+Replace your current `.eslintrc.json` file by the one found in [ESLINT_MIGRATION.GUIDE](ESLINT_MIGRATION_GUIDE.md#customizing_eslint__inspired_from_otia_and_prestations-ng_s_files_for_rules_)
+
+Then run
+```bash
+ng lint --fix=true
+```
+and finally fix manually remaining errors
+
+### Cleanup your project due to CLI improvements
+
+See section "CLI improvements" in angular's blog (https://blog.angular.io/angular-v15-is-now-available-df7be7f2f4c8)
+
+#### Remove files/folder from your project
+
+- delete `/src/polyfills.ts` file
+- delete `/src/test.ts` file
+- delete `/src/environments` folder
+
+#### Update your `main.ts` file
+```diff
+-import { enableProdMode } from '@angular/core';
+-import { environment } from './environments/environment';
+
+-if (environment.production) {
+-   enableProdMode();
+-}
+```
+
+#### Update your `angular.json` file
+```diff
+{
+    "projects": {
+        "[YOUR_PROJECT_NAME]": {
+            "architect": {
+                "build": {
+                    "options": {
+-                       "polyfills": "src/polyfills.ts",
++                       "polyfills": [
++                           "zone.js"
++                       ],  
+                    },
+                    "configurations": {
+                        "production": {
+-                           "fileReplacements": [
+-                               {
+-                                   "replace": "src/environments/environment.ts",
+-                                   "with": "src/environments/environment.prod.ts"
+-                               }
+-                           ]
+                        }
+                    }
+                },
+                "test": {
+                    "options": {
+-                       "main": "src/test.ts",
+-                       "polyfills": "src/polyfills.ts",
++                       "polyfills": [
++                           "zone.js",
++                           "zone.js/testing"
++                       ],
+                    }
+                }
+            }
+        }
+    }
+}
+```
+#### Update your `tsconfig.app.json` file
+```diff
+{
+    "files": [
+        "main.ts",
+-       "polyfills.ts"
+    ],
+}
+```
+
+#### Update your `tsconfig.spec.json` file
+```diff
+{
+-   "files": [
+-       "test.ts",
+-       "polyfills.ts"
+-   ],
+}
+```
+
+### Update `allowedCommonJsDependencies` in your `angular.json` file to add `dayjs`
+
+```diff
+{
+    "projects": {
+        "[YOUR_PROJECT_NAME]": {
+            "architect": {
+                "build": {
+                    "options": {
+                        "allowedCommonJsDependencies": [
+                            "core-js/modules/es.array.includes",
+                            "iban",
+-                           "zone.js/dist/zone-error"
++                           "zone.js/dist/zone-error",
++                           "dayjs"
+                        ],  
+                    },
+                }
+            }
+        }
+    }
+}
+```
+
+### HttpClientModule (`app.module.ts`)
+
+Need to import only once PrestationsNgCoreModule (containing HttpClientModule) in root module and not in lazy modules.
+Need to import only once HttpClientModule in root module done by PrestationsNgCoreModule.
+See 'Usage note' in https://angular.io/api/common/http/HttpInterceptor
+
+```diff
+@NgModule({
+    imports: [
+-       HttpClientModule,
+        NgHttpLoaderModule.forRoot()
+    ]
+})
+```
+
+### Use HTTP_LOADER_FILTERED_URL in your application to filter URLs in ng-http-loader component
+
+- `app.component.ts`: Add a public variable `HTTP_LOADER_FILTERED_URL = HTTP_LOADER_FILTERED_URL;`
+- `app.component.html`: Use the previous variable in `[filteredUrlPatterns]` attribute of `ng-http-loader` (`<ng-http-loader [filteredUrlPatterns]="HTTP_LOADER_FILTERED_URL"></ng-http-loader>`)
+
+### Rename your application page wrapper
+
+Rename your application page wrapper (the one containing your `foehn-page`) folder into `page-wrapper` along with it's `.html` and `.ts` files.
+
+### Remove protractor and E2E tests
+
+We do not use E2E tests in our applications. If you feel the need to have some, please use `Cypress` (https://docs.cypress.io/guides/getting-started/installing-cypress).
+
+#### Remove protractor dependency
+
+Since **Angular v12**, **protractor** has been **deprecated** (https://blog.angular.io/the-state-of-end-to-end-testing-with-angular-d175f751cb9c).
+```bash
+yarn remove protractor
+```
+Then delete file `front/protractor.conf.js`
+
+#### Remove E2E test
+
+- Delete folder `front/e2e`
+- Remove `e2e/tsconfig.e2e.json` from `.eslintrc.json` file
+```diff
+{
+    "overrides": [
+        // Typescript
+        {
+            "files": ["*.ts"],
+            "parserOptions": {
+                "project": [
+                    "tsconfig.json",
+-                   "e2e/tsconfig.e2e.json"
+                ],
+            }
+        }
+    ]
+}
+```
+- Remove script `"e2e": "ng e2e"` in `package.json` file
+```diff
+{
+  "scripts": {
+    "ng": "ng",
+    "start": "ng serve",
+    "build": "ng build --configuration production",
+    "test": "ng test",
++   "lint": "ng lint"
+-   "lint": "ng lint",
+-   "e2e": "ng e2e"
+  }
+}
+```
+- Remove E2E project from `angular.json` file
+```diff
+{
+  "projects": {
+-   "[YOUR_PROJECT_NAME]-e2e": {
+-     "root": "e2e",
+-     "sourceRoot": "e2e",
+-     "projectType": "application",
+-     "architect": {
+-       "e2e": {
+-         "builder": "@angular-devkit/build-angular:protractor",
+-         "options": {
+-           "protractorConfig": "./protractor.conf.js",
+-           "devServerTarget": "skeleton:serve"
+-         }
+-       },
+-       "lint": {
+-         "builder": "@angular-eslint/builder:lint",
+-         "options": {
+-           "lintFilePatterns": [
+-             "e2e/**/*.ts",
+-             "e2e/**/*.html"
+-           ]
+-         }
+-       }
+-     }
+-   }
+- },
+}
+```
+
+### Use puppeteer when running tests
+
+#### Add puppeteer dependency
+```bash
+yarn add puppeteer --dev
+```
+
+#### Update `karma.conf.js` file
+```diff
++process.env.CHROMIUM_BIN = require('puppeteer').executablePath();
+
+module.exports = function(config) {
+  config.set({
+```
+
+#### Cleanup your jenkins files
+
+Remove `chromium-headless` label attribute on your args.
+
+##### UT folder
+```diff
+def args = [
+    nodeVersion: 16,
+-   label: 'chromium-headless'
+]
+```
+##### devex > snap folder
+```diff
+def buildArgs = [
+    nodeVersion     : 16,
+-   label: 'chromium-headless'
+]
+```
+##### devex > stable folder
+```diff
+def args = [
+    nodeVersion     : 16,
+-   label: 'chromium-headless'
+]
+```
+
+### Deprecated features
+#### Checkables
+
+For all components extending FoehnCheckableGroupComponent such as:
+- foehn-autocomplete
+- foehn-checkbox
+- foehn-radio
+- foehn-select
+- or your custom components
+
+we have removed `@Input() allElementDisabled` to replace it by `@Input() disabled`.
+
+See below exemple on our `foehn-radio` component:
+```diff
+<foehn-radio
+
+-   [allElementDisabled]="true"
++   [disabled]="true"
+
+></foehn-radio>
+```
+
+#### Uploaders
+- [foehn-bo-multi-upload.component.ts](projects/prestations-ng/src/foehn-upload/foehn-bo-multi-upload/foehn-bo-multi-upload.component.ts)
+- [foehn-multi-upload.component.ts](projects/prestations-ng/src/foehn-upload/foehn-multi-upload/foehn-multi-upload.component.ts)
+    - remove `[overrideMaxSizeInMo]="xx"`. Now managed by the backend (see `DocumentProperties.fileMaxSizeByFormKey`)
+
+### Last but not least, check if your application is working!!!
+```bash
+yarn build
+yarn start
+```
+
+## PRESTATIONS-BE
+### Library upgrade
+
+see https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.7-Release-Notes#upgrading-from-spring-boot-26
+
+if you're using `org.springframework.boot.spring-boot-starter-parent` :
+```diff
+  <parent>
+    <groupId>org.springframework.boot</groupId>
+    <artifactId>spring-boot-starter-parent</artifactId>
+-    <version>2.6.x</version>
++    <version>2.7.x</version>
+    <relativePath />
+  </parent>
+```
+
+```diff
+- <prestations-be.version>15.x.x</prestations-be.version>
++ <prestations-be.version>16.x.x</prestations-be.version>
+```
+
+if you're using `ch.vd.cyber.parent.application-parent
+```diff
+<parent>
+    <groupId>ch.vd.cyber.parent</groupId>
+    <artifactId>application-parent</artifactId>
+-    <version>11.x.x</version>
++    <version>12.x.x</version>
+    <relativePath/>
+</parent>
+```
+
+### WebServiceProperties
+You should migrate your technical user (`webservice.username`) to a MiZo generated user.
+Ask your **Intégrateur référent** if you're not sure.
+
+### Ref-inf
+
+When using refinf :
+```diff
+- refinf.baseUrl=https://int-esgate.vd.ch/refinf-rf/v5
++ cyber-cache.base-url=https://int-esgate.vd.ch/cybercache-in
+```
+
+When not using refinf (and SdkConfig.class is imported)
+```diff
+- refinf.configuration.enabled=false
++ cyber-cache.configuration.enabled=false
+```
+
+### DocumentProperties
+if you're having one or more uploader, you have to define the max size for a file on each uploader  in your `application.properties` :
+i.e. `document.file-max-size-by-form-key.identityCard=5MB`
+
+### Verification page
+When possible, the verification page should use the same data as the confirmation PDF
+see example in skeleton : https://dsigit.etat-de-vaud.ch/outils/git/projects/CYBSDK/repos/skeleton/browse/front/src/app/verification-page

package/abstract-page-component.d.ts

@@ -1,16 +1,16 @@
 import { AfterViewInit, OnDestroy, OnInit } from '@angular/core';
-import { GesdemHandlerService } from './gesdem/gesdem-handler.service';
-import { FoehnNavigationService } from './foehn-navigation/foehn-navigation.service';
-import { FoehnFormComponent } from './foehn-form/foehn-form.component';
-import { Observable, Subscription } from 'rxjs';
 import { ActivatedRoute } from '@angular/router';
-import { GrowlBrokerService } from './foehn-growl/growl-broker.service';
-import { ValidationHandlerService } from './validation/validation-handler.service';
-import { GesdemEventService } from './gesdem/gesdem-event.service';
+import { Observable, Subscription } from 'rxjs';
 import { BreadcrumbEventService } from './foehn-breadcrumb/breadcrumb-event.service';
+import { FoehnFormComponent } from './foehn-form/foehn-form.component';
+import { GrowlBrokerService } from './foehn-growl/growl-broker.service';
+import { FoehnNavigationService } from './foehn-navigation/foehn-navigation.service';
 import { FoehnPageService } from './foehn-page/foehn-page.service';
+import { GesdemEventService } from './gesdem/gesdem-event.service';
+import { GesdemHandlerService } from './gesdem/gesdem-handler.service';
 import { I18nForm } from './i18n-form';
 import { SdkDictionaryService } from './sdk-dictionary/sdk-dictionary.service';
+import { ValidationHandlerService } from './validation/validation-handler.service';
 import * as i0 from "@angular/core";
 export declare abstract class AbstractPageComponent<T extends I18nForm> implements OnInit, OnDestroy, AfterViewInit {
     protected activatedRoute: ActivatedRoute;
@@ -51,5 +51,5 @@ export declare abstract class AbstractPageComponent<T extends I18nForm> implemen
     private gotToTop;
     abstract newForm(): T;
     static ɵfac: i0.ɵɵFactoryDeclaration<AbstractPageComponent<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractPageComponent<any>, never, never, {}, {}, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractPageComponent<any>, never, never, {}, {}, never, never, false, never>;
 }

package/directives/currency-formatter.directive.d.ts

@@ -1,6 +1,9 @@
 import { NgZone, OnInit } from '@angular/core';
 import { FoehnInputNumberComponent } from '../foehn-input/foehn-input-number.component';
 import * as i0 from "@angular/core";
+export declare function formatNumberAsGiven(value: string): string;
+export declare function formatDecimalCurrency(value: string, maxDecimalCount: number, maxLength: number, allowFreeInput: boolean): string;
+export declare function formatNonDecimalCurrency(value: string): string;
 export declare class NumberCurrencyFormatterDirective implements OnInit {
     private host;
     private ngZone;
@@ -13,5 +16,5 @@ export declare class NumberCurrencyFormatterDirective implements OnInit {
     private setFormatting;
     private hasValueChanged;
     static ɵfac: i0.ɵɵFactoryDeclaration<NumberCurrencyFormatterDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NumberCurrencyFormatterDirective, "[numberCurrencyFormatter]", never, {}, {}, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<NumberCurrencyFormatterDirective, "[numberCurrencyFormatter]", never, {}, {}, never, never, false, never>;
 }

package/directives/iban-formatter.directive.d.ts

@@ -6,5 +6,5 @@ export declare class IbanFormatterDirective {
     onBlur(value: string): void;
     private formatIban;
     static ɵfac: i0.ɵɵFactoryDeclaration<IbanFormatterDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<IbanFormatterDirective, "[ibanFormatter]", never, {}, {}, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<IbanFormatterDirective, "[ibanFormatter]", never, {}, {}, never, never, false, never>;
 }

package/directives/ide-formatter.directive.d.ts

@@ -14,5 +14,5 @@ export declare class IdeFormatterDirective {
      */
     private formatIde;
     static ɵfac: i0.ɵɵFactoryDeclaration<IdeFormatterDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<IdeFormatterDirective, "[ideFormatter]", never, {}, {}, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<IdeFormatterDirective, "[ideFormatter]", never, {}, {}, never, never, false, never>;
 }

package/directives/ndc-formatter.directive.d.ts

@@ -21,5 +21,5 @@ export declare class NDCFormatterDirective {
      */
     private formatNDC;
     static ɵfac: i0.ɵɵFactoryDeclaration<NDCFormatterDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NDCFormatterDirective, "[ndcFormatter]", never, {}, {}, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<NDCFormatterDirective, "[ndcFormatter]", never, {}, {}, never, never, false, never>;
 }