@fleetbase/storefront-engine 0.2.9 → 0.2.11

package/addon/components/widget/storefront-key-metrics.hbs

@@ -0,0 +1,19 @@
+<div class="storefront-key-metrics" ...attributes>
+    <div class="flex flex-col">
+        <div class="flex flex-row items-center justify-between px-4 py-2 border dark:border-gray-700 border-gray-200 dark:bg-gray-800 bg-gray-50 rounded-lg shadow-sm">
+            <span class="text-base font-bold text-black dark:text-gray-100">{{t "storefront.component.widget.key-metrics.title"}}</span>
+        </div>
+
+        <div class="mt-4">
+            {{#if this.getDashboardMetrics.isRunning}}
+                <Spinner />
+            {{else}}
+                <div class="grid grid-cols-2 lg:grid-cols-12 gap-4">
+                    {{#each-in this.metrics as |title options|}}
+                        <Dashboard::Count @title={{smart-humanize title}} @options={{options}} />
+                    {{/each-in}}
+                </div>
+            {{/if}}
+        </div>
+    </div>
+</div>

package/addon/components/widget/storefront-key-metrics.js

@@ -0,0 +1,80 @@
+import Component from '@glimmer/component';
+import { tracked } from '@glimmer/tracking';
+import { inject as service } from '@ember/service';
+import { task } from 'ember-concurrency-decorators';
+
+export default class WidgetStorefrontKeyMetricsComponent extends Component {
+    /**
+     * The widget ID to use for registering.
+     *
+     * @memberof WidgetFleetOpsKeyMetricsComponent
+     */
+    static widgetId = 'storefront-key-metrics-widget';
+
+    /**
+     * Inject the fetch service.
+     *
+     * @memberof WidgetKeyMetricsComponent
+     */
+    @service fetch;
+
+    /**
+     * Property for loading metrics to.
+     *
+     * @memberof WidgetKeyMetricsComponent
+     */
+    @tracked metrics = {};
+
+    /**
+     * Creates an instance of WidgetKeyMetricsComponent.
+     * @memberof WidgetKeyMetricsComponent
+     */
+    constructor() {
+        super(...arguments);
+        this.getDashboardMetrics.perform();
+    }
+
+    /**
+     * Task which fetches key metrics.
+     *
+     * @memberof WidgetKeyMetricsComponent
+     */
+    @task *getDashboardMetrics() {
+        this.metrics = yield this.fetch.get('metrics', {}, { namespace: 'storefront/int/v1' }).then((response) => {
+            return this.createMetricsMapFromResponse(response);
+        });
+    }
+
+    /**
+     * Creates a map of metrics from the response data. This method organizes the metrics data into a more usable format.
+     *
+     * @param {Object} metrics - The metrics object fetched from the server.
+     * @returns {Object} A map of metrics where each key is a metric name and its value is an object of metric options.
+     * @memberof WidgetKeyMetricsComponent
+     */
+    createMetricsMapFromResponse(metrics = {}) {
+        const keys = Object.keys(metrics);
+        const map = {};
+
+        for (let i = 0; i < keys.length; i++) {
+            const key = keys[i];
+            map[key] = this.createMetricOptionsHash(key, metrics[key]);
+        }
+
+        return map;
+    }
+
+    /**
+     * Creates a hash of options for a given metric. Depending on the metric key, it assigns a specific format.
+     *
+     * @param {string} key - The key representing the specific metric.
+     * @param {number} value - The value of the metric.
+     * @returns {Object} An object containing the metric value and its format.
+     * @memberof WidgetKeyMetricsComponent
+     */
+    createMetricOptionsHash(key, value) {
+        const options = { value };
+
+        return options;
+    }
+}

package/addon/components/widget/storefront-metrics.js

@@ -16,8 +16,8 @@ export default class WidgetStorefrontMetricsComponent extends Component {
     };
 
     @tracked isLoading = true;
-    @tracked start = format(startOfMonth(new Date()), 'P');
-    @tracked end = format(endOfMonth(new Date()), 'P');
+    @tracked start = format(startOfMonth(new Date()), 'yyyy-MM-dd');
+    @tracked end = format(endOfMonth(new Date()), 'yyyy-MM-dd');
 
     @computed('args.title') get title() {
         return this.args.title || 'This Month';

package/addon/engine.js

@@ -3,6 +3,7 @@ import loadInitializers from 'ember-load-initializers';
 import Resolver from 'ember-resolver';
 import config from './config/environment';
 import services from '@fleetbase/ember-core/exports/services';
+import StorefrontKeyMetricsWidget from './components/widget/storefront-key-metrics';
 
 const { modulePrefix } = config;
 const externalRoutes = ['console', 'extensions'];
@@ -17,6 +18,23 @@ export default class StorefrontEngine extends Engine {
     setupExtension = function (app, engine, universe) {
         // register menu item in header
         universe.registerHeaderMenuItem('Storefront', 'console.storefront', { icon: 'store', priority: 1 });
+
+        // widgets for registry
+        const KeyMetricsWidgetDefinition = {
+            widgetId: 'storefront-key-metrics-widget',
+            name: 'Storefront Metrics',
+            description: 'Key metrics from Storefront.',
+            icon: 'store',
+            component: StorefrontKeyMetricsWidget,
+            grid_options: { w: 12, h: 7, minW: 8, minH: 7 },
+            options: {
+                title: 'Storefront Metrics',
+            },
+        };
+
+        // register widgets
+        universe.registerDefaultDashboardWidgets([KeyMetricsWidgetDefinition]);
+        universe.registerDashboardWidgets([KeyMetricsWidgetDefinition]);
     };
 }
 

package/addon/templates/networks/index/network.hbs

@@ -33,5 +33,6 @@
         </div>
 
         <div>{{outlet}}</div>
+        <Spacer @height="300px" />
     </Overlay::Body>
 </Overlay>

package/addon/templates/products/index/category/new.hbs

@@ -296,5 +296,6 @@
                 </ArrayInput>
             </div>
         </ContentPanel>
+        <Spacer @height="300px" />
     </Overlay::Body>
 </Overlay>

package/app/components/widget/storefront-key-metrics.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/storefront-engine/components/widget/storefront-key-metrics';

package/composer.json

@@ -1,6 +1,6 @@
 {
     "name": "fleetbase/storefront-api",
-    "version": "0.2.9",
+    "version": "0.2.11",
     "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "keywords": [
         "fleetbase-extension",
@@ -21,22 +21,22 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0",
-        "fleetbase/core-api": "^1.3.13",
-        "fleetbase/fleetops-api": "^0.4.4",
+        "php": "^8.0",
+        "fleetbase/core-api": "^1.4.0",
+        "fleetbase/fleetops-api": "^0.4.6",
         "geocoder-php/google-maps-places-provider": "^1.4",
-        "laravel-notification-channels/apn": "^3.8",
-        "laravel-notification-channels/fcm": "^2.7",
+        "laravel-notification-channels/apn": "^5.0",
+        "laravel-notification-channels/fcm": "^4.1",
         "laravel-notification-channels/twilio": "^3.3",
-        "milon/barcode": "^9.0",
+        "milon/barcode": "^10.0",
         "php-http/guzzle7-adapter": "^1.0",
         "psr/http-factory-implementation": "*",
         "toin0u/geocoder-laravel": "^4.4"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.34.1",
-        "nunomaduro/collision": "^5.11.0|^6.4.0",
-        "pestphp/pest": "^1.22.6",
+        "nunomaduro/collision": "^7.0",
+        "pestphp/pest": "^2.33.2",
         "phpstan/phpstan": "^1.10.38",
         "symfony/var-dumper": "^5.4.29"
     },

package/extension.json

@@ -1,6 +1,6 @@
 {
     "name": "Storefront",
-    "version": "0.2.9",
+    "version": "0.2.11",
     "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "repository": "https://github.com/fleetbase/storefront",
     "license": "MIT",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fleetbase/storefront-engine",
-    "version": "0.2.9",
+    "version": "0.2.11",
     "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "fleetbase": {
         "route": "storefront",
@@ -43,7 +43,7 @@
         "publish:github": "npm config set '@fleetbase:registry' https://npm.pkg.github.com/ && npm publish"
     },
     "dependencies": {
-        "@fleetbase/ember-core": "^0.2.0",
+        "@fleetbase/ember-core": "^0.2.4",
         "@fleetbase/ember-ui": "^0.2.10",
         "@fleetbase/fleetops-data": "^0.1.8",
         "@babel/core": "^7.23.2",

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

@@ -11,11 +11,6 @@ use Illuminate\Support\Carbon;
 
 class ActionController extends Controller
 {
-    public function welcome()
-    {
-        return response()->json(['message' => 'Hello Friend!']);
-    }
-
     /**
      * Get the number of storefronts created.
      *
@@ -53,15 +48,10 @@ class ActionController extends Controller
         }
 
         $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;
 
@@ -102,16 +92,6 @@ class ActionController extends Controller
                 return $order->transaction->amount;
             });
 
-        response()->json($metrics);
-    }
-
-    /**
-     * CORS OPTIONS.
-     *
-     * @return \Illuminate\Http\Response
-     */
-    public function options()
-    {
-        return response()->json(['status' => 'ok']);
+        return response()->json($metrics);
     }
 }

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

@@ -8,6 +8,12 @@ use Illuminate\Http\Request;
 
 class MetricsController extends Controller
 {
+    /**
+     * Get all key metrics for a companies storefront
+     *
+     * @param \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Response
+     */
     public function all(Request $request)
     {
         $start    = $request->date('start');
@@ -22,50 +28,4 @@ class MetricsController extends Controller
 
         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));
-    }
 }

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

@@ -9,7 +9,7 @@ use Fleetbase\Storefront\Http\Resources\Store as StorefrontStore;
 use Fleetbase\Storefront\Http\Resources\StoreLocation as StorefrontStoreLocation;
 use Fleetbase\Storefront\Models\Store;
 use Fleetbase\Storefront\Models\StoreLocation;
-use Grimzy\LaravelMysqlSpatial\Types\Point;
+use Fleetbase\LaravelMysqlSpatial\Types\Point;
 use Illuminate\Http\Request;
 
 class NetworkController extends Controller

package/server/src/Http/Resources/Category.php

@@ -30,9 +30,9 @@ class Category extends FleetbaseResource
             ),
             'tags'          => $this->tags ?? [],
             'translations'  => $this->translations ?? [],
-            'products'      => Product::collection($this->whenLoaded('products')),
+            'products'      => $this->when($request->has('with_products') || $request->inArray('with', 'products'), Product::collection($this->products)),
             'subcategories' => $this->when(
-                $request->has('with_subcategories'),
+                $request->has('with_subcategories') || $request->inArray('with', 'subcategories'),
                 array_map(
                     function ($subCategory) {
                         return new Category($subCategory);

package/server/src/Http/Resources/Store.php

@@ -43,10 +43,10 @@ class Store extends FleetbaseResource
             'online'          => $this->online,
             'is_network'      => false,
             'is_store'        => true,
-            'category'        => $this->when($request->filled('network') && $request->has('with_category'), new Category($this->getNetworkCategoryUsingId($request->input('network')))),
+            'category'        => $this->when($request->filled('network') && ($request->has('with_category') || $request->inArray('with', 'category')), new Category($this->getNetworkCategoryUsingId($request->input('network')))),
             'networks'        => $this->when($request->boolean('with_networks') || $request->inArray('with', 'networks'), Network::collection($this->networks)),
-            'locations'       => $this->when($request->boolean('with_locations'), $this->locations->mapInto(StoreLocation::class)),
-            'media'           => $this->when($request->boolean('with_media'), Media::collection($this->media)),
+            'locations'       => $this->when($request->boolean('with_locations') || $request->inArray('with', 'locations'), $this->locations->mapInto(StoreLocation::class)),
+            'media'           => $this->when($request->boolean('with_media') || $request->inArray('with', 'media'), Media::collection($this->media)),
             'slug'            => $this->slug,
             'created_at'      => $this->created_at,
             'updated_at'      => $this->updated_at,

package/server/src/Models/NetworkStore.php

@@ -6,11 +6,13 @@ use Fleetbase\Models\Category;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasUuid;
 use Illuminate\Database\Eloquent\Relations\Pivot;
+use Illuminate\Database\Eloquent\SoftDeletes;
 
 class NetworkStore extends Pivot
 {
     use HasUuid;
     use HasApiModelBehavior;
+    use SoftDeletes;
 
     /**
      * The database table used by the model.

package/server/src/Models/StoreLocation.php

@@ -7,7 +7,7 @@ use Fleetbase\Models\User;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasPublicid;
 use Fleetbase\Traits\HasUuid;
-use Grimzy\LaravelMysqlSpatial\Eloquent\SpatialTrait;
+use Fleetbase\LaravelMysqlSpatial\Eloquent\SpatialTrait;
 
 class StoreLocation extends StorefrontModel
 {
@@ -121,7 +121,7 @@ class StoreLocation extends StorefrontModel
     }
 
     /**
-     * @return \Grimzy\LaravelMysqlSpatial\Types\Point
+     * @return \Fleetbase\LaravelMysqlSpatial\Types\Point
      */
     public function getLocationAttribute()
     {

package/server/src/routes.php

@@ -112,7 +112,6 @@ Route::prefix(config('storefront.api.routing.prefix', 'storefront'))->namespace(
                 $router->group(
                     ['prefix' => 'v1', 'middleware' => ['fleetbase.protected']],
                     function ($router) {
-                        $router->get('/', 'ActionController@welcome');
                         $router->group(
                             ['prefix' => 'actions'],
                             function ($router) {
@@ -161,13 +160,10 @@ Route::prefix(config('storefront.api.routing.prefix', 'storefront'))->namespace(
                         $router->group(
                             [],
                             function ($router) {
-                                /* Dashboard Build */
-                                $router->get('dashboard', 'MetricsController@dashboard');
-
                                 $router->group(
                                     ['prefix' => 'metrics'],
                                     function ($router) {
-                                        $router->get('all', 'MetricsController@all');
+                                        $router->get('/', 'MetricsController@all');
                                     }
                                 );
                             }

package/translations/en-us.yaml

@@ -212,6 +212,8 @@ storefront:
         security-access-code: Security Access Code
         postal-code: Postal Code
     widget:
+      key-metrics:
+        title: Storefront Metrics
       customers:
         widget-title: Recent Customers
         phone: Phone