@twin.org/entity-storage-connector-dynamodb 0.0.3-next.2 → 0.0.3-next.20

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.
Files changed (13) hide show
  1. package/README.md +8 -10
  2. package/dist/es/dynamoDbEntityStorageConnector.js +514 -42
  3. package/dist/es/dynamoDbEntityStorageConnector.js.map +1 -1
  4. package/dist/es/models/IDynamoDbEntityStorageConnectorConfig.js.map +1 -1
  5. package/dist/types/dynamoDbEntityStorageConnector.d.ts +63 -5
  6. package/dist/types/models/IDynamoDbEntityStorageConnectorConfig.d.ts +9 -0
  7. package/docs/changelog.md +445 -55
  8. package/docs/examples.md +96 -1
  9. package/docs/reference/classes/DynamoDbEntityStorageConnector.md +284 -20
  10. package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConfig.md +27 -10
  11. package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConstructorOptions.md +6 -6
  12. package/locales/en.json +17 -2
  13. package/package.json +8 -8
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # TWIN Entity Storage Connector Dynamo DB
1
+ # Entity Storage Connector DynamoDB
2
2
 
3
- Entity Storage connector implementation using Dynamo DB storage.
3
+ This package provides an Amazon DynamoDB backend for managed NoSQL storage in cloud-native deployments. It is designed to work with the wider storage ecosystem so applications can keep behaviour consistent across connectors and environments.
4
4
 
5
5
  ## Installation
6
6
 
@@ -8,18 +8,16 @@ Entity Storage connector implementation using Dynamo DB storage.
8
8
  npm install @twin.org/entity-storage-connector-dynamodb
9
9
  ```
10
10
 
11
- ## Testing
11
+ ## Dependency versions
12
12
 
13
- The tests developed are functional tests and need an instance of DynamoDB up and running. To run DynamoDB locally:
13
+ Published versions pin `@aws-sdk/client-dynamodb` and `@aws-sdk/lib-dynamodb` to releases that are at least 48 hours old on npm, so consumers with a minimum package age policy (for example pnpm `minimumReleaseAge`) can install without resolution failures.
14
14
 
15
- ```sh
16
- docker run -p 10000:8000 --name twin-entity-storage-dynamodb --hostname dynamodb -d amazon/dynamodb-local
17
- ```
15
+ ## Docker
18
16
 
19
- Afterwards you can run the tests as follows:
17
+ To perform testing of this component it may be necessary to launch a local instance to communicate with.
20
18
 
21
- ```sh
22
- npm run test
19
+ ```shell
20
+ docker run -d --name twin-entity-storage-dynamodb -p 18000:8000 amazon/dynamodb-local
23
21
  ```
24
22
 
25
23
  ## Examples