@fleetbase/registry-bridge-engine 0.0.1

package/server/src/Models/RegistryExtensionInstall.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Fleetbase\RegistryBridge\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Company;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasMetaAttributes;
+use Fleetbase\Traits\HasUuid;
+
+class RegistryExtensionInstall extends Model
+{
+    use HasUuid;
+    use HasMetaAttributes;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'registry_extension_installs';
+
+    /**
+     * The attributes that are mass assignable.
+     */
+    protected $fillable = [
+        'uuid',
+        'company_uuid',
+        'extension_uuid',
+        'meta',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     */
+    protected $casts = [
+        'meta'                  => Json::class,
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * Relations that should be loaded with model.
+     *
+     * @var array
+     */
+    protected $with = [];
+
+    /**
+     * Relations that should not be loaded.
+     *
+     * @var array
+     */
+    protected $without = ['company', 'extension'];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->belongsTo(Company::class, 'company_uuid', 'uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function extension()
+    {
+        return $this->belongsTo(RegistryExtension::class, 'extension_uuid', 'uuid');
+    }
+}

package/server/src/Models/RegistryExtensionPurchase.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace Fleetbase\RegistryBridge\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Casts\Money;
+use Fleetbase\Models\Company;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasMetaAttributes;
+use Fleetbase\Traits\HasUuid;
+
+class RegistryExtensionPurchase extends Model
+{
+    use HasUuid;
+    use HasMetaAttributes;
+    use HasApiModelBehavior;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'registry_extension_purchases';
+
+    /**
+     * The attributes that are mass assignable.
+     */
+    protected $fillable = [
+        'uuid',
+        'company_uuid',
+        'extension_uuid',
+        'stripe_checkout_session_id',
+        'stripe_payment_intent_id',
+        'is_subcription',
+        'locked_price',
+        'subscription_billing_period',
+        'subscription_model',
+        'meta',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     */
+    protected $casts = [
+        'meta'                  => Json::class,
+        'locked_price'          => Money::class,
+        'is_subcription'        => 'boolean',
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * Relations that should be loaded with model.
+     *
+     * @var array
+     */
+    protected $with = [];
+
+    /**
+     * Relations that should not be loaded.
+     *
+     * @var array
+     */
+    protected $without = ['company', 'extension'];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->belongsTo(Company::class, 'company_uuid', 'uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function extension()
+    {
+        return $this->belongsTo(RegistryExtension::class, 'extension_uuid', 'uuid');
+    }
+}

package/server/src/Models/RegistryUser.php

@@ -0,0 +1,140 @@
+<?php
+
+namespace Fleetbase\RegistryBridge\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Company;
+use Fleetbase\Models\Model;
+use Fleetbase\Models\User;
+use Fleetbase\Traits\Expirable;
+use Fleetbase\Traits\HasMetaAttributes;
+use Fleetbase\Traits\HasPublicId;
+use Fleetbase\Traits\HasUuid;
+
+class RegistryUser extends Model
+{
+    use HasUuid;
+    use HasMetaAttributes;
+    use HasPublicId;
+    use Expirable;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'registry_users';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'registry_user';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'company_uuid',
+        'user_uuid',
+        'token',
+        'scope',
+        'expires_at',
+        'last_used_at',
+        'name',
+        'metadata',
+        'revoked',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'meta'         => Json::class,
+        'last_used_at' => 'datetime',
+        'expires_at'   => 'datetime',
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = [];
+
+    /**
+     * The "booting" method of the model.
+     *
+     * This method is called when the model is being booted and is used to define
+     * model event hooks. In this model, it is used to automatically generate and
+     * assign a unique token to the `token` field when creating a new RegistryUser
+     * instance. The token is generated only if it hasn't been set already, ensuring
+     * that manually specified tokens are respected.
+     *
+     * @return void
+     */
+    protected static function boot()
+    {
+        parent::boot();
+
+        // Hook into the 'creating' event to set the token for new models
+        static::creating(function ($model) {
+            // Set the token only if it's not already set
+            if (empty($model->token)) {
+                $model->token = self::generateToken();
+            }
+        });
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->belongsTo(Company::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function user()
+    {
+        return $this->belongsTo(User::class);
+    }
+
+    /**
+     * Generates a unique token for authenticating with the registry.
+     *
+     * This method creates a token prefixed with 'flb_' and ensures its uniqueness
+     * within the `registry_users` table. The token is generated using secure random
+     * bytes, converted to a hexadecimal string.
+     *
+     * @param int the length of the unique token string
+     *
+     * @return string the unique, generated token
+     */
+    public static function generateToken(int $length = 18): string
+    {
+        do {
+            // Generate a random string and prepend with 'flb_'
+            $token = 'flb_' . bin2hex(random_bytes($length));
+
+            // Check if the token is unique in the database
+            $tokenExists = self::where('token', $token)->exists();
+        } while ($tokenExists);
+
+        return $token;
+    }
+}

package/server/src/Providers/RegistryBridgeServiceProvider.php

@@ -0,0 +1,117 @@
+<?php
+
+namespace Fleetbase\RegistryBridge\Providers;
+
+use Fleetbase\Providers\CoreServiceProvider;
+
+if (!class_exists(CoreServiceProvider::class)) {
+    throw new \Exception('Registry Bridge cannot be loaded without `fleetbase/core-api` installed!');
+}
+
+/**
+ * Registry Bridge service provider.
+ */
+class RegistryBridgeServiceProvider extends CoreServiceProvider
+{
+    /**
+     * The observers registered with the service provider.
+     *
+     * @var array
+     */
+    public $observers = [];
+
+    /**
+     * The console commands registered with the service provider.
+     *
+     * @var array
+     */
+    public $commands = [
+        \Fleetbase\RegistryBridge\Console\Commands\PostInstallExtension::class,
+        \Fleetbase\RegistryBridge\Console\Commands\Initialize::class,
+    ];
+
+    /**
+     * The middleware groups registered with the service provider.
+     *
+     * @var array
+     */
+    public $middleware = [
+        'fleetbase.registry' => [
+            'throttle:60,1',
+            \Illuminate\Session\Middleware\StartSession::class,
+            \Fleetbase\Http\Middleware\AuthenticateOnceWithBasicAuth::class,
+            \Illuminate\Routing\Middleware\SubstituteBindings::class,
+        ],
+    ];
+
+    /**
+     * Register any application services.
+     *
+     * Within the register method, you should only bind things into the
+     * service container. You should never attempt to register any event
+     * listeners, routes, or any other piece of functionality within the
+     * register method.
+     *
+     * More information on this can be found in the Laravel documentation:
+     * https://laravel.com/docs/8.x/providers
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->register(CoreServiceProvider::class);
+    }
+
+    /**
+     * Bootstrap any package services.
+     *
+     * @return void
+     *
+     * @throws \Exception if the `fleetbase/core-api` package is not installed
+     */
+    public function boot()
+    {
+        static::bootRegistryAuth();
+        $this->registerCommands();
+        $this->registerMiddleware();
+        $this->registerExpansionsFrom(__DIR__ . '/../Expansions');
+        $this->loadRoutesFrom(__DIR__ . '/../routes.php');
+        $this->loadMigrationsFrom(__DIR__ . '/../../migrations');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/registry-bridge.php', 'registry-bridge');
+    }
+
+    /**
+     * Initializes and sets up the npm registry authentication configuration.
+     *
+     * This method constructs the registry authentication string from configuration settings,
+     * checks for the existence of an npmrc file in the user's home directory, and creates it
+     * with the registry authentication string if it doesn't already exist.
+     *
+     * The registry configuration and token are pulled from the application's configuration files.
+     * It ensures the path to the .npmrc file is correctly formed regardless of trailing slashes
+     * in the HOME directory path or the registry host configuration.
+     *
+     * @param bool $reset - Overwrites existing file, "resetting" the .npmrc
+     *
+     * @return void
+     */
+    public static function bootRegistryAuth(bool $reset = false)
+    {
+        $homeDirectory  = rtrim(getenv('HOME'), '/');
+        $authPath       = $homeDirectory . '/.npmrc';
+        $authString     = '//' . str_replace(['http://', 'https://'], '', rtrim(config('registry-bridge.registry.host'), '/')) . '/:_authToken="' . config('registry-bridge.registry.token') . '"' . PHP_EOL;
+        if (!file_exists($authPath) || $reset === true) {
+            file_put_contents($authPath, $authString);
+        }
+
+        $consolePath    = rtrim(config('fleetbase.console.path'), '/');
+        $registryPath   = $consolePath . '/.npmrc';
+        $registryString = implode(PHP_EOL, [
+            'registry=https://registry.npmjs.org/',
+            '@fleetbase:registry=' . rtrim(config('registry-bridge.registry.host'), '/') . '/',
+        ]) . PHP_EOL;
+        if (!file_exists($registryPath) || $reset === true) {
+            file_put_contents($registryPath, $registryString);
+        }
+    }
+}

package/server/src/Support/Bridge.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Fleetbase\RegistryBridge\Support;
+
+use Illuminate\Support\Facades\Http;
+
+class Bridge
+{
+    /**
+     * Creates a complete URL by concatenating the base URL from the configuration with the provided URI.
+     *
+     * This method ensures that the base URL from the configuration has a trailing slash before
+     * concatenating it with the provided URI. It handles URL formation for making HTTP requests.
+     *
+     * @param string $uri the specific URI to append to the base URL
+     *
+     * @return string the complete URL formed by concatenating the base URL and the provided URI
+     */
+    private static function createUrl(string $uri = ''): string
+    {
+        $url = config('registry-bridge.registry.host');
+
+        return rtrim($url, '/') . '/' . $uri;
+    }
+
+    /**
+     * Sends a GET request to the specified URI.
+     *
+     * @param string $uri        URI to send the GET request to
+     * @param array  $parameters parameters to include in the request
+     * @param array  $options    additional options for the HTTP client
+     *
+     * @return \Illuminate\Http\Client\Response
+     */
+    public static function get($uri, $parameters = [], $options = [])
+    {
+        return Http::withOptions($options)->get(static::createUrl($uri), $parameters);
+    }
+
+    /**
+     * Sends a POST request to the specified URI.
+     *
+     * @param string $uri        URI to send the GET request to
+     * @param array  $parameters parameters to include in the request
+     * @param array  $options    additional options for the HTTP client
+     *
+     * @return \Illuminate\Http\Client\Response
+     */
+    public static function post($uri, $parameters = [], $options = [])
+    {
+        return Http::withOptions($options)->post(static::createUrl($uri), $parameters);
+    }
+}

package/server/src/Support/Utils.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Fleetbase\RegistryBridge\Support;
+
+use Stripe\StripeClient;
+
+class Utils
+{
+    /**
+     * Get the StripeClient instance.
+     */
+    public static function getStripeClient(array $options = []): ?StripeClient
+    {
+        return new StripeClient([
+            'api_key' => config('registry-bridge.stripe.secret'),
+            ...$options,
+        ]);
+    }
+}

package/server/src/routes.php

@@ -0,0 +1,58 @@
+<?php
+
+use Illuminate\Support\Facades\Route;
+
+/*
+|--------------------------------------------------------------------------
+| API Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register API routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| is assigned the "api" middleware group. Enjoy building your API!
+|
+*/
+
+Route::get('~registry/test', 'Fleetbase\RegistryBridge\Http\Controllers\Internal\v1\RegistryAuthController@test');
+
+Route::prefix(config('internals.api.routing.prefix', '~registry'))->middleware(['fleetbase.registry'])->namespace('Fleetbase\RegistryBridge\Http\Controllers')->group(
+    function ($router) {
+        /*
+         * Internal Routes v1
+         */
+        $router->group(['prefix' => config('internals.api.routing.internal_prefix', 'v1'), 'namespace' => 'Internal\v1'], function ($router) {
+            $router->get('categories', 'RegistryController@categories');
+            $router->get('engines', 'RegistryController@getInstalledEngines');
+            $router->group(['prefix' => 'installer'], function ($router) {
+                $router->post('install', 'ExtensionInstallerController@install');
+                $router->post('uninstall', 'ExtensionInstallerController@uninstall');
+            });
+            $router->group(['prefix' => 'auth'], function ($router) {
+                $router->post('authenticate', 'RegistryAuthController@authenticate');
+                $router->post('add-user', 'RegistryAuthController@addUser');
+                $router->post('check-access', 'RegistryAuthController@checkAccess');
+                $router->post('check-publish', 'RegistryAuthController@checkPublishAllowed');
+            });
+            $router->group(['prefix' => 'payments'], function ($router) {
+                $router->post('account', 'RegistryPaymentsController@getStripeAccount');
+                $router->post('account-session', 'RegistryPaymentsController@getStripeAccountSession');
+                $router->get('has-stripe-connect-account', 'RegistryPaymentsController@hasStripeConnectAccount');
+                $router->post('create-checkout-session', 'RegistryPaymentsController@createStripeCheckoutSession');
+                $router->post('get-checkout-session', 'RegistryPaymentsController@getStripeCheckoutSessionStatus');
+                $router->get('author-received', 'RegistryPaymentsController@getAuthorReceivedPayments');
+            });
+            $router->fleetbaseRoutes('registry-extensions', function ($router, $controller) {
+                $router->post('{id}/submit', $controller('submit'));
+                $router->post('approve', $controller('approve'));
+                $router->post('reject', $controller('reject'));
+                $router->get('download-bundle', $controller('downloadBundle'));
+                $router->get('analytics', $controller('analytics'));
+                $router->get('installed', $controller('installed'))->middleware([Spatie\ResponseCache\Middlewares\DoNotCacheResponse::class]);
+                $router->get('purchased', $controller('purchased'))->middleware([Spatie\ResponseCache\Middlewares\DoNotCacheResponse::class]);
+            });
+            $router->fleetbaseRoutes('registry-extension-bundles', function ($router, $controller) {
+                $router->get('download', $controller('download'));
+            });
+        });
+    }
+);

package/server/tests/Feature.php

@@ -0,0 +1,5 @@
+<?php
+
+test('example', function () {
+    expect(true)->toBeTrue();
+});

package/translations/en-us.yaml

@@ -0,0 +1,119 @@
+registry-bridge:
+  extension-name: Registry Bridge
+  common:
+    install: Install
+    uninstall: Uninstall
+    approve: Approve
+    reject: Reject
+    details: Details
+    about: About
+    about-extension: About {extensionName}
+  component:
+    extension-pending-publish-viewer:
+      content-panel-title: Extensions Pending Publish
+      focused-extension-title: >
+        {extensionName} Details
+      download-bundle: Download Bundle
+      view-details: View Details
+      no-extensions-awaiting-publish: No extensions awaiting publish
+    extension-reviewer-control:
+      content-panel-title: Extensions Awaiting Review
+      focused-extension-title: >
+        {extensionName} Details
+      approve-confirm-title: Are you sure you want to approve this extension?
+      approve-confirm-body: This extension should be thoroughly tested in both a development and test environment and tested for compliance as well as security issues. Once approved the extension will need to be manually published to the registry.
+      decline-confirm-title: Are you sure you want to reject this extension?
+      decline-confirm-body: This extension will be rejected, but the author will be given a chance to make corrections and re-submit for review.
+      download-bundle: Download Bundle
+      view-details: View Details
+      approve: Approve
+      reject: Reject
+      no-extensions-awaiting-review: No extensions awaiting review
+  installed:
+    title: Installed Extensions
+  purchased:
+    title: Purchased Extensions
+  developers:
+    extensions:
+      extensions: Extensions
+      create-new-extension: Create new Extension
+      new-extension: New Extension
+      extension: Extension
+      submission: Submission
+      details: Details
+      bundles: Bundles
+      monetize: Monetize
+      explore:
+        explore-extensions: Explore Extensions
+        explore-category-extensions: >
+          {categoryName} Extensions
+      extension-form:
+        package-name: Package Name
+        package-json-name: package.json name
+        composer-json-name: composer.json name
+        submission-success-message: Extension submitted and is awaiting review.
+        extension-category: Category
+        extension-category-help-text: Select the category in which users will be able to find your extension.
+        extension-select-category: Select Category
+        extension-name: Extension Name
+        extension-icon: Extension Icon
+        upload-extension-icon: Upload Icon
+        extension-description: Description
+        extension-tags: Tags
+        extension-add-tags: Add keywords and tags
+        extension-promotional-text: Promotional Text
+        details-content-block: Extension Details
+        extension-listing-details: Listing Details
+        extension-subtitle: Subtitle
+        extension-website-url: Website URL
+        extension-repo-url: Repository URL
+        extension-support-url: Support URL
+        extension-privacy-policy-url: Privacy Policy URL
+        extension-tos-url: Terms of Service URL
+        extension-primary-language: Primary Language
+        extension-version: Version
+        extension-copyright: Copyright
+        extension-copyright-help-text: Enter the copyright notice for your extension. This typically includes the year and the name of the copyright owner or company.
+        extension-payment-required: Payment Required
+        extension-payment-required-help-text: Determines if payment or subscription is required for users to install this extension.
+        extension-price: Price
+        extension-price-help-text: Specify the regular price of the extension. This is the standard cost for users to purchase or access the extension.
+        extension-sale-price: Sale Price
+        extension-sale-price-help-text: If the extension is currently offered at a discounted rate, enter the sale price here. This should be less than the regular price.
+        extension-subscription-required: Subscription Required
+        extension-subscription-required-help-text: Determines if user must have a subscription to install and use this extension.
+        extension-subscription-billing-period: Subscription Billing Period
+        extension-subscription-billing-period-placeholder: Select Billing Period
+        extension-subscription-billing-period-help-text: Specify the billing period for the subscription. Examples include monthly, quarterly, annually, or other custom intervals.
+        extension-subscription-amount: Subscription Amount
+        extension-subscription-amount-help-text: Enter the standard amount to be charged for the subscription. This should reflect the regular price before any discounts or tiered pricing adjustments.
+        extension-subscription-model: Subscription Model
+        extension-subscription-model-help-text: Determines the type of subscription pricing model to follow. Options include flate rate, tiered, and usage based subscription.
+        extension-subscription-tiers: Subscription Tiers
+        extension-subscription-tiers-help-text: Define the different pricing tiers for the subscription, if applicable. Include details like the tier levels, pricing for each tier, and any specific features or limitations of each tier.
+        extension-name-help-text: Enter the official name of the extension. This will be displayed as the primary identifier for users.
+        extension-icon-help-text: Upload an icon representing the extension. This icon will be used in listings and search results.
+        extension-description-help-text: Provide a detailed description of what the extension does and its key features. This information helps users understand the extension's functionality.
+        extension-tags-help-text: Add relevant keywords and tags that describe the extension, helping users find it through search.
+        extension-promotional-text-help-text: Write promotional text to highlight the extension's unique selling points. This text will be used in marketing or featured sections.
+        extension-subtitle-help-text: Provide a brief subtitle that offers additional context or information about the extension.
+        extension-website-url-help-text: Enter the URL to the extension's official website or product page for more information.
+        extension-repo-url-help-text: Provide the URL to the extension's code repository (e.g., GitHub, GitLab), if applicable.
+        extension-support-url-help-text: Specify the URL where users can obtain support, ask questions, or report issues with the extension.
+        extension-privacy-policy-url-help-text: Link to the privacy policy document that details how user data is handled and protected.
+        extension-tos-url-help-text: Link to the Terms of Service document that users must agree to before using the extension.
+        extension-primary-language-help-text: Specify the primary language the extension is developed or available in.
+        extension-version-help-text: Indicate the current version of the extension. This is important for tracking updates and compatibility.
+        extension-payment-details: Payment Details
+        extension-screenshots: Screenshots
+        upload-screenshots: Upload Screenshots
+        submit-for-review: Submit for Review
+        extension-bundle: Extension Bundle
+        extension-upload-bundle: Upload Extension Bundle
+        details: Details
+        bundle-id: Bundle ID
+        bundle-id-help-text: The identifier of the currently published bundle.
+        extension-id: Extension ID
+        extension-id-help-text: The unique identifier for this extension.
+        bundles: Bundles
+        upload-new-bundle: Upload new Bundle

package/tsconfig.declarations.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declarationDir": "declarations",
+    "emitDeclarationOnly": true,
+    "noEmit": false,
+    "rootDir": "."
+  },
+  "include": ["addon", "addon-test-support"]
+}