@andymic/pigeon 1.3.0 → 1.4.0

package/bin/pigeon.js

@@ -1,8 +1,4 @@
 #!/usr/bin/env node
-/*
- * Copyright (c) 2025 Andreas Michael
- * This software is under the Apache 2.0 License
- */
 import { cli, run } from "../src/cli.js";
 import { PigeonError } from "../src/index.js";
 try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andymic/pigeon",
-  "version": "1.3.0",
+  "version": "1.4.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.15.6",
     "prompt-sync": "^4.2.0"
   },
-  "gitHead": "40d793e0267631471bde05ffddc53ba908e07512"
+  "gitHead": "ec33791a735792a340bfa41c1f66e9a08534ffa6"
 }

package/src/cli.js

@@ -1,12 +1,9 @@
-/*
- * Copyright (c) 2025 Andreas Michael
- * This software is under the Apache 2.0 License
- */
 import meow from "meow";
 import { createConfig } from "./config.js";
-import { Database, deleteDir, guided, PigeonError, queryDB, runGeneration } from "./index.js";
+import { Database, deleteDir, enumsQuery, guided, PigeonError, queryDB, runGeneration } from "./index.js";
 import * as path from "node:path";
 import fs from "node:fs";
+import { getRelationshipsAndTables, tableProcessing } from "./pgAdmin.js";
 export const cli = meow(`
     Usage
       $ pigeon [options]
@@ -17,12 +14,15 @@ export const cli = meow(`
       --force   overwrites already existing files
       --output  [path:String] output directory for the generated files.
       --config  [path:String] path to .pigeon.json config file.
+      --pgAdmin [path:String] path to the pgAdmin ERD file.
+      --offline (only with pgAdmin) does not contact the database
  
     Examples
       $ pigeon --init
       $ pigeon --output C:/Users/User/Documents/Project
       $ pigeon --output ./generatedFiles --force
       $ pigeon --config ./customPigeonConfig.json
+      $ pigeon --pgAdmin C:/Users/User/Documents/Project/ERD.json --offline
       
     Exit Status
       Pigeon returns the following codes:
@@ -57,6 +57,13 @@ export const cli = meow(`
             type: "string",
             default: process.cwd(),
         },
+        pgAdmin: {
+            type: "string",
+        },
+        offline: {
+            type: "boolean",
+            default: false,
+        }
     },
     autoHelp: true,
     autoVersion: true,
@@ -67,6 +74,36 @@ export async function run(flags) {
         return createConfig(flags.cwd);
     if (flags.force)
         deleteDir(flags.output);
+    if (flags.pgAdmin) {
+        let enums;
+        let database;
+        if (!flags.offline) {
+            if (!fs.existsSync(path.join(process.cwd(), ".pigeon.json")))
+                return new PigeonError(1, "", new Error("The configuration file does not exist. Generate one using the \"pigeon --init\" command"));
+            const params = JSON.parse(fs.readFileSync(flags.config).toString());
+            database = new Database(params.host, params.port, params.database, params.username, params.password);
+            enums = await enumsQuery(database);
+        }
+        else {
+            enums = [];
+            database = new Database("localhost", "5432", "database", "username", "password");
+        }
+        if (enums instanceof PigeonError)
+            return enums;
+        if (!fs.existsSync(flags.pgAdmin))
+            return new PigeonError(1, "", new Error("The pgAdmin ERD file specified does not exist."));
+        const file = fs.readFileSync(flags.pgAdmin).toString();
+        let tables;
+        try {
+            tables = getRelationshipsAndTables(file).tables;
+        }
+        catch (e) {
+            return e;
+        }
+        const generationResult = runGeneration(flags.output, database, tableProcessing(tables), enums);
+        if (generationResult instanceof PigeonError)
+            return generationResult;
+    }
     if (flags.guided) {
         const params = guided();
         const database = new Database(params.host, String(params.port), params.db, params.user, params.pass);

package/src/config.js

@@ -1,7 +1,3 @@
-/*
- * Copyright (c) 2025 Andreas Michael
- * This software is under the Apache 2.0 License
- */
 import { PigeonError } from "./index.js";
 import fs from "node:fs";
 import * as path from "node:path";

package/src/index.js

@@ -1,7 +1,3 @@
-/*
- * Copyright (c) 2025 Andreas Michael
- * This software is under the Apache 2.0 License
- */
 import { arrayMaker, consoleMessage, getCombinations, getType, nameBeautifier, queryMaker, runQuery, singularize, sleep, tabsInserter } from "./utils.js";
 import prompt from "prompt-sync";
 import fs from "node:fs";
@@ -30,7 +26,7 @@ export class Database {
         this.pass = pass;
     }
 }
-class Table {
+export class Table {
     table_schema;
     table_name;
     columns = [];
@@ -46,7 +42,7 @@ class Table {
         this.unique = unique;
     }
 }
-class Enum {
+export class Enum {
     name;
     labels;
     constructor(name, labels) {
@@ -54,7 +50,7 @@ class Enum {
         this.labels = labels;
     }
 }
-class ColumnQueryRow {
+export class ColumnQueryRow {
     column_name;
     ordinal_position;
     column_default;
@@ -74,19 +70,21 @@ class ColumnQueryRow {
         this.identity_generation = identity_generation;
     }
 }
-class PrimaryKeyQueryRow {
+export class PrimaryKeyQueryRow {
     column_name;
     constructor(column_name) {
         this.column_name = column_name;
     }
 }
-class ForeignKeyQueryRow {
+export class ForeignKeyQueryRow {
+    local_schema;
     local_table;
     local_column;
     foreign_schema;
     foreign_table;
     foreign_column;
-    constructor(local_table, local_column, foreign_schema, foreign_table, foreign_column) {
+    constructor(local_schema, local_table, local_column, foreign_schema, foreign_table, foreign_column) {
+        this.local_schema = local_schema;
         this.local_table = local_table;
         this.local_column = local_column;
         this.foreign_schema = foreign_schema;
@@ -94,7 +92,7 @@ class ForeignKeyQueryRow {
         this.foreign_column = foreign_column;
     }
 }
-class UniqueQueryRow {
+export class UniqueQueryRow {
     columns;
     constructor(columns) {
         this.columns = columns;
@@ -152,14 +150,7 @@ export function guided() {
     const pass = input("Database Password: ");
     return { host, port, db, user, pass };
 }
-export async function queryDB(db) {
-    const tableQuery = await runQuery(`SELECT table_schema, table_name
-         FROM information_schema.tables
-         WHERE table_type = 'BASE TABLE'
-           AND table_schema NOT IN
-               ('pg_catalog', 'information_schema');`, [], db);
-    if (typeof tableQuery === "undefined")
-        return new PigeonError(1, "", new Error("An SQL error has occurred."));
+export async function enumsQuery(db) {
     const customTypeQuery = await runQuery(`SELECT t.oid, t.typname
          FROM pg_type t
          WHERE (t.typrelid = 0 OR t.typrelid IN (SELECT oid FROM pg_class WHERE relkind = 'c'))
@@ -181,6 +172,19 @@ export async function queryDB(db) {
             labels.push(enumLabel.enumlabel);
         enums.push(new Enum(type.typname, labels));
     }
+    return enums;
+}
+export async function queryDB(db) {
+    const tableQuery = await runQuery(`SELECT table_schema, table_name
+         FROM information_schema.tables
+         WHERE table_type = 'BASE TABLE'
+           AND table_schema NOT IN
+               ('pg_catalog', 'information_schema');`, [], db);
+    if (typeof tableQuery === "undefined")
+        return new PigeonError(1, "", new Error("An SQL error has occurred."));
+    const enums = await enumsQuery(db);
+    if (enums instanceof PigeonError)
+        return enums;
     const tables = [];
     for (const table of tableQuery.rows) {
         const columnQuery = await runQuery(`SELECT column_name,
@@ -383,7 +387,7 @@ function createClass(tableName, columns, primaryKey, foreignKeys) {
             text += "\t * A primary key representing the " + nameBeautifier(column.column_name) + " for the " + nameBeautifier(tableName) + " table.\n";
         else if (foreignKeys && foreignKeyIndex)
             text += "\t * A foreign key representing the " + nameBeautifier(column.column_name) + " for the " + nameBeautifier(tableName) + " table and referencing the " + nameBeautifier(foreignKeys[foreignKeyIndex].foreign_column) + " in the " + nameBeautifier(foreignKeys[foreignKeyIndex].foreign_table) + " table in the " + nameBeautifier(foreignKeys[foreignKeyIndex].foreign_schema) + " schema.\n";
-        else if (column.column_name.toLowerCase().startsWith('is_'))
+        else if (column.column_name.toLowerCase().startsWith("is_"))
             text += "\t * Indicates whether this record in the table " + nameBeautifier(tableName) + " is currently " + nameBeautifier(column.column_name.slice(3)).toLowerCase() + ".\n";
         else
             text += "\t * The " + nameBeautifier(column.column_name) + " for the " + nameBeautifier(tableName) + " table.\n";
@@ -396,7 +400,7 @@ function createClass(tableName, columns, primaryKey, foreignKeys) {
                     if (column.column_default)
                         text += " = new Date()";
                     else
-                        text += " = new Date(" + column.column_default.replace(' ', 'T') + ")";
+                        text += " = new Date(" + column.column_default.replace(" ", "T") + ")";
                 }
                 else if (dataType === "number" || dataType === "boolean")
                     text += " = " + column.column_default;
@@ -417,7 +421,7 @@ function createClass(tableName, columns, primaryKey, foreignKeys) {
         if (column.is_nullable === "YES")
             text += " | undefined";
         text += "} " + column.column_name;
-        if (!column.column_name.toLowerCase().startsWith('is_'))
+        if (!column.column_name.toLowerCase().startsWith("is_"))
             text += " - The " + nameBeautifier(column.column_name) + " of the " + nameBeautifier(tableName) + " table. \n";
         else
             text += " - Indicates whether this record in the table " + nameBeautifier(tableName) + " is currently " + nameBeautifier(column.column_name.slice(3)).toLowerCase() + ".\n";

package/src/maps.js

@@ -1,8 +1,4 @@
-/*
- * Copyright (c) 2024 Andreas Michael
- * This software is under the Apache 2.0 License
- */
-export const types = new Map([
+export const jsTypes = new Map([
     ["bigint", "number"],
     ["int8", "number"],
     ["bigserial", "number"],
@@ -65,3 +61,62 @@ export const types = new Map([
     ["uuid", "string"],
     ["xml", "string"],
 ]);
+export const udtTypes = new Map([
+    ["smallint", "int2"],
+    ["int2", "int2"],
+    ["integer", "int4"],
+    ["int", "int4"],
+    ["bigint", "int8"],
+    ["int8", "int8"],
+    ["real", "float4"],
+    ["float4", "float4"],
+    ["double precision", "float8"],
+    ["float8", "float8"],
+    ["numeric", "numeric"],
+    ["decimal", "numeric"],
+    ["money", "money"],
+    ["smallserial", "int2"],
+    ["serial", "int4"],
+    ["bigserial", "int8"],
+    ["character", "bpchar"],
+    ["char", "bpchar"],
+    ["character varying", "varchar"],
+    ["varchar", "varchar"],
+    ["text", "text"],
+    ["bytea", "bytea"],
+    ["bit", "bit"],
+    ["bit varying", "varbit"],
+    ["varbit", "varbit"],
+    ["boolean", "bool"],
+    ["bool", "bool"],
+    ["date", "date"],
+    ["time without time zone", "time"],
+    ["time", "time"],
+    ["time with time zone", "timetz"],
+    ["timetz", "timetz"],
+    ["timestamp without time zone", "timestamp"],
+    ["timestamp", "timestamp"],
+    ["timestamp with time zone", "timestamptz"],
+    ["timestamptz", "timestamptz"],
+    ["interval", "interval"],
+    ["box", "box"],
+    ["circle", "circle"],
+    ["line", "line"],
+    ["lseg", "lseg"],
+    ["path", "path"],
+    ["point", "point"],
+    ["polygon", "polygon"],
+    ["cidr", "cidr"],
+    ["inet", "inet"],
+    ["macaddr", "macaddr"],
+    ["macaddr8", "macaddr8"],
+    ["json", "json"],
+    ["jsonb", "jsonb"],
+    ["uuid", "uuid"],
+    ["tsquery", "tsquery"],
+    ["tsvector", "tsvector"],
+    ["pg_lsn", "pg_lsn"],
+    ["pg_snapshot", "pg_snapshot"],
+    ["txid_snapshot", "txid_snapshot"],
+    ["xml", "xml"],
+]);

package/src/pgAdmin.js

@@ -0,0 +1,117 @@
+import { ColumnQueryRow, ForeignKeyQueryRow, PigeonError, PrimaryKeyQueryRow, Table, UniqueQueryRow } from "./index.js";
+import { udtTypes } from "./maps.js";
+function objectToArray(json) {
+    let arrayJSON = "";
+    let enteredObject = false;
+    let brackets = 0;
+    for (let i = 0; i < json.length; i++) {
+        if (json[i] === "{") {
+            if (!enteredObject) {
+                enteredObject = true;
+                arrayJSON += "[";
+                brackets++;
+                continue;
+            }
+            brackets++;
+            arrayJSON += json[i];
+            continue;
+        }
+        else if (json[i] === "}") {
+            brackets--;
+            if (brackets === 0)
+                return JSON.parse(arrayJSON.slice(0, -1) + "]");
+            arrayJSON += json[i];
+            if (brackets === 1)
+                arrayJSON += ",";
+            continue;
+        }
+        if (enteredObject && brackets !== 1)
+            arrayJSON += json[i];
+    }
+}
+export function getRelationshipsAndTables(json) {
+    if (!json.startsWith("{\"version\":"))
+        throw new PigeonError(1, "", new Error("The file specified is not an pgAdmin ERD file."));
+    let relationships = [];
+    let tables = [];
+    const relationshipsIndex = json.match(/"type":"diagram-links"/)?.index;
+    if (relationshipsIndex)
+        relationships = objectToArray(json.slice(relationshipsIndex));
+    const tablesIndex = json.match(/"type":"diagram-nodes"/)?.index;
+    if (tablesIndex)
+        tables = objectToArray(json.slice(tablesIndex));
+    return {
+        relationships: relationships,
+        tables: tables,
+    };
+}
+export function tableProcessing(tables) {
+    const pigeonTables = [];
+    for (const table of tables) {
+        const data = table.otherInfo.data;
+        const columns = [];
+        let ordinalPossition = 1;
+        for (const column of data.columns) {
+            let dataType = column.cltype;
+            let udtType;
+            udtType = udtTypes.get(dataType);
+            if (!udtType) {
+                if (dataType.endsWith("[]")) {
+                    udtType = "_" + udtTypes.get(dataType.slice(0, -2));
+                    dataType = "ARRAY";
+                }
+                else {
+                    udtType = dataType;
+                    dataType = "USER-DEFINED";
+                }
+            }
+            if (dataType === "smallserial" || dataType === "serial" || dataType === "bigserial") {
+                dataType = dataType.replace("serial", "int");
+                if (dataType === "int")
+                    dataType = "integer";
+                column.defval = "nextval('" + data.name + "_" + column.name + "_seq'::regclass)";
+            }
+            let isNullable;
+            if (column.attnotnull)
+                isNullable = "NO";
+            else
+                isNullable = "YES";
+            let columnDefault;
+            if (column.defval !== "" && column.defval !== undefined)
+                columnDefault = column.defval;
+            else
+                columnDefault = null;
+            let identity;
+            if (column.colconstype === "i")
+                identity = "YES";
+            else
+                identity = "NO";
+            let identityGeneration = null;
+            if (identity === "YES") {
+                if (column.attidentity === "a")
+                    identityGeneration = "ALWAYS";
+                if (column.attidentity === "b")
+                    identityGeneration = "BY DEFAULT";
+            }
+            columns.push(new ColumnQueryRow(column.name, ordinalPossition, columnDefault, isNullable, dataType, udtType, identity, identityGeneration));
+            ordinalPossition++;
+        }
+        let primaryKey = undefined;
+        if (data.primary_key[0]?.columns[0]?.column)
+            primaryKey = new PrimaryKeyQueryRow(data.primary_key[0].columns[0].column);
+        const foreignKeys = [];
+        for (const foreignKey of data.foreign_key) {
+            for (const column of foreignKey.columns) {
+                const match = column.references_table_name.match(/(?:\((.*?)\))? ?(.*)/);
+                foreignKeys.push(new ForeignKeyQueryRow(data.schema, data.name, column.local_column, match[1] || data.schema, match[2], column.referenced));
+            }
+        }
+        const uniqueConstraints = [];
+        if (data.unique_constraint)
+            for (const uniqueConstraint of data.unique_constraint)
+                for (const column of uniqueConstraint.columns)
+                    uniqueConstraints.push(column.column);
+        pigeonTables.push(new Table(data.schema, data.name, columns, primaryKey, foreignKeys, new UniqueQueryRow(uniqueConstraints)));
+    }
+    return pigeonTables;
+}

package/src/utils.js

@@ -1,9 +1,5 @@
-/*
- * Copyright (c) 2025 Andreas Michael
- * This software is under the Apache 2.0 License
- */
 import pg from "pg";
-import { types } from "./maps.js";
+import { jsTypes } from "./maps.js";
 const { Client } = pg;
 export async function runQuery(command, parameters, db) {
     const client = new Client({
@@ -156,7 +152,7 @@ export function getType(dataType, udtName) {
         dataType = udtName.slice(1);
         isArray = true;
     }
-    let foundDataType = types.get(dataType);
+    let foundDataType = jsTypes.get(dataType);
     if (foundDataType === undefined)
         foundDataType = nameBeautifier(udtName).replaceAll(" ", "");
     if (isArray)