npm - @twin.org/entity-storage-service - Versions diffs - 0.0.3-next.13 → 0.0.3-next.14 - Mend

@twin.org/entity-storage-service 0.0.3-next.13 → 0.0.3-next.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/dist/es/entityStorageRoutes.js +4 -4
package/dist/es/entityStorageRoutes.js.map +1 -1
package/dist/es/entityStorageService.js +12 -8
package/dist/es/entityStorageService.js.map +1 -1
package/dist/types/entityStorageService.d.ts +17 -4
package/docs/changelog.md +16 -0
package/docs/open-api/spec.json +40 -15
package/docs/reference/classes/EntityStorageService.md +30 -4
package/package.json +2 -2

package/dist/es/entityStorageRoutes.js CHANGED Viewed

@@ -284,7 +284,7 @@ export function generateRestRoutesEntityStorage(baseRouteName, componentName, op
 export async function entityStorageSet(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
     const component = ComponentFactory.get(componentName);
-    await component.set(request.body);
+    await component.set(request.body, HttpParameterHelper.objectFromString(request.query?.conditions));
     return {
         statusCode: HttpStatusCode.noContent
     };
@@ -329,7 +329,7 @@ export async function entityStorageGet(httpRequestContext, componentName, reques
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = ComponentFactory.get(componentName);
-    const item = await component.get(request.pathParams.id, request.query?.secondaryIndex);
+    const item = await component.get(request.pathParams.id, request.query?.secondaryIndex, HttpParameterHelper.objectFromString(request.query?.conditions));
     return {
         body: item
     };
@@ -346,7 +346,7 @@ export async function entityStorageRemove(httpRequestContext, componentName, req
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = ComponentFactory.get(componentName);
-    await component.remove(request.pathParams.id);
+    await component.remove(request.pathParams.id, HttpParameterHelper.objectFromString(request.query?.conditions));
     return {
         statusCode: HttpStatusCode.noContent
     };
@@ -375,7 +375,7 @@ export async function entityStorageList(httpRequestContext, componentName, reque
  */
 export async function entityStorageCount(httpRequestContext, componentName, request) {
     const component = ComponentFactory.get(componentName);
-    const count = await component.count();
+    const count = await component.count(HttpParameterHelper.objectFromString(request.query?.conditions));
     return {
         body: { count }
     };

package/dist/es/entityStorageRoutes.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"entityStorageRoutes.js","sourceRoot":"","sources":["../../src/entityStorageRoutes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,mBAAmB,EAMnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAgBhF,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAG/C;;GAEG;AACH,MAAM,aAAa,GAAG,qBAAqB,CAAC;AAE5C;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAW;IACxC;QACC,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,oEAAoE;KACjF;CACD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,UAAU,+BAA+B,CAC9C,aAAqB,EACrB,aAAqB,EACrB,OAIC;IAED,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,gBAAgB,CAAC;IACvD,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IACzC,MAAM,aAAa,GAAG,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAEvD,MAAM,QAAQ,GAA6D;QAC1E,WAAW,EAAE,GAAG,aAAa,KAAK;QAClC,OAAO,EAAE,mBAAmB,SAAS,GAAG;QACxC,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,gBAAgB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC7D,WAAW,EAAE;YACZ,IAAI,4BAAoC;YACxC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,IAAI;gBACpD;oBACC,EAAE,EAAE,GAAG,aAAa,mBAAmB;oBACvC,OAAO,EAAE;wBACR,IAAI,EAAE;4BACL,EAAE,EAAE,OAAO;4BACX,IAAI,EAAE,SAAS;yBACf;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;KACD,CAAC;IAEF,MAAM,aAAa,GAAkE;QACpF,WAAW,EAAE,GAAG,aAAa,UAAU;QACvC,OAAO,EAAE,2BAA2B,SAAS,GAAG;QAChD,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG,aAAa,QAAQ;QAC9B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,qBAAqB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAClE,WAAW,EAAE;YACZ,IAAI,iCAAyC;YAC7C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,GAAG,aAAa,wBAAwB;oBAC5C,OAAO,EAAE;wBACR,IAAI,EAAE;4BACL,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;4BAChC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE;yBACtC;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;KACD,CAAC;IAEF,MAAM,QAAQ,GAAoE;QACjF,WAAW,EAAE,GAAG,aAAa,KAAK;QAClC,OAAO,EAAE,qBAAqB,SAAS,GAAG;QAC1C,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,MAAM;QAC5B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,gBAAgB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC7D,WAAW,EAAE;YACZ,IAAI,4BAAoC;YACxC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,IAAI;gBACpD;oBACC,EAAE,EAAE,GAAG,aAAa,mBAAmB;oBACvC,OAAO,EAAE;wBACR,UAAU,EAAE;4BACX,EAAE,EAAE,OAAO;yBACX;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,6BAAqC;gBACzC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,gBAAgB,IAAI;oBACrD;wBACC,EAAE,EAAE,GAAG,aAAa,oBAAoB;wBACxC,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,EAAE,EAAE,OAAO;gCACX,IAAI,EAAE,SAAS;6BACf;yBACD;qBACD;iBACD;aACD;YACD;gBACC,IAAI,qBAA6B;aACjC;SACD;KACD,CAAC;IAEF,MAAM,WAAW,GAAgE;QAChF,WAAW,EAAE,GAAG,aAAa,QAAQ;QACrC,OAAO,EAAE,wBAAwB,SAAS,GAAG;QAC7C,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,GAAG,aAAa,MAAM;QAC5B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,mBAAmB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAChE,WAAW,EAAE;YACZ,IAAI,+BAAuC;YAC3C,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,IAAI;gBACvD;oBACC,EAAE,EAAE,GAAG,aAAa,sBAAsB;oBAC1C,OAAO,EAAE;wBACR,UAAU,EAAE;4BACX,EAAE,EAAE,OAAO;yBACX;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;YACD;gBACC,IAAI,qBAA6B;aACjC;SACD;KACD,CAAC;IAEF,MAAM,SAAS,GAAsE;QACpF,WAAW,EAAE,GAAG,aAAa,MAAM;QACnC,OAAO,EAAE,sBAAsB,SAAS,GAAG;QAC3C,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,iBAAiB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC9D,WAAW,EAAE;YACZ,IAAI,6BAAqC;YACzC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,IAAI;gBACrD;oBACC,EAAE,EAAE,GAAG,aAAa,oBAAoB;oBACxC,OAAO,EAAE,EAAE;iBACX;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,8BAAsC;gBAC1C,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,gBAAgB,IAAI;oBACtD;wBACC,EAAE,EAAE,GAAG,aAAa,qBAAqB;wBACzC,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;6BAC5C;yBACD;qBACD;iBACD;aACD;SACD;KACD,CAAC;IAEF,MAAM,UAAU,GAAwE;QACvF,WAAW,EAAE,GAAG,aAAa,OAAO;QACpC,OAAO,EAAE,oBAAoB,SAAS,GAAG;QACzC,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,QAAQ;QAC9B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,kBAAkB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC/D,WAAW,EAAE;YACZ,IAAI,8BAAsC;YAC1C,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,IAAI;gBACtD;oBACC,EAAE,EAAE,GAAG,aAAa,qBAAqB;oBACzC,OAAO,EAAE,EAAE;iBACX;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,+BAAuC;gBAC3C,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,IAAI;oBACvD;wBACC,EAAE,EAAE,GAAG,aAAa,sBAAsB;wBAC1C,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,KAAK,EAAE,CAAC;6BACR;yBACD;qBACD;iBACD;aACD;SACD;KACD,CAAC;IAEF,MAAM,UAAU,GAA+D;QAC9E,WAAW,EAAE,GAAG,aAAa,OAAO;QACpC,OAAO,EAAE,2BAA2B,SAAS,GAAG;QAChD,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,kBAAkB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC/D,WAAW,EAAE;YACZ,IAAI,8BAAsC;YAC1C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,GAAG,aAAa,qBAAqB;oBACzC,OAAO,EAAE,EAAE;iBACX;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;KACD,CAAC;IAEF,MAAM,gBAAgB,GAAqE;QAC1F,WAAW,EAAE,GAAG,aAAa,aAAa;QAC1C,OAAO,EAAE,gCAAgC,SAAS,SAAS;QAC3D,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,GAAG,aAAa,QAAQ;QAC9B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,wBAAwB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACrE,WAAW,EAAE;YACZ,IAAI,oCAA4C;YAChD,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,GAAG,aAAa,2BAA2B;oBAC/C,OAAO,EAAE;wBACR,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;qBACxB;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;KACD,CAAC;IAEF,OAAO;QACN,QAAQ;QACR,aAAa;QACb,QAAQ;QACR,WAAW;QACX,gBAAgB;QAChB,UAAU;QACV,SAAS;QACT,UAAU;KACV,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACrC,kBAAuC,EACvC,aAAqB,EACrB,OAAiC;IAEjC,MAAM,CAAC,MAAM,CAA2B,aAAa,aAAmB,OAAO,CAAC,CAAC;IAEjF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAC1C,kBAAuC,EACvC,aAAqB,EACrB,OAAsC;IAEtC,MAAM,CAAC,MAAM,CAAgC,aAAa,aAAmB,OAAO,CAAC,CAAC;IACtF,MAAM,CAAC,UAAU,CAAC,aAAa,kBAAwB,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACvC,kBAAuC,EACvC,aAAqB,EACrB,OAAmC;IAEnC,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;IACxB,OAAO,EAAE,UAAU,EAAE,cAAc,CAAC,SAAS,EAAE,CAAC;AACjD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACrC,kBAAuC,EACvC,aAAqB,EACrB,OAAiC;IAEjC,MAAM,CAAC,MAAM,CAA2B,aAAa,aAAmB,OAAO,CAAC,CAAC;IACjF,MAAM,CAAC,MAAM,CACZ,aAAa,wBAEb,OAAO,CAAC,UAAU,CAClB,CAAC;IACF,MAAM,CAAC,WAAW,CAAC,aAAa,2BAAiC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAExF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,GAAG,CAC/B,OAAO,CAAC,UAAU,CAAC,EAAE,EACrB,OAAO,CAAC,KAAK,EAAE,cAA+B,CAC9C,CAAC;IACF,OAAO;QACN,IAAI,EAAE,IAAI;KACV,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACxC,kBAAuC,EACvC,aAAqB,EACrB,OAAoC;IAEpC,MAAM,CAAC,MAAM,CAA8B,aAAa,aAAmB,OAAO,CAAC,CAAC;IACpF,MAAM,CAAC,MAAM,CACZ,aAAa,wBAEb,OAAO,CAAC,UAAU,CAClB,CAAC;IACF,MAAM,CAAC,WAAW,CAAC,aAAa,2BAAiC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAExF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9C,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACtC,kBAAuC,EACvC,aAAqB,EACrB,OAAkC;IAElC,MAAM,CAAC,MAAM,CAA4B,aAAa,aAAmB,OAAO,CAAC,CAAC;IAElF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,KAAK,CACnC,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/D,OAAO,CAAC,KAAK,EAAE,OAAwB,EACvC,OAAO,CAAC,KAAK,EAAE,gBAAgB,EAC/B,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/D,OAAO,CAAC,KAAK,EAAE,MAAM,EACrB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CACnC,CAAC;IACF,OAAO;QACN,IAAI,EAAE,MAAM;KACZ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACvC,kBAAuC,EACvC,aAAqB,EACrB,OAAmC;IAEnC,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;IACtC,OAAO;QACN,IAAI,EAAE,EAAE,KAAK,EAAE;KACf,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC7C,kBAAuC,EACvC,aAAqB,EACrB,OAAyC;IAEzC,MAAM,CAAC,MAAM,CAAmC,aAAa,aAAmB,OAAO,CAAC,CAAC;IACzF,MAAM,CAAC,UAAU,CAAC,aAAa,kBAAwB,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tHttpParameterHelper,\n\ttype INotFoundResponse,\n\ttype IHttpRequestContext,\n\ttype INoContentResponse,\n\ttype IRestRoute,\n\ttype ITag\n} from \"@twin.org/api-models\";\nimport { Coerce, ComponentFactory, Guards, StringHelper } from \"@twin.org/core\";\nimport type {\n\tIEntityStorageComponent,\n\tIEntityStorageCountRequest,\n\tIEntityStorageCountResponse,\n\tIEntityStorageEmptyRequest,\n\tIEntityStorageGetRequest,\n\tIEntityStorageGetResponse,\n\tIEntityStorageListRequest,\n\tIEntityStorageListResponse,\n\tIEntityStorageRemoveBatchRequest,\n\tIEntityStorageRemoveRequest,\n\tIEntityStorageSetBatchRequest,\n\tIEntityStorageSetRequest\n} from \"@twin.org/entity-storage-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HttpStatusCode } from \"@twin.org/web\";\nimport type { IEntityStorageRoutesExamples } from \"./models/IEntityStorageRoutesExamples.js\";\n\n/*\n The source used when communicating about these routes.\n /\nconst ROUTES_SOURCE = \"entityStorageRoutes\";\n\n/\n The tag to associate with the routes.\n /\nexport const tagsEntityStorage: ITag[] = [\n\t{\n\t\tname: \"EntityStorage\",\n\t\tdescription: \"Endpoints which are modelled to access an entity storage contract.\"\n\t}\n];\n\n/\n The REST routes for entity storage.\n * @param baseRouteName Prefix to prepend to the paths.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @param options Additional options for the routes.\n * @param options.typeName Optional type name to use in the routes, defaults to Entity Storage.\n * @param options.tagName Optional name to use in OpenAPI spec for tag.\n * @param options.examples Optional examples to use in the routes.\n * @returns The generated routes.\n /\nexport function generateRestRoutesEntityStorage(\n\tbaseRouteName: string,\n\tcomponentName: string,\n\toptions?: {\n\t\ttypeName?: string;\n\t\ttagName?: string;\n\t\texamples?: IEntityStorageRoutesExamples;\n\t}\n): IRestRoute[] {\n\tconst typeName = options?.typeName ?? \"Entity Storage\";\n\tconst lowerName = typeName.toLowerCase();\n\tconst camelTypeName = StringHelper.camelCase(typeName);\n\n\tconst setRoute: IRestRoute<IEntityStorageSetRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}Set`,\n\t\tsummary: `Set an entry in ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"POST\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageSet(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageSetRequest>(),\n\t\t\texamples: options?.examples?.set?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}SetRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\tid: \"12345\",\n\t\t\t\t\t\t\tname: \"My Item\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst setBatchRoute: IRestRoute<IEntityStorageSetBatchRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}SetBatch`,\n\t\tsummary: `Set multiple entries in ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"POST\",\n\t\tpath: `${baseRouteName}/batch`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageSetBatch(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageSetBatchRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}SetBatchRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tbody: [\n\t\t\t\t\t\t\t{ id: \"12345\", name: \"My Item\" },\n\t\t\t\t\t\t\t{ id: \"67890\", name: \"My Other Item\" }\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst getRoute: IRestRoute<IEntityStorageGetRequest, IEntityStorageGetResponse> = {\n\t\toperationId: `${camelTypeName}Get`,\n\t\tsummary: `Get an entry from ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/:id`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageGet(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageGetRequest>(),\n\t\t\texamples: options?.examples?.get?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}GetRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tpathParams: {\n\t\t\t\t\t\t\tid: \"12345\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IEntityStorageGetResponse>(),\n\t\t\t\texamples: options?.examples?.get?.responseExamples ?? [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: `${camelTypeName}GetResponseExample`,\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tid: \"12345\",\n\t\t\t\t\t\t\t\tname: \"My Item\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: nameof<INotFoundResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst removeRoute: IRestRoute<IEntityStorageRemoveRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}Remove`,\n\t\tsummary: `Remove an entry from ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"DELETE\",\n\t\tpath: `${baseRouteName}/:id`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageRemove(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageRemoveRequest>(),\n\t\t\texamples: options?.examples?.remove?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}RemoveRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tpathParams: {\n\t\t\t\t\t\t\tid: \"12345\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: nameof<INotFoundResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst listRoute: IRestRoute<IEntityStorageListRequest, IEntityStorageListResponse> = {\n\t\toperationId: `${camelTypeName}List`,\n\t\tsummary: `Query entries from ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageList(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageListRequest>(),\n\t\t\texamples: options?.examples?.list?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}ListRequestExample`,\n\t\t\t\t\trequest: {}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IEntityStorageListResponse>(),\n\t\t\t\texamples: options?.examples?.list?.responseExamples ?? [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: `${camelTypeName}ListResponseExample`,\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tentities: [{ id: \"12345\", name: \"My Item\" }]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t};\n\n\tconst countRoute: IRestRoute<IEntityStorageCountRequest, IEntityStorageCountResponse> = {\n\t\toperationId: `${camelTypeName}Count`,\n\t\tsummary: `Count entries in ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/count`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageCount(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageCountRequest>(),\n\t\t\texamples: options?.examples?.count?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}CountRequestExample`,\n\t\t\t\t\trequest: {}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IEntityStorageCountResponse>(),\n\t\t\t\texamples: options?.examples?.count?.responseExamples ?? [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: `${camelTypeName}CountResponseExample`,\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tcount: 1\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t};\n\n\tconst emptyRoute: IRestRoute<IEntityStorageEmptyRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}Empty`,\n\t\tsummary: `Remove all entries from ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"DELETE\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageEmpty(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageEmptyRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}EmptyRequestExample`,\n\t\t\t\t\trequest: {}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst removeBatchRoute: IRestRoute<IEntityStorageRemoveBatchRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}RemoveBatch`,\n\t\tsummary: `Remove multiple entries from ${lowerName} by id.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"DELETE\",\n\t\tpath: `${baseRouteName}/batch`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageRemoveBatch(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageRemoveBatchRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}RemoveBatchRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tbody: [\"12345\", \"67890\"]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\treturn [\n\t\tsetRoute,\n\t\tsetBatchRoute,\n\t\tgetRoute,\n\t\tremoveRoute,\n\t\tremoveBatchRoute,\n\t\temptyRoute,\n\t\tlistRoute,\n\t\tcountRoute\n\t];\n}\n\n/\n Set the entry in entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageSet(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageSetRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IEntityStorageSetRequest>(ROUTES_SOURCE, nameof(request), request);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.set(request.body);\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/\n Set multiple entries in entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageSetBatch(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageSetBatchRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IEntityStorageSetBatchRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.arrayValue(ROUTES_SOURCE, nameof(request.body), request.body);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.setBatch(request.body);\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/\n Remove all entries from entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageEmpty(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageEmptyRequest\n): Promise<INoContentResponse> {\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.empty();\n\treturn { statusCode: HttpStatusCode.noContent };\n}\n\n/\n Get the entry from entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageGet(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageGetRequest\n): Promise<IEntityStorageGetResponse> {\n\tGuards.object<IEntityStorageGetRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<IEntityStorageGetRequest[\"pathParams\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.pathParams),\n\t\trequest.pathParams\n\t);\n\tGuards.stringValue(ROUTES_SOURCE, nameof(request.pathParams.id), request.pathParams.id);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tconst item = await component.get(\n\t\trequest.pathParams.id,\n\t\trequest.query?.secondaryIndex as keyof unknown\n\t);\n\treturn {\n\t\tbody: item\n\t};\n}\n\n/\n Remove the entry from entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageRemove(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageRemoveRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IEntityStorageRemoveRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<IEntityStorageRemoveRequest[\"pathParams\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.pathParams),\n\t\trequest.pathParams\n\t);\n\tGuards.stringValue(ROUTES_SOURCE, nameof(request.pathParams.id), request.pathParams.id);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.remove(request.pathParams.id);\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/\n Query the entries from entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageList(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageListRequest\n): Promise<IEntityStorageListResponse> {\n\tGuards.object<IEntityStorageListRequest>(ROUTES_SOURCE, nameof(request), request);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tconst result = await component.query(\n\t\tHttpParameterHelper.objectFromString(request.query?.conditions),\n\t\trequest.query?.orderBy as keyof unknown,\n\t\trequest.query?.orderByDirection,\n\t\tHttpParameterHelper.objectFromString(request.query?.properties),\n\t\trequest.query?.cursor,\n\t\tCoerce.number(request.query?.limit)\n\t);\n\treturn {\n\t\tbody: result\n\t};\n}\n\n/\n Count the entries in entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageCount(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageCountRequest\n): Promise<IEntityStorageCountResponse> {\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tconst count = await component.count();\n\treturn {\n\t\tbody: { count }\n\t};\n}\n\n/\n Remove multiple entries from entity storage by id.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function entityStorageRemoveBatch(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageRemoveBatchRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IEntityStorageRemoveBatchRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.arrayValue(ROUTES_SOURCE, nameof(request.body), request.body);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.removeBatch(request.body);\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n"]}
1	+ {"version":3,"file":"entityStorageRoutes.js","sourceRoot":"","sources":["../../src/entityStorageRoutes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,mBAAmB,EAMnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAgBhF,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAG/C;;GAEG;AACH,MAAM,aAAa,GAAG,qBAAqB,CAAC;AAE5C;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAW;IACxC;QACC,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,oEAAoE;KACjF;CACD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,UAAU,+BAA+B,CAC9C,aAAqB,EACrB,aAAqB,EACrB,OAIC;IAED,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,gBAAgB,CAAC;IACvD,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IACzC,MAAM,aAAa,GAAG,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAEvD,MAAM,QAAQ,GAA6D;QAC1E,WAAW,EAAE,GAAG,aAAa,KAAK;QAClC,OAAO,EAAE,mBAAmB,SAAS,GAAG;QACxC,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,gBAAgB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC7D,WAAW,EAAE;YACZ,IAAI,4BAAoC;YACxC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,IAAI;gBACpD;oBACC,EAAE,EAAE,GAAG,aAAa,mBAAmB;oBACvC,OAAO,EAAE;wBACR,IAAI,EAAE;4BACL,EAAE,EAAE,OAAO;4BACX,IAAI,EAAE,SAAS;yBACf;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;KACD,CAAC;IAEF,MAAM,aAAa,GAAkE;QACpF,WAAW,EAAE,GAAG,aAAa,UAAU;QACvC,OAAO,EAAE,2BAA2B,SAAS,GAAG;QAChD,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG,aAAa,QAAQ;QAC9B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,qBAAqB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAClE,WAAW,EAAE;YACZ,IAAI,iCAAyC;YAC7C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,GAAG,aAAa,wBAAwB;oBAC5C,OAAO,EAAE;wBACR,IAAI,EAAE;4BACL,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;4BAChC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE;yBACtC;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;KACD,CAAC;IAEF,MAAM,QAAQ,GAAoE;QACjF,WAAW,EAAE,GAAG,aAAa,KAAK;QAClC,OAAO,EAAE,qBAAqB,SAAS,GAAG;QAC1C,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,MAAM;QAC5B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,gBAAgB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC7D,WAAW,EAAE;YACZ,IAAI,4BAAoC;YACxC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,IAAI;gBACpD;oBACC,EAAE,EAAE,GAAG,aAAa,mBAAmB;oBACvC,OAAO,EAAE;wBACR,UAAU,EAAE;4BACX,EAAE,EAAE,OAAO;yBACX;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,6BAAqC;gBACzC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,gBAAgB,IAAI;oBACrD;wBACC,EAAE,EAAE,GAAG,aAAa,oBAAoB;wBACxC,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,EAAE,EAAE,OAAO;gCACX,IAAI,EAAE,SAAS;6BACf;yBACD;qBACD;iBACD;aACD;YACD;gBACC,IAAI,qBAA6B;aACjC;SACD;KACD,CAAC;IAEF,MAAM,WAAW,GAAgE;QAChF,WAAW,EAAE,GAAG,aAAa,QAAQ;QACrC,OAAO,EAAE,wBAAwB,SAAS,GAAG;QAC7C,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,GAAG,aAAa,MAAM;QAC5B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,mBAAmB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAChE,WAAW,EAAE;YACZ,IAAI,+BAAuC;YAC3C,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,IAAI;gBACvD;oBACC,EAAE,EAAE,GAAG,aAAa,sBAAsB;oBAC1C,OAAO,EAAE;wBACR,UAAU,EAAE;4BACX,EAAE,EAAE,OAAO;yBACX;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;YACD;gBACC,IAAI,qBAA6B;aACjC;SACD;KACD,CAAC;IAEF,MAAM,SAAS,GAAsE;QACpF,WAAW,EAAE,GAAG,aAAa,MAAM;QACnC,OAAO,EAAE,sBAAsB,SAAS,GAAG;QAC3C,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,iBAAiB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC9D,WAAW,EAAE;YACZ,IAAI,6BAAqC;YACzC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,IAAI;gBACrD;oBACC,EAAE,EAAE,GAAG,aAAa,oBAAoB;oBACxC,OAAO,EAAE,EAAE;iBACX;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,8BAAsC;gBAC1C,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,gBAAgB,IAAI;oBACtD;wBACC,EAAE,EAAE,GAAG,aAAa,qBAAqB;wBACzC,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;6BAC5C;yBACD;qBACD;iBACD;aACD;SACD;KACD,CAAC;IAEF,MAAM,UAAU,GAAwE;QACvF,WAAW,EAAE,GAAG,aAAa,OAAO;QACpC,OAAO,EAAE,oBAAoB,SAAS,GAAG;QACzC,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,QAAQ;QAC9B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,kBAAkB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC/D,WAAW,EAAE;YACZ,IAAI,8BAAsC;YAC1C,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,IAAI;gBACtD;oBACC,EAAE,EAAE,GAAG,aAAa,qBAAqB;oBACzC,OAAO,EAAE,EAAE;iBACX;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,+BAAuC;gBAC3C,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,IAAI;oBACvD;wBACC,EAAE,EAAE,GAAG,aAAa,sBAAsB;wBAC1C,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,KAAK,EAAE,CAAC;6BACR;yBACD;qBACD;iBACD;aACD;SACD;KACD,CAAC;IAEF,MAAM,UAAU,GAA+D;QAC9E,WAAW,EAAE,GAAG,aAAa,OAAO;QACpC,OAAO,EAAE,2BAA2B,SAAS,GAAG;QAChD,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,kBAAkB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC/D,WAAW,EAAE;YACZ,IAAI,8BAAsC;YAC1C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,GAAG,aAAa,qBAAqB;oBACzC,OAAO,EAAE,EAAE;iBACX;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;KACD,CAAC;IAEF,MAAM,gBAAgB,GAAqE;QAC1F,WAAW,EAAE,GAAG,aAAa,aAAa;QAC1C,OAAO,EAAE,gCAAgC,SAAS,SAAS;QAC3D,GAAG,EAAE,OAAO,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,GAAG,aAAa,QAAQ;QAC9B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,wBAAwB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACrE,WAAW,EAAE;YACZ,IAAI,oCAA4C;YAChD,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,GAAG,aAAa,2BAA2B;oBAC/C,OAAO,EAAE;wBACR,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;qBACxB;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;KACD,CAAC;IAEF,OAAO;QACN,QAAQ;QACR,aAAa;QACb,QAAQ;QACR,WAAW;QACX,gBAAgB;QAChB,UAAU;QACV,SAAS;QACT,UAAU;KACV,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACrC,kBAAuC,EACvC,aAAqB,EACrB,OAAiC;IAEjC,MAAM,CAAC,MAAM,CAA2B,aAAa,aAAmB,OAAO,CAAC,CAAC;IAEjF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,GAAG,CAClB,OAAO,CAAC,IAAI,EACZ,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAC/D,CAAC;IACF,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAC1C,kBAAuC,EACvC,aAAqB,EACrB,OAAsC;IAEtC,MAAM,CAAC,MAAM,CAAgC,aAAa,aAAmB,OAAO,CAAC,CAAC;IACtF,MAAM,CAAC,UAAU,CAAC,aAAa,kBAAwB,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACvC,kBAAuC,EACvC,aAAqB,EACrB,OAAmC;IAEnC,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;IACxB,OAAO,EAAE,UAAU,EAAE,cAAc,CAAC,SAAS,EAAE,CAAC;AACjD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACrC,kBAAuC,EACvC,aAAqB,EACrB,OAAiC;IAEjC,MAAM,CAAC,MAAM,CAA2B,aAAa,aAAmB,OAAO,CAAC,CAAC;IACjF,MAAM,CAAC,MAAM,CACZ,aAAa,wBAEb,OAAO,CAAC,UAAU,CAClB,CAAC;IACF,MAAM,CAAC,WAAW,CAAC,aAAa,2BAAiC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAExF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,GAAG,CAC/B,OAAO,CAAC,UAAU,CAAC,EAAE,EACrB,OAAO,CAAC,KAAK,EAAE,cAA+B,EAC9C,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAC/D,CAAC;IACF,OAAO;QACN,IAAI,EAAE,IAAI;KACV,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACxC,kBAAuC,EACvC,aAAqB,EACrB,OAAoC;IAEpC,MAAM,CAAC,MAAM,CAA8B,aAAa,aAAmB,OAAO,CAAC,CAAC;IACpF,MAAM,CAAC,MAAM,CACZ,aAAa,wBAEb,OAAO,CAAC,UAAU,CAClB,CAAC;IACF,MAAM,CAAC,WAAW,CAAC,aAAa,2BAAiC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAExF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,MAAM,CACrB,OAAO,CAAC,UAAU,CAAC,EAAE,EACrB,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAC/D,CAAC;IACF,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACtC,kBAAuC,EACvC,aAAqB,EACrB,OAAkC;IAElC,MAAM,CAAC,MAAM,CAA4B,aAAa,aAAmB,OAAO,CAAC,CAAC;IAElF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,KAAK,CACnC,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/D,OAAO,CAAC,KAAK,EAAE,OAAwB,EACvC,OAAO,CAAC,KAAK,EAAE,gBAAgB,EAC/B,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/D,OAAO,CAAC,KAAK,EAAE,MAAM,EACrB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CACnC,CAAC;IACF,OAAO;QACN,IAAI,EAAE,MAAM;KACZ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACvC,kBAAuC,EACvC,aAAqB,EACrB,OAAmC;IAEnC,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,KAAK,CAClC,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAC/D,CAAC;IACF,OAAO;QACN,IAAI,EAAE,EAAE,KAAK,EAAE;KACf,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC7C,kBAAuC,EACvC,aAAqB,EACrB,OAAyC;IAEzC,MAAM,CAAC,MAAM,CAAmC,aAAa,aAAmB,OAAO,CAAC,CAAC;IACzF,MAAM,CAAC,UAAU,CAAC,aAAa,kBAAwB,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA0B,aAAa,CAAC,CAAC;IAC/E,MAAM,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tHttpParameterHelper,\n\ttype INotFoundResponse,\n\ttype IHttpRequestContext,\n\ttype INoContentResponse,\n\ttype IRestRoute,\n\ttype ITag\n} from \"@twin.org/api-models\";\nimport { Coerce, ComponentFactory, Guards, StringHelper } from \"@twin.org/core\";\nimport type {\n\tIEntityStorageComponent,\n\tIEntityStorageCountRequest,\n\tIEntityStorageCountResponse,\n\tIEntityStorageEmptyRequest,\n\tIEntityStorageGetRequest,\n\tIEntityStorageGetResponse,\n\tIEntityStorageListRequest,\n\tIEntityStorageListResponse,\n\tIEntityStorageRemoveBatchRequest,\n\tIEntityStorageRemoveRequest,\n\tIEntityStorageSetBatchRequest,\n\tIEntityStorageSetRequest\n} from \"@twin.org/entity-storage-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HttpStatusCode } from \"@twin.org/web\";\nimport type { IEntityStorageRoutesExamples } from \"./models/IEntityStorageRoutesExamples.js\";\n\n/*\n The source used when communicating about these routes.\n /\nconst ROUTES_SOURCE = \"entityStorageRoutes\";\n\n/\n The tag to associate with the routes.\n /\nexport const tagsEntityStorage: ITag[] = [\n\t{\n\t\tname: \"EntityStorage\",\n\t\tdescription: \"Endpoints which are modelled to access an entity storage contract.\"\n\t}\n];\n\n/\n The REST routes for entity storage.\n * @param baseRouteName Prefix to prepend to the paths.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @param options Additional options for the routes.\n * @param options.typeName Optional type name to use in the routes, defaults to Entity Storage.\n * @param options.tagName Optional name to use in OpenAPI spec for tag.\n * @param options.examples Optional examples to use in the routes.\n * @returns The generated routes.\n /\nexport function generateRestRoutesEntityStorage(\n\tbaseRouteName: string,\n\tcomponentName: string,\n\toptions?: {\n\t\ttypeName?: string;\n\t\ttagName?: string;\n\t\texamples?: IEntityStorageRoutesExamples;\n\t}\n): IRestRoute[] {\n\tconst typeName = options?.typeName ?? \"Entity Storage\";\n\tconst lowerName = typeName.toLowerCase();\n\tconst camelTypeName = StringHelper.camelCase(typeName);\n\n\tconst setRoute: IRestRoute<IEntityStorageSetRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}Set`,\n\t\tsummary: `Set an entry in ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"POST\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageSet(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageSetRequest>(),\n\t\t\texamples: options?.examples?.set?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}SetRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\tid: \"12345\",\n\t\t\t\t\t\t\tname: \"My Item\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst setBatchRoute: IRestRoute<IEntityStorageSetBatchRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}SetBatch`,\n\t\tsummary: `Set multiple entries in ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"POST\",\n\t\tpath: `${baseRouteName}/batch`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageSetBatch(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageSetBatchRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}SetBatchRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tbody: [\n\t\t\t\t\t\t\t{ id: \"12345\", name: \"My Item\" },\n\t\t\t\t\t\t\t{ id: \"67890\", name: \"My Other Item\" }\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst getRoute: IRestRoute<IEntityStorageGetRequest, IEntityStorageGetResponse> = {\n\t\toperationId: `${camelTypeName}Get`,\n\t\tsummary: `Get an entry from ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/:id`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageGet(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageGetRequest>(),\n\t\t\texamples: options?.examples?.get?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}GetRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tpathParams: {\n\t\t\t\t\t\t\tid: \"12345\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IEntityStorageGetResponse>(),\n\t\t\t\texamples: options?.examples?.get?.responseExamples ?? [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: `${camelTypeName}GetResponseExample`,\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tid: \"12345\",\n\t\t\t\t\t\t\t\tname: \"My Item\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: nameof<INotFoundResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst removeRoute: IRestRoute<IEntityStorageRemoveRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}Remove`,\n\t\tsummary: `Remove an entry from ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"DELETE\",\n\t\tpath: `${baseRouteName}/:id`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageRemove(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageRemoveRequest>(),\n\t\t\texamples: options?.examples?.remove?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}RemoveRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tpathParams: {\n\t\t\t\t\t\t\tid: \"12345\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: nameof<INotFoundResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst listRoute: IRestRoute<IEntityStorageListRequest, IEntityStorageListResponse> = {\n\t\toperationId: `${camelTypeName}List`,\n\t\tsummary: `Query entries from ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageList(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageListRequest>(),\n\t\t\texamples: options?.examples?.list?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}ListRequestExample`,\n\t\t\t\t\trequest: {}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IEntityStorageListResponse>(),\n\t\t\t\texamples: options?.examples?.list?.responseExamples ?? [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: `${camelTypeName}ListResponseExample`,\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tentities: [{ id: \"12345\", name: \"My Item\" }]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t};\n\n\tconst countRoute: IRestRoute<IEntityStorageCountRequest, IEntityStorageCountResponse> = {\n\t\toperationId: `${camelTypeName}Count`,\n\t\tsummary: `Count entries in ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/count`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageCount(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageCountRequest>(),\n\t\t\texamples: options?.examples?.count?.requestExamples ?? [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}CountRequestExample`,\n\t\t\t\t\trequest: {}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IEntityStorageCountResponse>(),\n\t\t\t\texamples: options?.examples?.count?.responseExamples ?? [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: `${camelTypeName}CountResponseExample`,\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tcount: 1\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t};\n\n\tconst emptyRoute: IRestRoute<IEntityStorageEmptyRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}Empty`,\n\t\tsummary: `Remove all entries from ${lowerName}.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"DELETE\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageEmpty(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageEmptyRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}EmptyRequestExample`,\n\t\t\t\t\trequest: {}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst removeBatchRoute: IRestRoute<IEntityStorageRemoveBatchRequest, INoContentResponse> = {\n\t\toperationId: `${camelTypeName}RemoveBatch`,\n\t\tsummary: `Remove multiple entries from ${lowerName} by id.`,\n\t\ttag: options?.tagName ?? tagsEntityStorage[0].name,\n\t\tmethod: \"DELETE\",\n\t\tpath: `${baseRouteName}/batch`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tentityStorageRemoveBatch(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IEntityStorageRemoveBatchRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: `${camelTypeName}RemoveBatchRequestExample`,\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tbody: [\"12345\", \"67890\"]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\treturn [\n\t\tsetRoute,\n\t\tsetBatchRoute,\n\t\tgetRoute,\n\t\tremoveRoute,\n\t\tremoveBatchRoute,\n\t\temptyRoute,\n\t\tlistRoute,\n\t\tcountRoute\n\t];\n}\n\n/\n Set the entry in entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageSet(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageSetRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IEntityStorageSetRequest>(ROUTES_SOURCE, nameof(request), request);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.set(\n\t\trequest.body,\n\t\tHttpParameterHelper.objectFromString(request.query?.conditions)\n\t);\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/\n Set multiple entries in entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageSetBatch(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageSetBatchRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IEntityStorageSetBatchRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.arrayValue(ROUTES_SOURCE, nameof(request.body), request.body);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.setBatch(request.body);\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/\n Remove all entries from entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageEmpty(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageEmptyRequest\n): Promise<INoContentResponse> {\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.empty();\n\treturn { statusCode: HttpStatusCode.noContent };\n}\n\n/\n Get the entry from entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageGet(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageGetRequest\n): Promise<IEntityStorageGetResponse> {\n\tGuards.object<IEntityStorageGetRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<IEntityStorageGetRequest[\"pathParams\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.pathParams),\n\t\trequest.pathParams\n\t);\n\tGuards.stringValue(ROUTES_SOURCE, nameof(request.pathParams.id), request.pathParams.id);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tconst item = await component.get(\n\t\trequest.pathParams.id,\n\t\trequest.query?.secondaryIndex as keyof unknown,\n\t\tHttpParameterHelper.objectFromString(request.query?.conditions)\n\t);\n\treturn {\n\t\tbody: item\n\t};\n}\n\n/\n Remove the entry from entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageRemove(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageRemoveRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IEntityStorageRemoveRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<IEntityStorageRemoveRequest[\"pathParams\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.pathParams),\n\t\trequest.pathParams\n\t);\n\tGuards.stringValue(ROUTES_SOURCE, nameof(request.pathParams.id), request.pathParams.id);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.remove(\n\t\trequest.pathParams.id,\n\t\tHttpParameterHelper.objectFromString(request.query?.conditions)\n\t);\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/\n Query the entries from entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageList(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageListRequest\n): Promise<IEntityStorageListResponse> {\n\tGuards.object<IEntityStorageListRequest>(ROUTES_SOURCE, nameof(request), request);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tconst result = await component.query(\n\t\tHttpParameterHelper.objectFromString(request.query?.conditions),\n\t\trequest.query?.orderBy as keyof unknown,\n\t\trequest.query?.orderByDirection,\n\t\tHttpParameterHelper.objectFromString(request.query?.properties),\n\t\trequest.query?.cursor,\n\t\tCoerce.number(request.query?.limit)\n\t);\n\treturn {\n\t\tbody: result\n\t};\n}\n\n/\n Count the entries in entity storage.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n /\nexport async function entityStorageCount(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageCountRequest\n): Promise<IEntityStorageCountResponse> {\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tconst count = await component.count(\n\t\tHttpParameterHelper.objectFromString(request.query?.conditions)\n\t);\n\treturn {\n\t\tbody: { count }\n\t};\n}\n\n/\n Remove multiple entries from entity storage by id.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function entityStorageRemoveBatch(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IEntityStorageRemoveBatchRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IEntityStorageRemoveBatchRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.arrayValue(ROUTES_SOURCE, nameof(request.body), request.body);\n\n\tconst component = ComponentFactory.get<IEntityStorageComponent>(componentName);\n\tawait component.removeBatch(request.body);\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n"]}

package/dist/es/entityStorageService.js CHANGED Viewed

@@ -35,11 +35,12 @@ export class EntityStorageService {
     /**
      * Set an entity.
      * @param entity The entity to set.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The id of the entity.
      */
-    async set(entity) {
+    async set(entity, conditions) {
         Guards.object(EntityStorageService.CLASS_NAME, "entity", entity);
-        return this._entityStorage.set(entity, undefined);
+        return this._entityStorage.set(entity, conditions);
     }
     /**
      * Set multiple entities in a batch.
@@ -54,20 +55,22 @@ export class EntityStorageService {
      * 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 conditions The optional conditions to match for the entities.
      * @returns The object if it can be found or undefined.
      */
-    async get(id, secondaryIndex) {
+    async get(id, secondaryIndex, conditions) {
         Guards.stringValue(EntityStorageService.CLASS_NAME, "id", id);
-        return this._entityStorage.get(id, secondaryIndex);
+        return this._entityStorage.get(id, secondaryIndex, conditions);
     }
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.
+     * @param conditions The optional conditions to match for the entities.
      * @returns Nothing.
      */
-    async remove(id) {
+    async remove(id, conditions) {
         Guards.stringValue(EntityStorageService.CLASS_NAME, "id", id);
-        await this._entityStorage.remove(id);
+        await this._entityStorage.remove(id, conditions);
     }
     /**
      * Remove multiple entities by id.
@@ -87,10 +90,11 @@ export class EntityStorageService {
     }
     /**
      * Count all the entities which match the conditions.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The total count of entities in the storage.
      */
-    async count() {
-        return this._entityStorage.count();
+    async count(conditions) {
+        return this._entityStorage.count(conditions);
     }
     /**
      * Query all the entities which match the conditions.

package/dist/es/entityStorageService.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"entityStorageService.js","sourceRoot":"","sources":["../../src/entityStorageService.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAwB,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EACN,6BAA6B,EAG7B,MAAM,iCAAiC,CAAC;AAIzC;;GAEG;AACH,8DAA8D;AAC9D,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAU,UAAU,0BAA0C;IAE3E;;;OAGG;IACc,cAAc,CAA6B;IAE5D;;;OAGG;IACH,YAAY,OAAgD;QAC3D,MAAM,CAAC,MAAM,CACZ,oBAAoB,CAAC,UAAU,+BAE/B,OAAO,CAAC,iBAAiB,CACzB,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,6BAA6B,CAAC,GAAG,CACtD,OAAO,CAAC,iBAAiB,CACzB,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,oBAAoB,CAAC,UAAU,CAAC;IACxC,CAAC;IAED~~;;;;OAIG~~;IACI,KAAK,CAAC,GAAG,CAAC,MAAS;~~QACzB~~,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAEvE,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,~~SAAS~~,CAAC,CAAC;~~IACnD~~,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CAAC,QAAa;QAClC,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAE/E,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED~~;;;;;OAKG~~;IACI,KAAK,CAAC,GAAG,~~CAAC~~,EAAU,~~EAAE~~,cAAwB;~~QACpD~~,MAAM,CAAC,WAAW,CAAC,oBAAoB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAEpE,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;~~IACpD~~,CAAC;IAED~~;;;;OAIG~~;IACI,KAAK,CAAC,MAAM,~~CAAC~~,EAAU;~~QAC7B~~,MAAM,CAAC,WAAW,CAAC,oBAAoB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAEpE,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;~~IACtC~~,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,GAAa;QACrC,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAErE,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IAED~~;;;OAGG~~;IACI,KAAK,CAAC,KAAK;~~QACjB~~,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,~~EAAE~~,CAAC;~~IACpC~~,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,KAAK,CACjB,UAA+B,EAC/B,OAAiB,EACjB,gBAAgC,EAChC,UAAwB,EACxB,MAAe,EACf,KAAc;QAWd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAC7C,UAAU,EACV,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC;YACtB,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;YACrF,CAAC,CAAC,SAAS,EACZ,UAAU,EACV,MAAM,EACN,KAAK,CACL,CAAC;QAEF,OAAO,MAAM,CAAC;IACf,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Guards, Is } from \"@twin.org/core\";\nimport { type EntityCondition, SortDirection } from \"@twin.org/entity\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageComponent,\n\ttype IEntityStorageConnector\n} from \"@twin.org/entity-storage-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IEntityStorageServiceConstructorOptions } from \"./models/IEntityStorageServiceConstructorOptions.js\";\n\n/*\n Class for performing entity service operations.\n /\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport class EntityStorageService<T = any> implements IEntityStorageComponent<T> {\n\t/\n\t Runtime name for the class.\n\t /\n\tpublic static readonly CLASS_NAME: string = nameof<EntityStorageService>();\n\n\t/\n\t The entity storage for items.\n\t * @internal\n\t /\n\tprivate readonly _entityStorage: IEntityStorageConnector<T>;\n\n\t/\n\t Create a new instance of EntityStorageService.\n\t * @param options The dependencies for the entity storage service.\n\t /\n\tconstructor(options: IEntityStorageServiceConstructorOptions) {\n\t\tGuards.string(\n\t\t\tEntityStorageService.CLASS_NAME,\n\t\t\tnameof(options.entityStorageType),\n\t\t\toptions.entityStorageType\n\t\t);\n\t\tthis._entityStorage = EntityStorageConnectorFactory.get<IEntityStorageConnector<T>>(\n\t\t\toptions.entityStorageType\n\t\t);\n\t}\n\n\t/\n\t Returns the class name of the component.\n\t * @returns The class name of the component.\n\t /\n\tpublic className(): string {\n\t\treturn EntityStorageService.CLASS_NAME;\n\t}\n\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\tpublic async set(entity: T): Promise<void> {\n\t\tGuards.object(EntityStorageService.CLASS_NAME, nameof(entity), entity);\n\n\t\treturn this._entityStorage.set(entity, ~~undefined~~);\n\t}\n\n\t/\n\t Set multiple entities in a batch.\n\t * @param entities The entities to set.\n\t * @returns Nothing.\n\t /\n\tpublic async setBatch(entities: T[]): Promise<void> {\n\t\tGuards.arrayValue(EntityStorageService.CLASS_NAME, nameof(entities), entities);\n\n\t\treturn this._entityStorage.setBatch(entities);\n\t}\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\tpublic async get(id: string, ~~secondaryIndex~~?: keyof T): Promise<T \| undefined> {\n\t\tGuards.stringValue(EntityStorageService.CLASS_NAME, nameof(id), id);\n\n\t\treturn this._entityStorage.get(id, secondaryIndex);\n\t}\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\tpublic async remove(id: string): Promise<void> {\n\t\tGuards.stringValue(EntityStorageService.CLASS_NAME, nameof(id), id);\n\n\t\tawait this._entityStorage.remove(id);\n\t}\n\n\t/\n\t Remove multiple entities by id.\n\t * @param ids The ids of the entities to remove.\n\t * @returns Nothing.\n\t /\n\tpublic async removeBatch(ids: string[]): Promise<void> {\n\t\tGuards.arrayValue(EntityStorageService.CLASS_NAME, nameof(ids), ids);\n\n\t\treturn this._entityStorage.removeBatch(ids);\n\t}\n\n\t/\n\t Remove all entities from the storage.\n\t * @returns Nothing.\n\t /\n\tpublic async empty(): Promise<void> {\n\t\treturn this._entityStorage.empty();\n\t}\n\n\t/\n\t Count all the entities which match the conditions.\n\t * @returns The total count of entities in the storage.\n\t /\n\tpublic async count(): Promise<number> {\n\t\treturn this._entityStorage.count();\n\t}\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\tpublic async query(\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\t\tconst result = await this._entityStorage.query(\n\t\t\tconditions,\n\t\t\tIs.stringValue(orderBy)\n\t\t\t\t? [{ property: orderBy, sortDirection: orderByDirection ?? SortDirection.Ascending }]\n\t\t\t\t: undefined,\n\t\t\tproperties,\n\t\t\tcursor,\n\t\t\tlimit\n\t\t);\n\n\t\treturn result;\n\t}\n}\n"]}
1	+ {"version":3,"file":"entityStorageService.js","sourceRoot":"","sources":["../../src/entityStorageService.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAwB,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EACN,6BAA6B,EAG7B,MAAM,iCAAiC,CAAC;AAIzC;;GAEG;AACH,8DAA8D;AAC9D,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAU,UAAU,0BAA0C;IAE3E;;;OAGG;IACc,cAAc,CAA6B;IAE5D;;;OAGG;IACH,YAAY,OAAgD;QAC3D,MAAM,CAAC,MAAM,CACZ,oBAAoB,CAAC,UAAU,+BAE/B,OAAO,CAAC,iBAAiB,CACzB,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,6BAA6B,CAAC,GAAG,CACtD,OAAO,CAAC,iBAAiB,CACzB,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,oBAAoB,CAAC,UAAU,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,MAAS,EAAE,UAAoD;QAC/E,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAEvE,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CAAC,QAAa;QAClC,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAE/E,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACf,EAAU,EACV,cAAwB,EACxB,UAAoD;QAEpD,MAAM,CAAC,WAAW,CAAC,oBAAoB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAEpE,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAClB,EAAU,EACV,UAAoD;QAEpD,MAAM,CAAC,WAAW,CAAC,oBAAoB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAEpE,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,GAAa;QACrC,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAErE,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,CAAC,UAA+B;QACjD,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,KAAK,CACjB,UAA+B,EAC/B,OAAiB,EACjB,gBAAgC,EAChC,UAAwB,EACxB,MAAe,EACf,KAAc;QAWd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAC7C,UAAU,EACV,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC;YACtB,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;YACrF,CAAC,CAAC,SAAS,EACZ,UAAU,EACV,MAAM,EACN,KAAK,CACL,CAAC;QAEF,OAAO,MAAM,CAAC;IACf,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Guards, Is } from \"@twin.org/core\";\nimport { type EntityCondition, SortDirection } from \"@twin.org/entity\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageComponent,\n\ttype IEntityStorageConnector\n} from \"@twin.org/entity-storage-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IEntityStorageServiceConstructorOptions } from \"./models/IEntityStorageServiceConstructorOptions.js\";\n\n/*\n Class for performing entity service operations.\n /\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport class EntityStorageService<T = any> implements IEntityStorageComponent<T> {\n\t/\n\t Runtime name for the class.\n\t /\n\tpublic static readonly CLASS_NAME: string = nameof<EntityStorageService>();\n\n\t/\n\t The entity storage for items.\n\t * @internal\n\t /\n\tprivate readonly _entityStorage: IEntityStorageConnector<T>;\n\n\t/\n\t Create a new instance of EntityStorageService.\n\t * @param options The dependencies for the entity storage service.\n\t /\n\tconstructor(options: IEntityStorageServiceConstructorOptions) {\n\t\tGuards.string(\n\t\t\tEntityStorageService.CLASS_NAME,\n\t\t\tnameof(options.entityStorageType),\n\t\t\toptions.entityStorageType\n\t\t);\n\t\tthis._entityStorage = EntityStorageConnectorFactory.get<IEntityStorageConnector<T>>(\n\t\t\toptions.entityStorageType\n\t\t);\n\t}\n\n\t/\n\t Returns the class name of the component.\n\t * @returns The class name of the component.\n\t /\n\tpublic className(): string {\n\t\treturn EntityStorageService.CLASS_NAME;\n\t}\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\tpublic async set(entity: T, conditions?: { property: keyof T; value: unknown }[]): Promise<void> {\n\t\tGuards.object(EntityStorageService.CLASS_NAME, nameof(entity), entity);\n\n\t\treturn this._entityStorage.set(entity, conditions);\n\t}\n\n\t/\n\t Set multiple entities in a batch.\n\t * @param entities The entities to set.\n\t * @returns Nothing.\n\t /\n\tpublic async setBatch(entities: T[]): Promise<void> {\n\t\tGuards.arrayValue(EntityStorageService.CLASS_NAME, nameof(entities), entities);\n\n\t\treturn this._entityStorage.setBatch(entities);\n\t}\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\tpublic async get(\n\t\tid: string,\n\t\tsecondaryIndex?: keyof T,\n\t\tconditions?: { property: keyof T; value: unknown }[]\n\t): Promise<T \| undefined> {\n\t\tGuards.stringValue(EntityStorageService.CLASS_NAME, nameof(id), id);\n\n\t\treturn this._entityStorage.get(id, secondaryIndex, conditions);\n\t}\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\tpublic async remove(\n\t\tid: string,\n\t\tconditions?: { property: keyof T; value: unknown }[]\n\t): Promise<void> {\n\t\tGuards.stringValue(EntityStorageService.CLASS_NAME, nameof(id), id);\n\n\t\tawait this._entityStorage.remove(id, conditions);\n\t}\n\n\t/\n\t Remove multiple entities by id.\n\t * @param ids The ids of the entities to remove.\n\t * @returns Nothing.\n\t /\n\tpublic async removeBatch(ids: string[]): Promise<void> {\n\t\tGuards.arrayValue(EntityStorageService.CLASS_NAME, nameof(ids), ids);\n\n\t\treturn this._entityStorage.removeBatch(ids);\n\t}\n\n\t/\n\t Remove all entities from the storage.\n\t * @returns Nothing.\n\t /\n\tpublic async empty(): Promise<void> {\n\t\treturn this._entityStorage.empty();\n\t}\n\n\t/\n\t Count all the entities which match the conditions.\n\t * @param conditions The optional conditions to match for the entities.\n\t * @returns The total count of entities in the storage.\n\t /\n\tpublic async count(conditions?: EntityCondition<T>): Promise<number> {\n\t\treturn this._entityStorage.count(conditions);\n\t}\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\tpublic async query(\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\t\tconst result = await this._entityStorage.query(\n\t\t\tconditions,\n\t\t\tIs.stringValue(orderBy)\n\t\t\t\t? [{ property: orderBy, sortDirection: orderByDirection ?? SortDirection.Ascending }]\n\t\t\t\t: undefined,\n\t\t\tproperties,\n\t\t\tcursor,\n\t\t\tlimit\n\t\t);\n\n\t\treturn result;\n\t}\n}\n"]}

package/dist/types/entityStorageService.d.ts CHANGED Viewed

@@ -22,9 +22,13 @@ export declare class EntityStorageService<T = any> implements IEntityStorageComp
     /**
      * Set an entity.
      * @param entity The entity to set.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The id of the entity.
      */
-    set(entity: T): Promise<void>;
+    set(entity: T, conditions?: {
+        property: keyof T;
+        value: unknown;
+    }[]): Promise<void>;
     /**
      * Set multiple entities in a batch.
      * @param entities The entities to set.
@@ -35,15 +39,23 @@ export declare class EntityStorageService<T = any> implements IEntityStorageComp
      * 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 conditions The optional conditions to match for the entities.
      * @returns The object if it can be found or undefined.
      */
-    get(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;
+    get(id: string, secondaryIndex?: keyof T, conditions?: {
+        property: keyof T;
+        value: unknown;
+    }[]): Promise<T | undefined>;
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.
+     * @param conditions The optional conditions to match for the entities.
      * @returns Nothing.
      */
-    remove(id: string): Promise<void>;
+    remove(id: string, conditions?: {
+        property: keyof T;
+        value: unknown;
+    }[]): Promise<void>;
     /**
      * Remove multiple entities by id.
      * @param ids The ids of the entities to remove.
@@ -57,9 +69,10 @@ export declare class EntityStorageService<T = any> implements IEntityStorageComp
     empty(): Promise<void>;
     /**
      * Count all the entities which match the conditions.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The total count of entities in the storage.
      */
-    count(): Promise<number>;
+    count(conditions?: EntityCondition<T>): Promise<number>;
     /**
      * Query all the entities which match the conditions.
      * @param conditions The conditions to match for the entities.

package/docs/changelog.md CHANGED Viewed

@@ -1,5 +1,21 @@
 # Changelog
+## [0.0.3-next.14](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.13...entity-storage-service-v0.0.3-next.14) (2026-05-19)
+### Features
+* adding schema migration functionality to all the connectors ([#85](https://github.com/iotaledger/twin-entity-storage/issues/85)) ([fd1555a](https://github.com/iotaledger/twin-entity-storage/commit/fd1555a34380158214a577586dafae821e72a578))
+### Dependencies
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.3-next.13 to 0.0.3-next.14
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.13 to 0.0.3-next.14
 ## [0.0.3-next.13](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-service-v0.0.3-next.12...entity-storage-service-v0.0.3-next.13) (2026-05-13)

package/docs/open-api/spec.json CHANGED Viewed

@@ -28,6 +28,17 @@
 				"tags": [
 					"EntityStorage"
 				],
+				"parameters": [
+					{
+						"name": "conditions",
+						"description": "The optional conditions to match for the entity, JSON encoded array of property/value pairs.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					}
+				],
 				"security": [
 					{
 						"jwtBearerAuthScheme": []
@@ -571,6 +582,15 @@
 						"schema": {
 							"type": "string"
 						}
+					},
+					{
+						"name": "conditions",
+						"description": "The optional conditions to match for the entity, JSON encoded array of property/value pairs.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
 					}
 				],
 				"security": [
@@ -694,6 +714,15 @@
 						},
 						"style": "simple",
 						"example": "12345"
+					},
+					{
+						"name": "conditions",
+						"description": "The optional conditions to match for the entity, JSON encoded array of property/value pairs.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
 					}
 				],
 				"security": [
@@ -793,22 +822,22 @@
 				"tags": [
 					"EntityStorage"
 				],
+				"parameters": [
+					{
+						"name": "conditions",
+						"description": "The optional conditions to filter the count, JSON encoded EntityCondition.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					}
+				],
 				"security": [
 					{
 						"jwtBearerAuthScheme": []
 					}
 				],
-				"requestBody": {
-					"description": "Count the entries in entity storage.",
-					"required": true,
-					"content": {
-						"text/plain": {
-							"schema": {
-								"$ref": "#/components/schemas/EntityStorageCountRequest"
-							}
-						}
-					}
-				},
 				"responses": {
 					"200": {
 						"description": "The response for counting entries in entity storage.",
@@ -890,10 +919,6 @@
 	},
 	"components": {
 		"schemas": {
-			"EntityStorageCountRequest": {
-				"description": "Count the entries in entity storage.",
-				"type": "object"
-			},
 			"EntityStorageCountResponse": {
 				"type": "object",
 				"properties": {

package/docs/reference/classes/EntityStorageService.md CHANGED Viewed

@@ -62,7 +62,7 @@ The class name of the component.
 ### set() {#set}
-> **set**(`entity`): `Promise`\<`void`\>
+> **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 Set an entity.
@@ -74,6 +74,12 @@ Set an entity.
 The entity to set.
+##### conditions?
+`object`[]
+The optional conditions to match for the entities.
 #### Returns
 `Promise`\<`void`\>
@@ -114,7 +120,7 @@ Nothing.
 ### get() {#get}
-> **get**(`id`, `secondaryIndex?`): `Promise`\<`T` \| `undefined`\>
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 Get an entity.
@@ -132,6 +138,12 @@ keyof `T`
 Get the item using a secondary index.
+##### conditions?
+`object`[]
+The optional conditions to match for the entities.
 #### Returns
 `Promise`\<`T` \| `undefined`\>
@@ -146,7 +158,7 @@ The object if it can be found or undefined.
 ### remove() {#remove}
-> **remove**(`id`): `Promise`\<`void`\>
+> **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 Remove the entity.
@@ -158,6 +170,12 @@ Remove the entity.
 The id of the entity to remove.
+##### conditions?
+`object`[]
+The optional conditions to match for the entities.
 #### Returns
 `Promise`\<`void`\>
@@ -216,10 +234,18 @@ Nothing.
 ### count() {#count}
-> **count**(): `Promise`\<`number`\>
+> **count**(`conditions?`): `Promise`\<`number`\>
 Count all the entities which match the conditions.
+#### Parameters
+##### conditions?
+`EntityCondition`\<`T`\>
+The optional conditions to match for the entities.
 #### Returns
 `Promise`\<`number`\>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-service",
-	"version": "0.0.3-next.13",
+	"version": "0.0.3-next.14",
 	"description": "Service layer exposing storage contracts 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.3-next.13",
+		"@twin.org/entity-storage-models": "0.0.3-next.14",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},