@directus/app 9.14.0 → 9.14.3

package/dist/assets/files.7c2ccfe2.js

@@ -1,189 +0,0 @@
-import{a as i,o as d,b as c,w as t,g as e,e as a,B as s}from"./runtime-core.esm-bundler.b1f35d24.js";const h={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",tabindex:"-1"},[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:"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",tabindex:"-1"},[s("Downloading a File "),e("a",{class:"header-anchor",href:"#downloading-a-file"},"#")],-1),b=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",tabindex:"-1"},[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),y=e("hr",null,null,-1),j=e("h2",{id:"requesting-a-thumbnail",tabindex:"-1"},[s("Requesting a Thumbnail "),e("a",{class:"header-anchor",href:"#requesting-a-thumbnail"},"#")],-1),x={class:"two-up"},v={class:"left"},q=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),w=e("h3",{id:"preset-transformations",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[s("Advanced "),e("a",{class:"header-anchor",href:"#advanced"},"#")]),e("pre",null,[e("code",null,`?transforms=[
-	["blur", 45],
-	["tint", "rgb(255, 0, 0)"],
-	["expand", { "right": 200, "bottom": 150 }]
-]
-`)])],-1),L=e("hr",null,null,-1),X=e("h2",{id:"the-file-object",tabindex:"-1"},[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 "),te=s("folders"),le=s("."),ae=e("code",null,"uploaded_by",-1),ne=s(),ie=e("strong",null,"many-to-one",-1),oe=e("br",null,null,-1),re=s(" Who uploaded the file. Many-to-one to "),de=s("users"),ce=s("."),he=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"),be=s("."),ye=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),xe=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),ve=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),qe=e("p",null,[e("code",null,"description"),s(),e("strong",null,"string"),e("br"),s(" Description of the file.")],-1),we=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(`,
-	`),e("span",{class:"hljs-attr"},'"filename_download"'),s(": "),e("span",{class:"hljs-string"},'"paulo-silva-vSRgXtQuns8-unsplash.jpg"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"title"'),s(": "),e("span",{class:"hljs-string"},'"Paulo Silva (via Unsplash)"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"type"'),s(": "),e("span",{class:"hljs-string"},'"image/jpeg"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"folder"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
-	`),e("span",{class:"hljs-attr"},'"uploaded_by"'),s(": "),e("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"uploaded_on"'),s(": "),e("span",{class:"hljs-string"},'"2021-02-04T11:37:41-05:00"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"modified_by"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
-	`),e("span",{class:"hljs-attr"},'"modified_on"'),s(": "),e("span",{class:"hljs-string"},'"2021-02-04T11:37:42-05:00"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"filesize"'),s(": "),e("span",{class:"hljs-number"},"3442252"),s(`,
-	`),e("span",{class:"hljs-attr"},'"width"'),s(": "),e("span",{class:"hljs-number"},"3456"),s(`,
-	`),e("span",{class:"hljs-attr"},'"height"'),s(": "),e("span",{class:"hljs-number"},"5184"),s(`,
-	`),e("span",{class:"hljs-attr"},'"duration"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
-	`),e("span",{class:"hljs-attr"},'"description"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
-	`),e("span",{class:"hljs-attr"},'"location"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
-	`),e("span",{class:"hljs-attr"},'"tags"'),s(": ["),e("span",{class:"hljs-string"},'"photo"'),s(", "),e("span",{class:"hljs-string"},'"pretty"'),s(`],
-	`),e("span",{class:"hljs-attr"},'"metadata"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"icc"'),s(`: {
-			`),e("span",{class:"hljs-attr"},'"version"'),s(": "),e("span",{class:"hljs-string"},'"2.1"'),s(`,
-			`),e("span",{class:"hljs-attr"},'"intent"'),s(": "),e("span",{class:"hljs-string"},'"Perceptual"'),s(`,
-			`),e("span",{class:"hljs-attr"},'"cmm"'),s(": "),e("span",{class:"hljs-string"},'"lcms"'),s(`,
-			`),e("span",{class:"hljs-attr"},'"deviceClass"'),s(": "),e("span",{class:"hljs-string"},'"Monitor"'),s(`,
-			`),e("span",{class:"hljs-attr"},'"colorSpace"'),s(": "),e("span",{class:"hljs-string"},'"RGB"'),s(`,
-			`),e("span",{class:"hljs-attr"},'"connectionSpace"'),s(": "),e("span",{class:"hljs-string"},'"XYZ"'),s(`,
-			`),e("span",{class:"hljs-attr"},'"platform"'),s(": "),e("span",{class:"hljs-string"},'"Apple"'),s(`,
-			`),e("span",{class:"hljs-attr"},'"creator"'),s(": "),e("span",{class:"hljs-string"},'"lcms"'),s(`,
-			`),e("span",{class:"hljs-attr"},'"description"'),s(": "),e("span",{class:"hljs-string"},'"c2"'),s(`,
-			`),e("span",{class:"hljs-attr"},'"copyright"'),s(": "),e("span",{class:"hljs-string"},'""'),s(`
-		}
-	}
-}
-`)])])],-1),Ee=e("hr",null,null,-1),Ae=e("h2",{id:"list-files",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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 ->"),Ze=e("h3",{id:"graphql",tabindex:"-1"},[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-1",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-1"},"#")],-1),Je=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	files {
-		id
-		filename_disk
-	}
-}
-`)])],-1),Ve=e("hr",null,null,-1),$e=e("h2",{id:"retrieve-a-file",tabindex:"-1"},[s("Retrieve a File "),e("a",{class:"header-anchor",href:"#retrieve-a-file"},"#")],-1),es=e("p",null,"Retrieve a single file by primary key.",-1),ss={class:"two-up"},ts={class:"left"},ls=e("h3",{id:"query-parameters-1",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),as=s("Supports all "),ns=s("global query parameters"),is=s("."),os=e("h3",{id:"returns-1",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),rs=e("p",null,[s("Returns a "),e("a",{href:"#the-file-object"},"file object"),s(" if a valid primary key was provided.")],-1),ds=e("div",{class:"right"},[e("h3",{id:"rest-api-1",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),e("pre",null,[e("code",null,`GET /files/:id
-`)]),e("h5",{id:"example-2",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",null,`GET /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d
-`)]),e("h3",{id:"graphql-1",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-1"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
-	files_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): directus_files
-}
-`)])]),e("h5",{id:"example-3",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	files_by_id(id: `),e("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),s(`) {
-		id
-		filename_disk
-	}
-}
-`)])])],-1),cs=e("h2",{id:"upload-a-file",tabindex:"-1"},[s("Upload a File "),e("a",{class:"header-anchor",href:"#upload-a-file"},"#")],-1),hs=e("p",null,"Upload/create a new file.",-1),us={class:"two-up"},ps={class:"left"},fs=e("p",null,[s("To upload a file, use "),e("code",null,"multipart/form-data"),s(" as the encoding type, instead of JSON.")],-1),_s=e("p",null,[s("The file contents has to be provided in a part called "),e("code",null,"file"),s(". All other properties of "),e("a",{href:"#the-file-object"},"the file object"),s(" can be provided as parts as well.")],-1),ms=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Order Matters"),e("p",null,[s("Make sure to define the non-file properties "),e("em",null,"first"),s(". This ensures that the file metadata is associated with the correct file.")])],-1),gs=e("p",null,"You can upload multiple files at a time by repeating the payload with different contents, for example:",-1),bs=e("pre",null,[e("code",null,`--__X_BOUNDARY__
-Content-Disposition: form-data; name="title"
-
-Example
---__X_BOUNDARY__
-Content-Disposition: form-data; name="file"; filename="paulo-silva-vSRgXtQuns8-unsplash.jpg"
-Content-Type: image/jpeg
-
-// binary data
-
---__X_BOUNDARY__
-Content-Disposition: form-data; name="title"
-
-Another Title
---__X_BOUNDARY__
-Content-Disposition: form-data; name="file"; filename="mae-mu-GFhqNX1gE9E-unsplash.jpg"
-Content-Type: image/jpeg
-
-// binary data
-`)],-1),ys=e("p",null,[s("In JavaScript, this can be achieved using the native "),e("code",null,"FormData"),s(" class:")],-1),js=e("pre",null,[e("code",{class:"language-js"},[e("span",{class:"hljs-keyword"},"import"),s(" axios "),e("span",{class:"hljs-keyword"},"from"),s(),e("span",{class:"hljs-string"},"'axios'"),s(`;
-
-`),e("span",{class:"hljs-keyword"},"const"),s(" fileInput = "),e("span",{class:"hljs-built_in"},"document"),s(".querySelector("),e("span",{class:"hljs-string"},`'input[type="file"]'`),s(`);
-`),e("span",{class:"hljs-keyword"},"const"),s(" formData = "),e("span",{class:"hljs-keyword"},"new"),s(` FormData();
-
-formData.append(`),e("span",{class:"hljs-string"},"'title'"),s(", "),e("span",{class:"hljs-string"},"'My First File'"),s(`);
-formData.append(`),e("span",{class:"hljs-string"},"'file'"),s(", fileInput.files["),e("span",{class:"hljs-number"},"0"),s(`]);
-
-`),e("span",{class:"hljs-keyword"},"await"),s(" axios.post("),e("span",{class:"hljs-string"},"'/files'"),s(`, formData);
-`)])],-1),xs=e("h3",{id:"query-parameters-2",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),vs=s("Supports all "),qs=s("global query parameters"),ws=s("."),Ts=e("h3",{id:"returns-2",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ks=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the uploaded file, or an array of "),e("a",{href:"#the-file-object"},"file objects"),s(" if multiple files were uploaded at once.")],-1),Rs=e("div",{class:"right"},[e("pre",null,[e("code",null,`POST /files
-`)]),e("pre",null,[e("code",null,`// Request
-
-Content-Type: multipart/form-data; charset=utf-8; boundary=__X_BOUNDARY__
-Content-Length: 3442422
-
---__X_BOUNDARY__
-Content-Disposition: form-data; name="file"; filename="paulo-silva-vSRgXtQuns8-unsplash.jpg"
-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?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",tabindex:"-1"},[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-3",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Cs=s("Supports all "),Is=s("global query parameters"),Os=s("."),Qs=e("h3",{id:"request-body",tabindex:"-1"},[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-3",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-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-2",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`POST /files/import
-`)]),e("h5",{id:"example-4",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /files/import"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"url"'),s(": "),e("span",{class:"hljs-string"},'"https://source.unsplash.com/random"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"title"'),s(": "),e("span",{class:"hljs-string"},'"Example"'),s(`
-	}
-}
-`)])]),e("h3",{id:"graphql-2",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	import_file(url:`),e("span",{class:"hljs-type"}," String"),s(`!, data: create_directus_files_input!): directus_files
-}
-`)])]),e("h5",{id:"example-5",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	import_file(url: `),e("span",{class:"hljs-string"},'"https://source.unsplash.com/random"'),s(", data: { title: "),e("span",{class:"hljs-string"},'"Example"'),s(` }) {
-		id
-	}
-}
-`)])])],-1),Ys=e("hr",null,null,-1),Ms=e("h2",{id:"update-a-file",tabindex:"-1"},[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-4",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Hs=s("Supports all "),Ws=s("global query parameters"),Ks=s("."),Js=e("h3",{id:"request-body-1",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-1"},"#")],-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-4",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),et=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file object"),s(" for the updated file.")],-1),st=e("div",{class:"right"},[e("h3",{id:"rest-api-3",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`PATCH /files/:id
-`)]),e("h5",{id:"example-6",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"title"'),s(": "),e("span",{class:"hljs-string"},'"Example"'),s(`
-}
-`)])]),e("h3",{id:"graphql-3",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	update_files_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!, data: update_directus_files_input!): directus_files
-}
-`)])]),e("h5",{id:"example-7",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	update_files_item(id: `),e("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),s(", data: { title: "),e("span",{class:"hljs-string"},'"Example"'),s(` }) {
-		id
-		title
-	}
-}
-`)])])],-1),tt=e("hr",null,null,-1),lt=e("h2",{id:"update-multiple-files",tabindex:"-1"},[s("Update Multiple Files "),e("a",{class:"header-anchor",href:"#update-multiple-files"},"#")],-1),at=e("p",null,"Update multiple files at the same time.",-1),nt={class:"two-up"},it={class:"left"},ot=e("h3",{id:"query-parameters-5",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),rt=s("Supports all "),dt=s("global query parameters"),ct=s("."),ht=e("h3",{id:"request-body-2",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),ut=e("div",{class:"definitions"},[e("p",null,[e("code",null,"keys"),s(),e("strong",null,"Required"),e("br"),s(" Array of primary keys of the files you\u2019d like to update.")]),e("p",null,[e("code",null,"data"),s(),e("strong",null,"Required"),e("br"),s(" Any of "),e("a",{href:"#the-file-object"},"the file object"),s("\u2019s properties.")])],-1),pt=e("h3",{id:"returns-5",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),ft=e("p",null,[s("Returns the "),e("a",{href:"#the-file-object"},"file objects"),s(" for the updated files.")],-1),_t=e("div",{class:"right"},[e("h3",{id:"rest-api-4",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`PATCH /files
-`)]),e("h5",{id:"example-8",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /files"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"keys"'),s(": ["),e("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s(", "),e("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s(`],
-	`),e("span",{class:"hljs-attr"},'"data"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"tags"'),s(": ["),e("span",{class:"hljs-string"},'"cities"'),s(`]
-	}
-}
-`)])]),e("h3",{id:"graphql-4",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	update_files_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!, data: update_directus_files!): [directus_files]
-}
-`)])]),e("h5",{id:"example-9",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	update_files_items(
-		ids: [`),e("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s(", "),e("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s(`]
-		data: { tags: [`),e("span",{class:"hljs-string"},'"cities"'),s(`] }
-	)
-}
-`)])])],-1),mt=e("hr",null,null,-1),gt=e("h2",{id:"delete-a-file",tabindex:"-1"},[s("Delete a File "),e("a",{class:"header-anchor",href:"#delete-a-file"},"#")],-1),bt=e("p",null,"Delete an existing file.",-1),yt={class:"two-up"},jt={class:"left"},xt=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Destructive"),e("p",null,"This will also delete the file from disk.")],-1),vt=e("h3",{id:"query-parameters-6",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),qt=s("Supports all "),wt=s("global query parameters"),Tt=s("."),kt=e("h3",{id:"returns-6",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Rt=e("p",null,"Empty response.",-1),Et=e("div",{class:"right"},[e("h3",{id:"rest-api-5",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`DELETE /files/:id
-`)]),e("h5",{id:"example-10",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",null,`DELETE /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d
-`)]),e("h3",{id:"graphql-5",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	delete_files_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): delete_one
-}
-`)])]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	delete_files_item(id: `),e("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),s(`) {
-		id
-	}
-}
-`)])])],-1),At=e("hr",null,null,-1),Dt=e("h2",{id:"delete-multiple-files",tabindex:"-1"},[s("Delete Multiple Files "),e("a",{class:"header-anchor",href:"#delete-multiple-files"},"#")],-1),St=e("p",null,"Delete multiple files at once.",-1),Ft=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-3",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")]),e("p",null,"Array of file primary keys"),e("h3",{id:"returns-7",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty response.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-6",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`DELETE /files
-`)]),e("h5",{id:"example-11",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),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(`]
-`)])]),e("h3",{id:"graphql-6",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	delete_files_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!): delete_many
-}
-`)])]),e("h5",{id:"example-12",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	delete_files_items(ids: [`),e("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s(", "),e("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s(`]) {
-		ids
-	}
-}
-`)])])])],-1),Qt="Accessing Files",Ut=!1,Bt="page-reference",Lt={name:"files",setup(Pt,{expose:o}){const n={title:"Accessing Files",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:n}),(Ct,It)=>{const l=i("router-link"),r=i("docs-wrapper");return d(),c(r,{frontmatter:n},{default:t(()=>[e("div",h,[u,p,f,_,m,g,b,y,j,e("div",x,[e("div",v,[q,w,e("ul",null,[e("li",null,[T,k,R,E,a(l,{to:"/docs/configuration/project-settings/#files-thumbnails"},{default:t(()=>[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(l,{to:"/docs/reference/system/folders/"},{default:t(()=>[te]),_:1}),le]),e("p",null,[ae,ne,ie,oe,re,a(l,{to:"/docs/reference/system/users/"},{default:t(()=>[de]),_:1}),ce]),he,e("p",null,[ue,pe,fe,_e,me,a(l,{to:"/docs/reference/system/users/"},{default:t(()=>[ge]),_:1}),be]),ye,je,xe,ve,qe,we,Te,ke])]),Re]),Ee,Ae,De,e("div",Se,[e("div",Fe,[Pe,e("p",null,[Ce,a(l,{to:"/docs/reference/query"},{default:t(()=>[Ie]),_:1}),Oe]),Qe,e("p",null,[Ue,a(l,{to:"/docs/reference/query/#limit"},{default:t(()=>[Be]),_:1}),Le,Xe,Ye])]),e("div",Me,[ze,Ge,e("p",null,[a(l,{to:"/docs/reference/introduction/#search-http-method"},{default:t(()=>[Ne]),_:1})]),Ze,He,We,Ke,Je])]),Ve,$e,es,e("div",ss,[e("div",ts,[ls,e("p",null,[as,a(l,{to:"/docs/reference/query"},{default:t(()=>[ns]),_:1}),is]),os,rs]),ds]),cs,hs,e("div",us,[e("div",ps,[fs,_s,ms,gs,bs,ys,js,xs,e("p",null,[vs,a(l,{to:"/docs/reference/query"},{default:t(()=>[qs]),_:1}),ws]),Ts,ks]),Rs]),Es,As,Ds,e("div",Ss,[e("div",Fs,[Ps,e("p",null,[Cs,a(l,{to:"/docs/reference/query"},{default:t(()=>[Is]),_:1}),Os]),Qs,Us,Bs,Ls]),Xs]),Ys,Ms,zs,e("div",Gs,[e("div",Ns,[Zs,e("p",null,[Hs,a(l,{to:"/docs/reference/query"},{default:t(()=>[Ws]),_:1}),Ks]),Js,Vs,$s,et]),st]),tt,lt,at,e("div",nt,[e("div",it,[ot,e("p",null,[rt,a(l,{to:"/docs/reference/query"},{default:t(()=>[dt]),_:1}),ct]),ht,ut,pt,ft]),_t]),mt,gt,bt,e("div",yt,[e("div",jt,[xt,vt,e("p",null,[qt,a(l,{to:"/docs/reference/query"},{default:t(()=>[wt]),_:1}),Tt]),kt,Rt]),Et]),At,Dt,St,Ft])]),_:1})}}};export{Lt as default,Ut as modularExtension,Bt as pageClass,Qt as title};

package/dist/assets/filter-rules.056b97be.js

@@ -1,76 +0,0 @@
-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.b1f35d24.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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[l("Filter Operators "),t("a",{class:"header-anchor",href:"#filter-operators"},"#")],-1),x=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),R=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),w=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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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,x,R,w,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};