Index

libs/core/src/lib/form-support/plugins-validation.ts

__setPluginValidators
__setPluginValidators(pluginValidators)
Parameters :
Name Optional
pluginValidators No
extractPluginValidationFactory
extractPluginValidationFactory(pv: PluginValidatorUnion)
Parameters :
Name Type Optional
pv PluginValidatorUnion No
getPluginValidations
getPluginValidations()
isAsyncValidator
isAsyncValidator(validator: PluginValidatorUnion)
Parameters :
Name Type Optional
validator PluginValidatorUnion No

libs/core/src/lib/building-block/abstract-building-block.ts

accumulateBusinessEvents
accumulateBusinessEvents(arr, event: BusinessEventStatus)
Parameters :
Name Type Optional Default value
arr No [] as BusinessEventStatus[]
event BusinessEventStatus No
createDeferred
createDeferred()
Returns : Deferred
groupEventStatusesByName
groupEventStatusesByName(arr)
Parameters :
Name Optional Default value
arr No []

libs/acl/angular/src/lib/providers/create-async-acl-tag.ts

AclTagForInstanceAndParentFactory
AclTagForInstanceAndParentFactory(instance: BehaviorSubject, anyParent: AclTag, transient: BehaviorSubject)
Parameters :
Name Type Optional
instance BehaviorSubject No
anyParent AclTag No
transient BehaviorSubject No
createAsyncAclTagProviders
createAsyncAclTagProviders()

Create an AclTag token with a bound ACL_TAG_NAME_ASYNC_TOKEN which resolves to a Behavior Subject. Inject this behaviour subject and forward the tag name to the Acl Tag.

Created because the directive wasn't able to inject itself like it's working with usual components

providers: [ createAsyncAclTagProviders() ]

EmptyBehaviorSubjectFactory
EmptyBehaviorSubjectFactory()
Returns : BehaviorSubject<string>

libs/nx/src/generators/journey-src/lib/add-acl-defaults-to-policy/add-acl-defaults-to-policy.ts

addAclDefaultsToPolicy
addAclDefaultsToPolicy(tree: Tree, options: AddAclDefaultsToPolicyOptions, usedBuildingBlocks, usedLibraries)
Parameters :
Name Type Optional
tree Tree No
options AddAclDefaultsToPolicyOptions No
usedBuildingBlocks No
usedLibraries No

libs/nx/src/generators/building-block/lib/add-bb-dependencies-to-workspace/add-bb-dependencies-to-workspace.ts

addAdditionalDependencies
addAdditionalDependencies(tree: Tree)

The version of dependencies in the following method have to be maintained manually. They are not part of the TALY's workspace so they won't get automatically updated.

Parameters :
Name Type Optional
tree Tree No
addBbDependenciesToWorkspace
addBbDependenciesToWorkspace(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/generators/journey-src/lib/add-element-builder-scripts/add-element-builder-scripts.ts

addElementBuilderScripts
addElementBuilderScripts(tree: Tree, destinationDirectory: string)
Parameters :
Name Type Optional
tree Tree No
destinationDirectory string No

libs/nx/src/generators/building-block-example/generator.ts

addExample
addExample(tree: Tree, options: AddExampleOptionsWithPrefixedNameAndBuildingBlock)
Parameters :
Name Type Optional
tree Tree No
options AddExampleOptionsWithPrefixedNameAndBuildingBlock No
generate
generate(tree: Tree, options: BuildingBlockExampleGeneratorSchema)
Parameters :
Name Type Optional
tree Tree No
options BuildingBlockExampleGeneratorSchema No
updateExportIndexFile
updateExportIndexFile(tree: Tree, options: AddExampleOptionsWithPrefixedNameAndBuildingBlock)
Parameters :
Name Type Optional
tree Tree No
options AddExampleOptionsWithPrefixedNameAndBuildingBlock No
updateMdFile
updateMdFile(tree: Tree, options: AddExampleOptionsWithPrefixedNameAndBuildingBlock)
Parameters :
Name Type Optional
tree Tree No
options AddExampleOptionsWithPrefixedNameAndBuildingBlock No
writeToFile
writeToFile(tree: Tree, path: string, newContent: string)
Parameters :
Name Type Optional
tree Tree No
path string No
newContent string No

libs/nx/src/generators/journey/generator.ts

addFiles
addFiles(tree: Tree, options: NormalizedSchema)
Parameters :
Name Type Optional
tree Tree No
options NormalizedSchema No
addProject
addProject(tree: Tree, options: NormalizedSchema)
Parameters :
Name Type Optional
tree Tree No
options NormalizedSchema No
expandOptions
expandOptions(options: JourneyGeneratorSchema)
Parameters :
Name Type Optional
options JourneyGeneratorSchema No
Returns : NormalizedSchema
generateJourney
generateJourney(tree: Tree, options: JourneyGeneratorSchema)
Parameters :
Name Type Optional
tree Tree No
options JourneyGeneratorSchema No

libs/nx/src/generators/journey-src/lib/add-lib-assets-to-build-target/add-lib-assets-to-build-target.ts

addLibAssetsToBuildTarget
addLibAssetsToBuildTarget(tree: Tree, projectName: string, libraries)
Parameters :
Name Type Optional
tree Tree No
projectName string No
libraries No
createAssetConfigsFromLibs
createAssetConfigsFromLibs(tree: Tree, libraries)
Parameters :
Name Type Optional
tree Tree No
libraries No
Returns : AssetPatternWithRoot[]
getLibraryRoot
getLibraryRoot(tree: Tree, packageName: string)
Parameters :
Name Type Optional
tree Tree No
packageName string No
getMismatchedAssets
getMismatchedAssets(existingAssets, assetConfigsFromLibs)
Parameters :
Name Optional
existingAssets No
assetConfigsFromLibs No

libs/sdk/src/lib/journey/transform/transform.ts

addLocalizeMarker
addLocalizeMarker(config: JsonValue, translatableProperties)
Parameters :
Name Type Optional
config JsonValue No
translatableProperties No
Returns : JsonValue
getDynamicFormTranslatableProperties
getDynamicFormTranslatableProperties()
isDynamicFormBbConfig
isDynamicFormBbConfig(block)
Parameters :
Name Optional
block No
transformDynamicFormConfigs
transformDynamicFormConfigs(pagesJson: PagesJsonSchema)

Convert Dynamic Form configurations to Building Block configurations.

Parameters :
Name Type Optional
pagesJson PagesJsonSchema No
transformJourneyToInternalJourney
transformJourneyToInternalJourney(journey: Journey)

Apply extra transformations to a journey to be used internally.

Parameters :
Name Type Optional
journey Journey No
Returns : InternalJourney

libs/acl/form-support/src/lib/core/sync-control-view.ts

addNestedControl
addNestedControl(form: UntypedFormGroup, path: string, control: AbstractControl)
Parameters :
Name Type Optional
form UntypedFormGroup No
path string No
control AbstractControl No
removeNestedControl
removeNestedControl(form: UntypedFormGroup, path: string)

Support

Parameters :
Name Type Optional
form UntypedFormGroup No
path string No
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 some and the the control path there.

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 :
Name Type Optional
form UntypedFormGroup No
path string No
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 :
Name Type Optional
form UntypedFormGroup No
controlKey string No
aclObservable Observable No

libs/nx/src/generators/library/updaters/add-workspace-dependencies/add-workspace-dependencies.ts

addNxDependencies
addNxDependencies(tree: Tree, packageJsonPath: string)
Parameters :
Name Type Optional
tree Tree No
packageJsonPath string No
addWorkspaceDependencies
addWorkspaceDependencies(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/sdk/src/lib/journey/pages/pages.ts

addPage
addPage(page: Page, source: Journey)
Parameters :
Name Type Optional
page Page No
source Journey No
Returns : Journey
removePage
removePage(pageId: PageId, source: Journey)
Parameters :
Name Type Optional
pageId PageId No
source Journey No
Returns : Journey

libs/nx/src/generators/library/updaters/add-project-config/add-project-config.ts

addProjectConfig
addProjectConfig(tree: Tree, options: ExpandedLibraryGeneratorSchema)
Parameters :
Name Type Optional
tree Tree No
options ExpandedLibraryGeneratorSchema No

libs/nx/src/generators/journey-src/lib/add-showroom-files/add-showroom-files.ts

addShowroomFiles
addShowroomFiles(tree: Tree, destinationDirectory: string, pagesJson: PagesConfigurationWithTransformedDynamicForms, showroomJson?: ShowroomJsonSchema)
Parameters :
Name Type Optional
tree Tree No
destinationDirectory string No
pagesJson PagesConfigurationWithTransformedDynamicForms No
showroomJson ShowroomJsonSchema Yes

libs/nx/src/generators/library/updaters/add-templates/add-templates.ts

addTemplates
addTemplates(tree: Tree, options: ExpandedLibraryGeneratorSchema)
Parameters :
Name Type Optional
tree Tree No
options ExpandedLibraryGeneratorSchema No

libs/core/src/lib/form-support/validation.ts

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 controlPath parameter is used to manage the recursion and is expected to be empty in the initial call.

Parameters :
Name Type Optional Description
control AbstractControl No

the control to add validators to (can be a form group, form array or form control)

controlPath No

the form control path pieces of the given control (e.g. ['group', 'id']). Used for recursion. Pass in empty array if you are calling this manually.

validationMap Map No

a map of control paths and their associated validators

cleanup$ ReplaySubject No
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 :
Name Type Optional
form UntypedFormGroup No
config No
applyValidationToControl
applyValidationToControl(control: AbstractControl, validators, asyncValidators)
Parameters :
Name Type Optional Default value
control AbstractControl No
validators No []
asyncValidators No []
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 :
Name Type Optional
form UntypedFormGroup No
collectConfigurationItems
collectConfigurationItems(config)

Ensure that we don't have duplicates in the given list of validations.

Parameters :
Name Optional Default value
config No []
findErroneousFormControls
findErroneousFormControls(formControls: Record)
Parameters :
Name Type Optional
formControls Record No
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 :
Name Type Optional Description
controlPath No

path pieces to a control, e.g. ['group', 'id'] or ['items', '*', 'id']

validationMap Map No

map of control paths and their validation configs

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 :
Name Type Optional
config No
validations ValidationDefinitions No
safeApplyValidationToControl
safeApplyValidationToControl(key: string, control, validators, asyncValidators, validationConfigsForControl, cleanup$: ReplaySubject)
Parameters :
Name Type Optional
key string No
control No
validators No
asyncValidators No
validationConfigsForControl No
cleanup$ ReplaySubject No
subscribeToDynamicParameters
subscribeToDynamicParameters(control: AbstractControl, validationConfigsForControl, cleanup$: ReplaySubject)
Parameters :
Name Type Optional
control AbstractControl No
validationConfigsForControl No
cleanup$ ReplaySubject No
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 :
Name Type Optional
item ValidationConfigItem No
validations ValidationDefinitions No

libs/nx/src/generators/journey-src/lib/add-web-component-builder-target-to-project-config/add-web-component-builder-target-to-project-config.ts

addWebcomponentBuilderTargetToProjectConfig
addWebcomponentBuilderTargetToProjectConfig(tree: Tree, projectName: string, deployUrl?: string)
Parameters :
Name Type Optional
tree Tree No
projectName string No
deployUrl string Yes

libs/sdk/src/node/journey/load/split-journey/split-journey.ts

aggregateJourneyConfig
aggregateJourneyConfig(journeyConfig: SplitJourney)

Aggregates the split journey configuration into a classic journey configuration.

Parameters :
Name Type Optional Description
journeyConfig SplitJourney No
  • The split journey configuration.
Returns : Journey

The aggregated (classic) journey configuration.

extractDuplicates
extractDuplicates(array)

Extracts duplicate values from an array.

Parameters :
Name Optional Description
array No
  • The input array.
Returns : string[]

An array containing the unique duplicate values.

loadSplitJourneyFromFolder
loadSplitJourneyFromFolder(configDirectory: string)

Loads the split journey configuration from a folder.

Parameters :
Name Type Optional Description
configDirectory string No
  • The path to the configuration directory.
Returns : SplitJourney

The split journey configuration, loaded in memory.

libs/nx/src/generators/journey-src/lib/append-error-to-app-component-html/append-error-to-app-component-html.ts

appendErrorToAppComponentHtml
appendErrorToAppComponentHtml(outputDirectory: string, error: Error)
Parameters :
Name Type Optional
outputDirectory string No
error Error No
linkify
linkify(inputText: string)
Parameters :
Name Type Optional
inputText string No
replaceAtSymbols
replaceAtSymbols(input: string)
Parameters :
Name Type Optional
input string No
Returns : string
stripAnsiEscapeCodes
stripAnsiEscapeCodes(input: string)
Parameters :
Name Type Optional
input string No
Returns : string

libs/sdk/src/node/journey/validate/shared.ts

assertFileContentMatchesSchema
assertFileContentMatchesSchema(filePath: string, schema)

throws an error if the contents of the given file don't match the given schema.

Parameters :
Name Type Optional
filePath string No
schema No

libs/sdk/src/node/journey/validate/multi-tenant-journey.ts

assertValidApplicationJson
assertValidApplicationJson(baseConfigDirectory: string, tenantConfigDirectory: string)
Parameters :
Name Type Optional
baseConfigDirectory string No
tenantConfigDirectory string No
assertValidMultiTenantJourneyConfiguration
assertValidMultiTenantJourneyConfiguration(baseConfigDirectory: string, tenantConfigDirectory: string)

throws an error if the given multi-tenant journey config doesn't match the JSON schemas

Parameters :
Name Type Optional
baseConfigDirectory string No
tenantConfigDirectory string No
assertValidPagesJsons
assertValidPagesJsons(baseConfigDirectory: string, tenantConfigDirectory: string)
Parameters :
Name Type Optional
baseConfigDirectory string No
tenantConfigDirectory string No

libs/sdk/src/node/journey/validate/split-journey.ts

assertValidApplicationJson
assertValidApplicationJson(configDirectory: string)
Parameters :
Name Type Optional
configDirectory string No
assertValidPagesJsons
assertValidPagesJsons(configDirectory: string)
Parameters :
Name Type Optional
configDirectory string No
assertValidSplitJourneyConfiguration
assertValidSplitJourneyConfiguration(configDirectory: string)

throws an error if the given split journey config doesn't match the JSON schemas

Parameters :
Name Type Optional
configDirectory string No

libs/sdk/src/node/journey/validate/classic-journey.ts

assertValidClassicJourneyConfiguration
assertValidClassicJourneyConfiguration(configPath: string)
Parameters :
Name Type Optional
configPath string No

libs/sdk/src/lib/journey/utils/validate-parameters.ts

assertValidName
assertValidName(name: string)
Parameters :
Name Type Optional
name string No
Returns : void

libs/sdk/src/node/journey/generate/utils/validate-parameters.ts

assertValidPaths
assertValidPaths(options)
Parameters :
Name Optional
options No

libs/pfe-connector/src/lib/utils/pfe-resources.ts

assignValueToObjectWithPath
assignValueToObjectWithPath(__namedParameters: {object: StaticResourceList, path: string, value})

wrap the lodash set function (imported as setObject) with a better name to help reading the context.

Parameters :
Name Type Optional
object StaticResourceList No
path string No
value No
collectObjectLeaves
collectObjectLeaves(givenObject, predicateFn, parentKeys)
Parameters :
Name Optional Default value
givenObject No
predicateFn No
parentKeys No []
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 :
Name Type Optional
resourceMap BuildingBlockResourceMap No
pfeQueries No
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 :
Name Type Optional
resourceMap BuildingBlockResourceMap No
Returns : PFEQuery[]
getStaticResources
getStaticResources(resourceMap: BuildingBlockResourceMap)

Extract all static values from a resource list

Parameters :
Name Type Optional
resourceMap BuildingBlockResourceMap No
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 :
Name Type Optional
queries No
pfeQueryGetter ObservableFromQueryFunction No
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 :
Name Type Optional
objectA StaticResourceList No
objectB StaticResourceList No
transformPathChainToPath
transformPathChainToPath(pathPieces)
Parameters :
Name Optional Description
pathPieces No

list of path pieces

Example :
[&#39;object&#39;, &#39;key&#39;] -&gt; &#39;object.key&#39;
[&#39;list&#39;, &#39;0&#39;] -&gt; &#39;list[0]&#39;
Returns : string

the joined path, generates list-like paths for numeric path pieces

libs/nx/src/generators/journey-src/lib/add-showroom-files/utils/extract-showroom-data-from-building-blocks.ts

buildExampleData
buildExampleData(buildingBlocksWithShowroomData)
Parameters :
Name Optional
buildingBlocksWithShowroomData No
buildShowroomImportStatements
buildShowroomImportStatements(buildingBlocksWithShowroomData)
Parameters :
Name Optional
buildingBlocksWithShowroomData No
extractShowroomTemplateData
extractShowroomTemplateData(pagesJson: PagesConfigurationWithTransformedDynamicForms)
Parameters :
Name Type Optional
pagesJson PagesConfigurationWithTransformedDynamicForms No
Returns : ShowroomStrings
getBuildingBlocksWithShowroomData
getBuildingBlocksWithShowroomData(buildingBlocks)
Parameters :
Name Optional
buildingBlocks No
getExportNameForExampleData
getExportNameForExampleData(bbModuleName: string)
Parameters :
Name Type Optional
bbModuleName string No
Returns : string

libs/nx/src/generators/journey-src/lib/shared/bb-path-utils.ts

buildImportStatements
buildImportStatements(exportNamesGroupByPackage: Record)
Parameters :
Name Type Optional
exportNamesGroupByPackage Record No
extractBbFilePath
extractBbFilePath(basePath: string, bbModuleName: string, bbModuleFileExtension: string, bbFileExtension: string)
Parameters :
Name Type Optional
basePath string No
bbModuleName string No
bbModuleFileExtension string No
bbFileExtension string No
Returns : string | undefined
getLocalLibraryPackagePath
getLocalLibraryPackagePath(packageName: string)
Parameters :
Name Type Optional
packageName string No
Returns : string | undefined
getLocalPathToBbFile
getLocalPathToBbFile(basePath: string, bbModuleName: string, bbFileExtension: string)
Parameters :
Name Type Optional
basePath string No
bbModuleName string No
bbFileExtension string No
Returns : literal type
getNodeModulesLibraryPackagePath
getNodeModulesLibraryPackagePath(packageName: string)
Parameters :
Name Type Optional
packageName string No
Returns : string | undefined
getNodeModulesPathToBbFile
getNodeModulesPathToBbFile(basePath: string, bbModuleName: string, bbFileExtension: string)
Parameters :
Name Type Optional
basePath string No
bbModuleName string No
bbFileExtension string No
Returns : literal type

libs/nx/src/generators/building-block/generator.ts

buildingBlock
buildingBlock(tree: Tree, options: BuildingBlockGeneratorSchema)
Parameters :
Name Type Optional
tree Tree No
options BuildingBlockGeneratorSchema No
createBuildingBlock
createBuildingBlock(tree: Tree, options: AddBuildingBlockOptionsWithNameWithPrefix)
Parameters :
Name Type Optional
tree Tree No
options AddBuildingBlockOptionsWithNameWithPrefix No
updateExportIndexFile
updateExportIndexFile(tree: Tree, options: AddBuildingBlockOptionsWithNameWithPrefix)
Parameters :
Name Type Optional
tree Tree No
options AddBuildingBlockOptionsWithNameWithPrefix No

libs/core/src/lib/utils.ts

camelize
camelize(str: string)
Parameters :
Name Type Optional
str string No
dasherize
dasherize(str: string)
Parameters :
Name Type Optional
str string No
Returns : string
decamelize
decamelize(str: string)
Parameters :
Name Type Optional
str string No
Returns : string

libs/acl/form-support/src/lib/data/get-acl-path-object.ts

camelize
camelize(str: string)
Parameters :
Name Type Optional
str string No

libs/acl/form-support/src/lib/support/form-walker.ts

checkIsFormArray
checkIsFormArray(control: AbstractControl)
Parameters :
Name Type Optional
control AbstractControl No
Returns : UntypedFormArray
checkIsFormControl
checkIsFormControl(control: AbstractControl)
Parameters :
Name Type Optional
control AbstractControl No
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 :
Name Type Optional
control AbstractControl No
Returns : UntypedFormGroup
createControlItem
createControlItem(__namedParameters: {control: string[], controlPathSegments: boolean, isFormGroup: boolean, isFormArray: AbstractControl})
Parameters :
Name Type Optional
control string[] No
controlPathSegments boolean No
isFormGroup boolean No
isFormArray AbstractControl No
Returns : ControlItem
walkFormGroup
walkFormGroup(controlOrGroup: AbstractControl, __namedParameters: {includeFormGroups}, parentPath)

walkFormGroup

Parameters :
Name Type Optional Default value
controlOrGroup AbstractControl No
includeFormGroups No false
parentPath No []
Returns : ControlItem[]

libs/sdk/src/lib/journey/config/migrations/shared/utils.ts

cloneDeepWithJsonComments
cloneDeepWithJsonComments(obj: T)

comment-json stores the read comments in non-enumerable properties. These properties are ignored by both structuredClone as well as lodash's cloneDeep. This function uses comment-json's own stringify and parse to deep clone an object with these non-enumerable comment properties.

Parameters :
Name Type Optional
obj T No
Returns : T

libs/nx/src/executors/shared/metadata-utils/collect-building-block-folders.ts

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 :
Name Type Optional
source string No
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 :
Name Type Optional
folderPath string No

libs/nx/src/generators/journey-src/lib/create-pages/single-page/single-page.ts

collectBuildingBlockImports
collectBuildingBlockImports(blocks)
Parameters :
Name Optional
blocks No
hasCompactBuildingBlock
hasCompactBuildingBlock(allSections)
Parameters :
Name Optional
allSections No
hasSingleBuildingBlockWithBackground
hasSingleBuildingBlockWithBackground(page: PageConfiguration, navigationSections)
Parameters :
Name Type Optional
page PageConfiguration No
navigationSections No
singlePage
singlePage(tree: Tree, options: SinglePageOptions)
Parameters :
Name Type Optional
tree Tree No
options SinglePageOptions No

libs/nx/src/generators/journey-src/lib/create-pages/single-page/example-state.ts

collectFromBuildingBlocks
collectFromBuildingBlocks(blocks)

Find and collect all Building Blocks with a given example state and store it inside a map to further access.

Parameters :
Name Optional
blocks No
createIdentifier
createIdentifier(buildingBlockId: string)
Parameters :
Name Type Optional
buildingBlockId string No
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 :
Name Type Optional
items BuildingBlockWithExampleMap No
renderVariableDeclaration
renderVariableDeclaration(item: BuildingBlockWithExample)
Parameters :
Name Type Optional
item BuildingBlockWithExample No

libs/sdk/src/node/journey/generate/lib/install-journey-dependencies/collect-peer-dependencies.ts

collectPeerDependencies
collectPeerDependencies(options: InstallLibPeerDependenciesOptions)
Parameters :
Name Type Optional
options InstallLibPeerDependenciesOptions No
getDependencyFromPackageJson
getDependencyFromPackageJson(packageJson: PartialPackageJson, libraryName: string)
Parameters :
Name Type Optional
packageJson PartialPackageJson No
libraryName string No

libs/nx/src/executors/extract-plugin-metadata/compat/utils/collect-plugin-folders.ts

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 :
Name Type Optional
source string No
collectSecondaryEntrypoints
collectSecondaryEntrypoints(source: string)
Parameters :
Name Type Optional
source string No
getExpectedFileNames
getExpectedFileNames(type: FolderFileType, folderPath: string)
Parameters :
Name Type Optional Default value
type FolderFileType No
folderPath string No ''
getFilePath
getFilePath(type: FolderFileType, folderPath: string)
Parameters :
Name Type Optional Default value
type FolderFileType No
folderPath string No ''
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 :
Name Type Optional
folderPath string No
isSecondaryEntryPoint
isSecondaryEntryPoint(projectFolder: string)
Parameters :
Name Type Optional
projectFolder string No
logPluginFolderWarnings
logPluginFolderWarnings(stats: FolderStats, logger: LoggerApi)
Parameters :
Name Type Optional
stats FolderStats No
logger LoggerApi No
processEntrypoint
processEntrypoint(entryPoint: string, secondary)
Parameters :
Name Type Optional Default value
entryPoint string No
secondary No false

libs/nx/src/generators/journey-src/lib/add-acl-defaults-to-policy/collect-used-building-blocks-and-libraries.ts

collectUsedBuildingBlocksAndLibraries
collectUsedBuildingBlocksAndLibraries(pagesJson: PagesConfigurationWithTransformedDynamicForms)

collects building block metadata and the used libraries from a pages.json configuration.

Parameters :
Name Type Optional Description
pagesJson PagesConfigurationWithTransformedDynamicForms No

pages.json configuration to extract building blocks and libraries from

libs/common/src/lib/utils/compare-data-option.ts

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 :
Name Type Optional Description
listValue T No

is a DataOption object with element from the dropdownL array with value

selectedValue No

is a DataOption object with the value for compare with value

libs/core/src/lib/utils/natural-dates.ts

constructNaturalDateRegexp
constructNaturalDateRegexp()
Returns : RegExp
isNaturalDateString
isNaturalDateString(maybeDateString: string)
Parameters :
Name Type Optional
maybeDateString string No
Returns : boolean
parseNaturalDateString
parseNaturalDateString(maybeDateString: string)
Parameters :
Name Type Optional
maybeDateString string No
Returns : string | null
updateDate
updateDate(date: Dayjs, amount: number, unit: Units)
Parameters :
Name Type Optional
date Dayjs No
amount number No
unit Units No
Returns : Dayjs

libs/acl/form-support/src/lib/core/control-enforcer.ts

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 :
Name Type Optional
controls No
controlEnforcerFactory SyncEnforcer No
Returns : Observable<boolean>

libs/acl/src/lib/acl-engine/policy.ts

convertRulesToPolicyTxt
convertRulesToPolicyTxt(rules)
Parameters :
Name Optional
rules No
isComment
isComment(line: string)
Parameters :
Name Type Optional
line string No
Returns : boolean
isValidAclRuleState
isValidAclRuleState(state: string)
Parameters :
Name Type Optional
state string No
Returns : AclRuleState
parsePolicyTxtContent
parsePolicyTxtContent(fileContent: string)
Parameters :
Name Type Optional
fileContent string No
Returns : AclRule[]
parseRule
parseRule(rule: string, defaultRule: boolean)
Parameters :
Name Type Optional
rule string No
defaultRule boolean No
Returns : AclRule

libs/sdk/src/lib/journey/config/migrations/shared/jsonc-comments.ts

copyComments
copyComments(target: T, source: any, mappingOverrides?: Map)

And here our custom code follows:

Parameters :
Name Type Optional
target T No
source any No
mappingOverrides Map Yes
Returns : T

libs/nx/src/generators/journey-src/lib/copy-folder/copy-folder.ts

copyFolder
copyFolder(tree: Tree, sourceFolder: string, destFolder: string)

Given a sourceFolder, copy its entire content into the given tree at destFolder.

Parameters :
Name Type Optional
tree Tree No
sourceFolder string No
destFolder string No
getAllFilesInTreeAtDirectory
getAllFilesInTreeAtDirectory(tree: Tree, directory: string)
Parameters :
Name Type Optional
tree Tree No
directory string No
Returns : string[]

libs/acl/angular/src/lib/util/copy-clipboard.ts

copyToClipboard
copyToClipboard(value: string)
Parameters :
Name Type Optional
value string No

libs/acl/testing/src/acl-mock.ts

createAclMock
createAclMock()

libs/acl/src/lib/acl-engine/rule.ts

createAclPath
createAclPath(resources)
Parameters :
Name Optional
resources No
isResetByEditable
isResetByEditable(state: AclResourceState)
Parameters :
Name Type Optional
state AclResourceState No
Returns : "readonly" | "disabled"
isResetByVisible
isResetByVisible(state: AclResourceState)
Parameters :
Name Type Optional
state AclResourceState No
isResetState
isResetState(state: AclRuleState)
Parameters :
Name Type Optional
state AclRuleState No
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 :
Name Type Optional
rule AclRule No
aclPath string No
state AclResourceState No
Returns : boolean

libs/nx/src/generators/journey-src/lib/extract-frame-data/create-footer-declaration.ts

createArrayLiteralExpression
createArrayLiteralExpression(links)
Parameters :
Name Optional
links No
createFooterDeclaration
createFooterDeclaration(footer)
Parameters :
Name Optional
footer No

libs/nx/src/generators/journey-src/lib/extract-frame-data/create-navigation-section-declaration.ts

createArrayLiterals
createArrayLiterals(sections)
Parameters :
Name Optional
sections No
createNavigationSectionDeclaration
createNavigationSectionDeclaration(sections)
Parameters :
Name Optional Default value
sections No []

libs/core/src/lib/page/util.ts

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 :
Name Type Optional
queryList QueryList No
Returns : Observable<>
createPageStatusStream
createPageStatusStream(buildingBlockQueryList: QueryList)

Create a stream of WAITING or COMPLETE signals depending on the status of all Building Block currently on the page.

Parameters :
Name Type Optional
buildingBlockQueryList QueryList No

libs/core/src/lib/building-block/create-building-block-provider.ts

createBuildingBlockProvider
createBuildingBlockProvider(component: T)
Parameters :
Name Type Optional
component T No

libs/acl/angular/src/lib/providers/create-component-resolver.ts

createComponentResolver
createComponentResolver(component: T)
Parameters :
Name Type Optional
component T No

libs/acl/form-support/src/lib/support/create-control-list.ts

createControlListFromForm
createControlListFromForm(form: UntypedFormGroup, verbose, excludes)

Create a control list from all form controls in a form group including nested ones.

Parameters :
Name Type Optional Default value
form UntypedFormGroup No
verbose No false
excludes No []
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 bindControlList

Parameters :
Name Type Optional Default value
form UntypedFormGroup No
aclMapping No []
verbose No false
Returns : AclControlItem[]
mergeControlList
mergeControlList(base, overrides)

Only map given explicit map of acl keys and control paths

Parameters :
Name Optional Default value
base No
overrides No []

libs/core/src/lib/form-support/base-validation.ts

createDateStringFormatError
createDateStringFormatError(item: ValidationConfigItem, key)
Parameters :
Name Type Optional
item ValidationConfigItem No
key No
Returns : Error
isIsoDateString
isIsoDateString(dateString: string)
Parameters :
Name Type Optional
dateString string No
Returns : boolean

libs/sdk/src/node/journey/load/classic-journey/read-or-create-pfe-config.ts

createDefaultPFEConfig
createDefaultPFEConfig(pagesConfig: PagesJsonSchema)
Parameters :
Name Type Optional
pagesConfig PagesJsonSchema No
Returns : PfeJsonSchema
createPagesNavConfiguration
createPagesNavConfiguration(pages)
Parameters :
Name Optional
pages No
pageWalker
pageWalker(pages)

support utility to enrich a given page array with previous and next pages pointers

Parameters :
Name Optional
pages No
singleNavigationPageConfig
singleNavigationPageConfig(pageData: PageConfiguration, nextPage)

create a single pfe navigation config node, with minimal content to point to next page

Parameters :
Name Type Optional Default value
pageData PageConfiguration No
nextPage No null

libs/acl/angular/src/lib/acl-evaluation-wrapper.ts

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 prefixResolver callback.

Parameters :
Name Type Optional
targetService AclEvaluationInterface No
prefixResolver No
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 :
Name Type Optional
targetService AclEvaluationInterface No
prefix string No
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 :
Name Type Optional
targetService AclEvaluationInterface No
tag AclTag No

libs/nx/src/executors/shared/file-watcher/file-watcher.ts

createFileWatcher
createFileWatcher(directories, changeHandler)
Parameters :
Name Optional
directories No
changeHandler No

libs/nx/src/executors/introspection/compat/__test/example-library/src/other/get-form-correct-implicit-return-type.ts

createForm
createForm()
getPolicyForm
getPolicyForm()

libs/nx/src/executors/shared/metadata-utils/__test/example-library/src/other/get-form-correct-implicit-return-type.ts

createForm
createForm()
getPolicyForm
getPolicyForm()

libs/nx/src/executors/introspection/compat/utils/create-introspection-context.ts

createIntrospectionContext
createIntrospectionContext(__namedParameters: {root: IntrospectionContextRequirements, files, context, logger})
Parameters :
Name Type Optional
root IntrospectionContextRequirements No
files No
context No
logger No
Returns : IntrospectionContext | null

libs/nx/src/executors/journal/compat/utils/create-journal-record.ts

createJournalRecord
createJournalRecord(dir: string, packageName: string, logger: Logger)
Parameters :
Name Type Optional
dir string No
packageName string No
logger Logger No

libs/sdk/src/node/journey/generate/lib/create-journey/create-journey.ts

createJourney
createJourney(options: CreateJourneyOptions)
Parameters :
Name Type Optional
options CreateJourneyOptions No

libs/pfe-connector/src/lib/frame/page-action-status.ts

createLastPageObservable
createLastPageObservable(pfeBusinessService: PfeBusinessService, pfeNavigationService: PfeNavigationService, pfeConfigurationService: PfeConfigurationService)
Parameters :
Name Type Optional
pfeBusinessService PfeBusinessService No
pfeNavigationService PfeNavigationService No
pfeConfigurationService PfeConfigurationService No
Returns : Observable<boolean>
createNavOrServiceActivatorInProgressObservable
createNavOrServiceActivatorInProgressObservable(pfeServiceActivatorService: PfeServiceActivatorService, pfeNavigationService: PfeNavigationService)
Parameters :
Name Type Optional
pfeServiceActivatorService PfeServiceActivatorService No
pfeNavigationService PfeNavigationService No
Returns : Observable<boolean>
createPageActionStatusObservable
createPageActionStatusObservable(pfeServiceActivatorService: PfeServiceActivatorService, pfeNavigationService: PfeNavigationService, pfeConfigurationService: PfeConfigurationService, pfeBusinessService: PfeBusinessService, backLinkUtilsService: BackLinkUtilsService, talyPageDataService: TalyPageDataService, nextButtonDisabledWhenPageInvalid: boolean)
Parameters :
Name Type Optional
pfeServiceActivatorService PfeServiceActivatorService No
pfeNavigationService PfeNavigationService No
pfeConfigurationService PfeConfigurationService No
pfeBusinessService PfeBusinessService No
backLinkUtilsService BackLinkUtilsService No
talyPageDataService TalyPageDataService No
nextButtonDisabledWhenPageInvalid boolean No

libs/nx/src/generators/journey-src/lib/shared/ts-utils.ts

createLocalizeTemplateExpression
createLocalizeTemplateExpression(i18nText: string)
Parameters :
Name Type Optional
i18nText string No
Returns : ts.TaggedTemplateExpression
createSafePropertyIdentifier
createSafePropertyIdentifier(maybeUnsafeIdentifierString: string)
Parameters :
Name Type Optional
maybeUnsafeIdentifierString string No
Returns : ts.Identifier
createStringLiteral
createStringLiteral(value: string, i18nPath)
Parameters :
Name Type Optional
value string No
i18nPath No
Returns : ts.StringLiteral | ts.TaggedTemplateExpression
createTsExpression
createTsExpression(value, i18nPath)
Parameters :
Name Optional
value No
i18nPath No
Returns : ts.Expression
md5
md5(str: string)
Parameters :
Name Type Optional
str string No
Returns : string
tsNodeText
tsNodeText(n)
Parameters :
Name Optional
n No
Returns : string
turnArrayIntoArrayLiteral
turnArrayIntoArrayLiteral(arr, i18nPath)
Parameters :
Name Optional
arr No
i18nPath No
Returns : ts.ArrayLiteralExpression
turnObjectIntoObjectLiteral
turnObjectIntoObjectLiteral(obj: T, i18nPath)
Parameters :
Name Type Optional
obj T No
i18nPath No

libs/nx/src/generators/journey-src/lib/create-pages/single-page/create-page-data-assignment.ts

createNavigation
createNavigation(options?: Navigation)

Target Output:

navigation: {
  hidden: false
}
Parameters :
Name Type Optional
options Navigation Yes
createPageActionConfig
createPageActionConfig(options, createLocalizeAssignmentFn: curriedCreateLocalizeAssignmentFunction, pageId: string)
Parameters :
Name Type Optional
options No
createLocalizeAssignmentFn curriedCreateLocalizeAssignmentFunction No
pageId string No
createPageDataAssignment
createPageDataAssignment(page: PageConfigurationWithTransformedDynamicForms)

Convert an incoming page configuration to a valid TS variable assignment in the following form.

Given this page configuration

"pageConfiguration": {
       "id": "my-page",
       "title": {
         "headline": "Great first page",
         "topline": "and it works",
         "endImage": "assets/something-end.svg",
         "startImage": "assets/something-start.svg",
         "narrowImage": "assets/something-narrow.svg",
         "showAsStage": true
       }
       "pageData": {
         "navigation": {
           "hidden": false
         },
         "pageActionConfig": {
           "backButtonLabel": "Go Back 💨",
           "nextButtonLabel": "Go Forward ⏭"
         }
       }
 }

transform it into the following TS structure to output it into a TS component.

pageData: PageDataForTemplate = {
      pageActionConfig: {
          nextButtonLabel: $localize `:@@my-page.page-action.next-button-label:Go Back 💨`,
          backButtonLabel: $localize `:@@my-page.page-action.back-button-label:Go Forward ⏭`
      },
      stage: {
       headline: $localize `:@@my-page.stage.headline:Great first page`,
       topline: $localize `:@@my-page.stage.topline:and it works`,
       narrowImage: "assets/something-narrow.svg",
       startImage: "assets/something-start.svg",
       endImage: "assets/something-end.svg",
       showAsStage: true
      },
      navigation: {
          hidden: false
      }
  };
Parameters :
Name Type Optional
page PageConfigurationWithTransformedDynamicForms No
createStage
createStage(options, createLocalizeAssignmentFn: curriedCreateLocalizeAssignmentFunction)

Target Output:

stage: {
    headline: $localize `:@@my-page.stage.headline:Great first page`,
    topline: $localize `:@@my-page.stage.topline:and it works`,
    narrowImage: "assets/something-narrow.svg",
    startImage: "assets/something-start.svg",
    endImage: "assets/something-end.svg"
},
Parameters :
Name Type Optional
options No
createLocalizeAssignmentFn curriedCreateLocalizeAssignmentFunction No

libs/nx/src/generators/journey-src/lib/create-pages/single-page/merge-blocks-and-panels-into-sections.ts

createNewRuntimeSection
createNewRuntimeSection(sectionItem, index: number)
Parameters :
Name Type Optional
sectionItem No
index number No
createRuntimePanelFromConfiguration
createRuntimePanelFromConfiguration(panelConfig: PanelDefinition, blockConfig: BuildingBlockConfiguration, pageId: string, isExpertApp: boolean)
Parameters :
Name Type Optional
panelConfig PanelDefinition No
blockConfig BuildingBlockConfiguration No
pageId string No
isExpertApp boolean No
createRuntimeSectionFromConfiguration
createRuntimeSectionFromConfiguration(section: PageSectionDefinition, sectionItem)
Parameters :
Name Type Optional
section PageSectionDefinition No
sectionItem No
findLastSectionWithStandalonePanel
findLastSectionWithStandalonePanel(sections)
Parameters :
Name Optional
sections No
findPanelInSections
findPanelInSections(sections, panelId: string)
Parameters :
Name Type Optional
sections No
panelId string No
isPanel
isPanel(item: PanelOrSectionOrBlock)
Parameters :
Name Type Optional
item PanelOrSectionOrBlock No
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 panel, block, panel, block instead of panel, panel, panel, block, block

Parameters :
Name Type Optional Default value
page PageConfigurationWithTransformedDynamicForms No
isExpertApp No false

libs/nx/src/generators/journey-src/lib/create-pages/single-page/create-page-data-overrides.ts

createPageDataOverridesString
createPageDataOverridesString(pageId: string, allBlocks)
Parameters :
Name Type Optional
pageId string No
allBlocks No
Returns : string
createPropertyAssignmentBlockResources
createPropertyAssignmentBlockResources(resources: Record, pageId: string, blockId: string)
Parameters :
Name Type Optional
resources Record No
pageId string No
blockId string No
Returns : ts.PropertyAssignment
createPropertyAssignmentBlockValidators
createPropertyAssignmentBlockValidators(validators, pageId: string, blockId: string)
Parameters :
Name Type Optional
validators No
pageId string No
blockId string No
Returns : ts.PropertyAssignment
createPropertyAssignmentDynamicFormConfiguration
createPropertyAssignmentDynamicFormConfiguration(resources, pageId: string, blockId: string)
Parameters :
Name Type Optional
resources No
pageId string No
blockId string No
Returns : ts.PropertyAssignment
createPropertyAssignmentsForBlocks
createPropertyAssignmentsForBlocks(pageId: string, allBlocks)
Parameters :
Name Type Optional
pageId string No
allBlocks No
Returns : ts.PropertyAssignment[]

libs/nx/src/generators/journey-src/lib/create-pages/create-pages.ts

createPages
createPages(tree: Tree, options: CreatePagesOptions)
Parameters :
Name Type Optional
tree Tree No
options CreatePagesOptions No

libs/pfe-connector/src/lib/frame/pfe-frame-navigation.service.ts

createPfeHistoryObservable
createPfeHistoryObservable(pfeStateService: PfeStateService)
Parameters :
Name Type Optional
pfeStateService PfeStateService No
Returns : Observable<PageHistory>
filterSections
filterSections(allSections: SectionConfig, conditions: Map)
Parameters :
Name Type Optional
allSections SectionConfig No
conditions Map No
Returns : SectionConfig

libs/common/frame/src/services/frame-layout.service.ts

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 :
Name Type Optional
breakpoint$ Observable No
channel CHANNEL No

libs/acl/angular/src/lib/providers/create-static-acl-tag.ts

createStaticAclTagProvider
createStaticAclTagProvider(resourceName: string)

Usage inside a component to alway prefix it with an acl tag providers: [ createStaticAclTag('my-prefix') ]

Parameters :
Name Type Optional
resourceName string No

libs/nx/src/generators/journey-src/lib/add-acl-defaults-to-policy/create-updated-policy.ts

createUpdatedPolicy
createUpdatedPolicy(policy: string, aclDefaults: Map)

Adds the given ACL defaults to an existing policy. Replaces any existing ACL defaults.

Parameters :
Name Type Optional Description
policy string No

string representation of the current policy

aclDefaults Map No

map of acl defaults to add to the policy

Returns : string
removeOldDefaults
removeOldDefaults(policy: string)
Parameters :
Name Type Optional
policy string No
Returns : string

libs/sdk/src/node/workspace/generate/lib/create-workspace.ts

createWorkspace
createWorkspace(destinationDirectory: string, normalizedOptions: GenerateWorkspaceOptions)
Parameters :
Name Type Optional
destinationDirectory string No
normalizedOptions GenerateWorkspaceOptions No
Returns : AsyncGenerator<ProgressReport, void>

libs/sdk/src/node/journey/generate/lib/create-workspace/create-workspace.ts

createWorkspace
createWorkspace(directory: string, legacyDependencyResolution?: boolean)
Parameters :
Name Type Optional
directory string No
legacyDependencyResolution boolean Yes

libs/sdk/src/node/workspace/generate/lib/create-workspace-empty.ts

createWorkspaceEmpty
createWorkspaceEmpty(destinationDirectory: string, normalizedOptions: GenerateWorkspaceOptions)
Parameters :
Name Type Optional
destinationDirectory string No
normalizedOptions GenerateWorkspaceOptions No
Returns : AsyncGenerator<ProgressReport, void>

libs/sdk/src/node/workspace/generate/lib/create-workspace-with-journey.ts

createWorkspaceWithJourney
createWorkspaceWithJourney(destinationDirectory: string, normalizedOptions: GenerateWorkspaceOptions)
Parameters :
Name Type Optional
destinationDirectory string No
normalizedOptions GenerateWorkspaceOptions No
Returns : AsyncGenerator<ProgressReport, void>

libs/sdk/src/node/workspace/generate/lib/create-workspace-with-library.ts

createWorkspaceWithLibrary
createWorkspaceWithLibrary(destinationDirectory: string, normalizedOptions: GenerateWorkspaceOptions)
Parameters :
Name Type Optional
destinationDirectory string No
normalizedOptions GenerateWorkspaceOptions No
Returns : AsyncGenerator<ProgressReport, void>

libs/acl/src/lib/acl-engine/strings.ts

dasherize
dasherize(str?: string)
Parameters :
Name Type Optional
str string Yes
Returns : string
decamelize
decamelize(str: string)
Parameters :
Name Type Optional
str string No
Returns : string

libs/sdk/src/lib/journey/utils/string-utils.ts

dasherize
dasherize(str?: string)
Parameters :
Name Type Optional
str string Yes
Returns : string
decamelize
decamelize(str: string)
Parameters :
Name Type Optional
str string No
Returns : string

libs/sdk/src/lib/journey/transform/dasherize-bb-ids.ts

dasherizeBBIds
dasherizeBBIds(journey: Journey)
Parameters :
Name Type Optional
journey Journey No
Returns : Journey

libs/nx/src/generators/journey-src/lib/transform-to-module/transform-to-module.ts

deleteFiles
deleteFiles(tree: Tree, deleteFromDirectory: string)
Parameters :
Name Type Optional
tree Tree No
deleteFromDirectory string No
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 :
Name Type Optional
tree Tree No
destinationDirectory string No

libs/sdk/src/lib/journey/config/migrations/shared/base-application-property-path/base-application-property-path.ts

deletePropertyByPath
deletePropertyByPath(object: any, pathArray)
Parameters :
Name Type Optional
object any No
pathArray No
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 :
Name Type Optional Description
propertyPath No
  • The path of the property to search for.
applicationJson any No
  • The JSON object in which to search for the property path.
Returns : [] | undefined
  • The path (with refDefault) to the property if found, otherwise undefined.
getPropertyByPath
getPropertyByPath(object: any, pathArray)
Parameters :
Name Type Optional
object any No
pathArray No
Returns : any
setPropertyByPath
setPropertyByPath(object: any, pathArray, value: any)
Parameters :
Name Type Optional
object any No
pathArray No
value any No
Returns : void

libs/nx/src/migrations/make-sticky-building-block-the-banner-block/make-sticky-building-block-the-banner-block.ts

didJsonObjectChange
didJsonObjectChange(a: PagesJsonSchema, b: PagesJsonSchema)
Parameters :
Name Type Optional
a PagesJsonSchema No
b PagesJsonSchema No
makeStickyBuildingBlockTheBannerBlock
makeStickyBuildingBlockTheBannerBlock(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/migrations/move-stage-config-from-page-data-to-title/move-stage-config-from-page-data-to-title.ts

didJsonObjectChange
didJsonObjectChange(a: PagesJsonSchema, b: PagesJsonSchema)
Parameters :
Name Type Optional
a PagesJsonSchema No
b PagesJsonSchema No
moveStageConfigFromPageDataToTitle
moveStageConfigFromPageDataToTitle(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/migrations/remove-package-version-from-plugins-config/remove-package-version-from-plugins-config.ts

didJsonObjectChange
didJsonObjectChange(a: PagesJsonSchema, b: PagesJsonSchema)
Parameters :
Name Type Optional
a PagesJsonSchema No
b PagesJsonSchema No
removePackageVersionFromPluginConfig
removePackageVersionFromPluginConfig(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/migrations/remove-pages-configuration-from-pfe-json/remove-pages-configuration-from-pfe-json.ts

didJsonObjectChange
didJsonObjectChange(a, b)
Parameters :
Name Optional
a No
b No
removePagesConfigurationFromPfeJson
removePagesConfigurationFromPfeJson(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/generators/journey-src/generator.ts

ensureValidCustomElementName
ensureValidCustomElementName(projectName: string)
Parameters :
Name Type Optional
projectName string No
Returns : string
isValidCustomElementName
isValidCustomElementName(name: string)
Parameters :
Name Type Optional
name string No
Returns : boolean
journeySrc
journeySrc(tree: Tree, options: JourneySrcGeneratorSchema)
Parameters :
Name Type Optional
tree Tree No
options JourneySrcGeneratorSchema No

libs/nx/src/executors/shared/metadata-utils/__test/my-team-plugin-lib/src/other/injectable-files/no-class-declaration.ts

example
example()

libs/nx/src/executors/introspection/compat/utils/extract-form-properties.ts

extractAngularFormProperties
extractAngularFormProperties(propertyType: NodeWithTypeArguments, pathFromRoot, logger: Logger, typeName?: string)
Parameters :
Name Type Optional
propertyType NodeWithTypeArguments No
pathFromRoot No
logger Logger No
typeName string Yes
Returns : FormProperty[]
extractFormControlProperty
extractFormControlProperty(propertyType: NodeWithTypeArguments, pathFromRoot, logger: Logger)
Parameters :
Name Type Optional
propertyType NodeWithTypeArguments No
pathFromRoot No
logger Logger No
Returns : FormProperty[]
extractFormControlType
extractFormControlType(propertyType: NodeWithTypeArguments, pathFromRoot, logger: Logger)
Parameters :
Name Type Optional
propertyType NodeWithTypeArguments No
pathFromRoot No
logger Logger No
Returns : string
extractFormGroupProperties
extractFormGroupProperties(typeArguments: TypeNode, pathFromRoot, logger: Logger)
Parameters :
Name Type Optional
typeArguments TypeNode No
pathFromRoot No
logger Logger No
Returns : FormProperty[]
extractFormProperties
extractFormProperties(introspectionContext: IntrospectionContext, sourceFile, node)
Parameters :
Name Type Optional
introspectionContext IntrospectionContext No
sourceFile No
node No
extractPropertyTree
extractPropertyTree(checker, root, node, buildingBlockFilePath: string, logger: Logger)
Parameters :
Name Type Optional
checker No
root No
node No
buildingBlockFilePath string No
logger Logger No
extractTypeName
extractTypeName(propertyType)
Parameters :
Name Optional
propertyType No
Returns : string
getPropertyTypeInformation
getPropertyTypeInformation(checker, property, node, logger: Logger)
Parameters :
Name Type Optional
checker No
property No
node No
logger Logger No
getReturnTypeArgument
getReturnTypeArgument(checker, declaration)
Parameters :
Name Optional
checker No
declaration No
isAngularForms
isAngularForms(typeName: string)
Parameters :
Name Type Optional
typeName string No
isCustomDefinedType
isCustomDefinedType(type)
Parameters :
Name Optional
type No
isGetFormMethod
isGetFormMethod(node)
Parameters :
Name Optional
node No
mapToStackItems
mapToStackItems(visitedCustomTypeNames: Set, type, ancestors)
Parameters :
Name Type Optional
visitedCustomTypeNames Set No
type No
ancestors No

libs/oauth/src/lib/oauth.service.ts

extractAngularPathFromParentAppIfAny
extractAngularPathFromParentAppIfAny(angularPath: string, possibleJourneyPaths)
Parameters :
Name Type Optional
angularPath string No
possibleJourneyPaths No

libs/nx/src/generators/journey-src/lib/extract-debug-flags/extract-debug-flags.ts

extractDebugFlags
extractDebugFlags(inputFlags: InputDebugFlagsWithDeprecated)
Parameters :
Name Type Optional
inputFlags InputDebugFlagsWithDeprecated No
Returns : DebugFlags

libs/nx/src/generators/journey-src/lib/extract-frame-data/extract-frame-data.ts

extractFrameData
extractFrameData(tree: Tree, options: ExtractFrameDataOptions)
Parameters :
Name Type Optional
tree Tree No
options ExtractFrameDataOptions No

libs/nx/src/generators/journey-src/lib/extract-journey-model/extract-journey-model.ts

extractImportSpecifiersFromType
extractImportSpecifiersFromType(type, bbComponentAst)
Parameters :
Name Optional
type No
bbComponentAst No
Returns : string[]
extractJourneyModel
extractJourneyModel(tree: Tree, destinationDirectory: string, pagesJson: PagesConfigurationWithTransformedDynamicForms, projectName: string)
Parameters :
Name Type Optional
tree Tree No
destinationDirectory string No
pagesJson PagesConfigurationWithTransformedDynamicForms No
projectName string No
getBbStateType
getBbStateType(bb: BuildingBlockConfiguration, tree: Tree)
Parameters :
Name Type Optional
bb BuildingBlockConfiguration No
tree Tree No
hasDeclarationNode
hasDeclarationNode(declarations, identifier: string, ast)
Parameters :
Name Type Optional
declarations No
identifier string No
ast No
processInlineObjectType
processInlineObjectType(type, bbComponentAst)

Extract import specifiers from inline object types e.g. { name: string; address: AddressBb; } => ['AddressBb']

Parameters :
Name Optional
type No
bbComponentAst No
processMappedType
processMappedType(type, bbComponentAst)

Extract import specifiers from MappedType e.g. { [key in SomeEnum]: unknown } => ['SomeEnum']

Parameters :
Name Optional
type No
bbComponentAst No
processTypeWithArguments
processTypeWithArguments(type, bbComponentAst)

Extract import specifiers from types with arguments e.g. Record<string, BbState> => ['BbState']

Parameters :
Name Optional
type No
bbComponentAst No
shouldImportType
shouldImportType(type, bbComponentAst)
Parameters :
Name Optional
type No
bbComponentAst No

libs/nx/src/generators/journey-src/lib/update-project-internationalization/extract-internationalization-configs.ts

extractInternationalizationBuildConfigurations
extractInternationalizationBuildConfigurations(locales, localesDestinationFolder: string)
Parameters :
Name Type Optional
locales No
localesDestinationFolder string No
extractInternationalizationGenerateAndServeConfigurations
extractInternationalizationGenerateAndServeConfigurations(locales, projectName: string)
Parameters :
Name Type Optional
locales No
projectName string No
extractInternationalizationRootConfiguration
extractInternationalizationRootConfiguration(sourceLocale, localeFilePaths, stripLocaleBaseHref)
Parameters :
Name Optional Default value
sourceLocale No
localeFilePaths No
stripLocaleBaseHref No false
extractInternationalizationServeConfigurations
extractInternationalizationServeConfigurations(locales, projectName: string)
Parameters :
Name Type Optional
locales No
projectName string No
extractLocaleFromFilePath
extractLocaleFromFilePath(filePath: string)
Parameters :
Name Type Optional
filePath string No
Returns : string | undefined
extractLocalesFromFileNames
extractLocalesFromFileNames(localeFilePaths)
Parameters :
Name Optional
localeFilePaths No
Returns : string[]

libs/nx/src/generators/utils/extract-library-data.ts

extractLibraryData
extractLibraryData(tree: Tree, projectPath: string)
Parameters :
Name Type Optional
tree Tree No
projectPath string No
Returns : LibraryJsonSchema

libs/nx/src/executors/shared/metadata-utils/extract-package-json-data.ts

extractPackageJsonData
extractPackageJsonData(projectFolder: string)
Parameters :
Name Type Optional
projectFolder string No
Returns : packageJsonData
readPackageJsonFile
readPackageJsonFile(projectFolder: string)
Parameters :
Name Type Optional
projectFolder string No

libs/nx/src/executors/extract-plugin-metadata/compat/utils/inspect-injectable-class.ts

extractPluginType
extractPluginType(checker, classNode)
Parameters :
Name Optional
checker No
classNode No
extractPluginValidatorData
extractPluginValidatorData(fileName: string, classNode, logger: Logger)
Parameters :
Name Type Optional
fileName string No
classNode No
logger Logger No

libs/nx/src/generators/journey-src/lib/create-pages/single-page/notifications/notifications.ts

extractStateKeyPlaceholders
extractStateKeyPlaceholders(notifications)
Parameters :
Name Optional
notifications No
Returns : string[]
getNotificationsConfigForTemplate
getNotificationsConfigForTemplate(notifications)
Parameters :
Name Optional
notifications No
Returns : literal type
getTransformedMessageAndTitle
getTransformedMessageAndTitle(notifications, stateKeys)
Parameters :
Name Optional
notifications No
stateKeys No
sortNonErrorNotificationsByContext
sortNonErrorNotificationsByContext(notifications)
Parameters :
Name Optional
notifications No

libs/common/web-components/src/utils/utils.ts

extractWebComponentRoutesFromHash
extractWebComponentRoutesFromHash(hash: string)
Parameters :
Name Type Optional Description
hash string No

the hash to extract the web component routing map from

Returns : WebComponentRoutes

a map of web component ids and their associated paths

upsertWebComponentRoutesInHash
upsertWebComponentRoutesInHash(webCompId: string, path: string, hash: string)
Parameters :
Name Type Optional Description
webCompId string No

ID of the web component

path string No

the internal path of a web component

hash string No

hash in which to update/insert this new path for the given web component id

Returns : string

the given hash including the new/changed web component path

urlEncodeWebComponentRoutes
urlEncodeWebComponentRoutes(routes: WebComponentRoutes)
Parameters :
Name Type Optional Description
routes WebComponentRoutes No

key:value map of web component routes

Returns : string

string with web component routes encoded for usage in a URL

libs/sdk/src/node/journey/generate/utils/taly-version-compatibility.ts

findLatestCompatibleTalyVersion
findLatestCompatibleTalyVersion(configDirectory: string, currentlyInstalledTalyVersion: string)
Parameters :
Name Type Optional
configDirectory string No
currentlyInstalledTalyVersion string No
Returns : Promise<string>

libs/sdk/src/cli/migrations/migrate.ts

format
format(filePath: string, content: string)
Parameters :
Name Type Optional
filePath string No
content string No
migrate
migrate(configDirectory: string)
Parameters :
Name Type Optional
configDirectory string No
migrateClassicJourney
migrateClassicJourney(configDirectory: string)

migrates a classic journey configuration

Parameters :
Name Type Optional
configDirectory string No
migrateSplitJourney
migrateSplitJourney(configDirectory: string)

migrates a split journey configuration

Parameters :
Name Type Optional
configDirectory string No
updateJsonFileIfChanged
updateJsonFileIfChanged(filePath: string, updatedContent: T)
Parameters :
Name Type Optional
filePath string No
updatedContent T No

libs/nx/src/generators/plugin/generator.ts

generate
generate(tree: Tree, options: PluginGeneratorSchema)
Parameters :
Name Type Optional
tree Tree No
options PluginGeneratorSchema No

libs/nx/src/executors/shared/generate-app/generate-app.ts

generateApp
generateApp(projectName: string, options: GenerateAppSchema)
Parameters :
Name Type Optional
projectName string No
options GenerateAppSchema No
Returns : void

libs/nx/src/executors/journal/compat/utils/generate-journal.ts

generateJournal
generateJournal(__namedParameters: {libraryFolder: string, packageName: string, logger: Logger})

Create the Journal by following the following steps

  1. Find all Building Blocks by searching for the Markdown Files
  2. Extract the header data from each md file
  3. Extract the selector from the component file
Parameters :
Name Type Optional
libraryFolder string No
packageName string No
logger Logger No
logWarning
logWarning(__namedParameters: {stats: BuildingBlockFolderStats, logger: Logger})
Parameters :
Name Type Optional
stats BuildingBlockFolderStats No
logger Logger No

libs/sdk/src/cli/generate-journey/generate-journey.ts

generateJourney
generateJourney(options: GenerateJourneyOptions)
Parameters :
Name Type Optional
options GenerateJourneyOptions No

libs/sdk/src/node/journey/generate/generate.ts

generateJourney
generateJourney(options: GenerateJourneyOptions)

This function generates a journey in a new Nx workspace.

It returns an AsyncIterator that yields the generation progress.

Usage:

for await (const progress of generateJourney(options)) {
 console.log(progress.text);
}
Parameters :
Name Type Optional
options GenerateJourneyOptions No
Returns : AsyncGenerator<ProgressReport, void>

libs/sdk/src/node/journey/generate/lib/generate-journey-src/generate-journey-src.ts

generateJourneySrc
generateJourneySrc(destinationDirectory: string, generationOptions: JourneySrcGenerationOptions)
Parameters :
Name Type Optional
destinationDirectory string No
generationOptions JourneySrcGenerationOptions No
updateProjectConfig
updateProjectConfig(destinationDirectory: string, options: JourneySrcGenerationOptions)
Parameters :
Name Type Optional
destinationDirectory string No
options JourneySrcGenerationOptions No

libs/nx/src/generators/journey-src/lib/pfe-setup/page-mapping-options.ts

generatePageConfig
generatePageConfig(pages)
Parameters :
Name Optional
pages No
Returns : string
generatePageImport
generatePageImport(pageName: string)
Parameters :
Name Type Optional
pageName string No
Returns : string
generatePageImports
generatePageImports(pages)
Parameters :
Name Optional
pages No
Returns : string
getPageConfigName
getPageConfigName(name: string)
Parameters :
Name Type Optional
name string No
Returns : string
getPageMappingFileOptions
getPageMappingFileOptions(pages)
Parameters :
Name Optional
pages No
getPageRouteClassName
getPageRouteClassName(name: string)
Parameters :
Name Type Optional
name string No
Returns : string
getPageRouteName
getPageRouteName(name: string)
Parameters :
Name Type Optional
name string No
Returns : string
mappingServiceEntry
mappingServiceEntry(name: string)
Parameters :
Name Type Optional
name string No
Returns : string

libs/sdk/src/cli/generate-workspace/generate-workspace.ts

generateWorkspace
generateWorkspace(options: GenerateWorkspaceOptions)
Parameters :
Name Type Optional
options GenerateWorkspaceOptions No

libs/sdk/src/node/workspace/generate/generate.ts

generateWorkspace
generateWorkspace(options: GenerateWorkspaceOptions)

This function generates a new TALY Nx workspace.

It returns an AsyncIterator that yields the generation progress.

Parameters :
Name Type Optional
options GenerateWorkspaceOptions No
Returns : AsyncGenerator<ProgressReport, void>

libs/nx/src/generators/journey-src/lib/add-acl-defaults-to-policy/get-acl-defaults.ts

getAclDefaults
getAclDefaults(buildingBlocks, libraries)

extracts acl defaults for the given building blocks from the libraries' journals

Parameters :
Name Optional Description
buildingBlocks No

array of building block meta data

libraries No

array of library meta data

getAclDefaultsForLibrary
getAclDefaultsForLibrary(libraryName: string, libraryJournal: JournalFileSchema, buildingBlocks)
Parameters :
Name Type Optional
libraryName string No
libraryJournal JournalFileSchema No
buildingBlocks No

libs/core/runtime-utils/src/get-data-for-page.ts

getAllBlocks
getAllBlocks(page: PageConfigurationWithTransformedDynamicForms)
Parameters :
Name Type Optional
page PageConfigurationWithTransformedDynamicForms No

libs/sdk/src/lib/analytics/building-blocks.ts

getAllBuildingBlocksInPage
getAllBuildingBlocksInPage(page: PageConfigurationWithTransformedDynamicForms)
Parameters :
Name Type Optional Description
page PageConfigurationWithTransformedDynamicForms No

Page configuration

Returns : []

An array of all building block configurations in a page

getBuildingBlockConfigurations
getBuildingBlockConfigurations(journey: Journey)
Parameters :
Name Type Optional Description
journey Journey No

Journey configuration

Returns : []

An array of all building block configurations across all pages

getBuildingBlockLibraries
getBuildingBlockLibraries(journey: Journey)
Parameters :
Name Type Optional Description
journey Journey No

Journey configuration

Returns : string[]

An Array with the Building Block libraries used within the journey.

getBuildingBlocksWithJourneyMetadata
getBuildingBlocksWithJourneyMetadata(journey: Journey)
Parameters :
Name Type Optional Description
journey Journey No

Journey configuration

Returns : BuildingBlockWithJourneyMetadata[]

An Array with {@link BuildingBlockWithJourneyMetadata} objects. Each object contains the building block configuration in the block property, and meta data on the building block inside the journey context (i.e. which pages the block is used on, and if it is global or local).

getBuildingBlockUsageCounts
getBuildingBlockUsageCounts(journey: Journey)
Parameters :
Name Type Optional Description
journey Journey No

Journey configuration

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 :
Name Type Optional Description
journey Journey No

Journey configuration

Returns : string[]

An Array with the libraries listed within the journey configuration.

getUniqueBuildingBlocks
getUniqueBuildingBlocks(journey: Journey)
Parameters :
Name Type Optional Description
journey Journey No

Journey configuration

Returns : string[]

An array of the unique Building Block selectors that are used in the given journey configuration

isPageWithBlocks
isPageWithBlocks(page: PageConfiguration)
Parameters :
Name Type Optional
page PageConfiguration No
Returns : PageWithBlocks

libs/nx/src/executors/introspection/compat/run-introspection.ts

getBuildingBlockId
getBuildingBlockId(symbol)
Parameters :
Name Optional
symbol No

libs/nx/src/generators/journey-src/lib/get-journey-insights/get-journey-insights.ts

getBuildingBlockTitle
getBuildingBlockTitle(packageName: string, selector: string, usedLibraries)
Parameters :
Name Type Optional
packageName string No
selector string No
usedLibraries No
getJourneyInsights
getJourneyInsights(pagesJson: PagesConfigurationWithTransformedDynamicForms, usedLibraries)
Parameters :
Name Type Optional
pagesJson PagesConfigurationWithTransformedDynamicForms No
usedLibraries No
getPageDetails
getPageDetails(pagesJson: PagesConfigurationWithTransformedDynamicForms, usedLibraries)
Parameters :
Name Type Optional
pagesJson PagesConfigurationWithTransformedDynamicForms No
usedLibraries No

libs/nx/src/executors/shared/introspection/types.ts

getCoercedTypeNode
getCoercedTypeNode(typeArgumentData)

Given a TypeArgument node. We won't accept anything that is not a type reference (e.g. literals: Class<number, string>). If a value is not a type reference we want to coerce it into null to prevent the analysis of code we are not expecting here.

Parameters :
Name Optional
typeArgumentData No

libs/sdk/src/node/journey/generate/lib/install-journey-dependencies/install-journey-dependencies.ts

getDependencyStrings
getDependencyStrings(dependencies)

This function will return an array of strings that can be used to install the given dependencies.

Parameters :
Name Optional Description
dependencies No

the dependencies to install

installJourneyDependencies
installJourneyDependencies(destinationDirectory: string, journey: Journey, includeWebcomponentDependencies: boolean, legacyDependencyResolution?: boolean)
Parameters :
Name Type Optional
destinationDirectory string No
journey Journey No
includeWebcomponentDependencies boolean No
legacyDependencyResolution boolean Yes

libs/sdk/src/node/journey/load/multi-tenant-journey/multi-tenant-journey-utils.ts

getDisallowedTenantProperties
getDisallowedTenantProperties(baseConfig: JsonValue, tenantConfig, currentConfigPath)
Parameters :
Name Type Optional Default value
baseConfig JsonValue No
tenantConfig No
currentConfigPath No []
hasRefDefault
hasRefDefault(config)
Parameters :
Name Optional
config No
Returns : boolean
replaceRefDefault
replaceRefDefault(baseConfig: JsonValue, tenantConfig: JsonValue, currentConfigPath)
Parameters :
Name Type Optional Default value
baseConfig JsonValue No
tenantConfig JsonValue No
currentConfigPath No []
Returns : JsonValue

libs/nx/src/generators/library/generator.ts

getExpandedOptions
getExpandedOptions(options: LibraryGeneratorSchema)
Parameters :
Name Type Optional
options LibraryGeneratorSchema No
library
library(tree: Tree, options: LibraryGeneratorSchema)
Parameters :
Name Type Optional
tree Tree No
options LibraryGeneratorSchema No
verifyWorkspaceSetup
verifyWorkspaceSetup(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/generators/journey-src/lib/pfe-pages/pfe-pages.ts

getFirstPageId
getFirstPageId(config: PfeJsonSchema)
Parameters :
Name Type Optional
config PfeJsonSchema No
Returns : string | undefined

libs/nx/src/executors/extract-i18n/executor.ts

getI18nOutputFileName
getI18nOutputFileName(format)
Parameters :
Name Optional Default value
format No DEFAULT_TRANSLATION_FILE_FORMAT
getSourceLocaleCode
getSourceLocaleCode(sourceLocaleConfig)
Parameters :
Name Optional
sourceLocaleConfig No
runI18nExtractExecutor
runI18nExtractExecutor(options: ExtractI18nExecutorSchema, context: ExecutorContext)
Parameters :
Name Type Optional
options ExtractI18nExecutorSchema No
context ExecutorContext No

libs/nx/src/migrations/bb-plugin-validation-configs/bb-plugin-validation-configs.ts

getJsonFilePathInDirectory
getJsonFilePathInDirectory(tree: Tree, sourcePath: string, filename: string)

Get the path of a file with a specific name in a given directory.

Parameters :
Name Type Optional Description
tree Tree No
sourcePath string No

The given source path for the directory.

filename string No

The name of the file to find, without the extension.

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 :
Name Type Optional Description
tree Tree No
sourcePath string No

The given source path for the directory.

Returns : string[]

A list of all the matching paths.

migrateBBPluginValidations
migrateBBPluginValidations(tree: Tree)
Parameters :
Name Type Optional
tree Tree No
migrateClassicJourney
migrateClassicJourney(tree: Tree, configDirectory: string)
Parameters :
Name Type Optional
tree Tree No
configDirectory string No
migrateSplitJourney
migrateSplitJourney(tree: Tree, configDirectory: string)
Parameters :
Name Type Optional
tree Tree No
configDirectory string No
parseJsonc
parseJsonc(tree: Tree, jsonFilePath: string, __namedParameters: {excludeSchema: boolean})

Given an file path, parse the content of the file as JSONC.

Parameters :
Name Type Optional Description
tree Tree No
jsonFilePath string No

The path of the file to parse.

excludeSchema boolean No
Returns : T

The parsed JSONC content.

updateJsonFileIfChanged
updateJsonFileIfChanged(tree: Tree, filePath: string, updatedContent: T)
Parameters :
Name Type Optional
tree Tree No
filePath string No
updatedContent T No

libs/sdk/src/node/journey/load/utils.ts

getJsonFilePathInDirectory
getJsonFilePathInDirectory(sourcePath: string, filename: string)

Get the path of a file with a specific name in a given directory.

Parameters :
Name Type Optional Description
sourcePath string No

The given source path for the directory.

filename string No

The name of the file to find, without the extension.

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 :
Name Type Optional Description
sourcePath string No

The given source path for the directory.

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 :
Name Type Optional Description
jsonFilePath string No

The path of the file to parse.

excludeSchema boolean No
Returns : T

The parsed JSONC content.

libs/sdk/src/lib/journey/config/migrations/shared/policy.ts

getLineBreakChar
getLineBreakChar(stringWithLineBreaks: string)
Parameters :
Name Type Optional
stringWithLineBreaks string No
Returns : string
removeAllowAllRules
removeAllowAllRules(policy: string)
Parameters :
Name Type Optional
policy string No
Returns : string
removeSubject
removeSubject(policy: string)
Parameters :
Name Type Optional
policy string No
Returns : string
updatePolicyFromActionEffectToState
updatePolicyFromActionEffectToState(policy: string)
Parameters :
Name Type Optional
policy string No
Returns : string

libs/oauth/src/lib-test/mock-http-handler.ts

getMockHttpHandler
getMockHttpHandler()
Returns : HttpHandler

libs/oauth/src/lib-test/mock-oauth-service.ts

getMockOauthService
getMockOauthService()
Returns : OauthService

libs/acl/input-element-injector-directive/src/lib/input-element-injector-directive.directive.ts

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 :
Name Optional
control No
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 :
Name Optional
control No

libs/nx/src/generators/journey-src/lib/extract-frame-data/section-utils.ts

getNavigationSectionFromPagesConfig
getNavigationSectionFromPagesConfig(pagesConfig: Pick)
Parameters :
Name Type Optional
pagesConfig Pick No

libs/nx/src/generators/journey-src/lib/pfe-setup/pfe-setup.ts

getPfeConfigAsTsNodeText
getPfeConfigAsTsNodeText(pfeConfig: NgxPfeConfig)
Parameters :
Name Type Optional
pfeConfig NgxPfeConfig No
Returns : string
getPfeConfigOverrides
getPfeConfigOverrides(pfeConfig: NgxPfeConfig)
Parameters :
Name Type Optional
pfeConfig NgxPfeConfig No
Returns : NgxPfeConfig
getPfeConfigWithPagesConfiguration
getPfeConfigWithPagesConfiguration(pfeConfig: PfeJsonSchema, pages)
Parameters :
Name Type Optional
pfeConfig PfeJsonSchema No
pages No
Returns : NgxPfeConfig
pfeSetup
pfeSetup(tree: Tree, pfeConfig: PfeJsonSchema, pagesConfig: PagesConfigurationWithTransformedDynamicForms, destinationDirectory: string)
Parameters :
Name Type Optional
tree Tree No
pfeConfig PfeJsonSchema No
pagesConfig PagesConfigurationWithTransformedDynamicForms No
destinationDirectory string No

libs/nx/src/executors/extract-plugin-metadata/compat/extract-single-plugin-metadata.ts

getPluginId
getPluginId(symbolName: string)
Parameters :
Name Type Optional Default value
symbolName string No ''
runPluginMetadata
runPluginMetadata(context: BuilderContext, logger: Logger, projectPath: string, __namedParameters: {pluginFolder: PluginFolderStats, moduleFilePath, injectableFilePath, markdownFilePath})
Parameters :
Name Type Optional
context BuilderContext No
logger Logger No
projectPath string No
pluginFolder PluginFolderStats No
moduleFilePath No
injectableFilePath No
markdownFilePath No

libs/nx/src/generators/journey-src/lib/add-acl-defaults-to-policy/read-journals.ts

getPossiblePathsToJournalJson
getPossiblePathsToJournalJson(tree: Tree, libraryName: string, workspaceNodeModulesDirectory: string)
Parameters :
Name Type Optional
tree Tree No
libraryName string No
workspaceNodeModulesDirectory string No
Returns : string[]
readJournals
readJournals(tree: Tree, libraryNames, workspaceNodeModulesDirectory: string)
Parameters :
Name Type Optional
tree Tree No
libraryNames No
workspaceNodeModulesDirectory string No
Returns : LibraryMetaData[]

libs/common/frame/src/frame-parts/navigation/navigation-utils.ts

getSectionsBeforeCurrentSection
getSectionsBeforeCurrentSection(currentSection, sections: SectionConfig)
Parameters :
Name Type Optional
currentSection No
sections SectionConfig No
Returns : string[]
getSectionsWithStates
getSectionsWithStates(pageHistory, sections: SectionConfig)
Parameters :
Name Type Optional
pageHistory No
sections SectionConfig No
Returns : SectionWithState[]

libs/nx/src/executors/shared/get-source-files/get-source-files.ts

getSingleSourceFile
getSingleSourceFile(program, fileName: string)
Parameters :
Name Type Optional
program No
fileName string No
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 :
Name Optional
program No

libs/nx/src/executors/introspection/compat/utils/process-properties.ts

getSyntaxKindToName
getSyntaxKindToName(givenKind)
Parameters :
Name Optional
givenKind No

libs/core/form-tracking/src/lib/form-tracking.ts

getTrackingValue
getTrackingValue(control: TalyAbstractControl)
Parameters :
Name Type Optional
control TalyAbstractControl No
pushTrackingEvents
pushTrackingEvents(control: TalyAbstractControl, trackingIdPrefix: string, controlName: string, pushEvent)
Parameters :
Name Type Optional
control TalyAbstractControl No
trackingIdPrefix string No
controlName string No
pushEvent No
Returns : void
setupFormTracking
setupFormTracking(controlOrGroup: AbstractControl, trackingIdPrefix: string, untilDestroyed$: Observable, pushEvent: PushEventFunction, parentPath)
Parameters :
Name Type Optional Default value
controlOrGroup AbstractControl No
trackingIdPrefix string No
untilDestroyed$ Observable No
pushEvent PushEventFunction No
parentPath No []
Returns : void
trackControl
trackControl(control: AbstractControl, trackingIdPrefix: string, controlName: string, untilDestroyed$: Observable, pushEvent: PushEventFunction)
Parameters :
Name Type Optional
control AbstractControl No
trackingIdPrefix string No
controlName string No
untilDestroyed$ Observable No
pushEvent PushEventFunction No
Returns : void
trackForm
trackForm(controlOrGroup: AbstractControl, trackingIdPrefix: string, untilDestroyed$: Observable, pushEvent: PushEventFunction)
Parameters :
Name Type Optional
controlOrGroup AbstractControl No
trackingIdPrefix string No
untilDestroyed$ Observable No
pushEvent PushEventFunction No
Returns : void

libs/acl/src/lib/acl-engine/glob-match.ts

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 fs which causes quite some trouble in browsers as bundlers like webpack are usually not properly configured (especially in our target Angular environment) to handle 'fs', 'path' etc.

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/

Parameters :
Name Type Optional
value string No
pattern string No
regExpEscape
regExpEscape(s: string)
Parameters :
Name Type Optional
s string No
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 :
Name Type Optional
s string No
Returns : RegExp

libs/sdk/src/lib/journey/config/migrations/bb-plugin-validation-configs/bb-plugin-validation-configs.ts

isBuildingBlockConfigurationWithValidators
isBuildingBlockConfigurationWithValidators(block)
Parameters :
Name Optional
block No
isBuiltInValidationRule
isBuiltInValidationRule(validationRule: any)
Parameters :
Name Type Optional
validationRule any No
Returns : ValidationRule
migrateBBPluginValidationConfiguration
migrateBBPluginValidationConfiguration(validators)
Parameters :
Name Optional
validators No
Returns : ValidationRule[]
migrateBBPluginValidationConfigurationsInFrame
migrateBBPluginValidationConfigurationsInFrame(frame: Frame)

Migrates the validation configuration for actions in the frame. The configuration is mutated directly.

Parameters :
Name Type Optional
frame Frame No
Returns : void
migrateBBPluginValidationsInApplicationJson
migrateBBPluginValidationsInApplicationJson(applicationJson: ApplicationJsonSchema)
Parameters :
Name Type Optional
applicationJson ApplicationJsonSchema No
migrateBBPluginValidationsInPage
migrateBBPluginValidationsInPage(pageConfiguration: PageJsonSchema)
Parameters :
Name Type Optional
pageConfiguration PageJsonSchema No
Returns : PageJsonSchema
migrateBBPluginValidationsInPagesJson
migrateBBPluginValidationsInPagesJson(pagesConfiguration: PagesJsonSchema)
Parameters :
Name Type Optional
pagesConfiguration PagesJsonSchema No

libs/acl/src/lib/acl-engine/condition.ts

isConditionMet
isConditionMet(condition: string, environment: Record, storeQuery)
Parameters :
Name Type Optional
condition string No
environment Record No
storeQuery No
Returns : boolean
isFiltrexError
isFiltrexError(result)
Parameters :
Name Optional
result No
Returns : FiltrexError

libs/core/src/lib/form-support/form-utils.ts

isFormArray
isFormArray(control: AbstractControl)
Parameters :
Name Type Optional
control AbstractControl No
Returns : UntypedFormArray
isFormControl
isFormControl(control: AbstractControl)
Parameters :
Name Type Optional
control AbstractControl No
Returns : UntypedFormControl
isFormGroup
isFormGroup(control: AbstractControl)
Parameters :
Name Type Optional
control AbstractControl No
Returns : UntypedFormGroup

libs/sdk/src/lib/journey/config/migrations/classic-journey/pages-json.ts

isPluginConfigWithLibVersion
isPluginConfigWithLibVersion(library)
Parameters :
Name Optional
library No
makeStickyBuildingBlockTheBannerBlock
makeStickyBuildingBlockTheBannerBlock(pagesConfiguration: PagesJsonSchema)
Parameters :
Name Type Optional
pagesConfiguration PagesJsonSchema No
Returns : PagesJsonSchema
migratePluginLibrariesToLibraries
migratePluginLibrariesToLibraries(pagesConfiguration: PagesJsonSchema)
Parameters :
Name Type Optional
pagesConfiguration PagesJsonSchema No
migrateSInterpolationToCurlyBraceInterpolation
migrateSInterpolationToCurlyBraceInterpolation(source: string)
Parameters :
Name Type Optional
source string No
Returns : string
moveStageConfigFromPageDataToTitle
moveStageConfigFromPageDataToTitle(pagesConfiguration: PagesJsonSchema)
Parameters :
Name Type Optional
pagesConfiguration PagesJsonSchema No
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.

Input Output
@scope/package @scope/package
@scope/package/entry-point @scope/package
package package
package/entry-point package
Parameters :
Name Type Optional Description
packageName string No

the package name to remove the secondary entry point from

Returns : string

libs/acl/angular/src/lib/services/missing-policy-warning.ts

isRunByJest
isRunByJest()
missingPolicyWarning
missingPolicyWarning()

libs/pfe-connector/src/lib/types.ts

isStoreQuery
isStoreQuery(query: StaticResource)
Parameters :
Name Type Optional
query StaticResource No
Returns : StoreQuery

libs/nx/src/executors/shared/normalize-executor-options.ts

isUndefined
isUndefined(value)
Parameters :
Name Optional
value No
Returns : undefined
normalizeExecutorOptions
normalizeExecutorOptions(options: Record)

Turns an options object into an array of CLI params.

Input: { myProp: 'value', otherProp: ['test1', 'test2] }
Output: ['--my-prop', 'value', '--other-prop', 'test1', '--other-prop', 'test2']

Parameters :
Name Type Optional
options Record No
Returns : string[]

libs/sdk/src/cli/analytics/analyze-journey.ts

loadAndTransformJourney
loadAndTransformJourney(configDirectory: string)
Parameters :
Name Type Optional
configDirectory string No
Returns : Promise<InternalJourney>
printBuildingBlockCounts
printBuildingBlockCounts(configDirectory: string)
Parameters :
Name Type Optional
configDirectory string No
printBuildingBlockPackages
printBuildingBlockPackages(configDirectory: string)
Parameters :
Name Type Optional
configDirectory string No
printBuildingBlocks
printBuildingBlocks(configDirectory: string)
Parameters :
Name Type Optional
configDirectory string No
printBuildingBlocksWithJourneyMetadata
printBuildingBlocksWithJourneyMetadata(configDirectory: string)
Parameters :
Name Type Optional
configDirectory string No

libs/sdk/src/node/journey/load/classic-journey/classic-journey.ts

loadClassicJourneyFromFolder
loadClassicJourneyFromFolder(configDirectory: string)

Loads a classic journey config from a given folder.

Parameters :
Name Type Optional Description
configDirectory string No
  • The directory path where the journey configuration files are located.
Returns : Journey

A Promise that resolves to the loaded classic journey.

libs/sdk/src/node/journey/load/load.ts

loadJourneyFromFolder
loadJourneyFromFolder(configDirectory: string, baseConfigDirectory?: string)
Parameters :
Name Type Optional Description
configDirectory string No

path to the directory that contains the journey's configuration files

baseConfigDirectory string Yes

path to the directory that contains the base journey's configuration files

Example :
<div><pre class="line-numbers"><code class="language-none">const journey = await loadJourneyFromFolder(&#39;path/to/config&#39;);</code></pre></div>
Returns : Promise<Journey>

Promise that resolves to the journey configuration already validated. It rejects if the given directory does not contain a pages JSON file or an application JSON file.

libs/sdk/src/node/journey/load/multi-tenant-journey/multi-tenant-journey.ts

loadMultiTenantJourneyFromFolder
loadMultiTenantJourneyFromFolder(baseConfigDirectory: string, tenantConfigDirectory: string)
Parameters :
Name Type Optional
baseConfigDirectory string No
tenantConfigDirectory string No
Returns : SplitJourney
readApplicationJson
readApplicationJson(baseConfigDirectory: string, tenantConfigDirectory: string)
Parameters :
Name Type Optional
baseConfigDirectory string No
tenantConfigDirectory string No
readMultiTenantDirectory
readMultiTenantDirectory(baseConfigDirectory: string, tenantConfigDirectory: string)
Parameters :
Name Type Optional
baseConfigDirectory string No
tenantConfigDirectory string No
readNavigationJson
readNavigationJson(baseConfigDirectory: string, tenantConfigDirectory: string, pages)
Parameters :
Name Type Optional
baseConfigDirectory string No
tenantConfigDirectory string No
pages No

libs/nx/src/executors/shared/metadata-utils/md5.ts

md5
md5(str: string)
Parameters :
Name Type Optional
str string No

libs/common/module-integration/src/utils/runtime-utils.ts

mergeEnvObjects
mergeEnvObjects(hostEnvData, moduleEnvData: EnvObj, moduleId: string)
Parameters :
Name Type Optional
hostEnvData No
moduleEnvData EnvObj No
moduleId string No
Returns : EnvObj

libs/nx/src/migrations/update-footer-copyright/update-footer-copyright.ts

migrateClassicJourney
migrateClassicJourney(tree: Tree, filePath: string)
Parameters :
Name Type Optional
tree Tree No
filePath string No
migrateSplitJourney
migrateSplitJourney(tree: Tree, filePath: string)
Parameters :
Name Type Optional
tree Tree No
filePath string No
updateFooterCopyright
updateFooterCopyright(tree: Tree)
Parameters :
Name Type Optional
tree Tree No
updateJsonFileIfChanged
updateJsonFileIfChanged(tree: Tree, filePath: string, updatedContent: T)
Parameters :
Name Type Optional
tree Tree No
filePath string No
updatedContent T No

libs/sdk/src/lib/journey/config/migrations/footer-copyright/footer-copyright.ts

migrateFooterCopyrightInApplicationJson
migrateFooterCopyrightInApplicationJson(applicationJson: ApplicationJsonSchema, filePath?: string)
Parameters :
Name Type Optional
applicationJson ApplicationJsonSchema No
filePath string Yes
migrateFooterCopyrightInPagesJson
migrateFooterCopyrightInPagesJson(pagesConfiguration: PagesJsonSchemaBeforeTheFooterCopyrightMigration, filePath?: string)
Parameters :
Name Type Optional
pagesConfiguration PagesJsonSchemaBeforeTheFooterCopyrightMigration No
filePath string Yes
removeCopyRightYear
removeCopyRightYear(copyrightContent: string, filePath?: string)
Parameters :
Name Type Optional
copyrightContent string No
filePath string Yes

libs/sdk/src/lib/journey/config/migrations/classic-journey/pfe-json.ts

migratePfePagesConfiguration
migratePfePagesConfiguration(pfeConfiguration, pagesConfiguration: PagesJsonSchema)
Parameters :
Name Type Optional
pfeConfiguration No
pagesConfiguration PagesJsonSchema No
Returns : literal type

libs/nx/src/generators/journey-src/lib/env-parsing/env.ts

parseEnvFile
parseEnvFile(content: string)
Parameters :
Name Type Optional
content string No
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 key=value combination similar to the file format to provide an explicit value.

The result is a key-value object {a: 1, b:"value"}

Parameters :
Name Optional
overrides No
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:

{
  KEY_A: 'value'
  KEY_B: 'some other value if `KEY_B` is present in process.env'
}
Parameters :
Name Type Optional
tree Tree No
options ReadEnvOptions No
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 :
Name Type Optional
tree Tree No
envPath string Yes
Returns : EnvOptionObject

libs/nx/src/executors/journal/compat/utils/read-acl-resource-descriptor.ts

parseYamlFile
parseYamlFile(path: string, logger: Logger)
Parameters :
Name Type Optional
path string No
logger Logger No
readAclResourceDescriptor
readAclResourceDescriptor(path: string, __namedParameters: {root: string, logger: Logger})
Parameters :
Name Type Optional Default value
path string No
root string No ''
logger Logger No
Returns : AclDescriptor[]
validateAgainstSchemaFile
validateAgainstSchemaFile(document, logger: Logger)
Parameters :
Name Type Optional
document No
logger Logger No

libs/nx/src/utils/jest/path-matcher.ts

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.

Parameters :
Name Type Optional
this No
received string No
expected string No

libs/sdk/src/utils/jest/path-matcher.ts

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.

Parameters :
Name Type Optional
this No
received string No
expected string No

libs/nx/src/executors/shared/metadata-utils/__test/my-simple-team-plugin-lib/src/lib/pfe-acl-expression-adapter/pfe-acl-expression-adapter.factory.ts

PfeAclExpressionAdapterFactory
PfeAclExpressionAdapterFactory(pfeStateService: PfeStateService)
Parameters :
Name Type Optional
pfeStateService PfeStateService No

libs/nx/src/executors/shared/metadata-utils/__test/my-team-plugin-lib/src/lib/pfe-acl-expression-adapter/pfe-acl-expression-adapter.factory.ts

PfeAclExpressionAdapterFactory
PfeAclExpressionAdapterFactory(pfeStateService: PfeStateService)
Parameters :
Name Type Optional
pfeStateService PfeStateService No

libs/sdk/src/node/journey/generate/lib/proceed-with-temp-taly/proceed-with-temp-taly.ts

proceedWithTemporaryTalyVersion
proceedWithTemporaryTalyVersion(talyVersion: string, options)
Parameters :
Name Type Optional
talyVersion string No
options No
Returns : AsyncGenerator<ProgressReport, void>

libs/nx/src/generators/journey-src/lib/scaffold-core/theme-file.ts

processAquilaThemePath
processAquilaThemePath(aquilaThemePath, destinationFolder: string)
Parameters :
Name Type Optional
aquilaThemePath No
destinationFolder string No
Returns : ThemeFile | null

libs/common/src/lib/dynamic-form-native-components/dynamic-form-native-components.module.ts

provideDynamicFormNativeComponents
provideDynamicFormNativeComponents()
Returns : Provider[]

libs/common/src/lib/dynamic-form-standalone/dynamic-form-standalone.providers.ts

provideTalyStandaloneDynamicForm
provideTalyStandaloneDynamicForm()

Provides everything the TALY Standalone Dynamic Form needs

Returns : Provider[]

libs/core/dynamic-form/date/src/iso-date-adapter/iso-date-adapter-testing.ts

range
range(length: number, valueFunction)

Creates an array and fills it with values.

Parameters :
Name Type Optional
length number No
valueFunction No
Returns : T[]

libs/nx/src/generators/journey-src/lib/experimental/experimental.ts

readExperiments
readExperiments(requestedExperiments)
Parameters :
Name Optional
requestedExperiments No
Returns : Experiments[]
validateExperiments
validateExperiments(experiments)
Parameters :
Name Optional
experiments No
Returns : Experiments[]

libs/nx/src/executors/shared/read-markdown.ts

readMarkdown
readMarkdown(filePath: string)
Parameters :
Name Type Optional
filePath string No
Returns : Promise<FrontMatterResult<any>>
readMarkdownAttributes
readMarkdownAttributes(filePath: string)

Use Frontmatter to extract the header data of a given markdown file

Parameters :
Name Type Optional
filePath string No
Returns : Promise<any>

libs/nx/src/executors/shared/metadata-utils/read-markdown.ts

readMarkdown
readMarkdown(filePath: string)
Parameters :
Name Type Optional
filePath string No
Returns : Promise<FrontMatterResult<any>>
readMarkdownAttributes
readMarkdownAttributes(filePath: string)

Use Frontmatter to extract the header data of a given markdown file

Parameters :
Name Type Optional
filePath string No
Returns : Promise<any>

libs/nx/src/migrations/remove-acl-subject/remove-acl-subject.ts

removeAclSubject
removeAclSubject(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/migrations/remove-screenshot-executor/remove-screenshot-executor.ts

removeScreenshotExecutor
removeScreenshotExecutor(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/migrations/rename-i18n-executor-options-from-browser-target-to-build-target/rename-i18n-executor-options-from-browser-target-to-build-target.ts

renameI18nExecutorOptionsFromBrowserTargetToBuildTarget
renameI18nExecutorOptionsFromBrowserTargetToBuildTarget(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/generators/journey-src/lib/create-pages/single-page/render-markdown-as-html.ts

renderMarkdownAsHtml
renderMarkdownAsHtml(text: string)
Parameters :
Name Type Optional
text string No
Returns : string

libs/pfe-connector/src/lib/utils/pfe-validator.ts

replacePFEQueryWithStream
replacePFEQueryWithStream(validationData, pfeQueries)
Parameters :
Name Optional
validationData No
pfeQueries No

libs/nx/src/executors/extract-plugin-metadata/compat/extract-plugin-metadata.impl.ts

run
run(options: ExtractPluginMetadataSchema, context: BuilderContext)
Parameters :
Name Type Optional
options ExtractPluginMetadataSchema No
context BuilderContext No
Returns : Promise<literal type>

libs/nx/src/executors/introspection/compat/introspection.impl.ts

run
run(options: IntrospectionExecutorSchema, context: BuilderContext)
Parameters :
Name Type Optional
options IntrospectionExecutorSchema No
context BuilderContext No
Returns : Promise<literal type>
writeIntrospection
writeIntrospection(outputFile: string, content)

Write our introspection, include a hash over the given content & a date.

Parameters :
Name Type Optional
outputFile string No
content No

libs/nx/src/executors/journal/compat/journal.impl.ts

run
run(options: JournalExecutorSchema, context: BuilderContext)
Parameters :
Name Type Optional
options JournalExecutorSchema No
context BuilderContext No
Returns : Promise<literal type>

libs/nx/src/executors/generate-and-serve/executor.ts

runGenerateAndServeExecutor
runGenerateAndServeExecutor(options: GenerateAndServeExecutorSchema, context: ExecutorContext)
Parameters :
Name Type Optional
options GenerateAndServeExecutorSchema No
context ExecutorContext No
Returns : Promise<literal type>

libs/nx/src/executors/generate/executor.ts

runGenerateExecutor
runGenerateExecutor(options: GenerateExecutorSchema, context: ExecutorContext)
Parameters :
Name Type Optional
options GenerateExecutorSchema No
context ExecutorContext No

libs/nx/src/generators/journey-src/lib/scaffold-core/scaffold-core.ts

scaffoldCore
scaffoldCore(tree: Tree, options: ScaffoldCoreOptions)
Parameters :
Name Type Optional
tree Tree No
options ScaffoldCoreOptions No

libs/pfe-connector/src/lib/utils/showroom-state.ts

setShowroomDataInPfeState
setShowroomDataInPfeState(showroomDataForPage, pfeBusinessService: PfeBusinessService, buildingBlocksMap: DataForPage)
Parameters :
Name Type Optional
showroomDataForPage No
pfeBusinessService PfeBusinessService No
buildingBlocksMap DataForPage No
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 :
Name Type Optional
showroomDataForPage PageInJourneyExampleData No
pfeBusinessService PfeBusinessService No
buildingBlocksMap DataForPage No
setShowroomStateInPfeState
setShowroomStateInPfeState(showroomDataForPage: PageInJourneyExampleData, pfeBusinessService: PfeBusinessService)
Parameters :
Name Type Optional
showroomDataForPage PageInJourneyExampleData No
pfeBusinessService PfeBusinessService No

libs/nx/src/generators/journey-src/lib/store-configuration/store-configuration.ts

storeConfiguration
storeConfiguration(tree: Tree, pagesJson: PagesConfigurationWithTransformedDynamicForms, policy, destinationDirectory: string)
Parameters :
Name Type Optional
tree Tree No
pagesJson PagesConfigurationWithTransformedDynamicForms No
policy No
destinationDirectory string No

libs/acl/form-support/src/lib/core/sync-control-edit.ts

syncControlEdit
syncControlEdit(control: AbstractControl, aclObservable: Observable)

Disable or Enable a control for a given aclAttribute

Parameters :
Name Type Optional
control AbstractControl No
aclObservable Observable No

libs/acl/form-support/src/lib/core/sync-control-readonly.ts

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 :
Name Type Optional
aclObservable Observable No

libs/pfe-connector/src/lib/utils/tap-once-operators.ts

tapOnce
tapOnce(fn)
Parameters :
Name Optional
fn No

libs/nx/src/executors/journal/compat/utils/transform-lob-values.ts

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 :
Name Optional Default value
values No []

libs/nx/src/generators/journey-src/lib/open-api-journey-model/open-api-journey-model.ts

turnJourneyModelIntoOpenApiSchema
turnJourneyModelIntoOpenApiSchema(destinationDirectory: string, journeyModelName: string)
Parameters :
Name Type Optional
destinationDirectory string No
journeyModelName string No

libs/sdk/src/node/journey/generate/utils/unparse-options.ts

unparseOptions
unparseOptions(options: Record)

Turns an options object into an array of schematic CLI params.

Input: { myProp: 'value', otherProp: ['test1', 'test2] }
Output: ['--my-prop', 'value', '--other-prop', 'test1', '--other-prop', 'test2']

Parameters :
Name Type Optional
options Record No
Returns : string[]

libs/nx/src/migrations/update-acl-defaults/update-acl-defaults.ts

updateAclDefaults
updateAclDefaults(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/generators/library/updaters/update-base-tsconfig-json/update-base-tsconfig-json.ts

updateBaseTsconfigJson
updateBaseTsconfigJson(tree: Tree, options: ProjectDetails)
Parameters :
Name Type Optional
tree Tree No
options ProjectDetails No

libs/nx/src/migrations/update-bb-state-types/update-bb-state-types.ts

updateBbStateTypes
updateBbStateTypes(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/generators/library/updaters/update-gitignore/update-gitignore.ts

updateGitignore
updateGitignore(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/migrations/update-schemas-imports/update-schemas-imports.ts

updateImport
updateImport(tree: Tree, filePath: string, symbolName: string, oldModuleName: string, newModuleName: string)
Parameters :
Name Type Optional
tree Tree No
filePath string No
symbolName string No
oldModuleName string No
newModuleName string No
updateImports
updateImports(oldImport: string, newImport: string, importsToBeUpdated, filePath: string, content: string, tree: Tree)
Parameters :
Name Type Optional
oldImport string No
newImport string No
importsToBeUpdated No
filePath string No
content string No
tree Tree No
updateSchemasImports
updateSchemasImports(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/migrations/update-validation-errors-imports/update-validation-errors-imports.ts

updateImport
updateImport(tree: Tree, filePath: string, symbolName: string, oldModuleName: string, newModuleName: string)
Parameters :
Name Type Optional
tree Tree No
filePath string No
symbolName string No
oldModuleName string No
newModuleName string No
updateImports
updateImports(oldImport: string, newImport: string, importsToBeUpdated, filePath: string, content: string, tree: Tree)
Parameters :
Name Type Optional
oldImport string No
newImport string No
importsToBeUpdated No
filePath string No
content string No
tree Tree No
updateValidationErrorsImports
updateValidationErrorsImports(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/generators/library/updaters/update-package-json/update-package-json.ts

updatePackageJson
updatePackageJson(tree: Tree, options: ProjectDetails)
Parameters :
Name Type Optional
tree Tree No
options ProjectDetails No

libs/nx/src/migrations/update-policy-format/update-policy-format.ts

updatePolicyFormat
updatePolicyFormat(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/generators/journey-src/lib/update-project-internationalization/update-project-internationalization.ts

updateProjectInternationalization
updateProjectInternationalization(tree: Tree, projectName: string, stripLocaleBaseHref: boolean, localesDestinationFolder: string)
Parameters :
Name Type Optional
tree Tree No
projectName string No
stripLocaleBaseHref boolean No
localesDestinationFolder string No

libs/nx/src/migrations/update-validation-errors-component/update-validation-errors-component.ts

updateValidationErrorsComponent
updateValidationErrorsComponent(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/migrations/use-native-destroy-ref/use-native-destroy-ref.ts

useNativeDestroyRef
useNativeDestroyRef(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/nx/src/migrations/use-taly-i18n-executor/use-taly-i18n-executor.ts

useTalyI18nExecutor
useTalyI18nExecutor(tree: Tree)
Parameters :
Name Type Optional
tree Tree No

libs/sdk/src/cli/validate-journey-config/validate-journey-config.ts

validateJourneyConfig
validateJourneyConfig(configDirectory: string)
Parameters :
Name Type Optional
configDirectory string No

libs/nx/src/executors/journal/compat/write-journal.ts

writeJournal
writeJournal(outputFile: string, content: JournalContent)

Write our journal, include a hash over the given content & a date.

Parameters :
Name Type Optional
outputFile string No
content JournalContent No

libs/sdk/src/node/journey/write/write.ts

writeJourneyToFolder
writeJourneyToFolder(journeyConfiguration: Journey, configDirectory: string)
Parameters :
Name Type Optional
journeyConfiguration Journey No
configDirectory string No

libs/nx/src/executors/extract-plugin-metadata/compat/utils/write-plugin-metadata.ts

writePluginMetadata
writePluginMetadata(outputFile: string, content)

Write our metadata file, include a hash over the given content & a date.

Parameters :
Name Type Optional
outputFile string No
content No

results matching ""

    No results matching ""