npm - @appwrite.io/console - Versions diffs - 0.1.0 → 0.2.0 - Mend

@appwrite.io/console 0.1.0 → 0.2.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 (37) hide show

package/.github/workflows/publish.yml +18 -0
package/README.md +5 -5
package/dist/cjs/sdk.js +155 -36
package/dist/cjs/sdk.js.map +1 -1
package/dist/esm/sdk.js +154 -37
package/dist/esm/sdk.js.map +1 -1
package/dist/iife/sdk.js +155 -36
package/docs/examples/account/create-with-invite-code.md +18 -0
package/docs/examples/console/variables.md +18 -0
package/docs/examples/health/get-pub-sub.md +18 -0
package/docs/examples/health/get-queue.md +18 -0
package/docs/examples/{projects → project}/get-usage.md +3 -3
package/package.json +1 -1
package/src/client.ts +1 -1
package/src/index.ts +2 -0
package/src/models.ts +117 -215
package/src/query.ts +18 -0
package/src/services/account.ts +60 -0
package/src/services/console.ts +30 -0
package/src/services/databases.ts +11 -11
package/src/services/health.ts +39 -2
package/src/services/project.ts +34 -0
package/src/services/projects.ts +0 -27
package/src/services/storage.ts +1 -1
package/src/services/users.ts +1 -6
package/types/index.d.ts +2 -0
package/types/models.d.ts +117 -215
package/types/query.d.ts +6 -0
package/types/services/account.d.ts +19 -0
package/types/services/console.d.ts +15 -0
package/types/services/databases.d.ts +11 -11
package/types/services/health.d.ts +21 -2
package/types/services/project.d.ts +15 -0
package/types/services/projects.d.ts +0 -10
package/types/services/storage.d.ts +1 -1
package/types/services/users.d.ts +1 -2
package/.travis.yml +0 -32

package/.github/workflows/publish.yml ADDED Viewed

@@ -0,0 +1,18 @@
+name: Publish Package to npmjs
+on:
+    release:
+        types: [published]
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: "16.x"
+                  registry-url: "https://registry.npmjs.org"
+            - run: npm install
+            - run: npm run build
+            - run: npm publish
+              env:
+                NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md CHANGED Viewed

@@ -1,12 +1,12 @@
 # Appwrite Console SDK
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.2.1-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.3.8-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
-**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
+**This SDK is compatible with Appwrite server version 1.3.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
 Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Console SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
@@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console";
 To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@0.1.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@0.2.0"></script>
 ```
@@ -96,10 +96,10 @@ account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe')
 ### Learn more
 You can use the following resources to learn more and get help
-- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-flutter)
+- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-web)
 - 📜 [Appwrite Docs](https://appwrite.io/docs)
 - 💬 [Discord Community](https://appwrite.io/discord)
-- 🚂 [Appwrite Flutter Playground](https://github.com/appwrite/playground-for-flutter)
+- 🚂 [Appwrite Web Playground](https://github.com/appwrite/playground-for-web)
 ## Contribution

package/dist/cjs/sdk.js CHANGED Viewed

@@ -57,6 +57,12 @@ Query.lessThan = (attribute, value) => Query.addQuery(attribute, "lessThan", val
 Query.lessThanEqual = (attribute, value) => Query.addQuery(attribute, "lessThanEqual", value);
 Query.greaterThan = (attribute, value) => Query.addQuery(attribute, "greaterThan", value);
 Query.greaterThanEqual = (attribute, value) => Query.addQuery(attribute, "greaterThanEqual", value);
+Query.isNull = (attribute) => `isNull("${attribute}")`;
+Query.isNotNull = (attribute) => `isNotNull("${attribute}")`;
+Query.between = (attribute, start, end) => `between("${attribute}", [${Query.parseValues(start)},${Query.parseValues(end)}])`;
+Query.startsWith = (attribute, value) => Query.addQuery(attribute, "startsWith", value);
+Query.endsWith = (attribute, value) => Query.addQuery(attribute, "endsWith", value);
+Query.select = (attributes) => `select([${attributes.map((attr) => `"${attr}"`).join(",")}])`;
 Query.search = (attribute, value) => Query.addQuery(attribute, "search", value);
 Query.orderDesc = (attribute) => `orderDesc("${attribute}")`;
 Query.orderAsc = (attribute) => `orderAsc("${attribute}")`;
@@ -98,7 +104,7 @@ class Client {
             'x-sdk-name': 'Console',
             'x-sdk-platform': 'console',
             'x-sdk-language': 'web',
-            'x-sdk-version': '0.1.0',
+            'x-sdk-version': '0.2.0',
             'X-Appwrite-Response-Format': '1.0.0',
         };
         this.realtime = {
@@ -540,6 +546,58 @@ class Account extends Service {
             }, payload);
         });
     }
+    /**
+     * Create account using an invite code
+     *
+     * Use this endpoint to allow a new user to register a new account in your
+     * project. After the user registration completes successfully, you can use
+     * the [/account/verfication](/docs/client/account#accountCreateVerification)
+     * route to start verifying the user email address. To allow the new user to
+     * login to their new account, you need to create a new [account
+     * session](/docs/client/account#accountCreateSession).
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @param {string} name
+     * @param {string} code
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createWithInviteCode(userId, email, password, name, code) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof userId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "userId"');
+            }
+            if (typeof email === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "email"');
+            }
+            if (typeof password === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "password"');
+            }
+            let path = '/account/invite';
+            let payload = {};
+            if (typeof userId !== 'undefined') {
+                payload['userId'] = userId;
+            }
+            if (typeof email !== 'undefined') {
+                payload['email'] = email;
+            }
+            if (typeof password !== 'undefined') {
+                payload['password'] = password;
+            }
+            if (typeof name !== 'undefined') {
+                payload['name'] = name;
+            }
+            if (typeof code !== 'undefined') {
+                payload['code'] = code;
+            }
+            const uri = new URL(this.client.config.endpoint + path);
+            return yield this.client.call('post', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
     /**
      * Create JWT
      *
@@ -1648,6 +1706,30 @@ class Avatars extends Service {
     }
 }
+class Console extends Service {
+    constructor(client) {
+        super(client);
+    }
+    /**
+     * Get Variables
+     *
+     * Get all Environment Variables that are relevant for the console.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    variables() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let path = '/console/variables';
+            let payload = {};
+            const uri = new URL(this.client.config.endpoint + path);
+            return yield this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
+}
 class Databases extends Service {
     constructor(client) {
         super(client);
@@ -2729,7 +2811,7 @@ class Databases extends Service {
      * Create Relationship Attribute
      *
      * Create relationship attribute. [Learn more about relationship
-     * attributes](docs/databases-relationships#relationship-attributes).
+     * attributes](/docs/databases-relationships#relationship-attributes).
      *
      *
      * @param {string} databaseId
@@ -3042,7 +3124,7 @@ class Databases extends Service {
      * Update Relationship Attribute
      *
      * Update relationship attribute. [Learn more about relationship
-     * attributes](docs/databases-relationships#relationship-attributes).
+     * attributes](/docs/databases-relationships#relationship-attributes).
      *
      *
      * @param {string} databaseId
@@ -4354,7 +4436,7 @@ class Health extends Service {
     /**
      * Get Cache
      *
-     * Check the Appwrite in-memory cache server is up and connection is
+     * Check the Appwrite in-memory cache servers are up and connection is
      * successful.
      *
      * @throws {AppwriteException}
@@ -4373,7 +4455,7 @@ class Health extends Service {
     /**
      * Get DB
      *
-     * Check the Appwrite database server is up and connection is successful.
+     * Check the Appwrite database servers are up and connection is successful.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -4388,6 +4470,43 @@ class Health extends Service {
             }, payload);
         });
     }
+    /**
+     * Get PubSub
+     *
+     * Check the Appwrite pub-sub servers are up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getPubSub() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let path = '/health/pubsub';
+            let payload = {};
+            const uri = new URL(this.client.config.endpoint + path);
+            return yield this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
+    /**
+     * Get Queue
+     *
+     * Check the Appwrite queue messaging servers are up and connection is
+     * successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getQueue() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let path = '/health/queue';
+            let payload = {};
+            const uri = new URL(this.client.config.endpoint + path);
+            return yield this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
     /**
      * Get Certificates Queue
      *
@@ -4651,6 +4770,33 @@ class Locale extends Service {
     }
 }
+class Project extends Service {
+    constructor(client) {
+        super(client);
+    }
+    /**
+     * Get usage stats for a project
+     *
+     *
+     * @param {string} range
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getUsage(range) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let path = '/project/usage';
+            let payload = {};
+            if (typeof range !== 'undefined') {
+                payload['range'] = range;
+            }
+            const uri = new URL(this.client.config.endpoint + path);
+            return yield this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
+}
 class Projects extends Service {
     constructor(client) {
         super(client);
@@ -5557,31 +5703,6 @@ class Projects extends Service {
             }, payload);
         });
     }
-    /**
-     * Get usage stats for a project
-     *
-     *
-     * @param {string} projectId
-     * @param {string} range
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    getUsage(projectId, range) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (typeof projectId === 'undefined') {
-                throw new AppwriteException('Missing required parameter: "projectId"');
-            }
-            let path = '/projects/{projectId}/usage'.replace('{projectId}', projectId);
-            let payload = {};
-            if (typeof range !== 'undefined') {
-                payload['range'] = range;
-            }
-            const uri = new URL(this.client.config.endpoint + path);
-            return yield this.client.call('get', uri, {
-                'content-type': 'application/json',
-            }, payload);
-        });
-    }
     /**
      * List Webhooks
      *
@@ -6369,7 +6490,7 @@ class Storage extends Service {
         });
     }
     /**
-     * Get usage stats for a storage bucket
+     * Get usage stats for storage bucket
      *
      *
      * @param {string} bucketId
@@ -7319,20 +7440,16 @@ class Users extends Service {
      *
      *
      * @param {string} range
-     * @param {string} provider
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    getUsage(range, provider) {
+    getUsage(range) {
         return __awaiter(this, void 0, void 0, function* () {
             let path = '/users/usage';
             let payload = {};
             if (typeof range !== 'undefined') {
                 payload['range'] = range;
             }
-            if (typeof provider !== 'undefined') {
-                payload['provider'] = provider;
-            }
             const uri = new URL(this.client.config.endpoint + path);
             return yield this.client.call('get', uri, {
                 'content-type': 'application/json',
@@ -7825,6 +7942,7 @@ exports.Account = Account;
 exports.AppwriteException = AppwriteException;
 exports.Avatars = Avatars;
 exports.Client = Client;
+exports.Console = Console;
 exports.Databases = Databases;
 exports.Functions = Functions;
 exports.Graphql = Graphql;
@@ -7832,6 +7950,7 @@ exports.Health = Health;
 exports.ID = ID;
 exports.Locale = Locale;
 exports.Permission = Permission;
+exports.Project = Project;
 exports.Projects = Projects;
 exports.Query = Query;
 exports.Role = Role;