@restura/core 0.1.0-alpha.13 → 0.1.0-alpha.15

package/dist/index.mjs

@@ -216,7 +216,7 @@ import { createHash } from "crypto";
 import * as express from "express";
 import fs3 from "fs";
 import path3 from "path";
-import pg2 from "pg";
+import pg4 from "pg";
 import * as prettier3 from "prettier";
 
 // src/restura/sql/SqlUtils.ts
@@ -748,7 +748,7 @@ var joinDataSchema = z3.object({
 var requestDataSchema = z3.object({
   name: z3.string(),
   required: z3.boolean(),
-  isNullable: z3.boolean().optional().default(false),
+  isNullable: z3.boolean().optional(),
   validator: z3.array(validatorDataSchema)
 }).strict();
 var responseDataSchema = z3.object({
@@ -834,6 +834,12 @@ var postgresColumnDateTypesSchema = z3.enum([
   "INTERVAL"
   // time span
 ]);
+var postgresColumnJsonTypesSchema = z3.enum([
+  "JSON",
+  // stores JSON data as raw text
+  "JSONB"
+  // stores JSON data in a binary format, optimized for query performance
+]);
 var mariaDbColumnNumericTypesSchema = z3.enum([
   "BOOLEAN",
   // 1-byte A synonym for "TINYINT(1)". Supported from version 1.2.0 onwards.
@@ -896,6 +902,7 @@ var columnDataSchema = z3.object({
     postgresColumnNumericTypesSchema,
     postgresColumnStringTypesSchema,
     postgresColumnDateTypesSchema,
+    postgresColumnJsonTypesSchema,
     mariaDbColumnNumericTypesSchema,
     mariaDbColumnStringTypesSchema,
     mariaDbColumnDateTypesSchema
@@ -1203,9 +1210,14 @@ function convertTable(table) {
 
 // src/restura/sql/PsqlEngine.ts
 import { ObjectUtils as ObjectUtils4 } from "@redskytech/core-utils";
+import getDiff from "@wmfs/pg-diff-sync";
+import pgInfo from "@wmfs/pg-info";
+import pg2 from "pg";
 
 // src/restura/sql/PsqlPool.ts
 import pg from "pg";
+
+// src/restura/sql/PsqlConnection.ts
 import format3 from "pg-format";
 
 // src/restura/sql/PsqlUtils.ts
@@ -1255,25 +1267,16 @@ function SQL(strings, ...values) {
   return query;
 }
 
-// src/restura/sql/PsqlPool.ts
-var { Pool } = pg;
-var PsqlPool = class {
-  constructor(poolConfig) {
-    this.poolConfig = poolConfig;
-    this.pool = new Pool(poolConfig);
-    this.queryOne("SELECT NOW();", [], { isSystemUser: true, role: "", host: "localhost", ipAddress: "" }).then(() => {
-      logger.info("Connected to PostgreSQL database");
-    }).catch((error) => {
-      logger.error("Error connecting to database", error);
-      process.exit(1);
-    });
+// src/restura/sql/PsqlConnection.ts
+var PsqlConnection = class {
+  constructor() {
   }
   // eslint-disable-next-line  @typescript-eslint/no-explicit-any
   async queryOne(query, options, requesterDetails) {
     const formattedQuery = questionMarksToOrderedParams(query);
     this.logSqlStatement(formattedQuery, options, requesterDetails);
     try {
-      const response = await this.pool.query(formattedQuery, options);
+      const response = await this.query(formattedQuery, options);
       if (response.rows.length === 0) throw new RsError("NOT_FOUND", "No results found");
       else if (response.rows.length > 1) throw new RsError("DUPLICATE", "More than one result found");
       return response.rows[0];
@@ -1290,10 +1293,8 @@ var PsqlPool = class {
   async runQuery(query, options, requesterDetails) {
     const formattedQuery = questionMarksToOrderedParams(query);
     this.logSqlStatement(formattedQuery, options, requesterDetails);
-    const queryUpdated = query.replace(/[\t\n]/g, " ");
-    console.log(queryUpdated, options);
     try {
-      const response = await this.pool.query(formattedQuery, options);
+      const response = await this.query(formattedQuery, options);
       return response.rows;
     } catch (error) {
       console.error(error, query, options);
@@ -1325,6 +1326,25 @@ var PsqlPool = class {
   }
 };
 
+// src/restura/sql/PsqlPool.ts
+var { Pool } = pg;
+var PsqlPool = class extends PsqlConnection {
+  constructor(poolConfig) {
+    super();
+    this.poolConfig = poolConfig;
+    this.pool = new Pool(poolConfig);
+    this.queryOne("SELECT NOW();", [], { isSystemUser: true, role: "", host: "localhost", ipAddress: "" }).then(() => {
+      logger.info("Connected to PostgreSQL database");
+    }).catch((error) => {
+      logger.error("Error connecting to database", error);
+      process.exit(1);
+    });
+  }
+  async query(query, values) {
+    return this.pool.query(query, values);
+  }
+};
+
 // src/restura/sql/SqlEngine.ts
 import { ObjectUtils as ObjectUtils3 } from "@redskytech/core-utils";
 var SqlEngine = class {
@@ -1489,9 +1509,9 @@ expressionList =
 
 expression = 
     negate:negate?"(" "column:" column:column ","? value:value? ","? type:type? ")" 
-    {return \`\${negate? "!" : ""}(\${type?  type(column, value) : \`\${column} = \${format.literal(value)}\`})\`;}
+    {return \`\${negate? " NOT " : ""}(\${type?  type(column, value) : \`\${column} = \${format.literal(value)}\`})\`;}
     /
-    negate:negate?"("expression:expressionList")" { return \`\${negate? "!" : ""}(\${expression})\`; }
+    negate:negate?"("expression:expressionList")" { return \`\${negate? " NOT " : ""}(\${expression})\`; }
 
 negate = "!"
     
@@ -1526,9 +1546,7 @@ var filterPsqlParser = peg.generate(filterSqlGrammar, {
 var filterPsqlParser_default = filterPsqlParser;
 
 // src/restura/sql/PsqlEngine.ts
-import getDiff from "@wmfs/pg-diff-sync";
-import pgInfo from "@wmfs/pg-info";
-var { Client } = "pg";
+var { Client } = pg2;
 var systemUser = {
   role: "",
   host: "",
@@ -1576,7 +1594,7 @@ var PsqlEngine = class extends SqlEngine {
         }
         if (column.isNullable) columnSql += " NULL";
         else columnSql += " NOT NULL";
-        if (column.default) columnSql += ` DEFAULT '${column.default}'`;
+        if (column.default) columnSql += ` DEFAULT ${column.default}`;
         tableColumns.push(columnSql);
       }
       sql += tableColumns.join(", \n");
@@ -1663,15 +1681,12 @@ var PsqlEngine = class extends SqlEngine {
     await originalClient.connect();
     await scratchClient.connect();
     const info1 = await pgInfo({
-      client: originalClient,
-      schema: "public"
+      client: originalClient
     });
     const info2 = await pgInfo({
-      client: scratchClient,
-      schema: "public"
+      client: scratchClient
     });
     const diff = getDiff(info1, info2);
-    console.log("Schema differences:", diff);
     await originalClient.end();
     await scratchClient.end();
     return diff.join("\n");
@@ -1948,16 +1963,135 @@ var PsqlEngine = class extends SqlEngine {
     return whereClause;
   }
 };
-var schemaToPsqlType = (column, tableName) => {
+function schemaToPsqlType(column, tableName) {
   if (column.hasAutoIncrement) return "BIGSERIAL";
   if (column.type === "ENUM") return `"${tableName}_${column.name}_enum"`;
   if (column.type === "DATETIME") return "TIMESTAMPTZ";
   if (column.type === "MEDIUMINT") return "INT";
   return column.type;
+}
+
+// src/restura/sql/PsqlTransaction.ts
+import pg3 from "pg";
+var { Client: Client2 } = pg3;
+var PsqlTransaction = class extends PsqlConnection {
+  constructor(clientConfig) {
+    super();
+    this.clientConfig = clientConfig;
+    this.client = new Client2(clientConfig);
+    this.beginTransactionPromise = this.beginTransaction();
+  }
+  async beginTransaction() {
+    return this.query("BEGIN");
+  }
+  async rollback() {
+    return this.query("ROLLBACK");
+  }
+  async commit() {
+    return this.query("COMMIT");
+  }
+  async release() {
+    return this.client.end();
+  }
+  async query(query, values) {
+    await this.client.connect();
+    await this.beginTransactionPromise;
+    return this.client.query(query, values);
+  }
+};
+
+// src/restura/compareSchema.ts
+import cloneDeep from "lodash.clonedeep";
+var CompareSchema = class {
+  async diffSchema(newSchema, latestSchema, psqlEngine) {
+    const endPoints = this.diffEndPoints(newSchema.endpoints[0].routes, latestSchema.endpoints[0].routes);
+    const globalParams = this.diffStringArray(newSchema.globalParams, latestSchema.globalParams);
+    const roles = this.diffStringArray(newSchema.roles, latestSchema.roles);
+    let commands = "";
+    if (JSON.stringify(newSchema.database) !== JSON.stringify(latestSchema.database))
+      commands = await psqlEngine.diffDatabaseToSchema(newSchema);
+    const customTypes = newSchema.customTypes !== latestSchema.customTypes;
+    const schemaPreview = { endPoints, globalParams, roles, commands, customTypes };
+    return schemaPreview;
+  }
+  diffStringArray(newArray, originalArray) {
+    const stringsDiff = [];
+    const originalClone = new Set(originalArray);
+    newArray.forEach((item) => {
+      const originalIndex = originalClone.has(item);
+      if (!originalIndex) {
+        stringsDiff.push({
+          name: item,
+          changeType: "NEW"
+        });
+      } else {
+        originalClone.delete(item);
+      }
+    });
+    originalClone.forEach((item) => {
+      stringsDiff.push({
+        name: item,
+        changeType: "DELETED"
+      });
+    });
+    return stringsDiff;
+  }
+  diffEndPoints(newEndPoints, originalEndpoints) {
+    const originalClone = cloneDeep(originalEndpoints);
+    const diffObj = [];
+    newEndPoints.forEach((endPoint) => {
+      const { path: path4, method } = endPoint;
+      const endPointIndex = originalClone.findIndex((original) => {
+        return original.path === endPoint.path && original.method === endPoint.method;
+      });
+      if (endPointIndex === -1) {
+        diffObj.push({
+          name: `${method} ${path4}`,
+          changeType: "NEW"
+        });
+      } else {
+        const original = originalClone.findIndex((original2) => {
+          return this.compareEndPoints(endPoint, original2);
+        });
+        if (original === -1) {
+          diffObj.push({
+            name: `${method} ${path4}`,
+            changeType: "MODIFIED"
+          });
+        }
+        originalClone.splice(endPointIndex, 1);
+      }
+    });
+    originalClone.forEach((original) => {
+      const { path: path4, method } = original;
+      diffObj.push({
+        name: `${method} ${path4}`,
+        changeType: "DELETED"
+      });
+    });
+    return diffObj;
+  }
+  compareEndPoints(endPoint1, endPoint2) {
+    return JSON.stringify(endPoint1) === JSON.stringify(endPoint2);
+  }
 };
+__decorateClass([
+  boundMethod
+], CompareSchema.prototype, "diffSchema", 1);
+__decorateClass([
+  boundMethod
+], CompareSchema.prototype, "diffStringArray", 1);
+__decorateClass([
+  boundMethod
+], CompareSchema.prototype, "diffEndPoints", 1);
+__decorateClass([
+  boundMethod
+], CompareSchema.prototype, "compareEndPoints", 1);
+var compareSchema = new CompareSchema();
+var compareSchema_default = compareSchema;
 
 // src/restura/restura.ts
-var { types } = pg2;
+var { types } = pg4;
 var ResturaEngine = class {
   constructor() {
     this.publicEndpoints = {
@@ -2161,7 +2295,7 @@ var ResturaEngine = class {
   }
   async previewCreateSchema(req, res) {
     try {
-      const schemaDiff = { commands: "", endPoints: [], globalParams: [], roles: [], customTypes: false };
+      const schemaDiff = await compareSchema_default.diffSchema(req.data, this.schema, this.psqlEngine);
       res.send({ data: schemaDiff });
     } catch (err) {
       res.status(400).send(err);
@@ -2334,7 +2468,9 @@ setupPgReturnTypes();
 var restura = new ResturaEngine();
 export {
   HtmlStatusCodes,
+  PsqlConnection,
   PsqlPool,
+  PsqlTransaction,
   RsError,
   SQL,
   escapeColumnName,