@directus/app 9.11.0 → 9.12.1

package/dist/assets/{sdk.5d0984d2.js → sdk.12cd7974.js}

@@ -1,5 +1,5 @@
-import{w as l,y as r,z as h,A as t,E as s,C as o,W as e}from"./vendor.3b903562.js";const d={class:"markdown-body"},p=s("blockquote",null,[s("p",null,[e("The JS SDK provides an intuitive interface for the Directus API from within a JavaScript-powered project (browsers and Node.js). The default implementation uses "),s("a",{href:"https://npmjs.com/axios",target:"_blank",rel:"noopener noreferrer"},"Axios"),e(" for transport and "),s("code",null,"localStorage"),e(" for storing state.")])],-1),u=s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#installation"},"Installation")]),s("li",null,[s("a",{href:"#usage"},"Usage")]),s("li",null,[s("a",{href:"#typescript"},"TypeScript")]),s("li",null,[s("a",{href:"#reference"},"Reference")]),s("li",null,[s("a",{href:"#auth"},"Auth")]),s("li",null,[s("a",{href:"#transport"},"Transport")]),s("li",null,[s("a",{href:"#storage"},"Storage")]),s("li",null,[s("a",{href:"#items"},"Items")]),s("li",null,[s("a",{href:"#activity"},"Activity")]),s("li",null,[s("a",{href:"#comments"},"Comments")]),s("li",null,[s("a",{href:"#collections"},"Collections")]),s("li",null,[s("a",{href:"#fields"},"Fields")]),s("li",null,[s("a",{href:"#files"},"Files")]),s("li",null,[s("a",{href:"#folders"},"Folders")]),s("li",null,[s("a",{href:"#permissions"},"Permissions")]),s("li",null,[s("a",{href:"#presets"},"Presets")]),s("li",null,[s("a",{href:"#relations"},"Relations")]),s("li",null,[s("a",{href:"#revisions"},"Revisions")]),s("li",null,[s("a",{href:"#roles"},"Roles")]),s("li",null,[s("a",{href:"#settings"},"Settings")]),s("li",null,[s("a",{href:"#server"},"Server")]),s("li",null,[s("a",{href:"#users"},"Users")]),s("li",null,[s("a",{href:"#utils"},"Utils")])])])],-1),j=s("h2",{id:"installation"},[e("Installation "),s("a",{class:"header-anchor",href:"#installation"},"#")],-1),m=s("pre",null,[s("code",{class:"language-bash"},`npm install @directus/sdk
-`)],-1),g=s("h2",{id:"usage"},[e("Usage "),s("a",{class:"header-anchor",href:"#usage"},"#")],-1),_=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
+import{a as n,o as r,b as h,w as a,g as s,e as l,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var o={};const d={class:"markdown-body"},p=s("blockquote",null,[s("p",null,[e("The JS SDK provides an intuitive interface for the Directus API from within a JavaScript-powered project (browsers and Node.js). The default implementation uses "),s("a",{href:"https://npmjs.com/axios",target:"_blank",rel:"noopener noreferrer"},"Axios"),e(" for transport and "),s("code",{class:""},"localStorage"),e(" for storing state.")])],-1),u=s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#installation"},"Installation")]),s("li",null,[s("a",{href:"#usage"},"Usage")]),s("li",null,[s("a",{href:"#typescript"},"TypeScript")]),s("li",null,[s("a",{href:"#reference"},"Reference")]),s("li",null,[s("a",{href:"#auth"},"Auth")]),s("li",null,[s("a",{href:"#transport"},"Transport")]),s("li",null,[s("a",{href:"#storage"},"Storage")]),s("li",null,[s("a",{href:"#items"},"Items")]),s("li",null,[s("a",{href:"#activity"},"Activity")]),s("li",null,[s("a",{href:"#comments"},"Comments")]),s("li",null,[s("a",{href:"#collections"},"Collections")]),s("li",null,[s("a",{href:"#fields"},"Fields")]),s("li",null,[s("a",{href:"#files"},"Files")]),s("li",null,[s("a",{href:"#folders"},"Folders")]),s("li",null,[s("a",{href:"#permissions"},"Permissions")]),s("li",null,[s("a",{href:"#presets"},"Presets")]),s("li",null,[s("a",{href:"#relations"},"Relations")]),s("li",null,[s("a",{href:"#revisions"},"Revisions")]),s("li",null,[s("a",{href:"#roles"},"Roles")]),s("li",null,[s("a",{href:"#settings"},"Settings")]),s("li",null,[s("a",{href:"#server"},"Server")]),s("li",null,[s("a",{href:"#users"},"Users")]),s("li",null,[s("a",{href:"#utils"},"Utils")])])])],-1),j=s("h2",{id:"installation"},[e("Installation "),s("a",{class:"header-anchor",href:"#installation"},"#")],-1),m=s("pre",null,[s("code",{class:"language-bash"},`npm install @directus/sdk
+`)],-1),_=s("h2",{id:"usage"},[e("Usage "),s("a",{class:"header-anchor",href:"#usage"},"#")],-1),g=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
 
 `),s("span",{class:"hljs-keyword"},"const"),e(" directus = "),s("span",{class:"hljs-keyword"},"new"),e(" Directus("),s("span",{class:"hljs-string"},"'http://directus.example.com'"),e(`);
 
@@ -105,10 +105,10 @@ me.level = `),s("span",{class:"hljs-number"},"42"),e(`;
 
 `),s("span",{class:"hljs-comment"},'// Error TS2322: Type "string" is not assignable to type "number".'),e(`
 me.experience = `),s("span",{class:"hljs-string"},"'high'"),e(`;
-`)])],-1),D=s("h2",{id:"reference"},[e("Reference "),s("a",{class:"header-anchor",href:"#reference"},"#")],-1),T=s("h3",{id:"constructor"},[e("Constructor "),s("a",{class:"header-anchor",href:"#constructor"},"#")],-1),x=s("p",null,[e("This is the starting point to use the SDK. You need to create an instance and invoke methods from it. In most cases a single instance is sufficient, but in case you need more, you need to define "),s("a",{href:"#options.storage.prefix"},[s("code",null,"options.storage.prefix")]),e(".")],-1),I=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
+`)])],-1),D=s("h2",{id:"reference"},[e("Reference "),s("a",{class:"header-anchor",href:"#reference"},"#")],-1),T=s("h3",{id:"constructor"},[e("Constructor "),s("a",{class:"header-anchor",href:"#constructor"},"#")],-1),x=s("p",null,[e("This is the starting point to use the SDK. You need to create an instance and invoke methods from it. In most cases a single instance is sufficient, but in case you need more, you need to define "),s("a",{href:"#options.storage.prefix"},[s("code",{class:""},"options.storage.prefix")]),e(".")],-1),I=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
 
 `),s("span",{class:"hljs-keyword"},"const"),e(" directus = "),s("span",{class:"hljs-keyword"},"new"),e(` Directus(url, init);
-`)])],-1),A=s("ul",null,[s("li",null,[s("p",null,[s("code",null,"url"),e(" [required] "),s("em",null,"String"),e(" - A string pointing to your Directus instance. E.g. "),s("code",null,"https://admin.directus.io")]),s("p",null,[s("a",{name:"options"})])]),s("li",null,[s("p",null,[s("code",null,"init"),e(" [optional] "),s("em",null,"Object"),e(" - Define settings that you want to customize .The possible options are:")]),s("p",null,[s("a",{name:"options.auth"})]),s("ul",null,[s("li",null,[s("p",null,[s("code",null,"auth"),e(" [optional] "),s("em",null,"Object"),e(" - Defines settings you want to customize regarding "),s("a",{href:"#auth"},"authentication"),e(". The possible options are:")]),s("ul",null,[s("li",null,[s("p",null,[s("code",null,"mode"),e(" [optional] "),s("em",null,"String"),e(" - Defines the mode you want to use for authentication. It can be "),s("code",null,"'cookie'"),e(" for cookies or "),s("code",null,"'json'"),e(" for JWT. Defaults to "),s("code",null,"'cookie'"),e(" on browsers and "),s("code",null,"'json'"),e(" otherwise. We recommend using cookies when possible to prevent any kind of attacks, mostly XSS.")]),s("p",null,[s("a",{name:"options.auth.autoRefresh"})])]),s("li",null,[s("p",null,[s("code",null,"autoRefresh"),e(" [optional] "),s("em",null,"Boolean"),e(" - Tells SDK if it should handle refresh tokens automatically. Defaults to "),s("code",null,"true"),e(".")])]),s("li",null,[s("p",null,[s("code",null,"msRefreshBeforeExpires"),e(" [optional] "),s("em",null,"Number"),e(" - When "),s("code",null,"autoRefresh"),e(" is enabled, this tells how many milliseconds before the refresh token expires and needs to be refreshed. Defaults to "),s("code",null,"30000"),e(".")])]),s("li",null,[s("p",null,[s("code",null,"staticToken"),e(" [optional] "),s("em",null,"String"),e(" - Defines the static token to use. It is not compatible with the options above since it does not refresh. Defaults to "),s("code",null,"''"),e(" (no static token).")])])])])]),s("p",null,[s("a",{name:"options.storage"})]),s("ul",null,[s("li",null,[s("p",null,[s("code",null,"storage"),e(" [optional] "),s("em",null,"Object"),e(" - Defines settings you want to customize regarding "),s("a",{href:"#storage"},"storage"),e(".")]),s("p",null,[s("a",{name:"options.storage.prefix"})]),s("ul",null,[s("li",null,[s("code",null,"prefix"),e(" [optional] "),s("em",null,"String"),e(" - Defines the tokens prefix tokens that are saved. This should be fulfilled with different values when using multiple instances of SDK. Defaults to "),s("code",null,"''"),e(" (no prefix).")]),s("li",null,[s("code",null,"mode"),e(" [optional] "),s("em",null,"String"),e(" - Defines the storage location to be used to save tokens. Allowed values are "),s("code",null,"LocalStorage"),e(" and "),s("code",null,"MemoryStorage"),e(". Defaults to "),s("code",null,"LocalStorage"),e(" on browsers and "),s("code",null,"MemoryStorage"),e(" on Node.js. The mode "),s("code",null,"LocalStorage"),e(" is not compatible with Node.js.")])])])]),s("p",null,[s("a",{name:"options.transport"})]),s("ul",null,[s("li",null,[s("code",null,"transport"),e(" [optional] "),s("em",null,"Object"),e(" - Defines settings you want to customize regarding "),s("a",{href:"#transport"},"transport"),e(". "),s("ul",null,[s("li",null,[s("code",null,"params"),e(" [optional] "),s("em",null,"Object"),e(" - Defines an object with keys and values to be passed as additional query string.")]),s("li",null,[s("code",null,"headers"),e(" [optional] "),s("em",null,"Object"),e(" - Defines an object with keys and values to be passed as additional headers.")]),s("li",null,[s("code",null,"onUploadProgress"),e(" [optional] "),s("em",null,[e("(event: "),s("a",{href:"https://developer.mozilla.org/en-US/docs/Web/API/ProgressEvent",target:"_blank",rel:"noopener noreferrer"},"ProgressEvent"),e(" => void)")]),e(" - Defines a callback function to indicate the upload progress.")])])])])])],-1),R=s("h2",{id:"auth"},[e("Auth "),s("a",{class:"header-anchor",href:"#auth"},"#")],-1),q=s("p",null,"Defines how authentication is handled by the SDK.",-1),B=s("h3",{id:"custom-implementation"},[e("Custom Implementation "),s("a",{class:"header-anchor",href:"#custom-implementation"},"#")],-1),M=s("p",null,[e("It is possible to provide a custom implementation by extending "),s("code",null,"IAuth"),e(". While this could be useful for advanced usage, most use-cases do not need it.")],-1),C=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { IAuth, Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
+`)])],-1),A=s("ul",null,[s("li",null,[s("p",null,[s("code",{class:""},"url"),e(" [required] "),s("em",null,"String"),e(" - A string pointing to your Directus instance. E.g. "),s("code",{class:""},"https://admin.directus.io")]),s("p",null,[s("a",{name:"options"})])]),s("li",null,[s("p",null,[s("code",{class:""},"init"),e(" [optional] "),s("em",null,"Object"),e(" - Define settings that you want to customize .The possible options are:")]),s("p",null,[s("a",{name:"options.auth"})]),s("ul",null,[s("li",null,[s("p",null,[s("code",{class:""},"auth"),e(" [optional] "),s("em",null,"Object"),e(" - Defines settings you want to customize regarding "),s("a",{href:"#auth"},"authentication"),e(". The possible options are:")]),s("ul",null,[s("li",null,[s("p",null,[s("code",{class:""},"mode"),e(" [optional] "),s("em",null,"String"),e(" - Defines the mode you want to use for authentication. It can be "),s("code",{class:""},"'cookie'"),e(" for cookies or "),s("code",{class:""},"'json'"),e(" for JWT. Defaults to "),s("code",{class:""},"'cookie'"),e(" on browsers and "),s("code",{class:""},"'json'"),e(" otherwise. We recommend using cookies when possible to prevent any kind of attacks, mostly XSS.")]),s("p",null,[s("a",{name:"options.auth.autoRefresh"})])]),s("li",null,[s("p",null,[s("code",{class:""},"autoRefresh"),e(" [optional] "),s("em",null,"Boolean"),e(" - Tells SDK if it should handle refresh tokens automatically. Defaults to "),s("code",{class:""},"true"),e(".")])]),s("li",null,[s("p",null,[s("code",{class:""},"msRefreshBeforeExpires"),e(" [optional] "),s("em",null,"Number"),e(" - When "),s("code",{class:""},"autoRefresh"),e(" is enabled, this tells how many milliseconds before the refresh token expires and needs to be refreshed. Defaults to "),s("code",{class:""},"30000"),e(".")])]),s("li",null,[s("p",null,[s("code",{class:""},"staticToken"),e(" [optional] "),s("em",null,"String"),e(" - Defines the static token to use. It is not compatible with the options above since it does not refresh. Defaults to "),s("code",{class:""},"''"),e(" (no static token).")])])])])]),s("p",null,[s("a",{name:"options.storage"})]),s("ul",null,[s("li",null,[s("p",null,[s("code",{class:""},"storage"),e(" [optional] "),s("em",null,"Object"),e(" - Defines settings you want to customize regarding "),s("a",{href:"#storage"},"storage"),e(".")]),s("p",null,[s("a",{name:"options.storage.prefix"})]),s("ul",null,[s("li",null,[s("code",{class:""},"prefix"),e(" [optional] "),s("em",null,"String"),e(" - Defines the tokens prefix tokens that are saved. This should be fulfilled with different values when using multiple instances of SDK. Defaults to "),s("code",{class:""},"''"),e(" (no prefix).")]),s("li",null,[s("code",{class:""},"mode"),e(" [optional] "),s("em",null,"String"),e(" - Defines the storage location to be used to save tokens. Allowed values are "),s("code",{class:""},"LocalStorage"),e(" and "),s("code",{class:""},"MemoryStorage"),e(". Defaults to "),s("code",{class:""},"LocalStorage"),e(" on browsers and "),s("code",{class:""},"MemoryStorage"),e(" on Node.js. The mode "),s("code",{class:""},"LocalStorage"),e(" is not compatible with Node.js.")])])])]),s("p",null,[s("a",{name:"options.transport"})]),s("ul",null,[s("li",null,[s("code",{class:""},"transport"),e(" [optional] "),s("em",null,"Object"),e(" - Defines settings you want to customize regarding "),s("a",{href:"#transport"},"transport"),e(". "),s("ul",null,[s("li",null,[s("code",{class:""},"params"),e(" [optional] "),s("em",null,"Object"),e(" - Defines an object with keys and values to be passed as additional query string.")]),s("li",null,[s("code",{class:""},"headers"),e(" [optional] "),s("em",null,"Object"),e(" - Defines an object with keys and values to be passed as additional headers.")]),s("li",null,[s("code",{class:""},"onUploadProgress"),e(" [optional] "),s("em",null,[e("(event: "),s("a",{href:"https://developer.mozilla.org/en-US/docs/Web/API/ProgressEvent",target:"_blank",rel:"noopener noreferrer"},"ProgressEvent"),e(" => void)")]),e(" - Defines a callback function to indicate the upload progress.")])])])])])],-1),R=s("h2",{id:"auth"},[e("Auth "),s("a",{class:"header-anchor",href:"#auth"},"#")],-1),q=s("p",null,"Defines how authentication is handled by the SDK.",-1),B=s("h3",{id:"custom-implementation"},[e("Custom Implementation "),s("a",{class:"header-anchor",href:"#custom-implementation"},"#")],-1),M=s("p",null,[e("It is possible to provide a custom implementation by extending "),s("code",{class:""},"IAuth"),e(". While this could be useful for advanced usage, most use-cases do not need it.")],-1),C=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { IAuth, Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
 
 `),s("span",{class:"hljs-class"},[s("span",{class:"hljs-keyword"},"class"),e(),s("span",{class:"hljs-title"},"MyAuth"),e(),s("span",{class:"hljs-keyword"},"extends"),e(),s("span",{class:"hljs-title"},"IAuth"),e()]),e(`{
 	`),s("span",{class:"hljs-keyword"},"async"),e(),s("span",{class:"hljs-function"},[s("span",{class:"hljs-title"},"login"),e("("),s("span",{class:"hljs-params"}),e(")")]),e(` {
@@ -124,21 +124,21 @@ me.experience = `),s("span",{class:"hljs-string"},"'high'"),e(`;
 }
 
 `),s("span",{class:"hljs-keyword"},"const"),e(" directus = "),s("span",{class:"hljs-keyword"},"new"),e(" Directus("),s("span",{class:"hljs-string"},"'http://directus.example.com'"),e(", { "),s("span",{class:"hljs-attr"},"auth"),e(": "),s("span",{class:"hljs-keyword"},"new"),e(` MyAuth() });
-`)])],-1),O=s("h3",{id:"directus-implementation"},[e("Directus Implementation "),s("a",{class:"header-anchor",href:"#directus-implementation"},"#")],-1),P=s("p",null,[e("By default, Directus creates an instance of "),s("code",null,"Auth"),e(" which handles refresh tokens automatically. Check "),s("a",{href:"#options.auth"},[s("code",null,"options.auth")]),e(" to see the available settings.")],-1),U=s("h3",{id:"get-current-token"},[e("Get current token "),s("a",{class:"header-anchor",href:"#get-current-token"},"#")],-1),E=s("pre",null,[s("code",{class:"language-ts"},[s("span",{class:"hljs-keyword"},"const"),e(` token = directus.auth.token;
+`)])],-1),O=s("h3",{id:"directus-implementation"},[e("Directus Implementation "),s("a",{class:"header-anchor",href:"#directus-implementation"},"#")],-1),P=s("p",null,[e("By default, Directus creates an instance of "),s("code",{class:""},"Auth"),e(" which handles refresh tokens automatically. Check "),s("a",{href:"#options.auth"},[s("code",{class:""},"options.auth")]),e(" to see the available settings.")],-1),U=s("h3",{id:"get-current-token"},[e("Get current token "),s("a",{class:"header-anchor",href:"#get-current-token"},"#")],-1),E=s("pre",null,[s("code",{class:"language-ts"},[s("span",{class:"hljs-keyword"},"const"),e(` token = directus.auth.token;
 `)])],-1),N=s("h3",{id:"login"},[e("Login "),s("a",{class:"header-anchor",href:"#login"},"#")],-1),F=s("h4",{id:"with-credentials"},[e("With credentials "),s("a",{class:"header-anchor",href:"#with-credentials"},"#")],-1),K=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.auth.login({
 	`),s("span",{class:"hljs-attr"},"email"),e(": "),s("span",{class:"hljs-string"},"'admin@example.com'"),e(`,
 	`),s("span",{class:"hljs-attr"},"password"),e(": "),s("span",{class:"hljs-string"},"'d1r3ctu5'"),e(`,
 });
-`)])],-1),W=s("h4",{id:"with-static-tokens"},[e("With static tokens "),s("a",{class:"header-anchor",href:"#with-static-tokens"},"#")],-1),L=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.auth.static("),s("span",{class:"hljs-string"},"'static_token'"),e(`);
-`)])],-1),J=s("h3",{id:"refresh-auth-token"},[e("Refresh Auth Token "),s("a",{class:"header-anchor",href:"#refresh-auth-token"},"#")],-1),z=s("p",null,[e("By default, Directus will handle token refreshes. Although, you can handle this behaviour manually by setting "),s("a",{href:"#options.auth.autoRefresh"},[s("code",null,"autoRefresh")]),e(" to "),s("code",null,"false"),e(".")],-1),H=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.auth.refresh();
-`)])],-1),V={class:"tip hint"},G=s("div",{class:"hint-title"},"Developing Locally",-1),Y=e("If you\u2019re developing locally, you might not be able to refresh your auth token automatically in all browsers. This is because the default auth configuration requires secure cookies to be set, and not all browsers allow this for localhost. You can use a browser which does support this such as Firefox, or "),Q=e("disable secure cookies"),$=e("."),X=s("h3",{id:"logout"},[e("Logout "),s("a",{class:"header-anchor",href:"#logout"},"#")],-1),Z=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.auth.logout();
-`)])],-1),ss=s("h3",{id:"request-a-password-reset"},[e("Request a Password Reset "),s("a",{class:"header-anchor",href:"#request-a-password-reset"},"#")],-1),es=s("p",null,[e("By default, the address defined in "),s("code",null,"PUBLIC_URL"),e(" on "),s("code",null,".env"),e(" file is used for the link to the reset password page sent in the email:")],-1),ts=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.auth.password.request("),s("span",{class:"hljs-string"},"'admin@example.com'"),e(`);
-`)])],-1),as=s("p",null,"But a custom address can be passed as second argument:",-1),ns=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.auth.password.request(
+`)])],-1),L=s("h4",{id:"with-static-tokens"},[e("With static tokens "),s("a",{class:"header-anchor",href:"#with-static-tokens"},"#")],-1),W=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.auth.static("),s("span",{class:"hljs-string"},"'static_token'"),e(`);
+`)])],-1),J=s("h3",{id:"refresh-auth-token"},[e("Refresh Auth Token "),s("a",{class:"header-anchor",href:"#refresh-auth-token"},"#")],-1),H=s("p",null,[e("By default, Directus will handle token refreshes. Although, you can handle this behaviour manually by setting "),s("a",{href:"#options.auth.autoRefresh"},[s("code",{class:""},"autoRefresh")]),e(" to "),s("code",{class:""},"false"),e(".")],-1),V=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.auth.refresh();
+`)])],-1),z={class:"tip hint"},G=s("div",{class:"hint-title"},"Developing Locally",-1),Y=e("If you\u2019re developing locally, you might not be able to refresh your auth token automatically in all browsers. This is because the default auth configuration requires secure cookies to be set, and not all browsers allow this for localhost. You can use a browser which does support this such as Firefox, or "),Q=e("disable secure cookies"),$=e("."),X=s("h3",{id:"logout"},[e("Logout "),s("a",{class:"header-anchor",href:"#logout"},"#")],-1),Z=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.auth.logout();
+`)])],-1),ss=s("h3",{id:"request-a-password-reset"},[e("Request a Password Reset "),s("a",{class:"header-anchor",href:"#request-a-password-reset"},"#")],-1),es=s("p",null,[e("By default, the address defined in "),s("code",{class:""},"PUBLIC_URL"),e(" on "),s("code",{class:""},".env"),e(" file is used for the link to the reset password page sent in the email:")],-1),as=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.auth.password.request("),s("span",{class:"hljs-string"},"'admin@example.com'"),e(`);
+`)])],-1),ts=s("p",null,"But a custom address can be passed as second argument:",-1),ns=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.auth.password.request(
 	`),s("span",{class:"hljs-string"},"'admin@example.com'"),e(`,
 	`),s("span",{class:"hljs-string"},"'https://myapp.com'"),e(),s("span",{class:"hljs-comment"},"// In this case, the link will be https://myapp.com?token=FEE0A..."),e(`
 );
 `)])],-1),ls=s("h3",{id:"reset-a-password"},[e("Reset a Password "),s("a",{class:"header-anchor",href:"#reset-a-password"},"#")],-1),os=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.auth.password.reset("),s("span",{class:"hljs-string"},"'abc.def.ghi'"),e(", "),s("span",{class:"hljs-string"},"'n3w-p455w0rd'"),e(`);
-`)])],-1),cs=s("p",null,[e("Note: The token passed in the first parameter is sent in an email to the user when using "),s("code",null,"request()")],-1),is=s("h2",{id:"transport"},[e("Transport "),s("a",{class:"header-anchor",href:"#transport"},"#")],-1),rs=s("p",null,"The transport object abstracts how you communicate with Directus. Transports can be customized to use different HTTP libraries for example.",-1),hs=s("h3",{id:"custom-implementation-2"},[e("Custom Implementation "),s("a",{class:"header-anchor",href:"#custom-implementation-2"},"#")],-1),ds=s("p",null,[e("It is possible to provide a custom implementation by extending "),s("code",null,"ITransport"),e(". While, this could be useful for advanced usage, it is not needed for most use-cases.")],-1),ps=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { ITransport, Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
+`)])],-1),cs=s("p",null,[e("Note: The token passed in the first parameter is sent in an email to the user when using "),s("code",{class:""},"request()")],-1),is=s("h2",{id:"transport"},[e("Transport "),s("a",{class:"header-anchor",href:"#transport"},"#")],-1),rs=s("p",null,"The transport object abstracts how you communicate with Directus. Transports can be customized to use different HTTP libraries for example.",-1),hs=s("h3",{id:"custom-implementation-2"},[e("Custom Implementation "),s("a",{class:"header-anchor",href:"#custom-implementation-2"},"#")],-1),ds=s("p",null,[e("It is possible to provide a custom implementation by extending "),s("code",{class:""},"ITransport"),e(". While, this could be useful for advanced usage, it is not needed for most use-cases.")],-1),ps=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { ITransport, Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
 
 `),s("span",{class:"hljs-class"},[s("span",{class:"hljs-keyword"},"class"),e(),s("span",{class:"hljs-title"},"MyTransport"),e(),s("span",{class:"hljs-keyword"},"extends"),e(),s("span",{class:"hljs-title"},"ITransport"),e()]),e(`{
 	`),s("span",{class:"hljs-function"},[s("span",{class:"hljs-title"},"buildResponse"),e("("),s("span",{class:"hljs-params"}),e(")")]),e(` {
@@ -174,7 +174,7 @@ me.experience = `),s("span",{class:"hljs-string"},"'high'"),e(`;
 }
 
 `),s("span",{class:"hljs-keyword"},"const"),e(" directus = "),s("span",{class:"hljs-keyword"},"new"),e(" Directus("),s("span",{class:"hljs-string"},"'http://directus.example.com'"),e(", { "),s("span",{class:"hljs-attr"},"transport"),e(": "),s("span",{class:"hljs-keyword"},"new"),e(` MyTransport() });
-`)])],-1),us=s("h3",{id:"directus-implementation-2"},[e("Directus Implementation "),s("a",{class:"header-anchor",href:"#directus-implementation-2"},"#")],-1),js=s("p",null,[e("By default, Directus creates an instance of "),s("code",null,"Transport"),e(" which handles requests automatically. Check "),s("a",{href:"#options.transport"},[s("code",null,"options.transport")]),e(" to see the available settings.")],-1),ms=s("p",null,[e("To make HTTP requests SDK uses "),s("code",null,"axios"),e(" so it is compatible in both browsers and Node.js. Also, it is possible to handle upload progress (a downside of "),s("code",null,"fetch"),e(").")],-1),gs=s("h2",{id:"storage"},[e("Storage "),s("a",{class:"header-anchor",href:"#storage"},"#")],-1),_s=s("p",null,"The storage is used to load and save token information.",-1),fs=s("h3",{id:"custom-implementation-3"},[e("Custom Implementation "),s("a",{class:"header-anchor",href:"#custom-implementation-3"},"#")],-1),ys=s("p",null,[e("It is possible to provide a custom implementation by extending "),s("code",null,"BaseStorage"),e(". While, this could be useful for advanced usage, it is not needed for most use-cases.")],-1),ws=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { BaseStorage, Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
+`)])],-1),us=s("h3",{id:"directus-implementation-2"},[e("Directus Implementation "),s("a",{class:"header-anchor",href:"#directus-implementation-2"},"#")],-1),js=s("p",null,[e("By default, Directus creates an instance of "),s("code",{class:""},"Transport"),e(" which handles requests automatically. Check "),s("a",{href:"#options.transport"},[s("code",{class:""},"options.transport")]),e(" to see the available settings.")],-1),ms=s("p",null,[e("To make HTTP requests SDK uses "),s("code",{class:""},"axios"),e(" so it is compatible in both browsers and Node.js. Also, it is possible to handle upload progress (a downside of "),s("code",{class:""},"fetch"),e(").")],-1),_s=s("h2",{id:"storage"},[e("Storage "),s("a",{class:"header-anchor",href:"#storage"},"#")],-1),gs=s("p",null,"The storage is used to load and save token information.",-1),fs=s("h3",{id:"custom-implementation-3"},[e("Custom Implementation "),s("a",{class:"header-anchor",href:"#custom-implementation-3"},"#")],-1),ys=s("p",null,[e("It is possible to provide a custom implementation by extending "),s("code",{class:""},"BaseStorage"),e(". While, this could be useful for advanced usage, it is not needed for most use-cases.")],-1),ws=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" { BaseStorage, Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`;
 
 `),s("span",{class:"hljs-class"},[s("span",{class:"hljs-keyword"},"class"),e(),s("span",{class:"hljs-title"},"SessionStorage"),e(),s("span",{class:"hljs-keyword"},"extends"),e(),s("span",{class:"hljs-title"},"BaseStorage"),e()]),e(`{
 	`),s("span",{class:"hljs-function"},[s("span",{class:"hljs-title"},"get"),e("("),s("span",{class:"hljs-params"},"key"),e(")")]),e(` {
@@ -189,7 +189,7 @@ me.experience = `),s("span",{class:"hljs-string"},"'high'"),e(`;
 }
 
 `),s("span",{class:"hljs-keyword"},"const"),e(" directus = "),s("span",{class:"hljs-keyword"},"new"),e(" Directus("),s("span",{class:"hljs-string"},"'http://directus.example.com'"),e(", { "),s("span",{class:"hljs-attr"},"storage"),e(": "),s("span",{class:"hljs-keyword"},"new"),e(` SessionStorage() });
-`)])],-1),ks=s("h3",{id:"directus-implementation-3"},[e("Directus Implementation "),s("a",{class:"header-anchor",href:"#directus-implementation-3"},"#")],-1),bs=s("p",null,[e("By default, Directus creates an instance of "),s("code",null,"Storage"),e(" which handles store information automatically. Check "),s("a",{href:"#options.storage"},[s("code",null,"options.storage")]),e(" to see the available settings.")],-1),vs=s("p",null,[e("SDK uses "),s("code",null,"localStorage"),e(" on browsers and the memory itself on Node.js to save tokens. This behavior can be configured in "),s("a",{href:"#options.storage.mode"},[s("code",null,"options.storage.mode")]),e(". The "),s("code",null,"LocalStorage"),e(" is only available on browsers and the "),s("code",null,"MemoryStorage"),e(" is not persistent, i.e., once you leave the tab or quit the process, you will need to authenticate again.")],-1),Ss=s("p",null,[e("If you want to use multiple instances of the SDK you should set a different "),s("a",{href:"#options.storage.prefix"},[s("code",null,"prefix")]),e(" for each one.")],-1),Ds=s("h2",{id:"items"},[e("Items "),s("a",{class:"header-anchor",href:"#items"},"#")],-1),Ts=s("p",null,[e("You can get an instance of the item handler by providing the collection (and type, in the case of TypeScript) to the "),s("code",null,"items"),e(" function. The following examples will use the "),s("code",null,"Article"),e(" type.")],-1),xs=s("blockquote",null,[s("p",null,"JavaScript")],-1),Is=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"// import { Directus, ID } from '@directus/sdk';"),e(`
+`)])],-1),ks=s("h3",{id:"directus-implementation-3"},[e("Directus Implementation "),s("a",{class:"header-anchor",href:"#directus-implementation-3"},"#")],-1),bs=s("p",null,[e("By default, Directus creates an instance of "),s("code",{class:""},"Storage"),e(" which handles store information automatically. Check "),s("a",{href:"#options.storage"},[s("code",{class:""},"options.storage")]),e(" to see the available settings.")],-1),vs=s("p",null,[e("SDK uses "),s("code",{class:""},"localStorage"),e(" on browsers and the memory itself on Node.js to save tokens. This behavior can be configured in "),s("a",{href:"#options.storage.mode"},[s("code",{class:""},"options.storage.mode")]),e(". The "),s("code",{class:""},"LocalStorage"),e(" is only available on browsers and the "),s("code",{class:""},"MemoryStorage"),e(" is not persistent, i.e., once you leave the tab or quit the process, you will need to authenticate again.")],-1),Ss=s("p",null,[e("If you want to use multiple instances of the SDK you should set a different "),s("a",{href:"#options.storage.prefix"},[s("code",{class:""},"prefix")]),e(" for each one.")],-1),Ds=s("h2",{id:"items"},[e("Items "),s("a",{class:"header-anchor",href:"#items"},"#")],-1),Ts=s("p",null,[e("You can get an instance of the item handler by providing the collection (and type, in the case of TypeScript) to the "),s("code",{class:""},"items"),e(" function. The following examples will use the "),s("code",{class:""},"Article"),e(" type.")],-1),xs=s("blockquote",null,[s("p",null,"JavaScript")],-1),Is=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"// import { Directus, ID } from '@directus/sdk';"),e(`
 `),s("span",{class:"hljs-keyword"},"const"),e(" { Directus } = "),s("span",{class:"hljs-built_in"},"require"),e("("),s("span",{class:"hljs-string"},"'@directus/sdk'"),e(`);
 
 `),s("span",{class:"hljs-keyword"},"const"),e(" directus = "),s("span",{class:"hljs-keyword"},"new"),e(" Directus("),s("span",{class:"hljs-string"},"'http://directus.example.com'"),e(`);
@@ -253,14 +253,14 @@ me.experience = `),s("span",{class:"hljs-string"},"'high'"),e(`;
 	`),s("span",{class:"hljs-attr"},"limit"),e(": -"),s("span",{class:"hljs-number"},"1"),e(`,
 });
 `)])],-1),Ns=s("h3",{id:"read-single-item"},[e("Read Single Item "),s("a",{class:"header-anchor",href:"#read-single-item"},"#")],-1),Fs=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" articles.readOne("),s("span",{class:"hljs-number"},"15"),e(`);
-`)])],-1),Ks=s("p",null,"Supports optional query:",-1),Ws=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" articles.readOne("),s("span",{class:"hljs-number"},"15"),e(`, {
+`)])],-1),Ks=s("p",null,"Supports optional query:",-1),Ls=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" articles.readOne("),s("span",{class:"hljs-number"},"15"),e(`, {
 	`),s("span",{class:"hljs-attr"},"fields"),e(": ["),s("span",{class:"hljs-string"},"'title'"),e(`],
 });
-`)])],-1),Ls=s("h3",{id:"read-multiple-items"},[e("Read Multiple Items "),s("a",{class:"header-anchor",href:"#read-multiple-items"},"#")],-1),Js=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" articles.readMany(["),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"16"),e(", "),s("span",{class:"hljs-number"},"17"),e(`]);
-`)])],-1),zs=s("p",null,"Supports optional query:",-1),Hs=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" articles.readMany(["),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"16"),e(", "),s("span",{class:"hljs-number"},"17"),e(`], {
+`)])],-1),Ws=s("h3",{id:"read-multiple-items"},[e("Read Multiple Items "),s("a",{class:"header-anchor",href:"#read-multiple-items"},"#")],-1),Js=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" articles.readMany(["),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"16"),e(", "),s("span",{class:"hljs-number"},"17"),e(`]);
+`)])],-1),Hs=s("p",null,"Supports optional query:",-1),Vs=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" articles.readMany(["),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"16"),e(", "),s("span",{class:"hljs-number"},"17"),e(`], {
 	`),s("span",{class:"hljs-attr"},"fields"),e(": ["),s("span",{class:"hljs-string"},"'title'"),e(`],
 });
-`)])],-1),Vs=s("h3",{id:"update-single-item"},[e("Update Single Item "),s("a",{class:"header-anchor",href:"#update-single-item"},"#")],-1),Gs=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" articles.updateOne("),s("span",{class:"hljs-number"},"15"),e(`, {
+`)])],-1),zs=s("h3",{id:"update-single-item"},[e("Update Single Item "),s("a",{class:"header-anchor",href:"#update-single-item"},"#")],-1),Gs=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" articles.updateOne("),s("span",{class:"hljs-number"},"15"),e(`, {
 	`),s("span",{class:"hljs-attr"},"title"),e(": "),s("span",{class:"hljs-string"},"'This articles now has a different title'"),e(`,
 });
 `)])],-1),Ys=s("p",null,"Supports optional query:",-1),Qs=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` articles.updateOne(
@@ -284,12 +284,12 @@ me.experience = `),s("span",{class:"hljs-string"},"'high'"),e(`;
 		`),s("span",{class:"hljs-attr"},"fields"),e(": ["),s("span",{class:"hljs-string"},"'title'"),e(`],
 	}
 );
-`)])],-1),ee=s("h3",{id:"delete"},[e("Delete "),s("a",{class:"header-anchor",href:"#delete"},"#")],-1),te=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"// One"),e(`
+`)])],-1),ee=s("h3",{id:"delete"},[e("Delete "),s("a",{class:"header-anchor",href:"#delete"},"#")],-1),ae=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"// One"),e(`
 `),s("span",{class:"hljs-keyword"},"await"),e(" articles.deleteOne("),s("span",{class:"hljs-number"},"15"),e(`);
 
 `),s("span",{class:"hljs-comment"},"// Multiple"),e(`
 `),s("span",{class:"hljs-keyword"},"await"),e(" articles.deleteMany(["),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"42"),e(`]);
-`)])],-1),ae=s("h3",{id:"request-parameter-overrides"},[e("Request Parameter Overrides "),s("a",{class:"header-anchor",href:"#request-parameter-overrides"},"#")],-1),ne=s("p",null,[e("To override any of the axios request parameters, provide an additional parameter with a "),s("code",null,"requestOptions"),e(" object:")],-1),le=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` articles.createOne(
+`)])],-1),te=s("h3",{id:"request-parameter-overrides"},[e("Request Parameter Overrides "),s("a",{class:"header-anchor",href:"#request-parameter-overrides"},"#")],-1),ne=s("p",null,[e("To override any of the axios request parameters, provide an additional parameter with a "),s("code",{class:""},"requestOptions"),e(" object:")],-1),le=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` articles.createOne(
 	{ `),s("span",{class:"hljs-attr"},"title"),e(": "),s("span",{class:"hljs-string"},"'example'"),e(` },
 	{ `),s("span",{class:"hljs-attr"},"fields"),e(": ["),s("span",{class:"hljs-string"},"'id'"),e(`] },
 	{
@@ -301,11 +301,11 @@ me.experience = `),s("span",{class:"hljs-string"},"'high'"),e(`;
 	}
 );
 `)])],-1),oe=s("h2",{id:"activity"},[e("Activity "),s("a",{class:"header-anchor",href:"#activity"},"#")],-1),ce=s("pre",null,[s("code",{class:"language-js"},`directus.activity;
-`)],-1),ie=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_activity")'),e(".")],-1),re=s("h2",{id:"comments"},[e("Comments "),s("a",{class:"header-anchor",href:"#comments"},"#")],-1),he=s("pre",null,[s("code",{class:"language-js"},`directus.comments;
-`)],-1),de=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_comments")'),e(".")],-1),pe=s("h2",{id:"collections"},[e("Collections "),s("a",{class:"header-anchor",href:"#collections"},"#")],-1),ue=s("pre",null,[s("code",{class:"language-js"},`directus.collections;
-`)],-1),je=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_collections")'),e(".")],-1),me=s("h2",{id:"fields"},[e("Fields "),s("a",{class:"header-anchor",href:"#fields"},"#")],-1),ge=s("pre",null,[s("code",{class:"language-js"},`directus.fields;
-`)],-1),_e=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_fields")'),e(".")],-1),fe=s("h2",{id:"files"},[e("Files "),s("a",{class:"header-anchor",href:"#files"},"#")],-1),ye=s("pre",null,[s("code",{class:"language-js"},`directus.files;
-`)],-1),we=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_files")'),e(".")],-1),ke=s("h3",{id:"uploading-a-file"},[e("Uploading a file "),s("a",{class:"header-anchor",href:"#uploading-a-file"},"#")],-1),be=s("p",null,[e("To upload a file you will need to send a "),s("code",null,"multipart/form-data"),e(" as body. On browser side you do so:")],-1),ve=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"/* index.js */"),e(`
+`)],-1),ie=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_activity")'),e(".")],-1),re=s("h2",{id:"comments"},[e("Comments "),s("a",{class:"header-anchor",href:"#comments"},"#")],-1),he=s("pre",null,[s("code",{class:"language-js"},`directus.comments;
+`)],-1),de=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_comments")'),e(".")],-1),pe=s("h2",{id:"collections"},[e("Collections "),s("a",{class:"header-anchor",href:"#collections"},"#")],-1),ue=s("pre",null,[s("code",{class:"language-js"},`directus.collections;
+`)],-1),je=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_collections")'),e(".")],-1),me=s("h2",{id:"fields"},[e("Fields "),s("a",{class:"header-anchor",href:"#fields"},"#")],-1),_e=s("pre",null,[s("code",{class:"language-js"},`directus.fields;
+`)],-1),ge=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_fields")'),e(".")],-1),fe=s("h2",{id:"files"},[e("Files "),s("a",{class:"header-anchor",href:"#files"},"#")],-1),ye=s("pre",null,[s("code",{class:"language-js"},`directus.files;
+`)],-1),we=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_files")'),e(".")],-1),ke=s("h3",{id:"uploading-a-file"},[e("Uploading a file "),s("a",{class:"header-anchor",href:"#uploading-a-file"},"#")],-1),be=s("p",null,[e("To upload a file you will need to send a "),s("code",{class:""},"multipart/form-data"),e(" as body. On browser side you do so:")],-1),ve=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"/* index.js */"),e(`
 `),s("span",{class:"hljs-keyword"},"import"),e(" { Directus } "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'https://unpkg.com/@directus/sdk@latest/dist/sdk.esm.min.js'"),e(`;
 
 `),s("span",{class:"hljs-keyword"},"const"),e(" directus = "),s("span",{class:"hljs-keyword"},"new"),e(" Directus("),s("span",{class:"hljs-string"},"'http://localhost:8055'"),e(`, {
@@ -365,29 +365,29 @@ form.append(`),s("span",{class:"hljs-string"},'"file"'),e(", fs.createReadStream
 	},
 });
 `)])],-1),Oe=s("h2",{id:"folders"},[e("Folders "),s("a",{class:"header-anchor",href:"#folders"},"#")],-1),Pe=s("pre",null,[s("code",{class:"language-js"},`directus.folders;
-`)],-1),Ue=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_folders")'),e(".")],-1),Ee=s("h2",{id:"permissions"},[e("Permissions "),s("a",{class:"header-anchor",href:"#permissions"},"#")],-1),Ne=s("pre",null,[s("code",{class:"language-js"},`directus.permissions;
-`)],-1),Fe=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_permissions")'),e(".")],-1),Ke=s("h2",{id:"presets"},[e("Presets "),s("a",{class:"header-anchor",href:"#presets"},"#")],-1),We=s("pre",null,[s("code",{class:"language-js"},`directus.presets;
-`)],-1),Le=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_presets")'),e(".")],-1),Je=s("h2",{id:"relations"},[e("Relations "),s("a",{class:"header-anchor",href:"#relations"},"#")],-1),ze=s("pre",null,[s("code",{class:"language-js"},`directus.relations;
-`)],-1),He=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_relations")'),e(".")],-1),Ve=s("h2",{id:"revisions"},[e("Revisions "),s("a",{class:"header-anchor",href:"#revisions"},"#")],-1),Ge=s("pre",null,[s("code",{class:"language-js"},`directus.revisions;
-`)],-1),Ye=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_revisions")'),e(".")],-1),Qe=s("h2",{id:"roles"},[e("Roles "),s("a",{class:"header-anchor",href:"#roles"},"#")],-1),$e=s("pre",null,[s("code",{class:"language-js"},`directus.roles;
-`)],-1),Xe=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_roles")'),e(".")],-1),Ze=s("h2",{id:"settings"},[e("Settings "),s("a",{class:"header-anchor",href:"#settings"},"#")],-1),st=s("pre",null,[s("code",{class:"language-js"},`directus.settings;
-`)],-1),et=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_settings")'),e(".")],-1),tt=s("h2",{id:"server"},[e("Server "),s("a",{class:"header-anchor",href:"#server"},"#")],-1),at=s("h3",{id:"ping-the-server"},[e("Ping the Server "),s("a",{class:"header-anchor",href:"#ping-the-server"},"#")],-1),nt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.server.ping();
-`)])],-1),lt=s("h3",{id:"get-server%2Fproject-info"},[e("Get Server/Project Info "),s("a",{class:"header-anchor",href:"#get-server%2Fproject-info"},"#")],-1),ot=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.server.info();
-`)])],-1),ct=s("h2",{id:"users"},[e("Users "),s("a",{class:"header-anchor",href:"#users"},"#")],-1),it=s("pre",null,[s("code",{class:"language-js"},`directus.users;
-`)],-1),rt=s("p",null,[e("Same methods as "),s("code",null,'directus.items("directus_users")'),e(", and:")],-1),ht=s("h3",{id:"invite-a-new-user"},[e("Invite a New User "),s("a",{class:"header-anchor",href:"#invite-a-new-user"},"#")],-1),dt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.invites.send("),s("span",{class:"hljs-string"},"'admin@example.com'"),e(", "),s("span",{class:"hljs-string"},"'fe38136e-52f7-4622-8498-112b8a32a1e2'"),e(`);
-`)])],-1),pt=s("p",null,"The second parameter is the role of the user",-1),ut=s("h3",{id:"accept-a-user-invite"},[e("Accept a User Invite "),s("a",{class:"header-anchor",href:"#accept-a-user-invite"},"#")],-1),jt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.invites.accept("),s("span",{class:"hljs-string"},"'<accept-token>'"),e(", "),s("span",{class:"hljs-string"},"'n3w-p455w0rd'"),e(`);
-`)])],-1),mt=s("p",null,"The provided token is sent to the user\u2019s email",-1),gt=s("h3",{id:"enable-two-factor-authentication"},[e("Enable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#enable-two-factor-authentication"},"#")],-1),_t=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.tfa.enable("),s("span",{class:"hljs-string"},"'my-password'"),e(`);
-`)])],-1),ft=s("h3",{id:"disable-two-factor-authentication"},[e("Disable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#disable-two-factor-authentication"},"#")],-1),yt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.tfa.disable("),s("span",{class:"hljs-string"},"'691402'"),e(`);
-`)])],-1),wt=s("h3",{id:"get-the-current-user"},[e("Get the Current User "),s("a",{class:"header-anchor",href:"#get-the-current-user"},"#")],-1),kt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.users.me.read();
-`)])],-1),bt=s("p",null,"Supports optional query:",-1),vt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.users.me.read({
+`)],-1),Ue=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_folders")'),e(".")],-1),Ee=s("h2",{id:"permissions"},[e("Permissions "),s("a",{class:"header-anchor",href:"#permissions"},"#")],-1),Ne=s("pre",null,[s("code",{class:"language-js"},`directus.permissions;
+`)],-1),Fe=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_permissions")'),e(".")],-1),Ke=s("h2",{id:"presets"},[e("Presets "),s("a",{class:"header-anchor",href:"#presets"},"#")],-1),Le=s("pre",null,[s("code",{class:"language-js"},`directus.presets;
+`)],-1),We=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_presets")'),e(".")],-1),Je=s("h2",{id:"relations"},[e("Relations "),s("a",{class:"header-anchor",href:"#relations"},"#")],-1),He=s("pre",null,[s("code",{class:"language-js"},`directus.relations;
+`)],-1),Ve=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_relations")'),e(".")],-1),ze=s("h2",{id:"revisions"},[e("Revisions "),s("a",{class:"header-anchor",href:"#revisions"},"#")],-1),Ge=s("pre",null,[s("code",{class:"language-js"},`directus.revisions;
+`)],-1),Ye=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_revisions")'),e(".")],-1),Qe=s("h2",{id:"roles"},[e("Roles "),s("a",{class:"header-anchor",href:"#roles"},"#")],-1),$e=s("pre",null,[s("code",{class:"language-js"},`directus.roles;
+`)],-1),Xe=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_roles")'),e(".")],-1),Ze=s("h2",{id:"settings"},[e("Settings "),s("a",{class:"header-anchor",href:"#settings"},"#")],-1),sa=s("pre",null,[s("code",{class:"language-js"},`directus.settings;
+`)],-1),ea=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_settings")'),e(".")],-1),aa=s("h2",{id:"server"},[e("Server "),s("a",{class:"header-anchor",href:"#server"},"#")],-1),ta=s("h3",{id:"ping-the-server"},[e("Ping the Server "),s("a",{class:"header-anchor",href:"#ping-the-server"},"#")],-1),na=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.server.ping();
+`)])],-1),la=s("h3",{id:"get-server%2Fproject-info"},[e("Get Server/Project Info "),s("a",{class:"header-anchor",href:"#get-server%2Fproject-info"},"#")],-1),oa=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.server.info();
+`)])],-1),ca=s("h2",{id:"users"},[e("Users "),s("a",{class:"header-anchor",href:"#users"},"#")],-1),ia=s("pre",null,[s("code",{class:"language-js"},`directus.users;
+`)],-1),ra=s("p",null,[e("Same methods as "),s("code",{class:""},'directus.items("directus_users")'),e(", and:")],-1),ha=s("h3",{id:"invite-a-new-user"},[e("Invite a New User "),s("a",{class:"header-anchor",href:"#invite-a-new-user"},"#")],-1),da=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.invites.send("),s("span",{class:"hljs-string"},"'admin@example.com'"),e(", "),s("span",{class:"hljs-string"},"'fe38136e-52f7-4622-8498-112b8a32a1e2'"),e(`);
+`)])],-1),pa=s("p",null,"The second parameter is the role of the user",-1),ua=s("h3",{id:"accept-a-user-invite"},[e("Accept a User Invite "),s("a",{class:"header-anchor",href:"#accept-a-user-invite"},"#")],-1),ja=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.invites.accept("),s("span",{class:"hljs-string"},"'<accept-token>'"),e(", "),s("span",{class:"hljs-string"},"'n3w-p455w0rd'"),e(`);
+`)])],-1),ma=s("p",null,"The provided token is sent to the user\u2019s email",-1),_a=s("h3",{id:"enable-two-factor-authentication"},[e("Enable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#enable-two-factor-authentication"},"#")],-1),ga=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.tfa.enable("),s("span",{class:"hljs-string"},"'my-password'"),e(`);
+`)])],-1),fa=s("h3",{id:"disable-two-factor-authentication"},[e("Disable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#disable-two-factor-authentication"},"#")],-1),ya=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.tfa.disable("),s("span",{class:"hljs-string"},"'691402'"),e(`);
+`)])],-1),wa=s("h3",{id:"get-the-current-user"},[e("Get the Current User "),s("a",{class:"header-anchor",href:"#get-the-current-user"},"#")],-1),ka=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.users.me.read();
+`)])],-1),ba=s("p",null,"Supports optional query:",-1),va=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.users.me.read({
 	`),s("span",{class:"hljs-attr"},"fields"),e(": ["),s("span",{class:"hljs-string"},"'last_access'"),e(`],
 });
-`)])],-1),St=s("h3",{id:"update-the-current-users"},[e("Update the Current Users "),s("a",{class:"header-anchor",href:"#update-the-current-users"},"#")],-1),Dt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.me.update({ "),s("span",{class:"hljs-attr"},"first_name"),e(": "),s("span",{class:"hljs-string"},"'Admin'"),e(` });
-`)])],-1),Tt=s("p",null,"Supports optional query:",-1),xt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.me.update({ "),s("span",{class:"hljs-attr"},"first_name"),e(": "),s("span",{class:"hljs-string"},"'Admin'"),e(" }, { "),s("span",{class:"hljs-attr"},"fields"),e(": ["),s("span",{class:"hljs-string"},"'last_access'"),e(`] });
-`)])],-1),It=s("h2",{id:"utils"},[e("Utils "),s("a",{class:"header-anchor",href:"#utils"},"#")],-1),At=s("h3",{id:"get-a-random-string"},[e("Get a Random String "),s("a",{class:"header-anchor",href:"#get-a-random-string"},"#")],-1),Rt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.utils.random.string();
-`)])],-1),qt=s("p",null,[e("Supports an optional "),s("code",null,"length"),e(" (defaults to 32):")],-1),Bt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.random.string("),s("span",{class:"hljs-number"},"50"),e(`);
-`)])],-1),Mt=s("h3",{id:"generate-a-hash-for-a-given-value"},[e("Generate a Hash for a Given Value "),s("a",{class:"header-anchor",href:"#generate-a-hash-for-a-given-value"},"#")],-1),Ct=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.hash.generate("),s("span",{class:"hljs-string"},"'My String'"),e(`);
-`)])],-1),Ot=s("h3",{id:"verify-if-a-hash-is-valid"},[e("Verify if a Hash is Valid "),s("a",{class:"header-anchor",href:"#verify-if-a-hash-is-valid"},"#")],-1),Pt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.hash.verify("),s("span",{class:"hljs-string"},"'My String'"),e(", "),s("span",{class:"hljs-string"},"'$argon2i$v=19$m=4096,t=3,p=1$A5uogJh'"),e(`);
-`)])],-1),Ut=s("h3",{id:"sort-items-in-a-collection"},[e("Sort Items in a Collection "),s("a",{class:"header-anchor",href:"#sort-items-in-a-collection"},"#")],-1),Et=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.sort("),s("span",{class:"hljs-string"},"'articles'"),e(", "),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"42"),e(`);
-`)])],-1),Nt=s("p",null,[e("This will move item "),s("code",null,"15"),e(" to the position of item "),s("code",null,"42"),e(", and move everything in between one \u201Cslot\u201D up.")],-1),Ft=s("h3",{id:"revert-to-a-previous-revision"},[e("Revert to a Previous Revision "),s("a",{class:"header-anchor",href:"#revert-to-a-previous-revision"},"#")],-1),Kt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.revert("),s("span",{class:"hljs-number"},"451"),e(`);
-`)])],-1),Wt=s("p",null,"Note: The key passed is the primary key of the revision you\u2019d like to apply.",-1),Lt=s("hr",null,null,-1),Gt={setup(Jt,{expose:c}){const a={title:"JavaScript SDK",modularExtension:!1};return c({frontmatter:a}),(zt,Ht)=>{const n=l("router-link"),i=l("DocsWrapper");return r(),h(i,{frontmatter:a},{default:t(()=>[s("div",d,[p,u,j,m,g,_,f,y,w,k,b,v,S,D,T,x,I,A,R,q,B,M,C,O,P,U,E,N,F,K,W,L,J,z,H,s("div",V,[G,s("p",null,[Y,o(n,{to:"/docs/configuration/config-options/#security"},{default:t(()=>[Q]),_:1}),$])]),X,Z,ss,es,ts,as,ns,ls,os,cs,is,rs,hs,ds,ps,us,js,ms,gs,_s,fs,ys,ws,ks,bs,vs,Ss,Ds,Ts,xs,Is,As,Rs,qs,Bs,Ms,Cs,Os,Ps,Us,Es,Ns,Fs,Ks,Ws,Ls,Js,zs,Hs,Vs,Gs,Ys,Qs,$s,Xs,Zs,se,ee,te,ae,ne,le,oe,ce,ie,re,he,de,pe,ue,je,me,ge,_e,fe,ye,we,ke,be,ve,Se,De,Te,xe,Ie,s("p",null,[Ae,o(n,{to:"/docs/reference/files/#import-a-file"},{default:t(()=>[Re]),_:1}),qe]),Be,Me,Ce,Oe,Pe,Ue,Ee,Ne,Fe,Ke,We,Le,Je,ze,He,Ve,Ge,Ye,Qe,$e,Xe,Ze,st,et,tt,at,nt,lt,ot,ct,it,rt,ht,dt,pt,ut,jt,mt,gt,_t,ft,yt,wt,kt,bt,vt,St,Dt,Tt,xt,It,At,Rt,qt,Bt,Mt,Ct,Ot,Pt,Ut,Et,Nt,Ft,Kt,Wt,Lt])]),_:1})}}};export{Gt as default};
+`)])],-1),Sa=s("h3",{id:"update-the-current-users"},[e("Update the Current Users "),s("a",{class:"header-anchor",href:"#update-the-current-users"},"#")],-1),Da=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.me.update({ "),s("span",{class:"hljs-attr"},"first_name"),e(": "),s("span",{class:"hljs-string"},"'Admin'"),e(` });
+`)])],-1),Ta=s("p",null,"Supports optional query:",-1),xa=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.users.me.update({ "),s("span",{class:"hljs-attr"},"first_name"),e(": "),s("span",{class:"hljs-string"},"'Admin'"),e(" }, { "),s("span",{class:"hljs-attr"},"fields"),e(": ["),s("span",{class:"hljs-string"},"'last_access'"),e(`] });
+`)])],-1),Ia=s("h2",{id:"utils"},[e("Utils "),s("a",{class:"header-anchor",href:"#utils"},"#")],-1),Aa=s("h3",{id:"get-a-random-string"},[e("Get a Random String "),s("a",{class:"header-anchor",href:"#get-a-random-string"},"#")],-1),Ra=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(` directus.utils.random.string();
+`)])],-1),qa=s("p",null,[e("Supports an optional "),s("code",{class:""},"length"),e(" (defaults to 32):")],-1),Ba=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.random.string("),s("span",{class:"hljs-number"},"50"),e(`);
+`)])],-1),Ma=s("h3",{id:"generate-a-hash-for-a-given-value"},[e("Generate a Hash for a Given Value "),s("a",{class:"header-anchor",href:"#generate-a-hash-for-a-given-value"},"#")],-1),Ca=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.hash.generate("),s("span",{class:"hljs-string"},"'My String'"),e(`);
+`)])],-1),Oa=s("h3",{id:"verify-if-a-hash-is-valid"},[e("Verify if a Hash is Valid "),s("a",{class:"header-anchor",href:"#verify-if-a-hash-is-valid"},"#")],-1),Pa=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.hash.verify("),s("span",{class:"hljs-string"},"'My String'"),e(", "),s("span",{class:"hljs-string"},"'$argon2i$v=19$m=4096,t=3,p=1$A5uogJh'"),e(`);
+`)])],-1),Ua=s("h3",{id:"sort-items-in-a-collection"},[e("Sort Items in a Collection "),s("a",{class:"header-anchor",href:"#sort-items-in-a-collection"},"#")],-1),Ea=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.sort("),s("span",{class:"hljs-string"},"'articles'"),e(", "),s("span",{class:"hljs-number"},"15"),e(", "),s("span",{class:"hljs-number"},"42"),e(`);
+`)])],-1),Na=s("p",null,[e("This will move item "),s("code",{class:""},"15"),e(" to the position of item "),s("code",{class:""},"42"),e(", and move everything in between one \u201Cslot\u201D up.")],-1),Fa=s("h3",{id:"revert-to-a-previous-revision"},[e("Revert to a Previous Revision "),s("a",{class:"header-anchor",href:"#revert-to-a-previous-revision"},"#")],-1),Ka=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),e(" directus.utils.revert("),s("span",{class:"hljs-number"},"451"),e(`);
+`)])],-1),La=s("p",null,"Note: The key passed is the primary key of the revision you\u2019d like to apply.",-1),Wa=s("hr",null,null,-1),Ja={title:"JavaScript SDK",modularExtension:!1},Ha={name:"sdk",setup(Va,{expose:c}){return c({frontmatter:{title:"JavaScript SDK",modularExtension:!1}}),(za,Ga)=>{const t=n("router-link"),i=n("docswrapper");return r(),h(i,{frontmatter:Ja},{default:a(()=>[s("div",d,[p,u,j,m,_,g,f,y,w,k,b,v,S,D,T,x,I,A,R,q,B,M,C,O,P,U,E,N,F,K,L,W,J,H,V,s("div",z,[G,s("p",null,[Y,l(t,{to:"/docs/configuration/config-options/#security"},{default:a(()=>[Q]),_:1}),$])]),X,Z,ss,es,as,ts,ns,ls,os,cs,is,rs,hs,ds,ps,us,js,ms,_s,gs,fs,ys,ws,ks,bs,vs,Ss,Ds,Ts,xs,Is,As,Rs,qs,Bs,Ms,Cs,Os,Ps,Us,Es,Ns,Fs,Ks,Ls,Ws,Js,Hs,Vs,zs,Gs,Ys,Qs,$s,Xs,Zs,se,ee,ae,te,ne,le,oe,ce,ie,re,he,de,pe,ue,je,me,_e,ge,fe,ye,we,ke,be,ve,Se,De,Te,xe,Ie,s("p",null,[Ae,l(t,{to:"/docs/reference/files/#import-a-file"},{default:a(()=>[Re]),_:1}),qe]),Be,Me,Ce,Oe,Pe,Ue,Ee,Ne,Fe,Ke,Le,We,Je,He,Ve,ze,Ge,Ye,Qe,$e,Xe,Ze,sa,ea,aa,ta,na,la,oa,ca,ia,ra,ha,da,pa,ua,ja,ma,_a,ga,fa,ya,wa,ka,ba,va,Sa,Da,Ta,xa,Ia,Aa,Ra,qa,Ba,Ma,Ca,Oa,Pa,Ua,Ea,Na,Fa,Ka,La,Wa])]),_:1})}}};typeof o=="function"&&o(Ha);export{Ha as default,Ja as frontmatter};

package/dist/assets/security.8e2a8a41.js

@@ -0,0 +1 @@
+import{a as i,o as c,b as n,w as o,g as e,B as a}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const d=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,"TK")]),e("h2",{id:"https"},[a("HTTPS "),e("a",{class:"header-anchor",href:"#https"},"#")]),e("h2",{id:"password-salting%2Fhashing%2Falgorithm-%26-password-policy"},[a("Password Salting/Hashing/Algorithm & Password Policy "),e("a",{class:"header-anchor",href:"#password-salting%2Fhashing%2Falgorithm-%26-password-policy"},"#")]),e("h2",{id:"static-tokens"},[a("Static Tokens "),e("a",{class:"header-anchor",href:"#static-tokens"},"#")]),e("h2",{id:"encrypted-fields-%26-encrypted-database"},[a("Encrypted Fields & Encrypted Database "),e("a",{class:"header-anchor",href:"#encrypted-fields-%26-encrypted-database"},"#")]),e("h2",{id:"private-file-links"},[a("Private File Links "),e("a",{class:"header-anchor",href:"#private-file-links"},"#")]),e("h2",{id:"mfa-(required)-%26-sso"},[a("MFA (Required) & SSO "),e("a",{class:"header-anchor",href:"#mfa-(required)-%26-sso"},"#")]),e("h2",{id:"granular-access-control-%26-ip-white-listing-%26-app-access"},[a("Granular Access Control & IP WHite-Listing & App Access "),e("a",{class:"header-anchor",href:"#granular-access-control-%26-ip-white-listing-%26-app-access"},"#")]),e("h2",{id:"rate-limiting"},[a("Rate Limiting "),e("a",{class:"header-anchor",href:"#rate-limiting"},"#")]),e("h2",{id:"encrypted"},[a("Encrypted "),e("a",{class:"header-anchor",href:"#encrypted"},"#")]),e("h2",{id:"parameterized-database-queries"},[a("Parameterized Database Queries "),e("a",{class:"header-anchor",href:"#parameterized-database-queries"},"#")])],-1),l={title:"Security",modularExtension:!1},h={name:"security",setup(p,{expose:s}){return s({frontmatter:{title:"Security",modularExtension:!1}}),(f,u)=>{const t=i("docswrapper");return c(),n(t,{frontmatter:l},{default:o(()=>[d]),_:1})}}};typeof r=="function"&&r(h);export{h as default,l as frontmatter};

package/dist/assets/{server.3056da3b.js → server.9f12ae3e.js}

@@ -1,5 +1,5 @@
-import{w as t,y as h,z as i,A as n,E as s,C as r,W as e}from"./vendor.3b903562.js";const p={class:"markdown-body"},d={class:"two-up"},u={class:"left"},g=e("Provides detailed information about the project server, its schema, and its health. "),_=e("Learn more about Projects"),f=e("."),m=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#get-openapi-specification"},"Get OpenAPI Specification")]),s("li",null,[s("a",{href:"#get-graphql-sdl"},"Get GraphQL SDL")]),s("li",null,[s("a",{href:"#ping"},"Ping")]),s("li",null,[s("a",{href:"#info"},"Info")]),s("li",null,[s("a",{href:"#health"},"Health")])])])])],-1),j=s("hr",null,null,-1),y=s("h2",{id:"get-openapi-specification"},[e("Get OpenAPI Specification "),s("a",{class:"header-anchor",href:"#get-openapi-specification"},"#")],-1),v=s("p",null,"Retrieve the OpenAPI spec for the current project.",-1),b=s("div",{class:"two-up"},[s("div",{class:"left"},[s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"This OAS spec is based on the read permissions of the currently authenticated user.")]),s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")]),s("p",null,[e("Object conforming to "),s("a",{href:"https://swagger.io/specification/",target:"_blank",rel:"noopener noreferrer"},"the OpenAPI Specification")])]),s("div",{class:"right"},[s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")]),s("pre",null,[s("code",null,`GET /server/specs/oas
-`)]),s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+import{a as l,o as h,b as i,w as n,g as s,e as t,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const p={class:"markdown-body"},d={class:"two-up"},u={class:"left"},g=e("Provides detailed information about the project server, its schema, and its health. "),_=e("Learn more about Projects"),f=e("."),m=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#get-openapi-specification"},"Get OpenAPI Specification")]),s("li",null,[s("a",{href:"#get-graphql-sdl"},"Get GraphQL SDL")]),s("li",null,[s("a",{href:"#ping"},"Ping")]),s("li",null,[s("a",{href:"#info"},"Info")]),s("li",null,[s("a",{href:"#health"},"Health")])])])])],-1),j=s("hr",null,null,-1),y=s("h2",{id:"get-openapi-specification"},[e("Get OpenAPI Specification "),s("a",{class:"header-anchor",href:"#get-openapi-specification"},"#")],-1),v=s("p",null,"Retrieve the OpenAPI spec for the current project.",-1),b=s("div",{class:"two-up"},[s("div",{class:"left"},[s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"This OAS spec is based on the read permissions of the currently authenticated user.")]),s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")]),s("p",null,[e("Object conforming to "),s("a",{href:"https://swagger.io/specification/",target:"_blank",rel:"noopener noreferrer"},"the OpenAPI Specification")])]),s("div",{class:"right"},[s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")]),s("pre",null,[s("code",{class:""},`GET /server/specs/oas
+`)]),s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
 	server_specs_oas:`),s("span",{class:"hljs-type"}," String"),e(`
 }
@@ -23,25 +23,25 @@ import{w as t,y as h,z as i,A as n,E as s,C as r,W as e}from"./vendor.3b903562.j
   status:`),s("span",{class:"hljs-type"}," String"),e(`
 	`),s("span",{class:"hljs-keyword"},"..."),e(`
 `),s("span",{class:"hljs-comment"},"# etc"),e(`
-`)])])]),s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`GET /server/specs/graphql/
+`)])])]),s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /server/specs/graphql/
 GET /server/specs/graphql/system
-`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
 	server_specs_graphql(scope: graphql_sdl_scope):`),s("span",{class:"hljs-type"}," String"),e(`
 }
 `)])]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
 	server_specs_graphql(scope: `),s("span",{class:"hljs-string"},'"system"'),e(`)
 }
-`)])])])],-1),T=s("hr",null,null,-1),P=s("h2",{id:"ping"},[e("Ping "),s("a",{class:"header-anchor",href:"#ping"},"#")],-1),A=s("p",null,"Ping\u2026 pong! \u{1F3D3}",-1),G=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")]),s("p",null,"Pong.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`GET /server/ping
-`)]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)])])])],-1),T=s("hr",null,null,-1),P=s("h2",{id:"ping"},[e("Ping "),s("a",{class:"header-anchor",href:"#ping"},"#")],-1),x=s("p",null,"Ping\u2026 pong! \u{1F3D3}",-1),A=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")]),s("p",null,"Pong.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",{class:""},`GET /server/ping
+`)]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
 	server_ping:`),s("span",{class:"hljs-type"}," String"),e(`
 }
 `)])]),s("h5",{id:"example-3"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
 	server_ping
 }
-`)])])])],-1),I=s("hr",null,null,-1),x=s("h2",{id:"info"},[e("Info "),s("a",{class:"header-anchor",href:"#info"},"#")],-1),E=s("p",null,"Information about the current installation.",-1),R={class:"two-up"},L={class:"left"},Q=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The public information is returned for everybody. Admin users get additional information (see below).")],-1),O=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),D={class:"definitions"},C=s("p",null,[s("code",null,"project"),e(),s("strong",null,"object"),s("br"),e(" Public information about the project. Used to render the Admin App public pages.")],-1),H=e("See "),V=e("the settings object"),B=e(" for more information on the individual properties of the "),N=s("code",null,"project",-1),U=e(" object."),W=s("p",null,"Admin users also get the following information:",-1),z=s("div",{class:"definitions"},[s("p",null,[s("code",null,"directus.version"),e(),s("strong",null,"string"),s("br"),e(" Current version of Directus used.")]),s("p",null,[s("code",null,"node.version"),e(),s("strong",null,"string"),s("br"),e(" Current version of Node used.")]),s("p",null,[s("code",null,"node.uptime"),e(),s("strong",null,"integer"),s("br"),e(" How long the current process has been running.")]),s("p",null,[s("code",null,"os.type"),e(),s("strong",null,"string"),s("br"),e(" What type of operation system is used.")]),s("p",null,[s("code",null,"os.version"),e(),s("strong",null,"string"),s("br"),e(" What version of the operation system is used.")]),s("p",null,[s("code",null,"os.uptime"),e(),s("strong",null,"string"),s("br"),e(" How long the operating system has been up.")]),s("p",null,[s("code",null,"os.totalmem"),e(),s("strong",null,"string"),s("br"),e(" How much memory is available on the operating system.")])],-1),F=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`GET /server/info
-`)]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)])])])],-1),G=s("hr",null,null,-1),I=s("h2",{id:"info"},[e("Info "),s("a",{class:"header-anchor",href:"#info"},"#")],-1),E=s("p",null,"Information about the current installation.",-1),R={class:"two-up"},L={class:"left"},Q=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The public information is returned for everybody. Admin users get additional information (see below).")],-1),O=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),D={class:"definitions"},C=s("p",null,[s("code",{class:""},"project"),e(),s("strong",null,"object"),s("br"),e(" Public information about the project. Used to render the Admin App public pages.")],-1),H=e("See "),B=e("the settings object"),V=e(" for more information on the individual properties of the "),N=s("code",{class:""},"project",-1),U=e(" object."),W=s("p",null,"Admin users also get the following information:",-1),z=s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"directus.version"),e(),s("strong",null,"string"),s("br"),e(" Current version of Directus used.")]),s("p",null,[s("code",{class:""},"node.version"),e(),s("strong",null,"string"),s("br"),e(" Current version of Node used.")]),s("p",null,[s("code",{class:""},"node.uptime"),e(),s("strong",null,"integer"),s("br"),e(" How long the current process has been running.")]),s("p",null,[s("code",{class:""},"os.type"),e(),s("strong",null,"string"),s("br"),e(" What type of operation system is used.")]),s("p",null,[s("code",{class:""},"os.version"),e(),s("strong",null,"string"),s("br"),e(" What version of the operation system is used.")]),s("p",null,[s("code",{class:""},"os.uptime"),e(),s("strong",null,"string"),s("br"),e(" How long the operating system has been up.")]),s("p",null,[s("code",{class:""},"os.totalmem"),e(),s("strong",null,"string"),s("br"),e(" How much memory is available on the operating system.")])],-1),F=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",{class:""},`GET /server/info
+`)]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
 	server_info: server_info
 }
@@ -52,7 +52,7 @@ GET /server/specs/graphql/system
 		}
 	}
 }
-`)])])],-1),J=s("hr",null,null,-1),K=s("h2",{id:"health"},[e("Health "),s("a",{class:"header-anchor",href:"#health"},"#")],-1),M=s("p",null,"Get the current health status of the server.",-1),X=s("div",{class:"two-up"},[s("div",{class:"left"},[s("p",null,[e("The "),s("code",null,"/server/health"),e(" endpoint shows you a general health status for the server and all connected (third party) services, such as Redis or S3.")]),s("p",null,[e("The output is based on the \u201CHealth Check Response for HTTP APIs\u201D draft spec: "),s("a",{href:"https://tools.ietf.org/id/draft-inadarei-api-health-check-05.html",target:"_blank",rel:"noopener noreferrer"},"Health Check Response Format for HTTP APIs Draft Specification"),e(".")]),s("p",null,"This endpoint can be used to ensure a healthy system when running in a horizontally scaled setup, like Kubernetes, Google Cloud Platform or AWS Elastic Beanstalk."),s("p",null,[e("By default, the endpoint only returns a "),s("code",null,"status"),e(" of "),s("code",null,"ok"),e(", "),s("code",null,"warn"),e(" or "),s("code",null,"error"),e(". By authenticating as an admin, it will return more in-depth information about the current health status of the system.")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// Response"),e(`
+`)])])],-1),J=s("hr",null,null,-1),K=s("h2",{id:"health"},[e("Health "),s("a",{class:"header-anchor",href:"#health"},"#")],-1),M=s("p",null,"Get the current health status of the server.",-1),X=s("div",{class:"two-up"},[s("div",{class:"left"},[s("p",null,[e("The "),s("code",{class:""},"/server/health"),e(" endpoint shows you a general health status for the server and all connected (third party) services, such as Redis or S3.")]),s("p",null,[e("The output is based on the \u201CHealth Check Response for HTTP APIs\u201D draft spec: "),s("a",{href:"https://tools.ietf.org/id/draft-inadarei-api-health-check-05.html",target:"_blank",rel:"noopener noreferrer"},"Health Check Response Format for HTTP APIs Draft Specification"),e(".")]),s("p",null,"This endpoint can be used to ensure a healthy system when running in a horizontally scaled setup, like Kubernetes, Google Cloud Platform or AWS Elastic Beanstalk."),s("p",null,[e("By default, the endpoint only returns a "),s("code",{class:""},"status"),e(" of "),s("code",{class:""},"ok"),e(", "),s("code",{class:""},"warn"),e(" or "),s("code",{class:""},"error"),e(". By authenticating as an admin, it will return more in-depth information about the current health status of the system.")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// Response"),e(`
 
 `),s("span",{class:"hljs-comment"},"// Non-admin"),e(`
 {
@@ -103,12 +103,12 @@ GET /server/specs/graphql/system
     ]
   }
 }
-`)])]),s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"status"),e(),s("strong",null,"string"),s("br"),e(" One of "),s("code",null,"ok"),e(", "),s("code",null,"warn"),e(", "),s("code",null,"error"),e(".")])]),s("p",null,"Authenticated admin users also get the following information:"),s("div",{class:"definitions"},[s("p",null,[s("code",null,"releaseId"),e(),s("strong",null,"string"),s("br"),e(" Directus version in use.")]),s("p",null,[s("code",null,"serviceId"),e(),s("strong",null,"string"),s("br"),e(" UUID of the current Directus instance.")]),s("p",null,[s("code",null,"checks"),e(),s("strong",null,"array"),s("br"),e(" Array with the status of all individually connected services.")])])]),s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`GET /server/health
-`)]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)])]),s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"status"),e(),s("strong",null,"string"),s("br"),e(" One of "),s("code",{class:""},"ok"),e(", "),s("code",{class:""},"warn"),e(", "),s("code",{class:""},"error"),e(".")])]),s("p",null,"Authenticated admin users also get the following information:"),s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"releaseId"),e(),s("strong",null,"string"),s("br"),e(" Directus version in use.")]),s("p",null,[s("code",{class:""},"serviceId"),e(),s("strong",null,"string"),s("br"),e(" UUID of the current Directus instance.")]),s("p",null,[s("code",{class:""},"checks"),e(),s("strong",null,"array"),s("br"),e(" Array with the status of all individually connected services.")])])]),s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",{class:""},`GET /server/health
+`)]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
 	server_health:`),s("span",{class:"hljs-literal"}," JSON"),e(`
 }
 `)])]),s("h5",{id:"example-5"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
 	server_health
 }
-`)])])])],-1),Y=s("hr",null,null,-1),ns={setup(Z,{expose:o}){const l={title:"Server",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:l}),($,ss)=>{const a=t("router-link"),c=t("DocsWrapper");return h(),i(c,{frontmatter:l},{default:n(()=>[s("div",p,[s("div",d,[s("div",u,[s("blockquote",null,[s("p",null,[g,r(a,{to:"/docs/getting-started/glossary/#projects"},{default:n(()=>[_]),_:1}),f])])]),m]),j,y,v,b,q,k,w,S,T,P,A,G,I,x,E,s("div",R,[s("div",L,[Q,O,s("div",D,[C,s("p",null,[H,r(a,{to:"/docs/reference/system/settings/#the-settings-object"},{default:n(()=>[V]),_:1}),B,N,U])]),W,z]),F]),J,K,M,X,Y])]),_:1})}}};export{ns as default};
+`)])])])],-1),Y=s("hr",null,null,-1),Z={title:"Server",modularExtension:!1,pageClass:"page-reference"},$={name:"server",setup(ss,{expose:o}){return o({frontmatter:{title:"Server",modularExtension:!1,pageClass:"page-reference"}}),(es,ns)=>{const a=l("router-link"),c=l("docswrapper");return h(),i(c,{frontmatter:Z},{default:n(()=>[s("div",p,[s("div",d,[s("div",u,[s("blockquote",null,[s("p",null,[g,t(a,{to:"/docs/getting-started/glossary/#projects"},{default:n(()=>[_]),_:1}),f])])]),m]),j,y,v,b,q,k,w,S,T,P,x,A,G,I,E,s("div",R,[s("div",L,[Q,O,s("div",D,[C,s("p",null,[H,t(a,{to:"/docs/reference/system/settings/#the-settings-object"},{default:n(()=>[B]),_:1}),V,N,U])]),W,z]),F]),J,K,M,X,Y])]),_:1})}}};typeof r=="function"&&r($);export{$ as default,Z as frontmatter};

package/dist/assets/settings.149d1dff.js

@@ -0,0 +1 @@
+import{a as i,o as d,b as c,w as o,g as t,e as n,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const u={class:"markdown-body"},_=t("blockquote",null,[t("p",null,"The Settings Module is where your entire Project is configured, making it the first place to go after installation. To maintain project safety and integrity, this module is only available to Administrators.")],-1),h=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/app-guide/settings/settings-20220308A/settings-20220308A.mp4",type:"video/mp4"})],-1),g=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Administrators Only"),t("p",null,"Only Administrators have access to the Settings Module.")],-1),p=t("p",null,"Settings are split into five distinct sections, each described below.",-1),f=e("Project Settings"),m=e(" \u2014 Setup branding and other global style options."),b=e("Data Model"),y=e(" \u2014 Create and modify "),k=e("Collections"),v=e(", "),w=e("Relationships"),x=e(", form layout, and "),A=e("Fields"),S=e("."),C=e("Roles & Permissions"),q=e(" \u2014 Create and manage access via Roles and Permissions."),B=e("Presets & Bookmarks"),P=e(" \u2014 Set default views of data and configure bookmarks."),j=e("Webhooks"),R=e(" \u2014 Use platform events to trigger external services."),V=t("p",null,"Aside from the above pages, there are three shorthand links:",-1),F=t("li",null,[t("p",null,[t("strong",null,"Report Bug"),t("br"),e(" A direct link to report a bug in the platform. When using this button, helpful debugging information about your project is automatically included, such as: version number, operating system, and environment type.")])],-1),M=t("strong",null,"Request Feature",-1),N=t("br",null,null,-1),T=e(" A direct link to "),D=t("a",{href:"https://github.com/directus/directus/discussions/new",target:"_blank",rel:"noopener noreferrer"},"submit a new feature request",-1),E=e(" on GitHub. Feature requests are a great way to let our team know what should be prioritized next. Learn more about making feature requests in the "),G=e("Contributing > Introduction"),H=e("."),O=t("li",null,[t("p",null,[t("strong",null,"Platform Version"),t("br"),e(" Displays the exact version of your platform. Click this button to go to the GitHub releases page, which includes the full change logs.")])],-1),W={title:"Settings",modularExtension:!1},z={name:"settings",setup(I,{expose:l}){return l({frontmatter:{title:"Settings",modularExtension:!1}}),(L,U)=>{const s=i("router-link"),a=i("docswrapper");return d(),c(a,{frontmatter:W},{default:o(()=>[t("div",u,[_,h,g,p,t("ul",null,[t("li",null,[n(s,{to:"/docs/configuration/project-settings"},{default:o(()=>[f]),_:1}),m]),t("li",null,[n(s,{to:"/docs/configuration/data-model"},{default:o(()=>[b]),_:1}),y,n(s,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[k]),_:1}),v,n(s,{to:"/docs/getting-started/glossary/#relationships"},{default:o(()=>[w]),_:1}),x,n(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[A]),_:1}),S]),t("li",null,[n(s,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[C]),_:1}),q]),t("li",null,[n(s,{to:"/docs/configuration/presets-bookmarks"},{default:o(()=>[B]),_:1}),P]),t("li",null,[n(s,{to:"/docs/configuration/webhooks"},{default:o(()=>[j]),_:1}),R])]),V,t("ul",null,[F,t("li",null,[t("p",null,[M,N,T,D,E,n(s,{to:"/docs/contributing/introduction/#feature-requests"},{default:o(()=>[G]),_:1}),H])]),O])])]),_:1})}}};typeof r=="function"&&r(z);export{z as default,W as frontmatter};

package/dist/assets/settings.28abc1f0.js

@@ -0,0 +1,51 @@
+import{a,o as i,b as h,w as e,g as s,e as n,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var o={};const d={class:"markdown-body"},_=s("div",{class:"two-up"},[s("div",{class:"left"},[s("blockquote",null,[s("p",null,"Settings are key-value pairs that are stored in the database, and control different aspects of the project. Only administrators have access to manage Settings.")])]),s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-settings-object"},"The Settings Object")]),s("li",null,[s("a",{href:"#retrieve-settings"},"Retrieve Settings")]),s("li",null,[s("a",{href:"#update-settings"},"Update Settings")])])])])])],-1),p=s("hr",null,null,-1),u=s("h2",{id:"the-settings-object"},[t("The Settings Object "),s("a",{class:"header-anchor",href:"#the-settings-object"},"#")],-1),g={class:"two-up"},f={class:"left"},j={class:"definitions"},m=s("p",null,[s("code",{class:""},"id"),t(),s("strong",null,"uuid"),s("br"),t(" Primary key of the setting.")],-1),b=s("p",null,[s("code",{class:""},"project_name"),t(),s("strong",null,"string"),s("br"),t(" Name of the project, shown in the Admin App.")],-1),y=s("p",null,[s("code",{class:""},"project_descriptor"),t(),s("strong",null,"string"),s("br"),t(" Descriptor of the project, shown in the Admin App.")],-1),v=s("p",null,[s("code",{class:""},"project_url"),t(),s("strong",null,"string"),s("br"),t(" Link to the (public) website that goes with this project.")],-1),w=s("p",null,[s("code",{class:""},"project_color"),t(),s("strong",null,"string"),s("br"),t(" Brand color for the current project.")],-1),x=s("code",{class:""},"project_logo",-1),q=t(),k=s("strong",null,"many-to-one",-1),A=s("br",null,null,-1),S=t(" Primary logo for the current project. Many-to-one to "),T=t("files"),E=t("."),P=s("code",{class:""},"public_foreground",-1),R=t(),C=s("strong",null,"many-to-one",-1),B=s("br",null,null,-1),M=t(" Foreground image for the Admin App\u2019s public pages. Many-to-one to "),O=t("files"),N=t("."),Q=s("code",{class:""},"public_background",-1),D=t(),G=s("strong",null,"many-to-one",-1),H=s("br",null,null,-1),I=t(" Background image for the Admin App\u2019s public pages. Many-to-one to "),L=t("files"),V=t("."),W=s("p",null,[s("code",{class:""},"public_note"),t(),s("strong",null,"string"),s("br"),t(" Note shown on the Admin App\u2019s public pages. Supports Markdown.")],-1),F=s("p",null,[s("code",{class:""},"auth_login_attempts"),t(),s("strong",null,"integer"),s("br"),t(" How often a user is allowed to try to login. After which times the user will be suspended.")],-1),U=s("p",null,[s("code",{class:""},"auth_password_policy"),t(),s("strong",null,"RegEx"),s("br"),t(" What regex passwords must pass in order to be valid.")],-1),z=s("code",{class:""},"storage_asset_transform",-1),J=t(),K=s("strong",null,"string",-1),X=s("br",null,null,-1),Y=t(" If the transform endpoints are allowed to be used on "),Z=t("the assets endpoint"),$=t(". One of "),ss=s("code",{class:""},"all",-1),ts=t(", "),es=s("code",{class:""},"none",-1),ls=t(" or "),ns=s("code",{class:""},"presets",-1),as=t("."),os=s("code",{class:""},"storage_asset_presets",-1),rs=t(),cs=s("strong",null,"array",-1),is=s("br",null,null,-1),hs=t(" What preset keys exist in "),ds=t("the assets endpoint"),_s=t("."),ps=s("p",null,[s("code",{class:""},"custom_css"),t(),s("strong",null,"string"),s("br"),t(" CSS rules to override the App\u2019s default styling.")],-1),us=s("p",null,[s("code",{class:""},"storage_default_folder"),t(),s("strong",null,"uuid"),s("br"),t(" Folder for uploaded files. Does not affect existing files.")],-1),gs=s("p",null,[s("code",{class:""},"basemaps"),t(),s("strong",null,"array"),s("br"),t(" Custom tiles to overriding the Mapbox defaults.")],-1),fs=s("p",null,[s("code",{class:""},"mapbox_key"),t(),s("strong",null,"string"),s("br"),s("a",{href:"https://docs.mapbox.com/help/glossary/access-token/",target:"_blank",rel:"noopener noreferrer"},"Mapbox Access Token"),t(".")],-1),js=s("p",null,[s("code",{class:""},"module_bar"),t(),s("strong",null,"array"),s("br"),t(" What modules are enabled/added globally.")],-1),ms=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[t(`{
+	`),s("span",{class:"hljs-attr"},'"data"'),t(`: {
+		`),s("span",{class:"hljs-attr"},'"id"'),t(": "),s("span",{class:"hljs-number"},"1"),t(`,
+		`),s("span",{class:"hljs-attr"},'"project_name"'),t(": "),s("span",{class:"hljs-string"},'"Directus"'),t(`,
+		`),s("span",{class:"hljs-attr"},'"project_descriptor"'),t(": "),s("span",{class:"hljs-string"},'"Application"'),t(`,
+		`),s("span",{class:"hljs-attr"},'"project_url"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"project_color"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"project_logo"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"public_foreground"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"public_background"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"public_note"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"auth_login_attempts"'),t(": "),s("span",{class:"hljs-number"},"25"),t(`,
+		`),s("span",{class:"hljs-attr"},'"auth_password_policy"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"storage_asset_transform"'),t(": "),s("span",{class:"hljs-string"},'"all"'),t(`,
+		`),s("span",{class:"hljs-attr"},'"storage_asset_presets"'),t(`: [
+			{ `),s("span",{class:"hljs-attr"},'"key"'),t(": "),s("span",{class:"hljs-string"},'"small"'),t(", "),s("span",{class:"hljs-attr"},'"fit"'),t(": "),s("span",{class:"hljs-string"},'"cover"'),t(", "),s("span",{class:"hljs-attr"},'"width"'),t(": "),s("span",{class:"hljs-number"},"200"),t(", "),s("span",{class:"hljs-attr"},'"height"'),t(": "),s("span",{class:"hljs-number"},"161"),t(", "),s("span",{class:"hljs-attr"},'"quality"'),t(": "),s("span",{class:"hljs-number"},"80"),t(", "),s("span",{class:"hljs-attr"},'"withoutEnlargement"'),t(": "),s("span",{class:"hljs-literal"},"false"),t(` }
+		],
+		`),s("span",{class:"hljs-attr"},'"custom_css"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"storage_default_folder"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"basemaps"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"mapbox_key"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},'"module_bar"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`
+	}
+}
+`)])])],-1),bs=s("hr",null,null,-1),ys=s("h2",{id:"retrieve-settings"},[t("Retrieve Settings "),s("a",{class:"header-anchor",href:"#retrieve-settings"},"#")],-1),vs={class:"two-up"},ws={class:"left"},xs=s("h3",{id:"query-parameters"},[t("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),qs=t("Supports all "),ks=t("global query parameters"),As=t("."),Ss=s("h3",{id:"returns"},[t("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),Ts=s("p",null,[t("Returns the "),s("a",{href:"#the-settings-object"},"settings object"),t(".")],-1),Es=s("div",{class:"right"},[s("h3",{id:"rest-api"},[t("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")]),s("pre",null,[s("code",{class:""},`GET /settings
+`)]),s("h3",{id:"graphql"},[t("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),t(` {
+	settings: directus_settings
+}
+`)])]),s("h5",{id:"example"},[t("Example "),s("a",{class:"header-anchor",href:"#example"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),t(` {
+	settings {
+		project_name
+	}
+}
+`)])])],-1),Ps=s("hr",null,null,-1),Rs=s("h2",{id:"update-settings"},[t("Update Settings "),s("a",{class:"header-anchor",href:"#update-settings"},"#")],-1),Cs={class:"two-up"},Bs={class:"left"},Ms=s("h3",{id:"query-parameters-2"},[t("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Os=t("Supports all "),Ns=t("global query parameters"),Qs=t("."),Ds=s("h3",{id:"request-body"},[t("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Gs=s("p",null,[t("A partial "),s("a",{href:"#the-settings-object"},"settings object"),t(".")],-1),Hs=s("h3",{id:"returns-2"},[t("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),Is=s("p",null,[t("Returns the "),s("a",{href:"#the-setting-object"},"settings object"),t(".")],-1),Ls=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[t("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /settings
+`)]),s("h5",{id:"example-2"},[t("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /settings"),t(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"project_url"'),t(": "),s("span",{class:"hljs-string"},'"https://example.com/"'),t(`
+}
+`)])]),s("h3",{id:"graphql-2"},[t("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
+	update_settings(data: update_directus_settings_input!): directus_settings
+}
+`)])]),s("h5",{id:"example-3"},[t("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
+	update_settings(data: { project_url: `),s("span",{class:"hljs-string"},'"https://example.com"'),t(` }) {
+		project_name
+		project_url
+	}
+}
+`)])])],-1),Vs={title:"Settings",modularExtension:!1,pageClass:"page-reference"},Ws={name:"settings",setup(Fs,{expose:r}){return r({frontmatter:{title:"Settings",modularExtension:!1,pageClass:"page-reference"}}),(Us,zs)=>{const l=a("router-link"),c=a("docswrapper");return i(),h(c,{frontmatter:Vs},{default:e(()=>[s("div",d,[_,p,u,s("div",g,[s("div",f,[s("div",j,[m,b,y,v,w,s("p",null,[x,q,k,A,S,n(l,{to:"/docs/reference/files/"},{default:e(()=>[T]),_:1}),E]),s("p",null,[P,R,C,B,M,n(l,{to:"/docs/reference/files/"},{default:e(()=>[O]),_:1}),N]),s("p",null,[Q,D,G,H,I,n(l,{to:"/docs/reference/files/"},{default:e(()=>[L]),_:1}),V]),W,F,U,s("p",null,[z,J,K,X,Y,n(l,{to:"/docs/reference/files/#requesting-a-thumbnail"},{default:e(()=>[Z]),_:1}),$,ss,ts,es,ls,ns,as]),s("p",null,[os,rs,cs,is,hs,n(l,{to:"/docs/reference/files/#requesting-a-thumbnail"},{default:e(()=>[ds]),_:1}),_s]),ps,us,gs,fs,js])]),ms]),bs,ys,s("div",vs,[s("div",ws,[xs,s("p",null,[qs,n(l,{to:"/docs/reference/query"},{default:e(()=>[ks]),_:1}),As]),Ss,Ts]),Es]),Ps,Rs,s("div",Cs,[s("div",Bs,[Ms,s("p",null,[Os,n(l,{to:"/docs/reference/query"},{default:e(()=>[Ns]),_:1}),Qs]),Ds,Gs,Hs,Is]),Ls])])]),_:1})}}};typeof o=="function"&&o(Ws);export{Ws as default,Vs as frontmatter};