@twin.org/entity-storage-connector-dynamodb 0.0.2-next.9 → 0.0.3-next.10

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 (21) hide show
  1. package/README.md +7 -12
  2. package/dist/{esm/index.mjs → es/dynamoDbEntityStorageConnector.js} +314 -80
  3. package/dist/es/dynamoDbEntityStorageConnector.js.map +1 -0
  4. package/dist/es/index.js +6 -0
  5. package/dist/es/index.js.map +1 -0
  6. package/dist/es/models/IDynamoDbEntityStorageConnectorConfig.js +4 -0
  7. package/dist/es/models/IDynamoDbEntityStorageConnectorConfig.js.map +1 -0
  8. package/dist/es/models/IDynamoDbEntityStorageConnectorConstructorOptions.js +2 -0
  9. package/dist/es/models/IDynamoDbEntityStorageConnectorConstructorOptions.js.map +1 -0
  10. package/dist/types/dynamoDbEntityStorageConnector.d.ts +46 -12
  11. package/dist/types/index.d.ts +3 -3
  12. package/dist/types/models/IDynamoDbEntityStorageConnectorConfig.d.ts +5 -1
  13. package/dist/types/models/IDynamoDbEntityStorageConnectorConstructorOptions.d.ts +5 -1
  14. package/docs/changelog.md +230 -36
  15. package/docs/examples.md +96 -1
  16. package/docs/reference/classes/DynamoDbEntityStorageConnector.md +162 -30
  17. package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConfig.md +19 -11
  18. package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConstructorOptions.md +12 -4
  19. package/locales/en.json +16 -2
  20. package/package.json +17 -14
  21. package/dist/cjs/index.cjs +0 -751
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,13 @@ 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
+ ## Docker
12
12
 
13
- The tests developed are functional tests and need an instance of DynamoDB up and running. To run DynamoDB locally:
13
+ To perform testing of this component it may be necessary to launch a local instance to communicate with.
14
14
 
15
- ```sh
16
- docker run -p 8500:8000 --name twin-entity-storage-dynamodb --hostname dynamodb -d amazon/dynamodb-local
17
- ```
18
-
19
- Afterwards you can run the tests as follows:
20
-
21
- ```sh
22
- npm run test
15
+ ```shell
16
+ docker pull amazon/dynamodb-local:latest
17
+ docker run -d --name twin-entity-storage-dynamodb -p 10000:8000 amazon/dynamodb-local:latest
23
18
  ```
24
19
 
25
20
  ## Examples