@oruga-ui/oruga-next/src/types/utils.ts

UI components for Vue.js and CSS framework agnostic

import type { Component, EmitsToProps } from "vue";
import type { ComponentEmit } from "vue-component-type-helpers";

export type Numberish = number | string;

/**
 * Function to define a class binding.
 * @param suffix - a component class suffix
 * @param props - the component props
 * @returns a class binding or undefined if no class should be applied
 */
export type ClassFunction = (
    suffix: string,
    props: Record<string, any>,
) => ClassBinding | ClassBinding[] | undefined;

/** Vue native type for a class attribute */
export type ClassBinding = string | { [x: string]: boolean };

/** Vue native dynamic component 'is' property value type */
export type DynamicComponent = string | object | CallableFunction | Component;

/** Define a property as required */
export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };

/** Remove generic <[x: string]: any> index signature structure from type */
export type RemoveIndex<T> = {
    [K in keyof T as string extends K
        ? never
        : number extends K
          ? never
          : symbol extends K
            ? never
            : K]: T[K];
};

/** Custom type helper which extracts the `$emits` type of an component and converts it to an props object. */
export type ComponentEmits<C> = EmitsToProps<ComponentEmit<C>>;

/** Extracts the type of property `K` in object `T`. */
type TypeOfKey<T, K extends string> = K extends keyof T ? T[K] : unknown;

/**
 * Extracts the type of a deep property `K` within an object `T`.
 * Property `K` can be defined as a property path with `.` seperator.
 */
export type DeepType<T, K> = T extends object
    ? K extends string
        ? K extends `${infer F}.${infer R}`
            ? DeepType<TypeOfKey<T, F>, R>
            : TypeOfKey<T, K>
        : T
    : T;

/**
 * Defines a list of property paths for each property and deep property of an object `T`.
 * @source https://dev.to/pffigueiredo/typescript-utility-keyof-nested-object-2pa3
 */
export type DeepKeys<T> =
    | (T extends object
          ? {
                [K in keyof T]-?: K extends string | number
                    ? Required<T>[K] extends object
                        ? `${K}` | `${K}.${DeepKeys<T[K]>}`
                        : `${K}`
                    : never;
            }[keyof T & string]
          : never)
    | (keyof T & string);