mirror of
https://github.com/withastro/astro.git
synced 2025-01-06 22:10:10 -05:00
334948ced2
* Allow integrations to refresh content layer data
This reverts commit 90a862fc94.
* Add test
* Add changeset
* Add wait in test
* Dispose of queue
* Skip if no content layer collections
* Use spaces in markdown
* fix: don't keep data store in node_modules during dev
* Lint
* Fix test
* Apply suggestions from code review
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
* Re-order tests
* Wait for data store
* Lint
* Handle case where Vite already knows about save
---------
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
45 lines
2 KiB
Markdown
45 lines
2 KiB
Markdown
---
|
|
'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 }));
|
|
}
|
|
});
|
|
});
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|