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

package/docs/reference/classes/DynamoDbEntityStorageConnector.md

@@ -34,45 +34,51 @@ The options for the connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
+## Methods
 
-`IEntityStorageConnector.CLASS_NAME`
+### className() {#classname}
 
-## Methods
+> **className**(): `string`
 
-### bootstrap()
+Returns the class name of the component.
 
-> **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+#### Returns
 
-Bootstrap the component by creating and initializing any resources it needs.
+`string`
 
-#### Parameters
+The class name of the component.
 
-##### nodeLoggingComponentType?
+#### Implementation of
 
-`string`
+`IEntityStorageConnector.className`
 
-The node logging component type.
+***
+
+### health() {#health}
+
+> **health**(): `Promise`\<`IHealth`[]\>
+
+Returns the health status of the component.
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`Promise`\<`IHealth`[]\>
 
-True if the bootstrapping process was successful.
+The health status of the component.
 
 #### Implementation of
 
-`IEntityStorageConnector.bootstrap`
+`IEntityStorageConnector.health`
 
 ***
 
-### getSchema()
+### getSchema() {#getschema}
 
 > **getSchema**(): `IEntitySchema`
 
@@ -90,9 +96,35 @@ The schema for the entities.
 
 ***
 
-### get()
+### bootstrap() {#bootstrap}
+
+> **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
 
-> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`undefined` \| `T`\>
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### Implementation of
+
+`IEntityStorageConnector.bootstrap`
+
+***
+
+### get() {#get}
+
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
 Get an entity.
 
@@ -118,7 +150,7 @@ The optional conditions to match for the entities.
 
 #### Returns
 
-`Promise`\<`undefined` \| `T`\>
+`Promise`\<`T` \| `undefined`\>
 
 The object if it can be found or undefined.
 
@@ -128,7 +160,7 @@ The object if it can be found or undefined.
 
 ***
 
-### set()
+### set() {#set}
 
 > **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
@@ -160,7 +192,51 @@ The id of the entity.
 
 ***
 
-### remove()
+### setBatch() {#setbatch}
+
+> **setBatch**(`entities`): `Promise`\<`void`\>
+
+Set multiple entities in a batch.
+
+#### Parameters
+
+##### entities
+
+`T`[]
+
+The entities to set.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageConnector.setBatch`
+
+***
+
+### empty() {#empty}
+
+> **empty**(): `Promise`\<`void`\>
+
+Empty the entity storage.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageConnector.empty`
+
+***
+
+### remove() {#remove}
 
 > **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
@@ -192,9 +268,61 @@ Nothing.
 
 ***
 
-### query()
+### removeBatch() {#removebatch}
+
+> **removeBatch**(`ids`): `Promise`\<`void`\>
+
+Remove multiple entities by their IDs in a batch.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+The ids of the entities to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
 
-> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
+`IEntityStorageConnector.removeBatch`
+
+***
+
+### teardown() {#teardown}
+
+> **teardown**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Teardown the entity storage by deleting the underlying table.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the teardown process was successful.
+
+#### Implementation of
+
+`IEntityStorageConnector.teardown`
+
+***
+
+### query() {#query}
+
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Find all the entities which match the conditions.
 
@@ -222,9 +350,9 @@ The optional properties to return, defaults to all.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 
@@ -243,14 +371,18 @@ and a cursor which can be used to request more entities.
 
 ***
 
-### tableDelete()
+### count() {#count}
 
-> **tableDelete**(): `Promise`\<`void`\>
+> **count**(): `Promise`\<`number`\>
 
-Delete the table.
+Count all the entities which match the conditions.
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`number`\>
 
-Nothing.
+The total count of entities in the storage.
+
+#### Implementation of
+
+`IEntityStorageConnector.count`

package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConfig.md

@@ -4,7 +4,7 @@ Configuration for the Dynamo DB Entity Storage Connector.
 
 ## Properties
 
-### region
+### region {#region}
 
 > **region**: `string`
 
@@ -12,9 +12,9 @@ The region for the AWS connection.
 
 ***
 
-### authMode?
+### authMode? {#authmode}
 
-> `optional` **authMode**: `"credentials"` \| `"pod"`
+> `optional` **authMode?**: `"credentials"` \| `"pod"`
 
 The authentication mode.
 - "credentials": Use access key ID and secret access key.
@@ -28,23 +28,23 @@ credentials
 
 ***
 
-### accessKeyId?
+### accessKeyId? {#accesskeyid}
 
-> `optional` **accessKeyId**: `string`
+> `optional` **accessKeyId?**: `string`
 
 The AWS access key ID.
 
 ***
 
-### secretAccessKey?
+### secretAccessKey? {#secretaccesskey}
 
-> `optional` **secretAccessKey**: `string`
+> `optional` **secretAccessKey?**: `string`
 
 The AWS secret access key.
 
 ***
 
-### tableName
+### tableName {#tablename}
 
 > **tableName**: `string`
 
@@ -52,8 +52,16 @@ The name of the table for the storage.
 
 ***
 
-### endpoint?
+### endpoint? {#endpoint}
 
-> `optional` **endpoint**: `string`
+> `optional` **endpoint?**: `string`
 
-AWS endpoint, not usually required but could be used for local DynamoDB instance e.g. http://localhost:8500.
+AWS endpoint, not usually required but could be used for local DynamoDB instance e.g. http://localhost:10000.
+
+***
+
+### connectionTimeoutMs? {#connectiontimeoutms}
+
+> `optional` **connectionTimeoutMs?**: `number`
+
+The connection timeout in milliseconds.

package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConstructorOptions.md

@@ -4,7 +4,7 @@ Options for the Dynamo DB Entity Storage Connector constructor.
 
 ## Properties
 
-### entitySchema
+### entitySchema {#entityschema}
 
 > **entitySchema**: `string`
 
@@ -12,15 +12,23 @@ The schema for the entity
 
 ***
 
-### loggingComponentType?
+### partitionContextIds? {#partitioncontextids}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **partitionContextIds?**: `string`[]
+
+The keys to use from the context ids to create partitions.
+
+***
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
 
 The type of logging component to use, defaults to no logging.
 
 ***
 
-### config
+### config {#config}
 
 > **config**: [`IDynamoDbEntityStorageConnectorConfig`](IDynamoDbEntityStorageConnectorConfig.md)
 

package/locales/en.json

@@ -3,7 +3,9 @@
 		"dynamoDbEntityStorageConnector": {
 			"tableCreating": "Creating table \"{tableName}\"",
 			"tableCreated": "Created table \"{tableName}\"",
-			"tableExists": "Skipping create table \"{tableName}\" as it already exists"
+			"tableExists": "Skipping create table \"{tableName}\" as it already exists",
+			"tableDeleting": "Deleting table \"{tableName}\"",
+			"tableDeleted": "Table \"{tableName}\" deleted"
 		}
 	},
 	"error": {
@@ -17,7 +19,19 @@
 			"comparisonNotSupported": "Comparison operator \"{comparison}\" is not supported",
 			"conditionalNotSupported": "Conditional operator \"{operator}\" is not supported",
 			"sortSingle": "You can only sort by a single property",
-			"sortNotIndexed": "The property \"{property}\" is not indexed and cannot be used for sorting"
+			"sortNotIndexed": "The property \"{property}\" is not indexed and cannot be used for sorting",
+			"propertyNotFound": "The property \"{property}\" was not found on the entity schema",
+			"setBatchFailed": "Unable to set batch of entities",
+			"removeBatchFailed": "Unable to remove batch of entities",
+			"emptyFailed": "Unable to empty entity storage",
+			"countFailed": "Unable to count entities",
+			"teardownFailed": "Unable to teardown entity storage"
+		}
+	},
+	"health": {
+		"dynamoDbEntityStorageConnector": {
+			"healthDescription": "Checks if the DynamoDB connection is available",
+			"connectionFailed": "Failed to connect to DynamoDB"
 		}
 	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/entity-storage-connector-dynamodb",
-	"version": "0.0.2-next.9",
-	"description": "Entity Storage connector implementation using DynamoDb storage",
+	"version": "0.0.3-next.10",
+	"description": "Amazon DynamoDB connector for managed NoSQL persistence.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"url": "git+https://github.com/iotaledger/entity-storage.git",
 		"directory": "packages/entity-storage-connector-dynamodb"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,29 +14,28 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@aws-sdk/client-dynamodb": "3.896",
-		"@aws-sdk/lib-dynamodb": "3.896",
-		"@aws-sdk/util-dynamodb": "3.896",
+		"@aws-sdk/client-dynamodb": "3.1017",
+		"@aws-sdk/lib-dynamodb": "3.1017",
+		"@aws-sdk/util-dynamodb": "3.996",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.2-next.9",
+		"@twin.org/entity-storage-models": "0.0.3-next.10",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -55,5 +54,9 @@
 		"connector",
 		"adapter",
 		"integration"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/iotaledger/entity-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }