@serve.zone/dcrouter-migrations

Versioned SmartMigration chain for dcrouter's persistent data. This package builds the migration runner that dcrouter executes before DB-backed managers start reading collections.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Installation

pnpm add @serve.zone/dcrouter-migrations

What It Exports

Export	Purpose
`createMigrationRunner(db, targetVersion)`	Builds the dcrouter migration runner for the target application version
`IMigrationRunner`	Small interface for the returned runner
`IMigrationRunResult`	Result shape logged after a run

When To Use It

You are embedding dcrouter's storage layer outside the full runtime.
You want to test or inspect schema transitions directly.
You are extending dcrouter with new persistent data and need versioned upgrades.

If you boot the full DcRouter runtime, this package is already used for you during startup.

Usage

import { createMigrationRunner } from '@serve.zone/dcrouter-migrations';

const migration = await createMigrationRunner(db, '13.20.0');
const result = await migration.run();

console.log(result.currentVersionBefore, result.currentVersionAfter);

What the Current Chain Covers

target profile target field migration from host to ip
legacy domain source rename from manual to dcrouter
legacy DNS record source rename from manual to local
route storage unification from StoredRouteDoc to RouteDoc
route origin backfill for migrated API routes
systemKey backfill for persisted config, email, and DNS routes

Authoring Rules

Add new migration logic only in ts_migrations/index.ts.
Keep every step idempotent so reruns are safe.
Make each step's .to() version line up with the release version that ships it.
When adding new collection references, use the exact smartdata class-name collection casing for new code.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the LICENSE file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

readme.md