NGX-PFE - Page Flow Engine
  1. Miscellaneous
  2. Variables

Index

libs/ngx-pfe/i18n/angular-native/pfe-angular-translate-adapter.service.ts

$localize
Type : LocalizeFn

libs/ngx-pfe/hash-only-location-strategy.ts

APP_BASE_HREF_HASH_ONLY
Default value : new InjectionToken<string>('appBaseHrefHashOnly')

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

ARRAY_STATE_EXPRESSION
Type : string
Default value : '[]$'
STATE_EXPRESSION
Type : string
Default value : '$'
URL_STATE_REGEX
Default value : /{\$[^}]*}/gi

The RegExp to find JSONPath Expressions in URL Math {$.anything} or {$['anything']}

libs/ngx-pfe/schematics/ng-update/data/attribute-selectors.ts

attributeSelectors
Type : VersionChanges<AttributeSelectorUpgradeData>
Default value : {}

libs/ngx-pfe/services/pfe-routing/route-generator-guards.definition.ts

BYPASS_PFE_ROUTING
Type : string
Default value : 'BYPASS_PFE_ROUTING'

NavigationBehaviorOptions.state property. If set to true, navigation will bypass PFE routing actions.
PFE_GUARDS_CONFIG
Default value : new InjectionToken<Record<string | number | symbol, () => boolean>>('PFE_GUARDS_CONFIG')

libs/ngx-pfe/schematics/ng-update/data/class-names.ts

classNames
Type : VersionChanges<ClassNameUpgradeData>
Default value : {}

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

CONDITIONS_EVALUATORS
Type : InjectionToken<ConditionEvaluator[]>
Default value : new InjectionToken<ConditionEvaluator[]>( 'CONDITIONS_EVALUATORS' )

libs/ngx-pfe/schematics/ng-update/data/constructor-checks.ts

constructorChecks
Type : VersionChanges<ConstructorChecksUpgradeData>
Default value : {}

List of class names for which the constructor signature has been changed. The new constructor signature types don't need to be stored here because the signature will be determined automatically through type checking.

libs/ngx-pfe/jest-create-spy.ts

createSpy
Default value : () => jest.fn()
createSpyObj
Default value : (baseName: any, methodNames?: any): Record<string, jest.Mock<any>> => { const obj: any = {}; for (const methodName of methodNames) { obj[methodName] = jest.fn(); } return obj; }

libs/ngx-pfe/schematics/ng-update/data/css-selectors.ts

cssSelectors
Type : VersionChanges<AquilaCssSelectorData>
Default value : {}

libs/ngx-pfe/schematics/ng-update/data/css-tokens.ts

cssTokens
Type : VersionChanges<CssTokenUpgradeData>
Default value : {}

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

DEFAULT_CONDITIONS_EVALUATOR
Type : Provider[]
Default value : [ { provide: CONDITIONS_EVALUATORS, multi: true, useFactory: pfeExpressionEvaluator, }, { provide: CONDITIONS_EVALUATORS, multi: true, useFactory: pfeAndConditionEvaluator, deps: [PfeConditionsService], }, { provide: CONDITIONS_EVALUATORS, multi: true, useFactory: pfeOrConditionEvaluator, deps: [PfeConditionsService], }, ]

libs/ngx-pfe/ngx-pfe.module.ts

defaultProviders
Type : Provider[]
Default value : [ PFERouteGeneratorService, PfeRouteGuardsService, PFEPageRoutingEventsHandlerService, PfeBusinessService, PfeNavigationService, PfeStateService, PfePageMappingService, PfeRestService, [{ provide: PfeConfigurationService, useClass: PfeConfigurationService }], PfeNavigationUtilService, ]

libs/ngx-pfe/schematics/ng-update/utils/cherry-picked/project-tsconfig-paths.ts

defaultWorkspaceConfigPaths
Type : []
Default value : ['/angular.json', '/.angular.json']

Name of the default Angular CLI workspace configuration files.

libs/ngx-pfe/pfe-dev-tools/pfe-dev-tools.component.ts

DEVTOOLSURLPARAM
Type : string
Default value : 'devtools'
EXAMPLE_CONDITION_ADVANCED
Type : ConditionAdvanced
Default value : { operator: OPERATORS.AND, conditions: [ { value1Expression: '$.lastVisitedPage', operator: '==', value2Expression: '$.pfeHistory[:1]' }, { value1Expression: 5, operator: '==', value2Expression: 4 }, ], }
EXAMPLE_EXPRESSION
Type : string
Default value : '$.lastVisitedPage'
EXAMPLE_EXPRESSION_CONDITION
Type : ExpressionCondition[]
Default value : [ { expression: '{$.pfeVisitedPages[:1]} === {$.lastVisitedPage}' }, { value1Expression: '$.lastVisitedPage', operator: '==', value2Expression: '$.pfeVisitedPages[:1]' }, ]

libs/ngx-pfe/schematics/ng-update/data/element-selectors.ts

elementSelectors
Type : VersionChanges<ElementSelectorUpgradeData>
Default value : {}

libs/ngx-pfe/animations/animations.ts

fadeIn
Default value : trigger('routeAnimations', [ // fade in when created. this could also be written as transition('void => *') transition('* <=> *', [style({ opacity: 0 }), animate(300)]), ])

libs/ngx-pfe/schematics/ng-update/utils/cherry-picked/import-manager.ts

hasFlag
Default value : (data: AnalyzedImport, flag: ImportState) => (data.state & flag) !== 0

Checks whether an analyzed import has the given import flag set.

libs/ngx-pfe/ngx-http-token/http-token.model.ts

HTTP_TOKEN_CONFIGURATION
Type : InjectionToken<HttpTokenConfig>
Default value : new InjectionToken<HttpTokenConfig>('HTTP_TOKEN_CONFIGURATION')

libs/ngx-pfe/schematics/ng-update/data/input-names.ts

inputNames
Type : VersionChanges<InputNameUpgradeData>
Default value : {}

libs/ngx-pfe/jest.config.ts

isJenkins
Default value : process.env.IS_JENKINS
jenkinsReports
Type : object
Default value : { reporters: [ 'default', [ 'jest-junit', { outputDirectory: reportsBaseFolder, outputName: reportsFileName, }, ], ], coverageDirectory: '../../test_results/unit', coverageReporters: ['html', 'lcov', 'text'], }
localReports
Type : object
Default value : { coverageReporters: ['html'], coverageDirectory: '../../coverage/libs/ngx-pfe' }
path
Default value : require('path')
reportsBaseFolder
Default value : path.join('test_results', 'unit')
reportsFileName
Type : string
Default value : 'result.xml'
Default value : require('../../jest.esmodule.ignore')

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

JSON_PATH_REGEX
Default value : /({.*?})/gm

libs/ngx-pfe/services/pfe-navigation-service/navigation-util.service.ts

LAST_VISITED_PAGE_STATE_KEY
Type : string
Default value : 'lastVisitedPage'

libs/ngx-pfe/schematics/ng-update/data/method-call-checks.ts

methodCallChecks
Type : VersionChanges<MethodCallUpgradeData>
Default value : {}

libs/ngx-pfe/models/ngx-pfe-module-configuration.model.ts

NGX_PFE_CONFIGURATION
Type : InjectionToken<NgxPfeModuleConfiguration>
Default value : new InjectionToken<NgxPfeModuleConfiguration>( 'NGX_PFE_CONFIGURATION' )

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

NGX_PFE_FLOW_CONFIGURATION
Type : InjectionToken<NgxPfeConfig | Promise>
Default value : new InjectionToken< NgxPfeConfig | Promise<NgxPfeConfig> >('NGX_PFE_FLOW_CONFIGURATION - supply the flow configuration as a token')
VALIDATION_ERROR_STATE_KEY_FALLBACK
Type : string
Default value : 'validationErrorData'

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

NGX_PFE_INITIAL_STATE
Type : InjectionToken<Promise<PfeUserInputState>>
Default value : new InjectionToken<Promise<PfeUserInputState>>( 'NGX_PFE_INITIAL_STATE' )

Optional injection token that can be used to restore the state during startup
NGX_PFE_STATE_SESSION_STORAGE_KEY_CONFIG
Type : InjectionToken<PfeStateSessionStorageKeyConfig>
Default value : new InjectionToken<PfeStateSessionStorageKeyConfig>('NGX_PFE_STATE_KEY_CONFIG')

Injection token to configure the key in which the state will be stored in the session storage from each app

libs/ngx-pfe/ngx-http-token/http-token.module.ts

ngxDefaultHttpTokenServiceProviders
Type : Provider[]
Default value : [ { provide: NgxHttpTokenService, useClass: NgxDefaultHttpTokenService }, { provide: APP_INITIALIZER, useFactory: defaultServiceFetchTokenFactory, deps: [NgxHttpTokenService], multi: true, }, ]

libs/ngx-pfe/schematics/ng-update/data/output-names.ts

outputNames
Type : VersionChanges<OutputNameUpgradeData>
Default value : {}

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

PAGE_CONFIG_ROUTE_ATTRIBUTE_NAME
Type : string
Default value : 'pageConfig'

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

PFE_AND
Type : string
Default value : 'PFE_AND'

libs/ngx-pfe/pfe-dev-tools/redux-devtools-connector/redux-devtools-connector.model.ts

PFE_ENABLE_REDUX_DEVTOOLS
Default value : new InjectionToken<boolean>('PFE_ENABLE_REDUX_DEVTOOLS')

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

PFE_EXPRESSION
Type : string
Default value : 'PFE_EXPRESSION'

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

PFE_HISTORY_KEY
Type : string
Default value : 'pfeHistory'
PFE_STATE_INTERNAL_STATE_KEY
Type : string
Default value : '_pfe'

This key in the state is reserved for all internal pfe data. In general, it is desirable to also migrate existing previous keys over to this. For example pfeHistory, etc... But as those are used in a lot of places, that is a bigger, breaking, effort
PFE_STATE_NAVIGATING_FROM
Default value : `$.${PFE_STATE_INTERNAL_STATE_KEY}.navigationState.navigatingFrom`
PFE_STATE_NAVIGATING_TO
Default value : `$.${PFE_STATE_INTERNAL_STATE_KEY}.navigationState.navigatingTo`
PFE_VISITED_KEY
Type : string
Default value : 'pfeVisitedPages'

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

PFE_INTERNAL_VALUES
Type : []
Default value : ['pfeHistory', 'pfeVisitedPages', 'validationErrorData', 'lastVisitedPage', '_pfe']

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

PFE_OR
Type : string
Default value : 'PFE_OR'

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

PfeNavigateActionType
Type : string
Default value : 'PFE_NAVIGATE'

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

PfeNestedActionsType
Type : string
Default value : 'PFE_NESTED_ACTIONS'

libs/ngx-pfe/schematics/ng-update/utils/typescript/module-specifiers.ts

pfePackageSpecifier
Type : string
Default value : '@allianz/ngx-pfe'

libs/ngx-pfe/services/pfe-routing/page-config-resolver.ts

pfePageConfigResolver
Type : ResolveFn<PageConfig | undefined>
Default value : ( activatedRoute: ActivatedRouteSnapshot ): Promise<PageConfig | undefined> => { const pfeConfigService = inject(PfeConfigurationService); if (activatedRoute?.routeConfig?.path) { return pfeConfigService.getPageConfiguration(activatedRoute.routeConfig.path); } else { return Promise.resolve(undefined); } }

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

PfeResetStateActionType
Type : string
Default value : 'PFE_RESET_STATE'

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

PfeRewindHistory
Type : string
Default value : 'PFE_REWIND_HISTORY'

libs/ngx-pfe/pfe-actions/trigger-service-activators/trigger-service-activators.model.ts

PfeTriggerServiceActivatorsType
Type : string
Default value : 'TRIGGER_SERVICE_ACTIVATORS'

libs/ngx-pfe/pfe-actions/update-state-on-backend/update-state-on-backend.model.ts

PfeUpdateStateOnBackend
Type : string
Default value : 'PFE_UPDATE_STATE_ON_BACKEND'

libs/ngx-pfe/pfe-actions/update-state-values/update-state-values.model.ts

PfeUpdateStateValuesType
Type : string
Default value : 'UPDATE_STATE_VALUES'

libs/ngx-pfe/schematics/ng-update/data/property-names.ts

propertyNames
Type : VersionChanges<PropertyNameUpgradeData>
Default value : {}

libs/ngx-pfe/pfe-actions/reload-page/reload-page-action.model.ts

ReloadPageActionType
Type : string
Default value : 'PFE_RELOAD_PAGE'

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

REPLACEMENT_SEPARATOR
Type : string
Default value : '%jsonPath%'

libs/ngx-pfe/schematics/ng-update/data/symbol-removal.ts

symbolRemoval
Type : VersionChanges<SymbolRemovalUpgradeData>
Default value : {}

libs/ngx-pfe/schematics/ng-update/index.ts

upgradeData
Type : UpgradeData
Default value : { attributeSelectors, classNames, cssTokens, constructorChecks, cssSelectors, elementSelectors, inputNames, methodCallChecks, outputNames, propertyNames, symbolRemoval, }

Upgrade data that will be used for the Angular Material ng-update schematic.

results matching ""

    No results matching ""