Add a public API for aliasing and disabling JSON:API resource type fields

Looking great!

1. +++ b/core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php
   @@ -19,6 +20,13 @@ class ResourceTypeBuildEvent extends Event {
   +   * @var array|\Drupal\jsonapi\ResourceType\ResourceTypeField[]
   

   🤓🤔 I think we can remove array| here, the second part is sufficient?

2. +++ b/core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php
   @@ -31,9 +39,13 @@ class ResourceTypeBuildEvent extends Event {
   +    assert(Inspector::assertAllObjects($fields, ResourceTypeField::class));
   

   👍

3. +++ b/core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php
   @@ -76,4 +90,43 @@ public function resourceTypeShouldBeDisabled() {
   +  /**
   +   * Gets the current fields of the resource type to be built.
   +   */
   

   🤓 Missing @return.

4. +++ b/core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php
   @@ -76,4 +90,43 @@ public function resourceTypeShouldBeDisabled() {
   +   * Sets the public name of the given field on the resource type to be built.
   +   *
   +   * @param \Drupal\jsonapi\ResourceType\ResourceTypeField $field
   +   *   The field for which to set a public name.
   +   */
   +  public function disableField(ResourceTypeField $field) {
   

   🤓 Docblock is wrong. (This is not about public field name, but about disabling.)

5. +++ b/core/modules/jsonapi/src/ResourceType/ResourceTypeRelationship.php
   @@ -60,4 +60,14 @@ public function withPublicName($public_name) {
   +  public function disabled() {
   +    $relationship = parent::disabled();
   +    return isset($this->relatableResourceTypes)
   +      ? $relationship->withRelatableResourceTypes($this->relatableResourceTypes)
   +      : $relationship;
   +  }
   

   🤩 Woah, elegant, fascinating.

6. +++ b/core/modules/jsonapi/tests/modules/jsonapi_test_resource_type_building/src/EventSubscriber/ResourceTypeBuildEventSubscriber.php
   @@ -17,7 +17,13 @@ class ResourceTypeBuildEventSubscriber implements EventSubscriberInterface {
   +        ['disableResourceType'],
   +        ['aliasResourceTypeFields'],
   +        ['disableResourceTypeFields'],
   

   🤓 Übernit: I'm surprised these are arrays instead of strings.

I think this is RTBC :) But blocked on that other issue landing first, so Postponed it is for now.

Good job!

3085035-8.patch still applies cleanly, it just needed a re-test 😊

This looks great! Thanks for working on this. I can't wait to make use of this in JSON:API Extras.

Just a couple of questions.

1. Do we need to update the old change record? https://www.drupal.org/node/3079797
   Just saw #5

2. +++ b/core/modules/jsonapi/src/ResourceType/ResourceTypeBuildEvent.php
   @@ -48,12 +60,14 @@ protected function __construct($resource_type_name) {
   +  public static function createFromEntityTypeAndBundle(EntityTypeInterface $entity_type, $bundle, array $fields) {
   

   Do we need to default $fields to empty array?

Adding reviewer credit

Do we need to default $fields to empty array?

I don't think so. As this is a new class that hasn't been in a tagged release of Drupal yet, we don't need to do it for BC reasons. And I don't think we want to support an API where people don't pass this in explicitly. But if I'm wrong on that, please file a followup.

Meanwhile, pushed this to 8.8.x and above.

Setting to NW for updating the CR from #3037039: Create a public API for indicating resource types should not be exposed.

Also, tagging for both release notes and highlights, because #3037039: Create a public API for indicating resource types should not be exposed has both those tags. It could potentially be the same release note and/or highlight entry for both issues, so long as it's worded to encompass both.