apiyaml/src/commands/make_docs/scripts/templates/_useFnCommon.ts

api generator

import {ReactNode, useEffect, useMemo, useRef} from "react";
// @ts-ignore
import {ConfigurationParameters} from "../";
import {forEach, isEqual, set} from "lodash";

// types
export type Unpacked<T> =
    T extends (infer U)[] ? U :
        T extends (...args: never[]) => infer U ? U :
            T;

export interface ApiConfigOptions {
    useCachedValue?: boolean;
}

export interface ApiConfigParamsProps {
    apiConfigParams?: ConfigurationParameters;
    apiConfigOptions?: ApiConfigOptions;
}

//helpers
export function errorToast(msg: string | Error, description?: string | ReactNode) {
    try {
        import("sonner").then(({toast}) => {
            if (msg instanceof Error)
                msg = msg.message;

            toast.error(msg, {
                description,
                position: "bottom-center",
                duration: 3000,
            });
            console.error(msg, description);
        });
    } catch (e: unknown) {
    }
}

export function usePrevious(value: unknown) {
    // create a new reference
    const ref = useRef<typeof value>(null);

    // store current value in ref
    useEffect(() => {
        ref.current = value;
    }, [value]); // only re-run if value changes

    // return previous value (happens before update in useEffect above)
    return ref.current;
}

export function logDev(...value: unknown[]) {
    if (process.env.NEXT_PUBLIC_APP_ENV === "development") {
        console.log(...value);
    }
}

export function trimDataOnStream(text: string): string {
    text = text.trim();
    if (text.startsWith("data:")) {
        text = text.replace("data:", "");
    }
    return text;
}

export function useDeepCompareMemo(factory: any, dependencies: any[]) {
    const dependenciesRef = useRef<any[]>([]);

    if (!isEqual(dependenciesRef.current, dependencies)) {
        dependenciesRef.current = dependencies;
    }

    return useMemo(factory, dependenciesRef.current) as any;
}

/* transform dotKeyObject to RawObject
example:
const sourceObject = {
  'user.name': 'barney',
  'user.age': 40,
  'active': true
};
->TO
{
    "user": {
        "name": "barney",
        "age": 40
    },
    "active": true
}
* */

export function transformDotKeyObjectToRawObject(source: any) {

    // 1. Create an empty object for the result.
    const result = {};

    // 2. Iterate over the source object.
    forEach(source, (value, key) => {
        // 3. For each key-value pair, use _.set to place it in the result object.
        //    Lodash will parse the dot-notation key as a path.
        set(result, key, value);
    });
    return result;
}