Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[nextjs-xmcloud][sitecore-jss-nextjs] Component Library endpoint #1987

Merged
merged 28 commits into from
Dec 9, 2024

Conversation

art-alexeyenko
Copy link
Contributor

@art-alexeyenko art-alexeyenko commented Nov 29, 2024

Description / Motivation

Extends api/editing/render endpoint with Component Library functionality - so that a single component can be rendered and experimented with.

The implementation has two main parts:

  • REST Component service - retrieves component data for a component with uid, item id and other inputs
  • ComponentLibraryLayout component - renders the component, sends out the component:ready event and handles component updates from component:update event.
  • A dedicated component-library/render route, exclusive to XMCloud, for component library functionality

Some parts of the logic are prepared to be reused for other frameworks.

Please don't merge until release prep for 22.3 begins.

Testing Details

  • Unit Test Added
  • Manual Test/Other (Please elaborate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

@art-alexeyenko art-alexeyenko added the do-not-review PR's not ready for review label Nov 29, 2024
@stasmaxymov
Copy link
Contributor

PR is missing a part with component update listener

@art-alexeyenko art-alexeyenko requested a review from a team December 1, 2024 22:52
@art-alexeyenko art-alexeyenko added do-not-merge and removed do-not-review PR's not ready for review labels Dec 4, 2024
Copy link
Contributor

@illiakovalenko illiakovalenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job, Artem!
See my comments/questions below. I assume that internal document is not updated and because of that I have concerns related to the defined contract, or there is a different issue (or I missed some part)

@art-alexeyenko art-alexeyenko merged commit 5454a42 into dev Dec 9, 2024
1 check passed
@art-alexeyenko art-alexeyenko deleted the feature/jss-4556-render-component branch December 9, 2024 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants