catalyst-core 0.0.1-beta.2 → 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,44 +2,53 @@
 
 Frontend framework with server rendering support for web applications.
 
-## Table of Contents 
+## Table of Contents
 
-- Overview
-- Initial setup
-- 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
 
-## Initial Setup 
-Run the following commands in the directory where you want to scaffold catalyst app.
+**System Requirements**
 
-```js
-npx create-catalyst-app
-```
-
-if this steps fails, make sure .npmrc file exists and token used is a valid one.
+-   Node version 20.4.0 or later
+-   macOS and Linux are supported
 
-If successful, cli for setup will appear.
+**Automatic Installation**
 
-Select js for the language and Redux for state management option. (we’ll be adding ts support soon) 
+-   Run the following commands in the directory where you want to set up the Catalyst app.
 
-After selecting options
 ```js
-cd my-app && npm i
+npx create-catalyst-app@latest
 ```
-For starting the project
+
+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.
+
 ```js
-npm run start
+cd project-name && npm run start
 ```
 
-## Data Fetching with Catalyst 
+-   Navigate to http://localhost:3005
+
+The dev server should be running now.
+
+Visit our official documentation:
+https://catalyst.1mg.com/public_docs/content/installation
+
+## Data Fetching with Catalyst
 
 we have serverFetcher function for fetching with SSR and clientFetcher function for fetching during client side rendering and navigations.
 
@@ -48,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**
@@ -67,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()
@@ -94,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) => {
@@ -129,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,41 +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=== 'prepare' || x=== 'serve'
-);
-const script = scriptIndex === -1 ? args[0] : args[scriptIndex];
-const nodeArgs = scriptIndex > 0 ? args.slice(0, scriptIndex) : [];
-if (['build', 'start', 'prepare', '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 + '".');
-  console.log('Perhaps you need to update framework?');
 }

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

@@ -1,8 +1,7 @@
 {
     "cssModulesIdentifierDev": "[name]__[local]",
     "cssModulesIdentifierProd": "[name]__[local]__[hash:base64:5]",
-    "analyzeBundle": false,
     "chunkFileNameDev": "[name].bundle.js",
     "chunkFileNameProd": "[name].[contenthash].js",
     "cssChunkFileName": "[name].[contenthash].css"
-}
+}

package/{LICENSE → license}

@@ -6,4 +6,5 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/{logger/index.js → logger.js}

@@ -10,13 +10,13 @@ const {
 } = winston;
 
 /**
- * @description Logger library with rotational strategy. Creates a logs folder in root. 
+ * @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 {
@@ -25,7 +25,7 @@ const configureLogger = (config = {}) => {
     enableConsoleLogging = true
   } = config;
   const consoleTransport = new transports.Console({
-    level: 'debug'
+    level: "debug"
   });
   const fileTransport = (type = "info") => {
     return new DailyRotateFile({
@@ -39,7 +39,7 @@ const configureLogger = (config = {}) => {
   };
   const infoLogger = createLogger({
     format: format.combine(format.timestamp({
-      format: 'YYYY-MM-DD HH:mm:ss'
+      format: "YYYY-MM-DD HH:mm:ss"
     }), format.json()),
     defaultMeta: {
       loglevel: "info"
@@ -47,7 +47,7 @@ const configureLogger = (config = {}) => {
   });
   const debugLogger = createLogger({
     format: format.combine(format.timestamp({
-      format: 'YYYY-MM-DD HH:mm:ss'
+      format: "YYYY-MM-DD HH:mm:ss"
     }), format.json()),
     defaultMeta: {
       loglevel: "debug"
@@ -55,7 +55,7 @@ const configureLogger = (config = {}) => {
   });
   const errorLogger = createLogger({
     format: format.combine(format.timestamp({
-      format: 'YYYY-MM-DD HH:mm:ss'
+      format: "YYYY-MM-DD HH:mm:ss"
     }), format.json()),
     defaultMeta: {
       loglevel: "error"
@@ -67,23 +67,26 @@ const configureLogger = (config = {}) => {
     errorLogger.add(consoleTransport);
   }
   if (enableFileLogging && JSON.parse(enableFileLogging)) {
-    infoLogger.add(fileTransport('info'));
-    debugLogger.add(fileTransport('debug'));
-    errorLogger.add(fileTransport('error'));
+    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);
     };