@twin.org/verifiable-storage-models 0.0.2-next.6 → 0.0.3-next.1

package/dist/es/factories/verifiableStorageConnectorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
+/**
+ * Factory for creating verifiable storage connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const VerifiableStorageConnectorFactory = Factory.createFactory("verifiable-storage-connector");
+//# sourceMappingURL=verifiableStorageConnectorFactory.js.map

package/dist/es/factories/verifiableStorageConnectorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifiableStorageConnectorFactory.js","sourceRoot":"","sources":["../../../src/factories/verifiableStorageConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,iCAAiC,GAAG,OAAO,CAAC,aAAa,CACrE,8BAA8B,CAC9B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IVerifiableStorageConnector } from \"../models/IVerifiableStorageConnector.js\";\n\n/**\n * Factory for creating verifiable storage connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const VerifiableStorageConnectorFactory = Factory.createFactory<IVerifiableStorageConnector>(\n\t\"verifiable-storage-connector\"\n);\n"]}

package/dist/es/index.js

@@ -0,0 +1,14 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/verifiableStorageConnectorFactory.js";
+export * from "./models/api/IVerifiableStorageCreateRequest.js";
+export * from "./models/api/IVerifiableStorageCreateResponse.js";
+export * from "./models/api/IVerifiableStorageGetRequest.js";
+export * from "./models/api/IVerifiableStorageGetResponse.js";
+export * from "./models/api/IVerifiableStorageRemoveRequest.js";
+export * from "./models/api/IVerifiableStorageUpdateRequest.js";
+export * from "./models/api/IVerifiableStorageUpdateResponse.js";
+export * from "./models/IVerifiableStorageComponent.js";
+export * from "./models/IVerifiableStorageConnector.js";
+export * from "./models/verifiableStorageContexts.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,kDAAkD,CAAC;AACjE,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,iDAAiD,CAAC;AAChE,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/verifiableStorageConnectorFactory.js\";\nexport * from \"./models/api/IVerifiableStorageCreateRequest.js\";\nexport * from \"./models/api/IVerifiableStorageCreateResponse.js\";\nexport * from \"./models/api/IVerifiableStorageGetRequest.js\";\nexport * from \"./models/api/IVerifiableStorageGetResponse.js\";\nexport * from \"./models/api/IVerifiableStorageRemoveRequest.js\";\nexport * from \"./models/api/IVerifiableStorageUpdateRequest.js\";\nexport * from \"./models/api/IVerifiableStorageUpdateResponse.js\";\nexport * from \"./models/IVerifiableStorageComponent.js\";\nexport * from \"./models/IVerifiableStorageConnector.js\";\nexport * from \"./models/verifiableStorageContexts.js\";\n"]}

package/dist/es/models/IVerifiableStorageComponent.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageComponent.js","sourceRoot":"","sources":["../../../src/models/IVerifiableStorageComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Interface describing a Verifiable Storage component.\n */\nexport interface IVerifiableStorageComponent extends IComponent {\n\t/**\n\t * Create an item in verifiable storage.\n\t * @param data The data to store.\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 store the item in.\n\t * @param controller The identity of the controller to access the vault keys.\n\t * @returns The id of the stored verifiable item in urn format and the receipt.\n\t */\n\tcreate(\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\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\tupdate(\n\t\tid: string,\n\t\tdata?: Uint8Array,\n\t\tallowList?: string[],\n\t\tcontroller?: string\n\t): Promise<IJsonLdNodeObject>;\n\n\t/**\n\t * Get an verifiable item.\n\t * @param id The id of the item to get.\n\t * @param options Additional options for getting the 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 item and the receipt.\n\t */\n\tget(\n\t\tid: string,\n\t\toptions?: { includeData?: boolean; includeAllowList?: boolean }\n\t): Promise<{\n\t\tdata?: Uint8Array;\n\t\treceipt: IJsonLdNodeObject;\n\t\tallowList?: string[];\n\t}>;\n\n\t/**\n\t * Remove the item from verifiable storage.\n\t * @param id The id of the verifiable item to remove in urn format.\n\t * @param controller The identity of the controller.\n\t * @returns Nothing.\n\t */\n\tremove(id: string, controller?: string): Promise<void>;\n}\n"]}

package/dist/es/models/IVerifiableStorageConnector.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageConnector.js","sourceRoot":"","sources":["../../../src/models/IVerifiableStorageConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Interface describing a verifiable storage connector.\n */\nexport interface IVerifiableStorageConnector extends IComponent {\n\t/**\n\t * Create an item in verifiable storage.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param data The data to store.\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 * @returns The id of the stored verifiable item in urn format and the receipt.\n\t */\n\tcreate(\n\t\tcontrollerIdentity: string,\n\t\tdata: Uint8Array,\n\t\tallowList?: string[],\n\t\toptions?: {\n\t\t\tmaxAllowListSize?: number;\n\t\t}\n\t): Promise<{\n\t\tid: string;\n\t\treceipt: IJsonLdNodeObject;\n\t}>;\n\n\t/**\n\t * Update an item in verifiable storage.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\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 * @returns The updated receipt.\n\t */\n\tupdate(\n\t\tcontrollerIdentity: string,\n\t\tid: string,\n\t\tdata?: Uint8Array,\n\t\tallowList?: string[]\n\t): Promise<IJsonLdNodeObject>;\n\n\t/**\n\t * Get an verifiable item.\n\t * @param id The id of the item to get.\n\t * @param options Additional options for getting the 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 item, the receipt and the allow list.\n\t */\n\tget(\n\t\tid: string,\n\t\toptions?: { includeData?: boolean; includeAllowList?: boolean }\n\t): Promise<{\n\t\tdata?: Uint8Array;\n\t\treceipt: IJsonLdNodeObject;\n\t\tallowList?: string[];\n\t}>;\n\n\t/**\n\t * Remove the item from verifiable storage.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param id The id of the verifiable item to remove in urn format.\n\t * @returns Nothing.\n\t */\n\tremove(controllerIdentity: string, id: string): Promise<void>;\n}\n"]}

package/dist/es/models/api/IVerifiableStorageCreateRequest.js

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

package/dist/es/models/api/IVerifiableStorageCreateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageCreateRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Store the data and return the verifiable storage item id.\n */\nexport interface IVerifiableStorageCreateRequest {\n\t/**\n\t * The data to be stored.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The data for the verifiable storage item, this is a string serialized as base64.\n\t\t */\n\t\tdata: string;\n\n\t\t/**\n\t\t * The list of identities that are allowed to modify the item.\n\t\t */\n\t\tallowList?: string[];\n\n\t\t/**\n\t\t * The maximum size of the allow list.\n\t\t * @default 100\n\t\t */\n\t\tmaxAllowListSize?: number;\n\n\t\t/**\n\t\t * The namespace of the connector to use for the verifiable storage item, defaults to component configured namespace.\n\t\t */\n\t\tnamespace?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IVerifiableStorageCreateResponse.js

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

package/dist/es/models/api/IVerifiableStorageCreateResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageCreateResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageCreateResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ICreatedResponse } from \"@twin.org/api-models\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to storing the verifiable storage item.\n */\nexport interface IVerifiableStorageCreateResponse extends ICreatedResponse {\n\t/**\n\t * The data that was stored.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The receipt associated to the verifiable storage item.\n\t\t */\n\t\treceipt: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The id of the verifiable storage item.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IVerifiableStorageGetRequest.js

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

package/dist/es/models/api/IVerifiableStorageGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageGetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get the verifiable storage item.\n */\nexport interface IVerifiableStorageGetRequest {\n\t/**\n\t * The data to be requested.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the verifiable storage item to resolve.\n\t\t */\n\t\tid: string;\n\t};\n\t/**\n\t * The body optional param.\n\t */\n\tbody?: {\n\t\t/**\n\t\t * The flag to include the data.\n\t\t * @default true\n\t\t */\n\t\tincludeData?: boolean;\n\n\t\t/**\n\t\t * The flag to include the allow list.\n\t\t * @default true\n\t\t */\n\t\tincludeAllowList?: boolean;\n\t};\n}\n"]}

package/dist/es/models/api/IVerifiableStorageGetResponse.js

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

package/dist/es/models/api/IVerifiableStorageGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to getting the verifiable storage item.\n */\nexport interface IVerifiableStorageGetResponse {\n\t/**\n\t * The data that was obtained.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The receipt associated to the verifiable storage item.\n\t\t */\n\t\treceipt: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The data of the verifiable storage item, this is a string serialized as base64.\n\t\t */\n\t\tdata?: string;\n\n\t\t/**\n\t\t * The list of identities that are allowed to modify the item.\n\t\t */\n\t\tallowList?: string[];\n\t};\n}\n"]}

package/dist/es/models/api/IVerifiableStorageRemoveRequest.js

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

package/dist/es/models/api/IVerifiableStorageRemoveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove the verifiable storage item.\n */\nexport interface IVerifiableStorageRemoveRequest {\n\t/**\n\t * The data to be used for resolving.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the verifiable storage item to remove.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IVerifiableStorageUpdateRequest.js

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

package/dist/es/models/api/IVerifiableStorageUpdateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageUpdateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageUpdateRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Update the data and return the receipt.\n */\nexport interface IVerifiableStorageUpdateRequest {\n\t/**\n\t * The data to be updated.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the verifiable storage item to update.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The data to be updated.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The data which is a string serialized as base64, leave empty if just updating the allow list.\n\t\t */\n\t\tdata?: string;\n\n\t\t/**\n\t\t * An updated list of identities that are allowed to modify the item, send an empty list to remove all entries.\n\t\t */\n\t\tallowList?: string[];\n\t};\n}\n"]}

package/dist/es/models/api/IVerifiableStorageUpdateResponse.js

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

package/dist/es/models/api/IVerifiableStorageUpdateResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IVerifiableStorageUpdateResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageUpdateResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to updating the verifiable storage item.\n */\nexport interface IVerifiableStorageUpdateResponse {\n\t/**\n\t * The data that was updated.\n\t */\n\tbody: IJsonLdNodeObject;\n}\n"]}

package/dist/es/models/verifiableStorageContexts.js

@@ -0,0 +1,13 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of verifiable storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const VerifiableStorageContexts = {
+    /**
+     * The context root for the verifiable storage types.
+     */
+    ContextRoot: "https://schema.twindev.org/verifiable-storage/"
+};
+//# sourceMappingURL=verifiableStorageContexts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"verifiableStorageContexts.js","sourceRoot":"","sources":["../../../src/models/verifiableStorageContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACxC;;OAEG;IACH,WAAW,EAAE,gDAAgD;CACpD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of verifiable storage data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const VerifiableStorageContexts = {\n\t/**\n\t * The context root for the verifiable storage types.\n\t */\n\tContextRoot: \"https://schema.twindev.org/verifiable-storage/\"\n} as const;\n\n/**\n * The contexts of verifiable storage data.\n */\nexport type VerifiableStorageContexts =\n\t(typeof VerifiableStorageContexts)[keyof typeof VerifiableStorageContexts];\n"]}

package/dist/types/factories/verifiableStorageConnectorFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IVerifiableStorageConnector } from "../models/IVerifiableStorageConnector";
+import type { IVerifiableStorageConnector } from "../models/IVerifiableStorageConnector.js";
 /**
  * Factory for creating verifiable storage connectors.
  */

package/dist/types/index.d.ts

@@ -1,11 +1,11 @@
-export * from "./factories/verifiableStorageConnectorFactory";
-export * from "./models/api/IVerifiableStorageCreateRequest";
-export * from "./models/api/IVerifiableStorageCreateResponse";
-export * from "./models/api/IVerifiableStorageGetRequest";
-export * from "./models/api/IVerifiableStorageGetResponse";
-export * from "./models/api/IVerifiableStorageRemoveRequest";
-export * from "./models/api/IVerifiableStorageUpdateRequest";
-export * from "./models/api/IVerifiableStorageUpdateResponse";
-export * from "./models/IVerifiableStorageComponent";
-export * from "./models/IVerifiableStorageConnector";
-export * from "./models/verifiableStorageContexts";
+export * from "./factories/verifiableStorageConnectorFactory.js";
+export * from "./models/api/IVerifiableStorageCreateRequest.js";
+export * from "./models/api/IVerifiableStorageCreateResponse.js";
+export * from "./models/api/IVerifiableStorageGetRequest.js";
+export * from "./models/api/IVerifiableStorageGetResponse.js";
+export * from "./models/api/IVerifiableStorageRemoveRequest.js";
+export * from "./models/api/IVerifiableStorageUpdateRequest.js";
+export * from "./models/api/IVerifiableStorageUpdateResponse.js";
+export * from "./models/IVerifiableStorageComponent.js";
+export * from "./models/IVerifiableStorageConnector.js";
+export * from "./models/verifiableStorageContexts.js";

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

@@ -10,13 +10,13 @@ export interface IVerifiableStorageComponent extends IComponent {
      * @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 of the user to access the vault keys.
      * @param namespace The namespace to store the item in.
+     * @param controller The identity of the controller to access the vault keys.
      * @returns The id of the stored verifiable item in urn format and the receipt.
      */
     create(data: Uint8Array, allowList?: string[], options?: {
         maxAllowListSize?: number;
-    }, identity?: string, namespace?: string): Promise<{
+    }, namespace?: string, controller?: string): Promise<{
         id: string;
         receipt: IJsonLdNodeObject;
     }>;
@@ -25,10 +25,10 @@ export interface IVerifiableStorageComponent extends IComponent {
      * @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 item.
      * @param id The id of the item to get.
@@ -48,8 +48,8 @@ export interface IVerifiableStorageComponent extends IComponent {
     /**
      * Remove the item from verifiable storage.
      * @param id The id of the verifiable item to remove in urn format.
-     * @param controllerIdentity The identity of the controller.
+     * @param controller The identity of the controller.
      * @returns Nothing.
      */
-    remove(id: string, controllerIdentity?: string): Promise<void>;
+    remove(id: string, controller?: string): Promise<void>;
 }

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

@@ -6,14 +6,14 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 export interface IVerifiableStorageConnector extends IComponent {
     /**
      * Create an item in verifiable storage.
-     * @param controller The identity of the user to access the vault keys.
+     * @param controllerIdentity The identity of the user to access the vault keys.
      * @param data The data to store.
      * @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.
      * @returns The id of the stored verifiable item in urn format and the receipt.
      */
-    create(controller: string, data: Uint8Array, allowList?: string[], options?: {
+    create(controllerIdentity: string, data: Uint8Array, allowList?: string[], options?: {
         maxAllowListSize?: number;
     }): Promise<{
         id: string;
@@ -21,13 +21,13 @@ export interface IVerifiableStorageConnector extends IComponent {
     }>;
     /**
      * Update an item in verifiable storage.
-     * @param controller The identity of the user to access the vault keys.
+     * @param controllerIdentity The identity of the user to access the vault keys.
      * @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.
      * @returns The updated receipt.
      */
-    update(controller: string, id: string, data?: Uint8Array, allowList?: string[]): Promise<IJsonLdNodeObject>;
+    update(controllerIdentity: string, id: string, data?: Uint8Array, allowList?: string[]): Promise<IJsonLdNodeObject>;
     /**
      * Get an verifiable item.
      * @param id The id of the item to get.
@@ -46,9 +46,9 @@ export interface IVerifiableStorageConnector extends IComponent {
     }>;
     /**
      * Remove the item from verifiable storage.
-     * @param controller The identity of the user to access the vault keys.
+     * @param controllerIdentity The identity of the user to access the vault keys.
      * @param id The id of the verifiable item to remove in urn format.
      * @returns Nothing.
      */
-    remove(controller: string, id: string): Promise<void>;
+    remove(controllerIdentity: string, id: string): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,21 @@
 # @twin.org/verifiable-storage-models - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.0...verifiable-storage-models-v0.0.3-next.1) (2025-11-12)
+
+
+### Features
+
+* add context id features ([#40](https://github.com/twinfoundation/verifiable-storage/issues/40)) ([260b96a](https://github.com/twinfoundation/verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
+* add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
+* add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
+* eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
+* update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
+* update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
+* update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
+* update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
+* use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
+* use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
+
 ## [0.0.2-next.6](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.5...verifiable-storage-models-v0.0.2-next.6) (2025-10-09)
 
 

package/docs/reference/interfaces/IVerifiableStorageComponent.md

@@ -6,19 +6,11 @@ Interface describing a Verifiable Storage component.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### create()
 
-> **create**(`data`, `allowList?`, `options?`, `identity?`, `namespace?`): `Promise`\<\{ `id`: `string`; `receipt`: `IJsonLdNodeObject`; \}\>
+> **create**(`data`, `allowList?`, `options?`, `namespace?`, `controller?`): `Promise`\<\{ `id`: `string`; `receipt`: `IJsonLdNodeObject`; \}\>
 
 Create an item in verifiable storage.
 
@@ -46,17 +38,17 @@ Additional options for creating the item.
 
 The maximum size of the allow list.
 
-##### identity?
+##### namespace?
 
 `string`
 
-The identity of the user to access the vault keys.
+The namespace to store the item in.
 
-##### namespace?
+##### controller?
 
 `string`
 
-The namespace to store the item in.
+The identity of the controller to access the vault keys.
 
 #### Returns
 
@@ -68,7 +60,7 @@ The id of the stored verifiable item in urn format and the receipt.
 
 ### update()
 
-> **update**(`id`, `data?`, `allowList?`, `identity?`): `Promise`\<`IJsonLdNodeObject`\>
+> **update**(`id`, `data?`, `allowList?`, `controller?`): `Promise`\<`IJsonLdNodeObject`\>
 
 Update an item in verifiable storage.
 
@@ -92,11 +84,11 @@ The data to store, optional if updating the allow list.
 
 Updated list of identities that are allowed to modify the item.
 
-##### identity?
+##### controller?
 
 `string`
 
-The identity of the user to access the vault keys.
+The identity of the controller to access the vault keys.
 
 #### Returns
 
@@ -146,7 +138,7 @@ The data for the item and the receipt.
 
 ### remove()
 
-> **remove**(`id`, `controllerIdentity?`): `Promise`\<`void`\>
+> **remove**(`id`, `controller?`): `Promise`\<`void`\>
 
 Remove the item from verifiable storage.
 
@@ -158,7 +150,7 @@ Remove the item from verifiable storage.
 
 The id of the verifiable item to remove in urn format.
 
-##### controllerIdentity?
+##### controller?
 
 `string`
 

package/docs/reference/interfaces/IVerifiableStorageConnector.md

@@ -6,25 +6,17 @@ Interface describing a verifiable storage connector.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### create()
 
-> **create**(`controller`, `data`, `allowList?`, `options?`): `Promise`\<\{ `id`: `string`; `receipt`: `IJsonLdNodeObject`; \}\>
+> **create**(`controllerIdentity`, `data`, `allowList?`, `options?`): `Promise`\<\{ `id`: `string`; `receipt`: `IJsonLdNodeObject`; \}\>
 
 Create an item in verifiable storage.
 
 #### Parameters
 
-##### controller
+##### controllerIdentity
 
 `string`
 
@@ -62,13 +54,13 @@ The id of the stored verifiable item in urn format and the receipt.
 
 ### update()
 
-> **update**(`controller`, `id`, `data?`, `allowList?`): `Promise`\<`IJsonLdNodeObject`\>
+> **update**(`controllerIdentity`, `id`, `data?`, `allowList?`): `Promise`\<`IJsonLdNodeObject`\>
 
 Update an item in verifiable storage.
 
 #### Parameters
 
-##### controller
+##### controllerIdentity
 
 `string`
 
@@ -140,13 +132,13 @@ The data for the item, the receipt and the allow list.
 
 ### remove()
 
-> **remove**(`controller`, `id`): `Promise`\<`void`\>
+> **remove**(`controllerIdentity`, `id`): `Promise`\<`void`\>
 
 Remove the item from verifiable storage.
 
 #### Parameters
 
-##### controller
+##### controllerIdentity
 
 `string`
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/verifiable-storage-models",
-	"version": "0.0.2-next.6",
+	"version": "0.0.3-next.1",
 	"description": "Contains models and classes for use with verifiable storage",
 	"repository": {
 		"type": "git",
@@ -20,19 +20,17 @@
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"

package/dist/cjs/index.cjs

@@ -1,27 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating verifiable storage connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const VerifiableStorageConnectorFactory = core.Factory.createFactory("verifiable-storage-connector");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts of verifiable storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const VerifiableStorageContexts = {
-    /**
-     * The context root for the verifiable storage types.
-     */
-    ContextRoot: "https://schema.twindev.org/verifiable-storage/"
-};
-
-exports.VerifiableStorageConnectorFactory = VerifiableStorageConnectorFactory;
-exports.VerifiableStorageContexts = VerifiableStorageContexts;

package/dist/esm/index.mjs

@@ -1,24 +0,0 @@
-import { Factory } from '@twin.org/core';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating verifiable storage connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const VerifiableStorageConnectorFactory = Factory.createFactory("verifiable-storage-connector");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts of verifiable storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const VerifiableStorageContexts = {
-    /**
-     * The context root for the verifiable storage types.
-     */
-    ContextRoot: "https://schema.twindev.org/verifiable-storage/"
-};
-
-export { VerifiableStorageConnectorFactory, VerifiableStorageContexts };