@directus/app 9.22.2 → 9.23.1

package/dist/assets/operations-b7e7c226.js

@@ -1,169 +0,0 @@
-import{a as o,o as i,e as r,y as n,u as s,q as a,z as e}from"./runtime-core.esm-bundler-753bcc58.js";const h={class:"markdown-body"},u=s("blockquote",null,[s("p",null,"Operations are the building blocks of Data Flows within Directus.")],-1),d=s("hr",null,null,-1),_=s("h2",{id:"the-operation-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-operation-object"},"#"),a(" The Operation Object")],-1),j=s("p",null,[s("code",null,"id"),a(),s("strong",null,"uuid"),s("br"),a(" Primary key of the operation.")],-1),m=s("p",null,[s("code",null,"name"),a(),s("strong",null,"string"),s("br"),a(" Name for the operation.")],-1),g=s("p",null,[s("code",null,"key"),a(),s("strong",null,"string"),s("br"),a(" Key for the operation. Must be unique within a given flow.")],-1),y=s("p",null,[s("code",null,"type"),a(),s("strong",null,"string"),s("br"),a(" Type of operation. One of "),s("code",null,"log"),a(", "),s("code",null,"mail"),a(", "),s("code",null,"notification"),a(", "),s("code",null,"create"),a(", "),s("code",null,"read"),a(", "),s("code",null,"request"),a(", "),s("code",null,"sleep"),a(", "),s("code",null,"transform"),a(", "),s("code",null,"trigger"),a(", "),s("code",null,"condition"),a(", or any type of custom operation extensions.")],-1),b=s("p",null,[s("code",null,"options"),a(),s("strong",null,"json"),s("br"),a(" Options depending on the type of the operation.")],-1),f=s("p",null,[s("code",null,"position_x"),a(),s("strong",null,"integer"),s("br"),a(" Position of the operation on the X axis within the flow workspace.")],-1),x=s("p",null,[s("code",null,"position_y"),a(),s("strong",null,"integer"),s("br"),a(" Position of the operation on the Y axis within the flow workspace.")],-1),q=s("p",null,[s("code",null,"date_created"),a(),s("strong",null,"timestamp"),s("br"),a(" Timestamp in ISO8601 when the operation was created.")],-1),k=s("code",null,"user_created",-1),w=s("strong",null,"many-to-one",-1),T=s("br",null,null,-1),E=s("p",null,[s("code",null,"resolve"),a(),s("strong",null,"uuid"),s("br"),a(" The operation triggered when the current operation succeeds (or "),s("code",null,"then"),a(" logic of a condition operation). Primary key of an "),s("a",{href:"#the-operation-object"},"operation"),a(".")],-1),P=s("p",null,[s("code",null,"reject"),a(),s("strong",null,"uuid"),s("br"),a(" The operation triggered when the current operation fails (or "),s("code",null,"otherwise"),a(" logic of a condition operation). Primary key of an "),s("a",{href:"#the-operation-object"},"operation"),a(".")],-1),R=s("code",null,"flow",-1),S=s("strong",null,"many-to-one",-1),O=s("br",null,null,-1),A=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"585b04cd-2821-4dcc-a563-ae5d29ecace2"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Log a Message"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"log_message"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"log"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"position_x"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-number"},"12"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"position_y"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-number"},"24"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"date_created"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"2022-05-11T13:14:52Z"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"user_created"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"12e62fd0-29c7-4fd3-b3d3-c7a39933e8af"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"resolve"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"bf4099c0-c54c-4736-ab4e-95e2487595e4"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"reject"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"flow"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"22544db5-93f7-48e2-a028-7ae02c8fe49a"'),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),L=s("hr",null,null,-1),M=s("h2",{id:"list-operations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-operations"},"#"),a(" List Operations")],-1),D=s("p",null,"List all operations that exist in Directus.",-1),I=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),a(" Query Parameters")],-1),Q=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),a(" Returns")],-1),C=s("a",{href:"#the-operation-object"},"operation objects",-1),G=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),a(" REST API")],-1),v=s("pre",null,[s("code",null,`GET /operations
-SEARCH /operations
-`)],-1),B=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),a(" GraphQL")],-1),U=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),H=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Query"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-symbol"},"operations"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("directus_operations"),s("span",{class:"hljs-punctuation"},"]"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),N=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),a(" Example")],-1),V=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	operations `),s("span",{class:"hljs-punctuation"},"{"),a(`
-		id
-		name
-		key
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),z=s("hr",null,null,-1),F=s("h2",{id:"retrieve-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-an-operation"},"#"),a(" Retrieve an operation")],-1),K=s("p",null,"List an existing operation by primary key.",-1),X=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),a(" Query Parameters")],-1),Y=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),a(" Returns")],-1),Z=s("p",null,[a("Returns the requested "),s("a",{href:"#the-operation-object"},"operation object"),a(".")],-1),J=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),a(" REST API")],-1),W=s("pre",null,[s("code",null,`GET /operations/:id
-`)],-1),$=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),a(" Example")],-1),ss=s("pre",null,[s("code",null,`GET /operations/3c636d1c-4eb2-49cd-8a6d-3ec571ab3390
-`)],-1),as=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),a(" GraphQL")],-1),ns=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),ts=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Query"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	operations_by_id`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(" ID"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` directus_operations
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),es=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),a(" Example")],-1),ls=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	operations_by_id`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-number"},"42"),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		id
-		name
-		key
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),os=s("hr",null,null,-1),cs=s("h2",{id:"create-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-an-operation"},"#"),a(" Create an Operation")],-1),ps=s("p",null,"Create a new operation.",-1),is=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),a(" Query Parameters")],-1),rs=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),a(" Request Body")],-1),hs=s("p",null,[a("A partial "),s("a",{href:"#the-operation-object"},"operation object"),a(".")],-1),us=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),a(" Returns")],-1),ds=s("p",null,[a("Returns the "),s("a",{href:"#the-operation-object"},"operation object"),a(" for the created operation.")],-1),_s=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),a(" REST API")],-1),js=s("pre",null,[s("code",null,`POST /operations
-`)],-1),ms=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),a(" Example")],-1),gs=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /operations"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Log"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"my_log"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"log"'),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),ys=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),a(" GraphQL")],-1),bs=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),fs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	create_operations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(" create_directus_operations_input"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` directus_operations
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),xs=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),a(" Example")],-1),qs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	create_operations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(),s("span",{class:"hljs-symbol"},"name"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Log"'),a(", "),s("span",{class:"hljs-symbol"},"key"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"my_log"'),a(", "),s("span",{class:"hljs-symbol"},"type"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"log"'),a(),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		id
-		name
-		key
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),ks=s("hr",null,null,-1),ws=s("h2",{id:"create-multiple-operations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-multiple-operations"},"#"),a(" Create Multiple Operations")],-1),Ts=s("p",null,"Create multiple new operations.",-1),Es=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),a(" Query Parameters")],-1),Ps=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),a(" Request Body")],-1),Rs=s("p",null,[a("An array of partial "),s("a",{href:"#the-operation-object"},"operation objects"),a(".")],-1),Ss=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),a(" Returns")],-1),Os=s("p",null,[a("Returns the "),s("a",{href:"#the-operation-object"},"operation object"),a(" for the created operation.")],-1),As=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),a(" REST API")],-1),Ls=s("pre",null,[s("code",null,`POST /operations
-`)],-1),Ms=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),a(" Example")],-1),Ds=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /operations"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"["),a(`
-	`),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Log"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"my_log"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"log"'),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Send Notification"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"send_notification"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"notification"'),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"]"),a(`
-`)])],-1),Is=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),a(" GraphQL")],-1),Qs=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Cs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	create_operations_items`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("create_directus_operations_input"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("directus_operations"),s("span",{class:"hljs-punctuation"},"]"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),Gs=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),a(" Example")],-1),vs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	create_operations_items`),s("span",{class:"hljs-punctuation"},"("),a(`
-		`),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a(`
-			`),s("span",{class:"hljs-punctuation"},"{"),a(`
-				`),s("span",{class:"hljs-string"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Log"'),a(`,
-				`),s("span",{class:"hljs-string"},'"key"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"my_log"'),a(`,
-				`),s("span",{class:"hljs-string"},'"type"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"log"'),a(`
-			`),s("span",{class:"hljs-punctuation"},"}"),a(`,
-			`),s("span",{class:"hljs-punctuation"},"{"),a(`
-				`),s("span",{class:"hljs-string"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Send Notification"'),a(`,
-				`),s("span",{class:"hljs-string"},'"key"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"send_notification"'),a(`,
-				`),s("span",{class:"hljs-string"},'"type"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"notification"'),a(`
-			`),s("span",{class:"hljs-punctuation"},"}"),a(`
-		`),s("span",{class:"hljs-punctuation"},"]"),a(`
-	`),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		id
-		name
-		key
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),Bs=s("hr",null,null,-1),Us=s("h2",{id:"update-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-an-operation"},"#"),a(" Update an Operation")],-1),Hs=s("p",null,"Update an existing operation.",-1),Ns=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),a(" Query Parameters")],-1),Vs=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),a(" Request Body")],-1),zs=s("p",null,[a("A partial "),s("a",{href:"#the-operation-object"},"operation object"),a(".")],-1),Fs=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),a(" Returns")],-1),Ks=s("p",null,[a("Returns the "),s("a",{href:"#the-operation-object"},"operation object"),a(" for the updated operation.")],-1),Xs=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),a(" REST API")],-1),Ys=s("pre",null,[s("code",null,`PATCH /operation/:id
-`)],-1),Zs=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),a(" Example")],-1),Js=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /operation/7d62f1e9-a83f-407b-84f8-1c184f014501"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Updated Operation"'),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),Ws=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),a(" GraphQL")],-1),$s=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),sa=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	update_operations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(" ID"),s("span",{class:"hljs-punctuation"},"!"),a(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(" update_directus_operations_input"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` directus_operations
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),aa=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),a(" Example")],-1),na=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	update_operations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),a(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(),s("span",{class:"hljs-symbol"},"name"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Updated Operation"'),a(),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		id
-		name
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),ta=s("hr",null,null,-1),ea=s("h2",{id:"update-multiple-operations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-multiple-operations"},"#"),a(" Update Multiple Operations")],-1),la=s("p",null,"Update multiple existing operations.",-1),oa=s("h3",{id:"query-parameters-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-5"},"#"),a(" Query Parameters")],-1),ca=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),a(" Request Body")],-1),pa=s("p",null,[s("code",null,"keys"),a(),s("strong",null,"Required"),s("br"),a(" Array of primary keys of the operations you’d like to update.")],-1),ia=s("p",null,[s("code",null,"data"),a(),s("strong",null,"Required"),s("br"),a(" Any of "),s("a",{href:"#the-operation-object"},"the operation object"),a("’s properties.")],-1),ra=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),a(" Returns")],-1),ha=s("p",null,[a("Returns the "),s("a",{href:"#the-operation-object"},"operation objects"),a(" for the updated operations.")],-1),ua=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),a(" REST API")],-1),da=s("pre",null,[s("code",null,`PATCH /operations
-`)],-1),_a=s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),a(" Example")],-1),ja=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /operations"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"keys"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"6a25fb7c-26a4-4dcb-a474-d47b6a203a38"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"07ac467e-1900-4c62-9637-8dac2ab97f71"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Updated Operations"'),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),ma=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),a(" GraphQL")],-1),ga=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),ya=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	update_operations_items`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"ids"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("ID"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},"!"),a(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(" update_directus_operations_input"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("directus_operations"),s("span",{class:"hljs-punctuation"},"]"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),ba=s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),a(" Example")],-1),fa=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	update_operations_items`),s("span",{class:"hljs-punctuation"},"("),a(`
-		`),s("span",{class:"hljs-symbol"},"ids"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"6a25fb7c-26a4-4dcb-a474-d47b6a203a38"'),a(", "),s("span",{class:"hljs-string"},'"07ac467e-1900-4c62-9637-8dac2ab97f71"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-		`),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(),s("span",{class:"hljs-symbol"},"name"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Updated Operations"'),a(),s("span",{class:"hljs-punctuation"},"}"),a(`
-	`),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		id
-		name
-		key
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),xa=s("hr",null,null,-1),qa=s("h2",{id:"delete-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-an-operation"},"#"),a(" Delete an Operation")],-1),ka=s("p",null,"Delete an existing operation.",-1),wa=s("h3",{id:"returns-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-6"},"#"),a(" Returns")],-1),Ta=s("p",null,"Empty body.",-1),Ea=s("h3",{id:"rest-api-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-6"},"#"),a(" REST API")],-1),Pa=s("pre",null,[s("code",null,`DELETE /operations/:id
-`)],-1),Ra=s("h5",{id:"example-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-11"},"#"),a(" Example")],-1),Sa=s("pre",null,[s("code",null,`DELETE /operations/07ac467e-1900-4c62-9637-8dac2ab97f71
-`)],-1),Oa=s("h3",{id:"graphql-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-6"},"#"),a(" GraphQL")],-1),Aa=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),La=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	delete_operations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(" ID"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` delete_one
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),Ma=s("h5",{id:"example-12",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-12"},"#"),a(" Example")],-1),Da=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	delete_operations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"07ac467e-1900-4c62-9637-8dac2ab97f71"'),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		id
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),Ia=s("hr",null,null,-1),Qa=s("h2",{id:"delete-multiple-operations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-multiple-operations"},"#"),a(" Delete Multiple Operations")],-1),Ca=s("p",null,"Delete multiple existing operations.",-1),Ga=s("h3",{id:"request-body-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-4"},"#"),a(" Request Body")],-1),va=s("p",null,"An array of operations primary keys",-1),Ba=s("h3",{id:"returns-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-7"},"#"),a(" Returns")],-1),Ua=s("p",null,"Empty body.",-1),Ha=s("h3",{id:"rest-api-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-7"},"#"),a(" REST API")],-1),Na=s("pre",null,[s("code",null,`DELETE /operations
-`)],-1),Va=s("h5",{id:"example-13",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-13"},"#"),a(" Example")],-1),za=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /operations"),a(`
-`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"a791ce73-41a2-4fb7-8f67-c7ba176cc719"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"4e57ab0e-f4ec-47b5-9dad-e36f08a25642"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"5fe0a6f6-18ad-4bb3-94c6-2e033246c784"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-`)])],-1),Fa=s("h3",{id:"graphql-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-7"},"#"),a(" GraphQL")],-1),Ka=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Xa=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	delete_operations_items`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"ids"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("ID"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` delete_many
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),Ya=s("h5",{id:"example-14",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-14"},"#"),a(" Example")],-1),Za=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	delete_operations_items`),s("span",{class:"hljs-punctuation"},"("),a(`
-		`),s("span",{class:"hljs-symbol"},"ids"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a(`
-			`),s("span",{class:"hljs-string"},'"a791ce73-41a2-4fb7-8f67-c7ba176cc719"'),a(`
-			`),s("span",{class:"hljs-string"},'"4e57ab0e-f4ec-47b5-9dad-e36f08a25642"'),a(`
-			`),s("span",{class:"hljs-string"},'"5fe0a6f6-18ad-4bb3-94c6-2e033246c784"'),a(`
-		`),s("span",{class:"hljs-punctuation"},"]"),a(`
-	`),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		ids
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),Ja=s("h2",{id:"triggering-an-operation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#triggering-an-operation"},"#"),a(" Triggering an operation")],-1),Wa=s("p",null,"Trigger an operation based on primary key.",-1),$a=s("h3",{id:"request-body-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-5"},"#"),a(" Request Body")],-1),sn=s("p",null,"Payload for the operation, if needed.",-1),an=s("h3",{id:"returns-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-8"},"#"),a(" Returns")],-1),nn=s("p",null,"Result of the operation, if any.",-1),tn=s("h3",{id:"rest-api-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-8"},"#"),a(" REST API")],-1),en=s("pre",null,[s("code",null,`POST /operations/trigger/:operation_uuid
-`)],-1),ln=s("h5",{id:"example-15",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-15"},"#"),a(" Example")],-1),on=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),a(`
-`),s("span",{class:"hljs-comment"},"// Payload here"),a(`
-`)])],-1),un="Operations",dn=!1,_n="REST and GraphQL API documentation on the Operations collection in Directus.",jn="5 min read",mn="page-reference",gn={__name:"operations",setup(cn,{expose:c}){const l={title:"Operations",modularExtension:!1,description:"REST and GraphQL API documentation on the Operations collection in Directus.",readTime:"5 min read",pageClass:"page-reference"};return c({frontmatter:l}),(pn,rn)=>{const t=o("router-link"),p=o("docs-wrapper");return i(),r(p,{frontmatter:l},{default:n(()=>[s("div",h,[u,d,_,j,m,g,y,b,f,x,q,s("p",null,[k,a(),w,T,a(" The user who created the operation. Many-to-one to "),e(t,{to:"/docs/reference/system/users#the-users-object"},{default:n(()=>[a("users")]),_:1}),a(".")]),E,P,s("p",null,[R,a(),S,O,a(" The flow containing this operation. Many-to-one to "),e(t,{to:"/docs/reference/system/flows#the-flow-object"},{default:n(()=>[a("flows")]),_:1}),a(".")]),A,L,M,D,I,s("p",null,[a("Supports all "),e(t,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),Q,s("p",null,[a("An array of up to "),e(t,{to:"/docs/reference/query#limit"},{default:n(()=>[a("limit")]),_:1}),a(),C,a(". If no items are available, data will be an empty array.")]),G,v,s("p",null,[e(t,{to:"/docs/reference/introduction#search-http-method"},{default:n(()=>[a("Learn more about SEARCH ->")]),_:1})]),B,U,H,N,V,z,F,K,X,s("p",null,[a("Supports all "),e(t,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),Y,Z,J,W,$,ss,as,ns,ts,es,ls,os,cs,ps,is,s("p",null,[a("Supports all "),e(t,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),rs,hs,us,ds,_s,js,ms,gs,ys,bs,fs,xs,qs,ks,ws,Ts,Es,s("p",null,[a("Supports all "),e(t,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),Ps,Rs,Ss,Os,As,Ls,Ms,Ds,Is,Qs,Cs,Gs,vs,Bs,Us,Hs,Ns,s("p",null,[a("Supports all "),e(t,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),Vs,zs,Fs,Ks,Xs,Ys,Zs,Js,Ws,$s,sa,aa,na,ta,ea,la,oa,s("p",null,[a("Supports all "),e(t,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),ca,pa,ia,ra,ha,ua,da,_a,ja,ma,ga,ya,ba,fa,xa,qa,ka,wa,Ta,Ea,Pa,Ra,Sa,Oa,Aa,La,Ma,Da,Ia,Qa,Ca,Ga,va,Ba,Ua,Ha,Na,Va,za,Fa,Ka,Xa,Ya,Za,Ja,Wa,$a,sn,an,nn,tn,en,ln,on])]),_:1})}}};export{gn as default,_n as description,dn as modularExtension,mn as pageClass,jn as readTime,un as title};

package/dist/assets/operations-f642d037.js

@@ -1,29 +0,0 @@
-import{a as i,o as u,e as d,y as o,u as e,q as t,z as s}from"./runtime-core.esm-bundler-753bcc58.js";const c={class:"markdown-body"},h=e("blockquote",null,[e("p",null,[t("Operations are the individual actions in a flow. They enable 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, "),e("em",null,"and beyond!")])],-1),p={class:"tip hint"},g=e("div",{class:"hint-title"},"Before You Begin",-1),_=e("h2",{id:"condition",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#condition"},"#"),t(" Condition")],-1),f=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/condition-20220603A.webp",alt:"Condition"})],-1),m=e("strong",null,"Condition",-1),w=e("strong",null,"success path",-1),y=e("strong",null,"failure path",-1),v=e("p",null,[e("strong",null,"Options")],-1),b=e("strong",null,"Condition Rules",-1),T=e("p",null,[e("strong",null,"Payload")],-1),k=e("p",null,[t("This operation does not generate data. If the filter rule is configured properly, it will append a "),e("code",null,"null"),t(" value on its "),e("code",null,"operationKey"),t(", regardless of if the condition was met or not. However, if the filter rule is misconfigured, it will append an array containing an object you can use to help debug the misconfiguration.")],-1),D=e("p",null,[e("strong",null,"More Details")],-1),I={class:"warning hint"},S=e("strong",null,"Action (Blocking)",-1),j=e("code",null,"reject",-1),E=e("h2",{id:"run-script",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#run-script"},"#"),t(" Run Script")],-1),A=e("p",null,"This operation lets you add a custom script using vanilla JavaScript or TypeScript.",-1),x=e("p",null,[e("strong",null,"Options")],-1),O=e("p",null,[t("The operation provides a default function template. The "),e("em",null,"optional"),t(),e("code",null,"data"),t(" parameter lets you pass in the data chain as an argument.")],-1),P=e("p",null,[e("strong",null,"Payload")],-1),C=e("p",null,[t("The function’s "),e("code",null,"return"),t(" value will be appended under its "),e("code",null,"<operationKey>"),t(".")],-1),R=e("p",null,[e("strong",null,"More Details")],-1),q=e("p",null,[t("As an example, let’s say you have this function in a script operation, named "),e("code",null,"myScript"),t(".")],-1),M=e("pre",null,[e("code",{class:"language-JSON"},[e("span",{class:"hljs-comment"},"// A key from the data chain"),t(`
-`),e("span",{class:"hljs-punctuation"},"{"),t(`
-  `),e("span",{class:"hljs-attr"},'"previousOperation"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-punctuation"},"{"),t(`
-    `),e("span",{class:"hljs-attr"},'"value"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-number"},"5"),t(`
-  `),e("span",{class:"hljs-punctuation"},"}"),t(`
-`),e("span",{class:"hljs-punctuation"},"}"),t(`
-`)])],-1),F=e("p",null,"Then you add the following logic via Run Script.",-1),U=e("pre",null,[e("code",{class:"language-TypeScript"},[e("span",{class:"hljs-comment"},"// Your function in the myScript operation"),t(`
-`),e("span",{class:"hljs-variable language_"},"module"),t("."),e("span",{class:"hljs-property"},"exports"),t(" = "),e("span",{class:"hljs-keyword"},"function"),t("("),e("span",{class:"hljs-params"},"data"),t(`) {
-  `),e("span",{class:"hljs-keyword"},"return"),t(` {
-    `),e("span",{class:"hljs-attr"},"timesTwo"),t(": data."),e("span",{class:"hljs-property"},"previousOperation"),t("."),e("span",{class:"hljs-property"},"value"),t(" * "),e("span",{class:"hljs-number"},"2"),t(`
-  }
-}
-
-`)])],-1),N=e("p",null,[t("The returned value will be appended under the "),e("code",null,"myScript"),t(" operation key.")],-1),L=e("pre",null,[e("code",{class:"language-JSON"},[e("span",{class:"hljs-punctuation"},"{"),t(`
-  `),e("span",{class:"hljs-attr"},'"previousOperation"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-punctuation"},"{"),t(`
-    `),e("span",{class:"hljs-attr"},'"value"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-number"},"5"),t(`
-  `),e("span",{class:"hljs-punctuation"},"}"),e("span",{class:"hljs-punctuation"},","),t(`
-  `),e("span",{class:"hljs-attr"},'"myScript"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-punctuation"},"{"),t(`
-    `),e("span",{class:"hljs-attr"},'"timesTwo"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-number"},"10"),t(`
-  `),e("span",{class:"hljs-punctuation"},"}"),t(`
-`),e("span",{class:"hljs-punctuation"},"}"),t(`
-
-`)])],-1),K=e("div",{class:"tip hint"},[e("p",null,[t("Make sure your "),e("code",null,"return"),t(" value is valid JSON.")])],-1),B={class:"tip hint"},W=e("div",{class:"hint-title"},"Throwing Errors",-1),Y=e("strong",null,"Run Script",-1),H={class:"tip hint"},J=e("div",{class:"hint-title"},"Node Modules",-1),V=e("code",null,"FLOWS_EXEC_ALLOWED_MODULES",-1),Q=e("h2",{id:"create-data",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-data"},"#"),t(" Create Data")],-1),G=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),z=e("p",null,"This operation creates item(s) in a collection.",-1),X=e("p",null,[e("strong",null,"Options")],-1),$=e("ul",null,[e("li",null,[e("strong",null,"Collection"),t(" — Select the collection you’d like to create items in.")]),e("li",null,[e("strong",null,"Permissions"),t(" — Select the scope of permissions used for this operation.")]),e("li",null,[e("strong",null,"Emit Events"),t(" — Toggle whether the event is emitted.")]),e("li",null,[e("strong",null,"Payload"),t(" — Defines the payload to create item(s) in a collection.")])],-1),Z=e("p",null,[e("strong",null,"Payload")],-1),ee=e("p",null,[t("An array with the ID(s) of all items created will be appended under its "),e("code",null,"<operationKey>"),t(".")],-1),te=e("p",null,[e("strong",null,"More Details")],-1),oe=e("div",{class:"warning hint"},[e("p",null,[e("strong",null,"Emit Events"),t(" toggles the event’s "),e("em",null,"visibility"),t(" throughout Directus. For example, if togged on, this operation will trigger relevant event hooks in other flows or custom extensions. If toggled off, the operation will not trigger other event hooks. Imagine a situation where you have a flow being triggered by "),e("code",null,"<collection>.items.create"),t(" which contains an operation that then tries to create another item in that "),e("code",null,"<collection>"),t(". This would throw an infinite loop where the operation triggers its own flow, endlessly. However, if you toggle "),e("strong",null,"Emit Events"),t(" off, then this operation no longer triggers other event hooks.")])],-1),ne={class:"tip hint"},se=e("h2",{id:"delete-data",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-data"},"#"),t(" Delete Data")],-1),le=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),ie=e("p",null,"This operation deletes item(s) from a collection.",-1),ae=e("p",null,[e("strong",null,"Options")],-1),re=e("li",null,[e("strong",null,"Collection"),t(" — Select the collection you’d like to delete items from.")],-1),ue=e("li",null,[e("strong",null,"Permissions"),t(" — Set the scope of permissions used for this operation.")],-1),de=e("li",null,[e("strong",null,"Emit Events"),t(" — Toggle whether the event is emitted.")],-1),ce=e("li",null,[e("strong",null,"IDs"),t(" — Set Item IDs and press enter to confirm. Click the ID to remove.")],-1),he=e("strong",null,"Query",-1),pe=e("p",null,[e("strong",null,"Payload")],-1),ge=e("p",null,[t("An array with the ID(s) of all items deleted will be appended under its "),e("code",null,"<operationKey>"),t(".")],-1),_e=e("p",null,[e("strong",null,"More Details")],-1),fe=e("div",{class:"warning hint"},[e("p",null,[e("strong",null,"Emit Events"),t(" toggles the event’s "),e("em",null,"visibility"),t(" throughout Directus. For example, if togged on, this operation will trigger relevant event hooks in other flows or custom extensions. If toggled off, the operation will not trigger other event hooks. Imagine a situation where you have a flow being triggered by "),e("code",null,"<collection>.items.delete"),t(" which contains an operation that then tries to delete another item in that "),e("code",null,"<collection>"),t(". This would throw an infinite loop where the operation triggers its own flow, endlessly. However, if you toggle "),e("strong",null,"Emit Events"),t(" off, then this operation no longer triggers other event hooks.")])],-1),me=e("h2",{id:"read-data",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#read-data"},"#"),t(" Read Data")],-1),we=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),ye=e("p",null,"This operation reads item(s) from a collection and adds them onto the data chain. You may select Items by their ID or by running a query.",-1),ve=e("p",null,[e("strong",null,"Options")],-1),be=e("li",null,[e("strong",null,"Permissions"),t(" — Set the scope of permissions used for this operation.")],-1),Te=e("li",null,[e("strong",null,"Collections"),t(" — Select the collection you’d like to read items from.")],-1),ke=e("li",null,[e("strong",null,"IDs"),t(" — Input the ID for items you wish to read and press enter. Click the ID to remove.")],-1),De=e("strong",null,"Query",-1),Ie=e("li",null,[e("strong",null,"Emit Events"),t(" — Toggle whether the event is emitted.")],-1),Se=e("p",null,[e("strong",null,"Payload")],-1),je=e("p",null,[t("An array containing all items read will be appended under its "),e("code",null,"<operationKey>"),t(".")],-1),Ee=e("p",null,[e("strong",null,"More Details")],-1),Ae=e("div",{class:"warning hint"},[e("p",null,[e("strong",null,"Emit Events"),t(" toggles the event’s "),e("em",null,"visibility"),t(" throughout Directus. For example, if togged on, this operation will trigger relevant event hooks in other flows or custom extensions. If toggled off, the operation will not trigger other event hooks. Imagine a situation where you have a flow being triggered by "),e("code",null,"<collection>.items.read"),t(" which contains an operation that then tries to read another item in that "),e("code",null,"<collection>"),t(". This would throw an infinite loop where the operation triggers its own flow, endlessly. However, if you toggle "),e("strong",null,"Emit Events"),t(" off, then this operation no longer triggers other event hooks.")])],-1),xe=e("h2",{id:"update-data",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#update-data"},"#"),t(" Update Data")],-1),Oe=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),Pe=e("p",null,"This operation updates item(s) in a collection. You may select item(s) to update by their ID or by running a query.",-1),Ce=e("p",null,[e("strong",null,"Options")],-1),Re=e("li",null,[e("strong",null,"Collection"),t(" — Select the collection on which you’d like to update items in.")],-1),qe=e("li",null,[e("strong",null,"Permissions"),t(" — Set the role that this operation will inherit permissions from.")],-1),Me=e("li",null,[e("strong",null,"Emit Events"),t(" — Toggle whether the event is emitted.")],-1),Fe=e("li",null,[e("strong",null,"IDs"),t(" — Input the ID for Item(s) you wish to read and press enter. Click the ID to remove.")],-1),Ue=e("strong",null,"Payload",-1),Ne=e("strong",null,"Query",-1),Le=e("p",null,[e("strong",null,"Payload")],-1),Ke=e("p",null,[t("An array containing all items updated will be appended under its "),e("code",null,"<operationKey>"),t(".")],-1),Be=e("p",null,[e("strong",null,"More Details")],-1),We=e("div",{class:"warning hint"},[e("p",null,[e("strong",null,"Emit Events"),t(" toggles the event’s "),e("em",null,"visibility"),t(" throughout Directus. For example, if togged on, this operation will trigger relevant event hooks in other flows or custom extensions. If toggled off, the operation will not trigger other event hooks. Imagine a situation where you have a flow being triggered by "),e("code",null,"<collection>.items.update"),t(" which contains an operation that then tries to update another item in that "),e("code",null,"<collection>"),t(". This would throw an infinite loop where the operation triggers its own flow, endlessly updating items. However, if you toggle "),e("strong",null,"Emit Events"),t(" off, then this operation no longer triggers other event hooks.")])],-1),Ye={class:"tip hint"},He=e("code",null,"payload",-1),Je=e("h2",{id:"log-to-console",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#log-to-console"},"#"),t(" Log to Console")],-1),Ve=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),Qe=e("p",null,[e("strong",null,"Options")],-1),Ge=e("strong",null,"Message",-1),ze=e("p",null,[e("strong",null,"Payload")],-1),Xe=e("p",null,[t("This operation does not generate data for the data chain as its messages are for debugging and troubleshooting. It will append a "),e("code",null,"null"),t(" value on the "),e("code",null,"operationKey"),t(".")],-1),$e=e("p",null,[e("strong",null,"More Details")],-1),Ze=e("h2",{id:"send-email",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#send-email"},"#"),t(" Send Email")],-1),et=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),tt=e("p",null,"This operation sends off emails.",-1),ot=e("p",null,[e("strong",null,"Options")],-1),nt=e("ul",null,[e("li",null,[e("strong",null,"To"),t(" — Sets the email addresses. Hit "),e("code",null,"↵"),t(),e("code",null,"Enter"),t(" (PC) or "),e("code",null,"return"),t(" (Mac) to save the email. Click on a pill to remove it.")]),e("li",null,[e("strong",null,"Subject"),t(" — Set the subject line.")]),e("li",null,[e("strong",null,"Body"),t(" — Use a Markdown or WYSIWYG editor to create the email body.")])],-1),st=e("p",null,[e("strong",null,"Payload")],-1),lt=e("p",null,[t("This operation does not generate data for the data chain. It will append a "),e("code",null,"null"),t(" value on the "),e("code",null,"operationKey"),t(".")],-1),it=e("p",null,[e("strong",null,"More Details")],-1),at=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Batch Emails"),e("p",null,[t("You can input an array of emails in the "),e("code",null,"To"),t(" input option to send off multiple emails.")])],-1),rt=e("div",{class:"tip hint"},[e("p",null,[t("If you are testing out this operation from "),e("code",null,"localhost:8080"),t(", be sure to check your spam box, because your email provider may send it there automatically.")])],-1),ut=e("h2",{id:"send-notification",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#send-notification"},"#"),t(" Send Notification")],-1),dt=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),ct=e("p",null,"This operation pushes notifications to Directus Users. If the operation executes successfully, a list containing the IDs of all sent notifications generated is appended under this operation’s key.",-1),ht=e("p",null,[e("strong",null,"Options")],-1),pt=e("ul",null,[e("li",null,[e("strong",null,"Users"),t(" — Define a user by their UUID. Hit "),e("code",null,"↵"),t(),e("code",null,"Enter"),t(" (PC) or "),e("code",null,"return"),t(" (Mac) to save it. Click on a pill to remove it.")]),e("li",null,[e("strong",null,"Permissions"),t(" — Define the role that this operation will inherit permissions from.")]),e("li",null,[e("strong",null,"Title"),t(" — Set the title of the notification.")]),e("li",null,[e("strong",null,"Message"),t(" — Set the main body of the notification.")])],-1),gt=e("p",null,[e("strong",null,"Payload")],-1),_t=e("p",null,[t("This operation does not generate data. It will append a "),e("code",null,"null"),t(" value on its "),e("code",null,"operationKey"),t(".")],-1),ft=e("p",null,[e("strong",null,"More Details")],-1),mt=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Batch Notifications"),e("p",null,[t("You can input an array of UUIDs in the "),e("code",null,"To"),t(" input option to send off multiple emails.")])],-1),wt=e("h2",{id:"webhook-%2F-request-url",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#webhook-%2F-request-url"},"#"),t(" Webhook / Request URL")],-1),yt=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),vt=e("p",null,"This operation makes a request to another URL.",-1),bt=e("p",null,[e("strong",null,"Options")],-1),Tt=e("ul",null,[e("li",null,[e("strong",null,"Method"),t(" — Choose to make a GET, POST, PATCH, DELETE, or other type of request.")]),e("li",null,[e("strong",null,"URL"),t(" — Define the URL to send the request to.")]),e("li",null,[e("strong",null,"Headers"),t(" — Create a new "),e("code",null,"header:value"),t(" to pass along with the request.")]),e("li",null,[e("strong",null,"Request Body"),t(" — Set the request body’s data.")])],-1),kt=e("p",null,[e("strong",null,"Payload")],-1),Dt=e("p",null,[t("When an operation completes successfully, the "),e("code",null,"response"),t(" is appended under its "),e("code",null,"<operationKey"),t(".")],-1),It=e("h2",{id:"sleep",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sleep"},"#"),t(" Sleep")],-1),St=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/sleep-20220603A.webp",alt:"Sleep"})],-1),jt=e("p",null,"This operation creates a delay in the Flow for a given amount of milliseconds, then continues to the next operation.",-1),Et=e("p",null,[e("strong",null,"Options")],-1),At=e("ul",null,[e("li",null,[e("strong",null,"Milliseconds"),t(" — Define the number of milliseconds to sleep.")])],-1),xt=e("p",null,[e("strong",null,"Payload")],-1),Ot=e("p",null,[t("This operation does not generate data. It will append a "),e("code",null,"null"),t(" value on its "),e("code",null,"operationKey"),t(".")],-1),Pt=e("h2",{id:"transform-payload",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#transform-payload"},"#"),t(" Transform Payload")],-1),Ct=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),Rt=e("p",null,"This operation lets you custom define your own JSON payload for use in subsequent operations. This enables you to take multiple sources of data and “tidy them up” into a single payload.",-1),qt=e("p",null,[e("strong",null,"Options")],-1),Mt=e("ul",null,[e("li",null,[e("strong",null,"JSON"),t(" — Define JSON to insert into the data chain.")])],-1),Ft=e("p",null,[e("strong",null,"Payload")],-1),Ut=e("p",null,[t("When an operation completes successfully, the value you defined under the "),e("strong",null,"JSON"),t(" configuration operation is appended onto its "),e("code",null,"operationKey"),t(".")],-1),Nt=e("p",null,[e("strong",null,"More Details")],-1),Lt=e("p",null,[t("When does the Transform Payload operation come in handy? Let’s say you need to create a payload with data from a "),e("code",null,"users_collection"),t(", "),e("code",null,"widgets_collection"),t(" and some 3rd party resource which processes the data. You can add a "),e("a",{href:"#read-data"},"Read Data"),t(" operation for "),e("code",null,"collection_a"),t(", another Read Data operation for "),e("code",null,"collection_b"),t(", and a "),e("a",{href:"#webhook--request-url"},"Webhook"),t(" operation for the third party resource.")],-1),Kt=e("p",null,"Then you could stitch together all this data to create a new JSON object, like so:",-1),Bt=e("pre",null,[e("code",null,`{
-	"note": "You can add a hard-coded value!",
-	"name": "{{users_collection.username}}",
-	"widget_id": "{{widgets_collection.id}}",
-	"results": "{{webhookKey.subnestedValue}}"
-}
-`)],-1),Wt=e("h2",{id:"trigger-flow",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#trigger-flow"},"#"),t(" Trigger Flow")],-1),Yt=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),Ht=e("em",null,"(optionally)",-1),Jt=e("p",null,[e("strong",null,"Options")],-1),Vt=e("ul",null,[e("li",null,[e("strong",null,"Flow"),t(" — Define a flow by its primary key UUID.")]),e("li",null,[e("strong",null,"Payload"),t(" — Defines a JSON "),e("code",null,"payload"),t(" to pass into "),e("code",null,"$trigger"),t(" on the flow it triggered.")])],-1),Qt=e("p",null,[e("strong",null,"Payload")],-1),Gt=e("p",null,[t("If you’ve configured a "),e("strong",null,"Response Body"),t(" in the trigger of the other flow, this will be appended under this "),e("code",null,"operationKey"),t(". If no "),e("strong",null,"Response Body"),t(" is configured, "),e("code",null,"null"),t(" is appended under this "),e("code",null,"operationKey"),t(".")],-1),zt=e("p",null,[e("strong",null,"More Details")],-1),Xt=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Flows for-loops"),e("p",null,"If you pass an array to the other flow, the other flow will run once for each item in the array.")],-1),oo="Operations",no=!1,so="Operations are the individual actions in a flow. They enable 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!",lo="5 min read",io={__name:"operations",setup($t,{expose:a}){const l={title:"Operations",modularExtension:!1,description:"Operations are the individual actions in a flow. They enable 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:l}),(Zt,eo)=>{const n=i("router-link"),r=i("docs-wrapper");return u(),d(r,{frontmatter:l},{default:o(()=>[e("div",c,[h,e("div",p,[g,e("p",null,[t("On this page, we’ll explain what each operation does, the value it appends to the data chain, how to make use of its configuration options, as well as any well as other relevant details. We will assume you have read the documentation on "),s(n,{to:"/docs/configuration/flows"},{default:o(()=>[t("Flows")]),_:1}),t(" and "),s(n,{to:"/docs/configuration/flows/triggers"},{default:o(()=>[t("Triggers")]),_:1}),t(".")])]),_,f,e("p",null,[t("A "),m,t(" operation lets you choose a "),w,t(" or "),y,t(" by validating data passed into it with "),s(n,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter Rules")]),_:1}),t(".")]),v,e("ul",null,[e("li",null,[b,t(" — Create conditions with "),s(n,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter Rules")]),_:1}),t(".")])]),T,k,D,e("div",I,[e("p",null,[t("When using an "),s(n,{to:"/docs/configuration/flows/triggers.md#event-hook"},{default:o(()=>[t("Event Hook")]),_:1}),t(" configured to be "),S,t(", if your flow ends with a condition that executes with a "),j,t(" path, it will cancel your database transaction.")])]),E,A,x,O,P,C,R,q,M,F,U,N,L,K,e("div",B,[W,e("p",null,[t("If you throw an error in a "),Y,t(" operation, it will immediately break your flow chain and stop execution of subsequent flows. If you used a "),s(n,{to:"/docs/configuration/flows/triggers.md#event-hook"},{default:o(()=>[t("“Blocking” Event hook")]),_:1}),t(", throwing an error will cancel the original event transaction to the database.")])]),e("div",H,[J,e("p",null,[t("For security reasons, module usage is disabled by default. You can configure what Node Modules are available through "),s(n,{to:"/docs/self-hosted/config-options#security"},{default:o(()=>[t("the "),V,t(" environment variable")]),_:1}),t(".")])]),Q,G,z,X,$,Z,ee,te,oe,e("div",ne,[e("p",null,[t("To learn about payload requirements when creating an item, see "),s(n,{to:"/docs/reference/items"},{default:o(()=>[t("API Reference > Items")]),_:1}),t(".")])]),se,le,ie,ae,e("ul",null,[re,ue,de,ce,e("li",null,[he,t(" — Select items to delete with a query. To learn more, see "),s(n,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter Rules")]),_:1}),t(".")])]),pe,ge,_e,fe,me,we,ye,ve,e("ul",null,[be,Te,ke,e("li",null,[De,t(" — Select the items with a query. To learn more, see "),s(n,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter Rules")]),_:1}),t(".")]),Ie]),Se,je,Ee,Ae,xe,Oe,Pe,Ce,e("ul",null,[Re,qe,Me,Fe,e("li",null,[Ue,t(" — Update Items in a collection. To learn more, see "),s(n,{to:"/docs/reference/items"},{default:o(()=>[t("API > Items")]),_:1}),t(".")]),e("li",null,[Ne,t(" — Select items to update with a query. To learn more, see "),s(n,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter Rules")]),_:1}),t(".")])]),Le,Ke,Be,We,e("div",Ye,[e("p",null,[t("To learn about "),He,t(" requirements when updating an item, see "),s(n,{to:"/docs/reference/items"},{default:o(()=>[t("API Reference > Items")]),_:1}),t(".")])]),Je,Ve,e("p",null,[t("This operation outputs information to the server-side console as well as the "),s(n,{to:"/docs/configuration/flows#logs"},{default:o(()=>[t("Logs")]),_:1}),t(" within the Data Studio. This is a key tool for troubleshooting flow configuration. A Log operation’s key will have a null value on the data chain.")]),Qe,e("ul",null,[e("li",null,[Ge,t(" — Sets a "),s(n,{to:"/docs/configuration/flows#logs"},{default:o(()=>[t("log message")]),_:1}),t(".")])]),ze,Xe,$e,e("p",null,[t("For more details, see the section on "),s(n,{to:"/docs/configuration/flows#logs"},{default:o(()=>[t("Logs")]),_:1}),t(".")]),Ze,et,tt,ot,nt,st,lt,it,at,rt,ut,dt,ct,ht,pt,gt,_t,ft,mt,wt,yt,vt,bt,Tt,kt,Dt,It,St,jt,Et,At,xt,Ot,Pt,Ct,Rt,qt,Mt,Ft,Ut,Nt,Lt,Kt,Bt,Wt,Yt,e("p",null,[t("This operation starts another flow and "),Ht,t(" passes data into it. It should be used in combination with the "),s(n,{to:"/docs/configuration/flows/triggers#another-flow"},{default:o(()=>[t("Another Flow")]),_:1}),t(" trigger.")]),Jt,Vt,Qt,Gt,zt,Xt])]),_:1})}}};export{io as default,so as description,no as modularExtension,lo as readTime,oo as title};

package/dist/assets/operations-f83dba54.js

@@ -1,30 +0,0 @@
-import{a as l,o as c,e as h,y as n,u as t,q as e,z as s}from"./runtime-core.esm-bundler-753bcc58.js";const p={class:"markdown-body"},d=t("h2",{id:"extension-entrypoints",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#extension-entrypoints"},"#"),e(" Extension Entrypoints")],-1),u=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),f=t("h3",{id:"app-entrypoint",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#app-entrypoint"},"#"),e(" App Entrypoint")],-1),_=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),b=t("p",null,"Example of an entrypoint:",-1),j=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),g=t("h4",{id:"available-options",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#available-options"},"#"),e(" Available Options")],-1),m=t("li",null,[t("code",null,"id"),e(" — The unique key for this operation. It is good practice to scope proprietary operations with an author prefix.")],-1),y=t("li",null,[t("code",null,"name"),e(" — The human-readable name for this operation.")],-1),x=t("code",null,"icon",-1),w=t("li",null,[t("code",null,"description"),e(" — A short description (<80 characters) of this operation shown in the App.")],-1),v=t("li",null,[t("code",null,"overview"),e(" — An overview that will be shown on the operation’s 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),A=t("li",null,[t("code",null,"options"),e(" — The options of your operation. Can be either an options object or a dedicated Vue component.")],-1),T=t("h3",{id:"api-entrypoint",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#api-entrypoint"},"#"),e(" API Entrypoint")],-1),k=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),I=t("p",null,"Example of an entrypoint:",-1),E=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),P=t("h4",{id:"available-options-1",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#available-options-1"},"#"),e(" Available Options")],-1),C=t("ul",null,[t("li",null,[t("code",null,"id"),e(" — 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(" — The operations’s handler function.")])],-1),O=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),V=t("h2",{id:"handler-function",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#handler-function"},"#"),e(" Handler Function")],-1),q=t("code",null,"resolve",-1),D=t("code",null,"reject",-1),B=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’s options as properties and their respective already interpolated values. "),t("code",null,"context"),e(" is an object with the following properties:")],-1),N=t("ul",null,[t("li",null,[t("code",null,"services"),e(" — All API internal services.")]),t("li",null,[t("code",null,"exceptions"),e(" — API exception objects that can be used to throw “proper” errors.")]),t("li",null,[t("code",null,"database"),e(" — Knex instance that is connected to the current database.")]),t("li",null,[t("code",null,"getSchema"),e(" — Async function that reads the full available schema for use in services")]),t("li",null,[t("code",null,"env"),e(" — Parsed environment variables.")]),t("li",null,[t("code",null,"logger"),e(" — "),t("a",{href:"https://github.com/pinojs/pino",target:"_blank",rel:"noopener noreferrer"},"Pino"),e(" instance.")]),t("li",null,[t("code",null,"data"),e(" — Object containing the raw data returned by the previous operations.")]),t("li",null,[t("code",null,"accountability"),e(" — Information about the current user received by the trigger.")])],-1),K="Custom Operations",L=!0,S={__name:"operations",setup(z,{expose:i}){const a={title:"Custom Operations",modularExtension:!0};return i({frontmatter:a}),(W,F)=>{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,[e("Custom Operations allow you to create new types of steps for flows. "),s(o,{to:"/docs/configuration/flows/operations"},{default:n(()=>[e("Learn more about Operations")]),_:1}),e(".")])]),d,u,f,_,b,j,g,t("ul",null,[m,y,t("li",null,[x,e(" — An icon name from the "),s(o,{to:"/docs/getting-started/glossary#material-icons"},{default:n(()=>[e("material icon set")]),_:1}),e(", or the extended list of Directus custom icons.")]),w,v,A]),T,k,I,E,P,C,O,V,t("p",null,[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 "),q,e(" anchor, the handler function has to return a value. To trigger the operation connected to the "),D,e(" anchor, the handler function has to throw with a value. This value will then be added to the "),s(o,{to:"/docs/configuration/flows#the-data-chain"},{default:n(()=>[e("data chain")]),_:1}),e(".")]),B,N])]),_:1})}}};export{S as default,L as modularExtension,K as title};

package/dist/assets/overlay-4260f55c.js

@@ -1 +0,0 @@
-import{z as y}from"./index.5b245cc4.entry.js";var a={},v;function s(){return v||(v=1,function(b,c){(function(e){e(y)})(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}}}})}()),a}export{s as r};

package/dist/assets/overview-54e86f22.js

@@ -1 +0,0 @@
-import{a as s,o as c,e as d,y as o,u as e,q as t,z as a}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},p=e("blockquote",null,[e("p",null,"The App is a no-code presentation layer for your data, content, and assets. It uses an intuitive left-to-right visual hierarchy for general organization and navigation.")],-1),h=e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/overview/app-overview-20220810A.svg",alt:"Directus Application Overview",class:"no-shadow"},null,-1),g=e("h2",{id:"1.-module-bar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#1.-module-bar"},"#"),t(" 1. Module Bar")],-1),f=e("p",null,"The leftmost section of the App is the module bar, which includes the:",-1),_=e("li",null,[e("strong",null,"Project Logo"),t(" — Displays your configured project logo and project color (defaults to the Directus logo and color). If configured, clicking this component will navigate to the Project URL. During platform activity, an indeterminate progress indicator will also be shown here.")],-1),m=e("strong",null,"Module Navigation",-1),v=e("strong",null,"Notifications",-1),y=e("li",null,[e("strong",null,"Current User Menu"),t(" — This component displays the authenticated user’s name and avatar. "),e("ul",null,[e("li",null,"Sign Out — Hovering over the User Menu exposes the button to log out of the platform.")])],-1),b=e("h2",{id:"2.-navigation-bar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#2.-navigation-bar"},"#"),t(" 2. Navigation Bar")],-1),w=e("p",null,"The navigation bar is based on the current module, and includes:",-1),A=e("strong",null,"Project Name",-1),T=e("strong",null,"Navigation",-1),x=e("h2",{id:"3.-page",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#3.-page"},"#"),t(" 3. Page")],-1),k=e("p",null,"This is where the current page’s content is shown, including:",-1),P=e("ul",null,[e("li",null,[e("strong",null,"Header"),t(" — A fixed section at the top of each page, the header includes: "),e("ul",null,[e("li",null,"Page Icon — Clicking this navigates back to the previous page."),e("li",null,"Module Name — Clicking this navigates to the parent module/section."),e("li",null,"Page Title — Displays dynamic title of the current page."),e("li",null,"Action Buttons — Right-aligned contextual buttons for specific page actions.")])]),e("li",null,[e("strong",null,"Page Content"),t(" — This displays the content of the page you navigated to.")])],-1),N=e("h2",{id:"4.-sidebar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#4.-sidebar"},"#"),t(" 4. Sidebar")],-1),C=e("p",null,"The sidebar provides additional context and options for the current page, including:",-1),j=e("ul",null,[e("li",null,[e("strong",null,"Page Components"),t(" — Lists any contextual page components available. The “Info” component is available on every page, explaining the page’s general purpose and relevant details. Clicking any sidebar component will accordion it open. If the App window is large enough, the sidebar will automatically open, and can be closed by clicking the “X” in the top-right.")]),e("li",null,[e("strong",null,"Notifications Tray"),t(" — Fixed to the bottom of the page sidebar, this button opens a tray of recent user notifications, and provides a link to your Activity Log page.")])],-1),M="The Application",z=!1,L="The App is a no-code presentation layer for your data, content, and assets.",U="3 min read",O={__name:"overview",setup(B,{expose:l}){const i={title:"The Application",modularExtension:!1,description:"The App is a no-code presentation layer for your data, content, and assets.",readTime:"3 min read"};return l({frontmatter:i}),(I,S)=>{const n=s("router-link"),r=s("docs-wrapper");return c(),d(r,{frontmatter:i},{default:o(()=>[e("div",u,[p,h,g,f,e("ul",null,[_,e("li",null,[m,t(" — Allows navigating between the different modules your user has access to. Customizing the Module Navigation is done within the "),a(n,{to:"/docs/app/settings"},{default:o(()=>[t("Project Settings")]),_:1}),t(", but the default module list includes: "),e("ul",null,[e("li",null,[a(n,{to:"/docs/app/content/collections"},{default:o(()=>[t("Content")]),_:1}),t(" — The primary way to view and interact with database content")]),e("li",null,[a(n,{to:"/docs/app/user-directory"},{default:o(()=>[t("User Directory")]),_:1}),t(" — A dedicated section for the platform’s system Users")]),e("li",null,[a(n,{to:"/docs/app/file-library"},{default:o(()=>[t("File Library")]),_:1}),t(" — An aggregate of all files uploaded and managed within the platform")]),e("li",null,[a(n,{to:"/docs/app/insights"},{default:o(()=>[t("Insights")]),_:1}),t(" — Access to infinitely customizable data dashboards")]),e("li",null,[a(n,{to:"/docs/app/overview"},{default:o(()=>[t("App Guide")]),_:1}),t(" — A tailored, in-app portal for the platform’s concepts, guides, and reference")]),e("li",null,[a(n,{to:"/docs/app/settings"},{default:o(()=>[t("Settings")]),_:1}),t(" — An admin-only section for configuring the project and system settings")])])]),e("li",null,[v,t(" - Opens a drawer of notifications, such as from "),a(n,{to:"/docs/app/content/items#mentions"},{default:o(()=>[t("mentions")]),_:1}),t(".")]),y]),b,w,e("ul",null,[e("li",null,[A,t(" — Shows an icon and tooltip indicating the API’s connection strength, and the name of your current project, which can be configured under "),a(n,{to:"/docs/app/settings"},{default:o(()=>[t("Project Settings")]),_:1}),t(".")]),e("li",null,[T,t(" — This is a dynamic navigation based on your current module. Some modules also support "),a(n,{to:"/docs/getting-started/glossary#presets"},{default:o(()=>[t("Bookmark Presets")]),_:1}),t(", which are a customizable links to specific data-sets.")])]),x,k,P,N,C,j])]),_:1})}}};export{O as default,L as description,z as modularExtension,U as readTime,M as title};

package/dist/assets/overview-82a3c808.js

@@ -1 +0,0 @@
-import{a as c,o as i,e as d,y as o,u as t,q as e,z as s}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},m=t("blockquote",null,[t("p",null,"Whether you’re a hobbyist, startup or Fortune 500 enterprise, our flexible Cloud service lets you get up and running with Directus quickly. We do all the heavy lifting of managing your infrastructure and software updates - and you also benefit from fair and predictable usage-based pricing.")],-1),h=t("p",null,[t("img",{src:"https://cdn.directus.io/docs/v9/cloud/overview/overview-20220322A/hero-image-20220402A.webp",alt:"Hero Image"})],-1),p=t("a",{href:"https://directus.cloud",target:"_blank",rel:"noopener noreferrer"},"Directus Cloud",-1),g=t("h2",{id:"getting-started",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#getting-started"},"#"),e(" Getting Started")],-1),_=t("video",{alt:"Cloud Dashboard Overview",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[t("source",{src:"https://cdn.directus.io/docs/v9/cloud/overview/overview-20220322A/cloud-dashboard-overview-20220329A.mp4",type:"video/mp4"})],-1),f=t("h2",{id:"accounts",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#accounts"},"#"),e(" Accounts")],-1),y=t("h3",{id:"cloud-dashboard-header",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#cloud-dashboard-header"},"#"),e(" Cloud Dashboard Header")],-1),b=t("span",{mi:"",icon:""},"check",-1),v=t("li",null,[t("span",{mi:"",icon:""},"notifications"),e(" — Notifications such as version upgrades, platform upgrades, etc.")],-1),T=t("li",null,[t("span",{mi:"",icon:""},"help_outline"),e(" — Documentation, Community Support and Request for Premium Support.")],-1),w=t("span",{mi:"",icon:""},"expand_more",-1),j=t("span",{mi:"",icon:""},"account_circle",-1),x=t("h2",{id:"teams",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#teams"},"#"),e(" Teams")],-1),P=t("h2",{id:"projects",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#projects"},"#"),e(" Projects")],-1),M="Overview",S=!1,V="Whether you're a hobbyist, startup or Fortune 500 enterprise, our flexible Cloud service lets you get up and running with Directus quickly.",q="3 min read",O={__name:"overview",setup(A,{expose:r}){const n={title:"Overview",modularExtension:!1,description:"Whether you're a hobbyist, startup or Fortune 500 enterprise, our flexible Cloud service lets you get up and running with Directus quickly.",readTime:"3 min read"};return r({frontmatter:n}),(C,k)=>{const a=c("router-link"),l=c("docs-wrapper");return i(),d(l,{frontmatter:n},{default:o(()=>[t("div",u,[m,h,t("p",null,[p,e(" is a hosting platform for "),s(a,{to:"/docs/cloud/glossary#projects"},{default:o(()=>[e("Directus Projects")]),_:1}),e(" which handles data storage, hosting, updates and scalability so you can focus on building your digital apps and experiences. There are three "),s(a,{to:"/docs/cloud/glossary#projects"},{default:o(()=>[e("tiers of Cloud Projects")]),_:1}),e(": Community, Standard and Enterprise. All three tiers come with all the great features of Directus Core, as well as all "),s(a,{to:"/docs/cloud/glossary#cloud-exclusives"},{default:o(()=>[e("Cloud Exclusive")]),_:1}),e(" extensions.")]),t("p",null,[e("The Cloud Dashboard is constructed to manage three key components: "),s(a,{to:"/docs/cloud/glossary#accounts"},{default:o(()=>[e("Accounts")]),_:1}),e(", "),s(a,{to:"/docs/cloud/glossary#teams"},{default:o(()=>[e("Teams")]),_:1}),e(" and "),s(a,{to:"/docs/cloud/glossary#projects"},{default:o(()=>[e("Projects")]),_:1}),e(". First, create an Account. Once logged in, create or join a Team, and your Account will become a Member of that Team. Once that’s complete, you can create Projects within a Team.")]),t("p",null,[e("Accounts can be Members on multiple Teams. All Team Members have SuperAdmin privileges to manage the Team’s Projects, Project "),s(a,{to:"/docs/cloud/teams#manage-billing"},{default:o(()=>[e("billing")]),_:1}),e(", other Team Members and the Team itself. Teams can have multiple Team Members and multiple Projects. Projects can only be managed by one Team and cannot be transferred to new Teams.")]),g,t("p",null,[e("To make life easy, you have the option to "),s(a,{to:"/docs/cloud/accounts#create-account-and-login"},{default:o(()=>[e("create and login to your free Cloud Account")]),_:1}),e(" automatically with GitHub. If you don’t have a GitHub account or prefer not to use this login method, email-and-password login is available, as well. Once logged in, create a new Team or select an existing Team. Then you can access and manage the Team’s associated Projects, billing details, Team Members, Activity and Settings.")]),_,t("p",null,[e("Remember: The Dashboard layout itself is designed to manage "),s(a,{to:"/docs/cloud/glossary#accounts"},{default:o(()=>[e("Accounts")]),_:1}),e(", "),s(a,{to:"/docs/cloud/glossary#teams"},{default:o(()=>[e("Teams")]),_:1}),e(" and "),s(a,{to:"/docs/cloud/glossary#projects"},{default:o(()=>[e("Projects")]),_:1}),e(". Here’s how the Dashboard layout relates to each of these components:")]),f,y,t("ul",null,[t("li",null,[b,e(" — View Directus Cloud "),s(a,{to:"/docs/cloud/glossary#system-status"},{default:o(()=>[e("system status")]),_:1}),e(".")]),v,T,t("li",null,[w,e(" — "),s(a,{to:"/docs/cloud/teams#create-a-team"},{default:o(()=>[e("Create new Teams")]),_:1}),e(" and navigate between Teams you are on.")]),t("li",null,[j,e(" — "),s(a,{to:"/docs/cloud/accounts"},{default:o(()=>[e("Access, edit or destroy Account")]),_:1}),e(".")])]),x,t("ul",null,[t("li",null,[s(a,{to:"/docs/cloud/teams"},{default:o(()=>[e("Team Members")]),_:1}),e(" — View, invite and remove other Team Members or leave a Team.")]),t("li",null,[s(a,{to:"/docs/cloud/teams#view-team-activity"},{default:o(()=>[e("Team Activity")]),_:1}),e(" — View Team activity such as Project creation and deletion, billing information changes, Member invitations and removals, etc.")]),t("li",null,[s(a,{to:"/docs/cloud/teams#update-team-settings"},{default:o(()=>[e("Team Settings")]),_:1}),e(" — Edit the Team Name and Team Slug, as well as "),s(a,{to:"/docs/cloud/teams#destroy-a-team"},{default:o(()=>[e("destroy a Team")]),_:1}),e(".")])]),P,t("ul",null,[t("li",null,[s(a,{to:"/docs/cloud/projects"},{default:o(()=>[e("Team Projects")]),_:1}),e(" — View and access all Projects managed within a Team. Click a Project to enter the Product Details Page and access, monitor, edit or delete a Project.")]),t("li",null,[s(a,{to:"/docs/cloud/teams#manage-billing"},{default:o(()=>[e("Team Billing")]),_:1}),e(" — View and manage billing details such as credit card information, usage, subscriptions and receipts.")])])])]),_:1})}}};export{O as default,V as description,S as modularExtension,q as readTime,M as title};

package/dist/assets/overview-923246fb.js

@@ -1 +0,0 @@
-import{a as r,o as n,e as i,y as d,u as e,q as a}from"./runtime-core.esm-bundler-753bcc58.js";const l=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,"Settings Module gives admins ability to bring the app to life. Data models, roles and permissions, flows, translations, branding and whitelabeling, and beyond")]),e("h2",{id:"project-settings",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#project-settings"},"#"),a(" Project Settings")]),e("h2",{id:"data-model",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#data-model"},"#"),a(" Data Model")]),e("h2",{id:"roles-%26-permissions",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#roles-%26-permissions"},"#"),a(" Roles & Permissions")]),e("h2",{id:"presets-and-bookmarks",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#presets-and-bookmarks"},"#"),a(" Presets and Bookmarks")]),e("h2",{id:"translation-strings",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#translation-strings"},"#"),a(" Translation Strings")]),e("h2",{id:"flows",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#flows"},"#"),a(" Flows")])],-1),f="Overview",b=!1,_={__name:"overview",setup(c,{expose:t}){const s={title:"Overview",modularExtension:!1};return t({frontmatter:s}),(h,m)=>{const o=r("docs-wrapper");return n(),i(o,{frontmatter:s},{default:d(()=>[l]),_:1})}}};export{_ as default,b as modularExtension,f as title};

package/dist/assets/oz-2586602f.js

@@ -1 +0,0 @@
-import{z as P}from"./index.5b245cc4.entry.js";function F(a,l){for(var i=0;i<l.length;i++){const u=l[i];if(typeof u!="string"&&!Array.isArray(u)){for(const o in u)if(o!=="default"&&!(o in a)){const f=Object.getOwnPropertyDescriptor(u,o);f&&Object.defineProperty(a,o,f.get?f:{enumerable:!0,get:()=>u[o]})}}}return Object.freeze(Object.defineProperty(a,Symbol.toStringTag,{value:"Module"}))}var g={};(function(a,l){(function(i){i(P)})(function(i){i.defineMode("oz",function(u){function o(e){return new RegExp("^(("+e.join(")|(")+"))\\b")}var f=/[\^@!\|<>#~\.\*\-\+\\/,=]/,v=/(<-)|(:=)|(=<)|(>=)|(<=)|(<:)|(>:)|(=:)|(\\=)|(\\=:)|(!!)|(==)|(::)/,b=/(:::)|(\.\.\.)|(=<:)|(>=:)/,s=["in","then","else","of","elseof","elsecase","elseif","catch","finally","with","require","prepare","import","export","define","do"],h=["end"],x=o(["true","false","nil","unit"]),y=o(["andthen","at","attr","declare","feat","from","lex","mod","div","mode","orelse","parser","prod","prop","scanner","self","syn","token"]),w=o(["local","proc","fun","case","class","if","cond","or","dis","choice","not","thread","try","raise","lock","for","suchthat","meth","functor"]),p=o(s),k=o(h);function c(e,n){if(e.eatSpace())return null;if(e.match(/[{}]/))return"bracket";if(e.match("[]"))return"keyword";if(e.match(b)||e.match(v))return"operator";if(e.match(x))return"atom";var t=e.match(w);if(t)return n.doInCurrentLine?n.doInCurrentLine=!1:n.currentIndent++,t[0]=="proc"||t[0]=="fun"?n.tokenize=E:t[0]=="class"?n.tokenize=S:t[0]=="meth"&&(n.tokenize=I),"keyword";if(e.match(p)||e.match(y))return"keyword";if(e.match(k))return n.currentIndent--,"keyword";var r=e.next();if(r=='"'||r=="'")return n.tokenize=A(r),n.tokenize(e,n);if(/[~\d]/.test(r)){if(r=="~")if(/^[0-9]/.test(e.peek())){if(e.next()=="0"&&e.match(/^[xX][0-9a-fA-F]+/)||e.match(/^[0-9]*(\.[0-9]+)?([eE][~+]?[0-9]+)?/))return"number"}else return null;return r=="0"&&e.match(/^[xX][0-9a-fA-F]+/)||e.match(/^[0-9]*(\.[0-9]+)?([eE][~+]?[0-9]+)?/)?"number":null}return r=="%"?(e.skipToEnd(),"comment"):r=="/"&&e.eat("*")?(n.tokenize=m,m(e,n)):f.test(r)?"operator":(e.eatWhile(/\w/),"variable")}function S(e,n){return e.eatSpace()?null:(e.match(/([A-Z][A-Za-z0-9_]*)|(`.+`)/),n.tokenize=c,"variable-3")}function I(e,n){return e.eatSpace()?null:(e.match(/([a-zA-Z][A-Za-z0-9_]*)|(`.+`)/),n.tokenize=c,"def")}function E(e,n){return e.eatSpace()?null:!n.hasPassedFirstStage&&e.eat("{")?(n.hasPassedFirstStage=!0,"bracket"):n.hasPassedFirstStage?(e.match(/([A-Z][A-Za-z0-9_]*)|(`.+`)|\$/),n.hasPassedFirstStage=!1,n.tokenize=c,"def"):(n.tokenize=c,null)}function m(e,n){for(var t=!1,r;r=e.next();){if(r=="/"&&t){n.tokenize=c;break}t=r=="*"}return"comment"}function A(e){return function(n,t){for(var r=!1,d,z=!1;(d=n.next())!=null;){if(d==e&&!r){z=!0;break}r=!r&&d=="\\"}return(z||!r)&&(t.tokenize=c),"string"}}function C(){var e=s.concat(h);return new RegExp("[\\[\\]]|("+e.join("|")+")$")}return{startState:function(){return{tokenize:c,currentIndent:0,doInCurrentLine:!1,hasPassedFirstStage:!1}},token:function(e,n){return e.sol()&&(n.doInCurrentLine=0),n.tokenize(e,n)},indent:function(e,n){var t=n.replace(/^\s+|\s+$/g,"");return t.match(k)||t.match(p)||t.match(/(\[])/)?u.indentUnit*(e.currentIndent-1):e.currentIndent<0?0:e.currentIndent*u.indentUnit},fold:"indent",electricInput:C(),lineComment:"%",blockCommentStart:"/*",blockCommentEnd:"*/"}}),i.defineMIME("text/x-oz","oz")})})();const _=F({__proto__:null,default:g},[g]);export{_ as o};

package/dist/assets/panels-42e3f60d.js

@@ -1,65 +0,0 @@
-import{a as l,o as c,e as h,y as e,u as t,q as s,z as a}from"./runtime-core.esm-bundler-753bcc58.js";const d={class:"markdown-body"},p=t("h2",{id:"extension-entrypoint",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#extension-entrypoint"},"#"),s(" Extension Entrypoint")],-1),u=t("p",null,[s("The entrypoint of your panel is the "),t("code",null,"index"),s(" file inside the "),t("code",null,"src/"),s(" folder of your extension package. It exports a configuration object with options to configure the behavior of your panel. When loading your panel, this object is imported by the Directus host.")],-1),m=t("p",null,"Example of an entrypoint:",-1),_=t("pre",null,[t("code",{class:"language-js"},[t("span",{class:"hljs-keyword"},"import"),s(),t("span",{class:"hljs-title class_"},"PanelComponent"),s(),t("span",{class:"hljs-keyword"},"from"),s(),t("span",{class:"hljs-string"},"'./panel.vue'"),s(`;
-
-`),t("span",{class:"hljs-keyword"},"export"),s(),t("span",{class:"hljs-keyword"},"default"),s(` {
-	`),t("span",{class:"hljs-attr"},"id"),s(": "),t("span",{class:"hljs-string"},"'custom'"),s(`,
-	`),t("span",{class:"hljs-attr"},"name"),s(": "),t("span",{class:"hljs-string"},"'Custom'"),s(`,
-	`),t("span",{class:"hljs-attr"},"icon"),s(": "),t("span",{class:"hljs-string"},"'box'"),s(`,
-	`),t("span",{class:"hljs-attr"},"description"),s(": "),t("span",{class:"hljs-string"},"'This is my custom panel!'"),s(`,
-	`),t("span",{class:"hljs-attr"},"component"),s(": "),t("span",{class:"hljs-title class_"},"PanelComponent"),s(`,
-	`),t("span",{class:"hljs-attr"},"options"),s(`: [
-		{
-			`),t("span",{class:"hljs-attr"},"field"),s(": "),t("span",{class:"hljs-string"},"'text'"),s(`,
-			`),t("span",{class:"hljs-attr"},"name"),s(": "),t("span",{class:"hljs-string"},"'Text'"),s(`,
-			`),t("span",{class:"hljs-attr"},"type"),s(": "),t("span",{class:"hljs-string"},"'string'"),s(`,
-			`),t("span",{class:"hljs-attr"},"meta"),s(`: {
-				`),t("span",{class:"hljs-attr"},"interface"),s(": "),t("span",{class:"hljs-string"},"'input'"),s(`,
-				`),t("span",{class:"hljs-attr"},"width"),s(": "),t("span",{class:"hljs-string"},"'full'"),s(`,
-			},
-		},
-	],
-	`),t("span",{class:"hljs-attr"},"minWidth"),s(": "),t("span",{class:"hljs-number"},"12"),s(`,
-	`),t("span",{class:"hljs-attr"},"minHeight"),s(": "),t("span",{class:"hljs-number"},"8"),s(`,
-};
-`)])],-1),g=t("h4",{id:"available-options",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#available-options"},"#"),s(" Available Options")],-1),f=t("li",null,[t("code",null,"id"),s(" — The unique key for this panel. It is good practice to scope proprietary panels with an author prefix.")],-1),y=t("li",null,[t("code",null,"name"),s(" — The human-readable name for this panel.")],-1),j=t("code",null,"icon",-1),b=t("li",null,[t("code",null,"description"),s(" — A short description (<80 characters) of this panel shown in the App.")],-1),x=t("li",null,[t("code",null,"component"),s(" — A reference to your panel component.")],-1),w=t("li",null,[t("code",null,"options"),s(" — The options of your panel. Can be either an options object or a dedicated Vue component.")],-1),k=t("li",null,[t("code",null,"minWidth"),s(" - The minimum width in grid units of your panel on a dashboard.")],-1),v=t("li",null,[t("code",null,"minHeight"),s(" - The minimum height in grid units of your panel on a dashboard.")],-1),T=t("h2",{id:"panel-component",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#panel-component"},"#"),s(" Panel Component")],-1),A=t("p",null,"The panel component is the part of your extension that will be rendered by the Directus App whenever your panel should be used for data visualization in a dashboard within the Insights module. This panel component has to be Vue component. The most straightforward way to write a Vue component is to use the Vue Single File Component syntax.",-1),V=t("p",null,"Example of a panel component using the Vue SFC syntax:",-1),C=t("pre",null,[t("code",{class:"language-vue"},`<template>
-	<div class="text" :class="{ 'has-header': showHeader }">
-		{{ text }}
-	</div>
-</template>
-
-<script>
-export default {
-	props: {
-		showHeader: {
-			type: Boolean,
-			default: false,
-		},
-		text: {
-			type: String,
-			default: '',
-		},
-	},
-};
-<\/script>
-
-<style scoped>
-.text {
-	padding: 12px;
-}
-
-.text.has-header {
-	padding: 0 12px;
-}
-</style>
-`)],-1),P=t("h4",{id:"available-props",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#available-props"},"#"),s(" Available Props")],-1),D=t("ul",null,[t("li",null,[t("code",null,"showHeader"),s(),t("strong",null,"boolean"),s(" — Whether the header is shown. Useful for alternative styling based on the extra/reduced space.")]),t("li",null,[t("code",null,"dashboard"),s(),t("strong",null,"uuid"),s(" - The UUID string of the dashboard containing the panel.")]),t("li",null,[t("code",null,"height"),s(),t("strong",null,"number"),s(" - The current configured height of the panel.")]),t("li",null,[t("code",null,"width"),s(),t("strong",null,"number"),s(" - The current configured width of the panel.")]),t("li",null,[t("code",null,"now"),s(),t("strong",null,"Date"),s(" - The Date object as of the moment of viewing the dashboard containing the panel.")])],-1),I=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Vue Version"),t("p",null,"The Directus App uses Vue 3. There might be 3rd party libraries that aren’t yet compatible with Vue 3.")],-1),S=t("h2",{id:"accessing-internal-systems",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#accessing-internal-systems"},"#"),s(" Accessing Internal Systems")],-1),E=t("p",null,[s("To access internal systems like the API or the stores, you can use the "),t("code",null,"useApi()"),s(" and "),t("code",null,"useStores()"),s(" composables exported by the "),t("code",null,"@directus/extensions-sdk"),s(" package. They can be used inside a "),t("code",null,"setup()"),s(" function like this:")],-1),H=t("pre",null,[t("code",{class:"language-js"},[t("span",{class:"hljs-keyword"},"import"),s(" { useApi, useStores } "),t("span",{class:"hljs-keyword"},"from"),s(),t("span",{class:"hljs-string"},"'@directus/extensions-sdk'"),s(`;
-
-`),t("span",{class:"hljs-keyword"},"export"),s(),t("span",{class:"hljs-keyword"},"default"),s(` {
-	`),t("span",{class:"hljs-title function_"},"setup"),s("("),t("span",{class:"hljs-params"}),s(`) {
-		`),t("span",{class:"hljs-keyword"},"const"),s(" api = "),t("span",{class:"hljs-title function_"},"useApi"),s(`();
-
-		`),t("span",{class:"hljs-keyword"},"const"),s(" { useCollectionsStore } = "),t("span",{class:"hljs-title function_"},"useStores"),s(`();
-		`),t("span",{class:"hljs-keyword"},"const"),s(" collectionsStore = "),t("span",{class:"hljs-title function_"},"useCollectionsStore"),s(`();
-
-		`),t("span",{class:"hljs-comment"},"// ..."),s(`
-	},
-};
-`)])],-1),z=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Vue Options API"),t("p",null,[s("If you prefer to use the Vue Options API, you can inject the "),t("code",null,"api"),s(" and "),t("code",null,"stores"),s(" properties directly.")])],-1),O="Custom Panels",U=!0,F="A guide on how to build custom Panels in Directus.",L="3 min read",G={__name:"panels",setup(B,{expose:i}){const o={title:"Custom Panels",modularExtension:!0,description:"A guide on how to build custom Panels in Directus.",readTime:"3 min read"};return i({frontmatter:o}),(W,q)=>{const n=l("router-link"),r=l("docs-wrapper");return c(),h(r,{frontmatter:o},{default:e(()=>[t("div",d,[t("blockquote",null,[t("p",null,[s("Panels are modular units of data visualization that exist within the "),a(n,{to:"/docs/app/insights"},{default:e(()=>[s("Insights module")]),_:1}),s(". Each panel exists within a Dashboard and can be positioned and resized as needed. "),a(n,{to:"/docs/getting-started/glossary#panels"},{default:e(()=>[s("Learn more about Panels")]),_:1}),s(".")])]),p,u,m,_,g,t("ul",null,[f,y,t("li",null,[j,s(" — An icon name from the "),a(n,{to:"/docs/getting-started/glossary#material-icons"},{default:e(()=>[s("material icon set")]),_:1}),s(", or the extended list of Directus custom icons.")]),b,x,w,k,v]),T,A,V,C,P,D,I,S,E,H,z])]),_:1})}}};export{G as default,F as description,U as modularExtension,L as readTime,O as title};