@twin.org/engine-server-types 0.0.3-next.4 → 0.0.3-next.41

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 (88) hide show
  1. package/README.md +1 -1
  2. package/dist/es/components/authentication.js +23 -19
  3. package/dist/es/components/authentication.js.map +1 -1
  4. package/dist/es/components/authenticationAdmin.js +19 -15
  5. package/dist/es/components/authenticationAdmin.js.map +1 -1
  6. package/dist/es/components/authenticationAudit.js +35 -0
  7. package/dist/es/components/authenticationAudit.js.map +1 -0
  8. package/dist/es/components/authenticationRate.js +37 -0
  9. package/dist/es/components/authenticationRate.js.map +1 -0
  10. package/dist/es/components/hosting.js +29 -0
  11. package/dist/es/components/hosting.js.map +1 -0
  12. package/dist/es/components/information.js +12 -9
  13. package/dist/es/components/information.js.map +1 -1
  14. package/dist/es/components/mimeTypeProcessor.js +7 -7
  15. package/dist/es/components/mimeTypeProcessor.js.map +1 -1
  16. package/dist/es/components/restRouteProcessor.js +40 -46
  17. package/dist/es/components/restRouteProcessor.js.map +1 -1
  18. package/dist/es/components/socketRouteProcessor.js +36 -42
  19. package/dist/es/components/socketRouteProcessor.js.map +1 -1
  20. package/dist/es/index.js +9 -0
  21. package/dist/es/index.js.map +1 -1
  22. package/dist/es/models/IEngineServerConfig.js.map +1 -1
  23. package/dist/es/models/config/authenticationAuditComponentConfig.js +2 -0
  24. package/dist/es/models/config/authenticationAuditComponentConfig.js.map +1 -0
  25. package/dist/es/models/config/authenticationRateComponentConfig.js +2 -0
  26. package/dist/es/models/config/authenticationRateComponentConfig.js.map +1 -0
  27. package/dist/es/models/config/hostingComponentConfig.js +2 -0
  28. package/dist/es/models/config/hostingComponentConfig.js.map +1 -0
  29. package/dist/es/models/config/restRouteProcessorConfig.js.map +1 -1
  30. package/dist/es/models/config/socketRouteProcessorConfig.js.map +1 -1
  31. package/dist/es/models/types/authenticationAuditComponentType.js +13 -0
  32. package/dist/es/models/types/authenticationAuditComponentType.js.map +1 -0
  33. package/dist/es/models/types/authenticationRateComponentType.js +13 -0
  34. package/dist/es/models/types/authenticationRateComponentType.js.map +1 -0
  35. package/dist/es/models/types/hostingComponentType.js +13 -0
  36. package/dist/es/models/types/hostingComponentType.js.map +1 -0
  37. package/dist/types/components/authentication.d.ts +3 -7
  38. package/dist/types/components/authenticationAdmin.d.ts +3 -7
  39. package/dist/types/components/authenticationAudit.d.ts +12 -0
  40. package/dist/types/components/authenticationRate.d.ts +12 -0
  41. package/dist/types/components/hosting.d.ts +12 -0
  42. package/dist/types/components/information.d.ts +3 -7
  43. package/dist/types/components/mimeTypeProcessor.d.ts +2 -7
  44. package/dist/types/components/restRouteProcessor.d.ts +2 -7
  45. package/dist/types/components/socketRouteProcessor.d.ts +2 -7
  46. package/dist/types/index.d.ts +9 -0
  47. package/dist/types/models/IEngineServerConfig.d.ts +21 -6
  48. package/dist/types/models/config/authenticationAuditComponentConfig.d.ts +9 -0
  49. package/dist/types/models/config/authenticationRateComponentConfig.d.ts +9 -0
  50. package/dist/types/models/config/hostingComponentConfig.d.ts +9 -0
  51. package/dist/types/models/config/restRouteProcessorConfig.d.ts +0 -4
  52. package/dist/types/models/config/socketRouteProcessorConfig.d.ts +0 -4
  53. package/dist/types/models/types/authenticationAuditComponentType.d.ts +13 -0
  54. package/dist/types/models/types/authenticationRateComponentType.d.ts +13 -0
  55. package/dist/types/models/types/hostingComponentType.d.ts +13 -0
  56. package/docs/changelog.md +730 -118
  57. package/docs/examples.md +64 -1
  58. package/docs/reference/functions/initialiseAuthenticationAdminComponent.md +2 -2
  59. package/docs/reference/functions/initialiseAuthenticationAuditComponent.md +31 -0
  60. package/docs/reference/functions/initialiseAuthenticationComponent.md +2 -2
  61. package/docs/reference/functions/initialiseAuthenticationRateComponent.md +31 -0
  62. package/docs/reference/functions/initialiseHostingComponent.md +31 -0
  63. package/docs/reference/functions/initialiseInformationComponent.md +2 -2
  64. package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +2 -2
  65. package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +2 -2
  66. package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +2 -2
  67. package/docs/reference/index.md +12 -0
  68. package/docs/reference/interfaces/IEngineServerConfig.md +509 -15
  69. package/docs/reference/type-aliases/AuthenticationAdminComponentConfig.md +3 -3
  70. package/docs/reference/type-aliases/AuthenticationAuditComponentConfig.md +17 -0
  71. package/docs/reference/type-aliases/AuthenticationAuditComponentType.md +5 -0
  72. package/docs/reference/type-aliases/AuthenticationRateComponentConfig.md +17 -0
  73. package/docs/reference/type-aliases/AuthenticationRateComponentType.md +5 -0
  74. package/docs/reference/type-aliases/HostingComponentConfig.md +17 -0
  75. package/docs/reference/type-aliases/HostingComponentType.md +5 -0
  76. package/docs/reference/type-aliases/MimeTypeProcessorConfig.md +3 -3
  77. package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
  78. package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
  79. package/docs/reference/variables/AuthenticationAdminComponentType.md +1 -1
  80. package/docs/reference/variables/AuthenticationAuditComponentType.md +13 -0
  81. package/docs/reference/variables/AuthenticationComponentType.md +2 -2
  82. package/docs/reference/variables/AuthenticationRateComponentType.md +13 -0
  83. package/docs/reference/variables/HostingComponentType.md +13 -0
  84. package/docs/reference/variables/InformationComponentType.md +2 -2
  85. package/docs/reference/variables/MimeTypeProcessorType.md +1 -1
  86. package/docs/reference/variables/RestRouteProcessorType.md +7 -7
  87. package/docs/reference/variables/SocketRouteProcessorType.md +7 -7
  88. package/package.json +6 -7
@@ -0,0 +1,9 @@
1
+ import type { IHostingServiceConstructorOptions } from "@twin.org/api-service";
2
+ import type { HostingComponentType } from "../types/hostingComponentType.js";
3
+ /**
4
+ * Hosting component config types.
5
+ */
6
+ export type HostingComponentConfig = {
7
+ type: typeof HostingComponentType.Service;
8
+ options: IHostingServiceConstructorOptions;
9
+ };
@@ -1,7 +1,6 @@
1
1
  import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
2
2
  import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, IRestRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@twin.org/api-processors";
3
3
  import type { ITenantProcessorConstructorOptions } from "@twin.org/api-tenant-processor";
4
- import type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from "@twin.org/identity-authentication";
5
4
  import type { RestRouteProcessorType } from "../types/restRouteProcessorType.js";
6
5
  /**
7
6
  * REST route processor config types.
@@ -9,9 +8,6 @@ import type { RestRouteProcessorType } from "../types/restRouteProcessorType.js"
9
8
  export type RestRouteProcessorConfig = {
10
9
  type: typeof RestRouteProcessorType.AuthHeader;
11
10
  options?: IAuthHeaderProcessorConstructorOptions;
12
- } | {
13
- type: typeof RestRouteProcessorType.AuthVerifiableCredential;
14
- options?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;
15
11
  } | {
16
12
  type: typeof RestRouteProcessorType.Logging;
17
13
  options?: ILoggingProcessorConstructorOptions;
@@ -1,7 +1,6 @@
1
1
  import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
2
2
  import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, ISocketRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@twin.org/api-processors";
3
3
  import type { ITenantProcessorConstructorOptions } from "@twin.org/api-tenant-processor";
4
- import type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from "@twin.org/identity-authentication";
5
4
  import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType.js";
6
5
  /**
7
6
  * Socket route processor config types.
@@ -9,9 +8,6 @@ import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType
9
8
  export type SocketRouteProcessorConfig = {
10
9
  type: typeof SocketRouteProcessorType.AuthHeader;
11
10
  options?: IAuthHeaderProcessorConstructorOptions;
12
- } | {
13
- type: typeof SocketRouteProcessorType.AuthVerifiableCredential;
14
- options?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;
15
11
  } | {
16
12
  type: typeof SocketRouteProcessorType.Logging;
17
13
  options?: ILoggingProcessorConstructorOptions;
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Authentication audit component types.
3
+ */
4
+ export declare const AuthenticationAuditComponentType: {
5
+ /**
6
+ * Entity storage.
7
+ */
8
+ readonly EntityStorage: "entity-storage";
9
+ };
10
+ /**
11
+ * Authentication audit component types.
12
+ */
13
+ export type AuthenticationAuditComponentType = (typeof AuthenticationAuditComponentType)[keyof typeof AuthenticationAuditComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Authentication rate component types.
3
+ */
4
+ export declare const AuthenticationRateComponentType: {
5
+ /**
6
+ * Entity storage.
7
+ */
8
+ readonly EntityStorage: "entity-storage";
9
+ };
10
+ /**
11
+ * Authentication rate component types.
12
+ */
13
+ export type AuthenticationRateComponentType = (typeof AuthenticationRateComponentType)[keyof typeof AuthenticationRateComponentType];
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Hosting component types.
3
+ */
4
+ export declare const HostingComponentType: {
5
+ /**
6
+ * Service.
7
+ */
8
+ readonly Service: "service";
9
+ };
10
+ /**
11
+ * Hosting component types.
12
+ */
13
+ export type HostingComponentType = (typeof HostingComponentType)[keyof typeof HostingComponentType];