Add store rest endpoints

assets/js/blocks/attribute-filter/block.js

@@ -13,42 +13,32 @@ import {
 	useState,
 	useMemo,
 } from '@wordpress/element';
-import { find, sortBy } from 'lodash';
+import { sortBy } from 'lodash';
 import CheckboxList from '@woocommerce/base-components/checkbox-list';
-import { ATTRIBUTES } from '@woocommerce/block-settings';
 
 /**
  * Internal dependencies
  */
 import './style.scss';
+import { getTaxonomyFromAttributeId } from '../../utils/attributes';
 
 /**
  * Component displaying an attribute filter.
  */
 const AttributeFilterBlock = ( { attributes } ) => {
 	const [ options, setOptions ] = useState( [] );
 	const [ checkedOptions, setCheckedOptions ] = useState( [] );
-
 	const { showCounts, attributeId, queryType } = attributes;
-	const productAttribute = find( ATTRIBUTES, [
-		'attribute_id',
-		attributeId.toString(),
-	] );
-	const taxonomy = productAttribute.attribute_name
-		? 'pa_' + productAttribute.attribute_name
-		: null;
+	const taxonomy = getTaxonomyFromAttributeId( attributeId );
 
+	const [ queryState ] = useQueryStateByContext( 'product-grid' );
 	const [ productAttributes, setProductAttributes ] = useQueryStateByKey(
 		'product-grid',
 		'attributes',
 		[]
 	);
-	const [ queryState ] = useQueryStateByContext( 'product-grid' );
 
-	const countsQueryState = useMemo( () => {
-		if ( ! taxonomy ) {
-			return {};
-		}
+	const filteredCountsQueryState = useMemo( () => {
 		// If doing an "AND" query, we need to remove current taxonomy query so counts are not affected.
 		const modifiedQueryState =
 			'and' === queryType
@@ -69,21 +59,20 @@ const AttributeFilterBlock = ( { attributes } ) => {
 		};
 	}, [ queryState, taxonomy, queryType, productAttributes ] );
 
-	const { results: allTerms, isLoading: allTermsIsLoading } = useCollection( {
-		namespace: '/wc/blocks',
+	const {
+		results: attributeTerms,
+		isLoading: attributeTermsLoading,
+	} = useCollection( {
+		namespace: '/wc/store',
 		resourceName: 'products/attributes/terms',
 		resourceValues: [ attributeId ],
-		query: { per_page: 100 },
 	} );
 
-	const {
-		results: filteredCounts,
-		isLoading: filteredCountsIsLoading,
-	} = useCollection( {
+	const { results: filteredCounts } = useCollection( {
 		namespace: '/wc/store',
 		resourceName: 'products/collection-data',
 		query: {
-			...countsQueryState,
+			...filteredCountsQueryState,
 		},
 	} );
 
@@ -119,13 +108,13 @@ const AttributeFilterBlock = ( { attributes } ) => {
 	 * Compare intersection of all terms and filtered counts to get a list of options to display.
 	 */
 	useEffect( () => {
-		if ( filteredCountsIsLoading || allTermsIsLoading ) {
+		if ( attributeTermsLoading ) {
 			return;
 		}
 
 		const newOptions = [];
 
-		allTerms.forEach( ( term ) => {
+		attributeTerms.forEach( ( term ) => {
 			const filteredTerm = getFilteredTerm( term.id );
 
 			if ( ! filteredTerm && filteredCounts !== null ) {
@@ -145,10 +134,8 @@ const AttributeFilterBlock = ( { attributes } ) => {
 		setOptions( newOptions );
 	}, [
 		filteredCounts,
-		allTerms,
-		showCounts,
-		filteredCountsIsLoading,
-		allTermsIsLoading,
+		attributeTerms,
+		attributeTermsLoading,
 		getFilteredTerm,
 		getLabel,
 	] );
@@ -185,7 +172,7 @@ const AttributeFilterBlock = ( { attributes } ) => {
 				className={ 'wc-block-attribute-filter-list' }
 				options={ options }
 				onChange={ onChange }
-				isLoading={ allTermsIsLoading }
+				isLoading={ attributeTermsLoading }
 			/>
 		</div>
 	);

assets/js/utils/attributes.js

@@ -0,0 +1,26 @@
+/**
+ * External dependencies
+ */
+import { find } from 'lodash';
+import { ATTRIBUTES } from '@woocommerce/block-settings';
+
+/**
+ * Get the ID of the first image attached to a product (the featured image).
+ *
+ * @param {number} attributeId The attribute ID.
+ * @return {string} The taxonomy name.
+ */
+export function getTaxonomyFromAttributeId( attributeId ) {
+	if ( ! attributeId ) {
+		return null;
+	}
+
+	const productAttribute = find( ATTRIBUTES, [
+		'attribute_id',
+		attributeId.toString(),
+	] );
+
+	return productAttribute.attribute_name
+		? 'pa_' + productAttribute.attribute_name
+		: null;
+}

src/RestApi.php

@@ -76,6 +76,8 @@ protected static function get_controllers() {
 			'store-cart-items'              => __NAMESPACE__ . '\RestApi\StoreApi\Controllers\CartItems',
 			'store-products'                => __NAMESPACE__ . '\RestApi\StoreApi\Controllers\Products',
 			'store-product-collection-data' => __NAMESPACE__ . '\RestApi\StoreApi\Controllers\ProductCollectionData',
+			'store-product-attributes'      => __NAMESPACE__ . '\RestApi\StoreApi\Controllers\ProductAttributes',
+			'store-product-attribute-terms' => __NAMESPACE__ . '\RestApi\StoreApi\Controllers\ProductAttributeTerms',
 		];
 	}
 }

src/RestApi/StoreApi/Controllers/ProductAttributeTerms.php

@@ -0,0 +1,162 @@
+<?php
+/**
+ * Product Attribute Terms Controller.
+ *
+ * @internal This API is used internally by Blocks--it is still in flux and may be subject to revisions.
+ * @package WooCommerce/Blocks
+ */
+
+namespace Automattic\WooCommerce\Blocks\RestApi\StoreApi\Controllers;
+
+defined( 'ABSPATH' ) || exit;
+
+use \WP_Error as RestError;
+use \WP_REST_Server as RestServer;
+use \WP_REST_Controller as RestContoller;
+use \WC_REST_Exception as RestException;
+use Automattic\WooCommerce\Blocks\RestApi\StoreApi\Schemas\TermSchema;
+use Automattic\WooCommerce\Blocks\RestApi\StoreApi\Utilities\TermQuery;
+
+/**
+ * Product attribute terms API.
+ *
+ * @since $VID:$
+ */
+class ProductAttributeTerms extends RestContoller {
+	/**
+	 * Endpoint namespace.
+	 *
+	 * @var string
+	 */
+	protected $namespace = 'wc/store';
+
+	/**
+	 * Route base.
+	 *
+	 * @var string
+	 */
+	protected $rest_base = 'products/attributes/(?P<attribute_id>[\d]+)/terms';
+
+	/**
+	 * Schema class instance.
+	 *
+	 * @var TermSchema
+	 */
+	protected $schema;
+
+	/**
+	 * Query class instance.
+	 *
+	 * @var TermQuery
+	 */
+	protected $term_query;
+
+	/**
+	 * Setup API class.
+	 */
+	public function __construct() {
+		$this->schema     = new TermSchema();
+		$this->term_query = new TermQuery();
+	}
+
+	/**
+	 * Register the routes.
+	 */
+	public function register_routes() {
+		register_rest_route(
+			$this->namespace,
+			'/' . $this->rest_base,
+			array(
+				'args'   => array(
+					'attribute_id' => array(
+						'description' => __( 'Unique identifier for the attribute.', 'woo-gutenberg-products-block' ),
+						'type'        => 'integer',
+					),
+				),
+				array(
+					'methods'  => RestServer::READABLE,
+					'callback' => [ $this, 'get_items' ],
+					'args'     => $this->get_collection_params(),
+				),
+				'schema' => array( $this, 'get_public_item_schema' ),
+			)
+		);
+	}
+
+	/**
+	 * Item schema.
+	 *
+	 * @return array
+	 */
+	public function get_item_schema() {
+		return $this->schema->get_item_schema();
+	}
+
+	/**
+	 * Prepare a single item for response.
+	 *
+	 * @param \WP_Term         $item Term object.
+	 * @param \WP_REST_Request $request Request object.
+	 * @return \WP_REST_Response $response Response data.
+	 */
+	public function prepare_item_for_response( $item, $request ) {
+		return rest_ensure_response( $this->schema->get_item_response( $item ) );
+	}
+
+	/**
+	 * Get a collection of attribute terms.
+	 *
+	 * @param \WP_REST_Request $request Full details about the request.
+	 * @return RestError|\WP_REST_Response
+	 */
+	public function get_items( $request ) {
+		$attribute = wc_get_attribute( $request['attribute_id'] );
+
+		if ( ! $attribute || ! taxonomy_exists( $attribute->slug ) ) {
+			return new \WP_Error( 'woocommerce_rest_taxonomy_invalid', __( 'Attribute does not exist.', 'woo-gutenberg-products-block' ), array( 'status' => 404 ) );
+		}
+
+		$request['taxonomy'] = $attribute->slug;
+		$objects             = $this->term_query->get_objects( $request );
+
+		foreach ( $objects as $object ) {
+			$data     = $this->prepare_item_for_response( $object, $request );
+			$return[] = $this->prepare_response_for_collection( $data );
+		}
+
+		return rest_ensure_response( $return );
+	}
+
+	/**
+	 * Get the query params for collections of attributes.
+	 *
+	 * @return array
+	 */
+	public function get_collection_params() {
+		$params                       = array();
+		$params['context']            = $this->get_context_param();
+		$params['context']['default'] = 'view';
+
+		$params['order'] = array(
+			'description'       => __( 'Order sort attribute ascending or descending.', 'woo-gutenberg-products-block' ),
+			'type'              => 'string',
+			'default'           => 'asc',
+			'enum'              => array( 'asc', 'desc' ),
+			'validate_callback' => 'rest_validate_request_arg',
+		);
+
+		$params['orderby'] = array(
+			'description'       => __( 'Sort collection by object attribute.', 'woo-gutenberg-products-block' ),
+			'type'              => 'string',
+			'default'           => 'name',
+			'enum'              => array(
+				'name',
+				'slug',
+				'count',
+			),
+			'validate_callback' => 'rest_validate_request_arg',
+		);
+
+		return $params;
+	}
+}