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

package/.eslintignore

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

package/.eslintrc

@@ -0,0 +1,92 @@
+{
+    "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/README.md

@@ -2,32 +2,30 @@
 
 Frontend framework with server rendering support for web applications.
 
-## Table of Contents 
+## Table of Contents
 
-- Overview
-- Installation
-- Data Fetching with Catalyst
-    - serverFetcher
-    - clientFetcher
-    - refetch (for data revalidation)
-- State Management
+-   Overview
+-   Installation
+-   Data Fetching with Catalyst
+    -   serverFetcher
+    -   clientFetcher
+    -   refetch (for data revalidation)
+-   State Management
 
-## Overview 
+## Overview
 
 This package provides a way to proxy your request through your server. It allows you to cache your incoming request to improve your server response time.
 
-
 ## Installation
 
 **System Requirements**
 
-- Node version 20.4.0 or later
-- macOS and Linux are supported
-
+-   Node version 20.4.0 or later
+-   macOS and Linux are supported
 
 **Automatic Installation**
 
-- Run the following commands in the directory where you want to set up the Catalyst app.
+-   Run the following commands in the directory where you want to set up the Catalyst app.
 
 ```js
 npx create-catalyst-app@latest
@@ -35,24 +33,22 @@ npx create-catalyst-app@latest
 
 If successful, you will see the following prompts in your terminal.
 
-- Enter the name of your Catalyst application.
-- Choose state management.
-- Once packages are installed,start the development server by running the following command.
+-   Enter the name of your Catalyst application.
+-   Choose state management.
+-   Once packages are installed,start the development server by running the following command.
 
 ```js
 cd project-name && npm run start
 ```
 
-- Navigate to http://localhost:3005
+-   Navigate to http://localhost:3005
 
 The dev server should be running now.
 
-Visit our official documentation: 
+Visit our official documentation:
 https://catalyst.1mg.com/public_docs/content/installation
 
-
-
-## Data Fetching with Catalyst 
+## Data Fetching with Catalyst
 
 we have serverFetcher function for fetching with SSR and clientFetcher function for fetching during client side rendering and navigations.
 
@@ -61,18 +57,22 @@ we have serverFetcher function for fetching with SSR and clientFetcher function
 server fetcher will get request, request params, search params and store (if project is setup with redux or rtk) as arguments. We can declare it as an async function and use await for fetching or use then chaining for data fetching.
 
 if server fetcher is called for a route then client fetcher will not be called for that route, unless called with refetch.
+
 ```js
-Home.serverFetcher = async ({ req,params,searchParams }, { store }) => {
-  store.dispatch(someAction())
-  const res = await fetch("some_url");
-  const json = await res.json();
-  return json;
-};
+Home.serverFetcher = async ({ req, params, searchParams }, { store }) => {
+    store.dispatch(someAction())
+    const res = await fetch("some_url")
+    const json = await res.json()
+    return json
+}
 ```
+
 data returned from fetcher function will be accessible through useCurrentRouteData() hook provided by router.
+
 ```js
-const [data,error,isFetched] = useCurrentRouteData()
+const [data, error, isFetched] = useCurrentRouteData()
 ```
+
 error and loading state would be handled by router.
 
 **clientFetcher**
@@ -80,24 +80,25 @@ error and loading state would be handled by router.
 client fetcher would be called on client side rendering and client side navigations. `store` would be available as a param in client side for dispatching redux/rtk actions.
 
 ```js
-Home.clientFetcher = async ({route,location,params,searchParams,navigate},{store}) => {
-  store.dispatch(someAction())
-  const res = await fetch("some_url");
-  const json = await res.json();
-  return json;
-};
+Home.clientFetcher = async ({ route, location, params, searchParams, navigate }, { store }) => {
+    store.dispatch(someAction())
+    const res = await fetch("some_url")
+    const json = await res.json()
+    return json
+}
 ```
-data returned from client fetcher function will be accessible through  useCurrentRouteData() hook provided by router (hook for data access through client is same).
+
+data returned from client fetcher function will be accessible through useCurrentRouteData() hook provided by router (hook for data access through client is same).
+
 ```js
-const [data,error,isFetched] = useCurrentRouteData()
+const [data, error, isFetched] = useCurrentRouteData()
 ```
 
-
 **refetch (for data revalidation)**
 
 refetch function can be used were we need to execute clientFetcher based on some condition(such as for infinite scroll or some state change inside container or onClick.)
 
-We can pass arguments in refetch function which would 
+We can pass arguments in refetch function which would
 
 ```js
 const [data,error,isFetched,refetch] = useCurrentRouteData()
@@ -107,20 +108,20 @@ useEffect(()=>{
 },[arg])
 
 clientFetcher = ({},{refetchArgument}) => {
- 
+
   const res = await api_call // refetchArg can be used as a param in api call
   return res
 }
 
 ```
 
-
 ## State Management
+
 state management wrappers are defined in stateProvider.js file
 
 store can be configured by manipulating store/index.js as per user requirements (custom middlewares etc can be added in this way.
 
-initial state and request object would be provided in createStore function which will be called on server and client, we use the params to add additional arguments and middlewares in redux store. 
+initial state and request object would be provided in createStore function which will be called on server and client, we use the params to add additional arguments and middlewares in redux store.
 
 ```js
 const configureStore = (initialState, cookies, requestObj, customHeaders) => {
@@ -142,4 +143,5 @@ export default configureStore
 ```
 
 ## Documentation
+
 Visit https://catalyst.1mg.com to view the full documentation.

package/babel.config.json

@@ -10,11 +10,7 @@
         ],
         "@babel/preset-react"
     ],
-    "plugins": [
-        "@babel/plugin-proposal-object-rest-spread",
-        "transform-class-properties",
-        "@loadable/babel-plugin"
-    ],
+    "plugins": ["@loadable/babel-plugin"],
     "env": {
         "test": {
             "presets": ["@babel/preset-react"]

package/bin/catalyst.js

@@ -1,40 +1,41 @@
 #!/usr/bin/env node
-'use strict';
-process.on('unhandledRejection', err => {
-    throw err;
-});
-const { spawnSync } = require('node:child_process');
-const args = process.argv.slice(2);
+"use strict"
+process.on("unhandledRejection", (err) => {
+    throw err
+})
+const { spawnSync } = require("node:child_process")
+const args = process.argv.slice(2)
 const scriptIndex = args.findIndex(
-  x => x === 'build' || x === 'start' || x=== 'serve'
-);
-const script = scriptIndex === -1 ? args[0] : args[scriptIndex];
-const nodeArgs = scriptIndex > 0 ? args.slice(0, scriptIndex) : [];
-if (['build', 'start', 'serve'].includes(script)) {
-  const result = spawnSync(
-    process.execPath,
-    nodeArgs
-      .concat(require.resolve('../scripts/' + script))
-      .concat(args.slice(scriptIndex + 1)),
-    { stdio: 'inherit' }
-  );
-  if (result.signal) {
-    if (result.signal === 'SIGKILL') {
-      console.log(
-        'The build failed because the process exited too early. ' +
-          'This probably means the system ran out of memory or someone called ' +
-          '`kill -9` on the process.'
-      );
-    } else if (result.signal === 'SIGTERM') {
-      console.log(
-        'The build failed because the process exited too early. ' +
-          'Someone might have called `kill` or `killall`, or the system could ' +
-          'be shutting down.'
-      );
+    (x) => x === "build" || x === "start" || x === "serve" || x === "devBuild" || x === "devServe"
+)
+const script = scriptIndex === -1 ? args[0] : args[scriptIndex]
+const nodeArgs = scriptIndex > 0 ? args.slice(0, scriptIndex) : []
+if (["build", "start", "serve", "devBuild", "devServe"].includes(script)) {
+    const result = spawnSync(
+        process.execPath,
+        nodeArgs.concat(require.resolve("../scripts/" + script)).concat(args.slice(scriptIndex + 1)),
+        { stdio: "inherit" }
+    )
+    if (result.signal) {
+        if (result.signal === "SIGKILL") {
+          /* eslint-disable no-console */
+            console.log(
+                "The build failed because the process exited too early. " +
+                    "This probably means the system ran out of memory or someone called " +
+                    "`kill -9` on the process."
+            )
+        } else if (result.signal === "SIGTERM") {
+          /* eslint-disable no-console */
+            console.log(
+                "The build failed because the process exited too early. " +
+                    "Someone might have called `kill` or `killall`, or the system could " +
+                    "be shutting down."
+            )
+        }
+        process.exit(1)
     }
-    process.exit(1);
-  }
-  process.exit(result.status);
+    process.exit(result.status)
 } else {
+  /* eslint-disable no-console */
   console.log('Unknown script "' + script + '".');
 }

package/changelog.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## [0.0.1-beta.4] - 05-08-2024
+### Added
+- Implemented dynamic metadata for nested routing.
+- Dev build and dev serve configurations for a smoother development experience.([Refer documenatation](https://catalyst.1mg.com/public_docs/content/deployment))
+- ESLint security rules for improved code security.
+
+### Changed
+- Security audit conducted on all packages.
+- Removed Babel packages already included in the Babel preset.
+- Updated router version to support nested routing. (0.0.1-beta.0 to 0.0.1-beta.1)
+
+### Deprecated
+- `metadataFunction` is deprecated and has been renamed to `setMetaData`.
+
+### Removed
+- Redundant Babel packages removed, reducing dependencies.
+
+### Fixed
+- Updated documentation to reflect the latest changes.
+
+### Breaking Changes
+- The `metadataFunction` has been renamed to `setMetaData`. Update your code accordingly.
+- The `preparedRoutes` function now supports nested routing. Modify your routing setup to use this new functionality.
+- For more information on handling these changes, please refer to the [migration guide](https://catalyst.1mg.com/content/migration_guide/0.0.1-beta.4)  in the documentation.

package/config.json

@@ -4,4 +4,4 @@
     "chunkFileNameDev": "[name].bundle.js",
     "chunkFileNameProd": "[name].[contenthash].js",
     "cssChunkFileName": "[name].[contenthash].css"
-}
+}

package/logger.js

@@ -74,16 +74,19 @@ const configureLogger = (config = {}) => {
   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);
     };

package/package.json

@@ -1,85 +1,89 @@
 {
-   "name": "catalyst-core",
-   "version": "0.0.1-beta.3",
-   "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} NODE_ENV=production  webpack --config ./webpack/production.client.babel.js --progress",
-      "build:ssr": "APPLICATION=${npm_config_app_name} NODE_ENV=production SSR=true webpack --config ./webpack/production.ssr.babel.js --progress",
-      "build:server": "APPLICATION=${npm_config_app_name} NODE_ENV=production 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_ENV=production node -r ./scripts/loadScriptsBeforeServerStarts.js ${npm_config_src_path}/${build_output_path}/startServer.js",
-      "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/plugin-proposal-object-rest-spread": "^7.20.7",
-      "@babel/plugin-transform-react-jsx": "^7.22.15",
-      "@babel/preset-env": "^7.23.2",
-      "@babel/preset-react": "^7.22.15",
-      "@babel/register": "^7.22.15",
-      "@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.0",
-      "app-root-path": "^3.1.0",
-      "babel-loader": "^9.1.3",
-      "babel-plugin-dynamic-import-node": "^2.3.3",
-      "babel-plugin-syntax-dynamic-import": "^6.18.0",
-      "babel-plugin-transform-class-properties": "^6.24.1",
-      "babel-plugin-transform-es2015-modules-commonjs": "^6.26.2",
-      "babel-plugin-transform-export-extensions": "^6.22.0",
-      "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",
-      "css-modules-require-hook": "^4.2.3",
-      "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",
-      "isomorphic-dompurify": "^1.13.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"
-   }
+  "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"
+  }
 }