@fleetbase/storefront-engine 0.2.4 → 0.2.6

package/server/src/Models/Store.php

@@ -3,17 +3,17 @@
 namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Casts\Json;
+use Fleetbase\FleetOps\Models\Place;
 use Fleetbase\Models\Category;
-use Fleetbase\Models\User;
 use Fleetbase\Models\Company;
 use Fleetbase\Models\File;
-use Fleetbase\FleetOps\Models\Place;
+use Fleetbase\Models\User;
 use Fleetbase\Support\Utils as FleetbaseUtils;
+use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasMetaAttributes;
 use Fleetbase\Traits\HasOptionsAttributes;
-use Fleetbase\Traits\HasUuid;
-use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\Searchable;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Str;
@@ -22,10 +22,16 @@ use Spatie\Sluggable\SlugOptions;
 
 class Store extends StorefrontModel
 {
-    use HasUuid, HasPublicid, HasApiModelBehavior, HasOptionsAttributes, HasMetaAttributes, HasSlug, Searchable;
+    use HasUuid;
+    use HasPublicid;
+    use HasApiModelBehavior;
+    use HasOptionsAttributes;
+    use HasMetaAttributes;
+    use HasSlug;
+    use Searchable;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -39,7 +45,7 @@ class Store extends StorefrontModel
     protected $table = 'stores';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -58,17 +64,17 @@ class Store extends StorefrontModel
      * @var array
      */
     protected $casts = [
-        'options' => Json::class,
-        'meta' => Json::class,
-        'translations' => Json::class,
-        'alertable' => Json::class,
-        'tags' => 'array',
+        'options'         => Json::class,
+        'meta'            => Json::class,
+        'translations'    => Json::class,
+        'alertable'       => Json::class,
+        'tags'            => 'array',
         'require_account' => 'boolean',
-        'online' => 'boolean'
+        'online'          => 'boolean',
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
@@ -82,7 +88,7 @@ class Store extends StorefrontModel
     protected $hidden = ['logo', 'backdrop', 'files'];
 
     /**
-     * Attributes that is filterable on this model
+     * Attributes that is filterable on this model.
      *
      * @var array
      */
@@ -156,7 +162,7 @@ class Store extends StorefrontModel
                     'type',
                     'caption',
                     'created_at',
-                    'updated_at'
+                    'updated_at',
                 ]
             )->where('type', 'storefront_store_media');
     }
@@ -302,8 +308,9 @@ class Store extends StorefrontModel
     /**
      * Retrieves the category of the store belonging to the specified network using the network id.
      *
-     * @param  string $id The ID of the network for which the category is to be retrieved.
-     * @return \Fleetbase\Models\Category|null The category of the store in the given network, or null if the store does not belong to the network.
+     * @param string $id the ID of the network for which the category is to be retrieved
+     *
+     * @return \Fleetbase\Models\Category|null the category of the store in the given network, or null if the store does not belong to the network
      */
     public function getNetworkCategoryUsingId(?string $id)
     {
@@ -325,8 +332,9 @@ class Store extends StorefrontModel
     /**
      * Retrieves the category of the store belonging to the specified network.
      *
-     * @param  \Fleetbase\Storefront\Models\Network $network The network for which the category is to be retrieved.
-     * @return \Fleetbase\Models\Category|null The category of the store in the given network, or null if the store does not belong to the network.
+     * @param \Fleetbase\Storefront\Models\Network $network the network for which the category is to be retrieved
+     *
+     * @return \Fleetbase\Models\Category|null the category of the store in the given network, or null if the store does not belong to the network
      */
     public function getNetworkCategory(Network $network)
     {
@@ -347,18 +355,12 @@ class Store extends StorefrontModel
     }
 
     /**
-     *'Create a new product category for this store record
+     *'Create a new product category for this store record.
      *
-     * @param string $name
-     * @param string $description
-     * @param array|null $meta
-     * @param array|null $translations
-     * @param Category|null $parent
      * @param File|string|null $icon
-     * @param string $iconColor
-     * @return Category
+     * @param string           $iconColor
      */
-    public function createCategory(string $name, string $description = '', ?array $meta = [],  ?array $translations = [], ?Category $parent = null, $icon = null, $iconColor = '#000000'): Category
+    public function createCategory(string $name, string $description = '', ?array $meta = [], ?array $translations = [], Category $parent = null, $icon = null, $iconColor = '#000000'): Category
     {
         $iconFile = null;
         $iconName = null;
@@ -373,35 +375,29 @@ class Store extends StorefrontModel
 
         return Category::create(
             [
-                'company_uuid' => $this->company_uuid,
-                'owner_uuid' => $this->uuid,
-                'owner_type' => FleetbaseUtils::getMutationType('storefront:store'),
-                'parent_uuid' => $parent instanceof Category ? $parent->uuid : null,
+                'company_uuid'   => $this->company_uuid,
+                'owner_uuid'     => $this->uuid,
+                'owner_type'     => FleetbaseUtils::getMutationType('storefront:store'),
+                'parent_uuid'    => $parent instanceof Category ? $parent->uuid : null,
                 'icon_file_uuid' => $iconFile instanceof File ? $iconFile->uuid : null,
-                'for' => 'storefront_product',
-                'name' => $name,
-                'description' => $description,
-                'translations' => $translations,
-                'meta' => $meta,
-                'icon' => $iconName,
-                'icon_color' => $iconColor
+                'for'            => 'storefront_product',
+                'name'           => $name,
+                'description'    => $description,
+                'translations'   => $translations,
+                'meta'           => $meta,
+                'icon'           => $iconName,
+                'icon_color'     => $iconColor,
             ]
         );
     }
 
     /**
-     * Create a new product category if it doesn't already exists for this store record
+     * Create a new product category if it doesn't already exists for this store record.
      *
-     * @param string $name
-     * @param string $description
-     * @param array|null $meta
-     * @param array|null $translations
-     * @param Category|null $parent
      * @param File|string|null $icon
-     * @param string $iconColor
-     * @return Category
+     * @param string           $iconColor
      */
-    public function createCategoryStrict(string $name, string $description = '', ?array $meta = [],  ?array $translations = [], ?Category $parent = null, $icon = null, $iconColor = '#000000'): Category
+    public function createCategoryStrict(string $name, string $description = '', ?array $meta = [], ?array $translations = [], Category $parent = null, $icon = null, $iconColor = '#000000'): Category
     {
         $existingCategory = Category::where(['company_uuid' => $this->company_uuid, 'owner_uuid' => $this->uuid, 'name' => $name])->first();
 
@@ -414,42 +410,30 @@ class Store extends StorefrontModel
 
     /**
      * Creates a new product in the store.
-     *
-     * @param string $name
-     * @param string $description
-     * @param array $tags
-     * @param Category|null $category
-     * @param File|null $image
-     * @param User|null $createdBy
-     * @param string $sku
-     * @param integer $price
-     * @param string $status
-     * @param array $options
-     * @return Product
-     */
-    public function createProduct(string $name, string $description, array $tags = [], ?Category $category = null, ?File $image = null, ?User $createdBy = null, string $sku = '', int $price = 0, string $status = 'available', array $options = []): Product
+     */
+    public function createProduct(string $name, string $description, array $tags = [], Category $category = null, File $image = null, User $createdBy = null, string $sku = '', int $price = 0, string $status = 'available', array $options = []): Product
     {
         return Product::create(
             [
-                'company_uuid' => $this->company_uuid,
+                'company_uuid'       => $this->company_uuid,
                 'primary_image_uuid' => $image instanceof File ? $image->uuid : null,
-                'created_by_uuid' => $createdBy instanceof User ? $createdBy->uuid : null,
-                'store_uuid' => $this->uuid,
-                'category_uuid' => $category instanceof Category ? $category->uuid : null,
-                'name' => $name,
-                'description' => $description,
-                'tags' => $tags,
-                'sku' => $sku,
-                'price' => $price,
-                'sale_price' => isset($options['sale_price']) ? $options['sale_price'] : null,
-                'currency' => $this->currency,
-                'is_service' => isset($options['is_service']) ? $options['is_service'] : false,
-                'is_bookable' => isset($options['is_bookable']) ? $options['is_bookable'] : false,
-                'is_available' => isset($options['is_available']) ? $options['is_available'] : true,
-                'is_on_sale' => isset($options['is_on_sale']) ? $options['is_on_sale'] : false,
-                'is_recommended' => isset($options['is_recommended']) ? $options['is_recommended'] : false,
-                'can_pickup' => isset($options['can_pickup']) ? $options['can_pickup'] : false,
-                'status' => $status
+                'created_by_uuid'    => $createdBy instanceof User ? $createdBy->uuid : null,
+                'store_uuid'         => $this->uuid,
+                'category_uuid'      => $category instanceof Category ? $category->uuid : null,
+                'name'               => $name,
+                'description'        => $description,
+                'tags'               => $tags,
+                'sku'                => $sku,
+                'price'              => $price,
+                'sale_price'         => isset($options['sale_price']) ? $options['sale_price'] : null,
+                'currency'           => $this->currency,
+                'is_service'         => isset($options['is_service']) ? $options['is_service'] : false,
+                'is_bookable'        => isset($options['is_bookable']) ? $options['is_bookable'] : false,
+                'is_available'       => isset($options['is_available']) ? $options['is_available'] : true,
+                'is_on_sale'         => isset($options['is_on_sale']) ? $options['is_on_sale'] : false,
+                'is_recommended'     => isset($options['is_recommended']) ? $options['is_recommended'] : false,
+                'can_pickup'         => isset($options['can_pickup']) ? $options['can_pickup'] : false,
+                'status'             => $status,
             ]
         );
     }
@@ -465,10 +449,10 @@ class Store extends StorefrontModel
         if ($place instanceof Place) {
             return StoreLocation::create(
                 [
-                    'store_uuid' => $this->uuid,
+                    'store_uuid'      => $this->uuid,
                     'created_by_uuid' => $createdBy instanceof User ? $createdBy->uuid : null,
-                    'place_uuid' => $place->uuid,
-                    'name' => $name
+                    'place_uuid'      => $place->uuid,
+                    'name'            => $name,
                 ]
             );
         }

package/server/src/Models/StoreHour.php

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

package/server/src/Models/StoreLocation.php

@@ -2,19 +2,22 @@
 
 namespace Fleetbase\Storefront\Models;
 
-use Fleetbase\Models\User;
 use Fleetbase\FleetOps\Models\Place;
-use Fleetbase\Traits\HasUuid;
+use Fleetbase\Models\User;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 use Grimzy\LaravelMysqlSpatial\Eloquent\SpatialTrait;
 
 class StoreLocation extends StorefrontModel
 {
-    use HasUuid, HasPublicid, HasApiModelBehavior, SpatialTrait;
+    use HasUuid;
+    use HasPublicid;
+    use HasApiModelBehavior;
+    use SpatialTrait;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -28,7 +31,7 @@ class StoreLocation extends StorefrontModel
     protected $table = 'store_locations';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -51,7 +54,7 @@ class StoreLocation extends StorefrontModel
         'store_uuid',
         'created_by_uuid',
         'place_uuid',
-        'name'
+        'name',
     ];
 
     /**
@@ -62,7 +65,7 @@ class StoreLocation extends StorefrontModel
     protected $casts = [];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
@@ -108,7 +111,8 @@ class StoreLocation extends StorefrontModel
     }
 
     /**
-     * Get address for places
+     * Get address for places.
+     *
      * @return string
      */
     public function getAddressAttribute()

package/server/src/Models/StorefrontModel.php

@@ -9,7 +9,7 @@ class StorefrontModel extends Model
     /**
      * Create a new instance of the model.
      *
-     * @param array $attributes The attributes to set on the model.
+     * @param array $attributes the attributes to set on the model
      *
      * @return void
      */

package/server/src/Models/Vote.php

@@ -2,16 +2,18 @@
 
 namespace Fleetbase\Storefront\Models;
 
-use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 
 class Vote 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
      */
@@ -25,7 +27,7 @@ class Vote extends StorefrontModel
     protected $table = 'votes';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -41,7 +43,7 @@ class Vote extends StorefrontModel
         'customer_uuid',
         'subject_uuid',
         'subject_type',
-        'type'
+        'type',
     ];
 
     /**
@@ -52,7 +54,7 @@ class Vote extends StorefrontModel
     protected $casts = [];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */

package/server/src/Notifications/StorefrontOrderCanceled.php

@@ -2,25 +2,24 @@
 
 namespace Fleetbase\Storefront\Notifications;
 
-use Exception;
 use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Storefront\Models\NotificationChannel;
 use Fleetbase\Storefront\Support\Storefront;
-use Fleetbase\FleetOps\Support\Utils;
 use Illuminate\Bus\Queueable;
 use Illuminate\Notifications\Messages\MailMessage;
 use Illuminate\Notifications\Notification;
-use NotificationChannels\Fcm\FcmChannel;
-use NotificationChannels\Fcm\FcmMessage;
 use NotificationChannels\Apn\ApnChannel;
 use NotificationChannels\Apn\ApnMessage;
+use NotificationChannels\Fcm\FcmChannel;
+use NotificationChannels\Fcm\FcmMessage;
 use NotificationChannels\Fcm\Resources\AndroidConfig;
 use NotificationChannels\Fcm\Resources\AndroidFcmOptions;
 use NotificationChannels\Fcm\Resources\AndroidNotification;
 use NotificationChannels\Fcm\Resources\ApnsConfig;
 use NotificationChannels\Fcm\Resources\ApnsFcmOptions;
-use Pushok\Client as PushOkClient;
 use Pushok\AuthProvider\Token as PuskOkToken;
+use Pushok\Client as PushOkClient;
 
 class StorefrontOrderCanceled extends Notification
 {
@@ -47,14 +46,13 @@ class StorefrontOrderCanceled extends Notification
      */
     public function __construct(Order $order)
     {
-        $this->order = $order->setRelations([]);
+        $this->order      = $order->setRelations([]);
         $this->storefront = Storefront::findAbout($this->order->getMeta('storefront_id'));
     }
 
     /**
      * Get the notification's delivery channels.
      *
-     * @param  mixed  $notifiable
      * @return array
      */
     public function via($notifiable)
@@ -65,12 +63,11 @@ class StorefrontOrderCanceled extends Notification
     /**
      * Get the mail representation of the notification.
      *
-     * @param  mixed  $notifiable
      * @return \Illuminate\Notifications\Messages\MailMessage
      */
     public function toMail($notifiable)
     {
-        $message = (new MailMessage)
+        $message = (new MailMessage())
             ->subject('Your order from ' . $this->storefront->name . ' was canceled')
             ->line('Your order from ' . $this->storefront->name . ' has been canceled, if your card has been charged you will be refunded.')
             ->line('No further action is necessary.');
@@ -83,7 +80,6 @@ class StorefrontOrderCanceled extends Notification
     /**
      * Get the firebase cloud message representation of the notification.
      *
-     * @param  mixed  $notifiable
      * @return array
      */
     public function toFcm($notifiable)
@@ -110,7 +106,6 @@ class StorefrontOrderCanceled extends Notification
     /**
      * Get the apns message representation of the notification.
      *
-     * @param  mixed  $notifiable
      * @return array
      */
     public function toApn($notifiable)
@@ -120,13 +115,13 @@ class StorefrontOrderCanceled extends Notification
         if ($this->order->hasMeta('storefront_notification_channel')) {
             $notificationChannel = NotificationChannel::where([
                 'owner_uuid' => $about->uuid,
-                'app_key' => $this->order->getMeta('storefront_notification_channel'),
-                'scheme' => 'apn'
+                'app_key'    => $this->order->getMeta('storefront_notification_channel'),
+                'scheme'     => 'apn',
             ])->first();
         } else {
             $notificationChannel = NotificationChannel::where([
                 'owner_uuid' => $about->uuid,
-                'scheme' => 'apn'
+                'scheme'     => 'apn',
             ])->first();
         }
 
@@ -134,8 +129,9 @@ class StorefrontOrderCanceled extends Notification
 
         try {
             $channelClient = new PushOkClient(PuskOkToken::create($config));
-        } catch (Exception $e) {
+        } catch (\Exception $e) {
             app('sentry')->captureException($e);
+
             return;
         }
 
@@ -159,13 +155,13 @@ class StorefrontOrderCanceled extends Notification
         if ($this->order->hasMeta('storefront_notification_channel')) {
             $notificationChannel = NotificationChannel::where([
                 'owner_uuid' => $about->uuid,
-                'app_key' => $this->order->getMeta('storefront_notification_channel'),
-                'scheme' => 'fcm'
+                'app_key'    => $this->order->getMeta('storefront_notification_channel'),
+                'scheme'     => 'fcm',
             ])->first();
         } else {
             $notificationChannel = NotificationChannel::where([
                 'owner_uuid' => $about->uuid,
-                'scheme' => 'fcm'
+                'scheme'     => 'fcm',
             ])->first();
         }
 
@@ -180,7 +176,7 @@ class StorefrontOrderCanceled extends Notification
 
     public function configureFcm($notificationChannel)
     {
-        $config = (array) $notificationChannel->config;
+        $config    = (array) $notificationChannel->config;
         $fcmConfig = config('firebase.projects.app');
 
         // set credentials