sanity-plugin-workflow 1.0.0-beta.6 → 1.0.0-beta.8

package/src/helpers/generateMultipleOrderRanks.ts

@@ -0,0 +1,80 @@
+import {LexoRank} from 'lexorank'
+
+function generateMiddleValue(ranks: (LexoRank | undefined)[]) {
+  // Has no undefined values
+  if (!ranks.some((rank) => !rank)) {
+    return ranks
+  }
+
+  // Find the first undefined value
+  const firstUndefined = ranks.findIndex((rank) => !rank)
+
+  // Find the first defined value after the undefined value
+  const firstDefinedAfter = ranks.findIndex(
+    (rank, index) => rank && index > firstUndefined
+  )
+  // Find the first defined value before the undefined value
+  const firstDefinedBefore = ranks.findLastIndex(
+    (rank, index) => rank && index < firstUndefined
+  )
+
+  if (firstDefinedAfter === -1 || firstDefinedBefore === -1) {
+    throw new Error(
+      `Unable to generate middle value between indexes ${firstDefinedBefore} and ${firstDefinedAfter}`
+    )
+  }
+
+  const beforeRank = ranks[firstDefinedBefore]
+  const afterRank = ranks[firstDefinedAfter]
+
+  if (
+    !beforeRank ||
+    typeof beforeRank === 'undefined' ||
+    !afterRank ||
+    typeof afterRank === 'undefined'
+  ) {
+    throw new Error(
+      `Unable to generate middle value between indexes ${firstDefinedBefore} and ${firstDefinedAfter}`
+    )
+  }
+
+  // Generate a new value between the two
+  const between = beforeRank.between(afterRank)
+
+  // Calculate the middle index between the defined values
+  const middle = Math.floor((firstDefinedAfter + firstDefinedBefore) / 2)
+
+  if (ranks[middle]) {
+    throw new Error(`Should not have overwritten value at index ${middle}`)
+  }
+
+  // Insert the new value into the array
+  ranks[middle] = between
+
+  // Return as a new array
+  return ranks
+}
+
+// Generates an array of LexoRanks between two values
+export function generateMultipleOrderRanks(
+  count: number,
+  start?: LexoRank,
+  end?: LexoRank
+): LexoRank[] {
+  // Begin array with correct size
+  let ranks = [...Array(count)]
+
+  // Use or create default values
+  const rankStart = start ?? LexoRank.min().genNext().genNext()
+  const rankEnd = end ?? LexoRank.max().genPrev().genPrev()
+
+  ranks[0] = rankStart
+  ranks[count - 1] = rankEnd
+
+  // Keep processing the array until every value between undefined values is defined
+  for (let i = 0; i < count; i++) {
+    ranks = generateMiddleValue(ranks)
+  }
+
+  return ranks.sort((a, b) => a.toString().localeCompare(b.toString()))
+}

package/src/hooks/useWorkflowDocuments.tsx

@@ -122,30 +122,33 @@ export function useWorkflowDocuments(schemaTypes: string[]): WorkflowDocuments {
       const {_id, _type} = document
 
       // Metadata + useDocumentOperation always uses Published id
-      const {documentId} = document._metadata || {}
+      const {documentId, _rev} = document._metadata || {}
 
       await client
         .patch(`workflow-metadata.${documentId}`)
-        // Removed because it was effecting fast-updates between columns
-        // TODO: Prevent dragging while patching instead while keeping optimistic updates and revert when patch fails
-        // .ifRevisionId(document._metadata._rev)
+        .ifRevisionId(_rev)
         .set({state: newStateId, orderRank: newOrder})
         .commit()
-        .then(() => {
-          return toast.push({
-            title: `Moved to "${newState?.title ?? newStateId}"`,
+        .then((res) => {
+          toast.push({
+            title:
+              newState.id === document._metadata.state
+                ? `Reordered in "${newState?.title ?? newStateId}"`
+                : `Moved to "${newState?.title ?? newStateId}"`,
             status: 'success',
           })
+          return res
         })
         .catch((err) => {
           // Revert optimistic update
           setLocalDocuments(currentLocalData)
 
-          return toast.push({
+          toast.push({
             title: `Failed to move to "${newState?.title ?? newStateId}"`,
             description: err.message,
             status: 'error',
           })
+          return null
         })
 
       // Send back to the workflow board so a document update can happen