@twin.org/verifiable-storage-service 0.0.2-next.6 → 0.0.3-next.10

package/README.md

@@ -1,6 +1,8 @@
 # TWIN Verifiable Storage Service
 
-Verifiable Storage contract implementation and REST endpoint definitions.
+This package provides the service layer for verifiable storage, exposing component logic and REST route definitions that can be mounted in API applications. It translates storage operations into a consistent service interface for upstream consumers.
+
+The package is useful when you need to host verifiable storage capabilities behind HTTP endpoints while retaining the same contracts used by connectors and clients.
 
 ## Installation
 

package/dist/es/index.js

@@ -0,0 +1,8 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./models/IVerifiableStorageServiceConfig.js";
+export * from "./models/IVerifiableStorageServiceConstructorOptions.js";
+export * from "./verifiableStorageRoutes.js";
+export * from "./verifiableStorageService.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,6CAA6C,CAAC;AAC5D,cAAc,yDAAyD,CAAC;AACxE,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sBAAsB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/IVerifiableStorageServiceConfig.js\";\nexport * from \"./models/IVerifiableStorageServiceConstructorOptions.js\";\nexport * from \"./verifiableStorageRoutes.js\";\nexport * from \"./verifiableStorageService.js\";\nexport * from \"./restEntryPoints.js\";\n"]}

package/dist/es/models/IVerifiableStorageServiceConfig.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageServiceConfig.js","sourceRoot":"","sources":["../../../src/models/IVerifiableStorageServiceConfig.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 Verifiable Storage Service.\n */\nexport interface IVerifiableStorageServiceConfig {\n\t/**\n\t * What is the default connector to use for Verifiable Storage. If not provided the first connector from the factory will be used.\n\t */\n\tdefaultNamespace?: string;\n}\n"]}

package/dist/es/models/IVerifiableStorageServiceConstructorOptions.js

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

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

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

package/dist/es/restEntryPoints.js

@@ -0,0 +1,10 @@
+import { generateRestRoutesVerifiableStorage, tagsVerifiableStorage } from "./verifiableStorageRoutes.js";
+export const restEntryPoints = [
+    {
+        name: "verifiable",
+        defaultBaseRoute: "verifiable",
+        tags: tagsVerifiableStorage,
+        generateRoutes: generateRestRoutesVerifiableStorage
+    }
+];
+//# sourceMappingURL=restEntryPoints.js.map

package/dist/es/restEntryPoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restEntryPoints.js","sourceRoot":"","sources":["../../src/restEntryPoints.ts"],"names":[],"mappings":"AAGA,OAAO,EACN,mCAAmC,EACnC,qBAAqB,EACrB,MAAM,8BAA8B,CAAC;AAEtC,MAAM,CAAC,MAAM,eAAe,GAA2B;IACtD;QACC,IAAI,EAAE,YAAY;QAClB,gBAAgB,EAAE,YAAY;QAC9B,IAAI,EAAE,qBAAqB;QAC3B,cAAc,EAAE,mCAAmC;KACnD;CACD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteEntryPoint } from \"@twin.org/api-models\";\nimport {\n\tgenerateRestRoutesVerifiableStorage,\n\ttagsVerifiableStorage\n} from \"./verifiableStorageRoutes.js\";\n\nexport const restEntryPoints: IRestRouteEntryPoint[] = [\n\t{\n\t\tname: \"verifiable\",\n\t\tdefaultBaseRoute: \"verifiable\",\n\t\ttags: tagsVerifiableStorage,\n\t\tgenerateRoutes: generateRestRoutesVerifiableStorage\n\t}\n];\n"]}

package/dist/{esm/index.mjs → es/verifiableStorageRoutes.js}

@@ -1,7 +1,6 @@
-import { Guards, ComponentFactory, Converter, Is, GeneralError, Urn } from '@twin.org/core';
-import { HttpStatusCode, HeaderTypes } from '@twin.org/web';
-import { VerifiableStorageConnectorFactory } from '@twin.org/verifiable-storage-models';
-
+import { ContextIdHelper, ContextIdKeys, ContextIdStore } from "@twin.org/context";
+import { ComponentFactory, Converter, Guards, Is } from "@twin.org/core";
+import { HeaderTypes, HttpStatusCode } from "@twin.org/web";
 /**
  * The source used when communicating about these routes.
  */
@@ -9,7 +8,7 @@ const ROUTES_SOURCE = "verifiableStorageRoutes";
 /**
  * The tag to associate with the routes.
  */
-const tagsVerifiableStorage = [
+export const tagsVerifiableStorage = [
     {
         name: "VerifiableStorage",
         description: "Endpoints which are modelled to access a verifiable storage."
@@ -21,7 +20,7 @@ const tagsVerifiableStorage = [
  * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
  * @returns The generated routes.
  */
-function generateRestRoutesVerifiableStorage(baseRouteName, componentName) {
+export function generateRestRoutesVerifiableStorage(baseRouteName, componentName) {
     const createRoute = {
         operationId: "verifiableStorageCreate",
         summary: "Create an item in verifiable storage",
@@ -56,7 +55,7 @@ function generateRestRoutesVerifiableStorage(baseRouteName, componentName) {
                             body: {
                                 receipt: {
                                     "@context": "https://schema.twindev.org/verifiable-storage/",
-                                    type: "VerifiableStorageIotaReceipt"
+                                    type: "VerifiableStorageIotaReceipt2026"
                                 },
                                 id: "verifiable:iota:aW90YS1uZnQ6dHN0OjB4NzYyYjljNDllYTg2OWUwZWJkYTliYmZhNzY5Mzk0NDdhNDI4ZGNmMTc4YzVkMTVhYjQ0N2UyZDRmYmJiNGViMg=="
                             }
@@ -98,7 +97,7 @@ function generateRestRoutesVerifiableStorage(baseRouteName, componentName) {
                         response: {
                             body: {
                                 "@context": "https://schema.twindev.org/verifiable-storage/",
-                                type: "VerifiableStorageIotaReceipt"
+                                type: "VerifiableStorageIotaReceipt2026"
                             }
                         }
                     }
@@ -183,14 +182,16 @@ function generateRestRoutesVerifiableStorage(baseRouteName, componentName) {
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-async function verifiableStorageCreate(httpRequestContext, componentName, request) {
+export async function verifiableStorageCreate(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.body", request.body);
     Guards.stringBase64(ROUTES_SOURCE, "request.body.data", request.body.data);
+    const contextIds = await ContextIdStore.getContextIds();
+    ContextIdHelper.guard(contextIds, ContextIdKeys.Organization);
     const component = ComponentFactory.get(componentName);
     const result = await component.create(Converter.base64ToBytes(request.body.data), request.body.allowList, {
         maxAllowListSize: request.body.maxAllowListSize
-    }, httpRequestContext.userIdentity, request.body.namespace);
+    }, request.body.namespace, contextIds[ContextIdKeys.Organization]);
     return {
         statusCode: HttpStatusCode.created,
         headers: {
@@ -209,14 +210,16 @@ async function verifiableStorageCreate(httpRequestContext, componentName, reques
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-async function verifiableStorageUpdate(httpRequestContext, componentName, request) {
+export async function verifiableStorageUpdate(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);
     Guards.object(ROUTES_SOURCE, "request.body", request.body);
     Guards.stringBase64(ROUTES_SOURCE, "request.body.data", request.body.data);
+    const contextIds = await ContextIdStore.getContextIds();
+    ContextIdHelper.guard(contextIds, ContextIdKeys.Organization);
     const component = ComponentFactory.get(componentName);
-    const result = await component.update(request.pathParams.id, Is.stringBase64(request.body.data) ? Converter.base64ToBytes(request.body.data) : undefined, request.body.allowList, httpRequestContext.userIdentity);
+    const result = await component.update(request.pathParams.id, Is.stringBase64(request.body.data) ? Converter.base64ToBytes(request.body.data) : undefined, request.body.allowList, contextIds[ContextIdKeys.Organization]);
     return {
         body: result
     };
@@ -227,7 +230,7 @@ async function verifiableStorageUpdate(httpRequestContext, componentName, reques
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-async function verifiableStorageGet(componentName, request) {
+export async function verifiableStorageGet(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);
@@ -248,151 +251,16 @@ async function verifiableStorageGet(componentName, request) {
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-async function verifiableStorageRemove(httpRequestContext, componentName, request) {
+export async function verifiableStorageRemove(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 contextIds = await ContextIdStore.getContextIds();
+    ContextIdHelper.guard(contextIds, ContextIdKeys.Organization);
     const component = ComponentFactory.get(componentName);
-    await component.remove(request.pathParams.id, httpRequestContext.userIdentity);
+    await component.remove(request.pathParams.id, contextIds[ContextIdKeys.Organization]);
     return {
         statusCode: HttpStatusCode.noContent
     };
 }
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Service for performing Verifiable Storage operations to a connector.
- */
-class VerifiableStorageService {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "VerifiableStorageService";
-    /**
-     * The namespace supported by the verifiableStorage service.
-     * @internal
-     */
-    static _NAMESPACE = "verifiable";
-    /**
-     * The default namespace for the connector to use.
-     * @internal
-     */
-    _defaultNamespace;
-    /**
-     * Create a new instance of VerifiableStorageService.
-     * @param options The options for the service.
-     */
-    constructor(options) {
-        const names = VerifiableStorageConnectorFactory.names();
-        if (names.length === 0) {
-            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "noConnectors");
-        }
-        this._defaultNamespace = options?.config?.defaultNamespace ?? names[0];
-    }
-    /**
-     * Create a verifiable storage item.
-     * @param data The data for the verifiable storage item.
-     * @param allowList The list of identities that are allowed to modify the item.
-     * @param options Additional options for creating the item.
-     * @param options.maxAllowListSize The maximum size of the allow list.
-     * @param identity The identity to store the Verifiable Storage operation on.
-     * @param namespace The namespace to use for the Verifiable Storage.
-     * @returns The id of the created verifiable storage item.
-     */
-    async create(data, allowList, options, identity, namespace) {
-        Guards.uint8Array(VerifiableStorageService.CLASS_NAME, "data", data);
-        Guards.stringValue(VerifiableStorageService.CLASS_NAME, "identity", identity);
-        try {
-            const connectorNamespace = namespace ?? this._defaultNamespace;
-            const verifiableStorageConnector = VerifiableStorageConnectorFactory.get(connectorNamespace);
-            const verifiableStorageResult = await verifiableStorageConnector.create(identity, data, allowList, options);
-            return verifiableStorageResult;
-        }
-        catch (error) {
-            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "createFailed", undefined, error);
-        }
-    }
-    /**
-     * Update an item in verifiable storage.
-     * @param id The id of the item to update.
-     * @param data The data to store, optional if updating the allow list.
-     * @param allowList Updated list of identities that are allowed to modify the item.
-     * @param identity The identity of the user to access the vault keys.
-     * @returns The updated receipt.
-     */
-    async update(id, data, allowList, identity) {
-        Urn.guard(VerifiableStorageService.CLASS_NAME, "id", id);
-        Guards.stringValue(VerifiableStorageService.CLASS_NAME, "identity", identity);
-        try {
-            const verifiableStorageConnector = this.getConnector(id);
-            const verifiableStorageResult = await verifiableStorageConnector.update(identity, id, data, allowList);
-            return verifiableStorageResult;
-        }
-        catch (error) {
-            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "updateFailed", undefined, error);
-        }
-    }
-    /**
-     * Get an Verifiable Storage.
-     * @param id The id of the verifiable storage item to get.
-     * @param options Additional options for getting the verifiable storage item.
-     * @param options.includeData Should the data be included in the response, defaults to true.
-     * @param options.includeAllowList Should the allow list be included in the response, defaults to true.
-     * @returns The data for the verifiable storage item.
-     */
-    async get(id, options) {
-        Urn.guard(VerifiableStorageService.CLASS_NAME, "id", id);
-        try {
-            const verifiableStorageConnector = this.getConnector(id);
-            return verifiableStorageConnector.get(id, options);
-        }
-        catch (error) {
-            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "getFailed", undefined, error);
-        }
-    }
-    /**
-     * Remove a verifiable storage item.
-     * @param id The id of the Verifiable Storage to remove.
-     * @param identity The identity to perform the verifiableStorage operation on.
-     * @returns Nothing.
-     */
-    async remove(id, identity) {
-        Urn.guard(VerifiableStorageService.CLASS_NAME, "id", id);
-        Guards.stringValue(VerifiableStorageService.CLASS_NAME, "identity", identity);
-        try {
-            const verifiableStorageConnector = this.getConnector(id);
-            await verifiableStorageConnector.remove(identity, id);
-        }
-        catch (error) {
-            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "removeFailed", undefined, error);
-        }
-    }
-    /**
-     * Get the connector from the uri.
-     * @param id The id of the item in urn format.
-     * @returns The connector.
-     * @internal
-     */
-    getConnector(id) {
-        const idUri = Urn.fromValidString(id);
-        if (idUri.namespaceIdentifier() !== VerifiableStorageService._NAMESPACE) {
-            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "namespaceMismatch", {
-                namespace: VerifiableStorageService._NAMESPACE,
-                id
-            });
-        }
-        return VerifiableStorageConnectorFactory.get(idUri.namespaceMethod());
-    }
-}
-
-const restEntryPoints = [
-    {
-        name: "verifiable",
-        defaultBaseRoute: "verifiable",
-        tags: tagsVerifiableStorage,
-        generateRoutes: generateRestRoutesVerifiableStorage
-    }
-];
-
-export { VerifiableStorageService, generateRestRoutesVerifiableStorage, restEntryPoints, tagsVerifiableStorage, verifiableStorageCreate, verifiableStorageGet, verifiableStorageRemove, verifiableStorageUpdate };
+//# sourceMappingURL=verifiableStorageRoutes.js.map

package/dist/es/verifiableStorageRoutes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifiableStorageRoutes.js","sourceRoot":"","sources":["../../src/verifiableStorageRoutes.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAYzE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE5D;;GAEG;AACH,MAAM,aAAa,GAAG,yBAAyB,CAAC;AAEhD;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAW;IAC5C;QACC,IAAI,EAAE,mBAAmB;QACzB,WAAW,EAAE,8DAA8D;KAC3E;CACD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,mCAAmC,CAClD,aAAqB,EACrB,aAAqB;IAErB,MAAM,WAAW,GAChB;QACC,WAAW,EAAE,yBAAyB;QACtC,OAAO,EAAE,sCAAsC;QAC/C,GAAG,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,uBAAuB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACpE,WAAW,EAAE;YACZ,IAAI,mCAA2C;YAC/C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,uCAAuC;oBAC3C,OAAO,EAAE;wBACR,IAAI,EAAE;4BACL,IAAI,EAAE,kBAAkB;yBACxB;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,oCAA4C;gBAChD,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,wCAAwC;wBAC5C,QAAQ,EAAE;4BACT,UAAU,EAAE,cAAc,CAAC,OAAO;4BAClC,OAAO,EAAE;gCACR,CAAC,WAAW,CAAC,QAAQ,CAAC,EACrB,8HAA8H;6BAC/H;4BACD,IAAI,EAAE;gCACL,OAAO,EAAE;oCACR,UAAU,EAAE,gDAAgD;oCAC5D,IAAI,EAAE,kCAAkC;iCACxC;gCACD,EAAE,EAAE,8HAA8H;6BAClI;yBACD;qBACD;iBACD;aACD;SACD;KACD,CAAC;IAEH,MAAM,WAAW,GAChB;QACC,WAAW,EAAE,yBAAyB;QACtC,OAAO,EAAE,sCAAsC;QAC/C,GAAG,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,MAAM;QAC5B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,uBAAuB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACpE,WAAW,EAAE;YACZ,IAAI,mCAA2C;YAC/C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,uCAAuC;oBAC3C,OAAO,EAAE;wBACR,UAAU,EAAE;4BACX,EAAE,EAAE,8HAA8H;yBAClI;wBACD,IAAI,EAAE;4BACL,IAAI,EAAE,kBAAkB;yBACxB;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,oCAA4C;gBAChD,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,wCAAwC;wBAC5C,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,UAAU,EAAE,gDAAgD;gCAC5D,IAAI,EAAE,kCAAkC;6BACxC;yBACD;qBACD;iBACD;aACD;SACD;KACD,CAAC;IAEH,MAAM,QAAQ,GAA4E;QACzF,WAAW,EAAE,sBAAsB;QACnC,OAAO,EAAE,gCAAgC;QACzC,GAAG,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,MAAM;QAC5B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAAC,oBAAoB,CAAC,aAAa,EAAE,OAAO,CAAC;QAC5F,WAAW,EAAE;YACZ,IAAI,gCAAwC;YAC5C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,oCAAoC;oBACxC,OAAO,EAAE;wBACR,UAAU,EAAE;4BACX,EAAE,EAAE,8HAA8H;yBAClI;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,iCAAyC;gBAC7C,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,qCAAqC;wBACzC,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,IAAI,EAAE,kBAAkB;gCACxB,OAAO,EAAE;oCACR,UAAU,EAAE,uCAAuC;oCACnD,IAAI,EAAE,QAAQ;oCACd,KAAK,EAAE,2BAA2B;oCAClC,MAAM,EAAE,4BAA4B;iCACpC;6BACD;yBACD;qBACD;iBACD;aACD;SACD;KACD,CAAC;IAEF,MAAM,WAAW,GAAoE;QACpF,WAAW,EAAE,yBAAyB;QACtC,OAAO,EAAE,wCAAwC;QACjD,GAAG,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,IAAI;QAClC,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,GAAG,aAAa,MAAM;QAC5B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,uBAAuB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACpE,WAAW,EAAE;YACZ,IAAI,mCAA2C;YAC/C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,uCAAuC;oBAC3C,OAAO,EAAE;wBACR,UAAU,EAAE;4BACX,EAAE,EAAE,8HAA8H;yBAClI;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;SACD;KACD,CAAC;IAEF,OAAO,CAAC,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC5C,kBAAuC,EACvC,aAAqB,EACrB,OAAwC;IAExC,MAAM,CAAC,MAAM,CAAkC,aAAa,aAAmB,OAAO,CAAC,CAAC;IACxF,MAAM,CAAC,MAAM,CACZ,aAAa,kBAEb,OAAO,CAAC,IAAI,CACZ,CAAC;IACF,MAAM,CAAC,YAAY,CAAC,aAAa,uBAA6B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEjF,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;IACxD,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IAE9D,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA8B,aAAa,CAAC,CAAC;IACnF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,MAAM,CACpC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAC1C,OAAO,CAAC,IAAI,CAAC,SAAS,EACtB;QACC,gBAAgB,EAAE,OAAO,CAAC,IAAI,CAAC,gBAAgB;KAC/C,EACD,OAAO,CAAC,IAAI,CAAC,SAAS,EACtB,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CACtC,CAAC;IACF,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,OAAO;QAClC,OAAO,EAAE;YACR,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,EAAE;SACjC;QACD,IAAI,EAAE;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,EAAE,EAAE,MAAM,CAAC,EAAE;SACb;KACD,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC5C,kBAAuC,EACvC,aAAqB,EACrB,OAAwC;IAExC,MAAM,CAAC,MAAM,CAAkC,aAAa,aAAmB,OAAO,CAAC,CAAC;IACxF,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;IACxF,MAAM,CAAC,MAAM,CACZ,aAAa,kBAEb,OAAO,CAAC,IAAI,CACZ,CAAC;IACF,MAAM,CAAC,YAAY,CAAC,aAAa,uBAA6B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEjF,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;IACxD,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IAE9D,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA8B,aAAa,CAAC,CAAC;IACnF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,MAAM,CACpC,OAAO,CAAC,UAAU,CAAC,EAAE,EACrB,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,EAC3F,OAAO,CAAC,IAAI,CAAC,SAAS,EACtB,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CACtC,CAAC;IACF,OAAO;QACN,IAAI,EAAE,MAAM;KACZ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACzC,aAAqB,EACrB,OAAqC;IAErC,MAAM,CAAC,MAAM,CAA+B,aAAa,aAAmB,OAAO,CAAC,CAAC;IACrF,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,CAA8B,aAAa,CAAC,CAAC;IACnF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,OAAO;QACN,IAAI,EAAE;YACL,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YACnF,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,SAAS,EAAE,MAAM,CAAC,SAAS;SAC3B;KACD,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC5C,kBAAuC,EACvC,aAAqB,EACrB,OAAwC;IAExC,MAAM,CAAC,MAAM,CAAkC,aAAa,aAAmB,OAAO,CAAC,CAAC;IACxF,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,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;IACxD,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IAE9D,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA8B,aAAa,CAAC,CAAC;IACnF,MAAM,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;IAEtF,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIHttpRequestContext,\n\tINoContentResponse,\n\tIRestRoute,\n\tITag\n} from \"@twin.org/api-models\";\nimport { ContextIdHelper, ContextIdKeys, ContextIdStore } from \"@twin.org/context\";\nimport { ComponentFactory, Converter, Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type {\n\tIVerifiableStorageComponent,\n\tIVerifiableStorageCreateRequest,\n\tIVerifiableStorageCreateResponse,\n\tIVerifiableStorageGetRequest,\n\tIVerifiableStorageGetResponse,\n\tIVerifiableStorageRemoveRequest,\n\tIVerifiableStorageUpdateRequest,\n\tIVerifiableStorageUpdateResponse\n} from \"@twin.org/verifiable-storage-models\";\nimport { HeaderTypes, HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The source used when communicating about these routes.\n */\nconst ROUTES_SOURCE = \"verifiableStorageRoutes\";\n\n/**\n * The tag to associate with the routes.\n */\nexport const tagsVerifiableStorage: ITag[] = [\n\t{\n\t\tname: \"VerifiableStorage\",\n\t\tdescription: \"Endpoints which are modelled to access a verifiable storage.\"\n\t}\n];\n\n/**\n * The REST routes for VerifiableStorage.\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 * @returns The generated routes.\n */\nexport function generateRestRoutesVerifiableStorage(\n\tbaseRouteName: string,\n\tcomponentName: string\n): IRestRoute[] {\n\tconst createRoute: IRestRoute<IVerifiableStorageCreateRequest, IVerifiableStorageCreateResponse> =\n\t\t{\n\t\t\toperationId: \"verifiableStorageCreate\",\n\t\t\tsummary: \"Create an item in verifiable storage\",\n\t\t\ttag: tagsVerifiableStorage[0].name,\n\t\t\tmethod: \"POST\",\n\t\t\tpath: `${baseRouteName}/`,\n\t\t\thandler: async (httpRequestContext, request) =>\n\t\t\t\tverifiableStorageCreate(httpRequestContext, componentName, request),\n\t\t\trequestType: {\n\t\t\t\ttype: nameof<IVerifiableStorageCreateRequest>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"verifiableStorageCreateRequestExample\",\n\t\t\t\t\t\trequest: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tdata: \"SGVsbG8gd29ybGQ=\"\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\tresponseType: [\n\t\t\t\t{\n\t\t\t\t\ttype: nameof<IVerifiableStorageCreateResponse>(),\n\t\t\t\t\texamples: [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tid: \"verifiableStorageCreateResponseExample\",\n\t\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\t\tstatusCode: HttpStatusCode.created,\n\t\t\t\t\t\t\t\theaders: {\n\t\t\t\t\t\t\t\t\t[HeaderTypes.Location]:\n\t\t\t\t\t\t\t\t\t\t\"verifiable:iota:aW90YS1uZnQ6dHN0OjB4NzYyYjljNDllYTg2OWUwZWJkYTliYmZhNzY5Mzk0NDdhNDI4ZGNmMTc4YzVkMTVhYjQ0N2UyZDRmYmJiNGViMg==\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\t\treceipt: {\n\t\t\t\t\t\t\t\t\t\t\"@context\": \"https://schema.twindev.org/verifiable-storage/\",\n\t\t\t\t\t\t\t\t\t\ttype: \"VerifiableStorageIotaReceipt2026\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tid: \"verifiable:iota:aW90YS1uZnQ6dHN0OjB4NzYyYjljNDllYTg2OWUwZWJkYTliYmZhNzY5Mzk0NDdhNDI4ZGNmMTc4YzVkMTVhYjQ0N2UyZDRmYmJiNGViMg==\"\n\t\t\t\t\t\t\t\t}\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\n\tconst updateRoute: IRestRoute<IVerifiableStorageUpdateRequest, IVerifiableStorageUpdateResponse> =\n\t\t{\n\t\t\toperationId: \"verifiableStorageUpdate\",\n\t\t\tsummary: \"Update an item in verifiable storage\",\n\t\t\ttag: tagsVerifiableStorage[0].name,\n\t\t\tmethod: \"PUT\",\n\t\t\tpath: `${baseRouteName}/:id`,\n\t\t\thandler: async (httpRequestContext, request) =>\n\t\t\t\tverifiableStorageUpdate(httpRequestContext, componentName, request),\n\t\t\trequestType: {\n\t\t\t\ttype: nameof<IVerifiableStorageUpdateRequest>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"verifiableStorageUpdateRequestExample\",\n\t\t\t\t\t\trequest: {\n\t\t\t\t\t\t\tpathParams: {\n\t\t\t\t\t\t\t\tid: \"verifiable:iota:aW90YS1uZnQ6dHN0OjB4NzYyYjljNDllYTg2OWUwZWJkYTliYmZhNzY5Mzk0NDdhNDI4ZGNmMTc4YzVkMTVhYjQ0N2UyZDRmYmJiNGViMg==\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tdata: \"SGVsbG8gd29ybGQ=\"\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\tresponseType: [\n\t\t\t\t{\n\t\t\t\t\ttype: nameof<IVerifiableStorageUpdateResponse>(),\n\t\t\t\t\texamples: [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tid: \"verifiableStorageUpdateResponseExample\",\n\t\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\t\t\"@context\": \"https://schema.twindev.org/verifiable-storage/\",\n\t\t\t\t\t\t\t\t\ttype: \"VerifiableStorageIotaReceipt2026\"\n\t\t\t\t\t\t\t\t}\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\n\tconst getRoute: IRestRoute<IVerifiableStorageGetRequest, IVerifiableStorageGetResponse> = {\n\t\toperationId: \"verifiableStorageGet\",\n\t\tsummary: \"Get an verifiable storage item\",\n\t\ttag: tagsVerifiableStorage[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/:id`,\n\t\thandler: async (httpRequestContext, request) => verifiableStorageGet(componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IVerifiableStorageGetRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: \"verifiableStorageGetRequestExample\",\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tpathParams: {\n\t\t\t\t\t\t\tid: \"verifiable:iota:aW90YS1uZnQ6dHN0OjB4NzYyYjljNDllYTg2OWUwZWJkYTliYmZhNzY5Mzk0NDdhNDI4ZGNmMTc4YzVkMTVhYjQ0N2UyZDRmYmJiNGViMg==\"\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<IVerifiableStorageGetResponse>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"verifiableStorageGetResponseExample\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tdata: \"SGVsbG8gd29ybGQ=\",\n\t\t\t\t\t\t\t\treceipt: {\n\t\t\t\t\t\t\t\t\t\"@context\": \"https://www.w3.org/ns/activitystreams\",\n\t\t\t\t\t\t\t\t\ttype: \"Create\",\n\t\t\t\t\t\t\t\t\tactor: \"https://example.org/actor\",\n\t\t\t\t\t\t\t\t\tobject: \"https://example.org/object\"\n\t\t\t\t\t\t\t\t}\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 removeRoute: IRestRoute<IVerifiableStorageRemoveRequest, INoContentResponse> = {\n\t\toperationId: \"verifiableStorageRemove\",\n\t\tsummary: \"Remove an item from verifiable storage\",\n\t\ttag: tagsVerifiableStorage[0].name,\n\t\tmethod: \"DELETE\",\n\t\tpath: `${baseRouteName}/:id`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tverifiableStorageRemove(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IVerifiableStorageRemoveRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: \"verifiableStorageRemoveRequestExample\",\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tpathParams: {\n\t\t\t\t\t\t\tid: \"verifiable:iota:aW90YS1uZnQ6dHN0OjB4NzYyYjljNDllYTg2OWUwZWJkYTliYmZhNzY5Mzk0NDdhNDI4ZGNmMTc4YzVkMTVhYjQ0N2UyZDRmYmJiNGViMg==\"\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\treturn [createRoute, updateRoute, getRoute, removeRoute];\n}\n\n/**\n * Create a verifiable storage item.\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 verifiableStorageCreate(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IVerifiableStorageCreateRequest\n): Promise<IVerifiableStorageCreateResponse> {\n\tGuards.object<IVerifiableStorageCreateRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<IVerifiableStorageCreateRequest[\"body\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.body),\n\t\trequest.body\n\t);\n\tGuards.stringBase64(ROUTES_SOURCE, nameof(request.body.data), request.body.data);\n\n\tconst contextIds = await ContextIdStore.getContextIds();\n\tContextIdHelper.guard(contextIds, ContextIdKeys.Organization);\n\n\tconst component = ComponentFactory.get<IVerifiableStorageComponent>(componentName);\n\tconst result = await component.create(\n\t\tConverter.base64ToBytes(request.body.data),\n\t\trequest.body.allowList,\n\t\t{\n\t\t\tmaxAllowListSize: request.body.maxAllowListSize\n\t\t},\n\t\trequest.body.namespace,\n\t\tcontextIds[ContextIdKeys.Organization]\n\t);\n\treturn {\n\t\tstatusCode: HttpStatusCode.created,\n\t\theaders: {\n\t\t\t[HeaderTypes.Location]: result.id\n\t\t},\n\t\tbody: {\n\t\t\treceipt: result.receipt,\n\t\t\tid: result.id\n\t\t}\n\t};\n}\n\n/**\n * UPdate an Verifiable 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 verifiableStorageUpdate(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IVerifiableStorageUpdateRequest\n): Promise<IVerifiableStorageUpdateResponse> {\n\tGuards.object<IVerifiableStorageUpdateRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<IVerifiableStorageGetRequest[\"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\tGuards.object<IVerifiableStorageUpdateRequest[\"body\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.body),\n\t\trequest.body\n\t);\n\tGuards.stringBase64(ROUTES_SOURCE, nameof(request.body.data), request.body.data);\n\n\tconst contextIds = await ContextIdStore.getContextIds();\n\tContextIdHelper.guard(contextIds, ContextIdKeys.Organization);\n\n\tconst component = ComponentFactory.get<IVerifiableStorageComponent>(componentName);\n\tconst result = await component.update(\n\t\trequest.pathParams.id,\n\t\tIs.stringBase64(request.body.data) ? Converter.base64ToBytes(request.body.data) : undefined,\n\t\trequest.body.allowList,\n\t\tcontextIds[ContextIdKeys.Organization]\n\t);\n\treturn {\n\t\tbody: result\n\t};\n}\n\n/**\n * Get an Verifiable Storage.\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 verifiableStorageGet(\n\tcomponentName: string,\n\trequest: IVerifiableStorageGetRequest\n): Promise<IVerifiableStorageGetResponse> {\n\tGuards.object<IVerifiableStorageGetRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<IVerifiableStorageGetRequest[\"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<IVerifiableStorageComponent>(componentName);\n\tconst result = await component.get(request.pathParams.id, request.body);\n\treturn {\n\t\tbody: {\n\t\t\tdata: Is.uint8Array(result.data) ? Converter.bytesToBase64(result.data) : undefined,\n\t\t\treceipt: result.receipt,\n\t\t\tallowList: result.allowList\n\t\t}\n\t};\n}\n\n/**\n * Remove a verifiable storage item.\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 verifiableStorageRemove(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IVerifiableStorageRemoveRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IVerifiableStorageRemoveRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<IVerifiableStorageRemoveRequest[\"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 contextIds = await ContextIdStore.getContextIds();\n\tContextIdHelper.guard(contextIds, ContextIdKeys.Organization);\n\n\tconst component = ComponentFactory.get<IVerifiableStorageComponent>(componentName);\n\tawait component.remove(request.pathParams.id, contextIds[ContextIdKeys.Organization]);\n\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n"]}

package/dist/es/verifiableStorageService.js

@@ -0,0 +1,137 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { GeneralError, Guards, Urn } from "@twin.org/core";
+import { VerifiableStorageConnectorFactory } from "@twin.org/verifiable-storage-models";
+/**
+ * Service for performing Verifiable Storage operations to a connector.
+ */
+export class VerifiableStorageService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "VerifiableStorageService";
+    /**
+     * The namespace supported by the verifiableStorage service.
+     * @internal
+     */
+    static _NAMESPACE = "verifiable";
+    /**
+     * The default namespace for the connector to use.
+     * @internal
+     */
+    _defaultNamespace;
+    /**
+     * Create a new instance of VerifiableStorageService.
+     * @param options The options for the service.
+     */
+    constructor(options) {
+        const names = VerifiableStorageConnectorFactory.names();
+        if (names.length === 0) {
+            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "noConnectors");
+        }
+        this._defaultNamespace = options?.config?.defaultNamespace ?? names[0];
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return VerifiableStorageService.CLASS_NAME;
+    }
+    /**
+     * Create a verifiable storage item.
+     * @param data The data for the verifiable storage item.
+     * @param allowList The list of identities that are allowed to modify the item.
+     * @param options Additional options for creating the item.
+     * @param options.maxAllowListSize The maximum size of the allow list.
+     * @param namespace The namespace to use for the connector to use.
+     * @param controller The identity of the controller to access the vault keys.
+     * @returns The id of the created verifiable storage item.
+     */
+    async create(data, allowList, options, namespace, controller) {
+        Guards.uint8Array(VerifiableStorageService.CLASS_NAME, "data", data);
+        Guards.stringValue(VerifiableStorageService.CLASS_NAME, "controller", controller);
+        try {
+            const connectorNamespace = namespace ?? this._defaultNamespace;
+            const verifiableStorageConnector = VerifiableStorageConnectorFactory.get(connectorNamespace);
+            const verifiableStorageResult = await verifiableStorageConnector.create(controller, data, allowList, options);
+            return verifiableStorageResult;
+        }
+        catch (error) {
+            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "createFailed", undefined, error);
+        }
+    }
+    /**
+     * Update an item in verifiable storage.
+     * @param id The id of the item to update.
+     * @param data The data to store, optional if updating the allow list.
+     * @param allowList Updated list of identities that are allowed to modify the item.
+     * @param controller The identity of the controller to access the vault keys.
+     * @returns The updated receipt.
+     */
+    async update(id, data, allowList, controller) {
+        Urn.guard(VerifiableStorageService.CLASS_NAME, "id", id);
+        Guards.stringValue(VerifiableStorageService.CLASS_NAME, "controller", controller);
+        try {
+            const verifiableStorageConnector = this.getConnector(id);
+            const verifiableStorageResult = await verifiableStorageConnector.update(controller, id, data, allowList);
+            return verifiableStorageResult;
+        }
+        catch (error) {
+            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "updateFailed", undefined, error);
+        }
+    }
+    /**
+     * Get an Verifiable Storage.
+     * @param id The id of the verifiable storage item to get.
+     * @param options Additional options for getting the verifiable storage item.
+     * @param options.includeData Should the data be included in the response, defaults to true.
+     * @param options.includeAllowList Should the allow list be included in the response, defaults to true.
+     * @returns The data for the verifiable storage item.
+     */
+    async get(id, options) {
+        Urn.guard(VerifiableStorageService.CLASS_NAME, "id", id);
+        try {
+            const verifiableStorageConnector = this.getConnector(id);
+            const result = await verifiableStorageConnector.get(id, options);
+            return result;
+        }
+        catch (error) {
+            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "getFailed", undefined, error);
+        }
+    }
+    /**
+     * Remove a verifiable storage item.
+     * @param id The id of the Verifiable Storage to remove.
+     * @param controller The identity of the controller to access the vault keys.
+     * @returns Nothing.
+     */
+    async remove(id, controller) {
+        Urn.guard(VerifiableStorageService.CLASS_NAME, "id", id);
+        Guards.stringValue(VerifiableStorageService.CLASS_NAME, "controller", controller);
+        try {
+            const verifiableStorageConnector = this.getConnector(id);
+            await verifiableStorageConnector.remove(controller, id);
+        }
+        catch (error) {
+            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "removeFailed", undefined, error);
+        }
+    }
+    /**
+     * Get the connector from the uri.
+     * @param id The id of the item in urn format.
+     * @returns The connector.
+     * @internal
+     */
+    getConnector(id) {
+        const idUri = Urn.fromValidString(id);
+        if (idUri.namespaceIdentifier() !== VerifiableStorageService._NAMESPACE) {
+            throw new GeneralError(VerifiableStorageService.CLASS_NAME, "namespaceMismatch", {
+                namespace: VerifiableStorageService._NAMESPACE,
+                id
+            });
+        }
+        return VerifiableStorageConnectorFactory.get(idUri.namespaceMethod());
+    }
+}
+//# sourceMappingURL=verifiableStorageService.js.map

package/dist/es/verifiableStorageService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifiableStorageService.js","sourceRoot":"","sources":["../../src/verifiableStorageService.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EACN,iCAAiC,EAGjC,MAAM,qCAAqC,CAAC;AAG7C;;GAEG;AACH,MAAM,OAAO,wBAAwB;IACpC;;OAEG;IACI,MAAM,CAAU,UAAU,8BAA8C;IAE/E;;;OAGG;IACK,MAAM,CAAU,UAAU,GAAW,YAAY,CAAC;IAE1D;;;OAGG;IACc,iBAAiB,CAAS;IAE3C;;;OAGG;IACH,YAAY,OAAqD;QAChE,MAAM,KAAK,GAAG,iCAAiC,CAAC,KAAK,EAAE,CAAC;QACxD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAC7E,CAAC;QAED,IAAI,CAAC,iBAAiB,GAAG,OAAO,EAAE,MAAM,EAAE,gBAAgB,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,wBAAwB,CAAC,UAAU,CAAC;IAC5C,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,MAAM,CAClB,IAAgB,EAChB,SAAoB,EACpB,OAEC,EACD,SAAkB,EAClB,UAAmB;QAKnB,MAAM,CAAC,UAAU,CAAC,wBAAwB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAC3E,MAAM,CAAC,WAAW,CAAC,wBAAwB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAExF,IAAI,CAAC;YACJ,MAAM,kBAAkB,GAAG,SAAS,IAAI,IAAI,CAAC,iBAAiB,CAAC;YAE/D,MAAM,0BAA0B,GAC/B,iCAAiC,CAAC,GAAG,CAA8B,kBAAkB,CAAC,CAAC;YAExF,MAAM,uBAAuB,GAAG,MAAM,0BAA0B,CAAC,MAAM,CACtE,UAAU,EACV,IAAI,EACJ,SAAS,EACT,OAAO,CACP,CAAC;YAEF,OAAO,uBAAuB,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC/F,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAClB,EAAU,EACV,IAAiB,EACjB,SAAoB,EACpB,UAAmB;QAEnB,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAC/D,MAAM,CAAC,WAAW,CAAC,wBAAwB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAExF,IAAI,CAAC;YACJ,MAAM,0BAA0B,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACzD,MAAM,uBAAuB,GAAG,MAAM,0BAA0B,CAAC,MAAM,CACtE,UAAU,EACV,EAAE,EACF,IAAI,EACJ,SAAS,CACT,CAAC;YAEF,OAAO,uBAAuB,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC/F,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,GAAG,CACf,EAAU,EACV,OAA+D;QAK/D,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE/D,IAAI,CAAC;YACJ,MAAM,0BAA0B,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACzD,MAAM,MAAM,GAAG,MAAM,0BAA0B,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YACjE,OAAO,MAAM,CAAC;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC5F,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,UAAmB;QAClD,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAC/D,MAAM,CAAC,WAAW,CAAC,wBAAwB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAExF,IAAI,CAAC;YACJ,MAAM,0BAA0B,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACzD,MAAM,0BAA0B,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QACzD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC/F,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACK,YAAY,CAAC,EAAU;QAC9B,MAAM,KAAK,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAEtC,IAAI,KAAK,CAAC,mBAAmB,EAAE,KAAK,wBAAwB,CAAC,UAAU,EAAE,CAAC;YACzE,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,mBAAmB,EAAE;gBAChF,SAAS,EAAE,wBAAwB,CAAC,UAAU;gBAC9C,EAAE;aACF,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,iCAAiC,CAAC,GAAG,CAC3C,KAAK,CAAC,eAAe,EAAE,CACvB,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Urn } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tVerifiableStorageConnectorFactory,\n\ttype IVerifiableStorageComponent,\n\ttype IVerifiableStorageConnector\n} from \"@twin.org/verifiable-storage-models\";\nimport type { IVerifiableStorageServiceConstructorOptions } from \"./models/IVerifiableStorageServiceConstructorOptions.js\";\n\n/**\n * Service for performing Verifiable Storage operations to a connector.\n */\nexport class VerifiableStorageService implements IVerifiableStorageComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<VerifiableStorageService>();\n\n\t/**\n\t * The namespace supported by the verifiableStorage service.\n\t * @internal\n\t */\n\tprivate static readonly _NAMESPACE: string = \"verifiable\";\n\n\t/**\n\t * The default namespace for the connector to use.\n\t * @internal\n\t */\n\tprivate readonly _defaultNamespace: string;\n\n\t/**\n\t * Create a new instance of VerifiableStorageService.\n\t * @param options The options for the service.\n\t */\n\tconstructor(options?: IVerifiableStorageServiceConstructorOptions) {\n\t\tconst names = VerifiableStorageConnectorFactory.names();\n\t\tif (names.length === 0) {\n\t\t\tthrow new GeneralError(VerifiableStorageService.CLASS_NAME, \"noConnectors\");\n\t\t}\n\n\t\tthis._defaultNamespace = options?.config?.defaultNamespace ?? names[0];\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 VerifiableStorageService.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create a verifiable storage item.\n\t * @param data The data for the verifiable storage item.\n\t * @param allowList The list of identities that are allowed to modify the item.\n\t * @param options Additional options for creating the item.\n\t * @param options.maxAllowListSize The maximum size of the allow list.\n\t * @param namespace The namespace to use for the connector to use.\n\t * @param controller The identity of the controller to access the vault keys.\n\t * @returns The id of the created verifiable storage item.\n\t */\n\tpublic async create(\n\t\tdata: Uint8Array,\n\t\tallowList?: string[],\n\t\toptions?: {\n\t\t\tmaxAllowListSize?: number;\n\t\t},\n\t\tnamespace?: string,\n\t\tcontroller?: string\n\t): Promise<{\n\t\tid: string;\n\t\treceipt: IJsonLdNodeObject;\n\t}> {\n\t\tGuards.uint8Array(VerifiableStorageService.CLASS_NAME, nameof(data), data);\n\t\tGuards.stringValue(VerifiableStorageService.CLASS_NAME, nameof(controller), controller);\n\n\t\ttry {\n\t\t\tconst connectorNamespace = namespace ?? this._defaultNamespace;\n\n\t\t\tconst verifiableStorageConnector =\n\t\t\t\tVerifiableStorageConnectorFactory.get<IVerifiableStorageConnector>(connectorNamespace);\n\n\t\t\tconst verifiableStorageResult = await verifiableStorageConnector.create(\n\t\t\t\tcontroller,\n\t\t\t\tdata,\n\t\t\t\tallowList,\n\t\t\t\toptions\n\t\t\t);\n\n\t\t\treturn verifiableStorageResult;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(VerifiableStorageService.CLASS_NAME, \"createFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Update an item in verifiable storage.\n\t * @param id The id of the item to update.\n\t * @param data The data to store, optional if updating the allow list.\n\t * @param allowList Updated list of identities that are allowed to modify the item.\n\t * @param controller The identity of the controller to access the vault keys.\n\t * @returns The updated receipt.\n\t */\n\tpublic async update(\n\t\tid: string,\n\t\tdata?: Uint8Array,\n\t\tallowList?: string[],\n\t\tcontroller?: string\n\t): Promise<IJsonLdNodeObject> {\n\t\tUrn.guard(VerifiableStorageService.CLASS_NAME, nameof(id), id);\n\t\tGuards.stringValue(VerifiableStorageService.CLASS_NAME, nameof(controller), controller);\n\n\t\ttry {\n\t\t\tconst verifiableStorageConnector = this.getConnector(id);\n\t\t\tconst verifiableStorageResult = await verifiableStorageConnector.update(\n\t\t\t\tcontroller,\n\t\t\t\tid,\n\t\t\t\tdata,\n\t\t\t\tallowList\n\t\t\t);\n\n\t\t\treturn verifiableStorageResult;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(VerifiableStorageService.CLASS_NAME, \"updateFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Get an Verifiable Storage.\n\t * @param id The id of the verifiable storage item to get.\n\t * @param options Additional options for getting the verifiable storage item.\n\t * @param options.includeData Should the data be included in the response, defaults to true.\n\t * @param options.includeAllowList Should the allow list be included in the response, defaults to true.\n\t * @returns The data for the verifiable storage item.\n\t */\n\tpublic async get(\n\t\tid: string,\n\t\toptions?: { includeData?: boolean; includeAllowList?: boolean }\n\t): Promise<{\n\t\tdata?: Uint8Array;\n\t\treceipt: IJsonLdNodeObject;\n\t}> {\n\t\tUrn.guard(VerifiableStorageService.CLASS_NAME, nameof(id), id);\n\n\t\ttry {\n\t\t\tconst verifiableStorageConnector = this.getConnector(id);\n\t\t\tconst result = await verifiableStorageConnector.get(id, options);\n\t\t\treturn result;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(VerifiableStorageService.CLASS_NAME, \"getFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Remove a verifiable storage item.\n\t * @param id The id of the Verifiable Storage to remove.\n\t * @param controller The identity of the controller to access the vault keys.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(id: string, controller?: string): Promise<void> {\n\t\tUrn.guard(VerifiableStorageService.CLASS_NAME, nameof(id), id);\n\t\tGuards.stringValue(VerifiableStorageService.CLASS_NAME, nameof(controller), controller);\n\n\t\ttry {\n\t\t\tconst verifiableStorageConnector = this.getConnector(id);\n\t\t\tawait verifiableStorageConnector.remove(controller, id);\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(VerifiableStorageService.CLASS_NAME, \"removeFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Get the connector from the uri.\n\t * @param id The id of the item in urn format.\n\t * @returns The connector.\n\t * @internal\n\t */\n\tprivate getConnector(id: string): IVerifiableStorageConnector {\n\t\tconst idUri = Urn.fromValidString(id);\n\n\t\tif (idUri.namespaceIdentifier() !== VerifiableStorageService._NAMESPACE) {\n\t\t\tthrow new GeneralError(VerifiableStorageService.CLASS_NAME, \"namespaceMismatch\", {\n\t\t\t\tnamespace: VerifiableStorageService._NAMESPACE,\n\t\t\t\tid\n\t\t\t});\n\t\t}\n\n\t\treturn VerifiableStorageConnectorFactory.get<IVerifiableStorageConnector>(\n\t\t\tidUri.namespaceMethod()\n\t\t);\n\t}\n}\n"]}

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./models/IVerifiableStorageServiceConfig";
-export * from "./models/IVerifiableStorageServiceConstructorOptions";
-export * from "./verifiableStorageRoutes";
-export * from "./verifiableStorageService";
-export * from "./restEntryPoints";
+export * from "./models/IVerifiableStorageServiceConfig.js";
+export * from "./models/IVerifiableStorageServiceConstructorOptions.js";
+export * from "./verifiableStorageRoutes.js";
+export * from "./verifiableStorageService.js";
+export * from "./restEntryPoints.js";

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

@@ -1,4 +1,4 @@
-import type { IVerifiableStorageServiceConfig } from "./IVerifiableStorageServiceConfig";
+import type { IVerifiableStorageServiceConfig } from "./IVerifiableStorageServiceConfig.js";
 /**
  * Options for the Verifiable Storage service constructor.
  */

package/dist/types/verifiableStorageService.d.ts

@@ -1,6 +1,6 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IVerifiableStorageComponent } from "@twin.org/verifiable-storage-models";
-import type { IVerifiableStorageServiceConstructorOptions } from "./models/IVerifiableStorageServiceConstructorOptions";
+import type { IVerifiableStorageServiceConstructorOptions } from "./models/IVerifiableStorageServiceConstructorOptions.js";
 /**
  * Service for performing Verifiable Storage operations to a connector.
  */
@@ -14,19 +14,24 @@ export declare class VerifiableStorageService implements IVerifiableStorageCompo
      * @param options The options for the service.
      */
     constructor(options?: IVerifiableStorageServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Create a verifiable storage item.
      * @param data The data for the verifiable storage item.
      * @param allowList The list of identities that are allowed to modify the item.
      * @param options Additional options for creating the item.
      * @param options.maxAllowListSize The maximum size of the allow list.
-     * @param identity The identity to store the Verifiable Storage operation on.
-     * @param namespace The namespace to use for the Verifiable Storage.
+     * @param namespace The namespace to use for the connector to use.
+     * @param controller The identity of the controller to access the vault keys.
      * @returns The id of the created verifiable storage item.
      */
     create(data: Uint8Array, allowList?: string[], options?: {
         maxAllowListSize?: number;
-    }, identity?: string, namespace?: string): Promise<{
+    }, namespace?: string, controller?: string): Promise<{
         id: string;
         receipt: IJsonLdNodeObject;
     }>;
@@ -35,10 +40,10 @@ export declare class VerifiableStorageService implements IVerifiableStorageCompo
      * @param id The id of the item to update.
      * @param data The data to store, optional if updating the allow list.
      * @param allowList Updated list of identities that are allowed to modify the item.
-     * @param identity The identity of the user to access the vault keys.
+     * @param controller The identity of the controller to access the vault keys.
      * @returns The updated receipt.
      */
-    update(id: string, data?: Uint8Array, allowList?: string[], identity?: string): Promise<IJsonLdNodeObject>;
+    update(id: string, data?: Uint8Array, allowList?: string[], controller?: string): Promise<IJsonLdNodeObject>;
     /**
      * Get an Verifiable Storage.
      * @param id The id of the verifiable storage item to get.
@@ -57,8 +62,8 @@ export declare class VerifiableStorageService implements IVerifiableStorageCompo
     /**
      * Remove a verifiable storage item.
      * @param id The id of the Verifiable Storage to remove.
-     * @param identity The identity to perform the verifiableStorage operation on.
+     * @param controller The identity of the controller to access the vault keys.
      * @returns Nothing.
      */
-    remove(id: string, identity?: string): Promise<void>;
+    remove(id: string, controller?: string): Promise<void>;
 }