Skip to content
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

Improve typings for condition operator #321

Merged
merged 2 commits into from
Feb 5, 2024
Merged

Improve typings for condition operator #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
648af81
feat(condition): simplify types
kireevmp Jan 17, 2024
f816e21
Merge branch 'main' into feat/condition-types
AlexandrHoroshih Feb 5, 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
142 changes: 71 additions & 71 deletions src/condition/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,91 +7,91 @@ import {
Store,
UnitTargetable,
split,
UnitValue,
EventCallable,
EventCallableAsReturnType,
} from 'effector';

type NoInfer<T> = T & { [K in keyof T]: T[K] };
type EventAsReturnType<Payload> = any extends Payload ? Event<Payload> : never;
type NoInfer<T> = [T][T extends any ? 0 : never];
type NonFalsy<T> = T extends null | undefined | false | 0 | 0n | '' ? never : T;

export function condition<State>(options: {
source: Event<State>;
if: ((payload: State) => boolean) | Store<boolean> | State;
then: UnitTargetable<NoInfer<State> | void>;
else: UnitTargetable<NoInfer<State> | void>;
}): EventAsReturnType<State>;
export function condition<State>(options: {
source: Store<State>;
if: ((payload: State) => boolean) | Store<boolean> | State;
then: UnitTargetable<State | void>;
else: UnitTargetable<State | void>;
}): Store<State>;
export function condition<Params, Done, Fail>(options: {
source: Effect<Params, Done, Fail>;
if: ((payload: Params) => boolean) | Store<boolean> | Params;
then: UnitTargetable<NoInfer<Params> | void>;
else: UnitTargetable<NoInfer<Params> | void>;
}): Effect<Params, Done, Fail>;
type SourceUnit<T> = Store<T> | Event<T> | Effect<T, any, any>;

export function condition<State>(options: {
source: Event<State>;
if: ((payload: State) => boolean) | Store<boolean> | State;
then: UnitTargetable<NoInfer<State> | void>;
}): EventAsReturnType<State>;
export function condition<State>(options: {
source: Store<State>;
if: ((payload: State) => boolean) | Store<boolean> | State;
then: UnitTargetable<NoInfer<State> | void>;
}): Store<State>;
export function condition<Params, Done, Fail>(options: {
source: Effect<Params, Done, Fail>;
if: ((payload: Params) => boolean) | Store<boolean> | Params;
then: UnitTargetable<NoInfer<Params> | void>;
}): Effect<Params, Done, Fail>;
// -- Without `source`, with type guard --
export function condition<Payload, Then extends Payload = Payload>(options: {
source?: undefined;
if: ((payload: Payload) => payload is Then) | Then;
then?: UnitTargetable<NoInfer<Then> | void>;
else?: UnitTargetable<Exclude<NoInfer<Payload>, Then> | void>;
}): EventCallableAsReturnType<Payload>;

export function condition<State>(options: {
source: Event<State>;
if: ((payload: State) => boolean) | Store<boolean> | State;
else: UnitTargetable<NoInfer<State> | void>;
}): EventAsReturnType<State>;
export function condition<State>(options: {
source: Store<State>;
if: ((payload: State) => boolean) | Store<boolean> | State;
else: UnitTargetable<NoInfer<State> | void>;
}): Store<State>;
export function condition<Params, Done, Fail>(options: {
source: Effect<Params, Done, Fail>;
if: ((payload: Params) => boolean) | Store<boolean> | Params;
else: UnitTargetable<NoInfer<Params> | void>;
}): Effect<Params, Done, Fail>;
// -- Without `source`, with BooleanConstructor --
export function condition<
Payload,
Then extends NonFalsy<Payload> = NonFalsy<Payload>,
>(options: {
source?: undefined;
if: BooleanConstructor;
then?: UnitTargetable<NoInfer<Then> | void>;
else?: UnitTargetable<Exclude<NoInfer<Payload>, Then> | void>;
}): EventCallableAsReturnType<Payload>;

// Without `source`
// -- Without `source` --
export function condition<Payload>(options: {
source?: undefined;
if: ((payload: Payload) => boolean) | Store<boolean> | NoInfer<Payload>;
then?: UnitTargetable<NoInfer<Payload> | void>;
else?: UnitTargetable<NoInfer<Payload> | void>;
}): EventCallableAsReturnType<Payload>;

export function condition<State>(options: {
if: ((payload: State) => boolean) | Store<boolean> | State;
then: UnitTargetable<NoInfer<State> | void>;
else: UnitTargetable<NoInfer<State> | void>;
}): EventCallable<State>;
export function condition<State>(options: {
if: ((payload: State) => boolean) | Store<boolean> | State;
then: UnitTargetable<NoInfer<State> | void>;
}): EventCallable<State>;
export function condition<State>(options: {
if: ((payload: State) => boolean) | Store<boolean> | State;
else: UnitTargetable<NoInfer<State> | void>;
}): EventCallable<State>;
export function condition<State>({
// -- With `source` and type guard --
export function condition<
Payload extends UnitValue<Source>,
Then extends Payload = Payload,
Source extends SourceUnit<any> = SourceUnit<Payload>,
>(options: {
source: Source;
if: ((payload: Payload) => payload is Then) | Then;
then?: UnitTargetable<NoInfer<Then>>;
else?: UnitTargetable<Exclude<NoInfer<Payload>, Then>>;
}): Source;

// -- With `source` and BooleanConstructor --
export function condition<
Payload extends UnitValue<Source>,
Then extends NonFalsy<Payload> = NonFalsy<Payload>,
Source extends SourceUnit<any> = SourceUnit<Payload>,
>(options: {
source: Source;
if: BooleanConstructor;
then?: UnitTargetable<NoInfer<Then> | void>;
else?: UnitTargetable<Exclude<NoInfer<Payload>, Then>>;
}): EventCallable<Payload>;

// -- With `source` --
export function condition<
Payload extends UnitValue<Source>,
Source extends SourceUnit<any> = SourceUnit<Payload>,
>(options: {
source: SourceUnit<Payload>;
if: ((payload: Payload) => boolean) | Store<boolean> | NoInfer<Payload>;
then?: UnitTargetable<NoInfer<Payload> | void>;
else?: UnitTargetable<NoInfer<Payload> | void>;
}): Source;

export function condition<Payload>({
source = createEvent<Payload>(),
if: test,
then: thenBranch,
else: elseBranch,
source = createEvent<State>(),
}: {
if: ((payload: State) => boolean) | Store<boolean> | State;
source?: Store<State> | Event<State> | Effect<State, any, any>;
then?: UnitTargetable<State | void>;
else?: UnitTargetable<State | void>;
source?: SourceUnit<Payload>;
if: ((payload: Payload) => boolean) | Store<boolean> | Payload;
then?: UnitTargetable<Payload | void>;
else?: UnitTargetable<Payload | void>;
}) {
const checker =
is.unit(test) || isFunction(test) ? test : (value: State) => value === test;
is.unit(test) || isFunction(test) ? test : (value: Payload) => value === test;

if (thenBranch && elseBranch) {
split({
Expand Down
131 changes: 127 additions & 4 deletions test-typings/condition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
createStore,
Effect,
Event,
EventCallable,
Store,
} from 'effector';
import { condition } from '../dist/condition';
Expand Down Expand Up @@ -220,25 +221,25 @@ import { condition } from '../dist/condition';
);
}

// Disallow pass invalid type to then/else
// Disallow pass invalid type to then/else/if
{
condition({
// @ts-expect-error
source: createStore(0),
if: 0,
// @ts-expect-error 'string' is not assignable to 'number | void'
then: createEvent<string>(),
});

condition({
// @ts-expect-error
source: createStore<boolean>(false),
// @ts-expect-error 'Console' is not assignable to `if`
if: console,
then: createEvent(),
});

condition({
// @ts-expect-error
source: createStore<string>(''),
// @ts-expect-error 'number' is not assignable to type 'boolean'
if: (a) => 1,
then: createEvent(),
});
Expand All @@ -259,3 +260,125 @@ import { condition } from '../dist/condition';
else: fxOtherVoid,
});
}

// allows nesting conditions
{
condition({
source: createEvent<'a' | 'b' | 1>(),
if: (value): value is 'a' | 'b' => typeof value === 'string',
then: condition<'a' | 'b'>({
if: () => true,
then: createEvent<'a'>(),
else: createEvent<'b'>(),
}),
});
}

// returns `typeof source` when source is provided
{
const source = createEvent<string | number>();

expectType<typeof source>(
condition({
source,
if: 'string?',
then: createEvent<void>(),
}),
);
}

// Correctly passes type to `if`
{
condition({
source: createEvent<string>(),
if: (payload) => (expectType<string>(payload), true),
then: createEvent<string>(),
});

condition({
source: createEvent<'complex' | 'type'>(),
if: (payload) => (expectType<'complex' | 'type'>(payload), true),
then: createEvent<void>(),
});

condition({
source: createEvent<string>(),
// @ts-expect-error 'string' is not assignable to type 'number'
if: (_: number) => true,
then: createEvent<void>(),
});
}

// `Boolean` as type guard: disallows invalid type in `then`
{
condition({
source: createEvent<string | null>(),
if: Boolean,
// @ts-expect-error 'number' is not assignable to type 'string | void'
then: createEvent<number>(),
});
}

// `Boolean` as type guard: disallows invalid type in then/else
{
condition({
source: createEvent<string | null>(),
if: Boolean,
// @ts-expect-error 'number' is not assignable to type 'string | void'
then: createEvent<number>(),
});

condition({
source: createEvent<string | null>(),
if: Boolean,
// @ts-expect-error 'number' is not assignable to type 'string | void'
else: createEvent<number>(),
});
}

// `Boolean` as type guard: works for all sources
{
expectType<EventCallable<string | null>>(
condition({
source: createEvent<string | null>(),
if: Boolean,
then: createEvent<string>(),
else: createEvent<null>(),
}),
);

expectType<EventCallable<string | null>>(
condition({
source: createStore<string | null>(null),
if: Boolean,
then: createEvent<string>(),
else: createEvent<null>(),
}),
);

expectType<EventCallable<string | null>>(
condition({
source: createEffect<string | null, void>(),
if: Boolean,
then: createEvent<string>(),
else: createEvent<null>(),
}),
);
}

// `Boolean` as type guard: disallows invalid type in then/else
{
condition({
source: createEvent<string | null>(),
if: Boolean,
// @ts-expect-error
then: createEvent<number>(),
});

condition({
source: createEvent<string | null>(),
if: Boolean,
// @ts-expect-error
else: createEvent<number>(),
});
}
Loading