Fix nested types output from createStrictAPI() being unintentionally marked as required #1604
Conversation
itsdouges
requested review from
JakeLane,
pancaspe87,
liamqma,
dddlr and
zerosicx
as code owners
🦋 Changeset detectedLatest commit: a99f3f3 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| @@ -5,6 +5,58 @@ import type { XCSSProp } from './__fixtures__/strict-api-recursive'; | |||
| import { css, cssMap } from './__fixtures__/strict-api-recursive'; | |||
|
|
|||
| describe('createStrictAPI()', () => { | |||
| it('should mark all styles as optional in css()', () => { | |||
| const styles = css({ | |||
| '&:hover': {}, | |||
There was a problem hiding this comment.
This was a type violation previously.
| : TObject[P] | ||
| type EnforceSchema<TSchema> = { | ||
| [P in keyof TSchema]?: P extends keyof CompiledSchema | ||
| ? TSchema[P] extends Record<string, any> |
There was a problem hiding this comment.
Fix: unknown -> any
There was a problem hiding this comment.
Interesting, do you know why this works? I've seen similar things, just never seen like a TS issue or explanation.
There was a problem hiding this comment.
I think it's an edge case with complex nested types (interface + omits + ?). At a glace unknown should be fine but in this case it's obviously not.
I'm not sure!
| @@ -98,15 +98,15 @@ export const visitCssMapPath = ( | |||
| const { sheets, classNames } = transformCssItems(css, meta); | |||
| totalSheets.push(...sheets); | |||
|
|
|||
| if (classNames.length !== 1) { | |||
| if (classNames.length > 1) { | |||
There was a problem hiding this comment.
This allows us to make empty styles now (at least for testing).
| : TObject[P] | ||
| type EnforceSchema<TSchema> = { | ||
| [P in keyof TSchema]?: P extends keyof CompiledSchema | ||
| ? TSchema[P] extends Record<string, any> |
There was a problem hiding this comment.
Interesting, do you know why this works? I've seen similar things, just never seen like a TS issue or explanation.
| throw buildCodeFrameError( | ||
| createErrorMessage(ErrorMessages.STATIC_VARIANT_OBJECT), | ||
| property, | ||
| meta.parentPath | ||
| ); | ||
| } | ||
|
|
||
| return t.objectProperty(property.key, classNames[0]); | ||
| return t.objectProperty(property.key, classNames[0] || t.stringLiteral('')); |
There was a problem hiding this comment.
Got it, so having '&:hover' empty threw this?
This pull request updates types and adds some tests for this specific use case.