Merge pull request #501 from appwrite/remove-web-global-params

fix: web SDK removing global params

Author: TorstenDittmann

composer.json

@@ -23,11 +23,11 @@
         "ext-curl": "*",
         "ext-mbstring": "*",
         "ext-json": "*",
-        "twig/twig": "^3.3",
-        "matthiasmullie/minify": "^1.3"
+        "twig/twig": "^3.4.1",
+        "matthiasmullie/minify": "^1.3.68"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5.13",
+        "phpunit/phpunit": "^9.5.21",
         "brianium/paratest": "^6.4"
     },
     "minimum-stability": "dev",

composer.lock

@@ -8,7 +8,7 @@ export namespace Models {
         /**
          * {{ property.description }}
          */
-        {{ property.name | escapeKeyword }}{% if not property.required %}?{% endif %}: {{ property | getSubSchema(spec) | raw }};
+        {{ property.name }}{% if not property.required %}?{% endif %}: {{ property | getSubSchema(spec) | raw }};
 {% endfor %}
 {% if definition.additionalProperties %}        [key: string]: any;
 {% endif %}

specs/swagger2-latest-console.json

@@ -1,34 +1,13 @@
 import { Service } from '../service';
 import { {{ spec.title | caseUcfirst}}Exception, Client } from '../client';
 import type { Models } from '../models';
-import type { UploadProgress } from '../client';
-
-type Payload = {
-    [key: string]: any;
-}
+import type { UploadProgress, Payload } from '../client';
 
 export class {{ service.name | caseUcfirst }} extends Service {
-{% if service.globalParams | length %}
-{% for parameter in service.globalParams %}
-     protected {{ parameter.name | caseCamel | escapeKeyword }}: {{ parameter.type | typeName }};
-     public set{{ parameter.name | caseUcfirst | escapeKeyword }}({{ parameter.name | caseCamel | escapeKeyword }}: {{ parameter.type | typeName }}): void
-     {
-        this.{{ parameter.name | caseCamel | escapeKeyword }} = {{ parameter.name | caseCamel | escapeKeyword }};
-     }
-     public get{{ parameter.name | caseUcfirst | escapeKeyword }}(): {{ parameter.type | typeName }}
-     {
-        return this.{{ parameter.name | caseCamel | escapeKeyword }};
-     }
-{% endfor %}
-     constructor(client: Client, {% for parameter in service.globalParams %} {{ parameter.name | caseCamel | escapeKeyword }}:{{ parameter.type | typeName }}{% if not parameter.required %}|null = null{% endif %}{% if not loop.last %}, {% endif %}{% endfor %})
+     constructor(client: Client)
      {
         super(client);
-
-{% for parameter in service.globalParams %}
-        this.{{ parameter.name | caseCamel | escapeKeyword }} = {{ parameter.name | caseCamel | escapeKeyword }};
-{% endfor %}
      }
-{% endif %}
 {% for method in service.methods %}
 
         /**
@@ -38,34 +17,34 @@ export class {{ service.name | caseUcfirst }} extends Service {
 {{ method.description|comment3 }}
 {% endif %}
          *
-{% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
+{% for parameter in method.parameters.all %}
          * @param {{ '{' }}{{ parameter.type | getPropertyType(method) | raw }}{{ '}' }} {{ parameter.name | caseCamel | escapeKeyword }}
 {% endfor %}
          * @throws {{ '{' }}{{ spec.title | caseUcfirst}}Exception}
          * @returns {% if method.type == 'webAuth' %}{void|string}{% elseif method.type == 'location' %}{URL}{% else %}{Promise}{% endif %}
 
          */
-        {% if method.type != 'location' and method.type != 'webAuth'%}async {% endif %}{{ method.name | caseCamel }}{{ method.responseModel | getGenerics(spec) | raw }}({% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}{{ parameter.name | caseCamel | escapeKeyword }}{% if not parameter.required %}?{% endif %}: {{ parameter.type | getPropertyType(method) | raw }}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in method.consumes %}, onProgress = (progress: UploadProgress) => {}{% endif %}): {{ method | getReturn(spec) | raw }} {
-{% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
+        {% if method.type != 'location' and method.type != 'webAuth'%}async {% endif %}{{ method.name | caseCamel }}{{ method.responseModel | getGenerics(spec) | raw }}({% for parameter in method.parameters.all %}{{ parameter.name | caseCamel | escapeKeyword }}{% if not parameter.required %}?{% endif %}: {{ parameter.type | getPropertyType(method) | raw }}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in method.consumes %}, onProgress = (progress: UploadProgress) => {}{% endif %}): {{ method | getReturn(spec) | raw }} {
+{% for parameter in method.parameters.all %}
 {% if parameter.required %}
             if (typeof {{ parameter.name | caseCamel | escapeKeyword }} === 'undefined') {
                 throw new {{spec.title | caseUcfirst}}Exception('Missing required parameter: "{{ parameter.name | caseCamel | escapeKeyword }}"');
             }
 
 {% endif %}
 {% endfor %}
-            let path = '{{ method.path }}'{% for parameter in method.parameters.path %}.replace('{{ '{' }}{{ parameter.name | caseCamel | escapeKeyword }}{{ '}' }}', {% if parameter.isGlobal %}this.{% endif %}{{ parameter.name | caseCamel | escapeKeyword }}){% endfor %};
+            let path = '{{ method.path }}'{% for parameter in method.parameters.path %}.replace('{{ '{' }}{{ parameter.name | caseCamel | escapeKeyword }}{{ '}' }}', {{ parameter.name | caseCamel | escapeKeyword }}){% endfor %};
             let payload: Payload = {};
 
 {% for parameter in method.parameters.query %}
-            if (typeof {% if parameter.isGlobal %}this.{% endif %}{{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
-                payload['{{ parameter.name }}'] = {% if parameter.isGlobal %}this.{% endif %}{{ parameter.name | caseCamel | escapeKeyword }};
+            if (typeof {{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
+                payload['{{ parameter.name }}'] = {{ parameter.name | caseCamel | escapeKeyword }};
             }
 
 {% endfor %}
 {% for parameter in method.parameters.body %}
-            if (typeof {% if parameter.isGlobal %}this.{% endif %}{{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
-                payload['{{ parameter.name }}'] = {% if parameter.isGlobal %}this.{% endif %}{{ parameter.name | caseCamel | escapeKeyword }};
+            if (typeof {{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
+                payload['{{ parameter.name }}'] = {{ parameter.name | caseCamel | escapeKeyword }};
             }
 
 {% endfor %}

templates/web/src/models.ts.twig

@@ -22,7 +22,7 @@
             // Init SDK
             const { Client, Foo, Bar, General } = Appwrite;
             const client = new Client();
-            const foo = new Foo(client, 'string');
+            const foo = new Foo(client);
             const bar = new Bar(client);
             const general = new General(client);
 
@@ -34,19 +34,19 @@
             });
 
             // Foo
-            response = await foo.get(123, ["string in array"]);
+            response = await foo.get('string', 123, ["string in array"]);
             console.log(response.result);
 
-            response = await foo.post(123, ["string in array"]);
+            response = await foo.post('string', 123, ["string in array"]);
             console.log(response.result);
 
-            response = await foo.put(123, ["string in array"]);
+            response = await foo.put('string', 123, ["string in array"]);
             console.log(response.result);
 
-            response = await foo.patch(123, ["string in array"]);
+            response = await foo.patch('string', 123, ["string in array"]);
             console.log(response.result);
 
-            response = await foo.delete(123, ["string in array"]);
+            response = await foo.delete('string', 123, ["string in array"]);
             console.log(response.result);
 
             // Bar

templates/web/src/services/template.ts.twig

@@ -5,23 +5,23 @@ async function start() {
 
     console.log('\nTest Started');
     const client = new Client();
-    const foo = new Foo(client, 'string');
+    const foo = new Foo(client);
     const bar = new Bar(client);
     const general = new General(client);
     // Foo
-    response = await foo.get(123, ['string in array']);
+    response = await foo.get('string', 123, ['string in array']);
     console.log(response.result);
 
-    response = await foo.post(123, ['string in array']);
+    response = await foo.post('string', 123, ['string in array']);
     console.log(response.result);
 
-    response = await foo.put(123, ['string in array']);
+    response = await foo.put('string', 123, ['string in array']);
     console.log(response.result);
 
-    response = await foo.patch(123, ['string in array']);
+    response = await foo.patch('string', 123, ['string in array']);
     console.log(response.result);
 
-    response = await foo.delete(123, ['string in array']);
+    response = await foo.delete('string', 123, ['string in array']);
     console.log(response.result);
 
     // Bar