@directus/app 9.18.0 → 9.19.0

package/dist/assets/notifications.161a499a.js

@@ -1,153 +0,0 @@
-import{a as o,o as r,b as h,w as e,l as s,e as a,E as t}from"./runtime-core.esm-bundler.32cac88a.js";const d={class:"markdown-body"},p=s("blockquote",null,[s("p",null,"Notifications allow you to send/receive messages to/from other users of the platform.")],-1),u=s("hr",null,null,-1),_=s("h2",{id:"the-notification-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-notification-object"},"#"),t(" The Notification Object")],-1),f=s("p",null,[s("code",null,"id"),t(),s("strong",null,"integer"),s("br"),t(" Primary key of the revision.")],-1),m=s("p",null,[s("code",null,"timestamp"),t(),s("strong",null,"string"),s("br"),t(" Timestamp in ISO8601 when the notification was created.")],-1),j=s("p",null,[s("code",null,"status"),t(),s("strong",null,"string"),s("br"),t(" Current status of the notification. One of \u201Cinbox\u201D, \u201Carchived\u201D.")],-1),g=s("p",null,[s("code",null,"recipient"),t(),s("strong",null,"many-to-one"),s("br"),t(" User that received the notification.")],-1),b=s("p",null,[s("code",null,"sender"),t(),s("strong",null,"many-to-one"),s("br"),t(" User that sent the notification, if any.")],-1),y=s("p",null,[s("code",null,"subject"),t(),s("strong",null,"string"),s("br"),t(" Subject line of the message.")],-1),x=s("p",null,[s("code",null,"message"),t(),s("strong",null,"string"),s("br"),t(" Notification\u2019s message content. Will be sent in the email.")],-1),q=s("p",null,[s("code",null,"collection"),t(),s("strong",null,"string"),s("br"),t(" Collection this notification references.")],-1),E=s("p",null,[s("code",null,"item"),t(),s("strong",null,"string"),s("br"),t(" Primary key of the item this notification references.")],-1),T=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),t(`
-	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-number"},"2"),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"timestamp"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"2021-11-24T13:57:35Z"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"inbox"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"recipient"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"3EE34828-B43C-4FB2-A721-5151579B08EA"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"sender"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"497a495e-5529-4e46-8feb-2f35e9b85601"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"subject"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"You were mentioned in articles"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"message"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"\\nHello admin@example.com,\\n\\rijk@directus.io has mentioned you in a comment:\\n\\n> Hello <em>admin@example.com</em>!\\n\\n<a href=\\"http://localhost:8080/admin/content/articles/1\\">Click here to view.</a>\\n"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"item"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"1"'),t(`
-`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`)])],-1),k=s("hr",null,null,-1),P=s("h2",{id:"list-notifications",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-notifications"},"#"),t(" List Notifications")],-1),R=s("p",null,"List all notifications that exist in Directus.",-1),w=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),t(" Query Parameters")],-1),S=t("Supports all "),A=t("global query parameters"),C=t("."),L=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),t(" Returns")],-1),N=t("An array of up to "),Q=t("limit"),I=t(),D=s("a",{href:"#the-notification-object"},"notification objects",-1),O=t(". If no items are available, data will be an empty array."),H=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),t(" REST API")],-1),v=s("pre",null,[s("code",null,`GET /notifications
-SEARCH /notifications
-`)],-1),G=t("Learn more about SEARCH ->"),B=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),t(" GraphQL")],-1),M=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),U=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),t(` {
-	notifications: [directus_notifications]
-}
-`)])],-1),Y=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),t(" Example")],-1),V=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),t(` {
-	notifications {
-		id
-		recipient
-		subject
-	}
-}
-`)])],-1),F=s("hr",null,null,-1),W=s("h2",{id:"retrieve-a-notification",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-notification"},"#"),t(" Retrieve a notification")],-1),Z=s("p",null,"List an existing notification by primary key.",-1),z=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),t(" Query Parameters")],-1),J=t("Supports all "),K=t("global query parameters"),X=t("."),$=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),t(" Returns")],-1),ss=s("p",null,[t("Returns the requested "),s("a",{href:"#the-notification-object"},"notification object"),t(".")],-1),ts=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),t(" REST API")],-1),es=s("pre",null,[s("code",null,`GET /notifications/:id
-`)],-1),ns=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),t(" Example")],-1),as=s("pre",null,[s("code",null,`GET /notifications/42
-`)],-1),is=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),t(" GraphQL")],-1),os=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),ls=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),t(` {
-	notifications_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),t(`!): directus_notifications
-}
-`)])],-1),cs=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),t(" Example")],-1),rs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),t(` {
-	notifications_by_id(id: `),s("span",{class:"hljs-number"},"42"),t(`) {
-		id
-		sender
-		recipient
-		message
-		subject
-	}
-}
-`)])],-1),hs=s("hr",null,null,-1),ds=s("h2",{id:"create-a-notification",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-notification"},"#"),t(" Create a Notification")],-1),ps=s("p",null,"Create a new notification.",-1),us=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),t(" Query Parameters")],-1),_s=t("Supports all "),fs=t("global query parameters"),ms=t("."),js=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),t(" Request Body")],-1),gs=s("p",null,[t("A partial "),s("a",{href:"#the-notification-object"},"notification object"),t(".")],-1),bs=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),t(" Returns")],-1),ys=s("p",null,[t("Returns the "),s("a",{href:"#the-notification-object"},"notification object"),t(" for the created notification.")],-1),xs=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),t(" REST API")],-1),qs=s("pre",null,[s("code",null,`POST /notifications
-`)],-1),Es=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),t(" Example")],-1),Ts=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /notifications"),t(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),t(`
-	`),s("span",{class:"hljs-attr"},'"recipient"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"subject"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"Hi there!"'),t(`
-`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`)])],-1),ks=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),t(" GraphQL")],-1),Ps=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Rs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
-	create_notifications_item(data: create_directus_notifications_input!): directus_notifications
-}
-`)])],-1),ws=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),t(" Example")],-1),Ss=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	create_notifications_item(data: { recipient: `),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),t(", subject: "),s("span",{class:"hljs-string"},'"Hi there!"'),t(` }) {
-		id
-		recipient
-	}
-}
-`)])],-1),As=s("hr",null,null,-1),Cs=s("h2",{id:"create-multiple-notifications",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-multiple-notifications"},"#"),t(" Create Multiple Notifications")],-1),Ls=s("p",null,"Create multiple new notifications.",-1),Ns=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),t(" Query Parameters")],-1),Qs=t("Supports all "),Is=t("global query parameters"),Ds=t("."),Os=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),t(" Request Body")],-1),Hs=s("p",null,[t("An array of partial "),s("a",{href:"#the-notification-object"},"notification objects"),t(".")],-1),vs=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),t(" Returns")],-1),Gs=s("p",null,[t("Returns the "),s("a",{href:"#the-notification-object"},"notification object"),t(" for the created notification.")],-1),Bs=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),t(" REST API")],-1),Ms=s("pre",null,[s("code",null,`POST /notifications
-`)],-1),Us=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),t(" Example")],-1),Ys=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /notifications"),t(`
-
-`),s("span",{class:"hljs-punctuation"},"["),t(`
-	`),s("span",{class:"hljs-punctuation"},"{"),t(`
-		`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"directus_files"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"recipient"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"message"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"Hi there! You should check out these files"'),t(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-punctuation"},"{"),t(`
-		`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"recipient"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"message"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"Hi there! You should check out these articles"'),t(`
-	`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`),s("span",{class:"hljs-punctuation"},"]"),t(`
-`)])],-1),Vs=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),t(" GraphQL")],-1),Fs=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Ws=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
-	create_notifications_items(data: [create_directus_notifications_input!]!): [directus_notifications]
-}
-`)])],-1),Zs=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),t(" Example")],-1),zs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	create_notifications_items(
-		data: [
-			{
-				collection: `),s("span",{class:"hljs-string"},'"directus_files"'),t(`
-				recipient: `),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),t(`
-				message: `),s("span",{class:"hljs-string"},'"Hi there! You should check out these files"'),t(`
-			}
-			{
-				collection: `),s("span",{class:"hljs-string"},'"articles"'),t(`
-				recipient: `),s("span",{class:"hljs-string"},'"410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"'),t(`
-				message: `),s("span",{class:"hljs-string"},'"Hi there! You should check out these articles"'),t(`
-			}
-		]
-	) {
-		id
-		recipient
-	}
-}
-`)])],-1),Js=s("hr",null,null,-1),Ks=s("h2",{id:"update-a-notification",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-notification"},"#"),t(" Update a Notification")],-1),Xs=s("p",null,"Update an existing notification.",-1),$s=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Email Notifications"),s("p",null,"Emails are only sent when the notification is created. Updated to an existing notification won\u2019t trigger a new notification email to be sent.")],-1),st=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),t(" Query Parameters")],-1),tt=t("Supports all "),et=t("global query parameters"),nt=t("."),at=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),t(" Request Body")],-1),it=s("p",null,[t("A partial "),s("a",{href:"#the-notification-object"},"notification object"),t(".")],-1),ot=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),t(" Returns")],-1),lt=s("p",null,[t("Returns the "),s("a",{href:"#the-notification-object"},"notification object"),t(" for the updated notification.")],-1),ct=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),t(" REST API")],-1),rt=s("pre",null,[s("code",null,`PATCH /notifications/:id
-`)],-1),ht=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),t(" Example")],-1),dt=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /notifications/34"),t(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),t(`
-	`),s("span",{class:"hljs-attr"},'"message"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"This is my updated notification"'),t(`
-`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`)])],-1),pt=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),t(" GraphQL")],-1),ut=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),_t=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
-	update_notifications_item(id:`),s("span",{class:"hljs-literal"}," ID"),t(`!, data: update_directus_notifications_input): directus_notifications
-}
-`)])],-1),ft=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),t(" Example")],-1),mt=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	update_notifications_item(id: `),s("span",{class:"hljs-number"},"32"),t(", data: { message: "),s("span",{class:"hljs-string"},'"This is my updated notification"'),t(` }) {
-		id
-		message
-	}
-}
-`)])],-1),jt=s("hr",null,null,-1),gt=s("h2",{id:"update-multiple-notifications",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-multiple-notifications"},"#"),t(" Update Multiple Notifications")],-1),bt=s("p",null,"Update multiple existing notifications.",-1),yt=s("h3",{id:"query-parameters-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-5"},"#"),t(" Query Parameters")],-1),xt=t("Supports all "),qt=t("global query parameters"),Et=t("."),Tt=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),t(" Request Body")],-1),kt=s("p",null,[s("code",null,"keys"),t(),s("strong",null,"Required"),s("br"),t(" Array of primary keys of the notifications you\u2019d like to update.")],-1),Pt=s("p",null,[s("code",null,"data"),t(),s("strong",null,"Required"),s("br"),t(" Any of "),s("a",{href:"#the-notification-object"},"the notification object"),t("\u2019s properties.")],-1),Rt=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),t(" Returns")],-1),wt=s("p",null,[t("Returns the "),s("a",{href:"#the-notification-object"},"notification objects"),t(" for the updated notifications.")],-1),St=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),t(" REST API")],-1),At=s("pre",null,[s("code",null,`PATCH /notifications
-`)],-1),Ct=s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),t(" Example")],-1),Lt=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /notifications"),t(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),t(`
-	`),s("span",{class:"hljs-attr"},'"keys"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-number"},"15"),s("span",{class:"hljs-punctuation"},","),t(),s("span",{class:"hljs-number"},"64"),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-punctuation"},"{"),t(`
-		`),s("span",{class:"hljs-attr"},'"message"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"Updated message!"'),t(`
-	`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`)])],-1),Nt=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),t(" GraphQL")],-1),Qt=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),It=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
-	update_notifications_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),t(`!]!, data: update_directus_notifications_input): [directus_notifications]
-}
-`)])],-1),Dt=s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),t(" Example")],-1),Ot=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	update_notifications_items(ids: [`),s("span",{class:"hljs-number"},"15"),t(", "),s("span",{class:"hljs-number"},"64"),t("], data: { message: "),s("span",{class:"hljs-string"},'"Updated message!"'),t(` }) {
-		id
-		recipient
-	}
-}
-`)])],-1),Ht=s("hr",null,null,-1),vt=s("h2",{id:"delete-a-notification",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-notification"},"#"),t(" Delete a Notification")],-1),Gt=s("p",null,"Delete an existing notification.",-1),Bt=s("h3",{id:"returns-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-6"},"#"),t(" Returns")],-1),Mt=s("p",null,"Empty body.",-1),Ut=s("h3",{id:"rest-api-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-6"},"#"),t(" REST API")],-1),Yt=s("pre",null,[s("code",null,`DELETE /notifications/:id
-`)],-1),Vt=s("h5",{id:"example-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-11"},"#"),t(" Example")],-1),Ft=s("pre",null,[s("code",null,`DELETE /notifications/34
-`)],-1),Wt=s("h3",{id:"graphql-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-6"},"#"),t(" GraphQL")],-1),Zt=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),zt=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
-	delete_notifications_item(id:`),s("span",{class:"hljs-literal"}," ID"),t(`!): delete_one
-}
-`)])],-1),Jt=s("h5",{id:"example-12",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-12"},"#"),t(" Example")],-1),Kt=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	delete_notifications_item(id: `),s("span",{class:"hljs-number"},"32"),t(`) {
-		id
-	}
-}
-`)])],-1),Xt=s("hr",null,null,-1),$t=s("h2",{id:"delete-multiple-notifications",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-multiple-notifications"},"#"),t(" Delete Multiple Notifications")],-1),se=s("p",null,"Delete multiple existing notifications.",-1),te=s("h3",{id:"request-body-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-4"},"#"),t(" Request Body")],-1),ee=s("p",null,"An array of notification primary keys",-1),ne=s("h3",{id:"returns-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-7"},"#"),t(" Returns")],-1),ae=s("p",null,"Empty body.",-1),ie=s("h3",{id:"rest-api-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-7"},"#"),t(" REST API")],-1),oe=s("pre",null,[s("code",null,`DELETE /notifications
-`)],-1),le=s("h5",{id:"example-13",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-13"},"#"),t(" Example")],-1),ce=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /notifications"),t(`
-`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-number"},"15"),s("span",{class:"hljs-punctuation"},","),t(),s("span",{class:"hljs-number"},"251"),s("span",{class:"hljs-punctuation"},","),t(),s("span",{class:"hljs-number"},"810"),s("span",{class:"hljs-punctuation"},"]"),t(`
-`)])],-1),re=s("h3",{id:"graphql-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-7"},"#"),t(" GraphQL")],-1),he=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),de=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
-	delete_notifications_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),t(`!]!): delete_many
-}
-`)])],-1),pe=s("h5",{id:"example-14",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-14"},"#"),t(" Example")],-1),ue=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	delete_notifications_items(ids: [`),s("span",{class:"hljs-number"},"15"),t(", "),s("span",{class:"hljs-number"},"251"),t(", "),s("span",{class:"hljs-number"},"810"),t(`]) {
-		ids
-	}
-}
-`)])],-1),ge="Notifications",be=!1,ye="REST and GraphQL API documentation on the Notifications collection in Directus.",xe="5 min read",qe="page-reference",Ee={name:"notifications",setup(_e,{expose:l}){const i={title:"Notifications",modularExtension:!1,description:"REST and GraphQL API documentation on the Notifications collection in Directus.",readTime:"5 min read",pageClass:"page-reference"};return l({frontmatter:i}),(fe,me)=>{const n=o("router-link"),c=o("docs-wrapper");return r(),h(c,{frontmatter:i},{default:e(()=>[s("div",d,[p,u,_,f,m,j,g,b,y,x,q,E,T,k,P,R,w,s("p",null,[S,a(n,{to:"/docs/reference/query"},{default:e(()=>[A]),_:1}),C]),L,s("p",null,[N,a(n,{to:"/docs/reference/query#limit"},{default:e(()=>[Q]),_:1}),I,D,O]),H,v,s("p",null,[a(n,{to:"/docs/reference/introduction#search-http-method"},{default:e(()=>[G]),_:1})]),B,M,U,Y,V,F,W,Z,z,s("p",null,[J,a(n,{to:"/docs/reference/query"},{default:e(()=>[K]),_:1}),X]),$,ss,ts,es,ns,as,is,os,ls,cs,rs,hs,ds,ps,us,s("p",null,[_s,a(n,{to:"/docs/reference/query"},{default:e(()=>[fs]),_:1}),ms]),js,gs,bs,ys,xs,qs,Es,Ts,ks,Ps,Rs,ws,Ss,As,Cs,Ls,Ns,s("p",null,[Qs,a(n,{to:"/docs/reference/query"},{default:e(()=>[Is]),_:1}),Ds]),Os,Hs,vs,Gs,Bs,Ms,Us,Ys,Vs,Fs,Ws,Zs,zs,Js,Ks,Xs,$s,st,s("p",null,[tt,a(n,{to:"/docs/reference/query"},{default:e(()=>[et]),_:1}),nt]),at,it,ot,lt,ct,rt,ht,dt,pt,ut,_t,ft,mt,jt,gt,bt,yt,s("p",null,[xt,a(n,{to:"/docs/reference/query"},{default:e(()=>[qt]),_:1}),Et]),Tt,kt,Pt,Rt,wt,St,At,Ct,Lt,Nt,Qt,It,Dt,Ot,Ht,vt,Gt,Bt,Mt,Ut,Yt,Vt,Ft,Wt,Zt,zt,Jt,Kt,Xt,$t,se,te,ee,ne,ae,ie,oe,le,ce,re,he,de,pe,ue])]),_:1})}}};export{Ee as default,ye as description,be as modularExtension,qe as pageClass,xe as readTime,ge as title};

package/dist/assets/nsis.a31c102c.js

@@ -1 +0,0 @@
-import{y as a}from"./index.7f8a0ace.entry.js";import{s as l}from"./simple.1606e663.js";function s(n,r){return r.forEach(function(e){e&&typeof e!="string"&&!Array.isArray(e)&&Object.keys(e).forEach(function(t){if(t!=="default"&&!(t in n)){var i=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(n,t,i.get?i:{enumerable:!0,get:function(){return e[t]}})}})}),Object.freeze(Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}))}var o={exports:{}};(function(n,r){(function(e){e(a.exports,l.exports)})(function(e){e.defineSimpleMode("nsis",{start:[{regex:/(?:[+-]?)(?:0x[\d,a-f]+)|(?:0o[0-7]+)|(?:0b[0,1]+)|(?:\d+.?\d*)/,token:"number"},{regex:/"(?:[^\\"]|\\.)*"?/,token:"string"},{regex:/'(?:[^\\']|\\.)*'?/,token:"string"},{regex:/`(?:[^\\`]|\\.)*`?/,token:"string"},{regex:/^\s*(?:\!(addincludedir|addplugindir|appendfile|cd|define|delfile|echo|error|execute|finalize|getdllversion|gettlbversion|include|insertmacro|macro|macroend|makensis|packhdr|pragma|searchparse|searchreplace|system|tempfile|undef|uninstfinalize|verbose|warning))\b/,token:"keyword"},{regex:/^\s*(?:\!(if(?:n?def)?|ifmacron?def|macro))\b/,token:"keyword",indent:!0},{regex:/^\s*(?:\!(else|endif|macroend))\b/,token:"keyword",dedent:!0},{regex:/^\s*(?:Abort|AddBrandingImage|AddSize|AllowRootDirInstall|AllowSkipFiles|AutoCloseWindow|BGFont|BGGradient|BrandingText|BringToFront|Call|CallInstDLL|Caption|ChangeUI|CheckBitmap|ClearErrors|CompletedText|ComponentText|CopyFiles|CRCCheck|CreateDirectory|CreateFont|CreateShortCut|Delete|DeleteINISec|DeleteINIStr|DeleteRegKey|DeleteRegValue|DetailPrint|DetailsButtonText|DirText|DirVar|DirVerify|EnableWindow|EnumRegKey|EnumRegValue|Exch|Exec|ExecShell|ExecShellWait|ExecWait|ExpandEnvStrings|File|FileBufSize|FileClose|FileErrorText|FileOpen|FileRead|FileReadByte|FileReadUTF16LE|FileReadWord|FileWriteUTF16LE|FileSeek|FileWrite|FileWriteByte|FileWriteWord|FindClose|FindFirst|FindNext|FindWindow|FlushINI|GetCurInstType|GetCurrentAddress|GetDlgItem|GetDLLVersion|GetDLLVersionLocal|GetErrorLevel|GetFileTime|GetFileTimeLocal|GetFullPathName|GetFunctionAddress|GetInstDirError|GetKnownFolderPath|GetLabelAddress|GetTempFileName|GetWinVer|Goto|HideWindow|Icon|IfAbort|IfErrors|IfFileExists|IfRebootFlag|IfRtlLanguage|IfShellVarContextAll|IfSilent|InitPluginsDir|InstallButtonText|InstallColors|InstallDir|InstallDirRegKey|InstProgressFlags|InstType|InstTypeGetText|InstTypeSetText|Int64Cmp|Int64CmpU|Int64Fmt|IntCmp|IntCmpU|IntFmt|IntOp|IntPtrCmp|IntPtrCmpU|IntPtrOp|IsWindow|LangString|LicenseBkColor|LicenseData|LicenseForceSelection|LicenseLangString|LicenseText|LoadAndSetImage|LoadLanguageFile|LockWindow|LogSet|LogText|ManifestDPIAware|ManifestLongPathAware|ManifestMaxVersionTested|ManifestSupportedOS|MessageBox|MiscButtonText|Name|Nop|OutFile|Page|PageCallbacks|PEAddResource|PEDllCharacteristics|PERemoveResource|PESubsysVer|Pop|Push|Quit|ReadEnvStr|ReadINIStr|ReadRegDWORD|ReadRegStr|Reboot|RegDLL|Rename|RequestExecutionLevel|ReserveFile|Return|RMDir|SearchPath|SectionGetFlags|SectionGetInstTypes|SectionGetSize|SectionGetText|SectionIn|SectionSetFlags|SectionSetInstTypes|SectionSetSize|SectionSetText|SendMessage|SetAutoClose|SetBrandingImage|SetCompress|SetCompressor|SetCompressorDictSize|SetCtlColors|SetCurInstType|SetDatablockOptimize|SetDateSave|SetDetailsPrint|SetDetailsView|SetErrorLevel|SetErrors|SetFileAttributes|SetFont|SetOutPath|SetOverwrite|SetRebootFlag|SetRegView|SetShellVarContext|SetSilent|ShowInstDetails|ShowUninstDetails|ShowWindow|SilentInstall|SilentUnInstall|Sleep|SpaceTexts|StrCmp|StrCmpS|StrCpy|StrLen|SubCaption|Unicode|UninstallButtonText|UninstallCaption|UninstallIcon|UninstallSubCaption|UninstallText|UninstPage|UnRegDLL|Var|VIAddVersionKey|VIFileVersion|VIProductVersion|WindowIcon|WriteINIStr|WriteRegBin|WriteRegDWORD|WriteRegExpandStr|WriteRegMultiStr|WriteRegNone|WriteRegStr|WriteUninstaller|XPStyle)\b/,token:"keyword"},{regex:/^\s*(?:Function|PageEx|Section(?:Group)?)\b/,token:"keyword",indent:!0},{regex:/^\s*(?:(Function|PageEx|Section(?:Group)?)End)\b/,token:"keyword",dedent:!0},{regex:/\b(?:ARCHIVE|FILE_ATTRIBUTE_ARCHIVE|FILE_ATTRIBUTE_HIDDEN|FILE_ATTRIBUTE_NORMAL|FILE_ATTRIBUTE_OFFLINE|FILE_ATTRIBUTE_READONLY|FILE_ATTRIBUTE_SYSTEM|FILE_ATTRIBUTE_TEMPORARY|HIDDEN|HKCC|HKCR(32|64)?|HKCU(32|64)?|HKDD|HKEY_CLASSES_ROOT|HKEY_CURRENT_CONFIG|HKEY_CURRENT_USER|HKEY_DYN_DATA|HKEY_LOCAL_MACHINE|HKEY_PERFORMANCE_DATA|HKEY_USERS|HKLM(32|64)?|HKPD|HKU|IDABORT|IDCANCEL|IDD_DIR|IDD_INST|IDD_INSTFILES|IDD_LICENSE|IDD_SELCOM|IDD_UNINST|IDD_VERIFY|IDIGNORE|IDNO|IDOK|IDRETRY|IDYES|MB_ABORTRETRYIGNORE|MB_DEFBUTTON1|MB_DEFBUTTON2|MB_DEFBUTTON3|MB_DEFBUTTON4|MB_ICONEXCLAMATION|MB_ICONINFORMATION|MB_ICONQUESTION|MB_ICONSTOP|MB_OK|MB_OKCANCEL|MB_RETRYCANCEL|MB_RIGHT|MB_RTLREADING|MB_SETFOREGROUND|MB_TOPMOST|MB_USERICON|MB_YESNO|MB_YESNOCANCEL|NORMAL|OFFLINE|READONLY|SHCTX|SHELL_CONTEXT|SW_HIDE|SW_SHOWDEFAULT|SW_SHOWMAXIMIZED|SW_SHOWMINIMIZED|SW_SHOWNORMAL|SYSTEM|TEMPORARY)\b/,token:"atom"},{regex:/\b(?:admin|all|auto|both|bottom|bzip2|components|current|custom|directory|false|force|hide|highest|ifdiff|ifnewer|instfiles|lastused|leave|left|license|listonly|lzma|nevershow|none|normal|notset|off|on|right|show|silent|silentlog|textonly|top|true|try|un\.components|un\.custom|un\.directory|un\.instfiles|un\.license|uninstConfirm|user|Win10|Win7|Win8|WinVista|zlib)\b/,token:"builtin"},{regex:/\$\{(?:And(?:If(?:Not)?|Unless)|Break|Case(?:Else)?|Continue|Default|Do(?:Until|While)?|Else(?:If(?:Not)?|Unless)?|End(?:If|Select|Switch)|Exit(?:Do|For|While)|For(?:Each)?|If(?:Cmd|Not(?:Then)?|Then)?|Loop(?:Until|While)?|Or(?:If(?:Not)?|Unless)|Select|Switch|Unless|While)\}/,token:"variable-2",indent:!0},{regex:/\$\{(?:BannerTrimPath|DirState|DriveSpace|Get(BaseName|Drives|ExeName|ExePath|FileAttributes|FileExt|FileName|FileVersion|Options|OptionsS|Parameters|Parent|Root|Size|Time)|Locate|RefreshShellIcons)\}/,token:"variable-2",dedent:!0},{regex:/\$\{(?:Memento(?:Section(?:Done|End|Restore|Save)?|UnselectedSection))\}/,token:"variable-2",dedent:!0},{regex:/\$\{(?:Config(?:Read|ReadS|Write|WriteS)|File(?:Join|ReadFromEnd|Recode)|Line(?:Find|Read|Sum)|Text(?:Compare|CompareS)|TrimNewLines)\}/,token:"variable-2",dedent:!0},{regex:/\$\{(?:(?:At(?:Least|Most)|Is)(?:ServicePack|Win(?:7|8|10|95|98|200(?:0|3|8(?:R2)?)|ME|NT4|Vista|XP))|Is(?:NT|Server))\}/,token:"variable",dedent:!0},{regex:/\$\{(?:StrFilterS?|Version(?:Compare|Convert)|Word(?:AddS?|Find(?:(?:2|3)X)?S?|InsertS?|ReplaceS?))\}/,token:"variable-2",dedent:!0},{regex:/\$\{(?:RunningX64)\}/,token:"variable",dedent:!0},{regex:/\$\{(?:Disable|Enable)X64FSRedirection\}/,token:"variable-2",dedent:!0},{regex:/(#|;).*/,token:"comment"},{regex:/\/\*/,token:"comment",next:"comment"},{regex:/[-+\/*=<>!]+/,token:"operator"},{regex:/\$\w+/,token:"variable"},{regex:/\${[\w\.:-]+}/,token:"variable-2"},{regex:/\$\([\w\.:-]+\)/,token:"variable-3"}],comment:[{regex:/.*?\*\//,token:"comment",next:"start"},{regex:/.*/,token:"comment"}],meta:{electricInput:/^\s*((Function|PageEx|Section|Section(Group)?)End|(\!(endif|macroend))|\$\{(End(If|Unless|While)|Loop(Until)|Next)\})$/,blockCommentStart:"/*",blockCommentEnd:"*/",lineComment:["#",";"]}}),e.defineMIME("text/x-nsis","nsis")})})();var S=o.exports,E=s({__proto__:null,default:S},[o.exports]);export{E as n};

package/dist/assets/ntriples.848994f3.js

@@ -1 +0,0 @@
-import{y as B}from"./index.7f8a0ace.entry.js";function P(t,u){return u.forEach(function(f){f&&typeof f!="string"&&!Array.isArray(f)&&Object.keys(f).forEach(function(e){if(e!=="default"&&!(e in t)){var R=Object.getOwnPropertyDescriptor(f,e);Object.defineProperty(t,e,R.get?R:{enumerable:!0,get:function(){return f[e]}})}})}),Object.freeze(Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}))}var O={exports:{}};(function(t,u){(function(f){f(B.exports)})(function(f){f.defineMode("ntriples",function(){var e={PRE_SUBJECT:0,WRITING_SUB_URI:1,WRITING_BNODE_URI:2,PRE_PRED:3,WRITING_PRED_URI:4,PRE_OBJ:5,WRITING_OBJ_URI:6,WRITING_OBJ_BNODE:7,WRITING_OBJ_LITERAL:8,WRITING_LIT_LANG:9,WRITING_LIT_TYPE:10,POST_OBJ:11,ERROR:12};function R(_,n){var i=_.location,r;i==e.PRE_SUBJECT&&n=="<"?r=e.WRITING_SUB_URI:i==e.PRE_SUBJECT&&n=="_"?r=e.WRITING_BNODE_URI:i==e.PRE_PRED&&n=="<"?r=e.WRITING_PRED_URI:i==e.PRE_OBJ&&n=="<"?r=e.WRITING_OBJ_URI:i==e.PRE_OBJ&&n=="_"?r=e.WRITING_OBJ_BNODE:i==e.PRE_OBJ&&n=='"'?r=e.WRITING_OBJ_LITERAL:i==e.WRITING_SUB_URI&&n==">"||i==e.WRITING_BNODE_URI&&n==" "?r=e.PRE_PRED:i==e.WRITING_PRED_URI&&n==">"?r=e.PRE_OBJ:i==e.WRITING_OBJ_URI&&n==">"||i==e.WRITING_OBJ_BNODE&&n==" "||i==e.WRITING_OBJ_LITERAL&&n=='"'||i==e.WRITING_LIT_LANG&&n==" "||i==e.WRITING_LIT_TYPE&&n==">"?r=e.POST_OBJ:i==e.WRITING_OBJ_LITERAL&&n=="@"?r=e.WRITING_LIT_LANG:i==e.WRITING_OBJ_LITERAL&&n=="^"?r=e.WRITING_LIT_TYPE:n==" "&&(i==e.PRE_SUBJECT||i==e.PRE_PRED||i==e.PRE_OBJ||i==e.POST_OBJ)?r=i:i==e.POST_OBJ&&n=="."?r=e.PRE_SUBJECT:r=e.ERROR,_.location=r}return{startState:function(){return{location:e.PRE_SUBJECT,uris:[],anchors:[],bnodes:[],langs:[],types:[]}},token:function(_,n){var i=_.next();if(i=="<"){R(n,i);var r="";return _.eatWhile(function(I){return I!="#"&&I!=">"?(r+=I,!0):!1}),n.uris.push(r),_.match("#",!1)||(_.next(),R(n,">")),"variable"}if(i=="#"){var l="";return _.eatWhile(function(I){return I!=">"&&I!=" "?(l+=I,!0):!1}),n.anchors.push(l),"variable-2"}if(i==">")return R(n,">"),"variable";if(i=="_"){R(n,i);var T="";return _.eatWhile(function(I){return I!=" "?(T+=I,!0):!1}),n.bnodes.push(T),_.next(),R(n," "),"builtin"}if(i=='"')return R(n,i),_.eatWhile(function(I){return I!='"'}),_.next(),_.peek()!="@"&&_.peek()!="^"&&R(n,'"'),"string";if(i=="@"){R(n,"@");var E="";return _.eatWhile(function(I){return I!=" "?(E+=I,!0):!1}),n.langs.push(E),_.next(),R(n," "),"string-2"}if(i=="^"){_.next(),R(n,"^");var o="";return _.eatWhile(function(I){return I!=">"?(o+=I,!0):!1}),n.types.push(o),_.next(),R(n,">"),"variable"}i==" "&&R(n,i),i=="."&&R(n,i)}}}),f.defineMIME("application/n-triples","ntriples"),f.defineMIME("application/n-quads","ntriples"),f.defineMIME("text/n-triples","ntriples")})})();var N=O.exports,J=P({__proto__:null,default:N},[O.exports]);export{J as n};

package/dist/assets/octave.048d3f85.js

@@ -1 +0,0 @@
-import{y as k}from"./index.7f8a0ace.entry.js";function y(f,c){return c.forEach(function(r){r&&typeof r!="string"&&!Array.isArray(r)&&Object.keys(r).forEach(function(t){if(t!=="default"&&!(t in f)){var u=Object.getOwnPropertyDescriptor(r,t);Object.defineProperty(f,t,u.get?u:{enumerable:!0,get:function(){return r[t]}})}})}),Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var l={exports:{}};(function(f,c){(function(r){r(k.exports)})(function(r){r.defineMode("octave",function(){function t(e){return new RegExp("^(("+e.join(")|(")+"))\\b")}var u=new RegExp("^[\\+\\-\\*/&|\\^~<>!@'\\\\]"),p=new RegExp("^[\\(\\[\\{\\},:=;\\.]"),d=new RegExp("^((==)|(~=)|(<=)|(>=)|(<<)|(>>)|(\\.[\\+\\-\\*/\\^\\\\]))"),s=new RegExp("^((!=)|(\\+=)|(\\-=)|(\\*=)|(/=)|(&=)|(\\|=)|(\\^=))"),m=new RegExp("^((>>=)|(<<=))"),h=new RegExp("^[\\]\\)]"),g=new RegExp("^[_A-Za-z\xA1-\uFFFF][_A-Za-z0-9\xA1-\uFFFF]*"),v=t(["error","eval","function","abs","acos","atan","asin","cos","cosh","exp","log","prod","sum","log10","max","min","sign","sin","sinh","sqrt","tan","reshape","break","zeros","default","margin","round","ones","rand","syn","ceil","floor","size","clear","zeros","eye","mean","std","cov","det","eig","inv","norm","rank","trace","expm","logm","sqrtm","linspace","plot","title","xlabel","ylabel","legend","text","grid","meshgrid","mesh","num2str","fft","ifft","arrayfun","cellfun","input","fliplr","flipud","ismember"]),x=t(["return","case","switch","else","elseif","end","endif","endfunction","if","otherwise","do","for","while","try","catch","classdef","properties","events","methods","global","persistent","endfor","endwhile","printf","sprintf","disp","until","continue","pkg"]);function a(e,n){return!e.sol()&&e.peek()==="'"?(e.next(),n.tokenize=i,"operator"):(n.tokenize=i,i(e,n))}function b(e,n){return e.match(/^.*%}/)?(n.tokenize=i,"comment"):(e.skipToEnd(),"comment")}function i(e,n){if(e.eatSpace())return null;if(e.match("%{"))return n.tokenize=b,e.skipToEnd(),"comment";if(e.match(/^[%#]/))return e.skipToEnd(),"comment";if(e.match(/^[0-9\.+-]/,!1)){if(e.match(/^[+-]?0x[0-9a-fA-F]+[ij]?/))return e.tokenize=i,"number";if(e.match(/^[+-]?\d*\.\d+([EeDd][+-]?\d+)?[ij]?/)||e.match(/^[+-]?\d+([EeDd][+-]?\d+)?[ij]?/))return"number"}if(e.match(t(["nan","NaN","inf","Inf"])))return"number";var o=e.match(/^"(?:[^"]|"")*("|$)/)||e.match(/^'(?:[^']|'')*('|$)/);return o?o[1]?"string":"string error":e.match(x)?"keyword":e.match(v)?"builtin":e.match(g)?"variable":e.match(u)||e.match(d)?"operator":e.match(p)||e.match(s)||e.match(m)?null:e.match(h)?(n.tokenize=a,null):(e.next(),"error")}return{startState:function(){return{tokenize:i}},token:function(e,n){var o=n.tokenize(e,n);return(o==="number"||o==="variable")&&(n.tokenize=a),o},lineComment:"%",fold:"indent"}}),r.defineMIME("text/x-octave","octave")})})();var E=l.exports,z=y({__proto__:null,default:E},[l.exports]);export{z as o};

package/dist/assets/operations.67965cbf.js

@@ -1 +0,0 @@
-import{a as l,o as d,b as c,w as o,l as e,e as n,E as t}from"./runtime-core.esm-bundler.32cac88a.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,[t("When a Flow is triggered, it executes its chain of Operations, enabling you to do things like manage data within Directus, transform the Flow\u2019s data, send information off to outside services, set conditional logic, trigger other Flows, "),e("em",null,"and beyond!")])],-1),_={class:"tip hint"},p=e("div",{class:"hint-title"},"Before You Begin",-1),f=t("Please be sure to read the documentation on "),m=t("Flows"),g=t(" and "),w=t("Triggers"),y=t("."),b=e("h2",{id:"condition",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#condition"},"#"),t(" Condition")],-1),I=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/condition-20220603A.webp",alt:"Condition"})],-1),O=e("p",null,[t("A Condition routes to the next success or failure Operation based on some conditional "),e("code",null,"if"),t(" / "),e("code",null,"else"),t(" logic defined by a Filter query. That means if the query condition is met, the Flow will move forward with the success Operation. Otherwise, the failure Operation will initiate.")],-1),v=e("strong",null,"Condition Rules",-1),D=t(" \u2014 Create conditions with "),k=t("Filter Rules"),F=t("."),T=e("h2",{id:"create-data",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-data"},"#"),t(" Create Data")],-1),C=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/create-data-20220603A.webp",alt:"Create Data"})],-1),S=e("p",null,"This Operation creates Item(s) in a Collection.",-1),A=e("li",null,[e("strong",null,"Collection"),t(" \u2014 Use the dropdown menu to select the Collection you\u2019d like to create Items in.")],-1),x=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Select the scope of permissions used for this Operation.")],-1),q=e("li",null,[e("strong",null,"Emit Events"),t(" \u2014 Toggle whether the event is emitted.")],-1),P=e("strong",null,"Payload",-1),R=t(" \u2014 Create Item(s) in a Collection. To learn more, see "),U=t("API > Items"),E=t("."),j={class:"tip hint"},N=t("Make sure the Operation is scoped with the "),L=t("permissions"),B=t(" necessary to create Items."),W=e("h2",{id:"delete-data",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-data"},"#"),t(" Delete Data")],-1),M=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/delete-data-20220603A.webp",alt:"Delete Data"})],-1),J=e("p",null,"This Operation deletes Item(s) from a Collection by ID or query.",-1),Y=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Set the scope of permissions used for this Operation.")],-1),H=e("li",null,[e("strong",null,"Collection"),t(" \u2014 Use the dropdown menu to select the Collection you\u2019d like to delete Items from.")],-1),Q=e("li",null,[e("strong",null,"IDs"),t(" \u2014 Set Item IDs and press enter to confirm. Click the ID to remove.")],-1),V=e("strong",null,"Query",-1),G=t(" \u2014 Select Items to delete with a query. To learn more, see "),z=t("Filter Rules"),K=t("."),X={class:"tip hint"},Z=t("Make sure the Operation is scoped with the "),$=t("permissions"),ee=t(" necessary to delete Items."),te=e("h2",{id:"read-data",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#read-data"},"#"),t(" Read Data")],-1),oe=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/read-data-20220603A.webp",alt:"Read Data"})],-1),se=e("p",null,"This Operation reads Item(s) from a Collection and adds them onto the Flow Object. You may select Items by their ID or run a query to select the Items you wish to update.",-1),ne=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Set the scope of permissions used for this Operation.")],-1),ie=e("li",null,[e("strong",null,"Collections"),t(" \u2014 Select the Collection from which you\u2019d like to read Items.")],-1),le=e("li",null,[e("strong",null,"IDs"),t(" \u2014 Input the ID for Items you wish to read and press enter. Click the ID to remove.")],-1),ae=e("strong",null,"Query",-1),re=t(" \u2014 Select the Items with a query. To learn more, see "),de=t("Filter Rules"),ce=t("."),he=e("h2",{id:"update-data",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#update-data"},"#"),t(" Update Data")],-1),ue=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/update-data-20220603A.webp",alt:"Update Data"})],-1),_e=e("p",null,"This Operation updates Item(s) in a Collection. Similar to Read Data, you may select Items by their ID or run a query to select the Items you wish to update.",-1),pe=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Set the Role that this Operation will inherit permissions from.")],-1),fe=e("li",null,[e("strong",null,"Collections"),t(" \u2014 Select the Collection from which you\u2019d like to read Items.")],-1),me=e("li",null,[e("strong",null,"IDs"),t(" \u2014 Input the ID for Item(s) you wish to read and press enter. Click the ID to remove.")],-1),ge=e("strong",null,"Payload",-1),we=t(" \u2014 Update Items in a Collection. To learn more, see "),ye=t("API > Items"),be=t("."),Ie=e("strong",null,"Query",-1),Oe=t(" \u2014 Select Items to update with a query. To learn more, see "),ve=t("Filter Rules"),De=t("."),ke=e("h2",{id:"log-to-console",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#log-to-console"},"#"),t(" Log to Console")],-1),Fe=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/log-to-console-20220603A.webp",alt:"Log to Console"})],-1),Te=t("This Operation outputs something to the server-side console as well as the "),Ce=t("Log Panel"),Se=t(". This is a key tool for troubleshooting Flow configuration."),Ae=e("strong",null,"Message",-1),xe=t(" \u2014 Sets a "),qe=t("log message"),Pe=t("."),Re=e("h2",{id:"send-email",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#send-email"},"#"),t(" Send Email")],-1),Ue=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/send-email-20220603A.webp",alt:"Send Email"})],-1),Ee=e("p",null,"This Operation sends an email. Flow Object keys can be used as variables, which means you can use an array of emails from a previous step in Flows.",-1),je=e("ul",null,[e("li",null,[e("strong",null,"To"),t(" \u2014 Set the email addresses. Hit "),e("code",null,"\u21B5"),t(" to save the email. Click an email to remove it.")]),e("li",null,[e("strong",null,"Subject"),t(" \u2014 Set the subject line.")]),e("li",null,[e("strong",null,"Body"),t(" \u2014 Use a WYSIWYG editor to create the email body.")])],-1),Ne=e("div",{class:"tip hint"},[e("p",null,[t("If you are testing out this Operation locally from "),e("code",null,"localhost:8080"),t(", be sure to check your spam box, as your email provider may send it there automatically.")])],-1),Le=e("h2",{id:"send-notification",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#send-notification"},"#"),t(" Send Notification")],-1),Be=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/send-notification-20220603A.webp",alt:"Send Notification"})],-1),We=e("p",null,"This Operation sends a notification to an app user.",-1),Me=e("strong",null,"Users",-1),Je=t(" \u2014 Define a User by their primary key UUID. Use "),Ye=t("Flow keys"),He=t(" to set this dynamically."),Qe=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Define the Role that this Operation will inherit permissions from.")],-1),Ve=e("li",null,[e("strong",null,"Title"),t(" \u2014 Set the notification title.")],-1),Ge=e("li",null,[e("strong",null,"Message"),t(" \u2014 Set the main body of the notification.")],-1),ze=e("h2",{id:"webhook-%2F-request-url",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#webhook-%2F-request-url"},"#"),t(" Webhook / Request URL")],-1),Ke=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/webhook-20220603A.webp",alt:"Webhook / Request URL"})],-1),Xe=e("p",null,"This Operation makes a request to another URL.",-1),Ze=e("ul",null,[e("li",null,[e("strong",null,"Method"),t(" \u2014 Choose to make a GET, POST, PATCH, DELETE, or other type of request.")]),e("li",null,[e("strong",null,"URL"),t(" \u2014 Define the URL to send the request to.")]),e("li",null,[e("strong",null,"Headers"),t(" \u2014 Create a new "),e("code",null,"header:value"),t(" to pass along with the request.")]),e("li",null,[e("strong",null,"Request Body"),t(" \u2014 Set the request body data, using any string or JSON.")])],-1),$e=e("h2",{id:"sleep",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sleep"},"#"),t(" Sleep")],-1),et=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/sleep-20220603A.webp",alt:"Sleep"})],-1),tt=e("p",null,"This Operation pauses Operation Execution on the Flow for a given amount of milliseconds, then continues to the next Operation.",-1),ot=e("ul",null,[e("li",null,[e("strong",null,"Milliseconds"),t(" \u2014 Define the number of milliseconds the Operation will pause.")])],-1),st=e("h2",{id:"transform-payload",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#transform-payload"},"#"),t(" Transform Payload")],-1),nt=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/transform-payload-20220603A.webp",alt:"Transform Payload"})],-1),it=t("Transform Payload simply creates a new key on the Flow Object with nested JSON data to provide a clean space where you can combine data from multiple "),lt=t("Flow keys"),at=t(" into a single object. For example, if you need to use the same data multiple times "),rt=e("em",null,"(e.g. send it in a web request and also use it to create an Item in a Collection)",-1),dt=t(", you can combine the data with Transform Payload once, then access its Operation key repeatedly."),ct=e("ul",null,[e("li",null,[e("strong",null,"JSON"),t(" \u2014 Define JSON to insert into the Flow Object.")])],-1),ht=e("h2",{id:"trigger-flow",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#trigger-flow"},"#"),t(" Trigger Flow")],-1),ut=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/trigger-flow-20220603A.webp",alt:"Trigger Flow"})],-1),_t=t("This Operation starts another Flow and passes data to it. It should be used in combination with the "),pt=t("Another Flow"),ft=t(" Trigger."),mt=e("ul",null,[e("li",null,[e("strong",null,"Flow"),t(" \u2014 Define a Flow by its primary key UUID.")]),e("li",null,[e("strong",null,"Payload"),t(" \u2014 Define JSON to insert into the Flow Object.")])],-1),It="Operations",Ot=!1,vt="When a Flow is triggered, it executes its chain of Operations, enabling you to do things like manage data within Directus, transform the Flow's data, send information off to outside services, set conditional logic, trigger other Flows, and beyond!",Dt="5 min read",kt={name:"operations",setup(gt,{expose:a}){const i={title:"Operations",modularExtension:!1,description:"When a Flow is triggered, it executes its chain of Operations, enabling you to do things like manage data within Directus, transform the Flow's data, send information off to outside services, set conditional logic, trigger other Flows, and beyond!",readTime:"5 min read"};return a({frontmatter:i}),(wt,yt)=>{const s=l("router-link"),r=l("docs-wrapper");return d(),c(r,{frontmatter:i},{default:o(()=>[e("div",h,[u,e("div",_,[p,e("p",null,[f,n(s,{to:"/docs/configuration/flows"},{default:o(()=>[m]),_:1}),g,n(s,{to:"/docs/configuration/flows/triggers"},{default:o(()=>[w]),_:1}),y])]),b,I,O,e("ul",null,[e("li",null,[v,D,n(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[k]),_:1}),F])]),T,C,S,e("ul",null,[A,x,q,e("li",null,[P,R,n(s,{to:"/docs/reference/items"},{default:o(()=>[U]),_:1}),E])]),e("div",j,[e("p",null,[N,n(s,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[L]),_:1}),B])]),W,M,J,e("ul",null,[Y,H,Q,e("li",null,[V,G,n(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[z]),_:1}),K])]),e("div",X,[e("p",null,[Z,n(s,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[$]),_:1}),ee])]),te,oe,se,e("ul",null,[ne,ie,le,e("li",null,[ae,re,n(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[de]),_:1}),ce])]),he,ue,_e,e("ul",null,[pe,fe,me,e("li",null,[ge,we,n(s,{to:"/docs/reference/items"},{default:o(()=>[ye]),_:1}),be]),e("li",null,[Ie,Oe,n(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[ve]),_:1}),De])]),ke,Fe,e("p",null,[Te,n(s,{to:"/docs/configuration/flows#logs"},{default:o(()=>[Ce]),_:1}),Se]),e("ul",null,[e("li",null,[Ae,xe,n(s,{to:"/docs/configuration/flows#logs"},{default:o(()=>[qe]),_:1}),Pe])]),Re,Ue,Ee,je,Ne,Le,Be,We,e("ul",null,[e("li",null,[Me,Je,n(s,{to:"/docs/configuration/flows#the-flow-object"},{default:o(()=>[Ye]),_:1}),He]),Qe,Ve,Ge]),ze,Ke,Xe,Ze,$e,et,tt,ot,st,nt,e("p",null,[it,n(s,{to:"/docs/configuration/flows#the-flow-object"},{default:o(()=>[lt]),_:1}),at,rt,dt]),ct,ht,ut,e("p",null,[_t,n(s,{to:"/docs/configuration/flows/triggers#another-flow"},{default:o(()=>[pt]),_:1}),ft]),mt])]),_:1})}}};export{kt as default,vt as description,Ot as modularExtension,Dt as readTime,It as title};

package/dist/assets/operations.7e917932.js

@@ -1,30 +0,0 @@
-import{a as l,o as c,b as h,w as n,l as t,e as s,E as e}from"./runtime-core.esm-bundler.32cac88a.js";const p={class:"markdown-body"},d=e("Custom Operations allow you to create new types of steps for flows. "),u=e("Learn more about Operations"),_=e("."),f=t("h2",{id:"extension-entrypoints",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#extension-entrypoints"},"#"),e(" Extension Entrypoints")],-1),b=t("p",null,[e("Your operation has two entrypoints. The App entrypoint is the "),t("code",null,"app"),e(" file and the API entrypoint is the "),t("code",null,"api"),e(" file inside the "),t("code",null,"src/"),e(" folder of your extension package.")],-1),j=t("h3",{id:"app-entrypoint",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#app-entrypoint"},"#"),e(" App Entrypoint")],-1),g=t("p",null,"The App entrypoint exports a configuration object with options to configure the appearance of your operation. When loading your operation, this object is imported by the Directus App host.",-1),m=t("p",null,"Example of an entrypoint:",-1),y=t("pre",null,[t("code",{class:"language-js"},[t("span",{class:"hljs-keyword"},"export"),e(),t("span",{class:"hljs-keyword"},"default"),e(` {
-	`),t("span",{class:"hljs-attr"},"id"),e(": "),t("span",{class:"hljs-string"},"'custom'"),e(`,
-	`),t("span",{class:"hljs-attr"},"name"),e(": "),t("span",{class:"hljs-string"},"'Custom'"),e(`,
-	`),t("span",{class:"hljs-attr"},"icon"),e(": "),t("span",{class:"hljs-string"},"'box'"),e(`,
-	`),t("span",{class:"hljs-attr"},"description"),e(": "),t("span",{class:"hljs-string"},"'This is my custom operation!'"),e(`,
-	`),t("span",{class:"hljs-attr"},"overview"),e(": "),t("span",{class:"hljs-function"},[e("("),t("span",{class:"hljs-params"},"{ text }"),e(") =>")]),e(` [
-		{
-			`),t("span",{class:"hljs-attr"},"label"),e(": "),t("span",{class:"hljs-string"},"'Text'"),e(`,
-			`),t("span",{class:"hljs-attr"},"text"),e(`: text,
-		},
-	],
-	`),t("span",{class:"hljs-attr"},"options"),e(`: [
-		{
-			`),t("span",{class:"hljs-attr"},"field"),e(": "),t("span",{class:"hljs-string"},"'text'"),e(`,
-			`),t("span",{class:"hljs-attr"},"name"),e(": "),t("span",{class:"hljs-string"},"'Text'"),e(`,
-			`),t("span",{class:"hljs-attr"},"type"),e(": "),t("span",{class:"hljs-string"},"'string'"),e(`,
-			`),t("span",{class:"hljs-attr"},"meta"),e(`: {
-				`),t("span",{class:"hljs-attr"},"width"),e(": "),t("span",{class:"hljs-string"},"'full'"),e(`,
-				`),t("span",{class:"hljs-attr"},"interface"),e(": "),t("span",{class:"hljs-string"},"'input'"),e(`,
-			},
-		},
-	],
-};
-`)])],-1),x=t("h4",{id:"available-options",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#available-options"},"#"),e(" Available Options")],-1),w=t("li",null,[t("code",null,"id"),e(" \u2014 The unique key for this operation. It is good practice to scope proprietary operations with an author prefix.")],-1),v=t("li",null,[t("code",null,"name"),e(" \u2014 The human-readable name for this operation.")],-1),A=t("code",null,"icon",-1),T=e(" \u2014 An icon name from the "),k=e("material icon set"),I=e(", or the extended list of Directus custom icons."),E=t("li",null,[t("code",null,"description"),e(" \u2014 A short description (<80 characters) of this operation shown in the App.")],-1),P=t("li",null,[t("code",null,"overview"),e(" \u2014 An overview that will be shown on the operation\u2019s tile. Can be either a function that receives the options of the operation and returns an array of objects containing "),t("code",null,"label"),e(" and "),t("code",null,"text"),e(" or a dedicated Vue component.")],-1),C=t("li",null,[t("code",null,"options"),e(" \u2014 The options of your operation. Can be either an options object or a dedicated Vue component.")],-1),O=t("h3",{id:"api-entrypoint",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#api-entrypoint"},"#"),e(" API Entrypoint")],-1),V=t("p",null,"The API entrypoint exports a configuration object with options to configure the behavior of your operation. When loading your operation, this object is imported by the Directus API host.",-1),D=t("p",null,"Example of an entrypoint:",-1),q=t("pre",null,[t("code",{class:"language-js"},[t("span",{class:"hljs-keyword"},"export"),e(),t("span",{class:"hljs-keyword"},"default"),e(` {
-	`),t("span",{class:"hljs-attr"},"id"),e(": "),t("span",{class:"hljs-string"},"'custom'"),e(`,
-	`),t("span",{class:"hljs-attr"},"handler"),e(": "),t("span",{class:"hljs-function"},[e("("),t("span",{class:"hljs-params"},"{ text }"),e(") =>")]),e(` {
-		`),t("span",{class:"hljs-variable language_"},"console"),e("."),t("span",{class:"hljs-title function_"},"log"),e(`(text);
-	},
-};
-`)])],-1),B=t("h4",{id:"available-options-1",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#available-options-1"},"#"),e(" Available Options")],-1),N=t("ul",null,[t("li",null,[t("code",null,"id"),e(" \u2014 The unique key for this operation. It is good practice to scope proprietary operations with an author prefix.")]),t("li",null,[t("code",null,"handler"),e(" \u2014 The operations\u2019s handler function.")])],-1),F=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Extension Id"),t("p",null,"The extension id needs to be identical for both entrypoints in order for Directus to recognize them as part of the same extension.")],-1),W=t("h2",{id:"handler-function",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#handler-function"},"#"),e(" Handler Function")],-1),z=e("The handler function defined inside the API endpoint will be called whenever the flow the operation is connected to is executed. To trigger the operation connected to the "),H=t("code",null,"resolve",-1),K=e(" anchor, the handler function has to return a value. To trigger the operation connected to the "),L=t("code",null,"reject",-1),S=e(" anchor, the handler function has to throw with a value. This value will then be added to the "),Y=e("Flow Object"),G=e("."),J=t("p",null,[e("The handler function receives the two parameters "),t("code",null,"options"),e(" and "),t("code",null,"context"),e(". "),t("code",null,"options"),e(" is an object with the operation\u2019s options as properties and their respective already interpolated values. "),t("code",null,"context"),e(" is an object with the following properties:")],-1),M=t("ul",null,[t("li",null,[t("code",null,"services"),e(" \u2014 All API internal services.")]),t("li",null,[t("code",null,"exceptions"),e(" \u2014 API exception objects that can be used to throw \u201Cproper\u201D errors.")]),t("li",null,[t("code",null,"database"),e(" \u2014 Knex instance that is connected to the current database.")]),t("li",null,[t("code",null,"getSchema"),e(" \u2014 Async function that reads the full available schema for use in services")]),t("li",null,[t("code",null,"env"),e(" \u2014 Parsed environment variables.")]),t("li",null,[t("code",null,"logger"),e(" \u2014 "),t("a",{href:"https://github.com/pinojs/pino",target:"_blank",rel:"noopener noreferrer"},"Pino"),e(" instance.")]),t("li",null,[t("code",null,"data"),e(" \u2014 Object containing the raw data returned by the previous operations.")]),t("li",null,[t("code",null,"accountability"),e(" \u2014 Information about the current user received by the trigger.")])],-1),Z="Custom Operations",$=!0,tt={name:"operations",setup(Q,{expose:i}){const a={title:"Custom Operations",modularExtension:!0};return i({frontmatter:a}),(R,U)=>{const o=l("router-link"),r=l("docs-wrapper");return c(),h(r,{frontmatter:a},{default:n(()=>[t("div",p,[t("blockquote",null,[t("p",null,[d,s(o,{to:"/docs/getting-started/glossary#operations"},{default:n(()=>[u]),_:1}),_])]),f,b,j,g,m,y,x,t("ul",null,[w,v,t("li",null,[A,T,s(o,{to:"/docs/getting-started/glossary#material-icons"},{default:n(()=>[k]),_:1}),I]),E,P,C]),O,V,D,q,B,N,F,W,t("p",null,[z,H,K,L,S,s(o,{to:"/docs/configuration/flows#the-flow-object"},{default:n(()=>[Y]),_:1}),G]),J,M])]),_:1})}}};export{tt as default,$ as modularExtension,Z as title};

package/dist/assets/operations.d1b550e4.js

@@ -1,169 +0,0 @@
-import{a as l,o as i,b as h,w as t,l as s,e as n,E as e}from"./runtime-core.esm-bundler.32cac88a.js";const p={class:"markdown-body"},d=s("blockquote",null,[s("p",null,"Operations are the building blocks of Data Flows within Directus.")],-1),u=s("hr",null,null,-1),_=s("h2",{id:"the-operation-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-operation-object"},"#"),e(" The Operation Object")],-1),j=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the operation.")],-1),g=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Name for the operation.")],-1),m=s("p",null,[s("code",null,"key"),e(),s("strong",null,"string"),s("br"),e(" Key for the operation. Must be unique within a given flow.")],-1),f=s("p",null,[s("code",null,"type"),e(),s("strong",null,"string"),s("br"),e(" Type of operation. One of "),s("code",null,"log"),e(", "),s("code",null,"mail"),e(", "),s("code",null,"notification"),e(", "),s("code",null,"create"),e(", "),s("code",null,"read"),e(", "),s("code",null,"request"),e(", "),s("code",null,"sleep"),e(", "),s("code",null,"transform"),e(", "),s("code",null,"trigger"),e(", "),s("code",null,"condition"),e(", or any type of custom operation extensions.")],-1),b=s("p",null,[s("code",null,"options"),e(),s("strong",null,"json"),s("br"),e(" Options depending on the type of the operation.")],-1),y=s("p",null,[s("code",null,"position_x"),e(),s("strong",null,"integer"),s("br"),e(" Position of the operation on the X axis within the flow workspace.")],-1),x=s("p",null,[s("code",null,"position_y"),e(),s("strong",null,"integer"),s("br"),e(" Position of the operation on the Y axis within the flow workspace.")],-1),q=s("p",null,[s("code",null,"date_created"),e(),s("strong",null,"timestamp"),s("br"),e(" Timestamp in ISO8601 when the operation was created.")],-1),k=s("code",null,"user_created",-1),w=e(),E=s("strong",null,"many-to-one",-1),T=s("br",null,null,-1),P=e(" The user who created the operation. Many-to-one to "),R=e("users"),S=e("."),O=s("p",null,[s("code",null,"resolve"),e(),s("strong",null,"uuid"),s("br"),e(" The operation triggered when the current operation succeeds (or "),s("code",null,"then"),e(" logic of a condition operation). Primary key of an "),s("a",{href:"#the-operation-object"},"operation"),e(".")],-1),A=s("p",null,[s("code",null,"reject"),e(),s("strong",null,"uuid"),s("br"),e(" The operation triggered when the current operation fails (or "),s("code",null,"otherwise"),e(" logic of a condition operation). Primary key of an "),s("a",{href:"#the-operation-object"},"operation"),e(".")],-1),L=s("code",null,"flow",-1),M=e(),D=s("strong",null,"many-to-one",-1),I=s("br",null,null,-1),Q=e(" The flow containing this operation. Many-to-one to "),C=e("flows"),G=e("."),v=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"585b04cd-2821-4dcc-a563-ae5d29ecace2"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Log a Message"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"log_message"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"log"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"position_x"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"12"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"position_y"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"24"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"date_created"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"2022-05-11T13:14:52Z"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"user_created"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"12e62fd0-29c7-4fd3-b3d3-c7a39933e8af"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"resolve"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"bf4099c0-c54c-4736-ab4e-95e2487595e4"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"reject"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"flow"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"22544db5-93f7-48e2-a028-7ae02c8fe49a"'),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),B=s("hr",null,null,-1),U=s("h2",{id:"list-operations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-operations"},"#"),e(" List Operations")],-1),H=s("p",null,"List all operations that exist in Directus.",-1),N=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),e(" Query Parameters")],-1),V=e("Supports all "),F=e("global query parameters"),K=e("."),X=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),e(" Returns")],-1),Y=e("An array of up to "),Z=e("limit"),z=e(),J=s("a",{href:"#the-operation-object"},"operation objects",-1),W=e(". If no items are available, data will be an empty array."),$=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),e(" REST API")],-1),ss=s("pre",null,[s("code",null,`GET /operations
-SEARCH /operations
-`)],-1),es=e("Learn more about SEARCH ->"),ts=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),e(" GraphQL")],-1),as=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),ns=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	operations: [directus_operations]
-}
-`)])],-1),os=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),e(" Example")],-1),ls=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	operations {
-		id
-		name
-		key
-	}
-}
-`)])],-1),rs=s("hr",null,null,-1),cs=s("h2",{id:"retrieve-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-an-operation"},"#"),e(" Retrieve an operation")],-1),is=s("p",null,"List an existing operation by primary key.",-1),hs=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),e(" Query Parameters")],-1),ps=e("Supports all "),ds=e("global query parameters"),us=e("."),_s=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),e(" Returns")],-1),js=s("p",null,[e("Returns the requested "),s("a",{href:"#the-operation-object"},"operation object"),e(".")],-1),gs=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),e(" REST API")],-1),ms=s("pre",null,[s("code",null,`GET /operations/:id
-`)],-1),fs=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),e(" Example")],-1),bs=s("pre",null,[s("code",null,`GET /operations/3c636d1c-4eb2-49cd-8a6d-3ec571ab3390
-`)],-1),ys=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),e(" GraphQL")],-1),xs=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),qs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	operations_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_operations
-}
-`)])],-1),ks=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),e(" Example")],-1),ws=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	operations_by_id(id: `),s("span",{class:"hljs-number"},"42"),e(`) {
-		id
-		name
-		key
-	}
-}
-`)])],-1),Es=s("hr",null,null,-1),Ts=s("h2",{id:"create-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-an-operation"},"#"),e(" Create an Operation")],-1),Ps=s("p",null,"Create a new operation.",-1),Rs=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),e(" Query Parameters")],-1),Ss=e("Supports all "),Os=e("global query parameters"),As=e("."),Ls=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),e(" Request Body")],-1),Ms=s("p",null,[e("A partial "),s("a",{href:"#the-operation-object"},"operation object"),e(".")],-1),Ds=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),e(" Returns")],-1),Is=s("p",null,[e("Returns the "),s("a",{href:"#the-operation-object"},"operation object"),e(" for the created operation.")],-1),Qs=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),e(" REST API")],-1),Cs=s("pre",null,[s("code",null,`POST /operations
-`)],-1),Gs=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),e(" Example")],-1),vs=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /operations"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"My Log"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"my_log"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"log"'),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),Bs=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),e(" GraphQL")],-1),Us=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Hs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	create_operations_item(data: create_directus_operations_input!): directus_operations
-}
-`)])],-1),Ns=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),e(" Example")],-1),Vs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	create_operations_item(data: { name: `),s("span",{class:"hljs-string"},'"My Log"'),e(", key: "),s("span",{class:"hljs-string"},'"my_log"'),e(", "),s("span",{class:"hljs-keyword"},"type"),e(": "),s("span",{class:"hljs-string"},'"log"'),e(` }) {
-		id
-		name
-		key
-	}
-}
-`)])],-1),Fs=s("hr",null,null,-1),Ks=s("h2",{id:"create-multiple-operations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-multiple-operations"},"#"),e(" Create Multiple Operations")],-1),Xs=s("p",null,"Create multiple new operations.",-1),Ys=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),e(" Query Parameters")],-1),Zs=e("Supports all "),zs=e("global query parameters"),Js=e("."),Ws=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),e(" Request Body")],-1),$s=s("p",null,[e("An array of partial "),s("a",{href:"#the-operation-object"},"operation objects"),e(".")],-1),se=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),e(" Returns")],-1),ee=s("p",null,[e("Returns the "),s("a",{href:"#the-operation-object"},"operation object"),e(" for the created operation.")],-1),te=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),e(" REST API")],-1),ae=s("pre",null,[s("code",null,`POST /operations
-`)],-1),ne=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),e(" Example")],-1),oe=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /operations"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"["),e(`
-	`),s("span",{class:"hljs-punctuation"},"{"),e(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"My Log"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"my_log"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"log"'),e(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-punctuation"},"{"),e(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Send Notification"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"send_notification"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"notification"'),e(`
-	`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`),s("span",{class:"hljs-punctuation"},"]"),e(`
-`)])],-1),le=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),e(" GraphQL")],-1),re=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),ce=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	create_operations_items(data: [create_directus_operations_input!]!): [directus_operations]
-}
-`)])],-1),ie=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),e(" Example")],-1),he=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	create_operations_items(
-		data: [
-			{
-				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Log"'),e(`,
-				`),s("span",{class:"hljs-string"},'"key"'),e(": "),s("span",{class:"hljs-string"},'"my_log"'),e(`,
-				`),s("span",{class:"hljs-string"},'"type"'),e(": "),s("span",{class:"hljs-string"},'"log"'),e(`
-			},
-			{
-				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Send Notification"'),e(`,
-				`),s("span",{class:"hljs-string"},'"key"'),e(": "),s("span",{class:"hljs-string"},'"send_notification"'),e(`,
-				`),s("span",{class:"hljs-string"},'"type"'),e(": "),s("span",{class:"hljs-string"},'"notification"'),e(`
-			}
-		]
-	) {
-		id
-		name
-		key
-	}
-}
-`)])],-1),pe=s("hr",null,null,-1),de=s("h2",{id:"update-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-an-operation"},"#"),e(" Update an Operation")],-1),ue=s("p",null,"Update an existing operation.",-1),_e=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),e(" Query Parameters")],-1),je=e("Supports all "),ge=e("global query parameters"),me=e("."),fe=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),e(" Request Body")],-1),be=s("p",null,[e("A partial "),s("a",{href:"#the-operation-object"},"operation object"),e(".")],-1),ye=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),e(" Returns")],-1),xe=s("p",null,[e("Returns the "),s("a",{href:"#the-operation-object"},"operation object"),e(" for the updated operation.")],-1),qe=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),e(" REST API")],-1),ke=s("pre",null,[s("code",null,`PATCH /operation/:id
-`)],-1),we=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),e(" Example")],-1),Ee=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /operation/7d62f1e9-a83f-407b-84f8-1c184f014501"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"My Updated Operation"'),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),Te=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),e(" GraphQL")],-1),Pe=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Re=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_operations_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_operations_input): directus_operations
-}
-`)])],-1),Se=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),e(" Example")],-1),Oe=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	update_operations_item(id: `),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),e(", data: { name: "),s("span",{class:"hljs-string"},'"My Updated Operation"'),e(` }) {
-		id
-		name
-	}
-}
-`)])],-1),Ae=s("hr",null,null,-1),Le=s("h2",{id:"update-multiple-operations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-multiple-operations"},"#"),e(" Update Multiple Operations")],-1),Me=s("p",null,"Update multiple existing operations.",-1),De=s("h3",{id:"query-parameters-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-5"},"#"),e(" Query Parameters")],-1),Ie=e("Supports all "),Qe=e("global query parameters"),Ce=e("."),Ge=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),e(" Request Body")],-1),ve=s("p",null,[s("code",null,"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the operations you\u2019d like to update.")],-1),Be=s("p",null,[s("code",null,"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-operation-object"},"the operation object"),e("\u2019s properties.")],-1),Ue=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),e(" Returns")],-1),He=s("p",null,[e("Returns the "),s("a",{href:"#the-operation-object"},"operation objects"),e(" for the updated operations.")],-1),Ne=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),e(" REST API")],-1),Ve=s("pre",null,[s("code",null,`PATCH /operations
-`)],-1),Fe=s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),e(" Example")],-1),Ke=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /operations"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"keys"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"6a25fb7c-26a4-4dcb-a474-d47b6a203a38"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"07ac467e-1900-4c62-9637-8dac2ab97f71"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Updated Operations"'),e(`
-	`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),Xe=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),e(" GraphQL")],-1),Ye=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Ze=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_operations_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_operations_input): [directus_operations]
-}
-`)])],-1),ze=s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),e(" Example")],-1),Je=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	update_operations_items(
-		ids: [`),s("span",{class:"hljs-string"},'"6a25fb7c-26a4-4dcb-a474-d47b6a203a38"'),e(", "),s("span",{class:"hljs-string"},'"07ac467e-1900-4c62-9637-8dac2ab97f71"'),e(`]
-		data: { name: `),s("span",{class:"hljs-string"},'"Updated Operations"'),e(` }
-	) {
-		id
-		name
-		key
-	}
-}
-`)])],-1),We=s("hr",null,null,-1),$e=s("h2",{id:"delete-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-an-operation"},"#"),e(" Delete an Operation")],-1),st=s("p",null,"Delete an existing operation.",-1),et=s("h3",{id:"returns-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-6"},"#"),e(" Returns")],-1),tt=s("p",null,"Empty body.",-1),at=s("h3",{id:"rest-api-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-6"},"#"),e(" REST API")],-1),nt=s("pre",null,[s("code",null,`DELETE /operations/:id
-`)],-1),ot=s("h5",{id:"example-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-11"},"#"),e(" Example")],-1),lt=s("pre",null,[s("code",null,`DELETE /operations/07ac467e-1900-4c62-9637-8dac2ab97f71
-`)],-1),rt=s("h3",{id:"graphql-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-6"},"#"),e(" GraphQL")],-1),ct=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),it=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_operations_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
-}
-`)])],-1),ht=s("h5",{id:"example-12",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-12"},"#"),e(" Example")],-1),pt=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	delete_operations_item(id: `),s("span",{class:"hljs-string"},'"07ac467e-1900-4c62-9637-8dac2ab97f71"'),e(`) {
-		id
-	}
-}
-`)])],-1),dt=s("hr",null,null,-1),ut=s("h2",{id:"delete-multiple-operations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-multiple-operations"},"#"),e(" Delete Multiple Operations")],-1),_t=s("p",null,"Delete multiple existing operations.",-1),jt=s("h3",{id:"request-body-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-4"},"#"),e(" Request Body")],-1),gt=s("p",null,"An array of operations primary keys",-1),mt=s("h3",{id:"returns-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-7"},"#"),e(" Returns")],-1),ft=s("p",null,"Empty body.",-1),bt=s("h3",{id:"rest-api-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-7"},"#"),e(" REST API")],-1),yt=s("pre",null,[s("code",null,`DELETE /operations
-`)],-1),xt=s("h5",{id:"example-13",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-13"},"#"),e(" Example")],-1),qt=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /operations"),e(`
-`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"a791ce73-41a2-4fb7-8f67-c7ba176cc719"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"4e57ab0e-f4ec-47b5-9dad-e36f08a25642"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"5fe0a6f6-18ad-4bb3-94c6-2e033246c784"'),s("span",{class:"hljs-punctuation"},"]"),e(`
-`)])],-1),kt=s("h3",{id:"graphql-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-7"},"#"),e(" GraphQL")],-1),wt=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Et=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_operations_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
-}
-`)])],-1),Tt=s("h5",{id:"example-14",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-14"},"#"),e(" Example")],-1),Pt=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	delete_operations_items(
-		ids: [
-			`),s("span",{class:"hljs-string"},'"a791ce73-41a2-4fb7-8f67-c7ba176cc719"'),e(`
-			`),s("span",{class:"hljs-string"},'"4e57ab0e-f4ec-47b5-9dad-e36f08a25642"'),e(`
-			`),s("span",{class:"hljs-string"},'"5fe0a6f6-18ad-4bb3-94c6-2e033246c784"'),e(`
-		]
-	) {
-		ids
-	}
-}
-`)])],-1),Rt=s("h2",{id:"triggering-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#triggering-an-operation"},"#"),e(" Triggering an operation")],-1),St=s("p",null,"Trigger an operation based on primary key.",-1),Ot=s("h3",{id:"request-body-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-5"},"#"),e(" Request Body")],-1),At=s("p",null,"Payload for the operation, if needed.",-1),Lt=s("h3",{id:"returns-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-8"},"#"),e(" Returns")],-1),Mt=s("p",null,"Result of the operation, if any.",-1),Dt=s("h3",{id:"rest-api-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-8"},"#"),e(" REST API")],-1),It=s("pre",null,[s("code",null,`POST /operations/trigger/:operation_uuid
-`)],-1),Qt=s("h5",{id:"example-15",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-15"},"#"),e(" Example")],-1),Ct=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),e(`
-`),s("span",{class:"hljs-comment"},"// Payload here"),e(`
-`)])],-1),Ht="Operations",Nt=!1,Vt="REST and GraphQL API documentation on the Operations collection in Directus.",Ft="5 min read",Kt="page-reference",Xt={name:"operations",setup(Gt,{expose:r}){const o={title:"Operations",modularExtension:!1,description:"REST and GraphQL API documentation on the Operations collection in Directus.",readTime:"5 min read",pageClass:"page-reference"};return r({frontmatter:o}),(vt,Bt)=>{const a=l("router-link"),c=l("docs-wrapper");return i(),h(c,{frontmatter:o},{default:t(()=>[s("div",p,[d,u,_,j,g,m,f,b,y,x,q,s("p",null,[k,w,E,T,P,n(a,{to:"/docs/reference/system/users#the-users-object"},{default:t(()=>[R]),_:1}),S]),O,A,s("p",null,[L,M,D,I,Q,n(a,{to:"/docs/reference/system/flows#the-flow-object"},{default:t(()=>[C]),_:1}),G]),v,B,U,H,N,s("p",null,[V,n(a,{to:"/docs/reference/query"},{default:t(()=>[F]),_:1}),K]),X,s("p",null,[Y,n(a,{to:"/docs/reference/query#limit"},{default:t(()=>[Z]),_:1}),z,J,W]),$,ss,s("p",null,[n(a,{to:"/docs/reference/introduction#search-http-method"},{default:t(()=>[es]),_:1})]),ts,as,ns,os,ls,rs,cs,is,hs,s("p",null,[ps,n(a,{to:"/docs/reference/query"},{default:t(()=>[ds]),_:1}),us]),_s,js,gs,ms,fs,bs,ys,xs,qs,ks,ws,Es,Ts,Ps,Rs,s("p",null,[Ss,n(a,{to:"/docs/reference/query"},{default:t(()=>[Os]),_:1}),As]),Ls,Ms,Ds,Is,Qs,Cs,Gs,vs,Bs,Us,Hs,Ns,Vs,Fs,Ks,Xs,Ys,s("p",null,[Zs,n(a,{to:"/docs/reference/query"},{default:t(()=>[zs]),_:1}),Js]),Ws,$s,se,ee,te,ae,ne,oe,le,re,ce,ie,he,pe,de,ue,_e,s("p",null,[je,n(a,{to:"/docs/reference/query"},{default:t(()=>[ge]),_:1}),me]),fe,be,ye,xe,qe,ke,we,Ee,Te,Pe,Re,Se,Oe,Ae,Le,Me,De,s("p",null,[Ie,n(a,{to:"/docs/reference/query"},{default:t(()=>[Qe]),_:1}),Ce]),Ge,ve,Be,Ue,He,Ne,Ve,Fe,Ke,Xe,Ye,Ze,ze,Je,We,$e,st,et,tt,at,nt,ot,lt,rt,ct,it,ht,pt,dt,ut,_t,jt,gt,mt,ft,bt,yt,xt,qt,kt,wt,Et,Tt,Pt,Rt,St,Ot,At,Lt,Mt,Dt,It,Qt,Ct])]),_:1})}}};export{Xt as default,Vt as description,Nt as modularExtension,Kt as pageClass,Ft as readTime,Ht as title};

package/dist/assets/overlay.6f1501e8.js

@@ -1 +0,0 @@
-import{y as a}from"./index.7f8a0ace.entry.js";var c={exports:{}};(function(y,v){(function(e){e(a.exports)})(function(e){e.overlayMode=function(r,u,i){return{startState:function(){return{base:e.startState(r),overlay:e.startState(u),basePos:0,baseCur:null,overlayPos:0,overlayCur:null,streamSeen:null}},copyState:function(o){return{base:e.copyState(r,o.base),overlay:e.copyState(u,o.overlay),basePos:o.basePos,baseCur:null,overlayPos:o.overlayPos,overlayCur:null}},token:function(o,n){return(o!=n.streamSeen||Math.min(n.basePos,n.overlayPos)<o.start)&&(n.streamSeen=o,n.basePos=n.overlayPos=o.start),o.start==n.basePos&&(n.baseCur=r.token(o,n.base),n.basePos=o.pos),o.start==n.overlayPos&&(o.pos=o.start,n.overlayCur=u.token(o,n.overlay),n.overlayPos=o.pos),o.pos=Math.min(n.basePos,n.overlayPos),n.overlayCur==null?n.baseCur:n.baseCur!=null&&n.overlay.combineTokens||i&&n.overlay.combineTokens==null?n.baseCur+" "+n.overlayCur:n.overlayCur},indent:r.indent&&function(o,n,l){return r.indent(o.base,n,l)},electricChars:r.electricChars,innerMode:function(o){return{state:o.base,mode:r}},blankLine:function(o){var n,l;return r.blankLine&&(n=r.blankLine(o.base)),u.blankLine&&(l=u.blankLine(o.overlay)),l==null?n:i&&n!=null?n+" "+l:l}}}})})();export{c as o};

package/dist/assets/overview.13ed0fc0.js

@@ -1 +0,0 @@
-import{a as n,o as a,b as r,w as i,l as o,E as c}from"./runtime-core.esm-bundler.32cac88a.js";const l=o("div",{class:"markdown-body"},[o("blockquote",null,[o("p",null,"The vast flexibility of Directus is due to its thoughtful configuration options. This section guides administrators through the process of tailoring a newly installed project to your exact needs.")]),o("h2",{id:"config-options",tabindex:"-1"},[o("a",{class:"header-anchor",href:"#config-options"},"#"),c(" Config Options")])],-1),h="Configuring the Platform",m=!1,g={name:"overview",setup(f,{expose:e}){const t={title:"Configuring the Platform",modularExtension:!1};return e({frontmatter:t}),(d,u)=>{const s=n("docs-wrapper");return a(),r(s,{frontmatter:t},{default:i(()=>[l]),_:1})}}};export{g as default,m as modularExtension,h as title};