@fleetbase/storefront-engine 0.4.4 → 0.4.5

package/addon/templates/settings/locations.hbs

@@ -23,10 +23,10 @@
             </div>
 
             {{#each @model as |storeLocation|}}
-                <ContentPanel @title={{storeLocation.name}} @open={{true}} @pad={{true}}>
+                <ContentPanel @title={{storeLocation.name}} @open={{true}} @pad={{false}} @wrapperClass="bordered-classic">
                     <div class="flex items-center justify-between mb-4">
                         <div>
-                            <h4 class="dark:text-gray-100 text-base font-semibold">{{t "storefront.settings.locations.store-hour"}}</h4>
+                            <h4 class="text-sm tracking-wide uppercase text-gray-700 dark:text-gray-400 font-semibold">{{t "storefront.settings.locations.store-hour"}}</h4>
                         </div>
                         <div class="flex items-center">
                             <Button @icon="edit" @text={{t "storefront.common.edit"}} @onClick={{fn this.editStoreLocation storeLocation}} @wrapperClass="mr-2" />

package/addon/templates/settings.hbs

@@ -1,30 +1,8 @@
-<Layout::Section::Header @title={{t "storefront.common.settings"}} class="align-items-unset" @actionsWrapperClass="align-items-end-i">
-    <div class="ui-tabs w-full border-b-0i">
-        <nav>
-            <LinkTo @route="settings.index" class="ui-tab">
-                <FaIcon @icon="cog" @prefix="fas" class="mr-1" />
-                <span>{{t "storefront.common.general"}}</span>
-            </LinkTo>
-            <LinkTo @route="settings.locations" class="ui-tab">
-                <FaIcon @icon="map-marker-alt" class="mr-1" />
-                <span>{{t "storefront.common.location"}}</span>
-            </LinkTo>
-            <LinkTo @route="settings.gateways" class="ui-tab">
-                <FaIcon @icon="cash-register" class="mr-1" />
-                <span>{{t "storefront.common.gateways"}}</span>
-            </LinkTo>
-            <LinkTo @route="settings.api" class="ui-tab">
-                <FaIcon @icon="code" class="mr-1" />
-                <span>{{t "storefront.common.api"}}</span>
-            </LinkTo>
-            <LinkTo @route="settings.notifications" class="ui-tab">
-                <FaIcon @icon="bell-concierge" class="mr-1" />
-                <span>{{t "storefront.common.notification"}}</span>
-            </LinkTo>
-        </nav>
-    </div>
-</Layout::Section::Header>
-
-<Layout::Section::Body>
-    {{outlet}}
-</Layout::Section::Body>
+<TabNavigation @tabs={{this.tabs}} @contentClass="scrollable" @tablistClass="px-4 flex-row-reverse">
+    <:actions>
+        <h3 class="uppercase text-xs tracking-wide text-gray-700 dark:text-gray-400 font-semibold">{{t "storefront.common.settings"}}</h3>
+    </:actions>
+    <:default>
+        {{outlet}}
+    </:default>
+</TabNavigation>

package/addon/utils/get-gateway-schemas.js

@@ -17,6 +17,8 @@ export default function getGatewaySchemas() {
             username: '',
             password: '',
             invoice_id: '',
+            ebarimt_invoice_id: '',
+            district_code: '',
         },
         manual: {
             public_key: '',

package/app/controllers/settings.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/storefront-engine/controllers/settings';

package/composer.json

@@ -1,6 +1,6 @@
 {
     "name": "fleetbase/storefront-api",
-    "version": "0.4.4",
+    "version": "0.4.5",
     "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "keywords": [
         "fleetbase-extension",

package/extension.json

@@ -1,6 +1,6 @@
 {
     "name": "Storefront",
-    "version": "0.4.4",
+    "version": "0.4.5",
     "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "repository": "https://github.com/fleetbase/storefront",
     "license": "AGPL-3.0-or-later",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fleetbase/storefront-engine",
-    "version": "0.4.4",
+    "version": "0.4.5",
     "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "fleetbase": {
         "route": "storefront",
@@ -45,7 +45,7 @@
     "dependencies": {
         "@babel/core": "^7.23.2",
         "@fleetbase/ember-core": "^0.3.6",
-        "@fleetbase/ember-ui": "^0.3.8",
+        "@fleetbase/ember-ui": "^0.3.9",
         "@fleetbase/fleetops-data": "^0.1.20",
         "@fortawesome/ember-fontawesome": "^2.0.0",
         "@fortawesome/fontawesome-svg-core": "6.4.0",

package/server/config/storefront.php

@@ -35,5 +35,15 @@ return [
     */
     'connection' => [
         'db' => env('STOREFRONT_DB_CONNECTION', 'storefront')
-    ]
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Throttle/Rate-Limiting
+    |--------------------------------------------------------------------------
+    */
+    'throttle' => [
+        'max_attempts' => env('STOREFRONT_THROTTLE_REQUESTS_PER_MINUTE', 500),
+        'decay_minutes' => env('STOREFRONT_THROTTLE_DECAY_MINUTES', 1),
+    ],
 ];

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

@@ -435,7 +435,6 @@ class CheckoutController extends Controller
 
         // Create qpay instance
         $qpay = QPay::instance($gateway->config->username, $gateway->config->password, $gateway->callback_url);
-
         if ($gateway->sandbox) {
             $qpay = $qpay->useSandbox();
         }
@@ -471,15 +470,44 @@ class CheckoutController extends Controller
         $callbackUrl = Utils::apiUrl('storefront/v1/checkouts/capture-qpay', $callbackParams);
 
         // Create invoice description
-        // $invoiceAmount       = round($amount / 100);
+        $ebarimtInvoiceCode  = $gateway->sandbox ? 'TEST_INVOICE' : $gateway->config?->ebarimt_invoice_id ?? null;
         $invoiceAmount       = $amount;
-        $invoiceCode         = $gateway->sandbox ? 'TEST_INVOICE' : $gateway->config->invoice_id;
+        $invoiceCode         = $gateway->sandbox ? 'TEST_INVOICE' : $gateway->config?->invoice_id ?? null;
         $invoiceDescription  = $about->name . ' cart checkout';
         $invoiceReceiverCode = $checkout->public_id;
         $senderInvoiceNo     = $checkout->public_id;
+        $districtCode        = $gateway->config?->district_code ?? null;
+        $invoiceReceiverData = Utils::filterArray([
+            'name'     => $customer->name,
+            'email'    => $customer->email ?? null,
+            'phone'    => $customer->phone ?? null,
+        ]);
+        $lines = [];
+        foreach ($cart->items as $item) {
+            $lines[] = [
+                'line_description'    => $item->name,
+                'line_quantity'       => $item->quantity ?? 1,
+                'line_unit_price'     => number_format($item->price, 2, '.', ''),
+                'note'                => $checkout->public_id,
+                'classification_code' => '0111100',
+                'taxes'               => [
+                    [
+                        // 'tax_code'    => 'VAT', // only works without this
+                        'description' => 'НӨАТ',
+                        'amount'      => QPay::calculateTax($item->subtotal),
+                        'note'        => $checkout->public_id,
+                    ],
+                ],
+            ];
+        }
 
         // Create qpay invoice
-        $invoice = $qpay->createSimpleInvoice($invoiceAmount, $invoiceCode, $invoiceDescription, $invoiceReceiverCode, $senderInvoiceNo, $callbackUrl);
+        $invoice = null;
+        if ($ebarimtInvoiceCode) {
+            $invoice = $qpay->createEbarimtInvoice($ebarimtInvoiceCode, $senderInvoiceNo, $invoiceReceiverCode, $invoiceReceiverData, $invoiceDescription, '1', $districtCode, $lines);
+        } else {
+            $invoice = $qpay->createSimpleInvoice($invoiceAmount, $invoiceCode, $invoiceDescription, $invoiceReceiverCode, $senderInvoiceNo, $callbackUrl);
+        }
 
         // Update checkout with invoice id
         $checkout->updateOption('qpay_invoice_id', data_get($invoice, 'invoice_id'));
@@ -895,6 +923,7 @@ class CheckoutController extends Controller
             'delivery_tip' => $checkout->getOption('delivery_tip'),
             'total'        => Utils::numbersOnly($amount),
             'currency'     => $currency,
+            'gateway'      => $gateway->type,
             'require_pod'  => $about->getOption('require_pod'),
             'pod_method'   => $about->pod_method,
             'is_pickup'    => $checkout->is_pickup,
@@ -945,9 +974,6 @@ class CheckoutController extends Controller
         // notify driver if assigned
         $order->notifyDriverAssigned();
 
-        // notify order creation
-        Storefront::alertNewOrder($order);
-
         // purchase service quote
         if ($serviceQuote) {
             $order->purchaseQuote($serviceQuote->uuid, $transactionDetails);
@@ -961,6 +987,9 @@ class CheckoutController extends Controller
             }
         }
 
+        // notify order creation
+        Storefront::alertNewOrder($order);
+
         // update the cart with the checkout
         $checkout->checkedout();
 
@@ -1139,6 +1168,7 @@ class CheckoutController extends Controller
                 'delivery_tip'          => 0,
                 'total'                 => $subtotal,
                 'currency'              => $currency,
+                'gateway'               => $gateway->type,
                 'require_pod'           => $about->getOption('require_pod'),
                 'pod_method'            => $about->pod_method,
                 'is_pickup'             => $checkout->is_pickup,
@@ -1180,9 +1210,6 @@ class CheckoutController extends Controller
             // purchase service quote
             $order->purchaseQuote($serviceQuote->uuid, $transactionDetails);
 
-            // notify order creation
-            Storefront::alertNewOrder($order);
-
             // if order is auto accepted update status
             if ($store->isOption('auto_accept_orders')) {
                 Storefront::autoAcceptOrder($order);
@@ -1190,6 +1217,9 @@ class CheckoutController extends Controller
                     Storefront::autoDispatchOrder($order);
                 }
             }
+
+            // notify order creation
+            Storefront::alertNewOrder($order);
         }
 
         // convert origin to Place
@@ -1225,6 +1255,7 @@ class CheckoutController extends Controller
             'delivery_tip'          => $checkout->getOption('delivery_tip'),
             'total'                 => Utils::numbersOnly($amount),
             'currency'              => $currency,
+            'gateway'               => $gateway->type,
             'require_pod'           => $about->getOption('require_pod'),
             'pod_method'            => $about->pod_method,
             'is_pickup'             => $checkout->is_pickup,

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

@@ -336,7 +336,7 @@ class CustomerController extends Controller
     public function query(Request $request)
     {
         $results = Contact::queryWithRequest($request, function (&$query, $request) {
-            $query->where(['type' => 'customer']);
+            $query->where(['type' => 'customer', 'company_uuid' => session('company')]);
         });
 
         return Customer::collection($results);

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

@@ -4,7 +4,10 @@ namespace Fleetbase\Storefront\Http\Controllers\v1;
 
 use Fleetbase\FleetOps\Models\Order;
 use Fleetbase\Http\Controllers\Controller;
+use Fleetbase\Storefront\Models\Checkout;
+use Fleetbase\Storefront\Support\QPay;
 use Fleetbase\Storefront\Support\Storefront;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 
 class OrderController extends Controller
@@ -17,8 +20,11 @@ class OrderController extends Controller
     public function completeOrderPickup(Request $request)
     {
         $customer = Storefront::getCustomerFromToken();
-        $order    = Order::where('public_id', $request->order)->whereNull('deleted_at')->with(['customer'])->first();
+        if (!$customer) {
+            return response()->apiError('Customer is not authenticated.');
+        }
 
+        $order    = Order::where('public_id', $request->order)->whereNull('deleted_at')->with(['customer'])->first();
         if (!$order) {
             return response()->apiError('No order found.');
         }
@@ -40,4 +46,195 @@ class OrderController extends Controller
             'status' => $order->status,
         ]);
     }
+
+    /**
+     * Get receipt for an order based on the payment method type.
+     *
+     * This method acts as a router that delegates receipt generation to the appropriate
+     * handler based on the order's payment method. It performs authentication and authorization
+     * checks before routing to the specific receipt handler.
+     *
+     * @param Request $request The HTTP request containing the order identifier
+     *
+     * @return JsonResponse The receipt data or error response
+     */
+    public function getReceipt(Request $request)
+    {
+        // Authenticate customer
+        $customer = Storefront::getCustomerFromToken();
+        if (!$customer) {
+            return response()->apiError('Customer is not authenticated.');
+        }
+
+        // Retrieve order
+        $order = Order::where('public_id', $request->order)
+            ->whereNull('deleted_at')
+            ->with(['customer', 'payload'])
+            ->first();
+
+        if (!$order) {
+            return response()->apiError('No order found.');
+        }
+
+        // Authorize customer for this order
+        if ($order->customer_uuid !== $customer->uuid) {
+            return response()->apiError('Not authorized to get receipt for this order.');
+        }
+
+        // Route to appropriate receipt handler based on payment method
+        $paymentMethod = $order->payload->payment_method ?? null;
+
+        switch ($paymentMethod) {
+            case 'qpay':
+                return $this->getQpayEbarimtReceipt($request, $order);
+
+                // Add more payment methods here in the future
+                // case 'stripe':
+                //     return $this->getStripeReceipt($request, $order);
+                // case 'paypal':
+                //     return $this->getPaypalReceipt($request, $order);
+
+            default:
+                return response()->json([
+                    'message'        => 'No receipt available for this payment method.',
+                    'payment_method' => $paymentMethod,
+                ]);
+        }
+    }
+
+    /**
+     * Get Ebarimt receipt for QPay payment.
+     *
+     * This helper method handles the complete flow of generating an Ebarimt receipt
+     * for orders paid through QPay. It validates the request parameters, retrieves
+     * the payment information from QPay, creates the Ebarimt receipt, and stores
+     * the receipt data in the order metadata.
+     *
+     * @param Request $request The HTTP request containing Ebarimt parameters
+     * @param Order   $order   The order instance for which to generate the receipt
+     *
+     * @return JsonResponse The Ebarimt receipt data or error response
+     */
+    private function getQpayEbarimtReceipt(Request $request, Order $order)
+    {
+        // Extract and validate Ebarimt parameters
+        $ebarimtReceiverType = strtoupper($request->input('ebarimt_receiver_type', 'CITIZEN'));
+        $ebarimtReceiver     = $request->input('ebarimt_receiver');
+
+        if ($ebarimtReceiverType === 'COMPANY' && empty($ebarimtReceiver)) {
+            return response()->apiError('Company registration number is required.');
+        }
+
+        // Verify payment method is QPay
+        $order->loadMissing('payload');
+        if ($order->payload && $order->payload->payment_method !== 'qpay') {
+            return response()->apiError('This order was not paid using QPay.');
+        }
+
+        // Retrieve checkout record
+        $checkout = $order->getMeta('checkout_id')
+            ? Checkout::where('public_id', $order->getMeta('checkout_id'))->first()
+            : null;
+
+        if (!$checkout) {
+            return response()->apiError('No checkout found for this order.');
+        }
+
+        // Initialize QPay gateway
+        $qpay = $this->initializeQpayGateway();
+        if ($qpay instanceof JsonResponse) {
+            return $qpay; // Return error response if gateway initialization failed
+        }
+
+        // Retrieve payment information from QPay
+        $invoiceId = $checkout->getOption('qpay_invoice_id');
+        $payment   = $qpay->getPayment($invoiceId);
+
+        // Create Ebarimt receipt
+        $ebarimt = $this->createEbarimtReceipt($qpay, $payment, $ebarimtReceiverType, $ebarimtReceiver);
+
+        if ($ebarimt instanceof JsonResponse) {
+            return $ebarimt; // Return error response if creation failed
+        }
+
+        // Store receipt in order metadata
+        $order->updateMeta('ebarimt', $ebarimt);
+
+        return response()->json($ebarimt);
+    }
+
+    /**
+     * Initialize and configure the QPay gateway instance.
+     *
+     * This method retrieves the QPay gateway configuration, creates a QPay instance
+     * with the appropriate credentials, configures sandbox mode if enabled, and
+     * sets the authentication token.
+     *
+     * @return QPay|JsonResponse The configured QPay instance or error response
+     */
+    private function initializeQpayGateway()
+    {
+        // Resolve gateway configuration
+        $gateway = Storefront::findGateway('qpay');
+        if (!$gateway) {
+            return response()->apiError('QPay is not configured.');
+        }
+
+        // Create QPay instance with credentials
+        $qpay = QPay::instance(
+            $gateway->config->username,
+            $gateway->config->password,
+            $gateway->callback_url
+        );
+
+        // Configure sandbox mode if enabled
+        if ($gateway->sandbox) {
+            $qpay = $qpay->useSandbox();
+        }
+
+        // Set authentication token
+        $qpay = $qpay->setAuthToken();
+
+        return $qpay;
+    }
+
+    /**
+     * Create an Ebarimt receipt via QPay API.
+     *
+     * This method prepares the parameters for the Ebarimt receipt creation request,
+     * sends the request to the QPay Ebarimt API, and handles any errors that occur
+     * during the process.
+     *
+     * @param QPay        $qpay         The configured QPay instance
+     * @param mixed       $payment      The payment information retrieved from QPay
+     * @param string      $receiverType The type of receiver (CITIZEN or COMPANY)
+     * @param string|null $receiver     The company registration number (required if receiverType is COMPANY)
+     *
+     * @return mixed|JsonResponse The Ebarimt receipt data or error response
+     */
+    private function createEbarimtReceipt(QPay $qpay, $payment, string $receiverType, ?string $receiver = null)
+    {
+        // Prepare request parameters
+        $params = [
+            'payment_id'            => data_get($payment, 'payment_id'),
+            'ebarimt_receiver_type' => $receiverType,
+        ];
+
+        // Add company registration number if receiver type is COMPANY
+        if ($receiverType === 'COMPANY' && !empty($receiver)) {
+            $params['ebarimt_receiver'] = $receiver;
+        }
+
+        // Send request to QPay Ebarimt API
+        $ebarimt = $qpay->post('ebarimt_v3/create', $params);
+
+        // Check for API errors
+        if (isset($ebarimt->error)) {
+            return response()->apiError(
+                $ebarimt->error ?? $ebarimt->message ?? 'Unable to create ebarimt receipt'
+            );
+        }
+
+        return $ebarimt;
+    }
 }

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

@@ -8,35 +8,41 @@ class OrderFilter extends FleetOpsOrderFilter
 {
     public function queryForInternal()
     {
-        $this->builder
-            ->where(
-                [
-                    'company_uuid' => $this->session->get('company'),
-                    'type'         => 'storefront',
-                ]
-            )
-            ->whereHas(
-                'payload',
-                function ($q) {
-                    $q->where(
-                        function ($q) {
-                            $q->whereHas('waypoints');
-                            $q->orWhereHas('pickup');
-                            $q->orWhereHas('dropoff');
-                        }
-                    );
-                    $q->with(['entities', 'waypoints', 'dropoff', 'pickup', 'return']);
-                }
-            )
-            ->whereHas('trackingNumber')
-            ->whereHas('trackingStatuses')
-            ->with(
-                [
-                    'payload',
-                    'trackingNumber',
-                    'trackingStatuses',
-                ]
-            );
+        $this->builder->where('company_uuid', $this->session->get('company'));
+        $this->builder->whereNotNull('meta->storefront_id');
+
+        // replace ambiguous whereRelation with qualified whereHas to avoid alias clashes
+        $this->builder->whereHas('payload', function ($payloadQuery) {
+            $payloadQuery->where(function ($q) {
+                $q->orWhereHas('pickup', function ($p) {
+                    $p->whereNotNull('places.uuid');
+                });
+                $q->orWhereHas('dropoff', function ($d) {
+                    $d->whereNotNull('places.uuid');
+                });
+            });
+        });
+
+        // ensure associated tracking data exists
+        $this->builder->whereHas('trackingNumber', function ($q) {
+            $q->select('uuid');
+        });
+
+        $this->builder->whereHas('trackingStatuses', function ($q) {
+            $q->select('uuid');
+        });
+
+        // eager load main relationships to reduce N+1 overhead
+        $this->builder->with([
+            'payload.entities',
+            'payload.waypoints',
+            'payload.pickup',
+            'payload.dropoff',
+            'payload.return',
+            'trackingNumber',
+            'trackingStatuses',
+            'driverAssigned',
+        ]);
     }
 
     public function storefront(string $storefront)

package/server/src/Http/Middleware/ThrottleRequests.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Fleetbase\Storefront\Http\Middleware;
+
+use Illuminate\Routing\Middleware\ThrottleRequests as ThrottleRequestsMiddleware;
+
+class ThrottleRequests extends ThrottleRequestsMiddleware
+{
+    public function handle($request, \Closure $next, $maxAttempts = null, $decayMinutes = null, $prefix = '')
+    {
+        $maxAttempts  = config('storefront.throttle.max_attempts', 500);
+        $decayMinutes = config('storefront.throttle.decay_minutes', 1);
+
+        return parent::handle($request, $next, $maxAttempts, $decayMinutes, $prefix);
+    }
+}

package/server/src/Models/Cart.php

@@ -114,7 +114,7 @@ class Cart extends StorefrontModel
      */
     public function setEventsAttribute($events)
     {
-        $this->attributes['items'] = json_encode($events);
+        $this->attributes['events'] = json_encode($events);
     }
 
     /**

package/server/src/Providers/StorefrontServiceProvider.php

@@ -38,7 +38,7 @@ class StorefrontServiceProvider extends CoreServiceProvider
      */
     public $middleware = [
         'storefront.api' => [
-            'throttle:80,1',
+            \Fleetbase\Storefront\Http\Middleware\ThrottleRequests::class,
             \Illuminate\Session\Middleware\StartSession::class,
             \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
             \Fleetbase\Storefront\Http\Middleware\SetStorefrontSession::class,