@focus-reactive/payload-plugin-translator 0.11.2 → 0.11.3

package/README.md

@@ -618,6 +618,40 @@ Payload lets a wrapper field (group, array, blocks, tabs) be `localized`, which
 
 See the `deleteJobOnComplete: false` note under [Runners](#createpayloadjobsrunneroptions-recommended).
 
+Keeping them means they accumulate: nothing in the plugin removes a completed translation job, and the
+status panels read a collection's jobs on every open. How long that history is worth keeping is your
+call, not the plugin's, so pruning is left to you — the same way `deleteJobOnComplete` is.
+
+_Applies only to `createPayloadJobsRunner`._ `createSyncRunner` translates inline and writes no jobs at
+all, so there is nothing to prune.
+
+```ts
+// Run from your own cron / scheduled task.
+// Must match the `taskName` you passed to createPayloadJobsRunner — "translate_document" by default.
+const TRANSLATOR_TASK = "translate_document";
+
+const cutoff = new Date(Date.now() - 30 * 24 * 60 * 60 * 1000).toISOString();
+
+await payload.delete({
+  collection: "payload-jobs",
+  where: {
+    and: [
+      { taskSlug: { equals: TRANSLATOR_TASK } },
+      { completedAt: { exists: true } },
+      { completedAt: { less_than: cutoff } },
+    ],
+  },
+});
+```
+
+Three things the clauses buy you, in order: only this plugin's jobs, only finished ones — so nothing
+queued or in flight is touched — and only those older than your cutoff, so a run someone may still want
+to look at survives. Keep a cutoff of at least a day for that last reason; deleting everything
+completed would erase a translation that finished minutes ago.
+
+All three filter on real columns rather than paths inside the job's JSON input, so this behaves the same
+on SQLite, Postgres and MongoDB.
+
 ## TypeScript
 
 The package ships its types. Besides the factories, the following are exported for typing your own code:

package/dist/server/modules/task-runner/TaskRunner.interface.d.ts

@@ -35,7 +35,7 @@ export interface TaskRunner {
  * How a {@link TaskRunner.findByCollection} call is narrowed. Each field says whether it reaches the
  * database or is applied in memory over everything the database returned.
  *
- * @since 0.12.0
+ * @since 0.11.2
  */
 export type TaskFilter = {
     /** Keep only tasks for these documents. Applied in memory — see `PayloadJobsTaskRunner.findByCollection`. */

package/dist/server/modules/task-runner/TaskRunner.interface.js

@@ -2,7 +2,7 @@
  * How a {@link TaskRunner.findByCollection} call is narrowed. Each field says whether it reaches the
  * database or is applied in memory over everything the database returned.
  *
- * @since 0.12.0
+ * @since 0.11.2
  */ export { };
 
 //# sourceMappingURL=TaskRunner.interface.js.map

package/dist/server/modules/task-runner/toTaskFilter.d.ts

@@ -6,6 +6,6 @@ import type { TaskFilter } from "./TaskRunner.interface";
  * than being re-derived: the array form is deprecated and will be removed, and a hand-written
  * `Array.isArray` branch in someone else's runner would outlive it.
  *
- * @since 0.12.0
+ * @since 0.11.2
  */
 export declare function toTaskFilter(filter?: Array<string | number> | TaskFilter): TaskFilter;

package/dist/server/modules/task-runner/toTaskFilter.js

@@ -5,7 +5,7 @@
  * than being re-derived: the array form is deprecated and will be removed, and a hand-written
  * `Array.isArray` branch in someone else's runner would outlive it.
  *
- * @since 0.12.0
+ * @since 0.11.2
  */ export function toTaskFilter(filter) {
     return Array.isArray(filter) ? {
         documentIds: filter

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@focus-reactive/payload-plugin-translator",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "description": "Translation plugin for Payload CMS 3.x. Automatically translate your localized content using any translation provider.",
   "type": "module",
   "license": "MIT",