create-catalyst-app 0.0.1-beta.2 → 0.0.1-beta.20

package/templates/redux-ts/src/js/routes/utils.js

@@ -0,0 +1,42 @@
+import React from "react"
+import { RouterDataProvider, MetaTag } from "@tata1mg/router"
+import App from "@containers/App"
+import routes from "./index.js"
+
+/**
+ * Making the routes array compatible with the format accepted by createBrowserRouter
+ * API on the client side
+ * https://reactrouter.com/en/main/routers/create-browser-router
+ */
+
+export const preparedRoutes = ({ store, routerInitialState }) => {
+    const getPreparedRoutes = (routes) => {
+        return routes.map((route, index) => {
+            const Component = route.component
+            const routeToRender = {
+                ...route,
+                element: <Component key={index} />,
+            }
+            if (route.children) {
+                routeToRender.children = getPreparedRoutes(route.children)
+            }
+            return routeToRender
+        })
+    }
+
+    return [
+        {
+            element: (
+                <RouterDataProvider config={{}} initialState={routerInitialState} fetcherArgs={{ store }}>
+                    <MetaTag />
+                    <App />
+                </RouterDataProvider>
+            ),
+            children: getPreparedRoutes(routes),
+        },
+    ]
+}
+
+export const getRoutes = () => {
+    return routes
+}

package/templates/redux-ts/src/js/store/index.js

@@ -0,0 +1,28 @@
+import { configureStore as createStore } from "@reduxjs/toolkit"
+import { combineReducers } from "redux"
+import { shellReducer } from "@containers/App/reducer.js"
+import fetchInstance from "@api"
+
+/**
+ * Function that initializes the store with the initialstate and adds middlewares that can be used during action dispatch
+ * @param    {object} initialState    Default state
+ * @param    {object} request   Request object that we recieve on server, this is only recieved when store is initialized on the server.
+ * @return   {object} The store itself
+ */
+
+const configureStore = (initialState) => {
+    const api = fetchInstance
+    const store = createStore({
+        reducer: combineReducers({ shellReducer }),
+        middleware: (getDefaultMiddleware) =>
+            getDefaultMiddleware({
+                thunk: {
+                    extraArgument: { api },
+                },
+            }),
+        preloadedState: initialState,
+    })
+    return store
+}
+
+export default configureStore

package/templates/redux-ts/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+        "target": "ES2016",
+        "module": "CommonJS",
+        "esModuleInterop": true,
+        "strict": true,
+        "skipLibCheck": true,
+        "jsx": "react",
+        "noEmit": true
+    },
+    "include": ["src", "types.d.ts"],
+    "exclude": ["node_modules"]
+}

package/templates/redux-ts/types.d.ts

@@ -0,0 +1,4 @@
+declare module "*.scss" {
+    const classes: { [key: string]: string }
+    export default classes
+}

package/templates/rtk-js/client/index.js

@@ -1,17 +1,18 @@
 import React from "react"
+import "./styles"
 import { hydrateRoot } from "react-dom/client"
 import { loadableReady } from "@loadable/component"
 import { Provider } from "react-redux"
-import { createBrowserRouter, RouterProvider } from "@tata1mg/router"
-import { preparedRoutes } from "../src/js/routes/index.js"
-import configureStore from "../src/js/store/index.js"
-import "./styles"
+import { RouterProvider } from "@tata1mg/router"
+import clientRouter from "catalyst-core/router/ClientRouter"
+import configureStore from "@store"
 
 window.addEventListener("load", () => {
     loadableReady(() => {
         const { __ROUTER_INITIAL_DATA__: routerInitialData, __INITIAL_STATE__ } = window
         const store = configureStore(__INITIAL_STATE__ || {})
-        const router = createBrowserRouter(preparedRoutes({ store, routerInitialState: routerInitialData }))
+
+        const router = clientRouter({ store, routerInitialState: routerInitialData })
 
         const Application = (
             <Provider store={store} serverState={__INITIAL_STATE__}>

package/templates/rtk-js/package.json

@@ -1,52 +1,33 @@
 {
     "name": "create-catalyst-app-starter",
     "version": "1.0.0",
-    "description": "This README would normally document whatever steps are necessary to get your application up and running.",
-    "main": "index.js",
-    "bin": "scripts/cli.mjs",
     "scripts": {
         "start": "catalyst start",
         "build": "catalyst build",
-        "serve": "catalyst serve"
+        "serve": "catalyst serve",
+        "lint": "eslint .",
+        "devBuild": "catalyst devBuild",
+        "devServe": "catalyst devServe"
     },
     "_moduleAliases": {
+        "@api": "api.js",
         "@containers": "src/js/containers",
-        "@lib": "src/js/lib",
-        "$server": "server",
-        "@constants": "src/js/constants",
+        "@server": "server",
         "@config": "config",
-        "@components": "src/js/components",
-        "@css": "src/static/css"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/tata1mg/catalyst"
+        "@css": "src/static/css",
+        "@routes": "src/js/routes/",
+        "@store": "src/js/store/index.js"
     },
     "dependencies": {
         "@loadable/component": "^5.16.3",
-        "@tata1mg/router": "^0.0.1-alpha.13",
-        "catalyst-core":"0.0.1-beta.1",
-        "event-source-polyfill": "^1.0.31",
-        "express-static-gzip": "^2.1.7",
-        "framer-motion": "^10.18.0",
-        "isomorphic-dompurify": "^2.2.0",
-        "normalize.css": "^8.0.1",
-        "prop-types": "^15.8.1",
-            "react-dfp": "^0.21.0",
-        "react-helmet-async":"^1.3.0",
-        "react-intersection-observer": "^9.5.3",
-        "react-loadable-visibility": "^3.0.2",
-        "react-redux": "^8.1.3",
-        "@reduxjs/toolkit": "1.9.3"
-    },
-    "author": "",
-    "license": "ISC",
-    "bugs": {
-        "url": "https://github.com/tata1mg/catalyst/issues"
+        "@tata1mg/router": "^0.0.1-beta.7",
+        "catalyst-core": "0.0.1-beta.14",
+        "@reduxjs/toolkit": "1.9.3",
+        "react-redux": "^8.1.3"
     },
-    "homepage": "https://github.com/tata1mg/catalyst#readme",
     "devDependencies": {
-        "@babel/core": "^7.23.7",
-        "@babel/node": "^7.22.19"
+        "eslint": "^8.26.0",
+        "eslint-plugin-react": "^7.34.1",
+        "eslint-plugin-react-hooks": "^4.6.0"
     }
 }

package/templates/rtk-js/src/js/containers/App/index.js

@@ -1,42 +1,16 @@
-import React, { useState } from "react";
-import {
-  useLocation,
-  useOutlet,
-  UNSAFE_LocationContext,
-} from "react-router-dom";
-import {reduxTest} from "./reducer.js"
-import "@css/base/index.scss";
+import React from "react"
+import { Outlet } from "@tata1mg/router"
 
-
-export const BaseOutlet = () => {
-  const o = useOutlet();
-  const [outlet] = useState(o);
-
-  return <>{outlet}</>;
-};
 const App = () => {
-  
-  const location = useLocation();
-  const page = (
-    <div key={location.pathname.includes("/auth") ? "" : location.pathname}>
-      <UNSAFE_LocationContext.Provider value={{ location }}>
-        <BaseOutlet />
-      </UNSAFE_LocationContext.Provider>
-    </div>
-  );
-  return (
-        <div className={"flexColumn"}>
-          <>
-              {/* <ShellLocusHeader /> */}
-          </>
-          <div>{page}</div>
-        </div>
-  );
-};
+    return (
+        <>
+            <Outlet />
+        </>
+    )
+}
 
-App.serverSideFunction = ({store}) => {
-  store.dispatch(reduxTest())
-  return new Promise((resolve) => resolve());
-};
+App.serverSideFunction = () => {
+    return new Promise((resolve) => resolve())
+}
 
-export default App;
+export default App

package/templates/rtk-js/src/js/containers/App/reducer.js

@@ -8,7 +8,7 @@ export const appSlice = createSlice({
     name: "shellReducer",
     initialState: initialState,
     reducers: {
-        reduxTest: (state, action) => {
+        reduxTest: (state) => {
             state.testActionDispatched = true
         },
     },
@@ -16,11 +16,3 @@ export const appSlice = createSlice({
 
 export const { reduxTest } = appSlice.actions
 export const shellReducer = appSlice.reducer
-
-
-
-
-
-
-
-

package/templates/rtk-js/src/js/routes/utils.js

@@ -0,0 +1,42 @@
+import React from "react"
+import { RouterDataProvider, MetaTag } from "@tata1mg/router"
+import App from "@containers/App"
+import routes from "./index.js"
+
+/**
+ * Making the routes array compatible with the format accepted by createBrowserRouter
+ * API on the client side
+ * https://reactrouter.com/en/main/routers/create-browser-router
+ */
+
+export const preparedRoutes = ({ store, routerInitialState }) => {
+    const getPreparedRoutes = (routes) => {
+        return routes.map((route, index) => {
+            const Component = route.component
+            const routeToRender = {
+                ...route,
+                element: <Component key={index} />,
+            }
+            if (route.children) {
+                routeToRender.children = getPreparedRoutes(route.children)
+            }
+            return routeToRender
+        })
+    }
+
+    return [
+        {
+            element: (
+                <RouterDataProvider config={{}} initialState={routerInitialState} fetcherArgs={{ store }}>
+                    <MetaTag />
+                    <App />
+                </RouterDataProvider>
+            ),
+            children: getPreparedRoutes(routes),
+        },
+    ]
+}
+
+export const getRoutes = () => {
+    return routes
+}

package/templates/rtk-js/src/js/store/index.js

@@ -1,12 +1,19 @@
 import { configureStore as createStore } from "@reduxjs/toolkit"
-import {combineReducers} from "redux"
-import {shellReducer} from "@containers/App/reducer.js"
-import fetchInstance from "../../../api"
+import { combineReducers } from "redux"
+import { shellReducer } from "@containers/App/reducer.js"
+import fetchInstance from "@api"
 
-const configureStore = (initialState,request) => {
+/**
+ * Function that initializes the store with the initialstate and adds middlewares that can be used during action dispatch
+ * @param    {object} initialState    Default state
+ * @param    {object} request   Request object that we recieve on server, this is only recieved when store is initialized on the server.
+ * @return   {object} The store itself
+ */
+
+const configureStore = (initialState) => {
     const api = fetchInstance
     const store = createStore({
-        reducer: combineReducers({shellReducer}),
+        reducer: combineReducers({ shellReducer }),
         middleware: (getDefaultMiddleware) =>
             getDefaultMiddleware({
                 thunk: {
@@ -18,5 +25,4 @@ const configureStore = (initialState,request) => {
     return store
 }
 
-
 export default configureStore

package/templates/rtk-ts/client/index.js

@@ -0,0 +1,28 @@
+import React from "react"
+import "./styles"
+import { hydrateRoot } from "react-dom/client"
+import { loadableReady } from "@loadable/component"
+import { Provider } from "react-redux"
+import { RouterProvider } from "@tata1mg/router"
+import clientRouter from "catalyst-core/router/ClientRouter"
+import configureStore from "@store"
+
+window.addEventListener("load", () => {
+    loadableReady(() => {
+        const { __ROUTER_INITIAL_DATA__: routerInitialData, __INITIAL_STATE__ } = window
+        const store = configureStore(__INITIAL_STATE__ || {})
+
+        const router = clientRouter({ store, routerInitialState: routerInitialData })
+
+        const Application = (
+            <Provider store={store} serverState={__INITIAL_STATE__}>
+                <React.StrictMode>
+                    <RouterProvider router={router} />
+                </React.StrictMode>
+            </Provider>
+        )
+
+        const container = document.getElementById("app")
+        hydrateRoot(container, Application)
+    })
+})

package/templates/rtk-ts/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "create-catalyst-app-starter",
+    "version": "1.0.0",
+    "scripts": {
+        "start": "catalyst start",
+        "build": "npm run typecheck && catalyst build",
+        "serve": "catalyst serve",
+        "lint": "eslint .",
+        "devBuild": "catalyst devBuild",
+        "devServe": "catalyst devServe",
+        "typecheck": "tsc --noEmit"
+    },
+    "_moduleAliases": {
+        "@api": "api.js",
+        "@containers": "src/js/containers",
+        "@server": "server",
+        "@config": "config",
+        "@css": "src/static/css",
+        "@routes": "src/js/routes/",
+        "@store": "src/js/store/index.js"
+    },
+    "dependencies": {
+        "@loadable/component": "^5.16.3",
+        "@tata1mg/router": "^0.0.1-beta.7",
+        "catalyst-core": "0.0.1-beta.14",
+        "@reduxjs/toolkit": "1.9.3",
+        "react-redux": "^8.1.3"
+    },
+    "devDependencies": {
+        "eslint": "^8.26.0",
+        "typescript": "^5.8.3",
+        "@types/react": "^18.2.0",
+        "@types/react-dom": "^18.2.0",
+        "eslint-plugin-react": "^7.34.1",
+        "eslint-plugin-react-hooks": "^4.6.0"
+    }
+}

package/templates/rtk-ts/src/js/containers/App/index.js

@@ -0,0 +1,16 @@
+import React from "react"
+import { Outlet } from "@tata1mg/router"
+
+const App = () => {
+    return (
+        <>
+            <Outlet />
+        </>
+    )
+}
+
+App.serverSideFunction = () => {
+    return new Promise((resolve) => resolve())
+}
+
+export default App

package/{my-app → templates/rtk-ts}/src/js/containers/App/reducer.js

@@ -8,7 +8,7 @@ export const appSlice = createSlice({
     name: "shellReducer",
     initialState: initialState,
     reducers: {
-        reduxTest: (state, action) => {
+        reduxTest: (state) => {
             state.testActionDispatched = true
         },
     },
@@ -16,11 +16,3 @@ export const appSlice = createSlice({
 
 export const { reduxTest } = appSlice.actions
 export const shellReducer = appSlice.reducer
-
-
-
-
-
-
-
-

package/templates/rtk-ts/src/js/routes/utils.js

@@ -0,0 +1,42 @@
+import React from "react"
+import { RouterDataProvider, MetaTag } from "@tata1mg/router"
+import App from "@containers/App"
+import routes from "./index.js"
+
+/**
+ * Making the routes array compatible with the format accepted by createBrowserRouter
+ * API on the client side
+ * https://reactrouter.com/en/main/routers/create-browser-router
+ */
+
+export const preparedRoutes = ({ store, routerInitialState }) => {
+    const getPreparedRoutes = (routes) => {
+        return routes.map((route, index) => {
+            const Component = route.component
+            const routeToRender = {
+                ...route,
+                element: <Component key={index} />,
+            }
+            if (route.children) {
+                routeToRender.children = getPreparedRoutes(route.children)
+            }
+            return routeToRender
+        })
+    }
+
+    return [
+        {
+            element: (
+                <RouterDataProvider config={{}} initialState={routerInitialState} fetcherArgs={{ store }}>
+                    <MetaTag />
+                    <App />
+                </RouterDataProvider>
+            ),
+            children: getPreparedRoutes(routes),
+        },
+    ]
+}
+
+export const getRoutes = () => {
+    return routes
+}

package/templates/rtk-ts/src/js/store/index.js

@@ -0,0 +1,28 @@
+import { configureStore as createStore } from "@reduxjs/toolkit"
+import { combineReducers } from "redux"
+import { shellReducer } from "@containers/App/reducer.js"
+import fetchInstance from "@api"
+
+/**
+ * Function that initializes the store with the initialstate and adds middlewares that can be used during action dispatch
+ * @param    {object} initialState    Default state
+ * @param    {object} request   Request object that we recieve on server, this is only recieved when store is initialized on the server.
+ * @return   {object} The store itself
+ */
+
+const configureStore = (initialState) => {
+    const api = fetchInstance
+    const store = createStore({
+        reducer: combineReducers({ shellReducer }),
+        middleware: (getDefaultMiddleware) =>
+            getDefaultMiddleware({
+                thunk: {
+                    extraArgument: { api },
+                },
+            }),
+        preloadedState: initialState,
+    })
+    return store
+}
+
+export default configureStore

package/templates/rtk-ts/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+        "target": "ES2016",
+        "module": "CommonJS",
+        "esModuleInterop": true,
+        "strict": true,
+        "skipLibCheck": true,
+        "jsx": "react",
+        "noEmit": true
+    },
+    "include": ["src", "types.d.ts"],
+    "exclude": ["node_modules"]
+}

package/templates/rtk-ts/types.d.ts

@@ -0,0 +1,4 @@
+declare module "*.scss" {
+    const classes: { [key: string]: string }
+    export default classes
+}

package/templates/tailwind/postcss.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+    plugins: {
+        "@tailwindcss/postcss": {},
+    },
+}

package/templates/tailwind/src/static/css/base/index.scss

@@ -0,0 +1,2 @@
+@import "styles";
+@import "tailwindcss";

package/my-app/.babelrc

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

package/my-app/.eslintignore

@@ -1,6 +0,0 @@
-**/node_modules/*
-**/dist/*
-**/build/*
-**/coverage/*
-**/eventScripts/*
-**/docs/*

package/my-app/.eslintrc

@@ -1,53 +0,0 @@
-{
-    "parser": "@babel/eslint-parser",
-    "rules": {
-        "prettier/prettier": "error",
-        "no-console": "warn",
-        "react/prop-types": 1,
-        "react/display-name": [0, { "ignoreTranspilerName": true }],
-        "react-hooks/exhaustive-deps": "warn", // Checks effect dependencies
-        "no-prototype-builtins": "off",
-        "jam3/no-sanitizer-with-danger": 2,
-        "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.js"
-        },
-        "ecmaVersion": 6
-    },
-    "plugins": ["babel", "react", "react-hooks", "prettier", "jam3"],
-    "settings": {
-        "react": {
-            "createClass": "createReactClass",
-            "pragma": "React",
-            "version": "detect"
-        },
-        "propWrapperFunctions": [
-            "forbidExtraProps",
-            { "property": "freeze", "object": "Object" },
-            { "property": "myFavoriteWrapper" }
-        ],
-        "linkComponents": ["Hyperlink", { "name": "Link", "linkAttribute": "to" }]
-    }
-}