feat: add findVersions findVersionByID restoreVersion `findGlob…

…alVersrions` `findGlobalVersionByID` `restoreGlobalVersion` operations

docs/rest-api/overview.mdx

@@ -880,6 +880,35 @@ const result = await sdk.resetPassword({
   collection: 'users',
   data: { password: '1234567', token: resetPasswordToken },
 })
+
+// Find Versions operation
+const result = await sdk.findVersions({
+  collection: 'posts',
+  where: { parent: { equals: post.id } },
+})
+
+// Find Version by ID operation
+const result = await sdk.findVersionByID({ collection: 'posts', id: version.id })
+
+// Restore Version operation
+const result = await sdk.restoreVersion({
+  collection: 'posts',
+  id,
+})
+
+// Find Global Versions operation
+const result = await sdk.findGlobalVersions({
+  slug: 'global',
+})
+
+// Find Global Version by ID operation
+const result = await sdk.findGlobalVersionByID({ id: version.id, slug: 'global' })
+
+// Restore Global Version operation
+const result = await sdk.restoreGlobalVersion({
+  slug: 'global',
+  id
+})
 ```
 
 

packages/sdk/src/collections/findVersionByID.ts

@@ -0,0 +1,58 @@
+import type { ApplyDisableErrors, SelectType, TypeWithVersion } from 'payload'
+
+import type { PayloadSDK } from '../index.js'
+import type {
+  CollectionSlug,
+  DataFromCollectionSlug,
+  PayloadGeneratedTypes,
+  PopulateType,
+  TypedLocale,
+} from '../types.js'
+
+export type FindVersionByIDOptions<
+  T extends PayloadGeneratedTypes,
+  TSlug extends CollectionSlug<T>,
+  TDisableErrors extends boolean,
+> = {
+  collection: TSlug
+  depth?: number
+  disableErrors?: TDisableErrors
+  draft?: boolean
+  fallbackLocale?: false | TypedLocale<T>
+  id: number | string
+  locale?: 'all' | TypedLocale<T>
+  populate?: PopulateType<T>
+  select?: SelectType
+}
+
+export async function findVersionByID<
+  T extends PayloadGeneratedTypes,
+  TSlug extends CollectionSlug<T>,
+  TDisableErrors extends boolean,
+>(
+  sdk: PayloadSDK<T>,
+  options: FindVersionByIDOptions<T, TSlug, TDisableErrors>,
+  init?: RequestInit,
+): Promise<ApplyDisableErrors<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>, TDisableErrors>> {
+  try {
+    const response = await sdk.request({
+      args: options,
+      init,
+      method: 'GET',
+      path: `/${options.collection}/versions/${options.id}`,
+    })
+
+    if (response.ok) {
+      return response.json()
+    } else {
+      throw new Error()
+    }
+  } catch {
+    if (options.disableErrors) {
+      // @ts-expect-error generic nullable
+      return null
+    }
+
+    throw new Error(`Error retrieving the version document ${options.collection}/${options.id}`)
+  }
+}

packages/sdk/src/collections/findVersions.ts

@@ -0,0 +1,45 @@
+import type { PaginatedDocs, SelectType, Sort, TypeWithVersion, Where } from 'payload'
+
+import type { PayloadSDK } from '../index.js'
+import type {
+  CollectionSlug,
+  DataFromCollectionSlug,
+  PayloadGeneratedTypes,
+  PopulateType,
+  TypedLocale,
+} from '../types.js'
+
+export type FindVersionsOptions<
+  T extends PayloadGeneratedTypes,
+  TSlug extends CollectionSlug<T>,
+> = {
+  collection: TSlug
+  depth?: number
+  draft?: boolean
+  fallbackLocale?: false | TypedLocale<T>
+  limit?: number
+  locale?: 'all' | TypedLocale<T>
+  page?: number
+  populate?: PopulateType<T>
+  select?: SelectType
+  sort?: Sort
+  where?: Where
+}
+
+export async function findVersions<
+  T extends PayloadGeneratedTypes,
+  TSlug extends CollectionSlug<T>,
+>(
+  sdk: PayloadSDK<T>,
+  options: FindVersionsOptions<T, TSlug>,
+  init?: RequestInit,
+): Promise<PaginatedDocs<TypeWithVersion<DataFromCollectionSlug<T, TSlug>>>> {
+  const response = await sdk.request({
+    args: options,
+    init,
+    method: 'GET',
+    path: `/${options.collection}/versions`,
+  })
+
+  return response.json()
+}

packages/sdk/src/collections/restoreVersion.ts

@@ -0,0 +1,39 @@
+import type { PayloadSDK } from '../index.js'
+import type {
+  CollectionSlug,
+  DataFromCollectionSlug,
+  PayloadGeneratedTypes,
+  PopulateType,
+  TypedLocale,
+} from '../types.js'
+
+export type RestoreVersionByIDOptions<
+  T extends PayloadGeneratedTypes,
+  TSlug extends CollectionSlug<T>,
+> = {
+  collection: TSlug
+  depth?: number
+  draft?: boolean
+  fallbackLocale?: false | TypedLocale<T>
+  id: number | string
+  locale?: 'all' | TypedLocale<T>
+  populate?: PopulateType<T>
+}
+
+export async function restoreVersion<
+  T extends PayloadGeneratedTypes,
+  TSlug extends CollectionSlug<T>,
+>(
+  sdk: PayloadSDK<T>,
+  options: RestoreVersionByIDOptions<T, TSlug>,
+  init?: RequestInit,
+): Promise<DataFromCollectionSlug<T, TSlug>> {
+  const response = await sdk.request({
+    args: options,
+    init,
+    method: 'POST',
+    path: `/${options.collection}/versions/${options.id}`,
+  })
+
+  return response.json()
+}

packages/sdk/src/globals/findVersionByID.ts

@@ -0,0 +1,58 @@
+import type { ApplyDisableErrors, SelectType, TypeWithVersion } from 'payload'
+
+import type { PayloadSDK } from '../index.js'
+import type {
+  DataFromGlobalSlug,
+  GlobalSlug,
+  PayloadGeneratedTypes,
+  PopulateType,
+  TypedLocale,
+} from '../types.js'
+
+export type FindGlobalVersionByIDOptions<
+  T extends PayloadGeneratedTypes,
+  TSlug extends GlobalSlug<T>,
+  TDisableErrors extends boolean,
+> = {
+  depth?: number
+  disableErrors?: TDisableErrors
+  draft?: boolean
+  fallbackLocale?: false | TypedLocale<T>
+  id: number | string
+  locale?: 'all' | TypedLocale<T>
+  populate?: PopulateType<T>
+  select?: SelectType
+  slug: TSlug
+}
+
+export async function findGlobalVersionByID<
+  T extends PayloadGeneratedTypes,
+  TSlug extends GlobalSlug<T>,
+  TDisableErrors extends boolean,
+>(
+  sdk: PayloadSDK<T>,
+  options: FindGlobalVersionByIDOptions<T, TSlug, TDisableErrors>,
+  init?: RequestInit,
+): Promise<ApplyDisableErrors<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>, TDisableErrors>> {
+  try {
+    const response = await sdk.request({
+      args: options,
+      init,
+      method: 'GET',
+      path: `/globals/${options.slug}/versions/${options.id}`,
+    })
+
+    if (response.ok) {
+      return response.json()
+    } else {
+      throw new Error()
+    }
+  } catch {
+    if (options.disableErrors) {
+      // @ts-expect-error generic nullable
+      return null
+    }
+
+    throw new Error(`Error retrieving the version document ${options.slug}/${options.id}`)
+  }
+}

packages/sdk/src/globals/findVersions.ts

@@ -0,0 +1,45 @@
+import type { PaginatedDocs, SelectType, Sort, TypeWithVersion, Where } from 'payload'
+
+import type { PayloadSDK } from '../index.js'
+import type {
+  DataFromGlobalSlug,
+  GlobalSlug,
+  PayloadGeneratedTypes,
+  PopulateType,
+  TypedLocale,
+} from '../types.js'
+
+export type FindGlobalVersionsOptions<
+  T extends PayloadGeneratedTypes,
+  TSlug extends GlobalSlug<T>,
+> = {
+  depth?: number
+  draft?: boolean
+  fallbackLocale?: false | TypedLocale<T>
+  limit?: number
+  locale?: 'all' | TypedLocale<T>
+  page?: number
+  populate?: PopulateType<T>
+  select?: SelectType
+  slug: TSlug
+  sort?: Sort
+  where?: Where
+}
+
+export async function findGlobalVersions<
+  T extends PayloadGeneratedTypes,
+  TSlug extends GlobalSlug<T>,
+>(
+  sdk: PayloadSDK<T>,
+  options: FindGlobalVersionsOptions<T, TSlug>,
+  init?: RequestInit,
+): Promise<PaginatedDocs<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>>> {
+  const response = await sdk.request({
+    args: options,
+    init,
+    method: 'GET',
+    path: `/globals/${options.slug}/versions`,
+  })
+
+  return response.json()
+}

packages/sdk/src/globals/restoreVersion.ts

@@ -0,0 +1,43 @@
+import type { TypeWithVersion } from 'payload'
+
+import type { PayloadSDK } from '../index.js'
+import type {
+  DataFromGlobalSlug,
+  GlobalSlug,
+  PayloadGeneratedTypes,
+  PopulateType,
+  TypedLocale,
+} from '../types.js'
+
+export type RestoreGlobalVersionByIDOptions<
+  T extends PayloadGeneratedTypes,
+  TSlug extends GlobalSlug<T>,
+> = {
+  depth?: number
+  draft?: boolean
+  fallbackLocale?: false | TypedLocale<T>
+  id: number | string
+  locale?: 'all' | TypedLocale<T>
+  populate?: PopulateType<T>
+  slug: TSlug
+}
+
+export async function restoreGlobalVersion<
+  T extends PayloadGeneratedTypes,
+  TSlug extends GlobalSlug<T>,
+>(
+  sdk: PayloadSDK<T>,
+  options: RestoreGlobalVersionByIDOptions<T, TSlug>,
+  init?: RequestInit,
+): Promise<TypeWithVersion<DataFromGlobalSlug<T, TSlug>>> {
+  const response = await sdk.request({
+    args: options,
+    init,
+    method: 'POST',
+    path: `/globals/${options.slug}/versions/${options.id}`,
+  })
+
+  const { doc } = await response.json()
+
+  return doc
+}