@fleetbase/storefront-engine 0.1.7 → 0.1.9

package/.php-cs-fixer.php

@@ -0,0 +1,29 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__ . DIRECTORY_SEPARATOR . 'server' . DIRECTORY_SEPARATOR . 'tests')
+    ->in(__DIR__ . DIRECTORY_SEPARATOR . 'server' . DIRECTORY_SEPARATOR . 'src')
+    ->append(['.php-cs-fixer.php']);
+
+$rules = [
+    '@Symfony'               => true,
+    'phpdoc_no_empty_return' => false,
+    'array_syntax'           => ['syntax' => 'short'],
+    'yoda_style'             => false,
+    'binary_operator_spaces' => [
+        'operators' => [
+            '=>' => 'align',
+            '='  => 'align',
+        ],
+    ],
+    'concat_space'            => ['spacing' => 'one'],
+    'not_operator_with_space' => false,
+    'increment_style'         => ['style' => 'post'],
+    'indentation_type'        => true,
+    'single_quote'            => true,
+];
+
+return (new PhpCsFixer\Config())
+    ->setUsingCache(true)
+    ->setRules($rules)
+    ->setFinder($finder);

package/LICENSE.md

@@ -1,9 +1,21 @@
 The MIT License (MIT)
 
-Copyright (c) 2022
+Copyright (c) 2023 Fleetbase
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,32 +1,125 @@
-# @fleetbase/storefront-engine
+<p align="center">
+    <p align="center">
+        <img src="https://camo.githubusercontent.com/870812d4ebe999bd1434db7ffcb27c2f347f1c2c6af1842e59ae8b28855b4b42/68747470733a2f2f666c622d6173736574732e73332e61702d736f757468656173742d312e616d617a6f6e6177732e636f6d2f7374617469632f73746f726566726f6e742d6c6f676f2e737667" width="380" height="100" />
+    </p>
+    <p align="center">
+        Open-source Headless Commerce & Marketplace Extension for Fleetbase
+    </p>
+</p>
 
-[Short description of the addon.]
+---
 
+## Overview
 
-## Compatibility
+This monorepo contains both the frontend and backend components of the Storefront extension for Fleetbase. The frontend is built using Ember.js and the backend is implemented in PHP.
 
-* Ember.js v3.24 or above
-* Ember CLI v3.24 or above
-* Node.js v14 or above
+### Requirements
 
+- PHP 7.3.0 or above
+- Ember.js v3.24 or above
+- Ember CLI v3.24 or above
+- Node.js v14 or above
 
-## Installation
+## Structure
 
 ```
-ember install @fleetbase/storefront-engine
+├── addon
+├── app
+├── assets
+├── translations
+├── config
+├── node_modules
+├── server
+│ ├── config
+│ ├── data
+│ ├── migrations
+│ ├── resources
+│ ├── src
+│ ├── tests
+│ └── vendor
+├── tests
+├── testem.js
+├── index.js
+├── package.json
+├── phpstan.neon.dist
+├── phpunit.xml.dist
+├── pnpm-lock.yaml
+├── ember-cli-build.js
+├── composer.json
+├── CONTRIBUTING.md
+├── LICENSE.md
+├── README.md
+```
+
+## Installation
+
+### Backend
+
+Install the PHP packages using Composer:
+
+```bash
+composer require fleetbase/core-api
+composer require fleetbase/fleetops-api
+composer require fleetbase/storefront-api
 ```
+### Frontend
 
+Install the Ember.js Engine/Addon:
+
+```bash
+pnpm install @fleetbase/storefront-engine
+```
 
 ## Usage
 
-[Longer description of how to use the addon in apps.]
+### Backend
+
+🧹 Keep a modern codebase with **PHP CS Fixer**:
+```bash
+composer lint
+```
 
+⚗️ Run static analysis using **PHPStan**:
+```bash
+composer test:types
+```
 
-## Contributing
+✅ Run unit tests using **PEST**
+```bash
+composer test:unit
+```
 
-See the [Contributing](CONTRIBUTING.md) guide for details.
+🚀 Run the entire test suite:
+```bash
+composer test
+```
 
+### Frontend
 
-## License
+🧹 Keep a modern codebase with **ESLint**:
+```bash
+pnpm lint
+```
 
-This project is licensed under the [MIT License](LICENSE.md).
+✅ Run unit tests using **Ember/QUnit**
+```bash
+pnpm test
+pnpm test:ember
+pnpm test:ember-compatibility
+```
+
+🚀 Start the Ember Addon/Engine
+```bash
+pnpm start
+```
+
+🔨 Build the Ember Addon/Engine
+```bash
+pnpm build
+```
+
+## Contributing
+See the Contributing Guide for details on how to contribute to this project.
+
+## License
+This project is licensed under the MIT License.

package/composer.json

@@ -0,0 +1,88 @@
+{
+    "name": "fleetbase/storefront-api",
+    "version": "0.1.9",
+    "description": "Headless Commerce & Marketplace Extension for Fleetbase",
+    "keywords": [
+        "fleetbase-extension",
+        "storefront",
+        "headless commerce",
+        "marketplace",
+        "e-commerce"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Fleetbase Pte Ltd.",
+            "email": "hello@fleetbase.io"
+        },
+        {
+            "name": "Ronald A. Richardson",
+            "email": "ron@fleetbase.io"
+        }
+    ],
+    "require": {
+        "php": "^7.4|^8.0",
+        "fleetbase/core-api": "^1.2.6",
+        "fleetbase/fleetops-api": "^0.2.7",
+        "geocoder-php/google-maps-places-provider": "^1.4",
+        "laravel-notification-channels/apn": "^3.8",
+        "laravel-notification-channels/fcm": "^2.7",
+        "laravel-notification-channels/twilio": "^3.3",
+        "milon/barcode": "^9.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",
+        "phpstan/phpstan": "^1.10.38",
+        "symfony/var-dumper": "^5.4.29"
+    },
+    "autoload": {
+        "psr-4": {
+            "Fleetbase\\Storefront\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Fleetbase\\Storefront\\Tests\\": "tests/"
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Fleetbase\\Storefront\\Providers\\StorefrontServiceProvider",
+                "Fleetbase\\Storefront\\Providers\\EventServiceProvider"
+            ]
+        },
+        "fleetbase": {
+            "create-database": "storefront",
+            "order-config": "Fleetbase\\Storefront\\Support\\OrderConfig",
+            "sandbox-migrations": false
+        }
+    },
+    "config": {
+        "vendor-dir": "./server_vendor",
+        "sort-packages": true,
+        "preferred-install": "dist",
+        "allow-plugins": {
+            "pestphp/pest-plugin": true,
+            "php-http/discovery": true
+        }
+    },
+    "scripts": {
+        "lint": "php-cs-fixer fix -v",
+        "test:lint": "php-cs-fixer fix -v --dry-run",
+        "test:types": "phpstan analyse --ansi --memory-limit=0",
+        "test:unit": "pest --colors=always",
+        "test": [
+            "@test:lint",
+            "@test:types",
+            "@test:unit"
+        ]
+    }
+}

package/extension.json

@@ -0,0 +1,10 @@
+{
+    "name": "Storefront",
+    "version": "0.1.9",
+    "description": "Headless Commerce & Marketplace Extension for Fleetbase",
+    "repository": "https://github.com/fleetbase/storefront",
+    "license": "MIT",
+    "author": "Fleetbase Pte Ltd <hello@fleetbase.io>",
+    "engine": "package.json",
+    "api": "composer.json"
+}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@fleetbase/storefront-engine",
-    "version": "0.1.7",
-    "description": "Fleetbase Storefront extension provides a headless commerce module for launching e-commerce stores, on-demand apps, or marketplaces.",
+    "version": "0.1.9",
+    "description": "Headless Commerce & Marketplace Extension for Fleetbase",
     "fleetbase": {
         "route": "storefront",
         "dashboard": "storefront/int/v1/dashboard"
@@ -16,7 +16,7 @@
         "ember-engine",
         "ember-addon"
     ],
-    "repository": "https://github.com/fleetbase/storefront-engine",
+    "repository": "https://github.com/fleetbase/storefront",
     "license": "MIT",
     "author": "Fleetbase Pte Ltd <hello@fleetbase.io>",
     "directories": {
@@ -40,9 +40,9 @@
         "publish:github": "npm config set '@fleetbase:registry' https://npm.pkg.github.com/ && npm publish"
     },
     "dependencies": {
-        "@fleetbase/ember-core": "^0.1.2",
-        "@fleetbase/ember-ui": "^0.1.8",
-        "@fleetbase/fleetops-data": "^0.0.6",
+        "@fleetbase/ember-core": "^0.1.3",
+        "@fleetbase/ember-ui": "^0.1.9",
+        "@fleetbase/fleetops-data": "^0.1.0",
         "@fortawesome/ember-fontawesome": "^0.4.1",
         "@fortawesome/fontawesome-svg-core": "^6.4.0",
         "@fortawesome/free-solid-svg-icons": "^6.4.0",

package/phpstan.neon.dist

@@ -0,0 +1,8 @@
+parameters:
+    level: max
+    paths:
+        - src
+
+    checkMissingIterableValueType: true
+    checkGenericClassInNonGenericObjectType: false
+    reportUnmatchedIgnoredErrors: true

package/phpunit.xml.dist

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="default">
+            <directory suffix=".php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

package/server/.gitattributes

@@ -0,0 +1,14 @@
+/art               export-ignore
+/docs              export-ignore
+/tests             export-ignore
+/scripts           export-ignore
+/.github           export-ignore
+/.php_cs           export-ignore
+.editorconfig      export-ignore
+.gitattributes     export-ignore
+.gitignore         export-ignore
+phpstan.neon.dist  export-ignore
+phpunit.xml.dist   export-ignore
+CHANGELOG.md       export-ignore
+CONTRIBUTING.md    export-ignore
+README.md          export-ignore

package/server/README.md

@@ -0,0 +1,40 @@
+<p align="center">
+    <p align="center">
+        <img src="https://camo.githubusercontent.com/870812d4ebe999bd1434db7ffcb27c2f347f1c2c6af1842e59ae8b28855b4b42/68747470733a2f2f666c622d6173736574732e73332e61702d736f757468656173742d312e616d617a6f6e6177732e636f6d2f7374617469632f73746f726566726f6e742d6c6f676f2e737667" width="380" height="100" />
+    </p>
+    <p align="center">
+        Open-source headless commerce & marketplace extension for Fleetbase
+    </p>
+</p>
+
+------
+This package provides the Storefront extension API resources required by Fleetbase API.
+
+> **Requires [PHP 7.3.0+](https://php.net/releases/)**
+
+⚡️ Install Storefront [Composer](https://getcomposer.org):
+
+```bash
+composer require fleetbase/fleetops-api
+composer require fleetbase/storefront-api
+```
+
+🧹 Keep a modern codebase with **PHP CS Fixer**:
+```bash
+composer lint
+```
+
+⚗️ Run static analysis using **PHPStan**:
+```bash
+composer test:types
+```
+
+✅ Run unit tests using **PEST**
+```bash
+composer test:unit
+```
+
+🚀 Run the entire test suite:
+```bash
+composer test
+```

package/server/config/api.php

@@ -0,0 +1,101 @@
+<?php
+
+$storefrontFlow = [
+    'created' => [
+        'sequence' => 0,
+        'color' => 'green',
+        'events' => [
+            [
+                'status' => 'Order is being prepared',
+                'details' => 'Order has been received by {storefront.name} and is being prepared',
+                'code' => 'preparing',
+            ],
+            [
+                'status' => 'Order canceled',
+                'details' => 'Order could not be accepted',
+                'code' => 'canceled',
+            ],
+        ],
+    ],
+    'preparing' => [
+        'sequence' => 1,
+        'color' => 'orange',
+        'events' => [
+            [
+                'if' => [['meta.is_pickup', '=', true]],
+                'status' => 'Order is ready for pickup',
+                'details' => 'Order is ready to be picked up by customer.',
+                'code' => 'ready',
+            ],
+            [
+                'status' => 'Order dispatched',
+                'details' => 'Order has been dispatched to driver',
+                'code' => 'dispatched',
+            ],
+        ]
+    ],
+    'ready' => [
+        'sequence' => 2,
+        'color' => 'green',
+        'events' => [
+            [
+                'status' => 'Order picked up',
+                'details' => 'Order has been picked up by customer.',
+                'code' => 'completed',
+            ]
+        ]
+    ],
+    'dispatched' => [
+        'sequence' => 2,
+        'color' => 'blue',
+        'events' => [
+            [
+                'status' => 'Driver en-route',
+                'details' => 'Driver en-route to location',
+                'code' => 'driver_enroute',
+            ]
+        ]
+    ],
+    'driver_enroute' => [
+        'sequence' => 3,
+        'color' => 'green',
+        'events' => [
+            [
+                'status' => 'Order completed',
+                'details' => 'Driver has completed order',
+                'code' => 'completed',
+            ],
+        ]
+    ],
+];
+
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | API Events
+    |--------------------------------------------------------------------------
+    */
+
+    'events' => [],
+
+    /*
+    |--------------------------------------------------------------------------
+    | API Resource Types
+    |--------------------------------------------------------------------------
+    */
+    
+    'types' => [
+        'order' => [
+            [
+                'name' => 'Storefront',
+                'description' => 'Operational flow for storefront apps.',
+                'key' => 'storefront',
+                'meta_type' => 'order_config',
+                'meta' => [
+                    'flow' => $storefrontFlow,
+                ],
+            ],
+        ]
+    ]
+];

package/server/config/database.connections.php

@@ -0,0 +1,57 @@
+<?php
+
+use Fleetbase\Support\Utils;
+
+$host = env('DB_HOST', '127.0.0.1');
+$database = env('DB_DATABASE', 'fleetbase');
+$username = env('DB_USERNAME', 'fleetbase');
+$password = env('DB_PASSWORD', '');
+
+if ($databaseUrl = getenv('DATABASE_URL')) {
+    $url = Utils::parseUrl($databaseUrl);
+
+    $host = $url['host'];
+    $username = $url['user'];
+    if (isset($url['pass'])) {
+        $password = $url['pass'];
+    }
+    $database = substr($url['path'], 1);
+}
+
+$mysql_options = [];
+
+if (env('APP_ENV') === 'local') {
+    $mysql_options[PDO::ATTR_EMULATE_PREPARES] = true;
+}
+
+/*
+    |--------------------------------------------------------------------------
+    | Database Connections
+    |--------------------------------------------------------------------------
+    |
+    | Here are each of the database connections setup for your application.
+    | Of course, examples of configuring each database platform that is
+    | supported by Laravel is shown below to make development simple.
+    |
+    |
+    | All database work in Laravel is done through the PHP PDO facilities
+    | so make sure you have the driver for your particular database of
+    | choice installed on your machine before you begin development.
+    |
+    */
+return [
+    'storefront' => [
+        'driver' => 'mysql',
+        'host' => $host,
+        'port' => env('STOREFRONT_DB_PORT', '3306'),
+        'database' => $database . '_storefront',
+        'username' => $username,
+        'password' => $password,
+        'charset' => 'utf8mb4',
+        'collation' => 'utf8mb4_unicode_ci',
+        'prefix' => '',
+        'strict' => true,
+        'engine' => null,
+        'options' => $mysql_options,
+    ],
+];

package/server/config/storefront.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * -------------------------------------------
+ * Fleetbase Core API Configuration
+ * -------------------------------------------
+ */
+return [
+    'api' => [
+        'version' => '0.0.1',
+        'routing' => [
+            'prefix' => 'storefront',
+            'internal_prefix' => 'int'
+        ],
+    ],
+    'connection' => [
+        'db' => env('STOREFRONT_DB_CONNECTION', 'storefront')
+    ]
+];

package/server/config/twilio-notification-channel.php

@@ -0,0 +1,36 @@
+<?php
+
+return [
+    'username' => env('TWILIO_USERNAME'), // optional when using auth token
+    'password' => env('TWILIO_PASSWORD'), // optional when using auth token
+    'auth_token' => env('TWILIO_TOKEN'), // optional when using username and password
+    'account_sid' => env('TWILIO_SID'),
+
+    'from' => env('TWILIO_FROM'), // optional
+    'alphanumeric_sender' => env('TWILIO_ALPHA_SENDER'),
+
+    /**
+     * See https://www.twilio.com/docs/sms/services.
+     */
+    'sms_service_sid' => env('TWILIO_SMS_SERVICE_SID'),
+
+    /**
+     * Specify a number where all calls/messages should be routed. This can be used in development/staging environments
+     * for testing.
+     */
+    'debug_to' => env('TWILIO_DEBUG_TO'),
+
+    /**
+     * If an exception is thrown with one of these error codes, it will be caught & suppressed.
+     * To replicate the 2.x behaviour, specify '*' in the array, which will cause all exceptions to be suppressed.
+     * Suppressed errors will not be logged or reported, but the `NotificationFailed` event will be emitted.
+     *
+     * @see https://www.twilio.com/docs/api/errors
+     */
+    'ignored_error_codes' => [
+        21608, // The 'to' phone number provided is not yet verified for this account.
+        21211, // Invalid 'To' Phone Number
+        21614, // 'To' number is not a valid mobile number
+        21408, // Permission to send an SMS has not been enabled for the region indicated by the 'To' number
+    ],
+];

package/server/migrations/2023_05_03_025307_create_carts_table.php

@@ -0,0 +1,44 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::connection(config('storefront.connection.db'))->create('carts', function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->char('uuid', 36)->nullable()->unique();
+            $table->string('public_id')->nullable()->index();
+            $table->char('company_uuid', 36)->nullable()->index('carts_company_uuid_foreign');
+            $table->char('user_uuid', 36)->nullable()->index('carts_user_uuid_foreign');
+            $table->char('checkout_uuid', 36)->nullable()->index('carts_checkout_uuid_foreign');
+            $table->string('customer_id')->nullable();
+            $table->string('unique_identifier')->nullable();
+            $table->string('currency')->nullable();
+            $table->string('discount_code')->nullable();
+            $table->json('items')->nullable();
+            $table->json('events')->nullable();
+            $table->dateTime('expires_at')->nullable()->index();
+            $table->softDeletes();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::connection(config('storefront.connection.db'))->dropIfExists('carts');
+    }
+};