@fleetbase/fleetops-engine 0.6.8 → 0.6.9

package/server/src/Notifications/OrderFailed.php

@@ -4,6 +4,7 @@ namespace Fleetbase\FleetOps\Notifications;
 
 use Fleetbase\FleetOps\Http\Resources\v1\Order as OrderResource;
 use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Waypoint;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Support\PushNotification;
 use Illuminate\Broadcasting\Channel;
@@ -21,10 +22,17 @@ class OrderFailed extends Notification implements ShouldQueue
     /**
      * The order instance this notification is for.
      *
-     * @var \Fleetbase\Models\Order
+     * @var Order
      */
     public $order;
 
+    /**
+     * The waypoint instance this notification is for.
+     *
+     * @var Waypoint
+     */
+    public $waypoint;
+
     /**
      * Notification name.
      */
@@ -65,13 +73,14 @@ class OrderFailed extends Notification implements ShouldQueue
      *
      * @return void
      */
-    public function __construct(Order $order, string $reason = '')
+    public function __construct(Order $order, string $reason = '', ?Waypoint $waypoint = null)
     {
-        $this->order    = $order;
-        $this->reason   = $reason;
-        $this->title    = 'Order ' . $this->order->trackingNumber->tracking_number . ' delivery has has failed';
-        $this->message  = 'Order ' . $this->order->trackingNumber->tracking_number . ' delivery has failed.';
-        $this->data     = ['id' => $this->order->public_id, 'type' => 'order_canceled'];
+        $this->order       = $order;
+        $this->reason      = $reason;
+        $this->waypoint    = $waypoint;
+        $this->title       = 'Order ' . $this->getTrackingNumber() . ' delivery has has failed';
+        $this->message     = 'Order ' . $this->getTrackingNumber() . ' delivery has failed.';
+        $this->data        = ['id' => $this->order->public_id, 'type' => 'order_canceled'];
     }
 
     /**
@@ -110,12 +119,10 @@ class OrderFailed extends Notification implements ShouldQueue
         $order = new OrderResource($this->order);
 
         return [
+            'event' => 'order.failed_notification',
             'title' => $this->title,
             'body'  => $this->message . ' ' . $this->reason,
-            'data'  => [
-                ...$this->data,
-                'order' => $order->toWebhookPayload(),
-            ],
+            'data'  => $this->data,
         ];
     }
 
@@ -131,7 +138,7 @@ class OrderFailed extends Notification implements ShouldQueue
             ->line($this->message)
             ->line($this->reason)
             ->line('No further action is necessary.')
-            ->action('Track Order', Utils::consoleUrl('track-order', ['order' => $this->order->trackingNumber->tracking_number]));
+            ->action('Track Order', Utils::consoleUrl('track-order', ['order' => $this->getTrackingNumber()]));
     }
 
     /**
@@ -153,4 +160,17 @@ class OrderFailed extends Notification implements ShouldQueue
     {
         return PushNotification::createApnMessage($this->title, $this->message, $this->data, 'view_order');
     }
+
+    /**
+     * Get the tracking number which should be used for this event.
+     * In the case that the order has a currentWaypoint attached use its tracking number otherwise use the orders.
+     */
+    private function getTrackingNumber(): ?string
+    {
+        if ($this->waypoint instanceof Waypoint) {
+            return $this->waypoint->tracking;
+        }
+
+        return $this->order->tracking;
+    }
 }

package/server/src/Notifications/OrderPing.php

@@ -133,15 +133,11 @@ class OrderPing extends Notification implements ShouldQueue
      */
     public function toArray()
     {
-        $order = new OrderResource($this->order);
-
         return [
+            'event' => 'order.ping_notification',
             'title' => $this->title,
             'body'  => $this->message,
-            'data'  => [
-                ...$this->data,
-                'order' => $order->toWebhookPayload(),
-            ],
+            'data'  => $this->data,
         ];
     }
 

package/server/src/Notifications/OrderSplit.php

@@ -14,7 +14,7 @@ class OrderSplit extends Notification
     /**
      * The order instance this notification is for.
      *
-     * @var \Fleetbase\Models\Order
+     * @var \Fleetbase\FleetOps\Models\Order
      */
     public $order;
 

package/server/src/Notifications/WaypointCompleted.php

@@ -0,0 +1,157 @@
+<?php
+
+namespace Fleetbase\FleetOps\Notifications;
+
+use Fleetbase\FleetOps\Flow\Activity;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Waypoint;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Support\PushNotification;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Apn\ApnChannel;
+use NotificationChannels\Fcm\FcmChannel;
+
+class WaypointCompleted extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    /**
+     * The order instance this notification is for.
+     *
+     * @var Waypoint
+     */
+    public $waypoint;
+
+    /**
+     * The activity which triggered this waypoint completed..
+     *
+     * @var Activity
+     */
+    public $activity;
+
+    /**
+     * Notification name.
+     */
+    public static string $name = 'Waypoint Completed';
+
+    /**
+     * Notification description.
+     */
+    public static string $description = 'When an order waypoint/destination has been completed.';
+
+    /**
+     * Notification package.
+     */
+    public static string $package = 'fleet-ops';
+
+    /**
+     * The title of the notification.
+     */
+    public string $title;
+
+    /**
+     * The message body of the notification.
+     */
+    public string $message;
+
+    /**
+     * Additional data to be sent with the notification.
+     */
+    public array $data = [];
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct(Waypoint $waypoint, Activity $activity)
+    {
+        $this->waypoint    = $waypoint;
+        $this->activity    = $activity;
+        $this->title       = 'Order ' . $this->waypoint->trackingNumber->tracking_number . ' ' . strtolower($activity->details);
+        $this->message     = $activity->details;
+        $this->data        = ['id' => $this->waypoint->public_id, 'type' => 'waypoint_completed'];
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        return ['broadcast', 'mail', FcmChannel::class, ApnChannel::class];
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return Channel|array
+     */
+    public function broadcastOn()
+    {
+        $channels = [new Channel('api.' . session('api_credential'))];
+        $order    = Order::where('payload_uuid', $this->waypoint->payload_uuid)->first();
+        if ($order) {
+            $channels[] = new Channel('company.' . session('company', data_get($order, 'company.uuid')));
+            $channels[] = new Channel('company.' . data_get($order, 'company.public_id'));
+            $channels[] = new Channel('order.' . $order->uuid);
+            $channels[] = new Channel('order.' . $order->public_id);
+        }
+
+        return $channels;
+    }
+
+    /**
+     * Get notification as array.
+     *
+     * @return void
+     */
+    public function toArray()
+    {
+        return [
+            'event.waypoint_completed_notification',
+            'title' => $this->title,
+            'body'  => $this->message,
+            'data'  => $this->data,
+        ];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @return MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        return (new MailMessage())
+            ->subject($this->title)
+            ->line($this->message)
+            ->line('No further action is necessary.')
+            ->action('Track Order', Utils::consoleUrl('track-order', ['order' => $this->waypoint->trackingNumber->tracking_number]));
+    }
+
+    /**
+     * Get the firebase cloud message representation of the notification.
+     *
+     * @return array
+     */
+    public function toFcm($notifiable)
+    {
+        return PushNotification::createFcmMessage($this->title, $this->message, $this->data);
+    }
+
+    /**
+     * Get the apns message representation of the notification.
+     *
+     * @return array
+     */
+    public function toApn($notifiable)
+    {
+        return PushNotification::createApnMessage($this->title, $this->message, $this->data, 'view_order');
+    }
+}