Merge pull request PrestaShop#47 from jolelievre/product-api

Improve Product API mapping

Author: jolelievre

README.md

@@ -19,10 +19,49 @@ Required only for development:
 ## Installation
 
 Install all dependencies.
-```
+```bash
 composer install
 ```
 
+## Run tests locally
+
+### Initialize tmp shop environment
+
+First initialize the test environment with this command that will install a PrestaShop shop in a temporary folder so that the integration tests can run:
+
+```bash
+composer create-test-db
+```
+
+### Customize tmp shop environment
+
+You can define custom values when setting up the tmp shop:
+
+```bash
+composer clear-test-cache
+composer setup-local-tests -- [arguments]
+  arguments:
+    --force-clone Force cloning the repository even if cloned repository is detected (when no repository is detected the clone is automatic)
+    --build-assets Force building assets even if they are already built (when no assets are detected the build is automatic)
+    --build-db Force building DB by installing the default shop data (when no DB is detected the DB shop is installed automatically)
+    --update-local-parameters Force copying parameters from the `test/local-parameters` folder (when no parameter file is detectec they are automatically copied)
+    --force Force all the previous arguments
+    --core-branch Use a specific branch, you can use a branch from the original repository (ex: `develop`, `9.0.x`, ...) or from a fork (ex: `myfork:my-dev-branch`) (By default branch develop is used)
+```
+
+Example:
+```bash
+composer setup-local-tests -- --force --core-branch=jolelievre:product-api
+```
+
+### Run tests
+
+Then you can run the tests with this command:
+
+```bash
+composer run-module-tests
+```
+
 ## Contributing
 
 PrestaShop modules are open source extensions to the [PrestaShop e-commerce platform][prestashop]. Everyone is welcome and even encouraged to contribute with their own improvements!

config.xml

@@ -3,9 +3,9 @@
     <name>ps_apiresources</name>
     <displayName><![CDATA[PrestaShop API Resources]]></displayName>
     <version><![CDATA[0.1.0]]></version>
-    <description><![CDATA[Includes the resources allowing using the API for the PrestaShop domain.]]></description>
+    <description><![CDATA[Includes the resources allowing using the API for the PrestaShop domain, all endpoints are based on CQRS commands/queries from the Core and we APIPlatform framework is used as a base.]]></description>
     <author><![CDATA[PrestaShop]]></author>
     <tab><![CDATA[administration]]></tab>
     <is_configurable>0</is_configurable>
     <need_instance>0</need_instance>
-</module>
+</module>

src/ApiPlatform/Resources/CustomerGroup.php

@@ -25,6 +25,7 @@
 
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\ApiResource;
+use PrestaShop\Decimal\DecimalNumber;
 use PrestaShop\PrestaShop\Core\Domain\Customer\Group\Command\AddCustomerGroupCommand;
 use PrestaShop\PrestaShop\Core\Domain\Customer\Group\Command\DeleteCustomerGroupCommand;
 use PrestaShop\PrestaShop\Core\Domain\Customer\Group\Command\EditCustomerGroupCommand;
@@ -106,7 +107,7 @@ class CustomerGroup
     #[LocalizedValue]
     public array $localizedNames;
 
-    public float $reductionPercent;
+    public DecimalNumber $reductionPercent;
 
     public bool $displayPriceTaxExcluded;
 

src/ApiPlatform/Resources/Product/Product.php

@@ -24,6 +24,7 @@
 
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\ApiResource;
+use PrestaShop\Decimal\DecimalNumber;
 use PrestaShop\PrestaShop\Core\Domain\Product\Command\AddProductCommand;
 use PrestaShop\PrestaShop\Core\Domain\Product\Command\DeleteProductCommand;
 use PrestaShop\PrestaShop\Core\Domain\Product\Command\UpdateProductCommand;
@@ -102,6 +103,116 @@ class Product
     #[LocalizedValue]
     public array $descriptions;
 
+    #[LocalizedValue]
+    public array $shortDescriptions;
+
+    #[LocalizedValue]
+    public array $tags;
+
+    public DecimalNumber $priceTaxExcluded;
+
+    public DecimalNumber $priceTaxIncluded;
+
+    public DecimalNumber $ecotaxTaxExcluded;
+
+    public DecimalNumber $ecotaxTaxIncluded;
+
+    public int $taxRulesGroupId;
+
+    public bool $onSale;
+
+    public DecimalNumber $wholesalePrice;
+
+    public DecimalNumber $unitPriceTaxExcluded;
+
+    public DecimalNumber $unitPriceTaxIncluded;
+
+    public string $unity;
+
+    public DecimalNumber $unitPriceRatio;
+
+    public string $visibility;
+
+    public bool $availableForOrder;
+
+    public bool $onlineOnly;
+
+    public bool $showPrice;
+
+    public string $condition;
+
+    public bool $showCondition;
+
+    public int $manufacturerId;
+
+    public string $isbn;
+
+    public string $upc;
+
+    public string $gtin;
+
+    public string $mpn;
+
+    public string $reference;
+
+    public DecimalNumber $width;
+
+    public DecimalNumber $height;
+
+    public DecimalNumber $depth;
+
+    public DecimalNumber $weight;
+
+    public DecimalNumber $additionalShippingCost;
+
+    #[ApiProperty(openapiContext: ['type' => 'array', 'items' => ['type' => 'integer'], 'example' => [1, 3]])]
+    public array $carrierReferenceIds;
+
+    public int $deliveryTimeNoteType;
+
+    #[LocalizedValue]
+    public array $deliveryTimeInStockNotes;
+
+    #[LocalizedValue]
+    public array $deliveryTimeOutOfStockNotes;
+
+    #[LocalizedValue]
+    public array $metaTitles;
+
+    #[LocalizedValue]
+    public array $metaDescriptions;
+
+    #[LocalizedValue]
+    public array $linkRewrites;
+
+    public string $redirectType;
+
+    public ?int $redirectTarget = null;
+
+    public int $packStockType;
+
+    public int $outOfStockType;
+
+    public int $quantity;
+
+    public int $minimalQuantity;
+
+    public int $lowStockThreshold;
+
+    public bool $lowStockAlertEnabled;
+
+    #[LocalizedValue]
+    public array $availableNowLabels;
+
+    public string $location;
+
+    #[LocalizedValue]
+    public array $availableLaterLabels;
+
+    public ?\DateTimeImmutable $availableDate = null;
+
+    public string $coverThumbnailUrl;
+
     #[ApiProperty(openapiContext: ['type' => 'array', 'items' => ['type' => 'integer'], 'example' => [1, 3]])]
     public array $shopIds;
 
@@ -110,12 +221,72 @@ class Product
         '[_context][langId]' => '[displayLanguageId]',
         '[basicInformation][localizedNames]' => '[names]',
         '[basicInformation][localizedDescriptions]' => '[descriptions]',
+        '[basicInformation][localizedShortDescriptions]' => '[shortDescriptions]',
+        '[basicInformation][localizedTags]' => '[tags]',
+        '[pricesInformation][price]' => '[priceTaxExcluded]',
+        '[pricesInformation][priceTaxIncluded]' => '[priceTaxIncluded]',
+        '[pricesInformation][ecotax]' => '[ecotaxTaxExcluded]',
+        '[pricesInformation][ecotaxTaxIncluded]' => '[ecotaxTaxIncluded]',
+        '[pricesInformation][taxRulesGroupId]' => '[taxRulesGroupId]',
+        '[pricesInformation][onSale]' => '[onSale]',
+        '[pricesInformation][wholesalePrice]' => '[wholesalePrice]',
+        '[pricesInformation][unitPrice]' => '[unitPriceTaxExcluded]',
+        '[pricesInformation][unitPriceTaxIncluded]' => '[unitPriceTaxIncluded]',
+        '[pricesInformation][unity]' => '[unity]',
+        '[pricesInformation][unitPriceRatio]' => '[unitPriceRatio]',
+        '[options][visibility]' => '[visibility]',
+        '[options][availableForOrder]' => '[availableForOrder]',
+        '[options][onlineOnly]' => '[onlineOnly]',
+        '[options][showPrice]' => '[showPrice]',
+        '[options][condition]' => '[condition]',
+        '[options][showCondition]' => '[showCondition]',
+        '[options][manufacturerId]' => '[manufacturerId]',
+        '[details][isbn]' => '[isbn]',
+        '[details][upc]' => '[upc]',
+        '[details][gtin]' => '[gtin]',
+        '[details][mpn]' => '[mpn]',
+        '[details][reference]' => '[reference]',
+        '[shippingInformation][width]' => '[width]',
+        '[shippingInformation][height]' => '[height]',
+        '[shippingInformation][depth]' => '[depth]',
+        '[shippingInformation][weight]' => '[weight]',
+        '[shippingInformation][additionalShippingCost]' => '[additionalShippingCost]',
+        '[shippingInformation][carrierReferences]' => '[carrierReferenceIds]',
+        '[shippingInformation][deliveryTimeNoteType]' => '[deliveryTimeNoteType]',
+        '[shippingInformation][localizedDeliveryTimeInStockNotes]' => '[deliveryTimeInStockNotes]',
+        '[shippingInformation][localizedDeliveryTimeOutOfStockNotes]' => '[deliveryTimeOutOfStockNotes]',
+        '[productSeoOptions][localizedMetaTitles]' => '[metaTitles]',
+        '[productSeoOptions][localizedMetaDescriptions]' => '[metaDescriptions]',
+        '[productSeoOptions][localizedLinkRewrites]' => '[linkRewrites]',
+        '[productSeoOptions][redirectType]' => '[redirectType]',
+        '[productSeoOptions][redirectTarget][id]' => '[redirectTarget]',
+        '[stockInformation][packStockType]' => '[packStockType]',
+        '[stockInformation][outOfStockType]' => '[outOfStockType]',
+        '[stockInformation][quantity]' => '[quantity]',
+        '[stockInformation][minimalQuantity]' => '[minimalQuantity]',
+        '[stockInformation][lowStockThreshold]' => '[lowStockThreshold]',
+        '[stockInformation][lowStockAlertEnabled]' => '[lowStockAlertEnabled]',
+        '[stockInformation][localizedAvailableNowLabels]' => '[availableNowLabels]',
+        '[stockInformation][localizedAvailableLaterLabels]' => '[availableLaterLabels]',
+        '[stockInformation][location]' => '[location]',
+        '[stockInformation][availableDate]' => '[availableDate]',
     ];
 
     public const UPDATE_MAPPING = [
         '[_context][shopConstraint]' => '[shopConstraint]',
         '[type]' => '[productType]',
         '[names]' => '[localizedNames]',
         '[descriptions]' => '[localizedDescriptions]',
+        '[shortDescriptions]' => '[localizedShortDescriptions]',
+        '[metaTitles]' => '[localizedMetaTitles]',
+        '[metaDescriptions]' => '[localizedMetaDescriptions]',
+        '[linkRewrites]' => '[localizedLinkRewrites]',
+        '[deliveryTimeInStockNotes]' => '[localizedDeliveryTimeInStockNotes]',
+        '[deliveryTimeOutOfStockNotes]' => '[localizedDeliveryTimeOutOfStockNotes]',
+        '[availableNowLabels]' => '[localizedAvailableNowLabels]',
+        '[availableLaterLabels]' => '[localizedAvailableLaterLabels]',
+        '[priceTaxExcluded]' => '[price]',
+        '[unitPriceTaxExcluded]' => '[unitPrice]',
+        '[ecotaxTaxExcluded]' => '[ecotax]',
     ];
 }

src/ApiPlatform/Resources/Product/ProductList.php

@@ -25,6 +25,7 @@
 
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\ApiResource;
+use PrestaShop\Decimal\DecimalNumber;
 use PrestaShop\PrestaShop\Adapter\Product\Grid\Data\Factory\ProductGridDataFactoryDecorator;
 use PrestaShop\PrestaShop\Core\Domain\Product\Exception\ProductNotFoundException;
 use PrestaShop\PrestaShop\Core\Domain\Shop\Exception\ShopAssociationNotFound;
@@ -41,7 +42,8 @@
             scopes: ['product_read'],
             ApiResourceMapping: [
                 '[id_product]' => '[productId]',
-                '[final_price_tax_excluded]' => '[price]',
+                '[price_tax_excluded_decimal_value]' => '[priceTaxExcluded]',
+                '[price_tax_included_decimal_value]' => '[priceTaxIncluded]',
             ],
             gridDataFactory: ProductGridDataFactoryDecorator::class,
             filtersClass: ProductFilters::class,
@@ -65,7 +67,9 @@ class ProductList
 
     public int $quantity;
 
-    public string $price;
+    public DecimalNumber $priceTaxExcluded;
+
+    public DecimalNumber $priceTaxIncluded;
 
     public string $category;
 }