@directus/app 9.14.5 → 9.15.0

package/dist/assets/{endpoints.b6214ea4.js → endpoints.0f025685.js}

@@ -1,4 +1,4 @@
-import{a,o,b as r,w as i,g as s,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const c=s("div",{class:"markdown-body"},[s("blockquote",null,[s("p",null,"Custom API Endpoints register new API routes which can be used to infinitely extend the core functionality of the platform.")]),s("h2",{id:"extension-entrypoint",tabindex:"-1"},[e("Extension Entrypoint "),s("a",{class:"header-anchor",href:"#extension-entrypoint"},"#")]),s("p",null,[e("The entrypoint of your endpoint is the "),s("code",null,"index"),e(" file inside the "),s("code",null,"src/"),e(" folder of your extension package. It exports a register function to register one or more custom routes. Each route of your endpoint will be a sub-route of "),s("code",null,"/<extension-name>"),e(".")]),s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Extension Name"),s("p",null,"The extension name is usually the name of the folder where you put your extension when deploying it.")]),s("p",null,"Example of an entrypoint:"),s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"export"),e(),s("span",{class:"hljs-keyword"},"default"),e(` (router) => {
+import{a,o,b as r,w as i,g as s,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const c=s("div",{class:"markdown-body"},[s("blockquote",null,[s("p",null,"Custom API Endpoints register new API routes which can be used to infinitely extend the core functionality of the platform.")]),s("h2",{id:"extension-entrypoint",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#extension-entrypoint"},"#"),e(" Extension Entrypoint")]),s("p",null,[e("The entrypoint of your endpoint is the "),s("code",null,"index"),e(" file inside the "),s("code",null,"src/"),e(" folder of your extension package. It exports a register function to register one or more custom routes. Each route of your endpoint will be a sub-route of "),s("code",null,"/<extension-name>"),e(".")]),s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Extension Name"),s("p",null,"The extension name is usually the name of the folder where you put your extension when deploying it.")]),s("p",null,"Example of an entrypoint:"),s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"export"),e(),s("span",{class:"hljs-keyword"},"default"),e(` (router) => {
 	router.`),s("span",{class:"hljs-title function_"},"get"),e("("),s("span",{class:"hljs-string"},"'/'"),e(", "),s("span",{class:"hljs-function"},[e("("),s("span",{class:"hljs-params"},"req, res"),e(") =>")]),e(" res."),s("span",{class:"hljs-title function_"},"send"),e("("),s("span",{class:"hljs-string"},"'Hello, World!'"),e(`));
 };
 `)])]),s("p",null,"Alternatively, you can export a configuration object to be able to customize the root route:"),s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"export"),e(),s("span",{class:"hljs-keyword"},"default"),e(` {
@@ -9,7 +9,7 @@ import{a,o,b as r,w as i,g as s,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.
 		router.`),s("span",{class:"hljs-title function_"},"get"),e("("),s("span",{class:"hljs-string"},"'/goodbye'"),e(", "),s("span",{class:"hljs-function"},[e("("),s("span",{class:"hljs-params"},"req, res"),e(") =>")]),e(" res."),s("span",{class:"hljs-title function_"},"send"),e("("),s("span",{class:"hljs-string"},"'Goodbye!'"),e(`));
 	},
 };
-`)])]),s("p",null,[e("The routes of this endpoint are accessible at "),s("code",null,"/greet"),e(", "),s("code",null,"/greet/intro"),e(" and "),s("code",null,"/greet/goodbye"),e(".")]),s("h4",{id:"available-options",tabindex:"-1"},[e("Available Options "),s("a",{class:"header-anchor",href:"#available-options"},"#")]),s("ul",null,[s("li",null,[s("code",null,"id"),e(" \u2014 The unique key for this endpoint. Each route of your endpoint will be a sub-route of "),s("code",null,"/<id>"),e(".")]),s("li",null,[s("code",null,"handler"),e(" \u2014 The endpoint\u2019s registration handler function.")])]),s("h2",{id:"register-function",tabindex:"-1"},[e("Register Function "),s("a",{class:"header-anchor",href:"#register-function"},"#")]),s("p",null,[e("The register function receives the two parameters "),s("code",null,"router"),e(" and "),s("code",null,"context"),e(". "),s("code",null,"router"),e(" is an Express router instance. "),s("code",null,"context"),e(" is an object with the following properties:")]),s("ul",null,[s("li",null,[s("code",null,"services"),e(" \u2014 All API internal services.")]),s("li",null,[s("code",null,"exceptions"),e(" \u2014 API exception objects that can be used to throw \u201Cproper\u201D errors.")]),s("li",null,[s("code",null,"database"),e(" \u2014 Knex instance that is connected to the current database.")]),s("li",null,[s("code",null,"getSchema"),e(" \u2014 Async function that reads the full available schema for use in services")]),s("li",null,[s("code",null,"env"),e(" \u2014 Parsed environment variables.")]),s("li",null,[s("code",null,"logger"),e(" \u2014 "),s("a",{href:"https://github.com/pinojs/pino",target:"_blank",rel:"noopener noreferrer"},"Pino"),e(" instance.")]),s("li",null,[s("code",null,"emitter"),e(" \u2014 "),s("a",{href:"https://github.com/directus/directus/blob/main/api/src/emitter.ts",target:"_blank",rel:"noopener noreferrer"},"Event emitter"),e(" instance that can be used to trigger custom events for other extensions.")])]),s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"Event loop"),s("p",null,"When implementing custom events using the emitter make sure you never directly or indirectly emit the same event your hook is currently handling as that would result in an infinite loop!")]),s("h2",{id:"example%3A-recipes",tabindex:"-1"},[e("Example: Recipes "),s("a",{class:"header-anchor",href:"#example%3A-recipes"},"#")]),s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"export"),e(),s("span",{class:"hljs-keyword"},"default"),e(` (router, { services, exceptions }) => {
+`)])]),s("p",null,[e("The routes of this endpoint are accessible at "),s("code",null,"/greet"),e(", "),s("code",null,"/greet/intro"),e(" and "),s("code",null,"/greet/goodbye"),e(".")]),s("h4",{id:"available-options",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#available-options"},"#"),e(" Available Options")]),s("ul",null,[s("li",null,[s("code",null,"id"),e(" \u2014 The unique key for this endpoint. Each route of your endpoint will be a sub-route of "),s("code",null,"/<id>"),e(".")]),s("li",null,[s("code",null,"handler"),e(" \u2014 The endpoint\u2019s registration handler function.")])]),s("h2",{id:"register-function",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#register-function"},"#"),e(" Register Function")]),s("p",null,[e("The register function receives the two parameters "),s("code",null,"router"),e(" and "),s("code",null,"context"),e(". "),s("code",null,"router"),e(" is an Express router instance. "),s("code",null,"context"),e(" is an object with the following properties:")]),s("ul",null,[s("li",null,[s("code",null,"services"),e(" \u2014 All API internal services.")]),s("li",null,[s("code",null,"exceptions"),e(" \u2014 API exception objects that can be used to throw \u201Cproper\u201D errors.")]),s("li",null,[s("code",null,"database"),e(" \u2014 Knex instance that is connected to the current database.")]),s("li",null,[s("code",null,"getSchema"),e(" \u2014 Async function that reads the full available schema for use in services")]),s("li",null,[s("code",null,"env"),e(" \u2014 Parsed environment variables.")]),s("li",null,[s("code",null,"logger"),e(" \u2014 "),s("a",{href:"https://github.com/pinojs/pino",target:"_blank",rel:"noopener noreferrer"},"Pino"),e(" instance.")]),s("li",null,[s("code",null,"emitter"),e(" \u2014 "),s("a",{href:"https://github.com/directus/directus/blob/main/api/src/emitter.ts",target:"_blank",rel:"noopener noreferrer"},"Event emitter"),e(" instance that can be used to trigger custom events for other extensions.")])]),s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"Event loop"),s("p",null,"When implementing custom events using the emitter make sure you never directly or indirectly emit the same event your hook is currently handling as that would result in an infinite loop!")]),s("h2",{id:"example%3A-recipes",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example%3A-recipes"},"#"),e(" Example: Recipes")]),s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"export"),e(),s("span",{class:"hljs-keyword"},"default"),e(` (router, { services, exceptions }) => {
 	`),s("span",{class:"hljs-keyword"},"const"),e(" { "),s("span",{class:"hljs-title class_"},"ItemsService"),e(` } = services;
 	`),s("span",{class:"hljs-keyword"},"const"),e(" { "),s("span",{class:"hljs-title class_"},"ServiceUnavailableException"),e(` } = exceptions;
 

package/dist/assets/{erlang.acb354b6.js → erlang.50accc38.js}

@@ -1 +1 @@
-import{z as X}from"./index.917a76e9.entry.js";function Y(s,k){return k.forEach(function(c){c&&typeof c!="string"&&!Array.isArray(c)&&Object.keys(c).forEach(function(_){if(_!=="default"&&!(_ in s)){var b=Object.getOwnPropertyDescriptor(c,_);Object.defineProperty(s,_,b.get?b:{enumerable:!0,get:function(){return c[_]}})}})}),Object.freeze(Object.defineProperty(s,Symbol.toStringTag,{value:"Module"}))}var P={exports:{}};(function(s,k){(function(c){c(X.exports)})(function(c){c.defineMIME("text/x-erlang","erlang"),c.defineMode("erlang",function(_){var b=["-type","-spec","-export_type","-opaque"],m=["after","begin","catch","case","cond","end","fun","if","let","of","query","receive","try","when"],A=/[\->,;]/,R=["->",";",","],U=["and","andalso","band","bnot","bor","bsl","bsr","bxor","div","not","or","orelse","rem","xor"],j=/[\+\-\*\/<>=\|:!]/,O=["=","+","-","*","/",">",">=","<","=<","=:=","==","=/=","/=","||","<-","!"],Z=/[<\(\[\{]/,h=["<<","(","[","{"],q=/[>\)\]\}]/,w=["}","]",")",">>"],$=["is_atom","is_binary","is_bitstring","is_boolean","is_float","is_function","is_integer","is_list","is_number","is_pid","is_port","is_record","is_reference","is_tuple","atom","binary","bitstring","boolean","function","integer","list","number","pid","port","record","reference","tuple"],I=["abs","adler32","adler32_combine","alive","apply","atom_to_binary","atom_to_list","binary_to_atom","binary_to_existing_atom","binary_to_list","binary_to_term","bit_size","bitstring_to_list","byte_size","check_process_code","contact_binary","crc32","crc32_combine","date","decode_packet","delete_module","disconnect_node","element","erase","exit","float","float_to_list","garbage_collect","get","get_keys","group_leader","halt","hd","integer_to_list","internal_bif","iolist_size","iolist_to_binary","is_alive","is_atom","is_binary","is_bitstring","is_boolean","is_float","is_function","is_integer","is_list","is_number","is_pid","is_port","is_process_alive","is_record","is_reference","is_tuple","length","link","list_to_atom","list_to_binary","list_to_bitstring","list_to_existing_atom","list_to_float","list_to_integer","list_to_pid","list_to_tuple","load_module","make_ref","module_loaded","monitor_node","node","node_link","node_unlink","nodes","notalive","now","open_port","pid_to_list","port_close","port_command","port_connect","port_control","pre_loaded","process_flag","process_info","processes","purge_module","put","register","registered","round","self","setelement","size","spawn","spawn_link","spawn_monitor","spawn_opt","split_binary","statistics","term_to_binary","time","throw","tl","trunc","tuple_size","tuple_to_list","unlink","unregister","whereis"],g=/[\w@Ø-ÞÀ-Öß-öø-ÿ]/,Q=/[0-7]{1,3}|[bdefnrstv\\"']|\^[a-zA-Z]|x[0-9a-zA-Z]{2}|x{[0-9a-zA-Z]+}/;function D(e,n){if(n.in_string)return n.in_string=!W(e),i(n,e,"string");if(n.in_atom)return n.in_atom=!E(e),i(n,e,"atom");if(e.eatSpace())return i(n,e,"whitespace");if(!d(n)&&e.match(/-\s*[a-zß-öø-ÿ][\wØ-ÞÀ-Öß-öø-ÿ]*/))return u(e.current(),b)?i(n,e,"type"):i(n,e,"attribute");var r=e.next();if(r=="%")return e.skipToEnd(),i(n,e,"comment");if(r==":")return i(n,e,"colon");if(r=="?")return e.eatSpace(),e.eatWhile(g),i(n,e,"macro");if(r=="#")return e.eatSpace(),e.eatWhile(g),i(n,e,"record");if(r=="$")return e.next()=="\\"&&!e.match(Q)?i(n,e,"error"):i(n,e,"number");if(r==".")return i(n,e,"dot");if(r=="'"){if(!(n.in_atom=!E(e))){if(e.match(/\s*\/\s*[0-9]/,!1))return e.match(/\s*\/\s*[0-9]/,!0),i(n,e,"fun");if(e.match(/\s*\(/,!1)||e.match(/\s*:/,!1))return i(n,e,"function")}return i(n,e,"atom")}if(r=='"')return n.in_string=!W(e),i(n,e,"string");if(/[A-Z_Ø-ÞÀ-Ö]/.test(r))return e.eatWhile(g),i(n,e,"variable");if(/[a-z_ß-öø-ÿ]/.test(r)){if(e.eatWhile(g),e.match(/\s*\/\s*[0-9]/,!1))return e.match(/\s*\/\s*[0-9]/,!0),i(n,e,"fun");var t=e.current();return u(t,m)?i(n,e,"keyword"):u(t,U)?i(n,e,"operator"):e.match(/\s*\(/,!1)?u(t,I)&&(d(n).token!=":"||d(n,2).token=="erlang")?i(n,e,"builtin"):u(t,$)?i(n,e,"guard"):i(n,e,"function"):N(e)==":"?t=="erlang"?i(n,e,"builtin"):i(n,e,"function"):u(t,["true","false"])?i(n,e,"boolean"):i(n,e,"atom")}var l=/[0-9]/,o=/[0-9a-zA-Z]/;return l.test(r)?(e.eatWhile(l),e.eat("#")?e.eatWhile(o)||e.backUp(1):e.eat(".")&&(e.eatWhile(l)?e.eat(/[eE]/)&&(e.eat(/[-+]/)?e.eatWhile(l)||e.backUp(2):e.eatWhile(l)||e.backUp(1)):e.backUp(1)),i(n,e,"number")):x(e,Z,h)?i(n,e,"open_paren"):x(e,q,w)?i(n,e,"close_paren"):S(e,A,R)?i(n,e,"separator"):S(e,j,O)?i(n,e,"operator"):i(n,e,null)}function x(e,n,r){if(e.current().length==1&&n.test(e.current())){for(e.backUp(1);n.test(e.peek());)if(e.next(),u(e.current(),r))return!0;e.backUp(e.current().length-1)}return!1}function S(e,n,r){if(e.current().length==1&&n.test(e.current())){for(;n.test(e.peek());)e.next();for(;0<e.current().length;){if(u(e.current(),r))return!0;e.backUp(1)}e.next()}return!1}function W(e){return z(e,'"',"\\")}function E(e){return z(e,"'","\\")}function z(e,n,r){for(;!e.eol();){var t=e.next();if(t==n)return!0;t==r&&e.next()}return!1}function N(e){var n=e.match(/^\s*([^\s%])/,!1);return n?n[1]:""}function u(e,n){return-1<n.indexOf(e)}function i(e,n,r){switch(G(e,B(r,n)),r){case"atom":return"atom";case"attribute":return"attribute";case"boolean":return"atom";case"builtin":return"builtin";case"close_paren":return null;case"colon":return null;case"comment":return"comment";case"dot":return null;case"error":return"error";case"fun":return"meta";case"function":return"tag";case"guard":return"property";case"keyword":return"keyword";case"macro":return"variable-2";case"number":return"number";case"open_paren":return null;case"operator":return"operator";case"record":return"bracket";case"separator":return null;case"string":return"string";case"type":return"def";case"variable":return"variable";default:return null}}function T(e,n,r,t){return{token:e,column:n,indent:r,type:t}}function B(e,n){return T(n.current(),n.column(),n.indentation(),e)}function F(e){return T(e,0,0,e)}function d(e,n){var r=e.tokenStack.length,t=n||1;return r<t?!1:e.tokenStack[r-t]}function G(e,n){n.type=="comment"||n.type=="whitespace"||(e.tokenStack=H(e.tokenStack,n),e.tokenStack=J(e.tokenStack))}function H(e,n){var r=e.length-1;return 0<r&&e[r].type==="record"&&n.type==="dot"?e.pop():(0<r&&e[r].type==="group"&&e.pop(),e.push(n)),e}function J(e){if(!e.length)return e;var n=e.length-1;if(e[n].type==="dot")return[];if(n>1&&e[n].type==="fun"&&e[n-1].token==="fun")return e.slice(0,n-1);switch(e[n].token){case"}":return f(e,{g:["{"]});case"]":return f(e,{i:["["]});case")":return f(e,{i:["("]});case">>":return f(e,{i:["<<"]});case"end":return f(e,{i:["begin","case","fun","if","receive","try"]});case",":return f(e,{e:["begin","try","when","->",",","(","[","{","<<"]});case"->":return f(e,{r:["when"],m:["try","if","case","receive"]});case";":return f(e,{E:["case","fun","if","receive","try","when"]});case"catch":return f(e,{e:["try"]});case"of":return f(e,{e:["case"]});case"after":return f(e,{e:["receive","try"]});default:return e}}function f(e,n){for(var r in n)for(var t=e.length-1,l=n[r],o=t-1;-1<o;o--)if(u(e[o].token,l)){var a=e.slice(0,o);switch(r){case"m":return a.concat(e[o]).concat(e[t]);case"r":return a.concat(e[t]);case"i":return a;case"g":return a.concat(F("group"));case"E":return a.concat(e[o]);case"e":return a.concat(e[o])}}return r=="E"?[]:e}function K(e,n){var r,t=_.indentUnit,l=L(n),o=d(e,1),a=d(e,2);return e.in_string||e.in_atom?c.Pass:a?o.token=="when"?o.column+t:l==="when"&&a.type==="function"?a.indent+t:l==="("&&o.token==="fun"?o.column+3:l==="catch"&&(r=y(e,["try"]))?r.column:u(l,["end","after","of"])?(r=y(e,["begin","case","fun","if","receive","try"]),r?r.column:c.Pass):u(l,w)?(r=y(e,h),r?r.column:c.Pass):u(o.token,[",","|","||"])||u(l,[",","|","||"])?(r=M(e),r?r.column+r.token.length:t):o.token=="->"?u(a.token,["receive","case","if","try"])?a.column+t+t:a.column+t:u(o.token,h)?o.column+o.token.length:(r=V(e),p(r)?r.column+t:0):0}function L(e){var n=e.match(/,|[a-z]+|\}|\]|\)|>>|\|+|\(/);return p(n)&&n.index===0?n[0]:""}function M(e){var n=e.tokenStack.slice(0,-1),r=v(n,"type",["open_paren"]);return p(n[r])?n[r]:!1}function V(e){var n=e.tokenStack,r=v(n,"type",["open_paren","separator","keyword"]),t=v(n,"type",["operator"]);return p(r)&&p(t)&&r<t?n[r+1]:p(r)?n[r]:!1}function y(e,n){var r=e.tokenStack,t=v(r,"token",n);return p(r[t])?r[t]:!1}function v(e,n,r){for(var t=e.length-1;-1<t;t--)if(u(e[t][n],r))return t;return!1}function p(e){return e!==!1&&e!=null}return{startState:function(){return{tokenStack:[],in_string:!1,in_atom:!1}},token:function(e,n){return D(e,n)},indent:function(e,n){return K(e,n)},lineComment:"%"}})})})();var C=P.exports,ne=Y({__proto__:null,default:C},[P.exports]);export{ne as e};
+import{y as X}from"./index.e00d2c6d.entry.js";function Y(s,k){return k.forEach(function(c){c&&typeof c!="string"&&!Array.isArray(c)&&Object.keys(c).forEach(function(_){if(_!=="default"&&!(_ in s)){var b=Object.getOwnPropertyDescriptor(c,_);Object.defineProperty(s,_,b.get?b:{enumerable:!0,get:function(){return c[_]}})}})}),Object.freeze(Object.defineProperty(s,Symbol.toStringTag,{value:"Module"}))}var P={exports:{}};(function(s,k){(function(c){c(X.exports)})(function(c){c.defineMIME("text/x-erlang","erlang"),c.defineMode("erlang",function(_){var b=["-type","-spec","-export_type","-opaque"],m=["after","begin","catch","case","cond","end","fun","if","let","of","query","receive","try","when"],A=/[\->,;]/,R=["->",";",","],U=["and","andalso","band","bnot","bor","bsl","bsr","bxor","div","not","or","orelse","rem","xor"],j=/[\+\-\*\/<>=\|:!]/,O=["=","+","-","*","/",">",">=","<","=<","=:=","==","=/=","/=","||","<-","!"],Z=/[<\(\[\{]/,h=["<<","(","[","{"],q=/[>\)\]\}]/,w=["}","]",")",">>"],$=["is_atom","is_binary","is_bitstring","is_boolean","is_float","is_function","is_integer","is_list","is_number","is_pid","is_port","is_record","is_reference","is_tuple","atom","binary","bitstring","boolean","function","integer","list","number","pid","port","record","reference","tuple"],I=["abs","adler32","adler32_combine","alive","apply","atom_to_binary","atom_to_list","binary_to_atom","binary_to_existing_atom","binary_to_list","binary_to_term","bit_size","bitstring_to_list","byte_size","check_process_code","contact_binary","crc32","crc32_combine","date","decode_packet","delete_module","disconnect_node","element","erase","exit","float","float_to_list","garbage_collect","get","get_keys","group_leader","halt","hd","integer_to_list","internal_bif","iolist_size","iolist_to_binary","is_alive","is_atom","is_binary","is_bitstring","is_boolean","is_float","is_function","is_integer","is_list","is_number","is_pid","is_port","is_process_alive","is_record","is_reference","is_tuple","length","link","list_to_atom","list_to_binary","list_to_bitstring","list_to_existing_atom","list_to_float","list_to_integer","list_to_pid","list_to_tuple","load_module","make_ref","module_loaded","monitor_node","node","node_link","node_unlink","nodes","notalive","now","open_port","pid_to_list","port_close","port_command","port_connect","port_control","pre_loaded","process_flag","process_info","processes","purge_module","put","register","registered","round","self","setelement","size","spawn","spawn_link","spawn_monitor","spawn_opt","split_binary","statistics","term_to_binary","time","throw","tl","trunc","tuple_size","tuple_to_list","unlink","unregister","whereis"],g=/[\w@Ø-ÞÀ-Öß-öø-ÿ]/,Q=/[0-7]{1,3}|[bdefnrstv\\"']|\^[a-zA-Z]|x[0-9a-zA-Z]{2}|x{[0-9a-zA-Z]+}/;function D(e,n){if(n.in_string)return n.in_string=!W(e),i(n,e,"string");if(n.in_atom)return n.in_atom=!E(e),i(n,e,"atom");if(e.eatSpace())return i(n,e,"whitespace");if(!d(n)&&e.match(/-\s*[a-zß-öø-ÿ][\wØ-ÞÀ-Öß-öø-ÿ]*/))return u(e.current(),b)?i(n,e,"type"):i(n,e,"attribute");var r=e.next();if(r=="%")return e.skipToEnd(),i(n,e,"comment");if(r==":")return i(n,e,"colon");if(r=="?")return e.eatSpace(),e.eatWhile(g),i(n,e,"macro");if(r=="#")return e.eatSpace(),e.eatWhile(g),i(n,e,"record");if(r=="$")return e.next()=="\\"&&!e.match(Q)?i(n,e,"error"):i(n,e,"number");if(r==".")return i(n,e,"dot");if(r=="'"){if(!(n.in_atom=!E(e))){if(e.match(/\s*\/\s*[0-9]/,!1))return e.match(/\s*\/\s*[0-9]/,!0),i(n,e,"fun");if(e.match(/\s*\(/,!1)||e.match(/\s*:/,!1))return i(n,e,"function")}return i(n,e,"atom")}if(r=='"')return n.in_string=!W(e),i(n,e,"string");if(/[A-Z_Ø-ÞÀ-Ö]/.test(r))return e.eatWhile(g),i(n,e,"variable");if(/[a-z_ß-öø-ÿ]/.test(r)){if(e.eatWhile(g),e.match(/\s*\/\s*[0-9]/,!1))return e.match(/\s*\/\s*[0-9]/,!0),i(n,e,"fun");var t=e.current();return u(t,m)?i(n,e,"keyword"):u(t,U)?i(n,e,"operator"):e.match(/\s*\(/,!1)?u(t,I)&&(d(n).token!=":"||d(n,2).token=="erlang")?i(n,e,"builtin"):u(t,$)?i(n,e,"guard"):i(n,e,"function"):N(e)==":"?t=="erlang"?i(n,e,"builtin"):i(n,e,"function"):u(t,["true","false"])?i(n,e,"boolean"):i(n,e,"atom")}var l=/[0-9]/,o=/[0-9a-zA-Z]/;return l.test(r)?(e.eatWhile(l),e.eat("#")?e.eatWhile(o)||e.backUp(1):e.eat(".")&&(e.eatWhile(l)?e.eat(/[eE]/)&&(e.eat(/[-+]/)?e.eatWhile(l)||e.backUp(2):e.eatWhile(l)||e.backUp(1)):e.backUp(1)),i(n,e,"number")):x(e,Z,h)?i(n,e,"open_paren"):x(e,q,w)?i(n,e,"close_paren"):S(e,A,R)?i(n,e,"separator"):S(e,j,O)?i(n,e,"operator"):i(n,e,null)}function x(e,n,r){if(e.current().length==1&&n.test(e.current())){for(e.backUp(1);n.test(e.peek());)if(e.next(),u(e.current(),r))return!0;e.backUp(e.current().length-1)}return!1}function S(e,n,r){if(e.current().length==1&&n.test(e.current())){for(;n.test(e.peek());)e.next();for(;0<e.current().length;){if(u(e.current(),r))return!0;e.backUp(1)}e.next()}return!1}function W(e){return z(e,'"',"\\")}function E(e){return z(e,"'","\\")}function z(e,n,r){for(;!e.eol();){var t=e.next();if(t==n)return!0;t==r&&e.next()}return!1}function N(e){var n=e.match(/^\s*([^\s%])/,!1);return n?n[1]:""}function u(e,n){return-1<n.indexOf(e)}function i(e,n,r){switch(G(e,B(r,n)),r){case"atom":return"atom";case"attribute":return"attribute";case"boolean":return"atom";case"builtin":return"builtin";case"close_paren":return null;case"colon":return null;case"comment":return"comment";case"dot":return null;case"error":return"error";case"fun":return"meta";case"function":return"tag";case"guard":return"property";case"keyword":return"keyword";case"macro":return"variable-2";case"number":return"number";case"open_paren":return null;case"operator":return"operator";case"record":return"bracket";case"separator":return null;case"string":return"string";case"type":return"def";case"variable":return"variable";default:return null}}function T(e,n,r,t){return{token:e,column:n,indent:r,type:t}}function B(e,n){return T(n.current(),n.column(),n.indentation(),e)}function F(e){return T(e,0,0,e)}function d(e,n){var r=e.tokenStack.length,t=n||1;return r<t?!1:e.tokenStack[r-t]}function G(e,n){n.type=="comment"||n.type=="whitespace"||(e.tokenStack=H(e.tokenStack,n),e.tokenStack=J(e.tokenStack))}function H(e,n){var r=e.length-1;return 0<r&&e[r].type==="record"&&n.type==="dot"?e.pop():(0<r&&e[r].type==="group"&&e.pop(),e.push(n)),e}function J(e){if(!e.length)return e;var n=e.length-1;if(e[n].type==="dot")return[];if(n>1&&e[n].type==="fun"&&e[n-1].token==="fun")return e.slice(0,n-1);switch(e[n].token){case"}":return f(e,{g:["{"]});case"]":return f(e,{i:["["]});case")":return f(e,{i:["("]});case">>":return f(e,{i:["<<"]});case"end":return f(e,{i:["begin","case","fun","if","receive","try"]});case",":return f(e,{e:["begin","try","when","->",",","(","[","{","<<"]});case"->":return f(e,{r:["when"],m:["try","if","case","receive"]});case";":return f(e,{E:["case","fun","if","receive","try","when"]});case"catch":return f(e,{e:["try"]});case"of":return f(e,{e:["case"]});case"after":return f(e,{e:["receive","try"]});default:return e}}function f(e,n){for(var r in n)for(var t=e.length-1,l=n[r],o=t-1;-1<o;o--)if(u(e[o].token,l)){var a=e.slice(0,o);switch(r){case"m":return a.concat(e[o]).concat(e[t]);case"r":return a.concat(e[t]);case"i":return a;case"g":return a.concat(F("group"));case"E":return a.concat(e[o]);case"e":return a.concat(e[o])}}return r=="E"?[]:e}function K(e,n){var r,t=_.indentUnit,l=L(n),o=d(e,1),a=d(e,2);return e.in_string||e.in_atom?c.Pass:a?o.token=="when"?o.column+t:l==="when"&&a.type==="function"?a.indent+t:l==="("&&o.token==="fun"?o.column+3:l==="catch"&&(r=y(e,["try"]))?r.column:u(l,["end","after","of"])?(r=y(e,["begin","case","fun","if","receive","try"]),r?r.column:c.Pass):u(l,w)?(r=y(e,h),r?r.column:c.Pass):u(o.token,[",","|","||"])||u(l,[",","|","||"])?(r=M(e),r?r.column+r.token.length:t):o.token=="->"?u(a.token,["receive","case","if","try"])?a.column+t+t:a.column+t:u(o.token,h)?o.column+o.token.length:(r=V(e),p(r)?r.column+t:0):0}function L(e){var n=e.match(/,|[a-z]+|\}|\]|\)|>>|\|+|\(/);return p(n)&&n.index===0?n[0]:""}function M(e){var n=e.tokenStack.slice(0,-1),r=v(n,"type",["open_paren"]);return p(n[r])?n[r]:!1}function V(e){var n=e.tokenStack,r=v(n,"type",["open_paren","separator","keyword"]),t=v(n,"type",["operator"]);return p(r)&&p(t)&&r<t?n[r+1]:p(r)?n[r]:!1}function y(e,n){var r=e.tokenStack,t=v(r,"token",n);return p(r[t])?r[t]:!1}function v(e,n,r){for(var t=e.length-1;-1<t;t--)if(u(e[t][n],r))return t;return!1}function p(e){return e!==!1&&e!=null}return{startState:function(){return{tokenStack:[],in_string:!1,in_atom:!1}},token:function(e,n){return D(e,n)},indent:function(e,n){return K(e,n)},lineComment:"%"}})})})();var C=P.exports,ne=Y({__proto__:null,default:C},[P.exports]);export{ne as e};

package/dist/assets/{extensions.0f9a4545.js → extensions.27ee4742.js}

@@ -1,10 +1,10 @@
-import{a as n,o as i,b as c,w as a,g as e,e as d,B as s}from"./runtime-core.esm-bundler.e3d5f5b7.js";const h={class:"markdown-body"},p={class:"two-up"},u={class:"left"},x=s("The extensions endpoints are used by the Admin App to retrieve what extensions to install. "),_=s("Learn more about Extensions"),f=s("."),m=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#list-extensions"},"List Extensions ")])])])])],-1),y=e("hr",null,null,-1),g=e("h2",{id:"list-extensions",tabindex:"-1"},[s("List Extensions "),e("a",{class:"header-anchor",href:"#list-extensions"},"#")],-1),b=e("p",null,"List the available extensions in the project. The types of extensions that you can list are interfaces, displays, layouts, modules.",-1),E=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")]),e("p",null,"This endpoint doesn\u2019t currently support any query parameters."),e("h3",{id:"returns",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")]),e("p",null,"An array of interface extension keys.")]),e("div",{class:"right"},[e("h3",{id:"rest-api",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")]),e("pre",null,[e("code",null,`GET /extensions/:type
-`)]),e("h5",{id:"example",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("pre",null,[e("code",null,`GET /extensions/interfaces
-`)]),e("h3",{id:"graphql",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+import{a as n,o as i,b as c,w as a,g as e,e as d,B as s}from"./runtime-core.esm-bundler.e3d5f5b7.js";const h={class:"markdown-body"},p={class:"two-up"},u={class:"left"},x=s("The extensions endpoints are used by the Admin App to retrieve what extensions to install. "),_=s("Learn more about Extensions"),f=s("."),m=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#list-extensions"}," List Extensions")])])])])],-1),y=e("hr",null,null,-1),g=e("h2",{id:"list-extensions",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#list-extensions"},"#"),s(" List Extensions")],-1),b=e("p",null,"List the available extensions in the project. The types of extensions that you can list are interfaces, displays, layouts, modules.",-1),E=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#query-parameters"},"#"),s(" Query Parameters")]),e("p",null,"This endpoint doesn\u2019t currently support any query parameters."),e("h3",{id:"returns",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns"},"#"),s(" Returns")]),e("p",null,"An array of interface extension keys.")]),e("div",{class:"right"},[e("h3",{id:"rest-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api"},"#"),s(" REST API")]),e("pre",null,[e("code",null,`GET /extensions/:type
+`)]),e("h5",{id:"example",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example"},"#"),s(" Example")]),e("pre",null,[e("code",null,`GET /extensions/interfaces
+`)]),e("h3",{id:"graphql",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql"},"#"),s(" GraphQL")]),e("pre",null,[e("code",null,`POST /graphql/system
 `)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
 	extensions: extensions
 }
-`)])]),e("h5",{id:"example-1",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-1"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
+`)])]),e("h5",{id:"example-1",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-1"},"#"),s(" Example")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
 	extensions {
 		interfaces
 	}

package/dist/assets/{factor.74747951.js → factor.164d6f9d.js}

@@ -1 +1 @@
-import{z as g}from"./index.917a76e9.entry.js";import{s as a}from"./simple.1606e663.js";function x(r,n){return n.forEach(function(e){e&&typeof e!="string"&&!Array.isArray(e)&&Object.keys(e).forEach(function(t){if(t!=="default"&&!(t in r)){var o=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(r,t,o.get?o:{enumerable:!0,get:function(){return e[t]}})}})}),Object.freeze(Object.defineProperty(r,Symbol.toStringTag,{value:"Module"}))}var s={exports:{}};(function(r,n){(function(e){e(g.exports,a.exports)})(function(e){e.defineSimpleMode("factor",{start:[{regex:/#?!.*/,token:"comment"},{regex:/"""/,token:"string",next:"string3"},{regex:/(STRING:)(\s)/,token:["keyword",null],next:"string2"},{regex:/\S*?"/,token:"string",next:"string"},{regex:/(?:0x[\d,a-f]+)|(?:0o[0-7]+)|(?:0b[0,1]+)|(?:\-?\d+.?\d*)(?=\s)/,token:"number"},{regex:/((?:GENERIC)|\:?\:)(\s+)(\S+)(\s+)(\()/,token:["keyword",null,"def",null,"bracket"],next:"stack"},{regex:/(M\:)(\s+)(\S+)(\s+)(\S+)/,token:["keyword",null,"def",null,"tag"]},{regex:/USING\:/,token:"keyword",next:"vocabulary"},{regex:/(USE\:|IN\:)(\s+)(\S+)(?=\s|$)/,token:["keyword",null,"tag"]},{regex:/(\S+\:)(\s+)(\S+)(?=\s|$)/,token:["keyword",null,"def"]},{regex:/(?:;|\\|t|f|if|loop|while|until|do|PRIVATE>|<PRIVATE|\.|\S*\[|\]|\S*\{|\})(?=\s|$)/,token:"keyword"},{regex:/\S+[\)>\.\*\?]+(?=\s|$)/,token:"builtin"},{regex:/[\)><]+\S+(?=\s|$)/,token:"builtin"},{regex:/(?:[\+\-\=\/\*<>])(?=\s|$)/,token:"keyword"},{regex:/\S+/,token:"variable"},{regex:/\s+|./,token:null}],vocabulary:[{regex:/;/,token:"keyword",next:"start"},{regex:/\S+/,token:"tag"},{regex:/\s+|./,token:null}],string:[{regex:/(?:[^\\]|\\.)*?"/,token:"string",next:"start"},{regex:/.*/,token:"string"}],string2:[{regex:/^;/,token:"keyword",next:"start"},{regex:/.*/,token:"string"}],string3:[{regex:/(?:[^\\]|\\.)*?"""/,token:"string",next:"start"},{regex:/.*/,token:"string"}],stack:[{regex:/\)/,token:"bracket",next:"start"},{regex:/--/,token:"bracket"},{regex:/\S+/,token:"meta"},{regex:/\s+|./,token:null}],meta:{dontIndentStates:["start","vocabulary","string","string3","stack"],lineComment:["!","#!"]}}),e.defineMIME("text/x-factor","factor")})})();var i=s.exports,u=x({__proto__:null,default:i},[s.exports]);export{u as f};
+import{y as g}from"./index.e00d2c6d.entry.js";import{s as a}from"./simple.1606e663.js";function x(r,n){return n.forEach(function(e){e&&typeof e!="string"&&!Array.isArray(e)&&Object.keys(e).forEach(function(t){if(t!=="default"&&!(t in r)){var o=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(r,t,o.get?o:{enumerable:!0,get:function(){return e[t]}})}})}),Object.freeze(Object.defineProperty(r,Symbol.toStringTag,{value:"Module"}))}var s={exports:{}};(function(r,n){(function(e){e(g.exports,a.exports)})(function(e){e.defineSimpleMode("factor",{start:[{regex:/#?!.*/,token:"comment"},{regex:/"""/,token:"string",next:"string3"},{regex:/(STRING:)(\s)/,token:["keyword",null],next:"string2"},{regex:/\S*?"/,token:"string",next:"string"},{regex:/(?:0x[\d,a-f]+)|(?:0o[0-7]+)|(?:0b[0,1]+)|(?:\-?\d+.?\d*)(?=\s)/,token:"number"},{regex:/((?:GENERIC)|\:?\:)(\s+)(\S+)(\s+)(\()/,token:["keyword",null,"def",null,"bracket"],next:"stack"},{regex:/(M\:)(\s+)(\S+)(\s+)(\S+)/,token:["keyword",null,"def",null,"tag"]},{regex:/USING\:/,token:"keyword",next:"vocabulary"},{regex:/(USE\:|IN\:)(\s+)(\S+)(?=\s|$)/,token:["keyword",null,"tag"]},{regex:/(\S+\:)(\s+)(\S+)(?=\s|$)/,token:["keyword",null,"def"]},{regex:/(?:;|\\|t|f|if|loop|while|until|do|PRIVATE>|<PRIVATE|\.|\S*\[|\]|\S*\{|\})(?=\s|$)/,token:"keyword"},{regex:/\S+[\)>\.\*\?]+(?=\s|$)/,token:"builtin"},{regex:/[\)><]+\S+(?=\s|$)/,token:"builtin"},{regex:/(?:[\+\-\=\/\*<>])(?=\s|$)/,token:"keyword"},{regex:/\S+/,token:"variable"},{regex:/\s+|./,token:null}],vocabulary:[{regex:/;/,token:"keyword",next:"start"},{regex:/\S+/,token:"tag"},{regex:/\s+|./,token:null}],string:[{regex:/(?:[^\\]|\\.)*?"/,token:"string",next:"start"},{regex:/.*/,token:"string"}],string2:[{regex:/^;/,token:"keyword",next:"start"},{regex:/.*/,token:"string"}],string3:[{regex:/(?:[^\\]|\\.)*?"""/,token:"string",next:"start"},{regex:/.*/,token:"string"}],stack:[{regex:/\)/,token:"bracket",next:"start"},{regex:/--/,token:"bracket"},{regex:/\S+/,token:"meta"},{regex:/\s+|./,token:null}],meta:{dontIndentStates:["start","vocabulary","string","string3","stack"],lineComment:["!","#!"]}}),e.defineMIME("text/x-factor","factor")})})();var i=s.exports,u=x({__proto__:null,default:i},[s.exports]);export{u as f};

package/dist/assets/{faq.c134fb00.js → faq.633c25f1.js}

@@ -1,2 +1,2 @@
-import{a as r,o as n,b as i,w as l,g as e,B as s}from"./runtime-core.esm-bundler.e3d5f5b7.js";const c=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,"TK")]),e("h2",{id:"is-it-possible-to-update-the-admin-user-password-via-cli%3F",tabindex:"-1"},[s("Is it possible to update the admin user password via CLI? "),e("a",{class:"header-anchor",href:"#is-it-possible-to-update-the-admin-user-password-via-cli%3F"},"#")]),e("p",null,"You can do this with the following command:"),e("pre",null,[e("code",{class:"language-sh"},[s("npx directus "),e("span",{class:"hljs-built_in"},"users"),s(` passwd --email admin@example.com --password newpasswordhere
-`)])]),e("h2",{id:"why-isn%E2%80%99t-directus-properly-saving-chinese-characters-or-emoji%3F",tabindex:"-1"},[s("Why isn\u2019t Directus properly saving Chinese characters or emoji? "),e("a",{class:"header-anchor",href:"#why-isn%E2%80%99t-directus-properly-saving-chinese-characters-or-emoji%3F"},"#")]),e("p",null,[s("Please ensure that the encoding for your database, tables, and fields are set to "),e("code",null,"utf8mb4"),s(".")])],-1),m="Frequently Asked Questions",w=!1,f={name:"faq",setup(d,{expose:t}){const a={title:"Frequently Asked Questions",modularExtension:!1};return t({frontmatter:a}),(p,u)=>{const o=r("docs-wrapper");return n(),i(o,{frontmatter:a},{default:l(()=>[c]),_:1})}}};export{f as default,w as modularExtension,m as title};
+import{a as r,o as n,b as i,w as l,g as e,B as s}from"./runtime-core.esm-bundler.e3d5f5b7.js";const c=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,"TK")]),e("h2",{id:"is-it-possible-to-update-the-admin-user-password-via-cli%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#is-it-possible-to-update-the-admin-user-password-via-cli%3F"},"#"),s(" Is it possible to update the admin user password via CLI?")]),e("p",null,"You can do this with the following command:"),e("pre",null,[e("code",{class:"language-sh"},[s("npx directus "),e("span",{class:"hljs-built_in"},"users"),s(` passwd --email admin@example.com --password newpasswordhere
+`)])]),e("h2",{id:"why-isn%E2%80%99t-directus-properly-saving-chinese-characters-or-emoji%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#why-isn%E2%80%99t-directus-properly-saving-chinese-characters-or-emoji%3F"},"#"),s(" Why isn\u2019t Directus properly saving Chinese characters or emoji?")]),e("p",null,[s("Please ensure that the encoding for your database, tables, and fields are set to "),e("code",null,"utf8mb4"),s(".")])],-1),m="Frequently Asked Questions",w=!1,f={name:"faq",setup(d,{expose:t}){const a={title:"Frequently Asked Questions",modularExtension:!1};return t({frontmatter:a}),(p,u)=>{const o=r("docs-wrapper");return n(),i(o,{frontmatter:a},{default:l(()=>[c]),_:1})}}};export{f as default,w as modularExtension,m as title};

package/dist/assets/{fcl.76ae408d.js → fcl.2c3dc0b9.js}

@@ -1 +1 @@
-import{z as _}from"./index.917a76e9.entry.js";function g(f,d){return d.forEach(function(u){u&&typeof u!="string"&&!Array.isArray(u)&&Object.keys(u).forEach(function(o){if(o!=="default"&&!(o in f)){var i=Object.getOwnPropertyDescriptor(u,o);Object.defineProperty(f,o,i.get?i:{enumerable:!0,get:function(){return u[o]}})}})}),Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var v={exports:{}};(function(f,d){(function(u){u(_.exports)})(function(u){u.defineMode("fcl",function(o){var i=o.indentUnit,y={term:!0,method:!0,accu:!0,rule:!0,then:!0,is:!0,and:!0,or:!0,if:!0,default:!0},p={var_input:!0,var_output:!0,fuzzify:!0,defuzzify:!0,function_block:!0,ruleblock:!0},l={end_ruleblock:!0,end_defuzzify:!0,end_function_block:!0,end_fuzzify:!0,end_var:!0},s={true:!0,false:!0,nan:!0,real:!0,min:!0,max:!0,cog:!0,cogs:!0},b=/[+\-*&^%:=<>!|\/]/;function a(e,n){var t=e.next();if(/[\d\.]/.test(t))return t=="."?e.match(/^[0-9]+([eE][\-+]?[0-9]+)?/):t=="0"?e.match(/^[xX][0-9a-fA-F]+/)||e.match(/^0[0-7]+/):e.match(/^[0-9]*\.?[0-9]*([eE][\-+]?[0-9]+)?/),"number";if(t=="/"||t=="("){if(e.eat("*"))return n.tokenize=m,m(e,n);if(e.eat("/"))return e.skipToEnd(),"comment"}if(b.test(t))return e.eatWhile(b),"operator";e.eatWhile(/[\w\$_\xa1-\uffff]/);var r=e.current().toLowerCase();return y.propertyIsEnumerable(r)||p.propertyIsEnumerable(r)||l.propertyIsEnumerable(r)?"keyword":s.propertyIsEnumerable(r)?"atom":"variable"}function m(e,n){for(var t=!1,r;r=e.next();){if((r=="/"||r==")")&&t){n.tokenize=a;break}t=r=="*"}return"comment"}function x(e,n,t,r,c){this.indented=e,this.column=n,this.type=t,this.align=r,this.prev=c}function h(e,n,t){return e.context=new x(e.indented,n,t,null,e.context)}function k(e){if(!!e.context.prev){var n=e.context.type;return n=="end_block"&&(e.indented=e.context.indented),e.context=e.context.prev}}return{startState:function(e){return{tokenize:null,context:new x((e||0)-i,0,"top",!1),indented:0,startOfLine:!0}},token:function(e,n){var t=n.context;if(e.sol()&&(t.align==null&&(t.align=!1),n.indented=e.indentation(),n.startOfLine=!0),e.eatSpace())return null;var r=(n.tokenize||a)(e,n);if(r=="comment")return r;t.align==null&&(t.align=!0);var c=e.current().toLowerCase();return p.propertyIsEnumerable(c)?h(n,e.column(),"end_block"):l.propertyIsEnumerable(c)&&k(n),n.startOfLine=!1,r},indent:function(e,n){if(e.tokenize!=a&&e.tokenize!=null)return 0;var t=e.context,r=l.propertyIsEnumerable(n);return t.align?t.column+(r?0:1):t.indented+(r?0:i)},electricChars:"ryk",fold:"brace",blockCommentStart:"(*",blockCommentEnd:"*)",lineComment:"//"}}),u.defineMIME("text/x-fcl","fcl")})})();var z=v.exports,C=g({__proto__:null,default:z},[v.exports]);export{C as f};
+import{y as _}from"./index.e00d2c6d.entry.js";function g(f,d){return d.forEach(function(u){u&&typeof u!="string"&&!Array.isArray(u)&&Object.keys(u).forEach(function(o){if(o!=="default"&&!(o in f)){var i=Object.getOwnPropertyDescriptor(u,o);Object.defineProperty(f,o,i.get?i:{enumerable:!0,get:function(){return u[o]}})}})}),Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var v={exports:{}};(function(f,d){(function(u){u(_.exports)})(function(u){u.defineMode("fcl",function(o){var i=o.indentUnit,y={term:!0,method:!0,accu:!0,rule:!0,then:!0,is:!0,and:!0,or:!0,if:!0,default:!0},p={var_input:!0,var_output:!0,fuzzify:!0,defuzzify:!0,function_block:!0,ruleblock:!0},l={end_ruleblock:!0,end_defuzzify:!0,end_function_block:!0,end_fuzzify:!0,end_var:!0},s={true:!0,false:!0,nan:!0,real:!0,min:!0,max:!0,cog:!0,cogs:!0},b=/[+\-*&^%:=<>!|\/]/;function a(e,n){var t=e.next();if(/[\d\.]/.test(t))return t=="."?e.match(/^[0-9]+([eE][\-+]?[0-9]+)?/):t=="0"?e.match(/^[xX][0-9a-fA-F]+/)||e.match(/^0[0-7]+/):e.match(/^[0-9]*\.?[0-9]*([eE][\-+]?[0-9]+)?/),"number";if(t=="/"||t=="("){if(e.eat("*"))return n.tokenize=m,m(e,n);if(e.eat("/"))return e.skipToEnd(),"comment"}if(b.test(t))return e.eatWhile(b),"operator";e.eatWhile(/[\w\$_\xa1-\uffff]/);var r=e.current().toLowerCase();return y.propertyIsEnumerable(r)||p.propertyIsEnumerable(r)||l.propertyIsEnumerable(r)?"keyword":s.propertyIsEnumerable(r)?"atom":"variable"}function m(e,n){for(var t=!1,r;r=e.next();){if((r=="/"||r==")")&&t){n.tokenize=a;break}t=r=="*"}return"comment"}function x(e,n,t,r,c){this.indented=e,this.column=n,this.type=t,this.align=r,this.prev=c}function h(e,n,t){return e.context=new x(e.indented,n,t,null,e.context)}function k(e){if(!!e.context.prev){var n=e.context.type;return n=="end_block"&&(e.indented=e.context.indented),e.context=e.context.prev}}return{startState:function(e){return{tokenize:null,context:new x((e||0)-i,0,"top",!1),indented:0,startOfLine:!0}},token:function(e,n){var t=n.context;if(e.sol()&&(t.align==null&&(t.align=!1),n.indented=e.indentation(),n.startOfLine=!0),e.eatSpace())return null;var r=(n.tokenize||a)(e,n);if(r=="comment")return r;t.align==null&&(t.align=!0);var c=e.current().toLowerCase();return p.propertyIsEnumerable(c)?h(n,e.column(),"end_block"):l.propertyIsEnumerable(c)&&k(n),n.startOfLine=!1,r},indent:function(e,n){if(e.tokenize!=a&&e.tokenize!=null)return 0;var t=e.context,r=l.propertyIsEnumerable(n);return t.align?t.column+(r?0:1):t.indented+(r?0:i)},electricChars:"ryk",fold:"brace",blockCommentStart:"(*",blockCommentEnd:"*)",lineComment:"//"}}),u.defineMIME("text/x-fcl","fcl")})})();var z=v.exports,C=g({__proto__:null,default:z},[v.exports]);export{C as f};

package/dist/assets/{fields.2c2cc037.js → fields.47aabeca.js}

@@ -1,4 +1,4 @@
-import{a as t,o,b as h,w as e,g as s,e as i,B as l}from"./runtime-core.esm-bundler.e3d5f5b7.js";const p={class:"markdown-body"},d={class:"two-up"},u={class:"left"},f=l("Fields are individual pieces of content within an item. They are mapped to columns in the database. "),j=l("Learn more about Fields"),g=l("."),m=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-field-object"},"The Field Object ")]),s("li",null,[s("a",{href:"#list-all-fields"},"List All Fields ")]),s("li",null,[s("a",{href:"#list-fields-in-collection"},"List Fields in Collection ")]),s("li",null,[s("a",{href:"#retrieve-a-field"},"Retrieve a Field ")]),s("li",null,[s("a",{href:"#create-a-field"},"Create a Field ")]),s("li",null,[s("a",{href:"#update-a-field"},"Update a Field ")]),s("li",null,[s("a",{href:"#delete-a-field"},"Delete a Field ")])])])])],-1),_=s("hr",null,null,-1),y=s("h2",{id:"the-field-object",tabindex:"-1"},[l("The Field Object "),s("a",{class:"header-anchor",href:"#the-field-object"},"#")],-1),b={class:"two-up"},x={class:"left"},v={class:"definitions"},w=s("p",null,[s("code",null,"collection"),l(),s("strong",null,"string"),s("br"),l(" Name of the collection the field resides in.")],-1),q=s("p",null,[s("code",null,"field"),l(),s("strong",null,"string"),s("br"),l(" The identifier of the field. This matches the table column name.")],-1),T=s("code",null,"type",-1),k=l(),A=s("strong",null,"string",-1),E=s("br",null,null,-1),S=l(" The Directus data type of the field. See "),P=l("Types"),F=l(" for possible options."),R=s("h4",{id:"meta",tabindex:"-1"},[l("Meta "),s("a",{class:"header-anchor",href:"#meta"},"#")],-1),L=s("p",null,"Directus metadata, primarily used in the Admin App. Meta is optional.",-1),C=s("div",{class:"definitions"},[s("p",null,[s("code",null,"id"),l(),s("strong",null,"integer"),s("br"),l(" Primary key of the metadata row in "),s("code",null,"directus_fields"),l(".")]),s("p",null,[s("code",null,"collection"),l(),s("strong",null,"string"),s("br"),l(" The name of the collection this field resides in.")]),s("p",null,[s("code",null,"field"),l(),s("strong",null,"string"),s("br"),l(" Identifier of the field. Matches the column name in the database.")]),s("p",null,[s("code",null,"special"),l(),s("strong",null,"string"),s("br"),l(" Any special transform flags that apply to this field.")]),s("p",null,[s("code",null,"interface"),l(),s("strong",null,"string"),s("br"),l(" The interface used for this field.")]),s("p",null,[s("code",null,"options"),l(),s("strong",null,"object"),s("br"),l(" The interface options configured for this field. The structure is based on the interface used.")]),s("p",null,[s("code",null,"display"),l(),s("strong",null,"string"),s("br"),l(" The display used for this field.")]),s("p",null,[s("code",null,"display_options"),l(),s("strong",null,"string"),s("br"),l(" The configured options for the used display.")]),s("p",null,[s("code",null,"readonly"),l(),s("strong",null,"boolean"),s("br"),l(" If the field is considered readonly in the Admin App.")]),s("p",null,[s("code",null,"hidden"),l(),s("strong",null,"boolean"),s("br"),l(" If the field is hidden from the edit page in the Admin App.")]),s("p",null,[s("code",null,"sort"),l(),s("strong",null,"integer"),s("br"),l(" Where this field is shown on the edit page in the Admin App.")]),s("p",null,[s("code",null,"width"),l(),s("strong",null,"string"),s("br"),l(" How wide the interface is rendered on the edit page in the Admin App. One of "),s("code",null,"half"),l(", "),s("code",null,"half-left"),l(", "),s("code",null,"half-right"),l(", "),s("code",null,"half-space"),l(", "),s("code",null,"full"),l(", "),s("code",null,"fill"),l(".")]),s("p",null,[s("code",null,"translations"),l(),s("strong",null,"array"),s("br"),l(" How this field\u2019s name is displayed in the different languages in the Admin App.")]),s("p",null,[s("code",null,"note"),l(),s("strong",null,"string"),s("br"),l(" Short description displayed in the Admin App.")])],-1),Q=s("h4",{id:"schema",tabindex:"-1"},[l("Schema "),s("a",{class:"header-anchor",href:"#schema"},"#")],-1),I=s("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers. Note: schema is optional. If a field exist in directus_fields, but not in the database, it\u2019s an alias commonly used for relational (o2m) or presentation purposes in the Admin App.",-1),G=s("div",{class:"definitions"},[s("p",null,[s("code",null,"name"),l(),s("strong",null,"string"),s("br"),l(" Identifier of the field. Matches the column name in the database.")]),s("p",null,[s("code",null,"table"),l(),s("strong",null,"string"),s("br"),l(" Name of the table the column resides in.")]),s("p",null,[s("code",null,"data_type"),l(),s("strong",null,"string"),s("br"),l(" The datatype as used in the database. Note: this value is database vendor specific.")]),s("p",null,[s("code",null,"default_value"),l(),s("strong",null,"any"),s("br"),l(" The configured default value for the column.")]),s("p",null,[s("code",null,"max_length"),l(),s("strong",null,"integer"),s("br"),l(" Configured length for varchar-type columns.")]),s("p",null,[s("code",null,"numeric_precision"),l(),s("strong",null,"integer"),s("br"),l(" Precision for integer/float/decimal type fields.")]),s("p",null,[s("code",null,"numeric_scale"),l(),s("strong",null,"integer"),s("br"),l(" Scale for integer/float/decimal type fields.")]),s("p",null,[s("code",null,"is_nullable"),l(),s("strong",null,"boolean"),s("br"),l(" Whether or not the column is nullable. This is what is used as the \u201Crequired\u201D state in Directus.")]),s("p",null,[s("code",null,"is_primary_key"),l(),s("strong",null,"boolean"),s("br"),l(" Whether or not the field is the primary key of the table.")]),s("p",null,[s("code",null,"foreign_key_column"),l(),s("strong",null,"string"),s("br"),l(" If the current column has a foreign key constraint, this points to the related column.")]),s("p",null,[s("code",null,"foreign_key_table"),l(),s("strong",null,"string"),s("br"),l(" If the current column has a foreign key constraint, this points to the related table.")]),s("p",null,[s("code",null,"comment"),l(),s("strong",null,"string"),s("br"),l(" Comment as stored in the database.")])],-1),O=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),l(`
+import{a as t,o,b as h,w as e,g as s,e as i,B as l}from"./runtime-core.esm-bundler.e3d5f5b7.js";const p={class:"markdown-body"},d={class:"two-up"},u={class:"left"},f=l("Fields are individual pieces of content within an item. They are mapped to columns in the database. "),j=l("Learn more about Fields"),g=l("."),m=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-field-object"}," The Field Object")]),s("li",null,[s("a",{href:"#list-all-fields"}," List All Fields")]),s("li",null,[s("a",{href:"#list-fields-in-collection"}," List Fields in Collection")]),s("li",null,[s("a",{href:"#retrieve-a-field"}," Retrieve a Field")]),s("li",null,[s("a",{href:"#create-a-field"}," Create a Field")]),s("li",null,[s("a",{href:"#update-a-field"}," Update a Field")]),s("li",null,[s("a",{href:"#delete-a-field"}," Delete a Field")])])])])],-1),_=s("hr",null,null,-1),y=s("h2",{id:"the-field-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-field-object"},"#"),l(" The Field Object")],-1),b={class:"two-up"},x={class:"left"},v={class:"definitions"},w=s("p",null,[s("code",null,"collection"),l(),s("strong",null,"string"),s("br"),l(" Name of the collection the field resides in.")],-1),q=s("p",null,[s("code",null,"field"),l(),s("strong",null,"string"),s("br"),l(" The identifier of the field. This matches the table column name.")],-1),T=s("code",null,"type",-1),k=l(),A=s("strong",null,"string",-1),E=s("br",null,null,-1),S=l(" The Directus data type of the field. See "),P=l("Types"),F=l(" for possible options."),R=s("h4",{id:"meta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#meta"},"#"),l(" Meta")],-1),L=s("p",null,"Directus metadata, primarily used in the Admin App. Meta is optional.",-1),C=s("div",{class:"definitions"},[s("p",null,[s("code",null,"id"),l(),s("strong",null,"integer"),s("br"),l(" Primary key of the metadata row in "),s("code",null,"directus_fields"),l(".")]),s("p",null,[s("code",null,"collection"),l(),s("strong",null,"string"),s("br"),l(" The name of the collection this field resides in.")]),s("p",null,[s("code",null,"field"),l(),s("strong",null,"string"),s("br"),l(" Identifier of the field. Matches the column name in the database.")]),s("p",null,[s("code",null,"special"),l(),s("strong",null,"string"),s("br"),l(" Any special transform flags that apply to this field.")]),s("p",null,[s("code",null,"interface"),l(),s("strong",null,"string"),s("br"),l(" The interface used for this field.")]),s("p",null,[s("code",null,"options"),l(),s("strong",null,"object"),s("br"),l(" The interface options configured for this field. The structure is based on the interface used.")]),s("p",null,[s("code",null,"display"),l(),s("strong",null,"string"),s("br"),l(" The display used for this field.")]),s("p",null,[s("code",null,"display_options"),l(),s("strong",null,"string"),s("br"),l(" The configured options for the used display.")]),s("p",null,[s("code",null,"readonly"),l(),s("strong",null,"boolean"),s("br"),l(" If the field is considered readonly in the Admin App.")]),s("p",null,[s("code",null,"hidden"),l(),s("strong",null,"boolean"),s("br"),l(" If the field is hidden from the edit page in the Admin App.")]),s("p",null,[s("code",null,"sort"),l(),s("strong",null,"integer"),s("br"),l(" Where this field is shown on the edit page in the Admin App.")]),s("p",null,[s("code",null,"width"),l(),s("strong",null,"string"),s("br"),l(" How wide the interface is rendered on the edit page in the Admin App. One of "),s("code",null,"half"),l(", "),s("code",null,"half-left"),l(", "),s("code",null,"half-right"),l(", "),s("code",null,"half-space"),l(", "),s("code",null,"full"),l(", "),s("code",null,"fill"),l(".")]),s("p",null,[s("code",null,"translations"),l(),s("strong",null,"array"),s("br"),l(" How this field\u2019s name is displayed in the different languages in the Admin App.")]),s("p",null,[s("code",null,"note"),l(),s("strong",null,"string"),s("br"),l(" Short description displayed in the Admin App.")])],-1),Q=s("h4",{id:"schema",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#schema"},"#"),l(" Schema")],-1),I=s("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers. Note: schema is optional. If a field exist in directus_fields, but not in the database, it\u2019s an alias commonly used for relational (o2m) or presentation purposes in the Admin App.",-1),G=s("div",{class:"definitions"},[s("p",null,[s("code",null,"name"),l(),s("strong",null,"string"),s("br"),l(" Identifier of the field. Matches the column name in the database.")]),s("p",null,[s("code",null,"table"),l(),s("strong",null,"string"),s("br"),l(" Name of the table the column resides in.")]),s("p",null,[s("code",null,"data_type"),l(),s("strong",null,"string"),s("br"),l(" The datatype as used in the database. Note: this value is database vendor specific.")]),s("p",null,[s("code",null,"default_value"),l(),s("strong",null,"any"),s("br"),l(" The configured default value for the column.")]),s("p",null,[s("code",null,"max_length"),l(),s("strong",null,"integer"),s("br"),l(" Configured length for varchar-type columns.")]),s("p",null,[s("code",null,"numeric_precision"),l(),s("strong",null,"integer"),s("br"),l(" Precision for integer/float/decimal type fields.")]),s("p",null,[s("code",null,"numeric_scale"),l(),s("strong",null,"integer"),s("br"),l(" Scale for integer/float/decimal type fields.")]),s("p",null,[s("code",null,"is_nullable"),l(),s("strong",null,"boolean"),s("br"),l(" Whether or not the column is nullable. This is what is used as the \u201Crequired\u201D state in Directus.")]),s("p",null,[s("code",null,"is_primary_key"),l(),s("strong",null,"boolean"),s("br"),l(" Whether or not the field is the primary key of the table.")]),s("p",null,[s("code",null,"foreign_key_column"),l(),s("strong",null,"string"),s("br"),l(" If the current column has a foreign key constraint, this points to the related column.")]),s("p",null,[s("code",null,"foreign_key_table"),l(),s("strong",null,"string"),s("br"),l(" If the current column has a foreign key constraint, this points to the related table.")]),s("p",null,[s("code",null,"comment"),l(),s("strong",null,"string"),s("br"),l(" Comment as stored in the database.")])],-1),O=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),l(`
 	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),l(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),l(`
 	`),s("span",{class:"hljs-attr"},'"field"'),s("span",{class:"hljs-punctuation"},":"),l(),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),l(`
 	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),l(),s("span",{class:"hljs-string"},'"integer"'),s("span",{class:"hljs-punctuation"},","),l(`
@@ -34,43 +34,43 @@ import{a as t,o,b as h,w as e,g as s,e as i,B as l}from"./runtime-core.esm-bundl
 		`),s("span",{class:"hljs-attr"},'"comment"'),s("span",{class:"hljs-punctuation"},":"),l(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),l(`
 	`),s("span",{class:"hljs-punctuation"},"}"),l(`
 `),s("span",{class:"hljs-punctuation"},"}"),l(`
-`)])])],-1),D=s("hr",null,null,-1),B=s("h2",{id:"list-all-fields",tabindex:"-1"},[l("List All Fields "),s("a",{class:"header-anchor",href:"#list-all-fields"},"#")],-1),H=s("p",null,"List the available fields.",-1),M=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters",tabindex:"-1"},[l("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"returns",tabindex:"-1"},[l("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")]),s("p",null,[l("An array of "),s("a",{href:"#the-field-object"},"field objects"),l(".")])]),s("div",{class:"right"},[s("h3",{id:"rest-api",tabindex:"-1"},[l("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")]),s("pre",null,[s("code",null,`GET /fields
-`)]),s("h3",{id:"graphql",tabindex:"-1"},[l("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)])])],-1),D=s("hr",null,null,-1),B=s("h2",{id:"list-all-fields",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-all-fields"},"#"),l(" List All Fields")],-1),H=s("p",null,"List the available fields.",-1),M=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),l(" Query Parameters")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),l(" Returns")]),s("p",null,[l("An array of "),s("a",{href:"#the-field-object"},"field objects"),l(".")])]),s("div",{class:"right"},[s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),l(" REST API")]),s("pre",null,[s("code",null,`GET /fields
+`)]),s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),l(" GraphQL")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),l(` {
 	fields: [directus_fields]
 }
-`)])]),s("h5",{id:"example",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),l(` {
+`)])]),s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),l(" Example")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),l(` {
 	fields {
 		collection
 		field
 	}
 }
-`)])])])],-1),N=s("hr",null,null,-1),W=s("h2",{id:"list-fields-in-collection",tabindex:"-1"},[l("List Fields in Collection "),s("a",{class:"header-anchor",href:"#list-fields-in-collection"},"#")],-1),U=s("p",null,"List the available fields in a given collection.",-1),V=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-1",tabindex:"-1"},[l("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-1"},"#")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"returns-1",tabindex:"-1"},[l("Returns "),s("a",{class:"header-anchor",href:"#returns-1"},"#")]),s("p",null,[l("An array of "),s("a",{href:"#the-field-object"},"field objects"),l(".")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-1",tabindex:"-1"},[l("REST API "),s("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),s("pre",null,[s("code",null,`GET /fields/:collection
-`)]),s("h5",{id:"example-1",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-1"},"#")]),s("pre",null,[s("code",null,`GET /fields/articles
-`)]),s("h3",{id:"graphql-1",tabindex:"-1"},[l("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-1"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)])])])],-1),N=s("hr",null,null,-1),W=s("h2",{id:"list-fields-in-collection",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-fields-in-collection"},"#"),l(" List Fields in Collection")],-1),U=s("p",null,"List the available fields in a given collection.",-1),V=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),l(" Query Parameters")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),l(" Returns")]),s("p",null,[l("An array of "),s("a",{href:"#the-field-object"},"field objects"),l(".")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),l(" REST API")]),s("pre",null,[s("code",null,`GET /fields/:collection
+`)]),s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),l(" Example")]),s("pre",null,[s("code",null,`GET /fields/articles
+`)]),s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),l(" GraphQL")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),l(` {
 	fields_in_collection(collection:`),s("span",{class:"hljs-type"}," String"),l(`!): directus_fields
 }
-`)])]),s("h5",{id:"example-2",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),l(` {
+`)])]),s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),l(" Example")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),l(` {
 	fields_in_collection(collection: `),s("span",{class:"hljs-string"},'"articles"'),l(`) {
 		collection
 		field
 	}
 }
-`)])])])],-1),z=s("hr",null,null,-1),J=s("h2",{id:"retrieve-a-field",tabindex:"-1"},[l("Retrieve a Field "),s("a",{class:"header-anchor",href:"#retrieve-a-field"},"#")],-1),K=s("p",null,"Get a single field in a given collection.",-1),X=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-2",tabindex:"-1"},[l("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"returns-2",tabindex:"-1"},[l("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")]),s("p",null,[l("A "),s("a",{href:"#the-field-object"},"field object"),l(".")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-2",tabindex:"-1"},[l("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`GET /fields/:collection/:field
-`)]),s("h5",{id:"example-3",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",null,`GET /fields/articles/title
-`)]),s("h3",{id:"graphql-2",tabindex:"-1"},[l("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)])])])],-1),z=s("hr",null,null,-1),J=s("h2",{id:"retrieve-a-field",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-field"},"#"),l(" Retrieve a Field")],-1),K=s("p",null,"Get a single field in a given collection.",-1),X=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),l(" Query Parameters")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),l(" Returns")]),s("p",null,[l("A "),s("a",{href:"#the-field-object"},"field object"),l(".")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),l(" REST API")]),s("pre",null,[s("code",null,`GET /fields/:collection/:field
+`)]),s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),l(" Example")]),s("pre",null,[s("code",null,`GET /fields/articles/title
+`)]),s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),l(" GraphQL")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),l(` {
 	fields_by_name(collection:`),s("span",{class:"hljs-type"}," String"),l("!, field:"),s("span",{class:"hljs-type"}," String"),l(`!): directus_fields
 }
-`)])]),s("h5",{id:"example-4",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),l(` {
+`)])]),s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),l(" Example")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),l(` {
 	fields_by_name(collection: `),s("span",{class:"hljs-string"},'"articles"'),l(", field: "),s("span",{class:"hljs-string"},'"title"'),l(`) {
 		collection
 		field
 	}
 }
-`)])])])],-1),Y=s("hr",null,null,-1),Z=s("h2",{id:"create-a-field",tabindex:"-1"},[l("Create a Field "),s("a",{class:"header-anchor",href:"#create-a-field"},"#")],-1),$=s("p",null,"Create a new field in the given collection.",-1),ss=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-3",tabindex:"-1"},[l("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"request-body",tabindex:"-1"},[l("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"field"),l(),s("strong",null,"Required"),s("br"),l(" Field key, also used as the column name.")]),s("p",null,[s("code",null,"type"),l(),s("strong",null,"Required"),s("br"),l(" One of the Directus types. This in turn controls what datatype is used for the column in the database. Setting the type to "),s("code",null,"alias"),l(" prevents a column from being created in the database.")]),s("p",null,[s("code",null,"meta"),s("br"),l(" Any of the optional meta values in the "),s("a",{href:"#the-field-object"},"field object"),l(".")]),s("p",null,[s("code",null,"schema"),s("br"),l(" Any of the optional schema values in the "),s("a",{href:"#the-field-object"},"field object"),l(".")])]),s("h3",{id:"returns-3",tabindex:"-1"},[l("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")]),s("p",null,[l("The "),s("a",{href:"#the-field-object"},"field object"),l(" for the created field.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-3",tabindex:"-1"},[l("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`POST /fields/:collection
-`)]),s("h5",{id:"example-5",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /fields/articles"),l(`
+`)])])])],-1),Y=s("hr",null,null,-1),Z=s("h2",{id:"create-a-field",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-field"},"#"),l(" Create a Field")],-1),$=s("p",null,"Create a new field in the given collection.",-1),ss=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),l(" Query Parameters")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),l(" Request Body")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"field"),l(),s("strong",null,"Required"),s("br"),l(" Field key, also used as the column name.")]),s("p",null,[s("code",null,"type"),l(),s("strong",null,"Required"),s("br"),l(" One of the Directus types. This in turn controls what datatype is used for the column in the database. Setting the type to "),s("code",null,"alias"),l(" prevents a column from being created in the database.")]),s("p",null,[s("code",null,"meta"),s("br"),l(" Any of the optional meta values in the "),s("a",{href:"#the-field-object"},"field object"),l(".")]),s("p",null,[s("code",null,"schema"),s("br"),l(" Any of the optional schema values in the "),s("a",{href:"#the-field-object"},"field object"),l(".")])]),s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),l(" Returns")]),s("p",null,[l("The "),s("a",{href:"#the-field-object"},"field object"),l(" for the created field.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),l(" REST API")]),s("pre",null,[s("code",null,`POST /fields/:collection
+`)]),s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),l(" Example")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /fields/articles"),l(`
 
 `),s("span",{class:"hljs-punctuation"},"{"),l(`
 	`),s("span",{class:"hljs-attr"},'"field"'),s("span",{class:"hljs-punctuation"},":"),l(),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},","),l(`
@@ -82,11 +82,11 @@ import{a as t,o,b as h,w as e,g as s,e as i,B as l}from"./runtime-core.esm-bundl
 		`),s("span",{class:"hljs-attr"},'"default_value"'),s("span",{class:"hljs-punctuation"},":"),l(),s("span",{class:"hljs-string"},'"Hello World"'),l(`
 	`),s("span",{class:"hljs-punctuation"},"}"),l(`
 `),s("span",{class:"hljs-punctuation"},"}"),l(`
-`)])]),s("h3",{id:"graphql-3",tabindex:"-1"},[l("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)])]),s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),l(" GraphQL")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),l(` {
 	create_fields_item(collection:`),s("span",{class:"hljs-type"}," String"),l(`!, data: create_directus_fields_input!): directus_fields
 }
-`)])]),s("h5",{id:"example-6",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),l(` {
+`)])]),s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),l(" Example")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),l(` {
 	create_fields_item(
 		collection: `),s("span",{class:"hljs-string"},'"articles"'),l(`
 		data: { field: `),s("span",{class:"hljs-string"},'"title"'),l(", "),s("span",{class:"hljs-keyword"},"type"),l(": "),s("span",{class:"hljs-string"},'"string"'),l(", meta: { icon: "),s("span",{class:"hljs-string"},'"title"'),l(" }, "),s("span",{class:"hljs-keyword"},"schema"),l(": { default_value: "),s("span",{class:"hljs-string"},'"Hello World"'),l(` } }
@@ -95,8 +95,8 @@ import{a as t,o,b as h,w as e,g as s,e as i,B as l}from"./runtime-core.esm-bundl
 		field
 	}
 }
-`)])])])],-1),ls=s("hr",null,null,-1),es=s("h2",{id:"update-a-field",tabindex:"-1"},[l("Update a Field "),s("a",{class:"header-anchor",href:"#update-a-field"},"#")],-1),as=s("p",null,"Updates the given field in the given collection.",-1),ns=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-4",tabindex:"-1"},[l("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"request-body-1",tabindex:"-1"},[l("Request Body "),s("a",{class:"header-anchor",href:"#request-body-1"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"type"),s("br"),l(" The new type for the field.")]),s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"Changing Type"),s("p",null,"Types may not be compatible, and/or data might be truncated / corrupted. Please be careful when changing types of an existing field with content.")]),s("p",null,[s("code",null,"meta"),s("br"),l(" Any of the optional meta values in the "),s("a",{href:"#the-field-object"},"field object"),l(".")]),s("p",null,[s("code",null,"schema"),s("br"),l(" Any of the optional schema values in the "),s("a",{href:"#the-field-object"},"field object"),l(".")])]),s("p",null,"Updating the field name is not supported at this time."),s("h3",{id:"returns-4",tabindex:"-1"},[l("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")]),s("p",null,[l("The "),s("a",{href:"#the-field-object"},"field object"),l(" for the updated field.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-4",tabindex:"-1"},[l("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`PATCH /fields/:collection/:field
-`)]),s("h5",{id:"example-7",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /fields/articles/title"),l(`
+`)])])])],-1),ls=s("hr",null,null,-1),es=s("h2",{id:"update-a-field",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-field"},"#"),l(" Update a Field")],-1),as=s("p",null,"Updates the given field in the given collection.",-1),ns=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),l(" Query Parameters")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),l(" Request Body")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"type"),s("br"),l(" The new type for the field.")]),s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"Changing Type"),s("p",null,"Types may not be compatible, and/or data might be truncated / corrupted. Please be careful when changing types of an existing field with content.")]),s("p",null,[s("code",null,"meta"),s("br"),l(" Any of the optional meta values in the "),s("a",{href:"#the-field-object"},"field object"),l(".")]),s("p",null,[s("code",null,"schema"),s("br"),l(" Any of the optional schema values in the "),s("a",{href:"#the-field-object"},"field object"),l(".")])]),s("p",null,"Updating the field name is not supported at this time."),s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),l(" Returns")]),s("p",null,[l("The "),s("a",{href:"#the-field-object"},"field object"),l(" for the updated field.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),l(" REST API")]),s("pre",null,[s("code",null,`PATCH /fields/:collection/:field
+`)]),s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),l(" Example")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /fields/articles/title"),l(`
 
 `),s("span",{class:"hljs-punctuation"},"{"),l(`
 	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),l(),s("span",{class:"hljs-punctuation"},"{"),l(`
@@ -106,11 +106,11 @@ import{a as t,o,b as h,w as e,g as s,e as i,B as l}from"./runtime-core.esm-bundl
 		`),s("span",{class:"hljs-attr"},'"default_value"'),s("span",{class:"hljs-punctuation"},":"),l(),s("span",{class:"hljs-string"},'"Hello World!"'),l(`
 	`),s("span",{class:"hljs-punctuation"},"}"),l(`
 `),s("span",{class:"hljs-punctuation"},"}"),l(`
-`)])]),s("h3",{id:"graphql-4",tabindex:"-1"},[l("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)])]),s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),l(" GraphQL")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),l(` {
 	update_fields_item(collection:`),s("span",{class:"hljs-type"}," String"),l("!, field:"),s("span",{class:"hljs-type"}," String"),l(`!, data: update_directus_fields_input!): directus_fields
 }
-`)])]),s("h5",{id:"example-8",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),l(` {
+`)])]),s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),l(" Example")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),l(` {
 	update_fields_item(
 		collection: `),s("span",{class:"hljs-string"},'"articles"'),l(`
 		field: `),s("span",{class:"hljs-string"},'"title"'),l(`
@@ -120,13 +120,13 @@ import{a as t,o,b as h,w as e,g as s,e as i,B as l}from"./runtime-core.esm-bundl
 		field
 	}
 }
-`)])])])],-1),ts=s("hr",null,null,-1),is=s("h2",{id:"delete-a-field",tabindex:"-1"},[l("Delete a Field "),s("a",{class:"header-anchor",href:"#delete-a-field"},"#")],-1),cs=s("p",null,"Deletes the given field in the given collection.",-1),rs=s("div",{class:"two-up"},[s("div",{class:"left"},[s("div",{class:"danger hint"},[s("div",{class:"hint-title"},"Destructive"),s("p",null,"Be aware, this will delete the column from the database, including all data in it. This action can\u2019t be undone.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-5",tabindex:"-1"},[l("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`DELETE /fields/:collection/:field
-`)]),s("h5",{id:"example-9",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),s("pre",null,[s("code",null,`DELETE /fields/articles/title
-`)]),s("h3",{id:"graphql-5",tabindex:"-1"},[l("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)])])])],-1),ts=s("hr",null,null,-1),is=s("h2",{id:"delete-a-field",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-field"},"#"),l(" Delete a Field")],-1),cs=s("p",null,"Deletes the given field in the given collection.",-1),rs=s("div",{class:"two-up"},[s("div",{class:"left"},[s("div",{class:"danger hint"},[s("div",{class:"hint-title"},"Destructive"),s("p",null,"Be aware, this will delete the column from the database, including all data in it. This action can\u2019t be undone.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),l(" REST API")]),s("pre",null,[s("code",null,`DELETE /fields/:collection/:field
+`)]),s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),l(" Example")]),s("pre",null,[s("code",null,`DELETE /fields/articles/title
+`)]),s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),l(" GraphQL")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),l(` {
 	delete_fields_item(collection:`),s("span",{class:"hljs-type"}," String"),l("!, field:"),s("span",{class:"hljs-type"}," String"),l(`!): delete_field
 }
-`)])]),s("h5",{id:"example-10",tabindex:"-1"},[l("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),l(` {
+`)])]),s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),l(" Example")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),l(` {
 	delete_fields_item(collection: `),s("span",{class:"hljs-string"},'"articles"'),l(", field: "),s("span",{class:"hljs-string"},'"title"'),l(`) {
 		collection
 		field

package/dist/assets/file-library.82e96a16.js

@@ -0,0 +1 @@
+import{a as n,o as d,b as c,w as t,g as e,e as i,B as l}from"./runtime-core.esm-bundler.e3d5f5b7.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The File Library Module aggregates all files within the Directus Project into one consolidated library. It is a full-featured Digital Asset Management (DAM) system for storing, organizing, browsing, and transforming your various files and assets.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-library-20220307A.webp",alt:"File Library"})],-1),f=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#how-it-works"}," How it Works")]),e("li",null,[e("a",{href:"#files"}," Files")]),e("li",null,[e("a",{href:"#edit-an-image"}," Edit an Image")]),e("li",null,[e("a",{href:"#upload-a-file"}," Upload a File")]),e("li",null,[e("a",{href:"#replace-a-file"}," Replace a File")]),e("li",null,[e("a",{href:"#folders"}," Folders")]),e("li",null,[e("a",{href:"#create-a-folder"}," Create a Folder")]),e("li",null,[e("a",{href:"#rename-a-folder"}," Rename a Folder")]),e("li",null,[e("a",{href:"#move-a-folder"}," Move a Folder")]),e("li",null,[e("a",{href:"#delete-a-folder"}," Delete a Folder")]),e("li",null,[e("a",{href:"#more-help"}," More Help")])])])],-1),_={class:"warning hint"},m=e("div",{class:"hint-title"},"More Documents on Folder and File Management",-1),g=l("This is a non-technical, no-code guide to the File Library Module. Please note there is documentation on programmatic "),b=l("Folder"),F=l(" and "),y=l("File"),v=l(" management via the API."),w=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),l(" How it Works")],-1),k={class:"tip hint"},A=e("div",{class:"hint-title"},"Required Knowledge",-1),C=l("Familiarity with the "),D=l("Collections Page"),T=l(" will be helpful but not necessary."),I=l("The File Library acts as one big "),L=e("a",{href:"#folders"},"Folder",-1),P=l(" to store all uploaded "),x=e("a",{href:"#files"},"Files",-1),M=l(". Sub-folders can be created within the File Library to help Files stay organized. Folders and File information are stored in regular Collections, which means "),S=l("User and Role access permissions"),E=l(" are fully configurable and granular on both Folders and Files. Multiple files can be uploaded at once through the app and also programmatically via the API. Any type of file can be uploaded, "),H=e("em",null,"not just images",-1),U=l(". When a Folder is selected from the Navigation Bar, the "),R=e("a",{href:"#folders"},"File Listing Page",-1),B=l(" is presented. This page has all the same features and functionalities as the "),N=l("Collections Page"),W=l("."),j=e("video",{title:"How the File Library Works",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/how-it-works-20220305A.mp4",type:"video/mp4"}),e("p",null,[l(" Your browser is not displaying the video for some reason. Here's a "),e("a",{href:""},"link to the video"),l(" instead. ")])],-1),z=e("ol",null,[e("li",null,[l("Select a Folder. There are two options: "),e("ul",null,[e("li",null,"Choose desired Folder from the Navigation Bar."),e("li",null,[l("Click "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" in the Page Header, name your folder, and click "),e("strong",null,"\u201CSave\u201D"),l(".")])])]),e("li",null,[l("Click "),e("span",{mi:"",btn:""},"add"),l(" in the Page Header. A popover will appear.")]),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])]),e("li",null,"Optional: Click the File Display to open the File Details Page and fill in information as desired.")],-1),O=e("h2",{id:"files",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#files"},"#"),l(" Files")],-1),K=l("When a file is clicked in the File Listing Page, the File Details Page appears. This is a custom form for viewing assets and embeds, with core Fields included out-of-the-box (see below), and the ability for Administrators to add additional custom Fields. This page has the same features and functionality as the "),V=l("Item Page"),Y=l("."),q=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/files-20220305A.webp",alt:"Files"})],-1),J=e("h3",{id:"action-buttons",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#action-buttons"},"#"),l(" Action Buttons")],-1),X=e("p",null,"Notice the following Buttons in the Header:",-1),G=e("ul",null,[e("li",null,[e("span",{mi:"",btn:""},"check"),l(" \u2013 Saves any edits made to the file. ")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"tune"),l(" \u2013 Please see [Edit an Image](#edit-an-image) to learn more. ")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"save_alt"),l(" \u2013 Downloads the file to your current device. ")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"drive_file_move"),l(" \u2013 Moves selected File(s) to another Folder. ")]),e("li",null,[e("span",{mi:"",btn:"",dngr:""},"delete"),l(" \u2013 Permanently removes the File and its metadata. This action is permanent and cannot be undone. ")])],-1),Q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Deleting Files Linked to Items"),e("p",null,[l("By default, Directus will not allow you to delete a File until you remove it from any and all related Items. However, this behavior can be reconfigured so that Files automatically update when the image is deleted by setting the relational constraint of your File Field to "),e("code",null,"SET NULL"),l(" or "),e("code",null,"CASCADE"),l(" when the File is deleted.")])],-1),Z=e("h3",{id:"file-details",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-details"},"#"),l(" File Details")],-1),$=e("p",null,[l("The Files Collection comes pre-configured with the following Fields out of the box. New Fields can be created and customized as needed in "),e("strong",null,"Settings > Data Model"),l(". However the pre-configured Fields cannot be changed or deleted.")],-1),ee=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-details-20220305A.webp",alt:"File Details"})],-1),le=e("ul",null,[e("li",null,[e("strong",null,"Preview"),l(" \u2013 A preview of the image or file.")]),e("li",null,[e("strong",null,"Title"),l(" \u2013 A title for the File.")]),e("li",null,[e("strong",null,"Description"),l(" \u2013 A description of the File.")]),e("li",null,[e("strong",null,"Tags"),l(" \u2013 Keywords used for search-ability.")]),e("li",null,[e("strong",null,"Location"),l(" \u2013 An optional location "),e("em",null,"(e.g. where a photo was taken)"),l(".")]),e("li",null,[e("strong",null,"Storage"),l(" \u2013 Which storage adapter is used to store the file asset.")]),e("li",null,[e("strong",null,"Filename (Disk)"),l(" \u2013 LOCKED. This is the actual name of the file in storage.")]),e("li",null,[e("strong",null,"Filename (Download)"),l(" \u2013 Allows you to set the name of the file when it is downloaded.")])],-1),te=e("h3",{id:"file-sidebar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-sidebar"},"#"),l(" File Sidebar")],-1),oe=e("p",null,"The file sidebar also includes the following details, which are not editable and serve as metadata.",-1),ie=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-sidebar-20220305A.webp",alt:"File Sidebar"})],-1),ae=e("ul",null,[e("li",null,[e("strong",null,"Type"),l(" \u2013 The MIME type of the file, displayed in the App as a formatted media type.")]),e("li",null,[e("strong",null,"Dimensions"),l(" \u2013 "),e("em",null,"Images only"),l(". The width and height of the image in pixels.")]),e("li",null,[e("strong",null,"Size"),l(" \u2013 The file-size the asset takes up in the storage adapter.")]),e("li",null,[e("strong",null,"Created"),l(" \u2013 The timestamp of when the file was uploaded to the Project.")]),e("li",null,[e("strong",null,"Owner"),l(" \u2013 The User that uploaded the file to the Project.")]),e("li",null,[e("strong",null,"Modified"),l(" \u2013 The timestamp of when the file was last modified.")]),e("li",null,[e("strong",null,"Edited By"),l(" \u2013 The User that modified the File.")]),e("li",null,[e("strong",null,"Folder"),l(" \u2013 The current parent folder that contains the File.")]),e("li",null,[e("strong",null,"Metadata"),l(" \u2013 Metadata JSON dump of the File\u2019s EXIF, IPTC, and ICC information.")])],-1),ne=e("h2",{id:"edit-an-image",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#edit-an-image"},"#"),l(" Edit an Image")],-1),se=e("p",null,"Rotate, crop, flip, or adjust aspect ratios of an image.",-1),re=e("video",{alt:"Edit an Image",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220516A/edit-an-image-20220516A.mp4",type:"video/mp4"})],-1),de=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click a file to open its detail page.")]),e("li",null,[l("Click the "),e("span",{mi:"",btn:"",sec:""},"tune"),l(" button in the top right to open the image editor.")]),e("li",null,[l("Make your changes and click "),e("span",{mi:"",btn:""},"check"),l(" in the top right to save the updates.")])],-1),ce=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"Edits overwrite the original file on disk. This can\u2019t be reversed.")],-1),he=e("h2",{id:"upload-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#upload-a-file"},"#"),l(" Upload a File")],-1),ue=l("We covered the File Library\u2019s three upload methods in "),pe=e("a",{href:"#how-it-works"},"How it Works",-1),fe=l(". Keep in mind that files can also be added through different Interfaces as well. For example, Users can upload an Avatar image when they fill in their User Details. Similarly, Items with an Image Field will have a file upload Interface on the Item Detail page. Files can also be "),_e=l("uploaded programmatically via the API"),me=l("."),ge=e("h2",{id:"replace-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#replace-a-file"},"#"),l(" Replace a File")],-1),be=e("p",null,"When a file is replaced, its existing info and all relationships are kept.",-1),Fe=e("video",{alt:"Replace a File",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220608A/replace-a-file-20220608A.mp4",type:"video/mp4"})],-1),ye=e("ol",null,[e("li",null,"Click the Image Preview on the File Detail page. A popup will appear."),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])])],-1),ve=e("h2",{id:"folders",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#folders"},"#"),l(" Folders")],-1),we=e("p",null,"Folders provide the organization system for Files.",-1),ke=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/folders-20220305A.webp",alt:"Folders"})],-1),Ae=l("They can be named, renamed, and nested as sub-folders anywhere in the Folder hierarchy. Once a Folder is selected from the Navigation Bar, File Listing Page opens. The File Listing Page displays all Files within a Folder. It also enables all other features and functionalities from the "),Ce=l("Collections Page"),De=l(" such as batch editing, batch deleting, sorting, filtering, searching, etc. Folders can also be managed "),Te=l("programmatically via the API"),Ie=l("."),Le=e("h2",{id:"create-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-folder"},"#"),l(" Create a Folder")],-1),Pe=e("video",{alt:"Create a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/create-a-folder-20220305A.mp4",type:"video/mp4"})],-1),xe=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click on the "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" button located in the Header.")]),e("li",null,"Fill in a Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),Me=e("h2",{id:"rename-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rename-a-folder"},"#"),l(" Rename a Folder")],-1),Se=e("video",{alt:"Renaming a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/rename-a-folder-20220215A.mp4",type:"video/mp4"})],-1),Ee=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to rename and select \u201CRename Folder\u201D.")]),e("li",null,"Update the Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),He=e("h2",{id:"move-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#move-a-folder"},"#"),l(" Move a Folder")],-1),Ue=e("video",{alt:"Moving a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/move-a-folder20220305A.mp4",type:"video/mp4"})],-1),Re=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the folder you wish to move and select "),e("strong",null,"\u201CMove to Folder\u201D"),l(". A popup will appear.")]),e("li",null,"Select a Folder to serve as the new Parent Folder."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),Be=e("h2",{id:"delete-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-a-folder"},"#"),l(" Delete a Folder")],-1),Ne=e("video",{alt:"Deleting a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/delete-a-folder-20220215A.mp4",type:"video/mp4"})],-1),We=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to delete and select "),e("strong",null,"\u201CDelete Folder\u201D"),l(".")]),e("li",null,[l("Click "),e("strong",null,"\u201CDelete\u201D"),l(".")])],-1),je=e("div",{class:"tip hint"},[e("p",null,"When you delete a Folder, any nested Files and Folders will be moved one level up.")],-1),ze=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),l(" More Help")],-1),Oe=e("p",null,[l("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),Je="File Library",Xe=!1,Ge={name:"file-library",setup(Ke,{expose:s}){const a={title:"File Library",modularExtension:!1};return s({frontmatter:a}),(Ve,Ye)=>{const o=n("router-link"),r=n("docs-wrapper");return d(),c(r,{frontmatter:a},{default:t(()=>[e("div",h,[u,p,f,e("div",_,[m,e("p",null,[g,i(o,{to:"/docs/reference/system/folders/"},{default:t(()=>[b]),_:1}),F,i(o,{to:"/docs/reference/files/"},{default:t(()=>[y]),_:1}),v])]),w,e("div",k,[A,e("p",null,[C,i(o,{to:"/docs/app/content-collections/"},{default:t(()=>[D]),_:1}),T])]),e("p",null,[I,L,P,x,M,i(o,{to:"/docs/configuration/users-roles-permissions.md"},{default:t(()=>[S]),_:1}),E,H,U,R,B,i(o,{to:"/docs/app/content-collections/"},{default:t(()=>[N]),_:1}),W]),j,z,O,e("p",null,[K,i(o,{to:"/docs/getting-started/glossary/#items"},{default:t(()=>[V]),_:1}),Y]),q,J,X,G,Q,Z,$,ee,le,te,oe,ie,ae,ne,se,re,de,ce,he,e("p",null,[ue,pe,fe,i(o,{to:"/docs/reference/files/"},{default:t(()=>[_e]),_:1}),me]),ge,be,Fe,ye,ve,we,ke,e("p",null,[Ae,i(o,{to:"/docs/app/content-collections/"},{default:t(()=>[Ce]),_:1}),De,i(o,{to:"/docs/docs/reference/system/folders.md"},{default:t(()=>[Te]),_:1}),Ie]),Le,Pe,xe,Me,Se,Ee,He,Ue,Re,Be,Ne,We,je,ze,Oe])]),_:1})}}};export{Ge as default,Xe as modularExtension,Je as title};