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

package/dist/types/dynamoDbEntityStorageConnector.d.ts

@@ -1,6 +1,6 @@
 import { type EntityCondition, type IEntitySchema, SortDirection } from "@twin.org/entity";
 import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
-import type { IDynamoDbEntityStorageConnectorConstructorOptions } from "./models/IDynamoDbEntityStorageConnectorConstructorOptions";
+import type { IDynamoDbEntityStorageConnectorConstructorOptions } from "./models/IDynamoDbEntityStorageConnectorConstructorOptions.js";
 /**
  * Class for performing entity storage operations using Dynamo DB.
  */
@@ -8,23 +8,28 @@ export declare class DynamoDbEntityStorageConnector<T = unknown> implements IEnt
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of DynamoDbEntityStorageConnector.
      * @param options The options for the connector.
      */
     constructor(options: IDynamoDbEntityStorageConnectorConstructorOptions);
     /**
-     * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns True if the bootstrapping process was successful.
+     * Returns the class name of the component.
+     * @returns The class name of the component.
      */
-    bootstrap(nodeLoggingComponentType?: string): Promise<boolean>;
+    className(): string;
     /**
      * Get the schema for the entities.
      * @returns The schema for the entities.
      */
     getSchema(): IEntitySchema;
+    /**
+     * Bootstrap the component by creating and initializing any resources it needs.
+     * @param nodeLoggingComponentType The node logging component type.
+     * @returns True if the bootstrapping process was successful.
+     */
+    bootstrap(nodeLoggingComponentType?: string): Promise<boolean>;
     /**
      * Get an entity.
      * @param id The id of the entity to get, or the index value if secondaryIndex is set.
@@ -61,15 +66,15 @@ export declare class DynamoDbEntityStorageConnector<T = unknown> implements IEnt
      * @param conditions The conditions to match for the entities.
      * @param sortProperties The optional sort order.
      * @param properties The optional properties to return, defaults to all.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
     query(conditions?: EntityCondition<T>, sortProperties?: {
         property: keyof T;
         sortDirection: SortDirection;
-    }[], properties?: (keyof T)[], cursor?: string, pageSize?: number): Promise<{
+    }[], properties?: (keyof T)[], cursor?: string, limit?: number): Promise<{
         /**
          * The entities, which can be partial if a limited keys list was provided.
          */

package/dist/types/index.d.ts

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

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

@@ -26,7 +26,7 @@ export interface IDynamoDbEntityStorageConnectorConfig {
      */
     tableName: 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.
      */
     endpoint?: string;
 }

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

@@ -1,4 +1,4 @@
-import type { IDynamoDbEntityStorageConnectorConfig } from "./IDynamoDbEntityStorageConnectorConfig";
+import type { IDynamoDbEntityStorageConnectorConfig } from "./IDynamoDbEntityStorageConnectorConfig.js";
 /**
  * Options for the Dynamo DB Entity Storage Connector constructor.
  */
@@ -7,6 +7,10 @@ export interface IDynamoDbEntityStorageConnectorConstructorOptions {
      * The schema for the entity
      */
     entitySchema: string;
+    /**
+     * The keys to use from the context ids to create partitions.
+     */
+    partitionContextIds?: string[];
     /**
      * The type of logging component to use, defaults to no logging.
      */

package/docs/changelog.md

@@ -1,5 +1,70 @@
 # @twin.org/entity-storage-connector-dynamodb - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.3-next.1...entity-storage-connector-dynamodb-v0.0.3-next.2) (2025-11-13)
+
+
+### Bug Fixes
+
+* add missing dependency ([3282535](https://github.com/twinfoundation/entity-storage/commit/328253516e0d13b276406fb4de97dab8ee5e8ba7))
+* add missing dependency ([2b848f3](https://github.com/twinfoundation/entity-storage/commit/2b848f3a345522c869b798d7a1cb64112dd8e3e3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.3-next.0...entity-storage-connector-dynamodb-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add AWS pod authentication mode ([caaae36](https://github.com/twinfoundation/entity-storage/commit/caaae368ca104cd9994e1af7b6c4c20e603c2021))
+* add context id features ([#55](https://github.com/twinfoundation/entity-storage/issues/55)) ([99c15a2](https://github.com/twinfoundation/entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
+* add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
+* add synchronised to release configs ([e1e749c](https://github.com/twinfoundation/entity-storage/commit/e1e749cf261b58c8c36729686861e29c7d5e068e))
+* add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
+* eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
+* logging naming consistency ([f99d12d](https://github.com/twinfoundation/entity-storage/commit/f99d12dea04b6d4f2b5632ff5473e9ec7d5f9055))
+* synchronised storage ([#44](https://github.com/twinfoundation/entity-storage/issues/44)) ([94e10e2](https://github.com/twinfoundation/entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+* update docs ([5203e62](https://github.com/twinfoundation/entity-storage/commit/5203e621c3ae368f6fefb29ea5146f024f4a1b0d))
+* update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
+* 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.3-next.0 to 0.0.3-next.1
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.2-next.9...entity-storage-connector-dynamodb-v0.0.2-next.10) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.9 to 0.0.2-next.10
+
 ## [0.0.2-next.9](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-dynamodb-v0.0.2-next.8...entity-storage-connector-dynamodb-v0.0.2-next.9) (2025-10-02)
 
 

package/docs/reference/classes/DynamoDbEntityStorageConnector.md

@@ -36,39 +36,27 @@ The options for the connector.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IEntityStorageConnector.CLASS_NAME`
-
 ## Methods
 
-### bootstrap()
-
-> **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
-
-Bootstrap the component by creating and initializing any resources it needs.
-
-#### Parameters
-
-##### nodeLoggingComponentType?
+### className()
 
-`string`
+> **className**(): `string`
 
-The node logging component type.
+Returns the class name of the component.
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`string`
 
-True if the bootstrapping process was successful.
+The class name of the component.
 
 #### Implementation of
 
-`IEntityStorageConnector.bootstrap`
+`IEntityStorageConnector.className`
 
 ***
 
@@ -90,9 +78,35 @@ The schema for the entities.
 
 ***
 
+### bootstrap()
+
+> **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### Implementation of
+
+`IEntityStorageConnector.bootstrap`
+
+***
+
 ### get()
 
-> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
 Get an entity.
 
@@ -118,7 +132,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.
 
@@ -194,7 +208,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Find all the entities which match the conditions.
 
@@ -222,9 +236,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`
 

package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConfig.md

@@ -56,4 +56,4 @@ The name of the table for the storage.
 
 > `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.

package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConstructorOptions.md

@@ -12,6 +12,14 @@ The schema for the entity
 
 ***
 
+### partitionContextIds?
+
+> `optional` **partitionContextIds**: `string`[]
+
+The keys to use from the context ids to create partitions.
+
+***
+
 ### loggingComponentType?
 
 > `optional` **loggingComponentType**: `string`

package/locales/en.json

@@ -17,7 +17,8 @@
 			"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"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-dynamodb",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.2",
 	"description": "Entity Storage connector implementation using DynamoDb storage",
 	"repository": {
 		"type": "git",
@@ -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.927",
+		"@aws-sdk/lib-dynamodb": "3.927",
+		"@aws-sdk/util-dynamodb": "3.927",
+		"@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.2",
 		"@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/twinfoundation/entity-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }