https://github.com/iac-factory/s3-sdk-example
https://github.com/iac-factory/s3-sdk-example
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/iac-factory/s3-sdk-example
- Owner: iac-factory
- Created: 2022-05-08T19:25:54.000Z (about 3 years ago)
- Default Branch: Development
- Last Pushed: 2023-06-13T13:14:48.000Z (almost 2 years ago)
- Last Synced: 2025-02-08T17:44:56.162Z (4 months ago)
- Language: TypeScript
- Size: 91.8 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# S3 (Private, Local Library) #
- [ ] Implement `Interface.put()` Functionality
- [ ] Implement Interactive Stream (See Below)
## Usage ##
```typescript
import { File } from "./interface";
const interface = new File();
await interface.get({
Bucket: "aws-s3-example-bucket-name",
Key: "example-file.zip"
});
```
## Interactive Stream ##
```js
import fs from "fs";
import http from "http";
import https from "https";
import URI from "url";
import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
import Client from "./client.js";
const Service = await new Client().instantiate();
class Payload {
/*** @type {Client} */
client = Service;
/*** @type {import("@aws-sdk/types").StringSigner | string} */
url = null;
/*** @type {number} */
expiration= 900;
/*** @type {{headers?: OutgoingHttpHeaders | undefined, setHost?: boolean | undefined, lookup?: LookupFunction | undefined, agent: boolean, socketPath?: string | undefined, method: string, auth?: string | null | undefined, createConnection?: ((options: ClientRequestArgs, oncreate: (err: Error, socket: Socket) => void) => Socket) | undefined, timeout?: number | undefined, maxHeaderSize?: number | undefined, defaultPort?: number | string | undefined, rejectUnauthorized: boolean, path: string | null | undefined, protocol?: string | null | undefined, hostname?: string | null | undefined, _defaultAgent?: Agent | undefined, port, localAddress?: string | undefined, requestCert: boolean, host, family?: number | undefined, signal?: AbortSignal | undefined}} */
settings = null;
/***
*
* @param expiration {number}
*
*/
constructor(expiration = 900) {
this.expiration = expiration;
}
/***
*
* @param $ {PathLike | string}
*
* @returns {WriteStream}
*
*/
static stream = ($) => fs.createWriteStream($);
/***
*
* @param command {import("@aws-sdk/types").Command}
*
* @param expiration {number} Expiration Delta (Units are in milliseconds)
*
* @returns {Promise}
*
*/
async generate(command) {
this.url = await getSignedUrl(this.client, command, {
expiresIn: this.expiration
});
this.settings = this.configuration();
}
/***
* HTTPs Query Configuration Object
* --------------------------------
* @return {{headers?: OutgoingHttpHeaders | undefined, setHost?: boolean | undefined, lookup?: LookupFunction | undefined, agent: boolean, socketPath?: string | undefined, method: string, auth?: string | null | undefined, createConnection?: ((options: ClientRequestArgs, oncreate: (err: Error, socket: Socket) => void) => Socket) | undefined, timeout?: number | undefined, maxHeaderSize?: number | undefined, defaultPort?: number | string | undefined, rejectUnauthorized: boolean, path: string | null | undefined, protocol?: string | null | undefined, hostname?: string | null | undefined, _defaultAgent?: Agent | undefined, port, localAddress?: string | undefined, requestCert: boolean, host, family?: number | undefined, signal?: AbortSignal | undefined}}
*
* @constructor
*
*/
configuration = () => {
const $ = new URI.URL(this.url);
$.rejectUnauthorized = false;
return $;
};
/***
*
* @param local {string} Local File-System Path
* @param progress {boolean}
*
* @returns {Promise}
*
*/
async download(local, progress = true) {
const method = "GET";
const protocol = !this.url.charAt(4)
.localeCompare("s") ? https : http;
const file = Payload.stream(local);
const data = { saved: 0, total: 0, file: null, response: null, request: null };
const handler = (complete = false) => {
const $ = Number.parseInt(data.saved / (1024 ^ 2));
const _ = Number.parseInt(data.total / (1024 ^ 2));
process.stdout.moveCursor(0);
process.stdout.clearLine(0);
process.stdout.write("\r");
(complete) ? process.stdout.write(_ + "/" + _)
: process.stdout.write($ + "/" + _);
process.stdout.write(" ");
(complete) ? process.stdout.write("100.00" + "%")
: process.stdout.write(Number((data.saved / data.total) * 100).toFixed(2) + "%");
};
const $ = new Promise((resolve, reject) => {
const request = protocol.get(this.settings, response => {
if ( response.statusCode !== 200 ) {
reject(new Error(`Failed to get '${ this.settings }' (${ response.statusCode })`));
return;
}
data.file = {
local: local,
mime: response.headers["content-type"],
size: parseInt(response.headers["content-length"], 10)
};
data.request = this.settings;
data.response = {
method: method,
headers: response.headers,
http: response.httpVersion,
status: {
code: response.statusCode,
message: response.statusMessage
}
};
response.on("data", ($) => {
/// --> Chunk
data.saved += $.length;
(progress) && handler();
});
response.pipe(file);
});
file.on("finish", () => {
resolve(data);
});
request.on("error", (error) => {
fs.unlink(local, () => reject(error));
});
request.on("response", ($) => {
data.total = Number.parseInt($.headers["content-length"], 10);
});
file.on("error", (error) => {
fs.unlink(local, () => reject(error));
});
request.end();
});
return await $.then(() => {
(progress) && handler(true);
(progress) && process.stdout.write("\n");
return data;
});
}
}
export { Payload };
export default Payload;
```