@travetto/model-s3 3.0.2 → 3.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
<!-- This file was generated by @travetto/doc and should not be modified directly -->
|
|
2
|
-
<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-s3/DOC.
|
|
2
|
+
<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-s3/DOC.tsx and execute "npx trv doc" to rebuild -->
|
|
3
3
|
# S3 Model Support
|
|
4
|
+
|
|
4
5
|
## S3 backing for the travetto model module.
|
|
5
6
|
|
|
6
7
|
**Install: @travetto/model-s3**
|
|
@@ -12,12 +13,14 @@ npm install @travetto/model-s3
|
|
|
12
13
|
yarn add @travetto/model-s3
|
|
13
14
|
```
|
|
14
15
|
|
|
15
|
-
This module provides an [s3](https://aws.amazon.com/documentation/s3/)-based implementation for the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations."). This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and stream against [s3](https://aws.amazon.com/documentation/s3/).
|
|
16
|
+
This module provides an [s3](https://aws.amazon.com/documentation/s3/)-based implementation for the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations."). This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and stream against [s3](https://aws.amazon.com/documentation/s3/).
|
|
16
17
|
|
|
17
|
-
|
|
18
|
-
|
|
18
|
+
Supported features:
|
|
19
|
+
* [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11)
|
|
20
|
+
* [Streaming](https://github.com/travetto/travetto/tree/main/module/model/src/service/stream.ts#L3)
|
|
21
|
+
* [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11)
|
|
22
|
+
Out of the box, by installing the module, everything should be wired up by default.If you need to customize any aspect of the source or config, you can override and register it with the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module.
|
|
19
23
|
|
|
20
|
-
|
|
21
24
|
**Code: Wiring up a custom Model Source**
|
|
22
25
|
```typescript
|
|
23
26
|
import { InjectableFactory } from '@travetto/di';
|
|
@@ -33,9 +36,8 @@ export class Init {
|
|
|
33
36
|
}
|
|
34
37
|
```
|
|
35
38
|
|
|
36
|
-
|
|
39
|
+
where the [S3ModelConfig](https://github.com/travetto/travetto/tree/main/module/model-s3/src/config.ts#L11) is defined by:
|
|
37
40
|
|
|
38
|
-
|
|
39
41
|
**Code: Structure of S3ModelConfig**
|
|
40
42
|
```typescript
|
|
41
43
|
import { fromIni } from '@aws-sdk/credential-provider-ini';
|
|
@@ -99,8 +101,6 @@ export class S3ModelConfig {
|
|
|
99
101
|
}
|
|
100
102
|
```
|
|
101
103
|
|
|
102
|
-
|
|
103
|
-
standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support")resolution paths.
|
|
104
|
-
|
|
104
|
+
Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) annotation, and so these values can be overridden using the standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support") resolution paths.
|
|
105
105
|
|
|
106
106
|
**Note**: Do not commit your `accessKeyId` or `secretAccessKey` values to your source repository, especially if it is public facing. Not only is it a security risk, but Amazon will scan public repos, looking for keys, and if found will react swiftly.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@travetto/model-s3",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.3",
|
|
4
4
|
"description": "S3 backing for the travetto model module.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"s3",
|
|
@@ -27,11 +27,11 @@
|
|
|
27
27
|
"dependencies": {
|
|
28
28
|
"@aws-sdk/client-s3": "^3.272.0",
|
|
29
29
|
"@aws-sdk/credential-provider-ini": "^3.218.0",
|
|
30
|
-
"@travetto/config": "^3.0.
|
|
31
|
-
"@travetto/model": "^3.0.
|
|
30
|
+
"@travetto/config": "^3.0.3",
|
|
31
|
+
"@travetto/model": "^3.0.3"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
|
-
"@travetto/command": "^3.0.
|
|
34
|
+
"@travetto/command": "^3.0.3"
|
|
35
35
|
},
|
|
36
36
|
"peerDependenciesMeta": {
|
|
37
37
|
"@travetto/command": {
|