Configurable API Version (#58)

* feat: configurable `apiVersion`
* chore: bump deps
* chore: add note to readme about other options

Author: SimeonGriggs

README.md

@@ -2,6 +2,9 @@
 
 Sanity Studio v3 Tool and Document Action for empowering content editors to migrate Documents and Assets between Sanity Datasets and Projects from inside the Studio.
 
+> [!IMPORTANT]
+> You might not need this plugin. It was developed long before Sanity had fully-featured [live preview, visual editing](https://www.sanity.io/docs/visual-editing/introduction-to-visual-editing), [perspectives](https://www.sanity.io/docs/content-lake/perspectives) and [content releases](https://www.sanity.io/docs/user-guides/content-releases) which are more seamless ways to stage and preview content before publishing into production. It is recommended you investigate these features first before using this plugin.
+
 ## Installation
 
 ```
@@ -64,6 +67,7 @@ The plugin has some configuration options. These can be set by adding a config f
       // Required settings to show document action
       types: ['article', 'page'],
       // Optional settings
+      apiVersion: '2025-02-19',
       tool: true,
       filter: '_type != "product"',
       follow: [],

package-lock.json

@@ -90,16 +90,16 @@
     "react-dom": "^18.2.0",
     "react-is": "^18.2.0",
     "rimraf": "^4.4.1",
-    "sanity": "^3.8.1",
-    "styled-components": "^5.3.3",
+    "sanity": "^3.79.0",
+    "styled-components": "^6.1.8",
     "typescript": "^5.0.3"
   },
   "peerDependencies": {
-    "@sanity/ui": "^1.0 || ^2.0",
+    "@sanity/ui": "^2.0.0",
     "react": "^18",
     "react-dom": "^18",
-    "sanity": "^3.0.0",
-    "styled-components": "^5.0 || ^6.0"
+    "sanity": "^3.79.0",
+    "styled-components": "^6.0.0"
   },
   "engines": {
     "node": ">=14.0.0"

package.json

@@ -69,7 +69,7 @@ export default function CrossDatasetDuplicator(props: CrossDatasetDuplicatorProp
     return (
       <>
         <DuplicatorQuery token={secrets?.bearerToken} pluginConfig={pluginConfig} />
-        <ResetSecret />
+        <ResetSecret apiVersion={pluginConfig.apiVersion} />
       </>
     )
   }

src/components/CrossDatasetDuplicator.tsx

@@ -38,15 +38,14 @@ import {getDocumentsInArray} from '../helpers/getDocumentsInArray'
 import SelectButtons from './SelectButtons'
 import StatusBadge, {MessageTypes} from './StatusBadge'
 import Feedback from './Feedback'
-import {clientConfig} from '../helpers/clientConfig'
 import {PluginConfig} from '../types'
 
 export type DuplicatorProps = {
   docs: SanityDocument[]
   // TODO: Find out if this is even used?
   // draftIds: string[]
   token: string
-  pluginConfig: PluginConfig
+  pluginConfig: Required<PluginConfig>
   onDuplicated?: () => Promise<void>
 }
 
@@ -71,7 +70,7 @@ export default function Duplicator(props: DuplicatorProps) {
   const isDarkMode = useTheme().sanity.color.dark
 
   // Prepare origin (this Studio) client
-  const originClient = useClient(clientConfig)
+  const originClient = useClient({apiVersion: pluginConfig.apiVersion})
 
   const schema = useSchema()
 
@@ -139,7 +138,6 @@ export default function Duplicator(props: DuplicatorProps) {
 
     const payloadIds = payloadActual.map(({doc}) => doc._id)
     const destinationClient = originClient.withConfig({
-      ...clientConfig,
       dataset: destination.dataset,
       projectId: destination.projectId,
     })
@@ -235,7 +233,7 @@ export default function Duplicator(props: DuplicatorProps) {
     setMessage({text: 'Duplicating...', tone: `transparent`})
 
     const destinationClient = originClient.withConfig({
-      ...clientConfig,
+      apiVersion: pluginConfig.apiVersion,
       dataset: destination.dataset,
       projectId: destination.projectId,
     })

src/components/Duplicator.tsx

@@ -3,24 +3,22 @@ import {Button, Stack, Box, Label, Text, Card, Flex, Grid, Container, TextInput}
 import {useSchema, useClient, SanityDocument} from 'sanity'
 
 import Duplicator from './Duplicator'
-import {clientConfig} from '../helpers/clientConfig'
 import {PluginConfig} from '../types'
 
 type DuplicatorQueryProps = {
   token: string
-  pluginConfig: PluginConfig
+  pluginConfig: Required<PluginConfig>
 }
 
 type InitialData = {
   docs: SanityDocument[]
-  // draftIds: string[]
 }
 
 export default function DuplicatorQuery(props: DuplicatorQueryProps) {
   const {token, pluginConfig} = props
 
-  const {queries: preDefinedQueries} = pluginConfig
-  const originClient = useClient(clientConfig)
+  const {queries: preDefinedQueries, apiVersion} = pluginConfig
+  const originClient = useClient({apiVersion})
 
   const schema = useSchema()
   const schemaTypes = schema.getTypeNames()
@@ -29,7 +27,6 @@ export default function DuplicatorQuery(props: DuplicatorQueryProps) {
   const [fetched, setFetched] = useState(false)
   const [initialData, setInitialData] = useState<InitialData>({
     docs: [],
-    // draftIds: []
   })
   function handleSubmit(e?: any) {
     if (e) e.preventDefault()
@@ -43,13 +40,9 @@ export default function DuplicatorQuery(props: DuplicatorQueryProps) {
               .filter((doc) => schemaTypes.includes(doc._type))
               .filter((doc) => !doc._id.startsWith(`drafts.`))
           : []
-        // const initialDraftIds = res.length
-        //   ? res.filter((doc) => doc._id.startsWith(`drafts.`)).map((doc) => doc._id)
-        //   : []
 
         setInitialData({
           docs: registeredAndPublishedDocs,
-          // draftIds: initialDraftIds
         })
         setFetched(true)
       })

src/components/DuplicatorQuery.tsx

@@ -4,18 +4,17 @@ import {SanityDocument, useClient} from 'sanity'
 
 import type {DuplicatorProps} from './Duplicator'
 import Duplicator from './Duplicator'
-import {clientConfig} from '../helpers/clientConfig'
 
 export default function DuplicatorWrapper(props: DuplicatorProps) {
   const {docs, token, pluginConfig, onDuplicated} = props
   const [inbound, setInbound] = useState<SanityDocument[]>([])
-  const {follow = []} = pluginConfig
+  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(clientConfig)
+  const client = useClient({apiVersion})
 
   // "Inbound" will start with all documents that reference the first one
   // And then you can gather "Outbound" references thereafter

src/components/DuplicatorWrapper.tsx

@@ -2,11 +2,14 @@ import {useCallback} from 'react'
 import {useClient} from 'sanity'
 import {Button, Flex} from '@sanity/ui'
 
-import {clientConfig} from '../helpers/clientConfig'
 import {SECRET_NAMESPACE} from '../helpers/constants'
 
-export default function ResetSecret() {
-  const client = useClient(clientConfig)
+type ResetSecretProps = {
+  apiVersion: string
+}
+
+export default function ResetSecret({apiVersion}: ResetSecretProps) {
+  const client = useClient({apiVersion})
 
   const handleClick = useCallback(() => {
     client.delete({query: `*[_id == "secrets.${SECRET_NAMESPACE}"]`})

src/components/ResetSecret.tsx

@@ -7,7 +7,7 @@ import {PluginConfig} from '../types'
 
 const CrossDatasetDuplicatorContext = createContext(DEFAULT_CONFIG)
 
-type ConfigProviderProps = LayoutProps & {pluginConfig: PluginConfig}
+type ConfigProviderProps = LayoutProps & {pluginConfig: Required<PluginConfig>}
 
 /**
  * Plugin config context hook from the Cross Dataset Duplicator plugin