react-native-appwrite 0.9.2 → 0.10.1

package/.github/workflows/publish.yml

@@ -39,4 +39,4 @@ jobs:
     - name: Publish
       run: npm publish --tag ${{ steps.release_tag.outputs.tag }}
       env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_NO_ORG }}

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change log
 
+## 0.10.1
+
+* Fix URL based methods like `getFileViewURL`, `getFilePreviewURL` etc. by adding the missing `projectId` to searchParams
+* Add `gif` to ImageFormat enum
+
+## 0.10.0
+
+* Add generate file URL methods like`getFilePreviewURL`, `getFileViewURL` etc.
+* Update (breaking) existing methods like `getFilePreview` to download the image instead of returning URLs
+
+## 0.9.2
+
+* Fix `devKeys` by removing credentials from requests when the key is set
+
+## 0.9.1
+
+* Add `setDevkey` and `upsertDocument` methods
+
 ## 0.9.0
 
 * Add `token` param to `getFilePreview` and `getFileView` for File tokens usage

package/README.md

@@ -1,7 +1,7 @@
 # Appwrite React Native SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-react-native.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.7.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.7.4-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)

package/dist/cjs/sdk.js

@@ -100,7 +100,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.1',
             'X-Appwrite-Response-Format': '1.7.0',
         };
         this.realtime = {
@@ -392,7 +392,7 @@ class Client {
         };
     }
     call(method_1, url_1) {
-        return __awaiter(this, arguments, void 0, function* (method, url, headers = {}, params = {}) {
+        return __awaiter(this, arguments, void 0, function* (method, url, headers = {}, params = {}, responseType = 'json') {
             var _a, _b;
             method = method.toUpperCase();
             headers = Object.assign({}, this.headers, headers);
@@ -441,6 +441,9 @@ class Client {
                 if ((_a = response.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.includes('application/json')) {
                     data = yield response.json();
                 }
+                else if (responseType === 'arrayBuffer') {
+                    data = yield response.arrayBuffer();
+                }
                 else {
                     data = {
                         message: yield response.text()
@@ -1727,7 +1730,7 @@ class Avatars extends Service {
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getBrowser(code, width, height, quality) {
         if (typeof code === 'undefined') {
@@ -1749,7 +1752,7 @@ 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');
     }
     /**
      * The credit card endpoint will return you the icon of the credit card
@@ -1767,7 +1770,7 @@ class Avatars extends Service {
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getCreditCard(code, width, height, quality) {
         if (typeof code === 'undefined') {
@@ -1789,7 +1792,7 @@ 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');
     }
     /**
      * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
@@ -1799,7 +1802,7 @@ class Avatars extends Service {
      *
      * @param {string} url
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getFavicon(url) {
         if (typeof url === 'undefined') {
@@ -1815,7 +1818,7 @@ 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');
     }
     /**
      * You can use this endpoint to show different country flags icons to your
@@ -1834,7 +1837,7 @@ class Avatars extends Service {
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getFlag(code, width, height, quality) {
         if (typeof code === 'undefined') {
@@ -1856,7 +1859,7 @@ 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');
     }
     /**
      * Use this endpoint to fetch a remote image URL and crop it to any image size
@@ -1875,7 +1878,7 @@ class Avatars extends Service {
      * @param {number} width
      * @param {number} height
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getImage(url, width, height) {
         if (typeof url === 'undefined') {
@@ -1897,7 +1900,7 @@ 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');
     }
     /**
      * Use this endpoint to show your user initials avatar icon on your website or
@@ -1922,7 +1925,7 @@ class Avatars extends Service {
      * @param {number} height
      * @param {string} background
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getInitials(name, width, height, background) {
         const apiPath = '/avatars/initials';
@@ -1944,7 +1947,7 @@ 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');
     }
     /**
      * Converts a given plain text to a QR code image. You can use the query
@@ -1956,12 +1959,267 @@ class Avatars extends Service {
      * @param {number} margin
      * @param {boolean} download
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getQR(text, size, margin, download) {
         if (typeof text === 'undefined') {
             throw new AppwriteException('Missing required parameter: "text"');
         }
+        const apiPath = '/avatars/qr';
+        const 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);
+        payload['project'] = this.client.config.project;
+        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, width, height, quality) {
+        const apiPath = '/avatars/browsers/{code}'.replace('{code}', code);
+        const 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);
+        payload['project'] = this.client.config.project;
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+        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, width, height, quality) {
+        const apiPath = '/avatars/credit-cards/{code}'.replace('{code}', code);
+        const 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);
+        payload['project'] = this.client.config.project;
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+        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) {
+        const apiPath = '/avatars/favicon';
+        const payload = {};
+        if (typeof url !== 'undefined') {
+            payload['url'] = url;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        payload['project'] = this.client.config.project;
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+        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, width, height, quality) {
+        const apiPath = '/avatars/flags/{code}'.replace('{code}', code);
+        const 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);
+        payload['project'] = this.client.config.project;
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+        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, width, height) {
+        const apiPath = '/avatars/image';
+        const 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);
+        payload['project'] = this.client.config.project;
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+        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, width, height, background) {
+        const apiPath = '/avatars/initials';
+        const 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);
+        payload['project'] = this.client.config.project;
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+        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, size, margin, download) {
         const apiPath = '/avatars/qr';
         const payload = {};
         if (typeof text !== 'undefined') {
@@ -2087,6 +2345,10 @@ class Databases extends Service {
         return this.client.call('get', uri, {}, payload);
     }
     /**
+     * **WARNING: Experimental Feature** - This endpoint is experimental and not
+     * yet officially supported. It may be subject to breaking changes or removal
+     * in future versions.
+     *
      * Create or update a Document. Before using this route, you should create a
      * new collection resource using either a [server
      * integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
@@ -2719,7 +2981,7 @@ class Storage extends Service {
      * @param {string} fileId
      * @param {string} token
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getFileDownload(bucketId, fileId, token) {
         if (typeof bucketId === 'undefined') {
@@ -2738,7 +3000,7 @@ 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');
     }
     /**
      * Get a file preview image. Currently, this method supports preview for image
@@ -2762,7 +3024,7 @@ class Storage extends Service {
      * @param {ImageFormat} output
      * @param {string} token
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getFilePreview(bucketId, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output, token) {
         if (typeof bucketId === 'undefined') {
@@ -2814,7 +3076,7 @@ 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');
     }
     /**
      * Get a file content by its unique ID. This endpoint is similar to the
@@ -2825,7 +3087,7 @@ class Storage extends Service {
      * @param {string} fileId
      * @param {string} token
      * @throws {AppwriteException}
-     * @returns {URL}
+     * @returns {ArrayBuffer}
     */
     getFileView(bucketId, fileId, token) {
         if (typeof bucketId === 'undefined') {
@@ -2834,6 +3096,124 @@ class Storage extends Service {
         if (typeof fileId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const payload = {};
+        if (typeof token !== 'undefined') {
+            payload['token'] = token;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        payload['project'] = this.client.config.project;
+        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, fileId, token) {
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const payload = {};
+        if (typeof token !== 'undefined') {
+            payload['token'] = token;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        payload['project'] = this.client.config.project;
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+        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, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output, token) {
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const 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);
+        payload['project'] = this.client.config.project;
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+        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, fileId, token) {
         const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         const payload = {};
         if (typeof token !== 'undefined') {
@@ -3732,6 +4112,7 @@ exports.ImageFormat = void 0;
     ImageFormat["Webp"] = "webp";
     ImageFormat["Heic"] = "heic";
     ImageFormat["Avif"] = "avif";
+    ImageFormat["Gif"] = "gif";
 })(exports.ImageFormat || (exports.ImageFormat = {}));
 
 exports.Account = Account;