@andymic/pigeon 2.0.0 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andymic/pigeon",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "author": "Andreas Michael <ateasm03@gmail.com>",
   "description": "Pigeon is a TypeScript-based tool for generating TypeScript classes and methods from PostgreSQL database schemas.",
   "keywords": [
@@ -35,5 +35,5 @@
     "pg": "^8.16.0",
     "prompt-sync": "^4.2.0"
   },
-  "gitHead": "85641ef9cc7fe7b42c78f7470608793f192b880a"
+  "gitHead": "029bee420b59d84dfb269ec7eb3190aee486de10"
 }

package/src/index.js

@@ -272,19 +272,21 @@ export function runGeneration(dir, db, tables, enums) {
     }
     for (const table of tables) {
         let ts = "";
-        let hasForeign = false;
+        const imports = [];
         for (const column of table.columns) {
             if (column.isForeign && column.foreignColumn && column.foreignTable && column.foreignSchema) {
-                hasForeign = true;
                 if ((table.schema === column.foreignSchema) && (table.name === column.foreignTable))
                     continue;
+                if (imports.includes(column.foreignSchema + "/" + column.foreignTable))
+                    continue;
                 ts += "import {get" + nameBeautifier(column.foreignTable).replaceAll(" ", "") + "} from \".";
                 if (table.schema !== column.foreignSchema)
                     ts += "./" + column.foreignSchema;
                 ts += "/" + column.foreignTable + ".js\";\n";
+                imports.push(column.foreignSchema + "/" + column.foreignTable);
             }
         }
-        if (hasForeign)
+        if (imports.length !== 0)
             ts += "\n";
         ts += "import query from \"./index.js\";\n\n";
         if (enums) {
@@ -326,9 +328,9 @@ export function runGeneration(dir, db, tables, enums) {
             else if ((column.defaultValue !== null && column.defaultValue.includes("nextval")) || (column.isIdentity && column.identityGeneration === "ALWAYS"))
                 autoGenerated.push(column);
         }
-        ts += createAdd(table.schema, table.name, required, optional, autoGenerated, hasForeign);
+        ts += createAdd(table.schema, table.name, required, optional, autoGenerated, imports.length !== 0);
         ts += "\n\n";
-        ts += createUpdate(table.schema, table.name, table.columns, autoGenerated, hasForeign);
+        ts += createUpdate(table.schema, table.name, table.columns, autoGenerated, imports.length !== 0);
         ts += "\n\n";
         ts += createDelete(table.schema, table.name, table.columns);
         fs.writeFileSync(path.join(dir, table.schema, table.name + ".ts"), ts);
@@ -339,7 +341,7 @@ function createIndex(db) {
     text += "import pg from \"pg\";\n";
     text += "const { Client, Pool } = pg;\n";
     text += "\n";
-    text += "const pool = new Pool({\n";
+    text += "export const pool = new Pool({\n";
     text += "\thost: \"" + db.host + "\",\n";
     text += "\tport: " + db.port + ",\n";
     text += "\tdatabase: \"" + db.db + "\",\n";
@@ -350,7 +352,7 @@ function createIndex(db) {
     text += "\tconnectionTimeoutMillis: 2000\n";
     text += "});\n";
     text += "\n";
-    text += "const client = new Client({\n";
+    text += "export const client = new Client({\n";
     text += "\thost: \"" + db.host + "\",\n";
     text += "\tport: " + db.port + ",\n";
     text += "\tdatabase: \"" + db.db + "\",\n";
@@ -358,12 +360,9 @@ function createIndex(db) {
     text += "\tpassword: \"" + db.pass + "\"\n";
     text += "});\n";
     text += "\n";
-    text += "/*\n";
-    text += "export default (sql: string, params: any[]) => pool.query(sql, params);\n";
-    text += "*/\n";
+    text += "const poolQuery = (sql: string, params: any[]) => pool.query(sql, params);\n";
     text += "\n";
-    text += "/*\n";
-    text += "export default async (sql: string, params: any[]) => {\n";
+    text += "const clientQuery = async (sql: string, params: any[]) => {\n";
     text += "\ttry {\n";
     text += "\t\tawait client.connect();\n";
     text += "\t\treturn await client.query(sql, params);\n";
@@ -373,7 +372,10 @@ function createIndex(db) {
     text += "\t\tawait client.end();\n";
     text += "\t}\n";
     text += "}\n";
-    text += "*/";
+    text += "\n";
+    text += "//export default poolQuery;\n";
+    text += "\n";
+    text += "//export default clientQuery;\n";
     return text;
 }
 function createClass(tableName, columns) {
@@ -473,9 +475,10 @@ function createGet(tableSchema, tableName, columns) {
     text += " * @param {Partial<" + className + ">} criteria - An object containing properties of the " + className + " to filter by.\n";
     text += " * Only " + nameBeautifier(tableName).toLowerCase() + " matching all provided criteria will be returned.\n";
     text += " * An empty object or undefined criteria will fetch all " + className + " objects.\n";
+    text += " * @param {Function} [runQuery=query] - The function that executes the database query. This is optional and defaults to the production `query` function. It can be used for transactions when using pools.\n";
     text += " * @returns {Promise<" + className + "[]>} - A Promise object returning an array of " + nameBeautifier(tableName) + " matching the criteria.\n";
     text += " */\n";
-    text += "export async function get" + nameBeautifier(tableName).replaceAll(" ", "") + "(criteria: Partial<" + className + ">): Promise<" + className + "[]> {\n";
+    text += "export async function get" + nameBeautifier(tableName).replaceAll(" ", "") + "(criteria: Partial<" + className + ">, runQuery: Function = query): Promise<" + className + "[]> {\n";
     text += "\tconst whereClauses: string[] = [];\n";
     text += "\tconst values: any[] = [];\n";
     text += "\tlet paramIndex = 1;\n";
@@ -493,7 +496,7 @@ function createGet(tableSchema, tableName, columns) {
     text += "\t\tsql += \" WHERE \" + whereClauses.join(\" AND \");\n";
     text += "\tsql += \";\";\n";
     text += "\n";
-    text += "\tconst " + varName + "Query = await query(sql, values);\n";
+    text += "\tconst " + varName + "Query = await runQuery(sql, values);\n";
     text += arrayMaker(1, varName, className, columns) + "\n";
     text += "\treturn " + varName + ";\n";
     text += "}";
@@ -506,9 +509,9 @@ function createAdd(tableSchema, tableName, required, optional, autoGenerated, ha
     const functionName = "add" + singularize(nameBeautifier(tableName).replaceAll(" ", ""));
     const dataType = "Omit<" + className + ", '" + autoGenerated.concat(optional).map((column) => {
         return column.name;
-    }).join("\' | \'") + "'> & Partial<Pick<" + className + ", '" + optional.map((column) => {
+    }).join("\' | \'") + "'>" + (optional.length > 0 ? " & Partial<Pick<" + className + ", '" + optional.map((column) => {
         return column.name;
-    }).join("\' | \'") + "'>>";
+    }).join("\' | \'") + "'>>" : "");
     const editableColumns = required.concat(optional);
     text += "/**\n";
     text += " * Adds a new " + singularize(nameBeautifier(tableName)) + " object to the database.\n";
@@ -537,6 +540,7 @@ function createAdd(tableSchema, tableName, required, optional, autoGenerated, ha
         text += " * - The field" + (optional.length > 1 ? "s" : "") + " `" + optional.map((column) => {
             return column.name;
         }).join("`, `") + "` " + (optional.length > 1 ? "are" : "is") + " optional.\n";
+    text += " * @param {Function} [runQuery=query] - The function that executes the database query. This is optional and defaults to the production `query` function. It can be used for transactions when using pools.\n";
     text += " * @returns {Promise<" + className + ">} A Promise returning the newly created " + className + " object.\n";
     if (hasForeign) {
         text += " * @throws {Error} An exception in the case of the ";
@@ -547,7 +551,7 @@ function createAdd(tableSchema, tableName, required, optional, autoGenerated, ha
         text += " not existing in their table, or if other pre-insertion validation fails.\n";
     }
     text += " */\n";
-    text += "export async function " + functionName + "( " + paramName + ": " + dataType.replaceAll("'", "\"") + "): Promise<" + className + "> {\n";
+    text += "export async function " + functionName + "(" + paramName + ": " + dataType.replaceAll("'", "\"") + ", runQuery: Function = query): Promise<" + className + "> {\n";
     if (hasForeign) {
         for (const column of editableColumns) {
             if (column.isForeign && column.foreignColumn && column.foreignTable && column.foreignSchema) {
@@ -588,7 +592,7 @@ function createAdd(tableSchema, tableName, required, optional, autoGenerated, ha
     text += "\t\tthrow new Error(\"No data provided for " + paramName + " creation.\");\n";
     text += "\n";
     text += "\tconst sql = \"INSERT INTO " + tableSchema + "." + tableName + " (\" + intoClauses.join(\", \") + \") VALUES (\" + valuesClauses.join(\", \") + \") RETURNING *;\";\n";
-    text += "\tconst insertQuery = await query(sql, values);\n";
+    text += "\tconst insertQuery = await runQuery(sql, values);\n";
     text += "\treturn new " + className + "(\n";
     let columns = editableColumns.concat(autoGenerated);
     columns = [...new Set(columns)];
@@ -606,9 +610,9 @@ function createUpdate(tableSchema, tableName, columns, autoGenerated, hasForeign
     const className = singularize(nameBeautifier(tableName)).replaceAll(" ", "");
     const functionName = "update" + nameBeautifier(tableName).replaceAll(" ", "");
     const criteriaType = "Partial<" + className + ">";
-    const updatesType = "Partial<Omit<" + className + ", '" + autoGenerated.map((column) => {
+    const updatesType = "Partial<" + (autoGenerated.length !== 0 ? "Omit<" + className + ", '" + autoGenerated.map((column) => {
         return column.name;
-    }).join("' | '") + "'>>";
+    }).join("' | '") + "'>" : className) + ">";
     text += "/**\n";
     text += " * Updates existing " + className + " objects in the database based on the specified criteria.\n";
     text += " *\n";
@@ -618,11 +622,12 @@ function createUpdate(tableSchema, tableName, columns, autoGenerated, hasForeign
     text += " * An empty object would typically mean updating ALL " + nameBeautifier(tableName) + ", which should be handled with caution or disallowed.\n";
     text += " * @param {" + updatesType + "} updates - An object containing the new values for the fields to be updated.\n";
     text += " * Only fields present in this object will be updated.\n";
+    text += " * @param {Function} [runQuery=query] - The function that executes the database query. This is optional and defaults to the production `query` function. It can be used for transactions when using pools.\n";
     text += " * @returns {Promise<" + className + "[]>} A promise that resolves to an array of the updated " + className + " objects.\n";
     text += " * Returns an empty array if no records matched the criteria or if no rows were updated.\n";
     text += " * @throws {Error} If updates object is empty" + (hasForeign ? ", or if foreign key checks fail for provided update values" : "") + ".\n";
     text += " */\n";
-    text += "export async function update" + nameBeautifier(tableName).replaceAll(" ", "") + "(criteria: " + criteriaType.replaceAll("'", "\"") + ", updates: " + updatesType.replaceAll("'", "\"") + "): Promise<" + className + "[]> {\n";
+    text += "export async function update" + nameBeautifier(tableName).replaceAll(" ", "") + "(criteria: " + criteriaType.replaceAll("'", "\"") + ", updates: " + updatesType.replaceAll("'", "\"") + ", runQuery: Function = query): Promise<" + className + "[]> {\n";
     text += "\tif (Object.keys(updates).length === 0)\n";
     text += "\t\tthrow new Error(\"No update data provided.\");\n";
     text += "\n";
@@ -672,7 +677,7 @@ function createUpdate(tableSchema, tableName, columns, autoGenerated, hasForeign
     text += "\n";
     text += "\tlet sql = \"UPDATE " + tableSchema + "." + tableName + " SET \" + setClauses.join(\", \") + (whereClauses.length !== 0 ? \" WHERE \" + whereClauses.join(\" AND \") : \"\") + \" RETURNING *;\";\n";
     text += "\n";
-    text += "\tconst updateQuery = await query(sql, values);\n";
+    text += "\tconst updateQuery = await runQuery(sql, values);\n";
     text += arrayMaker(1, "update", className, columns) + "\n";
     text += "\treturn update;\n";
     text += "}";
@@ -690,9 +695,10 @@ function createDelete(tableSchema, tableName, columns) {
     text += " * @param {Partial<" + className + ">} criteria - An object containing properties of the " + className + " to filter by for deletion.\n";
     text += " * An empty object would typically mean deleting ALL " + nameBeautifier(tableName) + ", which should be handled with caution or disallowed.\n";
     text += " * Only accounts matching all provided criteria will be deleted.\n";
+    text += " * @param {Function} [runQuery=query] - The function that executes the database query. This is optional and defaults to the production `query` function. It can be used for transactions when using pools.\n";
     text += " * @returns {Promise<" + className + "[]>} - A Promise object returning the deleted " + nameBeautifier(tableName) + ".\n";
     text += " */\n";
-    text += "export async function " + functionName + "(criteria : Partial<" + className + ">): Promise<" + className + "[]> {\n";
+    text += "export async function " + functionName + "(criteria : Partial<" + className + ">, runQuery: Function = query): Promise<" + className + "[]> {\n";
     text += "\tconst whereClauses: string[] = [];\n";
     text += "\tconst values: any[] = [];\n";
     text += "\tlet paramIndex = 1;\n";
@@ -709,7 +715,7 @@ function createDelete(tableSchema, tableName, columns) {
     text += "\n";
     text += "\tlet sql = \"DELETE FROM " + tableSchema + "." + tableName + "\" + (whereClauses.length !== 0 ? \" WHERE \" + whereClauses.join(\" AND \") : \"\") + \" RETURNING *;\";\n";
     text += "\n";
-    text += "\tconst removeQuery = await query(sql, values);\n";
+    text += "\tconst removeQuery = await runQuery(sql, values);\n";
     text += arrayMaker(1, "remove", className, columns) + "\n";
     text += "\treturn remove;\n";
     text += "}";