@axinom/mosaic-service-common 0.69.0 → 0.70.0-rc.3

package/README.md

@@ -2,9 +2,15 @@
 
 ## About the Package
 
-This package is part of the Axinom Mosaic development platform. More information can be found at https://portal.axinom.com/mosaic.
+This package is part of the Axinom Mosaic development platform. More information
+can be found at https://portal.axinom.com/mosaic.
 
 ## License
 
-This package can be licensed under the [Axinom Products Licensing Agreement](https://portal.axinom.com/mosaic/contracts/products-licensing-agreement) or evaluated under the [Axinom Products Evaluation Agreement](https://portal.axinom.com/mosaic/contracts/products-evaluation-agreement).  
-No part of Axinom's software may be copied, modified, propagated, or distributed except in accordance with the terms contained in the Axinom Products Licensing Agreement and Axinom Products Evaluation Agreement.
+This package can be licensed under the
+[Axinom Products Licensing Agreement](https://portal.axinom.com/mosaic/contracts/products-licensing-agreement)
+or evaluated under the
+[Axinom Products Evaluation Agreement](https://portal.axinom.com/mosaic/contracts/products-evaluation-agreement).  
+No part of Axinom's software may be copied, modified, propagated, or distributed
+except in accordance with the terms contained in the Axinom Products Licensing
+Agreement and Axinom Products Evaluation Agreement.

package/dist/cjs/common/config/basic-config-definitions.d.ts

@@ -0,0 +1,476 @@
+import type { LoggerFn } from 'env-var';
+import { MaskMode } from '../logging/index.js';
+import type { Dict } from '../types/index.js';
+/**
+ * Get the basic configuration definitions that are used for most mosaic services
+ * @param variables process.env variables or custom provided values
+ * @returns The following configuration values are included:
+ * ```
+ * environment // e.g. NODE_ENV=development
+ * serviceId // e.g. SERVICE_ID=my-business-service
+ * logLevel // e.g. LOG_LEVEL=INFO
+ * healthEndpointPort // e.g. HEALTH_ENDPOINT_PORT=9000
+ * secureLoggingMode // e.g. SECURE_LOGGING_MODE=UNSAFE_SECRETS_NOT_HIDDEN_UNSAFE
+ * logMaskKeywords // e.g. LOG_MASK_KEYWORDS=secret,password,connectionString
+ * logMaskMaxDepth // e.g. LOG_MASK_MAX_DEPTH=10
+ * fullDevLogs // e.g. FULL_DEV_LOGS=true
+ * isDev // true for NODE_ENV=development
+ * isProd // true for NODE_ENV=production
+ * ```
+ */
+export declare const getBasicConfigDefinitions: (variables?: Dict<string | undefined>, logger?: LoggerFn) => {
+    /** @example NODE_ENV=development */
+    environment: () => "development" | "production" | "test";
+    /** @example SERVICE_ID=my-business-service */
+    serviceId: () => string;
+    /** @example LOG_LEVEL=INFO */
+    logLevel: () => "" | "FATAL" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE";
+    /** @example HEALTH_ENDPOINT_PORT=9000 */
+    healthEndpointPort: () => number;
+    /**
+     * This is used to determine if the service should use ephemeral ports for general endpoints during development.
+     * This is useful to avoid port conflicts when running multiple services having the same general port number (i.e. liveness/readiness, maintenance, monitoring, etc.).
+     *
+     * However if running services in a `container`, this should be set to `false`, as the container isolates the ports for each service.
+     *
+     * NOTE: this is effective only when the service is running in development mode (i.e. NODE_ENV=development).
+     *
+     * @example USE_EPHEMERAL_PORTS_DURING_DEV=true
+     */
+    useEphemeralPortsDuringDev: () => boolean;
+    /** @example SECURE_LOGGING_MODE=UNSAFE_DEBUG_UNSAFE */
+    secureLoggingMode: () => MaskMode;
+    /** @example LOG_MASK_KEYWORDS=secret,password,connectionString */
+    logMaskKeywords: () => string[];
+    /** @example LOG_MASK_MAX_DEPTH=10 */
+    logMaskMaxDepth: () => number;
+    /** @example FULL_DEV_LOGS=true */
+    fullDevLogs: () => boolean;
+    /** @example NODE_ENV=development */
+    isDev: () => boolean;
+    /** @example NODE_ENV=production */
+    isProd: () => boolean;
+};
+/**
+ * Get the basic configuration definitions for the Maintenance Endpoint
+ * @param variables process.env variables or custom provided values
+ * @returns The following configuration values are included:
+ * ```
+ * maintenanceEndpointPort // e.g. MAINTENANCE_ENDPOINT_PORT=9911
+ * maintenanceEndpointUserName // e.g. MAINTENANCE_ENDPOINT_USER_NAME=maintenance
+ * maintenanceEndpointPassword // e.g. MAINTENANCE_ENDPOINT_PASSWORD={qx/!|PEa0m{.8^W
+ * ```
+ */
+export declare const getBasicMaintenanceEndpointDefinitions: (variables?: Dict<string | undefined>, logger?: LoggerFn) => {
+    /** @example MAINTENANCE_ENDPOINT_PORT=9911 */
+    maintenanceEndpointPort: () => number | undefined;
+    /** @example MAINTENANCE_ENDPOINT_USER_NAME=maintenance */
+    maintenanceEndpointUserName: () => string;
+    /** @example MAINTENANCE_ENDPOINT_PASSWORD={qx/!|PEa0m{.8^W */
+    maintenanceEndpointPassword: () => string;
+};
+/**
+ * Get the basic configuration definitions for the Metrics Endpoint
+ * @param variables process.env variables or custom provided values
+ * @returns The following configuration values are included:
+ * ```
+ * metricsEndpointPort // e.g. METRICS_ENDPOINT_PORT=9090
+ * ```
+ */
+export declare const getBasicMetricsEndpointDefinitions: (variables?: Dict<string | undefined>, logger?: LoggerFn) => {
+    /** @example METRICS_ENDPOINT_PORT=9090 */
+    metricsEndpointPort: () => number;
+};
+/**
+ * Get the basic configuration definitions for GraphQL-specific settings
+ * @param variables process.env variables or custom provided values
+ * @returns The following configuration values are included:
+ * ```
+ * port // e.g. PORT=8080
+ * graphqlGuiEnabled // e.g. GRAPHQL_GUI_ENABLED=true
+ * ```
+ */
+export declare const getBasicGraphQlConfigDefinitions: (defaultPort: number, variables?: Dict<string | undefined>, logger?: LoggerFn) => {
+    /** @example PORT=8080 */
+    port: () => number;
+    /** @example GRAPHQL_GUI_ENABLED=true */
+    graphqlGuiEnabled: () => boolean;
+};
+/**
+ * Get the basic configuration definitions for Database specific settings
+ * @param variables process.env variables or custom provided values
+ * @returns The following configuration values are included:
+ * ```
+ * pgHost // e.g. POSTGRESQL_HOST=localhost
+ * pgPort // e.g. POSTGRESQL_PORT=5432
+ * pgUserSuffix // e.g. POSTGRESQL_USER_SUFFIX=@azure-suffix
+ * pgSSLMode // e.g. PGSSLMODE=require
+ * pgRoot // e.g. POSTGRESQL_ROOT=postgres
+ * pgRootPassword // e.g. POSTGRESQL_ROOT_PASSWORD=C~iZ[r0U-]wYdHXm>T
+ * dbName // e.g. DATABASE_NAME=my_business_service
+ * dbOwner // e.g. DATABASE_OWNER=my_business_owner
+ * dbOwnerPassword // e.g. DATABASE_OWNER_PASSWORD=x4HKTiFEY]iDov!+a
+ * dbLogin // e.g. DATABASE_LOGIN=my_business_login
+ * dbLoginPassword // e.g. DATABASE_LOGIN_PASSWORD=Cl1sJh56n'>caX@7[,
+ * dbGqlRole // e.g. DATABASE_GQL_ROLE=my_business_gql_role
+ * pgPoolMaxConnections // e.g. PG_POOL_MAX_CONNECTIONS=25
+ * pgRootConnectionString // calculated from the above settings
+ * dbOwnerConnectionString // calculated from the above settings
+ * dbOwnerReplicationConnectionString // calculated from the above settings
+ * dbShadowConnectionString // calculated from the above settings
+ * dbLoginConnectionString // calculated from the above settings
+ * ```
+ */
+export declare const getBasicDbConfigDefinitions: (variables?: Dict<string | undefined>, logger?: LoggerFn) => {
+    /** @example POSTGRESQL_HOST=localhost */
+    pgHost: () => string;
+    /** @example POSTGRESQL_PORT=5432 */
+    pgPort: () => number;
+    /** @example POSTGRESQL_PORT=5432 */
+    pgReplicationPort: () => number;
+    /** @example POSTGRESQL_USER_SUFFIX=@azure-suffix */
+    pgUserSuffix: () => string;
+    /** @example PGSSLMODE=require */
+    pgSSLMode: () => "disable" | "allow" | "prefer" | "require" | "verify-ca" | "verify-full" | "no-verify";
+    /** @example POSTGRESQL_ROOT=postgres */
+    pgRoot: () => string | undefined;
+    /** @example POSTGRESQL_ROOT_PASSWORD=C~iZ[r0U-]wYdHXm>T */
+    pgRootPassword: () => string | undefined;
+    /** @example DATABASE_NAME=my_business_service */
+    dbName: () => string;
+    /** @example DATABASE_OWNER=my_business_owner */
+    dbOwner: () => string;
+    /** @example DATABASE_OWNER_PASSWORD=x4HKTiFEY]iDov!+a */
+    dbOwnerPassword: () => string;
+    /** @example DATABASE_LOGIN=my_business_login */
+    dbLogin: () => string;
+    /** @example DATABASE_LOGIN_PASSWORD=Cl1sJh56n'>caX@7[, */
+    dbLoginPassword: () => string;
+    /** @example DATABASE_GQL_ROLE=my_business_gql_role */
+    dbGqlRole: () => string;
+    /** @example PG_POOL_MAX_CONNECTIONS=25 */
+    pgPoolMaxConnections: () => number;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    pgRootConnectionString: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    dbOwnerConnectionString: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* using POSTGRESQL_REPLICATION_PORT */
+    dbOwnerReplicationConnectionString: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    dbShadowConnectionString: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    dbLoginConnectionString: () => string;
+};
+/**
+ * Get the basic configuration definitions for RabbitMQ-specific settings
+ * @param variables process.env variables or custom provided values
+ * @returns The following configuration values are included:
+ * ```
+ * rmqProtocol // e.g. RABBITMQ_PROTOCOL=amqps
+ * rmqVHost // e.g. RABBITMQ_VHOST=2rig00smn1o9pq3a_rj3i6f7hj90ap1wc
+ * rmqHost // e.g. RABBITMQ_HOST=rabbitmq.eu.axinom.net
+ * rmqPort // e.g. RABBITMQ_PORT=5672
+ * rmqUser // e.g. RABBITMQ_USER=jXSwOk3FiQxRui39
+ * rmqPassword // e.g. RABBITMQ_PASSWORD=rk3m5LPHs4m4ALyDy9spsG2X
+ * rmqDevMiddleware // e.g. RABBITMQ_DEV_MIDDLEWARE=true
+ * rmqVHostAssert // e.g. RABBITMQ_VHOST_ASSERT=true
+ * rmqChannelMax // e.g. RABBITMQ_CHANNEL_MAX=100
+ * rmqMgmtProtocol // e.g. RABBITMQ_MGMT_PROTOCOL=https
+ * rmqMgmtHost // e.g. RABBITMQ_MGMT_HOST=rabbitmq.eu.axinom.net
+ * rmqMgmtPort // e.g. RABBITMQ_MGMT_PORT=15672
+ * rmqEventSigningPrivateKey // e.g. RABBITMQ_EVENT_SIGNING_PRIVATE_KEY=MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tP...
+ * rmqEventSigningKeyVersion // e.g. RABBITMQ_EVENT_SIGNING_KEY_VERSION=3
+ * rmqEventSigningPublicKey // e.g. RABBITMQ_EVENT_SIGNING_PUBLIC_KEY=MEgCQQCo9+BpMRYQ/dL3DS2CyJxRF+j6ctbT3/Qp84+KeFhnii7NT7fELilKUSnxS30WAvQCCo2yU1orfgqr41mM70MBAgMBAAE=
+ * rmqEventSigningKeyVersionsToRevoke // e.g. RABBITMQ_EVENT_SIGNING_KEY_VERSIONS_TO_REVOKE=1,2
+ * ```
+ */
+export declare const getBasicRabbitMqConfigDefinitions: (variables?: Dict<string | undefined>, logger?: LoggerFn) => {
+    /** @example RABBITMQ_PROTOCOL=amqps */
+    rmqProtocol: () => string;
+    /** @example RABBITMQ_VHOST=2rig00smn1o9pq3a_rj3i6f7hj90ap1wc */
+    rmqVHost: () => string;
+    /** @example RABBITMQ_HOST=rabbitmq.eu.axinom.net */
+    rmqHost: () => string;
+    /** @example RABBITMQ_PORT=5672 */
+    rmqPort: () => number;
+    /** @example RABBITMQ_USER=jXSwOk3FiQxRui39 */
+    rmqUser: () => string;
+    /** @example RABBITMQ_PASSWORD=rk3m5LPHs4m4ALyDy9spsG2X */
+    rmqPassword: () => string;
+    /** @example RABBITMQ_DEV_MIDDLEWARE=true */
+    rmqDevMiddleware: () => boolean;
+    /** @example RABBITMQ_VHOST_ASSERT=true */
+    rmqVHostAssert: () => boolean;
+    /** @example RABBITMQ_CHANNEL_MAX=100 */
+    rmqChannelMax: () => number;
+    /** @example RABBITMQ_MGMT_PROTOCOL=https */
+    rmqMgmtProtocol: () => string | undefined;
+    /** @example RABBITMQ_MGMT_HOST=rabbitmq.eu.axinom.net */
+    rmqMgmtHost: () => string | undefined;
+    /** @example RABBITMQ_MGMT_PORT=15672 */
+    rmqMgmtPort: () => number | undefined;
+    /** @example RABBITMQ_EVENT_SIGNING_PRIVATE_KEY=MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tP... */
+    rmqEventSigningPrivateKey: () => string;
+    /** @example RABBITMQ_EVENT_SIGNING_KEY_VERSION=3 */
+    rmqEventSigningKeyVersion: () => number;
+    /** @example RABBITMQ_EVENT_SIGNING_PUBLIC_KEY=MEgCQQCo9+BpMRYQ/dL3DS2CyJxRF+j6ctbT3/Qp84+KeFhnii7NT7fELilKUSnxS30WAvQCCo2yU1orfgqr41mM70MBAgMBAAE= */
+    rmqEventSigningPublicKey: () => string;
+    /** @example RABBITMQ_EVENT_SIGNING_KEY_VERSIONS_TO_REVOKE=1,2 */
+    rmqEventSigningKeyVersionsToRevoke: () => number[];
+};
+/**
+ * Get the basic configuration definitions for a customizable service
+ * @param variables process.env variables or custom provided values
+ * @returns The following configuration values are included:
+ * ```
+ * tenantId // e.g. TENANT_ID=add3a8b8-c960-4f9e-86ca-4a64d132fbd8
+ * environmentId // e.g. ENVIRONMENT_ID=c3b69496-0296-4f0e-b128-ace32dce5e53
+ * idServiceAuthBaseUrl // e.g. ID_SERVICE_AUTH_BASE_URL=https://id.service.eu.axinom.net
+ * serviceAccountClientId // e.g. SERVICE_ACCOUNT_CLIENT_ID=ff3cde26-2fc0-45c5-b1b1-8f60cd570962
+ * serviceAccountClientSecret // e.g. SERVICE_ACCOUNT_CLIENT_SECRET=seXdE9XWCGv3tj3j56k38xlQ
+ * ```
+ */
+export declare const getBasicCustomizableConfigDefinitions: (variables?: Dict<string | undefined>, logger?: LoggerFn) => {
+    /** @example TENANT_ID=add3a8b8-c960-4f9e-86ca-4a64d132fbd8 */
+    tenantId: () => string;
+    /** @example ENVIRONMENT_ID=c3b69496-0296-4f0e-b128-ace32dce5e53 */
+    environmentId: () => string;
+    /** @example ID_SERVICE_AUTH_BASE_URL=https://id.service.eu.axinom.net */
+    idServiceAuthBaseUrl: () => string;
+    /** @example SERVICE_ACCOUNT_CLIENT_ID=ff3cde26-2fc0-45c5-b1b1-8f60cd570962 */
+    serviceAccountClientId: () => string;
+    /** @example SERVICE_ACCOUNT_CLIENT_SECRET=seXdE9XWCGv3tj3j56k38xlQ */
+    serviceAccountClientSecret: () => string;
+};
+/**
+ * Get the basic configuration definitions for a managed service
+ * @param variables process.env variables or custom provided values
+ * @returns The following configuration values are included:
+ * ```
+ * idServiceAuthBaseUrl // e.g. ID_SERVICE_AUTH_BASE_URL=https://id.service.eu.axinom.net
+ * managedServiceAccountClientId // e.g. MANAGED_SERVICE_CLIENT_ID=dfce7685-b9e1-4ae9-86c2-a5725ad87379
+ * managedServiceAccountClientSecret // e.g. MANAGED_SERVICE_CLIENT_SECRET=g1ydBSPzxBy5nhzQov9tNc7a
+ * dbEnvOwner // e.g. DATABASE_ENV_OWNER=my_business_env_owner
+ * dbEnvOwnerPassword // e.g. DATABASE_ENV_OWNER_PASSWORD=F{Js~f#r=Nq*Zx`Ly3rh|Tt~
+ * dbEnvOwnerConnectionString // calculated from the above settings
+ * ```
+ */
+export declare const getBasicManagedConfigDefinitions: (variables?: Dict<string | undefined>, logger?: LoggerFn) => {
+    /** @example ID_SERVICE_AUTH_BASE_URL=https://id.service.eu.axinom.net */
+    idServiceAuthBaseUrl: () => string;
+    /** @example MANAGED_SERVICE_CLIENT_ID=dfce7685-b9e1-4ae9-86c2-a5725ad87379 */
+    managedServiceAccountClientId: () => string;
+    /** @example MANAGED_SERVICE_CLIENT_SECRET=g1ydBSPzxBy5nhzQov9tNc7a */
+    managedServiceAccountClientSecret: () => string;
+    /** @example DATABASE_ENV_OWNER=my_business_env_owner */
+    dbEnvOwner: () => string;
+    /** @example DATABASE_ENV_OWNER_PASSWORD=F{Js~f#r=Nq*Zx`Ly3rh|Tt~ */
+    dbEnvOwnerPassword: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    dbEnvOwnerConnectionString: () => string;
+};
+/**
+ * Get the basic, validated configuration object.
+ */
+export declare const getValidatedBasicConfig: (variables?: Dict<string | undefined>) => BasicConfig;
+/**
+ * The basic Configuration type
+ */
+declare const config: import("./config-validation.js").ValueObject<{
+    /** @example NODE_ENV=development */
+    environment: () => "development" | "production" | "test";
+    /** @example SERVICE_ID=my-business-service */
+    serviceId: () => string;
+    /** @example LOG_LEVEL=INFO */
+    logLevel: () => "" | "FATAL" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE";
+    /** @example HEALTH_ENDPOINT_PORT=9000 */
+    healthEndpointPort: () => number;
+    /**
+     * This is used to determine if the service should use ephemeral ports for general endpoints during development.
+     * This is useful to avoid port conflicts when running multiple services having the same general port number (i.e. liveness/readiness, maintenance, monitoring, etc.).
+     *
+     * However if running services in a `container`, this should be set to `false`, as the container isolates the ports for each service.
+     *
+     * NOTE: this is effective only when the service is running in development mode (i.e. NODE_ENV=development).
+     *
+     * @example USE_EPHEMERAL_PORTS_DURING_DEV=true
+     */
+    useEphemeralPortsDuringDev: () => boolean;
+    /** @example SECURE_LOGGING_MODE=UNSAFE_DEBUG_UNSAFE */
+    secureLoggingMode: () => MaskMode;
+    /** @example LOG_MASK_KEYWORDS=secret,password,connectionString */
+    logMaskKeywords: () => string[];
+    /** @example LOG_MASK_MAX_DEPTH=10 */
+    logMaskMaxDepth: () => number;
+    /** @example FULL_DEV_LOGS=true */
+    fullDevLogs: () => boolean;
+    /** @example NODE_ENV=development */
+    isDev: () => boolean;
+    /** @example NODE_ENV=production */
+    isProd: () => boolean;
+}>;
+export type BasicConfig = typeof config;
+/**
+ * The basic maintenance Configuration type
+ */
+declare const maintenanceConfig: import("./config-validation.js").ValueObject<{
+    /** @example MAINTENANCE_ENDPOINT_PORT=9911 */
+    maintenanceEndpointPort: () => number | undefined;
+    /** @example MAINTENANCE_ENDPOINT_USER_NAME=maintenance */
+    maintenanceEndpointUserName: () => string;
+    /** @example MAINTENANCE_ENDPOINT_PASSWORD={qx/!|PEa0m{.8^W */
+    maintenanceEndpointPassword: () => string;
+}>;
+export type BasicMaintenanceConfig = typeof maintenanceConfig;
+/**
+ * The basic metrics Configuration type
+ */
+declare const metricsConfig: import("./config-validation.js").ValueObject<{
+    /** @example METRICS_ENDPOINT_PORT=9090 */
+    metricsEndpointPort: () => number;
+}>;
+export type BasicMetricsConfig = typeof metricsConfig;
+/**
+ * The basic GraphQL Configuration type
+ */
+declare const gqlConfig: import("./config-validation.js").ValueObject<{
+    /** @example PORT=8080 */
+    port: () => number;
+    /** @example GRAPHQL_GUI_ENABLED=true */
+    graphqlGuiEnabled: () => boolean;
+}>;
+export type BasicGQLConfig = typeof gqlConfig;
+/**
+ * The basic DB Configuration type
+ */
+declare const dbConfig: import("./config-validation.js").ValueObject<{
+    /** @example POSTGRESQL_HOST=localhost */
+    pgHost: () => string;
+    /** @example POSTGRESQL_PORT=5432 */
+    pgPort: () => number;
+    /** @example POSTGRESQL_PORT=5432 */
+    pgReplicationPort: () => number;
+    /** @example POSTGRESQL_USER_SUFFIX=@azure-suffix */
+    pgUserSuffix: () => string;
+    /** @example PGSSLMODE=require */
+    pgSSLMode: () => "disable" | "allow" | "prefer" | "require" | "verify-ca" | "verify-full" | "no-verify";
+    /** @example POSTGRESQL_ROOT=postgres */
+    pgRoot: () => string | undefined;
+    /** @example POSTGRESQL_ROOT_PASSWORD=C~iZ[r0U-]wYdHXm>T */
+    pgRootPassword: () => string | undefined;
+    /** @example DATABASE_NAME=my_business_service */
+    dbName: () => string;
+    /** @example DATABASE_OWNER=my_business_owner */
+    dbOwner: () => string;
+    /** @example DATABASE_OWNER_PASSWORD=x4HKTiFEY]iDov!+a */
+    dbOwnerPassword: () => string;
+    /** @example DATABASE_LOGIN=my_business_login */
+    dbLogin: () => string;
+    /** @example DATABASE_LOGIN_PASSWORD=Cl1sJh56n'>caX@7[, */
+    dbLoginPassword: () => string;
+    /** @example DATABASE_GQL_ROLE=my_business_gql_role */
+    dbGqlRole: () => string;
+    /** @example PG_POOL_MAX_CONNECTIONS=25 */
+    pgPoolMaxConnections: () => number;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    pgRootConnectionString: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    dbOwnerConnectionString: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* using POSTGRESQL_REPLICATION_PORT */
+    dbOwnerReplicationConnectionString: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    dbShadowConnectionString: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    dbLoginConnectionString: () => string;
+}>;
+export type BasicDBConfig = typeof dbConfig;
+/**
+ * The basic RMQ Configuration type
+ */
+declare const rmqConfig: import("./config-validation.js").ValueObject<{
+    /** @example RABBITMQ_PROTOCOL=amqps */
+    rmqProtocol: () => string;
+    /** @example RABBITMQ_VHOST=2rig00smn1o9pq3a_rj3i6f7hj90ap1wc */
+    rmqVHost: () => string;
+    /** @example RABBITMQ_HOST=rabbitmq.eu.axinom.net */
+    rmqHost: () => string;
+    /** @example RABBITMQ_PORT=5672 */
+    rmqPort: () => number;
+    /** @example RABBITMQ_USER=jXSwOk3FiQxRui39 */
+    rmqUser: () => string;
+    /** @example RABBITMQ_PASSWORD=rk3m5LPHs4m4ALyDy9spsG2X */
+    rmqPassword: () => string;
+    /** @example RABBITMQ_DEV_MIDDLEWARE=true */
+    rmqDevMiddleware: () => boolean;
+    /** @example RABBITMQ_VHOST_ASSERT=true */
+    rmqVHostAssert: () => boolean;
+    /** @example RABBITMQ_CHANNEL_MAX=100 */
+    rmqChannelMax: () => number;
+    /** @example RABBITMQ_MGMT_PROTOCOL=https */
+    rmqMgmtProtocol: () => string | undefined;
+    /** @example RABBITMQ_MGMT_HOST=rabbitmq.eu.axinom.net */
+    rmqMgmtHost: () => string | undefined;
+    /** @example RABBITMQ_MGMT_PORT=15672 */
+    rmqMgmtPort: () => number | undefined;
+    /** @example RABBITMQ_EVENT_SIGNING_PRIVATE_KEY=MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tP... */
+    rmqEventSigningPrivateKey: () => string;
+    /** @example RABBITMQ_EVENT_SIGNING_KEY_VERSION=3 */
+    rmqEventSigningKeyVersion: () => number;
+    /** @example RABBITMQ_EVENT_SIGNING_PUBLIC_KEY=MEgCQQCo9+BpMRYQ/dL3DS2CyJxRF+j6ctbT3/Qp84+KeFhnii7NT7fELilKUSnxS30WAvQCCo2yU1orfgqr41mM70MBAgMBAAE= */
+    rmqEventSigningPublicKey: () => string;
+    /** @example RABBITMQ_EVENT_SIGNING_KEY_VERSIONS_TO_REVOKE=1,2 */
+    rmqEventSigningKeyVersionsToRevoke: () => number[];
+}>;
+export type BasicRMQConfig = typeof rmqConfig;
+/**
+ * The basic managed-service Configuration type
+ */
+declare const managedServiceConfig: import("./config-validation.js").ValueObject<{
+    /** @example ID_SERVICE_AUTH_BASE_URL=https://id.service.eu.axinom.net */
+    idServiceAuthBaseUrl: () => string;
+    /** @example MANAGED_SERVICE_CLIENT_ID=dfce7685-b9e1-4ae9-86c2-a5725ad87379 */
+    managedServiceAccountClientId: () => string;
+    /** @example MANAGED_SERVICE_CLIENT_SECRET=g1ydBSPzxBy5nhzQov9tNc7a */
+    managedServiceAccountClientSecret: () => string;
+    /** @example DATABASE_ENV_OWNER=my_business_env_owner */
+    dbEnvOwner: () => string;
+    /** @example DATABASE_ENV_OWNER_PASSWORD=F{Js~f#r=Nq*Zx`Ly3rh|Tt~ */
+    dbEnvOwnerPassword: () => string;
+    /** calculated from env variables: POSTGRESQL_* and DATABASE_* */
+    dbEnvOwnerConnectionString: () => string;
+}>;
+export type BasicManagedServiceConfig = typeof managedServiceConfig;
+/**
+ * The basic customizable-service Configuration type
+ */
+declare const customizableServiceConfig: import("./config-validation.js").ValueObject<{
+    /** @example TENANT_ID=add3a8b8-c960-4f9e-86ca-4a64d132fbd8 */
+    tenantId: () => string;
+    /** @example ENVIRONMENT_ID=c3b69496-0296-4f0e-b128-ace32dce5e53 */
+    environmentId: () => string;
+    /** @example ID_SERVICE_AUTH_BASE_URL=https://id.service.eu.axinom.net */
+    idServiceAuthBaseUrl: () => string;
+    /** @example SERVICE_ACCOUNT_CLIENT_ID=ff3cde26-2fc0-45c5-b1b1-8f60cd570962 */
+    serviceAccountClientId: () => string;
+    /** @example SERVICE_ACCOUNT_CLIENT_SECRET=seXdE9XWCGv3tj3j56k38xlQ */
+    serviceAccountClientSecret: () => string;
+}>;
+export type BasicCustomizableServiceConfig = typeof customizableServiceConfig;
+/**
+ * Get a string that contains help which default process env are supported
+ * within the different `getBasic***ConfigDefinitions` that can be printed to
+ * the console or used any other way.
+ * @example
+ * // get a list of all available settings:
+ * console.log(getEnvSettingsHelp());
+ *
+ * // print the usage of a single `getBasic***ConfigDefinitions` helper
+ * const logger: LoggerFn = (varname: string, str: string) => {
+ *  console.log(`${varname}: ${str}`);
+ * }
+ *
+ * getConfig(getBasicConfigDefinitions(undefined, logger));
+ */
+export declare const getEnvSettingsHelp: () => string;
+export {};
+//# sourceMappingURL=basic-config-definitions.d.ts.map

package/dist/cjs/common/config/basic-config-definitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic-config-definitions.d.ts","sourceRoot":"","sources":["../../../../src/common/config/basic-config-definitions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAIxC,OAAO,EAAuB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AA6B9C;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,yBAAyB,GACpC,YAAW,IAAI,CAAC,MAAM,GAAG,SAAS,CAAe,EACjD,SAAS,QAAQ;IAIf,oCAAoC;;IAMpC,8CAA8C;;IAE9C,8BAA8B;;IAE9B,yCAAyC;;IAGzC;;;;;;;;;OASG;;IAGH,uDAAuD;;IAWvD,kEAAkE;;IAGlE,qCAAqC;;IAGrC,kCAAkC;;IAElC,oCAAoC;;IAIpC,mCAAmC;;CAKtC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,sCAAsC,GACjD,YAAW,IAAI,CAAC,MAAM,GAAG,SAAS,CAAe,EACjD,SAAS,QAAQ;IAIf,8CAA8C;;IAG9C,0DAA0D;;IAG1D,8DAA8D;;CAIjE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kCAAkC,GAC7C,YAAW,IAAI,CAAC,MAAM,GAAG,SAAS,CAAe,EACjD,SAAS,QAAQ;IAIf,0CAA0C;;CAI7C,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC,GAC3C,aAAa,MAAM,EACnB,YAAW,IAAI,CAAC,MAAM,GAAG,SAAS,CAAe,EACjD,SAAS,QAAQ;IAIf,yBAAyB;;IAEzB,wCAAwC;;CAI3C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,2BAA2B,GACtC,YAAW,IAAI,CAAC,MAAM,GAAG,SAAS,CAAe,EACjD,SAAS,QAAQ;IAIf,yCAAyC;;IAEzC,oCAAoC;;IAEpC,oCAAoC;;IAGpC,oDAAoD;;IAGpD,iCAAiC;;IAcjC,wCAAwC;;IAExC,2DAA2D;;IAE3D,iDAAiD;;IAEjD,gDAAgD;;IAEhD,yDAAyD;;IAGzD,gDAAgD;;IAEhD,0DAA0D;;IAG1D,sDAAsD;;IAEtD,0CAA0C;;IAI1C,iEAAiE;;IAajE,iEAAiE;;IAIjE,mGAAmG;;IAInG,iEAAiE;;IAIjE,iEAAiE;;CAKpE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,iCAAiC,GAC5C,YAAW,IAAI,CAAC,MAAM,GAAG,SAAS,CAAe,EACjD,SAAS,QAAQ;IAMf,uCAAuC;;IAEvC,gEAAgE;;IAEhE,oDAAoD;;IAEpD,kCAAkC;;IAElC,8CAA8C;;IAE9C,0DAA0D;;IAE1D,4CAA4C;;IAG5C,0CAA0C;;IAG1C,wCAAwC;;IAMxC,4CAA4C;;IAE5C,yDAAyD;;IAEzD,wCAAwC;;IAIxC,iGAAiG;;IAOjG,oDAAoD;;IAOpD,sJAAsJ;;IAOtJ,iEAAiE;;CAQpE,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qCAAqC,GAChD,YAAW,IAAI,CAAC,MAAM,GAAG,SAAS,CAAe,EACjD,SAAS,QAAQ;IAIf,8DAA8D;;IAE9D,mEAAmE;;IAEnE,yEAAyE;;IAGzE,8EAA8E;;IAG9E,sEAAsE;;CAIzE,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gCAAgC,GAC3C,YAAW,IAAI,CAAC,MAAM,GAAG,SAAS,CAAe,EACjD,SAAS,QAAQ;IAIf,yEAAyE;;IAGzE,8EAA8E;;IAG9E,sEAAsE;;IAGtE,wDAAwD;;IAExD,oEAAoE;;IAGpE,iEAAiE;;CAmBpE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAClC,YAAW,IAAI,CAAC,MAAM,GAAG,SAAS,CAAe,KAChD,WAEF,CAAC;AAEF;;GAEG;AACH,QAAA,MAAM,MAAM;IA9aR,oCAAoC;;IAMpC,8CAA8C;;IAE9C,8BAA8B;;IAE9B,yCAAyC;;IAGzC;;;;;;;;;OASG;;IAGH,uDAAuD;;IAWvD,kEAAkE;;IAGlE,qCAAqC;;IAGrC,kCAAkC;;IAElC,oCAAoC;;IAIpC,mCAAmC;;EA8XkB,CAAC;AAC1D,MAAM,MAAM,WAAW,GAAG,OAAO,MAAM,CAAC;AAExC;;GAEG;AACH,QAAA,MAAM,iBAAiB;IA7WnB,8CAA8C;;IAG9C,0DAA0D;;IAG1D,8DAA8D;;EAyWjE,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,OAAO,iBAAiB,CAAC;AAE9D;;GAEG;AACH,QAAA,MAAM,aAAa;IA3Vf,0CAA0C;;EA2V2B,CAAC;AAC1E,MAAM,MAAM,kBAAkB,GAAG,OAAO,aAAa,CAAC;AAEtD;;GAEG;AACH,QAAA,MAAM,SAAS;IA3UX,yBAAyB;;IAEzB,wCAAwC;;EAyU2B,CAAC;AACxE,MAAM,MAAM,cAAc,GAAG,OAAO,SAAS,CAAC;AAE9C;;GAEG;AACH,QAAA,MAAM,QAAQ;IA1SV,yCAAyC;;IAEzC,oCAAoC;;IAEpC,oCAAoC;;IAGpC,oDAAoD;;IAGpD,iCAAiC;;IAcjC,wCAAwC;;IAExC,2DAA2D;;IAE3D,iDAAiD;;IAEjD,gDAAgD;;IAEhD,yDAAyD;;IAGzD,gDAAgD;;IAEhD,0DAA0D;;IAG1D,sDAAsD;;IAEtD,0CAA0C;;IAI1C,iEAAiE;;IAajE,iEAAiE;;IAIjE,mGAAmG;;IAInG,iEAAiE;;IAIjE,iEAAiE;;EAmOR,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,OAAO,QAAQ,CAAC;AAE5C;;GAEG;AACH,QAAA,MAAM,SAAS;IAnMX,uCAAuC;;IAEvC,gEAAgE;;IAEhE,oDAAoD;;IAEpD,kCAAkC;;IAElC,8CAA8C;;IAE9C,0DAA0D;;IAE1D,4CAA4C;;IAG5C,0CAA0C;;IAG1C,wCAAwC;;IAMxC,4CAA4C;;IAE5C,yDAAyD;;IAEzD,wCAAwC;;IAIxC,iGAAiG;;IAOjG,oDAAoD;;IAOpD,sJAAsJ;;IAOtJ,iEAAiE;;EA8ID,CAAC;AACrE,MAAM,MAAM,cAAc,GAAG,OAAO,SAAS,CAAC;AAE9C;;GAEG;AACH,QAAA,MAAM,oBAAoB;IArFtB,yEAAyE;;IAGzE,8EAA8E;;IAG9E,sEAAsE;;IAGtE,wDAAwD;;IAExD,oEAAoE;;IAGpE,iEAAiE;;EAuES,CAAC;AAC/E,MAAM,MAAM,yBAAyB,GAAG,OAAO,oBAAoB,CAAC;AAEpE;;GAEG;AACH,QAAA,MAAM,yBAAyB;IA9H3B,8DAA8D;;IAE9D,mEAAmE;;IAEnE,yEAAyE;;IAGzE,8EAA8E;;IAG9E,sEAAsE;;EAsHzE,CAAC;AACF,MAAM,MAAM,8BAA8B,GAAG,OAAO,yBAAyB,CAAC;AAE9E;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB,QAAO,MAuCrC,CAAC"}