catalyst-core 0.0.1-beta.4 → 0.0.1-beta.6

package/package.json

@@ -1,89 +1,111 @@
 {
-  "name": "catalyst-core",
-  "version": "0.0.1-beta.4",
-  "main": "index.js",
-  "description": "Web framework that provides great performance out of the box",
-  "bin": {
-    "catalyst": "bin/catalyst.js"
-  },
-  "scripts": {
-    "prepare": "babel src --out-dir .",
-    "start": "node ./scripts/checkVersion && npm run start:client & npm run start:server",
-    "start:client": "npx babel-node -r ./scripts/loadScriptsBeforeServerStarts.js webpack/development.client.babel --no-warnings=ExperimentalWarning --no-warnings=BABEL",
-    "start:server": "npx babel-node -r ./scripts/loadScriptsBeforeServerStarts.js ./server/startServer.js --watch-path=${npm_config_src_path}/server --watch-path=${npm_config_src_path}/src --ignore='__IGNORE__' --no-warnings=ExperimentalWarning --no-warnings=BABEL",
-    "build": "node ./scripts/checkVersion && npm run build:prepare && npm run build:client && npm run build:ssr && npm run build:server",
-    "build:prepare": "rm -rf ${npm_config_src_path}/${build_output_path} & node ./scripts/loadScriptsBeforeServerStarts.js",
-    "build:client": "APPLICATION=${npm_config_app_name} webpack --config ./webpack/production.client.babel.js --progress",
-    "build:ssr": "APPLICATION=${npm_config_app_name} SSR=true webpack --config ./webpack/production.ssr.babel.js --progress",
-    "build:server": "APPLICATION=${npm_config_app_name} npx babel ./server --out-dir ${npm_config_src_path}/${build_output_path} --ignore '**/*.test.js,./server/renderer/handler.js' && APPLICATION=${npm_config_app_name} npx babel ${npm_config_src_path}/server --out-dir ${npm_config_src_path}/${build_output_path}",
-    "serve": "APPLICATION=${npm_config_app_name} node -r ./scripts/loadScriptsBeforeServerStarts.js ${npm_config_src_path}/${build_output_path}/startServer.js",
-    "prepublishOnly": "npm i && npm run prepare",
-    "lint": "eslint .",
-    "prettify": "prettier . --write"
-  },
-  "license": "MIT",
-  "dependencies": {
-    "@babel/cli": "^7.23.0",
-    "@babel/core": "^7.23.2",
-    "@babel/node": "^7.22.19",
-    "@babel/preset-env": "^7.23.2",
-    "@babel/preset-react": "^7.22.15",
-    "@babel/register": "^7.22.15",
-    "@dr.pogodin/css-modules-require-hook": "^4.7.3",
-    "@loadable/babel-plugin": "^5.16.1",
-    "@loadable/component": "^5.15.3",
-    "@loadable/server": "^5.16.1",
-    "@loadable/webpack-plugin": "^5.15.2",
-    "@pmmmwh/react-refresh-webpack-plugin": "^0.5.11",
-    "@svgr/webpack": "^8.1.0",
-    "@tata1mg/router": "^0.0.1-beta.1",
-    "app-root-path": "^3.1.0",
-    "babel-loader": "^9.1.3",
-    "babel-plugin-transform-react-remove-prop-types": "^0.4.24",
-    "body-parser": "^1.20.2",
-    "chokidar": "^3.6.0",
-    "compression": "^1.7.4",
-    "cookie-parser": "^1.4.6",
-    "css-hot-loader": "^1.4.4",
-    "css-loader": "^6.8.1",
-    "express": "^4.18.2",
-    "express-static-gzip": "^2.1.7",
-    "file-loader": "^6.2.0",
-    "html-loader": "^4.2.0",
-    "img-loader": "^4.0.0",
-    "mini-css-extract-plugin": "^2.7.6",
-    "module-alias": "^2.2.3",
-    "picocolors": "^1.0.0",
-    "postcss-loader": "^7.3.3",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-redux": "^8.1.3",
-    "react-refresh": "^0.14.0",
-    "react-router-dom": "^6.16.0",
-    "redux": "^4.2.1",
-    "sass": "^1.69.5",
-    "sass-loader": "^13.3.2",
-    "sass-resources-loader": "^2.2.5",
-    "ua-parser-js": "^1.0.37",
-    "url": "^0.11.3",
-    "url-loader": "^4.1.1",
-    "webpack": "^5.88.2",
-    "webpack-bundle-analyzer": "^4.9.1",
-    "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^4.15.2",
-    "webpack-merge": "^5.9.0",
-    "webpack-node-externals": "^3.0.0",
-    "winston": "^3.11.0",
-    "winston-daily-rotate-file": "^5.0.0"
-  },
-  "devDependencies": {
-    "@babel/eslint-parser": "^7.19.1",
-    "eslint": "^8.26.0",
-    "eslint-plugin-babel": "^5.3.1",
-    "eslint-plugin-react": "^7.34.1",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-risxss": "^2.1.0",
-    "eslint-plugin-security": "^3.0.0",
-    "prettier": "^3.2.5"
-  }
+    "name": "catalyst-core",
+    "version": "0.0.1-beta.6",
+    "main": "index.js",
+    "description": "Web framework that provides great performance out of the box",
+    "bin": {
+        "catalyst": "bin/catalyst.js"
+    },
+    "_moduleAliases": {
+        "@catalyst/template": ".",
+        "@catalyst/template/src": "src",
+        "@catalyst/template/routes": "src/js/routes",
+        "@catalyst/template/server": "server",
+        "@catalyst/template/store": "src/js/store",
+        "@catalyst/template/config": "config",
+        "@catalyst": ".",
+        "@catalyst/root": "../",
+        "@catalyst/router": "router",
+        "@catalyst/scripts": "scripts",
+        "@catalyst/server": "server",
+        "@catalyst/webpack": "webpack"
+    },
+    "exports": {
+        ".": "./dist/index.js",
+        "./logger": "./dist/logger.js",
+        "./caching": "./dist/caching.js",
+        "./router/ClientRouter": "./dist/router/ClientRouter.js"
+    },
+    "scripts": {
+        "lint": "eslint .",
+        "lint-staged": "lint-staged",
+        "prettify": "prettier . --write",
+        "prepare": "babel src --out-dir ./dist",
+        "prepublishOnly": "npm i && npm run prepare"
+    },
+    "license": "MIT",
+    "dependencies": {
+        "@babel/cli": "^7.23.0",
+        "@babel/core": "^7.23.2",
+        "@babel/node": "^7.22.19",
+        "@babel/preset-env": "^7.23.2",
+        "@babel/preset-react": "^7.22.15",
+        "@babel/register": "^7.22.15",
+        "@dr.pogodin/css-modules-require-hook": "^4.7.3",
+        "@loadable/babel-plugin": "^5.16.1",
+        "@loadable/component": "^5.15.3",
+        "@loadable/server": "^5.16.1",
+        "@loadable/webpack-plugin": "^5.15.2",
+        "@pmmmwh/react-refresh-webpack-plugin": "^0.5.11",
+        "@svgr/webpack": "^8.1.0",
+        "@tata1mg/router": "^0.0.1-beta.2",
+        "app-root-path": "^3.1.0",
+        "babel-loader": "^9.1.3",
+        "babel-plugin-transform-react-remove-prop-types": "^0.4.24",
+        "body-parser": "^1.20.2",
+        "chokidar": "^3.6.0",
+        "compression": "^1.7.4",
+        "cookie-parser": "^1.4.6",
+        "css-hot-loader": "^1.4.4",
+        "css-loader": "^6.8.1",
+        "express": "^4.18.2",
+        "express-static-gzip": "^2.1.7",
+        "file-loader": "^6.2.0",
+        "html-loader": "^4.2.0",
+        "img-loader": "^4.0.0",
+        "mini-css-extract-plugin": "^2.7.6",
+        "module-alias": "^2.2.3",
+        "picocolors": "^1.0.0",
+        "postcss-loader": "^7.3.3",
+        "react": "^18.2.0",
+        "react-dom": "^18.2.0",
+        "react-redux": "^8.1.3",
+        "react-refresh": "^0.14.0",
+        "react-router-dom": "^6.16.0",
+        "redux": "^4.2.1",
+        "sass": "^1.69.5",
+        "sass-loader": "^13.3.2",
+        "sass-resources-loader": "^2.2.5",
+        "ua-parser-js": "^1.0.37",
+        "url": "^0.11.3",
+        "url-loader": "^4.1.1",
+        "webpack": "^5.88.2",
+        "webpack-bundle-analyzer": "^4.9.1",
+        "webpack-cli": "^5.1.4",
+        "webpack-dev-server": "^4.15.2",
+        "webpack-merge": "^5.9.0",
+        "webpack-node-externals": "^3.0.0",
+        "winston": "^3.11.0",
+        "winston-daily-rotate-file": "^5.0.0"
+    },
+    "devDependencies": {
+        "@babel/eslint-parser": "^7.19.1",
+        "@commitlint/cli": "^19.3.0",
+        "@commitlint/config-conventional": "^19.2.2",
+        "eslint": "^8.26.0",
+        "eslint-plugin-babel": "^5.3.1",
+        "eslint-plugin-react": "^7.34.1",
+        "eslint-plugin-react-hooks": "^4.6.0",
+        "eslint-plugin-risxss": "^2.1.0",
+        "eslint-plugin-security": "^3.0.0",
+        "husky": "^9.0.11",
+        "lint-staged": "^15.2.2",
+        "prettier": "^3.2.5"
+    },
+    "lint-staged": {
+        "*.{js,jsx}": [
+            "eslint .",
+            "prettier . --write"
+        ]
+    }
 }

package/.eslintignore

@@ -1,9 +0,0 @@
-**/node_modules/*
-**/router/*
-**/scripts/*
-**/server/*
-**/webpack/*
-
-caching.js
-index.js
-logger.js

package/.eslintrc

@@ -1,92 +0,0 @@
-{
-    "parser": "@babel/eslint-parser",
-    "rules": {
-        "no-console": "error",
-        "react/prop-types": 1,
-        "react/display-name": [
-            0,
-            {
-                "ignoreTranspilerName": true
-            }
-        ],
-        "react-hooks/exhaustive-deps": "error", // Checks effect dependencies
-        "no-prototype-builtins": "off",
-        "security/detect-possible-timing-attacks": "error",
-        "security/detect-child-process": "error",
-        "security/detect-eval-with-expression": "error",
-        "security/detect-new-buffer": "error",
-        "security/detect-no-csrf-before-method-override": "error",
-        "risxss/catch-potential-xss-react": [
-            "error",
-            {
-                "trustedLibraries": [
-                    "@commonUtils"
-                ]
-            }
-        ],
-        "react/jsx-no-target-blank": [
-            0,
-            {
-                "enforceDynamicLinks": "never"
-            }
-        ]
-    },
-    "env": {
-        "browser": true,
-        "es6": true,
-        "jest": true,
-        "node": true
-    },
-    "globals": {
-        "expect": true,
-        "__non_webpack_require__": true,
-        "logger": "readonly",
-        "AppCallbacks": "readonly"
-    },
-    "extends": [
-        "eslint:recommended",
-        "plugin:react/recommended"
-    ],
-    "parserOptions": {
-        "sourceType": "module",
-        "ecmaFeatures": {
-            "experimentalObjectRestSpread": true,
-            "jsx": true
-        },
-        "babelOptions": {
-            "configFile": "./babel.config.json"
-        },
-        "ecmaVersion": 6
-    },
-    "plugins": [
-        "babel",
-        "react",
-        "react-hooks",
-        "security",
-        "risxss"
-    ],
-    "settings": {
-        "react": {
-            "createClass": "createReactClass",
-            "pragma": "React",
-            "version": "detect"
-        },
-        "propWrapperFunctions": [
-            "forbidExtraProps",
-            {
-                "property": "freeze",
-                "object": "Object"
-            },
-            {
-                "property": "myFavoriteWrapper"
-            }
-        ],
-        "linkComponents": [
-            "Hyperlink",
-            {
-                "name": "Link",
-                "linkAttribute": "to"
-            }
-        ]
-    }
-}

package/caching.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _apiCaching = require("@tata1mg/api-caching");
-Object.keys(_apiCaching).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _apiCaching[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _apiCaching[key];
-    }
-  });
-});

package/index.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _index = require("./server/renderer/document/index");
-Object.keys(_index).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _index[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _index[key];
-    }
-  });
-});

package/logger.js

@@ -1,99 +0,0 @@
-"use strict";
-
-const winston = require("winston");
-const DailyRotateFile = require("winston-daily-rotate-file");
-const pc = require("picocolors");
-const {
-  createLogger,
-  format,
-  transports
-} = winston;
-
-/**
- * @description Logger library with rotational strategy. Creates a logs folder in root.
- *              With debug, error and info log directories with their respective log files.
- *
- * @format Logstash with timestamp
- * @param config { @enableDebugLogs: Bool // default: true }
- * @returns loggerInstance
- *
- */
-const configureLogger = (config = {}) => {
-  const {
-    enableDebugLogs = true,
-    enableFileLogging = true,
-    enableConsoleLogging = true
-  } = config;
-  const consoleTransport = new transports.Console({
-    level: "debug"
-  });
-  const fileTransport = (type = "info") => {
-    return new DailyRotateFile({
-      filename: `./logs/${type}/%DATE%.${type}.log`,
-      datePattern: "YYYY-MM-DD",
-      maxFiles: "3d",
-      // Logs will be removed after 2days,
-      loglevel: type,
-      level: type
-    });
-  };
-  const infoLogger = createLogger({
-    format: format.combine(format.timestamp({
-      format: "YYYY-MM-DD HH:mm:ss"
-    }), format.json()),
-    defaultMeta: {
-      loglevel: "info"
-    }
-  });
-  const debugLogger = createLogger({
-    format: format.combine(format.timestamp({
-      format: "YYYY-MM-DD HH:mm:ss"
-    }), format.json()),
-    defaultMeta: {
-      loglevel: "debug"
-    }
-  });
-  const errorLogger = createLogger({
-    format: format.combine(format.timestamp({
-      format: "YYYY-MM-DD HH:mm:ss"
-    }), format.json()),
-    defaultMeta: {
-      loglevel: "error"
-    }
-  });
-  if (enableConsoleLogging && JSON.parse(enableConsoleLogging)) {
-    infoLogger.add(consoleTransport);
-    debugLogger.add(consoleTransport);
-    errorLogger.add(consoleTransport);
-  }
-  if (enableFileLogging && JSON.parse(enableFileLogging)) {
-    infoLogger.add(fileTransport("info"));
-    debugLogger.add(fileTransport("debug"));
-    errorLogger.add(fileTransport("error"));
-  }
-  const Logger = {
-    debug: () => {},
-    error: msg => {
-      /* eslint-disable no-console */
-      console.log(pc.red(pc.bold("ERROR: " + JSON.stringify(msg))));
-      errorLogger.error(msg);
-    },
-    info: msg => {
-      /* eslint-disable no-console */
-      console.log(pc.green(pc.bold("INFO: " + JSON.stringify(msg))));
-      infoLogger.info(msg);
-    }
-  };
-  if (enableDebugLogs && JSON.parse(enableDebugLogs)) {
-    Logger.debug = msg => {
-      /* eslint-disable no-console */
-      console.log(pc.yellow(pc.bold("DEBUG: " + JSON.stringify(msg))));
-      debugLogger.debug(msg);
-    };
-  }
-  if (global) global.logger = Logger;
-  return Logger;
-};
-module.exports = {
-  configureLogger
-};

package/router/ClientRouter.js

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _router = require("@tata1mg/router");
-var _utils = require("@routes/utils.js");
-/**
- * @returns returns browsers routers (client routes)
- */
-const clientRouter = ({
-  store,
-  routerInitialState
-}) => (0, _router.createBrowserRouter)((0, _utils.preparedRoutes)({
-  store,
-  routerInitialState
-}));
-var _default = exports.default = clientRouter;

package/router/ServerRouter.js

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _router = require("@tata1mg/router");
-var _utils = require("@routes/utils.js");
-const ServerRouter = reduxData => {
-  const {
-    store,
-    intialData
-  } = reduxData;
-  return (0, _router.useRoutes)((0, _utils.preparedRoutes)({
-    store,
-    routerInitialState: intialData
-  }));
-};
-var _default = exports.default = ServerRouter;

package/router/index.js

@@ -1,32 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.preparedRoutes = exports.default = void 0;
-var _react = _interopRequireDefault(require("react"));
-var _validator = require("../scripts/validator.js");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const {
-  default: routes
-} = require(`${process.env.src_path}src/js/routes/index.js`);
-/**
- * @description prepares routes from routes defined inside template. 
- *              Adds path and element key inside each route. 
- * @returns returns routes list after modifiing template routes
-*/
-
-const getRoutes = (0, _validator.validateGetRoutes)(routes) ? routes : [];
-const preparedRoutes = () => {
-  return getRoutes()?.map((route, index) => {
-    const Component = route.element;
-    return {
-      path: route.path,
-      element: /*#__PURE__*/_react.default.createElement(Component, {
-        key: index
-      })
-    };
-  });
-};
-exports.preparedRoutes = preparedRoutes;
-var _default = exports.default = getRoutes;

package/router.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _router = require("@tata1mg/router");
-Object.keys(_router).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _router[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _router[key];
-    }
-  });
-});

package/scripts/build.js

@@ -1,42 +0,0 @@
-"use strict";
-
-const {
-  spawnSync
-} = require("child_process");
-const path = require("path");
-const {
-  name
-} = require(`${process.env.PWD}/package.json`);
-const {
-  BUILD_OUTPUT_PATH
-} = require(`${process.env.PWD}/config/config.json`);
-function arrayToObject(array) {
-  const obj = {};
-  array.forEach(item => {
-    const [key, value] = item.split("=");
-    if (value) obj[key] = value;
-  });
-  return obj;
-}
-
-/**
- * @description - creates a production build of the application.
- */
-function start() {
-  const commandLineArguments = process.argv.slice(2);
-  const argumentsObject = arrayToObject(commandLineArguments);
-  const dirname = path.resolve(__dirname, "../");
-  spawnSync("npm", ["run", "build", `--src_path=${process.env.PWD}`, `--app_name=${name || "catalyst_app"}`], {
-    cwd: dirname,
-    stdio: "inherit",
-    env: {
-      ...process.env,
-      src_path: process.env.PWD,
-      build_output_path: BUILD_OUTPUT_PATH,
-      NODE_ENV: "production",
-      IS_DEV_COMMAND: false,
-      ...argumentsObject
-    }
-  });
-}
-start();

package/scripts/checkVersion.js

@@ -1,5 +0,0 @@
-"use strict";
-
-if (process.versions.node.split(".")[0] < 20) {
-  console.error("\x1b[31m%s\x1b[0m", "use node version >=20");
-}

package/scripts/devBuild.js

@@ -1,42 +0,0 @@
-"use strict";
-
-const {
-  spawnSync
-} = require("child_process");
-const path = require("path");
-const {
-  name
-} = require(`${process.env.PWD}/package.json`);
-const {
-  BUILD_OUTPUT_PATH
-} = require(`${process.env.PWD}/config/config.json`);
-function arrayToObject(array) {
-  const obj = {};
-  array.forEach(item => {
-    const [key, value] = item.split("=");
-    if (value) obj[key] = value;
-  });
-  return obj;
-}
-
-/**
- * @description - creates a production build of the application.
- */
-function start() {
-  const commandLineArguments = process.argv.slice(2);
-  const argumentsObject = arrayToObject(commandLineArguments);
-  const dirname = path.resolve(__dirname, "../");
-  spawnSync("npm", ["run", "build", `--src_path=${process.env.PWD}`, `--app_name=${name || "catalyst_app"}`], {
-    cwd: dirname,
-    stdio: "inherit",
-    env: {
-      ...process.env,
-      src_path: process.env.PWD,
-      build_output_path: BUILD_OUTPUT_PATH,
-      NODE_ENV: "production",
-      IS_DEV_COMMAND: true,
-      ...argumentsObject
-    }
-  });
-}
-start();