@appwrite.io/console 0.6.2 → 0.6.4

package/dist/esm/sdk.js

@@ -47,9 +47,22 @@ class Service {
         return output;
     }
 }
+/**
+ * The size for chunked uploads in bytes.
+ */
 Service.CHUNK_SIZE = 5 * 1024 * 1024; // 5MB
 
+/**
+ * Helper class to generate query strings.
+ */
 class Query {
+    /**
+     * Constructor for Query class.
+     *
+     * @param {string} method
+     * @param {AttributesTypes} attribute
+     * @param {QueryTypes} values
+     */
     constructor(method, attribute, values) {
         this.method = method;
         this.attribute = attribute;
@@ -62,6 +75,11 @@ class Query {
             }
         }
     }
+    /**
+     * Convert the query object to a JSON string.
+     *
+     * @returns {string}
+     */
     toString() {
         return JSON.stringify({
             method: this.method,
@@ -70,30 +88,186 @@ class Query {
         });
     }
 }
+/**
+ * Filter resources where attribute is equal to value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 Query.equal = (attribute, value) => new Query("equal", attribute, value).toString();
+/**
+ * Filter resources where attribute is not equal to value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 Query.notEqual = (attribute, value) => new Query("notEqual", attribute, value).toString();
+/**
+ * Filter resources where attribute is less than value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 Query.lessThan = (attribute, value) => new Query("lessThan", attribute, value).toString();
+/**
+ * Filter resources where attribute is less than or equal to value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 Query.lessThanEqual = (attribute, value) => new Query("lessThanEqual", attribute, value).toString();
+/**
+ * Filter resources where attribute is greater than value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 Query.greaterThan = (attribute, value) => new Query("greaterThan", attribute, value).toString();
+/**
+ * Filter resources where attribute is greater than or equal to value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 Query.greaterThanEqual = (attribute, value) => new Query("greaterThanEqual", attribute, value).toString();
+/**
+ * Filter resources where attribute is null.
+ *
+ * @param {string} attribute
+ * @returns {string}
+ */
 Query.isNull = (attribute) => new Query("isNull", attribute).toString();
+/**
+ * Filter resources where attribute is not null.
+ *
+ * @param {string} attribute
+ * @returns {string}
+ */
 Query.isNotNull = (attribute) => new Query("isNotNull", attribute).toString();
+/**
+ * Filter resources where attribute is between start and end (inclusive).
+ *
+ * @param {string} attribute
+ * @param {string | number} start
+ * @param {string | number} end
+ * @returns {string}
+ */
 Query.between = (attribute, start, end) => new Query("between", attribute, [start, end]).toString();
+/**
+ * Filter resources where attribute starts with value.
+ *
+ * @param {string} attribute
+ * @param {string} value
+ * @returns {string}
+ */
 Query.startsWith = (attribute, value) => new Query("startsWith", attribute, value).toString();
+/**
+ * Filter resources where attribute ends with value.
+ *
+ * @param {string} attribute
+ * @param {string} value
+ * @returns {string}
+ */
 Query.endsWith = (attribute, value) => new Query("endsWith", attribute, value).toString();
+/**
+ * Specify which attributes should be returned by the API call.
+ *
+ * @param {string[]} attributes
+ * @returns {string}
+ */
 Query.select = (attributes) => new Query("select", undefined, attributes).toString();
+/**
+ * Filter resources by searching attribute for value.
+ * A fulltext index on attribute is required for this query to work.
+ *
+ * @param {string} attribute
+ * @param {string} value
+ * @returns {string}
+ */
 Query.search = (attribute, value) => new Query("search", attribute, value).toString();
+/**
+ * Sort results by attribute descending.
+ *
+ * @param {string} attribute
+ * @returns {string}
+ */
 Query.orderDesc = (attribute) => new Query("orderDesc", attribute).toString();
+/**
+ * Sort results by attribute ascending.
+ *
+ * @param {string} attribute
+ * @returns {string}
+ */
 Query.orderAsc = (attribute) => new Query("orderAsc", attribute).toString();
+/**
+ * Return results after documentId.
+ *
+ * @param {string} documentId
+ * @returns {string}
+ */
 Query.cursorAfter = (documentId) => new Query("cursorAfter", undefined, documentId).toString();
+/**
+ * Return results before documentId.
+ *
+ * @param {string} documentId
+ * @returns {string}
+ */
 Query.cursorBefore = (documentId) => new Query("cursorBefore", undefined, documentId).toString();
+/**
+ * Return only limit results.
+ *
+ * @param {number} limit
+ * @returns {string}
+ */
 Query.limit = (limit) => new Query("limit", undefined, limit).toString();
+/**
+ * Filter resources by skipping the first offset results.
+ *
+ * @param {number} offset
+ * @returns {string}
+ */
 Query.offset = (offset) => new Query("offset", undefined, offset).toString();
+/**
+ * Filter resources where attribute contains the specified value.
+ *
+ * @param {string} attribute
+ * @param {string | string[]} value
+ * @returns {string}
+ */
 Query.contains = (attribute, value) => new Query("contains", attribute, value).toString();
+/**
+ * Combine multiple queries using logical OR operator.
+ *
+ * @param {string[]} queries
+ * @returns {string}
+ */
 Query.or = (queries) => new Query("or", undefined, queries.map((query) => JSON.parse(query))).toString();
+/**
+ * Combine multiple queries using logical AND operator.
+ *
+ * @param {string[]} queries
+ * @returns {string}
+ */
 Query.and = (queries) => new Query("and", undefined, queries.map((query) => JSON.parse(query))).toString();
 
+/**
+ * Exception thrown by the  package
+ */
 class AppwriteException extends Error {
+    /**
+     * Initializes a Appwrite Exception.
+     *
+     * @param {string} message - The error message.
+     * @param {number} code - The error code. Default is 0.
+     * @param {string} type - The error type. Default is an empty string.
+     * @param {string} response - The response string. Default is an empty string.
+     */
     constructor(message, code = 0, type = '', response = '') {
         super(message);
         this.name = 'AppwriteException';
@@ -103,8 +277,14 @@ class AppwriteException extends Error {
         this.response = response;
     }
 }
+/**
+ * Client that handles requests to Appwrite
+ */
 class Client {
     constructor() {
+        /**
+         * Holds configuration such as project.
+         */
         this.config = {
             endpoint: 'https://cloud.appwrite.io/v1',
             endpointRealtime: '',
@@ -114,11 +294,14 @@ class Client {
             locale: '',
             mode: '',
         };
+        /**
+         * Custom headers for API requests.
+         */
         this.headers = {
             'x-sdk-name': 'Console',
             'x-sdk-platform': 'console',
             'x-sdk-language': 'web',
-            'x-sdk-version': '0.6.2',
+            'x-sdk-version': '0.6.4',
             'X-Appwrite-Response-Format': '1.5.0',
         };
         this.realtime = {
@@ -383,6 +566,19 @@ class Client {
             this.realtime.connect();
         };
     }
+    /**
+     * Call API endpoint with the specified method, URL, headers, and parameters.
+     *
+     * @param {string} method - HTTP method (e.g., 'GET', 'POST', 'PUT', 'DELETE').
+     * @param {URL} url - The URL of the API endpoint.
+     * @param {Headers} headers - Custom headers for the API request.
+     * @param {Payload} params - Request parameters.
+     * @returns {Promise<any>} - A promise that resolves with the response data.
+     *
+     * @typedef {Object} Payload - Request payload data.
+     * @property {string} key - The key.
+     * @property {string} value - The value.
+     */
     call(method, url, headers = {}, params = {}) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -429,6 +625,10 @@ class Client {
             try {
                 let data = null;
                 const response = yield fetch(url.toString(), options);
+                const warnings = response.headers.get('x-appwrite-warning');
+                if (warnings) {
+                    warnings.split(';').forEach((warning) => console.warn('Warning: ' + warning));
+                }
                 if ((_a = response.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.includes('application/json')) {
                     data = yield response.json();
                 }
@@ -700,7 +900,7 @@ class Account extends Service {
         });
     }
     /**
-     * Add Authenticator
+     * Create Authenticator
      *
      * Add an authenticator app to be used as an MFA factor. Verify the
      * authenticator using the [verify
@@ -729,7 +929,7 @@ class Account extends Service {
      *
      * Verify an authenticator app after adding it using the [add
      * authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator)
-     * method. add
+     * method.
      *
      * @param {AuthenticatorType} type
      * @param {string} otp
@@ -785,7 +985,7 @@ class Account extends Service {
         });
     }
     /**
-     * Create 2FA Challenge
+     * Create MFA Challenge
      *
      * Begin the process of MFA verification after sign-in. Finish the flow with
      * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
@@ -1878,7 +2078,7 @@ class Account extends Service {
         });
     }
     /**
-     * Create phone verification (confirmation)
+     * Update phone verification (confirmation)
      *
      * Use this endpoint to complete the user phone verification process. Use the
      * **userId** and **secret** that were sent to your user's phone number to
@@ -4246,10 +4446,11 @@ class Functions extends Service {
      * @param {string} templateOwner
      * @param {string} templateRootDirectory
      * @param {string} templateBranch
+     * @param {string} specification
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    create(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, templateRepository, templateOwner, templateRootDirectory, templateBranch) {
+    create(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, templateRepository, templateOwner, templateRootDirectory, templateBranch, specification) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof functionId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "functionId"');
@@ -4322,6 +4523,9 @@ class Functions extends Service {
             if (typeof templateBranch !== 'undefined') {
                 payload['templateBranch'] = templateBranch;
             }
+            if (typeof specification !== 'undefined') {
+                payload['specification'] = specification;
+            }
             const uri = new URL(this.client.config.endpoint + apiPath);
             return yield this.client.call('post', uri, {
                 'content-type': 'application/json',
@@ -4346,6 +4550,25 @@ class Functions extends Service {
             }, payload);
         });
     }
+    /**
+     * Get available function runtime specifications
+     *
+     * Get allowed function specifications for this instance.
+     *
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getSpecifications() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiPath = '/functions/specifications';
+            const payload = {};
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            return yield this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
     /**
      * Get functions usage
      *
@@ -4410,10 +4633,11 @@ class Functions extends Service {
      * @param {string} providerBranch
      * @param {boolean} providerSilentMode
      * @param {string} providerRootDirectory
+     * @param {string} specification
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    update(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory) {
+    update(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, specification) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof functionId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "functionId"');
@@ -4468,6 +4692,9 @@ class Functions extends Service {
             if (typeof providerRootDirectory !== 'undefined') {
                 payload['providerRootDirectory'] = providerRootDirectory;
             }
+            if (typeof specification !== 'undefined') {
+                payload['specification'] = specification;
+            }
             const uri = new URL(this.client.config.endpoint + apiPath);
             return yield this.client.call('put', uri, {
                 'content-type': 'application/json',
@@ -4639,7 +4866,7 @@ class Functions extends Service {
         });
     }
     /**
-     * Update function deployment
+     * Update deployment
      *
      * Update the function code deployment ID using the unique function ID. Use
      * this endpoint to switch the code deployment that should be executed by the
@@ -4724,7 +4951,7 @@ class Functions extends Service {
         });
     }
     /**
-     * Download Deployment
+     * Download deployment
      *
      * Get a Deployment's contents by its unique ID. This endpoint supports range
      * requests for partial or streaming file download.
@@ -12447,12 +12674,12 @@ class Users extends Service {
     /**
      * Create token
      *
-     * Returns a token with a secret key for creating a session. If the provided
-     * user ID has not be registered, a new user will be created. Use the returned
-     * user ID and secret and submit a request to the [PUT
-     * /account/sessions/custom](https://appwrite.io/docs/references/cloud/client-web/account#updateCustomSession)
+     * Returns a token with a secret key for creating a session. Use the user ID
+     * and secret and submit a request to the [PUT
+     * /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
      * endpoint to complete the login process.
      *
+     *
      * @param {string} userId
      * @param {number} length
      * @param {number} expire
@@ -12782,20 +13009,56 @@ class Vcs extends Service {
     }
 }
 
+/**
+ * Helper class to generate permission strings for resources.
+ */
 class Permission {
 }
+/**
+ * Generate read permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.read = (role) => {
     return `read("${role}")`;
 };
+/**
+ * Generate write permission string for the provided role.
+ *
+ * This is an alias of update, delete, and possibly create.
+ * Don't use write in combination with update, delete, or create.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.write = (role) => {
     return `write("${role}")`;
 };
+/**
+ * Generate create permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.create = (role) => {
     return `create("${role}")`;
 };
+/**
+ * Generate update permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.update = (role) => {
     return `update("${role}")`;
 };
+/**
+ * Generate delete permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.delete = (role) => {
     return `delete("${role}")`;
 };
@@ -12895,10 +13158,25 @@ class Role {
 }
 
 var _a, _ID_hexTimestamp;
+/**
+ * Helper class to generate ID strings for resources.
+ */
 class ID {
+    /**
+     * Uses the provided ID as the ID for the resource.
+     *
+     * @param {string} id
+     * @returns {string}
+     */
     static custom(id) {
         return id;
     }
+    /**
+     * Have Appwrite generate a unique ID for you.
+     *
+     * @param {number} padding. Default is 7.
+     * @returns {string}
+     */
     static unique(padding = 7) {
         // Generate a unique ID with padding to have a longer ID
         const baseId = __classPrivateFieldGet(ID, _a, "m", _ID_hexTimestamp).call(ID);
@@ -12998,7 +13276,7 @@ var CreditCard;
     CreditCard["AmericanExpress"] = "amex";
     CreditCard["Argencard"] = "argencard";
     CreditCard["Cabal"] = "cabal";
-    CreditCard["Consosud"] = "censosud";
+    CreditCard["Cencosud"] = "cencosud";
     CreditCard["DinersClub"] = "diners";
     CreditCard["Discover"] = "discover";
     CreditCard["Elo"] = "elo";
@@ -13263,9 +13541,6 @@ var Runtime;
     Runtime["Python311"] = "python-3.11";
     Runtime["Python312"] = "python-3.12";
     Runtime["Pythonml311"] = "python-ml-3.11";
-    Runtime["Deno121"] = "deno-1.21";
-    Runtime["Deno124"] = "deno-1.24";
-    Runtime["Deno135"] = "deno-1.35";
     Runtime["Deno140"] = "deno-1.40";
     Runtime["Dart215"] = "dart-2.15";
     Runtime["Dart216"] = "dart-2.16";
@@ -13319,12 +13594,11 @@ var Name;
     Name["V1functions"] = "v1-functions";
     Name["V1usage"] = "v1-usage";
     Name["V1usagedump"] = "v1-usage-dump";
-    Name["Webhooksv1"] = "webhooksv1";
+    Name["V1webhooks"] = "v1-webhooks";
     Name["V1certificates"] = "v1-certificates";
     Name["V1builds"] = "v1-builds";
     Name["V1messaging"] = "v1-messaging";
     Name["V1migrations"] = "v1-migrations";
-    Name["Hamsterv1"] = "hamsterv1";
 })(Name || (Name = {}));
 
 var SmtpEncryption;