Merge pull request #116 from shipt/development

Release 2.1.0

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 defaults: &defaults
   working_directory: ~/osmosis
   docker:
-    - image: circleci/node:12.16.1
+    - image: circleci/node:14.17.0
 
 install_dependencies: &install_dependencies
   run:

.github/CODEOWNERS

@@ -1 +1 @@
-* @chaceburnette @lein-haz @joshuakg @jkhusanov @divijadesai @taylorcore @MarquessV @TomMahle @ChiefoftheOwls @rkyle35242
+* @chaceburnette @lein-haz @joshuakg @jkhusanov @divijadesai @taylorcore @TomMahle @rkyle35242

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## v2.1.0
+* Updated several dependencies
+* Updated package.json to reflect React 18 compatibility as peer dependency
+* Other maintenance changes
+* Updated the wrapper component name to be set from the store hook name
+
 ## v2.0.2
 * Updated for better intellisence using templates
 * Added `useStore` to be attached to objects returned from `setupStore`, which wraps and abstracts the need to explicitly call `useContext(StoreContext)` when subscribing to a store. This also helps with mocking store objects when unit testing components subscribed to a store.

examples/counter-react/package.json

@@ -4,12 +4,13 @@
   "private": true,
   "dependencies": {
     "@shipt/osmosis": "../../osmosis",
-    "@testing-library/jest-dom": "^4.2.4",
-    "@testing-library/react": "^9.3.2",
-    "@testing-library/user-event": "^7.1.2",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
-    "react-scripts": "4.0.3"
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^13.4.0",
+    "@testing-library/user-event": "^14.4.3",
+    "@testing-library/dom": "^8.19.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-scripts": "5.0.1"
   },
   "scripts": {
     "start": "react-scripts start",

examples/counter-react/src/App.js

@@ -3,7 +3,7 @@ import { CounterStore, CounterWithReducerStore } from './store';
 
 import Counter from './counter';
 import PersistedCounter from './persistedCounter.js';
-import DispactCounter from './dispatchCounter.js';
+import DispatchCounter from './dispatchCounter.js';
 import CounterByName from './counterByName.js';
 
 configureUsePersistedState({
@@ -18,7 +18,7 @@ const App = () => {
     <>
       <Counter />
       <PersistedCounter />
-      <DispactCounter />
+      <DispatchCounter />
       {counters.map(name => (
         <CounterByName key={name} storeKey={name} name={name} />
       ))}

examples/counter-react/src/index.js

@@ -1,11 +1,11 @@
 import React from 'react';
-import ReactDOM from 'react-dom';
+import { createRoot }from 'react-dom/client';
 import App from './App';
 
-ReactDOM.render(
+const root = createRoot(document.getElementById('root'));
+root.render(
   <React.StrictMode>
     <App />
-  </React.StrictMode>,
-  document.getElementById('root')
+  </React.StrictMode>
 );
 

examples/counter-react/src/setupTests.js

@@ -4,9 +4,13 @@
 // learn more: https://github.com/testing-library/jest-dom
 import '@testing-library/jest-dom/extend-expect';
 import 'regenerator-runtime/runtime';
-
+import { configure as configureTestingLibrary } from '@testing-library/react';
 import { configureUsePersistedState } from '@shipt/osmosis';
+
+// https://github.com/testing-library/dom-testing-library/issues/524
+configureTestingLibrary({ asyncUtilTimeout: 400 });
+
 configureUsePersistedState({
-  getItem: ()=> {},
+  getItem: () => {},
   setItem: () => {}
 });

osmosis/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipt/osmosis",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "A lightweight state management library for React and React Native",
   "keywords": [
     "react",
@@ -35,6 +35,6 @@
     "generateTypes": "npx typescript ./src/index.js --declaration --allowJs --emitDeclarationOnly --outDir dist"
   },
   "peerDependencies": {
-    "react": "16.x || 17.x"
+    "react": "16.x || 17.x || 18.x"
   }
 }

osmosis/src/setupStore.js

@@ -83,6 +83,7 @@ const setupStore = (useCustomHook, config = {}) => {
         <WrappedComponent {...props} />
       </StoreContextWrapper>
     );
+    Wrapper.displayName = `${useCustomHook.name}Wrapper`;
     return Wrapper;
   };
 

osmosis/yarn.lock

@@ -1391,7 +1391,7 @@ component-emitter@^1.2.1:
 [email protected]:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
-  integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=
+  integrity sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==
 
 convert-source-map@^1.1.0, convert-source-map@^1.7.0:
   version "1.8.0"
@@ -2314,9 +2314,9 @@ micromatch@^3.1.10, micromatch@^3.1.4:
     to-regex "^3.0.2"
 
 minimatch@^3.0.4:
-  version "3.0.4"
-  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083"
-  integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==
+  version "3.1.2"
+  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b"
+  integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==
   dependencies:
     brace-expansion "^1.1.7"