@restura/core 0.1.0-alpha.20 → 0.1.0-alpha.22

package/dist/index.d.mts

@@ -3,6 +3,7 @@ import * as express from 'express';
 import { z } from 'zod';
 import { QueryResultRow, QueryConfigValues, QueryResult, PoolConfig, Pool, ClientConfig, Client } from 'pg';
 import { IncomingHttpHeaders } from 'http2';
+import { UUID } from 'crypto';
 
 declare const logger: winston.Logger;
 
@@ -2364,6 +2365,7 @@ interface AsyncExpressApplication {
 }
 
 declare abstract class PsqlConnection {
+    readonly instanceId: UUID;
     protected constructor();
     protected abstract query<R extends QueryResultRow = QueryResultRow, T extends Array<unknown> = unknown[]>(query: string, values?: QueryConfigValues<T>): Promise<QueryResult<R>>;
     queryOne<T>(query: string, options: any[], requesterDetails: RequesterDetails): Promise<T>;
@@ -2543,11 +2545,11 @@ type EventType = 'DATABASE_ROW_DELETE' | 'DATABASE_ROW_INSERT' | 'DATABASE_COLUM
 type MutationType = 'INSERT' | 'UPDATE' | 'DELETE';
 interface SqlMutationData {
     mutationType: MutationType;
-    requesterDetails: RequesterDetails;
+    queryMetadata: QueryMetadata;
 }
 interface DatabaseActionData {
     tableName: string;
-    requesterDetails: RequesterDetails;
+    queryMetadata: QueryMetadata;
 }
 interface ActionRowInsertData<T = DynamicObject> extends DatabaseActionData {
     insertId: number;
@@ -2570,6 +2572,7 @@ interface ActionRowDeleteFilter {
 }
 interface ActionColumnChangeFilter {
     tableName: string;
+    columns: string[];
 }
 type TriggerResult = {
     table: string;
@@ -2579,6 +2582,9 @@ type TriggerResult = {
     previousRecord: DynamicObject;
     requesterId: number;
 };
+type QueryMetadata = RequesterDetails & {
+    connectionInstanceId: UUID;
+};
 declare class EventManager {
     private actionHandlers;
     addRowInsertHandler(onInsert: (data: ActionRowInsertData<unknown>) => Promise<void>, filter?: ActionRowInsertFilter): void;
@@ -2592,4 +2598,4 @@ declare class EventManager {
 }
 declare const eventManager: EventManager;
 
-export { type ActionColumnChangeData, type ActionColumnChangeFilter, type ActionRowDeleteData, type ActionRowDeleteFilter, type ActionRowInsertData, type ActionRowInsertFilter, type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DatabaseActionData, type DynamicObject, type ErrorCode, type EventType, HtmlStatusCodes, type LoginDetails, type MatchTypes, type MutationType, type PageQuery, PsqlConnection, PsqlEngine, 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 SqlMutationData, type StandardOrderTypes, type TriggerResult, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, eventManager, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };
+export { type ActionColumnChangeData, type ActionColumnChangeFilter, type ActionRowDeleteData, type ActionRowDeleteFilter, type ActionRowInsertData, type ActionRowInsertFilter, type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DatabaseActionData, type DynamicObject, type ErrorCode, type EventType, HtmlStatusCodes, type LoginDetails, type MatchTypes, type MutationType, type PageQuery, PsqlConnection, PsqlEngine, PsqlPool, PsqlTransaction, type QueryMetadata, 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 SqlMutationData, type StandardOrderTypes, type TriggerResult, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, eventManager, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import * as express from 'express';
 import { z } from 'zod';
 import { QueryResultRow, QueryConfigValues, QueryResult, PoolConfig, Pool, ClientConfig, Client } from 'pg';
 import { IncomingHttpHeaders } from 'http2';
+import { UUID } from 'crypto';
 
 declare const logger: winston.Logger;
 
@@ -2364,6 +2365,7 @@ interface AsyncExpressApplication {
 }
 
 declare abstract class PsqlConnection {
+    readonly instanceId: UUID;
     protected constructor();
     protected abstract query<R extends QueryResultRow = QueryResultRow, T extends Array<unknown> = unknown[]>(query: string, values?: QueryConfigValues<T>): Promise<QueryResult<R>>;
     queryOne<T>(query: string, options: any[], requesterDetails: RequesterDetails): Promise<T>;
@@ -2543,11 +2545,11 @@ type EventType = 'DATABASE_ROW_DELETE' | 'DATABASE_ROW_INSERT' | 'DATABASE_COLUM
 type MutationType = 'INSERT' | 'UPDATE' | 'DELETE';
 interface SqlMutationData {
     mutationType: MutationType;
-    requesterDetails: RequesterDetails;
+    queryMetadata: QueryMetadata;
 }
 interface DatabaseActionData {
     tableName: string;
-    requesterDetails: RequesterDetails;
+    queryMetadata: QueryMetadata;
 }
 interface ActionRowInsertData<T = DynamicObject> extends DatabaseActionData {
     insertId: number;
@@ -2570,6 +2572,7 @@ interface ActionRowDeleteFilter {
 }
 interface ActionColumnChangeFilter {
     tableName: string;
+    columns: string[];
 }
 type TriggerResult = {
     table: string;
@@ -2579,6 +2582,9 @@ type TriggerResult = {
     previousRecord: DynamicObject;
     requesterId: number;
 };
+type QueryMetadata = RequesterDetails & {
+    connectionInstanceId: UUID;
+};
 declare class EventManager {
     private actionHandlers;
     addRowInsertHandler(onInsert: (data: ActionRowInsertData<unknown>) => Promise<void>, filter?: ActionRowInsertFilter): void;
@@ -2592,4 +2598,4 @@ declare class EventManager {
 }
 declare const eventManager: EventManager;
 
-export { type ActionColumnChangeData, type ActionColumnChangeFilter, type ActionRowDeleteData, type ActionRowDeleteFilter, type ActionRowInsertData, type ActionRowInsertFilter, type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DatabaseActionData, type DynamicObject, type ErrorCode, type EventType, HtmlStatusCodes, type LoginDetails, type MatchTypes, type MutationType, type PageQuery, PsqlConnection, PsqlEngine, 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 SqlMutationData, type StandardOrderTypes, type TriggerResult, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, eventManager, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };
+export { type ActionColumnChangeData, type ActionColumnChangeFilter, type ActionRowDeleteData, type ActionRowDeleteFilter, type ActionRowInsertData, type ActionRowInsertFilter, type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DatabaseActionData, type DynamicObject, type ErrorCode, type EventType, HtmlStatusCodes, type LoginDetails, type MatchTypes, type MutationType, type PageQuery, PsqlConnection, PsqlEngine, PsqlPool, PsqlTransaction, type QueryMetadata, 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 SqlMutationData, type StandardOrderTypes, type TriggerResult, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, eventManager, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };

package/dist/index.js

@@ -263,7 +263,7 @@ function boundMethod(target, key, descriptor) {
 var import_body_parser = __toESM(require("body-parser"));
 var import_compression = __toESM(require("compression"));
 var import_cookie_parser = __toESM(require("cookie-parser"));
-var import_crypto = require("crypto");
+var import_crypto2 = require("crypto");
 var express = __toESM(require("express"));
 var import_fs4 = __toESM(require("fs"));
 var import_path5 = __toESM(require("path"));
@@ -757,6 +757,8 @@ function addApiResponseFunctions(req, res, next) {
 function authenticateUser(applicationAuthenticateHandler) {
   return (req, res, next) => {
     applicationAuthenticateHandler(req, res, (userDetails) => {
+      req.requesterDetails.host = req.hostname;
+      req.requesterDetails.ipAddress = req.ip || "";
       req.requesterDetails = __spreadValues(__spreadValues({}, req.requesterDetails), userDetails);
       next();
     });
@@ -1329,14 +1331,17 @@ function SQL(strings, ...values) {
 }
 
 // src/restura/sql/PsqlConnection.ts
+var import_crypto = __toESM(require("crypto"));
 var PsqlConnection = class {
   constructor() {
+    this.instanceId = import_crypto.default.randomUUID();
   }
   // eslint-disable-next-line  @typescript-eslint/no-explicit-any
   async queryOne(query, options, requesterDetails) {
     const formattedQuery = questionMarksToOrderedParams(query);
-    this.logSqlStatement(formattedQuery, options, requesterDetails);
-    const queryMetadata = `--QUERY_METADATA(${JSON.stringify(requesterDetails)})
+    const meta = __spreadValues({ connectionInstanceId: this.instanceId }, requesterDetails);
+    this.logSqlStatement(formattedQuery, options, meta);
+    const queryMetadata = `--QUERY_METADATA(${JSON.stringify(meta)})
 `;
     try {
       const response = await this.query(queryMetadata + formattedQuery, options);
@@ -1355,8 +1360,9 @@ var PsqlConnection = class {
   // eslint-disable-next-line  @typescript-eslint/no-explicit-any
   async runQuery(query, options, requesterDetails) {
     const formattedQuery = questionMarksToOrderedParams(query);
-    this.logSqlStatement(formattedQuery, options, requesterDetails);
-    const queryMetadata = `--QUERY_METADATA(${JSON.stringify(requesterDetails)})
+    const meta = __spreadValues({ connectionInstanceId: this.instanceId }, requesterDetails);
+    this.logSqlStatement(formattedQuery, options, meta);
+    const queryMetadata = `--QUERY_METADATA(${JSON.stringify(meta)})
 `;
     try {
       const response = await this.query(queryMetadata + formattedQuery, options);
@@ -1369,7 +1375,7 @@ var PsqlConnection = class {
       throw new RsError("DATABASE_ERROR", `${error.message}`);
     }
   }
-  logSqlStatement(query, options, requesterDetails, prefix = "") {
+  logSqlStatement(query, options, queryMetadata, prefix = "") {
     if (logger.level !== "silly") return;
     let sqlStatement = "";
     if (options.length === 0) {
@@ -1383,9 +1389,9 @@ var PsqlConnection = class {
       });
     }
     let initiator = "Anonymous";
-    if ("userId" in requesterDetails && requesterDetails.userId)
-      initiator = `User Id (${requesterDetails.userId.toString()})`;
-    if ("isSystemUser" in requesterDetails && requesterDetails.isSystemUser) initiator = "SYSTEM";
+    if ("userId" in queryMetadata && queryMetadata.userId)
+      initiator = `User Id (${queryMetadata.userId.toString()})`;
+    if ("isSystemUser" in queryMetadata && queryMetadata.isSystemUser) initiator = "SYSTEM";
     logger.silly(`${prefix}query by ${initiator}, Query ->
  ${sqlStatement}`);
   }
@@ -1567,13 +1573,15 @@ var filterSqlGrammar = `
 
 start = expressionList
 
+_ = [ \\t\\r\\n]*  // Matches spaces, tabs, and line breaks
+
 expressionList =
-        leftExpression:expression operator:operator rightExpression:expressionList 
+    leftExpression:expression _ operator:operator _ rightExpression:expressionList 
     { return \`\${leftExpression} \${operator} \${rightExpression}\`;}
     / expression
 
 expression = 
-    negate:negate?"(" "column:" column:column ","? value:value? ","? type:type? ")" 
+    negate:negate? _ "(" _ "column" _ ":"  column:column _ ","? _ value:value? ","? _ type:type? _ ")"_
     {return \`\${negate? " NOT " : ""}(\${type?  type(column, value) : \`\${column} = \${format.literal(value)}\`})\`;}
     /
     negate:negate?"("expression:expressionList")" { return \`\${negate? " NOT " : ""}(\${expression})\`; }
@@ -1588,9 +1596,9 @@ column = left:text "." right:text { return  \`\${quoteSqlIdentity(left)}.\${quot
     text:text { return quoteSqlIdentity(text); } 
     
 
-text = text:[a-z0-9-_:@]i+ { return text.join("");}
+text = text:[a-z0-9 \\t\\r\\n\\-_:@]i+ { return text.join(""); }
 
-type = "type:" type:typeString { return type; }
+type = "type" _ ":" _ type:typeString { return type; }
 typeString = text:"startsWith" { return function(column, value) { return \`\${column} ILIKE '\${format.literal(value).slice(1,-1)}%'\`; } } /
     text:"endsWith"  { return function(column, value) { return \`\${column} ILIKE '%\${format.literal(value).slice(1,-1)}'\`; } } /
     text:"contains" { return function(column, value) { return \`\${column} ILIKE '%\${format.literal(value).slice(1,-1)}%'\`; } } /
@@ -1600,8 +1608,9 @@ typeString = text:"startsWith" { return function(column, value) { return \`\${co
     text:"lessThanEqual" { return function(column, value) { return \`\${column} <= '\${format.literal(value).slice(1,-1)}'\`; } } /
     text:"lessThan" { return function(column, value) { return \`\${column} < '\${format.literal(value).slice(1,-1)}'\`; } } / 
     text:"isNull"   { return function(column, value) { return \`isNull(\${column})\`; } } 
-    
-value = "value:" value:text { return value; } 
+
+value = "value" _ ":" value:text { return value; }
+
 
 `;
 var filterPsqlParser = import_pegjs.default.generate(filterSqlGrammar, {
@@ -1656,9 +1665,9 @@ var EventManager = class {
           tableName: triggerResult.table,
           insertId: triggerResult.record.id,
           insertObject: triggerResult.record,
-          requesterDetails: data.requesterDetails
+          queryMetadata: data.queryMetadata
         };
-        callback(insertData, data.requesterDetails);
+        callback(insertData, data.queryMetadata);
       },
       { concurrency: 10 }
     );
@@ -1671,9 +1680,9 @@ var EventManager = class {
         const deleteData = {
           tableName: triggerResult.table,
           deletedRow: triggerResult.previousRecord,
-          requesterDetails: data.requesterDetails
+          queryMetadata: data.queryMetadata
         };
-        callback(deleteData, data.requesterDetails);
+        callback(deleteData, data.queryMetadata);
       },
       { concurrency: 10 }
     );
@@ -1688,9 +1697,9 @@ var EventManager = class {
           rowId: triggerResult.record.id,
           newData: triggerResult.record,
           oldData: triggerResult.previousRecord,
-          requesterDetails: data.requesterDetails
+          queryMetadata: data.queryMetadata
         };
-        callback(columnChangeData, data.requesterDetails);
+        callback(columnChangeData, data.queryMetadata);
       },
       { concurrency: 10 }
     );
@@ -1705,6 +1714,13 @@ var EventManager = class {
         case "DATABASE_COLUMN_UPDATE":
           const filterColumnChange = filter;
           if (filterColumnChange.tableName !== filter.tableName) return false;
+          if (!filterColumnChange.columns.some((item) => {
+            const updatedColumns = Object.keys(
+              changedValues(triggerResult.record, triggerResult.previousRecord)
+            );
+            return updatedColumns.includes(item);
+          }))
+            return false;
           break;
       }
     }
@@ -1713,6 +1729,22 @@ var EventManager = class {
 };
 var eventManager = new EventManager();
 var eventManager_default = eventManager;
+function changedValues(record, previousRecord) {
+  const changed = {};
+  for (const i in previousRecord) {
+    if (previousRecord[i] !== record[i]) {
+      if (typeof previousRecord[i] === "object" && typeof record[i] === "object") {
+        const nestedChanged = changedValues(record[i], previousRecord[i]);
+        if (Object.keys(nestedChanged).length > 0) {
+          changed[i] = record[i];
+        }
+      } else {
+        changed[i] = record[i];
+      }
+    }
+  }
+  return changed;
+}
 
 // src/restura/sql/PsqlEngine.ts
 var { Client } = import_pg2.default;
@@ -1759,12 +1791,15 @@ var PsqlEngine = class extends SqlEngine {
   }
   async handleTrigger(payload, mutationType) {
     const findRequesterDetailsRegex = /^--QUERY_METADATA\(\{.*\}\)/;
-    let requesterDetails = {};
     const match = payload.query.match(findRequesterDetailsRegex);
     if (match) {
       const jsonString = match[0].slice(match[0].indexOf("{"), match[0].lastIndexOf("}") + 1);
-      requesterDetails = import_core_utils5.ObjectUtils.safeParse(jsonString);
-      await eventManager_default.fireActionFromDbTrigger({ requesterDetails, mutationType }, payload);
+      const queryMetadata = import_core_utils5.ObjectUtils.safeParse(jsonString);
+      const triggerFromThisInstance = queryMetadata.connectionInstanceId === this.psqlConnectionPool.instanceId;
+      if (!triggerFromThisInstance) {
+        return;
+      }
+      await eventManager_default.fireActionFromDbTrigger({ queryMetadata, mutationType }, payload);
     }
   }
   async createDatabaseFromSchema(schema, connection) {
@@ -1774,7 +1809,6 @@ var PsqlEngine = class extends SqlEngine {
   }
   generateDatabaseSchemaFromSchema(schema) {
     const sqlStatements = [];
-    const enums = [];
     const indexes = [];
     const triggers = [];
     for (const table of schema.database) {
@@ -1786,10 +1820,7 @@ var PsqlEngine = class extends SqlEngine {
       const tableColumns = [];
       for (const column of table.columns) {
         let columnSql = "";
-        if (column.type === "ENUM") {
-          enums.push(`CREATE TYPE ${schemaToPsqlType(column, table.name)} AS ENUM (${column.value});`);
-        }
-        columnSql += `	"${column.name}" ${schemaToPsqlType(column, table.name)}`;
+        columnSql += `	"${column.name}" ${schemaToPsqlType(column)}`;
         let value = column.value;
         if (column.type === "JSON") value = "";
         if (column.type === "JSONB") value = "";
@@ -1808,6 +1839,9 @@ var PsqlEngine = class extends SqlEngine {
         if (column.isNullable) columnSql += " NULL";
         else columnSql += " NOT NULL";
         if (column.default) columnSql += ` DEFAULT ${column.default}`;
+        if (value && column.type === "ENUM") {
+          columnSql += ` CHECK ("${column.name}" IN (${value}))`;
+        }
         tableColumns.push(columnSql);
       }
       sql += tableColumns.join(", \n");
@@ -1850,16 +1884,18 @@ var PsqlEngine = class extends SqlEngine {
     }
     sqlStatements.push(indexes.join("\n"));
     sqlStatements.push(triggers.join("\n"));
-    return enums.join("\n") + "\n" + sqlStatements.join("\n\n");
+    return sqlStatements.join("\n\n");
   }
   async getScratchPool() {
-    const response = await this.psqlConnectionPool.runQuery(
-      `SELECT * FROM pg_database
-      WHERE datname = '${this.psqlConnectionPool.poolConfig.database}_scratch'`,
+    var _a2, _b;
+    const scratchDbExists = await this.psqlConnectionPool.runQuery(
+      `SELECT *
+             FROM pg_database
+             WHERE datname = '${this.psqlConnectionPool.poolConfig.database}_scratch';`,
       [],
       systemUser
     );
-    if (response.length === 0) {
+    if (scratchDbExists.length === 0) {
       await this.psqlConnectionPool.runQuery(
         `CREATE DATABASE ${this.psqlConnectionPool.poolConfig.database}_scratch;`,
         [],
@@ -1876,12 +1912,27 @@ var PsqlEngine = class extends SqlEngine {
       idleTimeoutMillis: this.psqlConnectionPool.poolConfig.idleTimeoutMillis,
       connectionTimeoutMillis: this.psqlConnectionPool.poolConfig.connectionTimeoutMillis
     });
-    await scratchPool.runQuery(`drop schema public cascade;`, [], systemUser);
+    await scratchPool.runQuery(`DROP SCHEMA public CASCADE;`, [], systemUser);
     await scratchPool.runQuery(
-      `create schema public authorization ${this.psqlConnectionPool.poolConfig.user};`,
+      `CREATE SCHEMA public AUTHORIZATION ${this.psqlConnectionPool.poolConfig.user};`,
+      [],
+      systemUser
+    );
+    const schemaComment = await this.psqlConnectionPool.runQuery(
+      `SELECT pg_description.description
+                                                                                               FROM pg_description
+                                                                                                        JOIN pg_namespace ON pg_namespace.oid = pg_description.objoid
+                                                                                   WHERE pg_namespace.nspname = 'public';`,
       [],
       systemUser
     );
+    if ((_a2 = schemaComment[0]) == null ? void 0 : _a2.description) {
+      await scratchPool.runQuery(
+        `COMMENT ON SCHEMA public IS '${(_b = schemaComment[0]) == null ? void 0 : _b.description}';`,
+        [],
+        systemUser
+      );
+    }
     return scratchPool;
   }
   async diffDatabaseToSchema(schema) {
@@ -2251,9 +2302,9 @@ __decorateClass([
 __decorateClass([
   boundMethod
 ], PsqlEngine.prototype, "createInsertTriggers", 1);
-function schemaToPsqlType(column, tableName) {
+function schemaToPsqlType(column) {
   if (column.hasAutoIncrement) return "BIGSERIAL";
-  if (column.type === "ENUM") return `"${tableName}_${column.name}_enum"`;
+  if (column.type === "ENUM") return `TEXT`;
   if (column.type === "DATETIME") return "TIMESTAMPTZ";
   if (column.type === "MEDIUMINT") return "INT";
   return column.type;
@@ -2727,7 +2778,7 @@ var ResturaEngine = class {
       printWidth: 120,
       singleQuote: true
     }));
-    return (0, import_crypto.createHash)("sha256").update(schemaPrettyStr).digest("hex");
+    return (0, import_crypto2.createHash)("sha256").update(schemaPrettyStr).digest("hex");
   }
   async storeFileSystemSchema() {
     const schemaPrettyStr = await prettier3.format(JSON.stringify(this.schema), __spreadValues({
@@ -2796,7 +2847,7 @@ __decorateClass([
 __decorateClass([
   boundMethod
 ], ResturaEngine.prototype, "runCustomRouteLogic", 1);
-var setupPgReturnTypes = () => {
+function setupPgReturnTypes() {
   const TIMESTAMPTZ_OID = 1184;
   types.setTypeParser(TIMESTAMPTZ_OID, (val) => {
     return val === null ? null : new Date(val).toISOString();
@@ -2805,7 +2856,7 @@ var setupPgReturnTypes = () => {
   types.setTypeParser(BIGINT_OID, (val) => {
     return val === null ? null : Number(val);
   });
-};
+}
 setupPgReturnTypes();
 var restura = new ResturaEngine();