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

package/README.md

@@ -12,6 +12,8 @@ With Sanity Studio you can [customize your content tools to support arbitrary wo
 
 This plugin is distributed as a **reference implementation** of these customization APIs and is not considered to be a feature-complete implementation of what workflow management requires in production. It is a starting point intended to be forked and customized to the needs of your organization and content creators.
 
+A key intention of this plugin is that it **does not influence or modify whether a document is in draft or published**. It only tracks the values of a separate "metadata" document. In this implementation, an "Approved" document could be a draft but will still need publishing. "Approving" the document simply removes it from the Workflow process. You will decide if Publishing the document happens in the Studio like normal, using the [Scheduled Publishing plugin](https://www.sanity.io/plugins/scheduled-publishing) or the [Scheduling API](https://www.sanity.io/docs/scheduling-api#fa3bb95f83ed).
+
 ![Screenshot 2023-03-21 at 12 11 24](https://user-images.githubusercontent.com/9684022/226602179-5bd3d91a-9c27-431e-be18-3c70f06c6ccb.png)
 
 ## Features
@@ -51,7 +53,7 @@ Add it as a plugin in sanity.config.ts (or .js):
             // schemaTypes: ['article', 'product'],
             schemaTypes: [],
             // Optional, see below
-            states: [],
+            // states: [],
          })
      ]
  })
@@ -101,10 +103,12 @@ Once the Workflow is complete, the metadata can be removed by using the "Complet
 
 This plugin is largely based on the original Workflow Demo built into a Sanity Studio v2 project. The major differences are:
 
-* This plugin can be more easily installed and configured, not just code examples built into a Studio project
-* Documents must "opt-in" to and removed from the Workflow, in the previous version all documents were in the workflow which would fill up the interface
-* User Roles and Assignments can affect the Workflow. Set rules to enforce which States documents can move between and if being assigned to a document is required to move it to a new State
-* Ability to filter Schema types and assigned Users
+* This plugin is not concerned with nor will modify whether a document is in draft or published.
+* This plugin can be more easily installed and configured, not just code examples built into a Studio project.
+* Documents must "opt-in" to and be removed from the Workflow. In the previous version, all documents were in the workflow which would fill up the interface and negatively affect performance.
+* Document validation status can be used as a way to prevent movement through the workflow.
+* User Roles and Assignments can affect the Workflow. Set rules to enforce which States documents can move between and if being assigned to a document is required to move it to a new State.
+* This plugin can filter Schema types and assigned Users.
 
 ## License
 

package/lib/index.esm.js

@@ -633,7 +633,7 @@ function useWorkflowDocuments(schemaTypes) {
       setLocalDocuments(data);
     }
   }, [data]);
-  const move = React.useCallback((draggedId, destination, states, newOrder) => {
+  const move = React.useCallback(async (draggedId, destination, states, newOrder) => {
     const currentLocalData = localDocuments;
     const newLocalDocuments = localDocuments.map(item => {
       var _a;
@@ -680,10 +680,9 @@ function useWorkflowDocuments(schemaTypes) {
       _type
     } = document;
     const {
-      _rev,
       documentId
     } = document._metadata || {};
-    client.patch("workflow-metadata.".concat(documentId)).ifRevisionId(_rev).set({
+    await client.patch("workflow-metadata.".concat(documentId)).set({
       state: newStateId,
       orderRank: newOrder
     }).commit().then(() => {
@@ -692,11 +691,12 @@ function useWorkflowDocuments(schemaTypes) {
         title: "Moved to \"".concat((_a = newState == null ? void 0 : newState.title) != null ? _a : newStateId, "\""),
         status: "success"
       });
-    }).catch(() => {
+    }).catch(err => {
       var _a;
       setLocalDocuments(currentLocalData);
       return toast.push({
         title: "Failed to move to \"".concat((_a = newState == null ? void 0 : newState.title) != null ? _a : newStateId, "\""),
+        description: err.message,
         status: "error"
       });
     });
@@ -1114,7 +1114,7 @@ function DocumentList(props) {
       return (_c = (_b = (_a = dataFiltered[index]) == null ? void 0 : _a._metadata) == null ? void 0 : _b.documentId) != null ? _c : index;
     },
     estimateSize: () => 113,
-    overscan: 5
+    overscan: 10
   });
   if (!data.length) {
     return null;
@@ -1326,7 +1326,8 @@ function StateTitle(props) {
     requireAssignment,
     userRoleCanDrop,
     isDropDisabled,
-    draggingFrom
+    draggingFrom,
+    documentCount
   } = props;
   let tone = "default";
   const isSource = draggingFrom === state.id;
@@ -1351,7 +1352,15 @@ function StateTitle(props) {
       }), requireAssignment ? /* @__PURE__ */jsx(Status, {
         text: "You must be assigned to the document to move documents to this State",
         icon: UserIcon
-      }) : null]
+      }) : null, /* @__PURE__ */jsx(Box, {
+        flex: 1,
+        children: documentCount > 0 ? /* @__PURE__ */jsx(Text, {
+          weight: "semibold",
+          align: "right",
+          size: 1,
+          children: documentCount
+        }) : null
+      })]
     })
   });
 }
@@ -1421,6 +1430,17 @@ function Verify(props) {
     } = (_a = cur._metadata) != null ? _a : {};
     return !orderRank && documentId ? [...acc, documentId] : acc;
   }, []) : [];
+  const documentsWithDuplicatedOrderIds = (data == null ? void 0 : data.length) ? data.reduce((acc, cur) => {
+    var _a;
+    const {
+      documentId,
+      orderRank
+    } = (_a = cur._metadata) != null ? _a : {};
+    return orderRank && data.filter(d => {
+      var _a2;
+      return ((_a2 = d._metadata) == null ? void 0 : _a2.orderRank) === orderRank;
+    }).length > 1 && documentId ? [...acc, documentId] : acc;
+  }, []) : [];
   const correctDocuments = React.useCallback(async ids => {
     toast.push({
       title: "Correcting...",
@@ -1521,6 +1541,10 @@ function Verify(props) {
       tone: "caution",
       onClick: () => addOrderToDocuments(documentsWithoutOrderIds),
       text: documentsWithoutOrderIds.length === 1 ? "Set Order for 1 Document" : "Set Order for ".concat(documentsWithoutOrderIds.length, " Documents")
+    }) : null, documentsWithDuplicatedOrderIds.length > 0 ? /* @__PURE__ */jsx(Button, {
+      tone: "caution",
+      onClick: () => addOrderToDocuments(documentsWithDuplicatedOrderIds),
+      text: documentsWithDuplicatedOrderIds.length === 1 ? "Set Unique Order for 1 Document" : "Set Unique Order for ".concat(documentsWithDuplicatedOrderIds.length, " Documents")
     }) : null, orphanedMetadataDocumentIds.length > 0 ? /* @__PURE__ */jsx(Button, {
       text: "Cleanup orphaned metadata",
       onClick: handleOrphans,
@@ -1592,7 +1616,7 @@ function WorkflowTool(props) {
       setUndroppableStates(undroppableExceptSelf);
     }
   }, [data, states, user]);
-  const handleDragEnd = React.useCallback(result => {
+  const handleDragEnd = React.useCallback(async result => {
     var _a2, _b2, _c2, _d, _e, _f;
     setUndroppableStates([]);
     setDraggingFrom("");
@@ -1713,7 +1737,8 @@ function WorkflowTool(props) {
                 requireAssignment: (_b2 = state.requireAssignment) != null ? _b2 : false,
                 userRoleCanDrop,
                 isDropDisabled,
-                draggingFrom
+                draggingFrom,
+                documentCount: filterItemsAndSort(data, state.id, selectedUserIds, selectedSchemaTypes).length
               }), /* @__PURE__ */jsx(Box, {
                 flex: 1,
                 children: /* @__PURE__ */jsx(Droppable, {