@twin.org/blob-storage-connector-file 0.0.1-next.3 → 0.0.1-next.30

package/dist/cjs/index.cjs

@@ -33,7 +33,6 @@ class FileBlobStorageConnector {
     /**
      * Create a new instance of FileBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);

package/dist/esm/index.mjs

@@ -31,7 +31,6 @@ class FileBlobStorageConnector {
     /**
      * Create a new instance of FileBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);

package/dist/types/fileBlobStorageConnector.d.ts

@@ -1,5 +1,5 @@
 import type { IBlobStorageConnector } from "@twin.org/blob-storage-models";
-import type { IFileBlobStorageConnectorConfig } from "./models/IFileBlobStorageConnectorConfig";
+import type { IFileBlobStorageConnectorConstructorOptions } from "./models/IFileBlobStorageConnectorConstructorOptions";
 /**
  * Class for performing blob storage operations in file.
  */
@@ -15,11 +15,8 @@ export declare class FileBlobStorageConnector implements IBlobStorageConnector {
     /**
      * Create a new instance of FileBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
-    constructor(options: {
-        config: IFileBlobStorageConnectorConfig;
-    });
+    constructor(options: IFileBlobStorageConnectorConstructorOptions);
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".

package/dist/types/index.d.ts

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

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

@@ -0,0 +1,10 @@
+import type { IFileBlobStorageConnectorConfig } from "./IFileBlobStorageConnectorConfig";
+/**
+ * Options for the File Blob Storage Connector constructor.
+ */
+export interface IFileBlobStorageConnectorConstructorOptions {
+    /**
+     * The configuration for the connector.
+     */
+    config: IFileBlobStorageConnectorConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/blob-storage-connector-file - Changelog
 
-## v0.0.1-next.3
+## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.1-next.29...blob-storage-connector-file-v0.0.1-next.30) (2025-04-17)
+
+
+### Features
+
+* 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.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.1-next.28...blob-storage-connector-file-v0.0.1-next.29) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-connector-file:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## v0.0.1-next.28
 
 - Initial Release

package/docs/reference/classes/FileBlobStorageConnector.md

@@ -8,25 +8,23 @@ Class for performing blob storage operations in file.
 
 ## Constructors
 
-### new FileBlobStorageConnector()
+### Constructor
 
-> **new FileBlobStorageConnector**(`options`): [`FileBlobStorageConnector`](FileBlobStorageConnector.md)
+> **new FileBlobStorageConnector**(`options`): `FileBlobStorageConnector`
 
 Create a new instance of FileBlobStorageConnector.
 
 #### Parameters
 
-• **options**
+##### options
 
-The options for the connector.
-
-• **options.config**: [`IFileBlobStorageConnectorConfig`](../interfaces/IFileBlobStorageConnectorConfig.md)
+[`IFileBlobStorageConnectorConstructorOptions`](../interfaces/IFileBlobStorageConnectorConstructorOptions.md)
 
-The configuration for the connector.
+The options for the connector.
 
 #### Returns
 
-[`FileBlobStorageConnector`](FileBlobStorageConnector.md)
+`FileBlobStorageConnector`
 
 ## Properties
 
@@ -52,13 +50,15 @@ Runtime name for the class.
 
 ### bootstrap()
 
-> **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+> **bootstrap**(`nodeLoggingConnectorType?`): `Promise`\<`boolean`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -82,7 +82,9 @@ Set the blob.
 
 #### Parameters
 
-• **blob**: `Uint8Array`
+##### blob
+
+`Uint8Array`
 
 The data for the blob.
 
@@ -100,19 +102,21 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\>
+> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
 
 Get the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
 #### Returns
 
-`Promise`\<`undefined` \| `Uint8Array`\>
+`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
 
 The data for the blob if it can be found or undefined.
 
@@ -130,7 +134,9 @@ Remove the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to remove in urn format.
 

package/docs/reference/index.md

@@ -7,3 +7,4 @@
 ## Interfaces
 
 - [IFileBlobStorageConnectorConfig](interfaces/IFileBlobStorageConnectorConfig.md)
+- [IFileBlobStorageConnectorConstructorOptions](interfaces/IFileBlobStorageConnectorConstructorOptions.md)

package/docs/reference/interfaces/IFileBlobStorageConnectorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IFileBlobStorageConnectorConstructorOptions
+
+Options for the File Blob Storage Connector constructor.
+
+## Properties
+
+### config
+
+> **config**: [`IFileBlobStorageConnectorConfig`](IFileBlobStorageConnectorConfig.md)
+
+The configuration for the connector.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-connector-file",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.30",
 	"description": "Blob Storage connector implementation using file storage",
 	"repository": {
 		"type": "git",
@@ -13,56 +13,23 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage docs/reference",
-		"build": "tspc",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
-		"@twin.org/blob-storage-models": "0.0.1-next.3",
+		"@twin.org/blob-storage-models": "0.0.1-next.30",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/logging-models": "next"
-	},
-	"devDependencies": {
-		"@twin.org/logging-connector-entity-storage": "next",
-		"@twin.org/logging-service": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-connector-memory": "next",
-		"@twin.org/nameof-transformer": "next",
-		"@types/node": "22.5.5",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"dotenv": "16.4.5",
-		"rimraf": "6.0.1",
-		"rollup": "4.22.0",
-		"rollup-plugin-copy": "3.5.0",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",