Skip to content

handled case of assets union #3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 8, 2024
Merged

handled case of assets union #3060

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e9a6bc
handled case of assets union
nitzanyiz May 7, 2024
de47810
added docs to the types
nitzanyiz May 8, 2024
b45698d
fixed typing
nitzanyiz May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/assets/Assets.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import _ from 'lodash';
import {PathRecord} from '..//typings/common';
import type {AssetRecord} from '../typings/assets';

interface CustomObject {
[key: string]: any;
Expand Down Expand Up @@ -42,7 +42,8 @@ function ensurePath(obj: CustomObject, path: string) {
export class Assets {
[key: string]: any;

loadAssetsGroup<T extends string, K extends object>(groupName: T, assets: K): asserts this is PathRecord<T, K> {
loadAssetsGroup<T extends string, K extends object>(groupName: T,
assets: K): asserts this is AssetRecord<T, K, typeof this> {
if (!_.isString(groupName)) {
throw new Error('group name should be a string');
}
Expand Down
22 changes: 22 additions & 0 deletions src/typings/assets.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
type DotExtendedString<T extends string> = `${T}.`;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I reviewed this again, this time more thoroughly..
Since the TS utils are pretty complicated to understand at first glance I'd suggest to make them more readable.

  1. I'd change params names like T and K to something with more meaning..
    for example, maybe change this AssetRecord<T extends string, K extends object = {}, This extends object> to AssetRecord<PATH extends string, ASSETS extends object = {}, ASSETS_CLASS extends object>
  2. Let's add a short description above the complicated utils of what exactly they do. If we'll have to investigate an issue in the future it can be very useful
  3. RecRecord util's name is not so clear, can you think of a better name?

type PathArray<S extends string> =
DotExtendedString<S> extends `${infer A}.${infer B}` ? (A extends '' ? [] : [A, ...PathArray<B>]) : [];

type RecRecord<Path extends string[], K extends object = {}> = Path extends [infer Next, ...infer Rest]
? {[P in Next]: RecRecord<Rest, K>}
: K;

type DeepGet<K extends object, T extends string> = _DeepGet<K, PathArray<T>>;

type _DeepGet<K extends object, T extends Array<string>> = T extends [infer First, ...infer Rest]
? First extends keyof K
? _DeepGet<K[First], Rest>
: never
: K;

type PathRecord<T extends string, K = {}> = RecRecord<PathArray<T>, K>;

export type AssetRecord<T extends string, K extends object = {}, This extends object> = PathRecord<
T,
DeepGet<This, T> extends never ? K : DeepGet<This, T> & K
>;
11 changes: 0 additions & 11 deletions src/typings/common.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,3 @@ export type ExtendTypeWith<T extends Constructor<any>, OtherObject extends objec
export type Dictionary<TYPE> = {[key: string]: TYPE};

export type ComponentStatics<T> = Pick<T, keyof T>;

type DotExtendedString<T extends string> = `${T}.`;
export type PathArray<S extends string> = DotExtendedString<S> extends `${infer A}.${infer B}` ?
A extends '' ? [] : [A, ...PathArray<B>]
: [];

export type RecRecord<Path extends string[], K = {}> = Path extends [infer Next, ...infer Rest] ?
{[P in Next] : RecRecord<Rest, K>}
: K;

export type PathRecord<T extends string, K = {}> = RecRecord<PathArray<T>, K>;