@boxcustodia/library 2.0.0-alpha.10 → 2.0.0-alpha.12

package/src/utils/functions/createSafeContext.ts

@@ -0,0 +1,17 @@
+import React from "react";
+
+export const createSafeContext = <T>() => {
+  const context = React.createContext<T | null>(null);
+
+  const useContext = () => {
+    const contextValue = React.useContext(context);
+
+    if (contextValue === null) {
+      throw new Error("Context value is null");
+    }
+
+    return contextValue;
+  };
+
+  return [useContext, context.Provider] as const;
+};

package/src/utils/functions/ensureReactElement.tsx

@@ -0,0 +1,30 @@
+import React, { isValidElement, ReactElement, ReactNode } from "react";
+import { Renderable } from "@/models";
+
+type EnsureReactElementProps<P = {}> = {
+  children: Renderable<P>;
+  as?: React.ElementType;
+  props?: P;
+};
+
+export const ensureReactElement = <P,>({
+  children,
+  as: Wrapper = "div",
+  props,
+}: EnsureReactElementProps<P>): ReactElement => {
+  let childrenNode: ReactNode;
+
+  if (typeof children === "string") {
+    childrenNode = <Wrapper>{children}</Wrapper>;
+  } else if (isValidElement(children)) {
+    childrenNode = children;
+  } else if (typeof children === "function") {
+    childrenNode = children(props as P);
+  } else {
+    childrenNode = <Wrapper>{children}</Wrapper>;
+  }
+
+  if (isValidElement(childrenNode)) return childrenNode;
+
+  return <Wrapper>{childrenNode}</Wrapper>;
+};

package/src/utils/functions/getFormData.ts

@@ -0,0 +1,19 @@
+import { FormEvent } from "react";
+
+export const getFormData = (
+  event: FormEvent<HTMLFormElement>,
+): Record<string, string> => {
+  event.preventDefault();
+  const formElements = event.currentTarget
+    .elements as HTMLFormControlsCollection;
+  const data: Record<string, string> = {};
+
+  Array.from(formElements).forEach((element) => {
+    const input = element as HTMLInputElement;
+    if (input.name) {
+      data[input.name] = input.value;
+    }
+  });
+
+  return data;
+};

package/src/utils/functions/index.ts

@@ -0,0 +1,4 @@
+export * from "./createSafeContext";
+export * from "./ensureReactElement";
+export * from "./getFormData";
+export * from "./mergeRefs";

package/src/utils/functions/mergeRefs.ts

@@ -0,0 +1,18 @@
+import type * as React from "react";
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function mergeRefs<T = any>(
+  refs: Array<
+    React.MutableRefObject<T> | React.LegacyRef<T> | undefined | null
+  >,
+): React.RefCallback<T> {
+  return (value) => {
+    refs.forEach((ref) => {
+      if (typeof ref === "function") {
+        ref(value);
+      } else if (ref != null) {
+        (ref as React.MutableRefObject<T | null>).current = value;
+      }
+    });
+  };
+}

package/src/utils/index.ts

@@ -0,0 +1,3 @@
+export * from "./functions";
+export * from "./strings";
+export * from "./tests";

package/src/utils/strings/extractInitials.utility.ts

@@ -0,0 +1,10 @@
+/**
+ * Extracts the initials from a string.
+ * @param {string} string - The input string.
+ * @returns {string} The initials extracted from the input string.
+ */
+export const extractInitials = (string: string): string =>
+  string
+    .split(" ")
+    .map((word) => word.charAt(0))
+    .join("");

package/src/utils/strings/index.ts

@@ -0,0 +1 @@
+export * from "./extractInitials.utility";

package/src/utils/tests/click.ts

@@ -0,0 +1,3 @@
+import { act } from "@testing-library/react";
+
+export const click = (element: HTMLElement) => act(() => element.click());

package/src/utils/tests/index.ts

@@ -0,0 +1,2 @@
+export * from "./click";
+export * from "./type";

package/src/utils/tests/keyboard.ts

@@ -0,0 +1,21 @@
+import { act } from "@testing-library/react";
+
+type KeyboardEventOptions = {
+  key?: string;
+  ctrlKey?: boolean;
+  shiftKey?: boolean;
+  altKey?: boolean;
+  metaKey?: boolean;
+  [key: string]: any;
+};
+
+export const keyboard = (
+  element: EventTarget = document,
+  options: KeyboardEventOptions = { key: "a" },
+  eventName: "keydown" | "keypress" | "keyup" = "keydown",
+) => {
+  act(() => {
+    const event = new KeyboardEvent(eventName, options);
+    element.dispatchEvent(event);
+  });
+};

package/src/utils/tests/type.ts

@@ -0,0 +1,6 @@
+import { act, fireEvent } from "@testing-library/react";
+
+export const type = (element: HTMLElement, value: string) =>
+  act(() => {
+    fireEvent.change(element, { target: { value: value } });
+  });