react-native-appwrite 0.2.2 → 0.3.1

package/src/services/avatars.ts

@@ -2,6 +2,12 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import * as FileSystem from 'expo-file-system';
+import { Platform } from 'react-native';
+
+import { Browser } from '../enums/browser';
+import { CreditCard } from '../enums/credit-card';
+import { Flag } from '../enums/flag';
 
 export class Avatars extends Service {
 
@@ -24,14 +30,14 @@ export class Avatars extends Service {
      * image at source quality. If dimensions are not specified, the default size
      * of image returned is 100x100px.
      *
-     * @param {string} code
+     * @param {Browser} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getBrowser(code: string, width?: number, height?: number, quality?: number): URL {
+    getBrowser(code: Browser, width?: number, height?: number, quality?: number): URL {
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
@@ -74,14 +80,14 @@ export class Avatars extends Service {
      * of image returned is 100x100px.
      * 
      *
-     * @param {string} code
+     * @param {CreditCard} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getCreditCard(code: string, width?: number, height?: number, quality?: number): URL {
+    getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): URL {
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
@@ -158,14 +164,14 @@ export class Avatars extends Service {
      * of image returned is 100x100px.
      * 
      *
-     * @param {string} code
+     * @param {Flag} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFlag(code: string, width?: number, height?: number, quality?: number): URL {
+    getFlag(code: Flag, width?: number, height?: number, quality?: number): URL {
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }

package/src/services/databases.ts

@@ -2,6 +2,9 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import * as FileSystem from 'expo-file-system';
+import { Platform } from 'react-native';
+
 
 export class Databases extends Service {
 
@@ -55,12 +58,12 @@ export class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} documentId
-     * @param {Omit<Document, keyof Models.Document>} data
+     * @param {object} data
      * @param {string[]} permissions
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document> {
+    async createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document> {
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
         }
@@ -146,12 +149,12 @@ export class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} documentId
-     * @param {Partial<Omit<Document, keyof Models.Document>>} data
+     * @param {object} data
      * @param {string[]} permissions
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: Partial<Omit<Document, keyof Models.Document>>, permissions?: string[]): Promise<Document> {
+    async updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: object, permissions?: string[]): Promise<Document> {
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
         }

package/src/services/functions.ts

@@ -2,6 +2,10 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import * as FileSystem from 'expo-file-system';
+import { Platform } from 'react-native';
+
+import { ExecutionMethod } from '../enums/execution-method';
 
 export class Functions extends Service {
 
@@ -56,12 +60,12 @@ export class Functions extends Service {
      * @param {string} body
      * @param {boolean} async
      * @param {string} xpath
-     * @param {string} method
+     * @param {ExecutionMethod} method
      * @param {object} headers
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: string, headers?: object): Promise<Models.Execution> {
+    async createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }

package/src/services/graphql.ts

@@ -2,6 +2,9 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import * as FileSystem from 'expo-file-system';
+import { Platform } from 'react-native';
+
 
 export class Graphql extends Service {
 

package/src/services/locale.ts

@@ -2,6 +2,9 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import * as FileSystem from 'expo-file-system';
+import { Platform } from 'react-native';
+
 
 export class Locale extends Service {
 

package/src/services/messaging.ts

@@ -0,0 +1,84 @@
+import { Service } from '../service';
+import { AppwriteException, Client } from '../client';
+import type { Models } from '../models';
+import type { UploadProgress, Payload } from '../client';
+import * as FileSystem from 'expo-file-system';
+import { Platform } from 'react-native';
+
+
+export class Messaging extends Service {
+
+     constructor(client: Client)
+     {
+        super(client);
+     }
+
+    /**
+     * Create subscriber
+     *
+     * Create a new subscriber.
+     *
+     * @param {string} topicId
+     * @param {string} subscriberId
+     * @param {string} targetId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber> {
+        if (typeof topicId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "topicId"');
+        }
+
+        if (typeof subscriberId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "subscriberId"');
+        }
+
+        if (typeof targetId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "targetId"');
+        }
+
+        const apiPath = '/messaging/topics/{topicId}/subscribers'.replace('{topicId}', topicId);
+        const payload: Payload = {};
+
+        if (typeof subscriberId !== 'undefined') {
+            payload['subscriberId'] = subscriberId;
+        }
+
+        if (typeof targetId !== 'undefined') {
+            payload['targetId'] = targetId;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('post', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Delete subscriber
+     *
+     * Delete a subscriber by its unique ID.
+     *
+     * @param {string} topicId
+     * @param {string} subscriberId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async deleteSubscriber(topicId: string, subscriberId: string): Promise<{}> {
+        if (typeof topicId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "topicId"');
+        }
+
+        if (typeof subscriberId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "subscriberId"');
+        }
+
+        const apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replace('{topicId}', topicId).replace('{subscriberId}', subscriberId);
+        const payload: Payload = {};
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('delete', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+};

package/src/services/storage.ts

@@ -5,6 +5,9 @@ import type { UploadProgress, Payload } from '../client';
 import * as FileSystem from 'expo-file-system';
 import { Platform } from 'react-native';
 
+import { ImageGravity } from '../enums/image-gravity';
+import { ImageFormat } from '../enums/image-format';
+
 export class Storage extends Service {
 
      constructor(client: Client)
@@ -127,6 +130,7 @@ export class Storage extends Service {
             }
         }
 
+        let timestamp = new Date().getTime();
         while (offset < size) {
             let end = Math.min(offset + Service.CHUNK_SIZE - 1, size - 1);
 
@@ -141,11 +145,13 @@ export class Storage extends Service {
                 length: Service.CHUNK_SIZE
             });
             var path = `data:${file.type};base64,${chunk}`;
-            if (Platform.OS.toLowerCase() == 'android') {
-                path = FileSystem.cacheDirectory + '/tmp_chunk';
+            if (Platform.OS.toLowerCase() === 'android') {
+                path = FileSystem.cacheDirectory + '/tmp_chunk_' + timestamp;
                 await FileSystem.writeAsStringAsync(path, chunk, {encoding: FileSystem.EncodingType.Base64});
             }
-            payload['file'] = {uri: path, name: file.name, type: file.type};
+
+            payload['file'] = { uri: path, name: file.name, type: file.type };
+
             response = await this.client.call('post', uri, apiHeaders, payload);
 
             if (onProgress) {
@@ -306,7 +312,7 @@ export class Storage extends Service {
      * @param {string} fileId
      * @param {number} width
      * @param {number} height
-     * @param {string} gravity
+     * @param {ImageGravity} gravity
      * @param {number} quality
      * @param {number} borderWidth
      * @param {string} borderColor
@@ -314,11 +320,11 @@ export class Storage extends Service {
      * @param {number} opacity
      * @param {number} rotation
      * @param {string} background
-     * @param {string} output
+     * @param {ImageFormat} output
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: string, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: 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): URL {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }

package/src/services/teams.ts

@@ -2,6 +2,9 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import * as FileSystem from 'expo-file-system';
+import { Platform } from 'react-native';
+
 
 export class Teams extends Service {
 

package/types/client.d.ts

@@ -0,0 +1,133 @@
+import { Models } from './models';
+declare type Payload = {
+    [key: string]: any;
+};
+declare type Headers = {
+    [key: string]: string;
+};
+export declare type RealtimeResponseEvent<T extends unknown> = {
+    events: string[];
+    channels: string[];
+    timestamp: number;
+    payload: T;
+};
+export declare type UploadProgress = {
+    $id: string;
+    progress: number;
+    sizeUploaded: number;
+    chunksTotal: number;
+    chunksUploaded: number;
+};
+declare class AppwriteException extends Error {
+    code: number;
+    response: string;
+    type: string;
+    constructor(message: string, code?: number, type?: string, response?: string);
+}
+declare class Client {
+    config: {
+        endpoint: string;
+        endpointRealtime: string;
+        project: string;
+        jwt: string;
+        locale: string;
+        session: string;
+        platform: string;
+    };
+    headers: Headers;
+    /**
+     * Set Endpoint
+     *
+     * Your project endpoint
+     *
+     * @param {string} endpoint
+     *
+     * @returns {this}
+     */
+    setEndpoint(endpoint: string): this;
+    /**
+     * Set Realtime Endpoint
+     *
+     * @param {string} endpointRealtime
+     *
+     * @returns {this}
+     */
+    setEndpointRealtime(endpointRealtime: string): this;
+    /**
+     * Set platform
+     *
+     * Set platform. Will be used as origin for all requests.
+     *
+     * @param {string} platform
+     * @returns {this}
+     */
+    setPlatform(platform: string): this;
+    /**
+     * Set Project
+     *
+     * Your project ID
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setProject(value: string): this;
+    /**
+     * Set JWT
+     *
+     * Your secret JSON Web Token
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setJWT(value: string): this;
+    /**
+     * Set Locale
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setLocale(value: string): this;
+    /**
+     * Set Session
+     *
+     * The user session to authenticate with
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setSession(value: string): this;
+    private realtime;
+    /**
+     * Subscribes to Appwrite events and passes you the payload in realtime.
+     *
+     * @param {string|string[]} channels
+     * Channel to subscribe - pass a single channel as a string or multiple with an array of strings.
+     *
+     * Possible channels are:
+     * - account
+     * - collections
+     * - collections.[ID]
+     * - collections.[ID].documents
+     * - documents
+     * - documents.[ID]
+     * - files
+     * - files.[ID]
+     * - executions
+     * - executions.[ID]
+     * - functions.[ID]
+     * - teams
+     * - teams.[ID]
+     * - memberships
+     * - memberships.[ID]
+     * @param {(payload: RealtimeMessage) => void} callback Is called on every realtime update.
+     * @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>;
+}
+export { Client, AppwriteException };
+export type { Models, Payload };

package/types/enums/authentication-factor.d.ts

@@ -0,0 +1,6 @@
+export declare enum AuthenticationFactor {
+    Email = "email",
+    Phone = "phone",
+    Totp = "totp",
+    Recoverycode = "recoverycode"
+}

package/types/enums/authenticator-type.d.ts

@@ -0,0 +1,3 @@
+export declare enum AuthenticatorType {
+    Totp = "totp"
+}

package/types/enums/browser.d.ts

@@ -0,0 +1,16 @@
+export declare enum Browser {
+    AvantBrowser = "aa",
+    AndroidWebViewBeta = "an",
+    GoogleChrome = "ch",
+    GoogleChromeIOS = "ci",
+    GoogleChromeMobile = "cm",
+    Chromium = "cr",
+    MozillaFirefox = "ff",
+    Safari = "sf",
+    MobileSafari = "mf",
+    MicrosoftEdge = "ps",
+    MicrosoftEdgeIOS = "oi",
+    OperaMini = "om",
+    Opera = "op",
+    OperaNext = "on"
+}

package/types/enums/credit-card.d.ts

@@ -0,0 +1,18 @@
+export declare enum CreditCard {
+    AmericanExpress = "amex",
+    Argencard = "argencard",
+    Cabal = "cabal",
+    Consosud = "censosud",
+    DinersClub = "diners",
+    Discover = "discover",
+    Elo = "elo",
+    Hipercard = "hipercard",
+    JCB = "jcb",
+    Mastercard = "mastercard",
+    Naranja = "naranja",
+    TarjetaShopping = "targeta-shopping",
+    UnionChinaPay = "union-china-pay",
+    Visa = "visa",
+    MIR = "mir",
+    Maestro = "maestro"
+}

package/types/enums/execution-method.d.ts

@@ -0,0 +1,8 @@
+export declare enum ExecutionMethod {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    PATCH = "PATCH",
+    DELETE = "DELETE",
+    OPTIONS = "OPTIONS"
+}