@sanity/cross-dataset-duplicator 1.0.0 → 1.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Sanity.io
+Copyright (c) 2023 Sanity.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -19,9 +19,9 @@ This plugin is designed as a convenience for Authors to make small, infrequent c
 
 - This plugin should be used in conjunction with a reliable backup strategy.
 - Proceed with caution as this plugin can instantly write changes to Datasets.
-- Larger migrations may take more time, especially with Assets. The plugin tries to mitigate this by rate limiting asset uploads to 3 at a time.
+- Larger migrations may take more time, especially with Assets. Trying to upload them all at once could result in a rate-limiting issue, so the plugin mitigates this by limiting simultaneous asset uploads to 3.
 - If an Asset is already present at the destination, there's no need to duplicate it again.
-- Before starting a Duplication you can select which Documents and Assets to include. Migrations will fail if every Referenced Document or Asset is not included in the transaction or already present at the destination Dataset.
+- Before starting a Duplication you can select which Documents and Assets to include. Migrations will fail if every Referenced Document or Asset is not included in the transaction or is already present at the destination Dataset.
 
 ## Tool
 
@@ -35,17 +35,15 @@ The **Duplicate to...** Document Action allows you to migrate an individual Docu
 
 ![Cross Dataset Duplicator Action in Sanity Studio v3](./img/cdd-action.png)
 
-**Note:** If your Studio registered its own Document Actions, the plugin config will be overruled. See "Importing the Document Action" below.
-
 ## Required Setup
 
 ### 1. Workspaces
 
 You must have more than one [Workspace configured](https://www.sanity.io/docs/config-api-reference#37c85e3072b2) to use this plugin. 
 
-All Datasets and Project ID's setup as Workspaces will become selectable "destinations" for Migrations.
+All Datasets and Project IDs set up as Workspaces will become selectable "destinations" for Migrations.
 
-Once setup, you will see a dropdown menu next to the Search bar in the Studio with the Datasets you have configured.
+Once set up, you will see a dropdown menu next to the Search bar in the Studio with the Datasets you have configured.
 
 ### 2. Configuration
 
@@ -73,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.
@@ -115,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/dist/index.d.ts

@@ -0,0 +1,551 @@
+/// <reference types="react" />
+
+import {DocumentActionProps} from 'sanity'
+import {ForwardRefExoticComponent} from 'react'
+import {Plugin as Plugin_2} from 'sanity'
+import {RefAttributes} from 'react'
+import {SanityDocument} from 'sanity'
+import {SVGProps} from 'react'
+
+/**
+ * Plugin: Cross Dataset Duplicator
+ * @public
+ */
+export declare const crossDatasetDuplicator: Plugin_2<void | PluginConfig>
+
+/**
+ * Component to perform a migration from the Cross Dataset Duplicator plugin
+ * @public
+ */
+export declare function CrossDatasetDuplicatorAction(
+  props: CrossDatasetDuplicatorActionProps
+): JSX.Element
+
+/**
+ * Cross Dataset Duplicator document action props
+ * @public
+ */
+export declare type CrossDatasetDuplicatorActionProps = {
+  docs: SanityDocument[]
+  onDuplicated?: () => Promise<void>
+}
+
+/**
+ * Document action from the Cross Dataset Duplicator plugin
+ * @public
+ */
+export declare const DuplicateToAction: {
+  (props: DocumentActionProps): {
+    disabled: SanityDocument | null
+    title: string | null
+    label: string
+    dialog:
+      | false
+      | {
+          type: string
+          title: string
+          content: JSX.Element
+          onClose: () => void
+        }
+      | null
+    onHandle: () => void
+    icon: ForwardRefExoticComponent<
+      Pick<
+        SVGProps<SVGSVGElement>,
+        | 'string'
+        | 'filter'
+        | 'fill'
+        | 'values'
+        | 'height'
+        | 'crossOrigin'
+        | 'href'
+        | 'max'
+        | 'media'
+        | 'method'
+        | 'min'
+        | 'name'
+        | 'target'
+        | 'type'
+        | 'width'
+        | 'className'
+        | 'id'
+        | 'lang'
+        | 'style'
+        | 'tabIndex'
+        | 'role'
+        | 'color'
+        | 'aria-activedescendant'
+        | 'aria-atomic'
+        | 'aria-autocomplete'
+        | 'aria-busy'
+        | 'aria-checked'
+        | 'aria-colcount'
+        | 'aria-colindex'
+        | 'aria-colspan'
+        | 'aria-controls'
+        | 'aria-current'
+        | 'aria-describedby'
+        | 'aria-details'
+        | 'aria-disabled'
+        | 'aria-dropeffect'
+        | 'aria-errormessage'
+        | 'aria-expanded'
+        | 'aria-flowto'
+        | 'aria-grabbed'
+        | 'aria-haspopup'
+        | 'aria-hidden'
+        | 'aria-invalid'
+        | 'aria-keyshortcuts'
+        | 'aria-label'
+        | 'aria-labelledby'
+        | 'aria-level'
+        | 'aria-live'
+        | 'aria-modal'
+        | 'aria-multiline'
+        | 'aria-multiselectable'
+        | 'aria-orientation'
+        | 'aria-owns'
+        | 'aria-placeholder'
+        | 'aria-posinset'
+        | 'aria-pressed'
+        | 'aria-readonly'
+        | 'aria-relevant'
+        | 'aria-required'
+        | 'aria-roledescription'
+        | 'aria-rowcount'
+        | 'aria-rowindex'
+        | 'aria-rowspan'
+        | 'aria-selected'
+        | 'aria-setsize'
+        | 'aria-sort'
+        | 'aria-valuemax'
+        | 'aria-valuemin'
+        | 'aria-valuenow'
+        | 'aria-valuetext'
+        | 'children'
+        | 'dangerouslySetInnerHTML'
+        | 'onCopy'
+        | 'onCopyCapture'
+        | 'onCut'
+        | 'onCutCapture'
+        | 'onPaste'
+        | 'onPasteCapture'
+        | 'onCompositionEnd'
+        | 'onCompositionEndCapture'
+        | 'onCompositionStart'
+        | 'onCompositionStartCapture'
+        | 'onCompositionUpdate'
+        | 'onCompositionUpdateCapture'
+        | 'onFocus'
+        | 'onFocusCapture'
+        | 'onBlur'
+        | 'onBlurCapture'
+        | 'onChange'
+        | 'onChangeCapture'
+        | 'onBeforeInput'
+        | 'onBeforeInputCapture'
+        | 'onInput'
+        | 'onInputCapture'
+        | 'onReset'
+        | 'onResetCapture'
+        | 'onSubmit'
+        | 'onSubmitCapture'
+        | 'onInvalid'
+        | 'onInvalidCapture'
+        | 'onLoad'
+        | 'onLoadCapture'
+        | 'onError'
+        | 'onErrorCapture'
+        | 'onKeyDown'
+        | 'onKeyDownCapture'
+        | 'onKeyPress'
+        | 'onKeyPressCapture'
+        | 'onKeyUp'
+        | 'onKeyUpCapture'
+        | 'onAbort'
+        | 'onAbortCapture'
+        | 'onCanPlay'
+        | 'onCanPlayCapture'
+        | 'onCanPlayThrough'
+        | 'onCanPlayThroughCapture'
+        | 'onDurationChange'
+        | 'onDurationChangeCapture'
+        | 'onEmptied'
+        | 'onEmptiedCapture'
+        | 'onEncrypted'
+        | 'onEncryptedCapture'
+        | 'onEnded'
+        | 'onEndedCapture'
+        | 'onLoadedData'
+        | 'onLoadedDataCapture'
+        | 'onLoadedMetadata'
+        | 'onLoadedMetadataCapture'
+        | 'onLoadStart'
+        | 'onLoadStartCapture'
+        | 'onPause'
+        | 'onPauseCapture'
+        | 'onPlay'
+        | 'onPlayCapture'
+        | 'onPlaying'
+        | 'onPlayingCapture'
+        | 'onProgress'
+        | 'onProgressCapture'
+        | 'onRateChange'
+        | 'onRateChangeCapture'
+        | 'onResize'
+        | 'onResizeCapture'
+        | 'onSeeked'
+        | 'onSeekedCapture'
+        | 'onSeeking'
+        | 'onSeekingCapture'
+        | 'onStalled'
+        | 'onStalledCapture'
+        | 'onSuspend'
+        | 'onSuspendCapture'
+        | 'onTimeUpdate'
+        | 'onTimeUpdateCapture'
+        | 'onVolumeChange'
+        | 'onVolumeChangeCapture'
+        | 'onWaiting'
+        | 'onWaitingCapture'
+        | 'onAuxClick'
+        | 'onAuxClickCapture'
+        | 'onClick'
+        | 'onClickCapture'
+        | 'onContextMenu'
+        | 'onContextMenuCapture'
+        | 'onDoubleClick'
+        | 'onDoubleClickCapture'
+        | 'onDrag'
+        | 'onDragCapture'
+        | 'onDragEnd'
+        | 'onDragEndCapture'
+        | 'onDragEnter'
+        | 'onDragEnterCapture'
+        | 'onDragExit'
+        | 'onDragExitCapture'
+        | 'onDragLeave'
+        | 'onDragLeaveCapture'
+        | 'onDragOver'
+        | 'onDragOverCapture'
+        | 'onDragStart'
+        | 'onDragStartCapture'
+        | 'onDrop'
+        | 'onDropCapture'
+        | 'onMouseDown'
+        | 'onMouseDownCapture'
+        | 'onMouseEnter'
+        | 'onMouseLeave'
+        | 'onMouseMove'
+        | 'onMouseMoveCapture'
+        | 'onMouseOut'
+        | 'onMouseOutCapture'
+        | 'onMouseOver'
+        | 'onMouseOverCapture'
+        | 'onMouseUp'
+        | 'onMouseUpCapture'
+        | 'onSelect'
+        | 'onSelectCapture'
+        | 'onTouchCancel'
+        | 'onTouchCancelCapture'
+        | 'onTouchEnd'
+        | 'onTouchEndCapture'
+        | 'onTouchMove'
+        | 'onTouchMoveCapture'
+        | 'onTouchStart'
+        | 'onTouchStartCapture'
+        | 'onPointerDown'
+        | 'onPointerDownCapture'
+        | 'onPointerMove'
+        | 'onPointerMoveCapture'
+        | 'onPointerUp'
+        | 'onPointerUpCapture'
+        | 'onPointerCancel'
+        | 'onPointerCancelCapture'
+        | 'onPointerEnter'
+        | 'onPointerEnterCapture'
+        | 'onPointerLeave'
+        | 'onPointerLeaveCapture'
+        | 'onPointerOver'
+        | 'onPointerOverCapture'
+        | 'onPointerOut'
+        | 'onPointerOutCapture'
+        | 'onGotPointerCapture'
+        | 'onGotPointerCaptureCapture'
+        | 'onLostPointerCapture'
+        | 'onLostPointerCaptureCapture'
+        | 'onScroll'
+        | 'onScrollCapture'
+        | 'onWheel'
+        | 'onWheelCapture'
+        | 'onAnimationStart'
+        | 'onAnimationStartCapture'
+        | 'onAnimationEnd'
+        | 'onAnimationEndCapture'
+        | 'onAnimationIteration'
+        | 'onAnimationIterationCapture'
+        | 'onTransitionEnd'
+        | 'onTransitionEndCapture'
+        | 'key'
+        | 'display'
+        | 'overflow'
+        | 'radius'
+        | 'clipPath'
+        | 'mask'
+        | 'path'
+        | 'direction'
+        | 'fontSize'
+        | 'mode'
+        | 'to'
+        | 'accentHeight'
+        | 'accumulate'
+        | 'additive'
+        | 'alignmentBaseline'
+        | 'allowReorder'
+        | 'alphabetic'
+        | 'amplitude'
+        | 'arabicForm'
+        | 'ascent'
+        | 'attributeName'
+        | 'attributeType'
+        | 'autoReverse'
+        | 'azimuth'
+        | 'baseFrequency'
+        | 'baselineShift'
+        | 'baseProfile'
+        | 'bbox'
+        | 'begin'
+        | 'bias'
+        | 'by'
+        | 'calcMode'
+        | 'capHeight'
+        | 'clip'
+        | 'clipPathUnits'
+        | 'clipRule'
+        | 'colorInterpolation'
+        | 'colorInterpolationFilters'
+        | 'colorProfile'
+        | 'colorRendering'
+        | 'contentScriptType'
+        | 'contentStyleType'
+        | 'cursor'
+        | 'cx'
+        | 'cy'
+        | 'd'
+        | 'decelerate'
+        | 'descent'
+        | 'diffuseConstant'
+        | 'divisor'
+        | 'dominantBaseline'
+        | 'dur'
+        | 'dx'
+        | 'dy'
+        | 'edgeMode'
+        | 'elevation'
+        | 'enableBackground'
+        | 'end'
+        | 'exponent'
+        | 'externalResourcesRequired'
+        | 'fillOpacity'
+        | 'fillRule'
+        | 'filterRes'
+        | 'filterUnits'
+        | 'floodColor'
+        | 'floodOpacity'
+        | 'focusable'
+        | 'fontFamily'
+        | 'fontSizeAdjust'
+        | 'fontStretch'
+        | 'fontStyle'
+        | 'fontVariant'
+        | 'fontWeight'
+        | 'format'
+        | 'fr'
+        | 'from'
+        | 'fx'
+        | 'fy'
+        | 'g1'
+        | 'g2'
+        | 'glyphName'
+        | 'glyphOrientationHorizontal'
+        | 'glyphOrientationVertical'
+        | 'glyphRef'
+        | 'gradientTransform'
+        | 'gradientUnits'
+        | 'hanging'
+        | 'horizAdvX'
+        | 'horizOriginX'
+        | 'ideographic'
+        | 'imageRendering'
+        | 'in2'
+        | 'in'
+        | 'intercept'
+        | 'k1'
+        | 'k2'
+        | 'k3'
+        | 'k4'
+        | 'k'
+        | 'kernelMatrix'
+        | 'kernelUnitLength'
+        | 'kerning'
+        | 'keyPoints'
+        | 'keySplines'
+        | 'keyTimes'
+        | 'lengthAdjust'
+        | 'letterSpacing'
+        | 'lightingColor'
+        | 'limitingConeAngle'
+        | 'local'
+        | 'markerEnd'
+        | 'markerHeight'
+        | 'markerMid'
+        | 'markerStart'
+        | 'markerUnits'
+        | 'markerWidth'
+        | 'maskContentUnits'
+        | 'maskUnits'
+        | 'mathematical'
+        | 'numOctaves'
+        | 'offset'
+        | 'opacity'
+        | 'operator'
+        | 'order'
+        | 'orient'
+        | 'orientation'
+        | 'origin'
+        | 'overlinePosition'
+        | 'overlineThickness'
+        | 'paintOrder'
+        | 'panose1'
+        | 'pathLength'
+        | 'patternContentUnits'
+        | 'patternTransform'
+        | 'patternUnits'
+        | 'pointerEvents'
+        | 'points'
+        | 'pointsAtX'
+        | 'pointsAtY'
+        | 'pointsAtZ'
+        | 'preserveAlpha'
+        | 'preserveAspectRatio'
+        | 'primitiveUnits'
+        | 'r'
+        | 'refX'
+        | 'refY'
+        | 'renderingIntent'
+        | 'repeatCount'
+        | 'repeatDur'
+        | 'requiredExtensions'
+        | 'requiredFeatures'
+        | 'restart'
+        | 'result'
+        | 'rotate'
+        | 'rx'
+        | 'ry'
+        | 'scale'
+        | 'seed'
+        | 'shapeRendering'
+        | 'slope'
+        | 'spacing'
+        | 'specularConstant'
+        | 'specularExponent'
+        | 'speed'
+        | 'spreadMethod'
+        | 'startOffset'
+        | 'stdDeviation'
+        | 'stemh'
+        | 'stemv'
+        | 'stitchTiles'
+        | 'stopColor'
+        | 'stopOpacity'
+        | 'strikethroughPosition'
+        | 'strikethroughThickness'
+        | 'stroke'
+        | 'strokeDasharray'
+        | 'strokeDashoffset'
+        | 'strokeLinecap'
+        | 'strokeLinejoin'
+        | 'strokeMiterlimit'
+        | 'strokeOpacity'
+        | 'strokeWidth'
+        | 'surfaceScale'
+        | 'systemLanguage'
+        | 'tableValues'
+        | 'targetX'
+        | 'targetY'
+        | 'textAnchor'
+        | 'textDecoration'
+        | 'textLength'
+        | 'textRendering'
+        | 'transform'
+        | 'u1'
+        | 'u2'
+        | 'underlinePosition'
+        | 'underlineThickness'
+        | 'unicode'
+        | 'unicodeBidi'
+        | 'unicodeRange'
+        | 'unitsPerEm'
+        | 'vAlphabetic'
+        | 'vectorEffect'
+        | 'version'
+        | 'vertAdvY'
+        | 'vertOriginX'
+        | 'vertOriginY'
+        | 'vHanging'
+        | 'vIdeographic'
+        | 'viewBox'
+        | 'viewTarget'
+        | 'visibility'
+        | 'vMathematical'
+        | 'widths'
+        | 'wordSpacing'
+        | 'writingMode'
+        | 'x1'
+        | 'x2'
+        | 'x'
+        | 'xChannelSelector'
+        | 'xHeight'
+        | 'xlinkActuate'
+        | 'xlinkArcrole'
+        | 'xlinkHref'
+        | 'xlinkRole'
+        | 'xlinkShow'
+        | 'xlinkTitle'
+        | 'xlinkType'
+        | 'xmlBase'
+        | 'xmlLang'
+        | 'xmlns'
+        | 'xmlnsXlink'
+        | 'xmlSpace'
+        | 'y1'
+        | 'y2'
+        | 'y'
+        | 'yChannelSelector'
+        | 'z'
+        | 'zoomAndPan'
+      > &
+        RefAttributes<SVGSVGElement>
+    >
+  }
+  action: string
+}
+
+/**
+ * Plugin configuration
+ * @public
+ */
+export declare interface PluginConfig {
+  tool?: boolean
+  types?: string[]
+  filter?: string
+  follow?: ('inbound' | 'outbound')[]
+}
+
+/**
+ * Plugin config context hook from the Cross Dataset Duplicator plugin
+ * @public
+ */
+export declare function useCrossDatasetDuplicatorConfig(): PluginConfig
+
+export {}