@sanity/cross-dataset-duplicator 1.5.0 → 2.0.0

package/src/components/DuplicatorWrapper.tsx

@@ -1,67 +0,0 @@
-import {useState, useEffect} from 'react'
-import {Grid, Card, Container, Button} from '@sanity/ui'
-import {SanityDocument, useClient} from 'sanity'
-
-import type {DuplicatorProps} from './Duplicator'
-import Duplicator from './Duplicator'
-
-export default function DuplicatorWrapper(props: DuplicatorProps) {
-  const {docs, token, pluginConfig, onDuplicated} = props
-  const [inbound, setInbound] = useState<SanityDocument[]>([])
-  const {follow = [], apiVersion} = pluginConfig
-
-  // Make the first mode the default if there's only one
-  const [mode, setMode] = useState<'inbound' | 'outbound'>(
-    follow.length === 1 ? follow[0] : `outbound`
-  )
-  const client = useClient({apiVersion})
-
-  // "Inbound" will start with all documents that reference the first one
-  // And then you can gather "Outbound" references thereafter
-  useEffect(() => {
-    ;(async () => {
-      if (follow.includes(`inbound`)) {
-        const inboundReferences = await client.fetch(`*[references($id)]`, {id: docs[0]._id})
-        setInbound([...props.docs, ...inboundReferences])
-      }
-    })()
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [])
-
-  return (
-    <Container>
-      {follow.length > 1 && (follow.includes(`inbound`) || follow.includes(`outbound`)) ? (
-        <Card paddingX={4} paddingBottom={4} marginBottom={4} borderBottom>
-          <Grid columns={2} gap={4}>
-            {follow.includes(`outbound`) ? (
-              <Button
-                mode="ghost"
-                tone="primary"
-                selected={mode === 'outbound'}
-                onClick={() => setMode('outbound')}
-                text="Outbound"
-              />
-            ) : null}
-            {follow.includes(`inbound`) ? (
-              <Button
-                mode="ghost"
-                tone="primary"
-                selected={mode === 'inbound'}
-                onClick={() => setMode('inbound')}
-                disabled={inbound.length === 0}
-                text={inbound.length > 0 ? `Inbound (${inbound.length})` : 'No inbound references'}
-              />
-            ) : null}
-          </Grid>
-        </Card>
-      ) : null}
-      <Duplicator
-        docs={mode === 'outbound' ? docs : inbound}
-        token={token}
-        // draftIds={[]}
-        pluginConfig={pluginConfig}
-        onDuplicated={onDuplicated}
-      />
-    </Container>
-  )
-}

package/src/components/Feedback.tsx

@@ -1,18 +0,0 @@
-import React from 'react'
-import {Card, Text} from '@sanity/ui'
-import type {BadgeTone} from '@sanity/ui'
-
-type FeedbackProps = {
-  children?: React.ReactNode
-  tone?: BadgeTone
-}
-
-export default function Feedback(props: FeedbackProps) {
-  const {children, tone = `caution`} = props
-
-  return (
-    <Card padding={3} radius={2} shadow={1} tone={tone}>
-      <Text size={1}>{children}</Text>
-    </Card>
-  )
-}

package/src/components/ResetSecret.tsx

@@ -1,30 +0,0 @@
-import {useCallback} from 'react'
-import {useClient} from 'sanity'
-import {Button, Flex} from '@sanity/ui'
-
-import {SECRET_NAMESPACE} from '../helpers/constants'
-
-type ResetSecretProps = {
-  apiVersion: string
-}
-
-export default function ResetSecret({apiVersion}: ResetSecretProps) {
-  const client = useClient({apiVersion})
-
-  const handleClick = useCallback(() => {
-    client.delete({query: `*[_id == "secrets.${SECRET_NAMESPACE}"]`})
-  }, [client])
-
-  return (
-    <Flex align="center" justify="flex-end" paddingX={[2, 2, 2, 5]} paddingY={5}>
-      <Button
-        text="Reset Secret"
-        onClick={handleClick}
-        mode="ghost"
-        tone="critical"
-        fontSize={1}
-        padding={2}
-      />
-    </Flex>
-  )
-}

package/src/components/SelectButtons.tsx

@@ -1,84 +0,0 @@
-import {useState, useEffect} from 'react'
-import {Button, Card, Flex} from '@sanity/ui'
-
-import {PayloadItem} from './Duplicator'
-import {isAssetId} from '@sanity/asset-utils'
-
-const buttons = [`All`, `None`, null, `New`, `Existing`, `Older`, null, `Documents`, `Assets`]
-
-type Action = 'ALL' | 'NONE' | 'NEW' | 'EXISTING' | 'OLDER' | 'ASSETS' | 'DOCUMENTS'
-
-type SelectButtonsProps = {
-  payload: PayloadItem[]
-  setPayload: Function
-}
-
-export default function SelectButtons(props: SelectButtonsProps) {
-  const {payload, setPayload} = props
-  const [disabledActions, setDisabledActions] = useState<Action[]>([])
-
-  // Set intiial disabled button
-  useEffect(() => {
-    if (!disabledActions?.length && payload.every((item) => item.include)) {
-      setDisabledActions([`ALL`])
-    }
-  }, [disabledActions?.length, payload])
-
-  function handleSelectButton(action?: Action) {
-    if (!action || !payload.length) return
-
-    const newPayload = [...payload]
-
-    switch (action) {
-      case 'ALL':
-        newPayload.map((item) => (item.include = true))
-        break
-      case 'NONE':
-        newPayload.map((item) => (item.include = false))
-        break
-      case 'NEW':
-        newPayload.map((item) => (item.include = Boolean(item.status === 'CREATE')))
-        break
-      case 'EXISTING':
-        newPayload.map((item) => (item.include = Boolean(item.status === 'EXISTS')))
-        break
-      case 'OLDER':
-        newPayload.map((item) => (item.include = Boolean(item.status === 'OVERWRITE')))
-        break
-      case 'ASSETS':
-        newPayload.map((item) => (item.include = isAssetId(item.doc._id)))
-        break
-      case 'DOCUMENTS':
-        newPayload.map((item) => (item.include = !isAssetId(item.doc._id)))
-        break
-      default:
-        break
-    }
-
-    setDisabledActions([action])
-    setPayload(newPayload)
-  }
-
-  return (
-    <Card padding={1} radius={3} shadow={1}>
-      <Flex gap={2} wrap="wrap">
-        {buttons.map((action, actionIndex) =>
-          action ? (
-            <Button
-              key={action}
-              fontSize={1}
-              mode="bleed"
-              padding={2}
-              text={action}
-              disabled={disabledActions.includes(action.toUpperCase() as Action)}
-              onClick={() => handleSelectButton(action.toUpperCase() as Action)}
-            />
-          ) : (
-            // eslint-disable-next-line react/no-array-index-key
-            <Card key={`divider-${actionIndex}`} borderLeft />
-          )
-        )}
-      </Flex>
-    </Card>
-  )
-}

package/src/components/StatusBadge.tsx

@@ -1,111 +0,0 @@
-import {InfoOutlineIcon} from '@sanity/icons'
-import {Box, Text, Badge, Tooltip} from '@sanity/ui'
-import type {BadgeTone} from '@sanity/ui'
-
-type StatusTones = {
-  EXISTS: BadgeTone
-  OVERWRITE: BadgeTone
-  UPDATE: BadgeTone
-  CREATE: BadgeTone
-  UNPUBLISHED: BadgeTone
-}
-
-const documentTones: StatusTones = {
-  EXISTS: `primary`,
-  OVERWRITE: `critical`,
-  UPDATE: `caution`,
-  CREATE: `positive`,
-  UNPUBLISHED: `caution`,
-}
-
-const assetTones: StatusTones = {
-  EXISTS: `critical`,
-  OVERWRITE: `critical`,
-  UPDATE: `critical`,
-  CREATE: `positive`,
-  UNPUBLISHED: `default`,
-}
-
-export type MessageTypes = {
-  EXISTS: string
-  OVERWRITE: string
-  UPDATE: string
-  CREATE: string
-  UNPUBLISHED: string
-}
-
-const documentMessages: MessageTypes = {
-  // Only happens once document is copied the first time, and _updatedAt is the same
-  EXISTS: `This document already exists at the Destination with the same ID with the same Updated time.`,
-  // Is true immediately after transaction as _updatedAt is updated by API after mutation
-  // Is also true if the document at the destination has been manually modified
-  // Presently, the plugin doesn't actually compare the two documents
-  OVERWRITE: `A newer version of this document exists at the Destination, and it will be overwritten with this version.`,
-  // Document at destination is older
-  UPDATE: `An older version of this document exists at the Destination, and it will be overwritten with this version.`,
-  // Document at destination doesn't exist
-  CREATE: `This document will be created at the destination.`,
-  UNPUBLISHED: `A Draft version of this Document exists in this Dataset, but only the Published version will be duplicated to the destination.`,
-}
-
-const assetMessages: MessageTypes = {
-  EXISTS: `This Asset already exists at the Destination`,
-  OVERWRITE: `This Asset already exists at the Destination`,
-  UPDATE: `This Asset already exists at the Destination`,
-  CREATE: `This Asset does not yet exist at the Destination`,
-  UNPUBLISHED: ``,
-}
-
-const assetStatus: MessageTypes = {
-  EXISTS: `RE-UPLOAD`,
-  OVERWRITE: `RE-UPLOAD`,
-  UPDATE: `RE-UPLOAD`,
-  CREATE: `UPLOAD`,
-  UNPUBLISHED: ``,
-}
-
-type StatusBadgeProps = {
-  isAsset: boolean
-  status?: keyof MessageTypes
-}
-
-export default function StatusBadge(props: StatusBadgeProps) {
-  const {status, isAsset} = props
-
-  if (!status) {
-    return null
-  }
-
-  const badgeTone = isAsset ? assetTones[status] : documentTones[status]
-
-  if (!badgeTone) {
-    return (
-      <Badge muted padding={2} fontSize={1} mode="outline">
-        Checking...
-      </Badge>
-    )
-  }
-
-  const badgeText = isAsset ? assetMessages[status] : documentMessages[status]
-  const badgeStatus = isAsset ? assetStatus[status] : status
-
-  return (
-    <Tooltip
-      content={
-        <Box padding={3} style={{maxWidth: 200}}>
-          <Text size={1}>{badgeText}</Text>
-        </Box>
-      }
-      fallbackPlacements={['right', 'left']}
-      placement="top"
-      portal
-    >
-      <Badge muted padding={3} fontSize={1} tone={badgeTone} mode="outline">
-        {badgeStatus}
-        <Box marginLeft={2} display={'inline-block'} as="span">
-          <InfoOutlineIcon />
-        </Box>
-      </Badge>
-    </Tooltip>
-  )
-}

package/src/context/ConfigProvider.tsx

@@ -1,30 +0,0 @@
-import {useContext} from 'react'
-import {createContext} from 'react'
-import {LayoutProps} from 'sanity'
-
-import {DEFAULT_CONFIG} from '../helpers/constants'
-import {PluginConfig} from '../types'
-
-const CrossDatasetDuplicatorContext = createContext(DEFAULT_CONFIG)
-
-type ConfigProviderProps = LayoutProps & {pluginConfig: Required<PluginConfig>}
-
-/**
- * Plugin config context hook from the Cross Dataset Duplicator plugin
- * @public
- */
-export function useCrossDatasetDuplicatorConfig() {
-  const pluginConfig = useContext(CrossDatasetDuplicatorContext)
-
-  return pluginConfig
-}
-
-export function ConfigProvider(props: ConfigProviderProps) {
-  const {pluginConfig, ...rest} = props
-
-  return (
-    <CrossDatasetDuplicatorContext.Provider value={pluginConfig}>
-      {props.renderDefault(rest)}
-    </CrossDatasetDuplicatorContext.Provider>
-  )
-}

package/src/helpers/constants.ts

@@ -1,12 +0,0 @@
-import {PluginConfig} from '../types'
-
-export const SECRET_NAMESPACE = `CrossDatasetDuplicator`
-
-export const DEFAULT_CONFIG: Required<PluginConfig> = {
-  apiVersion: '2025-02-19',
-  tool: true,
-  types: [],
-  filter: '',
-  follow: ['outbound'],
-  queries: [],
-}

package/src/helpers/getDocumentsInArray.ts

@@ -1,86 +0,0 @@
-import {extractWithPath} from '@sanity/mutator'
-import {SanityClient, SanityDocument} from 'sanity'
-import {PluginConfig} from '../types'
-
-type OptionsBag = {
-  fetchIds: string[]
-  client: SanityClient
-  pluginConfig: PluginConfig
-  currentIds?: Set<string> | null
-  projection?: string
-}
-
-// Recursively fetch Documents from an array of _id's and their references
-// Heavy use of Set is to avoid recursively querying for id's already in the payload
-export async function getDocumentsInArray(options: OptionsBag): Promise<SanityDocument[]> {
-  const {fetchIds, client, pluginConfig, currentIds, projection} = options
-  const collection: SanityDocument[] = []
-
-  // Find initial docs
-  const filter = ['_id in $fetchIds', pluginConfig.filter].filter(Boolean).join(' && ')
-  const query = `*[${filter}]${projection ?? ``}`
-  const data: SanityDocument[] = await client.fetch(query, {
-    fetchIds: fetchIds ?? [],
-  })
-
-  if (!data?.length) {
-    return []
-  }
-
-  const localCurrentIds = currentIds ?? new Set<string>()
-
-  // Find new ids in the returned data
-  // Unless we started with an empty set, get the _ids from the data
-  const newDataIds = new Set<string>(
-    data
-      .map((dataDoc) => dataDoc._id)
-      .filter((id) => (currentIds?.size ? !localCurrentIds.has(id) : Boolean(id)))
-  )
-
-  if (newDataIds.size) {
-    collection.push(...data)
-    // @ts-ignore
-    localCurrentIds.add(...newDataIds)
-
-    // Check new data for more references
-    await Promise.all(
-      data.map(async (doc) => {
-        const expr = `.._ref`
-        const references: string[] = extractWithPath(expr, doc).map((ref) => ref.value as string)
-
-        if (references.length) {
-          // Find references not already in the Collection
-          const newReferenceIds = new Set<string>(
-            references.filter((ref) => !localCurrentIds.has(ref))
-          )
-
-          if (newReferenceIds.size) {
-            // Recursive query for new documents
-            const referenceDocs = await getDocumentsInArray({
-              fetchIds: Array.from(newReferenceIds),
-              currentIds: localCurrentIds,
-              client,
-              pluginConfig,
-            })
-
-            if (referenceDocs?.length) {
-              collection.push(...referenceDocs)
-            }
-          }
-        }
-      })
-    )
-  }
-
-  // Create a unique array of objects from collection
-  // Set() wasn't working for unique id's ¯\_(ツ)_/¯
-  const uniqueCollection = collection.filter(Boolean).reduce((acc: SanityDocument[], cur) => {
-    if (acc.some((doc) => doc._id === cur._id)) {
-      return acc
-    }
-
-    return [...acc, cur]
-  }, [])
-
-  return uniqueCollection
-}

package/src/helpers/index.ts

@@ -1,19 +0,0 @@
-import {CSSProperties} from 'react'
-
-export function createInitialMessage(docCount = 0, refsCount = 0): string {
-  const message = [
-    docCount === 1 ? `This Document contains` : `These ${docCount} Documents contain`,
-    refsCount === 1 ? `1 Reference.` : `${refsCount} References.`,
-    refsCount === 1 ? `That Document` : `Those Documents`,
-    `may have References too. If referenced Documents do not exist at the target Destination, this transaction will fail.`,
-  ]
-
-  return message.join(` `)
-}
-
-export const stickyStyles = (isDarkMode = true): CSSProperties => ({
-  position: 'sticky',
-  top: 0,
-  zIndex: 100,
-  backgroundColor: isDarkMode ? `rgba(10,10,10,0.95)` : `rgba(255,255,255,0.95)`,
-})

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './types'
-export * from './plugin'
-export * from './actions/DuplicateToAction'
-export {useCrossDatasetDuplicatorConfig} from './context/ConfigProvider'
-export {CrossDatasetDuplicatorAction} from './components/CrossDatasetDuplicatorAction'

package/src/plugin.tsx

@@ -1,31 +0,0 @@
-import {definePlugin} from 'sanity'
-
-import {DuplicateToAction} from './actions/DuplicateToAction'
-import {ConfigProvider} from './context/ConfigProvider'
-import {DEFAULT_CONFIG} from './helpers/constants'
-import {crossDatasetDuplicatorTool} from './tool'
-import {PluginConfig} from './types'
-
-/**
- * Plugin: Cross Dataset Duplicator
- * @public
- */
-export const crossDatasetDuplicator = definePlugin<Partial<PluginConfig> | void>((config = {}) => {
-  const pluginConfig = {...DEFAULT_CONFIG, ...config}
-  const {types} = pluginConfig
-
-  return {
-    name: '@sanity/cross-dataset-duplicator',
-    tools: (prev) => (pluginConfig.tool ? [...prev, crossDatasetDuplicatorTool()] : prev),
-    studio: {
-      components: {
-        layout: (props) => ConfigProvider({...props, pluginConfig}),
-      },
-    },
-    document: {
-      actions: (prev, {schemaType}) => {
-        return types && types.includes(schemaType) ? [...prev, DuplicateToAction] : prev
-      },
-    },
-  }
-})

package/src/tool/index.ts

@@ -1,14 +0,0 @@
-import type {Tool} from 'sanity'
-import {LaunchIcon} from '@sanity/icons'
-
-import {CrossDatasetDuplicatorTool, MultiToolConfig} from '../components/CrossDatasetDuplicatorTool'
-
-export const crossDatasetDuplicatorTool = (): Tool<MultiToolConfig> => ({
-  title: 'Duplicator',
-  name: 'duplicator',
-  icon: LaunchIcon,
-  component: CrossDatasetDuplicatorTool,
-  options: {
-    docs: [],
-  },
-})

package/src/types/index.ts

@@ -1,27 +0,0 @@
-import {SanityDocument} from 'sanity'
-
-type PreDefinedQuery = {
-  label: string
-  query: string
-}
-/**
- * Plugin configuration
- * @public
- */
-export interface PluginConfig {
-  apiVersion?: string
-  tool?: boolean
-  types?: string[]
-  filter?: string
-  follow?: ('inbound' | 'outbound')[]
-  queries?: PreDefinedQuery[]
-}
-
-/**
- * Cross Dataset Duplicator document action props
- * @public
- */
-export type CrossDatasetDuplicatorActionProps = {
-  docs: SanityDocument[]
-  onDuplicated?: () => Promise<void>
-}

package/v2-incompatible.js

@@ -1,11 +0,0 @@
-const {showIncompatiblePluginDialog} = require('@sanity/incompatible-plugin')
-const {name, version, sanityExchangeUrl} = require('./package.json')
-
-export default showIncompatiblePluginDialog({
-  name: name,
-  versions: {
-    v3: version,
-    v2: undefined,
-  },
-  sanityExchangeUrl,
-})