react-native-appwrite 0.9.2 → 0.10.1

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,151 @@ 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);
+        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: 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);
+        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: 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);
+        payload['project'] = this.client.config.project;
+
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+
         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 };

package/types/enums/image-format.d.ts

@@ -4,5 +4,6 @@ export declare enum ImageFormat {
     Png = "png",
     Webp = "webp",
     Heic = "heic",
-    Avif = "avif"
+    Avif = "avif",
+    Gif = "gif"
 }

package/types/services/avatars.d.ts

@@ -5,6 +5,135 @@ import { CreditCard } from '../enums/credit-card';
 import { Flag } from '../enums/flag';
 export declare class Avatars extends Service {
     constructor(client: Client);
+    /**
+     * 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 {ArrayBuffer}
+    */
+    getBrowser(code: Browser, width?: number, height?: number, quality?: number): Promise<ArrayBuffer>;
+    /**
+     * 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 {ArrayBuffer}
+    */
+    getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): Promise<ArrayBuffer>;
+    /**
+     * 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 {ArrayBuffer}
+    */
+    getFavicon(url: string): Promise<ArrayBuffer>;
+    /**
+     * 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 {ArrayBuffer}
+    */
+    getFlag(code: Flag, width?: number, height?: number, quality?: number): Promise<ArrayBuffer>;
+    /**
+     * 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 {ArrayBuffer}
+    */
+    getImage(url: string, width?: number, height?: number): Promise<ArrayBuffer>;
+    /**
+     * 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 {ArrayBuffer}
+    */
+    getInitials(name?: string, width?: number, height?: number, background?: string): Promise<ArrayBuffer>;
+    /**
+     * 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 {ArrayBuffer}
+    */
+    getQR(text: string, size?: number, margin?: number, download?: boolean): Promise<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
@@ -24,7 +153,7 @@ export declare class Avatars extends Service {
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getBrowser(code: Browser, width?: number, height?: number, quality?: number): URL;
+    getBrowserURL(code: Browser, width?: number, height?: number, quality?: number): URL;
     /**
      * 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
@@ -43,7 +172,7 @@ export declare class Avatars extends Service {
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): URL;
+    getCreditCardURL(code: CreditCard, width?: number, height?: number, quality?: number): URL;
     /**
      * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
      * website URL.
@@ -54,7 +183,7 @@ export declare class Avatars extends Service {
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFavicon(url: string): URL;
+    getFaviconURL(url: string): URL;
     /**
      * 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,
@@ -74,7 +203,7 @@ export declare class Avatars extends Service {
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFlag(code: Flag, width?: number, height?: number, quality?: number): URL;
+    getFlagURL(code: Flag, width?: number, height?: number, quality?: number): URL;
     /**
      * 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
@@ -94,7 +223,7 @@ export declare class Avatars extends Service {
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getImage(url: string, width?: number, height?: number): URL;
+    getImageURL(url: string, width?: number, height?: number): URL;
     /**
      * 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
@@ -120,7 +249,7 @@ export declare class Avatars extends Service {
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getInitials(name?: string, width?: number, height?: number, background?: string): URL;
+    getInitialsURL(name?: string, width?: number, height?: number, background?: string): URL;
     /**
      * 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.
@@ -133,5 +262,5 @@ export declare class Avatars extends Service {
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getQR(text: string, size?: number, margin?: number, download?: boolean): URL;
+    getQRURL(text: string, size?: number, margin?: number, download?: boolean): URL;
 }

package/types/services/databases.d.ts

@@ -42,6 +42,10 @@ export declare class Databases extends Service {
     */
     getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
     /**
+     * **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)

package/types/services/storage.d.ts

@@ -82,6 +82,55 @@ export declare class Storage extends Service {
      * @returns {Promise}
     */
     deleteFile(bucketId: string, fileId: string): Promise<{}>;
+    /**
+     * 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 {ArrayBuffer}
+    */
+    getFileDownload(bucketId: string, fileId: string, token?: string): Promise<ArrayBuffer>;
+    /**
+     * 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 {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): Promise<ArrayBuffer>;
+    /**
+     * 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 {ArrayBuffer}
+    */
+    getFileView(bucketId: string, fileId: string, token?: string): Promise<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
@@ -93,7 +142,7 @@ export declare class Storage extends Service {
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFileDownload(bucketId: string, fileId: string, token?: string): URL;
+    getFileDownloadURL(bucketId: string, fileId: string, token?: string): URL;
     /**
      * Get a file preview image. Currently, this method supports preview for image
      * files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
@@ -118,7 +167,7 @@ export declare class Storage extends Service {
      * @throws {AppwriteException}
      * @returns {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): 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;
     /**
      * Get a file content by its unique ID. This endpoint is similar to the
      * download method but returns with no  'Content-Disposition: attachment'
@@ -130,5 +179,5 @@ export declare class Storage extends Service {
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFileView(bucketId: string, fileId: string, token?: string): URL;
+    getFileViewURL(bucketId: string, fileId: string, token?: string): URL;
 }