__setPluginValidators | ||||
__setPluginValidators(pluginValidators)
|
||||
Parameters :
|
extractPluginValidationFactory | ||||||
extractPluginValidationFactory(pv: PluginValidatorUnion)
|
||||||
Parameters :
|
getPluginValidations |
getPluginValidations()
|
Returns :
ValidationDefinitions
|
isAsyncValidator | ||||||
isAsyncValidator(validator: PluginValidatorUnion)
|
||||||
Parameters :
Returns :
AsyncPluginValidator
|
accumulateBusinessEvents | ||||||||||||
accumulateBusinessEvents(arr, event: BusinessEventStatus)
|
||||||||||||
Parameters :
|
createDeferred |
createDeferred()
|
Returns :
Deferred
|
groupEventStatusesByName | ||||||
groupEventStatusesByName(arr)
|
||||||
Parameters :
|
AclTagForInstanceAndParentFactory | ||||||||||||
AclTagForInstanceAndParentFactory(instance: BehaviorSubject, anyParent: AclTag, transient: BehaviorSubject)
|
||||||||||||
Parameters :
|
EmptyBehaviorSubjectFactory |
EmptyBehaviorSubjectFactory()
|
Returns :
BehaviorSubject<string>
|
addAclDefaultsToPolicy | |||||||||||||||
addAclDefaultsToPolicy(tree: Tree, options: AddAclDefaultsToPolicyOptions, usedBuildingBlocks, usedLibraries)
|
|||||||||||||||
Parameters :
|
addBbDependenciesToWorkspace | ||||||
addBbDependenciesToWorkspace(tree: Tree)
|
||||||
Parameters :
|
addElementBuilderScripts | |||||||||
addElementBuilderScripts(tree: Tree, destinationDirectory: string)
|
|||||||||
Parameters :
|
addExample | |||||||||
addExample(tree: Tree, options: AddExampleOptionsWithPrefixedNameAndBuildingBlock)
|
|||||||||
Parameters :
|
generate | |||||||||
generate(tree: Tree, options: BuildingBlockExampleGeneratorSchema)
|
|||||||||
Parameters :
|
updateExportIndexFile | |||||||||
updateExportIndexFile(tree: Tree, options: AddExampleOptionsWithPrefixedNameAndBuildingBlock)
|
|||||||||
Parameters :
|
updateMdFile | |||||||||
updateMdFile(tree: Tree, options: AddExampleOptionsWithPrefixedNameAndBuildingBlock)
|
|||||||||
Parameters :
|
writeToFile |
writeToFile(tree: Tree, path: string, newContent: string)
|
|
addFiles | |||||||||
addFiles(tree: Tree, options: NormalizedSchema)
|
|||||||||
Parameters :
|
addProject | |||||||||
addProject(tree: Tree, options: NormalizedSchema)
|
|||||||||
Parameters :
|
expandOptions | ||||||
expandOptions(options: JourneyGeneratorSchema)
|
||||||
Parameters :
Returns :
NormalizedSchema
|
generateJourney | |||||||||
generateJourney(tree: Tree, options: JourneyGeneratorSchema)
|
|||||||||
Parameters :
|
addLibAssetsToBuildTarget | ||||||||||||
addLibAssetsToBuildTarget(tree: Tree, projectName: string, libraries)
|
||||||||||||
Parameters :
|
createAssetConfigsFromLibs | |||||||||
createAssetConfigsFromLibs(tree: Tree, libraries)
|
|||||||||
Parameters :
Returns :
AssetPatternWithRoot[]
|
getLibraryRoot | |||||||||
getLibraryRoot(tree: Tree, packageName: string)
|
|||||||||
Parameters :
|
getMismatchedAssets | ||||||
getMismatchedAssets(existingAssets, assetConfigsFromLibs)
|
||||||
Parameters :
|
addLocalizeMarker | |||||||||
addLocalizeMarker(config: JsonValue, translatableProperties)
|
|||||||||
Parameters :
Returns :
JsonValue
|
getDynamicFormTranslatableProperties |
getDynamicFormTranslatableProperties()
|
isDynamicFormBbConfig | ||||
isDynamicFormBbConfig(block)
|
||||
Parameters :
Returns :
DynamicFormBBConfiguration
|
transformDynamicFormConfigs | ||||||
transformDynamicFormConfigs(pagesJson: PagesJsonSchema)
|
||||||
Convert Dynamic Form configurations to Building Block configurations.
Parameters :
|
transformJourneyToInternalJourney | ||||||
transformJourneyToInternalJourney(journey: Journey)
|
||||||
Apply extra transformations to a journey to be used internally.
Parameters :
Returns :
InternalJourney
|
addNestedControl | ||||||||||||
addNestedControl(form: UntypedFormGroup, path: string, control: AbstractControl)
|
||||||||||||
Parameters :
|
removeNestedControl | |||||||||
removeNestedControl(form: UntypedFormGroup, path: string)
|
|||||||||
Support
Parameters :
|
splitPathIntoGroupAndControlKey | |||||||||
splitPathIntoGroupAndControlKey(form: UntypedFormGroup, path: string)
|
|||||||||
Helper to get proper access to a control and it's parent group.
We can't use form.addControl('some.path', control) as this would use 'some.path' as the key
and not access the group This helper does a proper traversal and returns the group and the matching control key (last part of the path) which can the be used to access group.addControl and group.removeControl
Parameters :
Returns :
literal type
|
syncControlView | ||||||||||||
syncControlView(form: UntypedFormGroup, controlKey: string, aclObservable: Observable)
|
||||||||||||
Remove or Add a form control by it's control key. The control must be available on the given form, will be cached through the closure
Parameters :
|
addNxDependencies | |||||||||
addNxDependencies(tree: Tree, packageJsonPath: string)
|
|||||||||
Parameters :
|
addWorkspaceDependencies | ||||||
addWorkspaceDependencies(tree: Tree)
|
||||||
Parameters :
|
addPage |
addPage(page: Page, source: Journey)
|
Returns :
Journey
|
removePage |
removePage(pageId: PageId, source: Journey)
|
Returns :
Journey
|
addProjectConfig | |||||||||
addProjectConfig(tree: Tree, options: ExpandedLibraryGeneratorSchema)
|
|||||||||
Parameters :
|
addShowroomFiles | |||||||||||||||
addShowroomFiles(tree: Tree, destinationDirectory: string, pagesJson: PagesConfigurationWithTransformedDynamicForms, showroomJson?: ShowroomJsonSchema)
|
|||||||||||||||
Parameters :
|
addTemplates | |||||||||
addTemplates(tree: Tree, options: ExpandedLibraryGeneratorSchema)
|
|||||||||
Parameters :
|
addValidatorsToNewControls | ||||||||||||||||||||
addValidatorsToNewControls(control: AbstractControl, controlPath, validationMap: Map, cleanup$: ReplaySubject)
|
||||||||||||||||||||
Apply validators from the given validationMap to the given control if it's a "new control" (i.e. if it has not had validators applied). If the given control is a form array or form group it will recursively call itself for all child controls. The
Parameters :
Returns :
boolean
whether a new control has been taken care of |
applyValidationConfig | |||||||||
applyValidationConfig(form: UntypedFormGroup, config)
|
|||||||||
Apply a validation configuration to a form group. For each accepted validation (as we only support a subset of validations) we will create a configuration entry (ValidationConfig) which is used to find the control & apply the validations. Validation Error Message are independent of the form control. The form control only knows about the validation name that goes wrong. The actual processing of those needs to happen in the template. For this purpose we return the entire map of ValidationConfig objects to easily access the errorMessages available in there.
Parameters :
Returns :
Map<string, ValidationConfig[]>
|
applyValidationToControl | ||||||||||||||||
applyValidationToControl(control: AbstractControl, validators, asyncValidators)
|
||||||||||||||||
Parameters :
|
cleanupValidationHandling | ||||||
cleanupValidationHandling(form: UntypedFormGroup)
|
||||||
This function has to be called on destruction of the form/component that called applyValidationConfig() in the first place. It ensures that the obsolete form is removed from the cache and that all active subscriptions are being shut down. If it is not called, the component won't be outkast from memory and will stay forever, ever, forever, ever...
Parameters :
|
collectConfigurationItems | ||||||
collectConfigurationItems(config)
|
||||||
Ensure that we don't have duplicates in the given list of validations.
Parameters :
|
findErroneousFormControls | ||||||
findErroneousFormControls(formControls: Record)
|
||||||
Parameters :
Returns :
TalyAbstractControl[]
|
getValidatorsForControlPath | ||||||||||||
getValidatorsForControlPath(controlPath, validationMap: Map)
|
||||||||||||
Returns the sync and async validators for a form control path. Will return empty arrays if the given control path has no validators configured.
Parameters :
Returns :
literal type
tuple with array of sync validators and array of async validators |
parseValidationConfiguration | |||||||||
parseValidationConfiguration(config, validations: ValidationDefinitions)
|
|||||||||
Pass in the config from a page config to retrieve a populated Map of applicable ValidationConfig[] per control id.
Parameters :
|
safeApplyValidationToControl | |||||||||||||||||||||
safeApplyValidationToControl(key: string, control, validators, asyncValidators, validationConfigsForControl, cleanup$: ReplaySubject)
|
|||||||||||||||||||||
Parameters :
|
subscribeToDynamicParameters | ||||||||||||
subscribeToDynamicParameters(control: AbstractControl, validationConfigsForControl, cleanup$: ReplaySubject)
|
||||||||||||
Parameters :
|
validationFactory | |||||||||
validationFactory(item: ValidationConfigItem, validations: ValidationDefinitions)
|
|||||||||
Very simplistic factory that receives a configuration directly from the pages configuration (e.g. { "required": true}) and returns the matching validators from Angular or from the configured plugins. This will be the single place where we can handle validations beyond required including params etc (like min/max). Given a Configuration Item with a type return the matching Validator. This will include the error message from the given configuration or takes a default value which will be part of the application translation.
Parameters :
Returns :
ValidationConfig | null
|
addWebcomponentBuilderTargetToProjectConfig |
addWebcomponentBuilderTargetToProjectConfig(tree: Tree, projectName: string, deployUrl?: string)
|
|
aggregateJourneyConfig | ||||||||
aggregateJourneyConfig(journeyConfig: SplitJourney)
|
||||||||
Aggregates the split journey configuration into a classic journey configuration.
Parameters :
Returns :
Journey
The aggregated (classic) journey configuration. |
extractDuplicates | ||||||
extractDuplicates(array)
|
||||||
Extracts duplicate values from an array.
Parameters :
Returns :
string[]
An array containing the unique duplicate values. |
loadSplitJourneyFromFolder | ||||||||
loadSplitJourneyFromFolder(configDirectory: string)
|
||||||||
Loads the split journey configuration from a folder.
Parameters :
Returns :
SplitJourney
The split journey configuration, loaded in memory. |
appendErrorToAppComponentHtml | |||||||||
appendErrorToAppComponentHtml(outputDirectory: string, error: Error)
|
|||||||||
Parameters :
|
linkify | ||||||
linkify(inputText: string)
|
||||||
Parameters :
|
replaceAtSymbols | ||||||
replaceAtSymbols(input: string)
|
||||||
Parameters :
Returns :
string
|
stripAnsiEscapeCodes | ||||||
stripAnsiEscapeCodes(input: string)
|
||||||
Parameters :
Returns :
string
|
assertFileContentMatchesSchema | |||||||||
assertFileContentMatchesSchema(filePath: string, schema)
|
|||||||||
throws an error if the contents of the given file don't match the given schema.
Parameters :
|
assertValidApplicationJson |
assertValidApplicationJson(baseConfigDirectory: string, tenantConfigDirectory: string)
|
|
assertValidMultiTenantJourneyConfiguration |
assertValidMultiTenantJourneyConfiguration(baseConfigDirectory: string, tenantConfigDirectory: string)
|
throws an error if the given multi-tenant journey config doesn't match the JSON schemas |
assertValidPagesJsons |
assertValidPagesJsons(baseConfigDirectory: string, tenantConfigDirectory: string)
|
|
assertValidApplicationJson | ||||||
assertValidApplicationJson(configDirectory: string)
|
||||||
Parameters :
|
assertValidPagesJsons | ||||||
assertValidPagesJsons(configDirectory: string)
|
||||||
Parameters :
|
assertValidSplitJourneyConfiguration | ||||||
assertValidSplitJourneyConfiguration(configDirectory: string)
|
||||||
throws an error if the given split journey config doesn't match the JSON schemas
Parameters :
|
assertValidClassicJourneyConfiguration | ||||||
assertValidClassicJourneyConfiguration(configPath: string)
|
||||||
Parameters :
|
assertValidName | ||||||
assertValidName(name: string)
|
||||||
Parameters :
Returns :
void
|
assertValidPaths | ||||
assertValidPaths(options)
|
||||
Parameters :
|
assignValueToObjectWithPath | ||||||||||||
assignValueToObjectWithPath(__namedParameters: {object: StaticResourceList, path: string, value})
|
||||||||||||
wrap the lodash
Parameters :
|
collectObjectLeaves | ||||||||||||
collectObjectLeaves(givenObject, predicateFn, parentKeys)
|
||||||||||||
Parameters :
Returns :
LeafRecord[]
|
createResourceUpdateStream | |||||||||
createResourceUpdateStream(resourceMap: BuildingBlockResourceMap, pfeQueries)
|
|||||||||
Transform a list of resources into a stream of StaticResourceList. The recipe is: extract the static data and add the latest values from all given pfe queries The resulting object can then be passed to a Building Block's setResource method.
Parameters :
Returns :
Observable<StaticResourceList>
|
getPFEQueryMap | ||||||
getPFEQueryMap(resourceMap: BuildingBlockResourceMap)
|
||||||
Given a resource list return a map of PFE Queries where the key is the future key in the resource object being passed to setResources() and the value is retrieved by the pfe store expression in the PFE Query.
Parameters :
Returns :
PFEQuery[]
|
getStaticResources | ||||||
getStaticResources(resourceMap: BuildingBlockResourceMap)
|
||||||
Extract all static values from a resource list
Parameters :
Returns :
StaticResourceList
|
mergePfeQueryUpdates | |||||||||
mergePfeQueryUpdates(queries, pfeQueryGetter: ObservableFromQueryFunction)
|
|||||||||
Take a list of PFEResourceQueries and transform them into a single map containing all mapped values from the store
Parameters :
Returns :
Observable<StaticResourceList>
|
mergeResources | |||||||||
mergeResources(objectA: StaticResourceList, objectB: StaticResourceList)
|
|||||||||
We need to deep merge resource objects and a spread operator will fail this task as nested keys with the same name are not merged (it's shallow) a = { nested : { valueA: 1}} b = { nested : { valueB: 2}} result = { nested : { valueA: 1, valueB: 2}}
Parameters :
|
transformPathChainToPath | ||||||
transformPathChainToPath(pathPieces)
|
||||||
Parameters :
Example :
Returns :
string
the joined path, generates list-like paths for numeric path pieces |
buildExampleData | ||||
buildExampleData(buildingBlocksWithShowroomData)
|
||||
Parameters :
|
buildShowroomImportStatements | ||||
buildShowroomImportStatements(buildingBlocksWithShowroomData)
|
||||
Parameters :
|
extractShowroomTemplateData | ||||||
extractShowroomTemplateData(pagesJson: PagesConfigurationWithTransformedDynamicForms)
|
||||||
Parameters :
Returns :
ShowroomStrings
|
getBuildingBlocksWithShowroomData | ||||
getBuildingBlocksWithShowroomData(buildingBlocks)
|
||||
Parameters :
Returns :
BuildingBlockConfiguration[]
|
getExportNameForExampleData | ||||||
getExportNameForExampleData(bbModuleName: string)
|
||||||
Parameters :
Returns :
string
|
buildImportStatements | ||||||
buildImportStatements(exportNamesGroupByPackage: Record)
|
||||||
Parameters :
|
extractBbFilePath | |||||||||||||||
extractBbFilePath(basePath: string, bbModuleName: string, bbModuleFileExtension: string, bbFileExtension: string)
|
|||||||||||||||
Parameters :
Returns :
string | undefined
|
getLocalLibraryPackagePath | ||||||
getLocalLibraryPackagePath(packageName: string)
|
||||||
Parameters :
Returns :
string | undefined
|
getLocalPathToBbFile |
getLocalPathToBbFile(basePath: string, bbModuleName: string, bbFileExtension: string)
|
Returns :
literal type
|
getNodeModulesLibraryPackagePath | ||||||
getNodeModulesLibraryPackagePath(packageName: string)
|
||||||
Parameters :
Returns :
string | undefined
|
getNodeModulesPathToBbFile |
getNodeModulesPathToBbFile(basePath: string, bbModuleName: string, bbFileExtension: string)
|
Returns :
literal type
|
buildingBlock | |||||||||
buildingBlock(tree: Tree, options: BuildingBlockGeneratorSchema)
|
|||||||||
Parameters :
|
createBuildingBlock | |||||||||
createBuildingBlock(tree: Tree, options: AddBuildingBlockOptionsWithNameWithPrefix)
|
|||||||||
Parameters :
|
updateExportIndexFile | |||||||||
updateExportIndexFile(tree: Tree, options: AddBuildingBlockOptionsWithNameWithPrefix)
|
|||||||||
Parameters :
|
camelize | ||||||
camelize(str: string)
|
||||||
Parameters :
|
dasherize | ||||||
dasherize(str: string)
|
||||||
Parameters :
Returns :
string
|
decamelize | ||||||
decamelize(str: string)
|
||||||
Parameters :
Returns :
string
|
camelize | ||||||
camelize(str: string)
|
||||||
Parameters :
|
checkIsFormArray | ||||||
checkIsFormArray(control: AbstractControl)
|
||||||
Parameters :
Returns :
UntypedFormArray
|
checkIsFormControl | ||||||
checkIsFormControl(control: AbstractControl)
|
||||||
Parameters :
Returns :
UntypedFormControl
|
checkIsFormGroup | ||||||
checkIsFormGroup(control: AbstractControl)
|
||||||
Check if it's a form group and use a TS type guard to let TS know that it is indeed a FormGroup in the control flow
Parameters :
Returns :
UntypedFormGroup
|
createControlItem | |||||||||||||||
createControlItem(__namedParameters: {control: string[], controlPathSegments: boolean, isFormGroup: boolean, isFormArray: AbstractControl})
|
|||||||||||||||
Parameters :
Returns :
ControlItem
|
walkFormGroup | ||||||||||||||||
walkFormGroup(controlOrGroup: AbstractControl, __namedParameters: {includeFormGroups}, parentPath)
|
||||||||||||||||
walkFormGroup
Parameters :
Returns :
ControlItem[]
|
cloneDeepWithJsonComments | ||||||
cloneDeepWithJsonComments(obj: T)
|
||||||
comment-json stores the read comments in non-enumerable properties.
These properties are ignored by both
Parameters :
Returns :
T
|
collectBuildingBlockFolders | ||||||
collectBuildingBlockFolders(source: string)
|
||||||
Find all suitable folders that contain a Building Block. A Building needs to be an Angular component, with a Markdown Files and Module. All with the same name
Parameters :
Returns :
Promise<BuildingBlockFoldersCollection>
|
statsBuildingBlockFolder | ||||||
statsBuildingBlockFolder(folderPath: string)
|
||||||
Create a small stat report about the given folder. Check if all required files for a Building Block do exist and return details of the check for a later analysis/logging to provide some verbose output.
Parameters :
Returns :
BuildingBlockFolderStats
|
collectBuildingBlockImports | ||||
collectBuildingBlockImports(blocks)
|
||||
Parameters :
Returns :
BuildingBlockImport[]
|
hasCompactBuildingBlock | ||||
hasCompactBuildingBlock(allSections)
|
||||
Parameters :
|
hasSingleBuildingBlockWithBackground | |||||||||
hasSingleBuildingBlockWithBackground(page: PageConfiguration, navigationSections)
|
|||||||||
Parameters :
|
singlePage | |||||||||
singlePage(tree: Tree, options: SinglePageOptions)
|
|||||||||
Parameters :
|
collectFromBuildingBlocks | ||||
collectFromBuildingBlocks(blocks)
|
||||
Find and collect all Building Blocks with a given example state and store it inside a map to further access.
Parameters :
Returns :
BuildingBlockWithExampleMap
|
createIdentifier | ||||||
createIdentifier(buildingBlockId: string)
|
||||||
Parameters :
|
renderAllVariableDeclarations | ||||||
renderAllVariableDeclarations(items: BuildingBlockWithExampleMap)
|
||||||
Take a collection of Building Block IDs and example state strings and render them as a list of variable assignments to output it directly into a component template. const myBbExampleState = {foo: "bar"}
Parameters :
|
renderVariableDeclaration | ||||||
renderVariableDeclaration(item: BuildingBlockWithExample)
|
||||||
Parameters :
|
collectPeerDependencies | ||||||
collectPeerDependencies(options: InstallLibPeerDependenciesOptions)
|
||||||
Parameters :
Returns :
Promise<LibraryConfiguration[]>
|
getDependencyFromPackageJson | |||||||||
getDependencyFromPackageJson(packageJson: PartialPackageJson, libraryName: string)
|
|||||||||
Parameters :
Returns :
LibraryConfiguration | null
|
collectPluginFolders | ||||||
collectPluginFolders(source: string)
|
||||||
Find all suitable folders that contain a Plugin. A Plugin needs to be an Injectable, with a Markdown Files and Module. All with the same name
Parameters :
Returns :
Promise<PluginFoldersCollection[]>
|
collectSecondaryEntrypoints | ||||||
collectSecondaryEntrypoints(source: string)
|
||||||
Parameters :
|
getExpectedFileNames | ||||||||||||
getExpectedFileNames(type: FolderFileType, folderPath: string)
|
||||||||||||
Parameters :
|
getFilePath | ||||||||||||
getFilePath(type: FolderFileType, folderPath: string)
|
||||||||||||
Parameters :
|
getFolderStats | ||||||
getFolderStats(folderPath: string)
|
||||||
Create a small stat report about the given folder. Check if all required files for a Plugin do exist and return details of the check for a later analysis/logging to provide some verbose output.
Parameters :
Returns :
Promise<FolderStats>
|
isSecondaryEntryPoint | ||||||
isSecondaryEntryPoint(projectFolder: string)
|
||||||
Parameters :
|
logPluginFolderWarnings | |||||||||
logPluginFolderWarnings(stats: FolderStats, logger: LoggerApi)
|
|||||||||
Parameters :
|
processEntrypoint | ||||||||||||
processEntrypoint(entryPoint: string, secondary)
|
||||||||||||
Parameters :
Returns :
Promise<PluginFoldersCollection>
|
collectUsedBuildingBlocksAndLibraries | ||||||||
collectUsedBuildingBlocksAndLibraries(pagesJson: PagesConfigurationWithTransformedDynamicForms)
|
||||||||
collects building block metadata and the used libraries from a pages.json configuration.
Parameters :
Returns :
UsedBuildingBlocksAndLibraries
|
compareDataOption | ||||||||||||
compareDataOption(listValue: T, selectedValue)
|
||||||||||||
Utility function to be used inside of Building blocks to provide possibility compare dataOption object by value in the dropdowns.
Parameters :
|
constructNaturalDateRegexp |
constructNaturalDateRegexp()
|
Returns :
RegExp
|
isNaturalDateString | ||||||
isNaturalDateString(maybeDateString: string)
|
||||||
Parameters :
Returns :
boolean
|
parseNaturalDateString | ||||||
parseNaturalDateString(maybeDateString: string)
|
||||||
Parameters :
Returns :
string | null
|
updateDate |
updateDate(date: Dayjs, amount: number, unit: Units)
|
Returns :
Dayjs
|
controlEnforcer | |||||||||
controlEnforcer(controls, controlEnforcerFactory: SyncEnforcer)
|
|||||||||
Given a list of AclControlItem use a factory to create streams for each control which will adjust depending on a given acl key subscription. The entire list is merged to listen for future changes afterwards.
Parameters :
Returns :
Observable<boolean>
|
convertRulesToPolicyTxt | ||||
convertRulesToPolicyTxt(rules)
|
||||
Parameters :
|
isComment | ||||||
isComment(line: string)
|
||||||
Parameters :
Returns :
boolean
|
isValidAclRuleState | ||||||
isValidAclRuleState(state: string)
|
||||||
Parameters :
Returns :
AclRuleState
|
parsePolicyTxtContent | ||||||
parsePolicyTxtContent(fileContent: string)
|
||||||
Parameters :
Returns :
AclRule[]
|
parseRule |
parseRule(rule: string, defaultRule: boolean)
|
Returns :
AclRule
|
copyComments | ||||||||||||
copyComments(target: T, source: any, mappingOverrides?: Map)
|
||||||||||||
And here our custom code follows:
Parameters :
Returns :
T
|
copyFolder |
copyFolder(tree: Tree, sourceFolder: string, destFolder: string)
|
Given a |
getAllFilesInTreeAtDirectory | |||||||||
getAllFilesInTreeAtDirectory(tree: Tree, directory: string)
|
|||||||||
Parameters :
Returns :
string[]
|
copyToClipboard | ||||||
copyToClipboard(value: string)
|
||||||
Parameters :
|
createAclMock |
createAclMock()
|
createAclPath | ||||
createAclPath(resources)
|
||||
Parameters :
|
isResetByEditable | ||||||
isResetByEditable(state: AclResourceState)
|
||||||
Parameters :
Returns :
"readonly" | "disabled"
|
isResetByVisible | ||||||
isResetByVisible(state: AclResourceState)
|
||||||
Parameters :
|
isResetState | ||||||
isResetState(state: AclRuleState)
|
||||||
Parameters :
Returns :
AclResetState
|
isRuleRelevantForPath | ||||||||||||
isRuleRelevantForPath(rule: AclRule, aclPath: string, state: AclResourceState)
|
||||||||||||
determines if rule "rule" is relevant for path "aclPath" and state "state" does not take the rule's condition into account
Parameters :
Returns :
boolean
|
createArrayLiteralExpression | ||||
createArrayLiteralExpression(links)
|
||||
Parameters :
|
createFooterDeclaration | ||||
createFooterDeclaration(footer)
|
||||
Parameters :
|
createArrayLiterals | ||||
createArrayLiterals(sections)
|
||||
Parameters :
|
createNavigationSectionDeclaration | ||||||
createNavigationSectionDeclaration(sections)
|
||||||
Parameters :
|
createBuildBlockChangesStream | ||||||
createBuildBlockChangesStream(queryList: QueryList)
|
||||||
Maintain a stream of added & removed Building Block instances so we can either cleanup removed Building Blocks or add missingFacades
Parameters :
Returns :
Observable<>
|
createPageStatusStream | ||||||
createPageStatusStream(buildingBlockQueryList: QueryList)
|
||||||
Create a stream of
Parameters :
|
createBuildingBlockProvider | ||||||
createBuildingBlockProvider(component: T)
|
||||||
Parameters :
|
createComponentResolver | ||||||
createComponentResolver(component: T)
|
||||||
Parameters :
|
createControlListFromForm | ||||||||||||||||
createControlListFromForm(form: UntypedFormGroup, verbose, excludes)
|
||||||||||||||||
Create a control list from all form controls in a form group including nested ones.
Parameters :
Returns :
AclControlItem[]
|
createControlListFromMap | ||||||||||||||||
createControlListFromMap(form: UntypedFormGroup, aclMapping, verbose)
|
||||||||||||||||
Create a manual mapping between form controls and acl keys.
The resulting array of AclControlItems can directly be consumed by
Parameters :
Returns :
AclControlItem[]
|
mergeControlList | |||||||||
mergeControlList(base, overrides)
|
|||||||||
Only map given explicit map of acl keys and control paths
Parameters :
|
createDateStringFormatError | |||||||||
createDateStringFormatError(item: ValidationConfigItem, key)
|
|||||||||
Parameters :
Returns :
Error
|
isIsoDateString | ||||||
isIsoDateString(dateString: string)
|
||||||
Parameters :
Returns :
boolean
|
createDefaultPFEConfig | ||||||
createDefaultPFEConfig(pagesConfig: PagesJsonSchema)
|
||||||
Parameters :
Returns :
PfeJsonSchema
|
createPagesNavConfiguration | ||||
createPagesNavConfiguration(pages)
|
||||
Parameters :
|
pageWalker | ||||
pageWalker(pages)
|
||||
support utility to enrich a given page array with previous and next pages pointers
Parameters :
|
singleNavigationPageConfig | ||||||||||||
singleNavigationPageConfig(pageData: PageConfiguration, nextPage)
|
||||||||||||
create a single pfe navigation config node, with minimal content to point to next page
Parameters :
|
createEvaluationProxy | |||||||||
createEvaluationProxy(targetService: AclEvaluationInterface, prefixResolver)
|
|||||||||
Forward all calls to a given AclEvaluationInterface and prefix the argument, which is a aclPath
with the prefix given through the
Parameters :
Returns :
AclEvaluationInterface
|
wrapAclEvaluation | |||||||||
wrapAclEvaluation(targetService: AclEvaluationInterface, prefix: string)
|
|||||||||
Prefix the acl evaluation with an ACL Tag. You can pass in for example a root AclService or directly an AclEngine and prefix all queries with the given prefix value
Parameters :
Returns :
AclEvaluationInterface
|
wrapAclEvaluationWithTag | |||||||||
wrapAclEvaluationWithTag(targetService: AclEvaluationInterface, tag: AclTag)
|
|||||||||
Prefix the acl evaluation with an ACL Tag. You can pass in for example a root AclService or directly an AclEngine and prefix all queries with the given acl tag's key.
Parameters :
Returns :
AclEvaluationInterface
|
createFileWatcher | ||||||
createFileWatcher(directories, changeHandler)
|
||||||
Parameters :
|
createForm |
createForm()
|
getPolicyForm |
getPolicyForm()
|
createForm |
createForm()
|
getPolicyForm |
getPolicyForm()
|
createIntrospectionContext | |||||||||||||||
createIntrospectionContext(__namedParameters: {root: IntrospectionContextRequirements, files, context, logger})
|
|||||||||||||||
Parameters :
Returns :
IntrospectionContext | null
|
createJournalRecord |
createJournalRecord(dir: string, packageName: string, logger: Logger)
|
Returns :
Promise<BuildingBlockJournalRecord>
|
createJourney | ||||||
createJourney(options: CreateJourneyOptions)
|
||||||
Parameters :
|
createLastPageObservable | ||||||||||||
createLastPageObservable(pfeBusinessService: PfeBusinessService, pfeNavigationService: PfeNavigationService, pfeConfigurationService: PfeConfigurationService)
|
||||||||||||
Parameters :
Returns :
Observable<boolean>
|
createNavOrServiceActivatorInProgressObservable | |||||||||
createNavOrServiceActivatorInProgressObservable(pfeServiceActivatorService: PfeServiceActivatorService, pfeNavigationService: PfeNavigationService)
|
|||||||||
Parameters :
Returns :
Observable<boolean>
|
createPageActionStatusObservable | ||||||||||||||||||||||||
createPageActionStatusObservable(pfeServiceActivatorService: PfeServiceActivatorService, pfeNavigationService: PfeNavigationService, pfeConfigurationService: PfeConfigurationService, pfeBusinessService: PfeBusinessService, backLinkUtilsService: BackLinkUtilsService, talyPageDataService: TalyPageDataService, nextButtonDisabledWhenPageInvalid: boolean)
|
||||||||||||||||||||||||
Parameters :
|
createLocalizeTemplateExpression | ||||||
createLocalizeTemplateExpression(i18nText: string)
|
||||||
Parameters :
Returns :
ts.TaggedTemplateExpression
|
createSafePropertyIdentifier | ||||||
createSafePropertyIdentifier(maybeUnsafeIdentifierString: string)
|
||||||
Parameters :
Returns :
ts.Identifier
|
createStringLiteral | |||||||||
createStringLiteral(value: string, i18nPath)
|
|||||||||
Parameters :
Returns :
ts.StringLiteral | ts.TaggedTemplateExpression
|
createTsExpression | ||||||
createTsExpression(value, i18nPath)
|
||||||
Parameters :
Returns :
ts.Expression
|
md5 | ||||||
md5(str: string)
|
||||||
Parameters :
Returns :
string
|
tsNodeText | ||||
tsNodeText(n)
|
||||
Parameters :
Returns :
string
|
turnArrayIntoArrayLiteral | ||||||
turnArrayIntoArrayLiteral(arr, i18nPath)
|
||||||
Parameters :
Returns :
ts.ArrayLiteralExpression
|
turnObjectIntoObjectLiteral | |||||||||
turnObjectIntoObjectLiteral(obj: T, i18nPath)
|
|||||||||
Parameters :
Returns :
ts.ObjectLiteralExpression
|
createNavigation | ||||||
createNavigation(options?: Navigation)
|
||||||
Target Output:
Parameters :
|
createPageActionConfig | ||||||||||||
createPageActionConfig(options, createLocalizeAssignmentFn: curriedCreateLocalizeAssignmentFunction, pageId: string)
|
||||||||||||
Parameters :
|
createPageDataAssignment | ||||||
createPageDataAssignment(page: PageConfigurationWithTransformedDynamicForms)
|
||||||
Convert an incoming page configuration to a valid TS variable assignment in the following form. Given this page configuration
transform it into the following TS structure to output it into a TS component.
Parameters :
|
createStage | |||||||||
createStage(options, createLocalizeAssignmentFn: curriedCreateLocalizeAssignmentFunction)
|
|||||||||
Target Output:
Parameters :
|
createNewRuntimeSection | |||||||||
createNewRuntimeSection(sectionItem, index: number)
|
|||||||||
Parameters :
Returns :
SectionRuntimeDefinition
|
createRuntimePanelFromConfiguration | |||||||||||||||
createRuntimePanelFromConfiguration(panelConfig: PanelDefinition, blockConfig: BuildingBlockConfiguration, pageId: string, isExpertApp: boolean)
|
|||||||||||||||
Parameters :
Returns :
PanelRuntimeDefinition
|
createRuntimeSectionFromConfiguration | |||||||||
createRuntimeSectionFromConfiguration(section: PageSectionDefinition, sectionItem)
|
|||||||||
Parameters :
Returns :
SectionRuntimeDefinition
|
findLastSectionWithStandalonePanel | ||||
findLastSectionWithStandalonePanel(sections)
|
||||
Parameters :
|
findPanelInSections | |||||||||
findPanelInSections(sections, panelId: string)
|
|||||||||
Parameters :
|
isPanel | ||||||
isPanel(item: PanelOrSectionOrBlock)
|
||||||
Parameters :
Returns :
PanelRuntimeDefinition
|
mergeBlocksAndPanelsIntoSections | ||||||||||||
mergeBlocksAndPanelsIntoSections(page: PageConfigurationWithTransformedDynamicForms, isExpertApp)
|
||||||||||||
Given a list of blocks, sections and panels merge everything except standalone BBs into sections configuration. Important: This method have to retain the order of elements, so we don't calculate two lists of panels and unbound blocks
but a mixed list to allow
Parameters :
Returns :
SectionRuntimeDefinition[]
|
createPageDataOverridesString | |||||||||
createPageDataOverridesString(pageId: string, allBlocks)
|
|||||||||
Parameters :
Returns :
string
|
createPropertyAssignmentBlockResources |
createPropertyAssignmentBlockResources(resources: Record, pageId: string, blockId: string)
|
Returns :
ts.PropertyAssignment
|
createPropertyAssignmentBlockValidators |
createPropertyAssignmentBlockValidators(validators, pageId: string, blockId: string)
|
Returns :
ts.PropertyAssignment
|
createPropertyAssignmentDynamicFormConfiguration |
createPropertyAssignmentDynamicFormConfiguration(resources, pageId: string, blockId: string)
|
Returns :
ts.PropertyAssignment
|
createPropertyAssignmentsForBlocks | |||||||||
createPropertyAssignmentsForBlocks(pageId: string, allBlocks)
|
|||||||||
Parameters :
Returns :
ts.PropertyAssignment[]
|
createPages | |||||||||
createPages(tree: Tree, options: CreatePagesOptions)
|
|||||||||
Parameters :
|
createPfeHistoryObservable | ||||||
createPfeHistoryObservable(pfeStateService: PfeStateService)
|
||||||
Parameters :
Returns :
Observable<PageHistory>
|
filterSections | |||||||||
filterSections(allSections: SectionConfig, conditions: Map)
|
|||||||||
Parameters :
Returns :
SectionConfig
|
createStackedLayoutObservable | |||||||||
createStackedLayoutObservable(breakpoint$: Observable, channel: CHANNEL)
|
|||||||||
Create an observable that combines the information about the active channel and the available screen estate defined by a breaking point. With those information we can easily decide if we want to switch the layout to be stacked (one column) or keep the "holy grail layout" with the three columns in the center and footer/header above and below Combinations: SCREEN_TOO_SMALL + EXPERT = stacked SCREEN_TOO_SMALL + RETAIL = stacked SCREEN OKAY + RETAIL = stacked SCREEN OKAY + EXPERT = holy grail
Parameters :
|
createStaticAclTagProvider | ||||||
createStaticAclTagProvider(resourceName: string)
|
||||||
Usage inside a component to alway prefix it with an acl tag providers: [ createStaticAclTag('my-prefix') ]
Parameters :
|
createUpdatedPolicy | ||||||||||||
createUpdatedPolicy(policy: string, aclDefaults: Map)
|
||||||||||||
Adds the given ACL defaults to an existing policy. Replaces any existing ACL defaults.
Parameters :
Returns :
string
|
removeOldDefaults | ||||||
removeOldDefaults(policy: string)
|
||||||
Parameters :
Returns :
string
|
createWorkspace | |||||||||
createWorkspace(destinationDirectory: string, normalizedOptions: GenerateWorkspaceOptions)
|
|||||||||
Parameters :
Returns :
AsyncGenerator<ProgressReport, void>
|
createWorkspace |
createWorkspace(directory: string, legacyDependencyResolution?: boolean)
|
|
createWorkspaceEmpty | |||||||||
createWorkspaceEmpty(destinationDirectory: string, normalizedOptions: GenerateWorkspaceOptions)
|
|||||||||
Parameters :
Returns :
AsyncGenerator<ProgressReport, void>
|
createWorkspaceWithJourney | |||||||||
createWorkspaceWithJourney(destinationDirectory: string, normalizedOptions: GenerateWorkspaceOptions)
|
|||||||||
Parameters :
Returns :
AsyncGenerator<ProgressReport, void>
|
createWorkspaceWithLibrary | |||||||||
createWorkspaceWithLibrary(destinationDirectory: string, normalizedOptions: GenerateWorkspaceOptions)
|
|||||||||
Parameters :
Returns :
AsyncGenerator<ProgressReport, void>
|
dasherize | ||||||
dasherize(str?: string)
|
||||||
Parameters :
Returns :
string
|
decamelize | ||||||
decamelize(str: string)
|
||||||
Parameters :
Returns :
string
|
dasherize | ||||||
dasherize(str?: string)
|
||||||
Parameters :
Returns :
string
|
decamelize | ||||||
decamelize(str: string)
|
||||||
Parameters :
Returns :
string
|
dasherizeBBIds | ||||||
dasherizeBBIds(journey: Journey)
|
||||||
Parameters :
Returns :
Journey
|
deleteFiles | |||||||||
deleteFiles(tree: Tree, deleteFromDirectory: string)
|
|||||||||
Parameters :
|
transformToModule | |||||||||
transformToModule(tree: Tree, destinationDirectory: string)
|
|||||||||
Transforms a generated app into a module for direct integration. Careful: this has to run after the app generation. It also has to run on a "top" level in the generators. The background for this is, that it also deletes files. That doesn't work if the tree is merged with another level that created the same files.
Parameters :
|
deletePropertyByPath | |||||||||
deletePropertyByPath(object: any, pathArray)
|
|||||||||
Parameters :
Returns :
void
|
getBaseApplicationPropertyPath | ||||||||||||
getBaseApplicationPropertyPath(propertyPath, applicationJson: any)
|
||||||||||||
Checks whether there is a refDefault in the given property path and adds it to the path if necessary.
Parameters :
Returns :
[] | undefined
|
getPropertyByPath | |||||||||
getPropertyByPath(object: any, pathArray)
|
|||||||||
Parameters :
Returns :
any
|
setPropertyByPath |
setPropertyByPath(object: any, pathArray, value: any)
|
Returns :
void
|
didJsonObjectChange | |||||||||
didJsonObjectChange(a: PagesJsonSchema, b: PagesJsonSchema)
|
|||||||||
Parameters :
|
makeStickyBuildingBlockTheBannerBlock | ||||||
makeStickyBuildingBlockTheBannerBlock(tree: Tree)
|
||||||
Parameters :
|
didJsonObjectChange | |||||||||
didJsonObjectChange(a: PagesJsonSchema, b: PagesJsonSchema)
|
|||||||||
Parameters :
|
moveStageConfigFromPageDataToTitle | ||||||
moveStageConfigFromPageDataToTitle(tree: Tree)
|
||||||
Parameters :
|
didJsonObjectChange | |||||||||
didJsonObjectChange(a: PagesJsonSchema, b: PagesJsonSchema)
|
|||||||||
Parameters :
|
removePackageVersionFromPluginConfig | ||||||
removePackageVersionFromPluginConfig(tree: Tree)
|
||||||
Parameters :
|
didJsonObjectChange | ||||||
didJsonObjectChange(a, b)
|
||||||
Parameters :
|
removePagesConfigurationFromPfeJson | ||||||
removePagesConfigurationFromPfeJson(tree: Tree)
|
||||||
Parameters :
|
ensureValidCustomElementName | ||||||
ensureValidCustomElementName(projectName: string)
|
||||||
Parameters :
Returns :
string
|
isValidCustomElementName | ||||||
isValidCustomElementName(name: string)
|
||||||
Parameters :
Returns :
boolean
|
journeySrc | |||||||||
journeySrc(tree: Tree, options: JourneySrcGeneratorSchema)
|
|||||||||
Parameters :
|
example |
example()
|
extractAngularFormProperties | |||||||||||||||
extractAngularFormProperties(propertyType: NodeWithTypeArguments, pathFromRoot, logger: Logger, typeName?: string)
|
|||||||||||||||
Parameters :
Returns :
FormProperty[]
|
extractFormControlProperty | ||||||||||||
extractFormControlProperty(propertyType: NodeWithTypeArguments, pathFromRoot, logger: Logger)
|
||||||||||||
Parameters :
Returns :
FormProperty[]
|
extractFormControlType | ||||||||||||
extractFormControlType(propertyType: NodeWithTypeArguments, pathFromRoot, logger: Logger)
|
||||||||||||
Parameters :
Returns :
string
|
extractFormGroupProperties | ||||||||||||
extractFormGroupProperties(typeArguments: TypeNode, pathFromRoot, logger: Logger)
|
||||||||||||
Parameters :
Returns :
FormProperty[]
|
extractFormProperties | ||||||||||||
extractFormProperties(introspectionContext: IntrospectionContext, sourceFile, node)
|
||||||||||||
Parameters :
|
extractPropertyTree | ||||||||||||||||||
extractPropertyTree(checker, root, node, buildingBlockFilePath: string, logger: Logger)
|
||||||||||||||||||
Parameters :
|
extractTypeName | ||||
extractTypeName(propertyType)
|
||||
Parameters :
Returns :
string
|
getPropertyTypeInformation | |||||||||||||||
getPropertyTypeInformation(checker, property, node, logger: Logger)
|
|||||||||||||||
Parameters :
|
getReturnTypeArgument | ||||||
getReturnTypeArgument(checker, declaration)
|
||||||
Parameters :
|
isAngularForms | ||||||
isAngularForms(typeName: string)
|
||||||
Parameters :
|
isCustomDefinedType | ||||
isCustomDefinedType(type)
|
||||
Parameters :
|
isGetFormMethod | ||||
isGetFormMethod(node)
|
||||
Parameters :
|
mapToStackItems | ||||||||||||
mapToStackItems(visitedCustomTypeNames: Set, type, ancestors)
|
||||||||||||
Parameters :
|
extractAngularPathFromParentAppIfAny | |||||||||
extractAngularPathFromParentAppIfAny(angularPath: string, possibleJourneyPaths)
|
|||||||||
Parameters :
|
extractDebugFlags | ||||||
extractDebugFlags(inputFlags: InputDebugFlagsWithDeprecated)
|
||||||
Parameters :
Returns :
DebugFlags
|
extractFrameData | |||||||||
extractFrameData(tree: Tree, options: ExtractFrameDataOptions)
|
|||||||||
Parameters :
|
extractImportSpecifiersFromType | ||||||
extractImportSpecifiersFromType(type, bbComponentAst)
|
||||||
Parameters :
Returns :
string[]
|
extractJourneyModel | |||||||||||||||
extractJourneyModel(tree: Tree, destinationDirectory: string, pagesJson: PagesConfigurationWithTransformedDynamicForms, projectName: string)
|
|||||||||||||||
Parameters :
|
getBbStateType | |||||||||
getBbStateType(bb: BuildingBlockConfiguration, tree: Tree)
|
|||||||||
Parameters :
|
hasDeclarationNode | ||||||||||||
hasDeclarationNode(declarations, identifier: string, ast)
|
||||||||||||
Parameters :
|
processInlineObjectType | ||||||
processInlineObjectType(type, bbComponentAst)
|
||||||
Extract import specifiers from inline object types e.g. { name: string; address: AddressBb; } => ['AddressBb']
Parameters :
|
processMappedType | ||||||
processMappedType(type, bbComponentAst)
|
||||||
Extract import specifiers from MappedType e.g. { [key in SomeEnum]: unknown } => ['SomeEnum']
Parameters :
|
processTypeWithArguments | ||||||
processTypeWithArguments(type, bbComponentAst)
|
||||||
Extract import specifiers from types with arguments e.g. Record<string, BbState> => ['BbState']
Parameters :
|
shouldImportType | ||||||
shouldImportType(type, bbComponentAst)
|
||||||
Parameters :
|
extractInternationalizationBuildConfigurations | |||||||||
extractInternationalizationBuildConfigurations(locales, localesDestinationFolder: string)
|
|||||||||
Parameters :
Returns :
BuildTargetConfiguration
|
extractInternationalizationGenerateAndServeConfigurations | |||||||||
extractInternationalizationGenerateAndServeConfigurations(locales, projectName: string)
|
|||||||||
Parameters :
Returns :
GenerateAndServeConfiguration
|
extractInternationalizationRootConfiguration | ||||||||||||
extractInternationalizationRootConfiguration(sourceLocale, localeFilePaths, stripLocaleBaseHref)
|
||||||||||||
Parameters :
Returns :
InternationalizationConfiguration
|
extractInternationalizationServeConfigurations | |||||||||
extractInternationalizationServeConfigurations(locales, projectName: string)
|
|||||||||
Parameters :
Returns :
BuildTargetConfiguration
|
extractLocaleFromFilePath | ||||||
extractLocaleFromFilePath(filePath: string)
|
||||||
Parameters :
Returns :
string | undefined
|
extractLocalesFromFileNames | ||||
extractLocalesFromFileNames(localeFilePaths)
|
||||
Parameters :
Returns :
string[]
|
extractLibraryData | |||||||||
extractLibraryData(tree: Tree, projectPath: string)
|
|||||||||
Parameters :
Returns :
LibraryJsonSchema
|
extractPackageJsonData | ||||||
extractPackageJsonData(projectFolder: string)
|
||||||
Parameters :
Returns :
packageJsonData
|
readPackageJsonFile | ||||||
readPackageJsonFile(projectFolder: string)
|
||||||
Parameters :
|
extractPluginType | ||||||
extractPluginType(checker, classNode)
|
||||||
Parameters :
|
extractPluginValidatorData | ||||||||||||
extractPluginValidatorData(fileName: string, classNode, logger: Logger)
|
||||||||||||
Parameters :
|
extractStateKeyPlaceholders | ||||
extractStateKeyPlaceholders(notifications)
|
||||
Parameters :
Returns :
string[]
|
getNotificationsConfigForTemplate | ||||
getNotificationsConfigForTemplate(notifications)
|
||||
Parameters :
Returns :
literal type
|
getTransformedMessageAndTitle | ||||||
getTransformedMessageAndTitle(notifications, stateKeys)
|
||||||
Parameters :
Returns :
NotificationConfig[]
|
sortNonErrorNotificationsByContext | ||||
sortNonErrorNotificationsByContext(notifications)
|
||||
Parameters :
|
extractWebComponentRoutesFromHash | ||||||||
extractWebComponentRoutesFromHash(hash: string)
|
||||||||
Parameters :
Returns :
WebComponentRoutes
a map of web component ids and their associated paths |
upsertWebComponentRoutesInHash | ||||||||||||||||
upsertWebComponentRoutesInHash(webCompId: string, path: string, hash: string)
|
||||||||||||||||
Parameters :
Returns :
string
the given hash including the new/changed web component path |
urlEncodeWebComponentRoutes | ||||||||
urlEncodeWebComponentRoutes(routes: WebComponentRoutes)
|
||||||||
Parameters :
Returns :
string
string with web component routes encoded for usage in a URL |
findLatestCompatibleTalyVersion |
findLatestCompatibleTalyVersion(configDirectory: string, currentlyInstalledTalyVersion: string)
|
Returns :
Promise<string>
|
format |
format(filePath: string, content: string)
|
|
migrate | ||||||
migrate(configDirectory: string)
|
||||||
Parameters :
|
migrateClassicJourney | ||||||
migrateClassicJourney(configDirectory: string)
|
||||||
migrates a classic journey configuration
Parameters :
|
migrateSplitJourney | ||||||
migrateSplitJourney(configDirectory: string)
|
||||||
migrates a split journey configuration
Parameters :
|
updateJsonFileIfChanged | |||||||||
updateJsonFileIfChanged(filePath: string, updatedContent: T)
|
|||||||||
Parameters :
|
generate | |||||||||
generate(tree: Tree, options: PluginGeneratorSchema)
|
|||||||||
Parameters :
|
generateApp | |||||||||
generateApp(projectName: string, options: GenerateAppSchema)
|
|||||||||
Parameters :
Returns :
void
|
generateJournal |
generateJournal(__namedParameters: {libraryFolder: string, packageName: string, logger: Logger})
|
Create the Journal by following the following steps
Returns :
Promise<JournalContent>
|
logWarning | |||||||||
logWarning(__namedParameters: {stats: BuildingBlockFolderStats, logger: Logger})
|
|||||||||
Parameters :
|
generateJourney | ||||||
generateJourney(options: GenerateJourneyOptions)
|
||||||
Parameters :
|
generateJourney | ||||||
generateJourney(options: GenerateJourneyOptions)
|
||||||
This function generates a journey in a new Nx workspace. It returns an AsyncIterator that yields the generation progress. Usage:
Parameters :
Returns :
AsyncGenerator<ProgressReport, void>
|
generateJourneySrc | |||||||||
generateJourneySrc(destinationDirectory: string, generationOptions: JourneySrcGenerationOptions)
|
|||||||||
Parameters :
|
updateProjectConfig | |||||||||
updateProjectConfig(destinationDirectory: string, options: JourneySrcGenerationOptions)
|
|||||||||
Parameters :
|
generatePageConfig | ||||
generatePageConfig(pages)
|
||||
Parameters :
Returns :
string
|
generatePageImport | ||||||
generatePageImport(pageName: string)
|
||||||
Parameters :
Returns :
string
|
generatePageImports | ||||
generatePageImports(pages)
|
||||
Parameters :
Returns :
string
|
getPageConfigName | ||||||
getPageConfigName(name: string)
|
||||||
Parameters :
Returns :
string
|
getPageMappingFileOptions | ||||
getPageMappingFileOptions(pages)
|
||||
Parameters :
|
getPageRouteClassName | ||||||
getPageRouteClassName(name: string)
|
||||||
Parameters :
Returns :
string
|
getPageRouteName | ||||||
getPageRouteName(name: string)
|
||||||
Parameters :
Returns :
string
|
mappingServiceEntry | ||||||
mappingServiceEntry(name: string)
|
||||||
Parameters :
Returns :
string
|
generateWorkspace | ||||||
generateWorkspace(options: GenerateWorkspaceOptions)
|
||||||
Parameters :
|
generateWorkspace | ||||||
generateWorkspace(options: GenerateWorkspaceOptions)
|
||||||
This function generates a new TALY Nx workspace. It returns an AsyncIterator that yields the generation progress.
Parameters :
Returns :
AsyncGenerator<ProgressReport, void>
|
getAclDefaults | |||||||||
getAclDefaults(buildingBlocks, libraries)
|
|||||||||
extracts acl defaults for the given building blocks from the libraries' journals
Parameters :
Returns :
Map<string, AclDefault>
|
getAclDefaultsForLibrary | ||||||||||||
getAclDefaultsForLibrary(libraryName: string, libraryJournal: JournalFileSchema, buildingBlocks)
|
||||||||||||
Parameters :
Returns :
Map<string, AclDefault>
|
getAllBlocks | ||||||
getAllBlocks(page: PageConfigurationWithTransformedDynamicForms)
|
||||||
Parameters :
|
getAllBuildingBlocksInPage | ||||||||
getAllBuildingBlocksInPage(page: PageConfigurationWithTransformedDynamicForms)
|
||||||||
Parameters :
Returns :
[]
An array of all building block configurations in a page |
getBuildingBlockConfigurations | ||||||||
getBuildingBlockConfigurations(journey: Journey)
|
||||||||
Parameters :
Returns :
[]
An array of all building block configurations across all pages |
getBuildingBlockLibraries | ||||||||
getBuildingBlockLibraries(journey: Journey)
|
||||||||
Parameters :
Returns :
string[]
An Array with the Building Block libraries used within the journey. |
getBuildingBlocksWithJourneyMetadata | ||||||||
getBuildingBlocksWithJourneyMetadata(journey: Journey)
|
||||||||
Parameters :
Returns :
BuildingBlockWithJourneyMetadata[]
An Array with {@link BuildingBlockWithJourneyMetadata} objects.
Each object contains the building block configuration in the |
getBuildingBlockUsageCounts | ||||||||
getBuildingBlockUsageCounts(journey: Journey)
|
||||||||
Parameters :
Returns :
Map<string, number>
A map with building block selectors as keys and the count how often they are used in the journey as values |
getJourneyPackages | ||||||||
getJourneyPackages(journey: Journey)
|
||||||||
Parameters :
Returns :
string[]
An Array with the libraries listed within the journey configuration. |
getUniqueBuildingBlocks | ||||||||
getUniqueBuildingBlocks(journey: Journey)
|
||||||||
Parameters :
Returns :
string[]
An array of the unique Building Block selectors that are used in the given journey configuration |
isPageWithBlocks | ||||||
isPageWithBlocks(page: PageConfiguration)
|
||||||
Parameters :
Returns :
PageWithBlocks
|
getBuildingBlockId | ||||
getBuildingBlockId(symbol)
|
||||
Parameters :
|
getBuildingBlockTitle |
getBuildingBlockTitle(packageName: string, selector: string, usedLibraries)
|
|
getJourneyInsights | |||||||||
getJourneyInsights(pagesJson: PagesConfigurationWithTransformedDynamicForms, usedLibraries)
|
|||||||||
Parameters :
|
getPageDetails | |||||||||
getPageDetails(pagesJson: PagesConfigurationWithTransformedDynamicForms, usedLibraries)
|
|||||||||
Parameters :
|
getCoercedTypeNode | ||||
getCoercedTypeNode(typeArgumentData)
|
||||
Given a TypeArgument node.
We won't accept anything that is not a type reference (e.g. literals:
Parameters :
|
getDependencyStrings | ||||||
getDependencyStrings(dependencies)
|
||||||
This function will return an array of strings that can be used to install the given dependencies.
Parameters :
|
installJourneyDependencies | |||||||||||||||
installJourneyDependencies(destinationDirectory: string, journey: Journey, includeWebcomponentDependencies: boolean, legacyDependencyResolution?: boolean)
|
|||||||||||||||
Parameters :
|
getDisallowedTenantProperties | ||||||||||||||||
getDisallowedTenantProperties(baseConfig: JsonValue, tenantConfig, currentConfigPath)
|
||||||||||||||||
Parameters :
|
hasRefDefault | ||||
hasRefDefault(config)
|
||||
Parameters :
Returns :
boolean
|
replaceRefDefault | ||||||||||||||||
replaceRefDefault(baseConfig: JsonValue, tenantConfig: JsonValue, currentConfigPath)
|
||||||||||||||||
Parameters :
Returns :
JsonValue
|
getExpandedOptions | ||||||
getExpandedOptions(options: LibraryGeneratorSchema)
|
||||||
Parameters :
Returns :
ExpandedLibraryGeneratorSchema
|
library | |||||||||
library(tree: Tree, options: LibraryGeneratorSchema)
|
|||||||||
Parameters :
|
verifyWorkspaceSetup | ||||||
verifyWorkspaceSetup(tree: Tree)
|
||||||
Parameters :
|
getFirstPageId | ||||||
getFirstPageId(config: PfeJsonSchema)
|
||||||
Parameters :
Returns :
string | undefined
|
getI18nOutputFileName | ||||||
getI18nOutputFileName(format)
|
||||||
Cherry picked from angular-cli via https://github.com/angular/angular-cli/blob/956e7ea1f53f8e705e7e6a9fa141742f06e907a7/packages/angular_devkit/build_angular/src/builders/extract-i18n/index.ts#L31
Parameters :
|
getSourceLocaleCode | ||||
getSourceLocaleCode(sourceLocaleConfig)
|
||||
Parameters :
|
runI18nExtractExecutor | |||||||||
runI18nExtractExecutor(options: ExtractI18nExecutorSchema, context: ExecutorContext)
|
|||||||||
Parameters :
|
getJsonFilePathInDirectory | ||||||||||||||||
getJsonFilePathInDirectory(tree: Tree, sourcePath: string, filename: string)
|
||||||||||||||||
Get the path of a file with a specific name in a given directory.
Parameters :
Returns :
string | undefined
The file path or undefined. |
getJsonFilePathsInDirectory | ||||||||||||
getJsonFilePathsInDirectory(tree: Tree, sourcePath: string)
|
||||||||||||
Get all the paths in a given directory OR an empty array if can't found the directory.
Parameters :
Returns :
string[]
A list of all the matching paths. |
migrateBBPluginValidations | ||||||
migrateBBPluginValidations(tree: Tree)
|
||||||
Parameters :
|
migrateClassicJourney | |||||||||
migrateClassicJourney(tree: Tree, configDirectory: string)
|
|||||||||
Parameters :
|
migrateSplitJourney | |||||||||
migrateSplitJourney(tree: Tree, configDirectory: string)
|
|||||||||
Parameters :
|
parseJsonc | ||||||||||||||||
parseJsonc(tree: Tree, jsonFilePath: string, __namedParameters: {excludeSchema: boolean})
|
||||||||||||||||
Given an file path, parse the content of the file as JSONC.
Parameters :
Returns :
T
The parsed JSONC content. |
updateJsonFileIfChanged | ||||||||||||
updateJsonFileIfChanged(tree: Tree, filePath: string, updatedContent: T)
|
||||||||||||
Parameters :
|
getJsonFilePathInDirectory | ||||||||||||
getJsonFilePathInDirectory(sourcePath: string, filename: string)
|
||||||||||||
Get the path of a file with a specific name in a given directory.
Parameters :
Returns :
string | undefined
The file path or undefined. |
getJsonFilePathsInDirectory | ||||||||
getJsonFilePathsInDirectory(sourcePath: string)
|
||||||||
Get all the paths in a given directory OR an empty array if can't found the directory.
Parameters :
Returns :
string[]
A list of all the matching paths. |
parseJsonc | ||||||||||||
parseJsonc(jsonFilePath: string, __namedParameters: {excludeSchema: boolean})
|
||||||||||||
Given an file path, parse the content of the file as JSONC.
Parameters :
Returns :
T
The parsed JSONC content. |
getLineBreakChar | ||||||
getLineBreakChar(stringWithLineBreaks: string)
|
||||||
Parameters :
Returns :
string
|
removeAllowAllRules | ||||||
removeAllowAllRules(policy: string)
|
||||||
Parameters :
Returns :
string
|
removeSubject | ||||||
removeSubject(policy: string)
|
||||||
Parameters :
Returns :
string
|
updatePolicyFromActionEffectToState | ||||||
updatePolicyFromActionEffectToState(policy: string)
|
||||||
Parameters :
Returns :
string
|
getMockHttpHandler |
getMockHttpHandler()
|
Returns :
HttpHandler
|
getMockOauthService |
getMockOauthService()
|
Returns :
OauthService
|
getNativeElement$ | ||||
getNativeElement$(control)
|
||||
getNativeElement$() allows it to subscribe to native element changes of a control. Use this function instead of directly accessing control.nativeElement$ to avoid issues regarding timing. For example, this might be the case when the native element of a control is initially hidden and appears at a later time.
Parameters :
Returns :
BehaviorSubject<HTMLElement | undefined>
|
getNxAbstractControl$ | ||||
getNxAbstractControl$(control)
|
||||
getNxAbstractControl$() allows it to subscribe to nxAbstractControl changes of a control. Use this function to access the nxAbstractControl of a component without timing issues. It provides functionality to set the readonly state. For example, this might be the case when the element of a nxAbstractControl is initially hidden and appears at a later time.
Parameters :
|
getNavigationSectionFromPagesConfig | ||||||
getNavigationSectionFromPagesConfig(pagesConfig: Pick)
|
||||||
Parameters :
Returns :
SectionConfiguration[]
|
getPfeConfigAsTsNodeText | ||||||
getPfeConfigAsTsNodeText(pfeConfig: NgxPfeConfig)
|
||||||
Parameters :
Returns :
string
|
getPfeConfigOverrides | ||||||
getPfeConfigOverrides(pfeConfig: NgxPfeConfig)
|
||||||
Parameters :
Returns :
NgxPfeConfig
|
getPfeConfigWithPagesConfiguration | |||||||||
getPfeConfigWithPagesConfiguration(pfeConfig: PfeJsonSchema, pages)
|
|||||||||
Parameters :
Returns :
NgxPfeConfig
|
pfeSetup | |||||||||||||||
pfeSetup(tree: Tree, pfeConfig: PfeJsonSchema, pagesConfig: PagesConfigurationWithTransformedDynamicForms, destinationDirectory: string)
|
|||||||||||||||
Parameters :
|
getPluginId | ||||||||
getPluginId(symbolName: string)
|
||||||||
Parameters :
|
runPluginMetadata | ||||||||||||||||||||||||
runPluginMetadata(context: BuilderContext, logger: Logger, projectPath: string, __namedParameters: {pluginFolder: PluginFolderStats, moduleFilePath, injectableFilePath, markdownFilePath})
|
||||||||||||||||||||||||
Parameters :
|
getPossiblePathsToJournalJson | ||||||||||||
getPossiblePathsToJournalJson(tree: Tree, libraryName: string, workspaceNodeModulesDirectory: string)
|
||||||||||||
Parameters :
Returns :
string[]
|
readJournals | ||||||||||||
readJournals(tree: Tree, libraryNames, workspaceNodeModulesDirectory: string)
|
||||||||||||
Parameters :
Returns :
LibraryMetaData[]
|
getSectionsBeforeCurrentSection | |||||||||
getSectionsBeforeCurrentSection(currentSection, sections: SectionConfig)
|
|||||||||
Parameters :
Returns :
string[]
|
getSectionsWithStates | |||||||||
getSectionsWithStates(pageHistory, sections: SectionConfig)
|
|||||||||
Parameters :
Returns :
SectionWithState[]
|
getSingleSourceFile | |||||||||
getSingleSourceFile(program, fileName: string)
|
|||||||||
Parameters :
|
getSourceFiles | ||||
getSourceFiles(program)
|
||||
Given a TS program return all actual given source files aka root source files and filtered by declaration files (if any).
Parameters :
|
getSyntaxKindToName | ||||
getSyntaxKindToName(givenKind)
|
||||
Parameters :
|
getTrackingValue | ||||||
getTrackingValue(control: TalyAbstractControl)
|
||||||
Parameters :
|
pushTrackingEvents | |||||||||||||||
pushTrackingEvents(control: TalyAbstractControl, trackingIdPrefix: string, controlName: string, pushEvent)
|
|||||||||||||||
Parameters :
Returns :
void
|
setupFormTracking | ||||||||||||||||||||||||
setupFormTracking(controlOrGroup: AbstractControl, trackingIdPrefix: string, untilDestroyed$: Observable, pushEvent: PushEventFunction, parentPath)
|
||||||||||||||||||||||||
Parameters :
Returns :
void
|
trackControl | ||||||||||||||||||
trackControl(control: AbstractControl, trackingIdPrefix: string, controlName: string, untilDestroyed$: Observable, pushEvent: PushEventFunction)
|
||||||||||||||||||
Parameters :
Returns :
void
|
trackForm | |||||||||||||||
trackForm(controlOrGroup: AbstractControl, trackingIdPrefix: string, untilDestroyed$: Observable, pushEvent: PushEventFunction)
|
|||||||||||||||
Parameters :
Returns :
void
|
globMatch |
globMatch(value: string, pattern: string)
|
Create a regex to match glob like strings. my/resource/path matches 'resources/*' Overly simplified. A star (*) matches virtually everything. No difference between one statr and two stars. No brace expansion. No extglob syntax. Reasons for this instead of using a proper glob library:
Friends like micromatch, picomatch & nanomatch rely on They are one of the reasons we decided for the first version to reimplement the core principles of casbin instead of just using it. To get into globbing mood check the page to tinker around: https://globster.xyz/ |
regExpEscape | ||||||
regExpEscape(s: string)
|
||||||
Parameters :
|
wildcardToRegExp | ||||||
wildcardToRegExp(s: string)
|
||||||
This regex is not written by us, but found somewhere in the guts of the internet. Unfortunately we did not record the exact source to provide proper credits.
Parameters :
Returns :
RegExp
|
isBuildingBlockConfigurationWithValidators | ||||
isBuildingBlockConfigurationWithValidators(block)
|
||||
Parameters :
Returns :
BuildingBlockConfiguration
|
isBuiltInValidationRule | ||||||
isBuiltInValidationRule(validationRule: any)
|
||||||
Parameters :
Returns :
ValidationRule
|
migrateBBPluginValidationConfiguration | ||||
migrateBBPluginValidationConfiguration(validators)
|
||||
Parameters :
Returns :
ValidationRule[]
|
migrateBBPluginValidationConfigurationsInFrame | ||||||
migrateBBPluginValidationConfigurationsInFrame(frame: Frame)
|
||||||
Migrates the validation configuration for actions in the frame. The configuration is mutated directly.
Parameters :
Returns :
void
|
migrateBBPluginValidationsInApplicationJson | ||||||
migrateBBPluginValidationsInApplicationJson(applicationJson: ApplicationJsonSchema)
|
||||||
Parameters :
|
migrateBBPluginValidationsInPage | ||||||
migrateBBPluginValidationsInPage(pageConfiguration: PageJsonSchema)
|
||||||
Parameters :
Returns :
PageJsonSchema
|
migrateBBPluginValidationsInPagesJson | ||||||
migrateBBPluginValidationsInPagesJson(pagesConfiguration: PagesJsonSchema)
|
||||||
Parameters :
|
isConditionMet | ||||||||||||
isConditionMet(condition: string, environment: Record, storeQuery)
|
||||||||||||
Parameters :
Returns :
boolean
|
isFiltrexError | ||||
isFiltrexError(result)
|
||||
Parameters :
Returns :
FiltrexError
|
isFormArray | ||||||
isFormArray(control: AbstractControl)
|
||||||
Parameters :
Returns :
UntypedFormArray
|
isFormControl | ||||||
isFormControl(control: AbstractControl)
|
||||||
Parameters :
Returns :
UntypedFormControl
|
isFormGroup | ||||||
isFormGroup(control: AbstractControl)
|
||||||
Parameters :
Returns :
UntypedFormGroup
|
isPluginConfigWithLibVersion | ||||
isPluginConfigWithLibVersion(library)
|
||||
Parameters :
Returns :
PluginConfigWithLibVersion
|
makeStickyBuildingBlockTheBannerBlock | ||||||
makeStickyBuildingBlockTheBannerBlock(pagesConfiguration: PagesJsonSchema)
|
||||||
Parameters :
Returns :
PagesJsonSchema
|
migratePluginLibrariesToLibraries | ||||||
migratePluginLibrariesToLibraries(pagesConfiguration: PagesJsonSchema)
|
||||||
Parameters :
|
migrateSInterpolationToCurlyBraceInterpolation | ||||||
migrateSInterpolationToCurlyBraceInterpolation(source: string)
|
||||||
Parameters :
Returns :
string
|
moveStageConfigFromPageDataToTitle | ||||||
moveStageConfigFromPageDataToTitle(pagesConfiguration: PagesJsonSchema)
|
||||||
Parameters :
Returns :
PagesJsonSchema
|
removeSecondaryEntryPoint | ||||||||||||||||||
removeSecondaryEntryPoint(packageName: string)
|
||||||||||||||||||
This function will remove anything that looks like a secondary entry point from a package name. It works for scoped packages as well as unscoped packages.
Parameters :
Returns :
string
|
isRunByJest |
isRunByJest()
|
missingPolicyWarning |
missingPolicyWarning()
|
isStoreQuery | ||||||
isStoreQuery(query: StaticResource)
|
||||||
Parameters :
Returns :
StoreQuery
|
isUndefined | ||||
isUndefined(value)
|
||||
Parameters :
Returns :
undefined
|
normalizeExecutorOptions | ||||||
normalizeExecutorOptions(options: Record)
|
||||||
Turns an options object into an array of CLI params. Input:
Parameters :
Returns :
string[]
|
loadAndTransformJourney | ||||||
loadAndTransformJourney(configDirectory: string)
|
||||||
Parameters :
Returns :
Promise<InternalJourney>
|
printBuildingBlockCounts | ||||||
printBuildingBlockCounts(configDirectory: string)
|
||||||
Parameters :
|
printBuildingBlockPackages | ||||||
printBuildingBlockPackages(configDirectory: string)
|
||||||
Parameters :
|
printBuildingBlocks | ||||||
printBuildingBlocks(configDirectory: string)
|
||||||
Parameters :
|
printBuildingBlocksWithJourneyMetadata | ||||||
printBuildingBlocksWithJourneyMetadata(configDirectory: string)
|
||||||
Parameters :
|
loadClassicJourneyFromFolder | ||||||||
loadClassicJourneyFromFolder(configDirectory: string)
|
||||||||
Loads a classic journey config from a given folder.
Parameters :
Returns :
Journey
A Promise that resolves to the loaded classic journey. |
loadJourneyFromFolder | ||||||||||||
loadJourneyFromFolder(configDirectory: string, baseConfigDirectory?: string)
|
||||||||||||
Parameters :
Example :
Returns :
Promise<Journey>
Promise that resolves to the journey configuration already validated. It rejects if the given directory does not contain a |
loadMultiTenantJourneyFromFolder |
loadMultiTenantJourneyFromFolder(baseConfigDirectory: string, tenantConfigDirectory: string)
|
Returns :
SplitJourney
|
readApplicationJson |
readApplicationJson(baseConfigDirectory: string, tenantConfigDirectory: string)
|
|
readMultiTenantDirectory |
readMultiTenantDirectory(baseConfigDirectory: string, tenantConfigDirectory: string)
|
|
readNavigationJson | ||||||||||||
readNavigationJson(baseConfigDirectory: string, tenantConfigDirectory: string, pages)
|
||||||||||||
Parameters :
|
md5 | ||||||
md5(str: string)
|
||||||
Parameters :
|
mergeEnvObjects |
mergeEnvObjects(hostEnvData, moduleEnvData: EnvObj, moduleId: string)
|
Returns :
EnvObj
|
migrateClassicJourney | |||||||||
migrateClassicJourney(tree: Tree, filePath: string)
|
|||||||||
Parameters :
|
migrateSplitJourney | |||||||||
migrateSplitJourney(tree: Tree, filePath: string)
|
|||||||||
Parameters :
|
updateFooterCopyright | ||||||
updateFooterCopyright(tree: Tree)
|
||||||
Parameters :
|
updateJsonFileIfChanged | ||||||||||||
updateJsonFileIfChanged(tree: Tree, filePath: string, updatedContent: T)
|
||||||||||||
Parameters :
|
migrateFooterCopyrightInApplicationJson | |||||||||
migrateFooterCopyrightInApplicationJson(applicationJson: ApplicationJsonSchema, filePath?: string)
|
|||||||||
Parameters :
|
migrateFooterCopyrightInPagesJson | |||||||||
migrateFooterCopyrightInPagesJson(pagesConfiguration: PagesJsonSchemaBeforeTheFooterCopyrightMigration, filePath?: string)
|
|||||||||
Parameters :
|
removeCopyRightYear |
removeCopyRightYear(copyrightContent: string, filePath?: string)
|
|
migratePfePagesConfiguration | |||||||||
migratePfePagesConfiguration(pfeConfiguration, pagesConfiguration: PagesJsonSchema)
|
|||||||||
Parameters :
Returns :
literal type
|
parseEnvFile | ||||||
parseEnvFile(content: string)
|
||||||
Cherry picked from dotenv via https://github.com/motdotla/dotenv/blob/7301ac9be0b2c766f865bbe24280bf82586d25aa/lib/main.js
Parameters :
Returns :
EnvOptionObject
|
parseEnvOptions | ||||
parseEnvOptions(overrides)
|
||||
Parse options given through the CLI.
Pass in a key only to retrieve the value from the process environment (via process.env)
or pass in a The result is a key-value object {a: 1, b:"value"}
Parameters :
Returns :
EnvOptionObject
|
readEnv | |||||||||
readEnv(tree: Tree, options: ReadEnvOptions)
|
|||||||||
Combines a given config of environment details with a separate list of env values given through the CLI. CLI values will override static config values. CLI values need to have the following format. The constructed env object returned by this function will then look like this:
Parameters :
Returns :
EnvOptionObject
|
readEnvFromFile | |||||||||
readEnvFromFile(tree: Tree, envPath?: string)
|
|||||||||
Read and parse env options from a plain text file in the format: A=1 B=value
Parameters :
Returns :
EnvOptionObject
|
parseYamlFile | |||||||||
parseYamlFile(path: string, logger: Logger)
|
|||||||||
Parameters :
|
readAclResourceDescriptor |
readAclResourceDescriptor(path: string, __namedParameters: {root: string, logger: Logger})
|
Returns :
AclDescriptor[]
|
validateAgainstSchemaFile | |||||||||
validateAgainstSchemaFile(document, logger: Logger)
|
|||||||||
Parameters :
|
pathMatching |
pathMatching(this, received: string, expected: string)
|
This custom matcher allows it to search for a path to be contained in a received result. It automatically converts the received path to the posix separator (/), which means the expected path should also be defined as such.
Returns :
jest.CustomMatcherResult
|
pathMatching |
pathMatching(this, received: string, expected: string)
|
This custom matcher allows it to search for a path to be contained in a received result. It automatically converts the received path to the posix separator (/), which means the expected path should also be defined as such.
Returns :
jest.CustomMatcherResult
|
PfeAclExpressionAdapterFactory | ||||||
PfeAclExpressionAdapterFactory(pfeStateService: PfeStateService)
|
||||||
Parameters :
Returns :
PfeAclExpressionAdapter
|
PfeAclExpressionAdapterFactory | ||||||
PfeAclExpressionAdapterFactory(pfeStateService: PfeStateService)
|
||||||
Parameters :
Returns :
PfeAclExpressionAdapter
|
proceedWithTemporaryTalyVersion | |||||||||
proceedWithTemporaryTalyVersion(talyVersion: string, options)
|
|||||||||
Parameters :
Returns :
AsyncGenerator<ProgressReport, void>
|
processAquilaThemePath | |||||||||
processAquilaThemePath(aquilaThemePath, destinationFolder: string)
|
|||||||||
Parameters :
Returns :
ThemeFile | null
|
provideDynamicFormNativeComponents |
provideDynamicFormNativeComponents()
|
Returns :
Provider[]
|
provideTalyStandaloneDynamicForm |
provideTalyStandaloneDynamicForm()
|
Provides everything the TALY Standalone Dynamic Form needs
Returns :
Provider[]
|
range | |||||||||
range(length: number, valueFunction)
|
|||||||||
Creates an array and fills it with values.
Parameters :
Returns :
T[]
|
readExperiments | ||||
readExperiments(requestedExperiments)
|
||||
Parameters :
Returns :
Experiments[]
|
validateExperiments | ||||
validateExperiments(experiments)
|
||||
Parameters :
Returns :
Experiments[]
|
readMarkdown | ||||||
readMarkdown(filePath: string)
|
||||||
Parameters :
Returns :
Promise<FrontMatterResult<any>>
|
readMarkdownAttributes | ||||||
readMarkdownAttributes(filePath: string)
|
||||||
Use Frontmatter to extract the header data of a given markdown file
Parameters :
Returns :
Promise<any>
|
readMarkdown | ||||||
readMarkdown(filePath: string)
|
||||||
Parameters :
Returns :
Promise<FrontMatterResult<any>>
|
readMarkdownAttributes | ||||||
readMarkdownAttributes(filePath: string)
|
||||||
Use Frontmatter to extract the header data of a given markdown file
Parameters :
Returns :
Promise<any>
|
removeAclSubject | ||||||
removeAclSubject(tree: Tree)
|
||||||
Parameters :
|
removeScreenshotExecutor | ||||||
removeScreenshotExecutor(tree: Tree)
|
||||||
Parameters :
|
renameI18nExecutorOptionsFromBrowserTargetToBuildTarget | ||||||
renameI18nExecutorOptionsFromBrowserTargetToBuildTarget(tree: Tree)
|
||||||
Parameters :
|
renderMarkdownAsHtml | ||||||
renderMarkdownAsHtml(text: string)
|
||||||
Parameters :
Returns :
string
|
replacePFEQueryWithStream | ||||||
replacePFEQueryWithStream(validationData, pfeQueries)
|
||||||
Parameters :
Returns :
ValidationConfigItem[]
|
run | |||||||||
run(options: ExtractPluginMetadataSchema, context: BuilderContext)
|
|||||||||
Parameters :
Returns :
Promise<literal type>
|
run | |||||||||
run(options: IntrospectionExecutorSchema, context: BuilderContext)
|
|||||||||
Parameters :
Returns :
Promise<literal type>
|
writeIntrospection | |||||||||
writeIntrospection(outputFile: string, content)
|
|||||||||
Write our introspection, include a hash over the given content & a date.
Parameters :
|
run | |||||||||
run(options: JournalExecutorSchema, context: BuilderContext)
|
|||||||||
Parameters :
Returns :
Promise<literal type>
|
runGenerateAndServeExecutor | |||||||||
runGenerateAndServeExecutor(options: GenerateAndServeExecutorSchema, context: ExecutorContext)
|
|||||||||
Parameters :
Returns :
Promise<literal type>
|
runGenerateExecutor | |||||||||
runGenerateExecutor(options: GenerateExecutorSchema, context: ExecutorContext)
|
|||||||||
Parameters :
|
scaffoldCore | |||||||||
scaffoldCore(tree: Tree, options: ScaffoldCoreOptions)
|
|||||||||
Parameters :
|
setShowroomDataInPfeState | ||||||||||||
setShowroomDataInPfeState(showroomDataForPage, pfeBusinessService: PfeBusinessService, buildingBlocksMap: DataForPage)
|
||||||||||||
Parameters :
|
setShowroomResourcesInPfeState | ||||||||||||
setShowroomResourcesInPfeState(showroomDataForPage: PageInJourneyExampleData, pfeBusinessService: PfeBusinessService, buildingBlocksMap: DataForPage)
|
||||||||||||
Takes dynamic resources in the page configuration, and sets the corresponding Building Block example data to the relevant key in the PFE state Ignores hardcoded resources in journey configuration
Parameters :
|
setShowroomStateInPfeState | |||||||||
setShowroomStateInPfeState(showroomDataForPage: PageInJourneyExampleData, pfeBusinessService: PfeBusinessService)
|
|||||||||
Parameters :
|
storeConfiguration | |||||||||||||||
storeConfiguration(tree: Tree, pagesJson: PagesConfigurationWithTransformedDynamicForms, policy, destinationDirectory: string)
|
|||||||||||||||
Parameters :
|
syncControlEdit | |||||||||
syncControlEdit(control: AbstractControl, aclObservable: Observable)
|
|||||||||
Disable or Enable a control for a given aclAttribute
Parameters :
|
syncControlReadonly | ||||||
syncControlReadonly(aclObservable: Observable)
|
||||||
Disable or Enable a control for a given aclAttribute Synchronizes the readonly attribute by using the NxAbstractControl, if implemented on the current element. Otherwise, the attribute is set directly on the nativeElement.
Parameters :
|
tapOnce | ||||
tapOnce(fn)
|
||||
Parameters :
|
transformLobValues | ||||||
transformLobValues(values)
|
||||||
Map incoming values of "motor" or "household" ot it's ABS value (KB, HH). That way people can author those values in a human-readable way in any Building Block markdown file while this transformation takes care of creating a data structure suitable for the UI-Editor.
Parameters :
|
turnJourneyModelIntoOpenApiSchema |
turnJourneyModelIntoOpenApiSchema(destinationDirectory: string, journeyModelName: string)
|
|
unparseOptions | ||||||
unparseOptions(options: Record)
|
||||||
Turns an options object into an array of schematic CLI params. Input:
Parameters :
Returns :
string[]
|
updateAclDefaults | ||||||
updateAclDefaults(tree: Tree)
|
||||||
Parameters :
|
updateBaseTsconfigJson | |||||||||
updateBaseTsconfigJson(tree: Tree, options: ProjectDetails)
|
|||||||||
Parameters :
|
updateBbStateTypes | ||||||
updateBbStateTypes(tree: Tree)
|
||||||
Parameters :
|
updateGitignore | ||||||
updateGitignore(tree: Tree)
|
||||||
Parameters :
|
updateImport | ||||||||||||||||||
updateImport(tree: Tree, filePath: string, symbolName: string, oldModuleName: string, newModuleName: string)
|
||||||||||||||||||
Parameters :
|
updateImports | |||||||||||||||||||||
updateImports(oldImport: string, newImport: string, importsToBeUpdated, filePath: string, content: string, tree: Tree)
|
|||||||||||||||||||||
Parameters :
|
updateSchemasImports | ||||||
updateSchemasImports(tree: Tree)
|
||||||
Parameters :
|
updateImport | ||||||||||||||||||
updateImport(tree: Tree, filePath: string, symbolName: string, oldModuleName: string, newModuleName: string)
|
||||||||||||||||||
Parameters :
|
updateImports | |||||||||||||||||||||
updateImports(oldImport: string, newImport: string, importsToBeUpdated, filePath: string, content: string, tree: Tree)
|
|||||||||||||||||||||
Parameters :
|
updateValidationErrorsImports | ||||||
updateValidationErrorsImports(tree: Tree)
|
||||||
Parameters :
|
updatePackageJson | |||||||||
updatePackageJson(tree: Tree, options: ProjectDetails)
|
|||||||||
Parameters :
|
updatePolicyFormat | ||||||
updatePolicyFormat(tree: Tree)
|
||||||
Parameters :
|
updateProjectInternationalization | |||||||||||||||
updateProjectInternationalization(tree: Tree, projectName: string, stripLocaleBaseHref: boolean, localesDestinationFolder: string)
|
|||||||||||||||
Parameters :
|
updateValidationErrorsComponent | ||||||
updateValidationErrorsComponent(tree: Tree)
|
||||||
Parameters :
|
useNativeDestroyRef | ||||||
useNativeDestroyRef(tree: Tree)
|
||||||
Parameters :
|
useTalyI18nExecutor | ||||||
useTalyI18nExecutor(tree: Tree)
|
||||||
Parameters :
|
validateJourneyConfig | ||||||
validateJourneyConfig(configDirectory: string)
|
||||||
Parameters :
|
writeJournal | |||||||||
writeJournal(outputFile: string, content: JournalContent)
|
|||||||||
Write our journal, include a hash over the given content & a date.
Parameters :
|
writeJourneyToFolder |
writeJourneyToFolder(journeyConfiguration: Journey, configDirectory: string)
|
|
writePluginMetadata | |||||||||
writePluginMetadata(outputFile: string, content)
|
|||||||||
Write our metadata file, include a hash over the given content & a date.
Parameters :
|