Merge pull request #947 from appwrite/fix-sync-node-and-web

fix: sync node and web

Author: christyjacob4

src/SDK/Language/Web.php

@@ -252,9 +252,11 @@ public function getGenerics(string $model, array $spec, bool $skipFirst = false)
     public function getReturn(array $method, array $spec): string
     {
         if ($method['type'] === 'webAuth') {
-            return 'void | URL';
-        } elseif ($method['type'] === 'location') {
-            return 'URL';
+            return 'Promise<void | string>';
+        }
+
+        if ($method['type'] === 'location') {
+            return 'string';
         }
 
         if (array_key_exists('responseModel', $method) && !empty($method['responseModel']) && $method['responseModel'] !== 'any') {

templates/web/src/client.ts.twig

@@ -1,5 +1,4 @@
 import { Models } from './models';
-import { Service } from './service';
 
 /**
  * Payload type representing a key-value pair with string keys and any values.
@@ -48,7 +47,7 @@ type RealtimeRequest = {
 /**
  * Realtime event response structure with generic payload type.
  */
-export type RealtimeResponseEvent<T extends unknown> = {
+type RealtimeResponseEvent<T extends unknown> = {
     /**
      * List of event names associated with the response.
      */
@@ -215,7 +214,7 @@ type Realtime = {
 /**
  * Type representing upload progress information.
  */
-export type UploadProgress = {
+type UploadProgress = {
     /**
      * Identifier for the upload progress.
      */
@@ -284,17 +283,18 @@ class {{spec.title | caseUcfirst}}Exception extends Error {
  * Client that handles requests to {{spec.title | caseUcfirst}}
  */
 class Client {
+    static CHUNK_SIZE = 1024 * 1024 * 5;
+
     /**
      * Holds configuration such as project.
      */
     config = {
         endpoint: '{{ spec.endpoint }}',
         endpointRealtime: '',
-{% for header in spec.global.headers %}
+        {%~ for header in spec.global.headers %}
         {{ header.key | caseLower }}: '',
-{% endfor %}
+        {%~ endfor %}
     };
-
     /**
      * Custom headers for API requests.
      */
@@ -303,9 +303,9 @@ class Client {
         'x-sdk-platform': '{{ sdk.platform }}',
         'x-sdk-language': '{{ language.name | caseLower }}',
         'x-sdk-version': '{{ sdk.version }}',
-{% for key,header in spec.global.defaultHeaders %}
+        {%~ for key,header in spec.global.defaultHeaders %}
         '{{key}}': '{{header}}',
-{% endfor %}
+        {%~ endfor %}
     };
 
     /**
@@ -337,14 +337,14 @@ class Client {
         return this;
     }
 
-{% for header in spec.global.headers %}
+    {%~ for header in spec.global.headers %}
     /**
      * Set {{header.key | caseUcfirst}}
      *
-{% if header.description %}
-{{header.description|comment2}}
+    {%~ if header.description %}
+     * {{header.description}}
      *
-{% endif %}
+    {%~ endif %}
      * @param value string
      *
      * @return {this}
@@ -354,8 +354,7 @@ class Client {
         this.config.{{ header.key | caseLower }} = value;
         return this;
     }
-
-{% endfor %}
+    {%~ endfor %}
 
     private realtime: Realtime = {
         socket: undefined,
@@ -540,40 +539,18 @@ class Client {
         }
     }
 
-    /**
-     * Call API endpoint with the specified method, URL, headers, and parameters.
-     *
-     * @param {string} method - HTTP method (e.g., 'GET', 'POST', 'PUT', 'DELETE').
-     * @param {URL} url - The URL of the API endpoint.
-     * @param {Headers} headers - Custom headers for the API request.
-     * @param {Payload} params - Request parameters.
-     * @returns {Promise<any>} - A promise that resolves with the response data.
-     * 
-     * @typedef {Object} Payload - Request payload data.
-     * @property {string} key - The key.
-     * @property {string} value - The value.
-     */
-    async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}): Promise<any> {
+    prepareRequest(method: string, url: URL, headers: Headers = {}, params: Payload = {}): { uri: string, options: RequestInit } {
         method = method.toUpperCase();
 
-
         headers = Object.assign({}, this.headers, headers);
 
         let options: RequestInit = {
             method,
             headers,
-            credentials: 'include'
         };
 
-        if (typeof window !== 'undefined' && window.localStorage) {
-            const cookieFallback = window.localStorage.getItem('cookieFallback');
-            if (cookieFallback) {
-                headers['X-Fallback-Cookies'] = cookieFallback;
-            }
-        }
-
         if (method === 'GET') {
-            for (const [key, value] of Object.entries(Service.flatten(params))) {
+            for (const [key, value] of Object.entries(Client.flatten(params))) {
                 url.searchParams.append(key, value);
             }
         } else {
@@ -583,15 +560,17 @@ class Client {
                     break;
 
                 case 'multipart/form-data':
-                    let formData = new FormData();
-
-                    for (const key in params) {
-                        if (Array.isArray(params[key])) {
-                            params[key].forEach((value: any) => {
-                                formData.append(key + '[]', value);
-                            })
+                    const formData = new FormData();
+
+                    for (const [key, value] of Object.entries(params)) {
+                        if (value instanceof File) {
+                            formData.append(key, value, value.name);
+                        } else if (Array.isArray(value)) {
+                            for (const nestedValue of value) {
+                                formData.append(`${key}[]`, nestedValue);
+                            }
                         } else {
-                            formData.append(key, params[key]);
+                            formData.append(key, value);
                         }
                     }
 
@@ -601,45 +580,121 @@ class Client {
             }
         }
 
-        try {
-            let data = null;
-            const response = await fetch(url.toString(), options);
+        return { uri: url.toString(), options };
+    }
+
+    async chunkedUpload(method: string, url: URL, headers: Headers = {}, originalPayload: Payload = {}, onProgress: (progress: UploadProgress) => void) {
+        const file = Object.values(originalPayload).find((value) => value instanceof File);
+
+        if (file.size <= Client.CHUNK_SIZE) {
+            return await this.call(method, url, headers, originalPayload);
+        }
+
+        let start = 0;
+        let response = null;
 
-            const warnings = response.headers.get('x-{{ spec.title | lower }}-warning');
-            if (warnings) {
-                warnings.split(';').forEach((warning: string) => console.warn('Warning: ' + warning));
+        while (start < file.size) {
+            let end = start + Client.CHUNK_SIZE; // Prepare end for the next chunk
+            if (end >= file.size) {
+                end = file.size; // Adjust for the last chunk to include the last byte
             }
 
-            if (response.headers.get('content-type')?.includes('application/json')) {
-                data = await response.json();
-            } else {
-                data = {
-                    message: await response.text()
-                };
+            headers['content-range'] = `bytes ${start}-${end-1}/${file.size}`;
+            const chunk = file.slice(start, end);
+
+            let payload = { ...originalPayload, file: new File([chunk], file.name)};
+
+            response = await this.call(method, url, headers, payload);
+
+            if (onProgress && typeof onProgress === 'function') {
+                onProgress({
+                    $id: response.$id,
+                    progress: Math.round((end / file.size) * 100),
+                    sizeUploaded: end,
+                    chunksTotal: Math.ceil(file.size / Client.CHUNK_SIZE),
+                    chunksUploaded: Math.ceil(end / Client.CHUNK_SIZE)
+                });
             }
 
-            if (400 <= response.status) {
-                throw new {{spec.title | caseUcfirst}}Exception(data?.message, response.status, data?.type, data);
+            if (response && response.$id) {
+                headers['x-{{spec.title | caseLower }}-id'] = response.$id;
             }
 
-            const cookieFallback = response.headers.get('X-Fallback-Cookies');
+            start = end;
+        }
 
-            if (typeof window !== 'undefined' && window.localStorage && cookieFallback) {
-                window.console.warn('{{spec.title | caseUcfirst}} is using localStorage for session management. Increase your security by adding a custom domain as your API endpoint.');
-                window.localStorage.setItem('cookieFallback', cookieFallback);
-            }
+        return response;
+    }
+
+    async redirect(method: string, url: URL, headers: Headers = {}, params: Payload = {}): Promise<string> {
+        const { uri, options } = this.prepareRequest(method, url, headers, params);
+        
+        const response = await fetch(uri, {
+            ...options,
+            redirect: 'manual'
+        });
+
+        if (response.status !== 301 && response.status !== 302) {
+            throw new {{spec.title | caseUcfirst}}Exception('Invalid redirect', response.status);
+        }
+
+        return response.headers.get('location') || '';
+    }
 
-            return data;
-        } catch (e) {
-            if (e instanceof {{spec.title | caseUcfirst}}Exception) {
-                throw e;
+    async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}, responseType = 'json'): Promise<any> {
+        const { uri, options } = this.prepareRequest(method, url, headers, params);
+
+        let data: any = null;
+
+        const response = await fetch(uri, options);
+
+        const warnings = response.headers.get('x-{{ spec.title | lower }}-warning');
+        if (warnings) {
+            warnings.split(';').forEach((warning: string) => console.warn('Warning: ' + warning));
+        }
+
+        if (response.headers.get('content-type')?.includes('application/json')) {
+            data = await response.json();
+        } else if (responseType === 'arrayBuffer') {
+            data = await response.arrayBuffer();
+        } else {
+            data = {
+                message: await response.text()
+            };
+        }
+
+        if (400 <= response.status) {
+            throw new {{spec.title | caseUcfirst}}Exception(data?.message, response.status, data?.type, data);
+        }
+
+        const cookieFallback = response.headers.get('X-Fallback-Cookies');
+
+        if (typeof window !== 'undefined' && window.localStorage && cookieFallback) {
+            window.console.warn('{{spec.title | caseUcfirst}} is using localStorage for session management. Increase your security by adding a custom domain as your API endpoint.');
+            window.localStorage.setItem('cookieFallback', cookieFallback);
+        }
+
+        return data;
+    }
+
+    static flatten(data: Payload, prefix = ''): Payload {
+        let output: Payload = {};
+
+        for (const [key, value] of Object.entries(data)) {
+            let finalKey = prefix ? prefix + '[' + key +']' : key;
+            if (Array.isArray(value)) {
+                output = { ...output, ...Client.flatten(value, finalKey) };
+            } else {
+                output[finalKey] = value;
             }
-            throw new {{spec.title | caseUcfirst}}Exception((<Error>e).message);
         }
+
+        return output;
     }
 }
 
 export { Client, {{spec.title | caseUcfirst}}Exception };
 export { Query } from './query';
-export type { Models, Payload };
+export type { Models, Payload, UploadProgress };
+export type { RealtimeResponseEvent };
 export type { QueryTypes, QueryTypesList } from './query';