Initial addition of UmzeptionContext

README.md

@@ -41,9 +41,11 @@ const umzeptionSetup = umzeption({
 import { Sequelize } from 'sequelize';
 import { Umzug, SequelizeStorage } from 'umzug';
 
+// TODO: add example for how to create umzeptionContexts
+
 const umzug = new Umzug({
   migrations: umzeptionSetup,
-  context: sequelize.getQueryInterface(),
+  context: umzeptionContext,
   storage: new SequelizeStorage({ sequelize }),
   logger: console,
 });

index.d.ts

@@ -1,8 +1,15 @@
 export type {
   UmzeptionDependency,
   UmzeptionLookupOptions,
+  AnyUmzeptionContext,
+  DefineUmzeptionContexts,
+  UmzeptionContext,
 } from './lib/advanced-types.d.ts';
 
+export {
+  createUmzeptionContext,
+} from './lib/context.js';
+
 export {
   umzeption,
 } from './lib/main.js';

index.js

@@ -1,3 +1,7 @@
+export {
+  createUmzeptionContext,
+} from './lib/context.js';
+
 export {
   umzeption,
 } from './lib/main.js';

lib/advanced-types.d.ts

@@ -1,27 +1,58 @@
 import type { PluginDefinition } from 'plugin-importer';
 
 // What a dependency should provide
-export interface UmzeptionDependency<T = unknown> extends PluginDefinition {
+export interface UmzeptionDependency<T extends AnyUmzeptionContext = AnyUmzeptionContext> extends PluginDefinition {
   glob: string[]
   installSchema: import('umzug').MigrationFn<T>
 }
 
 // The fully resolved internal definition
-export interface UmzeptionDefinition<T = unknown> extends UmzeptionDependency<T> {
+export interface UmzeptionDefinition<T extends AnyUmzeptionContext = AnyUmzeptionContext> extends UmzeptionDependency<T> {
   name: string
   pluginDir: string
 }
 
-export interface UmzeptionLookupOptions<T> extends PartialKeys<
-  Omit<UmzeptionDependency<T>, 'pluginDir'>,
-  'glob' | 'installSchema'
-> {
+export interface UmzeptionLookupOptions<T extends AnyUmzeptionContext> extends
+  PartialKeys<
+    Omit<UmzeptionDependency<T>, 'pluginDir'>,
+    'glob' | 'installSchema'
+  >
+{
   cwd?: string|undefined
   install?: boolean
   meta?: ImportMeta
   noop?: boolean
 }
 
+// *** Context definitions ***
+
+export interface DefineUmzeptionContexts {
+  unknown: UmzeptionContext<'unknown'>,
+}
+
+type ValidUmzeptionContexts = {
+  [key in keyof DefineUmzeptionContexts as (
+    DefineUmzeptionContexts[key] extends BaseUmzeptionContext
+      ? Equal<key, DefineUmzeptionContexts[key]["type"]>
+      : never
+  )]: string extends key ? never : DefineUmzeptionContexts[key]
+}
+
+export type AnyUmzeptionContext = ValidUmzeptionContexts[keyof ValidUmzeptionContexts];
+export type UmzeptionContextTypes = AnyUmzeptionContext["type"];
+
+interface BaseUmzeptionContext {
+  type: string
+  value: unknown
+}
+
+export interface UmzeptionContext<T extends UmzeptionContextTypes, V = unknown> extends BaseUmzeptionContext {
+  type: string extends T ? never : (T extends string ? T : never);
+  value: V
+}
+
 // *** Helpers ***
 
 type PartialKeys<T, Keys extends keyof T> = Omit<T, Keys> & Partial<Pick<T, Keys>>;
+type StringLiteral<T> = string extends T ? never : T;
+type Equal<A, B> = A extends B ? A : never;

lib/context.js

@@ -0,0 +1,10 @@
+/**
+ * @template {import("./advanced-types.js").UmzeptionContextTypes} T
+ * @template {import("./advanced-types.js").DefineUmzeptionContexts[T]["value"]} V
+ * @param {T} type
+ * @param {V} value
+ * @returns {import("./advanced-types.js").UmzeptionContext<T, V>}
+ */
+export function createUmzeptionContext (type, value) {
+  return /** @type {import("./advanced-types.js").UmzeptionContext<T, V>} */ ({ type, value });
+}

lib/definition.js

@@ -42,7 +42,7 @@ export function ensureUmzeptionDefinition (value) {
   }
 
   // Ensure that we have an async method here
-  /** @type {import('umzug').MigrationFn<unknown>} */
+  /** @type {import('umzug').MigrationFn<import('./advanced-types.d.ts').AnyUmzeptionContext>} */
   const asyncInstallSchema = async (...args) => installSchema.call(value, ...args);
 
   /** @type {import('./advanced-types.d.ts').UmzeptionDefinition} */

lib/dependencies.js

@@ -40,7 +40,7 @@ export function processDependency (value, { normalizedPluginName, pluginDir }) {
 }
 
 /**
- * @template T
+ * @template {import('./advanced-types.d.ts').AnyUmzeptionContext} T
  * @param {string[]} dependencies
  * @param {import('plugin-importer').LoadPluginsOptions} [options]
  * @returns {Promise<import('./advanced-types.d.ts').UmzeptionDefinition<T>[]>}

lib/lookup.js

@@ -5,7 +5,7 @@ import { loadDependencies } from './dependencies.js';
 import { resolveMigrations } from './resolve-migrations.js';
 
 /**
- * @template T
+ * @template {import('./advanced-types.d.ts').AnyUmzeptionContext} T
  * @param {import('./advanced-types.d.ts').UmzeptionLookupOptions<T>} options
  * @param {T} context
  * @returns {Promise<Array<import('umzug').RunnableMigration<T>>>}

lib/main.js

@@ -1,7 +1,7 @@
 import { umzeptionLookup } from './lookup.js';
 
 /**
- * @template T
+ * @template {import('./advanced-types.d.ts').AnyUmzeptionContext} T
  * @param {import('./advanced-types.d.ts').UmzeptionLookupOptions<T>} config
  * @returns {(context: T) => Promise<import('umzug').InputMigrations<T>>}
  */

lib/resolve-migrations.js

@@ -4,7 +4,7 @@ import { globby } from 'globby';
 import { importAbsolutePath } from 'plugin-importer';
 
 /**
- * @template T
+ * @template {import('./advanced-types.d.ts').AnyUmzeptionContext} T
  * @param {Pick<import('./advanced-types.d.ts').UmzeptionDefinition<T>, 'glob' | 'name' | 'pluginDir'>} definition
  * @param {T} _context
  * @param {boolean} [noop] - if set then the up/down migrations will have no operation

test/complex-integration.spec.js

@@ -5,7 +5,7 @@ import sinon from 'sinon';
 
 import { Umzug, memoryStorage } from 'umzug';
 
-import { umzeption } from '../index.js';
+import { createUmzeptionContext, umzeption } from '../index.js';
 
 import { down as downMain, up as upMain } from './fixtures/migrations/foo-01.js';
 
@@ -46,7 +46,7 @@ describe('Complex Integration', () => {
   });
 
   it('should run full dependency tree without running anything twice', async () => {
-    const context = {};
+    const context = createUmzeptionContext('unknown', 'test');
     const storage = memoryStorage();
 
     const expectedCallCount = getDependencyStubCallCount({ up: 1 });

test/fixtures/test-dependency-3/index.js

@@ -1,6 +1,6 @@
 import sinon from 'sinon';
 
-/** @satisfies {import('../../../index.js').UmzeptionDependency<unknown>} */
+/** @satisfies {import('../../../index.js').UmzeptionDependency} */
 export const umzeptionConfig = {
   glob: ['migrations/*.js'],
 

test/integration.spec.js

@@ -5,7 +5,7 @@ import sinon from 'sinon';
 
 import { Umzug, memoryStorage } from 'umzug';
 
-import { umzeption } from '../index.js';
+import { createUmzeptionContext, umzeption } from '../index.js';
 
 import { down as downMain, up as upMain } from './fixtures/migrations/foo-01.js';
 import { installSchema as installSchemaTestDependency } from './fixtures/test-dependency/index.js';
@@ -31,7 +31,8 @@ describe('Integration', () => {
   });
 
   it('should resolve dependencies and create proper migrations', async () => {
-    const context = {};
+    const context = createUmzeptionContext('unknown', 'test');
+
     const storage = memoryStorage();
 
     const expectedCallCount = getDependencyStubCallCount({ up: 1 });
@@ -66,7 +67,8 @@ describe('Integration', () => {
   });
 
   it('should support noop registering all migrations', async () => {
-    const context = {};
+    const context = createUmzeptionContext('unknown', 'test');
+
     const storage = memoryStorage();
 
     const expectedCallCount = getDependencyStubCallCount();
@@ -102,7 +104,8 @@ describe('Integration', () => {
   });
 
   it('should support install mode', async () => {
-    const context = {};
+    const context = createUmzeptionContext('unknown', 'test');
+
     const storage = memoryStorage();
 
     const expectedCallCount = getDependencyStubCallCount({ installSchema: 1 });
@@ -143,7 +146,8 @@ describe('Integration', () => {
   });
 
   it('should work without specifying top level installSchema', async () => {
-    const context = {};
+    const context = createUmzeptionContext('unknown', 'test');
+
     const storage = memoryStorage();
 
     const expectedCallCount = getDependencyStubCallCount({ installSchema: 1 });