@fleetbase/storefront-engine 0.2.4 → 0.2.6

package/server/src/Notifications/StorefrontOrderPreparing.php

@@ -4,25 +4,25 @@ 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 Fleetbase\FleetOps\Support\Utils;
 use Illuminate\Bus\Queueable;
 // use Illuminate\Contracts\Queue\ShouldQueue;
 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 StorefrontOrderPreparing extends Notification
 {
@@ -35,14 +35,13 @@ class StorefrontOrderPreparing 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)
@@ -70,12 +69,11 @@ class StorefrontOrderPreparing 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 . ' is being prepared')
             ->line('Your order is getting started.');
 
@@ -87,7 +85,6 @@ class StorefrontOrderPreparing extends Notification
     /**
      * Get the firebase cloud message representation of the notification.
      *
-     * @param  mixed  $notifiable
      * @return array
      */
     public function toFcm($notifiable)
@@ -118,13 +115,13 @@ class StorefrontOrderPreparing 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();
         }
 
@@ -139,7 +136,7 @@ class StorefrontOrderPreparing extends Notification
 
     public function configureFcm($notificationChannel)
     {
-        $config = (array) $notificationChannel->config;
+        $config    = (array) $notificationChannel->config;
         $fcmConfig = config('firebase.projects.app');
 
         // set credentials
@@ -156,7 +153,6 @@ class StorefrontOrderPreparing extends Notification
     /**
      * Get the apns message representation of the notification.
      *
-     * @param  mixed  $notifiable
      * @return array
      */
     public function toApn($notifiable)
@@ -166,13 +162,13 @@ class StorefrontOrderPreparing 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();
         }
 
@@ -188,9 +184,10 @@ class StorefrontOrderPreparing extends Notification
 
         try {
             $channelClient = new PushOkClient(PuskOkToken::create($config));
-        } catch (Exception $e) {
+        } catch (\Exception $e) {
             // report to sentry the exception
             app('sentry')->captureException($e);
+
             // return the apn message to be sent by fleetbase defaults anyway -- backup
             return;
         }

package/server/src/Notifications/StorefrontOrderReadyForPickup.php

@@ -4,25 +4,25 @@ 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 Fleetbase\FleetOps\Support\Utils;
 use Illuminate\Bus\Queueable;
 // use Illuminate\Contracts\Queue\ShouldQueue;
 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 StorefrontOrderReadyForPickup extends Notification
 {
@@ -35,14 +35,13 @@ class StorefrontOrderReadyForPickup 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)
@@ -70,12 +69,11 @@ class StorefrontOrderReadyForPickup 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 . ' is ready for pickup!')
             ->line('You can proceed to pickup your order.');
 
@@ -87,7 +85,6 @@ class StorefrontOrderReadyForPickup extends Notification
     /**
      * Get the firebase cloud message representation of the notification.
      *
-     * @param  mixed  $notifiable
      * @return array
      */
     public function toFcm($notifiable)
@@ -118,13 +115,13 @@ class StorefrontOrderReadyForPickup 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();
         }
 
@@ -139,7 +136,7 @@ class StorefrontOrderReadyForPickup extends Notification
 
     public function configureFcm($notificationChannel)
     {
-        $config = (array) $notificationChannel->config;
+        $config    = (array) $notificationChannel->config;
         $fcmConfig = config('firebase.projects.app');
 
         // set credentials
@@ -156,7 +153,6 @@ class StorefrontOrderReadyForPickup extends Notification
     /**
      * Get the apns message representation of the notification.
      *
-     * @param  mixed  $notifiable
      * @return array
      */
     public function toApn($notifiable)
@@ -166,13 +162,13 @@ class StorefrontOrderReadyForPickup 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();
         }
 
@@ -188,9 +184,10 @@ class StorefrontOrderReadyForPickup extends Notification
 
         try {
             $channelClient = new PushOkClient(PuskOkToken::create($config));
-        } catch (Exception $e) {
+        } catch (\Exception $e) {
             // report to sentry the exception
             app('sentry')->captureException($e);
+
             // return the apn message to be sent by fleetbase defaults anyway -- backup
             return;
         }

package/server/src/Observers/NetworkObserver.php

@@ -10,8 +10,7 @@ class NetworkObserver
     /**
      * Handle the Network "updated" event.
      *
-     * @param  \Fleetbase\Storefront\Models\Network  $network The Network that is updating.
-     * @return void
+     * @param \Fleetbase\Storefront\Models\Network $network the Network that is updating
      */
     public function updating(Network $network): void
     {
@@ -32,7 +31,7 @@ class NetworkObserver
                         }
                     )
                         ->values()
-                        ->toArray()
+                        ->toArray(),
                 ];
             }
         )->toArray();

package/server/src/Observers/ProductObserver.php

@@ -2,49 +2,34 @@
 
 namespace Fleetbase\Storefront\Observers;
 
-use Fleetbase\Models\File;
 use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Models\File;
 use Fleetbase\Storefront\Models\Product;
 use Fleetbase\Storefront\Models\ProductAddonCategory;
 use Fleetbase\Storefront\Models\ProductVariant;
 use Fleetbase\Storefront\Models\ProductVariantOption;
-use Illuminate\Support\Facades\Request;
 use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\Request;
+use Illuminate\Support\Str;
 
 class ProductObserver
 {
     /**
      * Handle the Product "created" event.
      *
-     * @param  \Fleetbase\Storefront\Models\Product  $product The Product that was created.
-     * @return void
+     * @param \Fleetbase\Storefront\Models\Product $product the Product that was created
      */
     public function created(Product $product): void
     {
-        $addonCategories = Request::input('product.addon_categories');
-        $variants = Request::input('product.variants');
-        $files = Request::input('product.files');
+        $addonCategories = Request::input('product.addon_categories', []);
+        $variants        = Request::input('product.variants', []);
+        $files           = Request::input('product.files', []);
 
         // save addon categories
-        foreach ($addonCategories as $addonCategory) {
-            $addonCategory['product_uuid'] = $product->uuid;
-
-            ProductAddonCategory::create(Arr::except($addonCategory, ['category']));
-        }
+        $product->setAddonCategories($addonCategories);
 
         // save product variants
-        foreach ($variants as $variant) {
-            $variant['created_by_uuid'] = Request::session()->get('user');
-            $variant['company_uuid'] = Request::session()->get('company');
-            $variant['product_uuid'] = $product->uuid;
-
-            $productVariant = ProductVariant::create(Arr::except($variant, ['options']));
-
-            foreach ($variant['options'] as $option) {
-                $option['product_variant_uuid'] = $productVariant->uuid;
-                ProductVariantOption::create($option);
-            }
-        }
+        $product->setProductVariants($variants);
 
         // set keys on files
         foreach ($files as $file) {
@@ -56,17 +41,16 @@ class ProductObserver
     /**
      * Handle the Product "updated" event.
      *
-     * @param  \Fleetbase\Storefront\Models\Product  $product The Product that was created.
-     * @return void
+     * @param \Fleetbase\Storefront\Models\Product $product the Product that was created
      */
     public function updated(Product $product): void
     {
-        $productAddonCategories = Request::input('product.addon_categories');
-        $variants = Request::input('product.variants');
+        $addonCategories        = Request::input('product.addon_categories', []);
+        $variants               = Request::input('product.variants', []);
 
         // update addon categories
-        foreach ($productAddonCategories as $productAddonCategory) {
-            if (!empty($productAddonCategory['uuid'])) {
+        foreach ($addonCategories as $productAddonCategory) {
+            if (isset($productAddonCategory['uuid']) && Str::isUuid($productAddonCategory['uuid'])) {
                 ProductAddonCategory::where('uuid', $productAddonCategory['uuid'])->update(Arr::except($productAddonCategory, ['uuid', 'name', 'category']));
                 continue;
             }
@@ -78,7 +62,7 @@ class ProductObserver
 
         // update product variants
         foreach ($variants as $variant) {
-            if (!empty($variant['uuid'])) {
+            if (isset($variant['uuid']) && Str::isUuid($variant['uuid'])) {
                 // update product variante
                 ProductVariant::where('uuid', $variant['uuid'])->update(Arr::except($variant, ['uuid', 'options']));
 
@@ -104,8 +88,8 @@ class ProductObserver
 
             // create new variant
             $variant['created_by_uuid'] = Request::session()->get('user');
-            $variant['company_uuid'] = Request::session()->get('company');
-            $variant['product_uuid'] = $product->uuid;
+            $variant['company_uuid']    = Request::session()->get('company');
+            $variant['product_uuid']    = $product->uuid;
 
             $productVariant = ProductVariant::create(Arr::except($variant, ['options']));
 

package/server/src/Providers/EventServiceProvider.php

@@ -2,22 +2,33 @@
 
 namespace Fleetbase\Storefront\Providers;
 
+use Fleetbase\Storefront\Models\Product;
+use Fleetbase\Storefront\Observers\ProductObserver;
 use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
 
 class EventServiceProvider extends ServiceProvider
 {
+    /**
+     * The model observers for your application.
+     *
+     * @var array
+     */
+    // protected $observers = [
+    //     Product::class => [ProductObserver::class],
+    // ];
+
     /**
      * The event listener mappings for the application.
      *
      * @var array
      */
     protected $listen = [
-        /**
+        /*
          * Order Events
          */
-        \Fleetbase\FleetOps\Events\OrderStarted::class => [\Fleetbase\Storefront\Listeners\HandleOrderStarted::class],
-        \Fleetbase\FleetOps\Events\OrderDispatched::class => [\Fleetbase\Storefront\Listeners\HandleOrderDispatched::class],
-        \Fleetbase\FleetOps\Events\OrderCompleted::class => [\Fleetbase\Storefront\Listeners\HandleOrderCompleted::class],
+        \Fleetbase\FleetOps\Events\OrderStarted::class        => [\Fleetbase\Storefront\Listeners\HandleOrderStarted::class],
+        \Fleetbase\FleetOps\Events\OrderDispatched::class     => [\Fleetbase\Storefront\Listeners\HandleOrderDispatched::class],
+        \Fleetbase\FleetOps\Events\OrderCompleted::class      => [\Fleetbase\Storefront\Listeners\HandleOrderCompleted::class],
         \Fleetbase\FleetOps\Events\OrderDriverAssigned::class => [\Fleetbase\Storefront\Listeners\HandleOrderDriverAssigned::class],
     ];
 }

package/server/src/Providers/StorefrontServiceProvider.php

@@ -2,8 +2,8 @@
 
 namespace Fleetbase\Storefront\Providers;
 
-use Fleetbase\Providers\CoreServiceProvider;
 use Fleetbase\FleetOps\Providers\FleetOpsServiceProvider;
+use Fleetbase\Providers\CoreServiceProvider;
 
 if (!class_exists(CoreServiceProvider::class)) {
     throw new \Exception('Storefront cannot be loaded without `fleetbase/core-api` installed!');
@@ -15,8 +15,6 @@ if (!class_exists(FleetOpsServiceProvider::class)) {
 
 /**
  * Storefront service provider.
- *
- * @package \Fleetbase\Storefront\Providers
  */
 class StorefrontServiceProvider extends CoreServiceProvider
 {
@@ -37,7 +35,7 @@ class StorefrontServiceProvider extends CoreServiceProvider
      */
     public $middleware = [
         'storefront.api' => [
-            'throttle:60,1',
+            'throttle:80,1',
             \Illuminate\Session\Middleware\StartSession::class,
             \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
             \Fleetbase\Storefront\Http\Middleware\SetStorefrontSession::class,
@@ -54,15 +52,15 @@ class StorefrontServiceProvider extends CoreServiceProvider
      * @var array
      */
     public $commands = [
-        \Fleetbase\Storefront\Console\Commands\NotifyStorefrontOrderNearby::class
+        \Fleetbase\Storefront\Console\Commands\NotifyStorefrontOrderNearby::class,
     ];
 
     /**
      * Register any application services.
      *
-     * Within the register method, you should only bind things into the 
-     * service container. You should never attempt to register any event 
-     * listeners, routes, or any other piece of functionality within the 
+     * Within the register method, you should only bind things into the
+     * service container. You should never attempt to register any event
+     * listeners, routes, or any other piece of functionality within the
      * register method.
      *
      * More information on this can be found in the Laravel documentation:
@@ -81,8 +79,8 @@ class StorefrontServiceProvider extends CoreServiceProvider
      *
      * @return void
      *
-     * @throws \Exception If the `fleetbase/core-api` package is not installed.
-     * @throws \Exception If the `fleetbase/fleetops-api` package is not installed.
+     * @throws \Exception if the `fleetbase/core-api` package is not installed
+     * @throws \Exception if the `fleetbase/fleetops-api` package is not installed
      */
     public function boot()
     {

package/server/src/Support/Metrics.php

@@ -2,17 +2,17 @@
 
 namespace Fleetbase\Storefront\Support;
 
+use Fleetbase\FleetOps\Models\Order;
 use Fleetbase\Models\Company;
 use Fleetbase\Storefront\Models\Network;
-use Fleetbase\Storefront\Models\Store;
 use Fleetbase\Storefront\Models\Product;
-use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\Storefront\Models\Store;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Str;
 
 /**
  * Metrics service to pull analyitcs and metrics from Storefront.
- * 
+ *
  * Ex:
  * $metrics = Metrics::new($company)->withTotalStores()->withOrdersCanceled()->get();
  */
@@ -23,15 +23,15 @@ class Metrics
     protected Company $company;
     protected array $metrics = [];
 
-    public static function new(Company $company, ?\DateTime $start = null, ?\DateTime $end = null): Metrics
+    public static function new(Company $company, \DateTime $start = null, \DateTime $end = null): Metrics
     {
         $start = $start === null ? Carbon::create(1900)->toDateTime() : $start;
-        $end = $end === null ? Carbon::tomorrow()->toDateTime() : $end;
+        $end   = $end === null ? Carbon::tomorrow()->toDateTime() : $end;
 
         return (new static())->setCompany($company)->between($start, $end);
     }
 
-    public static function forCompany(Company $company, ?\DateTime $start = null, ?\DateTime $end = null): Metrics
+    public static function forCompany(Company $company, \DateTime $start = null, \DateTime $end = null): Metrics
     {
         return static::new($company, $start, $end);
     }
@@ -104,7 +104,7 @@ class Metrics
         return $this;
     }
 
-    public function totalProducts(?callable $callback = null): Metrics
+    public function totalProducts(callable $callback = null): Metrics
     {
         $query = Product::where('company_uuid', $this->company->uuid);
 
@@ -117,7 +117,7 @@ class Metrics
         return $this->set('total_products', $data);
     }
 
-    public function totalStores(?callable $callback = null): Metrics
+    public function totalStores(callable $callback = null): Metrics
     {
         $query = Store::where('company_uuid', $this->company->uuid);
 
@@ -130,7 +130,7 @@ class Metrics
         return $this->set('total_stores', $data);
     }
 
-    public function totalNetworks(?callable $callback = null): Metrics
+    public function totalNetworks(callable $callback = null): Metrics
     {
         $query = Network::where('company_uuid', $this->company->uuid);
 
@@ -143,7 +143,7 @@ class Metrics
         return $this->set('total_networks', $data);
     }
 
-    public function ordersInProgress(?callable $callback = null): Metrics
+    public function ordersInProgress(callable $callback = null): Metrics
     {
         $query = Order::where('company_uuid', $this->company->uuid)
             ->whereBetween('created_at', [$this->start, $this->end])
@@ -159,7 +159,7 @@ class Metrics
         return $this->set('orders_in_progress', $data);
     }
 
-    public function ordersCompleted(?callable $callback = null): Metrics
+    public function ordersCompleted(callable $callback = null): Metrics
     {
         $query = Order::where('company_uuid', $this->company->uuid)
             ->whereBetween('created_at', [$this->start, $this->end])
@@ -175,7 +175,7 @@ class Metrics
         return $this->set('orders_completed', $data);
     }
 
-    public function ordersCanceled(?callable $callback = null): Metrics
+    public function ordersCanceled(callable $callback = null): Metrics
     {
         $query = Order::where('company_uuid', $this->company->uuid)
             ->whereBetween('created_at', [$this->start, $this->end])

package/server/src/Support/OrderConfig.php

@@ -2,7 +2,8 @@
 
 namespace Fleetbase\Storefront\Support;
 
-class OrderConfig {
+class OrderConfig
+{
     /**
      * Provides default order configs for Storefront.
      */
@@ -10,4 +11,4 @@ class OrderConfig {
     {
         return config('storefront.api.types.order', []);
     }
-}
+}