@twin.org/web 0.0.1-next.3 → 0.0.1-next.31

package/docs/reference/classes/Jwt.md

@@ -28,15 +28,21 @@ Encode a token.
 
 #### Parameters
 
-• **header**: `U`
+##### header
+
+`U`
 
 The header to encode.
 
-• **payload**: `T`
+##### payload
+
+`T`
 
 The payload to encode.
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for signing the token, can be omitted if a signer is provided.
 
@@ -62,15 +68,21 @@ Encode a token.
 
 #### Parameters
 
-• **header**: `U`
+##### header
+
+`U`
 
 The header to encode.
 
-• **payload**: `T`
+##### payload
+
+`T`
 
 The payload to encode.
 
-• **signer**
+##### signer
+
+(`alg`, `key`, `payload`) => `Promise`\<`Uint8Array`\>
 
 Custom signer method.
 
@@ -84,7 +96,7 @@ The encoded token.
 
 ### decode()
 
-> `static` **decode**\<`U`, `T`\>(`token`): `Promise`\<`object`\>
+> `static` **decode**\<`U`, `T`\>(`token`): `Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 Decode a token.
 
@@ -96,33 +108,23 @@ Decode a token.
 
 #### Parameters
 
-• **token**: `string`
+##### token
+
+`string`
 
 The token to decode.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 The decoded payload.
 
-##### header?
-
-> `optional` **header**: `U`
-
-##### payload?
-
-> `optional` **payload**: `T`
-
-##### signature?
-
-> `optional` **signature**: `Uint8Array`
-
 ***
 
 ### verify()
 
-> `static` **verify**\<`U`, `T`\>(`token`, `key`): `Promise`\<`object`\>
+> `static` **verify**\<`U`, `T`\>(`token`, `key`): `Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 Verify a token.
 
@@ -134,41 +136,29 @@ Verify a token.
 
 #### Parameters
 
-• **token**: `string`
+##### token
+
+`string`
 
 The token to verify.
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for verifying the token
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 The decoded payload.
 
-##### verified
-
-> **verified**: `boolean`
-
-##### header?
-
-> `optional` **header**: `U`
-
-##### payload?
-
-> `optional` **payload**: `T`
-
-##### signature?
-
-> `optional` **signature**: `Uint8Array`
-
 ***
 
 ### verifyWithVerifier()
 
-> `static` **verifyWithVerifier**\<`U`, `T`\>(`token`, `verifier`): `Promise`\<`object`\>
+> `static` **verifyWithVerifier**\<`U`, `T`\>(`token`, `verifier`): `Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 Verify a token.
 
@@ -180,36 +170,24 @@ Verify a token.
 
 #### Parameters
 
-• **token**: `string`
+##### token
+
+`string`
 
 The token to verify.
 
-• **verifier**
+##### verifier
+
+(`alg`, `key`, `payload`, `signature`) => `Promise`\<`boolean`\>
 
 Custom verification method.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `verified`: `boolean`; `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
 
 The decoded payload.
 
-##### verified
-
-> **verified**: `boolean`
-
-##### header?
-
-> `optional` **header**: `U`
-
-##### payload?
-
-> `optional` **payload**: `T`
-
-##### signature?
-
-> `optional` **signature**: `Uint8Array`
-
 ***
 
 ### verifySignature()
@@ -226,23 +204,33 @@ Verify a token by parts.
 
 #### Parameters
 
-• **header?**: `U`
+##### header?
+
+`U`
 
 The header to verify.
 
-• **payload?**: `T`
+##### payload?
+
+`T`
 
 The payload to verify.
 
-• **signature?**: `Uint8Array`
+##### signature?
+
+`Uint8Array`
 
 The signature to verify.
 
-• **key?**: `Uint8Array`
+##### key?
+
+`Uint8Array`
 
 The key for verifying the token, if not provided no verification occurs.
 
-• **verifier?**
+##### verifier?
+
+(`alg`, `key`, `payload`, `signature`) => `Promise`\<`boolean`\>
 
 Custom verification method.
 
@@ -262,15 +250,21 @@ The default signer for the JWT.
 
 #### Parameters
 
-• **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+##### alg
+
+[`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
 
 The algorithm to use.
 
-• **key**: `undefined` \| `Uint8Array`
+##### key
 
 The key to sign with.
 
-• **payload**: `Uint8Array`
+`undefined` | `Uint8Array`
+
+##### payload
+
+`Uint8Array`
 
 The payload to sign.
 
@@ -290,19 +284,27 @@ The default verifier for the JWT.
 
 #### Parameters
 
-• **alg**: [`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
+##### alg
+
+[`JwtAlgorithms`](../type-aliases/JwtAlgorithms.md)
 
 The algorithm to use.
 
-• **key**: `undefined` \| `Uint8Array`
+##### key
 
 The key to verify with.
 
-• **payload**: `Uint8Array`
+`undefined` | `Uint8Array`
+
+##### payload
+
+`Uint8Array`
 
 The payload to verify.
 
-• **signature**: `Uint8Array`
+##### signature
+
+`Uint8Array`
 
 The signature to verify.
 

package/docs/reference/classes/MimeTypeHelper.md

@@ -22,7 +22,9 @@ Detect the mime type from a byte array.
 
 #### Parameters
 
-• **data**: `Uint8Array`
+##### data
+
+`Uint8Array`
 
 The data to test.
 
@@ -42,10 +44,12 @@ Return the default extension for a mime type.
 
 #### Parameters
 
-• **mimeType**: `undefined` \| `string`
+##### mimeType
 
 The mimetype to get the extension for.
 
+`undefined` | `string`
+
 #### Returns
 
 `undefined` \| `string`

package/docs/reference/interfaces/IHttpHeaders.md

@@ -4,4 +4,4 @@ Model used for Http headers parameter.
 
 ## Indexable
 
- \[`key`: `string`\]: `string` \| `string`[]
+\[`key`: `string`\]: `string` \| `string`[]

package/docs/reference/interfaces/IJwk.md

@@ -4,7 +4,7 @@ The fields in a JSON Web Key.
 
 ## Indexable
 
- \[`key`: `string`\]: `unknown`
+\[`key`: `string`\]: `unknown`
 
 ## Properties
 

package/docs/reference/interfaces/IJwtHeader.md

@@ -4,7 +4,7 @@ The fields in a JSON Web Token header.
 
 ## Indexable
 
- \[`key`: `string`\]: `unknown`
+\[`key`: `string`\]: `unknown`
 
 ## Properties
 

package/docs/reference/interfaces/IJwtPayload.md

@@ -4,7 +4,7 @@ The fields in a JSON Web Token payload.
 
 ## Indexable
 
- \[`key`: `string`\]: `unknown`
+\[`key`: `string`\]: `unknown`
 
 ## Properties
 

package/docs/reference/variables/HeaderTypes.md

@@ -8,48 +8,48 @@ Common http header types.
 
 ### ContentType
 
-> `readonly` **ContentType**: `"Content-Type"` = `"Content-Type"`
+> `readonly` **ContentType**: `"content-type"` = `"content-type"`
 
 Content Type.
 
 ### ContentLength
 
-> `readonly` **ContentLength**: `"Content-Length"` = `"Content-Length"`
+> `readonly` **ContentLength**: `"content-length"` = `"content-length"`
 
 Content Length.
 
 ### ContentDisposition
 
-> `readonly` **ContentDisposition**: `"Content-Disposition"` = `"Content-Disposition"`
+> `readonly` **ContentDisposition**: `"content-disposition"` = `"content-disposition"`
 
 Content Disposition.
 
 ### Accept
 
-> `readonly` **Accept**: `"Accept"` = `"Accept"`
+> `readonly` **Accept**: `"accept"` = `"accept"`
 
 Accept.
 
 ### Authorization
 
-> `readonly` **Authorization**: `"Authorization"` = `"Authorization"`
+> `readonly` **Authorization**: `"authorization"` = `"authorization"`
 
 Authorization.
 
 ### Cookie
 
-> `readonly` **Cookie**: `"Cookie"` = `"Cookie"`
+> `readonly` **Cookie**: `"cookie"` = `"cookie"`
 
 Cookie.
 
 ### SetCookie
 
-> `readonly` **SetCookie**: `"Set-Cookie"` = `"Set-Cookie"`
+> `readonly` **SetCookie**: `"set-cookie"` = `"set-cookie"`
 
 Set Cookie.
 
 ### Location
 
-> `readonly` **Location**: `"Location"` = `"Location"`
+> `readonly` **Location**: `"location"` = `"location"`
 
 Location

package/docs/reference/variables/MimeTypes.md

@@ -36,6 +36,12 @@ JSON - application/json
 
 JSON-LD - application/ld+json
 
+### Jwt
+
+> `readonly` **Jwt**: `"application/jwt"` = `"application/jwt"`
+
+JWT - application/jwt
+
 ### Xml
 
 > `readonly` **Xml**: `"application/xml"` = `"application/xml"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/web",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.31",
 	"description": "Contains classes for use with web operations",
 	"repository": {
 		"type": "git",
@@ -13,46 +13,19 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage",
-		"build": "tspc",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
-		"@twin.org/core": "0.0.1-next.3",
-		"@twin.org/crypto": "0.0.1-next.3",
+		"@twin.org/core": "0.0.1-next.31",
+		"@twin.org/crypto": "0.0.1-next.31",
 		"@twin.org/nameof": "next"
 	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@types/node": "22.5.5",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.21.3",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		}
 	},
 	"files": [