@twin.org/blob-storage-service 0.0.1-next.29 → 0.0.1-next.30

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 (5) hide show
  1. package/docs/changelog.md +16 -0
  2. package/docs/reference/classes/BlobStorageEntry.md +3 -3
  3. package/docs/reference/classes/BlobStorageService.md +8 -8
  4. package/docs/reference/functions/generateRestRoutesBlobStorage.md +1 -1
  5. package/package.json +2 -2
package/docs/changelog.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @twin.org/blob-storage-service - Changelog
2
2
 
3
+ ## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.29...blob-storage-service-v0.0.1-next.30) (2025-04-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
16
+ * devDependencies
17
+ * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
18
+
3
19
  ## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.28...blob-storage-service-v0.0.1-next.29) (2025-03-28)
4
20
 
5
21
 
package/docs/reference/classes/BlobStorageEntry.md CHANGED
@@ -4,13 +4,13 @@ Class representing entry for the blob storage.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new BlobStorageEntry()
7
+ ### Constructor
8
8
 
9
- > **new BlobStorageEntry**(): [`BlobStorageEntry`](BlobStorageEntry.md)
9
+ > **new BlobStorageEntry**(): `BlobStorageEntry`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`BlobStorageEntry`](BlobStorageEntry.md)
13
+ `BlobStorageEntry`
14
14
 
15
15
  ## Properties
16
16
 
package/docs/reference/classes/BlobStorageService.md CHANGED
@@ -8,9 +8,9 @@ Service for performing blob storage operations to a connector.
8
8
 
9
9
  ## Constructors
10
10
 
11
- ### new BlobStorageService()
11
+ ### Constructor
12
12
 
13
- > **new BlobStorageService**(`options`?): [`BlobStorageService`](BlobStorageService.md)
13
+ > **new BlobStorageService**(`options?`): `BlobStorageService`
14
14
 
15
15
  Create a new instance of BlobStorageService.
16
16
 
@@ -24,7 +24,7 @@ The options for the service.
24
24
 
25
25
  #### Returns
26
26
 
27
- [`BlobStorageService`](BlobStorageService.md)
27
+ `BlobStorageService`
28
28
 
29
29
  ## Properties
30
30
 
@@ -50,7 +50,7 @@ Runtime name for the class.
50
50
 
51
51
  ### create()
52
52
 
53
- > **create**(`blob`, `encodingFormat`?, `fileExtension`?, `metadata`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
53
+ > **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `namespace?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
54
54
 
55
55
  Create the blob with some metadata.
56
56
 
@@ -112,7 +112,7 @@ The id of the stored blob in urn format.
112
112
 
113
113
  ### get()
114
114
 
115
- > **get**(`id`, `includeContent`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`IBlobStorageEntry`\>
115
+ > **get**(`id`, `includeContent`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IBlobStorageEntry`\>
116
116
 
117
117
  Get the blob entry.
118
118
 
@@ -160,7 +160,7 @@ Not found error if the blob cannot be found.
160
160
 
161
161
  ### update()
162
162
 
163
- > **update**(`id`, `encodingFormat`?, `fileExtension`?, `metadata`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
163
+ > **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
164
164
 
165
165
  Update the blob with metadata.
166
166
 
@@ -220,7 +220,7 @@ Not found error if the blob cannot be found.
220
220
 
221
221
  ### remove()
222
222
 
223
- > **remove**(`id`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
223
+ > **remove**(`id`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
224
224
 
225
225
  Remove the blob.
226
226
 
@@ -258,7 +258,7 @@ Nothing.
258
258
 
259
259
  ### query()
260
260
 
261
- > **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`IBlobStorageEntryList`\>
261
+ > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IBlobStorageEntryList`\>
262
262
 
263
263
  Query all the blob storage entries which match the conditions.
264
264
 
package/docs/reference/functions/generateRestRoutesBlobStorage.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Function: generateRestRoutesBlobStorage()
2
2
 
3
- > **generateRestRoutesBlobStorage**(`baseRouteName`, `componentName`, `options`?): `IRestRoute`\<`any`, `any`\>[]
3
+ > **generateRestRoutesBlobStorage**(`baseRouteName`, `componentName`, `options?`): `IRestRoute`\<`any`, `any`\>[]
4
4
 
5
5
  The REST routes for blob storage.
6
6
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-service",
3
- "version": "0.0.1-next.29",
3
+ "version": "0.0.1-next.30",
4
4
  "description": "Blob storage contract implementation and REST endpoint definitions",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,7 +15,7 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/api-models": "next",
18
- "@twin.org/blob-storage-models": "0.0.1-next.29",
18
+ "@twin.org/blob-storage-models": "0.0.1-next.30",
19
19
  "@twin.org/core": "next",
20
20
  "@twin.org/crypto": "next",
21
21
  "@twin.org/data-json-ld": "next",