Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "fix type for fragment keys",
"packageName": "@nova/react-test-utils",
"email": "stwilczy@microsoft.com",
"dependentChangeType": "patch"
}
2 changes: 1 addition & 1 deletion packages/nova-react-test-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"graphql": "^15.5.0",
"invariant": "^2.2.4",
"tslib": "^2.2.0",
"type-fest": "~2.19"
"type-fest": "^4.0.0"
},
"devDependencies": {
"@apollo/client": "^3.4.15",
Expand Down
2 changes: 2 additions & 0 deletions packages/nova-react-test-utils/src/shared/types.d-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,8 @@ interface PropsWithFragments {
user: MockFragmentKey;
regularProp: string;
optionalProp?: number;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
anyProp: any;
}

interface MockQuery extends OperationType {
Expand Down
42 changes: 25 additions & 17 deletions packages/nova-react-test-utils/src/shared/types.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import type { StoryObj } from "@storybook/react";
import type { Simplify, RequiredKeysOf } from "type-fest";
import type { Simplify, RequiredKeysOf, IfAny, SimplifyDeep } from "type-fest";
import type { ComponentType } from "react";

/**
* Utility type to extract the props of a React component.
*/
export type Props<Component> =
Component extends React.ComponentType<infer P> ? P : never;
Component extends ComponentType<infer P> ? P : never;

/**
* Utility type to return the keys of a component's props, where the value of the key is an object containing an optional " $data" property.
Expand All @@ -14,7 +15,11 @@ export type Props<Component> =
export type FragmentKeys<Component> =
Props<Component> extends infer P
? Required<{
[K in keyof P]: P[K] extends { " $data"?: unknown } ? K : never;
[K in keyof P]: IfAny<
P[K],
never,
P[K] extends { " $data"?: unknown } ? K : never
>;
}>[keyof P]
: never;

Expand Down Expand Up @@ -55,13 +60,12 @@ type OptionalArgs<T> = T extends { args?: infer A }

// Omits Z from the Storybook "args" field of T
type OmitFromArgs<T, Z> = Omit<T, "args"> &
Simplify<
SimplifyDeep<
(Record<string, never> extends Omit<RequiredArgs<T>, keyof Z>
? { args?: Omit<RequiredArgs<T>, keyof Z> }
: { args: Omit<RequiredArgs<T>, keyof Z> }) & {
args?: Omit<OptionalArgs<T>, keyof Z>;
},
{ deep: true }
}
>;

// Check if keys of T are a subset of keys of P. Returns true if they are or union of keys that are not.
Expand Down Expand Up @@ -89,19 +93,23 @@ export type ValidatedReferenceEntries<
TComponent,
TQuery extends { response: unknown },
> =
TComponent extends React.ComponentType<any>
// The any here is important, changing to unknown or never would break inferring component
// eslint-disable-next-line @typescript-eslint/no-explicit-any
TComponent extends ComponentType<any>
? FragmentKeys<TComponent> extends never
? Record<string, (queryResult: TQuery["response"]) => unknown>
: // Fragment keys must have correct type, other keys can be anything
Simplify<{
[K in FragmentKeys<TComponent>]: (
queryResult: TQuery["response"],
) => FragmentKeyType<TComponent, K> | null | undefined;
} & {
[K in Exclude<string, FragmentKeys<TComponent>>]?: (
queryResult: TQuery["response"],
) => unknown;
}>
Simplify<
{
[K in FragmentKeys<TComponent>]: (
queryResult: TQuery["response"],
) => FragmentKeyType<TComponent, K> | null | undefined;
} & {
[K in Exclude<string, FragmentKeys<TComponent>>]?: (
queryResult: TQuery["response"],
) => unknown;
}
>
: Record<string, (queryResult: TQuery["response"]) => unknown>;

export type StoryObjWithoutFragmentRefs<T> = T extends {
Expand All @@ -112,7 +120,7 @@ export type StoryObjWithoutFragmentRefs<T> = T extends {
};
};
}
? C extends React.ComponentType<infer P extends object>
? C extends ComponentType<infer P extends object>
? AreKeysSubset<D, P> extends true
? OmitFromArgs<StoryObj<T>, D>
: ReferenceEntriesError<AreKeysSubset<D, P>>
Expand Down
8 changes: 4 additions & 4 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -6310,10 +6310,10 @@ type-fest@^0.21.3:
resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37"
integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==

type-fest@~2.19:
version "2.19.0"
resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-2.19.0.tgz#88068015bb33036a598b952e55e9311a60fd3a9b"
integrity sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==
type-fest@^4.0.0:
version "4.41.0"
resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-4.41.0.tgz#6ae1c8e5731273c2bf1f58ad39cbae2c91a46c58"
integrity sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==

type@^1.0.1:
version "1.2.0"
Expand Down