@directus/app 9.22.2 → 9.23.1

package/dist/assets/security-a3433441.js

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

package/dist/assets/server-38a89f65.js

@@ -1,114 +0,0 @@
-import{a as e,o as p,e as i,y as a,u as s,q as n,z as o}from"./runtime-core.esm-bundler-753bcc58.js";const h={class:"markdown-body"},u=s("hr",null,null,-1),d=s("h2",{id:"get-openapi-specification",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#get-openapi-specification"},"#"),n(" Get OpenAPI Specification")],-1),j=s("p",null,"Retrieve the OpenAPI spec for the current project.",-1),_=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"This OAS spec is based on the read permissions of the currently authenticated user.")],-1),g=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),n(" Returns")],-1),m=s("p",null,[n("Object conforming to "),s("a",{href:"https://swagger.io/specification",target:"_blank",rel:"noopener noreferrer"},"the OpenAPI Specification")],-1),b=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),n(" REST API")],-1),f=s("pre",null,[s("code",null,`GET /server/specs/oas
-`)],-1),y=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),n(" GraphQL")],-1),v=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),x=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	`),s("span",{class:"hljs-symbol"},"server_specs_oas"),s("span",{class:"hljs-punctuation"},":"),n(` String
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),k=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),n(" Example")],-1),q=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	server_specs_oas
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),S=s("hr",null,null,-1),T=s("h2",{id:"get-graphql-sdl",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#get-graphql-sdl"},"#"),n(" Get GraphQL SDL")],-1),w=s("p",null,"Retrieve the GraphQL SDL for the current project.",-1),P=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The SDL is based on the permissions of the currently authenticated user.")],-1),I=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),n(" Returns")],-1),A=s("p",null,"GraphQL SDL file.",-1),E=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(" about_us "),s("span",{class:"hljs-punctuation"},"{"),n(`
-  `),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),n(` Int
-  `),s("span",{class:"hljs-symbol"},"introduction"),s("span",{class:"hljs-punctuation"},":"),n(` String
-  `),s("span",{class:"hljs-symbol"},"our_process"),s("span",{class:"hljs-punctuation"},":"),n(` String
-  `),s("span",{class:"hljs-symbol"},"sales_email"),s("span",{class:"hljs-punctuation"},":"),n(` String
-  `),s("span",{class:"hljs-symbol"},"general_email"),s("span",{class:"hljs-punctuation"},":"),n(` String
-  `),s("span",{class:"hljs-symbol"},"primary_color"),s("span",{class:"hljs-punctuation"},":"),n(` String
-  `),s("span",{class:"hljs-symbol"},"secondary_color"),s("span",{class:"hljs-punctuation"},":"),n(` String
-  `),s("span",{class:"hljs-symbol"},"logo"),s("span",{class:"hljs-punctuation"},":"),n(` directus_files
-  `),s("span",{class:"hljs-symbol"},"mark"),s("span",{class:"hljs-punctuation"},":"),n(` directus_files
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-
-`),s("span",{class:"hljs-keyword"},"type"),n(" articles "),s("span",{class:"hljs-punctuation"},"{"),n(`
-  `),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),n(` Int
-  `),s("span",{class:"hljs-symbol"},"status"),s("span",{class:"hljs-punctuation"},":"),n(` String
-	`),s("span",{class:"hljs-punctuation"},"..."),n(`
-`),s("span",{class:"hljs-comment"},"# etc"),n(`
-`)])],-1),G=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),n(" REST API")],-1),L=s("pre",null,[s("code",null,`GET /server/specs/graphql/
-GET /server/specs/graphql/system
-`)],-1),R=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),n(" GraphQL")],-1),Q=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),O=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	server_specs_graphql`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"scope"),s("span",{class:"hljs-punctuation"},":"),n(" graphql_sdl_scope"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` String
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),D=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),n(" Example")],-1),C=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	server_specs_graphql`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"scope"),s("span",{class:"hljs-punctuation"},":"),n(" system"),s("span",{class:"hljs-punctuation"},")"),n(`
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),H=s("hr",null,null,-1),V=s("h2",{id:"ping",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#ping"},"#"),n(" Ping")],-1),B=s("p",null,"Ping… pong! 🏓",-1),N=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),n(" Returns")],-1),U=s("p",null,"Pong.",-1),W=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),n(" REST API")],-1),z=s("pre",null,[s("code",null,`GET /server/ping
-`)],-1),F=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),n(" GraphQL")],-1),J=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),K=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	`),s("span",{class:"hljs-symbol"},"server_ping"),s("span",{class:"hljs-punctuation"},":"),n(` String
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),M=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),n(" Example")],-1),X=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	server_ping
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),Y=s("hr",null,null,-1),Z=s("h2",{id:"info",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#info"},"#"),n(" Info")],-1),$=s("p",null,"Information about the current installation.",-1),ss=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The public information is returned for everybody. Admin users get additional information (see below).")],-1),ns=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),n(" Returns")],-1),as=s("p",null,[s("code",null,"project"),n(),s("strong",null,"object"),s("br"),n(" Public information about the project. Used to render the Admin App public pages.")],-1),ts=s("code",null,"project",-1),ls=s("p",null,"Logged in users also get the following information:",-1),es=s("p",null,[s("code",null,"rateLimit"),n(),s("strong",null,"false | object"),s("br"),n(" Whether or not the rate limiter is enabled.")],-1),os=s("p",null,[s("code",null,"rateLimit.points"),n(),s("strong",null,"number"),s("br"),n(" If rate-limiter is enabled, amount of allowed points per duration")],-1),cs=s("p",null,[s("code",null,"rateLimit.duration"),n(),s("strong",null,"number"),s("br"),n(" If rate-limiter is enabled, duration in seconds in which points are counted")],-1),rs=s("p",null,"Admin users also get the following information:",-1),ps=s("p",null,[s("code",null,"directus.version"),n(),s("strong",null,"string"),s("br"),n(" Current version of Directus used.")],-1),is=s("p",null,[s("code",null,"node.version"),n(),s("strong",null,"string"),s("br"),n(" Current version of Node used.")],-1),hs=s("p",null,[s("code",null,"node.uptime"),n(),s("strong",null,"integer"),s("br"),n(" How long the current process has been running.")],-1),us=s("p",null,[s("code",null,"os.type"),n(),s("strong",null,"string"),s("br"),n(" What type of operation system is used.")],-1),ds=s("p",null,[s("code",null,"os.version"),n(),s("strong",null,"string"),s("br"),n(" What version of the operation system is used.")],-1),js=s("p",null,[s("code",null,"os.uptime"),n(),s("strong",null,"string"),s("br"),n(" How long the operating system has been up.")],-1),_s=s("p",null,[s("code",null,"os.totalmem"),n(),s("strong",null,"string"),s("br"),n(" How much memory is available on the operating system.")],-1),gs=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),n(" REST API")],-1),ms=s("pre",null,[s("code",null,`GET /server/info
-`)],-1),bs=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),n(" GraphQL")],-1),fs=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),ys=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	`),s("span",{class:"hljs-symbol"},"server_info"),s("span",{class:"hljs-punctuation"},":"),n(` server_info
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),vs=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),n(" Example")],-1),xs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	server_info `),s("span",{class:"hljs-punctuation"},"{"),n(`
-		directus `),s("span",{class:"hljs-punctuation"},"{"),n(`
-			version
-		`),s("span",{class:"hljs-punctuation"},"}"),n(`
-	`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),ks=s("hr",null,null,-1),qs=s("h2",{id:"health",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#health"},"#"),n(" Health")],-1),Ss=s("p",null,"Get the current health status of the server.",-1),Ts=s("p",null,[n("The "),s("code",null,"/server/health"),n(" endpoint shows you a general health status for the server and all connected (third party) services, such as Redis or S3.")],-1),ws=s("p",null,[n("The output is based on the “Health Check Response for HTTP APIs” draft spec: "),s("a",{href:"https://datatracker.ietf.org/doc/html/draft-inadarei-api-health-check-06",target:"_blank",rel:"noopener noreferrer"},"Health Check Response Format for HTTP APIs Draft Specification"),n(".")],-1),Ps=s("p",null,"This endpoint can be used to ensure a healthy system when running in a horizontally scaled setup, like Kubernetes, Google Cloud Platform or AWS Elastic Beanstalk.",-1),Is=s("p",null,[n("By default, the endpoint only returns a "),s("code",null,"status"),n(" of "),s("code",null,"ok"),n(", "),s("code",null,"warn"),n(" or "),s("code",null,"error"),n(". By authenticating as an admin, it will return more in-depth information about the current health status of the system.")],-1),As=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// Response"),n(`
-
-`),s("span",{class:"hljs-comment"},"// Non-admin"),n(`
-`),s("span",{class:"hljs-punctuation"},"{"),n(`
-  `),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"ok"'),n(`
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-
-`),s("span",{class:"hljs-comment"},"// Admin"),n(`
-`),s("span",{class:"hljs-punctuation"},"{"),n(`
-  `),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"ok"'),s("span",{class:"hljs-punctuation"},","),n(`
-  `),s("span",{class:"hljs-attr"},'"releaseId"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"9.0.0"'),s("span",{class:"hljs-punctuation"},","),n(`
-  `),s("span",{class:"hljs-attr"},'"serviceId"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"3292c816-ae02-43b4-ba91-f0bb549f040c"'),s("span",{class:"hljs-punctuation"},","),n(`
-  `),s("span",{class:"hljs-attr"},'"checks"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-    `),s("span",{class:"hljs-attr"},'"pg:responseTime"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n(`
-      `),s("span",{class:"hljs-punctuation"},"{"),n(`
-        `),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"ok"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"componentType"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"datastore"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"observedUnit"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"ms"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"observedValue"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"0.489"),n(`
-      `),s("span",{class:"hljs-punctuation"},"}"),n(`
-    `),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),n(`
-    `),s("span",{class:"hljs-attr"},'"pg:connectionsAvailable"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n(`
-      `),s("span",{class:"hljs-punctuation"},"{"),n(`
-        `),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"ok"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"componentType"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"datastore"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"observedValue"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"2"),n(`
-      `),s("span",{class:"hljs-punctuation"},"}"),n(`
-    `),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),n(`
-    `),s("span",{class:"hljs-attr"},'"pg:connectionsUsed"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n(`
-      `),s("span",{class:"hljs-punctuation"},"{"),n(`
-        `),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"ok"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"componentType"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"datastore"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"observedValue"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"0"),n(`
-      `),s("span",{class:"hljs-punctuation"},"}"),n(`
-    `),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),n(`
-    `),s("span",{class:"hljs-attr"},'"storage:local:responseTime"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n(`
-      `),s("span",{class:"hljs-punctuation"},"{"),n(`
-        `),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"ok"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"componentType"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"objectstore"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"observedValue"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"1.038"),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"observedUnit"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"ms"'),n(`
-      `),s("span",{class:"hljs-punctuation"},"}"),n(`
-    `),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),n(`
-    `),s("span",{class:"hljs-attr"},'"email:connection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n(`
-      `),s("span",{class:"hljs-punctuation"},"{"),n(`
-        `),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"ok"'),s("span",{class:"hljs-punctuation"},","),n(`
-        `),s("span",{class:"hljs-attr"},'"componentType"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"email"'),n(`
-      `),s("span",{class:"hljs-punctuation"},"}"),n(`
-    `),s("span",{class:"hljs-punctuation"},"]"),n(`
-  `),s("span",{class:"hljs-punctuation"},"}"),n(`
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),Es=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),n(" Returns")],-1),Gs=s("p",null,[s("code",null,"status"),n(),s("strong",null,"string"),s("br"),n(" One of "),s("code",null,"ok"),n(", "),s("code",null,"warn"),n(", "),s("code",null,"error"),n(".")],-1),Ls=s("p",null,"Authenticated admin users also get the following information:",-1),Rs=s("p",null,[s("code",null,"releaseId"),n(),s("strong",null,"string"),s("br"),n(" Directus version in use.")],-1),Qs=s("p",null,[s("code",null,"serviceId"),n(),s("strong",null,"string"),s("br"),n(" UUID of the current Directus instance.")],-1),Os=s("p",null,[s("code",null,"checks"),n(),s("strong",null,"array"),s("br"),n(" Array with the status of all individually connected services.")],-1),Ds=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),n(" REST API")],-1),Cs=s("pre",null,[s("code",null,`GET /server/health
-`)],-1),Hs=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),n(" GraphQL")],-1),Vs=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Bs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	`),s("span",{class:"hljs-symbol"},"server_health"),s("span",{class:"hljs-punctuation"},":"),n(` JSON
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),Ns=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),n(" Example")],-1),Us=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
-	server_health
-`),s("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),Ws=s("hr",null,null,-1),Ms="Server",Xs=!1,Ys="REST and GraphQL API documentation on the Server collection in Directus.",Zs="4 min read",$s="page-reference",sn={__name:"server",setup(zs,{expose:c}){const t={title:"Server",modularExtension:!1,description:"REST and GraphQL API documentation on the Server collection in Directus.",readTime:"4 min read",pageClass:"page-reference"};return c({frontmatter:t}),(Fs,Js)=>{const l=e("router-link"),r=e("docs-wrapper");return p(),i(r,{frontmatter:t},{default:a(()=>[s("div",h,[s("blockquote",null,[s("p",null,[n("Provides detailed information about the project server, its schema, and its health. "),o(l,{to:"/docs/getting-started/glossary#projects"},{default:a(()=>[n("Learn more about Projects")]),_:1}),n(".")])]),u,d,j,_,g,m,b,f,y,v,x,k,q,S,T,w,P,I,A,E,G,L,R,Q,O,D,C,H,V,B,N,U,W,z,F,J,K,M,X,Y,Z,$,ss,ns,as,s("p",null,[n("See "),o(l,{to:"/docs/reference/system/settings#the-settings-object"},{default:a(()=>[n("the settings object")]),_:1}),n(" for more information on the individual properties of the "),ts,n(" object.")]),ls,es,os,cs,rs,ps,is,hs,us,ds,js,_s,gs,ms,bs,fs,ys,vs,xs,ks,qs,Ss,Ts,ws,Ps,Is,As,Es,Gs,Ls,Rs,Qs,Os,Ds,Cs,Hs,Vs,Bs,Ns,Us,Ws])]),_:1})}}};export{sn as default,Ys as description,Xs as modularExtension,$s as pageClass,Zs as readTime,Ms as title};

package/dist/assets/settings-4740d28a.js

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

package/dist/assets/settings-c44be6ce.js

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

package/dist/assets/shares-3e43a709.js

@@ -1 +0,0 @@
-import{a as l,o as h,e as d,y as n,u as e,q as t,z as s}from"./runtime-core.esm-bundler-753bcc58.js";const c={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The Shares utility enables you to share an Item with anyone, regardless of their permissions, even if they are not users within the project.")],-1),p=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/data-sharing/data-sharing-20220217A/data-shares-20220217A.mp4",type:"video/mp4"}),e("p",null,[t("Your browser is not displaying the video for some reason. Here's a "),e("a",{href:"https://cdn.directus.io/docs/v9/app-guide/content/data-sharing/data-sharing-20220217A/data-shares-20220217A.mp4"},"link to the video"),t(" instead.")])],-1),m=e("h2",{id:"what%E2%80%99s-a-share%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#what%E2%80%99s-a-share%3F"},"#"),t(" What’s a Share?")],-1),g=e("p",null,"In any Project, some Collections may be accessible for only certain User roles, or hidden from the public. You may decide to share one of the Items within the collection with an individual or group of individuals who don’t yet have permission. In this case, use Shares. Shares let you give anybody access to an Item. When you create a Share on an Item, a Role for the Share to inherit view permissions is assigned. Then you can share the Item via a hyperlink or email. The link leads to a page containing the read-only content for just that shared Item.",-1),_={class:"tip hint"},w=e("div",{class:"hint-title"},"Read-only",-1),y={class:"warning hint"},f=e("div",{class:"hint-title"},"Users, Roles and Permissions!",-1),b=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),t(" How It Works")],-1),S=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/data-sharing/data-sharing-20220217A/how-shares-work-20220217A.mp4",type:"video/mp4"}),e("p",null,[t("If your browser is not displaying the video for some reason, here's a "),e("a",{href:"https://cdn.directus.io/docs/v9/app-guide/content/data-sharing/data-sharing-20220217A/how-shares-work-20220217A.mp4"},"link to the video"),t(" instead.")])],-1),v=e("ol",null,[e("li",null,"Navigate to the Content Module."),e("li",null,"Navigate to the Collection of the Item you want to share."),e("li",null,"Click the Item to open its Item Page."),e("li",null,"Click the Shares button in the Sidebar."),e("li",null,"From the dropdown, click “New Share.”"),e("li",null,[t("Fill in the Share Options. Everything on the "),e("a",{href:"#share-options-menu"},"Share Options Menu"),t(" is optional, but please note: "),e("ul",null,[e("li",null,"Without a name, it will be harder to remember the context/reason for the Share, especially with multiple shares on a single Item."),e("li",null,"If no Role is selected, it defaults to Public permissions, which provide no benefit, as anyone can access Items available to the Public role."),e("li",null,"The other access constraints are totally optional.")])]),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"check"),t(" in the Menu Header once you have set a name, a Role and constraints. You will see your new Share under "),e("strong",null,"Shares"),t(" in the sidebar.")]),e("li",null,[t("Click the "),e("span",{mi:"",icon:""},"more_horiz"),t(" button on the right side of your Share.")])],-1),k=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/content/data-sharing/data-sharing-20220217A/copy-send-edit-delete-shares-menu-20220217A.webp",alt:"copy send edit delete shares menu"})],-1),R=e("ol",{start:"9"},[e("li",null,[t("Here you have 4 options: "),e("ul",null,[e("li",null,[e("strong",null,"Copy Link"),t(" – Creates a hyperlink that you can copy and paste.")]),e("li",null,[e("strong",null,"Send Link"),t(" – Creates prompt for the User to add email(s) and share the link.")]),e("li",null,[e("strong",null,"Edit"),t(" – Reopens the Share Options Menu for additional edits.")]),e("li",null,[e("strong",null,"Delete"),t(" – Permanently deletes the Share.")])])])],-1),I=e("p",null,"Once the link is opened by a user, a custom page displaying the Shared Item will be rendered.",-1),C=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Logout to test links"),e("p",null,"If you open a Share link while logged in to Directus, it will redirect to the Item in the Directus App. When testing a Share, make sure to log out of the app before opening the link, or simply open the link in another browser or incognito tab.")],-1),x=e("h2",{id:"share-options-menu",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#share-options-menu"},"#"),t(" Share Options Menu")],-1),A=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/content/data-sharing/data-sharing-20220217A/share-options-menu-20220217A.webp",alt:"Share Options Menu"})],-1),F=e("ul",null,[e("li",null,[e("strong",null,"Name"),t(" – Adds a name to describe the Share.")]),e("li",null,[e("strong",null,"Role"),t(" – "),e("a",{href:"#assigning-a-role"},"Assigns a Role"),t(" from which the Share will inherit permissions.")]),e("li",null,[e("strong",null,"Password"),t(" – Creates a password that must be used to access the shared Item.")]),e("li",null,[e("strong",null,"Start Date"),t(" – Selects the first date that the Share can be accessed.")]),e("li",null,[e("strong",null,"End Date"),t(" – Selects the last date that the Share can be accessed.")]),e("li",null,[e("strong",null,"Max Uses"),t(" – Sets the total number of times the shared Item can be viewed.")]),e("li",null,[e("strong",null,"Times Used"),t(" - Displays the number of times the shared Item was viewed.")])],-1),N=e("h2",{id:"creating-and-viewing-shares",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#creating-and-viewing-shares"},"#"),t(" Creating and Viewing Shares")],-1),P=e("p",null,[t("A User’s ability to create Shares depends on their Role’s permissions. If you are an "),e("code",null,"Administrator"),t(", "),e("em",null,"congratulations!"),t(" You can share any Item you want. However, Users with other Roles will likely have limited Share permissions.")],-1),M=e("p",null,"Any Share will inherit the same read permissions as the Role it was associated with in the Share Options Menu.",-1),O=e("ul",null,[e("li",null,"Set the Collections a Role can view or share."),e("li",null,"Filter for specific Items a Role can view or share."),e("li",null,"Set specific Fields a Role can view or share."),e("li",null,"Set view permissions of relationally linked Items."),e("li",null,"Restrict Role access to specific IP address(es).")],-1),E=e("h2",{id:"is-data-sharing-safe%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#is-data-sharing-safe%3F"},"#"),t(" Is Data Sharing Safe?")],-1),T=e("p",null,[t("Obviously, you don’t want to expose Items unless they are explicitly shared, however some Items may be linked to Items in other Collections. So, in addition to inheriting the Role’s permissions, the API automatically generates and injects a permissions set so that only the shared Item "),e("em",null,"(and the Items relationally linked to that shared Item)"),t(" can be viewed. As noted previously, viewability is dependent on whether the Role associated to the Share has read permissions on those linked Collections.")],-1),U=e("h2",{id:"assigning-a-role",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#assigning-a-role"},"#"),t(" Assigning a Role")],-1),D=e("p",null,[t("The Role option in the "),e("a",{href:"#share-options-menu"},"Share Options Menu"),t(" lets you associate a Role to the Share. The Share will then inherit permissions of that Role.")],-1),H=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/content/data-sharing/data-sharing-20220217A/select-existing-role-menu-20220217A.webp",alt:"Select Role for Share"})],-1),L=e("h3",{id:"assign-an-existing-role",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#assign-an-existing-role"},"#"),t(" Assign an Existing Role")],-1),W=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"Share Options Menu"),t(".")]),e("li",null,[t("Click the Role Input Box and a new side menu will appear "),e("em",null,"(shown above)"),t(".")]),e("li",null,"Select the Role from which you’d like your Share to inherit permissions."),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"check"),t(" to confirm.")])],-1),Y=e("h3",{id:"creating-%2F-editing-a-role",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#creating-%2F-editing-a-role"},"#"),t(" Creating / Editing a Role")],-1),B=e("p",null,[e("em",null,"If your Role has the correct permissions configured"),t(", you can create a new Role and assign it to a Share "),e("em",null,"“on the fly”"),t(" in the Share Options Menu. However, you will still need to navigate to "),e("strong",null,"Settings > Roles and Permissions > [Role Name]"),t(" to configure any read permissions.")],-1),j=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/content/data-sharing/data-sharing-20220217A/creating-and-edit-roles-menu-20220217A.webp",alt:"Creating / Editing a Role within Shares"})],-1),V=e("h3",{id:"create-a-new-role",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-new-role"},"#"),t(" Create a New Role")],-1),q=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"Share Options Menu"),t(".")]),e("li",null,[t("Click "),e("span",{mi:"",icon:""},"add"),t(" in the Role Input Box and the Role Options Menu will appear.")]),e("li",null,"Fill out the options to create the Role according to your needs."),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"check"),t(" to confirm Role creation.")])],-1),z=e("h3",{id:"edit-an-assigned-role",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#edit-an-assigned-role"},"#"),t(" Edit an Assigned Role")],-1),G=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"Share Options Menu"),t(".")]),e("li",null,[t("Click "),e("span",{mi:"",icon:""},"open_in_new"),t(" in the Role Input Box and the Role Options Menu will appear.")]),e("li",null,"Edit Role options according to your needs."),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"check"),t(" to confirm edits.")])],-1),J=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"You're creating / editing actual Roles!"),e("p",null,"If you create or edit a Role in this menu, your changes will take effect across the application, not just in the context of the Share.")],-1),K=e("h2",{id:"limit-sharing-by-collection",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#limit-sharing-by-collection"},"#"),t(" Limit Sharing by Collection")],-1),Q=e("p",null,"You can limit which Collections a Role is allowed to share:",-1),X=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Roles and Permissions"),t(".")]),e("li",null,[t("Select the "),e("strong",null,"[Role Name]"),t(" that will be responsible for creating the Share.")]),e("li",null,[t("Find the "),e("strong",null,"[Collection]"),t(" you wish to set Filter(s) for, then click the icon in the column under "),e("span",{mi:"",icon:""},"share"),t(" and a small menu will appear.")]),e("li",null,[t("Select "),e("span",{mi:""},"check"),t(" to enable and "),e("span",{mi:""},"block"),t(" to disable Shares on this Collection.")])],-1),Z=e("h2",{id:"limit-sharing-by-item",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#limit-sharing-by-item"},"#"),t(" Limit Sharing by Item")],-1),$=e("p",null,[t("Sometimes you may want a given Role to be able to share some Items but not others. Filters allow you to control exactly which Items a Role will be able to share, for example, "),e("em",null,"only share reports that are marked as ‘Done’"),t(". To use Filters:")],-1),ee=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Roles and Permissions"),t(".")]),e("li",null,[t("Select the "),e("strong",null,"[Role Name]"),t(" that will be responsible for creating the Share.")]),e("li",null,[t("Find the "),e("strong",null,"[Collection]"),t(" you wish to set the Filter(s) for, then click the icon in the column under "),e("span",{mi:"",icon:""},"share"),t(" and a small menu will appear.")]),e("li",null,[t("Select "),e("span",{mi:"",icon:""},"rule"),e("strong",null,"Use Custom"),t(" and a side menu will appear.")]),e("li",null,"Create your Filter(s) as needed.")],-1),te=e("h2",{id:"limit-sharing-by-field",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#limit-sharing-by-field"},"#"),t(" Limit Sharing by Field")],-1),ne=e("p",null,[t("When you create a Share on some Item, you associate a Role "),e("em",null,"(and thus the Role’s permissions)"),t(" to the Item. This allows you to set read permissions for the exact fields "),e("em",null,"(including relational fields)"),t(" that get shared. To Limit sharing by Field:")],-1),ie=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Roles and Permissions"),t(".")]),e("li",null,[t("Select the "),e("strong",null,"[Role Name]"),t(" that is assigned to the Share.")]),e("li",null,[t("Find the "),e("strong",null,"[Collection]"),t(" then click the icon in the column under the "),e("span",{mi:"",icon:""},"visibility"),t(" icon and a small menu will appear.")]),e("li",null,[t("Select "),e("span",{mi:"",icon:""},"rule"),e("strong",null,"Use Custom"),t(" and a side menu will appear.")]),e("li",null,[t("Click "),e("strong",null,"Field Permissions"),t(".")]),e("li",null,"Click to check the Collection Fields for which you’d like to allow read permissions."),e("li",null,[t("Select "),e("span",{mi:""},"check"),t(" in the side menu Header to confirm changes.")])],-1),re="Shares",he=!1,de={__name:"shares",setup(se,{expose:a}){const o={title:"Shares",modularExtension:!1};return a({frontmatter:o}),(oe,le)=>{const i=l("router-link"),r=l("docs-wrapper");return h(),d(r,{frontmatter:o},{default:n(()=>[e("div",c,[u,p,m,g,e("div",_,[w,e("p",null,[t("At this time, Shares are read-only. However, Data Sharing is an extensible feature that could support full CRUD permissions. We welcome any "),s(i,{to:"/docs/contributing/introduction"},{default:n(()=>[t("pull-requests")]),_:1}),t(" to address this or interest in "),s(i,{to:"/docs/getting-started/support#sponsored-work"},{default:n(()=>[t("sponsoring the feature")]),_:1}),t(".")])]),e("div",y,[f,e("p",null,[t("You will need to understand how "),s(i,{to:"/docs/configuration/users-roles-permissions"},{default:n(()=>[t("Users, Roles, and Permissions")]),_:1}),t(" work in Directus to configure Shares properly.")])]),b,S,v,k,R,I,C,x,A,F,N,P,M,e("p",null,[t("This system allows for absolutely granular configuration options on Shares… "),e("em",null,[t("but it also means you’ll need to understand "),s(i,{to:"/docs/configuration/users-roles-permissions"},{default:n(()=>[t("Users, Roles, and Permissions")]),_:1}),t(" thoroughly to use Shares properly")]),t(". Here are some highlights of what you can do:")]),O,E,T,U,D,H,L,W,Y,B,j,V,q,z,G,J,K,Q,X,Z,$,ee,te,ne,ie])]),_:1})}}};export{de as default,he as modularExtension,re as title};

package/dist/assets/shell-ca487a90.js

@@ -1 +0,0 @@
-import{z as E}from"./index.5b245cc4.entry.js";function S(k,d){for(var i=0;i<d.length;i++){const f=d[i];if(typeof f!="string"&&!Array.isArray(f)){for(const l in f)if(l!=="default"&&!(l in k)){const s=Object.getOwnPropertyDescriptor(f,l);s&&Object.defineProperty(k,l,s.get?s:{enumerable:!0,get:()=>f[l]})}}}return Object.freeze(Object.defineProperty(k,Symbol.toStringTag,{value:"Module"}))}var w={};(function(k,d){(function(i){i(E)})(function(i){i.defineMode("shell",function(){var f={};function l(e,n){for(var r=0;r<n.length;r++)f[n[r]]=e}var s=["true","false"],a=["if","then","do","else","elif","while","until","for","in","esac","fi","fin","fil","done","exit","set","unset","export","function"],g=["ab","awk","bash","beep","cat","cc","cd","chown","chmod","chroot","clear","cp","curl","cut","diff","echo","find","gawk","gcc","get","git","grep","hg","kill","killall","ln","ls","make","mkdir","openssl","mv","nc","nl","node","npm","ping","ps","restart","rm","rmdir","sed","service","sh","shopt","shred","source","sort","sleep","ssh","start","stop","su","sudo","svn","tee","telnet","top","touch","vi","vim","wall","wc","wget","who","write","yes","zsh"];i.registerHelper("hintWords","shell",s.concat(a,g)),l("atom",s),l("keyword",a),l("builtin",g);function b(e,n){if(e.eatSpace())return null;var r=e.sol(),t=e.next();if(t==="\\")return e.next(),null;if(t==="'"||t==='"'||t==="`")return n.tokens.unshift(p(t,t==="`"?"quote":"string")),h(e,n);if(t==="#")return r&&e.eat("!")?(e.skipToEnd(),"meta"):(e.skipToEnd(),"comment");if(t==="$")return n.tokens.unshift(v),h(e,n);if(t==="+"||t==="=")return"operator";if(t==="-")return e.eat("-"),e.eatWhile(/\w/),"attribute";if(t=="<"){if(e.match("<<"))return"operator";var u=e.match(/^<-?\s*['"]?([^'"]*)['"]?/);if(u)return n.tokens.unshift(y(u[1])),"string-2"}if(/\d/.test(t)&&(e.eatWhile(/\d/),e.eol()||!/\w/.test(e.peek())))return"number";e.eatWhile(/[\w-]/);var o=e.current();return e.peek()==="="&&/\w+/.test(o)?"def":f.hasOwnProperty(o)?f[o]:null}function p(e,n){var r=e=="("?")":e=="{"?"}":e;return function(t,u){for(var o,c=!1;(o=t.next())!=null;){if(o===r&&!c){u.tokens.shift();break}else if(o==="$"&&!c&&e!=="'"&&t.peek()!=r){c=!0,t.backUp(1),u.tokens.unshift(v);break}else{if(!c&&e!==r&&o===e)return u.tokens.unshift(p(e,n)),h(t,u);if(!c&&/['"]/.test(o)&&!/['"]/.test(e)){u.tokens.unshift(x(o,"string")),t.backUp(1);break}}c=!c&&o==="\\"}return n}}function x(e,n){return function(r,t){return t.tokens[0]=p(e,n),r.next(),h(r,t)}}var v=function(e,n){n.tokens.length>1&&e.eat("$");var r=e.next();return/['"({]/.test(r)?(n.tokens[0]=p(r,r=="("?"quote":r=="{"?"def":"string"),h(e,n)):(/\d/.test(r)||e.eatWhile(/\w/),n.tokens.shift(),"def")};function y(e){return function(n,r){return n.sol()&&n.string==e&&r.tokens.shift(),n.skipToEnd(),"string-2"}}function h(e,n){return(n.tokens[0]||b)(e,n)}return{startState:function(){return{tokens:[]}},token:function(e,n){return h(e,n)},closeBrackets:"()[]{}''\"\"``",lineComment:"#",fold:"brace"}}),i.defineMIME("text/x-sh","shell"),i.defineMIME("application/x-sh","shell")})})();const m=S({__proto__:null,default:w},[w]);export{m as s};

package/dist/assets/show-hint-b91c59d1.js

@@ -1 +0,0 @@
-import{z as ot}from"./index.5b245cc4.entry.js";function rt(S,I){for(var r=0;r<I.length;r++){const y=I[r];if(typeof y!="string"&&!Array.isArray(y)){for(const m in y)if(m!=="default"&&!(m in S)){const w=Object.getOwnPropertyDescriptor(y,m);w&&Object.defineProperty(S,m,w.get?w:{enumerable:!0,get:()=>y[m]})}}}return Object.freeze(Object.defineProperty(S,Symbol.toStringTag,{value:"Module"}))}var G={};(function(S,I){(function(r){r(ot)})(function(r){var y="CodeMirror-hint",m="CodeMirror-hint-active";r.showHint=function(t,e,i){if(!e)return t.showHint(i);i&&i.async&&(e.async=!0);var n={hint:e};if(i)for(var s in i)n[s]=i[s];return t.showHint(n)},r.defineExtension("showHint",function(t){t=Z(this,this.getCursor("start"),t);var e=this.listSelections();if(!(e.length>1)){if(this.somethingSelected()){if(!t.hint.supportsSelection)return;for(var i=0;i<e.length;i++)if(e[i].head.line!=e[i].anchor.line)return}this.state.completionActive&&this.state.completionActive.close();var n=this.state.completionActive=new w(this,t);n.options.hint&&(r.signal(this,"startCompletion",this),n.update(!0))}}),r.defineExtension("closeHint",function(){this.state.completionActive&&this.state.completionActive.close()});function w(t,e){if(this.cm=t,this.options=e,this.widget=null,this.debounce=0,this.tick=0,this.startPos=this.cm.getCursor("start"),this.startLen=this.cm.getLine(this.startPos.line).length-this.cm.getSelection().length,this.options.updateOnCursorActivity){var i=this;t.on("cursorActivity",this.activityFunc=function(){i.cursorActivity()})}}var J=window.requestAnimationFrame||function(t){return setTimeout(t,1e3/60)},Q=window.cancelAnimationFrame||clearTimeout;w.prototype={close:function(){this.active()&&(this.cm.state.completionActive=null,this.tick=null,this.options.updateOnCursorActivity&&this.cm.off("cursorActivity",this.activityFunc),this.widget&&this.data&&r.signal(this.data,"close"),this.widget&&this.widget.close(),r.signal(this.cm,"endCompletion",this.cm))},active:function(){return this.cm.state.completionActive==this},pick:function(t,e){var i=t.list[e],n=this;this.cm.operation(function(){i.hint?i.hint(n.cm,t,i):n.cm.replaceRange(R(i),i.from||t.from,i.to||t.to,"complete"),r.signal(t,"pick",i),n.cm.scrollIntoView()}),this.options.closeOnPick&&this.close()},cursorActivity:function(){this.debounce&&(Q(this.debounce),this.debounce=0);var t=this.startPos;this.data&&(t=this.data.from);var e=this.cm.getCursor(),i=this.cm.getLine(e.line);if(e.line!=this.startPos.line||i.length-e.ch!=this.startLen-this.startPos.ch||e.ch<t.ch||this.cm.somethingSelected()||!e.ch||this.options.closeCharacters.test(i.charAt(e.ch-1)))this.close();else{var n=this;this.debounce=J(function(){n.update()}),this.widget&&this.widget.disable()}},update:function(t){if(this.tick!=null){var e=this,i=++this.tick;K(this.options.hint,this.cm,this.options,function(n){e.tick==i&&e.finishUpdate(n,t)})}},finishUpdate:function(t,e){this.data&&r.signal(this.data,"update");var i=this.widget&&this.widget.picked||e&&this.options.completeSingle;this.widget&&this.widget.close(),this.data=t,t&&t.list.length&&(i&&t.list.length==1?this.pick(t,0):(this.widget=new B(this,t),r.signal(t,"shown")))}};function Z(t,e,i){var n=t.options.hintOptions,s={};for(var c in U)s[c]=U[c];if(n)for(var c in n)n[c]!==void 0&&(s[c]=n[c]);if(i)for(var c in i)i[c]!==void 0&&(s[c]=i[c]);return s.hint.resolve&&(s.hint=s.hint.resolve(t,e)),s}function R(t){return typeof t=="string"?t:t.text}function $(t,e){var i={Up:function(){e.moveFocus(-1)},Down:function(){e.moveFocus(1)},PageUp:function(){e.moveFocus(-e.menuSize()+1,!0)},PageDown:function(){e.moveFocus(e.menuSize()-1,!0)},Home:function(){e.setFocus(0)},End:function(){e.setFocus(e.length-1)},Enter:e.pick,Tab:e.pick,Esc:e.close},n=/Mac/.test(navigator.platform);n&&(i["Ctrl-P"]=function(){e.moveFocus(-1)},i["Ctrl-N"]=function(){e.moveFocus(1)});var s=t.options.customKeys,c=s?{}:i;function o(u,l){var a;typeof l!="string"?a=function(H){return l(H,e)}:i.hasOwnProperty(l)?a=i[l]:a=l,c[u]=a}if(s)for(var f in s)s.hasOwnProperty(f)&&o(f,s[f]);var h=t.options.extraKeys;if(h)for(var f in h)h.hasOwnProperty(f)&&o(f,h[f]);return c}function _(t,e){for(;e&&e!=t;){if(e.nodeName.toUpperCase()==="LI"&&e.parentNode==t)return e;e=e.parentNode}}function B(t,e){this.id="cm-complete-"+Math.floor(Math.random(1e6)),this.completion=t,this.data=e,this.picked=!1;var i=this,n=t.cm,s=n.getInputField().ownerDocument,c=s.defaultView||s.parentWindow,o=this.hints=s.createElement("ul");o.setAttribute("role","listbox"),o.setAttribute("aria-expanded","true"),o.id=this.id;var f=t.cm.options.theme;o.className="CodeMirror-hints "+f,this.selectedHint=e.selectedHint||0;for(var h=e.list,u=0;u<h.length;++u){var l=o.appendChild(s.createElement("li")),a=h[u],H=y+(u!=this.selectedHint?"":" "+m);a.className!=null&&(H=a.className+" "+H),l.className=H,u==this.selectedHint&&l.setAttribute("aria-selected","true"),l.id=this.id+"-"+u,l.setAttribute("role","option"),a.render?a.render(l,e,a):l.appendChild(s.createTextNode(a.displayText||R(a))),l.hintId=u}var b=t.options.container||s.body,v=n.cursorCoords(t.options.alignWithWord?e.from:null),T=v.left,x=v.bottom,D=!0,k=0,O=0;if(b!==s.body){var it=["absolute","relative","fixed"].indexOf(c.getComputedStyle(b).position)!==-1,C=it?b:b.offsetParent,z=C.getBoundingClientRect(),M=s.body.getBoundingClientRect();k=z.left-M.left-C.scrollLeft,O=z.top-M.top-C.scrollTop}o.style.left=T-k+"px",o.style.top=x-O+"px";var F=c.innerWidth||Math.max(s.body.offsetWidth,s.documentElement.offsetWidth),W=c.innerHeight||Math.max(s.body.offsetHeight,s.documentElement.offsetHeight);b.appendChild(o),n.getInputField().setAttribute("aria-autocomplete","list"),n.getInputField().setAttribute("aria-owns",this.id),n.getInputField().setAttribute("aria-activedescendant",this.id+"-"+this.selectedHint);var g=t.options.moveOnOverlap?o.getBoundingClientRect():new DOMRect,j=t.options.paddingForScrollbar?o.scrollHeight>o.clientHeight+1:!1,A;setTimeout(function(){A=n.getScrollInfo()});var nt=g.bottom-W;if(nt>0){var L=g.bottom-g.top,st=v.top-(v.bottom-g.top);if(st-L>0)o.style.top=(x=v.top-L-O)+"px",D=!1;else if(L>W){o.style.height=W-5+"px",o.style.top=(x=v.bottom-g.top-O)+"px";var V=n.getCursor();e.from.ch!=V.ch&&(v=n.cursorCoords(V),o.style.left=(T=v.left-k)+"px",g=o.getBoundingClientRect())}}var E=g.right-F;if(j&&(E+=n.display.nativeBarWidth),E>0&&(g.right-g.left>F&&(o.style.width=F-5+"px",E-=g.right-g.left-F),o.style.left=(T=v.left-E-k)+"px"),j)for(var N=o.firstChild;N;N=N.nextSibling)N.style.paddingRight=n.display.nativeBarWidth+"px";if(n.addKeyMap(this.keyMap=$(t,{moveFocus:function(p,d){i.changeActive(i.selectedHint+p,d)},setFocus:function(p){i.changeActive(p)},menuSize:function(){return i.screenAmount()},length:h.length,close:function(){t.close()},pick:function(){i.pick()},data:e})),t.options.closeOnUnfocus){var q;n.on("blur",this.onBlur=function(){q=setTimeout(function(){t.close()},100)}),n.on("focus",this.onFocus=function(){clearTimeout(q)})}n.on("scroll",this.onScroll=function(){var p=n.getScrollInfo(),d=n.getWrapperElement().getBoundingClientRect();A||(A=n.getScrollInfo());var X=x+A.top-p.top,P=X-(c.pageYOffset||(s.documentElement||s.body).scrollTop);if(D||(P+=o.offsetHeight),P<=d.top||P>=d.bottom)return t.close();o.style.top=X+"px",o.style.left=T+A.left-p.left+"px"}),r.on(o,"dblclick",function(p){var d=_(o,p.target||p.srcElement);d&&d.hintId!=null&&(i.changeActive(d.hintId),i.pick())}),r.on(o,"click",function(p){var d=_(o,p.target||p.srcElement);d&&d.hintId!=null&&(i.changeActive(d.hintId),t.options.completeOnSingleClick&&i.pick())}),r.on(o,"mousedown",function(){setTimeout(function(){n.focus()},20)});var Y=this.getSelectedHintRange();return(Y.from!==0||Y.to!==0)&&this.scrollToActive(),r.signal(e,"select",h[this.selectedHint],o.childNodes[this.selectedHint]),!0}B.prototype={close:function(){if(this.completion.widget==this){this.completion.widget=null,this.hints.parentNode&&this.hints.parentNode.removeChild(this.hints),this.completion.cm.removeKeyMap(this.keyMap);var t=this.completion.cm.getInputField();t.removeAttribute("aria-activedescendant"),t.removeAttribute("aria-owns");var e=this.completion.cm;this.completion.options.closeOnUnfocus&&(e.off("blur",this.onBlur),e.off("focus",this.onFocus)),e.off("scroll",this.onScroll)}},disable:function(){this.completion.cm.removeKeyMap(this.keyMap);var t=this;this.keyMap={Enter:function(){t.picked=!0}},this.completion.cm.addKeyMap(this.keyMap)},pick:function(){this.completion.pick(this.data,this.selectedHint)},changeActive:function(t,e){if(t>=this.data.list.length?t=e?this.data.list.length-1:0:t<0&&(t=e?0:this.data.list.length-1),this.selectedHint!=t){var i=this.hints.childNodes[this.selectedHint];i&&(i.className=i.className.replace(" "+m,""),i.removeAttribute("aria-selected")),i=this.hints.childNodes[this.selectedHint=t],i.className+=" "+m,i.setAttribute("aria-selected","true"),this.completion.cm.getInputField().setAttribute("aria-activedescendant",i.id),this.scrollToActive(),r.signal(this.data,"select",this.data.list[this.selectedHint],i)}},scrollToActive:function(){var t=this.getSelectedHintRange(),e=this.hints.childNodes[t.from],i=this.hints.childNodes[t.to],n=this.hints.firstChild;e.offsetTop<this.hints.scrollTop?this.hints.scrollTop=e.offsetTop-n.offsetTop:i.offsetTop+i.offsetHeight>this.hints.scrollTop+this.hints.clientHeight&&(this.hints.scrollTop=i.offsetTop+i.offsetHeight-this.hints.clientHeight+n.offsetTop)},screenAmount:function(){return Math.floor(this.hints.clientHeight/this.hints.firstChild.offsetHeight)||1},getSelectedHintRange:function(){var t=this.completion.options.scrollMargin||0;return{from:Math.max(0,this.selectedHint-t),to:Math.min(this.data.list.length-1,this.selectedHint+t)}}};function tt(t,e){if(!t.somethingSelected())return e;for(var i=[],n=0;n<e.length;n++)e[n].supportsSelection&&i.push(e[n]);return i}function K(t,e,i,n){if(t.async)t(e,n,i);else{var s=t(e,i);s&&s.then?s.then(n):n(s)}}function et(t,e){var i=t.getHelpers(e,"hint"),n;if(i.length){var s=function(c,o,f){var h=tt(c,i);function u(l){if(l==h.length)return o(null);K(h[l],c,f,function(a){a&&a.list.length>0?o(a):u(l+1)})}u(0)};return s.async=!0,s.supportsSelection=!0,s}else return(n=t.getHelper(t.getCursor(),"hintWords"))?function(c){return r.hint.fromList(c,{words:n})}:r.hint.anyword?function(c,o){return r.hint.anyword(c,o)}:function(){}}r.registerHelper("hint","auto",{resolve:et}),r.registerHelper("hint","fromList",function(t,e){var i=t.getCursor(),n=t.getTokenAt(i),s,c=r.Pos(i.line,n.start),o=i;n.start<i.ch&&/\w/.test(n.string.charAt(i.ch-n.start-1))?s=n.string.substr(0,i.ch-n.start):(s="",c=i);for(var f=[],h=0;h<e.words.length;h++){var u=e.words[h];u.slice(0,s.length)==s&&f.push(u)}if(f.length)return{list:f,from:c,to:o}}),r.commands.autocomplete=r.showHint;var U={hint:r.hint.auto,completeSingle:!0,alignWithWord:!0,closeCharacters:/[\s()\[\]{};:>,]/,closeOnPick:!0,closeOnUnfocus:!0,updateOnCursorActivity:!0,completeOnSingleClick:!0,container:null,customKeys:null,extraKeys:null,paddingForScrollbar:!0,moveOnOverlap:!0};r.defineOption("hintOptions",null)})})();const lt=rt({__proto__:null,default:G},[G]);export{lt as s};

package/dist/assets/show-hint-d139d464.css

@@ -1 +0,0 @@
-.CodeMirror-hints{position:absolute;z-index:10;overflow:hidden;list-style:none;margin:0;padding:2px;-webkit-box-shadow:2px 3px 5px rgba(0,0,0,.2);-moz-box-shadow:2px 3px 5px rgba(0,0,0,.2);box-shadow:2px 3px 5px #0003;border-radius:3px;border:1px solid silver;background:white;font-size:90%;font-family:monospace;max-height:20em;overflow-y:auto}.CodeMirror-hint{margin:0;padding:0 4px;border-radius:2px;white-space:pre;color:#000;cursor:pointer}li.CodeMirror-hint-active{background:#08f;color:#fff}

package/dist/assets/sieve-2b47299c.js

@@ -1 +0,0 @@
-import{z as _}from"./index.5b245cc4.entry.js";function b(c,p){for(var t=0;t<p.length;t++){const u=p[t];if(typeof u!="string"&&!Array.isArray(u)){for(const o in u)if(o!=="default"&&!(o in c)){const f=Object.getOwnPropertyDescriptor(u,o);f&&Object.defineProperty(c,o,f.get?f:{enumerable:!0,get:()=>u[o]})}}}return Object.freeze(Object.defineProperty(c,Symbol.toStringTag,{value:"Module"}))}var k={};(function(c,p){(function(t){t(_)})(function(t){t.defineMode("sieve",function(u){function o(n){for(var e={},r=n.split(" "),i=0;i<r.length;++i)e[r[i]]=!0;return e}var f=o("if elsif else stop require"),g=o("true false not"),s=u.indentUnit;function l(n,e){var r=n.next();if(r=="/"&&n.eat("*"))return e.tokenize=a,a(n,e);if(r==="#")return n.skipToEnd(),"comment";if(r=='"')return e.tokenize=h(r),e.tokenize(n,e);if(r=="(")return e._indent.push("("),e._indent.push("{"),null;if(r==="{")return e._indent.push("{"),null;if(r==")"&&(e._indent.pop(),e._indent.pop()),r==="}")return e._indent.pop(),null;if(r==","||r==";"||/[{}\(\),;]/.test(r))return null;if(/\d/.test(r))return n.eatWhile(/[\d]/),n.eat(/[KkMmGg]/),"number";if(r==":")return n.eatWhile(/[a-zA-Z_]/),n.eatWhile(/[a-zA-Z0-9_]/),"operator";n.eatWhile(/\w/);var i=n.current();return i=="text"&&n.eat(":")?(e.tokenize=v,"string"):f.propertyIsEnumerable(i)?"keyword":g.propertyIsEnumerable(i)?"atom":null}function v(n,e){return e._multiLineString=!0,n.sol()?(n.next()=="."&&n.eol()&&(e._multiLineString=!1,e.tokenize=l),"string"):(n.eatSpace(),n.peek()=="#"?(n.skipToEnd(),"comment"):(n.skipToEnd(),"string"))}function a(n,e){for(var r=!1,i;(i=n.next())!=null;){if(r&&i=="/"){e.tokenize=l;break}r=i=="*"}return"comment"}function h(n){return function(e,r){for(var i=!1,d;(d=e.next())!=null&&!(d==n&&!i);)i=!i&&d=="\\";return i||(r.tokenize=l),"string"}}return{startState:function(n){return{tokenize:l,baseIndent:n||0,_indent:[]}},token:function(n,e){return n.eatSpace()?null:(e.tokenize||l)(n,e)},indent:function(n,e){var r=n._indent.length;return e&&e[0]=="}"&&r--,r<0&&(r=0),r*s},electricChars:"}"}}),t.defineMIME("application/sieve","sieve")})})();const y=b({__proto__:null,default:k},[k]);export{y as s};