@fleetbase/storefront-engine 0.2.4 → 0.2.6

package/server/src/Models/Product.php

@@ -3,32 +3,38 @@
 namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Casts\Json;
+use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Models\Category;
 use Fleetbase\Models\File;
 use Fleetbase\Models\User;
-use Fleetbase\FleetOps\Support\Utils;
-use Fleetbase\Traits\HasMetaAttributes;
-use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasMetaAttributes;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\Searchable;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
+use Milon\Barcode\Facades\DNS2DFacade as DNS2D;
 use Spatie\Sluggable\HasSlug;
 use Spatie\Sluggable\SlugOptions;
-use Milon\Barcode\Facades\DNS2DFacade as DNS2D;
 
 class ProductStatus
 {
     public const AVAILABLE = 'available';
-    public const DRAFT = 'draft';
+    public const DRAFT     = 'draft';
 }
 
 class Product extends StorefrontModel
 {
-    use HasUuid, HasPublicid, HasApiModelBehavior, HasMetaAttributes, HasSlug, Searchable;
+    use HasUuid;
+    use HasPublicid;
+    use HasApiModelBehavior;
+    use HasMetaAttributes;
+    use HasSlug;
+    use Searchable;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -42,7 +48,7 @@ class Product extends StorefrontModel
     protected $table = 'products';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -78,7 +84,7 @@ class Product extends StorefrontModel
         'is_recommended',
         'can_pickup',
         'status',
-        'slug'
+        'slug',
     ];
 
     /**
@@ -87,27 +93,27 @@ class Product extends StorefrontModel
      * @var array
      */
     protected $casts = [
-        'is_service' => 'boolean',
-        'is_bookable' => 'boolean',
-        'is_on_sale' => 'boolean',
-        'is_available' => 'boolean',
+        'is_service'     => 'boolean',
+        'is_bookable'    => 'boolean',
+        'is_on_sale'     => 'boolean',
+        'is_available'   => 'boolean',
         'is_recommended' => 'boolean',
-        'can_pickup' => 'boolean',
-        'tags' => 'array',
-        'meta' => Json::class,
-        'translations' => Json::class,
-        'youtube_urls' => Json::class
+        'can_pickup'     => 'boolean',
+        'tags'           => 'array',
+        'meta'           => Json::class,
+        'translations'   => Json::class,
+        'youtube_urls'   => Json::class,
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
     protected $appends = ['primary_image_url', 'store_id', 'meta_array'];
 
     /**
-     * Attributes that is filterable on this model
+     * Attributes that is filterable on this model.
      *
      * @var array
      */
@@ -230,9 +236,9 @@ class Product extends StorefrontModel
 
         foreach ($this->meta as $key => $value) {
             $_meta[] = [
-                'key' => Str::snake($key),
+                'key'   => Str::snake($key),
                 'label' => Utils::smartHumanize($key),
-                'value' => $value
+                'value' => $value,
             ];
         }
 
@@ -244,9 +250,9 @@ class Product extends StorefrontModel
      */
     public function getPrimaryImageUrlAttribute()
     {
-        $default = $this->primaryImage->url ?? null;
+        $default   = $this->primaryImage->url ?? null;
         $secondary = $this->files->first()->url ?? null;
-        $backup = 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/image-file-icon.png';
+        $backup    = 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/image-file-icon.png';
 
         return $default ?? $secondary ?? $backup;
     }
@@ -262,7 +268,7 @@ class Product extends StorefrontModel
     }
 
     /**
-     * Set the price as only numbers
+     * Set the price as only numbers.
      *
      * @void
      */
@@ -272,7 +278,7 @@ class Product extends StorefrontModel
     }
 
     /**
-     * Set the sale price as only numbers
+     * Set the sale price as only numbers.
      *
      * @void
      */
@@ -281,15 +287,131 @@ class Product extends StorefrontModel
         $this->attributes['sale_price'] = Utils::numbersOnly($value);
     }
 
+    /**
+     * Sets or updates addon categories for the product.
+     *
+     * This function iterates over each addon category in the given array. If the category exists (identified by UUID),
+     * it updates the existing category. Otherwise, it creates a new category and adds it to the product.
+     *
+     * @param array $addonCategories An array of addon categories data. Each category should have keys like 'uuid',
+     *                               'excluded_addons', 'max_selectable', and 'is_required'.
+     *
+     * @return Product returns the instance of the Product for method chaining
+     */
+    public function setAddonCategories(array $addonCategories = []): Product
+    {
+        foreach ($addonCategories as $addonCategory) {
+            // get uuid if set
+            $id = data_get($addonCategory, 'uuid');
+
+            // update product addon category
+            if (Str::isUuid($id)) {
+                ProductAddonCategory::where('uuid', $id)->update([
+                    'excluded_addons' => data_get($addonCategory, 'excluded_addons'),
+                    'max_selectable'  => data_get($addonCategory, 'max_selectable'),
+                    'is_required'     => data_get($addonCategory, 'is_required'),
+                ]);
+                continue;
+            }
+
+            // create new product addon category
+            $productAddonCategory = ProductAddonCategory::create([
+                'product_uuid'    => $this->uuid,
+                'category_uuid'   => data_get($addonCategory, 'category_uuid'),
+                'excluded_addons' => data_get($addonCategory, 'excluded_addons'),
+                'max_selectable'  => data_get($addonCategory, 'max_selectable'),
+                'is_required'     => data_get($addonCategory, 'is_required'),
+            ]);
+
+            // insert to hasmany relation
+            $this->addonCategories->push($productAddonCategory);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Sets or updates product variants for the product.
+     *
+     * Iterates through each variant in the provided array. If the variant exists (identified by UUID), it updates
+     * the variant with new values. If it doesn't exist, a new variant is created. Also handles the setting or
+     * updating of product variant options.
+     *
+     * @param array $variants An array of product variants data. Each variant should have keys like 'uuid', 'name',
+     *                        'description', 'translations', 'meta', 'is_multiselect', 'is_required', 'min', 'max',
+     *                        and 'options'.
+     *
+     * @return Product returns the instance of the Product for method chaining
+     */
+    public function setProductVariants(array $variants = []): Product
+    {
+        foreach ($variants as $variant) {
+            $id = data_get($variant, 'uuid');
+
+            if (Str::isUuid($id)) {
+                // Update the existing product variant with new values if any changed
+                ProductVariant::where('uuid', $id)->update([
+                    'name'           => data_get($variant, 'name'),
+                    'description'    => data_get($variant, 'name'),
+                    'translations'   => data_get($variant, 'translations', []),
+                    'meta'           => data_get($variant, 'meta', []),
+                    'is_multiselect' => data_get($variant, 'is_multiselect'),
+                    'is_required'    => data_get($variant, 'is_required'),
+                    'min'            => data_get($variant, 'min'),
+                    'max'            => data_get($variant, 'max'),
+                ]);
+
+                // Update product variant options if applicable
+                if (is_array($variant['options'])) {
+                    foreach ($variant['options'] as $option) {
+                        $optionId = data_get($option, 'uuid');
+
+                        if (Str::isUuid($optionId)) {
+                            // make sure additional cost is always numbers only
+                            if (isset($option['additional_cost'])) {
+                                $option['additional_cost'] = Utils::numbersOnly($option['additional_cost']);
+                            }
+
+                            $productVariantOptionInput = Arr::except($option, ['uuid']);
+                            ProductVariantOption::where('uuid', $option['uuid'])->update($productVariantOptionInput);
+                            continue;
+                        }
+
+                        $option['product_variant_uuid'] = $id;
+                        ProductVariantOption::create($option);
+                    }
+                }
+
+                continue;
+            }
+
+            $variant['created_by_uuid'] = session('user');
+            $variant['company_uuid']    = session('company');
+            $variant['product_uuid']    = $this->uuid;
+
+            $productVariantInput = Arr::except($variant, ['options']);
+            $productVariant      = ProductVariant::create($productVariantInput);
+
+            if (is_array($variant['options'])) {
+                foreach ($variant['options'] as $option) {
+                    $option['product_variant_uuid'] = $productVariant->uuid;
+                    ProductVariantOption::create($option);
+                }
+            }
+        }
+
+        return $this;
+    }
+
     /**
      * Finds products that match the specified search query, store, and network.
      *
-     * @param string $search The search query to use to find products.
-     * @param string|null $store The store to search for products in. If null, all stores are searched.
-     * @param int $limit The maximum number of products to return.
+     * @param string      $search  the search query to use to find products
+     * @param string|null $store   The store to search for products in. If null, all stores are searched.
+     * @param int         $limit   the maximum number of products to return
      * @param string|null $network The network to search for products on. If null, the session network is used.
      *
-     * @return \Illuminate\Database\Eloquent\Collection The collection of products that match the search query, store, and network.
+     * @return \Illuminate\Database\Eloquent\Collection the collection of products that match the search query, store, and network
      */
     public static function findFromNetwork($search, $store = null, $limit = 20, $network = null): ?\Illuminate\Database\Eloquent\Collection
     {

package/server/src/Models/ProductAddon.php

@@ -3,21 +3,24 @@
 namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Casts\Json;
+use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Models\Category;
 use Fleetbase\Models\User;
-use Fleetbase\FleetOps\Support\Utils;
-use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 use Spatie\Sluggable\HasSlug;
 use Spatie\Sluggable\SlugOptions;
 
 class ProductAddon extends StorefrontModel
 {
-    use HasUuid, HasPublicid, HasApiModelBehavior, HasSlug;
+    use HasUuid;
+    use HasPublicid;
+    use HasApiModelBehavior;
+    use HasSlug;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -31,7 +34,7 @@ class ProductAddon extends StorefrontModel
     protected $table = 'product_addons';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -52,7 +55,7 @@ class ProductAddon extends StorefrontModel
         'price',
         'sale_price',
         'is_on_sale',
-        'slug'
+        'slug',
     ];
 
     /**
@@ -61,12 +64,12 @@ class ProductAddon extends StorefrontModel
      * @var array
      */
     protected $casts = [
-        'is_on_sale' => 'boolean',
-        'translations' => Json::class
+        'is_on_sale'   => 'boolean',
+        'translations' => Json::class,
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
@@ -107,7 +110,7 @@ class ProductAddon extends StorefrontModel
     }
 
     /**
-     * Set the price as only numbers
+     * Set the price as only numbers.
      *
      * @void
      */
@@ -117,7 +120,7 @@ class ProductAddon extends StorefrontModel
     }
 
     /**
-     * Set the sale price as only numbers
+     * Set the sale price as only numbers.
      *
      * @void
      */

package/server/src/Models/ProductAddonCategory.php

@@ -3,12 +3,13 @@
 namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Casts\Json;
-use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasUuid;
 
 class ProductAddonCategory extends StorefrontModel
 {
-    use HasUuid, HasApiModelBehavior;
+    use HasUuid;
+    use HasApiModelBehavior;
 
     /**
      * The database table used by the model.
@@ -18,7 +19,7 @@ class ProductAddonCategory extends StorefrontModel
     protected $table = 'product_addon_categories';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -32,8 +33,8 @@ class ProductAddonCategory extends StorefrontModel
     protected $fillable = [
         'product_uuid',
         'category_uuid',
-        'exluded_addons',
-        'max_selectable'
+        'excluded_addons',
+        'max_selectable',
     ];
 
     /**
@@ -42,18 +43,18 @@ class ProductAddonCategory extends StorefrontModel
      * @var array
      */
     protected $casts = [
-        'exluded_addons' => Json::class
+        'excluded_addons' => Json::class,
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
     protected $appends = ['name'];
 
     /**
-     * Dynamic attributes should be hidden
+     * Dynamic attributes should be hidden.
      *
      * @var array
      */

package/server/src/Models/ProductHour.php

@@ -2,12 +2,13 @@
 
 namespace Fleetbase\Storefront\Models;
 
-use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasUuid;
 
 class ProductHour extends StorefrontModel
 {
-    use HasUuid, HasApiModelBehavior;
+    use HasUuid;
+    use HasApiModelBehavior;
 
     /**
      * The database table used by the model.
@@ -17,7 +18,7 @@ class ProductHour extends StorefrontModel
     protected $table = 'product_hours';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -32,7 +33,7 @@ class ProductHour extends StorefrontModel
         'product_uuid',
         'day_of_week',
         'start',
-        'end'
+        'end',
     ];
 
     /**
@@ -43,7 +44,7 @@ class ProductHour extends StorefrontModel
     protected $casts = [];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */

package/server/src/Models/ProductStoreLocation.php

@@ -2,14 +2,16 @@
 
 namespace Fleetbase\Storefront\Models;
 
-use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasUuid;
 use Spatie\Sluggable\HasSlug;
 use Spatie\Sluggable\SlugOptions;
 
 class ProductStoreLocation extends StorefrontModel
 {
-    use HasUuid, HasApiModelBehavior, HasSlug;
+    use HasUuid;
+    use HasApiModelBehavior;
+    use HasSlug;
 
     /**
      * The database table used by the model.
@@ -19,7 +21,7 @@ class ProductStoreLocation extends StorefrontModel
     protected $table = 'product_store_locations';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -32,7 +34,7 @@ class ProductStoreLocation extends StorefrontModel
      */
     protected $fillable = [
         'product_uuid',
-        'store_location_uuid'
+        'store_location_uuid',
     ];
 
     /**
@@ -43,7 +45,7 @@ class ProductStoreLocation extends StorefrontModel
     protected $casts = [];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */

package/server/src/Models/ProductVariant.php

@@ -5,19 +5,23 @@ namespace Fleetbase\Storefront\Models;
 use Fleetbase\Casts\Json;
 use Fleetbase\Models\Category;
 use Fleetbase\Models\User;
-use Fleetbase\Traits\HasMetaAttributes;
-use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasMetaAttributes;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 use Spatie\Sluggable\HasSlug;
 use Spatie\Sluggable\SlugOptions;
 
 class ProductVariant extends StorefrontModel
 {
-    use HasUuid, HasPublicid, HasApiModelBehavior, HasMetaAttributes, HasSlug;
+    use HasUuid;
+    use HasPublicid;
+    use HasApiModelBehavior;
+    use HasMetaAttributes;
+    use HasSlug;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -31,7 +35,7 @@ class ProductVariant extends StorefrontModel
     protected $table = 'product_variants';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -52,7 +56,7 @@ class ProductVariant extends StorefrontModel
         'is_multiselect',
         'is_required',
         'min',
-        'max'
+        'max',
     ];
 
     /**
@@ -62,20 +66,20 @@ class ProductVariant extends StorefrontModel
      */
     protected $casts = [
         'is_multiselect' => 'boolean',
-        'is_required' => 'boolean',
-        'meta' => Json::class,
-        'translations' => Json::class
+        'is_required'    => 'boolean',
+        'meta'           => Json::class,
+        'translations'   => Json::class,
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
     protected $appends = [];
 
     /**
-     * Relationships to auto load with driver
+     * Relationships to auto load with driver.
      *
      * @var array
      */

package/server/src/Models/ProductVariantOption.php

@@ -4,17 +4,20 @@ namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Casts\Json;
 use Fleetbase\FleetOps\Support\Utils;
-use Fleetbase\Traits\HasMetaAttributes;
-use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasMetaAttributes;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 
 class ProductVariantOption extends StorefrontModel
 {
-    use HasUuid, HasPublicid, HasMetaAttributes, HasApiModelBehavior;
+    use HasUuid;
+    use HasPublicid;
+    use HasMetaAttributes;
+    use HasApiModelBehavior;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -28,7 +31,7 @@ class ProductVariantOption extends StorefrontModel
     protected $table = 'product_variant_options';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -46,7 +49,7 @@ class ProductVariantOption extends StorefrontModel
         'description',
         'translations',
         'meta',
-        'additional_cost'
+        'additional_cost',
     ];
 
     /**
@@ -56,11 +59,11 @@ class ProductVariantOption extends StorefrontModel
      */
     protected $casts = [
         'translations' => Json::class,
-        'meta' => Json::class
+        'meta'         => Json::class,
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
@@ -75,7 +78,7 @@ class ProductVariantOption extends StorefrontModel
     }
 
     /**
-     * Set the price as only numbers
+     * Set the price as only numbers.
      *
      * @void
      */

package/server/src/Models/Review.php

@@ -2,18 +2,20 @@
 
 namespace Fleetbase\Storefront\Models;
 
-use Fleetbase\Models\File;
 use Fleetbase\FleetOps\Models\Contact;
-use Fleetbase\Traits\HasUuid;
+use Fleetbase\Models\File;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 
 class Review extends StorefrontModel
 {
-    use HasUuid, HasPublicid, HasApiModelBehavior;
+    use HasUuid;
+    use HasPublicid;
+    use HasApiModelBehavior;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -27,7 +29,7 @@ class Review extends StorefrontModel
     protected $table = 'reviews';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -56,14 +58,14 @@ class Review extends StorefrontModel
     protected $casts = [];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
     protected $appends = [];
 
     /**
-     * Attributes that is filterable on this model
+     * Attributes that is filterable on this model.
      *
      * @var array
      */