sanity-plugin-media 4.3.5 → 5.0.0

package/dist/index.d.cts

@@ -1,462 +0,0 @@
-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 AssetFormData = z.infer<ReturnType<typeof getAssetFormSchema>>;
-
-/**
- * Input component that automatically applies media tags when an asset is selected or uploaded.
- *
- * Apply explicitly to image/file fields that should be auto-tagged:
- * ```ts
- * import {AutoTagInput} from 'sanity-plugin-media'
- *
- * defineField({
- *   type: 'image',
- *   options: { mediaTags: ['product'] },   // also pre-filters the media browser
- *   components: { input: AutoTagInput },
- * })
- * ```
- *
- * Pass `mediaTags` as a prop to override or use without `options`:
- * ```ts
- * components: { input: (props) => <AutoTagInput {...props} mediaTags={['product']} /> }
- * ```
- */
-export declare function AutoTagInput(props: AutoTagInputProps): JSX;
-
-export declare type AutoTagInputProps = InputProps & {
-  mediaTags?: string[];
-};
-
-declare type CustomFields = {
-  altText?: LocalizedString;
-  description?: LocalizedString;
-  opt?: {
-    media?: {
-      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;
-  creditLine?: {
-    enabled: boolean;
-    excludeSources?: string | string[] | undefined;
-  };
-  locales?: Locale[];
-};
-
-declare type FileAsset = SanityAssetDocument &
-  CustomFields & {
-    _type: "sanity.fileAsset";
-  };
-
-declare type FileMediaFieldConfig = Omit<FileDefinition, "options"> &
-  FieldDefinitionBase & {
-    name: string;
-    mediaTags: string[];
-    options?: FileDefinition["options"];
-  };
-
-declare type FileMediaFieldResult = Omit<FileDefinition, "options"> &
-  FieldDefinitionBase & {
-    options?: FileDefinition["options"] & {
-      mediaTags: string[];
-    };
-    components: {
-      input: typeof AutoTagInput;
-    };
-  } & WidenValidation &
-  WidenInitialValue;
-
-declare function getAssetFormSchema(
-  locales?: {
-    id: string;
-  }[],
-): z.ZodObject<
-  {
-    altText:
-      | z.ZodOptional<z.ZodString>
-      | z.ZodObject<
-          Record<string, z.ZodTypeAny>,
-          "passthrough",
-          z.ZodTypeAny,
-          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",
-          z.ZodTypeAny,
-          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",
-          z.ZodTypeAny,
-          z.objectOutputType<
-            Record<string, z.ZodTypeAny>,
-            z.ZodTypeAny,
-            "passthrough"
-          >,
-          z.objectInputType<
-            Record<string, z.ZodTypeAny>,
-            z.ZodTypeAny,
-            "passthrough"
-          >
-        >;
-    opt: z.ZodObject<
-      {
-        media: z.ZodObject<
-          {
-            tags: z.ZodNullable<
-              z.ZodArray<
-                z.ZodObject<
-                  {
-                    label: z.ZodString;
-                    value: z.ZodString;
-                  },
-                  "strip",
-                  z.ZodTypeAny,
-                  {
-                    value: string;
-                    label: string;
-                  },
-                  {
-                    value: string;
-                    label: string;
-                  }
-                >,
-                "many"
-              >
-            >;
-          },
-          "strip",
-          z.ZodTypeAny,
-          {
-            tags:
-              | {
-                  value: string;
-                  label: string;
-                }[]
-              | null;
-          },
-          {
-            tags:
-              | {
-                  value: string;
-                  label: string;
-                }[]
-              | null;
-          }
-        >;
-      },
-      "strip",
-      z.ZodTypeAny,
-      {
-        media: {
-          tags:
-            | {
-                value: string;
-                label: string;
-              }[]
-            | null;
-        };
-      },
-      {
-        media: {
-          tags:
-            | {
-                value: string;
-                label: string;
-              }[]
-            | null;
-        };
-      }
-    >;
-    originalFilename: z.ZodString;
-    title:
-      | z.ZodOptional<z.ZodString>
-      | z.ZodObject<
-          Record<string, z.ZodTypeAny>,
-          "passthrough",
-          z.ZodTypeAny,
-          z.objectOutputType<
-            Record<string, z.ZodTypeAny>,
-            z.ZodTypeAny,
-            "passthrough"
-          >,
-          z.objectInputType<
-            Record<string, z.ZodTypeAny>,
-            z.ZodTypeAny,
-            "passthrough"
-          >
-        >;
-  },
-  "strip",
-  z.ZodTypeAny,
-  {
-    originalFilename: string;
-    opt: {
-      media: {
-        tags:
-          | {
-              value: string;
-              label: string;
-            }[]
-          | null;
-      };
-    };
-    altText?:
-      | string
-      | z.objectOutputType<
-          Record<string, z.ZodTypeAny>,
-          z.ZodTypeAny,
-          "passthrough"
-        >
-      | undefined;
-    description?:
-      | string
-      | z.objectOutputType<
-          Record<string, z.ZodTypeAny>,
-          z.ZodTypeAny,
-          "passthrough"
-        >
-      | undefined;
-    title?:
-      | string
-      | 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;
-            }[]
-          | null;
-      };
-    };
-    altText?:
-      | string
-      | z.objectInputType<
-          Record<string, z.ZodTypeAny>,
-          z.ZodTypeAny,
-          "passthrough"
-        >
-      | undefined;
-    description?:
-      | string
-      | z.objectInputType<
-          Record<string, z.ZodTypeAny>,
-          z.ZodTypeAny,
-          "passthrough"
-        >
-      | undefined;
-    title?:
-      | string
-      | 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;
-  };
-
-declare type ImageMediaFieldConfig = Omit<ImageDefinition, "options"> &
-  FieldDefinitionBase & {
-    name: string;
-    mediaTags: string[];
-    options?: ImageDefinition["options"];
-  };
-
-declare type ImageMediaFieldResult = Omit<ImageDefinition, "options"> &
-  FieldDefinitionBase & {
-    options?: ImageDefinition["options"] & {
-      mediaTags: string[];
-    };
-    components: {
-      input: typeof AutoTagInput;
-    };
-  } & WidenValidation &
-  WidenInitialValue;
-
-declare type Locale = {
-  title: string;
-  id: string;
-  [key: string]: unknown;
-};
-
-declare type LocalizedString = string | Record<string, string>;
-
-export declare const media: Plugin_2<void | MediaToolOptions>;
-
-export declare const mediaAssetSource: {
-  component: (props: AssetSourceComponentProps) => JSX;
-  icon: ForwardRefExoticComponent<
-    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.
- *
- * Pass `mediaTags` at the top level — they are moved into `options.mediaTags` (for media browser
- * pre-filtering) and wire up {@link AutoTagInput} as the field component automatically:
- * ```ts
- * import {mediaField} from 'sanity-plugin-media'
- *
- * mediaField({
- *   name: 'coverImage',
- *   type: 'image',
- *   mediaTags: ['product-cover'],
- *   options: { hotspot: true },
- * })
- * ```
- *
- * For file fields, set `type: 'file'`:
- * ```ts
- * mediaField({ name: 'drawing', type: 'file', mediaTags: ['model-drawing'] })
- * ```
- */
-export declare function mediaField(
-  config: ImageMediaFieldConfig,
-): ImageMediaFieldResult;
-
-export declare function mediaField(
-  config: FileMediaFieldConfig,
-): FileMediaFieldResult;
-
-export declare type MediaTagsOptions = {
-  mediaTags?: string[];
-};
-
-export declare type MediaToolOptions = {
-  maximumUploadSize?: number;
-  createTagsOnUpload?: boolean;
-  components?: {
-    details?: ComponentType<
-      DetailsProps & {
-        renderDefaultDetails: (props: DetailsProps) => JSX.Element;
-      }
-    >;
-  };
-  creditLine?: {
-    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[];
-};
-
-declare type SanityReference = {
-  _ref: string;
-  _type: "reference";
-  _weak?: boolean;
-};
-
-declare const tagOptionSchema: z.ZodObject<
-  {
-    label: z.ZodString;
-    value: z.ZodString;
-  },
-  "strip",
-  z.ZodTypeAny,
-  {
-    value: string;
-    label: string;
-  },
-  {
-    value: string;
-    label: string;
-  }
->;
-
-declare type TagSelectOption = z.infer<typeof tagOptionSchema>;
-
-export {};

package/sanity.json

@@ -1,8 +0,0 @@
-{
-  "parts": [
-    {
-      "implements": "part:@sanity/base/sanity-root",
-      "path": "./v2-incompatible.js"
-    }
-  ]
-}

package/src/__tests__/fixtures/createEpicTestStore.ts

@@ -1,28 +0,0 @@
-import {configureStore, type AnyAction, type EnhancedStore} from '@reduxjs/toolkit'
-import type {SanityClient} from '@sanity/client'
-import type {Epic} from 'redux-observable'
-import {createEpicMiddleware} from 'redux-observable'
-
-import {rootReducer} from '../../modules'
-import type {RootReducerState} from '../../modules/types'
-import {createTestRootState} from './rootState'
-
-export function createEpicTestStore(
-  epic: Epic<AnyAction, AnyAction, RootReducerState, {client: SanityClient}>,
-  mockClient: SanityClient,
-  preloaded?: Partial<RootReducerState>,
-): EnhancedStore<RootReducerState, AnyAction> {
-  const epicMiddleware = createEpicMiddleware<AnyAction, AnyAction, RootReducerState>({
-    dependencies: {client: mockClient},
-  })
-
-  const store = configureStore({
-    reducer: rootReducer,
-    middleware: (getDefaultMiddleware) =>
-      getDefaultMiddleware({serializableCheck: false, thunk: false}).concat(epicMiddleware),
-    preloadedState: createTestRootState(preloaded),
-  })
-
-  epicMiddleware.run(epic)
-  return store
-}

package/src/__tests__/fixtures/listenMock.ts

@@ -1,9 +0,0 @@
-import {vi} from 'vitest'
-
-/** Flat mock for client.listen() without deep callback nesting (ESLint max-nested-callbacks). */
-export function createListenMock(): ReturnType<typeof vi.fn> {
-  const unsubscribe = vi.fn()
-  const subscribe = vi.fn()
-  subscribe.mockReturnValue({unsubscribe})
-  return vi.fn().mockReturnValue({subscribe})
-}

package/src/__tests__/fixtures/mockSanityClient.ts

@@ -1,84 +0,0 @@
-import type {SanityClient} from '@sanity/client'
-import {Subject, of} from 'rxjs'
-import {vi} from 'vitest'
-
-export type MockSanityClient = {
-  observable: {
-    fetch: ReturnType<typeof vi.fn>
-    delete: ReturnType<typeof vi.fn>
-    create: ReturnType<typeof vi.fn>
-    assets: {upload: ReturnType<typeof vi.fn>}
-  }
-  fetch: ReturnType<typeof vi.fn>
-  listen: ReturnType<typeof vi.fn>
-  patch: ReturnType<typeof vi.fn>
-  transaction: ReturnType<typeof vi.fn>
-}
-
-export function createMockSanityClient(
-  overrides: Partial<Omit<MockSanityClient, 'observable'>> & {
-    observable?: Partial<MockSanityClient['observable']> & {
-      assets?: Partial<MockSanityClient['observable']['assets']>
-    }
-  } = {},
-): SanityClient {
-  const {observable: observableOverrides, ...restOverrides} = overrides
-
-  const observableBase: MockSanityClient['observable'] = {
-    fetch: vi.fn(() => of({items: []})),
-    delete: vi.fn(() => of({})),
-    create: vi.fn(() => of({_id: 'new'})),
-    assets: {
-      upload: vi.fn(() => of({type: 'complete', body: {document: {_id: 'up'}}})),
-    },
-  }
-
-  const observable: MockSanityClient['observable'] = {
-    ...observableBase,
-    ...(observableOverrides ?? {}),
-    assets: {
-      ...observableBase.assets,
-      ...(observableOverrides?.assets ?? {}),
-    },
-  }
-
-  const client: MockSanityClient = {
-    observable,
-    fetch: vi.fn(() => Promise.resolve(0)),
-    listen: vi.fn(() => new Subject()),
-    patch: vi.fn(),
-    transaction: vi.fn(),
-    ...restOverrides,
-  }
-
-  return client as unknown as SanityClient
-}
-
-export function mockPatchChain(result: unknown): {
-  set: ReturnType<typeof vi.fn>
-  setIfMissing: ReturnType<typeof vi.fn>
-  commit: ReturnType<typeof vi.fn>
-} {
-  const commit = vi.fn().mockResolvedValue(result)
-  const chain = {
-    set: vi.fn(),
-    setIfMissing: vi.fn(),
-    commit,
-  }
-  chain.set.mockImplementation(() => chain)
-  chain.setIfMissing.mockImplementation(() => chain)
-  return chain
-}
-
-export function mockTransactionCommit(resolved: unknown = undefined): {
-  patch: ReturnType<typeof vi.fn>
-  delete: ReturnType<typeof vi.fn>
-  commit: ReturnType<typeof vi.fn>
-} {
-  const tx = {
-    patch: vi.fn().mockReturnThis(),
-    delete: vi.fn().mockReturnThis(),
-    commit: vi.fn().mockResolvedValue(resolved),
-  }
-  return tx
-}

package/src/__tests__/fixtures/renderWithProviders.tsx

@@ -1,55 +0,0 @@
-import {configureStore} from '@reduxjs/toolkit'
-import {studioTheme, ThemeProvider, ToastProvider} from '@sanity/ui'
-import {render} from '@testing-library/react'
-import type {ReactElement, ReactNode} from 'react'
-import {Provider} from 'react-redux'
-import {ColorSchemeProvider} from 'sanity'
-import type {AssetSourceComponentProps} from 'sanity'
-
-import {AssetBrowserDispatchProvider} from '../../contexts/AssetSourceDispatchContext'
-import {ToolOptionsProvider} from '../../contexts/ToolOptionsContext'
-import {rootReducer} from '../../modules'
-import type {RootReducerState} from '../../modules/types'
-import type {MediaToolOptions} from '../../types'
-import {createTestRootState} from './rootState'
-
-type Opts = {
-  onSelect?: AssetSourceComponentProps['onSelect']
-  preloaded?: Partial<RootReducerState>
-  toolOptions?: Partial<MediaToolOptions>
-}
-
-export function renderWithProviders(ui: ReactElement, opts: Opts = {}) {
-  const {onSelect, preloaded, toolOptions} = opts
-
-  const store = configureStore({
-    reducer: rootReducer,
-    middleware: (getDefaultMiddleware) =>
-      getDefaultMiddleware({thunk: false, serializableCheck: false}),
-    preloadedState: createTestRootState(preloaded),
-  })
-
-  const options: MediaToolOptions = {
-    creditLine: {enabled: false},
-    directUploads: true,
-    ...toolOptions,
-  }
-
-  const wrap = (node: ReactNode) => (
-    <Provider store={store}>
-      <ColorSchemeProvider scheme="light">
-        <ToolOptionsProvider options={options}>
-          <ThemeProvider theme={studioTheme}>
-            <ToastProvider>
-              <AssetBrowserDispatchProvider onSelect={onSelect}>
-                {node}
-              </AssetBrowserDispatchProvider>
-            </ToastProvider>
-          </ThemeProvider>
-        </ToolOptionsProvider>
-      </ColorSchemeProvider>
-    </Provider>
-  )
-
-  return {store, ...render(wrap(ui))}
-}

package/src/__tests__/fixtures/rootState.ts

@@ -1,27 +0,0 @@
-import {initialState as assetsInitialState} from '../../modules/assets'
-import type {RootReducerState} from '../../modules/types'
-
-export function createTestRootState(overrides: Partial<RootReducerState> = {}): RootReducerState {
-  const base: RootReducerState = {
-    assets: {
-      ...assetsInitialState,
-      assetTypes: ['file', 'image'],
-    },
-    debug: {badConnection: false, enabled: false},
-    dialog: {items: []},
-    notifications: {items: []},
-    search: {facets: [], query: ''},
-    selected: {assets: [], document: undefined, documentAssetIds: []},
-    tags: {
-      allIds: [],
-      byIds: {},
-      creating: false,
-      fetchCount: -1,
-      fetching: false,
-      panelVisible: true,
-    },
-    uploads: {allIds: [], byIds: {}},
-  }
-
-  return {...base, ...overrides} as RootReducerState
-}

package/src/__tests__/fixtures/withinDialog.ts

@@ -1,28 +0,0 @@
-import {within, type Screen} from '@testing-library/react'
-
-/** Topmost Sanity dialog matching `name` (handles animated duplicate layers). */
-export function getDialogRoot(name: RegExp, base: Screen): HTMLElement {
-  const dialogs = base.getAllByRole('dialog', {name})
-  const el = dialogs.at(-1)
-  if (!el) {
-    throw new Error(`No dialog found matching ${name}`)
-  }
-  return el
-}
-
-/** Scoped queries for that dialog. */
-export function withinDialog(name: RegExp, base: Screen) {
-  return within(getDialogRoot(name, base))
-}
-
-/**
- * Sanity `TextInput` is not always exposed as a labellable control; use the native input by `name`.
- */
-export function inputByName(dialogName: RegExp, base: Screen, name: string): HTMLInputElement {
-  const root = getDialogRoot(dialogName, base)
-  const input = root.querySelector(`input[name="${name}"]`)
-  if (!input || !(input instanceof HTMLInputElement)) {
-    throw new Error(`No input name="${name}" in dialog matching ${dialogName}`)
-  }
-  return input
-}