@qkix/strapi-plugin-rewind 0.1.3 → 0.1.4

package/README.md

@@ -34,7 +34,7 @@ Strapi sells a feature called **Content History** on its Growth and Enterprise
 plans. Rewind is **not that feature**, is not a drop-in replacement for it, and
 does not unlock it.
 
-It is the poor cousin. If you pay for Growth, use Strapi's — it is deeper, it is
+It is the poor cousin. If you pay for Growth, use Strapi's - it is deeper, it is
 supported by the people who wrote the CMS, and it will stay in step with Strapi
 in a way a third-party plugin cannot promise. Rewind exists for everyone on
 Community Edition, who today has nothing at all: no way to see what a document
@@ -56,7 +56,7 @@ cheap to add once the plumbing existed:
 - **Writes from outside the Content Manager can be versioned** (opt-in), where
   Strapi only ever records admin-panel edits.
 
-And a good deal it does _not_ do — see [Limits](#limits).
+And a good deal it does _not_ do - see [Limits](#limits).
 
 ### On not touching the paywall
 
@@ -64,8 +64,8 @@ Rewind never reads or writes `strapi.ee`, never inspects a licence, and never
 enables a gated feature. It is an independent implementation writing to its own
 table, and it works the same whether or not you have a Strapi licence. Strapi's
 history code is MIT-licensed and was read while working out what the problem
-actually is — the way you would read any open-source implementation before
-writing your own — but the code here is written for this plugin.
+actually is - the way you would read any open-source implementation before
+writing your own - but the code here is written for this plugin.
 
 ## Install
 
@@ -94,7 +94,7 @@ the first disk alert.
 
 Six actions on a tracked content type: `create`, `update`, `clone`, `publish`,
 `unpublish` and `discardDraft`. Each version stores the document's content, its
-relations, and a snapshot of the schema at the time — the last of which is what
+relations, and a snapshot of the schema at the time - the last of which is what
 lets a restore tell "this field was empty" apart from "this field did not exist
 yet".
 
@@ -106,7 +106,7 @@ A save that is rolled back records nothing.
 <img src="https://raw.githubusercontent.com/qkix/strapi-plugins/main/packages/strapi-plugin-rewind/docs/panel.png" alt="History entries labelled Replaced by restore, Draft discarded and Edited" width="320" />
 
 The badge says what happened to the document. **Replaced by restore** marks the
-state a restore was about to overwrite — the undo point for that restore.
+state a restore was about to overwrite - the undo point for that restore.
 
 ## Restoring
 
@@ -125,7 +125,7 @@ part of a restore is what it will _not_ do:
 - fields no longer in the model are skipped
 - links to documents or media that have since been deleted are dropped, and
   reported
-- **fields that are not translated per locale change in every locale at once** —
+- **fields that are not translated per locale change in every locale at once** -
   restoring the Polish version of a document rewrites a shared field for every
   other language too. This is not a choice the plugin makes; a non-localised
   field physically has one value. The dialog names those fields and counts the
@@ -138,14 +138,14 @@ with the one saved immediately before it.
 
 <img src="https://raw.githubusercontent.com/qkix/strapi-plugins/main/packages/strapi-plugin-rewind/docs/changes.png" alt="A word-level diff: 'put back' struck through and replaced by 'restored in one click', and 'ten' by 'twelve'" width="760" />
 
-Scalars are shown as a plain before and after. Prose — including rich text
-stored as JSON — is compared word by word, with the unchanged stretches
+Scalars are shown as a plain before and after. Prose - including rich text
+stored as JSON - is compared word by word, with the unchanged stretches
 collapsed, so a one-word edit in a long article reads as one word rather than
 as the whole article with something green in it somewhere. Relations are
 reported as linked and unlinked.
 
-Where a field's stored value changed but its readable text did not — a mark
-applied, blocks reordered — it says so, rather than showing an empty diff.
+Where a field's stored value changed but its readable text did not - a mark
+applied, blocks reordered - it says so, rather than showing an empty diff.
 
 ### Rendering a field type properly
 
@@ -156,7 +156,7 @@ package that owns the format can show that, so the mapping is a registry:
 ```ts
 import { registerDiffRenderer } from '@qkix/strapi-plugin-rewind/strapi-admin';
 
-import { MyBlocksDiff } from './MyBlocksDiff'; // yours — see below
+import { MyBlocksDiff } from './MyBlocksDiff'; // yours - see below
 
 registerDiffRenderer('plugin::better-blocks.better-blocks', MyBlocksDiff);
 ```
@@ -165,8 +165,8 @@ 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
+> `@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
@@ -185,8 +185,8 @@ type, since every custom field stores itself as `json`.
 | `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
+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`.
 
@@ -213,7 +213,7 @@ Worth knowing before you install it, not after:
 ## Keeping your history when the plugin is off
 
 Strapi's schema sync drops tables belonging to content types it no longer sees.
-Disable this plugin for a single boot and the history would go with it — so on
+Disable this plugin for a single boot and the history would go with it - so on
 boot Rewind adds its table to Strapi's `persisted_tables` list, which is the
 same mechanism Strapi uses to protect its own. Nothing to configure.
 
@@ -221,6 +221,11 @@ same mechanism Strapi uses to protect its own. Nothing to configure.
 
 Strapi 5, Node 20 or 22.
 
+## Roadmap
+
+What is worth building next, what is deliberately not planned, and why:
+[ROADMAP.md](https://github.com/qkix/strapi-plugins/blob/main/packages/strapi-plugin-rewind/ROADMAP.md).
+
 ## License
 
 MIT.

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

@@ -42,7 +42,7 @@ export type DiffRenderer = React.ComponentType<{
  * 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
+ * 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.
  */

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

@@ -11,7 +11,7 @@ declare const _default: {
 export default _default;
 export { PLUGIN_ID } from './pluginId';
 /**
- * The hook a package owning a field format uses to render its own diff — see
+ * The hook a package owning a field format uses to render its own diff - see
  * diffRegistry for why this is a registry and not a switch.
  */
 export { registerDiffRenderer } from './diffRegistry';

package/dist/server/index.mjs

@@ -152,7 +152,7 @@ const Z = ["id", "documentId", "locale"], S = [
      * Writes one version per affected locale, for each buffered intent.
      *
      * Called from the transaction's commit hook and never awaited by the write
-     * path — a failure here must not be able to reach the editor's save.
+     * path - a failure here must not be able to reach the editor's save.
      */
     async captureAll(i, c) {
       for (const l of i)
@@ -203,7 +203,7 @@ const Z = ["id", "documentId", "locale"], S = [
     const a = j.indexOf(n.origin) < j.indexOf(o.origin);
     t.set(r, {
       // A winning `publish` still wants the rows an earlier `discardDraft`
-      // captured — losing them would lose the only copy of that state.
+      // captured - losing them would lose the only copy of that state.
       ...a ? n : o,
       before: o.before ?? n.before
     });
@@ -342,7 +342,7 @@ const Z = ["id", "documentId", "locale"], S = [
      * On by default, because a version table that only grows is a problem the
      * plugin would be creating rather than solving. The defaults are gentle:
      * a full week of every save, then a version a day for a month, then one a
-     * week — and anchors (publish, unpublish, discard, restore) and pinned
+     * week - and anchors (publish, unpublish, discard, restore) and pinned
      * versions are never removed at all, whatever their age.
      *
      * Set `enabled: false` to keep everything forever and manage it yourself.
@@ -677,8 +677,8 @@ const Z = ["id", "documentId", "locale"], S = [
     /**
      * What changed between a version and the one before it.
      *
-     * Comparing against the previous version — rather than against the document
-     * as it stands — is what makes a history readable: each entry answers "what
+     * Comparing against the previous version - rather than against the document
+     * as it stands - is what makes a history readable: each entry answers "what
      * did this edit do?". The other question, "what would restoring this
      * change?", is what `restore.preview()` already answers.
      */
@@ -836,7 +836,7 @@ const Z = ["id", "documentId", "locale"], S = [
      *
      * A separate call, and the UI shows it before asking for confirmation.
      * Restore without a preview of the consequences is a trap rather than a
-     * tool — `crossLocaleFields` in particular, where restoring the Polish
+     * tool - `crossLocaleFields` in particular, where restoring the Polish
      * version of a document quietly rewrites a field in every other language.
      */
     async preview(s) {
@@ -860,7 +860,7 @@ const Z = ["id", "documentId", "locale"], S = [
     /**
      * Writes the version back, to the draft only.
      *
-     * The document lands in "modified" and publishing stays a deliberate act —
+     * The document lands in "modified" and publishing stays a deliberate act -
      * restoring must never change what the public sees on its own.
      */
     async apply(s, i) {

package/dist/server/src/config/index.d.ts

@@ -31,7 +31,7 @@ declare const _default: {
          * On by default, because a version table that only grows is a problem the
          * plugin would be creating rather than solving. The defaults are gentle:
          * a full week of every save, then a version a day for a month, then one a
-         * week — and anchors (publish, unpublish, discard, restore) and pinned
+         * week - and anchors (publish, unpublish, discard, restore) and pinned
          * versions are never removed at all, whatever their age.
          *
          * Set `enabled: false` to keep everything forever and manage it yourself.

package/dist/server/src/content-types/index.d.ts

@@ -2,8 +2,8 @@
  * The versions table.
  *
  * `relatedDocumentId`, not `documentId`: Strapi injects a `documentId` into
- * every content type and rejects the name outright — "The attribute
- * "documentId" is reserved and cannot be used in a model" — at boot, before
+ * every content type and rejects the name outright - "The attribute
+ * "documentId" is reserved and cannot be used in a model" - at boot, before
  * anything else runs. Strapi's own history model calls it `relatedDocumentId`
  * for the same reason.
  *

package/dist/server/src/services/diff.d.ts

@@ -8,17 +8,17 @@ export interface FieldChange {
     type: string;
     /**
      * A custom field's uid, when the attribute is one. Custom fields all report
-     * their storage type — usually `json` — so this is the only thing specific
+     * their storage type - usually `json` - so this is the only thing specific
      * enough for the owning package to key a diff renderer on.
      */
     customField?: string;
     kind: ChangeKind;
-    /** Scalars only — the values themselves, for a plain before/after. */
+    /** Scalars only - the values themselves, for a plain before/after. */
     before?: unknown;
     after?: unknown;
-    /** Prose fields — a word-level diff of the readable text. */
+    /** Prose fields - a word-level diff of the readable text. */
     spans?: DiffSpan[];
-    /** Relations and media — what was linked and unlinked. */
+    /** Relations and media - what was linked and unlinked. */
     linked?: RelationRef[];
     unlinked?: RelationRef[];
 }
@@ -45,8 +45,8 @@ declare const diff: ({ strapi }: {
     /**
      * What changed between a version and the one before it.
      *
-     * Comparing against the previous version — rather than against the document
-     * as it stands — is what makes a history readable: each entry answers "what
+     * Comparing against the previous version - rather than against the document
+     * as it stands - is what makes a history readable: each entry answers "what
      * did this edit do?". The other question, "what would restoring this
      * change?", is what `restore.preview()` already answers.
      */

package/dist/server/src/services/lock.d.ts

@@ -8,7 +8,7 @@ import type { Core } from '@strapi/strapi';
  *
  * Best-effort is the honest description: read-then-write is not atomic, so two
  * instances starting within the same millisecond can both win. That is
- * acceptable for a nightly tidy-up and not for anything else — do not reuse
+ * acceptable for a nightly tidy-up and not for anything else - do not reuse
  * this for something that must happen exactly once.
  */
 declare const lock: ({ strapi }: {

package/dist/server/src/services/restore.d.ts

@@ -3,9 +3,9 @@ import type { RelationRef } from './serializer';
 export interface RestorePreview {
     /** Fields that will be written back. */
     fieldsToRestore: string[];
-    /** In the model but not in the version — left exactly as they are. */
+    /** In the model but not in the version - left exactly as they are. */
     fieldsKeptAsIs: string[];
-    /** In the version but no longer in the model — skipped. */
+    /** In the version but no longer in the model - skipped. */
     fieldsDropped: string[];
     /** Not localised, so restoring them changes every locale at once. */
     crossLocaleFields: string[];
@@ -26,14 +26,14 @@ declare const restore: ({ strapi }: {
      *
      * A separate call, and the UI shows it before asking for confirmation.
      * Restore without a preview of the consequences is a trap rather than a
-     * tool — `crossLocaleFields` in particular, where restoring the Polish
+     * tool - `crossLocaleFields` in particular, where restoring the Polish
      * version of a document quietly rewrites a field in every other language.
      */
     preview(versionId: number): Promise<RestorePreview>;
     /**
      * Writes the version back, to the draft only.
      *
-     * The document lands in "modified" and publishing stays a deliberate act —
+     * The document lands in "modified" and publishing stays a deliberate act -
      * restoring must never change what the public sees on its own.
      */
     apply(versionId: number, userId: number | null): Promise<{

package/dist/server/src/services/serializer.d.ts

@@ -3,8 +3,8 @@
  *
  * Written for this plugin rather than lifted from Strapi's own history module.
  * Where the shapes here resemble theirs it is because Strapi's populate API
- * dictates them — a relation can only be populated by naming its fields, a
- * dynamic zone only through `on` fragments — not because the code was copied.
+ * dictates them - a relation can only be populated by naming its fields, a
+ * dynamic zone only through `on` fragments - not because the code was copied.
  * Their implementation is MIT and was read while working out what the problem
  * actually is; two facts learned that way are worth stating outright, since
  * both cost a day if you meet them the hard way:
@@ -26,7 +26,7 @@ import type { Core } from '@strapi/strapi';
  * The timestamps and author columns change on every write, so a version that
  * keeps them can never be compared with another. `locale` and `localizations`
  * are injected by i18n and describe how the document is wired up rather than
- * what it says — restoring them would try to rewrite the translation graph.
+ * what it says - restoring them would try to rewrite the translation graph.
  */
 export declare const FIELDS_TO_IGNORE: string[];
 export interface RelationRef {

package/dist/server/src/services/snapshot.d.ts

@@ -9,7 +9,7 @@ declare const snapshot: ({ strapi }: {
      * Writes one version per affected locale, for each buffered intent.
      *
      * Called from the transaction's commit hook and never awaited by the write
-     * path — a failure here must not be able to reach the editor's save.
+     * path - a failure here must not be able to reach the editor's save.
      */
     captureAll(intents: SnapshotIntent[], userId: number | null): Promise<void>;
     capture(intent: SnapshotIntent, userId: number | null): Promise<void>;

package/dist/server/src/utils/backfillLabels.d.ts

@@ -3,7 +3,7 @@ import type { Core } from '@strapi/strapi';
  * Gives versions recorded before labels existed something to show.
  *
  * Without this, upgrading leaves a history where older entries are a badge and
- * a timestamp and newer ones have a title — the list stays half-unreadable for
+ * a timestamp and newer ones have a title - the list stays half-unreadable for
  * exactly as long as the old versions are worth keeping.
  *
  * Two details that matter:

package/dist/server/src/utils/captureContext.d.ts

@@ -11,7 +11,7 @@ export interface SnapshotIntent {
  * Intents buffered against the transaction they belong to.
  *
  * Keyed by the Knex transaction object because that is the only thing the
- * Content Manager's `update` and `publish` calls have in common — they are
+ * Content Manager's `update` and `publish` calls have in common - they are
  * sequential siblings, not nested, so nothing about the call stack relates
  * them. Strapi hands the same `trx` to every nested `db.transaction`, which
  * makes it a reliable key, and a WeakMap means a finished transaction takes its

package/dist/server/src/utils/persistTable.d.ts

@@ -3,8 +3,8 @@ import type { Core } from '@strapi/strapi';
  * Keeps the versions table alive when the plugin is not loaded.
  *
  * Strapi's schema sync drops any table it previously tracked that is no longer
- * in the user schema. Disable this plugin for a single boot — to debug, to test
- * an upgrade — and the history it exists to protect is gone without a prompt.
+ * in the user schema. Disable this plugin for a single boot - to debug, to test
+ * an upgrade - and the history it exists to protect is gone without a prompt.
  *
  * `persisted_tables` is the core-store key `@strapi/database` consults before
  * dropping (schema/diff.js). The EE `admin::persist-tables` service writes the

package/dist/server/src/utils/textDiff.d.ts

@@ -1,7 +1,7 @@
 /**
  * A word-level diff, and the text extraction that makes it useful.
  *
- * The alternative — reporting "content changed" — is true and worthless. The
+ * The alternative - reporting "content changed" - is true and worthless. The
  * field an editor cares most about is usually rich text stored as JSON, so the
  * readable part is pulled out and compared as prose. That is renderer-agnostic:
  * it walks the structure collecting anything that reads as text, without
@@ -29,7 +29,7 @@ export declare const diffWords: (before: string, after: string) => DiffSpan[];
  * Pulls the human-readable text out of an arbitrary value.
  *
  * Rich text, components and dynamic zones are all nested objects and arrays
- * whose shape this plugin deliberately does not model — a `text` key here, a
+ * whose shape this plugin deliberately does not model - a `text` key here, a
  * `children` array there. Collecting every string reached is imprecise but
  * stable across editors, and it is what turns "content changed" into a sentence
  * an editor recognises.

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@qkix/strapi-plugin-rewind",
-  "version": "0.1.3",
-  "description": "Document version history for Strapi v5 — snapshots on every save, with restore",
+  "version": "0.1.4",
+  "description": "Document version history for Strapi v5 - snapshots on every save, with restore",
   "strapi": {
     "kind": "plugin",
     "name": "rewind",
     "displayName": "Rewind",
-    "description": "Document version history for Strapi v5 — snapshots on every save, with restore"
+    "description": "Document version history for Strapi v5 - snapshots on every save, with restore"
   },
   "keywords": [
     "strapi",