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.

Sign up for GitHub

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

Jump to bottom

Edit EMA: JavaScript SDK Libraries #27106

Closed
5 tasks done
Tracked by #26644
fmontes opened this issue Dec 23, 2023 · 0 comments · Fixed by #27107
Closed
5 tasks done
Tracked by #26644

Edit EMA: JavaScript SDK Libraries #27106

fmontes opened this issue Dec 23, 2023 · 0 comments · Fixed by #27107
Assignees
@fmontes
Labels
OKR : Core Features Owned by Will Priority : 3 Average QA : Not Needed Team : Lunik Type : New Functionality

Comments

@fmontes
Copy link
Member

fmontes commented Dec 23, 2023 •
edited
Loading

Parent

#26644

User Story

As a dotCMS developer, I want an official JavaScript for interacting with dotCMS APIs, which will enable me to seamlessly render pages using various JavaScript frameworks and utilize dotCMS as the data source.

Acceptance Criteria
Beta Give feedback

Proposed Objective

Core Features

Proposed Priority

Priority 3 - Average

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

N/A

Assumptions & Initiation Needs

  • These 3 libraries are more or less coded into our nextjs example in core/ema/nextjs we need to pull the code from there into Nx Libraries and publish to npm.
  • For development mode, we can use npm link and make sure that core/ema/nextjs still works as expected.

Quality Assurance Notes & Workarounds

N/A
@fmontes fmontes mentioned this issue Dec 23, 2023
Closed
@fmontes fmontes linked a pull request Dec 23, 2023 that will close this issue
feat(edit-ema): Add JavaScript SDK libraries #27106 #27107
Merged
3 tasks
@fmontes fmontes self-assigned this Dec 27, 2023
github-merge-queue bot pushed a commit that referenced this issue Jan 3, 2024
@fmontes
feat(edit-ema): Add JavaScript SDK libraries #27106 (#27107)
24d0f8e 
* render contentlet angular container

* Add plus buttons

* Add contentlet from new button in top/bottom position

* Add scroll event to hide

* Detect the contentlet target if the chindren is pointerenter

* Fix set position button

* Add actions, edit and delete

* Clean up and doc

* Clean up dropzone

* Add form selector

* Clean up

* Fix bad animation in template builder load

* Update env example

* Align top button to left if the width is smaller than 250

* Add min width to menu

* Sort action buttons

* Move toolbar into shell folder

* Fix should open a confirm dialog and save on confirm

* Fix should add contentlet

* Fix should open a dialog and save after backend emit

* Fix should add contentlet after backend emit SAVE_CONTENTLET

* Green ema editor tests

* Test EmaContentletToolsComponent

* Update listener in the edit ema

* Refix EditEmaEditorComponent

* Fix SQ

* Fix SQ

* Add form to page

* Code review feedback

* Fix should get content by types

* Fix EditEmaStore

* Fix test with newcontentletid

* Fix EmaFormSelectorComponent

* Create custom pipe

* Fix SQ

* Add message keys in add options

* Fix menu options tests

* Add message to form selector

* Fix messages

* Add client sdk

* react

* move client

* Test libraries

* Add rows column and start with containers

* React lib in progress

* Add page

* Render basic page using npm lib

* Render contentlets from context

* Extract effects to custom hooks

* clean up

* Clean up

* Clean up

* Simplify the react lib

* Clean up

* Fetch data from @dotcms/client

* Change the builder of the client sdk to get declarations

* Improve error and add some docs

* packagejson

* Add nextjs sdk

* Clean up

* Remove core-web prettier

* Clean up

* Clean up

* Clean up

* Clean up

* Clean up

* Clean up

* Update nextjs

* Clean up

* Test sdk client

* Fix tests

* Refactor DotCmsClient to use personaId instead of com.dotmarketing.persona.id

* Add more use cases to client sdk

* Add tests for row in sdk react

* Add column tests in sdk react

* Run container tests in react sdk

* Clean up container tests

* Run tests in DotcmsPage react sdk

* Run tests for PageProvider react sdk

* Tests for hooks in react sdk

* Run the tests for utils in react sdk

* Skip DotcmsPage in nextjs

* Add nextjs to run nextjs sdk tests

* Run dotcms-page nextjs sdk

* Rename to DotcmsPage nextjs sdk

* Rename file cases

* Fix SQ

* Fix react sdk tests

* FIx case folder

* More SQ fixes

* Fix tests

* Rename Row folder

* Rename Row.tsx

* Rename Column

* Rename Container.spec

* Fix react sdk tests

* Rename container

* Refactor Container.spec.tsx import paths and update mock data

* Rename Column

* Fix casing

* try to fix tests

* try to fix tests

* Update PageContext import and remove unused imports

* Some docs

* Move the client enums to the client lib

* Move the enums to the client

* Add some docs

* Add some more docs

* Improve typedoc

* Unify post message event

* Clean up

* Add tests to postMessageToEditor

* FIx origin

* Fix peerdeps

* Rename to DotcmaLayout

* Can't pass origin at this point

* Unify hooks

* Fix tests

* Fix test

* Extract onPointerEnterHandler

* Update doc

* Refactor DotCmsClient class to improve query parameter handling

* Add maxContentlets property to container interface

* Add peer deps

* Add peer deps

* Refactor page context and layout components

* Update @dotcms/client library docs

* Update @dotcms/react doc and package

* Update @dotcms/nextjs library and add documentation

* Fix dupe sq warn

* Add mockPageContext to index.ts and update Container.spec.tsx

* Add styleClass to rows and columns

* Class columns

* Update DotcmsLayout.spec.tsx and index.ts

* Add support for TypeScript React components in code coverage

* Add usePageEditor tests and fix reload behavior

* Fix package repo url

* Manu feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fmontes fmontes

Labels
OKR : Core Features Owned by Will Priority : 3 Average QA : Not Needed Team : Lunik Type : New Functionality
Projects
dotCMS - Product Planning
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(edit-ema): Add JavaScript SDK libraries #27106 dotCMS/core
1 participant
@fmontes