Update to V3 of umzug does not appear to have compatible @types/umzug

[redevill]

Update to V3 of umzug does not appear to have compatible @types/umzug

[mmkal]

The external typings should not be used with v3. Just remove the dependency.

[redevill]

Just tried what you suggested:
This is the code import statement and below are the compilation errors.

import { Migration, Umzug, UpDownMigrationsOptions } from 'umzug';

---

Building Node Server
server/db/dbMgmt/ormFactory.ts:3:10 - error TS2724: '"umzug"' has no exported member named 'Migration'. Did you mean 'MigrationFn'?

3 import { Migration, Umzug, UpDownMigrationsOptions } from 'umzug';
~~~~~~~~~

server/db/dbMgmt/ormFactory.ts:3:28 - error TS2305: Module '"umzug"' has no exported member 'UpDownMigrationsOptions'.

3 import { Migration, Umzug, UpDownMigrationsOptions } from 'umzug';
~~~~~~~~~~~~~~~~~~~~~~~

server/services/db-admin.handlers.ts:5:10 - error TS2305: Module '"umzug"' has no exported member 'UpDownMigrationsOptions'.

5 import { UpDownMigrationsOptions } from 'umzug';
~~~~~~~~~~~~~~~~~~~~~~~

[redevill]

FYI - did use the npm ci option to ensure a rebuild of the node modules. Also tried several other V3 tags - V3.2.1 , V3.0.0 and the first beta... all give the same errors.

[mmkal]

See the error: Module '"umzug"' has no exported member 'UpDownMigrationsOptions'.. This is not an export of v3. I believe it also wasn't an official export of v2 - the types were originally maintained separately - so it's not documented in the migration guide. But, have a look at the readme to make sure you understand the differences between 2 and 3. If you'd like to add a note to the readme a PR would be welcome.

[redevill]

Not sure I understand - A primary public function in umzug V2 & V3 - is the method "up" as defined below:
up(options?: UpToOptions | UpDownMigrationsOptions): Promise<Migration[]>;

How am I to create a strongly typed options object "UpDownMigrationsOptions" to pass to the publicly defined method "up" if it is not exported?

Or is the intent of the library to remove the ability to supply options to the "up" method?

[mmkal]

(Edited - sorry, I originally submitted partial message)

A primary public function in umzug V2 & V3 - is the method "up" as defined below:
up(options?: UpToOptions | UpDownMigrationsOptions): Promise<Migration[]>;

No it isn't:

umzug/src/umzug.ts

Line 220 in 10ef28d

async up(options: MigrateUpOptions = {}): Promise<MigrationMeta[]> {

Unless I'm misunderstanding you? Where in V3 did you find that code?

[redevill]

Apologies - in the upgrade process, the old typings were not removed - causing my confusion.