@twin.org/web 0.0.3-next.3 → 0.0.3-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 (52) hide show
  1. package/README.md +1 -1
  2. package/dist/es/index.js +3 -0
  3. package/dist/es/index.js.map +1 -1
  4. package/dist/es/models/IHttpLinkHeader.js +2 -0
  5. package/dist/es/models/IHttpLinkHeader.js.map +1 -0
  6. package/dist/es/models/headerTypes.js +129 -1
  7. package/dist/es/models/headerTypes.js.map +1 -1
  8. package/dist/es/models/httpLinkRelType.js +130 -0
  9. package/dist/es/models/httpLinkRelType.js.map +1 -0
  10. package/dist/es/models/httpMethod.js +36 -0
  11. package/dist/es/models/httpMethod.js.map +1 -1
  12. package/dist/es/models/httpStatusCode.js +63 -0
  13. package/dist/es/models/httpStatusCode.js.map +1 -1
  14. package/dist/es/models/mimeTypes.js +170 -1
  15. package/dist/es/models/mimeTypes.js.map +1 -1
  16. package/dist/es/utils/cookieHelper.js +83 -0
  17. package/dist/es/utils/cookieHelper.js.map +1 -0
  18. package/dist/es/utils/headerHelper.js +383 -1
  19. package/dist/es/utils/headerHelper.js.map +1 -1
  20. package/dist/es/utils/mimeTypeHelper.js +42 -1
  21. package/dist/es/utils/mimeTypeHelper.js.map +1 -1
  22. package/dist/types/index.d.ts +3 -0
  23. package/dist/types/models/IHttpLinkHeader.d.ts +26 -0
  24. package/dist/types/models/headerTypes.d.ts +128 -0
  25. package/dist/types/models/httpLinkRelType.d.ts +130 -0
  26. package/dist/types/models/httpMethod.d.ts +36 -0
  27. package/dist/types/models/httpStatusCode.d.ts +63 -0
  28. package/dist/types/models/mimeTypes.d.ts +169 -0
  29. package/dist/types/utils/cookieHelper.d.ts +49 -0
  30. package/dist/types/utils/headerHelper.d.ts +115 -0
  31. package/docs/changelog.md +592 -1
  32. package/docs/examples.md +108 -1
  33. package/docs/reference/classes/CookieHelper.md +155 -0
  34. package/docs/reference/classes/FetchError.md +453 -1
  35. package/docs/reference/classes/FetchHelper.md +12 -12
  36. package/docs/reference/classes/HeaderHelper.md +385 -2
  37. package/docs/reference/classes/Jwk.md +6 -6
  38. package/docs/reference/classes/Jws.md +3 -3
  39. package/docs/reference/classes/Jwt.md +17 -17
  40. package/docs/reference/classes/MimeTypeHelper.md +4 -4
  41. package/docs/reference/index.md +4 -0
  42. package/docs/reference/interfaces/IFetchOptions.md +12 -12
  43. package/docs/reference/interfaces/IHttpHeaders.md +1 -1
  44. package/docs/reference/interfaces/IHttpLinkHeader.md +43 -0
  45. package/docs/reference/type-aliases/HttpLinkRelType.md +5 -0
  46. package/docs/reference/variables/HeaderTypes.md +280 -8
  47. package/docs/reference/variables/HttpLinkRelType.md +191 -0
  48. package/docs/reference/variables/HttpMethod.md +63 -9
  49. package/docs/reference/variables/HttpStatusCode.md +314 -62
  50. package/docs/reference/variables/MimeTypes.md +279 -23
  51. package/locales/en.json +4 -0
  52. package/package.json +6 -6
@@ -6,140 +6,396 @@ Common mime types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### PlainText
9
+ ### PlainText {#plaintext}
10
10
 
11
11
  > `readonly` **PlainText**: `"text/plain"` = `"text/plain"`
12
12
 
13
13
  Plaint Text - text/plain
14
14
 
15
- ### Html
15
+ ### EventStream {#eventstream}
16
+
17
+ > `readonly` **EventStream**: `"text/event-stream"` = `"text/event-stream"`
18
+
19
+ Event Stream - text/event-stream
20
+
21
+ ### Html {#html}
16
22
 
17
23
  > `readonly` **Html**: `"text/html"` = `"text/html"`
18
24
 
19
25
  HTML - text/html
20
26
 
21
- ### Javascript
27
+ ### Css {#css}
28
+
29
+ > `readonly` **Css**: `"text/css"` = `"text/css"`
30
+
31
+ CSS - text/css
32
+
33
+ ### Javascript {#javascript}
22
34
 
23
35
  > `readonly` **Javascript**: `"text/javascript"` = `"text/javascript"`
24
36
 
25
37
  Javascript - text/javascript
26
38
 
27
- ### Json
39
+ ### Markdown {#markdown}
40
+
41
+ > `readonly` **Markdown**: `"text/markdown"` = `"text/markdown"`
42
+
43
+ Markdown - text/markdown
44
+
45
+ ### Json {#json}
28
46
 
29
47
  > `readonly` **Json**: `"application/json"` = `"application/json"`
30
48
 
31
49
  JSON - application/json
32
50
 
33
- ### JsonLd
51
+ ### ProblemJson {#problemjson}
52
+
53
+ > `readonly` **ProblemJson**: `"application/problem+json"` = `"application/problem+json"`
54
+
55
+ Problem JSON - application/problem+json
56
+
57
+ ### JsonLd {#jsonld}
34
58
 
35
59
  > `readonly` **JsonLd**: `"application/ld+json"` = `"application/ld+json"`
36
60
 
37
61
  JSON-LD - application/ld+json
38
62
 
39
- ### Jwt
63
+ ### ActivityStreams {#activitystreams}
64
+
65
+ > `readonly` **ActivityStreams**: `"application/activity+json"` = `"application/activity+json"`
66
+
67
+ Activity Streams - application/activity+json
68
+
69
+ ### JrdJson {#jrdjson}
70
+
71
+ > `readonly` **JrdJson**: `"application/jrd+json"` = `"application/jrd+json"`
72
+
73
+ WebFinger JRD - application/jrd+json
74
+
75
+ ### Jwt {#jwt}
40
76
 
41
77
  > `readonly` **Jwt**: `"application/jwt"` = `"application/jwt"`
42
78
 
43
79
  JWT - application/jwt
44
80
 
45
- ### Xml
81
+ ### AccessTokenJwt {#accesstokenjwt}
82
+
83
+ > `readonly` **AccessTokenJwt**: `"application/at+jwt"` = `"application/at+jwt"`
84
+
85
+ Access Token JWT - application/at+jwt
86
+
87
+ ### Jose {#jose}
88
+
89
+ > `readonly` **Jose**: `"application/jose"` = `"application/jose"`
90
+
91
+ JOSE (Compact Serialization) - application/jose
92
+
93
+ ### JoseJson {#josejson}
94
+
95
+ > `readonly` **JoseJson**: `"application/jose+json"` = `"application/jose+json"`
96
+
97
+ JOSE (JSON Serialization) - application/jose+json
98
+
99
+ ### JwkJson {#jwkjson}
100
+
101
+ > `readonly` **JwkJson**: `"application/jwk+json"` = `"application/jwk+json"`
102
+
103
+ JSON Web Key (JWK) - application/jwk+json
104
+
105
+ ### JwkSetJson {#jwksetjson}
106
+
107
+ > `readonly` **JwkSetJson**: `"application/jwk-set+json"` = `"application/jwk-set+json"`
108
+
109
+ JSON Web Key Set (JWKS) - application/jwk-set+json
110
+
111
+ ### DidJson {#didjson}
112
+
113
+ > `readonly` **DidJson**: `"application/did+json"` = `"application/did+json"`
114
+
115
+ Decentralized Identifier (DID) - application/did+json
116
+
117
+ ### DidLdJson {#didldjson}
118
+
119
+ > `readonly` **DidLdJson**: `"application/did+ld+json"` = `"application/did+ld+json"`
120
+
121
+ Decentralized Identifier (DID) (JSON-LD) - application/did+ld+json
122
+
123
+ ### VerifiableCredentialLdJson {#verifiablecredentialldjson}
124
+
125
+ > `readonly` **VerifiableCredentialLdJson**: `"application/vc+ld+json"` = `"application/vc+ld+json"`
126
+
127
+ Verifiable Credential (JSON-LD) - application/vc+ld+json
128
+
129
+ ### VerifiablePresentationLdJson {#verifiablepresentationldjson}
130
+
131
+ > `readonly` **VerifiablePresentationLdJson**: `"application/vp+ld+json"` = `"application/vp+ld+json"`
132
+
133
+ Verifiable Presentation (JSON-LD) - application/vp+ld+json
134
+
135
+ ### VerifiableCredentialJwt {#verifiablecredentialjwt}
136
+
137
+ > `readonly` **VerifiableCredentialJwt**: `"application/vc+jwt"` = `"application/vc+jwt"`
138
+
139
+ Verifiable Credential (JWT) - application/vc+jwt
140
+
141
+ ### VerifiablePresentationJwt {#verifiablepresentationjwt}
142
+
143
+ > `readonly` **VerifiablePresentationJwt**: `"application/vp+jwt"` = `"application/vp+jwt"`
144
+
145
+ Verifiable Presentation (JWT) - application/vp+jwt
146
+
147
+ ### JsonPatch {#jsonpatch}
148
+
149
+ > `readonly` **JsonPatch**: `"application/json-patch+json"` = `"application/json-patch+json"`
150
+
151
+ JSON Patch - application/json-patch+json
152
+
153
+ ### MergePatch {#mergepatch}
154
+
155
+ > `readonly` **MergePatch**: `"application/merge-patch+json"` = `"application/merge-patch+json"`
156
+
157
+ JSON Merge Patch - application/merge-patch+json
158
+
159
+ ### Cwt {#cwt}
160
+
161
+ > `readonly` **Cwt**: `"application/cwt"` = `"application/cwt"`
162
+
163
+ CBOR Web Token (CWT) - application/cwt
164
+
165
+ ### Cose {#cose}
166
+
167
+ > `readonly` **Cose**: `"application/cose"` = `"application/cose"`
168
+
169
+ COSE - application/cose
170
+
171
+ ### CoseKey {#cosekey}
172
+
173
+ > `readonly` **CoseKey**: `"application/cose-key"` = `"application/cose-key"`
174
+
175
+ COSE Key - application/cose-key
176
+
177
+ ### CoseKeySet {#cosekeyset}
178
+
179
+ > `readonly` **CoseKeySet**: `"application/cose-key-set"` = `"application/cose-key-set"`
180
+
181
+ COSE Key Set - application/cose-key-set
182
+
183
+ ### FormUrlEncoded {#formurlencoded}
184
+
185
+ > `readonly` **FormUrlEncoded**: `"application/x-www-form-urlencoded"` = `"application/x-www-form-urlencoded"`
186
+
187
+ Form URL Encoded - application/x-www-form-urlencoded
188
+
189
+ ### MultipartFormData {#multipartformdata}
190
+
191
+ > `readonly` **MultipartFormData**: `"multipart/form-data"` = `"multipart/form-data"`
192
+
193
+ Multipart Form Data - multipart/form-data
194
+
195
+ ### Xml {#xml}
46
196
 
47
197
  > `readonly` **Xml**: `"application/xml"` = `"application/xml"`
48
198
 
49
199
  XML - application/xml
50
200
 
51
- ### OctetStream
201
+ ### Wasm {#wasm}
202
+
203
+ > `readonly` **Wasm**: `"application/wasm"` = `"application/wasm"`
204
+
205
+ WASM - application/wasm
206
+
207
+ ### WebManifest {#webmanifest}
208
+
209
+ > `readonly` **WebManifest**: `"application/manifest+json"` = `"application/manifest+json"`
210
+
211
+ Web App Manifest - application/manifest+json
212
+
213
+ ### OctetStream {#octetstream}
52
214
 
53
215
  > `readonly` **OctetStream**: `"application/octet-stream"` = `"application/octet-stream"`
54
216
 
55
217
  Application Octet Stream, arbitrary binary - application/octet-stream
56
218
 
57
- ### Gzip
219
+ ### Gzip {#gzip}
58
220
 
59
221
  > `readonly` **Gzip**: `"application/gzip"` = `"application/gzip"`
60
222
 
61
223
  Application GZIP - application/gzip
62
224
 
63
- ### Zlib
225
+ ### Zlib {#zlib}
64
226
 
65
227
  > `readonly` **Zlib**: `"application/zlib"` = `"application/zlib"`
66
228
 
67
229
  Application deflate - application/zlib
68
230
 
69
- ### Bzip2
231
+ ### Bzip2 {#bzip2}
70
232
 
71
233
  > `readonly` **Bzip2**: `"application/x-bzip2"` = `"application/x-bzip2"`
72
234
 
73
235
  Application BZIP2 - application/x-bzip2
74
236
 
75
- ### Zip
237
+ ### Zip {#zip}
76
238
 
77
239
  > `readonly` **Zip**: `"application/zip"` = `"application/zip"`
78
240
 
79
241
  Application ZIP - application/zip
80
242
 
81
- ### Pdf
243
+ ### Pdf {#pdf}
82
244
 
83
245
  > `readonly` **Pdf**: `"application/pdf"` = `"application/pdf"`
84
246
 
85
247
  Application PDF - application/pdf
86
248
 
87
- ### Gif
249
+ ### Gif {#gif}
88
250
 
89
251
  > `readonly` **Gif**: `"image/gif"` = `"image/gif"`
90
252
 
91
253
  Image GIF - image/gif
92
254
 
93
- ### Bmp
255
+ ### Bmp {#bmp}
94
256
 
95
257
  > `readonly` **Bmp**: `"image/bmp"` = `"image/bmp"`
96
258
 
97
259
  Image BMP - image/bmp
98
260
 
99
- ### Jpeg
261
+ ### Jpeg {#jpeg}
100
262
 
101
263
  > `readonly` **Jpeg**: `"image/jpeg"` = `"image/jpeg"`
102
264
 
103
265
  Image JPEG - image/jpeg
104
266
 
105
- ### Png
267
+ ### Png {#png}
106
268
 
107
269
  > `readonly` **Png**: `"image/png"` = `"image/png"`
108
270
 
109
271
  Image PNG - image/png
110
272
 
111
- ### Tiff
273
+ ### Tiff {#tiff}
112
274
 
113
275
  > `readonly` **Tiff**: `"image/tiff"` = `"image/tiff"`
114
276
 
115
277
  Image Tiff - image/tiff
116
278
 
117
- ### Svg
279
+ ### Svg {#svg}
118
280
 
119
281
  > `readonly` **Svg**: `"image/svg+xml"` = `"image/svg+xml"`
120
282
 
121
283
  Image SVG - image/svg+xml
122
284
 
123
- ### WebP
285
+ ### Ico {#ico}
286
+
287
+ > `readonly` **Ico**: `"image/x-icon"` = `"image/x-icon"`
288
+
289
+ Image ICO - image/x-icon
290
+
291
+ ### WebP {#webp}
124
292
 
125
293
  > `readonly` **WebP**: `"image/webp"` = `"image/webp"`
126
294
 
127
295
  Image WEBP - image/webp
128
296
 
129
- ### Mp4
297
+ ### Avif {#avif}
298
+
299
+ > `readonly` **Avif**: `"image/avif"` = `"image/avif"`
300
+
301
+ Image AVIF - image/avif
302
+
303
+ ### Apng {#apng}
304
+
305
+ > `readonly` **Apng**: `"image/apng"` = `"image/apng"`
306
+
307
+ Image APNG - image/apng
308
+
309
+ ### Woff {#woff}
310
+
311
+ > `readonly` **Woff**: `"font/woff"` = `"font/woff"`
312
+
313
+ Font WOFF - font/woff
314
+
315
+ ### Woff2 {#woff2}
316
+
317
+ > `readonly` **Woff2**: `"font/woff2"` = `"font/woff2"`
318
+
319
+ Font WOFF2 - font/woff2
320
+
321
+ ### Ttf {#ttf}
322
+
323
+ > `readonly` **Ttf**: `"font/ttf"` = `"font/ttf"`
324
+
325
+ Font TTF - font/ttf
326
+
327
+ ### Otf {#otf}
328
+
329
+ > `readonly` **Otf**: `"font/otf"` = `"font/otf"`
330
+
331
+ Font OTF - font/otf
332
+
333
+ ### Mp3 {#mp3}
334
+
335
+ > `readonly` **Mp3**: `"audio/mpeg"` = `"audio/mpeg"`
336
+
337
+ Audio MP3 - audio/mpeg
338
+
339
+ ### OggAudio {#oggaudio}
340
+
341
+ > `readonly` **OggAudio**: `"audio/ogg"` = `"audio/ogg"`
342
+
343
+ Audio OGG - audio/ogg
344
+
345
+ ### Wav {#wav}
346
+
347
+ > `readonly` **Wav**: `"audio/wav"` = `"audio/wav"`
348
+
349
+ Audio WAV - audio/wav
350
+
351
+ ### WebmAudio {#webmaudio}
352
+
353
+ > `readonly` **WebmAudio**: `"audio/webm"` = `"audio/webm"`
354
+
355
+ Audio WEBM - audio/webm
356
+
357
+ ### Aac {#aac}
358
+
359
+ > `readonly` **Aac**: `"audio/aac"` = `"audio/aac"`
360
+
361
+ Audio AAC - audio/aac
362
+
363
+ ### Mp4Audio {#mp4audio}
364
+
365
+ > `readonly` **Mp4Audio**: `"audio/mp4"` = `"audio/mp4"`
366
+
367
+ Audio MP4 - audio/mp4
368
+
369
+ ### Mp4 {#mp4}
130
370
 
131
371
  > `readonly` **Mp4**: `"video/mp4"` = `"video/mp4"`
132
372
 
133
373
  Video MP4 - video/mp4
134
374
 
135
- ### Mpeg
375
+ ### Mpeg {#mpeg}
136
376
 
137
377
  > `readonly` **Mpeg**: `"video/mpeg"` = `"video/mpeg"`
138
378
 
139
379
  Audio/Video MPEG - video/mpeg
140
380
 
141
- ### Webm
381
+ ### Webm {#webm}
142
382
 
143
383
  > `readonly` **Webm**: `"video/webm"` = `"video/webm"`
144
384
 
145
385
  Video WEBM - video/webm
386
+
387
+ ### OggVideo {#oggvideo}
388
+
389
+ > `readonly` **OggVideo**: `"video/ogg"` = `"video/ogg"`
390
+
391
+ Video OGG - video/ogg
392
+
393
+ ### Quicktime {#quicktime}
394
+
395
+ > `readonly` **Quicktime**: `"video/quicktime"` = `"video/quicktime"`
396
+
397
+ Video QuickTime - video/quicktime
398
+
399
+ ## See
400
+
401
+ https://www.iana.org/assignments/media-types/media-types.xhtml
package/locales/en.json CHANGED
@@ -21,6 +21,10 @@
21
21
  "jws": {
22
22
  "createFailed": "Failed to create JWS",
23
23
  "verifyFailed": "Failed to verify JWS"
24
+ },
25
+ "headerHelper": {
26
+ "invalidLinkHeaderURL": "URL for Link header cannot contain \">\" character.",
27
+ "invalidLinkHeaderRel": "Relation type for Link header cannot contain \" character."
24
28
  }
25
29
  },
26
30
  "errorMessages": {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@twin.org/web",
3
- "version": "0.0.3-next.3",
4
- "description": "Contains classes for use with web operations",
3
+ "version": "0.0.3-next.30",
4
+ "description": "Classes for use with web operations",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "git+https://github.com/twinfoundation/framework.git",
@@ -14,10 +14,10 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.3-next.3",
18
- "@twin.org/crypto": "0.0.3-next.3",
19
- "@twin.org/nameof": "0.0.3-next.3",
20
- "jose": "6.1.1"
17
+ "@twin.org/core": "0.0.3-next.30",
18
+ "@twin.org/crypto": "0.0.3-next.30",
19
+ "@twin.org/nameof": "0.0.3-next.30",
20
+ "jose": "6.2.2"
21
21
  },
22
22
  "main": "./dist/es/index.js",
23
23
  "types": "./dist/types/index.d.ts",