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

SDK: Export Essenstial Interface in @dotcms/react for TypeScript Implementation #31221

Closed
1 task
rjvelazco opened this issue Jan 24, 2025 · 2 comments
Closed
1 task

Comments

@rjvelazco
Copy link
Contributor

rjvelazco commented Jan 24, 2025

Parent Issue

#30943

Task

Currently, we don't have @dotcms/types, which is why we need to export all the necessary interfaces in the @dotcms/react package. This will help us define all the required interfaces to build a React SPA with dotCMS using TypeScript. Below is a list of interfaces we should support:

  • DotCMSPageAsset
  • DotCMSPageAssetContainer
  • DotCMSLayout
  • DotCMSPage
  • DotCMSSite
  • DotCMSTemplate
  • DotCMSViewAs

By including these interfaces, we ensure better type safety and a smoother development experience when integrating React and TypeScript with dotCMS.

Proposed Objective

Technical User Experience

Proposed Priority

Priority 3 - Average

Acceptance Criteria

Tasks

Preview Give feedback

Important

There's no need to create a NextJS with TS example but it would be a NICE TO HAVE

@rjvelazco rjvelazco changed the title SDK: Export Essenstial Interface for TypeScritp Implementation SDK: Export Essenstial Interface in @dotcms/react for TypeScript Implementation Jan 24, 2025
@rjvelazco
Copy link
Contributor Author

@fmontes, should we consider putting effort into creating @dotcms/types? This way, we can share interfaces across the SDKs, ensuring they remain synchronized and consistent.

@rjvelazco
Copy link
Contributor Author

Closed in favor of: #31225

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

1 participant