@directus/app 9.12.0 → 9.13.0

package/dist/assets/file-library.3626307c.js

@@ -0,0 +1 @@
+import{a as s,o as d,b as c,w as t,g as e,e as i,B as l}from"./runtime-core.esm-bundler.e6808e6c.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The File Library Module aggregates all files within the Directus Project into one consolidated library. It is a full-featured Digital Asset Management (DAM) system for storing, organizing, browsing, and transforming your various files and assets.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-library-20220307A.webp",alt:"File Library"})],-1),f=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#how-it-works"},"How it Works")]),e("li",null,[e("a",{href:"#files"},"Files")]),e("li",null,[e("a",{href:"#edit-an-image"},"Edit an Image")]),e("li",null,[e("a",{href:"#upload-a-file"},"Upload a File")]),e("li",null,[e("a",{href:"#replace-a-file"},"Replace a File")]),e("li",null,[e("a",{href:"#folders"},"Folders")]),e("li",null,[e("a",{href:"#create-a-folder"},"Create a Folder")]),e("li",null,[e("a",{href:"#rename-a-folder"},"Rename a Folder")]),e("li",null,[e("a",{href:"#move-a-folder"},"Move a Folder")]),e("li",null,[e("a",{href:"#delete-a-folder"},"Delete a Folder")]),e("li",null,[e("a",{href:"#more-help"},"More Help")])])])],-1),_={class:"warning hint"},m=e("div",{class:"hint-title"},"More Documents on Folder and File Management",-1),g=l("This is a non-technical, no-code guide to the File Library Module. Please note there is documentation on programmatic "),F=l("Folder"),y=l(" and "),b=l("File"),v=l(" management via the API."),w=e("h2",{id:"how-it-works"},[l("How it Works "),e("a",{class:"header-anchor",href:"#how-it-works"},"#")],-1),k={class:"tip hint"},A=e("div",{class:"hint-title"},"Required Knowledge",-1),C=l("Familiarity with the "),D=l("Collections Page"),T=l(" will be helpful but not necessary."),I=l("The File Library acts as one big "),L=e("a",{href:"#folders"},"Folder",-1),P=l(" to store all uploaded "),M=e("a",{href:"#files"},"Files",-1),S=l(". Sub-folders can be created within the File Library to help Files stay organized. Folders and File information are stored in regular Collections, which means "),E=l("User and Role access permissions"),H=l(" are fully configurable and granular on both Folders and Files. Multiple files can be uploaded at once through the app and also programmatically via the API. Any type of file can be uploaded, "),U=e("em",null,"not just images",-1),R=l(". When a Folder is selected from the Navigation Bar, the "),x=e("a",{href:"#folders"},"File Listing Page",-1),B=l(" is presented. This page has all the same features and functionalities as the "),N=l("Collections Page"),W=l("."),j=e("video",{title:"How the File Library Works",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/how-it-works-20220305A.mp4",type:"video/mp4"}),e("p",null,[l(" Your browser is not displaying the video for some reason. Here's a "),e("a",{href:""},"link to the video"),l(" instead. ")])],-1),z=e("ol",null,[e("li",null,[l("Select a Folder. There are two options: "),e("ul",null,[e("li",null,"Choose desired Folder from the Navigation Bar."),e("li",null,[l("Click "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" in the Page Header, name your folder, and click "),e("strong",null,"\u201CSave\u201D"),l(".")])])]),e("li",null,[l("Click "),e("span",{mi:"",btn:""},"add"),l(" in the Page Header. A popover will appear.")]),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])]),e("li",null,"Optional: Click the File Display to open the File Details Page and fill in information as desired.")],-1),O=e("h2",{id:"files"},[l("Files "),e("a",{class:"header-anchor",href:"#files"},"#")],-1),K=l("When a file is clicked in the File Listing Page, the File Details Page appears. This is a custom form for viewing assets and embeds, with core Fields included out-of-the-box (see below), and the ability for Administrators to add additional custom Fields. This page has the same features and functionality as the "),V=l("Item Details Page"),Y=l("."),q=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/files-20220305A.webp",alt:"Files"})],-1),J=e("h3",{id:"action-buttons"},[l("Action Buttons "),e("a",{class:"header-anchor",href:"#action-buttons"},"#")],-1),X=e("p",null,"Notice the following Buttons in the Header:",-1),G=e("ul",null,[e("li",null,[e("span",{mi:"",btn:""},"check"),l(" \u2013 Saves any edits made to the file. ")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"tune"),l(" \u2013 Please see [Edit an Image](#edit-an-image) to learn more. ")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"save_alt"),l(" \u2013 Downloads the file to your current device. ")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"drive_file_move"),l(" \u2013 Moves selected File(s) to another Folder. ")]),e("li",null,[e("span",{mi:"",btn:"",dngr:""},"delete"),l(" \u2013 Permanently removes the File and its metadata. This action is permanent and cannot be undone. ")])],-1),Q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Deleting Files Linked to Items"),e("p",null,[l("By default, Directus will not allow you to delete a File until you remove it from any and all related Items. However, this behavior can be reconfigured so that Files automatically update when the image is deleted by setting the relational constraint of your File Field to "),e("code",null,"SET NULL"),l(" or "),e("code",null,"CASCADE"),l(" when the File is deleted.")])],-1),Z=e("h3",{id:"file-details"},[l("File Details "),e("a",{class:"header-anchor",href:"#file-details"},"#")],-1),$=e("p",null,[l("The Files Collection comes pre-configured with the following Fields out of the box. New Fields can be created and customized as needed in "),e("strong",null,"Settings > Data Model"),l(". However the pre-configured Fields cannot be changed or deleted.")],-1),ee=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-details-20220305A.webp",alt:"File Details"})],-1),le=e("ul",null,[e("li",null,[e("strong",null,"Preview"),l(" \u2013 A preview of the image or file.")]),e("li",null,[e("strong",null,"Title"),l(" \u2013 A title for the File.")]),e("li",null,[e("strong",null,"Description"),l(" \u2013 A description of the File.")]),e("li",null,[e("strong",null,"Tags"),l(" \u2013 Keywords used for search-ability.")]),e("li",null,[e("strong",null,"Location"),l(" \u2013 An optional location "),e("em",null,"(e.g. where a photo was taken)"),l(".")]),e("li",null,[e("strong",null,"Storage"),l(" \u2013 Which storage adapter is used to store the file asset.")]),e("li",null,[e("strong",null,"Filename (Disk)"),l(" \u2013 LOCKED. This is the actual name of the file in storage.")]),e("li",null,[e("strong",null,"Filename (Download)"),l(" \u2013 Allows you to set the name of the file when it is downloaded.")])],-1),te=e("h3",{id:"file-sidebar"},[l("File Sidebar "),e("a",{class:"header-anchor",href:"#file-sidebar"},"#")],-1),oe=e("p",null,"The file sidebar also includes the following details, which are not editable and serve as metadata.",-1),ie=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-sidebar-20220305A.webp",alt:"File Sidebar"})],-1),ae=e("ul",null,[e("li",null,[e("strong",null,"Type"),l(" \u2013 The MIME type of the file, displayed in the App as a formatted media type.")]),e("li",null,[e("strong",null,"Dimensions"),l(" \u2013 "),e("em",null,"Images only"),l(". The width and height of the image in pixels.")]),e("li",null,[e("strong",null,"Size"),l(" \u2013 The file-size the asset takes up in the storage adapter.")]),e("li",null,[e("strong",null,"Created"),l(" \u2013 The timestamp of when the file was uploaded to the Project.")]),e("li",null,[e("strong",null,"Owner"),l(" \u2013 The User that uploaded the file to the Project.")]),e("li",null,[e("strong",null,"Modified"),l(" \u2013 The timestamp of when the file was last modified.")]),e("li",null,[e("strong",null,"Edited By"),l(" \u2013 The User that modified the File.")]),e("li",null,[e("strong",null,"Folder"),l(" \u2013 The current parent folder that contains the File.")]),e("li",null,[e("strong",null,"Metadata"),l(" \u2013 Metadata JSON dump of the File\u2019s EXIF, IPTC, and ICC information.")])],-1),se=e("h2",{id:"edit-an-image"},[l("Edit an Image "),e("a",{class:"header-anchor",href:"#edit-an-image"},"#")],-1),ne=e("p",null,"Rotate, crop, flip, or adjust aspect ratios of an image.",-1),re=e("video",{alt:"Edit an Image",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220516A/edit-an-image-20220516A.mp4",type:"video/mp4"})],-1),de=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click a file to open its detail page.")]),e("li",null,[l("Click the "),e("span",{mi:"",btn:"",sec:""},"tune"),l(" button in the top right to open the image editor.")]),e("li",null,[l("Make your changes and click "),e("span",{mi:"",btn:""},"check"),l(" in the top right to save the updates.")])],-1),ce=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"Edits overwrite the original file on disk. This can\u2019t be reversed.")],-1),he=e("h2",{id:"upload-a-file"},[l("Upload a File "),e("a",{class:"header-anchor",href:"#upload-a-file"},"#")],-1),ue=l("We covered the File Library\u2019s three upload methods in "),pe=e("a",{href:"#how-it-works"},"How it Works",-1),fe=l(". Keep in mind that files can also be added through different Interfaces as well. For example, Users can upload an Avatar image when they fill in their User Details. Similarly, Items with an Image Field will have a file upload Interface on the Item Detail page. Files can also be "),_e=l("uploaded programmatically via the API"),me=l("."),ge=e("h2",{id:"replace-a-file"},[l("Replace a File "),e("a",{class:"header-anchor",href:"#replace-a-file"},"#")],-1),Fe=e("p",null,"When a file is replaced, its existing info and all relationships are kept.",-1),ye=e("video",{alt:"Replace a File",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220608A/replace-a-file-20220608A.mp4",type:"video/mp4"})],-1),be=e("ol",null,[e("li",null,"Click the Image Preview on the File Detail page. A popup will appear."),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])])],-1),ve=e("h2",{id:"folders"},[l("Folders "),e("a",{class:"header-anchor",href:"#folders"},"#")],-1),we=e("p",null,"Folders provide the organization system for Files.",-1),ke=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/folders-20220305A.webp",alt:"Folders"})],-1),Ae=l("They can be named, renamed, and nested as sub-folders anywhere in the Folder hierarchy. Once a Folder is selected from the Navigation Bar, File Listing Page opens. The File Listing Page displays all Files within a Folder. It also enables all other features and functionalities from the "),Ce=l("Collections Page"),De=l(" such as batch editing, batch deleting, sorting, filtering, searching, etc. Folders can also be managed "),Te=l("programmatically via the API"),Ie=l("."),Le=e("h2",{id:"create-a-folder"},[l("Create a Folder "),e("a",{class:"header-anchor",href:"#create-a-folder"},"#")],-1),Pe=e("video",{alt:"Create a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/create-a-folder-20220305A.mp4",type:"video/mp4"})],-1),Me=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click on the "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" button located in the Header.")]),e("li",null,"Fill in a Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),Se=e("h2",{id:"rename-a-folder"},[l("Rename a Folder "),e("a",{class:"header-anchor",href:"#rename-a-folder"},"#")],-1),Ee=e("video",{alt:"Renaming a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/rename-a-folder-20220215A.mp4",type:"video/mp4"})],-1),He=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to rename and select \u201CRename Folder\u201D.")]),e("li",null,"Update the Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),Ue=e("h2",{id:"move-a-folder"},[l("Move a Folder "),e("a",{class:"header-anchor",href:"#move-a-folder"},"#")],-1),Re=e("video",{alt:"Moving a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/move-a-folder20220305A.mp4",type:"video/mp4"})],-1),xe=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the folder you wish to move and select "),e("strong",null,"\u201CMove to Folder\u201D"),l(". A popup will appear.")]),e("li",null,"Select a Folder to serve as the new Parent Folder."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),Be=e("h2",{id:"delete-a-folder"},[l("Delete a Folder "),e("a",{class:"header-anchor",href:"#delete-a-folder"},"#")],-1),Ne=e("video",{alt:"Deleting a Folder",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/delete-a-folder-20220215A.mp4",type:"video/mp4"})],-1),We=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to delete and select "),e("strong",null,"\u201CDelete Folder\u201D"),l(".")]),e("li",null,[l("Click "),e("strong",null,"\u201CDelete\u201D"),l(".")])],-1),je=e("div",{class:"tip hint"},[e("p",null,"When you delete a Folder, any nested Files and Folders will be moved one level up.")],-1),ze=e("h2",{id:"more-help"},[l("More Help "),e("a",{class:"header-anchor",href:"#more-help"},"#")],-1),Oe=e("p",null,[l("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),Je="File Library",Xe=!1,Ge={name:"file-library",setup(Ke,{expose:n}){const a={title:"File Library",modularExtension:!1};return n({frontmatter:a}),(Ve,Ye)=>{const o=s("router-link"),r=s("docs-wrapper");return d(),c(r,{frontmatter:a},{default:t(()=>[e("div",h,[u,p,f,e("div",_,[m,e("p",null,[g,i(o,{to:"/docs/reference/system/folders/"},{default:t(()=>[F]),_:1}),y,i(o,{to:"/docs/reference/files/"},{default:t(()=>[b]),_:1}),v])]),w,e("div",k,[A,e("p",null,[C,i(o,{to:"/docs/app/content-collections/"},{default:t(()=>[D]),_:1}),T])]),e("p",null,[I,L,P,M,S,i(o,{to:"/docs/configuration/users-roles-permissions.md"},{default:t(()=>[E]),_:1}),H,U,R,x,B,i(o,{to:"/docs/app/content-collections/"},{default:t(()=>[N]),_:1}),W]),j,z,O,e("p",null,[K,i(o,{to:"/docs/getting-started/glossary/#items"},{default:t(()=>[V]),_:1}),Y]),q,J,X,G,Q,Z,$,ee,le,te,oe,ie,ae,se,ne,re,de,ce,he,e("p",null,[ue,pe,fe,i(o,{to:"/docs/reference/files/"},{default:t(()=>[_e]),_:1}),me]),ge,Fe,ye,be,ve,we,ke,e("p",null,[Ae,i(o,{to:"/docs/app/content-collections/"},{default:t(()=>[Ce]),_:1}),De,i(o,{to:"/docs/docs/reference/system/folders.md"},{default:t(()=>[Te]),_:1}),Ie]),Le,Pe,Me,Se,Ee,He,Ue,Re,xe,Be,Ne,We,je,ze,Oe])]),_:1})}}};export{Ge as default,Xe as modularExtension,Je as title};

package/dist/assets/{files.8a404c59.js → files.e045e557.js}

@@ -1,7 +1,9 @@
-import{w as o,y as c,z as h,A as l,E as e,C as a,W as s}from"./vendor.f6090249.js";const d={class:"markdown-body"},u=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,[s("Every file managed by the platform is uploaded to the configured storage adapter, and its associated metadata is tracked within the "),e("code",null,"directus_files"),s(" system collection. Any requested file transformations are handled on the fly, and are only saved to storage.")])])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#accessing-an-file"},"Accessing an File")]),e("li",null,[e("a",{href:"#downloading-a-file"},"Downloading a File")]),e("li",null,[e("a",{href:"#requesting-a-thumbnail"},"Requesting a Thumbnail")]),e("li",null,[e("a",{href:"#the-file-object"},"The File Object")]),e("li",null,[e("a",{href:"#list-files"},"List Files")]),e("li",null,[e("a",{href:"#retrieve-a-file"},"Retrieve a File")]),e("li",null,[e("a",{href:"#upload-a-file"},"Upload a File")]),e("li",null,[e("a",{href:"#import-a-file"},"Import a File")]),e("li",null,[e("a",{href:"#update-a-file"},"Update a File")]),e("li",null,[e("a",{href:"#update-multiple-files"},"Update Multiple Files")]),e("li",null,[e("a",{href:"#delete-a-file"},"Delete a File")]),e("li",null,[e("a",{href:"#delete-multiple-files"},"Delete Multiple Files")])])])])])],-1),p=e("hr",null,null,-1),f=e("h2",{id:"accessing-an-file"},[s("Accessing an File "),e("a",{class:"header-anchor",href:"#accessing-an-file"},"#")],-1),_=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"The location of your actual file originals is based on the project\u2019s configuration, but you can consistently access them via the API using the following URL."),e("pre",null,[e("code",null,`example.com/assets/<file-id>
+import{a as o,o as c,b as h,w as l,g as e,e as a,B as s}from"./runtime-core.esm-bundler.e6808e6c.js";const d={class:"markdown-body"},u=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,[s("Every file managed by the platform is uploaded to the configured storage adapter, and its associated metadata is tracked within the "),e("code",null,"directus_files"),s(" system collection. Any requested file transformations are handled on the fly, and are only saved to storage.")])])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#accessing-an-file"},"Accessing an File")]),e("li",null,[e("a",{href:"#downloading-a-file"},"Downloading a File")]),e("li",null,[e("a",{href:"#requesting-a-thumbnail"},"Requesting a Thumbnail")]),e("li",null,[e("a",{href:"#the-file-object"},"The File Object")]),e("li",null,[e("a",{href:"#list-files"},"List Files")]),e("li",null,[e("a",{href:"#retrieve-a-file"},"Retrieve a File")]),e("li",null,[e("a",{href:"#upload-a-file"},"Upload a File")]),e("li",null,[e("a",{href:"#import-a-file"},"Import a File")]),e("li",null,[e("a",{href:"#update-a-file"},"Update a File")]),e("li",null,[e("a",{href:"#update-multiple-files"},"Update Multiple Files")]),e("li",null,[e("a",{href:"#delete-a-file"},"Delete a File")]),e("li",null,[e("a",{href:"#delete-multiple-files"},"Delete Multiple Files")])])])])])],-1),p=e("hr",null,null,-1),f=e("h2",{id:"accessing-an-file"},[s("Accessing an File "),e("a",{class:"header-anchor",href:"#accessing-an-file"},"#")],-1),_=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"The location of your actual file originals is based on the project\u2019s configuration, but you can consistently access them via the API using the following URL."),e("pre",null,[e("code",null,`example.com/assets/<file-id>
 example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4
-`)]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Direct File Access"),e("p",null,[s("While you may "),e("em",null,"technically"),s(" be able to expose your storage adapters root filesystem and access your raw files through there, it is recommended that you always use the Directus API. This is the only way that you can take advantage of file permissions and other built-in features.")])])]),e("div",{class:"right"},[e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/original-20220216A.jpg",alt:"Original File"}),s(),e("em",null,"Original File Used \u2014 602KB and 1800x1200")])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"downloading-a-file"},[s("Downloading a File "),e("a",{class:"header-anchor",href:"#downloading-a-file"},"#")],-1),y=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[s("To download an asset with the correct filename, you need to add the "),e("code",null,"?download"),s(" query parameter to the request and the "),e("code",null,"download"),s(" attribute to your anchor tag. This will ensure the appropriate "),e("a",{href:"https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html",target:"_blank",rel:"noopener noreferrer"},"Content-Disposition"),s(" headers are added. Without this, the download will work on the "),e("em",null,"same"),s(" domain, however it will have the file\u2019s \u201Cid\u201D as the filename for cross-origin requests.")])]),e("div",{class:"right"},[e("h3",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("pre",null,[e("code",{class:"language-html"},[e("span",{class:"hljs-tag"},[s("<"),e("span",{class:"hljs-name"},"a"),s(),e("span",{class:"hljs-attr"},"href"),s("="),e("span",{class:"hljs-string"},'"https://your-directus.com/assets/<file-id>?download"'),s(),e("span",{class:"hljs-attr"},"target"),s("="),e("span",{class:"hljs-string"},'"_blank"'),s(),e("span",{class:"hljs-attr"},"download"),s("="),e("span",{class:"hljs-string"},'"Your File.pdf"'),s(">")]),s("Download"),e("span",{class:"hljs-tag"},[s("</"),e("span",{class:"hljs-name"},"a"),s(">")]),s(`
-`)])])])],-1),b=e("hr",null,null,-1),j=e("h2",{id:"requesting-a-thumbnail"},[s("Requesting a Thumbnail "),e("a",{class:"header-anchor",href:"#requesting-a-thumbnail"},"#")],-1),v={class:"two-up"},q={class:"left"},w=e("p",null,[s("Fetching thumbnails is as easy as adding a "),e("code",null,"key"),s(" query parameter to the original file\u2019s URL. In the Admin App, you can configure different asset presets that control the output of any given image. If a requested thumbnail doesn\u2019t yet exist, it is dynamically generated and immediately returned.")],-1),x=e("h3",{id:"preset-transformations"},[s("Preset Transformations "),e("a",{class:"header-anchor",href:"#preset-transformations"},"#")],-1),T=e("strong",null,[e("code",null,"key")],-1),k=s(" \u2014 This "),R=e("strong",null,"key",-1),E=s(" of the "),A=s("Storage Asset Preset"),D=s(", a shortcut for the below parameters"),P=e("h3",{id:"custom-transformations"},[s("Custom Transformations "),e("a",{class:"header-anchor",href:"#custom-transformations"},"#")],-1),F=e("p",null,"Alternatively, if you have \u201CStorage Asset Transform\u201D set to all, you can use the following parameters for more fine grained control:",-1),S=e("ul",null,[e("li",null,[e("strong",null,[e("code",null,"fit")]),s(" \u2014 The "),e("strong",null,"fit"),s(" of the thumbnail while always preserving the aspect ratio, can be any of the following options: "),e("ul",null,[e("li",null,[e("code",null,"cover"),s(" \u2014 Covers both width/height by cropping/clipping to fit")]),e("li",null,[e("code",null,"contain"),s(" \u2014 Contain within both width/height using \u201Cletterboxing\u201D as needed")]),e("li",null,[e("code",null,"inside"),s(" \u2014 Resize to be as large as possible, ensuring dimensions are less than or equal to the requested width and height")]),e("li",null,[e("code",null,"outside"),s(" \u2014 Resize to be as small as possible, ensuring dimensions are greater than or equal to the requested width and height")])])]),e("li",null,[e("strong",null,[e("code",null,"width")]),s(" \u2014 The "),e("strong",null,"width"),s(" of the thumbnail in pixels")]),e("li",null,[e("strong",null,[e("code",null,"height")]),s(" \u2014 The "),e("strong",null,"height"),s(" of the thumbnail in pixels")]),e("li",null,[e("strong",null,[e("code",null,"quality")]),s(" \u2014 The optional "),e("strong",null,"quality"),s(" of the thumbnail ("),e("code",null,"1"),s(" to "),e("code",null,"100"),s(")")]),e("li",null,[e("strong",null,[e("code",null,"withoutEnlargement")]),s(" \u2014 Disable image up-scaling")]),e("li",null,[e("strong",null,[e("code",null,"format")]),s(" \u2014 What file format to return the thumbnail in. One of "),e("code",null,"jpg"),s(", "),e("code",null,"png"),s(", "),e("code",null,"webp"),s(", "),e("code",null,"tiff")])],-1),C=e("h3",{id:"advanced-transformations"},[s("Advanced Transformations "),e("a",{class:"header-anchor",href:"#advanced-transformations"},"#")],-1),I=e("p",null,[s("For even more advanced control over the file generation, Directus exposes "),e("a",{href:"https://sharp.pixelplumbing.com/api-operation",target:"_blank",rel:"noopener noreferrer"},[s("the full "),e("code",null,"sharp"),s(" API")]),s(" through the "),e("code",null,"transforms"),s(" query parameter. This parameter accepts a two-dimensional array with the format "),e("code",null,"[Operation, ...arguments]"),s(".")],-1),O=e("h3",{id:"quality-vs-filesize"},[s("Quality vs Filesize "),e("a",{class:"header-anchor",href:"#quality-vs-filesize"},"#")],-1),Q=e("p",null,[s("The quality parameter can be any integer from "),e("code",null,"0-100"),s(". Qualities closer to "),e("code",null,"0"),s(" have lower filesizes, but also poor image quality due to compression artifacts. Values closer to "),e("code",null,"100"),s(" have larger filesizes, but better image quality. Below are four possible qualities (200x200 cover) to visually compare the balance between compression and filesize.")],-1),L=e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"25%"),e("th",null,"50%"),e("th",null,"75%"),e("th",null,"100%")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-25-20220216A.jpg",alt:"25%"}),e("br"),e("em",null,"4KB")]),e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-50-20220216A.jpg",alt:"50%"}),e("br"),e("em",null,"6KB")]),e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-75-20220216A.jpg",alt:"75%"}),e("br"),e("em",null,"8KB")]),e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-100-20220216A.jpg",alt:"100%"}),e("br"),e("em",null,"38KB")])])])],-1),X=e("div",{class:"right"},[e("h3",{id:"preset"},[s("Preset "),e("a",{class:"header-anchor",href:"#preset"},"#")]),e("pre",null,[e("code",null,`example.com/assets/<file-id>?key=<key>
+`)]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"SEO"),e("p",null,"You can provide an optional filename after the UUID to optimize for SEO, for example:"),e("pre",null,[e("code",null,`example.com/assets/<file-id>/<filename>
+example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4/directus-logo.png
+`)]),e("p",null,[s("This optional filename is also used in the Content-Disposition header when the "),e("code",null,"?download"),s(" query parameter is used.")])]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Direct File Access"),e("p",null,[s("While you may "),e("em",null,"technically"),s(" be able to expose your storage adapters root filesystem and access your raw files through there, it is recommended that you always use the Directus API. This is the only way that you can take advantage of file permissions and other built-in features.")])])]),e("div",{class:"right"},[e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/original-20220216A.jpg",alt:"Original File"}),s(),e("em",null,"Original File Used \u2014 602KB and 1800x1200")])])],-1),m=e("hr",null,null,-1),g=e("h2",{id:"downloading-a-file"},[s("Downloading a File "),e("a",{class:"header-anchor",href:"#downloading-a-file"},"#")],-1),y=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[s("To download an asset with the correct filename, you need to add the "),e("code",null,"?download"),s(" query parameter to the request and the "),e("code",null,"download"),s(" attribute to your anchor tag. This will ensure the appropriate "),e("a",{href:"https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html",target:"_blank",rel:"noopener noreferrer"},"Content-Disposition"),s(" headers are added. Without this, the download will work on the "),e("em",null,"same"),s(" domain, however it will have the file\u2019s \u201Cid\u201D as the filename for cross-origin requests.")])]),e("div",{class:"right"},[e("h3",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("pre",null,[e("code",{class:"language-html"},[e("span",{class:"hljs-tag"},[s("<"),e("span",{class:"hljs-name"},"a"),s(),e("span",{class:"hljs-attr"},"href"),s("="),e("span",{class:"hljs-string"},'"https://your-directus.com/assets/<file-id>?download"'),s(),e("span",{class:"hljs-attr"},"target"),s("="),e("span",{class:"hljs-string"},'"_blank"'),s(),e("span",{class:"hljs-attr"},"download"),s("="),e("span",{class:"hljs-string"},'"Your File.pdf"'),s(">")]),s("Download"),e("span",{class:"hljs-tag"},[s("</"),e("span",{class:"hljs-name"},"a"),s(">")]),s(`
+`)])])])],-1),b=e("hr",null,null,-1),j=e("h2",{id:"requesting-a-thumbnail"},[s("Requesting a Thumbnail "),e("a",{class:"header-anchor",href:"#requesting-a-thumbnail"},"#")],-1),v={class:"two-up"},q={class:"left"},w=e("p",null,[s("Fetching thumbnails is as easy as adding a "),e("code",null,"key"),s(" query parameter to the original file\u2019s URL. In the Admin App, you can configure different asset presets that control the output of any given image. If a requested thumbnail doesn\u2019t yet exist, it is dynamically generated and immediately returned.")],-1),x=e("h3",{id:"preset-transformations"},[s("Preset Transformations "),e("a",{class:"header-anchor",href:"#preset-transformations"},"#")],-1),T=e("strong",null,[e("code",null,"key")],-1),k=s(" \u2014 This "),R=e("strong",null,"key",-1),E=s(" of the "),A=s("Storage Asset Preset"),D=s(", a shortcut for the below parameters"),S=e("h3",{id:"custom-transformations"},[s("Custom Transformations "),e("a",{class:"header-anchor",href:"#custom-transformations"},"#")],-1),F=e("p",null,"Alternatively, if you have \u201CStorage Asset Transform\u201D set to all, you can use the following parameters for more fine grained control:",-1),P=e("ul",null,[e("li",null,[e("strong",null,[e("code",null,"fit")]),s(" \u2014 The "),e("strong",null,"fit"),s(" of the thumbnail while always preserving the aspect ratio, can be any of the following options: "),e("ul",null,[e("li",null,[e("code",null,"cover"),s(" \u2014 Covers both width/height by cropping/clipping to fit")]),e("li",null,[e("code",null,"contain"),s(" \u2014 Contain within both width/height using \u201Cletterboxing\u201D as needed")]),e("li",null,[e("code",null,"inside"),s(" \u2014 Resize to be as large as possible, ensuring dimensions are less than or equal to the requested width and height")]),e("li",null,[e("code",null,"outside"),s(" \u2014 Resize to be as small as possible, ensuring dimensions are greater than or equal to the requested width and height")])])]),e("li",null,[e("strong",null,[e("code",null,"width")]),s(" \u2014 The "),e("strong",null,"width"),s(" of the thumbnail in pixels")]),e("li",null,[e("strong",null,[e("code",null,"height")]),s(" \u2014 The "),e("strong",null,"height"),s(" of the thumbnail in pixels")]),e("li",null,[e("strong",null,[e("code",null,"quality")]),s(" \u2014 The optional "),e("strong",null,"quality"),s(" of the thumbnail ("),e("code",null,"1"),s(" to "),e("code",null,"100"),s(")")]),e("li",null,[e("strong",null,[e("code",null,"withoutEnlargement")]),s(" \u2014 Disable image up-scaling")]),e("li",null,[e("strong",null,[e("code",null,"format")]),s(" \u2014 What file format to return the thumbnail in. One of "),e("code",null,"jpg"),s(", "),e("code",null,"png"),s(", "),e("code",null,"webp"),s(", "),e("code",null,"tiff")])],-1),C=e("h3",{id:"advanced-transformations"},[s("Advanced Transformations "),e("a",{class:"header-anchor",href:"#advanced-transformations"},"#")],-1),I=e("p",null,[s("For even more advanced control over the file generation, Directus exposes "),e("a",{href:"https://sharp.pixelplumbing.com/api-operation",target:"_blank",rel:"noopener noreferrer"},[s("the full "),e("code",null,"sharp"),s(" API")]),s(" through the "),e("code",null,"transforms"),s(" query parameter. This parameter accepts a two-dimensional array with the format "),e("code",null,"[Operation, ...arguments]"),s(".")],-1),O=e("h3",{id:"quality-vs-filesize"},[s("Quality vs Filesize "),e("a",{class:"header-anchor",href:"#quality-vs-filesize"},"#")],-1),Q=e("p",null,[s("The quality parameter can be any integer from "),e("code",null,"0-100"),s(". Qualities closer to "),e("code",null,"0"),s(" have lower filesizes, but also poor image quality due to compression artifacts. Values closer to "),e("code",null,"100"),s(" have larger filesizes, but better image quality. Below are four possible qualities (200x200 cover) to visually compare the balance between compression and filesize.")],-1),U=e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"25%"),e("th",null,"50%"),e("th",null,"75%"),e("th",null,"100%")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-25-20220216A.jpg",alt:"25%"}),e("br"),e("em",null,"4KB")]),e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-50-20220216A.jpg",alt:"50%"}),e("br"),e("em",null,"6KB")]),e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-75-20220216A.jpg",alt:"75%"}),e("br"),e("em",null,"8KB")]),e("td",null,[e("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-100-20220216A.jpg",alt:"100%"}),e("br"),e("em",null,"38KB")])])])],-1),B=e("div",{class:"right"},[e("h3",{id:"preset"},[s("Preset "),e("a",{class:"header-anchor",href:"#preset"},"#")]),e("pre",null,[e("code",null,`example.com/assets/<file-id>?key=<key>
 `)]),e("h3",{id:"custom"},[s("Custom "),e("a",{class:"header-anchor",href:"#custom"},"#")]),e("pre",null,[e("code",null,`example.com/assets/<file-id>?fit=<fit>&width=<width>&height=<height>&quality=<quality>
 example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4?fit=cover&width=200&height=200&quality=80
 `)]),e("h3",{id:"advanced"},[s("Advanced "),e("a",{class:"header-anchor",href:"#advanced"},"#")]),e("pre",null,[e("code",null,`?transforms=[
@@ -9,7 +11,7 @@ example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4?fit=cover&width=200&heig
 	["tint", "rgb(255, 0, 0)"],
 	["expand", { "right": 200, "bottom": 150 }]
 ]
-`)])],-1),B=e("hr",null,null,-1),U=e("h2",{id:"the-file-object"},[s("The File Object "),e("a",{class:"header-anchor",href:"#the-file-object"},"#")],-1),Y={class:"two-up"},M={class:"left"},z={class:"definitions"},G=e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the file")],-1),N=e("p",null,[e("code",null,"storage"),s(),e("strong",null,"string"),e("br"),s(" Storage adapter used for the file.")],-1),W=e("p",null,[e("code",null,"filename_disk"),s(),e("strong",null,"string"),e("br"),s(" Name of the file as saved on the storage adapter.")],-1),Z=e("p",null,[e("code",null,"filename_download"),s(),e("strong",null,"string"),e("br"),s(" Preferred filename when file is downloaded.")],-1),H=e("p",null,[e("code",null,"title"),s(),e("strong",null,"string"),e("br"),s(" Title for the file.")],-1),K=e("p",null,[e("code",null,"type"),s(),e("strong",null,"string"),e("br"),s(" Mimetype of the file.")],-1),J=e("code",null,"folder",-1),V=s(),$=e("strong",null,"many-to-one",-1),ee=e("br",null,null,-1),se=s(" What (virtual) folder the file is in. Many-to-one to "),le=s("folders"),te=s("."),ae=e("code",null,"uploaded_by",-1),ne=s(),oe=e("strong",null,"many-to-one",-1),ie=e("br",null,null,-1),re=s(" Who uploaded the file. Many-to-one to "),ce=s("users"),he=s("."),de=e("p",null,[e("code",null,"uploaded_on"),s(),e("strong",null,"datetime"),e("br"),s(" When the file was uploaded.")],-1),ue=e("code",null,"modified_by",-1),pe=s(),fe=e("strong",null,"many-to-one",-1),_e=e("br",null,null,-1),me=s(" Who updated the file last. Many-to-one to "),ge=s("users"),ye=s("."),be=e("p",null,[e("code",null,"filesize"),s(),e("strong",null,"number"),e("br"),s(" Size of the file in bytes.")],-1),je=e("p",null,[e("code",null,"width"),s(),e("strong",null,"number"),e("br"),s(" If the file is a(n) image/video, it\u2019s the width in px.")],-1),ve=e("p",null,[e("code",null,"height"),s(),e("strong",null,"number"),e("br"),s(" If the file is a(n) image/video, it\u2019s the height in px.")],-1),qe=e("p",null,[e("code",null,"duration"),s(),e("strong",null,"number"),e("br"),s(" If the file contains audio/video, it\u2019s the duration in milliseconds.")],-1),we=e("p",null,[e("code",null,"description"),s(),e("strong",null,"string"),e("br"),s(" Description of the file.")],-1),xe=e("p",null,[e("code",null,"location"),s(),e("strong",null,"string"),e("br"),s(" Location of the file.")],-1),Te=e("p",null,[e("code",null,"tags"),s(),e("strong",null,"array"),e("br"),s(" Tags for the file.")],-1),ke=e("p",null,[e("code",null,"metadata"),s(),e("strong",null,"object"),e("br"),s(" Any additional metadata Directus was able to scrape from the file. For images, this includes EXIF, IPTC, and ICC information.")],-1),Re=e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
+`)])],-1),L=e("hr",null,null,-1),X=e("h2",{id:"the-file-object"},[s("The File Object "),e("a",{class:"header-anchor",href:"#the-file-object"},"#")],-1),Y={class:"two-up"},M={class:"left"},z={class:"definitions"},G=e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the file")],-1),N=e("p",null,[e("code",null,"storage"),s(),e("strong",null,"string"),e("br"),s(" Storage adapter used for the file.")],-1),Z=e("p",null,[e("code",null,"filename_disk"),s(),e("strong",null,"string"),e("br"),s(" Name of the file as saved on the storage adapter.")],-1),H=e("p",null,[e("code",null,"filename_download"),s(),e("strong",null,"string"),e("br"),s(" Preferred filename when file is downloaded.")],-1),W=e("p",null,[e("code",null,"title"),s(),e("strong",null,"string"),e("br"),s(" Title for the file.")],-1),K=e("p",null,[e("code",null,"type"),s(),e("strong",null,"string"),e("br"),s(" Mimetype of the file.")],-1),J=e("code",null,"folder",-1),V=s(),$=e("strong",null,"many-to-one",-1),ee=e("br",null,null,-1),se=s(" What (virtual) folder the file is in. Many-to-one to "),le=s("folders"),te=s("."),ae=e("code",null,"uploaded_by",-1),ne=s(),oe=e("strong",null,"many-to-one",-1),ie=e("br",null,null,-1),re=s(" Who uploaded the file. Many-to-one to "),ce=s("users"),he=s("."),de=e("p",null,[e("code",null,"uploaded_on"),s(),e("strong",null,"datetime"),e("br"),s(" When the file was uploaded.")],-1),ue=e("code",null,"modified_by",-1),pe=s(),fe=e("strong",null,"many-to-one",-1),_e=e("br",null,null,-1),me=s(" Who updated the file last. Many-to-one to "),ge=s("users"),ye=s("."),be=e("p",null,[e("code",null,"filesize"),s(),e("strong",null,"number"),e("br"),s(" Size of the file in bytes.")],-1),je=e("p",null,[e("code",null,"width"),s(),e("strong",null,"number"),e("br"),s(" If the file is a(n) image/video, it\u2019s the width in px.")],-1),ve=e("p",null,[e("code",null,"height"),s(),e("strong",null,"number"),e("br"),s(" If the file is a(n) image/video, it\u2019s the height in px.")],-1),qe=e("p",null,[e("code",null,"duration"),s(),e("strong",null,"number"),e("br"),s(" If the file contains audio/video, it\u2019s the duration in milliseconds.")],-1),we=e("p",null,[e("code",null,"description"),s(),e("strong",null,"string"),e("br"),s(" Description of the file.")],-1),xe=e("p",null,[e("code",null,"location"),s(),e("strong",null,"string"),e("br"),s(" Location of the file.")],-1),Te=e("p",null,[e("code",null,"tags"),s(),e("strong",null,"array"),e("br"),s(" Tags for the file.")],-1),ke=e("p",null,[e("code",null,"metadata"),s(),e("strong",null,"object"),e("br"),s(" Any additional metadata Directus was able to scrape from the file. For images, this includes EXIF, IPTC, and ICC information.")],-1),Re=e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
 	`),e("span",{class:"hljs-attr"},'"id"'),s(": "),e("span",{class:"hljs-string"},'"4f4b14fa-a43a-46d0-b7ad-90af5919bebb"'),s(`,
 	`),e("span",{class:"hljs-attr"},'"storage"'),s(": "),e("span",{class:"hljs-string"},'"local"'),s(`,
 	`),e("span",{class:"hljs-attr"},'"filename_disk"'),s(": "),e("span",{class:"hljs-string"},'"4f4b14fa-a43a-46d0-b7ad-90af5919bebb.jpeg"'),s(`,
@@ -43,10 +45,10 @@ example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4?fit=cover&width=200&heig
 		}
 	}
 }
-`)])])],-1),Ee=e("hr",null,null,-1),Ae=e("h2",{id:"list-files"},[s("List Files "),e("a",{class:"header-anchor",href:"#list-files"},"#")],-1),De=e("p",null,"List all files that exist in Directus.",-1),Pe={class:"two-up"},Fe={class:"left"},Se=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),Ce=s("Supports all "),Ie=s("global query parameters"),Oe=s("."),Qe=e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),Le=s("An array of up to "),Xe=s("limit"),Be=s(),Ue=e("a",{href:"#the-file-object"},"file objects",-1),Ye=s(". If no items are available, data will be an empty array."),Me={class:"right"},ze=e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),Ge=e("pre",null,[e("code",null,`GET /files
+`)])])],-1),Ee=e("hr",null,null,-1),Ae=e("h2",{id:"list-files"},[s("List Files "),e("a",{class:"header-anchor",href:"#list-files"},"#")],-1),De=e("p",null,"List all files that exist in Directus.",-1),Se={class:"two-up"},Fe={class:"left"},Pe=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),Ce=s("Supports all "),Ie=s("global query parameters"),Oe=s("."),Qe=e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),Ue=s("An array of up to "),Be=s("limit"),Le=s(),Xe=e("a",{href:"#the-file-object"},"file objects",-1),Ye=s(". If no items are available, data will be an empty array."),Me={class:"right"},ze=e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),Ge=e("pre",null,[e("code",null,`GET /files
 SEARCH /files
-`)],-1),Ne=s("Learn more about SEARCH ->"),We=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),Ze=e("pre",null,[e("code",null,`POST /graphql/system
-`)],-1),He=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
+`)],-1),Ne=s("Learn more about SEARCH ->"),Ze=e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),He=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),We=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
 	files: [directus_files]
 }
 `)])],-1),Ke=e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")],-1),Je=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
@@ -106,8 +108,8 @@ Content-Disposition: form-data; name="file"; filename="paulo-silva-vSRgXtQuns8-u
 Content-Type: image/jpeg
 
 \xFF\xD8\xFF\xE0JFIF


HH\xFF\xE2ICC_PROFILE

\flcmsmntrRGB XYZ \x07\xDC
)9acspAPPL\xF6\xD6
\xD3-lcms
-desc\xFC^cprt
\\\vwtpt
hbkpt
|rXYZ
\x90gXYZ
\xA4bXYZ
\xB8rTRC
\xCC@gTRC
\xCC@bTRC
\xCC@descc2textIXXYZ \xF6\xD6
\xD3-XYZ 3\xA4XYZ o\xA28\xF5\x90XYZ b\x99\xB7\x85\xDAXYZ $\xA0\x84\xB6\xCFcurv\xCB
\xC9c\x92\bk\v\xF6?Q4!\xF1)\x902;\x92FQw]\xEDkpz\x89\xB1\x9A|\xACi\xBF}\xD3\xC3\xE90\xFF\xFF\xFF\xDB\x84\b\b\x07\x07
-`)])],-1),Es=e("hr",null,null,-1),As=e("h2",{id:"import-a-file"},[s("Import a File "),e("a",{class:"header-anchor",href:"#import-a-file"},"#")],-1),Ds=e("p",null,"Import a file from the web",-1),Ps={class:"two-up"},Fs={class:"left"},Ss=e("h3",{id:"query-parameters-4"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Cs=s("Supports all "),Is=s("global query parameters"),Os=s("."),Qs=e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ls=e("div",{class:"definitions"},[e("p",null,[e("code",null,"url"),s(),e("strong",null,"Required"),e("br"),s(" The URL to download the file from.")]),e("p",null,[e("code",null,"data"),e("br"),s(" Any of "),e("a",{href:"#the-file-object"},"the file object"),s("\u2019s properties.")])],-1),Xs=e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Bs=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the imported file.")],-1),Us=e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /files/import
+desc\xFC^cprt
\\\vwtpt
hbkpt
|rXYZ
\x90gXYZ
\xA4bXYZ
\xB8rTRC
\xCC@gTRC
\xCC@bTRC
\xCC@descc2textIXXYZ \xF6\xD6
\xD3-XYZ 3\xA4XYZ o\xA28\xF5\x90XYZ b\x99\xB7\x85\xDAXYZ $\xA0\x84\xB6\xCFcurv\xCB
\xC9c\x92\bk\v\xF6?Q\x1B4!\xF1)\x902;\x92FQw]\xEDkpz\x89\xB1\x9A|\xACi\xBF}\xD3\xC3\xE90\xFF\xFF\xFF\xDB\x84\b\b\x07\x07
+`)])],-1),Es=e("hr",null,null,-1),As=e("h2",{id:"import-a-file"},[s("Import a File "),e("a",{class:"header-anchor",href:"#import-a-file"},"#")],-1),Ds=e("p",null,"Import a file from the web",-1),Ss={class:"two-up"},Fs={class:"left"},Ps=e("h3",{id:"query-parameters-4"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Cs=s("Supports all "),Is=s("global query parameters"),Os=s("."),Qs=e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Us=e("div",{class:"definitions"},[e("p",null,[e("code",null,"url"),s(),e("strong",null,"Required"),e("br"),s(" The URL to download the file from.")]),e("p",null,[e("code",null,"data"),e("br"),s(" Any of "),e("a",{href:"#the-file-object"},"the file object"),s("\u2019s properties.")])],-1),Bs=e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Ls=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the imported file.")],-1),Xs=e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /files/import
 `)]),e("h5",{id:"example-5"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /files/import"),s(`
 
 {
@@ -125,7 +127,7 @@ desc\xFC^cprt
\\\vwtpt
hbkpt
|rXYZ
\x90gXYZ
\xA4bXYZ
\xB8rTRC
\xCC@gTRC
\xC
 		id
 	}
 }
-`)])])],-1),Ys=e("hr",null,null,-1),Ms=e("h2",{id:"update-a-file"},[s("Update a File "),e("a",{class:"header-anchor",href:"#update-a-file"},"#")],-1),zs=e("p",null,"Update an existing file, and/or replace it\u2019s file contents.",-1),Gs={class:"two-up"},Ns={class:"left"},Ws=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Zs=s("Supports all "),Hs=s("global query parameters"),Ks=s("."),Js=e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Vs=e("p",null,[s("You can either submit a JSON object consisting of a partial "),e("a",{href:"#the-file-object"},"file object"),s(" to update the file meta, or send a multipart/form-data request to replace the file contents on disk. See "),e("a",{href:"#upload-a-file"},"Upload a File"),s(" for more information on the structure of this "),e("code",null,"multipart/form-data"),s(" request.")],-1),$s=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),el=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the updated file.")],-1),sl=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`PATCH /files/:id
+`)])])],-1),Ys=e("hr",null,null,-1),Ms=e("h2",{id:"update-a-file"},[s("Update a File "),e("a",{class:"header-anchor",href:"#update-a-file"},"#")],-1),zs=e("p",null,"Update an existing file, and/or replace it\u2019s file contents.",-1),Gs={class:"two-up"},Ns={class:"left"},Zs=e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Hs=s("Supports all "),Ws=s("global query parameters"),Ks=s("."),Js=e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Vs=e("p",null,[s("You can either submit a JSON object consisting of a partial "),e("a",{href:"#the-file-object"},"file object"),s(" to update the file meta, or send a multipart/form-data request to replace the file contents on disk. See "),e("a",{href:"#upload-a-file"},"Upload a File"),s(" for more information on the structure of this "),e("code",null,"multipart/form-data"),s(" request.")],-1),$s=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),el=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the updated file.")],-1),sl=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`PATCH /files/:id
 `)]),e("h5",{id:"example-7"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d"),s(`
 
 {
@@ -171,7 +173,7 @@ desc\xFC^cprt
\\\vwtpt
hbkpt
|rXYZ
\x90gXYZ
\xA4bXYZ
\xB8rTRC
\xCC@gTRC
\xC
 		id
 	}
 }
-`)])])],-1),Al=e("hr",null,null,-1),Dl=e("h2",{id:"delete-multiple-files"},[s("Delete Multiple Files "),e("a",{class:"header-anchor",href:"#delete-multiple-files"},"#")],-1),Pl=e("p",null,"Delete multiple files at once.",-1),Fl=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Destructive"),e("p",null,"This will also delete the files from disk.")]),e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")]),e("p",null,"Array of file primary keys"),e("h3",{id:"returns-8"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty response.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /files
+`)])])],-1),Al=e("hr",null,null,-1),Dl=e("h2",{id:"delete-multiple-files"},[s("Delete Multiple Files "),e("a",{class:"header-anchor",href:"#delete-multiple-files"},"#")],-1),Sl=e("p",null,"Delete multiple files at once.",-1),Fl=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Destructive"),e("p",null,"This will also delete the files from disk.")]),e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")]),e("p",null,"Array of file primary keys"),e("h3",{id:"returns-8"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty response.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /files
 `)]),e("h5",{id:"example-12"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// DELETE /files"),s(`
 
 [`),e("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s(", "),e("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s(`]
@@ -184,4 +186,4 @@ desc\xFC^cprt
\\\vwtpt
hbkpt
|rXYZ
\x90gXYZ
\xA4bXYZ
\xB8rTRC
\xCC@gTRC
\xC
 		ids
 	}
 }
-`)])])])],-1),Ql={setup(Sl,{expose:i}){const n={title:"Accessing Files",modularExtension:!1,pageClass:"page-reference"};return i({frontmatter:n}),(Cl,Il)=>{const t=o("router-link"),r=o("DocsWrapper");return c(),h(r,{frontmatter:n},{default:l(()=>[e("div",d,[u,p,f,_,m,g,y,b,j,e("div",v,[e("div",q,[w,x,e("ul",null,[e("li",null,[T,k,R,E,a(t,{to:"/docs/configuration/project-settings/#files-thumbnails"},{default:l(()=>[A]),_:1}),D])]),P,F,S,C,I,O,Q,L]),X]),B,U,e("div",Y,[e("div",M,[e("div",z,[G,N,W,Z,H,K,e("p",null,[J,V,$,ee,se,a(t,{to:"/docs/reference/system/folders/"},{default:l(()=>[le]),_:1}),te]),e("p",null,[ae,ne,oe,ie,re,a(t,{to:"/docs/reference/system/users/"},{default:l(()=>[ce]),_:1}),he]),de,e("p",null,[ue,pe,fe,_e,me,a(t,{to:"/docs/reference/system/users/"},{default:l(()=>[ge]),_:1}),ye]),be,je,ve,qe,we,xe,Te,ke])]),Re]),Ee,Ae,De,e("div",Pe,[e("div",Fe,[Se,e("p",null,[Ce,a(t,{to:"/docs/reference/query"},{default:l(()=>[Ie]),_:1}),Oe]),Qe,e("p",null,[Le,a(t,{to:"/docs/reference/query/#limit"},{default:l(()=>[Xe]),_:1}),Be,Ue,Ye])]),e("div",Me,[ze,Ge,e("p",null,[a(t,{to:"/docs/reference/introduction/#search-http-method"},{default:l(()=>[Ne]),_:1})]),We,Ze,He,Ke,Je])]),Ve,$e,es,e("div",ss,[e("div",ls,[ts,e("p",null,[as,a(t,{to:"/docs/reference/query"},{default:l(()=>[ns]),_:1}),os]),is,rs]),cs]),hs,ds,e("div",us,[e("div",ps,[fs,_s,ms,gs,ys,bs,js,vs,e("p",null,[qs,a(t,{to:"/docs/reference/query"},{default:l(()=>[ws]),_:1}),xs]),Ts,ks]),Rs]),Es,As,Ds,e("div",Ps,[e("div",Fs,[Ss,e("p",null,[Cs,a(t,{to:"/docs/reference/query"},{default:l(()=>[Is]),_:1}),Os]),Qs,Ls,Xs,Bs]),Us]),Ys,Ms,zs,e("div",Gs,[e("div",Ns,[Ws,e("p",null,[Zs,a(t,{to:"/docs/reference/query"},{default:l(()=>[Hs]),_:1}),Ks]),Js,Vs,$s,el]),sl]),ll,tl,al,e("div",nl,[e("div",ol,[il,e("p",null,[rl,a(t,{to:"/docs/reference/query"},{default:l(()=>[cl]),_:1}),hl]),dl,ul,pl,fl]),_l]),ml,gl,yl,e("div",bl,[e("div",jl,[vl,ql,e("p",null,[wl,a(t,{to:"/docs/reference/query"},{default:l(()=>[xl]),_:1}),Tl]),kl,Rl]),El]),Al,Dl,Pl,Fl])]),_:1})}}};export{Ql as default};
+`)])])])],-1),Ql="Accessing Files",Ul=!1,Bl="page-reference",Ll={name:"files",setup(Pl,{expose:i}){const n={title:"Accessing Files",modularExtension:!1,pageClass:"page-reference"};return i({frontmatter:n}),(Cl,Il)=>{const t=o("router-link"),r=o("docs-wrapper");return c(),h(r,{frontmatter:n},{default:l(()=>[e("div",d,[u,p,f,_,m,g,y,b,j,e("div",v,[e("div",q,[w,x,e("ul",null,[e("li",null,[T,k,R,E,a(t,{to:"/docs/configuration/project-settings/#files-thumbnails"},{default:l(()=>[A]),_:1}),D])]),S,F,P,C,I,O,Q,U]),B]),L,X,e("div",Y,[e("div",M,[e("div",z,[G,N,Z,H,W,K,e("p",null,[J,V,$,ee,se,a(t,{to:"/docs/reference/system/folders/"},{default:l(()=>[le]),_:1}),te]),e("p",null,[ae,ne,oe,ie,re,a(t,{to:"/docs/reference/system/users/"},{default:l(()=>[ce]),_:1}),he]),de,e("p",null,[ue,pe,fe,_e,me,a(t,{to:"/docs/reference/system/users/"},{default:l(()=>[ge]),_:1}),ye]),be,je,ve,qe,we,xe,Te,ke])]),Re]),Ee,Ae,De,e("div",Se,[e("div",Fe,[Pe,e("p",null,[Ce,a(t,{to:"/docs/reference/query"},{default:l(()=>[Ie]),_:1}),Oe]),Qe,e("p",null,[Ue,a(t,{to:"/docs/reference/query/#limit"},{default:l(()=>[Be]),_:1}),Le,Xe,Ye])]),e("div",Me,[ze,Ge,e("p",null,[a(t,{to:"/docs/reference/introduction/#search-http-method"},{default:l(()=>[Ne]),_:1})]),Ze,He,We,Ke,Je])]),Ve,$e,es,e("div",ss,[e("div",ls,[ts,e("p",null,[as,a(t,{to:"/docs/reference/query"},{default:l(()=>[ns]),_:1}),os]),is,rs]),cs]),hs,ds,e("div",us,[e("div",ps,[fs,_s,ms,gs,ys,bs,js,vs,e("p",null,[qs,a(t,{to:"/docs/reference/query"},{default:l(()=>[ws]),_:1}),xs]),Ts,ks]),Rs]),Es,As,Ds,e("div",Ss,[e("div",Fs,[Ps,e("p",null,[Cs,a(t,{to:"/docs/reference/query"},{default:l(()=>[Is]),_:1}),Os]),Qs,Us,Bs,Ls]),Xs]),Ys,Ms,zs,e("div",Gs,[e("div",Ns,[Zs,e("p",null,[Hs,a(t,{to:"/docs/reference/query"},{default:l(()=>[Ws]),_:1}),Ks]),Js,Vs,$s,el]),sl]),ll,tl,al,e("div",nl,[e("div",ol,[il,e("p",null,[rl,a(t,{to:"/docs/reference/query"},{default:l(()=>[cl]),_:1}),hl]),dl,ul,pl,fl]),_l]),ml,gl,yl,e("div",bl,[e("div",jl,[vl,ql,e("p",null,[wl,a(t,{to:"/docs/reference/query"},{default:l(()=>[xl]),_:1}),Tl]),kl,Rl]),El]),Al,Dl,Sl,Fl])]),_:1})}}};export{Ll as default,Ul as modularExtension,Bl as pageClass,Ql as title};

package/dist/assets/filter-rules.247581e5.js

@@ -0,0 +1,76 @@
+import{a as e,o as u,b as i,w as s,g as t,e as d,B as l}from"./runtime-core.esm-bundler.e6808e6c.js";const c={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[l("Permissions, validation, and the API\u2019s "),t("code",null,"filter"),l(" parameter all rely on a specific JSON structure to define their rules. This page describes the syntax for creating flat, relational, or complex filter rules.")])],-1),p=t("p",null,[t("div",{class:"table-of-contents"},[t("ul",null,[t("li",null,[t("a",{href:"#syntax"},"Syntax")]),t("li",null,[t("a",{href:"#filter-operators"},"Filter Operators")]),t("li",null,[t("a",{href:"#relational"},"Relational")]),t("li",null,[t("a",{href:"#logical-operators"},"Logical Operators")]),t("li",null,[t("a",{href:"#dynamic-variables"},"Dynamic Variables")])])])],-1),_=t("h2",{id:"syntax"},[l("Syntax "),t("a",{class:"header-anchor",href:"#syntax"},"#")],-1),f=t("ul",null,[t("li",null,[t("strong",null,"Field"),l(" \u2014 Any valid root field, "),t("a",{href:"#relational"},"relational field"),l(", or "),t("a",{href:"#logical-operators"},"logical operator")]),t("li",null,[t("strong",null,"Operator"),l(" \u2014 Any valid "),t("a",{href:"#filter-operators"},"filter operator")]),t("li",null,[t("strong",null,"Value"),l(" \u2014 Any valid static value, or "),t("a",{href:"#dynamic-variables"},"dynamic variable")])],-1),g=t("pre",null,[t("code",null,`{
+	<field>: {
+		<operator>: <value>
+	}
+}
+`)],-1),m=t("h3",{id:"examples"},[l("Examples "),t("a",{class:"header-anchor",href:"#examples"},"#")],-1),y=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"title"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_contains"'),l(": "),t("span",{class:"hljs-string"},'"Directus"'),l(`
+	}
+}
+`)])],-1),b=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"owner"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),l(`
+	}
+}
+`)])],-1),v=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"datetime"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_lte"'),l(": "),t("span",{class:"hljs-string"},'"$NOW"'),l(`
+	}
+}
+`)])],-1),j=t("h2",{id:"filter-operators"},[l("Filter Operators "),t("a",{class:"header-anchor",href:"#filter-operators"},"#")],-1),R=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,[l("Operator Title "),t("em",null,"(in app)")]),t("th",null,"Operator"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,"Equals"),t("td",null,[t("code",null,"_eq")]),t("td",null,"Equal to")]),t("tr",null,[t("td",null,"Doesn\u2019t equal"),t("td",null,[t("code",null,"_neq")]),t("td",null,"Not equal to")]),t("tr",null,[t("td",null,"Less than"),t("td",null,[t("code",null,"_lt")]),t("td",null,"Less than")]),t("tr",null,[t("td",null,"Less than or equal to"),t("td",null,[t("code",null,"_lte")]),t("td",null,"Less than or equal to")]),t("tr",null,[t("td",null,"Greater than"),t("td",null,[t("code",null,"_gt")]),t("td",null,"Greater than")]),t("tr",null,[t("td",null,"Greater than or equal to"),t("td",null,[t("code",null,"_gte")]),t("td",null,"Greater than or equal to")]),t("tr",null,[t("td",null,"Is one of"),t("td",null,[t("code",null,"_in")]),t("td",null,"Matches any of the values")]),t("tr",null,[t("td",null,"Is not one of"),t("td",null,[t("code",null,"_nin")]),t("td",null,"Doesn\u2019t match any of the values")]),t("tr",null,[t("td",null,"Is null"),t("td",null,[t("code",null,"_null")]),t("td",null,[l("Is "),t("code",null,"null")])]),t("tr",null,[t("td",null,"Isn\u2019t null"),t("td",null,[t("code",null,"_nnull")]),t("td",null,[l("Is not "),t("code",null,"null")])]),t("tr",null,[t("td",null,"Contains"),t("td",null,[t("code",null,"_contains")]),t("td",null,"Contains the substring")]),t("tr",null,[t("td",null,"Doesn\u2019t contain"),t("td",null,[t("code",null,"_ncontains")]),t("td",null,"Doesn\u2019t contain the substring")]),t("tr",null,[t("td",null,"Starts with"),t("td",null,[t("code",null,"_starts_with")]),t("td",null,"Starts with")]),t("tr",null,[t("td",null,"Doesn\u2019t start with"),t("td",null,[t("code",null,"_nstarts_with")]),t("td",null,"Doesn\u2019t start with")]),t("tr",null,[t("td",null,"Ends with"),t("td",null,[t("code",null,"_ends_with")]),t("td",null,"Ends with")]),t("tr",null,[t("td",null,"Doesn\u2019t end with"),t("td",null,[t("code",null,"_nends_with")]),t("td",null,"Doesn\u2019t end with")]),t("tr",null,[t("td",null,"Is between"),t("td",null,[t("code",null,"_between")]),t("td",null,"Is between two values (inclusive)")]),t("tr",null,[t("td",null,"Isn\u2019t between"),t("td",null,[t("code",null,"_nbetween")]),t("td",null,"Is not between two values (inclusive)")]),t("tr",null,[t("td",null,"Is empty"),t("td",null,[t("code",null,"_empty")]),t("td",null,[l("Is empty ("),t("code",null,"null"),l(" or falsy)")])]),t("tr",null,[t("td",null,"Isn\u2019t empty"),t("td",null,[t("code",null,"_nempty")]),t("td",null,[l("Is not empty ("),t("code",null,"null"),l(" or falsy)")])]),t("tr",null,[t("td",null,"Intersects"),t("td",null,[t("code",null,"_intersects"),l(),t("sup",null,"[1]")]),t("td",null,"Value intersects a given point")]),t("tr",null,[t("td",null,"Doesn\u2019t intersect"),t("td",null,[t("code",null,"_nintersects"),l(),t("sup",null,"[1]")]),t("td",null,"Value does not intersect a given point")]),t("tr",null,[t("td",null,"Intersects Bounding box"),t("td",null,[t("code",null,"_intersects_bbox"),l(),t("sup",null,"[1]")]),t("td",null,"Value is in a bounding box")]),t("tr",null,[t("td",null,"Doesn\u2019t intersect bounding box"),t("td",null,[t("code",null,"_nintersects_bbox"),l(),t("sup",null,"[1]")]),t("td",null,"Value is not in a bounding box")])])],-1),w=t("p",null,[l("The following operator has no Title on the Filter Interface as it is "),t("strong",null,"only available in validation permissions"),l(":")],-1),x=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"Operator"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,[t("code",null,"_regex"),l(),t("sup",null,"[2]")]),t("td",null,"Field has to match regex")])])],-1),E=t("sup",null,"[1]",-1),N=l(" Only available on Geometry types.\\ "),O=t("sup",null,"[2]",-1),I=l(' JavaScript "flavor" regex. Make sure to escape backslashes. '),T=t("h2",{id:"relational"},[l("Relational "),t("a",{class:"header-anchor",href:"#relational"},"#")],-1),q=t("p",null,[l("You can target related values by nesting field names. For example, if you have a relational Many-to-One "),t("code",null,"author"),l(" field, you can set a rule for the "),t("code",null,"author.name"),l(" field using the following syntax.")],-1),D=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"author"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"name"'),l(`: {
+			`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"Rijk van Zanten"'),l(`
+		}
+	}
+}
+`)])],-1),U=t("h2",{id:"logical-operators"},[l("Logical Operators "),t("a",{class:"header-anchor",href:"#logical-operators"},"#")],-1),F=t("p",null,[l("You can nest or group multiple rules using the "),t("code",null,"_and"),l(" or "),t("code",null,"_or"),l(" logical operators. Each logical operator holds an array of Filter Rules, allowing for more complex filtering. Also note in the example that Logical Operators can be sub-nested into Logical Operators. However, they cannot be sub-nested into Filter Rules.")],-1),$=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"_or"'),l(`: [
+		{
+			`),t("span",{class:"hljs-attr"},'"_and"'),l(`: [
+				{
+					`),t("span",{class:"hljs-attr"},'"user_created"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),l(`
+					}
+				},
+				{
+					`),t("span",{class:"hljs-attr"},'"status"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_in"'),l(": ["),t("span",{class:"hljs-string"},'"published"'),l(", "),t("span",{class:"hljs-string"},'"draft"'),l(`]
+					}
+				}
+			]
+		},
+		{
+			`),t("span",{class:"hljs-attr"},'"_and"'),l(`: [
+				{
+					`),t("span",{class:"hljs-attr"},'"user_created"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_neq"'),l(": "),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),l(`
+					}
+				},
+				{
+					`),t("span",{class:"hljs-attr"},'"status"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_in"'),l(": ["),t("span",{class:"hljs-string"},'"published"'),l(`]
+					}
+				}
+			]
+		}
+	]
+}
+`)])],-1),C=t("h3",{id:"some-vs-none-in-one-to-many"},[l("Some vs None in One-to-Many "),t("a",{class:"header-anchor",href:"#some-vs-none-in-one-to-many"},"#")],-1),S=t("p",null,"When applying filters to a one-to-many field, Directus will default to a \u201Csome\u201D search, for example in:",-1),k=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"categories"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"name"'),l(`: {
+			`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"Recipe"'),l(`
+		}
+	}
+}
+`)])],-1),L=t("p",null,[l("the top level parent will be returned if "),t("em",null,"one of"),l(" the categories has the name "),t("code",null,"Recipe"),l(". This behavior can be overridden by using the explicit "),t("code",null,"_some"),l(" and "),t("code",null,"_none"),l(" operators, for example:")],-1),V=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"categories"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_none"'),l(`: {
+			`),t("span",{class:"hljs-attr"},'"name"'),l(`: {
+				`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"Recipe"'),l(`
+			}
+		}
+	}
+}
+`)])],-1),W=t("p",null,"will fetch all parent items that don\u2019t have the category \u201CRecipe\u201D",-1),A=t("h2",{id:"dynamic-variables"},[l("Dynamic Variables "),t("a",{class:"header-anchor",href:"#dynamic-variables"},"#")],-1),B=t("p",null,[l("In addition to static values, you can also filter against "),t("em",null,"dynamic"),l(" values using the following variables.")],-1),G=t("ul",null,[t("li",null,[t("code",null,"$CURRENT_USER"),l(" \u2014 The primary key of the currently authenticated user")]),t("li",null,[t("code",null,"$CURRENT_ROLE"),l(" \u2014 The primary key of the role for the currently authenticated user")]),t("li",null,[t("code",null,"$NOW"),l(" \u2014 The current timestamp")]),t("li",null,[t("code",null,"$NOW(<adjustment>)"),l(" - The current timestamp plus/minus a given distance, for example "),t("code",null,"$NOW(-1 year)"),l(", "),t("code",null,"$NOW(+2 hours)")])],-1),M={class:"tip hint"},P=t("div",{class:"hint-title"},"Functions",-1),Y=l("You can also use "),J=l("Function Parameters"),z=l(" when building Filters."),H=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Nested User / Role variables in Permissions"),t("p",null,[l("When configuring permissions, "),t("code",null,"$CURRENT_USER"),l(" and "),t("code",null,"$CURRENT_ROLE"),l(" allow you to specify any (nested) field under the current user/role as well as the root ID. For example: "),t("code",null,"$CURRENT_ROLE.name"),l(" or "),t("code",null,"$CURRENT_USER.avatar.filesize"),l(". This includes custom fields that were added to the directus_users/directus_roles tables.")]),t("p",null,"Note: This feature is only available for permissions, validation, and presets. Regular filters and conditional fields currently only support the root ID.")],-1),tt="Filter Rules",lt=!1,nt={name:"filter-rules",setup(Z,{expose:a}){const n={title:"Filter Rules",modularExtension:!1};return a({frontmatter:n}),(K,Q)=>{const o=e("router-link"),r=e("docs-wrapper");return u(),i(r,{frontmatter:n},{default:s(()=>[t("div",c,[h,p,_,f,g,m,y,b,v,j,R,w,x,E,N,O,I,T,q,D,U,F,$,C,S,k,L,V,W,A,B,G,t("div",M,[P,t("p",null,[Y,d(o,{to:"/docs/reference/query/#functions"},{default:s(()=>[J]),_:1}),z])]),H])]),_:1})}}};export{nt as default,lt as modularExtension,tt as title};

package/dist/assets/filters.43e74661.js

@@ -0,0 +1 @@
+import{a as n,o as d,b as c,w as o,g as e,e as i,B as t}from"./runtime-core.esm-bundler.e6808e6c.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results, restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.")],-1),_=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filters-20220303A.webp",alt:"Filters"})],-1),p=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#how-it-works"},"How it Works")]),e("li",null,[e("a",{href:"#and%2For-groups"},"AND/OR Groups")]),e("li",null,[e("a",{href:"#dynamic-variables"},"Dynamic Variables")]),e("li",null,[e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections")]),e("li",null,[e("a",{href:"#unfilterable-fields"},"Unfilterable Fields")]),e("li",null,[e("a",{href:"#extensibility-options"},"Extensibility Options")]),e("li",null,[e("a",{href:"#more-help"},"More Help")])])])],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"There Are Two Filters Documents",-1),y=t("This page is a non-technical guide to using Filters. For more technical info, see "),g=t("Filter-Rules"),b=t("."),w=e("h2",{id:"how-it-works"},[t("How it Works "),e("a",{class:"header-anchor",href:"#how-it-works"},"#")],-1),F={class:"tip hint"},v=e("div",{class:"hint-title"},"Assumed Knowledge",-1),A=t("Filters are intuitive to use, but get quite nuanced as complexity increases. In order to use Filters effectively, you will need to understand the Field "),k=t("(aka "),C=t("data model"),O=t(")"),x=t(" being filtered as well as any relevant "),R=t("Users, Roles and Permissions"),D=t("."),N=t("A basic filter is composed of 3 parts: A "),G=e("strong",null,"Field",-1),I=t(" from the Collection being Filtered, a logical "),V=t("Operator"),E=t(", and some specified "),H=e("strong",null,"Value",-1),T=t(" to filter for within each Item\u2019s Field."),U=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/how-filters-work-20220303A.mp4",type:"video/mp4"})],-1),W=e("ol",{start:"2"},[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"filter_list"),t(" or "),e("strong",null,"\u201CAdd Filter\u201D"),t(".")]),e("li",null,"Select the Field to filter by."),e("li",null,"Select the Operator as desired."),e("li",null,"Define the Value to filter for.")],-1),S=e("p",null,[t("From here, you can set multiple Filters at once, filter by "),e("a",{href:"#filtering-by-related-collections"},"Fields in related Collections"),t(", set Values with "),e("a",{href:"#dynamic-variables"},"Dynamic Variables"),t(", as well as apply "),e("a",{href:"#and-or-groups"},"AND/OR Groups"),t(".")],-1),B={class:"tip hint"},$=e("div",{class:"hint-title"},"Operators",-1),j=t("The Field type will determine the kinds of Operators that can be used on it. In fact, some Fields cannot be filtered at all (read more in "),P=e("a",{href:"#unfilterable-fields"},"Unfilterable Fields",-1),q=t("). Once a Field is selected, the permitted operators will automatically display. An exhaustive list of Operators and what they do can be found in the more technical "),L=t("Filter Rules"),M=t(" document."),Y=e("h2",{id:"and%2For-groups"},[t("AND/OR Groups "),e("a",{class:"header-anchor",href:"#and%2For-groups"},"#")],-1),z=e("p",null,[e("code",null,"AND"),t(" Groups give the option to filter for Items that meet "),e("em",null,"all of several criteria"),t(". On the other hand, "),e("code",null,"OR"),t(" Groups filter for Items that meet "),e("em",null,"any one of several criteria"),t(".")],-1),K=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/and-or-groups-20220303A.webp",alt:"AND/OR Groups"})],-1),J=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click \u201CAnd/OR Group\u201D at the very top of the dropdown menu."),e("li",null,[t("Click the AND/OR text to toggle: "),e("ul",null,[e("li",null,[e("code",null,"AND"),t(" \u2013 Selects Items that meet every single criteria.")]),e("li",null,[e("code",null,"OR"),t(" \u2013 Selects Items that meet one of several criteria.")])])]),e("li",null,"Click \u201CAdd Filter\u201D again."),e("li",null,"Configure the Field, Operator, and Value as desired."),e("li",null,[t("Click and hold "),e("span",{mi:"",icon:""},"drag_indicator"),t(" to drag a Filter and nest it under an AND/OR Group.")])],-1),Q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Why do we need AND Groups?"),e("p",null,[t("Filters actually default to "),e("code",null,"AND"),t(" Group behavior automatically. However, when Filters are nested inside of an OR Group, they of course switch to "),e("code",null,"OR"),t(" Group behavior. So an AND Group is necessary in cases where you want to meet multiple conditions inside of OR Groups.")])],-1),X=e("h2",{id:"dynamic-variables"},[t("Dynamic Variables "),e("a",{class:"header-anchor",href:"#dynamic-variables"},"#")],-1),Z=e("p",null,"The following video shows how to filter for Blog posts written within the past 60 days.",-1),ee=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/dynamic-variables-20220307A.mp4",type:"video/mp4"})],-1),te=t("The following Dynamic Variables are built into Directus to make Filtering easier: "),oe=e("code",null,"$CURRENT_USER",-1),le=t(", "),ie=e("code",null,"$CURRENT_ROLE",-1),se=t(", "),ne=e("code",null,"$NOW",-1),re=t(" and "),ae=e("code",null,"$NOW(<adjustment>)",-1),de=t(". For more information, please see the Dynamic Variables section in "),ce=t("Filter Rules"),ue=t("."),he=e("h2",{id:"filtering-by-related-collections"},[t("Filtering by Related Collections "),e("a",{class:"header-anchor",href:"#filtering-by-related-collections"},"#")],-1),_e=e("p",null,[t("You may need to run filters on one Collection "),e("em",null,"based on information in another related Collection"),t(". Here are a few examples of when that might happen:")],-1),pe=e("ul",null,[e("li",null,[t("Book authors that also wrote screenplays (filters "),e("code",null,"authors"),t(", uses "),e("code",null,"screenplays"),t(").")]),e("li",null,[t("Products with a 5 star customer review (filters "),e("code",null,"products"),t(", uses "),e("code",null,"reviews"),t(").")]),e("li",null,[t("Accounts with active user login within the last 12 months (filters "),e("code",null,"accounts"),t(", uses "),e("code",null,"logins"),t(").")])],-1),fe=e("p",null,[t("This can span across any number of relationally linked Collections. For example, you could filter for customers that bought rock songs, where the "),e("code",null,"customers"),t(" and "),e("code",null,"genres"),t(" Collections are linked by "),e("code",null,"customers"),t(" -> "),e("code",null,"invoices"),t(" -> "),e("code",null,"invoice-items"),t(" -> "),e("code",null,"tracks"),t(" -> "),e("code",null,"genres"),t(".")],-1),me=t("You will notice a "),ye=e("span",{mi:"",icon:""},"chevron_right",-1),ge=t(" icon beside relational Fields. When you click on any "),be=t("Alias"),we=t(" Field, all the Fields for that associated Collection pop down. If you select one of these Fields, you can run Filters on the current Collection by Field values in a related Collection."),Fe=e("p",null,"Here are step-by-step instructions on how to filter by Fields in other Collections:",-1),ve=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filtering-by-related-collections-20220303A.mp4",type:"video/mp4"})],-1),Ae=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click the desired relational Field. This will pop down and display the related Collection Fields."),e("li",null,"Select a Field from this related Collection."),e("li",null,"Set the Operator and Value as desired.")],-1),ke=e("h2",{id:"unfilterable-fields"},[t("Unfilterable Fields "),e("a",{class:"header-anchor",href:"#unfilterable-fields"},"#")],-1),Ce=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/unfilterable-fields-20220303A.webp",alt:"Unfilterable Fields"})],-1),Oe=e("p",null,[t("Not all Fields can be filtered. As seen above in "),e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections"),t(", Alias Fields cannot be filtered; they instead provide a dropdown menu to access Fields from a related Collection. Additionally, the \u201CPresentation\u201D and \u201CGroup\u201D Fields cannot be filtered at all and will not appear as an option in Filters.")],-1),xe=e("h2",{id:"extensibility-options"},[t("Extensibility Options "),e("a",{class:"header-anchor",href:"#extensibility-options"},"#")],-1),Re=e("p",null,"Directus Core is completely open-source, modular and extensible. Extensions allow you to expand or modify any part of Directus to fit your needs. Here are some great resources to get started down that track.",-1),De=t("Extensions > Introduction"),Ne=t("Extensions > Creating Extensions"),Ge=t("Contributing > Introduction"),Ie=t("Contributing > Codebase Overview"),Ve=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Accelerated Development"),e("p",null,[t("Working on an enterprise project and looking to outsource or financially sponsor the development of a Shares extension? Contact "),e("a",{href:"https://directus.io/contact/",target:"_blank",rel:"noopener noreferrer"},"our team")])],-1),Ee=e("h2",{id:"more-help"},[t("More Help "),e("a",{class:"header-anchor",href:"#more-help"},"#")],-1),He=e("p",null,[t("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),Be="Filters",$e=!1,je={name:"filters",setup(Te,{expose:r}){const s={title:"Filters",modularExtension:!1};return r({frontmatter:s}),(Ue,We)=>{const l=n("router-link"),a=n("docs-wrapper");return d(),c(a,{frontmatter:s},{default:o(()=>[e("div",u,[h,_,p,e("div",f,[m,e("p",null,[y,i(l,{to:"/docs/reference/filter-rules/"},{default:o(()=>[g]),_:1}),b])]),w,e("div",F,[v,e("p",null,[A,e("em",null,[k,i(l,{to:"/docs/configuration/data-model/"},{default:o(()=>[C]),_:1}),O]),x,i(l,{to:"/docs/configuration/users-roles-permissions.md"},{default:o(()=>[R]),_:1}),D])]),e("p",null,[N,G,I,i(l,{to:"/docs/reference/filter-rules/#filter-operators"},{default:o(()=>[V]),_:1}),E,H,T]),U,W,S,e("div",B,[$,e("p",null,[j,P,q,i(l,{to:"/docs/reference/filter-rules/#filter-operators"},{default:o(()=>[L]),_:1}),M])]),Y,z,K,J,Q,X,Z,ee,e("p",null,[te,oe,le,ie,se,ne,re,ae,de,i(l,{to:"/docs/reference/filter-rules/"},{default:o(()=>[ce]),_:1}),ue]),he,_e,pe,fe,e("p",null,[me,ye,ge,i(l,{to:"/docs/getting-started/glossary/#alias"},{default:o(()=>[be]),_:1}),we]),Fe,ve,Ae,ke,Ce,Oe,xe,Re,e("ul",null,[e("li",null,[i(l,{to:"/docs/extensions/introduction/"},{default:o(()=>[De]),_:1})]),e("li",null,[i(l,{to:"/docs/extensions/creating-extensions/"},{default:o(()=>[Ne]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/introduction/"},{default:o(()=>[Ge]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/codebase-overview/"},{default:o(()=>[Ie]),_:1})])]),Ve,Ee,He])]),_:1})}}};export{je as default,$e as modularExtension,Be as title};

package/dist/assets/flows.323ce75f.js

@@ -0,0 +1,15 @@
+import{a as l,o as c,b as d,w as o,g as e,e as n,B as t}from"./runtime-core.esm-bundler.e6808e6c.js";const h={class:"markdown-body"},_=e("blockquote",null,[e("p",null,"Flows enable custom, event-driven data processing and task automation within Directus. Each Flow is composed of one Trigger, followed by a series of Operations.")],-1),u=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#what's-a-flow%3F"},"What's a Flow?")]),e("li",null,[e("a",{href:"#create-a-flow"},"Create a Flow")]),e("li",null,[e("a",{href:"#the-flow-object"},"The Flow Object")]),e("li",null,[e("a",{href:"#logs"},"Logs")])])])],-1),p={class:"tip hint"},w=e("div",{class:"hint-title"},"Learn More",-1),f=t("There is also dedicated API documentation on "),g=t("Flows"),m=t(" and "),b=t("Operations"),O=t("."),y=e("h2",{id:"what%E2%80%99s-a-flow%3F"},[t("What\u2019s a Flow? "),e("a",{class:"header-anchor",href:"#what%E2%80%99s-a-flow%3F"},"#")],-1),F=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/whats-a-flow-20220603A.webp",alt:"What's a Flow?"})],-1),v=t("Each Flow begins with one Trigger, which defines the actions that start the Flow. Triggers can be an event or action within the app, an incoming webhook, a cron job, or a manual click of a button. Please see the documentation on "),j=t("Triggers"),k=t(" for more details."),T=t("Operations are the actions performed after the Trigger. An operation can be creating new Items in a Collection, sending off emails, pushing "),A=e("em",null,"in-app",-1),x=t(" notifications, or sending webhooks, just to name a few. You can even set up divergent chains of Flow Operations, which execute conditionally, based on whether one Operation passed or failed. A "),C=t("console log"),S=t(" is also included to help design and troubleshoot your Flows and ensure data is passed on as intended. Check out the documentation on "),P=t("Operations"),N=t(" for more details."),E=e("p",null,[t("Once a Flow is triggered, Directus creates a "),e("a",{href:"#the-flow-object"},"Flow Object"),t(", which stores data from the Trigger event. As each Operation in the flow executes, the data generated is added onto this Flow Object, and every Operation in a Flow has access to it.")],-1),$=e("h2",{id:"create-a-flow"},[t("Create a Flow "),e("a",{class:"header-anchor",href:"#create-a-flow"},"#")],-1),D=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Create a Flow"},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/create-a-flow-20220603A.mp4",type:"video/mp4"})],-1),L=e("p",null,"To create a Flow, follow these steps:",-1),V=e("li",null,[t("Navigate to "),e("strong",null,"\u201CSettings > Flows\u201D"),t(" and click "),e("span",{mi:"",btn:""},"add"),t(" in the Page Header. A side menu will appear.")],-1),W=e("li",null,[t("Under "),e("strong",null,"Flow Setup"),t(", fill in a name for the Flow."),e("br"),t(" Optional: Set a status, material icon, description or color to help remember the Flow.")],-1),B=t("Select your "),J=e("strong",null,"Activity and Logs Tracking",-1),G=t(" preference as desired."),H=e("br",null,null,-1),I=t(" To learn more, please see "),Y=t("Activity"),q=t(" and "),M=t("Logs"),K=t("."),R=t("Click "),U=e("span",{mi:"",btn:""},"arrow_forward",-1),z=t(" to navigate to "),Q=e("strong",null,"Trigger Setup",-1),X=t(", select a "),Z=t("Trigger"),ee=t(" type and configure as desired."),te=e("li",null,[t("Click "),e("span",{mi:"",btn:""},"done"),t(" in the Menu Header to be taken to the Flow Grid Area."),e("br"),t(" You\u2019ll see the Trigger Panel on the Flow Grid.")],-1),oe=e("li",null,[t("On the Trigger Panel, click "),e("span",{mi:""},"add"),t(" and the "),e("strong",null,"Create Operation"),t(" side menu will open.")],-1),se=t("Choose a name and the "),ne=t("Operation"),ae=t(" type, and configure as desired."),le=e("br",null,null,-1),ie=t(" Directus will convert the unique name into an Operation Key, used on the "),re=e("a",{href:"#the-flow-object"},"Flow Object",-1),ce=t("."),de=e("br",null,null,-1),he=t(" If you don\u2019t choose a name, the system will auto-generate a name and key."),_e=e("li",null,[t("Next, click "),e("span",{mi:"",btn:""},"done"),t(" in the Page Header to confirm your choices and return to the Flow Grid Area.")],-1),ue=e("li",null,[t("On the newly created Operation Panel: "),e("ul",null,[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"add"),t(" to add an Operation to follow the successful execution of the current Operation.")]),e("li",null,[t("Click "),e("span",{mi:"",icon:""},"remove"),t(" to add an Operation should the current Operation fail.")])])],-1),pe=e("li",null,"Repeat steps 8-10 to add to your Flow.",-1),we=e("li",null,[e("strong",null,"Optional:"),t(" To edit a Trigger or Operation Panel, click "),e("span",{mi:"",icon:""},"edit"),t(" and make any necessary edits.")],-1),fe=e("li",null,[e("strong",null,"Optional:"),t(" To delete an Operation Panel, click "),e("span",{mi:"",icon:""},"more_vert"),t(" then "),e("span",{mi:"",icon:"",dngr:""},"delete"),t(".")],-1),ge=e("h2",{id:"the-flow-object"},[t("The Flow Object "),e("a",{class:"header-anchor",href:"#the-flow-object"},"#")],-1),me=e("p",null,"When a Flow is triggered, Directus creates a JSON object to store all data generated within the Flow. When you create an Operation, this generates a key that appends to the Flow Object when the Operation executes. The key is used to add the associated Operation\u2019s data onto the Flows Object. As each Operation in the Flow executes, it has access to the Flow Object and therefore the data generated from preceding Operations.",-1),be=e("p",null,[t("The following JSON object is a simple example of a Flow with two Operations. The "),e("code",null,"$trigger"),t(", "),e("code",null,"$last"),t(", and "),e("code",null,"$accountability"),t(" keys are included on every Flow. An Operation key will be generated for each Operation that executes successfully.")],-1),Oe=e("pre",null,[e("code",{class:"language-JSON"},[t(`{
+   `),e("span",{class:"hljs-attr"},'"$trigger"'),t(": {}, "),e("span",{class:"hljs-comment"},"// Data generated by the Flow's Trigger."),t(`
+   `),e("span",{class:"hljs-attr"},'"$last"'),t(": "),e("span",{class:"hljs-literal"},"null"),t(", "),e("span",{class:"hljs-comment"},"// Data from the last Operation in the flow, for easy access!"),t(`
+   `),e("span",{class:"hljs-attr"},'"$accountability"'),t(": {}, "),e("span",{class:"hljs-comment"},"// Provides details on who/what tripped the Trigger and generated this Flow Object."),t(`
+   `),e("span",{class:"hljs-attr"},'"operation_key"'),t(": { "),e("span",{class:"hljs-comment"},"// The data (if any) generated by the first Operation."),t(`
+			`),e("span",{class:"hljs-attr"},'"some_nested_key"'),t(": "),e("span",{class:"hljs-string"},'"Some nested value."'),t(`,
+    },
+	`),e("span",{class:"hljs-attr"},'"operation_key_2"'),t(": "),e("span",{class:"hljs-literal"},"null"),t(", "),e("span",{class:"hljs-comment"},"// Value is null if no data was generated during an Operation."),t(`
+}
+`)])],-1),ye=e("h3",{id:"flow-variables"},[t("Flow Variables "),e("a",{class:"header-anchor",href:"#flow-variables"},"#")],-1),Fe=e("p",null,"The Flow Object keys serve as variables that allow data access from every Flow Operation. Variables must be passed using the following double-moustache syntax. You can even use dot-notation to extract sub-nested values.",-1),ve=e("pre",null,[e("code",{class:"language-JSON"},[t(`{
+   `),e("span",{class:"hljs-attr"},'"operation_key_3"'),t(`: {
+			`),e("span",{class:"hljs-attr"},'"user"'),t(": "),e("span",{class:"hljs-string"},'"{{ $accountability.user }}"'),t(`,
+	 }
+}
+`)])],-1),je=e("h2",{id:"logs"},[t("Logs "),e("a",{class:"header-anchor",href:"#logs"},"#")],-1),ke=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/logs-20220603A.mp4",type:"video/mp4"})],-1),Te=e("p",null,"Accessible from the Sidebar, Logs store information for each Flow execution. Each log will display information from Triggers as well as each Operation in the Flow.",-1),Pe="Flows",Ne=!1,Ee={name:"flows",setup(Ae,{expose:i}){const a={title:"Flows",modularExtension:!1};return i({frontmatter:a}),(xe,Ce)=>{const s=l("router-link"),r=l("docs-wrapper");return c(),d(r,{frontmatter:a},{default:o(()=>[e("div",h,[_,u,e("div",p,[w,e("p",null,[f,n(s,{to:"/docs/reference/system/flows"},{default:o(()=>[g]),_:1}),m,n(s,{to:"/docs/reference/system/operations"},{default:o(()=>[b]),_:1}),O])]),y,F,e("p",null,[v,n(s,{to:"/docs/configuration/flows/triggers"},{default:o(()=>[j]),_:1}),k]),e("p",null,[T,A,x,n(s,{to:"/docsconfiguration/flows/operations/#log-to-console"},{default:o(()=>[C]),_:1}),S,n(s,{to:"/docs/configuration/flows/operations"},{default:o(()=>[P]),_:1}),N]),E,$,D,L,e("ol",null,[V,W,e("li",null,[B,J,G,H,I,n(s,{to:"/docs/reference/system/activity/"},{default:o(()=>[Y]),_:1}),q,n(s,{to:"/docs/#logs"},{default:o(()=>[M]),_:1}),K]),e("li",null,[R,U,z,Q,X,n(s,{to:"/docsconfiguration/flows/triggers"},{default:o(()=>[Z]),_:1}),ee]),te,oe,e("li",null,[se,n(s,{to:"/docsconfiguration/flows/operations"},{default:o(()=>[ne]),_:1}),ae,le,ie,re,ce,de,he]),_e,ue,pe,we,fe]),ge,me,be,Oe,ye,Fe,ve,je,ke,Te])]),_:1})}}};export{Ee as default,Ne as modularExtension,Pe as title};