@payloadcms/plugin-nested-docs 3.0.0-alpha.48 → 3.0.0-alpha.50

package/dist/fields/breadcrumbs.js

@@ -1,7 +1,7 @@
 export const createBreadcrumbsField = (relationTo, overrides = {})=>({
         name: 'breadcrumbs',
-        localized: true,
         type: 'array',
+        localized: true,
         ...overrides || {},
         admin: {
             readOnly: true,
@@ -10,32 +10,32 @@ export const createBreadcrumbsField = (relationTo, overrides = {})=>({
         fields: [
             {
                 name: 'doc',
+                type: 'relationship',
                 admin: {
                     disabled: true
                 },
                 maxDepth: 0,
-                relationTo,
-                type: 'relationship'
+                relationTo
             },
             {
+                type: 'row',
                 fields: [
                     {
                         name: 'url',
+                        type: 'text',
                         admin: {
                             width: '50%'
                         },
-                        label: 'URL',
-                        type: 'text'
+                        label: 'URL'
                     },
                     {
                         name: 'label',
+                        type: 'text',
                         admin: {
                             width: '50%'
-                        },
-                        type: 'text'
+                        }
                     }
-                ],
-                type: 'row'
+                ]
             },
             ...overrides?.fields || []
         ]

package/dist/fields/breadcrumbs.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fields/breadcrumbs.ts"],"sourcesContent":["import type { ArrayField, Field } from 'payload/types'\n\nexport const createBreadcrumbsField = (\n  relationTo: string,\n  overrides: Partial<ArrayField> = {},\n): Field => ({\n  name: 'breadcrumbs',\n  localized: true,\n  type: 'array',\n  ...(overrides || {}),\n  admin: {\n    readOnly: true,\n    ...(overrides?.admin || {}),\n  },\n  fields: [\n    {\n      name: 'doc',\n      admin: {\n        disabled: true,\n      },\n      maxDepth: 0,\n      relationTo,\n      type: 'relationship',\n    },\n    {\n      fields: [\n        {\n          name: 'url',\n          admin: {\n            width: '50%',\n          },\n          label: 'URL',\n          type: 'text',\n        },\n        {\n          name: 'label',\n          admin: {\n            width: '50%',\n          },\n          type: 'text',\n        },\n      ],\n      type: 'row',\n    },\n    ...(overrides?.fields || []),\n  ],\n})\n\nexport default createBreadcrumbsField\n"],"names":["createBreadcrumbsField","relationTo","overrides","name","localized","type","admin","readOnly","fields","disabled","maxDepth","width","label"],"mappings":"AAEA,OAAO,MAAMA,yBAAyB,CACpCC,YACAC,YAAiC,CAAC,CAAC,GACxB,CAAA;QACXC,MAAM;QACNC,WAAW;QACXC,MAAM;QACN,GAAIH,aAAa,CAAC,CAAC;QACnBI,OAAO;YACLC,UAAU;YACV,GAAIL,WAAWI,SAAS,CAAC,CAAC;QAC5B;QACAE,QAAQ;YACN;gBACEL,MAAM;gBACNG,OAAO;oBACLG,UAAU;gBACZ;gBACAC,UAAU;gBACVT;gBACAI,MAAM;YACR;YACA;gBACEG,QAAQ;oBACN;wBACEL,MAAM;wBACNG,OAAO;4BACLK,OAAO;wBACT;wBACAC,OAAO;wBACPP,MAAM;oBACR;oBACA;wBACEF,MAAM;wBACNG,OAAO;4BACLK,OAAO;wBACT;wBACAN,MAAM;oBACR;iBACD;gBACDA,MAAM;YACR;eACIH,WAAWM,UAAU,EAAE;SAC5B;IACH,CAAA,EAAE;AAEF,eAAeR,uBAAsB"}
+{"version":3,"sources":["../../src/fields/breadcrumbs.ts"],"sourcesContent":["import type { ArrayField, Field } from 'payload/types'\n\nexport const createBreadcrumbsField = (\n  relationTo: string,\n  overrides: Partial<ArrayField> = {},\n): Field => ({\n  name: 'breadcrumbs',\n  type: 'array',\n  localized: true,\n  ...(overrides || {}),\n  admin: {\n    readOnly: true,\n    ...(overrides?.admin || {}),\n  },\n  fields: [\n    {\n      name: 'doc',\n      type: 'relationship',\n      admin: {\n        disabled: true,\n      },\n      maxDepth: 0,\n      relationTo,\n    },\n    {\n      type: 'row',\n      fields: [\n        {\n          name: 'url',\n          type: 'text',\n          admin: {\n            width: '50%',\n          },\n          label: 'URL',\n        },\n        {\n          name: 'label',\n          type: 'text',\n          admin: {\n            width: '50%',\n          },\n        },\n      ],\n    },\n    ...(overrides?.fields || []),\n  ],\n})\n\nexport default createBreadcrumbsField\n"],"names":["createBreadcrumbsField","relationTo","overrides","name","type","localized","admin","readOnly","fields","disabled","maxDepth","width","label"],"mappings":"AAEA,OAAO,MAAMA,yBAAyB,CACpCC,YACAC,YAAiC,CAAC,CAAC,GACxB,CAAA;QACXC,MAAM;QACNC,MAAM;QACNC,WAAW;QACX,GAAIH,aAAa,CAAC,CAAC;QACnBI,OAAO;YACLC,UAAU;YACV,GAAIL,WAAWI,SAAS,CAAC,CAAC;QAC5B;QACAE,QAAQ;YACN;gBACEL,MAAM;gBACNC,MAAM;gBACNE,OAAO;oBACLG,UAAU;gBACZ;gBACAC,UAAU;gBACVT;YACF;YACA;gBACEG,MAAM;gBACNI,QAAQ;oBACN;wBACEL,MAAM;wBACNC,MAAM;wBACNE,OAAO;4BACLK,OAAO;wBACT;wBACAC,OAAO;oBACT;oBACA;wBACET,MAAM;wBACNC,MAAM;wBACNE,OAAO;4BACLK,OAAO;wBACT;oBACF;iBACD;YACH;eACIT,WAAWM,UAAU,EAAE;SAC5B;IACH,CAAA,EAAE;AAEF,eAAeR,uBAAsB"}

package/dist/fields/parent.js

@@ -6,9 +6,9 @@ export const createParentField = (relationTo, overrides)=>({
         },
         // filterOptions are assigned dynamically based on the pluginConfig
         // filterOptions: parentFilterOptions(),
+        type: 'relationship',
         maxDepth: 1,
         relationTo,
-        type: 'relationship',
         ...overrides || {}
     });
 export default createParentField;

package/dist/fields/parent.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fields/parent.ts"],"sourcesContent":["import type { SingleRelationshipField } from 'payload/types'\n\nexport const createParentField = (\n  relationTo: string,\n  overrides?: Partial<\n    SingleRelationshipField & {\n      hasMany: false\n    }\n  >,\n): SingleRelationshipField => ({\n  name: 'parent',\n  admin: {\n    position: 'sidebar',\n    ...(overrides?.admin || {}),\n  },\n  // filterOptions are assigned dynamically based on the pluginConfig\n  // filterOptions: parentFilterOptions(),\n  maxDepth: 1,\n  relationTo,\n  type: 'relationship',\n  ...(overrides || {}),\n})\n\nexport default createParentField\n"],"names":["createParentField","relationTo","overrides","name","admin","position","maxDepth","type"],"mappings":"AAEA,OAAO,MAAMA,oBAAoB,CAC/BC,YACAC,YAK6B,CAAA;QAC7BC,MAAM;QACNC,OAAO;YACLC,UAAU;YACV,GAAIH,WAAWE,SAAS,CAAC,CAAC;QAC5B;QACA,mEAAmE;QACnE,wCAAwC;QACxCE,UAAU;QACVL;QACAM,MAAM;QACN,GAAIL,aAAa,CAAC,CAAC;IACrB,CAAA,EAAE;AAEF,eAAeF,kBAAiB"}
+{"version":3,"sources":["../../src/fields/parent.ts"],"sourcesContent":["import type { SingleRelationshipField } from 'payload/types'\n\nexport const createParentField = (\n  relationTo: string,\n  overrides?: Partial<\n    SingleRelationshipField & {\n      hasMany: false\n    }\n  >,\n): SingleRelationshipField => ({\n  name: 'parent',\n  admin: {\n    position: 'sidebar',\n    ...(overrides?.admin || {}),\n  },\n  // filterOptions are assigned dynamically based on the pluginConfig\n  // filterOptions: parentFilterOptions(),\n  type: 'relationship',\n  maxDepth: 1,\n  relationTo,\n  ...(overrides || {}),\n})\n\nexport default createParentField\n"],"names":["createParentField","relationTo","overrides","name","admin","position","type","maxDepth"],"mappings":"AAEA,OAAO,MAAMA,oBAAoB,CAC/BC,YACAC,YAK6B,CAAA;QAC7BC,MAAM;QACNC,OAAO;YACLC,UAAU;YACV,GAAIH,WAAWE,SAAS,CAAC,CAAC;QAC5B;QACA,mEAAmE;QACnE,wCAAwC;QACxCE,MAAM;QACNC,UAAU;QACVN;QACA,GAAIC,aAAa,CAAC,CAAC;IACrB,CAAA,EAAE;AAEF,eAAeF,kBAAiB"}

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@payloadcms/plugin-nested-docs",
-  "version": "3.0.0-alpha.48",
+  "version": "3.0.0-alpha.50",
   "description": "The official Nested Docs plugin for Payload",
-  "repository": "https://github.com/payloadcms/payload",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/payloadcms/payload.git",
+    "directory": "packages/plugin-nested-docs"
+  },
   "license": "MIT",
   "homepage": "https://payloadcms.com",
   "author": "Payload CMS, Inc.",
@@ -11,14 +15,17 @@
   "type": "module",
   "devDependencies": {
     "@payloadcms/eslint-config": "1.1.1",
-    "payload": "3.0.0-alpha.48"
+    "payload": "3.0.0-alpha.50"
   },
   "peerDependencies": {
-    "payload": "3.0.0-alpha.48"
+    "payload": "3.0.0-alpha.50"
   },
-  "exports": null,
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
   },
   "files": [
     "dist",

package/src/index.ts

@@ -0,0 +1,71 @@
+import type { Plugin } from 'payload/config'
+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'
+
+const nestedDocs =
+  (pluginConfig: PluginConfig): Plugin =>
+  (config) => ({
+    ...config,
+    collections: (config.collections || []).map((collection) => {
+      if (pluginConfig.collections.indexOf(collection.slug) > -1) {
+        const fields = [...(collection?.fields || [])]
+
+        const existingBreadcrumbField = collection.fields.find(
+          (field) =>
+            'name' in field && field.name === (pluginConfig?.breadcrumbsFieldSlug || 'breadcrumbs'),
+        )
+
+        const existingParentField = collection.fields.find(
+          (field) => 'name' in field && field.name === (pluginConfig?.parentFieldSlug || 'parent'),
+        ) as SingleRelationshipField
+
+        const defaultFilterOptions = parentFilterOptions(pluginConfig?.breadcrumbsFieldSlug)
+
+        if (existingParentField) {
+          if (!existingParentField.filterOptions) {
+            existingParentField.filterOptions = defaultFilterOptions
+          }
+        }
+
+        if (!existingParentField && !pluginConfig.parentFieldSlug) {
+          const defaultParentField = createParentField(collection.slug)
+          defaultParentField.filterOptions = defaultFilterOptions
+          fields.push(defaultParentField)
+        }
+
+        if (!existingBreadcrumbField && !pluginConfig.breadcrumbsFieldSlug) {
+          fields.push(createBreadcrumbsField(collection.slug))
+        }
+
+        return {
+          ...collection,
+          fields,
+          hooks: {
+            ...(collection.hooks || {}),
+            afterChange: [
+              resaveChildren(pluginConfig, collection),
+              resaveSelfAfterCreate(pluginConfig, collection),
+              ...(collection?.hooks?.afterChange || []),
+            ],
+            beforeChange: [
+              async ({ data, originalDoc, req }) =>
+                populateBreadcrumbs(req, pluginConfig, collection, data, originalDoc),
+              ...(collection?.hooks?.beforeChange || []),
+            ],
+          },
+        }
+      }
+
+      return collection
+    }),
+  })
+
+export default nestedDocs