https://github.com/simonwep/yuppee
⚙️ Type-safe migration library to migrate data from one schema to another.
https://github.com/simonwep/yuppee
json migration migration-tool
Last synced: 8 months ago
JSON representation
⚙️ Type-safe migration library to migrate data from one schema to another.
- Host: GitHub
- URL: https://github.com/simonwep/yuppee
- Owner: simonwep
- License: mit
- Created: 2022-12-23T16:30:45.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T13:22:17.000Z (over 3 years ago)
- Last Synced: 2024-10-29T22:56:37.325Z (over 1 year ago)
- Topics: json, migration, migration-tool
- Language: TypeScript
- Homepage:
- Size: 133 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Type-Safe migration utility to migrate from one data-schema to another.
### Summary
This is a small package to facilitate the transition from one data-structure to another.
It may be useful if you have settings or very little state that is stored as a single JSON-Object that needs to be migrated to another schema at some point.
### Usage
Install it using your preferred package manager (taking npm as example):
```shell
npm install yuppee
```
```ts
import { createMigration, createMigrator } from 'yuppee';
// All possible versions your clients may have.
type StateV1 = { version: 1, name?: string };
type StateV2 = { version: 2, names: string[] };
type StateV3 = { version: 3, data: { names: string[] } };
// This is the type that should be used throughout your app.
// It's an alias to the latest version and can be re-mapped on every update.
type State = StateV3;
const migrate = createMigrator({
init: () => ({ name: 'baz' }),
migrations: [
createMigration({
from: 1,
to: 2,
migrate: (state) => ({
names: state.name ? [state.name] : []
})
}),
createMigration({
from: 2,
to: 3,
migrate: (state) => ({
data: { names: state.names }
})
})
]
});
/* Logs { version: 3, data: { names: ['baz'] } } */
console.log(migrate());
/* Logs { version: 3, data: { names: ['foo'] } } */
console.log(migrate({ version: 1, name: 'foo' }));
/* Logs { version: 3, data: { names: ['bar', 'bam'] } } */
console.log(migrate({ version: 2, names: ['bar', 'bam'] }));
```