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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist/cjs/index.cjs +0 -1
  2. package/dist/esm/index.mjs +0 -1
  3. package/dist/types/fileBlobStorageConnector.d.ts +2 -5
  4. package/dist/types/index.d.ts +1 -0
  5. package/dist/types/models/IFileBlobStorageConnectorConstructorOptions.d.ts +10 -0
  6. package/docs/changelog.md +141 -1
  7. package/docs/reference/classes/FileBlobStorageConnector.md +21 -15
  8. package/docs/reference/index.md +1 -0
  9. package/docs/reference/interfaces/IFileBlobStorageConnectorConstructorOptions.md +11 -0
  10. package/package.json +9 -9
package/dist/cjs/index.cjs CHANGED
@@ -33,7 +33,6 @@ class FileBlobStorageConnector {
33
33
  /**
34
34
  * Create a new instance of FileBlobStorageConnector.
35
35
  * @param options The options for the connector.
36
- * @param options.config The configuration for the connector.
37
36
  */
38
37
  constructor(options) {
39
38
  core.Guards.object(this.CLASS_NAME, "options", options);
package/dist/esm/index.mjs CHANGED
@@ -31,7 +31,6 @@ class FileBlobStorageConnector {
31
31
  /**
32
32
  * Create a new instance of FileBlobStorageConnector.
33
33
  * @param options The options for the connector.
34
- * @param options.config The configuration for the connector.
35
34
  */
36
35
  constructor(options) {
37
36
  Guards.object(this.CLASS_NAME, "options", options);
package/dist/types/fileBlobStorageConnector.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { IBlobStorageConnector } from "@twin.org/blob-storage-models";
2
- import type { IFileBlobStorageConnectorConfig } from "./models/IFileBlobStorageConnectorConfig";
2
+ import type { IFileBlobStorageConnectorConstructorOptions } from "./models/IFileBlobStorageConnectorConstructorOptions";
3
3
  /**
4
4
  * Class for performing blob storage operations in file.
5
5
  */
@@ -15,11 +15,8 @@ export declare class FileBlobStorageConnector implements IBlobStorageConnector {
15
15
  /**
16
16
  * Create a new instance of FileBlobStorageConnector.
17
17
  * @param options The options for the connector.
18
- * @param options.config The configuration for the connector.
19
18
  */
20
- constructor(options: {
21
- config: IFileBlobStorageConnectorConfig;
22
- });
19
+ constructor(options: IFileBlobStorageConnectorConstructorOptions);
23
20
  /**
24
21
  * Bootstrap the component by creating and initializing any resources it needs.
25
22
  * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
package/dist/types/index.d.ts CHANGED
@@ -1,2 +1,3 @@
1
1
  export * from "./fileBlobStorageConnector";
2
2
  export * from "./models/IFileBlobStorageConnectorConfig";
3
+ export * from "./models/IFileBlobStorageConnectorConstructorOptions";
package/dist/types/models/IFileBlobStorageConnectorConstructorOptions.d.ts ADDED
@@ -0,0 +1,10 @@
1
+ import type { IFileBlobStorageConnectorConfig } from "./IFileBlobStorageConnectorConfig";
2
+ /**
3
+ * Options for the File Blob Storage Connector constructor.
4
+ */
5
+ export interface IFileBlobStorageConnectorConstructorOptions {
6
+ /**
7
+ * The configuration for the connector.
8
+ */
9
+ config: IFileBlobStorageConnectorConfig;
10
+ }
package/docs/changelog.md CHANGED
@@ -1,5 +1,145 @@
1
1
  # @twin.org/blob-storage-connector-file - Changelog
2
2
 
3
- ## v0.0.1-next.9
3
+ ## 0.0.1 (2025-07-04)
4
+
5
+
6
+ ### Features
7
+
8
+ * release to production ([eacfe75](https://github.com/twinfoundation/blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/blob-storage-models bumped from ^0.0.0 to ^0.0.1
16
+
17
+ ## [0.0.1-next.37](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.1-next.36...blob-storage-connector-file-v0.0.1-next.37) (2025-06-20)
18
+
19
+
20
+ ### Miscellaneous Chores
21
+
22
+ * **blob-storage-connector-file:** Synchronize repo versions
23
+
24
+
25
+ ### Dependencies
26
+
27
+ * The following workspace dependencies were updated
28
+ * dependencies
29
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.36 to 0.0.1-next.37
30
+
31
+ ## [0.0.1-next.36](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.1-next.35...blob-storage-connector-file-v0.0.1-next.36) (2025-06-19)
32
+
33
+
34
+ ### Miscellaneous Chores
35
+
36
+ * **blob-storage-connector-file:** Synchronize repo versions
37
+
38
+
39
+ ### Dependencies
40
+
41
+ * The following workspace dependencies were updated
42
+ * dependencies
43
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.35 to 0.0.1-next.36
44
+
45
+ ## [0.0.1-next.35](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.1-next.34...blob-storage-connector-file-v0.0.1-next.35) (2025-06-17)
46
+
47
+
48
+ ### Miscellaneous Chores
49
+
50
+ * **blob-storage-connector-file:** Synchronize repo versions
51
+
52
+
53
+ ### Dependencies
54
+
55
+ * The following workspace dependencies were updated
56
+ * dependencies
57
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.34 to 0.0.1-next.35
58
+
59
+ ## [0.0.1-next.34](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.1-next.33...blob-storage-connector-file-v0.0.1-next.34) (2025-06-12)
60
+
61
+
62
+ ### Features
63
+
64
+ * update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
65
+
66
+
67
+ ### Dependencies
68
+
69
+ * The following workspace dependencies were updated
70
+ * dependencies
71
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.33 to 0.0.1-next.34
72
+
73
+ ## [0.0.1-next.33](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.1-next.32...blob-storage-connector-file-v0.0.1-next.33) (2025-06-03)
74
+
75
+
76
+ ### Miscellaneous Chores
77
+
78
+ * **blob-storage-connector-file:** Synchronize repo versions
79
+
80
+
81
+ ### Dependencies
82
+
83
+ * The following workspace dependencies were updated
84
+ * dependencies
85
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.32 to 0.0.1-next.33
86
+
87
+ ## [0.0.1-next.32](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.1-next.31...blob-storage-connector-file-v0.0.1-next.32) (2025-05-28)
88
+
89
+
90
+ ### Miscellaneous Chores
91
+
92
+ * **blob-storage-connector-file:** Synchronize repo versions
93
+
94
+
95
+ ### Dependencies
96
+
97
+ * The following workspace dependencies were updated
98
+ * dependencies
99
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.31 to 0.0.1-next.32
100
+
101
+ ## [0.0.1-next.31](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-file-v0.0.1-next.30...blob-storage-connector-file-v0.0.1-next.31) (2025-05-08)
102
+
103
+
104
+ ### Miscellaneous Chores
105
+
106
+ * **blob-storage-connector-file:** Synchronize repo versions
107
+
108
+
109
+ ### Dependencies
110
+
111
+ * The following workspace dependencies were updated
112
+ * dependencies
113
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.30 to 0.0.1-next.31
114
+
115
+ ## [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)
116
+
117
+
118
+ ### Features
119
+
120
+ * use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
121
+
122
+
123
+ ### Dependencies
124
+
125
+ * The following workspace dependencies were updated
126
+ * dependencies
127
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
128
+
129
+ ## [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)
130
+
131
+
132
+ ### Miscellaneous Chores
133
+
134
+ * **blob-storage-connector-file:** Synchronize repo versions
135
+
136
+
137
+ ### Dependencies
138
+
139
+ * The following workspace dependencies were updated
140
+ * dependencies
141
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
142
+
143
+ ## v0.0.1-next.28
4
144
 
5
145
  - Initial Release
package/docs/reference/classes/FileBlobStorageConnector.md CHANGED
@@ -8,25 +8,23 @@ Class for performing blob storage operations in file.
8
8
 
9
9
  ## Constructors
10
10
 
11
- ### new FileBlobStorageConnector()
11
+ ### Constructor
12
12
 
13
- > **new FileBlobStorageConnector**(`options`): [`FileBlobStorageConnector`](FileBlobStorageConnector.md)
13
+ > **new FileBlobStorageConnector**(`options`): `FileBlobStorageConnector`
14
14
 
15
15
  Create a new instance of FileBlobStorageConnector.
16
16
 
17
17
  #### Parameters
18
18
 
19
- • **options**
19
+ ##### options
20
20
 
21
- The options for the connector.
22
-
23
- • **options.config**: [`IFileBlobStorageConnectorConfig`](../interfaces/IFileBlobStorageConnectorConfig.md)
21
+ [`IFileBlobStorageConnectorConstructorOptions`](../interfaces/IFileBlobStorageConnectorConstructorOptions.md)
24
22
 
25
- The configuration for the connector.
23
+ The options for the connector.
26
24
 
27
25
  #### Returns
28
26
 
29
- [`FileBlobStorageConnector`](FileBlobStorageConnector.md)
27
+ `FileBlobStorageConnector`
30
28
 
31
29
  ## Properties
32
30
 
@@ -52,13 +50,15 @@ Runtime name for the class.
52
50
 
53
51
  ### bootstrap()
54
52
 
55
- > **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
53
+ > **bootstrap**(`nodeLoggingConnectorType?`): `Promise`\<`boolean`\>
56
54
 
57
55
  Bootstrap the component by creating and initializing any resources it needs.
58
56
 
59
57
  #### Parameters
60
58
 
61
- • **nodeLoggingConnectorType?**: `string`
59
+ ##### nodeLoggingConnectorType?
60
+
61
+ `string`
62
62
 
63
63
  The node logging connector type, defaults to "node-logging".
64
64
 
@@ -82,7 +82,9 @@ Set the blob.
82
82
 
83
83
  #### Parameters
84
84
 
85
- • **blob**: `Uint8Array`
85
+ ##### blob
86
+
87
+ `Uint8Array`
86
88
 
87
89
  The data for the blob.
88
90
 
@@ -100,19 +102,21 @@ The id of the stored blob in urn format.
100
102
 
101
103
  ### get()
102
104
 
103
- > **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\>
105
+ > **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
104
106
 
105
107
  Get the blob.
106
108
 
107
109
  #### Parameters
108
110
 
109
- • **id**: `string`
111
+ ##### id
112
+
113
+ `string`
110
114
 
111
115
  The id of the blob to get in urn format.
112
116
 
113
117
  #### Returns
114
118
 
115
- `Promise`\<`undefined` \| `Uint8Array`\>
119
+ `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
116
120
 
117
121
  The data for the blob if it can be found or undefined.
118
122
 
@@ -130,7 +134,9 @@ Remove the blob.
130
134
 
131
135
  #### Parameters
132
136
 
133
- • **id**: `string`
137
+ ##### id
138
+
139
+ `string`
134
140
 
135
141
  The id of the blob to remove in urn format.
136
142
 
package/docs/reference/index.md CHANGED
@@ -7,3 +7,4 @@
7
7
  ## Interfaces
8
8
 
9
9
  - [IFileBlobStorageConnectorConfig](interfaces/IFileBlobStorageConnectorConfig.md)
10
+ - [IFileBlobStorageConnectorConstructorOptions](interfaces/IFileBlobStorageConnectorConstructorOptions.md)
package/docs/reference/interfaces/IFileBlobStorageConnectorConstructorOptions.md ADDED
@@ -0,0 +1,11 @@
1
+ # Interface: IFileBlobStorageConnectorConstructorOptions
2
+
3
+ Options for the File Blob Storage Connector constructor.
4
+
5
+ ## Properties
6
+
7
+ ### config
8
+
9
+ > **config**: [`IFileBlobStorageConnectorConfig`](IFileBlobStorageConnectorConfig.md)
10
+
11
+ The configuration for the connector.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-connector-file",
3
- "version": "0.0.1-next.9",
3
+ "version": "0.0.1",
4
4
  "description": "Blob Storage connector implementation using file storage",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,22 +14,22 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/blob-storage-models": "0.0.1-next.9",
18
- "@twin.org/core": "next",
19
- "@twin.org/crypto": "next",
20
- "@twin.org/logging-models": "next",
21
- "@twin.org/nameof": "next"
17
+ "@twin.org/blob-storage-models": "^0.0.1",
18
+ "@twin.org/core": "^0.0.1",
19
+ "@twin.org/crypto": "^0.0.1",
20
+ "@twin.org/logging-models": "^0.0.1",
21
+ "@twin.org/nameof": "^0.0.1"
22
22
  },
23
23
  "main": "./dist/cjs/index.cjs",
24
24
  "module": "./dist/esm/index.mjs",
25
25
  "types": "./dist/types/index.d.ts",
26
26
  "exports": {
27
27
  ".": {
28
+ "types": "./dist/types/index.d.ts",
28
29
  "require": "./dist/cjs/index.cjs",
29
- "import": "./dist/esm/index.mjs",
30
- "types": "./dist/types/index.d.ts"
30
+ "import": "./dist/esm/index.mjs"
31
31
  },
32
- "./locales": "./locales"
32
+ "./locales/*.json": "./locales/*.json"
33
33
  },
34
34
  "files": [
35
35
  "dist/cjs",