@modern-kit/utils/dist/_chunk/index.d-BYSArY.d.ts

modern-kit/utils

/**
 * @description 주어진 객체 타입의 실제 유효한 프로퍼티 경로를 점(.)으로 구분하여 문자열로 반환합니다.
 * 옵셔널 프로퍼티라면 옵셔널 체이닝(?)을 포함하며, 중첩된 객체의 경우 모든 깊이의 경로가 유니온 타입으로 표현됩니다.
 *
 * @note PropertyAllPath와 다음과 같은 차이점이 있습니다:
 * - 깊이 제한 (10레벨)
 * - 실제 옵셔널 프로퍼티에만 옵셔널 경로 포함
 *
 * @template T - 대상 객체 타입
 *
 * @example
 * PropertyPath<{ a: { b: { c: 1 } } }> // 'a' | 'a.b' | 'a.b.c'
 *
 * @example
 * PropertyPath<{ a: { b?: { c: 1 } } }> // 'a' | 'a.b' | 'a.b?.c'
 */
type PropertyPath<T, Limit extends unknown[] = []> = Limit['length'] extends 10 ? never : {
    [K in keyof T & string]: T[K] extends Record<PropertyKey, unknown> | undefined ? K | (T[K] extends Record<PropertyKey, unknown> ? `${K}.${PropertyPath<T[K], [...Limit, unknown]>}` : `${K}?.${PropertyPath<NonNullable<T[K]>, [
        ...Limit,
        unknown
    ]>}`) : K;
}[keyof T & string];

/**
 * @description 주어진 객체 타입에서 지정된 경로에 해당하는 값의 타입을 반환합니다.
 * `점 표기법(dot notation)`을 사용하여 중첩된 객체 속성 타입에 접근할 수 있습니다.
 *
 * 주어진 객체 타입에 옵셔널 키가 있는 경우, `옵셔널(?) 경로`로 접근해야 합니다. 옵셔널 경로로 접근하는 경우, undefined를 타입에 포함하여 반환합니다.
 *
 * `isUndefinable` 파라미터를 `true`로 설정하면, undefined를 타입에 포함하여 반환합니다.
 *
 * @template T - 조회하고자 하는 객체 타입
 * @template P - 점 표기법으로 표현된 프로퍼티 경로 타입
 * @template isUndefinable - 경로에 해당하는 값이 존재하지 않을 경우 undefined를 반환할지 여부
 *
 * @example
 * GetByPath<{ a: { b: { c: 1 } } }, 'a'> // { b: { c: 1 } }
 * GetByPath<{ a: { b: { c: 1 } } }, 'a.b'> // { c: 1 }
 * GetByPath<{ a: { b: { c: 1 } } }, 'a.b.c'> // 1
 *
 * @example
 * // 옵셔널 프로퍼티 사용 케이스
 * GetByPath<{ a: { b?: { c: 1 } } }, 'a.b?.c'> // 1 | undefined
 *
 * @example
 * // isUndefinable 사용 케이스
 * GetByPath<{ a: { b: { c: 1 } } }, 'a.b.c', true> // 1 | undefined
 */
type GetByPath<T extends Record<PropertyKey, unknown>, P extends PropertyPath<T>, isUndefinable extends boolean = false> = P extends `${infer LeftPath}.${infer RightPath}` ? LeftPath extends `${infer OptionalLeft}?` ? NonNullable<T[OptionalLeft]> extends Record<PropertyKey, unknown> ? GetByPath<NonNullable<T[OptionalLeft]>, RightPath, true> : never : T[LeftPath] extends Record<PropertyKey, unknown> ? GetByPath<T[LeftPath], RightPath, isUndefinable> : never : isUndefinable extends false ? T[P] : T[P] | undefined;

export type { GetByPath as G, PropertyPath as P };