Versioning & Time-Travel

import { defineModel, DataTypes } from "stabilize-orm";

export const Document = defineModel({
  tableName: "documents",
  versioned: true, // Enable automatic versioning
  columns: {
    id: { type: DataTypes.Integer, primaryKey: true },
    title: { type: DataTypes.String, length: 255 },
    content: { type: DataTypes.Text },
    status: { type: DataTypes.String, length: 50 },
  },
});

const docRepository = orm.getRepository(Document);

// Create initial document (version 1)
const doc = await docRepository.create({
  title: "My Document",
  content: "Initial content",
  status: "draft",
});

console.log("Created document, version:", doc.version); // 1

// Update creates version 2
await docRepository.update(doc.id, {
  content: "Updated content",
});

// Another update creates version 3
await docRepository.update(doc.id, {
  status: "published",
});

console.log("Document now at version 3");

// Get full version history
const history = await docRepository.history(doc.id);

console.log(`Document has ${history.length} versions`);

history.forEach(version => {
  console.log(`Version ${version.version}:`);
  console.log(`  Title: ${version.title}`);
  console.log(`  Status: ${version.status}`);
  console.log(`  Changed at: ${version.modified_at}`);
});

// Get document as it was on a specific date
const pastDate = new Date("2025-01-01T00:00:00Z");
const docAsOf = await docRepository.asOf(doc.id, pastDate);

console.log("Document on Jan 1, 2025:");
console.log(`  Title: ${docAsOf.title}`);
console.log(`  Content: ${docAsOf.content}`);
console.log(`  Status: ${docAsOf.status}`);

// Get a specific version (may require a helper or history lookup)
const version2 = (await docRepository.history(doc.id)).find(v => v.version === 2);
console.log("Version 2 content:", version2?.content);

// Rollback to version 2
await docRepository.rollback(doc.id, 2);

const currentDoc = await docRepository.findOne(doc.id);
console.log("Rolled back to version 2");
console.log("Current content:", currentDoc.content);
console.log("Current version:", currentDoc.version); // Creates new version

// Rollback creates a new version with old data
// So if you were at version 5 and rollback to version 2,
// you'll now be at version 6 with version 2's data

// Get audit trail with user information
const auditTrail = await docRepository.history(doc.id);

console.log("Change History:");
auditTrail.forEach(version => {
  console.log(`Version ${version.version}:`);
  console.log(`  Changed by: ${version.modified_by || "System"}`);
  console.log(`  Changed at: ${version.modified_at}`);
  // You may need to diff fields manually for "changes"
});