@directus/app 9.22.1 → 9.22.3

package/dist/assets/sdk-b67c4a64.js

@@ -0,0 +1,439 @@
+import{a as o,o as r,e as h,y as a,u as s,q as t,z as n}from"./runtime-core.esm-bundler-753bcc58.js";const p={class:"markdown-body"},d=s("blockquote",null,[s("p",null,[t("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"),t(" for transport and "),s("code",null,"localStorage"),t(" for storing state. Advanced customizations are available.")])],-1),u=s("h2",{id:"installation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#installation"},"#"),t(" Installation")],-1),j=s("pre",null,[s("code",{class:"language-bash"},`npm install @directus/sdk
+`)],-1),_=s("h2",{id:"basic-usage",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#basic-usage"},"#"),t(" Basic Usage")],-1),m=s("p",null,[t("This is the starting point to use the JS SDK. After you’ve created the "),s("code",null,"Directus"),t(" instance, you can start invoking methods from it to access your project and data.")],-1),g=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),t(" { "),s("span",{class:"hljs-title class_"},"Directus"),t(" } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'@directus/sdk'"),t(`;
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("("),s("span",{class:"hljs-string"},"'http://directus.example.com'"),t(`);
+`)])],-1),f=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-keyword"},"function"),t(),s("span",{class:"hljs-title function_"},"publicData"),t("("),s("span",{class:"hljs-params"}),t(`) {
+	`),s("span",{class:"hljs-comment"},"// GET DATA"),t(`
+
+	`),s("span",{class:"hljs-comment"},"// We don't need to authenticate if the public role has access to some_public_collection."),t(`
+	`),s("span",{class:"hljs-keyword"},"const"),t(" publicData = "),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-title function_"},"items"),t("("),s("span",{class:"hljs-string"},"'some_public_collection'"),t(")."),s("span",{class:"hljs-title function_"},"readByQuery"),t("({ "),s("span",{class:"hljs-attr"},"sort"),t(": ["),s("span",{class:"hljs-string"},"'id'"),t(`] });
+
+	`),s("span",{class:"hljs-variable language_"},"console"),t("."),s("span",{class:"hljs-title function_"},"log"),t("(publicData."),s("span",{class:"hljs-property"},"data"),t(`);
+}
+`)])],-1),y=s("h3",{id:"basic-authentication",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#basic-authentication"},"#"),t(" Basic Authentication")],-1),w=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-keyword"},"function"),t(),s("span",{class:"hljs-title function_"},"start"),t("("),s("span",{class:"hljs-params"}),t(`) {
+	`),s("span",{class:"hljs-comment"},"// AUTHENTICATION"),t(`
+
+	`),s("span",{class:"hljs-keyword"},"let"),t(" authenticated = "),s("span",{class:"hljs-literal"},"false"),t(`;
+
+	`),s("span",{class:"hljs-comment"},"// Try to authenticate with token if exists"),t(`
+	`),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t(`
+		.`),s("span",{class:"hljs-title function_"},"refresh"),t(`()
+		.`),s("span",{class:"hljs-title function_"},"then"),t("("),s("span",{class:"hljs-function"},"() =>"),t(` {
+			authenticated = `),s("span",{class:"hljs-literal"},"true"),t(`;
+		})
+		.`),s("span",{class:"hljs-title function_"},"catch"),t("("),s("span",{class:"hljs-function"},"() =>"),t(` {});
+
+	`),s("span",{class:"hljs-comment"},"// Let's login in case we don't have token or it is invalid / expired"),t(`
+	`),s("span",{class:"hljs-keyword"},"while"),t(` (!authenticated) {
+		`),s("span",{class:"hljs-keyword"},"const"),t(" email = "),s("span",{class:"hljs-variable language_"},"window"),t("."),s("span",{class:"hljs-title function_"},"prompt"),t("("),s("span",{class:"hljs-string"},"'Email:'"),t(`);
+		`),s("span",{class:"hljs-keyword"},"const"),t(" password = "),s("span",{class:"hljs-variable language_"},"window"),t("."),s("span",{class:"hljs-title function_"},"prompt"),t("("),s("span",{class:"hljs-string"},"'Password:'"),t(`);
+
+		`),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t(`
+			.`),s("span",{class:"hljs-title function_"},"login"),t(`({ email, password })
+			.`),s("span",{class:"hljs-title function_"},"then"),t("("),s("span",{class:"hljs-function"},"() =>"),t(` {
+				authenticated = `),s("span",{class:"hljs-literal"},"true"),t(`;
+			})
+			.`),s("span",{class:"hljs-title function_"},"catch"),t("("),s("span",{class:"hljs-function"},"() =>"),t(` {
+				`),s("span",{class:"hljs-variable language_"},"window"),t("."),s("span",{class:"hljs-title function_"},"alert"),t("("),s("span",{class:"hljs-string"},"'Invalid credentials'"),t(`);
+			});
+	}
+
+	`),s("span",{class:"hljs-comment"},"// GET DATA"),t(`
+
+	`),s("span",{class:"hljs-comment"},"// After authentication, we can fetch data from any collections that the user has permissions to."),t(`
+	`),s("span",{class:"hljs-keyword"},"const"),t(" privateData = "),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-title function_"},"items"),t("("),s("span",{class:"hljs-string"},"'some_private_collection'"),t(")."),s("span",{class:"hljs-title function_"},"readByQuery"),t("({ "),s("span",{class:"hljs-attr"},"sort"),t(": ["),s("span",{class:"hljs-string"},"'id'"),t(`] });
+
+	`),s("span",{class:"hljs-variable language_"},"console"),t("."),s("span",{class:"hljs-title function_"},"log"),t("(publicData."),s("span",{class:"hljs-property"},"data"),t(`);
+}
+
+`),s("span",{class:"hljs-title function_"},"start"),t(`();
+`)])],-1),b=s("h2",{id:"custom-configuration",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#custom-configuration"},"#"),t(" Custom Configuration")],-1),k=s("p",null,[t("The previous section covered basic installation and usage of the JS SDK with default configurations for "),s("code",null,"init"),t(". But sometimes you may need to customize these defaults.")],-1),x=s("h3",{id:"constructor",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#constructor"},"#"),t(" Constructor")],-1),v=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),t(" { "),s("span",{class:"hljs-title class_"},"Directus"),t(" } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'@directus/sdk'"),t(`;
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t(`(url, init);
+`)])],-1),D=s("h3",{id:"parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#parameters"},"#"),t(" Parameters")],-1),S=s("br",null,null,-1),T=s("h4",{id:"url-required",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#url-required"},"#"),t(),s("code",null,"url"),t(),s("em",null,"required")],-1),A=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"String")]),s("li",null,[s("strong",null,"Description"),t(" — A string that points to your Directus instance. E.g., "),s("code",null,"https://example.directus.io")]),s("li",null,[s("strong",null,"Default"),t(" — N/A")])],-1),I=s("br",null,null,-1),R=s("h4",{id:"init-optional",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#init-optional"},"#"),t(),s("code",null,"init"),t(),s("em",null,"optional")],-1),B=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"Object")]),s("li",null,[s("strong",null,"Description"),t(" — Defines authentication, storage and transport settings.")]),s("li",null,[s("strong",null,"Default"),t(" — The following shows the default values for "),s("code",null,"init"),t(".")])],-1),q=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"// This is the default init object"),t(`
+`),s("span",{class:"hljs-keyword"},"const"),t(` config = {
+	`),s("span",{class:"hljs-attr"},"auth"),t(`: {
+		`),s("span",{class:"hljs-attr"},"mode"),t(": "),s("span",{class:"hljs-string"},"'cookie'"),t(", "),s("span",{class:"hljs-comment"},"// 'json' in Node.js"),t(`
+		`),s("span",{class:"hljs-attr"},"autoRefresh"),t(": "),s("span",{class:"hljs-literal"},"true"),t(`,
+		`),s("span",{class:"hljs-attr"},"msRefreshBeforeExpires"),t(": "),s("span",{class:"hljs-number"},"30000"),t(`,
+		`),s("span",{class:"hljs-attr"},"staticToken"),t(": "),s("span",{class:"hljs-string"},"''"),t(`,
+	},
+	`),s("span",{class:"hljs-attr"},"storage"),t(`: {
+		`),s("span",{class:"hljs-attr"},"prefix"),t(": "),s("span",{class:"hljs-string"},"''"),t(`,
+		`),s("span",{class:"hljs-attr"},"mode"),t(": "),s("span",{class:"hljs-string"},"'LocalStorage'"),t(", "),s("span",{class:"hljs-comment"},"// 'MemoryStorage' in Node.js"),t(`
+	},
+	`),s("span",{class:"hljs-attr"},"transport"),t(`: {
+		`),s("span",{class:"hljs-attr"},"params"),t(`: {},
+		`),s("span",{class:"hljs-attr"},"headers"),t(`: {},
+		`),s("span",{class:"hljs-attr"},"onUploadProgress"),t(": "),s("span",{class:"hljs-function"},[t("("),s("span",{class:"hljs-params"},"ProgressEvent"),t(") =>")]),t(` {},
+		`),s("span",{class:"hljs-attr"},"maxBodyLength"),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+		`),s("span",{class:"hljs-attr"},"maxContentLength"),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+	},
+};
+`)])],-1),M=s("h2",{id:"customize-auth",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#customize-auth"},"#"),t(" Customize "),s("code",null,"auth")],-1),N=s("p",null,[t("Defines how authentication is handled by the SDK. By default, Directus creates an instance of "),s("code",null,"auth"),t(" which handles refresh tokens automatically.")],-1),E=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"const"),t(` auth = {
+	`),s("span",{class:"hljs-attr"},"mode"),t(": "),s("span",{class:"hljs-string"},"'cookie'"),t(", "),s("span",{class:"hljs-comment"},"// 'json' in Node.js"),t(`
+	`),s("span",{class:"hljs-attr"},"autoRefresh"),t(": "),s("span",{class:"hljs-literal"},"true"),t(`,
+	`),s("span",{class:"hljs-attr"},"msRefreshBeforeExpires"),t(": "),s("span",{class:"hljs-number"},"30000"),t(`,
+	`),s("span",{class:"hljs-attr"},"staticToken"),t(": "),s("span",{class:"hljs-string"},"''"),t(`,
+};
+`)])],-1),C=s("h3",{id:"options",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#options"},"#"),t(" Options")],-1),O=s("br",null,null,-1),P=s("h4",{id:"mode",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#mode"},"#"),t(),s("code",null,"mode")],-1),L=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"String")]),s("li",null,[s("strong",null,"Description"),t(" — Defines the mode you want to use for authentication. It can be "),s("code",null,"'cookie'"),t(" for cookies or "),s("code",null,"'json'"),t(" for JWT.")]),s("li",null,[s("strong",null,"Default"),t(" — Defaults to "),s("code",null,"'cookie'"),t(" on browsers and "),s("code",null,"'json'"),t(" otherwise.")])],-1),U=s("div",{class:"tip hint"},[s("p",null,"We recommend using cookies when possible to prevent any kind of attacks, mostly XSS.")],-1),K=s("h4",{id:"autorefresh",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#autorefresh"},"#"),t(),s("code",null,"autoRefresh")],-1),F=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"Boolean")]),s("li",null,[s("strong",null,"Description"),t(" — Determines whether SDK handles refresh tokens automatically.")]),s("li",null,[s("strong",null,"Default"),t(" — Defaults to "),s("code",null,"true"),t(".")])],-1),W=s("br",null,null,-1),z=s("h4",{id:"msrefreshbeforeexpires",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#msrefreshbeforeexpires"},"#"),t(),s("code",null,"msRefreshBeforeExpires")],-1),J=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"Number")]),s("li",null,[s("strong",null,"Description"),t(" — When "),s("code",null,"autoRefresh"),t(" is enabled, this tells how many milliseconds before the refresh token expires and needs to be refreshed.")]),s("li",null,[s("strong",null,"Default"),t(" — Defaults to "),s("code",null,"30000"),t(".")])],-1),G=s("br",null,null,-1),H=s("h4",{id:"statictoken",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#statictoken"},"#"),t(),s("code",null,"staticToken")],-1),V=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"String")]),s("li",null,[s("strong",null,"Description"),t(" - Defines the static token to use. It is not compatible with the options above since it does not refresh.")]),s("li",null,[s("strong",null,"Default"),t(" — Defaults to "),s("code",null,"''"),t(" (no static token).")])],-1),Q=s("h3",{id:"extend-auth",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#extend-auth"},"#"),t(" Extend "),s("code",null,"auth")],-1),Y=s("p",null,[t("It is possible to provide a custom implementation by extending "),s("code",null,"IAuth"),t(". While this could be useful in certain advanced situations, it is not needed for most use-cases.")],-1),$=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),t(" { "),s("span",{class:"hljs-title class_"},"IAuth"),t(", "),s("span",{class:"hljs-title class_"},"Directus"),t(" } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'@directus/sdk'"),t(`;
+
+`),s("span",{class:"hljs-keyword"},"class"),t(),s("span",{class:"hljs-title class_"},"MyAuth"),t(),s("span",{class:"hljs-keyword"},"extends"),t(),s("span",{class:"hljs-title class_ inherited__"},"IAuth"),t(` {
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"login"),t("("),s("span",{class:"hljs-params"}),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(" { "),s("span",{class:"hljs-attr"},"access_token"),t(": "),s("span",{class:"hljs-string"},"''"),t(", "),s("span",{class:"hljs-attr"},"expires"),t(": "),s("span",{class:"hljs-number"},"0"),t(` };
+	}
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"logout"),t("("),s("span",{class:"hljs-params"}),t(`) {}
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"refresh"),t("("),s("span",{class:"hljs-params"}),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(" { "),s("span",{class:"hljs-attr"},"access_token"),t(": "),s("span",{class:"hljs-string"},"''"),t(", "),s("span",{class:"hljs-attr"},"expires"),t(": "),s("span",{class:"hljs-number"},"0"),t(` };
+	}
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"static"),t("("),s("span",{class:"hljs-params"}),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(),s("span",{class:"hljs-literal"},"true"),t(`;
+	}
+}
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("("),s("span",{class:"hljs-string"},"'https://example.directus.app'"),t(`, {
+	`),s("span",{class:"hljs-attr"},"auth"),t(": "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"MyAuth"),t(`(),
+});
+`)])],-1),X=s("h2",{id:"customize-storage",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#customize-storage"},"#"),t(" Customize "),s("code",null,"storage")],-1),Z=s("p",null,[t("The storage is used to load and save token information. By default, Directus creates an instance of "),s("code",null,"storage"),t(" which handles store information automatically.")],-1),ss=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"const"),t(` storage = {
+	`),s("span",{class:"hljs-attr"},"prefix"),t(": "),s("span",{class:"hljs-string"},"''"),t(`,
+	`),s("span",{class:"hljs-attr"},"mode"),t(": "),s("span",{class:"hljs-string"},"'LocalStorage'"),t(", "),s("span",{class:"hljs-comment"},"// 'MemoryStorage' in Node.js"),t(`
+};
+`)])],-1),ts=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Multiple Instances"),s("p",null,[t("If you want to use multiple instances of the SDK you should set a different "),s("a",{href:"#prefix"},[s("code",null,"prefix")]),t(" for each one.")])],-1),as=s("div",{class:"tip hint"},[s("p",null,"The axios instance can be used for custom requests by calling:"),s("pre",null,[s("code",{class:"language-ts"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"transport"),t(".<method>("),s("span",{class:"hljs-string"},"'/path/to/endpoint'"),t(`, {
+	`),s("span",{class:"hljs-comment"},"/* body, params, ... */"),t(`
+});
+`)])])],-1),es=s("h3",{id:"options-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#options-1"},"#"),t(" Options")],-1),ns=s("br",null,null,-1),ls=s("h4",{id:"prefix",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#prefix"},"#"),t(),s("code",null,"prefix")],-1),os=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"String")]),s("li",null,[s("strong",null,"Description"),t(" — Defines the tokens prefix tokens that are saved. This should be fulfilled with different values when using multiple instances of SDK.")]),s("li",null,[s("strong",null,"Default"),t(" — Defaults to "),s("code",null,"''"),t(" (no prefix).")])],-1),cs=s("br",null,null,-1),is=s("h4",{id:"mode-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#mode-1"},"#"),t(),s("code",null,"mode")],-1),rs=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"String")]),s("li",null,[s("strong",null,"Description"),t(" — Defines the storage location to be used to save tokens. Allowed values are "),s("code",null,"LocalStorage"),t(" and "),s("code",null,"MemoryStorage"),t(". The mode "),s("code",null,"LocalStorage"),t(" is not compatible with Node.js. "),s("code",null,"MemoryStorage"),t(" is not persistent, so once you leave the tab or quit the process, you will need to authenticate again.")]),s("li",null,[s("strong",null,"Default"),t(" — Defaults to "),s("code",null,"LocalStorage"),t(" on browsers and "),s("code",null,"MemoryStorage"),t(" on Node.js.")])],-1),hs=s("h3",{id:"extend-storage",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#extend-storage"},"#"),t(" Extend "),s("code",null,"storage")],-1),ps=s("p",null,[t("It is possible to provide a custom implementation by extending "),s("code",null,"BaseStorage"),t(". While this could be useful in certain advanced situations, it is not needed for most use-cases.")],-1),ds=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),t(" { "),s("span",{class:"hljs-title class_"},"BaseStorage"),t(", "),s("span",{class:"hljs-title class_"},"Directus"),t(" } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'@directus/sdk'"),t(`;
+
+`),s("span",{class:"hljs-keyword"},"class"),t(),s("span",{class:"hljs-title class_"},"SessionStorage"),t(),s("span",{class:"hljs-keyword"},"extends"),t(),s("span",{class:"hljs-title class_ inherited__"},"BaseStorage"),t(` {
+	`),s("span",{class:"hljs-title function_"},"get"),t("("),s("span",{class:"hljs-params"},"key"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(" sessionStorage."),s("span",{class:"hljs-title function_"},"getItem"),t(`(key);
+	}
+	`),s("span",{class:"hljs-title function_"},"set"),t("("),s("span",{class:"hljs-params"},"key, value"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(" sessionStorage."),s("span",{class:"hljs-title function_"},"setItem"),t(`(key, value);
+	}
+	`),s("span",{class:"hljs-title function_"},"delete"),t("("),s("span",{class:"hljs-params"},"key"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(" sessionStorage."),s("span",{class:"hljs-title function_"},"removeItem"),t(`(key);
+	}
+}
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("("),s("span",{class:"hljs-string"},"'https://example.directus.app'"),t(`, {
+	`),s("span",{class:"hljs-attr"},"storage"),t(": "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"SessionStorage"),t(`(),
+});
+`)])],-1),us=s("h2",{id:"customize-transport",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#customize-transport"},"#"),t(" Customize "),s("code",null,"transport")],-1),js=s("p",null,[t("Defines settings you want to customize regarding "),s("a",{href:"#extend-transport"},"Transport"),t(".")],-1),_s=s("p",null,[t("By default, Directus creates an instance of "),s("code",null,"Transport"),t(" which handles requests automatically. It uses "),s("a",{href:"https://axios-http.com/",target:"_blank",rel:"noopener noreferrer"},[s("code",null,"axios")]),t(" so it is compatible in both browsers and Node.js. With axios, it is also possible to handle upload progress (a downside of "),s("code",null,"fetch"),t(").")],-1),ms=s("p",null,[t("The configurations within "),s("code",null,"init.transport"),t(" are passed to "),s("code",null,"axios"),t(". For more details, see "),s("a",{href:"https://axios-http.com/docs/req_config",target:"_blank",rel:"noopener noreferrer"},"Request Config"),t(" in the axios documentation.")],-1),gs=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"export"),t(),s("span",{class:"hljs-keyword"},"default"),t(` {
+	`),s("span",{class:"hljs-attr"},"params"),t(`: {},
+	`),s("span",{class:"hljs-attr"},"headers"),t(`: {},
+	`),s("span",{class:"hljs-attr"},"onUploadProgress"),t(": "),s("span",{class:"hljs-function"},[t("("),s("span",{class:"hljs-params"},"ProgressEvent"),t(") =>")]),t(` {},
+	`),s("span",{class:"hljs-attr"},"maxBodyLength"),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+	`),s("span",{class:"hljs-attr"},"maxContentLength"),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
+};
+`)])],-1),fs=s("h3",{id:"options-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#options-2"},"#"),t(" Options")],-1),ys=s("br",null,null,-1),ws=s("h4",{id:"params",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#params"},"#"),t(),s("code",null,"params")],-1),bs=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"Object")]),s("li",null,[s("strong",null,"Description"),t(" — Defines an object with keys and values to be passed as additional query string.")]),s("li",null,[s("strong",null,"Default"),t(" — N/A")])],-1),ks=s("br",null,null,-1),xs=s("h4",{id:"headers",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#headers"},"#"),t(),s("code",null,"headers")],-1),vs=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"Object")]),s("li",null,[s("strong",null,"Description"),t(" - Defines an object with keys and values to be passed as additional headers.")]),s("li",null,[s("strong",null,"Default"),t(" — N/A")])],-1),Ds=s("br",null,null,-1),Ss=s("h4",{id:"onuploadprogress",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#onuploadprogress"},"#"),t(),s("code",null,"onUploadProgress")],-1),Ts=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"Function")]),s("li",null,[s("strong",null,"Description"),t(" — Defines a callback function to indicate the upload progress.")]),s("li",null,[s("strong",null,"Default"),t(" — N/A")])],-1),As=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"ProgressEvent Please see the MDN documentation to learn more about the"),s("p",null,[s("a",{href:"https://developer.mozilla.org/en-US/docs/Web/API/ProgressEvent",target:"_blank",rel:"noopener noreferrer"},"ProgressEvent"),t(".")])],-1),Is=s("br",null,null,-1),Rs=s("h4",{id:"maxbodylength",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#maxbodylength"},"#"),t(),s("code",null,"maxBodyLength")],-1),Bs=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"Number")]),s("li",null,[s("strong",null,"Description"),t(" — The maximum body length in bytes. Set "),s("code",null,"Infinity"),t(" for no limit.")]),s("li",null,[s("strong",null,"Default"),t(" — N/A")])],-1),qs=s("br",null,null,-1),Ms=s("h4",{id:"maxcontentlength",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#maxcontentlength"},"#"),t(),s("code",null,"maxContentLength")],-1),Ns=s("ul",null,[s("li",null,[s("strong",null,"Type"),t(" — "),s("code",null,"Number")]),s("li",null,[s("strong",null,"Description"),t(" — The maximum content length in bytes. Set "),s("code",null,"Infinity"),t(" for no limit.")]),s("li",null,[s("strong",null,"Default"),t(" — N/A")])],-1),Es=s("h3",{id:"extend-transport",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#extend-transport"},"#"),t(" Extend "),s("code",null,"Transport")],-1),Cs=s("p",null,[t("It is possible to provide a custom implementation by extending "),s("code",null,"ITransport"),t(". For example, you can customize it to use different HTTP libraries. While this could be useful in certain advanced situations, it is not needed for most use-cases.")],-1),Os=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),t(" { "),s("span",{class:"hljs-title class_"},"ITransport"),t(", "),s("span",{class:"hljs-title class_"},"Directus"),t(" } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'@directus/sdk'"),t(`;
+
+`),s("span",{class:"hljs-keyword"},"class"),t(),s("span",{class:"hljs-title class_"},"MyTransport"),t(),s("span",{class:"hljs-keyword"},"extends"),t(),s("span",{class:"hljs-title class_ inherited__"},"ITransport"),t(` {
+	`),s("span",{class:"hljs-title function_"},"buildResponse"),t("("),s("span",{class:"hljs-params"}),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(` {
+			`),s("span",{class:"hljs-attr"},"raw"),t(": "),s("span",{class:"hljs-string"},"''"),t(`,
+			`),s("span",{class:"hljs-attr"},"data"),t(`: {},
+			`),s("span",{class:"hljs-attr"},"status"),t(": "),s("span",{class:"hljs-number"},"0"),t(`,
+			`),s("span",{class:"hljs-attr"},"headers"),t(`: {},
+		};
+	}
+
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"get"),t("("),s("span",{class:"hljs-params"},"path, options"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(),s("span",{class:"hljs-variable language_"},"this"),t("."),s("span",{class:"hljs-title function_"},"buildResponse"),t(`();
+	}
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"head"),t("("),s("span",{class:"hljs-params"},"path, options"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(),s("span",{class:"hljs-variable language_"},"this"),t("."),s("span",{class:"hljs-title function_"},"buildResponse"),t(`();
+	}
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"options"),t("("),s("span",{class:"hljs-params"},"path, options"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(),s("span",{class:"hljs-variable language_"},"this"),t("."),s("span",{class:"hljs-title function_"},"buildResponse"),t(`();
+	}
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"delete"),t("("),s("span",{class:"hljs-params"},"path, data, options"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(),s("span",{class:"hljs-variable language_"},"this"),t("."),s("span",{class:"hljs-title function_"},"buildResponse"),t(`();
+	}
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"post"),t("("),s("span",{class:"hljs-params"},"path, data, options"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(),s("span",{class:"hljs-variable language_"},"this"),t("."),s("span",{class:"hljs-title function_"},"buildResponse"),t(`();
+	}
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"put"),t("("),s("span",{class:"hljs-params"},"path, data, options"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(),s("span",{class:"hljs-variable language_"},"this"),t("."),s("span",{class:"hljs-title function_"},"buildResponse"),t(`();
+	}
+	`),s("span",{class:"hljs-keyword"},"async"),t(),s("span",{class:"hljs-title function_"},"patch"),t("("),s("span",{class:"hljs-params"},"path, data, options"),t(`) {
+		`),s("span",{class:"hljs-keyword"},"return"),t(),s("span",{class:"hljs-variable language_"},"this"),t("."),s("span",{class:"hljs-title function_"},"buildResponse"),t(`();
+	}
+}
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("("),s("span",{class:"hljs-string"},"'https://example.directus.app'"),t(`, {
+	`),s("span",{class:"hljs-attr"},"transport"),t(": "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"MyTransport"),t(`(),
+});
+`)])],-1),Ps=s("h2",{id:"typescript",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#typescript"},"#"),t(" TypeScript")],-1),Ls=s("p",null,"Version >= 4.1",-1),Us=s("p",null,"Although it’s not required, it is recommended to use TypeScript to have an easy development experience. This allows more detailed IDE suggestions for return types, sorting, filtering, etc.",-1),Ks=s("p",null,"To feed the SDK with your current schema, you need to pass it on the constructor.",-1),Fs=s("pre",null,[s("code",{class:"language-ts"},[s("span",{class:"hljs-keyword"},"type"),t(),s("span",{class:"hljs-title class_"},"BlogPost"),t(` = {
+	`),s("span",{class:"hljs-attr"},"id"),t(": "),s("span",{class:"hljs-variable constant_"},"ID"),t(`;
+	`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-built_in"},"string"),t(`;
+};
+
+`),s("span",{class:"hljs-keyword"},"type"),t(),s("span",{class:"hljs-title class_"},"BlogSettings"),t(` = {
+	`),s("span",{class:"hljs-attr"},"display_promotions"),t(": "),s("span",{class:"hljs-built_in"},"boolean"),t(`;
+};
+
+`),s("span",{class:"hljs-keyword"},"type"),t(),s("span",{class:"hljs-title class_"},"MyCollections"),t(` = {
+	`),s("span",{class:"hljs-attr"},"posts"),t(": "),s("span",{class:"hljs-title class_"},"BlogPost"),t(`;
+	`),s("span",{class:"hljs-attr"},"settings"),t(": "),s("span",{class:"hljs-title class_"},"BlogSettings"),t(`;
+};
+
+`),s("span",{class:"hljs-comment"},"// This is how you feed custom type information to Directus."),t(`
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("<"),s("span",{class:"hljs-title class_"},"MyCollections"),t(">("),s("span",{class:"hljs-string"},"'https://example.directus.app'"),t(`);
+
+`),s("span",{class:"hljs-comment"},"// ..."),t(`
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" post = "),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-title function_"},"items"),t("("),s("span",{class:"hljs-string"},"'posts'"),t(")."),s("span",{class:"hljs-title function_"},"readOne"),t("("),s("span",{class:"hljs-number"},"1"),t(`);
+`),s("span",{class:"hljs-comment"},"// typeof(post) is a partial BlogPost object"),t(`
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" settings = "),s("span",{class:"hljs-keyword"},"await"),t(" posts."),s("span",{class:"hljs-title function_"},"singleton"),t("("),s("span",{class:"hljs-string"},"'settings'"),t(")."),s("span",{class:"hljs-title function_"},"read"),t(`();
+`),s("span",{class:"hljs-comment"},"// typeof(settings) is a partial BlogSettings object"),t(`
+`)])],-1),Ws=s("p",null,"You can also extend the Directus system type information by providing type information for system collections as well.",-1),zs=s("pre",null,[s("code",{class:"language-ts"},[s("span",{class:"hljs-keyword"},"import"),t(" { "),s("span",{class:"hljs-title class_"},"Directus"),t(" } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'@directus/sdk'"),t(`;
+
+`),s("span",{class:"hljs-comment"},"// Custom fields added to Directus user collection."),t(`
+`),s("span",{class:"hljs-keyword"},"type"),t(),s("span",{class:"hljs-title class_"},"UserType"),t(` = {
+	`),s("span",{class:"hljs-attr"},"level"),t(": "),s("span",{class:"hljs-built_in"},"number"),t(`;
+	`),s("span",{class:"hljs-attr"},"experience"),t(": "),s("span",{class:"hljs-built_in"},"number"),t(`;
+};
+
+`),s("span",{class:"hljs-keyword"},"type"),t(),s("span",{class:"hljs-title class_"},"CustomTypes"),t(` = {
+	`),s("span",{class:"hljs-comment"},`/*
+	This type will be merged with Directus user type.
+	It's important that the naming matches a directus
+	collection name exactly. Typos won't get caught here
+	since SDK will assume it's a custom user collection.
+	*/`),t(`
+	`),s("span",{class:"hljs-attr"},"directus_users"),t(": "),s("span",{class:"hljs-title class_"},"UserType"),t(`;
+};
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("<"),s("span",{class:"hljs-title class_"},"CustomTypes"),t(">("),s("span",{class:"hljs-string"},"'https://example.directus.app'"),t(`);
+
+`),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t("."),s("span",{class:"hljs-title function_"},"login"),t(`({
+	`),s("span",{class:"hljs-attr"},"email"),t(": "),s("span",{class:"hljs-string"},"'admin@example.com'"),t(`,
+	`),s("span",{class:"hljs-attr"},"password"),t(": "),s("span",{class:"hljs-string"},"'password'"),t(`,
+});
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" me = "),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"users"),t("."),s("span",{class:"hljs-property"},"me"),t("."),s("span",{class:"hljs-title function_"},"read"),t(`();
+`),s("span",{class:"hljs-comment"},"// typeof me = partial DirectusUser & UserType;"),t(`
+
+`),s("span",{class:"hljs-comment"},"// OK"),t(`
+me.`),s("span",{class:"hljs-property"},"level"),t(" = "),s("span",{class:"hljs-number"},"42"),t(`;
+
+`),s("span",{class:"hljs-comment"},'// Error TS2322: Type "string" is not assignable to type "number".'),t(`
+me.`),s("span",{class:"hljs-property"},"experience"),t(" = "),s("span",{class:"hljs-string"},"'high'"),t(`;
+`)])],-1),Js=s("h2",{id:"authentication",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#authentication"},"#"),t(" Authentication")],-1),Gs=s("h3",{id:"get-current-token",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#get-current-token"},"#"),t(" Get current token")],-1),Hs=s("pre",null,[s("code",{class:"language-ts"},[s("span",{class:"hljs-keyword"},"const"),t(" token = "),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t("."),s("span",{class:"hljs-property"},"token"),t(`;
+`)])],-1),Vs=s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"Async"),s("p",null,[t("Reading the token is an asynchronous getter. This makes sure that any currently active "),s("code",null,"refresh"),t(" calls are being awaited before the current token is returned.")])],-1),Qs=s("h3",{id:"login",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#login"},"#"),t(" Login")],-1),Ys=s("h4",{id:"with-credentials",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#with-credentials"},"#"),t(" With credentials")],-1),$s=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t("."),s("span",{class:"hljs-title function_"},"login"),t(`({
+	`),s("span",{class:"hljs-attr"},"email"),t(": "),s("span",{class:"hljs-string"},"'admin@example.com'"),t(`,
+	`),s("span",{class:"hljs-attr"},"password"),t(": "),s("span",{class:"hljs-string"},"'d1r3ctu5'"),t(`,
+});
+`)])],-1),Xs=s("h4",{id:"with-static-tokens",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#with-static-tokens"},"#"),t(" With static tokens")],-1),Zs=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t("."),s("span",{class:"hljs-title function_"},"static"),t("("),s("span",{class:"hljs-string"},"'static_token'"),t(`);
+`)])],-1),st=s("h3",{id:"refresh-auth-token",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#refresh-auth-token"},"#"),t(" Refresh Auth Token")],-1),tt=s("p",null,[t("By default, Directus will handle token refreshes. Although, you can handle this behavior manually by setting "),s("a",{href:"#options.auth.autoRefresh"},[s("code",null,"autoRefresh")]),t(" to "),s("code",null,"false"),t(".")],-1),at=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t("."),s("span",{class:"hljs-title function_"},"refresh"),t(`();
+`)])],-1),et={class:"tip hint"},nt=s("div",{class:"hint-title"},"Developing Locally",-1),lt=s("h3",{id:"logout",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#logout"},"#"),t(" Logout")],-1),ot=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t("."),s("span",{class:"hljs-title function_"},"logout"),t(`();
+`)])],-1),ct=s("h3",{id:"request-a-password-reset",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-a-password-reset"},"#"),t(" Request a Password Reset")],-1),it=s("p",null,[t("By default, the address defined in "),s("code",null,"PUBLIC_URL"),t(" on "),s("code",null,".env"),t(" file is used for the link to the reset password page sent in the email:")],-1),rt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t("."),s("span",{class:"hljs-property"},"password"),t("."),s("span",{class:"hljs-title function_"},"request"),t("("),s("span",{class:"hljs-string"},"'admin@example.com'"),t(`);
+`)])],-1),ht=s("p",null,"But a custom address can be passed as second argument:",-1),pt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t("."),s("span",{class:"hljs-property"},"password"),t("."),s("span",{class:"hljs-title function_"},"request"),t(`(
+	`),s("span",{class:"hljs-string"},"'admin@example.com'"),t(`,
+	`),s("span",{class:"hljs-string"},"'https://myapp.com'"),t(),s("span",{class:"hljs-comment"},"// In this case, the link will be https://myapp.com?token=FEE0A..."),t(`
+);
+`)])],-1),dt=s("strong",null,"Note",-1),ut=s("code",null,"PASSWORD_RESET_URL_ALLOW_LIST",-1),jt=s("h3",{id:"reset-a-password",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#reset-a-password"},"#"),t(" Reset a Password")],-1),_t=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"auth"),t("."),s("span",{class:"hljs-property"},"password"),t("."),s("span",{class:"hljs-title function_"},"reset"),t("("),s("span",{class:"hljs-string"},"'abc.def.ghi'"),t(", "),s("span",{class:"hljs-string"},"'n3w-p455w0rd'"),t(`);
+`)])],-1),mt=s("p",null,[t("Note: The token passed in the first parameter is sent in an email to the user when using "),s("code",null,"request()")],-1),gt=s("h2",{id:"items",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#items"},"#"),t(" Items")],-1),ft=s("p",null,[t("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"),t(" function. The following examples will use the "),s("code",null,"Article"),t(" type.")],-1),yt=s("blockquote",null,[s("p",null,"JavaScript")],-1),wt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"// import { Directus, ID } from '@directus/sdk';"),t(`
+`),s("span",{class:"hljs-keyword"},"const"),t(" { "),s("span",{class:"hljs-title class_"},"Directus"),t(" } = "),s("span",{class:"hljs-built_in"},"require"),t("("),s("span",{class:"hljs-string"},"'@directus/sdk'"),t(`);
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("("),s("span",{class:"hljs-string"},"'https://example.directus.app'"),t(`);
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" articles = directus."),s("span",{class:"hljs-title function_"},"items"),t("("),s("span",{class:"hljs-string"},"'articles'"),t(`);
+`)])],-1),bt=s("blockquote",null,[s("p",null,"TypeScript")],-1),kt=s("pre",null,[s("code",{class:"language-ts"},[s("span",{class:"hljs-keyword"},"import"),t(" { "),s("span",{class:"hljs-title class_"},"Directus"),t(", "),s("span",{class:"hljs-variable constant_"},"ID"),t(" } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'@directus/sdk'"),t(`;
+
+`),s("span",{class:"hljs-comment"},"// Map your collection structure based on its fields."),t(`
+`),s("span",{class:"hljs-keyword"},"type"),t(),s("span",{class:"hljs-title class_"},"Article"),t(` = {
+	`),s("span",{class:"hljs-attr"},"id"),t(": "),s("span",{class:"hljs-variable constant_"},"ID"),t(`;
+	`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-built_in"},"string"),t(`;
+	`),s("span",{class:"hljs-attr"},"body"),t(": "),s("span",{class:"hljs-built_in"},"string"),t(`;
+	`),s("span",{class:"hljs-attr"},"published"),t(": "),s("span",{class:"hljs-built_in"},"boolean"),t(`;
+};
+
+`),s("span",{class:"hljs-comment"},"// Map your collections to its respective types. The SDK will"),t(`
+`),s("span",{class:"hljs-comment"},"// infer its types based on usage later."),t(`
+`),s("span",{class:"hljs-keyword"},"type"),t(),s("span",{class:"hljs-title class_"},"MyBlog"),t(` = {
+	`),s("span",{class:"hljs-comment"},"// [collection_name]: typescript_type"),t(`
+	`),s("span",{class:"hljs-attr"},"articles"),t(": "),s("span",{class:"hljs-title class_"},"Article"),t(`;
+
+	`),s("span",{class:"hljs-comment"},"// You can also extend Directus collection. The naming has"),t(`
+	`),s("span",{class:"hljs-comment"},"// to match a Directus system collection and it will be merged"),t(`
+	`),s("span",{class:"hljs-comment"},"// into the system spec."),t(`
+	`),s("span",{class:"hljs-attr"},"directus_users"),t(`: {
+		`),s("span",{class:"hljs-attr"},"bio"),t(": "),s("span",{class:"hljs-built_in"},"string"),t(`;
+	};
+};
+
+`),s("span",{class:"hljs-comment"},"// Let the SDK know about your collection types."),t(`
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("<"),s("span",{class:"hljs-title class_"},"MyBlog"),t(">("),s("span",{class:"hljs-string"},"'https://example.directus.app'"),t(`);
+
+`),s("span",{class:"hljs-comment"},'// typeof(article) is a partial "Article"'),t(`
+`),s("span",{class:"hljs-keyword"},"const"),t(" article = "),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-title function_"},"items"),t("("),s("span",{class:"hljs-string"},"'articles'"),t(")."),s("span",{class:"hljs-title function_"},"readOne"),t("("),s("span",{class:"hljs-number"},"10"),t(`);
+
+`),s("span",{class:"hljs-comment"},'// Error TS2322: "hello" is not assignable to type "boolean".'),t(`
+`),s("span",{class:"hljs-comment"},"// post.published = 'hello';"),t(`
+`)])],-1),xt=s("h3",{id:"create-single-item",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-single-item"},"#"),t(" Create Single Item")],-1),vt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"createOne"),t(`({
+	`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-string"},"'My New Article'"),t(`,
+});
+`)])],-1),Dt=s("h3",{id:"create-multiple-items",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-multiple-items"},"#"),t(" Create Multiple Items")],-1),St=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"createMany"),t(`([
+	{
+		`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-string"},"'My First Article'"),t(`,
+	},
+	{
+		`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-string"},"'My Second Article'"),t(`,
+	},
+]);
+`)])],-1),Tt=s("h3",{id:"read-by-query",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#read-by-query"},"#"),t(" Read By Query")],-1),At=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"readByQuery"),t(`({
+	`),s("span",{class:"hljs-attr"},"search"),t(": "),s("span",{class:"hljs-string"},"'Directus'"),t(`,
+	`),s("span",{class:"hljs-attr"},"filter"),t(`: {
+		`),s("span",{class:"hljs-attr"},"date_published"),t(`: {
+			`),s("span",{class:"hljs-attr"},"_gte"),t(": "),s("span",{class:"hljs-string"},"'$NOW'"),t(`,
+		},
+	},
+});
+`)])],-1),It=s("h3",{id:"read-all",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#read-all"},"#"),t(" Read All")],-1),Rt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"readByQuery"),t(`({
+	`),s("span",{class:"hljs-comment"},"// By default API limits results to 100."),t(`
+	`),s("span",{class:"hljs-comment"},"// With -1, it will return all results, but it may lead to performance degradation"),t(`
+	`),s("span",{class:"hljs-comment"},"// for large result sets."),t(`
+	`),s("span",{class:"hljs-attr"},"limit"),t(": -"),s("span",{class:"hljs-number"},"1"),t(`,
+});
+`)])],-1),Bt=s("h3",{id:"read-single-item",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#read-single-item"},"#"),t(" Read Single Item")],-1),qt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"readOne"),t("("),s("span",{class:"hljs-number"},"15"),t(`);
+`)])],-1),Mt=s("p",null,"Supports optional query:",-1),Nt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"readOne"),t("("),s("span",{class:"hljs-number"},"15"),t(`, {
+	`),s("span",{class:"hljs-attr"},"fields"),t(": ["),s("span",{class:"hljs-string"},"'title'"),t(`],
+});
+`)])],-1),Et=s("h3",{id:"read-multiple-items",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#read-multiple-items"},"#"),t(" Read Multiple Items")],-1),Ct=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"readMany"),t("(["),s("span",{class:"hljs-number"},"15"),t(", "),s("span",{class:"hljs-number"},"16"),t(", "),s("span",{class:"hljs-number"},"17"),t(`]);
+`)])],-1),Ot=s("p",null,"Supports optional query:",-1),Pt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"readMany"),t("(["),s("span",{class:"hljs-number"},"15"),t(", "),s("span",{class:"hljs-number"},"16"),t(", "),s("span",{class:"hljs-number"},"17"),t(`], {
+	`),s("span",{class:"hljs-attr"},"fields"),t(": ["),s("span",{class:"hljs-string"},"'title'"),t(`],
+});
+`)])],-1),Lt=s("h3",{id:"update-single-item",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-single-item"},"#"),t(" Update Single Item")],-1),Ut=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"updateOne"),t("("),s("span",{class:"hljs-number"},"15"),t(`, {
+	`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-string"},"'This articles now has a different title'"),t(`,
+});
+`)])],-1),Kt=s("p",null,"Supports optional query:",-1),Ft=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"updateOne"),t(`(
+	`),s("span",{class:"hljs-number"},"42"),t(`,
+	{
+		`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-string"},"'This articles now has a similar title'"),t(`,
+	},
+	{
+		`),s("span",{class:"hljs-attr"},"fields"),t(": ["),s("span",{class:"hljs-string"},"'title'"),t(`],
+	}
+);
+`)])],-1),Wt=s("h3",{id:"update-multiple-items",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-multiple-items"},"#"),t(" Update Multiple Items")],-1),zt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"updateMany"),t("(["),s("span",{class:"hljs-number"},"15"),t(", "),s("span",{class:"hljs-number"},"42"),t(`], {
+	`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-string"},"'Both articles now have the same title'"),t(`,
+});
+`)])],-1),Jt=s("p",null,"Supports optional query:",-1),Gt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"updateMany"),t(`(
+	[`),s("span",{class:"hljs-number"},"15"),t(", "),s("span",{class:"hljs-number"},"42"),t(`],
+	{
+		`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-string"},"'Both articles now have the same title'"),t(`,
+	},
+	{
+		`),s("span",{class:"hljs-attr"},"fields"),t(": ["),s("span",{class:"hljs-string"},"'title'"),t(`],
+	}
+);
+`)])],-1),Ht=s("h3",{id:"delete",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete"},"#"),t(" Delete")],-1),Vt=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"// One"),t(`
+`),s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"deleteOne"),t("("),s("span",{class:"hljs-number"},"15"),t(`);
+
+`),s("span",{class:"hljs-comment"},"// Multiple"),t(`
+`),s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"deleteMany"),t("(["),s("span",{class:"hljs-number"},"15"),t(", "),s("span",{class:"hljs-number"},"42"),t(`]);
+`)])],-1),Qt=s("h3",{id:"request-parameter-overrides",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-parameter-overrides"},"#"),t(" Request Parameter Overrides")],-1),Yt=s("p",null,[t("To override any of the axios request parameters, provide an additional parameter with a "),s("code",null,"requestOptions"),t(" object:")],-1),$t=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" articles."),s("span",{class:"hljs-title function_"},"createOne"),t(`(
+	{ `),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-string"},"'example'"),t(` },
+	{ `),s("span",{class:"hljs-attr"},"fields"),t(": ["),s("span",{class:"hljs-string"},"'id'"),t(`] },
+	{
+		`),s("span",{class:"hljs-attr"},"requestOptions"),t(`: {
+			`),s("span",{class:"hljs-attr"},"headers"),t(`: {
+				`),s("span",{class:"hljs-string"},"'X-My-Custom-Header'"),t(": "),s("span",{class:"hljs-string"},"'example'"),t(`,
+			},
+		},
+	}
+);
+`)])],-1),Xt=s("h2",{id:"activity",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#activity"},"#"),t(" Activity")],-1),Zt=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"activity"),t(`;
+`)])],-1),sa=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_activity")'),t(".")],-1),ta=s("h2",{id:"comments",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#comments"},"#"),t(" Comments")],-1),aa=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"comments"),t(`;
+`)])],-1),ea=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_comments")'),t(".")],-1),na=s("h2",{id:"collections",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#collections"},"#"),t(" Collections")],-1),la=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"collections"),t(`;
+`)])],-1),oa=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_collections")'),t(".")],-1),ca=s("h2",{id:"fields",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#fields"},"#"),t(" Fields")],-1),ia=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"fields"),t(`;
+`)])],-1),ra=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_fields")'),t(".")],-1),ha=s("h2",{id:"files",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#files"},"#"),t(" Files")],-1),pa=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"files"),t(`;
+`)])],-1),da=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_files")'),t(".")],-1),ua=s("h3",{id:"uploading-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#uploading-a-file"},"#"),t(" Uploading a file")],-1),ja=s("p",null,[t("To upload a file you will need to send a "),s("code",null,"multipart/form-data"),t(" as body. On browser side you do so:")],-1),_a=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-comment"},"/* index.js */"),t(`
+`),s("span",{class:"hljs-keyword"},"import"),t(" { "),s("span",{class:"hljs-title class_"},"Directus"),t(" } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'https://unpkg.com/@directus/sdk@latest/dist/sdk.esm.min.js'"),t(`;
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("("),s("span",{class:"hljs-string"},"'https://example.directus.app'"),t(`, {
+	`),s("span",{class:"hljs-attr"},"auth"),t(`: {
+		`),s("span",{class:"hljs-attr"},"staticToken"),t(": "),s("span",{class:"hljs-string"},"'STATIC_TOKEN'"),t(", "),s("span",{class:"hljs-comment"},"// If you want to use a static token, otherwise check below how you can use email and password."),t(`
+	},
+});
+
+`),s("span",{class:"hljs-comment"},"// await directus.auth.login({ email, password })"),t(`
+`),s("span",{class:"hljs-comment"},"// If you want to use email and password, remove the staticToken above."),t(`
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" form = "),s("span",{class:"hljs-variable language_"},"document"),t("."),s("span",{class:"hljs-title function_"},"querySelector"),t("("),s("span",{class:"hljs-string"},"'#upload-file'"),t(`);
+
+`),s("span",{class:"hljs-keyword"},"if"),t(" (form && form "),s("span",{class:"hljs-keyword"},"instanceof"),t(),s("span",{class:"hljs-title class_"},"HTMLFormElement"),t(`) {
+	form.`),s("span",{class:"hljs-title function_"},"addEventListener"),t("("),s("span",{class:"hljs-string"},"'submit'"),t(", "),s("span",{class:"hljs-keyword"},"async"),t(` (event) => {
+		event.`),s("span",{class:"hljs-title function_"},"preventDefault"),t(`();
+
+		`),s("span",{class:"hljs-keyword"},"const"),t(" form = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"FormData"),t("(event."),s("span",{class:"hljs-property"},"target"),t(`);
+		`),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"files"),t("."),s("span",{class:"hljs-title function_"},"createOne"),t(`(form);
+	});
+}
+`)])],-1),ma=s("pre",null,[s("code",{class:"language-html"},[s("span",{class:"hljs-comment"},"<!-- index.html -->"),t(`
+`),s("span",{class:"hljs-tag"},[t("<"),s("span",{class:"hljs-name"},"head"),t(">")]),s("span",{class:"hljs-tag"},[t("</"),s("span",{class:"hljs-name"},"head"),t(">")]),t(`
+`),s("span",{class:"hljs-tag"},[t("<"),s("span",{class:"hljs-name"},"body"),t(">")]),t(`
+	`),s("span",{class:"hljs-tag"},[t("<"),s("span",{class:"hljs-name"},"form"),t(),s("span",{class:"hljs-attr"},"id"),t("="),s("span",{class:"hljs-string"},'"upload-file"'),t(">")]),t(`
+		`),s("span",{class:"hljs-tag"},[t("<"),s("span",{class:"hljs-name"},"input"),t(),s("span",{class:"hljs-attr"},"type"),t("="),s("span",{class:"hljs-string"},'"text"'),t(),s("span",{class:"hljs-attr"},"name"),t("="),s("span",{class:"hljs-string"},'"title"'),t(" />")]),t(`
+		`),s("span",{class:"hljs-tag"},[t("<"),s("span",{class:"hljs-name"},"input"),t(),s("span",{class:"hljs-attr"},"type"),t("="),s("span",{class:"hljs-string"},'"file"'),t(),s("span",{class:"hljs-attr"},"name"),t("="),s("span",{class:"hljs-string"},'"file"'),t(" />")]),t(`
+    	`),s("span",{class:"hljs-tag"},[t("<"),s("span",{class:"hljs-name"},"button"),t(">")]),t("Send"),s("span",{class:"hljs-tag"},[t("</"),s("span",{class:"hljs-name"},"button"),t(">")]),t(`
+	`),s("span",{class:"hljs-tag"},[t("</"),s("span",{class:"hljs-name"},"form"),t(">")]),t(`
+	`),s("span",{class:"hljs-tag"},[t("<"),s("span",{class:"hljs-name"},"script"),t(),s("span",{class:"hljs-attr"},"src"),t("="),s("span",{class:"hljs-string"},'"/index.js"'),t(),s("span",{class:"hljs-attr"},"type"),t("="),s("span",{class:"hljs-string"},'"module"'),t(">")]),s("span",{class:"hljs-tag"},[t("</"),s("span",{class:"hljs-name"},"script"),t(">")]),t(`
+`),s("span",{class:"hljs-tag"},[t("</"),s("span",{class:"hljs-name"},"body"),t(">")]),t(`
+`),s("span",{class:"hljs-tag"},[t("</"),s("span",{class:"hljs-name"},"html"),t(">")]),t(`
+`)])],-1),ga=s("h4",{id:"nodejs-usage",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#nodejs-usage"},"#"),t(" NodeJS usage")],-1),fa=s("p",null,"When uploading a file from a NodeJS environment, you’ll have to override the headers to ensure the correct boundary is set:",-1),ya=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),t(" { "),s("span",{class:"hljs-title class_"},"Directus"),t(" } "),s("span",{class:"hljs-keyword"},"from"),t(),s("span",{class:"hljs-string"},"'https://unpkg.com/@directus/sdk@latest/dist/sdk.esm.min.js'"),t(`;
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" directus = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"Directus"),t("("),s("span",{class:"hljs-string"},"'https://example.directus.app'"),t(`, {
+	`),s("span",{class:"hljs-attr"},"auth"),t(`: {
+		`),s("span",{class:"hljs-attr"},"staticToken"),t(": "),s("span",{class:"hljs-string"},"'STATIC_TOKEN'"),t(", "),s("span",{class:"hljs-comment"},"// If you want to use a static token, otherwise check below how you can use email and password."),t(`
+	},
+});
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" form = "),s("span",{class:"hljs-keyword"},"new"),t(),s("span",{class:"hljs-title class_"},"FormData"),t(`();
+form.`),s("span",{class:"hljs-title function_"},"append"),t("("),s("span",{class:"hljs-string"},'"file"'),t(", fs."),s("span",{class:"hljs-title function_"},"createReadStream"),t("("),s("span",{class:"hljs-string"},'"./to_upload.jpeg"'),t(`));
+
+`),s("span",{class:"hljs-keyword"},"const"),t(" fileId = "),s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"files"),t("."),s("span",{class:"hljs-title function_"},"createOne"),t(`(form, {}, {
+  `),s("span",{class:"hljs-attr"},"requestOptions"),t(`: {
+    `),s("span",{class:"hljs-attr"},"headers"),t(`: {
+      ...form.`),s("span",{class:"hljs-title function_"},"getHeaders"),t(`()
+    }
+  }
+);
+`)])],-1),wa=s("h3",{id:"importing-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#importing-a-file"},"#"),t(" Importing a file")],-1),ba=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"files"),t("."),s("span",{class:"hljs-keyword"},"import"),t(`({
+	`),s("span",{class:"hljs-attr"},"url"),t(": "),s("span",{class:"hljs-string"},"'http://www.example.com/example-image.jpg'"),t(`,
+});
+`)])],-1),ka=s("p",null,"Example of importing file with custom data:",-1),xa=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"files"),t("."),s("span",{class:"hljs-keyword"},"import"),t(`({
+	`),s("span",{class:"hljs-attr"},"url"),t(": "),s("span",{class:"hljs-string"},"'http://www.example.com/example-image.jpg'"),t(`,
+	`),s("span",{class:"hljs-attr"},"data"),t(`: {
+		`),s("span",{class:"hljs-attr"},"title"),t(": "),s("span",{class:"hljs-string"},"'My Custom File'"),t(`,
+	},
+});
+`)])],-1),va=s("h2",{id:"folders",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#folders"},"#"),t(" Folders")],-1),Da=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"folders"),t(`;
+`)])],-1),Sa=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_folders")'),t(".")],-1),Ta=s("h2",{id:"permissions",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#permissions"},"#"),t(" Permissions")],-1),Aa=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"permissions"),t(`;
+`)])],-1),Ia=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_permissions")'),t(".")],-1),Ra=s("h2",{id:"presets",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#presets"},"#"),t(" Presets")],-1),Ba=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"presets"),t(`;
+`)])],-1),qa=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_presets")'),t(".")],-1),Ma=s("h2",{id:"relations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#relations"},"#"),t(" Relations")],-1),Na=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"relations"),t(`;
+`)])],-1),Ea=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_relations")'),t(".")],-1),Ca=s("h2",{id:"revisions",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#revisions"},"#"),t(" Revisions")],-1),Oa=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"revisions"),t(`;
+`)])],-1),Pa=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_revisions")'),t(".")],-1),La=s("h2",{id:"roles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#roles"},"#"),t(" Roles")],-1),Ua=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"roles"),t(`;
+`)])],-1),Ka=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_roles")'),t(".")],-1),Fa=s("h2",{id:"settings",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#settings"},"#"),t(" Settings")],-1),Wa=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"settings"),t(`;
+`)])],-1),za=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_settings")'),t(".")],-1),Ja=s("h2",{id:"server",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#server"},"#"),t(" Server")],-1),Ga=s("h3",{id:"ping-the-server",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#ping-the-server"},"#"),t(" Ping the Server")],-1),Ha=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"server"),t("."),s("span",{class:"hljs-title function_"},"ping"),t(`();
+`)])],-1),Va=s("h3",{id:"get-server%2Fproject-info",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#get-server%2Fproject-info"},"#"),t(" Get Server/Project Info")],-1),Qa=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"server"),t("."),s("span",{class:"hljs-title function_"},"info"),t(`();
+`)])],-1),Ya=s("h2",{id:"users",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#users"},"#"),t(" Users")],-1),$a=s("pre",null,[s("code",{class:"language-js"},[t("directus."),s("span",{class:"hljs-property"},"users"),t(`;
+`)])],-1),Xa=s("p",null,[t("Same methods as "),s("code",null,'directus.items("directus_users")'),t(", and:")],-1),Za=s("h3",{id:"invite-a-new-user",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#invite-a-new-user"},"#"),t(" Invite a New User")],-1),se=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"users"),t("."),s("span",{class:"hljs-property"},"invites"),t("."),s("span",{class:"hljs-title function_"},"send"),t("("),s("span",{class:"hljs-string"},"'admin@example.com'"),t(", "),s("span",{class:"hljs-string"},"'fe38136e-52f7-4622-8498-112b8a32a1e2'"),t(`);
+`)])],-1),te=s("p",null,"The second parameter is the role of the user",-1),ae=s("h3",{id:"accept-a-user-invite",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#accept-a-user-invite"},"#"),t(" Accept a User Invite")],-1),ee=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"users"),t("."),s("span",{class:"hljs-property"},"invites"),t("."),s("span",{class:"hljs-title function_"},"accept"),t("("),s("span",{class:"hljs-string"},"'<accept-token>'"),t(", "),s("span",{class:"hljs-string"},"'n3w-p455w0rd'"),t(`);
+`)])],-1),ne=s("p",null,"The provided token is sent to the user’s email",-1),le=s("h3",{id:"enable-two-factor-authentication",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#enable-two-factor-authentication"},"#"),t(" Enable Two-Factor Authentication")],-1),oe=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"users"),t("."),s("span",{class:"hljs-property"},"tfa"),t("."),s("span",{class:"hljs-title function_"},"enable"),t("("),s("span",{class:"hljs-string"},"'my-password'"),t(`);
+`)])],-1),ce=s("h3",{id:"disable-two-factor-authentication",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#disable-two-factor-authentication"},"#"),t(" Disable Two-Factor Authentication")],-1),ie=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"users"),t("."),s("span",{class:"hljs-property"},"tfa"),t("."),s("span",{class:"hljs-title function_"},"disable"),t("("),s("span",{class:"hljs-string"},"'691402'"),t(`);
+`)])],-1),re=s("h3",{id:"get-the-current-user",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#get-the-current-user"},"#"),t(" Get the Current User")],-1),he=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"users"),t("."),s("span",{class:"hljs-property"},"me"),t("."),s("span",{class:"hljs-title function_"},"read"),t(`();
+`)])],-1),pe=s("p",null,"Supports optional query:",-1),de=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"users"),t("."),s("span",{class:"hljs-property"},"me"),t("."),s("span",{class:"hljs-title function_"},"read"),t(`({
+	`),s("span",{class:"hljs-attr"},"fields"),t(": ["),s("span",{class:"hljs-string"},"'last_access'"),t(`],
+});
+`)])],-1),ue=s("h3",{id:"update-the-current-users",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-the-current-users"},"#"),t(" Update the Current Users")],-1),je=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"users"),t("."),s("span",{class:"hljs-property"},"me"),t("."),s("span",{class:"hljs-title function_"},"update"),t("({ "),s("span",{class:"hljs-attr"},"first_name"),t(": "),s("span",{class:"hljs-string"},"'Admin'"),t(` });
+`)])],-1),_e=s("p",null,"Supports optional query:",-1),me=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"users"),t("."),s("span",{class:"hljs-property"},"me"),t("."),s("span",{class:"hljs-title function_"},"update"),t("({ "),s("span",{class:"hljs-attr"},"first_name"),t(": "),s("span",{class:"hljs-string"},"'Admin'"),t(" }, { "),s("span",{class:"hljs-attr"},"fields"),t(": ["),s("span",{class:"hljs-string"},"'last_access'"),t(`] });
+`)])],-1),ge=s("h2",{id:"utils",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#utils"},"#"),t(" Utils")],-1),fe=s("h3",{id:"get-a-random-string",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#get-a-random-string"},"#"),t(" Get a Random String")],-1),ye=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"utils"),t("."),s("span",{class:"hljs-property"},"random"),t("."),s("span",{class:"hljs-title function_"},"string"),t(`();
+`)])],-1),we=s("p",null,[t("Supports an optional "),s("code",null,"length"),t(" (defaults to 32):")],-1),be=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"utils"),t("."),s("span",{class:"hljs-property"},"random"),t("."),s("span",{class:"hljs-title function_"},"string"),t("("),s("span",{class:"hljs-number"},"50"),t(`);
+`)])],-1),ke=s("h3",{id:"generate-a-hash-for-a-given-value",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#generate-a-hash-for-a-given-value"},"#"),t(" Generate a Hash for a Given Value")],-1),xe=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"utils"),t("."),s("span",{class:"hljs-property"},"hash"),t("."),s("span",{class:"hljs-title function_"},"generate"),t("("),s("span",{class:"hljs-string"},"'My String'"),t(`);
+`)])],-1),ve=s("h3",{id:"verify-if-a-hash-is-valid",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#verify-if-a-hash-is-valid"},"#"),t(" Verify if a Hash is Valid")],-1),De=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"utils"),t("."),s("span",{class:"hljs-property"},"hash"),t("."),s("span",{class:"hljs-title function_"},"verify"),t("("),s("span",{class:"hljs-string"},"'My String'"),t(", "),s("span",{class:"hljs-string"},"'$argon2i$v=19$m=4096,t=3,p=1$A5uogJh'"),t(`);
+`)])],-1),Se=s("h3",{id:"sort-items-in-a-collection",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#sort-items-in-a-collection"},"#"),t(" Sort Items in a Collection")],-1),Te=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"utils"),t("."),s("span",{class:"hljs-title function_"},"sort"),t("("),s("span",{class:"hljs-string"},"'articles'"),t(", "),s("span",{class:"hljs-number"},"15"),t(", "),s("span",{class:"hljs-number"},"42"),t(`);
+`)])],-1),Ae=s("p",null,[t("This will move item "),s("code",null,"15"),t(" to the position of item "),s("code",null,"42"),t(", and move everything in between one “slot” up.")],-1),Ie=s("h3",{id:"revert-to-a-previous-revision",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#revert-to-a-previous-revision"},"#"),t(" Revert to a Previous Revision")],-1),Re=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"await"),t(" directus."),s("span",{class:"hljs-property"},"utils"),t("."),s("span",{class:"hljs-title function_"},"revert"),t("("),s("span",{class:"hljs-number"},"451"),t(`);
+`)])],-1),Be=s("p",null,"Note: The key passed is the primary key of the revision you’d like to apply.",-1),qe=s("hr",null,null,-1),Oe="JavaScript SDK",Pe=!1,Le="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 [Axios](https://npmjs.com/axios) for transport and `localStorage` for storing state.",Ue="14 min read",Ke={__name:"sdk",setup(Me,{expose:c}){const l={title:"JavaScript SDK",modularExtension:!1,description:"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 [Axios](https://npmjs.com/axios) for transport and `localStorage` for storing state.",readTime:"14 min read"};return c({frontmatter:l}),(Ne,Ee)=>{const e=o("router-link"),i=o("docs-wrapper");return r(),h(i,{frontmatter:l},{default:a(()=>[s("div",p,[d,u,j,_,m,g,s("p",null,[t("You can always access data available to the "),n(e,{to:"/docs/configuration/users-roles-permissions.html#directus-roles"},{default:a(()=>[t("public role")]),_:1}),t(".")]),f,y,s("p",null,[t("To access anything that is not available to the "),n(e,{to:"/docs/configuration/users-roles-permissions.html#directus-roles"},{default:a(()=>[t("public role")]),_:1}),t(", you must be "),n(e,{to:"/docs/reference/authentication.md"},{default:a(()=>[t("authenticated")]),_:1}),t(".")]),w,b,k,x,v,D,S,T,A,I,R,B,q,M,N,E,C,O,P,L,U,K,F,W,z,J,G,H,V,Q,Y,$,X,Z,ss,ts,as,es,ns,ls,os,cs,is,rs,hs,ps,ds,us,js,_s,ms,gs,fs,ys,ws,bs,ks,xs,vs,Ds,Ss,Ts,As,Is,Rs,Bs,qs,Ms,Ns,Es,Cs,Os,Ps,Ls,Us,Ks,Fs,Ws,zs,Js,Gs,Hs,Vs,Qs,Ys,$s,Xs,Zs,st,tt,at,s("div",et,[nt,s("p",null,[t("If you’re 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 "),n(e,{to:"/docs/self-hosted/config-options#security"},{default:a(()=>[t("disable secure cookies")]),_:1}),t(".")])]),lt,ot,ct,it,rt,ht,pt,s("p",null,[dt,t(": To use a custom address you need to configure the "),n(e,{to:"/docs/self-hosted/config-options#security"},{default:a(()=>[ut,t(" environment variable")]),_:1}),t(" to enable this feature.")]),jt,_t,mt,gt,ft,yt,wt,bt,kt,xt,vt,Dt,St,Tt,At,It,Rt,Bt,qt,Mt,Nt,Et,Ct,Ot,Pt,Lt,Ut,Kt,Ft,Wt,zt,Jt,Gt,Ht,Vt,Qt,Yt,$t,Xt,Zt,sa,ta,aa,ea,na,la,oa,ca,ia,ra,ha,pa,da,ua,ja,_a,ma,ga,fa,ya,wa,s("p",null,[t("Example of "),n(e,{to:"/docs/reference/files#import-a-file"},{default:a(()=>[t("importing a file from a URL")]),_:1}),t(":")]),ba,ka,xa,va,Da,Sa,Ta,Aa,Ia,Ra,Ba,qa,Ma,Na,Ea,Ca,Oa,Pa,La,Ua,Ka,Fa,Wa,za,Ja,Ga,Ha,Va,Qa,Ya,$a,Xa,Za,se,te,ae,ee,ne,le,oe,ce,ie,re,he,pe,de,ue,je,_e,me,ge,fe,ye,we,be,ke,xe,ve,De,Se,Te,Ae,Ie,Re,Be,qe])]),_:1})}}};export{Ke as default,Le as description,Pe as modularExtension,Ue as readTime,Oe as title};