Publish block editor build types

[noahtallen]

What?

Publishes block editor build types. (This package is a lot bigger, and I think the types published are going to be pretty helpful.)

Why?

See #49647

How?

Testing Instructions

• npm run build:package-types
• check types at packages/block-editor/build-types

[noahtallen]

Currently down to just a couple errors:

Incorrect published types for /Users/noahallen/source/gutenberg/packages/block-editor/build-types/index.d.ts:
 packages/block-editor/build-types/components/block-list/use-block-props/index.d.ts(21,14): error TS2552: Cannot find name 'getBlockProps'. Did you mean 'useBlockProps'?
packages/block-editor/build-types/components/inner-blocks/index.d.ts(29,14): error TS2552: Cannot find name 'getInnerBlocksProps'. Did you mean 'useInnerBlocksProps'?

These are a little tricky. Any suggestions? This the source code for one of those errors, but they are both the same:

gutenberg/packages/block-editor/src/components/inner-blocks/index.js

Lines 12 to 16 in fff6d81

	import {
	getBlockSupport,
	store as blocksStore,
	__unstableGetInnerBlocksProps as getInnerBlocksProps,
	} from '@wordpress/blocks';

gutenberg/packages/block-editor/src/components/inner-blocks/index.js

Line 243 in fff6d81

useInnerBlocksProps.save = getInnerBlocksProps;

[noahtallen]

Basically all the issues in block-editor were just that we weren't importing types like this.

[noahtallen]

this appears to be unused but was causing an error

[noahtallen]

temporary fix so that I could see other type errors. (This will be solved by #49960)

[adamziel]

Cc @johnhooks

[johnhooks]

@noahtallen I have two PRs that could be helpful in typing the block editor.

• feature: add TypeScript types to the blocks package #48604 - It's a pretty huge PR and I need some help wrapping it up and finding support to get it merge it. But it would be a great improvement and help improve the types of the block editor. There are going to be lots of issues to resolve before we could enable checkJs because the code wasn't written with types in mind, but the exported types great for packages that depend on @wordpress/blocks.
• feature(data): add types to dispatch and select #49930 - This could help if you are using dispatch and select to access the block editor store.

Also, I'm very willing to help type the block editor, just point me in the right direction.

[noahtallen]

Very nice! My goal with this is to basically let us publish types without requiring checkJs. I added a script in #49736 which helps us avoid publishing any errors.

After discussion with @dmsnell, @tyxla, and @adamziel, my thought process is that we still get a ton of value by publishing what we can, even if it’s inferred from JSDoc. It’s hard to maintain DT, and if we publish here, we can remove that from the equation. Then, we can continue improving types (which is the hardest part!) until checkJs could be enabled! So the published types gradually get better and better — but we still get a lot out of the box (like full types for the store, which is harder to do in DT!)

I think the only thing blocking this PR now is the error I mentioned above.

but I’ll also take a look at those PRs!

[noahtallen]

Deviations from DT are probably the biggest unknown. In some packages, I don’t think this is a big enough issue to block things. Maybe that’s different since block editor is so big 🤔

[tyxla]

Currently down to just a couple errors:

Incorrect published types for /Users/noahallen/source/gutenberg/packages/block-editor/build-types/index.d.ts:
 packages/block-editor/build-types/components/block-list/use-block-props/index.d.ts(21,14): error TS2552: Cannot find name 'getBlockProps'. Did you mean 'useBlockProps'?
packages/block-editor/build-types/components/inner-blocks/index.d.ts(29,14): error TS2552: Cannot find name 'getInnerBlocksProps'. Did you mean 'useInnerBlocksProps'?

These are a little tricky. Any suggestions? This the source code for one of those errors, but they are both the same:

gutenberg/packages/block-editor/src/components/inner-blocks/index.js

Lines 12 to 16 in fff6d81

	import {
	getBlockSupport,
	store as blocksStore,
	__unstableGetInnerBlocksProps as getInnerBlocksProps,
	} from '@wordpress/blocks';

gutenberg/packages/block-editor/src/components/inner-blocks/index.js

Line 243 in fff6d81

useInnerBlocksProps.save = getInnerBlocksProps;

I haven't spent a bunch of time on this one, but it might mean that we might need to publish types for the @wordpress/blocks package first.

[johnhooks]

I'll try merging this into a fork of #48604 and see if it helps.

Edit:

@tyxla you were right the issue was @wordpress/blocks not being typed. Merging this PR with #48604 worked. I had to make a few adjustments because we removed the WP prefix from the types exported from the @wordpress/blocks package.

[tyxla]

Thanks for verifying @johnhooks! Seems like we should land those PRs in a sequence.

Besides the memize update, is there anything else that is blocking #48604?

[johnhooks]

@tyxla I'm currently reviewing the entire PR, I hope to have it cleaned up by the end of the week.

I was also attempting to type the internals of the package, though this will be an on going process. Should I leave those changes or remove them and save it for later, concentrating on just providing exported types?

[tyxla]

Sounds great, thanks @johnhooks!

I was also attempting to type the internals of the package, though this will be an on going process. Should I leave those changes or remove them and save it for later, concentrating on just providing exported types?

My suggestion would be to leave the internals for another time and focus on the exported types. That can also be a good way to split the work into more bearable and easy-to-grok and easy-to-land pieces.