@mimik/configuration 5.0.1 → 5.0.3

package/README.md

@@ -43,9 +43,10 @@ The following environment variables are being setup:
 | SERVER_VERSION | version of the software for the micro-service | package.version | serverSettings.version
 | SERVER_NAME | name of the micro-service | package.name | serverSettings.name
 | SERVER_TYPE | type of the micro-service | package.mimik.type | serverSettings.type
-| SWAGGER_FILE_VERSION | version of the swagger file for the API | package.swaggerFile.version | serverSettings.swaggerFileVersion
-| SWAGGER_FILE_ACCOUNT | account associated with the API | package.swaggerFile.account |
-| SWAGGER_FILE_NAME | name of the API | package.swaggerFile.name |
+| SWAGGER_FILE_VERSION | version of the swagger file for the API | package.swaggerFile.version | serverSettings.swaggerFile.version
+| SWAGGER_FILE_ACCOUNT | account associated with the API | package.swaggerFile.account | serverSettings.swaggerFile.account
+| SWAGGER_FILE_NAME | name of the API | package.swaggerFile.name | serverSettings.swaggerFile.name
+| SWAGGER_FILE_PROVIDER | provider of the API file | package.swaggerFile.provider | serverSettings.swaggerFile.provider, if not present the default is `bitbucket`
 | SERVER_LOCAL_IPV4 | IP address of the micro-service | ip.address() | serverSettings.ip.local
 | CONSOLE_LEVEL | log level for console output | debug | logInfo.consoleLevel
 | LOG_LEVEL | log level for console output | debug | logInfo.logLevel
@@ -65,6 +66,7 @@ The following environement variables are being used for the configuration:
 | SWAGGER_FILE_DIRECTORY | directory where the api definition is located | ./api | serverSettings.api | [1]
 | BITBUCKET_USERNAME | username to access bitbucket read access on the swagger repos | ' ' | serverSettings.apiBasicAuth.username
 | BITBUCKET_PASSWORD | password to access bitbucket read access on the swagger repos | ' ' | serverSettings.apiBasicAuth.password
+| SWAGGERHUB_API_KEY | apiKey to access swaggerhub | | serverSettings.apiApiKey
 | SERVER_SECURITY_SET | switch to enable or disable the token interpretation | on | serverSettings.securitySet | only active if environment is `local`
 | INTERCEPT_ERROR | switch to use or not the errorIntercept option | on | serverSettings.interceptError | must be set to off for mID
 | SERVER_PORT | port of the server |  | serverSettings.port |

package/index.js

@@ -87,6 +87,8 @@ const {
   DEFAULT_SERVER_PUBLIC_DOMAIN_NAME,
   DEFAULT_ADMIN_EXTERNAL_ID,
   DEFAULT_SWAGGER_DIR,
+  DEFAULT_SWAGGER_FILE_PROVIDER,
+  SUPPORTED_SWAGGER_FILE_PROVIDERS,
   DEFAULT_INTERCEPT_ERROR,
   DEFAULT_BITBUCKET_USERNAME,
   DEFAULT_BITBUCKET_PASSWORD,
@@ -444,12 +446,15 @@ if (!isMSTSet) {
   configuration.dependencies = {};
 }
 if (process.env.OAUTH_GENERIC_PREVIOUS_KEY) configuration.security.generic.previousKey = process.env.OAUTH_GENERIC_PREVIOUS_KEY;
-if (process.env.BITBUCKET_USERNAME) {
+if (process.env.BITBUCKET_USERNAME || process.env.BITBUCKET_PASSWORD) {
   configuration.serverSettings.apiBasicAuth = {
     username: process.env.BITBUCKET_USERNAME || DEFAULT_BITBUCKET_USERNAME,
     password: process.env.BITBUCKET_PASSWORD || DEFAULT_BITBUCKET_PASSWORD,
   };
 }
+if (process.env.SWAGGERHUB_API_KEY) {
+  configuration.serverSettings.apiApiKey = process.env.SWAGGERHUB_API_KEY;
+}
 configuration.logInfo = setupLog();
 configuration.locationProvider = setupLocationProvider();
 
@@ -472,9 +477,10 @@ configuration.locationProvider = setupLocationProvider();
  * | SERVER_VERSION | version of the software for the micro-service | package.version | serverSettings.version
  * | SERVER_NAME | name of the micro-service | package.name | serverSettings.name
  * | SERVER_TYPE | type of the micro-service | package.mimik.type | serverSettings.type
- * | SWAGGER_FILE_VERSION | version of the swagger file for the API | package.swaggerFile.version | serverSettings.swaggerFileVersion
- * | SWAGGER_FILE_ACCOUNT | account associated with the API | package.swaggerFile.account |
- * | SWAGGER_FILE_NAME | name of the API | package.swaggerFile.name |
+ * | SWAGGER_FILE_VERSION | version of the swagger file for the API | package.swaggerFile.version | serverSettings.swaggerFile.version
+ * | SWAGGER_FILE_ACCOUNT | account associated with the API | package.swaggerFile.account | serverSettings.swaggerFile.account
+ * | SWAGGER_FILE_NAME | name of the API | package.swaggerFile.name | serverSettings.swaggerFile.name
+ * | SWAGGER_FILE_PROVIDER | provider of the API file | package.swaggerFile.provider | serverSettings.swaggerFile.provider, if not present the default is `bitbucket`
  * | SERVER_LOCAL_IPV4 | IP address of the micro-service | ip.address() | serverSettings.ip.local
  * | CONSOLE_LEVEL | log level for console output | debug | logInfo.consoleLevel
  * | LOG_LEVEL | log level for console output | debug | logInfo.logLevel
@@ -494,6 +500,7 @@ configuration.locationProvider = setupLocationProvider();
  * | SWAGGER_FILE_DIRECTORY | directory where the api definition is located | ./api | serverSettings.api | [1]
  * | BITBUCKET_USERNAME | username to access bitbucket read access on the swagger repos | ' ' | serverSettings.apiBasicAuth.username
  * | BITBUCKET_PASSWORD | password to access bitbucket read access on the swagger repos | ' ' | serverSettings.apiBasicAuth.password
+ * | SWAGGERHUB_API_KEY | apiKey to access swaggerhub | | serverSettings.apiApiKey
  * | SERVER_SECURITY_SET | switch to enable or disable the token interpretation | on | serverSettings.securitySet | only active if environment is `local`
  * | INTERCEPT_ERROR | switch to use or not the errorIntercept option | on | serverSettings.interceptError | must be set to off for mID
  * | SERVER_PORT | port of the server |  | serverSettings.port |
@@ -643,6 +650,8 @@ const setConfig = (pack, options) => {
     process.env.SWAGGER_FILE_VERSION = pack.swaggerFile.version;
     process.env.SWAGGER_FILE_ACCOUNT = pack.swaggerFile.account;
     process.env.SWAGGER_FILE_NAME = pack.swaggerFile.name;
+    if (pack.swaggerFile.provider) process.env.SWAGGER_FILE_PROVIDER = pack.swaggerFile.provider;
+    else process.env.SWAGGER_FILE_PROVIDER = DEFAULT_SWAGGER_FILE_PROVIDER;
   }
 
   // eslint-disable-next-line max-len
@@ -652,7 +661,12 @@ const setConfig = (pack, options) => {
   configuration.serverSettings.type = process.env.SERVER_TYPE;
   configuration.serverSettings.version = process.env.SERVER_VERSION;
   configuration.serverSettings.api = `${process.env.SWAGGER_FILE_DIRECTORY || DEFAULT_SWAGGER_DIR}/${apiFilename}`;
-  configuration.serverSettings.swaggerFileVersion = process.env.SWAGGER_FILE_VERSION;
+  configuration.serverSettings.swaggerFile = {
+    version: process.env.SWAGGER_FILE_VERSION,
+    name: process.env.SWAGGER_FILE_NAME,
+    account: process.env.SWAGGER_FILE_ACCOUNT,
+    provider: process.env.SWAGGER_FILE_PROVIDER,
+  };
 
   // default for every server for cluster management
   configuration.dependencies[configuration.serverSettings.type] = {
@@ -661,6 +675,9 @@ const setConfig = (pack, options) => {
 
   if (isMSTSet) configuration.dependencies[configuration.serverSettings.type].audience = process.env[`${configuration.serverSettings.type}_AUDIENCE`.toUpperCase()];
 
+  if (!SUPPORTED_SWAGGER_FILE_PROVIDERS.includes(configuration.serverSettings.swaggerFile.provider)) {
+    throw new Error(`swaggerFile provider not supported: ${configuration.serverSettings.swaggerFile.provider}`);
+  }
   if (options.database) {
     if (options.database.type === 'mongodb') {
       configuration.mongoSettings = setupMongo(options.database);

package/lib/common.js

@@ -88,6 +88,8 @@ const DEFAULT_SERVER_PUBLIC_DOMAIN_NAME = null;
 const DEFAULT_ADMIN_EXTERNAL_ID = 'admin';
 
 const DEFAULT_SWAGGER_DIR = '../api';
+const DEFAULT_SWAGGER_FILE_PROVIDER = 'bitbucket';
+const SUPPORTED_SWAGGER_FILE_PROVIDERS = [DEFAULT_SWAGGER_FILE_PROVIDER, 'swagggerhub'];
 
 const DEFAULT_BITBUCKET_USERNAME = ' ';
 const DEFAULT_BITBUCKET_PASSWORD = ' ';
@@ -165,6 +167,8 @@ module.exports = {
   DEFAULT_SERVER_PUBLIC_DOMAIN_NAME,
   DEFAULT_ADMIN_EXTERNAL_ID,
   DEFAULT_SWAGGER_DIR,
+  DEFAULT_SWAGGER_FILE_PROVIDER,
+  SUPPORTED_SWAGGER_FILE_PROVIDERS,
   DEFAULT_INTERCEPT_ERROR,
   DEFAULT_BITBUCKET_USERNAME,
   DEFAULT_BITBUCKET_PASSWORD,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/configuration",
-  "version": "5.0.1",
+  "version": "5.0.3",
   "description": "Common configuration for mimik services",
   "main": "index.js",
   "scripts": {