Exporting Typescript types

[matthew-gladman-oua]

Describe the bug

Trying to use this project in a typescript project. But it doesn't appear to have exported types, so right now it can't be imported into the project...

Expected Behavior

Types included in the exported package

What plugins are used? What other connection properties were set?

N/A

Current Behavior

No type definitions exported.

You can also tell that that this isn't working quite right in the examples importing in this fashion:

import { AwsPGClient } from "aws-advanced-nodejs-wrapper/dist/pg/lib/index.js";

Reproduction Steps

Install in a Typescript project and try to import the wrapper

Possible Solution

No response

Additional Information/Context

No response

The AWS Advanced NodeJs Wrapper version used

N/A

Node version used

22

Operating System and version

macOS

[karenc-bq]

Hi @matthew-gladman-oua, thank you for raising this, we will be fixing it.

[karenc-bq]

Hi @matthew-gladman-oua, we have released version 2.0.0 of the Wrapper, you should be able to import the Wrapper like so now:

import { AwsPGClient } from "aws-advanced-nodejs-wrapper/pg";
import { FailoverSuccessError } from "aws-advanced-nodejs-wrapper";

Please let us know if you run into more issues.

[matthew-gladman-oua]

Nicely done! I'll give this a whirl later today! <3

[matthew-gladman-oua]

@karenc-bq
I may have prematurely closed the issue. So types appear to be only partially working.

import { AwsPGClient } from 'aws-advanced-nodejs-wrapper/pg';

Works now 🎉

But, it expects the config to be on any and the return type is also any.

// client is `any`, config is `any`
const client = new AwsPGClient({
  connectionString: config.db.connectionString,
  max: config.db.maxConnections,
  min: config.db.minConnections,
});

So it's still challenging to use in a type safe environment.

---

This isn't as directly related to this issue, but seems to be an issue in this 2.0.0 release. There are quite a few dependencies that are not marked as peerDependencies or dependencies and it is causing issues when compiling this in a project (ie, using esbuild). Rendering 2.0.0 quite hard to use in its current state (happy to open this up as a seperate issue)

✘ [ERROR] Could not resolve "aws-xray-sdk"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/utils/telemetry/xray_telemetry_context.js:17:62:
      17 │ import { getNamespace, getSegment, Segment, setSegment } from "aws-xray-sdk";
         ╵                                                               ~~~~~~~~~~~~~~                                                                                                                                                                                         

  You can mark the path "aws-xray-sdk" as external to exclude it from the bundle, which will remove
  this error and leave the unresolved path in the bundle.

✘ [ERROR] Could not resolve "@opentelemetry/sdk-node"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/utils/telemetry/open_telemetry_context.js:19:20:
      19 │ import { api } from "@opentelemetry/sdk-node";
         ╵                     ~~~~~~~~~~~~~~~~~~~~~~~~~                                                                                                                                                                                                                        

  You can mark the path "@opentelemetry/sdk-node" as external to exclude it from the bundle, which
  will remove this error and leave the unresolved path in the bundle.

✘ [ERROR] Could not resolve "@aws-sdk/client-rds"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/plugins/custom_endpoint/custom_endpoint_plugin.js:17:26:
      17 │ import { RDSClient } from "@aws-sdk/client-rds";
         ╵                           ~~~~~~~~~~~~~~~~~~~~~                                                                                                                                                                                                                      

  You can mark the path "@aws-sdk/client-rds" as external to exclude it from the bundle, which will
  remove this error and leave the unresolved path in the bundle.

✘ [ERROR] Could not resolve "tough-cookie"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/plugins/federated_auth/adfs_credentials_provider_factory.js:23:26:
      23 │ import { CookieJar } from "tough-cookie";
         ╵                           ~~~~~~~~~~~~~~                                                                                                                                                                                                                             

  You can mark the path "tough-cookie" as external to exclude it from the bundle, which will remove
  this error and leave the unresolved path in the bundle.

✘ [ERROR] Could not resolve "axios-cookiejar-support"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/plugins/federated_auth/adfs_credentials_provider_factory.js:24:24:
      24 │ import { wrapper } from "axios-cookiejar-support";
         ╵                         ~~~~~~~~~~~~~~~~~~~~~~~~~                                                                                                                                                                                                                    

  You can mark the path "axios-cookiejar-support" as external to exclude it from the bundle, which
  will remove this error and leave the unresolved path in the bundle.

✘ [ERROR] Could not resolve "@aws-sdk/client-sts"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/plugins/federated_auth/saml_credentials_provider_factory.js:16:53:
      16 │ import { AssumeRoleWithSAMLCommand, STSClient } from "@aws-sdk/client-sts";
         ╵                                                      ~~~~~~~~~~~~~~~~~~~~~                                                                                                                                                                                           

  You can mark the path "@aws-sdk/client-sts" as external to exclude it from the bundle, which will
  remove this error and leave the unresolved path in the bundle.

✘ [ERROR] Could not resolve "entities"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/plugins/federated_auth/saml_credentials_provider_factory.js:19:23:
      19 │ import { decode } from "entities";
         ╵                        ~~~~~~~~~~                                                                                                                                                                                                                                    

  You can mark the path "entities" as external to exclude it from the bundle, which will remove this
  error and leave the unresolved path in the bundle.

✘ [ERROR] Could not resolve "http-cookie-agent/http"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/plugins/federated_auth/adfs_credentials_provider_factory.js:25:33:
      25 │ import { HttpsCookieAgent } from "http-cookie-agent/http";
         ╵                                  ~~~~~~~~~~~~~~~~~~~~~~~~                                                                                                                                                                                                            

  You can mark the path "http-cookie-agent/http" as external to exclude it from the bundle, which
  will remove this error and leave the unresolved path in the bundle.

✘ [ERROR] Could not resolve "@aws-sdk/rds-signer"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/utils/iam_auth_utils.js:20:23:
      20 │ import { Signer } from "@aws-sdk/rds-signer";
         ╵                        ~~~~~~~~~~~~~~~~~~~~~                                                                                                                                                                                                                         

  You can mark the path "@aws-sdk/rds-signer" as external to exclude it from the bundle, which will
  remove this error and leave the unresolved path in the bundle.

✘ [ERROR] Could not resolve "@aws-sdk/client-rds"

    ../../node_modules/aws-advanced-nodejs-wrapper/dist/common/lib/plugins/custom_endpoint/custom_endpoint_monitor_impl.js:16:50:
      16 │ import { DescribeDBClusterEndpointsCommand } from "@aws-sdk/client-rds";
         ╵                                                   ~~~~~~~~~~~~~~~~~~~~~                                                                                                                                                                                              

  You can mark the path "@aws-sdk/client-rds" as external to exclude it from the bundle, which will
  remove this error and leave the unresolved path in the bundle.

[matthew-gladman-oua]

Mininum reproduction:

• https://stackblitz.com/edit/stackblitz-starters-nzfjfuv3?file=index.ts

You can run npx esbuild index.ts --bundle in that stack blitz to see the compilation results. If you hover of any of the items you'll see that they are any, and in strict projects this is generally blocked.

[karenc-bq]

Thank you for the repro steps, we will be addressing both of these issues and keep you updated. Thank you for your patience.