# projectn-bolt-aws-typescript-sdk

> The official Project N Bolt TypeScript client library

Latest version **1.0.0** (published 2021-07-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install projectn-bolt-aws-typescript-sdk
pnpm add projectn-bolt-aws-typescript-sdk
yarn add projectn-bolt-aws-typescript-sdk
bun add projectn-bolt-aws-typescript-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-07-14 |
| First published | 2021-06-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 41.5 KB |
| Known vulnerabilities | 0 (+24 in 2 direct dependencies) |
| Install scripts | no |
| Author | Project N |
| Maintainers | madhu.polu |

## Links

- npm: https://www.npmjs.com/package/projectn-bolt-aws-typescript-sdk
- npm.io page: https://npm.io/package/projectn-bolt-aws-typescript-sdk

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.936.0
- [@aws-sdk/client-s3](https://npm.io/package/@aws-sdk/client-s3.md) ^3.18.0

## Recent versions

- 1.0.0 (latest) — 2021-07-14
- 1.0.0-alpha.8 — 2021-07-03
- 1.0.0-alpha.7 — 2021-06-30
- 1.0.0-alpha.6 — 2021-06-30
- 1.0.0-alpha.5 — 2021-06-30
- 1.0.0-alpha.4 — 2021-06-30
- 1.0.0-alpha.3 — 2021-06-29
- 1.0.0-alpha.2 — 2021-06-27
- 1.0.0-alpha.1 — 2021-06-27

## README

# TypeScript SDK for Bolt

This SDK provides an authentication solution for programatically interacting with Bolt. It wraps the AWS S3 client class so project wide integration is as easy as refactoring `const { S3Client } = require("@aws-sdk/client-s3")` to `import { BoltS3Client } from "./BoltS3Client"`.

The package affects the signing and routing protocol of the AWS S3 client, therefore any non S3 clients created through this SDK will be un-affected by the wrapper.

## Install the SDK

```shell
npm i projectn-bolt-aws-typescript-sdk
```

## Using Typescript SDK for Bolt

Import the SDK into your project:

```shell
import { BoltS3Client } from "projectn-bolt-aws-typescript-sdk";
```

## Set up  Bolt Client

Replace the following in your application:
```shell
const client = new S3Client({});
```

with
```shell
const client = new BoltS3Client({});
```

## Configuration

For the client to work it must have knowledge of Bolt's *region* and *url*

The URL must be formatted as follows:

`https://<subdomain>{region}<domain>`

An example is:

`https://bolt.{region}.google.com`

Where the `{region}` within the URL is a string literal placeholder that will be replaced by the python sdk

**To expose Bolt's URL to the SDK:**

1. Declare the ENV variable: `BOLT_URL`

```bash
export BOLT_URL="<url>"
```

**There are two ways to expose Bolt's region to the SDK:**

1. If running on an EC2 instance the SDK will by default use that EC2s region
2. With the ENV variable: `AWS_REGION`.
```bash
export AWS_REGION='<region>'
```

---
_Source: https://npm.io/package/projectn-bolt-aws-typescript-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._