@3sixty/engine-server-types 0.20.0-next.4 → 0.20.0-next.6

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 (116) hide show
  1. package/dist/es/components/authentication.js +41 -7
  2. package/dist/es/components/authentication.js.map +1 -1
  3. package/dist/es/components/authenticationAccount.js +86 -0
  4. package/dist/es/components/authenticationAccount.js.map +1 -0
  5. package/dist/es/components/authenticationAccountAdmin.js +47 -0
  6. package/dist/es/components/authenticationAccountAdmin.js.map +1 -0
  7. package/dist/es/components/authenticationAdmin.js +11 -9
  8. package/dist/es/components/authenticationAdmin.js.map +1 -1
  9. package/dist/es/components/authenticationProvider.js +45 -0
  10. package/dist/es/components/authenticationProvider.js.map +1 -0
  11. package/dist/es/components/oauth.js +32 -0
  12. package/dist/es/components/oauth.js.map +1 -0
  13. package/dist/es/components/organization.js +44 -0
  14. package/dist/es/components/organization.js.map +1 -0
  15. package/dist/es/components/organizationRequestAdmin.js +41 -0
  16. package/dist/es/components/organizationRequestAdmin.js.map +1 -0
  17. package/dist/es/components/restRouteProcessor.js +19 -9
  18. package/dist/es/components/restRouteProcessor.js.map +1 -1
  19. package/dist/es/components/socketRouteProcessor.js +19 -9
  20. package/dist/es/components/socketRouteProcessor.js.map +1 -1
  21. package/dist/es/index.js +18 -0
  22. package/dist/es/index.js.map +1 -1
  23. package/dist/es/models/IEngineServerConfig.js.map +1 -1
  24. package/dist/es/models/config/authenticationAccountAdminComponentConfig.js +2 -0
  25. package/dist/es/models/config/authenticationAccountAdminComponentConfig.js.map +1 -0
  26. package/dist/es/models/config/authenticationAccountComponentConfig.js +2 -0
  27. package/dist/es/models/config/authenticationAccountComponentConfig.js.map +1 -0
  28. package/dist/es/models/config/authenticationProviderConfig.js +2 -0
  29. package/dist/es/models/config/authenticationProviderConfig.js.map +1 -0
  30. package/dist/es/models/config/oauthComponentConfig.js +2 -0
  31. package/dist/es/models/config/oauthComponentConfig.js.map +1 -0
  32. package/dist/es/models/config/organizationComponentConfig.js +2 -0
  33. package/dist/es/models/config/organizationComponentConfig.js.map +1 -0
  34. package/dist/es/models/config/organizationRequestAdminComponentConfig.js +2 -0
  35. package/dist/es/models/config/organizationRequestAdminComponentConfig.js.map +1 -0
  36. package/dist/es/models/config/restRouteProcessorConfig.js.map +1 -1
  37. package/dist/es/models/config/socketRouteProcessorConfig.js.map +1 -1
  38. package/dist/es/models/types/authenticationAccountAdminComponentType.js +17 -0
  39. package/dist/es/models/types/authenticationAccountAdminComponentType.js.map +1 -0
  40. package/dist/es/models/types/authenticationAccountComponentType.js +17 -0
  41. package/dist/es/models/types/authenticationAccountComponentType.js.map +1 -0
  42. package/dist/es/models/types/authenticationProviderType.js +21 -0
  43. package/dist/es/models/types/authenticationProviderType.js.map +1 -0
  44. package/dist/es/models/types/oauthComponentType.js +13 -0
  45. package/dist/es/models/types/oauthComponentType.js.map +1 -0
  46. package/dist/es/models/types/organizationComponentType.js +17 -0
  47. package/dist/es/models/types/organizationComponentType.js.map +1 -0
  48. package/dist/es/models/types/organizationRequestAdminComponentType.js +17 -0
  49. package/dist/es/models/types/organizationRequestAdminComponentType.js.map +1 -0
  50. package/dist/es/models/types/restRouteProcessorType.js +10 -1
  51. package/dist/es/models/types/restRouteProcessorType.js.map +1 -1
  52. package/dist/es/models/types/socketRouteProcessorType.js +10 -1
  53. package/dist/es/models/types/socketRouteProcessorType.js.map +1 -1
  54. package/dist/types/components/authentication.d.ts +16 -0
  55. package/dist/types/components/authenticationAccount.d.ts +37 -0
  56. package/dist/types/components/authenticationAccountAdmin.d.ts +12 -0
  57. package/dist/types/components/authenticationProvider.d.ts +12 -0
  58. package/dist/types/components/oauth.d.ts +12 -0
  59. package/dist/types/components/organization.d.ts +12 -0
  60. package/dist/types/components/organizationRequestAdmin.d.ts +12 -0
  61. package/dist/types/index.d.ts +18 -0
  62. package/dist/types/models/IEngineServerConfig.d.ts +30 -0
  63. package/dist/types/models/config/authenticationAccountAdminComponentConfig.d.ts +13 -0
  64. package/dist/types/models/config/authenticationAccountComponentConfig.d.ts +13 -0
  65. package/dist/types/models/config/authenticationProviderConfig.d.ts +17 -0
  66. package/dist/types/models/config/oauthComponentConfig.d.ts +9 -0
  67. package/dist/types/models/config/organizationComponentConfig.d.ts +13 -0
  68. package/dist/types/models/config/organizationRequestAdminComponentConfig.d.ts +13 -0
  69. package/dist/types/models/config/restRouteProcessorConfig.d.ts +8 -1
  70. package/dist/types/models/config/socketRouteProcessorConfig.d.ts +8 -1
  71. package/dist/types/models/types/authenticationAccountAdminComponentType.d.ts +17 -0
  72. package/dist/types/models/types/authenticationAccountComponentType.d.ts +17 -0
  73. package/dist/types/models/types/authenticationProviderType.d.ts +21 -0
  74. package/dist/types/models/types/oauthComponentType.d.ts +13 -0
  75. package/dist/types/models/types/organizationComponentType.d.ts +17 -0
  76. package/dist/types/models/types/organizationRequestAdminComponentType.d.ts +17 -0
  77. package/dist/types/models/types/restRouteProcessorType.d.ts +8 -0
  78. package/dist/types/models/types/socketRouteProcessorType.d.ts +8 -0
  79. package/docs/changelog.md +30 -0
  80. package/docs/examples.md +91 -0
  81. package/docs/reference/functions/initialiseAccountDataEntityStorage.md +30 -0
  82. package/docs/reference/functions/initialiseAuthenticationAccountAdminComponent.md +31 -0
  83. package/docs/reference/functions/initialiseAuthenticationAccountComponent.md +31 -0
  84. package/docs/reference/functions/initialiseAuthenticationPasswordResetEntityStorage.md +30 -0
  85. package/docs/reference/functions/initialiseAuthenticationProvider.md +31 -0
  86. package/docs/reference/functions/initialiseAuthenticationUserEntityStorage.md +30 -0
  87. package/docs/reference/functions/initialiseOAuthComponent.md +31 -0
  88. package/docs/reference/functions/initialiseOrganizationComponent.md +31 -0
  89. package/docs/reference/functions/initialiseOrganizationEntityStorage.md +31 -0
  90. package/docs/reference/functions/initialiseOrganizationRequestAdminComponent.md +31 -0
  91. package/docs/reference/functions/initialiseOrganizationRequestEntityStorage.md +30 -0
  92. package/docs/reference/index.md +29 -0
  93. package/docs/reference/interfaces/IEngineServerConfig.md +36 -0
  94. package/docs/reference/type-aliases/AuthenticationAccountAdminComponentConfig.md +5 -0
  95. package/docs/reference/type-aliases/AuthenticationAccountAdminComponentType.md +5 -0
  96. package/docs/reference/type-aliases/AuthenticationAccountComponentConfig.md +5 -0
  97. package/docs/reference/type-aliases/AuthenticationAccountComponentType.md +5 -0
  98. package/docs/reference/type-aliases/AuthenticationProviderConfig.md +5 -0
  99. package/docs/reference/type-aliases/AuthenticationProviderType.md +5 -0
  100. package/docs/reference/type-aliases/OAuthComponentConfig.md +17 -0
  101. package/docs/reference/type-aliases/OAuthComponentType.md +5 -0
  102. package/docs/reference/type-aliases/OrganizationComponentConfig.md +5 -0
  103. package/docs/reference/type-aliases/OrganizationComponentType.md +5 -0
  104. package/docs/reference/type-aliases/OrganizationRequestAdminComponentConfig.md +5 -0
  105. package/docs/reference/type-aliases/OrganizationRequestAdminComponentType.md +5 -0
  106. package/docs/reference/type-aliases/RestRouteProcessorConfig.md +1 -1
  107. package/docs/reference/type-aliases/SocketRouteProcessorConfig.md +1 -1
  108. package/docs/reference/variables/AuthenticationAccountAdminComponentType.md +19 -0
  109. package/docs/reference/variables/AuthenticationAccountComponentType.md +19 -0
  110. package/docs/reference/variables/AuthenticationProviderType.md +25 -0
  111. package/docs/reference/variables/OAuthComponentType.md +13 -0
  112. package/docs/reference/variables/OrganizationComponentType.md +19 -0
  113. package/docs/reference/variables/OrganizationRequestAdminComponentType.md +19 -0
  114. package/docs/reference/variables/RestRouteProcessorType.md +12 -0
  115. package/docs/reference/variables/SocketRouteProcessorType.md +12 -0
  116. package/package.json +10 -3
package/docs/changelog.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.20.0-next.6](https://github.com/3sixtyglobal/engine/compare/engine-server-types-v0.20.0-next.5...engine-server-types-v0.20.0-next.6) (2026-11-03)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * pass every resolved dependency type to the component initialisers ([#36](https://github.com/3sixtyglobal/engine/issues/36)) ([71f28ba](https://github.com/3sixtyglobal/engine/commit/71f28baa32ed123ca416ec8ceceb9ccd02bf1361))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @3sixty/engine-models bumped from 0.20.0-next.5 to 0.20.0-next.6
16
+ * @3sixty/engine-types bumped from 0.20.0-next.5 to 0.20.0-next.6
17
+
18
+ ## [0.20.0-next.5](https://github.com/3sixtyglobal/engine/compare/engine-server-types-v0.20.0-next.4...engine-server-types-v0.20.0-next.5) (2026-11-02)
19
+
20
+
21
+ ### Features
22
+
23
+ * account onboarding, organizations and OAuth sign in ([#32](https://github.com/3sixtyglobal/engine/issues/32)) ([34df36e](https://github.com/3sixtyglobal/engine/commit/34df36eb74007e789fcbe1132f8878b715f4ba6a))
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @3sixty/engine-models bumped from 0.20.0-next.4 to 0.20.0-next.5
31
+ * @3sixty/engine-types bumped from 0.20.0-next.4 to 0.20.0-next.5
32
+
3
33
  ## [0.20.0-next.4](https://github.com/3sixtyglobal/engine/compare/engine-server-types-v0.20.0-next.3...engine-server-types-v0.20.0-next.4) (2026-10-26)
4
34
 
5
35
 
package/docs/examples.md CHANGED
@@ -62,3 +62,94 @@ const serverConfig: IEngineServerConfig = {
62
62
  console.log(serverConfig.web?.port); // 3001
63
63
  console.log(serverConfig.types.restRouteProcessor?.length ?? 0); // 2
64
64
  ```
65
+
66
+ ## Authentication Providers and OAuth
67
+
68
+ Each provider is registered with the authentication provider factory under its id, so `entity-storage` handles password logins and `google` or `microsoft` handle OAuth sign in through the OAuth component.
69
+
70
+ ```typescript
71
+ import type { IEngineServerConfig } from '@3sixty/engine-server-types';
72
+ import {
73
+ AuthenticationComponentType,
74
+ AuthenticationProviderType,
75
+ OAuthComponentType
76
+ } from '@3sixty/engine-server-types';
77
+
78
+ const types: Partial<IEngineServerConfig['types']> = {
79
+ authenticationComponent: [{ type: AuthenticationComponentType.EntityStorage }],
80
+ authenticationProvider: [
81
+ { type: AuthenticationProviderType.EntityStorage },
82
+ {
83
+ type: AuthenticationProviderType.Google,
84
+ options: {
85
+ config: {
86
+ clientId: 'google-client-id',
87
+ clientSecret: 'google-client-secret',
88
+ allowedDomains: ['example.org']
89
+ }
90
+ }
91
+ },
92
+ {
93
+ type: AuthenticationProviderType.Microsoft,
94
+ options: {
95
+ config: {
96
+ clientId: 'microsoft-client-id',
97
+ clientSecret: 'microsoft-client-secret',
98
+ tenant: 'organizations',
99
+ allowedTenants: ['9188040d-6c67-4c5b-b112-36a304b66dad']
100
+ }
101
+ }
102
+ }
103
+ ],
104
+ oauthComponent: [
105
+ {
106
+ type: OAuthComponentType.Service,
107
+ options: {
108
+ config: {
109
+ successRedirectUrl: 'https://app.example.org/',
110
+ failureRedirectUrl: 'https://app.example.org/login'
111
+ }
112
+ }
113
+ }
114
+ ]
115
+ };
116
+
117
+ console.log(types.authenticationProvider?.length); // 3
118
+ ```
119
+
120
+ The OAuth component signs the sign in kept by the browser with the node signing key in the registered vault connector. Accounts created through a provider are given the default roles with the registered authorization component.
121
+
122
+ ## Organizations and Password Reset
123
+
124
+ The organization component registers organizations on the node, inside the tenant partition, and the authentication component sends password reset links through the registered messaging component.
125
+
126
+ ```typescript
127
+ import type { IEngineServerConfig } from '@3sixty/engine-server-types';
128
+ import {
129
+ AuthenticationComponentType,
130
+ OrganizationComponentType
131
+ } from '@3sixty/engine-server-types';
132
+
133
+ const types: Partial<IEngineServerConfig['types']> = {
134
+ authenticationComponent: [
135
+ {
136
+ type: AuthenticationComponentType.EntityStorage,
137
+ options: {
138
+ config: {
139
+ passwordResetUrl: 'https://app.example.org/reset-password',
140
+ registrationVerificationUrl: 'https://app.example.org/verify',
141
+ emailSender: 'no-reply@example.org'
142
+ }
143
+ }
144
+ }
145
+ ],
146
+ organizationComponent: [
147
+ {
148
+ type: OrganizationComponentType.EntityStorage,
149
+ options: { config: { verificationMethodId: 'trust-assertion' } }
150
+ }
151
+ ]
152
+ };
153
+
154
+ console.log(types.organizationComponent?.length); // 1
155
+ ```
@@ -0,0 +1,30 @@
1
+ # Function: initialiseAccountDataEntityStorage()
2
+
3
+ > **initialiseAccountDataEntityStorage**(`engineCore`, `context`, `storageType`): `void`
4
+
5
+ Initialise the entity storage of the account data, shared by every component that uses it so the
6
+ schema and partitions match.
7
+
8
+ ## Parameters
9
+
10
+ ### engineCore
11
+
12
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
13
+
14
+ The engine core.
15
+
16
+ ### context
17
+
18
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
19
+
20
+ The context for the engine.
21
+
22
+ ### storageType
23
+
24
+ `string` \| `undefined`
25
+
26
+ The configured storage type.
27
+
28
+ ## Returns
29
+
30
+ `void`
@@ -0,0 +1,31 @@
1
+ # Function: initialiseAuthenticationAccountAdminComponent()
2
+
3
+ > **initialiseAuthenticationAccountAdminComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationAccountAdminComponentConfig`](../type-aliases/AuthenticationAccountAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
4
+
5
+ Initialise the authentication account admin component.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`AuthenticationAccountAdminComponentConfig`](../type-aliases/AuthenticationAccountAdminComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `EngineTypeInitialiserReturn`\<[`AuthenticationAccountAdminComponentConfig`](../type-aliases/AuthenticationAccountAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseAuthenticationAccountComponent()
2
+
3
+ > **initialiseAuthenticationAccountComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationAccountComponentConfig`](../type-aliases/AuthenticationAccountComponentConfig.md), `Factory`\<`IComponent`\>\>
4
+
5
+ Initialise the authentication account component.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`AuthenticationAccountComponentConfig`](../type-aliases/AuthenticationAccountComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `EngineTypeInitialiserReturn`\<[`AuthenticationAccountComponentConfig`](../type-aliases/AuthenticationAccountComponentConfig.md), `Factory`\<`IComponent`\>\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,30 @@
1
+ # Function: initialiseAuthenticationPasswordResetEntityStorage()
2
+
3
+ > **initialiseAuthenticationPasswordResetEntityStorage**(`engineCore`, `context`, `storageType`): `void`
4
+
5
+ Initialise the entity storage of the password reset and sign up verification tokens, partitioned
6
+ like the accounts they belong to.
7
+
8
+ ## Parameters
9
+
10
+ ### engineCore
11
+
12
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
13
+
14
+ The engine core.
15
+
16
+ ### context
17
+
18
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
19
+
20
+ The context for the engine.
21
+
22
+ ### storageType
23
+
24
+ `string` \| `undefined`
25
+
26
+ The configured storage type.
27
+
28
+ ## Returns
29
+
30
+ `void`
@@ -0,0 +1,31 @@
1
+ # Function: initialiseAuthenticationProvider()
2
+
3
+ > **initialiseAuthenticationProvider**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`AuthenticationProviderConfig`](../type-aliases/AuthenticationProviderConfig.md), `Factory`\<`IAuthenticationProvider`\<`unknown`\>\>\>
4
+
5
+ Initialise an authentication provider, registered under its authentication provider id.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`AuthenticationProviderConfig`](../type-aliases/AuthenticationProviderConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `EngineTypeInitialiserReturn`\<[`AuthenticationProviderConfig`](../type-aliases/AuthenticationProviderConfig.md), `Factory`\<`IAuthenticationProvider`\<`unknown`\>\>\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,30 @@
1
+ # Function: initialiseAuthenticationUserEntityStorage()
2
+
3
+ > **initialiseAuthenticationUserEntityStorage**(`engineCore`, `context`, `storageType`): `void`
4
+
5
+ Initialise the entity storage of the authentication users, shared by every component that uses
6
+ it so the schema and partitions match.
7
+
8
+ ## Parameters
9
+
10
+ ### engineCore
11
+
12
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
13
+
14
+ The engine core.
15
+
16
+ ### context
17
+
18
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
19
+
20
+ The context for the engine.
21
+
22
+ ### storageType
23
+
24
+ `string` \| `undefined`
25
+
26
+ The configured storage type.
27
+
28
+ ## Returns
29
+
30
+ `void`
@@ -0,0 +1,31 @@
1
+ # Function: initialiseOAuthComponent()
2
+
3
+ > **initialiseOAuthComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`OAuthComponentConfig`](../type-aliases/OAuthComponentConfig.md), `Factory`\<`IComponent`\>\>
4
+
5
+ Initialise the OAuth sign in component.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`OAuthComponentConfig`](../type-aliases/OAuthComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `EngineTypeInitialiserReturn`\<[`OAuthComponentConfig`](../type-aliases/OAuthComponentConfig.md), `Factory`\<`IComponent`\>\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseOrganizationComponent()
2
+
3
+ > **initialiseOrganizationComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`OrganizationComponentConfig`](../type-aliases/OrganizationComponentConfig.md), `Factory`\<`IComponent`\>\>
4
+
5
+ Initialise the organization component.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`OrganizationComponentConfig`](../type-aliases/OrganizationComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `EngineTypeInitialiserReturn`\<[`OrganizationComponentConfig`](../type-aliases/OrganizationComponentConfig.md), `Factory`\<`IComponent`\>\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,31 @@
1
+ # Function: initialiseOrganizationEntityStorage()
2
+
3
+ > **initialiseOrganizationEntityStorage**(`engineCore`, `context`, `storageType`): `void`
4
+
5
+ Initialise the entity storage of the registered organizations, inside the tenant partition like
6
+ the accounts that join them. Every component that checks an organization is registered
7
+ initialises it, so the check never runs against missing storage.
8
+
9
+ ## Parameters
10
+
11
+ ### engineCore
12
+
13
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
14
+
15
+ The engine core.
16
+
17
+ ### context
18
+
19
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
20
+
21
+ The context for the engine.
22
+
23
+ ### storageType
24
+
25
+ `string` \| `undefined`
26
+
27
+ The configured storage type.
28
+
29
+ ## Returns
30
+
31
+ `void`
@@ -0,0 +1,31 @@
1
+ # Function: initialiseOrganizationRequestAdminComponent()
2
+
3
+ > **initialiseOrganizationRequestAdminComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`OrganizationRequestAdminComponentConfig`](../type-aliases/OrganizationRequestAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
4
+
5
+ Initialise the organization request admin component.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`OrganizationRequestAdminComponentConfig`](../type-aliases/OrganizationRequestAdminComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ## Returns
28
+
29
+ `EngineTypeInitialiserReturn`\<[`OrganizationRequestAdminComponentConfig`](../type-aliases/OrganizationRequestAdminComponentConfig.md), `Factory`\<`IComponent`\>\>
30
+
31
+ The instance created and the factory for it.
@@ -0,0 +1,30 @@
1
+ # Function: initialiseOrganizationRequestEntityStorage()
2
+
3
+ > **initialiseOrganizationRequestEntityStorage**(`engineCore`, `context`, `storageType`): `void`
4
+
5
+ Initialise the entity storage of the requests to join an organization, shared by every component
6
+ that uses it so the schema and partitions match.
7
+
8
+ ## Parameters
9
+
10
+ ### engineCore
11
+
12
+ `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
13
+
14
+ The engine core.
15
+
16
+ ### context
17
+
18
+ `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
19
+
20
+ The context for the engine.
21
+
22
+ ### storageType
23
+
24
+ `string` \| `undefined`
25
+
26
+ The configured storage type.
27
+
28
+ ## Returns
29
+
30
+ `void`
@@ -6,43 +6,72 @@
6
6
 
7
7
  ## Type Aliases
8
8
 
9
+ - [AuthenticationAccountAdminComponentConfig](type-aliases/AuthenticationAccountAdminComponentConfig.md)
10
+ - [AuthenticationAccountComponentConfig](type-aliases/AuthenticationAccountComponentConfig.md)
9
11
  - [AuthenticationAdminComponentConfig](type-aliases/AuthenticationAdminComponentConfig.md)
10
12
  - [AuthenticationAuditComponentConfig](type-aliases/AuthenticationAuditComponentConfig.md)
11
13
  - [AuthenticationComponentConfig](type-aliases/AuthenticationComponentConfig.md)
14
+ - [AuthenticationProviderConfig](type-aliases/AuthenticationProviderConfig.md)
12
15
  - [AuthenticationRateComponentConfig](type-aliases/AuthenticationRateComponentConfig.md)
13
16
  - [InformationComponentConfig](type-aliases/InformationComponentConfig.md)
14
17
  - [MimeTypeProcessorConfig](type-aliases/MimeTypeProcessorConfig.md)
18
+ - [OAuthComponentConfig](type-aliases/OAuthComponentConfig.md)
19
+ - [OrganizationComponentConfig](type-aliases/OrganizationComponentConfig.md)
20
+ - [OrganizationRequestAdminComponentConfig](type-aliases/OrganizationRequestAdminComponentConfig.md)
15
21
  - [RestRouteProcessorConfig](type-aliases/RestRouteProcessorConfig.md)
16
22
  - [SocketRouteProcessorConfig](type-aliases/SocketRouteProcessorConfig.md)
23
+ - [AuthenticationAccountAdminComponentType](type-aliases/AuthenticationAccountAdminComponentType.md)
24
+ - [AuthenticationAccountComponentType](type-aliases/AuthenticationAccountComponentType.md)
17
25
  - [AuthenticationAdminComponentType](type-aliases/AuthenticationAdminComponentType.md)
18
26
  - [AuthenticationAuditComponentType](type-aliases/AuthenticationAuditComponentType.md)
19
27
  - [AuthenticationComponentType](type-aliases/AuthenticationComponentType.md)
28
+ - [AuthenticationProviderType](type-aliases/AuthenticationProviderType.md)
20
29
  - [AuthenticationRateComponentType](type-aliases/AuthenticationRateComponentType.md)
21
30
  - [InformationComponentType](type-aliases/InformationComponentType.md)
22
31
  - [MimeTypeProcessorType](type-aliases/MimeTypeProcessorType.md)
32
+ - [OAuthComponentType](type-aliases/OAuthComponentType.md)
33
+ - [OrganizationComponentType](type-aliases/OrganizationComponentType.md)
34
+ - [OrganizationRequestAdminComponentType](type-aliases/OrganizationRequestAdminComponentType.md)
23
35
  - [RestRouteProcessorType](type-aliases/RestRouteProcessorType.md)
24
36
  - [SocketRouteProcessorType](type-aliases/SocketRouteProcessorType.md)
25
37
  - [WebServerType](type-aliases/WebServerType.md)
26
38
 
27
39
  ## Variables
28
40
 
41
+ - [AuthenticationAccountAdminComponentType](variables/AuthenticationAccountAdminComponentType.md)
42
+ - [AuthenticationAccountComponentType](variables/AuthenticationAccountComponentType.md)
29
43
  - [AuthenticationAdminComponentType](variables/AuthenticationAdminComponentType.md)
30
44
  - [AuthenticationAuditComponentType](variables/AuthenticationAuditComponentType.md)
31
45
  - [AuthenticationComponentType](variables/AuthenticationComponentType.md)
46
+ - [AuthenticationProviderType](variables/AuthenticationProviderType.md)
32
47
  - [AuthenticationRateComponentType](variables/AuthenticationRateComponentType.md)
33
48
  - [InformationComponentType](variables/InformationComponentType.md)
34
49
  - [MimeTypeProcessorType](variables/MimeTypeProcessorType.md)
50
+ - [OAuthComponentType](variables/OAuthComponentType.md)
51
+ - [OrganizationComponentType](variables/OrganizationComponentType.md)
52
+ - [OrganizationRequestAdminComponentType](variables/OrganizationRequestAdminComponentType.md)
35
53
  - [RestRouteProcessorType](variables/RestRouteProcessorType.md)
36
54
  - [SocketRouteProcessorType](variables/SocketRouteProcessorType.md)
37
55
  - [WebServerType](variables/WebServerType.md)
38
56
 
39
57
  ## Functions
40
58
 
59
+ - [initialiseAuthenticationUserEntityStorage](functions/initialiseAuthenticationUserEntityStorage.md)
60
+ - [initialiseAuthenticationPasswordResetEntityStorage](functions/initialiseAuthenticationPasswordResetEntityStorage.md)
41
61
  - [initialiseAuthenticationComponent](functions/initialiseAuthenticationComponent.md)
62
+ - [initialiseAccountDataEntityStorage](functions/initialiseAccountDataEntityStorage.md)
63
+ - [initialiseOrganizationRequestEntityStorage](functions/initialiseOrganizationRequestEntityStorage.md)
64
+ - [initialiseOrganizationEntityStorage](functions/initialiseOrganizationEntityStorage.md)
65
+ - [initialiseAuthenticationAccountComponent](functions/initialiseAuthenticationAccountComponent.md)
66
+ - [initialiseAuthenticationAccountAdminComponent](functions/initialiseAuthenticationAccountAdminComponent.md)
42
67
  - [initialiseAuthenticationAdminComponent](functions/initialiseAuthenticationAdminComponent.md)
43
68
  - [initialiseAuthenticationAuditComponent](functions/initialiseAuthenticationAuditComponent.md)
69
+ - [initialiseAuthenticationProvider](functions/initialiseAuthenticationProvider.md)
44
70
  - [initialiseAuthenticationRateComponent](functions/initialiseAuthenticationRateComponent.md)
45
71
  - [initialiseInformationComponent](functions/initialiseInformationComponent.md)
46
72
  - [initialiseMimeTypeProcessorComponent](functions/initialiseMimeTypeProcessorComponent.md)
73
+ - [initialiseOAuthComponent](functions/initialiseOAuthComponent.md)
74
+ - [initialiseOrganizationComponent](functions/initialiseOrganizationComponent.md)
75
+ - [initialiseOrganizationRequestAdminComponent](functions/initialiseOrganizationRequestAdminComponent.md)
47
76
  - [initialiseRestRouteProcessorComponent](functions/initialiseRestRouteProcessorComponent.md)
48
77
  - [initialiseSocketRouteProcessorComponent](functions/initialiseSocketRouteProcessorComponent.md)
@@ -678,6 +678,42 @@ Authentication component options which can be overridden by individual component
678
678
 
679
679
  Authentication admin component options which can be overridden by individual components by specifying types other than default.
680
680
 
681
+ ##### authenticationProvider?
682
+
683
+ > `optional` **authenticationProvider?**: `IEngineCoreTypeConfig`\<[`AuthenticationProviderConfig`](../type-aliases/AuthenticationProviderConfig.md)\>[]
684
+
685
+ Authentication providers, each registered under its authentication provider id.
686
+
687
+ ##### authenticationAccountComponent?
688
+
689
+ > `optional` **authenticationAccountComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationAccountComponentConfig`](../type-aliases/AuthenticationAccountComponentConfig.md)\>[]
690
+
691
+ Authentication account component options, for the data stored against the signed in account.
692
+
693
+ ##### authenticationAccountAdminComponent?
694
+
695
+ > `optional` **authenticationAccountAdminComponent?**: `IEngineCoreTypeConfig`\<[`AuthenticationAccountAdminComponentConfig`](../type-aliases/AuthenticationAccountAdminComponentConfig.md)\>[]
696
+
697
+ Authentication account admin component options, for the data stored against any account.
698
+
699
+ ##### organizationRequestAdminComponent?
700
+
701
+ > `optional` **organizationRequestAdminComponent?**: `IEngineCoreTypeConfig`\<[`OrganizationRequestAdminComponentConfig`](../type-aliases/OrganizationRequestAdminComponentConfig.md)\>[]
702
+
703
+ Organization request admin component options, for reviewing the requests to join an organization.
704
+
705
+ ##### organizationComponent?
706
+
707
+ > `optional` **organizationComponent?**: `IEngineCoreTypeConfig`\<[`OrganizationComponentConfig`](../type-aliases/OrganizationComponentConfig.md)\>[]
708
+
709
+ Organization component options, for the organizations registered on the node and their profiles.
710
+
711
+ ##### oauthComponent?
712
+
713
+ > `optional` **oauthComponent?**: `IEngineCoreTypeConfig`\<[`OAuthComponentConfig`](../type-aliases/OAuthComponentConfig.md)\>[]
714
+
715
+ OAuth sign in component options which can be overridden by individual components by specifying types other than default.
716
+
681
717
  #### Overrides
682
718
 
683
719
  `IEngineConfig.types`
@@ -0,0 +1,5 @@
1
+ # Type Alias: AuthenticationAccountAdminComponentConfig
2
+
3
+ > **AuthenticationAccountAdminComponentConfig** = \{ `type`: *typeof* [`EntityStorage`](../variables/AuthenticationAccountAdminComponentType.md#entitystorage); `options?`: `IEntityStorageAuthenticationAccountAdminServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/AuthenticationAccountAdminComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
4
+
5
+ Authentication account admin component config types.
@@ -0,0 +1,5 @@
1
+ # Type Alias: AuthenticationAccountAdminComponentType
2
+
3
+ > **AuthenticationAccountAdminComponentType** = *typeof* [`AuthenticationAccountAdminComponentType`](../variables/AuthenticationAccountAdminComponentType.md)\[keyof *typeof* [`AuthenticationAccountAdminComponentType`](../variables/AuthenticationAccountAdminComponentType.md)\]
4
+
5
+ Authentication account admin component types.
@@ -0,0 +1,5 @@
1
+ # Type Alias: AuthenticationAccountComponentConfig
2
+
3
+ > **AuthenticationAccountComponentConfig** = \{ `type`: *typeof* [`EntityStorage`](../variables/AuthenticationAccountComponentType.md#entitystorage); `options?`: `IEntityStorageAuthenticationAccountServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/AuthenticationAccountComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
4
+
5
+ Authentication account component config types.
@@ -0,0 +1,5 @@
1
+ # Type Alias: AuthenticationAccountComponentType
2
+
3
+ > **AuthenticationAccountComponentType** = *typeof* [`AuthenticationAccountComponentType`](../variables/AuthenticationAccountComponentType.md)\[keyof *typeof* [`AuthenticationAccountComponentType`](../variables/AuthenticationAccountComponentType.md)\]
4
+
5
+ Authentication account component types.
@@ -0,0 +1,5 @@
1
+ # Type Alias: AuthenticationProviderConfig
2
+
3
+ > **AuthenticationProviderConfig** = \{ `type`: *typeof* [`EntityStorage`](../variables/AuthenticationProviderType.md#entitystorage); `options?`: `IEntityStorageAuthenticationProviderConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`Google`](../variables/AuthenticationProviderType.md#google); `options`: `IGoogleOAuthProviderConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`Microsoft`](../variables/AuthenticationProviderType.md#microsoft); `options`: `IMicrosoftOAuthProviderConnectorConstructorOptions`; \}
4
+
5
+ Authentication provider config types.
@@ -0,0 +1,5 @@
1
+ # Type Alias: AuthenticationProviderType
2
+
3
+ > **AuthenticationProviderType** = *typeof* [`AuthenticationProviderType`](../variables/AuthenticationProviderType.md)\[keyof *typeof* [`AuthenticationProviderType`](../variables/AuthenticationProviderType.md)\]
4
+
5
+ Authentication provider types.
@@ -0,0 +1,17 @@
1
+ # Type Alias: OAuthComponentConfig
2
+
3
+ > **OAuthComponentConfig** = `object`
4
+
5
+ OAuth component config types.
6
+
7
+ ## Properties
8
+
9
+ ### type {#type}
10
+
11
+ > **type**: *typeof* [`Service`](../variables/OAuthComponentType.md#service)
12
+
13
+ ***
14
+
15
+ ### options {#options}
16
+
17
+ > **options**: `IOAuthServiceConstructorOptions`
@@ -0,0 +1,5 @@
1
+ # Type Alias: OAuthComponentType
2
+
3
+ > **OAuthComponentType** = *typeof* [`OAuthComponentType`](../variables/OAuthComponentType.md)\[keyof *typeof* [`OAuthComponentType`](../variables/OAuthComponentType.md)\]
4
+
5
+ OAuth component types.