@3sixty/api-models 0.0.0-stage → 0.20.0-next.0

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

@@ -0,0 +1,5 @@
+# Type Alias: HttpContextIdKeys
+
+> **HttpContextIdKeys** = *typeof* [`HttpContextIdKeys`](../variables/HttpContextIdKeys.md)\[keyof *typeof* [`HttpContextIdKeys`](../variables/HttpContextIdKeys.md)\]
+
+HTTP definition of some context keys.

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

@@ -0,0 +1,5 @@
+# Type Alias: IRestRouteEntryPoint
+
+> **IRestRouteEntryPoint** = [`IBaseRouteEntryPoint`](../interfaces/IBaseRouteEntryPoint.md)\<[`IRestRoute`](../interfaces/IRestRoute.md)\>
+
+Route entry points are used for exposing the REST routes from a package.

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

@@ -0,0 +1,5 @@
+# Type Alias: ISocketRouteEntryPoint
+
+> **ISocketRouteEntryPoint** = [`IBaseRouteEntryPoint`](../interfaces/IBaseRouteEntryPoint.md)\<[`ISocketRoute`](../interfaces/ISocketRoute.md)\>
+
+Route entry points are used for exposing the socket routes from a package.

package/docs/reference/variables/HealthCategory.md

@@ -0,0 +1,19 @@
+# Variable: HealthCategory
+
+> `const` **HealthCategory**: `object`
+
+The category of a health check.
+
+## Type Declaration
+
+### Connectivity {#connectivity}
+
+> `readonly` **Connectivity**: `"connectivity"` = `"connectivity"`
+
+Connectivity health check for infrastructure connectors.
+
+### Application {#application}
+
+> `readonly` **Application**: `"application"` = `"application"`
+
+Application health check for domain services.

package/docs/reference/variables/HealthStatus.md

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

package/docs/reference/variables/HttpBodyLimit.md

@@ -0,0 +1,19 @@
+# Variable: HttpBodyLimit
+
+> `const` **HttpBodyLimit**: `object`
+
+The names of the well-known body size limits for routes.
+
+## Type Declaration
+
+### Default {#default}
+
+> `readonly` **Default**: `"default"` = `"default"`
+
+The server default limit.
+
+### Large {#large}
+
+> `readonly` **Large**: `"large"` = `"large"`
+
+A large limit for routes carrying file payloads, defaults to 25 MiB.

package/docs/reference/variables/HttpContextIdKeys.md

@@ -0,0 +1,56 @@
+# Variable: HttpContextIdKeys
+
+> `const` **HttpContextIdKeys**: `object`
+
+HTTP definition of some context keys.
+
+## Type Declaration
+
+### IpAddress {#ipaddress}
+
+> `readonly` **IpAddress**: `"ipAddress"` = `"ipAddress"`
+
+IP address of the client.
+
+### UserAgent {#useragent}
+
+> `readonly` **UserAgent**: `"userAgent"` = `"userAgent"`
+
+User agent of the client.
+
+### CorrelationId {#correlationid}
+
+> `readonly` **CorrelationId**: `"correlationId"` = `"correlationId"`
+
+Correlation ID of the request.
+
+### RemoteRequest {#remoterequest}
+
+> `readonly` **RemoteRequest**: `"remoteRequest"` = `"remoteRequest"`
+
+Is this a remote request, will be a random UUID if request arrived through a REST endpoint, otherwise undefined.
+
+### PublicOrigin {#publicorigin}
+
+> `readonly` **PublicOrigin**: `"publicOrigin"` = `"publicOrigin"`
+
+Public Origin of the request.
+
+### LocalOrigin {#localorigin}
+
+> `readonly` **LocalOrigin**: `"localOrigin"` = `"localOrigin"`
+
+Local Origin of the request.
+
+### Scope {#scope}
+
+> `readonly` **Scope**: `"scope"` = `"scope"`
+
+The comma-separated scope claim from the verified JWT for the current request.
+
+### OriginalTenant {#originaltenant}
+
+> `readonly` **OriginalTenant**: `"originalTenant"` = `"originalTenant"`
+
+The caller's original tenant ID before an escalated privilege tenant override was applied.
+Only present when overrideTenant substitution is active for the current request.

package/docs/reference/variables/MimeTypeProcessorFactory.md

@@ -0,0 +1,5 @@
+# Variable: MimeTypeProcessorFactory
+
+> `const` **MimeTypeProcessorFactory**: `Factory`\<[`IMimeTypeProcessor`](../interfaces/IMimeTypeProcessor.md)\>
+
+Factory for creating implementation of mime type processor types.

package/docs/reference/variables/RestClientProcessorFactory.md

@@ -0,0 +1,5 @@
+# Variable: RestClientProcessorFactory
+
+> `const` **RestClientProcessorFactory**: `Factory`\<[`IRestClientProcessor`](../interfaces/IRestClientProcessor.md)\>
+
+Factory for creating implementation of REST client processor types.

package/docs/reference/variables/RestRouteProcessorFactory.md

@@ -0,0 +1,5 @@
+# Variable: RestRouteProcessorFactory
+
+> `const` **RestRouteProcessorFactory**: `Factory`\<[`IRestRouteProcessor`](../interfaces/IRestRouteProcessor.md)\>
+
+Factory for creating implementation of REST route processor types.

package/docs/reference/variables/SocketRouteProcessorFactory.md

@@ -0,0 +1,5 @@
+# Variable: SocketRouteProcessorFactory
+
+> `const` **SocketRouteProcessorFactory**: `Factory`\<[`ISocketRouteProcessor`](../interfaces/ISocketRouteProcessor.md)\>
+
+Factory for creating implementation of socket route processor types.

package/locales/en.json

@@ -0,0 +1,8 @@
+{
+	"error": {
+		"httpHeaderHelper": {
+			"locationMissing": "The Location response header is missing or empty",
+			"idNotFound": "The resource ID could not be extracted from the Location header"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,54 @@
 {
-  "name": "@3sixty/api-models",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-models",
+	"version": "0.20.0-next.0",
+	"description": "Shared API contracts, route types, and response models used across services and clients.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api.git",
+		"directory": "packages/api-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/entity": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/web": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		}
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"models",
+		"types",
+		"interfaces",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api/issues"
+	},
+	"homepage": "https://3sixty.global"
+}