@aws/aurora-dsql-postgresjs-connector 0.1.0 → 0.1.1

package/README.md

@@ -1,5 +1,10 @@
 # Aurora DSQL Connector for Postgres.js
 
+[![GitHub](https://img.shields.io/badge/github-awslabs/aurora--dsql--postgres--js--connector-blue?logo=github)](https://github.com/awslabs/aurora-dsql-nodejs-connector/tree/main/packages/postgres-js)
+[![License](https://img.shields.io/badge/license-Apache--2.0-brightgreen)](https://github.com/awslabs/aurora-dsql-nodejs-connector/blob/main/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/@aws/aurora-dsql-postgresjs-connector)](https://www.npmjs.com/package/@aws/aurora-dsql-postgresjs-connector)
+[![Discord chat](https://img.shields.io/discord/1435027294837276802.svg?logo=discord)](https://discord.com/invite/nEF6ksFWru)
+
 The Aurora DSQL Connector for Postgres.js is a Node.js connector built on [Postgres.js](https://github.com/porsager/postgres) 
 that integrates IAM Authentication for connecting JavaScript applications to Amazon Aurora DSQL clusters.
 
@@ -7,7 +12,7 @@ The Aurora DSQL Connector for Postgres.js is designed as an authentication plugi
 Postgres.js client to enable applications to authenticate with Amazon Aurora DSQL using IAM credentials. The connector 
 does not connect directly to the database, but provides seamless IAM authentication on top of the underlying Postgres.js driver.
 
-## Benefits of the Connector
+## About the Connector
 
 Amazon Aurora DSQL is a distributed SQL database service that provides high availability and scalability for 
 PostgreSQL-compatible applications. Aurora DSQL requires IAM-based authentication with time-limited tokens that 
@@ -19,21 +24,33 @@ client that handles IAM token generation, allowing users to connect to Aurora DS
 The Aurora DSQL Connector for Postgres.js works with most versions of Postgres.js. Users provide their own version by installing
 Postgres.js directly.
 
+### What is Aurora DSQL Authentication?
+
+In Aurora DSQL, authentication involves:
+
+- **IAM Authentication:** All connections use IAM-based authentication with time-limited tokens
+- **Token Generation:** Authentication tokens are generated using AWS credentials and have configurable lifetimes
+
+The Aurora DSQL Connector for Postgres.js is designed to understand these requirements and automatically generate IAM authentication tokens when establishing connections.
+
 ### Features
 
 - **Automatic IAM Authentication** - Handles DSQL token generation and refresh
 - **Built on Postgres.js** - Leverages the fast PostgreSQL client for Node.js
+- **Seamless Integration** - Works with existing Postgres.js connection patterns
 - **Region Auto-Discovery** - Extracts AWS region from DSQL cluster hostname
 - **Full TypeScript Support** - Provides full type safety
-- **Custom Credentials** - Support for custom AWS credential providers
+- **AWS Credentials Support** - Supports various AWS credential providers (default, profile-based, custom)
+- **Connection Pooling Compatibility** - Works seamlessly with Postgres.js' built-in connection pooling
 
 ## Quick start guide
 
 ### Requirements
 
 - Node.js 20+
+- [Access to an Aurora DSQL cluster](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/getting-started.html)
+- Set up appropriate IAM permissions to allow your application to connect to Aurora DSQL.
 - AWS credentials configured (via AWS CLI, environment variables, or IAM roles)
-- Access to an Aurora DSQL cluster
 
 ### Installation
 

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { auroraDSQLPostgres } from './client';
-export type { AuroraDSQLConfig } from './client';
+export { auroraDSQLPostgres } from './client.js';
+export type { AuroraDSQLConfig } from './client.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,kBAAkB,EAAC,MAAM,UAAU,CAAC;AAC5C,YAAY,EAAC,gBAAgB,EAAC,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAC;AAC/C,YAAY,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -2,5 +2,5 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-export { auroraDSQLPostgres } from './client';
+export { auroraDSQLPostgres } from './client.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,kBAAkB,EAAC,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws/aurora-dsql-postgresjs-connector",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "An AWS Aurora DSQL connector with IAM authentication for Postgres.js",
   "license": "Apache-2.0",
   "repository": {
@@ -32,7 +32,7 @@
   ],
   "dependencies": {
     "@aws-sdk/credential-providers": "^3.901.0",
-    "@aws-sdk/dsql-signer": "^3.920.0"
+    "@aws-sdk/dsql-signer": "^3.940.0"
   },
   "peerDependencies": {
     "postgres": "^3.4.7"
@@ -40,10 +40,10 @@
   "devDependencies": {
     "@eslint/js": "^9.37.0",
     "@types/jest": "^29.5.14",
-    "@types/node": "^20.19.24",
-    "@typescript-eslint/eslint-plugin": "^8.46.2",
-    "@typescript-eslint/parser": "^8.46.2",
-    "eslint": "^9.38.0",
+    "@types/node": "^20.19.25",
+    "@typescript-eslint/eslint-plugin": "^8.48.0",
+    "@typescript-eslint/parser": "^8.48.0",
+    "eslint": "^9.39.1",
     "eslint-plugin-header": "^3.1.1",
     "jest": "^29.7.0",
     "postgres": "^3.4.7",