declapract-typescript-ehmpathy 0.31.7 → 0.31.9

package/dist/practices/package-json-order/best-practice/package.json.declapract.ts

@@ -32,7 +32,8 @@ export const desiredRelativeKeyOrder = {
     'fix',
     'generate:schema',
     'generate:types-from-sql',
-    'generate:dao',
+    'generate:dao:dynamodb',
+    'generate:dao:postgres',
     'build:artifact',
     'build:clean',
     'build:compile',

package/dist/practices/persist-with-rds/bad-practices/with-connection-in-input/.declapract.readme.md

@@ -0,0 +1 @@
+withDatabaseConnection -> withDatabaseContext, per procedure-fns pattern

package/dist/practices/persist-with-rds/bad-practices/with-connection-in-input/src/utils/database/withDatabaseConnection.ts

@@ -0,0 +1,3 @@
+import { FileCheckType } from 'declapract';
+
+export const check = FileCheckType.EXISTS; // if a file exists with this path pattern, then it's bad practice

package/dist/practices/persist-with-rds/best-practice/package.json

@@ -5,14 +5,14 @@
   },
   "devDependencies": {
     "sql-code-generator": "@declapract{check.minVersion('0.9.3')}",
-    "sql-dao-generator": "@declapract{check.minVersion('0.3.1')}",
+    "sql-dao-generator": "@declapract{check.minVersion('0.4.0')}",
     "sql-schema-control": "@declapract{check.minVersion('1.5.0')}",
-    "sql-schema-generator": "@declapract{check.minVersion('0.21.4')}",
+    "sql-schema-generator": "@declapract{check.minVersion('0.23.0')}",
     "@types/yesql": "@declapract{check.minVersion('3.2.2')}",
     "@types/pg": "@declapract{check.minVersion('8.6.1')}"
   },
   "scripts": {
-    "generate:dao": "npx sql-dao-generator generate && npm run fix:format",
+    "generate:dao:postgres": "npx sql-dao-generator generate && npm run fix:format",
     "generate:schema": "npx sql-schema-generator generate -c codegen.sql.schema.yml && npm run fix:format",
     "generate:types-from-sql": "npx sql-code-generator generate -c codegen.sql.types.yml && npm run fix:format",
     "provision:docker:clear": "docker rm -f $(docker ps -a -f 'publish=7821' -q) 2>/dev/null || true && echo 'ensured port is available 👍'",

package/dist/practices/persist-with-rds/best-practice/src/utils/database/withDatabaseTransaction.ts

@@ -1,19 +1,20 @@
 import { DatabaseConnection } from './getDatabaseConnection';
 
 export const withDatabaseTransaction = <
-  P extends { dbConnection: DatabaseConnection },
+  P,
+  C extends { dbConnection: DatabaseConnection },
   R,
 >(
-  logic: (args: P) => R | Promise<R>,
+  logic: (input: P, context: C) => R | Promise<R>,
 ): typeof logic => {
-  return (async (args: P) => {
-    await args.dbConnection.query({ sql: 'START TRANSACTION' }); // begin transaction
+  return (async (input: P, context: C) => {
+    await context.dbConnection.query({ sql: 'START TRANSACTION' }); // begin transaction
     try {
-      const result = await logic({ ...args }); // run the request
-      await args.dbConnection.query({ sql: 'COMMIT' }); // commit if successful
+      const result = await logic(input, context); // run the request
+      await context.dbConnection.query({ sql: 'COMMIT' }); // commit if successful
       return result;
     } catch (error) {
-      await args.dbConnection.query({ sql: 'ROLLBACK' }); // rollback if not successful
+      await context.dbConnection.query({ sql: 'ROLLBACK' }); // rollback if not successful
       throw error;
     }
   }) as typeof logic;

package/package.json

@@ -2,7 +2,7 @@
   "name": "declapract-typescript-ehmpathy",
   "author": "ehmpathy",
   "description": "declapract best practices declarations for typescript",
-  "version": "0.31.7",
+  "version": "0.31.9",
   "main": "src/index.js",
   "repository": "ehmpathy/declapract-typescript-ehmpathy",
   "homepage": "https://github.com/ehmpathy/declapract-typescript-ehmpathy",

package/dist/practices/persist-with-rds/best-practice/src/utils/database/withDatabaseConnection.ts

@@ -1,46 +0,0 @@
-import { DropFirst } from 'type-fns';
-
-import {
-  DatabaseConnection,
-  getDatabaseConnection,
-} from './getDatabaseConnection';
-
-/**
- * wraps the function to provide a managed database connection to it, if one was not already passed in
- *
- * note
- * - manages the database connection it gives to the function by opening it and closing it once the function finishes
- * - if a database connection was passed in as part of the arguments, it will instead use that one and will not close it once it finishes (useful for transactions)
- *
- * example usage:
- * ```
- *   const findById = withDatabaseConnection(({ id, dbConnection }: { id: string; dbConnection: DatabaseConnection }) => {
- *     // do logic with dbConnection
- *   });
- *   // ...
- *   await findById({ id: 821 }); // note how we don't have to pass in the dbConnection
- * ```
- */
-export const withDatabaseConnection = <
-  P extends { dbConnection: DatabaseConnection },
-  R,
-  PR, // the rest of the parameters
->(
-  logic: (args0: P, ...argsRest: PR[]) => R | Promise<R>,
-) => {
-  return async (
-    args0: Omit<P, 'dbConnection'> & { dbConnection?: DatabaseConnection },
-    ...argsRest: DropFirst<Parameters<typeof logic>>
-  ) => {
-    // open the db connection, if one was not given
-    const dbConnection = args0.dbConnection ?? (await getDatabaseConnection());
-
-    // try and run the logic with db connection
-    try {
-      return await logic({ ...args0, dbConnection } as P, ...argsRest); // as P because: https://github.com/microsoft/TypeScript/issues/35858
-    } finally {
-      // make sure to close the db connection, both when `logic` throws an error or succeeds
-      if (!args0.dbConnection) await dbConnection.end();
-    }
-  };
-};