@directus/app 9.22.1 → 9.22.3

package/dist/assets/ar-ly-3d3901d5.js

@@ -0,0 +1 @@
+var e={code:"ar-ly",week:{dow:6,doy:12},direction:"rtl",buttonText:{prev:"السابق",next:"التالي",today:"اليوم",month:"شهر",week:"أسبوع",day:"يوم",list:"أجندة"},weekText:"أسبوع",allDayText:"اليوم كله",moreLinkText:"أخرى",noEventsText:"أي أحداث لعرض"};export{e as default};

package/dist/assets/ar-ma-24c7c037.js

@@ -0,0 +1 @@
+var e={code:"ar-ma",week:{dow:6,doy:12},direction:"rtl",buttonText:{prev:"السابق",next:"التالي",today:"اليوم",month:"شهر",week:"أسبوع",day:"يوم",list:"أجندة"},weekText:"أسبوع",allDayText:"اليوم كله",moreLinkText:"أخرى",noEventsText:"أي أحداث لعرض"};export{e as default};

package/dist/assets/ar-sa-fc93a307.js

@@ -0,0 +1 @@
+var e={code:"ar-sa",week:{dow:0,doy:6},direction:"rtl",buttonText:{prev:"السابق",next:"التالي",today:"اليوم",month:"شهر",week:"أسبوع",day:"يوم",list:"أجندة"},weekText:"أسبوع",allDayText:"اليوم كله",moreLinkText:"أخرى",noEventsText:"أي أحداث لعرض"};export{e as default};

package/dist/assets/ar-tn-e5d6130c.js

@@ -0,0 +1 @@
+var e={code:"ar-tn",week:{dow:1,doy:4},direction:"rtl",buttonText:{prev:"السابق",next:"التالي",today:"اليوم",month:"شهر",week:"أسبوع",day:"يوم",list:"أجندة"},weekText:"أسبوع",allDayText:"اليوم كله",moreLinkText:"أخرى",noEventsText:"أي أحداث لعرض"};export{e as default};

package/dist/assets/architecture-b6b25b37.js

@@ -0,0 +1 @@
+import{a as o,o as n,e as i,y as c,u as e,q as t}from"./runtime-core.esm-bundler-753bcc58.js";const l=e("div",{class:"markdown-body"},[e("p",null,[e("strong",null,"Directus is a wrapper for both your database and file asset storage system.")]),e("p",null,"At first glance, it may be tempting to think of Directus as an app-centric platform. But that’s not the case. The app is just a GUI powered by the API, which allows developers, business users, and data analysts equal access to data and asset storage, all in one place."),e("p",null,"Here’s how the platform architecture breaks down."),e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/getting-started/architecture/architecture-20220512/directus-architecture-20220512A.webp",alt:"Directus Architecture Graphic"})]),e("p",null,[t("Directus is plug-and-play. Once linked, it does’t "),e("em",null,"own"),t(" your data or file assets, but it does create about 10-20 data tables needed for platform operation. These tables do not intermingle with the rest of your data, so you can remove Directus without a trace. You also have the freedom to access the database with raw SQL queries and access your file assets with CLI commands.")]),e("p",null,"At the lowest layer, the platform introspects the database and abstracts away specific SQL details- so no matter what SQL vendor you choose, the platform works seamlessly. Similarly, Directus syncs with your configured file storage service, providing control over your file assets."),e("p",null,[t("The next layer contains logic to access, transmit, query, and transform data, including event triggers, webhooks, data query operations, and file transformations "),e("em",null,"(like image cropping)"),t(". After that, data and assets get cached for efficient user access.")]),e("p",null,"Directus provides secure user access methods. Choose access token format and configure authentication as desired. You can set SSO and allow login through Google, Facebook, etc."),e("p",null,"Finally, a complete set of REST and GraphQL endpoints are generated dynamically, based on your data model as well as your configured roles and their associated access permissions."),e("p",null,[t("The Directus SDK is "),e("a",{href:"https://www.npmjs.com/package/directus",target:"_blank",rel:"noopener noreferrer"},"available via NPM"),t(". You also have access to two Command-Line Interfaces (CLI). One enables server-side actions relating to your on-prem instance, like migrating the database or resetting a user. The other allows you to interact with a Directus instance as you would with an SDK.")]),e("p",null,[t("Directus is 100% open-source, modular, and extensible, ensuring you will never hit a hard feature ceiling within the platform. Built entirely in crispy clean Typescript, mostly on Node.js and Vue.js, you have the power to add or modify "),e("em",null,"any feature"),t(" with your own custom extensions.")])],-1),m="Architecture",f=!1,w="A breakdown of the Directus platform architecture.",y="2 min read",g={__name:"architecture",setup(u,{expose:s}){const a={title:"Architecture",modularExtension:!1,description:"A breakdown of the Directus platform architecture.",readTime:"2 min read"};return s({frontmatter:a}),(d,h)=>{const r=o("docs-wrapper");return n(),i(r,{frontmatter:a},{default:c(()=>[l]),_:1})}}};export{g as default,w as description,f as modularExtension,y as readTime,m as title};

package/dist/assets/asciiarmor-162cc536.js

@@ -0,0 +1 @@
+import{z as c}from"./index.522e44ef.entry.js";function u(i,a){for(var n=0;n<a.length;n++){const t=a[n];if(typeof t!="string"&&!Array.isArray(t)){for(const e in t)if(e!=="default"&&!(e in i)){const r=Object.getOwnPropertyDescriptor(t,e);r&&Object.defineProperty(i,e,r.get?r:{enumerable:!0,get:()=>t[e]})}}}return Object.freeze(Object.defineProperty(i,Symbol.toStringTag,{value:"Module"}))}var p={};(function(i,a){(function(n){n(c)})(function(n){function t(e){var r=e.match(/^\s*\S/);return e.skipToEnd(),r?"error":null}n.defineMode("asciiarmor",function(){return{token:function(e,r){var o;if(r.state=="top")return e.sol()&&(o=e.match(/^-----BEGIN (.*)?-----\s*$/))?(r.state="headers",r.type=o[1],"tag"):t(e);if(r.state=="headers"){if(e.sol()&&e.match(/^\w+:/))return r.state="header","atom";var f=t(e);return f&&(r.state="body"),f}else{if(r.state=="header")return e.skipToEnd(),r.state="headers","string";if(r.state=="body")return e.sol()&&(o=e.match(/^-----END (.*)?-----\s*$/))?o[1]!=r.type?"error":(r.state="end","tag"):e.eatWhile(/[A-Za-z0-9+\/=]/)?null:(e.next(),"error");if(r.state=="end")return t(e)}},blankLine:function(e){e.state=="headers"&&(e.state="body")},startState:function(){return{state:"top",type:null}}}}),n.defineMIME("application/pgp","asciiarmor"),n.defineMIME("application/pgp-encrypted","asciiarmor"),n.defineMIME("application/pgp-keys","asciiarmor"),n.defineMIME("application/pgp-signature","asciiarmor")})})();const l=u({__proto__:null,default:p},[p]);export{l as a};

package/dist/assets/asn.1-8fb0b7f2.js

@@ -0,0 +1 @@
+import{z as x}from"./index.522e44ef.entry.js";function h(S,f){for(var I=0;I<f.length;I++){const o=f[I];if(typeof o!="string"&&!Array.isArray(o)){for(const u in o)if(u!=="default"&&!(u in S)){const i=Object.getOwnPropertyDescriptor(o,u);i&&Object.defineProperty(S,u,i.get?i:{enumerable:!0,get:()=>o[u]})}}}return Object.freeze(Object.defineProperty(S,Symbol.toStringTag,{value:"Module"}))}var N={};(function(S,f){(function(I){I(x)})(function(I){I.defineMode("asn.1",function(u,i){var a=u.indentUnit,l=i.keywords||{},m=i.cmipVerbs||{},y=i.compareTypes||{},C=i.status||{},R=i.tags||{},g=i.storage||{},D=i.modifier||{},b=i.accessTypes||{},L=i.multiLineStrings,P=i.indentStatements!==!1,A=/[\|\^]/,E;function M(e,n){var t=e.next();if(t=='"'||t=="'")return n.tokenize=U(t),n.tokenize(e,n);if(/[\[\]\(\){}:=,;]/.test(t))return E=t,"punctuation";if(t=="-"&&e.eat("-"))return e.skipToEnd(),"comment";if(/\d/.test(t))return e.eatWhile(/[\w\.]/),"number";if(A.test(t))return e.eatWhile(A),"operator";e.eatWhile(/[\w\-]/);var r=e.current();return l.propertyIsEnumerable(r)?"keyword":m.propertyIsEnumerable(r)?"variable cmipVerbs":y.propertyIsEnumerable(r)?"atom compareTypes":C.propertyIsEnumerable(r)?"comment status":R.propertyIsEnumerable(r)?"variable-3 tags":g.propertyIsEnumerable(r)?"builtin storage":D.propertyIsEnumerable(r)?"string-2 modifier":b.propertyIsEnumerable(r)?"atom accessTypes":"variable"}function U(e){return function(n,t){for(var r=!1,c,O=!1;(c=n.next())!=null;){if(c==e&&!r){var T=n.peek();T&&(T=T.toLowerCase(),(T=="b"||T=="h"||T=="o")&&n.next()),O=!0;break}r=!r&&c=="\\"}return(O||!(r||L))&&(t.tokenize=null),"string"}}function d(e,n,t,r,c){this.indented=e,this.column=n,this.type=t,this.align=r,this.prev=c}function p(e,n,t){var r=e.indented;return e.context&&e.context.type=="statement"&&(r=e.context.indented),e.context=new d(r,n,t,null,e.context)}function s(e){var n=e.context.type;return(n==")"||n=="]"||n=="}")&&(e.indented=e.context.indented),e.context=e.context.prev}return{startState:function(e){return{tokenize:null,context:new d((e||0)-a,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;E=null;var r=(n.tokenize||M)(e,n);if(r=="comment")return r;if(t.align==null&&(t.align=!0),(E==";"||E==":"||E==",")&&t.type=="statement")s(n);else if(E=="{")p(n,e.column(),"}");else if(E=="[")p(n,e.column(),"]");else if(E=="(")p(n,e.column(),")");else if(E=="}"){for(;t.type=="statement";)t=s(n);for(t.type=="}"&&(t=s(n));t.type=="statement";)t=s(n)}else E==t.type?s(n):P&&((t.type=="}"||t.type=="top")&&E!=";"||t.type=="statement"&&E=="newstatement")&&p(n,e.column(),"statement");return n.startOfLine=!1,r},electricChars:"{}",lineComment:"--",fold:"brace"}});function o(u){for(var i={},a=u.split(" "),l=0;l<a.length;++l)i[a[l]]=!0;return i}I.defineMIME("text/x-ttcn-asn",{name:"asn.1",keywords:o("DEFINITIONS OBJECTS IF DERIVED INFORMATION ACTION REPLY ANY NAMED CHARACTERIZED BEHAVIOUR REGISTERED WITH AS IDENTIFIED CONSTRAINED BY PRESENT BEGIN IMPORTS FROM UNITS SYNTAX MIN-ACCESS MAX-ACCESS MINACCESS MAXACCESS REVISION STATUS DESCRIPTION SEQUENCE SET COMPONENTS OF CHOICE DistinguishedName ENUMERATED SIZE MODULE END INDEX AUGMENTS EXTENSIBILITY IMPLIED EXPORTS"),cmipVerbs:o("ACTIONS ADD GET NOTIFICATIONS REPLACE REMOVE"),compareTypes:o("OPTIONAL DEFAULT MANAGED MODULE-TYPE MODULE_IDENTITY MODULE-COMPLIANCE OBJECT-TYPE OBJECT-IDENTITY OBJECT-COMPLIANCE MODE CONFIRMED CONDITIONAL SUBORDINATE SUPERIOR CLASS TRUE FALSE NULL TEXTUAL-CONVENTION"),status:o("current deprecated mandatory obsolete"),tags:o("APPLICATION AUTOMATIC EXPLICIT IMPLICIT PRIVATE TAGS UNIVERSAL"),storage:o("BOOLEAN INTEGER OBJECT IDENTIFIER BIT OCTET STRING UTCTime InterfaceIndex IANAifType CMIP-Attribute REAL PACKAGE PACKAGES IpAddress PhysAddress NetworkAddress BITS BMPString TimeStamp TimeTicks TruthValue RowStatus DisplayString GeneralString GraphicString IA5String NumericString PrintableString SnmpAdminString TeletexString UTF8String VideotexString VisibleString StringStore ISO646String T61String UniversalString Unsigned32 Integer32 Gauge Gauge32 Counter Counter32 Counter64"),modifier:o("ATTRIBUTE ATTRIBUTES MANDATORY-GROUP MANDATORY-GROUPS GROUP GROUPS ELEMENTS EQUALITY ORDERING SUBSTRINGS DEFINED"),accessTypes:o("not-accessible accessible-for-notify read-only read-create read-write"),multiLineStrings:!0})})})();const G=h({__proto__:null,default:N},[N]);export{G as a};

package/dist/assets/asterisk-40014f94.js

@@ -0,0 +1 @@
+import{z as m}from"./index.522e44ef.entry.js";function f(l,s){for(var t=0;t<s.length;t++){const r=s[t];if(typeof r!="string"&&!Array.isArray(r)){for(const o in r)if(o!=="default"&&!(o in l)){const c=Object.getOwnPropertyDescriptor(r,o);c&&Object.defineProperty(l,o,c.get?c:{enumerable:!0,get:()=>r[o]})}}}return Object.freeze(Object.defineProperty(l,Symbol.toStringTag,{value:"Module"}))}var u={};(function(l,s){(function(t){t(m)})(function(t){t.defineMode("asterisk",function(){var r=["exten","same","include","ignorepat","switch"],o=["#include","#exec"],c=["addqueuemember","adsiprog","aelsub","agentlogin","agentmonitoroutgoing","agi","alarmreceiver","amd","answer","authenticate","background","backgrounddetect","bridge","busy","callcompletioncancel","callcompletionrequest","celgenuserevent","changemonitor","chanisavail","channelredirect","chanspy","clearhash","confbridge","congestion","continuewhile","controlplayback","dahdiacceptr2call","dahdibarge","dahdiras","dahdiscan","dahdisendcallreroutingfacility","dahdisendkeypadfacility","datetime","dbdel","dbdeltree","deadagi","dial","dictate","directory","disa","dumpchan","eagi","echo","endwhile","exec","execif","execiftime","exitwhile","extenspy","externalivr","festival","flash","followme","forkcdr","getcpeid","gosub","gosubif","goto","gotoif","gotoiftime","hangup","iax2provision","ices","importvar","incomplete","ivrdemo","jabberjoin","jabberleave","jabbersend","jabbersendgroup","jabberstatus","jack","log","macro","macroexclusive","macroexit","macroif","mailboxexists","meetme","meetmeadmin","meetmechanneladmin","meetmecount","milliwatt","minivmaccmess","minivmdelete","minivmgreet","minivmmwi","minivmnotify","minivmrecord","mixmonitor","monitor","morsecode","mp3player","mset","musiconhold","nbscat","nocdr","noop","odbc","odbc","odbcfinish","originate","ospauth","ospfinish","osplookup","ospnext","page","park","parkandannounce","parkedcall","pausemonitor","pausequeuemember","pickup","pickupchan","playback","playtones","privacymanager","proceeding","progress","queue","queuelog","raiseexception","read","readexten","readfile","receivefax","receivefax","receivefax","record","removequeuemember","resetcdr","retrydial","return","ringing","sayalpha","saycountedadj","saycountednoun","saycountpl","saydigits","saynumber","sayphonetic","sayunixtime","senddtmf","sendfax","sendfax","sendfax","sendimage","sendtext","sendurl","set","setamaflags","setcallerpres","setmusiconhold","sipaddheader","sipdtmfmode","sipremoveheader","skel","slastation","slatrunk","sms","softhangup","speechactivategrammar","speechbackground","speechcreate","speechdeactivategrammar","speechdestroy","speechloadgrammar","speechprocessingsound","speechstart","speechunloadgrammar","stackpop","startmusiconhold","stopmixmonitor","stopmonitor","stopmusiconhold","stopplaytones","system","testclient","testserver","transfer","tryexec","trysystem","unpausemonitor","unpausequeuemember","userevent","verbose","vmauthenticate","vmsayname","voicemail","voicemailmain","wait","waitexten","waitfornoise","waitforring","waitforsilence","waitmusiconhold","waituntil","while","zapateller"];function d(e,n){var i="",a=e.next();if(n.blockComment)return a=="-"&&e.match("-;",!0)?n.blockComment=!1:e.skipTo("--;")?(e.next(),e.next(),e.next(),n.blockComment=!1):e.skipToEnd(),"comment";if(a==";")return e.match("--",!0)&&!e.match("-",!1)?(n.blockComment=!0,"comment"):(e.skipToEnd(),"comment");if(a=="[")return e.skipTo("]"),e.eat("]"),"header";if(a=='"')return e.skipTo('"'),"string";if(a=="'")return e.skipTo("'"),"string-2";if(a=="#"&&(e.eatWhile(/\w/),i=e.current(),o.indexOf(i)!==-1))return e.skipToEnd(),"strong";if(a=="$"){var p=e.peek();if(p=="{")return e.skipTo("}"),e.eat("}"),"variable-3"}if(e.eatWhile(/\w/),i=e.current(),r.indexOf(i)!==-1){switch(n.extenStart=!0,i){case"same":n.extenSame=!0;break;case"include":case"switch":case"ignorepat":n.extenInclude=!0;break}return"atom"}}return{startState:function(){return{blockComment:!1,extenStart:!1,extenSame:!1,extenInclude:!1,extenExten:!1,extenPriority:!1,extenApplication:!1}},token:function(e,n){var i="";if(e.eatSpace())return null;if(n.extenStart)return e.eatWhile(/[^\s]/),i=e.current(),/^=>?$/.test(i)?(n.extenExten=!0,n.extenStart=!1,"strong"):(n.extenStart=!1,e.skipToEnd(),"error");if(n.extenExten)return n.extenExten=!1,n.extenPriority=!0,e.eatWhile(/[^,]/),n.extenInclude&&(e.skipToEnd(),n.extenPriority=!1,n.extenInclude=!1),n.extenSame&&(n.extenPriority=!1,n.extenSame=!1,n.extenApplication=!0),"tag";if(n.extenPriority)return n.extenPriority=!1,n.extenApplication=!0,e.next(),n.extenSame?null:(e.eatWhile(/[^,]/),"number");if(n.extenApplication){if(e.eatWhile(/,/),i=e.current(),i===",")return null;if(e.eatWhile(/\w/),i=e.current().toLowerCase(),n.extenApplication=!1,c.indexOf(i)!==-1)return"def strong"}else return d(e,n);return null},blockCommentStart:";--",blockCommentEnd:"--;",lineComment:";"}}),t.defineMIME("text/x-asterisk","asterisk")})})();const g=f({__proto__:null,default:u},[u]);export{g as a};

package/dist/assets/authentication-67696c0d.js

@@ -0,0 +1,74 @@
+import{a as l,o as h,e as i,y as n,u as s,q as e,z as a}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},d=s("hr",null,null,-1),p=s("h2",{id:"access-tokens",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#access-tokens"},"#"),e(" Access Tokens")],-1),_=s("p",null,"There are two types of tokens that can be used to authenticate within Directus.",-1),g=s("p",null,[s("strong",null,"Temporary Token (JWT)"),e(" are returned by the "),s("a",{href:"#login"},"login"),e(" endpoint/mutation. These tokens have a relatively short expiration time, and are thus the most secure option to use. The tokens are returned with a "),s("code",null,"refresh_token"),e(" that can be used to retrieve a new access token via the "),s("a",{href:"#refresh"},"refresh"),e(" endpoint/mutation.")],-1),j=s("p",null,[s("strong",null,"Static Tokens"),e(" can be set for each platform user, and never expire. They are less secure, but quite useful for server-to-server communication. They are saved as plain-text within "),s("code",null,"directus_users.token"),e(".")],-1),f=s("p",null,[e("Once you have your access token, there are two ways to pass it to the API, via the "),s("code",null,"access_token"),e(" query parameter, or in the request’s Authorization Header.")],-1),b=s("h3",{id:"query-parameter",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameter"},"#"),e(" Query Parameter")],-1),m=s("pre",null,[s("code",null,`?access_token=<token>
+`)],-1),k=s("h3",{id:"authorization-header",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#authorization-header"},"#"),e(" Authorization Header")],-1),y=s("pre",null,[s("code",null,`Authorization: Bearer <token>
+`)],-1),w=s("hr",null,null,-1),q=s("h2",{id:"login",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#login"},"#"),e(" Login")],-1),v=s("p",null,"Retrieve a temporary access token and refresh token.",-1),x=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),e(" Request Body")],-1),T=s("p",null,[s("code",null,"email"),e(),s("strong",null,"Required"),s("br"),e(" Email address of the user you’re retrieving the access token for.")],-1),P=s("p",null,[s("code",null,"password"),e(),s("strong",null,"Required"),s("br"),e(" Password of the user.")],-1),S=s("p",null,[s("code",null,"otp"),s("br"),e(" The user’s one-time-password (if MFA is enabled).")],-1),R=s("p",null,[s("code",null,"mode"),s("br"),e(" Whether to retrieve the refresh token in the JSON response, or in a "),s("code",null,"httpOnly"),e(),s("code",null,"secure"),e(" cookie. One of "),s("code",null,"json"),e(", "),s("code",null,"cookie"),e(". Defaults to "),s("code",null,"json"),e(".")],-1),A=s("h3",{id:"response-attributes",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#response-attributes"},"#"),e(" Response Attributes")],-1),O=s("p",null,[s("code",null,"access_token"),e(),s("strong",null,"string"),s("br"),e(" Temporary access token to be used in follow-up requests.")],-1),E=s("p",null,[s("code",null,"expires"),e(),s("strong",null,"integer"),s("br"),e(" How long before the access token will expire. Value is in milliseconds.")],-1),L=s("p",null,[s("code",null,"refresh_token"),e(),s("strong",null,"string"),s("br"),e(" The token that can be used to retrieve a new access token through "),s("a",{href:"#refresh"},[s("code",null,"/auth/refresh")]),e(". Note: if you used "),s("code",null,"cookie"),e(" as the mode in the request, the refresh token won’t be returned in the JSON.")],-1),I={class:"tip hint"},B=s("div",{class:"hint-title"},"Expiry time",-1),N=s("code",null,"ACCESS_TOKEN_TTL",-1),G=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),e(" REST API")],-1),C=s("pre",null,[s("code",null,`POST /auth/login
+`)],-1),D=s("pre",null,[s("code",null,`POST /auth/login/:provider
+`)],-1),J=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"email"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"admin@example.com"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"password"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"d1r3ct5us"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),W=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),e(" GraphQL")],-1),z=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Q=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+	auth_login`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"email"),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"admin@example.com"'),e(", "),s("span",{class:"hljs-symbol"},"password"),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"d1r3ctu5"'),s("span",{class:"hljs-punctuation"},")"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+		access_token
+		refresh_token
+	`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),H=s("hr",null,null,-1),V=s("h2",{id:"refresh",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#refresh"},"#"),e(" Refresh")],-1),U=s("p",null,"Retrieve a new access token using a refresh token.",-1),K=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),e(" Request Body")],-1),F=s("p",null,[s("code",null,"refresh_token"),s("br"),e(" The refresh token to use. If you have the refresh token in a cookie through "),s("a",{href:"#login"},[s("code",null,"/auth/login")]),e(", you don’t have to submit it here.")],-1),M=s("p",null,[s("code",null,"mode"),s("br"),e(" Whether to retrieve the refresh token in the JSON response, or in a "),s("code",null,"httpOnly"),e(),s("code",null,"secure"),e(" cookie. One of "),s("code",null,"json"),e(", "),s("code",null,"cookie"),e(".")],-1),Y=s("h3",{id:"response-attributes-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#response-attributes-1"},"#"),e(" Response Attributes")],-1),X=s("p",null,[s("code",null,"access_token"),e(),s("strong",null,"string"),s("br"),e(" Temporary access token to be used in follow-up requests.")],-1),Z=s("p",null,[s("code",null,"expires"),e(),s("strong",null,"integer"),s("br"),e(" How long before the access token will expire. Value is in milliseconds.")],-1),$=s("p",null,[s("code",null,"refresh_token"),e(),s("strong",null,"string"),s("br"),e(" The token that can be used to retrieve a new access token through "),s("a",{href:"#refresh"},[s("code",null,"/auth/refresh")]),e(". Note: if you used "),s("code",null,"cookie"),e(" as the mode in the request, the refresh token won’t be returned in the JSON.")],-1),ss=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),e(" REST API")],-1),es=s("pre",null,[s("code",null,`POST /auth/refresh
+`)],-1),ns=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"refresh_token"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"gmPd...8wuB"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"mode"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"json"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),ts=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),e(" GraphQL")],-1),as=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),os=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+	auth_refresh`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"refresh_token"),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"abc...def"'),e(", "),s("span",{class:"hljs-symbol"},"mode"),s("span",{class:"hljs-punctuation"},":"),e(" json"),s("span",{class:"hljs-punctuation"},")"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+		access_token
+		refresh_token
+	`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),ls=s("hr",null,null,-1),rs=s("h2",{id:"logout",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#logout"},"#"),e(" Logout")],-1),cs=s("p",null,"Invalidate the refresh token thus destroying the user’s session.",-1),hs=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),e(" Request Body")],-1),is=s("p",null,[s("code",null,"refresh_token"),s("br"),e(" The refresh token to invalidate. If you have the refresh token in a cookie through "),s("a",{href:"#login"},[s("code",null,"/auth/login")]),e(", you don’t have to submit it here.")],-1),us=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),e(" REST API")],-1),ds=s("pre",null,[s("code",null,`POST /auth/logout
+`)],-1),ps=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"refresh_token"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"gmPd...8wuB"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),_s=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),e(" GraphQL")],-1),gs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),js=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+	auth_logout`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"refresh_token"),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"gmPd...8wuB"'),s("span",{class:"hljs-punctuation"},")"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),fs=s("hr",null,null,-1),bs=s("h2",{id:"request-password-reset",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-password-reset"},"#"),e(" Request Password Reset")],-1),ms=s("p",null,"Request a password reset email to be sent to the given user.",-1),ks=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),e(" Request Body")],-1),ys=s("p",null,[s("code",null,"email"),e(),s("strong",null,"Required"),s("br"),e(" Email address of the user you’re requesting a password reset for.")],-1),ws=s("code",null,"reset_url",-1),qs=s("br",null,null,-1),vs=s("br",null,null,-1),xs=s("strong",null,"Note",-1),Ts=s("code",null,"PASSWORD_RESET_URL_ALLOW_LIST",-1),Ps=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),e(" REST API")],-1),Ss=s("pre",null,[s("code",null,`POST /auth/password/request
+`)],-1),Rs=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"email"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"admin@example.com"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),As=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),e(" GraphQL")],-1),Os=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Es=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+	auth_password_request`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"email"),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"admin@example.com"'),s("span",{class:"hljs-punctuation"},")"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),Ls=s("hr",null,null,-1),Is=s("h2",{id:"reset-a-password",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#reset-a-password"},"#"),e(" Reset a Password")],-1),Bs=s("p",null,"The request a password reset endpoint sends an email with a link to the admin app (or a custom route) which in turn uses this endpoint to allow the user to reset their password.",-1),Ns=s("h3",{id:"request-body-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-4"},"#"),e(" Request Body")],-1),Gs=s("p",null,[s("code",null,"token"),e(),s("strong",null,"Required"),s("br"),e(" Password reset token, as provided in the email sent by the request endpoint.")],-1),Cs=s("p",null,[s("code",null,"password"),e(),s("strong",null,"Required"),s("br"),e(" New password for the user.")],-1),Ds=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),e(" REST API")],-1),Js=s("pre",null,[s("code",null,`POST /auth/password/reset
+`)],-1),Ws=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"token"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"password"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),zs=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),e(" GraphQL")],-1),Qs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Hs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+	auth_password_reset`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"token"),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),e(", "),s("span",{class:"hljs-symbol"},"password"),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"d1r3ctu5"'),s("span",{class:"hljs-punctuation"},")"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),Vs=s("hr",null,null,-1),Us=s("h2",{id:"list-auth-providers",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-auth-providers"},"#"),e(" List Auth Providers")],-1),Ks=s("p",null,"List all the configured auth providers.",-1),Fs={class:"tip hint"},Ms=s("div",{class:"hint-title"},"Configuring auth providers",-1),Ys=s("h3",{id:"response-attributes-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#response-attributes-2"},"#"),e(" Response Attributes")],-1),Xs=s("p",null,[s("code",null,"data"),e(),s("strong",null,"Array"),s("br"),e(" Array of configured auth providers.")],-1),Zs=s("p",null,[s("code",null,"disableDefault"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not the default authentication provider is disabled.")],-1),$s=s("pre",null,[s("code",null,`GET /auth
+`)],-1),se=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),e(`
+		`),s("span",{class:"hljs-punctuation"},"{"),e(`
+			`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"GitHub"'),s("span",{class:"hljs-punctuation"},","),e(`
+			`),s("span",{class:"hljs-attr"},'"driver"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"oauth2"'),s("span",{class:"hljs-punctuation"},","),e(`
+			`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"github"'),e(`
+		`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-punctuation"},"{"),e(`
+			`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Google"'),s("span",{class:"hljs-punctuation"},","),e(`
+			`),s("span",{class:"hljs-attr"},'"driver"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"openid"'),s("span",{class:"hljs-punctuation"},","),e(`
+			`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"google"'),e(`
+		`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-punctuation"},"{"),e(`
+			`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Okta"'),s("span",{class:"hljs-punctuation"},","),e(`
+			`),s("span",{class:"hljs-attr"},'"driver"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"openid"'),e(`
+		`),s("span",{class:"hljs-punctuation"},"}"),e(`
+	`),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"disableDefault"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),ee=s("hr",null,null,-1),ne=s("h2",{id:"login-using-sso-providers",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#login-using-sso-providers"},"#"),e(" Login Using SSO Providers")],-1),te=s("p",null,"Will redirect to the configured SSO provider for the user to login.",-1),ae=s("pre",null,[s("code",null,`GET /auth/login/:provider
+`)],-1),oe=s("hr",null,null,-1),ie="Authentication",ue=!1,de="API documentation on authentication in Directus.",pe="5 min read",_e="page-reference",ge={__name:"authentication",setup(le,{expose:r}){const o={title:"Authentication",modularExtension:!1,description:"API documentation on authentication in Directus.",readTime:"5 min read",pageClass:"page-reference"};return r({frontmatter:o}),(re,ce)=>{const t=l("router-link"),c=l("docs-wrapper");return h(),i(c,{frontmatter:o},{default:n(()=>[s("div",u,[s("blockquote",null,[s("p",null,[e("All data within the platform is private by default. The "),a(t,{to:"/docs/configuration/users-roles-permissions#configure-permissions"},{default:n(()=>[e("public role")]),_:1}),e(" can be configured to expose data without authentication, or you can pass an access token to the API to access private data.")])]),d,p,_,g,j,f,b,m,k,y,w,q,v,x,T,P,S,R,A,O,E,L,s("div",I,[B,s("p",null,[e("The token’s expiration time can be configured through "),a(t,{to:"/docs/self-hosted/config-options#general"},{default:n(()=>[e("the "),N,e(" environment variable")]),_:1}),e(".")])]),G,C,D,J,W,z,Q,H,V,U,K,F,M,Y,X,Z,$,ss,es,ns,ts,as,os,ls,rs,cs,hs,is,us,ds,ps,_s,gs,js,fs,bs,ms,ks,ys,s("p",null,[ws,qs,e(" Provide a custom reset url which the link in the email will lead to. The reset token will be passed as a parameter."),vs,xs,e(": You need to configure the "),a(t,{to:"/docs/self-hosted/config-options#security"},{default:n(()=>[Ts,e(" environment variable")]),_:1}),e(" to enable this feature.")]),Ps,Ss,Rs,As,Os,Es,Ls,Is,Bs,Ns,Gs,Cs,Ds,Js,Ws,zs,Qs,Hs,Vs,Us,Ks,s("div",Fs,[Ms,s("p",null,[e("To learn more about setting up auth providers, see "),a(t,{to:"/docs/self-hosted/config-options#authentication"},{default:n(()=>[e("Configuring auth providers")]),_:1}),e(".")])]),Ys,Xs,Zs,$s,se,ee,ne,te,ae,oe])]),_:1})}}};export{ge as default,de as description,ue as modularExtension,_e as pageClass,pe as readTime,ie as title};

package/dist/assets/autorefresh-26e9b86a.js

@@ -0,0 +1 @@
+import{z as a}from"./index.522e44ef.entry.js";function p(u,n){for(var o=0;o<n.length;o++){const i=n[o];if(typeof i!="string"&&!Array.isArray(i)){for(const r in i)if(r!=="default"&&!(r in u)){const e=Object.getOwnPropertyDescriptor(i,r);e&&Object.defineProperty(u,r,e.get?e:{enumerable:!0,get:()=>i[r]})}}}return Object.freeze(Object.defineProperty(u,Symbol.toStringTag,{value:"Module"}))}var s={};(function(u,n){(function(o){o(a)})(function(o){o.defineOption("autoRefresh",!1,function(e,t){e.state.autoRefresh&&(r(e,e.state.autoRefresh),e.state.autoRefresh=null),t&&e.display.wrapper.offsetHeight==0&&i(e,e.state.autoRefresh={delay:t.delay||250})});function i(e,t){function f(){e.display.wrapper.offsetHeight?(r(e,t),e.display.lastWrapHeight!=e.display.wrapper.clientHeight&&e.refresh()):t.timeout=setTimeout(f,t.delay)}t.timeout=setTimeout(f,t.delay),t.hurry=function(){clearTimeout(t.timeout),t.timeout=setTimeout(f,50)},o.on(window,"mouseup",t.hurry),o.on(window,"keyup",t.hurry)}function r(e,t){clearTimeout(t.timeout),o.off(window,"mouseup",t.hurry),o.off(window,"keyup",t.hurry)}})})();const y=p({__proto__:null,default:s},[s]);export{y as a};

package/dist/assets/az-9c8fa2c1.js

@@ -0,0 +1 @@
+var t={code:"az",week:{dow:1,doy:4},buttonText:{prev:"Əvvəl",next:"Sonra",today:"Bu Gün",month:"Ay",week:"Həftə",day:"Gün",list:"Gündəm"},weekText:"Həftə",allDayText:"Bütün Gün",moreLinkText(e){return"+ daha çox "+e},noEventsText:"Göstərmək üçün hadisə yoxdur"};export{t as default};

package/dist/assets/backing-directus-08c7a0b1.js

@@ -0,0 +1 @@
+import{a,o as u,e as c,y as o,u as e,q as t,z as n}from"./runtime-core.esm-bundler-753bcc58.js";const d={class:"markdown-body"},p=e("blockquote",null,[e("p",null,[t("Directus is both "),e("em",null,"premium"),t(" and "),e("em",null,"free"),t(" — two things that don’t often go together. It takes significant resources to maintain the platform. If you’d like to help keep development active, please consider supporting Directus through one of the methods below.")])],-1),h=e("h2",{id:"brand-advocacy",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#brand-advocacy"},"#"),t(" Brand Advocacy")],-1),m=e("p",null,[e("strong",null,"You can create perfect software, but if no one knows about it, it’s all for naught. Marketing and advertising are expensive. You can help us cut these costs with the following quick options.")],-1),f=e("p",null,[e("strong",null,"GitHub Stars"),e("br"),t(" As an open-source project, stars are a primary metric by which we measure our success. It only takes a few seconds to head to the "),e("a",{href:"https://github.com/directus/directus",target:"_blank",rel:"noopener noreferrer"},"Directus GitHub Repo"),t(" and click the star. With enough activity in a short period of time, we get "),e("em",null,"even more exposure"),t(" on GitHub’s trending page!")],-1),g=e("p",null,[e("strong",null,"Social Posts"),e("br"),t(" Engage with us on social media. Follow us! A quick post mentioning "),e("a",{href:"https://twitter.com/directus",target:"_blank",rel:"noopener noreferrer"},"@directus"),t(" goes a long way! "),e("em",null,"Plus, we re-tweet the team’s favorite shout-outs to our 45K+ followers.")],-1),_=e("strong",null,"Testimonials",-1),b=e("br",null,null,-1),w=e("em",null,"One sentence.",-1),y=e("em",null,"need to hear your testimonial",-1),k=e("a",{href:"https://twitter.com/directus",target:"_blank",rel:"noopener noreferrer"},"Tweet",-1),v=e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord",-1),x=e("p",null,[e("strong",null,"Reviews"),e("br"),t(" The following popular rating platforms allow you to post your rating and testimonial publicly, which automatically gives it more exposure.")],-1),C=e("ul",null,[e("li",null,[e("a",{href:"https://www.g2.com/products/directus/reviews",target:"_blank",rel:"noopener noreferrer"},"G2")]),e("li",null,[e("a",{href:"https://www.capterra.com/p/156619/Directus",target:"_blank",rel:"noopener noreferrer"},"Capterra")]),e("li",null,[e("a",{href:"https://www.trustradius.com/products/directus/reviews",target:"_blank",rel:"noopener noreferrer"},"TrustRadius")]),e("li",null,[e("a",{href:"https://www.producthunt.com/posts/directus-9",target:"_blank",rel:"noopener noreferrer"},"Product Hunt")])],-1),D=e("h2",{id:"community-engagement",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#community-engagement"},"#"),t(" Community Engagement")],-1),T=e("p",null,[e("strong",null,"While the Directus Core Team spearheads development, community engagement is an essential part of the Directus mission. We need your help in order to make Directus all it can be.")],-1),G=e("p",null,[e("strong",null,"GitHub Sponsors"),e("br"),t(" The core team is funded. All monthly donations via "),e("a",{href:"https://github.com/sponsors/directus",target:"_blank",rel:"noopener noreferrer"},"GitHub Sponsors"),t(" form a budget to compensate the top community contributors. Donate to sponsor more "),e("a",{href:"https://github.com/orgs/directus/people",target:"_blank",rel:"noopener noreferrer"},"community developers")],-1),S=e("p",null,[e("strong",null,"Code Pull Requests"),e("br"),t(" Squashing bugs, optimizing the codebase, increasing test coverage, and adding new features, are all extremely valuable. Obviously, you’re making the platform better for yourself as well. "),e("em",null,"That’s a double whammy!"),t(),e("a",{href:"https://github.com/directus",target:"_blank",rel:"noopener noreferrer"},"Go make your PR on GitHub!")],-1),E=e("p",null,[e("strong",null,"Bug Reporting"),e("br"),t(" If you find an issue in Directus, no matter how small, we’d love to hear about it. Proper bug reporting helps our team improve platform stability. "),e("a",{href:"https://github.com/directus/directus/issues/new",target:"_blank",rel:"noopener noreferrer"},"Report a bug on GitHub")],-1),q=e("strong",null,"App Translations",-1),H=e("br",null,null,-1),P=e("a",{href:"https://locales.directus.io",target:"_blank",rel:"noopener noreferrer"},"Crowdin integration",-1),R=e("h2",{id:"financial-support",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#financial-support"},"#"),t(" Financial Support")],-1),W=e("p",null,[e("strong",null,"Talented full-time and part-time staff, infrastructure, and third-party services are just some of our organization’s many expenses. Here are a few support avenues that help us keep the lights on.")],-1),z=e("p",null,[e("strong",null,"Premium Support"),e("br"),e("em",null,"Software engineering is hard!"),t(" Let our Core Team help you better manage your Directus project with a dedicated Premium Support agreement so your devs can focus on your app’s core business logic. "),e("a",{href:"https://directus.io/contact",target:"_blank",rel:"noopener noreferrer"},"Contact the Team"),t(" for more info.")],-1),B=e("strong",null,"Sponsored Work",-1),j=e("br",null,null,-1),A=e("em",null,"and for your project!",-1),I=e("strong",null,"Directus Cloud",-1),N=e("br",null,null,-1),F={class:"tip hint"},O=e("div",{class:"hint-title"},"Ready to try out Cloud?",-1),V=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Enterprise Cloud"),e("p",null,[t("Need total customization, unlimited scalability, and dedicated support? "),e("a",{href:"https://directus.io/contact",target:"_blank",rel:"noopener noreferrer"},"Contact us")])],-1),Q="Backing Directus",J=!1,U="What you can do to support Directus.",X="4 min read",Z={__name:"backing-directus",setup(Y,{expose:i}){const s={title:"Backing Directus",modularExtension:!1,description:"What you can do to support Directus.",readTime:"4 min read"};return i({frontmatter:s}),(L,M)=>{const r=a("router-link"),l=a("docs-wrapper");return u(),c(l,{frontmatter:s},{default:o(()=>[e("div",d,[p,h,m,f,g,e("p",null,[_,b,w,t(" Even that was a sentence and it was only two words! If you’re a fan of Directus, we’d love to hear why with a short endorsement… More importantly, potential new users "),y,t(" to see if the product is right for them! Shoot us an "),n(r,{to:"/docsmailto:info@directus.io"},{default:o(()=>[t("email")]),_:1}),t(", "),k,t(", or "),v,t(" message with your name, title, and company.")]),x,C,D,T,G,S,e("p",null,[t("Not quite a software engineer yet? We have plenty of documentation that can always use some extra attention. Learn more in our "),n(r,{to:"/docs/contributing/introduction"},{default:o(()=>[t("Contributors Guide")]),_:1}),t(".")]),E,e("p",null,[q,H,t(" Every button, element, or other line of text in the app is "),n(r,{to:"/docs/contributing/translations"},{default:o(()=>[t("fully translatable")]),_:1}),t(". These translations make our app an international platform. Our "),P,t(" makes polishing existing translations or creating new ones a breeze.")]),R,W,z,e("p",null,[B,j,n(r,{to:"/docs/getting-started/support#commissioned-features"},{default:o(()=>[t("Commissioned Features")]),_:1}),t(" and "),n(r,{to:"/docs/getting-started/support#expedited-fixes"},{default:o(()=>[t("Expedited Fixes")]),_:1}),t(" are great ways to financially support the development of Directus and improve the codebase for the community "),A]),e("p",null,[I,N,t(" Cloud architecture, software updates, and configuration optimizations require fully dedicated effort. Cut through all that digital red-tape and run your projects on "),n(r,{to:"/docs/cloud/overview"},{default:o(()=>[t("Directus Cloud")]),_:1}),t(". You get production-ready projects with zero vendor lock-in, 90 second average build times, incredibly fair pricing, scaling at the click of a button, automatic updates with no downtime and a constant stream of new "),n(r,{to:"/docs/cloud/glossary#extensions"},{default:o(()=>[t("Cloud Exclusive Extensions")]),_:1}),t(".")]),e("p",null,[t("We do everything we can to make hosting on "),n(r,{to:"/docs/cloud/overview"},{default:o(()=>[t("Directus Cloud")]),_:1}),t(" a no-brainer.")]),e("div",F,[O,e("p",null,[t("Test out Directus Cloud now for free with the "),n(r,{to:"/docs/getting-started/quickstart"},{default:o(()=>[t("Quickstart Guide")]),_:1}),t(".")])]),V])]),_:1})}}};export{Z as default,U as description,J as modularExtension,X as readTime,Q as title};

package/dist/assets/basic-workflows-17f0fecc.js

@@ -0,0 +1 @@
+import{a as r,o as c,e as h,y as l,u as e,t as a,q as t,z as s}from"./runtime-core.esm-bundler-753bcc58.js";const f={class:"markdown-body"},m=e("blockquote",null,[e("p",null,[t("Workflows are the use of custom access permissions to add structured stages to the flow of content creation or data generation. Workflows enable you to do things like pass off work in progress between multiple roles, build decision trees, "),e("em",null,"and beyond!")])],-1),p={class:"tip hint"},w={class:"hint-title"},_=e("strong",null,"Directus Version:",-1),g=e("h2",{id:"explanation",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#explanation"},"#"),t(" Explanation")],-1),b=e("p",null,"Workflows are when you use these permissions techniques to create structured stages to content or data creation. In simplest terms, it is when you have two or more roles, and you give them different permissions at each stage in the content creation process.",-1),k=e("p",null,[t("There are an infinite number of possible workflows you could configure. But for this recipe, we will configure a simple workflow where "),e("code",null,"writers"),t(" and "),e("code",null,"editors"),t(" work together to create, co-edit and publish "),e("code",null,"articles"),t(".")],-1),y=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/workflows-20220909/workflows-20220909B.webp",alt:"A Workflow"})],-1),v=e("p",null,[t("For this recipe, our workflow will have three stages, "),e("code",null,"draft"),t(", "),e("code",null,"under review"),t(", and "),e("code",null,"published"),t(", which will be defined in a "),e("code",null,"status"),t(" field.")],-1),x=e("table",null,[e("thead",null,[e("tr",null,[e("th",null,[e("code",null,"status")]),e("th",null,[e("code",null,"Author")]),e("th",null,[e("code",null,"Editor")])])]),e("tbody",null,[e("tr",null,[e("td",null,[e("em",null,"Article is not yet created")]),e("td",null,[t("Author can create new items in "),e("code",null,"articles"),t(", but only with a status of "),e("code",null,"draft"),t(".")]),e("td",null,[t("Editor cannot create new items in "),e("code",null,"articles"),t(".")])]),e("tr",null,[e("td",null,[e("code",null,"Draft")]),e("td",null,[t("Author creates and edits the article. Then can set status to "),e("code",null,"under review"),t(" when ready.")]),e("td",null,"Editor has either read-only, or no permissions at all.")]),e("tr",null,[e("td",null,[e("code",null,"Under Review")]),e("td",null,[t("Author can edit the article’s content, but not the "),e("code",null,"status"),t(" field.")]),e("td",null,[t("Editor can edit the article, as well as set status to "),e("code",null,"Draft"),t(" or "),e("code",null,"Published"),t(".")])]),e("tr",null,[e("td",null,[e("code",null,"Published")]),e("td",null,"Author is no longer responsible for article, and has read-only permissions."),e("td",null,"Editor has permissions to update or delete the article.")])])],-1),A=e("p",null,[t("This whole workflow is created with permissions. All we need to do to create these stages is change the "),e("code",null,"author"),t(" and "),e("code",null,"editor"),t(" permissions for each item in "),e("code",null,"articles"),t(" conditionally, based on the value of "),e("code",null,"status"),t(".")],-1),T=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/workflows-20220909/workflows-20220909A.webp",alt:"A Workflow"})],-1),E=e("h2",{id:"how-to-guide",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-to-guide"},"#"),t(" How-To Guide")],-1),U={class:"tip hint"},W=e("div",{class:"hint-title"},"Requirements",-1),C=e("p",null,"To implement a workflow, you’ll need:",-1),F=e("li",null,[t("A collection with some kind of content. In this recipe, we’ll use a collection called "),e("code",null,"articles"),t(".")],-1),B=e("li",null,[t("A field on that collection to validate conditionally. We’ll use a "),e("code",null,"status"),t(" field.")],-1),S=e("li",null,[t("Two "),e("em",null,"(or more)"),t(" roles that will work to author content. We’ll use "),e("code",null,"writer"),t(" and "),e("code",null,"editor"),t(" roles.")],-1),D=e("p",null,[t("To create a structured workflow for "),e("code",null,"articles"),t(", follow these steps.")],-1),I=e("code",null,"status",-1),V=e("code",null,"status",-1),N=e("em",null,[t("("),e("code",null,"draft"),t(", "),e("code",null,"under review"),t(" and "),e("code",null,"published"),t(")")],-1),P=e("code",null,"author",-1),q=e("code",null,"editor",-1),K=e("code",null,"status",-1),R=e("ul",null,[e("li",null,[t("For the "),e("code",null,"author"),t(" role: "),e("ul",null,[e("li",null,[t("Set a filter under "),e("strong",null,"Create > Use Custom > Field Validation"),t(" to ensure the author can only create articles with a "),e("code",null,"draft"),t(" status.")]),e("li",null,"Enable all read permissions."),e("li",null,[t("Set a filter under "),e("strong",null,"Update > Use Custom > Item Permissions"),t(" to ensure the user can update articles with a "),e("code",null,"draft"),t(" or "),e("code",null,"under review"),t(" status.")]),e("li",null,[t("Set a filter under "),e("strong",null,"Update > Use Custom > Field Validation"),t(" to ensure the user can only update article status to "),e("code",null,"under review"),t(".")]),e("li",null,"Keep delete permissions restricted."),e("li",null,"Keep shares permissions restricted.")])]),e("li",null,[t("For the "),e("code",null,"editor"),t(" role: "),e("ul",null,[e("li",null,"Keep create permissions restricted."),e("li",null,"Enable all read permissions."),e("li",null,[t("Set a filter under "),e("strong",null,"Update > Use Custom > Item Permissions"),t(" to ensure the user can only update articles with an "),e("code",null,"under review"),t(" status.")]),e("li",null,[t("Set a filter under "),e("strong",null,"Update > Use Custom > Field Validation"),t(" to ensure the user can only update status to "),e("code",null,"published"),t(".")]),e("li",null,"Keep delete permissions restricted."),e("li",null,"Keep shares permissions restricted.")])])],-1),Y=e("h2",{id:"final-tips",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#final-tips"},"#"),t(" Final Tips")],-1),H=e("p",null,"This recipe covers one simple example of a workflow. As you move forward and created your own custom-tailored workflows, just remember:",-1),$=e("ul",null,[e("li",null,"You could use any number of roles."),e("li",null,"You could use any collection or relationally linked collections."),e("li",null,[t("You can add more stages in your workflow by adding more values to your "),e("code",null,"status"),t(" field.")])],-1),j=e("p",null,"Be sure to pay close attention to how you configure custom access permissions for workflows. Unintentional misconfigurations can have side-effects.",-1),z=e("p",null,[t("In our simple "),e("code",null,"articles"),t(" workflow above, a minor misconfiguration in a co-editing workflow between two team members "),e("em",null,"might"),t(" not be a big problem. But in other cases it can have big consequences. For example, let’s imagine for a second that:")],-1),G=e("ul",null,[e("li",null,[t("The "),e("code",null,"writer"),t(" and "),e("code",null,"editor"),t(" roles were "),e("code",null,"teacher"),t(" and "),e("code",null,"student"),t(" roles.")]),e("li",null,[t("The "),e("code",null,"articles"),t(" collection was instead a "),e("code",null,"tests"),t(" collection.")]),e("li",null,[t("The "),e("code",null,"status"),t(" field defined if the test was "),e("code",null,"not started"),t(", "),e("code",null,"in progress"),t(", or "),e("code",null,"submitted"),t(".")])],-1),J=e("p",null,"A minor misconfiguration here could ruin academic integrity. Here’s a few potential issues:",-1),L=e("ul",null,[e("li",null,"students retake/re-edit their own submitted test."),e("li",null,"students take/edit/delete tests of other students."),e("li",null,"teachers modify the results of students that they like or don’t like."),e("li",null,[e("em",null,"and beyond!")])],-1),M=e("p",null,"When creating your own workflow, its a good idea to define each role involved, each stage in the workflow, and the explicit set of permissions each role has at each stage.",-1),O={class:"tip hint"},Q=e("div",{class:"hint-title"},"Next Steps",-1),te="Basic Workflows",le=!1,oe=null,se=[],ne=null,ie="9.18.1",re=null,ae="Eron Powell",de={__name:"basic-workflows",setup(X,{expose:d}){const n={title:"Basic Workflows",modularExtension:!1,description:null,tags:[],skill_level:null,directus_version:"9.18.1",author_override:null,author:"Eron Powell"};return d({frontmatter:n}),(i,Z)=>{const o=r("router-link"),u=r("docs-wrapper");return c(),h(u,{frontmatter:n},{default:l(()=>[e("div",f,[m,e("div",p,[e("div",w,"Author: "+a(i.$frontmatter.author),1),e("p",null,[_,t(" "+a(i.$frontmatter.directus_version),1)])]),g,e("p",null,[t("Remember, your basic "),s(o,{to:"/docs/configuration/users-roles-permissions/permissions.md#configure-permissions"},{default:l(()=>[t("CRUDS permissions")]),_:1}),t(" define what a role can and can’t do to all items in a collection. "),s(o,{to:"/docs/configuration/users-roles-permissions/permissions.md#configure-custom-permissions"},{default:l(()=>[t("Custom access permissions")]),_:1}),t(" take things a step further and let you define what a role can and can’t do to each item in a collection, "),e("em",null,[t("based on its "),s(o,{to:"/docs/configuration/data-model/fields.md"},{default:l(()=>[t("field values")]),_:1})]),t(".")]),b,k,y,v,x,A,T,E,e("div",U,[W,C,e("ul",null,[e("li",null,[t("An understanding of "),s(o,{to:"/docs/configuration/users-roles-permissions.md"},{default:l(()=>[t("permissions")]),_:1}),t(" and "),s(o,{to:"/docs/reference/filter-rules.md"},{default:l(()=>[t("filters")]),_:1}),t(" in Directus.")]),F,B,S])]),D,e("ol",null,[e("li",null,[t("First, "),s(o,{to:"/docs/configuration/data-model/fields.md#create-a-field-standard"},{default:l(()=>[t("create a field")]),_:1}),t(" to track the article status. We’ll call this field "),I,t(", but it could be named anything.")]),e("li",null,[s(o,{to:"/docs/configuration/data-model/fields.md#create-a-field-advanced"},{default:l(()=>[t("Create a field")]),_:1}),t(" with a Dropdown Interface. Name it "),V,t(" and add the stages "),N,t(" needed for your content creation process.")]),e("li",null,[t("Next, "),s(o,{to:"/docs/configuration/users-roles-permissions/roles.md#create-a-role"},{default:l(()=>[t("create two roles")]),_:1}),t(": "),P,t(" and "),q,t(".")]),e("li",null,[t("Finally, configure "),s(o,{to:"/docs/configuration/users-roles-permissions/permissions.md#configure-custom-permissions"},{default:l(()=>[t("custom access permissions")]),_:1}),t(" for each role based on the value of the "),K,t(" field. "),R])]),Y,H,$,j,z,G,J,L,M,e("div",O,[Q,e("p",null,[t("Workflows can be further enhanced with custom "),s(o,{to:"/docs/extensions/interfaces.md"},{default:l(()=>[t("Interfaces")]),_:1}),t(" as well as "),s(o,{to:"/docs/configuration/flows.md"},{default:l(()=>[t("flows")]),_:1}),t(".")])])])]),_:1})}}};export{ae as author,re as author_override,de as default,oe as description,ie as directus_version,le as modularExtension,ne as skill_level,se as tags,te as title};