Merge branch 'master' into feature/actions

# Conflicts:
#	config.toml

Author: sebprt

README.md

@@ -12,7 +12,11 @@
 - Edit theme design & layout in `themes/middleware`
 - Edit theme configuration in `config.toml`
 
-Local : `hugo server -D`
+Open local server : 
+- `hugo server -D`
+
+Build static files:
+- `hugo`
 
 ## Maintainers
 

config.toml

@@ -52,28 +52,34 @@ hasChildren = true
 
   [[menu.main]]
   parent = "Core concepts"
-  name = "Satellite"
+  name = "Satellites"
   url = "core-concept/satellite"
   weight = 1
 
   [[menu.main]]
   parent = "Core concepts"
   name = "Pipeline"
-  url = "core-concept/pipeline"
+  url = "core-concept/satellite/pipeline"
   weight = 2
 
   [[menu.main]]
   parent = "Core concepts"
   name = "Workflow"
-  url = "core-concept/workflow"
+  url = "core-concept/satellite/workflow"
   weight = 3
 
   [[menu.main]]
   parent = "Core concepts"
-  name = "Action"
-  url = "core-concept/action"
+  name = "HTTP Hook"
+  url = "core-concept/satellite/http-hook"
   weight = 4
 
+  [[menu.main]]
+  parent = "Core concepts"
+  name = "HTTP API"
+  url = "core-concept/satellite/http-api"
+  weight = 5
+
 [[menu.main]]
 weight = 3
 name = "Features"
@@ -186,16 +192,23 @@ hasChildren = true
    url = "connectivity/filtering"
    weight = 12
 
-[[menu.main]]
-name = "Actions"
-weight = 4
-hasChildren = true
+  [[menu.main]]
+   parent = "Connectivity"
+   name = "Batch"
+   url = "connectivity/batch"
+   weight = 13
 
   [[menu.main]]
-  parent = "Actions"
-  name = "Custom"
-  url = "action/custom"
-  weight = 1
+   parent = "Connectivity"
+   name = "Magento 2"
+   url = "connectivity/magento-2"
+   weight = 14
+
+  [[menu.main]]
+  parent = "Connectivity"
+  name = "Zoho CRM"
+  url = "connectivity/zoho"
+  weight = 15
 
 [params]
 logo = "logo-web.svg"

content/connectivity/akeneo/plugin.en.md

@@ -14,14 +14,14 @@ weight: 1
 - [Installation](#installation)
 - [Usage](#usage)
     - [Connecting to Akeneo](#connecting-to-akeneo)
-    - [Using the enterprise version](#using-the-enterprise-version)
     - [Building an extractor](#building-an-extractor)
     - [Building a lookup](#building-a-lookup)
     - [Building a conditional lookup](#building-a-conditional-lookup)
     - [Building a loader](#building-a-loader)
 - [Advanced Usage](#advanced-usage)
     - [Filtering your search](#filtering-your-search)
     - [Using ExpressionLanguage](#using-expressionlanguage)
+- [Available resources](#available-resources)
 --- 
 ## What is it ?
 
@@ -59,36 +59,29 @@ To retrieve these identifiers, you need to add a
 
 Warning: For the `api_url` option, you must remove the `/` at the end of your URL if there is one.
 
-### Using the enterprise edition
-
-The `enterprise` option allows you to use the enterprise features in Akeneo and uses the Enterprise client accordingly. By default, it's set to `false`.
-
-```yaml
-akeneo:
-  enterprise: true
-  # ...
-```
-
 ### Building an extractor
 
-In the configuration of your extractor, you must specify the `type` of resource you will be working on
-and which `method you want to use to retrieve your data.
-
-The list of available resources is quite long depend on the edition of your Akeneo (Enterprise, Growth or Community).
-
-For a Community Edition or Growth Edition, you can choose between this types of resources : `product`, `category`, `attribute`,
-`attributeOption`, `attributeGroup`, `family`, `productMediaFile`, `locale`, `channel`, `currency`, `measureFamily`,
-`associationType`, `familyVariant`, `productModel`.
-
-For an Enterprise Edition, you will be able to use in addition to the resources present in the Community Edition :
-`publishedProduct`, `productModelDraft`, `productDraft`, `asset`, `assetCategory`, `assetTag`, `referenceEntityRecord`,
-`referenceEntityAttribute`, `referenceEntityAttributeOption`, `referenceEntity`.
+In the configuration of your extractor, you must specify the `type` of resource (see [available-resources](#available-resources)) 
+you will be working on and which method you want to use to retrieve your data.
 
 For each resource, the following 3 methods are available :
 - `all` : retrieves all data from a table
 - `get` : retrieve a row from a table
 - `listPerPage` : retrieves a set number of data from a table
 
+Depending on the resource and the method used, different options are available in the YAML configuration :
+
+| Resource                             | Method      | Option(s) required            |
+|--------------------------------------|-------------|-------------------------------|
+| **All resources**                    | all         | _No options required_         |
+| **All resources**                    | get         | identifier                    |
+| **All resources**                    | listPerPage | _No options required_         |
+| **attributeOption**                  | all         | attribute_code                |
+| **attributeOption**                  | get         | attribute_code, code          |
+| **assetManager**                     | all         | asset_family_code             |
+| **assetManager**                     | get         | asset_family_code, asset_code |
+| **productMediaFile, assetMediaFile** | get         | file                          |
+
 ```yaml
 akeneo:
   extractor:
@@ -110,7 +103,8 @@ this is called a lookup.
 In the configuration of your lookup, you must specify the `type` of resource you will be working on
 and which `method` you want to use to retrieve your data.
 
-The list of available resources is quite long and depends on the edition of your Akeneo (Enterprise, Growth or Community).
+You can retrieve the list of available resources [here](#available-resources).
+
 The options available are the same as for the [loader](#building-a-loader).
 
 The `merge` option allows you to add data to your dataset, in a sense merging your actual dataset with your new data.
@@ -171,19 +165,8 @@ akeneo:
 
 ### Building a loader
 
-In the configuration of your loader, you must specify the `type` of resource you are going to write
-and which `method` you want to use to insert your data.
-
-The list of available resources is quite long and dépends on your Akeneo edition (Enterprise, Growth or Community).
-
-For a Community Edition or Growth Edition, you can choose between these types of resources: `product`, `category`, `attribute`,
-`attributeOption`, `attributeGroup`, `family`, `productMediaFile`, `locale`, `channel`, `currency`, `measureFamily`,
-`associationType`, `familyVariant`, `productModel`.
-
-For an Enterprise Edition, you will be able to use in addition to the resources present in the Community Edition:
-`publishedProduct`,
-`productModelDraft`, `productDraft`, `asset`, `assetCategory`, `assetTag`, `referenceEntityRecord`, `referenceEntityAttribute`,
-`referenceEntityAttributeOption`, `referenceEntity`.
+In the configuration of your loader, you must specify the `type` of resource (see [available-resources](#available-resources)) 
+you are going to write and which `method` you want to use to insert your data.
 
 For each resource, the following 4 methods are available :
 
@@ -192,13 +175,24 @@ For each resource, the following 4 methods are available :
 - `upsertList`: will try to update a resources list, otherwise the resources will be created
 - `delete`: delete a resource from the table
 
+Depending on the resource and the method used, different options are available in the YAML configuration :
+
+| Resource                           | Method     | Option(s) required                                 |
+|------------------------------------|------------|----------------------------------------------------|
+| **All resources**                  | upsert     | code                                               |
+| **All resources**                  | upsertList | _No options required_                              |
+| **referenceEntityRecord**          | upsert     | reference_entity, code                             |
+| **referenceEntityRecord**          | upsertList | reference_entity                                   |
+| **referenceEntityAttributeOption** | upsert     | reference_entity, reference_entity_attribute, code |
+| **referenceEntityAttributeOption** | upsertList | reference_entity, reference_entity_attribute       |
+| **attributeOption**                | upsert     | attribute_code, code                               |
+| **attributeOption**                | upsertList | attribute_code                                     |
+
 ```yaml
 akeneo:
   loader:
     type: products
     method: create
-  logger:
-    type: stderr
   client:
     api_url: 'http://demo.akeneo.com/'
     client_id: '414yc7d9mnk044ko4wswgw80o8ssw80gssos488kk8ogss40ko'
@@ -248,3 +242,32 @@ akeneo:
     - 'Kiboko\Component\ExpressionLanguage\Akeneo\AkeneoFilterProvider'
   # ...
 ```
+
+## Available resources
+
+| Resources                          | Akeneo's Edition(s)           |
+|------------------------------------|-------------------------------|
+| **product**                        | Community, Growth, Enterprise |
+| **category**                       | Community, Growth, Enterprise |
+| **attribute**                      | Community, Growth, Enterprise |
+| **attributeOption**                | Community, Growth, Enterprise |
+| **attributeGroup**                 | Community, Growth, Enterprise |
+| **family**                         | Community, Growth, Enterprise |
+| **productMediaFile**               | Community, Growth, Enterprise |
+| **locale**                         | Community, Growth, Enterprise |
+| **channel**                        | Community, Growth, Enterprise |
+| **currency**                       | Community, Growth, Enterprise |
+| **measureFamily**                  | Community, Growth, Enterprise |
+| **associationType**                | Community, Growth, Enterprise |
+| **familyVariant**                  | Community, Growth, Enterprise |
+| **productModel**                   | Community, Growth, Enterprise |
+| **publishedProduct**               | Enterprise                    |
+| **productModelDraft**              | Enterprise                    |
+| **productDraft**                   | Enterprise                    |
+| **asset**                          | Enterprise                    |
+| **assetCategory**                  | Enterprise                    |
+| **assetTag**                       | Enterprise                    |
+| **referenceEntityRecord**          | Enterprise                    |
+| **referenceEntityAttribute**       | Enterprise                    |
+| **referenceEntityAttributeOption** | Enterprise                    |
+| **referenceEntity**                | Enterprise                    |

content/connectivity/batch/_index.en.md

@@ -0,0 +1,98 @@
+---
+title: "Batch"
+date: 2023-06-22T12:00:02+02:00
+draft: false
+type: "plugins"
+description: "Fork a single line into multiple lines, or merge multiple lines into one."
+weight: 13
+---
+
+- [What is it?](#what-is-it)
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Forking a line](#forking-a-line)
+    - [Merging multiple lines](#merging-multiple-lines)
+---
+
+## What is it?
+
+The Batch plugin can split a single line of data into multiple ones, or can merge multiple lines into a single one.
+
+## Installation
+
+This plugin is already integrated into the Satellite package, so you can’t require it with composer.
+
+## Usage
+
+### Forking a line
+
+`fork` splits data into multiple lines.
+
+In the following example, we have one line containing 2 fields: an `id`, and `images` which contains multiple values.
+Instead we want to have multiple lines, each containing a single `image` along with the `id`.
+
+Our example input looks like this:
+```json
+[{"images": ["one.jpg", "two.jpg", "three.jpg"], "id": 15}]
+```
+
+We'll use the "fork" option to split the lines for each value under `images`:
+
+{{< tabs name="fork" >}}
+
+{{< tab name="YAML configuration" codelang="yaml" >}}
+batch:
+  fork:
+    foreach: '@=input["images"]'
+    do: '@={ id: input["id"], image: item }'
+{{< /tab >}}
+
+{{< tab name="interpreted code" codelang="php" >}}
+$results = [];
+foreach ($input["images"] as $key => $item) {
+    $results[] = ["id" => $input["id"], "image" => $item];
+}
+{{< /tab >}}
+{{< /tabs >}}
+
+The result will be: 
+```json
+[{"id": 15, "image": "one.jpg"}]
+[{"id": 15, "image": "two.jpg"}]
+[{"id": 15, "image": "three.jpg"}]
+```
+
+### Merging multiple lines
+
+`merge` concatenates many lines traversing the pipeline into fewer lines.
+
+This can be useful if the targeted API can handle many batches of data in a single payload, like Akeneo for example.
+
+Our example input looks like this:
+```json
+[{"foo": "bar"}]
+[{"lorem": "ipsum"}]
+[{"ga": "bu"}]
+[{"zo": "meu"}]
+[{"bla": "bli"}]
+```
+
+We'll use the "merge" option. `size` dictates the maximum number of lines to concatenate:
+
+{{< tabs name="fork" >}}
+
+{{< tab name="YAML configuration" codelang="yaml" >}}
+batch:
+  merge:
+    size: 2
+{{< /tab >}}
+{{< /tabs >}}
+
+When the number of item reaches `size`, the merge will be applied to the next lines, and so on.
+
+The output will be:
+```json
+[{"foo": "bar"},{"lorem": "ipsum"}]
+[{"ga": "bu"},{"zo": "meu"}]
+[{"bla": "bli"}]
+```

content/connectivity/custom/lookup_mapper.en.md

@@ -0,0 +1,35 @@
+---
+title: "Lookup mapper"
+date: 2023-07-31T12:07:47+02:00
+draft: false
+type: "plugins"
+icon: "ti-settings"
+description: "Learn how to write a custom mapper"
+weight: 1
+---
+
+A lookup mapper is a class that implements `Kiboko\Contract\Mapping\CompiledMapperInterface`.
+
+Its purpose is to merge the result of the lookup back into your line.
+
+`$output` is your line, and `$input` is the result of the lookup.
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace Acme\Custom;
+
+use Kiboko\Contract\Mapping\CompiledMapperInterface;
+
+class LookupMapper implements CompiledMapperInterface
+{
+    public function __invoke($input, $output = null)
+    {
+        $output['actual_customer_id'] = $input['id'];
+
+        return $output;
+    }
+}
+```