catalyst-core 0.0.1-beta.2

package/.prettierignore

@@ -0,0 +1,2 @@
+**/*.html
+

package/.prettierrc.json

@@ -0,0 +1,7 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": false,
+    "arrowParens": "always",
+    "printWidth": 110
+}

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 1mg Healthcare Solutions Private Limited.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+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.

package/README.md

@@ -0,0 +1,132 @@
+# Catalyst
+
+Frontend framework with server rendering support for web applications.
+
+## Table of Contents 
+
+- Overview
+- Initial setup
+- Data Fetching with Catalyst
+    - serverFetcher
+    - clientFetcher
+    - refetch (for data revalidation)
+- State Management
+
+## 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.
+
+
+## Initial Setup 
+Run the following commands in the directory where you want to scaffold catalyst app.
+
+```js
+npx create-catalyst-app
+```
+
+if this steps fails, make sure .npmrc file exists and token used is a valid one.
+
+If successful, cli for setup will appear.
+
+Select js for the language and Redux for state management option. (we’ll be adding ts support soon) 
+
+After selecting options
+```js
+cd my-app && npm i
+```
+For starting the project
+```js
+npm run start
+```
+
+## Data Fetching with Catalyst 
+
+we have serverFetcher function for fetching with SSR and clientFetcher function for fetching during client side rendering and navigations.
+
+**serverFetcher**
+
+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;
+};
+```
+data returned from fetcher function will be accessible through useCurrentRouteData() hook provided by router.
+```js
+const [data,error,isFetched] = useCurrentRouteData()
+```
+error and loading state would be handled by router.
+
+**clientFetcher**
+
+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;
+};
+```
+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()
+```
+
+
+**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 
+
+```js
+const [data,error,isFetched,refetch] = useCurrentRouteData()
+
+useEffect(()=>{
+  refetch({refetchArgument:some_value})
+},[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. 
+
+```js
+const configureStore = (initialState, cookies, requestObj, customHeaders) => {
+    const api = fetchInstance
+    const store = createStore({
+        reducer: rootReducer,
+        middleware: (getDefaultMiddleware) =>
+            getDefaultMiddleware({
+                thunk: {
+                    extraArgument: { api },
+                },
+            }),
+        preloadedState: initialState,
+    })
+    return store
+}
+
+export default configureStore
+```
+
+## Documentation
+Visit https://catalyst.1mg.com to view the full documentation.

package/babel.config.json

@@ -0,0 +1,24 @@
+{
+    "presets": [
+        [
+            "@babel/preset-env",
+            {
+                "targets": {
+                    "node": "current"
+                }
+            }
+        ],
+        "@babel/preset-react"
+    ],
+    "plugins": [
+        "@babel/plugin-proposal-object-rest-spread",
+        "transform-class-properties",
+        "@loadable/babel-plugin"
+    ],
+    "env": {
+        "test": {
+            "presets": ["@babel/preset-react"]
+        }
+    },
+    "ignore": ["__TEST__"]
+}

package/bin/catalyst.js

@@ -0,0 +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);
+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.'
+      );
+    }
+    process.exit(1);
+  }
+  process.exit(result.status);
+} else {
+  console.log('Unknown script "' + script + '".');
+  console.log('Perhaps you need to update framework?');
+}

package/caching.js

@@ -0,0 +1,16 @@
+"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/checkVersion.js

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

package/config/config.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  "S3_BUCKET": "stagassets.1mg.com",
+  "S3_FOLDER": "pwa-app",
+  "CDN_ASSET_PATH": "https://stagstatic.1mg.com",
+  "APPLICATION_PORT": "3005",
+  "APPLICATION_BASE_URL": "http://localhost:3005",
+  "SERVER_PATH": "http://localhost:3005",
+  "OUTPUT_PATH": "build",
+  "PUBLIC_OUTPUT_PATH": "build/public",
+  "PUBLIC_ASSET_PATH": "http://localhost:3006/assets/",
+  "LOCAL_ASSET_PATH": "/assets/",
+  "EXTERNAL_BASE_URL": "http://localhost:3005",
+  "DEV_SERVER_PORT": 3006,
+  "DEV_SERVER_HOSTNAME": "localhost",
+  "DEV_SERVER_HOST_URL": "http://localhost:3006",
+  "ENV_NAME": "local",
+  "BUILD_ENV": ""
+};

package/config.json

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

package/index.js

@@ -0,0 +1,16 @@
+"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/index.js

@@ -0,0 +1,96 @@
+"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 => {
+      console.log(pc.red(pc.bold("ERROR: " + JSON.stringify(msg))));
+      errorLogger.error(msg);
+    },
+    info: msg => {
+      console.log(pc.green(pc.bold("INFO: " + JSON.stringify(msg))));
+      infoLogger.info(msg);
+    }
+  };
+  if (enableDebugLogs && JSON.parse(enableDebugLogs)) {
+    Logger.debug = msg => {
+      console.log(pc.yellow(pc.bold("DEBUG: " + JSON.stringify(msg))));
+      debugLogger.debug(msg);
+    };
+  }
+  if (global) global.logger = Logger;
+  return Logger;
+};
+module.exports = {
+  configureLogger
+};

package/package.json

@@ -0,0 +1,87 @@
+{
+   "name": "catalyst-core",
+   "version": "0.0.1-beta.2",
+   "main": "index.js",
+   "description": "1mg framework around react",
+   "bin": {
+      "catalyst": "./bin/catalyst.js"
+   },
+   "scripts": {
+      "prepare": "babel src --out-dir . ",
+      "start": "npx babel-node -r ./scripts/loadScriptsBeforeServerStarts.js ./webpack/development.client.babel & npx babel-node -r ./scripts/loadScriptsBeforeServerStarts.js ./server/mainIndex.js --watch-path=${npm_config_src_path}/server --watch-path=${npm_config_src_path}/src --ignore=' '",
+      "build": "rm -rf ${npm_config_src_path}/build & node ./scripts/loadScriptsBeforeServerStarts.js & APPLICATION=${npm_config_app_name} NODE_ENV=production  webpack --config ./webpack/production.client.babel.js --progress && APPLICATION=${npm_config_app_name} NODE_ENV=production SSR=true webpack --config ./webpack/production.ssr.babel.js --progress && APPLICATION=${npm_config_app_name} NODE_ENV=production npx babel ./server --out-dir ${npm_config_src_path}/build --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 ",
+      "serve": "APPLICATION=${npm_config_app_name} NODE_ENV=production node -r ./scripts/loadScriptsBeforeServerStarts.js ${npm_config_src_path}/build/mainIndex.js"
+   },
+   "author": "",
+   "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-alpha.13",
+      "acorn-loose": "^8.4.0",
+      "app-root-path": "^3.1.0",
+      "aws-sdk": "^2.1490.0",
+      "axios": "^0.19.2",
+      "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",
+      "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",
+      "dotenv-webpack": "^8.0.1",
+      "esm-module-alias": "^2.0.3",
+      "express": "^4.18.2",
+      "express-static-gzip": "^2.1.7",
+      "file-loader": "^6.2.0",
+      "helmet": "^7.0.0",
+      "html-loader": "^4.2.0",
+      "img-loader": "^4.0.0",
+      "isomorphic-dompurify": "^1.13.0",
+      "lodash.template": "^4.5.0",
+      "mini-css-extract-plugin": "^2.7.6",
+      "module-alias": "^2.2.3",
+      "node-dev": "^7.4.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",
+      "redux-logger": "^3.0.6",
+      "redux-thunk": "^2.4.2",
+      "sass": "^1.69.5",
+      "sass-loader": "^13.3.2",
+      "sass-resources-loader": "^2.2.5",
+      "ua-parser-js": "^1.0.37",
+      "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.1",
+      "webpack-merge": "^5.9.0",
+      "webpack-node-externals": "^3.0.0",
+      "winston": "^3.11.0",
+      "winston-daily-rotate-file": "^5.0.0"
+   }
+}