@quillsql/node 0.4.3 → 0.4.4

package/dist/db/DatabaseHelper.d.ts

@@ -7,7 +7,6 @@ import { SnowflakeConnectionConfig } from "./Snowflake";
 import { BigQueryConfig } from "./BigQuery";
 import { MysqlConnectionConfig } from "./Mysql";
 export declare enum DatabaseType {
-    postgres = "postgres",
     postgresql = "postgresql",
     snowflake = "snowflake",
     bigquery = "bigquery",

package/dist/db/DatabaseHelper.js

@@ -16,7 +16,6 @@ const BigQuery_1 = require("./BigQuery");
 const Mysql_1 = require("./Mysql");
 var DatabaseType;
 (function (DatabaseType) {
-    DatabaseType["postgres"] = "postgres";
     DatabaseType["postgresql"] = "postgresql";
     DatabaseType["snowflake"] = "snowflake";
     DatabaseType["bigquery"] = "bigquery";

package/dist/index.d.ts

@@ -6,12 +6,28 @@ import { DatabaseType } from "./db/DatabaseHelper";
 /**
  * Quill - Fullstack API Platform for Dashboards and Reporting.
  */
+export interface QuillQueryResult {
+    data?: any;
+    status: string;
+    error?: string;
+    queries?: {
+        rows: any[];
+        fields: any[];
+    };
+}
 export default class QuillClass {
     targetConnection: CachedConnection;
     private baseUrl;
     private config;
-    constructor(privateKey: string, databaseType: DatabaseType, databaseConnectionString?: string, databaseCredentials?: any, cache?: Partial<CacheCredentials>, metadataServerURL?: string);
-    query({ orgId, metadata }: QuillQueryParams): Promise<any>;
+    constructor(data: {
+        privateKey: string;
+        databaseType: DatabaseType;
+        databaseConnectionString?: string;
+        databaseConfig?: any;
+        cache?: Partial<CacheCredentials>;
+        metadataServerURL?: string;
+    });
+    query({ orgId, metadata, }: QuillQueryParams): Promise<QuillQueryResult>;
     private runQueries;
     private postQuill;
     close(): Promise<void>;

package/dist/index.js

@@ -21,20 +21,18 @@ const schemaConversion_1 = require("./utils/schemaConversion");
 const HOST = process.env.ENV === "development"
     ? "http://localhost:8080"
     : "https://quill-344421.uc.r.appspot.com";
-/**
- * Quill - Fullstack API Platform for Dashboards and Reporting.
- */
 class QuillClass {
-    constructor(privateKey, databaseType, databaseConnectionString, databaseCredentials, cache = {}, metadataServerURL) {
+    constructor(data) {
+        const { privateKey, databaseType, databaseConnectionString, databaseConfig, cache, metadataServerURL, } = data;
         this.baseUrl = metadataServerURL ? metadataServerURL : HOST;
         this.config = { headers: { Authorization: `Bearer ${privateKey}` } };
-        let credentials = databaseCredentials;
+        let credentials = databaseConfig;
         if (databaseConnectionString) {
             credentials = (0, DatabaseHelper_1.getDatabaseCredentials)(databaseType, databaseConnectionString);
         }
-        this.targetConnection = new CachedConnection_1.CachedConnection(databaseType, credentials, cache);
+        this.targetConnection = new CachedConnection_1.CachedConnection(databaseType, credentials, cache || {});
     }
-    query({ orgId, metadata }) {
+    query({ orgId, metadata, }) {
         var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             this.targetConnection.orgId = orgId;
@@ -169,7 +167,14 @@ class QuillClass {
 }
 exports.default = QuillClass;
 const Quill = ({ privateKey, databaseConnectionString, databaseConfig, cache, databaseType, metadataServerURL, }) => {
-    return new QuillClass(privateKey, databaseType, databaseConnectionString, databaseConfig, cache, metadataServerURL);
+    return new QuillClass({
+        privateKey,
+        databaseType,
+        databaseConnectionString,
+        databaseConfig,
+        cache,
+        metadataServerURL,
+    });
 };
 module.exports = Quill;
 module.exports.Quill = Quill;
@@ -183,3 +188,4 @@ module.exports.getColumnInfoBySchemaByDatabase =
     DatabaseHelper_1.getColumnInfoBySchemaByDatabase;
 module.exports.connectToDatabase = DatabaseHelper_1.connectToDatabase;
 module.exports.runQueryByDatabase = DatabaseHelper_1.runQueryByDatabase;
+module.exports.DatabaseType = DatabaseHelper_1.DatabaseType;

package/dist/index.uspec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/index.uspec.js

@@ -1,39 +1,41 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = __importDefault(require("."));
-const DatabaseHelper_1 = require("./db/DatabaseHelper");
-jest.mock(".");
-describe("Quill", () => {
-    let quill;
-    beforeEach(() => {
-        quill = new _1.default("dummy_private_key", DatabaseHelper_1.DatabaseType.postgres, "dummy_db_url", {}, undefined);
-        quill.targetConnection.query = jest.fn().mockResolvedValue([]);
-    });
-    describe("query", () => {
-        it("return nothing when suppling no queries", () => {
-            const metadata = {
-                task: "test",
-                queries: [],
-            };
-            const result = quill.query({
-                orgId: "dummy",
-                metadata,
-            });
-            expect(result).resolves.toEqual([]);
-        });
-        it("returns an error for the improper query", () => {
-            const metadata = {
-                task: "test",
-                queries: ["SELECT * FROM test"],
-            };
-            const result = quill.query({
-                orgId: "dummy",
-                metadata,
-            });
-        });
-    });
-    // Add more test cases as needed
-});
+// import Quill from ".";
+// import { DatabaseType } from "./db/DatabaseHelper";
+// jest.mock(".");
+// describe("Quill", () => {
+//   let quill: Quill;
+//   beforeEach(() => {
+//     quill = new Quill(
+//       "dummy_private_key",
+//       DatabaseType.postgres,
+//       "dummy_db_url",
+//       {},
+//       undefined
+//     );
+//     quill.targetConnection.query = jest.fn().mockResolvedValue([]);
+//   });
+//   describe("query", () => {
+//     it("return nothing when suppling no queries", () => {
+//       const metadata = {
+//         task: "test",
+//         queries: [],
+//       };
+//       const result = quill.query({
+//         orgId: "dummy",
+//         metadata,
+//       });
+//       expect(result).resolves.toEqual([]);
+//     });
+//     it("returns an error for the improper query", () => {
+//       const metadata = {
+//         task: "test",
+//         queries: ["SELECT * FROM test"],
+//       };
+//       const result = quill.query({
+//         orgId: "dummy",
+//         metadata,
+//       });
+//     });
+//   });
+//   // Add more test cases as needed
+// });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quillsql/node",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "Quill's client SDK for node backends.",
   "main": "dist/index.js",
   "module": "./dist/index.js",

package/src/db/DatabaseHelper.ts

@@ -52,7 +52,6 @@ import {
 } from "./Mysql";
 
 export enum DatabaseType {
-  postgres = "postgres",
   postgresql = "postgresql",
   snowflake = "snowflake",
   bigquery = "bigquery",

package/src/index.ts

@@ -31,6 +31,13 @@ const HOST =
  * Quill - Fullstack API Platform for Dashboards and Reporting.
  */
 
+export interface QuillQueryResult {
+  data?: any;
+  status: string;
+  error?: string;
+  queries?: { rows: any[]; fields: any[] };
+}
+
 export default class QuillClass {
   // Configure cached connection pools with the given config.
   public targetConnection;
@@ -41,17 +48,25 @@ export default class QuillClass {
     };
   };
 
-  constructor(
-    privateKey: string,
-    databaseType: DatabaseType,
-    databaseConnectionString?: string,
-    databaseCredentials?: any,
-    cache: Partial<CacheCredentials> = {},
-    metadataServerURL?: string
-  ) {
+  constructor(data: {
+    privateKey: string;
+    databaseType: DatabaseType;
+    databaseConnectionString?: string;
+    databaseConfig?: any;
+    cache?: Partial<CacheCredentials>;
+    metadataServerURL?: string;
+  }) {
+    const {
+      privateKey,
+      databaseType,
+      databaseConnectionString,
+      databaseConfig,
+      cache,
+      metadataServerURL,
+    } = data;
     this.baseUrl = metadataServerURL ? metadataServerURL : HOST;
     this.config = { headers: { Authorization: `Bearer ${privateKey}` } };
-    let credentials = databaseCredentials;
+    let credentials = databaseConfig;
     if (databaseConnectionString) {
       credentials = getDatabaseCredentials(
         databaseType,
@@ -61,11 +76,14 @@ export default class QuillClass {
     this.targetConnection = new CachedConnection(
       databaseType,
       credentials,
-      cache
+      cache || {}
     );
   }
 
-  public async query({ orgId, metadata }: QuillQueryParams): Promise<any> {
+  public async query({
+    orgId,
+    metadata,
+  }: QuillQueryParams): Promise<QuillQueryResult> {
     this.targetConnection.orgId = orgId;
     try {
       const preQueryResults = metadata.preQueries
@@ -256,14 +274,14 @@ const Quill = ({
   databaseConfig: any;
   metadataServerURL?: string;
 }) => {
-  return new QuillClass(
+  return new QuillClass({
     privateKey,
     databaseType,
     databaseConnectionString,
     databaseConfig,
     cache,
-    metadataServerURL
-  );
+    metadataServerURL,
+  });
 };
 
 module.exports = Quill;
@@ -278,3 +296,4 @@ module.exports.getColumnInfoBySchemaByDatabase =
   getColumnInfoBySchemaByDatabase;
 module.exports.connectToDatabase = connectToDatabase;
 module.exports.runQueryByDatabase = runQueryByDatabase;
+module.exports.DatabaseType = DatabaseType;

package/src/index.uspec.ts

@@ -1,45 +1,45 @@
-import Quill from ".";
-import { DatabaseType } from "./db/DatabaseHelper";
+// import Quill from ".";
+// import { DatabaseType } from "./db/DatabaseHelper";
 
-jest.mock(".");
+// jest.mock(".");
 
-describe("Quill", () => {
-  let quill: Quill;
+// describe("Quill", () => {
+//   let quill: Quill;
 
-  beforeEach(() => {
-    quill = new Quill(
-      "dummy_private_key",
-      DatabaseType.postgres,
-      "dummy_db_url",
-      {},
-      undefined
-    );
-    quill.targetConnection.query = jest.fn().mockResolvedValue([]);
-  });
+//   beforeEach(() => {
+//     quill = new Quill(
+//       "dummy_private_key",
+//       DatabaseType.postgres,
+//       "dummy_db_url",
+//       {},
+//       undefined
+//     );
+//     quill.targetConnection.query = jest.fn().mockResolvedValue([]);
+//   });
 
-  describe("query", () => {
-    it("return nothing when suppling no queries", () => {
-      const metadata = {
-        task: "test",
-        queries: [],
-      };
-      const result = quill.query({
-        orgId: "dummy",
-        metadata,
-      });
-      expect(result).resolves.toEqual([]);
-    });
-    it("returns an error for the improper query", () => {
-      const metadata = {
-        task: "test",
-        queries: ["SELECT * FROM test"],
-      };
-      const result = quill.query({
-        orgId: "dummy",
-        metadata,
-      });
-    });
-  });
+//   describe("query", () => {
+//     it("return nothing when suppling no queries", () => {
+//       const metadata = {
+//         task: "test",
+//         queries: [],
+//       };
+//       const result = quill.query({
+//         orgId: "dummy",
+//         metadata,
+//       });
+//       expect(result).resolves.toEqual([]);
+//     });
+//     it("returns an error for the improper query", () => {
+//       const metadata = {
+//         task: "test",
+//         queries: ["SELECT * FROM test"],
+//       };
+//       const result = quill.query({
+//         orgId: "dummy",
+//         metadata,
+//       });
+//     });
+//   });
 
-  // Add more test cases as needed
-});
+//   // Add more test cases as needed
+// });