sanity-plugin-workflow 1.0.6 → 2.0.1

package/src/components/UserAssignment.tsx

@@ -1,121 +0,0 @@
-import React from 'react'
-import {useToast} from '@sanity/ui'
-import {UserSelectMenu} from 'sanity-plugin-utils'
-import {useClient} from 'sanity'
-
-import {User} from '../types'
-import {API_VERSION} from '../constants'
-
-type UserAssignmentProps = {
-  userList: User[]
-  assignees: string[]
-  documentId: string
-}
-
-export default function UserAssignment(props: UserAssignmentProps) {
-  const {assignees, userList, documentId} = props
-  const client = useClient({apiVersion: API_VERSION})
-  const toast = useToast()
-
-  const addAssignee = React.useCallback(
-    (userId: string) => {
-      const user = userList.find((u) => u.id === userId)
-
-      if (!userId || !user) {
-        return toast.push({
-          status: 'error',
-          title: 'Could not find User',
-        })
-      }
-
-      return client
-        .patch(`workflow-metadata.${documentId}`)
-        .setIfMissing({assignees: []})
-        .insert(`after`, `assignees[-1]`, [userId])
-        .commit()
-        .then(() => {
-          return toast.push({
-            title: `Added ${user.displayName} to assignees`,
-            status: 'success',
-          })
-        })
-        .catch((err) => {
-          console.error(err)
-
-          return toast.push({
-            title: `Failed to add assignee`,
-            description: userId,
-            status: 'error',
-          })
-        })
-    },
-    [documentId, client, toast, userList]
-  )
-
-  const removeAssignee = React.useCallback(
-    (userId: string) => {
-      const user = userList.find((u) => u.id === userId)
-
-      if (!userId || !user) {
-        return toast.push({
-          status: 'error',
-          title: 'Could not find User',
-        })
-      }
-
-      return client
-        .patch(`workflow-metadata.${documentId}`)
-        .unset([`assignees[@ == "${userId}"]`])
-        .commit()
-        .then(() => {
-          return toast.push({
-            title: `Removed ${user.displayName} from assignees`,
-            status: 'success',
-          })
-        })
-        .catch((err) => {
-          console.error(err)
-
-          return toast.push({
-            title: `Failed to remove assignee`,
-            description: documentId,
-            status: 'error',
-          })
-        })
-    },
-    [client, toast, documentId, userList]
-  )
-
-  const clearAssignees = React.useCallback(() => {
-    return client
-      .patch(`workflow-metadata.${documentId}`)
-      .unset([`assignees`])
-      .commit()
-      .then(() => {
-        return toast.push({
-          title: `Cleared assignees`,
-          status: 'success',
-        })
-      })
-      .catch((err) => {
-        console.error(err)
-
-        return toast.push({
-          title: `Failed to clear assignees`,
-          description: documentId,
-          status: 'error',
-        })
-      })
-  }, [client, toast, documentId])
-
-  return (
-    <UserSelectMenu
-      style={{maxHeight: 300}}
-      value={assignees || []}
-      userList={userList}
-      onAdd={addAssignee}
-      onClear={clearAssignees}
-      onRemove={removeAssignee}
-    />
-  )
-}

package/src/components/UserAssignmentInput.tsx

@@ -1,27 +0,0 @@
-import {Card} from '@sanity/ui'
-import {FunctionComponent} from 'react'
-import {ArraySchemaType, ArrayOfPrimitivesInputProps, useFormValue} from 'sanity'
-import {useProjectUsers} from 'sanity-plugin-utils'
-
-import {API_VERSION} from '../constants'
-import UserAssignment from './UserAssignment'
-
-const UserAssignmentInput: FunctionComponent<
-  ArrayOfPrimitivesInputProps<string | number | boolean, ArraySchemaType>
-> = (props) => {
-  const documentId = useFormValue([`documentId`])
-  const userList = useProjectUsers({apiVersion: API_VERSION})
-
-  const stringValue =
-    Array.isArray(props?.value) && props?.value?.length
-      ? props.value.map((item) => String(item))
-      : []
-
-  return (
-    <Card border padding={1}>
-      <UserAssignment userList={userList} assignees={stringValue} documentId={String(documentId)} />
-    </Card>
-  )
-}
-
-export default UserAssignmentInput

package/src/components/UserDisplay.tsx

@@ -1,57 +0,0 @@
-import React from 'react'
-import {Button, Grid, Popover, useClickOutside} from '@sanity/ui'
-import {AddIcon} from '@sanity/icons'
-
-import AvatarGroup from './DocumentCard/AvatarGroup'
-import {User} from '../types'
-import UserAssignment from './UserAssignment'
-
-type UserDisplayProps = {
-  userList: User[]
-  assignees: string[]
-  documentId: string
-  disabled?: boolean
-}
-
-export default function UserDisplay(props: UserDisplayProps) {
-  const {assignees, userList, documentId, disabled = false} = props
-
-  const [button] = React.useState(null)
-  const [popover, setPopover] = React.useState(null)
-  const [isOpen, setIsOpen] = React.useState(false)
-
-  const close = React.useCallback(() => setIsOpen(false), [])
-  const open = React.useCallback(() => setIsOpen(true), [])
-
-  useClickOutside(close, [button, popover])
-
-  return (
-    <Popover
-      // @ts-ignore
-      ref={setPopover}
-      content={<UserAssignment userList={userList} assignees={assignees} documentId={documentId} />}
-      portal
-      open={isOpen}
-    >
-      {!assignees || assignees.length === 0 ? (
-        <Button
-          onClick={open}
-          fontSize={1}
-          padding={2}
-          tabIndex={-1}
-          icon={AddIcon}
-          text="Assign"
-          tone="positive"
-          mode="ghost"
-          disabled={disabled}
-        />
-      ) : (
-        <Grid>
-          <Button onClick={open} padding={0} mode="bleed" disabled={disabled}>
-            <AvatarGroup users={userList.filter((u) => assignees.includes(u.id))} />
-          </Button>
-        </Grid>
-      )}
-    </Popover>
-  )
-}

package/src/components/Verify.tsx

@@ -1,297 +0,0 @@
-import {Button, useToast} from '@sanity/ui'
-import {LexoRank} from 'lexorank'
-import React from 'react'
-import {useClient} from 'sanity'
-import {UserExtended} from 'sanity-plugin-utils'
-
-import {API_VERSION} from '../constants'
-import {generateMultipleOrderRanks} from '../helpers/generateMultipleOrderRanks'
-import {SanityDocumentWithMetadata, State} from '../types'
-import FloatingCard from './FloatingCard'
-
-type VerifyProps = {
-  data: SanityDocumentWithMetadata[]
-  userList: UserExtended[]
-  states: State[]
-}
-
-// This component checks the validity of the data in the Kanban
-// It will only render something it there is invalid date
-// And will render buttons to fix the data
-export default function Verify(props: VerifyProps) {
-  const {data, userList, states} = props
-  const client = useClient({apiVersion: API_VERSION})
-  const toast = useToast()
-
-  // A lot of error-checking
-  const documentsWithoutValidMetadataIds = data?.length
-    ? data.reduce((acc, cur) => {
-        const {documentId, state} = cur._metadata ?? {}
-        const stateExists = states.find((s) => s.id === state)
-
-        return !stateExists && documentId ? [...acc, documentId] : acc
-      }, [] as string[])
-    : []
-
-  const documentsWithInvalidUserIds =
-    data?.length && userList?.length
-      ? data.reduce((acc, cur) => {
-          const {documentId, assignees} = cur._metadata ?? {}
-          const allAssigneesExist = assignees?.length
-            ? assignees?.every((a) => userList.find((u) => u.id === a))
-            : true
-
-          return !allAssigneesExist && documentId ? [...acc, documentId] : acc
-        }, [] as string[])
-      : []
-
-  const documentsWithoutOrderIds = data?.length
-    ? data.reduce((acc, cur) => {
-        const {documentId, orderRank} = cur._metadata ?? {}
-
-        return !orderRank && documentId ? [...acc, documentId] : acc
-      }, [] as string[])
-    : []
-
-  const documentsWithDuplicatedOrderIds = data?.length
-    ? data.reduce((acc, cur) => {
-        const {documentId, orderRank} = cur._metadata ?? {}
-
-        return orderRank &&
-          data.filter((d) => d._metadata?.orderRank === orderRank).length > 1 &&
-          documentId
-          ? [...acc, documentId]
-          : acc
-      }, [] as string[])
-    : []
-
-  // Updates metadata documents to a valid, existing state
-  const correctDocuments = React.useCallback(
-    async (ids: string[]) => {
-      toast.push({
-        title: 'Correcting...',
-        status: 'info',
-      })
-
-      const tx = ids.reduce((item, documentId) => {
-        return item.patch(`workflow-metadata.${documentId}`, {
-          set: {state: states[0].id},
-        })
-      }, client.transaction())
-
-      await tx.commit()
-
-      toast.push({
-        title: `Corrected ${
-          ids.length === 1 ? `1 Document` : `${ids.length} Documents`
-        }`,
-        status: 'success',
-      })
-    },
-    [client, states, toast]
-  )
-
-  // Remove users that are no longer in the project from documents
-  const removeUsersFromDocuments = React.useCallback(
-    async (ids: string[]) => {
-      toast.push({
-        title: 'Removing users...',
-        status: 'info',
-      })
-
-      const tx = ids.reduce((item, documentId) => {
-        const {assignees} =
-          data.find((d) => d._id === documentId)?._metadata ?? {}
-        const validAssignees = assignees?.length
-          ? // eslint-disable-next-line max-nested-callbacks
-            assignees.filter((a) => userList.find((u) => u.id === a)?.id)
-          : []
-
-        return item.patch(`workflow-metadata.${documentId}`, {
-          set: {assignees: validAssignees},
-        })
-      }, client.transaction())
-
-      await tx.commit()
-
-      toast.push({
-        title: `Corrected ${
-          ids.length === 1 ? `1 Document` : `${ids.length} Documents`
-        }`,
-        status: 'success',
-      })
-    },
-    [client, data, toast, userList]
-  )
-
-  // Add order value to metadata documents
-  const addOrderToDocuments = React.useCallback(
-    async (ids: string[]) => {
-      toast.push({
-        title: 'Adding ordering...',
-        status: 'info',
-      })
-
-      // Get first and second order values, if they exist
-      const [firstOrder, secondOrder] = [...data]
-        .slice(0, 2)
-        .map((d) => d._metadata?.orderRank)
-      const minLexo = firstOrder ? LexoRank.parse(firstOrder) : undefined
-      const maxLexo = secondOrder ? LexoRank.parse(secondOrder) : undefined
-      const ranks = generateMultipleOrderRanks(ids.length, minLexo, maxLexo)
-
-      const tx = client.transaction()
-
-      // Create a new in-between value for each document
-      for (let index = 0; index < ids.length; index += 1) {
-        tx.patch(`workflow-metadata.${ids[index]}`, {
-          set: {orderRank: ranks[index].toString()},
-        })
-      }
-
-      await tx.commit()
-
-      toast.push({
-        title: `Added order to ${
-          ids.length === 1 ? `1 Document` : `${ids.length} Documents`
-        }`,
-        status: 'success',
-      })
-    },
-    [data, client, toast]
-  )
-
-  // Reset order value on all metadata documents
-  const resetOrderOfAllDocuments = React.useCallback(
-    async (ids: string[]) => {
-      toast.push({
-        title: 'Adding ordering...',
-        status: 'info',
-      })
-
-      const ranks = generateMultipleOrderRanks(ids.length)
-
-      const tx = client.transaction()
-
-      // Create a new in-between value for each document
-      for (let index = 0; index < ids.length; index += 1) {
-        tx.patch(`workflow-metadata.${ids[index]}`, {
-          set: {orderRank: ranks[index].toString()},
-        })
-      }
-
-      await tx.commit()
-
-      toast.push({
-        title: `Added order to ${
-          ids.length === 1 ? `1 Document` : `${ids.length} Documents`
-        }`,
-        status: 'success',
-      })
-    },
-    [data, client, toast]
-  )
-
-  // A document could be deleted and the workflow metadata left behind
-  const orphanedMetadataDocumentIds = React.useMemo(() => {
-    return data.length
-      ? data.filter((doc) => !doc?._id).map((doc) => doc._metadata.documentId)
-      : []
-  }, [data])
-
-  const handleOrphans = React.useCallback(() => {
-    toast.push({
-      title: 'Removing orphaned metadata...',
-      status: 'info',
-    })
-
-    const tx = client.transaction()
-    orphanedMetadataDocumentIds.forEach((id) => {
-      tx.delete(`workflow-metadata.${id}`)
-    })
-
-    tx.commit()
-
-    toast.push({
-      title: `Removed ${orphanedMetadataDocumentIds.length} orphaned metadata documents`,
-      status: 'success',
-    })
-  }, [client, orphanedMetadataDocumentIds, toast])
-
-  return (
-    <FloatingCard>
-      {documentsWithoutValidMetadataIds.length > 0 ? (
-        <Button
-          tone="caution"
-          mode="ghost"
-          onClick={() => correctDocuments(documentsWithoutValidMetadataIds)}
-          text={
-            documentsWithoutValidMetadataIds.length === 1
-              ? `Correct 1 Document State`
-              : `Correct ${documentsWithoutValidMetadataIds.length} Document States`
-          }
-        />
-      ) : null}
-      {documentsWithInvalidUserIds.length > 0 ? (
-        <Button
-          tone="caution"
-          mode="ghost"
-          onClick={() => removeUsersFromDocuments(documentsWithInvalidUserIds)}
-          text={
-            documentsWithInvalidUserIds.length === 1
-              ? `Remove Invalid Users from 1 Document`
-              : `Remove Invalid Users from ${documentsWithInvalidUserIds.length} Documents`
-          }
-        />
-      ) : null}
-      {documentsWithoutOrderIds.length > 0 ? (
-        <Button
-          tone="caution"
-          mode="ghost"
-          onClick={() => addOrderToDocuments(documentsWithoutOrderIds)}
-          text={
-            documentsWithoutOrderIds.length === 1
-              ? `Set Order for 1 Document`
-              : `Set Order for ${documentsWithoutOrderIds.length} Documents`
-          }
-        />
-      ) : null}
-      {documentsWithDuplicatedOrderIds.length > 0 ? (
-        <>
-          <Button
-            tone="caution"
-            mode="ghost"
-            onClick={() => addOrderToDocuments(documentsWithDuplicatedOrderIds)}
-            text={
-              documentsWithDuplicatedOrderIds.length === 1
-                ? `Set Unique Order for 1 Document`
-                : `Set Unique Order for ${documentsWithDuplicatedOrderIds.length} Documents`
-            }
-          />
-          <Button
-            tone="caution"
-            mode="ghost"
-            onClick={() =>
-              resetOrderOfAllDocuments(
-                data.map((doc) => String(doc._metadata?.documentId))
-              )
-            }
-            text={
-              data.length === 1
-                ? `Reset Order for 1 Document`
-                : `Reset Order for all ${data.length} Documents`
-            }
-          />
-        </>
-      ) : null}
-      {orphanedMetadataDocumentIds.length > 0 ? (
-        <Button
-          text="Cleanup orphaned metadata"
-          onClick={handleOrphans}
-          tone="caution"
-          mode="ghost"
-        />
-      ) : null}
-    </FloatingCard>
-  )
-}

package/src/components/WorkflowContext.tsx

@@ -1,71 +0,0 @@
-import {useCallback, useContext, useState} from 'react'
-import {createContext} from 'react'
-import {LayoutProps} from 'sanity'
-
-import {DEFAULT_CONFIG} from '../constants'
-import {useWorkflowMetadata} from '../hooks/useWorkflowMetadata'
-import {KeyedMetadata, WorkflowConfig} from '../types'
-
-export type WorkflowContextValue = Required<WorkflowConfig> & {
-  data: KeyedMetadata
-  loading: boolean
-  error: boolean | unknown | ProgressEvent
-  ids: string[]
-  addId: (id: string) => void
-  removeId: (id: string) => void
-}
-
-const WorkflowContext = createContext<WorkflowContextValue>({
-  data: {},
-  loading: false,
-  error: false,
-  ids: [],
-  addId: () => null,
-  removeId: () => null,
-  ...DEFAULT_CONFIG,
-})
-
-export function useWorkflowContext(id?: string) {
-  const current = useContext(WorkflowContext)
-
-  return {...current, metadata: id ? current.data[id] : null}
-}
-
-type WorkflowProviderProps = LayoutProps & {workflow: Required<WorkflowConfig>}
-
-/**
- * This Provider wraps the Studio and provides the workflow context to document actions and badges.
- * This is so individual actions and badges do not need to all register their own listeners.
- * Instead, each document "signals" its ID up to the provider, which then registers a single listener
- * This is performed inside of a component loaded at the root level of the Document Form
- */
-export function WorkflowProvider(props: WorkflowProviderProps) {
-  const [ids, setIds] = useState<string[]>([])
-  const addId = useCallback(
-    (id: string) =>
-      setIds((current) => (current.includes(id) ? current : [...current, id])),
-    []
-  )
-  const removeId = useCallback(
-    (id: string) => setIds((current) => current.filter((i) => i !== id)),
-    []
-  )
-  const {data, loading, error} = useWorkflowMetadata(ids)
-
-  return (
-    <WorkflowContext.Provider
-      value={{
-        data,
-        loading,
-        error,
-        ids,
-        addId,
-        removeId,
-        states: props.workflow.states,
-        schemaTypes: props.workflow.schemaTypes,
-      }}
-    >
-      {props.renderDefault(props)}
-    </WorkflowContext.Provider>
-  )
-}

package/src/components/WorkflowSignal.tsx

@@ -1,30 +0,0 @@
-import {useEffect} from 'react'
-import {ObjectInputProps} from 'sanity'
-
-import {useWorkflowContext} from './WorkflowContext'
-
-// This component is loaded at the root level of the Document Form
-// It is used to signal the document ID to the WorkflowProvider
-export default function WorkflowSignal(props: ObjectInputProps) {
-  const documentId = props?.value?._id
-    ? props.value._id.replace(`drafts.`, ``)
-    : null
-
-  const {addId, removeId} = useWorkflowContext()
-
-  useEffect(() => {
-    // On mount, add  to the query of listening documents
-    if (documentId) {
-      addId(documentId)
-    }
-
-    // On unmount, remove from the query of listening documents
-    return () => {
-      if (documentId) {
-        removeId(documentId)
-      }
-    }
-  }, [documentId, addId, removeId])
-
-  return props.renderDefault(props)
-}