@twin.org/blob-storage-models 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 (6) hide show
  1. package/docs/changelog.md +7 -0
  2. package/docs/reference/classes/BlobStorageDataTypes.md +3 -3
  3. package/docs/reference/interfaces/IBlobStorageComponent.md +5 -5
  4. package/docs/reference/type-aliases/BlobStorageContexts.md +1 -1
  5. package/docs/reference/type-aliases/BlobStorageTypes.md +1 -1
  6. package/package.json +1 -1
package/docs/changelog.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @twin.org/blob-storage-models - Changelog
2
2
 
3
+ ## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.29...blob-storage-models-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
+
3
10
  ## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.28...blob-storage-models-v0.0.1-next.29) (2025-03-28)
4
11
 
5
12
 
package/docs/reference/classes/BlobStorageDataTypes.md CHANGED
@@ -4,13 +4,13 @@ Handle all the data types for blob storage.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new BlobStorageDataTypes()
7
+ ### Constructor
8
8
 
9
- > **new BlobStorageDataTypes**(): [`BlobStorageDataTypes`](BlobStorageDataTypes.md)
9
+ > **new BlobStorageDataTypes**(): `BlobStorageDataTypes`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`BlobStorageDataTypes`](BlobStorageDataTypes.md)
13
+ `BlobStorageDataTypes`
14
14
 
15
15
  ## Methods
16
16
 
package/docs/reference/interfaces/IBlobStorageComponent.md CHANGED
@@ -10,7 +10,7 @@ Interface describing an blob storage component.
10
10
 
11
11
  ### create()
12
12
 
13
- > **create**(`blob`, `encodingFormat`?, `fileExtension`?, `metadata`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
13
+ > **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `namespace?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
14
14
 
15
15
  Create the blob with some metadata.
16
16
 
@@ -68,7 +68,7 @@ The id of the stored blob in urn format.
68
68
 
69
69
  ### get()
70
70
 
71
- > **get**(`id`, `includeContent`, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
71
+ > **get**(`id`, `includeContent`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
72
72
 
73
73
  Get the blob and metadata.
74
74
 
@@ -112,7 +112,7 @@ Not found error if the blob cannot be found.
112
112
 
113
113
  ### update()
114
114
 
115
- > **update**(`id`, `encodingFormat`?, `fileExtension`?, `metadata`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
115
+ > **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
116
116
 
117
117
  Update the blob with metadata.
118
118
 
@@ -168,7 +168,7 @@ Not found error if the blob cannot be found.
168
168
 
169
169
  ### remove()
170
170
 
171
- > **remove**(`id`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
171
+ > **remove**(`id`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
172
172
 
173
173
  Remove the blob.
174
174
 
@@ -206,7 +206,7 @@ Not found error if the blob cannot be found.
206
206
 
207
207
  ### query()
208
208
 
209
- > **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
209
+ > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
210
210
 
211
211
  Query all the blob storage entries which match the conditions.
212
212
 
package/docs/reference/type-aliases/BlobStorageContexts.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Type Alias: BlobStorageContexts
2
2
 
3
- > **BlobStorageContexts**: *typeof* [`BlobStorageContexts`](../variables/BlobStorageContexts.md)\[keyof *typeof* [`BlobStorageContexts`](../variables/BlobStorageContexts.md)\]
3
+ > **BlobStorageContexts** = *typeof* [`BlobStorageContexts`](../variables/BlobStorageContexts.md)\[keyof *typeof* [`BlobStorageContexts`](../variables/BlobStorageContexts.md)\]
4
4
 
5
5
  The contexts of blob storage data.
package/docs/reference/type-aliases/BlobStorageTypes.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Type Alias: BlobStorageTypes
2
2
 
3
- > **BlobStorageTypes**: *typeof* [`BlobStorageTypes`](../variables/BlobStorageTypes.md)\[keyof *typeof* [`BlobStorageTypes`](../variables/BlobStorageTypes.md)\]
3
+ > **BlobStorageTypes** = *typeof* [`BlobStorageTypes`](../variables/BlobStorageTypes.md)\[keyof *typeof* [`BlobStorageTypes`](../variables/BlobStorageTypes.md)\]
4
4
 
5
5
  The types of blob storage data.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-models",
3
- "version": "0.0.1-next.29",
3
+ "version": "0.0.1-next.30",
4
4
  "description": "Models which define the structure of the blob storage contracts and connectors",
5
5
  "repository": {
6
6
  "type": "git",