feat(plugin-nested-docs): support for translations

packages/plugin-nested-docs/package.json

@@ -29,6 +29,16 @@
       "import": "./src/exports/types.ts",
       "types": "./src/exports/types.ts",
       "default": "./src/exports/types.ts"
+    },
+    "./translations/languages/all": {
+      "import": "./src/translations/index.ts",
+      "types": "./src/translations/index.ts",
+      "default": "./src/translations/index.ts"
+    },
+    "./translations/languages/*": {
+      "import": "./src/translations/languages/*.ts",
+      "types": "./src/translations/languages/*.ts",
+      "default": "./src/translations/languages/*.ts"
     }
   },
   "main": "./src/index.ts",
@@ -46,10 +56,13 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
   },
-  "devDependencies": {
-    "@payloadcms/eslint-config": "workspace:*",
+  "dependencies": {
+    "@payloadcms/translations": "workspace:*",
     "payload": "workspace:*"
   },
+  "devDependencies": {
+    "@payloadcms/eslint-config": "workspace:*"
+  },
   "peerDependencies": {
     "payload": "workspace:*"
   },

packages/plugin-nested-docs/src/fields/breadcrumbs.ts

@@ -6,6 +6,12 @@ export const createBreadcrumbsField = (
 ): Field => ({
   name: 'breadcrumbs',
   type: 'array',
+  labels: {
+    // @ts-expect-error - translations are not typed in plugins yet
+    plural: ({ t }) => t('plugin-nested-docs:breadcrumbsPlural'),
+    // @ts-expect-error - translations are not typed in plugins yet
+    singular: ({ t }) => t('plugin-nested-docs:breadcrumbsSingular'),
+  },
   localized: true,
   ...(overrides || {}),
   admin: {
@@ -19,6 +25,8 @@ export const createBreadcrumbsField = (
       admin: {
         disabled: true,
       },
+      // @ts-expect-error - translations are not typed in plugins yet
+      label: ({ t }) => t('plugin-nested-docs:doc'),
       maxDepth: 0,
       relationTo,
     },
@@ -31,14 +39,17 @@ export const createBreadcrumbsField = (
           admin: {
             width: '50%',
           },
-          label: 'URL',
+          // @ts-expect-error - translations are not typed in plugins yet
+          label: ({ t }) => t('plugin-nested-docs:url'),
         },
         {
           name: 'label',
           type: 'text',
           admin: {
             width: '50%',
           },
+          // @ts-expect-error - translations are not typed in plugins yet
+          label: ({ t }) => t('plugin-nested-docs:label'),
         },
       ],
     },

packages/plugin-nested-docs/src/fields/parent.ts

@@ -13,6 +13,8 @@ export const createParentField = (
     position: 'sidebar',
     ...(overrides?.admin || {}),
   },
+  // @ts-expect-error - translations are not typed in plugins yet
+  label: ({ t }) => t('plugin-nested-docs:parent'),
   // filterOptions are assigned dynamically based on the pluginConfig
   // filterOptions: parentFilterOptions(),
   type: 'relationship',

packages/plugin-nested-docs/src/index.ts

@@ -2,6 +2,8 @@ import type { SingleRelationshipField } from 'payload'
 
 import { definePlugin } from 'payload'
 
+import { deepMergeSimple } from 'payload/shared'
+
 import type { NestedDocsPluginConfig } from './types.js'
 
 import { createBreadcrumbsField } from './fields/breadcrumbs.js'
@@ -10,7 +12,9 @@ import { parentFilterOptions } from './fields/parentFilterOptions.js'
 import { populateBreadcrumbsBeforeChange } from './hooks/populateBreadcrumbsBeforeChange.js'
 import { resaveChildren } from './hooks/resaveChildren.js'
 import { resaveSelfAfterCreate } from './hooks/resaveSelfAfterCreate.js'
+import { translations } from './translations/index.js'
 import { getParents } from './utilities/getParents.js'
+export { translations as nestedDocsTranslations } from './translations/index.js'
 
 export { createBreadcrumbsField, createParentField, getParents }
 
@@ -69,5 +73,9 @@ export const nestedDocsPlugin = definePlugin<NestedDocsPluginConfig>({
 
       return collection
     }),
+    i18n: {
+      ...config.i18n,
+      translations: deepMergeSimple(translations, config.i18n?.translations ?? {}),
+    },
   }),
 })

packages/plugin-nested-docs/src/translations/index.ts

@@ -0,0 +1,15 @@
+import type { GenericTranslationsObject, NestedKeysStripped } from '@payloadcms/translations'
+
+import { de } from './languages/de.js'
+import { en } from './languages/en.js'
+import { it } from './languages/it.js'
+
+export const translations = {
+  de,
+  en,
+  it,
+}
+
+export type PluginNestedDocsTranslations = GenericTranslationsObject
+
+export type PluginNestedDocsTranslationKeys = NestedKeysStripped<PluginNestedDocsTranslations>

packages/plugin-nested-docs/src/translations/languages/de.ts

@@ -0,0 +1,13 @@
+import type { GenericTranslationsObject } from '@payloadcms/translations'
+
+export const de: GenericTranslationsObject = {
+  $schema: '../translation-schema.json',
+  'plugin-nested-docs': {
+    breadcrumbsPlural: 'Navigationspfade',
+    breadcrumbsSingular: 'Navigationspfad',
+    doc: 'Dokument',
+    label: 'Bezeichnung',
+    parent: 'Übergeordnetes Dokument',
+    url: 'URL',
+  },
+}

packages/plugin-nested-docs/src/translations/languages/en.ts

@@ -0,0 +1,13 @@
+import type { GenericTranslationsObject } from '@payloadcms/translations'
+
+export const en: GenericTranslationsObject = {
+  $schema: '../translation-schema.json',
+  'plugin-nested-docs': {
+    breadcrumbsPlural: 'Breadcrumbs',
+    breadcrumbsSingular: 'Breadcrumb',
+    doc: 'Document',
+    label: 'Label',
+    parent: 'Parent Document',
+    url: 'URL',
+  },
+}

packages/plugin-nested-docs/src/translations/languages/it.ts

@@ -0,0 +1,13 @@
+import type { GenericTranslationsObject } from '@payloadcms/translations'
+
+export const it: GenericTranslationsObject = {
+  $schema: '../translation-schema.json',
+  'plugin-nested-docs': {
+    breadcrumbsPlural: 'Percorsi di navigazione',
+    breadcrumbsSingular: 'Percorso di navigazione',
+    doc: 'Documento',
+    label: 'Etichetta',
+    parent: 'Documento genitore',
+    url: 'URL',
+  },
+}

packages/plugin-nested-docs/src/translations/translation-schema.json

@@ -0,0 +1,36 @@
+{
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "plugin-nested-docs": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "breadcrumbsPlural": {
+          "type": "string"
+        },
+        "breadcrumbsSingular": {
+          "type": "string"
+        },
+        "doc": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "parent": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": ["breadcrumbsPlural", "breadcrumbsSingular", "doc", "label", "parent", "url"]
+    }
+  },
+  "required": ["plugin-nested-docs"]
+}

packages/plugin-nested-docs/src/translations/types.ts

@@ -0,0 +1,3 @@
+import type { en } from './languages/en.js'
+
+export type PluginDefaultTranslationsObject = typeof en

test/plugin-nested-docs/collections/Pages.ts

@@ -41,7 +41,7 @@ export const Pages: CollectionConfig = {
       },
       admin: {
         components: {
-          Field: null,
+          Field: undefined,
         },
       },
     },