Bumping react versions, fixing some tests, adding some documentation

.eslintrc.json

@@ -9,7 +9,12 @@
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:react/recommended",
-    "prettier"
+    "prettier",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/typescript",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
   ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
@@ -18,7 +23,12 @@
     },
     "sourceType": "module"
   },
-  "plugins": ["react", "@typescript-eslint"],
+  "plugins": [
+    "react", 
+    "@typescript-eslint",
+    "jsdoc",
+    "prefer-arrow"
+  ],
   "rules": {
     "react/display-name": "off"
   },

.gitignore

@@ -1,3 +1,4 @@
 /lib
 /node_modules
 /coverage
+.env

.nvmrc

@@ -0,0 +1 @@
+v18.17.0

README.md

@@ -37,6 +37,18 @@ Or using NPM:
 
     $ npm install react-esi
 
+## Testing
+
+Update snapshots
+
+    $ npm updateSnapshot
+
+Run tests
+
+    $ npm run test
+
+Tests do not work locally without a valid url to serve from, currently server.tsx has hardcoded value example.com does not run a local dev server for testing purposes.
+
 ## Usage
 
 React ESI provides a convenient [Higher Order Component](https://reactjs.org/docs/higher-order-components.html) that will:

jest.config.js

@@ -5,5 +5,11 @@ module.exports = {
   },
   testRegex: "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
   moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
-  testEnvironment: "jsdom"
+  testEnvironment: "jsdom",
+
+  setupFiles: [
+    "./jest/jest.polyfills.js",
+    "./jest/jest.envVars.js",
+    "./src/server.tsx"
+  ]
 };

jest/jest.envVars.js

@@ -0,0 +1,3 @@
+process.env.REACT_ESI_SECRET =
+  "f7ddf06659aadbcba0cdad4c927ac5bf38167d714e1a15cad13115e7e9d21a9d";
+process.env.REACT_ESI_PATH = "/_custom";

jest/jest.polyfills.js

@@ -0,0 +1,33 @@
+// jest.polyfills.js
+/**
+ * @note The block below contains polyfills for Node.js globals
+ * required for Jest to function when running JSDOM tests.
+ * These HAVE to be require's and HAVE to be in this exact
+ * order, since "undici" depends on the "TextEncoder" global API.
+ *
+ * Consider migrating to a more modern test runner if
+ * you don't want to deal with this.
+ */
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { TextDecoder, TextEncoder, ReadableStream } = require("node:util");
+Object.defineProperties(globalThis, {
+  ReadableStream: { value: ReadableStream },
+  TextDecoder: { value: TextDecoder },
+  TextEncoder: { value: TextEncoder }
+});
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { Blob, File } = require("node:buffer");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { fetch, Headers, FormData, Request, Response } = require("undici");
+
+Object.defineProperties(globalThis, {
+  fetch: { value: fetch, writable: true },
+  Blob: { value: Blob },
+  File: { value: File },
+  Headers: { value: Headers },
+  FormData: { value: FormData },
+  Request: { value: Request },
+  Response: { value: Response },
+});