Add option to add new documents on top

README.md

@@ -110,6 +110,8 @@ Additionally, pass in overrides for the field, such as making it visible by pass
 
 You cannot override the `name`, `type` or `initialValue` attributes.
 
+You can configure the placement of new documents by setting `newItemPosition` to `before` (defaults to `after`).
+
 ```js
 // sanity.config.js
 import {defineConfig} from "sanity";
@@ -136,8 +138,11 @@ export default defineConfig({
                         // Minimum required configuration
                         orderRankField({ type: "category" }),
 
+                        // OR placing new documents on top
+                        orderRankField({ type: "category", newItemPosition: "before" }),
+
                         // OR you can override _some_ of the field settings
-                        orderRankField({ type: 'category', hidden: false }),
+                        orderRankField({ type: "category", hidden: false }),
 
                         // ...all other fields
                     ],
@@ -153,8 +158,8 @@ export default defineConfig({
 On first load, your Document list will not have any Order. You can select "Reset Order" from the menu in the top right of the list.
 You can also re-run this at any time.
 
-The `orderRankField` will query the last Document to set an `initialValue` to come after it.
-New Documents always start at the end of the Ordered list.
+The `orderRankField` will query the last/first Document to set an `initialValue` to come after/before it.
+The placement of new documents can be configured by `newItemPosition` on the `orderRankField` in the document.
 
 ## Querying Ordered Documents
 

src/desk-structure/orderableDocumentListDeskItem.ts

@@ -4,6 +4,7 @@ import type {ConfigContext} from 'sanity'
 import {ComponentType} from 'react'
 import {StructureBuilder, type ListItem, type MenuItem} from 'sanity/desk'
 import OrderableDocumentList from '../OrderableDocumentList'
+import {API_VERSION} from '../helpers/constants'
 
 export interface OrderableListConfig {
   type: string
@@ -29,7 +30,7 @@ export function orderableDocumentListDeskItem(config: OrderableListConfig): List
 
   const {type, filter, menuItems = [], createIntent, params, title, icon, id, context, S} = config
   const {schema, getClient} = context
-  const client = getClient({apiVersion: '2021-09-01'})
+  const client = getClient({apiVersion: API_VERSION})
 
   const listTitle = title ?? `Orderable ${type}`
   const listId = id ?? `orderable-${type}`

src/fields/orderRankField.ts

@@ -1,14 +1,16 @@
 import {type ConfigContext, defineField} from 'sanity'
-import {ORDER_FIELD_NAME} from '../helpers/constants'
+import {API_VERSION, ORDER_FIELD_NAME} from '../helpers/constants'
 import initialRank from '../helpers/initialRank'
+import {NewItemPosition} from '../types'
 
 export type SchemaContext = Omit<ConfigContext, 'schema' | 'currentUser' | 'client'>
 
 export interface RankFieldConfig {
   type: string
+  newItemPosition?: NewItemPosition
 }
 
 export const orderRankField = (config: RankFieldConfig) => {
   if (!config?.type) {
     throw new Error(
       `
@@ -18,7 +20,7 @@
     )
   }
 
-  const {type} = config
+  const {type, newItemPosition = 'after'} = config
   return defineField({
     title: 'Order Rank',
     readOnly: true,
@@ -27,11 +29,13 @@
     name: ORDER_FIELD_NAME,
     type: 'string',
     initialValue: async (p, {getClient}) => {
-      const lastDocOrderRank = await getClient({apiVersion: '2021-09-01'}).fetch(
-        `*[_type == $type]|order(@[$order] desc)[0][$order]`,
+      const direction = newItemPosition === 'before' ? 'asc' : 'desc'
+
+      const lastDocOrderRank = await getClient({apiVersion: API_VERSION}).fetch(
+        `*[_type == $type]|order(@[$order] ${direction})[0][$order]`,
         {type, order: ORDER_FIELD_NAME}
       )
-      return initialRank(lastDocOrderRank)
+      return initialRank(lastDocOrderRank, newItemPosition)
     },
   })
 }

src/helpers/client.ts

@@ -1,5 +1,6 @@
 import {useClient} from 'sanity'
+import {API_VERSION} from './constants'
 
 export function useSanityClient() {
-  return useClient({apiVersion: '2021-09-01'})
+  return useClient({apiVersion: API_VERSION})
 }

src/helpers/constants.ts

@@ -1 +1,3 @@
 export const ORDER_FIELD_NAME = `orderRank` as const
+
+export const API_VERSION = `2021-09-01` as const

src/helpers/initialRank.ts

@@ -1,10 +1,15 @@
 import {LexoRank} from 'lexorank'
+import {NewItemPosition} from '../types'
 
 // Use in initial value field by passing in the rank value of the last document
 // If not value passed, generate a sensibly low rank
-export default function initialRank(lastRankValue = ``): string {
-  const lastRank = lastRankValue ? LexoRank.parse(lastRankValue) : LexoRank.min()
-  const nextRank = lastRank.genNext().genNext()
+export default function initialRank(
+  compareRankValue = ``,
+  newItemPosition: NewItemPosition = 'after'
+): string {
+  const compareRank = compareRankValue ? LexoRank.parse(compareRankValue) : LexoRank.min()
+  const rank =
+    newItemPosition === 'before' ? compareRank.genPrev().genPrev() : compareRank.genNext().genNext()
 
-  return nextRank.toString()
+  return rank.toString()
 }

src/types.ts

@@ -6,3 +6,5 @@ export interface SanityDocumentWithOrder extends SanityDocument {
   [ORDER_FIELD_NAME]?: string
   hasPublished?: boolean
 }
+
+export type NewItemPosition = 'after' | 'before'