react-native-appwrite 0.9.2 → 0.10.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "react-native-appwrite",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/src/client.ts

@@ -115,7 +115,7 @@ class Client {
         'x-sdk-name': 'React Native',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'reactnative',
-        'x-sdk-version': '0.9.2',
+        'x-sdk-version': '0.10.0',
         'X-Appwrite-Response-Format': '1.7.0',
     };
 
@@ -432,7 +432,7 @@ class Client {
         }
     }
 
-    async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}): Promise<any> {
+    async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}, responseType = 'json'): Promise<any> {
         method = method.toUpperCase();
 
         headers = Object.assign({}, this.headers, headers);
@@ -488,6 +488,8 @@ class Client {
 
             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()

package/src/services/avatars.ts

@@ -33,9 +33,9 @@ export class Avatars extends Service {
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getBrowser(code: Browser, width?: number, height?: number, quality?: number): URL {
+    getBrowser(code: Browser, width?: number, height?: number, quality?: number): Promise<ArrayBuffer> {
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
@@ -62,7 +62,8 @@ export class Avatars extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-        return uri;
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
     }
 
     /**
@@ -81,9 +82,9 @@ export class Avatars extends Service {
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): URL {
+    getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): Promise<ArrayBuffer> {
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
@@ -110,7 +111,8 @@ export class Avatars extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-        return uri;
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
     }
 
     /**
@@ -121,9 +123,9 @@ export class Avatars extends Service {
      *
      * @param {string} url
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getFavicon(url: string): URL {
+    getFavicon(url: string): Promise<ArrayBuffer> {
         if (typeof url === 'undefined') {
             throw new AppwriteException('Missing required parameter: "url"');
         }
@@ -142,7 +144,8 @@ export class Avatars extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-        return uri;
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
     }
 
     /**
@@ -162,9 +165,9 @@ export class Avatars extends Service {
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getFlag(code: Flag, width?: number, height?: number, quality?: number): URL {
+    getFlag(code: Flag, width?: number, height?: number, quality?: number): Promise<ArrayBuffer> {
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
@@ -191,7 +194,8 @@ export class Avatars extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-        return uri;
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
     }
 
     /**
@@ -211,9 +215,9 @@ export class Avatars extends Service {
      * @param {number} width
      * @param {number} height
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getImage(url: string, width?: number, height?: number): URL {
+    getImage(url: string, width?: number, height?: number): Promise<ArrayBuffer> {
         if (typeof url === 'undefined') {
             throw new AppwriteException('Missing required parameter: "url"');
         }
@@ -240,7 +244,8 @@ export class Avatars extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-        return uri;
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
     }
 
     /**
@@ -266,9 +271,9 @@ export class Avatars extends Service {
      * @param {number} height
      * @param {string} background
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getInitials(name?: string, width?: number, height?: number, background?: string): URL {
+    getInitials(name?: string, width?: number, height?: number, background?: string): Promise<ArrayBuffer> {
         const apiPath = '/avatars/initials';
         const payload: Payload = {};
 
@@ -295,7 +300,8 @@ export class Avatars extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-        return uri;
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
     }
 
     /**
@@ -308,9 +314,9 @@ export class Avatars extends Service {
      * @param {number} margin
      * @param {boolean} download
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getQR(text: string, size?: number, margin?: number, download?: boolean): URL {
+    getQR(text: string, size?: number, margin?: number, download?: boolean): Promise<ArrayBuffer> {
         if (typeof text === 'undefined') {
             throw new AppwriteException('Missing required parameter: "text"');
         }
@@ -341,6 +347,276 @@ export class Avatars extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
+    }
+
+    /**
+     * You can use this endpoint to show different browser icons to your users.
+     * The code argument receives the browser code as it appears in your user [GET
+     * /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions)
+     * endpoint. Use width, height and quality arguments to change the output
+     * settings.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     *
+     * @param {Browser} code
+     * @param {number} width
+     * @param {number} height
+     * @param {number} quality
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getBrowserURL(code: Browser, width?: number, height?: number, quality?: number): URL {
+        const apiPath = '/avatars/browsers/{code}'.replace('{code}', code);
+        const payload: Payload = {};
+
+        if (typeof width !== 'undefined') {
+            payload['width'] = width;
+        }
+
+        if (typeof height !== 'undefined') {
+            payload['height'] = height;
+        }
+
+        if (typeof quality !== 'undefined') {
+            payload['quality'] = quality;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        return uri;
+    }
+
+    /**
+     * The credit card endpoint will return you the icon of the credit card
+     * provider you need. Use width, height and quality arguments to change the
+     * output settings.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     * 
+     *
+     * @param {CreditCard} code
+     * @param {number} width
+     * @param {number} height
+     * @param {number} quality
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getCreditCardURL(code: CreditCard, width?: number, height?: number, quality?: number): URL {
+        const apiPath = '/avatars/credit-cards/{code}'.replace('{code}', code);
+        const payload: Payload = {};
+
+        if (typeof width !== 'undefined') {
+            payload['width'] = width;
+        }
+
+        if (typeof height !== 'undefined') {
+            payload['height'] = height;
+        }
+
+        if (typeof quality !== 'undefined') {
+            payload['quality'] = quality;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        return uri;
+    }
+
+    /**
+     * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
+     * website URL.
+     * 
+     * This endpoint does not follow HTTP redirects.
+     *
+     * @param {string} url
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFaviconURL(url: string): URL {
+        const apiPath = '/avatars/favicon';
+        const payload: Payload = {};
+
+        if (typeof url !== 'undefined') {
+            payload['url'] = url;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        return uri;
+    }
+
+    /**
+     * You can use this endpoint to show different country flags icons to your
+     * users. The code argument receives the 2 letter country code. Use width,
+     * height and quality arguments to change the output settings. Country codes
+     * follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     * 
+     *
+     * @param {Flag} code
+     * @param {number} width
+     * @param {number} height
+     * @param {number} quality
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFlagURL(code: Flag, width?: number, height?: number, quality?: number): URL {
+        const apiPath = '/avatars/flags/{code}'.replace('{code}', code);
+        const payload: Payload = {};
+
+        if (typeof width !== 'undefined') {
+            payload['width'] = width;
+        }
+
+        if (typeof height !== 'undefined') {
+            payload['height'] = height;
+        }
+
+        if (typeof quality !== 'undefined') {
+            payload['quality'] = quality;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        return uri;
+    }
+
+    /**
+     * Use this endpoint to fetch a remote image URL and crop it to any image size
+     * you want. This endpoint is very useful if you need to crop and display
+     * remote images in your app or in case you want to make sure a 3rd party
+     * image is properly served using a TLS protocol.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 400x400px.
+     * 
+     * This endpoint does not follow HTTP redirects.
+     *
+     * @param {string} url
+     * @param {number} width
+     * @param {number} height
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getImageURL(url: string, width?: number, height?: number): URL {
+        const apiPath = '/avatars/image';
+        const payload: Payload = {};
+
+        if (typeof url !== 'undefined') {
+            payload['url'] = url;
+        }
+
+        if (typeof width !== 'undefined') {
+            payload['width'] = width;
+        }
+
+        if (typeof height !== 'undefined') {
+            payload['height'] = height;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        return uri;
+    }
+
+    /**
+     * Use this endpoint to show your user initials avatar icon on your website or
+     * app. By default, this route will try to print your logged-in user name or
+     * email initials. You can also overwrite the user name if you pass the 'name'
+     * parameter. If no name is given and no user is logged, an empty avatar will
+     * be returned.
+     * 
+     * You can use the color and background params to change the avatar colors. By
+     * default, a random theme will be selected. The random theme will persist for
+     * the user's initials when reloading the same theme will always return for
+     * the same initials.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     * 
+     *
+     * @param {string} name
+     * @param {number} width
+     * @param {number} height
+     * @param {string} background
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getInitialsURL(name?: string, width?: number, height?: number, background?: string): URL {
+        const apiPath = '/avatars/initials';
+        const payload: Payload = {};
+
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
+        if (typeof width !== 'undefined') {
+            payload['width'] = width;
+        }
+
+        if (typeof height !== 'undefined') {
+            payload['height'] = height;
+        }
+
+        if (typeof background !== 'undefined') {
+            payload['background'] = background;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        return uri;
+    }
+
+    /**
+     * Converts a given plain text to a QR code image. You can use the query
+     * parameters to change the size and style of the resulting image.
+     * 
+     *
+     * @param {string} text
+     * @param {number} size
+     * @param {number} margin
+     * @param {boolean} download
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getQRURL(text: string, size?: number, margin?: number, download?: boolean): URL {
+        const apiPath = '/avatars/qr';
+        const payload: Payload = {};
+
+        if (typeof text !== 'undefined') {
+            payload['text'] = text;
+        }
+
+        if (typeof size !== 'undefined') {
+            payload['size'] = size;
+        }
+
+        if (typeof margin !== 'undefined') {
+            payload['margin'] = margin;
+        }
+
+        if (typeof download !== 'undefined') {
+            payload['download'] = download;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
         return uri;
     }
 };

package/src/services/storage.ts

@@ -260,9 +260,9 @@ export class Storage extends Service {
      * @param {string} fileId
      * @param {string} token
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getFileDownload(bucketId: string, fileId: string, token?: string): URL {
+    getFileDownload(bucketId: string, fileId: string, token?: string): Promise<ArrayBuffer> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -285,7 +285,8 @@ export class Storage extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-        return uri;
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
     }
 
     /**
@@ -310,9 +311,9 @@ export class Storage extends Service {
      * @param {ImageFormat} output
      * @param {string} token
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): URL {
+    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): Promise<ArrayBuffer> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -379,7 +380,8 @@ export class Storage extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-        return uri;
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
     }
 
     /**
@@ -391,9 +393,9 @@ export class Storage extends Service {
      * @param {string} fileId
      * @param {string} token
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
-    getFileView(bucketId: string, fileId: string, token?: string): URL {
+    getFileView(bucketId: string, fileId: string, token?: string): Promise<ArrayBuffer> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -416,6 +418,136 @@ export class Storage extends Service {
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
+        return this.client.call('get', uri, {
+        }, payload, 'arrayBuffer');
+    }
+
+    /**
+     * Get a file content by its unique ID. The endpoint response return with a
+     * 'Content-Disposition: attachment' header that tells the browser to start
+     * downloading the file to user downloads directory.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {string} token
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFileDownloadURL(bucketId: string, fileId: string, token?: string): URL {
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const payload: Payload = {};
+
+        if (typeof token !== 'undefined') {
+            payload['token'] = token;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        return uri;
+    }
+
+    /**
+     * Get a file preview image. Currently, this method supports preview for image
+     * files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
+     * and spreadsheets, will return the file icon image. You can also pass query
+     * string arguments for cutting and resizing your preview image. Preview is
+     * supported only for image files smaller than 10MB.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {number} width
+     * @param {number} height
+     * @param {ImageGravity} gravity
+     * @param {number} quality
+     * @param {number} borderWidth
+     * @param {string} borderColor
+     * @param {number} borderRadius
+     * @param {number} opacity
+     * @param {number} rotation
+     * @param {string} background
+     * @param {ImageFormat} output
+     * @param {string} token
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFilePreviewURL(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): URL {
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const payload: Payload = {};
+
+        if (typeof width !== 'undefined') {
+            payload['width'] = width;
+        }
+
+        if (typeof height !== 'undefined') {
+            payload['height'] = height;
+        }
+
+        if (typeof gravity !== 'undefined') {
+            payload['gravity'] = gravity;
+        }
+
+        if (typeof quality !== 'undefined') {
+            payload['quality'] = quality;
+        }
+
+        if (typeof borderWidth !== 'undefined') {
+            payload['borderWidth'] = borderWidth;
+        }
+
+        if (typeof borderColor !== 'undefined') {
+            payload['borderColor'] = borderColor;
+        }
+
+        if (typeof borderRadius !== 'undefined') {
+            payload['borderRadius'] = borderRadius;
+        }
+
+        if (typeof opacity !== 'undefined') {
+            payload['opacity'] = opacity;
+        }
+
+        if (typeof rotation !== 'undefined') {
+            payload['rotation'] = rotation;
+        }
+
+        if (typeof background !== 'undefined') {
+            payload['background'] = background;
+        }
+
+        if (typeof output !== 'undefined') {
+            payload['output'] = output;
+        }
+
+        if (typeof token !== 'undefined') {
+            payload['token'] = token;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        return uri;
+    }
+
+    /**
+     * Get a file content by its unique ID. This endpoint is similar to the
+     * download method but returns with no  'Content-Disposition: attachment'
+     * header.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {string} token
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    getFileViewURL(bucketId: string, fileId: string, token?: string): URL {
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const payload: Payload = {};
+
+        if (typeof token !== 'undefined') {
+            payload['token'] = token;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
         return uri;
     }
 };

package/types/client.d.ts

@@ -138,7 +138,7 @@ declare class Client {
      * @returns {() => void} Unsubscribes from events.
      */
     subscribe<T extends unknown>(channels: string | string[], callback: (payload: RealtimeResponseEvent<T>) => void): () => void;
-    call(method: string, url: URL, headers?: Headers, params?: Payload): Promise<any>;
+    call(method: string, url: URL, headers?: Headers, params?: Payload, responseType?: string): Promise<any>;
 }
 export { Client, AppwriteException };
 export type { Models, Payload };