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

package/dist/cjs/index.cjs

@@ -256,6 +256,11 @@ 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.
@@ -267,6 +272,7 @@ class EntityStorageService {
         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.
@@ -277,15 +283,24 @@ class EntityStorageService {
      */
     async set(entity, userIdentity, nodeIdentity) {
         core.Guards.object(this.CLASS_NAME, "entity", entity);
+        const conditions = [];
         if (this._includeUserIdentity) {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            conditions.push({
+                property: "userIdentity",
+                value: userIdentity
+            });
             core.ObjectHelper.propertySet(entity, "userIdentity", userIdentity);
         }
         if (this._includeNodeIdentity) {
             core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+            conditions.push({
+                property: "nodeIdentity",
+                value: nodeIdentity
+            });
             core.ObjectHelper.propertySet(entity, "nodeIdentity", nodeIdentity);
         }
-        return this._entityStorage.set(entity);
+        return this._entityStorage.set(entity, conditions);
     }
     /**
      * Get an entity.
@@ -297,50 +312,7 @@ class EntityStorageService {
      */
     async get(id, secondaryIndex, userIdentity, nodeIdentity) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        const conditions = [];
-        if (this._includeUserIdentity) {
-            core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
-            conditions.push({
-                property: "userIdentity",
-                comparison: entity.ComparisonOperator.Equals,
-                value: userIdentity
-            });
-        }
-        if (this._includeNodeIdentity) {
-            core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            conditions.push({
-                property: "nodeIdentity",
-                comparison: entity.ComparisonOperator.Equals,
-                value: nodeIdentity
-            });
-        }
-        if (core.Is.stringValue(secondaryIndex)) {
-            conditions.push({
-                property: secondaryIndex,
-                comparison: entity.ComparisonOperator.Equals,
-                value: id
-            });
-        }
-        if (conditions.length === 0) {
-            const entity = await this._entityStorage.get(id, secondaryIndex);
-            if (core.Is.empty(entity)) {
-                throw new core.NotFoundError(this.CLASS_NAME, "entityNotFound", id);
-            }
-            core.ObjectHelper.propertyDelete(entity, "nodeIdentity");
-            core.ObjectHelper.propertyDelete(entity, "userIdentity");
-            return entity;
-        }
-        const results = await this._entityStorage.query({
-            conditions,
-            logicalOperator: entity.LogicalOperator.And
-        }, undefined, undefined, undefined, 1);
-        const entity$1 = results.entities[0];
-        if (core.Is.empty(entity$1)) {
-            throw new core.NotFoundError(this.CLASS_NAME, "entityNotFound", id);
-        }
-        core.ObjectHelper.propertyDelete(entity$1, "nodeIdentity");
-        core.ObjectHelper.propertyDelete(entity$1, "userIdentity");
-        return entity$1;
+        return this.internalGet(id, secondaryIndex, userIdentity, nodeIdentity);
     }
     /**
      * Remove the entity.
@@ -356,7 +328,6 @@ class EntityStorageService {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
             conditions.push({
                 property: "userIdentity",
-                comparison: entity.ComparisonOperator.Equals,
                 value: userIdentity
             });
         }
@@ -364,32 +335,10 @@ class EntityStorageService {
             core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
             conditions.push({
                 property: "nodeIdentity",
-                comparison: entity.ComparisonOperator.Equals,
                 value: nodeIdentity
             });
         }
-        if (conditions.length === 0) {
-            const entity = await this._entityStorage.get(id);
-            if (core.Is.empty(entity)) {
-                throw new core.NotFoundError(this.CLASS_NAME, "entityNotFound", id);
-            }
-            await this._entityStorage.remove(id);
-        }
-        else {
-            const results = await this._entityStorage.query({
-                conditions,
-                logicalOperator: entity.LogicalOperator.And
-            }, undefined, undefined, undefined, 1);
-            if (results.entities.length > 0) {
-                const firstEntity = results.entities[0];
-                const schema = this._entityStorage.getSchema();
-                const primaryKey = entity.EntitySchemaHelper.getPrimaryKey(schema);
-                await this._entityStorage.remove(firstEntity[primaryKey.property]);
-            }
-            else {
-                throw new core.NotFoundError(this.CLASS_NAME, "entityNotFound", id);
-            }
-        }
+        await this._entityStorage.remove(id, conditions);
     }
     /**
      * Query all the entities which match the conditions.
@@ -404,27 +353,26 @@ class EntityStorageService {
      * and a cursor which can be used to request more entities.
      */
     async query(conditions, sortProperties, properties, cursor, pageSize, userIdentity, nodeIdentity) {
-        const conditionsList = [];
-        if (this._includeUserIdentity) {
-            core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
-            conditionsList.push({
-                property: "userIdentity",
-                comparison: entity.ComparisonOperator.Equals,
-                value: userIdentity
-            });
-        }
+        const finalConditions = {
+            conditions: [],
+            logicalOperator: entity.LogicalOperator.And
+        };
         if (this._includeNodeIdentity) {
             core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            conditionsList.push({
+            finalConditions.conditions.push({
                 property: "nodeIdentity",
                 comparison: entity.ComparisonOperator.Equals,
                 value: nodeIdentity
             });
         }
-        const finalConditions = {
-            conditions: conditionsList,
-            logicalOperator: entity.LogicalOperator.And
-        };
+        if (this._includeUserIdentity) {
+            core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            finalConditions.conditions.push({
+                property: "userIdentity",
+                comparison: entity.ComparisonOperator.Equals,
+                value: userIdentity
+            });
+        }
         if (!core.Is.empty(conditions)) {
             finalConditions.conditions.push(conditions);
         }
@@ -435,6 +383,67 @@ class EntityStorageService {
         }
         return result;
     }
+    /**
+     * 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.
+     * @param nodeIdentity The node identity to use with storage operations.
+     * @returns The object if it can be found or throws.
+     * @internal
+     */
+    async internalGet(id, secondaryIndex, userIdentity, nodeIdentity) {
+        const conditions = [];
+        if (this._includeUserIdentity) {
+            core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            conditions.push({
+                property: "userIdentity",
+                comparison: entity.ComparisonOperator.Equals,
+                value: userIdentity
+            });
+        }
+        if (this._includeNodeIdentity) {
+            core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+            conditions.push({
+                property: "nodeIdentity",
+                comparison: entity.ComparisonOperator.Equals,
+                value: nodeIdentity
+            });
+        }
+        if (core.Is.stringValue(secondaryIndex)) {
+            conditions.push({
+                property: secondaryIndex,
+                comparison: entity.ComparisonOperator.Equals,
+                value: id
+            });
+        }
+        let entity$1;
+        if (conditions.length === 0) {
+            entity$1 = await this._entityStorage.get(id, secondaryIndex);
+        }
+        else {
+            if (!core.Is.stringValue(secondaryIndex)) {
+                const schema = this._entityStorage.getSchema();
+                const primaryKey = entity.EntitySchemaHelper.getPrimaryKey(schema);
+                conditions.unshift({
+                    property: primaryKey.property,
+                    comparison: entity.ComparisonOperator.Equals,
+                    value: id
+                });
+            }
+            const results = await this._entityStorage.query({
+                conditions,
+                logicalOperator: entity.LogicalOperator.And
+            }, undefined, undefined, undefined, 1);
+            entity$1 = results.entities[0];
+        }
+        if (core.Is.empty(entity$1)) {
+            throw new core.NotFoundError(this.CLASS_NAME, "entityNotFound", id);
+        }
+        core.ObjectHelper.propertyDelete(entity$1, "nodeIdentity");
+        core.ObjectHelper.propertyDelete(entity$1, "userIdentity");
+        return entity$1;
+    }
 }
 
 /**

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 { ComparisonOperator, LogicalOperator, EntitySchemaHelper } from '@twin.org/entity';
+import { EntitySchemaHelper, LogicalOperator, ComparisonOperator } from '@twin.org/entity';
 import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 
 // Copyright 2024 IOTA Stiftung.
@@ -254,6 +254,11 @@ 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.
@@ -265,6 +270,7 @@ class EntityStorageService {
         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.
@@ -275,15 +281,24 @@ class EntityStorageService {
      */
     async set(entity, userIdentity, nodeIdentity) {
         Guards.object(this.CLASS_NAME, "entity", entity);
+        const conditions = [];
         if (this._includeUserIdentity) {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            conditions.push({
+                property: "userIdentity",
+                value: userIdentity
+            });
             ObjectHelper.propertySet(entity, "userIdentity", userIdentity);
         }
         if (this._includeNodeIdentity) {
             Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+            conditions.push({
+                property: "nodeIdentity",
+                value: nodeIdentity
+            });
             ObjectHelper.propertySet(entity, "nodeIdentity", nodeIdentity);
         }
-        return this._entityStorage.set(entity);
+        return this._entityStorage.set(entity, conditions);
     }
     /**
      * Get an entity.
@@ -295,50 +310,7 @@ class EntityStorageService {
      */
     async get(id, secondaryIndex, userIdentity, nodeIdentity) {
         Guards.stringValue(this.CLASS_NAME, "id", id);
-        const conditions = [];
-        if (this._includeUserIdentity) {
-            Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
-            conditions.push({
-                property: "userIdentity",
-                comparison: ComparisonOperator.Equals,
-                value: userIdentity
-            });
-        }
-        if (this._includeNodeIdentity) {
-            Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            conditions.push({
-                property: "nodeIdentity",
-                comparison: ComparisonOperator.Equals,
-                value: nodeIdentity
-            });
-        }
-        if (Is.stringValue(secondaryIndex)) {
-            conditions.push({
-                property: secondaryIndex,
-                comparison: ComparisonOperator.Equals,
-                value: id
-            });
-        }
-        if (conditions.length === 0) {
-            const entity = await this._entityStorage.get(id, secondaryIndex);
-            if (Is.empty(entity)) {
-                throw new NotFoundError(this.CLASS_NAME, "entityNotFound", id);
-            }
-            ObjectHelper.propertyDelete(entity, "nodeIdentity");
-            ObjectHelper.propertyDelete(entity, "userIdentity");
-            return entity;
-        }
-        const results = await this._entityStorage.query({
-            conditions,
-            logicalOperator: LogicalOperator.And
-        }, undefined, undefined, undefined, 1);
-        const entity = results.entities[0];
-        if (Is.empty(entity)) {
-            throw new NotFoundError(this.CLASS_NAME, "entityNotFound", id);
-        }
-        ObjectHelper.propertyDelete(entity, "nodeIdentity");
-        ObjectHelper.propertyDelete(entity, "userIdentity");
-        return entity;
+        return this.internalGet(id, secondaryIndex, userIdentity, nodeIdentity);
     }
     /**
      * Remove the entity.
@@ -354,7 +326,6 @@ class EntityStorageService {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
             conditions.push({
                 property: "userIdentity",
-                comparison: ComparisonOperator.Equals,
                 value: userIdentity
             });
         }
@@ -362,32 +333,10 @@ class EntityStorageService {
             Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
             conditions.push({
                 property: "nodeIdentity",
-                comparison: ComparisonOperator.Equals,
                 value: nodeIdentity
             });
         }
-        if (conditions.length === 0) {
-            const entity = await this._entityStorage.get(id);
-            if (Is.empty(entity)) {
-                throw new NotFoundError(this.CLASS_NAME, "entityNotFound", id);
-            }
-            await this._entityStorage.remove(id);
-        }
-        else {
-            const results = await this._entityStorage.query({
-                conditions,
-                logicalOperator: LogicalOperator.And
-            }, undefined, undefined, undefined, 1);
-            if (results.entities.length > 0) {
-                const firstEntity = results.entities[0];
-                const schema = this._entityStorage.getSchema();
-                const primaryKey = EntitySchemaHelper.getPrimaryKey(schema);
-                await this._entityStorage.remove(firstEntity[primaryKey.property]);
-            }
-            else {
-                throw new NotFoundError(this.CLASS_NAME, "entityNotFound", id);
-            }
-        }
+        await this._entityStorage.remove(id, conditions);
     }
     /**
      * Query all the entities which match the conditions.
@@ -402,27 +351,26 @@ class EntityStorageService {
      * and a cursor which can be used to request more entities.
      */
     async query(conditions, sortProperties, properties, cursor, pageSize, userIdentity, nodeIdentity) {
-        const conditionsList = [];
-        if (this._includeUserIdentity) {
-            Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
-            conditionsList.push({
-                property: "userIdentity",
-                comparison: ComparisonOperator.Equals,
-                value: userIdentity
-            });
-        }
+        const finalConditions = {
+            conditions: [],
+            logicalOperator: LogicalOperator.And
+        };
         if (this._includeNodeIdentity) {
             Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            conditionsList.push({
+            finalConditions.conditions.push({
                 property: "nodeIdentity",
                 comparison: ComparisonOperator.Equals,
                 value: nodeIdentity
             });
         }
-        const finalConditions = {
-            conditions: conditionsList,
-            logicalOperator: LogicalOperator.And
-        };
+        if (this._includeUserIdentity) {
+            Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            finalConditions.conditions.push({
+                property: "userIdentity",
+                comparison: ComparisonOperator.Equals,
+                value: userIdentity
+            });
+        }
         if (!Is.empty(conditions)) {
             finalConditions.conditions.push(conditions);
         }
@@ -433,6 +381,67 @@ class EntityStorageService {
         }
         return result;
     }
+    /**
+     * 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.
+     * @param nodeIdentity The node identity to use with storage operations.
+     * @returns The object if it can be found or throws.
+     * @internal
+     */
+    async internalGet(id, secondaryIndex, userIdentity, nodeIdentity) {
+        const conditions = [];
+        if (this._includeUserIdentity) {
+            Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            conditions.push({
+                property: "userIdentity",
+                comparison: ComparisonOperator.Equals,
+                value: userIdentity
+            });
+        }
+        if (this._includeNodeIdentity) {
+            Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+            conditions.push({
+                property: "nodeIdentity",
+                comparison: ComparisonOperator.Equals,
+                value: nodeIdentity
+            });
+        }
+        if (Is.stringValue(secondaryIndex)) {
+            conditions.push({
+                property: secondaryIndex,
+                comparison: ComparisonOperator.Equals,
+                value: id
+            });
+        }
+        let entity;
+        if (conditions.length === 0) {
+            entity = await this._entityStorage.get(id, secondaryIndex);
+        }
+        else {
+            if (!Is.stringValue(secondaryIndex)) {
+                const schema = this._entityStorage.getSchema();
+                const primaryKey = EntitySchemaHelper.getPrimaryKey(schema);
+                conditions.unshift({
+                    property: primaryKey.property,
+                    comparison: ComparisonOperator.Equals,
+                    value: id
+                });
+            }
+            const results = await this._entityStorage.query({
+                conditions,
+                logicalOperator: LogicalOperator.And
+            }, undefined, undefined, undefined, 1);
+            entity = results.entities[0];
+        }
+        if (Is.empty(entity)) {
+            throw new NotFoundError(this.CLASS_NAME, "entityNotFound", id);
+        }
+        ObjectHelper.propertyDelete(entity, "nodeIdentity");
+        ObjectHelper.propertyDelete(entity, "userIdentity");
+        return entity;
+    }
 }
 
 /**

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/entity-storage-service - Changelog
 
-## v0.0.1-next.7
+## v0.0.1-next.9
 
 - Initial Release

package/docs/open-api/spec.json

@@ -133,7 +133,7 @@
                     },
                     {
                         "name": "sortProperties",
-                        "description": "The sort property array as JSON serialization of {property,direction}[].",
+                        "description": "The sort property array as JSON serialization of property,direction.",
                         "in": "query",
                         "required": false,
                         "schema": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-service",
-	"version": "0.0.1-next.7",
+	"version": "0.0.1-next.9",
 	"description": "Entity Storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.1-next.7",
+		"@twin.org/entity-storage-models": "0.0.1-next.9",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},