fix: validate string-list parameters across SDKs

mock-server/app/http.php

@@ -555,7 +555,7 @@
     ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
     ->label('sdk.response.model', Response::MODEL_MOCK)
     ->label('sdk.mock', true)
-    ->param('queries', [], new ArrayList(new Text(4096), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Array of query strings generated using the Query class provided by the SDK.')
+    ->param('queries', [], new ArrayList(new Text(4096), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Array of query strings generated using the Query class provided by the SDK.', true)
     ->inject('response')
     ->action(function (array $queries, UtopiaSwooleResponse $response) {
         $response->json(['result' => \json_encode($queries)]);
@@ -655,7 +655,9 @@
     ->label('sdk.response.model', Response::MODEL_MOCK)
     ->label('sdk.mock', true)
     ->param('documents', [], new ArrayList(new Assoc(), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Array of document objects.')
-    ->action(function (array $documents) {
+    ->param('labels', null, new Nullable(new ArrayList(new Nullable(new Text(256)), APP_LIMIT_ARRAY_PARAMS_SIZE)), 'Optional labels, including null values.', true)
+    ->inject('response')
+    ->action(function (array $documents, ?array $labels, UtopiaSwooleResponse $response) {
         if ($documents === []) {
             throw new Exception(Exception::GENERAL_MOCK, 'Documents must not be empty');
         }
@@ -665,6 +667,10 @@
                 throw new Exception(Exception::GENERAL_MOCK, 'Each document must be an object with an $id');
             }
         }
+
+        $response->json([
+            'result' => \json_encode(['documents' => $documents, 'labels' => $labels]),
+        ]);
     });
 
 App::get('/v1/mock/tests/union')

templates/deno/src/client.ts.twig

@@ -156,6 +156,17 @@ export class Client {
         return json;
     }
 
+    static validateStringList(name: string, value: unknown, nullableItems: boolean = false): void {
+        // Missing values are left to the generated required-parameter checks.
+        if (value === null || typeof value === 'undefined') {
+            return;
+        }
+
+        if (!Array.isArray(value) || value.some((item) => typeof item !== 'string' && !(nullableItems && item === null))) {
+            throw new {{spec.info.title | caseUcfirst}}Exception(`Invalid parameter: "${name}" must be a list of strings.`, 0, 'sdk_input_validation');
+        }
+    }
+
     static flatten(data: Payload, prefix = ''): Payload {
         let output: Payload = {};
 

templates/deno/src/services/service.ts.twig

@@ -87,6 +87,12 @@ export class {{ service.name | caseUcfirst }} extends Service {
             throw new {{spec.info.title | caseUcfirst}}Exception('Missing required parameter: "{{ parameter.name | caseCamel | escapeKeyword }}"');
         }
 
+{% endif %}
+{% endfor %}
+{% for parameter in (method | parameters('all')) %}
+{% if (parameter | schemaType) == 'array' and ((parameter | arraySchema) | schemaType) == 'string' %}
+        Client.validateStringList('{{ parameter.name | caseCamel | escapeKeyword }}', {{ parameter.name | caseCamel | escapeKeyword }}{% if (parameter | arraySchema) | schemaNullable %}, true{% endif %});
+
 {% endif %}
 {% endfor %}
         let apiPath = '{{ method.path }}'{% for parameter in (method | parameters('path')) %}.replace('{{ '{' }}{{ parameter.name }}{{ '}' }}', {% if (parameter.extensions['x-sdk-source']|default('')) == 'security' %}this.client.config['{{ parameter.extensions['x-sdk-config'] | caseLower }}']{% else %}{{ parameter.name | caseCamel | escapeKeyword }}{% endif %}){% endfor %};

templates/node/src/client.ts.twig

@@ -696,6 +696,32 @@ class Client {
         return data;
     }
 
+    static validateStringList(
+        name: string,
+        value: unknown,
+        nullableItems = false,
+    ): void {
+        // Missing values are left to the generated required-parameter checks.
+        if (value === null || typeof value === 'undefined') {
+            return;
+        }
+
+        if (
+            !Array.isArray(value) ||
+            value.some(
+                (item) =>
+                    typeof item !== 'string' &&
+                    !(nullableItems && item === null),
+            )
+        ) {
+            throw new {{spec.info.title | caseUcfirst}}Exception(
+                `Invalid parameter: "${name}" must be a list of strings.`,
+                0,
+                'sdk_input_validation',
+            );
+        }
+    }
+
     static flatten(data: Payload, prefix = ''): Payload {
         let output: Payload = {};
 

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

@@ -138,6 +138,15 @@ export class {{ service.name | caseUcfirst }} {
         }
         {%~ endif %}
         {%~ endfor %}
+        {%~ for parameter in (method | parameters('all')) %}
+        {%~ if (parameter | schemaType) == 'array' and ((parameter | arraySchema) | schemaType) == 'string' %}
+        {%~ set validationArgs = ["'" ~ (parameter.name | caseCamel | escapeKeyword) ~ "'", (parameter.name | caseCamel | escapeKeyword)] %}
+        {%~ if (parameter | arraySchema) | schemaNullable %}
+        {%~ set validationArgs = validationArgs | merge(['true']) %}
+        {%~ endif %}
+        {{ 'Client.validateStringList' | jsArgs(validationArgs, 8) | raw }}
+        {%~ endif %}
+        {%~ endfor %}
 {% set pathReplacements = [] %}{% for parameter in (method | parameters('path')) %}{% set pathReplacements = pathReplacements|merge([['{' ~ parameter.name ~ '}', 'encodeURIComponent(String(' ~ (((parameter.extensions['x-sdk-source']|default('')) == 'security') ? ('this.client.config.' ~ (parameter.extensions['x-sdk-config'] | caseLower)) : (parameter.name | caseCamel | escapeKeyword)) ~ '))']]) %}{% endfor %}
         {{ method.path | tsApiPath(pathReplacements, 8) | raw }}
         const apiPayload: Payload = {};

templates/php/base/params.twig

@@ -1,3 +1,9 @@
+{% for parameter in (method | parameters('all')) %}
+{% if (parameter | schemaType) == 'array' and ((parameter | arraySchema) | schemaType) == 'string' %}
+        $this->validateStringList('{{ parameter.name | caseCamel }}', ${{ parameter.name | caseCamel | escapeKeyword }}{% if (parameter | arraySchema) | schemaNullable %}, nullableItems: true{% endif %});
+
+{% endif %}
+{% endfor %}
         $apiParams = [];
 {% if (method | parameters('all')) | length %}
 {% for parameter in (method | parameters('all')) %}

templates/php/src/Client.php.twig

@@ -295,7 +295,7 @@ class Client
                 $method === self::METHOD_GET => $this->requestFactory->query(
                     $method,
                     $uri,
-                    $params,
+                    $this->prepareParams($params),
                     $headers
                 ),
                 $contentType === 'application/json' => $this->requestFactory->json(
@@ -374,7 +374,8 @@ class Client
     }
 
     /**
-     * Prepare params for JSON encoding by converting model objects to arrays
+     * Prepare params for encoding by converting model objects to arrays and
+     * enum objects to their values
      *
      */
     protected function prepareParams($data)
@@ -387,6 +388,10 @@ class Client
             return $data->toArray();
         }
 
+        if ($data instanceof \JsonSerializable) {
+            return $data->jsonSerialize();
+        }
+
         return $data;
     }
 

templates/php/src/Service.php.twig

@@ -9,4 +9,22 @@ abstract class Service
     public function __construct(protected Client $client)
     {
     }
+
+    protected function validateStringList(string $name, ?array $value, bool $nullableItems = false): void
+    {
+        if ($value === null) {
+            return;
+        }
+
+        // Enum objects serialize to their string value.
+        $valid = array_is_list($value) && array_all(
+            $value,
+            fn (mixed $item): bool => ($nullableItems && $item === null)
+                || is_string($item instanceof \JsonSerializable ? $item->jsonSerialize() : $item)
+        );
+
+        if (!$valid) {
+            throw new {{ namespace | split('\\') | last | caseUcfirst }}Exception('Invalid parameter: "' . $name . '" must be a list of strings.', 0, 'sdk_input_validation');
+        }
+    }
 }

templates/python/base/params.twig

@@ -11,6 +11,13 @@
 {% endif -%}
 {% endif -%}
 {% endfor -%}
+{% for parameter in (method | parameters('all')) -%}
+{% if (parameter | schemaType) == 'array' and ((parameter | arraySchema) | schemaType) == 'string' %}
+{% set paramName = parameter.name | escapeKeyword | caseSnake -%}
+{% set validation %}        self._validate_string_list('{{ paramName }}', {{ paramName }}{% if (parameter | arraySchema) | schemaNullable %}, nullable_items=True{% endif %}){% endset %}
+{{ validation | formatCall | raw }}
+{% endif -%}
+{% endfor -%}
 {% for parameter in (method | parameters('path')) %}
         api_path = api_path.replace('{{ '{' }}{{ parameter.name }}{{ '}' }}', str(self._normalize_value({% if (parameter.extensions['x-sdk-source']|default('')) == 'security' %}self.client.get_config('{{ parameter.extensions['x-sdk-config'] | caseLower }}'){% else %}{{ parameter.name | escapeKeyword | caseSnake }}{% endif %})))
 {% endfor -%}

templates/python/package/client.py.twig

@@ -281,8 +281,10 @@ class Client:
 
         for key in data:
             value = data[key] if isinstance(data, dict) else key
-            finalKey = prefix + '[' + key + ']' if prefix else key
-            finalKey = prefix + '[' + str(i) + ']' if isinstance(data, list) else finalKey
+            if isinstance(data, list):
+                finalKey = prefix + '[' + str(i) + ']'
+            else:
+                finalKey = prefix + '[' + key + ']' if prefix else key
             i += 1
 
             if isinstance(value, list) or isinstance(value, dict):

templates/python/package/service.py.twig

@@ -29,6 +29,20 @@ class Service:
 
         return value
 
+    def _validate_string_list(self, name: str, value: Any, nullable_items: bool = False) -> None:
+        """Validate item types; generated required checks handle missing lists."""
+        if value is None:
+            return
+
+        if not isinstance(value, list) or any(
+            not isinstance(self._normalize_value(item), str) and not (nullable_items and item is None) for item in value
+        ):
+            expected = 'strings or None' if nullable_items else 'strings'
+            raise AppwriteException(
+                f'Invalid parameter: "{name}" must be a list of {expected}.',
+                type='sdk_input_validation',
+            )
+
     def _parse_response(self, response: Any, model: Optional[Type[ModelType]] = None) -> Any:
         if model is None:
             return response

templates/react-native/src/client.ts.twig

@@ -785,6 +785,32 @@ class Client {
             throw new {{spec.info.title | caseUcfirst}}Exception((<Error>e).message);
         }
     }
+
+    static validateStringList(
+        name: string,
+        value: unknown,
+        nullableItems = false,
+    ): void {
+        // Missing values are left to the generated required-parameter checks.
+        if (value === null || typeof value === 'undefined') {
+            return;
+        }
+
+        if (
+            !Array.isArray(value) ||
+            value.some(
+                (item) =>
+                    typeof item !== 'string' &&
+                    !(nullableItems && item === null),
+            )
+        ) {
+            throw new {{spec.info.title | caseUcfirst}}Exception(
+                `Invalid parameter: "${name}" must be a list of strings.`,
+                0,
+                'sdk_input_validation',
+            );
+        }
+    }
 }
 
 export { Client, {{spec.info.title | caseUcfirst}}Exception };

templates/react-native/src/services/template.ts.twig

@@ -142,6 +142,16 @@ export class {{ service.name | caseUcfirst }} extends Service {
             {{ ('throw new ' ~ (spec.info.title | caseUcfirst) ~ 'Exception') | tsCall('\'Missing required parameter: "' ~ (parameter.name | caseCamel | escapeKeyword) ~ '"\'', ';', 12) | raw }}
         }
 
+{% endif %}
+{% endfor %}
+{% for parameter in (method | parameters('all')) %}
+{% if (parameter | schemaType) == 'array' and ((parameter | arraySchema) | schemaType) == 'string' %}
+{% set validationArgs = ["'" ~ (parameter.name | caseCamel | escapeKeyword) ~ "'", (parameter.name | caseCamel | escapeKeyword)] %}
+{% if (parameter | arraySchema) | schemaNullable %}
+{% set validationArgs = validationArgs | merge(['true']) %}
+{% endif %}
+        {{ 'Client.validateStringList' | jsArgs(validationArgs, 8) | raw }}
+
 {% endif %}
 {% endfor %}
 {% set pathReplacements = [] %}{% for parameter in (method | parameters('path')) %}{% set pathReplacements = pathReplacements|merge([['{' ~ parameter.name ~ '}', 'encodeURIComponent(String(' ~ (((parameter.extensions['x-sdk-source']|default('')) == 'security') ? ('this.client.config.' ~ (parameter.extensions['x-sdk-config'] | caseLower)) : (parameter.name | caseCamel | escapeKeyword)) ~ '))']]) %}{% endfor %}
@@ -462,6 +472,16 @@ export class {{ service.name | caseUcfirst }} extends Service {
             {{ ('throw new ' ~ (spec.info.title | caseUcfirst) ~ 'Exception') | tsCall('\'Missing required parameter: "' ~ (parameter.name | caseCamel | escapeKeyword) ~ '"\'', ';', 12) | raw }}
         }
 
+{% endif %}
+{% endfor %}
+{% for parameter in (method | parameters('all')) %}
+{% if (parameter | schemaType) == 'array' and ((parameter | arraySchema) | schemaType) == 'string' %}
+{% set validationArgs = ["'" ~ (parameter.name | caseCamel | escapeKeyword) ~ "'", (parameter.name | caseCamel | escapeKeyword)] %}
+{% if (parameter | arraySchema) | schemaNullable %}
+{% set validationArgs = validationArgs | merge(['true']) %}
+{% endif %}
+        {{ 'Client.validateStringList' | jsArgs(validationArgs, 8) | raw }}
+
 {% endif %}
 {% endfor %}
 {% set pathReplacements = [] %}{% for parameter in (method | parameters('path')) %}{% set pathReplacements = pathReplacements|merge([['{' ~ parameter.name ~ '}', 'encodeURIComponent(String(' ~ (((parameter.extensions['x-sdk-source']|default('')) == 'security') ? ('this.client.config.' ~ (parameter.extensions['x-sdk-config'] | caseLower)) : (parameter.name | caseCamel | escapeKeyword)) ~ '))']]) %}{% endfor %}

templates/ruby/base/params.twig

@@ -7,6 +7,12 @@
                 raise {{spec.info.title | caseUcfirst}}::Exception.new('Missing required parameter: "{{ parameter.name | caseCamel | escapeKeyword }}"')
             end
 
+{% endif %}
+{% endfor %}
+{% for parameter in (method | parameters('all')) %}
+{% if (parameter | schemaType) == 'array' and ((parameter | arraySchema) | schemaType) == 'string' %}
+            validate_string_list('{{ parameter.name | caseCamel | escapeKeyword }}', {{ parameter.name | caseSnake | escapeKeyword }}{% if (parameter | arraySchema) | schemaNullable %}, nullable_items: true{% endif %})
+
 {% endif %}
 {% endfor %}
             api_path = '{{ method.path }}'

templates/ruby/lib/container/service.rb.twig

@@ -3,5 +3,14 @@ module {{spec.info.title | caseUcfirst }}
         def initialize(client)
             @client = client
         end
+
+        private
+
+        def validate_string_list(name, value, nullable_items: false)
+            return if value.nil?
+            return if value.is_a?(Array) && value.all? { |item| item.is_a?(String) || (nullable_items && item.nil?) }
+
+            raise {{spec.info.title | caseUcfirst}}::Exception.new("Invalid parameter: \"#{name}\" must be a list of strings.", 0, 'sdk_input_validation')
+        end
     end
 end

templates/rust/tests/tests.rs

@@ -1,5 +1,6 @@
 use appwrite::{
     Client,
+    enums::MockType,
     id::ID,
     input_file::InputFile,
     operator::{self, Condition},
@@ -112,6 +113,19 @@ async fn test_general_service(client: &Client, string_in_array: &[String]) -> Re
         Err(e) => eprintln!("general.redirected => error {}", e),
     }
 
+    let queries = vec!["not JSON".to_string(), MockType::First.to_string()];
+    match general.list_rows(Some(queries)).await {
+        Ok(response) => println!("{}", response.result),
+        Err(e) => eprintln!("general.list_rows => error {}", e),
+    }
+
+    let documents = vec![json!({"$id": "first"})];
+    let labels = vec!["ready".to_string()];
+    match general.create_documents(documents, Some(labels)).await {
+        Ok(response) => println!("{}", response.result),
+        Err(e) => eprintln!("general.create_documents => error {}", e),
+    }
+
     for (id, plain) in [("", "0"), ("0", "")] {
         let error = general.validate_path(plain, Some(id)).await.unwrap_err();
         assert_eq!(error.code, 0);

templates/web/src/client.ts.twig

@@ -1265,6 +1265,32 @@ class Client {
         return data;
     }
 
+    static validateStringList(
+        name: string,
+        value: unknown,
+        nullableItems = false,
+    ): void {
+        // Missing values are left to the generated required-parameter checks.
+        if (value === null || typeof value === 'undefined') {
+            return;
+        }
+
+        if (
+            !Array.isArray(value) ||
+            value.some(
+                (item) =>
+                    typeof item !== 'string' &&
+                    !(nullableItems && item === null),
+            )
+        ) {
+            throw new {{spec.info.title | caseUcfirst}}Exception(
+                `Invalid parameter: "${name}" must be a list of strings.`,
+                0,
+                'sdk_input_validation',
+            );
+        }
+    }
+
     static flatten(data: Payload, prefix = ''): Payload {
         let output: Payload = {};
 

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

@@ -141,6 +141,15 @@ export class {{ service.name | caseUcfirst }} {
         }
         {%~ endif %}
         {%~ endfor %}
+        {%~ for parameter in (method | parameters('all')) %}
+        {%~ if (parameter | schemaType) == 'array' and ((parameter | arraySchema) | schemaType) == 'string' %}
+        {%~ set validationArgs = ["'" ~ (parameter.name | caseCamel | escapeKeyword) ~ "'", (parameter.name | caseCamel | escapeKeyword)] %}
+        {%~ if (parameter | arraySchema) | schemaNullable %}
+        {%~ set validationArgs = validationArgs | merge(['true']) %}
+        {%~ endif %}
+        {{ 'Client.validateStringList' | jsArgs(validationArgs, 8) | raw }}
+        {%~ endif %}
+        {%~ endfor %}
 {% set pathReplacements = [] %}{% for parameter in (method | parameters('path')) %}{% set pathReplacements = pathReplacements|merge([['{' ~ parameter.name ~ '}', 'encodeURIComponent(String(' ~ (((parameter.extensions['x-sdk-source']|default('')) == 'security') ? ('this.client.config.' ~ (parameter.extensions['x-sdk-config'] | caseLower)) : (parameter.name | caseCamel | escapeKeyword)) ~ '))']]) %}{% endfor %}
         {{ method.path | tsApiPath(pathReplacements, 8) | raw }}
         const payload: Payload = {};