@anglr/common 8.0.0-beta.20211217130754 → 9.0.0-beta.20220215123148

package/appveyor.yml

@@ -0,0 +1,67 @@
+image: Visual Studio 2019
+
+environment:
+  nodejs_version: "12"
+
+branches:
+  only:
+    - /^\d+\.\d+/
+    - /^v\d+\.\d+\.\d+/
+
+init:
+  - ps: |
+      Install-Product node $env:nodejs_version
+      "//registry.npmjs.org/:_authToken=$env:npm_auth_token`n" | out-file "$env:userprofile\.npmrc" -Encoding ASCII
+
+cache:
+  - node_modules
+
+install:
+  - cmd: npm install --loglevel error
+  - cmd: npm run clean
+
+build: off
+
+build_script:
+  - ps: |
+      $env:NGV_BUILD_NUMBER = $env:APPVEYOR_BUILD_NUMBER
+      
+      #stable version build
+      if($env:APPVEYOR_REPO_TAG -eq "true")
+      {
+        $env:APPVEYOR_REPO_TAG_NAME -match "^v(\d+\.\d+)\.\d+"
+        git checkout "$($Matches[1])" -q
+
+        npm run version:build
+        Update-AppveyorBuild -Version "$(cat version.bak)"
+
+        $env:NGV_BUILD_NUMBER = -1
+        npm run deploy
+
+        #release on github
+        $match = [System.Text.RegularExpressions.Regex]::Match((Get-Content "./changelog.md" -Encoding UTF8 | Out-String).TrimEnd(), "## Version \d+\.\d+\.\d+ (?<date>\(\d+-\d+-\d+\))(?<content>.*?)(?:## Version|`$)", [System.Text.RegularExpressions.RegexOptions]::Singleline)
+
+        Set-AppveyorBuildVariable 'Changelog' $match.Groups["content"].Value
+        Set-AppveyorBuildVariable 'ChangeDate' $match.Groups["date"].Value
+      }
+      else
+      {
+        git checkout $env:APPVEYOR_REPO_BRANCH -q
+
+        npm run version:build
+        Update-AppveyorBuild -Version "$(cat version.bak)"
+
+        $env:NGV_BUILD_NUMBER = -1
+        npm run deploy:next
+      }
+      
+  - ps: Update-AppveyorBuild -Version "$(cat version.bak)"
+
+deploy:
+  - provider: GitHub
+    description: '$(Changelog)'
+    auth_token:
+      secure: FOD7P4H4NF3p30wWrc/CUbtuP1YDUtMGeJgiHGo9P8uwpf+fBcKLxLZ/CLCjTsx1
+    force_update: true
+    on:
+      APPVEYOR_REPO_TAG: true

package/changelog.md

@@ -1,32 +1,26 @@
 # Changelog
 
-## Version 8.0.0 (2021-12-17)
+## Version 9.0.0 (2022-02-15)
 
 ### Bug Fixes
 
 - fixed `RestSinkService` calling `setInterval` only after application is stable
-- fixed `ComponentRoute`, now accepts `ComponentRouteDefinition` new route definition without `component` as it should be
 
 ### Features
 
 - `DataRouter` can now be used inside of `Resolve` of *route*
 - added new `ClickOutsideDirective` which allows changing value of boolean if user clicks outside of selected element, or provided element, part of `ClickOutsideModule`
-- updated `ProgressInterceptor`, which now supports local progress indicator using `httpContext` with `PROGRESS_INDICATOR_GROUP_NAME` token
-- added new `PROGRESS_INDICATOR_GROUP_NAME` http context token used for passing progress indicator group name for local progress indicator
-- added new `IGNORED_INTERCEPTORS` http context token storing array of ignored interceptors types
+- added code that modifies `HttpRequest` prototype `clone` method, adds support for cloning also `additionalInfo`
+- added new `AdditionalInfo` generic interface, which allows definition of additional data
+- updated `ProgressInterceptor`, which now supports local progress indicator using `additionalInfo` with `LocalProgressIndicatorName`
+- added new `LocalProgressIndicatorName` interface as type for additionalInfo with `progressGroupName`
+- added new `updateHttpRequestClone` function, that needs to be called to make `additionalInfo` working correctly with `HttpRequest`
 - added new `MultiButtonComponent` class used for displaying multibutton
 - added new `MultiButtonCssClasses` interface that describes multi button css classes
 - added new `MULTI_BUTTON_CSS_CLASSES` injection token for default css classes for multibutton
 - added new `MultiButtonModule` module containing components for displaying multi button
 - fixed `DebugDataEnabledService.setEnabled()` now triggers `enabledChange` only when there is change of `enabled` value
 - improved `DebugDataComponent` new styling, `display: none` when not enabled, `.clickable` css class
-- added new `GoBackModule` module for *GoBack* directive
-- added new `GoBackDirective` directive that performs browser back button action on click
-- added new `MergeCssClassesPipe` that merges css classes that will be passed to ngClass
-- added new `NgClassType` type of css class definition for NgClass and merge used within `MergeCssClassesPipe`
-- added new `CommonDynamicModule` for `NgComponentOutletEx` directive
-- added new `CommonLocalizeModule` for `LocalizePipe` pipe
-- added new `CommonUtilsModule` for `IsNaNPipe`, `IsPresentPipe`, `UrlEncodePipe`, `MergeCssClassesPipe` pipes
 - added new **Notifications**
    - added new `NOTIFICATIONS` `InjectionToken` used for injecting notifications service implementation
    - added new `NOTIFICATIONS_SCOPE` `InjectionToken` used for injecting notifications scope name
@@ -39,8 +33,6 @@
    - added new `NotificationsProvider` as notifications provider that allows to create scoped notifications provider
    - added new `DefaultNotificationsService` default notifications service implementation
    - added new `DEFAULT_NOTIFICATIONS` as default notifications provider
-- *subpackage* `@anglr/common/hotkeys`
-   - updated `AppHotkeysService` added `ngOnDestroy` which wraps existing `destroy` method
 - *subpackage* `@anglr/common/material`
    - added new `ConfirmationDialogComponent` confirmation dialog component
    - added new `ConfirmationDialogDirective` directive that enables confirmation dialog on click
@@ -118,7 +110,7 @@
    - added new `prepareForFormBuilder` function that prepares object for form builder, wraps each property in array
    - added new `readEncodedFilter` function that reads filter value from encoded string
    - added new **Form Model Builder**
-      - added new `buildFormModel` method for building `FormGroup` from *decorated model*, only for properties with non `undefined` value
+      - added new `buildFormModel` method for building `FormGroup` from *decorated model*
       - added new `ValidatorFnFactory` and `AsyncValidatorFnFactory` as factories for `validationFn` and `asyncValidationFn` respectively with arguments from component context
       - added new `CurrentValue` class which allows obtaining of current value when needed from component context
       - added new `getCurrentValue` which should be used for obtaining argument current value in `ValidatorFnFactory` or `AsyncValidatorFnFactory`
@@ -150,23 +142,170 @@
 
 ### BREAKING CHANGES
 
-- minimal supported version of *Angular* is `13.1.0`
-- minimal supported version of `@jscrpt/common` is `2.2.0`
-- compiled as *Angular IVY* **only** with new *APF*
-- removed support of *es5* target and using latest package.json features
-- removed dependency `@anglr/types`, all mising types used directly here
-- dropped support of `Node.js <= 12.20`
-- removed `HttpRequestIgnoredInterceptorId` interface, now using builtin `HttpContextToken` named `IGNORED_INTERCEPTORS`
-- removed `IgnoredInterceptorId`, now using buildin `HttpContextToken` named `IGNORED_INTERCEPTORS`
-- removed `IgnoredInterceptorsService`, now using buildin `HttpContextToken` named `IGNORED_INTERCEPTORS`
+- minimal supported version of *Angular* is `10.0.0`
+- minimal supported version of `@jscrpt/common` is `1.2.0`
+- removed `HttpRequestIgnoredInterceptorId` interface, explicitly using type unions where needed, `HttpRequest<any> & AdditionalInfo<IgnoredInterceptorId>`
+- changed `IgnoredInterceptorId` to generic `AdditionalInfo`, allowing broader usage
+- renamed `SERVER_BASE_URL` to `HTTP_REQUEST_BASE_URL`
+- renamed `SERVER_COOKIE_HEADER` to `HTTP_REQUEST_COOKIE_HEADER`
+- renamed `SERVER_AUTH_HEADER` to `HTTP_REQUEST_AUTH_HEADER`
+- refactored `DataRouter`, deprecated DataRouterData, use `DataRouter` `valuePromise` directly
+- `CookieService` now using `HTTP_REQUEST_COOKIE_HEADER` instead of `SERVER_COOKIE_HEADER`
+- *subpackage* `@anglr/common/forms`
+   - `RequiredClassDirective` moved to separate module `RequiredClassModule`
+   - refactored `HasErrorDirective`, changed constructor parameters
+   - removed `HAS_ERROR_OPTIONS` token, replaced by `VALIDATION_ERROR_RENDERER_FACTORY_OPTIONS`
+   - renamed `HAS_ERROR_DEFAULT_MESSAGES` to `VALIDATION_ERROR_MESSAGES`
+
+## Version 8.0.0 (2021-11-26)
+
+### Bug Fixes
+
+- fixed `RestSinkService` calling `setInterval` only after application is stable
+
+### Features
+
+- `DataRouter` can now be used inside of `Resolve` of *route*
+- added new `ClickOutsideDirective` which allows changing value of boolean if user clicks outside of selected element, or provided element, part of `ClickOutsideModule`
+- added code that modifies `HttpRequest` prototype `clone` method, adds support for cloning also `additionalInfo`
+- added new `AdditionalInfo` generic interface, which allows definition of additional data
+- updated `ProgressInterceptor`, which now supports local progress indicator using `additionalInfo` with `LocalProgressIndicatorName`
+- added new `LocalProgressIndicatorName` interface as type for additionalInfo with `progressGroupName`
+- added new `updateHttpRequestClone` function, that needs to be called to make `additionalInfo` working correctly with `HttpRequest`
+- added new `MultiButtonComponent` class used for displaying multibutton
+- added new `MultiButtonCssClasses` interface that describes multi button css classes
+- added new `MULTI_BUTTON_CSS_CLASSES` injection token for default css classes for multibutton
+- added new `MultiButtonModule` module containing components for displaying multi button
+- fixed `DebugDataEnabledService.setEnabled()` now triggers `enabledChange` only when there is change of `enabled` value
+- improved `DebugDataComponent` new styling, `display: none` when not enabled, `.clickable` css class
+- added new **Notifications**
+   - added new `NOTIFICATIONS` `InjectionToken` used for injecting notifications service implementation
+   - added new `NOTIFICATIONS_SCOPE` `InjectionToken` used for injecting notifications scope name
+   - added new `NotificationsOptions` as configuration object that is used by `Notifications` default implementation
+   - added new `NotificationSeverity` as severity of notification message
+   - added new `Notification` as instance of notification that is being displayed
+   - added new `Notifications` interface that manages currently displayed notifications
+   - added new `NotificationsScopeProvider` as tuple that will hold notification provider and notifications scope provider
+   - added new `NotificationsScopeProviderFactory` as factory for creating `NotificationsScopeProvider`
+   - added new `NotificationsProvider` as notifications provider that allows to create scoped notifications provider
+   - added new `DefaultNotificationsService` default notifications service implementation
+   - added new `DEFAULT_NOTIFICATIONS` as default notifications provider
+- *subpackage* `@anglr/common/material`
+   - added new `ConfirmationDialogComponent` confirmation dialog component
+   - added new `ConfirmationDialogDirective` directive that enables confirmation dialog on click
+      - `Inputs`
+         - `confirmation` - confirmation text that is displayed in dialog
+         - `confirmationTitle` - title for confirmation dialog
+         - `confirmationConfirm` - text for confirm confirmation button
+         - `confirmationCancel` - text for cancel confirmation button
+         - `confirmationCssClasses` - object with css classes to be applied to confirmation dialog component
+         - `skipConfirmation` - condidition that determines whether display confirmation dialog or skip it and run confirm directly
+         - `preventDefaultsAndPropagation` - indication whether prevent default and stop propagation of click event, defaults to `true`
+      - `Outputs`
+         - `confirm` - occurs when user confirms confirmation
+   - added new `CONFIRMATION_DIALOG_OPTIONS` injection token used for setting global default options for confirmation dialog
+   - added new `ConfirmationDialogOptions` options for confirmation dialog component
+      - `confirmationText` - text that is displayed as confirmation text (localization constant)
+      - `dialogCancelText` - text that is displayed as cancel button text (localization constant)
+      - `dialogConfirmText` - text that is displayed as confirm button text (localization constant)
+      - `cssClasses` - css classes for confirmation dialog component
+   - added new `ConfirmationDialogCssClasses` css classes for confirmation dialog component
+      - `buttonsContainerDiv` - css classes applied to container div containing buttons
+      - `closeButton` - css classes applied to close button
+      - `closeButtonIcon` - css classes applied to close button icon span
+      - `confirmButton` - css classes applied to confirm button
+      - `confirmButtonIcon` - css classes applied to confirm button icon span
+   - added new `ConfirmationDialogModule` module as module containing confirmation dialog component and directive
+   - added new `DebugDataCopyClickDirective` that allows to copy data to clipboard on click on `<debug-data>`
+   - added new `DebugDataCopyClickModule` as module for debug data copy click directive
+- added *subpackage* `@anglr/common/date-fns`
+- *subpackage* `@anglr/common/date-fns`
+   - `readEncodedFilterWithDates` function that reads filter value from encoded string, deserialize date properties into date
+- *subpackage* `@anglr/common/moment` 
+   - added new `readEncodedFilterWithDates` function that reads filter value from encoded string, deserialize date properties into moment
+- *subpackage* `@anglr/common/store`
+   - added new `SessionTemporaryStorageService` as `TemporaryStorage` implementation using *Session*
+- *subpackage* `@anglr/common/positions`
+   - added new parameter `flipCallback` to `positionsWithFlip`, which is called when flip occurs during positioning
+   - added new `FLIP_DIRECTION` type defining direction of occured flip, used as parameter to `flipCallback`
+   - added new `PositionToDirective` which allows positioning elements relative to each other, part of `PositionsModule`
+   - added new `TooltipModule` which allows user to use *tooltip* directives and components
+   - added new `TooltipDirective` that allows user to use *tooltip* attribute to create tooltip
+      - added new `TooltipOptions` which allows to customize *tooltip*
+         - `delay` - delay for displaying of tooltip on hover
+         - `fixedPosition` - indication whether is tooltip displayed at fixed position, or if it is displayed where cursor enters element
+         - `elementPositionAt` - position where should be tooltip displayed at element
+         - `tooltipPosition` - position of tooltip where should placed at
+         - `allowSelection` - allows selection of text in tooltip
+         - `tooltipCssClass` - css class that is applied to tooltip renderer component
+         - `tooltipRenderer` - type of tooltip renderer that is used for rendering tooltip
+         - `stopPropagation` - indication whether stop propagation of "hover" event
+   - added new `TooltipRenderer` as representation of component that is used for rendering tooltip
+   - added new `TooltipComponent` as default component implementing `TooltipRenderer`
+   - added new `TOOLTIP_OPTIONS` injection token used for injecting tooltip options
+- *subpackage* `@anglr/common/structured-log`
+   - added new `RestSinkService` as `Sink` implementation that allows storing logs using `LoggerRestClient`
+   - added new `LoggerRestClient` interface, if implemented and provided using `LOGGER_REST_CLIENT` allows storing logs using REST
+   - added new `RestSinkConfigService` used as configuration for `RestSinkService`, allows setting log level, interval, log count for flushing, also possible to set log level for immediate flush
+   - added new `REST_SINK` provider for providing `RestSinkService` as `Sink`
+- *subpackage* `@anglr/common/forms`
+   - added new `RequiredClassModule` containing `RequiredClassDirective`
+   - completely refactored `HasErrorDirective`, now also supports custom component for rendering errors
+   - added `ValidationErrorsResult` as type holding validation error results
+   - added new `ErrorMessagesExtractor` that is used as service used for obtaining validation error messages and validation errors in form of `ValidationErrorsResult`
+   - added new types
+      - `IsSubmittedOrDirtyFunc` - Describes function that is used for performing actions when form is submitted or dirty
+      - `ValidationErrorsComponent` - Component that is used for rendering validation errors
+      - `ValidationErrorsTemplateContext` - Context passed to template that is used for rendering validation errors
+      - `ValidationErrorsRendererOptions` - Options for ValidationErrorRenderer
+      - `ValidationErrorRendererFactoryOptions` - Options for ValidationErrorRendererFactory
+      - `ValidationErrorRendererCtor` - Describes type that represents ValidationErrorRenderer
+      - `ValidationErrorRenderer` - Describes service that is used for rendering validation errors
+   - added new `ValidationErrorRendererFactory` that is used for obtaining validation error renderer implementation
+   - added new `DefaultValidationErrorRenderer` which is default implementation of validation error renderer
+   - added new `VALIDATION_ERROR_RENDERER_FACTORY_OPTIONS` which is used for obtaining renderer factory options using DI
+   - added new `prepareForFormBuilder` function that prepares object for form builder, wraps each property in array
+   - added new `readEncodedFilter` function that reads filter value from encoded string
+   - added new **Form Model Builder**
+      - added new `buildFormModel` method for building `FormGroup` from *decorated model*
+      - added new `ValidatorFnFactory` and `AsyncValidatorFnFactory` as factories for `validationFn` and `asyncValidationFn` respectively with arguments from component context
+      - added new `CurrentValue` class which allows obtaining of current value when needed from component context
+      - added new `getCurrentValue` which should be used for obtaining argument current value in `ValidatorFnFactory` or `AsyncValidatorFnFactory`
+      - added new `ModelDecoratorMetadata` interface describing metadata for whole model
+      - added new `ModelPropertyDecoratorMetadata` interface describing metadata for model of single property
+      - added new `ModelPropertyOptions` type that represents options that can be passed to control represented by model property
+      - added new `ValidatorFnFactoryFn` and `AsyncValidatorFnFactoryFn` interfaces describing factory functions for validators functions
+      - added validations *decorators*
+         - `Email` - validation of email
+         - `MinLength` - validation of min string length
+         - `MaxLength` - validation of max string length
+         - `MinValue` - validation of min number value
+         - `MaxValue` - validation of max number value
+         - `Number` - validation for number
+         - `Pattern` - validation for reqular expression pattern
+         - `Required` - validation for mandatory value
+         - `RequiredIf` - conditional validation for mandatory value
+      - added *decorators*
+         - `InvalidateOnChange` - allows invalidation of sibling `FormControl`s on changes of `FormControl` value
+         - `ControlOptions` - allows to set control options for property
+         - `AsyncValidator` - allows setting of `AsyncValidatorFn`
+         - `Validator` - allows setting of `ValidatorFn`
+         - `Disabled` - sets control as disabled
+         - `FormGroupAsyncValidator` - allows setting of `AsyncValidatorFn` for whole `FormGroup`
+         - `FormGroupValidator` - allows setting of `ValidatorFn` for whole `FormGroup`
+         - `FormGroupProperty` - indicating that property is `FormGroup`
+         - `FormArrayProperty` - indicating that property is `FormArray`
+         - `ModelPropertyMetadata` - allows setting of `ModelPropertyDecoratorMetadata` for property
+
+### BREAKING CHANGES
+
+- minimal supported version of *Angular* is `10.0.0`
+- minimal supported version of `@jscrpt/common` is `1.2.0`
+- removed `HttpRequestIgnoredInterceptorId` interface, explicitly using type unions where needed, `HttpRequest<any> & AdditionalInfo<IgnoredInterceptorId>`
+- changed `IgnoredInterceptorId` to generic `AdditionalInfo`, allowing broader usage
 - renamed `SERVER_BASE_URL` to `HTTP_REQUEST_BASE_URL`
 - renamed `SERVER_COOKIE_HEADER` to `HTTP_REQUEST_COOKIE_HEADER`
 - renamed `SERVER_AUTH_HEADER` to `HTTP_REQUEST_AUTH_HEADER`
-- removed `CommonModule` in favor of new more specific modules `CommonDynamicModule`, `CommonLocalizeModule`, `CommonUtilsModule`
-- removed not working `HmrData` decorator
-- removed not working `HmrServiceData` decorator
-- removed not working `HmrServiceDataConstructor` decorator
-- from `NgComponentOutletEx` removed `ngComponentOutletExNgModuleFactory` property which is useless for IVY
 - refactored `DataRouter`, deprecated DataRouterData, use `DataRouter` `valuePromise` directly
 - `CookieService` now using `HTTP_REQUEST_COOKIE_HEADER` instead of `SERVER_COOKIE_HEADER`
 - *subpackage* `@anglr/common/forms`
@@ -174,10 +313,6 @@
    - refactored `HasErrorDirective`, changed constructor parameters
    - removed `HAS_ERROR_OPTIONS` token, replaced by `VALIDATION_ERROR_RENDERER_FACTORY_OPTIONS`
    - renamed `HAS_ERROR_DEFAULT_MESSAGES` to `VALIDATION_ERROR_MESSAGES`
-- *subpackage* `@anglr/common/hmr`
-   - removed `hmrAccept` function, replaced by built in Angular loader
-- *subpackage* `@anglr/common/numeral`
-   - for `NumeralPipe` pipe `transform` has strict `format` parameter of type `string`
 
 ## Version 7.3.2 (2020-05-15)