@mimik/be-project-builder 1.0.0

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@mimik/be-project-builder",
+  "version": "1.0.0",
+  "description": "Project builder for mimik back end service ",
+  "main": "./index.js",
+  "bin": {
+    "be-project-builder": "./index.js"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "scripts": {
+    "lint": "eslint . --no-error-on-unmatched-pattern"
+  },
+  "dependencies": {
+    "@mimik/request-retry": "^4.0.6",
+    "ansi-colors": "4.1.3",
+    "comment-json": "4.5.1",
+    "dotenv": "17.2.3",
+    "js-base64": "3.7.8",
+    "js-yaml": "4.1.1",
+    "mustache": "4.2.0",
+    "prompts": "^2.4.2",
+    "swagger-client": "3.36.0",
+    "yaml": "2.8.2"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.39.2",
+    "@mimik/eslint-plugin-document-env": "^2.0.8",
+    "@stylistic/eslint-plugin": "5.7.1",
+    "eslint-plugin-import": "2.32.0",
+    "globals": "17.1.0",
+    "husky": "9.1.7",
+    "jsdoc-to-markdown": "9.1.3"
+  }
+}

package/scaffoldFiles/local/commitMsgCheck.txt

@@ -0,0 +1,3 @@
+import { commitCheckMsg } from '@mimik/local';
+
+commitCheckMsg();

package/scaffoldFiles/local/dotFiles.txt

@@ -0,0 +1,3 @@
+import { dotFiles } from '@mimik/local';
+
+dotFiles();

package/scaffoldFiles/local/jsdoc.json

@@ -0,0 +1,6 @@
+{
+    "source": {
+        "includePattern": ".+\\.js(doc|x)?$",
+        "excludePattern": ""
+    }
+}

package/scaffoldFiles/local/scripts.txt

@@ -0,0 +1,3 @@
+import { scripts } from '@mimik/local';
+
+scripts();

package/scaffoldFiles/local/setup.txt

@@ -0,0 +1,3 @@
+import { setup } from '@mimik/local';
+
+setup();

package/scaffoldFiles/local/start-example.json

@@ -0,0 +1,37 @@
+{ 
+  // parameters defintiion to set are from:
+  // - ./src/configuration/config.js: for the custom parameters
+  // - @mimik/configuration: for the general parameters
+  // -- service description
+  "SERVER_PORT": 8080,
+  // "SERVER_ID": "an ID",
+  // -- server public address
+  "SERVER_PUBLIC_DOMAIN_NAME": "a domain name",
+  "SERVER_PUBLIC_PROTOCOL": "http:",
+  // -- logs
+  "LOG_LEVEL": "debug",
+  "CONSOLE_LEVEL": "debug",
+  "NO_STACK": "yes",
+  "LOG_MODE": "none",
+  // "LOG_MODE": "awsS3, awsKinesis, sumologic, all, none",
+  // "EXIT_DELAY: 2000,
+  // -- providers
+  // "locationNeeded": "yes",
+  // "CLOUD_PROVIDER": "AWS",
+  // // -- database
+  // TODO: add database parameters here
+  // "DATABASE_NAME": "a name",
+  // -- specific parameters
+  // TODO: add specific parameters here
+  // -- security
+  // "SERVER_SECURITY_SET": "off",
+  // -- dependencies, the audiences are generated by mST
+  // "mIDNeeded": "yes",
+  // TODO: add dependencies (except mID) as a base URL (xxx_URL) here
+  // EXAMPLE:
+  // "MSS_URL": "http://localhost:8070/mSS/v1",
+  // -- environment
+  // "REGISTRATION_SET: "off",
+  // "REGISTRATION_RETRY": 200000,
+  "NODE_ENV": "local"
+}

package/scaffoldFiles/local/testSetup.txt

@@ -0,0 +1,3 @@
+import { testSetup } from '@mimik/local';
+
+testSetup();

package/scaffoldFiles/local/unScripts.txt

@@ -0,0 +1,3 @@
+import { unScripts } from '@mimik/local';
+
+unScripts();

package/scaffoldFiles/package.json

@@ -0,0 +1,51 @@
+{
+  "version": "1.0.0",
+  "main": "./src/index.js",
+  "type": "module",
+  "scripts": {
+    "postinstall": "if [ \"$NODE_ENV\" != \"production\" ] && [ \"$NODE_ENV\" != \"prod\" ]\nthen\nnode ./local/scripts.js && node ./local/dotFiles.js\nfi",
+    "lint": "eslint . --no-error-on-unmatched-pattern",
+    "docs": "jsdoc2md ./src/configuration/config.js > README.md",
+    "pretest": "node ./local/testSetup.js",
+    "test": "mocha --reporter mochawesome --bail --exit --file test/src/set-env.js test/normal/",
+    "test-old": "mocha --reporter mochawesome --bail --exit test/",
+    "test-ci": "c8 --reporter=lcov --reporter=text npm test --exit",
+    "test-detached": "node ./local/testSetup.js && mocha --reporter mochawesome --bail --exit --file test/src/set-env.js test/detached/",
+    "prestart": "node ./local/setup.js",
+    "start": "sh server-start.sh",
+    "pre-push": "npm run docs && npm run lint && npm run test",
+    "pre-commit": "npm run docs && npm run lint",
+    "prepare": "if [ \"$NODE_ENV\" != \"production\" ] && [ \"$NODE_ENV\" != \"prod\" ] \nthen\nhusky\nfi"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run pre-commit",
+      "pre-push": "npm run pre-push",
+      "commit-msg": "node ./local/commitMsgCheck $1"
+    }
+  },
+  "keywords": [
+    "swagger",
+    "mimik"
+  ],
+  "license": "MIT",
+  "author": "mimik",
+  "private": true,
+  "dependencies": {
+    "@mimik/cluster": "5.0.1",
+    "@mimik/configuration": "6.0.6",
+    "@mimik/init": "6.0.2",
+    "@mimik/metrics-helper": "2.0.1",
+    "@mimik/response-helper": "4.0.4",
+    "@mimik/sumologic-winston-logger": "2.1.5",
+    "@mimik/swagger-helper": "5.0.2",
+    "@mimik/systeminfo": "4.0.1",
+    "express": "5.1.0"
+  },
+  "devDependencies": {
+    "@mimik/local": "7.1.2",
+    "@mimik/request-helper": "2.0.2",
+    "@mimik/test-helper": "3.0.3",
+    "body-parser": "2.2.0"
+  }
+}

package/scaffoldFiles/src/common.txt

@@ -0,0 +1,16 @@
+/* eslint-disable no-magic-numbers */
+const GET = 'get';
+const POST = 'post';
+const DELETE = 'delete';
+const PUT = 'put';
+
+const DECIMAL = 10;
+// TODO: add other constants here
+
+export {
+  DECIMAL,
+  DELETE,
+  GET,
+  POST,
+  PUT,
+};

package/scaffoldFiles/src/dbValidateHelper.txt

@@ -0,0 +1,4 @@
+import config from '../configuration/config.js';
+import mongooser from '@mimik/mongooser';
+
+export const dbValidate = () => mongooser(config).validate();

package/scaffoldFiles/src/index.txt

@@ -0,0 +1,34 @@
+import { APIRequestDuration, HTTPRequestDuration, register } from '@mimik/metrics-helper';
+import cluster from '@mimik/cluster';
+// import compression from 'compression'; // TODO: to be added if compression is needed. compression needs to added as a dependency in package.json
+import config from './configuration/config.js';
+// import { dbValidate } from './lib/dbValidateHelper.js'; // TODO: to be added if a database is used
+import { dirname } from 'path';
+import express from 'express';
+import { fileURLToPath } from 'url';
+import init from '@mimik/init';
+
+const databaseOps = [];
+// dababaseOps.push(dbValidation) // TODO: to be added if a database is used
+
+const localDirname = dirname(fileURLToPath(import.meta.url));
+const app = express();
+
+app.use(express.json());
+// app.use(compression()); // TODO: to be added if compression is needed, if the requestor supports: Accept-Encoding: gzip
+
+const options = {
+  metrics: { APIRequestDuration, HTTPRequestDuration, register },
+  // TODO: add specific format here
+  // EXAMPLE:
+  //  formats: {
+  //    base64: {
+  //      type: 'string',
+  //      validate: /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/][AQgw]==|[A-Za-z0-9+/]{2}[AEIMQUYcgkosw048]=)?$/u,
+  //    },
+  //  },
+};
+
+init(app, localDirname, config, databaseOps, cluster(config, { HTTPRequestDuration }), options);
+
+export default app;

package/scaffoldFiles/src/infoController.txt

@@ -0,0 +1,34 @@
+import { RESPONSE_CODE, getRichError, sendError, sendResult } from '@mimik/response-helper';
+import { convertParams } from '@mimik/swagger-helper';
+import processor from '../processors/infoProcessor.js';
+import { register } from '@mimik/metrics-helper';
+
+const getInfos = (con, req, res) => {
+  const options = convertParams(con);
+  const { types } = options;
+
+  if (!types || types.length === 0) {
+    sendError(getRichError('Parameter', 'types must have at least 1 item'), res, null, options);
+    return;
+  }
+
+  processor.getInfos(types, options.correlationId)
+    .then(result => sendResult(result, RESPONSE_CODE.OK, res, options))
+    .catch(err => sendError(err, res, null, options));
+};
+
+const getMetrics = (con, req, res) => {
+  const options = convertParams(con, 'silly');
+
+  return register.metrics()
+    .then((result) => {
+      res.setHeader('Content-Type', register.contentType);
+      res.end(result);
+    })
+    .catch(err => sendError(err, res, null, options));
+};
+
+export {
+  getInfos,
+  getMetrics,
+};

package/scaffoldFiles/src/infoProcessor.txt

@@ -0,0 +1,26 @@
+import { filterConfig, healthInfo } from '@mimik/systeminfo';
+import Promise from 'bluebird';
+import config from '../configuration/config.js';
+
+const getInfos = (options, correlationId) => {
+  const response = { data: {} };
+
+  return Promise.map(options, (option) => {
+    // TODO: add the specific options here
+    if (option === 'config') {
+      if (!response.data.system) response.data.system = {};
+      response.data.system.config = filterConfig(config);
+      return Promise.resolve(null);
+    }
+    if (option === 'healthCheck') {
+      if (!response.data.system) response.data.system = {};
+      response.data.system.healthCheck = healthInfo();
+      return Promise.resolve(null);
+    }
+    return Promise.resolve(null);
+  }).then(() => response);
+};
+
+export default {
+  getInfos,
+};

package/scaffoldFiles/src/mustacheConfig.txt

@@ -0,0 +1,57 @@
+/* eslint-disable no-process-env */
+import { DECIMAL } from '../lib/common.js';
+import { URL } from 'url';
+import process from 'process';
+import { readFile } from 'fs/promises';
+import { setConfig } from '@mimik/configuration';
+
+const pack = JSON.parse(await readFile(new URL('../../package.json', import.meta.url)));
+
+/**
+ *
+ * {{serviceType}} Configuration.
+ *
+ * @function config
+ * @returns {Object} configuration - Server configuration.
+ * @description The following environment variables are required to configure {{serviceType}}:
+ *
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * TODO: add the environment variables used here
+ *
+ * These values are in addition to those required by the
+ * [configuration](https://bitbucket.org/mimiktech/configuration) library.
+ *
+ * The API is available on
+ * [SwaggerHub](https://app.swaggerhub.com/apis/mimik/{{serviceType}}).
+ */
+export const conf = (() => {
+  const configuration = setConfig(pack, {
+    // TODO: to add if a database is used
+    //  database: {
+    //    type: 'mongodb',
+    //    table: {
+    // TODO: add the mongo table here
+    // EXAMPLE:
+    //    node: process.env.NODE_TABLE || 'a table name',
+    //  },
+    },
+    // TODO: add dependencies if any here
+    // EXAMPLE:
+    //  dependencies: {
+    //    mSS: {
+    //      url: process.env.MSS_URL,
+    //      audience: process.env.MSS_AUDIENCE,
+    //    },
+    //  }
+    custom: {
+    // TODO: add the custom properties here
+    // EXAMPLE:
+    //  searchRadius: parseFloat(process.env.SEARCH_RADIUS, DECIMAL) || 'a search radius number',
+    },
+  });
+
+  return configuration;
+})();
+
+export default conf;

package/scaffoldFiles/src/mustacheController.txt

@@ -0,0 +1,20 @@
+import {
+  ERROR_CODE,
+  RESPONSE_CODE,
+  getRichError,
+  sendError,
+  sendResult,
+} from '@mimik/response-helper';
+import { convertParams } from '@mimik/swagger-helper';
+
+{{#functions}}
+const {{name}} = (con, req, res) => {
+  const options = convertParams(con);
+  // TODO: add controller logic here
+};
+
+{{/functions}}
+export {
+  {{#functions}}{{name}}{{^last}},
+  {{/last}}{{/functions}},
+};

package/scaffoldFiles/test/mustacheCommon.txt

@@ -0,0 +1,44 @@
+/* eslint-disable no-process-env, processDoc/validate-document-env */
+import { SET_ON } from '../../src/lib/common.js';
+import config from '../../src/configuration/config.js';
+import process from 'process';
+
+const getTestHelperConf = (app, isLocal, env) => {
+  const { serverSettings } = config;
+  const basePath = process.env.BASE_PATH;
+  const audience = `${serverSettings.public.protocol}//${serverSettings.public.domainName}${basePath}/clients/Generic-{{serviceType}}`;
+
+  // forcing security to be on
+  config.serverSettings.securitySet = SET_ON;
+
+  const fixtures = {
+    APP: app,
+    BASE_PATH: basePath,
+    CUSTOMER_NAME: env.CUSTOMER_NAME,
+    ENVIRONMENT: env.NODE_ENV,
+    IS_LOCAL: isLocal,
+    // TODO: add the specific fixtures here 
+    {{SERVICE_TYPE}}_AUDIENCE: audience,
+    {{SERVICE_TYPE}}_TOKEN: env.{{SERVICE_TYPE}}_TOKEN,
+    {{SERVICE_TYPE}}_URL: env.{{SERVICE_TYPE}}_URL,
+    MIT_URL: env.MIT_URL,
+    MST_TOKEN: env.MST_TOKEN,
+    MST_URL: env.MST_URL,
+    USE_MOCK_PROFILES: env.USE_MOCK_PROFILES === 'yes',
+  };
+
+  return {
+    fixtures,
+    serviceConfiguration: config,
+    services: {
+      MIT: 'mIT',
+      MST: 'mST',
+      {{SERVICE_TYPE}}: '{{serviceType}}',
+      // TODO: add the specific services here
+    },
+  };
+};
+
+export {
+  getTestHelperConf,
+};

package/scaffoldFiles/test/mustacheHttp-test-detached.txt

@@ -0,0 +1,34 @@
+/* eslint-disable no-process-env, processDoc/validate-document-env */
+import { importTest, runTests } from '@mimik/test-helper';
+import { API_TEST_TIMEOUT } from '../../src/lib/common.js';
+import { getTestHelperConf } from '../src/common.js';
+import process from 'process';
+import { readFileSync } from 'fs';
+import { resolve } from 'path';
+import { testJsonFile } from '@mimik/local';
+
+const raw = readFileSync(`${testJsonFile}`, 'utf-8');
+const testEnv = JSON.parse(raw);
+
+const systemEndpoints = resolve('./test/src/systemEndpoints.js');
+// TODO: add the test filenames here
+
+const tests = () => {
+  describe('RUNNING API TEST FOR {{SERVICE_TYPE}} SERVICE (DETACHED MODE)', function apiTest() {
+    // eslint-disable-next-line no-invalid-this
+    this.timeout(API_TEST_TIMEOUT);
+
+    importTest('System Endpoint Tests', systemEndpoints);
+    // TODO: add the importTests here
+  });
+};
+const main = () => {
+  const isLocal = process.env.NODE_ENV === 'local';
+  const env = isLocal ? testEnv : process.env;
+  const app = isLocal ? `http://localhost:${env.SERVER_PORT}` : env.SERVER_URL;
+  const testHelperConfig = getTestHelperConf(app, isLocal, env);
+
+  runTests(testHelperConfig, tests);
+};
+
+main();

package/scaffoldFiles/test/mustacheHttp-test-normal.txt

@@ -0,0 +1,36 @@
+/* eslint-disable no-console, no-process-env, processDoc/validate-document-env */
+import { importTest, runTests } from '@mimik/test-helper';
+import { API_TEST_TIMEOUT } from '../../src/lib/common.js';
+import app from '../../src/index.js';
+import { getTestHelperConf } from '../src/common.js';
+import process from 'process';
+import { readFileSync } from 'fs';
+import { resolve } from 'path';
+import { testJsonFile } from '@mimik/local';
+
+const raw = readFileSync(`${testJsonFile}`, 'utf-8');
+const testEnv = JSON.parse(raw);
+
+const systemEndpoints = resolve('./test/src/systemEndpoints.js');
+// TODO: add the test filenames here
+
+const tests = () => {
+  describe('RUNNING API TEST FOR {{SERVICE_TYPE}} SERVICE', function apiTest() {
+    // eslint-disable-next-line no-invalid-this
+    this.timeout(API_TEST_TIMEOUT);
+
+    importTest('System Endpoint Tests', systemEndpoints);
+    // TODO: add the importTests here
+  });
+};
+const main = async () => {
+  const isLocal = process.env.NODE_ENV === 'local';
+  const env = isLocal ? testEnv : process.env;
+  const testHelperConfig = await getTestHelperConf(app, isLocal, env);
+
+  runTests(testHelperConfig, tests);
+};
+
+main().catch((err) => {
+  console.error('Failed to run tests:', err);
+});

package/scaffoldFiles/test/set-env.txt

@@ -0,0 +1,7 @@
+import { start2process, testJsonFile } from '@mimik/local';
+import { readFileSync } from 'fs';
+
+const raw = readFileSync(`${testJsonFile}`, 'utf-8');
+const testEnv = JSON.parse(raw);
+
+start2process(testEnv);

package/scaffoldFiles/test/systemEndpoints.txt

@@ -0,0 +1,87 @@
+/* eslint-disable no-process-env, processDoc/validate-document-env, import/no-extraneous-dependencies */
+import { ERROR_CODE, RESPONSE_CODE } from '@mimik/response-helper';
+import {
+  ROLES,
+  SERVICES,
+  getFixture,
+  getToken,
+  prepTokens,
+} from '@mimik/test-helper';
+import { base, baseAuth, basic } from './util.js';
+import { GET } from '../../src/lib/common.js';
+
+const TIMEOUT = getFixture('mochaSettings').timeout;
+const types = 'types=config&types=healthCheck'; // TODO: add the specific types here
+const adminToken = { role: ROLES.ADMIN, destType: SERVICES.{{SERVICE_TYPE}} };
+// TODO: create system token here
+// EXAMPLE:
+// const systemToken = { role: ROLES.SYSTEM, origType: SERVICES.MST, destType: SERVICES.{{SERVICE_TYPE}} };
+
+describe('Healthcheck, Metrics and Info Tests', function APITest() {
+  this.timeout(TIMEOUT);
+  // eslint-disable-next-line no-undef
+  before(async () => {
+    await prepTokens([adminToken, systemToken]);
+  });
+
+  it('should respond with 200 - get healthcheck', (done) => {
+    basic(GET, '/healthcheck')
+      .expect(RESPONSE_CODE.OK)
+      .end((err) => {
+        if (err) return done(err);
+        return done();
+      });
+  }).timeout(TIMEOUT);
+
+  it('should respond with 200 - get metrics', (done) => {
+    basic(GET, '/metrics')
+      .expect(RESPONSE_CODE.OK)
+      .end((err) => {
+        if (err) return done(err);
+        return done();
+      });
+  }).timeout(TIMEOUT);
+
+  it('should respond with 200 - get info (admin security)', (done) => {
+    baseAuth(GET, `/info?${types}`, getToken(adminToken))
+      .expect(RESPONSE_CODE.OK)
+      .end((err) => {
+        if (err) return done(err);
+        return done();
+      });
+  }).timeout(TIMEOUT);
+
+  it('should respond with 400 - empty types', (done) => {
+    baseAuth(GET, '/info', getToken(adminToken))
+      .query({ types: [] })
+      .expect(ERROR_CODE.PARAMETER)
+      .end(done);
+  }).timeout(TIMEOUT);
+
+  it('should respond with 400 - invalid types', (done) => {
+    baseAuth(GET, '/info', getToken(adminToken))
+      .query({ types: ['xyz'] })
+      .expect(ERROR_CODE.PARAMETER)
+      .end(done);
+  }).timeout(TIMEOUT);
+
+  it('should respond with 400 - get info with the wrong way to pass parameters', (done) => {
+    baseAuth(GET, '/info?types=healthCheck,config', getToken(adminToken))
+      .expect(ERROR_CODE.PARAMETER)
+      .end(done);
+  });
+
+  it('should respond with 401 - no auth', (done) => {
+    base(GET, '/info')
+      .query({ types: ['healthCheck'] })
+      .expect(ERROR_CODE.UNAUTHORIZED)
+      .end(done);
+  }).timeout(TIMEOUT);
+
+  it('should respond with 403 - System Security', (done) => {
+    baseAuth(GET, '/info', getToken(systemToken))
+      .query({ types: ['healthCheck'] })
+      .expect(ERROR_CODE.FORBIDDEN)
+      .end(done);
+  }).timeout(TIMEOUT);
+});

package/scaffoldFiles/test/util.txt

@@ -0,0 +1,36 @@
+/* eslint-disable no-process-env, processDoc/validate-document-env, import/no-extraneous-dependencies */
+import { GENERIC_HEADER, getFixture } from '@mimik/test-helper';
+import { expect } from 'chai';
+import process from 'node:process';
+import supertest from 'supertest';
+
+const BASE_PATH = process.env.BASE_PATH || getFixture.get('BASE_PATH');
+const app = getFixture('APP');
+
+const basic = (method, path) => supertest(app)[method](path).set(GENERIC_HEADER);
+const base = (method, path) => supertest(app)[method](`${BASE_PATH}${path}`).set(GENERIC_HEADER);
+const baseAuth = (method, path, token) => base(method, path).set(GENERIC_HEADER).set('Authorization', token);
+const handleError = (err, res, statusCode, message, cb) => {
+  if (err) return cb(err);
+  expect(res.body).to.be.an('object');
+  expect(res.body.statusCode).to.equal(statusCode);
+  if (message) expect(res.body.message).to.include(message);
+  return cb();
+};
+const audience = (type, audiences) => {
+  let result;
+
+  audiences.forEach((item) => {
+    if (item.type === type) result = item.audience;
+  });
+  return result;
+};
+
+export {
+  audience,
+  basic,
+  base,
+  baseAuth,
+  handleError,
+  expect,
+};

package/test.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+export LOG_LEVEL="error"
+export CONSOLE_LEVEL="error"
+node index.js