@sequencemedia/react-router-render 2.4.56 → 2.5.1

package/babel.config.cjs

@@ -12,5 +12,7 @@ module.exports = {
     ],
     '@babel/react'
   ],
-  ignore: [/node_modules\/(?!@sequencemedia\/react-router-render)/]
+  ignore: [
+    /node_modules\/(?!@sequencemedia\/react-router-render)/
+  ]
 }

package/eslint.config.mjs

@@ -0,0 +1,147 @@
+import globals from 'globals'
+import standard from '@sequencemedia/eslint-config-standard/configs/recommended/merge'
+import typescript from '@sequencemedia/eslint-config-typescript/configs/recommended/merge'
+import babelParser from '@babel/eslint-parser'
+import typescriptParser from '@typescript-eslint/parser'
+import reactPlugin from 'eslint-plugin-react'
+
+const reactParserOptions = {
+  ecmaFeatures: {
+    jsx: true
+  }
+}
+
+const reactPlugins = {
+  react: reactPlugin
+}
+
+const reactRules = {
+  'no-unused-vars': [
+    'error',
+    {
+      varsIgnorePattern: 'React'
+    }
+  ],
+  quotes: [
+    'error',
+    'single'
+  ],
+  'jsx-quotes': [
+    'error',
+    'prefer-single'
+  ],
+  'react/jsx-indent': [
+    'error',
+    2,
+    {
+      checkAttributes: true,
+      indentLogicalExpressions: true
+    }
+  ]
+}
+
+const reactSettings = {
+  react: {
+    version: 'detect'
+  }
+}
+
+export default [
+  {
+    ignores: [
+      'coverage'
+    ]
+  },
+  /**
+   *  React config for all `jsx` files
+   */
+  {
+    ...reactPlugin.configs.flat.recommended,
+    settings: {
+      ...reactSettings
+    }
+  },
+  /**
+   *  Standard config
+   */
+  standard({
+    files: [
+      '**/*.{mjs,cjs,mts,cts}'
+    ],
+    ignores: [
+      'src',
+      'test'
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.node
+      }
+    }
+  }),
+  standard({
+    files: [
+      'src/**/*.{mjs,cjs,mts,cts}'
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.node
+      }
+    }
+  }),
+  standard({
+    files: [
+      'test/**/*.{mjs,cjs,mts,cts}'
+    ],
+    languageOptions: {
+      globals: {
+        ...globals.mocha
+      }
+    }
+  }),
+  /**
+   *  Standard config for all `jsx` files
+   */
+  standard({
+    files: [
+      'src/**/*.jsx'
+    ],
+    languageOptions: {
+      parser: babelParser,
+      parserOptions: {
+        ...reactParserOptions,
+        project: null
+      },
+      globals: {
+        ...globals.browser
+      }
+    },
+    plugins: {
+      ...reactPlugins
+    }, // @ts-expect-error Storybook
+    rules: {
+      ...reactRules
+    },
+    settings: {
+      ...reactSettings
+    }
+  }),
+  /**
+   *  TypeScript config
+   */
+  typescript({
+    files: [
+      '**/*.{mts,cts}'
+    ],
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        projectService: true,
+        project: 'tsconfig.json'
+      },
+      globals: {
+        ...globals.node,
+        ReactRouterRenderTypes: 'readonly'
+      }
+    }
+  })
+]

package/index.d.mts

@@ -0,0 +1,13 @@
+import type React from 'react'
+import type {
+  StaticRouterProps
+} from 'react-router'
+
+declare global {
+  namespace ReactRouterRenderTypes {
+    export type RouterPropsType = StaticRouterProps
+    export type RoutesType = React.ReactNode
+  }
+}
+
+export {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencemedia/react-router-render",
-  "version": "2.4.56",
+  "version": "2.5.1",
   "description": "Sync/async isomorphic render of React apps with React Router",
   "keywords": [
     "React",
@@ -13,6 +13,7 @@
   ],
   "main": "./src/index.mjs",
   "type": "module",
+  "types": "./index.d.mts",
   "author": {
     "name": "Jonathan Perry for Sequence Media Limited",
     "email": "jonathanperry@sequencemedia.net",
@@ -27,7 +28,7 @@
     "url": "git://github.com/sequencemedia/react-router-render.git"
   },
   "scripts": {
-    "lint": "eslint . --ext .mjs,.cjs,.jsx",
+    "lint": "eslint",
     "lint:fix": "npm run lint -- --fix",
     "prepare": "husky",
     "test": "NODE_ENV=test mocha test --recursive --verbose"
@@ -37,17 +38,29 @@
     "debug": "^4.4.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.9",
-    "@babel/eslint-parser": "^7.26.8",
+    "@babel/core": "^7.26.10",
+    "@babel/eslint-parser": "^7.26.10",
     "@babel/preset-env": "^7.26.9",
     "@babel/preset-react": "^7.26.3",
     "@babel/register": "^7.25.9",
+    "@sequencemedia/eslint-config-standard": "^0.2.42",
+    "@sequencemedia/eslint-config-typescript": "^0.1.60",
     "@sequencemedia/sinon-chai": "^0.0.131",
+    "@types/babel__register": "^7.17.3",
+    "@types/debug": "^4.1.12",
+    "@types/prop-types": "^15.7.14",
+    "@types/react": "^19.0.10",
+    "@types/react-dom": "^19.0.4",
+    "@types/react-redux": "^7.1.34",
+    "@types/react-router": "^5.1.20",
+    "@types/redux": "^3.6.0",
+    "@typescript-eslint/eslint-plugin": "^8.26.1",
+    "@typescript-eslint/parser": "^8.26.1",
     "chai": "^5.2.0",
     "core-js": "^3.41.0",
-    "eslint": "8.57.1",
-    "eslint-config-standard": "^17.1.0",
+    "eslint": "^9.22.0",
     "eslint-plugin-react": "^7.37.4",
+    "globals": "^16.0.0",
     "husky": "^9.1.7",
     "mocha": "^11.1.0",
     "prop-types": "^15.8.1",

package/src/index.d.cts

@@ -0,0 +1,5 @@
+export {
+  renderToString,
+  renderToStaticMarkup,
+  render
+} from '#react-router-render'

package/src/index.d.mts

@@ -0,0 +1,5 @@
+export {
+  renderToString,
+  renderToStaticMarkup,
+  render
+} from '#react-router-render'

package/src/index.mjs

@@ -1,3 +1,8 @@
+/**
+ *  @typedef {ReactRouterRenderTypes.RouterPropsType} RouterPropsType
+ *  @typedef {ReactRouterRenderTypes.RoutesType} RoutesType
+ */
+
 import debug from 'debug'
 
 import Boom from '@hapi/boom'
@@ -12,17 +17,21 @@ const log = debug('@sequencemedia/react-redux-render')
 log('`react-redux-render` is awake')
 
 /**
- * @param {Object.<string, any>} data
- * @returns A boom object
+ *  @param {RouterPropsType} data
+ *  @returns A boom object
  */
-const notFound = (data) => Boom.notFound('Routing exception', data)
+function notFound (data) {
+  return (
+    Boom.notFound('Routing exception', data)
+  )
+}
 
 /**
- * @param {Object.<string, any>} routerProps
- * @param {Object.<string, any>} routes
- * @returns {string}
+ *  @param {RouterPropsType & { context?: Record<PropertyKey, unknown> }} routerProps
+ *  @param {RoutesType} routes
+ *  @returns {string}
  */
-export function renderToString ({ location, context = {}, ...router } = {}, routes = {}) {
+export function renderToString ({ location, context = {}, ...router }, routes) {
   const routerProps = { ...router, location, context }
   const string = getReactDOMServerRenderToString(routerProps, routes)
   if (string) return string
@@ -30,11 +39,11 @@ export function renderToString ({ location, context = {}, ...router } = {}, rout
 }
 
 /**
- * @param {Object.<string, any>} routerProps
- * @param {Object.<string, any>} routes
- * @returns {string}
+ *  @param {RouterPropsType & { context?: Record<PropertyKey, unknown> }} routerProps
+ *  @param {RoutesType} routes
+ *  @returns {string}
  */
-export function renderToStaticMarkup ({ location, context = {}, ...router } = {}, routes = {}) {
+export function renderToStaticMarkup ({ location, context = {}, ...router }, routes) {
   const routerProps = { ...router, location, context }
   const string = getReactDOMServerRenderToStaticMarkup(routerProps, routes)
   if (string) return string
@@ -42,11 +51,11 @@ export function renderToStaticMarkup ({ location, context = {}, ...router } = {}
 }
 
 /**
- * @param {Object.<string, any>} routerProps
- * @param {Object.<string, any>} routes
- * @returns {Promise<string>}
+ *  @param {RouterPropsType & { context?: Record<PropertyKey, unknown> }} routerProps
+ *  @param {RoutesType} routes
+ *  @returns {string}
  */
-export async function render ({ location, context = {}, ...router } = {}, routes = {}) {
+export function render ({ location, context = {}, ...router }, routes) {
   const routerProps = { ...router, location, context }
   const string = getReactDOMServerRenderToString(routerProps, routes)
   if (string) return string

package/src/react-dom-server.cjs

@@ -1,5 +1,7 @@
 require('@babel/register')({
-  ignore: [/node_modules\/(?!@sequencemedia\/react-router-render)/]
+  ignore: [
+    /node_modules\/(?!@sequencemedia\/react-router-render)/
+  ]
 })
 
 const {

package/src/react-dom-server.d.cts

@@ -0,0 +1,4 @@
+export {
+  getReactDOMServerRenderToString,
+  getReactDOMServerRenderToStaticMarkup
+} from '#react-router-render/react-dom-server'

package/src/react-dom-server.d.mts

@@ -0,0 +1,8 @@
+declare module '#react-router-render/react-dom-server' {
+  type RouterPropsType = ReactRouterRenderTypes.RouterPropsType
+  type RoutesType = ReactRouterRenderTypes.RoutesType
+
+  export function getReactDOMServerRenderToString (routerProps: RouterPropsType, routes: RoutesType): string
+
+  export function getReactDOMServerRenderToStaticMarkup (routerProps: RouterPropsType, routes: RoutesType): string
+}

package/src/react-dom-server.jsx

@@ -1,3 +1,16 @@
+/**
+ *  @typedef {ReactRouterRenderTypes.RouterPropsType} RouterPropsType
+ *  @typedef {ReactRouterRenderTypes.RoutesType} RoutesType
+ *
+ *  @typedef {{
+ *    props: RouterPropsType
+ *  }} RouterPropsException
+ *
+ *  @typedef {{
+ *    e: unknown
+ *  }} Exception
+ */
+
 import debug from 'debug'
 import React from 'react'
 import ReactDOMServer from 'react-dom/server'
@@ -11,16 +24,20 @@ const log = debug('@sequencemedia/react-redux-render')
 log('`react-redux-render` is awake')
 
 /**
- * @param {Error} e
- * @param {{props: Object.<string, any>}} data
- * @returns A boom object
+ *  @param {Error} e
+ *  @param {RouterPropsException | Exception} data
+ *  @returns A boom object
  */
-const badImplementation = (e, data) => Boom.boomify(e, { statusCode: 500, message: 'Rendering exception', data })
+function badImplementation (e, data) {
+  return (
+    Boom.boomify(e, { statusCode: 500, message: 'Rendering exception', data })
+  )
+}
 
 /**
- * @param {Object.<string, any>} routerProps
- * @param {Object.<string, any>} routes
- * @returns {string}
+ *  @param {RouterPropsType} routerProps
+ *  @param {RoutesType} routes
+ *  @returns {string}
  */
 export function getReactDOMServerRenderToString (routerProps, routes) {
   try {
@@ -30,16 +47,15 @@ export function getReactDOMServerRenderToString (routerProps, routes) {
       </Router>
     )
   } catch (e) {
-    log(e)
-
-    throw badImplementation(e, routerProps)
+    if (e instanceof Error) throw badImplementation(e, { props: routerProps })
+    throw badImplementation(new Error('Exception'), { e })
   }
 }
 
 /**
- * @param {Object.<string, any>} routerProps
- * @param {Object.<string, any>} routes
- * @returns {string}
+ *  @param {RouterPropsType} routerProps
+ *  @param {RoutesType} routes
+ *  @returns {string}
  */
 export function getReactDOMServerRenderToStaticMarkup (routerProps, routes) {
   try {
@@ -49,8 +65,7 @@ export function getReactDOMServerRenderToStaticMarkup (routerProps, routes) {
       </Router>
     )
   } catch (e) {
-    log(e)
-
-    throw badImplementation(e, routerProps)
+    if (e instanceof Error) throw badImplementation(e, { props: routerProps })
+    throw badImplementation(new Error('Exception'), { e })
   }
 }

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "target": "ESNext",
+    "allowJs": true,
+    "checkJs": true,
+    "noEmit": true,
+    "strict": true,
+    "jsx": "react",
+    "paths": {
+      "#react-router-render": [
+        "./src/index.mjs"
+      ],
+      "#react-router-render/react-dom-server": [
+        "./src/react-dom-server.cjs"
+      ]
+    }
+  },
+  "include": [
+    "."
+  ],
+  "exclude": [
+    "test"
+  ]
+}