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

package/dist/{esm/index.mjs → es/factories/entityStorageConnectorFactory.js}

@@ -1,11 +1,9 @@
-import { Factory } from '@twin.org/core';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
 /**
  * Factory for creating entity storage connectors.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const EntityStorageConnectorFactory = Factory.createFactory("entity-storage");
-
-export { EntityStorageConnectorFactory };
+export const EntityStorageConnectorFactory = Factory.createFactory("entity-storage");
+//# sourceMappingURL=entityStorageConnectorFactory.js.map

package/dist/es/factories/entityStorageConnectorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityStorageConnectorFactory.js","sourceRoot":"","sources":["../../../src/factories/entityStorageConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,6BAA6B,GACzC,OAAO,CAAC,aAAa,CAA0B,gBAAgB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IEntityStorageConnector } from \"../models/IEntityStorageConnector.js\";\n\n/**\n * Factory for creating entity storage connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EntityStorageConnectorFactory =\n\tFactory.createFactory<IEntityStorageConnector>(\"entity-storage\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,12 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/entityStorageConnectorFactory.js";
+export * from "./models/api/IEntityStorageGetRequest.js";
+export * from "./models/api/IEntityStorageGetResponse.js";
+export * from "./models/api/IEntityStorageListRequest.js";
+export * from "./models/api/IEntityStorageListResponse.js";
+export * from "./models/api/IEntityStorageRemoveRequest.js";
+export * from "./models/api/IEntityStorageSetRequest.js";
+export * from "./models/IEntityStorageComponent.js";
+export * from "./models/IEntityStorageConnector.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,8CAA8C,CAAC;AAC7D,cAAc,0CAA0C,CAAC;AACzD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/entityStorageConnectorFactory.js\";\nexport * from \"./models/api/IEntityStorageGetRequest.js\";\nexport * from \"./models/api/IEntityStorageGetResponse.js\";\nexport * from \"./models/api/IEntityStorageListRequest.js\";\nexport * from \"./models/api/IEntityStorageListResponse.js\";\nexport * from \"./models/api/IEntityStorageRemoveRequest.js\";\nexport * from \"./models/api/IEntityStorageSetRequest.js\";\nexport * from \"./models/IEntityStorageComponent.js\";\nexport * from \"./models/IEntityStorageConnector.js\";\n"]}

package/dist/es/models/IEntityStorageComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEntityStorageComponent.js.map

package/dist/es/models/IEntityStorageComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageComponent.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { EntityCondition, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Interface describing an entity storage component.\n */\nexport interface IEntityStorageComponent<T = unknown> extends IComponent {\n\t/**\n\t * Set an entity.\n\t * @param entity The entity to set.\n\t * @returns The id of the entity.\n\t */\n\tset(entity: T): Promise<void>;\n\n\t/**\n\t * Get an entity.\n\t * @param id The id of the entity to get, or the index value if secondaryIndex is set.\n\t * @param secondaryIndex Get the item using a secondary index.\n\t * @returns The object if it can be found or undefined.\n\t */\n\tget(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;\n\n\t/**\n\t * Remove the entity.\n\t * @param id The id of the entity to remove.\n\t * @returns Nothing.\n\t */\n\tremove(id: string): Promise<void>;\n\n\t/**\n\t * Query all the entities which match the conditions.\n\t * @param conditions The conditions to match for the entities.\n\t * @param orderBy The order for the results.\n\t * @param orderByDirection The direction for the order, defaults to ascending.\n\t * @param properties The optional properties to return, defaults to all.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tquery(\n\t\tconditions?: EntityCondition<T>,\n\t\torderBy?: keyof T,\n\t\torderByDirection?: SortDirection,\n\t\tproperties?: (keyof T)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: Partial<T>[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/IEntityStorageConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEntityStorageConnector.js.map

package/dist/es/models/IEntityStorageConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageConnector.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { EntityCondition, IEntitySchema, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Interface describing an entity storage connector.\n */\nexport interface IEntityStorageConnector<T = unknown> extends IComponent {\n\t/**\n\t * Get the schema for the entities.\n\t * @returns The schema for the entities.\n\t */\n\tgetSchema(): IEntitySchema;\n\n\t/**\n\t * Set an entity.\n\t * @param entity The entity to set.\n\t * @param conditions The optional conditions to match for the entities.\n\t * @returns The id of the entity.\n\t */\n\tset(entity: T, conditions?: { property: keyof T; value: unknown }[]): Promise<void>;\n\n\t/**\n\t * Get an entity.\n\t * @param id The id of the entity to get, or the index value if secondaryIndex is set.\n\t * @param secondaryIndex Get the item using a secondary index.\n\t * @param conditions The optional conditions to match for the entities.\n\t * @returns The object if it can be found or undefined.\n\t */\n\tget(\n\t\tid: string,\n\t\tsecondaryIndex?: keyof T,\n\t\tconditions?: { property: keyof T; value: unknown }[]\n\t): Promise<T | undefined>;\n\n\t/**\n\t * Remove the entity.\n\t * @param id The id of the entity to remove.\n\t * @param conditions The optional conditions to match for the entities.\n\t * @returns Nothing.\n\t */\n\tremove(id: string, conditions?: { property: keyof T; value: unknown }[]): Promise<void>;\n\n\t/**\n\t * Query all the entities which match the conditions.\n\t * @param conditions The conditions to match for the entities.\n\t * @param sortProperties The optional sort order.\n\t * @param properties The optional properties to return, defaults to all.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tquery(\n\t\tconditions?: EntityCondition<T>,\n\t\tsortProperties?: {\n\t\t\tproperty: keyof T;\n\t\t\tsortDirection: SortDirection;\n\t\t}[],\n\t\tproperties?: (keyof T)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: Partial<T>[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/api/IEntityStorageGetRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageGetRequest.js.map

package/dist/es/models/api/IEntityStorageGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageGetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get an entry from entity storage.\n */\nexport interface IEntityStorageGetRequest {\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the entity to get.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The secondary index to query with the id.\n\t\t */\n\t\tsecondaryIndex?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IEntityStorageGetResponse.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageGetResponse.js.map

package/dist/es/models/api/IEntityStorageGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageGetResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get an entry from entity storage.\n */\nexport interface IEntityStorageGetResponse {\n\t/**\n\t * The data for the requested entity.\n\t */\n\tbody: unknown;\n}\n"]}

package/dist/es/models/api/IEntityStorageListRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEntityStorageListRequest.js.map

package/dist/es/models/api/IEntityStorageListRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageListRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SortDirection } from \"@twin.org/entity\";\n\n/**\n * Query the entries from entity storage.\n */\nexport interface IEntityStorageListRequest {\n\t/**\n\t * The parameters from the query.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The condition for the query as JSON version of EntityCondition type.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * The order property for the results.\n\t\t */\n\t\torderBy?: string;\n\n\t\t/**\n\t\t * The direction for the order, defaults to desc.\n\t\t */\n\t\torderByDirection?: SortDirection;\n\n\t\t/**\n\t\t * The properties to return in the response as a comma separated list, by default returns all properties.\n\t\t */\n\t\tproperties?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get next chunk of data, returned in previous response.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IEntityStorageListResponse.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageListResponse.js.map

package/dist/es/models/api/IEntityStorageListResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageListResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageListResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response to getting the list of entries from a query.\n */\nexport interface IEntityStorageListResponse {\n\t/**\n\t * The list of entries from the query.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The entities from the query.\n\t\t */\n\t\tentities: unknown[];\n\n\t\t/**\n\t\t * The cursor for the next page.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IEntityStorageRemoveRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageRemoveRequest.js.map

package/dist/es/models/api/IEntityStorageRemoveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove an entry from entity storage.\n */\nexport interface IEntityStorageRemoveRequest {\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the entity to remove.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IEntityStorageSetRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntityStorageSetRequest.js.map

package/dist/es/models/api/IEntityStorageSetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageSetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IEntityStorageSetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Set an entry in entity storage.\n */\nexport interface IEntityStorageSetRequest {\n\t/**\n\t * The data to be used in the entity.\n\t */\n\tbody: unknown;\n}\n"]}

package/dist/types/factories/entityStorageConnectorFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IEntityStorageConnector } from "../models/IEntityStorageConnector";
+import type { IEntityStorageConnector } from "../models/IEntityStorageConnector.js";
 /**
  * Factory for creating entity storage connectors.
  */

package/dist/types/index.d.ts

@@ -1,9 +1,9 @@
-export * from "./factories/entityStorageConnectorFactory";
-export * from "./models/api/IEntityStorageGetRequest";
-export * from "./models/api/IEntityStorageGetResponse";
-export * from "./models/api/IEntityStorageListRequest";
-export * from "./models/api/IEntityStorageListResponse";
-export * from "./models/api/IEntityStorageRemoveRequest";
-export * from "./models/api/IEntityStorageSetRequest";
-export * from "./models/IEntityStorageComponent";
-export * from "./models/IEntityStorageConnector";
+export * from "./factories/entityStorageConnectorFactory.js";
+export * from "./models/api/IEntityStorageGetRequest.js";
+export * from "./models/api/IEntityStorageGetResponse.js";
+export * from "./models/api/IEntityStorageListRequest.js";
+export * from "./models/api/IEntityStorageListResponse.js";
+export * from "./models/api/IEntityStorageRemoveRequest.js";
+export * from "./models/api/IEntityStorageSetRequest.js";
+export * from "./models/IEntityStorageComponent.js";
+export * from "./models/IEntityStorageConnector.js";

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

@@ -7,38 +7,34 @@ export interface IEntityStorageComponent<T = unknown> extends IComponent {
     /**
      * Set an entity.
      * @param entity The entity to set.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns The id of the entity.
      */
-    set(entity: T, userIdentity?: string): Promise<void>;
+    set(entity: T): Promise<void>;
     /**
      * Get an entity.
      * @param id The id of the entity to get, or the index value if secondaryIndex is set.
      * @param secondaryIndex Get the item using a secondary index.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns The object if it can be found or undefined.
      */
-    get(id: string, secondaryIndex?: keyof T, userIdentity?: string): Promise<T | undefined>;
+    get(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns Nothing.
      */
-    remove(id: string, userIdentity?: string): Promise<void>;
+    remove(id: string): Promise<void>;
     /**
      * Query all the entities which match the conditions.
      * @param conditions The conditions to match for the entities.
      * @param orderBy The order for the results.
      * @param orderByDirection The direction for the order, defaults to ascending.
      * @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 userIdentity The user identity to use with storage operations.
+     * @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>, orderBy?: keyof T, orderByDirection?: SortDirection, properties?: (keyof T)[], cursor?: string, pageSize?: number, userIdentity?: string): Promise<{
+    query(conditions?: EntityCondition<T>, orderBy?: keyof T, orderByDirection?: SortDirection, properties?: (keyof T)[], cursor?: string, limit?: number): Promise<{
         /**
          * The entities, which can be partial if a limited keys list was provided.
          */

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

@@ -45,15 +45,15 @@ export interface IEntityStorageConnector<T = unknown> extends IComponent {
      * @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/models/api/IEntityStorageListRequest.d.ts

@@ -24,9 +24,9 @@ export interface IEntityStorageListRequest {
          */
         properties?: string;
         /**
-         * The number of entries to return per page.
+         * Limit the number of entities to return.
          */
-        pageSize?: number | string;
+        limit?: string;
         /**
          * The cursor to get next chunk of data, returned in previous response.
          */

package/docs/changelog.md

@@ -1,5 +1,38 @@
 # @twin.org/entity-storage-models - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.3-next.1...entity-storage-models-v0.0.3-next.2) (2025-11-13)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.3-next.0...entity-storage-models-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* 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 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))
+* remove includeNodeIdentity flag ([d88d1d0](https://github.com/twinfoundation/entity-storage/commit/d88d1d0694419b795dc860e0b712a0051c9a1c9e))
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+* 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))
+
+## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.9...entity-storage-models-v0.0.2-next.10) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
+
 ## [0.0.2-next.9](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.2-next.8...entity-storage-models-v0.0.2-next.9) (2025-10-02)
 
 

package/docs/reference/interfaces/IEntityStorageComponent.md

@@ -16,7 +16,7 @@ Interface describing an entity storage component.
 
 ### set()
 
-> **set**(`entity`, `userIdentity?`): `Promise`\<`void`\>
+> **set**(`entity`): `Promise`\<`void`\>
 
 Set an entity.
 
@@ -28,12 +28,6 @@ Set an entity.
 
 The entity to set.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -44,7 +38,7 @@ The id of the entity.
 
 ### get()
 
-> **get**(`id`, `secondaryIndex?`, `userIdentity?`): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex?`): `Promise`\<`T` \| `undefined`\>
 
 Get an entity.
 
@@ -62,15 +56,9 @@ keyof `T`
 
 Get the item using a secondary index.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
-`Promise`\<`undefined` \| `T`\>
+`Promise`\<`T` \| `undefined`\>
 
 The object if it can be found or undefined.
 
@@ -78,7 +66,7 @@ The object if it can be found or undefined.
 
 ### remove()
 
-> **remove**(`id`, `userIdentity?`): `Promise`\<`void`\>
+> **remove**(`id`): `Promise`\<`void`\>
 
 Remove the entity.
 
@@ -90,12 +78,6 @@ Remove the entity.
 
 The id of the entity to remove.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -106,7 +88,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`, `userIdentity?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Query all the entities which match the conditions.
 
@@ -140,20 +122,14 @@ 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`
 
 The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>

package/docs/reference/interfaces/IEntityStorageConnector.md

@@ -58,7 +58,7 @@ The id of the entity.
 
 ### get()
 
-> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
 Get an entity.
 
@@ -84,7 +84,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.
 
@@ -120,7 +120,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`; \}\>
 
 Query all the entities which match the conditions.
 
@@ -148,9 +148,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/IEntityStorageListRequest.md

@@ -34,11 +34,11 @@ The direction for the order, defaults to desc.
 
 The properties to return in the response as a comma separated list, by default returns all properties.
 
-#### pageSize?
+#### limit?
 
-> `optional` **pageSize**: `string` \| `number`
+> `optional` **limit**: `string`
 
-The number of entries to return per page.
+Limit the number of entities to return.
 
 #### cursor?
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-models",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.2",
 	"description": "Models which define the structure of the entity storage contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -18,20 +18,18 @@
 		"@twin.org/entity": "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"
@@ -50,5 +48,9 @@
 		"models",
 		"types",
 		"schemas"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/entity-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,13 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating entity storage connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const EntityStorageConnectorFactory = core.Factory.createFactory("entity-storage");
-
-exports.EntityStorageConnectorFactory = EntityStorageConnectorFactory;