@twin.org/entity-storage-connector-dynamodb 0.0.1-next.9 → 0.0.2-next.1

package/dist/cjs/index.cjs

@@ -50,9 +50,6 @@ class DynamoDbEntityStorageConnector {
     /**
      * Create a new instance of DynamoDbEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The schema for the entity.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);
@@ -283,9 +280,10 @@ class DynamoDbEntityStorageConnector {
      * @param conditions The optional conditions to match for the entities.
      * @returns The id of the entity.
      */
-    async set(entity, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity);
-        const id = entity[this._primaryKey.property];
+    async set(entity$1, conditions) {
+        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
+        const id = entity$1[this._primaryKey.property];
         try {
             const docClient = this.createDocClient();
             const { conditionExpression, attributeNames, attributeValues } = this.buildConditionExpression(conditions);
@@ -293,15 +291,22 @@ class DynamoDbEntityStorageConnector {
                 TableName: this._config.tableName,
                 Item: {
                     [DynamoDbEntityStorageConnector._PARTITION_ID_NAME]: DynamoDbEntityStorageConnector._PARTITION_ID_VALUE,
-                    ...entity
+                    ...entity$1
                 },
-                ConditionExpression: conditionExpression,
+                // Only set the condition expression if we have conditions to match
+                // and the primary key exists, otherwise we are creating a new object
+                ConditionExpression: core.Is.stringValue(conditionExpression)
+                    ? `(attribute_exists(${this._primaryKey.property}) AND ${conditionExpression}) OR attribute_not_exists(${this._primaryKey.property})`
+                    : undefined,
                 ExpressionAttributeNames: attributeNames,
                 ExpressionAttributeValues: attributeValues
             });
             await docClient.send(putCommand);
         }
         catch (err) {
+            if (core.BaseError.isErrorName(err, "ConditionalCheckFailedException")) {
+                return;
+            }
             if (core.BaseError.isErrorCode(err, "ResourceNotFoundException")) {
                 throw new core.GeneralError(this.CLASS_NAME, "tableDoesNotExist", {
                     tableName: this._config.tableName
@@ -440,6 +445,14 @@ class DynamoDbEntityStorageConnector {
         }
         prop += comparator.property;
         let attributeName = this.populateAttributeNames(prop, attributeNames);
+        if (core.Is.empty(comparator.value)) {
+            if (comparator.comparison === entity.ComparisonOperator.Equals) {
+                return `attribute_not_exists(${attributeName})`;
+            }
+            else if (comparator.comparison === entity.ComparisonOperator.NotEquals) {
+                return `attribute_exists(${attributeName})`;
+            }
+        }
         let propName = `:${attributeName.replace(/\./g, "").replace(/#/g, "")}`;
         if (core.Is.array(comparator.value)) {
             const dbValues = comparator.value.map(v => this.propertyToDbValue(v, type));
@@ -563,7 +576,7 @@ class DynamoDbEntityStorageConnector {
     }
     /**
      * Create a new DB connection.
-     * @returns The dynamo db connection.
+     * @returns The Dynamo DB connection.
      * @internal
      */
     createConnection() {
@@ -571,7 +584,7 @@ class DynamoDbEntityStorageConnector {
     }
     /**
      * Create a new DB connection configuration.
-     * @returns The dynamo db connection configuration.
+     * @returns The Dynamo DB connection configuration.
      * @internal
      */
     createConnectionConfig() {
@@ -620,6 +633,7 @@ class DynamoDbEntityStorageConnector {
                 : undefined;
             // If we have a sortable property defined in the descriptor then we must use
             // the secondary index for the query
+            let scanAscending = true;
             if (core.Is.arrayValue(sortProperties)) {
                 if (sortProperties.length > 1) {
                     throw new core.GeneralError(this.CLASS_NAME, "sortSingle");
@@ -637,6 +651,7 @@ class DynamoDbEntityStorageConnector {
                     indexName = propertySchema.isPrimary
                         ? undefined
                         : `${sortProperty.property}Index`;
+                    scanAscending = sortProperty.sortDirection === entity.SortDirection.Ascending;
                 }
             }
             const attributeNames = { "#partitionId": "partitionId" };
@@ -661,6 +676,7 @@ class DynamoDbEntityStorageConnector {
                 ExpressionAttributeValues: attributeValues,
                 ProjectionExpression: properties?.map(p => p).join(", "),
                 Limit: returnSize,
+                ScanIndexForward: scanAscending,
                 ExclusiveStartKey: core.Is.empty(cursor)
                     ? undefined
                     : core.ObjectHelper.fromBytes(core.Converter.base64ToBytes(cursor))
@@ -669,7 +685,11 @@ class DynamoDbEntityStorageConnector {
             const results = await connection.send(query);
             let entities = [];
             if (core.Is.arrayValue(results.Items)) {
-                entities = results.Items.map(item => utilDynamodb.unmarshall(item));
+                entities = results.Items.map(item => {
+                    const unmarshalled = utilDynamodb.unmarshall(item);
+                    delete unmarshalled[DynamoDbEntityStorageConnector._PARTITION_ID_NAME];
+                    return unmarshalled;
+                });
             }
             return {
                 entities,

package/dist/esm/index.mjs

@@ -2,7 +2,7 @@ import { waitUntilTableExists, DynamoDB, QueryCommand } from '@aws-sdk/client-dy
 import { GetCommand, PutCommand, DeleteCommand, DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
 import { unmarshall } from '@aws-sdk/util-dynamodb';
 import { Guards, Is, BaseError, GeneralError, Coerce, ObjectHelper, Converter } from '@twin.org/core';
-import { EntitySchemaFactory, EntitySchemaHelper, ComparisonOperator, LogicalOperator } from '@twin.org/entity';
+import { EntitySchemaFactory, EntitySchemaHelper, ComparisonOperator, LogicalOperator, SortDirection } from '@twin.org/entity';
 import { LoggingConnectorFactory } from '@twin.org/logging-models';
 
 // Copyright 2024 IOTA Stiftung.
@@ -48,9 +48,6 @@ class DynamoDbEntityStorageConnector {
     /**
      * Create a new instance of DynamoDbEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The schema for the entity.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);
@@ -283,6 +280,7 @@ class DynamoDbEntityStorageConnector {
      */
     async set(entity, conditions) {
         Guards.object(this.CLASS_NAME, "entity", entity);
+        EntitySchemaHelper.validateEntity(entity, this.getSchema());
         const id = entity[this._primaryKey.property];
         try {
             const docClient = this.createDocClient();
@@ -293,13 +291,20 @@ class DynamoDbEntityStorageConnector {
                     [DynamoDbEntityStorageConnector._PARTITION_ID_NAME]: DynamoDbEntityStorageConnector._PARTITION_ID_VALUE,
                     ...entity
                 },
-                ConditionExpression: conditionExpression,
+                // Only set the condition expression if we have conditions to match
+                // and the primary key exists, otherwise we are creating a new object
+                ConditionExpression: Is.stringValue(conditionExpression)
+                    ? `(attribute_exists(${this._primaryKey.property}) AND ${conditionExpression}) OR attribute_not_exists(${this._primaryKey.property})`
+                    : undefined,
                 ExpressionAttributeNames: attributeNames,
                 ExpressionAttributeValues: attributeValues
             });
             await docClient.send(putCommand);
         }
         catch (err) {
+            if (BaseError.isErrorName(err, "ConditionalCheckFailedException")) {
+                return;
+            }
             if (BaseError.isErrorCode(err, "ResourceNotFoundException")) {
                 throw new GeneralError(this.CLASS_NAME, "tableDoesNotExist", {
                     tableName: this._config.tableName
@@ -438,6 +443,14 @@ class DynamoDbEntityStorageConnector {
         }
         prop += comparator.property;
         let attributeName = this.populateAttributeNames(prop, attributeNames);
+        if (Is.empty(comparator.value)) {
+            if (comparator.comparison === ComparisonOperator.Equals) {
+                return `attribute_not_exists(${attributeName})`;
+            }
+            else if (comparator.comparison === ComparisonOperator.NotEquals) {
+                return `attribute_exists(${attributeName})`;
+            }
+        }
         let propName = `:${attributeName.replace(/\./g, "").replace(/#/g, "")}`;
         if (Is.array(comparator.value)) {
             const dbValues = comparator.value.map(v => this.propertyToDbValue(v, type));
@@ -561,7 +574,7 @@ class DynamoDbEntityStorageConnector {
     }
     /**
      * Create a new DB connection.
-     * @returns The dynamo db connection.
+     * @returns The Dynamo DB connection.
      * @internal
      */
     createConnection() {
@@ -569,7 +582,7 @@ class DynamoDbEntityStorageConnector {
     }
     /**
      * Create a new DB connection configuration.
-     * @returns The dynamo db connection configuration.
+     * @returns The Dynamo DB connection configuration.
      * @internal
      */
     createConnectionConfig() {
@@ -618,6 +631,7 @@ class DynamoDbEntityStorageConnector {
                 : undefined;
             // If we have a sortable property defined in the descriptor then we must use
             // the secondary index for the query
+            let scanAscending = true;
             if (Is.arrayValue(sortProperties)) {
                 if (sortProperties.length > 1) {
                     throw new GeneralError(this.CLASS_NAME, "sortSingle");
@@ -635,6 +649,7 @@ class DynamoDbEntityStorageConnector {
                     indexName = propertySchema.isPrimary
                         ? undefined
                         : `${sortProperty.property}Index`;
+                    scanAscending = sortProperty.sortDirection === SortDirection.Ascending;
                 }
             }
             const attributeNames = { "#partitionId": "partitionId" };
@@ -659,6 +674,7 @@ class DynamoDbEntityStorageConnector {
                 ExpressionAttributeValues: attributeValues,
                 ProjectionExpression: properties?.map(p => p).join(", "),
                 Limit: returnSize,
+                ScanIndexForward: scanAscending,
                 ExclusiveStartKey: Is.empty(cursor)
                     ? undefined
                     : ObjectHelper.fromBytes(Converter.base64ToBytes(cursor))
@@ -667,7 +683,11 @@ class DynamoDbEntityStorageConnector {
             const results = await connection.send(query);
             let entities = [];
             if (Is.arrayValue(results.Items)) {
-                entities = results.Items.map(item => unmarshall(item));
+                entities = results.Items.map(item => {
+                    const unmarshalled = unmarshall(item);
+                    delete unmarshalled[DynamoDbEntityStorageConnector._PARTITION_ID_NAME];
+                    return unmarshalled;
+                });
             }
             return {
                 entities,

package/dist/types/dynamoDbEntityStorageConnector.d.ts

@@ -1,6 +1,6 @@
-import { type EntityCondition, type IEntitySchema, type SortDirection } from "@twin.org/entity";
+import { type EntityCondition, type IEntitySchema, SortDirection } from "@twin.org/entity";
 import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
-import type { IDynamoDbEntityStorageConnectorConfig } from "./models/IDynamoDbEntityStorageConnectorConfig";
+import type { IDynamoDbEntityStorageConnectorConstructorOptions } from "./models/IDynamoDbEntityStorageConnectorConstructorOptions";
 /**
  * Class for performing entity storage operations using Dynamo DB.
  */
@@ -12,15 +12,8 @@ export declare class DynamoDbEntityStorageConnector<T = unknown> implements IEnt
     /**
      * Create a new instance of DynamoDbEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The schema for the entity.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
-     * @param options.config The configuration for the connector.
      */
-    constructor(options: {
-        entitySchema: string;
-        loggingConnectorType?: string;
-        config: IDynamoDbEntityStorageConnectorConfig;
-    });
+    constructor(options: IDynamoDbEntityStorageConnectorConstructorOptions);
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./dynamoDbEntityStorageConnector";
 export * from "./models/IDynamoDbEntityStorageConnectorConfig";
+export * from "./models/IDynamoDbEntityStorageConnectorConstructorOptions";

package/dist/types/models/IDynamoDbEntityStorageConnectorConstructorOptions.d.ts

@@ -0,0 +1,18 @@
+import type { IDynamoDbEntityStorageConnectorConfig } from "./IDynamoDbEntityStorageConnectorConfig";
+/**
+ * Options for the Dynamo DB Entity Storage Connector constructor.
+ */
+export interface IDynamoDbEntityStorageConnectorConstructorOptions {
+    /**
+     * The schema for the entity
+     */
+    entitySchema: string;
+    /**
+     * The type of logging connector to use, defaults to no logging.
+     */
+    loggingConnectorType?: string;
+    /**
+     * The configuration for the connector.
+     */
+    config: IDynamoDbEntityStorageConnectorConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,134 @@
 # @twin.org/entity-storage-connector-dynamodb - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.2-next.0...entity-storage-connector-dynamodb-v0.0.2-next.1) (2025-07-17)
+
+
+### Features
+
+* add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+* update docs ([5203e62](https://github.com/twinfoundation/entity-storage/commit/5203e621c3ae368f6fefb29ea5146f024f4a1b0d))
+* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
+
+
+### Bug Fixes
+
+* query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.0 to 0.0.2-next.1
+
+## 0.0.1 (2025-07-04)
+
+
+### Features
+
+* add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
+* release to production ([a309051](https://github.com/twinfoundation/entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+* update docs ([5203e62](https://github.com/twinfoundation/entity-storage/commit/5203e621c3ae368f6fefb29ea5146f024f4a1b0d))
+* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
+
+
+### Bug Fixes
+
+* query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from ^0.0.0 to ^0.0.1
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.31](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.1-next.30...entity-storage-connector-dynamodb-v0.0.1-next.31) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.30 to 0.0.1-next.31
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.30 to 0.0.1-next.31
+
+## [0.0.1-next.30](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.1-next.29...entity-storage-connector-dynamodb-v0.0.1-next.30) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.1-next.28...entity-storage-connector-dynamodb-v0.0.1-next.29) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.1-next.27...entity-storage-connector-dynamodb-v0.0.1-next.28) (2025-04-09)
+
+
+### Features
+
+* update docs ([5203e62](https://github.com/twinfoundation/entity-storage/commit/5203e621c3ae368f6fefb29ea5146f024f4a1b0d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.27 to 0.0.1-next.28
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.27 to 0.0.1-next.28
+
+## [0.0.1-next.27](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.1-next.26...entity-storage-connector-dynamodb-v0.0.1-next.27) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-dynamodb:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.26 to 0.0.1-next.27
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.26 to 0.0.1-next.27
+
+## v0.0.1-next.26
 
 - Initial Release

package/docs/reference/classes/DynamoDbEntityStorageConnector.md

@@ -4,7 +4,9 @@ Class for performing entity storage operations using Dynamo DB.
 
 ## Type Parameters
 
-• **T** = `unknown`
+### T
+
+`T` = `unknown`
 
 ## Implements
 
@@ -12,33 +14,23 @@ Class for performing entity storage operations using Dynamo DB.
 
 ## Constructors
 
-### new DynamoDbEntityStorageConnector()
+### Constructor
 
-> **new DynamoDbEntityStorageConnector**\<`T`\>(`options`): [`DynamoDbEntityStorageConnector`](DynamoDbEntityStorageConnector.md)\<`T`\>
+> **new DynamoDbEntityStorageConnector**\<`T`\>(`options`): `DynamoDbEntityStorageConnector`\<`T`\>
 
 Create a new instance of DynamoDbEntityStorageConnector.
 
 #### Parameters
 
-• **options**
-
-The options for the connector.
-
-• **options.entitySchema**: `string`
+##### options
 
-The schema for the entity.
+[`IDynamoDbEntityStorageConnectorConstructorOptions`](../interfaces/IDynamoDbEntityStorageConnectorConstructorOptions.md)
 
-• **options.loggingConnectorType?**: `string`
-
-The type of logging connector to use, defaults to no logging.
-
-• **options.config**: [`IDynamoDbEntityStorageConnectorConfig`](../interfaces/IDynamoDbEntityStorageConnectorConfig.md)
-
-The configuration for the connector.
+The options for the connector.
 
 #### Returns
 
-[`DynamoDbEntityStorageConnector`](DynamoDbEntityStorageConnector.md)\<`T`\>
+`DynamoDbEntityStorageConnector`\<`T`\>
 
 ## Properties
 
@@ -56,13 +48,15 @@ Runtime name for the class.
 
 ### bootstrap()
 
-> **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+> **bootstrap**(`nodeLoggingConnectorType?`): `Promise`\<`boolean`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -80,13 +74,13 @@ True if the bootstrapping process was successful.
 
 ### getSchema()
 
-> **getSchema**(): `IEntitySchema`\<`unknown`\>
+> **getSchema**(): `IEntitySchema`
 
 Get the schema for the entities.
 
 #### Returns
 
-`IEntitySchema`\<`unknown`\>
+`IEntitySchema`
 
 The schema for the entities.
 
@@ -98,21 +92,27 @@ The schema for the entities.
 
 ### get()
 
-> **get**(`id`, `secondaryIndex`?, `conditions`?): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`undefined` \| `T`\>
 
 Get an entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to get, or the index value if secondaryIndex is set.
 
-• **secondaryIndex?**: keyof `T`
+##### secondaryIndex?
+
+keyof `T`
 
 Get the item using a secondary index.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -130,17 +130,21 @@ The object if it can be found or undefined.
 
 ### set()
 
-> **set**(`entity`, `conditions`?): `Promise`\<`void`\>
+> **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
 Set an entity.
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to set.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -158,17 +162,21 @@ The id of the entity.
 
 ### remove()
 
-> **remove**(`id`, `conditions`?): `Promise`\<`void`\>
+> **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
 Remove the entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to remove.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -186,51 +194,49 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Find all the entities which match the conditions.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<`T`\>
+##### conditions?
+
+`EntityCondition`\<`T`\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **properties?**: keyof `T`[]
+##### properties?
+
+keyof `T`[]
 
 The optional properties to return, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
 
-##### entities
-
-> **entities**: `Partial`\<`T`\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.
-
 #### Implementation of
 
 `IEntityStorageConnector.query`

package/docs/reference/index.md

@@ -7,3 +7,4 @@
 ## Interfaces
 
 - [IDynamoDbEntityStorageConnectorConfig](interfaces/IDynamoDbEntityStorageConnectorConfig.md)
+- [IDynamoDbEntityStorageConnectorConstructorOptions](interfaces/IDynamoDbEntityStorageConnectorConstructorOptions.md)

package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConstructorOptions.md

@@ -0,0 +1,27 @@
+# Interface: IDynamoDbEntityStorageConnectorConstructorOptions
+
+Options for the Dynamo DB Entity Storage Connector constructor.
+
+## Properties
+
+### entitySchema
+
+> **entitySchema**: `string`
+
+The schema for the entity
+
+***
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+***
+
+### config
+
+> **config**: [`IDynamoDbEntityStorageConnectorConfig`](IDynamoDbEntityStorageConnectorConfig.md)
+
+The configuration for the connector.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-dynamodb",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Entity Storage connector implementation using DynamoDb storage",
 	"repository": {
 		"type": "git",
@@ -14,12 +14,12 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@aws-sdk/client-dynamodb": "3.656",
-		"@aws-sdk/lib-dynamodb": "3.656",
-		"@aws-sdk/util-dynamodb": "3.656",
+		"@aws-sdk/client-dynamodb": "3.844",
+		"@aws-sdk/lib-dynamodb": "3.844",
+		"@aws-sdk/util-dynamodb": "3.844",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.1-next.9",
+		"@twin.org/entity-storage-models": "0.0.2-next.1",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
@@ -28,11 +28,11 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",