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

package/dist/es/models/types/restRouteProcessorType.js

@@ -1,4 +1,5 @@
 // Copyright 2024 IOTA Stiftung.
+// Copyright 2026 3Sixty Trade Ltd.
 // SPDX-License-Identifier: Apache-2.0.
 /**
  * REST route processor types.
@@ -9,6 +10,10 @@ export const RestRouteProcessorType = {
      * Auth header.
      */
     AuthHeader: "auth-header",
+    /**
+     * Authentication account, sets the identity and organization of the signed in account.
+     */
+    AuthenticationAccount: "authentication-account",
     /**
      * Logging.
      */
@@ -48,6 +53,10 @@ export const RestRouteProcessorType = {
     /**
      * Authorization.
      */
-    Authorization: "authorization"
+    Authorization: "authorization",
+    /**
+     * Origin check, rejects cookie authenticated state changing requests from other origins.
+     */
+    OriginCheck: "origin-check"
 };
 //# sourceMappingURL=restRouteProcessorType.js.map

package/dist/es/models/types/restRouteProcessorType.js.map

@@ -1 +1 @@
-{"version":3,"file":"restRouteProcessorType.js","sources":["../../../../src/models/types/restRouteProcessorType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC;;OAEG;IACH,UAAU,EAAE,aAAa;IAEzB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,SAAS,EAAE,YAAY;IAEvB;;OAEG;IACH,eAAe,EAAE,mBAAmB;IAEpC;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,YAAY,EAAE,eAAe;IAE7B;;OAEG;IACH,cAAc,EAAE,iBAAiB;IAEjC;;OAEG;IACH,SAAS,EAAE,YAAY;IAEvB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,aAAa,EAAE,eAAe;CACrB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * REST route processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const RestRouteProcessorType = {\n\t/**\n\t * Auth header.\n\t */\n\tAuthHeader: \"auth-header\",\n\n\t/**\n\t * Logging.\n\t */\n\tLogging: \"logging\",\n\n\t/**\n\t * Context ID.\n\t */\n\tContextId: \"context-id\",\n\n\t/**\n\t * Static Context ID.\n\t */\n\tStaticContextId: \"static-context-id\",\n\n\t/**\n\t * Tenant.\n\t */\n\tTenant: \"tenant\",\n\n\t/**\n\t * Single Tenant.\n\t */\n\tSingleTenant: \"single-tenant\",\n\n\t/**\n\t * Tenant override.\n\t */\n\tTenantOverride: \"tenant-override\",\n\n\t/**\n\t * REST Route.\n\t */\n\tRestRoute: \"rest-route\",\n\n\t/**\n\t * Metrics.\n\t */\n\tMetrics: \"metrics\",\n\n\t/**\n\t * Tracing.\n\t */\n\tTracing: \"tracing\",\n\n\t/**\n\t * Authorization.\n\t */\n\tAuthorization: \"authorization\"\n} as const;\n\n/**\n * REST route processor types.\n */\nexport type RestRouteProcessorType =\n\t(typeof RestRouteProcessorType)[keyof typeof RestRouteProcessorType];\n"]}
+{"version":3,"file":"restRouteProcessorType.js","sources":["../../../../src/models/types/restRouteProcessorType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,mCAAmC;AACnC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC;;OAEG;IACH,UAAU,EAAE,aAAa;IAEzB;;OAEG;IACH,qBAAqB,EAAE,wBAAwB;IAE/C;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,SAAS,EAAE,YAAY;IAEvB;;OAEG;IACH,eAAe,EAAE,mBAAmB;IAEpC;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,YAAY,EAAE,eAAe;IAE7B;;OAEG;IACH,cAAc,EAAE,iBAAiB;IAEjC;;OAEG;IACH,SAAS,EAAE,YAAY;IAEvB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,aAAa,EAAE,eAAe;IAE9B;;OAEG;IACH,WAAW,EAAE,cAAc;CAClB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// Copyright 2026 3Sixty Trade Ltd.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * REST route processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const RestRouteProcessorType = {\n\t/**\n\t * Auth header.\n\t */\n\tAuthHeader: \"auth-header\",\n\n\t/**\n\t * Authentication account, sets the identity and organization of the signed in account.\n\t */\n\tAuthenticationAccount: \"authentication-account\",\n\n\t/**\n\t * Logging.\n\t */\n\tLogging: \"logging\",\n\n\t/**\n\t * Context ID.\n\t */\n\tContextId: \"context-id\",\n\n\t/**\n\t * Static Context ID.\n\t */\n\tStaticContextId: \"static-context-id\",\n\n\t/**\n\t * Tenant.\n\t */\n\tTenant: \"tenant\",\n\n\t/**\n\t * Single Tenant.\n\t */\n\tSingleTenant: \"single-tenant\",\n\n\t/**\n\t * Tenant override.\n\t */\n\tTenantOverride: \"tenant-override\",\n\n\t/**\n\t * REST Route.\n\t */\n\tRestRoute: \"rest-route\",\n\n\t/**\n\t * Metrics.\n\t */\n\tMetrics: \"metrics\",\n\n\t/**\n\t * Tracing.\n\t */\n\tTracing: \"tracing\",\n\n\t/**\n\t * Authorization.\n\t */\n\tAuthorization: \"authorization\",\n\n\t/**\n\t * Origin check, rejects cookie authenticated state changing requests from other origins.\n\t */\n\tOriginCheck: \"origin-check\"\n} as const;\n\n/**\n * REST route processor types.\n */\nexport type RestRouteProcessorType =\n\t(typeof RestRouteProcessorType)[keyof typeof RestRouteProcessorType];\n"]}

package/dist/es/models/types/socketRouteProcessorType.js

@@ -1,4 +1,5 @@
 // Copyright 2024 IOTA Stiftung.
+// Copyright 2026 3Sixty Trade Ltd.
 // SPDX-License-Identifier: Apache-2.0.
 /**
  * Socket route processor types.
@@ -9,6 +10,10 @@ export const SocketRouteProcessorType = {
      * Auth header.
      */
     AuthHeader: "auth-header",
+    /**
+     * Authentication account, sets the identity and organization of the signed in account.
+     */
+    AuthenticationAccount: "authentication-account",
     /**
      * Logging.
      */
@@ -40,6 +45,10 @@ export const SocketRouteProcessorType = {
     /**
      * Authorization.
      */
-    Authorization: "authorization"
+    Authorization: "authorization",
+    /**
+     * Origin check, rejects cookie authenticated socket connections from other origins.
+     */
+    OriginCheck: "origin-check"
 };
 //# sourceMappingURL=socketRouteProcessorType.js.map

package/dist/es/models/types/socketRouteProcessorType.js.map

@@ -1 +1 @@
-{"version":3,"file":"socketRouteProcessorType.js","sources":["../../../../src/models/types/socketRouteProcessorType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACvC;;OAEG;IACH,UAAU,EAAE,aAAa;IAEzB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,SAAS,EAAE,YAAY;IAEvB;;OAEG;IACH,eAAe,EAAE,mBAAmB;IAEpC;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,YAAY,EAAE,eAAe;IAE7B;;OAEG;IACH,cAAc,EAAE,iBAAiB;IAEjC;;OAEG;IACH,WAAW,EAAE,cAAc;IAE3B;;OAEG;IACH,aAAa,EAAE,eAAe;CACrB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Socket route processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SocketRouteProcessorType = {\n\t/**\n\t * Auth header.\n\t */\n\tAuthHeader: \"auth-header\",\n\n\t/**\n\t * Logging.\n\t */\n\tLogging: \"logging\",\n\n\t/**\n\t * Context ID.\n\t */\n\tContextId: \"context-id\",\n\n\t/**\n\t * Static Context ID.\n\t */\n\tStaticContextId: \"static-context-id\",\n\n\t/**\n\t * Tenant.\n\t */\n\tTenant: \"tenant\",\n\n\t/**\n\t * Single Tenant.\n\t */\n\tSingleTenant: \"single-tenant\",\n\n\t/**\n\t * Tenant override.\n\t */\n\tTenantOverride: \"tenant-override\",\n\n\t/**\n\t * Socket Route.\n\t */\n\tSocketRoute: \"socket-route\",\n\n\t/**\n\t * Authorization.\n\t */\n\tAuthorization: \"authorization\"\n} as const;\n\n/**\n * Socket route processor types.\n */\nexport type SocketRouteProcessorType =\n\t(typeof SocketRouteProcessorType)[keyof typeof SocketRouteProcessorType];\n"]}
+{"version":3,"file":"socketRouteProcessorType.js","sources":["../../../../src/models/types/socketRouteProcessorType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,mCAAmC;AACnC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACvC;;OAEG;IACH,UAAU,EAAE,aAAa;IAEzB;;OAEG;IACH,qBAAqB,EAAE,wBAAwB;IAE/C;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,SAAS,EAAE,YAAY;IAEvB;;OAEG;IACH,eAAe,EAAE,mBAAmB;IAEpC;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,YAAY,EAAE,eAAe;IAE7B;;OAEG;IACH,cAAc,EAAE,iBAAiB;IAEjC;;OAEG;IACH,WAAW,EAAE,cAAc;IAE3B;;OAEG;IACH,aAAa,EAAE,eAAe;IAE9B;;OAEG;IACH,WAAW,EAAE,cAAc;CAClB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// Copyright 2026 3Sixty Trade Ltd.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Socket route processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SocketRouteProcessorType = {\n\t/**\n\t * Auth header.\n\t */\n\tAuthHeader: \"auth-header\",\n\n\t/**\n\t * Authentication account, sets the identity and organization of the signed in account.\n\t */\n\tAuthenticationAccount: \"authentication-account\",\n\n\t/**\n\t * Logging.\n\t */\n\tLogging: \"logging\",\n\n\t/**\n\t * Context ID.\n\t */\n\tContextId: \"context-id\",\n\n\t/**\n\t * Static Context ID.\n\t */\n\tStaticContextId: \"static-context-id\",\n\n\t/**\n\t * Tenant.\n\t */\n\tTenant: \"tenant\",\n\n\t/**\n\t * Single Tenant.\n\t */\n\tSingleTenant: \"single-tenant\",\n\n\t/**\n\t * Tenant override.\n\t */\n\tTenantOverride: \"tenant-override\",\n\n\t/**\n\t * Socket Route.\n\t */\n\tSocketRoute: \"socket-route\",\n\n\t/**\n\t * Authorization.\n\t */\n\tAuthorization: \"authorization\",\n\n\t/**\n\t * Origin check, rejects cookie authenticated socket connections from other origins.\n\t */\n\tOriginCheck: \"origin-check\"\n} as const;\n\n/**\n * Socket route processor types.\n */\nexport type SocketRouteProcessorType =\n\t(typeof SocketRouteProcessorType)[keyof typeof SocketRouteProcessorType];\n"]}

package/dist/types/components/authentication.d.ts

@@ -2,6 +2,22 @@ import { ComponentFactory } from "@3sixty/core";
 import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@3sixty/engine-models";
 import type { AuthenticationComponentConfig } from "../models/config/authenticationComponentConfig.js";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
+/**
+ * Initialise the entity storage of the authentication users, shared by every component that uses
+ * it so the schema and partitions match.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param storageType The configured storage type.
+ */
+export declare function initialiseAuthenticationUserEntityStorage(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, storageType: string | undefined): void;
+/**
+ * Initialise the entity storage of the password reset and sign up verification tokens, partitioned
+ * like the accounts they belong to.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param storageType The configured storage type.
+ */
+export declare function initialiseAuthenticationPasswordResetEntityStorage(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, storageType: string | undefined): void;
 /**
  * Initialise the authentication component.
  * @param engineCore The engine core.

package/dist/types/components/authenticationAccount.d.ts

@@ -0,0 +1,37 @@
+import { ComponentFactory } from "@3sixty/core";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@3sixty/engine-models";
+import type { AuthenticationAccountComponentConfig } from "../models/config/authenticationAccountComponentConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
+/**
+ * Initialise the entity storage of the account data, shared by every component that uses it so the
+ * schema and partitions match.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param storageType The configured storage type.
+ */
+export declare function initialiseAccountDataEntityStorage(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, storageType: string | undefined): void;
+/**
+ * Initialise the entity storage of the requests to join an organization, shared by every component
+ * that uses it so the schema and partitions match.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param storageType The configured storage type.
+ */
+export declare function initialiseOrganizationRequestEntityStorage(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, storageType: string | undefined): void;
+/**
+ * Initialise the entity storage of the registered organizations, inside the tenant partition like
+ * the accounts that join them. Every component that checks an organization is registered
+ * initialises it, so the check never runs against missing storage.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param storageType The configured storage type.
+ */
+export declare function initialiseOrganizationEntityStorage(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, storageType: string | undefined): void;
+/**
+ * Initialise the authentication account component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export declare function initialiseAuthenticationAccountComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAccountComponentConfig): EngineTypeInitialiserReturn<AuthenticationAccountComponentConfig, typeof ComponentFactory>;

package/dist/types/components/authenticationAccountAdmin.d.ts

@@ -0,0 +1,12 @@
+import { ComponentFactory } from "@3sixty/core";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@3sixty/engine-models";
+import type { AuthenticationAccountAdminComponentConfig } from "../models/config/authenticationAccountAdminComponentConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
+/**
+ * Initialise the authentication account admin component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export declare function initialiseAuthenticationAccountAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAccountAdminComponentConfig): EngineTypeInitialiserReturn<AuthenticationAccountAdminComponentConfig, typeof ComponentFactory>;

package/dist/types/components/authenticationProvider.d.ts

@@ -0,0 +1,12 @@
+import { AuthenticationProviderFactory } from "@3sixty/api-auth-models";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@3sixty/engine-models";
+import type { AuthenticationProviderConfig } from "../models/config/authenticationProviderConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
+/**
+ * Initialise an authentication provider, registered under its authentication provider id.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export declare function initialiseAuthenticationProvider(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationProviderConfig): EngineTypeInitialiserReturn<AuthenticationProviderConfig, typeof AuthenticationProviderFactory>;

package/dist/types/components/oauth.d.ts

@@ -0,0 +1,12 @@
+import { ComponentFactory } from "@3sixty/core";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@3sixty/engine-models";
+import type { OAuthComponentConfig } from "../models/config/oauthComponentConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
+/**
+ * Initialise the OAuth sign in component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export declare function initialiseOAuthComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: OAuthComponentConfig): EngineTypeInitialiserReturn<OAuthComponentConfig, typeof ComponentFactory>;

package/dist/types/components/organization.d.ts

@@ -0,0 +1,12 @@
+import { ComponentFactory } from "@3sixty/core";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@3sixty/engine-models";
+import type { OrganizationComponentConfig } from "../models/config/organizationComponentConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
+/**
+ * Initialise the organization component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export declare function initialiseOrganizationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: OrganizationComponentConfig): EngineTypeInitialiserReturn<OrganizationComponentConfig, typeof ComponentFactory>;

package/dist/types/components/organizationRequestAdmin.d.ts

@@ -0,0 +1,12 @@
+import { ComponentFactory } from "@3sixty/core";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@3sixty/engine-models";
+import type { OrganizationRequestAdminComponentConfig } from "../models/config/organizationRequestAdminComponentConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
+/**
+ * Initialise the organization request admin component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export declare function initialiseOrganizationRequestAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: OrganizationRequestAdminComponentConfig): EngineTypeInitialiserReturn<OrganizationRequestAdminComponentConfig, typeof ComponentFactory>;

package/dist/types/index.d.ts

@@ -1,26 +1,44 @@
 export * from "./components/authentication.js";
+export * from "./components/authenticationAccount.js";
+export * from "./components/authenticationAccountAdmin.js";
 export * from "./components/authenticationAdmin.js";
 export * from "./components/authenticationAudit.js";
+export * from "./components/authenticationProvider.js";
 export * from "./components/authenticationRate.js";
 export * from "./components/information.js";
 export * from "./components/mimeTypeProcessor.js";
+export * from "./components/oauth.js";
+export * from "./components/organization.js";
+export * from "./components/organizationRequestAdmin.js";
 export * from "./components/restRouteProcessor.js";
 export * from "./components/socketRouteProcessor.js";
+export * from "./models/config/authenticationAccountAdminComponentConfig.js";
+export * from "./models/config/authenticationAccountComponentConfig.js";
 export * from "./models/config/authenticationAdminComponentConfig.js";
 export * from "./models/config/authenticationAuditComponentConfig.js";
 export * from "./models/config/authenticationComponentConfig.js";
+export * from "./models/config/authenticationProviderConfig.js";
 export * from "./models/config/authenticationRateComponentConfig.js";
 export * from "./models/config/informationComponentConfig.js";
 export * from "./models/config/mimeTypeProcessorConfig.js";
+export * from "./models/config/oauthComponentConfig.js";
+export * from "./models/config/organizationComponentConfig.js";
+export * from "./models/config/organizationRequestAdminComponentConfig.js";
 export * from "./models/config/restRouteProcessorConfig.js";
 export * from "./models/config/socketRouteProcessorConfig.js";
 export * from "./models/IEngineServerConfig.js";
+export * from "./models/types/authenticationAccountAdminComponentType.js";
+export * from "./models/types/authenticationAccountComponentType.js";
 export * from "./models/types/authenticationAdminComponentType.js";
 export * from "./models/types/authenticationAuditComponentType.js";
 export * from "./models/types/authenticationComponentType.js";
+export * from "./models/types/authenticationProviderType.js";
 export * from "./models/types/authenticationRateComponentType.js";
 export * from "./models/types/informationComponentType.js";
 export * from "./models/types/mimeTypeProcessorType.js";
+export * from "./models/types/oauthComponentType.js";
+export * from "./models/types/organizationComponentType.js";
+export * from "./models/types/organizationRequestAdminComponentType.js";
 export * from "./models/types/restRouteProcessorType.js";
 export * from "./models/types/socketRouteProcessorType.js";
 export * from "./models/types/webServerType.js";

package/dist/types/models/IEngineServerConfig.d.ts

@@ -1,12 +1,18 @@
 import type { IWebServerOptions } from "@3sixty/api-models";
 import type { IEngineCoreTypeConfig } from "@3sixty/engine-models";
 import type { IEngineConfig } from "@3sixty/engine-types";
+import type { AuthenticationAccountAdminComponentConfig } from "./config/authenticationAccountAdminComponentConfig.js";
+import type { AuthenticationAccountComponentConfig } from "./config/authenticationAccountComponentConfig.js";
 import type { AuthenticationAdminComponentConfig } from "./config/authenticationAdminComponentConfig.js";
 import type { AuthenticationAuditComponentConfig } from "./config/authenticationAuditComponentConfig.js";
 import type { AuthenticationComponentConfig } from "./config/authenticationComponentConfig.js";
+import type { AuthenticationProviderConfig } from "./config/authenticationProviderConfig.js";
 import type { AuthenticationRateComponentConfig } from "./config/authenticationRateComponentConfig.js";
 import type { InformationComponentConfig } from "./config/informationComponentConfig.js";
 import type { MimeTypeProcessorConfig } from "./config/mimeTypeProcessorConfig.js";
+import type { OAuthComponentConfig } from "./config/oauthComponentConfig.js";
+import type { OrganizationComponentConfig } from "./config/organizationComponentConfig.js";
+import type { OrganizationRequestAdminComponentConfig } from "./config/organizationRequestAdminComponentConfig.js";
 import type { RestRouteProcessorConfig } from "./config/restRouteProcessorConfig.js";
 import type { SocketRouteProcessorConfig } from "./config/socketRouteProcessorConfig.js";
 import type { WebServerType } from "./types/webServerType.js";
@@ -60,5 +66,29 @@ export interface IEngineServerConfig extends IEngineConfig {
          * Authentication admin component options which can be overridden by individual components by specifying types other than default.
          */
         authenticationAdminComponent?: IEngineCoreTypeConfig<AuthenticationAdminComponentConfig>[];
+        /**
+         * Authentication providers, each registered under its authentication provider id.
+         */
+        authenticationProvider?: IEngineCoreTypeConfig<AuthenticationProviderConfig>[];
+        /**
+         * Authentication account component options, for the data stored against the signed in account.
+         */
+        authenticationAccountComponent?: IEngineCoreTypeConfig<AuthenticationAccountComponentConfig>[];
+        /**
+         * Authentication account admin component options, for the data stored against any account.
+         */
+        authenticationAccountAdminComponent?: IEngineCoreTypeConfig<AuthenticationAccountAdminComponentConfig>[];
+        /**
+         * Organization request admin component options, for reviewing the requests to join an organization.
+         */
+        organizationRequestAdminComponent?: IEngineCoreTypeConfig<OrganizationRequestAdminComponentConfig>[];
+        /**
+         * Organization component options, for the organizations registered on the node and their profiles.
+         */
+        organizationComponent?: IEngineCoreTypeConfig<OrganizationComponentConfig>[];
+        /**
+         * OAuth sign in component options which can be overridden by individual components by specifying types other than default.
+         */
+        oauthComponent?: IEngineCoreTypeConfig<OAuthComponentConfig>[];
     };
 }

package/dist/types/models/config/authenticationAccountAdminComponentConfig.d.ts

@@ -0,0 +1,13 @@
+import type { IEntityStorageAuthenticationAccountAdminServiceConstructorOptions } from "@3sixty/api-auth-account-service";
+import type { IBaseRestClientConfig } from "@3sixty/api-models";
+import type { AuthenticationAccountAdminComponentType } from "../types/authenticationAccountAdminComponentType.js";
+/**
+ * Authentication account admin component config types.
+ */
+export type AuthenticationAccountAdminComponentConfig = {
+    type: typeof AuthenticationAccountAdminComponentType.EntityStorage;
+    options?: IEntityStorageAuthenticationAccountAdminServiceConstructorOptions;
+} | {
+    type: typeof AuthenticationAccountAdminComponentType.RestClient;
+    options: IBaseRestClientConfig;
+};

package/dist/types/models/config/authenticationAccountComponentConfig.d.ts

@@ -0,0 +1,13 @@
+import type { IEntityStorageAuthenticationAccountServiceConstructorOptions } from "@3sixty/api-auth-account-service";
+import type { IBaseRestClientConfig } from "@3sixty/api-models";
+import type { AuthenticationAccountComponentType } from "../types/authenticationAccountComponentType.js";
+/**
+ * Authentication account component config types.
+ */
+export type AuthenticationAccountComponentConfig = {
+    type: typeof AuthenticationAccountComponentType.EntityStorage;
+    options?: IEntityStorageAuthenticationAccountServiceConstructorOptions;
+} | {
+    type: typeof AuthenticationAccountComponentType.RestClient;
+    options: IBaseRestClientConfig;
+};

package/dist/types/models/config/authenticationProviderConfig.d.ts

@@ -0,0 +1,17 @@
+import type { IEntityStorageAuthenticationProviderConnectorConstructorOptions } from "@3sixty/api-auth-connector-entity-storage";
+import type { IGoogleOAuthProviderConnectorConstructorOptions } from "@3sixty/api-auth-oauth-connector-google";
+import type { IMicrosoftOAuthProviderConnectorConstructorOptions } from "@3sixty/api-auth-oauth-connector-microsoft";
+import type { AuthenticationProviderType } from "../types/authenticationProviderType.js";
+/**
+ * Authentication provider config types.
+ */
+export type AuthenticationProviderConfig = {
+    type: typeof AuthenticationProviderType.EntityStorage;
+    options?: IEntityStorageAuthenticationProviderConnectorConstructorOptions;
+} | {
+    type: typeof AuthenticationProviderType.Google;
+    options: IGoogleOAuthProviderConnectorConstructorOptions;
+} | {
+    type: typeof AuthenticationProviderType.Microsoft;
+    options: IMicrosoftOAuthProviderConnectorConstructorOptions;
+};

package/dist/types/models/config/oauthComponentConfig.d.ts

@@ -0,0 +1,9 @@
+import type { IOAuthServiceConstructorOptions } from "@3sixty/api-auth-oauth-service";
+import type { OAuthComponentType } from "../types/oauthComponentType.js";
+/**
+ * OAuth component config types.
+ */
+export type OAuthComponentConfig = {
+    type: typeof OAuthComponentType.Service;
+    options: IOAuthServiceConstructorOptions;
+};

package/dist/types/models/config/organizationComponentConfig.d.ts

@@ -0,0 +1,13 @@
+import type { IEntityStorageOrganizationServiceConstructorOptions } from "@3sixty/api-auth-account-service";
+import type { IBaseRestClientConfig } from "@3sixty/api-models";
+import type { OrganizationComponentType } from "../types/organizationComponentType.js";
+/**
+ * Organization component config types.
+ */
+export type OrganizationComponentConfig = {
+    type: typeof OrganizationComponentType.EntityStorage;
+    options?: IEntityStorageOrganizationServiceConstructorOptions;
+} | {
+    type: typeof OrganizationComponentType.RestClient;
+    options: IBaseRestClientConfig;
+};

package/dist/types/models/config/organizationRequestAdminComponentConfig.d.ts

@@ -0,0 +1,13 @@
+import type { IEntityStorageOrganizationRequestAdminServiceConstructorOptions } from "@3sixty/api-auth-account-service";
+import type { IBaseRestClientConfig } from "@3sixty/api-models";
+import type { OrganizationRequestAdminComponentType } from "../types/organizationRequestAdminComponentType.js";
+/**
+ * Organization request admin component config types.
+ */
+export type OrganizationRequestAdminComponentConfig = {
+    type: typeof OrganizationRequestAdminComponentType.EntityStorage;
+    options?: IEntityStorageOrganizationRequestAdminServiceConstructorOptions;
+} | {
+    type: typeof OrganizationRequestAdminComponentType.RestClient;
+    options: IBaseRestClientConfig;
+};

package/dist/types/models/config/restRouteProcessorConfig.d.ts

@@ -1,6 +1,7 @@
+import type { IAuthenticationAccountProcessorConstructorOptions } from "@3sixty/api-auth-account-service";
 import type { IAuthHeaderProcessorConstructorOptions } from "@3sixty/api-auth-entity-storage-service";
 import type { ITenantOverrideProcessorConstructorOptions } from "@3sixty/api-auth-service";
-import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, IRestRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@3sixty/api-processors";
+import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, IOriginCheckProcessorConstructorOptions, IRestRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@3sixty/api-processors";
 import type { ISingleTenantProcessorConstructorOptions, ITenantProcessorConstructorOptions } from "@3sixty/api-tenant-processor";
 import type { IAuthorizationRouteProcessorConstructorOptions } from "@3sixty/authorization-service";
 import type { IMetricsRouteProcessorConstructorOptions } from "@3sixty/telemetry-processors";
@@ -12,6 +13,9 @@ import type { RestRouteProcessorType } from "../types/restRouteProcessorType.js"
 export type RestRouteProcessorConfig = {
     type: typeof RestRouteProcessorType.AuthHeader;
     options?: IAuthHeaderProcessorConstructorOptions;
+} | {
+    type: typeof RestRouteProcessorType.AuthenticationAccount;
+    options?: IAuthenticationAccountProcessorConstructorOptions;
 } | {
     type: typeof RestRouteProcessorType.Logging;
     options?: ILoggingProcessorConstructorOptions;
@@ -42,4 +46,7 @@ export type RestRouteProcessorConfig = {
 } | {
     type: typeof RestRouteProcessorType.Authorization;
     options?: IAuthorizationRouteProcessorConstructorOptions;
+} | {
+    type: typeof RestRouteProcessorType.OriginCheck;
+    options?: IOriginCheckProcessorConstructorOptions;
 };

package/dist/types/models/config/socketRouteProcessorConfig.d.ts

@@ -1,6 +1,7 @@
+import type { IAuthenticationAccountProcessorConstructorOptions } from "@3sixty/api-auth-account-service";
 import type { IAuthHeaderProcessorConstructorOptions } from "@3sixty/api-auth-entity-storage-service";
 import type { ITenantOverrideProcessorConstructorOptions } from "@3sixty/api-auth-service";
-import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, ISocketRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@3sixty/api-processors";
+import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, IOriginCheckProcessorConstructorOptions, ISocketRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@3sixty/api-processors";
 import type { ISingleTenantProcessorConstructorOptions, ITenantProcessorConstructorOptions } from "@3sixty/api-tenant-processor";
 import type { IAuthorizationRouteProcessorConstructorOptions } from "@3sixty/authorization-service";
 import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType.js";
@@ -10,6 +11,9 @@ import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType
 export type SocketRouteProcessorConfig = {
     type: typeof SocketRouteProcessorType.AuthHeader;
     options?: IAuthHeaderProcessorConstructorOptions;
+} | {
+    type: typeof SocketRouteProcessorType.AuthenticationAccount;
+    options?: IAuthenticationAccountProcessorConstructorOptions;
 } | {
     type: typeof SocketRouteProcessorType.Logging;
     options?: ILoggingProcessorConstructorOptions;
@@ -34,4 +38,7 @@ export type SocketRouteProcessorConfig = {
 } | {
     type: typeof SocketRouteProcessorType.Authorization;
     options?: IAuthorizationRouteProcessorConstructorOptions;
+} | {
+    type: typeof SocketRouteProcessorType.OriginCheck;
+    options?: IOriginCheckProcessorConstructorOptions;
 };

package/dist/types/models/types/authenticationAccountAdminComponentType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Authentication account admin component types.
+ */
+export declare const AuthenticationAccountAdminComponentType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
+};
+/**
+ * Authentication account admin component types.
+ */
+export type AuthenticationAccountAdminComponentType = (typeof AuthenticationAccountAdminComponentType)[keyof typeof AuthenticationAccountAdminComponentType];

package/dist/types/models/types/authenticationAccountComponentType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Authentication account component types.
+ */
+export declare const AuthenticationAccountComponentType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
+};
+/**
+ * Authentication account component types.
+ */
+export type AuthenticationAccountComponentType = (typeof AuthenticationAccountComponentType)[keyof typeof AuthenticationAccountComponentType];

package/dist/types/models/types/authenticationProviderType.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Authentication provider types.
+ */
+export declare const AuthenticationProviderType: {
+    /**
+     * Passwords for accounts held in entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * Google.
+     */
+    readonly Google: "google";
+    /**
+     * Microsoft.
+     */
+    readonly Microsoft: "microsoft";
+};
+/**
+ * Authentication provider types.
+ */
+export type AuthenticationProviderType = (typeof AuthenticationProviderType)[keyof typeof AuthenticationProviderType];

package/dist/types/models/types/oauthComponentType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * OAuth component types.
+ */
+export declare const OAuthComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * OAuth component types.
+ */
+export type OAuthComponentType = (typeof OAuthComponentType)[keyof typeof OAuthComponentType];

package/dist/types/models/types/organizationComponentType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Organization component types.
+ */
+export declare const OrganizationComponentType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
+};
+/**
+ * Organization component types.
+ */
+export type OrganizationComponentType = (typeof OrganizationComponentType)[keyof typeof OrganizationComponentType];

package/dist/types/models/types/organizationRequestAdminComponentType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Organization request admin component types.
+ */
+export declare const OrganizationRequestAdminComponentType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
+};
+/**
+ * Organization request admin component types.
+ */
+export type OrganizationRequestAdminComponentType = (typeof OrganizationRequestAdminComponentType)[keyof typeof OrganizationRequestAdminComponentType];

package/dist/types/models/types/restRouteProcessorType.d.ts

@@ -6,6 +6,10 @@ export declare const RestRouteProcessorType: {
      * Auth header.
      */
     readonly AuthHeader: "auth-header";
+    /**
+     * Authentication account, sets the identity and organization of the signed in account.
+     */
+    readonly AuthenticationAccount: "authentication-account";
     /**
      * Logging.
      */
@@ -46,6 +50,10 @@ export declare const RestRouteProcessorType: {
      * Authorization.
      */
     readonly Authorization: "authorization";
+    /**
+     * Origin check, rejects cookie authenticated state changing requests from other origins.
+     */
+    readonly OriginCheck: "origin-check";
 };
 /**
  * REST route processor types.

package/dist/types/models/types/socketRouteProcessorType.d.ts

@@ -6,6 +6,10 @@ export declare const SocketRouteProcessorType: {
      * Auth header.
      */
     readonly AuthHeader: "auth-header";
+    /**
+     * Authentication account, sets the identity and organization of the signed in account.
+     */
+    readonly AuthenticationAccount: "authentication-account";
     /**
      * Logging.
      */
@@ -38,6 +42,10 @@ export declare const SocketRouteProcessorType: {
      * Authorization.
      */
     readonly Authorization: "authorization";
+    /**
+     * Origin check, rejects cookie authenticated socket connections from other origins.
+     */
+    readonly OriginCheck: "origin-check";
 };
 /**
  * Socket route processor types.