BREAKING: New syntax for installSchemaFromString

voxpelli · Aug 17, 2023 · 214405f · 214405f
1 parent a4e9e5e
commit 214405f
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -123,10 +123,10 @@ import { installSchemaFromString } from 'umzeption';
 export const umzeptionConfig = {
   dependencies: ['@yikesable/abc'],
   glob: ['migrations/*.js'],
-  // installSchemaFromString accepts a string or a Promise resolving to a string
-  installSchema: installSchemaFromString(
-    readFile(new URL('create-tables.sql', import.meta.url), 'utf8')
-  ),
+  installSchema: async ({ context }) => {
+    const tables = await readFile(new URL('create-tables.sql', import.meta.url), 'utf8');
+    return installSchemaFromString(context, tables);
+  },
 };
 ```
 

diff --git a/lib/schema-helper.js b/lib/schema-helper.js
@@ -13,11 +13,11 @@ function getTablesFromString (createTablesString) {
 
 /**
  * @param {import('./advanced-types.js').DefineUmzeptionContexts['pg']} context
- * @param {string|Promise<string>} createTablesString
+ * @param {string} createTablesString
  * @returns {Promise<void>}
  */
 export async function pgInstallSchemaFromString (context, createTablesString) {
-  const tables = getTablesFromString(await createTablesString);
+  const tables = getTablesFromString(createTablesString);
 
   await context.value.transact(async client => {
     for (const table of tables) {
@@ -27,17 +27,16 @@ export async function pgInstallSchemaFromString (context, createTablesString) {
 }
 
 /**
- * @param {string|Promise<string>} createTablesString
- * @returns {import('umzug').MigrationFn<import('./advanced-types.js').AnyUmzeptionContext>}
+ * @param {import('./advanced-types.js').AnyUmzeptionContext} context
+ * @param {string} createTablesString
+ * @returns {Promise<void>}
  */
-export function installSchemaFromString (createTablesString) {
-  return async ({ context }) => {
-    switch (context.type) {
-      case 'pg':
-        await pgInstallSchemaFromString(context, createTablesString);
-        break;
-      default:
-        throw new Error(`Unsupported context type: ${context.type}`);
-    }
-  };
+export async function installSchemaFromString (context, createTablesString) {
+  switch (context.type) {
+    case 'pg':
+      await pgInstallSchemaFromString(context, createTablesString);
+      break;
+    default:
+      throw new Error(`Unsupported context type: ${context.type}`);
+  }
 }