fix(web): typed arguments and service classes

src/SDK/Language.php

@@ -74,4 +74,13 @@ public function getParams()
     {
         return $this->params;
     }
+
+    /**
+     * Language specific filters.
+     * @return array 
+     */
+    public function getFilters(): array
+    {
+        return [];
+    }
 }

src/SDK/Language/Web.php

@@ -2,7 +2,10 @@
 
 namespace Appwrite\SDK\Language;
 
-class Web extends JS {
+use Twig\TwigFilter;
+
+class Web extends JS
+{
 
     /**
      * @return string
@@ -20,8 +23,38 @@ public function getFiles()
         return [
             [
                 'scope'         => 'default',
-                'destination'   => 'src/sdk.ts',
-                'template'      => '/web/src/sdk.ts.twig',
+                'destination'   => 'src/index.ts',
+                'template'      => 'web/src/index.ts.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'src/client.ts',
+                'template'      => 'web/src/client.ts.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'src/service.ts',
+                'template'      => 'web/src/service.ts.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'service',
+                'destination'   => 'src/services/{{service.name | caseDash}}.ts',
+                'template'      => 'web/src/services/template.ts.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'src/models.ts',
+                'template'      => 'web/src/models.ts.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'src/query.ts',
+                'template'      => 'web/src/query.ts.twig',
                 'minify'        => false,
             ],
             [
@@ -98,7 +131,7 @@ public function getParamExample(array $param)
 
         $output = '';
 
-        if(empty($example) && $example !== 0 && $example !== false) {
+        if (empty($example) && $example !== 0 && $example !== false) {
             switch ($type) {
                 case self::TYPE_NUMBER:
                 case self::TYPE_INTEGER:
@@ -118,8 +151,7 @@ public function getParamExample(array $param)
                     $output .= "document.getElementById('uploader').files[0]";
                     break;
             }
-        }
-        else {
+        } else {
             switch ($type) {
                 case self::TYPE_NUMBER:
                 case self::TYPE_INTEGER:
@@ -141,4 +173,170 @@ public function getParamExample(array $param)
 
         return $output;
     }
+
+    public function getTypeName($type, $method = []): string
+    {
+        switch ($type) {
+            case self::TYPE_INTEGER:
+            case self::TYPE_NUMBER:
+                return 'number';
+                break;
+            case self::TYPE_ARRAY:
+                return 'string[]';
+            case self::TYPE_FILE:
+                return 'File';
+            case self::TYPE_OBJECT:
+                if (empty($method)) {
+                    return $type;
+                }
+
+                switch ($method['responseModel']) {
+                    case 'user':
+                        return "Partial<Preferences>";
+                        break;
+                    case 'document':
+                        if ($method['method'] === 'post') {
+                            return "Omit<Document, keyof Models.Document>";
+                        }
+                        if ($method['method'] === 'patch') {
+                            return "Partial<Omit<Document, keyof Models.Document>>";
+                        }
+                }
+                break;
+        }
+
+        return $type;
+    }
+
+    protected function populateGenerics(string $model, array $spec, array &$generics, bool $skipFirst = false)
+    {
+        if (!$skipFirst && $spec['definitions'][$model]['additionalProperties']) {
+            $generics[] = $this->toUpperCase($model);
+        }
+
+        $properties = $spec['definitions'][$model]['properties'];
+
+        foreach ($properties as $property) {
+            if (array_key_exists('sub_schema', $property) && $property['sub_schema']) {
+                $this->populateGenerics($property['sub_schema'], $spec, $generics, false);
+            }
+        }
+    }
+
+    public function getGenerics(string $model, array $spec, bool $skipFirst = false): string
+    {
+        $generics = [];
+
+        if (array_key_exists($model, $spec['definitions'])) {
+            $this->populateGenerics($model, $spec, $generics, $skipFirst);
+        }
+
+        if (empty($generics)) return '';
+
+        $generics = array_unique($generics);
+        $generics = array_map(fn ($type) => "{$type} extends Models.{$type}", $generics);
+
+        return '<' . implode(', ', $generics) . '>';
+    }
+
+    public function getReturn(array $method, array $spec): string
+    {
+        if ($method['type'] === 'webAuth') {
+            return 'void | URL';
+        } elseif ($method['type'] === 'location') {
+            return 'URL';
+        }
+
+        if (array_key_exists('responseModel', $method) && !empty($method['responseModel']) && $method['responseModel'] !== 'any') {
+            $ret = 'Promise<';
+
+            if (
+                array_key_exists($method['responseModel'], $spec['definitions']) &&
+                array_key_exists('additionalProperties', $spec['definitions'][$method['responseModel']]) &&
+                !$spec['definitions'][$method['responseModel']]['additionalProperties']
+            ) {
+                $ret .= 'Models.';
+            }
+
+            $ret .= $this->toUpperCase($method['responseModel']);
+
+            $models = [];
+
+            if ($method['responseModel']) {
+                $this->populateGenerics($method['responseModel'], $spec, $models);
+            }
+
+            $models = array_unique($models);
+            $models = array_filter($models, fn ($model) => $model != $this->toUpperCase($method['responseModel']));
+
+            if (!empty($models)) {
+                $ret .= '<' . implode(', ', $models) . '>';
+            }
+
+            $ret .= '>';
+
+            return $ret;
+        } else {
+            return 'Promise<{}>';
+        }
+
+        return "";
+    }
+
+    public function toUpperCase(string $value): string
+    {
+        return ucfirst((string)$this->helperCamelCase($value));
+    }
+
+    protected function helperCamelCase($str)
+    {
+        $str = preg_replace('/[^a-z0-9' . implode("", []) . ']+/i', ' ', $str);
+        $str = trim($str);
+        $str = ucwords($str);
+        $str = str_replace(" ", "", $str);
+        $str = lcfirst($str);
+
+        return $str;
+    }
+
+    public function getSubSchema(array $property, array $spec): string
+    {
+        if (array_key_exists('sub_schema', $property)) {
+            $ret = '';
+            $generics = [];
+            $this->populateGenerics($property['sub_schema'], $spec, $generics);
+
+            $generics = array_filter($generics, fn ($model) => $model != $this->toUpperCase($property['sub_schema']));
+
+            $ret .= $this->toUpperCase($property['sub_schema']);
+            if (!empty($generics)) {
+                $ret .= '<' . implode(', ', $generics) . '>';
+            }
+            if ($property['type'] === 'array') {
+                $ret .= '[]';
+            }
+
+            return $ret;
+        }
+
+        return $this->getTypeName($property['type']);
+    }
+
+    public function getFilters(): array
+    {
+        return [
+            new TwigFilter('getPropertyType', function ($value, $method = []) {
+                return $this->getTypeName($value, $method);
+            }),
+            new TwigFilter('getSubSchema', function (array $property, array $spec) {
+                return $this->getSubSchema($property, $spec);
+            }),
+            new TwigFilter('getGenerics', function (string $model, array $spec, bool $skipAdditional = false) {
+                return $this->getGenerics($model, $spec, $skipAdditional);
+            }),
+            new TwigFilter('getReturn', function (array $method, array $spec) {
+                return $this->getReturn($method, $spec);
+            }),
+        ];
+    }
 }

src/SDK/SDK.php

@@ -75,6 +75,14 @@ public function __construct(Language $language, Spec $spec)
         $this->twig = new Environment(new FilesystemLoader(__DIR__ . '/../../templates'), [
             'debug' => true
         ] );
+
+        /**
+         * Add language specific filters
+         */
+        foreach ($this->language->getFilters() as $filter) {
+            $this->twig->addFilter($filter);
+        }
+
         $this->twig->addExtension(new \Twig\Extension\DebugExtension());
 
         $this->twig->addFilter(new TwigFilter('caseLower', function ($value) {

templates/web/package.json.twig

@@ -13,7 +13,7 @@
     "./package.json": "./package.json"
   },
   "module": "dist/esm/sdk.js",
-  "types": "types/sdk.d.ts",
+  "types": "types/index.d.ts",
   "repository": {
     "type": "git",
     "url": "{{ sdk.gitURL }}"
@@ -24,12 +24,12 @@
     "build:libs": "rollup -c"
   },
   "devDependencies": {
-    "@rollup/plugin-typescript": "8.2.5",
+    "@rollup/plugin-typescript": "8.3.2",
     "playwright": "1.15.0",
-    "rollup": "2.56.3",
-    "serve-handler": "6.1.3",
-    "tslib": "2.3.1",
-    "typescript": "4.2.3"
+    "rollup": "2.75.4",
+    "serve-handler": "6.1.0",
+    "tslib": "2.4.0",
+    "typescript": "4.7.2"
   },
   "dependencies": {
     "cross-fetch": "3.1.5",

templates/web/rollup.config.js.twig

@@ -3,7 +3,7 @@ import typescript from "@rollup/plugin-typescript";
 
 export default {
     external: Object.keys(pkg.dependencies),
-    input: "src/sdk.ts",
+    input: "src/index.ts",
     plugins: [typescript()],
     output: [
         {
@@ -20,7 +20,7 @@ export default {
         {
             format: "iife",
             file: pkg.jsdelivr,
-            name: "window",
+            name: "Appwrite",
             extend: true,
             globals: {
                 "cross-fetch": "window",