From 7df7bf448bd26e870a1fde8aaa47430904d68366 Mon Sep 17 00:00:00 2001
From: Patrik <patrik@payloadcms.com>
Date: Thu, 4 Apr 2024 16:55:18 -0400
Subject: [PATCH] fix: updates type name of `CustomPublishButtonProps` to
 `CustomPublishButtonType` (#5644)

* fix: updates type name from CustomPublishButtonProps to CustomPublishButtonType

* fix: maps old name to new name
---
 docs/admin/components.mdx                                | 4 ++--
 .../src/admin/components/elements/Publish/index.tsx      | 9 +++++++--
 packages/payload/src/admin/components/elements/types.ts  | 2 +-
 packages/payload/src/collections/config/types.ts         | 4 ++--
 packages/payload/src/exports/types.ts                    | 1 +
 packages/payload/src/globals/config/types.ts             | 4 ++--
 6 files changed, 15 insertions(+), 9 deletions(-)

diff --git a/docs/admin/components.mdx b/docs/admin/components.mdx
index 00d810f263..a72b61ebf9 100644
--- a/docs/admin/components.mdx
+++ b/docs/admin/components.mdx
@@ -168,7 +168,7 @@ import * as React from 'react'
 import {
   CustomSaveButtonProps,
   CustomSaveDraftButtonProps,
-  CustomPublishButtonProps,
+  CustomPublishButtonType,
   CustomPreviewButtonProps,
 } from 'payload/types'
 
@@ -185,7 +185,7 @@ export const CustomSaveDraftButton: CustomSaveDraftButtonProps = ({
   return <DefaultButton label={label} disabled={disabled} saveDraft={saveDraft} />
 }
 
-export const CustomPublishButton: CustomPublishButtonProps = ({
+export const CustomPublishButton: CustomPublishButtonType = ({
   DefaultButton,
   disabled,
   label,
diff --git a/packages/payload/src/admin/components/elements/Publish/index.tsx b/packages/payload/src/admin/components/elements/Publish/index.tsx
index b199e0adff..66d6649421 100644
--- a/packages/payload/src/admin/components/elements/Publish/index.tsx
+++ b/packages/payload/src/admin/components/elements/Publish/index.tsx
@@ -9,11 +9,16 @@ import { useDocumentInfo } from '../../utilities/DocumentInfo'
 import { useLocale } from '../../utilities/Locale'
 import RenderCustomComponent from '../../utilities/RenderCustomComponent'
 
-export type CustomPublishButtonProps = React.ComponentType<
+export type CustomPublishButtonType = React.ComponentType<
   DefaultPublishButtonProps & {
     DefaultButton: React.ComponentType<DefaultPublishButtonProps>
   }
 >
+/**
+ * @deprecated Use `CustomPublishButtonType` instead - renamed from `CustomPublishButtonProps`
+ */
+export type CustomPublishButtonProps = CustomPublishButtonType
+
 export type DefaultPublishButtonProps = {
   canPublish: boolean
   disabled: boolean
@@ -38,7 +43,7 @@ const DefaultPublishButton: React.FC<DefaultPublishButtonProps> = ({
 }
 
 type Props = {
-  CustomComponent?: CustomPublishButtonProps
+  CustomComponent?: CustomPublishButtonType
 }
 
 export const Publish: React.FC<Props> = ({ CustomComponent }) => {
diff --git a/packages/payload/src/admin/components/elements/types.ts b/packages/payload/src/admin/components/elements/types.ts
index 1787c347b5..5d18a3f7f9 100644
--- a/packages/payload/src/admin/components/elements/types.ts
+++ b/packages/payload/src/admin/components/elements/types.ts
@@ -1,4 +1,4 @@
 export type { CustomPreviewButtonProps } from './PreviewButton'
-export type { CustomPublishButtonProps } from './Publish'
+export type { CustomPublishButtonProps, CustomPublishButtonType } from './Publish'
 export type { CustomSaveButtonProps } from './Save'
 export type { CustomSaveDraftButtonProps } from './SaveDraft'
diff --git a/packages/payload/src/collections/config/types.ts b/packages/payload/src/collections/config/types.ts
index 7ab338b017..f702558045 100644
--- a/packages/payload/src/collections/config/types.ts
+++ b/packages/payload/src/collections/config/types.ts
@@ -6,7 +6,7 @@ import type { DeepRequired } from 'ts-essentials'
 import type { GeneratedTypes } from '../../'
 import type {
   CustomPreviewButtonProps,
-  CustomPublishButtonProps,
+  CustomPublishButtonType,
   CustomSaveButtonProps,
   CustomSaveDraftButtonProps,
 } from '../../admin/components/elements/types'
@@ -228,7 +228,7 @@ export type CollectionAdminOptions = {
        * Replaces the "Publish" button
        * + drafts must be enabled
        */
-      PublishButton?: CustomPublishButtonProps
+      PublishButton?: CustomPublishButtonType
       /**
        * Replaces the "Save" button
        * + drafts must be disabled
diff --git a/packages/payload/src/exports/types.ts b/packages/payload/src/exports/types.ts
index 166388d2ce..53c5cdfee4 100644
--- a/packages/payload/src/exports/types.ts
+++ b/packages/payload/src/exports/types.ts
@@ -19,6 +19,7 @@ export { FileData, ImageSize, IncomingUploadType } from '../uploads/types'
 
 export type {
   CustomPublishButtonProps,
+  CustomPublishButtonType,
   CustomSaveButtonProps,
   CustomSaveDraftButtonProps,
 } from './../admin/components/elements/types'
diff --git a/packages/payload/src/globals/config/types.ts b/packages/payload/src/globals/config/types.ts
index 62dcd7df9a..29a00aee5b 100644
--- a/packages/payload/src/globals/config/types.ts
+++ b/packages/payload/src/globals/config/types.ts
@@ -3,7 +3,7 @@ import type { DeepRequired } from 'ts-essentials'
 
 import type {
   CustomPreviewButtonProps,
-  CustomPublishButtonProps,
+  CustomPublishButtonType,
   CustomSaveButtonProps,
   CustomSaveDraftButtonProps,
 } from '../../admin/components/elements/types'
@@ -86,7 +86,7 @@ export type GlobalAdminOptions = {
        * Replaces the "Publish" button
        * + drafts must be enabled
        */
-      PublishButton?: CustomPublishButtonProps
+      PublishButton?: CustomPublishButtonType
       /**
        * Replaces the "Save" button
        * + drafts must be disabled