@appigram/react-code-split-ssr 1.3.0 → 1.3.1

package/README.md

@@ -1,114 +1,130 @@
 # React Code Split SSR
+
 React code splitting with server side rendering
 
 ## How it works
 
-- Based on React Router 6
+- React 19
+- Based on React Router 7
 - Server side: Load all components synchronously, then render to string.
 - Client side: Load the initial component before rendering, render the entire screen synchronously, then load the rest of routes asynchronously.
 
 #### Note: This packages is only tested in Meteor projects, but technically it can be used in any Nodejs projects. Here is an [example](https://github.com/lhz516/react-code-split-ssr-example) with Meteor
 
 ## Usage
+
 ```
 $ npm i react-code-split-ssr --save
 ```
+
 Client/server shared:
+
 ```js
-import { Bundle } from 'react-code-split-ssr'
-import React from 'react'
+import { Bundle } from 'react-code-split-ssr';
+import React from 'react';
 
-const Home = () => <Bundle mod={import('/imports/modules/home')} />
-const Posts = () => <Bundle mod={import('/imports/modules/posts')} />
+const Home = () => <Bundle mod={import('/imports/modules/home')} />;
+const Posts = () => <Bundle mod={import('/imports/modules/posts')} />;
 
 export const routes = [
-  { exact: true, path: '/', component: Home },
-  { exact: true, path: '/posts', component: Posts },
-]
-
+	{ exact: true, path: '/', component: Home },
+	{ exact: true, path: '/posts', component: Posts },
+];
 ```
+
 Client:
+
 ```js
-import  React from 'react'
-import { render } from 'react-dom'
-import { matchPath } from 'react-router'
-import { BrowserRouter, Route, Switch } from 'react-router-dom'
-import { generateRoutes } from 'react-code-split-ssr'
-import { routes, redirects } from '/imports/routes'
+import React from 'react';
+import { render } from 'react-dom';
+import { matchPath } from 'react-router';
+import { BrowserRouter, Route, Switch } from 'react-router-dom';
+import { generateRoutes } from 'react-code-split-ssr';
+import { routes, redirects } from '/imports/routes';
 // import some components...
 
 /* In an async function */
 const Routes = await generateRoutes({
-  routes,
-  redirects,
-  notFoundComp: NotFound,
-  pathname: window.location.pathname,
-})
+	routes,
+	redirects,
+	notFoundComp: NotFound,
+	pathname: window.location.pathname,
+});
 render(
-  <BrowserRouter>
-    <Layout>
-      <Routes />
-    </Layout>
-  </BrowserRouter>,
-  document.getElementById('app'),
-)
+	<BrowserRouter>
+		<Layout>
+			<Routes />
+		</Layout>
+	</BrowserRouter>,
+	document.getElementById('app')
+);
 ```
+
 Server:
+
 ```js
-import { Route, StaticRouter, Switch } from 'react-router'
-import React from 'react'
-import { renderToString } from 'react-dom/server'
-import { generateRoutes } from 'react-code-split-ssr'
-import { routes, redirects } from '/imports/routes'
+import { Route, StaticRouter, Switch } from 'react-router';
+import React from 'react';
+import { renderToString } from 'react-dom/server';
+import { generateRoutes } from 'react-code-split-ssr';
+import { routes, redirects } from '/imports/routes';
 // import some components...
 
 /* In an async server router */
 const Routes = await generateRoutes({
-  routes,
-  redirects,
-  notFoundComp: NotFound,
-  pathname: req.url
-})
-
-const ServerRoutes = ({url, context = {}}) => (
-  <StaticRouter
-    location={url.pathname}
-    context={context}
-  >
-    <Layout>
-      <Routes />
-    </Layout>
-  </StaticRouter>
-)
-const bodyHtmlString = renderToString(<ServerRoutes url={sink.request.url} />)
+	routes,
+	redirects,
+	notFoundComp: NotFound,
+	pathname: req.url,
+});
+
+const ServerRoutes = ({ url, context = {} }) => (
+	<StaticRouter location={url.pathname} context={context}>
+		<Layout>
+			<Routes />
+		</Layout>
+	</StaticRouter>
+);
+const bodyHtmlString = renderToString(<ServerRoutes url={sink.request.url} />);
 // Use bodyHtmlString to where you need
 ```
 
 ## API
 
 ### Bundle - React Component \<Bundle\>
+
 #### Props
-- mod {Promise<Component>} ***Required*** - A `Promise` object which can be resolved to React Component
+
+- mod {Promise<Component>} **_Required_** - A `Promise` object which can be resolved to React Component
 - loading {Component} - A React Component
 
 ### generateRoutes - Func (object: Options)
+
 A function that returns a `Promise` object which can be resolved to React Router routes wrapped in `<Switch>`
 
 #### Options
-- pathname {string} ***Required*** - Pathname for initial loading
-- routes {objects}[] ***Required*** - An array of `<Route>` props object
+
+- pathname {string} **_Required_** - Pathname for initial loading
+- routes {objects}[] **_Required_** - An array of `<Route>` props object
   - `component` field only accepts `() => <Bundle/>`
   - `location`, `render` fields are currently not supported
-- redirects  {objects}[] - An array of `<Redirect>` props object
+- redirects {objects}[] - An array of `<Redirect>` props object
 - notFoundComp {Component} - A React component for 404 Not Found, only accepts `() => <Bundle/>`
 
+## v1.3.0
+
+- [x] Upgrade to React-Router 7 and React 19
+
 ## v1.2.0
+
 - [x] Remove redirects, Fix React-Router v6 specific rendering
 
 ## v1.1.0
+
 - [x] Upgrade to React-Router v6
 
 ## v1.0.0
+
 - [ ] SSR correctly for redirected routes
-- [X] Change `notFoundComp` to `() => <Bundle />`
+- [x] Change `notFoundComp` to `() => <Bundle />`
 - [ ] Add more argument validations

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@appigram/react-code-split-ssr",
-	"version": "1.3.0",
+	"version": "1.3.1",
 	"description": "React code splitting with SSR",
 	"main": "./lib/index.js",
 	"scripts": {