@twin.org/web 0.0.2-next.9 → 0.0.3-next.1

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 (66) hide show
  1. package/dist/es/errors/fetchError.js +27 -0
  2. package/dist/es/errors/fetchError.js.map +1 -0
  3. package/dist/es/index.js +20 -0
  4. package/dist/es/index.js.map +1 -0
  5. package/dist/es/models/IFetchOptions.js +2 -0
  6. package/dist/es/models/IFetchOptions.js.map +1 -0
  7. package/dist/es/models/IHttpHeaders.js +4 -0
  8. package/dist/es/models/IHttpHeaders.js.map +1 -0
  9. package/dist/es/models/IJwk.js +2 -0
  10. package/dist/es/models/IJwk.js.map +1 -0
  11. package/dist/es/models/IJwtHeader.js +2 -0
  12. package/dist/es/models/IJwtHeader.js.map +1 -0
  13. package/dist/es/models/IJwtPayload.js +2 -0
  14. package/dist/es/models/IJwtPayload.js.map +1 -0
  15. package/dist/es/models/headerTypes.js +41 -0
  16. package/dist/es/models/headerTypes.js.map +1 -0
  17. package/dist/es/models/httpMethod.js +18 -0
  18. package/dist/es/models/httpMethod.js.map +1 -0
  19. package/dist/es/models/httpStatusCode.js +257 -0
  20. package/dist/es/models/httpStatusCode.js.map +1 -0
  21. package/dist/es/models/jwkCryptoKey.js +4 -0
  22. package/dist/es/models/jwkCryptoKey.js.map +1 -0
  23. package/dist/es/models/mimeTypes.js +101 -0
  24. package/dist/es/models/mimeTypes.js.map +1 -0
  25. package/dist/es/utils/fetchHelper.js +271 -0
  26. package/dist/es/utils/fetchHelper.js.map +1 -0
  27. package/dist/es/utils/headerHelper.js +34 -0
  28. package/dist/es/utils/headerHelper.js.map +1 -0
  29. package/dist/es/utils/jwk.js +99 -0
  30. package/dist/es/utils/jwk.js.map +1 -0
  31. package/dist/es/utils/jws.js +58 -0
  32. package/dist/es/utils/jws.js.map +1 -0
  33. package/dist/es/utils/jwt.js +243 -0
  34. package/dist/es/utils/jwt.js.map +1 -0
  35. package/dist/es/utils/mimeTypeHelper.js +144 -0
  36. package/dist/es/utils/mimeTypeHelper.js.map +1 -0
  37. package/dist/types/errors/fetchError.d.ts +1 -1
  38. package/dist/types/index.d.ts +17 -16
  39. package/dist/types/models/IFetchOptions.d.ts +1 -1
  40. package/dist/types/models/IJwk.d.ts +1 -2
  41. package/dist/types/models/IJwtHeader.d.ts +1 -2
  42. package/dist/types/models/IJwtPayload.d.ts +1 -2
  43. package/dist/types/utils/fetchHelper.d.ts +6 -2
  44. package/dist/types/utils/headerHelper.d.ts +17 -0
  45. package/dist/types/utils/jwk.d.ts +10 -4
  46. package/dist/types/utils/jws.d.ts +5 -1
  47. package/dist/types/utils/jwt.d.ts +7 -3
  48. package/docs/changelog.md +292 -0
  49. package/docs/reference/classes/FetchHelper.md +10 -2
  50. package/docs/reference/classes/HeaderHelper.md +57 -0
  51. package/docs/reference/classes/Jwk.md +27 -7
  52. package/docs/reference/classes/Jws.md +8 -0
  53. package/docs/reference/classes/Jwt.md +30 -22
  54. package/docs/reference/classes/MimeTypeHelper.md +5 -5
  55. package/docs/reference/index.md +4 -3
  56. package/docs/reference/type-aliases/IJwk.md +5 -0
  57. package/docs/reference/type-aliases/IJwtHeader.md +5 -0
  58. package/docs/reference/type-aliases/IJwtPayload.md +5 -0
  59. package/locales/.validate-ignore +1 -0
  60. package/locales/en.json +3 -2
  61. package/package.json +25 -12
  62. package/dist/cjs/index.cjs +0 -1269
  63. package/dist/esm/index.mjs +0 -1258
  64. package/docs/reference/interfaces/IJwk.md +0 -7
  65. package/docs/reference/interfaces/IJwtHeader.md +0 -13
  66. package/docs/reference/interfaces/IJwtPayload.md +0 -13
@@ -16,7 +16,7 @@ Class to help with mime types.
16
16
 
17
17
  ### detect()
18
18
 
19
- > `static` **detect**(`data`): `Promise`\<`undefined` \| `string`\>
19
+ > `static` **detect**(`data`): `Promise`\<`string` \| `undefined`\>
20
20
 
21
21
  Detect the mime type from a byte array.
22
22
 
@@ -30,7 +30,7 @@ The data to test.
30
30
 
31
31
  #### Returns
32
32
 
33
- `Promise`\<`undefined` \| `string`\>
33
+ `Promise`\<`string` \| `undefined`\>
34
34
 
35
35
  The mime type if detected.
36
36
 
@@ -38,7 +38,7 @@ The mime type if detected.
38
38
 
39
39
  ### defaultExtension()
40
40
 
41
- > `static` **defaultExtension**(`mimeType`): `undefined` \| `string`
41
+ > `static` **defaultExtension**(`mimeType`): `string` \| `undefined`
42
42
 
43
43
  Return the default extension for a mime type.
44
44
 
@@ -48,10 +48,10 @@ Return the default extension for a mime type.
48
48
 
49
49
  The mimetype to get the extension for.
50
50
 
51
- `undefined` | `string`
51
+ `string` | `undefined`
52
52
 
53
53
  #### Returns
54
54
 
55
- `undefined` \| `string`
55
+ `string` \| `undefined`
56
56
 
57
57
  The extension for the mime type.
@@ -4,6 +4,7 @@
4
4
 
5
5
  - [FetchError](classes/FetchError.md)
6
6
  - [FetchHelper](classes/FetchHelper.md)
7
+ - [HeaderHelper](classes/HeaderHelper.md)
7
8
  - [Jwk](classes/Jwk.md)
8
9
  - [Jws](classes/Jws.md)
9
10
  - [Jwt](classes/Jwt.md)
@@ -13,12 +14,12 @@
13
14
 
14
15
  - [IFetchOptions](interfaces/IFetchOptions.md)
15
16
  - [IHttpHeaders](interfaces/IHttpHeaders.md)
16
- - [IJwk](interfaces/IJwk.md)
17
- - [IJwtHeader](interfaces/IJwtHeader.md)
18
- - [IJwtPayload](interfaces/IJwtPayload.md)
19
17
 
20
18
  ## Type Aliases
21
19
 
20
+ - [IJwk](type-aliases/IJwk.md)
21
+ - [IJwtHeader](type-aliases/IJwtHeader.md)
22
+ - [IJwtPayload](type-aliases/IJwtPayload.md)
22
23
  - [HeaderTypes](type-aliases/HeaderTypes.md)
23
24
  - [HttpMethod](type-aliases/HttpMethod.md)
24
25
  - [HttpStatusCode](type-aliases/HttpStatusCode.md)
@@ -0,0 +1,5 @@
1
+ # Type Alias: IJwk
2
+
3
+ > **IJwk** = `JWK`
4
+
5
+ The fields in a JSON Web Key.
@@ -0,0 +1,5 @@
1
+ # Type Alias: IJwtHeader
2
+
3
+ > **IJwtHeader** = `JWTHeaderParameters`
4
+
5
+ The fields in a JSON Web Token header.
@@ -0,0 +1,5 @@
1
+ # Type Alias: IJwtPayload
2
+
3
+ > **IJwtPayload** = `JWTPayload`
4
+
5
+ The fields in a JSON Web Token payload.
@@ -0,0 +1 @@
1
+ ^errorMessages.fetch.*$
package/locales/en.json CHANGED
@@ -1,11 +1,12 @@
1
1
  {
2
2
  "error": {
3
3
  "fetchHelper": {
4
- "decodingJSON": "Decoding JSON failed for route \"{route}\"",
4
+ "decodingJSON": "Decoding JSON failed for route \"{url}\"",
5
5
  "failureStatusText": "The request to the API failed: \"{statusText}\"",
6
6
  "connectivity": "The request failed, the API could be offline, or there are other connectivity issues",
7
7
  "timeout": "The request timed out",
8
- "general": "A general failure occurred during the request"
8
+ "general": "A general failure occurred during the request",
9
+ "retryLimitExceeded": "The retry limit was exceeded for route \"{url}\""
9
10
  },
10
11
  "jwt": {
11
12
  "noKeyOrSigner": "No key or signer was provided for JWT creation",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/web",
3
- "version": "0.0.2-next.9",
3
+ "version": "0.0.3-next.1",
4
4
  "description": "Contains classes for use with web operations",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,26 +14,39 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.2-next.9",
18
- "@twin.org/crypto": "0.0.2-next.9",
19
- "@twin.org/nameof": "0.0.2-next.9",
20
- "jose": "6.1.0"
17
+ "@twin.org/core": "0.0.3-next.1",
18
+ "@twin.org/crypto": "0.0.3-next.1",
19
+ "@twin.org/nameof": "0.0.3-next.1",
20
+ "jose": "6.1.1"
21
21
  },
22
- "main": "./dist/cjs/index.cjs",
23
- "module": "./dist/esm/index.mjs",
22
+ "main": "./dist/es/index.js",
24
23
  "types": "./dist/types/index.d.ts",
25
24
  "exports": {
26
25
  ".": {
27
26
  "types": "./dist/types/index.d.ts",
28
- "require": "./dist/cjs/index.cjs",
29
- "import": "./dist/esm/index.mjs"
27
+ "import": "./dist/es/index.js",
28
+ "default": "./dist/es/index.js"
30
29
  }
31
30
  },
32
31
  "files": [
33
- "dist/cjs",
34
- "dist/esm",
32
+ "dist/es",
35
33
  "dist/types",
36
34
  "locales",
37
35
  "docs"
38
- ]
36
+ ],
37
+ "keywords": [
38
+ "twin",
39
+ "trade",
40
+ "iota",
41
+ "framework",
42
+ "blockchain",
43
+ "web",
44
+ "http",
45
+ "rest",
46
+ "api"
47
+ ],
48
+ "bugs": {
49
+ "url": "git+https://github.com/twinfoundation/framework/issues"
50
+ },
51
+ "homepage": "https://twindev.org"
39
52
  }