@restura/core 0.1.0-alpha.12 → 0.1.0-alpha.14

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import winston from 'winston';
 import * as express from 'express';
 import { z } from 'zod';
-import { PoolConfig, Pool } from 'pg';
+import pg, { QueryResultRow, QueryConfigValues, QueryResult, PoolConfig, Pool, ClientConfig, Client } from 'pg';
 import { IncomingHttpHeaders } from 'http2';
 
 declare const logger: winston.Logger;
@@ -1391,15 +1391,33 @@ interface AsyncExpressApplication {
     delete: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
 }
 
-declare class PsqlPool {
-    poolConfig: PoolConfig;
-    pool: Pool;
-    constructor(poolConfig: PoolConfig);
+declare abstract class PsqlConnection {
+    constructor();
+    protected abstract query<R extends QueryResultRow = any>(query: string, values?: QueryConfigValues<any>): Promise<QueryResult<R>>;
     queryOne(query: string, options: any[], requesterDetails: RequesterDetails): Promise<any>;
     runQuery(query: string, options: any[], requesterDetails: RequesterDetails): Promise<any[]>;
     private logSqlStatement;
 }
 
+declare class PsqlPool extends PsqlConnection {
+    poolConfig: PoolConfig;
+    pool: Pool;
+    constructor(poolConfig: PoolConfig);
+    protected query<R extends QueryResultRow = any>(query: string, values?: QueryConfigValues<any>): Promise<QueryResult<R>>;
+}
+
+declare class PsqlTransaction extends PsqlConnection {
+    clientConfig: ClientConfig;
+    client: Client;
+    private beginTransactionPromise;
+    constructor(clientConfig: ClientConfig);
+    private beginTransaction;
+    rollback(): Promise<pg.QueryResult<any>>;
+    commit(): Promise<pg.QueryResult<any>>;
+    release(): Promise<void>;
+    protected query<R extends QueryResultRow = any>(query: string, values?: QueryConfigValues<any>): Promise<QueryResult<R>>;
+}
+
 declare class ResturaEngine {
     resturaConfig: ResturaConfigSchema;
     private resturaRouter;
@@ -1498,4 +1516,4 @@ declare function updateObjectQuery(table: string, obj: DynamicObject, whereState
 declare function isValueNumber(value: unknown): value is number;
 declare function SQL(strings: any, ...values: any): any;
 
-export { type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DynamicObject, type ErrorCode, HtmlStatusCodes, type LoginDetails, type MatchTypes, type PageQuery, PsqlPool, type RequesterDetails, type ResponseType, type ResponseTypeMap, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type StandardOrderTypes, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };
+export { type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DynamicObject, type ErrorCode, HtmlStatusCodes, type LoginDetails, type MatchTypes, type PageQuery, PsqlConnection, PsqlPool, PsqlTransaction, type RequesterDetails, type ResponseType, type ResponseTypeMap, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type StandardOrderTypes, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import winston from 'winston';
 import * as express from 'express';
 import { z } from 'zod';
-import { PoolConfig, Pool } from 'pg';
+import pg, { QueryResultRow, QueryConfigValues, QueryResult, PoolConfig, Pool, ClientConfig, Client } from 'pg';
 import { IncomingHttpHeaders } from 'http2';
 
 declare const logger: winston.Logger;
@@ -1391,15 +1391,33 @@ interface AsyncExpressApplication {
     delete: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
 }
 
-declare class PsqlPool {
-    poolConfig: PoolConfig;
-    pool: Pool;
-    constructor(poolConfig: PoolConfig);
+declare abstract class PsqlConnection {
+    constructor();
+    protected abstract query<R extends QueryResultRow = any>(query: string, values?: QueryConfigValues<any>): Promise<QueryResult<R>>;
     queryOne(query: string, options: any[], requesterDetails: RequesterDetails): Promise<any>;
     runQuery(query: string, options: any[], requesterDetails: RequesterDetails): Promise<any[]>;
     private logSqlStatement;
 }
 
+declare class PsqlPool extends PsqlConnection {
+    poolConfig: PoolConfig;
+    pool: Pool;
+    constructor(poolConfig: PoolConfig);
+    protected query<R extends QueryResultRow = any>(query: string, values?: QueryConfigValues<any>): Promise<QueryResult<R>>;
+}
+
+declare class PsqlTransaction extends PsqlConnection {
+    clientConfig: ClientConfig;
+    client: Client;
+    private beginTransactionPromise;
+    constructor(clientConfig: ClientConfig);
+    private beginTransaction;
+    rollback(): Promise<pg.QueryResult<any>>;
+    commit(): Promise<pg.QueryResult<any>>;
+    release(): Promise<void>;
+    protected query<R extends QueryResultRow = any>(query: string, values?: QueryConfigValues<any>): Promise<QueryResult<R>>;
+}
+
 declare class ResturaEngine {
     resturaConfig: ResturaConfigSchema;
     private resturaRouter;
@@ -1498,4 +1516,4 @@ declare function updateObjectQuery(table: string, obj: DynamicObject, whereState
 declare function isValueNumber(value: unknown): value is number;
 declare function SQL(strings: any, ...values: any): any;
 
-export { type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DynamicObject, type ErrorCode, HtmlStatusCodes, type LoginDetails, type MatchTypes, type PageQuery, PsqlPool, type RequesterDetails, type ResponseType, type ResponseTypeMap, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type StandardOrderTypes, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };
+export { type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DynamicObject, type ErrorCode, HtmlStatusCodes, type LoginDetails, type MatchTypes, type PageQuery, PsqlConnection, PsqlPool, PsqlTransaction, type RequesterDetails, type ResponseType, type ResponseTypeMap, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type StandardOrderTypes, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };

package/dist/index.js

@@ -68,7 +68,9 @@ var __decorateClass = (decorators, target, key, kind) => {
 var src_exports = {};
 __export(src_exports, {
   HtmlStatusCodes: () => HtmlStatusCodes,
+  PsqlConnection: () => PsqlConnection,
   PsqlPool: () => PsqlPool,
+  PsqlTransaction: () => PsqlTransaction,
   RsError: () => RsError,
   SQL: () => SQL,
   escapeColumnName: () => escapeColumnName,
@@ -1248,7 +1250,6 @@ var import_core_utils5 = require("@redskytech/core-utils");
 
 // src/restura/sql/PsqlPool.ts
 var import_pg = __toESM(require("pg"));
-var import_pg_format2 = __toESM(require("pg-format"));
 
 // src/restura/sql/PsqlUtils.ts
 var import_pg_format = __toESM(require("pg-format"));
@@ -1297,25 +1298,17 @@ function SQL(strings, ...values) {
   return query;
 }
 
-// src/restura/sql/PsqlPool.ts
-var { Pool } = import_pg.default;
-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 import_pg_format2 = __toESM(require("pg-format"));
+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];
@@ -1332,10 +1325,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);
@@ -1367,6 +1358,25 @@ var PsqlPool = class {
   }
 };
 
+// src/restura/sql/PsqlPool.ts
+var { Pool } = import_pg.default;
+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
 var import_core_utils4 = require("@redskytech/core-utils");
 var SqlEngine = class {
@@ -1531,9 +1541,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 = "!"
     
@@ -1570,7 +1580,7 @@ var filterPsqlParser_default = filterPsqlParser;
 // src/restura/sql/PsqlEngine.ts
 var import_pg_diff_sync = __toESM(require("@wmfs/pg-diff-sync"));
 var import_pg_info = __toESM(require("@wmfs/pg-info"));
-var import_pg2 = require("pg");
+var { Client } = "pg";
 var systemUser = {
   role: "",
   host: "",
@@ -1688,14 +1698,14 @@ var PsqlEngine = class extends SqlEngine {
   async diffDatabaseToSchema(schema) {
     const scratchPool = await this.getScratchPool();
     await this.createDatabaseFromSchema(schema, scratchPool);
-    const originalClient = new import_pg2.Client({
+    const originalClient = new Client({
       database: this.psqlConnectionPool.poolConfig.database,
       user: this.psqlConnectionPool.poolConfig.user,
       password: this.psqlConnectionPool.poolConfig.password,
       host: this.psqlConnectionPool.poolConfig.host,
       port: this.psqlConnectionPool.poolConfig.port
     });
-    const scratchClient = new import_pg2.Client({
+    const scratchClient = new Client({
       database: this.psqlConnectionPool.poolConfig.database + "_scratch",
       user: this.psqlConnectionPool.poolConfig.user,
       password: this.psqlConnectionPool.poolConfig.password,
@@ -1713,7 +1723,6 @@ var PsqlEngine = class extends SqlEngine {
       schema: "public"
     });
     const diff = (0, import_pg_diff_sync.default)(info1, info2);
-    console.log("Schema differences:", diff);
     await originalClient.end();
     await scratchClient.end();
     return diff.join("\n");
@@ -1827,22 +1836,20 @@ var PsqlEngine = class extends SqlEngine {
       );
     } else if (routeData.type === "PAGED") {
       const data = req.data;
-      const pageResults = await this.psqlConnectionPool.runQuery(
-        `${selectStatement}${sqlStatement}${groupByOrderByStatement} LIMIT ? OFFSET ?;SELECT COUNT(${routeData.groupBy ? `DISTINCT ${routeData.groupBy.tableName}.${routeData.groupBy.columnName}` : "*"}) AS total
-${sqlStatement};`,
-        [
-          ...sqlParams,
-          data.perPage || DEFAULT_PAGED_PER_PAGE_NUMBER,
-          (data.page - 1) * data.perPage || DEFAULT_PAGED_PAGE_NUMBER,
-          ...sqlParams
-        ],
+      const pagePromise = this.psqlConnectionPool.runQuery(
+        `${selectStatement}${sqlStatement}${groupByOrderByStatement}` + SQL`LIMIT ${data.perPage || DEFAULT_PAGED_PER_PAGE_NUMBER} OFFSET ${(data.page - 1) * data.perPage || DEFAULT_PAGED_PAGE_NUMBER};`,
+        sqlParams,
         req.requesterDetails
       );
+      const totalQuery = `SELECT COUNT(${routeData.groupBy ? `DISTINCT ${routeData.groupBy.tableName}.${routeData.groupBy.columnName}` : "*"}) AS total
+ ${sqlStatement};`;
+      const totalPromise = await this.psqlConnectionPool.runQuery(totalQuery, sqlParams, req.requesterDetails);
+      const [pageResults, totalResponse] = await Promise.all([pagePromise, totalPromise]);
       let total = 0;
-      if (import_core_utils5.ObjectUtils.isArrayWithData(pageResults)) {
-        total = pageResults[1][0].total;
+      if (import_core_utils5.ObjectUtils.isArrayWithData(totalResponse)) {
+        total = totalResponse[0].total;
       }
-      return { data: pageResults[0], total };
+      return { data: pageResults, total };
     } else {
       throw new RsError("UNKNOWN_ERROR", "Unknown route type.");
     }
@@ -2000,6 +2007,125 @@ var schemaToPsqlType = (column, tableName) => {
   return column.type;
 };
 
+// src/restura/sql/PsqlTransaction.ts
+var import_pg2 = __toESM(require("pg"));
+var { Client: Client2 } = import_pg2.default;
+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
+var import_lodash = __toESM(require("lodash.clonedeep"));
+var CompareSchema = class {
+  async diffSchema(newSchema, latestSchema, psqlEngine) {
+    let endPoints = this.diffEndPoints(newSchema.endpoints[0].routes, latestSchema.endpoints[0].routes);
+    let globalParams = this.diffStringArray(newSchema.globalParams, latestSchema.globalParams);
+    let roles = this.diffStringArray(newSchema.roles, latestSchema.roles);
+    let commands = "";
+    if (JSON.stringify(newSchema.database) !== JSON.stringify(latestSchema.database))
+      commands = await psqlEngine.diffDatabaseToSchema(newSchema);
+    let customTypes = newSchema.customTypes !== latestSchema.customTypes;
+    const schemaPreview = { endPoints, globalParams, roles, commands, customTypes };
+    return schemaPreview;
+  }
+  diffStringArray(newArray, originalArray) {
+    let stringsDiff = [];
+    let originalClone = new Set(originalArray);
+    newArray.forEach((item) => {
+      let 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) {
+    let originalClone = (0, import_lodash.default)(originalEndpoints);
+    let diffObj = [];
+    newEndPoints.forEach((endPoint) => {
+      let { path: path4, method } = endPoint;
+      let endPointIndex = originalClone.findIndex((original) => {
+        return original.path === endPoint.path && original.method === endPoint.method;
+      });
+      if (endPointIndex === -1) {
+        diffObj.push({
+          name: `${method} ${path4}`,
+          changeType: "NEW"
+        });
+      } else {
+        let 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) => {
+      let { 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 } = import_pg3.default;
 var ResturaEngine = class {
@@ -2205,7 +2331,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);
@@ -2379,7 +2505,9 @@ var restura = new ResturaEngine();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   HtmlStatusCodes,
+  PsqlConnection,
   PsqlPool,
+  PsqlTransaction,
   RsError,
   SQL,
   escapeColumnName,