@fleetbase/storefront-engine 0.1.6 → 0.1.8

package/server/src/Http/Controllers/v1/ServiceQuoteController.php

@@ -0,0 +1,402 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Controllers\v1;
+
+use Fleetbase\Http\Controllers\Controller;
+use Fleetbase\Storefront\Http\Requests\GetServiceQuoteFromCart;
+use Fleetbase\FleetOps\Http\Resources\v1\ServiceQuote as ServiceQuoteResource;
+use Fleetbase\FleetOps\Models\Entity;
+use Fleetbase\FleetOps\Models\Place;
+use Fleetbase\FleetOps\Models\ServiceQuote;
+use Fleetbase\FleetOps\Models\ServiceQuoteItem;
+use Fleetbase\FleetOps\Models\ServiceRate;
+use Fleetbase\FleetOps\Models\IntegratedVendor;
+use Fleetbase\Storefront\Models\Store;
+use Fleetbase\Storefront\Models\Cart;
+use Fleetbase\Storefront\Models\Product;
+use Fleetbase\Storefront\Models\StoreLocation;
+use Fleetbase\FleetOps\Support\Flow;
+use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Support\Str;
+
+class ServiceQuoteController extends Controller
+{
+    /**
+     * Query for Storefront Product resources.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Fleetbase\Http\Resources\DriverCollection
+     */
+    public function fromCart(GetServiceQuoteFromCart $request)
+    {
+        $requestId = ServiceQuote::generatePublicId('request');
+        $origin = $this->getPlaceFromId($request->input('origin'));
+        $destination = $this->getPlaceFromId($request->input('destination'));
+        $facilitator = $request->input('facilitator');
+        $scheduledAt = $request->input('scheduled_at');
+        $serviceType = $request->input('service_type');
+        $cart = Cart::retrieve($request->input('cart'));
+        $currency = $cart->currency;
+        $config = $request->input('config', 'storefront');
+        $all = $request->boolean('all');
+        $isRouteOptimized = $request->boolean('is_route_optimized', true);
+        $isNetwork = Str::startsWith(session('storefront_key'), 'network_');
+
+        if ($isNetwork) {
+            return $this->fromCartForNetwork($request);
+        }
+
+        if (!$origin) {
+            return response()->error('No delivery origin!');
+        }
+
+        if (!$destination) {
+            return response()->error('No delivery destination!');
+        }
+
+        // if no cart respond with error
+        if (!$cart) {
+            return response()->error('Cart session not found!');
+        }
+
+        // if facilitator is an integrated partner resolve service quotes from bridge
+        if ($facilitator && Utils::isIntegratedVendorId($facilitator)) {
+            $integratedVendor = IntegratedVendor::where('company_uuid', session('company'))->where(function ($q) use ($facilitator) {
+                $q->where('public_id', $facilitator);
+                $q->orWhere('provider', $facilitator);
+            })->first();
+
+            if ($integratedVendor) {
+                try {
+                    /** @var \Fleetbase\Models\ServiceQuote $serviceQuote */
+                    $serviceQuote = $integratedVendor->api()->setRequestId($requestId)->getQuoteFromPreliminaryPayload([$origin, $destination], [], $serviceType, $scheduledAt, $isRouteOptimized);
+                } catch (\Exception $e) {
+                    return response()->error($e->getMessage());
+                }
+            }
+
+            // set origin and destination in service quote meta
+            $serviceQuote->updateMeta([
+                'origin' => $origin->public_id,
+                'destination' => $destination->public_id,
+            ]);
+
+            return new ServiceQuoteResource($serviceQuote);
+        }
+
+        // get distance matrix
+        $matrix = Utils::getDrivingDistanceAndTime($origin, $destination);
+
+        // create entities from cart items
+        $entities = collect($cart->items ?? [])->map(function ($cartItem) {
+            $product = Product::where('public_id', $cartItem->product_id)->first();
+
+            return Entity::fromStorefrontProduct($product);
+        });
+
+        // prepare to collect service quotes
+        $serviceQuotes = collect();
+
+        // get order configurations for ecommerce / task
+        $orderConfigs = Flow::queryOrderConfigurations(function (&$query) use ($config) {
+            $query->where('key', $config);
+        });
+
+        // get service rates for config type
+        $serviceRates = ServiceRate::whereIn('service_type', $orderConfigs->pluck('key'))->get();
+
+        // if no service rates send an empty quote
+        if ($serviceRates->isEmpty()) {
+            // if service rates is empty but there is integrated vendors, get quote from integrated vendors
+            $integratedVendor = IntegratedVendor::where('company_uuid', session('company'))->first();
+
+            if ($integratedVendor) {
+                try {
+                    /** @var \Fleetbase\Models\ServiceQuote $serviceQuote */
+                    $serviceQuote = $integratedVendor->api()->setRequestId($requestId)->getQuoteFromPreliminaryPayload([$origin, $destination], [], $serviceType, $scheduledAt, $isRouteOptimized);
+                } catch (\Exception $e) {
+                    return response()->error($e->getMessage());
+                }
+
+                // set origin and destination in service quote meta
+                $serviceQuote->updateMeta([
+                    'origin' => $origin->public_id,
+                    'destination' => $destination->public_id,
+                ]);
+
+                return new ServiceQuoteResource($serviceQuote);
+            }
+
+            return response()->error('No service rates available!');
+        }
+
+        foreach ($serviceRates as $serviceRate) {
+            // get a quote from each rate and send back the best
+            [$subTotal, $lines] = $serviceRate->quoteFromPreliminaryData($entities, [$origin, $destination], $matrix->distance, $matrix->time, false);
+
+            $quote = ServiceQuote::create([
+                'request_id' => $requestId,
+                'company_uuid' => $serviceRate->company_uuid,
+                'service_rate_uuid' => $serviceRate->uuid,
+                'amount' => $subTotal,
+                'currency' => $serviceRate->currency,
+                'meta' => [
+                    'origin' => $origin->public_id,
+                    'destination' => $destination->public_id,
+                ]
+            ]);
+
+            $items = $lines->map(function ($line) use ($quote) {
+                return ServiceQuoteItem::create([
+                    'service_quote_uuid' => $quote->uuid,
+                    'amount' => $line['amount'],
+                    'currency' => $line['currency'],
+                    'details' => $line['details'],
+                    'code' => $line['code'],
+                ]);
+            });
+
+            $quote->setRelation('items', $items);
+            $serviceQuotes->push($quote);
+        }
+
+        // if user is requesting all return all service quotes
+        if ($all) {
+            return ServiceQuoteResource::collection($serviceQuotes);
+        }
+
+        // filter by currency
+        $matchingCurrency = $serviceQuotes->where('currency', $currency);
+
+        if ($matchingCurrency->count()) {
+            $bestQuote = $matchingCurrency->sortBy('amount')->first();
+
+            return new ServiceQuoteResource($bestQuote);
+        }
+
+        // get the best service quote
+        $bestQuote = $serviceQuotes->sortBy('amount')->first();
+
+        return new ServiceQuoteResource($bestQuote);
+    }
+    /**
+     * Query for Storefront Product resources.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Fleetbase\Http\Resources\DriverCollection
+     */
+    public function fromCartForNetwork(GetServiceQuoteFromCart $request)
+    {
+        $requestId = ServiceQuote::generatePublicId('request');
+        // $origin = $this->getPlaceFromId($request->input('origin'));
+        $destination = $this->getPlaceFromId($request->input('destination'));
+        $facilitator = $request->input('facilitator');
+        $scheduledAt = $request->input('scheduled_at');
+        $serviceType = $request->input('service_type');
+        $cart = Cart::retrieve($request->input('cart'));
+        $currency = $cart->currency;
+        $config = $request->input('config', 'storefront');
+        $all = $request->boolean('all');
+        $isRouteOptimized = $request->boolean('is_route_optimized', true);
+
+        // make sure destination is set
+        if (!$destination) {
+            return response()->error('No delivery destination!');
+        }
+
+        // if no cart respond with error
+        if (!$cart) {
+            return response()->error('Cart session not found!');
+        }
+
+        // collect stores
+        $storeLocations = collect($cart->items)->map(function ($cartItem) {
+            $storeLocationId = $cartItem->store_location_id;
+
+            // if no store location id set, use first locations id
+            if (!$storeLocationId) {
+                $store = Store::where('public_id', $cartItem->store_id)->first();
+
+                if ($store) {
+                    $storeLocationId = Utils::get($store, 'locations.0.public_id');
+                }
+            }
+
+            return $storeLocationId;
+        })->unique()->filter()->map(function ($storeLocationId) {
+            return StoreLocation::where('public_id', $storeLocationId)->with(['store', 'place'])->first();
+        });
+
+        // fallback store locations using origin param
+        if ($storeLocations->isEmpty()) {
+            $storeLocationIds = $request->input('origin', []);
+
+            if (is_string($storeLocationIds) && Str::contains($storeLocationIds, ',')) {
+                $storeLocationIds = explode(',', $storeLocationIds);
+            }
+
+            $storeLocations = collect($storeLocationIds)->unique()->filter()->map(function ($storeLocationId) {
+                return StoreLocation::where('public_id', $storeLocationId)->with(['store', 'place'])->first();
+            });
+        }
+
+        // get origins
+        $origins = $storeLocations->map(function ($storeLocation) {
+            return $storeLocation->place;
+        });
+
+        // if facilitator is an integrated partner resolve service quotes from bridge
+        if ($facilitator && Utils::isIntegratedVendorId($facilitator)) {
+            $integratedVendor = IntegratedVendor::where('company_uuid', session('company'))->where(function ($q) use ($facilitator) {
+                $q->where('public_id', $facilitator);
+                $q->orWhere('provider', $facilitator);
+            })->first();
+
+            if ($integratedVendor) {
+                try {
+                    /** @var \Fleetbase\Models\ServiceQuote $serviceQuote */
+                    $serviceQuote = $integratedVendor->api()->setRequestId($requestId)->getQuoteFromPreliminaryPayload([...$origins, $destination], [], $serviceType, $scheduledAt, $isRouteOptimized);
+                } catch (\Exception $e) {
+                    return response()->error($e->getMessage());
+                }
+            }
+
+            // set origin and destination in service quote meta
+            $serviceQuote->updateMeta([
+                'origin' => $origins->pluck('public_id')->toArray(),
+                'destination' => $destination->public_id,
+            ]);
+
+            return new ServiceQuoteResource($serviceQuote);
+        }
+
+        // get distance matrix
+        // $matrix = Utils::getDrivingDistanceAndTime($origin, $destination);
+        $matrix = Utils::distanceMatrix($origins, [$destination]);
+
+        // create entities from cart items
+        $entities = collect($cart->items ?? [])->map(function ($cartItem) {
+            $product = Product::where('public_id', $cartItem->product_id)->first();
+
+            return Entity::fromStorefrontProduct($product);
+        });
+
+        // prepare to collect service quotes
+        $serviceQuotes = collect();
+
+        // get order configurations for ecommerce / task
+        $orderConfigs = Flow::queryOrderConfigurations(function (&$query) use ($config) {
+            $query->where('key', $config);
+        });
+
+        // get service rates for config type
+        $serviceRates = ServiceRate::whereIn('service_type', $orderConfigs->pluck('key'))->get();
+
+        // if no service rates send an empty quote
+        if ($serviceRates->isEmpty()) {
+            // if service rates is empty but there is integrated vendors, get quote from integrated vendors
+            $integratedVendor = IntegratedVendor::where('company_uuid', session('company'))->first();
+
+            if ($integratedVendor) {
+                try {
+                    /** @var \Fleetbase\FleetOps\Models\ServiceQuote $serviceQuote */
+                    $serviceQuote = $integratedVendor->api()->setRequestId($requestId)->getQuoteFromPreliminaryPayload([...$origins, $destination], [], $serviceType, $scheduledAt, $isRouteOptimized);
+                } catch (\Exception $e) {
+                    return response()->error($e->getMessage());
+                }
+
+                // set origin and destination in service quote meta
+                $serviceQuote->updateMeta([
+                    'origin' => $origins->pluck('public_id')->toArray(),
+                    'destination' => $destination->public_id,
+                ]);
+
+                return new ServiceQuoteResource($serviceQuote);
+            }
+
+            return response()->error('No service rates available!');
+        }
+
+        foreach ($serviceRates as $serviceRate) {
+            // get a quote from each rate and send back the best
+            [$subTotal, $lines] = $serviceRate->quoteFromPreliminaryData($entities, [...$origins, $destination], $matrix->distance, $matrix->time, false);
+
+            $quote = ServiceQuote::create([
+                'request_id' => $requestId,
+                'company_uuid' => $serviceRate->company_uuid,
+                'service_rate_uuid' => $serviceRate->uuid,
+                'amount' => $subTotal,
+                'currency' => $serviceRate->currency,
+                'meta' => [
+                    'origin' => $origins->pluck('public_id')->toArray(),
+                    'destination' => $destination->public_id,
+                ]
+            ]);
+
+            $items = $lines->map(function ($line) use ($quote) {
+                return ServiceQuoteItem::create([
+                    'service_quote_uuid' => $quote->uuid,
+                    'amount' => $line['amount'],
+                    'currency' => $line['currency'],
+                    'details' => $line['details'],
+                    'code' => $line['code'],
+                ]);
+            });
+
+            $quote->setRelation('items', $items);
+            $serviceQuotes->push($quote);
+        }
+
+        // if user is requesting all return all service quotes
+        if ($all) {
+            return ServiceQuoteResource::collection($serviceQuotes);
+        }
+
+        // filter by currency
+        $matchingCurrency = $serviceQuotes->where('currency', $currency);
+
+        if ($matchingCurrency->count()) {
+            $bestQuote = $matchingCurrency->sortBy('amount')->first();
+
+            return new ServiceQuoteResource($bestQuote);
+        }
+
+        // get the best service quote
+        $bestQuote = $serviceQuotes->sortBy('amount')->first();
+
+        return new ServiceQuoteResource($bestQuote);
+    }
+
+    /**
+     * Returns a place from either a place id or store location id.
+     *
+     * @param string $id
+     * @return Place
+     */
+    public function getPlaceFromId($id)
+    {
+        if (Str::startsWith($id, 'store_location')) {
+            $storeLocation = StoreLocation::select(['place_uuid'])->where(['public_id' => $id, 'store_uuid' => session('storefront_store')])->with(['place'])->first();
+
+            if (!$storeLocation) {
+                return null;
+            }
+
+            return $storeLocation->place;
+        }
+
+        if (Str::startsWith($id, 'place')) {
+            return Place::where(['public_id' => $id, 'company_uuid' => session('company')])->first();
+        }
+
+        // handle coordinates tooo!
+        if (!Str::startsWith($id, ['place_', 'store_location']) && Utils::isCoordinates($id)) {
+            $point = Utils::getPointFromCoordinates($id);
+            $place = Place::createFromCoordinates($point, ['company_uuid' => session('company')], true);
+
+            return $place;
+        }
+
+        return Place::where(['public_id' => $id, 'company_uuid' => session('company')])->first();
+    }
+}

package/server/src/Http/Controllers/v1/StoreController.php

@@ -0,0 +1,176 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Controllers\v1;
+
+use Fleetbase\Http\Controllers\Controller;
+use Fleetbase\Storefront\Http\Resources\Gateway as GatewayResource;
+use Fleetbase\Storefront\Http\Resources\Network;
+use Fleetbase\Storefront\Http\Resources\Product as ProductResource;
+use Fleetbase\Storefront\Http\Resources\Store as StorefrontStore;
+use Fleetbase\Storefront\Http\Resources\StoreLocation as StoreLocationResource;
+use Fleetbase\Storefront\Models\Gateway;
+use Fleetbase\Storefront\Models\Product;
+use Fleetbase\Storefront\Models\Store;
+use Fleetbase\Storefront\Models\StoreLocation;
+use Fleetbase\Storefront\Support\Storefront;
+use Illuminate\Http\Request;
+use Illuminate\Support\Str;
+
+class StoreController extends Controller
+{
+    /**
+     * Returns general information and settings about the storefront or network given the key.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function about()
+    {
+        $about = Storefront::about('*');
+
+        if (!$about) {
+            return response()->error('Unable to find store!');
+        }
+
+        if ($about->is_store) {
+            return new StorefrontStore($about);
+        }
+
+        return new Network($about);
+    }
+
+    /**
+     * Returns all locations and their hours for the current store.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function locations(Request $request)
+    {
+        if (session('storefront_network') && $request->missing('store')) {
+            return response()->error('Networks cannot have locations!');
+        }
+
+        if ($request->filled('store')) {
+            $locations = StoreLocation::whereHas('store', function ($q) use ($request) {
+                $q->where('public_id', $request->input('store'));
+            })->with(['place', 'hours'])->get();
+        } else {
+            $locations = StoreLocation::where('store_uuid', session('storefront_store'))->with(['place', 'hours'])->get();
+        }
+
+        return StoreLocationResource::collection($locations);
+    }
+
+    /**
+     * Returns a specific store location given the id.
+     *
+     * @param  string $id
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function location(string $id, Request $request)
+    {
+        if (session('storefront_network') && $request->missing('store')) {
+            return response()->error('Networks cannot have locations!');
+        }
+
+        $storeId = $request->input('store', session('storefront_store'));
+        $store = Store::where('public_id', $storeId)->orWhere('uuid', $storeId)->first();
+
+        $location = StoreLocation::where([
+            'public_id' => $id,
+            'store_uuid' => $store->uuid
+        ])
+            ->with(['place', 'hours'])
+            ->first();
+
+        return new StoreLocationResource($location);
+    }
+
+    /**
+     * Returns all payment gateways for the current store.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function gateways(Request $request)
+    {
+        $id = session('storefront_store') ?? session('storefront_network');
+
+        $sandbox = $request->input('sandbox', false);
+        $query = Gateway::select(['public_id', 'name', 'code', 'type', 'sandbox', 'return_url', 'callback_url'])->where('owner_uuid', $id);
+
+        if ($sandbox) {
+            $query->where('sandbox', 1);
+        }
+
+        // fetch all gateways available
+        $gateways = $query->get();
+
+        // create cod/cash gateway if enabled
+        // @var \Fleetbase\Models\Storefront\Store|\Fleetbase\Models\Storefront\Network $about
+        $about = Storefront::about();
+
+        // if cod is enabled add cash as a gateway
+        if ($about->hasOption('cod_enabled')) {
+            $gateways->push(Gateway::cash($sandbox));
+        }
+
+        return GatewayResource::collection($gateways);
+    }
+
+    /**
+     * Returns a specific payment gateway given the id.
+     *
+     * @param  string $id
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function gateway(string $id, Request $request)
+    {
+        $ownerId = session('storefront_store') ?? session('storefront_network');
+
+        $sandbox = $request->input('sandbox', false);
+        $query = Gateway::select(['public_id', 'name', 'code', 'type', 'sandbox', 'return_url', 'callback_url'])->where(['public_id' => $id, 'owner_uuid' => $ownerId]);
+
+        if ($sandbox) {
+            $query->where('sandbox', 1);
+        }
+
+        // fetch all gateways available
+        $gateway = $query->first();
+
+        return new GatewayResource($gateway);
+    }
+
+    /**
+     * Search current store or network.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function search(Request $request)
+    {
+        $searchQuery = $request->input('query', '');
+        $limit = $request->input('limit', 14);
+        $store = $request->input('store');
+        $key = session('storefront_key');
+
+        if (Str::startsWith($key, 'store')) {
+            $results = Product::where('store_uuid', session('storefront_store'))
+                ->search($searchQuery)
+                ->limit($limit)
+                ->whereNull('deleted_at')
+                ->whereIsAvailable(1)
+                ->whereStatus('published')
+                ->get();
+
+            return ProductResource::collection($results);
+        }
+
+        $results = Product::findFromNetwork($searchQuery, $store, $limit);
+
+        return ProductResource::collection($results);
+    }
+}

package/server/src/Http/Filter/AddonCategoryFilter.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Filter;
+
+use Fleetbase\Http\Filter\Filter;
+
+class AddonCategoryFilter extends Filter
+{
+    public function queryForInternal()
+    {
+        // Query only this company sessions resources
+        $this->builder->where(
+            [
+                'company_uuid' => $this->session->get('company'),
+                'for' => 'storefront_product_addon'
+            ]
+        );
+    }
+}

package/server/src/Http/Filter/CustomerFilter.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Filter;
+
+use Fleetbase\FleetOps\Http\Filter\ContactFilter;
+
+class CustomerFilter extends ContactFilter
+{
+    public function storefront($storefront)
+    {
+        $this->builder->whereHas(
+            'customerOrders',
+            function ($query) use ($storefront) {
+                $query->where('meta->storefront_id', $storefront);
+            }
+        );
+    }
+}

package/server/src/Http/Filter/GatewayFilter.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Filter;
+
+use Fleetbase\Http\Filter\Filter;
+
+class GatewayFilter extends Filter
+{
+    public function queryForInternal()
+    {
+        $this->builder->where('company_uuid', $this->session->get('company'));
+    }
+}

package/server/src/Http/Filter/NetworkFilter.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Filter;
+
+use Fleetbase\Http\Filter\Filter;
+
+class NetworkFilter extends Filter
+{
+    public function queryForInternal()
+    {
+        $this->builder->where('company_uuid', $this->session->get('company'));
+    }
+
+    public function query(?string $searchQuery)
+    {
+        $this->builder->search($searchQuery);
+    }
+}

package/server/src/Http/Filter/NotificationChannelFilter.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Filter;
+
+use Fleetbase\Http\Filter\Filter;
+
+class NotificationChannelFilter extends Filter
+{
+    public function queryForInternal()
+    {
+        $this->builder->where('company_uuid', $this->session->get('company'));
+    }
+}