@twin.org/blob-storage-models 0.0.1-next.17 → 0.0.1-next.18

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 +1 -1
  2. package/docs/reference/interfaces/IBlobStorageComponent.md +81 -27
  3. package/docs/reference/interfaces/IBlobStorageConnector.md +9 -3
  4. package/docs/reference/interfaces/IBlobStorageEntry.md +1 -1
  5. package/docs/reference/interfaces/IBlobStorageEntryList.md +1 -1
  6. package/package.json +1 -1
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/blob-storage-models - Changelog
2
2
 
3
- ## v0.0.1-next.17
3
+ ## v0.0.1-next.18
4
4
 
5
5
  - Initial Release
package/docs/reference/interfaces/IBlobStorageComponent.md CHANGED
@@ -16,31 +16,45 @@ Create the blob with some metadata.
16
16
 
17
17
  #### Parameters
18
18
 
19
- • **blob**: `string`
19
+ ##### blob
20
+
21
+ `string`
20
22
 
21
23
  The data for the blob in base64 format.
22
24
 
23
- • **encodingFormat?**: `string`
25
+ ##### encodingFormat?
26
+
27
+ `string`
24
28
 
25
29
  Mime type for the blob, will be detected if left undefined.
26
30
 
27
- • **fileExtension?**: `string`
31
+ ##### fileExtension?
32
+
33
+ `string`
28
34
 
29
35
  Extension for the blob, will be detected if left undefined.
30
36
 
31
- • **metadata?**: `IJsonLdNodeObject`
37
+ ##### metadata?
38
+
39
+ `IJsonLdNodeObject`
32
40
 
33
41
  Data for the custom metadata as JSON-LD.
34
42
 
35
- • **namespace?**: `string`
43
+ ##### namespace?
44
+
45
+ `string`
36
46
 
37
47
  The namespace to use for storing, defaults to component configured namespace.
38
48
 
39
- • **userIdentity?**: `string`
49
+ ##### userIdentity?
50
+
51
+ `string`
40
52
 
41
53
  The user identity to use with storage operations.
42
54
 
43
- • **nodeIdentity?**: `string`
55
+ ##### nodeIdentity?
56
+
57
+ `string`
44
58
 
45
59
  The node identity to use with storage operations.
46
60
 
@@ -60,19 +74,27 @@ Get the blob and metadata.
60
74
 
61
75
  #### Parameters
62
76
 
63
- • **id**: `string`
77
+ ##### id
78
+
79
+ `string`
64
80
 
65
81
  The id of the blob to get in urn format.
66
82
 
67
- • **includeContent**: `boolean`
83
+ ##### includeContent
84
+
85
+ `boolean`
68
86
 
69
87
  Include the content, or just get the metadata.
70
88
 
71
- • **userIdentity?**: `string`
89
+ ##### userIdentity?
90
+
91
+ `string`
72
92
 
73
93
  The user identity to use with storage operations.
74
94
 
75
- • **nodeIdentity?**: `string`
95
+ ##### nodeIdentity?
96
+
97
+ `string`
76
98
 
77
99
  The node identity to use with storage operations.
78
100
 
@@ -96,27 +118,39 @@ Update the blob with metadata.
96
118
 
97
119
  #### Parameters
98
120
 
99
- • **id**: `string`
121
+ ##### id
122
+
123
+ `string`
100
124
 
101
125
  The id of the blob metadata to update.
102
126
 
103
- • **encodingFormat?**: `string`
127
+ ##### encodingFormat?
128
+
129
+ `string`
104
130
 
105
131
  Mime type for the blob, will be detected if left undefined.
106
132
 
107
- • **fileExtension?**: `string`
133
+ ##### fileExtension?
134
+
135
+ `string`
108
136
 
109
137
  Extension for the blob, will be detected if left undefined.
110
138
 
111
- • **metadata?**: `IJsonLdNodeObject`
139
+ ##### metadata?
140
+
141
+ `IJsonLdNodeObject`
112
142
 
113
143
  Data for the custom metadata as JSON-LD.
114
144
 
115
- • **userIdentity?**: `string`
145
+ ##### userIdentity?
146
+
147
+ `string`
116
148
 
117
149
  The user identity to use with storage operations.
118
150
 
119
- • **nodeIdentity?**: `string`
151
+ ##### nodeIdentity?
152
+
153
+ `string`
120
154
 
121
155
  The node identity to use with storage operations.
122
156
 
@@ -140,15 +174,21 @@ Remove the blob.
140
174
 
141
175
  #### Parameters
142
176
 
143
- • **id**: `string`
177
+ ##### id
178
+
179
+ `string`
144
180
 
145
181
  The id of the blob to remove in urn format.
146
182
 
147
- • **userIdentity?**: `string`
183
+ ##### userIdentity?
184
+
185
+ `string`
148
186
 
149
187
  The user identity to use with storage operations.
150
188
 
151
- • **nodeIdentity?**: `string`
189
+ ##### nodeIdentity?
190
+
191
+ `string`
152
192
 
153
193
  The node identity to use with storage operations.
154
194
 
@@ -172,31 +212,45 @@ Query all the blob storage entries which match the conditions.
172
212
 
173
213
  #### Parameters
174
214
 
175
- • **conditions?**: `EntityCondition`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
215
+ ##### conditions?
216
+
217
+ `EntityCondition`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
176
218
 
177
219
  The conditions to match for the entries.
178
220
 
179
- • **orderBy?**: `"dateCreated"` \| `"dateModified"`
221
+ ##### orderBy?
180
222
 
181
223
  The order for the results, defaults to created.
182
224
 
183
- • **orderByDirection?**: `SortDirection`
225
+ `"dateCreated"` | `"dateModified"`
226
+
227
+ ##### orderByDirection?
228
+
229
+ `SortDirection`
184
230
 
185
231
  The direction for the order, defaults to descending.
186
232
 
187
- • **cursor?**: `string`
233
+ ##### cursor?
234
+
235
+ `string`
188
236
 
189
237
  The cursor to request the next page of entries.
190
238
 
191
- • **pageSize?**: `number`
239
+ ##### pageSize?
240
+
241
+ `number`
192
242
 
193
243
  The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
194
244
 
195
- • **userIdentity?**: `string`
245
+ ##### userIdentity?
246
+
247
+ `string`
196
248
 
197
249
  The user identity to use with storage operations.
198
250
 
199
- • **nodeIdentity?**: `string`
251
+ ##### nodeIdentity?
252
+
253
+ `string`
200
254
 
201
255
  The node identity to use with storage operations.
202
256
 
package/docs/reference/interfaces/IBlobStorageConnector.md CHANGED
@@ -16,7 +16,9 @@ Set the blob.
16
16
 
17
17
  #### Parameters
18
18
 
19
- • **blob**: `Uint8Array`
19
+ ##### blob
20
+
21
+ `Uint8Array`
20
22
 
21
23
  The data for the blob.
22
24
 
@@ -36,7 +38,9 @@ Get the blob.
36
38
 
37
39
  #### Parameters
38
40
 
39
- • **id**: `string`
41
+ ##### id
42
+
43
+ `string`
40
44
 
41
45
  The id of the blob to get in urn format.
42
46
 
@@ -56,7 +60,9 @@ Remove the blob.
56
60
 
57
61
  #### Parameters
58
62
 
59
- • **id**: `string`
63
+ ##### id
64
+
65
+ `string`
60
66
 
61
67
  The id of the blob to remove in urn format.
62
68
 
package/docs/reference/interfaces/IBlobStorageEntry.md CHANGED
@@ -6,7 +6,7 @@ Interface describing a blob storage entry.
6
6
 
7
7
  ### @context
8
8
 
9
- > **@context**: `"https://schema.twindev.org/blob-storage/"` \| [`"https://schema.twindev.org/blob-storage/"`, `...string[]`]
9
+ > **@context**: `"https://schema.twindev.org/blob-storage/"` \| \[`"https://schema.twindev.org/blob-storage/"`, `...string[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
package/docs/reference/interfaces/IBlobStorageEntryList.md CHANGED
@@ -6,7 +6,7 @@ Interface describing an blob storage entry list.
6
6
 
7
7
  ### @context
8
8
 
9
- > **@context**: `"https://schema.twindev.org/blob-storage/"` \| [`"https://schema.twindev.org/blob-storage/"`, `...string[]`]
9
+ > **@context**: `"https://schema.twindev.org/blob-storage/"` \| \[`"https://schema.twindev.org/blob-storage/"`, `...string[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-models",
3
- "version": "0.0.1-next.17",
3
+ "version": "0.0.1-next.18",
4
4
  "description": "Models which define the structure of the blob storage contracts and connectors",
5
5
  "repository": {
6
6
  "type": "git",