From 4150c87be080844199c09ef65df9f6843df8c71a Mon Sep 17 00:00:00 2001 From: Paul Date: Mon, 15 Apr 2024 13:22:01 -0300 Subject: [PATCH] chore(plugin-nested-docs): update nested docs plugin exports and moved away from default exports (#5856) --- .../src/fields/breadcrumbs.ts | 2 -- .../plugin-nested-docs/src/fields/parent.ts | 2 -- .../src/fields/parentFilterOptions.ts | 2 -- .../src/hooks/resaveChildren.ts | 5 ++--- .../src/hooks/resaveSelfAfterCreate.ts | 4 +--- packages/plugin-nested-docs/src/index.ts | 18 +++++++++--------- .../src/utilities/formatBreadcrumb.ts | 4 +--- .../src/utilities/getParents.ts | 4 +--- .../src/utilities/populateBreadcrumbs.ts | 8 +++----- .../collections/Categories.ts | 4 ++-- test/plugin-nested-docs/collections/Pages.ts | 3 +-- .../collections/populateFullTitle.ts | 4 +--- test/plugin-nested-docs/config.ts | 2 +- 13 files changed, 22 insertions(+), 40 deletions(-) diff --git a/packages/plugin-nested-docs/src/fields/breadcrumbs.ts b/packages/plugin-nested-docs/src/fields/breadcrumbs.ts index 7eaadf38c..262a21a76 100644 --- a/packages/plugin-nested-docs/src/fields/breadcrumbs.ts +++ b/packages/plugin-nested-docs/src/fields/breadcrumbs.ts @@ -45,5 +45,3 @@ export const createBreadcrumbsField = ( ...(overrides?.fields || []), ], }) - -export default createBreadcrumbsField diff --git a/packages/plugin-nested-docs/src/fields/parent.ts b/packages/plugin-nested-docs/src/fields/parent.ts index 87086819e..67b6d09b9 100644 --- a/packages/plugin-nested-docs/src/fields/parent.ts +++ b/packages/plugin-nested-docs/src/fields/parent.ts @@ -20,5 +20,3 @@ export const createParentField = ( relationTo, ...(overrides || {}), }) - -export default createParentField diff --git a/packages/plugin-nested-docs/src/fields/parentFilterOptions.ts b/packages/plugin-nested-docs/src/fields/parentFilterOptions.ts index e1c532e0d..13ddc51ef 100644 --- a/packages/plugin-nested-docs/src/fields/parentFilterOptions.ts +++ b/packages/plugin-nested-docs/src/fields/parentFilterOptions.ts @@ -12,5 +12,3 @@ export const parentFilterOptions: (breadcrumbsFieldSlug?: string) => FilterOptio return null } - -export default parentFilterOptions diff --git a/packages/plugin-nested-docs/src/hooks/resaveChildren.ts b/packages/plugin-nested-docs/src/hooks/resaveChildren.ts index cc282951a..4361f8e81 100644 --- a/packages/plugin-nested-docs/src/hooks/resaveChildren.ts +++ b/packages/plugin-nested-docs/src/hooks/resaveChildren.ts @@ -2,7 +2,7 @@ import type { CollectionAfterChangeHook, CollectionConfig, PayloadRequest } from import type { PluginConfig } from '../types.js' -import populateBreadcrumbs from '../utilities/populateBreadcrumbs.js' +import { populateBreadcrumbs } from '../utilities/populateBreadcrumbs.js' type ResaveArgs = { collection: CollectionConfig @@ -65,7 +65,7 @@ const resave = async ({ collection, doc, draft, pluginConfig, req }: ResaveArgs) } } -const resaveChildren = +export const resaveChildren = (pluginConfig: PluginConfig, collection: CollectionConfig): CollectionAfterChangeHook => async ({ doc, req }) => { await resave({ @@ -88,4 +88,3 @@ const resaveChildren = return undefined } -export default resaveChildren diff --git a/packages/plugin-nested-docs/src/hooks/resaveSelfAfterCreate.ts b/packages/plugin-nested-docs/src/hooks/resaveSelfAfterCreate.ts index 0e968a1ac..b07308a5e 100644 --- a/packages/plugin-nested-docs/src/hooks/resaveSelfAfterCreate.ts +++ b/packages/plugin-nested-docs/src/hooks/resaveSelfAfterCreate.ts @@ -5,7 +5,7 @@ import type { PluginConfig } from '../types.js' // This hook automatically re-saves a document after it is created // so that we can build its breadcrumbs with the newly created document's ID. -const resaveSelfAfterCreate = +export const resaveSelfAfterCreate = (pluginConfig: PluginConfig, collection: CollectionConfig): CollectionAfterChangeHook => async ({ doc, operation, req }) => { const { locale, payload } = req @@ -52,5 +52,3 @@ const resaveSelfAfterCreate = return undefined } - -export default resaveSelfAfterCreate diff --git a/packages/plugin-nested-docs/src/index.ts b/packages/plugin-nested-docs/src/index.ts index e7521a29d..4a8954d55 100644 --- a/packages/plugin-nested-docs/src/index.ts +++ b/packages/plugin-nested-docs/src/index.ts @@ -3,14 +3,16 @@ import type { SingleRelationshipField } from 'payload/types' import type { PluginConfig } from './types.js' -import createBreadcrumbsField from './fields/breadcrumbs.js' -import createParentField from './fields/parent.js' -import parentFilterOptions from './fields/parentFilterOptions.js' -import resaveChildren from './hooks/resaveChildren.js' -import resaveSelfAfterCreate from './hooks/resaveSelfAfterCreate.js' -import populateBreadcrumbs from './utilities/populateBreadcrumbs.js' +import { createBreadcrumbsField } from './fields/breadcrumbs.js' +import { createParentField } from './fields/parent.js' +import { parentFilterOptions } from './fields/parentFilterOptions.js' +import { resaveChildren } from './hooks/resaveChildren.js' +import { resaveSelfAfterCreate } from './hooks/resaveSelfAfterCreate.js' +import { populateBreadcrumbs } from './utilities/populateBreadcrumbs.js' -const nestedDocs = +export { createBreadcrumbsField, createParentField } + +export const nestedDocs = (pluginConfig: PluginConfig): Plugin => (config) => ({ ...config, @@ -67,5 +69,3 @@ const nestedDocs = return collection }), }) - -export default nestedDocs diff --git a/packages/plugin-nested-docs/src/utilities/formatBreadcrumb.ts b/packages/plugin-nested-docs/src/utilities/formatBreadcrumb.ts index ab4ad2346..51d157c55 100644 --- a/packages/plugin-nested-docs/src/utilities/formatBreadcrumb.ts +++ b/packages/plugin-nested-docs/src/utilities/formatBreadcrumb.ts @@ -2,7 +2,7 @@ import type { CollectionConfig } from 'payload/types' import type { Breadcrumb, PluginConfig } from '../types.js' -const formatBreadcrumb = ( +export const formatBreadcrumb = ( pluginConfig: PluginConfig, collection: CollectionConfig, docs: Array>, @@ -29,5 +29,3 @@ const formatBreadcrumb = ( url, } } - -export default formatBreadcrumb diff --git a/packages/plugin-nested-docs/src/utilities/getParents.ts b/packages/plugin-nested-docs/src/utilities/getParents.ts index 963ca548b..3d2ce58b1 100644 --- a/packages/plugin-nested-docs/src/utilities/getParents.ts +++ b/packages/plugin-nested-docs/src/utilities/getParents.ts @@ -2,7 +2,7 @@ import type { CollectionConfig } from 'payload/types' import type { PluginConfig } from '../types.js' -const getParents = async ( +export const getParents = async ( req: any, pluginConfig: PluginConfig, collection: CollectionConfig, @@ -44,5 +44,3 @@ const getParents = async ( return docs } - -export default getParents diff --git a/packages/plugin-nested-docs/src/utilities/populateBreadcrumbs.ts b/packages/plugin-nested-docs/src/utilities/populateBreadcrumbs.ts index c7742b32a..453eb5c6f 100644 --- a/packages/plugin-nested-docs/src/utilities/populateBreadcrumbs.ts +++ b/packages/plugin-nested-docs/src/utilities/populateBreadcrumbs.ts @@ -2,10 +2,10 @@ import type { CollectionConfig } from 'payload/types' import type { PluginConfig } from '../types.js' -import formatBreadcrumb from './formatBreadcrumb.js' -import getParents from './getParents.js' +import { formatBreadcrumb } from './formatBreadcrumb.js' +import { getParents } from './getParents.js' -const populateBreadcrumbs = async ( +export const populateBreadcrumbs = async ( req: any, pluginConfig: PluginConfig, collection: CollectionConfig, @@ -40,5 +40,3 @@ const populateBreadcrumbs = async ( [pluginConfig?.breadcrumbsFieldSlug || 'breadcrumbs']: breadcrumbs, } } - -export default populateBreadcrumbs diff --git a/test/plugin-nested-docs/collections/Categories.ts b/test/plugin-nested-docs/collections/Categories.ts index a0c3fafe1..e9b806801 100644 --- a/test/plugin-nested-docs/collections/Categories.ts +++ b/test/plugin-nested-docs/collections/Categories.ts @@ -1,7 +1,7 @@ import type { CollectionConfig } from 'payload/types' -import { createBreadcrumbsField } from '../../../packages/plugin-nested-docs/src/fields/breadcrumbs.js' -import createParentField from '../../../packages/plugin-nested-docs/src/fields/parent.js' +import { createBreadcrumbsField } from '@payloadcms/plugin-nested-docs' +import { createParentField } from '@payloadcms/plugin-nested-docs' export const Categories: CollectionConfig = { access: { diff --git a/test/plugin-nested-docs/collections/Pages.ts b/test/plugin-nested-docs/collections/Pages.ts index ec458b739..e3e713c00 100644 --- a/test/plugin-nested-docs/collections/Pages.ts +++ b/test/plugin-nested-docs/collections/Pages.ts @@ -1,7 +1,6 @@ -// const payload = require('payload'); import type { CollectionConfig } from 'payload/types' -import populateFullTitle from './populateFullTitle.js' +import { populateFullTitle } from './populateFullTitle.js' export const Pages: CollectionConfig = { slug: 'pages', diff --git a/test/plugin-nested-docs/collections/populateFullTitle.ts b/test/plugin-nested-docs/collections/populateFullTitle.ts index f462222d0..fcdb052b2 100644 --- a/test/plugin-nested-docs/collections/populateFullTitle.ts +++ b/test/plugin-nested-docs/collections/populateFullTitle.ts @@ -11,7 +11,5 @@ export const generateFullTitle = (breadcrumbs: Array<{ label: string }>): string return undefined } -const populateFullTitle: FieldHook = ({ data, originalDoc }) => +export const populateFullTitle: FieldHook = ({ data, originalDoc }) => generateFullTitle(data?.breadcrumbs || originalDoc?.breadcrumbs) - -export default populateFullTitle diff --git a/test/plugin-nested-docs/config.ts b/test/plugin-nested-docs/config.ts index d024756ed..dbef801fd 100644 --- a/test/plugin-nested-docs/config.ts +++ b/test/plugin-nested-docs/config.ts @@ -1,4 +1,4 @@ -import nestedDocs from '@payloadcms/plugin-nested-docs' +import { nestedDocs } from '@payloadcms/plugin-nested-docs' import { buildConfigWithDefaults } from '../buildConfigWithDefaults.js' import { devUser } from '../credentials.js'