@twin.org/api-service 0.0.3-next.8 → 0.9.0-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/README.md +1 -1
  2. package/dist/es/healthRoutes.js +107 -0
  3. package/dist/es/healthRoutes.js.map +1 -0
  4. package/dist/es/healthService.js +155 -0
  5. package/dist/es/healthService.js.map +1 -0
  6. package/dist/es/index.js +7 -0
  7. package/dist/es/index.js.map +1 -1
  8. package/dist/es/informationRoutes.js +92 -62
  9. package/dist/es/informationRoutes.js.map +1 -1
  10. package/dist/es/informationService.js +13 -59
  11. package/dist/es/informationService.js.map +1 -1
  12. package/dist/es/models/IHealthServiceConfig.js +4 -0
  13. package/dist/es/models/IHealthServiceConfig.js.map +1 -0
  14. package/dist/es/models/IHealthServiceConstructorOptions.js +2 -0
  15. package/dist/es/models/IHealthServiceConstructorOptions.js.map +1 -0
  16. package/dist/es/models/IPlatformServiceConfig.js +4 -0
  17. package/dist/es/models/IPlatformServiceConfig.js.map +1 -0
  18. package/dist/es/models/IPlatformServiceConstructorOptions.js +2 -0
  19. package/dist/es/models/IPlatformServiceConstructorOptions.js.map +1 -0
  20. package/dist/es/platformService.js +155 -0
  21. package/dist/es/platformService.js.map +1 -0
  22. package/dist/es/restEntryPoints.js +10 -0
  23. package/dist/es/restEntryPoints.js.map +1 -1
  24. package/dist/types/healthRoutes.d.ts +20 -0
  25. package/dist/types/healthService.d.ts +42 -0
  26. package/dist/types/index.d.ts +7 -0
  27. package/dist/types/informationRoutes.d.ts +11 -3
  28. package/dist/types/informationService.d.ts +12 -17
  29. package/dist/types/models/IHealthServiceConfig.d.ts +16 -0
  30. package/dist/types/models/IHealthServiceConstructorOptions.d.ts +10 -0
  31. package/dist/types/models/IPlatformServiceConfig.d.ts +10 -0
  32. package/dist/types/models/IPlatformServiceConstructorOptions.d.ts +15 -0
  33. package/dist/types/platformService.d.ts +39 -0
  34. package/dist/types/restEntryPoints.d.ts +3 -0
  35. package/docs/changelog.md +752 -59
  36. package/docs/examples.md +74 -1
  37. package/docs/reference/classes/HealthService.md +123 -0
  38. package/docs/reference/classes/InformationService.md +20 -66
  39. package/docs/reference/classes/PlatformService.md +123 -0
  40. package/docs/reference/functions/generateRestRoutesHealth.md +25 -0
  41. package/docs/reference/functions/serverLivez.md +31 -0
  42. package/docs/reference/functions/serverReadyz.md +31 -0
  43. package/docs/reference/index.md +11 -1
  44. package/docs/reference/interfaces/IHealthServiceConfig.md +32 -0
  45. package/docs/reference/interfaces/IHealthServiceConstructorOptions.md +11 -0
  46. package/docs/reference/interfaces/IInformationServiceConfig.md +5 -5
  47. package/docs/reference/interfaces/IInformationServiceConstructorOptions.md +1 -1
  48. package/docs/reference/interfaces/IPlatformServiceConfig.md +17 -0
  49. package/docs/reference/interfaces/IPlatformServiceConstructorOptions.md +25 -0
  50. package/docs/reference/variables/restEntryPoints.md +2 -0
  51. package/docs/reference/variables/tagsHealth.md +5 -0
  52. package/locales/en.json +7 -1
  53. package/package.json +13 -8
package/docs/reference/interfaces/IPlatformServiceConstructorOptions.md ADDED
@@ -0,0 +1,25 @@
1
+ # Interface: IPlatformServiceConstructorOptions
2
+
3
+ Options for the Platform Service constructor.
4
+
5
+ ## Properties
6
+
7
+ ### tenantEntityStorageType? {#tenantentitystoragetype}
8
+
9
+ > `optional` **tenantEntityStorageType?**: `string`
10
+
11
+ The entity storage for the tenants.
12
+
13
+ #### Default
14
+
15
+ ```ts
16
+ tenant
17
+ ```
18
+
19
+ ***
20
+
21
+ ### config? {#config}
22
+
23
+ > `optional` **config?**: [`IPlatformServiceConfig`](IPlatformServiceConfig.md)
24
+
25
+ Configuration for the service.
package/docs/reference/variables/restEntryPoints.md CHANGED
@@ -1,3 +1,5 @@
1
1
  # Variable: restEntryPoints
2
2
 
3
3
  > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
4
+
5
+ REST entry points for the information and health services.
package/docs/reference/variables/tagsHealth.md ADDED
@@ -0,0 +1,5 @@
1
+ # Variable: tagsHealth
2
+
3
+ > `const` **tagsHealth**: `ITag`[]
4
+
5
+ The tag to associate with the routes.
package/locales/en.json CHANGED
@@ -1 +1,7 @@
1
- {}
1
+ {
2
+ "error": {
3
+ "healthService": {
4
+ "componentHealthCheckFailed": "Health check failed for component \"{className}\""
5
+ }
6
+ }
7
+ }
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/api-service",
3
- "version": "0.0.3-next.8",
4
- "description": "Information contract implementation and REST endpoint definitions",
3
+ "version": "0.9.0-next.1",
4
+ "description": "Information and hosting service implementations with generated REST route handlers.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/api.git",
7
+ "url": "git+https://github.com/iotaledger/twin-api.git",
8
8
  "directory": "packages/api-service"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -14,10 +14,15 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/api-models": "0.0.3-next.8",
18
- "@twin.org/core": "next",
19
- "@twin.org/nameof": "next",
20
- "@twin.org/web": "next"
17
+ "@twin.org/api-models": "0.9.0-next.1",
18
+ "@twin.org/context": "0.9.0-next.1",
19
+ "@twin.org/core": "0.9.0-next.1",
20
+ "@twin.org/engine-models": "0.0.3-next.56",
21
+ "@twin.org/entity-storage-models": "0.0.3-next.33",
22
+ "@twin.org/logging-models": "0.0.3-next.8",
23
+ "@twin.org/nameof": "0.9.0-next.1",
24
+ "@twin.org/vault-models": "0.0.3-next.9",
25
+ "@twin.org/web": "0.9.0-next.1"
21
26
  },
22
27
  "main": "./dist/es/index.js",
23
28
  "types": "./dist/types/index.d.ts",
@@ -46,7 +51,7 @@
46
51
  "business-logic"
47
52
  ],
48
53
  "bugs": {
49
- "url": "git+https://github.com/twinfoundation/api/issues"
54
+ "url": "git+https://github.com/iotaledger/twin-api/issues"
50
55
  },
51
56
  "homepage": "https://twindev.org"
52
57
  }