summaryrefslogtreecommitdiff
path: root/.changeset/curvy-walls-kneel.md
diff options
context:
space:
mode:
Diffstat (limited to '.changeset/curvy-walls-kneel.md')
-rw-r--r--.changeset/curvy-walls-kneel.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/.changeset/curvy-walls-kneel.md b/.changeset/curvy-walls-kneel.md
new file mode 100644
index 000000000..dc04cb0af
--- /dev/null
+++ b/.changeset/curvy-walls-kneel.md
@@ -0,0 +1,45 @@
+---
+'astro': patch
+---
+
+Adds a new function `refreshContent` to the `astro:server:setup` hook that allows integrations to refresh the content layer. This can be used, for example, to register a webhook endpoint during dev, or to open a socket to a CMS to listen for changes.
+
+By default, `refreshContent` will refresh all collections. You can optionally pass a `loaders` property, which is an array of loader names. If provided, only collections that use those loaders will be refreshed. For example, A CMS integration could use this property to only refresh its own collections.
+
+You can also pass a `context` object to the loaders. This can be used to pass arbitrary data, such as the webhook body, or an event from the websocket.
+
+```ts
+ {
+ name: 'my-integration',
+ hooks: {
+ 'astro:server:setup': async ({ server, refreshContent }) => {
+ server.middlewares.use('/_refresh', async (req, res) => {
+ if(req.method !== 'POST') {
+ res.statusCode = 405
+ res.end('Method Not Allowed');
+ return
+ }
+ let body = '';
+ req.on('data', chunk => {
+ body += chunk.toString();
+ });
+ req.on('end', async () => {
+ try {
+ const webhookBody = JSON.parse(body);
+ await refreshContent({
+ context: { webhookBody },
+ loaders: ['my-loader']
+ });
+ res.writeHead(200, { 'Content-Type': 'application/json' });
+ res.end(JSON.stringify({ message: 'Content refreshed successfully' }));
+ } catch (error) {
+ res.writeHead(500, { 'Content-Type': 'application/json' });
+ res.end(JSON.stringify({ error: 'Failed to refresh content: ' + error.message }));
+ }
+ });
+ });
+ }
+ }
+}
+```
+