@directus/app 9.13.0 → 9.14.2

package/dist/assets/users.9e656e05.js

@@ -0,0 +1,252 @@
+import{a as r,o as h,b as i,w as a,g as s,e as n,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const u={class:"markdown-body"},d={class:"two-up"},p={class:"left"},_=e("Directus Users are the individual accounts that let you authenticate into the API and App. Each user belongs to a Role which defines its granular Permissions. "),g=e("Learn more about Users"),f=e("."),j=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-user-object"},"The User Object ")]),s("li",null,[s("a",{href:"#list-users"},"List Users ")]),s("li",null,[s("a",{href:"#retrieve-a-user"},"Retrieve a User ")]),s("li",null,[s("a",{href:"#retrieve-the-current-user"},"Retrieve the Current User ")]),s("li",null,[s("a",{href:"#update-the-current-user"},"Update the Current User ")]),s("li",null,[s("a",{href:"#create-a-user"},"Create a User ")]),s("li",null,[s("a",{href:"#create-multiple-users"},"Create Multiple Users ")]),s("li",null,[s("a",{href:"#update-a-user"},"Update a User ")]),s("li",null,[s("a",{href:"#update-multiple-users"},"Update Multiple Users ")]),s("li",null,[s("a",{href:"#delete-a-user"},"Delete a User ")]),s("li",null,[s("a",{href:"#delete-multiple-users"},"Delete Multiple Users ")]),s("li",null,[s("a",{href:"#invite-a-new-user"},"Invite a new User ")]),s("li",null,[s("a",{href:"#accept-user-invite"},"Accept User Invite ")]),s("li",null,[s("a",{href:"#generate-two-factor-authentication-secret"},"Generate Two-Factor Authentication Secret ")]),s("li",null,[s("a",{href:"#enable-two-factor-authentication"},"Enable Two-Factor Authentication ")]),s("li",null,[s("a",{href:"#disable-two-factor-authentication"},"Disable Two-Factor Authentication ")])])])])],-1),m=s("hr",null,null,-1),b=s("h2",{id:"the-user-object",tabindex:"-1"},[e("The User Object "),s("a",{class:"header-anchor",href:"#the-user-object"},"#")],-1),y={class:"two-up"},x={class:"left"},q={class:"definitions"},v=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the user.")],-1),w=s("p",null,[s("code",null,"first_name"),e(),s("strong",null,"string"),s("br"),e(" First name of the user.")],-1),T=s("p",null,[s("code",null,"last_name"),e(),s("strong",null,"string"),s("br"),e(" Last name of the user.")],-1),R=s("p",null,[s("code",null,"email"),e(),s("strong",null,"string"),s("br"),e(" Email address of the user.")],-1),E=s("p",null,[s("code",null,"password"),e(),s("strong",null,"hash"),s("br"),e(" Password of the user.")],-1),S=s("p",null,[s("code",null,"location"),e(),s("strong",null,"string"),s("br"),e(" Location of the user.")],-1),k=s("p",null,[s("code",null,"title"),e(),s("strong",null,"string"),s("br"),e(" Title of the user.")],-1),P=s("p",null,[s("code",null,"description"),e(),s("strong",null,"string"),s("br"),e(" Description of the user.")],-1),A=s("p",null,[s("code",null,"tags"),e(),s("strong",null,"csv"),s("br"),e(" Tags for the user.")],-1),U=s("code",null,"avatar",-1),O=e(),L=s("strong",null,"many-to-one",-1),C=s("br",null,null,-1),I=e(" Avatar file. Many-to-one to "),Q=e("files"),G=e("."),B=s("p",null,[s("code",null,"language"),e(),s("strong",null,"string"),s("br"),e(" Language the Admin App is rendered in. See "),s("a",{href:"https://locales.directus.io",target:"_blank",rel:"noopener noreferrer"},"our Crowdin page"),e(" for all available languages and translations.")],-1),D=s("p",null,[s("code",null,"theme"),e(),s("strong",null,"string"),s("br"),e(" One of "),s("code",null,"auto"),e(", "),s("code",null,"light"),e(", "),s("code",null,"dark"),e(".")],-1),M=s("p",null,[s("code",null,"tfa_secret"),e(),s("strong",null,"string"),s("br"),e(" When TFA is enabled, this holds the secret key for it.")],-1),F=s("p",null,[s("code",null,"status"),e(),s("strong",null,"string"),s("br"),e(" Status of the user. One of "),s("code",null,"draft"),e(", "),s("code",null,"invited"),e(", "),s("code",null,"active"),e(", "),s("code",null,"suspended"),e(", "),s("code",null,"archived"),e(".")],-1),H=s("code",null,"role",-1),N=e(),V=s("strong",null,"uuid",-1),W=s("br",null,null,-1),Y=e(" Role of the user. Many-to-one to "),z=e("roles"),J=e("."),K=s("p",null,[s("code",null,"token"),e(),s("strong",null,"string"),s("br"),e(" Static access token for the user.")],-1),X=s("p",null,[s("code",null,"last_access"),e(),s("strong",null,"date"),s("br"),e(" Last time the user accessed the API.")],-1),Z=s("p",null,[s("code",null,"last_page"),e(),s("strong",null,"string"),s("br"),e(" Last page in the app the user used.")],-1),$=s("p",null,[s("code",null,"provider"),e(),s("strong",null,"string"),s("br"),e(" What auth provider was used to register this user.")],-1),ss=s("p",null,[s("code",null,"external_identifier"),e(),s("strong",null,"string"),s("br"),e(" Primary key of the user in the third party authentication provider, if used.")],-1),es=s("p",null,[s("code",null,"auth_data"),e(),s("strong",null,"json"),s("br"),e(" Required data about the user as provided by the third party auth provider, if used.")],-1),as=s("p",null,[s("code",null,"email_notifications"),e(),s("strong",null,"boolean"),s("br"),e(" When this is enabled, the user will receive emails for notifications.")],-1),ts=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"first_name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Admin"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"last_name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"User"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"email"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"admin@example.com"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"password"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"**********"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"location"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"New York City"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"CTO"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"tags"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"avatar"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"language"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"en-US"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"theme"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"auto"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"tfa_secret"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"active"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"token"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"last_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"2021-02-05T10:18:13-05:00"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"last_page"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"/settings/roles/653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])])],-1),ns=s("hr",null,null,-1),ls=s("h2",{id:"list-users",tabindex:"-1"},[e("List Users "),s("a",{class:"header-anchor",href:"#list-users"},"#")],-1),rs=s("p",null,"List all users that exist in Directus.",-1),cs={class:"two-up"},os={class:"left"},hs=s("h3",{id:"query-parameters",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),is=e("Supports all "),us=e("global query parameters"),ds=e("."),ps=s("h3",{id:"returns",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),_s=e("An array of up to "),gs=e("limit"),fs=e(),js=s("a",{href:"#the-user-object"},"user objects",-1),ms=e(". If no items are available, data will be an empty array."),bs={class:"right"},ys=s("h3",{id:"rest-api",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),xs=s("pre",null,[s("code",null,`GET /users
+SEARCH /users
+`)],-1),qs=e("Learn more about SEARCH ->"),vs=s("h3",{id:"graphql",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ws=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Ts=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	users: [directus_users]
+}
+`)])],-1),Rs=s("h5",{id:"example",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),Es=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	users {
+		first_name
+		last_name
+		email
+	}
+}
+`)])],-1),Ss=s("hr",null,null,-1),ks=s("h2",{id:"retrieve-a-user",tabindex:"-1"},[e("Retrieve a User "),s("a",{class:"header-anchor",href:"#retrieve-a-user"},"#")],-1),Ps=s("p",null,"List an existing user by primary key.",-1),As={class:"two-up"},Us={class:"left"},Os=s("h3",{id:"query-parameters-1",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),Ls=e("Supports all "),Cs=e("global query parameters"),Is=e("."),Qs=s("h3",{id:"returns-1",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),Gs=s("p",null,[e("Returns the requested "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),Bs=s("div",{class:"right"},[s("h3",{id:"rest-api-1",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),s("pre",null,[s("code",null,`GET /users/:id
+`)]),s("h5",{id:"example-1",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-1"},"#")]),s("pre",null,[s("code",null,`GET /users/72a1ce24-4748-47de-a05f-ce9af3033727
+`)]),s("h3",{id:"graphql-1",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-1"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	users_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_users
+}
+`)])]),s("h5",{id:"example-2",tabindex:"-1"},[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(` {
+	users_by_id(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(`) {
+		first_name
+		last_name
+		email
+	}
+}
+`)])])],-1),Ds=s("hr",null,null,-1),Ms=s("h2",{id:"retrieve-the-current-user",tabindex:"-1"},[e("Retrieve the Current User "),s("a",{class:"header-anchor",href:"#retrieve-the-current-user"},"#")],-1),Fs=s("p",null,"Retrieve the currently authenticated user.",-1),Hs={class:"two-up"},Ns={class:"left"},Vs=s("h3",{id:"query-parameters-2",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Ws=e("Supports all "),Ys=e("global query parameters"),zs=e("."),Js=s("h3",{id:"returns-2",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),Ks=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the currently authenticated user.")],-1),Xs=s("div",{class:"right"},[s("h3",{id:"rest-api-2",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`GET /users/me
+`)]),s("h3",{id:"graphql-2",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	users_me: directus_users
+}
+`)])]),s("h5",{id:"example-3",tabindex:"-1"},[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(` {
+	users_me {
+		email
+	}
+}
+`)])])],-1),Zs=s("hr",null,null,-1),$s=s("h2",{id:"update-the-current-user",tabindex:"-1"},[e("Update the Current User "),s("a",{class:"header-anchor",href:"#update-the-current-user"},"#")],-1),se=s("p",null,"Update the authenticated user.",-1),ee={class:"two-up"},ae={class:"left"},te=s("h3",{id:"query-parameters-3",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),ne=e("Supports all "),le=e("global query parameters"),re=e("."),ce=s("h3",{id:"returns-3",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),oe=s("p",null,[e("Returns the updated "),s("a",{href:"#the-user-object"},"user object"),e(" for the authenticated user.")],-1),he=s("div",{class:"right"},[s("h3",{id:"rest-api-3",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`PATCH /users/me
+`)]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /users/me"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"email"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"new.email@example.com"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-3",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_users_me(data: update_directus_users_input!): directus_users
+}
+`)])]),s("h5",{id:"example-4",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_users_me(data: { email: `),s("span",{class:"hljs-string"},'"new.email@example.com"'),e(` }) {
+		email
+	}
+}
+`)])])],-1),ie=s("hr",null,null,-1),ue=s("h2",{id:"create-a-user",tabindex:"-1"},[e("Create a User "),s("a",{class:"header-anchor",href:"#create-a-user"},"#")],-1),de=s("p",null,"Create a new user",-1),pe={class:"two-up"},_e={class:"left"},ge=s("h3",{id:"query-parameters-4",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),fe=e("Supports all "),je=e("global query parameters"),me=e("."),be=s("h3",{id:"request-body",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),ye=s("p",null,[e("A partial "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),xe=s("p",null,[s("code",null,"email"),e(" and "),s("code",null,"password"),e(" are required to authenticate with the default authentication provider.")],-1),qe=s("h3",{id:"returns-4",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),ve=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the created user.")],-1),we=s("div",{class:"right"},[s("h3",{id:"rest-api-4",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`POST /users
+`)]),s("h5",{id:"example-5",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"email"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"another@example.com"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"password"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"d1r3ctu5"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-4",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_users_item(data: create_directus_users_input!): directus_users
+}
+`)])]),s("h5",{id:"example-6",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_users_item(
+		data: { email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(` }
+	) {
+		email
+		role
+	}
+}
+`)])])],-1),Te=s("hr",null,null,-1),Re=s("h2",{id:"create-multiple-users",tabindex:"-1"},[e("Create Multiple Users "),s("a",{class:"header-anchor",href:"#create-multiple-users"},"#")],-1),Ee=s("p",null,"Create multiple new users",-1),Se={class:"two-up"},ke={class:"left"},Pe=s("h3",{id:"query-parameters-5",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ae=e("Supports all "),Ue=e("global query parameters"),Oe=e("."),Le=s("h3",{id:"request-body-1",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-1"},"#")],-1),Ce=s("p",null,[e("An array of partial "),s("a",{href:"#the-user-object"},"user objects"),e(".")],-1),Ie=s("p",null,[s("code",null,"email"),e(" and "),s("code",null,"password"),e(" are required.")],-1),Qe=s("h3",{id:"returns-5",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),Ge=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user objects"),e(" for the created users.")],-1),Be=s("div",{class:"right"},[s("h3",{id:"rest-api-5",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`POST /users
+`)]),s("h5",{id:"example-7",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"["),e(`
+	`),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"email"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"admin@example.com"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"password"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"p455w0rd"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"email"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"another@example.com"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"password"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"d1r3ctu5"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`),s("span",{class:"hljs-punctuation"},"]"),e(`
+`)])]),s("h3",{id:"graphql-5",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_users_items(data: [create_directus_users_input!]!): [directus_users]
+}
+`)])]),s("h5",{id:"example-8",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_users_items(
+		data: [
+			{ email: `),s("span",{class:"hljs-string"},'"admin@example.com"'),e(", password: "),s("span",{class:"hljs-string"},'"p455w0rd"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(` }
+			{ email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(` }
+		]
+	) {
+		email
+		role
+	}
+}
+`)])])],-1),De=s("hr",null,null,-1),Me=s("h2",{id:"update-a-user",tabindex:"-1"},[e("Update a User "),s("a",{class:"header-anchor",href:"#update-a-user"},"#")],-1),Fe=s("p",null,"Update an existing user.",-1),He={class:"two-up"},Ne={class:"left"},Ve=s("h3",{id:"query-parameters-6",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),We=e("Supports all "),Ye=e("global query parameters"),ze=e("."),Je=s("h3",{id:"request-body-2",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Ke=s("p",null,[e("A partial "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),Xe=s("h3",{id:"returns-6",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ze=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the updated user.")],-1),$e=s("div",{class:"right"},[s("h3",{id:"rest-api-6",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",null,`PATCH /users/:id
+`)]),s("h5",{id:"example-9",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /users/72a1ce24-4748-47de-a05f-ce9af3033727"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"CTO"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-6",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_users_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_users_input!): directus_users
+}
+`)])]),s("h5",{id:"example-10",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_users_item(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", data: { title: "),s("span",{class:"hljs-string"},'"CTO"'),e(` }) {
+		first_name
+		last_name
+	}
+}
+`)])])],-1),sa=s("hr",null,null,-1),ea=s("h2",{id:"update-multiple-users",tabindex:"-1"},[e("Update Multiple Users "),s("a",{class:"header-anchor",href:"#update-multiple-users"},"#")],-1),aa=s("p",null,"Update multiple existing users.",-1),ta={class:"two-up"},na={class:"left"},la=s("h3",{id:"query-parameters-7",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-7"},"#")],-1),ra=e("Supports all "),ca=e("global query parameters"),oa=e("."),ha=s("h3",{id:"request-body-3",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),ia=s("div",{class:"definitions"},[s("p",null,[s("code",null,"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the users you\u2019d like to update.")]),s("p",null,[s("code",null,"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-user-object"},"the user object"),e("\u2019s properties.")])],-1),ua=s("h3",{id:"returns-7",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-7"},"#")],-1),da=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user objects"),e(" for the updated users.")],-1),pa=s("div",{class:"right"},[s("h3",{id:"rest-api-7",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",null,`PATCH /users
+`)]),s("h5",{id:"example-11",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-11"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /users"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"keys"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"CTO"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-7",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_users_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_users_input!): [directus_users]
+}
+`)])]),s("h5",{id:"example-12",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_users_items(
+		ids: [`),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`]
+		data: { title: `),s("span",{class:"hljs-string"},'"CTO"'),e(` }
+	) {
+		first_name
+		last_name
+	}
+}
+`)])])],-1),_a=s("hr",null,null,-1),ga=s("h2",{id:"delete-a-user",tabindex:"-1"},[e("Delete a User "),s("a",{class:"header-anchor",href:"#delete-a-user"},"#")],-1),fa=s("p",null,"Delete an existing user.",-1),ja=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-8",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-8",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",null,`DELETE /users/:id
+`)]),s("h5",{id:"example-13",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),s("pre",null,[s("code",null,`DELETE /users/72a1ce24-4748-47de-a05f-ce9af3033727
+`)]),s("h3",{id:"graphql-8",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_users_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
+}
+`)])]),s("h5",{id:"example-14",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_users_item(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(`) {
+		id
+	}
+}
+`)])])])],-1),ma=s("hr",null,null,-1),ba=s("h2",{id:"delete-multiple-users",tabindex:"-1"},[e("Delete Multiple Users "),s("a",{class:"header-anchor",href:"#delete-multiple-users"},"#")],-1),ya=s("p",null,"Delete multiple existing users.",-1),xa=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-4",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")]),s("p",null,"An array of user primary keys"),s("h3",{id:"returns-9",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-9"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-9",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),s("pre",null,[s("code",null,`DELETE /users
+`)]),s("h5",{id:"example-15",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-15"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// Request"),e(`
+`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},"]"),e(`
+`)])]),s("h3",{id:"graphql-9",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-9"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_users_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
+}
+`)])]),s("h5",{id:"example-16",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-16"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_users_items(ids: [`),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`]) {
+		ids
+	}
+}
+`)])])])],-1),qa=s("hr",null,null,-1),va=s("h2",{id:"invite-a-new-user",tabindex:"-1"},[e("Invite a new User "),s("a",{class:"header-anchor",href:"#invite-a-new-user"},"#")],-1),wa=s("p",null,"Invite a new user by email.",-1),Ta={class:"two-up"},Ra={class:"left"},Ea=s("h3",{id:"request-body-5",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")],-1),Sa={class:"definitions"},ka=s("p",null,[s("code",null,"email"),e(),s("strong",null,"Required"),s("br"),e(" User email to invite.")],-1),Pa=s("p",null,[s("code",null,"role"),e(),s("strong",null,"Required"),s("br"),e(" Role of the new user.")],-1),Aa=s("code",null,"invite_url",-1),Ua=s("br",null,null,-1),Oa=e(" Provide a custom invite url which the link in the email will lead to. The invite token will be passed as a parameter."),La=s("br",null,null,-1),Ca=s("strong",null,"Note",-1),Ia=e(": You need to configure the "),Qa=s("code",null,"USER_INVITE_URL_ALLOW_LIST",-1),Ga=e(" environment variable"),Ba=e(" to enable this feature."),Da=s("h3",{id:"returns-10",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-10"},"#")],-1),Ma=s("p",null,"Empty body.",-1),Fa=s("div",{class:"right"},[s("h3",{id:"rest-api-10",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-10"},"#")]),s("pre",null,[s("code",null,`POST /users/invite
+`)]),s("h5",{id:"example-17",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-17"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/invite"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"email"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"another@example.com"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-10",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-10"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_invite(email:`),s("span",{class:"hljs-type"}," String"),e("!, role:"),s("span",{class:"hljs-type"}," String"),e("!, invite_url:"),s("span",{class:"hljs-type"}," String"),e("):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])]),s("h5",{id:"example-18",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-18"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_invite(email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`)
+}
+`)])])],-1),Ha=s("hr",null,null,-1),Na=s("h2",{id:"accept-user-invite",tabindex:"-1"},[e("Accept User Invite "),s("a",{class:"header-anchor",href:"#accept-user-invite"},"#")],-1),Va=s("p",null,[e("Accept your invite. The "),s("a",{href:"#invite-a-new-user"},"invite user endpoint"),e(" sends the email a link to the Admin App.")],-1),Wa=s("p",null,"This link includes a token, which is then used to activate the invited user.",-1),Ya=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-6",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-6"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"token"),e(),s("strong",null,"Required"),s("br"),e(" Accept invite token.")]),s("p",null,[s("code",null,"password"),e(),s("strong",null,"Required"),s("br"),e(" Password for the user.")])]),s("h3",{id:"returns-11",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-11"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-11",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-11"},"#")]),s("pre",null,[s("code",null,`POST /users/invite/accept
+`)]),s("h5",{id:"example-19",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-19"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/invite/accept"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"token"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"password"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-11",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-11"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_invite_accept(token:`),s("span",{class:"hljs-type"}," String"),e("!, password:"),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])]),s("h5",{id:"example-20",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-20"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_invite_accept(token: `),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`)
+}
+`)])])])],-1),za=s("hr",null,null,-1),Ja=s("h2",{id:"generate-two-factor-authentication-secret",tabindex:"-1"},[e("Generate Two-Factor Authentication Secret "),s("a",{class:"header-anchor",href:"#generate-two-factor-authentication-secret"},"#")],-1),Ka=s("p",null,"Generates a secret and returns the URL to be used in an authenticator app.",-1),Xa=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-7",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-7"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"password"),e(),s("strong",null,"Required"),s("br"),e(" The user\u2019s password.")])]),s("h3",{id:"returns-12",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-12"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"secret"),e(),s("strong",null,"string"),s("br"),e(" OTP secret to be saved in the authenticator app.")]),s("p",null,[s("code",null,"otpauth_url"),e(),s("strong",null,"string"),s("br"),s("code",null,"otpauth://"),e(" formatted URL. Can be rendered as QR code and used in most authenticator apps.")])])]),s("div",{class:"right"},[s("h3",{id:"rest-api-12",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-12"},"#")]),s("pre",null,[s("code",null,`POST /users/me/tfa/generate
+`)]),s("h5",{id:"example-21",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-21"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/me/tfa/generate"),e(`
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"password"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-12",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-12"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_me_tfa_generate(password:`),s("span",{class:"hljs-type"}," String"),e(`!): users_me_tfa_generate_data
+}
+`)])]),s("h5",{id:"example-22",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-22"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_me_tfa_generate(password: `),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`) {
+		secret
+		otpauth_url
+	}
+}
+`)])])])],-1),Za=s("hr",null,null,-1),$a=s("h2",{id:"enable-two-factor-authentication",tabindex:"-1"},[e("Enable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#enable-two-factor-authentication"},"#")],-1),st=s("p",null,"Adds a TFA secret to the user account.",-1),et=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-8",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-8"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"secret"),e(),s("strong",null,"Required"),s("br"),e(" The TFA secret from tfa/generate.")]),s("p",null,[s("code",null,"otp"),e(),s("strong",null,"Required"),s("br"),e(" OTP generated with the secret, to recheck if the user has a correct TFA setup")])]),s("h3",{id:"returns-13",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-13"},"#")]),s("div",{class:"definitions"},[s("p",null,"Empty response.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-13",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-13"},"#")]),s("pre",null,[s("code",null,`POST /users/me/tfa/enable
+`)]),s("h5",{id:"example-23",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-23"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/me/tfa/enable"),e(`
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"otp"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"123456"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"secret"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"3CtiutsNBmY3szHE"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-13",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-13"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_me_tfa_enable(otp:`),s("span",{class:"hljs-type"}," String"),e("!, secret:"),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])]),s("h5",{id:"example-24",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-24"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_me_tfa_enable(otp: `),s("span",{class:"hljs-string"},'"123456"'),e(", secret: "),s("span",{class:"hljs-string"},'"3CtiutsNBmY3szHE"'),e(`)
+}
+`)])])])],-1),at=s("hr",null,null,-1),tt=s("h2",{id:"disable-two-factor-authentication",tabindex:"-1"},[e("Disable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#disable-two-factor-authentication"},"#")],-1),nt=s("p",null,"Disables two-factor authentication by removing the OTP secret from the user.",-1),lt=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-9",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-9"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"otp"),e(),s("strong",null,"Required"),s("br"),e(" One-time password generated by the authenticator app.")])]),s("h3",{id:"returns-14",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-14"},"#")]),s("p",null,"Empty response.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-14",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-14"},"#")]),s("pre",null,[s("code",null,`POST /users/me/tfa/disable
+`)]),s("h5",{id:"example-25",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-25"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/me/tfa/disable"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"otp"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"859014"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-14",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-14"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_me_tfa_disable(otp:`),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])]),s("h5",{id:"example-26",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-26"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_me_tfa_disable(otp: `),s("span",{class:"hljs-string"},'"591763"'),e(`)
+}
+`)])])])],-1),it="Users",ut=!1,dt="page-reference",pt={name:"users",setup(rt,{expose:c}){const l={title:"Users",modularExtension:!1,pageClass:"page-reference"};return c({frontmatter:l}),(ct,ot)=>{const t=r("router-link"),o=r("docs-wrapper");return h(),i(o,{frontmatter:l},{default:a(()=>[s("div",u,[s("div",d,[s("div",p,[s("blockquote",null,[s("p",null,[_,n(t,{to:"/docs/getting-started/glossary/#users/"},{default:a(()=>[g]),_:1}),f])])]),j]),m,b,s("div",y,[s("div",x,[s("div",q,[v,w,T,R,E,S,k,P,A,s("p",null,[U,O,L,C,I,n(t,{to:"/docs/reference/files/"},{default:a(()=>[Q]),_:1}),G]),B,D,M,F,s("p",null,[H,N,V,W,Y,n(t,{to:"/docs/reference/roles"},{default:a(()=>[z]),_:1}),J]),K,X,Z,$,ss,es,as])]),ts]),ns,ls,rs,s("div",cs,[s("div",os,[hs,s("p",null,[is,n(t,{to:"/docs/reference/query"},{default:a(()=>[us]),_:1}),ds]),ps,s("p",null,[_s,n(t,{to:"/docs/reference/query/#limit"},{default:a(()=>[gs]),_:1}),fs,js,ms])]),s("div",bs,[ys,xs,s("p",null,[n(t,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[qs]),_:1})]),vs,ws,Ts,Rs,Es])]),Ss,ks,Ps,s("div",As,[s("div",Us,[Os,s("p",null,[Ls,n(t,{to:"/docs/reference/query"},{default:a(()=>[Cs]),_:1}),Is]),Qs,Gs]),Bs]),Ds,Ms,Fs,s("div",Hs,[s("div",Ns,[Vs,s("p",null,[Ws,n(t,{to:"/docs/reference/query"},{default:a(()=>[Ys]),_:1}),zs]),Js,Ks]),Xs]),Zs,$s,se,s("div",ee,[s("div",ae,[te,s("p",null,[ne,n(t,{to:"/docs/reference/query"},{default:a(()=>[le]),_:1}),re]),ce,oe]),he]),ie,ue,de,s("div",pe,[s("div",_e,[ge,s("p",null,[fe,n(t,{to:"/docs/reference/query"},{default:a(()=>[je]),_:1}),me]),be,ye,xe,qe,ve]),we]),Te,Re,Ee,s("div",Se,[s("div",ke,[Pe,s("p",null,[Ae,n(t,{to:"/docs/reference/query"},{default:a(()=>[Ue]),_:1}),Oe]),Le,Ce,Ie,Qe,Ge]),Be]),De,Me,Fe,s("div",He,[s("div",Ne,[Ve,s("p",null,[We,n(t,{to:"/docs/reference/query"},{default:a(()=>[Ye]),_:1}),ze]),Je,Ke,Xe,Ze]),$e]),sa,ea,aa,s("div",ta,[s("div",na,[la,s("p",null,[ra,n(t,{to:"/docs/reference/query"},{default:a(()=>[ca]),_:1}),oa]),ha,ia,ua,da]),pa]),_a,ga,fa,ja,ma,ba,ya,xa,qa,va,wa,s("div",Ta,[s("div",Ra,[Ea,s("div",Sa,[ka,Pa,s("p",null,[Aa,Ua,Oa,La,Ca,Ia,n(t,{to:"/docs/self-hosted/config-options/#security"},{default:a(()=>[Qa,Ga]),_:1}),Ba])]),Da,Ma]),Fa]),Ha,Na,Va,Wa,Ya,za,Ja,Ka,Xa,Za,$a,st,et,at,tt,nt,lt])]),_:1})}}};export{pt as default,ut as modularExtension,dt as pageClass,it as title};

package/dist/assets/utilities.4a346b3b.js

@@ -0,0 +1,74 @@
+import{a as r,o as h,b as c,w as a,g as s,e as l,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const d={class:"markdown-body"},u=s("div",{class:"two-up"},[s("div",{class:"left"},[s("blockquote",null,[s("p",null,"Utilities are the various helper endpoints located within the API.")])]),s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#generate-a-hash"},"Generate a Hash ")]),s("li",null,[s("a",{href:"#verify-a-hash"},"Verify a Hash ")]),s("li",null,[s("a",{href:"#manually-sort-items-in-collection"},"Manually Sort Items in Collection ")]),s("li",null,[s("a",{href:"#import-data-from-file"},"Import Data from File ")]),s("li",null,[s("a",{href:"#export-data-to-a-file"},"Export Data to a File ")]),s("li",null,[s("a",{href:"#clear-the-internal-cache"},"Clear the Internal Cache ")])])])])])],-1),p=s("hr",null,null,-1),_=s("h2",{id:"generate-a-hash",tabindex:"-1"},[e("Generate a Hash "),s("a",{class:"header-anchor",href:"#generate-a-hash"},"#")],-1),f=s("p",null,"Generate a hash for a given string.",-1),m=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"string"),e(),s("strong",null,"Required"),s("br"),e(" String to hash.")])]),s("h3",{id:"returns",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")]),s("p",null,"Hashed string.")]),s("div",{class:"right"},[s("h3",{id:"rest-api",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")]),s("pre",null,[s("code",null,`POST /utils/hash/generate
+`)]),s("h5",{id:"example",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /utils/hash/generate"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"string"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Hello World!"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	utils_hash_generate(string:`),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," String"),e(`
+}
+`)])]),s("h5",{id:"example-1",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-1"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	utils_hash_generate(string: `),s("span",{class:"hljs-string"},'"Hello World!"'),e(`)
+}
+`)])])])],-1),g=s("hr",null,null,-1),y=s("h2",{id:"verify-a-hash",tabindex:"-1"},[e("Verify a Hash "),s("a",{class:"header-anchor",href:"#verify-a-hash"},"#")],-1),b=s("p",null,"Verify a string with a hash.",-1),j=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-1",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-1"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"string"),e(),s("strong",null,"Required"),s("br"),e(" Source string.")]),s("p",null,[s("code",null,"hash"),e(),s("strong",null,"Required"),s("br"),e(" Hash you want to verify against.")])]),s("h3",{id:"returns-1",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-1"},"#")]),s("p",null,"Boolean.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-1",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),s("pre",null,[s("code",null,`POST /utils/hash/verify
+`)]),s("h5",{id:"example-2",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /utils/hash/verify"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"string"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Hello World!"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"hash"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"$arg...fEfM"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-1",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-1"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	utils_hash_verify(hash:`),s("span",{class:"hljs-type"}," String"),e("!, string:"),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])])])],-1),x=s("hr",null,null,-1),q=s("h2",{id:"manually-sort-items-in-collection",tabindex:"-1"},[e("Manually Sort Items in Collection "),s("a",{class:"header-anchor",href:"#manually-sort-items-in-collection"},"#")],-1),v=s("p",null,"If a collection has a sort field, this util can be used to move items in that manual order.",-1),A=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-2",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"item"),e(),s("strong",null,"Required"),s("br"),e(" Primary key of the item you\u2019re moving in the collection.")]),s("p",null,[s("code",null,"to"),e(),s("strong",null,"Required"),s("br"),e(" Primary key of the item you\u2019re moving the source item too.")])]),s("h3",{id:"returns-2",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-2",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`POST /utils/sort/:collection
+`)]),s("h5",{id:"example-3",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /utils/sort/articles"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"item"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"16"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"to"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"51"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-2",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	utils_sort(collection:`),s("span",{class:"hljs-type"}," String"),e("!, item:"),s("span",{class:"hljs-literal"}," ID"),e("!, to:"),s("span",{class:"hljs-literal"}," ID"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])]),s("h5",{id:"example-4",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	utils_sort(collection: `),s("span",{class:"hljs-string"},'"articles"'),e(", item: "),s("span",{class:"hljs-number"},"16"),e(", to: "),s("span",{class:"hljs-number"},"51"),e(`)
+}
+`)])])])],-1),S=s("hr",null,null,-1),E=s("h2",{id:"import-data-from-file",tabindex:"-1"},[e("Import Data from File "),s("a",{class:"header-anchor",href:"#import-data-from-file"},"#")],-1),R=e("Import multiple records from a JSON or CSV file into a collection. Relies on a "),T=s("code",null,"multipart/form-data",-1),w=e(" encoded request, just like regular file uploads. Check "),P=e("Upload a File"),C=e(" for more information."),O=e("The import endpoint expects the file structure to match "),F=e("the export query parameter"),k=e(". For JSON, this is an array of objects, where every object is an item. For CSV, the first line has to be the columns header."),I={class:"two-up"},B={class:"left"},D=s("h3",{id:"request-body-3",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),M=e("Send the file in a "),G=s("code",null,"multipart/form-data",-1),H=e(" request. See "),L=e("Upload a File"),U=e(" for more information."),V=s("h3",{id:"returns-3",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),N=s("p",null,"Empty body.",-1),Q=s("div",{class:"right"},[s("h3",{id:"rest-api-3",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`POST /utils/import/:collection
+`)]),s("h5",{id:"example-5",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",null,`POST /utils/import/articles
+
+Content-Type: multipart/form-data; charset=utf-8; boundary=__X_BOUNDARY__
+Content-Length: 3442422
+
+--__X_BOUNDARY__
+Content-Disposition: form-data; name="file"; filename="articles.csv"
+Content-Type: text/csv
+
+"id","title","another","created_by"
+1,"My First Articled","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+2,"My Second Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+3,"My Updated Third Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+4,"My Fourth Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+5,"My Fifth Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+...
+`)]),s("h3",{id:"graphql-3",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("p",null,"n/a")],-1),W=s("hr",null,null,-1),J=s("h2",{id:"export-data-to-a-file",tabindex:"-1"},[e("Export Data to a File "),s("a",{class:"header-anchor",href:"#export-data-to-a-file"},"#")],-1),X=s("p",null,"Export a larger data set to a file in the File Library",-1),Y={class:"two-up"},$={class:"left"},z=s("h3",{id:"query-parameters",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),K=s("p",null,"Doesn\u2019t use any query parameters.",-1),Z=s("h3",{id:"request-body-4",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),ss={class:"definitions"},es=s("p",null,[s("code",null,"format"),e(),s("strong",null,"Required"),s("br"),e(" What file format to save the export to. One of "),s("code",null,"csv"),e(", "),s("code",null,"xml"),e(", "),s("code",null,"json"),e(".")],-1),as=s("code",null,"query",-1),ts=e(),ls=s("strong",null,"Required",-1),ns=s("br",null,null,-1),rs=e(" The query object to use for the export. Supports the "),os=e("global query parameters"),is=e("."),hs=s("p",null,[s("code",null,"file"),e(),s("strong",null,"File Object"),s("br"),e(" Partial file object to tweak where / how the export file is saved.")],-1),cs=s("h3",{id:"returns-4",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),ds=s("p",null,"Empty body",-1),us=s("div",{class:"right"},[s("h3",{id:"rest-api-4",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`POST /utils/export/:collection
+`)]),s("h5",{id:"example-6",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",null,`POST /utils/export/articles
+`)]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"query"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"filter"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+			`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+				`),s("span",{class:"hljs-attr"},'"_eq"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"published"'),e(`
+			`),s("span",{class:"hljs-punctuation"},"}"),e(`
+		`),s("span",{class:"hljs-punctuation"},"}"),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"file"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"folder"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"34e95c19-cc50-42f2-83c8-b97616ac2390"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])]),s("h3",{id:"graphql-4",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("p",null,"n/a")],-1),ps=s("hr",null,null,-1),_s=s("h2",{id:"clear-the-internal-cache",tabindex:"-1"},[e("Clear the Internal Cache "),s("a",{class:"header-anchor",href:"#clear-the-internal-cache"},"#")],-1),fs=s("p",null,"Resets both the data and schema cache of Directus. This endpoint is only available to admin users.",-1),ms=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"n/a"),s("h3",{id:"returns-5",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")]),s("p",null,"Empty body")]),s("div",{class:"right"},[s("h3",{id:"rest-api-5",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`POST /utils/cache/clear
+`)]),s("h3",{id:"graphql-5",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	utils_cache_clear
+}
+`)])])])],-1),xs="Utilities",qs=!1,vs="page-reference",As={name:"utilities",setup(gs,{expose:o}){const n={title:"Utilities",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:n}),(ys,bs)=>{const t=r("router-link"),i=r("docs-wrapper");return h(),c(i,{frontmatter:n},{default:a(()=>[s("div",d,[u,p,_,f,m,g,y,b,j,x,q,v,A,S,E,s("p",null,[R,T,w,l(t,{to:"/docs/reference/files/#upload-a-file"},{default:a(()=>[P]),_:1}),C]),s("p",null,[O,l(t,{to:"/docs/reference/query/#export"},{default:a(()=>[F]),_:1}),k]),s("div",I,[s("div",B,[D,s("p",null,[M,G,H,l(t,{to:"/docs/reference/files/#upload-a-file"},{default:a(()=>[L]),_:1}),U]),V,N]),Q]),W,J,X,s("div",Y,[s("div",$,[z,K,Z,s("div",ss,[es,s("p",null,[as,ts,ls,ns,rs,l(t,{to:"/docs/reference/query"},{default:a(()=>[os]),_:1}),is]),hs]),cs,ds]),us]),ps,_s,fs,ms])]),_:1})}}};export{As as default,qs as modularExtension,vs as pageClass,xs as title};

package/dist/assets/vb.82528105.js

@@ -0,0 +1 @@
+import{z as U}from"./index.e2330f33.entry.js";function $(l,v){return v.forEach(function(i){i&&typeof i!="string"&&!Array.isArray(i)&&Object.keys(i).forEach(function(c){if(c!=="default"&&!(c in l)){var d=Object.getOwnPropertyDescriptor(i,c);Object.defineProperty(l,c,d.get?d:{enumerable:!0,get:function(){return i[c]}})}})}),Object.freeze(Object.defineProperty(l,Symbol.toStringTag,{value:"Module"}))}var O={exports:{}};(function(l,v){(function(i){i(U.exports)})(function(i){i.defineMode("vb",function(c,d){var a="error";function u(e){return new RegExp("^(("+e.join(")|(")+"))\\b","i")}var E=new RegExp("^[\\+\\-\\*/%&\\\\|\\^~<>!]"),z=new RegExp("^[\\(\\)\\[\\]\\{\\}@,:`=;\\.]"),R=new RegExp("^((==)|(<>)|(<=)|(>=)|(<>)|(<<)|(>>)|(//)|(\\*\\*))"),S=new RegExp("^((\\+=)|(\\-=)|(\\*=)|(%=)|(/=)|(&=)|(\\|=)|(\\^=))"),_=new RegExp("^((//=)|(>>=)|(<<=)|(\\*\\*=))"),j=new RegExp("^[_A-Za-z][_A-Za-z0-9]*"),h=["class","module","sub","enum","select","while","if","function","get","set","property","try","structure","synclock","using","with"],g=["else","elseif","case","catch","finally"],y=["next","loop"],b=["and","andalso","or","orelse","xor","in","not","is","isnot","like"],C=u(b),w=["#const","#else","#elseif","#end","#if","#region","addhandler","addressof","alias","as","byref","byval","cbool","cbyte","cchar","cdate","cdbl","cdec","cint","clng","cobj","compare","const","continue","csbyte","cshort","csng","cstr","cuint","culng","cushort","declare","default","delegate","dim","directcast","each","erase","error","event","exit","explicit","false","for","friend","gettype","goto","handles","implements","imports","infer","inherits","interface","isfalse","istrue","lib","me","mod","mustinherit","mustoverride","my","mybase","myclass","namespace","narrowing","new","nothing","notinheritable","notoverridable","of","off","on","operator","option","optional","out","overloads","overridable","overrides","paramarray","partial","private","protected","public","raiseevent","readonly","redim","removehandler","resume","return","shadows","shared","static","step","stop","strict","then","throw","to","true","trycast","typeof","until","until","when","widening","withevents","writeonly"],x=["object","boolean","char","string","byte","sbyte","short","ushort","int16","uint16","integer","uinteger","int32","uint32","long","ulong","int64","uint64","decimal","single","double","float","date","datetime","intptr","uintptr"],T=u(w),A=u(x),F='"',L=u(h),m=u(g),k=u(y),I=u(["end"]),D=u(["do"]);i.registerHelper("hintWords","vb",h.concat(g).concat(y).concat(b).concat(w).concat(x));function s(e,n){n.currentIndent++}function f(e,n){n.currentIndent--}function p(e,n){if(e.eatSpace())return null;var r=e.peek();if(r==="'")return e.skipToEnd(),"comment";if(e.match(/^((&H)|(&O))?[0-9\.a-f]/i,!1)){var t=!1;if((e.match(/^\d*\.\d+F?/i)||e.match(/^\d+\.\d*F?/)||e.match(/^\.\d+F?/))&&(t=!0),t)return e.eat(/J/i),"number";var o=!1;if(e.match(/^&H[0-9a-f]+/i)||e.match(/^&O[0-7]+/i)?o=!0:e.match(/^[1-9]\d*F?/)?(e.eat(/J/i),o=!0):e.match(/^0(?![\dx])/i)&&(o=!0),o)return e.eat(/L/i),"number"}return e.match(F)?(n.tokenize=K(e.current()),n.tokenize(e,n)):e.match(_)||e.match(S)?null:e.match(R)||e.match(E)||e.match(C)?"operator":e.match(z)?null:e.match(D)?(s(e,n),n.doInCurrentLine=!0,"keyword"):e.match(L)?(n.doInCurrentLine?n.doInCurrentLine=!1:s(e,n),"keyword"):e.match(m)?"keyword":e.match(I)?(f(e,n),f(e,n),"keyword"):e.match(k)?(f(e,n),"keyword"):e.match(A)||e.match(T)?"keyword":e.match(j)?"variable":(e.next(),a)}function K(e){var n=e.length==1,r="string";return function(t,o){for(;!t.eol();){if(t.eatWhile(/[^'"]/),t.match(e))return o.tokenize=p,r;t.eat(/['"]/)}if(n){if(d.singleLineStringErrors)return a;o.tokenize=p}return r}}function P(e,n){var r=n.tokenize(e,n),t=e.current();if(t===".")return r=n.tokenize(e,n),r==="variable"?"variable":a;var o="[({".indexOf(t);return o!==-1&&s(e,n),o="])}".indexOf(t),o!==-1&&f(e,n)?a:r}var H={electricChars:"dDpPtTfFeE ",startState:function(){return{tokenize:p,lastToken:null,currentIndent:0,nextLineIndent:0,doInCurrentLine:!1}},token:function(e,n){e.sol()&&(n.currentIndent+=n.nextLineIndent,n.nextLineIndent=0,n.doInCurrentLine=0);var r=P(e,n);return n.lastToken={style:r,content:e.current()},r},indent:function(e,n){var r=n.replace(/^\s+|\s+$/g,"");return r.match(k)||r.match(I)||r.match(m)?c.indentUnit*(e.currentIndent-1):e.currentIndent<0?0:e.currentIndent*c.indentUnit},lineComment:"'"};return H}),i.defineMIME("text/x-vb","vb")})})();var J=O.exports,W=$({__proto__:null,default:J},[O.exports]);export{W as v};

package/dist/assets/vbscript.f3012ea2.js

@@ -0,0 +1 @@
+import{z as Q}from"./index.e2330f33.entry.js";function X(l,p){return p.forEach(function(o){o&&typeof o!="string"&&!Array.isArray(o)&&Object.keys(o).forEach(function(a){if(a!=="default"&&!(a in l)){var v=Object.getOwnPropertyDescriptor(o,a);Object.defineProperty(l,a,v.get?v:{enumerable:!0,get:function(){return o[a]}})}})}),Object.freeze(Object.defineProperty(l,Symbol.toStringTag,{value:"Module"}))}var x={exports:{}};(function(l,p){(function(o){o(Q.exports)})(function(o){o.defineMode("vbscript",function(a,v){var d="error";function t(e){return new RegExp("^(("+e.join(")|(")+"))\\b","i")}var w=new RegExp("^[\\+\\-\\*/&\\\\\\^<>=]"),k=new RegExp("^((<>)|(<=)|(>=))"),O=new RegExp("^[\\.,]"),C=new RegExp("^[\\(\\)]"),I=new RegExp("^[A-Za-z][_A-Za-z0-9]*"),S=["class","sub","select","while","if","function","property","with","for"],E=["else","elseif","case"],j=["next","loop","wend"],D=t(["and","or","not","xor","is","mod","eqv","imp"]),T=["dim","redim","then","until","randomize","byval","byref","new","property","exit","in","const","private","public","get","set","let","stop","on error resume next","on error goto 0","option explicit","call","me"],L=["true","false","nothing","empty","null"],R=["abs","array","asc","atn","cbool","cbyte","ccur","cdate","cdbl","chr","cint","clng","cos","csng","cstr","date","dateadd","datediff","datepart","dateserial","datevalue","day","escape","eval","execute","exp","filter","formatcurrency","formatdatetime","formatnumber","formatpercent","getlocale","getobject","getref","hex","hour","inputbox","instr","instrrev","int","fix","isarray","isdate","isempty","isnull","isnumeric","isobject","join","lbound","lcase","left","len","loadpicture","log","ltrim","rtrim","trim","maths","mid","minute","month","monthname","msgbox","now","oct","replace","rgb","right","rnd","round","scriptengine","scriptenginebuildversion","scriptenginemajorversion","scriptengineminorversion","second","setlocale","sgn","sin","space","split","sqr","strcomp","string","strreverse","tan","time","timer","timeserial","timevalue","typename","ubound","ucase","unescape","vartype","weekday","weekdayname","year"],F=["vbBlack","vbRed","vbGreen","vbYellow","vbBlue","vbMagenta","vbCyan","vbWhite","vbBinaryCompare","vbTextCompare","vbSunday","vbMonday","vbTuesday","vbWednesday","vbThursday","vbFriday","vbSaturday","vbUseSystemDayOfWeek","vbFirstJan1","vbFirstFourDays","vbFirstFullWeek","vbGeneralDate","vbLongDate","vbShortDate","vbLongTime","vbShortTime","vbObjectError","vbOKOnly","vbOKCancel","vbAbortRetryIgnore","vbYesNoCancel","vbYesNo","vbRetryCancel","vbCritical","vbQuestion","vbExclamation","vbInformation","vbDefaultButton1","vbDefaultButton2","vbDefaultButton3","vbDefaultButton4","vbApplicationModal","vbSystemModal","vbOK","vbCancel","vbAbort","vbRetry","vbIgnore","vbYes","vbNo","vbCr","VbCrLf","vbFormFeed","vbLf","vbNewLine","vbNullChar","vbNullString","vbTab","vbVerticalTab","vbUseDefault","vbTrue","vbFalse","vbEmpty","vbNull","vbInteger","vbLong","vbSingle","vbDouble","vbCurrency","vbDate","vbString","vbObject","vbError","vbBoolean","vbVariant","vbDataObject","vbDecimal","vbByte","vbArray"],u=["WScript","err","debug","RegExp"],z=["description","firstindex","global","helpcontext","helpfile","ignorecase","length","number","pattern","source","value","count"],W=["clear","execute","raise","replace","test","write","writeline","close","open","state","eof","update","addnew","end","createobject","quit"],A=["server","response","request","session","application"],B=["buffer","cachecontrol","charset","contenttype","expires","expiresabsolute","isclientconnected","pics","status","clientcertificate","cookies","form","querystring","servervariables","totalbytes","contents","staticobjects","codepage","lcid","sessionid","timeout","scripttimeout"],K=["addheader","appendtolog","binarywrite","end","flush","redirect","binaryread","remove","removeall","lock","unlock","abandon","getlasterror","htmlencode","mappath","transfer","urlencode"],b=W.concat(z);u=u.concat(F),a.isASP&&(u=u.concat(A),b=b.concat(K,B));var M=t(T),_=t(L),N=t(R),P=t(u),q=t(b),U='"',Y=t(S),y=t(E),g=t(j),h=t(["end"]),H=t(["do"]),J=t(["on error resume next","exit"]),V=t(["rem"]);function m(e,r){r.currentIndent++}function s(e,r){r.currentIndent--}function f(e,r){if(e.eatSpace())return"space";var n=e.peek();if(n==="'"||e.match(V))return e.skipToEnd(),"comment";if(e.match(/^((&H)|(&O))?[0-9\.]/i,!1)&&!e.match(/^((&H)|(&O))?[0-9\.]+[a-z_]/i,!1)){var i=!1;if((e.match(/^\d*\.\d+/i)||e.match(/^\d+\.\d*/)||e.match(/^\.\d+/))&&(i=!0),i)return e.eat(/J/i),"number";var c=!1;if(e.match(/^&H[0-9a-f]+/i)||e.match(/^&O[0-7]+/i)?c=!0:e.match(/^[1-9]\d*F?/)?(e.eat(/J/i),c=!0):e.match(/^0(?![\dx])/i)&&(c=!0),c)return e.eat(/L/i),"number"}return e.match(U)?(r.tokenize=$(e.current()),r.tokenize(e,r)):e.match(k)||e.match(w)||e.match(D)?"operator":e.match(O)?null:e.match(C)?"bracket":e.match(J)?(r.doInCurrentLine=!0,"keyword"):e.match(H)?(m(e,r),r.doInCurrentLine=!0,"keyword"):e.match(Y)?(r.doInCurrentLine?r.doInCurrentLine=!1:m(e,r),"keyword"):e.match(y)?"keyword":e.match(h)?(s(e,r),s(e,r),"keyword"):e.match(g)?(r.doInCurrentLine?r.doInCurrentLine=!1:s(e,r),"keyword"):e.match(M)?"keyword":e.match(_)?"atom":e.match(q)?"variable-2":e.match(N)?"builtin":e.match(P)?"variable-2":e.match(I)?"variable":(e.next(),d)}function $(e){var r=e.length==1,n="string";return function(i,c){for(;!i.eol();){if(i.eatWhile(/[^'"]/),i.match(e))return c.tokenize=f,n;i.eat(/['"]/)}if(r){if(v.singleLineStringErrors)return d;c.tokenize=f}return n}}function G(e,r){var n=r.tokenize(e,r),i=e.current();return i==="."?(n=r.tokenize(e,r),i=e.current(),n&&(n.substr(0,8)==="variable"||n==="builtin"||n==="keyword")?((n==="builtin"||n==="keyword")&&(n="variable"),b.indexOf(i.substr(1))>-1&&(n="variable-2"),n):d):n}var Z={electricChars:"dDpPtTfFeE ",startState:function(){return{tokenize:f,lastToken:null,currentIndent:0,nextLineIndent:0,doInCurrentLine:!1,ignoreKeyword:!1}},token:function(e,r){e.sol()&&(r.currentIndent+=r.nextLineIndent,r.nextLineIndent=0,r.doInCurrentLine=0);var n=G(e,r);return r.lastToken={style:n,content:e.current()},n==="space"&&(n=null),n},indent:function(e,r){var n=r.replace(/^\s+|\s+$/g,"");return n.match(g)||n.match(h)||n.match(y)?a.indentUnit*(e.currentIndent-1):e.currentIndent<0?0:e.currentIndent*a.indentUnit}};return Z}),o.defineMIME("text/vbscript","vbscript")})})();var ee=x.exports,ne=X({__proto__:null,default:ee},[x.exports]);export{ne as v};

package/dist/assets/velocity.87d27c70.js

@@ -0,0 +1 @@
+import{z as g}from"./index.e2330f33.entry.js";function $(f,k){return k.forEach(function(t){t&&typeof t!="string"&&!Array.isArray(t)&&Object.keys(t).forEach(function(o){if(o!=="default"&&!(o in f)){var a=Object.getOwnPropertyDescriptor(t,o);Object.defineProperty(f,o,a.get?a:{enumerable:!0,get:function(){return t[o]}})}})}),Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var v={exports:{}};(function(f,k){(function(t){t(g.exports)})(function(t){t.defineMode("velocity",function(){function o(n){for(var e={},i=n.split(" "),r=0;r<i.length;++r)e[i[r]]=!0;return e}var a=o("#end #else #break #stop #[[ #]] #{end} #{else} #{break} #{stop}"),u=o("#if #elseif #foreach #set #include #parse #macro #define #evaluate #{if} #{elseif} #{foreach} #{set} #{include} #{parse} #{macro} #{define} #{evaluate}"),h=o("$foreach.count $foreach.hasNext $foreach.first $foreach.last $foreach.topmost $foreach.parent.count $foreach.parent.hasNext $foreach.parent.first $foreach.parent.last $foreach.parent $velocityCount $!bodyContent $bodyContent"),b=/[+\-*&%=<>!?:\/|]/;function s(n,e,i){return e.tokenize=i,i(n,e)}function c(n,e){var i=e.beforeParams;e.beforeParams=!1;var r=n.next();if(r=="'"&&!e.inString&&e.inParams)return e.lastTokenWasBuiltin=!1,s(n,e,d(r));if(r=='"'){if(e.lastTokenWasBuiltin=!1,e.inString)return e.inString=!1,"string";if(e.inParams)return s(n,e,d(r))}else{if(/[\[\]{}\(\),;\.]/.test(r))return r=="("&&i?e.inParams=!0:r==")"&&(e.inParams=!1,e.lastTokenWasBuiltin=!0),null;if(/\d/.test(r))return e.lastTokenWasBuiltin=!1,n.eatWhile(/[\w\.]/),"number";if(r=="#"&&n.eat("*"))return e.lastTokenWasBuiltin=!1,s(n,e,y);if(r=="#"&&n.match(/ *\[ *\[/))return e.lastTokenWasBuiltin=!1,s(n,e,m);if(r=="#"&&n.eat("#"))return e.lastTokenWasBuiltin=!1,n.skipToEnd(),"comment";if(r=="$")return n.eat("!"),n.eatWhile(/[\w\d\$_\.{}-]/),h&&h.propertyIsEnumerable(n.current())?"keyword":(e.lastTokenWasBuiltin=!0,e.beforeParams=!0,"builtin");if(b.test(r))return e.lastTokenWasBuiltin=!1,n.eatWhile(b),"operator";n.eatWhile(/[\w\$_{}@]/);var l=n.current();return a&&a.propertyIsEnumerable(l)?"keyword":u&&u.propertyIsEnumerable(l)||n.current().match(/^#@?[a-z0-9_]+ *$/i)&&n.peek()=="("&&!(u&&u.propertyIsEnumerable(l.toLowerCase()))?(e.beforeParams=!0,e.lastTokenWasBuiltin=!1,"keyword"):e.inString?(e.lastTokenWasBuiltin=!1,"string"):n.pos>l.length&&n.string.charAt(n.pos-l.length-1)=="."&&e.lastTokenWasBuiltin?"builtin":(e.lastTokenWasBuiltin=!1,null)}}function d(n){return function(e,i){for(var r=!1,l,p=!1;(l=e.next())!=null;){if(l==n&&!r){p=!0;break}if(n=='"'&&e.peek()=="$"&&!r){i.inString=!0,p=!0;break}r=!r&&l=="\\"}return p&&(i.tokenize=c),"string"}}function y(n,e){for(var i=!1,r;r=n.next();){if(r=="#"&&i){e.tokenize=c;break}i=r=="*"}return"comment"}function m(n,e){for(var i=0,r;r=n.next();){if(r=="#"&&i==2){e.tokenize=c;break}r=="]"?i++:r!=" "&&(i=0)}return"meta"}return{startState:function(){return{tokenize:c,beforeParams:!1,inParams:!1,inString:!1,lastTokenWasBuiltin:!1}},token:function(n,e){return n.eatSpace()?null:e.tokenize(n,e)},blockCommentStart:"#*",blockCommentEnd:"*#",lineComment:"##",fold:"velocity"}}),t.defineMIME("text/velocity","velocity")})})();var W=v.exports,B=$({__proto__:null,default:W},[v.exports]);export{B as v};

package/dist/assets/verilog.b421b7be.js

@@ -0,0 +1 @@
+import{z as oe}from"./index.e2330f33.entry.js";function ae(S,D){return D.forEach(function(s){s&&typeof s!="string"&&!Array.isArray(s)&&Object.keys(s).forEach(function(g){if(g!=="default"&&!(g in S)){var x=Object.getOwnPropertyDescriptor(s,g);Object.defineProperty(S,g,x.get?x:{enumerable:!0,get:function(){return s[g]}})}})}),Object.freeze(Object.defineProperty(S,Symbol.toStringTag,{value:"Module"}))}var K={exports:{}};(function(S,D){(function(s){s(oe.exports)})(function(s){s.defineMode("verilog",function(i,l){var a=i.indentUnit,f=l.statementIndentUnit||a,w=l.dontAlignCalls,m=l.compilerDirectivesUseRegularIndentation,C=l.noIndentKeywords||[],_=l.multiLineStrings,p=l.hooks||{};function y(e){for(var t={},n=e.split(" "),r=0;r<n.length;++r)t[n[r]]=!0;return t}var O=y("accept_on alias always always_comb always_ff always_latch and assert assign assume automatic before begin bind bins binsof bit break buf bufif0 bufif1 byte case casex casez cell chandle checker class clocking cmos config const constraint context continue cover covergroup coverpoint cross deassign default defparam design disable dist do edge else end endcase endchecker endclass endclocking endconfig endfunction endgenerate endgroup endinterface endmodule endpackage endprimitive endprogram endproperty endspecify endsequence endtable endtask enum event eventually expect export extends extern final first_match for force foreach forever fork forkjoin function generate genvar global highz0 highz1 if iff ifnone ignore_bins illegal_bins implements implies import incdir include initial inout input inside instance int integer interconnect interface intersect join join_any join_none large let liblist library local localparam logic longint macromodule matches medium modport module nand negedge nettype new nexttime nmos nor noshowcancelled not notif0 notif1 null or output package packed parameter pmos posedge primitive priority program property protected pull0 pull1 pulldown pullup pulsestyle_ondetect pulsestyle_onevent pure rand randc randcase randsequence rcmos real realtime ref reg reject_on release repeat restrict return rnmos rpmos rtran rtranif0 rtranif1 s_always s_eventually s_nexttime s_until s_until_with scalared sequence shortint shortreal showcancelled signed small soft solve specify specparam static string strong strong0 strong1 struct super supply0 supply1 sync_accept_on sync_reject_on table tagged task this throughout time timeprecision timeunit tran tranif0 tranif1 tri tri0 tri1 triand trior trireg type typedef union unique unique0 unsigned until until_with untyped use uwire var vectored virtual void wait wait_order wand weak weak0 weak1 while wildcard wire with within wor xnor xor"),E=/[\+\-\*\/!~&|^%=?:<>]/,$=/[\[\]{}()]/,J=/\d[0-9_]*/,Q=/\d*\s*'s?d\s*\d[0-9_]*/i,X=/\d*\s*'s?b\s*[xz01][xz01_]*/i,Y=/\d*\s*'s?o\s*[xz0-7][xz0-7_]*/i,Z=/\d*\s*'s?h\s*[0-9a-fxz?][0-9a-fxz?_]*/i,U=/(\d[\d_]*(\.\d[\d_]*)?E-?[\d_]+)|(\d[\d_]*\.\d[\d_]*)/i,H=/^((`?\w+)|[)}\]])/,M=/[)}\]]/,A=new RegExp("^(`(?:ifdef|ifndef|elsif|else|endif|undef|undefineall|define|include|begin_keywords|celldefine|default|nettype|end_keywords|endcelldefine|line|nounconnected_drive|pragma|resetall|timescale|unconnected_drive))\\b"),ee=/^(`(?:ifdef|ifndef|elsif|else))\b/,W=/^(`(?:elsif|else|endif))\b/,c,d,ne=y("case checker class clocking config function generate interface module package primitive program property specify sequence table task"),u={};for(var I in ne)u[I]="end"+I;u.begin="end",u.casex="endcase",u.casez="endcase",u.do="while",u.fork="join;join_any;join_none",u.covergroup="endgroup",u.macro_begin="macro_end";for(var te in C){var I=C[te];u[I]&&(u[I]=void 0)}var ie=y("always always_comb always_ff always_latch assert assign assume else export for foreach forever if import initial repeat while extern typedef");function j(e,t){var n=e.peek(),r;if(p[n]&&(r=p[n](e,t))!=!1||p.tokenBase&&(r=p.tokenBase(e,t))!=!1)return r;if(/[,;:\.]/.test(n))return c=e.next(),null;if($.test(n))return c=e.next(),"bracket";if(n=="`")if(e.next(),e.eatWhile(/[\w\$_]/)){var o=e.current();if(d=o,o.startsWith("`uvm_")&&o.endsWith("_begin")){var v=d.substr(0,d.length-5)+"end";u[o]=v,c="newblock"}else{e.eatSpace(),e.peek()=="("&&(c="newmacro");var B=e.current();e.backUp(B.length-o.length)}return"def"}else return null;if(n=="$")return e.next(),e.eatWhile(/[\w\$_]/)?"meta":null;if(n=="#")return e.next(),e.eatWhile(/[\d_.]/),"def";if(n=="@")return e.next(),e.eatWhile(/[@]/),"def";if(n=='"')return e.next(),t.tokenize=re(n),t.tokenize(e,t);if(n=="/"){if(e.next(),e.eat("*"))return t.tokenize=q,q(e,t);if(e.eat("/"))return e.skipToEnd(),"comment";e.backUp(1)}if(e.match(U)||e.match(Q)||e.match(X)||e.match(Y)||e.match(Z)||e.match(J)||e.match(U))return"number";if(e.eatWhile(E))return c=e.current(),"meta";if(e.eatWhile(/[\w\$_]/)){var o=e.current();return O[o]?(u[o]&&(c="newblock",o==="fork"&&(e.eatSpace(),e.peek()==";"&&(c="newstatement"),e.backUp(e.current().length-o.length))),ie[o]&&(c="newstatement"),d=o,"keyword"):"variable"}return e.next(),null}function re(e){return function(t,n){for(var r=!1,o,v=!1;(o=t.next())!=null;){if(o==e&&!r){v=!0;break}r=!r&&o=="\\"}return(v||!(r||_))&&(n.tokenize=j),"string"}}function q(e,t){for(var n=!1,r;r=e.next();){if(r=="/"&&n){t.tokenize=j;break}n=r=="*"}return"comment"}function R(e,t,n,r,o,v){this.indented=e,this.column=t,this.type=n,this.scopekind=r,this.align=o,this.prev=v}function h(e,t,n,r){var o=e.indented,v=new R(o,t,n,r||"",null,e.context);return e.context=v}function b(e){var t=e.context.type;return(t==")"||t=="]"||t=="}")&&(e.indented=e.context.indented),e.context=e.context.prev}function N(e,t){if(e==t)return!0;var n=t.split(";");for(var r in n)if(e==n[r])return!0;return!1}function T(e,t){return e==null?!1:e.scopekind===t?!0:T(e.prev,t)}function le(){var e=[];for(var t in u)if(u[t]){var n=u[t].split(";");for(var r in n)e.push(n[r])}var o=new RegExp("[{}()\\[\\]]|("+e.join("|")+")$");return o}return{electricInput:le(),startState:function(e){var t={tokenize:null,context:new R((e||0)-a,0,"top","top",!1),indented:0,compilerDirectiveIndented:0,startOfLine:!0};return p.startState&&p.startState(t),t},token:function(e,t){var n=t.context;if(e.sol()&&(n.align==null&&(n.align=!1),t.indented=e.indentation(),t.startOfLine=!0),p.token){var r=p.token(e,t);if(r!==void 0)return r}if(e.eatSpace())return null;c=null,d=null;var r=(t.tokenize||j)(e,t);if(r=="comment"||r=="meta"||r=="variable")return(c==="="||c==="<=")&&!T(n,"assignment")&&(h(t,e.column()+c.length,"assignment","assignment"),n.align==null&&(n.align=!0)),r;n.align==null&&(n.align=!0);var o=n.type=="assignment"&&M.test(c)&&n.prev&&n.prev.type===c;if(c==n.type||o){if(o&&(n=b(t)),n=b(t),c==")"){if(n&&n.type==="macro")for(n=b(t);n&&(n.type=="statement"||n.type=="assignment");)n=b(t)}else if(c=="}"&&n&&n.type==="statement")for(;n&&n.type=="statement";)n=b(t)}else if((c==";"||c==",")&&(n.type=="statement"||n.type=="assignment")||n.type&&N(d,n.type))for(n=b(t);n&&(n.type=="statement"||n.type=="assignment");)n=b(t);else if(c=="{")h(t,e.column(),"}");else if(c=="[")h(t,e.column(),"]");else if(c=="(")h(t,e.column(),")");else if(n&&n.type=="endcase"&&c==":")h(t,e.column(),"statement","case");else if(c=="newstatement")h(t,e.column(),"statement",d);else if(c=="newblock"){if(!(d=="function"&&n&&(n.type=="statement"||n.type=="endgroup"))){if(!(d=="task"&&n&&n.type=="statement")){if(!(d=="class"&&n&&n.type=="statement")){var v=u[d];h(t,e.column(),v,d)}}}}else(c=="newmacro"||d&&d.match(A))&&(c=="newmacro"&&h(t,e.column(),"macro","macro"),d.match(W)&&(t.compilerDirectiveIndented-=f),d.match(ee)&&(t.compilerDirectiveIndented+=f));return t.startOfLine=!1,r},indent:function(e,t){if(e.tokenize!=j&&e.tokenize!=null)return s.Pass;if(p.indent){var n=p.indent(e);if(n>=0)return n}var r=e.context,o=t&&t.charAt(0);r.type=="statement"&&o=="}"&&(r=r.prev);var v=!1,B=t.match(H);return B&&(v=N(B[0],r.type)),!m&&t.match(A)?t.match(W)?e.compilerDirectiveIndented-f:e.compilerDirectiveIndented:r.type=="statement"?r.indented+(o=="{"?0:f):(M.test(r.type)||r.type=="assignment")&&r.align&&!w?r.column+(v?0:1):r.type==")"&&!v?r.indented+f:r.indented+(v?0:a)},blockCommentStart:"/*",blockCommentEnd:"*/",lineComment:"//",fold:"indent"}}),s.defineMIME("text/x-verilog",{name:"verilog"}),s.defineMIME("text/x-systemverilog",{name:"verilog"});var g={"|":"link",">":"property",$:"variable",$$:"variable","?$":"qualifier","?*":"qualifier","-":"hr","/":"property","/-":"property","@":"variable-3","@-":"variable-3","@++":"variable-3","@+=":"variable-3","@+=-":"variable-3","@--":"variable-3","@-=":"variable-3","%+":"tag","%-":"tag","%":"tag",">>":"tag","<<":"tag","<>":"tag","#":"tag","^":"attribute","^^":"attribute","^!":"attribute","*":"variable-2","**":"variable-2","\\":"keyword",'"':"comment"},x={"/":"beh-hier",">":"beh-hier","-":"phys-hier","|":"pipe","?":"when","@":"stage","\\":"keyword"},k=3,L=/^([~!@#\$%\^&\*-\+=\?\/\\\|'"<>]+)([\d\w_]*)/,P=/^[! ]  /,V=/^[! ] */,F=/^\/[\/\*]/;function z(i,l,a){var f=l/k;return"tlv-"+i.tlvIndentationStyle[f]+"-"+a}function G(i){var l;return(l=i.match(L,!1))&&l[2].length>0}s.defineMIME("text/x-tlv",{name:"verilog",hooks:{electricInput:!1,token:function(i,l){var a=void 0,f;if(i.sol()&&!l.tlvInBlockComment){i.peek()=="\\"&&(a="def",i.skipToEnd(),i.string.match(/\\SV/)?l.tlvCodeActive=!1:i.string.match(/\\TLV/)&&(l.tlvCodeActive=!0)),l.tlvCodeActive&&i.pos==0&&l.indented==0&&(f=i.match(V,!1))&&(l.indented=f[0].length);var w=l.indented,m=w/k;if(m<=l.tlvIndentationStyle.length){var C=i.string.length==w,_=m*k;if(_<i.string.length){var p=i.string.slice(_),y=p[0];x[y]&&(f=p.match(L))&&g[f[1]]&&(w+=k,y=="\\"&&_>0||(l.tlvIndentationStyle[m]=x[y],m++))}if(!C)for(;l.tlvIndentationStyle.length>m;)l.tlvIndentationStyle.pop()}l.tlvNextIndent=w}if(l.tlvCodeActive){var O=!1,f;if(a!==void 0)a+=" "+z(l,0,"scope-ident");else if(i.pos/k<l.tlvIndentationStyle.length&&(f=i.match(i.sol()?P:/^   /)))a="tlv-indent-"+(i.pos%2==0?"even":"odd")+" "+z(l,i.pos-k,"indent"),f[0].charAt(0)=="!"&&(a+=" tlv-alert-line-prefix"),G(i)&&(a+=" "+z(l,i.pos,"before-scope-ident"));else if(l.tlvInBlockComment)i.match(/^.*?\*\//)?l.tlvInBlockComment=!1:i.skipToEnd(),a="comment";else if((f=i.match(F))&&!l.tlvInBlockComment)f[0]=="//"?i.skipToEnd():l.tlvInBlockComment=!0,a="comment";else if(f=i.match(L)){var E=f[1],$=f[2];g.hasOwnProperty(E)&&($.length>0||i.eol())?(a=g[E],i.column()==l.indented&&(a+=" "+z(l,i.column(),"scope-ident"))):(i.backUp(i.current().length-1),a="tlv-default")}else i.match(/^\t+/)?a="tlv-tab":i.match(/^[\[\]{}\(\);\:]+/)?a="meta":(f=i.match(/^[mM]4([\+_])?[\w\d_]*/))?a=f[1]=="+"?"tlv-m4-plus":"tlv-m4":i.match(/^ +/)?i.eol()?a="error":a="tlv-default":i.match(/^[\w\d_]+/)?a="number":(i.next(),a="tlv-default");O&&(a+=" tlv-statement")}else i.match(/^[mM]4([\w\d_]*)/)&&(a="tlv-m4");return a},indent:function(i){return i.tlvCodeActive==!0?i.tlvNextIndent:-1},startState:function(i){i.tlvIndentationStyle=[],i.tlvCodeActive=!0,i.tlvNextIndent=-1,i.tlvInBlockComment=!1}}})})})();var ce=K.exports,de=ae({__proto__:null,default:ce},[K.exports]);export{de as v};

package/dist/assets/vhdl.8a45e1a3.js

@@ -0,0 +1 @@
+import{z as _}from"./index.e2330f33.entry.js";function C(y,x){return x.forEach(function(o){o&&typeof o!="string"&&!Array.isArray(o)&&Object.keys(o).forEach(function(u){if(u!=="default"&&!(u in y)){var p=Object.getOwnPropertyDescriptor(o,u);Object.defineProperty(y,u,p.get?p:{enumerable:!0,get:function(){return o[u]}})}})}),Object.freeze(Object.defineProperty(y,Symbol.toStringTag,{value:"Module"}))}var z={exports:{}};(function(y,x){(function(o){o(_.exports)})(function(o){function u(d){for(var f={},c=d.split(","),a=0;a<c.length;++a){var v=c[a].toUpperCase(),g=c[a].charAt(0).toUpperCase()+c[a].slice(1);f[c[a]]=!0,f[v]=!0,f[g]=!0}return f}function p(d){return d.eatWhile(/[\w\$_]/),"meta"}o.defineMode("vhdl",function(d,f){var c=d.indentUnit,a=f.atoms||u("null"),v=f.hooks||{"`":p,$:p},g=f.multiLineStrings,O=u("abs,access,after,alias,all,and,architecture,array,assert,attribute,begin,block,body,buffer,bus,case,component,configuration,constant,disconnect,downto,else,elsif,end,end block,end case,end component,end for,end generate,end if,end loop,end process,end record,end units,entity,exit,file,for,function,generate,generic,generic map,group,guarded,if,impure,in,inertial,inout,is,label,library,linkage,literal,loop,map,mod,nand,new,next,nor,null,of,on,open,or,others,out,package,package body,port,port map,postponed,procedure,process,pure,range,record,register,reject,rem,report,return,rol,ror,select,severity,signal,sla,sll,sra,srl,subtype,then,to,transport,type,unaffected,units,until,use,variable,wait,when,while,with,xnor,xor"),S=u("architecture,entity,begin,case,port,else,elsif,end,for,function,if"),k=/[&|~><!\)\(*#%@+\/=?\:;}{,\.\^\-\[\]]/,l;function b(e,n){var t=e.next();if(v[t]){var r=v[t](e,n);if(r!==!1)return r}if(t=='"')return n.tokenize=E(t),n.tokenize(e,n);if(t=="'")return n.tokenize=j(t),n.tokenize(e,n);if(/[\[\]{}\(\),;\:\.]/.test(t))return l=t,null;if(/[\d']/.test(t))return e.eatWhile(/[\w\.']/),"number";if(t=="-"&&e.eat("-"))return e.skipToEnd(),"comment";if(k.test(t))return e.eatWhile(k),"operator";e.eatWhile(/[\w\$_]/);var i=e.current();return O.propertyIsEnumerable(i.toLowerCase())?(S.propertyIsEnumerable(i)&&(l="newstatement"),"keyword"):a.propertyIsEnumerable(i)?"atom":"variable"}function j(e){return function(n,t){for(var r=!1,i,h=!1;(i=n.next())!=null;){if(i==e&&!r){h=!0;break}r=!r&&i=="--"}return(h||!(r||g))&&(t.tokenize=b),"string"}}function E(e){return function(n,t){for(var r=!1,i,h=!1;(i=n.next())!=null;){if(i==e&&!r){h=!0;break}r=!r&&i=="--"}return(h||!(r||g))&&(t.tokenize=b),"string-2"}}function w(e,n,t,r,i){this.indented=e,this.column=n,this.type=t,this.align=r,this.prev=i}function m(e,n,t){return e.context=new w(e.indented,n,t,null,e.context)}function s(e){var n=e.context.type;return(n==")"||n=="]"||n=="}")&&(e.indented=e.context.indented),e.context=e.context.prev}return{startState:function(e){return{tokenize:null,context:new w((e||0)-c,0,"top",!1),indented:0,startOfLine:!0}},token:function(e,n){var t=n.context;if(e.sol()&&(t.align==null&&(t.align=!1),n.indented=e.indentation(),n.startOfLine=!0),e.eatSpace())return null;l=null;var r=(n.tokenize||b)(e,n);if(r=="comment"||r=="meta")return r;if(t.align==null&&(t.align=!0),(l==";"||l==":")&&t.type=="statement")s(n);else if(l=="{")m(n,e.column(),"}");else if(l=="[")m(n,e.column(),"]");else if(l=="(")m(n,e.column(),")");else if(l=="}"){for(;t.type=="statement";)t=s(n);for(t.type=="}"&&(t=s(n));t.type=="statement";)t=s(n)}else l==t.type?s(n):(t.type=="}"||t.type=="top"||t.type=="statement"&&l=="newstatement")&&m(n,e.column(),"statement");return n.startOfLine=!1,r},indent:function(e,n){if(e.tokenize!=b&&e.tokenize!=null)return 0;var t=n&&n.charAt(0),r=e.context,i=t==r.type;return r.type=="statement"?r.indented+(t=="{"?0:c):r.align?r.column+(i?0:1):r.indented+(i?0:c)},electricChars:"{}"}}),o.defineMIME("text/x-vhdl","vhdl")})})();var L=z.exports,I=C({__proto__:null,default:L},[z.exports]);export{I as v};