@twin.org/blob-storage-connector-file 0.0.2-next.5 → 0.0.3-next.1

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

@@ -1,14 +1,14 @@
-import { mkdir, writeFile, readFile, unlink, access } from 'node:fs/promises';
-import path from 'node:path';
-import { Guards, ComponentFactory, BaseError, Converter, Urn, GeneralError } from '@twin.org/core';
-import { Sha256 } from '@twin.org/crypto';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { access, mkdir, readFile, unlink, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { ContextIdHelper, ContextIdStore } from "@twin.org/context";
+import { BaseError, ComponentFactory, Converter, GeneralError, Guards, Is, Urn } from "@twin.org/core";
+import { Sha256 } from "@twin.org/crypto";
 /**
  * Class for performing blob storage operations in file.
  */
-class FileBlobStorageConnector {
+export class FileBlobStorageConnector {
     /**
      * The namespace for the items.
      */
@@ -27,6 +27,11 @@ class FileBlobStorageConnector {
      * @internal
      */
     _extension;
+    /**
+     * The keys to use from the context ids to create partitions.
+     * @internal
+     */
+    _partitionContextIds;
     /**
      * Create a new instance of FileBlobStorageConnector.
      * @param options The options for the connector.
@@ -37,6 +42,14 @@ class FileBlobStorageConnector {
         Guards.stringValue(FileBlobStorageConnector.CLASS_NAME, "options.config.directory", options.config.directory);
         this._directory = path.resolve(options.config.directory);
         this._extension = options.config.extension ?? ".blob";
+        this._partitionContextIds = options.partitionContextIds;
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return FileBlobStorageConnector.CLASS_NAME;
     }
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
@@ -46,24 +59,16 @@ class FileBlobStorageConnector {
     async bootstrap(nodeLoggingComponentType) {
         const nodeLogging = ComponentFactory.getIfExists(nodeLoggingComponentType);
         if (!(await this.dirExists(this._directory))) {
-            await nodeLogging?.log({
-                level: "info",
-                source: FileBlobStorageConnector.CLASS_NAME,
-                message: "directoryCreating",
-                data: {
-                    directory: this._directory
-                }
-            });
             try {
-                await mkdir(this._directory, { recursive: true });
                 await nodeLogging?.log({
                     level: "info",
                     source: FileBlobStorageConnector.CLASS_NAME,
-                    message: "directoryCreated",
+                    message: "directoryCreating",
                     data: {
                         directory: this._directory
                     }
                 });
+                await mkdir(this._directory, { recursive: true });
             }
             catch (err) {
                 await nodeLogging?.log({
@@ -97,12 +102,15 @@ class FileBlobStorageConnector {
      */
     async set(blob) {
         Guards.uint8Array(FileBlobStorageConnector.CLASS_NAME, "blob", blob);
+        const contextIds = await ContextIdStore.getContextIds();
+        const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
         try {
-            if (!(await this.dirExists(this._directory))) {
-                await mkdir(this._directory);
-            }
             const id = Converter.bytesToHex(Sha256.sum256(blob));
-            const fullPath = path.join(this._directory, `${id}${this._extension}`);
+            const fullPath = this.createFullPath(id, partitionKey);
+            const dir = path.dirname(fullPath);
+            if (!(await this.dirExists(dir))) {
+                await mkdir(dir, { recursive: true });
+            }
             await writeFile(fullPath, blob);
             return `blob:${new Urn(FileBlobStorageConnector.NAMESPACE, id).toString()}`;
         }
@@ -118,6 +126,8 @@ class FileBlobStorageConnector {
     async get(id) {
         Urn.guard(FileBlobStorageConnector.CLASS_NAME, "id", id);
         const urnParsed = Urn.fromValidString(id);
+        const contextIds = await ContextIdStore.getContextIds();
+        const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
         if (urnParsed.namespaceMethod() !== FileBlobStorageConnector.NAMESPACE) {
             throw new GeneralError(FileBlobStorageConnector.CLASS_NAME, "namespaceMismatch", {
                 namespace: FileBlobStorageConnector.NAMESPACE,
@@ -125,7 +135,7 @@ class FileBlobStorageConnector {
             });
         }
         try {
-            const fullPath = path.join(this._directory, `${urnParsed.namespaceSpecific(1)}${this._extension}`);
+            const fullPath = this.createFullPath(urnParsed.namespaceSpecific(1), partitionKey);
             return await readFile(fullPath);
         }
         catch (err) {
@@ -143,6 +153,8 @@ class FileBlobStorageConnector {
     async remove(id) {
         Urn.guard(FileBlobStorageConnector.CLASS_NAME, "id", id);
         const urnParsed = Urn.fromValidString(id);
+        const contextIds = await ContextIdStore.getContextIds();
+        const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
         if (urnParsed.namespaceMethod() !== FileBlobStorageConnector.NAMESPACE) {
             throw new GeneralError(FileBlobStorageConnector.CLASS_NAME, "namespaceMismatch", {
                 namespace: FileBlobStorageConnector.NAMESPACE,
@@ -150,7 +162,7 @@ class FileBlobStorageConnector {
             });
         }
         try {
-            const fullPath = path.join(this._directory, `${urnParsed.namespaceSpecific(1)}${this._extension}`);
+            const fullPath = this.createFullPath(urnParsed.namespaceSpecific(1), partitionKey);
             await unlink(fullPath);
             return true;
         }
@@ -176,6 +188,16 @@ class FileBlobStorageConnector {
             return false;
         }
     }
+    /**
+     * Create the full path for the blob.
+     * @param id The id of the blob.
+     * @param partitionKey The partition key.
+     * @returns The full path for the blob.
+     * @internal
+     */
+    createFullPath(id, partitionKey) {
+        const partitionPath = Is.stringValue(partitionKey) ? path.join(partitionKey, id) : id;
+        return path.join(this._directory, `${partitionPath}${this._extension}`);
+    }
 }
-
-export { FileBlobStorageConnector };
+//# sourceMappingURL=fileBlobStorageConnector.js.map

package/dist/es/fileBlobStorageConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileBlobStorageConnector.js","sourceRoot":"","sources":["../../src/fileBlobStorageConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EACN,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,YAAY,EACZ,MAAM,EACN,EAAE,EACF,GAAG,EACH,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAK1C;;GAEG;AACH,MAAM,OAAO,wBAAwB;IACpC;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,MAAM,CAAC;IAElD;;OAEG;IACI,MAAM,CAAU,UAAU,8BAA8C;IAE/E;;;OAGG;IACc,UAAU,CAAS;IAEpC;;;OAGG;IACc,UAAU,CAAS;IAEpC;;;OAGG;IACc,oBAAoB,CAAY;IAEjD;;;OAGG;IACH,YAAY,OAAoD;QAC/D,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAC7E,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,UAAU,oBAA0B,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3F,MAAM,CAAC,WAAW,CACjB,wBAAwB,CAAC,UAAU,8BAEnC,OAAO,CAAC,MAAM,CAAC,SAAS,CACxB,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,IAAI,OAAO,CAAC;QACtD,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,wBAAwB,CAAC,UAAU,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,wBAAiC;QACvD,MAAM,WAAW,GAAG,gBAAgB,CAAC,WAAW,CAAoB,wBAAwB,CAAC,CAAC;QAE9F,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YAC9C,IAAI,CAAC;gBACJ,MAAM,WAAW,EAAE,GAAG,CAAC;oBACtB,KAAK,EAAE,MAAM;oBACb,MAAM,EAAE,wBAAwB,CAAC,UAAU;oBAC3C,OAAO,EAAE,mBAAmB;oBAC5B,IAAI,EAAE;wBACL,SAAS,EAAE,IAAI,CAAC,UAAU;qBAC1B;iBACD,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACnD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,MAAM,WAAW,EAAE,GAAG,CAAC;oBACtB,KAAK,EAAE,OAAO;oBACd,MAAM,EAAE,wBAAwB,CAAC,UAAU;oBAC3C,OAAO,EAAE,uBAAuB;oBAChC,IAAI,EAAE;wBACL,SAAS,EAAE,IAAI,CAAC,UAAU;qBAC1B;oBACD,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC;iBAC/B,CAAC,CAAC;gBACH,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;aAAM,CAAC;YACP,MAAM,WAAW,EAAE,GAAG,CAAC;gBACtB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,wBAAwB,CAAC,UAAU;gBAC3C,OAAO,EAAE,iBAAiB;gBAC1B,IAAI,EAAE;oBACL,SAAS,EAAE,IAAI,CAAC,UAAU;iBAC1B;aACD,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,IAAgB;QAChC,MAAM,CAAC,UAAU,CAAC,wBAAwB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAE3E,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE/F,IAAI,CAAC;YACJ,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAErD,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;YAEvD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACnC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAClC,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvC,CAAC;YAED,MAAM,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAEhC,OAAO,QAAQ,IAAI,GAAG,CAAC,wBAAwB,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC7E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;QAC9F,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,EAAU;QAC1B,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAC/D,MAAM,SAAS,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE/F,IAAI,SAAS,CAAC,eAAe,EAAE,KAAK,wBAAwB,CAAC,SAAS,EAAE,CAAC;YACxE,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,mBAAmB,EAAE;gBAChF,SAAS,EAAE,wBAAwB,CAAC,SAAS;gBAC7C,EAAE;aACF,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;YAEnF,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,CAAC;gBAC1C,OAAO;YACR,CAAC;YACD,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;QAC3F,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE/D,MAAM,SAAS,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE/F,IAAI,SAAS,CAAC,eAAe,EAAE,KAAK,wBAAwB,CAAC,SAAS,EAAE,CAAC;YACxE,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,mBAAmB,EAAE;gBAChF,SAAS,EAAE,wBAAwB,CAAC,SAAS;gBAC7C,EAAE;aACF,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;YAEnF,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEvB,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,CAAC;gBAC1C,OAAO,KAAK,CAAC;YACd,CAAC;YACD,MAAM,IAAI,YAAY,CAAC,wBAAwB,CAAC,UAAU,EAAE,kBAAkB,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;QAC9F,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,SAAS,CAAC,GAAW;QAClC,IAAI,CAAC;YACJ,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC;YAClB,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACK,cAAc,CAAC,EAAU,EAAE,YAAqB;QACvD,MAAM,aAAa,GAAG,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtF,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,aAAa,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACzE,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { access, mkdir, readFile, unlink, writeFile } from \"node:fs/promises\";\nimport path from \"node:path\";\nimport type { IBlobStorageConnector } from \"@twin.org/blob-storage-models\";\nimport { ContextIdHelper, ContextIdStore } from \"@twin.org/context\";\nimport {\n\tBaseError,\n\tComponentFactory,\n\tConverter,\n\tGeneralError,\n\tGuards,\n\tIs,\n\tUrn\n} from \"@twin.org/core\";\nimport { Sha256 } from \"@twin.org/crypto\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IFileBlobStorageConnectorConstructorOptions } from \"./models/IFileBlobStorageConnectorConstructorOptions.js\";\n\n/**\n * Class for performing blob storage operations in file.\n */\nexport class FileBlobStorageConnector implements IBlobStorageConnector {\n\t/**\n\t * The namespace for the items.\n\t */\n\tpublic static readonly NAMESPACE: string = \"file\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<FileBlobStorageConnector>();\n\n\t/**\n\t * The directory to use for storage.\n\t * @internal\n\t */\n\tprivate readonly _directory: string;\n\n\t/**\n\t * The extension to use for storage.\n\t * @internal\n\t */\n\tprivate readonly _extension: string;\n\n\t/**\n\t * The keys to use from the context ids to create partitions.\n\t * @internal\n\t */\n\tprivate readonly _partitionContextIds?: string[];\n\n\t/**\n\t * Create a new instance of FileBlobStorageConnector.\n\t * @param options The options for the connector.\n\t */\n\tconstructor(options: IFileBlobStorageConnectorConstructorOptions) {\n\t\tGuards.object(FileBlobStorageConnector.CLASS_NAME, nameof(options), options);\n\t\tGuards.object(FileBlobStorageConnector.CLASS_NAME, nameof(options.config), options.config);\n\t\tGuards.stringValue(\n\t\t\tFileBlobStorageConnector.CLASS_NAME,\n\t\t\tnameof(options.config.directory),\n\t\t\toptions.config.directory\n\t\t);\n\t\tthis._directory = path.resolve(options.config.directory);\n\t\tthis._extension = options.config.extension ?? \".blob\";\n\t\tthis._partitionContextIds = options.partitionContextIds;\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 FileBlobStorageConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Bootstrap the component by creating and initializing any resources it needs.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns True if the bootstrapping process was successful.\n\t */\n\tpublic async bootstrap(nodeLoggingComponentType?: string): Promise<boolean> {\n\t\tconst nodeLogging = ComponentFactory.getIfExists<ILoggingComponent>(nodeLoggingComponentType);\n\n\t\tif (!(await this.dirExists(this._directory))) {\n\t\t\ttry {\n\t\t\t\tawait nodeLogging?.log({\n\t\t\t\t\tlevel: \"info\",\n\t\t\t\t\tsource: FileBlobStorageConnector.CLASS_NAME,\n\t\t\t\t\tmessage: \"directoryCreating\",\n\t\t\t\t\tdata: {\n\t\t\t\t\t\tdirectory: this._directory\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t\tawait mkdir(this._directory, { recursive: true });\n\t\t\t} catch (err) {\n\t\t\t\tawait nodeLogging?.log({\n\t\t\t\t\tlevel: \"error\",\n\t\t\t\t\tsource: FileBlobStorageConnector.CLASS_NAME,\n\t\t\t\t\tmessage: \"directoryCreateFailed\",\n\t\t\t\t\tdata: {\n\t\t\t\t\t\tdirectory: this._directory\n\t\t\t\t\t},\n\t\t\t\t\terror: BaseError.fromError(err)\n\t\t\t\t});\n\t\t\t\treturn false;\n\t\t\t}\n\t\t} else {\n\t\t\tawait nodeLogging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: FileBlobStorageConnector.CLASS_NAME,\n\t\t\t\tmessage: \"directoryExists\",\n\t\t\t\tdata: {\n\t\t\t\t\tdirectory: this._directory\n\t\t\t\t}\n\t\t\t});\n\t\t}\n\n\t\treturn true;\n\t}\n\n\t/**\n\t * Set the blob.\n\t * @param blob The data for the blob.\n\t * @returns The id of the stored blob in urn format.\n\t */\n\tpublic async set(blob: Uint8Array): Promise<string> {\n\t\tGuards.uint8Array(FileBlobStorageConnector.CLASS_NAME, nameof(blob), blob);\n\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tconst partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);\n\n\t\ttry {\n\t\t\tconst id = Converter.bytesToHex(Sha256.sum256(blob));\n\n\t\t\tconst fullPath = this.createFullPath(id, partitionKey);\n\n\t\t\tconst dir = path.dirname(fullPath);\n\t\t\tif (!(await this.dirExists(dir))) {\n\t\t\t\tawait mkdir(dir, { recursive: true });\n\t\t\t}\n\n\t\t\tawait writeFile(fullPath, blob);\n\n\t\t\treturn `blob:${new Urn(FileBlobStorageConnector.NAMESPACE, id).toString()}`;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(FileBlobStorageConnector.CLASS_NAME, \"setBlobFailed\", undefined, err);\n\t\t}\n\t}\n\n\t/**\n\t * Get the blob.\n\t * @param id The id of the blob to get in urn format.\n\t * @returns The data for the blob if it can be found or undefined.\n\t */\n\tpublic async get(id: string): Promise<Uint8Array | undefined> {\n\t\tUrn.guard(FileBlobStorageConnector.CLASS_NAME, nameof(id), id);\n\t\tconst urnParsed = Urn.fromValidString(id);\n\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tconst partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);\n\n\t\tif (urnParsed.namespaceMethod() !== FileBlobStorageConnector.NAMESPACE) {\n\t\t\tthrow new GeneralError(FileBlobStorageConnector.CLASS_NAME, \"namespaceMismatch\", {\n\t\t\t\tnamespace: FileBlobStorageConnector.NAMESPACE,\n\t\t\t\tid\n\t\t\t});\n\t\t}\n\n\t\ttry {\n\t\t\tconst fullPath = this.createFullPath(urnParsed.namespaceSpecific(1), partitionKey);\n\n\t\t\treturn await readFile(fullPath);\n\t\t} catch (err) {\n\t\t\tif (BaseError.isErrorCode(err, \"ENOENT\")) {\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tthrow new GeneralError(FileBlobStorageConnector.CLASS_NAME, \"getBlobFailed\", { id }, err);\n\t\t}\n\t}\n\n\t/**\n\t * Remove the blob.\n\t * @param id The id of the blob to remove in urn format.\n\t * @returns True if the blob was found.\n\t */\n\tpublic async remove(id: string): Promise<boolean> {\n\t\tUrn.guard(FileBlobStorageConnector.CLASS_NAME, nameof(id), id);\n\n\t\tconst urnParsed = Urn.fromValidString(id);\n\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tconst partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);\n\n\t\tif (urnParsed.namespaceMethod() !== FileBlobStorageConnector.NAMESPACE) {\n\t\t\tthrow new GeneralError(FileBlobStorageConnector.CLASS_NAME, \"namespaceMismatch\", {\n\t\t\t\tnamespace: FileBlobStorageConnector.NAMESPACE,\n\t\t\t\tid\n\t\t\t});\n\t\t}\n\n\t\ttry {\n\t\t\tconst fullPath = this.createFullPath(urnParsed.namespaceSpecific(1), partitionKey);\n\n\t\t\tawait unlink(fullPath);\n\n\t\t\treturn true;\n\t\t} catch (err) {\n\t\t\tif (BaseError.isErrorCode(err, \"ENOENT\")) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t\tthrow new GeneralError(FileBlobStorageConnector.CLASS_NAME, \"removeBlobFailed\", { id }, err);\n\t\t}\n\t}\n\n\t/**\n\t * Check if the dir exists.\n\t * @param dir The directory to check.\n\t * @returns True if the dir exists.\n\t * @internal\n\t */\n\tprivate async dirExists(dir: string): Promise<boolean> {\n\t\ttry {\n\t\t\tawait access(dir);\n\t\t\treturn true;\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t/**\n\t * Create the full path for the blob.\n\t * @param id The id of the blob.\n\t * @param partitionKey The partition key.\n\t * @returns The full path for the blob.\n\t * @internal\n\t */\n\tprivate createFullPath(id: string, partitionKey?: string): string {\n\t\tconst partitionPath = Is.stringValue(partitionKey) ? path.join(partitionKey, id) : id;\n\t\treturn path.join(this._directory, `${partitionPath}${this._extension}`);\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,6 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./fileBlobStorageConnector.js";
+export * from "./models/IFileBlobStorageConnectorConfig.js";
+export * from "./models/IFileBlobStorageConnectorConstructorOptions.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,+BAA+B,CAAC;AAC9C,cAAc,6CAA6C,CAAC;AAC5D,cAAc,yDAAyD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./fileBlobStorageConnector.js\";\nexport * from \"./models/IFileBlobStorageConnectorConfig.js\";\nexport * from \"./models/IFileBlobStorageConnectorConstructorOptions.js\";\n"]}

package/dist/es/models/IFileBlobStorageConnectorConfig.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IFileBlobStorageConnectorConfig.js","sourceRoot":"","sources":["../../../src/models/IFileBlobStorageConnectorConfig.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 File Blob Storage Connector.\n */\nexport interface IFileBlobStorageConnectorConfig {\n\t/**\n\t * The directory to use for storage.\n\t */\n\tdirectory: string;\n\n\t/**\n\t * The extension to add to files when they are stored.\n\t */\n\textension?: string;\n}\n"]}

package/dist/es/models/IFileBlobStorageConnectorConstructorOptions.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IFileBlobStorageConnectorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IFileBlobStorageConnectorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IFileBlobStorageConnectorConfig } from \"./IFileBlobStorageConnectorConfig.js\";\n\n/**\n * Options for the File Blob Storage Connector constructor.\n */\nexport interface IFileBlobStorageConnectorConstructorOptions {\n\t/**\n\t * The keys to use from the context ids to create partitions.\n\t */\n\tpartitionContextIds?: string[];\n\n\t/**\n\t * The configuration for the connector.\n\t */\n\tconfig: IFileBlobStorageConnectorConfig;\n}\n"]}

package/dist/types/fileBlobStorageConnector.d.ts

@@ -1,5 +1,5 @@
 import type { IBlobStorageConnector } from "@twin.org/blob-storage-models";
-import type { IFileBlobStorageConnectorConstructorOptions } from "./models/IFileBlobStorageConnectorConstructorOptions";
+import type { IFileBlobStorageConnectorConstructorOptions } from "./models/IFileBlobStorageConnectorConstructorOptions.js";
 /**
  * Class for performing blob storage operations in file.
  */
@@ -17,6 +17,11 @@ export declare class FileBlobStorageConnector implements IBlobStorageConnector {
      * @param options The options for the connector.
      */
     constructor(options: IFileBlobStorageConnectorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingComponentType The node logging component type.

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./fileBlobStorageConnector";
-export * from "./models/IFileBlobStorageConnectorConfig";
-export * from "./models/IFileBlobStorageConnectorConstructorOptions";
+export * from "./fileBlobStorageConnector.js";
+export * from "./models/IFileBlobStorageConnectorConfig.js";
+export * from "./models/IFileBlobStorageConnectorConstructorOptions.js";

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

@@ -1,8 +1,12 @@
-import type { IFileBlobStorageConnectorConfig } from "./IFileBlobStorageConnectorConfig";
+import type { IFileBlobStorageConnectorConfig } from "./IFileBlobStorageConnectorConfig.js";
 /**
  * Options for the File Blob Storage Connector constructor.
  */
 export interface IFileBlobStorageConnectorConstructorOptions {
+    /**
+     * The keys to use from the context ids to create partitions.
+     */
+    partitionContextIds?: string[];
     /**
      * The configuration for the connector.
      */

package/docs/changelog.md

@@ -1,5 +1,24 @@
 # @twin.org/blob-storage-connector-file - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.3-next.0...blob-storage-connector-file-v0.0.3-next.1) (2025-11-11)
+
+
+### Features
+
+* add context id features ([#30](https://github.com/twinfoundation/blob-storage/issues/30)) ([fbf1c92](https://github.com/twinfoundation/blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
+* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+* eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
+* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
 ## [0.0.2-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.2-next.4...blob-storage-connector-file-v0.0.2-next.5) (2025-10-09)
 
 

package/docs/reference/classes/FileBlobStorageConnector.md

@@ -44,6 +44,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IBlobStorageConnector.className`
+
+***
+
 ### bootstrap()
 
 > **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
@@ -98,7 +116,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+> **get**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 Get the blob.
 
@@ -112,7 +130,7 @@ The id of the blob to get in urn format.
 
 #### Returns
 
-`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 The data for the blob if it can be found or undefined.
 

package/docs/reference/interfaces/IFileBlobStorageConnectorConstructorOptions.md

@@ -4,6 +4,14 @@ Options for the File Blob Storage Connector constructor.
 
 ## Properties
 
+### partitionContextIds?
+
+> `optional` **partitionContextIds**: `string`[]
+
+The keys to use from the context ids to create partitions.
+
+***
+
 ### config
 
 > **config**: [`IFileBlobStorageConnectorConfig`](IFileBlobStorageConnectorConfig.md)

package/locales/en.json

@@ -2,7 +2,6 @@
 	"info": {
 		"fileBlobStorageConnector": {
 			"directoryCreating": "Creating directory \"{directory}\"",
-			"directoryCreated": "Created directory \"{directory}\"",
 			"directoryExists": "Skipping create directory \"{directory}\" as it already exists"
 		}
 	},

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-connector-file",
-	"version": "0.0.2-next.5",
+	"version": "0.0.3-next.1",
 	"description": "Blob Storage connector implementation using file storage",
 	"repository": {
 		"type": "git",
@@ -14,26 +14,25 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/blob-storage-models": "0.0.2-next.5",
+		"@twin.org/blob-storage-models": "0.0.3-next.1",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "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"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"

package/dist/cjs/index.cjs

@@ -1,183 +0,0 @@
-'use strict';
-
-var promises = require('node:fs/promises');
-var path = require('node:path');
-var core = require('@twin.org/core');
-var crypto = require('@twin.org/crypto');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for performing blob storage operations in file.
- */
-class FileBlobStorageConnector {
-    /**
-     * The namespace for the items.
-     */
-    static NAMESPACE = "file";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "FileBlobStorageConnector";
-    /**
-     * The directory to use for storage.
-     * @internal
-     */
-    _directory;
-    /**
-     * The extension to use for storage.
-     * @internal
-     */
-    _extension;
-    /**
-     * Create a new instance of FileBlobStorageConnector.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        core.Guards.object(FileBlobStorageConnector.CLASS_NAME, "options", options);
-        core.Guards.object(FileBlobStorageConnector.CLASS_NAME, "options.config", options.config);
-        core.Guards.stringValue(FileBlobStorageConnector.CLASS_NAME, "options.config.directory", options.config.directory);
-        this._directory = path.resolve(options.config.directory);
-        this._extension = options.config.extension ?? ".blob";
-    }
-    /**
-     * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns True if the bootstrapping process was successful.
-     */
-    async bootstrap(nodeLoggingComponentType) {
-        const nodeLogging = core.ComponentFactory.getIfExists(nodeLoggingComponentType);
-        if (!(await this.dirExists(this._directory))) {
-            await nodeLogging?.log({
-                level: "info",
-                source: FileBlobStorageConnector.CLASS_NAME,
-                message: "directoryCreating",
-                data: {
-                    directory: this._directory
-                }
-            });
-            try {
-                await promises.mkdir(this._directory, { recursive: true });
-                await nodeLogging?.log({
-                    level: "info",
-                    source: FileBlobStorageConnector.CLASS_NAME,
-                    message: "directoryCreated",
-                    data: {
-                        directory: this._directory
-                    }
-                });
-            }
-            catch (err) {
-                await nodeLogging?.log({
-                    level: "error",
-                    source: FileBlobStorageConnector.CLASS_NAME,
-                    message: "directoryCreateFailed",
-                    data: {
-                        directory: this._directory
-                    },
-                    error: core.BaseError.fromError(err)
-                });
-                return false;
-            }
-        }
-        else {
-            await nodeLogging?.log({
-                level: "info",
-                source: FileBlobStorageConnector.CLASS_NAME,
-                message: "directoryExists",
-                data: {
-                    directory: this._directory
-                }
-            });
-        }
-        return true;
-    }
-    /**
-     * Set the blob.
-     * @param blob The data for the blob.
-     * @returns The id of the stored blob in urn format.
-     */
-    async set(blob) {
-        core.Guards.uint8Array(FileBlobStorageConnector.CLASS_NAME, "blob", blob);
-        try {
-            if (!(await this.dirExists(this._directory))) {
-                await promises.mkdir(this._directory);
-            }
-            const id = core.Converter.bytesToHex(crypto.Sha256.sum256(blob));
-            const fullPath = path.join(this._directory, `${id}${this._extension}`);
-            await promises.writeFile(fullPath, blob);
-            return `blob:${new core.Urn(FileBlobStorageConnector.NAMESPACE, id).toString()}`;
-        }
-        catch (err) {
-            throw new core.GeneralError(FileBlobStorageConnector.CLASS_NAME, "setBlobFailed", undefined, err);
-        }
-    }
-    /**
-     * Get the blob.
-     * @param id The id of the blob to get in urn format.
-     * @returns The data for the blob if it can be found or undefined.
-     */
-    async get(id) {
-        core.Urn.guard(FileBlobStorageConnector.CLASS_NAME, "id", id);
-        const urnParsed = core.Urn.fromValidString(id);
-        if (urnParsed.namespaceMethod() !== FileBlobStorageConnector.NAMESPACE) {
-            throw new core.GeneralError(FileBlobStorageConnector.CLASS_NAME, "namespaceMismatch", {
-                namespace: FileBlobStorageConnector.NAMESPACE,
-                id
-            });
-        }
-        try {
-            const fullPath = path.join(this._directory, `${urnParsed.namespaceSpecific(1)}${this._extension}`);
-            return await promises.readFile(fullPath);
-        }
-        catch (err) {
-            if (core.BaseError.isErrorCode(err, "ENOENT")) {
-                return;
-            }
-            throw new core.GeneralError(FileBlobStorageConnector.CLASS_NAME, "getBlobFailed", { id }, err);
-        }
-    }
-    /**
-     * Remove the blob.
-     * @param id The id of the blob to remove in urn format.
-     * @returns True if the blob was found.
-     */
-    async remove(id) {
-        core.Urn.guard(FileBlobStorageConnector.CLASS_NAME, "id", id);
-        const urnParsed = core.Urn.fromValidString(id);
-        if (urnParsed.namespaceMethod() !== FileBlobStorageConnector.NAMESPACE) {
-            throw new core.GeneralError(FileBlobStorageConnector.CLASS_NAME, "namespaceMismatch", {
-                namespace: FileBlobStorageConnector.NAMESPACE,
-                id
-            });
-        }
-        try {
-            const fullPath = path.join(this._directory, `${urnParsed.namespaceSpecific(1)}${this._extension}`);
-            await promises.unlink(fullPath);
-            return true;
-        }
-        catch (err) {
-            if (core.BaseError.isErrorCode(err, "ENOENT")) {
-                return false;
-            }
-            throw new core.GeneralError(FileBlobStorageConnector.CLASS_NAME, "removeBlobFailed", { id }, err);
-        }
-    }
-    /**
-     * Check if the dir exists.
-     * @param dir The directory to check.
-     * @returns True if the dir exists.
-     * @internal
-     */
-    async dirExists(dir) {
-        try {
-            await promises.access(dir);
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-}
-
-exports.FileBlobStorageConnector = FileBlobStorageConnector;