Service-level params for Web

Author: Meldiron

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

@@ -8,6 +8,39 @@ type Payload = {
 }
 
 export class {{ service.name | caseUcfirst }} extends Service {
+{% if service.globalParams | length %}
+{% for parameter in service.globalParams %}
+    {{ parameter.name | caseCamel | escapeKeyword }};
+    /**
+     * Set {{ parameter.name }}.
+     *
+     * @param {{ '{' }}{{ parameter.type | typeName }}{{ '}' }} {{ parameter.name | caseCamel | escapeKeyword }}
+     *
+     * @return void
+     */
+     set{{ parameter.name | caseUcfirst | escapeKeyword }}({{ parameter.name | caseCamel | escapeKeyword }})
+     {
+        this.{{ parameter.name | caseCamel | escapeKeyword }} = {{ parameter.name | caseCamel | escapeKeyword }};
+     }
+    /**
+     * Get {{ parameter.name }}.
+     *
+     * @return {{ parameter.type | typeName }}
+     */
+     get{{ parameter.name | caseUcfirst | escapeKeyword }}({{ parameter.name | caseCamel | escapeKeyword }})
+     {
+        return this.{{ parameter.name | caseCamel | escapeKeyword }};
+     }
+{% endfor %}
+     constructor(client, {% for parameter in service.globalParams %} {{ parameter.name | caseCamel | escapeKeyword }}{% if not parameter.required %} = null{% endif %}{% if not loop.last %}, {% endif %}{% endfor %})
+     {
+        super(client);
+
+{% for parameter in service.globalParams %}
+        this.{{ parameter.name | caseCamel | escapeKeyword }} = {{ parameter.name | caseCamel | escapeKeyword }};
+{% endfor %}
+     }
+{% endif %}
 {% for method in service.methods %}
 
         /**
@@ -17,34 +50,34 @@ export class {{ service.name | caseUcfirst }} extends Service {
 {{ method.description|comment3 }}
 {% endif %}
          *
-{% for parameter in method.parameters.all %}
+{% for parameter in method.parameters.all | filter((param) => not param.isGlobal) %}
          * @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 %}{{ 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 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 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 }}{{ '}' }}', {{ parameter.name | caseCamel | escapeKeyword }}){% 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 payload: Payload = {};
 
 {% for parameter in method.parameters.query %}
-            if (typeof {{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
-                payload['{{ parameter.name }}'] = {{ parameter.name | caseCamel | escapeKeyword }};
+            if (typeof {% if parameter.isGlobal %}this.{% endif %}{{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
+                payload['{{ parameter.name }}'] = {% if parameter.isGlobal %}this.{% endif %}{{ parameter.name | caseCamel | escapeKeyword }};
             }
 
 {% endfor %}
 {% for parameter in method.parameters.body %}
-            if (typeof {{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
-                payload['{{ parameter.name }}'] = {{ parameter.name | caseCamel | escapeKeyword }};
+            if (typeof {% if parameter.isGlobal %}this.{% endif %}{{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
+                payload['{{ parameter.name }}'] = {% if parameter.isGlobal %}this.{% endif %}{{ parameter.name | caseCamel | escapeKeyword }};
             }
 
 {% endfor %}

tests/languages/web/index.html

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

tests/languages/web/node.js

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