node-appwrite 7.0.0 → 8.0.0-RC1

package/index.js

@@ -1,5 +1,8 @@
 const Client = require('./lib/client.js');
 const Query = require('./lib/query.js');
+const Permission = require('./lib/permission.js');
+const Role = require('./lib/role.js');
+const ID = require('./lib/id.js');
 const InputFile = require('./lib/inputFile.js');
 const AppwriteException = require('./lib/exception.js');
 const Account = require('./lib/services/account.js');
@@ -15,6 +18,9 @@ const Users = require('./lib/services/users.js');
 module.exports = {
     Client,
     Query,
+    Permission,
+    Role,
+    ID,
     InputFile,
     AppwriteException,
     Account,

package/lib/client.js

@@ -10,8 +10,11 @@ class Client {
         this.endpoint = 'https://HOSTNAME/v1';
         this.headers = {
             'content-type': '',
-            'x-sdk-version': 'appwrite:nodejs:7.0.0',
-            'X-Appwrite-Response-Format' : '0.15.0',
+            'x-sdk-name': 'Node.js',
+            'x-sdk-platform': 'server',
+            'x-sdk-language': 'nodejs',
+            'x-sdk-version': '8.0.0-RC1',
+            'X-Appwrite-Response-Format' : '1.0.0-RC1',
         };
         this.selfSigned = false;
     }

package/lib/id.js

@@ -0,0 +1,12 @@
+class ID {
+
+    static unique = () => {
+         return 'unique()'
+    }
+
+    static custom = (id) => {
+         return id
+    }
+}
+
+module.exports = ID;

package/lib/permission.js

@@ -0,0 +1,24 @@
+class Permission {
+
+    static read = (role) => {
+         return `read("${role}")`
+    }
+
+    static write = (role) => {
+         return `write("${role}")`
+    }
+
+    static create = (role) => {
+         return `create("${role}")`
+    }
+
+    static update = (role) => {
+         return `update("${role}")`
+    }
+
+    static delete = (role) => {
+         return `delete("${role}")`
+    }
+}
+
+module.exports = Permission;

package/lib/query.js

@@ -5,27 +5,45 @@ class Query {
   static notEqual = (attribute, value) =>
     Query.addQuery(attribute, "notEqual", value);
 
-  static lesser = (attribute, value) =>
-    Query.addQuery(attribute, "lesser", value);
+  static lessThan = (attribute, value) =>
+    Query.addQuery(attribute, "lessThan", value);
 
-  static lesserEqual = (attribute, value) =>
-    Query.addQuery(attribute, "lesserEqual", value);
+  static lessThanEqual = (attribute, value) =>
+    Query.addQuery(attribute, "lessThanEqual", value);
 
-  static greater = (attribute, value) =>
-    Query.addQuery(attribute, "greater", value);
+  static greaterThan = (attribute, value) =>
+    Query.addQuery(attribute, "greaterThan", value);
 
-  static greaterEqual = (attribute, value) =>
-    Query.addQuery(attribute, "greaterEqual", value);
+  static greaterThanEqual = (attribute, value) =>
+    Query.addQuery(attribute, "greaterThanEqual", value);
 
   static search = (attribute, value) =>
     Query.addQuery(attribute, "search", value);
 
-  static addQuery = (attribute, oper, value) =>
+  static orderDesc = (attribute) =>
+    `orderDesc("${attribute}")`;
+
+  static orderAsc = (attribute) =>
+    `orderAsc("${attribute}")`;
+
+  static cursorAfter = (documentId) =>
+    `cursorAfter("${documentId}")`;
+
+  static cursorBefore = (documentId) =>
+    `cursorBefore("${documentId}")`;
+
+  static limit = (limit) =>
+    `limit(${limit})`;
+
+  static offset = (offset) =>
+    `offset(${offset})`;
+
+  static addQuery = (attribute, method, value) =>
     value instanceof Array
-      ? `${attribute}.${oper}(${value
+      ? `${method}("${attribute}", [${value
           .map((v) => Query.parseValues(v))
-          .join(",")})`
-      : `${attribute}.${oper}(${Query.parseValues(value)})`;
+          .join(",")}])`
+      : `${method}("${attribute}", [${Query.parseValues(value)}])`;
 
   static parseValues = (value) =>
     typeof value === "string" || value instanceof String

package/lib/role.js

@@ -0,0 +1,25 @@
+class Role {
+    static any = () => {
+        return 'any'
+    }
+    static user = (id) => {
+        return 'user:' + id
+    }
+    static users = () => {
+        return 'users'
+    }
+    static guests = () => {
+        return 'guests'
+    }
+    static team = (id, role = '') => {
+        if(role === '') {
+            return 'team:' + id
+        }
+        return 'team:' + id + '/' + role
+    }
+    static status = (status) => {
+        return 'status:' + status
+    }
+}
+
+module.exports = Role;

package/lib/services/account.js

@@ -8,6 +8,12 @@ const fs = require('fs');
 
 class Account extends Service {
 
+     constructor(client)
+     {
+        super(client);
+     }
+
+
     /**
      * Get Account
      *
@@ -43,6 +49,8 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateEmail(email, password) {
+        let path = '/account/email';
+        let payload = {};
         if (typeof email === 'undefined') {
             throw new AppwriteException('Missing required parameter: "email"');
         }
@@ -51,8 +59,6 @@ class Account extends Service {
             throw new AppwriteException('Missing required parameter: "password"');
         }
 
-        let path = '/account/email';
-        let payload = {};
 
         if (typeof email !== 'undefined') {
             payload['email'] = email;
@@ -73,21 +79,16 @@ class Account extends Service {
      * Get currently logged in user list of latest security activity logs. Each
      * log returns user IP address, location and date and time of log.
      *
-     * @param {number} limit
-     * @param {number} offset
+     * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getLogs(limit, offset) {
+    async getLogs(queries) {
         let path = '/account/logs';
         let payload = {};
 
-        if (typeof limit !== 'undefined') {
-            payload['limit'] = limit;
-        }
-
-        if (typeof offset !== 'undefined') {
-            payload['offset'] = offset;
+        if (typeof queries !== 'undefined') {
+            payload['queries'] = queries;
         }
 
         return await this.client.call('get', path, {
@@ -105,12 +106,12 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateName(name) {
+        let path = '/account/name';
+        let payload = {};
         if (typeof name === 'undefined') {
             throw new AppwriteException('Missing required parameter: "name"');
         }
 
-        let path = '/account/name';
-        let payload = {};
 
         if (typeof name !== 'undefined') {
             payload['name'] = name;
@@ -134,12 +135,12 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updatePassword(password, oldPassword) {
+        let path = '/account/password';
+        let payload = {};
         if (typeof password === 'undefined') {
             throw new AppwriteException('Missing required parameter: "password"');
         }
 
-        let path = '/account/password';
-        let payload = {};
 
         if (typeof password !== 'undefined') {
             payload['password'] = password;
@@ -157,30 +158,31 @@ class Account extends Service {
     /**
      * Update Account Phone
      *
-     * Update currently logged in user account phone number. After changing phone
-     * number, the user confirmation status will get reset. A new confirmation SMS
-     * is not sent automatically however you can use the phone confirmation
-     * endpoint again to send the confirmation SMS.
+     * Update the currently logged in user's phone number. After updating the
+     * phone number, the phone verification status will be reset. A confirmation
+     * SMS is not sent automatically, however you can use the [POST
+     * /account/verification/phone](/docs/client/account#accountCreatePhoneVerification)
+     * endpoint to send a confirmation SMS.
      *
-     * @param {string} number
+     * @param {string} phone
      * @param {string} password
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updatePhone(number, password) {
-        if (typeof number === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "number"');
+    async updatePhone(phone, password) {
+        let path = '/account/phone';
+        let payload = {};
+        if (typeof phone === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "phone"');
         }
 
         if (typeof password === 'undefined') {
             throw new AppwriteException('Missing required parameter: "password"');
         }
 
-        let path = '/account/phone';
-        let payload = {};
 
-        if (typeof number !== 'undefined') {
-            payload['number'] = number;
+        if (typeof phone !== 'undefined') {
+            payload['phone'] = phone;
         }
 
         if (typeof password !== 'undefined') {
@@ -221,12 +223,12 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updatePrefs(prefs) {
+        let path = '/account/prefs';
+        let payload = {};
         if (typeof prefs === 'undefined') {
             throw new AppwriteException('Missing required parameter: "prefs"');
         }
 
-        let path = '/account/prefs';
-        let payload = {};
 
         if (typeof prefs !== 'undefined') {
             payload['prefs'] = prefs;
@@ -255,6 +257,8 @@ class Account extends Service {
      * @returns {Promise}
      */
     async createRecovery(email, url) {
+        let path = '/account/recovery';
+        let payload = {};
         if (typeof email === 'undefined') {
             throw new AppwriteException('Missing required parameter: "email"');
         }
@@ -263,8 +267,6 @@ class Account extends Service {
             throw new AppwriteException('Missing required parameter: "url"');
         }
 
-        let path = '/account/recovery';
-        let payload = {};
 
         if (typeof email !== 'undefined') {
             payload['email'] = email;
@@ -300,6 +302,8 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateRecovery(userId, secret, password, passwordAgain) {
+        let path = '/account/recovery';
+        let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
@@ -316,8 +320,6 @@ class Account extends Service {
             throw new AppwriteException('Missing required parameter: "passwordAgain"');
         }
 
-        let path = '/account/recovery';
-        let payload = {};
 
         if (typeof userId !== 'undefined') {
             payload['userId'] = userId;
@@ -387,12 +389,12 @@ class Account extends Service {
      * @returns {Promise}
      */
     async getSession(sessionId) {
+        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+        let payload = {};
         if (typeof sessionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "sessionId"');
         }
 
-        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
-        let payload = {};
 
         return await this.client.call('get', path, {
             'content-type': 'application/json',
@@ -411,12 +413,12 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateSession(sessionId) {
+        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+        let payload = {};
         if (typeof sessionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "sessionId"');
         }
 
-        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
-        let payload = {};
 
         return await this.client.call('patch', path, {
             'content-type': 'application/json',
@@ -436,12 +438,12 @@ class Account extends Service {
      * @returns {Promise}
      */
     async deleteSession(sessionId) {
+        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+        let payload = {};
         if (typeof sessionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "sessionId"');
         }
 
-        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
-        let payload = {};
 
         return await this.client.call('delete', path, {
             'content-type': 'application/json',
@@ -491,12 +493,12 @@ class Account extends Service {
      * @returns {Promise}
      */
     async createVerification(url) {
+        let path = '/account/verification';
+        let payload = {};
         if (typeof url === 'undefined') {
             throw new AppwriteException('Missing required parameter: "url"');
         }
 
-        let path = '/account/verification';
-        let payload = {};
 
         if (typeof url !== 'undefined') {
             payload['url'] = url;
@@ -521,6 +523,8 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateVerification(userId, secret) {
+        let path = '/account/verification';
+        let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
@@ -529,8 +533,6 @@ class Account extends Service {
             throw new AppwriteException('Missing required parameter: "secret"');
         }
 
-        let path = '/account/verification';
-        let payload = {};
 
         if (typeof userId !== 'undefined') {
             payload['userId'] = userId;
@@ -548,13 +550,12 @@ class Account extends Service {
     /**
      * Create Phone Verification
      *
-     * Use this endpoint to send a verification message to your user's phone
-     * number to confirm they are the valid owners of that address. The provided
-     * secret should allow you to complete the verification process by verifying
-     * both the **userId** and **secret** parameters. Learn more about how to
-     * [complete the verification
+     * Use this endpoint to send a verification SMS to the currently logged in
+     * user. This endpoint is meant for use after updating a user's phone number
+     * using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone)
+     * endpoint. Learn more about how to [complete the verification
      * process](/docs/client/account#accountUpdatePhoneVerification). The
-     * verification link sent to the user's phone number is valid for 15 minutes.
+     * verification code sent to the user's phone number is valid for 15 minutes.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -582,6 +583,8 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updatePhoneVerification(userId, secret) {
+        let path = '/account/verification/phone';
+        let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
@@ -590,8 +593,6 @@ class Account extends Service {
             throw new AppwriteException('Missing required parameter: "secret"');
         }
 
-        let path = '/account/verification/phone';
-        let payload = {};
 
         if (typeof userId !== 'undefined') {
             payload['userId'] = userId;
@@ -607,4 +608,4 @@ class Account extends Service {
     }
 }
 
-module.exports = Account;
+module.exports = Account;

package/lib/services/avatars.js

@@ -8,6 +8,12 @@ const fs = require('fs');
 
 class Avatars extends Service {
 
+     constructor(client)
+     {
+        super(client);
+     }
+
+
     /**
      * Get Browser Icon
      *
@@ -29,12 +35,12 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getBrowser(code, width, height, quality) {
+        let path = '/avatars/browsers/{code}'.replace('{code}', code);
+        let payload = {};
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
 
-        let path = '/avatars/browsers/{code}'.replace('{code}', code);
-        let payload = {};
 
         if (typeof width !== 'undefined') {
             payload['width'] = width;
@@ -74,12 +80,12 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getCreditCard(code, width, height, quality) {
+        let path = '/avatars/credit-cards/{code}'.replace('{code}', code);
+        let payload = {};
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
 
-        let path = '/avatars/credit-cards/{code}'.replace('{code}', code);
-        let payload = {};
 
         if (typeof width !== 'undefined') {
             payload['width'] = width;
@@ -110,12 +116,12 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getFavicon(url) {
+        let path = '/avatars/favicon';
+        let payload = {};
         if (typeof url === 'undefined') {
             throw new AppwriteException('Missing required parameter: "url"');
         }
 
-        let path = '/avatars/favicon';
-        let payload = {};
 
         if (typeof url !== 'undefined') {
             payload['url'] = url;
@@ -131,7 +137,8 @@ class Avatars extends Service {
      *
      * 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.
+     * height and quality arguments to change the output settings. Country codes
+     * follow the [ISO 3166-1](http://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
@@ -147,12 +154,12 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getFlag(code, width, height, quality) {
+        let path = '/avatars/flags/{code}'.replace('{code}', code);
+        let payload = {};
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
 
-        let path = '/avatars/flags/{code}'.replace('{code}', code);
-        let payload = {};
 
         if (typeof width !== 'undefined') {
             payload['width'] = width;
@@ -192,12 +199,12 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getImage(url, width, height) {
+        let path = '/avatars/image';
+        let payload = {};
         if (typeof url === 'undefined') {
             throw new AppwriteException('Missing required parameter: "url"');
         }
 
-        let path = '/avatars/image';
-        let payload = {};
 
         if (typeof url !== 'undefined') {
             payload['url'] = url;
@@ -239,12 +246,11 @@ class Avatars extends Service {
      * @param {string} name
      * @param {number} width
      * @param {number} height
-     * @param {string} color
      * @param {string} background
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getInitials(name, width, height, color, background) {
+    async getInitials(name, width, height, background) {
         let path = '/avatars/initials';
         let payload = {};
 
@@ -260,10 +266,6 @@ class Avatars extends Service {
             payload['height'] = height;
         }
 
-        if (typeof color !== 'undefined') {
-            payload['color'] = color;
-        }
-
         if (typeof background !== 'undefined') {
             payload['background'] = background;
         }
@@ -288,12 +290,12 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getQR(text, size, margin, download) {
+        let path = '/avatars/qr';
+        let payload = {};
         if (typeof text === 'undefined') {
             throw new AppwriteException('Missing required parameter: "text"');
         }
 
-        let path = '/avatars/qr';
-        let payload = {};
 
         if (typeof text !== 'undefined') {
             payload['text'] = text;
@@ -317,4 +319,4 @@ class Avatars extends Service {
     }
 }
 
-module.exports = Avatars;
+module.exports = Avatars;