react-on-rails 13.4.0 → 14.0.0

package/README.md

@@ -63,7 +63,7 @@ See [Rails/Webpacker React Integration Options](https://www.shakacode.com/react-
 
 ## Online demo
 * See the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) for an example of a live implementation and code.
-* A deployed version of the project `spec/dummy` which demonstrates several uses of `react_on_rails` is available on heroku [through this link](https://ror-spec-dummy.herokuapp.com/)
+* A deployed version of the project `spec/dummy`, which demonstrates several uses of `react_on_rails`, will soon be available on [Control Plane through this link](https://ror-spec-dummy.reactrails.com/)
 
 ## ShakaCode Forum Premium Content
 _Requires creating a free account._
@@ -73,7 +73,7 @@ _Requires creating a free account._
 
 ## Prerequisites
 
-Ruby on Rails >=5, rails/webpacker >= 4.2 or shakapacker > 6, Ruby >= 2.7
+Ruby on Rails >=5, rails/webpacker >= 4.2 or shakapacker > 6, Ruby >= 3.0.0
 
 # Support
 

package/node_package/lib/ReactOnRails.d.ts

@@ -1,2 +1,3 @@
+export * from "./types";
 declare const _default: import("./types").ReactOnRails;
 export default _default;

package/node_package/lib/ReactOnRails.js

@@ -22,6 +22,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -259,4 +262,5 @@ ctx.ReactOnRails = {
 };
 ctx.ReactOnRails.resetOptions();
 ClientStartup.clientStartup(ctx);
+__exportStar(require("./types"), exports);
 exports.default = ctx.ReactOnRails;

package/node_package/lib/clientStartup.js

@@ -245,7 +245,6 @@ function clientStartup(context) {
     if (!isWindow(context)) {
         return;
     }
-    var document = context.document;
     // Tried with a file local variable, but the install handler gets called twice.
     // eslint-disable-next-line no-underscore-dangle
     if (context.__REACT_ON_RAILS_EVENT_HANDLERS_RAN_ONCE__) {

package/node_package/lib/reactApis.js

@@ -6,7 +6,7 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.supportsRootApi = void 0;
 var react_dom_1 = __importDefault(require("react-dom"));
-var reactMajorVersion = ((_a = react_dom_1.default.version) === null || _a === void 0 ? void 0 : _a.split('.')[0]) || 16;
+var reactMajorVersion = Number((_a = react_dom_1.default.version) === null || _a === void 0 ? void 0 : _a.split('.')[0]) || 16;
 // TODO: once we require React 18, we can remove this and inline everything guarded by it.
 // Not the default export because others may be added for future React versions.
 // eslint-disable-next-line import/prefer-default-export

package/node_package/lib/serverRenderReactComponent.js

@@ -45,6 +45,7 @@ var createReactOutput_1 = __importDefault(require("./createReactOutput"));
 var isServerRenderResult_1 = require("./isServerRenderResult");
 var buildConsoleReplay_1 = __importDefault(require("./buildConsoleReplay"));
 var handleError_1 = __importDefault(require("./handleError"));
+/* eslint-disable @typescript-eslint/no-explicit-any */
 function serverRenderReactComponentInternal(options) {
     var _this = this;
     var name = options.name, domNodeId = options.domNodeId, trace = options.trace, props = options.props, railsContext = options.railsContext, renderingReturnsPromises = options.renderingReturnsPromises, throwJsErrors = options.throwJsErrors;

package/node_package/lib/types/index.d.ts

@@ -1,6 +1,6 @@
-import type { ReactElement, ReactNode, Component, FunctionComponent, ComponentClass } from 'react';
+import type { ReactElement, ReactNode, Component, ComponentType } from 'react';
 type Store = any;
-type ReactComponent = FunctionComponent | ComponentClass | string;
+type ReactComponent = ComponentType<any> | string;
 export interface RailsContext {
     railsEnv: string;
     inMailer: boolean;
@@ -10,14 +10,13 @@ export interface RailsContext {
     rorPro: boolean;
     rorProVersion?: string;
     serverSide: boolean;
-    originalUrl: string;
     href: string;
     location: string;
     scheme: string;
     host: string;
-    port: string;
+    port: number | null;
     pathname: string;
-    search: string;
+    search: string | null;
     httpAcceptLanguage: string;
 }
 type AuthenticityHeaders = {
@@ -28,7 +27,10 @@ type AuthenticityHeaders = {
 };
 type StoreGenerator = (props: Record<string, unknown>, railsContext: RailsContext) => Store;
 interface ServerRenderResult {
-    renderedHtml?: string;
+    renderedHtml?: string | {
+        componentHtml: string;
+        [key: string]: string;
+    };
     redirectLocation?: {
         pathname: string;
         search: string;
@@ -39,7 +41,7 @@ interface ServerRenderResult {
 type CreateReactOutputResult = ServerRenderResult | ReactElement | Promise<string>;
 type RenderFunctionResult = ReactComponent | ServerRenderResult | Promise<string>;
 interface RenderFunction {
-    (props?: Record<string, unknown>, railsContext?: RailsContext, domNodeId?: string): RenderFunctionResult;
+    (props?: any, railsContext?: RailsContext, domNodeId?: string): RenderFunctionResult;
     renderFunction?: boolean;
 }
 type ReactComponentOrRenderFunction = ReactComponent | RenderFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "13.4.0",
+  "version": "14.0.0",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
@@ -14,40 +14,40 @@
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-react": "^7.18.6",
     "@babel/types": "^7.20.7",
-    "@types/jest": "^28.1.3",
-    "@types/react": "^16.14.35",
-    "@types/react-dom": "^16.9.17",
-    "@types/turbolinks": "^5.2.0",
-    "@types/webpack-env": "^1.18.0",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
+    "@types/jest": "^29.0.0",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
+    "@types/turbolinks": "^5.2.2",
+    "@types/webpack-env": "^1.18.4",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
     "babelify": "^10.0.0",
     "blue-tape": "^1.0.0",
+    "concurrently": "^8.2.2",
     "create-react-class": "^15.7.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^7.0.0",
     "eslint-config-shakacode": "^16.0.1",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-prettier": "^3.4.1",
-    "eslint-plugin-react": "^7.32.1",
-    "jest": "^28.1.3",
-    "jest-environment-jsdom": "^28.1.3",
-    "jsdom": "^16.4.0",
+    "eslint-plugin-react": "^7.33.2",
+    "jest": "^29.0.0",
+    "jest-environment-jsdom": "^29.0.0",
+    "jsdom": "^22.1.0",
     "nps": "^5.9.3",
-    "prettier": "^2.8.3",
+    "prettier": "^2.8.8",
     "prettier-eslint-cli": "^5.0.0",
     "prop-types": "^15.8.1",
-    "react": "^16.14.0",
-    "react-dom": "^16.14.0",
+    "react": "^17.0.0",
+    "react-dom": "^17.0.0",
     "react-transform-hmr": "^1.0.4",
-    "redux": "^4.2.0",
-    "ts-jest": "^28.0.8",
-    "typescript": "^4.9.4"
+    "redux": "^4.2.1",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@babel/runtime-corejs3": "^7.12.5",
-    "concurrently": "^5.1.0"
+    "@babel/runtime-corejs3": "^7.12.5"
   },
   "peerDependencies": {
     "js-yaml": ">= 3.0.0",
@@ -55,8 +55,7 @@
     "react-dom": ">= 16"
   },
   "files": [
-    "node_package/lib",
-    "webpackConfigLoader.js"
+    "node_package/lib"
   ],
   "scripts": {
     "test": "jest node_package/tests",

package/webpackConfigLoader.js

@@ -1,71 +0,0 @@
-/**
- * TODO: THIS SHOULD BE REMOVED
- *
- * Allow defaults for the config/webpacker.yml. Thee values in this file MUST match values
- * in https://github.com/rails/webpacker/blob/master/lib/install/config/webpacker.yml
- *
- * NOTE: for HMR reloading, env.WEBPACKER_HMR value will override any config value. This env value
- * should be set to TRUE to turn this on.
- */
-
-const { join, resolve } = require('path');
-const { env } = require('process');
-const { safeLoad } = require('js-yaml');
-const { readFileSync } = require('fs');
-
-function removeOuterSlashes(string) {
-  return string.replace(/^\/*/, '').replace(/\/*$/, '');
-}
-
-function formatPublicPath(settings) {
-  if (settings.dev_server) {
-    const { host } = settings.dev_server;
-    const { port } = settings.dev_server;
-    const path = settings.public_output_path;
-    const hostWithHttp = `http://${host}:${port}`;
-
-    let formattedHost = removeOuterSlashes(hostWithHttp);
-    if (formattedHost && !/^http/i.test(formattedHost)) {
-      formattedHost = `//${formattedHost}`;
-    }
-    const formattedPath = removeOuterSlashes(path);
-    return `${formattedHost}/${formattedPath}/`;
-  }
-
-  const publicOuterPathWithoutOutsideSlashes = removeOuterSlashes(settings.public_output_path);
-  return `//${publicOuterPathWithoutOutsideSlashes}/`;
-}
-
-/**
- * @param configPath, location where webpacker.yml will be found
- * Return values are consistent with Webpacker's js helpers
- * For example, you might define:
- *   const isHMR = settings.dev_server && settings.dev_server.hmr
- * @returns {{
-     settings,
-     resolvedModules,
-     output: { path, publicPath, publicPathWithHost }
-   }}
- */
-const configLoader = (configPath) => {
-  // Some test environments might not have the NODE_ENV set, so we'll have fallbacks.
-  const configEnv = env.NODE_ENV || env.RAILS_ENV || 'development';
-  const ymlConfigPath = join(configPath, 'webpacker.yml');
-  const settings = safeLoad(readFileSync(ymlConfigPath, 'utf8'))[configEnv];
-
-  // NOTE: Rails path is hard coded to `/public`
-  const output = {
-    // Next line differs from the webpacker definition as we use the configPath to create
-    // the relative path.
-    path: resolve(configPath, '..', 'public', settings.public_output_path),
-    publicPath: `/${settings.public_output_path}/`.replace(/([^:]\/)\/+/g, '$1'),
-    publicPathWithHost: formatPublicPath(settings),
-  };
-
-  return {
-    settings,
-    output,
-  };
-};
-
-module.exports = configLoader;