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

package/docs/reference/index.md

@@ -0,0 +1,34 @@
+# @3sixty/api-service
+
+## Classes
+
+- [HealthService](classes/HealthService.md)
+- [InformationService](classes/InformationService.md)
+- [PlatformService](classes/PlatformService.md)
+
+## Interfaces
+
+- [IHealthServiceConfig](interfaces/IHealthServiceConfig.md)
+- [IHealthServiceConstructorOptions](interfaces/IHealthServiceConstructorOptions.md)
+- [IInformationServiceConfig](interfaces/IInformationServiceConfig.md)
+- [IInformationServiceConstructorOptions](interfaces/IInformationServiceConstructorOptions.md)
+- [IPlatformServiceConfig](interfaces/IPlatformServiceConfig.md)
+- [IPlatformServiceConstructorOptions](interfaces/IPlatformServiceConstructorOptions.md)
+
+## Variables
+
+- [tagsHealth](variables/tagsHealth.md)
+- [tagsInformation](variables/tagsInformation.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesHealth](functions/generateRestRoutesHealth.md)
+- [serverHealth](functions/serverHealth.md)
+- [generateRestRoutesInformation](functions/generateRestRoutesInformation.md)
+- [serverRoot](functions/serverRoot.md)
+- [serverInfo](functions/serverInfo.md)
+- [serverLivez](functions/serverLivez.md)
+- [serverReadyz](functions/serverReadyz.md)
+- [serverFavIcon](functions/serverFavIcon.md)
+- [serverSpec](functions/serverSpec.md)

package/docs/reference/interfaces/IHealthServiceConfig.md

@@ -0,0 +1,79 @@
+# Interface: IHealthServiceConfig
+
+Configuration for the health service.
+
+## Properties
+
+### healthCheckInterval? {#healthcheckinterval}
+
+> `optional` **healthCheckInterval?**: `number`
+
+The interval for checking the health of the components.
+
+#### Default
+
+```ts
+60000
+```
+
+***
+
+### healthCheckApplicationInterval? {#healthcheckapplicationinterval}
+
+> `optional` **healthCheckApplicationInterval?**: `number`
+
+The interval for running the application health lifecycle (init, application, teardown).
+
+#### Default
+
+```ts
+300000
+```
+
+***
+
+### initialInterval? {#initialinterval}
+
+> `optional` **initialInterval?**: `number`
+
+The initial interval for checking the health of the components and setting it in the health service.
+This is used to check the health of the components immediately after the service is started.
+
+#### Default
+
+```ts
+2000
+```
+
+***
+
+### includeErrorStack? {#includeerrorstack}
+
+> `optional` **includeErrorStack?**: `boolean`
+
+Whether to include stack traces in health check error details.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### overrideApplicationHealthTaskHandler? {#overrideapplicationhealthtaskhandler}
+
+> `optional` **overrideApplicationHealthTaskHandler?**: `string`
+
+The URL of the module to use for the application health background task.
+If not provided, the default healthApplicationTask module will be used.
+
+***
+
+### excludeCloneComponents? {#excludeclonecomponents}
+
+> `optional` **excludeCloneComponents?**: `string`[]
+
+The component types to exclude from the engine clone used by the application health
+background task. Each entry is a regular expression matched against the engine config
+type keys, for example "^rightsManagement" or "messaging.*Connector".

package/docs/reference/interfaces/IHealthServiceConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IHealthServiceConstructorOptions
+
+Options for the HealthService constructor.
+
+## Properties
+
+### backgroundTaskComponentType? {#backgroundtaskcomponenttype}
+
+> `optional` **backgroundTaskComponentType?**: `string`
+
+The background task component type to use for running application health checks.
+
+#### Default
+
+```ts
+background-task
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IHealthServiceConfig`](IHealthServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/interfaces/IInformationServiceConfig.md

@@ -0,0 +1,27 @@
+# Interface: IInformationServiceConfig
+
+Configuration for the information service.
+
+## Properties
+
+### serverInfo {#serverinfo}
+
+> **serverInfo**: `IServerInfo`
+
+The server information.
+
+***
+
+### openApiSpecPath? {#openapispecpath}
+
+> `optional` **openApiSpecPath?**: `string`
+
+The path to the OpenAPI Spec.
+
+***
+
+### favIconPath? {#faviconpath}
+
+> `optional` **favIconPath?**: `string`
+
+The path to the favicon.

package/docs/reference/interfaces/IInformationServiceConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IInformationServiceConstructorOptions
+
+Options for the InformationService constructor.
+
+## Properties
+
+### config {#config}
+
+> **config**: [`IInformationServiceConfig`](IInformationServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/interfaces/IPlatformServiceConfig.md

@@ -0,0 +1,17 @@
+# Interface: IPlatformServiceConfig
+
+Configuration for the platform service
+
+## Properties
+
+### isMultiTenant? {#ismultitenant}
+
+> `optional` **isMultiTenant?**: `boolean`
+
+Indicates whether the service is running in a multi-tenant environment.
+
+#### Default
+
+```ts
+false
+```

package/docs/reference/interfaces/IPlatformServiceConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IPlatformServiceConstructorOptions
+
+Options for the Platform Service constructor.
+
+## Properties
+
+### tenantEntityStorageType? {#tenantentitystoragetype}
+
+> `optional` **tenantEntityStorageType?**: `string`
+
+The entity storage for the tenants.
+
+#### Default
+
+```ts
+tenant
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IPlatformServiceConfig`](IPlatformServiceConfig.md)
+
+Configuration for the service.

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,5 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+REST entry points for the information and health services.

package/docs/reference/variables/tagsHealth.md

@@ -0,0 +1,5 @@
+# Variable: tagsHealth
+
+> `const` **tagsHealth**: `ITag`[]
+
+The tag to associate with the routes.

package/docs/reference/variables/tagsInformation.md

@@ -0,0 +1,5 @@
+# Variable: tagsInformation
+
+> `const` **tagsInformation**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,11 @@
+{
+	"error": {
+		"healthService": {
+			"componentHealthCheckFailed": "Health check failed for component \"{className}\"",
+			"applicationHealthCheckTaskFailed": "Application health check background task failed"
+		},
+		"applicationHealthTask": {
+			"engineNotStarted": "Application health engine is not started"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,58 @@
 {
-  "name": "@3sixty/api-service",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-service",
+	"version": "0.20.0-next.0",
+	"description": "Information and hosting service implementations with generated REST route handlers.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api.git",
+		"directory": "packages/api-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-models": "0.20.0-next.0",
+		"@3sixty/background-task-models": "next",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/entity-storage-models": "next",
+		"@3sixty/logging-models": "next",
+		"@3sixty/modules": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/vault-models": "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",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api/issues"
+	},
+	"homepage": "https://3sixty.global"
+}