@directus/app 9.12.2 → 9.14.1

package/dist/assets/operations.22151874.js

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

package/dist/assets/operations.50a08aae.js

@@ -1 +0,0 @@
-import{a as l,o as d,b as c,w as t,g as e,e as n,B as o}from"./runtime-core.esm-bundler.b1f35d24.js";var i={};const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"Operations are the actions performed after the Flow is triggered. Whether you need to access and create Data within Directus, send information off to outside services, create time-oriented Flows, set conditional logic or even trigger other Flows, these simple but powerful tasks can make it happen.")],-1),_=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#condition"},"Condition")]),e("li",null,[e("a",{href:"#create-data"},"Create Data")]),e("li",null,[e("a",{href:"#delete-data"},"Delete Data")]),e("li",null,[e("a",{href:"#read-data"},"Read Data")]),e("li",null,[e("a",{href:"#update-data"},"Update Data")]),e("li",null,[e("a",{href:"#log-to-console"},"Log to Console")]),e("li",null,[e("a",{href:"#send-email"},"Send Email")]),e("li",null,[e("a",{href:"#send-notification"},"Send Notification")]),e("li",null,[e("a",{href:"#webhook-%2F-request-url"},"Webhook / Request URL")]),e("li",null,[e("a",{href:"#sleep"},"Sleep")]),e("li",null,[e("a",{href:"#transform-payload"},"Transform Payload")]),e("li",null,[e("a",{href:"#trigger-flow"},"Trigger Flow")])])])],-1),p={class:"tip hint"},f=e("div",{class:"hint-title"},"Before You Begin",-1),m=o("Please be sure to read the documentation on "),g=o("Flows"),w=o(" and "),y=o("Triggers"),b=o("."),I=e("h2",{id:"condition"},[o("Condition "),e("a",{class:"header-anchor",href:"#condition"},"#")],-1),v=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/condition-20220603A.webp",alt:"Condition"})],-1),D=e("p",null,[o("Routes to the next success or failure Operation based on some conditional "),e("code",{class:""},"if"),o(" / "),e("code",{class:""},"else"),o(" logic defined by a Filter query. That means if the query condition is met, the Flow will move forward with the success Operation. Otherwise, the failure Operation will be initiated.")],-1),C=e("strong",null,"Condition Rules",-1),S=o(" \u2014 Create conditions with "),k=o("Filter Rules"),O=o("."),T=e("h2",{id:"create-data"},[o("Create Data "),e("a",{class:"header-anchor",href:"#create-data"},"#")],-1),F=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),A=e("p",null,"Creates some Item(s) in a Collection.",-1),q=e("li",null,[e("strong",null,"Collection"),o(" \u2014 Use the dropdown to select a Collection to create Items in.")],-1),R=e("li",null,[e("strong",null,"Permissions"),o(" \u2014 Set the scope of permissions used for this Operation.")],-1),P=e("li",null,[e("strong",null,"Emit Events"),o(" \u2014 Toggle whether the event is emitted.")],-1),U=e("strong",null,"Payload",-1),x=o(" \u2014 Create Item(s) in a Collection. To learn more, see "),E=o("API > Items"),L=o("."),N={class:"tip hint"},j=o("Make sure the Operation is scoped with the "),B=o("permissions"),M=o(" necessary to create Items."),W=e("h2",{id:"delete-data"},[o("Delete Data "),e("a",{class:"header-anchor",href:"#delete-data"},"#")],-1),J=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),Y=e("p",null,"Deletes some Item(s) from a Collection by ID or query.",-1),H=e("li",null,[e("strong",null,"Permissions"),o(" \u2014 Set the scope of permissions used for this Operation.")],-1),Q=e("li",null,[e("strong",null,"Collection"),o(" \u2014 Use the dropdown to set the Collection to delete Items from.")],-1),V=e("li",null,[e("strong",null,"IDs"),o(" \u2014 Set Item IDs and press enter to confirm. Click the ID to remove.")],-1),G=e("strong",null,"Query",-1),z=o(" \u2014 Select Items to delete with a query. To learn more, see "),K=o("Filter Rules"),X=o("."),Z={class:"tip hint"},$=o("Make sure the Operation is scoped with the "),ee=o("permissions"),oe=o(" necessary to delete Items."),te=e("h2",{id:"read-data"},[o("Read Data "),e("a",{class:"header-anchor",href:"#read-data"},"#")],-1),se=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),ne=e("p",null,"Reads Item(s) form a Collection and adds them onto the Flow Object. You may select Items by their ID or run a query to select the Items you wish to update.",-1),le=e("li",null,[e("strong",null,"Permissions"),o(" \u2014 Set the scope of permissions used for this Operation.")],-1),ie=e("li",null,[e("strong",null,"Collections"),o(" \u2014 Select the Collection to read Items from.")],-1),ae=e("li",null,[e("strong",null,"IDs"),o(" \u2014 Input ID for Item(s) you wish to read and press enter. Click the ID to remove.")],-1),re=e("strong",null,"Query",-1),de=o(" \u2014 Select Items with a query. To learn more, see "),ce=o("Filter Rules"),he=o("."),ue=e("h2",{id:"update-data"},[o("Update Data "),e("a",{class:"header-anchor",href:"#update-data"},"#")],-1),_e=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,"Updates Item(s) in a Collection. You may select Items by their ID or run a query to select the Items you wish to update.",-1),fe=e("li",null,[e("strong",null,"Permissions"),o(" \u2014 Defines Role that this Operation will inherit permissions from.")],-1),me=e("li",null,[e("strong",null,"Collections"),o(" \u2014 Select the Collection to read Items from.")],-1),ge=e("li",null,[e("strong",null,"IDs"),o(" \u2014 Input ID for Item(s) you wish to read and press enter. Click the ID to remove.")],-1),we=e("strong",null,"Payload",-1),ye=o(" \u2014 Updates Item(s) in a Collection. To learn more, see "),be=o("API > Items"),Ie=o("."),ve=e("strong",null,"Query",-1),De=o(" \u2014 Select Items to update with a query. To learn more, see "),Ce=o("Filter Rules"),Se=o("."),ke=e("h2",{id:"log-to-console"},[o("Log to Console "),e("a",{class:"header-anchor",href:"#log-to-console"},"#")],-1),Oe=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/log-to-console-20220603A.webp",alt:"Log to Console"})],-1),Te=e("p",null,"Output something to the console. This will appear in both the server side and in-app Sidebar Console Log. This is a key tool to help troubleshoot Flow configuration.",-1),Fe=e("ul",null,[e("li",null,[e("strong",null,"Message"),o(" \u2014 Sets a "),e("a",{href:"#configuration/flows/flows/logs"},"log message"),o(".")])],-1),Ae=e("div",{class:"tip hint"},[e("p",null,"This will be delivered to your in-app Log Panel and also logged to the server-side console.")],-1),qe=e("h2",{id:"send-email"},[o("Send Email "),e("a",{class:"header-anchor",href:"#send-email"},"#")],-1),Re=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),Pe=e("p",null,"Sends email(s). Flow Object keys can be used as variables. This means an array of emails from a previous step in Flows could be used.",-1),Ue=e("ul",null,[e("li",null,[e("strong",null,"To"),o(" \u2014 Sets email addresses. Hit "),e("code",{class:""},"\u21B5"),o(" to save the email. Click an email to remove it.")]),e("li",null,[e("strong",null,"Subject"),o(" \u2014 Set subject line.")]),e("li",null,[e("strong",null,"Body"),o(" \u2014 Provides WYSIWYG editor to create email body.")])],-1),xe=e("div",{class:"tip hint"},[e("p",null,[o("If you are testing out this Operation locally from "),e("code",{class:""},"localhost:8080"),o(", be sure to check your spam box as your email provider may send it there automatically.")])],-1),Ee=e("h2",{id:"send-notification"},[o("Send Notification "),e("a",{class:"header-anchor",href:"#send-notification"},"#")],-1),Le=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),Ne=e("p",null,"Sends a notification to an app user.",-1),je=e("strong",null,"Users",-1),Be=o(" \u2014 Defines a User by their primary key UUID. Use "),Me=o("Flow keys"),We=o(" to set this dynamically."),Je=e("li",null,[e("strong",null,"Permissions"),o(" \u2014 Defines Role that this Operation will inherit permissions from.")],-1),Ye=e("li",null,[e("strong",null,"Title"),o(" \u2014 Sets the notification title.")],-1),He=e("li",null,[e("strong",null,"Message"),o(" \u2014 Sets the main body of the notification.")],-1),Qe=e("h2",{id:"webhook-%2F-request-url"},[o("Webhook / Request URL "),e("a",{class:"header-anchor",href:"#webhook-%2F-request-url"},"#")],-1),Ve=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/webhook-20220603A.webp",alt:"Webhok / Request URL"})],-1),Ge=e("p",null,"Makes a request to another URL.",-1),ze=e("ul",null,[e("li",null,[e("strong",null,"Method"),o(" \u2014 Choose to make a GET, POST, PATCH, DELETE, or other type of request.")]),e("li",null,[e("strong",null,"URL"),o(" \u2014 Define the URL to send request to.")]),e("li",null,[e("strong",null,"Headers"),o(" \u2014 Create new "),e("code",{class:""},"header:value"),o(" to pass along with the request.")]),e("li",null,[e("strong",null,"Request Body"),o(" \u2014 Set request body data. Use any string or JSON.")])],-1),Ke=e("h2",{id:"sleep"},[o("Sleep "),e("a",{class:"header-anchor",href:"#sleep"},"#")],-1),Xe=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/sleep-20220603A.webp",alt:"Sleep"})],-1),Ze=e("p",null,"Pauses Operation Execution on the Flow for a given amount of milliseconds. Then continues to the next Operation.",-1),$e=e("ul",null,[e("li",null,[e("strong",null,"Milliseconds"),o(" \u2014 Define the number of milliseconds to pause.")])],-1),eo=e("h2",{id:"transform-payload"},[o("Transform Payload "),e("a",{class:"header-anchor",href:"#transform-payload"},"#")],-1),oo=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),to=e("p",null,[o("Transform Payload simply creates a new key on the Flow Object with nested JSON data. This provides a clean space where you can combine data from multiple Flow keys all into one object. So for example, if you needed to use the same data multiple times "),e("em",null,"(e.g. send it in a web request and also use it to create an Item in a Collection)"),o(", you can combine the data one time with Transform Payload, then use its Operation key again and again.")],-1),so=e("ul",null,[e("li",null,[e("strong",null,"JSON"),o(" \u2014 Define JSON to insert into the Flow Object.")])],-1),no=e("h2",{id:"trigger-flow"},[o("Trigger Flow "),e("a",{class:"header-anchor",href:"#trigger-flow"},"#")],-1),lo=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),io=o("This Operation starts another Flow and passes data to it. It should be used in combination with the "),ao=o("Another Flow"),ro=o(" Trigger."),co=e("ul",null,[e("li",null,[e("strong",null,"Flow"),o(" \u2014 Define a Flow by its primary key UUID.")]),e("li",null,[e("strong",null,"Payload"),o(" \u2014 Define JSON to insert into the Flow Object.")])],-1),ho={title:"Operations",modularExtension:!1},uo={name:"operations",setup(_o,{expose:a}){return a({frontmatter:{title:"Operations",modularExtension:!1}}),(po,fo)=>{const s=l("router-link"),r=l("docswrapper");return d(),c(r,{frontmatter:ho},{default:t(()=>[e("div",h,[u,_,e("div",p,[f,e("p",null,[m,n(s,{to:"/docs/configuration/flows/flows"},{default:t(()=>[g]),_:1}),w,n(s,{to:"/docsflows/triggers"},{default:t(()=>[y]),_:1}),b])]),I,v,D,e("ul",null,[e("li",null,[C,S,n(s,{to:"/docs/configuration/filter-rules"},{default:t(()=>[k]),_:1}),O])]),T,F,A,e("ul",null,[q,R,P,e("li",null,[U,x,n(s,{to:"/docsreference/items/"},{default:t(()=>[E]),_:1}),L])]),e("div",N,[e("p",null,[j,n(s,{to:"/docsconfiguration/users-roles-permissions"},{default:t(()=>[B]),_:1}),M])]),W,J,Y,e("ul",null,[H,Q,V,e("li",null,[G,z,n(s,{to:"/docs/configuration/filter-rules"},{default:t(()=>[K]),_:1}),X])]),e("div",Z,[e("p",null,[$,n(s,{to:"/docsconfiguration/users-roles-permissions"},{default:t(()=>[ee]),_:1}),oe])]),te,se,ne,e("ul",null,[le,ie,ae,e("li",null,[re,de,n(s,{to:"/docs/configuration/filter-rules"},{default:t(()=>[ce]),_:1}),he])]),ue,_e,pe,e("ul",null,[fe,me,ge,e("li",null,[we,ye,n(s,{to:"/docsreference/items/"},{default:t(()=>[be]),_:1}),Ie]),e("li",null,[ve,De,n(s,{to:"/docs/configuration/filter-rules"},{default:t(()=>[Ce]),_:1}),Se])]),ke,Oe,Te,Fe,Ae,qe,Re,Pe,Ue,xe,Ee,Le,Ne,e("ul",null,[e("li",null,[je,Be,n(s,{to:"/docs/configuration/flows/flows/#the-flow-object"},{default:t(()=>[Me]),_:1}),We]),Je,Ye,He]),Qe,Ve,Ge,ze,Ke,Xe,Ze,$e,eo,oo,to,so,no,lo,e("p",null,[io,n(s,{to:"/docs/configuration/triggers/#another-flow"},{default:t(()=>[ao]),_:1}),ro]),co])]),_:1})}}};typeof i=="function"&&i(uo);export{uo as default,ho as frontmatter};

package/dist/assets/overview.3436365c.js

@@ -1 +0,0 @@
-import{a as n,o as l,b as r,w as o,g as t,e as a,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var c={};const u={class:"markdown-body"},_=t("blockquote",null,[t("p",null,"Whether you\u2019re 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),m=t("p",null,[t("div",{class:"table-of-contents"},[t("ul",null,[t("li",null,[t("a",{href:"#getting-started"},"Getting Started")]),t("li",null,[t("a",{href:"#accounts"},"Accounts")]),t("li",null,[t("a",{href:"#teams"},"Teams")]),t("li",null,[t("a",{href:"#projects"},"Projects")])])])],-1),p=t("a",{href:"https://directus.cloud/",target:"_blank",rel:"noopener noreferrer"},"Directus Cloud",-1),g=e(" is a hosting platform for "),f=e("Directus Projects"),v=e(" which handles data storage, hosting, updates and scalability so you can focus on building your digital apps and experiences. There are three "),y=e("tiers of Cloud Projects"),b=e(": Community, Standard and Enterprise. All three tiers come with all the great features of Directus Core, as well as all "),T=e("Cloud Exclusive"),w=e(" extensions."),j=e("The Cloud Dashboard is constructed to manage three key components: "),P=e("Accounts"),A=e(", "),C=e("Teams"),x=e(" and "),k=e("Projects"),D=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\u2019s complete, you can create Projects within a Team."),M=e("Accounts can be Members on multiple Teams. All Team Members have SuperAdmin privileges to manage the Team\u2019s Projects, Project "),S=e("billing"),V=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."),O=t("h2",{id:"getting-started"},[e("Getting Started "),t("a",{class:"header-anchor",href:"#getting-started"},"#")],-1),B=e("To make life easy, you have the option to "),E=e("create and login to your free Cloud Account"),H=e(" automatically with GitHub. If you don\u2019t 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\u2019s associated Projects, billing details, Team Members, Activity and Settings."),N=t("video",{alt:"Cloud Dashboard Overview",loop:"",muted:"",controls:"",autoplay:""},[t("source",{src:"https://cdn.directus.io/docs/v9/cloud/overview/overview-20220322A/cloud-dashboard-overview-20220329A.mp4",type:"video/mp4"})],-1),G=e("Remember: The Dashboard layout itself is designed to manage "),q=e("Accounts"),F=e(", "),I=e("Teams"),R=e(" and "),W=e("Projects"),z=e(". Here\u2019s how the Dashboard layout relates to each of these components:"),J=t("h2",{id:"accounts"},[e("Accounts "),t("a",{class:"header-anchor",href:"#accounts"},"#")],-1),K=t("h3",{id:"cloud-dashboard-header"},[e("Cloud Dashboard Header "),t("a",{class:"header-anchor",href:"#cloud-dashboard-header"},"#")],-1),L=t("span",{mi:"",icon:""},"check",-1),Q=e(" \u2014 View Directus Cloud "),U=e("system status"),X=e("."),Y=t("li",null,[t("span",{mi:"",icon:""},"notifications"),e(" \u2014 Notifications such as version upgrades, platform upgrades, etc.")],-1),Z=t("li",null,[t("span",{mi:"",icon:""},"help_outline"),e(" \u2014 Documentation, Community Support and Request for Premium Support.")],-1),$=t("span",{mi:"",icon:""},"expand_more",-1),ee=e(" \u2014 "),te=e("Create new Teams"),oe=e(" and navigate between Teams you are on."),se=t("span",{mi:"",icon:""},"account_circle",-1),ae=e(" \u2014 "),ne=e("Access, edit or destroy Account"),ce=e("."),ie=t("h2",{id:"teams"},[e("Teams "),t("a",{class:"header-anchor",href:"#teams"},"#")],-1),de=e("Team Members"),le=e(" \u2014 View, invite and remove other Team Members or leave a Team."),re=e("Team Activity"),ue=e(" \u2014 View Team activity such as Project creation and deletion, billing information changes, Member invitations and removals, etc."),_e=e("Team Settings"),he=e(" \u2014 Edit the Team Name and Team Slug, as well as "),me=e("destroy a Team"),pe=e("."),ge=t("h2",{id:"projects"},[e("Projects "),t("a",{class:"header-anchor",href:"#projects"},"#")],-1),fe=e("Team Projects"),ve=e(" \u2014 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."),ye=e("Team Billing"),be=e(" \u2014 View and manage billing details such as credit card information, usage, subscriptions and receipts."),Te={title:"Overview",modularExtension:!1},we={name:"overview",setup(je,{expose:i}){return i({frontmatter:{title:"Overview",modularExtension:!1}}),(Pe,Ae)=>{const s=n("router-link"),d=n("docswrapper");return l(),r(d,{frontmatter:Te},{default:o(()=>[t("div",u,[_,h,m,t("p",null,[p,g,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[f]),_:1}),v,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[y]),_:1}),b,a(s,{to:"/docs/cloud/glossary/#cloud-exclusives"},{default:o(()=>[T]),_:1}),w]),t("p",null,[j,a(s,{to:"/docs/cloud/glossary/#accounts"},{default:o(()=>[P]),_:1}),A,a(s,{to:"/docs/cloud/glossary/#teams"},{default:o(()=>[C]),_:1}),x,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[k]),_:1}),D]),t("p",null,[M,a(s,{to:"/docs/cloud/teams/#manage-billing"},{default:o(()=>[S]),_:1}),V]),O,t("p",null,[B,a(s,{to:"/docs/cloud/accounts/#create-account-and-login"},{default:o(()=>[E]),_:1}),H]),N,t("p",null,[G,a(s,{to:"/docs/cloud/glossary/#accounts"},{default:o(()=>[q]),_:1}),F,a(s,{to:"/docs/cloud/glossary/#teams"},{default:o(()=>[I]),_:1}),R,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[W]),_:1}),z]),J,K,t("ul",null,[t("li",null,[L,Q,a(s,{to:"/docs/cloud/glossary/#system-status"},{default:o(()=>[U]),_:1}),X]),Y,Z,t("li",null,[$,ee,a(s,{to:"/docs/cloud/teams/#create-a-team"},{default:o(()=>[te]),_:1}),oe]),t("li",null,[se,ae,a(s,{to:"/docs/cloud/accounts"},{default:o(()=>[ne]),_:1}),ce])]),ie,t("ul",null,[t("li",null,[a(s,{to:"/docs/cloud/teams"},{default:o(()=>[de]),_:1}),le]),t("li",null,[a(s,{to:"/docs/cloud/teams/#view-team-activity"},{default:o(()=>[re]),_:1}),ue]),t("li",null,[a(s,{to:"/docs/cloud/teams/#update-team-settings"},{default:o(()=>[_e]),_:1}),he,a(s,{to:"/docs/cloud/teams/#destroy-a-team"},{default:o(()=>[me]),_:1}),pe])]),ge,t("ul",null,[t("li",null,[a(s,{to:"/docs/cloud/projects"},{default:o(()=>[fe]),_:1}),ve]),t("li",null,[a(s,{to:"/docs/cloud/teams/#manage-billing"},{default:o(()=>[ye]),_:1}),be])])])]),_:1})}}};typeof c=="function"&&c(we);export{we as default,Te as frontmatter};

package/dist/assets/overview.623fafba.js

@@ -1 +0,0 @@
-import{a as i,o as c,b as d,w as o,g as t,e as s,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var u="assets/app-overview.6445a201.svg";var a={};const h={class:"markdown-body"},p=t("blockquote",null,[t("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),_=t("img",{src:u,alt:"Directus Application Overview",class:"no-shadow"},null,-1),g=t("h2",{id:"1.-module-bar"},[e("1. Module Bar "),t("a",{class:"header-anchor",href:"#1.-module-bar"},"#")],-1),f=t("p",null,"The leftmost section of the App is the module bar, which includes the:",-1),m=t("li",null,[t("strong",null,"Project Logo"),e(" \u2014 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),v=t("strong",null,"Module Navigation",-1),y=e(" \u2014 Allows navigating between the different modules your user has access to. Customizing the Module Navigation is done within the "),b=e("Project Settings"),w=e(", but the default module list includes: "),k=e("Content"),A=e(" \u2014 The primary way to view and interact with database content"),T=e("User Directory"),x=e(" \u2014 A dedicated section for the platform\u2019s system Users"),P=e("File Library"),N=e(" \u2014 An aggregate of all files uploaded and managed within the platform"),C=e("Insights"),j=e(" \u2014 Access to infinitely customizable data dashboards"),B=e("App Guide"),I=e(" \u2014 A tailored, in-app portal for the platform\u2019s concepts, guides, and reference"),S=e("Settings"),D=e(" \u2014 An admin-only section for configuring the project and system settings"),M=t("strong",null,"Notifications",-1),L=e(" - Opens a drawer of notifications, such as from "),U=e("mentions"),z=e("."),O=t("li",null,[t("strong",null,"Current User Menu"),e(" \u2014 This component displays the authenticated user\u2019s name and avatar. "),t("ul",null,[t("li",null,"Sign Out \u2014 Hovering over the User Menu exposes the button to log out of the platform.")])],-1),V=t("h2",{id:"2.-navigation-bar"},[e("2. Navigation Bar "),t("a",{class:"header-anchor",href:"#2.-navigation-bar"},"#")],-1),E=t("p",null,"The navigation bar is based on the current module, and includes:",-1),F=t("strong",null,"Project Name",-1),H=e(" \u2014 Shows an icon and tooltip indicating the API\u2019s connection strength, and the name of your current project, which can be configured under "),R=e("Project Settings"),q=e("."),G=t("strong",null,"Navigation",-1),X=e(" \u2014 This is a dynamic navigation based on your current module. Some modules also support "),J=e("Bookmark Presets"),K=e(", which are a customizable links to specific data-sets."),Q=t("h2",{id:"3.-page"},[e("3. Page "),t("a",{class:"header-anchor",href:"#3.-page"},"#")],-1),W=t("p",null,"This is where the current page\u2019s content is shown, including:",-1),Y=t("ul",null,[t("li",null,[t("strong",null,"Header"),e(" \u2014 A fixed section at the top of each page, the header includes: "),t("ul",null,[t("li",null,"Page Icon \u2014 Clicking this navigates back to the previous page."),t("li",null,"Module Name \u2014 Clicking this navigates to the parent module/section."),t("li",null,"Page Title \u2014 Displays dynamic title of the current page."),t("li",null,"Action Buttons \u2014 Right-aligned contextual buttons for specific page actions.")])]),t("li",null,[t("strong",null,"Page Content"),e(" \u2014 This displays the content of the page you navigated to.")])],-1),Z=t("h2",{id:"4.-sidebar"},[e("4. Sidebar "),t("a",{class:"header-anchor",href:"#4.-sidebar"},"#")],-1),$=t("p",null,"The sidebar provides additional context and options for the current page, including:",-1),tt=t("ul",null,[t("li",null,[t("strong",null,"Page Components"),e(" \u2014 Lists any contextual page components available. The \u201CInfo\u201D component is available on every page, explaining the page\u2019s 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 \u201CX\u201D in the top-right.")]),t("li",null,[t("strong",null,"Notifications Tray"),e(" \u2014 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),et={title:"The Application",modularExtension:!1},ot={name:"overview",setup(nt,{expose:l}){return l({frontmatter:{title:"The Application",modularExtension:!1}}),(st,it)=>{const n=i("router-link"),r=i("docswrapper");return c(),d(r,{frontmatter:et},{default:o(()=>[t("div",h,[p,_,g,f,t("ul",null,[m,t("li",null,[v,y,s(n,{to:"/docs/app/settings"},{default:o(()=>[b]),_:1}),w,t("ul",null,[t("li",null,[s(n,{to:"/docs/app/content-collections/"},{default:o(()=>[k]),_:1}),A]),t("li",null,[s(n,{to:"/docs/app/user-directory"},{default:o(()=>[T]),_:1}),x]),t("li",null,[s(n,{to:"/docs/app/file-library"},{default:o(()=>[P]),_:1}),N]),t("li",null,[s(n,{to:"/docs/app/insights"},{default:o(()=>[C]),_:1}),j]),t("li",null,[s(n,{to:"/docs/app/overview/"},{default:o(()=>[B]),_:1}),I]),t("li",null,[s(n,{to:"/docs/app/settings"},{default:o(()=>[S]),_:1}),D])])]),t("li",null,[M,L,s(n,{to:"/docs/app/content-items/#mentions"},{default:o(()=>[U]),_:1}),z]),O]),V,E,t("ul",null,[t("li",null,[F,H,s(n,{to:"/docs/app/settings"},{default:o(()=>[R]),_:1}),q]),t("li",null,[G,X,s(n,{to:"/docs/getting-started/glossary/#presets"},{default:o(()=>[J]),_:1}),K])]),Q,W,Y,Z,$,tt])]),_:1})}}};typeof a=="function"&&a(ot);export{ot as default,et as frontmatter};

package/dist/assets/overview.dbebe94a.js

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

package/dist/assets/panels.385b173a.js

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