@qkix/strapi-plugin-rewind 0.3.0 → 0.4.1

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

@@ -35,6 +35,15 @@ export interface RelationRef {
     id?: number;
     locale?: string | null;
     targetUid: string;
+    /**
+     * What the target was called when the version was taken.
+     *
+     * Stored rather than looked up, because the moment it matters is the moment
+     * it can no longer be looked up: a relation to a since-deleted document would
+     * otherwise read as an id and a shrug. Absent on versions written before this
+     * was recorded, and on a target whose type has no field that reads as a name.
+     */
+    label?: string;
 }
 export interface SplitDocument {
     data: Record<string, unknown>;
@@ -44,8 +53,44 @@ export interface SplitDocument {
 type Attribute = Record<string, any>;
 /** Morph relations are skipped: Strapi's own populate builder skips them too. */
 export declare const isMorphRelation: (attribute: Attribute) => boolean;
-/** Populate object covering everything a snapshot needs, and nothing more. */
-export declare const buildDeepPopulate: (strapi: Core.Strapi, uid: string, useDatabaseSyntax?: boolean) => Record<string, unknown>;
+/** Media is a relation to one particular content type, and always has been. */
+export declare const MEDIA_UID = "plugin::upload.file";
+/** The field to read a target's name from, per target uid. */
+export type LabelFields = Map<string, string>;
+/**
+ * Which field names a target of each relation on this content type.
+ *
+ * The Content Manager's configured `mainField` first, so a version agrees with
+ * what the relation input in the editor shows, then the usual suspects. The
+ * result is validated against the target's own attributes: a `mainField` can
+ * name a field that has since been deleted, and selecting a column that is not
+ * there fails the whole snapshot rather than one label.
+ *
+ * Async because the configuration lives in the store. Resolved once per
+ * capture, not once per relation - see the cache in `createMainFieldResolver`.
+ */
+export declare const labelFieldsFor: (strapi: Core.Strapi, uid: string, mainFieldFor: (targetUid: string) => Promise<string | undefined>) => Promise<LabelFields>;
+/**
+ * The same relations with their labels taken off.
+ *
+ * Content hashes are what stops an unchanged save becoming a version, and a
+ * label is not content: renaming an author does not change which author an
+ * article points at. Hashing it would make the next save of every article
+ * mentioning that author look like an edit, and produce a version whose diff is
+ * empty. Stripping here also keeps hashes written before labels existed valid.
+ */
+export declare const withoutLabels: (relations: Record<string, RelationRef[]>) => Record<string, RelationRef[]>;
+/**
+ * Populate object covering everything a snapshot needs, and nothing more.
+ *
+ * `labelFields` names, per target uid, the one extra column to read so the
+ * relation can be recorded with the target's name as well as its id - see
+ * {@link labelFieldsFor}. It is applied to this level only, never to the
+ * recursion: a relation nested inside a component is stored as part of `data`
+ * rather than extracted, so widening its select would change what a component
+ * holds, and with it every content hash ever computed.
+ */
+export declare const buildDeepPopulate: (strapi: Core.Strapi, uid: string, useDatabaseSyntax?: boolean, labelFields?: LabelFields) => Record<string, unknown>;
 /**
  * The content type's attributes plus every component reachable from it, however
  * deeply nested.
@@ -61,5 +106,5 @@ export declare const buildSchemaSnapshot: (strapi: Core.Strapi, uid: string) =>
  * and "the author changed" as different kinds of change, and so a restore can
  * check each target still exists before writing it back.
  */
-export declare const split: (strapi: Core.Strapi, uid: string, entry: Record<string, unknown>) => SplitDocument;
+export declare const split: (strapi: Core.Strapi, uid: string, entry: Record<string, unknown>, labelFields?: LabelFields) => SplitDocument;
 export {};

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

@@ -1,4 +1,22 @@
 import type { Core } from '@strapi/strapi';
+/**
+ * Which field the Content Manager treats as a type's title.
+ *
+ * Returned as a function so the lookup is cached per content type: a backfill
+ * runs it once per row, a snapshot once per relation target, and the
+ * configuration behind it does not change while the server is up.
+ *
+ * `undefined` when the type has no configuration yet - which happens for a
+ * content type added since the last admin build - so callers guess instead.
+ */
+export declare const createMainFieldResolver: (strapi: Core.Strapi) => (uid: string) => Promise<string | undefined>;
+/**
+ * Field names worth trying when the Content Manager has no opinion.
+ *
+ * Shared with {@link import('../services/serializer').labelFieldsFor}, so a
+ * version and the relations inside it are named by the same rule.
+ */
+export declare const LABEL_FIELD_CANDIDATES: string[];
 /**
  * Derives the short, human-readable stand-in shown for a version in the panel.
  *
@@ -7,8 +25,6 @@ import type { Core } from '@strapi/strapi';
  * pressing Restore would give them.
  *
  * The field is whatever the Content Manager displays as the entry's title, so
- * the panel agrees with the rest of the admin. The returned function caches the
- * lookup per content type: a backfill runs it once per row, and the
- * configuration behind it does not change while the server is up.
+ * the panel agrees with the rest of the admin.
  */
 export declare const createLabeller: (strapi: Core.Strapi) => (uid: string, data: Record<string, unknown> | null | undefined) => Promise<string | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qkix/strapi-plugin-rewind",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Document version history for Strapi v5 - snapshots on every save, with restore",
   "strapi": {
     "kind": "plugin",
@@ -56,8 +56,8 @@
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
     "@qkix/eslint-config": "0.0.0",
-    "@qkix/tsconfig": "0.0.0",
-    "@qkix/strapi-test-harness": "0.0.0"
+    "@qkix/strapi-test-harness": "0.0.0",
+    "@qkix/tsconfig": "0.0.0"
   },
   "peerDependencies": {
     "@strapi/admin": "^5.0.0",