Merge pull request #674 from 2002Bishwajeet/feat-whitelist-enums

feat: Enum Whitelist
appwrite · Aug 15, 2023 · 8004657 · 8004657
2 parents c4ef17e + 453ffdb
commit 8004657
Show file tree

Hide file tree

Showing 47 changed files with 314 additions and 36 deletions.
diff --git a/example.php b/example.php
@@ -37,8 +37,8 @@ function getSSLPage($url) {
     }
 
     // Leave the platform you want uncommented
-    $platform = 'client';
-    // $platform = 'console';
+//    $platform = 'client';
+     $platform = 'console';
     // $platform = 'server';
 
     $spec = getSSLPage("https://raw.githubusercontent.com/appwrite/appwrite/master/app/config/specs/swagger2-latest-{$platform}.json");

diff --git a/src/SDK/Language/Android.php b/src/SDK/Language/Android.php
@@ -387,6 +387,11 @@ public function getFiles(): array
                 'destination'   => 'library/src/main/java/io/appwrite/models/{{ definition.name | caseUcfirst }}.kt',
                 'template'      => '/android/library/src/main/java/io/appwrite/models/Model.kt.twig',
             ],
+            [
+                'scope'         => 'enum',
+                'destination'   => 'library/src/main/java/io/appwrite/enums/{{ enum.name | caseUcfirst }}.kt',
+                'template'      => '/android/library/src/main/java/io/appwrite/enums/Enum.kt.twig',
+            ],
         ];
     }
 }
diff --git a/src/SDK/Language/Apple.php b/src/SDK/Language/Apple.php
@@ -60,6 +60,11 @@ public function getFiles(): array
                 'destination'   => '/Sources/{{ spec.title | caseUcfirst}}/WebSockets/WebSocketClientError.swift',
                 'template'      => '/swift/Sources/WebSockets/WebSocketClientError.swift.twig',
             ],
+            [
+                'scope' => 'enum',
+                'destination' => '/Sources/{{ spec.title | caseUcfirst}}/Enums/{{ enum.name | caseUcfirst }}.swift',
+                'template' => '/swift/Sources/Enums/Enum.swift.twig',
+            ],
             // Config for project example-swiftui
             [
                 'scope'         => 'default',

diff --git a/src/SDK/Language/Dart.php b/src/SDK/Language/Dart.php
@@ -466,6 +466,11 @@ public function getFiles(): array
                 'destination'   => 'lib/src/input_file.dart',
                 'template'      => 'dart/lib/src/input_file.dart.twig',
             ],
+            [
+                'scope'         => 'enum',
+                'destination'   => 'lib/src/enums/{{ enum.name | caseSnake }}.dart',
+                'template'      => 'dart/lib/src/enums/enum.dart.twig',
+            ],
         ];
     }
 

diff --git a/src/SDK/Language/Deno.php b/src/SDK/Language/Deno.php
@@ -93,6 +93,11 @@ public function getFiles(): array
                 'destination'   => 'docs/examples/{{service.name | caseLower}}/{{method.name | caseDash}}.md',
                 'template'      => 'deno/docs/example.md.twig',
             ],
+            [
+                'scope'         => 'enum',
+                'destination'   => 'src/enums/{{ enum.name | caseDash }}.ts',
+                'template'      => 'deno/src/enums/enum.ts.twig',
+            ],
         ];
     }
 
@@ -102,6 +107,10 @@ public function getFiles(): array
      */
     public function getTypeName(array $parameter): string
     {
+        if (isset($parameter['enumName'])) {
+            return $parameter['enumName'];
+        }
+
         switch ($parameter['type']) {
             case self::TYPE_INTEGER:
                 return 'number';

diff --git a/src/SDK/Language/DotNet.php b/src/SDK/Language/DotNet.php
@@ -129,7 +129,8 @@ public function getKeywords(): array
             'when',
             'where',
             'while',
-            'yield'
+            'yield',
+            'path'
         ];
     }
 
@@ -150,6 +151,7 @@ public function getIdentifierOverrides(): array
      */
     public function getTypeName(array $parameter): string
     {
+
         switch ($parameter['type']) {
             case self::TYPE_INTEGER:
                 return 'long';
@@ -394,6 +396,11 @@ public function getFiles(): array
                 'scope'         => 'definition',
                 'destination'   => '/src/{{ spec.title | caseUcfirst }}/Models/{{ definition.name | caseUcfirst | overrideIdentifier }}.cs',
                 'template'      => 'dotnet/src/Appwrite/Models/Model.cs.twig',
+            ],
+            [
+                'scope'         => 'enum',
+                'destination'   => '/src/{{ spec.title | caseUcfirst }}/Enums/{{ enum.name | caseUcfirst | overrideIdentifier }}.cs',
+                'template'      => 'dotnet/src/Appwrite/Enums/Enums.cs.twig',
             ]
         ];
     }

diff --git a/src/SDK/Language/Flutter.php b/src/SDK/Language/Flutter.php
@@ -330,6 +330,11 @@ public function getFiles(): array
                 'destination'   => '.travis.yml',
                 'template'      => 'flutter/.travis.yml.twig',
             ],
+            [
+                'scope'         => 'enum',
+                'destination'   => 'lib/src/enums/{{ enum.name | caseSnake }}.dart',
+                'template'      => 'dart/lib/src/enums/enum.dart.twig',
+            ],
         ];
     }
 }
diff --git a/src/SDK/Language/JS.php b/src/SDK/Language/JS.php
@@ -105,6 +105,7 @@ public function getKeywords(): array
             'while',
             'with',
             'yield',
+            'path'
         ];
     }
 
@@ -123,6 +124,7 @@ public function getIdentifierOverrides(): array
      */
     public function getTypeName(array $parameter): string
     {
+
         switch ($parameter['type']) {
             case self::TYPE_INTEGER:
             case self::TYPE_NUMBER:

diff --git a/src/SDK/Language/Kotlin.php b/src/SDK/Language/Kotlin.php
@@ -86,7 +86,8 @@ public function getKeywords(): array
             "vararg",
             "when",
             "where",
-            "while"
+            "while",
+            "path"
         ];
     }
 
@@ -104,6 +105,7 @@ public function getIdentifierOverrides(): array
      */
     public function getTypeName(array $parameter): string
     {
+
         switch ($parameter['type']) {
             case self::TYPE_INTEGER:
                 return 'Long';
@@ -418,6 +420,11 @@ public function getFiles(): array
                 'destination'   => '/src/main/kotlin/{{ sdk.namespace | caseSlash }}/models/{{ definition.name | caseUcfirst }}.kt',
                 'template'      => '/kotlin/src/main/kotlin/io/appwrite/models/Model.kt.twig',
             ],
+            [
+                'scope'         => 'enum',
+                'destination'   => '/src/main/kotlin/{{ sdk.namespace | caseSlash }}/enums/{{ enum.name | caseUcfirst }}.kt',
+                'template'      => '/kotlin/src/main/kotlin/io/appwrite/enums/Enum.kt.twig',
+            ],
         ];
     }
 

diff --git a/src/SDK/Language/Node.php b/src/SDK/Language/Node.php
@@ -126,6 +126,11 @@ public function getFiles(): array
                 'destination'   => '.travis.yml',
                 'template'      => 'node/.travis.yml.twig',
             ],
+            [
+                'scope'         => 'enum',
+                'destination'   => 'lib/enums/{{ enum.name | caseDash }}.js',
+                'template'      => 'node/lib/enums/enum.js.twig',
+            ],
         ];
     }
 

diff --git a/src/SDK/Language/PHP.php b/src/SDK/Language/PHP.php
@@ -117,7 +117,8 @@ public function getKeywords(): array
             'use',
             'var',
             'while',
-            'xor'
+            'xor',
+            'path'
         ];
     }
 
@@ -211,6 +212,11 @@ public function getFiles(): array
                 'destination'   => '/src/{{ spec.title | caseUcfirst}}/Services/{{service.name | caseUcfirst}}.php',
                 'template'      => 'php/src/Services/Service.php.twig',
             ],
+            [
+                'scope'         => 'enum',
+                'destination'   => '/src/{{ spec.title | caseUcfirst}}/Enums/{{ enum.name | caseUcfirst }}.php',
+                'template'      => 'php/src/Enums/Enum.php.twig',
+            ],
         ];
     }
 
@@ -221,6 +227,7 @@ public function getFiles(): array
      */
     public function getTypeName(array $parameter): string
     {
+
         switch ($parameter['type']) {
             case self::TYPE_STRING:
                 $type = 'string';

diff --git a/src/SDK/Language/Python.php b/src/SDK/Language/Python.php
@@ -184,6 +184,11 @@ public function getFiles(): array
                 'destination'   => '.travis.yml',
                 'template'      => 'python/.travis.yml.twig',
             ],
+            [
+                'scope'         => 'enum',
+                'destination'   => '{{ spec.title | caseSnake}}/enums/{{ enum.name | caseSnake }}.py',
+                'template'      => 'python/package/enums/enum.py.twig',
+            ],
         ];
     }
 

diff --git a/src/SDK/Language/Ruby.php b/src/SDK/Language/Ruby.php
@@ -74,6 +74,7 @@ public function getKeywords(): array
             'until',
             'when',
             'while',
+            'path'
         ];
     }
 

diff --git a/src/SDK/Language/Swift.php b/src/SDK/Language/Swift.php
@@ -284,6 +284,11 @@ public function getFiles(): array
                 'destination'   => '/Sources/{{ spec.title | caseUcfirst}}Models/{{ definition.name | caseUcfirst }}.swift',
                 'template'      => '/swift/Sources/Models/Model.swift.twig',
             ],
+            [
+                'scope' => 'enum',
+                'destination' => '/Sources/{{ spec.title | caseUcfirst}}Enums/{{ enum.name | caseUcfirst }}.swift',
+                'template' => '/swift/Sources/Enums/Enum.swift.twig',
+            ]
         ];
     }
 
@@ -293,6 +298,10 @@ public function getFiles(): array
      */
     public function getTypeName(array $parameter): string
     {
+        if (isset($parameter['enumName'])) {
+            return $parameter['enumName'];
+        }
+
         switch ($parameter['type']) {
             case self::TYPE_INTEGER:
                 return 'Int';

diff --git a/src/SDK/Language/Web.php b/src/SDK/Language/Web.php
@@ -115,6 +115,11 @@ public function getFiles(): array
                 'destination'   => '.travis.yml',
                 'template'      => 'web/.travis.yml.twig',
             ],
+            [
+                'scope'         => 'enum',
+                'destination'   => 'src/enums/{{ enum.name | caseDash }}.ts',
+                'template'      => 'web/src/enums/enum.ts.twig',
+            ],
         ];
     }
 

diff --git a/src/SDK/SDK.php b/src/SDK/SDK.php
@@ -556,6 +556,7 @@ public function generate(string $target): void
                 'params' => $this->language->getParams(),
             ],
             'sdk' => $this->getParams(),
+            'enums' => $this->spec->getEnumNames(),
         ];
 
         foreach ($this->language->getFiles() as $file) {
@@ -634,6 +635,27 @@ public function generate(string $target): void
                         }
                     }
                     break;
+                case 'enum':
+                    foreach ($this->spec->getServices() as $key => $service) {
+                        $methods = $this->spec->getMethods($key);
+
+                        foreach ($methods as $method) {
+                            $parameters = $method['parameters']['all'];
+
+                            foreach ($parameters as $parameter) {
+                                    // Check if the enum field is defined
+                                if (isset($parameter['enumValues'])) {
+                                    $params['enum'] = [
+                                        'name' =>  $parameter['enumName'] ?? $parameter['name'],
+                                        'enum' => $parameter['enumValues'],
+                                        'keys' => $parameter['enumKeys'],
+                                    ];
+                                    $this->render($template, $destination, $block, $params, $minify);
+                                }
+                            }
+                        }
+                    }
+                    break;
             }
         }
     }

diff --git a/src/Spec/Spec.php b/src/Spec/Spec.php
@@ -164,4 +164,11 @@ public function setAttribute($key, $value, $type = self::SET_TYPE_ASSIGN)
 
         return $this;
     }
+
+    /**
+     * Get EnumNames
+     *
+     * @return array
+     */
+    abstract public function getEnumNames();
 }
diff --git a/src/Spec/Swagger2.php b/src/Spec/Swagger2.php
@@ -221,6 +221,11 @@ public function getMethods($service)
                         }
 
                         $param['default'] = (is_array($param['default'])) ? json_encode($param['default']) : $param['default'];
+                        if (isset($parameter['enum'])) {
+                            $param['enumValues'] = $parameter['enum'];
+                            $param['enumName'] = $parameter['x-enum-name'];
+                            $param['enumKeys'] = $parameter['x-enum-keys'];
+                        }
 
                         switch ($parameter['in']) {
                             case 'header':
@@ -240,24 +245,31 @@ public function getMethods($service)
                                 $bodyRequired = $parameter['schema']['required'] ?? [];
 
                                 foreach ($bodyProperties as $key => $value) {
-                                    $param['name'] = $key;
-                                    $param['type'] = $value['type'] ?? null;
-                                    $param['description'] = $value['description'] ?? '';
-                                    $param['required'] = (in_array($key, $bodyRequired));
-                                    $param['example'] = $value['x-example'] ?? null;
-                                    $param['isUploadID'] = $value['x-upload-id'] ?? false;
-                                    $param['nullable'] = $value['x-nullable'] ?? false;
-                                    $param['array'] = [
+                                    $temp = $param;
+                                    $temp['name'] = $key;
+                                    $temp['type'] = $value['type'] ?? null;
+                                    $temp['description'] = $value['description'] ?? '';
+                                    $temp['required'] = (in_array($key, $bodyRequired));
+                                    $temp['example'] = $value['x-example'] ?? null;
+                                    $temp['isUploadID'] = $value['x-upload-id'] ?? false;
+                                    $temp['nullable'] = $value['x-nullable'] ?? false;
+                                    $temp['array'] = [
                                         'type' => $value['items']['type'] ?? '',
                                     ];
                                     if ($value['type'] === 'object' && is_array($value['default'])) {
                                         $value['default'] = (empty($value['default'])) ? new stdClass() : $value['default'];
                                     }
 
-                                    $param['default'] = (is_array($value['default']) || $value['default'] instanceof stdClass) ? json_encode($value['default']) : $value['default'];
+                                    if (isset($value['enum'])) {
+                                        $temp['enumValues'] = $value['enum'];
+                                        $temp['enumName'] = $value['x-enum-name'];
+                                        $temp['enumKeys'] = $value['x-enum-keys'];
+                                    }
+
+                                    $temp['default'] = (is_array($value['default']) || $value['default'] instanceof stdClass) ? json_encode($value['default']) : $value['default'];
 
-                                    $output['parameters']['body'][] = $param;
-                                    $output['parameters']['all'][] = $param;
+                                    $output['parameters']['body'][] = $temp;
+                                    $output['parameters']['all'][] = $temp;
                                 }
 
                                 continue 2;
@@ -341,4 +353,25 @@ public function getDefinitions()
         }
         return $list;
     }
+
+    /**
+     * @return array
+     */
+    public function getEnumNames(): array
+    {
+        $list = [];
+
+        foreach ($this->getServices() as $key => $service) {
+            foreach ($this->getMethods($key) as $method) {
+                if (isset($method['parameters']) && is_array($method['parameters'])) {
+                    foreach ($method['parameters']['all'] as $parameter) {
+                        if (isset($parameter['enumValues'])) {
+                            $list[] = $parameter['enumName'] ?? $parameter['name'];
+                        }
+                    }
+                }
+            }
+        }
+        return  \array_values(\array_unique($list));
+    }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -74,6 +74,7 @@ public function getKeywords(): array @@
                 'until',
                 'when',
                 'while',
+                'path'
             ];
         }
@@ Expand Down @@