Add more endpoints and models for sites

src/Appwrite/Platform/Modules/Sites/Http/Sites/CreateSite.php

@@ -79,7 +79,7 @@ class CreateSite extends Base
                 Config::getParam('framework-specifications', []),
                 App::getEnv('_APP_SITES_CPUS', APP_SITE_CPUS_DEFAULT),
                 App::getEnv('_APP_SITES_MEMORY', APP_SITE_MEMORY_DEFAULT)
-            ), 'Runtime specification for the site and builds.', true, ['plan'])
+            ), 'Framework specification for the site and builds.', true, ['plan'])
             ->inject('request')
             ->inject('response')
             ->inject('dbForProject')

src/Appwrite/Platform/Modules/Sites/Http/Sites/GetSite.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Sites;
+
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+
+class GetSite extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'getSite';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_GET)
+            ->setHttpPath('/v1/sites/:siteId')
+            ->desc('Get site')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.read') // TODO: Update scope to sites.read
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'get')
+            ->label('sdk.description', '/docs/references/sites/get-site.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_OK)
+            ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+            ->label('sdk.response.model', Response::MODEL_SITE)
+            ->param('siteId', '', new UID(), 'Site ID.')
+            ->inject('response')
+            ->inject('dbForProject')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, Response $response, Database $dbForProject)
+    {
+        $site = $dbForProject->getDocument('sites', $siteId);
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        $response->dynamic($site, Response::MODEL_SITE);
+    }
+}

src/Appwrite/Platform/Modules/Sites/Http/Sites/ListFrameworks.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Sites;
+
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Utopia\Response;
+use Utopia\Config\Config;
+use Utopia\Database\Document;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+use Utopia\System\System;
+
+class ListFrameworks extends Base
+{
+    // TODO: This won't work right now as the structure of frameworks is not properly defined, fix it later
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'listFrameworks';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_GET)
+            ->setHttpPath('/v1/sites/frameworks')
+            ->desc('List frameworks')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.read') // TODO: Update scope to sites.read
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'listFrameworks')
+            ->label('sdk.description', '/docs/references/sites/list-frameworks.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_OK)
+            ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+            ->label('sdk.response.model', Response::MODEL_FRAMEWORK_LIST)
+            ->inject('response')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(Response $response)
+    {
+        $frameworks = Config::getParam('frameworks');
+
+        $allowList = \array_filter(\explode(',', System::getEnv('_APP_SITES_FRAMEWORKS', '')));
+
+        $allowed = [];
+        foreach ($frameworks as $id => $framework) {
+            if (!empty($allowList) && !\in_array($id, $allowList)) {
+                continue;
+            }
+
+            $framework['$id'] = $id;
+            $allowed[] = $framework;
+        }
+
+        $response->dynamic(new Document([
+            'total' => count($allowed),
+            'frameworks' => $allowed
+        ]), Response::MODEL_FRAMEWORK_LIST);
+    }
+}

src/Appwrite/Platform/Modules/Sites/Http/Sites/ListSites.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Sites;
+
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Utopia\Database\Validator\Queries\Sites;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Document;
+use Utopia\Database\Exception\Query as QueryException;
+use Utopia\Database\Query;
+use Utopia\Database\Validator\Query\Cursor;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+use Utopia\Validator\Text;
+
+class ListSites extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'listSites';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_GET)
+            ->setHttpPath('/v1/sites')
+            ->desc('List sites')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.write') // TODO: Update scope to sites.write
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'list')
+            ->label('sdk.description', '/docs/references/sites/list-sites.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_OK)
+            ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+            ->label('sdk.response.model', Response::MODEL_SITE_LIST)
+            ->param('queries', [], new Sites(), 'Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' queries are allowed, each ' . APP_LIMIT_ARRAY_ELEMENT_SIZE . ' characters long. You may filter on the following attributes: ' . implode(', ', Sites::ALLOWED_ATTRIBUTES), true)
+            ->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true)
+            ->inject('response')
+            ->inject('dbForProject')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(array $queries, string $search, Response $response, Database $dbForProject)
+    {
+        try {
+            $queries = Query::parseQueries($queries);
+        } catch (QueryException $e) {
+            throw new Exception(Exception::GENERAL_QUERY_INVALID, $e->getMessage());
+        }
+
+        if (!empty($search)) {
+            $queries[] = Query::search('search', $search);
+        }
+
+        /**
+         * Get cursor document if there was a cursor query, we use array_filter and reset for reference $cursor to $queries
+         */
+        $cursor = \array_filter($queries, function ($query) {
+            return \in_array($query->getMethod(), [Query::TYPE_CURSOR_AFTER, Query::TYPE_CURSOR_BEFORE]);
+        });
+        $cursor = reset($cursor);
+        if ($cursor) {
+            /** @var Query $cursor */
+
+            $validator = new Cursor();
+            if (!$validator->isValid($cursor)) {
+                throw new Exception(Exception::GENERAL_QUERY_INVALID, $validator->getDescription());
+            }
+
+            $siteId = $cursor->getValue();
+            $cursorDocument = $dbForProject->getDocument('sites', $siteId);
+
+            if ($cursorDocument->isEmpty()) {
+                throw new Exception(Exception::GENERAL_CURSOR_NOT_FOUND, "Site '{$siteId}' for the 'cursor' value not found.");
+            }
+
+            $cursor->setValue($cursorDocument);
+        }
+
+        $filterQueries = Query::groupByType($queries)['filters'];
+
+        $response->dynamic(new Document([
+            'sites' => $dbForProject->find('sites', $queries),
+            'total' => $dbForProject->count('sites', $filterQueries, APP_LIMIT_COUNT),
+        ]), Response::MODEL_SITE_LIST);
+    }
+}

src/Appwrite/Platform/Modules/Sites/Http/Sites/UpdateSite.php

@@ -0,0 +1,231 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Sites;
+
+use Appwrite\Event\Build;
+use Appwrite\Event\Event;
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Sites\Validator\FrameworkSpecification;
+use Appwrite\Utopia\Response;
+use Executor\Executor;
+use Utopia\App;
+use Utopia\Config\Config;
+use Utopia\Database\Database;
+use Utopia\Database\Document;
+use Utopia\Database\Helpers\ID;
+use Utopia\Database\Helpers\Permission;
+use Utopia\Database\Helpers\Role;
+use Utopia\Database\Query;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+use Utopia\Swoole\Request;
+use Utopia\Validator\ArrayList;
+use Utopia\Validator\Boolean;
+use Utopia\Validator\Text;
+use Utopia\Validator\WhiteList;
+use Utopia\VCS\Adapter\Git\GitHub;
+
+class UpdateSite extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'updateSite';
+    }
+
+    public function __construct()
+    {
+        $this->setHttpMethod(Action::HTTP_REQUEST_METHOD_PUT)
+            ->setHttpPath('/v1/sites/:siteId')
+            ->desc('Update site')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.write') // TODO: update it to sites.write later
+            ->label('event', 'sites.[siteId].update')
+            ->label('audits.event', 'sites.update')
+            ->label('audits.resource', 'site/{response.$id}')
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'update')
+            ->label('sdk.description', '/docs/references/sites/update-site.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_OK)
+            ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+            ->label('sdk.response.model', Response::MODEL_SITE)
+            ->param('siteId', '', new UID(), 'Site ID.')
+            ->param('name', '', new Text(128), 'Site name. Max length: 128 chars.')
+            ->param('framework', '', new WhiteList(Config::getParam('frameworks'), true), 'Sites framework.')
+            ->param('enabled', true, new Boolean(), 'Is site enabled? When set to \'disabled\', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.', true) // TODO: Add logging param later
+            ->param('installCommand', '', new Text(8192, 0), 'Install Command.', true)
+            ->param('buildCommand', '', new Text(8192, 0), 'Build Command.', true)
+            ->param('outputDirectory', '', new Text(8192, 0), 'Output Directory for site.', true)
+            ->param('fallbackRedirect', '', new Text(8192, 0), 'Fallback Redirect URL for site in case a route is not found.', true)
+            ->param('scopes', [], new ArrayList(new WhiteList(array_keys(Config::getParam('scopes')), true), APP_LIMIT_ARRAY_PARAMS_SIZE), 'List of scopes allowed for API key auto-generated for every execution. Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' scopes are allowed.', true) //TODO: Update description of scopes
+            ->param('installationId', '', new Text(128, 0), 'Appwrite Installation ID for VCS (Version Control System) deployment.', true)
+            ->param('providerRepositoryId', '', new Text(128, 0), 'Repository ID of the repo linked to the site.', true)
+            ->param('providerBranch', '', new Text(128, 0), 'Production branch for the repo linked to the site.', true)
+            ->param('providerSilentMode', false, new Boolean(), 'Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.', true)
+            ->param('providerRootDirectory', '', new Text(128, 0), 'Path to site code in the linked repo.', true)
+            ->param('specification', APP_SITE_SPECIFICATION_DEFAULT, fn (array $plan) => new FrameworkSpecification(
+                $plan,
+                Config::getParam('framework-specifications', []),
+                App::getEnv('_APP_SITES_CPUS', APP_SITE_CPUS_DEFAULT),
+                App::getEnv('_APP_SITES_MEMORY', APP_SITE_MEMORY_DEFAULT)
+            ), 'Framework specification for the site and builds.', true, ['plan'])
+            ->inject('request')
+            ->inject('response')
+            ->inject('dbForProject')
+            ->inject('project')
+            ->inject('queueForEvents')
+            ->inject('queueForBuilds')
+            ->inject('dbForConsole')
+            ->inject('gitHub')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, string $name, string $framework, bool $enabled, string $installCommand, string $buildCommand, string $outputDirectory, string $fallbackRedirect, array $scopes, string $installationId, ?string $providerRepositoryId, string $providerBranch, bool $providerSilentMode, string $providerRootDirectory, string $specification, Request $request, Response $response, Database $dbForProject, Document $project, Event $queueForEvents, Build $queueForBuilds, Database $dbForConsole, GitHub $github)
+    {
+        // TODO: If only branch changes, re-deploy
+        $site = $dbForProject->getDocument('sites', $siteId);
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        $installation = $dbForConsole->getDocument('installations', $installationId);
+
+        if (!empty($installationId) && $installation->isEmpty()) {
+            throw new Exception(Exception::INSTALLATION_NOT_FOUND);
+        }
+
+        if (!empty($providerRepositoryId) && (empty($installationId) || empty($providerBranch))) {
+            throw new Exception(Exception::GENERAL_ARGUMENT_INVALID, 'When connecting to VCS (Version Control System), you need to provide "installationId" and "providerBranch".');
+        }
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        if (empty($framework)) {
+            $framework = $site->getAttribute('framework');
+        }
+
+        $enabled ??= $site->getAttribute('enabled', true);
+
+        $repositoryId = $site->getAttribute('repositoryId', '');
+        $repositoryInternalId = $site->getAttribute('repositoryInternalId', '');
+
+        $isConnected = !empty($site->getAttribute('providerRepositoryId', ''));
+
+        // Git disconnect logic. Disconnecting only when providerRepositoryId is empty, allowing for continue updates without disconnecting git
+        if ($isConnected && ($providerRepositoryId !== null && empty($providerRepositoryId))) {
+            $repositories = $dbForConsole->find('repositories', [
+                Query::equal('projectInternalId', [$project->getInternalId()]),
+                Query::equal('resourceInternalId', [$site->getInternalId()]),
+                Query::equal('resourceType', ['site']),
+                Query::limit(100),
+            ]);
+
+            foreach ($repositories as $repository) {
+                $dbForConsole->deleteDocument('repositories', $repository->getId());
+            }
+
+            $providerRepositoryId = '';
+            $installationId = '';
+            $providerBranch = '';
+            $providerRootDirectory = '';
+            $providerSilentMode = true;
+            $repositoryId = '';
+            $repositoryInternalId = '';
+        }
+
+        // Git connect logic
+        if (!$isConnected && !empty($providerRepositoryId)) {
+            $teamId = $project->getAttribute('teamId', '');
+
+            $repository = $dbForConsole->createDocument('repositories', new Document([
+                '$id' => ID::unique(),
+                '$permissions' => [
+                    Permission::read(Role::team(ID::custom($teamId))),
+                    Permission::update(Role::team(ID::custom($teamId), 'owner')),
+                    Permission::update(Role::team(ID::custom($teamId), 'developer')),
+                    Permission::delete(Role::team(ID::custom($teamId), 'owner')),
+                    Permission::delete(Role::team(ID::custom($teamId), 'developer')),
+                ],
+                'installationId' => $installation->getId(),
+                'installationInternalId' => $installation->getInternalId(),
+                'projectId' => $project->getId(),
+                'projectInternalId' => $project->getInternalId(),
+                'providerRepositoryId' => $providerRepositoryId,
+                'resourceId' => $site->getId(),
+                'resourceInternalId' => $site->getInternalId(),
+                'resourceType' => 'site',
+                'providerPullRequestIds' => []
+            ]));
+
+            $repositoryId = $repository->getId();
+            $repositoryInternalId = $repository->getInternalId();
+        }
+
+        $live = true;
+
+        if (
+            $site->getAttribute('name') !== $name ||
+            $site->getAttribute('buildCommand') !== $buildCommand ||
+            $site->getAttribute('installCommand') !== $installCommand ||
+            $site->getAttribute('outputDirectory') !== $outputDirectory ||
+            $site->getAttribute('fallbackRedirect') !== $fallbackRedirect ||
+            $site->getAttribute('providerRootDirectory') !== $providerRootDirectory ||
+            $site->getAttribute('framework') !== $framework
+        ) {
+            $live = false;
+        }
+
+        $spec = Config::getParam('framework-specifications')[$specification] ?? [];
+
+        // Enforce Cold Start if spec limits change.
+        if ($site->getAttribute('specification') !== $specification && !empty($site->getAttribute('deploymentId'))) {
+            $executor = new Executor(App::getEnv('_APP_EXECUTOR_HOST'));
+            try {
+                $executor->deleteRuntime($project->getId(), $site->getAttribute('deploymentId'));
+            } catch (\Throwable $th) {
+                // Don't throw if the deployment doesn't exist
+                if ($th->getCode() !== 404) {
+                    throw $th;
+                }
+            }
+        }
+
+        $site = $dbForProject->updateDocument('sites', $site->getId(), new Document(array_merge($site->getArrayCopy(), [
+            'name' => $name,
+            'framework' => $framework,
+            'enabled' => $enabled,
+            'live' => $live,
+            'buildCommand' => $buildCommand,
+            'installCommand' => $installCommand,
+            'outputDirectory' => $outputDirectory,
+            'fallbackRedirect' => $fallbackRedirect,
+            'scopes' => $scopes,
+            'installationId' => $installation->getId(),
+            'installationInternalId' => $installation->getInternalId(),
+            'providerRepositoryId' => $providerRepositoryId,
+            'repositoryId' => $repositoryId,
+            'repositoryInternalId' => $repositoryInternalId,
+            'providerBranch' => $providerBranch,
+            'providerRootDirectory' => $providerRootDirectory,
+            'providerSilentMode' => $providerSilentMode,
+            'specification' => $specification,
+            'search' => implode(' ', [$siteId, $name, $framework]),
+        ])));
+
+        // Redeploy logic
+        if (!$isConnected && !empty($providerRepositoryId)) {
+            $this->redeployVcsFunction($request, $site, $project, $installation, $dbForProject, $queueForBuilds, new Document(), $github);
+        }
+
+        $queueForEvents->setParam('siteId', $site->getId());
+
+        $response->dynamic($site, Response::MODEL_SITE);
+    }
+}

src/Appwrite/Platform/Modules/Sites/Services/Http.php

@@ -4,6 +4,10 @@ namespace Appwrite\Platform\Modules\Sites\Services;
 
 use Appwrite\Platform\Modules\Sites\Http\Deployments\CreateDeployment;
 use Appwrite\Platform\Modules\Sites\Http\Sites\CreateSite;
+use Appwrite\Platform\Modules\Sites\Http\Sites\GetSite;
+use Appwrite\Platform\Modules\Sites\Http\Sites\ListFrameworks;
+use Appwrite\Platform\Modules\Sites\Http\Sites\ListSites;
+use Appwrite\Platform\Modules\Sites\Http\Sites\UpdateSite;
 use Utopia\Platform\Service;
 
 class Http extends Service
@@ -12,6 +16,10 @@ class Http extends Service
     {
         $this->type = Service::TYPE_HTTP;
         $this->addAction(CreateSite::getName(), new CreateSite());
+        $this->addAction(GetSite::getName(), new GetSite());
+        $this->addAction(ListSites::getName(), new ListSites());
+        $this->addAction(UpdateSite::getName(), new UpdateSite());
+        $this->addAction(ListFrameworks::getName(), new ListFrameworks());
         $this->addAction(CreateDeployment::getName(), new CreateDeployment());
     }
 }

src/Appwrite/Utopia/Database/Validator/Queries/Sites.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Appwrite\Utopia\Database\Validator\Queries;
+
+class Sites extends Base
+{
+    public const ALLOWED_ATTRIBUTES = [
+        'name',
+        'enabled',
+        'framework',
+        'deploymentId',
+        'buildCommand',
+        'installCommand',
+        'outputDirectory',
+        'installationId'
+    ];
+
+    /**
+     * Expression constructor
+     *
+     */
+    public function __construct()
+    {
+        parent::__construct('sites', self::ALLOWED_ATTRIBUTES);
+    }
+}

src/Appwrite/Utopia/Response.php

@@ -44,6 +44,7 @@ use Appwrite\Utopia\Response\Model\Error;
 use Appwrite\Utopia\Response\Model\ErrorDev;
 use Appwrite\Utopia\Response\Model\Execution;
 use Appwrite\Utopia\Response\Model\File;
+use Appwrite\Utopia\Response\Model\Framework;
 use Appwrite\Utopia\Response\Model\Func;
 use Appwrite\Utopia\Response\Model\Headers;
 use Appwrite\Utopia\Response\Model\HealthAntivirus;
@@ -248,6 +249,8 @@ class Response extends SwooleResponse
     // Sites
     public const MODEL_SITE = 'site';
     public const MODEL_SITE_LIST = 'siteList';
+    public const MODEL_FRAMEWORK = 'framework';
+    public const MODEL_FRAMEWORK_LIST = 'frameworkList';
 
     // Functions
     public const MODEL_FUNCTION = 'function';
@@ -362,6 +365,7 @@ class Response extends SwooleResponse
             ->setModel(new BaseList('Installations List', self::MODEL_INSTALLATION_LIST, 'installations', self::MODEL_INSTALLATION))
             ->setModel(new BaseList('Provider Repositories List', self::MODEL_PROVIDER_REPOSITORY_LIST, 'providerRepositories', self::MODEL_PROVIDER_REPOSITORY))
             ->setModel(new BaseList('Branches List', self::MODEL_BRANCH_LIST, 'branches', self::MODEL_BRANCH))
+            ->setModel(new BaseList('Frameworks List', self::MODEL_FRAMEWORK_LIST, 'frameworks', self::MODEL_FRAMEWORK))
             ->setModel(new BaseList('Runtimes List', self::MODEL_RUNTIME_LIST, 'runtimes', self::MODEL_RUNTIME))
             ->setModel(new BaseList('Deployments List', self::MODEL_DEPLOYMENT_LIST, 'deployments', self::MODEL_DEPLOYMENT))
             ->setModel(new BaseList('Executions List', self::MODEL_EXECUTION_LIST, 'executions', self::MODEL_EXECUTION))
@@ -439,6 +443,7 @@ class Response extends SwooleResponse
             ->setModel(new VcsContent())
             ->setModel(new Branch())
             ->setModel(new Runtime())
+            ->setModel(new Framework())
             ->setModel(new Deployment())
             ->setModel(new Execution())
             ->setModel(new Build())

src/Appwrite/Utopia/Response/Model/Framework.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace Appwrite\Utopia\Response\Model;
+
+use Appwrite\Utopia\Response;
+use Appwrite\Utopia\Response\Model;
+
+class Framework extends Model
+{
+    public function __construct()
+    {
+        $this
+            ->addRule('$id', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Framework ID.',
+                'default' => '',
+                'example' => 'sveltekit',
+            ])
+            ->addRule('key', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Parent framework key.',
+                'default' => '',
+                'example' => 'sveltekit',
+            ])
+            ->addRule('name', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Framework Name.',
+                'default' => '',
+                'example' => 'SvelteKit'
+            ])
+            ->addRule('logo', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Name of the logo image.',
+                'default' => '',
+                'example' => 'sveltekit.png',
+            ])
+            ->addRule('supports', [
+                'type' => self::TYPE_STRING,
+                'description' => 'List of supported architectures.',
+                'default' => '',
+                'example' => 'amd64',
+                'array' => true,
+            ])
+        ;
+    }
+
+    /**
+     * Get Name
+     *
+     * @return string
+     */
+    public function getName(): string
+    {
+        return 'Framework';
+    }
+
+    /**
+     * Get Type
+     *
+     * @return string
+     */
+    public function getType(): string
+    {
+        return Response::MODEL_FRAMEWORK;
+    }
+}