@quillsql/node 0.2.1 → 0.2.3

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 stryvedev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/index.js

@@ -13,7 +13,7 @@ const axios = require("axios");
 var PgError = require("pg-error");
 Connection.prototype.parseE = PgError.parse;
 Connection.prototype.parseN = PgError.parse;
-module.exports = ({ publicKey, privateKey, databaseConnectionString, stagingDatabaseConnectionString, }) => {
+module.exports = ({ privateKey, databaseConnectionString, stagingDatabaseConnectionString, }) => {
     const pool = new Pool({
         connectionString: databaseConnectionString,
     });
@@ -27,16 +27,23 @@ module.exports = ({ publicKey, privateKey, databaseConnectionString, stagingData
             if (task === "query") {
                 const response = yield axios.post("https://quill-344421.uc.r.appspot.com/validate", { query: query }, {
                     params: {
-                        publicKey,
                         orgId,
                     },
                     headers: {
                         Authorization: `Bearer ${privateKey}`,
                     },
                 });
+                const { fieldToRemove } = response.data;
                 try {
                     const queryResult = yield targetPool.query(response.data.query);
-                    return queryResult;
+                    return Object.assign(Object.assign({}, queryResult), { fields: queryResult.fields.filter(
+                        // @ts-ignore
+                        (field) => field.name !== fieldToRemove), 
+                        // @ts-ignore
+                        rows: queryResult.rows.map((row) => {
+                            delete row[fieldToRemove];
+                            return row;
+                        }) });
                 }
                 catch (err) {
                     return Object.assign(Object.assign({}, err), { 
@@ -47,7 +54,6 @@ module.exports = ({ publicKey, privateKey, databaseConnectionString, stagingData
             if (task === "config") {
                 const response = yield axios.get("https://quill-344421.uc.r.appspot.com/config", {
                     params: {
-                        publicKey,
                         orgId,
                         // @ts-ignore
                         name: metadata === null || metadata === void 0 ? void 0 : metadata.name,
@@ -71,7 +77,6 @@ module.exports = ({ publicKey, privateKey, databaseConnectionString, stagingData
             if (task === "create") {
                 const response = yield axios.post("https://quill-344421.uc.r.appspot.com/item", Object.assign({}, metadata), {
                     params: {
-                        publicKey,
                         orgId,
                     },
                     headers: {
@@ -86,7 +91,6 @@ module.exports = ({ publicKey, privateKey, databaseConnectionString, stagingData
                         params: {
                             id,
                             orgId,
-                            publicKey,
                         },
                         headers: {
                             Authorization: `Bearer ${privateKey}`,
@@ -94,15 +98,22 @@ module.exports = ({ publicKey, privateKey, databaseConnectionString, stagingData
                     });
                     const response = yield axios.post("https://quill-344421.uc.r.appspot.com/validate", { query: resp.data.queryString }, {
                         params: {
-                            publicKey,
                             orgId,
                         },
                         headers: {
                             Authorization: `Bearer ${privateKey}`,
                         },
                     });
+                    const { fieldToRemove } = response.data;
                     const queryResult = yield targetPool.query(response.data.query);
-                    return Object.assign(Object.assign({}, resp.data), { rows: queryResult.rows, fields: queryResult.fields });
+                    return Object.assign(Object.assign({}, resp.data), { fields: queryResult.fields.filter(
+                        // @ts-ignore
+                        (field) => field.name !== fieldToRemove), 
+                        // @ts-ignore
+                        rows: queryResult.rows.map((row) => {
+                            delete row[fieldToRemove];
+                            return row;
+                        }) });
                 }
                 catch (err) {
                     return Object.assign(Object.assign({}, err), { 

package/index.ts

@@ -4,13 +4,21 @@ var PgError = require("pg-error");
 Connection.prototype.parseE = PgError.parse;
 Connection.prototype.parseN = PgError.parse;
 
+const cache : any = {}; //set the cache
+
+function setCache(key : any, value : any) {
+  cache[key] = value;
+}
+
+function getCache(key : any) {
+  return cache[key];
+}
+
 interface QuillConfig {
-  publicKey: string;
   privateKey: string;
   databaseConnectionString: string;
   stagingDatabaseConnectionString?: string;
 }
-
 type FieldFormat =
   | "whole_number"
   | "one_decimal_place"
@@ -23,14 +31,12 @@ type FieldFormat =
   | "hh_ap_pm"
   | "percent"
   | "string";
-
 interface FormattedColumn {
   label: string;
   field: string;
   chartType: string;
   format: FieldFormat;
 }
-
 interface QuillRequestMetadata {
   task: string;
   // a query to be run
@@ -49,16 +55,14 @@ interface QuillRequestMetadata {
   dashboardName?: string;
   columns?: FormattedColumn[];
   dateField?: { table: string; field: string };
+  template?: boolean;
 }
-
 interface QuillQueryParams {
   orgId: string;
   metadata: QuillRequestMetadata;
   environment?: string;
 }
-
 module.exports = ({
-  publicKey,
   privateKey,
   databaseConnectionString,
   stagingDatabaseConnectionString,
@@ -69,7 +73,6 @@ module.exports = ({
   const stagingPool = new Pool({
     connectionString: stagingDatabaseConnectionString,
   });
-
   return {
     query: async ({ orgId, metadata, environment }: QuillQueryParams) => {
       const targetPool = environment === "STAGING" ? stagingPool : pool;
@@ -81,7 +84,6 @@ module.exports = ({
           { query: query },
           {
             params: {
-              publicKey,
               orgId,
             },
             headers: {
@@ -89,9 +91,21 @@ module.exports = ({
             },
           }
         );
+        const { fieldToRemove } = response.data;
         try {
           const queryResult = await targetPool.query(response.data.query);
-          return queryResult;
+          return {
+            ...queryResult,
+            fields: queryResult.fields.filter(
+              // @ts-ignore
+              (field) => field.name !== fieldToRemove
+            ),
+            // @ts-ignore
+            rows: queryResult.rows.map((row) => {
+              delete row[fieldToRemove];
+              return row;
+            }),
+          };
         } catch (err) {
           return {
             // @ts-ignore
@@ -101,13 +115,11 @@ module.exports = ({
           };
         }
       }
-
       if (task === "config") {
         const response = await axios.get(
           "https://quill-344421.uc.r.appspot.com/config",
           {
             params: {
-              publicKey,
               orgId,
               // @ts-ignore
               name: metadata?.name,
@@ -118,19 +130,32 @@ module.exports = ({
           }
         );
         let dashConfig = response.data;
+        let newFilters = [];
+        
         if (dashConfig.filters.length) {
           for (let i = 0; i < dashConfig.filters.length; i++) {
-            // parse query
-            // run query
             const queryResult = await targetPool.query(
               dashConfig.filters[i].query
             );
             const { rows } = queryResult;
-            dashConfig = { options: rows };
+            newFilters.push({ ...dashConfig.filters[i], options: rows });
+            dashConfig.filters[i].options = rows
           }
         }
-        return dashConfig;
-      }
+
+        dashConfig = { ...dashConfig, filters: newFilters };
+
+        const { fieldToRemove, newQueries } = response.data;
+        
+        for (const newQuery of newQueries) { 
+          const { query } = newQuery
+          const cacheKey = `config:${orgId}:${newQuery._id}`;
+          setCache(cacheKey, {fieldToRemove, query});
+        };
+        return {
+            ...dashConfig
+          };
+        } 
 
       if (task === "create") {
         const response = await axios.post(
@@ -138,7 +163,6 @@ module.exports = ({
           { ...metadata },
           {
             params: {
-              publicKey,
               orgId,
             },
             headers: {
@@ -148,41 +172,68 @@ module.exports = ({
         );
         return response.data;
       }
-
       if (task === "item") {
         try {
+
+          const {filters } = metadata;
+
           const resp = await axios.get(
             "https://quill-344421.uc.r.appspot.com/selfhostitem",
             {
               params: {
                 id,
                 orgId,
-                publicKey,
               },
               headers: {
                 Authorization: `Bearer ${privateKey}`,
               },
             }
           );
+          let fieldToRemove : any, query;
+
+          if (getCache(`config:${orgId}:${id}`) && !filters) {
+            getCache(`config:${orgId}:${id}`)
+          }
+
+          if (!filters && getCache(`config:${orgId}:${id}`)) { 
+            ({fieldToRemove, query} = getCache(`config:${orgId}:${id}`)); 
+          }
+          else {
           const response = await axios.post(
             "https://quill-344421.uc.r.appspot.com/validate",
             { query: resp.data.queryString },
             {
               params: {
-                publicKey,
                 orgId,
+                filters
               },
               headers: {
                 Authorization: `Bearer ${privateKey}`,
               },
             }
           );
-          const queryResult = await targetPool.query(response.data.query);
+          ({ fieldToRemove, query } = response.data);
+
+          
+
+            const cacheKey = `config:${orgId}:${id}`; 
+            setCache(cacheKey, {fieldToRemove, query});
+          };
+          const queryResult = await targetPool.query(query);
+          
           return {
             ...resp.data,
-            rows: queryResult.rows,
-            fields: queryResult.fields,
+            fields: queryResult.fields.filter(
+              // @ts-ignore
+              (field) => field.name !== fieldToRemove
+            ),
+            // @ts-ignore
+            rows: queryResult.rows.map((row) => {
+              delete row[fieldToRemove];
+              return row;
+            }),
           };
+
         } catch (err) {
           return {
             // @ts-ignore
@@ -194,4 +245,4 @@ module.exports = ({
       }
     },
   };
-};
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quillsql/node",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Quill SDK for Node.js",
   "main": "dist/index.js",
   "scripts": {