Index

libs/ngx-pfe/pfe-conditions/conditions.model.ts

BaseOrExpressionCondition

Help type to include all the possible types that can have an array

PfeBaseCondition | DefaultCondition | ExpressionCondition
Condition

A single condition. Includes the legacy and new conditions.

PfeBaseCondition | DefaultCondition | ExpressionCondition | ConditionAdvanced
ConditionEvaluatorFunction
function
Conditions

The legacy ExpressionCondition and ConditionAdvanced, including also the PfeBaseCondition[]

BaseOrExpressionCondition[] | ConditionAdvanced
DefaultCondition

Conditions that are available by default

PfeAndCondition | PfeOrCondition | PfeExpressionCondition

libs/ngx-pfe/util/typescript/strict-function-types.ts

BivariantCallbackFunction

Strict mode in typescript also activates the strictFunctionTypes. See: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-6.html

This means, that it turns functions as parameters from bivariant (contravariant or covariant = subtypes allowed in the parameters of the functions) to contravariant (not allowed).

As this does not apply to methods, the BivariantCallbackFunction type can be used to disable the contravariance for functions that are used as parameters.

A concrete example why this workaround was introduced: The PfeActionFunction expects a function with this signature: (actionConfig: PfeBaseActionConfig) => Promise<void | boolean> A concrete implementation of a PfeActionFunction is going to use a more specific derived type for the PfeBaseActionConfig. With contravariance, this is not allowed because: If that PfeActionFunction would be called with the config of another PfeActionFunction, that also extends the PfeBaseActionConfig, but has other attributes, the original function would try to access its expected attributes that are not available in this case.

As it is certain that this case does not happen, this workaround is used to keep the bivariant behavior.

A more hands on example about this, can be found here: https://github.developer.allianz.io/tobias-siebert/typescript-strictfunctiontypes-covariance-and-contravariance

libs/ngx-pfe/models/json-schema.model.ts

DefaultNgxPfeConfig

This file contains the data models that are used for the json schemas that are shipped with the PFE.

typescript-json-schema is currently not able to handle default generics:

NgxPfeConfig<AppConfiguration | PageConfig | PfeActionConfig>
DefaultPageNavigationConfiguration
PageNavigationConfiguration<PfeActionConfig>
DefaultPfeNavigationConfiguration
PfeNavigationConfiguration<PfeActionConfig>

libs/ngx-pfe/pfe-service-activator/service/service-activator.service.ts

HttpErrorHandler

Handles a serviceActivator call error.

function

libs/ngx-pfe/util/convert-http-response-headers.ts

HTTPResponseHeaders
Record<string | string[]>

libs/ngx-pfe/util/i18n-from-state/directive/pfe-i18n-from-state.directive.ts

i18nFromStateText

Text that can contain placeholders in the form: %jsonPath%$.variableFromTheState%jsonPath%

string

libs/ngx-pfe/models/jsonpath-expression-type.model.ts

JsonPathExpression
string

libs/ngx-pfe/pfe-service-activator/service/service-activator.model.ts

NavServiceActivatorConfigsArray

The service activator configs.

NavServiceActivatorConfig<ACTIONS>[]
ServiceActivatorProgressDetails

libs/ngx-pfe/models/navigation-config.model.ts

PageId

Unique ID of a page.

string
PageNavigationConfiguration
RegularPageNavigationConfiguration<ACTIONS> | NavigationNodeConfiguration<ACTIONS>

libs/ngx-pfe/pfe-actions/pfe-actions.model.ts

PfeActionConfig

These are the integrated default actions. Should be used as a basis for custom extensions in apps

PfeTriggerServiceActivatorsActionConfig | PfeUpdateStateValuesActionConfig | PfeUpdateStateOnBackendActionConfig | RewindHistoryActionConfig | PfeReloadPageActionConfig | PfeResetStateActionConfig | PfeNestedActions<PfeActionConfig>
PfeActionFunction

Actions have to implement this function.

An action can return a boolean result to indicate if further execution should be stopped. For example, this applies to a navigation that triggers an action. If no boolean is returned, a positive (true) response is assumed.

This works in a similar fashion as the Angular route guards with the difference that actions are not executed in parallel. But: The break flag in the action config has to be set to true, to prevent further actions from being executed.

If an exception is thrown by this function, the execution of the actions is aborted. The function itself is responsible to handle things like a redirection to an error page, etc...

BivariantCallbackFunction<Promise<void | boolean>>

libs/ngx-pfe/services/pfe-page-mapping-service/page-definition.ts

RoutePfeLazy

Extends the Angular Route and ensures that either loadChildren or loadComponent is set (but never both).

|

libs/ngx-pfe/pfe-conditions/rules-evaluator/condition.model.ts

RulesEvaluatorConditions
ConditionAdvanced | ExpressionCondition[]

libs/ngx-pfe/services/pfe-state-service/state.service.ts

StateID
string

results matching ""

    No results matching ""