Итерация и манипуляция значениями полей
Добавление мета-директив в схему GraphQL для итерации и манипуляции элементами значений полей типа array и object:
@underArrayItem@underJSONObjectProperty@underEachArrayItem@underEachJSONObjectProperty@objectClone
@underArrayItem
@underArrayItem заставляет вложенную директиву применяться к конкретному элементу массива.
В запросе ниже только первый элемент массива с именами категорий преобразуется в верхний регистр:
query {
posts {
categoryNames
@underArrayItem(index: 0)
@strUpperCase
}
}...производя:
{
"data": {
"posts": {
"categoryNames": [
"NEWS",
"sports"
]
}
}
}@underJSONObjectProperty
@underJSONObjectProperty заставляет вложенную директиву получать запись из запрошенного объекта JSON.
Эта директива особенно полезна для извлечения и манипуляции нужными данными после обращения к внешнему API, который, скорее всего, будет иметь универсальный тип JSONObject (как при использовании функционального поля _sendJSONObjectItemHTTPRequest из расширения HTTP Client).
В запросе ниже мы получаем объект JSON из WP REST API и используем @underJSONObjectProperty для манипуляции свойством type ответа, преобразуя его в верхний регистр:
query {
postData: _sendJSONObjectItemHTTPRequest(input: {
url: "https://newapi.getpop.org/wp-json/wp/v2/posts/1/?_fields=id,type,title,date"
})
@underJSONObjectProperty(by: { key: "type" })
@strUpperCase
}Это произведёт:
{
"data": {
"postData": {
"id": 1,
"date": "2019-08-02T07:53:57",
"type": "POST",
"title": {
"rendered": "Hello world!"
}
}
}
}Помимо получения "key" для указания на свойство, находящееся на первом уровне объекта JSON, эта директива также может получать "path" для навигации внутри структуры объекта, используя . в качестве разделителя между уровнями.
В запросе ниже конечная точка WP REST API для записи предоставляет свойство "title.rendered". Мы можем перейти к этому подэлементу и преобразовать его в регистр заголовка:
query {
postData: _sendJSONObjectItemHTTPRequest(input: {
url: "https://newapi.getpop.org/wp-json/wp/v2/posts/1/?_fields=id,type,title,date"
})
@underJSONObjectProperty(by: { path: "title.rendered" })
@strTitleCase
}Это произведёт:
{
"data": {
"postData": {
"id": 1,
"date": "2019-08-02T07:53:57",
"type": "post",
"title": {
"rendered": "HELLO WORLD!"
}
}
}
}@underEachArrayItem
@underEachArrayItem итерирует элементы массива из некоторого поля в запрошенной сущности и выполняет вложенную(-ые) директиву(-ы) для каждого из них.
Например, поле Post.categoryNames имеет тип [String]. Используя @underEachArrayItem, мы можем итерировать имена категорий и применять к ним директиву @strTranslate.
В этом запросе категории записи переводятся с английского на французский:
query {
posts {
id
title
categoryNames
@underEachArrayItem
@strTranslate(
from: "en",
to: "fr"
)
}
}...производя:
{
"data": {
"posts": [
{
"id": 662,
"title": "Explaining the privacy policy",
"categoryNames": [
"Non classé"
]
},
{
"id": 28,
"title": "HTTP caching improves performance",
"categoryNames": [
"Avancé"
]
},
{
"id": 25,
"title": "Public or Private API mode, for extra security",
"categoryNames": [
"Ressource",
"Blog",
"Avancé"
]
}
]
}
}@underEachArrayItem может передавать как индекс, так и значение итерируемого элемента в качестве динамической переменной своим вложенным директивам через аргументы директивы passIndexOnwardsAs и passValueOnwardsAs.
Этот запрос демонстрирует использование динамических переменных $index и $value:
{
_echo(value: ["first", "second", "third"])
@underEachArrayItem(
passIndexOnwardsAs: "index"
passValueOnwardsAs: "value"
)
@applyField(
name: "_echo"
arguments: {
value: {
index: $index,
value: $value
}
},
setResultInResponse: true
)
}Результат:
{
"data": {
"_echo": [
{
"index": 0,
"value": "first"
},
{
"index": 1,
"value": "second"
},
{
"index": 2,
"value": "third"
}
]
}
}@underEachArrayItem также может ограничивать позиции массива для итерации через параметр filter->by, который принимает либо запись include, либо exclude.
Этот запрос:
{
including: _echo([
"first",
"second",
"third"
])
@underEachArrayItem(
filter: {
by: {
include: [0, 2]
}
}
)
@strUpperCase
excluding: _echo([
"first",
"second",
"third"
])
@underEachArrayItem(
filter: {
by: {
exclude: [0, 2]
}
}
)
@strUpperCase
}...производит:
{
"data": {
"including": [
"FIRST",
"second",
"THIRD"
],
"excluding": [
"first",
"SECOND",
"third"
]
}
}@underEachJSONObjectProperty
@underEachJSONObjectProperty аналогична @underEachArrayItem, но работает с элементами JSONObject.
В этом запросе мы итерируем все записи объекта JSON и заменяем любую запись null пустой строкой:
{
_echo(
value: {
first: "hello",
second: "world",
third: null
}
)
@underEachJSONObjectProperty
@default(value: "")
}...производя:
{
"data": {
"_echo": {
"first": "hello",
"second": "world",
"third": ""
}
}
}@underEachJSONObjectProperty может передавать ключ и значение, по которым выполняется итерация, в качестве динамической переменной своим вложенным директивам через аргументы директивы passKeyOnwardsAs и passValueOnwardsAs.
Этот запрос демонстрирует использование динамических переменных $key и $value:
{
_echo(value: {
uno: "first",
dos: "second",
tres: "third"
})
@underEachJSONObjectProperty(
passKeyOnwardsAs: "key"
passValueOnwardsAs: "value"
)
@applyField(
name: "_echo"
arguments: {
value: {
key: $key,
value: $value
}
},
setResultInResponse: true
)
}Результат:
{
"data": {
"_echo": {
"uno": {
"key": "uno",
"value": "first"
},
"dos": {
"key": "dos",
"value": "second"
},
"tres": {
"key": "tres",
"value": "third"
}
}
}
}@underEachJSONObjectProperty также может ограничивать ключи объекта JSON для итерации через параметр filter->by, который принимает либо запись includeKeys, либо excludeKeys.
Этот запрос:
{
includingKeys: _echo(value: {
uno: "first",
dos: "second",
tres: "third"
})
@underEachJSONObjectProperty(
filter: {
by: {
includeKeys: ["uno", "tres"]
}
}
)
@strUpperCase
excludingKeys: _echo(value: {
uno: "first",
dos: "second",
tres: "third"
})
@underEachJSONObjectProperty(
filter: {
by: {
excludeKeys: ["uno", "tres"]
}
}
)
@strUpperCase
}...производит:
{
"data": {
"includingKeys": {
"uno": "FIRST",
"dos": "second",
"tres": "THIRD"
},
"excludingKeys": {
"uno": "first",
"dos": "SECOND",
"tres": "third"
}
}
}@objectClone
Объекты JSON могут быть доступны по ссылке в резолверах полей (а не путём копирования/дублирования объекта). В этом случае, когда объект JSON изменяется, это изменение будет видно всем полям, которые обращаются к данному объекту JSON.
Так обстоит дело с полем Block.attributes:
{
posts {
blocks(filterBy: { include: "core/heading" } ) {
attributes
}
}
}...что производит:
{
"data": {
"posts": [
{
"blocks": [
{
"attributes": {
"content": "Image Block (Full width)",
"level": 2
}
},
{
"attributes": {
"content": "Gallery Block",
"level": 2
}
}
]
}
]
}
}В запросе ниже originalAttributes просто извлекает атрибуты, тогда как transformedAttributes также переведёт свойство content на французский язык:
{
posts {
blocks(filterBy: { include: "core/heading" } ) {
originalAttributes: attributes
transformedAttributes: attributes
@underJSONObjectProperty(by: { key: "content" })
@strTranslate(to: "fr")
}
}
}Однако, поскольку запрошенная сущность Block ссылается на один и тот же объект JSON в originalAttributes и transformedAttributes, преобразования, выполненные последним полем, также затронут первое поле (это не зависит от порядка их появления в запросе).
В результате оба поля переводятся на французский язык:
{
"data": {
"posts": [
{
"blocks": [
{
"originalAttributes": {
"content": "Bloc d'image (pleine largeur)",
"level": 2
},
"transformedAttributes": {
"content": "Bloc d'image (pleine largeur)",
"level": 2
}
},
{
"originalAttributes": {
"content": "Bloc Galerie",
"level": 2
},
"transformedAttributes": {
"content": "Bloc Galerie",
"level": 2
}
}
]
}
]
}
}Мы можем избежать этой проблемы, добавив директиву @objectClone к полю transformedAttributes, чтобы изменения выполнялись над клонированным объектом JSON:
{
posts {
blocks(filterBy: { include: "core/heading" } ) {
originalAttributes: attributes
transformedAttributes: attributes
@objectClone
@underJSONObjectProperty(by: { key: "content" })
@strTranslate(to: "fr")
}
}
}...producing:
{
"data": {
"posts": [
{
"blocks": [
{
"originalAttributes": {
"content": "Image Block (Full width)",
"level": 2
},
"transformedAttributes": {
"content": "Bloc d'image (pleine largeur)",
"level": 2
}
},
{
"originalAttributes": {
"content": "Gallery Block",
"level": 2
},
"transformedAttributes": {
"content": "Bloc Galerie",
"level": 2
}
}
]
}
]
}
}Further examples
In this query, @underEachArrayItem wraps @underJSONObjectProperty, which itself wraps @strUpperCase, transforming the "title.rendered" property into upper case, for the multiple post entries obtained via the WP REST API:
query {
postListData: _sendJSONObjectCollectionHTTPRequest(
url: "https://newapi.getpop.org/wp-json/wp/v2/posts/?per_page=3&_fields=id,type,title,date"
)
@underEachArrayItem
@underJSONObjectProperty(by: { path: "title.rendered" })
@strUpperCase
}...producing:
{
"data": {
"postListData": [
{
"id": 1692,
"date": "2022-04-26T10:10:08",
"type": "post",
"title": {
"rendered": "MY BLOGROLL"
}
},
{
"id": 1657,
"date": "2020-12-21T08:24:18",
"type": "post",
"title": {
"rendered": "A TALE OF TWO CITIES – TEASER"
}
},
{
"id": 1499,
"date": "2019-08-08T02:49:36",
"type": "post",
"title": {
"rendered": "COPE WITH WORDPRESS: POST DEMO CONTAINING PLENTY OF BLOCKS"
}
}
]
}
}