@sanity/cross-dataset-duplicator 1.1.0 → 1.2.1

package/README.md

@@ -71,13 +71,63 @@ The plugin has some configuration options. These can be set by adding a config f
  })
 ```
 
-Options:
+#### Options:
 
 - `tool` (boolean, default: true) – Set whether the Migration **Tool** is enabled.
 - `types` (Array[String], default: []) – Set which Schema Types the Migration Action should be enabled in.
 - `filter` (String, default: undefined) - Set a predicate for documents when gathering dependencies.
 - `follow` (("inbound" | "outbound")[], default: []) – Add buttons to allow the user to begin with just the existing document or first fetch all inbound references.
 
+#### Action Options
+
+The Document Action has additional config options:
+
+- `onDuplicated` (`() => Promise<void>`, default: undefined) - fire a callback after documents have been duplicated.
+
+The `onDuplicated` callback could be used to update update metadata after documents have been synced, or to perform arbitrary cleanup tasks like closing the dialog:
+
+```tsx
+const DuplicatorAction = ({ published, onComplete }: DocumentActionProps) => {
+  const [dialogOpen, setDialogOpen] = useState(false)
+  const [submitting, setSubmitting] = useState(false)
+  const [duplicated, setDuplicated] = useState(false)
+
+  return {
+    label: 'Duplicate',
+    title: 'Duplicate',
+    tone: 'positive',
+    disabled: submitting || duplicated,
+    loading: submitting,
+    icon: PublishIcon,
+    dialog: dialogOpen && published && {
+      type: 'popover',
+      title: 'Cross Dataset Duplicator',
+      content: (
+        <CrossDatasetDuplicatorAction
+          docs={[published]}
+          onDuplicated={async () => {
+            alert('data migrated')
+            await new Promise((resolve) => {
+              setTimeout(() => {
+                setDialogOpen(false);
+                setDuplicated(true)
+                resolve()
+              }, 1000)
+            })
+          }}
+        />
+      ),
+      onHandle: () => setDialogOpen(true),
+      onClose: () => {
+        onComplete()
+        setDialogOpen(false)
+        setSubmitting(false)
+      }
+    },
+  }
+}
+```
+
 ### 3. Authentication Key
 
 To Duplicate the original files of Assets, an API Token with Viewer permissions is required. You will be prompted for this the first time you attempt to use either the Tool or Document Action on any Dataset.
@@ -113,4 +163,8 @@ on how to run this plugin with hotreload in the studio.
 Run ["CI & Release" workflow](https://github.com/sanity-io/cross-dataset-duplicator/actions/workflows/main.yml).
 Make sure to select the main branch and check "Release new version".
 
-Semantic release will only release on configured branches, so it is safe to run release on any branch.
+Semantic release will only release on configured branches, so it is safe to run release on any branch.
+
+## License
+
+[MIT](LICENSE) © Sanity.io

package/{lib/src → dist}/index.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="react" />
 
 import {DocumentActionProps} from 'sanity'
+import {ForwardRefExoticComponent} from 'react'
 import {Plugin as Plugin_2} from 'sanity'
-import {default as React_2} from 'react'
+import {RefAttributes} from 'react'
 import {SanityDocument} from 'sanity'
+import {SVGProps} from 'react'
 
 /**
  * Plugin: Cross Dataset Duplicator
@@ -25,6 +27,7 @@ export declare function CrossDatasetDuplicatorAction(
  */
 export declare type CrossDatasetDuplicatorActionProps = {
   docs: SanityDocument[]
+  onDuplicated?: () => Promise<void>
 }
 
 /**
@@ -46,10 +49,13 @@ export declare const DuplicateToAction: {
         }
       | null
     onHandle: () => void
-    icon: React_2.ForwardRefExoticComponent<
+    icon: ForwardRefExoticComponent<
       Pick<
-        React_2.SVGProps<SVGSVGElement>,
+        SVGProps<SVGSVGElement>,
         | 'string'
+        | 'filter'
+        | 'fill'
+        | 'values'
         | 'height'
         | 'crossOrigin'
         | 'href'
@@ -285,10 +291,8 @@ export declare const DuplicateToAction: {
         | 'overflow'
         | 'radius'
         | 'clipPath'
-        | 'filter'
         | 'mask'
         | 'path'
-        | 'fill'
         | 'direction'
         | 'fontSize'
         | 'mode'
@@ -483,7 +487,6 @@ export declare const DuplicateToAction: {
         | 'unicodeRange'
         | 'unitsPerEm'
         | 'vAlphabetic'
-        | 'values'
         | 'vectorEffect'
         | 'version'
         | 'vertAdvY'
@@ -522,7 +525,7 @@ export declare const DuplicateToAction: {
         | 'z'
         | 'zoomAndPan'
       > &
-        React_2.RefAttributes<SVGSVGElement>
+        RefAttributes<SVGSVGElement>
     >
   }
   action: string