libs/nx/src/generators/journey-src-runtime/schema.ts
nx
Omit<JourneySrcGenerationOptions, 'target' | 'useHashLocationStrategy'>
Properties |
|
| aquilaChannel (Optional) | |
| Type |
CHANNEL
|
| Default value |
"retail"
|
|
Description
|
Provide a value of 'expert' to specify that this journey is meant for internal usage (Experts, insurance agents) or a value of 'retail' for user-facing journeys. It will be 'retail' by default. "retail" |
| aquilaTheme (Optional) | |
| Type |
string
|
|
Description
|
Provide a path to a css file for a custom Aquila theme.
When |
| baseConfigDirectory (Optional) | |
| Type |
string
|
|
Description
|
Path to the base configuration you extend from. It's required for multi-tenant journeys. |
| configDirectory (Optional) | |
| Type |
string
|
|
Description
|
The path to the config directory that contains journey configuration files (relative to the project root). |
| debugDfPort (Optional) | |
| Type |
number
|
|
Description
|
Port for the Dynamic Form editor server.
Only used by the |
| deployUrl (Optional) | |
| Type |
string
|
|
Description
|
Only for web components: The url at which the web component will be served. |
| env (Optional) | |
| Type |
string[]
|
| Default value |
[]
|
|
Description
|
You can provide individual overrides or new env values in the form of KEY=value. Repeat the env option if necessary. [] |
| envPath (Optional) | |
| Type |
string
|
|
Description
|
Provide path to a file with the environment config. In this file each environment variable needs to be on a separate line and in the format VARIABLE=VALUE (e.g. BFF_BASE_URL=http://my-bff.url). |
| experimental (Optional) | |
| Type |
Experiments[]
|
| Default value |
[]
|
|
Description
|
Enable specific features that are not yet available by default and that can change any day (unstable). Use at your own risk. You can find more information under https://taly.frameworks.allianz.io/additional-documentation/app-generation.html#experimental-features. [] |
| pfeAutomaticStateSessionStorage (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Enable PFE to automatically store state in session storage whenever the state changes.
This option alone has no effect unless |
| project | |
| Type |
string
|
|
Description
|
The project for which the journey source code needs to be generated. A configuration for that project is required. |
| scripts (Optional) | |
| Type |
string[]
|
|
Description
|
Scripts (URLs) to be loaded with the application. These will be added as to the index.html. |
| showDevtools (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether to include the TALY devtools. This enables all devtools surfaces
(ACL Inspector, ACL Hierarchical Inspector, PFE Debugger, Building Block Debugger and
Dynamic Form Debugger) through |
| showroom (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Generate the journey in showroom mode false |
| stripLocaleBaseHref (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Set the |
| tsStrictMode (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether the generated app should use TypeScript's strict mode for compilation false |
| useEnhancedVerticalSpacing (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether to use enhanced vertical spacing instead of the standard vertical spacing. false |
| useNoopLocationStrategy (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether to use a noop location strategy. Only has an effect when the target is 'webcomponent'. false |
import { JourneySrcGenerationOptions } from '@allianz/taly-sdk';
// this "cli" comment is necessary for Nx to recognize this as a Generator schema.
// don't remove!
/**
* @cli nx
*/
// eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-empty-object-type
export interface JourneySrcRuntimeGeneratorSchema
extends Omit<JourneySrcGenerationOptions, 'target' | 'useHashLocationStrategy'> {}