react-simplikit 0.0.2 → 0.0.4

package/esm/utils/buildContext/index.d.mts

@@ -0,0 +1,38 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+type ProviderProps<ContextValuesType> = (ContextValuesType & {
+    children: ReactNode;
+}) | {
+    children: ReactNode;
+};
+/**
+ * @description
+ * `buildContext` is a helper function that reduces repetitive code when defining React Context.
+ *
+ * @param contextName - The name of the context.
+ * @param defaultContextValues - The default values to be passed to the context.
+ *
+ * @returns A tuple of the form [Provider, useContext]:
+ * - `Provider`: The component that provides the context.
+ * - `useContext`: The hook that uses the context.
+ *
+ * @example
+ * const [Provider, useContext] = buildContext<{ title: string }>('TestContext', null);
+ *
+ * function Inner() {
+ *   const { title } = useContext();
+ *   return <div>{title}</div>;
+ * }
+ *
+ * function Page() {
+ *   return (
+ *     <Provider title="Hello">
+ *       <Inner />
+ *     </Provider>
+ *   );
+ * }
+ */
+declare function buildContext<ContextValuesType extends object>(contextName: string, defaultContextValues?: ContextValuesType): readonly [({ children, ...contextValues }: ProviderProps<ContextValuesType>) => react_jsx_runtime.JSX.Element, () => ContextValuesType];
+
+export { buildContext };

package/esm/utils/buildContext/index.mjs

@@ -0,0 +1,28 @@
+// src/utils/buildContext/buildContext.tsx
+import { createContext, useContext, useMemo } from "react";
+import { jsx } from "react/jsx-runtime";
+function buildContext(contextName, defaultContextValues) {
+  const Context = createContext(defaultContextValues ?? void 0);
+  function Provider({ children, ...contextValues }) {
+    const value = useMemo(
+      () => Object.keys(contextValues).length > 0 ? contextValues : null,
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+      [...Object.values(contextValues)]
+    );
+    return /* @__PURE__ */ jsx(Context.Provider, { value, children });
+  }
+  function useInnerContext() {
+    const context = useContext(Context);
+    if (context != null) {
+      return context;
+    }
+    if (defaultContextValues != null) {
+      return defaultContextValues;
+    }
+    throw new Error(`\`${contextName}Context\` must be used within \`${contextName}Provider\``);
+  }
+  return [Provider, useInnerContext];
+}
+export {
+  buildContext
+};

package/esm/utils/mergeRefs/index.d.mts

@@ -0,0 +1,37 @@
+import { RefObject, RefCallback } from 'react';
+
+/**
+ * @description
+ * This function takes multiple refs (RefObject or RefCallback) and returns a single ref that updates all provided refs.
+ * It's useful when you need to pass multiple refs to a single element.
+ *
+ * @param refs - An array of refs to be merged. Each ref can be either a RefObject or RefCallback.
+ *
+ * @returns A single ref callback that updates all provided refs.
+ *
+ * @example
+ * forwardRef(function Component(props, parentRef) {
+ *   const myRef = useRef(null);
+ *
+ *   return <div ref={mergeRefs(myRef, parentRef)} />;
+ * })
+ *
+ * @example
+ * function Component(props) {
+ *   const ref = useRef(null);
+ *   const [height, setHeight] = useState(0);
+ *
+ *   const measuredRef = useCallback(node => {
+ *     if(node == null) {
+ *       return;
+ *     }
+ *
+ *     setHeight(node.offsetHeight);
+ *   }, []);
+ *
+ *   return <div ref={mergeRefs(measuredRef, ref)} />;
+ * }
+ */
+declare function mergeRefs<T>(...refs: Array<RefObject<T> | RefCallback<T> | null | undefined>): RefCallback<T>;
+
+export { mergeRefs };

package/esm/utils/mergeRefs/index.mjs

@@ -0,0 +1,18 @@
+// src/utils/mergeRefs/mergeRefs.ts
+function mergeRefs(...refs) {
+  return (value) => {
+    for (const ref of refs) {
+      if (ref == null) {
+        continue;
+      }
+      if (typeof ref === "function") {
+        ref(value);
+        continue;
+      }
+      ref.current = value;
+    }
+  };
+}
+export {
+  mergeRefs
+};

package/package.json

@@ -1,11 +1,91 @@
 {
   "name": "react-simplikit",
-  "version": "0.0.2",
-  "description": "",
-  "main": "index.js",
+  "version": "0.0.4",
+  "main": "./dist/index.js",
+  "sideEffects": false,
+  "files": [
+    "dist/**/*",
+    "esm/**/*"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "docs:gen": "tsx .scripts/index.ts generate-docs",
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "prettier:fix": "prettier --write .",
+    "test": "vitest run",
+    "test:coverage": "yarn vitest run --coverage",
+    "prepack": "tsup"
   },
-  "author": "",
-  "license": "ISC"
-}
+  "publishConfig": {
+    "access": "public",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "module": "./esm/index.mjs",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "import": "./esm/index.mjs",
+        "require": "./dist/index.js"
+      },
+      "./package.json": "./package.json"
+    }
+  },
+  "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",
+    "@trivago/prettier-plugin-sort-imports": "^5.2.0",
+    "@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",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "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",
+    "vitest": "^2.1.8",
+    "vue": "^3.5.13"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-dom": "*"
+  },
+  "packageManager": "yarn@4.5.3",
+  "module": "./esm/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./esm/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.ts"
+}