catalyst-core 0.3.0-beta.5 → 0.3.0-canary.2

package/dist/scripts/validator.js

@@ -1,149 +0,0 @@
-import pc from "picocolors"
-
-const handleError = (e) => {
-    console.log(pc.red("Failed to start server: "), e)
-}
-
-const validatePreInitServer = (fn) => {
-    try {
-        if (!fn) throw new Error("preServerInit named function should be defined in server/index.js")
-        if (typeof fn !== "function")
-            throw new Error("preServerInit should be function present in server/index.js")
-        return true
-    } catch (e) {
-        handleError(e)
-    }
-}
-
-const validateMiddleware = (fn) => {
-    try {
-        if (!fn) throw new Error("addMiddlewares named function not found in server/server.js")
-        if (typeof fn !== "function")
-            throw new Error("addMiddlewares should be function present in server/server.js")
-        return true
-    } catch (e) {
-        handleError(e)
-    }
-}
-
-const validateReducerFunction = (fn) => {
-    try {
-        if (!fn) throw new Error("reducer not found in src/js/containers/App/reducer")
-        if (typeof fn !== "function")
-            throw new Error("reducer should present in src/js/containers/App/reducer")
-        return true
-    } catch (e) {
-        handleError(e)
-    }
-}
-
-const validateConfigFile = (obj) => {
-    try {
-        if (!obj) throw new Error("config not found in config folder")
-        if (typeof obj !== "object")
-            throw new Error(
-                "config object should be exported from config folder inside your project root directory"
-            )
-        if (typeof obj === "object") {
-            const requiredConfigKeys = {
-                NODE_SERVER_HOSTNAME: "",
-                NODE_SERVER_PORT: "",
-                WEBPACK_DEV_SERVER_HOSTNAME: "",
-                WEBPACK_DEV_SERVER_PORT: "",
-                BUILD_OUTPUT_PATH: "",
-                PUBLIC_STATIC_ASSET_PATH: "",
-                PUBLIC_STATIC_ASSET_URL: "",
-                CLIENT_ENV_VARIABLES: [],
-                ANALYZE_BUNDLE: "",
-            }
-            for (let key in requiredConfigKeys) {
-                if (!(key in obj)) throw new Error(`${key} key not found inside config.json`)
-            }
-        }
-        return true
-    } catch (e) {
-        handleError(e)
-    }
-}
-
-const validatePackageJson = (obj) => {
-    try {
-        if (!obj) throw new Error("package.json not found in the project")
-        if (typeof obj !== "object")
-            throw new Error("package.json should be defined in project root directory")
-        return true
-    } catch (e) {
-        handleError(e)
-    }
-}
-
-const validateModuleAlias = (obj) => {
-    try {
-        if (!obj) throw new Error("moduleAliases not found in package.json file present in root directory.")
-        if (typeof obj !== "object")
-            throw new Error("moduleAliases named object should be exported from package.json")
-        if (typeof obj === "object") {
-            const requiredModuleAliases = {
-                "@api": "api.js",
-                "@containers": "src/js/containers",
-                "@server": "server",
-                "@config": "config",
-                "@css": "src/static/css",
-                "@routes": "src/js/routes/",
-            }
-            for (let key in requiredModuleAliases) {
-                if (key.includes("catalyst"))
-                    throw new Error(`Catalyst keyword is restricted for defining aliases`)
-                if (!(key in obj)) throw new Error(`${key} module alias not defined inside package.json`)
-            }
-        }
-        return true
-    } catch (e) {
-        handleError(e)
-    }
-}
-
-const validateConfigureStore = (fn) => {
-    try {
-        if (!fn) throw new Error("configureStore not found in file src/js/store/index.js")
-        if (typeof fn !== "function")
-            throw new Error("configureStore should be function exported from src/js/store/index.js")
-        return true
-    } catch (e) {
-        handleError(e)
-    }
-}
-
-const validateGetRoutes = (fn) => {
-    try {
-        if (!fn) throw new Error("getRoutes not found in file src/js/routes/utils.js")
-        if (typeof fn !== "function")
-            throw new Error("getRoutes should be function exported from src/js/routers/index.js")
-        return true
-    } catch (e) {
-        handleError(e)
-    }
-}
-
-const validateCustomDocument = (fn) => {
-    try {
-        if (!fn) throw new Error("document not found in file server/document.js")
-        if (typeof fn !== "function")
-            throw new Error("document should be a react component exported from server/document.js")
-        return true
-    } catch (e) {
-        handleError(e)
-    }
-}
-
-export {
-    validateConfigFile,
-    validateConfigureStore,
-    validateCustomDocument,
-    validateGetRoutes,
-    validatePackageJson,
-    validateReducerFunction,
-    validateModuleAlias,
-    validatePreInitServer,
-    validateMiddleware,
-}

package/dist/web-router/hooks.jsx

@@ -1,72 +0,0 @@
-import { useNavigate, useLocation } from "react-router"
-
-/**
- * @param {number} delay
- */
-function wait(delay) {
-    return new Promise((resolve) => {
-        setTimeout(resolve, delay)
-    })
-}
-
-// function navigationDirection(param) {
-//     if (typeof param === "string") {
-//         return "forward-navigation"
-//     } else if (typeof param === "number") {
-//         return param < 0 ? "backward-navigation" : param > 0 ? "forward-navigation" : "Same_page_navigation"
-//     } else {
-//         return "Invalid_param"
-//     }
-// }
-
-// export function useNavigateWithTransition() {
-//     const navigate = useNavigate()
-//     const { setIsExitComplete, updateScrollPosition } = useScrollRestorationContext()
-//     const location = useLocation()
-//     function transition(route, options = {}) {
-//         if (document.startViewTransition && options.skipTransition) {
-//             const directionForNavigation = navigationDirection(route)
-//             //decide whether to use backward transition or forward transition or no transition in case route is 0
-//             if (directionForNavigation === "Same_page_navigation") {
-//                 navigate(route, options)
-//                 return
-//             }
-//             //select the root element and give it the viewTransitionNameb by the directionForNavigation
-//             const rootElementRef = document.querySelector(":root")
-//             rootElementRef.style.viewTransitionName = directionForNavigation
-
-//             const viewTransition = document.startViewTransition(async function updateCallback() {
-//                 // Update scroll position for the current route
-//                 updateScrollPosition(location.key, parseInt(window.scrollY, 10))
-//                 delete options.skipTransition
-//                 navigate(route, options)
-//                 await wait(50)
-//             })
-
-//             // A Promise that fulfills once the pseudo-element tree is created and the transition animation is about to start.
-//             viewTransition.ready.then(() => {
-//                 if (directionForNavigation === "backward-navigation") {
-//                     setIsExitComplete(true)
-//                 } else {
-//                     window.scrollTo({ top: 0, left: 0, behavior: "auto" })
-//                 }
-//             })
-
-//             //A Promise that fulfills once the transition animation is finished, and the new page view is visible and interactive to the user.
-//             viewTransition.finished.finally(() => {
-//                 // Clear the temporary tag
-//                 if (rootElementRef) rootElementRef.style.viewTransitionName = ""
-//             })
-//         } else {
-//             // fallback for old browser
-//             delete options.skipTransition
-//             navigate(route, options)
-//         }
-//     }
-
-//     return transition
-// }
-
-export const useNavigateWithTransition = () => {
-    return useNavigate()
-}

package/dist/web-router/types/components/MetaTag.d.ts

@@ -1,2 +0,0 @@
-export function MetaTag(): React.JSX.Element
-import React from "react"

package/dist/web-router/types/components/RouterDataProvider.d.ts

@@ -1,95 +0,0 @@
-/**
- * @description  Router Data
- * @typedef {{data: any, error: any, isFetching: boolean, isFetched:boolean, refetch?:(args:any)=>Promise<void>}} RouteData
- */
-/**
- * @type {import("react").Context<Object.<string, RouteData>>}
- */
-export const RouterContext: import("react").Context<{
-    [x: string]: RouteData
-}>
-export function serverDataFetcher(
-    serverFetchDataProps: ServerFetchDataProps,
-    fetcherArgs: {
-        [x: string]: any
-    }
-): Promise<{
-    [x: string]: RouteData
-}>
-export function RouterDataProvider({
-    children,
-    initialState,
-    fetcherArgs,
-    config,
-}: RouterDataProviderProps): React.JSX.Element
-export function useCurrentRouteData(): RouteData
-export function useRouterData(): {
-    [x: string]: RouteData
-}
-export type RouteData = {
-    data: any
-    error: any
-    isFetching: boolean
-    isFetched: boolean
-    refetch?: (args: any) => Promise<void>
-}
-export type RouterDataProviderConfig = {
-    /**
-     * disableCaching disable caching of fetched data - default is false
-     */
-    disableCaching?: boolean | undefined
-}
-export type RouterFetcherProps = {
-    /**
-     * route object
-     */
-    route: any
-    /**
-     * the current location object, which represents the current URL in web browsers.
-     */
-    location: import("react-router").Location
-    /**
-     * object of key/value pairs of the dynamic params from the current URL that were matched by the route path.
-     */
-    params: import("react-router").Params
-    /**
-     * search parameters via URLSearchParams interface.
-     */
-    searchParams: URLSearchParams
-    /**
-     * function to navigate to other pages based on response.
-     */
-    navigate: import("react-router").NavigateFunction
-}
-export type ServerFetchDataProps = {
-    /**
-     * routes Array
-     */
-    routes: import("react-router").RouteObject[]
-    /**
-     * current url
-     */
-    url: string
-    /**
-     * Express request object
-     */
-    req: import("express").Request
-}
-export type RouterDataProviderProps = {
-    /**
-     * Initial State of Data Provider - Mostly used to hydrate client with data from server
-     */
-    initialState: any
-    children: any
-    /**
-     * anything passed in fetcherArgs is passed to all the fetcher functions
-     */
-    fetcherArgs: {
-        [x: string]: any
-    }
-    /**
-     * Global router data provider config
-     */
-    config: RouterDataProviderConfig
-}
-import React from "react"

package/dist/web-router/types/context.d.ts

@@ -1,14 +0,0 @@
-/**
- * @typedef oneMgRouterContext
- * @property {import("react-router").RouteMatch<string, import("react-router").RouteObject>[]=} matchedRoutes
- */
-/**
- * @description This is internal context made for sharing data among router components
- * @type {import("react").Context<oneMgRouterContext>}
- */
-export const OneMgRouterContext: import("react").Context<oneMgRouterContext>
-export type oneMgRouterContext = {
-    matchedRoutes?:
-        | import("react-router").RouteMatch<string, import("react-router").RouteObject>[]
-        | undefined
-}

package/dist/web-router/types/hooks.d.ts

@@ -1 +0,0 @@
-export function useNavigateWithTransition(): import("react-router").NavigateFunction

package/dist/web-router/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from "react-router"
-declare const _default: any
-export default _default

package/dist/web-router/types/utils/metaDataUtils.d.ts

@@ -1,40 +0,0 @@
-/**
- * Merges multiple lists of head elements, ensuring that later lists override earlier ones in case of duplicates.
- * Handles all types of head elements, including title, meta, link, etc.
- *
- * @param {...Array<JSX.Element>} lists - Multiple lists of JSX head elements, where the first argument is the parent and the rest are children in order.
- * @returns {Array<JSX.Element>} - The combined list with later lists overriding duplicates from earlier ones.
- */
-export function mergeHeadElements(...lists: Array<JSX.Element>[]): Array<JSX.Element>
-/**
- * Deletes all elements in the head with a specific data attribute.
- *
- * @param {string} attributeName - The name of the data attribute to search for.
- * @param {string} [attributeValue] - The specific value of the data attribute to match (optional).
- */
-export function deleteHeadTagsByDataAttribute(attributeName: string, attributeValue?: string): void
-/**
- * Returns resolved array of meta data elements.
- *
- *
- * @param {Array<Match>} matchedRoutes  - Array of all matches.
- * @param {Object} routeData  - Data returned from Router.
- * @returns {Array<JSX.Element>} - List of all meta tags for the matched location.
- */
-export function getMetaData(matchedRoutes: Array<Match>, routeData: Object): Array<JSX.Element>
-/**
- * Static function defined on a route component that returns metadata elements
- * to be rendered in the document head for that route.
- * Must return an array of JSX elements (e.g. <title>, <meta>), NOT a plain
- * object. Returning an object fails silently: no error is thrown, but the
- * tags will not appear in the rendered <head>.
- *
- * @param {any} fetcherData - Data returned from the route's fetcher (serverFetcher/clientFetcher).
- * @returns {Array<JSX.Element>} - Array of JSX head elements (title, meta, link, etc).
- *
- * @example
- * HomePage.setMetaData = (apiResponse) => [
- *   <title key="title">{apiResponse?.title || "Home"}</title>,
- * ];
- */
-export type SetMetaData = (fetcherData: any) => Array<JSX.Element>