Merge pull request #15 from allen-munsch/typescript-typing

Adds an initial typescript typing

index.d.ts

@@ -0,0 +1,49 @@
+declare module 'athena-express' {
+    import * as aws from 'aws-sdk';
+    interface ConnectionConfigInterface {
+        aws: typeof aws;
+        s3: string;
+        getStats: boolean;
+        db: string,
+        workgroup: string,
+        formatJson: boolean,
+        retry: number,
+        ignoreEmpty: boolean,
+        encryption: Record<string, string>,
+        skipResults: boolean,
+        waitForResults: boolean
+    }
+
+    interface QueryResultsInterface<T> {
+        Items: T[];
+        DataScannedInMB: number;
+        QueryCostInUSD: number;
+        EngineExecutionTimeInMillis: number;
+        S3Location: string;
+        QueryExecutionId: string;
+        Count: number;
+        DataScannedInBytes: number;
+        TotalExecutionTimeInMillis: number;
+        QueryQueueTimeInMillis: number;
+        QueryPlanningTimeInMillis: number;
+        ServiceProcessingTimeInMillis: number;
+    }
+
+    interface QueryObjectInterface {
+        sql: string;
+        db: string;
+    }
+    type DirectQueryString = string;
+    type QueryExecutionId = string;
+
+    type OptionalQueryResultsInterface<T> = Partial<QueryResultsInterface<T>> & Pick<QueryResultsInterface<T>, 'QueryExecutionId'>;
+    type QueryResult<T> = OptionalQueryResultsInterface<T>;
+    type QueryFunc<T> = (query: QueryObjectInterface|DirectQueryString|QueryExecutionId) => Promise<QueryResult<T>>;
+
+    class AthenaExpress {
+        public new: (config: Partial<ConnectionConfigInterface>) => any;
+        public query: QueryFunc;
+        constructor(config: Partial<ConnectionConfigInterface>);
+        query: QueryFunc;
+    }
+}

package.json

@@ -3,6 +3,7 @@
   "version": "6.0.2",
   "description": "Athena-Express makes it easier to execute SQL queries on Amazon Athena by consolidating & astracting several methods in the AWS SDK",
   "main": "./lib/index.js",
+  "types": "./index.d.ts",
   "scripts": {
     "test": "node ./node_modules/mocha/bin/mocha",
     "coveralls": "istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage",