@twin.org/blob-storage-service 0.0.1-next.21 → 0.0.1-next.23

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 (13) hide show
  1. package/dist/cjs/index.cjs +82 -43
  2. package/dist/esm/index.mjs +82 -43
  3. package/dist/types/blobStorageRoutes.d.ts +1 -1
  4. package/dist/types/blobStorageService.d.ts +7 -7
  5. package/dist/types/entities/blobStorageEntry.d.ts +6 -2
  6. package/dist/types/models/IBlobStorageServiceConstructorOptions.d.ts +1 -1
  7. package/docs/changelog.md +1 -1
  8. package/docs/open-api/spec.json +151 -121
  9. package/docs/reference/classes/BlobStorageEntry.md +11 -3
  10. package/docs/reference/classes/BlobStorageService.md +9 -9
  11. package/docs/reference/functions/blobStorageUpdate.md +1 -1
  12. package/docs/reference/interfaces/IBlobStorageServiceConstructorOptions.md +1 -1
  13. package/package.json +3 -2
package/docs/reference/classes/BlobStorageService.md CHANGED
@@ -50,9 +50,9 @@ 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`?, `annotationObject`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
54
54
 
55
- Create the blob with some metadata.
55
+ Create the blob with some annotation.
56
56
 
57
57
  #### Parameters
58
58
 
@@ -74,11 +74,11 @@ Mime type for the blob, will be detected if left undefined.
74
74
 
75
75
  Extension for the blob, will be detected if left undefined.
76
76
 
77
- ##### metadata?
77
+ ##### annotationObject?
78
78
 
79
79
  `IJsonLdNodeObject`
80
80
 
81
- Data for the custom metadata as JSON-LD.
81
+ Data for the custom annotation as JSON-LD.
82
82
 
83
83
  ##### namespace?
84
84
 
@@ -128,7 +128,7 @@ The id of the blob to get in urn format.
128
128
 
129
129
  `boolean`
130
130
 
131
- Include the content, or just get the metadata.
131
+ Include the content, or just get the annotation.
132
132
 
133
133
  ##### userIdentity?
134
134
 
@@ -160,9 +160,9 @@ 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`?, `annotationObject`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
164
164
 
165
- Update the blob with metadata.
165
+ Update the blob with annotation.
166
166
 
167
167
  #### Parameters
168
168
 
@@ -184,11 +184,11 @@ Mime type for the blob, will be detected if left undefined.
184
184
 
185
185
  Extension for the blob, will be detected if left undefined.
186
186
 
187
- ##### metadata?
187
+ ##### annotationObject?
188
188
 
189
189
  `IJsonLdNodeObject`
190
190
 
191
- Data for the custom metadata as JSON-LD.
191
+ Data for the custom annotation as JSON-LD.
192
192
 
193
193
  ##### userIdentity?
194
194
 
package/docs/reference/functions/blobStorageUpdate.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  > **blobStorageUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
4
4
 
5
- Update the blob storage metadata.
5
+ Update the blob storage annotation.
6
6
 
7
7
  ## Parameters
8
8
 
package/docs/reference/interfaces/IBlobStorageServiceConstructorOptions.md CHANGED
@@ -8,7 +8,7 @@ Options for the Blob Storage Service constructor.
8
8
 
9
9
  > `optional` **entryEntityStorageType**: `string`
10
10
 
11
- The type of the storage connector for the metadata.
11
+ The type of the storage connector for the annotation.
12
12
 
13
13
  #### Default
14
14
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-service",
3
- "version": "0.0.1-next.21",
3
+ "version": "0.0.1-next.23",
4
4
  "description": "Blob storage contract implementation and REST endpoint definitions",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,8 +15,9 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/api-models": "next",
18
- "@twin.org/blob-storage-models": "0.0.1-next.21",
18
+ "@twin.org/blob-storage-models": "0.0.1-next.23",
19
19
  "@twin.org/core": "next",
20
+ "@twin.org/crypto": "next",
20
21
  "@twin.org/data-json-ld": "next",
21
22
  "@twin.org/entity": "next",
22
23
  "@twin.org/entity-storage-models": "next",