@fleetbase/storefront-engine 0.1.6 → 0.1.8

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_stores_table.php

@@ -0,0 +1,42 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Query\Expression;
+use Illuminate\Support\Facades\Schema;
+use Fleetbase\Support\Utils;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        $databaseName = Utils::getFleetbaseDatabaseName();
+
+        Schema::connection(config('storefront.connection.db'))->table('stores', function (Blueprint $table) use ($databaseName) {
+            $table->foreign(['backdrop_uuid'])->references(['uuid'])->on(new Expression($databaseName . '.files'))->onUpdate('NO ACTION')->onDelete('NO ACTION');
+            $table->foreign(['company_uuid'])->references(['uuid'])->on(new Expression($databaseName . '.companies'))->onUpdate('NO ACTION')->onDelete('NO ACTION');
+            $table->foreign(['created_by_uuid'])->references(['uuid'])->on(new Expression($databaseName . '.users'))->onUpdate('NO ACTION')->onDelete('NO ACTION');
+            $table->foreign(['logo_uuid'])->references(['uuid'])->on(new Expression($databaseName . '.files'))->onUpdate('NO ACTION')->onDelete('NO ACTION');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::connection(config('storefront.connection.db'))->table('stores', function (Blueprint $table) {
+            $table->dropForeign('stores_backdrop_uuid_foreign');
+            $table->dropForeign('stores_company_uuid_foreign');
+            $table->dropForeign('stores_created_by_uuid_foreign');
+            $table->dropForeign('stores_logo_uuid_foreign');
+        });
+    }
+};

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_votes_table.php

@@ -0,0 +1,38 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Query\Expression;
+use Illuminate\Support\Facades\Schema;
+use Fleetbase\Support\Utils;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        $databaseName = Utils::getFleetbaseDatabaseName();
+
+        Schema::connection(config('storefront.connection.db'))->table('votes', function (Blueprint $table) use ($databaseName) {
+            $table->foreign(['created_by_uuid'])->references(['uuid'])->on(new Expression($databaseName . '.users'))->onUpdate('NO ACTION')->onDelete('NO ACTION');
+            $table->foreign(['customer_uuid'])->references(['uuid'])->on(new Expression($databaseName . '.contacts'))->onUpdate('NO ACTION')->onDelete('NO ACTION');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::connection(config('storefront.connection.db'))->table('votes', function (Blueprint $table) {
+            $table->dropForeign('votes_created_by_uuid_foreign');
+            $table->dropForeign('votes_customer_uuid_foreign');
+        });
+    }
+};

package/server/src/Auth/Schemas/Storefront.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Fleetbase\Storefront\Auth\Schemas;
+
+class Storefront
+{
+    /**
+     * The permission schema Name.
+     *
+     * @var string
+     */
+    public string $name = 'storefront';
+
+    /**
+     * The permission schema Polict Name.
+     *
+     * @var string
+     */
+    public string $policyName = 'Storefront';
+
+    /**
+     * Guards these permissions should apply to.
+     *
+     * @var array
+     */
+    public array $guards = ['web', 'api'];
+
+    /**
+     * The permission schema resources.
+     *
+     * @var array
+     */
+    public array $resources = [
+        [
+            'name' => 'order',
+            'actions' => ['accept', 'mark-as-ready', 'mark-as-completed', 'reject']
+        ],
+        [
+            'name' => 'product',
+            'actions' => ['import']
+        ],
+        [
+            'name' => 'product-addon',
+            'actions' => []
+        ],
+        [
+            'name' => 'product-addon-category',
+            'actions' => []
+        ],
+        [
+            'name' => 'product-hour',
+            'actions' => []
+        ],
+        [
+            'name' => 'product-store-location',
+            'actions' => []
+        ],
+        [
+            'name' => 'product-variant',
+            'actions' => []
+        ],
+        [
+            'name' => 'product-variant-option',
+            'actions' => []
+        ],
+        [
+            'name' => 'gateway',
+            'actions' => []
+        ],
+        [
+            'name' => 'notification-channel',
+            'actions' => []
+        ],
+        [
+            'name' => 'network',
+            'actions' => []
+        ],
+        [
+            'name' => 'network-store',
+            'actions' => []
+        ],
+        [
+            'name' => 'store',
+            'actions' => []
+        ],
+        [
+            'name' => 'store-location',
+            'actions' => []
+        ],
+        [
+            'name' => 'store-hour',
+            'actions' => []
+        ]
+    ];
+}

package/server/src/Console/Commands/NotifyStorefrontOrderNearby.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Fleetbase\Storefront\Console\Commands;
+
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Storefront\Notifications\StorefrontOrderNearby;
+use Illuminate\Console\Command;
+
+class NotifyStorefrontOrderNearby extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'storefront:notify-order-nearby';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Notifies customer when their order is nearby/ reaching';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        // Get storefront orders that are enroute
+        $orders = $this->getActiveStorefrontOrders();
+
+        // Notify and update 
+        $this->alert('Found (' . $orders->count() . ') Storefront Orders which are Enroute.');
+
+        // Iterate each order
+        $orders->each(
+            function ($order) {
+                $origin = $order->payload->getPickupOrFirstWaypoint();
+                $destination = $order->payload->getDropoffOrLastWaypoint();
+                $matrix = Utils::getDrivingDistanceAndTime($origin, $destination);
+                $distance = $matrix->distance;
+                $time = $matrix->time;
+
+                if (!$distance || !$time) {
+                    return;
+                }
+
+                $this->line('Order ' . $order->public_id . ' is ' . Utils::formatSeconds($time) . ' from being delivered');
+                $this->line('Order ' . $order->public_id . ' distance is ' . Utils::formatMeters($distance) . ' away');
+
+                if (round($distance) < 1500 && $order->missingMeta('storefront_order_nearby')) {
+                    $this->line('Order ' . $order->public_id . ' is nearby');
+                    $order->customer->notify(new StorefrontOrderNearby($order, $distance, $time));
+                    $order->updateMeta('storefront_order_nearby', true);
+                }
+            }
+        );
+    }
+
+    /**
+     * Fetches active storefront orders based on certain criteria.
+     *
+     * @return \Illuminate\Database\Eloquent\Collection
+     */
+    public function getActiveStorefrontOrders(): \Illuminate\Database\Eloquent\Collection
+    {
+        return Order::where(
+            [
+                'status' => 'driver_enroute',
+                'type' => 'storefront',
+                'dispatched' => true
+            ]
+        )->with(
+            [
+                'payload',
+                'customer'
+            ]
+        )
+            ->withoutGlobalScopes()
+            ->get();
+    }
+}

package/server/src/Expansions/EntityExpansion.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Fleetbase\Storefront\Expansions;
+
+use Fleetbase\Build\Expansion;
+
+class EntityExpansion implements Expansion
+{
+    /**
+     * Get the target class to expand.
+     *
+     * @return string|Class
+     */
+    public static function target()
+    {
+        return \Fleetbase\FleetOps\Models\Entity::class;
+    }
+
+    /**
+     * Create a new Entity from a Storefront Product
+     *
+     * @return \Fleetbase\FleetOps\Models\Entity
+     */
+    public function fromStorefrontProduct()
+    {
+        return static function (\Fleetbase\Storefront\Models\Product $product) {
+            return new static([
+                'company_uuid' => session('company'),
+                'photo_uuid' => $product->primary_image_uuid,
+                'internal_id' => $product->public_id,
+                'name' => $product->name,
+                'description' => $product->description,
+                'currency' => $product->currency,
+                'sku' => $product->sku,
+                'price' => $product->price,
+                'sale_price' => $product->sale_price,
+                'meta' => [
+                    'product_id' => $product->public_id,
+                    'image_url' => $product->primary_image_url,
+                ]
+            ]);
+        };
+    }
+}

package/server/src/Http/Controllers/ActionController.php

@@ -0,0 +1,119 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Controllers;
+
+use Fleetbase\Http\Controllers\Controller;
+use Fleetbase\FleetOps\Models\Contact;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\Storefront\Models\Store;
+use Illuminate\Http\Request;
+use Illuminate\Support\Carbon;
+
+class ActionController extends Controller
+{
+    public function welcome()
+    {
+        return response()->json(['message' => 'Hello Friend!']);
+    }
+
+    /**
+     * Get the number of storefronts created.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function getStoreCount(Request $request)
+    {
+        $count = Store::where('company_uuid', session('company'))->count();
+
+        return response()->json(['storeCount' => $count]);
+    }
+
+    /**
+     * Get key metrics for storefront.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Response
+     */
+    public function getMetrics(Request $request)
+    {
+        $store = $request->input('store');
+        $start = $request->has('start') ? Carbon::fromString($request->input('start'))->toDateTimeString() : Carbon::now()->startOfMonth()->toDateTimeString();
+        $end = $request->has('end') ? Carbon::fromString($request->input('end'))->toDateTimeString() : Carbon::now()->toDateTimeString();
+
+        // default metrics
+        $metrics = [
+            'orders_count' => 0,
+            'customers_count' => 0,
+            'stores_count' => 0,
+            'earnings_sum' => 0
+        ];
+
+        // get the current active store
+        if (!$store) {
+            return response()->json($metrics);
+        }
+
+        $store = Store::where('uuid', $store)->first();
+
+        if (!$store) {
+            return response()->json($metrics);
+        }
+
+        /**
+         * Query metrics between given time period
+         */
+
+        // send back currency
+        $metrics['currency'] = $store->currency;
+
+        // - orders count
+        $metrics['orders_count'] = Order::where([
+            'company_uuid' => session('company'),
+            'type' => 'storefront'
+        ])
+            ->where('meta->storefront_id', $store->public_id)
+            ->whereNotIn('status', ['canceled'])
+            ->whereBetween('created_at', [$start, $end])->count();
+
+        // - customers count -- change to where has orders where meta->storefront_id === store
+        $metrics['customers_count'] = Contact::where([
+            'company_uuid' => session('company'),
+            'type' => 'customer'
+        ])->whereHas('customerOrders', function ($q) use ($start, $end, $store) {
+            $q->whereBetween('created_at', [$start, $end]);
+            $q->where('meta->storefront_id', $store->public_id);
+            $q->whereNotIn('status', ['canceled']);
+        })->count();
+
+        // - stores count
+        $metrics['stores_count'] = Store::where(['company_uuid' => session('company')])->count();
+
+        // - earnings sum
+        // $metrics['earnings_sum'] = Transaction::where(['company_uuid' => session('company'), 'type' => 'storefront', 'meta->storefront_id' => $store->public_id])->whereBetween('created_at', [$start, $end])->sum('amount');
+        $metrics['earnings_sum'] = Order::where([
+            'company_uuid' => session('company'),
+            'type' => 'storefront'
+        ])
+            ->whereBetween('created_at', [$start, $end])
+            ->where('meta->storefront_id', $store->public_id)
+            ->with(['transaction'])
+            ->whereNotIn('status', ['canceled'])
+            ->get()
+            ->sum(function ($order) {
+                return $order->transaction->amount;
+            });
+
+        response()->json($metrics);
+    }
+
+    /**
+     * CORS OPTIONS.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function options()
+    {
+        return response()->json(['status' => 'ok']);
+    }
+}

package/server/src/Http/Controllers/AddonCategoryController.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Controllers;
+
+class AddonCategoryController extends StorefrontController
+{
+    /**
+     * The resource to query
+     *
+     * @var string
+     */
+    public $resource = 'addon_category';
+}

package/server/src/Http/Controllers/CustomerController.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Controllers;
+
+class CustomerController extends StorefrontController
+{
+    /**
+     * The resource to query
+     *
+     * @var string
+     */
+    public $resource = 'customer';
+}

package/server/src/Http/Controllers/GatewayController.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Controllers;
+
+class GatewayController extends StorefrontController
+{
+    /**
+     * The resource to query
+     *
+     * @var string
+     */
+    public $resource = 'gateway';
+}

package/server/src/Http/Controllers/MetricsController.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Controllers;
+
+use Fleetbase\Storefront\Support\Metrics;
+use Fleetbase\Http\Controllers\Controller;
+use Illuminate\Http\Request;
+
+class MetricsController extends Controller
+{
+    public function all(Request $request)
+    {
+        $start = $request->date('start');
+        $end = $request->date('end');
+        $discover = $request->array('discover', []);
+
+        try {
+            $data = Metrics::forCompany($request->user()->company, $start, $end)->with($discover)->get();
+        } catch (\Exception $e) {
+            return response()->error($e->getMessage());
+        }
+
+        return response()->json($data);
+    }
+
+    public function dashboard(Request $request)
+    {
+        $start = $request->date('start');
+        $end = $request->date('end');
+        $discover = $request->array('discover', []);
+        $metrics = [];
+
+        try {
+            $metrics = Metrics::forCompany($request->user()->company, $start, $end)->with($discover)->get();
+        } catch (\Exception $e) {
+            return response()->error($e->getMessage());
+        }
+
+        // metrics format map
+        $metricsFormats = [];
+
+        // dashboard config
+        $dashboardConfig = [
+            [
+                'size' => 12,
+                'title' => 'Storefront Metrics',
+                'classList' => [],
+                'component' => null,
+                'queryParams' => [
+                    'start' => ['component' => 'date-picker'],
+                    'end' => ['component' => 'date-picker'],
+                ],
+                'widgets' => collect($metrics)
+                    ->map(function ($value, $key) use ($metricsFormats) {
+                        return [
+                            'component' => 'count',
+                            'options' => [
+                                'format' => $metricsFormats[$key] ?? null,
+                                'title' => str_replace('_', ' ', \Illuminate\Support\Str::title($key)),
+                                'value' => $value
+                            ]
+                        ];
+                    })
+                    ->values()
+                    ->toArray()
+            ]
+        ];
+
+        return response()->json(array_values($dashboardConfig));
+    }
+}