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

package/dist/cjs/index.cjs

@@ -96,6 +96,9 @@ function generateRestRoutesEntityStorage(baseRouteName, componentName, options)
                         }
                     }
                 ]
+            },
+            {
+                type: "INotFoundResponse"
             }
         ]
     };
@@ -122,6 +125,9 @@ function generateRestRoutesEntityStorage(baseRouteName, componentName, options)
         responseType: [
             {
                 type: "INoContentResponse"
+            },
+            {
+                type: "INotFoundResponse"
             }
         ]
     };
@@ -273,12 +279,12 @@ class EntityStorageService {
         core.Guards.object(this.CLASS_NAME, "entity", entity);
         if (this._includeUserIdentity) {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            core.ObjectHelper.propertySet(entity, "userIdentity", userIdentity);
         }
         if (this._includeNodeIdentity) {
             core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+            core.ObjectHelper.propertySet(entity, "nodeIdentity", nodeIdentity);
         }
-        entity.nodeIdentity = nodeIdentity;
-        entity.userIdentity = userIdentity;
         return this._entityStorage.set(entity);
     }
     /**
@@ -317,10 +323,11 @@ class EntityStorageService {
         }
         if (conditions.length === 0) {
             const entity = await this._entityStorage.get(id, secondaryIndex);
-            if (!core.Is.empty(entity)) {
-                delete entity.nodeIdentity;
-                delete entity.userIdentity;
+            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({
@@ -328,8 +335,11 @@ class EntityStorageService {
             logicalOperator: entity.LogicalOperator.And
         }, undefined, undefined, undefined, 1);
         const entity$1 = results.entities[0];
-        delete entity$1.nodeIdentity;
-        delete entity$1.userIdentity;
+        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;
     }
     /**
@@ -359,17 +369,26 @@ class EntityStorageService {
             });
         }
         if (conditions.length === 0) {
-            return this._entityStorage.remove(id);
+            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);
         }
-        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 {
+            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);
+            }
         }
     }
     /**
@@ -409,10 +428,10 @@ class EntityStorageService {
         if (!core.Is.empty(conditions)) {
             finalConditions.conditions.push(conditions);
         }
-        const result = await this._entityStorage.query(finalConditions, sortProperties, properties, cursor, pageSize);
+        const result = await this._entityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, sortProperties, properties, cursor, pageSize);
         for (const entity of result.entities) {
-            delete entity.nodeIdentity;
-            delete entity.userIdentity;
+            core.ObjectHelper.propertyDelete(entity, "nodeIdentity");
+            core.ObjectHelper.propertyDelete(entity, "userIdentity");
         }
         return result;
     }

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { HttpParameterHelper } from '@twin.org/api-models';
-import { StringHelper, Guards, ComponentFactory, Coerce, Is } from '@twin.org/core';
+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 { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
@@ -94,6 +94,9 @@ function generateRestRoutesEntityStorage(baseRouteName, componentName, options)
                         }
                     }
                 ]
+            },
+            {
+                type: "INotFoundResponse"
             }
         ]
     };
@@ -120,6 +123,9 @@ function generateRestRoutesEntityStorage(baseRouteName, componentName, options)
         responseType: [
             {
                 type: "INoContentResponse"
+            },
+            {
+                type: "INotFoundResponse"
             }
         ]
     };
@@ -271,12 +277,12 @@ class EntityStorageService {
         Guards.object(this.CLASS_NAME, "entity", entity);
         if (this._includeUserIdentity) {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            ObjectHelper.propertySet(entity, "userIdentity", userIdentity);
         }
         if (this._includeNodeIdentity) {
             Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+            ObjectHelper.propertySet(entity, "nodeIdentity", nodeIdentity);
         }
-        entity.nodeIdentity = nodeIdentity;
-        entity.userIdentity = userIdentity;
         return this._entityStorage.set(entity);
     }
     /**
@@ -315,10 +321,11 @@ class EntityStorageService {
         }
         if (conditions.length === 0) {
             const entity = await this._entityStorage.get(id, secondaryIndex);
-            if (!Is.empty(entity)) {
-                delete entity.nodeIdentity;
-                delete entity.userIdentity;
+            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({
@@ -326,8 +333,11 @@ class EntityStorageService {
             logicalOperator: LogicalOperator.And
         }, undefined, undefined, undefined, 1);
         const entity = results.entities[0];
-        delete entity.nodeIdentity;
-        delete entity.userIdentity;
+        if (Is.empty(entity)) {
+            throw new NotFoundError(this.CLASS_NAME, "entityNotFound", id);
+        }
+        ObjectHelper.propertyDelete(entity, "nodeIdentity");
+        ObjectHelper.propertyDelete(entity, "userIdentity");
         return entity;
     }
     /**
@@ -357,17 +367,26 @@ class EntityStorageService {
             });
         }
         if (conditions.length === 0) {
-            return this._entityStorage.remove(id);
+            const entity = await this._entityStorage.get(id);
+            if (Is.empty(entity)) {
+                throw new NotFoundError(this.CLASS_NAME, "entityNotFound", id);
+            }
+            await this._entityStorage.remove(id);
         }
-        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 {
+            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);
+            }
         }
     }
     /**
@@ -407,10 +426,10 @@ class EntityStorageService {
         if (!Is.empty(conditions)) {
             finalConditions.conditions.push(conditions);
         }
-        const result = await this._entityStorage.query(finalConditions, sortProperties, properties, cursor, pageSize);
+        const result = await this._entityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, sortProperties, properties, cursor, pageSize);
         for (const entity of result.entities) {
-            delete entity.nodeIdentity;
-            delete entity.userIdentity;
+            ObjectHelper.propertyDelete(entity, "nodeIdentity");
+            ObjectHelper.propertyDelete(entity, "userIdentity");
         }
         return result;
     }

package/dist/types/entityStorageService.d.ts

@@ -4,10 +4,7 @@ import type { IEntityStorageConfig } from "./models/IEntityStorageConfig";
 /**
  * Class for performing entity service operations.
  */
-export declare class EntityStorageService<T extends {
-    nodeIdentity?: string;
-    userIdentity?: string;
-} = any> implements IEntityStorageComponent<T> {
+export declare class EntityStorageService<T = any> implements IEntityStorageComponent<T> {
     /**
      * Runtime name for the class.
      */

package/docs/changelog.md

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

package/docs/open-api/spec.json

@@ -348,6 +348,27 @@
                             }
                         }
                     },
+                    "404": {
+                        "description": "The resource you tried to access does not exist, see the content for more details.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/NotFoundResponse"
+                                },
+                                "examples": {
+                                    "exampleResponse": {
+                                        "value": {
+                                            "name": "NotFoundError",
+                                            "message": "component.error",
+                                            "properties": {
+                                                "notFoundId": "1"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    },
                     "500": {
                         "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
                         "content": {
@@ -435,6 +456,27 @@
                             }
                         }
                     },
+                    "404": {
+                        "description": "The resource you tried to access does not exist, see the content for more details.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/NotFoundResponse"
+                                },
+                                "examples": {
+                                    "exampleResponse": {
+                                        "value": {
+                                            "name": "NotFoundError",
+                                            "message": "component.error",
+                                            "properties": {
+                                                "notFoundId": "1"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    },
                     "500": {
                         "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
                         "content": {
@@ -515,6 +557,45 @@
                 ],
                 "additionalProperties": false,
                 "description": "Model to describe serialized error."
+            },
+            "NotFoundResponse": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "notFoundId": {
+                        "type": "string",
+                        "description": "The id if the item that was not found."
+                    },
+                    "name": {
+                        "type": "string",
+                        "description": "The name for the error."
+                    },
+                    "message": {
+                        "type": "string",
+                        "description": "The message for the error."
+                    },
+                    "source": {
+                        "type": "string",
+                        "description": "The source of the error."
+                    },
+                    "properties": {
+                        "type": "object",
+                        "additionalProperties": {},
+                        "description": "Any additional information for the error."
+                    },
+                    "stack": {
+                        "type": "string",
+                        "description": "The stack trace for the error."
+                    },
+                    "inner": {
+                        "$ref": "#/components/schemas/Error"
+                    }
+                },
+                "required": [
+                    "message",
+                    "name"
+                ],
+                "description": "The body which contains the error."
             }
         },
         "securitySchemes": {

package/docs/reference/classes/EntityStorageService.md

@@ -4,7 +4,7 @@ Class for performing entity service operations.
 
 ## Type Parameters
 
-• **T** *extends* `object` = `any`
+• **T** = `any`
 
 ## Implements
 

package/locales/en.json

@@ -1,3 +1,7 @@
 {
-	"error": {}
+	"error": {
+		"entityStorageService": {
+			"entityNotFound": "Could not find entity with id \"{id}\""
+		}
+	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-service",
-	"version": "0.0.1-next.5",
+	"version": "0.0.1-next.7",
 	"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.5",
+		"@twin.org/entity-storage-models": "0.0.1-next.7",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},