puck icon indicating copy to clipboard operation
puck copied to clipboard

resolveAllData has deprecated APIs

Open chrisvxd opened this issue 10 months ago • 6 comments

Description

The resolveAllData function includes APIs that were previously used to manage component load state internally. These APIs weren't intended to be exposed, but they ended up being included in the exported functions.

Loading states are now handled differently and these APIs are no longer used internally. However, since they're publicly available, users have started relying on them to track when each node is resolving in the tree while executing resolveAllData.

Since they weren't originally meant to be exposed, they are currently undocumented. We should document them to better support their usage and maintenance.

chrisvxd avatar Feb 17 '25 10:02 chrisvxd

I'm wondering if resolveAllData will be deprecated in major or minor version. Now the document explains it.

https://puckeditor.com/docs/api-reference/functions/resolve-all-data

ojj1123 avatar May 05 '25 04:05 ojj1123

actually i'm using this api for excuting all resolveData at once.

ojj1123 avatar May 05 '25 04:05 ojj1123

Hey @ojj1123! No, it won't be deprecated. It's a very important part of the Puck API for React Server Components and overall usage. This refers to some parameters that resolveAllData is receiving but aren't documented (onResolveStart and onResolveEnd). You're most likely not using them.

FedericoBonel avatar May 05 '25 04:05 FedericoBonel

We should probably mark onResolveStart and onResolveEnd as deprecated to give people time to migrate before removing them.

FedericoBonel avatar Jul 21 '25 04:07 FedericoBonel

@FedericoBonel we're keeping these APIs. Please update this to a documentation ticket.

chrisvxd avatar Oct 22 '25 08:10 chrisvxd

@FedericoBonel we're keeping these APIs. Please update this to a documentation ticket.

Done!

FedericoBonel avatar Oct 23 '25 03:10 FedericoBonel