Compare commits
21 Commits
Author | SHA1 | Date |
---|---|---|
Bauke | f26b4dd09e | |
Bauke | f6ffc0182d | |
Bauke | d8fa000181 | |
Bauke | cfd7e39b03 | |
Bauke | 453b707b46 | |
Bauke | 80267a459a | |
Bauke | fc5741192d | |
Bauke | 43c3a5c132 | |
Bauke | fd20d051a1 | |
Bauke | 7c95c574ce | |
Bauke | b798e18a16 | |
Bauke | 6f084dc9e0 | |
Bauke | 5a10c49a3e | |
Bauke | d1811c1da9 | |
Bauke | 90ef75b68b | |
Bauke | 5e9d99fd47 | |
Bauke | 72ffa26796 | |
Bauke | c9f30bffef | |
Bauke | 6d1dff6af5 | |
Bauke | cfa0e5ea34 | |
Bauke | 492673d71d |
|
@ -1,107 +1,4 @@
|
||||||
# Logs
|
.direnv/
|
||||||
logs
|
|
||||||
*.log
|
|
||||||
npm-debug.log*
|
|
||||||
yarn-debug.log*
|
|
||||||
yarn-error.log*
|
|
||||||
lerna-debug.log*
|
|
||||||
|
|
||||||
# Diagnostic reports (https://nodejs.org/api/report.html)
|
|
||||||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
|
|
||||||
|
|
||||||
# Runtime data
|
|
||||||
pids
|
|
||||||
*.pid
|
|
||||||
*.seed
|
|
||||||
*.pid.lock
|
|
||||||
|
|
||||||
# Directory for instrumented libs generated by jscoverage/JSCover
|
|
||||||
lib-cov
|
|
||||||
|
|
||||||
# Coverage directory used by tools like istanbul
|
|
||||||
coverage
|
|
||||||
*.lcov
|
|
||||||
|
|
||||||
# nyc test coverage
|
|
||||||
.nyc_output
|
|
||||||
|
|
||||||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
|
||||||
.grunt
|
|
||||||
|
|
||||||
# Bower dependency directory (https://bower.io/)
|
|
||||||
bower_components
|
|
||||||
|
|
||||||
# node-waf configuration
|
|
||||||
.lock-wscript
|
|
||||||
|
|
||||||
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
|
||||||
build/Release
|
|
||||||
|
|
||||||
# Dependency directories
|
|
||||||
node_modules/
|
|
||||||
jspm_packages/
|
|
||||||
|
|
||||||
# TypeScript v1 declaration files
|
|
||||||
typings/
|
|
||||||
|
|
||||||
# TypeScript cache
|
|
||||||
*.tsbuildinfo
|
|
||||||
|
|
||||||
# Optional npm cache directory
|
|
||||||
.npm
|
|
||||||
|
|
||||||
# Optional eslint cache
|
|
||||||
.eslintcache
|
|
||||||
|
|
||||||
# Microbundle cache
|
|
||||||
.rpt2_cache/
|
|
||||||
.rts2_cache_cjs/
|
|
||||||
.rts2_cache_es/
|
|
||||||
.rts2_cache_umd/
|
|
||||||
|
|
||||||
# Optional REPL history
|
|
||||||
.node_repl_history
|
|
||||||
|
|
||||||
# Output of 'npm pack'
|
|
||||||
*.tgz
|
|
||||||
|
|
||||||
# Yarn Integrity file
|
|
||||||
.yarn-integrity
|
|
||||||
|
|
||||||
# dotenv environment variables file
|
|
||||||
.env
|
|
||||||
.env.test
|
|
||||||
|
|
||||||
# parcel-bundler cache (https://parceljs.org/)
|
|
||||||
.cache
|
|
||||||
|
|
||||||
# Next.js build output
|
|
||||||
.next
|
|
||||||
|
|
||||||
# Nuxt.js build / generate output
|
|
||||||
.nuxt
|
|
||||||
dist
|
|
||||||
|
|
||||||
# Gatsby files
|
|
||||||
.cache/
|
|
||||||
# Comment in the public line in if your project uses Gatsby and *not* Next.js
|
|
||||||
# https://nextjs.org/blog/next-9-1#public-directory-support
|
|
||||||
# public
|
|
||||||
|
|
||||||
# vuepress build output
|
|
||||||
.vuepress/dist
|
|
||||||
|
|
||||||
# Serverless directories
|
|
||||||
.serverless/
|
|
||||||
|
|
||||||
# FuseBox cache
|
|
||||||
.fusebox/
|
|
||||||
|
|
||||||
# DynamoDB Local files
|
|
||||||
.dynamodb/
|
|
||||||
|
|
||||||
# TernJS port file
|
|
||||||
.tern-port
|
|
||||||
|
|
||||||
# Build output directory
|
|
||||||
build/
|
build/
|
||||||
|
coverage/
|
||||||
|
node_modules/
|
||||||
|
|
143
LICENSE
143
LICENSE
|
@ -1,5 +1,5 @@
|
||||||
GNU GENERAL PUBLIC LICENSE
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
Version 3, 29 June 2007
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
@ -7,17 +7,15 @@
|
||||||
|
|
||||||
Preamble
|
Preamble
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
software and other kinds of works.
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
The licenses for most software and other practical works are designed
|
||||||
to take away your freedom to share and change the works. By contrast,
|
to take away your freedom to share and change the works. By contrast,
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
share and change all versions of a program--to make sure it remains free
|
share and change all versions of a program--to make sure it remains free
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
software for all its users.
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
When we speak of free software, we are referring to freedom, not
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
|
||||||
want it, that you can change the software or use pieces of it in new
|
want it, that you can change the software or use pieces of it in new
|
||||||
free programs, and that you know you can do these things.
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
Developers that use our General Public Licenses protect your rights
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
you this License which gives you legal permission to copy, distribute
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
and/or modify the software.
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
A secondary benefit of defending all users' freedom is that
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
improvements made in alternate versions of the program, if they
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
receive widespread use, become available for other developers to
|
||||||
or can get the source code. And you must show them these terms so they
|
incorporate. Many developers of free software are heartened and
|
||||||
know their rights.
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
The GNU Affero General Public License is designed specifically to
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
ensure that, in such cases, the modified source code becomes available
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
An older license, called the Affero General Public License and
|
||||||
that there is no warranty for this free software. For both users' and
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
changed, so that their problems will not be attributed erroneously to
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
authors of previous versions.
|
this license.
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
The precise terms and conditions for copying, distribution and
|
||||||
modification follow.
|
modification follow.
|
||||||
|
@ -72,7 +60,7 @@ modification follow.
|
||||||
|
|
||||||
0. Definitions.
|
0. Definitions.
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
works, such as semiconductor masks.
|
works, such as semiconductor masks.
|
||||||
|
@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
|
||||||
the Program, the only way you could satisfy both those terms and this
|
the Program, the only way you could satisfy both those terms and this
|
||||||
License would be to refrain entirely from conveying the Program.
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
Notwithstanding any other provision of this License, you have
|
||||||
permission to link or combine any covered work with a work licensed
|
permission to link or combine any covered work with a work licensed
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
under version 3 of the GNU General Public License into a single
|
||||||
combined work, and to convey the resulting work. The terms of this
|
combined work, and to convey the resulting work. The terms of this
|
||||||
License will continue to apply to the part which is the covered work,
|
License will continue to apply to the part which is the covered work,
|
||||||
but the special requirements of the GNU Affero General Public License,
|
but the work with which it is combined will remain governed by version
|
||||||
section 13, concerning interaction through a network will apply to the
|
3 of the GNU General Public License.
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
the GNU General Public License from time to time. Such new versions will
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
address new problems or concerns.
|
address new problems or concerns.
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
Each version is given a distinguishing version number. If the
|
||||||
Program specifies that a certain numbered version of the GNU General
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
Public License "or any later version" applies to it, you have the
|
Public License "or any later version" applies to it, you have the
|
||||||
option of following the terms and conditions either of that numbered
|
option of following the terms and conditions either of that numbered
|
||||||
version or of any later version published by the Free Software
|
version or of any later version published by the Free Software
|
||||||
Foundation. If the Program does not specify a version number of the
|
Foundation. If the Program does not specify a version number of the
|
||||||
GNU General Public License, you may choose any version ever published
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
by the Free Software Foundation.
|
by the Free Software Foundation.
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
If the Program specifies that a proxy can decide which future
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
public statement of acceptance of a version permanently authorizes you
|
public statement of acceptance of a version permanently authorizes you
|
||||||
to choose that version for the Program.
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
|
||||||
Copyright (C) <year> <name of author>
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
This program is free software: you can redistribute it and/or modify
|
||||||
it under the terms of the GNU General Public License as published by
|
it under the terms of the GNU Affero General Public License as published
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
by the Free Software Foundation, either version 3 of the License, or
|
||||||
(at your option) any later version.
|
(at your option) any later version.
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
GNU General Public License for more details.
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU Affero General Public License
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
If your software can interact with users remotely through a computer
|
||||||
notice like this when it starts in an interactive mode:
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
<program> Copyright (C) <year> <name of author>
|
interface could display a "Source" link that leads users to an archive
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
of the code. There are many ways you could offer source, and different
|
||||||
This is free software, and you are welcome to redistribute it
|
solutions will be better for different programs; see section 13 for the
|
||||||
under certain conditions; type `show c' for details.
|
specific requirements.
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
<https://www.gnu.org/licenses/>.
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
|
|
|
@ -0,0 +1,35 @@
|
||||||
|
# Build the package.
|
||||||
|
[tasks.build]
|
||||||
|
dependencies = ["clean", "lint"]
|
||||||
|
clear = true
|
||||||
|
command = "pnpm"
|
||||||
|
args = ["tsc"]
|
||||||
|
|
||||||
|
# Clean the build directory.
|
||||||
|
[tasks.clean]
|
||||||
|
clear = true
|
||||||
|
command = "pnpm"
|
||||||
|
args = ["trash", "build/"]
|
||||||
|
|
||||||
|
# Run the full set of linting and testing.
|
||||||
|
[tasks.lint]
|
||||||
|
clear = true
|
||||||
|
dependencies = ["lint-js", "typecheck", "test"]
|
||||||
|
|
||||||
|
# Lint the TypeScript using XO.
|
||||||
|
[tasks.lint-js]
|
||||||
|
clear = true
|
||||||
|
command = "pnpm"
|
||||||
|
args = ["xo"]
|
||||||
|
|
||||||
|
# Run the tests.
|
||||||
|
[tasks.test]
|
||||||
|
clear = true
|
||||||
|
command = "pnpm"
|
||||||
|
args = ["tsx", "tests/migrate.test.ts"]
|
||||||
|
|
||||||
|
# Do a typecheck with tsc.
|
||||||
|
[tasks.typecheck]
|
||||||
|
clear = true
|
||||||
|
command = "pnpm"
|
||||||
|
args = ["tsc", "--noEmit"]
|
26
README.md
26
README.md
|
@ -1,19 +1,17 @@
|
||||||
# migration-helper
|
# Migration 🧳 Helper
|
||||||
|
|
||||||
> A tiny helper library for migrating data.
|
> **Tiny helper library for migrating data.**
|
||||||
|
|
||||||
* Zero dependencies
|
## Features
|
||||||
* 100% code coverage
|
|
||||||
* TypeScript definitions included
|
* Zero dependencies.
|
||||||
|
* 100% code coverage.
|
||||||
|
* TypeScript definitions included.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install migration-helper
|
|
||||||
```
|
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import {migrate, Migration} from 'migration-helper';
|
import {migrate, Migration} from '@holllo/migration-helper';
|
||||||
|
|
||||||
// Your data that needs migrating.
|
// Your data that needs migrating.
|
||||||
const data = 'data';
|
const data = 'data';
|
||||||
|
@ -34,12 +32,14 @@ const migrations: Array<Migration<string>> = [
|
||||||
];
|
];
|
||||||
|
|
||||||
// Migrate your data.
|
// Migrate your data.
|
||||||
const migrated = migrate(data, version, migrations);
|
const migrated = await migrate(data, version, migrations);
|
||||||
|
|
||||||
// Congratulations, your data is now on version 1.0.2!
|
// Congratulations, your data is now on version 1.0.2!
|
||||||
console.log(migrated);
|
console.log(migrated);
|
||||||
```
|
```
|
||||||
|
|
||||||
See [the tests directory] for how to use `number`, `Date` or a custom way of versioning.
|
See [the tests directory](https://git.bauke.xyz/Holllo/migration-helper/src/branch/main/tests) for how to use `number`, `Date` or a custom way of versioning.
|
||||||
|
|
||||||
[the tests directory]: tests/
|
## License
|
||||||
|
|
||||||
|
Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Holllo/migration-helper/src/branch/main/LICENSE) for more information.
|
||||||
|
|
|
@ -0,0 +1,59 @@
|
||||||
|
{
|
||||||
|
"nodes": {
|
||||||
|
"flake-utils": {
|
||||||
|
"inputs": {
|
||||||
|
"systems": "systems"
|
||||||
|
},
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1705309234,
|
||||||
|
"narHash": "sha256-uNRRNRKmJyCRC/8y1RqBkqWBLM034y4qN7EprSdmgyA=",
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"rev": "1ef2e671c3b0c19053962c07dbda38332dcebf26",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"nixpkgs": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1705975988,
|
||||||
|
"narHash": "sha256-HJS/ilLkwLaFe+kPciiVuEwa90p7d7Y2FUZXuq7ztVk=",
|
||||||
|
"owner": "NixOS",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"rev": "4d3d04cfd372a0511f12b885c9822e406b00fe8e",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"id": "nixpkgs",
|
||||||
|
"type": "indirect"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": {
|
||||||
|
"inputs": {
|
||||||
|
"flake-utils": "flake-utils",
|
||||||
|
"nixpkgs": "nixpkgs"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"systems": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1681028828,
|
||||||
|
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
|
||||||
|
"owner": "nix-systems",
|
||||||
|
"repo": "default",
|
||||||
|
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "nix-systems",
|
||||||
|
"repo": "default",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": "root",
|
||||||
|
"version": 7
|
||||||
|
}
|
|
@ -0,0 +1,13 @@
|
||||||
|
{
|
||||||
|
inputs.flake-utils.url = "github:numtide/flake-utils";
|
||||||
|
|
||||||
|
outputs = { self, nixpkgs, flake-utils }:
|
||||||
|
flake-utils.lib.eachDefaultSystem (system:
|
||||||
|
let
|
||||||
|
pkgs = nixpkgs.legacyPackages.${system};
|
||||||
|
in
|
||||||
|
{
|
||||||
|
devShells.default = import ./shell.nix { inherit pkgs; };
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
58
package.json
58
package.json
|
@ -1,21 +1,22 @@
|
||||||
{
|
{
|
||||||
"name": "migration-helper",
|
"name": "@holllo/migration-helper",
|
||||||
"description": "A tiny helper library for migrating data.",
|
"description": "Tiny helper library for migrating data.",
|
||||||
"license": "GPL-3.0-or-later",
|
"license": "AGPL-3.0-or-later",
|
||||||
"version": "0.1.0",
|
"version": "0.1.4",
|
||||||
"author": "Holllo <helllo@holllo.cc>",
|
"author": "Holllo <helllo@holllo.org>",
|
||||||
"repository": "https://github.com/Holllo/migration-helper",
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://git.bauke.xyz/Holllo/migration-helper"
|
||||||
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc",
|
"prepublishOnly": "makers build"
|
||||||
"prepublishOnly": "pnpm test && pnpm build",
|
|
||||||
"test": "xo && c8 ava && tsc --noEmit"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"ava": "^4.0.1",
|
"@holllo/test": "^0.2.1",
|
||||||
"c8": "^7.11.0",
|
"trash-cli": "^5.0.0",
|
||||||
"ts-node": "^10.6.0",
|
"tsx": "^4.7.0",
|
||||||
"typescript": "^4.6.2",
|
"typescript": "^5.3.3",
|
||||||
"xo": "^0.48.0"
|
"xo": "^0.56.0"
|
||||||
},
|
},
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "build/source/migration-helper.js",
|
"main": "build/source/migration-helper.js",
|
||||||
|
@ -26,33 +27,12 @@
|
||||||
"LICENSE",
|
"LICENSE",
|
||||||
"README.md"
|
"README.md"
|
||||||
],
|
],
|
||||||
"ava": {
|
|
||||||
"extensions": {
|
|
||||||
"ts": "module"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"tests/**/*.ts"
|
|
||||||
],
|
|
||||||
"nodeArguments": [
|
|
||||||
"--loader=ts-node/esm",
|
|
||||||
"--no-warnings"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"c8": {
|
|
||||||
"100": true,
|
|
||||||
"all": true,
|
|
||||||
"include": [
|
|
||||||
"source",
|
|
||||||
"tests"
|
|
||||||
],
|
|
||||||
"reportDir": "coverage",
|
|
||||||
"reporter": [
|
|
||||||
"text",
|
|
||||||
"html"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"xo": {
|
"xo": {
|
||||||
"prettier": true,
|
"prettier": true,
|
||||||
|
"rules": {
|
||||||
|
"@typescript-eslint/consistent-type-imports": "off",
|
||||||
|
"no-await-in-loop": "off"
|
||||||
|
},
|
||||||
"space": true
|
"space": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
3697
pnpm-lock.yaml
3697
pnpm-lock.yaml
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,7 @@
|
||||||
|
{ pkgs ? import <nixpkgs> { } }:
|
||||||
|
|
||||||
|
with pkgs;
|
||||||
|
|
||||||
|
mkShell rec {
|
||||||
|
packages = [ cargo-make nodejs nodePackages.pnpm ];
|
||||||
|
}
|
|
@ -7,9 +7,9 @@
|
||||||
* The migrate function should take the data you pass through {@link migrate}
|
* The migrate function should take the data you pass through {@link migrate}
|
||||||
* and modify it to your needs.
|
* and modify it to your needs.
|
||||||
*/
|
*/
|
||||||
export type Migration<V> = {
|
export type Migration<V, A = any, B = any> = {
|
||||||
version: V;
|
version: V;
|
||||||
migrate: (data: any) => Promise<unknown>;
|
migrate: (data: A) => Promise<B>;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -19,7 +19,7 @@ export type Migration<V> = {
|
||||||
* tested, while the second argument will be the version passed into
|
* tested, while the second argument will be the version passed into
|
||||||
* {@link migrate}.
|
* {@link migrate}.
|
||||||
*
|
*
|
||||||
* If left undefined, `a < b` will be used. This works for {@link Date dates},
|
* If left undefined, `a <= b` will be used. This works for {@link Date dates},
|
||||||
* {@link Number numbers} and {@link String strings}. So if you want to use a
|
* {@link Number numbers} and {@link String strings}. So if you want to use a
|
||||||
* different type for versioning you should create your own function.
|
* different type for versioning you should create your own function.
|
||||||
*/
|
*/
|
||||||
|
@ -35,7 +35,7 @@ export async function migrate<V>(
|
||||||
data: unknown,
|
data: unknown,
|
||||||
version: V,
|
version: V,
|
||||||
migrations: Array<Migration<V>>,
|
migrations: Array<Migration<V>>,
|
||||||
skip: SkipMigrationFn<V> = (a, b) => a < b,
|
skip: SkipMigrationFn<V> = (a, b) => a <= b,
|
||||||
): Promise<unknown> {
|
): Promise<unknown> {
|
||||||
let migratedData = data;
|
let migratedData = data;
|
||||||
|
|
||||||
|
@ -44,7 +44,7 @@ export async function migrate<V>(
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
migratedData = migration.migrate(migratedData);
|
migratedData = await migration.migrate(migratedData);
|
||||||
}
|
}
|
||||||
|
|
||||||
return migratedData;
|
return migratedData;
|
||||||
|
|
|
@ -1,22 +0,0 @@
|
||||||
import test from 'ava';
|
|
||||||
|
|
||||||
import {migrate, Migration} from '../source/migration-helper.js';
|
|
||||||
|
|
||||||
test('migrate<Date>', async (t) => {
|
|
||||||
const migrations: Array<Migration<Date>> = [
|
|
||||||
{
|
|
||||||
version: new Date('2022-01-01'),
|
|
||||||
migrate: async (data: string) => `${data} migrated`,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
function offsetDate(offset: number): Date {
|
|
||||||
const d = new Date(migrations[0].version);
|
|
||||||
d.setDate(d.getDate() + offset);
|
|
||||||
return d;
|
|
||||||
}
|
|
||||||
|
|
||||||
const data = 'data';
|
|
||||||
t.is(await migrate(data, offsetDate(-1), migrations), 'data migrated');
|
|
||||||
t.is(await migrate(data, offsetDate(1), migrations), data);
|
|
||||||
});
|
|
|
@ -0,0 +1,77 @@
|
||||||
|
import {setup} from '@holllo/test';
|
||||||
|
import {
|
||||||
|
migrate,
|
||||||
|
Migration,
|
||||||
|
SkipMigrationFn,
|
||||||
|
} from '../source/migration-helper.js';
|
||||||
|
|
||||||
|
await setup('migrate<T>', async (group) => {
|
||||||
|
group.test('T = Date', async (test) => {
|
||||||
|
const migrations: Array<Migration<Date, string, string>> = [
|
||||||
|
{
|
||||||
|
version: new Date('2022-01-01'),
|
||||||
|
migrate: async (data: string) => `${data} migrated`,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
function offsetDate(offset: number): Date {
|
||||||
|
const d = new Date(migrations[0].version);
|
||||||
|
d.setDate(d.getDate() + offset);
|
||||||
|
return d;
|
||||||
|
}
|
||||||
|
|
||||||
|
const data = 'data';
|
||||||
|
test.equals(
|
||||||
|
await migrate(data, offsetDate(-1), migrations),
|
||||||
|
'data migrated',
|
||||||
|
);
|
||||||
|
test.equals(await migrate(data, offsetDate(1), migrations), data);
|
||||||
|
});
|
||||||
|
|
||||||
|
group.test('T = number', async (test) => {
|
||||||
|
const migrations: Array<Migration<number, string, string>> = [
|
||||||
|
{
|
||||||
|
version: 5,
|
||||||
|
migrate: async (data: string) => `${data} migrated`,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const data = 'data';
|
||||||
|
test.equals(await migrate(data, 4, migrations), 'data migrated');
|
||||||
|
test.equals(await migrate(data, 6, migrations), data);
|
||||||
|
});
|
||||||
|
|
||||||
|
group.test('T = {custom: number}', async (test) => {
|
||||||
|
type Custom = {
|
||||||
|
custom: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
const skip: SkipMigrationFn<Custom> = (a, b) => a.custom > b.custom;
|
||||||
|
const migrations: Array<Migration<Custom, string, string>> = [
|
||||||
|
{
|
||||||
|
version: {custom: 5},
|
||||||
|
migrate: async (data: string) => `${data} migrated`,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const data = 'data';
|
||||||
|
test.equals(await migrate(data, {custom: 4}, migrations, skip), data);
|
||||||
|
test.equals(
|
||||||
|
await migrate(data, {custom: 6}, migrations, skip),
|
||||||
|
'data migrated',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
group.test('T = string', async (test) => {
|
||||||
|
const migrations: Array<Migration<string, string, string>> = [
|
||||||
|
{
|
||||||
|
version: '0.2.4',
|
||||||
|
migrate: async (data: string) => `${data} migrated`,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const data = 'data';
|
||||||
|
test.equals(await migrate(data, '0.2.3', migrations), 'data migrated');
|
||||||
|
test.equals(await migrate(data, '0.2.5', migrations), data);
|
||||||
|
});
|
||||||
|
});
|
|
@ -1,16 +0,0 @@
|
||||||
import test from 'ava';
|
|
||||||
|
|
||||||
import {migrate, Migration} from '../source/migration-helper.js';
|
|
||||||
|
|
||||||
test('migrate<number>', async (t) => {
|
|
||||||
const migrations: Array<Migration<number>> = [
|
|
||||||
{
|
|
||||||
version: 5,
|
|
||||||
migrate: async (data: string) => `${data} migrated`,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
const data = 'data';
|
|
||||||
t.is(await migrate(data, 4, migrations), 'data migrated');
|
|
||||||
t.is(await migrate(data, 6, migrations), data);
|
|
||||||
});
|
|
|
@ -1,25 +0,0 @@
|
||||||
import test from 'ava';
|
|
||||||
|
|
||||||
import {
|
|
||||||
migrate,
|
|
||||||
Migration,
|
|
||||||
SkipMigrationFn,
|
|
||||||
} from '../source/migration-helper.js';
|
|
||||||
|
|
||||||
test('migrate<{custom: number}>', async (t) => {
|
|
||||||
type Custom = {
|
|
||||||
custom: number;
|
|
||||||
};
|
|
||||||
|
|
||||||
const skip: SkipMigrationFn<Custom> = (a, b) => a.custom > b.custom;
|
|
||||||
const migrations: Array<Migration<Custom>> = [
|
|
||||||
{
|
|
||||||
version: {custom: 5},
|
|
||||||
migrate: async (data: string) => `${data} migrated`,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
const data = 'data';
|
|
||||||
t.is(await migrate(data, {custom: 4}, migrations, skip), data);
|
|
||||||
t.is(await migrate(data, {custom: 6}, migrations, skip), 'data migrated');
|
|
||||||
});
|
|
|
@ -1,16 +0,0 @@
|
||||||
import test from 'ava';
|
|
||||||
|
|
||||||
import {migrate, Migration} from '../source/migration-helper.js';
|
|
||||||
|
|
||||||
test('migrate<string>', async (t) => {
|
|
||||||
const migrations: Array<Migration<string>> = [
|
|
||||||
{
|
|
||||||
version: '0.2.4',
|
|
||||||
migrate: async (data: string) => `${data} migrated`,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
const data = 'data';
|
|
||||||
t.is(await migrate(data, '0.2.3', migrations), 'data migrated');
|
|
||||||
t.is(await migrate(data, '0.2.5', migrations), data);
|
|
||||||
});
|
|
Loading…
Reference in New Issue