Update type names (#23)

* ContextInnerBlockAttributes => RemoteDataInnerBlockAttributes

* ContextBlockAttributes => RemoteDataBlockAttributes

Author: chriszarate

src/blocks/remote-data-container/components/block-binding-controls.tsx

@@ -31,7 +31,7 @@ export function BlockBindingFieldControl( props: BlockBindingFieldControlProps )
 }
 
 interface BlockBindingControlsProps {
-	attributes: ContextInnerBlockAttributes;
+	attributes: RemoteDataInnerBlockAttributes;
 	availableBindings: AvailableBindings;
 	blockName: string;
 	removeBinding: ( target: string ) => void;

src/blocks/remote-data-container/components/inner-blocks.tsx

@@ -7,7 +7,7 @@ interface InnerBlocksProps {
 	blockConfig: BlockConfig;
 	getInnerBlocks: (
 		result: Record< string, string >
-	) => BlockInstance< ContextInnerBlockAttributes >[];
+	) => BlockInstance< RemoteDataInnerBlockAttributes >[];
 	remoteData: RemoteData;
 }
 

src/blocks/remote-data-container/components/loop-template.tsx

@@ -15,7 +15,7 @@ import { LoopIndexContext } from '@/blocks/remote-data-container/context/loop-in
 interface LoopTemplateProps {
 	getInnerBlocks: (
 		result: Record< string, string >
-	) => BlockInstance< ContextInnerBlockAttributes >[];
+	) => BlockInstance< RemoteDataInnerBlockAttributes >[];
 	remoteData: RemoteData;
 }
 

src/blocks/remote-data-container/edit.tsx

@@ -15,7 +15,7 @@ import { hasRemoteDataChanged } from '@/utils/block-binding';
 import { getBlockConfig } from '@/utils/localized-block-data';
 import './editor.scss';
 
-export function Edit( props: BlockEditProps< ContextBlockAttributes > ) {
+export function Edit( props: BlockEditProps< RemoteDataBlockAttributes > ) {
 	const blockConfig = getBlockConfig( props.name );
 
 	if ( ! blockConfig ) {

src/blocks/remote-data-container/hooks/use-existing-remote-data.ts

@@ -17,7 +17,7 @@ export function useExistingRemoteData(): RemoteData[] {
 
 		return blocks
 			.map( clientId => {
-				const block = getBlocksByClientId< ContextBlockAttributes >( clientId )[ 0 ];
+				const block = getBlocksByClientId< RemoteDataBlockAttributes >( clientId )[ 0 ];
 				return block?.attributes?.remoteData;
 			} )
 			.filter( ( maybeRemoteData ): maybeRemoteData is RemoteData => Boolean( maybeRemoteData ) );

src/blocks/remote-data-container/hooks/use-patterns.ts

@@ -33,8 +33,8 @@ export function usePatterns( blockName: string, rootClientId: string ) {
 	return {
 		getInnerBlocks: (
 			result: Record< string, string >
-		): BlockInstance< ContextInnerBlockAttributes >[] => {
-			return getBlocks< ContextInnerBlockAttributes >( rootClientId ).map( block =>
+		): BlockInstance< RemoteDataInnerBlockAttributes >[] => {
+			return getBlocks< RemoteDataInnerBlockAttributes >( rootClientId ).map( block =>
 				cloneBlockWithAttributes( block, result )
 			);
 		},

src/blocks/remote-data-container/hooks/with-block-binding.tsx

@@ -17,12 +17,12 @@ import { getMismatchedAttributes } from '@/utils/block-binding';
 import { getBlockAvailableBindings } from '@/utils/localized-block-data';
 
 interface BoundBlockEditProps {
-	attributes: ContextInnerBlockAttributes;
+	attributes: RemoteDataInnerBlockAttributes;
 	availableBindings: AvailableBindings;
 	blockName: string;
 	children: JSX.Element;
 	remoteDataName: string;
-	setAttributes: ( attributes: ContextInnerBlockAttributes ) => void;
+	setAttributes: ( attributes: RemoteDataInnerBlockAttributes ) => void;
 }
 
 function BoundBlockEdit( props: BoundBlockEditProps ) {
@@ -78,7 +78,7 @@ function BoundBlockEdit( props: BoundBlockEditProps ) {
 }
 
 export const withBlockBinding = createHigherOrderComponent( BlockEdit => {
-	return ( props: BlockEditProps< ContextInnerBlockAttributes > ) => {
+	return ( props: BlockEditProps< RemoteDataInnerBlockAttributes > ) => {
 		const { attributes, context, name, setAttributes } = props;
 		const remoteData = context[ REMOTE_DATA_CONTEXT_KEY ] as RemoteData | undefined;
 		const availableBindings = getBlockAvailableBindings( remoteData?.blockName ?? '' );
@@ -118,7 +118,7 @@ export const withBlockBinding = createHigherOrderComponent( BlockEdit => {
 
 		// If the block has a binding and the attributes do not match their expected
 		// values, update and merge the attributes.
-		const mergedAttributes = useMemo< ContextInnerBlockAttributes >( () => {
+		const mergedAttributes = useMemo< RemoteDataInnerBlockAttributes >( () => {
 			return {
 				...attributes,
 				...getMismatchedAttributes( attributes, remoteData.results, index ),

src/blocks/remote-data-container/index.ts

@@ -11,7 +11,7 @@ import './style.scss';
 
 // Register a unique block definition for each of the context blocks.
 Object.values( getBlocksConfig() ).forEach( blockConfig => {
-	registerBlockType< ContextBlockAttributes >( blockConfig.name, {
+	registerBlockType< RemoteDataBlockAttributes >( blockConfig.name, {
 		...blockConfig.settings,
 		attributes: {
 			remoteData: {

src/utils/block-binding.ts

@@ -31,18 +31,18 @@ function getExpectedAttributeValue(
 }
 
 export function getBoundAttributeEntries(
-	attributes: ContextInnerBlockAttributes
+	attributes: RemoteDataInnerBlockAttributes
 ): [ string, RemoteDataBlockBinding ][] {
 	return Object.entries( attributes.metadata?.bindings ?? {} ).filter(
 		( [ _target, binding ] ) => binding.source === BLOCK_BINDING_SOURCE
 	);
 }
 
 export function getMismatchedAttributes(
-	attributes: ContextInnerBlockAttributes,
+	attributes: RemoteDataInnerBlockAttributes,
 	results: RemoteData[ 'results' ],
 	index = 0
-): Partial< ContextInnerBlockAttributes > {
+): Partial< RemoteDataInnerBlockAttributes > {
 	return Object.fromEntries(
 		getBoundAttributeEntries( attributes )
 			.map( ( [ target, binding ] ) => [
@@ -52,7 +52,7 @@ export function getMismatchedAttributes(
 			.filter(
 				( [ target, value ] ) => null !== value && value !== getAttributeValue( attributes, target )
 			)
-	) as Partial< ContextInnerBlockAttributes >;
+	) as Partial< RemoteDataInnerBlockAttributes >;
 }
 
 export function hasRemoteDataChanged( one: RemoteData, two: RemoteData ): boolean {

tests/src/utils/block-binding.test.ts

@@ -7,7 +7,7 @@ describe( 'block-binding utils', () => {
 	describe( 'getBoundAttributeEntries', () => {
 		it( 'should return bound attribute entries', () => {
 			const name = 'test/block';
-			const attributes: ContextInnerBlockAttributes = {
+			const attributes: RemoteDataInnerBlockAttributes = {
 				metadata: {
 					bindings: {
 						content: { source: BLOCK_BINDING_SOURCE, args: { name, field: 'title' } },
@@ -26,7 +26,7 @@ describe( 'block-binding utils', () => {
 		} );
 
 		it( 'should return an empty array when no bindings are present', () => {
-			const attributes: ContextInnerBlockAttributes = {};
+			const attributes: RemoteDataInnerBlockAttributes = {};
 
 			const result = getBoundAttributeEntries( attributes );
 
@@ -37,7 +37,7 @@ describe( 'block-binding utils', () => {
 	describe( 'getMismatchedAttributes', () => {
 		it( 'should return mismatched attributes', () => {
 			const name = 'test/block';
-			const attributes: ContextInnerBlockAttributes = {
+			const attributes: RemoteDataInnerBlockAttributes = {
 				content: 'Old content',
 				url: 'https://old-url.com',
 				alt: 'Old alt',
@@ -61,7 +61,7 @@ describe( 'block-binding utils', () => {
 
 		it( 'should return an empty object when no mismatches are found', () => {
 			const name = 'test/block';
-			const attributes: ContextInnerBlockAttributes = {
+			const attributes: RemoteDataInnerBlockAttributes = {
 				content: 'Title: Current content',
 				url: 'https://current-url.com',
 				metadata: {
@@ -84,7 +84,7 @@ describe( 'block-binding utils', () => {
 
 		it( 'should handle missing results', () => {
 			const name = 'test/block';
-			const attributes: ContextInnerBlockAttributes = {
+			const attributes: RemoteDataInnerBlockAttributes = {
 				content: 'Old content',
 				url: 'https://old-url.com',
 				metadata: {
@@ -106,7 +106,7 @@ describe( 'block-binding utils', () => {
 
 		it( 'should handle missing label', () => {
 			const name = 'test/block';
-			const attributes: ContextInnerBlockAttributes = {
+			const attributes: RemoteDataInnerBlockAttributes = {
 				content: 'My Title',
 				metadata: {
 					bindings: {

types/remote-data.d.ts

@@ -23,11 +23,11 @@ interface RemoteData {
 	results: Record< string, string >[];
 }
 
-interface ContextBlockAttributes {
+interface RemoteDataBlockAttributes {
 	remoteData: RemoteData;
 }
 
-interface FieldSelection extends ContextBlockAttributes {
+interface FieldSelection extends RemoteDataBlockAttributes {
 	selectedField: string;
 	type: 'field' | 'meta';
 }
@@ -47,7 +47,7 @@ interface RemoteDataBlockBinding {
 	args: RemoteDataBlockBindingArgs;
 }
 
-interface ContextInnerBlockAttributes {
+interface RemoteDataInnerBlockAttributes {
 	alt?: string | RichTextData;
 	content?: string | RichTextData;
 	index?: number;

types/wordpress__block-editor/index.d.ts

@@ -27,7 +27,7 @@ declare module '@wordpress/block-editor' {
 
 	// Incomplete type for our use case.
 	interface BlockPattern {
-		blocks: BlockInstance< ContextInnerBlockAttributes >[];
+		blocks: BlockInstance< RemoteDataInnerBlockAttributes >[];
 		name: string;
 		title: string;
 	}