@directus/app 9.13.0 → 9.14.0

package/dist/assets/hooks.f7efe9af.js

@@ -0,0 +1,60 @@
+import{a as o,o as a,b as c,w as u,g as e,B as l}from"./runtime-core.esm-bundler.b1f35d24.js";const r=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,"Custom API Hooks allow running custom logic when a specified event occurs within your project. There are different types of events to choose from.")]),e("h2",{id:"extension-entrypoint",tabindex:"-1"},[l("Extension Entrypoint "),e("a",{class:"header-anchor",href:"#extension-entrypoint"},"#")]),e("p",null,[l("The entrypoint of your hook is the "),e("code",null,"index"),l(" file inside the "),e("code",null,"src/"),l(" folder of your extension package. It exports a register function to register one or more event listeners.")]),e("p",null,"Example of an entrypoint:"),e("pre",null,[e("code",{class:"language-js"},[e("span",{class:"hljs-keyword"},"export"),l(),e("span",{class:"hljs-keyword"},"default"),l(` ({ filter, action }) => {
+	filter(`),e("span",{class:"hljs-string"},"'items.create'"),l(", "),e("span",{class:"hljs-function"},"() =>"),l(` {
+		`),e("span",{class:"hljs-built_in"},"console"),l(".log("),e("span",{class:"hljs-string"},"'Creating Item!'"),l(`);
+	});
+
+	action(`),e("span",{class:"hljs-string"},"'items.create'"),l(", "),e("span",{class:"hljs-function"},"() =>"),l(` {
+		`),e("span",{class:"hljs-built_in"},"console"),l(".log("),e("span",{class:"hljs-string"},"'Item created!'"),l(`);
+	});
+};
+`)])]),e("h2",{id:"events",tabindex:"-1"},[l("Events "),e("a",{class:"header-anchor",href:"#events"},"#")]),e("p",null,"Your hook can trigger on a variety of different events. An event is defined by its type and its name."),e("p",null,"There are four event types to choose from:"),e("ul",null,[e("li",null,[e("a",{href:"#filter"},"Filter")]),e("li",null,[e("a",{href:"#action"},"Action")]),e("li",null,[e("a",{href:"#init"},"Init")]),e("li",null,[e("a",{href:"#schedule"},"Schedule")])]),e("p",null,"Use filter hooks when you want the hook to fire before the event. Use action hooks when you want the hook to fire after the event."),e("h3",{id:"filter",tabindex:"-1"},[l("Filter "),e("a",{class:"header-anchor",href:"#filter"},"#")]),e("p",null,"Filter hooks act on the event\u2019s payload before the event is fired. They allow you to check, modify, or cancel an event."),e("p",null,[l("Below is an example of canceling a "),e("code",null,"create"),l(" event by throwing a standard Directus exception.")]),e("pre",null,[e("code",{class:"language-js"},[e("span",{class:"hljs-keyword"},"export"),l(),e("span",{class:"hljs-keyword"},"default"),l(` ({ filter }, { exceptions }) => {
+	`),e("span",{class:"hljs-keyword"},"const"),l(` { InvalidPayloadException } = exceptions;
+
+	filter(`),e("span",{class:"hljs-string"},"'items.create'"),l(", "),e("span",{class:"hljs-keyword"},"async"),l(` (input) => {
+		`),e("span",{class:"hljs-keyword"},"if"),l(` (LOGIC_TO_CANCEL_EVENT) {
+			`),e("span",{class:"hljs-keyword"},"throw"),l(),e("span",{class:"hljs-keyword"},"new"),l(` InvalidPayloadException(WHAT_IS_WRONG);
+		}
+
+		`),e("span",{class:"hljs-keyword"},"return"),l(` input;
+	});
+};
+`)])]),e("p",null,"The filter register function receives two parameters:"),e("ul",null,[e("li",null,"The event name"),e("li",null,"A callback function that is executed whenever the event fires.")]),e("p",null,"The callback function itself receives three parameters:"),e("ul",null,[e("li",null,"The modifiable payload"),e("li",null,"An event-specific meta object"),e("li",null,"A context object")]),e("p",null,"The context object has the following properties:"),e("ul",null,[e("li",null,[e("code",null,"database"),l(" \u2014 The current database transaction")]),e("li",null,[e("code",null,"schema"),l(" \u2014 The current API schema in use")]),e("li",null,[e("code",null,"accountability"),l(" \u2014 Information about the current user")])]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Performance"),e("p",null,[l("Filters can impact performance when not carefully implemented, as they are executed in a blocking manner. This applies in particular to filters firing on "),e("code",null,"read"),l(" events, where a single request can result in a large amount of database reads.")])]),e("h3",{id:"action",tabindex:"-1"},[l("Action "),e("a",{class:"header-anchor",href:"#action"},"#")]),e("p",null,"Action hooks execute after a defined event and receive data related to the event. Use action hooks when you need to automate responses to CRUD events on items or server actions."),e("p",null,"The action register function receives two parameters:"),e("ul",null,[e("li",null,"The event name"),e("li",null,"A callback function that is executed whenever the event fires.")]),e("p",null,"The callback function itself receives two parameters:"),e("ul",null,[e("li",null,"An event-specific meta object"),e("li",null,"A context object")]),e("p",null,"The context object has the following properties:"),e("ul",null,[e("li",null,[e("code",null,"database"),l(" \u2014 The current database transaction")]),e("li",null,[e("code",null,"schema"),l(" \u2014 The current API schema in use")]),e("li",null,[e("code",null,"accountability"),l(" \u2014 Information about the current user")])]),e("h3",{id:"init",tabindex:"-1"},[l("Init "),e("a",{class:"header-anchor",href:"#init"},"#")]),e("p",null,"Init hooks execute at a defined point within the lifecycle of Directus. Use init hook objects to inject logic into internal services."),e("p",null,"The init register function receives two parameters:"),e("ul",null,[e("li",null,"The event name"),e("li",null,"A callback function that is executed whenever the event fires.")]),e("p",null,"The callback function itself receives one parameter:"),e("ul",null,[e("li",null,"An event-specific meta object")]),e("h3",{id:"schedule",tabindex:"-1"},[l("Schedule "),e("a",{class:"header-anchor",href:"#schedule"},"#")]),e("p",null,[l("Schedule hooks execute at certain points in time rather than when Directus performs a specific action. This is supported through "),e("a",{href:"https://www.npmjs.com/package/node-cron",target:"_blank",rel:"noopener noreferrer"},[e("code",null,"node-cron")]),l(".")]),e("p",null,[l("To set up a scheduled event, provide a cron statement as the first parameter to the "),e("code",null,"schedule()"),l(" function. For example "),e("code",null,"schedule('15 14 1 * *', <...>)"),l(" (at 14:15 on day-of-month 1) or "),e("code",null,"schedule('5 4 * * sun', <...>)"),l(" (at 04:05 on Sunday).")]),e("p",null,"Below is an example of registering a schedule hook."),e("pre",null,[e("code",{class:"language-js"},[e("span",{class:"hljs-keyword"},"import"),l(" axios "),e("span",{class:"hljs-keyword"},"from"),l(),e("span",{class:"hljs-string"},"'axios'"),l(`;
+
+`),e("span",{class:"hljs-keyword"},"export"),l(),e("span",{class:"hljs-keyword"},"default"),l(` ({ schedule }) => {
+	schedule(`),e("span",{class:"hljs-string"},"'*/15 * * * *'"),l(", "),e("span",{class:"hljs-keyword"},"async"),l(` () => {
+		`),e("span",{class:"hljs-keyword"},"await"),l(" axios.post("),e("span",{class:"hljs-string"},"'http://example.com/webhook'"),l(", { "),e("span",{class:"hljs-attr"},"message"),l(": "),e("span",{class:"hljs-string"},"'Another 15 minutes passed...'"),l(` });
+	});
+};
+`)])]),e("h2",{id:"available-events",tabindex:"-1"},[l("Available Events "),e("a",{class:"header-anchor",href:"#available-events"},"#")]),e("h3",{id:"filter-events",tabindex:"-1"},[l("Filter Events "),e("a",{class:"header-anchor",href:"#filter-events"},"#")]),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Name"),e("th",null,"Payload"),e("th",null,"Meta")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",null,"request.not_found")]),e("td",null,[e("code",null,"false")]),e("td",null,[e("code",null,"request"),l(", "),e("code",null,"response")])]),e("tr",null,[e("td",null,[e("code",null,"request.error")]),e("td",null,"The request errors"),e("td",null,"\u2013")]),e("tr",null,[e("td",null,[e("code",null,"database.error")]),e("td",null,"The database error"),e("td",null,[e("code",null,"client")])]),e("tr",null,[e("td",null,[e("code",null,"auth.login")]),e("td",null,"The login payload"),e("td",null,[e("code",null,"status"),l(", "),e("code",null,"user"),l(", "),e("code",null,"provider")])]),e("tr",null,[e("td",null,[e("code",null,"auth.jwt")]),e("td",null,"The auth token"),e("td",null,[e("code",null,"status"),l(", "),e("code",null,"user"),l(", "),e("code",null,"provider"),l(", "),e("code",null,"type")])]),e("tr",null,[e("td",null,[e("code",null,"authenticate")]),e("td",null,"The empty accountability object"),e("td",null,[e("code",null,"req")])]),e("tr",null,[e("td",null,[e("code",null,"(<collection>.)items.read")]),e("td",null,"The read item"),e("td",null,[e("code",null,"query"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"(<collection>.)items.create")]),e("td",null,"The new item"),e("td",null,[e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"(<collection>.)items.update")]),e("td",null,"The updated item"),e("td",null,[e("code",null,"keys"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"(<collection>.)items.delete")]),e("td",null,"The keys of the item"),e("td",null,[e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"<system-collection>.create")]),e("td",null,"The new item"),e("td",null,[e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"<system-collection>.update")]),e("td",null,"The updated item"),e("td",null,[e("code",null,"keys"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"<system-collection>.delete")]),e("td",null,"The keys of the item"),e("td",null,[e("code",null,"collection")])])])]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"System Collections"),e("p",null,[e("code",null,"<system-collection>"),l(" should be replaced with one of the system collection names "),e("code",null,"activity"),l(", "),e("code",null,"collections"),l(", "),e("code",null,"fields"),l(", "),e("code",null,"files"),l(" (except create/update), "),e("code",null,"folders"),l(", "),e("code",null,"permissions"),l(", "),e("code",null,"presets"),l(", "),e("code",null,"relations"),l(", "),e("code",null,"revisions"),l(", "),e("code",null,"roles"),l(", "),e("code",null,"settings"),l(", "),e("code",null,"users"),l(" or "),e("code",null,"webhooks"),l(".")])]),e("h3",{id:"action-events",tabindex:"-1"},[l("Action Events "),e("a",{class:"header-anchor",href:"#action-events"},"#")]),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Name"),e("th",null,"Meta")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",null,"server.start")]),e("td",null,[e("code",null,"server")])]),e("tr",null,[e("td",null,[e("code",null,"server.stop")]),e("td",null,[e("code",null,"server")])]),e("tr",null,[e("td",null,[e("code",null,"response")]),e("td",null,[e("code",null,"request"),l(", "),e("code",null,"response"),l(", "),e("code",null,"ip"),l(", "),e("code",null,"duration"),l(", "),e("code",null,"finished")])]),e("tr",null,[e("td",null,[e("code",null,"auth.login")]),e("td",null,[e("code",null,"payload"),l(", "),e("code",null,"status"),l(", "),e("code",null,"user"),l(", "),e("code",null,"provider")])]),e("tr",null,[e("td",null,[e("code",null,"files.upload")]),e("td",null,[e("code",null,"payload"),l(", "),e("code",null,"key"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"(<collection>.)items.read")]),e("td",null,[e("code",null,"payload"),l(", "),e("code",null,"query"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"(<collection>.)items.create")]),e("td",null,[e("code",null,"payload"),l(", "),e("code",null,"key"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"(<collection>.)items.update")]),e("td",null,[e("code",null,"payload"),l(", "),e("code",null,"keys"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"(<collection>.)items.delete")]),e("td",null,[e("code",null,"keys"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"(<collection>.)items.sort")]),e("td",null,[e("code",null,"collection"),l(", "),e("code",null,"item"),l(", "),e("code",null,"to")])]),e("tr",null,[e("td",null,[e("code",null,"<system-collection>.create")]),e("td",null,[e("code",null,"payload"),l(", "),e("code",null,"key"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"<system-collection>.update")]),e("td",null,[e("code",null,"payload"),l(", "),e("code",null,"keys"),l(", "),e("code",null,"collection")])]),e("tr",null,[e("td",null,[e("code",null,"<system-collection>.delete")]),e("td",null,[e("code",null,"keys"),l(", "),e("code",null,"collection")])])])]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"System Collections"),e("p",null,[e("code",null,"<system-collection>"),l(" should be replaced with one of the system collection names "),e("code",null,"activity"),l(", "),e("code",null,"collections"),l(", "),e("code",null,"fields"),l(", "),e("code",null,"files"),l(" (except create/update), "),e("code",null,"folders"),l(", "),e("code",null,"permissions"),l(", "),e("code",null,"presets"),l(", "),e("code",null,"relations"),l(", "),e("code",null,"revisions"),l(", "),e("code",null,"roles"),l(", "),e("code",null,"settings"),l(", "),e("code",null,"users"),l(" or "),e("code",null,"webhooks"),l(".")])]),e("h3",{id:"init-events",tabindex:"-1"},[l("Init Events "),e("a",{class:"header-anchor",href:"#init-events"},"#")]),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Name"),e("th",null,"Meta")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",null,"cli.before")]),e("td",null,[e("code",null,"program")])]),e("tr",null,[e("td",null,[e("code",null,"cli.after")]),e("td",null,[e("code",null,"program")])]),e("tr",null,[e("td",null,[e("code",null,"app.before")]),e("td",null,[e("code",null,"app")])]),e("tr",null,[e("td",null,[e("code",null,"app.after")]),e("td",null,[e("code",null,"app")])]),e("tr",null,[e("td",null,[e("code",null,"routes.before")]),e("td",null,[e("code",null,"app")])]),e("tr",null,[e("td",null,[e("code",null,"routes.after")]),e("td",null,[e("code",null,"app")])]),e("tr",null,[e("td",null,[e("code",null,"routes.custom.before")]),e("td",null,[e("code",null,"app")])]),e("tr",null,[e("td",null,[e("code",null,"routes.custom.after")]),e("td",null,[e("code",null,"app")])]),e("tr",null,[e("td",null,[e("code",null,"middlewares.before")]),e("td",null,[e("code",null,"app")])]),e("tr",null,[e("td",null,[e("code",null,"middlewares.after")]),e("td",null,[e("code",null,"app")])])])]),e("h2",{id:"register-function",tabindex:"-1"},[l("Register Function "),e("a",{class:"header-anchor",href:"#register-function"},"#")]),e("p",null,"The register function receives an object containing the type-specific register functions as the first parameter:"),e("ul",null,[e("li",null,[e("code",null,"filter"),l(" \u2014 Listen for a filter event")]),e("li",null,[e("code",null,"action"),l(" \u2014 Listen for an action event")]),e("li",null,[e("code",null,"init"),l(" \u2014 Listen for an init event")]),e("li",null,[e("code",null,"schedule"),l(" \u2014 Execute a function at certain points in time")])]),e("p",null,"The second parameter is a context object with the following properties:"),e("ul",null,[e("li",null,[e("code",null,"services"),l(" \u2014 All API internal services")]),e("li",null,[e("code",null,"exceptions"),l(" \u2014 API exception objects that can be used for throwing \u201Cproper\u201D errors")]),e("li",null,[e("code",null,"database"),l(" \u2014 Knex instance that is connected to the current database")]),e("li",null,[e("code",null,"getSchema"),l(" \u2014 Async function that reads the full available schema for use in services")]),e("li",null,[e("code",null,"env"),l(" \u2014 Parsed environment variables")]),e("li",null,[e("code",null,"logger"),l(" \u2014 "),e("a",{href:"https://github.com/pinojs/pino",target:"_blank",rel:"noopener noreferrer"},"Pino"),l(" instance.")]),e("li",null,[e("code",null,"emitter"),l(" \u2014 "),e("a",{href:"https://github.com/directus/directus/blob/main/api/src/emitter.ts",target:"_blank",rel:"noopener noreferrer"},"Event emitter"),l(" instance that can be used to trigger custom events for other extensions.")])]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Event loop"),e("p",null,"When implementing custom events using the emitter make sure you never directly or indirectly emit the same event your hook is currently handling as that would result in an infinite loop!")]),e("h2",{id:"example%3A-sync-with-external",tabindex:"-1"},[l("Example: Sync with External "),e("a",{class:"header-anchor",href:"#example%3A-sync-with-external"},"#")]),e("pre",null,[e("code",{class:"language-js"},[e("span",{class:"hljs-keyword"},"import"),l(" axios "),e("span",{class:"hljs-keyword"},"from"),l(),e("span",{class:"hljs-string"},"'axios'"),l(`;
+
+`),e("span",{class:"hljs-keyword"},"export"),l(),e("span",{class:"hljs-keyword"},"default"),l(` ({ filter }, { services, exceptions }) => {
+	`),e("span",{class:"hljs-keyword"},"const"),l(` { MailService } = services;
+	`),e("span",{class:"hljs-keyword"},"const"),l(` { ServiceUnavailableException, ForbiddenException } = exceptions;
+
+	`),e("span",{class:"hljs-comment"},"// Sync with external recipes service, cancel creation on failure"),l(`
+	filter(`),e("span",{class:"hljs-string"},"'items.create'"),l(", "),e("span",{class:"hljs-keyword"},"async"),l(` (input, { collection }, { schema }) => {
+		`),e("span",{class:"hljs-keyword"},"if"),l(" (collection !== "),e("span",{class:"hljs-string"},"'recipes'"),l(") "),e("span",{class:"hljs-keyword"},"return"),l(` input;
+
+		`),e("span",{class:"hljs-keyword"},"const"),l(" mailService = "),e("span",{class:"hljs-keyword"},"new"),l(` MailService({ schema });
+
+		`),e("span",{class:"hljs-keyword"},"try"),l(` {
+			`),e("span",{class:"hljs-keyword"},"await"),l(" axios.post("),e("span",{class:"hljs-string"},"'https://example.com/recipes'"),l(`, input);
+			`),e("span",{class:"hljs-keyword"},"await"),l(` mailService.send({
+				`),e("span",{class:"hljs-attr"},"to"),l(": "),e("span",{class:"hljs-string"},"'person@example.com'"),l(`,
+				`),e("span",{class:"hljs-attr"},"template"),l(`: {
+					`),e("span",{class:"hljs-attr"},"name"),l(": "),e("span",{class:"hljs-string"},"'item-created'"),l(`,
+					`),e("span",{class:"hljs-attr"},"data"),l(`: {
+						`),e("span",{class:"hljs-attr"},"collection"),l(`: collection,
+					},
+				},
+			});
+		} `),e("span",{class:"hljs-keyword"},"catch"),l(` (error) {
+			`),e("span",{class:"hljs-keyword"},"throw"),l(),e("span",{class:"hljs-keyword"},"new"),l(` ServiceUnavailableException(error);
+		}
+
+		input.syncedWithExample = `),e("span",{class:"hljs-literal"},"true"),l(`;
+
+		`),e("span",{class:"hljs-keyword"},"return"),l(` input;
+	});
+};
+`)])])],-1),f="Custom API Hooks",m=!0,y={name:"hooks",setup(i,{expose:t}){const n={title:"Custom API Hooks",modularExtension:!0};return t({frontmatter:n}),(d,h)=>{const s=o("docs-wrapper");return a(),c(s,{frontmatter:n},{default:u(()=>[r]),_:1})}}};export{y as default,m as modularExtension,f as title};