@directus/app 9.12.0 → 9.12.1

package/dist/assets/introduction.2e6f5c1d.js

@@ -0,0 +1,90 @@
+import{a as l,o as d,b as c,w as s,g as t,e as a,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var o={};const h={class:"markdown-body"},u=t("blockquote",null,[t("p",null,"Directus offers both a RESTful and GraphQL API to manage the data in the database. The API has predictable resource-oriented URLs, relies on standard HTTP status codes, and uses JSON for input and output.")],-1),p=t("p",null,[t("div",{class:"table-of-contents"},[t("ul",null,[t("li",null,[t("a",{href:"#dynamic-api"},"Dynamic API")]),t("li",null,[t("a",{href:"#rest-vs.-graphql"},"REST vs. GraphQL")]),t("li",null,[t("a",{href:"#authentication"},"Authentication")]),t("li",null,[t("a",{href:"#relational-data"},"Relational Data")]),t("li",null,[t("a",{href:"#search-http-method"},"SEARCH HTTP Method")]),t("li",null,[t("a",{href:"#system-data-in-graphql"},"System data in GraphQL")]),t("li",null,[t("a",{href:"#error-codes"},"Error Codes")])])])],-1),_=t("h2",{id:"dynamic-api"},[e("Dynamic API "),t("a",{class:"header-anchor",href:"#dynamic-api"},"#")],-1),f=e("The platform\u2019s API uses "),m=e("Database Mirroring"),y=e(" to dynamically generate REST endpoints and a GraphQL schema based on the connected database\u2019s architecture. Since these endpoints return data based on your specific schema and configured permissions, the input/output of the API differs greatly for individual installations."),g=t("h2",{id:"rest-vs.-graphql"},[e("REST vs. GraphQL "),t("a",{class:"header-anchor",href:"#rest-vs.-graphql"},"#")],-1),b=t("p",null,[t("strong",null,"There is no difference in the functionality available between the REST and GraphQL endpoints."),e(" The functionality available in both is mapped to the same set of core services, meaning that you don\u2019t lose any performance or capabilities by choosing one or the other.")],-1),w=t("p",null,"Which one you choose is ultimately up to you.",-1),T=t("h2",{id:"authentication"},[e("Authentication "),t("a",{class:"header-anchor",href:"#authentication"},"#")],-1),j=e("By default, all data in the system is off-limits for unauthenticated users. To gain access to protected data, you must "),v=e("include an access token with every request"),E=e(", or "),A=e("configure permissions for the public role"),k=e("."),I=t("p",null,"Useful references:",-1),P=e("Authenticating into the API"),D=e("Login endpoint reference"),S=t("h2",{id:"relational-data"},[e("Relational Data "),t("a",{class:"header-anchor",href:"#relational-data"},"#")],-1),R=e("Directus only retrieves the fields in your items that explicitly have been requested. Relational data can be retrieved nested by using "),q=e("the "),L=t("code",{class:""},"fields",-1),x=e(" parameter"),N=e(" in REST, or regular nested queries in GraphQL. This allows you to retrieve the author of your article included in the articles data, or fetch related log entry points for your app\u2019s analytics data for example."),O=t("h3",{id:"creating-%2F-updating-%2F-deleting"},[e("Creating / Updating / Deleting "),t("a",{class:"header-anchor",href:"#creating-%2F-updating-%2F-deleting"},"#")],-1),C=t("p",null,"Similarly to fetching, relational content can be modified deeply as well.",-1),H=t("h4",{id:"many-to-one"},[e("Many-to-One "),t("a",{class:"header-anchor",href:"#many-to-one"},"#")],-1),M=t("p",null,"Many-to-One relationships are fairly straightforward to manage relationally. You can simply submit the changes you want as an object under the relational key in your collection. For example, if you wanted to create a new featured article on your page, you could submit:",-1),U=t("pre",null,[t("code",{class:"language-json"},[e(`{
+	`),t("span",{class:"hljs-attr"},'"featured_article"'),e(`: {
+		`),t("span",{class:"hljs-attr"},'"title"'),e(": "),t("span",{class:"hljs-string"},'"This is my new article!"'),e(`
+	}
+}
+`)])],-1),G=t("p",null,[e("This will create a new record in the related collection, and save its primary key in the "),t("code",{class:""},"featured_article"),e(" field for this item. To update an existing item, simply provide the primary key with the updates, and Directus will treat it as an update instead of a creation:")],-1),V=t("pre",null,[t("code",{class:"language-json"},[e(`{
+	`),t("span",{class:"hljs-attr"},'"featured_article"'),e(`: {
+		`),t("span",{class:"hljs-attr"},'"id"'),e(": "),t("span",{class:"hljs-number"},"15"),e(`,
+		`),t("span",{class:"hljs-attr"},'"title"'),e(": "),t("span",{class:"hljs-string"},'"This is an updated title for my article!"'),e(`
+	}
+}
+`)])],-1),B=t("p",null,"Seeing that the Many-to-One relationship stores the foreign key on the field itself, removing the item can be done by nullifying the field:",-1),F=t("pre",null,[t("code",{class:"language-json"},[e(`{
+	`),t("span",{class:"hljs-attr"},'"featured_article"'),e(": "),t("span",{class:"hljs-literal"},"null"),e(`
+}
+`)])],-1),Q=t("h4",{id:"one-to-many-(%2F-many-to-many)"},[e("One-to-Many (/ Many-to-Many) "),t("a",{class:"header-anchor",href:"#one-to-many-(%2F-many-to-many)"},"#")],-1),Y=t("p",null,"One-to-Many, and therefore Many-to-Many and Many-to-Any, relationships can be updated in one of two ways:",-1),W=t("p",null,[t("strong",null,"Basic")],-1),K=t("p",null,[e("The API will return one-to-many fields as an array of nested keys or items (based on the "),t("code",{class:""},"fields"),e(" parameter). You can use this same structure to select what the related items are:")],-1),X=t("pre",null,[t("code",{class:"language-json"},[e(`{
+	`),t("span",{class:"hljs-attr"},'"children"'),e(": ["),t("span",{class:"hljs-number"},"2"),e(", "),t("span",{class:"hljs-number"},"7"),e(", "),t("span",{class:"hljs-number"},"149"),e(`]
+}
+`)])],-1),z=t("p",null,"You can also provide an object instead of a primary key in order to create new items nested on the fly, or an object with a primary key included to update an existing item:",-1),J=t("pre",null,[t("code",{class:"language-json"},[e(`{
+	`),t("span",{class:"hljs-attr"},'"children"'),e(`: [
+		`),t("span",{class:"hljs-number"},"2"),e(", "),t("span",{class:"hljs-comment"},"// assign existing item 2 to be a child of the current item"),e(`
+		{
+			`),t("span",{class:"hljs-attr"},'"name"'),e(": "),t("span",{class:"hljs-string"},'"A new nested item"'),e(`
+		},
+		{
+			`),t("span",{class:"hljs-attr"},'"id"'),e(": "),t("span",{class:"hljs-number"},"149"),e(`,
+			`),t("span",{class:"hljs-attr"},'"name"'),e(": "),t("span",{class:"hljs-string"},'"Assign and update existing item 149"'),e(`
+		}
+	]
+}
+`)])],-1),Z=t("p",null,"To remove items from this relationship, simply omit them from the array:",-1),$=t("pre",null,[t("code",{class:"language-json"},[e(`{
+	`),t("span",{class:"hljs-attr"},'"children"'),e(": ["),t("span",{class:"hljs-number"},"2"),e(", "),t("span",{class:"hljs-number"},"149"),e(`]
+}
+`)])],-1),tt=t("p",null,"This method of updating a one-to-many is very useful for smaller relational datasets.",-1),et=t("p",null,[t("strong",null,"\u201CDetailed\u201D")],-1),st=t("p",null,"Alternatively, you can provide an object detailing the changes as follows:",-1),nt=t("pre",null,[t("code",{class:"language-json"},[e(`{
+	`),t("span",{class:"hljs-attr"},'"children"'),e(`: {
+		`),t("span",{class:"hljs-attr"},'"create"'),e(": [{ "),t("span",{class:"hljs-attr"},'"name"'),e(": "),t("span",{class:"hljs-string"},'"A new nested item"'),e(` }],
+		`),t("span",{class:"hljs-attr"},'"update"'),e(": [{ "),t("span",{class:"hljs-attr"},'"id"'),e(": "),t("span",{class:"hljs-number"},"149"),e(", "),t("span",{class:"hljs-attr"},'"name"'),e(": "),t("span",{class:"hljs-string"},'"A new nested item"'),e(` }],
+		`),t("span",{class:"hljs-attr"},'"delete"'),e(": ["),t("span",{class:"hljs-number"},"7"),e(`]
+	}
+}
+`)])],-1),at=t("p",null,"This is useful if you need to have more tightly control on staged changes, or when you\u2019re working with a big relational dataset.",-1),lt=t("h4",{id:"many-to-any-(union-types)"},[e("Many-to-Any (Union Types) "),t("a",{class:"header-anchor",href:"#many-to-any-(union-types)"},"#")],-1),ot=t("p",null,"Many-to-Any fields work very similar to a \u201Cregular\u201D many-to-many, with the exception that the related field can pull in the fields from any of the related collections, for example:",-1),rt=t("pre",null,[t("code",{class:"language-json"},[e(`{
+	`),t("span",{class:"hljs-attr"},'"sections"'),e(`: [
+		{
+			`),t("span",{class:"hljs-attr"},'"collection"'),e(": "),t("span",{class:"hljs-string"},'"headings"'),e(`,
+			`),t("span",{class:"hljs-attr"},'"item"'),e(`: {
+				`),t("span",{class:"hljs-comment"},"/* headings fields */"),e(`
+			}
+		},
+		{
+			`),t("span",{class:"hljs-attr"},'"collection"'),e(": "),t("span",{class:"hljs-string"},'"paragraphs"'),e(`,
+			`),t("span",{class:"hljs-attr"},'"item"'),e(`: {
+				`),t("span",{class:"hljs-comment"},"/* paragraphs fields */"),e(`
+			}
+		}
+	]
+}
+`)])],-1),it=t("h5",{id:"rest-api"},[e("REST API "),t("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),dt=t("p",null,[e("To scope the fields that are returned per collection type, you can use the "),t("code",{class:""},"<field>:<scope>"),e(" syntax in the fields parameter as follows:")],-1),ct=t("pre",null,[t("code",{class:""},`GET /items/pages
+	?fields[]=sections.item:headings.id
+	&fields[]=sections.item:headings.title
+	&fields[]=sections.item:paragraphs.body
+	&fields[]=sections.item:paragraphs.background_color
+`)],-1),ht=t("h5",{id:"graphql"},[e("GraphQL "),t("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ut=t("p",null,"In GraphQL, you can use nested fragments on the Union Type to select the fields:",-1),pt=t("pre",null,[t("code",{class:"language-graphql"},[t("span",{class:"hljs-keyword"},"query"),e(` {
+	pages {
+		sections {
+			item {
+				`),t("span",{class:"hljs-keyword"},"..."),e(),t("span",{class:"hljs-keyword"},"on"),e(` headings {
+					id
+					title
+				}
+
+				`),t("span",{class:"hljs-keyword"},"..."),e(),t("span",{class:"hljs-keyword"},"on"),e(` paragraphs {
+					body
+					background_color
+				}
+			}
+		}
+	}
+}
+`)])],-1),_t=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Updating"),t("p",null,"Updating records in a many-to-any is identical to the other relationship types.")],-1),ft=t("h2",{id:"search-http-method"},[e("SEARCH HTTP Method "),t("a",{class:"header-anchor",href:"#search-http-method"},"#")],-1),mt=t("p",null,"When using the REST API to read multiple items by (very) advanced filters, you might run into the issue where the URL simply can\u2019t hold enough data to include the full query structure. In those cases, you can use the SEARCH http method as a drop-in replacement for GET, where you\u2019re allowed to put the query into the request body as follows:",-1),yt=t("p",null,[t("strong",null,"Before:")],-1),gt=t("pre",null,[t("code",{class:""},`GET /items/articles?filter[title][_eq]=Hello World
+`)],-1),bt=t("p",null,[t("strong",null,"After:")],-1),wt=t("pre",null,[t("code",{class:"language-json"},`SEARCH /items/articles
+
+{
+	"query": {
+		"filter": {
+			"title": {
+				"_eq": "Hello World"
+			}
+		}
+	}
+}
+`)],-1),Tt=t("p",null,[e("There\u2019s a lot of discussion around whether or not to put a body in a GET request, to use POSTs to create search queries, or to rely on a different method altogether. As of right now, we\u2019ve chosen "),t("a",{href:"https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/",target:"_blank",rel:"noopener noreferrer"},[e("to align with IETF\u2019s "),t("em",null,"HTTP SEARCH Method"),e(" specification")]),e(". While we recognize this is still a draft spec, the SEARCH method has been used extensively before in the WebDAV world ("),t("a",{href:"https://tools.ietf.org/html/rfc5323",target:"_blank",rel:"noopener noreferrer"},"spec"),e("), and compared to the other available options, it feels like the \u201Ccleanest\u201D and most correct to handle this moving forward. As with everything else, if you have any ideas, opinions, or concerns, "),t("a",{href:"https://github.com/directus/directus/discussions/new",target:"_blank",rel:"noopener noreferrer"},"we\u2019d love to hear your thoughts"),e(".")],-1),jt=t("p",null,"Useful reading:",-1),vt=t("ul",null,[t("li",null,[t("a",{href:"https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"HTTP SEARCH Method"),e(" (IETF, 2021)")])]),t("li",null,[t("a",{href:"https://httptoolkit.tech/blog/http-search-method/",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"Defining a new HTTP method: HTTP SEARCH"),e(" (Tim Perry, 2021)")])]),t("li",null,[t("a",{href:"https://stackoverflow.com/questions/978061/http-get-with-request-body",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"HTTP GET with request body"),e(" (StackOverflow, 2009 and ongoing)")])]),t("li",null,[t("a",{href:"https://www.elastic.co/guide/en/elasticsearch/guide/current/_empty_search.html",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"Elastic Search GET body usage"),e(" (elastic, n.d.)")])]),t("li",null,[t("a",{href:"https://evertpot.com/dropbox-post-api/",target:"_blank",rel:"noopener noreferrer"},[t("em",null,"Dropbox starts using POST, and why this is poor API design."),e(" (Evert Pot, 2015)")])])],-1),Et=t("h2",{id:"system-data-in-graphql"},[e("System data in GraphQL "),t("a",{class:"header-anchor",href:"#system-data-in-graphql"},"#")],-1),At=t("p",null,[e("Due to restrictions in GraphQL itself, it\u2019s impossible to properly scope/namespace system functionality from regular data access. In order to prevent any naming conflicts between user-created and system data, we\u2019ve scoped the access of the two into separate endpoints for user and system data respectively: "),t("code",{class:""},"/graphql"),e(" and "),t("code",{class:""},"/graphql/system"),e(". Both endpoints share the same underlying schema, so "),t("strong",null,"nested relations will work as expected"),e(" regardless if they \u201Ccross over\u201D between user and system data. The only difference in the two endpoints are the root query and mutation fields available.")],-1),kt=t("h2",{id:"error-codes"},[e("Error Codes "),t("a",{class:"header-anchor",href:"#error-codes"},"#")],-1),It=t("p",null,"Below are the global error codes used within Directus, and what they mean.",-1),Pt=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"Error Code"),t("th",null,"HTTP Status"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,[t("code",{class:""},"FAILED_VALIDATION")]),t("td",null,"400"),t("td",null,"Validation for this particular item failed")]),t("tr",null,[t("td",null,[t("code",{class:""},"FORBIDDEN")]),t("td",null,"403"),t("td",null,"You are not allowed to do the current action")]),t("tr",null,[t("td",null,[t("code",{class:""},"INVALID_TOKEN")]),t("td",null,"403"),t("td",null,"Provided token is invalid")]),t("tr",null,[t("td",null,[t("code",{class:""},"TOKEN_EXPIRED")]),t("td",null,"401"),t("td",null,"Provided token is valid but has expired")]),t("tr",null,[t("td",null,[t("code",{class:""},"INVALID_CREDENTIALS")]),t("td",null,"401"),t("td",null,"Username / password or access token is wrong")]),t("tr",null,[t("td",null,[t("code",{class:""},"INVALID_IP")]),t("td",null,"401"),t("td",null,"Your IP address isn\u2019t allow-listed to be used with this user")]),t("tr",null,[t("td",null,[t("code",{class:""},"INVALID_OTP")]),t("td",null,"401"),t("td",null,"Wrong OTP was provided")]),t("tr",null,[t("td",null,[t("code",{class:""},"INVALID_PAYLOAD")]),t("td",null,"400"),t("td",null,"Provided payload is invalid")]),t("tr",null,[t("td",null,[t("code",{class:""},"INVALID_QUERY")]),t("td",null,"400"),t("td",null,"The requested query parameters can not be used")]),t("tr",null,[t("td",null,[t("code",{class:""},"UNSUPPORTED_MEDIA_TYPE")]),t("td",null,"415"),t("td",null,[e("Provided payload format or "),t("code",{class:""},"Content-Type"),e(" header is unsupported")])]),t("tr",null,[t("td",null,[t("code",{class:""},"REQUESTS_EXCEEDED")]),t("td",null,"429"),t("td",null,"Hit the rate limit")]),t("tr",null,[t("td",null,[t("code",{class:""},"ROUTE_NOT_FOUND")]),t("td",null,"404"),t("td",null,"Endpoint does not exist")]),t("tr",null,[t("td",null,[t("code",{class:""},"SERVICE_UNAVAILABLE")]),t("td",null,"503"),t("td",null,"Could not use external service")]),t("tr",null,[t("td",null,[t("code",{class:""},"UNPROCESSABLE_ENTITY")]),t("td",null,"422"),t("td",null,"You tried doing something illegal")])])],-1),Dt=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Security"),t("p",null,[e("To prevent leaking which items exist, all actions for non-existing items will return a "),t("code",{class:""},"FORBIDDEN"),e(" error.")])],-1),St={title:"API Reference",modularExtension:!1},Rt={name:"introduction",setup(qt,{expose:r}){return r({frontmatter:{title:"API Reference",modularExtension:!1}}),(Lt,xt)=>{const n=l("router-link"),i=l("docswrapper");return d(),c(i,{frontmatter:St},{default:s(()=>[t("div",h,[u,p,_,t("p",null,[f,a(n,{to:"/docs/getting-started/introduction/#database-mirroring"},{default:s(()=>[m]),_:1}),y]),g,b,w,T,t("p",null,[j,a(n,{to:"/docs/reference/authentication/#access-tokens"},{default:s(()=>[v]),_:1}),E,a(n,{to:"/docs/getting-started/quickstart/#_6-set-role-public-permissions"},{default:s(()=>[A]),_:1}),k]),I,t("ul",null,[t("li",null,[a(n,{to:"/docs/reference/authentication/"},{default:s(()=>[P]),_:1})]),t("li",null,[a(n,{to:"/docs/reference/authentication/#login"},{default:s(()=>[D]),_:1})])]),S,t("p",null,[R,a(n,{to:"/docs/reference/query/#fields"},{default:s(()=>[q,L,x]),_:1}),N]),O,C,H,M,U,G,V,B,F,Q,Y,W,K,X,z,J,Z,$,tt,et,st,nt,at,lt,ot,rt,it,dt,ct,ht,ut,pt,_t,ft,mt,yt,gt,bt,wt,Tt,jt,vt,Et,At,kt,It,Pt,Dt])]),_:1})}}};typeof o=="function"&&o(Rt);export{Rt as default,St as frontmatter};

package/dist/assets/introduction.78a2a844.js

@@ -0,0 +1,4 @@
+import{a as r,o as l,b as c,w as o,g as e,e as i,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const d={class:"markdown-body"},h=e("blockquote",null,[e("p",null,[t("Our team truly appreciates every single contributor, community member, GitHub star, pull-request, bug report, and feature request. Keeping Directus completely free and open-source is our way of saying: "),e("strong",null,"Thank you!")])],-1),p=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"We're here to help!"),e("p",null,[t("If you have "),e("em",null,"any"),t(" questions along your contributor journey, please feel free to come chat with us on our "),e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord Community"),t(".")])],-1),_=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Technical Contributor Docs"),e("p",null,[t("Technical documentation for contributing to the core codebase is located on the main "),e("code",{class:""},"directus/directus"),e("a",{href:"https://github.com/directus/directus/wiki",target:"_blank",rel:"noopener noreferrer"},"GitHub repository\u2019s Wiki"),t(".")])],-1),f=e("h2",{id:"code-of-conduct"},[t("Code of Conduct "),e("a",{class:"header-anchor",href:"#code-of-conduct"},"#")],-1),g=e("p",null,[e("strong",null,[t("The Directus "),e("a",{href:"https://github.com/directus/directus/blob/main/code_of_conduct.md",target:"_blank",rel:"noopener noreferrer"},"Code of Conduct"),t(" is one of the ways we put our values into practice. We expect all of our staff, contractors and contributors to know and follow this code.")])],-1),m=e("p",null,[e("strong",null,"Our contributors and maintainers work extremely hard to build Directus as premium open-source software. Please be respectful of those efforts throughout our ecosystem. Trolling, harassing, insulting, or other unacceptable behavior by participants will not be tolerated.")],-1),b=e("p",null,"In the interest of fostering an open and welcoming environment, we as pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.",-1),y=e("p",null,"Examples of behavior that contributes to creating a positive environment include:",-1),w=e("ul",null,[e("li",null,"Using welcoming and inclusive language"),e("li",null,"Being respectful of differing viewpoints and experiences"),e("li",null,"Gracefully accepting constructive criticism"),e("li",null,"Focusing on what is best for the community"),e("li",null,"Showing empathy towards other community members")],-1),v=e("p",null,[e("strong",null,[t("Before continuing, please take a moment to read our full "),e("a",{href:"https://github.com/directus/directus/blob/main/contributing.md",target:"_blank",rel:"noopener noreferrer"},"Code of Conduct"),t(".")])],-1),k=e("h2",{id:"wait-%E2%80%94-before-you-begin"},[t("Wait \u2014 Before you Begin "),e("a",{class:"header-anchor",href:"#wait-%E2%80%94-before-you-begin"},"#")],-1),q=t("When contributing to this repository, it is important to first discuss the change you wish to make with the owners of this repository. This can be done via "),x=e("a",{href:"https://github.com/directus/directus/issues",target:"_blank",rel:"noopener noreferrer"},"GitHub Issue",-1),C=t(", "),D=e("a",{href:"https://github.com/directus/directus/discussions",target:"_blank",rel:"noopener noreferrer"},"GitHub Discussions",-1),R=t(", "),F=e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord",-1),B=t(", "),T=t("email"),Y=t(", or any other method."),G=e("p",null,"Following this rule will help avoid wasted time caused by multiple people working on the same issue or writing code that will not be merged.",-1),H=e("h2",{id:"feature-requests"},[t("Feature Requests "),e("a",{class:"header-anchor",href:"#feature-requests"},"#")],-1),S=e("p",null,[t("Feature requests are a great way to let our team know what should be prioritized next. You can "),e("a",{href:"https://github.com/directus/directus/discussions/new",target:"_blank",rel:"noopener noreferrer"},"submit a new feature request"),t(" or "),e("a",{href:"https://github.com/directus/directus/discussions",target:"_blank",rel:"noopener noreferrer"},"vote on existing submissions"),t(" via GitHub Discussions.")],-1),W=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"The 80/20 Rule"),e("p",null,"To keep the Directus codebase as clean and simple as possible, we will only consider approving features that we feel at least 80% of our user-base will find valuable. If your feature request falls within the 20% range, it is considered an edge-case and should be implemented as an extension.")],-1),A=e("h2",{id:"rfcs"},[t("RFCs "),e("a",{class:"header-anchor",href:"#rfcs"},"#")],-1),I=e("p",null,[t("Some Directus features/fixes may require additional design, strategy, and/or discussion before beginning work. For these notable pull-requests, you should first submit an RFC (Request For Comments) to our core team via "),e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord"),t(". This process is relatively informal, but ensures proper alignment, and helps avoid squandered development time by contributors.")],-1),E=e("h2",{id:"bug-reporting"},[t("Bug Reporting "),e("a",{class:"header-anchor",href:"#bug-reporting"},"#")],-1),N=e("p",null,[t("Reporting any bugs you come across is an invaluable part of helping keep Directus stable. After confirming a similar issue doesn\u2019t already exist, you can "),e("a",{href:"https://github.com/directus/directus/issues/new",target:"_blank",rel:"noopener noreferrer"},"submit a bug report"),t(" via GitHub Issues. Please ensure the following for all submissions:")],-1),O=e("li",null,"You are experiencing an actual bug, not a configuration issue",-1),P=e("li",null,"You are using the official (pre-built) version of directus and not a fork",-1),V=e("li",null,"You are not asking a question or requesting a new feature",-1),U=e("li",null,"You have checked that no similar issue (or discussion) already exists",-1),j=e("li",null,"You have entered a clear and concise title",-1),z=e("li",null,"You have followed the issue template, with stack details and steps to reproduce",-1),K=t("You have already completed all "),L=t("troubleshooting steps"),M=e("h2",{id:"reporting-security-vulnerabilities"},[t("Reporting Security Vulnerabilities "),e("a",{class:"header-anchor",href:"#reporting-security-vulnerabilities"},"#")],-1),J=t("If you believe you have discovered a security issue within a Directus product or service, please reach out to us directly over email: "),Q=t("security@directus.io"),X=t(". We will then open a "),Z=e("a",{href:"https://github.com/directus/directus/security/advisories",target:"_blank",rel:"noopener noreferrer"},"GitHub Security Advisory",-1),$=t(" for tracking the fix."),ee=e("p",null,"We value the members of the independent security research community who find security vulnerabilities and work with our team so that proper fixes can be issued to users. Our policy is to credit all researchers in the fix\u2019s release notes. In order to receive credit, security researchers must follow responsible disclosure practices, including:",-1),te=e("ul",null,[e("li",null,"They do not publish the vulnerability prior to the Directus team releasing a fix for it"),e("li",null,"They do not divulge exact details of the issue, eg: through exploits or proof-of-concepts")],-1),oe=e("h2",{id:"submitting-a-pull-request"},[t("Submitting a Pull-Request "),e("a",{class:"header-anchor",href:"#submitting-a-pull-request"},"#")],-1),se=e("h3",{id:"1.-submit-an-rfc-(if-needed)"},[t("1. Submit an RFC (if needed) "),e("a",{class:"header-anchor",href:"#1.-submit-an-rfc-(if-needed)"},"#")],-1),ie=e("p",null,[t("Please read our docs on the "),e("a",{href:"#rfcs"},"RFC process"),t(".")],-1),re=e("h3",{id:"2.-update-relevant-docs"},[t("2. Update relevant docs "),e("a",{class:"header-anchor",href:"#2.-update-relevant-docs"},"#")],-1),ne=e("p",null,"Before submitting any pull-requests, ensure that any relevant documentation (included in this same repo) is updated.",-1),ae=e("h3",{id:"3.-push-your-changes"},[t("3. Push your changes "),e("a",{class:"header-anchor",href:"#3.-push-your-changes"},"#")],-1),ue=e("pre",null,[e("code",{class:"language-bash"},`git push -u origin YOUR-BRANCH-NAME
+`)],-1),le=e("h3",{id:"submit-a-pull-request"},[t("Submit a pull-request "),e("a",{class:"header-anchor",href:"#submit-a-pull-request"},"#")],-1),ce=e("p",null,"Once you push the changes to your repo, the \u201CCompare & pull request\u201D button will appear in GitHub. Click it and you\u2019ll be taken to a screen where you can fill in the appropriate details. Finally, open the pull request by clicking the \u201CCreate pull request\u201D button.",-1),de=e("p",null,"Now our core staff will review your contribution and either merge it, or request that you to make changes.",-1),he=e("h2",{id:"syncing-your-fork-with-directus"},[t("Syncing Your Fork with Directus "),e("a",{class:"header-anchor",href:"#syncing-your-fork-with-directus"},"#")],-1),pe=e("p",null,"After you have submitted your pull requests, you would need to sync your fork with Directus to pull all the latest commits before you continue to contribute.",-1),_e=e("h3",{id:"1.-add-directus-as-a-remote"},[t("1. Add Directus as a Remote "),e("a",{class:"header-anchor",href:"#1.-add-directus-as-a-remote"},"#")],-1),fe=e("p",null,"While your fork is your main remote or origin, you will add Directus as the upstream, which generally refers to the original repo that you have forked.",-1),ge=e("pre",null,[e("code",{class:"language-bash"},`git remote add upstream git@github.com:directus/directus.git
+`)],-1),me=e("h3",{id:"2.-fetch-the-latest-changes"},[t("2. Fetch the Latest Changes "),e("a",{class:"header-anchor",href:"#2.-fetch-the-latest-changes"},"#")],-1),be=e("p",null,[t("Depending on your setup, you will need to get the latest commits from the "),e("code",{class:""},"main"),t(" branch of Directus by doing a pull, reset, rebase or fetch.")],-1),ye=e("pre",null,[e("code",{class:"language-bash"},`git pull upstream main
+`)],-1),we=e("p",null,"At this point you are ready to continue working on Directus, with the latest commits included!",-1),ve=e("div",{class:"tip hint"},[e("p",null,"Before you begin or resume development, be sure to always sync, if you are going to submit a pull request with your changes!")],-1),ke={title:"Contributing",modularExtension:!1},qe={name:"introduction",setup(xe,{expose:a}){return a({frontmatter:{title:"Contributing",modularExtension:!1}}),(Ce,De)=>{const s=r("router-link"),u=r("docswrapper");return l(),c(u,{frontmatter:ke},{default:o(()=>[e("div",d,[h,p,_,f,g,m,b,y,w,v,k,e("p",null,[q,x,C,D,R,F,B,i(s,{to:"/docsmailto:info@directus.io"},{default:o(()=>[T]),_:1}),Y]),G,H,S,W,A,I,E,N,e("ul",null,[O,P,V,U,j,z,e("li",null,[K,i(s,{to:"/docs/getting-started/support#troubleshooting-steps"},{default:o(()=>[L]),_:1})])]),M,e("p",null,[J,i(s,{to:"/docsmailto:security@directus.io"},{default:o(()=>[Q]),_:1}),X,Z,$]),ee,te,oe,se,ie,re,ne,ae,ue,le,ce,de,he,pe,_e,fe,ge,me,be,ye,we,ve])]),_:1})}}};typeof n=="function"&&n(qe);export{qe as default,ke as frontmatter};

package/dist/assets/introduction.7c5efc8a.js

@@ -0,0 +1 @@
+import{a as i,o as c,b as _,w as s,g as t,e as n,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var a={};const r={class:"markdown-body"},h=t("blockquote",null,[t("p",null,"In addition to being highly customizable, Directus has been architected to be completely modular and extensible. This ensures you will never hit a hard feature ceiling within the platform.")],-1),u=t("h2",{id:"extension-sdk"},[e("Extension SDK "),t("a",{class:"header-anchor",href:"#extension-sdk"},"#")],-1),p=e("The easiest way to start creating extensions is to use the "),x=e("Extensions SDK"),m=e("."),f=t("h2",{id:"app-extensions"},[e("App Extensions "),t("a",{class:"header-anchor",href:"#app-extensions"},"#")],-1),w=t("p",null,"Allow creating custom experiences within the Directus App.",-1),C=e("Modules"),g=e(" \u2014 Created with Vue.js"),y=e("Layouts"),E=e(" \u2014 Created with Vue.js"),k=e("Interfaces"),b=e(" \u2014 Created with Vue.js"),j=e("Displays"),v=e(" \u2014 Created with Vue.js"),V=e("Panels"),S=e(" \u2014 Created with Vue.js"),D=e("Themes"),N=e(" \u2014 Created with custom CSS"),T=t("h2",{id:"api-extensions"},[e("API Extensions "),t("a",{class:"header-anchor",href:"#api-extensions"},"#")],-1),A=t("p",null,"Allow extending and customizing the data pipeline and platform logic.",-1),B=e("Endpoints"),I=e(" \u2014 Created with JavaScript / Node.js"),J=e("Hooks"),L=e(" \u2014 Created with JavaScript / Node.js"),q=e("Email Templates"),z=e(" \u2014 Created with Liquid.js"),K=e("Migrations"),M=e(" \u2014 Created with JavaScript / Node.js"),P=e(" ## CLI Extensions TBD - Commands - Extensions "),H={title:"Extensions",modularExtension:!1},F={name:"introduction",setup(G,{expose:d}){return d({frontmatter:{title:"Extensions",modularExtension:!1}}),(O,Q)=>{const o=i("router-link"),l=i("docswrapper");return c(),_(l,{frontmatter:H},{default:s(()=>[t("div",r,[h,u,t("p",null,[p,n(o,{to:"/docs/extensions/creating-extensions/"},{default:s(()=>[x]),_:1}),m]),f,w,t("ul",null,[t("li",null,[n(o,{to:"/docs/extensions/modules/"},{default:s(()=>[C]),_:1}),g]),t("li",null,[n(o,{to:"/docs/extensions/layouts/"},{default:s(()=>[y]),_:1}),E]),t("li",null,[n(o,{to:"/docs/extensions/interfaces/"},{default:s(()=>[k]),_:1}),b]),t("li",null,[n(o,{to:"/docs/extensions/displays/"},{default:s(()=>[j]),_:1}),v]),t("li",null,[n(o,{to:"/docs/extensions/panels/"},{default:s(()=>[V]),_:1}),S]),t("li",null,[n(o,{to:"/docs/extensions/themes/"},{default:s(()=>[D]),_:1}),N])]),T,A,t("ul",null,[t("li",null,[n(o,{to:"/docs/extensions/endpoints/"},{default:s(()=>[B]),_:1}),I]),t("li",null,[n(o,{to:"/docs/extensions/hooks/"},{default:s(()=>[J]),_:1}),L]),t("li",null,[n(o,{to:"/docs/extensions/email-templates/"},{default:s(()=>[q]),_:1}),z]),t("li",null,[n(o,{to:"/docs/extensions/migrations/"},{default:s(()=>[K]),_:1}),M])]),P])]),_:1})}}};typeof a=="function"&&a(F);export{F as default,H as frontmatter};

package/dist/assets/introduction.d5621d79.js

@@ -0,0 +1 @@
+import{a,o as u,b as d,w as o,g as e,e as s,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const c={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"These Docs will help you get up-and-running quickly, guide you through advanced features, and explain the core concepts that make Directus so unique.")],-1),p=e("h2",{id:"what-is-directus%3F"},[t("What is Directus? "),e("a",{class:"header-anchor",href:"#what-is-directus%3F"},"#")],-1),g=e("p",null,[e("strong",null,"Directus is an Open Data Platform built to democratize the database."),t(" Its no-code app is safe and intuitive enough to make data accessible to everyone, while still providing the granular configuration and technical tools required by power-users and data scientists. For developers, a data connection toolkit provides a dynamic REST+GraphQL API, JavaScript SDK, and options for authorization, caching, and more.")],-1),f=e("p",null,[t("Written entirely in JavaScript (primarily "),e("a",{href:"https://nodejs.dev",target:"_blank",rel:"noopener noreferrer"},"Node.js"),t(" and "),e("a",{href:"https://vuejs.org",target:"_blank",rel:"noopener noreferrer"},"Vue.js"),t("), Directus is completely open-source, modular, and extensible, allowing it to be fully tailored to the requirements of any project. Below are the key features of the platform:")],-1),m=e("ul",null,[e("li",null,[e("strong",null,"No-Code App for anyone to manage data")]),e("li",null,[e("strong",null,"Data Connection Toolkit with REST & GraphQL")]),e("li",null,[e("strong",null,"Supports Any SQL Database")]),e("li",null,[e("strong",null,"Authorization & Caching")]),e("li",null,[e("strong",null,"Completely Free & Open Source")])],-1),_=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"What's in a name?"),e("p",null,[t("\u201CDirectus\u201D ("),e("a",{href:"http://audio.pronouncekiwi.com/Salli/Directus",target:"_blank",rel:"noopener noreferrer"},"duh REKT iss"),t(") is Latin for: "),e("em",null,"laid straight, arranged in lines"),t(". The broadest goal of our platform is to present data in a simple, orderly, and intuitive way.")])],-1),y=e("h2",{id:"use-cases"},[t("Use Cases "),e("a",{class:"header-anchor",href:"#use-cases"},"#")],-1),b=e("p",null,"As flexible as the database itself, Directus can power any data-driven project. Below are some examples of common ways the platform is used:",-1),w=e("ul",null,[e("li",null,[e("strong",null,"Headless CMS"),t(" \u2014 Whether you\u2019re building on JAMstack, server-side (SSR), static websites (SSG), etc \u2014 Open Data Platforms offer a modern and flexible way to manage every omnichannel digital experience.")]),e("li",null,[e("strong",null,"Apps, Games & IoT"),t(" \u2014 A powerful data backbone for any software or smart device, including: native or hybrid apps, VR/AR, customer kiosks, installations, microcontrollers, digital signage, and even smart appliances.")]),e("li",null,[e("strong",null,"No-Code App Builder"),t(" \u2014 Ditch the spreadsheet. Now anyone can create beautiful custom apps for managing customers, projects, inventory, knowledgebases, task lists, marketing, or anything else\u2026 all with zero code.")]),e("li",null,[e("strong",null,"Back-Office & BI Tools"),t(" \u2014 Gain insights into company KPIs and enable no-code exploration of business data. Coalesce previously siloed department data to give your team meaningful and actionable analytics.")]),e("li",null,[e("strong",null,"Digital Asset Management"),t(" \u2014 Aggregate all of your digital files in one place for improved organization, searchability, delivery, and integration with other datasets, all while enabling on-the-fly file transformations.")]),e("li",null,[e("strong",null,"Raw Data Visualization"),t(" \u2014 Establish a \u201Csingle source of truth\u201D for all of your disparate data while enabling non-technical users to build custom dashboards that generate meaningful insights from complex datasets.")])],-1),v=e("h2",{id:"core-principles"},[t("Core Principles "),e("a",{class:"header-anchor",href:"#core-principles"},"#")],-1),k=e("p",null,"Directus is a simple solution for complex problems, with a data-first approach guided by the following core principles:",-1),D=e("ul",null,[e("li",null,[e("strong",null,"Pure"),t(" \u2014 No predefined or proprietary schema, with all system metadata stored separately")]),e("li",null,[e("strong",null,"Open"),t(" \u2014 Public and transparent codebase with no obfuscated or cloud-only code")]),e("li",null,[e("strong",null,"Portable"),t(" \u2014 Database can be exported or migrated at any time with no vendor lock-in")]),e("li",null,[e("strong",null,"Limitless"),t(" \u2014 No artificial limitations or paywalls on users, roles, languages, collections, or items")]),e("li",null,[e("strong",null,"Extensible"),t(" \u2014 Every aspect of the platform is modular to avoid any hard feature ceilings")]),e("li",null,[e("strong",null,"Unopinionated"),t(" \u2014 Choose your stack, database, and architecture; self-hosted or on cloud")])],-1),x=e("h2",{id:"database-mirroring"},[t("Database Mirroring "),e("a",{class:"header-anchor",href:"#database-mirroring"},"#")],-1),A=e("p",null,[e("strong",null,[t("Directus is installed as a "),e("em",null,"layer"),t(" on top of your new or existing SQL database, with its App and API dynamically \u201Cmirroring\u201D your actual schema and content in real-time.")]),t(" This approach is similar to how technical database clients (like "),e("em",null,"phpMyAdmin"),t(") work, however Directus provides an experience that is safe, intuitive, and powerful enough for anyone\u2026 even the most non-technical users.")],-1),S=t("To keep things simple, Directus uses friendlier names for database terms, including "),C=t("Project"),T=t(" (database), "),P=t("Collection"),I=t(" (table), "),E=t("Field"),j=t(" (column), "),L=t("Item"),M=t(" (record), and "),N=t("Type"),O=t(" (datatype)."),q=e("p",null,"Database mirroring has many unique advantages:",-1),z=e("ul",null,[e("li",null,"Control over your pure SQL database schema, tailored to your exact requirements"),e("li",null,"Significant performance improvements through optimizations and indexing"),e("li",null,"Complete transparency, portability, and security for your data"),e("li",null,"Direct database access and the full power of raw/complex SQL queries"),e("li",null,"Allows importing existing databases, unaltered and without any migrations")],-1),B=e("p",null,"Other platforms typically use a predefined or proprietary \u201Cone-size-fits-all\u201D data model to store your content (have you ever peeked behind the curtain of a WordPress installation? Yikes!). That is not the case with Directus. Directus gives you direct access to your pure and unaltered data. That means you have the option to bypass the Directus middleware (API, SDK, App) and connect to your data with proper SQL queries. This effectively removes all bottlenecks, latency overhead, and proprietary access limitations.",-1),G=e("h2",{id:"modular-%26-extensible"},[t("Modular & Extensible "),e("a",{class:"header-anchor",href:"#modular-%26-extensible"},"#")],-1),V=e("p",null,"What makes Directus so flexible is that it has been designed from the ground up with complete extensibility, helping avoid a feature ceiling. In addition to offering our software\u2019s codebase as open-source, we\u2019ve included the following extension types in the platform\u2019s App and API.",-1),W=t("Displays"),Q=t(" \u2014 A small inline preview of a field\u2019s value"),R=t("Email Templates"),F=t(" \u2014 Custom structure and formatting for emails"),H=t("Endpoints"),K=t(" \u2014 Custom registered API endpoints"),J=t("Hooks"),U=t(" \u2014 Event and interval hooks for triggering custom logic"),Y=t("Interfaces"),X=t(" \u2014 How you view or interact with a field and its value"),Z=t("Layouts"),$=t(" \u2014 How you browse, view or interact with a set of Items in a Collection"),ee=t("Migrations"),te=t(" \u2014 Custom migrations for tracking project schema and content updates"),oe=t("Modules"),ne=t(" \u2014 The highest and broadest level of organization within the App"),se=t("Panels"),ae=t(" \u2014 A way to view dashboard data within the Insights Module"),re=t("Themes"),le=t(" \u2014 Whitelabeling through App Themes and Custom CSS"),ie=e("h2",{id:"the-directus-ecosystem"},[t("The Directus Ecosystem "),e("a",{class:"header-anchor",href:"#the-directus-ecosystem"},"#")],-1),ue=e("ul",null,[e("li",null,[e("strong",null,[e("a",{href:"https://github.com/directus/directus",target:"_blank",rel:"noopener noreferrer"},"GitHub")]),t(" \u2014 The open-source repository and version control")]),e("li",null,[e("strong",null,[e("a",{href:"https://www.npmjs.com/package/directus",target:"_blank",rel:"noopener noreferrer"},"NPM Package")]),t(" \u2014 The official Directus node package")]),e("li",null,[e("strong",null,[e("a",{href:"https://hub.docker.com/r/directus/directus",target:"_blank",rel:"noopener noreferrer"},"Docker Image")]),t(" \u2014 The official Directus docker image")]),e("li",null,[e("strong",null,[e("a",{href:"https://docs.directus.io",target:"_blank",rel:"noopener noreferrer"},"Documentation")]),t(" \u2014 Docs for the most recent version of our platform")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.cloud",target:"_blank",rel:"noopener noreferrer"},"On-Demand Cloud")]),t(" \u2014 Our self-service managed solution (multitenant)")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.cloud",target:"_blank",rel:"noopener noreferrer"},"Enterprise Cloud")]),t(" \u2014 Our tailored managed solution (single tenant)")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.cloud/docs",target:"_blank",rel:"noopener noreferrer"},"Cloud Documentation")]),t(" \u2014 Docs for the managed cloud dashboard")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.cloud/docs#creating-a-private-demo",target:"_blank",rel:"noopener noreferrer"},"Private Demos")]),t(" \u2014 Instructions on creating a free cloud demo")]),e("li",null,[e("strong",null,[e("a",{href:"https://status.directus.cloud",target:"_blank",rel:"noopener noreferrer"},"System Status")]),t(" \u2014 Up-to-date information on our various cloud systems")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.io",target:"_blank",rel:"noopener noreferrer"},"Website")]),t(" \u2014 General information, resources, and team info")]),e("li",null,[e("strong",null,[e("a",{href:"https://twitter.com/directus",target:"_blank",rel:"noopener noreferrer"},"Twitter")]),t(" \u2014 The latest product info and sneak-peeks")]),e("li",null,[e("strong",null,[e("a",{href:"https://www.youtube.com/c/DirectusVideos",target:"_blank",rel:"noopener noreferrer"},"Videos")]),t(" \u2014 Our YouTube channel with video tutorials and feature overviews")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord")]),t(" \u2014 A growing community of 4K+ developers")]),e("li",null,[e("strong",null,[e("a",{href:"https://locales.directus.io/",target:"_blank",rel:"noopener noreferrer"},"Crowdin")]),t(" \u2014 Service for managing the App\u2019s many language translations")]),e("li",null,[e("strong",null,[e("a",{href:"https://directus.market/",target:"_blank",rel:"noopener noreferrer"},"Marketplace")]),t(" \u2014 Coming in 2021, will offer a unified portal for platform extensions")]),e("li",null,[e("strong",null,[e("a",{href:"https://github.com/directus-community/awesome-directus",target:"_blank",rel:"noopener noreferrer"},"Awesome List")]),t(" \u2014 A list of awesome things related to Directus")])],-1),de={title:"Getting Started",modularExtension:!1},ce={name:"introduction",setup(he,{expose:l}){return l({frontmatter:{title:"Getting Started",modularExtension:!1}}),(pe,ge)=>{const n=a("router-link"),i=a("docswrapper");return u(),d(i,{frontmatter:de},{default:o(()=>[e("div",c,[h,p,g,f,m,_,y,b,w,v,k,D,x,A,e("p",null,[S,s(n,{to:"/docs/getting-started/glossary/#projects"},{default:o(()=>[C]),_:1}),T,s(n,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[P]),_:1}),I,s(n,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[E]),_:1}),j,s(n,{to:"/docs/getting-started/glossary/#items"},{default:o(()=>[L]),_:1}),M,s(n,{to:"/docs/getting-started/glossary/#types"},{default:o(()=>[N]),_:1}),O]),q,z,B,G,V,e("ul",null,[e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/displays/"},{default:o(()=>[W]),_:1})]),Q]),e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/email-templates/"},{default:o(()=>[R]),_:1})]),F]),e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/endpoints/"},{default:o(()=>[H]),_:1})]),K]),e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/hooks/"},{default:o(()=>[J]),_:1})]),U]),e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/interfaces/"},{default:o(()=>[Y]),_:1})]),X]),e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/layouts/"},{default:o(()=>[Z]),_:1})]),$]),e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/migrations/"},{default:o(()=>[ee]),_:1})]),te]),e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/modules/"},{default:o(()=>[oe]),_:1})]),ne]),e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/panels/"},{default:o(()=>[se]),_:1})]),ae]),e("li",null,[e("strong",null,[s(n,{to:"/docs/extensions/themes/"},{default:o(()=>[re]),_:1})]),le])]),ie,ue])]),_:1})}}};typeof r=="function"&&r(ce);export{ce as default,de as frontmatter};

package/dist/assets/{items.4e295453.js → items.4205dfa0.js}

@@ -1,4 +1,4 @@
-import{w as r,y as c,z as h,A as s,E as e,C as l,W as t}from"./vendor.f6090249.js";const d={class:"markdown-body"},u={class:"two-up"},p={class:"left"},_=t("Items are individual pieces of data in your database. They can be anything, from articles, to IoT status checks. "),m=t("Learn more about Items"),f=t("."),g=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-item-object"},"The Item Object")]),e("li",null,[e("a",{href:"#get-items"},"Get Items")]),e("li",null,[e("a",{href:"#get-item-by-id"},"Get Item by ID")]),e("li",null,[e("a",{href:"#create-an-item"},"Create an Item")]),e("li",null,[e("a",{href:"#create-multiple-items"},"Create Multiple Items")]),e("li",null,[e("a",{href:"#update-an-item"},"Update an Item")]),e("li",null,[e("a",{href:"#update-multiple-items"},"Update Multiple Items")]),e("li",null,[e("a",{href:"#delete-an-item"},"Delete an Item")]),e("li",null,[e("a",{href:"#delete-multiple-items"},"Delete Multiple Items")])])])])],-1),y=e("hr",null,null,-1),b=e("h2",{id:"the-item-object"},[t("The Item Object "),e("a",{class:"header-anchor",href:"#the-item-object"},"#")],-1),j={class:"two-up"},q={class:"left"},x=e("p",null,[t("Items don\u2019t have a pre-defined schema. The format depends completely on how you configured your collections and fields in Directus. For the sake of documentation, we\u2019ll use a fictional articles collection with the following fields: "),e("code",null,"id"),t(", "),e("code",null,"status"),t(", "),e("code",null,"title"),t(", "),e("code",null,"body"),t(", "),e("code",null,"featured_image"),t(", and "),e("code",null,"author"),t(".")],-1),v={class:"tip hint"},E=e("div",{class:"hint-title"},"Relational Data",-1),T=t("Please see "),w=t("Relational Data"),I=t(" and "),P=t("Field Parameters"),R=t(" to learn more."),S=e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[t(`{
+import{a as n,o as i,b as h,w as s,g as e,e as l,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=t("Items are individual pieces of data in your database. They can be anything, from articles, to IoT status checks. "),m=t("Learn more about Items"),f=t("."),g=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-item-object"},"The Item Object")]),e("li",null,[e("a",{href:"#get-items"},"Get Items")]),e("li",null,[e("a",{href:"#get-item-by-id"},"Get Item by ID")]),e("li",null,[e("a",{href:"#create-an-item"},"Create an Item")]),e("li",null,[e("a",{href:"#create-multiple-items"},"Create Multiple Items")]),e("li",null,[e("a",{href:"#update-an-item"},"Update an Item")]),e("li",null,[e("a",{href:"#update-multiple-items"},"Update Multiple Items")]),e("li",null,[e("a",{href:"#delete-an-item"},"Delete an Item")]),e("li",null,[e("a",{href:"#delete-multiple-items"},"Delete Multiple Items")])])])])],-1),y=e("hr",null,null,-1),b=e("h2",{id:"the-item-object"},[t("The Item Object "),e("a",{class:"header-anchor",href:"#the-item-object"},"#")],-1),j={class:"two-up"},q={class:"left"},x=e("p",null,[t("Items don\u2019t have a pre-defined schema. The format depends completely on how you configured your collections and fields in Directus. For the sake of documentation, we\u2019ll use a fictional articles collection with the following fields: "),e("code",{class:""},"id"),t(", "),e("code",{class:""},"status"),t(", "),e("code",{class:""},"title"),t(", "),e("code",{class:""},"body"),t(", "),e("code",{class:""},"featured_image"),t(", and "),e("code",{class:""},"author"),t(".")],-1),v={class:"tip hint"},w=e("div",{class:"hint-title"},"Relational Data",-1),E=t("Please see "),T=t("Relational Data"),I=t(" and "),P=t("Field Parameters"),R=t(" to learn more."),S=e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[t(`{
 	`),e("span",{class:"hljs-attr"},'"id"'),t(": "),e("span",{class:"hljs-number"},"1"),t(`,
 	`),e("span",{class:"hljs-attr"},'"status"'),t(": "),e("span",{class:"hljs-string"},'"published"'),t(`,
 	`),e("span",{class:"hljs-attr"},'"title"'),t(": "),e("span",{class:"hljs-string"},'"Hello, world!"'),t(`,
@@ -6,14 +6,14 @@ import{w as r,y as c,z as h,A as s,E as e,C as l,W as t}from"./vendor.f6090249.j
 	`),e("span",{class:"hljs-attr"},'"featured_image"'),t(": "),e("span",{class:"hljs-string"},'"768eabec-3c54-4110-a6bb-64b548116661"'),t(`,
 	`),e("span",{class:"hljs-attr"},'"author"'),t(": "),e("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),t(`
 }
-`)])])],-1),D=e("hr",null,null,-1),A=e("h2",{id:"get-items"},[t("Get Items "),e("a",{class:"header-anchor",href:"#get-items"},"#")],-1),k=e("p",null,"List all items that exist in Directus.",-1),C={class:"two-up"},G={class:"left"},Q=e("h3",{id:"query-parameters"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),L=t("Supports all "),O=t("global query parameters"),H=t("."),M={class:"tip hint"},B=e("div",{class:"hint-title"},"Relational Data",-1),U=t("The "),F=t("Field Parameter"),N=t(" is required to return nested relational data."),V=e("h3",{id:"returns"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),W=t("An array of up to "),z=t("limit"),J=t(),K=e("a",{href:"#the-item-object"},"item objects",-1),X=t(". If no items are available, data will be an empty array."),Y=e("h4",{id:"singleton"},[t("Singleton "),e("a",{class:"header-anchor",href:"#singleton"},"#")],-1),Z=e("p",null,"If your collection is a singleton, this endpoint will return the item. If the item doesn\u2019t exist in the database, the default values will be returned.",-1),$={class:"right"},ee=e("h3",{id:"rest-api"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),te=e("pre",null,[e("code",null,`GET /items/:collection
+`)])])],-1),D=e("hr",null,null,-1),A=e("h2",{id:"get-items"},[t("Get Items "),e("a",{class:"header-anchor",href:"#get-items"},"#")],-1),k=e("p",null,"List all items that exist in Directus.",-1),C={class:"two-up"},G={class:"left"},Q=e("h3",{id:"query-parameters"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),L=t("Supports all "),O=t("global query parameters"),H=t("."),M={class:"tip hint"},B=e("div",{class:"hint-title"},"Relational Data",-1),U=t("The "),F=t("Field Parameter"),N=t(" is required to return nested relational data."),V=e("h3",{id:"returns"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),z=t("An array of up to "),J=t("limit"),K=t(),W=e("a",{href:"#the-item-object"},"item objects",-1),X=t(". If no items are available, data will be an empty array."),Y=e("h4",{id:"singleton"},[t("Singleton "),e("a",{class:"header-anchor",href:"#singleton"},"#")],-1),Z=e("p",null,"If your collection is a singleton, this endpoint will return the item. If the item doesn\u2019t exist in the database, the default values will be returned.",-1),$={class:"right"},ee=e("h3",{id:"rest-api"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),te=e("pre",null,[e("code",{class:""},`GET /items/:collection
 SEARCH /items/:collection
-`)],-1),se=t("Learn more about SEARCH ->"),ae=e("h5",{id:"example"},[t("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),le=e("pre",null,[e("code",null,`GET /items/articles
-`)],-1),ne=e("h3",{id:"graphql"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),re=e("pre",null,[e("code",null,`POST /graphql
+`)],-1),se=t("Learn more about SEARCH ->"),ae=e("h5",{id:"example"},[t("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),le=e("pre",null,[e("code",{class:""},`GET /items/articles
+`)],-1),ne=e("h3",{id:"graphql"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),re=e("pre",null,[e("code",{class:""},`POST /graphql
 `)],-1),oe=e("pre",null,[e("code",{class:"language-graphql"},`type Query {
 	<collection>: [<collection>]
 }
-`)],-1),ie=e("h5",{id:"example-2"},[t("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")],-1),ce=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),t(` {
+`)],-1),ce=e("h5",{id:"example-2"},[t("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")],-1),ie=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),t(` {
 	articles {
 		id
 		title
@@ -22,9 +22,9 @@ SEARCH /items/:collection
 		}
 	}
 }
-`)])],-1),he=e("hr",null,null,-1),de=e("h2",{id:"get-item-by-id"},[t("Get Item by ID "),e("a",{class:"header-anchor",href:"#get-item-by-id"},"#")],-1),ue=e("p",null,"Get an item that exists in Directus.",-1),pe={class:"two-up"},_e={class:"left"},me=e("h3",{id:"query-parameters-2"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),fe=t("Supports all "),ge=t("global query parameters"),ye=t("."),be=e("h3",{id:"returns-2"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),je=e("p",null,[t("Returns an "),e("a",{href:"#the-item-object"},"item object"),t(" if a valid primary key was provided.")],-1),qe=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /items/:collection/:id
-`)]),e("h5",{id:"example-3"},[t("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",null,`GET /items/articles/15
-`)]),e("h3",{id:"graphql-2"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql
+`)])],-1),he=e("hr",null,null,-1),de=e("h2",{id:"get-item-by-id"},[t("Get Item by ID "),e("a",{class:"header-anchor",href:"#get-item-by-id"},"#")],-1),pe=e("p",null,"Get an item that exists in Directus.",-1),ue={class:"two-up"},_e={class:"left"},me=e("h3",{id:"query-parameters-2"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),fe=t("Supports all "),ge=t("global query parameters"),ye=t("."),be=e("h3",{id:"returns-2"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),je=e("p",null,[t("Returns an "),e("a",{href:"#the-item-object"},"item object"),t(" if a valid primary key was provided.")],-1),qe=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",{class:""},`GET /items/:collection/:id
+`)]),e("h5",{id:"example-3"},[t("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:""},`GET /items/articles/15
+`)]),e("h3",{id:"graphql-2"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql
 `)]),e("pre",null,[e("code",{class:"language-graphql"},`type Query {
 	<collection>_by_id(id: ID!): <collection>
 }
@@ -34,13 +34,13 @@ SEARCH /items/:collection
 		title
 	}
 }
-`)])])],-1),xe=e("hr",null,null,-1),ve=e("h2",{id:"create-an-item"},[t("Create an Item "),e("a",{class:"header-anchor",href:"#create-an-item"},"#")],-1),Ee=e("p",null,"Create a new item in the given collection.",-1),Te={class:"two-up"},we={class:"left"},Ie=e("h3",{id:"query-parameters-3"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Pe=t("Supports all "),Re=t("global query parameters"),Se=t("."),De=e("h3",{id:"request-body"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ae=e("p",null,[t("An array of partial "),e("a",{href:"#the-item-object"},"item objects"),t(".")],-1),ke={class:"tip hint"},Ce=e("div",{class:"hint-title"},"Relational Data",-1),Ge=t("Relational data needs to be correctly nested to add new items successfully. Check out the "),Qe=t("relational data section"),Le=t(" for more information."),Oe=e("h3",{id:"returns-3"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),He=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item objects"),t(" of the item that were created.")],-1),Me=e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /items/:collection
-`)]),e("h5",{id:"example-5"},[t("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",null,`POST /items/articles
+`)])])],-1),xe=e("hr",null,null,-1),ve=e("h2",{id:"create-an-item"},[t("Create an Item "),e("a",{class:"header-anchor",href:"#create-an-item"},"#")],-1),we=e("p",null,"Create a new item in the given collection.",-1),Ee={class:"two-up"},Te={class:"left"},Ie=e("h3",{id:"query-parameters-3"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Pe=t("Supports all "),Re=t("global query parameters"),Se=t("."),De=e("h3",{id:"request-body"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ae=e("p",null,[t("An array of partial "),e("a",{href:"#the-item-object"},"item objects"),t(".")],-1),ke={class:"tip hint"},Ce=e("div",{class:"hint-title"},"Relational Data",-1),Ge=t("Relational data needs to be correctly nested to add new items successfully. Check out the "),Qe=t("relational data section"),Le=t(" for more information."),Oe=e("h3",{id:"returns-3"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),He=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item objects"),t(" of the item that were created.")],-1),Me=e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",{class:""},`POST /items/:collection
+`)]),e("h5",{id:"example-5"},[t("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:""},`POST /items/articles
 `)]),e("pre",null,[e("code",{class:"language-json"},[t(`{
 	`),e("span",{class:"hljs-attr"},'"title"'),t(": "),e("span",{class:"hljs-string"},'"Hello world!"'),t(`,
 	`),e("span",{class:"hljs-attr"},'"body"'),t(": "),e("span",{class:"hljs-string"},'"This is our first article"'),t(`
 }
-`)])]),e("h3",{id:"graphql-3"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql
+`)])]),e("h3",{id:"graphql-3"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql
 `)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
 	create_<collection>_item(data: create_<collection>_input): <collection>
 }
@@ -50,8 +50,8 @@ SEARCH /items/:collection
 		title
 	}
 }
-`)])])],-1),Be=e("hr",null,null,-1),Ue=e("h2",{id:"create-multiple-items"},[t("Create Multiple Items "),e("a",{class:"header-anchor",href:"#create-multiple-items"},"#")],-1),Fe=e("p",null,"Create new items in the given collection.",-1),Ne={class:"two-up"},Ve={class:"left"},We=e("h3",{id:"query-parameters-4"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),ze=t("Supports all "),Je=t("global query parameters"),Ke=t("."),Xe=e("h3",{id:"request-body-2"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Ye=e("p",null,[t("An array of partial "),e("a",{href:"#the-item-object"},"item objects"),t(".")],-1),Ze=e("h3",{id:"returns-4"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),$e=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item objects"),t(" of the item that were created.")],-1),et=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`POST /items/:collection
-`)]),e("h5",{id:"example-7"},[t("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",null,`POST /items/articles
+`)])])],-1),Be=e("hr",null,null,-1),Ue=e("h2",{id:"create-multiple-items"},[t("Create Multiple Items "),e("a",{class:"header-anchor",href:"#create-multiple-items"},"#")],-1),Fe=e("p",null,"Create new items in the given collection.",-1),Ne={class:"two-up"},Ve={class:"left"},ze=e("h3",{id:"query-parameters-4"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Je=t("Supports all "),Ke=t("global query parameters"),We=t("."),Xe=e("h3",{id:"request-body-2"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Ye=e("p",null,[t("An array of partial "),e("a",{href:"#the-item-object"},"item objects"),t(".")],-1),Ze=e("h3",{id:"returns-4"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),$e=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item objects"),t(" of the item that were created.")],-1),et=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",{class:""},`POST /items/:collection
+`)]),e("h5",{id:"example-7"},[t("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:""},`POST /items/articles
 `)]),e("pre",null,[e("code",{class:"language-json"},[t(`[
 	{
 		`),e("span",{class:"hljs-attr"},'"title"'),t(": "),e("span",{class:"hljs-string"},'"Hello world!"'),t(`,
@@ -62,7 +62,7 @@ SEARCH /items/:collection
 		`),e("span",{class:"hljs-attr"},'"body"'),t(": "),e("span",{class:"hljs-string"},'"This is our second article"'),t(`
 	}
 ]
-`)])]),e("h3",{id:"graphql-4"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql
+`)])]),e("h3",{id:"graphql-4"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql
 `)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
 	create_<collection>_items(data: [create_<collection>_input]): [<collection>]
 }
@@ -77,12 +77,12 @@ SEARCH /items/:collection
 		title
 	}
 }
-`)])])],-1),tt=e("hr",null,null,-1),st=e("h2",{id:"update-an-item"},[t("Update an Item "),e("a",{class:"header-anchor",href:"#update-an-item"},"#")],-1),at=e("p",null,"Update an existing item.",-1),lt={class:"two-up"},nt={class:"left"},rt=e("h3",{id:"query-parameters-5"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ot=t("Supports all "),it=t("global query parameters"),ct=t("."),ht=e("h3",{id:"request-body-3"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),dt=e("p",null,[t("A partial "),e("a",{href:"#the-item-object"},"item object"),t(".")],-1),ut=e("h3",{id:"returns-5"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),pt=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item object"),t(" of the item that was updated.")],-1),_t=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /items/:collection/:id
-`)]),e("h5",{id:"example-9"},[t("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",null,`PATCH /items/articles/15
+`)])])],-1),tt=e("hr",null,null,-1),st=e("h2",{id:"update-an-item"},[t("Update an Item "),e("a",{class:"header-anchor",href:"#update-an-item"},"#")],-1),at=e("p",null,"Update an existing item.",-1),lt={class:"two-up"},nt={class:"left"},rt=e("h3",{id:"query-parameters-5"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ot=t("Supports all "),ct=t("global query parameters"),it=t("."),ht=e("h3",{id:"request-body-3"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),dt=e("p",null,[t("A partial "),e("a",{href:"#the-item-object"},"item object"),t(".")],-1),pt=e("h3",{id:"returns-5"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),ut=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item object"),t(" of the item that was updated.")],-1),_t=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",{class:""},`PATCH /items/:collection/:id
+`)]),e("h5",{id:"example-9"},[t("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:""},`PATCH /items/articles/15
 `)]),e("pre",null,[e("code",{class:"language-json"},[t(`{
 	`),e("span",{class:"hljs-attr"},'"title"'),t(": "),e("span",{class:"hljs-string"},'"An updated title"'),t(`
 }
-`)])]),e("h3",{id:"graphql-5"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql
+`)])]),e("h3",{id:"graphql-5"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql
 `)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
 	update_<collection>_item(id: ID!, data: update_<collection>_input!): <collection>
 }
@@ -92,15 +92,15 @@ SEARCH /items/:collection
 		title
 	}
 }
-`)])])],-1),mt=e("hr",null,null,-1),ft=e("h2",{id:"update-multiple-items"},[t("Update Multiple Items "),e("a",{class:"header-anchor",href:"#update-multiple-items"},"#")],-1),gt=e("p",null,"Update multiple items at the same time.",-1),yt={class:"two-up"},bt={class:"left"},jt=e("h3",{id:"query-parameters-6"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),qt=t("Supports all "),xt=t("global query parameters"),vt=t("."),Et=e("h3",{id:"request-body-4"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Tt=e("p",null,[t("Object containing "),e("code",null,"data"),t(" for the values to set, and either "),e("code",null,"keys"),t(" or "),e("code",null,"query"),t(" to select what items to update.")],-1),wt=e("h3",{id:"returns-6"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),It=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item objects"),t(" for the updated items.")],-1),Pt=e("h4",{id:"singleton-2"},[t("Singleton "),e("a",{class:"header-anchor",href:"#singleton-2"},"#")],-1),Rt=e("p",null,[t("If your collection is a singleton, this endpoint will act the same as the "),e("a",{href:"#update-an-item"},"Update an Item"),t(" endpoint.")],-1),St=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`PATCH /items/:collection
-`)]),e("h5",{id:"example-11"},[t("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",null,`PATCH /items/articles
+`)])])],-1),mt=e("hr",null,null,-1),ft=e("h2",{id:"update-multiple-items"},[t("Update Multiple Items "),e("a",{class:"header-anchor",href:"#update-multiple-items"},"#")],-1),gt=e("p",null,"Update multiple items at the same time.",-1),yt={class:"two-up"},bt={class:"left"},jt=e("h3",{id:"query-parameters-6"},[t("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),qt=t("Supports all "),xt=t("global query parameters"),vt=t("."),wt=e("h3",{id:"request-body-4"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Et=e("p",null,[t("Object containing "),e("code",{class:""},"data"),t(" for the values to set, and either "),e("code",{class:""},"keys"),t(" or "),e("code",{class:""},"query"),t(" to select what items to update.")],-1),Tt=e("h3",{id:"returns-6"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),It=e("p",null,[t("Returns the "),e("a",{href:"#the-item-object"},"item objects"),t(" for the updated items.")],-1),Pt=e("h4",{id:"singleton-2"},[t("Singleton "),e("a",{class:"header-anchor",href:"#singleton-2"},"#")],-1),Rt=e("p",null,[t("If your collection is a singleton, this endpoint will act the same as the "),e("a",{href:"#update-an-item"},"Update an Item"),t(" endpoint.")],-1),St=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",{class:""},`PATCH /items/:collection
+`)]),e("h5",{id:"example-11"},[t("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",{class:""},`PATCH /items/articles
 `)]),e("pre",null,[e("code",{class:"language-json"},[t(`{
 	`),e("span",{class:"hljs-attr"},'"keys"'),t(": ["),e("span",{class:"hljs-number"},"1"),t(", "),e("span",{class:"hljs-number"},"2"),t(`],
 	`),e("span",{class:"hljs-attr"},'"data"'),t(`: {
 		`),e("span",{class:"hljs-attr"},'"status"'),t(": "),e("span",{class:"hljs-string"},'"published"'),t(`
 	}
 }
-`)])]),e("h3",{id:"graphql-6"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",null,`POST /graphql
+`)])]),e("h3",{id:"graphql-6"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql
 `)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
 	update_<collection>_items(ids: [ID!]!, data: [update_<collection>_input]): [<collection>]
 }
@@ -110,9 +110,9 @@ SEARCH /items/:collection
 		status
 	}
 }
-`)])])],-1),Dt=e("hr",null,null,-1),At=e("h2",{id:"delete-an-item"},[t("Delete an Item "),e("a",{class:"header-anchor",href:"#delete-an-item"},"#")],-1),kt=e("p",null,"Delete an existing item.",-1),Ct=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"returns-7"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /items/:collection/:id
-`)]),e("h5",{id:"example-13"},[t("Example "),e("a",{class:"header-anchor",href:"#example-13"},"#")]),e("pre",null,[e("code",null,`DELETE /items/articles/15
-`)]),e("h3",{id:"graphql-7"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",null,`POST /graphql
+`)])])],-1),Dt=e("hr",null,null,-1),At=e("h2",{id:"delete-an-item"},[t("Delete an Item "),e("a",{class:"header-anchor",href:"#delete-an-item"},"#")],-1),kt=e("p",null,"Delete an existing item.",-1),Ct=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"returns-7"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",{class:""},`DELETE /items/:collection/:id
+`)]),e("h5",{id:"example-13"},[t("Example "),e("a",{class:"header-anchor",href:"#example-13"},"#")]),e("pre",null,[e("code",{class:""},`DELETE /items/articles/15
+`)]),e("h3",{id:"graphql-7"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql
 `)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
 	delete_<collection>_item(id: ID!): delete_one
 }
@@ -121,10 +121,10 @@ SEARCH /items/:collection
 		id
 	}
 }
-`)])])])],-1),Gt=e("hr",null,null,-1),Qt=e("h2",{id:"delete-multiple-items"},[t("Delete Multiple Items "),e("a",{class:"header-anchor",href:"#delete-multiple-items"},"#")],-1),Lt=e("p",null,"Delete multiple existing items.",-1),Ot=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-5"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("p",null,"An array of item primary keys."),e("h3",{id:"returns-8"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",null,`DELETE /items/:collection
-`)]),e("h5",{id:"example-15"},[t("Example "),e("a",{class:"header-anchor",href:"#example-15"},"#")]),e("pre",null,[e("code",null,`DELETE /items/articles
+`)])])])],-1),Gt=e("hr",null,null,-1),Qt=e("h2",{id:"delete-multiple-items"},[t("Delete Multiple Items "),e("a",{class:"header-anchor",href:"#delete-multiple-items"},"#")],-1),Lt=e("p",null,"Delete multiple existing items.",-1),Ot=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-5"},[t("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("p",null,"An array of item primary keys."),e("h3",{id:"returns-8"},[t("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[t("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",{class:""},`DELETE /items/:collection
+`)]),e("h5",{id:"example-15"},[t("Example "),e("a",{class:"header-anchor",href:"#example-15"},"#")]),e("pre",null,[e("code",{class:""},`DELETE /items/articles
 `)]),e("pre",null,[e("code",{class:"language-json"},[t("["),e("span",{class:"hljs-number"},"15"),t(", "),e("span",{class:"hljs-number"},"16"),t(", "),e("span",{class:"hljs-number"},"21"),t(`]
-`)])]),e("h3",{id:"graphql-8"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-8"},"#")]),e("pre",null,[e("code",null,`POST /graphql
+`)])]),e("h3",{id:"graphql-8"},[t("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-8"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql
 `)]),e("pre",null,[e("code",{class:"language-graphql"},`type Mutation {
 	delete_<collection>_items(ids: [ID!]!): delete_many
 }
@@ -133,4 +133,4 @@ SEARCH /items/:collection
 		ids
 	}
 }
-`)])])])],-1),Ft={setup(Ht,{expose:o}){const n={title:"Accessing Items",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:n}),(Mt,Bt)=>{const a=r("router-link"),i=r("DocsWrapper");return c(),h(i,{frontmatter:n},{default:s(()=>[e("div",d,[e("div",u,[e("div",p,[e("blockquote",null,[e("p",null,[_,l(a,{to:"/docs/getting-started/glossary/#items"},{default:s(()=>[m]),_:1}),f])])]),g]),y,b,e("div",j,[e("div",q,[x,e("div",v,[E,e("p",null,[T,l(a,{to:"/docs/reference/introduction/#relational-data"},{default:s(()=>[w]),_:1}),I,l(a,{to:"/docs/reference/query/#fields"},{default:s(()=>[P]),_:1}),R])])]),S]),D,A,k,e("div",C,[e("div",G,[Q,e("p",null,[L,l(a,{to:"/docs/reference/query"},{default:s(()=>[O]),_:1}),H]),e("div",M,[B,e("p",null,[U,l(a,{to:"/docs/reference/query/#fields"},{default:s(()=>[F]),_:1}),N])]),V,e("p",null,[W,l(a,{to:"/docs/reference/query/#limit"},{default:s(()=>[z]),_:1}),J,K,X]),Y,Z]),e("div",$,[ee,te,e("p",null,[l(a,{to:"/docs/reference/introduction/#search-http-method"},{default:s(()=>[se]),_:1})]),ae,le,ne,re,oe,ie,ce])]),he,de,ue,e("div",pe,[e("div",_e,[me,e("p",null,[fe,l(a,{to:"/docs/reference/query"},{default:s(()=>[ge]),_:1}),ye]),be,je]),qe]),xe,ve,Ee,e("div",Te,[e("div",we,[Ie,e("p",null,[Pe,l(a,{to:"/docs/reference/query"},{default:s(()=>[Re]),_:1}),Se]),De,Ae,e("div",ke,[Ce,e("p",null,[Ge,l(a,{to:"/docs/reference/introduction/#relational-data"},{default:s(()=>[Qe]),_:1}),Le])]),Oe,He]),Me]),Be,Ue,Fe,e("div",Ne,[e("div",Ve,[We,e("p",null,[ze,l(a,{to:"/docs/reference/query"},{default:s(()=>[Je]),_:1}),Ke]),Xe,Ye,Ze,$e]),et]),tt,st,at,e("div",lt,[e("div",nt,[rt,e("p",null,[ot,l(a,{to:"/docs/reference/query"},{default:s(()=>[it]),_:1}),ct]),ht,dt,ut,pt]),_t]),mt,ft,gt,e("div",yt,[e("div",bt,[jt,e("p",null,[qt,l(a,{to:"/docs/reference/query"},{default:s(()=>[xt]),_:1}),vt]),Et,Tt,wt,It,Pt,Rt]),St]),Dt,At,kt,Ct,Gt,Qt,Lt,Ot])]),_:1})}}};export{Ft as default};
+`)])])])],-1),Ht={title:"Accessing Items",modularExtension:!1,pageClass:"page-reference"},Mt={name:"items",setup(Bt,{expose:o}){return o({frontmatter:{title:"Accessing Items",modularExtension:!1,pageClass:"page-reference"}}),(Ut,Ft)=>{const a=n("router-link"),c=n("docswrapper");return i(),h(c,{frontmatter:Ht},{default:s(()=>[e("div",d,[e("div",p,[e("div",u,[e("blockquote",null,[e("p",null,[_,l(a,{to:"/docs/getting-started/glossary/#items"},{default:s(()=>[m]),_:1}),f])])]),g]),y,b,e("div",j,[e("div",q,[x,e("div",v,[w,e("p",null,[E,l(a,{to:"/docs/reference/introduction/#relational-data"},{default:s(()=>[T]),_:1}),I,l(a,{to:"/docs/reference/query/#fields"},{default:s(()=>[P]),_:1}),R])])]),S]),D,A,k,e("div",C,[e("div",G,[Q,e("p",null,[L,l(a,{to:"/docs/reference/query"},{default:s(()=>[O]),_:1}),H]),e("div",M,[B,e("p",null,[U,l(a,{to:"/docs/reference/query/#fields"},{default:s(()=>[F]),_:1}),N])]),V,e("p",null,[z,l(a,{to:"/docs/reference/query/#limit"},{default:s(()=>[J]),_:1}),K,W,X]),Y,Z]),e("div",$,[ee,te,e("p",null,[l(a,{to:"/docs/reference/introduction/#search-http-method"},{default:s(()=>[se]),_:1})]),ae,le,ne,re,oe,ce,ie])]),he,de,pe,e("div",ue,[e("div",_e,[me,e("p",null,[fe,l(a,{to:"/docs/reference/query"},{default:s(()=>[ge]),_:1}),ye]),be,je]),qe]),xe,ve,we,e("div",Ee,[e("div",Te,[Ie,e("p",null,[Pe,l(a,{to:"/docs/reference/query"},{default:s(()=>[Re]),_:1}),Se]),De,Ae,e("div",ke,[Ce,e("p",null,[Ge,l(a,{to:"/docs/reference/introduction/#relational-data"},{default:s(()=>[Qe]),_:1}),Le])]),Oe,He]),Me]),Be,Ue,Fe,e("div",Ne,[e("div",Ve,[ze,e("p",null,[Je,l(a,{to:"/docs/reference/query"},{default:s(()=>[Ke]),_:1}),We]),Xe,Ye,Ze,$e]),et]),tt,st,at,e("div",lt,[e("div",nt,[rt,e("p",null,[ot,l(a,{to:"/docs/reference/query"},{default:s(()=>[ct]),_:1}),it]),ht,dt,pt,ut]),_t]),mt,ft,gt,e("div",yt,[e("div",bt,[jt,e("p",null,[qt,l(a,{to:"/docs/reference/query"},{default:s(()=>[xt]),_:1}),vt]),wt,Et,Tt,It,Pt,Rt]),St]),Dt,At,kt,Ct,Gt,Qt,Lt,Ot])]),_:1})}}};typeof r=="function"&&r(Mt);export{Mt as default,Ht as frontmatter};

package/dist/assets/items.64ed9295.js

@@ -0,0 +1 @@
+import{a as l,o as d,b as r,w as n,g as e,e as o,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var s={};const h={class:"markdown-body"},m=e("blockquote",null,[e("p",null,"The Item Page is a tailored form for managing Items and their Field values. This page also includes options for archiving, reverting, and commenting on the Item.")],-1),u=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#create-an-item"},"Create an Item")]),e("li",null,[e("a",{href:"#edit-an-item"},"Edit an Item")]),e("li",null,[e("a",{href:"#archive-an-item"},"Archive an Item")]),e("li",null,[e("a",{href:"#revert-an-item"},"Revert an Item")]),e("li",null,[e("a",{href:"#comment-on-an-item"},"Comment on an Item")]),e("li",null,[e("a",{href:"#delete-an-item"},"Delete an Item")])])])],-1),p={class:"tip hint"},_=e("div",{class:"hint-title"},"Programmatically Manage Items",-1),v=t("This page shows you how to manage Items within the no-code app. However, Items can also be "),g=t("managed"),f=t(" programmatically via the API."),I=e("h2",{id:"create-an-item"},[t("Create an Item "),e("a",{class:"header-anchor",href:"#create-an-item"},"#")],-1),w=e("video",{title:"Create an Item",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-items/content-items-20220415A/create-an-item-20220415A.mp4",type:"video/mp4"})],-1),C=e("p",null,"To create an Item, follow the steps below.",-1),y=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"add"),t(" in the Page Header and the Item Page will open.")]),e("li",null,"Fill in Item details as desired."),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"check"),t(" in the Page Header.")])],-1),b=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Singletons"),e("p",null,"If the Collection is configured as a Singleton in the data model settings, then the App will skip step two above and automatically open the Item Page.")],-1),k=e("h2",{id:"edit-an-item"},[t("Edit an Item "),e("a",{class:"header-anchor",href:"#edit-an-item"},"#")],-1),A=e("video",{title:"Edit an Item",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-items/content-items-20220415A/edit-an-item-20220415A.mp4",type:"video/mp4"})],-1),P=e("p",null,"To edit an Item\u2019s Field Values, follow the steps below.",-1),S=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,"Click on the desired Item. The Item Page will open."),e("li",null,"Update Item details as desired."),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"check"),t(" in the header.")])],-1),T=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Other Save Options"),e("p",null,[t("To the right of the primary Save button, there is a "),e("span",{mi:"",icon:""},"more_vert"),t(" menu which contains the following alternate save options:")]),e("p",null,[e("span",{mi:"",icon:""},"check"),t(" Save and Stay (\u2318S)"),e("br"),e("span",{mi:"",icon:""},"add"),t(" Save and Create New (\u2318\u21E7S)"),e("br"),e("span",{mi:"",icon:""},"done_all"),t(" Save as Copy"),e("br"),e("span",{mi:"",icon:""},"undo"),t(" Discard all Changes")])],-1),M=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Singletons"),e("p",null,"If the Collection is configured as a \u201CSingleton\u201D in Data Model Settings, then the App will skip step two above and automatically open the Item Page.")],-1),N=e("h2",{id:"archive-an-item"},[t("Archive an Item "),e("a",{class:"header-anchor",href:"#archive-an-item"},"#")],-1),R=e("video",{title:"Archive an Item",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-items/content-items-20220415A/archive-an-item-20220415A.mp4",type:"video/mp4"})],-1),x=t("To archive an Item, follow the steps below. "),D=t("Learn More"),E=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,"Select the desired Item. The Item Page will open."),e("li",null,[t("Click "),e("span",{mi:"",btn:"",warn:""},"archive"),t(" located in the header and a popup will appear.")]),e("li",null,[t("Click "),e("strong",null,"\u201CArchive\u201D"),t(" to confirm the action.")])],-1),F=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Requires Configuration"),e("p",null,"Requires an archive Field to be configured within the Collection\u2019s data model settings.")],-1),V=e("h2",{id:"revert-an-item"},[t("Revert an Item "),e("a",{class:"header-anchor",href:"#revert-an-item"},"#")],-1),B=e("video",{title:"Revert an Item",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-items/content-items-20220415A/revert-an-item-20220415A.mp4",type:"video/mp4"})],-1),H=t("As you update Field Values on Items, Directus saves these "),q=t("Revisions"),O=t(", and they can be compared side-by-side to the current state. To revert an Item, follow the steps below."),U=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,"Select the desired Item. The Item Page will open."),e("li",null,[t("Click "),e("strong",null,"\u201CRevisions\u201D"),t(" in the page sidebar.")]),e("li",null,"Click on the revision you wish to preview and a side menu will appear."),e("li",null,[t("Go to "),e("strong",null,"\u201CRevisions Made\u201D"),t(" in the side menu and view the revision differences.")]),e("li",null,[t("Click "),e("span",{mi:"",btn:"",muted:""},"restore"),t(" to revert the Item\u2019s values and return to the Item Page.")]),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"check"),t(" to confirm and exit to the Collection Page.")])],-1),Y=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Revision Preview"),e("p",null,[t("You will also see a "),e("strong",null,"\u201CRevision Preview\u201D"),t(" button in the side menu navigation, which will let you preview all the Item\u2019s values for that revision.")])],-1),z={class:"tip hint"},G=t("Items can also be reverted "),L=t("programmatically via the API"),j=t("."),J=e("h2",{id:"comment-on-an-item"},[t("Comment on an Item "),e("a",{class:"header-anchor",href:"#comment-on-an-item"},"#")],-1),K=e("video",{title:"Comment on an Item",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-items/content-items-20220415A/comment-on-an-item-20220415A.mp4",type:"video/mp4"})],-1),Q=e("p",null,"Comments, a collaborative tool, are left on an Item in the sidebar and remain there for you and other team-members to refer to. To create a comment, follow the steps below.",-1),W=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,"Select the desired Item. The Item Page will open."),e("li",null,[t("Click "),e("strong",null,"\u201CComments\u201D"),t(" in the page sidebar.")]),e("li",null,"Type your message into the input box."),e("li",null,[t("Click the "),e("strong",null,"\u201CSubmit\u201D"),t(" button.")])],-1),X=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Mentions"),e("p",null,[t("You can also search and mention any User by typing the "),e("strong",null,"\u201C@\u201D"),t(" symbol along with their name or email to send an in-app notification as well as an email directing to your comment.")])],-1),Z=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Edit and Delete Comments"),e("p",null,[t("Each comment displays the time it was created in its upper right-hand corner. Hover over this and the "),e("span",{mi:"",icon:""},"more_horiz"),t(" menu will appear. Click this menu to "),e("span",{mi:"",icon:""},"edit"),t(" edit or "),e("span",{mi:"",icon:""},"delete"),t(" delete the comment.")])],-1),$=e("h2",{id:"delete-an-item"},[t("Delete an Item "),e("a",{class:"header-anchor",href:"#delete-an-item"},"#")],-1),ee=e("video",{title:"Comment on an Item",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-items/content-items-20220415A/delete-an-item-20220415A.mp4",type:"video/mp4"})],-1),te=e("p",null,"To delete an Item, follow the steps below.",-1),ne=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,"Select the desired Item. The Item Page will open."),e("li",null,[t("Click "),e("span",{mi:"",btn:"",dngr:""},"delete"),t(" located in the header and a popup will appear.")]),e("li",null,[t("Click "),e("strong",null,"\u201CDelete\u201D"),t(" to confirm the action.")])],-1),ie=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Soft-Delete"),e("p",null,[t("If you wish to remove an Item from view or use without fully deleting it, you may consider "),e("a",{href:"#archive-an-item"},"archiving the Item"),t(" instead.")])],-1),oe={title:"Item Page",modularExtension:!1},le={name:"items",setup(se,{expose:a}){return a({frontmatter:{title:"Item Page",modularExtension:!1}}),(ae,ce)=>{const i=l("router-link"),c=l("docswrapper");return d(),r(c,{frontmatter:oe},{default:n(()=>[e("div",h,[m,u,e("div",p,[_,e("p",null,[v,o(i,{to:"/docs/reference/items/"},{default:n(()=>[g]),_:1}),f])]),I,w,C,y,b,k,A,P,S,T,M,N,R,e("p",null,[x,o(i,{to:"/docs/configuration/data-model/#archive"},{default:n(()=>[D]),_:1})]),E,F,V,B,e("p",null,[H,o(i,{to:"/docs/getting-started/glossary/#revisions"},{default:n(()=>[q]),_:1}),O]),U,Y,e("div",z,[e("p",null,[G,o(i,{to:"/docs/reference/system/revisions/"},{default:n(()=>[L]),_:1}),j])]),J,K,Q,W,X,Z,$,ee,te,ne,ie])]),_:1})}}};typeof s=="function"&&s(le);export{le as default,oe as frontmatter};

package/dist/assets/javascript-hint.29e9b67f.js

@@ -0,0 +1 @@
+import{A as N}from"./index.70f6f88a.entry.js";function T(d,m){return m.forEach(function(l){l&&typeof l!="string"&&!Array.isArray(l)&&Object.keys(l).forEach(function(p){if(p!=="default"&&!(p in d)){var y=Object.getOwnPropertyDescriptor(l,p);Object.defineProperty(d,p,y.get?y:{enumerable:!0,get:function(){return l[p]}})}})}),Object.freeze(Object.defineProperty(d,Symbol.toStringTag,{value:"Module"}))}var O={exports:{}};(function(d,m){(function(l){l(N.exports)})(function(l){var p=l.Pos;function y(e,n){for(var t=0,r=e.length;t<r;++t)n(e[t])}function x(e,n){if(!Array.prototype.indexOf){for(var t=e.length;t--;)if(e[t]===n)return!0;return!1}return e.indexOf(n)!=-1}function w(e,n,t,r){var s=e.getCursor(),i=t(e,s);if(!/\b(?:string|comment)\b/.test(i.type)){var c=l.innerMode(e.getMode(),i.state);if(c.mode.helperType!=="json"){i.state=c.state,/^[\w$_]*$/.test(i.string)?i.end>s.ch&&(i.end=s.ch,i.string=i.string.slice(0,s.ch-i.start)):i={start:s.ch,end:s.ch,string:"",state:i.state,type:i.string=="."?"property":null};for(var a=i;a.type=="property";){if(a=t(e,p(s.line,a.start)),a.string!=".")return;if(a=t(e,p(s.line,a.start)),!h)var h=[];h.push(a)}return{list:Q(i,h,n,r),from:p(s.line,i.start),to:p(s.line,i.end)}}}}function P(e,n){return w(e,$,function(t,r){return t.getTokenAt(r)},n)}l.registerHelper("hint","javascript",P);function A(e,n){var t=e.getTokenAt(n);return n.ch==t.start+1&&t.string.charAt(0)=="."?(t.end=t.start,t.string=".",t.type="property"):/^\.[\w$_]*$/.test(t.string)&&(t.type="property",t.start++,t.string=t.string.replace(/\./,"")),t}function _(e,n){return w(e,S,A,n)}l.registerHelper("hint","coffeescript",_);var j="charAt charCodeAt indexOf lastIndexOf substring substr slice trim trimLeft trimRight toUpperCase toLowerCase split concat match replace search".split(" "),C="length concat join splice push pop shift unshift slice reverse sort indexOf lastIndexOf every some filter forEach map reduce reduceRight ".split(" "),H="prototype apply call bind".split(" "),$="break case catch class const continue debugger default delete do else export extends false finally for function if in import instanceof new null return super switch this throw true try typeof var void while with yield".split(" "),S="and break catch class continue delete do else extends false finally for if in instanceof isnt new no not null of off on or return switch then throw true try typeof until void while with yes".split(" ");function E(e,n){if(!Object.getOwnPropertyNames||!Object.getPrototypeOf)for(var t in e)n(t);else for(var r=e;r;r=Object.getPrototypeOf(r))Object.getOwnPropertyNames(r).forEach(n)}function Q(e,n,t,r){var s=[],i=e.string,c=r&&r.globalScope||window;function a(g){g.lastIndexOf(i,0)==0&&!x(s,g)&&s.push(g)}function h(g){typeof g=="string"?y(j,a):g instanceof Array?y(C,a):g instanceof Function&&y(H,a),E(g,a)}if(n&&n.length){var u=n.pop(),o;for(u.type&&u.type.indexOf("variable")===0?(r&&r.additionalContext&&(o=r.additionalContext[u.string]),(!r||r.useGlobalScope!==!1)&&(o=o||c[u.string])):u.type=="string"?o="":u.type=="atom"?o=1:u.type=="function"&&(c.jQuery!=null&&(u.string=="$"||u.string=="jQuery")&&typeof c.jQuery=="function"?o=c.jQuery():c._!=null&&u.string=="_"&&typeof c._=="function"&&(o=c._()));o!=null&&n.length;)o=o[n.pop().string];o!=null&&h(o)}else{for(var f=e.state.localVars;f;f=f.next)a(f.name);for(var v=e.state.context;v;v=v.prev)for(var f=v.vars;f;f=f.next)a(f.name);for(var f=e.state.globalVars;f;f=f.next)a(f.name);if(r&&r.additionalContext!=null)for(var I in r.additionalContext)a(I);(!r||r.useGlobalScope!==!1)&&h(c),y(t,a)}return s}})})();var G=O.exports,L=T({__proto__:null,default:G},[O.exports]);export{L as j};

package/dist/assets/javascript.d2db845f.js

@@ -0,0 +1 @@
+import{A as he}from"./index.70f6f88a.entry.js";function xe(Y,hr){return hr.forEach(function(k){k&&typeof k!="string"&&!Array.isArray(k)&&Object.keys(k).forEach(function(_){if(_!=="default"&&!(_ in Y)){var v=Object.getOwnPropertyDescriptor(k,_);Object.defineProperty(Y,_,v.get?v:{enumerable:!0,get:function(){return k[_]}})}})}),Object.freeze(Object.defineProperty(Y,Symbol.toStringTag,{value:"Module"}))}var Fr={exports:{}};(function(Y,hr){(function(k){k(he.exports)})(function(k){k.defineMode("javascript",function(_,v){var N=_.indentUnit,xr=v.statementIndent,Z=v.jsonld,z=v.json||Z,vr=v.trackScope!==!1,p=v.typescript,C=v.wordCharacters||/[\w$\xa1-\uffff]/,gr=function(){function r(g){return{type:g,style:"keyword"}}var e=r("keyword a"),t=r("keyword b"),f=r("keyword c"),u=r("keyword d"),l=r("operator"),m={type:"atom",style:"atom"};return{if:r("if"),while:e,with:e,else:t,do:t,try:t,finally:t,return:u,break:u,continue:u,new:r("new"),delete:f,void:f,throw:f,debugger:r("debugger"),var:r("var"),const:r("var"),let:r("var"),function:r("function"),catch:r("catch"),for:r("for"),switch:r("switch"),case:r("case"),default:r("default"),in:l,typeof:l,instanceof:l,true:m,false:m,null:m,undefined:m,NaN:m,Infinity:m,this:r("this"),class:r("class"),super:r("atom"),yield:f,export:r("export"),import:r("import"),extends:f,await:f}}(),yr=/[+\-*&%=<>!?|~^@]/,Dr=/^@(context|id|value|language|type|container|list|set|reverse|index|base|vocab|graph)"/;function Jr(r){for(var e=!1,t,f=!1;(t=r.next())!=null;){if(!e){if(t=="/"&&!f)return;t=="["?f=!0:f&&t=="]"&&(f=!1)}e=!e&&t=="\\"}}var R,rr;function w(r,e,t){return R=r,rr=t,e}function M(r,e){var t=r.next();if(t=='"'||t=="'")return e.tokenize=Lr(t),e.tokenize(r,e);if(t=="."&&r.match(/^\d[\d_]*(?:[eE][+\-]?[\d_]+)?/))return w("number","number");if(t=="."&&r.match(".."))return w("spread","meta");if(/[\[\]{}\(\),;\:\.]/.test(t))return w(t);if(t=="="&&r.eat(">"))return w("=>","operator");if(t=="0"&&r.match(/^(?:x[\dA-Fa-f_]+|o[0-7_]+|b[01_]+)n?/))return w("number","number");if(/\d/.test(t))return r.match(/^[\d_]*(?:n|(?:\.[\d_]*)?(?:[eE][+\-]?[\d_]+)?)?/),w("number","number");if(t=="/")return r.eat("*")?(e.tokenize=er,er(r,e)):r.eat("/")?(r.skipToEnd(),w("comment","comment")):Pr(r,e,1)?(Jr(r),r.match(/^\b(([gimyus])(?![gimyus]*\2))+\b/),w("regexp","string-2")):(r.eat("="),w("operator","operator",r.current()));if(t=="`")return e.tokenize=U,U(r,e);if(t=="#"&&r.peek()=="!")return r.skipToEnd(),w("meta","meta");if(t=="#"&&r.eatWhile(C))return w("variable","property");if(t=="<"&&r.match("!--")||t=="-"&&r.match("->")&&!/\S/.test(r.string.slice(0,r.start)))return r.skipToEnd(),w("comment","comment");if(yr.test(t))return(t!=">"||!e.lexical||e.lexical.type!=">")&&(r.eat("=")?(t=="!"||t=="=")&&r.eat("="):/[<>*+\-|&?]/.test(t)&&(r.eat(t),t==">"&&r.eat(t))),t=="?"&&r.eat(".")?w("."):w("operator","operator",r.current());if(C.test(t)){r.eatWhile(C);var f=r.current();if(e.lastType!="."){if(gr.propertyIsEnumerable(f)){var u=gr[f];return w(u.type,u.style,f)}if(f=="async"&&r.match(/^(\s|\/\*([^*]|\*(?!\/))*?\*\/)*[\[\(\w]/,!1))return w("async","keyword",f)}return w("variable","variable",f)}}function Lr(r){return function(e,t){var f=!1,u;if(Z&&e.peek()=="@"&&e.match(Dr))return t.tokenize=M,w("jsonld-keyword","meta");for(;(u=e.next())!=null&&!(u==r&&!f);)f=!f&&u=="\\";return f||(t.tokenize=M),w("string","string")}}function er(r,e){for(var t=!1,f;f=r.next();){if(f=="/"&&t){e.tokenize=M;break}t=f=="*"}return w("comment","comment")}function U(r,e){for(var t=!1,f;(f=r.next())!=null;){if(!t&&(f=="`"||f=="$"&&r.eat("{"))){e.tokenize=M;break}t=!t&&f=="\\"}return w("quasi","string-2",r.current())}var Qr="([{}])";function sr(r,e){e.fatArrowAt&&(e.fatArrowAt=null);var t=r.string.indexOf("=>",r.start);if(!(t<0)){if(p){var f=/:\s*(?:\w+(?:<[^>]*>|\[\])?|\{[^}]*\})\s*$/.exec(r.string.slice(r.start,t));f&&(t=f.index)}for(var u=0,l=!1,m=t-1;m>=0;--m){var g=r.string.charAt(m),A=Qr.indexOf(g);if(A>=0&&A<3){if(!u){++m;break}if(--u==0){g=="("&&(l=!0);break}}else if(A>=3&&A<6)++u;else if(C.test(g))l=!0;else if(/["'\/`]/.test(g))for(;;--m){if(m==0)return;var we=r.string.charAt(m-1);if(we==g&&r.string.charAt(m-2)!="\\"){m--;break}}else if(l&&!u){++m;break}}l&&!u&&(e.fatArrowAt=m)}}var Rr={atom:!0,number:!0,variable:!0,string:!0,regexp:!0,this:!0,import:!0,"jsonld-keyword":!0};function jr(r,e,t,f,u,l){this.indented=r,this.column=e,this.type=t,this.prev=u,this.info=l,f!=null&&(this.align=f)}function Ur(r,e){if(!vr)return!1;for(var t=r.localVars;t;t=t.next)if(t.name==e)return!0;for(var f=r.context;f;f=f.prev)for(var t=f.vars;t;t=t.next)if(t.name==e)return!0}function Er(r,e,t,f,u){var l=r.cc;for(i.state=r,i.stream=u,i.marked=null,i.cc=l,i.style=e,r.lexical.hasOwnProperty("align")||(r.lexical.align=!0);;){var m=l.length?l.pop():z?b:h;if(m(t,f)){for(;l.length&&l[l.length-1].lex;)l.pop()();return i.marked?i.marked:t=="variable"&&Ur(r,f)?"variable-2":e}}}var i={state:null,column:null,marked:null,cc:null};function o(){for(var r=arguments.length-1;r>=0;r--)i.cc.push(arguments[r])}function n(){return o.apply(null,arguments),!0}function cr(r,e){for(var t=e;t;t=t.next)if(t.name==r)return!0;return!1}function B(r){var e=i.state;if(i.marked="def",!!vr){if(e.context){if(e.lexical.info=="var"&&e.context&&e.context.block){var t=Ar(r,e.context);if(t!=null){e.context=t;return}}else if(!cr(r,e.localVars)){e.localVars=new K(r,e.localVars);return}}v.globalVars&&!cr(r,e.globalVars)&&(e.globalVars=new K(r,e.globalVars))}}function Ar(r,e){if(e)if(e.block){var t=Ar(r,e.prev);return t?t==e.prev?e:new W(t,e.vars,!0):null}else return cr(r,e.vars)?e:new W(e.prev,new K(r,e.vars),!1);else return null}function nr(r){return r=="public"||r=="private"||r=="protected"||r=="abstract"||r=="readonly"}function W(r,e,t){this.prev=r,this.vars=e,this.block=t}function K(r,e){this.name=r,this.next=e}var Wr=new K("this",new K("arguments",null));function P(){i.state.context=new W(i.state.context,i.state.localVars,!1),i.state.localVars=Wr}function lr(){i.state.context=new W(i.state.context,i.state.localVars,!0),i.state.localVars=null}function j(){i.state.localVars=i.state.context.vars,i.state.context=i.state.context.prev}j.lex=!0;function s(r,e){var t=function(){var f=i.state,u=f.indented;if(f.lexical.type=="stat")u=f.lexical.indented;else for(var l=f.lexical;l&&l.type==")"&&l.align;l=l.prev)u=l.indented;f.lexical=new jr(u,i.stream.column(),r,null,f.lexical,e)};return t.lex=!0,t}function a(){var r=i.state;r.lexical.prev&&(r.lexical.type==")"&&(r.indented=r.lexical.indented),r.lexical=r.lexical.prev)}a.lex=!0;function c(r){function e(t){return t==r?n():r==";"||t=="}"||t==")"||t=="]"?o():n(e)}return e}function h(r,e){return r=="var"?n(s("vardef",e),br,c(";"),a):r=="keyword a"?n(s("form"),dr,h,a):r=="keyword b"?n(s("form"),h,a):r=="keyword d"?i.stream.match(/^\s*$/,!1)?n():n(s("stat"),F,c(";"),a):r=="debugger"?n(c(";")):r=="{"?n(s("}"),lr,fr,a,j):r==";"?n():r=="if"?(i.state.lexical.info=="else"&&i.state.cc[i.state.cc.length-1]==a&&i.state.cc.pop()(),n(s("form"),dr,h,a,zr)):r=="function"?n(S):r=="for"?n(s("form"),lr,Mr,h,j,a):r=="class"||p&&e=="interface"?(i.marked="keyword",n(s("form",r=="class"?r:e),$r,a)):r=="variable"?p&&e=="declare"?(i.marked="keyword",n(h)):p&&(e=="module"||e=="enum"||e=="type")&&i.stream.match(/^\s*\w/,!1)?(i.marked="keyword",e=="enum"?n(Br):e=="type"?n(Or,c("operator"),d,c(";")):n(s("form"),E,c("{"),s("}"),fr,a,a)):p&&e=="namespace"?(i.marked="keyword",n(s("form"),b,h,a)):p&&e=="abstract"?(i.marked="keyword",n(h)):n(s("stat"),Zr):r=="switch"?n(s("form"),dr,c("{"),s("}","switch"),lr,fr,a,a,j):r=="case"?n(b,c(":")):r=="default"?n(c(":")):r=="catch"?n(s("form"),P,Kr,h,a,j):r=="export"?n(s("stat"),le,a):r=="import"?n(s("stat"),de,a):r=="async"?n(h):e=="@"?n(b,h):o(s("stat"),b,c(";"),a)}function Kr(r){if(r=="(")return n(q,c(")"))}function b(r,e){return Tr(r,e,!1)}function y(r,e){return Tr(r,e,!0)}function dr(r){return r!="("?o():n(s(")"),F,c(")"),a)}function Tr(r,e,t){if(i.state.fatArrowAt==i.stream.start){var f=t?Ir:Vr;if(r=="(")return n(P,s(")"),x(q,")"),a,c("=>"),f,j);if(r=="variable")return o(P,E,c("=>"),f,j)}var u=t?D:O;return Rr.hasOwnProperty(r)?n(u):r=="function"?n(S,u):r=="class"||p&&e=="interface"?(i.marked="keyword",n(s("form"),ce,a)):r=="keyword c"||r=="async"?n(t?y:b):r=="("?n(s(")"),F,c(")"),a,u):r=="operator"||r=="spread"?n(t?y:b):r=="["?n(s("]"),pe,a,u):r=="{"?H(ir,"}",null,u):r=="quasi"?o(tr,u):r=="new"?n(Gr(t)):n()}function F(r){return r.match(/[;\}\)\],]/)?o():o(b)}function O(r,e){return r==","?n(F):D(r,e,!1)}function D(r,e,t){var f=t==!1?O:D,u=t==!1?b:y;if(r=="=>")return n(P,t?Ir:Vr,j);if(r=="operator")return/\+\+|--/.test(e)||p&&e=="!"?n(f):p&&e=="<"&&i.stream.match(/^([^<>]|<[^<>]*>)*>\s*\(/,!1)?n(s(">"),x(d,">"),a,f):e=="?"?n(b,c(":"),u):n(u);if(r=="quasi")return o(tr,f);if(r!=";"){if(r=="(")return H(y,")","call",f);if(r==".")return n(Cr,f);if(r=="[")return n(s("]"),F,c("]"),a,f);if(p&&e=="as")return i.marked="keyword",n(d,f);if(r=="regexp")return i.state.lastType=i.marked="operator",i.stream.backUp(i.stream.pos-i.stream.start-1),n(u)}}function tr(r,e){return r!="quasi"?o():e.slice(e.length-2)!="${"?n(tr):n(F,Hr)}function Hr(r){if(r=="}")return i.marked="string-2",i.state.tokenize=U,n(tr)}function Vr(r){return sr(i.stream,i.state),o(r=="{"?h:b)}function Ir(r){return sr(i.stream,i.state),o(r=="{"?h:y)}function Gr(r){return function(e){return e=="."?n(r?Yr:Xr):e=="variable"&&p?n(fe,r?D:O):o(r?y:b)}}function Xr(r,e){if(e=="target")return i.marked="keyword",n(O)}function Yr(r,e){if(e=="target")return i.marked="keyword",n(D)}function Zr(r){return r==":"?n(a,h):o(O,c(";"),a)}function Cr(r){if(r=="variable")return i.marked="property",n()}function ir(r,e){if(r=="async")return i.marked="property",n(ir);if(r=="variable"||i.style=="keyword"){if(i.marked="property",e=="get"||e=="set")return n(re);var t;return p&&i.state.fatArrowAt==i.stream.start&&(t=i.stream.match(/^\s*:\s*/,!1))&&(i.state.fatArrowAt=i.stream.pos+t[0].length),n($)}else{if(r=="number"||r=="string")return i.marked=Z?"property":i.style+" property",n($);if(r=="jsonld-keyword")return n($);if(p&&nr(e))return i.marked="keyword",n(ir);if(r=="[")return n(b,J,c("]"),$);if(r=="spread")return n(y,$);if(e=="*")return i.marked="keyword",n(ir);if(r==":")return o($)}}function re(r){return r!="variable"?o($):(i.marked="property",n(S))}function $(r){if(r==":")return n(y);if(r=="(")return o(S)}function x(r,e,t){function f(u,l){if(t?t.indexOf(u)>-1:u==","){var m=i.state.lexical;return m.info=="call"&&(m.pos=(m.pos||0)+1),n(function(g,A){return g==e||A==e?o():o(r)},f)}return u==e||l==e?n():t&&t.indexOf(";")>-1?o(r):n(c(e))}return function(u,l){return u==e||l==e?n():o(r,f)}}function H(r,e,t){for(var f=3;f<arguments.length;f++)i.cc.push(arguments[f]);return n(s(e,t),x(r,e),a)}function fr(r){return r=="}"?n():o(h,fr)}function J(r,e){if(p){if(r==":")return n(d);if(e=="?")return n(J)}}function ee(r,e){if(p&&(r==":"||e=="in"))return n(d)}function Sr(r){if(p&&r==":")return i.stream.match(/^\s*\w+\s+is\b/,!1)?n(b,ne,d):n(d)}function ne(r,e){if(e=="is")return i.marked="keyword",n()}function d(r,e){if(e=="keyof"||e=="typeof"||e=="infer"||e=="readonly")return i.marked="keyword",n(e=="typeof"?y:d);if(r=="variable"||e=="void")return i.marked="type",n(T);if(e=="|"||e=="&")return n(d);if(r=="string"||r=="number"||r=="atom")return n(T);if(r=="[")return n(s("]"),x(d,"]",","),a,T);if(r=="{")return n(s("}"),mr,a,T);if(r=="(")return n(x(kr,")"),te,T);if(r=="<")return n(x(d,">"),d);if(r=="quasi")return o(pr,T)}function te(r){if(r=="=>")return n(d)}function mr(r){return r.match(/[\}\)\]]/)?n():r==","||r==";"?n(mr):o(G,mr)}function G(r,e){if(r=="variable"||i.style=="keyword")return i.marked="property",n(G);if(e=="?"||r=="number"||r=="string")return n(G);if(r==":")return n(d);if(r=="[")return n(c("variable"),ee,c("]"),G);if(r=="(")return o(Q,G);if(!r.match(/[;\}\)\],]/))return n()}function pr(r,e){return r!="quasi"?o():e.slice(e.length-2)!="${"?n(pr):n(d,ie)}function ie(r){if(r=="}")return i.marked="string-2",i.state.tokenize=U,n(pr)}function kr(r,e){return r=="variable"&&i.stream.match(/^\s*[?:]/,!1)||e=="?"?n(kr):r==":"?n(d):r=="spread"?n(kr):o(d)}function T(r,e){if(e=="<")return n(s(">"),x(d,">"),a,T);if(e=="|"||r=="."||e=="&")return n(d);if(r=="[")return n(d,c("]"),T);if(e=="extends"||e=="implements")return i.marked="keyword",n(d);if(e=="?")return n(d,c(":"),d)}function fe(r,e){if(e=="<")return n(s(">"),x(d,">"),a,T)}function ar(){return o(d,ae)}function ae(r,e){if(e=="=")return n(d)}function br(r,e){return e=="enum"?(i.marked="keyword",n(Br)):o(E,J,I,oe)}function E(r,e){if(p&&nr(e))return i.marked="keyword",n(E);if(r=="variable")return B(e),n();if(r=="spread")return n(E);if(r=="[")return H(ue,"]");if(r=="{")return H(_r,"}")}function _r(r,e){return r=="variable"&&!i.stream.match(/^\s*:/,!1)?(B(e),n(I)):(r=="variable"&&(i.marked="property"),r=="spread"?n(E):r=="}"?o():r=="["?n(b,c("]"),c(":"),_r):n(c(":"),E,I))}function ue(){return o(E,I)}function I(r,e){if(e=="=")return n(y)}function oe(r){if(r==",")return n(br)}function zr(r,e){if(r=="keyword b"&&e=="else")return n(s("form","else"),h,a)}function Mr(r,e){if(e=="await")return n(Mr);if(r=="(")return n(s(")"),se,a)}function se(r){return r=="var"?n(br,L):r=="variable"?n(L):o(L)}function L(r,e){return r==")"?n():r==";"?n(L):e=="in"||e=="of"?(i.marked="keyword",n(b,L)):o(b,L)}function S(r,e){if(e=="*")return i.marked="keyword",n(S);if(r=="variable")return B(e),n(S);if(r=="(")return n(P,s(")"),x(q,")"),a,Sr,h,j);if(p&&e=="<")return n(s(">"),x(ar,">"),a,S)}function Q(r,e){if(e=="*")return i.marked="keyword",n(Q);if(r=="variable")return B(e),n(Q);if(r=="(")return n(P,s(")"),x(q,")"),a,Sr,j);if(p&&e=="<")return n(s(">"),x(ar,">"),a,Q)}function Or(r,e){if(r=="keyword"||r=="variable")return i.marked="type",n(Or);if(e=="<")return n(s(">"),x(ar,">"),a)}function q(r,e){return e=="@"&&n(b,q),r=="spread"?n(q):p&&nr(e)?(i.marked="keyword",n(q)):p&&r=="this"?n(J,I):o(E,J,I)}function ce(r,e){return r=="variable"?$r(r,e):ur(r,e)}function $r(r,e){if(r=="variable")return B(e),n(ur)}function ur(r,e){if(e=="<")return n(s(">"),x(ar,">"),a,ur);if(e=="extends"||e=="implements"||p&&r==",")return e=="implements"&&(i.marked="keyword"),n(p?d:b,ur);if(r=="{")return n(s("}"),V,a)}function V(r,e){if(r=="async"||r=="variable"&&(e=="static"||e=="get"||e=="set"||p&&nr(e))&&i.stream.match(/^\s+[\w$\xa1-\uffff]/,!1))return i.marked="keyword",n(V);if(r=="variable"||i.style=="keyword")return i.marked="property",n(X,V);if(r=="number"||r=="string")return n(X,V);if(r=="[")return n(b,J,c("]"),X,V);if(e=="*")return i.marked="keyword",n(V);if(p&&r=="(")return o(Q,V);if(r==";"||r==",")return n(V);if(r=="}")return n();if(e=="@")return n(b,V)}function X(r,e){if(e=="!"||e=="?")return n(X);if(r==":")return n(d,I);if(e=="=")return n(y);var t=i.state.lexical.prev,f=t&&t.info=="interface";return o(f?Q:S)}function le(r,e){return e=="*"?(i.marked="keyword",n(wr,c(";"))):e=="default"?(i.marked="keyword",n(b,c(";"))):r=="{"?n(x(qr,"}"),wr,c(";")):o(h)}function qr(r,e){if(e=="as")return i.marked="keyword",n(c("variable"));if(r=="variable")return o(y,qr)}function de(r){return r=="string"?n():r=="("?o(b):r=="."?o(O):o(or,Nr,wr)}function or(r,e){return r=="{"?H(or,"}"):(r=="variable"&&B(e),e=="*"&&(i.marked="keyword"),n(me))}function Nr(r){if(r==",")return n(or,Nr)}function me(r,e){if(e=="as")return i.marked="keyword",n(or)}function wr(r,e){if(e=="from")return i.marked="keyword",n(b)}function pe(r){return r=="]"?n():o(x(y,"]"))}function Br(){return o(s("form"),E,c("{"),s("}"),x(ke,"}"),a,a)}function ke(){return o(E,I)}function be(r,e){return r.lastType=="operator"||r.lastType==","||yr.test(e.charAt(0))||/[,.]/.test(e.charAt(0))}function Pr(r,e,t){return e.tokenize==M&&/^(?:operator|sof|keyword [bcd]|case|new|export|default|spread|[\[{}\(,;:]|=>)$/.test(e.lastType)||e.lastType=="quasi"&&/\{\s*$/.test(r.string.slice(0,r.pos-(t||0)))}return{startState:function(r){var e={tokenize:M,lastType:"sof",cc:[],lexical:new jr((r||0)-N,0,"block",!1),localVars:v.localVars,context:v.localVars&&new W(null,null,!1),indented:r||0};return v.globalVars&&typeof v.globalVars=="object"&&(e.globalVars=v.globalVars),e},token:function(r,e){if(r.sol()&&(e.lexical.hasOwnProperty("align")||(e.lexical.align=!1),e.indented=r.indentation(),sr(r,e)),e.tokenize!=er&&r.eatSpace())return null;var t=e.tokenize(r,e);return R=="comment"?t:(e.lastType=R=="operator"&&(rr=="++"||rr=="--")?"incdec":R,Er(e,t,R,rr,r))},indent:function(r,e){if(r.tokenize==er||r.tokenize==U)return k.Pass;if(r.tokenize!=M)return 0;var t=e&&e.charAt(0),f=r.lexical,u;if(!/^\s*else\b/.test(e))for(var l=r.cc.length-1;l>=0;--l){var m=r.cc[l];if(m==a)f=f.prev;else if(m!=zr&&m!=j)break}for(;(f.type=="stat"||f.type=="form")&&(t=="}"||(u=r.cc[r.cc.length-1])&&(u==O||u==D)&&!/^[,\.=+\-*:?[\(]/.test(e));)f=f.prev;xr&&f.type==")"&&f.prev.type=="stat"&&(f=f.prev);var g=f.type,A=t==g;return g=="vardef"?f.indented+(r.lastType=="operator"||r.lastType==","?f.info.length+1:0):g=="form"&&t=="{"?f.indented:g=="form"?f.indented+N:g=="stat"?f.indented+(be(r,e)?xr||N:0):f.info=="switch"&&!A&&v.doubleIndentSwitch!=!1?f.indented+(/^(?:case|default)\b/.test(e)?N:2*N):f.align?f.column+(A?0:1):f.indented+(A?0:N)},electricInput:/^\s*(?:case .*?:|default:|\{|\})$/,blockCommentStart:z?null:"/*",blockCommentEnd:z?null:"*/",blockCommentContinue:z?null:" * ",lineComment:z?null:"//",fold:"brace",closeBrackets:"()[]{}''\"\"``",helperType:z?"json":"javascript",jsonldMode:Z,jsonMode:z,expressionAllowed:Pr,skipExpression:function(r){Er(r,"atom","atom","true",new k.StringStream("",2,null))}}}),k.registerHelper("wordChars","javascript",/[\w$]/),k.defineMIME("text/javascript","javascript"),k.defineMIME("text/ecmascript","javascript"),k.defineMIME("application/javascript","javascript"),k.defineMIME("application/x-javascript","javascript"),k.defineMIME("application/ecmascript","javascript"),k.defineMIME("application/json",{name:"javascript",json:!0}),k.defineMIME("application/x-json",{name:"javascript",json:!0}),k.defineMIME("application/manifest+json",{name:"javascript",json:!0}),k.defineMIME("application/ld+json",{name:"javascript",jsonld:!0}),k.defineMIME("text/typescript",{name:"javascript",typescript:!0}),k.defineMIME("application/typescript",{name:"javascript",typescript:!0})})})();var ve=Fr.exports,ye=xe({__proto__:null,default:ve},[Fr.exports]);export{Fr as a,ye as j};

package/dist/assets/jinja2.f97723a0.js

@@ -0,0 +1 @@
+import{A as p}from"./index.70f6f88a.entry.js";function b(f,u){return u.forEach(function(i){i&&typeof i!="string"&&!Array.isArray(i)&&Object.keys(i).forEach(function(o){if(o!=="default"&&!(o in f)){var l=Object.getOwnPropertyDescriptor(i,o);Object.defineProperty(f,o,l.get?l:{enumerable:!0,get:function(){return i[o]}})}})}),Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var a={exports:{}};(function(f,u){(function(i){i(p.exports)})(function(i){i.defineMode("jinja2",function(){var o=["and","as","block","endblock","by","cycle","debug","else","elif","extends","filter","endfilter","firstof","for","endfor","if","endif","ifchanged","endifchanged","ifequal","endifequal","ifnotequal","endifnotequal","in","include","load","not","now","or","parsed","regroup","reversed","spaceless","endspaceless","ssi","templatetag","openblock","closeblock","openvariable","closevariable","openbrace","closebrace","opencomment","closecomment","widthratio","url","with","endwith","get_current_language","trans","endtrans","noop","blocktrans","endblocktrans","get_available_languages","get_current_language_bidi","plural"],l=/^[+\-*&%=<>!?|~^]/,g=/^[:\[\(\{]/,t=["true","false"],c=/^(\d[+\-\*\/])?\d+(\.\d+)?/;o=new RegExp("(("+o.join(")|(")+"))\\b"),t=new RegExp("(("+t.join(")|(")+"))\\b");function d(e,n){var r=e.peek();if(n.incomment)return e.skipTo("#}")?(e.eatWhile(/\#|}/),n.incomment=!1):e.skipToEnd(),"comment";if(n.intag){if(n.operator){if(n.operator=!1,e.match(t))return"atom";if(e.match(c))return"number"}if(n.sign){if(n.sign=!1,e.match(t))return"atom";if(e.match(c))return"number"}if(n.instring)return r==n.instring&&(n.instring=!1),e.next(),"string";if(r=="'"||r=='"')return n.instring=r,e.next(),"string";if(e.match(n.intag+"}")||e.eat("-")&&e.match(n.intag+"}"))return n.intag=!1,"tag";if(e.match(l))return n.operator=!0,"operator";if(e.match(g))n.sign=!0;else if(e.eat(" ")||e.sol()){if(e.match(o))return"keyword";if(e.match(t))return"atom";if(e.match(c))return"number";e.sol()&&e.next()}else e.next();return"variable"}else if(e.eat("{")){if(e.eat("#"))return n.incomment=!0,e.skipTo("#}")?(e.eatWhile(/\#|}/),n.incomment=!1):e.skipToEnd(),"comment";if(r=e.eat(/\{|%/))return n.intag=r,r=="{"&&(n.intag="}"),e.eat("-"),"tag"}e.next()}return{startState:function(){return{tokenize:d}},token:function(e,n){return n.tokenize(e,n)},blockCommentStart:"{#",blockCommentEnd:"#}"}}),i.defineMIME("text/jinja2","jinja2")})})();var s=a.exports,j=b({__proto__:null,default:s},[a.exports]);export{j};

package/dist/assets/jsx.3f2b01c1.js

@@ -0,0 +1 @@
+import{A as k,B as w}from"./index.70f6f88a.entry.js";import{a as O}from"./javascript.d2db845f.js";function S(l,h){return h.forEach(function(i){i&&typeof i!="string"&&!Array.isArray(i)&&Object.keys(i).forEach(function(a){if(a!=="default"&&!(a in l)){var f=Object.getOwnPropertyDescriptor(i,a);Object.defineProperty(l,a,f.get?f:{enumerable:!0,get:function(){return i[a]}})}})}),Object.freeze(Object.defineProperty(l,Symbol.toStringTag,{value:"Module"}))}var x={exports:{}};(function(l,h){(function(i){i(k.exports,w.exports,O.exports)})(function(i){function a(r,c,o,s){this.state=r,this.mode=c,this.depth=o,this.prev=s}function f(r){return new a(i.copyState(r.mode,r.state),r.mode,r.depth,r.prev&&f(r.prev))}i.defineMode("jsx",function(r,c){var o=i.getMode(r,{name:"xml",allowMissing:!0,multilineTagIndentPastTag:!1,allowMissingTagName:!0}),s=i.getMode(r,c&&c.base||"javascript");function j(t){var n=t.tagName;t.tagName=null;var e=o.indent(t,"","");return t.tagName=n,e}function g(t,n){return n.context.mode==o?y(t,n,n.context):b(t,n,n.context)}function y(t,n,e){if(e.depth==2)return t.match(/^.*?\*\//)?e.depth=1:t.skipToEnd(),"comment";if(t.peek()=="{"){o.skipAttribute(e.state);var u=j(e.state),p=e.state.context;if(p&&t.match(/^[^>]*>\s*$/,!1)){for(;p.prev&&!p.startOfLine;)p=p.prev;p.startOfLine?u-=r.indentUnit:e.prev.state.lexical&&(u=e.prev.state.lexical.indented)}else e.depth==1&&(u+=r.indentUnit);return n.context=new a(i.startState(s,u),s,0,n.context),null}if(e.depth==1){if(t.peek()=="<")return o.skipAttribute(e.state),n.context=new a(i.startState(o,j(e.state)),o,0,n.context),null;if(t.match("//"))return t.skipToEnd(),"comment";if(t.match("/*"))return e.depth=2,g(t,n)}var v=o.token(t,e.state),d=t.current(),m;return/\btag\b/.test(v)?/>$/.test(d)?e.state.context?e.depth=0:n.context=n.context.prev:/^</.test(d)&&(e.depth=1):!v&&(m=d.indexOf("{"))>-1&&t.backUp(d.length-m),v}function b(t,n,e){if(t.peek()=="<"&&s.expressionAllowed(t,e.state))return n.context=new a(i.startState(o,s.indent(e.state,"","")),o,0,n.context),s.skipExpression(e.state),null;var u=s.token(t,e.state);if(!u&&e.depth!=null){var p=t.current();p=="{"?e.depth++:p=="}"&&--e.depth==0&&(n.context=n.context.prev)}return u}return{startState:function(){return{context:new a(i.startState(s),s)}},copyState:function(t){return{context:f(t.context)}},token:g,indent:function(t,n,e){return t.context.mode.indent(t.context.state,n,e)},innerMode:function(t){return t.context}}},"xml","javascript"),i.defineMIME("text/jsx","jsx"),i.defineMIME("text/typescript-jsx",{name:"jsx",base:{name:"javascript",typescript:!0}})})})();var T=x.exports,N=S({__proto__:null,default:T},[x.exports]);export{N as j};