@twin.org/api-models 0.0.1-next.1

package/docs/reference/interfaces/IUnprocessableEntityResponse.md

@@ -0,0 +1,19 @@
+# Interface: IUnprocessableEntityResponse
+
+The server cannot process the request, see the content for more details.
+
+## Properties
+
+### statusCode
+
+> **statusCode**: `422`
+
+Response status code.
+
+***
+
+### body
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IWebServer.md

@@ -0,0 +1,77 @@
+# Interface: IWebServer\<T\>
+
+Interface describing a web server.
+
+## Type Parameters
+
+• **T**
+
+## Methods
+
+### getInstance()
+
+> **getInstance**(): `T`
+
+Get the web server instance.
+
+#### Returns
+
+`T`
+
+The web server instance.
+
+***
+
+### build()
+
+> **build**(`restRouteProcessors`, `restRoutes`, `options`?): `Promise`\<`void`\>
+
+Build the server.
+
+#### Parameters
+
+• **restRouteProcessors**: [`IHttpRestRouteProcessor`](IHttpRestRouteProcessor.md)[]
+
+The hooks to process the incoming requests.
+
+• **restRoutes**: [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]
+
+The REST routes.
+
+• **options?**: [`IWebServerOptions`](IWebServerOptions.md)
+
+Options for building the server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### start()
+
+> **start**(): `Promise`\<`void`\>
+
+Start the server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### stop()
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IWebServerOptions.md

@@ -0,0 +1,75 @@
+# Interface: IWebServerOptions
+
+Options for the web server.
+
+## Properties
+
+### port?
+
+> `optional` **port**: `number`
+
+The port to bind the web server to.
+
+#### Default
+
+```ts
+3000
+```
+
+***
+
+### host?
+
+> `optional` **host**: `string`
+
+The address to bind the web server to.
+
+#### Default
+
+```ts
+localhost
+```
+
+***
+
+### methods?
+
+> `optional` **methods**: `HttpMethod`[]
+
+The methods that the server accepts.
+
+#### Default
+
+```ts
+["GET", "PUT", "POST", "DELETE", "OPTIONS"]
+```
+
+***
+
+### allowedHeaders?
+
+> `optional` **allowedHeaders**: `string`[]
+
+Any additional allowed headers.
+
+***
+
+### exposedHeaders?
+
+> `optional` **exposedHeaders**: `string`[]
+
+And additional exposed headers.
+
+***
+
+### corsOrigins?
+
+> `optional` **corsOrigins**: `string` \| `string`[]
+
+The allowed CORS domains.
+
+#### Default
+
+```ts
+["*"]
+```

package/docs/reference/type-aliases/HealthStatus.md

@@ -0,0 +1,5 @@
+# Type Alias: HealthStatus
+
+> **HealthStatus**: *typeof* [`HealthStatus`](../variables/HealthStatus.md)\[keyof *typeof* [`HealthStatus`](../variables/HealthStatus.md)\]
+
+The health status of the component.

package/docs/reference/variables/HealthStatus.md

@@ -0,0 +1,25 @@
+# Variable: HealthStatus
+
+> `const` **HealthStatus**: `object`
+
+The health status of the component.
+
+## Type declaration
+
+### Ok
+
+> `readonly` **Ok**: `"ok"` = `"ok"`
+
+OK.
+
+### Warning
+
+> `readonly` **Warning**: `"warning"` = `"warning"`
+
+Warning.
+
+### Error
+
+> `readonly` **Error**: `"error"` = `"error"`
+
+Error.

package/locales/en.json

@@ -0,0 +1,9 @@
+{
+	"error": {
+		"baseRestClient": {
+			"missingRouteProp": "Missing route parameter in data \"{routeProp}\" for route \"{route}\"",
+			"decodingFailed": "Decoding JSON failed for route \"{route}\"",
+			"failureStatusText": "The request to the API failed: \"{statusText}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+	"name": "@twin.org/api-models",
+	"version": "0.0.1-next.1",
+	"description": "Contains models and classes for use with APIs",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/api.git",
+		"directory": "packages/api-models"
+	},
+	"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": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/web": "next"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@vitest/coverage-v8": "2.1.1",
+		"@types/node": "22.5.5",
+		"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"
+	]
+}