sanity-plugin-media 6.0.9 → 6.1.0

package/README.md

@@ -24,6 +24,7 @@ _Individual asset view_
 
 - Support for batch uploads with drag and drop support
 - Edit text fields native to Sanity's asset documents, such as `title`, `description`, `altText` and `originalFilename`
+- Browse folder documents in a dedicated sidebar and assign assets to folders individually or in bulk
 - View asset metadata and a limited subset of EXIF data, if present
 - Tag your assets individually or in bulk
 - Manage tags directly within the plugin
@@ -32,7 +33,7 @@ _Individual asset view_
 
 #### Granular search tools
 
-- Refine your search with any combination of search facets such as filtering by tag name, asset usage, file size, orientation, type (and more)
+- Refine your search with any combination of search facets such as filtering by tag name, folder, asset usage, file size, orientation, type (and more)
 - Use text search for a quick lookup by title, description and alt text
 
 #### Built for large datasets and collaborative editing in mind
@@ -118,6 +119,11 @@ export default defineConfig({
       // number - maximum file size (in bytes) that can be uploaded through the plugin interface
       directUploads: true,
       // boolean - enable / disable direct uploads through the plugin interface (default true)
+      excludeTags: ['internal', 'archived'],
+      // string[] (optional) - tag slugs (`media.tag` `name.current`). Assets that reference
+      // any of these tags are omitted from the Media browser grid and asset picker queries,
+      // and those tags are hidden in the tag sidebar and tag search facet. The asset edit
+      // dialog still lists all tags so you can assign or remove them on an open asset.
       components: {
         details: CustomDetails,
         // Custom component for asset details (see below)
@@ -286,6 +292,7 @@ export function CustomDetails(props) {
 <summary>Limitations when using Sanity's GraphQL endpoints</summary>
 
 - Currently, `opt.media.tags` on assets aren't accessible via GraphQL. This is because `opt` is a custom object used by this plugin and not part of Sanity's asset schema.
+- The same limitation applies to `opt.media.folder`.
 
 </details>
 
@@ -307,9 +314,9 @@ export function CustomDetails(props) {
 <details>
 <summary>How can I query asset fields I've set in this plugin?</summary>
 
-The following GROQ query will return an image with additional asset text fields as well as an array of tag names.
+The following GROQ query will return an image with additional asset text fields, its folder reference, resolved folder name, and an array of tag names.
 
-Note that tags are namespaced within `opt.media` and tag names are accessed via the `current` property (as they're defined as slugs on the `tag.media` document schema).
+Note that tags and folders are namespaced within `opt.media`. Tag names are accessed via the `current` property (as they're defined as slugs on the `tag.media` document schema), and the folder is a single weak reference you can dereference for its `name`.
 
 ```
 *[_id == 'my-document-id'] {
@@ -319,6 +326,8 @@ Note that tags are namespaced within `opt.media` and tag names are accessed via
       _type,
       altText,
       description,
+      "folder": opt.media.folder,
+      "folderName": opt.media.folder->name,
       "tags": opt.media.tags[]->name.current,
       title
     }
@@ -338,6 +347,20 @@ Note that tags are namespaced within `opt.media` and tag names are accessed via
 
 </details>
 
+#### Folders
+
+<details>
+<summary>How do folders work?</summary>
+
+- This plugin defines the document type `media.folder`
+- Folder hierarchy is stored on folder documents using a `parent` reference to another `media.folder` document
+- Asset folder assignment is stored as a weak reference at `opt.media.folder`
+- The default asset browser view shows all assets. Opening a folder filters the asset list to assets assigned to that folder.
+- You can move selected assets to a folder from the selection bar, remove selected assets from the current folder, or change/remove an individual asset's folder from the asset details dialog
+- Deleting a folder deletes only the folder document. Assets assigned to it stay in the library and have their folder assignment removed; nested folders move up one level.
+
+</details>
+
 #### Tags
 
 <details>

package/dist/index.d.ts

@@ -15,6 +15,10 @@ type DetailsProps = {
   allTagOptions: TagSelectOption[];
   assetTagOptions: TagSelectOption[] | null;
   currentAsset: Asset;
+  folderPath?: string;
+  folderMissing?: boolean;
+  onChangeFolder: () => void;
+  onRemoveFolder: () => void;
   creditLine?: {
     enabled: boolean;
     excludeSources?: string | string[] | undefined;
@@ -122,6 +126,13 @@ type MediaToolOptions = {
     excludeSources?: string | string[];
   };
   directUploads?: boolean;
+  /**
+   * Tag slugs (`media.tag.name.current`) whose assets are omitted from the Media
+   * browser grid and asset source/picker queries (and from the tag sidebar / tag
+   * search facet). The asset edit dialog still lists all tags so they can be
+   * assigned or removed on an open asset.
+   */
+  excludeTags?: string[];
   /**
    * Optional locales following Sanity recommended scheme: [{ id, title }]
    * https://www.sanity.io/docs/studio/localization#k4da239411955
@@ -139,6 +150,7 @@ type CustomFields = {
   description?: LocalizedString;
   opt?: {
     media?: {
+      folder?: SanityReference;
       tags?: SanityReference[];
     };
   };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/components/FormBuilderTool/index.tsx","../src/components/DialogAssetEdit/Details.tsx","../src/formSchema/index.ts","../src/types/index.ts","../src/plugin.tsx","../src/components/AutoTagInputWrapper/index.tsx","../src/utils/mediaField.ts"],"mappings":";;;;;;;cAOM,kBAAe,OAAW,8CAAyB,IAAA;KCc7C;EACV;EACA,kBAAkB;EAClB,SAAS,QAAQ;EACjB,QAAQ,YAAY;EACpB,UAAU,gBAAgB;EAC1B,eAAe;EACf,iBAAiB;EACjB,cAAc;EACd;IACE;IACA;;EAEF,UAAU;;cCpBC,iBAAe,EAAA;;;;;;;;;;iBAKZ,mBAAmB;EAAW;MAAa,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KCJ/C;EACV;;KAGU;EACV;EACA;EACA;IACE,UAAU,cACR;MAAgB,uBAAuB,OAAO,iBAAiB,IAAI;;;EAGvE;IACE;IACA;;EAEF;;;;;EAKA,UAAU;;KAGA;EACV;EACA;GACC;;KAGE,2BAA2B;KAE3B;EACH,UAAU;EACV,cAAc;EACd;IACE;MACE,OAAO;;;EAGX,QAAQ;;KAYE,QAAQ,YAAY;KAEpB,gBAAgB,EAAE,MAAM,kBAAkB;KA8F1C,YAAY,sBACtB;EACE;;KAGQ,aAAa,2BACvB;EACE;EACA,aAAa;;KAqBL;EACV;EACA;EACA;;KAuIU,kBAAkB,EAAE,aAAa;cC3ThC;;;;;;cAWA,wBAAK,cAAA;KCVN,oBAAoB;EAC9B;;;;;;;;;;;;;;;;;;;;;iBAsBc,aAAa,OAAO,oCAAiB,IAAA;KC7BhD,wBAAwB,KAAK,8BAChC;EACE;EACA;EACA,UAAU;;KAGT,uBAAuB,KAAK,6BAC/B;EACE;EACA;EACA,UAAU;;KAGT,wBAAwB,KAAK,8BAChC;EACE,UAAU;IAA8B;;EACxC;IAAa,cAAc;;IACzB,kBACJ;KAEG,uBAAuB,KAAK,6BAC/B;EACE,UAAU;IAA6B;;EACvC;IAAa,cAAc;;IACzB,kBACJ;;;;;;;;;;;;;;;;;;;;;;iBAuBc,WAAW,QAAQ,wBAAwB;iBAC3C,WAAW,QAAQ,uBAAuB"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/components/FormBuilderTool/index.tsx","../src/components/DialogAssetEdit/Details.tsx","../src/formSchema/index.ts","../src/types/index.ts","../src/plugin.tsx","../src/components/AutoTagInputWrapper/index.tsx","../src/utils/mediaField.ts"],"mappings":";;;;;;;cAQM,kBAAe,OAAW,8CAAyB,IAAA;KCsB7C;EACV;EACA,kBAAkB;EAClB,SAAS,QAAQ;EACjB,QAAQ,YAAY;EACpB,UAAU,gBAAgB;EAC1B,eAAe;EACf,iBAAiB;EACjB,cAAc;EACd;EACA;EACA;EACA;EACA;IACE;IACA;;EAEF,UAAU;;cCjCC,iBAAe,EAAA;;;;;;;;;;iBAKZ,mBAAmB;EAAW;MAAa,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KCJ/C;EACV;;KAGU;EACV;EACA;EACA;IACE,UAAU,cACR;MAAgB,uBAAuB,OAAO,iBAAiB,IAAI;;;EAGvE;IACE;IACA;;EAEF;;;;;;;EAOA;;;;;EAKA,UAAU;;KAGA;EACV;EACA;GACC;;KAGE,2BAA2B;KAE3B;EACH,UAAU;EACV,cAAc;EACd;IACE;MACE,SAAS;MACT,OAAO;;;EAGX,QAAQ;;KAYE,QAAQ,YAAY;KAEpB,gBAAgB,EAAE,MAAM,kBAAkB;KAgJ1C,YAAY,sBACtB;EACE;;KAuBQ,aAAa,2BACvB;EACE;EACA,aAAa;;KAqBL;EACV;EACA;EACA;;KA0IU,kBAAkB,EAAE,aAAa;cCzYhC;;;;;;cAkBA,wBAAK,cAAA;KCpBN,oBAAoB;EAC9B;;;;;;;;;;;;;;;;;;;;;iBAsBc,aAAa,OAAO,oCAAiB,IAAA;KC7BhD,wBAAwB,KAAK,8BAChC;EACE;EACA;EACA,UAAU;;KAGT,uBAAuB,KAAK,6BAC/B;EACE;EACA;EACA,UAAU;;KAGT,wBAAwB,KAAK,8BAChC;EACE,UAAU;IAA8B;;EACxC;IAAa,cAAc;;IACzB,kBACJ;KAEG,uBAAuB,KAAK,6BAC/B;EACE,UAAU;IAA6B;;EACvC;IAAa,cAAc;;IACzB,kBACJ;;;;;;;;;;;;;;;;;;;;;;iBAuBc,WAAW,QAAQ,wBAAwB;iBAC3C,WAAW,QAAQ,uBAAuB"}