@twin.org/api-service 0.0.3-next.4 → 0.0.3-next.40

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 (63) 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 +156 -0
  5. package/dist/es/healthService.js.map +1 -0
  6. package/dist/es/hostingService.js +89 -0
  7. package/dist/es/hostingService.js.map +1 -0
  8. package/dist/es/index.js +10 -0
  9. package/dist/es/index.js.map +1 -1
  10. package/dist/es/informationRoutes.js +92 -62
  11. package/dist/es/informationRoutes.js.map +1 -1
  12. package/dist/es/informationService.js +12 -58
  13. package/dist/es/informationService.js.map +1 -1
  14. package/dist/es/models/IHealthServiceConfig.js +4 -0
  15. package/dist/es/models/IHealthServiceConfig.js.map +1 -0
  16. package/dist/es/models/IHealthServiceConstructorOptions.js +2 -0
  17. package/dist/es/models/IHealthServiceConstructorOptions.js.map +1 -0
  18. package/dist/es/models/IHostingServiceConfig.js +4 -0
  19. package/dist/es/models/IHostingServiceConfig.js.map +1 -0
  20. package/dist/es/models/IHostingServiceConstructorOptions.js +2 -0
  21. package/dist/es/models/IHostingServiceConstructorOptions.js.map +1 -0
  22. package/dist/es/models/IUrlTransformerServiceConfig.js +4 -0
  23. package/dist/es/models/IUrlTransformerServiceConfig.js.map +1 -0
  24. package/dist/es/models/IUrlTransformerServiceConstructorOptions.js +2 -0
  25. package/dist/es/models/IUrlTransformerServiceConstructorOptions.js.map +1 -0
  26. package/dist/es/restEntryPoints.js +7 -0
  27. package/dist/es/restEntryPoints.js.map +1 -1
  28. package/dist/es/urlTransformerService.js +256 -0
  29. package/dist/es/urlTransformerService.js.map +1 -0
  30. package/dist/types/healthRoutes.d.ts +20 -0
  31. package/dist/types/healthService.d.ts +42 -0
  32. package/dist/types/hostingService.d.ts +39 -0
  33. package/dist/types/index.d.ts +10 -0
  34. package/dist/types/informationRoutes.d.ts +11 -3
  35. package/dist/types/informationService.d.ts +11 -16
  36. package/dist/types/models/IHealthServiceConfig.d.ts +16 -0
  37. package/dist/types/models/IHealthServiceConstructorOptions.d.ts +10 -0
  38. package/dist/types/models/IHostingServiceConfig.d.ts +13 -0
  39. package/dist/types/models/IHostingServiceConstructorOptions.d.ts +15 -0
  40. package/dist/types/models/IUrlTransformerServiceConfig.d.ts +19 -0
  41. package/dist/types/models/IUrlTransformerServiceConstructorOptions.d.ts +15 -0
  42. package/dist/types/urlTransformerService.d.ts +94 -0
  43. package/docs/changelog.md +574 -55
  44. package/docs/examples.md +74 -1
  45. package/docs/reference/classes/HealthService.md +123 -0
  46. package/docs/reference/classes/HostingService.md +131 -0
  47. package/docs/reference/classes/InformationService.md +19 -65
  48. package/docs/reference/classes/UrlTransformerService.md +379 -0
  49. package/docs/reference/functions/generateRestRoutesHealth.md +25 -0
  50. package/docs/reference/functions/serverLivez.md +31 -0
  51. package/docs/reference/functions/serverReadyz.md +31 -0
  52. package/docs/reference/index.md +14 -1
  53. package/docs/reference/interfaces/IHealthServiceConfig.md +32 -0
  54. package/docs/reference/interfaces/IHealthServiceConstructorOptions.md +11 -0
  55. package/docs/reference/interfaces/IHostingServiceConfig.md +19 -0
  56. package/docs/reference/interfaces/IHostingServiceConstructorOptions.md +25 -0
  57. package/docs/reference/interfaces/IInformationServiceConfig.md +5 -5
  58. package/docs/reference/interfaces/IInformationServiceConstructorOptions.md +1 -1
  59. package/docs/reference/interfaces/IUrlTransformerServiceConfig.md +32 -0
  60. package/docs/reference/interfaces/IUrlTransformerServiceConstructorOptions.md +25 -0
  61. package/docs/reference/variables/tagsHealth.md +5 -0
  62. package/locales/en.json +13 -1
  63. package/package.json +9 -5
package/locales/en.json CHANGED
@@ -1 +1,13 @@
1
- {}
1
+ {
2
+ "error": {
3
+ "urlTransformerService": {
4
+ "encryptionUnavailable": "Encryption is unavailable because no nodeId is configured",
5
+ "decryptionUnavailable": "Decryption is unavailable because no nodeId is configured",
6
+ "encryptionFailed": "An error occurred during encryption",
7
+ "decryptionFailed": "An error occurred during decryption"
8
+ },
9
+ "healthService": {
10
+ "componentHealthCheckFailed": "Health check failed for component \"{className}\""
11
+ }
12
+ }
13
+ }
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/api-service",
3
- "version": "0.0.3-next.4",
4
- "description": "Information contract implementation and REST endpoint definitions",
3
+ "version": "0.0.3-next.40",
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,9 +14,13 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/api-models": "0.0.3-next.4",
17
+ "@twin.org/api-models": "0.0.3-next.40",
18
+ "@twin.org/context": "next",
18
19
  "@twin.org/core": "next",
20
+ "@twin.org/engine-models": "next",
21
+ "@twin.org/logging-models": "next",
19
22
  "@twin.org/nameof": "next",
23
+ "@twin.org/vault-models": "next",
20
24
  "@twin.org/web": "next"
21
25
  },
22
26
  "main": "./dist/es/index.js",
@@ -46,7 +50,7 @@
46
50
  "business-logic"
47
51
  ],
48
52
  "bugs": {
49
- "url": "git+https://github.com/twinfoundation/api/issues"
53
+ "url": "git+https://github.com/iotaledger/twin-api/issues"
50
54
  },
51
55
  "homepage": "https://twindev.org"
52
56
  }