@appwrite.io/console 0.1.0-preview-0.1 → 0.1.1

package/dist/iife/sdk.js

@@ -55,6 +55,12 @@
     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}")`;
@@ -96,7 +102,7 @@
                 'x-sdk-name': 'Console',
                 'x-sdk-platform': 'console',
                 'x-sdk-language': 'web',
-                'x-sdk-version': '0.1.0-preview-0.1',
+                'x-sdk-version': '0.1.1',
                 'X-Appwrite-Response-Format': '1.0.0',
             };
             this.realtime = {
@@ -881,7 +887,7 @@
          * password combination. This route will create a new session for the user.
          *
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} email
          * @param {string} password
@@ -926,7 +932,7 @@
          * your Appwrite instance by default.
          *
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} userId
          * @param {string} email
@@ -1017,7 +1023,7 @@
          * user.
          *
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          *
          * @param {string} provider
@@ -1065,7 +1071,7 @@
          * is valid for 15 minutes.
          *
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} userId
          * @param {string} phone
@@ -1646,6 +1652,30 @@
         }
     }
 
+    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);
@@ -2724,7 +2754,10 @@
             });
         }
         /**
-         * Create relationship Attribute
+         * Create Relationship Attribute
+         *
+         * Create relationship attribute. [Learn more about relationship
+         * attributes](/docs/databases-relationships#relationship-attributes).
          *
          *
          * @param {string} databaseId
@@ -3036,16 +3069,18 @@
         /**
          * Update Relationship Attribute
          *
+         * Update relationship attribute. [Learn more about relationship
+         * attributes](/docs/databases-relationships#relationship-attributes).
+         *
          *
          * @param {string} databaseId
          * @param {string} collectionId
          * @param {string} key
-         * @param {boolean} twoWay
          * @param {string} onDelete
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        updateRelationshipAttribute(databaseId, collectionId, key, twoWay, onDelete) {
+        updateRelationshipAttribute(databaseId, collectionId, key, onDelete) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof databaseId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "databaseId"');
@@ -3058,9 +3093,6 @@
                 }
                 let path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
                 let payload = {};
-                if (typeof twoWay !== 'undefined') {
-                    payload['twoWay'] = twoWay;
-                }
                 if (typeof onDelete !== 'undefined') {
                     payload['onDelete'] = onDelete;
                 }
@@ -7821,6 +7853,7 @@
     exports.AppwriteException = AppwriteException;
     exports.Avatars = Avatars;
     exports.Client = Client;
+    exports.Console = Console;
     exports.Databases = Databases;
     exports.Functions = Functions;
     exports.Graphql = Graphql;

package/docs/examples/{teams/update.md → console/variables.md}

@@ -1,15 +1,15 @@
-import { Client, Teams } from "appwrite";
+import { Client, Console } from "@appwrite.io/console";
 
 const client = new Client();
 
-const teams = new Teams(client);
+const console = new Console(client);
 
 client
     .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-const promise = teams.update('[TEAM_ID]', '[NAME]');
+const promise = console.variables();
 
 promise.then(function (response) {
     console.log(response); // Success

package/docs/examples/databases/create-relationship-attribute.md

@@ -9,7 +9,7 @@ client
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-const promise = databases.createRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'onetoone');
+const promise = databases.createRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'oneToOne');
 
 promise.then(function (response) {
     console.log(response); // Success

package/package.json

@@ -2,7 +2,7 @@
   "name": "@appwrite.io/console",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "0.1.0-preview-0.1",
+  "version": "0.1.1",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/src/client.ts

@@ -104,7 +104,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '0.1.0-preview-0.1',
+        'x-sdk-version': '0.1.1',
         'X-Appwrite-Response-Format': '1.0.0',
     };
 

package/src/index.ts

@@ -1,6 +1,7 @@
 export { Client, Query, AppwriteException } from './client';
 export { Account } from './services/account';
 export { Avatars } from './services/avatars';
+export { Console } from './services/console';
 export { Databases } from './services/databases';
 export { Functions } from './services/functions';
 export { Graphql } from './services/graphql';

package/src/models.ts

@@ -746,11 +746,11 @@ export namespace Models {
          */
         array?: boolean;
         /**
-         * The Id of the related collection
+         * The ID of the related collection.
          */
         relatedCollection: string;
         /**
-         * The type of the relationship
+         * The type of the relationship.
          */
         relationType: string;
         /**
@@ -758,13 +758,17 @@ export namespace Models {
          */
         twoWay: boolean;
         /**
-         * The key of the two-way relationship
+         * The key of the two-way relationship.
          */
         twoWayKey: string;
         /**
-         * Action to take on related documents when parent document is deleted
+         * How deleting the parent document will propagate to child documents.
          */
         onDelete: string;
+        /**
+         * Whether this is the parent or child side of the relationship
+         */
+        side: string;
     }
     /**
      * Index
@@ -933,15 +937,15 @@ export namespace Models {
         /**
          * Hashed user password.
          */
-        password: string;
+        password?: string;
         /**
          * Password hashing algorithm.
          */
-        hash: string;
+        hash?: string;
         /**
          * Password hashing algorithm configuration.
          */
-        hashOptions: object;
+        hashOptions?: object;
         /**
          * User registration date in ISO 8601 format.
          */
@@ -1078,59 +1082,6 @@ export namespace Models {
          */
         threads: number;
     }
-    /**
-     * Account
-     */
-    export type Account<Preferences extends Models.Preferences> = {
-        /**
-         * User ID.
-         */
-        $id: string;
-        /**
-         * User creation date in ISO 8601 format.
-         */
-        $createdAt: string;
-        /**
-         * User update date in ISO 8601 format.
-         */
-        $updatedAt: string;
-        /**
-         * User name.
-         */
-        name: string;
-        /**
-         * User registration date in ISO 8601 format.
-         */
-        registration: string;
-        /**
-         * User status. Pass `true` for enabled and `false` for disabled.
-         */
-        status: boolean;
-        /**
-         * Password update time in ISO 8601 format.
-         */
-        passwordUpdate: string;
-        /**
-         * User email address.
-         */
-        email: string;
-        /**
-         * User phone number in E.164 format.
-         */
-        phone: string;
-        /**
-         * Email verification status.
-         */
-        emailVerification: boolean;
-        /**
-         * Phone verification status.
-         */
-        phoneVerification: boolean;
-        /**
-         * User preferences as a key-value object
-         */
-        prefs: Preferences;
-    }
     /**
      * Preferences
      */
@@ -2594,4 +2545,25 @@ export namespace Models {
          */
         buckets: Metric[];
     }
+    /**
+     * Console Variables
+     */
+    export type ConsoleVariables = {
+        /**
+         * CNAME target for your Appwrite custom domains.
+         */
+        _APP_DOMAIN_TARGET: string;
+        /**
+         * Maximum file size allowed for file upload in bytes.
+         */
+        _APP_STORAGE_LIMIT: number;
+        /**
+         * Maximum file size allowed for deployment in bytes.
+         */
+        _APP_FUNCTIONS_SIZE_LIMIT: number;
+        /**
+         * Defines if usage stats are enabled. This value is set to &#039;enabled&#039; by default, to disable the usage stats set the value to &#039;disabled&#039;.
+         */
+        _APP_USAGE_STATS: string;
+    }
 }

package/src/query.ts

@@ -21,6 +21,24 @@ export class Query {
   static greaterThanEqual = (attribute: string, value: QueryTypes): string =>
     Query.addQuery(attribute, "greaterThanEqual", value);
 
+  static isNull = (attribute: string): string =>
+    `isNull("${attribute}")`;
+
+  static isNotNull = (attribute: string): string =>
+    `isNotNull("${attribute}")`;
+
+  static between = (attribute: string, start: string|number, end: string|number): string =>
+    `between("${attribute}", [${Query.parseValues(start)},${Query.parseValues(end)}])`;
+
+  static startsWith = (attribute: string, value: string): string =>
+    Query.addQuery(attribute, "startsWith", value);
+
+  static endsWith = (attribute: string, value: string): string =>
+    Query.addQuery(attribute, "endsWith", value);
+
+  static select = (attributes: string[]): string =>
+    `select([${attributes.map((attr: string) => `"${attr}"`).join(",")}])`;
+
   static search = (attribute: string, value: string): string =>
     Query.addQuery(attribute, "search", value);
 

package/src/services/account.ts

@@ -211,7 +211,7 @@ export class Account extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.Account<Preferences>> {
+        async updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>> {
             if (typeof password === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "password"');
             }
@@ -493,7 +493,7 @@ export class Account extends Service {
          * password combination. This route will create a new session for the user.
          * 
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} email
          * @param {string} password
@@ -542,7 +542,7 @@ export class Account extends Service {
          * your Appwrite instance by default.
          * 
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} userId
          * @param {string} email
@@ -642,7 +642,7 @@ export class Account extends Service {
          * user.
          * 
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          * 
          *
          * @param {string} provider
@@ -697,7 +697,7 @@ export class Account extends Service {
          * is valid for 15 minutes.
          * 
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} userId
          * @param {string} phone
@@ -855,7 +855,7 @@ export class Account extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateStatus<Preferences extends Models.Preferences>(): Promise<Models.Account<Preferences>> {
+        async updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>> {
             let path = '/account/status';
             let payload: Payload = {};
 

package/src/services/console.ts

@@ -0,0 +1,30 @@
+import { Service } from '../service';
+import { AppwriteException, Client } from '../client';
+import type { Models } from '../models';
+import type { UploadProgress, Payload } from '../client';
+
+export class Console extends Service {
+
+     constructor(client: Client)
+     {
+        super(client);
+     }
+
+        /**
+         * Get Variables
+         *
+         * Get all Environment Variables that are relevant for the console.
+         *
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        async variables(): Promise<Models.ConsoleVariables> {
+            let path = '/console/variables';
+            let payload: Payload = {};
+
+            const uri = new URL(this.client.config.endpoint + path);
+            return await this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        }
+};

package/src/services/databases.ts

@@ -472,7 +472,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: boolean): Promise<Models.AttributeBoolean> {
+        async updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise<Models.AttributeBoolean> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -577,7 +577,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeDatetime> {
+        async updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeDatetime> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -687,7 +687,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeEmail> {
+        async updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeEmail> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -805,7 +805,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault: string): Promise<Models.AttributeEnum> {
+        async updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise<Models.AttributeEnum> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -936,7 +936,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault: number): Promise<Models.AttributeFloat> {
+        async updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeFloat> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1075,7 +1075,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault: number): Promise<Models.AttributeInteger> {
+        async updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeInteger> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1201,7 +1201,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeIp> {
+        async updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeIp> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1240,8 +1240,11 @@ export class Databases extends Service {
         }
 
         /**
-         * Create relationship Attribute
+         * Create Relationship Attribute
          *
+         * Create relationship attribute. [Learn more about relationship
+         * attributes](/docs/databases-relationships#relationship-attributes).
+         * 
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -1385,7 +1388,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeString> {
+        async updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeString> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1495,7 +1498,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeUrl> {
+        async updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeUrl> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1600,16 +1603,18 @@ export class Databases extends Service {
         /**
          * Update Relationship Attribute
          *
+         * Update relationship attribute. [Learn more about relationship
+         * attributes](/docs/databases-relationships#relationship-attributes).
+         * 
          *
          * @param {string} databaseId
          * @param {string} collectionId
          * @param {string} key
-         * @param {boolean} twoWay
          * @param {string} onDelete
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, twoWay?: boolean, onDelete?: string): Promise<Models.AttributeRelationship> {
+        async updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1625,10 +1630,6 @@ export class Databases extends Service {
             let path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
             let payload: Payload = {};
 
-            if (typeof twoWay !== 'undefined') {
-                payload['twoWay'] = twoWay;
-            }
-
             if (typeof onDelete !== 'undefined') {
                 payload['onDelete'] = onDelete;
             }

package/types/index.d.ts

@@ -1,6 +1,7 @@
 export { Client, Query, AppwriteException } from './client';
 export { Account } from './services/account';
 export { Avatars } from './services/avatars';
+export { Console } from './services/console';
 export { Databases } from './services/databases';
 export { Functions } from './services/functions';
 export { Graphql } from './services/graphql';