Skip to content

Commit 80ce946

Browse files
tumms2021389tumms2021389
authored
ReadMe update for Release 23.1.11 (#466)
* ReadMe update for Release 23.1.11
1 parent 807cb4c commit 80ce946

File tree

1 file changed

+29
-34
lines changed

1 file changed

+29
-34
lines changed

‎README.md‎

Lines changed: 29 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,13 @@
11
<p align="center"><img width=60% src="docs/media/ReactSDK-Logo.png">
22

3-
# React SDK - Release Announcement - v23.1.10
3+
# React SDK - Release Announcement - v23.1.11
44

5-
This release - **SDK-R v23.1.10** - is **only compatible with Pega Infinity 23**. This release is related to the [**main** branch of the React SDK repository](https://github.com/pegasystems/react-sdk/tree/main).
5+
**SDK-R v23.1.11** is **only compatible with Pega Infinity '23** and is related to the [**release/23.1.11**](https://github.com/pegasystems/react-sdk/tree/release/23.1.11) branch of the React SDK repository.
66
<br>
7-
(If you currently are using the React SDK with Pega Infinity 8.8, update your SDK to
8-
the [SDK-R v8.8.20 - release/8.8.20 branch](https://github.com/pegasystems/react-sdk/tree/release/8.8.20).)
9-
10-
The SDK-R v23.1.10 and v8.8.20 releases allow React SDK users to to take advantage of the latest
11-
[SDK enhancements and fixes noted in **What's New in the SDK?**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/react-sdk-updates.html) including:
127

13-
* Added the use of **TypeScript typedefs** (from @pega/pcore-pconnect-typedefs) to SDK components.
14-
For more information, see [Using type definitions](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/type-definitions-constellation-sdks.html)
15-
* Additional functionality including **RichTextEditor** and **Dynamic Tabs** components and **many-to-many data reference** support
16-
* Updated Cosmos support to cosmos 4 (for custom Constellation components).
17-
* Enhanced security including token storage and item obfuscation support.
18-
* Bug fixes.
19-
* Full set of merged PRs can be found in the [react-sdk-components GitHub repo list of merged PRs](https://github.com/pegasystems/react-sdk-components/pulls?q=is%3Apr+is%3Amerged+base%3Amaster+). This release includes all PRs since (and including) #166 and #230.
8+
**Note**: From **SDK-R v23.1.11** onwards, the main branch will be the development branch for future versions or the latest version of Infinity.
209

10+
The SDK-R v23.1.11 release upgrades the React version to React 17. This release allows React SDK users to to take advantage of the latest SDK enhancements and fixes. For more information, see [ **What's New in SDK-R 23.1.11**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/react-sdk-updates.html).
2111
<br />
2212

2313
This
@@ -28,24 +18,23 @@ about all of the React SDK releases.
2818

2919
## Previous releases
3020

31-
### React SDK - Release Announcement - v8.23.11 - 10 August 2023
32-
33-
This (**main** branch) is the latest version of the React SDK. It is intended to be used with **Infinity 8.8.0+**. If you need to use **Infinity 8.7.***, please use the **release/8.8.10** branch instead of this **main** branch.
34-
35-
This version of the **React SDK** provides many new features that are documented here:
36-
37-
[What's new in the SDK?](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/react-sdk-updates.html) and also outlined below:
21+
### React SDK - Release Announcement - v23.1.10
3822

39-
The following list shows some of the key features and changes in this 8.23.11 release:
23+
The **SDK-R v23.1.10** release is **only compatible with Pega Infinity '23**. This release is related to the [**release/23.1.10**](https://github.com/pegasystems/react-sdk/tree/release/23.1.10) branch of the React SDK repository.
24+
<br>
25+
(If you currently are using the React SDK with Pega Infinity 8.8, update your SDK to
26+
the [SDK-R v8.8.20 - release/8.8.20 branch](https://github.com/pegasystems/react-sdk/tree/release/8.8.20).)
4027

41-
- Added localization support. You can now implement localization in your custom and overridden SDK components.
28+
The SDK-R v23.1.10 and v8.8.20 releases allow React SDK users to to take advantage of the latest SDK enhancements and fixes. For more information, see [**What's New in SDK-R 23.1.10 and SDK-R 8.8.20**](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/react-sdk-updates.html).
4229

43-
- Updated the lint settings in the DX Component Builder to enable publishing custom components with lint errors or warnings. You can modify the lint setting (lintAction) in the sdk-config.json file from “show” to “block” to disable publishing components with lint errors or warnings.
30+
* Added the use of **TypeScript typedefs** (from @pega/pcore-pconnect-typedefs) to SDK components.
31+
For more information, see [Using type definitions](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/type-definitions-constellation-sdks.html)
32+
* Additional functionality including **RichTextEditor** and **Dynamic Tabs** components and **many-to-many data reference** support
33+
* Updated Constellation Design System support to Cosmos 4 (for custom Constellation components).
34+
* Enhanced security including token storage and item obfuscation support.
35+
* Bug fixes.
36+
* Full set of merged PRs can be found in the [react-sdk-components GitHub repo list of merged PRs](https://github.com/pegasystems/react-sdk-components/pulls?q=is%3Apr+is%3Amerged+base%3Amaster+). This release includes all PRs since (and including) #166 and #230.
4437

45-
- Updated support for the following npm packages:
46-
- @pega/react-sdk-components: v8.23.11
47-
- @pega/react-sdk-overrides: v8.23.11
48-
- @pega/dx-component-builder-sdk: v8.23.16
4938

5039
For more information about the react-sdk-components and react-sdk-overrides packages, and enhancements and bug fixes in the packages, click [here](https://github.com/pegasystems/react-sdk-components/blob/master/packages/react-sdk-components/doc/KeyReleaseUpdates.md).
5140

@@ -60,9 +49,15 @@ If you want to continue using the previous release you can checkout [release/8.8
6049

6150
# Overview
6251

63-
The **React SDK** provides Pega customers with the ability to build DX components that connect Pega’s ConstellationJS Engine APIs with a design system other than the Pega [Constellation Design System](https://design.pega.com).
52+
The **React 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.
53+
54+
A DX component consists of the following:
55+
56+
- 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.
57+
- Javascript to integrate component parameters, ConstellationJS client APIs, and alternate design system presentational components.
58+
- Storybook configuration and mocks for integrating with Infinity to facilitate local component testing before publication, configuration, and testing with the Infinity server.
6459

65-
The React SDK differs from out-of-the-box Constellation design system because it provides and demonstrates the use of a React design system that is not the Pega **Constellation** design system. The alternative design system used in this React SDK is [Material UI](https://mui.com/).
60+
The React SDK includes a ConstellationJS to React bridge and sample DX components. The alternative design system used in the React SDK is [Material UI](https://v4.mui.com/). For more information about Constellation SDKs, see the [Constellation SDKs](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/constellation-sdks.html) documentation.
6661

6762
A **summary of the latest updates** to the **@pega/react-sdk-components** and
6863
**@pega/react-sdk-overrides** used by the React SDK can be found in
@@ -74,7 +69,7 @@ A **summary of the latest updates** to the **@pega/react-sdk-components** and
7469

7570
## Pega Infinity Server and Constellation-enabled Application
7671

77-
This version of the React SDK assumes that you have access to a Pega Infinity server (**23.1.0+**) running an application that is configured to run using the Constellation UI service. _(If you need to use Infinity 8.8.*, please use the **release/8.8.20** branch instead of this **main** branch.)_
72+
This version of the React SDK assumes that you have access to a Pega Infinity server (**23.1.0+**) running an application that is configured to run using the Constellation UI service. _(If you need to use Infinity 8.8.x, please use the **release/8.8.20** branch instead of the **release/23.1.11** branch.)_
7873

7974
The **MediaCo** sample application is already configured as a Constellation application and can be found in the React SDK download associated with this repo which is available at [https://community.pega.com/marketplace/components/react-sdk](https://community.pega.com/marketplace/components/react-sdk). The OAuth 2.0 Client Registration records associated with the **MediaCo** application are available in the same React SDK download. For more information about the MediaCo sample application, see [MediaCo sample application](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/mediaco-sample-application.html).
8075

@@ -92,15 +87,15 @@ Future updates to the SDK will support more recent LTS versions of node as Const
9287

9388
---
9489
# Installing and Running the Application
95-
The following procedures provide an overview of installing Constellation SDKs and running the application. For detailed documentation, see [Installing and configuring Constellation SDKs](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/installing-configuring-constellation-sdks.html).
90+
The following procedures provide an overview of installing Constellation SDKs and running the application. For more information, see [Installing and configuring Constellation SDKs](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/installing-configuring-constellation-sdks.html).
9691

9792
# Developing with the SDKs
9893
You can find more details on how to integrate the latest React SDK into your development workflow and also instructions on the new using the new DX Component Builder for SDK features.
9994

100-
see [Development](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/development.html)
95+
For more information, see [Development](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/development.html).
10196

10297
# Troubleshooting
103-
Stuck? Look at our [Troubleshooting Constellation SDKs](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/troubleshooting-constellation-sdks.html) which covers resolutions for most of the common problems.
98+
If you are facing any issues, please see [Troubleshooting Constellation SDKs](https://docs.pega.com/bundle/constellation-sdk/page/constellation-sdks/sdks/troubleshooting-constellation-sdks.html).
10499

105100

106101
---

0 commit comments

Comments
 (0)