@fleetbase/storefront-engine 0.1.7 → 0.1.9

package/server/src/Models/Network.php

@@ -0,0 +1,300 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Category;
+use Fleetbase\Models\User;
+use Fleetbase\Models\Company;
+use Fleetbase\Models\File;
+use Fleetbase\Models\Invite;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Traits\HasOptionsAttributes;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\Searchable;
+use Illuminate\Support\Str;
+use Spatie\Sluggable\HasSlug;
+use Spatie\Sluggable\SlugOptions;
+
+class Network extends StorefrontModel
+{
+    use HasUuid, HasPublicId, HasApiModelBehavior, HasOptionsAttributes, HasSlug, Searchable;
+
+    /**
+     * The type of public Id to generate
+     *
+     * @var string
+     */
+    protected $publicIdType = 'network';
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'networks';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = ['name', 'description'];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['created_by_uuid', 'company_uuid', 'logo_uuid', 'backdrop_uuid', 'key', 'online', 'name', 'description', 'website', 'facebook', 'instagram', 'twitter', 'email', 'phone', 'translations', 'tags', 'currency', 'timezone', 'pod_method', 'options', 'alertable', 'slug'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'options' => Json::class,
+        'translations' => Json::class,
+        'alertable' => Json::class,
+        'tags' => 'array',
+        'online' => 'boolean'
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = ['logo_url', 'backdrop_url', 'stores_count'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = ['logo', 'backdrop', 'files', 'media'];
+
+    /**
+     * @var \Spatie\Sluggable\SlugOptions
+     */
+    public function getSlugOptions(): SlugOptions
+    {
+        return SlugOptions::create()
+            ->generateSlugsFrom('name')
+            ->saveSlugsTo('slug');
+    }
+
+    /** on boot generate key */
+    public static function boot()
+    {
+        parent::boot();
+        static::creating(function ($model) {
+            $model->key = 'network_' . md5(Str::random(14) . time());
+        });
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function createdBy()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(User::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(Company::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function logo()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(File::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function backdrop()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(File::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function files()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->hasMany(File::class, 'subject_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function media()
+    {
+        return $this->files()->where('type', 'storefront_network_media');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasManyThrough
+     */
+    public function stores()
+    {
+        return $this->belongsToMany(Store::class, 'network_stores', 'network_uuid', 'store_uuid')
+            ->using(NetworkStore::class)
+            ->withPivot('category_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function notificationChannels()
+    {
+        return $this->hasMany(NotificationChannel::class, 'owner_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function gateways()
+    {
+        return $this->hasMany(Gateway::class, 'owner_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function invitations()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->hasMany(Invite::class, 'subject_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function categories()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->hasMany(Category::class, 'owner_uuid')->where(['for' => 'network_category']);
+    }
+
+    /**
+     * @var string
+     */
+    public function getLogoUrlAttribute()
+    {
+        // return static::attributeFromCache($this, 'logo.url', 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/image-file-icon.png');
+        return $this->logo->url ?? 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/image-file-icon.png';
+    }
+
+    /**
+     * @var string
+     */
+    public function getBackdropUrlAttribute()
+    {
+        // return static::attributeFromCache($this, 'backdrop.url', 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/default-storefront-backdrop.png');
+        return $this->backdrop->url ?? 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/default-storefront-backdrop.png';
+    }
+
+    /**
+     * @var integer
+     */
+    public function getStoresCountAttribute()
+    {
+        return $this->stores()->count();
+    }
+
+    /**
+     * Adds a new store to the network
+     *
+     * @param Store $store
+     * @param Category|null $category
+     * @return NetworkStore
+     */
+    public function addStore(Store $store, ?Category $category = null): NetworkStore
+    {
+        return NetworkStore::updateOrCreate(
+            [
+                'network_uuid' => $this->uuid,
+                'store_uuid' => $store->uuid
+            ],
+            [
+                'network_uuid' => $this->uuid,
+                'store_uuid' => $store->uuid,
+                'category_uuid' => $category instanceof Category ? $category->uuid : null
+            ]
+        );
+    }
+
+    /**
+     *'Create a new network store category for this store record
+     *
+     * @param string $name
+     * @param string $description
+     * @param array|null $meta
+     * @param array|null $translations
+     * @param Category|null $parent
+     * @param File|string|null $icon
+     * @param string $iconColor
+     * @return Category
+     */
+    public function createCategory(string $name, string $description = '', ?array $meta = [],  ?array $translations = [], ?Category $parent = null, $icon = null, $iconColor = '#000000'): Category
+    {
+        $iconFile = null;
+        $iconName = null;
+
+        if ($icon instanceof File) {
+            $iconFile = $icon;
+        }
+
+        if (is_string($icon)) {
+            $iconName = $icon;
+        }
+
+        return Category::create([
+            'company_uuid' => $this->company_uuid,
+            'owner_uuid' => $this->uuid,
+            'owner_type' => Utils::getMutationType('network:storefront'),
+            'parent_uuid' => $parent instanceof Category ? $parent->uuid : null,
+            'icon_file_uuid' => $iconFile->uuid,
+            'for' => 'storefront_network',
+            'name' => $name,
+            'description' => $description,
+            'translations' => $translations,
+            'meta' => $meta,
+            'icon' => $iconName,
+            'icon_color' => $iconColor
+        ]);
+    }
+
+    /**
+     * Create a new network store category if it doesn't already exists for this store record
+     *
+     * @param string $name
+     * @param string $description
+     * @param array|null $meta
+     * @param array|null $translations
+     * @param Category|null $parent
+     * @param File|string|null $icon
+     * @param string $iconColor
+     * @return Category
+     */
+    public function createCategoryStrict(string $name, string $description = '', ?array $meta = [],  ?array $translations = [], ?Category $parent = null, $icon = null, $iconColor = '#000000'): Category
+    {
+        $existingCategory = Category::where(['company_uuid' => $this->company_uuid, 'owner_uuid' => $this->uuid, 'name' => $name])->first();
+
+        if ($existingCategory) {
+            return $existingCategory;
+        }
+
+        return $this->createCategory($name, $description, $meta, $translations, $parent, $icon, $iconColor);
+    }
+}

package/server/src/Models/NetworkStore.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Models\Category;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Illuminate\Database\Eloquent\Relations\Pivot;
+
+class NetworkStore extends Pivot
+{
+    use HasUuid, HasApiModelBehavior;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'network_stores';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['network_uuid', 'store_uuid', 'category_uuid'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * Create a new instance of the model.
+     *
+     * @param array $attributes The attributes to set on the model.
+     *
+     * @return void
+     */
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+
+        $this->connection = config('storefront.connection.db');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function network()
+    {
+        return $this->belongsTo(Network::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function store()
+    {
+        return $this->belongsTo(Store::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function category()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(Category::class);
+    }
+}

package/server/src/Models/NotificationChannel.php

@@ -0,0 +1,147 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Casts\PolymorphicType;
+use Fleetbase\Models\User;
+use Fleetbase\Models\Company;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Traits\HasOptionsAttributes;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Illuminate\Support\Str;
+
+class NotificationChannel extends StorefrontModel
+{
+    use HasUuid, HasApiModelBehavior, HasOptionsAttributes;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'notification_channels';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = ['name', 'scheme'];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['created_by_uuid', 'company_uuid', 'certificate_uuid', 'owner_uuid', 'owner_type', 'name', 'scheme', 'app_key', 'config', 'options'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        // 'config' => Json::class,
+        'options' => Json::class,
+        'owner_type' => PolymorphicType::class
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /** on boot generate key */
+    public static function boot()
+    {
+        parent::boot();
+        static::creating(function ($model) {
+            $model->app_key = 'noty_channel_' . md5(Str::random(14) . time());
+        });
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function createdBy()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(User::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(Company::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function certificate()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(File::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
+     */
+    public function owner()
+    {
+        return $this->morphTo(__FUNCTION__, 'owner_type', 'owner_uuid');
+    }
+
+    /**
+     * Sets the owner type
+     */
+    public function setOwnerTypeAttribute($type)
+    {
+        $this->attributes['owner_type'] = Utils::getMutationType($type);
+    }
+
+    public function setConfigAttribute($config)
+    {
+        if (is_array($config) && isset($config['private_key_content'])) {
+            $config['private_key_content'] = trim($config['private_key_content']);
+        }
+
+        $json = json_encode($config);
+        // $json = str_replace("\\n", "", $json);
+
+        $this->attributes['config'] = $json;
+    }
+
+    public function getConfigAttribute($config)
+    {
+        $config = json_decode($config, true);
+        // $config = Json::decode($config);
+
+        $sortedKeys = collect($config)->keys()->sort(function ($key) use ($config) {
+            $item = Utils::get($config, $key);
+
+            return Utils::isBooleanValue($item) ? 1 : 0;
+        });
+        $sortedConfig = [];
+
+        foreach ($sortedKeys as $key) {
+            $sortedConfig[$key] = $config[$key];
+        }
+
+        return (object) $sortedConfig;
+    }
+
+    public function getIsApnGatewayAttribute()
+    {
+        return $this->scheme === 'apn';
+    }
+
+    public function getIsFcmGatewayAttribute()
+    {
+        return $this->scheme === 'fcm';
+    }
+}

package/server/src/Models/PaymentMethod.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\User;
+use Fleetbase\Models\Company;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasPublicid;
+
+class PaymentMethod extends StorefrontModel
+{
+    use HasUuid, HasPublicid, HasApiModelBehavior;
+
+    /**
+     * The type of public Id to generate
+     *
+     * @var string
+     */
+    protected $publicIdType = 'payment_method';
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'payment_methods';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['company_uuid', 'created_by_uuid', 'gateway_uuid', 'store_uuid', 'owner_uuid', 'owner_type', 'gateway_id', 'type', 'brand', 'last4', 'meta'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'meta' => Json::class
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function createdBy()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(User::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(Company::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
+     */
+    public function owner()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->morphTo(__FUNCTION__, 'owner_type', 'owner_uuid')->withoutGlobalScopes();
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function store()
+    {
+        return $this->belongsTo(Store::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function gateway()
+    {
+        return $this->belongsTo(Gateway::class);
+    }
+}