@roxxel/payload-multilang 0.0.1

package/dist/styles/admin.css

@@ -0,0 +1,316 @@
+.payload-multilang-page {
+  padding: 32px;
+}
+
+.payload-multilang-page__header {
+  align-items: flex-start;
+  display: flex;
+  gap: 16px;
+  justify-content: space-between;
+  margin-bottom: 24px;
+}
+
+.payload-multilang-page__header h1,
+.payload-multilang-page__header h2,
+.payload-multilang-panel h2 {
+  margin: 0 0 8px;
+}
+
+.payload-multilang-page__header p {
+  margin: 0;
+  opacity: 0.75;
+}
+
+.payload-multilang-layout {
+  align-items: flex-start;
+  display: grid;
+  gap: 24px;
+  grid-template-columns: minmax(280px, 360px) minmax(0, 1fr);
+}
+
+
+
+
+.payload-multilang-panel--wide {
+  min-width: 0;
+}
+
+.payload-multilang-form,
+.payload-multilang-field {
+  display: grid;
+  gap: 12px;
+}
+
+.payload-multilang-form label,
+.payload-multilang-field {
+  display: grid;
+  font-size: 13px;
+  gap: 6px;
+}
+
+.payload-multilang-form input,
+.payload-multilang-form select,
+.payload-multilang-field select,
+.payload-multilang-inline-form input,
+.payload-multilang-inline-form select,
+.payload-multilang-toolbar__select select {
+  background: var(--theme-input-bg);
+  border: 1px solid var(--theme-elevation-150);
+  border-radius: 4px;
+  color: var(--theme-text);
+  min-height: 36px;
+  padding: 6px 10px;
+}
+
+.payload-multilang-checkbox {
+  align-items: center;
+  display: flex !important;
+  flex-direction: row;
+}
+
+.payload-multilang-actions,
+.payload-multilang-inline-form {
+  align-items: center;
+  display: flex;
+  flex-wrap: wrap;
+  gap: 10px;
+}
+
+.payload-multilang-inline-form {
+  margin-bottom: 12px;
+}
+
+.payload-multilang-table {
+  border-collapse: collapse;
+  width: 100%;
+}
+
+.payload-multilang-table th,
+.payload-multilang-table td {
+  border-bottom: 1px solid var(--theme-elevation-100);
+  padding: 10px 8px;
+  text-align: left;
+  vertical-align: top;
+}
+
+.payload-multilang-table--compact th,
+.payload-multilang-table--compact td {
+  padding: 6px 8px;
+}
+
+.payload-multilang-table__actions {
+  display: flex;
+  gap: 8px;
+}
+
+.payload-multilang-table__actions button {
+  background: transparent;
+  border: 0;
+  color: var(--theme-success-500);
+  cursor: pointer;
+  padding: 0;
+}
+
+.payload-multilang-toolbar {
+  align-items: center;
+  display: flex;
+  gap: 8px;
+  margin-bottom: 0;
+  position: fixed;
+  right: 96px;
+  top: 14px;
+  z-index: 30;
+}
+
+.payload-multilang-toolbar__select {
+  align-items: center;
+  display: flex;
+}
+
+.payload-multilang-toolbar__select select {
+  min-width: 150px;
+}
+
+.payload-multilang-metabox__header {
+  align-items: center;
+  display: flex;
+  justify-content: space-between;
+  margin-bottom: 12px;
+}
+
+.payload-multilang-metabox__header h3 {
+  margin: 0;
+}
+
+.payload-multilang-language-select {
+  align-items: center;
+  display: grid;
+  gap: 8px;
+  grid-template-columns: 32px minmax(0, 1fr);
+}
+
+.payload-multilang-language-select__flag {
+  align-items: center;
+  border: 1px solid var(--theme-elevation-150);
+  border-radius: 4px;
+  display: inline-flex;
+  font-size: 13px;
+  height: 36px;
+  justify-content: center;
+}
+
+.payload-multilang-translations {
+  display: grid;
+  gap: 8px;
+  margin-top: 16px;
+}
+
+.payload-multilang-translations h4 {
+  font-size: 13px;
+  margin: 0;
+}
+
+.payload-multilang-translation-row {
+  align-items: center;
+  border-top: 1px solid var(--theme-elevation-100);
+  display: grid;
+  gap: 8px;
+  grid-template-columns: 32px minmax(0, 1fr) auto;
+  min-height: 36px;
+  padding-top: 8px;
+}
+
+.payload-multilang-translation-row__flag,
+.payload-multilang-flag-cell {
+  align-items: center;
+  display: inline-flex;
+  justify-content: center;
+  white-space: nowrap;
+}
+
+.payload-multilang-flag-cell--current {
+  font-weight: 600;
+}
+
+.payload-multilang-flag-cell--unassigned {
+  color: var(--theme-elevation-500);
+  font-size: 13px;
+}
+
+.payload-multilang-column-stack {
+  align-items: center;
+  display: flex;
+  flex-direction: row;
+  gap: 16px;
+  justify-content: flex-start;
+  white-space: nowrap;
+}
+
+.payload-multilang-column-stack>span {
+  width: 34px;
+}
+
+.cell-payloadMultilangTranslations {
+  padding-left: 0px;
+}
+
+#heading-payloadMultilangTranslations {
+  padding-left: calc(var(--base) * 0.3);
+}
+
+#heading-payloadMultilangTranslations .field-label {
+  font-size: 18px;
+  word-spacing: 28px;
+
+}
+
+.payload-multilang-flag-cell {
+  font-size: 18px;
+  min-height: 34px;
+}
+
+.payload-multilang-translation-row__name {
+  min-width: 0;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+
+.payload-multilang-translation-row__current {
+  font-size: 12px;
+  opacity: 0.75;
+}
+
+.payload-multilang-link-button,
+.payload-multilang-cell-action {
+  align-items: center;
+  background: transparent;
+  border: 0;
+  color: var(--theme-success-500);
+  cursor: pointer;
+  display: inline-flex;
+  font: inherit;
+  height: 34px;
+  justify-content: center;
+  padding: 0;
+  text-decoration: none;
+  width: 34px;
+}
+
+.payload-multilang-icon-button {
+  align-items: center;
+  background: var(--theme-elevation-50);
+  border: 1px solid var(--theme-elevation-150);
+  border-radius: 4px;
+  color: var(--theme-text);
+  cursor: pointer;
+  display: inline-flex;
+  font: inherit;
+  font-size: 18px;
+  height: 34px;
+  justify-content: center;
+  line-height: 1;
+  padding: 0;
+  width: 34px;
+}
+
+.payload-multilang-icon-button:disabled,
+.payload-multilang-link-button:disabled {
+  cursor: not-allowed;
+  opacity: 0.5;
+}
+
+.payload-multilang-pen-icon {
+  display: block;
+  height: 20px;
+  width: 20px;
+}
+
+.payload-multilang-muted,
+.payload-multilang-status {
+  font-size: 12px;
+  opacity: 0.75;
+}
+
+.payload-multilang-status--linked {
+  opacity: 1;
+}
+
+.payload-multilang-cell {
+  white-space: nowrap;
+}
+
+.payload-multilang-cell--muted {
+  opacity: 0.65;
+}
+
+@media (max-width: 900px) {
+  .payload-multilang-toolbar {
+    margin-bottom: 16px;
+    position: static;
+  }
+
+  .payload-multilang-layout {
+    grid-template-columns: 1fr;
+  }
+}

package/dist/types.d.ts

@@ -0,0 +1,96 @@
+import type { CollectionSlug, GlobalSlug, Where } from 'payload';
+export type MultilangDirection = 'ltr' | 'rtl';
+export type MultilangFieldNames = {
+    group: string;
+    language: string;
+    meta: string;
+};
+export type MultilangLanguage = {
+    active?: boolean;
+    code: string;
+    direction?: MultilangDirection;
+    flagLabel?: string;
+    id?: number | string;
+    isDefault?: boolean;
+    locale?: string;
+    name: string;
+    order?: number;
+};
+export type MultilangCollectionOptions = {
+    /**
+     * Set to false to create empty translation documents by default.
+     */
+    duplicate?: boolean;
+    /**
+     * Additional top-level document field names that should not be copied when creating a translation.
+     */
+    duplicateExcludeFields?: string[];
+    /**
+     * Override hidden metadata field names for this collection.
+     */
+    fields?: Partial<MultilangFieldNames>;
+    /**
+     * Top-level document field names that should share one value across every language in a translation group.
+     */
+    synchronizedFields?: string[];
+};
+export type MultilangGlobalOptions = {
+    /**
+     * Override the top-level tabs field label used to group localized global fields.
+     */
+    label?: string;
+};
+export type PayloadMultilangConfig = {
+    /**
+     * Payload collections that should use Polylang-style document translations.
+     */
+    collections?: Partial<Record<CollectionSlug, MultilangCollectionOptions | true>>;
+    /**
+     * Disable runtime UI/endpoints/hooks while keeping schema fields in place.
+     */
+    disabled?: boolean;
+    /**
+     * Global duplicate exclusions applied to all enabled collections.
+     */
+    duplicateExcludeFields?: string[];
+    /**
+     * Global hidden metadata field name overrides.
+     */
+    fieldNames?: Partial<MultilangFieldNames>;
+    /**
+     * Payload globals that should store language-specific values in one singleton document.
+     */
+    globals?: Partial<Record<GlobalSlug, MultilangGlobalOptions | true>>;
+    /**
+     * Languages available to translated collections. Codes are normalized to
+     * lowercase during plugin setup.
+     */
+    languages: MultilangLanguage[];
+};
+export type ResolvedMultilangCollection = {
+    defaultLanguage: MultilangLanguage;
+    duplicate: boolean;
+    duplicateExcludeFields: string[];
+    fieldNames: MultilangFieldNames;
+    languages: MultilangLanguage[];
+    slug: string;
+    synchronizedFields: string[];
+};
+export type ResolvedMultilangGlobal = {
+    defaultLanguage: MultilangLanguage;
+    label: string;
+    languages: MultilangLanguage[];
+    slug: string;
+};
+export type TranslationMap<TDoc = Record<string, unknown>> = Record<string, TDoc>;
+export type TranslationState<TDoc = Record<string, unknown>> = {
+    group?: string;
+    language?: string;
+    source?: TDoc;
+    translations: TranslationMap<TDoc>;
+};
+export type WithLanguageArgs = {
+    fieldName?: string;
+    language: string;
+    where?: Where;
+};

package/dist/types.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type { CollectionSlug, GlobalSlug, Where } from 'payload'\n\nexport type MultilangDirection = 'ltr' | 'rtl'\n\nexport type MultilangFieldNames = {\n  group: string\n  language: string\n  meta: string\n}\n\nexport type MultilangLanguage = {\n  active?: boolean\n  code: string\n  direction?: MultilangDirection\n  flagLabel?: string\n  id?: number | string\n  isDefault?: boolean\n  locale?: string\n  name: string\n  order?: number\n}\n\nexport type MultilangCollectionOptions = {\n  /**\n   * Set to false to create empty translation documents by default.\n   */\n  duplicate?: boolean\n  /**\n   * Additional top-level document field names that should not be copied when creating a translation.\n   */\n  duplicateExcludeFields?: string[]\n  /**\n   * Override hidden metadata field names for this collection.\n   */\n  fields?: Partial<MultilangFieldNames>\n  /**\n   * Top-level document field names that should share one value across every language in a translation group.\n   */\n  synchronizedFields?: string[]\n}\n\nexport type MultilangGlobalOptions = {\n  /**\n   * Override the top-level tabs field label used to group localized global fields.\n   */\n  label?: string\n}\n\nexport type PayloadMultilangConfig = {\n  /**\n   * Payload collections that should use Polylang-style document translations.\n   */\n  collections?: Partial<Record<CollectionSlug, MultilangCollectionOptions | true>>\n  /**\n   * Disable runtime UI/endpoints/hooks while keeping schema fields in place.\n   */\n  disabled?: boolean\n  /**\n   * Global duplicate exclusions applied to all enabled collections.\n   */\n  duplicateExcludeFields?: string[]\n  /**\n   * Global hidden metadata field name overrides.\n   */\n  fieldNames?: Partial<MultilangFieldNames>\n  /**\n   * Payload globals that should store language-specific values in one singleton document.\n   */\n  globals?: Partial<Record<GlobalSlug, MultilangGlobalOptions | true>>\n  /**\n   * Languages available to translated collections. Codes are normalized to\n   * lowercase during plugin setup.\n   */\n  languages: MultilangLanguage[]\n}\n\nexport type ResolvedMultilangCollection = {\n  defaultLanguage: MultilangLanguage\n  duplicate: boolean\n  duplicateExcludeFields: string[]\n  fieldNames: MultilangFieldNames\n  languages: MultilangLanguage[]\n  slug: string\n  synchronizedFields: string[]\n}\n\nexport type ResolvedMultilangGlobal = {\n  defaultLanguage: MultilangLanguage\n  label: string\n  languages: MultilangLanguage[]\n  slug: string\n}\n\nexport type TranslationMap<TDoc = Record<string, unknown>> = Record<string, TDoc>\n\nexport type TranslationState<TDoc = Record<string, unknown>> = {\n  group?: string\n  language?: string\n  source?: TDoc\n  translations: TranslationMap<TDoc>\n}\n\nexport type WithLanguageArgs = {\n  fieldName?: string\n  language: string\n  where?: Where\n}\n"],"names":[],"mappings":"AAsGA,WAIC"}

package/docs/configuration.md

@@ -0,0 +1,192 @@
+# Configuration
+
+Use `payloadMultilang()` in `payload.config.ts`.
+
+```ts
+import { buildConfig } from 'payload'
+import { payloadMultilang } from '@roxxel/payload-multilang'
+
+export default buildConfig({
+  localization: false,
+  plugins: [
+    payloadMultilang({
+      collections: {
+        posts: true,
+      },
+      globals: {
+        'site-settings': true,
+      },
+      languages: [
+        {
+          code: 'en',
+          isDefault: true,
+          name: 'English',
+        },
+        {
+          code: 'uk',
+          name: 'Ukrainian',
+        },
+      ],
+    }),
+  ],
+})
+```
+
+## Plugin Options
+
+| Option                   | Type                                                 | Description                                                                                                            |
+| ------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `languages`              | `MultilangLanguage[]`                                | Required. Languages available in the admin UI and helper APIs. Exactly one active language must set `isDefault: true`. |
+| `collections`            | `Record<string, true \| MultilangCollectionOptions>` | Collection slugs to localize.                                                                                          |
+| `globals`                | `Record<string, true \| MultilangGlobalOptions>`     | Global slugs to localize.                                                                                              |
+| `fieldNames`             | `Partial<MultilangFieldNames>`                       | Optional custom field names used by localized collections.                                                             |
+| `duplicateExcludeFields` | `string[]`                                           | Extra top-level fields to skip when a new translation duplicates source document data.                                 |
+| `disabled`               | `boolean`                                            | Returns the Payload config unchanged when true. Useful for temporary opt-out in specific environments.                 |
+
+## Languages
+
+```ts
+type MultilangLanguage = {
+  active?: boolean
+  code: string
+  direction?: 'ltr' | 'rtl'
+  flagLabel?: string
+  id?: number | string
+  isDefault?: boolean
+  locale?: string
+  name: string
+  order?: number
+}
+```
+
+Language codes are trimmed and normalized to lowercase. Duplicate codes are rejected.
+
+```ts
+payloadMultilang({
+  languages: [
+    {
+      code: 'en',
+      flagLabel: 'EN',
+      isDefault: true,
+      locale: 'en_US',
+      name: 'English',
+      order: 0,
+    },
+    {
+      code: 'uk',
+      flagLabel: 'UK',
+      locale: 'uk_UA',
+      name: 'Ukrainian',
+      order: 1,
+    },
+  ],
+})
+```
+
+## Collections
+
+Set a collection slug to `true` for default behavior.
+
+```ts
+payloadMultilang({
+  collections: {
+    posts: true,
+  },
+  languages,
+})
+```
+
+Use collection options when you need custom translation behavior.
+
+```ts
+payloadMultilang({
+  collections: {
+    posts: {
+      duplicate: true,
+      duplicateExcludeFields: ['legacyId'],
+      synchronizedFields: ['featuredImage', 'author'],
+    },
+  },
+  languages,
+})
+```
+
+| Option                   | Type                           | Description                                                                                                                                                          |
+| ------------------------ | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `duplicate`              | `boolean`                      | Defaults to `true`. When creating a translation, copy source document fields into the new document. Set to `false` to create empty translation documents by default. |
+| `duplicateExcludeFields` | `string[]`                     | Additional top-level fields to skip during duplication for this collection.                                                                                          |
+| `fields`                 | `Partial<MultilangFieldNames>` | Override metadata field names for this collection.                                                                                                                   |
+| `synchronizedFields`     | `string[]`                     | Top-level fields that should stay the same across all translations in a group.                                                                                       |
+
+## Globals
+
+Set a global slug to `true` for default behavior.
+
+```ts
+payloadMultilang({
+  globals: {
+    'site-settings': true,
+  },
+  languages,
+})
+```
+
+Use `label` to customize the admin tabs wrapper label.
+
+```ts
+payloadMultilang({
+  globals: {
+    'site-settings': {
+      label: 'Settings translations',
+    },
+  },
+  languages,
+})
+```
+
+Read and update localized global values with `findGlobalByLanguage` and `updateGlobalByLanguage`.
+
+## Custom Field Names
+
+The default collection metadata field names are:
+
+```ts
+{
+  language: '_multilangLanguage',
+  group: '_multilangGroup',
+  meta: '_multilangMeta',
+}
+```
+
+Override them globally:
+
+```ts
+payloadMultilang({
+  fieldNames: {
+    language: 'languageCode',
+    group: 'translationGroup',
+    meta: 'translationMeta',
+  },
+  collections: {
+    posts: true,
+  },
+  languages,
+})
+```
+
+Or override them for one collection:
+
+```ts
+payloadMultilang({
+  collections: {
+    posts: {
+      fields: {
+        language: 'postLanguage',
+      },
+    },
+  },
+  languages,
+})
+```
+
+When using custom field names, pass the same names to helpers that accept `fieldNames` or `fieldName`.