@appwrite.io/console 0.1.0 → 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',
+                'x-sdk-version': '0.1.1',
                 'X-Appwrite-Response-Format': '1.0.0',
             };
             this.realtime = {
@@ -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);
@@ -2727,7 +2757,7 @@
          * 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
@@ -3040,7 +3070,7 @@
          * 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
@@ -7823,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/console/variables.md

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

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",
+  "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',
+        '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

@@ -2545,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 'enabled' by default, to disable the usage stats set the value to 'disabled'.
+         */
+        _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/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"');
             }
@@ -1243,7 +1243,7 @@ export 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
@@ -1388,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"');
             }
@@ -1498,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"');
             }
@@ -1604,7 +1604,7 @@ export 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

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';

package/types/models.d.ts

@@ -2545,4 +2545,25 @@ export declare namespace Models {
          */
         buckets: Metric[];
     };
+    /**
+     * Console Variables
+     */
+    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 'enabled' by default, to disable the usage stats set the value to 'disabled'.
+         */
+        _APP_USAGE_STATS: string;
+    };
 }

package/types/query.d.ts

@@ -8,6 +8,12 @@ export declare class Query {
     static lessThanEqual: (attribute: string, value: QueryTypes) => string;
     static greaterThan: (attribute: string, value: QueryTypes) => string;
     static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
+    static isNull: (attribute: string) => string;
+    static isNotNull: (attribute: string) => string;
+    static between: (attribute: string, start: string | number, end: string | number) => string;
+    static startsWith: (attribute: string, value: string) => string;
+    static endsWith: (attribute: string, value: string) => string;
+    static select: (attributes: string[]) => string;
     static search: (attribute: string, value: string) => string;
     static orderDesc: (attribute: string) => string;
     static orderAsc: (attribute: string) => string;

package/types/services/console.d.ts

@@ -0,0 +1,15 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Console extends Service {
+    constructor(client: Client);
+    /**
+     * Get Variables
+     *
+     * Get all Environment Variables that are relevant for the console.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    variables(): Promise<Models.ConsoleVariables>;
+}

package/types/services/databases.d.ts

@@ -176,7 +176,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: boolean): Promise<Models.AttributeBoolean>;
+    updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise<Models.AttributeBoolean>;
     /**
      * Create DateTime Attribute
      *
@@ -203,7 +203,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeDatetime>;
+    updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeDatetime>;
     /**
      * Create Email Attribute
      *
@@ -235,7 +235,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeEmail>;
+    updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeEmail>;
     /**
      * Create Enum Attribute
      *
@@ -267,7 +267,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault: string): Promise<Models.AttributeEnum>;
+    updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise<Models.AttributeEnum>;
     /**
      * Create Float Attribute
      *
@@ -304,7 +304,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault: number): Promise<Models.AttributeFloat>;
+    updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeFloat>;
     /**
      * Create Integer Attribute
      *
@@ -341,7 +341,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault: number): Promise<Models.AttributeInteger>;
+    updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeInteger>;
     /**
      * Create IP Address Attribute
      *
@@ -373,12 +373,12 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeIp>;
+    updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeIp>;
     /**
      * 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
@@ -425,7 +425,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeString>;
+    updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeString>;
     /**
      * Create URL Attribute
      *
@@ -457,7 +457,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeUrl>;
+    updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeUrl>;
     /**
      * Get Attribute
      *
@@ -484,7 +484,7 @@ export declare 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