@os-design/use-forwarded-state 1.0.21 → 1.0.23

package/dist/{types/index.d.ts → index.d.ts}

@@ -1,4 +1,4 @@
-import { Dispatch, SetStateAction } from 'react';
+import { type Dispatch, type SetStateAction } from 'react';
 interface UseForwardedStateProps<T> {
     value?: T;
     defaultValue?: T | (() => T);

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,cAAc,EAMpB,MAAM,OAAO,CAAC;AAEf,UAAU,sBAAsB,CAAC,CAAC;IAChC,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CAC/B;AAMD,QAAA,MAAM,iBAAiB,GAAI,CAAC,sCAIzB,sBAAsB,CAAC,CAAC,CAAC,KAAG,CAC7B,CAAC,GAAG,SAAS,EACb,QAAQ,CAAC,cAAc,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CA4BxC,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/{esm/index.js → index.js}

@@ -1,5 +1,4 @@
 import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
-// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types
 const isFunction = value => typeof value === 'function';
 const useForwardedState = ({
   value,
@@ -20,5 +19,4 @@ const useForwardedState = ({
   }, [forwardedValue, shouldUseInnerValue]);
   return [forwardedValue, setForwardedValue];
 };
-export default useForwardedState;
-//# sourceMappingURL=index.js.map
+export default useForwardedState;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@os-design/use-forwarded-state",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "license": "UNLICENSED",
   "repository": "git@gitlab.com:os-team/libs/os-design.git",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "react-native": "src/index.ts",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "react-native": "./src/index.ts",
   "files": [
     "dist",
     "src",
@@ -21,9 +21,8 @@
   "sideEffects": false,
   "scripts": {
     "clean": "rimraf dist",
-    "build:esm": "cross-env BABEL_ENV=esm babel src --root-mode upward --extensions .ts,.tsx --out-dir dist/esm --source-maps",
-    "build:cjs": "cross-env BABEL_ENV=cjs babel src --root-mode upward --extensions .ts,.tsx --out-dir dist/cjs --source-maps",
-    "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist/types",
+    "build:esm": "cross-env BABEL_ENV=esm babel src --root-mode upward --extensions .ts,.tsx --out-dir dist",
+    "build:types": "tsc -p tsconfig.build.json --emitDeclarationOnly --declaration --declarationDir dist",
     "build": "yarn clean && npm-run-all 'build:*'",
     "ncu": "ncu -u"
   },
@@ -33,5 +32,5 @@
   "peerDependencies": {
     "react": ">=18"
   },
-  "gitHead": "6b63f712ae05bd98c00f59b868ac782f3475dc99"
+  "gitHead": "86a83e87297a07afe132782ca2c95023b7139276"
 }

package/src/index.mdx

@@ -0,0 +1,54 @@
+import { Meta } from '@storybook/blocks';
+import UseForwardedStateExample from './index.example';
+
+<Meta title='Utils/useForwardedState' />
+
+# useForwardedState
+
+Uses the inner state if the passed value is undefined.
+
+## Example of usage
+
+```tsx
+import React, { forwardRef } from 'react';
+import { Button } from '@os-design/core';
+import { useForwardedState } from '@os-design/utils';
+
+type JsxInputProps = Omit<
+  JSX.IntrinsicElements['input'],
+  'value' | 'defaultValue' | 'onChange' | 'ref'
+>;
+interface InputProps extends JsxInputProps {
+  value?: string;
+  defaultValue?: string | (() => string);
+  onChange?: (value: string) => void;
+}
+
+const UseForwardedStateExample = forwardRef<HTMLInputElement, InputProps>(
+  ({ value, defaultValue, onChange, ...rest }, ref) => {
+    const [forwardedValue, setForwardedValue] = useForwardedState({
+      value,
+      defaultValue,
+      onChange,
+    });
+
+    return (
+      <>
+        <p>
+          <input
+            value={forwardedValue}
+            onChange={(e) => setForwardedValue(e.target.value)}
+            {...rest}
+            ref={ref}
+          />
+        </p>
+        <Button onClick={() => setForwardedValue('')}>Clear</Button>
+      </>
+    );
+  }
+);
+
+export default UseForwardedStateExample;
+```
+
+<UseForwardedStateExample />

package/src/index.ts

@@ -1,6 +1,6 @@
 import {
-  Dispatch,
-  SetStateAction,
+  type Dispatch,
+  type SetStateAction,
   useCallback,
   useEffect,
   useMemo,
@@ -14,9 +14,9 @@ interface UseForwardedStateProps<T> {
   onChange?: (value: T) => void;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types
-const isFunction = (value: any): value is Function =>
-  typeof value === 'function';
+const isFunction = <T>(
+  value: SetStateAction<T>
+): value is (prevState: T) => T => typeof value === 'function';
 
 const useForwardedState = <T>({
   value,

package/dist/cjs/index.js

@@ -1,45 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-var _react = require("react");
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
-function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i["return"] && (_r = _i["return"](), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types
-var isFunction = function isFunction(value) {
-  return typeof value === 'function';
-};
-var useForwardedState = function useForwardedState(_ref) {
-  var value = _ref.value,
-    defaultValue = _ref.defaultValue,
-    onChange = _ref.onChange;
-  var _useState = (0, _react.useState)(defaultValue),
-    _useState2 = _slicedToArray(_useState, 2),
-    innerValue = _useState2[0],
-    setInnerValue = _useState2[1];
-  var onChangeRef = (0, _react.useRef)(onChange);
-  (0, _react.useEffect)(function () {
-    onChangeRef.current = onChange;
-  }, [onChange]);
-  var shouldUseInnerValue = (0, _react.useMemo)(function () {
-    return value === undefined;
-  }, [value]);
-  var forwardedValue = (0, _react.useMemo)(function () {
-    return shouldUseInnerValue ? innerValue : value;
-  }, [shouldUseInnerValue, innerValue, value]);
-  var setForwardedValue = (0, _react.useCallback)(function (v) {
-    var nextValue = isFunction(v) ? v(forwardedValue) : v;
-    if (shouldUseInnerValue) setInnerValue(nextValue);
-    if (onChangeRef.current && nextValue !== undefined) onChangeRef.current(nextValue);
-  }, [forwardedValue, shouldUseInnerValue]);
-  return [forwardedValue, setForwardedValue];
-};
-var _default = useForwardedState;
-exports["default"] = _default;
-//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":["_react","require","_slicedToArray","arr","i","_arrayWithHoles","_iterableToArrayLimit","_unsupportedIterableToArray","_nonIterableRest","TypeError","o","minLen","_arrayLikeToArray","n","Object","prototype","toString","call","slice","constructor","name","Array","from","test","len","length","arr2","_i","Symbol","iterator","_s","_e","_x","_r","_arr","_n","_d","next","done","push","value","err","isArray","isFunction","useForwardedState","_ref","defaultValue","onChange","_useState","useState","_useState2","innerValue","setInnerValue","onChangeRef","useRef","useEffect","current","shouldUseInnerValue","useMemo","undefined","forwardedValue","setForwardedValue","useCallback","v","nextValue","_default","exports"],"sources":["../../src/index.ts"],"sourcesContent":["import {\n  Dispatch,\n  SetStateAction,\n  useCallback,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n} from 'react';\n\ninterface UseForwardedStateProps<T> {\n  value?: T;\n  defaultValue?: T | (() => T);\n  onChange?: (value: T) => void;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types\nconst isFunction = (value: any): value is Function =>\n  typeof value === 'function';\n\nconst useForwardedState = <T>({\n  value,\n  defaultValue,\n  onChange,\n}: UseForwardedStateProps<T>): [\n  T | undefined,\n  Dispatch<SetStateAction<T | undefined>>,\n] => {\n  const [innerValue, setInnerValue] = useState(defaultValue);\n  const onChangeRef = useRef(onChange);\n\n  useEffect(() => {\n    onChangeRef.current = onChange;\n  }, [onChange]);\n\n  const shouldUseInnerValue = useMemo(() => value === undefined, [value]);\n  const forwardedValue = useMemo(\n    () => (shouldUseInnerValue ? innerValue : value),\n    [shouldUseInnerValue, innerValue, value]\n  );\n\n  const setForwardedValue = useCallback<\n    Dispatch<SetStateAction<T | undefined>>\n  >(\n    (v) => {\n      const nextValue = isFunction(v) ? v(forwardedValue) : v;\n      if (shouldUseInnerValue) setInnerValue(nextValue);\n      if (onChangeRef.current && nextValue !== undefined)\n        onChangeRef.current(nextValue);\n    },\n    [forwardedValue, shouldUseInnerValue]\n  );\n\n  return [forwardedValue, setForwardedValue];\n};\n\nexport default useForwardedState;\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAQe,SAAAC,eAAAC,GAAA,EAAAC,CAAA,WAAAC,eAAA,CAAAF,GAAA,KAAAG,qBAAA,CAAAH,GAAA,EAAAC,CAAA,KAAAG,2BAAA,CAAAJ,GAAA,EAAAC,CAAA,KAAAI,gBAAA;AAAA,SAAAA,iBAAA,cAAAC,SAAA;AAAA,SAAAF,4BAAAG,CAAA,EAAAC,MAAA,SAAAD,CAAA,qBAAAA,CAAA,sBAAAE,iBAAA,CAAAF,CAAA,EAAAC,MAAA,OAAAE,CAAA,GAAAC,MAAA,CAAAC,SAAA,CAAAC,QAAA,CAAAC,IAAA,CAAAP,CAAA,EAAAQ,KAAA,aAAAL,CAAA,iBAAAH,CAAA,CAAAS,WAAA,EAAAN,CAAA,GAAAH,CAAA,CAAAS,WAAA,CAAAC,IAAA,MAAAP,CAAA,cAAAA,CAAA,mBAAAQ,KAAA,CAAAC,IAAA,CAAAZ,CAAA,OAAAG,CAAA,+DAAAU,IAAA,CAAAV,CAAA,UAAAD,iBAAA,CAAAF,CAAA,EAAAC,MAAA;AAAA,SAAAC,kBAAAT,GAAA,EAAAqB,GAAA,QAAAA,GAAA,YAAAA,GAAA,GAAArB,GAAA,CAAAsB,MAAA,EAAAD,GAAA,GAAArB,GAAA,CAAAsB,MAAA,WAAArB,CAAA,MAAAsB,IAAA,OAAAL,KAAA,CAAAG,GAAA,GAAApB,CAAA,GAAAoB,GAAA,EAAApB,CAAA,IAAAsB,IAAA,CAAAtB,CAAA,IAAAD,GAAA,CAAAC,CAAA,UAAAsB,IAAA;AAAA,SAAApB,sBAAAH,GAAA,EAAAC,CAAA,QAAAuB,EAAA,WAAAxB,GAAA,gCAAAyB,MAAA,IAAAzB,GAAA,CAAAyB,MAAA,CAAAC,QAAA,KAAA1B,GAAA,4BAAAwB,EAAA,QAAAG,EAAA,EAAAC,EAAA,EAAAC,EAAA,EAAAC,EAAA,EAAAC,IAAA,OAAAC,EAAA,OAAAC,EAAA,iBAAAJ,EAAA,IAAAL,EAAA,GAAAA,EAAA,CAAAV,IAAA,CAAAd,GAAA,GAAAkC,IAAA,QAAAjC,CAAA,QAAAU,MAAA,CAAAa,EAAA,MAAAA,EAAA,UAAAQ,EAAA,uBAAAA,EAAA,IAAAL,EAAA,GAAAE,EAAA,CAAAf,IAAA,CAAAU,EAAA,GAAAW,IAAA,MAAAJ,IAAA,CAAAK,IAAA,CAAAT,EAAA,CAAAU,KAAA,GAAAN,IAAA,CAAAT,MAAA,KAAArB,CAAA,GAAA+B,EAAA,iBAAAM,GAAA,IAAAL,EAAA,OAAAL,EAAA,GAAAU,GAAA,yBAAAN,EAAA,YAAAR,EAAA,eAAAM,EAAA,GAAAN,EAAA,cAAAb,MAAA,CAAAmB,EAAA,MAAAA,EAAA,2BAAAG,EAAA,QAAAL,EAAA,aAAAG,IAAA;AAAA,SAAA7B,gBAAAF,GAAA,QAAAkB,KAAA,CAAAqB,OAAA,CAAAvC,GAAA,UAAAA,GAAA;AAQf;AACA,IAAMwC,UAAU,GAAG,SAAbA,UAAUA,CAAIH,KAAU;EAAA,OAC5B,OAAOA,KAAK,KAAK,UAAU;AAAA;AAE7B,IAAMI,iBAAiB,GAAG,SAApBA,iBAAiBA,CAAAC,IAAA,EAOlB;EAAA,IANHL,KAAK,GAAAK,IAAA,CAALL,KAAK;IACLM,YAAY,GAAAD,IAAA,CAAZC,YAAY;IACZC,QAAQ,GAAAF,IAAA,CAARE,QAAQ;EAKR,IAAAC,SAAA,GAAoC,IAAAC,eAAQ,EAACH,YAAY,CAAC;IAAAI,UAAA,GAAAhD,cAAA,CAAA8C,SAAA;IAAnDG,UAAU,GAAAD,UAAA;IAAEE,aAAa,GAAAF,UAAA;EAChC,IAAMG,WAAW,GAAG,IAAAC,aAAM,EAACP,QAAQ,CAAC;EAEpC,IAAAQ,gBAAS,EAAC,YAAM;IACdF,WAAW,CAACG,OAAO,GAAGT,QAAQ;EAChC,CAAC,EAAE,CAACA,QAAQ,CAAC,CAAC;EAEd,IAAMU,mBAAmB,GAAG,IAAAC,cAAO,EAAC;IAAA,OAAMlB,KAAK,KAAKmB,SAAS;EAAA,GAAE,CAACnB,KAAK,CAAC,CAAC;EACvE,IAAMoB,cAAc,GAAG,IAAAF,cAAO,EAC5B;IAAA,OAAOD,mBAAmB,GAAGN,UAAU,GAAGX,KAAK;EAAA,CAAC,EAChD,CAACiB,mBAAmB,EAAEN,UAAU,EAAEX,KAAK,CACzC,CAAC;EAED,IAAMqB,iBAAiB,GAAG,IAAAC,kBAAW,EAGnC,UAACC,CAAC,EAAK;IACL,IAAMC,SAAS,GAAGrB,UAAU,CAACoB,CAAC,CAAC,GAAGA,CAAC,CAACH,cAAc,CAAC,GAAGG,CAAC;IACvD,IAAIN,mBAAmB,EAAEL,aAAa,CAACY,SAAS,CAAC;IACjD,IAAIX,WAAW,CAACG,OAAO,IAAIQ,SAAS,KAAKL,SAAS,EAChDN,WAAW,CAACG,OAAO,CAACQ,SAAS,CAAC;EAClC,CAAC,EACD,CAACJ,cAAc,EAAEH,mBAAmB,CACtC,CAAC;EAED,OAAO,CAACG,cAAc,EAAEC,iBAAiB,CAAC;AAC5C,CAAC;AAAC,IAAAI,QAAA,GAEarB,iBAAiB;AAAAsB,OAAA,cAAAD,QAAA"}

package/dist/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":["useCallback","useEffect","useMemo","useRef","useState","isFunction","value","useForwardedState","defaultValue","onChange","innerValue","setInnerValue","onChangeRef","current","shouldUseInnerValue","undefined","forwardedValue","setForwardedValue","v","nextValue"],"sources":["../../src/index.ts"],"sourcesContent":["import {\n  Dispatch,\n  SetStateAction,\n  useCallback,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n} from 'react';\n\ninterface UseForwardedStateProps<T> {\n  value?: T;\n  defaultValue?: T | (() => T);\n  onChange?: (value: T) => void;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types\nconst isFunction = (value: any): value is Function =>\n  typeof value === 'function';\n\nconst useForwardedState = <T>({\n  value,\n  defaultValue,\n  onChange,\n}: UseForwardedStateProps<T>): [\n  T | undefined,\n  Dispatch<SetStateAction<T | undefined>>,\n] => {\n  const [innerValue, setInnerValue] = useState(defaultValue);\n  const onChangeRef = useRef(onChange);\n\n  useEffect(() => {\n    onChangeRef.current = onChange;\n  }, [onChange]);\n\n  const shouldUseInnerValue = useMemo(() => value === undefined, [value]);\n  const forwardedValue = useMemo(\n    () => (shouldUseInnerValue ? innerValue : value),\n    [shouldUseInnerValue, innerValue, value]\n  );\n\n  const setForwardedValue = useCallback<\n    Dispatch<SetStateAction<T | undefined>>\n  >(\n    (v) => {\n      const nextValue = isFunction(v) ? v(forwardedValue) : v;\n      if (shouldUseInnerValue) setInnerValue(nextValue);\n      if (onChangeRef.current && nextValue !== undefined)\n        onChangeRef.current(nextValue);\n    },\n    [forwardedValue, shouldUseInnerValue]\n  );\n\n  return [forwardedValue, setForwardedValue];\n};\n\nexport default useForwardedState;\n"],"mappings":"AAAA,SAGEA,WAAW,EACXC,SAAS,EACTC,OAAO,EACPC,MAAM,EACNC,QAAQ,QACH,OAAO;AAQd;AACA,MAAMC,UAAU,GAAIC,KAAU,IAC5B,OAAOA,KAAK,KAAK,UAAU;AAE7B,MAAMC,iBAAiB,GAAGA,CAAI;EAC5BD,KAAK;EACLE,YAAY;EACZC;AACyB,CAAC,KAGvB;EACH,MAAM,CAACC,UAAU,EAAEC,aAAa,CAAC,GAAGP,QAAQ,CAACI,YAAY,CAAC;EAC1D,MAAMI,WAAW,GAAGT,MAAM,CAACM,QAAQ,CAAC;EAEpCR,SAAS,CAAC,MAAM;IACdW,WAAW,CAACC,OAAO,GAAGJ,QAAQ;EAChC,CAAC,EAAE,CAACA,QAAQ,CAAC,CAAC;EAEd,MAAMK,mBAAmB,GAAGZ,OAAO,CAAC,MAAMI,KAAK,KAAKS,SAAS,EAAE,CAACT,KAAK,CAAC,CAAC;EACvE,MAAMU,cAAc,GAAGd,OAAO,CAC5B,MAAOY,mBAAmB,GAAGJ,UAAU,GAAGJ,KAAM,EAChD,CAACQ,mBAAmB,EAAEJ,UAAU,EAAEJ,KAAK,CACzC,CAAC;EAED,MAAMW,iBAAiB,GAAGjB,WAAW,CAGlCkB,CAAC,IAAK;IACL,MAAMC,SAAS,GAAGd,UAAU,CAACa,CAAC,CAAC,GAAGA,CAAC,CAACF,cAAc,CAAC,GAAGE,CAAC;IACvD,IAAIJ,mBAAmB,EAAEH,aAAa,CAACQ,SAAS,CAAC;IACjD,IAAIP,WAAW,CAACC,OAAO,IAAIM,SAAS,KAAKJ,SAAS,EAChDH,WAAW,CAACC,OAAO,CAACM,SAAS,CAAC;EAClC,CAAC,EACD,CAACH,cAAc,EAAEF,mBAAmB,CACtC,CAAC;EAED,OAAO,CAACE,cAAc,EAAEC,iBAAiB,CAAC;AAC5C,CAAC;AAED,eAAeV,iBAAiB"}

package/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,cAAc,EAMf,MAAM,OAAO,CAAC;AAEf,UAAU,sBAAsB,CAAC,CAAC;IAChC,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CAC/B;AAMD,QAAA,MAAM,iBAAiB,gIAkCtB,CAAC;AAEF,eAAe,iBAAiB,CAAC"}