From 3a2a1d3ba21b3fae1e4f5a9e445c01c828d9dbf9 Mon Sep 17 00:00:00 2001 From: amosmurmu Date: Fri, 9 May 2025 21:09:01 +0530 Subject: [PATCH 1/4] docs: update extension events --- content/guides/9.extensions/2.api-extensions/1.hooks.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/guides/9.extensions/2.api-extensions/1.hooks.md b/content/guides/9.extensions/2.api-extensions/1.hooks.md index 3b72ab00..6fbdf16f 100644 --- a/content/guides/9.extensions/2.api-extensions/1.hooks.md +++ b/content/guides/9.extensions/2.api-extensions/1.hooks.md @@ -93,6 +93,9 @@ The context object has the following properties: | `auth.update`[2] | The updated auth token[3]. | `identifier`, `provider`, `providerPayload` | | `authenticate` | The empty accountability object. | `req` | | `email.send` | The email payload. | | +| `extensions.load` | The extensions payload. | `payload` | +| `extensions.unload` | The extensions payload. | `payload` | +| `extensions.reload` | The extensions payload. | `payload`, `added` , `removed` | | `(.)items.query` | The items query. | `collection` | | `(.)items.read` | The read item. | `query`, `collection` | | `(.)items.create` | The new item. | `collection` | From 527e80f13e71e015bc9f22981522a27098940dc2 Mon Sep 17 00:00:00 2001 From: amosmurmu Date: Tue, 20 May 2025 18:10:16 +0530 Subject: [PATCH 2/4] chore: update docs for new events --- .../9.extensions/2.api-extensions/1.hooks.md | 46 ++++++++++--------- 1 file changed, 24 insertions(+), 22 deletions(-) diff --git a/content/guides/9.extensions/2.api-extensions/1.hooks.md b/content/guides/9.extensions/2.api-extensions/1.hooks.md index 6fbdf16f..23729ab2 100644 --- a/content/guides/9.extensions/2.api-extensions/1.hooks.md +++ b/content/guides/9.extensions/2.api-extensions/1.hooks.md @@ -16,13 +16,13 @@ The `index.js` or `index.ts` file exports a function that is read by Directus. I ```js export default ({ filter, action }) => { - filter('items.create', () => { - console.log('Creating Item!'); - }); + filter('items.create', () => { + console.log('Creating Item!'); + }); - action('items.create', () => { - console.log('Item created!'); - }); + action('items.create', () => { + console.log('Item created!'); + }); }; ``` @@ -55,10 +55,10 @@ Filter events are called before an event is emitted. ```js export default ({ filter }) => { - filter('items.create', (payload, meta, context) => { - console.log('About to create item.'); + filter('items.create', (payload, meta, context) => { + console.log('About to create item.'); return payload; - }); + }); } ``` @@ -93,9 +93,6 @@ The context object has the following properties: | `auth.update`[2] | The updated auth token[3]. | `identifier`, `provider`, `providerPayload` | | `authenticate` | The empty accountability object. | `req` | | `email.send` | The email payload. | | -| `extensions.load` | The extensions payload. | `payload` | -| `extensions.unload` | The extensions payload. | `payload` | -| `extensions.reload` | The extensions payload. | `payload`, `added` , `removed` | | `(.)items.query` | The items query. | `collection` | | `(.)items.read` | The read item. | `query`, `collection` | | `(.)items.create` | The new item. | `collection` | @@ -129,9 +126,9 @@ Actions events are called after an event is emitted. ```js export default ({ action }) => { - action('items.create', (meta, context) => { - console.log('Item was just created.'); - }); + action('items.create', (meta, context) => { + console.log('Item was just created.'); + }); } ``` @@ -169,6 +166,11 @@ The context object has the following properties: | `response` | `request`, `response`, `ip`, `duration`, `finished` | | `auth.login` | `payload`, `status`, `user`, `provider` | | `files.upload` | `payload`, `key`, `collection` | +| `extensions.load` | `payload` | +| `extensions.unload` | `payload` | +| `extensions.reload` | `payload`, `added` , `removed` | +| `extensions.installed` | `payload` | +| `extensions.uninstalled` | `payload` | | `(.)items.read` | `payload`, `query`, `collection` | | `(.)items.create` | `payload`, `key`, `collection` | | `(.)items.update` | `payload`, `keys`, `collection` | @@ -190,9 +192,9 @@ Init events are called during the Directus application lifecycle. ```js export default ({ init }) => { - init('routes.before', (meta) => { - console.log(meta); - }); + init('routes.before', (meta) => { + console.log(meta); + }); }; ``` @@ -221,9 +223,9 @@ Schedule events are called on a defined time interval. ```js export default ({ schedule }) => { - schedule('*/15 * * * *', () => { - console.log('15 minutes have passed.'); - }); + schedule('*/15 * * * *', () => { + console.log('15 minutes have passed.'); + }); }; ``` @@ -247,7 +249,7 @@ The embed hook injects custom JavaScript or CSS into the `` and `` t ```js export default ({ embed }) => { - embed('body', ''); + embed('body', ''); }; ``` From 739c0946b28fb2cae1ab0718b64b185d703dd3fe Mon Sep 17 00:00:00 2001 From: ian Date: Tue, 20 May 2025 20:53:07 +0800 Subject: [PATCH 3/4] Remove unnecessary changes --- .../9.extensions/2.api-extensions/1.hooks.md | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/content/guides/9.extensions/2.api-extensions/1.hooks.md b/content/guides/9.extensions/2.api-extensions/1.hooks.md index 23729ab2..79178dfa 100644 --- a/content/guides/9.extensions/2.api-extensions/1.hooks.md +++ b/content/guides/9.extensions/2.api-extensions/1.hooks.md @@ -16,13 +16,13 @@ The `index.js` or `index.ts` file exports a function that is read by Directus. I ```js export default ({ filter, action }) => { - filter('items.create', () => { - console.log('Creating Item!'); - }); + filter('items.create', () => { + console.log('Creating Item!'); + }); - action('items.create', () => { - console.log('Item created!'); - }); + action('items.create', () => { + console.log('Item created!'); + }); }; ``` @@ -55,10 +55,10 @@ Filter events are called before an event is emitted. ```js export default ({ filter }) => { - filter('items.create', (payload, meta, context) => { - console.log('About to create item.'); + filter('items.create', (payload, meta, context) => { + console.log('About to create item.'); return payload; - }); + }); } ``` @@ -126,9 +126,9 @@ Actions events are called after an event is emitted. ```js export default ({ action }) => { - action('items.create', (meta, context) => { - console.log('Item was just created.'); - }); + action('items.create', (meta, context) => { + console.log('Item was just created.'); + }); } ``` @@ -192,9 +192,9 @@ Init events are called during the Directus application lifecycle. ```js export default ({ init }) => { - init('routes.before', (meta) => { - console.log(meta); - }); + init('routes.before', (meta) => { + console.log(meta); + }); }; ``` @@ -223,9 +223,9 @@ Schedule events are called on a defined time interval. ```js export default ({ schedule }) => { - schedule('*/15 * * * *', () => { - console.log('15 minutes have passed.'); - }); + schedule('*/15 * * * *', () => { + console.log('15 minutes have passed.'); + }); }; ``` @@ -249,7 +249,7 @@ The embed hook injects custom JavaScript or CSS into the `` and `` t ```js export default ({ embed }) => { - embed('body', ''); + embed('body', ''); }; ``` From 7bff529b6294a6be298407c16eba966b2d89f8d0 Mon Sep 17 00:00:00 2001 From: ian Date: Tue, 20 May 2025 20:53:27 +0800 Subject: [PATCH 4/4] Fix incorrect meta --- .../guides/9.extensions/2.api-extensions/1.hooks.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/guides/9.extensions/2.api-extensions/1.hooks.md b/content/guides/9.extensions/2.api-extensions/1.hooks.md index 79178dfa..ea72ac89 100644 --- a/content/guides/9.extensions/2.api-extensions/1.hooks.md +++ b/content/guides/9.extensions/2.api-extensions/1.hooks.md @@ -166,11 +166,11 @@ The context object has the following properties: | `response` | `request`, `response`, `ip`, `duration`, `finished` | | `auth.login` | `payload`, `status`, `user`, `provider` | | `files.upload` | `payload`, `key`, `collection` | -| `extensions.load` | `payload` | -| `extensions.unload` | `payload` | -| `extensions.reload` | `payload`, `added` , `removed` | -| `extensions.installed` | `payload` | -| `extensions.uninstalled` | `payload` | +| `extensions.load` | `extensions` | +| `extensions.unload` | `extensions` | +| `extensions.reload` | `extensions`, `added` , `removed` | +| `extensions.installed` | `extensions`, `versionId` | +| `extensions.uninstalled` | `extensions`, `folder` | | `(.)items.read` | `payload`, `query`, `collection` | | `(.)items.create` | `payload`, `key`, `collection` | | `(.)items.update` | `payload`, `keys`, `collection` |