sanity-plugin-media 4.3.5 → 5.0.0

package/src/types/index.ts

@@ -1,379 +0,0 @@
-import type {Action} from '@reduxjs/toolkit'
-import type {
-  SanityAssetDocument,
-  SanityClient,
-  SanityDocument,
-  SanityImageAssetDocument,
-} from '@sanity/client'
-import type {ComponentType, JSX} from 'react'
-import type {Epic} from 'redux-observable'
-import * as z from 'zod'
-
-import type {DetailsProps} from '../components/DialogAssetEdit/Details'
-import type {SUPPORTED_ASSET_TYPES} from '../constants'
-import {getAssetFormSchema, tagFormSchema, tagOptionSchema} from '../formSchema'
-import type {RootReducerState} from '../modules/types'
-
-export type AssetTypes = (typeof SUPPORTED_ASSET_TYPES)[number]
-
-export type MediaTagsOptions = {
-  mediaTags?: string[]
-}
-
-export 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[]
-}
-
-export type Locale = {
-  title: string
-  id: string
-  [key: string]: unknown
-}
-
-type LocalizedString = string | Record<string, string>
-
-type CustomFields = {
-  altText?: LocalizedString
-  description?: LocalizedString
-  opt?: {
-    media?: {
-      tags?: SanityReference[]
-    }
-  }
-  title?: LocalizedString
-}
-
-type SearchFacetInputCommon = {
-  assetTypes: AssetType[]
-  name: string
-  operatorType: SearchFacetOperatorType
-  operatorTypes?: (SearchFacetOperatorType | null)[]
-  selectOnly?: boolean
-  title: string
-}
-
-export type Asset = FileAsset | ImageAsset
-
-export type AssetFormData = z.infer<ReturnType<typeof getAssetFormSchema>>
-
-export type AssetItem = {
-  _type: 'asset'
-  asset: Asset
-  error?: string
-  picked: boolean
-  updating: boolean
-}
-
-export type AssetType = 'file' | 'image'
-
-export type Block = {
-  _type: string
-  _key: string
-  children: Span[]
-  markDefs: MarkDef[]
-}
-
-export type BrowserView = 'grid' | 'table'
-
-export type ButtonVariant = 'danger' | 'default' | 'secondary'
-
-// TODO: rename
-export type CardAssetData = {
-  id: string
-  type: 'asset'
-}
-
-export type CardUploadData = {
-  id: string
-  type: 'upload'
-}
-
-export type Dialog =
-  | DialogAssetEditProps
-  | DialogConfirmProps
-  | DialogSearchFacetsProps
-  | DialogTagCreateProps
-  | DialogTagEditProps
-  | DialogTagsProps
-
-export type DialogAction = 'deleteAsset' | 'deleteTag'
-
-export type DialogAssetEditProps = {
-  assetId?: string
-  closeDialogId?: string
-  id: string
-  lastCreatedTag?: {
-    label: string
-    value: string
-  }
-  lastRemovedTagIds?: string[]
-  type: 'assetEdit'
-}
-
-export type DialogConfirmProps = {
-  closeDialogId?: string
-  confirmCallbackAction: Action // TODO: reconsider
-  confirmText: string
-  description?: string
-  headerTitle: string
-  id: string
-  title: string
-  tone: 'critical' | 'primary'
-  type: 'confirm'
-}
-
-export type DialogSearchFacetsProps = {
-  closeDialogId?: string
-  id: string
-  type: 'searchFacets'
-}
-
-export type DialogTagsProps = {
-  closeDialogId?: string
-  id: string
-  type: 'tags'
-}
-
-export type DialogTagCreateProps = {
-  closeDialogId?: string
-  id: string
-  type: 'tagCreate'
-}
-
-export type DialogTagEditProps = {
-  closeDialogId?: string
-  id: string
-  tagId?: string
-  type: 'tagEdit'
-}
-
-export type Document = {
-  _createdAt: string
-  _id: string
-  _rev: string
-  _type: string
-  _updatedAt: string
-  name?: string
-  title?: string
-}
-
-export type HttpError = {
-  message: string
-  statusCode: number
-}
-
-export type FileAsset = SanityAssetDocument &
-  CustomFields & {
-    _type: 'sanity.fileAsset'
-  }
-
-export type ImageAsset = SanityImageAssetDocument &
-  CustomFields & {
-    _type: 'sanity.imageAsset'
-    creditLine?: LocalizedString
-  }
-
-export type MarkDef = {_key: string; _type: string}
-
-export type MyEpic = Epic<
-  Action,
-  Action,
-  RootReducerState,
-  {
-    client: SanityClient
-  }
->
-
-export type Order = {
-  direction: OrderDirection
-  field: string
-}
-
-export type OrderDirection = 'asc' | 'desc'
-
-export type SanityReference = {
-  _ref: string
-  _type: 'reference'
-  _weak?: boolean
-}
-
-export type SearchFacetInputProps =
-  | SearchFacetInputNumberProps
-  | SearchFacetInputSearchableProps
-  | SearchFacetInputSelectProps
-  | SearchFacetInputStringProps
-
-export type SearchFacetDivider = {
-  type: 'divider'
-}
-
-export type SearchFacetGroup = {
-  facets: (SearchFacetDivider | SearchFacetGroup | SearchFacetInputProps)[]
-  title: string
-  type: 'group'
-}
-
-export type SearchFacetInputNumberModifier = {
-  fieldModifier?: (fieldName: string) => string
-  name: string
-  title: string
-}
-
-export type SearchFacetInputNumberProps = SearchFacetInputCommon & {
-  field: string
-  modifier?: string
-  modifiers?: SearchFacetInputNumberModifier[]
-  type: 'number'
-  value?: number
-}
-
-export type SearchFacetInputSearchableProps = SearchFacetInputCommon & {
-  field: string
-  name: string
-  options?: SearchFacetInputSelectListItemProps[]
-  type: 'searchable'
-  value?: TagSelectOption
-}
-
-export type SearchFacetInputSelectProps = SearchFacetInputCommon & {
-  field?: string
-  options: SearchFacetInputSelectListItemProps[]
-  type: 'select'
-  value: string
-}
-
-export type SearchFacetInputSelectListItemProps = {
-  name: string
-  title: string
-  value: string
-}
-
-export type SearchFacetInputStringProps = SearchFacetInputCommon & {
-  field: string
-  modifier?: string
-  type: 'string'
-  value?: string
-}
-
-export type SearchFacetName =
-  | 'altText'
-  | 'creditLine'
-  | 'description'
-  | 'fileName'
-  | 'height'
-  | 'inCurrentDocument'
-  | 'inUse'
-  | 'isOpaque'
-  | 'orientation'
-  | 'size'
-  | 'tag'
-  | 'title'
-  | 'type'
-  | 'width'
-
-export type SearchFacetOperatorType =
-  | 'doesNotInclude'
-  | 'doesNotReference'
-  | 'empty'
-  | 'equalTo'
-  | 'greaterThan'
-  | 'greaterThanOrEqualTo'
-  | 'includes'
-  | 'is'
-  | 'isNot'
-  | 'lessThan'
-  | 'lessThanOrEqualTo'
-  | 'notEmpty'
-  | 'references'
-
-export type SearchFacetOperators = Record<
-  SearchFacetOperatorType,
-  {
-    fn: (value: number | string | undefined, field?: string) => string | undefined
-    hideInput?: boolean
-    label: string
-  }
->
-
-export type SanityUploadCompleteEvent = {
-  asset: SanityAssetDocument | SanityImageAssetDocument
-  id: string
-  type: 'complete'
-}
-
-export type SanityUploadProgressEvent = {
-  lengthComputable: boolean
-  loaded: number
-  percent: number
-  stage: 'download' | 'upload'
-  total: number
-  type: 'progress'
-}
-
-export type SanityUploadResponseEvent = {
-  body: {document: Partial<SanityAssetDocument | SanityImageAssetDocument>}
-  headers: Record<string, string>
-  method: string
-  statusCode: number
-  statusMessage: string
-  type: 'response'
-  url: string // preview image?
-}
-
-export type Span = {
-  _key: string
-  text: string
-  marks: string[]
-}
-
-export type Tag = SanityDocument & {
-  name: {
-    _type: 'slug'
-    current: string
-  }
-}
-
-export type TagActions = 'applyAll' | 'delete' | 'edit' | 'removeAll' | 'search'
-
-export type TagFormData = z.infer<typeof tagFormSchema>
-
-export type TagItem = {
-  _type: 'tag'
-  tag: Tag
-  error?: HttpError
-  picked: boolean
-  updating: boolean
-}
-
-export type TagSelectOption = z.infer<typeof tagOptionSchema>
-
-export type UploadItem = {
-  _type: 'upload'
-  assetType: AssetType
-  hash: string
-  name: string
-  objectUrl?: string
-  percent?: number
-  size: number
-  status: 'complete' | 'queued' | 'uploading'
-}
-
-export type WithId<T extends SearchFacetInputProps> = T & {
-  id: string
-}

package/src/types/sanity-ui.d.ts

@@ -1,6 +0,0 @@
-import {type Theme} from '@sanity/ui'
-
-declare module 'styled-components' {
-  // eslint-disable-next-line
-  interface DefaultTheme extends Theme {}
-}

package/src/utils/applyMediaTags.ts

@@ -1,87 +0,0 @@
-import type {SanityClient} from '@sanity/client'
-import groq from 'groq'
-import {nanoid} from 'nanoid'
-
-import {TAG_DOCUMENT_NAME} from '../constants'
-import type {Tag} from '../types'
-
-type ApplyMediaTagsOptions = {
-  client: SanityClient
-  assetId: string
-  mediaTags: string[]
-  createTagsOnUpload?: boolean
-}
-
-// Serialize calls per asset so concurrent fields reading the same asset
-// don't race each other — the second call always runs after the first commits.
-const pendingByAsset = new Map<string, Promise<void>>()
-
-export function applyMediaTags(options: ApplyMediaTagsOptions): Promise<void> {
-  const {assetId} = options
-  const chain = (pendingByAsset.get(assetId) ?? Promise.resolve()).then(() =>
-    doApplyMediaTags(options),
-  )
-  const cleanup = chain
-    .catch(() => {})
-    .finally(() => {
-      if (pendingByAsset.get(assetId) === cleanup) pendingByAsset.delete(assetId)
-    })
-  pendingByAsset.set(assetId, cleanup)
-  return chain
-}
-
-async function doApplyMediaTags({
-  client,
-  assetId,
-  mediaTags,
-  createTagsOnUpload = true,
-}: ApplyMediaTagsOptions): Promise<void> {
-  if (!mediaTags || mediaTags.length === 0) return
-
-  const resolvedTags = await Promise.all(
-    mediaTags.map(async (tagName) => {
-      const existingTag = await client.fetch<Tag | null>(
-        groq`*[_type == "${TAG_DOCUMENT_NAME}" && name.current == $tagName][0]`,
-        {tagName},
-      )
-      if (existingTag) return existingTag
-      if (createTagsOnUpload) {
-        const newTag = await client.create({
-          _type: TAG_DOCUMENT_NAME,
-          name: {_type: 'slug', current: tagName},
-        })
-        return newTag as Tag
-      }
-      return null
-    }),
-  )
-
-  const validTags = resolvedTags.filter((tag): tag is Tag => tag !== null)
-  if (validTags.length === 0) return
-
-  const existing = await client.fetch<{tagIds: string[]} | null>(
-    groq`*[_id == $assetId][0]{'tagIds': opt.media.tags[]._ref}`,
-    {assetId},
-    {useCdn: false}, // bypass CDN cache so we see the latest committed tag refs
-  )
-  const existingIds = new Set(existing?.tagIds ?? [])
-
-  const tagReferences = validTags
-    .filter((tag) => !existingIds.has(tag._id))
-    .map((tag) => ({
-      _key: nanoid(),
-      _ref: tag._id,
-      _type: 'reference' as const,
-      _weak: true,
-    }))
-
-  if (tagReferences.length === 0) return
-
-  await client
-    .patch(assetId)
-    .setIfMissing({opt: {}})
-    .setIfMissing({'opt.media': {}})
-    .setIfMissing({'opt.media.tags': []})
-    .append('opt.media.tags', tagReferences)
-    .commit()
-}

package/src/utils/blocksToText.test.ts

@@ -1,43 +0,0 @@
-import {describe, expect, it} from 'vitest'
-
-import type {Block} from '../types'
-import blocksToText from './blocksToText'
-
-describe('blocksToText', () => {
-  it('returns plain strings unchanged', () => {
-    expect(blocksToText('hello')).toBe('hello')
-    expect(blocksToText('')).toBe('')
-  })
-
-  it('returns empty string for non-array non-string input', () => {
-    expect(blocksToText(null as unknown as string)).toBe('')
-  })
-
-  it('joins block children text with blank lines between blocks', () => {
-    const blocks: Block[] = [
-      {
-        _type: 'block',
-        _key: 'a',
-        markDefs: [],
-        children: [{_key: 'a1', text: 'Line one', marks: []}],
-      },
-      {
-        _type: 'block',
-        _key: 'b',
-        markDefs: [],
-        children: [{_key: 'b1', text: 'Line two', marks: []}],
-      },
-    ]
-    expect(blocksToText(blocks)).toBe('Line one\n\nLine two')
-  })
-
-  it('removes non-block nodes by default', () => {
-    const blocks = [{_type: 'image', _key: 'i', markDefs: [], children: []}] as unknown as Block[]
-    expect(blocksToText(blocks)).toBe('')
-  })
-
-  it('keeps placeholder for non-block nodes when nonTextBehavior is not remove', () => {
-    const blocks = [{_type: 'image', _key: 'i', markDefs: [], children: []}] as unknown as Block[]
-    expect(blocksToText(blocks, {nonTextBehavior: 'keep'})).toBe('[image block]')
-  })
-})

package/src/utils/blocksToText.ts

@@ -1,27 +0,0 @@
-import type {Block} from '../types'
-
-const defaults = {nonTextBehavior: 'remove'}
-
-// Serialize portable text to plain text
-// Based off: https://www.sanity.io/docs/presenting-block-text#plain-text-serialization
-
-export default function (blocks: string | Block[] = '', opts = {}) {
-  if (typeof blocks === 'string') {
-    return blocks
-  }
-
-  if (!Array.isArray(blocks)) {
-    return ''
-  }
-
-  const options = Object.assign({}, defaults, opts)
-  return blocks
-    .map((block) => {
-      if (block._type !== 'block' || !block.children) {
-        return options.nonTextBehavior === 'remove' ? '' : `[${block._type} block]`
-      }
-
-      return block.children.map((child) => child.text).join('')
-    })
-    .join('\n\n')
-}

package/src/utils/constructFilter.test.ts

@@ -1,120 +0,0 @@
-// @vitest-environment node
-
-import {describe, expect, it} from 'vitest'
-
-import {inputs} from '../config/searchFacets'
-import type {SearchFacetInputProps} from '../types'
-import constructFilter from './constructFilter'
-
-describe('constructFilter', () => {
-  it('includes base filter that excludes drafts and restricts asset types', () => {
-    const q = constructFilter({
-      assetTypes: ['image', 'file'],
-      searchFacets: [],
-      searchQuery: undefined,
-    })
-
-    expect(q).toContain('_type in ["sanity.imageAsset","sanity.fileAsset"]')
-    expect(q).toContain('!(_id in path("drafts.**"))')
-  })
-
-  it('limits to a single asset type in picker mode', () => {
-    const q = constructFilter({
-      assetTypes: ['image'],
-      searchFacets: [],
-      searchQuery: undefined,
-    })
-
-    expect(q).toContain('_type in ["sanity.imageAsset"]')
-  })
-
-  it('appends text search on trimmed query', () => {
-    const q = constructFilter({
-      assetTypes: ['file', 'image'],
-      searchFacets: [],
-      searchQuery: '  hello  ',
-    })
-
-    expect(q).toContain(
-      "[_id, altText, assetId, creditLine, description, originalFilename, title, url] match '*hello*'",
-    )
-  })
-
-  it('composes number facet with field modifier (size / KB)', () => {
-    const q = constructFilter({
-      assetTypes: ['image'],
-      searchFacets: [{...inputs.size, value: 500} as SearchFacetInputProps],
-      searchQuery: undefined,
-    })
-
-    expect(q.replace(/\s+/g, ' ')).toContain('round(size / 1000) > 500')
-  })
-
-  it('composes searchable tag facet (references)', () => {
-    const facet = {
-      ...inputs.tag,
-      operatorType: 'references' as const,
-      value: {label: 'T', value: 'tag-id-1'},
-    } as SearchFacetInputProps
-
-    const q = constructFilter({
-      assetTypes: ['image', 'file'],
-      searchFacets: [facet],
-      searchQuery: undefined,
-    })
-
-    expect(q).toContain("references('tag-id-1')")
-  })
-
-  it('composes select facet (inUse)', () => {
-    const q = constructFilter({
-      assetTypes: ['image', 'file'],
-      searchFacets: [structuredClone(inputs.inUse)],
-      searchQuery: undefined,
-    })
-
-    expect(q).toContain('count(*[references(^._id)]) > 0')
-  })
-
-  it('AND-joins base filter, search text, and multiple facets', () => {
-    const q = constructFilter({
-      assetTypes: ['image', 'file'],
-      searchFacets: [{...inputs.title}, {...inputs.inUse}],
-      searchQuery: 'x',
-    })
-
-    const parts = q.split(' && ')
-    expect(parts.length).toBeGreaterThanOrEqual(4)
-  })
-
-  it('matches snapshot for stable GROQ shape (apiVersion / filter regressions)', () => {
-    const q = constructFilter({
-      assetTypes: ['file', 'image'],
-      searchFacets: [
-        {...inputs.size, value: 100} as SearchFacetInputProps,
-        {
-          ...inputs.tag,
-          operatorType: 'references',
-          value: {label: 'Example', value: 'abc123'},
-        } as SearchFacetInputProps,
-      ],
-      searchQuery: 'portrait',
-    })
-
-    const normalized = q.replace(/\s+/g, ' ').trim()
-
-    expect(normalized).toBe(
-      '_type in ["sanity.fileAsset","sanity.imageAsset"] && !(_id in path("drafts.**")) && [_id, altText, assetId, creditLine, description, originalFilename, title, url] match \'*portrait*\' && round(size / 1000) > 100 && references(\'abc123\')',
-    )
-  })
-
-  it('omits text search fragment when searchQuery is undefined', () => {
-    const q = constructFilter({
-      assetTypes: ['image', 'file'],
-      searchFacets: [],
-      searchQuery: undefined,
-    })
-
-    expect(q).not.toContain('match ')
-  })
-})