@fleetbase/storefront-engine 0.3.23 → 0.3.25

package/server/src/Notifications/StorefrontOrderCompleted.php

@@ -3,32 +3,55 @@
 namespace Fleetbase\Storefront\Notifications;
 
 use Fleetbase\FleetOps\Models\Order;
-use Fleetbase\FleetOps\Support\Utils;
-use Fleetbase\Storefront\Models\NotificationChannel;
+use Fleetbase\Storefront\Models\Network;
+use Fleetbase\Storefront\Models\Store;
+use Fleetbase\Storefront\Support\PushNotification;
 use Fleetbase\Storefront\Support\Storefront;
 use Illuminate\Bus\Queueable;
-// use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Notifications\Messages\MailMessage;
 use Illuminate\Notifications\Notification;
 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\AuthProvider\Token as PuskOkToken;
-use Pushok\Client as PushOkClient;
 
 class StorefrontOrderCompleted extends Notification
 {
     use Queueable;
 
-    public $storefront;
+    /**
+     * The order instance this notification is for.
+     */
     public Order $order;
 
+    /**
+     * The order instance this notification is for.
+     */
+    public Store|Network $storefront;
+
+    /**
+     * The time the notification was sent.
+     */
+    public string $sentAt;
+
+    /**
+     * The ID of the notification.
+     */
+    public string $notificationId;
+
+    /**
+     * The notification subject.
+     */
+    public string $subject;
+
+    /**
+     * The notification body.
+     */
+    public string $body;
+
+    /**
+     * The notification order status.
+     */
+    public string $status;
+
     /**
      * Create a new notification instance.
      *
@@ -36,35 +59,22 @@ class StorefrontOrderCompleted extends Notification
      */
     public function __construct(Order $order)
     {
-        $this->order      = $order->setRelations([]);
-        $this->storefront = Storefront::findAbout($this->order->getMeta('storefront_id'));
+        $this->order          = $order;
+        $this->storefront     = Storefront::findAbout($order->getMeta('storefront_id'));
+        $this->sentAt         = now()->toDateTimeString();
+        $this->notificationId = uniqid('notification_');
+
+        $this->subject = 'Your order from ' . $this->storefront->name . ' has been delivered';
+        $this->body    = 'Your order from ' . $this->storefront->name . ' has been delivered, enjoy!';
+        $this->status  = 'order_completed';
     }
 
     /**
      * Get the notification's delivery channels.
-     *
-     * @return array
      */
-    public function via($notifiable)
+    public function via($notifiable): array
     {
-        // $channels = ['mail'];
-        $channels = [];
-
-        if (!$this->storefront) {
-            return $channels;
-        }
-
-        $hasApnNotificationChannels = NotificationChannel::where(['owner_uuid' => $this->storefront->uuid, 'scheme' => 'apn'])->count();
-        $hasFcmNotificationChannels = NotificationChannel::where(['owner_uuid' => $this->storefront->uuid, 'scheme' => 'android'])->count();
-
-        if ($hasApnNotificationChannels) {
-            $channels[] = ApnChannel::class;
-        }
-        if ($hasFcmNotificationChannels) {
-            $channels[] = FcmChannel::class;
-        }
-
-        return $channels;
+        return ['mail', 'database', FcmChannel::class, ApnChannel::class];
     }
 
     /**
@@ -75,8 +85,8 @@ class StorefrontOrderCompleted extends Notification
     public function toMail($notifiable)
     {
         $message = (new MailMessage())
-            ->subject('Your order has been delivered')
-            ->line('Your order has been delivered, enjoy!');
+            ->subject($this->subject)
+            ->line($this->body);
 
         // $message->action('View Details', Utils::consoleUrl('', ['shift' => 'fleet-ops/orders/view/' . $this->order->public_id]));
 
@@ -86,112 +96,57 @@ class StorefrontOrderCompleted extends Notification
     /**
      * Get the firebase cloud message representation of the notification.
      *
-     * @return array
+     * @return \NotificationChannels\Fcm\FcmMessage
      */
     public function toFcm($notifiable)
     {
-        $notification = \NotificationChannels\Fcm\Resources\Notification::create()
-            ->setTitle('Your order has been delivered')
-            ->setBody('Your order has been delivered, enjoy!');
-
-        $message = FcmMessage::create()
-            ->setData(['order' => $this->order->uuid, 'id' => $this->order->public_id, 'type' => 'order_completed'])
-            ->setNotification($notification)
-            ->setAndroid(
-                AndroidConfig::create()
-                    ->setFcmOptions(AndroidFcmOptions::create()->setAnalyticsLabel('analytics'))
-                    ->setNotification(AndroidNotification::create()->setColor('#4391EA'))
-            )->setApns(
-                ApnsConfig::create()
-                    ->setFcmOptions(ApnsFcmOptions::create()->setAnalyticsLabel('analytics_ios'))
-            );
-
-        return $message;
+        return PushNotification::createFcmMessage(
+            $this->order,
+            $this->subject,
+            $this->body,
+            $this->status,
+            $notifiable
+        );
     }
 
     /**
      * Get the apns message representation of the notification.
      *
-     * @return array
+     * @return \NotificationChannels\Apn\ApnMessage
      */
     public function toApn($notifiable)
     {
-        $about = Storefront::findAbout($this->order->getMeta('storefront_id'));
-
-        if ($this->order->hasMeta('storefront_notification_channel')) {
-            $notificationChannel = NotificationChannel::where([
-                'owner_uuid' => $about->uuid,
-                'app_key'    => $this->order->getMeta('storefront_notification_channel'),
-                'scheme'     => 'apn',
-            ])->first();
-        } else {
-            $notificationChannel = NotificationChannel::where([
-                'owner_uuid' => $about->uuid,
-                'scheme'     => 'apn',
-            ])->first();
-        }
-
-        $config = (array) $notificationChannel->config;
-
-        try {
-            $channelClient = new PushOkClient(PuskOkToken::create($config));
-        } catch (\Exception $e) {
-            app('sentry')->captureException($e);
-
-            return;
-        }
-
-        $message = ApnMessage::create()
-            ->badge(1)
-            ->title('Your order has been delivered')
-            ->body('Your order has been delivered, enjoy!')
-            ->custom('type', 'order_completed')
-            ->custom('order', $this->order->uuid)
-            ->custom('id', $this->order->public_id)
-            ->via($channelClient);
-
-        return $message;
+        return PushNotification::createApnMessage(
+            $this->order,
+            $this->subject,
+            $this->body,
+            $this->status,
+            $notifiable
+        );
     }
 
-    public function fcmProject($notifiable, $message)
-    {
-        $about = Storefront::findAbout($this->order->getMeta('storefront_id'));
-
-        if ($this->order->hasMeta('storefront_notification_channel')) {
-            $notificationChannel = NotificationChannel::where([
-                'owner_uuid' => $about->uuid,
-                'app_key'    => $this->order->getMeta('storefront_notification_channel'),
-                'scheme'     => 'fcm',
-            ])->first();
-        } else {
-            $notificationChannel = NotificationChannel::where([
-                'owner_uuid' => $about->uuid,
-                'scheme'     => 'fcm',
-            ])->first();
-        }
-
-        if (!$notificationChannel) {
-            return 'app';
-        }
-
-        $this->configureFcm($notificationChannel);
-
-        return $notificationChannel->app_key;
-    }
-
-    public function configureFcm($notificationChannel)
+    /**
+     * Get the array representation of the notification.
+     */
+    public function toArray($notifiable): array
     {
-        $config    = (array) $notificationChannel->config;
-        $fcmConfig = config('firebase.projects.app');
-
-        // set credentials
-        Utils::set($fcmConfig, 'credentials.file', $config['firebase_credentials_json']);
-
-        // set db url
-        Utils::set($fcmConfig, 'database.url', $config['firebase_database_url']);
-
-        config('firebase.projects.' . $notificationChannel->app_key, $fcmConfig);
-
-        return $fcmConfig;
+        $this->order->loadMissing(['customer', 'company']);
+        $customer = $this->order->customer;
+        $company  = $this->order->company;
+
+        return [
+            'notifiable'      => $notifiable->public_id,
+            'notification_id' => $this->notificationId,
+            'sent_at'         => $this->sentAt,
+            'subject'         => $this->subject,
+            'message'         => $this->status,
+            'storefront'      => $this->storefront->name,
+            'storefront_id'   => $this->storefront->public_id,
+            'id'              => $customer->public_id,
+            'email'           => $customer->email,
+            'phone'           => $customer->phone,
+            'companyId'       => $company->public_id,
+            'company'         => $company->name,
+        ];
     }
 }

package/server/src/Notifications/StorefrontOrderCreated.php

@@ -3,9 +3,10 @@
 namespace Fleetbase\Storefront\Notifications;
 
 use Fleetbase\FleetOps\Models\Order;
-// use Illuminate\Contracts\Queue\ShouldQueue;
-use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Storefront\Models\Network;
+use Fleetbase\Storefront\Models\Store;
 use Fleetbase\Storefront\Support\Storefront;
+use Fleetbase\Support\Utils;
 use Illuminate\Bus\Queueable;
 use Illuminate\Notifications\Messages\MailMessage;
 use Illuminate\Notifications\Notification;
@@ -16,7 +17,25 @@ class StorefrontOrderCreated extends Notification
 {
     use Queueable;
 
-    // public ?Order $order;
+    /**
+     * The order instance this notification is for.
+     */
+    public Order $order;
+
+    /**
+     * The order instance this notification is for.
+     */
+    public Store|Network $storefront;
+
+    /**
+     * The time the notification was sent.
+     */
+    public string $sentAt;
+
+    /**
+     * The ID of the notification.
+     */
+    public string $notificationId;
 
     /**
      * Create a new notification instance.
@@ -25,18 +44,16 @@ class StorefrontOrderCreated extends Notification
      */
     public function __construct(Order $order)
     {
-        $storefrontId = $order->getMeta('storefront_id');
-
-        $this->order      = $order;
-        $this->storefront = Storefront::findAbout($storefrontId);
+        $this->order          = $order;
+        $this->storefront     = Storefront::findAbout($order->getMeta('storefront_id'));
+        $this->sentAt         = now()->toDateTimeString();
+        $this->notificationId = uniqid('notification_');
     }
 
     /**
      * Get the notification's delivery channels.
-     *
-     * @return array
      */
-    public function via($notifiable)
+    public function via($notifiable): array
     {
         return ['mail', TwilioChannel::class];
     }
@@ -141,12 +158,9 @@ class StorefrontOrderCreated extends Notification
 
     /**
      * Get the array representation of the notification.
-     *
-     * @return array
      */
-    public function toArray($notifiable)
+    public function toArray($notifiable): array
     {
-        return [
-        ];
+        return [...$this->order->toArray()];
     }
 }

package/server/src/Notifications/StorefrontOrderDriverAssigned.php

@@ -2,31 +2,62 @@
 
 namespace Fleetbase\Storefront\Notifications;
 
+use Fleetbase\FleetOps\Models\Driver;
 use Fleetbase\FleetOps\Models\Order;
-use Fleetbase\FleetOps\Support\Utils;
-use Fleetbase\Storefront\Models\NotificationChannel;
+use Fleetbase\Storefront\Models\Network;
+use Fleetbase\Storefront\Models\Store;
+use Fleetbase\Storefront\Support\PushNotification;
 use Fleetbase\Storefront\Support\Storefront;
-// 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\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\AuthProvider\Token as PuskOkToken;
-use Pushok\Client as PushOkClient;
 
 class StorefrontOrderDriverAssigned extends Notification
 {
     use Queueable;
 
+    /**
+     * The order instance this notification is for.
+     */
+    public Order $order;
+
+    /**
+     * The driver assigned to the order.
+     */
+    public Driver $driver;
+
+    /**
+     * The order instance this notification is for.
+     */
+    public Store|Network $storefront;
+
+    /**
+     * The time the notification was sent.
+     */
+    public string $sentAt;
+
+    /**
+     * The ID of the notification.
+     */
+    public string $notificationId;
+
+    /**
+     * The notification subject.
+     */
+    public string $subject;
+
+    /**
+     * The notification body.
+     */
+    public string $body;
+
+    /**
+     * The notification order status.
+     */
+    public string $status;
+
     /**
      * Create a new notification instance.
      *
@@ -34,9 +65,15 @@ class StorefrontOrderDriverAssigned extends Notification
      */
     public function __construct(Order $order)
     {
-        $this->order      = $order->setRelations([]);
-        $this->driver     = $order->driverAssigned;
-        $this->storefront = Storefront::findAbout($this->order->getMeta('storefront_id'));
+        $this->order          = $order;
+        $this->storefront     = Storefront::findAbout($order->getMeta('storefront_id'));
+        $this->driver         = $order->driverAssigned;
+        $this->sentAt         = now()->toDateTimeString();
+        $this->notificationId = uniqid('notification_');
+
+        $this->subject = 'Your driver is ' . $this->driver->name;
+        $this->body    = 'A driver has been assigned to your order from ' . $this->storefront->name . ', they are currently en-route for pickup';
+        $this->status  = 'order_driver_assigned';
     }
 
     /**
@@ -46,24 +83,7 @@ class StorefrontOrderDriverAssigned extends Notification
      */
     public function via($notifiable)
     {
-        // $channels = ['mail'];
-        $channels = [];
-
-        if (!$this->storefront) {
-            return $channels;
-        }
-
-        $hasApnNotificationChannels = NotificationChannel::where(['owner_uuid' => $this->storefront->uuid, 'scheme' => 'apn'])->count();
-        $hasFcmNotificationChannels = NotificationChannel::where(['owner_uuid' => $this->storefront->uuid, 'scheme' => 'android'])->count();
-
-        if ($hasApnNotificationChannels) {
-            $channels[] = ApnChannel::class;
-        }
-        if ($hasFcmNotificationChannels) {
-            $channels[] = FcmChannel::class;
-        }
-
-        return $channels;
+        return ['mail', 'database', FcmChannel::class, ApnChannel::class];
     }
 
     /**
@@ -74,8 +94,8 @@ class StorefrontOrderDriverAssigned extends Notification
     public function toMail($notifiable)
     {
         $message = (new MailMessage())
-            ->subject('Your order from ' . $this->storefront->name . ' is being prepared')
-            ->line('Your order is getting started.');
+            ->subject($this->subject)
+            ->line($this->body);
 
         // $message->action('View Details', Utils::consoleUrl('', ['shift' => 'fleet-ops/orders/view/' . $this->order->public_id]));
 
@@ -85,111 +105,57 @@ class StorefrontOrderDriverAssigned extends Notification
     /**
      * Get the firebase cloud message representation of the notification.
      *
-     * @return array
+     * @return \NotificationChannels\Fcm\FcmMessage
      */
     public function toFcm($notifiable)
     {
-        $notification = \NotificationChannels\Fcm\Resources\Notification::create()
-            ->setTitle('Your driver is ' . $this->driver->name)
-            ->setBody('A driver has been assigned to your order, they are en-route for pickup');
-
-        $message = FcmMessage::create()
-            ->setData(['order' => $this->order->uuid, 'id' => $this->order->public_id, 'type' => 'order_driver_assigned'])
-            ->setNotification($notification)
-            ->setAndroid(
-                AndroidConfig::create()
-                    ->setFcmOptions(AndroidFcmOptions::create()->setAnalyticsLabel('analytics'))
-                    ->setNotification(AndroidNotification::create()->setColor('#4391EA'))
-            )->setApns(
-                ApnsConfig::create()
-                    ->setFcmOptions(ApnsFcmOptions::create()->setAnalyticsLabel('analytics_ios'))
-            );
-
-        return $message;
-    }
-
-    public function fcmProject($notifiable, $message)
-    {
-        $about = Storefront::findAbout($this->order->getMeta('storefront_id'));
-
-        if ($this->order->hasMeta('storefront_notification_channel')) {
-            $notificationChannel = NotificationChannel::where([
-                'owner_uuid' => $about->uuid,
-                'app_key'    => $this->order->getMeta('storefront_notification_channel'),
-                'scheme'     => 'fcm',
-            ])->first();
-        } else {
-            $notificationChannel = NotificationChannel::where([
-                'owner_uuid' => $about->uuid,
-                'scheme'     => 'fcm',
-            ])->first();
-        }
-
-        if (!$notificationChannel) {
-            return 'app';
-        }
-
-        $this->configureFcm($notificationChannel);
-
-        return $notificationChannel->app_key;
-    }
-
-    public function configureFcm($notificationChannel)
-    {
-        $config    = (array) $notificationChannel->config;
-        $fcmConfig = config('firebase.projects.app');
-
-        // set credentials
-        Utils::set($fcmConfig, 'credentials.file', $config['firebase_credentials_json']);
-
-        // set db url
-        Utils::set($fcmConfig, 'database.url', $config['firebase_database_url']);
-
-        config('firebase.projects.' . $notificationChannel->app_key, $fcmConfig);
-
-        return $fcmConfig;
+        return PushNotification::createFcmMessage(
+            $this->order,
+            $this->subject,
+            $this->body,
+            $this->status,
+            $notifiable
+        );
     }
 
     /**
      * Get the apns message representation of the notification.
      *
-     * @return array
+     * @return \NotificationChannels\Apn\ApnMessage
      */
     public function toApn($notifiable)
     {
-        $about = Storefront::findAbout($this->order->getMeta('storefront_id'));
-
-        if ($this->order->hasMeta('storefront_notification_channel')) {
-            $notificationChannel = NotificationChannel::where([
-                'owner_uuid' => $about->uuid,
-                'app_key'    => $this->order->getMeta('storefront_notification_channel'),
-                'scheme'     => 'apn',
-            ])->first();
-        } else {
-            $notificationChannel = NotificationChannel::where([
-                'owner_uuid' => $about->uuid,
-                'scheme'     => 'apn',
-            ])->first();
-        }
-
-        $config = (array) $notificationChannel->config;
-
-        try {
-            $channelClient = new PushOkClient(PuskOkToken::create($config));
-        } catch (\Exception $e) {
-            // stop silently
-            return;
-        }
-
-        $message = ApnMessage::create()
-            ->badge(1)
-            ->title('Your driver is ' . $this->driver->name)
-            ->body('A driver has been assigned to your order, they are en-route for pickup')
-            ->custom('type', 'order_driver_assigned')
-            ->custom('order', $this->order->uuid)
-            ->custom('id', $this->order->public_id)
-            ->via($channelClient);
+        return PushNotification::createApnMessage(
+            $this->order,
+            $this->subject,
+            $this->body,
+            $this->status,
+            $notifiable
+        );
+    }
 
-        return $message;
+    /**
+     * Get the array representation of the notification.
+     */
+    public function toArray($notifiable): array
+    {
+        $this->order->loadMissing(['customer', 'company']);
+        $customer = $this->order->customer;
+        $company  = $this->order->company;
+
+        return [
+            'notifiable'      => $notifiable->public_id,
+            'notification_id' => $this->notificationId,
+            'sent_at'         => $this->sentAt,
+            'subject'         => $this->subject,
+            'message'         => $this->status,
+            'storefront'      => $this->storefront->name,
+            'storefront_id'   => $this->storefront->public_id,
+            'id'              => $customer->public_id,
+            'email'           => $customer->email,
+            'phone'           => $customer->phone,
+            'companyId'       => $company->public_id,
+            'company'         => $company->name,
+        ];
     }
 }