@qkix/strapi-plugin-rewind 0.1.2 → 0.1.3

package/README.md

@@ -156,18 +156,42 @@ package that owns the format can show that, so the mapping is a registry:
 ```ts
 import { registerDiffRenderer } from '@qkix/strapi-plugin-rewind/strapi-admin';
 
-registerDiffRenderer('plugin::better-blocks.better-blocks', BlocksDiff);
+import { MyBlocksDiff } from './MyBlocksDiff'; // yours — see below
+
+registerDiffRenderer('plugin::better-blocks.better-blocks', MyBlocksDiff);
 ```
 
 Keyed by a custom field's uid, or by an attribute `type`. A uid wins over a
 type, since every custom field stores itself as `json`.
 
+> **Bring your own renderer.** Rewind ships the registry, not the renderers. No
+> `@qkix` package currently exports a block-aware diff component — including
+> Better Blocks — so the component above is one you write. A renderer receives
+> the two values and returns the `FieldChange` shape exported alongside
+> `registerDiffRenderer`; without one registered, a field falls back to the
+> generic text diff. A ready-made renderer for Better Blocks documents is
+> wanted, and not yet written.
+
 ## Configuration
 
-| Option           | Default | Meaning                                                                                                         |
-| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------- |
-| `contentTypes`   | `[]`    | Which content types to version. Empty means none.                                                               |
-| `trackApiWrites` | `false` | Also version writes from outside the Content Manager (REST, GraphQL, programmatic). `userId` is null for those. |
+| Option                     | Default       | Meaning                                                                                                         |
+| -------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------- |
+| `contentTypes`             | `[]`          | Which content types to version. Empty means none.                                                               |
+| `trackApiWrites`           | `false`       | Also version writes from outside the Content Manager (REST, GraphQL, programmatic). `userId` is null for those. |
+| `retention.enabled`        | `true`        | Thin old versions on a schedule. `false` keeps everything forever and leaves the table to you.                  |
+| `retention.keepAllDays`    | `7`           | Keep every version this many days back.                                                                         |
+| `retention.dailyUntilDays` | `30`          | Then keep one a day, up to this age.                                                                            |
+| `retention.maxAgeDays`     | `365`         | Then keep one a week, and drop anything older.                                                                  |
+| `retention.keepAnchors`    | `true`        | Never thin publish, unpublish, discard or restore versions, whatever their age.                                 |
+| `cron`                     | `'0 3 * * *'` | When the thinning runs, in the server's timezone.                                                               |
+
+The three windows must widen in order — `keepAllDays <= dailyUntilDays <=
+maxAgeDays` — and the plugin refuses to boot rather than delete on a guess if
+they do not. Pinned versions are never thinned either, independently of
+`keepAnchors`.
+
+So out of the box a year of history costs roughly: every save for a week, one a
+day for a month, one a week after that, plus every publish and every pin.
 
 ## Limits
 

package/dist/admin/src/diffRegistry.d.ts

@@ -37,9 +37,14 @@ export type DiffRenderer = React.ComponentType<{
  * the type-to-component mapping is a registry rather than a switch:
  *
  *   import { registerDiffRenderer } from '@qkix/strapi-plugin-rewind/strapi-admin';
- *   registerDiffRenderer('plugin::better-blocks.better-blocks', BlocksDiff);
+ *   registerDiffRenderer('plugin::better-blocks.better-blocks', MyBlocksDiff);
  *
  * Keyed by the attribute's `type`, or by a custom field's uid.
+ *
+ * `MyBlocksDiff` above is the caller's own component. No @qkix package exports
+ * one today — this is the hook for writing it, not a wiring instruction for
+ * something that already exists. Without a renderer registered, the field falls
+ * back to the generic text diff.
  */
 export declare const registerDiffRenderer: (type: string, renderer: DiffRenderer) => void;
 export declare const getDiffRenderer: (type: string) => DiffRenderer | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qkix/strapi-plugin-rewind",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Document version history for Strapi v5 — snapshots on every save, with restore",
   "strapi": {
     "kind": "plugin",
@@ -55,8 +55,8 @@
     "styled-components": "^6.1.17",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
-    "@qkix/strapi-test-harness": "0.0.0",
     "@qkix/eslint-config": "0.0.0",
+    "@qkix/strapi-test-harness": "0.0.0",
     "@qkix/tsconfig": "0.0.0"
   },
   "peerDependencies": {