node-appwrite 11.1.1 → 12.0.0

package/index.js

@@ -12,9 +12,28 @@ const Functions = require('./lib/services/functions.js');
 const Graphql = require('./lib/services/graphql.js');
 const Health = require('./lib/services/health.js');
 const Locale = require('./lib/services/locale.js');
+const Messaging = require('./lib/services/messaging.js');
 const Storage = require('./lib/services/storage.js');
 const Teams = require('./lib/services/teams.js');
 const Users = require('./lib/services/users.js');
+const AuthenticatorType = require("./lib/enums/authenticator-type.js");
+const AuthenticationFactor = require("./lib/enums/authentication-factor.js");
+const OAuthProvider = require("./lib/enums/o-auth-provider.js");
+const Browser = require("./lib/enums/browser.js");
+const CreditCard = require("./lib/enums/credit-card.js");
+const Flag = require("./lib/enums/flag.js");
+const RelationshipType = require("./lib/enums/relationship-type.js");
+const RelationMutate = require("./lib/enums/relation-mutate.js");
+const IndexType = require("./lib/enums/index-type.js");
+const Runtime = require("./lib/enums/runtime.js");
+const ExecutionMethod = require("./lib/enums/execution-method.js");
+const Name = require("./lib/enums/name.js");
+const SmtpEncryption = require("./lib/enums/smtp-encryption.js");
+const Compression = require("./lib/enums/compression.js");
+const ImageGravity = require("./lib/enums/image-gravity.js");
+const ImageFormat = require("./lib/enums/image-format.js");
+const PasswordHash = require("./lib/enums/password-hash.js");
+const MessagingProviderType = require("./lib/enums/messaging-provider-type.js");
 
 module.exports = {
     Client,
@@ -31,7 +50,26 @@ module.exports = {
     Graphql,
     Health,
     Locale,
+    Messaging,
     Storage,
     Teams,
     Users,
+    AuthenticatorType,
+    AuthenticationFactor,
+    OAuthProvider,
+    Browser,
+    CreditCard,
+    Flag,
+    RelationshipType,
+    RelationMutate,
+    IndexType,
+    Runtime,
+    ExecutionMethod,
+    Name,
+    SmtpEncryption,
+    Compression,
+    ImageGravity,
+    ImageFormat,
+    PasswordHash,
+    MessagingProviderType,
 };

package/lib/client.js

@@ -1,24 +1,23 @@
 const os = require('os');
 const URL = require('url').URL;
-const https = require("https");
-const axios = require('axios');
-const FormData = require('form-data');
+const Query = require('./query.js');
+const {fetch, FormData, Agent} = require('undici');
 const AppwriteException = require('./exception.js');
 
 class Client {
     static CHUNK_SIZE = 5*1024*1024; // 5MB
     
     constructor() {
-        this.endpoint = 'https://HOSTNAME/v1';
+        this.endpoint = 'https://cloud.appwrite.io/v1';
         this.headers = {
             'accept-encoding': '*',
             'content-type': '',
-            'user-agent' : `AppwriteNodeJSSDK/11.1.1 (${os.type()}; ${os.version()}; ${os.arch()})`,
+            'user-agent' : `AppwriteNodeJSSDK/12.0.0 (${os.type()}; ${os.version()}; ${os.arch()})`,
             'x-sdk-name': 'Node.js',
             'x-sdk-platform': 'server',
             'x-sdk-language': 'nodejs',
-            'x-sdk-version': '11.1.1',
-            'X-Appwrite-Response-Format' : '1.4.0',
+            'x-sdk-version': '12.0.0',
+            'X-Appwrite-Response-Format' : '1.5.0',
         };
         this.selfSigned = false;
     }
@@ -30,7 +29,7 @@ class Client {
      *
      * @param {string} project
      *
-     * @return self
+     * @return Client
      */
     setProject(project) {
         this.addHeader('X-Appwrite-Project', project);
@@ -45,7 +44,7 @@ class Client {
      *
      * @param {string} key
      *
-     * @return self
+     * @return Client
      */
     setKey(key) {
         this.addHeader('X-Appwrite-Key', key);
@@ -60,7 +59,7 @@ class Client {
      *
      * @param {string} jwt
      *
-     * @return self
+     * @return Client
      */
     setJWT(jwt) {
         this.addHeader('X-Appwrite-JWT', jwt);
@@ -73,7 +72,7 @@ class Client {
      *
      * @param {string} locale
      *
-     * @return self
+     * @return Client
      */
     setLocale(locale) {
         this.addHeader('X-Appwrite-Locale', locale);
@@ -81,6 +80,36 @@ class Client {
         return this;
     }
 
+    /**
+     * Set Session
+     *
+     * The user session to authenticate with
+     *
+     * @param {string} session
+     *
+     * @return Client
+     */
+    setSession(session) {
+        this.addHeader('X-Appwrite-Session', session);
+
+        return this;
+    }
+
+    /**
+     * Set ForwardedUserAgent
+     *
+     * The user agent string of the client that made the request
+     *
+     * @param {string} forwardeduseragent
+     *
+     * @return Client
+     */
+    setForwardedUserAgent(forwardeduseragent) {
+        this.addHeader('X-Forwarded-User-Agent', forwardeduseragent);
+
+        return this;
+    }
+
     /**
      * Set self signed.
      *
@@ -109,8 +138,12 @@ class Client {
     }
 
     /**
+     * Sets a header for requests.
+     * 
      * @param {string} key
      * @param {string} value
+     * 
+     * @return this
      */
     addHeader(key, value) {
         this.headers[key.toLowerCase()] = value;
@@ -118,79 +151,88 @@ class Client {
         return this;
     }
       
-    async call(method, path = '', headers = {}, params = {}, responseType = 'json') {
-        headers = Object.assign({}, this.headers, headers);
+    async call(method, path = "", headers = {}, params = {}, responseType = "json") {
+        headers = {...this.headers, ...headers};
+        const url = new URL(this.endpoint + path);
 
-        let contentType = headers['content-type'].toLowerCase();
+        let body = undefined;
 
-        let formData = null;
+        if (method.toUpperCase() === "GET") {
+            url.search = new URLSearchParams(Client.flatten(params)).toString();
+        } else if (headers["content-type"]?.toLowerCase().startsWith("multipart/form-data")) {
+            delete headers["content-type"];
+            const formData = new FormData();
 
-        // Compute FormData for axios and appwrite.
-        if (contentType.startsWith('multipart/form-data')) {
-            const form = new FormData();
-            
-            let flatParams = Client.flatten(params);
-            
-            for (const key in flatParams) {
-                const value = flatParams[key];
+            const flatParams = Client.flatten(params);
 
-                if(value && value.type && value.type === 'file') {
-                    form.append(key, value.file, { filename: value.filename });
+            for (const [key, value] of Object.entries(flatParams)) {
+                if (value && value.type && value.type === "file") {
+                    formData.append(key, value.file, value.filename);
                 } else {
-                    form.append(key, flatParams[key]);
+                    formData.append(key, value);
                 }
             }
 
-            headers = {
-                ...headers,
-                ...form.getHeaders()
-            };
-
-            formData = form;
+            body = formData;
+        } else {
+            body = JSON.stringify(params);
         }
 
-        let options = {
+      let response = undefined;
+      try {
+        response = await fetch(url.toString(), {
             method: method.toUpperCase(),
-            url: this.endpoint + path,
-            params: (method.toUpperCase() === 'GET') ? params : {},
-            headers: headers,
-            data: (method.toUpperCase() === 'GET' || contentType.startsWith('multipart/form-data')) ? formData : params,
-            json: (contentType.startsWith('application/json')),
-            responseType: responseType
-        };
-        if (this.selfSigned) {
-            // Allow self signed requests
-            options.httpsAgent = new https.Agent({ rejectUnauthorized: false });
-        }
+            headers,
+            body,
+            redirect: responseType === "location" ? "manual" : "follow",
+            dispatcher: new Agent({
+                connect: {
+                    rejectUnauthorized: !this.selfSigned,
+                },
+            }),
+        });
+      } catch (error) {
+        throw new AppwriteException(error.message);
+      }
+
+      if (response.status >= 400) {
+        const text = await response.text();
+        let json = undefined;
         try {
-            let response = await axios(options);
-            return response.data;
-        } catch(error) {
-            if('response' in error && error.response !== undefined) {
-                if(error.response && 'data' in error.response) {
-                    if (typeof(error.response.data) === 'string') {
-                        throw new AppwriteException(error.response.data, error.response.status, '', error.response.data);
-                    } else {
-                        throw new AppwriteException(error.response.data.message, error.response.status, error.response.data.type, error.response.data);
-                    }
-                } else {
-                    throw new AppwriteException(error.response.statusText, error.response.status, error.response.data);
-                }
-            } else {
-                throw new AppwriteException(error.message);
-            }
+            json = JSON.parse(text);
+        } catch (error) {
+            throw new AppwriteException(text, response.status, "", text);
         }
+        throw new AppwriteException(json.message, json.code, json.type, json);
+      }
+
+      if (responseType === "arraybuffer") {
+        const data = await response.arrayBuffer();
+        return data;
+      }
+
+      if (responseType === "location") {
+        return response.headers.get("location");
+      }
+
+      const text = await response.text();
+      let json = undefined;
+      try {
+          json = JSON.parse(text);
+      } catch (error) {
+          return text;
+      }
+      return json;
     }
 
-    static flatten(data, prefix = '') {
+    static flatten(data, prefix = "") {
         let output = {};
 
-        for (const key in data) {
-            let value = data[key];
-            let finalKey = prefix ? prefix + '[' + key +']' : key;
+        for (const [key, value] of Object.entries(data)) {
+            let finalKey = prefix ? prefix + "[" + key + "]" : key;
 
             if (Array.isArray(value)) {
-                output = Object.assign(output, Client.flatten(value, finalKey)); // @todo: handle name collision here if needed
+                output = { ...output, ...Client.flatten(value, finalKey) };
             } else {
                 output[finalKey] = value;
             }

package/lib/enums/authentication-factor.js

@@ -0,0 +1,8 @@
+const AuthenticationFactor = Object.freeze({
+    Email: 'email' ,
+    Phone: 'phone' ,
+    Totp: 'totp' ,
+    Recoverycode: 'recoverycode' 
+});
+
+module.exports = AuthenticationFactor;

package/lib/enums/authenticator-type.js

@@ -0,0 +1,5 @@
+const AuthenticatorType = Object.freeze({
+    Totp: 'totp' 
+});
+
+module.exports = AuthenticatorType;

package/lib/enums/browser.js

@@ -0,0 +1,18 @@
+const Browser = Object.freeze({
+    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' 
+});
+
+module.exports = Browser;

package/lib/enums/compression.js

@@ -0,0 +1,7 @@
+const Compression = Object.freeze({
+    None: 'none' ,
+    Gzip: 'gzip' ,
+    Zstd: 'zstd' 
+});
+
+module.exports = Compression;

package/lib/enums/credit-card.js

@@ -0,0 +1,20 @@
+const CreditCard = Object.freeze({
+    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' 
+});
+
+module.exports = CreditCard;

package/lib/enums/execution-method.js

@@ -0,0 +1,10 @@
+const ExecutionMethod = Object.freeze({
+    GET: 'GET' ,
+    POST: 'POST' ,
+    PUT: 'PUT' ,
+    PATCH: 'PATCH' ,
+    DELETE: 'DELETE' ,
+    OPTIONS: 'OPTIONS' 
+});
+
+module.exports = ExecutionMethod;

package/lib/enums/flag.js

@@ -0,0 +1,198 @@
+const Flag = Object.freeze({
+    Afghanistan: 'af' ,
+    Angola: 'ao' ,
+    Albania: 'al' ,
+    Andorra: 'ad' ,
+    UnitedArabEmirates: 'ae' ,
+    Argentina: 'ar' ,
+    Armenia: 'am' ,
+    AntiguaAndBarbuda: 'ag' ,
+    Australia: 'au' ,
+    Austria: 'at' ,
+    Azerbaijan: 'az' ,
+    Burundi: 'bi' ,
+    Belgium: 'be' ,
+    Benin: 'bj' ,
+    BurkinaFaso: 'bf' ,
+    Bangladesh: 'bd' ,
+    Bulgaria: 'bg' ,
+    Bahrain: 'bh' ,
+    Bahamas: 'bs' ,
+    BosniaAndHerzegovina: 'ba' ,
+    Belarus: 'by' ,
+    Belize: 'bz' ,
+    Bolivia: 'bo' ,
+    Brazil: 'br' ,
+    Barbados: 'bb' ,
+    BruneiDarussalam: 'bn' ,
+    Bhutan: 'bt' ,
+    Botswana: 'bw' ,
+    CentralAfricanRepublic: 'cf' ,
+    Canada: 'ca' ,
+    Switzerland: 'ch' ,
+    Chile: 'cl' ,
+    China: 'cn' ,
+    CoteDIvoire: 'ci' ,
+    Cameroon: 'cm' ,
+    DemocraticRepublicOfTheCongo: 'cd' ,
+    RepublicOfTheCongo: 'cg' ,
+    Colombia: 'co' ,
+    Comoros: 'km' ,
+    CapeVerde: 'cv' ,
+    CostaRica: 'cr' ,
+    Cuba: 'cu' ,
+    Cyprus: 'cy' ,
+    CzechRepublic: 'cz' ,
+    Germany: 'de' ,
+    Djibouti: 'dj' ,
+    Dominica: 'dm' ,
+    Denmark: 'dk' ,
+    DominicanRepublic: 'do' ,
+    Algeria: 'dz' ,
+    Ecuador: 'ec' ,
+    Egypt: 'eg' ,
+    Eritrea: 'er' ,
+    Spain: 'es' ,
+    Estonia: 'ee' ,
+    Ethiopia: 'et' ,
+    Finland: 'fi' ,
+    Fiji: 'fj' ,
+    France: 'fr' ,
+    MicronesiaFederatedStatesOf: 'fm' ,
+    Gabon: 'ga' ,
+    UnitedKingdom: 'gb' ,
+    Georgia: 'ge' ,
+    Ghana: 'gh' ,
+    Guinea: 'gn' ,
+    Gambia: 'gm' ,
+    GuineaBissau: 'gw' ,
+    EquatorialGuinea: 'gq' ,
+    Greece: 'gr' ,
+    Grenada: 'gd' ,
+    Guatemala: 'gt' ,
+    Guyana: 'gy' ,
+    Honduras: 'hn' ,
+    Croatia: 'hr' ,
+    Haiti: 'ht' ,
+    Hungary: 'hu' ,
+    Indonesia: 'id' ,
+    India: 'in' ,
+    Ireland: 'ie' ,
+    IranIslamicRepublicOf: 'ir' ,
+    Iraq: 'iq' ,
+    Iceland: 'is' ,
+    Israel: 'il' ,
+    Italy: 'it' ,
+    Jamaica: 'jm' ,
+    Jordan: 'jo' ,
+    Japan: 'jp' ,
+    Kazakhstan: 'kz' ,
+    Kenya: 'ke' ,
+    Kyrgyzstan: 'kg' ,
+    Cambodia: 'kh' ,
+    Kiribati: 'ki' ,
+    SaintKittsAndNevis: 'kn' ,
+    SouthKorea: 'kr' ,
+    Kuwait: 'kw' ,
+    LaoPeopleSDemocraticRepublic: 'la' ,
+    Lebanon: 'lb' ,
+    Liberia: 'lr' ,
+    Libya: 'ly' ,
+    SaintLucia: 'lc' ,
+    Liechtenstein: 'li' ,
+    SriLanka: 'lk' ,
+    Lesotho: 'ls' ,
+    Lithuania: 'lt' ,
+    Luxembourg: 'lu' ,
+    Latvia: 'lv' ,
+    Morocco: 'ma' ,
+    Monaco: 'mc' ,
+    Moldova: 'md' ,
+    Madagascar: 'mg' ,
+    Maldives: 'mv' ,
+    Mexico: 'mx' ,
+    MarshallIslands: 'mh' ,
+    NorthMacedonia: 'mk' ,
+    Mali: 'ml' ,
+    Malta: 'mt' ,
+    Myanmar: 'mm' ,
+    Montenegro: 'me' ,
+    Mongolia: 'mn' ,
+    Mozambique: 'mz' ,
+    Mauritania: 'mr' ,
+    Mauritius: 'mu' ,
+    Malawi: 'mw' ,
+    Malaysia: 'my' ,
+    Namibia: 'na' ,
+    Niger: 'ne' ,
+    Nigeria: 'ng' ,
+    Nicaragua: 'ni' ,
+    Netherlands: 'nl' ,
+    Norway: 'no' ,
+    Nepal: 'np' ,
+    Nauru: 'nr' ,
+    NewZealand: 'nz' ,
+    Oman: 'om' ,
+    Pakistan: 'pk' ,
+    Panama: 'pa' ,
+    Peru: 'pe' ,
+    Philippines: 'ph' ,
+    Palau: 'pw' ,
+    PapuaNewGuinea: 'pg' ,
+    Poland: 'pl' ,
+    NorthKorea: 'kp' ,
+    Portugal: 'pt' ,
+    Paraguay: 'py' ,
+    Qatar: 'qa' ,
+    Romania: 'ro' ,
+    Russia: 'ru' ,
+    Rwanda: 'rw' ,
+    SaudiArabia: 'sa' ,
+    Sudan: 'sd' ,
+    Senegal: 'sn' ,
+    Singapore: 'sg' ,
+    SolomonIslands: 'sb' ,
+    SierraLeone: 'sl' ,
+    ElSalvador: 'sv' ,
+    SanMarino: 'sm' ,
+    Somalia: 'so' ,
+    Serbia: 'rs' ,
+    SouthSudan: 'ss' ,
+    SaoTomeAndPrincipe: 'st' ,
+    Suriname: 'sr' ,
+    Slovakia: 'sk' ,
+    Slovenia: 'si' ,
+    Sweden: 'se' ,
+    Eswatini: 'sz' ,
+    Seychelles: 'sc' ,
+    Syria: 'sy' ,
+    Chad: 'td' ,
+    Togo: 'tg' ,
+    Thailand: 'th' ,
+    Tajikistan: 'tj' ,
+    Turkmenistan: 'tm' ,
+    TimorLeste: 'tl' ,
+    Tonga: 'to' ,
+    TrinidadAndTobago: 'tt' ,
+    Tunisia: 'tn' ,
+    Turkey: 'tr' ,
+    Tuvalu: 'tv' ,
+    Tanzania: 'tz' ,
+    Uganda: 'ug' ,
+    Ukraine: 'ua' ,
+    Uruguay: 'uy' ,
+    UnitedStates: 'us' ,
+    Uzbekistan: 'uz' ,
+    VaticanCity: 'va' ,
+    SaintVincentAndTheGrenadines: 'vc' ,
+    Venezuela: 've' ,
+    Vietnam: 'vn' ,
+    Vanuatu: 'vu' ,
+    Samoa: 'ws' ,
+    Yemen: 'ye' ,
+    SouthAfrica: 'za' ,
+    Zambia: 'zm' ,
+    Zimbabwe: 'zw' 
+});
+
+module.exports = Flag;

package/lib/enums/image-format.js

@@ -0,0 +1,9 @@
+const ImageFormat = Object.freeze({
+    Jpg: 'jpg' ,
+    Jpeg: 'jpeg' ,
+    Gif: 'gif' ,
+    Png: 'png' ,
+    Webp: 'webp' 
+});
+
+module.exports = ImageFormat;

package/lib/enums/image-gravity.js

@@ -0,0 +1,13 @@
+const ImageGravity = Object.freeze({
+    Center: 'center' ,
+    TopLeft: 'top-left' ,
+    Top: 'top' ,
+    TopRight: 'top-right' ,
+    Left: 'left' ,
+    Right: 'right' ,
+    BottomLeft: 'bottom-left' ,
+    Bottom: 'bottom' ,
+    BottomRight: 'bottom-right' 
+});
+
+module.exports = ImageGravity;

package/lib/enums/index-type.js

@@ -0,0 +1,7 @@
+const IndexType = Object.freeze({
+    Key: 'key' ,
+    Fulltext: 'fulltext' ,
+    Unique: 'unique' 
+});
+
+module.exports = IndexType;

package/lib/enums/messaging-provider-type.js

@@ -0,0 +1,7 @@
+const MessagingProviderType = Object.freeze({
+    Email: 'email' ,
+    Sms: 'sms' ,
+    Push: 'push' 
+});
+
+module.exports = MessagingProviderType;

package/lib/enums/name.js

@@ -0,0 +1,17 @@
+const Name = Object.freeze({
+    V1Database: 'v1-database' ,
+    V1Deletes: 'v1-deletes' ,
+    V1Audits: 'v1-audits' ,
+    V1Mails: 'v1-mails' ,
+    V1Functions: 'v1-functions' ,
+    V1Usage: 'v1-usage' ,
+    V1UsageDump: 'v1-usage-dump' ,
+    Webhooksv1: 'webhooksv1' ,
+    V1Certificates: 'v1-certificates' ,
+    V1Builds: 'v1-builds' ,
+    V1Messaging: 'v1-messaging' ,
+    V1Migrations: 'v1-migrations' ,
+    Hamsterv1: 'hamsterv1' 
+});
+
+module.exports = Name;