| accessPageAsAnonymous |
accessPageAsAnonymous()
|
| consentManagementTest |
consentManagementTest()
|
| giveConsent |
giveConsent()
|
| verifyAsAnonymous |
verifyAsAnonymous()
|
| verifyConsentManagementPage |
verifyConsentManagementPage()
|
| withdrawConsent |
withdrawConsent()
|
| activeCartReducer | ||||||
activeCartReducer(state, action)
|
||||||
|
Parameters :
Returns :
string
|
| cartEntitiesReducer | ||||||
cartEntitiesReducer(state, action)
|
||||||
|
Parameters :
Returns :
Cart
|
| wishListReducer | ||||||
wishListReducer(state, action)
|
||||||
|
Parameters :
Returns :
string
|
| addAccountFeature | ||||
addAccountFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addProfileFeature | ||||
addProfileFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addUserFeatures | ||||
addUserFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addAddress |
addAddress()
|
| addressBookDirectoryTabbingOrder |
addressBookDirectoryTabbingOrder()
|
| addressBookFormTabbingOrder | ||||
addressBookFormTabbingOrder(config)
|
||||
|
Parameters :
|
| getAddressRequest | ||||||||||||
getAddressRequest(auth, address, verify: boolean)
|
||||||||||||
|
Parameters :
|
| selectCountryCanada |
selectCountryCanada()
|
| setupForAddressBookTests |
setupForAddressBookTests()
|
| addAdministrationFeature | ||||
addAdministrationFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addOrderApprovalsFeature | ||||
addOrderApprovalsFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusOrganization | ||||
addSpartacusOrganization(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addAep | ||||
addAep(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addGtm | ||||
addGtm(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addPersonalizationFeature | ||||
addPersonalizationFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addTrackingFeatures | ||||
addTrackingFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addAsmFeature | ||||
addAsmFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addAsmFeatures | ||||
addAsmFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addB2bProductToCartAndCheckout |
addB2bProductToCartAndCheckout()
|
| completeReplenishmentForm | ||||
completeReplenishmentForm(replenishmentPeriod)
|
||||
|
Parameters :
|
| enterPONumber |
enterPONumber()
|
| loginB2bUser |
loginB2bUser()
|
| placeOrder | ||||
placeOrder(orderUrl)
|
||||
|
Parameters :
|
| reviewB2bOrderConfirmation | ||||||||||||||||||
reviewB2bOrderConfirmation(sampleUser, sampleProduct, cartData, isAccount: boolean, replenishment?)
|
||||||||||||||||||
|
Parameters :
|
| reviewB2bReviewOrderPage | |||||||||||||||
reviewB2bReviewOrderPage(sampleUser, cartData, isAccount: boolean, orderType)
|
|||||||||||||||
|
Parameters :
|
| selectAccountDeliveryMode |
selectAccountDeliveryMode()
|
| selectAccountPayment |
selectAccountPayment()
|
| selectAccountShippingAddress |
selectAccountShippingAddress()
|
| selectCreditCardPayment |
selectCreditCardPayment()
|
| addB2bProviders | ||||
addB2bProviders(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addCustomConfig | ||||||||
addCustomConfig(tsconfigPath, basePath, config)
|
||||||||
|
Parameters :
Returns :
Rule
|
| addFeatureModule | ||||||||||
addFeatureModule(tsconfigPath, basePath, config, options)
|
||||||||||
|
Parameters :
Returns :
Rule
|
| addFeatureTranslations | ||||||||
addFeatureTranslations(tsconfigPath, basePath, config)
|
||||||||
|
Parameters :
Returns :
Rule
|
| addLibraryAssets | ||||||
addLibraryAssets(assetsConfig, options)
|
||||||
|
Parameters :
Returns :
Rule
|
| addLibraryFeature | ||||||
addLibraryFeature(options, config)
|
||||||
|
Parameters :
Returns :
Rule
|
| addLibraryStyles | ||||||
addLibraryStyles(stylingConfig, options)
|
||||||
|
Parameters :
Returns :
Rule
|
| addPackageJsonDependencies | |||||||||
addPackageJsonDependencies(dependencies, packageJson: any)
|
|||||||||
|
Parameters :
Returns :
Rule
|
| addPackageJsonDependenciesForLibrary | ||||||
addPackageJsonDependenciesForLibrary(dependencies, options)
|
||||||
|
Parameters :
Returns :
Rule
|
| addRootModule | ||||||||
addRootModule(tsconfigPath, basePath, config)
|
||||||||
|
Parameters :
Returns :
Rule
|
| addSchematicsTasks | ||||||
addSchematicsTasks(featureOptions, context)
|
||||||
|
Parameters :
Returns :
void
|
| checkAppStructure | ||||||
checkAppStructure(tree, project)
|
||||||
|
Parameters :
Returns :
boolean
|
| configureB2bFeatures | |||||||||
configureB2bFeatures(options, packageJson: any)
|
|||||||||
|
Parameters :
Returns :
Rule
|
| createAssetsArray | ||||||
createAssetsArray(assetsConfig, angularJsonAssets)
|
||||||
|
Parameters :
Returns :
unknown[]
|
| createModuleFileName | ||||
createModuleFileName(config)
|
||||
|
Parameters :
Returns :
string
|
| createNodePackageInstallationTask | ||||
createNodePackageInstallationTask(context)
|
||||
|
Parameters :
Returns :
TaskId
|
| dependencyExists | |||||||||
dependencyExists(dependency, packageJson: any)
|
|||||||||
|
Parameters :
Returns :
boolean
|
| getPackageBySubFeature | ||||
getPackageBySubFeature(subFeature)
|
||||
|
Parameters :
Returns :
string
|
| getSpartacusFeaturesModule | ||||
getSpartacusFeaturesModule(sourceFile)
|
||||
|
Parameters :
Returns :
CallExpression | undefined
|
| handleFeature | ||||||
handleFeature(options, config)
|
||||||
|
Parameters :
Returns :
Rule
|
| installPackageJsonDependencies |
installPackageJsonDependencies()
|
|
Returns :
Rule
|
| installRequiredSpartacusFeatures | ||||||
installRequiredSpartacusFeatures(dependencyManagement, options)
|
||||||
|
Parameters :
Returns :
Rule
|
| logFeatureInstallation | ||||||
logFeatureInstallation(dependencyManagement, context)
|
||||||
|
Parameters :
Returns :
void
|
| prepareCliPackageAndSubFeature | ||||
prepareCliPackageAndSubFeature(features)
|
||||
|
Parameters :
Returns :
Record<string, string[]>
|
| runExternalSpartacusLibrary | ||||
runExternalSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| shouldAddFeature | ||||||
shouldAddFeature(feature, features)
|
||||||
|
Parameters :
Returns :
boolean
|
| spartacusFeatureModuleExists | ||||||||
spartacusFeatureModuleExists(tree, tsconfigPath, basePath)
|
||||||||
|
Parameters :
Returns :
boolean
|
| addBulkPricingFeature | ||||
addBulkPricingFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addImageZoom | ||||
addImageZoom(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusProduct | ||||
addSpartacusProduct(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addVariantsFeature | ||||
addVariantsFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addCartFeatures | ||||
addCartFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addCartImportExportFeature | ||||
addCartImportExportFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addQuickOrderFeature | ||||
addQuickOrderFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addSavedCartFeature | ||||
addSavedCartFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addCartItemsAndLoadCart |
addCartItemsAndLoadCart()
|
| cartTabbingOrder | ||||
cartTabbingOrder(config)
|
||||
|
Parameters :
|
| addCartItemsAndLoadCart |
addCartItemsAndLoadCart()
|
| saveForLaterTabbingOrder | ||||
saveForLaterTabbingOrder(config)
|
||||
|
Parameters :
|
| addCdc | ||||||
addCdc(options, context)
|
||||||
|
Parameters :
Returns :
Rule
|
| addCdcFeature | ||||
addCdcFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addCds | ||||||
addCds(options, context)
|
||||||
|
Parameters :
Returns :
Rule
|
| addCdsFeature | ||||
addCdsFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| validateCdsOptions | |||||
validateCdsOptions(undefined, context)
|
|||||
|
Parameters :
Returns :
void
|
| addCheapProductToCart | ||||
addCheapProductToCart(sampleProduct)
|
||||
|
Parameters :
|
| addCheapProductToCartAndBeginCheckoutForSignedInCustomer | ||||
addCheapProductToCartAndBeginCheckoutForSignedInCustomer(sampleProduct)
|
||||
|
Parameters :
|
| addCheapProductToCartAndLogin | ||||||
addCheapProductToCartAndLogin(sampleUser, sampleProduct)
|
||||||
|
Parameters :
|
| addCheapProductToCartAndProceedToCheckout | ||||
addCheapProductToCartAndProceedToCheckout(sampleProduct)
|
||||
|
Parameters :
|
| addProductToCart |
addProductToCart()
|
| clickAddNewPayment |
clickAddNewPayment()
|
| clickCheapProductDetailsFromHomePage | ||||
clickCheapProductDetailsFromHomePage(sampleProduct)
|
||||
|
Parameters :
|
| clickHamburger |
clickHamburger()
|
|
Clicks the main menu (on mobile only) |
| fillAddressForm | ||||
fillAddressForm(shippingAddressData)
|
||||
|
Parameters :
|
| fillAddressFormWithCheapProduct | ||||||
fillAddressFormWithCheapProduct(shippingAddressData, cartData)
|
||||||
|
Parameters :
|
| fillPaymentForm | ||||||
fillPaymentForm(paymentDetailsData, billingAddress?)
|
||||||
|
Parameters :
|
| fillPaymentFormWithCheapProduct | ||||||||
fillPaymentFormWithCheapProduct(paymentDetailsData, billingAddress?, cartData)
|
||||||||
|
Parameters :
|
| goToCheapProductDetailsPage | ||||
goToCheapProductDetailsPage(sampleProduct)
|
||||
|
Parameters :
|
| goToPaymentDetails |
goToPaymentDetails()
|
| goToProductDetailsPage |
goToProductDetailsPage()
|
| loginUser | ||||
loginUser(sampleUser)
|
||||
|
Parameters :
|
| placeOrder |
placeOrder()
|
| placeOrderWithCheapProduct | ||||||||
placeOrderWithCheapProduct(sampleUser, cartData, currency)
|
||||||||
|
Parameters :
|
| registerUser | |||||||||
registerUser(giveRegistrationConsent: boolean, sampleUser)
|
|||||||||
|
Parameters :
|
| signInUser | ||||
signInUser(sampleUser)
|
||||
|
Parameters :
|
| signOut |
signOut()
|
| signOutUser | ||||
signOutUser(sampleUser)
|
||||
|
Parameters :
|
| verifyDeliveryMethod |
verifyDeliveryMethod()
|
| verifyOrderConfirmationPageWithCheapProduct | |||||||||||||||
verifyOrderConfirmationPageWithCheapProduct(sampleUser, sampleProduct, cartData, isApparel: boolean)
|
|||||||||||||||
|
Parameters :
|
| verifyReviewOrderPage |
verifyReviewOrderPage()
|
| viewOrderHistory |
viewOrderHistory()
|
| viewOrderHistoryWithCheapProduct | ||||
viewOrderHistoryWithCheapProduct(cartData)
|
||||
|
Parameters :
|
| visitHomePage | ||||||
visitHomePage(queryStringParams?)
|
||||||
|
Visits the homepage and waits for corresponding xhr call
Parameters :
|
| waitForCategoryPage | ||||||
waitForCategoryPage(categoryCode, alias)
|
||||||
|
Parameters :
Returns :
string
|
| waitForPage | |||||||||
waitForPage(page, alias)
|
|||||||||
|
Creates a routing alias for a given page
Parameters :
Returns :
string
a Routing alias |
| waitForProductPage | ||||||
waitForProductPage(product, alias)
|
||||||
|
Parameters :
Returns :
string
|
| addCheckoutFeatures | ||||
addCheckoutFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addSavedCheckoutFeature | ||||
addSavedCheckoutFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addCmsComponent | ||||
addCmsComponent(options)
|
||||
|
Parameters :
Returns :
Rule
|
| buildComponentModule | ||||
buildComponentModule(options)
|
||||
|
Parameters :
Returns :
string
|
| buildDeclaringCmsModule | ||||
buildDeclaringCmsModule(options)
|
||||
|
Parameters :
Returns :
string
|
| declareInModule | ||||
declareInModule(options)
|
||||
|
Parameters :
Returns :
Rule
|
| updateComponent | ||||
updateComponent(options)
|
||||
|
Parameters :
Returns :
Rule
|
| updateModule | ||||
updateModule(options)
|
||||
|
Parameters :
Returns :
Rule
|
| updateTemplate | ||||
updateTemplate(options)
|
||||
|
Parameters :
Returns :
Rule
|
| validateArguments | ||||
validateArguments(options)
|
||||
|
Parameters :
Returns :
void
|
| addCmsRoute | ||||
addCmsRoute(injector)
|
||||
|
Parameters :
Returns :
void
|
| addComment | ||||||||||||||||
addComment(context: any, octoKit: any, comment)
|
||||||||||||||||
|
Adds hosting service deployment URL as a comment to the corresponding github pull request
Parameters :
|
| build |
build()
|
| getBundleId | ||||||
getBundleId(branch)
|
||||||
|
Generates a UPP valid bundle Id based on the branch name replaces slashes with -s and other chars with -d
Parameters :
|
| addCommentToPR | |||||||||||||||
addCommentToPR(entryPoints, ghClient: any, relatedPR, context)
|
|||||||||||||||
|
Parameters :
|
| extractListOfNotAnalyzedEntryPoints | ||||||
extractListOfNotAnalyzedEntryPoints(entryPoints)
|
||||||
|
Generate list of all entry points that could not be analyzed.
Parameters :
Returns :
[]
|
| extractSnippetFromFile | ||||||
extractSnippetFromFile(filename)
|
||||||
|
Extract from the api-extractor report public api definition.
Parameters :
Returns :
string
|
| generateCommentBody | |||||||||
generateCommentBody(analyzedComments, notAnalyzableEntryPoints)
|
|||||||||
|
Generates github comment content for pull request with bot results
Parameters :
Returns :
string
|
| generateCommentForAnalyzed | ||||||
generateCommentForAnalyzed(comments)
|
||||||
|
Generates part of the pull request comment for analyzed libraries
Parameters :
Returns :
string
|
| generateCommentForEntryPoint | ||||||
generateCommentForEntryPoint(entry)
|
||||||
|
Generate comment for entry points based on their status
Parameters :
Returns :
string
comment for entry point |
| generateCommentForNotAnalyzed | ||||||
generateCommentForNotAnalyzed(notAnalyzableEntryPoints)
|
||||||
|
Generates part of the pull request comment for not analyzed libraries
Parameters :
Returns :
string
|
| generateHelpContent | ||||||
generateHelpContent(analysisContent)
|
||||||
|
Generate help information related to found errors to help developers debug the issue.
Parameters :
|
| getDiff | ||||||
getDiff(report)
|
||||||
|
Get diff between base and head branch report.
Parameters :
Returns :
string
diff between head and base branch of public api for entry point |
| printReport | ||||||||||||||||||||
printReport(body, ghClient: any, issueNumber, context)
|
||||||||||||||||||||
|
Update or create comment in the PR with API extractor result.
Parameters :
|
| addCommonConfiguration | ||||||
addCommonConfiguration(sourceFile, options)
|
||||||
|
Parameters :
Returns :
void
|
| addConfiguration | ||||||||||
addConfiguration(tree, tsconfigPath, basePath, options)
|
||||||||||
|
Parameters :
Returns :
void
|
| addSpartacusConfiguration | ||||
addSpartacusConfiguration(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addStorefrontConfig | ||||||
addStorefrontConfig(sourceFile, options)
|
||||||
|
Creates and adds a spartacus config based on the provided
Parameters :
Returns :
void
|
| createBackendConfiguration | ||||
createBackendConfiguration(options)
|
||||
|
Parameters :
Returns :
string
|
| createFeatureLevelConfiguration | ||||
createFeatureLevelConfiguration(options)
|
||||
|
Parameters :
Returns :
string
|
| createI18NConfiguration |
createI18NConfiguration()
|
|
Returns :
string
|
| createSiteContextConfig | ||||
createSiteContextConfig(options)
|
||||
|
Parameters :
Returns :
string
|
| addConstructorParam | ||||||||||
addConstructorParam(source, sourcePath, constructorNode, paramToAdd)
|
||||||||||
|
Parameters :
Returns :
Change[]
|
| buildHtmlComment | ||||
buildHtmlComment(commentText)
|
||||
|
Parameters :
Returns :
string
|
| buildSelector | ||||
buildSelector(selector)
|
||||
|
Parameters :
Returns :
string
|
| buildSpartacusComment | ||||
buildSpartacusComment(comment)
|
||||
|
Parameters :
Returns :
string
|
| checkConstructorParameters | ||||||
checkConstructorParameters(constructorNode, parameterClassTypes)
|
||||||
|
Parameters :
Returns :
boolean
|
| checkImports | ||||||
checkImports(source, parameterClassTypes)
|
||||||
|
Parameters :
Returns :
boolean
|
| checkSuper | ||||||
checkSuper(constructorNode, parameterClassTypes)
|
||||||
|
Parameters :
Returns :
boolean
|
| commitChanges | ||||||||||
commitChanges(host, path, changes, insertDirection)
|
||||||||||
|
Parameters :
Returns :
void
|
| defineProperty | ||||||||
defineProperty(nodes, path, toAdd)
|
||||||||
|
Parameters :
Returns :
InsertChange
|
| filterNamedImports | ||||
filterNamedImports(imports)
|
||||
|
Parameters :
Returns :
ts.ImportDeclaration[]
|
| filterNamespacedImports | ||||
filterNamespacedImports(imports)
|
||||
|
Parameters :
Returns :
ts.ImportDeclaration[]
|
| findConstructor | ||||
findConstructor(nodes)
|
||||
|
Parameters :
Returns :
ts.Node | undefined
|
| findLevel1NodesByTextAndKind | ||||||||
findLevel1NodesByTextAndKind(nodes, text, syntaxKind)
|
||||||||
|
Parameters :
Returns :
ts.Node[]
|
| findLevel1NodesInSourceByTextAndKind | ||||||||
findLevel1NodesInSourceByTextAndKind(source, text, syntaxKind)
|
||||||||
|
Parameters :
Returns :
ts.Node[]
|
| findMultiLevelNodesByTextAndKind | ||||||||
findMultiLevelNodesByTextAndKind(nodes, text, syntaxKind)
|
||||||||
|
Parameters :
Returns :
ts.Node[]
|
| getAllTsSourceFiles | ||||||
getAllTsSourceFiles(tree, basePath)
|
||||||
|
Parameters :
Returns :
ts.SourceFile[]
|
| getClassName | ||||
getClassName(constructorParameter)
|
||||
|
Parameters :
Returns :
string | undefined
|
| getConstructorParameterList | ||||
getConstructorParameterList(constructorNode)
|
||||
|
Parameters :
Returns :
ts.Node[]
|
| getHtmlFiles | ||||||||||||
getHtmlFiles(tree, fileName: string, directory?)
|
||||||||||||
|
Parameters :
Returns :
string[]
|
| getImportDeclarationNode | ||||||
getImportDeclarationNode(source, importToCheck)
|
||||||
|
Parameters :
Returns :
ts.Node | undefined
|
| getImportDeclarations | ||||||
getImportDeclarations(source, importPath)
|
||||||
|
Parameters :
Returns :
ts.ImportDeclaration[]
|
| getIndexHtmlPath | ||||
getIndexHtmlPath(tree)
|
||||
|
Parameters :
Returns :
string
|
| getLineFromTSFile | ||||||||
getLineFromTSFile(host, path, position)
|
||||||||
|
Parameters :
|
| getLineStartFromTSFile | ||||||
getLineStartFromTSFile(source, position)
|
||||||
|
Parameters :
Returns :
number
|
| getMetadataProperty | ||||||
getMetadataProperty(metadata, propertyName)
|
||||||
|
Parameters :
Returns :
ts.PropertyAssignment
|
| getParamName | ||||||||
getParamName(source, constructorNode, classType)
|
||||||||
|
Parameters :
Returns :
string | undefined
|
| getPathResultsForFile | ||||||||
getPathResultsForFile(tree, file, directory?)
|
||||||||
|
Parameters :
Returns :
string[]
|
| getServerTsPath | ||||
getServerTsPath(host)
|
||||
|
Parameters :
Returns :
string | undefined
|
| getTextPosition | ||||||||||||
getTextPosition(content, text, startingPosition: number)
|
||||||||||||
|
Parameters :
Returns :
number | undefined
|
| getTsSourceFile | ||||||
getTsSourceFile(tree, path)
|
||||||
|
Parameters :
Returns :
ts.SourceFile
|
| injectService | ||||
injectService(config)
|
||||
|
Parameters :
Returns :
InsertChange
|
| insertCommentAboveConfigProperty | ||||||||||
insertCommentAboveConfigProperty(sourcePath, source, identifierName, comment)
|
||||||||||
|
Parameters :
Returns :
Change[]
|
| insertCommentAboveIdentifier | ||||||||||||
insertCommentAboveIdentifier(sourcePath, source, identifierName, comment, identifierType)
|
||||||||||||
|
Parameters :
Returns :
Change[]
|
| insertCommentAboveImportIdentifier | ||||||||||||
insertCommentAboveImportIdentifier(sourcePath, source, identifierName, importPath, comment)
|
||||||||||||
|
Parameters :
Returns :
Change[]
|
| insertComponentSelectorComment | ||||||||
insertComponentSelectorComment(content, componentSelector, componentProperty)
|
||||||||
|
Parameters :
Returns :
string | undefined
|
| insertHtmlComment | ||||||
insertHtmlComment(content, componentProperty)
|
||||||
|
Parameters :
Returns :
string | undefined
|
| isCandidateForConstructorDeprecation | |||||||||
isCandidateForConstructorDeprecation(source, constructorDeprecation)
|
|||||||||
|
Method performs the following checks on the provided
If only once condition is not satisfied, the method returns
Parameters :
Returns :
boolean
|
| isInheriting | ||||||
isInheriting(nodes, inheritedClass)
|
||||||
|
Parameters :
Returns :
boolean
|
| isInjected | ||||||
isInjected(constructorNode, parameterClassType)
|
||||||
|
Parameters :
Returns :
boolean
|
| removeConstructorParam | ||||||||||
removeConstructorParam(source, sourcePath, constructorNode, paramToRemove)
|
||||||||||
|
Parameters :
Returns :
Change[]
|
| removeConstructorParamInternal | ||||||||
removeConstructorParamInternal(sourcePath, constructorNode, importToRemove)
|
||||||||
|
Parameters :
Returns :
Change[]
|
| removeImport | ||||||
removeImport(source, importToRemove)
|
||||||
|
Parameters :
Returns :
Change
|
| removeInjectImports | ||||||||
removeInjectImports(source, constructorNode, paramToRemove)
|
||||||||
|
Parameters :
Returns :
Change[]
|
| removeParamFromSuper | ||||||||
removeParamFromSuper(sourcePath, constructorNode, paramName)
|
||||||||
|
Parameters :
Returns :
Change[]
|
| renameIdentifierNode | ||||||||||
renameIdentifierNode(sourcePath, source, oldName, newName)
|
||||||||||
|
Parameters :
Returns :
ReplaceChange[]
|
| shouldRemoveDecorator | ||||||
shouldRemoveDecorator(constructorNode, decoratorIdentifier)
|
||||||
|
Parameters :
Returns :
boolean
|
| shouldRemoveImportAndParam | ||||||
shouldRemoveImportAndParam(source, importToRemove)
|
||||||
|
Parameters :
Returns :
boolean
|
| updateConstructorSuperNode | ||||||||
updateConstructorSuperNode(sourcePath, constructorNode, propertyName)
|
||||||||
|
Parameters :
Returns :
InsertChange
|
| visitHtmlNodesRecursively | ||||||||||
visitHtmlNodesRecursively(nodes, propertyName, resultingElements, parentElement?)
|
||||||||||
|
Parameters :
Returns :
void
|
| addCpqRulebasedRootModule | ||||||
addCpqRulebasedRootModule(options)
|
||||||
|
Needed to set the CPQ specific root module that enforces early login and must not be active for other configurators
Parameters :
Returns :
Rule
|
| addProductConfiguratorFeatures | ||||
addProductConfiguratorFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addProductConfiguratorRulebasedFeature | ||||||
addProductConfiguratorRulebasedFeature(options)
|
||||||
|
Called with or without CPQ enabled, and uses a different application module for CPQ
Parameters :
Returns :
Rule
|
| addProductConfiguratorTextfieldFeature | ||||
addProductConfiguratorTextfieldFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addDigitalPayments | ||||
addDigitalPayments(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addDigitalPaymentsFeature | ||||
addDigitalPaymentsFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addEntryPoint | ||||||||||||
addEntryPoint(entryPoints, name, newName)
|
||||||||||||
|
Initialized new empty entry point in the passed object.
Parameters :
Returns :
void
|
| analyzeEntryPoint | ||||||
analyzeEntryPoint(entryPointDir)
|
||||||
|
Run api-extractor on directory
Parameters :
Returns :
Promise<>
Array with exit code and errors array as a second element |
| analyzeEntryPoints | ||||||
analyzeEntryPoints(branch, entryPoints)
|
||||||
|
Parameters :
|
| copyApiExtractorConfig | ||||||
copyApiExtractorConfig(targetDir)
|
||||||
|
Copies api-extractor config to provided directory
Parameters :
Returns :
Promise<void>
|
| getDirectoryOfPackageJson | ||||||
getDirectoryOfPackageJson(path)
|
||||||
|
Get the directory for the package.json file.
Parameters :
Returns :
string
directory of the package.json file |
| updateNameInPackageJson | ||||||
updateNameInPackageJson(path)
|
||||||
|
Updates name in package.json, so it doesn't have more than 1
Parameters :
Returns :
literal type
object with name and the newName |
| addEpdVisualization | ||||
addEpdVisualization(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addEpdVisualizationFeature | ||||
addEpdVisualizationFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addExternalRoutesFactory | ||||
addExternalRoutesFactory(service)
|
||||
|
Parameters :
Returns :
void
|
| addImport | ||||||||||
addImport(host, filePath, importText, importPath)
|
||||||||||
|
Parameters :
Returns :
void
|
| addToMetadata | ||||||||||||
addToMetadata(host, modulePath, text, metadataType, moduleSource?)
|
||||||||||||
|
Parameters :
Returns :
InsertChange[]
|
| addToModuleDeclarations | ||||||||||
addToModuleDeclarations(host, modulePath, declarations, moduleSource?)
|
||||||||||
|
Parameters :
Returns :
InsertChange[]
|
| addToModuleExports | ||||||||||
addToModuleExports(host, modulePath, exportsText, moduleSource?)
|
||||||||||
|
Parameters :
Returns :
InsertChange[]
|
| addToModuleImports | ||||||||||
addToModuleImports(host, modulePath, importText, moduleSource?)
|
||||||||||
|
Parameters :
Returns :
InsertChange[]
|
| addToModuleImportsAndCommitChanges | ||||||||
addToModuleImportsAndCommitChanges(host, modulePath, importText)
|
||||||||
|
Parameters :
Returns :
void
|
| addToModuleProviders | ||||||||||
addToModuleProviders(host, modulePath, importText, moduleSource?)
|
||||||||||
|
Parameters :
Returns :
InsertChange[]
|
| buildRelativePath | ||||||
buildRelativePath(from, to)
|
||||||
|
Build a relative path from one file path to another file path.
Parameters :
Returns :
string
|
| createImportChange | ||||||||||
createImportChange(host, filePath, importText, importPath)
|
||||||||||
|
Parameters :
Returns :
Change
|
| getAppModule | ||||||
getAppModule(host, project)
|
||||||
|
Parameters :
Returns :
string
|
| getTemplateInfo | ||||
getTemplateInfo(source)
|
||||
|
Parameters :
Returns :
literal type | undefined
|
| getTemplateUrlOrInlineTemplate | ||||||
getTemplateUrlOrInlineTemplate(source, templateOrTemplateUrl)
|
||||||
|
Parameters :
Returns :
literal type | undefined
|
| stripTsFromImport | ||||
stripTsFromImport(importPath)
|
||||
|
Parameters :
Returns :
string
|
| addManyProductsToTheList | ||||
addManyProductsToTheList(products)
|
||||
|
Parameters :
|
| addProductToCartWithQuickForm | ||||||
addProductToCartWithQuickForm(productCode, quantity?)
|
||||||
|
Parameters :
|
| addProductToTheList | ||||
addProductToTheList(query)
|
||||
|
Parameters :
|
| addProductToTheListAndModifyQuantity | ||||||
addProductToTheListAndModifyQuantity(query, quantity)
|
||||||
|
Parameters :
|
| addToCart |
addToCart()
|
| addToCartClick |
addToCartClick()
|
| addWrongProductQuery | ||||
addWrongProductQuery(query)
|
||||
|
Parameters :
|
| clearList |
clearList()
|
| getQuickOrderResultBox | ||||||
getQuickOrderResultBox(query, resultBoxLength)
|
||||||
|
Parameters :
|
| interceptAddToCartEndpoint |
interceptAddToCartEndpoint()
|
| interceptSearchProductsEndpoint | ||||
interceptSearchProductsEndpoint(query)
|
||||
|
Parameters :
|
| modifyProductQuantityInQuickOrderList | ||||
modifyProductQuantityInQuickOrderList(quantity)
|
||||
|
Parameters :
|
| prepareCartWithProduct |
prepareCartWithProduct()
|
| removeFirstRow |
removeFirstRow()
|
| removeManyRows | ||||
removeManyRows(quantity)
|
||||
|
Parameters :
|
| restoreDeletedEntry |
restoreDeletedEntry()
|
| verifyCartPageTabbingOrder |
verifyCartPageTabbingOrder()
|
| verifyEmptyListButtonIsHidden |
verifyEmptyListButtonIsHidden()
|
| verifyMiniCartQuantity | ||||
verifyMiniCartQuantity(quantity)
|
||||
|
Parameters :
|
| verifyQuickOrderFormResultsBoxIsEmpty |
verifyQuickOrderFormResultsBoxIsEmpty()
|
| verifyQuickOrderListQuantity | ||||
verifyQuickOrderListQuantity(quantity)
|
||||
|
Parameters :
|
| verifyQuickOrderPageDoNotShowEntryDeletionMessages |
verifyQuickOrderPageDoNotShowEntryDeletionMessages()
|
| verifyQuickOrderPageHasNotDeletionMessage |
verifyQuickOrderPageHasNotDeletionMessage()
|
| verifyQuickOrderPageShowEntryDeletionMessages | ||||
verifyQuickOrderPageShowEntryDeletionMessages(quantity)
|
||||
|
Parameters :
|
| verifyQuickOrderPageShowErrorMessageNonPurchasableProduct |
verifyQuickOrderPageShowErrorMessageNonPurchasableProduct()
|
| verifyQuickOrderPageShowErrorMessageOutOfStock |
verifyQuickOrderPageShowErrorMessageOutOfStock()
|
| verifyQuickOrderPageShowInfoMessageToAddProductBeforeClickingAddToCart |
verifyQuickOrderPageShowInfoMessageToAddProductBeforeClickingAddToCart()
|
| verifyQuickOrderPageShowSuccessMessageWasAdded |
verifyQuickOrderPageShowSuccessMessageWasAdded()
|
| verifyQuickOrderPageShowWarningMessageWasReduced |
verifyQuickOrderPageShowWarningMessageWasReduced()
|
| verifyQuickOrderPageTabbingOrder |
verifyQuickOrderPageTabbingOrder()
|
| verifyQuickOrderReachedListLimit |
verifyQuickOrderReachedListLimit()
|
| visitCartPage |
visitCartPage()
|
| visitQuickOrderPage |
visitQuickOrderPage()
|
| addMissingDependenciesToPackageJson | ||||||||
addMissingDependenciesToPackageJson(libraries, rootPackageJson, options)
|
||||||||
|
Adds peerDependencies to libraries package.json files
Parameters :
Returns :
void
|
| categorizeUsageOfDependencies | ||||
categorizeUsageOfDependencies(libraries)
|
||||
|
Categorize in which type of files we use different dependencies
Parameters :
Returns :
void
|
| checkEmptyDevDependencies | ||||||
checkEmptyDevDependencies(libraries, options)
|
||||||
|
Check if package does not have any devDependencies
Parameters :
Returns :
void
|
| checkForLockFile | ||||||
checkForLockFile(libraries, options)
|
||||||
|
Parameters :
Returns :
void
|
| checkIfWeHaveAllDependenciesInPackageJson | ||||||||
checkIfWeHaveAllDependenciesInPackageJson(libraries, packageJson, options)
|
||||||||
|
Get external dependencies from imports
Parameters :
Returns :
void
|
| checkRxInternalImports | ||||||
checkRxInternalImports(libraries, options)
|
||||||
|
Check rxjs/internal imports
Parameters :
Returns :
void
|
| checkTsLibDep | ||||||||
checkTsLibDep(libraries, rootPackageJson, options)
|
||||||||
|
Parameters :
Returns :
void
|
| extractExternalDependenciesFromImports | ||||
extractExternalDependenciesFromImports(libraries)
|
||||
|
Extract external dependencies from imports
Parameters :
Returns :
void
|
| filterLocalAbsolutePathFiles | ||||||
filterLocalAbsolutePathFiles(libraries, options)
|
||||||
|
Filer native Node.js APIs
Parameters :
Returns :
void
|
| filterLocalRelativeImports | ||||
filterLocalRelativeImports(libraries)
|
||||
|
Remove these imports from the object as it is no longer useful in processing.
Parameters :
Returns :
void
|
| filterNativeNodeAPIs | ||||||
filterNativeNodeAPIs(libraries, options)
|
||||||
|
Filter native Node.js APIs
Parameters :
Returns :
void
|
| filterOutSpecOnlyDependencies | ||||
filterOutSpecOnlyDependencies(libraries)
|
||||
|
Remove spec external dependencies as we already took care of them.
Parameters :
Returns :
void
|
| getAllImports | ||||||
getAllImports(sourceFile)
|
||||||
|
Get list of all imports (paths)
Parameters :
Returns :
Set<string>
set with import paths |
| manageDependencies | ||||||
manageDependencies(repository, options)
|
||||||
|
Parameters :
|
| readJsonFile | ||||||
readJsonFile(path)
|
||||||
|
Read and parse json file content
Parameters :
Returns :
any
content of the json |
| removeNotUsedDependenciesFromPackageJson | ||||||
removeNotUsedDependenciesFromPackageJson(libraries, options)
|
||||||
|
Remove dependencies that are no longer referenced in the library
Parameters :
Returns :
void
|
| saveJsonFile | ||||||||||||
saveJsonFile(path, content: any)
|
||||||||||||
|
Stringify and safe json file content
Parameters :
Returns :
void
|
| savePackageJsonFiles | ||||
savePackageJsonFiles(libraries)
|
||||
|
Save updated package.json files.
Parameters :
|
| updateDependenciesVersions | ||||||||
updateDependenciesVersions(libraries, rootPackageJson, options)
|
||||||||
|
Update versions in all libraries package json files
Parameters :
Returns :
void
|
| addModuleDeclaration | ||||||||
addModuleDeclaration(sourceFile, insertOptions, createIfMissing)
|
||||||||
|
Parameters :
Returns :
Expression | undefined
|
| addModuleExport | ||||||||
addModuleExport(sourceFile, insertOptions, createIfMissing)
|
||||||||
|
Parameters :
Returns :
Expression | undefined
|
| addModuleImport | ||||||||
addModuleImport(sourceFile, insertOptions, createIfMissing)
|
||||||||
|
Parameters :
Returns :
Expression | undefined
|
| addModuleProvider | ||||||||
addModuleProvider(sourceFile, insertOptions, createIfMissing)
|
||||||||
|
Parameters :
Returns :
Expression | undefined
|
| addToModuleInternal | ||||||||||
addToModuleInternal(sourceFile, propertyName, insertOptions, createIfMissing)
|
||||||||||
|
Parameters :
Returns :
Expression | undefined
|
| ensureModuleExists | ||||
ensureModuleExists(options)
|
||||
|
Parameters :
Returns :
Rule
|
| getModule | ||||
getModule(sourceFile)
|
||||
|
Parameters :
Returns :
CallExpression | undefined
|
| isDuplication | ||||||||
isDuplication(initializer, propertyName, content)
|
||||||||
|
Parameters :
Returns :
boolean
|
| isTypeTokenDuplicate | ||||||
isTypeTokenDuplicate(initializer, typeToken)
|
||||||
|
Parameters :
Returns :
boolean
|
| normalizeTypeToken | ||||
normalizeTypeToken(token)
|
||||
|
Parameters :
Returns :
string
|
| addMutipleProductWithoutVariantToCart |
addMutipleProductWithoutVariantToCart()
|
| addVariantOfSameProductToCart |
addVariantOfSameProductToCart()
|
| configureProductWithVariants |
configureProductWithVariants()
|
| visitProductWithoutVariantPage |
visitProductWithoutVariantPage()
|
| addOrderFeature | ||||
addOrderFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addOrderFeatures | ||||
addOrderFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addPaymentMethod |
addPaymentMethod()
|
| addProductToCart |
addProductToCart()
|
| addShippingAddress |
addShippingAddress()
|
| goToProductPageFromCategory |
goToProductPageFromCategory()
|
| loginSuccessfully |
loginSuccessfully()
|
| selectDeliveryMethod |
selectDeliveryMethod()
|
| selectPaymentMethod |
selectPaymentMethod()
|
| selectShippingAddress |
selectShippingAddress()
|
| verifyAndPlaceOrder |
verifyAndPlaceOrder()
|
| verifyAndPlaceOrderUsing | ||||
verifyAndPlaceOrderUsing(deliveryName)
|
||||
|
Parameters :
|
| verifyAndPlaceOrderWithShipping |
verifyAndPlaceOrderWithShipping()
|
| addPaymentMethod | ||||
addPaymentMethod(paymentDetail)
|
||||
|
Parameters :
|
| verifyPaymentCard | ||||
verifyPaymentCard(cardLength)
|
||||
|
Parameters :
|
| visitPaymentDetailsPage |
visitPaymentDetailsPage()
|
| addProduct | ||||
addProduct(productCode?)
|
||||
|
Parameters :
Returns :
void
|
| checkoutNextStep | ||||
checkoutNextStep(url)
|
||||
|
Parameters :
|
| getFormFieldByValue | ||||
getFormFieldByValue(value)
|
||||
|
Parameters :
|
| login |
login()
|
| register |
register()
|
| registerAndLogin |
registerAndLogin()
|
|
Returns :
void
|
| verifyTabbingOrder | ||||||
verifyTabbingOrder(containerSelector, elements)
|
||||||
|
Parameters :
|
| verifyTabElement | ||||
verifyTabElement(tabElement)
|
||||
|
Parameters :
|
| addProductAsAnonymous |
addProductAsAnonymous()
|
| addProductFromPdp | ||||
addProductFromPdp(productCode)
|
||||
|
Adds product from PDP directly
Parameters :
|
| addProductWhenLoggedIn | ||||||
addProductWhenLoggedIn(mobile: boolean)
|
||||||
|
Parameters :
|
| checkAddedToCartDialog | ||||||
checkAddedToCartDialog(itemsNumber: number)
|
||||||
|
Parameters :
|
| checkBasicCart |
checkBasicCart()
|
| checkCartSummary | ||||
checkCartSummary(subtotal)
|
||||
|
Parameters :
|
| checkMiniCartCount | ||||
checkMiniCartCount(expectedCount)
|
||||
|
Parameters :
|
| checkProductInCart |
checkProductInCart(product, qty: number, currency: string)
|
|
|
| clickAddToCart |
clickAddToCart()
|
| closeAddedToCartDialog |
closeAddedToCartDialog()
|
| getBaseUrlPrefix |
getBaseUrlPrefix()
|
| getCartItem | ||||
getCartItem(name)
|
||||
|
Parameters :
|
| getOccUrlPrefix |
getOccUrlPrefix()
|
| goToCart |
goToCart()
|
| goToFirstProductFromSearch | |||||||||
goToFirstProductFromSearch(id, mobile: boolean)
|
|||||||||
|
Parameters :
|
| incrementQuantity |
incrementQuantity()
|
| loginCartUser |
loginCartUser()
|
| loginRegisteredUser |
loginRegisteredUser()
|
| logOutAndEmptyCart |
logOutAndEmptyCart()
|
| logOutAndNavigateToEmptyCart |
logOutAndNavigateToEmptyCart()
|
| manipulateCartQuantity |
manipulateCartQuantity()
|
| outOfStock |
outOfStock()
|
| registerCartPageRoute |
registerCartPageRoute()
|
| registerCartRefreshRoute |
registerCartRefreshRoute()
|
| registerCartUser |
registerCartUser()
|
| registerCreateCartRoute |
registerCreateCartRoute()
|
| registerDeleteCartItemRoute |
registerDeleteCartItemRoute()
|
| registerSaveCartRoute |
registerSaveCartRoute()
|
| removeAllItemsFromCart |
removeAllItemsFromCart()
|
| removeCartItem | ||||
removeCartItem(product)
|
||||
|
Parameters :
|
| validateEmptyCart |
validateEmptyCart()
|
| verifyCartNotEmpty |
verifyCartNotEmpty()
|
| verifyMergedCartWhenLoggedIn |
verifyMergedCartWhenLoggedIn()
|
| addProductToCart |
addProductToCart()
|
| checkAppliedPromotions |
checkAppliedPromotions()
|
| checkAppliedPromotionsFordifferentCartTotals |
checkAppliedPromotionsFordifferentCartTotals()
|
| checkForAppliedPromotions |
checkForAppliedPromotions()
|
| checkForAppliedPromotionsInCartModal | ||||
checkForAppliedPromotionsInCartModal(productName)
|
||||
|
Parameters :
|
| decreaseQuantityOfCartEntry |
decreaseQuantityOfCartEntry()
|
| goToCartDetailsViewFromCartDialog |
goToCartDetailsViewFromCartDialog()
|
| goToOrderHistoryDetailsFromSummary |
goToOrderHistoryDetailsFromSummary()
|
| removeCartEntry |
removeCartEntry()
|
| selectDeliveryMethod |
selectDeliveryMethod()
|
| selectPaymentMethod |
selectPaymentMethod()
|
| selectShippingAddress |
selectShippingAddress()
|
| addProductToCart | ||||||
addProductToCart(productCode)
|
||||||
|
Navigates to the PDP page to add the product with the given code.
Parameters :
|
| attemptUpload | ||||
attemptUpload(csvPath)
|
||||
|
Attempt to upload a csv by filling out import cart form and clicking "Upload".
Parameters :
|
| convertCsvToArray | ||||
convertCsvToArray(csv)
|
||||
|
Converts a csv into an array interpretable for the
Parameters :
Returns :
Array<string>
|
| exportCart | ||||||
exportCart(expectedData?)
|
||||||
|
Goes to the cart page and clicks the button to export cart.
Parameters :
|
| getCsvHeaders | ||||
getCsvHeaders(csv)
|
||||
|
Gets the header names of columns from a csv string.
Parameters :
Returns :
Array<string>
|
| getSavedDate |
getSavedDate()
|
|
Gets the current date in a format matching the 'Saved Date' column.
Returns :
string
|
| importCartTestFromConfig | ||||
importCartTestFromConfig(config)
|
||||
|
Standardized E2E Test for import cart scenarios.
Parameters :
|
| restoreCart | ||||
restoreCart(cart)
|
||||
|
Restore the imported cart from the saved carts list.
Parameters :
|
| verifyCart | ||||
verifyCart(config)
|
||||
|
Check that the restored cart contains the correct products.
Parameters :
|
| verifyImportedData | ||||||
verifyImportedData(config, cart)
|
||||||
|
Check that the imported cart displays correctly in saved carts list.
Parameters :
|
| addProductToCart | ||||
addProductToCart(product)
|
||||
|
Parameters :
|
| getItem | ||||||
getItem(product, position)
|
||||||
|
Parameters :
|
| moveItem | ||||||||||||
moveItem(product, targetPosition, isAnonymous: boolean)
|
||||||||||||
|
Parameters :
|
| removeItem | ||||||
removeItem(product, position)
|
||||||
|
Parameters :
|
| stubForCartRefresh |
stubForCartRefresh()
|
| stubForCartsRefresh |
stubForCartsRefresh()
|
| validateCart | ||||||
validateCart(qtyInCart, qtyInSavedCart)
|
||||||
|
Parameters :
|
| validateCartPromotion | ||||||
validateCartPromotion(hasPromotion: boolean)
|
||||||
|
Parameters :
|
| validateProduct | ||||||||||||
validateProduct(product, qty: number, position)
|
||||||||||||
|
Parameters :
|
| verifyMiniCartQty | ||||
verifyMiniCartQty(qty)
|
||||
|
Parameters :
|
| addProductToCart | ||||
addProductToCart(product)
|
||||
|
Parameters :
|
| addToWishList | ||||
addToWishList(product)
|
||||
|
Parameters :
|
| addToWishListAnonymous | ||||
addToWishListAnonymous(product)
|
||||
|
Parameters :
|
| addToWishListFromPage |
addToWishListFromPage()
|
| checkoutFromCart | ||||
checkoutFromCart(checkoutProducts)
|
||||
|
Parameters :
|
| checkoutFromWishList | ||||
checkoutFromWishList(checkoutProducts)
|
||||
|
Parameters :
|
| checkWishListPersisted | ||||
checkWishListPersisted(product)
|
||||
|
Parameters :
|
| fillAddressForm | ||||
fillAddressForm(shippingAddressData)
|
||||
|
Parameters :
|
| fillPaymentForm | ||||||
fillPaymentForm(paymentDetailsData, billingAddress?)
|
||||||
|
Parameters :
|
| getCartItem | ||||
getCartItem(name)
|
||||
|
Parameters :
|
| getWishListItem | ||||
getWishListItem(name)
|
||||
|
Parameters :
|
| goToCartAndCheckout | ||||
goToCartAndCheckout(checkoutProducts)
|
||||
|
Parameters :
|
| goToProductPage | ||||
goToProductPage(product)
|
||||
|
Parameters :
|
| loginWishListUser |
loginWishListUser()
|
| placeOrderWithProducts | ||||
placeOrderWithProducts(checkoutProducts)
|
||||
|
Parameters :
|
| proceedToCheckout |
proceedToCheckout()
|
| registerWishListUser |
registerWishListUser()
|
| removeProductFromPdp |
removeProductFromPdp()
|
| removeProductFromWishListPage | ||||
removeProductFromWishListPage(product)
|
||||
|
Parameters :
|
| verifyOrderConfirmationPage | ||||
verifyOrderConfirmationPage(checkoutProducts)
|
||||
|
Parameters :
|
| verifyProductInWishList | ||||
verifyProductInWishList(product)
|
||||
|
Parameters :
|
| verifyProductInWishListPdp |
verifyProductInWishListPdp()
|
| verifyProductNotInWishListPdp |
verifyProductNotInWishListPdp()
|
| waitForGetWishList |
waitForGetWishList()
|
| addProductToCart | ||||||
addProductToCart(product, quantity)
|
||||||
|
Parameters :
|
| clickSavedCartButtonsFromCartPage | ||||
clickSavedCartButtonsFromCartPage(position)
|
||||
|
Parameters :
|
| interceptCloneSavedCartEndpoint | ||||
interceptCloneSavedCartEndpoint(cartCode)
|
||||
|
Parameters :
|
| interceptDeleteCartEndpoint | ||||
interceptDeleteCartEndpoint(cartCode)
|
||||
|
Parameters :
|
| interceptGetAllSavedCartEndpoint |
interceptGetAllSavedCartEndpoint()
|
| interceptGetSavedCartEndpoint | ||||
interceptGetSavedCartEndpoint(cartCode)
|
||||
|
Parameters :
|
| interceptRestoreSavedCartEndpoint | ||||
interceptRestoreSavedCartEndpoint(cartCode)
|
||||
|
Parameters :
|
| interceptSaveCartEndpoint | ||||
interceptSaveCartEndpoint(cartCode)
|
||||
|
Parameters :
|
| loginB2bUser |
loginB2bUser()
|
| restoreCart | |||||||||||||||
restoreCart(product, savedCartForm: any, isEmptyCart: boolean, cloneSavedCart)
|
|||||||||||||||
|
Parameters :
|
| saveActiveCart |
saveActiveCart()
|
| updateSavedCartAndDelete |
updateSavedCartAndDelete(product, savedCartForm: any, deleteEntry: boolean)
|
|
|
| updateSavedCartAndRestore | |||||||||
updateSavedCartAndRestore(product, savedCartForm: any)
|
|||||||||
|
Parameters :
|
| verifyActiveCartWasSaved | ||||
verifyActiveCartWasSaved(cartCode)
|
||||
|
Parameters :
|
| verifyCartDetails | ||||||
verifyCartDetails(cart: any)
|
||||||
|
Parameters :
|
| verifyCartPageTabbingOrder |
verifyCartPageTabbingOrder()
|
| verifyDetailsTabbingOrder |
verifyDetailsTabbingOrder()
|
| verifyListingTabbingOrder |
verifyListingTabbingOrder()
|
| verifyMiniCartQuantity | ||||
verifyMiniCartQuantity(quantity)
|
||||
|
Parameters :
|
| verifyModalTabbingOrder |
verifyModalTabbingOrder()
|
| visitCartPage |
visitCartPage()
|
| visitSavedCartDetailsPage | ||||
visitSavedCartDetailsPage(cartCode)
|
||||
|
Parameters :
|
| visitSavedCartListingPage |
visitSavedCartListingPage()
|
| waitForCartPageData | ||||
waitForCartPageData(product)
|
||||
|
Parameters :
|
| waitForSavedCartDetailsPageData | ||||
waitForSavedCartDetailsPageData(product)
|
||||
|
Parameters :
|
| waitForSavedCartListingPageData | ||||
waitForSavedCartListingPageData(product)
|
||||
|
Parameters :
|
| addProductToCart | ||||
addProductToCart(productCode)
|
||||
|
Parameters :
|
| applyCoupon | ||||
applyCoupon(couponCode)
|
||||
|
Parameters :
|
| applyMyCouponAsAnonymous |
applyMyCouponAsAnonymous()
|
| ApplyMyCoupons | |||||||||
ApplyMyCoupons(couponCode, checkOrderPromotion: boolean)
|
|||||||||
|
Parameters :
|
| applyWrongCoupon |
applyWrongCoupon()
|
| claimCoupon | ||||
claimCoupon(couponCode)
|
||||
|
Parameters :
|
| getCouponItemFromCart | ||||
getCouponItemFromCart(couponCode)
|
||||
|
Parameters :
|
| getCouponItemOrderSummary | ||||
getCouponItemOrderSummary(couponCode)
|
||||
|
Parameters :
|
| navigateToCartPage |
navigateToCartPage()
|
| navigateToCheckoutPage |
navigateToCheckoutPage()
|
| navigateToOrderHistoryPage | |||||||||
navigateToOrderHistoryPage(orderData: any, couponCode)
|
|||||||||
|
Parameters :
|
| placeOrder | ||||||
placeOrder(token: any)
|
||||||
|
Parameters :
|
| registerCartRefreshRoute |
registerCartRefreshRoute()
|
| registerOrderDetailsRoute | ||||
registerOrderDetailsRoute(orderCode)
|
||||
|
Parameters :
|
| registerProductDetailsRoute | ||||
registerProductDetailsRoute(productCode)
|
||||
|
Parameters :
|
| removeCoupon | ||||
removeCoupon(couponCode)
|
||||
|
Parameters :
|
| verifyCouponAndPromotion | ||||||||
verifyCouponAndPromotion(couponCode, totalPrice, savedPrice)
|
||||||||
|
Parameters :
|
| verifyCouponAndSavedPrice | ||||||
verifyCouponAndSavedPrice(couponCode, savedPrice)
|
||||||
|
Parameters :
|
| verifyCouponAndSavedPriceInOrder | ||||||
verifyCouponAndSavedPriceInOrder(couponCode, savedPrice)
|
||||||
|
Parameters :
|
| verifyCouponInOrderHistory | ||||||||
verifyCouponInOrderHistory(couponCode, totalPrice, savedPrice)
|
||||||||
|
Parameters :
|
| verifyCustomerCouponRemoving |
verifyCustomerCouponRemoving()
|
| verifyGiftProductCoupon | ||||
verifyGiftProductCoupon(productCode)
|
||||
|
Parameters :
|
| verifyMyCoupons |
verifyMyCoupons()
|
| verifyNoCouponInOrderHistory |
verifyNoCouponInOrderHistory()
|
| verifyOrderHistory | |||||||||
verifyOrderHistory(orderData: any, couponCode?)
|
|||||||||
|
Parameters :
|
| verifyOrderHistoryForCouponAndPrice | ||||||||||||
verifyOrderHistoryForCouponAndPrice(orderData: any, couponCode?, savedPrice?)
|
||||||||||||
|
Parameters :
|
| verifyOrderPlacingWithCouponAndCustomerCoupon |
verifyOrderPlacingWithCouponAndCustomerCoupon()
|
| verifyProductInCart | ||||
verifyProductInCart(productCode)
|
||||
|
Parameters :
|
| visitProductPage | ||||
visitProductPage(productCode)
|
||||
|
Parameters :
|
| addPWA | ||||
addPWA(options)
|
||||
|
Parameters :
Returns :
Rule
|
| removeServiceWorkerSetup | ||||||
removeServiceWorkerSetup(host, modulePath)
|
||||||
|
Parameters :
|
| updateAppModule | ||||||
updateAppModule(options: any)
|
||||||
|
Parameters :
Returns :
Rule
|
| addQualtricsFeature | ||||
addQualtricsFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addQualtricsFeatures | ||||
addQualtricsFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addressBookNextStep |
addressBookNextStep()
|
| assertSiteContextChange | ||||
assertSiteContextChange(testPath)
|
||||
|
Parameters :
Returns :
void
|
| deliveryModeNextStep |
deliveryModeNextStep()
|
| doPlaceOrder |
doPlaceOrder()
|
| paymentDetailsNextStep |
paymentDetailsNextStep()
|
| siteContextChange | ||||||||||
siteContextChange(pagePath, alias, selectedOption, label)
|
||||||||||
|
Parameters :
Returns :
void
|
| stub | ||||||
stub(request, alias)
|
||||||
|
Parameters :
Returns :
void
|
| verifySiteContextChangeUrl | ||||||||||||
verifySiteContextChangeUrl(pagePath, alias, selectedOption, label, testPath)
|
||||||||||||
|
Parameters :
Returns :
void
|
| addSetupPackageJsonDependencies | ||||||
addSetupPackageJsonDependencies(packageJson: any)
|
||||||
|
Parameters :
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| updateImport |
updateImport()
|
|
Returns :
Rule
|
| addSmartEditFeature | ||||
addSmartEditFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addSmartEditFeatures | ||||
addSmartEditFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacus | ||||
addSpartacus(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusFeatures | ||||
addSpartacusFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| increaseBudgets |
increaseBudgets()
|
|
Returns :
Rule
|
| installStyles | ||||
installStyles(options)
|
||||
|
Parameters :
Returns :
Rule
|
| prepareDependencies |
prepareDependencies()
|
|
Returns :
NodeDependency[]
|
| updateAppModule | ||||
updateAppModule(project)
|
||||
|
Parameters :
Returns :
Rule
|
| updateIndexFile | ||||||
updateIndexFile(tree, options)
|
||||||
|
Parameters :
Returns :
Rule
|
| updateMainComponent | ||||||
updateMainComponent(project, options)
|
||||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSpartacusLibrary | ||||
addSpartacusLibrary(taskOptions)
|
||||
|
Parameters :
Returns :
Rule
|
| addSSR | ||||
addSSR(options)
|
||||
|
Parameters :
Returns :
Rule
|
| modifyAppModuleFile |
modifyAppModuleFile()
|
|
Returns :
Rule
|
| modifyAppServerModuleFile |
modifyAppServerModuleFile()
|
|
Returns :
Rule
|
| modifyIndexHtmlFile | ||||
modifyIndexHtmlFile(options)
|
||||
|
Parameters :
Returns :
Rule
|
| prepareDependencies |
prepareDependencies()
|
|
Returns :
NodeDependency[]
|
| provideServerFile | ||||
provideServerFile(options)
|
||||
|
Parameters :
Returns :
Source
|
| addStorefinderFeature | ||||
addStorefinderFeature(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addStorefinderFeatures | ||||
addStorefinderFeatures(options)
|
||||
|
Parameters :
Returns :
Rule
|
| addStorefinderPackageJsonDependencies | ||||||
addStorefinderPackageJsonDependencies(packageJson: any)
|
||||||
|
Parameters :
Returns :
Rule
|
| isStorefinderPresent | ||||||||||||
isStorefinderPresent(tree, packageJson: any, appModulePath)
|
||||||||||||
|
Parameters :
Returns :
Promise<boolean>
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| removeOldSetup | ||||
removeOldSetup(appModulePath)
|
||||
|
Parameters :
Returns :
Rule
|
| addToCart | ||||||||||
addToCart(cartCode, productCode, quantity, accessToken)
|
||||||||||
|
Parameters :
|
| createCart | ||||
createCart(accessToken)
|
||||
|
Parameters :
|
| addToCartAndVerify | |||||||||
addToCartAndVerify(shopName, productId)
|
|||||||||
|
Add a product to the cart. Verifies whether the cart is not empty and contains the product.
Parameters :
Returns :
void
|
| checkAttributeDisplayed | ||||||
checkAttributeDisplayed(attributeName)
|
||||||
|
Verifies whether the attribute is displayed.
Parameters :
Returns :
void
|
| checkConfigurationPageIsDisplayed |
checkConfigurationPageIsDisplayed()
|
|
Verifies whether the configuration page is visible.
Returns :
void
|
| checkTextfieldProductInCart | ||||||
checkTextfieldProductInCart(productId)
|
||||||
|
Verifies whether the cart contains the product.
Parameters :
Returns :
void
|
| clickAddToCartButton | ||||||
clickAddToCartButton(shopName)
|
||||||
|
Clicks 'Add to Cart' button.
Parameters :
Returns :
void
|
| clickOnAddToCartBtnOnPD |
clickOnAddToCartBtnOnPD()
|
|
Clicks 'Add to Cart' button on the product details page.
Returns :
void
|
| clickOnConfigureButton |
clickOnConfigureButton()
|
|
Clicks on 'Configure' button.
Returns :
void
|
| clickOnEditConfigurationLink | ||||||
clickOnEditConfigurationLink(cartItemIndex)
|
||||||
|
Clicks on the 'Edit Configuration' link in cart for a certain cart item.
Parameters :
Returns :
void
|
| clickOnViewCartBtnOnPD |
clickOnViewCartBtnOnPD()
|
|
Clicks on 'View Cart' on the product details page.
Returns :
void
|
| getAttributeId | ||||||
getAttributeId(attributeName)
|
||||||
|
Retrieves attribute ID.
Parameters :
Returns :
string
|
| goToConfigurationPage | |||||||||
goToConfigurationPage(shopName, productId)
|
|||||||||
|
Navigates to the product configuration page.
Parameters :
Returns :
Chainable<Window>
|
| goToProductDetailsPage | |||||||||
goToProductDetailsPage(shopName, productId)
|
|||||||||
|
Navigates to the product configuration page.
Parameters :
Returns :
Chainable<Window>
|
| selectAttribute | |||||||||
selectAttribute(attributeName, value?)
|
|||||||||
|
Selects value of the corresponding attribute.
Parameters :
Returns :
void
|
| addToCartTabbingOrder | ||||
addToCartTabbingOrder(config)
|
||||
|
Parameters :
|
| anonoymousConsentConfig | |||||||||||||||
anonoymousConsentConfig(registerConsent, showLegalDescriptionInDialog: boolean, requiredConsents, consentManagementPage)
|
|||||||||||||||
|
Parameters :
|
| anonymousConfigTestFlow |
anonymousConfigTestFlow()
|
| changeLanguageTest |
changeLanguageTest()
|
| checkAllInputConsentState | ||||
checkAllInputConsentState(state)
|
||||
|
Parameters :
|
| checkBannerHidden |
checkBannerHidden()
|
| checkConsentNotExist | ||||
checkConsentNotExist(text)
|
||||
|
Parameters :
|
| checkConsentsInConsentPage |
checkConsentsInConsentPage()
|
| checkDialogClosed |
checkDialogClosed()
|
| checkDialogDescription |
checkDialogDescription()
|
| checkDialogOpen |
checkDialogOpen()
|
| checkInputConsentState | ||||||
checkInputConsentState(position, state)
|
||||||
|
Parameters :
|
| clearAllConsent |
clearAllConsent()
|
| clickAllowAllFromBanner |
clickAllowAllFromBanner()
|
| clickViewDetailsFromBanner |
clickViewDetailsFromBanner()
|
| closeAnonymousConsentsDialog |
closeAnonymousConsentsDialog()
|
| giveRegistrationConsentTest |
giveRegistrationConsentTest()
|
| loggedInUserBannerTest |
loggedInUserBannerTest()
|
| loggedInUserFooterLinkTest |
loggedInUserFooterLinkTest()
|
| movingFromAnonymousToRegisteredUser |
movingFromAnonymousToRegisteredUser()
|
| navigateToConsentPage |
navigateToConsentPage()
|
| openAnonymousConsentsDialog |
openAnonymousConsentsDialog()
|
| registerNewUserAndLogin | ||||||||
registerNewUserAndLogin(newUser, giveRegistrationConsent, hiddenConsent?)
|
||||||||
|
Parameters :
|
| registerUserAndCheckMyAccountConsent | ||||||||||
registerUserAndCheckMyAccountConsent(user, consentCheckBox, position, hiddenConsent?)
|
||||||||||
|
Parameters :
|
| seeBannerAsAnonymous |
seeBannerAsAnonymous()
|
| selectAllConsent |
selectAllConsent()
|
| sessionLogin |
sessionLogin()
|
| showAnonymousConfigTest |
showAnonymousConfigTest()
|
| testAsAnonymousUser |
testAsAnonymousUser()
|
| testAsLoggedInUser |
testAsLoggedInUser()
|
| toggleAnonymousConsent | ||||
toggleAnonymousConsent(position)
|
||||
|
Parameters :
|
| anonymousConsentsStatePersistenceFactory | ||||
anonymousConsentsStatePersistenceFactory(anonymousConsentsStatePersistenceService)
|
||||
|
Parameters :
Returns :
void
|
| appendHtmlElementToHead | ||||||||
appendHtmlElementToHead(host, htmlFilePath, elementHtml)
|
||||||||
|
Parameters :
|
| getChildElementIndentation | ||||
getChildElementIndentation(element)
|
||||
|
Parameters :
|
| getElementByTagName | ||||||
getElementByTagName(tagName, htmlContent)
|
||||||
|
Finds an element by its tag name.
Parameters :
Returns :
DefaultTreeElement | null
|
| getHtmlHeadTagElement | ||||
getHtmlHeadTagElement(htmlContent)
|
||||
|
Parses the given HTML file and returns the head element if available.
Parameters :
Returns :
DefaultTreeElement | null
|
| applyFacet | ||||||
applyFacet(facetGroup, facetName)
|
||||||
|
Parameters :
Returns :
void
|
| clickOnCarouselItem | |||||||||
clickOnCarouselItem(productId, checkForCarouselEvent?: boolean)
|
|||||||||
|
Parameters :
Returns :
void
|
| navigateToCategory | ||||
navigateToCategory(categoryName)
|
||||
|
Parameters :
Returns :
void
|
| navigateToHomepage |
navigateToHomepage()
|
|
Returns :
void
|
| verifyCarouselClickEvent | |||||||||
verifyCarouselClickEvent(productSku, carouselEvent: any)
|
|||||||||
|
Parameters :
|
| verifyCarouselEvent | ||||||
verifyCarouselEvent(carouselEvent: any)
|
||||||
|
Parameters :
|
| verifyCarouselItemRendered | ||||||
verifyCarouselItemRendered($carouselItem, index)
|
||||||
|
Parameters :
Returns :
void
|
| verifyCarouselItemsRendered | ||||
verifyCarouselItemsRendered($merchandisingCarousel)
|
||||
|
Parameters :
Returns :
void
|
| verifyCarouselLevelMetadata | ||||
verifyCarouselLevelMetadata($merchandisingCarousel)
|
||||
|
Parameters :
Returns :
void
|
| verifyCarouselViewEvent | ||||||
verifyCarouselViewEvent(carouselEvent: any)
|
||||||
|
Parameters :
|
| verifyFirstCarouselItemPrice | ||||
verifyFirstCarouselItemPrice(currencySymbol)
|
||||
|
Parameters :
Returns :
void
|
| verifyFirstCarouselItemTextContent | ||||||
verifyFirstCarouselItemTextContent(toContain, toNotContain)
|
||||||
|
Parameters :
Returns :
void
|
| verifyMerchandisingCarouselRendersOnBrandPage | ||||||||||
verifyMerchandisingCarouselRendersOnBrandPage(strategyRequestAlias, brandCode, language?, additionalFacets?)
|
||||||||||
|
Parameters :
Returns :
void
|
| verifyMerchandisingCarouselRendersOnCategoryPage | ||||||||||||||||||
verifyMerchandisingCarouselRendersOnCategoryPage(strategyRequestAlias, categoryCode, language?, additionalFacets?, containsConsentReference?: boolean)
|
||||||||||||||||||
|
Parameters :
Returns :
void
|
| verifyMerchandisingCarouselRendersOnHomePage | ||||||||||||
verifyMerchandisingCarouselRendersOnHomePage(strategyRequestAlias, language?, containsConsentReference?: boolean)
|
||||||||||||
|
Parameters :
Returns :
void
|
| verifyMerchandisingCarouselRendersOnPDPPage | ||||||||
verifyMerchandisingCarouselRendersOnPDPPage(strategyRequestAlias, productId, language?)
|
||||||||
|
Parameters :
Returns :
void
|
| verifyMerchandisingCarouselRendersProducts |
verifyMerchandisingCarouselRendersProducts()
|
|
Returns :
void
|
| verifyRequestToStrategyService | ||||||
verifyRequestToStrategyService(requestAlias, strategyRequestContext)
|
||||||
|
Parameters :
Returns :
void
|
| waitForCarouselViewEvent |
waitForCarouselViewEvent()
|
|
Returns :
void
|
| asmFactory | ||||
asmFactory(asmEnablerService)
|
||||
|
We do not like to block the UI, which is why we delgate loading of ASM to a real component; the router and state aren't available in an optimized way during the APP_INITIALIZER.
Parameters :
Returns :
void
|
| asmStatePersistenceFactory | ||||
asmStatePersistenceFactory(asmStatePersistenceService)
|
||||
|
Parameters :
Returns :
void
|
| asmTabbingOrderNoSelectedUser | ||||
asmTabbingOrderNoSelectedUser(config)
|
||||
|
Parameters :
|
| asmTabbingOrderNotLoggedIn | ||||
asmTabbingOrderNotLoggedIn(config)
|
||||
|
Parameters :
|
| asmTabbingOrderWithSelectedUser | ||||
asmTabbingOrderWithSelectedUser(config)
|
||||
|
Parameters :
|
| assertDefaultNumberOfProducts | ||||
assertDefaultNumberOfProducts(view)
|
||||
|
Parameters :
|
| backtoTopIsNotVisible |
backtoTopIsNotVisible()
|
| backToTopIsVisible | ||||||
backToTopIsVisible(isShowMoreButton?: boolean)
|
||||||
|
Parameters :
|
| configScroll |
configScroll(active: boolean, productLimit, showMoreButton: boolean)
|
|
|
| isPaginationNotVisible |
isPaginationNotVisible()
|
| isPaginationVisible |
isPaginationVisible()
|
| scrollToFooter | ||||||||||||
scrollToFooter(totalResults, isShowMoreButton?: boolean, productLimit?)
|
||||||||||||
|
Parameters :
|
| verifyFilterResetsList |
verifyFilterResetsList()
|
| verifyGridResetsList |
verifyGridResetsList()
|
| verifyNumberOfProducts | ||||
verifyNumberOfProducts(numberOfProducts)
|
||||
|
Parameters :
|
| verifySortingResetsList |
verifySortingResetsList()
|
| assertFirstProduct |
assertFirstProduct()
|
| assertNumberOfProducts | ||||||
assertNumberOfProducts(alias, category)
|
||||||
|
Parameters :
|
| checkDistinctProductName | ||||
checkDistinctProductName(firstProduct)
|
||||
|
Parameters :
|
| checkFirstItem | ||||
checkFirstItem(productName)
|
||||
|
Parameters :
Returns :
void
|
| choosePage | ||||
choosePage(pageNumber)
|
||||
|
Parameters :
Returns :
void
|
| clearActiveFacet |
clearActiveFacet()
|
| clearSelectedFacet |
clearSelectedFacet()
|
| clickFacet | ||||
clickFacet(header)
|
||||
|
Parameters :
|
| clickSearchIcon |
clickSearchIcon()
|
| createProductFacetQuery | ||||||||
createProductFacetQuery(param, search, alias)
|
||||||||
|
Parameters :
Returns :
void
|
| createProductQuery | ||||||||||
createProductQuery(alias, queryId, pageSize, currentPage)
|
||||||||||
|
Parameters :
Returns :
void
|
| createProductSortQuery | ||||||
createProductSortQuery(sort, alias)
|
||||||
|
Parameters :
Returns :
void
|
| enterProduct |
enterProduct()
|
| filterUsingFacetFiltering |
filterUsingFacetFiltering()
|
| nextPage |
nextPage()
|
|
Returns :
void
|
| previousPage |
previousPage()
|
|
Returns :
void
|
| searchForProduct | ||||
searchForProduct(product)
|
||||
|
Parameters :
|
| searchResult |
searchResult()
|
| sortByHighestPrice |
sortByHighestPrice()
|
| sortByLowestPrice |
sortByLowestPrice()
|
| sortByNameAscending |
sortByNameAscending()
|
| sortByNameDescending |
sortByNameDescending()
|
| sortByRelevance |
sortByRelevance()
|
| sortByTopRated |
sortByTopRated()
|
| verifyChoosePage | ||||
verifyChoosePage(pageNumber)
|
||||
|
Parameters :
Returns :
void
|
| verifyNextPage | ||||
verifyNextPage(pageNumber)
|
||||
|
Parameters :
Returns :
void
|
| verifyPreviousPage | ||||
verifyPreviousPage(pageNumber)
|
||||
|
Parameters :
Returns :
void
|
| verifyProductSearch | ||||||||
verifyProductSearch(productAlias, sortingAlias, sortBy)
|
||||||||
|
Parameters :
Returns :
void
|
| viewMode |
viewMode()
|
| assertInventoryDisplay | ||||||||
assertInventoryDisplay(productCode, alias, functionality)
|
||||||||
|
Parameters :
|
| configureInventoryDisplay | ||||||
configureInventoryDisplay(enable: boolean)
|
||||||
|
Parameters :
|
| interceptProductDetails | ||||
interceptProductDetails(productCode)
|
||||
|
Parameters :
|
| runInventoryDisplayE2E | |||||||||
runInventoryDisplayE2E(business, sampleData: any)
|
|||||||||
|
Parameters :
|
| testInventoryDisplay | ||||||
testInventoryDisplay(productCode, functionality)
|
||||||
|
Parameters :
|
| assignmentsTest | ||||
assignmentsTest(config)
|
||||
|
Parameters :
|
| augmentableTypesPostStep | ||||||
augmentableTypesPostStep(context, options)
|
||||||
|
Post build step
Parameters :
Returns :
Promise<BuilderOutput>
|
| augmentedTypesBuilder | ||||||
augmentedTypesBuilder(options, context)
|
||||||
|
Builder that runs default ng-packagr builder ('@angular-devkit/build-angular:ng-packagr') and performs additional post step to move augmentable types to root d.ts file. It's a workaround to make TS types augmentable, reference issues:
Parameters :
Returns :
Observable<BuilderOutput>
|
| getNgPackgrLibOutputPath | ||||
getNgPackgrLibOutputPath(ngPackagerFile)
|
||||
|
Get output directory for ng packager job
Parameters :
|
| ngPackagrBuild | ||||||
ngPackagrBuild(context, options)
|
||||||
|
Run ng packager build step as is
Parameters :
Returns :
Promise<BuilderOutput>
|
| propagateAugmentableTypes | ||||||
propagateAugmentableTypes(libPath, logger)
|
||||||
|
Propagate augmentable types for every package.json file in the built in library
Parameters :
|
| authStatePersistenceFactory | ||||
authStatePersistenceFactory(authStatePersistenceService)
|
||||
|
Parameters :
|
| checkOAuthParamsInUrl | ||||||
checkOAuthParamsInUrl(authService, configInit)
|
||||||
|
Initialize the check for
Parameters :
Returns :
Promise<void>
|
| b2bUserApproverListReducer | ||||||
b2bUserApproverListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| b2bUserEntitiesReducer | ||||||
b2bUserEntitiesReducer(state, action)
|
||||||
|
Parameters :
Returns :
B2BUser
|
| b2bUserPermissionListReducer | ||||||
b2bUserPermissionListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| b2bUserUserGroupListReducer | ||||||
b2bUserUserGroupListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| userListReducer | ||||||
userListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| baseSiteConfigValidator | ||||
baseSiteConfigValidator(config)
|
||||
|
Parameters :
|
| baseUrlConfigValidator | ||||
baseUrlConfigValidator(config)
|
||||
|
Parameters :
|
| beforeExit |
beforeExit()
|
|
Returns :
void
|
| buildLibs |
buildLibs()
|
|
Returns :
void
|
| buildSchematics | ||||
buildSchematics(options)
|
||||
|
Parameters :
Returns :
void
|
| buildSchematicsAndPublish | ||||
buildSchematicsAndPublish(buildCmd)
|
||||
|
Parameters :
Returns :
void
|
| executeCommand | ||||
executeCommand(command)
|
||||
|
Parameters :
Returns :
Promise<void>
|
| program |
program()
|
|
Returns :
Promise<void>
|
| publishLibs | ||||
publishLibs(reload)
|
||||
|
Parameters :
Returns :
void
|
| startVerdaccio |
startVerdaccio()
|
|
Returns :
ChildProcess
|
| testAllSchematics |
testAllSchematics()
|
|
Returns :
void
|
| benchmark |
benchmark()
|
|
Utility function to benchmark a test suite using events emmitted by the Cypress test runner To benchmark your test, just import and call this function before the test suite runs. |
| budgetsEntitiesReducer | ||||||
budgetsEntitiesReducer(state, action)
|
||||||
|
Parameters :
Returns :
Budget
|
| budgetsListReducer | ||||||
budgetsListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| budgetTableConfigFactory |
budgetTableConfigFactory()
|
|
Returns :
TableConfig
|
| bufferDebounceTime | ||||||
bufferDebounceTime(time, scheduler?)
|
||||||
|
Parameters :
Returns :
OperatorFunction<T, T[]>
|
| buildCmsStructure | |||
buildCmsStructure(undefined)
|
|||
|
Parameters :
Returns :
CmsStructureConfig
|
| buildLayoutConfig | |||
buildLayoutConfig(undefined)
|
|||
|
Parameters :
Returns :
LayoutConfig
|
| provideCmsStructure | ||||
provideCmsStructure(options)
|
||||
|
Helper function to simplify the creation of static CMS structure ( ```ts
Parameters :
Returns :
ValueProvider
|
| buildComment | ||||
buildComment(content)
|
||||
|
Parameters :
Returns :
string
|
| removedPublicApiDeprecation | ||||||||
removedPublicApiDeprecation(tree, context, removedNodes)
|
||||||||
|
Parameters :
Returns :
Tree
|
| buildDefaultPath | ||||||
buildDefaultPath(project)
|
||||||
|
Build a default project path for generating.
Parameters :
Returns :
string
|
| getAngularJsonFile | ||||||
getAngularJsonFile(tree, possibleProjectFiles)
|
||||||
|
Parameters :
Returns :
WorkspaceSchema
|
| getDefaultProjectNameFromWorkspace | ||||
getDefaultProjectNameFromWorkspace(tree)
|
||||
|
Parameters :
Returns :
string
|
| getProject | ||||||
getProject(workspaceOrHost, projectName)
|
||||||
|
Parameters :
Returns :
WorkspaceProject<TProjectType>
|
| getProjectFromWorkspace | ||||||||
getProjectFromWorkspace(tree, options, files)
|
||||||||
|
Parameters :
Returns :
WorkspaceProject<TProjectType>
|
| getProjectTargets | ||||
getProjectTargets(project)
|
||||
|
Parameters :
Returns :
WorkspaceTargets
|
| getProjectTargets | ||||||
getProjectTargets(workspaceOrHost, projectName)
|
||||||
|
Parameters :
Returns :
WorkspaceTargets
|
| getProjectTargets | |||||||||
getProjectTargets(projectOrHost, projectName: string)
|
|||||||||
|
Parameters :
Returns :
WorkspaceTargets
|
| getSourceRoot | ||||||
getSourceRoot(host, options)
|
||||||
|
Parameters :
Returns :
string
|
| getWorkspace | ||||||
getWorkspace(host, files)
|
||||||
|
Parameters :
Returns :
literal type
|
| isWorkspaceProject | ||||||
isWorkspaceProject(project: any)
|
||||||
|
Parameters :
Returns :
WorkspaceProject
|
| isWorkspaceSchema | ||||||
isWorkspaceSchema(workspace: any)
|
||||||
|
Parameters :
Returns :
WorkspaceSchema
|
| scaffoldStructure | ||||
scaffoldStructure(options)
|
||||
|
Parameters :
Returns :
Rule
|
| validateSpartacusInstallation | ||||||
validateSpartacusInstallation(packageJson: any)
|
||||||
|
Parameters :
Returns :
void
|
| buildMethodComment | ||||||
buildMethodComment(oldApiMethod, newApiMethod?)
|
||||||
|
Parameters :
Returns :
string
|
| migrateMethodPropertiesDeprecation | ||||||||
migrateMethodPropertiesDeprecation(tree, _context, methodProperties)
|
||||||||
|
Parameters :
Returns :
Tree
|
| cancellationButtons | ||||
cancellationButtons(numberOfButton)
|
||||
|
Parameters :
|
| cancelReplenishmentDetails |
cancelReplenishmentDetails()
|
| clickReplenishmentDetails | ||||
clickReplenishmentDetails(replenishmentOrderCode)
|
||||
|
Parameters :
|
| createReplenishmentDetailsRequestRoute | ||||||||
createReplenishmentDetailsRequestRoute(requestMethod, replenishmentOrderCode, alias)
|
||||||||
|
Parameters :
|
| verifyOrderOverviewIsCancelled |
verifyOrderOverviewIsCancelled()
|
| verifyOrderOverviewIsNotCancelled |
verifyOrderOverviewIsNotCancelled()
|
| verifyReplenishmentIsCancelled | ||||
verifyReplenishmentIsCancelled(replenishmentOrderCode)
|
||||
|
Parameters :
|
| cancelReplenishmentInHistory |
cancelReplenishmentInHistory()
|
| createReplenishmentRequestRoute | ||||
createReplenishmentRequestRoute(requestMethod)
|
||||
|
Parameters :
|
| verifyFirstRowReplenishmentIsCancelled |
verifyFirstRowReplenishmentIsCancelled()
|
| verifyFirstRowReplenishmentIsNotCancelled |
verifyFirstRowReplenishmentIsNotCancelled()
|
| verifySorting |
verifySorting()
|
| visitReplenishmentHistory |
visitReplenishmentHistory()
|
| waitForReplenishmentOrders |
waitForReplenishmentOrders()
|
| cancelReturnRequest |
cancelReturnRequest()
|
| confirmCancelOrder |
confirmCancelOrder()
|
| confirmReturnOrder |
confirmReturnOrder()
|
| getStubbedCancellableOrderDetails |
getStubbedCancellableOrderDetails()
|
| getStubbedReturnableOrderDetails |
getStubbedReturnableOrderDetails()
|
| getStubbedReturnRequestDetails |
getStubbedReturnRequestDetails()
|
| getStubbedReturnRequestDetailsAfterCancel |
getStubbedReturnRequestDetailsAfterCancel()
|
| getStubbedReturnRequestList |
getStubbedReturnRequestList()
|
| getStubbedReturnRequestListAfterCancel |
getStubbedReturnRequestListAfterCancel()
|
| visitCancelOrderPage |
visitCancelOrderPage()
|
| visitOrderDetailPage |
visitOrderDetailPage()
|
| visitReturnOrderPage |
visitReturnOrderPage()
|
| visitReturnRequestDetailsPage |
visitReturnRequestDetailsPage()
|
| visitReturnRequestListPage |
visitReturnRequestListPage()
|
| capitalize | ||||
capitalize(str)
|
||||
|
Parameters :
|
| viewportContext | |||||||||
viewportContext(viewportList, callback)
|
|||||||||
|
Runs the same tests against all the provided viewports
Parameters :
|
| cartStatePersistenceFactory | ||||||
cartStatePersistenceFactory(cartStatePersistenceService, configInit)
|
||||||
|
Parameters :
Returns :
Promise<Config>
|
| uninitializeActiveCartMetaReducerFactory |
uninitializeActiveCartMetaReducerFactory()
|
|
Before
Returns :
MetaReducer<any>
|
| cdcJsFactory | ||||||
cdcJsFactory(cdcJsService, configInit)
|
||||||
|
Parameters :
Returns :
Promise<Config>
|
| defaultCdcComponentsConfig |
defaultCdcComponentsConfig()
|
|
Returns :
CmsConfig
|
| cdsConfigValidator | ||||
cdsConfigValidator(config)
|
||||
|
Parameters :
Returns :
string | void
|
| changePasswordTabbingOrder | ||||
changePasswordTabbingOrder(config)
|
||||
|
Parameters :
|
| checkAddToCartBtnDisplayed |
checkAddToCartBtnDisplayed()
|
|
Verifies whether the 'add to cart' button is displayed.
Returns :
void
|
| checkAttributeDisplayed | |||||||||
checkAttributeDisplayed(attributeName, uiType)
|
|||||||||
|
Verifies whether the attribute is displayed.
Parameters :
Returns :
void
|
| checkAttributeNotDisplayed | |||||||||
checkAttributeNotDisplayed(attributeName, uiType)
|
|||||||||
|
Verifies whether the attribute is not displayed.
Parameters :
Returns :
void
|
| checkAttrValueDisplayed | ||||||||||||
checkAttrValueDisplayed(attributeName, uiType, valueName)
|
||||||||||||
|
Verifies whether the attribute value is displayed.
Parameters :
Returns :
void
|
| checkAttrValueNotDisplayed | ||||||||||||
checkAttrValueNotDisplayed(attributeName, uiType, valueName)
|
||||||||||||
|
Verifies whether the attribute value is not displayed.
Parameters :
Returns :
void
|
| checkCurrentGroupActive | ||||||
checkCurrentGroupActive(currentGroup)
|
||||||
|
Verifies whether the current group is active.
Parameters :
Returns :
void
|
| checkFocus | ||||||||||||
checkFocus(attributeName, uiType, valueName)
|
||||||||||||
|
Verifies whether the corresponding value ID is focused.
Parameters :
Returns :
void
|
| checkGroupFormDisplayed |
checkGroupFormDisplayed()
|
|
Verifies whether the group form is displayed.
Returns :
void
|
| checkGroupMenuDisplayed |
checkGroupMenuDisplayed()
|
|
Verifies whether the group menu is displayed.
Returns :
void
|
| checkGroupTitleDisplayed |
checkGroupTitleDisplayed()
|
|
Verifies whether the group title is displayed.
Returns :
void
|
| checkHamburgerDisplayed |
checkHamburgerDisplayed()
|
|
Verifies whether the group menu is displayed.
Returns :
void
|
| checkNextBtnDisabled |
checkNextBtnDisabled()
|
|
Verifies whether the 'next' button is disabled.
Returns :
void
|
| checkNextBtnEnabled |
checkNextBtnEnabled()
|
|
Verifies whether the 'next' button is enabled.
Returns :
void
|
| checkPreviousAndNextBtnsDispalyed |
checkPreviousAndNextBtnsDispalyed()
|
|
Verifies whether the 'previous' and 'next' buttons are displayed.
Returns :
void
|
| checkPreviousBtnDisabled |
checkPreviousBtnDisabled()
|
|
Verifies whether the 'previous' button is disabled.
Returns :
void
|
| checkPreviousBtnEnabled |
checkPreviousBtnEnabled()
|
|
Verifies whether the 'previous' button is enabled.
Returns :
void
|
| checkPriceSummaryDisplayed |
checkPriceSummaryDisplayed()
|
|
Verifies whether the price summary is displayed.
Returns :
void
|
| checkShowMoreLinkAtProductTitleDisplayed |
checkShowMoreLinkAtProductTitleDisplayed()
|
|
Verifies whether 'show more' button is displayed in the product title component.
Returns :
void
|
| checkTabBarDisplayed |
checkTabBarDisplayed()
|
|
Verifies whether the product title component is displayed.
Returns :
void
|
| checkTotalPrice | ||||||
checkTotalPrice(formattedPrice)
|
||||||
|
Verifies the accuracy of the formatted price.
Parameters :
Returns :
void
|
| checkUpdatingMessageNotDisplayed |
checkUpdatingMessageNotDisplayed()
|
|
Verifies whether the updating configuration message is not displayed on the top of the configuration.
Returns :
void
|
| checkValueSelected | ||||||||||||
checkValueSelected(uiType, attributeName, valueName)
|
||||||||||||
|
Verifies whether a corresponding UI type is selected.
Parameters :
Returns :
void
|
| clickHamburger |
clickHamburger()
|
|
Clicks the group menu.
Returns :
void
|
| clickOnAddToCartBtnOnPD |
clickOnAddToCartBtnOnPD()
|
|
Clicks on 'Add to cart' on the product details page.
Returns :
void
|
| clickOnGroupByGroupIndex | ||||||
clickOnGroupByGroupIndex(groupIndex)
|
||||||
|
Clicks on the group via its index in the group menu.
Parameters :
Returns :
void
|
| clickOnNextBtn | ||||||
clickOnNextBtn(nextGroup)
|
||||||
|
Clicks on the next group Button and verifies that an element of the next group is displayed.
Parameters :
Returns :
void
|
| clickOnPreviousBtn | ||||||
clickOnPreviousBtn(previousGroup)
|
||||||
|
Clicks on the previous group Button and verifies that an element of the previous group is displayed.
Parameters :
Returns :
void
|
| clickOnPreviousOrNextBtn | |||||||||
clickOnPreviousOrNextBtn(btnSelector, activeGroup)
|
|||||||||
|
Clicks on 'previous' or 'next' button.
Parameters :
Returns :
void
|
| clickOnProceedToCheckoutBtnOnPD |
clickOnProceedToCheckoutBtnOnPD()
|
|
Clicks on 'Proceed to Checkout' on the product details page.
Returns :
void
|
| clickOnViewCartBtnOnPD |
clickOnViewCartBtnOnPD()
|
|
Clicks on 'View Cart' on the product details page.
Returns :
void
|
| completeOrderProcess | ||||||
completeOrderProcess(productName)
|
||||||
|
Orders a product: (1) Registers a new user, (2) Logs in with the credentials of the newly registered user, (3) Searches for a corresponding product by a product name, (4) Adds a searched product to the cart, (5) Orders a product, (6) Verifies whether the order history contains the ordered product and (7) Navigates to the order details of the product via 'Display Configuration' link.
Parameters :
Returns :
void
|
| defineAliases | ||||
defineAliases(backendUrl)
|
||||
|
Parameters :
|
| getAttributeId | |||||||||
getAttributeId(attributeName, uiType)
|
|||||||||
|
Retrieves attribute ID.
Parameters :
Returns :
string
|
| getAttributeLabelId | ||||||
getAttributeLabelId(attributeName)
|
||||||
|
Retrieves the attribute label id.
Parameters :
Returns :
string
|
| navigateToOverviewPage |
navigateToOverviewPage()
|
|
Navigates to the overview page via the overview tab.
Returns :
void
|
| searchForProduct | ||||||
searchForProduct(productName)
|
||||||
|
Searches for a product by a product name.
Parameters :
Returns :
void
|
| selectAttribute | |||||||||||||||
selectAttribute(attributeName, uiType, valueName, value?)
|
|||||||||||||||
|
Selects a corresponding attribute value.
Parameters :
Returns :
void
|
| checkAmountOfBundleItems | |||||||||
checkAmountOfBundleItems(cartItemIndex, itemsAmount)
|
|||||||||
|
Verifies the amount of bundle items for a certain cart item.
Parameters :
|
| checkBundleItemName | ||||||||||||
checkBundleItemName(cartItemIndex, bundleItemIndex, name)
|
||||||||||||
|
Verifies the name of bundle item.
Parameters :
|
| checkBundleItemPrice | ||||||||||||
checkBundleItemPrice(cartItemIndex, bundleItemIndex, price)
|
||||||||||||
|
Verifies the price of bundle item.
Parameters :
|
| checkBundleItemQuantity | ||||||||||||
checkBundleItemQuantity(cartItemIndex, bundleInfoIndex, quantity)
|
||||||||||||
|
Verifies the quantity of bundle item.
Parameters :
|
| checkoutB2B |
checkoutB2B()
|
|
Conducts the B2B checkout.
Returns :
void
|
| clickOnProceedToCheckoutBtnInCart |
clickOnProceedToCheckoutBtnInCart()
|
|
Clicks on 'Proceed to Checkout' in the cart
Returns :
void
|
| clickOnResolveIssuesLinkInCart | ||||||
clickOnResolveIssuesLinkInCart(cartItemIndex)
|
||||||
|
Clicks on 'Resolve Issues' link in the cart.
Parameters :
Returns :
void
|
| defineDeliveryModeAlias |
defineDeliveryModeAlias()
|
|
Define alias for deliveryMode API call. |
| findBundleItem | ||||||
findBundleItem(cartItemIndex)
|
||||||
|
Search for a corresponding bundle item.
Parameters :
Returns :
Chainable<JQuery<HTMLElement>>
|
| goToOrderHistory | ||||||
goToOrderHistory(shopName)
|
||||||
|
Navigates to the oder history page.
Parameters :
Returns :
Chainable<Window>
|
| searchForOrder | ||||||
searchForOrder(orderNumber)
|
||||||
|
Verifies whether the searched order exists in the order history and sets the '@isFound' alias accordingly.
Parameters :
Returns :
void
|
| selectOrderByOrderNumberAlias | ||||||
selectOrderByOrderNumberAlias(shopName)
|
||||||
|
Selects the order by the oder number alias.
Parameters :
Returns :
void
|
| toggleBundleItems | ||||||
toggleBundleItems(linkName)
|
||||||
|
Toggle bundle items via 'show' or 'hide' link
Parameters :
|
| verifyCartCount | ||||||
verifyCartCount(expectedCount)
|
||||||
|
Verifies the amount of cart entries.
Parameters :
|
| checkAndLogRemovedDependencies | |||||||||||||||
checkAndLogRemovedDependencies(packageJson: any, installedSpartacusLibs, removedDependencies, logger)
|
|||||||||||||||
|
Parameters :
Returns :
void
|
| collectSpartacusLibraryDependencies | ||||||
collectSpartacusLibraryDependencies(packageJson: any)
|
||||||
|
Parameters :
Returns :
literal type
|
| collectSpartacusPeerDeps | ||||||
collectSpartacusPeerDeps(collectedDeps, name)
|
||||||
|
Parameters :
Returns :
string[]
|
| createSpartacusLibraryDependencies | ||||||
createSpartacusLibraryDependencies(allSpartacusLibraries, skipScopes)
|
||||||
|
Parameters :
Returns :
NodeDependency[]
|
| getCurrentDependencyVersion | |||||||||
getCurrentDependencyVersion(dependency, packageJson: any)
|
|||||||||
|
Parameters :
Returns :
semver.SemVer | null
|
| migrateDependencies | ||||||||
migrateDependencies(tree, context, removedDependencies)
|
||||||||
|
Parameters :
Returns :
Rule
|
| updatePackageJsonDependencies | |||||||||
updatePackageJsonDependencies(dependencies, packageJson: any)
|
|||||||||
|
Parameters :
Returns :
Rule
|
| checkApprovalDashboardMenuOptionExistence | ||||||
checkApprovalDashboardMenuOptionExistence(exists: boolean)
|
||||||
|
Parameters :
|
| getStubbedApprovedOrderApprovalDetail |
getStubbedApprovedOrderApprovalDetail()
|
| getStubbedOrderApprovalDetail |
getStubbedOrderApprovalDetail()
|
| getStubbedOrderApprovalList |
getStubbedOrderApprovalList()
|
| getStubbedPendingOrderDetails |
getStubbedPendingOrderDetails()
|
| getStubbedRejectedOrderApprovalDetail |
getStubbedRejectedOrderApprovalDetail()
|
| loginB2bApprover |
loginB2bApprover()
|
| loginB2bUser |
loginB2bUser()
|
| makeStubbedDecision |
makeStubbedDecision()
|
| visitOrderApprovalDetailPage |
visitOrderApprovalDetailPage()
|
| visitOrderApprovalListPage |
visitOrderApprovalListPage()
|
| checkAttrDisplayed | ||||||||
checkAttrDisplayed(attributeName, valueName, attributeIdx)
|
||||||||
|
Verifies whether the attribute name and value are displayed at the given position.
Parameters :
Returns :
void
|
| checkAttrPriceDisplayed | ||||||
checkAttrPriceDisplayed(priceString, attributeIdx)
|
||||||
|
Verifies whether the attribute price is displayed at the given position.
Parameters :
Returns :
void
|
| checkAttrType | ||||||
checkAttrType(attributeType, attributeIdx)
|
||||||
|
Verifies whether the attribute name and value are displayed at the given position.
Parameters :
Returns :
void
|
| checkGroupHeaderDisplayed | ||||||
checkGroupHeaderDisplayed(groupName, groupIdx)
|
||||||
|
Verifies whether the group header displayed.
Parameters :
Returns :
void
|
| checkGroupHeaderNotDisplayed | ||||
checkGroupHeaderNotDisplayed(groupName)
|
||||
|
Verifies whether the group header is not displayed.
Parameters :
Returns :
void
|
| checkAttributeHeaderDisplayed | ||||||
checkAttributeHeaderDisplayed(attributeHeaders)
|
||||||
|
Verifies if all passed attribute headers are displayed
Parameters :
Returns :
void
|
| checkConfigPageDisplayed |
checkConfigPageDisplayed()
|
|
Verifies whether the configuration page is displayed.
Returns :
void
|
| checkPrice | |||||||||||||||
checkPrice(uiType, priceFormula, attributeName, valueName?)
|
|||||||||||||||
|
Selects a corresponding attribute value.
Parameters :
Returns :
void
|
| checkProductTitleDisplayed |
checkProductTitleDisplayed()
|
|
Verifies whether the product title component is displayed.
Returns :
void
|
| checkSuccessMessageNotDisplayed |
checkSuccessMessageNotDisplayed()
|
|
Verifies whether the global success message is not displayed on the top of the configuration.
Returns :
void
|
| checkValueNotSelected | ||||||||||||
checkValueNotSelected(uiType, attributeName, valueName)
|
||||||||||||
|
Verifies whether a corresponding UI type not selected.
Parameters :
|
| clickAddToCartBtn |
clickAddToCartBtn()
|
|
Clicks on the 'Add to cart' button.
Returns :
void
|
| clickOnConfigureBtnInCatalog |
clickOnConfigureBtnInCatalog()
|
|
Clicks on 'Add to Cart' button in catalog list.
Returns :
void
|
| clickOnGroup | ||||||
clickOnGroup(groupIndex)
|
||||||
|
Clicks on the group via its index in the group menu.
Parameters :
Returns :
void
|
| convertCardTypeToUiType | ||||||
convertCardTypeToUiType(cardType)
|
||||||
|
converts the given card/bundle type to the corresponding ui type
Parameters :
|
| deSelectProductCard | ||||||||||||
deSelectProductCard(cardType, attributeName, valueName)
|
||||||||||||
|
DeSelects a product card and waits until it's state changes.
Parameters :
|
| getNthGroupMenu | ||||
getNthGroupMenu(index)
|
||||
|
Returns nth group menu link
Parameters :
Returns :
Chainable<JQuery<HTMLElement>>
|
| goToConfigurationPage | ||||||||||||
goToConfigurationPage(shopName, productId, configurationType)
|
||||||||||||
|
Navigates to the product configuration page.
Parameters :
Returns :
Chainable<Window>
|
| goToCPQConfigurationPage | |||||||||
goToCPQConfigurationPage(shopName, productId)
|
|||||||||
|
Navigates to the CPQ product configuration page.
Parameters :
Returns :
Chainable<Window>
|
| goToPDPage | |||||||||
goToPDPage(shopName, productId)
|
|||||||||
|
Navigates to the product detail page.
Parameters :
Returns :
void
|
| login | ||||||||
login(email, password, name)
|
||||||||
|
Logs in.
Parameters :
Returns :
void
|
| selectAttributeAndWait | |||||||||||||||
selectAttributeAndWait(attributeName, uiType, valueName, value?)
|
|||||||||||||||
|
Selects a corresponding attribute value and wait.
Parameters :
Returns :
void
|
| selectProductCard | ||||||||||||
selectProductCard(cardType, attributeName, valueName)
|
||||||||||||
|
Selects a product card and waits until it's state changes.
Parameters :
|
| setQuantity | |||||||||||||||
setQuantity(uiType, quantity, attributeName, valueName?)
|
|||||||||||||||
|
Selects a corresponding attribute value.
Parameters :
Returns :
void
|
| waitForProductCardsLoad | ||||
waitForProductCardsLoad(expectedLength)
|
||||
|
Waiting for the product card to load correctly
Parameters :
|
| checkBanner |
checkBanner()
|
| clickHamburger |
clickHamburger()
|
| waitForHomePage |
waitForHomePage()
|
| checkCartEmpty |
checkCartEmpty()
|
|
Verifies whether the mini-cart displays zero cart items. |
| clickOnEditConfigurationLink | ||||||
clickOnEditConfigurationLink(cartItemIndex)
|
||||||
|
Clicks on the 'Edit Configuration' link in cart for a certain cart item.
Parameters :
Returns :
void
|
| clickOnRemoveLink | ||||||
clickOnRemoveLink(cartItemIndex)
|
||||||
|
Clicks on the 'Remove' link in cart for a certain cart item to remove a cart item.
Parameters :
Returns :
void
|
| defineOrderNumberAlias |
defineOrderNumberAlias()
|
|
Defines the order number alias.
Returns :
void
|
| navigateToOrderDetails |
navigateToOrderDetails()
|
|
Navigates to the order details page.
Returns :
void
|
| checkConfigOverviewPageDisplayed |
checkConfigOverviewPageDisplayed()
|
|
Verifies whether the product overview page is displayed.
Returns :
void
|
| checkContinueToCartBtnDisplayed |
checkContinueToCartBtnDisplayed()
|
|
Verifies whether 'Continue to Cart' button is displayed.
Returns :
void
|
| clickContinueToCartBtnOnOP |
clickContinueToCartBtnOnOP()
|
|
Clicks on 'Continue to cart' on the product overview page.
Returns :
void
|
| waitForNotificationBanner | ||||||
waitForNotificationBanner(numberOfIssues?)
|
||||||
|
Waits for the notitication banner to display the correct number of issues
Parameters :
Returns :
void
|
| checkConfigPageDisplayed |
checkConfigPageDisplayed()
|
|
Verifies whether the configuration page is displayed.
Returns :
void
|
| checkConflictDescriptionDisplayed | ||||||
checkConflictDescriptionDisplayed(description)
|
||||||
|
Verifies whether the conflict description is displayed.
Parameters :
Returns :
void
|
| checkConflictDetectedMsgDisplayed | ||||||
checkConflictDetectedMsgDisplayed(attributeName)
|
||||||
|
Verifies whether the conflict detected under the attribute name is displayed.
Parameters :
Returns :
void
|
| checkConflictDetectedMsgNotDisplayed | ||||||
checkConflictDetectedMsgNotDisplayed(attributeName)
|
||||||
|
Verifies whether the conflict detected under the attribute name is not displayed.
Parameters :
Returns :
void
|
| checkConflictHeaderGroupDisplayed |
checkConflictHeaderGroupDisplayed()
|
|
Verifies whether the conflict header group is displayed.
Returns :
void
|
| checkConflictHeaderGroupNotDisplayed |
checkConflictHeaderGroupNotDisplayed()
|
|
Verifies whether the conflict header group is not displayed.
Returns :
void
|
| checkGlobalMessageNotDisplayed |
checkGlobalMessageNotDisplayed()
|
|
Verifies whether the global message is not displayed on the top of the configuration.
Returns :
void
|
| checkImageSelected | ||||||||||||
checkImageSelected(uiType, attributeName, valueName)
|
||||||||||||
|
Verifies whether the image value is selected.
Parameters :
Returns :
void
|
| checkLoadingMsgNotDisplayed |
checkLoadingMsgNotDisplayed()
|
|
Verifies whether the loading message is not displayed.
Returns :
void
|
| checkProductTitleDisplayed |
checkProductTitleDisplayed()
|
|
Verifies whether the product title component is displayed.
Returns :
void
|
| checkStatusIconDisplayed | |||||||||
checkStatusIconDisplayed(groupName, status)
|
|||||||||
|
Verifies whether status icon is displayed.
Parameters :
Returns :
void
|
| checkStatusIconNotDisplayed | ||||||
checkStatusIconNotDisplayed(groupName)
|
||||||
|
Verifies whether status icon is not displayed.
Parameters :
Returns :
void
|
| clickAddToCartBtn |
clickAddToCartBtn()
|
|
Clicks on the 'Add to cart' button.
Returns :
void
|
| clickOnConfigureBtnInCatalog |
clickOnConfigureBtnInCatalog()
|
|
Clicks on 'Add to Cart' button in catalog list.
Returns :
void
|
| clickOnGroup | ||||||
clickOnGroup(groupIndex)
|
||||||
|
Clicks on the group via its index in the group menu.
Parameters :
Returns :
void
|
| deselectConflictingValue | ||||||||||||
deselectConflictingValue(attributeName, uiType, valueName)
|
||||||||||||
|
Deselects a conflicting value, namely deselects a value. Then verifies whether the conflict detected message under the attribute name is not displayed anymore and the conflict header group in the group menu is not displayed either.
Parameters :
Returns :
void
|
| goToCart | ||||||
goToCart(shopName)
|
||||||
|
Navigates to the cart page.
Parameters :
|
| goToConfigurationPage | |||||||||
goToConfigurationPage(shopName, productId)
|
|||||||||
|
Navigates to the product configuration page.
Parameters :
|
| goToPDPage | |||||||||
goToPDPage(shopName, productId)
|
|||||||||
|
Navigates to the product detail page.
Parameters :
Returns :
void
|
| registerConfigurationRoute |
registerConfigurationRoute()
|
|
Register configuration route. |
| selectConflictingValue | |||||||||||||||
selectConflictingValue(attributeName, uiType, valueName, numberOfConflicts)
|
|||||||||||||||
|
Selects a conflicting value, namely selects a value. Then verifies whether the conflict detected message under the attribute name is displayed, The conflict header group in the group menu is displayed and Finally verifies whether the expected number of conflicts is accurate.
Parameters :
Returns :
void
|
| verifyNumberOfConflicts | ||||||
verifyNumberOfConflicts(numberOfConflicts)
|
||||||
|
Verifies whether the expected number of conflicts is accurate.
Parameters :
Returns :
void
|
| checkFocusIsNotWithinGroupSkipper |
checkFocusIsNotWithinGroupSkipper()
|
| checkFocusIsWithinGroupSkipper |
checkFocusIsWithinGroupSkipper()
|
| checkGroupSkipperAnchorsHaveLoaded | ||||
checkGroupSkipperAnchorsHaveLoaded(noOfAnchors)
|
||||
|
Parameters :
|
| verifyGroupSkippingFromConfig | ||||
verifyGroupSkippingFromConfig(config)
|
||||
|
Parameters :
|
| verifyGroupSkippingOnPageFromConfig | ||||
verifyGroupSkippingOnPageFromConfig(config)
|
||||
|
Parameters :
|
| checkIfSSRIsUsed | ||||
checkIfSSRIsUsed(tree)
|
||||
|
Parameters :
Returns :
boolean
|
| cleanSemverVersion | ||||
cleanSemverVersion(versionString)
|
||||
|
Parameters :
Returns :
string
|
| createDependencies | ||||||
createDependencies(dependencyObject, options)
|
||||||
|
Parameters :
Returns :
NodeDependency[]
|
| createSpartacusDependencies | ||||
createSpartacusDependencies(dependencyObject)
|
||||
|
Parameters :
Returns :
NodeDependency[]
|
| getMajorVersionNumber | ||||
getMajorVersionNumber(versionString)
|
||||
|
Parameters :
Returns :
number
|
| getPrefixedSpartacusSchematicsVersion |
getPrefixedSpartacusSchematicsVersion()
|
|
Returns :
string
|
| getSpartacusCurrentFeatureLevel |
getSpartacusCurrentFeatureLevel()
|
|
Returns :
string
|
| getSpartacusSchematicsVersion |
getSpartacusSchematicsVersion()
|
|
Returns :
string
|
| mapPackageToNodeDependencies | ||||||||
mapPackageToNodeDependencies(packageName, version, overwrite)
|
||||||||
|
Parameters :
Returns :
NodeDependency
|
| prepare3rdPartyDependencies |
prepare3rdPartyDependencies()
|
|
Returns :
NodeDependency[]
|
| prepareSpartacusDependencies |
prepareSpartacusDependencies()
|
|
Returns :
NodeDependency[]
|
| readPackageJson | ||||
readPackageJson(tree)
|
||||
|
Parameters :
Returns :
any
|
| checkNotificationBanner | |||||||||
checkNotificationBanner(element, numberOfIssues?)
|
|||||||||
|
Verifies whether the issues banner is displayed.
Parameters :
Returns :
void
|
| checkout |
checkout()
|
|
Conducts the checkout.
Returns :
void
|
| verifyNotificationBannerInCart | |||||||||
verifyNotificationBannerInCart(cartItemIndex, numberOfIssues?)
|
|||||||||
|
Verifies whether the issues banner is displayed in the cart for a certain cart item.
Parameters :
Returns :
void
|
| checkNotificationBannerOnOP | |||||||||
checkNotificationBannerOnOP(element, numberOfIssues?)
|
|||||||||
|
Verifies whether the issues banner is displayed.
Parameters :
Returns :
void
|
| clickOnResolveIssuesLinkOnOP |
clickOnResolveIssuesLinkOnOP()
|
|
Clicks on 'Resolve Issues' link on the product overview page.
Returns :
void
|
| goToConfigOverviewPage | |||||||||
goToConfigOverviewPage(shopName, productId)
|
|||||||||
|
Navigates to the configured product overview page.
Parameters :
Returns :
Chainable<Window>
|
| navigateToConfigurationPage |
navigateToConfigurationPage()
|
|
Navigates to the configuration page via configuration tab.
Returns :
void
|
| registerConfigurationOvOCC |
registerConfigurationOvOCC()
|
|
Registers OCC call for OV page in order to wait for it |
| verifyNotificationBannerOnOP | ||||||
verifyNotificationBannerOnOP(numberOfIssues?)
|
||||||
|
Verifies whether the issues banner is displayed and the number of issues are accurate.
Parameters :
Returns :
void
|
| checkoutAppliedCouponsTabbingOrder | ||||
checkoutAppliedCouponsTabbingOrder(config)
|
||||
|
Parameters :
|
| checkoutCouponsTabbingOrder | ||||
checkoutCouponsTabbingOrder(config)
|
||||
|
Parameters :
|
| checkoutBillingAddressTabbingOrder | ||||
checkoutBillingAddressTabbingOrder(config)
|
||||
|
Parameters :
|
| checkoutPaymentDetailsTabbingOrder | ||||
checkoutPaymentDetailsTabbingOrder(config)
|
||||
|
Parameters :
|
| checkoutDeliveryMode |
checkoutDeliveryMode()
|
| checkoutPaymentDetails |
checkoutPaymentDetails()
|
| checkoutShippingAddress |
checkoutShippingAddress()
|
| orderConfirmation |
orderConfirmation()
|
| reviewAndPlaceOrder |
reviewAndPlaceOrder()
|
| checkoutDeliveryModeTabbingOrder | ||||
checkoutDeliveryModeTabbingOrder(config)
|
||||
|
Parameters :
|
| checkoutDeliveryModeTabbingOrderAccount | ||||
checkoutDeliveryModeTabbingOrderAccount(config)
|
||||
|
Parameters :
|
| checkoutMyCouponsTabbingOrder | ||||
checkoutMyCouponsTabbingOrder(config)
|
||||
|
Parameters :
|
| checkoutReviewOrderTabbingOrder | |||||||||
checkoutReviewOrderTabbingOrder(config, checkout: boolean)
|
|||||||||
|
Parameters :
|
| checkoutShippingAddressAccount | ||||
checkoutShippingAddressAccount(config)
|
||||
|
Parameters :
|
| checkoutShippingAddressExistingTabbingOrder | ||||
checkoutShippingAddressExistingTabbingOrder(config)
|
||||
|
Parameters :
|
| checkoutShippingAddressNewTabbingOrder | ||||
checkoutShippingAddressNewTabbingOrder(config)
|
||||
|
Parameters :
|
| checkProductAvailabilityMessage |
checkProductAvailabilityMessage()
|
| checkReducedQuantity | ||||
checkReducedQuantity(product)
|
||||
|
Parameters :
|
| validateStock |
validateStock(mockResponse: object, alias: string)
|
|
|
| checkRowHeaders | ||||||
checkRowHeaders(configs)
|
||||||
|
Assert table headers are correctly labelled.
Parameters :
Returns :
void
|
| checkRows | ||||
checkRows(rows)
|
||||
|
Parameters :
Returns :
void
|
| getFormattedDate | ||||
getFormattedDate(date)
|
||||
|
Parameters :
Returns :
string
|
| getListRowsFromBody | ||||||||||||
getListRowsFromBody(body: any, objectType, rows)
|
||||||||||||
|
Parameters :
|
| getMonthPartFromDate | ||||
getMonthPartFromDate(date)
|
||||
|
Parameters :
Returns :
string
|
| getNestedRowsFromBody | |||||||||
getNestedRowsFromBody(body: any, config)
|
|||||||||
|
When getting the rows from a body with children, return body with child rows
Parameters :
|
| getRootRowsFromBody | |||||||||
getRootRowsFromBody(body: any, config)
|
|||||||||
|
When getting the rows from a body with children, only return the body row
Parameters :
|
| getVariableFromName | |||||||||
getVariableFromName(name, dataset: any)
|
|||||||||
|
Parameters :
|
| ngSelect | ||||
ngSelect(sortKey)
|
||||
|
Parameters :
Returns :
void
|
| testList | ||||||||
testList(config, options?, suffix)
|
||||||||
|
Parameters :
Returns :
void
|
| testListSorting | ||||
testListSorting(config)
|
||||
|
Parameters :
Returns :
void
|
| verifyList | ||||||
verifyList(rows, rowConfig)
|
||||||
|
Parameters :
Returns :
void
|
| claimCoupon | ||||
claimCoupon(couponCode)
|
||||
|
Parameters :
|
| createStandardUser |
createStandardUser()
|
| goMyCoupon |
goMyCoupon()
|
| verfifyNotificationDisable |
verfifyNotificationDisable()
|
| verfifyNotificationEnable |
verfifyNotificationEnable()
|
| verifyClaimCouponFail | ||||
verifyClaimCouponFail(couponCode)
|
||||
|
Parameters :
|
| verifyClaimCouponSuccess | ||||
verifyClaimCouponSuccess(couponCode)
|
||||
|
Parameters :
|
| verifyCouponsClaiming |
verifyCouponsClaiming()
|
| verifyEnableDisableNotification |
verifyEnableDisableNotification()
|
| verifyFindProduct | ||||||
verifyFindProduct(couponCode, productNumber)
|
||||||
|
Parameters :
|
| verifyMyCoupons |
verifyMyCoupons()
|
| verifyPagingAndSorting |
verifyPagingAndSorting()
|
| verifyReadMore |
verifyReadMore()
|
| waitForClaimCoupon | ||||
waitForClaimCoupon(couponCode)
|
||||
|
Parameters :
Returns :
string
|
| waitForGetCoupons |
waitForGetCoupons()
|
|
Returns :
string
|
| cleanSlashes | ||||
cleanSlashes(path)
|
||||
|
Parameters :
Returns :
string
|
| urlPathJoin | ||||||
urlPathJoin(...parts: undefined)
|
||||||
|
Joins the multiple parts with '/' to create a url
Parameters :
Returns :
string
|
| cleanup |
cleanup()
|
|
Returns :
void
|
| collect | ||||
collect(directories)
|
||||
|
Parameters :
Returns :
Record<string, Record<string, string>>
|
| compareFiles | ||||
compareFiles(options)
|
||||
|
Parameters :
Returns :
void
|
| format | ||||
format(path)
|
||||
|
Parameters :
Returns :
void
|
| read | ||||
read(path)
|
||||
|
Parameters :
Returns :
string
|
| readJson | ||||
readJson(path)
|
||||
|
Parameters :
Returns :
any
|
| run | ||||
run(options)
|
||||
|
Parameters :
Returns :
void
|
| save | ||||||
save(path, content)
|
||||||
|
Parameters :
Returns :
void
|
| clearAnonymousConsentTemplates | ||||
clearAnonymousConsentTemplates(reducer)
|
||||
|
Parameters :
Returns :
ActionReducer<AnonymousConsentsState, Action>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<AnonymousConsentsState>
|
| clearCmsState | ||||
clearCmsState(reducer)
|
||||
|
Parameters :
Returns :
ActionReducer<StateWithCms, Action>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<CmsState>
|
| clearCustomerSupportAgentAsmState | ||||
clearCustomerSupportAgentAsmState(reducer)
|
||||
|
Parameters :
Returns :
ActionReducer<AsmState, Action>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<AsmState>
|
| clearMultiCartState | ||||
clearMultiCartState(reducer)
|
||||
|
Parameters :
Returns :
ActionReducer<any>
|
| getMultiCartReducers |
getMultiCartReducers()
|
|
Returns :
ActionReducerMap<MultiCartState>
|
| clearOrganizationState | ||||
clearOrganizationState(reducer)
|
||||
|
Parameters :
Returns :
ActionReducer<OrganizationState, Action>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<OrganizationState>
|
| clearOrganizationState | ||||
clearOrganizationState(reducer)
|
||||
|
Parameters :
Returns :
ActionReducer<OrderApprovalState, Action>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<OrderApprovalState>
|
| clearProductsState | ||||
clearProductsState(reducer)
|
||||
|
Parameters :
Returns :
ActionReducer<any>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<ProductsState>
|
| clearStoreFinderState | ||||
clearStoreFinderState(reducer)
|
||||
|
Parameters :
Returns :
ActionReducer<StoresState, Action>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<StoresState>
|
| clearUserState | ||||
clearUserState(reducer)
|
||||
|
Parameters :
Returns :
ActionReducer<any>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<UserState>
|
| clickNotifyMeBtn | ||||
clickNotifyMeBtn(productCode)
|
||||
|
Parameters :
|
| disableNotificationChannel |
disableNotificationChannel()
|
| enableNotificationChannel |
enableNotificationChannel()
|
| interceptNotificationPreferencesChange |
interceptNotificationPreferencesChange()
|
| navigateToMyInterestsPage |
navigateToMyInterestsPage()
|
| navigateToNotificationPreferencePage |
navigateToNotificationPreferencePage()
|
| navigateToPDP | ||||
navigateToPDP(productCode)
|
||||
|
Parameters :
|
| navigateToPDPInCustomerInterest | ||||
navigateToPDPInCustomerInterest(productCode)
|
||||
|
Parameters :
|
| removeCustomerInterest | ||||
removeCustomerInterest(productCode)
|
||||
|
Parameters :
|
| stubForPaginableMyInterests | ||||||
stubForPaginableMyInterests(jsonfile, url)
|
||||||
|
Parameters :
|
| subscribeStockNotification | ||||
subscribeStockNotification(productCode)
|
||||
|
Parameters :
|
| unsubscribeStockNotification | ||||
unsubscribeStockNotification(productCode)
|
||||
|
Parameters :
|
| updateEmail |
updateEmail()
|
|
Returns :
String
|
| verifyCustomerInterest | ||||
verifyCustomerInterest(productCode)
|
||||
|
Parameters :
|
| verifyCustomerInterests |
verifyCustomerInterests()
|
| verifyEmailChannel | ||||
verifyEmailChannel(email)
|
||||
|
Parameters :
|
| verifyNavigateToMyInterestsInDialog |
verifyNavigateToMyInterestsInDialog()
|
| verifyNavigateToNotificationPreferenceInDialog |
verifyNavigateToNotificationPreferenceInDialog()
|
| verifyPagingAndSorting |
verifyPagingAndSorting()
|
| verifyRemovingCustomerInterestInPDP |
verifyRemovingCustomerInterestInPDP()
|
| verifyStockNotification |
verifyStockNotification()
|
| verifyStockNotificationAsGuest |
verifyStockNotificationAsGuest()
|
| verifyStockNotificationWithoutChannel |
verifyStockNotificationWithoutChannel()
|
| verifySubscriptionAndCustomerInterest | ||||
verifySubscriptionAndCustomerInterest(productCode)
|
||||
|
Parameters :
|
| verifyUnsubscribe |
verifyUnsubscribe()
|
| clickSubmit | ||||
clickSubmit(fixture)
|
||||
|
Parameters :
|
| closeAccountTabbingOrder | ||||
closeAccountTabbingOrder(config)
|
||||
|
Parameters :
|
| cmsStoreConfigFactory |
cmsStoreConfigFactory()
|
|
Returns :
StateConfig
|
| comparePathsConfigs | ||||||||||||
comparePathsConfigs(targetPaths, tsConfigPath, silent)
|
||||||||||||
|
Compare target paths with current paths and reports extra or missing entries.
Parameters :
Returns :
boolean
true when there were some errors |
| handleAppConfigs | ||||||
handleAppConfigs(libraries, options)
|
||||||
|
Parameters :
Returns :
void
|
| handleConfigUpdate | ||||||||||||
handleConfigUpdate(targetPaths: any, file, options)
|
||||||||||||
|
Compares paths and reports errors or updates configs.
Parameters :
Returns :
boolean
true when there were some errors |
| handleLibConfigs | ||||||
handleLibConfigs(libraries, options)
|
||||||
|
Adds paths to spartacus dependencies in
Parameters :
Returns :
void
|
| handleRootConfigs | ||||||
handleRootConfigs(libraries, options)
|
||||||
|
Add paths to all libraries and all their entry points to root
Parameters :
Returns :
void
|
| handleSchematicsConfigs | ||||||
handleSchematicsConfigs(libraries, options)
|
||||||
|
When library have its own schematics ts config (tsconfig.schematics.json exists) and have
schematics as peerDependency we add path to
Parameters :
Returns :
void
|
| joinPaths | ||||
joinPaths(...parts: undefined)
|
||||
|
Parameters :
|
| manageTsConfigs | ||||||
manageTsConfigs(repository, options)
|
||||||
|
Checks and updates tsconfig files across repository.
Parameters :
|
| readTsConfigFile | ||||
readTsConfigFile(path)
|
||||
|
Parameters :
Returns :
any
|
| setCompilerOptionsPaths | ||||||
setCompilerOptionsPaths(tsconfigPath, paths)
|
||||||
|
Parameters :
|
| completeForm | ||||||
completeForm(rowConfigs, formType)
|
||||||
|
Parameters :
|
| getValueKey | ||||
getValueKey(formType)
|
||||
|
Returns the key of the MyCompanyRowConfig for the item value. Depending on the form type, it returns the key for creating OR updating value.
Parameters :
Returns :
"createValue" | "updateValue"
|
| verifyDetails | ||||||
verifyDetails(config, formType)
|
||||||
|
Parameters :
|
| componentExistsReducer | ||||||
componentExistsReducer(state, action)
|
||||||
|
Parameters :
Returns :
boolean
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ComponentsContext
|
| configFactory |
configFactory()
|
| defaultConfigFactory |
defaultConfigFactory()
|
| rootConfigFactory |
rootConfigFactory()
|
| configFromCookieFactory | ||||||||||||
configFromCookieFactory(cookieName, platform: any, document)
|
||||||||||||
|
Parameters :
|
| parseConfigJSON | ||||
parseConfigJSON(config)
|
||||
|
Parameters :
|
| configInitializerFactory | ||||||
configInitializerFactory(configInitializer, initializers)
|
||||||
|
Parameters :
Returns :
Promise<void>
|
| locationInitializedFactory | ||||
locationInitializedFactory(configInitializer)
|
||||
|
Parameters :
Returns :
Promise<Config>
|
| configuratorReducer | ||||||
configuratorReducer(state, action)
|
||||||
|
Parameters :
Returns :
Configurator.Configuration
|
| setGroupsVisited | ||||||
setGroupsVisited(changedInteractionState, groupId)
|
||||||
|
Parameters :
|
| setInitialCurrentGroup | ||||
setInitialCurrentGroup(state)
|
||||
|
Parameters :
Returns :
Configurator.Configuration
|
| takeOverChanges | ||||||
takeOverChanges(action, state)
|
||||||
|
Parameters :
Returns :
Configurator.Configuration
|
| takeOverPricingChanges | ||||||
takeOverPricingChanges(action, state)
|
||||||
|
Parameters :
Returns :
Configurator.Configuration
|
| configureDefaultProduct |
configureDefaultProduct()
|
| verifyTabbingOrder |
verifyTabbingOrder()
|
| configureSpartacusModules | ||||||||
configureSpartacusModules(tree, tsconfigPath, basePath)
|
||||||||
|
Parameters :
Returns :
void
|
| setupSpartacusFeaturesModule | ||||
setupSpartacusFeaturesModule(project)
|
||||
|
Migration which ensures the spartacus features are being correctly set up
Parameters :
Returns :
Rule
|
| configureSpartacusModules | ||||||||
configureSpartacusModules(tree, tsconfigPath, basePath)
|
||||||||
|
Parameters :
Returns :
void
|
| setupSpartacusModule | ||||
setupSpartacusModule(project)
|
||||
|
Migration which ensures the spartacus is being correctly set up
Parameters :
Returns :
Rule
|
| configureStoreModules | ||||||||
configureStoreModules(tree, tsconfigPath, basePath)
|
||||||||
|
Parameters :
Returns :
void
|
| setupStoreModules | ||||
setupStoreModules(project)
|
||||
|
Migration that ensures that we have correct Store modules set
Parameters :
Returns :
Rule
|
| configValidatorFactory | ||||||
configValidatorFactory(configInitializer, validators)
|
||||||
|
Parameters :
Returns :
void
|
| consentManagementTabbingOrder | ||||
consentManagementTabbingOrder(config)
|
||||
|
Parameters :
|
| consignmentTrackingEventsTabbingOrder | ||||
consignmentTrackingEventsTabbingOrder(config)
|
||||
|
Parameters :
|
| consignmentTrackingTabbingOrder | ||||
consignmentTrackingTabbingOrder(config)
|
||||
|
Parameters :
|
| controlsMustMatch | |||||||||||||||
controlsMustMatch(formGroup, firstControlName, secondControlName, errorName)
|
|||||||||||||||
|
Generic function for validators, which checks if two passed controls match.
Parameters :
Returns :
void
|
| costCenterAssignedBudgetsListReducer | ||||||
costCenterAssignedBudgetsListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| costCentersEntitiesReducer | ||||||
costCentersEntitiesReducer(state, action)
|
||||||
|
Parameters :
Returns :
CostCenter
|
| costCentersListReducer | ||||||
costCentersListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| costCenterTableConfigFactory |
costCenterTableConfigFactory()
|
|
Returns :
TableConfig
|
| countOfDeepEqualObjects | |||||||||
countOfDeepEqualObjects(obj: any, arr)
|
|||||||||
|
Parameters :
Returns :
number
|
| deepEqualObjects | ||||||
deepEqualObjects(objA, objB)
|
||||||
|
Parameters :
Returns :
boolean
|
| indexOfFirstOccurrence | |||||||||
indexOfFirstOccurrence(obj: any, arr)
|
|||||||||
|
Parameters :
Returns :
number | undefined
|
| shallowEqualObjects | ||||||
shallowEqualObjects(objA, objB)
|
||||||
|
Parameters :
Returns :
boolean
|
| countriesListTabbingOrder | ||||
countriesListTabbingOrder(config)
|
||||
|
Parameters :
|
| createAccountFromGuest | ||||
createAccountFromGuest(password)
|
||||
|
Parameters :
|
| loginAsGuest | ||||
loginAsGuest(sampleUser)
|
||||
|
Parameters :
|
| createCodeForEntityName | ||||||
createCodeForEntityName(name, code)
|
||||||
|
Parameters :
Returns :
void
|
| createFrom | |||||||||
createFrom(type, data)
|
|||||||||
|
Creates an instance of the given class and fills its properties with the given data.
Parameters :
Returns :
T
|
| createProgram | ||||||||
createProgram(tree, basePath, tsconfigPath)
|
||||||||
|
Parameters :
Returns :
literal type
|
| saveAndFormat | ||||
saveAndFormat(sourceFile)
|
||||
|
Parameters :
Returns :
void
|
| createShellObject | ||||||||
createShellObject(key, excludeKeys, value)
|
||||||||
|
Parameters :
Returns :
E
|
| filterKeysByType | ||||||
filterKeysByType(keys, type)
|
||||||
|
Parameters :
Returns :
string[]
|
| getExclusionKeys | ||||||
getExclusionKeys(key, excludeKeys)
|
||||||
|
Parameters :
Returns :
string[]
|
| getStateSlice | ||||||||
getStateSlice(keys, excludeKeys, state)
|
||||||||
|
Parameters :
Returns :
E
|
| getStateSliceValue | ||||||
getStateSliceValue(keys, state)
|
||||||
|
Parameters :
Returns :
E
|
| handleExclusions | ||||||||||||
handleExclusions(key, excludeKeys, value: any)
|
||||||||||||
|
Parameters :
Returns :
any
|
| createTest | ||||
createTest(config)
|
||||
|
Parameters :
|
| createUser |
createUser()
|
|
Creates user, but doesn't log in
Returns :
AccountData
|
| fakeExpiredAccessToken |
fakeExpiredAccessToken()
|
|
Fakes the expiration of the access token by tampering it's value. |
| revokeAccessToken |
revokeAccessToken()
|
|
Revokes access token via http endpoint |
| decorateExpressEngine | ||||||
decorateExpressEngine(ngExpressEngine, optimizationOptions)
|
||||||
|
Parameters :
Returns :
NgExpressEngine
|
| deepMerge | ||||||
deepMerge(target, ...sources: undefined)
|
||||||
|
Parameters :
Returns :
any
|
| isObject | ||||||
isObject(item: any)
|
||||||
|
Parameters :
Returns :
boolean
|
| deepUpdateValueAndValidity | |||||||||
deepUpdateValueAndValidity(control, options)
|
|||||||||
|
Calls the native Angular method In particular it's useful for triggering re-emission of observables
Note: Dropping this function may be considered, when it's implemented natively by Angular. See https://github.com/angular/angular/issues/6170
Parameters :
Returns :
void
|
| defaultCartSavedCartComponentsConfig |
defaultCartSavedCartComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultCheckoutComponentsConfig |
defaultCheckoutComponentsConfig()
|
| defaultEpdVisualizationComponentsConfig |
defaultEpdVisualizationComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultGlobalMessageConfigFactory |
defaultGlobalMessageConfigFactory()
|
|
Returns :
GlobalMessageConfig
|
| defaultImageZoomComponentsConfig |
defaultImageZoomComponentsConfig()
|
| defaultOccConfiguratorTextfieldConfigFactory |
defaultOccConfiguratorTextfieldConfigFactory()
|
|
Returns :
OccConfig
|
| defaultOccCpqConfiguratorConfigFactory |
defaultOccCpqConfiguratorConfigFactory()
|
|
Returns :
OccConfig
|
| defaultOccVariantConfiguratorConfigFactory |
defaultOccVariantConfiguratorConfigFactory()
|
|
Returns :
OccConfig
|
| defaultOrderComponentsConfig |
defaultOrderComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultOrganizationAdministrationComponentsConfig |
defaultOrganizationAdministrationComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultOrganizationOrderApprovalComponentsConfig |
defaultOrganizationOrderApprovalComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultPersonalizationComponentsConfig |
defaultPersonalizationComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultProductBulkPricingComponentsConfig |
defaultProductBulkPricingComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultProductConfiguratorRulebasedComponentsConfig |
defaultProductConfiguratorRulebasedComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultProductConfiguratorTextfieldComponentsConfig |
defaultProductConfiguratorTextfieldComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultProductVariantsComponentsConfig |
defaultProductVariantsComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultQualtricsComponentsConfig |
defaultQualtricsComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultQuickOrderComponentsConfig |
defaultQuickOrderComponentsConfig()
|
| defaultSiteContextConfigFactory |
defaultSiteContextConfigFactory()
|
|
Returns :
SiteContextConfig
|
| defaultStoreFinderComponentsConfig |
defaultStoreFinderComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultUserAccountComponentsConfig |
defaultUserAccountComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultUserProfileComponentsConfig |
defaultUserProfileComponentsConfig()
|
|
Returns :
CmsConfig
|
| defaultViewTabbingOrder | ||||
defaultViewTabbingOrder(config)
|
||||
|
Parameters :
|
| denormalizeCustomB2BSearch | ||||||||||
denormalizeCustomB2BSearch(list, entities, params?, id?)
|
||||||||||
|
Parameters :
Returns :
LoaderState<EntitiesModel<T>>
|
| denormalizeSearch | ||||||
denormalizeSearch(state, params?)
|
||||||
|
Parameters :
Returns :
LoaderState<EntitiesModel<T>>
|
| normalizeListPage | ||||||
normalizeListPage(list, id)
|
||||||
|
Parameters :
Returns :
literal type
|
| serializeParams | ||||||
serializeParams(params, searchConfig)
|
||||||
|
Parameters :
Returns :
string
|
| serializeSearchConfig | ||||||
serializeSearchConfig(config, id?)
|
||||||
|
Parameters :
Returns :
string
|
| deploy | ||||||||||||||||
deploy(github: any, octoKit: any, branch)
|
||||||||||||||||
|
Deploys an app to the hosting service
Parameters :
|
| undeploy | ||||||||
undeploy(branch: any)
|
||||||||
|
Undeploys an app from the Upscale hosting service
Parameters :
|
| disableTest | ||||
disableTest(config)
|
||||
|
Parameters :
|
| doPlaceOrder | ||||||
doPlaceOrder(productData?: any)
|
||||||
|
Parameters :
|
| entityErrorSelector | ||||||
entityErrorSelector(state, id)
|
||||||
|
Parameters :
Returns :
boolean
|
| entityLoaderStateSelector | ||||||
entityLoaderStateSelector(state, id)
|
||||||
|
Parameters :
Returns :
LoaderState<T>
|
| entityLoadingSelector | ||||||
entityLoadingSelector(state, id)
|
||||||
|
Parameters :
Returns :
boolean
|
| entitySuccessSelector | ||||||
entitySuccessSelector(state, id)
|
||||||
|
Parameters :
Returns :
boolean
|
| entityValueSelector | ||||||
entityValueSelector(state, id)
|
||||||
|
Parameters :
Returns :
T
|
| entityFailMeta | ||||||||||||
entityFailMeta(entityType, id, error?: any)
|
||||||||||||
|
Parameters :
Returns :
EntityLoaderMeta
|
| entityLoadMeta | ||||||
entityLoadMeta(entityType, id)
|
||||||
|
Parameters :
Returns :
EntityLoaderMeta
|
| entityResetMeta | ||||||
entityResetMeta(entityType, id?)
|
||||||
|
Parameters :
Returns :
EntityLoaderMeta
|
| entitySuccessMeta | ||||||
entitySuccessMeta(entityType, id)
|
||||||
|
Parameters :
Returns :
EntityLoaderMeta
|
| entityHasPendingProcessesSelector | ||||||
entityHasPendingProcessesSelector(state, id)
|
||||||
|
Parameters :
Returns :
boolean
|
| entityIsStableSelector | ||||||
entityIsStableSelector(state, id)
|
||||||
|
Parameters :
Returns :
boolean
|
| entityProcessesLoaderStateSelector | ||||||
entityProcessesLoaderStateSelector(state, id)
|
||||||
|
Parameters :
Returns :
ProcessesLoaderState<T>
|
| entityLoaderReducer | ||||||
entityLoaderReducer(entityType, reducer?)
|
||||||
|
Higher order reducer that wraps LoaderReducer and EntityReducer enhancing single state reducer to support multiple entities with generic loading flags
Parameters :
Returns :
EntityLoaderState<T>
|
| entityMeta | ||||||
entityMeta(type, id?)
|
||||||
|
Parameters :
Returns :
EntityMeta
|
| entityRemoveAllMeta | ||||
entityRemoveAllMeta(type)
|
||||
|
Parameters :
Returns :
EntityMeta
|
| entityRemoveMeta | ||||||
entityRemoveMeta(type, id)
|
||||||
|
Parameters :
Returns :
EntityMeta
|
| entityProcessesDecrementMeta | ||||||
entityProcessesDecrementMeta(entityType, id)
|
||||||
|
Parameters :
Returns :
EntityProcessesLoaderMeta
|
| entityProcessesIncrementMeta | ||||||
entityProcessesIncrementMeta(entityType, id)
|
||||||
|
Parameters :
Returns :
EntityProcessesLoaderMeta
|
| entityProcessesLoaderResetMeta | ||||||
entityProcessesLoaderResetMeta(entityType, id)
|
||||||
|
Parameters :
Returns :
EntityProcessesLoaderMeta
|
| entityProcessesLoaderReducer | ||||||
entityProcessesLoaderReducer(entityType, reducer?)
|
||||||
|
Higher order reducer that wraps ProcessesLoaderReducer and EntityReducer enhancing single state reducer to support multiple entities with generic processesCount flag
Parameters :
Returns :
EntityProcessesLoaderState<T>
|
| entityReducer | ||||||
entityReducer(entityType, reducer)
|
||||||
|
Higher order reducer for reusing reducer logic for multiple entities Utilizes entityId meta field to target entity by id in actions
Parameters :
|
| entityScopedFailMeta | |||||||||||||||
entityScopedFailMeta(entityType, id, scope?, error?: any)
|
|||||||||||||||
|
Parameters :
Returns :
EntityScopedLoaderMeta
|
| entityScopedLoadMeta | ||||||||
entityScopedLoadMeta(entityType, id, scope?)
|
||||||||
|
Parameters :
Returns :
EntityScopedLoaderMeta
|
| entityScopedResetMeta | ||||||||
entityScopedResetMeta(entityType, id?, scope?)
|
||||||||
|
Parameters :
Returns :
EntityScopedLoaderMeta
|
| entityScopedSuccessMeta | ||||||||
entityScopedSuccessMeta(entityType, id, scope?)
|
||||||||
|
Parameters :
Returns :
EntityScopedLoaderMeta
|
| entityScopedLoaderReducer | ||||||
entityScopedLoaderReducer(entityType, reducer?)
|
||||||
|
Higher order reducer that wraps scopedLoaderReducer and EntityReducer enhancing single state reducer to support multiple entities with generic loading flags and scopes
Parameters :
Returns :
EntityScopedLoaderState<T>
|
| entitySelector | ||||||
entitySelector(state, id)
|
||||||
|
Parameters :
Returns :
T
|
| epdVisualizationConfigValidator | ||||
epdVisualizationConfigValidator(epdVisualizationConfig)
|
||||
|
Parameters :
Returns :
string | void
|
| invalidUrlMessage | ||||||
invalidUrlMessage(propertyName, url)
|
||||||
|
Parameters :
|
| invalidUrlProtocolMessage | ||||
invalidUrlProtocolMessage(propertyName)
|
||||
|
Parameters :
|
| unconfiguredPropertyMessage | ||||
unconfiguredPropertyMessage(propertyName)
|
||||
|
Parameters :
|
| error | ||||||||||||
error(file, errors, help)
|
||||||||||||
|
Print error
Parameters :
Returns :
void
|
| logUpdatedFile | ||||||
logUpdatedFile(path)
|
||||||
|
Log updated file
Parameters :
Returns :
void
|
| logViolation | |||||||||||
logViolation(file, violation, undefined)
|
|||||||||||
|
Log violation (warning,error) for file
Parameters :
Returns :
void
|
| readJsonFile | ||||||
readJsonFile(path)
|
||||||
|
Read content of json file
Parameters :
Returns :
any
|
| reportProgress | ||||||
reportProgress(message)
|
||||||
|
Log script step
Parameters :
Returns :
void
|
| success | ||||
success(message?)
|
||||
|
Logger when everything was ok
Parameters :
Returns :
void
|
| warning | ||||||||||||
warning(file, warnings, help)
|
||||||||||||
|
Print warning
Parameters :
Returns :
void
|
| extractFields | ||||||
extractFields(data, fields)
|
||||||
|
Extract part of the object described by fields definition
Parameters :
Returns :
T
|
| getObjectPart | ||||||
getObjectPart(data, fields)
|
||||||
|
Parameters :
Returns :
T
|
| mergeFields | ||||||
mergeFields(fields)
|
||||||
|
Merge occ fields parameters
Parameters :
Returns :
string
|
| optimizeFields | ||||
optimizeFields(fields)
|
||||
|
Optimize fields definition by removing not needed groups
Parameters :
Returns :
object
|
| parseFields | ||||||||||||
parseFields(fields, startIndex: number)
|
||||||||||||
|
Parse string field definition to an AST object
Parameters :
Returns :
| object
|
| stringifyFields | ||||
stringifyFields(fields)
|
||||
|
Convert AST object fields definition to string representation
Parameters :
Returns :
string
|
| extractPreviousVersionForChangelog | ||||||
extractPreviousVersionForChangelog(packageVersions, newVersion)
|
||||||
|
Parameters :
|
| fetchPackageVersions | ||||
fetchPackageVersions(npmPackage)
|
||||
|
Parameters :
|
| pkgVersionsPromise | ||||
pkgVersionsPromise(packageName)
|
||||
|
Parameters :
|
| facadeFactory | ||||
facadeFactory(descriptor)
|
||||
|
Factory that will create proxy facade, which is a service that will expose methods and properties from a facade implemented in the lazy loaded module. Returned proxy facade will lazy load the feature and facade implementation at first method call or when first property observable will be subscribed.
Parameters :
Returns :
T
|
| failMeta | |||||||||
failMeta(entityType, error?: any)
|
|||||||||
|
Parameters :
Returns :
LoaderMeta
|
| loadMeta | ||||
loadMeta(entityType)
|
||||
|
Parameters :
Returns :
LoaderMeta
|
| resetMeta | ||||
resetMeta(entityType)
|
||||
|
Parameters :
Returns :
LoaderMeta
|
| successMeta | ||||
successMeta(entityType)
|
||||
|
Parameters :
Returns :
LoaderMeta
|
| fillAndSubmitRegistrationForm |
fillAndSubmitRegistrationForm()
|
| login |
login()
|
| register |
register()
|
| registerUser |
registerUser()
|
| updateUserProfile |
updateUserProfile()
|
| verifyLoginOrRegistrationSuccess |
verifyLoginOrRegistrationSuccess()
|
| verifyProfileUpdateSuccess |
verifyProfileUpdateSuccess()
|
| fillBillingAddress | ||||
fillBillingAddress(billingAddress)
|
||||
|
Parameters :
|
| fillPaymentDetails | ||||||||||||
fillPaymentDetails(paymentDetails, billingAddress?, submitForm: boolean)
|
||||||||||||
|
Parameters :
|
| fillShippingAddress | |||||||||
fillShippingAddress(shippingAddress, submitForm: boolean)
|
|||||||||
|
Parameters :
|
| fillLoginForm | |||
fillLoginForm(undefined)
|
|||
|
Parameters :
|
| fillRegistrationForm | |||||||
fillRegistrationForm(undefined, giveRegistrationConsent, hiddenConsent?)
|
|||||||
|
Parameters :
|
| login | ||||||
login(username, password)
|
||||||
|
Parameters :
|
| register | ||||||||
register(user, giveRegistrationConsent, hiddenConsent?)
|
||||||||
|
Parameters :
|
| findLastIndex | ||||||
findLastIndex(elements, predicate)
|
||||||
|
Parameters :
|
| getSuffixUrlMatcher | |||
getSuffixUrlMatcher(undefined)
|
|||
|
Matches the pattern '[ ** / ] marker / :paramName'
Parameters :
|
| findStoresReducer | ||||||
findStoresReducer(state, action)
|
||||||
|
Parameters :
Returns :
FindStoresState
|
| footerTabbingOrder | ||||
footerTabbingOrder(config)
|
||||
|
Parameters :
|
| forgotPasswordTabbingOrder | ||||
forgotPasswordTabbingOrder(config)
|
||||
|
Parameters :
|
| generateMail | |||||||||
generateMail(alias, newTimestamp: boolean)
|
|||||||||
|
Parameters :
|
| randomString |
randomString()
|
| getAlert |
getAlert()
|
| getErrorAlert |
getErrorAlert()
|
| getSuccessAlert |
getSuccessAlert()
|
| getWarningAlert |
getWarningAlert()
|
| getApparelCheckoutUser |
getApparelCheckoutUser()
|
| getB2bConfiguration |
getB2bConfiguration()
|
|
Returns :
CustomConfig[]
|
| getSpartacusProviders | ||||
getSpartacusProviders(sourceFile)
|
||||
|
Parameters :
Returns :
Node[]
|
| normalizeConfiguration | ||||
normalizeConfiguration(config)
|
||||
|
Parameters :
Returns :
string
|
| getBrowserTransferStateReducer | ||||||||||||
getBrowserTransferStateReducer(transferState, keys, isLoggedIn: boolean)
|
||||||||||||
|
Parameters :
|
| getServerTransferStateReducer | ||||||
getServerTransferStateReducer(transferState, keys)
|
||||||
|
Parameters :
|
| getTransferStateReducer | ||||||||||
getTransferStateReducer(platformId, transferState?, config?, authStatePersistenceService?)
|
||||||||||
|
Parameters :
|
| getCartIdByUserId | ||||||
getCartIdByUserId(cart, userId)
|
||||||
|
Extract cart identifier for current user. Anonymous calls use
Parameters :
Returns :
string
|
| getWishlistName | ||||
getWishlistName(customerId)
|
||||
|
Compute wishlist cart name for customer.
Parameters :
Returns :
string
|
| isCartNotFoundError | ||||
isCartNotFoundError(error)
|
||||
|
Check if the returned error is of type notFound. We additionally check if the cart is not a selective cart. For selective cart this error can happen only when extension is disabled. It should never happen, because in that case, selective cart should also be disabled in our configuration. However if that happens we want to handle these errors silently.
Parameters :
Returns :
boolean
|
| isSelectiveCart | ||||||
isSelectiveCart(cartId: string)
|
||||||
|
Check if cart is selective (save for later) based on id.
Parameters :
Returns :
boolean
|
| isTempCartId | ||||
isTempCartId(cartId)
|
||||
|
What is a temporary cart?
Why we need temporary carts?
Temporary cart life cycle
Parameters :
Returns :
boolean
|
| getConfiguratorReducers |
getConfiguratorReducers()
|
|
Returns :
ActionReducerMap<ConfiguratorState>
|
| getConfiguratorTextfieldReducers |
getConfiguratorTextfieldReducers()
|
| getConstructor | ||||
getConstructor(nodes)
|
||||
|
Parameters :
Returns :
ts.Node
|
| getParams | ||||||
getParams(constructorNode, camelizedParamNames)
|
||||||
|
Parameters :
Returns :
string[]
|
| getSuperNode | ||||
getSuperNode(constructorNode)
|
||||
|
Parameters :
Returns :
ts.Node | undefined
|
| runMigration | |||||||||||||||
runMigration(appTree, schematicRunner, migrationScript, options: object)
|
|||||||||||||||
|
Parameters :
Returns :
Promise<UnitTestTree>
|
| writeFile | ||||||||
writeFile(host, filePath, contents)
|
||||||||
|
Parameters :
Returns :
void
|
| getContextParameterDefault | ||||||
getContextParameterDefault(config, parameter)
|
||||||
|
Helper function for calculating default value for context parameter from config
Parameters :
Returns :
string | undefined
|
| getContextParameterValues | ||||||
getContextParameterValues(config, parameter)
|
||||||
|
Helper function for safely getting context parameter config
Parameters :
Returns :
string[]
|
| getCookie | ||||||
getCookie(cookie, name)
|
||||||
|
Parameters :
|
| getDefaultDeliveryModeCode | ||||||
getDefaultDeliveryModeCode(accessToken, cartId?)
|
||||||
|
Parameters :
|
| getDefaultUrlMatcherFactory | ||||||
getDefaultUrlMatcherFactory(routingConfigService, urlMatcherService)
|
||||||
|
Parameters :
Returns :
UrlMatcherFactory
|
| getEpdVisualizationDefaultConfig |
getEpdVisualizationDefaultConfig()
|
|
Returns :
EpdVisualizationConfig
|
| getGlobMatcher | ||||
getGlobMatcher(patterns)
|
||||
|
For given list of glob-like patterns, returns a matcher function. The matcher returns true for given URL only when ANY of the positive patterns is matched and NONE of the negative ones.
Parameters :
Returns :
boolean
|
| globToRegex | |||||||||
globToRegex(glob, literalQuestionMark)
|
|||||||||
|
Converts the glob-like pattern into regex string. Patterns use a limited glob format:
Parameters :
Returns :
string
|
| processGlobPatterns | ||||
processGlobPatterns(urls)
|
||||
|
Converts list of glob-like patterns into list of RegExps with information whether the glob pattern is positive or negative
Parameters :
Returns :
literal type[]
|
| getItemStatus | ||||
getItemStatus(itemState)
|
||||
|
Parameters :
Returns :
Observable<OrganizationItemStatus<T>>
|
| getLastValueSync | ||||
getLastValueSync(source)
|
||||
|
Will grab last synchronously available value from the observable stream at the time of the call. Should be used with caution, as it's not a legitimate way for getting value from the observable. Observable composition or standard subscribe method should be used for most of the cases.
Parameters :
Returns :
T | undefined
|
| getLoadPath | ||||||
getLoadPath(path, serverRequestOrigin)
|
||||||
|
Resolves the relative path to the absolute one in SSR, using the server request's origin. It's needed, because Angular Universal doesn't support relative URLs in HttpClient. See Angular issues:
Parameters :
Returns :
string
|
| i18nextAddTranslations | ||||||
i18nextAddTranslations(i18next, resources)
|
||||||
|
Parameters :
Returns :
void
|
| i18nextGetHttpClient | ||||||
i18nextGetHttpClient(httpClient)
|
||||||
|
Returns a function appropriate for i18next to make http calls for JSON files.
See docs for It uses Angular HttpClient under the hood, so it works in SSR.
Parameters :
Returns :
void
|
| i18nextInit | ||||||||||||||
i18nextInit(i18next, configInit, languageService, httpClient, serverRequestOrigin, siteContextI18nextSynchronizer)
|
||||||||||||||
|
Parameters :
Returns :
Promise<any>
|
| getMetaTagContent | ||||||
getMetaTagContent(name, meta)
|
||||||
|
Parameters :
|
| mediaServerConfigFromMetaTagFactory | ||||
mediaServerConfigFromMetaTagFactory(meta)
|
||||
|
Parameters :
Returns :
OccConfig
|
| occServerConfigFromMetaTagFactory | ||||
occServerConfigFromMetaTagFactory(meta)
|
||||
|
Parameters :
Returns :
OccConfig
|
| provideConfigFromMetaTags |
provideConfigFromMetaTags()
|
|
Returns :
Provider[]
|
| getNextFocusableElement | ||||||
getNextFocusableElement(elements, activeElementIndex)
|
||||||
|
Parameters :
Returns :
HTMLElement
|
| getPreviousFocusableElement | ||||||
getPreviousFocusableElement(elements, activeElementIndex)
|
||||||
|
Parameters :
Returns :
HTMLElement
|
| getProcessErrorFactory | ||||
getProcessErrorFactory(processId)
|
||||
|
Parameters :
Returns :
MemoizedSelector<StateWithProcess<T>, boolean>
|
| getProcessLoadingFactory | ||||
getProcessLoadingFactory(processId)
|
||||
|
Parameters :
Returns :
MemoizedSelector<StateWithProcess<T>, boolean>
|
| getProcessStateFactory | ||||
getProcessStateFactory(processId)
|
||||
|
Parameters :
Returns :
MemoizedSelector<StateWithProcess<T>, LoaderState<T>>
|
| getProcessSuccessFactory | ||||
getProcessSuccessFactory(processId)
|
||||
|
Parameters :
Returns :
MemoizedSelector<StateWithProcess<T>, boolean>
|
| getProcessState |
getProcessState()
|
| getProductDetailsUrlMatcherFactory | ||||||
getProductDetailsUrlMatcherFactory(service, defaultMatcherFactory)
|
||||||
|
Parameters :
Returns :
UrlMatcherFactory
|
| getProductListingUrlMatcherFactory | ||||||
getProductListingUrlMatcherFactory(service, defaultMatcherFactory)
|
||||||
|
Parameters :
Returns :
UrlMatcherFactory
|
| getProjectTsConfigPaths | ||||||
getProjectTsConfigPaths(tree, project?)
|
||||||
|
Gets all tsconfig paths (or only for specific project) from a CLI project by reading the workspace configuration and looking for common tsconfig locations.
Parameters :
Returns :
literal type
|
| getTargetTsconfigPath | ||||||
getTargetTsconfigPath(project, targetName)
|
||||||
|
Gets the tsconfig path from the given target within the specified project.
Parameters :
Returns :
string | null
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<OrderState, any>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<CheckoutState, any>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducer<GlobalMessageState>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<State>
|
| reducer | |||||||||
reducer(state, action: any)
|
|||||||||
|
Parameters :
Returns :
RouterState
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducer<EntityLoaderState<T>>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<SiteContextState>
|
| getReducers |
getReducers()
|
|
Returns :
ActionReducerMap<ClientAuthState>
|
| getReducersTransitional |
| since 4.2 - use getReducersTransitional_4_2 with order lib instead |
getReducersTransitional()
|
|
Returns :
ActionReducerMap<Partial<UserState>>
|
| getReducersTransitional_4_2 |
getReducersTransitional_4_2()
|
|
Returns :
ActionReducerMap<Partial<UserState>>
|
| getRequestOrigin | ||||
getRequestOrigin(req)
|
||||
|
Parameters :
Returns :
string
|
| getRequestUrl | ||||
getRequestUrl(req)
|
||||
|
Parameters :
Returns :
string
|
| getSampleUser |
getSampleUser()
|
| getServerRequestProviders |
getServerRequestProviders()
|
|
Returns Spartacus providers to be passed to the Angular express engine (in SSR)
Returns :
StaticProvider[]
|
| getStorage | ||||||
getStorage(storageType, winRef)
|
||||||
|
Parameters :
Returns :
Storage | undefined
|
| isSsr | ||||
isSsr(storage)
|
||||
|
Parameters :
Returns :
boolean
|
| persistToStorage | ||||||||||||
persistToStorage(configKey, value: any, storage)
|
||||||||||||
|
Parameters :
Returns :
void
|
| readFromStorage | ||||||
readFromStorage(storage, key)
|
||||||
|
Parameters :
Returns :
unknown
|
| getStructuredDataFactory | ||||
getStructuredDataFactory(injector)
|
||||
|
Factory to build the structure data without any interaction with the UI.
Parameters :
Returns :
void
|
| getTestConfig |
getTestConfig()
|
|
Returns :
EpdVisualizationConfig
|
| getUrl | ||||
getUrl(urlString)
|
||||
|
Parameters :
Returns :
URL | null
|
| isHttpOrHttps | ||||
isHttpOrHttps(url)
|
||||
|
Parameters :
|
| hasPendingProcessesSelector | ||||
hasPendingProcessesSelector(state)
|
||||
|
Parameters :
Returns :
boolean
|
| isStableSelector | ||||
isStableSelector(state)
|
||||
|
Parameters :
Returns :
boolean
|
| headerTabbingOrder |
headerTabbingOrder(config, mobile: boolean, loggedIn: boolean)
|
|
|
| subCategoryTabbingOrder | ||||||||||||
subCategoryTabbingOrder(config, subCategoryName, mobile: boolean)
|
||||||||||||
|
Parameters :
|
| homeTabbingOrder | ||||
homeTabbingOrder(config)
|
||||
|
Parameters :
|
| ignoreCaseSensivity | ||||
ignoreCaseSensivity(base)
|
||||
|
Converts string value to RegExp ignoring case sensivity.
Parameters :
Returns :
RegExp
|
| loginAsMyCompanyAdmin |
loginAsMyCompanyAdmin()
|
|
Login as user with organization administration powers.
Returns :
void
|
| testMyCompanyFeatureFromConfig | ||||
testMyCompanyFeatureFromConfig(config)
|
||||
|
Parameters :
|
| waitForData | ||||||||
waitForData(suffix, thenCommand, waitForCommand)
|
||||||||
|
Parameters :
Returns :
void
|
| initConfigurableRoutes | ||||
initConfigurableRoutes(service)
|
||||
|
Parameters :
Returns :
void
|
| initHtmlDirAttribute | ||||||
initHtmlDirAttribute(directionService, featureConfigService)
|
||||||
|
Parameters :
Returns :
void
|
| initI18nConfig | ||||||
initI18nConfig(configInitializer, config)
|
||||||
|
Parameters :
Returns :
ConfigInitializer | null
|
| initializeBaseSite | ||||
initializeBaseSite(baseSiteInitializer)
|
||||
|
Parameters :
Returns :
void
|
| initializeCurrency | ||||
initializeCurrency(currencyInitializer)
|
||||
|
Parameters :
Returns :
void
|
| initializeLanguage | ||||
initializeLanguage(languageInitializer)
|
||||
|
Parameters :
Returns :
void
|
| initializeContext | ||||||
initializeContext(configInit, siteContextRoutesHandler)
|
||||||
|
Parameters :
Returns :
Promise<Config>
|
| initSeoService | ||||
initSeoService(injector)
|
||||
|
Parameters :
Returns :
void
|
| initSiteContextConfig | ||||||
initSiteContextConfig(configInitializer, config)
|
||||||
|
Initializes the site context config
Parameters :
Returns :
ConfigInitializer | null
|
| initTheme | ||||
initTheme(themeService)
|
||||
|
Parameters :
|
| isCanActivate | ||||||
isCanActivate(guard: any)
|
||||||
|
Parameters :
Returns :
CanActivate
|
| isFunction | ||||||
isFunction(v: any)
|
||||||
|
Parameters :
Returns :
T
|
| isPromise | ||||||
isPromise(obj: any)
|
||||||
|
Parameters :
Returns :
Promise<any>
|
| wrapIntoObservable | ||||
wrapIntoObservable(value)
|
||||
|
Parameters :
Returns :
Observable<T>
|
| isFeatureConfig | ||||
isFeatureConfig(config)
|
||||
|
Parameters :
Returns :
Required<FeaturesConfig>
|
| isFeatureEnabled | ||||||
isFeatureEnabled(config, feature)
|
||||||
|
Parameters :
Returns :
boolean
|
| isFeatureLevel | ||||||
isFeatureLevel(config, level)
|
||||||
|
Parameters :
Returns :
boolean
|
| isInLevel | ||||||
isInLevel(level, version)
|
||||||
|
Parameters :
Returns :
boolean
|
| isImportedFrom | ||||||
isImportedFrom(node, importPath)
|
||||||
|
Parameters :
Returns :
boolean
|
| isImportedFromSpartacusLibs | ||||
isImportedFromSpartacusLibs(node)
|
||||
|
Parameters :
Returns :
boolean
|
| isNotNullable | ||||
isNotNullable(value)
|
||||
|
Parameters :
Returns :
NonNullable<T>
|
| isNotUndefined | ||||
isNotUndefined(value)
|
||||
|
Parameters :
Returns :
T
|
| isObject | ||||||
isObject(item: any)
|
||||||
|
Parameters :
Returns :
boolean
|
| keyboardFocusFactory | ||||
| since 4.2, refer to spartacus issues (#13762) Start keyboard focus services on app initialization. | ||||
keyboardFocusFactory(onNavigateFocusService)
|
||||
|
Parameters :
|
| listenForTokenAuthenticationRequest |
listenForTokenAuthenticationRequest()
|
|
Returns :
string
|
| listenForTokenRevocationRequest |
listenForTokenRevocationRequest()
|
|
Returns :
string
|
| loginAsDefaultUser |
loginAsDefaultUser()
|
| loginUser |
loginUser()
|
| loginWithBadCredentials |
loginWithBadCredentials()
|
| registerUser |
registerUser()
|
|
Use only if you are outside of |
| registerUserFromLoginPage |
registerUserFromLoginPage()
|
|
Use only if you already are on the |
| signOutUser |
signOutUser()
|
| listTest | ||||
listTest(config)
|
||||
|
Parameters :
Returns :
void
|
| loaderErrorSelector | ||||
loaderErrorSelector(state)
|
||||
|
Parameters :
Returns :
boolean
|
| loaderLoadingSelector | ||||
loaderLoadingSelector(state)
|
||||
|
Parameters :
Returns :
boolean
|
| loaderSuccessSelector | ||||
loaderSuccessSelector(state)
|
||||
|
Parameters :
Returns :
boolean
|
| loaderValueSelector | ||||
loaderValueSelector(state)
|
||||
|
Parameters :
Returns :
T
|
| loaderReducer | ||||||
loaderReducer(entityType, reducer?)
|
||||||
|
Higher order reducer that adds generic loading flag to chunk of the state Utilizes "loader" meta field of actions to set specific flags for specific action (LOAD, SUCCESS, FAIL, RESET)
Parameters :
Returns :
LoaderState<T>
|
| loadPackageJson | ||||
loadPackageJson(p)
|
||||
|
Parameters :
|
| login | ||||||||||||
login(uid, password, failOnStatusCode: boolean)
|
||||||||||||
|
Parameters :
|
| retrieveAuthToken |
retrieveAuthToken()
|
| setSessionData | ||||
setSessionData(data)
|
||||
|
Parameters :
|
| loginTabbingOrder | |||||||||
loginTabbingOrder(config, prefillForm: boolean)
|
|||||||||
|
Parameters :
|
| loginUsingUserWithOrder |
loginUsingUserWithOrder()
|
| logOut |
logOut()
|
| userPasswordTest | ||||
userPasswordTest(config)
|
||||
|
Parameters :
Returns :
void
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrate |
migrate()
|
|
Returns :
Rule
|
| migrateComponentMigration | ||||||||
migrateComponentMigration(tree, context, componentData)
|
||||||||
|
Parameters :
Returns :
Tree
|
| migrateConfigDeprecation | ||||||||
migrateConfigDeprecation(tree, _context, configDeprecations)
|
||||||||
|
Parameters :
Returns :
Tree
|
| migrateConstructorDeprecation | ||||||||
migrateConstructorDeprecation(tree, context, constructorDeprecations)
|
||||||||
|
Parameters :
Returns :
Tree
|
| migrateMissingPackage | ||||||||
migrateMissingPackage(tree, context, missingPackageConfig)
|
||||||||
|
Parameters :
Returns :
Tree
|
| migrateRenamedSymbols | ||||||
migrateRenamedSymbols(tree, renamedSymbols)
|
||||||
|
Parameters :
Returns :
Tree
|
| mockTranslate | |||||||||
mockTranslate(key, options: any)
|
|||||||||
|
Parameters :
|
| moduleInitializersFactory | ||||||
moduleInitializersFactory(lazyModuleService, moduleInitializerFunctions)
|
||||||
|
Parameters :
Returns :
any
|
| myAccountTabbingOrder | |||||||||
myAccountTabbingOrder(config, mobile: boolean)
|
|||||||||
|
Parameters :
|
| myInterestTabbingOrder | ||||
myInterestTabbingOrder(config)
|
||||
|
Parameters :
|
| nestedListTest | ||||
nestedListTest(config)
|
||||
|
Parameters :
Returns :
void
|
| normalizeHttpError | ||||
normalizeHttpError(error)
|
||||
|
Normalizes HttpErrorResponse to HttpErrorModel. Can be used as a safe and generic way for embodying http errors into NgRx Action payload, as it will strip potentially unserializable parts from it and warn in debug mode if passed error is not instance of HttpErrorModel (which usually happens when logic in NgRx Effect is not sealed correctly)
Parameters :
Returns :
HttpErrorModel | undefined
|
| notificationPreferenceTabbingOrder | ||||
notificationPreferenceTabbingOrder(config)
|
||||
|
Parameters :
|
| occConfigValidator | ||||
occConfigValidator(config)
|
||||
|
Parameters :
|
| onNavigateFactory | ||||
onNavigateFactory(onNavigateService)
|
||||
|
Parameters :
Returns :
void
|
| orderApprovalsEntitiesReducer | ||||||
orderApprovalsEntitiesReducer(state, action)
|
||||||
|
Parameters :
Returns :
OrderApproval
|
| orderApprovalsListReducer | ||||||
orderApprovalsListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| orderDetailsTabbingOrder | ||||
orderDetailsTabbingOrder(config)
|
||||
|
Parameters :
|
| orderFacadeFactory |
orderFacadeFactory()
|
| orderHistoryNoOrdersTabbingOrder | ||||
orderHistoryNoOrdersTabbingOrder(config)
|
||||
|
Parameters :
|
| orderHistoryWithOrdersTabbingOrder |
orderHistoryWithOrdersTabbingOrder()
|
| orderReturnRequestFacadeFactory |
orderReturnRequestFacadeFactory()
|
| orgUnitAddressListReducer | ||||||
orgUnitAddressListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| orgUnitEntitiesReducer | ||||||
orgUnitEntitiesReducer(state, action)
|
||||||
|
Parameters :
Returns :
B2BUnitNode
|
| orgUnitListReducer | ||||||
orgUnitListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| orgUnitUserListReducer | ||||||
orgUnitUserListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| parseCSV | ||||||
parseCSV(raw, defaultValues)
|
||||||
|
Parameters :
Returns :
string
|
| paymentDetailsTabbingOrder | ||||
paymentDetailsTabbingOrder(config)
|
||||
|
Parameters :
|
| permissionsEntitiesReducer | ||||||
permissionsEntitiesReducer(state, action)
|
||||||
|
Parameters :
Returns :
Permission
|
| permissionsListReducer | ||||||
permissionsListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| permissionTableConfigFactory |
permissionTableConfigFactory()
|
|
Returns :
TableConfig
|
| personalDetailsTabbingOrder | ||||
personalDetailsTabbingOrder(config)
|
||||
|
Parameters :
|
| prepareRepositoryForApiExtractor | |||||||||
prepareRepositoryForApiExtractor(branch, baseCommit)
|
|||||||||
|
Prepare repository with base branch clone for api-extractor
Parameters :
Returns :
Promise<void>
|
| processesDecrementMeta | ||||
processesDecrementMeta(entityType)
|
||||
|
Parameters :
Returns :
ProcessesLoaderMeta
|
| processesIncrementMeta | ||||
processesIncrementMeta(entityType)
|
||||
|
Parameters :
Returns :
ProcessesLoaderMeta
|
| processesLoaderResetMeta | ||||
processesLoaderResetMeta(entityType)
|
||||
|
Parameters :
Returns :
ProcessesLoaderMeta
|
| processesLoaderReducer | ||||||
processesLoaderReducer(entityType, reducer?)
|
||||||
|
Higher order reducer that adds processes count
Parameters :
Returns :
ProcessesLoaderState<T>
|
| productListTabbingOrderDesktop | ||||
productListTabbingOrderDesktop(config)
|
||||
|
Parameters :
|
| productListTabbingOrderMobile | ||||
productListTabbingOrderMobile(config)
|
||||
|
Parameters :
|
| productListTabbingOrderMobileFilters | ||||
productListTabbingOrderMobileFilters(config)
|
||||
|
Parameters :
|
| toggleProductView |
toggleProductView()
|
| productPageTabbingOrder | ||||
productPageTabbingOrder(config)
|
||||
|
Parameters :
|
| productPageTabsTabbingOrder |
productPageTabsTabbingOrder()
|
| productStoreConfigFactory |
productStoreConfigFactory()
|
|
Returns :
StateConfig
|
| provideConfig | |||||||||
provideConfig(config, defaultConfig)
|
|||||||||
|
Helper function to provide configuration chunk using ConfigChunk token To provide default configuration in libraries provideDefaultConfig should be used instead.
Parameters :
Returns :
ValueProvider
|
| provideConfigFactory | ||||||||||||
provideConfigFactory(configFactory, deps?, defaultConfig)
|
||||||||||||
|
Helper function to provide configuration with factory function, using ConfigChunk token To provide default configuration in libraries provideDefaultConfigFactory should be used instead.
Parameters :
Returns :
FactoryProvider
|
| provideDefaultConfig | ||||||
provideDefaultConfig(config)
|
||||||
|
Helper function to provide default configuration chunk using DefaultConfigChunk token
Parameters :
Returns :
ValueProvider
|
| provideDefaultConfigFactory | |||||||||
provideDefaultConfigFactory(configFactory, deps?)
|
|||||||||
|
Helper function to provide default configuration with factory function, using DefaultConfigChunk token
Parameters :
Returns :
FactoryProvider
|
| provideConfigValidator | ||||
provideConfigValidator(configValidator)
|
||||
|
Use to probide config validation at app bootstrap (when all config chunks are merged)
Parameters :
Returns :
Provider
|
| validateConfig | ||||||
validateConfig(config, configValidators)
|
||||||
|
Parameters :
|
| provideOutlet | ||||
provideOutlet(options)
|
||||
|
Helper function to register a component for an outlet.
Parameters :
Returns :
StaticProvider
|
| pwaConfigurationFactory | ||||
pwaConfigurationFactory(pwaConfig)
|
||||
|
Parameters :
Returns :
SwRegistrationOptions
|
| pwaFactory | ||||
pwaFactory(addToHomeScreenService)
|
||||
|
Parameters :
Returns :
any
|
| quickOrderFacadeFactory |
quickOrderFacadeFactory()
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
AsmUi
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ConsignmentTrackingState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
Order
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ReturnRequestList
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
OrderHistoryList
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ReplenishmentOrder
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ReplenishmentOrderList
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
CardTypesState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
CheckoutStepsState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
PaymentTypesState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
OrderTypesState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ConfiguratorTextfield.Configuration
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
boolean
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
boolean
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
AnonymousConsent[]
|
| toggleConsentStatus | ||||||||
toggleConsentStatus(consents, templateCode, status)
|
||||||||
|
Parameters :
Returns :
AnonymousConsent[]
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
NodeItem
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
EntityState<Page>
|
| reducer | ||||
reducer(entityType)
|
||||
|
Parameters :
Returns :
string
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
GlobalMessageState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
BaseSiteState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
CurrenciesState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
LanguagesState
|
| reducer | ||||||
| since 4.2 - use order lib instead | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ConsignmentTrackingState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
BillingCountriesState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
CustomerCouponSearchResult
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
NotificationPreference[]
|
| reducer | ||||||
| since 4.2 - use order lib instead | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
Order
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
DeliveryCountriesState
|
| reducer | ||||||
| since 4.2 - use order lib instead | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ReturnRequestList
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
PaymentDetails[]
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
RegionsState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ProductInterestSearchResult
|
| reducer | ||||||
| since 4.2 - use order lib instead | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ReplenishmentOrder
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
Address[]
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ConsentTemplate[]
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
CostCenter[]
|
| reducer | ||||||
| since 4.2 - use order lib instead | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
OrderHistoryList
|
| reducer | ||||||
| since 4.2 - use order lib instead | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ReplenishmentOrderList
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ProductReferencesState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ProductsSearchState
|
| reducer | ||||||
reducer(state, action)
|
||||||
|
Parameters :
Returns :
ProductReviewsState
|
| registerAndLogin |
registerAndLogin()
|
| registerOutletsFactory | ||||||||
registerOutletsFactory(providedOutletOptions, componentFactoryResolver, outletService)
|
||||||||
|
Parameters :
Returns :
void
|
| registerTabbingOrder | ||||
registerTabbingOrder(config)
|
||||
|
Parameters :
|
| replenishmentOrderFacadeFactory |
replenishmentOrderFacadeFactory()
|
| resolveApplicable | ||||||||||||
resolveApplicable(applicables, matchParams, priorityParams)
|
||||||||||||
|
Helper logic to resolve best matching Applicable Finding best match is a two step process:
Parameters :
Returns :
T | undefined
|
| run | ||||||
run(args, logger)
|
||||||
|
Parameters :
|
| run |
run()
|
| run |
run()
|
| run |
run()
|
| scaffoldAppStructure |
scaffoldAppStructure()
|
|
Returns :
Rule
|
| scopedLoaderReducer | ||||||
scopedLoaderReducer(entityType, reducer?)
|
||||||
|
Higher order reducer designed to add scope support for loader reducer
Parameters :
Returns :
ScopedLoaderState<T>
|
| searchResultsTabbingOrder | ||||
searchResultsTabbingOrder(config)
|
||||
|
Parameters :
|
| selectProductSizeVariant |
selectProductSizeVariant()
|
| selectProductSizeVariantWithoutStock |
selectProductSizeVariantWithoutStock()
|
| selectProductStyleVariant |
selectProductStyleVariant()
|
| verifyContentInReviewTab |
verifyContentInReviewTab()
|
| verifyCorrectTabs |
verifyCorrectTabs()
|
| verifyProductDetails |
verifyProductDetails()
|
| verifyQuantityInCart |
verifyQuantityInCart()
|
| verifyReviewForm |
verifyReviewForm()
|
| verifyTextInTabs |
verifyTextInTabs()
|
| serializePageContext | ||||||||||||
serializePageContext(pageContext, ignoreContentPageId?: boolean)
|
||||||||||||
|
Serializes the provided page context.
The pattern used for serialization is:
Parameters :
Returns :
string
|
| serviceMapFactory |
serviceMapFactory()
|
| setHtmlLangAttribute | ||||||
setHtmlLangAttribute(winRef, languageService)
|
||||||
|
Sets active language in
Parameters :
Returns :
void
|
| signOut |
signOut()
|
| verifyGlobalMessageAfterRegistration |
verifyGlobalMessageAfterRegistration()
|
| siteContextStoreConfigFactory |
siteContextStoreConfigFactory()
|
|
Returns :
StateConfig
|
| skipLinkFactory | ||||||
skipLinkFactory(componentFactoryResolver, outletService)
|
||||||
|
Adds the skip link component before the cx-storefront.
Parameters :
Returns :
void
|
| smartEditFactory | ||||
smartEditFactory(smartEditLauncherService)
|
||||
|
Parameters :
Returns :
void
|
| sortTitles | ||||||
sortTitles(title1, title2)
|
||||||
|
Parameters :
|
| stockNotificationDialogTabbingOrder | ||||
stockNotificationDialogTabbingOrder(config)
|
||||
|
Parameters :
|
| stockNotificationNotLoginTabbingOrder | ||||
stockNotificationNotLoginTabbingOrder(config)
|
||||
|
Parameters :
|
| stockNotificationTabbingOrderNotificationsAllowed | ||||
stockNotificationTabbingOrderNotificationsAllowed(config)
|
||||
|
Parameters :
|
| stockNotificationTabbingOrderNotificationsNotAllowed | ||||
stockNotificationTabbingOrderNotificationsNotAllowed(config)
|
||||
|
Parameters :
|
| stockNotificationTabbingOrderProductSubscribed | ||||
stockNotificationTabbingOrderProductSubscribed(config)
|
||||
|
Parameters :
|
| storeDetailsTabbingOrder | ||||
storeDetailsTabbingOrder(config)
|
||||
|
Parameters :
|
| storesListTabbingOrder | ||||
storesListTabbingOrder(config)
|
||||
|
Parameters :
|
| switchLanguage | ||||
switchLanguage(lang)
|
||||
|
Parameters :
|
| switchSiteContext | ||||||
switchSiteContext(option, label)
|
||||||
|
Parameters :
|
| testActionToEventMapping | |||
testActionToEventMapping(undefined)
|
|||
|
Parameters :
|
| testFeaturesFromConfig | ||||
testFeaturesFromConfig(config)
|
||||
|
Parameters :
|
| tmsFactory | ||||
tmsFactory(service)
|
||||
|
The factory that conditionally (based on the configuration) starts collecting events
Parameters :
Returns :
void
|
| uniteLatest | ||||
uniteLatest(sources)
|
||||
|
uniteLatest is an alternative to combineLatest. The first emission is emitted synchronously (just like combineLatest) and all following emissions are audited and emitted using asapScheduler. It effectively smooths out emissions when multiple sources will emit at the same time: uniteLatest will have only one emission, where combine latest will have more than one (one per source changed).
Parameters :
Returns :
Observable<ReturnTypes<R>>
|
| unitsTableConfigFactory |
unitsTableConfigFactory()
|
|
Returns :
TableConfig
|
| Unnamed function | ||||
Unnamed function(options)
|
||||
|
Parameters :
Returns :
Rule
|
| updateEmailTabbingOrder | ||||
updateEmailTabbingOrder(config)
|
||||
|
Parameters :
|
| updateProfile |
updateProfile()
|
| validateUpdateProfileForm | ||||||||
validateUpdateProfileForm(title, firstName, lastName)
|
||||||||
|
Parameters :
|
| verifyUpdatedProfile |
verifyUpdatedProfile()
|
| updateTest | ||||
updateTest(config)
|
||||
|
Parameters :
|
| userGroupAvailableOrderApprovalPermissionsListReducer | ||||||
userGroupAvailableOrderApprovalPermissionsListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| userGroupAvailablOrgCustomersListReducer | ||||||
userGroupAvailablOrgCustomersListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| userGroupEntitiesReducer | ||||||
userGroupEntitiesReducer(state, action)
|
||||||
|
Parameters :
Returns :
UserGroup
|
| userGroupsListReducer | ||||||
userGroupsListReducer(state, action)
|
||||||
|
Parameters :
Returns :
any
|
| userGroupTableConfigFactory |
userGroupTableConfigFactory()
|
|
Returns :
TableConfig
|
| userTableConfigFactory |
userTableConfigFactory()
|
|
Returns :
TableConfig
|
| ValidateQuantityToCancel | ||||
ValidateQuantityToCancel(control)
|
||||
|
Parameters :
|
| ValidateQuantityToCancel | ||||
ValidateQuantityToCancel(control)
|
||||
|
Parameters :
|
| verifyNewAddress |
verifyNewAddress()
|
| viewAllStoresReducer | ||||||
viewAllStoresReducer(state, action)
|
||||||
|
Parameters :
Returns :
ViewAllStoresState
|
| visitProduct | ||||
visitProduct(productCode)
|
||||
|
Parameters :
|
| waitForOrderToBePlacedRequest | ||||||||||||
waitForOrderToBePlacedRequest(orderNumber?, contentCatalog, currency)
|
||||||||||||
|
Waits until order is available in orders API response.
Parameters :
|
| waitForOrderWithConsignmentToBePlacedRequest | ||||||||||||
waitForOrderWithConsignmentToBePlacedRequest(orderNumber?, contentCatalog, elapsedTime: number)
|
||||||||||||
|
Parameters :
|
| wishlistTabbingOrder | ||||
wishlistTabbingOrder(config)
|
||||
|
Parameters :
|
| withdrawOn | ||||
withdrawOn(notifier)
|
||||
|
Withdraw from the source observable when notifier emits a value Withdraw will result in resubscribing to the source observable Operator is useful to kill ongoing emission transformation on notifier emission
Parameters :
Returns :
OperatorFunction<T, T>
|