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

package/docs/examples.md

@@ -1 +1,96 @@
-# @twin.org/entity-storage-connector-dynamodb - Examples
+# Entity Storage Connector DynamoDB Examples
+
+These examples show a complete flow from connector setup through reads, writes, filtered queries, and table maintenance tasks.
+
+## DynamoDbEntityStorageConnector
+
+```typescript
+import {
+  DynamoDbEntityStorageConnector,
+  type IDynamoDbEntityStorageConnectorConstructorOptions
+} from '@twin.org/entity-storage-connector-dynamodb';
+import {
+  ComparisonOperator,
+  LogicalOperator,
+  SortDirection,
+  type EntityCondition
+} from '@twin.org/entity';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+const options: IDynamoDbEntityStorageConnectorConstructorOptions = {
+  entitySchema: 'Profile',
+  config: {
+    region: 'eu-west-1',
+    authMode: 'credentials',
+    accessKeyId: 'local-access-key',
+    secretAccessKey: 'local-secret-key',
+    tableName: 'profiles',
+    endpoint: 'http://localhost:10000'
+  }
+};
+
+const connector = new DynamoDbEntityStorageConnector<Profile>(options);
+await connector.bootstrap();
+
+const className = connector.className();
+const schema = connector.getSchema();
+
+await connector.set({
+  id: 'profile-1',
+  email: 'ada@example.com',
+  status: 'active',
+  createdAt: '2026-03-09T10:30:00.000Z'
+});
+
+const byPrimaryKey = await connector.get('profile-1');
+const bySecondaryIndex = await connector.get('ada@example.com', 'email');
+
+const activeCondition: EntityCondition<Profile> = {
+  logicalOperator: LogicalOperator.And,
+  conditions: [
+    {
+      property: 'status',
+      comparison: ComparisonOperator.Equals,
+      value: 'active'
+    }
+  ]
+};
+
+const result = await connector.query(
+  activeCondition,
+  [{ property: 'createdAt', sortDirection: SortDirection.Descending }],
+  ['id', 'email', 'status'],
+  undefined,
+  25
+);
+
+await connector.remove('profile-1');
+```
+
+```typescript
+import { DynamoDbEntityStorageConnector } from '@twin.org/entity-storage-connector-dynamodb';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+const connector = new DynamoDbEntityStorageConnector<Profile>({
+  entitySchema: 'Profile',
+  config: {
+    region: 'eu-west-1',
+    authMode: 'pod',
+    tableName: 'profiles'
+  }
+});
+
+await connector.bootstrap('logging');
+```

package/docs/reference/classes/DynamoDbEntityStorageConnector.md

@@ -10,7 +10,7 @@ Class for performing entity storage operations using Dynamo DB.
 
 ## Implements
 
-- `IEntityStorageConnector`\<`T`\>
+- `IEntityStorageMigrationConnector`\<`T`\>
 
 ## Constructors
 
@@ -34,7 +34,7 @@ The options for the connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -42,7 +42,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -56,11 +56,29 @@ The class name of the component.
 
 #### Implementation of
 
-`IEntityStorageConnector.className`
+`IEntityStorageMigrationConnector.className`
 
 ***
 
-### getSchema()
+### health() {#health}
+
+> **health**(): `Promise`\<`IHealth`[]\>
+
+Returns the health status of the component.
+
+#### Returns
+
+`Promise`\<`IHealth`[]\>
+
+The health status of the component.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.health`
+
+***
+
+### getSchema() {#getschema}
 
 > **getSchema**(): `IEntitySchema`
 
@@ -74,11 +92,11 @@ The schema for the entities.
 
 #### Implementation of
 
-`IEntityStorageConnector.getSchema`
+`IEntityStorageMigrationConnector.getSchema`
 
 ***
 
-### bootstrap()
+### bootstrap() {#bootstrap}
 
 > **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
 
@@ -100,11 +118,11 @@ True if the bootstrapping process was successful.
 
 #### Implementation of
 
-`IEntityStorageConnector.bootstrap`
+`IEntityStorageMigrationConnector.bootstrap`
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
@@ -138,11 +156,11 @@ The object if it can be found or undefined.
 
 #### Implementation of
 
-`IEntityStorageConnector.get`
+`IEntityStorageMigrationConnector.get`
 
 ***
 
-### set()
+### set() {#set}
 
 > **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
@@ -170,11 +188,55 @@ The id of the entity.
 
 #### Implementation of
 
-`IEntityStorageConnector.set`
+`IEntityStorageMigrationConnector.set`
+
+***
+
+### 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
+
+`IEntityStorageMigrationConnector.setBatch`
 
 ***
 
-### remove()
+### empty() {#empty}
+
+> **empty**(): `Promise`\<`void`\>
+
+Empty the entity storage.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.empty`
+
+***
+
+### remove() {#remove}
 
 > **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
@@ -202,11 +264,63 @@ Nothing.
 
 #### Implementation of
 
-`IEntityStorageConnector.remove`
+`IEntityStorageMigrationConnector.remove`
+
+***
+
+### 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
+
+`IEntityStorageMigrationConnector.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
+
+`IEntityStorageMigrationConnector.teardown`
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
@@ -253,18 +367,168 @@ and a cursor which can be used to request more entities.
 
 #### Implementation of
 
-`IEntityStorageConnector.query`
+`IEntityStorageMigrationConnector.query`
+
+***
+
+### count() {#count}
+
+> **count**(`conditions?`): `Promise`\<`number`\>
+
+Count all the entities which match the conditions.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<`T`\>
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The total count of entities in the storage.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.count`
+
+***
+
+### getPartitionContextIds() {#getpartitioncontextids}
+
+> **getPartitionContextIds**(): `Promise`\<`IContextIds`[]\>
+
+Get a unique list of all the context ids from the storage.
+
+#### Returns
+
+`Promise`\<`IContextIds`[]\>
+
+The list of unique context ids.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.getPartitionContextIds`
+
+***
+
+### createTargetConnector() {#createtargetconnector}
+
+> **createTargetConnector**\<`U`\>(`newEntitySchema`): `Promise`\<`IEntityStorageConnector`\<`U`\>\>
+
+Create the target connector for performing the migration it will use a temporary storage location.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### newEntitySchema
+
+`string`
+
+The name of the new entity schema to create the connector for.
+
+#### Returns
+
+`Promise`\<`IEntityStorageConnector`\<`U`\>\>
+
+Connector for performing the migration.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.createTargetConnector`
 
 ***
 
-### tableDelete()
+### finalizeMigration() {#finalizemigration}
 
-> **tableDelete**(): `Promise`\<`void`\>
+> **finalizeMigration**\<`U`\>(`targetConnector`, `options?`, `loggingComponentType?`): `Promise`\<`DynamoDbEntityStorageConnector`\<`U`\>\>
 
-Delete the table.
+Finalize the migration by tearing down the old connector and replacing it with the new one.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
+
+`DynamoDbEntityStorageConnector`\<`U`\>
+
+The target connector to finalize the migration with.
+
+##### options?
+
+`IMigrationOptions`\<`T`, `U`\>
+
+The options to control how the migration is finalized.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type to use for logging during the migration finalization.
+
+#### Returns
+
+`Promise`\<`DynamoDbEntityStorageConnector`\<`U`\>\>
+
+A promise that resolves when the migration is finalized.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.finalizeMigration`
+
+***
+
+### cleanupMigration() {#cleanupmigration}
+
+> **cleanupMigration**\<`U`\>(`targetConnector`, `options?`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Cleanup the migration if a migration fails or needs to be aborted.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
+
+`IEntityStorageConnector`\<`U`\> \| `undefined`
+
+The target connector to cleanup the migration with.
+
+##### options?
+
+`IMigrationOptions`\<`T`, `U`\>
+
+The options to control how the migration is cleaned up.
+
+##### loggingComponentType?
+
+`string`
+
+The optional component type to use for logging the migration progress.
 
 #### Returns
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the migration is cleaned up.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.cleanupMigration`

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,25 @@ 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:10000.
+
+***
+
+### connectionTimeoutMs? {#connectiontimeoutms}
+
+> `optional` **connectionTimeoutMs?**: `number`
+
+The connection timeout in milliseconds.
+
+***
+
+### maxAttempts? {#maxattempts}
+
+> `optional` **maxAttempts?**: `number`
+
+Maximum number of attempts for each SDK request (1 = no retries).
+Defaults to the AWS SDK default (3).

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,23 +12,23 @@ The schema for the entity
 
 ***
 
-### partitionContextIds?
+### partitionContextIds? {#partitioncontextids}
 
-> `optional` **partitionContextIds**: `string`[]
+> `optional` **partitionContextIds?**: `string`[]
 
 The keys to use from the context ids to create partitions.
 
 ***
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `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": {
@@ -18,7 +20,20 @@
 			"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",
-			"propertyNotFound": "The property \"{property}\" was not found on the entity schema"
+			"propertyNotFound": "The property \"{property}\" was not found on the entity schema",
+			"getPartitionContextIdsFailed": "Unable to get partition context ids",
+			"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",
+			"finalizeMigrationFailedBootstrap": "Finalizing migration failed during bootstrap phase"
+		}
+	},
+	"health": {
+		"dynamoDbEntityStorageConnector": {
+			"healthDescription": "Checks if the DynamoDB table \"{tableName}\" is available",
+			"connectionFailed": "Failed to connect to DynamoDB table \"{tableName}\""
 		}
 	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/entity-storage-connector-dynamodb",
-	"version": "0.0.3-next.2",
-	"description": "Entity Storage connector implementation using DynamoDb storage",
+	"version": "0.0.3-next.21",
+	"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/twin-entity-storage.git",
 		"directory": "packages/entity-storage-connector-dynamodb"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,13 +14,13 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@aws-sdk/client-dynamodb": "3.927",
-		"@aws-sdk/lib-dynamodb": "3.927",
-		"@aws-sdk/util-dynamodb": "3.927",
+		"@aws-sdk/client-dynamodb": "3.1050",
+		"@aws-sdk/lib-dynamodb": "3.1050",
+		"@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.3-next.2",
+		"@twin.org/entity-storage-models": "0.0.3-next.21",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
@@ -56,7 +56,7 @@
 		"integration"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/entity-storage/issues"
+		"url": "git+https://github.com/iotaledger/twin-entity-storage/issues"
 	},
 	"homepage": "https://twindev.org"
 }