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

package/dist/index.mjs

@@ -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,10 +1210,16 @@ 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
 import format2 from "pg-format";
 function escapeColumnName(columnName) {
@@ -1222,7 +1235,8 @@ function insertObjectQuery(table, obj) {
   const params = Object.values(obj);
   const columns = keys.map((column) => escapeColumnName(column)).join(", ");
   const values = params.map((value) => SQL`${value}`).join(", ");
-  const query = `INSERT INTO "${table}" (${columns})
+  const query = `
+INSERT INTO "${table}" (${columns})
                  VALUES (${values})
                  RETURNING *`;
   return query;
@@ -1232,7 +1246,8 @@ function updateObjectQuery(table, obj, whereStatement) {
   for (const i in obj) {
     setArray.push(`${escapeColumnName(i)} = ` + SQL`${obj[i]}`);
   }
-  return `UPDATE ${escapeColumnName(table)}
+  return `
+UPDATE ${escapeColumnName(table)}
                  SET ${setArray.join(", ")} ${whereStatement}
                  RETURNING *`;
 }
@@ -1255,7 +1270,6 @@ function SQL(strings, ...values) {
 }
 
 // src/restura/sql/PsqlConnection.ts
-import format3 from "pg-format";
 var PsqlConnection = class {
   constructor() {
   }
@@ -1263,8 +1277,10 @@ var PsqlConnection = class {
   async queryOne(query, options, requesterDetails) {
     const formattedQuery = questionMarksToOrderedParams(query);
     this.logSqlStatement(formattedQuery, options, requesterDetails);
+    const queryMetadata = `--QUERY_METADATA(${JSON.stringify(requesterDetails)})
+`;
     try {
-      const response = await this.query(formattedQuery, options);
+      const response = await this.query(queryMetadata + 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];
@@ -1281,8 +1297,10 @@ var PsqlConnection = class {
   async runQuery(query, options, requesterDetails) {
     const formattedQuery = questionMarksToOrderedParams(query);
     this.logSqlStatement(formattedQuery, options, requesterDetails);
+    const queryMetadata = `--QUERY_METADATA(${JSON.stringify(requesterDetails)})
+`;
     try {
-      const response = await this.query(formattedQuery, options);
+      const response = await this.query(queryMetadata + formattedQuery, options);
       return response.rows;
     } catch (error) {
       console.error(error, query, options);
@@ -1533,10 +1551,112 @@ var filterPsqlParser = peg.generate(filterSqlGrammar, {
 });
 var filterPsqlParser_default = filterPsqlParser;
 
+// src/restura/eventManager.ts
+import Bluebird from "bluebird";
+var EventManager = class {
+  constructor() {
+    this.actionHandlers = {
+      DATABASE_ROW_DELETE: [],
+      DATABASE_ROW_INSERT: [],
+      DATABASE_COLUMN_UPDATE: []
+    };
+  }
+  addRowInsertHandler(onInsert, filter) {
+    this.actionHandlers.DATABASE_ROW_INSERT.push({
+      callback: onInsert,
+      filter
+    });
+  }
+  addColumnChangeHandler(onUpdate, filter) {
+    this.actionHandlers.DATABASE_COLUMN_UPDATE.push({
+      callback: onUpdate,
+      filter
+    });
+  }
+  addRowDeleteHandler(onDelete, filter) {
+    this.actionHandlers.DATABASE_ROW_DELETE.push({
+      callback: onDelete,
+      filter
+    });
+  }
+  async fireActionFromDbTrigger(sqlMutationData, result) {
+    if (sqlMutationData.mutationType === "INSERT") {
+      await this.fireInsertActions(sqlMutationData, result);
+    } else if (sqlMutationData.mutationType === "UPDATE") {
+      await this.fireUpdateActions(sqlMutationData, result);
+    } else if (sqlMutationData.mutationType === "DELETE") {
+      await this.fireDeleteActions(sqlMutationData, result);
+    }
+  }
+  async fireInsertActions(data, triggerResult) {
+    await Bluebird.map(
+      this.actionHandlers.DATABASE_ROW_INSERT,
+      ({ callback, filter }) => {
+        if (!this.hasHandlersForEventType("DATABASE_ROW_INSERT", filter, triggerResult)) return;
+        const insertData = {
+          tableName: triggerResult.table,
+          insertId: triggerResult.record.id,
+          insertObject: triggerResult.record,
+          requesterDetails: data.requesterDetails
+        };
+        callback(insertData, data.requesterDetails);
+      },
+      { concurrency: 10 }
+    );
+  }
+  async fireDeleteActions(data, triggerResult) {
+    await Bluebird.map(
+      this.actionHandlers.DATABASE_ROW_DELETE,
+      ({ callback, filter }) => {
+        if (!this.hasHandlersForEventType("DATABASE_ROW_DELETE", filter, triggerResult)) return;
+        const deleteData = {
+          tableName: triggerResult.table,
+          deletedRow: triggerResult.previousRecord,
+          requesterDetails: data.requesterDetails
+        };
+        callback(deleteData, data.requesterDetails);
+      },
+      { concurrency: 10 }
+    );
+  }
+  async fireUpdateActions(data, triggerResult) {
+    await Bluebird.map(
+      this.actionHandlers.DATABASE_COLUMN_UPDATE,
+      ({ callback, filter }) => {
+        if (!this.hasHandlersForEventType("DATABASE_COLUMN_UPDATE", filter, triggerResult)) return;
+        const columnChangeData = {
+          tableName: triggerResult.table,
+          rowId: triggerResult.record.id,
+          newData: triggerResult.record,
+          oldData: triggerResult.previousRecord,
+          requesterDetails: data.requesterDetails
+        };
+        callback(columnChangeData, data.requesterDetails);
+      },
+      { concurrency: 10 }
+    );
+  }
+  hasHandlersForEventType(eventType, filter, triggerResult) {
+    if (filter) {
+      switch (eventType) {
+        case "DATABASE_ROW_INSERT":
+        case "DATABASE_ROW_DELETE":
+          if (filter.tableName && filter.tableName !== triggerResult.table) return false;
+          break;
+        case "DATABASE_COLUMN_UPDATE":
+          const filterColumnChange = filter;
+          if (filterColumnChange.tableName !== filter.tableName) return false;
+          break;
+      }
+    }
+    return true;
+  }
+};
+var eventManager = new EventManager();
+var eventManager_default = eventManager;
+
 // 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: "",
@@ -1544,9 +1664,49 @@ var systemUser = {
   isSystemUser: true
 };
 var PsqlEngine = class extends SqlEngine {
-  constructor(psqlConnectionPool) {
+  constructor(psqlConnectionPool, shouldListenForDbTriggers = false) {
     super();
     this.psqlConnectionPool = psqlConnectionPool;
+    if (shouldListenForDbTriggers) {
+      this.setupTriggerListeners = this.listenForDbTriggers();
+    }
+  }
+  async close() {
+    if (this.triggerClient) {
+      await this.triggerClient.end();
+    }
+  }
+  async listenForDbTriggers() {
+    this.triggerClient = new Client({
+      user: this.psqlConnectionPool.poolConfig.user,
+      host: this.psqlConnectionPool.poolConfig.host,
+      database: this.psqlConnectionPool.poolConfig.database,
+      password: this.psqlConnectionPool.poolConfig.password,
+      port: this.psqlConnectionPool.poolConfig.port,
+      connectionTimeoutMillis: 2e3
+    });
+    await this.triggerClient.connect();
+    const promises = [];
+    promises.push(this.triggerClient.query("LISTEN insert"));
+    promises.push(this.triggerClient.query("LISTEN update"));
+    promises.push(this.triggerClient.query("LISTEN delete"));
+    await Promise.all(promises);
+    this.triggerClient.on("notification", async (msg) => {
+      if (msg.channel === "insert" || msg.channel === "update" || msg.channel === "delete") {
+        const payload = JSON.parse(msg.payload);
+        await this.handleTrigger(payload, msg.channel.toUpperCase());
+      }
+    });
+  }
+  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 = ObjectUtils4.safeParse(jsonString);
+      await eventManager_default.fireActionFromDbTrigger({ requesterDetails, mutationType }, payload);
+    }
   }
   async createDatabaseFromSchema(schema, connection) {
     const sqlFullStatement = this.generateDatabaseSchemaFromSchema(schema);
@@ -1557,7 +1717,11 @@ var PsqlEngine = class extends SqlEngine {
     const sqlStatements = [];
     const enums = [];
     const indexes = [];
+    const triggers = [];
     for (const table of schema.database) {
+      triggers.push(this.createInsertTriggers(table.name));
+      triggers.push(this.createUpdateTrigger(table.name));
+      triggers.push(this.createDeleteTrigger(table.name));
       let sql = `CREATE TABLE "${table.name}"
 					   ( `;
       const tableColumns = [];
@@ -1584,7 +1748,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");
@@ -1595,7 +1759,7 @@ var PsqlEngine = class extends SqlEngine {
           indexes.push(
             `	CREATE ${unique}INDEX "${index.name}" ON "${table.name}" (${index.columns.map((item) => {
               return `"${item}" ${index.order}`;
-            }).join(", ")})`
+            }).join(", ")});`
           );
         }
       }
@@ -1625,7 +1789,8 @@ var PsqlEngine = class extends SqlEngine {
       }
       sqlStatements.push(sql + constraints.join(",\n") + ";");
     }
-    sqlStatements.push(indexes.join(";\n"));
+    sqlStatements.push(indexes.join("\n"));
+    sqlStatements.push(triggers.join("\n"));
     return enums.join("\n") + "\n" + sqlStatements.join("\n\n");
   }
   async getScratchPool() {
@@ -1671,12 +1836,10 @@ 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);
     await originalClient.end();
@@ -1695,8 +1858,7 @@ var PsqlEngine = class extends SqlEngine {
     )) {
       return "'[]'";
     }
-    return `COALESCE((
-				SELECT JSON_AGG(JSON_BUILD_OBJECT(
+    return `COALESCE((SELECT JSON_AGG(JSON_BUILD_OBJECT(
 			${item.subquery.properties.map((nestedItem) => {
       if (!this.doesRoleHavePermissionToColumn(req.requesterDetails.role, schema, nestedItem, [
         ...routeData.joins,
@@ -1705,7 +1867,7 @@ var PsqlEngine = class extends SqlEngine {
         return;
       }
       if (nestedItem.subquery) {
-        return `"${nestedItem.name}", ${this.createNestedSelect(
+        return `'${nestedItem.name}', ${this.createNestedSelect(
           // recursion
           req,
           schema,
@@ -1716,7 +1878,7 @@ var PsqlEngine = class extends SqlEngine {
         )}`;
       }
       return `'${nestedItem.name}', ${escapeColumnName(nestedItem.selector)}`;
-    }).filter(Boolean).join(",")}
+    }).filter(Boolean).join(", ")}
 						)) 
 						FROM
 							"${item.subquery.table}"
@@ -1844,10 +2006,12 @@ var PsqlEngine = class extends SqlEngine {
       req.requesterDetails.role,
       sqlParams
     );
-    let deleteStatement = `DELETE
-                           FROM "${routeData.table}" ${joinStatement}`;
-    deleteStatement += this.generateWhereClause(req, routeData.where, routeData, sqlParams);
-    deleteStatement += ";";
+    const whereClause = this.generateWhereClause(req, routeData.where, routeData, sqlParams);
+    if (whereClause.replace(/\s/g, "") === "") {
+      throw new RsError("DELETE_FORBIDDEN", "Deletes need a where clause");
+    }
+    const deleteStatement = `
+DELETE FROM "${routeData.table}" ${joinStatement} ${whereClause}`;
     await this.psqlConnectionPool.runQuery(deleteStatement, sqlParams, req.requesterDetails);
     return true;
   }
@@ -1910,17 +2074,17 @@ var PsqlEngine = class extends SqlEngine {
         );
       let operator = item.operator;
       if (operator === "LIKE") {
-        sqlParams[sqlParams.length - 1] = `%${sqlParams[sqlParams.length - 1]}%`;
+        item.value = `%${item.value}%`;
       } else if (operator === "STARTS WITH") {
         operator = "LIKE";
-        sqlParams[sqlParams.length - 1] = `${sqlParams[sqlParams.length - 1]}%`;
+        item.value = `${item.value}%`;
       } else if (operator === "ENDS WITH") {
         operator = "LIKE";
-        sqlParams[sqlParams.length - 1] = `%${sqlParams[sqlParams.length - 1]}`;
+        item.value = `%${item.value}`;
       }
       const replacedValue = this.replaceParamKeywords(item.value, routeData, req, sqlParams);
       const escapedValue = SQL`${replacedValue}`;
-      whereClause += `	${item.conjunction || ""} "${item.tableName}"."${item.columnName}" ${operator} ${["IN", "NOT IN"].includes(operator) ? `(${escapedValue})` : escapedValue}
+      whereClause += `	${item.conjunction || ""} "${item.tableName}"."${item.columnName}" ${operator.replace("LIKE", "ILIKE")} ${["IN", "NOT IN"].includes(operator) ? `(${escapedValue})` : escapedValue}
 `;
     });
     const data = req.data;
@@ -1954,63 +2118,94 @@ var PsqlEngine = class extends SqlEngine {
     }
     return whereClause;
   }
+  createUpdateTrigger(tableName) {
+    return ` 
+CREATE OR REPLACE FUNCTION notify_${tableName}_update()
+    RETURNS TRIGGER AS $$
+BEGIN
+    PERFORM pg_notify('update', JSON_BUILD_OBJECT('table', '${tableName}', 'query', current_query(), 'record', NEW, 'previousRecord', OLD)::text);
+    RETURN NEW;
+END;
+$$ LANGUAGE plpgsql;
+
+CREATE OR REPLACE TRIGGER ${tableName}_update
+    AFTER UPDATE ON "${tableName}"
+    FOR EACH ROW
+EXECUTE FUNCTION notify_${tableName}_update();
+		`;
+  }
+  createDeleteTrigger(tableName) {
+    return `
+CREATE OR REPLACE FUNCTION notify_${tableName}_delete()
+    RETURNS TRIGGER AS $$
+BEGIN
+    PERFORM pg_notify('delete', JSON_BUILD_OBJECT('table', '${tableName}', 'query', current_query(), 'record', NEW, 'previousRecord', OLD)::text);
+    RETURN NEW;
+END;
+$$ LANGUAGE plpgsql;
+
+CREATE OR REPLACE TRIGGER "${tableName}_delete"
+    AFTER DELETE ON "${tableName}"
+    FOR EACH ROW
+EXECUTE FUNCTION notify_${tableName}_delete();
+		`;
+  }
+  createInsertTriggers(tableName) {
+    return `
+CREATE OR REPLACE FUNCTION notify_${tableName}_insert()
+    RETURNS TRIGGER AS $$
+BEGIN
+    PERFORM pg_notify('insert', JSON_BUILD_OBJECT('table', '${tableName}', 'query', current_query(), 'record', NEW, 'previousRecord', OLD)::text);
+    RETURN NEW;
+END;
+$$ LANGUAGE plpgsql;
+
+CREATE TRIGGER "${tableName}_insert"
+    AFTER INSERT ON "${tableName}"
+    FOR EACH ROW
+EXECUTE FUNCTION notify_${tableName}_insert();
+		`;
+  }
 };
-var schemaToPsqlType = (column, tableName) => {
+__decorateClass([
+  boundMethod
+], PsqlEngine.prototype, "handleTrigger", 1);
+__decorateClass([
+  boundMethod
+], PsqlEngine.prototype, "createUpdateTrigger", 1);
+__decorateClass([
+  boundMethod
+], PsqlEngine.prototype, "createDeleteTrigger", 1);
+__decorateClass([
+  boundMethod
+], PsqlEngine.prototype, "createInsertTriggers", 1);
+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 pg2 from "pg";
-var { Client: Client2 } = pg2;
-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) {
-    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);
+    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);
-    let customTypes = newSchema.customTypes !== latestSchema.customTypes;
+    const customTypes = newSchema.customTypes !== latestSchema.customTypes;
     const schemaPreview = { endPoints, globalParams, roles, commands, customTypes };
     return schemaPreview;
   }
   diffStringArray(newArray, originalArray) {
-    let stringsDiff = [];
-    let originalClone = new Set(originalArray);
+    const stringsDiff = [];
+    const originalClone = new Set(originalArray);
     newArray.forEach((item) => {
-      let originalIndex = originalClone.has(item);
+      const originalIndex = originalClone.has(item);
       if (!originalIndex) {
         stringsDiff.push({
           name: item,
@@ -2029,11 +2224,11 @@ var CompareSchema = class {
     return stringsDiff;
   }
   diffEndPoints(newEndPoints, originalEndpoints) {
-    let originalClone = cloneDeep(originalEndpoints);
-    let diffObj = [];
+    const originalClone = cloneDeep(originalEndpoints);
+    const diffObj = [];
     newEndPoints.forEach((endPoint) => {
-      let { path: path4, method } = endPoint;
-      let endPointIndex = originalClone.findIndex((original) => {
+      const { path: path4, method } = endPoint;
+      const endPointIndex = originalClone.findIndex((original) => {
         return original.path === endPoint.path && original.method === endPoint.method;
       });
       if (endPointIndex === -1) {
@@ -2042,7 +2237,7 @@ var CompareSchema = class {
           changeType: "NEW"
         });
       } else {
-        let original = originalClone.findIndex((original2) => {
+        const original = originalClone.findIndex((original2) => {
           return this.compareEndPoints(endPoint, original2);
         });
         if (original === -1) {
@@ -2055,7 +2250,7 @@ var CompareSchema = class {
       }
     });
     originalClone.forEach((original) => {
-      let { path: path4, method } = original;
+      const { path: path4, method } = original;
       diffObj.push({
         name: `${method} ${path4}`,
         changeType: "DELETED"
@@ -2458,11 +2653,13 @@ var setupPgReturnTypes = () => {
 };
 setupPgReturnTypes();
 var restura = new ResturaEngine();
+
+// src/restura/sql/PsqlTransaction.ts
+import pg4 from "pg";
+var { Client: Client2 } = pg4;
 export {
   HtmlStatusCodes,
-  PsqlConnection,
   PsqlPool,
-  PsqlTransaction,
   RsError,
   SQL,
   escapeColumnName,