chore: support both es-module and commonjs

Author: yamatatsu

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-          - '18'
+          - "18"
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -21,4 +21,4 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
-      - run: npm test
+      - run: npm test run

.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
           node-version: 18
           registry-url: "https://registry.npmjs.org"
       - run: npm ci
-      - run: npm test
+      - run: npm test run
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -8,3 +8,5 @@ node_modules/
 
 lib/*.js
 test/*.js
+
+dist

index.ts

@@ -0,0 +1,3 @@
+import { AthenaQuery } from "./lib/athena-query";
+
+export default AthenaQuery;

jest.config.js

@@ -1,4 +1,3 @@
-import { setTimeout } from "node:timers/promises";
 import {
   Athena,
   Datum,
@@ -16,9 +15,9 @@ async function startQueryExecution(params: {
   const output = await params.athena.startQueryExecution({
     QueryString: params.sql,
     ExecutionParameters: params.executionParameters,
-    WorkGroup: params.workgroup,
+    WorkGroup: params.workgroup || "primary",
     QueryExecutionContext: {
-      Database: params.db,
+      Database: params.db || "default",
       Catalog: params.catalog,
     },
   });
@@ -46,7 +45,7 @@ async function waitExecutionCompleted(params: {
   } else if (state === "FAILED") {
     throw new Error(reason);
   } else {
-    await setTimeout(200);
+    await wait(200);
     await waitExecutionCompleted(params);
   }
 }
@@ -147,4 +146,6 @@ async function getDataTypes(
   return columnInfoObject;
 }
 
+const wait = (ms: number) => new Promise((res) => setTimeout(res, ms));
+
 export { startQueryExecution, waitExecutionCompleted, getQueryResults };

lib/helper.ts

@@ -2,8 +2,9 @@
   "name": "@classmethod/athena-query",
   "version": "0.2.1",
   "description": "Athena-Query makes it easier to execute SQL queries on Amazon Athena by consolidating & abstracting several methods in the AWS SDK",
-  "main": "./lib/index.js",
-  "types": "./lib/index.ts",
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.esm.mjs",
+  "types": "./dist/index.d.ts",
   "author": "Classmethod, Inc.",
   "license": "MIT",
   "repository": {
@@ -27,18 +28,19 @@
     "lib"
   ],
   "scripts": {
-    "build": "tsc",
-    "pretest": "npm run build",
-    "test": "jest"
+    "build": "rm -rf dist && rollup -c",
+    "test": "vitest"
   },
   "devDependencies": {
     "@aws-sdk/client-athena": "^3.218.0",
-    "@types/jest": "^29.2.3",
+    "@rollup/plugin-commonjs": "^23.0.3",
     "@types/node": "^18.11.9",
     "aws-sdk-client-mock": "^2.0.1",
-    "jest": "^29.3.1",
     "prettier": "^2.8.0",
-    "typescript": "^4.9.3"
+    "rollup": "^3.5.0",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "typescript": "^4.9.3",
+    "vitest": "^0.25.3"
   },
   "peerDependencies": {
     "@aws-sdk/client-athena": "^3.218.0"

lib/index.ts

@@ -0,0 +1,17 @@
+import commonjs from "@rollup/plugin-commonjs";
+import typescript from "rollup-plugin-typescript2";
+
+export default {
+  input: "index.ts",
+  output: [
+    {
+      file: "dist/index.esm.mjs",
+    },
+    {
+      file: "dist/index.cjs.js",
+      format: "cjs",
+      exports: "default",
+    },
+  ],
+  plugins: [typescript({ exclude: ["test/**"] }), commonjs()],
+};

package-lock.json

@@ -1,3 +1,4 @@
+import { beforeEach, test, expect } from "vitest";
 import {
   Athena,
   AthenaClient,

package.json

@@ -1,4 +1,5 @@
 {
+  "exclude": ["dist", "examples"],
   "compilerOptions": {
     /* Visit https://aka.ms/tsconfig to read more about this file */
 
@@ -25,9 +26,9 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
     /* Modules */
-    "module": "commonjs" /* Specify what module code is generated. */,
+    "module": "esnext" /* Specify what module code is generated. */,
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
@@ -44,12 +45,12 @@
     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
 
     /* Emit */
-    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
     // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
     // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    "outDir": "dist" /* Specify an output folder for all emitted files. */,
     // "removeComments": true,                           /* Disable emitting comments. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
@@ -65,7 +66,7 @@
     // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
     // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
     // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "declarationDir": "." /* Specify the output directory for generated declaration files. */,
     // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
 
     /* Interop Constraints */