libs/sdk/src/lib/model/journey-src-generation-options.ts
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. |
| 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). |
| debugAcl (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether to include the ACL Inspector |
| debugBb (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether to include BB Debuggers for every Building Block |
| debugHelpers (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether to include all available debug helpers (ACL Inspector, PFE Debugger, BB Debugger) |
| debugPfe (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether to include the PFE Debugger |
| 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 |
string[]
|
| 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. |
| 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. |
| showroom (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Generate the journey in showroom mode |
| stripLocaleBaseHref (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Set the |
| target (Optional) | |
| Type |
JourneyTargetType
|
| Default value |
"app"
|
|
Description
|
Intended integration strategy for this journey. Choose |
| tsStrictMode (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether the generated app should use TypeScript's strict mode for compilation |
| useHashLocationStrategy (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether to use a hash location strategy. Only has an effect when the target is 'app' (standalone journey). Recommended only for special cases where the app server does not support the default path location strategy. |
| useNoopLocationStrategy (Optional) | |
| Type |
boolean
|
| Default value |
false
|
|
Description
|
Whether to use a noop location strategy. Only has an effect when the target is 'webcomponent'. |
import { CHANNEL } from '@allianz/taly-core';
export interface JourneySrcGenerationOptions {
/**
* The project for which the journey source code needs to be generated. A configuration for that project is required.
*/
project: string;
/**
* The path to the config directory that contains journey configuration files
* (relative to the project root).
*/
configDirectory?: string;
/**
* Only for web components: The url at which the web component will be served.
*/
deployUrl?: string;
/**
* You can provide individual overrides or new env values in the form of KEY=value. Repeat
* the env option if necessary.
* @default []
*/
env?: string[];
/**
* 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).
*/
envPath?: string;
/**
* 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.
* @default []
*/
experimental?: string[];
/**
* 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.
* @default "retail"
*/
aquilaChannel?: CHANNEL;
/**
* Provide a path to a css file for a custom Aquila theme.
* When `--aquila-theme` is used together with `--aquila-channel=expert`,
* the default expert theme from NDBX will NOT be imported.
* To avoid any potential style issues, it is important to extend your custom theme from the default "expert" theme.
*/
aquilaTheme?: string;
/**
* Set the `baseHref` property to an empty string in the generated localization configuration
* @default false
*/
stripLocaleBaseHref?: boolean;
/**
* Intended integration strategy for this journey. Choose `app` (default) for a standalone Angular application.
* @default "app"
*/
target?: JourneyTargetType;
/**
* Whether to use a noop location strategy. Only has an effect when the target is
* 'webcomponent'.
* @default false
*/
useNoopLocationStrategy?: boolean;
/**
* Whether to use a hash location strategy.
* Only has an effect when the target is 'app' (standalone journey).
* Recommended only for special cases where the app server does not support the default path location strategy.
* @default false
*/
useHashLocationStrategy?: boolean;
/**
* Whether the generated app should use TypeScript's strict mode for compilation
* @default false
*/
tsStrictMode?: boolean;
/**
* Whether to include all available debug helpers (ACL Inspector, PFE Debugger, BB Debugger)
* @default false
*/
debugHelpers?: boolean;
/**
* Whether to include the PFE Debugger
* @default false
*/
debugPfe?: boolean;
/**
* Whether to include the ACL Inspector
* @default false
*/
debugAcl?: boolean;
/**
* Whether to include BB Debuggers for every Building Block
* @default false
*/
debugBb?: boolean;
/**
* Generate the journey in showroom mode
* @default false
*/
showroom?: boolean;
/**
* Scripts (URLs) to be loaded with the application.
* These will be added as <script src="..." defer /> to the index.html.
*/
scripts?: string[];
/**
* Path to the base configuration you extend from.
* It's required for multi-tenant journeys.
*/
baseConfigDirectory?: string;
}
export enum JourneyTargetType {
App = 'app',
Module = 'module',
WebComponent = 'webcomponent'
}