catalyst-core-internal 0.0.1-beta.9 → 0.0.1

package/README.md

@@ -1,146 +1,43 @@
-# Catalyst
-
-Frontend framework with server rendering support for web applications.
+<div align="center">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://onemg.gumlet.io/staging/7ee66dfb-b5fb-4fbe-8dea-789685e45f7a.svg">
+ <img alt="Catalyst logo" src="https://onemg.gumlet.io/staging/2fdb0975-8f51-4fd1-bd7d-6375d793f581.svg" height="128">
+ </picture>
+</div>
 
 ## Table of Contents
 
 -   Overview
 -   Installation
--   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.
+Catalyst offers a comprehensive suite of features designed for modern web development. It includes isomorphic rendering for optimal performance, an extendable server with full-stack capabilities, and configurable state management. The framework employs smart prefetching of data and chunks, allows easy configuration of global styles and layouts, and provides SEO optimization at both global and page levels.
+
+This version adds support for Universal app for both Android and iOS. Please checkout [Universal App Documentaion](https://catalyst.1mg.com/public_docs/content/Universal%20App/RunUniversalApp)
 
 ## Installation
 
 **System Requirements**
 
 -   Node version 20.4.0 or later
--   macOS and Linux are supported
+-   Compatible with **macOS** and **Linux**
 
 **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
+```bash
 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.
-
-```js
-cd project-name && npm run start
-```
-
--   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.
-
-**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.
+You will see some prompts to configure your application.
 
-```js
-const [data, error, isFetched] = useCurrentRouteData()
+```bash
+cd <name-of-your-project> && npm run start
 ```
 
-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
-```
+The development server will start at `http://localhost:3005`
 
 ## Documentation
 

package/babel.config.js

@@ -0,0 +1,32 @@
+module.exports = (api) => {
+    api.cache(true)
+
+    return {
+        presets: [
+            [
+                "@babel/preset-typescript",
+                {
+                    isTSX: true,
+                    allExtensions: true,
+                },
+            ],
+            [
+                "@babel/preset-env",
+                {
+                    targets: {
+                        node: "current",
+                    },
+                },
+            ],
+            ["@babel/preset-react", { runtime: "automatic" }],
+        ],
+        compact: true,
+        plugins: ["@loadable/babel-plugin"],
+        env: {
+            test: {
+                presets: ["@babel/preset-react"],
+            },
+        },
+        ignore: ["__TEST__"],
+    }
+}

package/bin/catalyst.js

@@ -5,27 +5,110 @@ process.on("unhandledRejection", (err) => {
 })
 const { spawnSync } = require("node:child_process")
 const args = process.argv.slice(2)
-const scriptIndex = args.findIndex(
-    (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)) {
+
+// Array of valid commands
+const validCommands = [
+    "build",
+    "start",
+    "serve",
+    "devBuild",
+    "devServe",
+    "buildApp",
+    "buildApp:ios",
+    "buildApp:android",
+    "setupEmulator",
+    "setupEmulator:ios",
+    "setupEmulator:android",
+]
+
+// Map of platform-specific commands to their script paths
+const platformScripts = {
+    "setupEmulator:ios": "../dist/native/setupEmulatorIos.js",
+    "setupEmulator:android": "../dist/native/androidSetup.js",
+    "buildApp:ios": "../dist/native/buildAppIos.js",
+    "buildApp:android": "../dist/native/buildAppAndroid.js",
+}
+
+// Helper to check if arg is a platform command
+const isPlatformCommand = (arg, prefix) => {
+    if (!arg.startsWith(`${prefix}:`)) return false
+    const platform = arg.split(":")[1]
+    return ["ios", "android"].includes(platform) || platform === undefined
+}
+
+// Helper function to run a platform command
+const runPlatformCommand = (baseCommand, platform) => {
+    const command = `${baseCommand}:${platform}`
     const result = spawnSync(
         process.execPath,
-        nodeArgs.concat(require.resolve("../scripts/" + script)).concat(args.slice(scriptIndex + 1)),
+        nodeArgs.concat(require.resolve(platformScripts[command])).concat(args.slice(scriptIndex + 1)),
         { stdio: "inherit" }
     )
+    return result
+}
+
+// Helper function to run commands for all platforms
+const runAllPlatforms = (baseCommand) => {
+    const platforms = ["ios", "android"]
+    for (const platform of platforms) {
+        const result = runPlatformCommand(baseCommand, platform)
+        if (result.status !== 0) {
+            handleProcessResult(result)
+            return
+        }
+    }
+    process.exit(0)
+}
+
+const scriptIndex = args.findIndex(
+    (x) =>
+        x === "build" ||
+        x === "start" ||
+        x === "serve" ||
+        x === "devBuild" ||
+        x === "devServe" ||
+        isPlatformCommand(x, "buildApp") ||
+        isPlatformCommand(x, "setupEmulator")
+)
+const script = scriptIndex === -1 ? args[0] : args[scriptIndex]
+const nodeArgs = scriptIndex > 0 ? args.slice(0, scriptIndex) : []
+
+if (validCommands.includes(script)) {
+    // Handle platform-specific or combined commands
+    if (script === "buildApp" || script === "setupEmulator") {
+        // Run for all platforms if no specific platform is specified
+        runAllPlatforms(script)
+    } else if (script in platformScripts) {
+        // Run for specific platform
+        const result = spawnSync(
+            process.execPath,
+            nodeArgs.concat(require.resolve(platformScripts[script])).concat(args.slice(scriptIndex + 1)),
+            { stdio: "inherit" }
+        )
+        handleProcessResult(result)
+    } else {
+        // Original commands
+        const result = spawnSync(
+            process.execPath,
+            nodeArgs.concat(require.resolve("../dist/scripts/" + script)).concat(args.slice(scriptIndex + 1)),
+            { stdio: "inherit" }
+        )
+        handleProcessResult(result)
+    }
+} else {
+    console.log('Unknown script "' + script + '".')
+}
+
+// Helper function to handle process results
+function handleProcessResult(result) {
     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 " +
@@ -35,7 +118,4 @@ if (["build", "start", "serve", "devBuild", "devServe"].includes(script)) {
         process.exit(1)
     }
     process.exit(result.status)
-} else {
-  /* eslint-disable no-console */
-  console.log('Unknown script "' + script + '".');
 }

package/changelog.md

@@ -0,0 +1,129 @@
+# Changelog
+
+## [0.0.3-canary.20] - 2025-12-12
+
+-   Patch: Allow localhost traffic to be served from http
+
+## [0.0.3-canary.19] - 2025-12-09
+
+-   Offline fallback support: packages `public/offline.html` into Android/iOS bundles and shows it automatically when connectivity drops (with retry handling)
+-   Notification refactor: streamlined config toggle for local vs push, centralized permission/asset handling, and simpler routing into the web app
+-   Access control: combined access control config for ios
+
+## [0.0.3-canary.18] - 2025-11-19
+
+-   Configuration Files
+-   Android Native WebView - MainActivity.kt
+-   Android Native WebView - CustomWebview.kt
+
+## [0.0.3-canary.17] - 2025-11-19
+
+-   ✨ Added complete notification system (local & push)
+-   🔔 New useNotification() React hook
+-   📱 Firebase Cloud Messaging conditional build support
+-   🤖 Android notification handling in MainActivity
+-   🔧 5 new notification commands + 5 callbacks in NativeBridge
+-   📦 Auto-processing of notification icons & sounds
+-   ⚙️ Conditional dependencies based on notification config
+-   🧹 Updated .gitignore & .npmignore
+-   📋 Enhanced build process with automatic permission injection
+-   🔗 Deep link integration with notifications
+
+## [0.0.3-canary.16] - 2025-11-19
+
+-   FeaturesGallery Support for File Picker: Enhanced file picker to open native gallery for selecting images and videos
+-   HTTPS Framework Server: Enabled HTTPS support for the framework server with self-signed SSL certificate
+-   MIME Type Handling: Fixed and improved MIME type detection and handling in the file picker
+
+## [0.0.3-canary.15] - 2025-11-19
+
+-   Adding Android release support and appInfo key
+
+## [0.0.3-canary.14] - 2025-09-29
+
+-   Android custom splashscreen
+
+## [0.0.3-canary.13] - 2025-09-28
+
+-   Multi file support in useFilePicker hook
+-   Android multiple app icon support
+-   Android whitelisting toggle support
+
+## [0.0.3-canary.12] - 2025-09-26
+
+-   Universal App Context: Added comprehensive context support for building universal mobile applications
+-   OpenTelemetry SDK Integration: Built-in support for observability and performance monitoring with Otel SDK
+
+## [0.0.3-canary.11] - 2025-09-26
+
+-   Build organization: Store APKs and iOS builds organized by generation date and time for better tracking and management
+-   Enhanced Android native support: Add support for native keyboard and webview resizing in Android
+-   Device info API web support: Web support in device info API
+
+## [0.0.3-canary.10] - 2025-09-11
+
+-   **Sentry import bug fix**
+-   **Open telemetry SDK**
+
+## [0.0.3-canary.9] - 2025-09-11
+
+-   **App name configuration**
+-   **Device Info API**
+-   **Access control configuration**
+
+## [0.0.3-canary.8] - 2025-01-06
+
+-   **App icon configuration**
+-   **Splash screen integration**
+-   **Url Whitelisting**
+
+## [0.0.3-canary.7] - 2025-01-06
+
+### 🚀 Features
+
+-   **Native API Integration**: Enhanced native module integration for better performance
+-   **Automated IP Resolution**: Intelligent network detection eliminates manual IP configuration
+-   **Universal Build System**: Streamlined one-command builds for both Android and iOS platforms
+-   **Enhanced CLI Interface**: Improved command-line tools for better developer experience
+
+### 🐛 Bug Fixes
+
+-   Fixed IP address detection issues on development environments
+-   Resolved build configuration conflicts between platforms
+-   Improved error handling and recovery mechanisms
+
+### 🔧 Improvements
+
+-   **Performance**: Optimized native module loading and execution
+-   **Developer Experience**: Enhanced CLI with better error messages and debugging info
+-   **Configuration**: Dynamic config updates without requiring restarts
+-   **Build Process**: Faster and more reliable build pipeline
+
+### 🧪 Testing & Validation
+
+-   ✅ **Android Build**: Verified APK generation, installation, and runtime behavior
+-   ✅ **iOS Build**: Tested build process and device compatibility
+-   ✅ **IP Detection**: Validated automatic network resolution across platforms
+-   ✅ **Native Modules**: Confirmed API integration and performance benchmarks
+-   ✅ **CLI Operations**: Tested enhanced command-line workflows and error handling
+
+### 🔄 Breaking Changes
+
+**None** - All changes maintain backward compatibility while enhancing existing functionality
+
+### 📝 Technical Details
+
+-   Improved native API bridge for better cross-platform communication
+-   Enhanced error reporting with detailed stack traces and suggestions
+-   Optimized build configuration for faster development cycles
+-   Added comprehensive logging for debugging and monitoring
+
+### 🔗 Migration Notes
+
+-   No migration steps required
+-   Existing projects will automatically benefit from improvements
+-   Optional: Update CLI usage to leverage new enhanced features
+
+## Version
+
+-   Target version: 0.0.3-canary.7

package/dist/caching.js

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

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

@@ -0,0 +1,10 @@
+"use strict";const pc=require("picocolors");const winston=require("winston");const DailyRotateFile=require("winston-daily-rotate-file");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:`${process.env.src_path}/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};