react-simplikit 0.0.3 → 0.0.4

package/dist/components/ImpressionArea/index.d.ts

@@ -28,8 +28,6 @@ type Props<Tag extends ElementType> = React__default.ComponentPropsWithoutRef<Ta
  * @returns {JSX.Element} A React component that tracks the visibility of its child elements.
  *
  * @example
- * import { ImpressionArea } from 'react-simplikit';
- *
  * function App() {
  *   return (
  *     <ImpressionArea
@@ -38,7 +36,7 @@ type Props<Tag extends ElementType> = React__default.ComponentPropsWithoutRef<Ta
  *       timeThreshold={1000}
  *       areaThreshold={0.5}
  *     >
- *       <div>Track my visibility!</div>
+ *       <div>Track me!</div>
  *     </ImpressionArea>
  *   );
  * }

package/dist/hooks/useAsyncEffect/index.d.ts

@@ -16,9 +16,9 @@ import { DependencyList } from 'react';
  *   setData(data);
  *
  *   return () => {
- *     console.log('Cleanup on unmount or dependency change');
+ *     console.log('Cleanup on unmount or dependencies change');
  *   };
- * }, [dependency]);
+ * }, [dependencies]);
  */
 declare function useAsyncEffect(effect: () => Promise<void | (() => void)>, deps?: DependencyList): void;
 

package/dist/hooks/useBooleanState/index.d.ts

@@ -5,11 +5,11 @@
  *
  * @param {boolean} [defaultValue=false] - The initial value of the state. Defaults to `false`.
  *
- * @returns {readonly [boolean, () => void, () => void, () => void]} A tuple containing:
- * - `boolean` - The current state value.
- * - `() => void` - A function to set the state to `true`.
- * - `() => void` - A function to set the state to `false`.
- * - `() => void` - A function to toggle the state.
+ * @returns {readonly [state: boolean, setTrue: () => void, setFalse: () => void, toggle: () => void]} A tuple containing:
+ * - state `boolean` - The current state value.
+ * - setTrue `() => void` - A function to set the state to `true`.
+ * - setFalse `() => void` - A function to set the state to `false`.
+ * - toggle `() => void` - A function to toggle the state.
  *
  * @example
  * const [open, openBottomSheet, closeBottomSheet, toggleBottomSheet] = useBooleanState(false);

package/dist/hooks/{useCallbackOnce → useCallbackOncePerRender}/index.d.ts

@@ -12,10 +12,10 @@ import { DependencyList } from 'react';
  * @returns {(...args: any[]) => void} A memoized function that will only execute once until dependencies change.
  *
  * @example
- * import { useCallbackOnce } from 'react-simplikit';
+ * import { useCallbackOncePerRender } from 'react-simplikit';
  *
  * function Component() {
- *   const handleOneTimeEvent = useCallbackOnce(() => {
+ *   const handleOneTimeEvent = useCallbackOncePerRender(() => {
  *     console.log('This will only run once');
  *   }, []);
  *
@@ -25,7 +25,7 @@ import { DependencyList } from 'react';
  * @example
  * // With dependencies
  * function TrackingComponent({ userId }: { userId: string }) {
- *   const trackUserVisit = useCallbackOnce(() => {
+ *   const trackUserVisit = useCallbackOncePerRender(() => {
  *     analytics.trackVisit(userId);
  *   }, [userId]);
  *
@@ -36,6 +36,6 @@ import { DependencyList } from 'react';
  *   return <div>User page</div>;
  * }
  */
-declare function useCallbackOnce<F extends (...args: any[]) => void>(callback: F, deps: DependencyList): (...args: Parameters<F>) => void;
+declare function useCallbackOncePerRender<F extends (...args: any[]) => void>(callback: F, deps: DependencyList): (...args: Parameters<F>) => void;
 
-export { useCallbackOnce };
+export { useCallbackOncePerRender };

package/dist/hooks/{useCallbackOnce → useCallbackOncePerRender}/index.js

@@ -17,14 +17,14 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/hooks/useCallbackOnce/index.ts
-var useCallbackOnce_exports = {};
-__export(useCallbackOnce_exports, {
-  useCallbackOnce: () => useCallbackOnce
+// src/hooks/useCallbackOncePerRender/index.ts
+var useCallbackOncePerRender_exports = {};
+__export(useCallbackOncePerRender_exports, {
+  useCallbackOncePerRender: () => useCallbackOncePerRender
 });
-module.exports = __toCommonJS(useCallbackOnce_exports);
+module.exports = __toCommonJS(useCallbackOncePerRender_exports);
 
-// src/hooks/useCallbackOnce/useCallbackOnce.ts
+// src/hooks/useCallbackOncePerRender/useCallbackOncePerRender.ts
 var import_react2 = require("react");
 
 // src/hooks/usePreservedCallback/usePreservedCallback.ts
@@ -39,8 +39,8 @@ function usePreservedCallback(callback) {
   }, []);
 }
 
-// src/hooks/useCallbackOnce/useCallbackOnce.ts
-function useCallbackOnce(callback, deps) {
+// src/hooks/useCallbackOncePerRender/useCallbackOncePerRender.ts
+function useCallbackOncePerRender(callback, deps) {
   const hasFired = (0, import_react2.useRef)(false);
   (0, import_react2.useEffect)(() => {
     hasFired.current = false;
@@ -55,5 +55,5 @@ function useCallbackOnce(callback, deps) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  useCallbackOnce
+  useCallbackOncePerRender
 });

package/dist/hooks/useDebounce/index.d.ts

@@ -12,9 +12,10 @@ type DebounceOptions = {
  * `useDebounce` is a React hook that returns a debounced version of the provided callback function.
  * It helps optimize event handling by delaying function execution and grouping multiple calls into one.
  *
+ * @template {(...args: unknown[]) => unknown} F - The type of the callback function.
  * @param {F} callback - The function to debounce.
  * @param {number} wait - The number of milliseconds to delay the function execution.
- * @param {object} [options] - Configuration options for debounce behavior.
+ * @param {DebounceOptions} [options] - Configuration options for debounce behavior.
  * @param {boolean} [options.leading=false] - If `true`, the function is called at the start of the sequence.
  * @param {boolean} [options.trailing=true] - If `true`, the function is called at the end of the sequence.
  *

package/dist/hooks/useInputState/index.d.ts

@@ -4,13 +4,13 @@ import { ChangeEventHandler } from 'react';
  * @description
  * `useInputState` is a React hook that manages an input state with optional value transformation.
  *
- * @param {string} initialValue - The initial value of the input. Defaults to an empty string (`""`).
- * @param {(value: string) => string} [transformValue] - A function to transform the input value.
+ * @param {string} [initialValue=""] - The initial value of the input. Defaults to an empty string (`""`).
+ * @param {(value: string) => string} [transformValue=(v: string) => v] - A function to transform the input value.
  *   Defaults to an identity function that returns the input unchanged.
  *
- * @returns {readonly [string, (value: string) => void]} A tuple containing:
- * - `string` - The current state value.
- * - `(value: string) => void` - A function to update the state.
+ * @returns {readonly [value: string, onChange: (value: string) => void]} A tuple containing:
+ * - value `string` - The current state value.
+ * - onChange `(value: string) => void` - A function to update the state.
  *
  * @example
  * import { useInputState } from 'react-simplikit';

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { Separated } from './components/Separated/index.js';
 export { SwitchCase } from './components/SwitchCase/index.js';
 export { useAsyncEffect } from './hooks/useAsyncEffect/index.js';
 export { useBooleanState } from './hooks/useBooleanState/index.js';
-export { useCallbackOnce } from './hooks/useCallbackOnce/index.js';
+export { useCallbackOncePerRender } from './hooks/useCallbackOncePerRender/index.js';
 export { useDebounce } from './hooks/useDebounce/index.js';
 export { useImpressionRef } from './hooks/useImpressionRef/index.js';
 export { useInputState } from './hooks/useInputState/index.js';

package/dist/index.js

@@ -27,7 +27,7 @@ __export(index_exports, {
   mergeRefs: () => mergeRefs,
   useAsyncEffect: () => useAsyncEffect,
   useBooleanState: () => useBooleanState,
-  useCallbackOnce: () => useCallbackOnce,
+  useCallbackOncePerRender: () => useCallbackOncePerRender,
   useDebounce: () => useDebounce,
   useImpressionRef: () => useImpressionRef,
   useInputState: () => useInputState,
@@ -341,9 +341,9 @@ var useBooleanState = (defaultValue = false) => {
   return [bool, setTrue, setFalse, toggle2];
 };
 
-// src/hooks/useCallbackOnce/useCallbackOnce.ts
+// src/hooks/useCallbackOncePerRender/useCallbackOncePerRender.ts
 var import_react10 = require("react");
-function useCallbackOnce(callback, deps) {
+function useCallbackOncePerRender(callback, deps) {
   const hasFired = (0, import_react10.useRef)(false);
   (0, import_react10.useEffect)(() => {
     hasFired.current = false;
@@ -741,7 +741,7 @@ function buildContext(contextName, defaultContextValues) {
   mergeRefs,
   useAsyncEffect,
   useBooleanState,
-  useCallbackOnce,
+  useCallbackOncePerRender,
   useDebounce,
   useImpressionRef,
   useInputState,

package/esm/components/ImpressionArea/index.d.mts

@@ -28,8 +28,6 @@ type Props<Tag extends ElementType> = React__default.ComponentPropsWithoutRef<Ta
  * @returns {JSX.Element} A React component that tracks the visibility of its child elements.
  *
  * @example
- * import { ImpressionArea } from 'react-simplikit';
- *
  * function App() {
  *   return (
  *     <ImpressionArea
@@ -38,7 +36,7 @@ type Props<Tag extends ElementType> = React__default.ComponentPropsWithoutRef<Ta
  *       timeThreshold={1000}
  *       areaThreshold={0.5}
  *     >
- *       <div>Track my visibility!</div>
+ *       <div>Track me!</div>
  *     </ImpressionArea>
  *   );
  * }

package/esm/hooks/useAsyncEffect/index.d.mts

@@ -16,9 +16,9 @@ import { DependencyList } from 'react';
  *   setData(data);
  *
  *   return () => {
- *     console.log('Cleanup on unmount or dependency change');
+ *     console.log('Cleanup on unmount or dependencies change');
  *   };
- * }, [dependency]);
+ * }, [dependencies]);
  */
 declare function useAsyncEffect(effect: () => Promise<void | (() => void)>, deps?: DependencyList): void;
 

package/esm/hooks/useBooleanState/index.d.mts

@@ -5,11 +5,11 @@
  *
  * @param {boolean} [defaultValue=false] - The initial value of the state. Defaults to `false`.
  *
- * @returns {readonly [boolean, () => void, () => void, () => void]} A tuple containing:
- * - `boolean` - The current state value.
- * - `() => void` - A function to set the state to `true`.
- * - `() => void` - A function to set the state to `false`.
- * - `() => void` - A function to toggle the state.
+ * @returns {readonly [state: boolean, setTrue: () => void, setFalse: () => void, toggle: () => void]} A tuple containing:
+ * - state `boolean` - The current state value.
+ * - setTrue `() => void` - A function to set the state to `true`.
+ * - setFalse `() => void` - A function to set the state to `false`.
+ * - toggle `() => void` - A function to toggle the state.
  *
  * @example
  * const [open, openBottomSheet, closeBottomSheet, toggleBottomSheet] = useBooleanState(false);

package/esm/hooks/{useCallbackOnce → useCallbackOncePerRender}/index.d.mts

@@ -12,10 +12,10 @@ import { DependencyList } from 'react';
  * @returns {(...args: any[]) => void} A memoized function that will only execute once until dependencies change.
  *
  * @example
- * import { useCallbackOnce } from 'react-simplikit';
+ * import { useCallbackOncePerRender } from 'react-simplikit';
  *
  * function Component() {
- *   const handleOneTimeEvent = useCallbackOnce(() => {
+ *   const handleOneTimeEvent = useCallbackOncePerRender(() => {
  *     console.log('This will only run once');
  *   }, []);
  *
@@ -25,7 +25,7 @@ import { DependencyList } from 'react';
  * @example
  * // With dependencies
  * function TrackingComponent({ userId }: { userId: string }) {
- *   const trackUserVisit = useCallbackOnce(() => {
+ *   const trackUserVisit = useCallbackOncePerRender(() => {
  *     analytics.trackVisit(userId);
  *   }, [userId]);
  *
@@ -36,6 +36,6 @@ import { DependencyList } from 'react';
  *   return <div>User page</div>;
  * }
  */
-declare function useCallbackOnce<F extends (...args: any[]) => void>(callback: F, deps: DependencyList): (...args: Parameters<F>) => void;
+declare function useCallbackOncePerRender<F extends (...args: any[]) => void>(callback: F, deps: DependencyList): (...args: Parameters<F>) => void;
 
-export { useCallbackOnce };
+export { useCallbackOncePerRender };

package/esm/hooks/{useCallbackOnce → useCallbackOncePerRender}/index.mjs

@@ -1,4 +1,4 @@
-// src/hooks/useCallbackOnce/useCallbackOnce.ts
+// src/hooks/useCallbackOncePerRender/useCallbackOncePerRender.ts
 import { useEffect as useEffect2, useRef as useRef2 } from "react";
 
 // src/hooks/usePreservedCallback/usePreservedCallback.ts
@@ -13,8 +13,8 @@ function usePreservedCallback(callback) {
   }, []);
 }
 
-// src/hooks/useCallbackOnce/useCallbackOnce.ts
-function useCallbackOnce(callback, deps) {
+// src/hooks/useCallbackOncePerRender/useCallbackOncePerRender.ts
+function useCallbackOncePerRender(callback, deps) {
   const hasFired = useRef2(false);
   useEffect2(() => {
     hasFired.current = false;
@@ -28,5 +28,5 @@ function useCallbackOnce(callback, deps) {
   });
 }
 export {
-  useCallbackOnce
+  useCallbackOncePerRender
 };

package/esm/hooks/useDebounce/index.d.mts

@@ -12,9 +12,10 @@ type DebounceOptions = {
  * `useDebounce` is a React hook that returns a debounced version of the provided callback function.
  * It helps optimize event handling by delaying function execution and grouping multiple calls into one.
  *
+ * @template {(...args: unknown[]) => unknown} F - The type of the callback function.
  * @param {F} callback - The function to debounce.
  * @param {number} wait - The number of milliseconds to delay the function execution.
- * @param {object} [options] - Configuration options for debounce behavior.
+ * @param {DebounceOptions} [options] - Configuration options for debounce behavior.
  * @param {boolean} [options.leading=false] - If `true`, the function is called at the start of the sequence.
  * @param {boolean} [options.trailing=true] - If `true`, the function is called at the end of the sequence.
  *

package/esm/hooks/useInputState/index.d.mts

@@ -4,13 +4,13 @@ import { ChangeEventHandler } from 'react';
  * @description
  * `useInputState` is a React hook that manages an input state with optional value transformation.
  *
- * @param {string} initialValue - The initial value of the input. Defaults to an empty string (`""`).
- * @param {(value: string) => string} [transformValue] - A function to transform the input value.
+ * @param {string} [initialValue=""] - The initial value of the input. Defaults to an empty string (`""`).
+ * @param {(value: string) => string} [transformValue=(v: string) => v] - A function to transform the input value.
  *   Defaults to an identity function that returns the input unchanged.
  *
- * @returns {readonly [string, (value: string) => void]} A tuple containing:
- * - `string` - The current state value.
- * - `(value: string) => void` - A function to update the state.
+ * @returns {readonly [value: string, onChange: (value: string) => void]} A tuple containing:
+ * - value `string` - The current state value.
+ * - onChange `(value: string) => void` - A function to update the state.
  *
  * @example
  * import { useInputState } from 'react-simplikit';

package/esm/index.d.mts

@@ -3,7 +3,7 @@ export { Separated } from './components/Separated/index.mjs';
 export { SwitchCase } from './components/SwitchCase/index.mjs';
 export { useAsyncEffect } from './hooks/useAsyncEffect/index.mjs';
 export { useBooleanState } from './hooks/useBooleanState/index.mjs';
-export { useCallbackOnce } from './hooks/useCallbackOnce/index.mjs';
+export { useCallbackOncePerRender } from './hooks/useCallbackOncePerRender/index.mjs';
 export { useDebounce } from './hooks/useDebounce/index.mjs';
 export { useImpressionRef } from './hooks/useImpressionRef/index.mjs';
 export { useInputState } from './hooks/useInputState/index.mjs';

package/esm/index.mjs

@@ -292,9 +292,9 @@ var useBooleanState = (defaultValue = false) => {
   return [bool, setTrue, setFalse, toggle2];
 };
 
-// src/hooks/useCallbackOnce/useCallbackOnce.ts
+// src/hooks/useCallbackOncePerRender/useCallbackOncePerRender.ts
 import { useEffect as useEffect5, useRef as useRef5 } from "react";
-function useCallbackOnce(callback, deps) {
+function useCallbackOncePerRender(callback, deps) {
   const hasFired = useRef5(false);
   useEffect5(() => {
     hasFired.current = false;
@@ -691,7 +691,7 @@ export {
   mergeRefs,
   useAsyncEffect,
   useBooleanState,
-  useCallbackOnce,
+  useCallbackOncePerRender,
   useDebounce,
   useImpressionRef,
   useInputState,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-simplikit",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "main": "./dist/index.js",
   "sideEffects": false,
   "files": [
@@ -8,6 +8,7 @@
     "esm/**/*"
   ],
   "scripts": {
+    "docs:gen": "tsx .scripts/index.ts generate-docs",
     "docs:dev": "vitepress dev",
     "docs:build": "vitepress build",
     "docs:preview": "vitepress preview",
@@ -34,6 +35,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.16.0",
+    "@openai/openai": "npm:@jsr/openai__openai@^4.93.0",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.1.0",
@@ -41,7 +43,10 @@
     "@types/node": "^22.10.2",
     "@types/react": "^19.0.7",
     "@vitest/coverage-v8": "^2.1.8",
+    "commander": "^13.1.0",
+    "comment-parser": "^1.4.1",
     "corepack": "^0.30.0",
+    "dotenv": "^16.4.7",
     "esbuild": "^0.24.0",
     "eslint": "^9.16.0",
     "eslint-config-prettier": "^9.1.0",
@@ -54,11 +59,14 @@
     "fast-glob": "^3.3.3",
     "globals": "^15.13.0",
     "jsdom": "^25.0.1",
+    "listr2": "^8.2.5",
+    "ora": "^8.2.0",
     "prettier": "^3.4.2",
     "prettier-plugin-sort-re-exports": "^0.1.0",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
     "tsup": "^8.3.5",
+    "tsx": "^4.19.2",
     "typescript": "^5.7.2",
     "typescript-eslint": "^8.18.0",
     "vitepress": "^1.5.0",