Skip to content

The Angular SDK is designed to provide customers with a bridge from the Constellation JavaScript Engine (which is not open sourced) via Angular. This is important for clients who do not want to the use the out-of-the-box React-based implementation of Constellation. The SDK provides implementations of many container and presentation components wr…

License

Notifications You must be signed in to change notification settings

pegasystems/angular-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Angular SDK - Release Announcement - v24.1.10

The SDK-A v24.1.10 release is only compatible with Pega Infinity '24.1. This release is available in the release/24.1.10 branch of the Angular SDK repository.

Note: The main branch is the active development branch for future versions of Angular SDK.

The SDK-A v24.1.10 release upgrades the Angular version to 17 and the Angular Material version to 17. This release allows Angular SDK users to take advantage of the latest SDK enhancements and fixes. For more information, see What's new in SDK-A 24.1.10.

This Angular SDK updates page provides details about all of the Angular SDK releases.


IMPORTANT: If you are upgrading from a previous version of Angular SDK, please follow the guidelines documented in Upgrading Angular SDK.


Overview

The Angular SDK combined with Pega's client orchestration APIs (ConstellationJS APIs) provides a guided iterative development workflow experience. This accelerates integrating Pega’s Constellation DX API with an alternative (non-Pega) UI. Integrating an alternative design system is achieved using DX Components.

A DX component consists of the following:

  • Component definition metadata that defines the low code developer configuration experience in App Studio and the parameters passed to the DX component for runtime rendering.
  • Javascript to integrate component parameters, ConstellationJS client APIs, and alternate design system presentational components.
  • Storybook configuration and mocks for integrating with Infinity to facilitate local component testing before publication, configuration, and testing with the Infinity server.

The Angular SDK includes a ConstellationJS to Angular bridge and sample DX components. The alternative design system used in the Angular SDK is Angular Material. For more information about Constellation SDKs, see the Constellation SDKs documentation.

Prerequisites

Pega Infinity Server and Constellation architecture-enabled Application

This version of the Angular SDK assumes that you have access to a Pega Infinity server (24.1.0+) running an application that is configured to run using the Constellation UI service.

  • If you need to use Infinity 23.1.x, please use the release/23.1.10 branch.
  • If you need to use Infinity 8.8.x, please use the release/8.8.10 branch.

The MediaCo sample application is already configured as a Constellation architecture-based application and can be found in the Angular SDK download associated with this repo which is available in the Angular SDK Pega Marketplace page. The OAuth 2.0 Client Registration records associated with the MediaCo application are available in the same Angular SDK download. For more information about the MediaCo sample application, see MediaCo sample application.

The Angular SDK has been tested with:

  • node 20.12.1
  • npm 10.5.0

Future updates to the SDK will support more recent LTS versions of node as the Constellation architecture supports them.

Before installing and running the SDK code, refer to the Angular SDK Guide in the Pega Marketplace for the procedure to prepare your Infinity server and node environment so you can proceed with the steps in the next section.



Troubleshooting

If you are facing any issues, please see Troubleshooting Constellation SDKs.


License

This project is licensed under the terms of the Apache 2 license.

You can see the full license here or directly on apache.org.



Contributing

We welcome contributions to the Angular SDK project.

Refer to our guidelines for contributors if you are interested in contributing to the project.



Additional Resources

About

The Angular SDK is designed to provide customers with a bridge from the Constellation JavaScript Engine (which is not open sourced) via Angular. This is important for clients who do not want to the use the out-of-the-box React-based implementation of Constellation. The SDK provides implementations of many container and presentation components wr…

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published