@aws-sdk/core
This package provides common or core functionality to the AWS SDK for JavaScript (v3).
You do not need to explicitly install this package, since it will be transitively installed by AWS SDK clients.
@aws-sdk/core submodules
Core submodules are organized for distribution via the package.json exports field.
exports is supported by default by the latest Node.js, webpack, and esbuild. For react-native, it can be
enabled via instructions found at reactnative.dev/blog.
Think of @aws-sdk/core as a mono-package within the monorepo.
It preserves the benefits of modularization, for example to optimize Node.js initialization speed,
while making it easier to have a consistent version of core dependencies, reducing package sprawl when
installing an SDK client.
Guide for submodules
- Each
index.tsfile corresponding to the pattern./src/submodules/<MODULE_NAME>/index.tswill be published as a separatedist-cjsbundled submodule index using theInliner.jsbuild script. - create a folder as
./src/submodules/<SUBMODULE>including anindex.tsfile and aREADME.mdfile.- The linter will throw an error on missing submodule metadata in
package.jsonand the varioustsconfig.jsonfiles, but it will automatically fix them if possible.
- The linter will throw an error on missing submodule metadata in
- a submodule is equivalent to a standalone
@aws-sdk/<pkg>package in that importing it in Node.js will resolve a separate bundle. - submodules may not relatively import files from other submodules. Instead, directly use the
@scope/pkg/submodulename as the import.- The linter will check for this and throw an error.
- To the extent possible, correctly declaring submodule metadata is validated by the linter in
@aws-sdk/core. The linter runs duringyarn buildand also asyarn lint.
When should I create an @aws-sdk/core/submodule vs. @aws-sdk/new-package?
Keep in mind that the core package is installed by all AWS SDK clients.
If the component functionality is upstream of multiple clients, it is a good candidate for a core submodule. For example, XML serialization.
If the component's functionality is downstream of a client, for example S3 pre-signing, it should be a standalone package with potentially a peer or runtime dependency on an AWS SDK client.