state-in-url 3.0.4 → 3.0.6

package/README.md

@@ -3,7 +3,14 @@ English | [한국어](./README.KO.md) | [简体中文](./README.CN.md)
 <div align="center">
   <img src="/assets/Logo_big.png?raw=true" alt="state-in-url logo"/>
 
-  <div>Easily share complex state between unrelated React components, with IDE autocomplete and TS validation. Without any hasssle or boilerplate. </div>
+  <div><h2>Easily share complex state objects between unrelated React components, preserve types and structure, with TS validation. Without any hasssle or boilerplate.</h2></div>
+
+</div>
+
+<hr />
+
+<div align="center">
+<a href="https://github.com/asmyshlyaev177/state-in-url/blob/master/Limits.md"  target="_blank">URI size limitation, <b>up to 12KB</b> is safe</a>
 </div>
 
 <div align="center">
@@ -16,7 +23,6 @@ English | [한국어](./README.KO.md) | [简体中文](./README.CN.md)
 [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)]([https://github.com/semantic-release/semantic-release](https://github.com/asmyshlyaev177/state-in-url))
 ![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/state-in-url.svg)
 
-[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/master/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua/)
 </div>
 
 <div align="center">
@@ -26,12 +32,14 @@ English | [한국어](./README.KO.md) | [简体中文](./README.CN.md)
 ![Demo-gif](https://github.com/asmyshlyaev177/state-in-url/blob/master/assets/Demo-gif.gif)
 
 <a href="https://state-in-url-asmyshlyaev177.vercel.app/" target="_blank">DEMO</a> |
-<a href="https://state-in-url.netlify.app/" target="_blank">DEMO2</a> |
+<a href="https://state-in-url.netlify.app/" target="_blank">DEMO2</a>
 
 <hr />
 
 Add a ⭐️ and <a href="https://github.com/asmyshlyaev177" target="_blank">follow me</a> to support the project!
 
+Will appreciate you feedback/opinion on [discussions](https://github.com/asmyshlyaev177/state-in-url/discussions/1)
+
 Share if it useful for you.
 [FB](https://www.facebook.com/sharer.php?u=https://github.com/asmyshlyaev177/state-in-url)
 [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/asmyshlyaev177/state-in-url)
@@ -42,7 +50,7 @@ Share if it useful for you.
 
   </div>
 
-## Why use state-in-url?
+# Why use state-in-url?
 
 `state-in-url` Simple state management with optional URL sync. Good for implementing deep links. Share complex states between unrelated React components, TS-friendly, NextJS compatible. Most of users don't care about URL, so, can use it to store your app state.
 
@@ -103,7 +111,7 @@ pnpm add state-in-url
 In `tsconfig.json` in `compilerOptions` set `"moduleResolution": "Bundler"`, or`"moduleResolution": "Node16"`, or `"moduleResolution": "NodeNext"`.
 Possibly need to set `"module": "ES2022"`, or `"module": "ESNext"`
 
-# useUrlState
+## useUrlState
 
 `useUrlState` is a custom React hook for Next.js/React-Router applications that make communication between client components easy. It allows you to share any complex state and sync it with the URL search parameters, providing a way to persist state across page reloads and share application state via URLs.
 
@@ -353,7 +361,6 @@ API is same as for Next.js version, except can pass options from [NavigateOption
 
 [Docs](packages/urlstate/react-router/useUrlState#api)
 
-
 ### Example
 
 ```typescript
@@ -487,7 +494,6 @@ function SettingsComponent() {
 
 See [Contributing doc](CONTRIBUTING.md)
 
-
 ## Roadmap
 
 - [x] hook for `Next.js`

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "state-in-url",
-  "version": "3.0.4",
-  "description": "Library to store complex state in browser URL, includes hook for NextJS, hook for pure React, and low level helpers.",
+  "version": "3.0.6",
+  "description": "Easily share complex state objects between unrelated React components, preserve types and structure, with TS validation. Deep links and url state synchronization wthout any hasssle or boilerplate.",
   "homepage": "https://state-in-url-asmyshlyaev177.vercel.app",
   "keywords": [
     "front-end",
@@ -103,7 +103,7 @@
     "test:unit": "wireit",
     "test:int": "wireit",
     "test:int:ci": "wireit",
-    "test:exports": "npx babel-node --extensions .js,.mjs,.ts,.mts --config-file ./babel.config.json -- ./packages/urlstate/exportsTest.ts",
+    "test:exports": "npm run build && npx babel-node --extensions .js,.mjs,.ts,.mts --config-file ./babel.config.json -- ./packages/urlstate/exportsTest.ts",
     "test": "wireit",
     "tsc": "wireit",
     "dev": "wireit",
@@ -126,8 +126,7 @@
     "reinstall": "rm -rf dist .wireit node_modules packages/example-nextjs14/node_modules packages/example-nextjs14/.next packages/example-react/node_modules && npm install",
     "setup": "playwright install --with-deps",
     "prepack": "npm run build && cp package.json dist/package.json && npm run build:demo",
-    "prepare": "npx husky",
-    "preinstall": "npx only-allow npm"
+    "prepare": "npx husky"
   },
   "wireit": {
     "test": {
@@ -136,7 +135,7 @@
         "test:unit",
         "build:packages"
       ],
-      "command": "npm run test:int"
+      "command": "npm run test:exports && npm run test:int"
     },
     "kill-next": {
       "command": "ps aux | grep .next | grep -v grep | awk '{print $2}' | xargs kill -9 2>&1; exit 0"
@@ -304,7 +303,7 @@
       "command": "cd packages/example-react && npm run build"
     },
     "build": {
-      "command": "rollup -c rollup.config.js --bundleConfigAsCjs && npm run test:exports",
+      "command": "rollup -c rollup.config.js --bundleConfigAsCjs",
       "dependencies": [
         "cleanup"
       ]
@@ -386,6 +385,7 @@
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "lint-staged": "^15.2.9",
+    "only-allow": "^1.2.1",
     "playwright": "^1.45.3",
     "prettier": "^3.2.5",
     "prettier-plugin-tailwindcss": "^0.6.8",
@@ -399,7 +399,7 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3",
     "wait-on": "^8.0.1",
-    "wireit": "^0.14.9",
-    "zx": "^8.1.5"
-  }
+    "wireit": "^0.14.9"
+  },
+  "packageManager": "npm@10.8.2"
 }