@twin.org/entity-storage-service 0.0.2-next.9 → 0.0.3-next.10

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Entity Storage Service
+# Entity Storage Service
 
-Entity Storage contract implementation and REST endpoint definitions.
+This package defines the service-facing contracts and REST endpoint definitions used to expose storage behaviour consistently. It is designed to work with the wider storage ecosystem so applications can keep behaviour consistent across connectors and environments.
 
 ## Installation
 

package/dist/es/entityStorageRoutes.js

@@ -0,0 +1,399 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { HttpParameterHelper } from "@twin.org/api-models";
+import { Coerce, ComponentFactory, Guards, StringHelper } from "@twin.org/core";
+import { HttpStatusCode } from "@twin.org/web";
+/**
+ * The source used when communicating about these routes.
+ */
+const ROUTES_SOURCE = "entityStorageRoutes";
+/**
+ * The tag to associate with the routes.
+ */
+export const tagsEntityStorage = [
+    {
+        name: "EntityStorage",
+        description: "Endpoints which are modelled to access an entity storage contract."
+    }
+];
+/**
+ * The REST routes for entity storage.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param options Additional options for the routes.
+ * @param options.typeName Optional type name to use in the routes, defaults to Entity Storage.
+ * @param options.tagName Optional name to use in OpenAPI spec for tag.
+ * @param options.examples Optional examples to use in the routes.
+ * @returns The generated routes.
+ */
+export function generateRestRoutesEntityStorage(baseRouteName, componentName, options) {
+    const typeName = options?.typeName ?? "Entity Storage";
+    const lowerName = typeName.toLowerCase();
+    const camelTypeName = StringHelper.camelCase(typeName);
+    const setRoute = {
+        operationId: `${camelTypeName}Set`,
+        summary: `Set an entry in ${lowerName}.`,
+        tag: options?.tagName ?? tagsEntityStorage[0].name,
+        method: "POST",
+        path: `${baseRouteName}/`,
+        handler: async (httpRequestContext, request) => entityStorageSet(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IEntityStorageSetRequest",
+            examples: options?.examples?.set?.requestExamples ?? [
+                {
+                    id: `${camelTypeName}SetRequestExample`,
+                    request: {
+                        body: {
+                            id: "12345",
+                            name: "My Item"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            }
+        ]
+    };
+    const setBatchRoute = {
+        operationId: `${camelTypeName}SetBatch`,
+        summary: `Set multiple entries in ${lowerName}.`,
+        tag: options?.tagName ?? tagsEntityStorage[0].name,
+        method: "POST",
+        path: `${baseRouteName}/batch`,
+        handler: async (httpRequestContext, request) => entityStorageSetBatch(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IEntityStorageSetBatchRequest",
+            examples: [
+                {
+                    id: `${camelTypeName}SetBatchRequestExample`,
+                    request: {
+                        body: [
+                            { id: "12345", name: "My Item" },
+                            { id: "67890", name: "My Other Item" }
+                        ]
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            }
+        ]
+    };
+    const getRoute = {
+        operationId: `${camelTypeName}Get`,
+        summary: `Get an entry from ${lowerName}.`,
+        tag: options?.tagName ?? tagsEntityStorage[0].name,
+        method: "GET",
+        path: `${baseRouteName}/:id`,
+        handler: async (httpRequestContext, request) => entityStorageGet(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IEntityStorageGetRequest",
+            examples: options?.examples?.get?.requestExamples ?? [
+                {
+                    id: `${camelTypeName}GetRequestExample`,
+                    request: {
+                        pathParams: {
+                            id: "12345"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IEntityStorageGetResponse",
+                examples: options?.examples?.get?.responseExamples ?? [
+                    {
+                        id: `${camelTypeName}GetResponseExample`,
+                        response: {
+                            body: {
+                                id: "12345",
+                                name: "My Item"
+                            }
+                        }
+                    }
+                ]
+            },
+            {
+                type: "INotFoundResponse"
+            }
+        ]
+    };
+    const removeRoute = {
+        operationId: `${camelTypeName}Remove`,
+        summary: `Remove an entry from ${lowerName}.`,
+        tag: options?.tagName ?? tagsEntityStorage[0].name,
+        method: "DELETE",
+        path: `${baseRouteName}/:id`,
+        handler: async (httpRequestContext, request) => entityStorageRemove(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IEntityStorageRemoveRequest",
+            examples: options?.examples?.remove?.requestExamples ?? [
+                {
+                    id: `${camelTypeName}RemoveRequestExample`,
+                    request: {
+                        pathParams: {
+                            id: "12345"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            },
+            {
+                type: "INotFoundResponse"
+            }
+        ]
+    };
+    const listRoute = {
+        operationId: `${camelTypeName}List`,
+        summary: `Query entries from ${lowerName}.`,
+        tag: options?.tagName ?? tagsEntityStorage[0].name,
+        method: "GET",
+        path: `${baseRouteName}/`,
+        handler: async (httpRequestContext, request) => entityStorageList(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IEntityStorageListRequest",
+            examples: options?.examples?.list?.requestExamples ?? [
+                {
+                    id: `${camelTypeName}ListRequestExample`,
+                    request: {}
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IEntityStorageListResponse",
+                examples: options?.examples?.list?.responseExamples ?? [
+                    {
+                        id: `${camelTypeName}ListResponseExample`,
+                        response: {
+                            body: {
+                                entities: [{ id: "12345", name: "My Item" }]
+                            }
+                        }
+                    }
+                ]
+            }
+        ]
+    };
+    const countRoute = {
+        operationId: `${camelTypeName}Count`,
+        summary: `Count entries in ${lowerName}.`,
+        tag: options?.tagName ?? tagsEntityStorage[0].name,
+        method: "GET",
+        path: `${baseRouteName}/count`,
+        handler: async (httpRequestContext, request) => entityStorageCount(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IEntityStorageCountRequest",
+            examples: options?.examples?.count?.requestExamples ?? [
+                {
+                    id: `${camelTypeName}CountRequestExample`,
+                    request: {}
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IEntityStorageCountResponse",
+                examples: options?.examples?.count?.responseExamples ?? [
+                    {
+                        id: `${camelTypeName}CountResponseExample`,
+                        response: {
+                            body: {
+                                count: 1
+                            }
+                        }
+                    }
+                ]
+            }
+        ]
+    };
+    const emptyRoute = {
+        operationId: `${camelTypeName}Empty`,
+        summary: `Remove all entries from ${lowerName}.`,
+        tag: options?.tagName ?? tagsEntityStorage[0].name,
+        method: "DELETE",
+        path: `${baseRouteName}/`,
+        handler: async (httpRequestContext, request) => entityStorageEmpty(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IEntityStorageEmptyRequest",
+            examples: [
+                {
+                    id: `${camelTypeName}EmptyRequestExample`,
+                    request: {}
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            }
+        ]
+    };
+    const removeBatchRoute = {
+        operationId: `${camelTypeName}RemoveBatch`,
+        summary: `Remove multiple entries from ${lowerName} by id.`,
+        tag: options?.tagName ?? tagsEntityStorage[0].name,
+        method: "DELETE",
+        path: `${baseRouteName}/batch`,
+        handler: async (httpRequestContext, request) => entityStorageRemoveBatch(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IEntityStorageRemoveBatchRequest",
+            examples: [
+                {
+                    id: `${camelTypeName}RemoveBatchRequestExample`,
+                    request: {
+                        body: ["12345", "67890"]
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            }
+        ]
+    };
+    return [
+        setRoute,
+        setBatchRoute,
+        getRoute,
+        removeRoute,
+        removeBatchRoute,
+        emptyRoute,
+        listRoute,
+        countRoute
+    ];
+}
+/**
+ * Set the entry in entity storage.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function entityStorageSet(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    const component = ComponentFactory.get(componentName);
+    await component.set(request.body);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
+/**
+ * Set multiple entries in entity storage.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function entityStorageSetBatch(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.arrayValue(ROUTES_SOURCE, "request.body", request.body);
+    const component = ComponentFactory.get(componentName);
+    await component.setBatch(request.body);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
+/**
+ * Remove all entries from entity storage.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function entityStorageEmpty(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    await component.empty();
+    return { statusCode: HttpStatusCode.noContent };
+}
+/**
+ * Get the entry from entity storage.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function entityStorageGet(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    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);
+    return {
+        body: item
+    };
+}
+/**
+ * Remove the entry from entity storage.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function entityStorageRemove(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    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);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
+/**
+ * Query the entries from entity storage.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function entityStorageList(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    const component = ComponentFactory.get(componentName);
+    const result = await component.query(HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, HttpParameterHelper.objectFromString(request.query?.properties), request.query?.cursor, Coerce.number(request.query?.limit));
+    return {
+        body: result
+    };
+}
+/**
+ * Count the entries in entity storage.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function entityStorageCount(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    const count = await component.count();
+    return {
+        body: { count }
+    };
+}
+/**
+ * Remove multiple entries from entity storage by id.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function entityStorageRemoveBatch(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.arrayValue(ROUTES_SOURCE, "request.body", request.body);
+    const component = ComponentFactory.get(componentName);
+    await component.removeBatch(request.body);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
+//# sourceMappingURL=entityStorageRoutes.js.map

package/dist/es/entityStorageRoutes.js.map

@@ -0,0 +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"]}

package/dist/es/entityStorageService.js

@@ -0,0 +1,113 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Guards, Is } from "@twin.org/core";
+import { SortDirection } from "@twin.org/entity";
+import { EntityStorageConnectorFactory } from "@twin.org/entity-storage-models";
+/**
+ * Class for performing entity service operations.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export class EntityStorageService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "EntityStorageService";
+    /**
+     * The entity storage for items.
+     * @internal
+     */
+    _entityStorage;
+    /**
+     * Create a new instance of EntityStorageService.
+     * @param options The dependencies for the entity storage service.
+     */
+    constructor(options) {
+        Guards.string(EntityStorageService.CLASS_NAME, "options.entityStorageType", options.entityStorageType);
+        this._entityStorage = EntityStorageConnectorFactory.get(options.entityStorageType);
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return EntityStorageService.CLASS_NAME;
+    }
+    /**
+     * Set an entity.
+     * @param entity The entity to set.
+     * @returns The id of the entity.
+     */
+    async set(entity) {
+        Guards.object(EntityStorageService.CLASS_NAME, "entity", entity);
+        return this._entityStorage.set(entity, undefined);
+    }
+    /**
+     * Set multiple entities in a batch.
+     * @param entities The entities to set.
+     * @returns Nothing.
+     */
+    async setBatch(entities) {
+        Guards.arrayValue(EntityStorageService.CLASS_NAME, "entities", entities);
+        return this._entityStorage.setBatch(entities);
+    }
+    /**
+     * 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.
+     * @returns The object if it can be found or undefined.
+     */
+    async get(id, secondaryIndex) {
+        Guards.stringValue(EntityStorageService.CLASS_NAME, "id", id);
+        return this._entityStorage.get(id, secondaryIndex);
+    }
+    /**
+     * Remove the entity.
+     * @param id The id of the entity to remove.
+     * @returns Nothing.
+     */
+    async remove(id) {
+        Guards.stringValue(EntityStorageService.CLASS_NAME, "id", id);
+        await this._entityStorage.remove(id);
+    }
+    /**
+     * Remove multiple entities by id.
+     * @param ids The ids of the entities to remove.
+     * @returns Nothing.
+     */
+    async removeBatch(ids) {
+        Guards.arrayValue(EntityStorageService.CLASS_NAME, "ids", ids);
+        return this._entityStorage.removeBatch(ids);
+    }
+    /**
+     * Remove all entities from the storage.
+     * @returns Nothing.
+     */
+    async empty() {
+        return this._entityStorage.empty();
+    }
+    /**
+     * Count all the entities which match the conditions.
+     * @returns The total count of entities in the storage.
+     */
+    async count() {
+        return this._entityStorage.count();
+    }
+    /**
+     * Query all the entities which match the conditions.
+     * @param conditions The conditions to match for the entities.
+     * @param orderBy The order for the results.
+     * @param orderByDirection The direction for the order, defaults to ascending.
+     * @param properties The optional properties to return, defaults to all.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    async query(conditions, orderBy, orderByDirection, properties, cursor, limit) {
+        const result = await this._entityStorage.query(conditions, Is.stringValue(orderBy)
+            ? [{ property: orderBy, sortDirection: orderByDirection ?? SortDirection.Ascending }]
+            : undefined, properties, cursor, limit);
+        return result;
+    }
+}
+//# sourceMappingURL=entityStorageService.js.map

package/dist/es/entityStorageService.js.map

@@ -0,0 +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"]}

package/dist/es/index.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./entityStorageRoutes.js";
+export * from "./entityStorageService.js";
+export * from "./models/IEntityStorageServiceConfig.js";
+export * from "./models/IEntityStorageRoutesExamples.js";
+export * from "./models/IEntityStorageServiceConstructorOptions.js";
+export * from "./restEntryPoints.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,qDAAqD,CAAC;AACpE,cAAc,sBAAsB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./entityStorageRoutes.js\";\nexport * from \"./entityStorageService.js\";\nexport * from \"./models/IEntityStorageServiceConfig.js\";\nexport * from \"./models/IEntityStorageRoutesExamples.js\";\nexport * from \"./models/IEntityStorageServiceConstructorOptions.js\";\nexport * from \"./restEntryPoints.js\";\n"]}

package/dist/es/models/IEntityStorageRoutesExamples.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageRoutesExamples.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageRoutesExamples.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteRequestExample, IRestRouteResponseExample } from \"@twin.org/api-models\";\nimport type {\n\tIEntityStorageCountRequest,\n\tIEntityStorageCountResponse,\n\tIEntityStorageGetRequest,\n\tIEntityStorageGetResponse,\n\tIEntityStorageListRequest,\n\tIEntityStorageListResponse,\n\tIEntityStorageRemoveRequest,\n\tIEntityStorageSetRequest\n} from \"@twin.org/entity-storage-models\";\n\n/**\n * Examples for the entity storage routes.\n */\nexport interface IEntityStorageRoutesExamples {\n\t/**\n\t * Examples for the set route.\n\t */\n\tset?: {\n\t\trequestExamples: IRestRouteRequestExample<IEntityStorageSetRequest>[];\n\t};\n\n\t/**\n\t * Examples for the get route.\n\t */\n\tget?: {\n\t\trequestExamples: IRestRouteRequestExample<IEntityStorageGetRequest>[];\n\t\tresponseExamples: IRestRouteResponseExample<IEntityStorageGetResponse>[];\n\t};\n\n\t/**\n\t * Examples for the remove route.\n\t */\n\tremove?: {\n\t\trequestExamples: IRestRouteRequestExample<IEntityStorageRemoveRequest>[];\n\t};\n\n\t/**\n\t * Examples for the list route.\n\t */\n\tlist?: {\n\t\trequestExamples: IRestRouteRequestExample<IEntityStorageListRequest>[];\n\t\tresponseExamples: IRestRouteResponseExample<IEntityStorageListResponse>[];\n\t};\n\n\t/**\n\t * Examples for the count route.\n\t */\n\tcount?: {\n\t\trequestExamples: IRestRouteRequestExample<IEntityStorageCountRequest>[];\n\t\tresponseExamples: IRestRouteResponseExample<IEntityStorageCountResponse>[];\n\t};\n}\n"]}

package/dist/es/models/IEntityStorageServiceConfig.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageServiceConfig.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageServiceConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the entity storage service.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface IEntityStorageServiceConfig {}\n"]}

package/dist/es/models/IEntityStorageServiceConstructorOptions.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityStorageServiceConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageServiceConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEntityStorageServiceConfig } from \"./IEntityStorageServiceConfig.js\";\n\n/**\n * Options for the Entity Storage Service constructor.\n */\nexport interface IEntityStorageServiceConstructorOptions {\n\t/**\n\t * The type of the entity storage.\n\t */\n\tentityStorageType: string;\n\n\t/**\n\t * The configuration for the service.\n\t */\n\tconfig?: IEntityStorageServiceConfig;\n}\n"]}

package/dist/es/restEntryPoints.js

@@ -0,0 +1,15 @@
+import { generateRestRoutesEntityStorage, tagsEntityStorage } from "./entityStorageRoutes.js";
+/**
+ * These are dummy entry points for the entity storage service.
+ * In reality your application would create its own entry points based on the
+ * entity storage schema objects it wants to store, using a custom defaultBaseRoute.
+ */
+export const restEntryPoints = [
+    {
+        name: "entity-storage",
+        defaultBaseRoute: "entity-storage",
+        tags: tagsEntityStorage,
+        generateRoutes: generateRestRoutesEntityStorage
+    }
+];
+//# sourceMappingURL=restEntryPoints.js.map