Skip to content

Commit 543c8b0

Browse files
🤖 Merge PR DefinitelyTyped#74574 [@wordpress/block-editor] Updated the types to match how WordPress actually returns things by @joshualip-plaudit
1 parent f76d480 commit 543c8b0

2 files changed

Lines changed: 125 additions & 132 deletions

File tree

‎types/wordpress__block-editor/index.d.ts‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ declare module "@wordpress/data" {
1616
* @deprecated Use the version that takes a store descriptor object instead
1717
*/
1818
function select(key: "core/block-editor"): typeof import("./store/selectors");
19-
20-
function useDispatch(key: "core/block-editor"): typeof import("./store/actions");
21-
function useSelect(key: "core/block-editor"): typeof import("./store/selectors");
2219
}
2320

2421
type Decurry<S extends { [key: string]: (...args: any[]) => any }> = {

‎types/wordpress__block-editor/wordpress__block-editor-tests.tsx‎

Lines changed: 125 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -488,117 +488,115 @@ be.transformStyles(STYLES, ".foobar");
488488
// $ExpectType BlockEditorStoreDescriptor
489489
be.store;
490490

491-
for (const dispatchOrUseDispatch of [dispatch, useDispatch]) {
492-
// $ExpectType void
493-
dispatchOrUseDispatch("core/block-editor").insertBlock(BLOCK_INSTANCE);
494-
dispatchOrUseDispatch("core/block-editor").insertBlock(BLOCK_INSTANCE, 4);
495-
dispatchOrUseDispatch("core/block-editor").insertBlock(BLOCK_INSTANCE, 4, "foo");
496-
dispatchOrUseDispatch("core/block-editor").insertBlock(BLOCK_INSTANCE, 4, "foo", false);
497-
498-
// $ExpectType IterableIterator<void>
499-
dispatchOrUseDispatch("core/block-editor").insertBlocks([BLOCK_INSTANCE]);
500-
dispatchOrUseDispatch("core/block-editor").insertBlocks([BLOCK_INSTANCE], 5);
501-
dispatchOrUseDispatch("core/block-editor").insertBlocks([BLOCK_INSTANCE], 5, "foo");
502-
dispatchOrUseDispatch("core/block-editor").insertBlocks([BLOCK_INSTANCE], 5, "foo", false);
503-
504-
// $ExpectType void
505-
dispatchOrUseDispatch("core/block-editor").insertDefaultBlock();
506-
dispatchOrUseDispatch("core/block-editor").insertDefaultBlock({ foo: "bar" });
507-
dispatchOrUseDispatch("core/block-editor").insertDefaultBlock({ foo: "bar" }, "foo");
508-
dispatchOrUseDispatch("core/block-editor").insertDefaultBlock({ foo: "bar" }, "foo", 5);
509-
510-
// $ExpectType void
511-
dispatchOrUseDispatch("core/block-editor").mergeBlocks("foo", "bar");
512-
513-
// $ExpectType void
514-
dispatchOrUseDispatch("core/block-editor").moveBlocksUp("foo", "bar");
515-
dispatchOrUseDispatch("core/block-editor").moveBlocksUp(["foo", "baz"], "bar");
516-
517-
// $ExpectType IterableIterator<void>
518-
dispatchOrUseDispatch("core/block-editor").moveBlockToPosition("foo", "bar", "baz", 1);
519-
dispatchOrUseDispatch("core/block-editor").moveBlockToPosition(undefined, "foo", undefined, 5);
520-
dispatchOrUseDispatch("core/block-editor").moveBlockToPosition(undefined, undefined, undefined, 5);
521-
522-
// $ExpectType void
523-
dispatchOrUseDispatch("core/block-editor").multiSelect("foo", "bar");
524-
525-
// $ExpectType void
526-
dispatchOrUseDispatch("core/block-editor").receiveBlocks([BLOCK_INSTANCE]);
527-
528-
// $ExpectType void
529-
dispatchOrUseDispatch("core/block-editor").removeBlock("foo");
530-
dispatchOrUseDispatch("core/block-editor").removeBlock("foo", true);
531-
532-
// $ExpectType IterableIterator<void>
533-
dispatchOrUseDispatch("core/block-editor").removeBlocks("foo");
534-
dispatchOrUseDispatch("core/block-editor").removeBlocks("foo", false);
535-
dispatchOrUseDispatch("core/block-editor").removeBlocks(["foo"]);
536-
dispatchOrUseDispatch("core/block-editor").removeBlocks(["foo"], false);
537-
538-
// $ExpectType void
539-
dispatchOrUseDispatch("core/block-editor").replaceBlock("foo", BLOCK_INSTANCE);
540-
dispatchOrUseDispatch("core/block-editor").replaceBlock("foo", [BLOCK_INSTANCE]);
541-
dispatchOrUseDispatch("core/block-editor").replaceBlock(["foo"], BLOCK_INSTANCE);
542-
dispatchOrUseDispatch("core/block-editor").replaceBlock(["foo"], [BLOCK_INSTANCE]);
543-
544-
// $ExpectType IterableIterator<void>
545-
dispatchOrUseDispatch("core/block-editor").replaceBlocks("foo", BLOCK_INSTANCE);
546-
dispatchOrUseDispatch("core/block-editor").replaceBlocks("foo", [BLOCK_INSTANCE], 3);
547-
dispatchOrUseDispatch("core/block-editor").replaceBlocks(["foo"], BLOCK_INSTANCE);
548-
dispatchOrUseDispatch("core/block-editor").replaceBlocks(["foo"], [BLOCK_INSTANCE], 0);
549-
550-
// $ExpectType void
551-
dispatchOrUseDispatch("core/block-editor").replaceInnerBlocks("foo", [BLOCK_INSTANCE]);
552-
dispatchOrUseDispatch("core/block-editor").replaceInnerBlocks("foo", [BLOCK_INSTANCE], true);
553-
554-
// $ExpectType void
555-
dispatchOrUseDispatch("core/block-editor").resetBlocks([BLOCK_INSTANCE]);
556-
557-
// $ExpectType void
558-
dispatchOrUseDispatch("core/block-editor").selectBlock("foo");
559-
dispatchOrUseDispatch("core/block-editor").selectBlock("foo", 5);
560-
561-
// $ExpectType void
562-
dispatchOrUseDispatch("core/block-editor").selectionChange("foo", "bar", 0, 5);
563-
564-
// $ExpectType IterableIterator<void>
565-
dispatchOrUseDispatch("core/block-editor").selectNextBlock("foo");
566-
567-
// $ExpectType IterableIterator<void>
568-
dispatchOrUseDispatch("core/block-editor").selectPreviousBlock("foo");
569-
570-
// $ExpectType void
571-
dispatchOrUseDispatch("core/block-editor").setTemplateValidity(false);
572-
573-
// $ExpectType void
574-
dispatchOrUseDispatch("core/block-editor").showInsertionPoint();
575-
dispatchOrUseDispatch("core/block-editor").showInsertionPoint("foo");
576-
dispatchOrUseDispatch("core/block-editor").showInsertionPoint("foo", 5);
577-
578-
// $ExpectType void
579-
dispatchOrUseDispatch("core/block-editor").toggleBlockMode("foo");
580-
581-
// $ExpectType void
582-
dispatchOrUseDispatch("core/block-editor").toggleSelection();
583-
dispatchOrUseDispatch("core/block-editor").toggleSelection(true);
584-
585-
// $ExpectType void
586-
dispatchOrUseDispatch("core/block-editor").updateBlock("foo", { attributes: { foo: "bar" }, innerBlocks: [] });
587-
588-
// $ExpectType void
589-
dispatchOrUseDispatch("core/block-editor").updateBlockAttributes("foo", { foo: "bar" });
590-
591-
// $ExpectType void
592-
dispatchOrUseDispatch("core/block-editor").updateBlockListSettings("foo", { allowedBlocks: ["core/paragraph"] });
593-
594-
// $ExpectType void
595-
dispatchOrUseDispatch("core/block-editor").updateSettings({
596-
focusMode: true,
597-
codeEditingEnabled: false,
598-
maxUploadFileSize: 500,
599-
richEditingEnabled: false,
600-
});
601-
}
491+
// $ExpectType void
492+
dispatch("core/block-editor").insertBlock(BLOCK_INSTANCE);
493+
dispatch("core/block-editor").insertBlock(BLOCK_INSTANCE, 4);
494+
dispatch("core/block-editor").insertBlock(BLOCK_INSTANCE, 4, "foo");
495+
dispatch("core/block-editor").insertBlock(BLOCK_INSTANCE, 4, "foo", false);
496+
497+
// $ExpectType IterableIterator<void>
498+
dispatch("core/block-editor").insertBlocks([BLOCK_INSTANCE]);
499+
dispatch("core/block-editor").insertBlocks([BLOCK_INSTANCE], 5);
500+
dispatch("core/block-editor").insertBlocks([BLOCK_INSTANCE], 5, "foo");
501+
dispatch("core/block-editor").insertBlocks([BLOCK_INSTANCE], 5, "foo", false);
502+
503+
// $ExpectType void
504+
dispatch("core/block-editor").insertDefaultBlock();
505+
dispatch("core/block-editor").insertDefaultBlock({ foo: "bar" });
506+
dispatch("core/block-editor").insertDefaultBlock({ foo: "bar" }, "foo");
507+
dispatch("core/block-editor").insertDefaultBlock({ foo: "bar" }, "foo", 5);
508+
509+
// $ExpectType void
510+
dispatch("core/block-editor").mergeBlocks("foo", "bar");
511+
512+
// $ExpectType void
513+
dispatch("core/block-editor").moveBlocksUp("foo", "bar");
514+
dispatch("core/block-editor").moveBlocksUp(["foo", "baz"], "bar");
515+
516+
// $ExpectType IterableIterator<void>
517+
dispatch("core/block-editor").moveBlockToPosition("foo", "bar", "baz", 1);
518+
dispatch("core/block-editor").moveBlockToPosition(undefined, "foo", undefined, 5);
519+
dispatch("core/block-editor").moveBlockToPosition(undefined, undefined, undefined, 5);
520+
521+
// $ExpectType void
522+
dispatch("core/block-editor").multiSelect("foo", "bar");
523+
524+
// $ExpectType void
525+
dispatch("core/block-editor").receiveBlocks([BLOCK_INSTANCE]);
526+
527+
// $ExpectType void
528+
dispatch("core/block-editor").removeBlock("foo");
529+
dispatch("core/block-editor").removeBlock("foo", true);
530+
531+
// $ExpectType IterableIterator<void>
532+
dispatch("core/block-editor").removeBlocks("foo");
533+
dispatch("core/block-editor").removeBlocks("foo", false);
534+
dispatch("core/block-editor").removeBlocks(["foo"]);
535+
dispatch("core/block-editor").removeBlocks(["foo"], false);
536+
537+
// $ExpectType void
538+
dispatch("core/block-editor").replaceBlock("foo", BLOCK_INSTANCE);
539+
dispatch("core/block-editor").replaceBlock("foo", [BLOCK_INSTANCE]);
540+
dispatch("core/block-editor").replaceBlock(["foo"], BLOCK_INSTANCE);
541+
dispatch("core/block-editor").replaceBlock(["foo"], [BLOCK_INSTANCE]);
542+
543+
// $ExpectType IterableIterator<void>
544+
dispatch("core/block-editor").replaceBlocks("foo", BLOCK_INSTANCE);
545+
dispatch("core/block-editor").replaceBlocks("foo", [BLOCK_INSTANCE], 3);
546+
dispatch("core/block-editor").replaceBlocks(["foo"], BLOCK_INSTANCE);
547+
dispatch("core/block-editor").replaceBlocks(["foo"], [BLOCK_INSTANCE], 0);
548+
549+
// $ExpectType void
550+
dispatch("core/block-editor").replaceInnerBlocks("foo", [BLOCK_INSTANCE]);
551+
dispatch("core/block-editor").replaceInnerBlocks("foo", [BLOCK_INSTANCE], true);
552+
553+
// $ExpectType void
554+
dispatch("core/block-editor").resetBlocks([BLOCK_INSTANCE]);
555+
556+
// $ExpectType void
557+
dispatch("core/block-editor").selectBlock("foo");
558+
dispatch("core/block-editor").selectBlock("foo", 5);
559+
560+
// $ExpectType void
561+
dispatch("core/block-editor").selectionChange("foo", "bar", 0, 5);
562+
563+
// $ExpectType IterableIterator<void>
564+
dispatch("core/block-editor").selectNextBlock("foo");
565+
566+
// $ExpectType IterableIterator<void>
567+
dispatch("core/block-editor").selectPreviousBlock("foo");
568+
569+
// $ExpectType void
570+
dispatch("core/block-editor").setTemplateValidity(false);
571+
572+
// $ExpectType void
573+
dispatch("core/block-editor").showInsertionPoint();
574+
dispatch("core/block-editor").showInsertionPoint("foo");
575+
dispatch("core/block-editor").showInsertionPoint("foo", 5);
576+
577+
// $ExpectType void
578+
dispatch("core/block-editor").toggleBlockMode("foo");
579+
580+
// $ExpectType void
581+
dispatch("core/block-editor").toggleSelection();
582+
dispatch("core/block-editor").toggleSelection(true);
583+
584+
// $ExpectType void
585+
dispatch("core/block-editor").updateBlock("foo", { attributes: { foo: "bar" }, innerBlocks: [] });
586+
587+
// $ExpectType void
588+
dispatch("core/block-editor").updateBlockAttributes("foo", { foo: "bar" });
589+
590+
// $ExpectType void
591+
dispatch("core/block-editor").updateBlockListSettings("foo", { allowedBlocks: ["core/paragraph"] });
592+
593+
// $ExpectType void
594+
dispatch("core/block-editor").updateSettings({
595+
focusMode: true,
596+
codeEditingEnabled: false,
597+
maxUploadFileSize: 500,
598+
richEditingEnabled: false,
599+
});
602600

603601
for (const dispatchOrUseDispatch of [dispatch, useDispatch]) {
604602
// $ExpectType Promise<void>
@@ -712,27 +710,25 @@ for (const dispatchOrUseDispatch of [dispatch, useDispatch]) {
712710
});
713711
}
714712

715-
for (const selectOrUseSelect of [select, useSelect]) {
716-
// $ExpectType boolean
717-
selectOrUseSelect("core/block-editor").canInsertBlockType("core/paragraph");
718-
selectOrUseSelect("core/block-editor").canInsertBlockType("core/paragraph", "foo");
713+
// $ExpectType boolean
714+
select("core/block-editor").canInsertBlockType("core/paragraph");
715+
select("core/block-editor").canInsertBlockType("core/paragraph", "foo");
719716

720-
// $ExpectType string | null
721-
selectOrUseSelect("core/block-editor").getAdjacentBlockClientId();
722-
selectOrUseSelect("core/block-editor").getAdjacentBlockClientId("foo");
723-
selectOrUseSelect("core/block-editor").getAdjacentBlockClientId("foo", -1);
724-
selectOrUseSelect("core/block-editor").getAdjacentBlockClientId("foo", 1);
717+
// $ExpectType string | null
718+
select("core/block-editor").getAdjacentBlockClientId();
719+
select("core/block-editor").getAdjacentBlockClientId("foo");
720+
select("core/block-editor").getAdjacentBlockClientId("foo", -1);
721+
select("core/block-editor").getAdjacentBlockClientId("foo", 1);
725722

726-
// $ExpectType string[]
727-
selectOrUseSelect("core/block-editor").getBlockParents("foo");
728-
selectOrUseSelect("core/block-editor").getBlockParentsByBlockName("foo", ["core/query"]);
729-
selectOrUseSelect("core/block-editor").getBlockParents("foo", true);
730-
selectOrUseSelect("core/block-editor").getBlockParentsByBlockName("foo", ["core/query"], true);
723+
// $ExpectType string[]
724+
select("core/block-editor").getBlockParents("foo");
725+
select("core/block-editor").getBlockParentsByBlockName("foo", ["core/query"]);
726+
select("core/block-editor").getBlockParents("foo", true);
727+
select("core/block-editor").getBlockParentsByBlockName("foo", ["core/query"], true);
731728

732-
// $ExpectType string[]
733-
selectOrUseSelect("core/block-editor").getBlocksByName("core/group");
734-
selectOrUseSelect("core/block-editor").getBlocksByName(["core/group", "core/paragraph"]);
735-
}
729+
// $ExpectType string[]
730+
select("core/block-editor").getBlocksByName("core/group");
731+
select("core/block-editor").getBlocksByName(["core/group", "core/paragraph"]);
736732

737733
for (const selectOrUseSelect of [select, useSelect]) {
738734
// $ExpectType boolean

0 commit comments

Comments
 (0)