node-appwrite 11.1.1 → 12.0.0

package/lib/services/avatars.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Avatars extends Service {
 
@@ -28,7 +30,7 @@ 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
@@ -73,7 +75,7 @@ class Avatars extends Service {
      * of image returned is 100x100px.
      * 
      *
-     * @param {string} code
+     * @param {CreditCard} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
@@ -147,7 +149,7 @@ class Avatars extends Service {
      * of image returned is 100x100px.
      * 
      *
-     * @param {string} code
+     * @param {Flag} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality

package/lib/services/databases.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Databases extends Service {
 
@@ -366,6 +368,8 @@ class Databases extends Service {
     /**
      * List attributes
      *
+     * List attributes in the collection.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string[]} queries
@@ -452,6 +456,9 @@ class Databases extends Service {
     /**
      * Update boolean attribute
      *
+     * Update a boolean attribute. Changing the `default` value will not update
+     * already existing documents.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -500,6 +507,8 @@ class Databases extends Service {
     /**
      * Create datetime attribute
      *
+     * Create a date time attribute according to the ISO 8601 standard.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -553,6 +562,9 @@ class Databases extends Service {
     /**
      * Update dateTime attribute
      *
+     * Update a date time attribute. Changing the `default` value will not update
+     * already existing documents.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -709,6 +721,10 @@ class Databases extends Service {
     /**
      * Create enum attribute
      *
+     * Create an enumeration attribute. The `elements` param acts as a white-list
+     * of accepted values for this attribute. 
+     * 
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -1221,11 +1237,11 @@ class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} relatedCollectionId
-     * @param {string} type
+     * @param {RelationshipType} type
      * @param {boolean} twoWay
      * @param {string} key
      * @param {string} twoWayKey
-     * @param {string} onDelete
+     * @param {RelationMutate} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
      */
@@ -1511,6 +1527,8 @@ class Databases extends Service {
     /**
      * Get attribute
      *
+     * Get attribute by ID.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -1541,6 +1559,8 @@ class Databases extends Service {
     /**
      * Delete attribute
      *
+     * Deletes an attribute.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -1578,7 +1598,7 @@ class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {string} onDelete
+     * @param {RelationMutate} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
      */
@@ -1809,6 +1829,8 @@ class Databases extends Service {
     /**
      * List indexes
      *
+     * List indexes in the collection.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string[]} queries
@@ -1839,10 +1861,14 @@ class Databases extends Service {
     /**
      * Create index
      *
+     * Creates an index on the attributes listed. Your index should include all
+     * the attributes you will query in a single request.
+     * Attributes can be `key`, `fulltext`, and `unique`.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {string} type
+     * @param {IndexType} type
      * @param {string[]} attributes
      * @param {string[]} orders
      * @throws {AppwriteException}
@@ -1896,6 +1922,8 @@ class Databases extends Service {
     /**
      * Get index
      *
+     * Get index by ID.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -1926,6 +1954,8 @@ class Databases extends Service {
     /**
      * Delete index
      *
+     * Delete an index.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key

package/lib/services/functions.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Functions extends Service {
 
@@ -52,7 +54,7 @@ class Functions extends Service {
      *
      * @param {string} functionId
      * @param {string} name
-     * @param {string} runtime
+     * @param {Runtime} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
@@ -220,7 +222,7 @@ class Functions extends Service {
      *
      * @param {string} functionId
      * @param {string} name
-     * @param {string} runtime
+     * @param {Runtime} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
@@ -388,6 +390,7 @@ class Functions extends Service {
      * @param {boolean} activate
      * @param {string} entrypoint
      * @param {string} commands
+     * @param {CallableFunction} onProgress
      * @throws {AppwriteException}
      * @returns {Promise}
      */
@@ -423,8 +426,9 @@ class Functions extends Service {
             payload['activate'] = activate.toString();
         }
 
-        const size = code.size;
 
+        const size = code.size;
+        
         const apiHeaders = {
             'content-type': 'multipart/form-data',
         };
@@ -435,118 +439,78 @@ class Functions extends Service {
         let chunksUploaded = 0;
 
 
-        let currentChunk = Buffer.from('');
-        let currentChunkSize = 0;
-        let currentChunkStart = 0;
-
-        const selfClient = this.client;
+        let currentChunk = 1;
+        let currentPosition = 0;
+        let uploadableChunk = new Uint8Array(client.CHUNK_SIZE);
+    
 
-        async function uploadChunk(lastUpload = false) {
-            if(chunksUploaded - 1 >= currentChunkStart / client.CHUNK_SIZE) {
+        const uploadChunk = async (lastUpload = false) => {
+            if(currentChunk <= chunksUploaded) {
                 return;
             }
-            
-            const start = currentChunkStart;
-            const end = currentChunkStart + currentChunkSize - 1;
 
-            if(!lastUpload || currentChunkStart !== 0) {
+            const start = ((currentChunk - 1) * client.CHUNK_SIZE);
+            let end = start + currentPosition - 1;
+
+            if(!lastUpload || currentChunk !== 1) {
                 apiHeaders['content-range'] = 'bytes ' + start + '-' + end + '/' + size;
             }
 
+            let uploadableChunkTrimmed;
+            
+            if(currentPosition + 1 >= client.CHUNK_SIZE) {
+                uploadableChunkTrimmed = uploadableChunk;
+            } else {
+                uploadableChunkTrimmed = new Uint8Array(currentPosition);
+                for(let i = 0; i <= currentPosition; i++) {
+                    uploadableChunkTrimmed[i] = uploadableChunk[i];
+                }
+            }
+
             if (id) {
                 apiHeaders['x-appwrite-id'] = id;
             }
 
-            payload['code'] = {
-                type: 'file',
-                file: currentChunk,
-                filename: code.filename,
-                size: currentChunkSize
-            };
+            payload['code'] = { type: 'file', file: new File([uploadableChunkTrimmed], code.filename), filename: code.filename };
 
-            response = await selfClient.call('post', apiPath, apiHeaders, payload);
+            response = await this.client.call('post', apiPath, apiHeaders, payload);
 
             if (!id) {
                 id = response['$id'];
             }
-            
+
             if (onProgress !== null) {
                 onProgress({
                     $id: response['$id'],
-                    progress: Math.min((start+client.CHUNK_SIZE) * client.CHUNK_SIZE, size) / size * 100,
+                    progress: Math.min((currentChunk) * client.CHUNK_SIZE, size) / size * 100,
                     sizeUploaded: end+1,
                     chunksTotal: response['chunksTotal'],
                     chunksUploaded: response['chunksUploaded']
                 });
             }
 
-            currentChunkStart += client.CHUNK_SIZE;
-        }
-
-        return await new Promise((resolve, reject) => {
-            const writeStream = new Stream.Writable();
-            writeStream._write = async (mainChunk, encoding, callback) => {
-                try {
-                    // Segment incoming chunk into up to 5MB chunks
-                    const mainChunkSize = Buffer.byteLength(mainChunk);
-                    const chunksCount = Math.ceil(mainChunkSize / client.CHUNK_SIZE);
-                    const chunks = [];
-
-                    for(let i = 0; i < chunksCount; i++) {
-                        const chunk = mainChunk.slice(i * client.CHUNK_SIZE, (i + 1) * client.CHUNK_SIZE);
-                        chunks.push(chunk);
-                    }
-
-                    for (const chunk of chunks) {
-                        const chunkSize = Buffer.byteLength(chunk);
-
-                        if(chunkSize + currentChunkSize == client.CHUNK_SIZE) {
-                            // Upload chunk
-                            currentChunk = Buffer.concat([currentChunk, chunk]);
-                            currentChunkSize = Buffer.byteLength(currentChunk);
-                            await uploadChunk();
-                            currentChunk = Buffer.from('');
-                            currentChunkSize = 0;
-                        } else if(chunkSize + currentChunkSize > client.CHUNK_SIZE) {
-                            // Upload chunk, put rest into next chunk
-                            const bytesToUpload = client.CHUNK_SIZE - currentChunkSize;
-                            const newChunkSection = chunk.slice(0, bytesToUpload);
-                            currentChunk = Buffer.concat([currentChunk, newChunkSection]);
-                            currentChunkSize = Buffer.byteLength(currentChunk);
-                            await uploadChunk();
-                            currentChunk = chunk.slice(bytesToUpload, undefined);
-                            currentChunkSize = chunkSize - bytesToUpload;
-                        } else {
-                            // Append into current chunk
-                            currentChunk = Buffer.concat([currentChunk, chunk]);
-                            currentChunkSize = chunkSize + currentChunkSize;
-                        }
-                    }
-
-                    callback();
-                } catch (e) {
-                    callback(e);
+            uploadableChunk = new Uint8Array(client.CHUNK_SIZE);
+            currentChunk++;
+            currentPosition = 0;
+        }
+
+        for await (const chunk of code.stream) {
+            for(const b of chunk) {
+                uploadableChunk[currentPosition] = b;
+
+                currentPosition++;
+                if(currentPosition >= client.CHUNK_SIZE) {
+                    await uploadChunk();
+                    currentPosition = 0;
                 }
             }
+        }
 
-            writeStream.on("finish", async () => {
-                if(currentChunkSize > 0) {
-                    try {
-                        await uploadChunk(true);
-                    } catch (e) {
-                        reject(e);
-                    }
-                }
-                
-                resolve(response);
-            });
+        if (currentPosition > 0) { // Check if there's any remaining data for the last chunk
+            await uploadChunk(true);
+        }
 
-            writeStream.on("error", (err) => {
-                reject(err);
-            });
-            
-            code.stream.pipe(writeStream);
-        });
+        return response;
 
     }
 
@@ -739,7 +703,7 @@ 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}

package/lib/services/graphql.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Graphql extends Service {
 

package/lib/services/health.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Health extends Service {
 
@@ -66,6 +68,28 @@ class Health extends Service {
         }, payload);
     }
 
+    /**
+     * Get the SSL certificate for a domain
+     *
+     * Get the SSL certificate for a domain
+     *
+     * @param {string} domain
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getCertificate(domain) {
+        const apiPath = '/health/certificate';
+        let payload = {};
+
+        if (typeof domain !== 'undefined') {
+            payload['domain'] = domain;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get DB
      *
@@ -216,9 +240,40 @@ class Health extends Service {
         }, payload);
     }
 
+    /**
+     * Get number of failed queue jobs
+     *
+     * Returns the amount of failed jobs in a given queue.
+     * 
+     *
+     * @param {Name} name
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getFailedJobs(name, threshold) {
+        const apiPath = '/health/queue/failed/{name}'.replace('{name}', name);
+        let payload = {};
+        if (typeof name === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "name"');
+        }
+
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get functions queue
      *
+     * Get the number of function executions that are waiting to be processed in
+     * the Appwrite internal queue server.
+     *
      * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -328,6 +383,52 @@ class Health extends Service {
         }, payload);
     }
 
+    /**
+     * Get usage queue
+     *
+     * Get the number of metrics that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getQueueUsage(threshold) {
+        const apiPath = '/health/queue/usage';
+        let payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get usage dump queue
+     *
+     * Get the number of projects containing metrics that are waiting to be
+     * processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getQueueUsageDump(threshold) {
+        const apiPath = '/health/queue/usage-dump';
+        let payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get webhooks queue
      *
@@ -351,6 +452,23 @@ class Health extends Service {
         }, payload);
     }
 
+    /**
+     * Get storage
+     *
+     * Check the Appwrite storage device is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getStorage() {
+        const apiPath = '/health/storage';
+        let payload = {};
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get local storage
      *

package/lib/services/locale.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Locale extends Service {