forge-sql-orm 2.0.12 → 2.0.14

package/README.md

@@ -81,7 +81,7 @@ Forge-SQL-ORM is designed to work with @forge/sql and requires some additional s
 
 ```sh
 npm install forge-sql-orm @forge/sql drizzle-orm momment -S
-npm install mysql2 drizzle-kit inquirer@8.0.0  -D
+npm install forge-sql-orm-cli  -D
 ```
 
 This will:
@@ -89,6 +89,7 @@ This will:
 - Install @forge/sql, the Forge database layer
 - Install Drizzle ORM and its MySQL driver
 - Install TypeScript types for MySQL
+- Install forge-sql-orm-cli A command-line interface tool for managing Atlassian Forge SQL migrations and model generation with Drizzle ORM integration.
 
 ## Direct Drizzle Usage with Custom Driver
 
@@ -127,7 +128,7 @@ This approach gives you direct access to all Drizzle ORM features while still us
 1. **Generate initial schema from an existing database**
 
    ```sh
-   npx forge-sql-orm generate:model --dbName testDb --output ./database/schema
+   npx forge-sql-orm-cli generate:model --dbName testDb --output ./database/schema
    ```
 
    _(This is done only once when setting up the project)_
@@ -135,7 +136,7 @@ This approach gives you direct access to all Drizzle ORM features while still us
 2. **Create the first migration**
 
    ```sh
-   npx forge-sql-orm migrations:create --dbName testDb --entitiesPath ./database/schema --output ./database/migration
+   npx forge-sql-orm-cli migrations:create --dbName testDb --entitiesPath ./database/schema --output ./database/migration
    ```
 
    _(This initializes the database migration structure, also done once)_
@@ -152,7 +153,7 @@ This approach gives you direct access to all Drizzle ORM features while still us
 5. **Update the migration**
 
    ```sh
-   npx forge-sql-orm migrations:update --dbName testDb --entitiesPath ./database/schema --output ./database/migration
+   npx forge-sql-orm-cli migrations:update --dbName testDb --entitiesPath ./database/schema --output ./database/migration
    ```
 
    - ⚠️ **Do NOT update schema before this step!**
@@ -165,7 +166,7 @@ This approach gives you direct access to all Drizzle ORM features while still us
 7. **Update the schema**
 
    ```sh
-   npx forge-sql-orm generate:model --dbName testDb --output ./database/schema
+   npx forge-sql-orm-cli generate:model --dbName testDb --output ./database/schema
    ```
 
 8. **Repeat steps 4-7 as needed**
@@ -194,12 +195,12 @@ Before using Drop Migrations, ensure that:
 
 1. First, ensure your local schema matches the deployed database:
    ```bash
-   npx forge-sql-orm generate:model --output ./database/schema
+   npx forge-sql-orm-cli generate:model --output ./database/schema
    ```
 
 2. Generate the drop migration:
    ```bash
-   npx forge-sql-orm migrations:drop --entitiesPath ./database/schema --output ./database/migration
+   npx forge-sql-orm-cli migrations:drop --entitiesPath ./database/schema --output ./database/migration
    ```
 
 3. Deploy and run the migration in your Forge app:
@@ -214,7 +215,7 @@ Before using Drop Migrations, ensure that:
 
 4. After dropping all tables, you can create a new migration to recreate the schema:
    ```bash
-   npx forge-sql-orm migrations:create --entitiesPath ./database/schema --output ./database/migration --force
+   npx forge-sql-orm-cli migrations:create --entitiesPath ./database/schema --output ./database/migration --force
    ```
    The `--force` parameter is required here because we're creating a new migration after dropping all tables.
 
@@ -535,22 +536,7 @@ The `ForgeSqlOrmOptions` object allows customization of ORM behavior:
 
 ## CLI Commands
 
-```sh
-$ npx forge-sql-orm --help
-
-Usage: forge-sql-orm [options] [command]
-
-Options:
-  -V, --version                Output the version number
-  -h, --help                   Display help for command
-
-Commands:
-  generate:model [options]     Generate Drizzle models from the database
-  migrations:create [options]  Generate an initial migration for the entire database
-  migrations:update [options]  Generate a migration to update the database schema
-  migrations:drop [options]    Generate a migration to drop all tables
-  help [command]               Display help for a specific command
-```
+Documentation [here](forge-sql-orm-cli/README.md)
 
 ## Web Triggers for Migrations
 

package/dist/ForgeSQLORM.js

@@ -2,12 +2,12 @@
 Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
 const drizzleOrm = require("drizzle-orm");
 const moment = require("moment");
-const table = require("drizzle-orm/table");
 const sql = require("drizzle-orm/sql/sql");
 const sql$1 = require("@forge/sql");
 const mysqlProxy = require("drizzle-orm/mysql-proxy");
 const mysqlCore = require("drizzle-orm/mysql-core");
 const moment$1 = require("moment/moment.js");
+const table = require("drizzle-orm/table");
 const parseDateTime = (value, format) => {
   const m = moment(value, format, true);
   if (!m.isValid()) {
@@ -131,12 +131,12 @@ function generateDropTableStatements(tables) {
   dropStatements.push(`DELETE FROM __migrations;`);
   return dropStatements;
 }
-function mapSelectTableToAlias(table2, aliasMap) {
+function mapSelectTableToAlias(table2, uniqPrefix, aliasMap) {
   const { columns, tableName } = getTableMetadata(table2);
   const selectionsTableFields = {};
   Object.keys(columns).forEach((name) => {
     const column = columns[name];
-    const uniqName = `a_${tableName}_${column.name}`;
+    const uniqName = `a_${uniqPrefix}_${tableName}_${column.name}`.toLowerCase();
     const fieldAlias = drizzleOrm.sql.raw(uniqName);
     selectionsTableFields[name] = drizzleOrm.sql`${column} as \`${fieldAlias}\``;
     aliasMap[uniqName] = column;
@@ -146,13 +146,13 @@ function mapSelectTableToAlias(table2, aliasMap) {
 function isDrizzleColumn(column) {
   return column && typeof column === "object" && "table" in column;
 }
-function mapSelectAllFieldsToAlias(selections, name, fields, aliasMap) {
+function mapSelectAllFieldsToAlias(selections, name, uniqName, fields, aliasMap) {
   if (drizzleOrm.isTable(fields)) {
-    selections[name] = mapSelectTableToAlias(fields, aliasMap);
+    selections[name] = mapSelectTableToAlias(fields, uniqName, aliasMap);
   } else if (isDrizzleColumn(fields)) {
     const column = fields;
-    const uniqName = `a_${table.getTableName(column.table)}_${column.name}`;
-    let aliasName = drizzleOrm.sql.raw(uniqName);
+    const uniqAliasName = `a_${uniqName}_${column.name}`.toLowerCase();
+    let aliasName = drizzleOrm.sql.raw(uniqAliasName);
     selections[name] = drizzleOrm.sql`${column} as \`${aliasName}\``;
     aliasMap[uniqName] = column;
   } else if (sql.isSQLWrapper(fields)) {
@@ -160,7 +160,7 @@ function mapSelectAllFieldsToAlias(selections, name, fields, aliasMap) {
   } else {
     const innerSelections = {};
     Object.entries(fields).forEach(([iname, ifields]) => {
-      mapSelectAllFieldsToAlias(innerSelections, iname, ifields, aliasMap);
+      mapSelectAllFieldsToAlias(innerSelections, iname, `${uniqName}_${iname}`, ifields, aliasMap);
     });
     selections[name] = innerSelections;
   }
@@ -173,7 +173,7 @@ function mapSelectFieldsWithAlias(fields) {
   const aliasMap = {};
   const selections = {};
   Object.entries(fields).forEach(([name, fields2]) => {
-    mapSelectAllFieldsToAlias(selections, name, fields2, aliasMap);
+    mapSelectAllFieldsToAlias(selections, name, name, fields2, aliasMap);
   });
   return { selections, aliasMap };
 }
@@ -218,7 +218,11 @@ function transformObject(obj, selections, aliasMap) {
     if (alias && aliasMap[alias]) {
       result[key] = transformValue(value, alias, aliasMap);
     } else if (selection && typeof selection === "object" && !sql.isSQLWrapper(selection)) {
-      result[key] = transformObject(value, selection, aliasMap);
+      result[key] = transformObject(
+        value,
+        selection,
+        aliasMap
+      );
     } else {
       result[key] = value;
     }
@@ -227,9 +231,38 @@ function transformObject(obj, selections, aliasMap) {
 }
 function applyFromDriverTransform(rows, selections, aliasMap) {
   return rows.map((row) => {
-    return transformObject(row, selections, aliasMap);
+    const transformed = transformObject(
+      row,
+      selections,
+      aliasMap
+    );
+    return processNullBranches(transformed);
   });
 }
+function processNullBranches(obj) {
+  if (obj === null || typeof obj !== "object" || obj === void 0) {
+    return obj;
+  }
+  const result = {};
+  let allNull = true;
+  for (const [key, value] of Object.entries(obj)) {
+    if (value === null || value === void 0) {
+      result[key] = null;
+      continue;
+    }
+    if (typeof value === "object" && (value !== null || value !== void 0)) {
+      const processed = processNullBranches(value);
+      result[key] = processed;
+      if (processed !== null) {
+        allNull = false;
+      }
+    } else {
+      result[key] = value;
+      allNull = false;
+    }
+  }
+  return allNull ? null : result;
+}
 class ForgeSQLCrudOperations {
   forgeOperations;
   options;
@@ -620,13 +653,10 @@ function createAliasedSelectBuilder(db, fields, selectFn) {
           };
         }
         if (prop === "then") {
-          return (onfulfilled, onrejected) => target.execute().then(
-            (rows) => {
-              const transformed = applyFromDriverTransform(rows, selections, aliasMap);
-              return onfulfilled?.(transformed);
-            },
-            onrejected
-          );
+          return (onfulfilled, onrejected) => target.execute().then((rows) => {
+            const transformed = applyFromDriverTransform(rows, selections, aliasMap);
+            return onfulfilled?.(transformed);
+          }, onrejected);
         }
         const value = Reflect.get(target, prop, receiver);
         if (typeof value === "function") {
@@ -671,7 +701,9 @@ class ForgeSQLORMImpl {
       if (newOptions.logRawSqlQuery) {
         console.debug("Initializing ForgeSQLORM...");
       }
-      this.drizzle = patchDbWithSelectAliased(mysqlProxy.drizzle(forgeDriver, { logger: newOptions.logRawSqlQuery }));
+      this.drizzle = patchDbWithSelectAliased(
+        mysqlProxy.drizzle(forgeDriver, { logger: newOptions.logRawSqlQuery })
+      );
       this.crudOperations = new ForgeSQLCrudOperations(this, newOptions);
       this.fetchOperations = new ForgeSQLSelectOperations(newOptions);
     } catch (error) {