Summary

This library is a framework agnostic implementation for common container types coming from the Pega Constellation Core library. For detailed documentation, see the API specification.

Installation

npm install @labb/dx-engine

Versioning is based on <major.minor.patch>, where:

• major: the major version of Pega that is used
• minor: the minor version of Pega that is used
• patch: the version of updates to the library itself

The library works together with Pega's constellation core. Make sure the correct versions of that libraries is installed as well.

npm install @pega/constellationjs

Features

Container management

This library is responsible for managing the containers as defined by Pega's constellation core. The library will listen for state changes to each container and update the properties accordingly. Different type of containers can have different functionality during initialization or after state changes. This functionality is implemented for the following container types:

• Attachment
• DeferLoad
• FlowContainer
• ModalViewContainer
• Reference
• Region
• RootContainer
• SimpleTable
• ViewContainer
• View

Constellation Bootstrapping

To load the constellation core in the browser and setup initial communication with the Pega server, a set of precise and specific steps need to be performed. To avoid errors and mistakes in this bootstrapping process, an easy to use BootstrapService is provided.

OAuth2 authentication

After the constellation core and the DX Egine are bootstrapped, the application is ready for communication with the Infinity server using the DX API's. The first step in this communication is retrieving a valid access token. To work together with the OAuth2 client registrations in Pega, a OAuth2 authentication service is provided by the DX Engine. Using this service it is possible to retrieve a token using the credentials or the authorization code (with or without PKCE) flows.

API documentation

For detailed documentation, see the API specification.