sanity-plugin-media 4.3.0 → 4.3.2

package/dist/index.d.mts

@@ -1,26 +1,26 @@
-import {AssetSourceComponentProps} from 'sanity'
-import type {ComponentType} from 'react'
-import {Control} from 'react-hook-form'
-import type {FieldDefinitionBase} from 'sanity'
-import {FieldErrors} from 'react-hook-form'
-import type {FileDefinition} from 'sanity'
-import {ForwardRefExoticComponent} from 'react'
-import type {ImageDefinition} from 'sanity'
-import {InputProps} from 'sanity'
-import {JSX as JSX_2} from 'react'
-import {Plugin as Plugin_2} from 'sanity'
-import {RefAttributes} from 'react'
-import type {SanityAssetDocument} from '@sanity/client'
-import type {SanityImageAssetDocument} from '@sanity/client'
-import {SVGProps} from 'react'
-import {UseFormRegister} from 'react-hook-form'
-import type {WidenInitialValue} from 'sanity'
-import type {WidenValidation} from 'sanity'
-import * as z from 'zod'
+import { AssetSourceComponentProps } from "sanity";
+import type { ComponentType } from "react";
+import { Control } from "react-hook-form";
+import type { FieldDefinitionBase } from "sanity";
+import { FieldErrors } from "react-hook-form";
+import type { FileDefinition } from "sanity";
+import { ForwardRefExoticComponent } from "react";
+import type { ImageDefinition } from "sanity";
+import { InputProps } from "sanity";
+import { JSX } from "react";
+import { Plugin as Plugin_2 } from "sanity";
+import { RefAttributes } from "react";
+import type { SanityAssetDocument } from "@sanity/client";
+import type { SanityImageAssetDocument } from "@sanity/client";
+import { SVGProps } from "react";
+import { UseFormRegister } from "react-hook-form";
+import type { WidenInitialValue } from "sanity";
+import type { WidenValidation } from "sanity";
+import * as z from "zod";
 
-declare type Asset = FileAsset | ImageAsset
+declare type Asset = FileAsset | ImageAsset;
 
-declare type AssetFormData = z.infer<ReturnType<typeof getAssetFormSchema>>
+declare type AssetFormData = z.infer<ReturnType<typeof getAssetFormSchema>>;
 
 /**
  * Input component that automatically applies media tags when an asset is selected or uploaded.
@@ -41,95 +41,119 @@ declare type AssetFormData = z.infer<ReturnType<typeof getAssetFormSchema>>
  * components: { input: (props) => <AutoTagInput {...props} mediaTags={['product']} /> }
  * ```
  */
-export declare function AutoTagInput(props: AutoTagInputProps): JSX_2
+export declare function AutoTagInput(props: AutoTagInputProps): JSX;
 
 export declare type AutoTagInputProps = InputProps & {
-  mediaTags?: string[]
-}
+  mediaTags?: string[];
+};
 
 declare type CustomFields = {
-  altText?: LocalizedString
-  description?: LocalizedString
+  altText?: LocalizedString;
+  description?: LocalizedString;
   opt?: {
     media?: {
-      tags?: SanityReference[]
-    }
-  }
-  title?: LocalizedString
-}
+      tags?: SanityReference[];
+    };
+  };
+  title?: LocalizedString;
+};
 
 declare type DetailsProps = {
-  formUpdating: boolean
-  handleCreateTag: (title: string) => void
-  control: Control<AssetFormData>
-  errors: FieldErrors<AssetFormData>
-  register: UseFormRegister<AssetFormData>
-  allTagOptions: TagSelectOption[]
-  assetTagOptions: TagSelectOption[] | null
-  currentAsset: Asset
+  formUpdating: boolean;
+  handleCreateTag: (title: string) => void;
+  control: Control<AssetFormData>;
+  errors: FieldErrors<AssetFormData>;
+  register: UseFormRegister<AssetFormData>;
+  allTagOptions: TagSelectOption[];
+  assetTagOptions: TagSelectOption[] | null;
+  currentAsset: Asset;
   creditLine?: {
-    enabled: boolean
-    excludeSources?: string | string[] | undefined
-  }
-  locales?: Locale_2[]
-}
+    enabled: boolean;
+    excludeSources?: string | string[] | undefined;
+  };
+  locales?: Locale[];
+};
 
 declare type FileAsset = SanityAssetDocument &
   CustomFields & {
-    _type: 'sanity.fileAsset'
-  }
+    _type: "sanity.fileAsset";
+  };
 
-declare type FileMediaFieldConfig = Omit<FileDefinition, 'options'> &
+declare type FileMediaFieldConfig = Omit<FileDefinition, "options"> &
   FieldDefinitionBase & {
-    name: string
-    mediaTags: string[]
-    options?: FileDefinition['options']
-  }
+    name: string;
+    mediaTags: string[];
+    options?: FileDefinition["options"];
+  };
 
-declare type FileMediaFieldResult = Omit<FileDefinition, 'options'> &
+declare type FileMediaFieldResult = Omit<FileDefinition, "options"> &
   FieldDefinitionBase & {
-    options?: FileDefinition['options'] & {
-      mediaTags: string[]
-    }
+    options?: FileDefinition["options"] & {
+      mediaTags: string[];
+    };
     components: {
-      input: typeof AutoTagInput
-    }
+      input: typeof AutoTagInput;
+    };
   } & WidenValidation &
-  WidenInitialValue
+  WidenInitialValue;
 
 declare function getAssetFormSchema(
   locales?: {
-    id: string
-  }[]
+    id: string;
+  }[],
 ): z.ZodObject<
   {
     altText:
       | z.ZodOptional<z.ZodString>
       | z.ZodObject<
           Record<string, z.ZodTypeAny>,
-          'passthrough',
+          "passthrough",
           z.ZodTypeAny,
-          z.objectOutputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>,
-          z.objectInputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-        >
+          z.objectOutputType<
+            Record<string, z.ZodTypeAny>,
+            z.ZodTypeAny,
+            "passthrough"
+          >,
+          z.objectInputType<
+            Record<string, z.ZodTypeAny>,
+            z.ZodTypeAny,
+            "passthrough"
+          >
+        >;
     creditLine:
       | z.ZodOptional<z.ZodString>
       | z.ZodObject<
           Record<string, z.ZodTypeAny>,
-          'passthrough',
+          "passthrough",
           z.ZodTypeAny,
-          z.objectOutputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>,
-          z.objectInputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-        >
+          z.objectOutputType<
+            Record<string, z.ZodTypeAny>,
+            z.ZodTypeAny,
+            "passthrough"
+          >,
+          z.objectInputType<
+            Record<string, z.ZodTypeAny>,
+            z.ZodTypeAny,
+            "passthrough"
+          >
+        >;
     description:
       | z.ZodOptional<z.ZodString>
       | z.ZodObject<
           Record<string, z.ZodTypeAny>,
-          'passthrough',
+          "passthrough",
           z.ZodTypeAny,
-          z.objectOutputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>,
-          z.objectInputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-        >
+          z.objectOutputType<
+            Record<string, z.ZodTypeAny>,
+            z.ZodTypeAny,
+            "passthrough"
+          >,
+          z.objectInputType<
+            Record<string, z.ZodTypeAny>,
+            z.ZodTypeAny,
+            "passthrough"
+          >
+        >;
     opt: z.ZodObject<
       {
         media: z.ZodObject<
@@ -138,182 +162,222 @@ declare function getAssetFormSchema(
               z.ZodArray<
                 z.ZodObject<
                   {
-                    label: z.ZodString
-                    value: z.ZodString
+                    label: z.ZodString;
+                    value: z.ZodString;
                   },
-                  'strip',
+                  "strip",
                   z.ZodTypeAny,
                   {
-                    value: string
-                    label: string
+                    value: string;
+                    label: string;
                   },
                   {
-                    value: string
-                    label: string
+                    value: string;
+                    label: string;
                   }
                 >,
-                'many'
+                "many"
               >
-            >
+            >;
           },
-          'strip',
+          "strip",
           z.ZodTypeAny,
           {
             tags:
               | {
-                  value: string
-                  label: string
+                  value: string;
+                  label: string;
                 }[]
-              | null
+              | null;
           },
           {
             tags:
               | {
-                  value: string
-                  label: string
+                  value: string;
+                  label: string;
                 }[]
-              | null
+              | null;
           }
-        >
+        >;
       },
-      'strip',
+      "strip",
       z.ZodTypeAny,
       {
         media: {
           tags:
             | {
-                value: string
-                label: string
+                value: string;
+                label: string;
               }[]
-            | null
-        }
+            | null;
+        };
       },
       {
         media: {
           tags:
             | {
-                value: string
-                label: string
+                value: string;
+                label: string;
               }[]
-            | null
-        }
+            | null;
+        };
       }
-    >
-    originalFilename: z.ZodString
+    >;
+    originalFilename: z.ZodString;
     title:
       | z.ZodOptional<z.ZodString>
       | z.ZodObject<
           Record<string, z.ZodTypeAny>,
-          'passthrough',
+          "passthrough",
           z.ZodTypeAny,
-          z.objectOutputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>,
-          z.objectInputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-        >
+          z.objectOutputType<
+            Record<string, z.ZodTypeAny>,
+            z.ZodTypeAny,
+            "passthrough"
+          >,
+          z.objectInputType<
+            Record<string, z.ZodTypeAny>,
+            z.ZodTypeAny,
+            "passthrough"
+          >
+        >;
   },
-  'strip',
+  "strip",
   z.ZodTypeAny,
   {
+    originalFilename: string;
     opt: {
       media: {
         tags:
           | {
-              value: string
-              label: string
+              value: string;
+              label: string;
             }[]
-          | null
-      }
-    }
-    originalFilename: string
+          | null;
+      };
+    };
     altText?:
       | string
-      | z.objectOutputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-      | undefined
-    creditLine?:
-      | string
-      | z.objectOutputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-      | undefined
+      | z.objectOutputType<
+          Record<string, z.ZodTypeAny>,
+          z.ZodTypeAny,
+          "passthrough"
+        >
+      | undefined;
     description?:
       | string
-      | z.objectOutputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-      | undefined
+      | z.objectOutputType<
+          Record<string, z.ZodTypeAny>,
+          z.ZodTypeAny,
+          "passthrough"
+        >
+      | undefined;
     title?:
       | string
-      | z.objectOutputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-      | undefined
+      | z.objectOutputType<
+          Record<string, z.ZodTypeAny>,
+          z.ZodTypeAny,
+          "passthrough"
+        >
+      | undefined;
+    creditLine?:
+      | string
+      | z.objectOutputType<
+          Record<string, z.ZodTypeAny>,
+          z.ZodTypeAny,
+          "passthrough"
+        >
+      | undefined;
   },
   {
+    originalFilename: string;
     opt: {
       media: {
         tags:
           | {
-              value: string
-              label: string
+              value: string;
+              label: string;
             }[]
-          | null
-      }
-    }
-    originalFilename: string
+          | null;
+      };
+    };
     altText?:
       | string
-      | z.objectInputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-      | undefined
-    creditLine?:
-      | string
-      | z.objectInputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-      | undefined
+      | z.objectInputType<
+          Record<string, z.ZodTypeAny>,
+          z.ZodTypeAny,
+          "passthrough"
+        >
+      | undefined;
     description?:
       | string
-      | z.objectInputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-      | undefined
+      | z.objectInputType<
+          Record<string, z.ZodTypeAny>,
+          z.ZodTypeAny,
+          "passthrough"
+        >
+      | undefined;
     title?:
       | string
-      | z.objectInputType<Record<string, z.ZodTypeAny>, z.ZodTypeAny, 'passthrough'>
-      | undefined
+      | z.objectInputType<
+          Record<string, z.ZodTypeAny>,
+          z.ZodTypeAny,
+          "passthrough"
+        >
+      | undefined;
+    creditLine?:
+      | string
+      | z.objectInputType<
+          Record<string, z.ZodTypeAny>,
+          z.ZodTypeAny,
+          "passthrough"
+        >
+      | undefined;
   }
->
+>;
 
 declare type ImageAsset = SanityImageAssetDocument &
   CustomFields & {
-    _type: 'sanity.imageAsset'
-    creditLine?: LocalizedString
-  }
+    _type: "sanity.imageAsset";
+    creditLine?: LocalizedString;
+  };
 
-declare type ImageMediaFieldConfig = Omit<ImageDefinition, 'options'> &
+declare type ImageMediaFieldConfig = Omit<ImageDefinition, "options"> &
   FieldDefinitionBase & {
-    name: string
-    mediaTags: string[]
-    options?: ImageDefinition['options']
-  }
+    name: string;
+    mediaTags: string[];
+    options?: ImageDefinition["options"];
+  };
 
-declare type ImageMediaFieldResult = Omit<ImageDefinition, 'options'> &
+declare type ImageMediaFieldResult = Omit<ImageDefinition, "options"> &
   FieldDefinitionBase & {
-    options?: ImageDefinition['options'] & {
-      mediaTags: string[]
-    }
+    options?: ImageDefinition["options"] & {
+      mediaTags: string[];
+    };
     components: {
-      input: typeof AutoTagInput
-    }
+      input: typeof AutoTagInput;
+    };
   } & WidenValidation &
-  WidenInitialValue
+  WidenInitialValue;
 
-declare type Locale_2 = {
-  title: string
-  id: string
-  [key: string]: unknown
-}
+declare type Locale = {
+  title: string;
+  id: string;
+  [key: string]: unknown;
+};
 
-declare type LocalizedString = string | Record<string, string>
+declare type LocalizedString = string | Record<string, string>;
 
-export declare const media: Plugin_2<void | MediaToolOptions>
+export declare const media: Plugin_2<void | MediaToolOptions>;
 
 export declare const mediaAssetSource: {
-  component: (props: AssetSourceComponentProps) => JSX_2
+  component: (props: AssetSourceComponentProps) => JSX;
   icon: ForwardRefExoticComponent<
-    Omit<SVGProps<SVGSVGElement>, 'ref'> & RefAttributes<SVGSVGElement>
-  >
-  name: string
-  title: string
-}
+    Omit<SVGProps<SVGSVGElement>, "ref"> & RefAttributes<SVGSVGElement>
+  >;
+  name: string;
+  title: string;
+};
 
 /**
  * Defines an image or file field with automatic media tag application when an asset is selected.
@@ -336,59 +400,63 @@ export declare const mediaAssetSource: {
  * mediaField({ name: 'drawing', type: 'file', mediaTags: ['model-drawing'] })
  * ```
  */
-export declare function mediaField(config: ImageMediaFieldConfig): ImageMediaFieldResult
+export declare function mediaField(
+  config: ImageMediaFieldConfig,
+): ImageMediaFieldResult;
 
-export declare function mediaField(config: FileMediaFieldConfig): FileMediaFieldResult
+export declare function mediaField(
+  config: FileMediaFieldConfig,
+): FileMediaFieldResult;
 
 export declare type MediaTagsOptions = {
-  mediaTags?: string[]
-}
+  mediaTags?: string[];
+};
 
 export declare type MediaToolOptions = {
-  maximumUploadSize?: number
-  createTagsOnUpload?: boolean
+  maximumUploadSize?: number;
+  createTagsOnUpload?: boolean;
   components?: {
     details?: ComponentType<
       DetailsProps & {
-        renderDefaultDetails: (props: DetailsProps) => JSX_2.Element
+        renderDefaultDetails: (props: DetailsProps) => JSX.Element;
       }
-    >
-  }
+    >;
+  };
   creditLine?: {
-    enabled: boolean
-    excludeSources?: string | string[]
-  }
-  directUploads?: boolean
+    enabled: boolean;
+    excludeSources?: string | string[];
+  };
+  directUploads?: boolean;
   /**
    * Optional locales following Sanity recommended scheme: [{ id, title }]
    * https://www.sanity.io/docs/studio/localization#k4da239411955
    */
-  locales?: Locale_2[]
-}
+  locales?: Locale[];
+};
 
 declare type SanityReference = {
-  _ref: string
-  _type: 'reference'
-  _weak?: boolean
-}
+  _ref: string;
+  _type: "reference";
+  _weak?: boolean;
+};
 
 declare const tagOptionSchema: z.ZodObject<
   {
-    label: z.ZodString
-    value: z.ZodString
+    label: z.ZodString;
+    value: z.ZodString;
   },
-  'strip',
+  "strip",
   z.ZodTypeAny,
   {
-    value: string
-    label: string
+    value: string;
+    label: string;
   },
   {
-    value: string
-    label: string
+    value: string;
+    label: string;
   }
->
+>;
 
-declare type TagSelectOption = z.infer<typeof tagOptionSchema>
+declare type TagSelectOption = z.infer<typeof tagOptionSchema>;
 
-export {}
+export {};