@directus/app 9.10.0 → 9.12.0

package/dist/assets/{q.61a8ab64.js → q.d3d8a6a4.js}

@@ -1 +1 @@
-import{bV as w}from"./vendor.e0a21029.js";function j(f,s){return s.forEach(function(i){i&&typeof i!="string"&&!Array.isArray(i)&&Object.keys(i).forEach(function(c){if(c!=="default"&&!(c in f)){var d=Object.getOwnPropertyDescriptor(i,c);Object.defineProperty(f,c,d.get?d:{enumerable:!0,get:function(){return i[c]}})}})}),Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var v={exports:{}};(function(f,s){(function(i){i(w.exports)})(function(i){i.defineMode("q",function(c){var d=c.indentUnit,l,a=k(["abs","acos","aj","aj0","all","and","any","asc","asin","asof","atan","attr","avg","avgs","bin","by","ceiling","cols","cor","cos","count","cov","cross","csv","cut","delete","deltas","desc","dev","differ","distinct","div","do","each","ej","enlist","eval","except","exec","exit","exp","fby","fills","first","fkeys","flip","floor","from","get","getenv","group","gtime","hclose","hcount","hdel","hopen","hsym","iasc","idesc","if","ij","in","insert","inter","inv","key","keys","last","like","list","lj","load","log","lower","lsq","ltime","ltrim","mavg","max","maxs","mcount","md5","mdev","med","meta","min","mins","mmax","mmin","mmu","mod","msum","neg","next","not","null","or","over","parse","peach","pj","plist","prd","prds","prev","prior","rand","rank","ratios","raze","read0","read1","reciprocal","reverse","rload","rotate","rsave","rtrim","save","scan","select","set","setenv","show","signum","sin","sqrt","ss","ssr","string","sublist","sum","sums","sv","system","tables","tan","til","trim","txf","type","uj","ungroup","union","update","upper","upsert","value","var","view","views","vs","wavg","where","where","while","within","wj","wj1","wsum","xasc","xbar","xcol","xcols","xdesc","xexp","xgroup","xkey","xlog","xprev","xrank"]),m=/[|/&^!+:\\\-*%$=~#;@><,?_\'\"\[\(\]\)\s{}]/;function k(e){return new RegExp("^("+e.join("|")+")$")}function u(e,n){var o=e.sol(),t=e.next();if(l=null,o){if(t=="/")return(n.tokenize=g)(e,n);if(t=="\\")return e.eol()||/\s/.test(e.peek())?(e.skipToEnd(),/^\\\s*$/.test(e.current())?(n.tokenize=y)(e):n.tokenize=u,"comment"):(n.tokenize=u,"builtin")}if(/\s/.test(t))return e.peek()=="/"?(e.skipToEnd(),"comment"):"whitespace";if(t=='"')return(n.tokenize=b)(e,n);if(t=="`")return e.eatWhile(/[A-Za-z\d_:\/.]/),"symbol";if(t=="."&&/\d/.test(e.peek())||/\d/.test(t)){var r=null;return e.backUp(1),e.match(/^\d{4}\.\d{2}(m|\.\d{2}([DT](\d{2}(:\d{2}(:\d{2}(\.\d{1,9})?)?)?)?)?)/)||e.match(/^\d+D(\d{2}(:\d{2}(:\d{2}(\.\d{1,9})?)?)?)/)||e.match(/^\d{2}:\d{2}(:\d{2}(\.\d{1,9})?)?/)||e.match(/^\d+[ptuv]{1}/)?r="temporal":(e.match(/^0[NwW]{1}/)||e.match(/^0x[\da-fA-F]*/)||e.match(/^[01]+[b]{1}/)||e.match(/^\d+[chijn]{1}/)||e.match(/-?\d*(\.\d*)?(e[+\-]?\d+)?(e|f)?/))&&(r="number"),r&&(!(t=e.peek())||m.test(t))?r:(e.next(),"error")}return/[A-Za-z]|\./.test(t)?(e.eatWhile(/[A-Za-z._\d]/),a.test(e.current())?"keyword":"variable"):/[|/&^!+:\\\-*%$=~#;@><\.,?_\']/.test(t)||/[{}\(\[\]\)]/.test(t)?null:"error"}function g(e,n){return e.skipToEnd(),/\/\s*$/.test(e.current())?(n.tokenize=h)(e,n):n.tokenize=u,"comment"}function h(e,n){var o=e.sol()&&e.peek()=="\\";return e.skipToEnd(),o&&/^\\\s*$/.test(e.current())&&(n.tokenize=u),"comment"}function y(e){return e.skipToEnd(),"comment"}function b(e,n){for(var o=!1,t,r=!1;t=e.next();){if(t=='"'&&!o){r=!0;break}o=!o&&t=="\\"}return r&&(n.tokenize=u),"string"}function p(e,n,o){e.context={prev:e.context,indent:e.indent,col:o,type:n}}function x(e){e.indent=e.context.indent,e.context=e.context.prev}return{startState:function(){return{tokenize:u,context:null,indent:0,col:0}},token:function(e,n){e.sol()&&(n.context&&n.context.align==null&&(n.context.align=!1),n.indent=e.indentation());var o=n.tokenize(e,n);if(o!="comment"&&n.context&&n.context.align==null&&n.context.type!="pattern"&&(n.context.align=!0),l=="(")p(n,")",e.column());else if(l=="[")p(n,"]",e.column());else if(l=="{")p(n,"}",e.column());else if(/[\]\}\)]/.test(l)){for(;n.context&&n.context.type=="pattern";)x(n);n.context&&l==n.context.type&&x(n)}else l=="."&&n.context&&n.context.type=="pattern"?x(n):/atom|string|variable/.test(o)&&n.context&&(/[\}\]]/.test(n.context.type)?p(n,"pattern",e.column()):n.context.type=="pattern"&&!n.context.align&&(n.context.align=!0,n.context.col=e.column()));return o},indent:function(e,n){var o=n&&n.charAt(0),t=e.context;if(/[\]\}]/.test(o))for(;t&&t.type=="pattern";)t=t.prev;var r=t&&o==t.type;return t?t.type=="pattern"?t.col:t.align?t.col+(r?0:1):t.indent+(r?0:d):0}}}),i.defineMIME("text/x-q","q")})})();var z=v.exports,q=j({__proto__:null,default:z},[v.exports]);export{q};
+import{bW as w}from"./vendor.f6090249.js";function j(f,s){return s.forEach(function(i){i&&typeof i!="string"&&!Array.isArray(i)&&Object.keys(i).forEach(function(c){if(c!=="default"&&!(c in f)){var d=Object.getOwnPropertyDescriptor(i,c);Object.defineProperty(f,c,d.get?d:{enumerable:!0,get:function(){return i[c]}})}})}),Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var v={exports:{}};(function(f,s){(function(i){i(w.exports)})(function(i){i.defineMode("q",function(c){var d=c.indentUnit,l,a=k(["abs","acos","aj","aj0","all","and","any","asc","asin","asof","atan","attr","avg","avgs","bin","by","ceiling","cols","cor","cos","count","cov","cross","csv","cut","delete","deltas","desc","dev","differ","distinct","div","do","each","ej","enlist","eval","except","exec","exit","exp","fby","fills","first","fkeys","flip","floor","from","get","getenv","group","gtime","hclose","hcount","hdel","hopen","hsym","iasc","idesc","if","ij","in","insert","inter","inv","key","keys","last","like","list","lj","load","log","lower","lsq","ltime","ltrim","mavg","max","maxs","mcount","md5","mdev","med","meta","min","mins","mmax","mmin","mmu","mod","msum","neg","next","not","null","or","over","parse","peach","pj","plist","prd","prds","prev","prior","rand","rank","ratios","raze","read0","read1","reciprocal","reverse","rload","rotate","rsave","rtrim","save","scan","select","set","setenv","show","signum","sin","sqrt","ss","ssr","string","sublist","sum","sums","sv","system","tables","tan","til","trim","txf","type","uj","ungroup","union","update","upper","upsert","value","var","view","views","vs","wavg","where","where","while","within","wj","wj1","wsum","xasc","xbar","xcol","xcols","xdesc","xexp","xgroup","xkey","xlog","xprev","xrank"]),m=/[|/&^!+:\\\-*%$=~#;@><,?_\'\"\[\(\]\)\s{}]/;function k(e){return new RegExp("^("+e.join("|")+")$")}function u(e,n){var o=e.sol(),t=e.next();if(l=null,o){if(t=="/")return(n.tokenize=g)(e,n);if(t=="\\")return e.eol()||/\s/.test(e.peek())?(e.skipToEnd(),/^\\\s*$/.test(e.current())?(n.tokenize=y)(e):n.tokenize=u,"comment"):(n.tokenize=u,"builtin")}if(/\s/.test(t))return e.peek()=="/"?(e.skipToEnd(),"comment"):"whitespace";if(t=='"')return(n.tokenize=b)(e,n);if(t=="`")return e.eatWhile(/[A-Za-z\d_:\/.]/),"symbol";if(t=="."&&/\d/.test(e.peek())||/\d/.test(t)){var r=null;return e.backUp(1),e.match(/^\d{4}\.\d{2}(m|\.\d{2}([DT](\d{2}(:\d{2}(:\d{2}(\.\d{1,9})?)?)?)?)?)/)||e.match(/^\d+D(\d{2}(:\d{2}(:\d{2}(\.\d{1,9})?)?)?)/)||e.match(/^\d{2}:\d{2}(:\d{2}(\.\d{1,9})?)?/)||e.match(/^\d+[ptuv]{1}/)?r="temporal":(e.match(/^0[NwW]{1}/)||e.match(/^0x[\da-fA-F]*/)||e.match(/^[01]+[b]{1}/)||e.match(/^\d+[chijn]{1}/)||e.match(/-?\d*(\.\d*)?(e[+\-]?\d+)?(e|f)?/))&&(r="number"),r&&(!(t=e.peek())||m.test(t))?r:(e.next(),"error")}return/[A-Za-z]|\./.test(t)?(e.eatWhile(/[A-Za-z._\d]/),a.test(e.current())?"keyword":"variable"):/[|/&^!+:\\\-*%$=~#;@><\.,?_\']/.test(t)||/[{}\(\[\]\)]/.test(t)?null:"error"}function g(e,n){return e.skipToEnd(),/\/\s*$/.test(e.current())?(n.tokenize=h)(e,n):n.tokenize=u,"comment"}function h(e,n){var o=e.sol()&&e.peek()=="\\";return e.skipToEnd(),o&&/^\\\s*$/.test(e.current())&&(n.tokenize=u),"comment"}function y(e){return e.skipToEnd(),"comment"}function b(e,n){for(var o=!1,t,r=!1;t=e.next();){if(t=='"'&&!o){r=!0;break}o=!o&&t=="\\"}return r&&(n.tokenize=u),"string"}function p(e,n,o){e.context={prev:e.context,indent:e.indent,col:o,type:n}}function x(e){e.indent=e.context.indent,e.context=e.context.prev}return{startState:function(){return{tokenize:u,context:null,indent:0,col:0}},token:function(e,n){e.sol()&&(n.context&&n.context.align==null&&(n.context.align=!1),n.indent=e.indentation());var o=n.tokenize(e,n);if(o!="comment"&&n.context&&n.context.align==null&&n.context.type!="pattern"&&(n.context.align=!0),l=="(")p(n,")",e.column());else if(l=="[")p(n,"]",e.column());else if(l=="{")p(n,"}",e.column());else if(/[\]\}\)]/.test(l)){for(;n.context&&n.context.type=="pattern";)x(n);n.context&&l==n.context.type&&x(n)}else l=="."&&n.context&&n.context.type=="pattern"?x(n):/atom|string|variable/.test(o)&&n.context&&(/[\}\]]/.test(n.context.type)?p(n,"pattern",e.column()):n.context.type=="pattern"&&!n.context.align&&(n.context.align=!0,n.context.col=e.column()));return o},indent:function(e,n){var o=n&&n.charAt(0),t=e.context;if(/[\]\}]/.test(o))for(;t&&t.type=="pattern";)t=t.prev;var r=t&&o==t.type;return t?t.type=="pattern"?t.col:t.align?t.col+(r?0:1):t.indent+(r?0:d):0}}}),i.defineMIME("text/x-q","q")})})();var z=v.exports,q=j({__proto__:null,default:z},[v.exports]);export{q};

package/dist/assets/{query.e6b1f07e.js → query.8828d31d.js}

@@ -1,4 +1,4 @@
-import{w as a,y as o,z as d,A as s,E as e,C as c,W as l}from"./vendor.e0a21029.js";const h={class:"markdown-body"},u=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Most Directus API Endpoint operations can be manipulated with the following parameters. It is important to understand them to get the most out of the platform.")])]),e("div",{class:"right"},[e("p"),e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#fields"},"Fields")]),e("li",null,[e("a",{href:"#filter"},"Filter")]),e("li",null,[e("a",{href:"#search"},"Search")]),e("li",null,[e("a",{href:"#sort"},"Sort")]),e("li",null,[e("a",{href:"#limit"},"Limit")]),e("li",null,[e("a",{href:"#offset"},"Offset"),l(" / "),e("a",{href:"#page"},"Page")]),e("li",null,[e("a",{href:"#aggregation-grouping"},"Aggregation & Grouping")]),e("li",null,[e("a",{href:"#deep"},"Deep")]),e("li",null,[e("a",{href:"#aliases"},"Aliases")]),e("li",null,[e("a",{href:"#export"},"Export")])]),e("p"),l(" - [Functions](#functions) "),e("p"),l(" - [Metadata](#metadata) - [Total Count](#total-count) - [Filter Count](#filter-count) ")])])],-1),p=e("hr",null,null,-1),f=e("h2",{id:"fields"},[l("Fields "),e("a",{class:"header-anchor",href:"#fields"},"#")],-1),g=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Choose the fields that are returned in the current dataset. This parameter supports dot notation to request nested relational fields. You can also use a wildcard (*) to include all fields at a specific depth.")])],-1),m=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples"},"#")]),e("p",null,[l("Get all top-level fields"),e("br"),e("code",null,"*")]),e("p",null,[l("Get all top-level fields and all second-level relational fields"),e("br"),e("code",null,"*.*")]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Performance & Size"),e("p",null,[l("While the fields wildcard is very useful for debugging purposes, we recommend only requesting "),e("em",null,"specific"),l(" fields for production use. By only requesting the fields you really need, you can speed up the request, and reduce the overall output size.")])]),e("p",null,[l("Get all top-level fields and second-level relational fields within images"),e("br"),e("code",null,"*,images.*")]),e("p",null,[l("Get only the first_name and last_name fields"),e("br"),e("code",null,"first_name,last_name")]),e("p",null,[l("Get all top-level and second-level relational fields, and third-level fields within images.thumbnails"),e("br"),e("code",null,"*.*,images.thumbnails.*")]),e("h3",{id:"many-to-any-(union-types)"},[l("Many-To-Any (Union Types) "),e("a",{class:"header-anchor",href:"#many-to-any-(union-types)"},"#")]),e("p",null,[l("Seeing that Many-to-Any (m2a) fields have nested data from multiple collections, it\u2019s not always safe / wanted to fetch the same field from every related collection. In m2a fields, you can use the following syntax to specify what fields to fetch from which related nested collection type:"),e("br"),e("code",null,"?fields=<m2a-field>:<collection-scope>.<field>"),l(".")]),e("p",null,[l("Lets say we have a collection "),e("code",null,"pages"),l(" with a many-to-any field called "),e("code",null,"sections"),l(" that points to "),e("code",null,"headings"),l(", "),e("code",null,"paragraphs"),l(", and "),e("code",null,"videos"),l(". We only want to fetch "),e("code",null,"title"),l(" and "),e("code",null,"level"),l(" from "),e("code",null,"headings"),l(", "),e("code",null,"body"),l(" from "),e("code",null,"paragraphs"),l(" and "),e("code",null,"source"),l(" from "),e("code",null,"videos"),l(". We can achieve that by using:")]),e("pre",null,[e("code",null,`sections.item:headings.title
+import{w as a,y as o,z as d,A as s,E as e,C as c,W as l}from"./vendor.f6090249.js";const h={class:"markdown-body"},u=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Most Directus API Endpoint operations can be manipulated with the following parameters. It is important to understand them to get the most out of the platform.")])]),e("div",{class:"right"},[e("p"),e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#fields"},"Fields")]),e("li",null,[e("a",{href:"#filter"},"Filter")]),e("li",null,[e("a",{href:"#search"},"Search")]),e("li",null,[e("a",{href:"#sort"},"Sort")]),e("li",null,[e("a",{href:"#limit"},"Limit")]),e("li",null,[e("a",{href:"#offset"},"Offset"),l(" / "),e("a",{href:"#page"},"Page")]),e("li",null,[e("a",{href:"#aggregation-grouping"},"Aggregation & Grouping")]),e("li",null,[e("a",{href:"#deep"},"Deep")]),e("li",null,[e("a",{href:"#aliases"},"Aliases")]),e("li",null,[e("a",{href:"#export"},"Export")])]),e("p"),l(" - [Functions](#functions) "),e("p"),l(" - [Metadata](#metadata) - [Total Count](#total-count) - [Filter Count](#filter-count) ")])])],-1),p=e("hr",null,null,-1),f=e("h2",{id:"fields"},[l("Fields "),e("a",{class:"header-anchor",href:"#fields"},"#")],-1),g=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Choose the fields that are returned in the current dataset. This parameter supports dot notation to request nested relational fields. You can also use a wildcard (*) to include all fields at a specific depth.")])],-1),m=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples"},"#")]),e("p",null,[l("Get all top-level fields"),e("br"),e("code",null,"*")]),e("p",null,[l("Get all top-level fields and all second-level relational fields"),e("br"),e("code",null,"*.*")]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Performance & Size"),e("p",null,[l("While the fields wildcard is very useful for debugging purposes, we recommend only requesting "),e("em",null,"specific"),l(" fields for production use. By only requesting the fields you really need, you can speed up the request, and reduce the overall output size.")])]),e("p",null,[l("Get all top-level fields and second-level relational fields within images"),e("br"),e("code",null,"*,images.*")]),e("p",null,[l("Get only the first_name and last_name fields"),e("br"),e("code",null,"first_name,last_name")]),e("p",null,[l("Get all top-level and second-level relational fields, and third-level fields within images.thumbnails"),e("br"),e("code",null,"*.*,images.thumbnails.*")]),e("h3",{id:"many-to-any-(union-types)"},[l("Many-To-Any (Union Types) "),e("a",{class:"header-anchor",href:"#many-to-any-(union-types)"},"#")]),e("p",null,[l("Seeing that Many-to-Any (m2a) fields have nested data from multiple collections, it\u2019s not always safe / wanted to fetch the same field from every related collection. In m2a fields, you can use the following syntax to specify what fields to fetch from which related nested collection type:"),e("br"),e("code",null,"?fields=<m2a-field>:<collection-scope>.<field>"),l(".")]),e("p",null,[l("Lets say we have a collection "),e("code",null,"pages"),l(" with a many-to-any field called "),e("code",null,"sections"),l(" that points to "),e("code",null,"headings"),l(", "),e("code",null,"paragraphs"),l(", and "),e("code",null,"videos"),l(". We only want to fetch "),e("code",null,"title"),l(" and "),e("code",null,"level"),l(" from "),e("code",null,"headings"),l(", "),e("code",null,"body"),l(" from "),e("code",null,"paragraphs"),l(" and "),e("code",null,"source"),l(" from "),e("code",null,"videos"),l(". We can achieve that by using:")]),e("pre",null,[e("code",null,`sections.item:headings.title
 sections.item:headings.level
 sections.item:paragraphs.body
 sections.item:videos.source
@@ -58,13 +58,13 @@ sections.item:videos.source
 		id
 	}
 }
-`)])])])],-1),I=e("hr",null,null,-1),P=e("h2",{id:"limit"},[l("Limit "),e("a",{class:"header-anchor",href:"#limit"},"#")],-1),D=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Set the maximum number of items that will be returned. The default limit is set to "),e("code",null,"100"),l(".")])])],-1),F=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-4"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-4"},"#")]),e("p",null,[l("Get the first 200 items"),e("br"),e("code",null,"200")]),e("p",null,[l("Get all items"),e("br"),e("code",null,"-1")]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"All Items"),e("p",null,"Depending on the size of your collection, fetching unlimited data may result in degraded performance or timeouts, use with caution.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`?limit=200
+`)])])])],-1),I=e("hr",null,null,-1),P=e("h2",{id:"limit"},[l("Limit "),e("a",{class:"header-anchor",href:"#limit"},"#")],-1),Q=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Set the maximum number of items that will be returned. The default limit is set to "),e("code",null,"100"),l(".")])])],-1),D=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-4"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-4"},"#")]),e("p",null,[l("Get the first 200 items"),e("br"),e("code",null,"200")]),e("p",null,[l("Get all items"),e("br"),e("code",null,"-1")]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"All Items"),e("p",null,"Depending on the size of your collection, fetching unlimited data may result in degraded performance or timeouts, use with caution.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`?limit=200
 `)]),e("h3",{id:"graphql-5"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
 	articles(limit: `),e("span",{class:"hljs-number"},"200"),l(`) {
 		id
 	}
 }
-`)])])])],-1),Q=e("hr",null,null,-1),N=e("h2",{id:"offset"},[l("Offset "),e("a",{class:"header-anchor",href:"#offset"},"#")],-1),C=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Skip the first "),e("code",null,"n"),l(" items in the response. Can be used for pagination.")])])],-1),B=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-5"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-5"},"#")]),e("p",null,[l("Get items 101\u2014200"),e("br"),e("code",null,"100")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`?offset=100
+`)])])])],-1),F=e("hr",null,null,-1),N=e("h2",{id:"offset"},[l("Offset "),e("a",{class:"header-anchor",href:"#offset"},"#")],-1),C=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Skip the first "),e("code",null,"n"),l(" items in the response. Can be used for pagination.")])])],-1),B=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-5"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-5"},"#")]),e("p",null,[l("Get items 101\u2014200"),e("br"),e("code",null,"100")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`?offset=100
 `)]),e("h3",{id:"graphql-6"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
 	articles(offset: `),e("span",{class:"hljs-number"},"100"),l(`) {
 		id
@@ -76,7 +76,7 @@ sections.item:videos.source
 		id
 	}
 }
-`)])])])],-1),U=e("hr",null,null,-1),V=e("h2",{id:"aggregation-%26-grouping"},[l("Aggregation & Grouping "),e("a",{class:"header-anchor",href:"#aggregation-%26-grouping"},"#")],-1),J=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Aggregate functions allow you to perform calculations on a set of values, returning a single result.")])],-1),Y=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"The following aggregation functions are available in Directus:"),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Name"),e("th",null,"Description")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",null,"count")]),e("td",null,"Counts how many items there are")]),e("tr",null,[e("td",null,[e("code",null,"countDistinct")]),e("td",null,"Counts how many unique items there are")]),e("tr",null,[e("td",null,[e("code",null,"sum")]),e("td",null,"Adds together the values in the given field")]),e("tr",null,[e("td",null,[e("code",null,"sumDistinct")]),e("td",null,"Adds together the unique values in the given field")]),e("tr",null,[e("td",null,[e("code",null,"avg")]),e("td",null,"Get the average value of the given field")]),e("tr",null,[e("td",null,[e("code",null,"avgDistinct")]),e("td",null,"Get the average value of the unique values in the given field")]),e("tr",null,[e("td",null,[e("code",null,"min")]),e("td",null,"Return the lowest value in the field")]),e("tr",null,[e("td",null,[e("code",null,"max")]),e("td",null,"Return the highest value in the field")])])]),e("h3",{id:"grouping"},[l("Grouping "),e("a",{class:"header-anchor",href:"#grouping"},"#")]),e("p",null,[l("By default, the above aggregation functions run on the whole dataset. To allow for more flexible reporting, you can combine the above aggregation with grouping. Grouping allows for running the aggregation functions based on a shared value. This allows for things like "),e("em",null,"\u201CAverage rating per month\u201D"),l(" or "),e("em",null,"\u201CTotal sales of items in the jeans category\u201D"),l(".")]),e("p",null,[l("The "),e("code",null,"groupBy"),l(" query allows for grouping on multiple fields simultaneously. Combined with the "),e("a",{href:"#functions"},"Functions"),l(", this allows for aggregate reporting per year-month-date.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",null,`?aggregate[avg]=cost
+`)])])])],-1),U=e("hr",null,null,-1),V=e("h2",{id:"aggregation-%26-grouping"},[l("Aggregation & Grouping "),e("a",{class:"header-anchor",href:"#aggregation-%26-grouping"},"#")],-1),J=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Aggregate functions allow you to perform calculations on a set of values, returning a single result.")])],-1),Y=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"The following aggregation functions are available in Directus:"),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Name"),e("th",null,"Description")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",null,"count")]),e("td",null,"Counts how many items there are")]),e("tr",null,[e("td",null,[e("code",null,"countDistinct")]),e("td",null,"Counts how many unique items there are")]),e("tr",null,[e("td",null,[e("code",null,"sum")]),e("td",null,"Adds together the values in the given field")]),e("tr",null,[e("td",null,[e("code",null,"sumDistinct")]),e("td",null,"Adds together the unique values in the given field")]),e("tr",null,[e("td",null,[e("code",null,"avg")]),e("td",null,"Get the average value of the given field")]),e("tr",null,[e("td",null,[e("code",null,"avgDistinct")]),e("td",null,"Get the average value of the unique values in the given field")]),e("tr",null,[e("td",null,[e("code",null,"min")]),e("td",null,"Return the lowest value in the field")]),e("tr",null,[e("td",null,[e("code",null,"max")]),e("td",null,"Return the highest value in the field")]),e("tr",null,[e("td",null,[e("code",null,"countAll")]),e("td",null,[l("Equivalent to "),e("code",null,"?aggregate[count]=*"),l(" (GraphQL only)")])])])]),e("h3",{id:"grouping"},[l("Grouping "),e("a",{class:"header-anchor",href:"#grouping"},"#")]),e("p",null,[l("By default, the above aggregation functions run on the whole dataset. To allow for more flexible reporting, you can combine the above aggregation with grouping. Grouping allows for running the aggregation functions based on a shared value. This allows for things like "),e("em",null,"\u201CAverage rating per month\u201D"),l(" or "),e("em",null,"\u201CTotal sales of items in the jeans category\u201D"),l(".")]),e("p",null,[l("The "),e("code",null,"groupBy"),l(" query allows for grouping on multiple fields simultaneously. Combined with the "),e("a",{href:"#functions"},"Functions"),l(", this allows for aggregate reporting per year-month-date.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",null,`?aggregate[avg]=cost
 &groupBy[]=author
 &groupBy[]=year(publish_date)
 `)]),e("h3",{id:"graphql-8"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-8"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
@@ -130,10 +130,10 @@ sections.item:videos.source
 		}
 	}
 }
-`)])])])],-1),ae=e("hr",null,null,-1),se=e("h2",{id:"export"},[l("Export "),e("a",{class:"header-anchor",href:"#export"},"#")],-1),ne=e("p",null,"Save the current API response to a file.",-1),ie=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Saves the API response to a file. Accepts one of "),e("code",null,"json"),l(", "),e("code",null,"csv"),l(", "),e("code",null,"xml"),l(".")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-11"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-11"},"#")]),e("pre",null,[e("code",null,`?export=json
+`)])])])],-1),ae=e("hr",null,null,-1),se=e("h2",{id:"export"},[l("Export "),e("a",{class:"header-anchor",href:"#export"},"#")],-1),ne=e("p",null,"Save the current API response to a file.",-1),re=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Saves the API response to a file. Accepts one of "),e("code",null,"json"),l(", "),e("code",null,"csv"),l(", "),e("code",null,"xml"),l(".")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-11"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-11"},"#")]),e("pre",null,[e("code",null,`?export=json
 ?export=csv
 ?export=xml
-`)]),e("h3",{id:"graphql-11"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-11"},"#")]),e("p",null,"n/a")])],-1),re=e("hr",null,null,-1),oe=e("h2",{id:"functions"},[l("Functions "),e("a",{class:"header-anchor",href:"#functions"},"#")],-1),de=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Functions allow for \u201Clive\u201D modification of values stored in a field. Functions can be used in any query parameter you\u2019d normally supply a field key, including fields, aggregation, and filter.")])],-1),ce=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Functions can be used by wrapping the field key in a JavaScript like syntax, for example:"),e("p",null,[e("code",null,"timestamp"),l(" -> "),e("code",null,"year(timestamp)")]),e("h3",{id:"datetime-functions"},[l("DateTime Functions "),e("a",{class:"header-anchor",href:"#datetime-functions"},"#")]),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Filter"),e("th",null,"Description")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",null,"year")]),e("td",null,"Extract the year from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"month")]),e("td",null,"Extract the month from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"week")]),e("td",null,"Extract the week from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"day")]),e("td",null,"Extract the day from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"weekday")]),e("td",null,"Extract the weekday from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"hour")]),e("td",null,"Extract the hour from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"minute")]),e("td",null,"Extract the minute from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"second")]),e("td",null,"Extract the second from a datetime/date/timestamp field")])])]),e("h3",{id:"array-functions"},[l("Array Functions "),e("a",{class:"header-anchor",href:"#array-functions"},"#")]),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Filter"),e("th",null,"Description")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",null,"count")]),e("td",null,"Extract the number of items from a JSON array or relational field")])])]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"GraphQL"),e("p",null,[l("Names aren\u2019t allowed to include any special characters in GraphQL, preventing the "),e("code",null,"()"),l(" syntax from being used.")]),e("p",null,[l("As an alternative, the above functions can be used by appending "),e("code",null,"_func"),l(" at the end of the field name, and using the function name as the nested field (see the example that follows).")])])]),e("div",{class:"right"},[e("h3",{id:"rest-api-12"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-12"},"#")]),e("pre",null,[e("code",null,`?fields=id,title,weekday(date_published)
+`)]),e("h3",{id:"graphql-11"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-11"},"#")]),e("p",null,"n/a")])],-1),ie=e("hr",null,null,-1),oe=e("h2",{id:"functions"},[l("Functions "),e("a",{class:"header-anchor",href:"#functions"},"#")],-1),de=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Functions allow for \u201Clive\u201D modification of values stored in a field. Functions can be used in any query parameter you\u2019d normally supply a field key, including fields, aggregation, and filter.")])],-1),ce=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Functions can be used by wrapping the field key in a JavaScript like syntax, for example:"),e("p",null,[e("code",null,"timestamp"),l(" -> "),e("code",null,"year(timestamp)")]),e("h3",{id:"datetime-functions"},[l("DateTime Functions "),e("a",{class:"header-anchor",href:"#datetime-functions"},"#")]),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Filter"),e("th",null,"Description")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",null,"year")]),e("td",null,"Extract the year from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"month")]),e("td",null,"Extract the month from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"week")]),e("td",null,"Extract the week from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"day")]),e("td",null,"Extract the day from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"weekday")]),e("td",null,"Extract the weekday from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"hour")]),e("td",null,"Extract the hour from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"minute")]),e("td",null,"Extract the minute from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",null,"second")]),e("td",null,"Extract the second from a datetime/date/timestamp field")])])]),e("h3",{id:"array-functions"},[l("Array Functions "),e("a",{class:"header-anchor",href:"#array-functions"},"#")]),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Filter"),e("th",null,"Description")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",null,"count")]),e("td",null,"Extract the number of items from a JSON array or relational field")])])]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"GraphQL"),e("p",null,[l("Names aren\u2019t allowed to include any special characters in GraphQL, preventing the "),e("code",null,"()"),l(" syntax from being used.")]),e("p",null,[l("As an alternative, the above functions can be used by appending "),e("code",null,"_func"),l(" at the end of the field name, and using the function name as the nested field (see the example that follows).")])])]),e("div",{class:"right"},[e("h3",{id:"rest-api-12"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-12"},"#")]),e("pre",null,[e("code",null,`?fields=id,title,weekday(date_published)
 &filter[year(date_published)][_eq]=2021
 `)]),e("h3",{id:"graphql-12"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-12"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
 	articles(filter: { date_published_func: { year: { _eq: `),e("span",{class:"hljs-number"},"2021"),l(` } } }) {
@@ -149,4 +149,4 @@ sections.item:videos.source
 ?meta=filter_count
 
 ?meta=*
-`)]),e("h3",{id:"graphql-13"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-13"},"#")]),e("p",null,"n/a")])],-1),ye={setup(ge,{expose:n}){const t={title:"Global Query Parameters",modularExtension:!1,pageClass:"page-reference"};return n({frontmatter:t}),(me,_e)=>{const i=a("router-link"),r=a("DocsWrapper");return o(),d(r,{frontmatter:t},{default:s(()=>[e("div",h,[u,p,f,g,m,_,v,e("div",y,[e("div",w,[e("p",null,[b,c(i,{to:"/docs/configuration/filter-rules"},{default:s(()=>[q]),_:1}),j])])]),x,k,G,A,E,S,T,R,L,I,P,D,F,Q,N,C,B,M,W,z,O,U,V,J,Y,H,K,X,Z,$,ee,le,te,ae,se,ne,ie,re,oe,de,ce,he,ue,pe,fe])]),_:1})}}};export{ye as default};
+`)]),e("h3",{id:"graphql-13"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-13"},"#")]),e("p",null,"n/a")])],-1),ye={setup(ge,{expose:n}){const t={title:"Global Query Parameters",modularExtension:!1,pageClass:"page-reference"};return n({frontmatter:t}),(me,_e)=>{const r=a("router-link"),i=a("DocsWrapper");return o(),d(i,{frontmatter:t},{default:s(()=>[e("div",h,[u,p,f,g,m,_,v,e("div",y,[e("div",w,[e("p",null,[b,c(r,{to:"/docs/configuration/filter-rules"},{default:s(()=>[q]),_:1}),j])])]),x,k,G,A,E,S,T,R,L,I,P,Q,D,F,N,C,B,M,W,z,O,U,V,J,Y,H,K,X,Z,$,ee,le,te,ae,se,ne,re,ie,oe,de,ce,he,ue,pe,fe])]),_:1})}}};export{ye as default};

package/dist/assets/quickstart.26991a56.js

@@ -0,0 +1,9 @@
+import{w as i,y as r,z as d,A as o,E as t,C as n,W as e}from"./vendor.f6090249.js";const u={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[e("This quickstart guide is designed to get you up and running with a Directus Cloud Project in a snap. Along the way, you will better understand what Directus is, setup your free Directus Cloud Account, get a "),t("em",null,"hands-on introduction"),e(" to the App and API, and find more resources to deep-dive into.")])],-1),_=t("h2",{id:"1.-create-cloud-account-and-login"},[e("1. Create Cloud Account and Login "),t("a",{class:"header-anchor",href:"#1.-create-cloud-account-and-login"},"#")],-1),p=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-account-and-login-20220427.mp4",type:"video/mp4"})],-1),m=e("First, you\u2019ll need to "),f=e("create an Account and log in"),g=e(" on "),y=t("a",{href:"https://directus.cloud/login",target:"_blank",rel:"noopener noreferrer"},"Directus Cloud",-1),b=t("p",null,"Your Directus Cloud Account allows you to create and manage any number of Community and Standard Projects. We\u2019ve made life easier by giving you the option to create and log in to your free Cloud Account 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.",-1),v=t("p",null,"The very first time you log in to your cloud account, you will be prompted to create a Team. Teams are totally free to create. Each Directus Cloud Project exists within the scope of one Team. They allow you to organize Team Members, Projects and Project Billing as desired.",-1),w=t("p",null,"Once your Team is created, it\u2019s time to create your free Community Cloud Project!",-1),C={class:"tip hint"},A=t("div",{class:"hint-title"},"Learn More About Cloud",-1),P=e("Overview"),k=e("Cloud Accounts"),j=e("Cloud Teams"),I=t("h2",{id:"2.-create-and-access-project"},[e("2. Create and Access Project "),t("a",{class:"header-anchor",href:"#2.-create-and-access-project"},"#")],-1),T=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-and-access-project-20220427A.mp4",type:"video/mp4"})],-1),D=t("p",null,"To create a Community Project, follow the steps below:",-1),S=e("Open the Team Menu in the Dashboard Header and select or "),F=e("create"),M=e(" the desired Team."),N=t("li",null,[e("Navigate to "),t("strong",null,"\u201CProjects\u201D"),e(" and click "),t("strong",null,"\u201CCreate Project\u201D"),e(".")],-1),R=t("li",null,"Set the Project Name.",-1),q=t("li",null,"Select the Community tier.",-1),L=t("li",null,[e("Scroll to the bottom of the screen and choose the "),t("strong",null,"\u201CEmpty Project\u201D"),e(" Starting Template."),t("br"),e(" Note: The "),t("strong",null,"\u201CDemo Project\u201D"),e(" adds in dummy data for in-depth feature demonstrations.")],-1),x=t("li",null,[e("Click "),t("strong",null,"\u201CCreate Project\u201D"),e(".")],-1),O=t("p",null,[t("em",null,"It should take around 90 seconds for the Cloud Project to build out. During this time, a link will be sent to the email associated with your Cloud Account. The email will contain your Project URL as well as an email and password to login. If you used GitHub to create your account, this will be your GitHub email. Once the build is complete, it\u2019s time log in!")],-1),B={start:"7"},E=e("You can "),G=e("access a Project"),W=e(" from within the Cloud Dashboard or type the URL into your browser."),H=t("li",null,"Log in with your username and password from the email.",-1),U=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Check All Inbox Folders"),t("p",null,"Due to the algorithms used by some email providers, it is possible the email containing your Project login information will end up in another folder like \u201CSocial\u201D or \u201CPromotions\u201D.")],-1),z={class:"tip hint"},V=t("div",{class:"hint-title"},"Learn More About Cloud Projects",-1),Y=e("Overview"),K=e("Cloud Projects"),Q=t("h2",{id:"3.-create-a-collection"},[e("3. Create a Collection "),t("a",{class:"header-anchor",href:"#3.-create-a-collection"},"#")],-1),J=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-a-collection-20220427A.mp4",type:"video/mp4"})],-1),X=e("Once logged in, you\u2019re greeted with the option to create your first "),Z=e("Collection"),$=e("."),tt=t("ol",null,[t("li",null,"Navigate into the Content Module."),t("li",null,[e("Click "),t("strong",null,"\u201CCreate Collection\u201D"),e(" and a side menu will appear.")]),t("li",null,[e("Fill in a "),t("strong",null,"Name"),e("."),t("br"),e(" For the sake of this demo, we\u2019ll call ours "),t("code",null,"articles"),e(", but feel free to make it your own!")]),t("li",null,[e("Leave the other options at default. Click "),t("span",{mi:"",btn:""},"arrow_forward"),e(" and the "),t("strong",null,"\u201COptional System Fields\u201D"),e(" menu will open."),t("br"),e(" Keep the values in this menu at the default, toggled off, for now. You can adjust them later.")]),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"check"),e(" in the menu header.")])],-1),et={class:"tip hint"},ot=t("div",{class:"hint-title"},"Learn More About Collections",-1),st=e("The Content Module"),nt=e("Create and Manage a Collection"),lt=e("Build Relationships Between Collections"),it=t("h2",{id:"4.-create-a-field"},[e("4. Create a Field "),t("a",{class:"header-anchor",href:"#4.-create-a-field"},"#")],-1),at=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-a-field-20220427A.mp4",type:"video/mp4"})],-1),ct=e("With your first Collection created, it\u2019s time to start adding some "),rt=e("Fields"),dt=e("."),ut=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,[e("Settings Module > Data Model > "),t("code",null,"Collection-Name")]),e(".")]),t("li",null,[e("Click the "),t("strong",null,"\u201CCreate Field\u201D"),e(" button and select the "),t("strong",null,"\u201CInput\u201D"),e(" Field type.")]),t("li",null,[e("Fill in a Field name under "),t("strong",null,"Key"),e(". We\u2019ll be calling our Field "),t("code",null,"title"),e("."),t("br"),e(" Directus offers powerful Field customization options, but let\u2019s stick to the defaults for now.")]),t("li",null,[e("Select "),t("strong",null,"\u201CSave\u201D"),e(".")])],-1),ht={class:"tip hint"},_t=t("div",{class:"hint-title"},"Learn More About Fields",-1),pt=e("Create and Manage Fields in the App"),mt=t("h2",{id:"5.-create-an-item"},[e("5. Create an Item "),t("a",{class:"header-anchor",href:"#5.-create-an-item"},"#")],-1),ft=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-an-item-20220427B.mp4",type:"video/mp4"})],-1),gt=e("Now that we have a Collection with a Field configured, it\u2019s time to add an "),yt=e("Item"),bt=e("."),vt=t("ol",null,[t("li",null,"Navigate to the Content Module."),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"add"),e(" in the page header to open the Item Page.")]),t("li",null,"Fill in the Field Value(s) as desired."),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"check"),e(" in the top-right to save your Item.")])],-1),wt={class:"tip hint"},Ct=t("div",{class:"hint-title"},"Learn More About Items",-1),At=e("The Content Module"),Pt=e("The Item Page"),kt=t("h2",{id:"6.-set-roles-%26-permissions"},[e("6. Set Roles & Permissions "),t("a",{class:"header-anchor",href:"#6.-set-roles-%26-permissions"},"#")],-1),jt=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/set-read-permissions-20220427A.mp4",type:"video/mp4"})],-1),It=t("p",null,"Directus comes with two built-in roles: Public and Admin. The Public Role determines what data is returned to non-authenticated users. Public comes with all permissions turned off and can be reconfigured with fully granular control to expose exactly what you want unauthenticated Users to see. The Admin role has full permissions and this cannot be changed. Aside from these built-in Roles, any number of new Roles can be created, all with fully customized, granular permissions.",-1),Tt=t("p",null,[e("By Default, content entered into Directus will be considered private. So permissions always start off set to the default of "),t("span",{mi:"",icon:"",dngr:""},"block"),e(),t("strong",null,"No Access"),e(", with full ability to reconfigure as desired. So, in order to have the API return our Items, let\u2019s add some read permissions. For simplicity\u2019s sake, we\u2019ll do this on the Public Role, instead of creating a new Role.")],-1),Dt=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings Module > Roles & Permissions > Public"),e(".")]),t("li",null,[e("Click "),t("span",{mi:"",icon:"",dngr:""},"block"),e(" under the "),t("span",{mi:"",icon:""},"visibility"),e(" icon on the desired Collection."),t("br"),e(" In our case, the Collection name is "),t("code",null,"article"),e(".")]),t("li",null,[e("Click "),t("strong",null,"\u201CAll Access\u201D"),e(" to give the Public Role full read permissions to the Items in this Collection.")])],-1),St={class:"tip hint"},Ft=t("div",{class:"hint-title"},"Learn More About Roles & Permissions",-1),Mt=e("Users, Roles and Permissions"),Nt=e("."),Rt=t("h2",{id:"7.-connect-to-the-api"},[e("7. Connect to the API "),t("a",{class:"header-anchor",href:"#7.-connect-to-the-api"},"#")],-1),qt=e("Now that your Project has some content in it which is exposed to the Public, it\u2019s time to start using this content externally! Data can be accessed in a number of ways, including the REST and GraphQL API Enpoints. In this case, we\u2019ll use the "),Lt=t("code",null,"/items/",-1),xt=e(),Ot=e("REST API endpoint"),Bt=e(" to retrieve the Item we just created."),Et=t("ol",null,[t("li",null,[e("Open "),t("code",null,"http://your-project-url.directus.app/items/articles"),e("."),t("br"),e(" You can use the browser or an API tool like "),t("a",{href:"http://postman.com",target:"_blank",rel:"noopener noreferrer"},"Postman"),e(" or "),t("a",{href:"https://paw.cloud",target:"_blank",rel:"noopener noreferrer"},"Paw")])],-1),Gt=t("p",null,[t("em",null,"And there it is! The Article Item you just created is being served in beautiful JSON, ready to be used anywhere and everywhere!")],-1),Wt=t("pre",null,[t("code",{class:"language-json"},[e(`{
+	`),t("span",{class:"hljs-attr"},'"data"'),e(`: [
+		{
+			`),t("span",{class:"hljs-attr"},'"id"'),e(": "),t("span",{class:"hljs-number"},"1"),e(`,
+			`),t("span",{class:"hljs-attr"},'"title"'),e(": "),t("span",{class:"hljs-string"},'"Hello World!"'),e(`
+		}
+	]
+}
+`)])],-1),Ht=t("p",null,[t("em",null,"In this example, we made a super-simple read request with the API, but there\u2019s more! The REST and GraphQL APIs provide exhaustive endpoints for the data model and every single action that you can do in the App can be done via the API. In fact, the App is just a GUI powered by the API.")],-1),Ut={class:"tip hint"},zt=t("div",{class:"hint-title"},"Learn More About The API",-1),Vt=e("Intro to the API"),Yt=e("JS SDK"),Zt={setup(Kt,{expose:a}){const l={title:"Quickstart Guide",modularExtension:!1};return a({frontmatter:l}),(Qt,Jt)=>{const s=i("router-link"),c=i("DocsWrapper");return r(),d(c,{frontmatter:l},{default:o(()=>[t("div",u,[h,_,p,t("p",null,[m,n(s,{to:"/docs/cloud/accounts/#create-account-and-login"},{default:o(()=>[f]),_:1}),g,y]),b,v,w,t("div",C,[A,t("ul",null,[t("li",null,[n(s,{to:"/docs/cloud/overview/"},{default:o(()=>[P]),_:1})]),t("li",null,[n(s,{to:"/docs/cloud/accounts/"},{default:o(()=>[k]),_:1})]),t("li",null,[n(s,{to:"/docs/cloud/teams/"},{default:o(()=>[j]),_:1})])])]),I,T,D,t("ol",null,[t("li",null,[S,n(s,{to:"/docs/cloud/teams/#create-a-team"},{default:o(()=>[F]),_:1}),M]),N,R,q,L,x]),O,t("ol",B,[t("li",null,[E,n(s,{to:"/docs/cloud/projects/#access-a-project"},{default:o(()=>[G]),_:1}),W]),H]),U,t("div",z,[V,t("ul",null,[t("li",null,[n(s,{to:"/docs/cloud/overview/"},{default:o(()=>[Y]),_:1})]),t("li",null,[n(s,{to:"/docs/cloud/projects/"},{default:o(()=>[K]),_:1})])])]),Q,J,t("p",null,[X,n(s,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[Z]),_:1}),$]),tt,t("div",et,[ot,t("ul",null,[t("li",null,[n(s,{to:"/docs/app/content"},{default:o(()=>[st]),_:1})]),t("li",null,[n(s,{to:"/docs/configuration/data-model/"},{default:o(()=>[nt]),_:1})]),t("li",null,[n(s,{to:"/docs/configuration/relationships/"},{default:o(()=>[lt]),_:1})])])]),it,at,t("p",null,[ct,n(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[rt]),_:1}),dt]),ut,t("div",ht,[_t,t("ul",null,[t("li",null,[n(s,{to:"/docs/configuration/data-model/"},{default:o(()=>[pt]),_:1})])])]),mt,ft,t("p",null,[gt,n(s,{to:"/docs/getting-started/glossary/#"},{default:o(()=>[yt]),_:1}),bt]),vt,t("div",wt,[Ct,t("ul",null,[t("li",null,[n(s,{to:"/docs/app/content/"},{default:o(()=>[At]),_:1})]),t("li",null,[n(s,{to:"/docs/app/content/items"},{default:o(()=>[Pt]),_:1})])])]),kt,jt,It,Tt,Dt,t("div",St,[Ft,t("ul",null,[t("li",null,[n(s,{to:"/docs/configuration/users-roles-permissions/"},{default:o(()=>[Mt]),_:1}),Nt])])]),Rt,t("p",null,[qt,Lt,xt,n(s,{to:"/docs/reference/items"},{default:o(()=>[Ot]),_:1}),Bt]),Et,Gt,Wt,Ht,t("div",Ut,[zt,t("ul",null,[t("li",null,[n(s,{to:"/docs/reference/introduction/"},{default:o(()=>[Vt]),_:1})]),t("li",null,[n(s,{to:"/docs/reference/sdk/"},{default:o(()=>[Yt]),_:1})])])])])]),_:1})}}};export{Zt as default};

package/dist/assets/{quickstart.9c3c65b4.js → quickstart.60decafe.js}

@@ -1,4 +1,4 @@
-import{w as i,y as c,z as d,A as o,E as t,C as n,W as e}from"./vendor.e0a21029.js";const h={class:"markdown-body"},u=t("blockquote",null,[t("p",null,"If you\u2019re looking for the fastest way to get up-and-running with Directus, this guide will walk you through getting things installed, configured, and modeled.")],-1),p=t("h2",{id:"1.-installation"},[e("1. Installation "),t("a",{class:"header-anchor",href:"#1.-installation"},"#")],-1),_=t("p",null,[e("Make sure you have the latest LTS version or newer of "),t("a",{href:"https://nodejs.dev",target:"_blank",rel:"noopener noreferrer"},"Node.js"),e(" installed, and have a running database ready to connect to.")],-1),m=t("p",null,"Run the following command in your terminal and follow the prompts.",-1),g=t("pre",null,[t("code",{class:"language-bash"},`npm init directus-project example-project
+import{w as i,y as c,z as d,A as o,E as t,C as n,W as e}from"./vendor.f6090249.js";const h={class:"markdown-body"},u=t("blockquote",null,[t("p",null,"If you\u2019re looking for the fastest way to get up-and-running with Directus, this guide will walk you through getting things installed, configured, and modeled.")],-1),p=t("h2",{id:"1.-installation"},[e("1. Installation "),t("a",{class:"header-anchor",href:"#1.-installation"},"#")],-1),_=t("p",null,[e("Make sure you have the latest LTS version or newer of "),t("a",{href:"https://nodejs.dev",target:"_blank",rel:"noopener noreferrer"},"Node.js"),e(" installed, and have a running database ready to connect to.")],-1),m=t("p",null,"Run the following command in your terminal and follow the prompts.",-1),g=t("pre",null,[t("code",{class:"language-bash"},`npm init directus-project example-project
 `)],-1),f=t("p",null,"Choose SQLite from the list. Use up/down arrow keys to select the SQL type.",-1),b=t("pre",null,[t("code",{class:"language-bash"},`? Choose your database client SQLite
 `)],-1),y=t("p",null,[e("After that a file path for "),t("code",null,"data.db"),e(", your database, will be suggested. Hit the enter key to stick with the default path.")],-1),w=t("pre",null,[t("code",{class:"language-bash"},`? Database File Path: <file-path>/example-project/data.db
 `)],-1),v=t("p",null,"Next you\u2019ll set your username/email and password.",-1),k=t("pre",null,[t("code",{class:"language-bash"},`Create your first admin user:
@@ -17,4 +17,4 @@ The configuration can be found in <file-path>/example-project/.env
 		}
 	]
 }
-`)])],-1),qt={setup(Ft,{expose:l}){const a={title:"Quickstart Guide",modularExtension:!1};return l({frontmatter:a}),(Nt,Tt)=>{const s=i("router-link"),r=i("DocsWrapper");return c(),d(r,{frontmatter:a},{default:o(()=>[t("div",h,[u,p,_,m,g,f,b,y,w,v,k,C,I,P,j,D,A,x,S,F,N,T,R,q,L,W,E,M,O,Q,t("div",B,[H,t("p",null,[z,n(s,{to:"/docs/app/content/collections"},{default:o(()=>[U]),_:1}),V])]),G,Y,J,K,t("div",X,[Z,t("p",null,[$,n(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[tt]),_:1}),et])]),ot,st,nt,at,t("div",it,[lt,t("p",null,[rt,n(s,{to:"/docs/app/content-items/"},{default:o(()=>[ct]),_:1}),dt])]),ht,ut,pt,_t,t("div",mt,[gt,t("p",null,[ft,n(s,{to:"/docs/reference/system/roles"},{default:o(()=>[bt]),_:1}),yt,n(s,{to:"/docs/reference/system/permissions"},{default:o(()=>[wt]),_:1}),vt])]),kt,t("p",null,[Ct,n(s,{to:"/docs/reference/items"},{default:o(()=>[It,Pt,jt]),_:1}),Dt]),At,xt,St])]),_:1})}}};export{qt as default};
+`)])],-1),qt={setup(Ft,{expose:l}){const a={title:"Quickstart Guide",modularExtension:!1};return l({frontmatter:a}),(Nt,Tt)=>{const s=i("router-link"),r=i("DocsWrapper");return c(),d(r,{frontmatter:a},{default:o(()=>[t("div",h,[u,p,_,m,g,f,b,y,w,v,k,C,I,P,j,D,A,x,S,F,N,T,R,q,L,W,E,M,O,Q,t("div",B,[H,t("p",null,[z,n(s,{to:"/docs/app/content-collections"},{default:o(()=>[U]),_:1}),V])]),G,Y,J,K,t("div",X,[Z,t("p",null,[$,n(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[tt]),_:1}),et])]),ot,st,nt,at,t("div",it,[lt,t("p",null,[rt,n(s,{to:"/docs/app/content-items/"},{default:o(()=>[ct]),_:1}),dt])]),ht,ut,pt,_t,t("div",mt,[gt,t("p",null,[ft,n(s,{to:"/docs/reference/system/roles"},{default:o(()=>[bt]),_:1}),yt,n(s,{to:"/docs/reference/system/permissions"},{default:o(()=>[wt]),_:1}),vt])]),kt,t("p",null,[Ct,n(s,{to:"/docs/reference/items"},{default:o(()=>[It,Pt,jt]),_:1}),Dt]),At,xt,St])]),_:1})}}};export{qt as default};

package/dist/assets/{r.f34d7d93.js → r.09038281.js}

@@ -1 +1 @@
-import{bV as S}from"./vendor.e0a21029.js";function O(c,b){return b.forEach(function(t){t&&typeof t!="string"&&!Array.isArray(t)&&Object.keys(t).forEach(function(l){if(l!=="default"&&!(l in c)){var f=Object.getOwnPropertyDescriptor(t,l);Object.defineProperty(c,l,f.get?f:{enumerable:!0,get:function(){return t[l]}})}})}),Object.freeze(Object.defineProperty(c,Symbol.toStringTag,{value:"Module"}))}var _={exports:{}};(function(c,b){(function(t){t(S.exports)})(function(t){t.registerHelper("wordChars","r",/[\w.]/),t.defineMode("r",function(l){function f(e){for(var n={},r=0;r<e.length;++r)n[e[r]]=!0;return n}var x=["NULL","NA","Inf","NaN","NA_integer_","NA_real_","NA_complex_","NA_character_","TRUE","FALSE"],y=["list","quote","bquote","eval","return","call","parse","deparse"],g=["if","else","repeat","while","function","for","in","next","break"],A=["if","else","repeat","while","function","for"];t.registerHelper("hintWords","r",x.concat(y,g));var E=f(x),w=f(y),N=f(g),I=f(A),k=/[+\-*\/^<>=!&|~$:]/,o;function p(e,n){o=null;var r=e.next();if(r=="#")return e.skipToEnd(),"comment";if(r=="0"&&e.eat("x"))return e.eatWhile(/[\da-f]/i),"number";if(r=="."&&e.eat(/\d/))return e.match(/\d*(?:e[+\-]?\d+)?/),"number";if(/\d/.test(r))return e.match(/\d*(?:\.\d+)?(?:e[+\-]\d+)?L?/),"number";if(r=="'"||r=='"')return n.tokenize=L(r),"string";if(r=="`")return e.match(/[^`]+`/),"variable-3";if(r=="."&&e.match(/.(?:[.]|\d+)/))return"keyword";if(/[a-zA-Z\.]/.test(r)){e.eatWhile(/[\w\.]/);var i=e.current();return E.propertyIsEnumerable(i)?"atom":N.propertyIsEnumerable(i)?(I.propertyIsEnumerable(i)&&!e.match(/\s*if(\s+|$)/,!1)&&(o="block"),"keyword"):w.propertyIsEnumerable(i)?"builtin":"variable"}else return r=="%"?(e.skipTo("%")&&e.next(),"operator variable-2"):r=="<"&&e.eat("-")||r=="<"&&e.match("<-")||r=="-"&&e.match(/>>?/)?"operator arrow":r=="="&&n.ctx.argList?"arg-is":k.test(r)?r=="$"?"operator dollar":(e.eatWhile(k),"operator"):/[\(\){}\[\];]/.test(r)?(o=r,r==";"?"semi":null):null}function L(e){return function(n,r){if(n.eat("\\")){var i=n.next();return i=="x"?n.match(/^[a-f0-9]{2}/i):(i=="u"||i=="U")&&n.eat("{")&&n.skipTo("}")?n.next():i=="u"?n.match(/^[a-f0-9]{4}/i):i=="U"?n.match(/^[a-f0-9]{8}/i):/[0-7]/.test(i)&&n.match(/^[0-7]{1,2}/),"string-2"}else{for(var u;(u=n.next())!=null;){if(u==e){r.tokenize=p;break}if(u=="\\"){n.backUp(1);break}}return"string"}}}var h=1,d=2,s=4;function a(e,n,r){e.ctx={type:n,indent:e.indent,flags:0,column:r.column(),prev:e.ctx}}function m(e,n){var r=e.ctx;e.ctx={type:r.type,indent:r.indent,flags:r.flags|n,column:r.column,prev:r.prev}}function v(e){e.indent=e.ctx.indent,e.ctx=e.ctx.prev}return{startState:function(){return{tokenize:p,ctx:{type:"top",indent:-l.indentUnit,flags:d},indent:0,afterIdent:!1}},token:function(e,n){if(e.sol()&&((n.ctx.flags&3)==0&&(n.ctx.flags|=d),n.ctx.flags&s&&v(n),n.indent=e.indentation()),e.eatSpace())return null;var r=n.tokenize(e,n);return r!="comment"&&(n.ctx.flags&d)==0&&m(n,h),(o==";"||o=="{"||o=="}")&&n.ctx.type=="block"&&v(n),o=="{"?a(n,"}",e):o=="("?(a(n,")",e),n.afterIdent&&(n.ctx.argList=!0)):o=="["?a(n,"]",e):o=="block"?a(n,"block",e):o==n.ctx.type?v(n):n.ctx.type=="block"&&r!="comment"&&m(n,s),n.afterIdent=r=="variable"||r=="keyword",r},indent:function(e,n){if(e.tokenize!=p)return 0;var r=n&&n.charAt(0),i=e.ctx,u=r==i.type;return i.flags&s&&(i=i.prev),i.type=="block"?i.indent+(r=="{"?0:l.indentUnit):i.flags&h?i.column+(u?0:1):i.indent+(u?0:l.indentUnit)},lineComment:"#"}}),t.defineMIME("text/x-rsrc","r")})})();var U=_.exports,z=O({__proto__:null,default:U},[_.exports]);export{z as r};
+import{bW as S}from"./vendor.f6090249.js";function O(c,b){return b.forEach(function(t){t&&typeof t!="string"&&!Array.isArray(t)&&Object.keys(t).forEach(function(l){if(l!=="default"&&!(l in c)){var f=Object.getOwnPropertyDescriptor(t,l);Object.defineProperty(c,l,f.get?f:{enumerable:!0,get:function(){return t[l]}})}})}),Object.freeze(Object.defineProperty(c,Symbol.toStringTag,{value:"Module"}))}var _={exports:{}};(function(c,b){(function(t){t(S.exports)})(function(t){t.registerHelper("wordChars","r",/[\w.]/),t.defineMode("r",function(l){function f(e){for(var n={},r=0;r<e.length;++r)n[e[r]]=!0;return n}var x=["NULL","NA","Inf","NaN","NA_integer_","NA_real_","NA_complex_","NA_character_","TRUE","FALSE"],y=["list","quote","bquote","eval","return","call","parse","deparse"],g=["if","else","repeat","while","function","for","in","next","break"],A=["if","else","repeat","while","function","for"];t.registerHelper("hintWords","r",x.concat(y,g));var E=f(x),w=f(y),N=f(g),I=f(A),k=/[+\-*\/^<>=!&|~$:]/,o;function p(e,n){o=null;var r=e.next();if(r=="#")return e.skipToEnd(),"comment";if(r=="0"&&e.eat("x"))return e.eatWhile(/[\da-f]/i),"number";if(r=="."&&e.eat(/\d/))return e.match(/\d*(?:e[+\-]?\d+)?/),"number";if(/\d/.test(r))return e.match(/\d*(?:\.\d+)?(?:e[+\-]\d+)?L?/),"number";if(r=="'"||r=='"')return n.tokenize=L(r),"string";if(r=="`")return e.match(/[^`]+`/),"variable-3";if(r=="."&&e.match(/.(?:[.]|\d+)/))return"keyword";if(/[a-zA-Z\.]/.test(r)){e.eatWhile(/[\w\.]/);var i=e.current();return E.propertyIsEnumerable(i)?"atom":N.propertyIsEnumerable(i)?(I.propertyIsEnumerable(i)&&!e.match(/\s*if(\s+|$)/,!1)&&(o="block"),"keyword"):w.propertyIsEnumerable(i)?"builtin":"variable"}else return r=="%"?(e.skipTo("%")&&e.next(),"operator variable-2"):r=="<"&&e.eat("-")||r=="<"&&e.match("<-")||r=="-"&&e.match(/>>?/)?"operator arrow":r=="="&&n.ctx.argList?"arg-is":k.test(r)?r=="$"?"operator dollar":(e.eatWhile(k),"operator"):/[\(\){}\[\];]/.test(r)?(o=r,r==";"?"semi":null):null}function L(e){return function(n,r){if(n.eat("\\")){var i=n.next();return i=="x"?n.match(/^[a-f0-9]{2}/i):(i=="u"||i=="U")&&n.eat("{")&&n.skipTo("}")?n.next():i=="u"?n.match(/^[a-f0-9]{4}/i):i=="U"?n.match(/^[a-f0-9]{8}/i):/[0-7]/.test(i)&&n.match(/^[0-7]{1,2}/),"string-2"}else{for(var u;(u=n.next())!=null;){if(u==e){r.tokenize=p;break}if(u=="\\"){n.backUp(1);break}}return"string"}}}var h=1,d=2,s=4;function a(e,n,r){e.ctx={type:n,indent:e.indent,flags:0,column:r.column(),prev:e.ctx}}function m(e,n){var r=e.ctx;e.ctx={type:r.type,indent:r.indent,flags:r.flags|n,column:r.column,prev:r.prev}}function v(e){e.indent=e.ctx.indent,e.ctx=e.ctx.prev}return{startState:function(){return{tokenize:p,ctx:{type:"top",indent:-l.indentUnit,flags:d},indent:0,afterIdent:!1}},token:function(e,n){if(e.sol()&&((n.ctx.flags&3)==0&&(n.ctx.flags|=d),n.ctx.flags&s&&v(n),n.indent=e.indentation()),e.eatSpace())return null;var r=n.tokenize(e,n);return r!="comment"&&(n.ctx.flags&d)==0&&m(n,h),(o==";"||o=="{"||o=="}")&&n.ctx.type=="block"&&v(n),o=="{"?a(n,"}",e):o=="("?(a(n,")",e),n.afterIdent&&(n.ctx.argList=!0)):o=="["?a(n,"]",e):o=="block"?a(n,"block",e):o==n.ctx.type?v(n):n.ctx.type=="block"&&r!="comment"&&m(n,s),n.afterIdent=r=="variable"||r=="keyword",r},indent:function(e,n){if(e.tokenize!=p)return 0;var r=n&&n.charAt(0),i=e.ctx,u=r==i.type;return i.flags&s&&(i=i.prev),i.type=="block"?i.indent+(r=="{"?0:l.indentUnit):i.flags&h?i.column+(u?0:1):i.indent+(u?0:l.indentUnit)},lineComment:"#"}}),t.defineMIME("text/x-rsrc","r")})})();var U=_.exports,z=O({__proto__:null,default:U},[_.exports]);export{z as r};

package/dist/assets/{relations.77fc85a4.js → relations.29fed98c.js}

@@ -1,4 +1,4 @@
-import{w as s,y as i,z as c,A as t,E as e,C as h,W as l}from"./vendor.e0a21029.js";const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=l("What data is linked to what other data. Allows you to assign authors to articles, products to sales, and whatever other structures you can think of. "),g=l("Learn more about Relationships"),f=l("."),m=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-relation-object"},"The Relation Object")]),e("li",null,[e("a",{href:"#list-relations"},"List relations")]),e("li",null,[e("a",{href:"#list-relations-in-collection"},"List relations in collection")]),e("li",null,[e("a",{href:"#retrieve-a-relation"},"Retrieve a relation")]),e("li",null,[e("a",{href:"#create-a-relation"},"Create a Relation")]),e("li",null,[e("a",{href:"#update-a-relation"},"Update a Relation")]),e("li",null,[e("a",{href:"#delete-a-relation"},"Delete a Relation")])])])])],-1),y=e("hr",null,null,-1),j=e("h2",{id:"the-relation-object"},[l("The Relation Object "),e("a",{class:"header-anchor",href:"#the-relation-object"},"#")],-1),b=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",null,"collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the collection. This matches the table name in the database.")]),e("p",null,[e("code",null,"field"),l(),e("strong",null,"string"),e("br"),l(" Name of the field that holds the related primary key. This matches the column name in the database.")]),e("p",null,[e("code",null,"related_collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the related collection. This matches the table name in the database.")])]),e("h4",{id:"meta"},[l("Meta "),e("a",{class:"header-anchor",href:"#meta"},"#")]),e("p",null,"Directus metadata. Used to enable non-database relationship types"),e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),l(),e("strong",null,"integer"),e("br"),l(" Primary key of the metadata row in "),e("code",null,"directus_relations"),l(".")]),e("p",null,[e("code",null,"many_collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the collection. Matches the top level "),e("code",null,"collection"),l(" field.")]),e("p",null,[e("code",null,"many_field"),l(),e("strong",null,"string"),e("br"),l(" Name of the field. Matches the top level "),e("code",null,"field"),l(" field.")]),e("p",null,[e("code",null,"one_collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the related collection. Matches the top level "),e("code",null,"related_collection"),l(" field.")]),e("p",null,[e("code",null,"one_field"),l(),e("strong",null,"string"),e("br"),l(" Name of the one to many field on the other side of the relation.")]),e("p",null,[e("code",null,"one_allowed_collections"),l(),e("strong",null,"string"),e("br"),l(" What collections are allowed to be used in a many-to-any context.")]),e("p",null,[e("code",null,"one_collection_field"),l(),e("strong",null,"string"),e("br"),l(" Field that holds the collection name in a many-to-any context.")]),e("p",null,[e("code",null,"one_deselect_action"),l(),e("strong",null,"nullify | delete"),e("br"),l(" Whether to nullify or delete related one-to-many records.")]),e("p",null,[e("code",null,"sort_field"),l(),e("strong",null,"string"),e("br"),l(" What field is used to hold the sort field.")]),e("p",null,[e("code",null,"junction_field"),l(),e("strong",null,"string"),e("br"),l(" What field connects two relations in a many-to-many (o2m-m2o) context.")])]),e("h4",{id:"schema"},[l("Schema "),e("a",{class:"header-anchor",href:"#schema"},"#")]),e("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers."),e("div",{class:"definitions"},[e("p",null,[e("code",null,"table"),l(),e("strong",null,"string"),e("br"),l(" The table name.")]),e("p",null,[e("code",null,"column"),l(),e("strong",null,"string"),e("br"),l(" The column name.")]),e("p",null,[e("code",null,"foreign_key_table"),l(),e("strong",null,"string"),e("br"),l(" Related table name.")]),e("p",null,[e("code",null,"foreign_key_column"),l(),e("strong",null,"string"),e("br"),l(" Related column name.")]),e("p",null,[e("code",null,"constraint_name"),l(),e("strong",null,"string"),e("br"),l(" Name for the foreign key constraint.")]),e("p",null,[e("code",null,"on_update"),l(),e("strong",null,"string"),e("br"),l(" Update trigger for the foreign key constraint.")]),e("p",null,[e("code",null,"on_delete"),l(),e("strong",null,"string"),e("br"),l(" Delete trigger for the foreign key constraint.")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[l(`{
+import{w as s,y as i,z as c,A as t,E as e,C as h,W as l}from"./vendor.f6090249.js";const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=l("What data is linked to what other data. Allows you to assign authors to articles, products to sales, and whatever other structures you can think of. "),g=l("Learn more about Relationships"),f=l("."),m=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-relation-object"},"The Relation Object")]),e("li",null,[e("a",{href:"#list-relations"},"List relations")]),e("li",null,[e("a",{href:"#list-relations-in-collection"},"List relations in collection")]),e("li",null,[e("a",{href:"#retrieve-a-relation"},"Retrieve a relation")]),e("li",null,[e("a",{href:"#create-a-relation"},"Create a Relation")]),e("li",null,[e("a",{href:"#update-a-relation"},"Update a Relation")]),e("li",null,[e("a",{href:"#delete-a-relation"},"Delete a Relation")])])])])],-1),y=e("hr",null,null,-1),j=e("h2",{id:"the-relation-object"},[l("The Relation Object "),e("a",{class:"header-anchor",href:"#the-relation-object"},"#")],-1),b=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",null,"collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the collection. This matches the table name in the database.")]),e("p",null,[e("code",null,"field"),l(),e("strong",null,"string"),e("br"),l(" Name of the field that holds the related primary key. This matches the column name in the database.")]),e("p",null,[e("code",null,"related_collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the related collection. This matches the table name in the database.")])]),e("h4",{id:"meta"},[l("Meta "),e("a",{class:"header-anchor",href:"#meta"},"#")]),e("p",null,"Directus metadata. Used to enable non-database relationship types"),e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),l(),e("strong",null,"integer"),e("br"),l(" Primary key of the metadata row in "),e("code",null,"directus_relations"),l(".")]),e("p",null,[e("code",null,"many_collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the collection. Matches the top level "),e("code",null,"collection"),l(" field.")]),e("p",null,[e("code",null,"many_field"),l(),e("strong",null,"string"),e("br"),l(" Name of the field. Matches the top level "),e("code",null,"field"),l(" field.")]),e("p",null,[e("code",null,"one_collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the related collection. Matches the top level "),e("code",null,"related_collection"),l(" field.")]),e("p",null,[e("code",null,"one_field"),l(),e("strong",null,"string"),e("br"),l(" Name of the one to many field on the other side of the relation.")]),e("p",null,[e("code",null,"one_allowed_collections"),l(),e("strong",null,"string"),e("br"),l(" What collections are allowed to be used in a many-to-any context.")]),e("p",null,[e("code",null,"one_collection_field"),l(),e("strong",null,"string"),e("br"),l(" Field that holds the collection name in a many-to-any context.")]),e("p",null,[e("code",null,"one_deselect_action"),l(),e("strong",null,"nullify | delete"),e("br"),l(" Whether to nullify or delete related one-to-many records.")]),e("p",null,[e("code",null,"sort_field"),l(),e("strong",null,"string"),e("br"),l(" What field is used to hold the sort field.")]),e("p",null,[e("code",null,"junction_field"),l(),e("strong",null,"string"),e("br"),l(" What field connects two relations in a many-to-many (o2m-m2o) context.")])]),e("h4",{id:"schema"},[l("Schema "),e("a",{class:"header-anchor",href:"#schema"},"#")]),e("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers."),e("div",{class:"definitions"},[e("p",null,[e("code",null,"table"),l(),e("strong",null,"string"),e("br"),l(" The table name.")]),e("p",null,[e("code",null,"column"),l(),e("strong",null,"string"),e("br"),l(" The column name.")]),e("p",null,[e("code",null,"foreign_key_table"),l(),e("strong",null,"string"),e("br"),l(" Related table name.")]),e("p",null,[e("code",null,"foreign_key_column"),l(),e("strong",null,"string"),e("br"),l(" Related column name.")]),e("p",null,[e("code",null,"constraint_name"),l(),e("strong",null,"string"),e("br"),l(" Name for the foreign key constraint.")]),e("p",null,[e("code",null,"on_update"),l(),e("strong",null,"string"),e("br"),l(" Update trigger for the foreign key constraint.")]),e("p",null,[e("code",null,"on_delete"),l(),e("strong",null,"string"),e("br"),l(" Delete trigger for the foreign key constraint.")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[l(`{
 	`),e("span",{class:"hljs-attr"},'"collection"'),l(": "),e("span",{class:"hljs-string"},'"about_us"'),l(`,
 	`),e("span",{class:"hljs-attr"},'"field"'),l(": "),e("span",{class:"hljs-string"},'"logo"'),l(`,
 	`),e("span",{class:"hljs-attr"},'"related_collection"'),l(": "),e("span",{class:"hljs-string"},'"directus_files"'),l(`,

package/dist/assets/{relationships.7a8128c2.js → relationships.9b51c50f.js}

@@ -1,4 +1,4 @@
-import{w as s,y as c,z as d,A as n,E as e,C as l,W as t}from"./vendor.e0a21029.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,[t("As you might have guessed, relationships are a crucial part of any relational database. Directus supports all standard relationship types, as well as a few more "),e("em",null,"compound"),t(" types that offer greater flexibility.")])],-1),f=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#many-to-one-(m2o)"},"Many-to-One (M2O)")]),e("li",null,[e("a",{href:"#one-to-many-(o2m)"},"One-to-Many (O2M)")]),e("li",null,[e("a",{href:"#translations-(o2m)"},"Translations (O2M)")]),e("li",null,[e("a",{href:"#many-to-many-(m2m)"},"Many-to-Many (M2M)")]),e("li",null,[e("a",{href:"#many-to-any-(m2a)"},"Many-to-Any (M2A)")]),e("li",null,[e("a",{href:"#one-to-one-(o2o)"},"One-to-One (O2O)")])])])],-1),p=e("h3",{id:"introduction"},[t("Introduction "),e("a",{class:"header-anchor",href:"#introduction"},"#")],-1),m=e("p",null,"While it may seem complex at first, relational data is actually quite straightforward once you understand what\u2019s happening behind the sometimes confusing terminology. Before diving into the details of each type, let\u2019s first cover a few basics that will help you better visualize them in your mind\u2019s eye.",-1),_=e("h3",{id:"primary-and-foreign-keys"},[t("Primary and Foreign Keys "),e("a",{class:"header-anchor",href:"#primary-and-foreign-keys"},"#")],-1),y=t("Every "),g=t("Item"),w=t(" in a relational database has a unique "),M=t("Primary Key"),b=t(" (or \u201CPK\u201D) that identifies it within its "),v=t("Collection"),O=t(". Because it\u2019s required, the key is the first "),k=t("field"),T=t(" created within a collection, typically storing an \u201Cauto-increment\u201D number, an automatically generated unique hash, or a manually entered value. They are often abbreviated to \u201CPK\u201D (Primary Key), \u201CID\u201D (Identifier), \u201CUID\u201D (Unique Identifier), or \u201CUUID\u201D (Universally Unique Identifier), depending on the type of value they store. After it\u2019s created, the value of an item\u2019s PK should "),C=e("em",null,"never",-1),x=t(" change."),A=e("p",null,[t("To link items together relationally, you simply save a reference to an item\u2019s PK in a different field. That "),e("em",null,"reference"),t(" is called a Foreign Key (FK). If the primary key is a "),e("em",null,"person"),t(", the foreign key is like their "),e("em",null,"business card"),t(". It references the actual person, providing just enough information to find them.")],-1),j=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Composite & Compound Keys"),e("p",null,[t("In the above explanation we\u2019ve ignored "),e("em",null,"composite"),t(" and "),e("em",null,"compound"),t(" keys, which are essentially unique keys created by combining "),e("em",null,"multiple"),t(" field/column values.")])],-1),I=e("h3",{id:"perspective-matters"},[t("Perspective Matters "),e("a",{class:"header-anchor",href:"#perspective-matters"},"#")],-1),P=e("p",null,"Just like primary and foreign keys, relationships are always described relative to their \u201Cparent\u201D collection. Looking at the same relationship/key from the perspective of the opposite collection would reverse it. This means that a many-to-one relationship can also be seen as a one-to-many relationship, it just depends on which collection is considered the parent.",-1),D=e("h2",{id:"many-to-one-(m2o)"},[t("Many-to-One (M2O) "),e("a",{class:"header-anchor",href:"#many-to-one-(m2o)"},"#")],-1),S=e("p",null,[t("The Many-to-One is the only relationship type with an actual field on the parent Collection. This field saves the foreign key to a single related item. For example, a "),e("em",null,"city"),t(" can only be in one "),e("em",null,"country"),t(", but a "),e("em",null,"country"),t(" can have many "),e("em",null,"cities"),t(".")],-1),F=e("p",null,"Below is an example of a M2O relationship:",-1),R=e("pre",null,[e("code",null,`cities (the "Many" Collection)
+import{w as s,y as c,z as d,A as n,E as e,C as l,W as t}from"./vendor.f6090249.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,[t("As you might have guessed, relationships are a crucial part of any relational database. Directus supports all standard relationship types, as well as a few more "),e("em",null,"compound"),t(" types that offer greater flexibility.")])],-1),f=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#many-to-one-(m2o)"},"Many-to-One (M2O)")]),e("li",null,[e("a",{href:"#one-to-many-(o2m)"},"One-to-Many (O2M)")]),e("li",null,[e("a",{href:"#translations-(o2m)"},"Translations (O2M)")]),e("li",null,[e("a",{href:"#many-to-many-(m2m)"},"Many-to-Many (M2M)")]),e("li",null,[e("a",{href:"#many-to-any-(m2a)"},"Many-to-Any (M2A)")]),e("li",null,[e("a",{href:"#one-to-one-(o2o)"},"One-to-One (O2O)")])])])],-1),p=e("h3",{id:"introduction"},[t("Introduction "),e("a",{class:"header-anchor",href:"#introduction"},"#")],-1),m=e("p",null,"While it may seem complex at first, relational data is actually quite straightforward once you understand what\u2019s happening behind the sometimes confusing terminology. Before diving into the details of each type, let\u2019s first cover a few basics that will help you better visualize them in your mind\u2019s eye.",-1),_=e("h3",{id:"primary-and-foreign-keys"},[t("Primary and Foreign Keys "),e("a",{class:"header-anchor",href:"#primary-and-foreign-keys"},"#")],-1),y=t("Every "),g=t("Item"),w=t(" in a relational database has a unique "),M=t("Primary Key"),b=t(" (or \u201CPK\u201D) that identifies it within its "),v=t("Collection"),O=t(". Because it\u2019s required, the key is the first "),k=t("field"),T=t(" created within a collection, typically storing an \u201Cauto-increment\u201D number, an automatically generated unique hash, or a manually entered value. They are often abbreviated to \u201CPK\u201D (Primary Key), \u201CID\u201D (Identifier), \u201CUID\u201D (Unique Identifier), or \u201CUUID\u201D (Universally Unique Identifier), depending on the type of value they store. After it\u2019s created, the value of an item\u2019s PK should "),C=e("em",null,"never",-1),x=t(" change."),A=e("p",null,[t("To link items together relationally, you simply save a reference to an item\u2019s PK in a different field. That "),e("em",null,"reference"),t(" is called a Foreign Key (FK). If the primary key is a "),e("em",null,"person"),t(", the foreign key is like their "),e("em",null,"business card"),t(". It references the actual person, providing just enough information to find them.")],-1),j=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Composite & Compound Keys"),e("p",null,[t("In the above explanation we\u2019ve ignored "),e("em",null,"composite"),t(" and "),e("em",null,"compound"),t(" keys, which are essentially unique keys created by combining "),e("em",null,"multiple"),t(" field/column values.")])],-1),I=e("h3",{id:"perspective-matters"},[t("Perspective Matters "),e("a",{class:"header-anchor",href:"#perspective-matters"},"#")],-1),P=e("p",null,"Just like primary and foreign keys, relationships are always described relative to their \u201Cparent\u201D collection. Looking at the same relationship/key from the perspective of the opposite collection would reverse it. This means that a many-to-one relationship can also be seen as a one-to-many relationship, it just depends on which collection is considered the parent.",-1),D=e("h2",{id:"many-to-one-(m2o)"},[t("Many-to-One (M2O) "),e("a",{class:"header-anchor",href:"#many-to-one-(m2o)"},"#")],-1),S=e("p",null,[t("The Many-to-One is the only relationship type with an actual field on the parent Collection. This field saves the foreign key to a single related item. For example, a "),e("em",null,"city"),t(" can only be in one "),e("em",null,"country"),t(", but a "),e("em",null,"country"),t(" can have many "),e("em",null,"cities"),t(".")],-1),F=e("p",null,"Below is an example of a M2O relationship:",-1),R=e("pre",null,[e("code",null,`cities (the "Many" Collection)
 - id (Primary Key)
 - name
 - country (the M2O field that stores the country key)

package/dist/assets/{revisions.99756266.js → revisions.0f19e955.js}

@@ -1,4 +1,4 @@
-import{w as l,y as c,z as h,A as t,E as s,C as o,W as e}from"./vendor.e0a21029.js";const d={class:"markdown-body"},_={class:"two-up"},p={class:"left"},u=e("Revisions are individual changes to items made. Directus keeps track of changes made, so you\u2019re able to revert to a previous state at will. "),v=e("Learn more about Revisions"),m=e("."),f=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-revision-object"},"The Revision Object")]),s("li",null,[s("a",{href:"#list-revisions"},"List revisions")]),s("li",null,[s("a",{href:"#retrieve-a-revision"},"Retrieve a revision")])])])])],-1),g=s("hr",null,null,-1),y=s("h2",{id:"the-revision-object"},[e("The Revision Object "),s("a",{class:"header-anchor",href:"#the-revision-object"},"#")],-1),j={class:"two-up"},b={class:"left"},q={class:"definitions"},x=s("p",null,[s("code",null,"id"),e(),s("strong",null,"integer"),s("br"),e(" Primary key of the revision.")],-1),w=s("code",null,"activity",-1),k=e(),R=s("strong",null,"many-to-one",-1),E=s("br",null,null,-1),T=e(" Related activity record. Many-to-one to "),P=e("activity"),S=e("."),L=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Collection in which this revision happened.")],-1),C=s("p",null,[s("code",null,"item"),e(),s("strong",null,"string"),s("br"),e(" Primary key of the item that was changed.")],-1),A=s("p",null,[s("code",null,"data"),e(),s("strong",null,"object"),s("br"),e(" Snapshot of the top-level item data.")],-1),D=s("p",null,[s("code",null,"delta"),e(),s("strong",null,"object"),s("br"),e(" Snapshot of the changes made in this revision.")],-1),Q=s("p",null,[s("code",null,"parent"),e(),s("strong",null,"many-to-one"),s("br"),e(" Parent revision that triggered this revision. Many-to-one to revisions (recursive).")],-1),G=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
+import{w as l,y as c,z as h,A as t,E as s,C as o,W as e}from"./vendor.f6090249.js";const d={class:"markdown-body"},_={class:"two-up"},p={class:"left"},u=e("Revisions are individual changes to items made. Directus keeps track of changes made, so you\u2019re able to revert to a previous state at will. "),v=e("Learn more about Revisions"),m=e("."),f=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-revision-object"},"The Revision Object")]),s("li",null,[s("a",{href:"#list-revisions"},"List revisions")]),s("li",null,[s("a",{href:"#retrieve-a-revision"},"Retrieve a revision")])])])])],-1),g=s("hr",null,null,-1),y=s("h2",{id:"the-revision-object"},[e("The Revision Object "),s("a",{class:"header-anchor",href:"#the-revision-object"},"#")],-1),j={class:"two-up"},b={class:"left"},q={class:"definitions"},x=s("p",null,[s("code",null,"id"),e(),s("strong",null,"integer"),s("br"),e(" Primary key of the revision.")],-1),w=s("code",null,"activity",-1),k=e(),R=s("strong",null,"many-to-one",-1),E=s("br",null,null,-1),T=e(" Related activity record. Many-to-one to "),P=e("activity"),S=e("."),L=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Collection in which this revision happened.")],-1),C=s("p",null,[s("code",null,"item"),e(),s("strong",null,"string"),s("br"),e(" Primary key of the item that was changed.")],-1),A=s("p",null,[s("code",null,"data"),e(),s("strong",null,"object"),s("br"),e(" Snapshot of the top-level item data.")],-1),D=s("p",null,[s("code",null,"delta"),e(),s("strong",null,"object"),s("br"),e(" Snapshot of the changes made in this revision.")],-1),Q=s("p",null,[s("code",null,"parent"),e(),s("strong",null,"many-to-one"),s("br"),e(" Parent revision that triggered this revision. Many-to-one to revisions (recursive).")],-1),G=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
 	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-number"},"368"),e(`,
 	`),s("span",{class:"hljs-attr"},'"activity"'),e(": "),s("span",{class:"hljs-number"},"438"),e(`,
 	`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"articles"'),e(`,