@fleetbase/storefront-engine 0.3.2 → 0.3.4

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_carts_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_checkouts_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_gateways_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_network_stores_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_networks_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_notification_channels_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_payment_methods_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_addon_categories_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_addons_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_hours_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_store_locations_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_variant_options_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_variants_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_products_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_reviews_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_store_hours_table.php

@@ -4,8 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_store_locations_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_stores_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/migrations/2023_05_03_025310_add_foreign_keys_to_votes_table.php

@@ -1,13 +1,12 @@
 <?php
 
+use Fleetbase\Support\Utils;
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
-use Fleetbase\Support\Utils;
 
-return new class extends Migration
-{
+return new class() extends Migration {
     /**
      * Run the migrations.
      *

package/server/seeders/OrderConfigSeeder.php

@@ -0,0 +1,270 @@
+<?php
+
+namespace Fleetbase\Storefront\Seeders;
+
+use Fleetbase\FleetOps\Models\OrderConfig;
+use Fleetbase\Models\Company;
+use Illuminate\Database\Seeder;
+use Illuminate\Support\Str;
+
+class OrderConfigSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        $companies = Company::all();
+        foreach ($companies as $company) {
+            static::createStorefrontConfig($company);
+        }
+    }
+
+    /**
+     * Creates or retrieves an existing storefront configuration for a given company.
+     *
+     * This method checks if a storefront configuration (OrderConfig) already exists for the given company.
+     * If it exists, the method returns the existing configuration. Otherwise, it creates a new configuration with
+     * predefined settings for a storefront order process. The configuration includes various stages like 'created',
+     * 'started', 'canceled', 'completed', etc., each defined with specific attributes like key, code, color, logic,
+     * events, status, actions, details, and more. These stages help manage the order lifecycle in a storefront context.
+     *
+     * @param Company $company The company for which the storefront configuration is being created or retrieved.
+     * @return OrderConfig The storefront order configuration associated with the specified company.
+     */
+    public static function createStorefrontConfig(Company $company): OrderConfig
+    {
+        return OrderConfig::firstOrCreate(
+            [
+                'company_uuid' => $company->uuid,
+                'key'          => 'storefront',
+                'namespace'    => 'system:order-config:storefront',
+            ],
+            [
+                'name'         => 'Storefront',
+                'key'          => 'storefront',
+                'namespace'    => 'system:order-config:storefront',
+                'description'  => 'Storefront order configuration for hyperlocal delivery and pickup',
+                'core_service' => 1,
+                'status'       => 'private',
+                'version'      => '0.0.1',
+                'tags'         => ['storefront', 'ecommerce', 'hyperlocal'],
+                'entities'     => [],
+                'meta'         => [],
+                'flow'         => [
+                    'created' => [
+                        'key'         => 'created',
+                        'code'        => 'created',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => [],
+                        'status'      => 'Order Created',
+                        'actions'     => [],
+                        'details'     => 'New order was created.',
+                        'options'     => [],
+                        'complete'    => false,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => ['dispatched'],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'started' => [
+                        'key'         => 'started',
+                        'code'        => 'started',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => [],
+                        'status'      => 'Order Started',
+                        'actions'     => [],
+                        'details'     => 'Order has been started',
+                        'options'     => [],
+                        'complete'    => false,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => ['canceled', 'preparing'],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'canceled' => [
+                        'key'         => 'canceled',
+                        'code'        => 'canceled',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => ['order.canceled'],
+                        'status'      => 'Order canceled',
+                        'actions'     => [],
+                        'details'     => 'Order could not be accepted',
+                        'options'     => [],
+                        'complete'    => false,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => [],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'completed' => [
+                        'key'         => 'completed',
+                        'code'        => 'completed',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => [],
+                        'status'      => 'Order completed',
+                        'actions'     => [],
+                        'details'     => 'Driver has completed the order',
+                        'options'     => [],
+                        'complete'    => true,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => [],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'picked_up' => [
+                        'key'         => 'completed',
+                        'code'        => 'picked_up',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => [],
+                        'status'      => 'Order picked up',
+                        'actions'     => [],
+                        'details'     => 'Order has been picked up by customer',
+                        'options'     => [],
+                        'complete'    => true,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => [],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'preparing' => [
+                        'key'         => 'preparing',
+                        'code'        => 'preparing',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => [],
+                        'status'      => 'Order is being prepared',
+                        'actions'     => [],
+                        'details'     => 'Order has been received by {storefront.name} and is being prepared',
+                        'options'     => [],
+                        'complete'    => false,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => ['driver_enroute_to_store', 'pickup_ready'],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'dispatched' => [
+                        'key'         => 'dispatched',
+                        'code'        => 'dispatched',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => [],
+                        'status'      => 'Order Dispatched',
+                        'actions'     => [],
+                        'details'     => 'Order has been dispatched.',
+                        'options'     => [],
+                        'complete'    => false,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => ['started'],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'pickup_ready' => [
+                        'key'   => 'ready',
+                        'code'  => 'pickup_ready',
+                        'color' => '#1f2937',
+                        'logic' => [
+                            [
+                                'type'       => 'if',
+                                'conditions' => [
+                                    [
+                                        'field'    => 'meta.is_pickup',
+                                        'value'    => 'true',
+                                        'operator' => 'equal',
+                                    ],
+                                ],
+                            ],
+                        ],
+                        'events'      => [],
+                        'status'      => 'Order is ready for pickup',
+                        'actions'     => [],
+                        'details'     => 'Order is ready to be picked up by customer',
+                        'options'     => [],
+                        'complete'    => false,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => ['picked_up'],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'driver_enroute' => [
+                        'key'         => 'driver_enroute',
+                        'code'        => 'driver_enroute',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => [],
+                        'status'      => 'Driver en-route',
+                        'actions'     => [],
+                        'details'     => 'Driver is on the way to the customer',
+                        'options'     => [],
+                        'complete'    => false,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => ['completed'],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'driver_picked_up' => [
+                        'key'         => 'driver_picked_up',
+                        'code'        => 'driver_picked_up',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => [],
+                        'status'      => 'Driver picked up',
+                        'actions'     => [],
+                        'details'     => 'Driver has picked up order',
+                        'options'     => [],
+                        'complete'    => false,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => ['driver_enroute'],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                    'driver_enroute_to_store' => [
+                        'key'         => 'driver_enroute',
+                        'code'        => 'driver_enroute_to_store',
+                        'color'       => '#1f2937',
+                        'logic'       => [],
+                        'events'      => [],
+                        'status'      => 'Driver en-route',
+                        'actions'     => [],
+                        'details'     => 'Driver en-route to store',
+                        'options'     => [],
+                        'complete'    => false,
+                        'entities'    => [],
+                        'sequence'    => 0,
+                        'activities'  => ['driver_picked_up'],
+                        'internalId'  => Str::uuid(),
+                        'pod_method'  => 'scan',
+                        'require_pod' => false,
+                    ],
+                ],
+            ]
+        );
+    }
+}

package/server/src/Expansions/ContactFilterExpansion.php

@@ -21,7 +21,7 @@ class ContactFilterExpansion implements Expansion
      *
      * @return \Closure
      */
-    public function storefront()
+    public static function storefront()
     {
         return function (?string $storefront) {
             /* @var \Fleetbase\FleetOps\Http\Filter\ContactFilter $this */

package/server/src/Expansions/EntityExpansion.php

@@ -23,9 +23,9 @@ class EntityExpansion implements Expansion
      *
      * @return Entity
      */
-    public function fromStorefrontProduct()
+    public static function fromStorefrontProduct()
     {
-        return static function (Product $product) {
+        return static function (Product $product, $meta = []) {
             return new Entity([
                 'company_uuid' => session('company'),
                 'photo_uuid'   => $product->primary_image_uuid,
@@ -39,6 +39,7 @@ class EntityExpansion implements Expansion
                 'meta'         => [
                     'product_id' => $product->public_id,
                     'image_url'  => $product->primary_image_url,
+                    ...$meta,
                 ],
             ]);
         };

package/server/src/Expansions/OrderFilterExpansion.php

@@ -21,7 +21,7 @@ class OrderFilterExpansion implements Expansion
      *
      * @return \Closure
      */
-    public function storefront()
+    public static function storefront()
     {
         return function (?string $storefront) {
             /* @var \Fleetbase\FleetOps\Http\Filter\OrderFilter $this */

package/server/src/Expansions/VendorFilterExpansion.php

@@ -21,7 +21,7 @@ class VendorFilterExpansion implements Expansion
      *
      * @return \Closure
      */
-    public function storefront()
+    public static function storefront()
     {
         return function (?string $storefront) {
             /* @var \Fleetbase\FleetOps\Http\Filter\VendorFilter $this */

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

@@ -19,9 +19,6 @@ class CartController extends Controller
     {
         $cart = Cart::retrieve($uniqueId, true);
 
-        // reset currency
-        $cart->resetCurrency();
-
         return new StorefrontCart($cart);
     }
 
@@ -49,9 +46,6 @@ class CartController extends Controller
             return response()->error($e->getMessage());
         }
 
-        // reset currency
-        $cart->resetCurrency();
-
         return new StorefrontCart($cart);
     }
 
@@ -80,9 +74,6 @@ class CartController extends Controller
             return response()->error($e->getMessage());
         }
 
-        // reset currency
-        $cart->resetCurrency();
-
         return new StorefrontCart($cart);
     }
 
@@ -107,9 +98,6 @@ class CartController extends Controller
             return response()->error($e->getMessage());
         }
 
-        // reset currency
-        $cart->resetCurrency();
-
         return new StorefrontCart($cart);
     }