@twin.org/web 0.0.1-next.1

package/docs/reference/variables/HeaderTypes.md

@@ -0,0 +1,55 @@
+# Variable: HeaderTypes
+
+> `const` **HeaderTypes**: `object`
+
+Common http header types.
+
+## Type declaration
+
+### ContentType
+
+> `readonly` **ContentType**: `"Content-Type"` = `"Content-Type"`
+
+Content Type.
+
+### ContentLength
+
+> `readonly` **ContentLength**: `"Content-Length"` = `"Content-Length"`
+
+Content Length.
+
+### ContentDisposition
+
+> `readonly` **ContentDisposition**: `"Content-Disposition"` = `"Content-Disposition"`
+
+Content Disposition.
+
+### Accept
+
+> `readonly` **Accept**: `"Accept"` = `"Accept"`
+
+Accept.
+
+### Authorization
+
+> `readonly` **Authorization**: `"Authorization"` = `"Authorization"`
+
+Authorization.
+
+### Cookie
+
+> `readonly` **Cookie**: `"Cookie"` = `"Cookie"`
+
+Cookie.
+
+### SetCookie
+
+> `readonly` **SetCookie**: `"Set-Cookie"` = `"Set-Cookie"`
+
+Set Cookie.
+
+### Location
+
+> `readonly` **Location**: `"Location"` = `"Location"`
+
+Location

package/docs/reference/variables/HttpMethod.md

@@ -0,0 +1,43 @@
+# Variable: HttpMethod
+
+> `const` **HttpMethod**: `object`
+
+The names of the HTTP Methods.
+
+## Type declaration
+
+### GET
+
+> `readonly` **GET**: `"GET"` = `"GET"`
+
+### POST
+
+> `readonly` **POST**: `"POST"` = `"POST"`
+
+### PUT
+
+> `readonly` **PUT**: `"PUT"` = `"PUT"`
+
+### PATCH
+
+> `readonly` **PATCH**: `"PATCH"` = `"PATCH"`
+
+### DELETE
+
+> `readonly` **DELETE**: `"DELETE"` = `"DELETE"`
+
+### OPTIONS
+
+> `readonly` **OPTIONS**: `"OPTIONS"` = `"OPTIONS"`
+
+### HEAD
+
+> `readonly` **HEAD**: `"HEAD"` = `"HEAD"`
+
+### CONNECT
+
+> `readonly` **CONNECT**: `"CONNECT"` = `"CONNECT"`
+
+### TRACE
+
+> `readonly` **TRACE**: `"TRACE"` = `"TRACE"`

package/docs/reference/variables/HttpStatusCode.md

@@ -0,0 +1,379 @@
+# Variable: HttpStatusCode
+
+> `const` **HttpStatusCode**: `object`
+
+Standard HTTP status codes.
+
+## Type declaration
+
+### continue
+
+> `readonly` **continue**: `100` = `100`
+
+Continue status code.
+
+### switchingProtocols
+
+> `readonly` **switchingProtocols**: `101` = `101`
+
+Switching Protocols status code.
+
+### processing
+
+> `readonly` **processing**: `102` = `102`
+
+Processing status code.
+
+### earlyHints
+
+> `readonly` **earlyHints**: `103` = `103`
+
+Early Hints status code.
+
+### ok
+
+> `readonly` **ok**: `200` = `200`
+
+OK status code.
+
+### created
+
+> `readonly` **created**: `201` = `201`
+
+Created status code.
+
+### accepted
+
+> `readonly` **accepted**: `202` = `202`
+
+Accepted status code.
+
+### nonAuthoritativeInformation
+
+> `readonly` **nonAuthoritativeInformation**: `203` = `203`
+
+Non-Authoritative Information status code.
+
+### noContent
+
+> `readonly` **noContent**: `204` = `204`
+
+No Content status code.
+
+### resetContent
+
+> `readonly` **resetContent**: `205` = `205`
+
+Reset Content status code.
+
+### partialContent
+
+> `readonly` **partialContent**: `206` = `206`
+
+Partial Content status code.
+
+### multiStatus
+
+> `readonly` **multiStatus**: `207` = `207`
+
+Multi-Status status code.
+
+### alreadyReported
+
+> `readonly` **alreadyReported**: `208` = `208`
+
+Already Reported status code.
+
+### imUsed
+
+> `readonly` **imUsed**: `226` = `226`
+
+IM Used status code.
+
+### multipleChoices
+
+> `readonly` **multipleChoices**: `300` = `300`
+
+Multiple Choices status code.
+
+### movedPermanently
+
+> `readonly` **movedPermanently**: `301` = `301`
+
+Moved Permanently status code.
+
+### found
+
+> `readonly` **found**: `302` = `302`
+
+Found status code.
+
+### seeOther
+
+> `readonly` **seeOther**: `303` = `303`
+
+See Other status code.
+
+### notModified
+
+> `readonly` **notModified**: `304` = `304`
+
+Not Modified status code.
+
+### useProxy
+
+> `readonly` **useProxy**: `305` = `305`
+
+Use Proxy status code.
+
+### temporaryRedirect
+
+> `readonly` **temporaryRedirect**: `307` = `307`
+
+Temporary Redirect status code.
+
+### permanentRedirect
+
+> `readonly` **permanentRedirect**: `308` = `308`
+
+Permanent Redirect status code.
+
+### badRequest
+
+> `readonly` **badRequest**: `400` = `400`
+
+Bad Request status code.
+
+### unauthorized
+
+> `readonly` **unauthorized**: `401` = `401`
+
+Unauthorized status code.
+
+### paymentRequired
+
+> `readonly` **paymentRequired**: `402` = `402`
+
+Payment Required status code.
+
+### forbidden
+
+> `readonly` **forbidden**: `403` = `403`
+
+Forbidden status code.
+
+### notFound
+
+> `readonly` **notFound**: `404` = `404`
+
+Not Found status code.
+
+### methodNotAllowed
+
+> `readonly` **methodNotAllowed**: `405` = `405`
+
+Method Not Allowed status code.
+
+### notAcceptable
+
+> `readonly` **notAcceptable**: `406` = `406`
+
+Not Acceptable status code.
+
+### proxyAuthenticationRequired
+
+> `readonly` **proxyAuthenticationRequired**: `407` = `407`
+
+Proxy Authentication Required status code.
+
+### requestTimeout
+
+> `readonly` **requestTimeout**: `408` = `408`
+
+Request Timeout status code.
+
+### conflict
+
+> `readonly` **conflict**: `409` = `409`
+
+Conflict status code.
+
+### gone
+
+> `readonly` **gone**: `410` = `410`
+
+Gone status code.
+
+### lengthRequired
+
+> `readonly` **lengthRequired**: `411` = `411`
+
+Length Required status code.
+
+### preconditionFailed
+
+> `readonly` **preconditionFailed**: `412` = `412`
+
+Precondition Failed status code.
+
+### payloadTooLarge
+
+> `readonly` **payloadTooLarge**: `413` = `413`
+
+Payload Too Large status code.
+
+### uriTooLong
+
+> `readonly` **uriTooLong**: `414` = `414`
+
+URI Too Long status code.
+
+### unsupportedMediaType
+
+> `readonly` **unsupportedMediaType**: `415` = `415`
+
+Unsupported Media Type status code.
+
+### rangeNotSatisfiable
+
+> `readonly` **rangeNotSatisfiable**: `416` = `416`
+
+Range Not Satisfiable status code.
+
+### expectationFailed
+
+> `readonly` **expectationFailed**: `417` = `417`
+
+Expectation Failed status code.
+
+### imATeapot
+
+> `readonly` **imATeapot**: `418` = `418`
+
+I'm a Teapot status code.
+
+### misdirectedRequest
+
+> `readonly` **misdirectedRequest**: `421` = `421`
+
+Misdirected Request status code.
+
+### unprocessableEntity
+
+> `readonly` **unprocessableEntity**: `422` = `422`
+
+Unprocessable Entity status code.
+
+### locked
+
+> `readonly` **locked**: `423` = `423`
+
+Locked status code.
+
+### failedDependency
+
+> `readonly` **failedDependency**: `424` = `424`
+
+Failed Dependency status code.
+
+### tooEarly
+
+> `readonly` **tooEarly**: `425` = `425`
+
+Too Early status code.
+
+### upgradeRequired
+
+> `readonly` **upgradeRequired**: `426` = `426`
+
+Upgrade Required status code.
+
+### preconditionRequired
+
+> `readonly` **preconditionRequired**: `428` = `428`
+
+Precondition Required status code.
+
+### tooManyRequests
+
+> `readonly` **tooManyRequests**: `429` = `429`
+
+Too Many Requests status code.
+
+### requestHeaderFieldsTooLarge
+
+> `readonly` **requestHeaderFieldsTooLarge**: `431` = `431`
+
+Request Header Fields Too Large status code.
+
+### unavailableForLegalReasons
+
+> `readonly` **unavailableForLegalReasons**: `451` = `451`
+
+Unavailable For Legal Reasons status code.
+
+### internalServerError
+
+> `readonly` **internalServerError**: `500` = `500`
+
+Internal Server Error status code.
+
+### notImplemented
+
+> `readonly` **notImplemented**: `501` = `501`
+
+Not Implemented status code.
+
+### badGateway
+
+> `readonly` **badGateway**: `502` = `502`
+
+Bad Gateway status code.
+
+### serviceUnavailable
+
+> `readonly` **serviceUnavailable**: `503` = `503`
+
+Service Unavailable status code.
+
+### gatewayTimeout
+
+> `readonly` **gatewayTimeout**: `504` = `504`
+
+Gateway Timeout status code.
+
+### httpVersionNotSupported
+
+> `readonly` **httpVersionNotSupported**: `505` = `505`
+
+HTTP Version Not Supported status code.
+
+### variantAlsoNegotiates
+
+> `readonly` **variantAlsoNegotiates**: `506` = `506`
+
+Variant Also Negotiates status code.
+
+### insufficientStorage
+
+> `readonly` **insufficientStorage**: `507` = `507`
+
+Insufficient Storage status code.
+
+### loopDetected
+
+> `readonly` **loopDetected**: `508` = `508`
+
+Loop Detected status code.
+
+### notExtended
+
+> `readonly` **notExtended**: `510` = `510`
+
+Not Extended status code.
+
+### networkAuthenticationRequired
+
+> `readonly` **networkAuthenticationRequired**: `511` = `511`
+
+Network Authentication Required status code.

package/docs/reference/variables/JwtAlgorithms.md

@@ -0,0 +1,19 @@
+# Variable: JwtAlgorithms
+
+> `const` **JwtAlgorithms**: `object`
+
+The cryptographic algorithms supported for JSON Web Tokens and JSON Web Keys.
+
+## Type declaration
+
+### HS256
+
+> `readonly` **HS256**: `"HS256"` = `"HS256"`
+
+HMAC using SHA-256.
+
+### EdDSA
+
+> `readonly` **EdDSA**: `"EdDSA"` = `"EdDSA"`
+
+EdDSA using Ed25519.

package/docs/reference/variables/MimeTypes.md

@@ -0,0 +1,133 @@
+# Variable: MimeTypes
+
+> `const` **MimeTypes**: `object`
+
+Common mime types.
+
+## Type declaration
+
+### PlainText
+
+> `readonly` **PlainText**: `"text/plain"` = `"text/plain"`
+
+Plaint Text - text/plain
+
+### Html
+
+> `readonly` **Html**: `"text/html"` = `"text/html"`
+
+HTML - text/html
+
+### Javascript
+
+> `readonly` **Javascript**: `"text/javascript"` = `"text/javascript"`
+
+Javascript - text/javascript
+
+### Json
+
+> `readonly` **Json**: `"application/json"` = `"application/json"`
+
+JSON - application/json
+
+### JsonLd
+
+> `readonly` **JsonLd**: `"application/ld+json"` = `"application/ld+json"`
+
+JSON-LD - application/ld+json
+
+### Xml
+
+> `readonly` **Xml**: `"application/xml"` = `"application/xml"`
+
+XML - application/xml
+
+### OctetStream
+
+> `readonly` **OctetStream**: `"application/octet-stream"` = `"application/octet-stream"`
+
+Application Octet Stream, arbitrary binary - application/octet-stream
+
+### Gzip
+
+> `readonly` **Gzip**: `"application/gzip"` = `"application/gzip"`
+
+Application GZIP - application/gzip
+
+### Bzip2
+
+> `readonly` **Bzip2**: `"application/x-bzip2"` = `"application/x-bzip2"`
+
+Application BZIP2 - application/x-bzip2
+
+### Zip
+
+> `readonly` **Zip**: `"application/zip"` = `"application/zip"`
+
+Application ZIP - application/zip
+
+### Pdf
+
+> `readonly` **Pdf**: `"application/pdf"` = `"application/pdf"`
+
+Application PDF - application/pdf
+
+### Gif
+
+> `readonly` **Gif**: `"image/gif"` = `"image/gif"`
+
+Image GIF - image/gif
+
+### Bmp
+
+> `readonly` **Bmp**: `"image/bmp"` = `"image/bmp"`
+
+Image BMP - image/bmp
+
+### Jpeg
+
+> `readonly` **Jpeg**: `"image/jpeg"` = `"image/jpeg"`
+
+Image JPEG - image/jpeg
+
+### Png
+
+> `readonly` **Png**: `"image/png"` = `"image/png"`
+
+Image PNG - image/png
+
+### Tiff
+
+> `readonly` **Tiff**: `"image/tiff"` = `"image/tiff"`
+
+Image Tiff - image/tiff
+
+### Svg
+
+> `readonly` **Svg**: `"image/svg+xml"` = `"image/svg+xml"`
+
+Image SVG - image/svg+xml
+
+### WebP
+
+> `readonly` **WebP**: `"image/webp"` = `"image/webp"`
+
+Image WEBP - image/webp
+
+### Mp4
+
+> `readonly` **Mp4**: `"video/mp4"` = `"video/mp4"`
+
+Video MP4 - video/mp4
+
+### Mpeg
+
+> `readonly` **Mpeg**: `"video/mpeg"` = `"video/mpeg"`
+
+Audio/Video MPEG - video/mpeg
+
+### Webm
+
+> `readonly` **Webm**: `"video/webm"` = `"video/webm"`
+
+Video WEBM - video/webm

package/locales/en.json

@@ -0,0 +1,18 @@
+{
+	"error": {
+		"fetchHelper": {
+			"decodingJSON": "Decoding JSON failed for route \"{route}\"",
+			"failureStatusText": "The request to the API failed: \"{statusText}\"",
+			"connectivity": "The request failed, the API could be offline, or there are other connectivity issues",
+			"timeout": "The request timed out",
+			"general": "A general failure occurred during the request"
+		},
+		"jwt": {
+			"noKeyOrSigner": "No key or signer was provided for JWT creation",
+			"noKeyOrVerifier": "No key or verifier was provided for JWT creation"
+		}
+	},
+	"errorMessages": {
+		"fetch": "Fetch"
+	}
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+	"name": "@twin.org/web",
+	"version": "0.0.1-next.1",
+	"description": "Contains classes for use with web operations",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/framework.git",
+		"directory": "packages/web"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"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.1",
+		"@twin.org/crypto": "0.0.1-next.1",
+		"@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": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		}
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}