@bb-cli/schematics

Backbase Schematics

Backbase provides a @bb-cli/schematics NPM package, which contains a collection of Angular Schematics. These can be used to transform your project by generating or modifying code.

This section provides reference information to scaffold the following:

• Backbase Project
• Application
• Bundle
• Widget
• UI Component
• Library
• Theme

Backbase Project

npm run ng -- generate ng-new <name> [-dir|--directory=<directory>] [--npm-scope=<npm-scope>] [--version=<version>] [-p|--prefix=<prefix>] [--registry=<registry>] [--skip-install=<true|false>]

Arguments

Argument	Description
<name>	Project name

Options

Option	Description
--directory=<directory>	The directory name to create the project in Aliases: -dir
--npm-scope=<npm-scope>	Npm scope for importing libs
--version=<version>	The version of the module Default: 1.0.0
--prefix=<prefix>	The prefix to apply to generated component & decorator selectors Default: bb Aliases: -p
--registry=<registry>	Npm registry for @backbase scoped packages Default: https://repo.backbase.com/artifactory/api/npm/npm-backbase/
--skip-install=<true|false>	When true, does not install dependency packages

Application

npm run ng -- generate app <name> [--project-root=<project-root>] [-s|--inline-style=<true|false>] [-t|--inline-template=<true|false>] [--view-encapsulation=<Emulated|Native|None|ShadowDom>] [-S|--skip-tests=<true|false>] [--skip-package-json=<true|false>]

Arguments

Argument	Description
<name>	The name of the application

Options

Option	Description
--project-root=<project-root>	The root directory of the new application
--inline-style=<true|false>	Specifies if the style will be in the ts file Default: true Aliases: -s
--inline-template=<true|false>	Specifies if the template will be in the ts file Aliases: -t
--view-encapsulation=<Emulated|Native|None|ShadowDom>	The view encapsulation strategy to use in the new app.
--skip-tests=<true|false>	Skip creating spec files Default: true Aliases: -S
--skip-package-json=<true|false>	Do not add dependencies to package.json

Bundle

npm run ng -- generate bundle  [--project=<project>] [--strategy=<single|per-spa|per-route>] [--depth=<depth>] [--portal-protocol=<portal-protocol>] [--portal-host=<portal-host>] [--portal-port=<portal-port>] [--portal-context=<portal-context>] [--portal-version=<portal-version>] [--auth-type=<auth-type>] [--portal-username=<portal-username>] [--portal-password=<portal-password>] [--portal-auth-path=<portal-auth-path>] [--ropc-identity-provider=<ropc-identity-provider>] [--ropc-client-id=<ropc-client-id>] [--ropc-scope=<ropc-scope>] [--ropc-client-secret=<ropc-client-secret>] [--model-files=<model-files>]

Options

Option	Description
--project=<project>	The name of the project.
--strategy=<single|per-spa|per-route>	The bundling strategy to use. Should be one of 'single', 'per-spa', or 'per-route'.
--depth=<depth>	For the per-route strategy only, how deep into the routing tree to split into bundles (defaults to max depth)
--portal-protocol=<portal-protocol>	Protocol of the URL identifying Backbase server
--portal-host=<portal-host>	Host name of the URL identifying Backbase server
--portal-port=<portal-port>	Port of the URL identifying Backbase server
--portal-context=<portal-context>	Application context of the Backbase server
--portal-version=<portal-version>	Portal version (5, 6, 6.1)
--auth-type=<auth-type>	The type of authentication mechanism to use. The default is 'basic' for legacy Backbase Authentication Services, using basic Auth. Use 'ropc' for Backbase Identity and Access Management (or other compatible Identity Provider. See the online Backbase Documentation for more details.
--portal-username=<portal-username>	Username
--portal-password=<portal-password>	Password
--portal-auth-path=<portal-auth-path>	Authorization path (for basic auth only)
--ropc-identity-provider=<ropc-identity-provider>	Full URL of the identity provider for ROPC auth
--ropc-client-id=<ropc-client-id>	A unique string that was used when registering the CLI as a client
--ropc-scope=<ropc-scope>	The scope of the access request
--ropc-client-secret=<ropc-client-secret>	Usually optional, a secret/password assigned to the client in the Identity Provider config when the CLI was registered as a client'
--model-files=<model-files>	comma seprated json files that contains page model

Widget

npm run ng -- generate widget <name> [--item-name=<item-name>] [--inline-template=<true|false>] [--npm-scope=<npm-scope>] [--public=<true|false>] [--spec=<true|false>] [--project=<project>]

Arguments

Argument	Description
<name>	The name of the module

Options

Option	Description
--item-name=<item-name>	The name of the backbase application item
--inline-template=<true|false>	Include template inline in the component.ts file
--npm-scope=<npm-scope>	Npm scope of the package
--public=<true|false>	Whether this library needs to be published to an NPM registry (in Angular Package Format). This is only required to share this library with a project outside of this repository
--spec=<true|false>	Specifies if a spec file is generated
--project=<project>	Project to add widget to

UI Component

npm run ng -- generate ui-component <name> <lib> 

Arguments

Argument	Description
<name>	The name of the component
<lib>	The library name which the component is going to be a part of

Library

npm run ng -- generate library <name> [--version=<version>] [--project=<project>] [--npm-scope=<npm-scope>] [--public=<true|false>] [-np|--no-project=<true|false>] [--skip-test=<true|false>] [--skip-lint=<true|false>]

Arguments

Argument	Description
<name>	The name of the module

Options

Option	Description
--version=<version>	The version of the module (for public) Default: 1.0.0
--project=<project>	Project to add the library to
--npm-scope=<npm-scope>	Npm scope of the package
--public=<true|false>	Whether this library needs to be published to an NPM registry (in Angular Package Format) - this is only required to share this library with a project outside of this repository
--no-project=<true|false>	The option to skip the step where library is added to the project Aliases: -np
--skip-test=<true|false>	The option to skip test architect
--skip-lint=<true|false>	The option to skip lint architect

Theme

npm run ng -- generate theme  [--name=<name>] [--project-name=<project-name>] [--theme-version=<theme-version>]

Options

Option	Description
--name=<name>	Theme name. Defaults to 'backbase-theme' Default: backbase-theme
--project-name=<project-name>	Project name. If not provided the defaultProject inside angular.json will be selected.
--theme-version=<theme-version>	The version of the Backbase Theme to create from, defaults to 'latest' Default: latest