@twin.org/entity-storage-service 0.0.1-next.9 → 0.0.1

package/dist/cjs/index.cjs

@@ -224,7 +224,7 @@ async function entityStorageRemove(httpRequestContext, componentName, request) {
 async function entityStorageList(httpRequestContext, componentName, request) {
     core.Guards.object(ROUTES_SOURCE, "request", request);
     const component = core.ComponentFactory.get(componentName);
-    const result = await component.query(apiModels.HttpParameterHelper.objectFromString(request.query?.conditions), apiModels.HttpParameterHelper.objectFromString(request.query?.sortProperties), apiModels.HttpParameterHelper.objectFromString(request.query?.properties), request.query?.cursor, core.Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const result = await component.query(apiModels.HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, apiModels.HttpParameterHelper.objectFromString(request.query?.properties), request.query?.cursor, core.Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         body: result
     };
@@ -256,23 +256,15 @@ class EntityStorageService {
      * @internal
      */
     _includeUserIdentity;
-    /**
-     * The primary key for the entity.
-     * @internal
-     */
-    _primaryKey;
     /**
      * Create a new instance of EntityStorageService.
      * @param options The dependencies for the entity storage service.
-     * @param options.config The configuration for the service.
-     * @param options.entityStorageType The entity storage type.
      */
     constructor(options) {
         core.Guards.string(this.CLASS_NAME, "options.entityStorageType", options.entityStorageType);
         this._entityStorage = entityStorageModels.EntityStorageConnectorFactory.get(options.entityStorageType);
         this._includeNodeIdentity = options.config?.includeNodeIdentity ?? true;
         this._includeUserIdentity = options.config?.includeUserIdentity ?? true;
-        this._primaryKey = entity.EntitySchemaHelper.getPrimaryKey(this._entityStorage.getSchema());
     }
     /**
      * Set an entity.
@@ -343,7 +335,8 @@ class EntityStorageService {
     /**
      * Query all the entities which match the conditions.
      * @param conditions The conditions to match for the entities.
-     * @param sortProperties The optional sort order.
+     * @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.
@@ -352,7 +345,7 @@ class EntityStorageService {
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, properties, cursor, pageSize, userIdentity, nodeIdentity) {
+    async query(conditions, orderBy, orderByDirection, properties, cursor, pageSize, userIdentity, nodeIdentity) {
         const finalConditions = {
             conditions: [],
             logicalOperator: entity.LogicalOperator.And
@@ -376,7 +369,9 @@ class EntityStorageService {
         if (!core.Is.empty(conditions)) {
             finalConditions.conditions.push(conditions);
         }
-        const result = await this._entityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, sortProperties, properties, cursor, pageSize);
+        const result = await this._entityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, core.Is.stringValue(orderBy)
+            ? [{ property: orderBy, sortDirection: orderByDirection ?? entity.SortDirection.Ascending }]
+            : undefined, properties, cursor, pageSize);
         for (const entity of result.entities) {
             core.ObjectHelper.propertyDelete(entity, "nodeIdentity");
             core.ObjectHelper.propertyDelete(entity, "userIdentity");

package/dist/esm/index.mjs

@@ -1,7 +1,7 @@
 import { HttpParameterHelper } from '@twin.org/api-models';
 import { StringHelper, Guards, ComponentFactory, Coerce, ObjectHelper, Is, NotFoundError } from '@twin.org/core';
 import { HttpStatusCode } from '@twin.org/web';
-import { EntitySchemaHelper, LogicalOperator, ComparisonOperator } from '@twin.org/entity';
+import { LogicalOperator, ComparisonOperator, SortDirection, EntitySchemaHelper } from '@twin.org/entity';
 import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 
 // Copyright 2024 IOTA Stiftung.
@@ -222,7 +222,7 @@ async function entityStorageRemove(httpRequestContext, componentName, request) {
 async function entityStorageList(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
     const component = ComponentFactory.get(componentName);
-    const result = await component.query(HttpParameterHelper.objectFromString(request.query?.conditions), HttpParameterHelper.objectFromString(request.query?.sortProperties), HttpParameterHelper.objectFromString(request.query?.properties), request.query?.cursor, Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const result = await component.query(HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, HttpParameterHelper.objectFromString(request.query?.properties), request.query?.cursor, Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         body: result
     };
@@ -254,23 +254,15 @@ class EntityStorageService {
      * @internal
      */
     _includeUserIdentity;
-    /**
-     * The primary key for the entity.
-     * @internal
-     */
-    _primaryKey;
     /**
      * Create a new instance of EntityStorageService.
      * @param options The dependencies for the entity storage service.
-     * @param options.config The configuration for the service.
-     * @param options.entityStorageType The entity storage type.
      */
     constructor(options) {
         Guards.string(this.CLASS_NAME, "options.entityStorageType", options.entityStorageType);
         this._entityStorage = EntityStorageConnectorFactory.get(options.entityStorageType);
         this._includeNodeIdentity = options.config?.includeNodeIdentity ?? true;
         this._includeUserIdentity = options.config?.includeUserIdentity ?? true;
-        this._primaryKey = EntitySchemaHelper.getPrimaryKey(this._entityStorage.getSchema());
     }
     /**
      * Set an entity.
@@ -341,7 +333,8 @@ class EntityStorageService {
     /**
      * Query all the entities which match the conditions.
      * @param conditions The conditions to match for the entities.
-     * @param sortProperties The optional sort order.
+     * @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.
@@ -350,7 +343,7 @@ class EntityStorageService {
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, properties, cursor, pageSize, userIdentity, nodeIdentity) {
+    async query(conditions, orderBy, orderByDirection, properties, cursor, pageSize, userIdentity, nodeIdentity) {
         const finalConditions = {
             conditions: [],
             logicalOperator: LogicalOperator.And
@@ -374,7 +367,9 @@ class EntityStorageService {
         if (!Is.empty(conditions)) {
             finalConditions.conditions.push(conditions);
         }
-        const result = await this._entityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, sortProperties, properties, cursor, pageSize);
+        const result = await this._entityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, Is.stringValue(orderBy)
+            ? [{ property: orderBy, sortDirection: orderByDirection ?? SortDirection.Ascending }]
+            : undefined, properties, cursor, pageSize);
         for (const entity of result.entities) {
             ObjectHelper.propertyDelete(entity, "nodeIdentity");
             ObjectHelper.propertyDelete(entity, "userIdentity");

package/dist/types/entityStorageService.d.ts

@@ -1,6 +1,6 @@
-import { type SortDirection, type EntityCondition } from "@twin.org/entity";
+import { type EntityCondition, SortDirection } from "@twin.org/entity";
 import { type IEntityStorageComponent } from "@twin.org/entity-storage-models";
-import type { IEntityStorageConfig } from "./models/IEntityStorageConfig";
+import type { IEntityStorageServiceConstructorOptions } from "./models/IEntityStorageServiceConstructorOptions";
 /**
  * Class for performing entity service operations.
  */
@@ -12,13 +12,8 @@ export declare class EntityStorageService<T = any> implements IEntityStorageComp
     /**
      * Create a new instance of EntityStorageService.
      * @param options The dependencies for the entity storage service.
-     * @param options.config The configuration for the service.
-     * @param options.entityStorageType The entity storage type.
      */
-    constructor(options: {
-        entityStorageType: string;
-        config?: IEntityStorageConfig;
-    });
+    constructor(options: IEntityStorageServiceConstructorOptions);
     /**
      * Set an entity.
      * @param entity The entity to set.
@@ -47,7 +42,8 @@ export declare class EntityStorageService<T = any> implements IEntityStorageComp
     /**
      * Query all the entities which match the conditions.
      * @param conditions The conditions to match for the entities.
-     * @param sortProperties The optional sort order.
+     * @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.
@@ -56,10 +52,7 @@ export declare class EntityStorageService<T = any> implements IEntityStorageComp
      * @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, userIdentity?: string, nodeIdentity?: string): Promise<{
+    query(conditions?: EntityCondition<T>, orderBy?: keyof T, orderByDirection?: SortDirection, properties?: (keyof T)[], cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<{
         /**
          * The entities, which can be partial if a limited keys list was provided.
          */

package/dist/types/index.d.ts

@@ -2,4 +2,5 @@ export * from "./entityStorageRoutes";
 export * from "./entityStorageService";
 export * from "./models/IEntityStorageConfig";
 export * from "./models/IEntityStorageRoutesExamples";
+export * from "./models/IEntityStorageServiceConstructorOptions";
 export * from "./restEntryPoints";

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

@@ -0,0 +1,14 @@
+import type { IEntityStorageConfig } from "./IEntityStorageConfig";
+/**
+ * Options for the Entity Storage Service constructor.
+ */
+export interface IEntityStorageServiceConstructorOptions {
+    /**
+     * The type of the entity storage.
+     */
+    entityStorageType: string;
+    /**
+     * The configuration for the service.
+     */
+    config?: IEntityStorageConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,109 @@
 # @twin.org/entity-storage-service - Changelog
 
-## v0.0.1-next.9
+## 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))
+* 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-service-v0.0.1-next.30...entity-storage-service-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-service-v0.0.1-next.29...entity-storage-service-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-service-v0.0.1-next.28...entity-storage-service-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-service-v0.0.1-next.27...entity-storage-service-v0.0.1-next.28) (2025-04-09)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-service:** Synchronize repo versions
+
+
+### 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-service-v0.0.1-next.26...entity-storage-service-v0.0.1-next.27) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-service:** 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