state-in-url 3.0.5 → 3.0.7

package/README.CN.md

@@ -22,7 +22,7 @@
 
 ![演示-gif](https://github.com/asmyshlyaev177/state-in-url/assets/19854148/c9802601-4d42-4362-b3e4-37ff87c3b97f)
 
-<a href="https://state-in-url-asmyshlyaev177.vercel.app/" target="_blank">演示</a> |
+<a href="https://state-in-url.dev/" target="_blank">演示</a> |
 <a href="https://state-in-url.netlify.app/" target="_blank">DEMO2</a> |
 
 <hr />

package/README.KO.md

@@ -26,7 +26,7 @@
 ![데모-gif](https://github.com/asmyshlyaev177/state-in-url/assets/19854148/c9802601-4d42-4362-b3e4-37ff87c3b97f)
 
 
-<a href="https://state-in-url-asmyshlyaev177.vercel.app/" target="_blank">데모</a> |
+<a href="https://state-in-url.dev" target="_blank">데모</a> |
 <a href="https://state-in-url.netlify.app/" target="_blank">DEMO2</a> |
 
 

package/README.md

@@ -23,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">
@@ -32,13 +31,15 @@ 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.dev" target="_blank">DEMO</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)
@@ -118,6 +119,8 @@ Possibly need to set `"module": "ES2022"`, or `"module": "ESNext"`
 
 [Docs](packages/urlstate/next/useUrlState#api)
 
+[React-Router example](#useurlstate-hook-for-react-router)
+
 ### Usage examples
 
 #### Basic
@@ -176,6 +179,9 @@ function MyComponent() {
 
 #### With complex state shape
 
+<details>
+  <Summary>Example</Summary>
+  
 ```typescript
 export const form: Form = {
   name: '',
@@ -190,7 +196,6 @@ type Form = {
   'agree to terms': boolean;
   tags: { id: string; value: { text: string; time: Date } }[];
 };
-
 ```
 
 ```typescript
@@ -250,10 +255,16 @@ const tags = [
 ```
 
 [Demo page example code](https://github.com/asmyshlyaev177/state-in-url/blob/master/packages/example-nextjs14/src/app/Form.tsx)
+</details>
+
 
 #### Auto sync state
 
-```typescript
+<details>
+  <Summary>Example</Summary>
+
+  ```typescript
+  
   const timer = React.useRef(0 as unknown as NodeJS.Timeout);
   React.useEffect(() => {
     clearTimeout(timer.current);
@@ -274,8 +285,15 @@ Syncing state `onBlur` will be more aligned with real world usage.
 <input onBlur={() => updateUrl()} .../>
 ```
 
+</details>
+
+
+
 #### With server side rendering
 
+<details>
+  <Summary>Example</Summary>
+  
 ```typescript
 export default async function Home({ searchParams }: { searchParams: object }) {
   return (
@@ -294,9 +312,13 @@ const Form = ({ searchParams }: { searchParams: object }) => {
 }
 ```
 
+</details>
+
 #### Using hook in `layout` component
 
-That a tricky part, since nextjs with app router doesn't allow to access searchParams from server side. There is workaround with using middleware, but it isn't pretty and can stop working after nextjs update.
+<details>
+  <Summary>Example</Summary>
+  That a tricky part, since nextjs with app router doesn't allow to access searchParams from server side. There is workaround with using middleware, but it isn't pretty and can stop working after nextjs update.
 
 ```typescript
 // add to appropriate `layout.tsc`
@@ -340,9 +362,13 @@ export default async function Layout({
 
 
 ```
+</details>
 
 #### With arbitrary state shape (not recommended)
 
+<details>
+  <Summary>Example</Summary>
+
 ```typescript
 'use client'
 import { useUrlState } from 'state-in-url/next';
@@ -353,6 +379,9 @@ function SettingsComponent() {
   const { state, updateUrl, updateState } = useUrlState<object>(someObj);
 }
 ```
+</details>
+
+
 
 ## useUrlState hook for React-Router
 
@@ -512,6 +541,8 @@ This project is licensed under the [MIT license](LICENSE).
 
 ## Inspiration
 
+[NUQS](https://github.com/47ng/nuqs)
+
 [Using URL to store state in Vue](https://dev.to/jacobandrewsky/using-url-to-store-state-in-vue-275c)
 
 [Storing state in the URL](https://antonz.org/storing-state/)

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "state-in-url",
-  "version": "3.0.5",
+  "version": "3.0.7",
   "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",
+  "homepage": "https://state-in-url.dev",
   "keywords": [
     "front-end",
     "state-management",
@@ -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"
 }