From 8355a2200f3d156be56e3d260b4da83a5c70087a Mon Sep 17 00:00:00 2001
From: Derek Sifford <dereksifford@gmail.com>
Date: Thu, 11 Jul 2019 18:50:41 -0400
Subject: [PATCH] [@wordpress/blocks] miscellaneous fixes for compatibility
 with wordpress core (#36827)

* [@wordpress/blocks] miscellaneous fixes for compatibility with wordpress core

* fix lint errors
---
 types/wordpress__blocks/api/categories.d.ts   |  4 ++-
 types/wordpress__blocks/api/factory.d.ts      | 11 +++-----
 types/wordpress__blocks/api/registration.d.ts |  2 +-
 types/wordpress__blocks/api/serializer.d.ts   |  6 ++---
 types/wordpress__blocks/api/templates.d.ts    |  2 +-
 .../block-content-provider.d.ts               | 27 +++++++++++++++++--
 types/wordpress__blocks/index.d.ts            |  4 +--
 .../wordpress__blocks-tests.tsx               |  2 +-
 8 files changed, 40 insertions(+), 18 deletions(-)

diff --git a/types/wordpress__blocks/api/categories.d.ts b/types/wordpress__blocks/api/categories.d.ts
index 14a04f6ed5..28ccf7b65d 100644
--- a/types/wordpress__blocks/api/categories.d.ts
+++ b/types/wordpress__blocks/api/categories.d.ts
@@ -1,7 +1,9 @@
+import { Dashicon } from '@wordpress/components';
+
 export interface Category {
     slug: string;
     title: string;
-    icon: JSX.Element | null;
+    icon?: JSX.Element | Dashicon.Icon | null;
 }
 
 /**
diff --git a/types/wordpress__blocks/api/factory.d.ts b/types/wordpress__blocks/api/factory.d.ts
index 0f20e60db8..c0715b586d 100644
--- a/types/wordpress__blocks/api/factory.d.ts
+++ b/types/wordpress__blocks/api/factory.d.ts
@@ -11,7 +11,7 @@ import { Block, BlockInstance, Transform } from '../';
 export function cloneBlock<T extends Record<string, any>>(
     block: BlockInstance<T>,
     mergeAttributes?: Partial<T>,
-    newInnerBlocks?: readonly BlockInstance[]
+    newInnerBlocks?: BlockInstance[]
 ): BlockInstance<T>;
 
 /**
@@ -24,7 +24,7 @@ export function cloneBlock<T extends Record<string, any>>(
 export function createBlock<T extends Record<string, any>>(
     name: string,
     attributes?: Partial<T>,
-    innerBlocks?: readonly BlockInstance[]
+    innerBlocks?: BlockInstance[]
 ): BlockInstance<T>;
 
 /**
@@ -66,7 +66,7 @@ export function getBlockTransforms<T extends Record<string, any> = Record<string
  *
  * @returns Block types that ALL blocks in `blocks` can be transformed to.
  */
-export function getPossibleBlockTransformations(blocks: readonly BlockInstance[]): Array<Block<Record<string, any>>>;
+export function getPossibleBlockTransformations(blocks: BlockInstance[]): Array<Block<Record<string, any>>>;
 
 /**
  * Switch one or more blocks into one or more blocks of the new block type.
@@ -74,7 +74,4 @@ export function getPossibleBlockTransformations(blocks: readonly BlockInstance[]
  * @param blocks - One or more `BlockInstance`.
  * @param name - Block name of block to be switched to.
  */
-export function switchToBlockType(
-    blocks: BlockInstance | readonly BlockInstance[],
-    name: string
-): BlockInstance[] | null;
+export function switchToBlockType(blocks: BlockInstance | BlockInstance[], name: string): BlockInstance[] | null;
diff --git a/types/wordpress__blocks/api/registration.d.ts b/types/wordpress__blocks/api/registration.d.ts
index beb93d16ba..b9d387401e 100644
--- a/types/wordpress__blocks/api/registration.d.ts
+++ b/types/wordpress__blocks/api/registration.d.ts
@@ -25,7 +25,7 @@ export function getBlockType<T = any>(name: string | undefined): Block<T> | unde
 /**
  * Returns all registered blocks.
  */
-export function getBlockTypes(): ReadonlyArray<Block<any>>;
+export function getBlockTypes(): Array<Block<any>>;
 
 /**
  * Returns an array with the child blocks of a given block.
diff --git a/types/wordpress__blocks/api/serializer.d.ts b/types/wordpress__blocks/api/serializer.d.ts
index 3309585e38..4c834059cc 100644
--- a/types/wordpress__blocks/api/serializer.d.ts
+++ b/types/wordpress__blocks/api/serializer.d.ts
@@ -28,7 +28,7 @@ export function getBlockMenuDefaultClassName(blockName: string): string;
 export function getSaveContent<T>(
     blockTypeOrName: Block<T> | string,
     attributes: T,
-    innerBlocks?: readonly BlockInstance[]
+    innerBlocks?: BlockInstance[]
 ): string;
 
 /**
@@ -42,7 +42,7 @@ export function getSaveContent<T>(
 export function getSaveElement<T>(
     blockTypeOrName: Block<T> | string,
     attributes: T,
-    innerBlocks?: readonly BlockInstance[]
+    innerBlocks?: BlockInstance[]
 ): ReactChild;
 
 /**
@@ -50,4 +50,4 @@ export function getSaveElement<T>(
  *
  * @param blocks - Block(s) to serialize.
  */
-export function serialize(blocks: readonly BlockInstance[]): string;
+export function serialize(blocks: BlockInstance[]): string;
diff --git a/types/wordpress__blocks/api/templates.d.ts b/types/wordpress__blocks/api/templates.d.ts
index 8ae01af85f..4e5baf254e 100644
--- a/types/wordpress__blocks/api/templates.d.ts
+++ b/types/wordpress__blocks/api/templates.d.ts
@@ -9,7 +9,7 @@ export interface TemplateArray extends ReadonlyArray<Template> {}
  * @param blocks - Block list.
  * @param template - Block template.
  */
-export function doBlocksMatchTemplate(blocks?: readonly BlockInstance[], template?: TemplateArray): boolean;
+export function doBlocksMatchTemplate(blocks?: BlockInstance[], template?: TemplateArray): boolean;
 
 /**
  * Synchronize a block list with a block template.
diff --git a/types/wordpress__blocks/block-content-provider.d.ts b/types/wordpress__blocks/block-content-provider.d.ts
index 3f1037dc9c..a39d329c71 100644
--- a/types/wordpress__blocks/block-content-provider.d.ts
+++ b/types/wordpress__blocks/block-content-provider.d.ts
@@ -1,9 +1,32 @@
+import { BlockInstance } from './';
 import { ComponentType, ReactNode } from '@wordpress/element';
 
 /**
- * A Higher Order Component used to inject BlockContent using context to the
- * wrapped component.
+ * A Higher Order Component used to inject BlockContent using context to the wrapped component.
  */
 export function withBlockContentContext<T extends ComponentType<any>>(
     wrapped: T
 ): T extends ComponentType<infer U> ? ComponentType<Omit<U, 'BlockContent'>> : never;
+
+declare namespace BlockContentProvider {
+    interface Props {
+        children: ReactNode;
+        innerBlocks: BlockInstance[];
+    }
+}
+/**
+ * An internal block component used in block content serialization to inject nested block content
+ * within the `save` implementation of the ancestor component in which it is nested. The component
+ * provides a pre-bound `BlockContent` component via context, which is used by the developer-facing
+ * `InnerBlocks.Content` component to render block content.
+ *
+ * @example
+ * ```jsx
+ * <BlockContentProvider innerBlocks={ innerBlocks }>
+ * 	{ blockSaveElement }
+ * </BlockContentProvider>
+ * ```
+ */
+declare const BlockContentProvider: ComponentType<BlockContentProvider.Props>;
+
+export default BlockContentProvider;
diff --git a/types/wordpress__blocks/index.d.ts b/types/wordpress__blocks/index.d.ts
index 5184278d2f..26ff0693d4 100644
--- a/types/wordpress__blocks/index.d.ts
+++ b/types/wordpress__blocks/index.d.ts
@@ -169,14 +169,14 @@ export interface BlockDeprecation<T extends Record<string, any>>
      * technically valid even once deprecated, and requires updates to its
      * attributes or inner blocks.
      */
-    isEligible?(attributes: Record<string, any>, innerBlocks: readonly BlockInstance[]): boolean;
+    isEligible?(attributes: Record<string, any>, innerBlocks: BlockInstance[]): boolean;
     /**
      * A function which, given the old attributes and inner blocks is
      * expected to return either the new attributes or a tuple array of
      * [attributes, innerBlocks] compatible with the block.
      */
     migrate?(attributes: Record<string, any>): T;
-    migrate?(attributes: Record<string, any>, innerBlocks: readonly BlockInstance[]): [T, BlockInstance[]];
+    migrate?(attributes: Record<string, any>, innerBlocks: BlockInstance[]): [T, BlockInstance[]];
 }
 
 //
diff --git a/types/wordpress__blocks/wordpress__blocks-tests.tsx b/types/wordpress__blocks/wordpress__blocks-tests.tsx
index d79efae513..3d42abe472 100644
--- a/types/wordpress__blocks/wordpress__blocks-tests.tsx
+++ b/types/wordpress__blocks/wordpress__blocks-tests.tsx
@@ -264,7 +264,7 @@ blocks.getBlockSupport('core/paragraph', 'inserter', { foo: 'bar' });
 // $ExpectType Block<any> | undefined
 blocks.getBlockType('core/paragraph');
 
-// $ExpectType ReadonlyArray<Block<any>>
+// $ExpectType Block<any>[]
 blocks.getBlockTypes();
 
 // $ExpectType string[]