Detection Library

Adapter.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Utopia\Detector;
+
+abstract class Adapter
+{
+    abstract public function detect(array $inputs): ?Detection;
+}

Adapter/Framework.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Utopia\Detector\Adapter;
+
+use Utopia\Detector\Adapter;
+use Utopia\Detector\Detection\Framework\Detection as FrameworkDetection;
+
+class Framework implements Adapter
+{
+    // add param input for mixed input
+    public function detect(array $inputs): ?FrameworkDetection
+    {
+        // Implement logic to determine if framework matches
+
+        return null;
+    }
+}

Adapter/PackageManager.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Utopia\Detector\Adapter;
+
+use Utopia\Detector\Adapter;
+use Utopia\Detector\Detection\PackageManager\Detection as PackageManagerDetection;
+
+class PackageManager implements Adapter
+{
+    // add param input for mixed input
+    public function detect(array $inputs): ?PackageManagerDetection
+    {
+        // implement logic to detect package manager
+
+        return null;
+    }
+}

Adapter/RenderingStrategy.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Utopia\Detector\Adapter;
+
+use Utopia\Detector\Adapter;
+use Utopia\Detector\Detection\RenderingStrategy\Detection as RenderingStrategyDetection;
+
+class RenderingStrategy implements Adapter
+{
+    // add param input for mixed input
+    public function detect(array $inputs): ?RenderingStrategyDetection
+    {
+        // implement logic to detect rendering strategy ie server side, client side, etc
+
+        return null;
+    }
+}

Adapter/Runtime.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Utopia\Detector\Adapter;
+
+use Utopia\Detector\Adapter;
+use Utopia\Detector\Detection\Runtime\Detection as RuntimeDetection;
+
+class Runtime implements Adapter
+{
+    // add param input for mixed input
+    public function detect(array $inputs): ?RuntimeDetection
+    {
+        // Implement logic to determine if runtime matches
+
+        return null;
+    }
+}

Detection.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Utopia\Detector;
+
+abstract class Detection
+{
+    abstract public function getName(): string;
+}

Detection/Framework/Detection.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Utopia\Detector\Detection\Framework;
+
+use Utopia\Detector\Detection as BaseDetection;
+
+abstract class Detection extends BaseDetection
+{
+    abstract public function getInstallCommand(): string;
+    abstract public function getBuildCommand(): string;
+    abstract public function getInstallCommands(): array;
+    abstract public function getBuildCommands(): array;
+    abstract public function getOutputDirectory(): string;
+    abstract public function getFallbackFile(): string | null;
+}

Detection/Framework/Nextjs.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Utopia\Detector\Detection\Framework;
+
+use Utopia\Detector\Detection\Framework\Detection as FrameworkDetection;
+
+class Nextjs extends FrameworkDetection
+{
+    public function getName(): string
+    {
+        return 'Next.js';
+    }
+
+    public function getInstallCommand(): string
+    {
+        return 'npm install';
+    }
+
+    public function getBuildCommand(): string
+    {
+        return 'npm run build';
+    }
+
+    public function getInstallCommands(): array
+    {
+        return [
+            'npm' => 'npm install',
+            'yarn' => 'yarn install',
+            'pnpm' => 'pnpm install',
+        ];
+    }
+
+    public function getBuildCommands(): array
+    {
+        return [
+            'npm' => 'npm run build',
+            'yarn' => 'yarn build',
+            'pnpm' => 'pnpm build',
+        ];
+    }
+
+    public function getOutputDirectory(): string
+    {
+        return './.next';
+    }
+
+    public function getFallbackFile(): string | null
+    {
+        return null;
+    }
+}

Detection/PackageManager/Detection.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Utopia\Detector\Detection\PackageManager;
+
+use Utopia\Detector\Detection as BaseDetection;
+
+abstract class Detection extends BaseDetection
+{
+    abstract public function getName(): string;
+}

Detection/PackageManager/Npm.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Utopia\Detector\Detection\PackageManager;
+
+use Utopia\Detector\Detection\PackageManager\Detection as PackageManagerDetection;
+
+class Npm extends PackageManagerDetection
+{
+    public function getName(): string
+    {
+        return 'npm';
+    }
+}

Detection/RenderingStrategy/Detection.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Utopia\Detector\Detection\RenderingStrategy;
+
+use Utopia\Detector\Detection as BaseDetection;
+
+abstract class Detection extends BaseDetection
+{
+    abstract public function getName(): string;
+}

Detection/RenderingStrategy/SSR.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Utopia\Detector\Detection\RenderingStrategy;
+
+use Utopia\Detector\Detection\RenderingStrategy\Detection as RenderingStrategyDetection;
+
+class SSR extends RenderingStrategyDetection
+{
+    public function getName(): string
+    {
+        return 'SSR';
+    }
+}

Detection/Runtime/Detection.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Utopia\Detector\Detection\Runtime;
+
+use Utopia\Detector\Detection as BaseDetection;
+
+abstract class Detection extends BaseDetection
+{
+    abstract public function getCommand(): string;
+    abstract public function getCommands(): array;
+}

Detection/Runtime/Node.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Utopia\Detector\Detection\Runtime;
+
+use Utopia\Detector\Detection\Runtime\Detection as RuntimeDetection;
+
+class Node extends RuntimeDetection
+{
+    public function getName(): string
+    {
+        return 'node';
+    }
+
+    public function getCommand(): string
+    {
+        return 'npm install';
+    }
+
+    public function getCommands(): array
+    {
+        return [
+            'npm' => 'npm install',
+            'yarn' => 'yarn install',
+            'pnpm' => 'pnpm install',
+        ];
+    }
+}

Detector.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Utopia\Detector;
+
+class Detector {
+
+    private array $inputs;
+    private Adapter $adapter;
+
+    public function _construct(array $inputs, Adapter $adapter) { 
+        $this->inputs = $inputs;
+        $this->adapter = $adapter;
+    }  
+
+    public function detect(): ?Detection
+    {
+        return $this->adapter->detect($this->inputs);
+    }
+}

example.php

@@ -0,0 +1,52 @@
+<?php
+
+use Utopia\Detector\Detector;
+use Utopia\Detector\Adapter\Framework;
+use Utopia\Detector\Adapter\PackageManager;
+use Utopia\Detector\Adapter\RenderingStrategy;
+use Utopia\Detector\Adapter\Runtime;
+use Utopia\Detector\Detection\Framework\Detection as FrameworkDetection;
+use Utopia\Detector\Detection\PackageManager\Detection as PackageManagerDetection;
+use Utopia\Detector\Detection\RenderingStrategy\Detection as RenderingStrategyDetection;
+use Utopia\Detector\Detection\Runtime\Detection as RuntimeDetection;
+
+$files = ['src/main.js', '.gitignore', 'package.json', 'yarn.lock'];
+$runtimeDetector = new Detector($files, new Runtime());
+$detection = $runtimeDetector->detect();
+
+if ($detection instanceof RuntimeDetection) {
+    $installCommand = $detection->getCommand();
+    echo "Detected runtime: " . $detection->getName() . "\n";
+    echo "Install command: " . $installCommand . "\n";
+} else {
+    echo "No runtime detected.\n";
+}
+
+$frameworkDetector = new Detector($files, new Framework());
+$detection = $frameworkDetector->detect();
+
+if ($detection instanceof FrameworkDetection) {
+    echo "Detected framework: " . $detection->getName() . "\n";
+    echo "Install command: " . $detection->getInstallCommand() . "\n";
+    echo "Build command: " . $detection->getBuildCommand() . "\n";
+} else {
+    echo "No framework detected.\n";
+}
+
+$packageManagerDetector = new Detector($files, new PackageManager());
+$detection = $packageManagerDetector->detect();
+
+if ($detection instanceof PackageManagerDetection) {
+    echo "Detected package manager: " . $detection->getName() . "\n";
+} else {
+    echo "No package manager detected.\n";
+}
+
+$renderingStrategyDetector = new Detector($files, new RenderingStrategy());
+$detection = $renderingStrategyDetector->detect();
+
+if ($detection instanceof RenderingStrategyDetection) {
+    echo "Detected rendering strategy: " . $detection->getName() . "\n";
+} else {
+    echo "No rendering strategy detected.\n";
+}