node-appwrite 4.0.1 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/README.md +2 -2
  2. package/docs/examples/account/update-session.md +20 -0
  3. package/docs/examples/functions/{create-tag.md → create-deployment.md} +1 -1
  4. package/docs/examples/functions/{delete-tag.md → delete-deployment.md} +1 -1
  5. package/docs/examples/functions/{update-tag.md → get-deployment.md} +1 -1
  6. package/docs/examples/functions/{list-tags.md → list-deployments.md} +1 -1
  7. package/docs/examples/functions/retry-build.md +20 -0
  8. package/docs/examples/functions/{get-tag.md → update-deployment.md} +1 -1
  9. package/docs/examples/storage/create-bucket.md +20 -0
  10. package/docs/examples/storage/create-file.md +1 -1
  11. package/docs/examples/storage/delete-bucket.md +20 -0
  12. package/docs/examples/storage/delete-file.md +1 -1
  13. package/docs/examples/storage/get-bucket.md +20 -0
  14. package/docs/examples/storage/get-file-download.md +1 -1
  15. package/docs/examples/storage/get-file-preview.md +1 -1
  16. package/docs/examples/storage/get-file-view.md +1 -1
  17. package/docs/examples/storage/get-file.md +1 -1
  18. package/docs/examples/storage/list-buckets.md +20 -0
  19. package/docs/examples/storage/list-files.md +1 -1
  20. package/docs/examples/storage/update-bucket.md +20 -0
  21. package/docs/examples/storage/update-file.md +1 -1
  22. package/index.d.ts +412 -152
  23. package/lib/client.js +7 -5
  24. package/lib/exception.js +2 -1
  25. package/lib/query.js +2 -0
  26. package/lib/services/account.js +28 -3
  27. package/lib/services/avatars.js +3 -0
  28. package/lib/services/database.js +6 -3
  29. package/lib/services/functions.js +212 -117
  30. package/lib/services/health.js +3 -0
  31. package/lib/services/locale.js +3 -0
  32. package/lib/services/storage.js +390 -33
  33. package/lib/services/teams.js +7 -0
  34. package/lib/services/users.js +6 -2
  35. package/package.json +2 -2
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # Appwrite Node.js SDK
2
2
 
3
3
  ![License](https://img.shields.io/github/license/appwrite/sdk-for-node.svg?style=flat-square)
4
- ![Version](https://img.shields.io/badge/api%20version-0.12.0-blue.svg?style=flat-square)
4
+ ![Version](https://img.shields.io/badge/api%20version-0.13.0-blue.svg?style=flat-square)
5
5
  [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
6
6
  [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
7
7
  [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
8
8
 
9
- **This SDK is compatible with Appwrite server version 0.12.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
9
+ **This SDK is compatible with Appwrite server version 0.13.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
10
10
 
11
11
  > This is the Node.js SDK for integrating with Appwrite from your Node.js server-side code.
12
12
  If you're looking to integrate from the browser, you should check [appwrite/sdk-for-web](https://github.com/appwrite/sdk-for-web)
@@ -0,0 +1,20 @@
1
+ const sdk = require('node-appwrite');
2
+
3
+ // Init SDK
4
+ let client = new sdk.Client();
5
+
6
+ let account = new sdk.Account(client);
7
+
8
+ client
9
+ .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
10
+ .setProject('5df5acd0d48c2') // Your project ID
11
+ .setJWT('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') // Your secret JSON Web Token
12
+ ;
13
+
14
+ let promise = account.updateSession('[SESSION_ID]');
15
+
16
+ promise.then(function (response) {
17
+ console.log(response);
18
+ }, function (error) {
19
+ console.log(error);
20
+ });
@@ -12,7 +12,7 @@ client
12
12
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
13
13
  ;
14
14
 
15
- let promise = functions.createTag('[FUNCTION_ID]', '[COMMAND]', fs.createReadStream(__dirname + '/file.png'));
15
+ let promise = functions.createDeployment('[FUNCTION_ID]', '[ENTRYPOINT]', fs.createReadStream(__dirname + '/file.png'), false);
16
16
 
17
17
  promise.then(function (response) {
18
18
  console.log(response);
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = functions.deleteTag('[FUNCTION_ID]', '[TAG_ID]');
14
+ let promise = functions.deleteDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = functions.updateTag('[FUNCTION_ID]', '[TAG]');
14
+ let promise = functions.getDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = functions.listTags('[FUNCTION_ID]');
14
+ let promise = functions.listDeployments('[FUNCTION_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -0,0 +1,20 @@
1
+ const sdk = require('node-appwrite');
2
+
3
+ // Init SDK
4
+ let client = new sdk.Client();
5
+
6
+ let functions = new sdk.Functions(client);
7
+
8
+ client
9
+ .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
10
+ .setProject('5df5acd0d48c2') // Your project ID
11
+ .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
+ ;
13
+
14
+ let promise = functions.retryBuild('[FUNCTION_ID]', '[DEPLOYMENT_ID]', '[BUILD_ID]');
15
+
16
+ promise.then(function (response) {
17
+ console.log(response);
18
+ }, function (error) {
19
+ console.log(error);
20
+ });
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = functions.getTag('[FUNCTION_ID]', '[TAG_ID]');
14
+ let promise = functions.updateDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -0,0 +1,20 @@
1
+ const sdk = require('node-appwrite');
2
+
3
+ // Init SDK
4
+ let client = new sdk.Client();
5
+
6
+ let storage = new sdk.Storage(client);
7
+
8
+ client
9
+ .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
10
+ .setProject('5df5acd0d48c2') // Your project ID
11
+ .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
+ ;
13
+
14
+ let promise = storage.createBucket('[BUCKET_ID]', '[NAME]', 'file');
15
+
16
+ promise.then(function (response) {
17
+ console.log(response);
18
+ }, function (error) {
19
+ console.log(error);
20
+ });
@@ -12,7 +12,7 @@ client
12
12
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
13
13
  ;
14
14
 
15
- let promise = storage.createFile('[FILE_ID]', fs.createReadStream(__dirname + '/file.png'));
15
+ let promise = storage.createFile('[BUCKET_ID]', '[FILE_ID]', fs.createReadStream(__dirname + '/file.png'));
16
16
 
17
17
  promise.then(function (response) {
18
18
  console.log(response);
@@ -0,0 +1,20 @@
1
+ const sdk = require('node-appwrite');
2
+
3
+ // Init SDK
4
+ let client = new sdk.Client();
5
+
6
+ let storage = new sdk.Storage(client);
7
+
8
+ client
9
+ .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
10
+ .setProject('5df5acd0d48c2') // Your project ID
11
+ .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
+ ;
13
+
14
+ let promise = storage.deleteBucket('[BUCKET_ID]');
15
+
16
+ promise.then(function (response) {
17
+ console.log(response);
18
+ }, function (error) {
19
+ console.log(error);
20
+ });
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = storage.deleteFile('[FILE_ID]');
14
+ let promise = storage.deleteFile('[BUCKET_ID]', '[FILE_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -0,0 +1,20 @@
1
+ const sdk = require('node-appwrite');
2
+
3
+ // Init SDK
4
+ let client = new sdk.Client();
5
+
6
+ let storage = new sdk.Storage(client);
7
+
8
+ client
9
+ .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
10
+ .setProject('5df5acd0d48c2') // Your project ID
11
+ .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
+ ;
13
+
14
+ let promise = storage.getBucket('[BUCKET_ID]');
15
+
16
+ promise.then(function (response) {
17
+ console.log(response);
18
+ }, function (error) {
19
+ console.log(error);
20
+ });
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = storage.getFileDownload('[FILE_ID]');
14
+ let promise = storage.getFileDownload('[BUCKET_ID]', '[FILE_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = storage.getFilePreview('[FILE_ID]');
14
+ let promise = storage.getFilePreview('[BUCKET_ID]', '[FILE_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = storage.getFileView('[FILE_ID]');
14
+ let promise = storage.getFileView('[BUCKET_ID]', '[FILE_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = storage.getFile('[FILE_ID]');
14
+ let promise = storage.getFile('[BUCKET_ID]', '[FILE_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -0,0 +1,20 @@
1
+ const sdk = require('node-appwrite');
2
+
3
+ // Init SDK
4
+ let client = new sdk.Client();
5
+
6
+ let storage = new sdk.Storage(client);
7
+
8
+ client
9
+ .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
10
+ .setProject('5df5acd0d48c2') // Your project ID
11
+ .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
+ ;
13
+
14
+ let promise = storage.listBuckets();
15
+
16
+ promise.then(function (response) {
17
+ console.log(response);
18
+ }, function (error) {
19
+ console.log(error);
20
+ });
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = storage.listFiles();
14
+ let promise = storage.listFiles('[BUCKET_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);
@@ -0,0 +1,20 @@
1
+ const sdk = require('node-appwrite');
2
+
3
+ // Init SDK
4
+ let client = new sdk.Client();
5
+
6
+ let storage = new sdk.Storage(client);
7
+
8
+ client
9
+ .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
10
+ .setProject('5df5acd0d48c2') // Your project ID
11
+ .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
+ ;
13
+
14
+ let promise = storage.updateBucket('[BUCKET_ID]', '[NAME]', 'file');
15
+
16
+ promise.then(function (response) {
17
+ console.log(response);
18
+ }, function (error) {
19
+ console.log(error);
20
+ });
@@ -11,7 +11,7 @@ client
11
11
  .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
12
12
  ;
13
13
 
14
- let promise = storage.updateFile('[FILE_ID]', [], []);
14
+ let promise = storage.updateFile('[BUCKET_ID]', '[FILE_ID]');
15
15
 
16
16
  promise.then(function (response) {
17
17
  console.log(response);