@justanarthur/payload-plugin-translator 3.1.0 → 3.2.0

package/README.md

@@ -79,7 +79,7 @@ export const myResolver: TranslateResolver = {
 | `globals`     | `GlobalSlug[]`        | yes      | Globals to auto-translate.                                             |
 | `resolvers`   | `TranslateResolver[]` | yes      | Tried in order; first to succeed wins per chunk.                       |
 | `autoTranslate` | `boolean`           | no       | Default `true`. Set `false` to opt out of the auto-translate afterChange hook — useful when you drive translation manually via the `translateOperation` export. |
-| `autoTranslateMode` | `'missing' \| 'all'` | no | Default `'missing'`: a publish in the default locale fills empty fields in other locales and keeps existing translations and slugs. `'all'` re-translates everything. |
+| `autoTranslateMode` | `'missing' \| 'untranslated' \| 'all'` | no | Default `'missing'`: a publish in the default locale fills empty fields in other locales and keeps existing translations and slugs. `'untranslated'` also replaces fields that still hold the source copy. `'all'` re-translates everything. |
 | `review`      | `boolean`             | no       | Default `true`. Adds the `/admin/translations` review view, its endpoints and the hidden `translation-status` collection (needs a migration on postgres). |
 | `disabled`    | `boolean`             | no       | Skip the plugin entirely (no overrides, no jobs). Useful in tests.    |
 | `_options.additionalTraverseRichText` | function | no | Hook to extend rich-text traversal — see below.             |
@@ -128,6 +128,12 @@ With `review` on, **Translations** appears in the admin nav (`/admin/translation
   last auto-translate job and its error. Actions: *Translate missing fields*, *Re-translate all*,
   *Mark reviewed*.
 
+- **Bulk fix**: *Translate untranslated* queues one translate workflow per incomplete document,
+  for all locales or one, in `untranslated` mode (empty fields and fields still holding the source
+  copy; existing translations and slugs stay). Locales a pending job already covers are skipped.
+  The overview shows queued, running and failed jobs, and *Run a batch now* processes a few without
+  waiting for the job runner. Needs `autoTranslate` on, since that registers the jobs.
+
 The view only lists collections and globals the signed-in user can read, and the endpoints behind
 the actions require a user.
 

package/dist/client.css

@@ -39,187 +39,3 @@
   flex-wrap: wrap;
   gap: .5rem;
 }
-
-/* src/client/components/Review/styles.css */
-.translator-review {
-  padding-bottom: calc(var(--base) * 3);
-}
-
-.translator-review__header {
-  display: flex;
-  justify-content: space-between;
-  align-items: baseline;
-  gap: var(--base);
-  margin: calc(var(--base) * 1.5) 0;
-  flex-wrap: wrap;
-}
-
-.translator-review__header h1 {
-  margin: 0;
-}
-
-.translator-review__tabs {
-  display: flex;
-  gap: calc(var(--base) / 2);
-  margin-bottom: var(--base);
-  flex-wrap: wrap;
-}
-
-.translator-review__tab {
-  border: 1px solid var(--theme-elevation-150);
-  color: var(--theme-elevation-800);
-  text-decoration: none;
-  border-radius: 999px;
-  padding: 4px 12px;
-  font-size: 13px;
-}
-
-.translator-review__tab[aria-current="true"] {
-  background: var(--theme-elevation-900);
-  border-color: var(--theme-elevation-900);
-  color: var(--theme-elevation-0);
-}
-
-.translator-review__scroll {
-  overflow-x: auto;
-  border: 1px solid var(--theme-elevation-100);
-  border-radius: var(--style-radius-m);
-}
-
-.translator-review table {
-  border-collapse: collapse;
-  width: 100%;
-  font-size: 13px;
-}
-
-.translator-review th, .translator-review td {
-  border-bottom: 1px solid var(--theme-elevation-100);
-  text-align: left;
-  vertical-align: top;
-  padding: 8px 10px;
-}
-
-.translator-review th {
-  background: var(--theme-elevation-50);
-  white-space: nowrap;
-  font-weight: 600;
-}
-
-.translator-review tr:last-child td {
-  border-bottom: 0;
-}
-
-.translator-review__doc {
-  min-width: 220px;
-}
-
-.translator-review__doc small {
-  display: block;
-  color: var(--theme-elevation-500);
-}
-
-.translator-review__cell {
-  display: inline-flex;
-  font-variant-numeric: tabular-nums;
-  text-decoration: none;
-  color: var(--theme-elevation-1000);
-  border: 1px solid #0000;
-  border-radius: 999px;
-  align-items:  center;
-  gap: 4px;
-  min-width: 64px;
-  padding: 2px 8px;
-}
-
-.translator-review__cell--ok {
-  background: var(--theme-success-100);
-}
-
-.translator-review__cell--partial {
-  background: var(--theme-warning-100);
-}
-
-.translator-review__cell--missing {
-  background: var(--theme-error-100);
-}
-
-.translator-review__cell--stale {
-  border-color: var(--theme-warning-500);
-}
-
-.translator-review__legend {
-  display: flex;
-  gap: var(--base);
-  color: var(--theme-elevation-600);
-  margin-top: calc(var(--base) / 2);
-  flex-wrap: wrap;
-  font-size: 12px;
-}
-
-.translator-review__pager {
-  display: flex;
-  gap: var(--base);
-  margin-top: var(--base);
-  align-items:  center;
-}
-
-.translator-review__state {
-  white-space: nowrap;
-  border-radius: 999px;
-  padding: 1px 8px;
-  font-size: 12px;
-}
-
-.translator-review__state--ok {
-  background: var(--theme-success-100);
-}
-
-.translator-review__state--missing {
-  background: var(--theme-error-100);
-}
-
-.translator-review__state--identical, .translator-review__state--placeholders {
-  background: var(--theme-warning-100);
-}
-
-.translator-review__text {
-  white-space: pre-wrap;
-  word-break: break-word;
-  max-width: 420px;
-}
-
-.translator-review__text--empty {
-  color: var(--theme-elevation-400);
-  font-style: italic;
-}
-
-.translator-review__path {
-  font-family: var(--font-mono, monospace);
-  color: var(--theme-elevation-600);
-  word-break: break-all;
-  max-width: 240px;
-  font-size: 12px;
-}
-
-.translator-review__meta {
-  display: flex;
-  gap: calc(var(--base) * 1.5);
-  color: var(--theme-elevation-600);
-  margin-bottom: var(--base);
-  flex-wrap: wrap;
-  font-size: 13px;
-}
-
-.translator-review__actions {
-  display: flex;
-  gap: calc(var(--base) / 2);
-  flex-wrap: wrap;
-}
-
-.translator-review__actions .btn {
-  margin: 0;
-}
-
-.translator-review__error {
-  color: var(--theme-error-500);
-}

package/dist/client.d.ts

@@ -4,15 +4,25 @@ declare const CustomButtonWithTranslator: ({ type }: {
 	type: "publish" | "save";
 }) => Element_12xgc;
 import { JSX as JSX_1kxb2 } from "react";
+type Progress = {
+	pending: number;
+	running: number;
+	failed: number;
+} | null;
 type Element_12xgc2 = JSX_1kxb2["Element"];
+declare const BulkActions: ({ tab, locales, progress }: {
+	tab: string;
+	locales: string[];
+	progress: Progress;
+}) => Element_12xgc2;
+import { JSX as JSX_1kxb3 } from "react";
+type Element_12xgc3 = JSX_1kxb3["Element"];
 declare const ReviewActions: ({ entity, locale, reviewed }: {
 	entity: string;
 	locale: string;
 	reviewed: boolean;
-}) => Element_12xgc2;
-/** loads the review view styles; the view itself is a server component */
-declare const ReviewStyles: () => null;
-import { JSX as JSX_1kxb3 } from "react";
-type Element_12xgc3 = JSX_1kxb3["Element"];
-declare const TranslationsNavLink: () => Element_12xgc3;
-export { CustomButtonWithTranslator, ReviewActions, ReviewStyles, TranslationsNavLink, CustomButtonWithTranslator as default };
+}) => Element_12xgc3;
+import { JSX as JSX_1kxb4 } from "react";
+type Element_12xgc4 = JSX_1kxb4["Element"];
+declare const TranslationsNavLink: () => Element_12xgc4;
+export { BulkActions, CustomButtonWithTranslator, ReviewActions, TranslationsNavLink, CustomButtonWithTranslator as default };

package/dist/client.js

@@ -315,14 +315,125 @@ var CustomButtonWithTranslator = ({ type }) => {
   });
 };
 
-// src/client/components/Review/ReviewActions.tsx
+// src/client/components/Review/BulkActions.tsx
 import { Button as Button3, toast as toast2, useConfig as useConfig3 } from "@payloadcms/ui";
 import { useState as useState2 } from "react";
 import { jsx as jsx7, jsxs as jsxs5 } from "react/jsx-runtime";
 
-var ReviewActions = ({ entity, locale, reviewed }) => {
+var BulkActions = ({ tab, locales, progress }) => {
   const { config: { routes: { api }, serverURL } } = useConfig3();
+  const [locale, setLocale] = useState2("");
   const [pending, setPending] = useState2(null);
+  const post = async (path, body) => {
+    const res = await fetch(`${serverURL ?? ""}${api}/translator/review/${path}`, {
+      method: "POST",
+      credentials: "include",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(body)
+    });
+    const result = await res.json().catch(() => ({}));
+    if (!res.ok || !result.success)
+      throw new Error(result?.errors?.[0]?.message ?? "request failed");
+    return result;
+  };
+  const queue = async () => {
+    const scope = `${locale ? locale.toUpperCase() : "every locale"} of all ${tab}`;
+    if (!window.confirm(`Queue translation of empty and untranslated fields in ${scope}? Existing translations are kept.`))
+      return;
+    setPending("bulk");
+    try {
+      const { queuedDocuments, queuedLocales, skippedPending } = await post("bulk", { tab, locale, mode: "untranslated" });
+      toast2.success(queuedDocuments ? `Queued ${queuedDocuments} documents (${queuedLocales} locales)${skippedPending ? `, ${skippedPending} already queued` : ""}` : skippedPending ? "Everything incomplete is already queued" : "Nothing to translate");
+      window.location.reload();
+    } catch (error) {
+      toast2.error(`Could not queue: ${error instanceof Error ? error.message : String(error)}`);
+    } finally {
+      setPending(null);
+    }
+  };
+  const runNow = async () => {
+    setPending("run");
+    try {
+      await post("run-jobs", {});
+      toast2.success("Ran a batch of queued translations");
+      window.location.reload();
+    } catch (error) {
+      toast2.error(`Could not run jobs: ${error instanceof Error ? error.message : String(error)}`);
+    } finally {
+      setPending(null);
+    }
+  };
+  return /* @__PURE__ */ jsxs5("div", {
+    className: "tr__bulk",
+    children: [
+      /* @__PURE__ */ jsxs5("div", {
+        className: "tr__bulk-main",
+        children: [
+          /* @__PURE__ */ jsxs5("select", {
+            "aria-label": "Locale",
+            className: "tr__select",
+            onChange: (event) => setLocale(event.target.value),
+            value: locale,
+            children: [
+              /* @__PURE__ */ jsx7("option", {
+                value: "",
+                children: "All locales"
+              }),
+              locales.map((each) => /* @__PURE__ */ jsx7("option", {
+                value: each,
+                children: each.toUpperCase()
+              }, each))
+            ]
+          }),
+          /* @__PURE__ */ jsx7(Button3, {
+            buttonStyle: "primary",
+            disabled: Boolean(pending),
+            onClick: queue,
+            size: "small",
+            children: pending === "bulk" ? "Queuing…" : "Translate untranslated"
+          })
+        ]
+      }),
+      progress && (progress.pending > 0 || progress.failed > 0) && /* @__PURE__ */ jsxs5("div", {
+        className: "tr__bulk-progress",
+        children: [
+          progress.pending > 0 && /* @__PURE__ */ jsxs5("span", {
+            className: "tr__pill",
+            "data-tone": "warn",
+            children: [
+              progress.pending,
+              " queued",
+              progress.running ? `, ${progress.running} running` : ""
+            ]
+          }),
+          progress.failed > 0 && /* @__PURE__ */ jsxs5("span", {
+            className: "tr__pill",
+            "data-tone": "bad",
+            children: [
+              progress.failed,
+              " failed today"
+            ]
+          }),
+          progress.pending > 0 && /* @__PURE__ */ jsx7(Button3, {
+            buttonStyle: "secondary",
+            disabled: Boolean(pending),
+            onClick: runNow,
+            size: "small",
+            children: pending === "run" ? "Running…" : "Run a batch now"
+          })
+        ]
+      })
+    ]
+  });
+};
+// src/client/components/Review/ReviewActions.tsx
+import { Button as Button4, toast as toast3, useConfig as useConfig4 } from "@payloadcms/ui";
+import { useState as useState3 } from "react";
+import { jsx as jsx8, jsxs as jsxs6 } from "react/jsx-runtime";
+
+var ReviewActions = ({ entity, locale, reviewed }) => {
+  const { config: { routes: { api }, serverURL } } = useConfig4();
+  const [pending, setPending] = useState3(null);
   const run = async (action) => {
     if (action === "translate-all" && !window.confirm(`Re-translate every field in ${locale}? Existing ${locale} copy is replaced.`))
       return;
@@ -333,37 +444,37 @@ var ReviewActions = ({ entity, locale, reviewed }) => {
         method: "POST",
         credentials: "include",
         headers: { "Content-Type": "application/json" },
-        body: JSON.stringify({ entity, locale, mode: action === "translate-all" ? "all" : "missing" })
+        body: JSON.stringify({ entity, locale, mode: action === "translate-all" ? "all" : "untranslated" })
       });
       const result = await res.json().catch(() => ({}));
       if (!res.ok || !result.success)
         throw new Error(result?.errors?.[0]?.message ?? "request failed");
-      toast2.success(action === "mark-reviewed" ? `${locale} marked as reviewed` : `${locale} translated`);
+      toast3.success(action === "mark-reviewed" ? `${locale} marked as reviewed` : `${locale} translated`);
       window.location.reload();
     } catch (error) {
-      toast2.error(`Could not ${action.replace("-", " ")}: ${error instanceof Error ? error.message : String(error)}`);
+      toast3.error(`Could not ${action.replace("-", " ")}: ${error instanceof Error ? error.message : String(error)}`);
     } finally {
       setPending(null);
     }
   };
-  return /* @__PURE__ */ jsxs5("div", {
+  return /* @__PURE__ */ jsxs6("div", {
     className: "translator-review__actions",
     children: [
-      /* @__PURE__ */ jsx7(Button3, {
+      /* @__PURE__ */ jsx8(Button4, {
         buttonStyle: "primary",
         disabled: Boolean(pending),
-        onClick: () => run("translate-missing"),
+        onClick: () => run("translate-untranslated"),
         size: "small",
-        children: pending === "translate-missing" ? "Translating…" : "Translate missing fields"
+        children: pending === "translate-untranslated" ? "Translating…" : "Translate untranslated fields"
       }),
-      /* @__PURE__ */ jsx7(Button3, {
+      /* @__PURE__ */ jsx8(Button4, {
         buttonStyle: "secondary",
         disabled: Boolean(pending),
         onClick: () => run("translate-all"),
         size: "small",
         children: pending === "translate-all" ? "Translating…" : "Re-translate all"
       }),
-      /* @__PURE__ */ jsx7(Button3, {
+      /* @__PURE__ */ jsx8(Button4, {
         buttonStyle: "secondary",
         disabled: Boolean(pending) || reviewed,
         onClick: () => run("mark-reviewed"),
@@ -373,22 +484,19 @@ var ReviewActions = ({ entity, locale, reviewed }) => {
     ]
   });
 };
-// src/client/components/Review/ReviewStyles.tsx
-
-var ReviewStyles = () => null;
 // src/client/components/Review/TranslationsNavLink.tsx
-import { useConfig as useConfig4 } from "@payloadcms/ui";
+import { useConfig as useConfig5 } from "@payloadcms/ui";
 import { formatAdminURL } from "payload/shared";
-import { jsx as jsx8 } from "react/jsx-runtime";
+import { jsx as jsx9 } from "react/jsx-runtime";
 
 var TranslationsNavLink = () => {
-  const { config: { routes: { admin } } } = useConfig4();
+  const { config: { routes: { admin } } } = useConfig5();
   const href = formatAdminURL({ adminRoute: admin, path: REVIEW_VIEW_PATH });
-  return /* @__PURE__ */ jsx8("a", {
+  return /* @__PURE__ */ jsx9("a", {
     className: "nav__link",
     href,
     id: "nav-translations",
-    children: /* @__PURE__ */ jsx8("span", {
+    children: /* @__PURE__ */ jsx9("span", {
       className: "nav__link-label",
       children: "Translations"
     })
@@ -398,9 +506,9 @@ var TranslationsNavLink = () => {
 // src/exports/client.ts
 var client_default = CustomButtonWithTranslator;
 export {
+  BulkActions,
   CustomButtonWithTranslator,
   ReviewActions,
-  ReviewStyles,
   TranslationsNavLink,
   client_default as default
 };

package/dist/index.d.ts

@@ -6,6 +6,8 @@ type TranslateArgs = {
 	data?: Record<string, any>;
 	emptyOnly?: boolean;
 	globalSlug?: string;
+	/** with `emptyOnly`, also replace fields that still hold the source copy */
+	retranslateIdentical?: boolean;
 	id?: number | string;
 	locale: string;
 	localeFrom: string;
@@ -18,6 +20,8 @@ type TranslateResult = {
 } | {
 	success: true;
 	translatedData: Record<string, any>;
+	/** values sent to the resolver; 0 means the target needed nothing */
+	translatedCount: number;
 	dataFrom: Doc;
 };
 type TranslateOperationArgs = ({
@@ -45,6 +49,11 @@ type TranslateResolver = {
 	key: string;
 	resolve: (args: TranslateResolverArgs) => Promise<TranslateResolverResponse> | TranslateResolverResponse;
 };
+/**
+* `missing` fills empty fields, `untranslated` also replaces fields that still hold the
+* source copy, `all` re-translates everything.
+*/
+type TranslateMode = "all" | "missing" | "untranslated";
 type TranslatorConfig = {
 	collections: CollectionSlug[];
 	disabled?: boolean;
@@ -56,7 +65,7 @@ type TranslatorConfig = {
 	* `missing` (default) fills empty fields and keeps existing translations and slugs;
 	* `all` re-translates every field.
 	*/
-	autoTranslateMode?: "all" | "missing";
+	autoTranslateMode?: TranslateMode;
 	/** adds the /admin/translations review view, its endpoints and the status collection (default true) */
 	review?: boolean;
 	_options?: {

package/dist/index.js

@@ -4,14 +4,19 @@ import {
   createAutoTranslateCollectionHook2,
   createAutoTranslateGlobalHook2,
   recordTranslationStatus,
+  translateModeArgs,
+  isTranslateMode,
   createTranslateTask2,
   createTranslateWorkflow2
-} from "./shared/chunk-p03jz82h.js";
-import"./shared/chunk-9d433kmv.js";
+} from "./shared/chunk-hkx0bzb6.js";
+import"./shared/chunk-d0n3f8ad.js";
 import {
   readLocales,
-  parseEntityKey
-} from "./shared/chunk-15n5q7wd.js";
+  parseEntityKey,
+  hasTranslateWorkflow,
+  queueBulkTranslation,
+  runQueuedTranslations
+} from "./shared/chunk-4ftfmxgs.js";
 import {
   TRANSLATION_STATUS_SLUG2,
   REVIEW_VIEW_PATH
@@ -171,7 +176,7 @@ var translateHandler = async (req) => {
     collectionSlug,
     globalSlug,
     id,
-    emptyOnly: mode !== "all",
+    ...translateModeArgs(isTranslateMode(mode) ? mode : "untranslated"),
     locale,
     localeFrom: defaultLocale,
     overrideAccess: false,
@@ -208,7 +213,39 @@ var markReviewedHandler = async (req) => {
   });
   return Response.json({ success: true });
 };
+var bulkHandler = async (req) => {
+  if (!req.user)
+    throw new APIError("Unauthorized", 401);
+  if (!req.json)
+    throw new APIError("Content-Type should be json");
+  if (!hasTranslateWorkflow(req))
+    throw new APIError("Bulk translation needs autoTranslate enabled, which registers the translate jobs", 400);
+  const body = await req.json();
+  const pluginConfig = req.payload.config.custom?.translator;
+  const { targetLocales } = readLocales(req);
+  const tabAllowed = body.tab === "globals" ? Boolean(pluginConfig?.globals.length) : pluginConfig?.collections.includes(body.tab);
+  if (!body.tab || !tabAllowed)
+    throw new APIError("Forbidden", 403);
+  if (body.locale && !targetLocales.includes(body.locale))
+    throw new APIError("Bad Request", 400);
+  const result = await queueBulkTranslation({
+    req,
+    tab: body.tab,
+    locale: body.locale || undefined,
+    mode: isTranslateMode(body.mode) ? body.mode : "untranslated"
+  });
+  return Response.json({ success: true, ...result });
+};
+var runJobsHandler = async (req) => {
+  if (!req.user)
+    throw new APIError("Unauthorized", 401);
+  if (!hasTranslateWorkflow(req))
+    throw new APIError("Translate jobs are not registered", 400);
+  return Response.json({ success: true, progress: await runQueuedTranslations(req) });
+};
 var reviewEndpoints = [
+  { path: "/translator/review/bulk", method: "post", handler: bulkHandler },
+  { path: "/translator/review/run-jobs", method: "post", handler: runJobsHandler },
   { path: "/translator/review/translate", method: "post", handler: translateHandler },
   { path: "/translator/review/mark-reviewed", method: "post", handler: markReviewedHandler }
 ];

package/dist/jobs.js

@@ -1,12 +1,13 @@
 import {
-  TRANSLATE_TASK_SLUG2,
-  TRANSLATE_WORKFLOW_SLUG2,
   createAutoTranslateCollectionHook2,
   createAutoTranslateGlobalHook2,
   createTranslateTask2,
   createTranslateWorkflow2
-} from "./shared/chunk-p03jz82h.js";
-import"./shared/chunk-9d433kmv.js";
+} from "./shared/chunk-hkx0bzb6.js";
+import {
+  TRANSLATE_TASK_SLUG2,
+  TRANSLATE_WORKFLOW_SLUG2
+} from "./shared/chunk-d0n3f8ad.js";
 
 // src/exports/jobs.ts
 var jobs = {