@appwrite.io/console 0.6.2 → 0.6.4

package/src/query.ts

@@ -3,11 +3,21 @@ export type QueryTypesList = string[] | number[] | boolean[] | Query[];
 export type QueryTypes = QueryTypesSingle | QueryTypesList;
 type AttributesTypes = string | string[];
 
+/**
+ * Helper class to generate query strings.
+ */
 export class Query {
   method: string;
   attribute: AttributesTypes | undefined;
   values: QueryTypesList | undefined;
 
+  /**
+   * Constructor for Query class.
+   *
+   * @param {string} method
+   * @param {AttributesTypes} attribute
+   * @param {QueryTypes} values
+   */
   constructor(
     method: string,
     attribute?: AttributesTypes,
@@ -25,6 +35,11 @@ export class Query {
     }
   }
 
+  /**
+   * Convert the query object to a JSON string.
+   *
+   * @returns {string}
+   */
   toString(): string {
     return JSON.stringify({
       method: this.method,
@@ -33,69 +48,214 @@ export class Query {
     });
   }
 
+  /**
+   * Filter resources where attribute is equal to value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
   static equal = (attribute: string, value: QueryTypes): string =>
     new Query("equal", attribute, value).toString();
 
+  /**
+   * Filter resources where attribute is not equal to value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
   static notEqual = (attribute: string, value: QueryTypes): string =>
     new Query("notEqual", attribute, value).toString();
 
+  /**
+   * Filter resources where attribute is less than value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
   static lessThan = (attribute: string, value: QueryTypes): string =>
     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}
+   */
   static lessThanEqual = (attribute: string, value: QueryTypes): string =>
     new Query("lessThanEqual", attribute, value).toString();
 
+  /**
+   * Filter resources where attribute is greater than value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
   static greaterThan = (attribute: string, value: QueryTypes): string =>
     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}
+   */
   static greaterThanEqual = (attribute: string, value: QueryTypes): string =>
     new Query("greaterThanEqual", attribute, value).toString();
 
+  /**
+   * Filter resources where attribute is null.
+   *
+   * @param {string} attribute
+   * @returns {string}
+   */
   static isNull = (attribute: string): string =>
     new Query("isNull", attribute).toString();
 
+  /**
+   * Filter resources where attribute is not null.
+   *
+   * @param {string} attribute
+   * @returns {string}
+   */
   static isNotNull = (attribute: string): string =>
     new Query("isNotNull", attribute).toString();
 
-  static between = (attribute: string, start: string | number, end: string | number) =>
+  /**
+   * Filter resources where attribute is between start and end (inclusive).
+   *
+   * @param {string} attribute
+   * @param {string | number} start
+   * @param {string | number} end
+   * @returns {string}
+   */
+  static between = (attribute: string, start: string | number, end: string | number): string =>
     new Query("between", attribute, [start, end] as QueryTypesList).toString();
 
+  /**
+   * Filter resources where attribute starts with value.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
   static startsWith = (attribute: string, value: string): string =>
     new Query("startsWith", attribute, value).toString();
 
+  /**
+   * Filter resources where attribute ends with value.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
   static endsWith = (attribute: string, value: string): string =>
     new Query("endsWith", attribute, value).toString();
 
+  /**
+   * Specify which attributes should be returned by the API call.
+   *
+   * @param {string[]} attributes
+   * @returns {string}
+   */
   static select = (attributes: string[]): string =>
     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}
+   */
   static search = (attribute: string, value: string): string =>
     new Query("search", attribute, value).toString();
 
+  /**
+   * Sort results by attribute descending.
+   *
+   * @param {string} attribute
+   * @returns {string}
+   */
   static orderDesc = (attribute: string): string =>
     new Query("orderDesc", attribute).toString();
 
+  /**
+   * Sort results by attribute ascending.
+   *
+   * @param {string} attribute
+   * @returns {string}
+   */
   static orderAsc = (attribute: string): string =>
     new Query("orderAsc", attribute).toString();
 
+  /**
+   * Return results after documentId.
+   *
+   * @param {string} documentId
+   * @returns {string}
+   */
   static cursorAfter = (documentId: string): string =>
     new Query("cursorAfter", undefined, documentId).toString();
 
+  /**
+   * Return results before documentId.
+   *
+   * @param {string} documentId
+   * @returns {string}
+   */
   static cursorBefore = (documentId: string): string =>
     new Query("cursorBefore", undefined, documentId).toString();
 
+  /**
+   * Return only limit results.
+   *
+   * @param {number} limit
+   * @returns {string}
+   */
   static limit = (limit: number): string =>
     new Query("limit", undefined, limit).toString();
 
+  /**
+   * Filter resources by skipping the first offset results.
+   *
+   * @param {number} offset
+   * @returns {string}
+   */
   static offset = (offset: number): string =>
     new Query("offset", undefined, offset).toString();
 
+  /**
+   * Filter resources where attribute contains the specified value.
+   *
+   * @param {string} attribute
+   * @param {string | string[]} value
+   * @returns {string}
+   */
   static contains = (attribute: string, value: string | string[]): string =>
     new Query("contains", attribute, value).toString();
 
+  /**
+   * Combine multiple queries using logical OR operator.
+   *
+   * @param {string[]} queries
+   * @returns {string}
+   */
   static or = (queries: string[]) =>
     new Query("or", undefined, queries.map((query) => JSON.parse(query))).toString();
 
+  /**
+   * Combine multiple queries using logical AND operator.
+   *
+   * @param {string[]} queries
+   * @returns {string}
+   */
   static and = (queries: string[]) =>
     new Query("and", undefined, queries.map((query) => JSON.parse(query))).toString();
 }

package/src/service.ts

@@ -2,6 +2,9 @@ import { Client } from './client';
 import type { Payload } from './client';
 
 export class Service {
+    /**
+     * The size for chunked uploads in bytes.
+     */
     static CHUNK_SIZE = 5*1024*1024; // 5MB
 
     client: Client;

package/src/services/account.ts

@@ -268,7 +268,7 @@ export 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
@@ -298,7 +298,7 @@ export 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
@@ -360,7 +360,7 @@ export 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)
@@ -1543,7 +1543,7 @@ export 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

package/src/services/functions.ts

@@ -70,10 +70,11 @@ export class Functions extends Service {
      * @param {string} templateOwner
      * @param {string} templateRootDirectory
      * @param {string} templateBranch
+     * @param {string} specification
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string): Promise<Models.Function> {
+    async create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string, specification?: string): Promise<Models.Function> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -169,6 +170,10 @@ export class Functions extends Service {
             payload['templateBranch'] = templateBranch;
         }
 
+        if (typeof specification !== 'undefined') {
+            payload['specification'] = specification;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('post', uri, {
             'content-type': 'application/json',
@@ -193,6 +198,25 @@ export class Functions extends Service {
         }, payload);
     }
 
+    /**
+     * Get available function runtime specifications
+     *
+     * Get allowed function specifications for this instance.
+     * 
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getSpecifications(): Promise<Models.SpecificationList> {
+        const apiPath = '/functions/specifications';
+        const payload: Payload = {};
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get functions usage
      *
@@ -259,10 +283,11 @@ export class Functions extends Service {
      * @param {string} providerBranch
      * @param {boolean} providerSilentMode
      * @param {string} providerRootDirectory
+     * @param {string} specification
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function> {
+    async update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -334,6 +359,10 @@ export class Functions extends Service {
             payload['providerRootDirectory'] = providerRootDirectory;
         }
 
+        if (typeof specification !== 'undefined') {
+            payload['specification'] = specification;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('put', uri, {
             'content-type': 'application/json',
@@ -527,7 +556,7 @@ export 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
@@ -619,7 +648,7 @@ export 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.

package/src/services/users.ts

@@ -1422,11 +1422,11 @@ export 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

package/types/client.d.ts

@@ -1,30 +1,96 @@
 import { Models } from './models';
+/**
+ * Payload type representing a key-value pair with string keys and any values.
+ */
 declare type Payload = {
     [key: string]: any;
 };
+/**
+ * Headers type representing a key-value pair with string keys and string values.
+ */
 declare type Headers = {
     [key: string]: string;
 };
+/**
+ * Realtime event response structure with generic payload type.
+ */
 export declare type RealtimeResponseEvent<T extends unknown> = {
+    /**
+     * List of event names associated with the response.
+     */
     events: string[];
+    /**
+     * List of channel names associated with the response.
+     */
     channels: string[];
+    /**
+     * Timestamp indicating the time of the event.
+     */
     timestamp: number;
+    /**
+     * Payload containing event-specific data.
+     */
     payload: T;
 };
+/**
+ * Type representing upload progress information.
+ */
 export declare type UploadProgress = {
+    /**
+     * Identifier for the upload progress.
+     */
     $id: string;
+    /**
+     * Current progress of the upload (in percentage).
+     */
     progress: number;
+    /**
+     * Total size uploaded (in bytes) during the upload process.
+     */
     sizeUploaded: number;
+    /**
+     * Total number of chunks that need to be uploaded.
+     */
     chunksTotal: number;
+    /**
+     * Number of chunks that have been successfully uploaded.
+     */
     chunksUploaded: number;
 };
+/**
+ * Exception thrown by the  package
+ */
 declare class AppwriteException extends Error {
+    /**
+     * The error code associated with the exception.
+     */
     code: number;
+    /**
+     * The response string associated with the exception.
+     */
     response: string;
+    /**
+     * Error type.
+     * See [Error Types](https://appwrite.io/docs/response-codes#errorTypes) for more information.
+     */
     type: string;
+    /**
+     * 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: string, code?: number, type?: string, response?: string);
 }
+/**
+ * Client that handles requests to Appwrite
+ */
 declare class Client {
+    /**
+     * Holds configuration such as project.
+     */
     config: {
         endpoint: string;
         endpointRealtime: string;
@@ -34,6 +100,9 @@ declare class Client {
         locale: string;
         mode: string;
     };
+    /**
+     * Custom headers for API requests.
+     */
     headers: Headers;
     /**
      * Set Endpoint
@@ -126,6 +195,19 @@ declare class Client {
      * @returns {() => void} Unsubscribes from events.
      */
     subscribe<T extends unknown>(channels: string | string[], callback: (payload: RealtimeResponseEvent<T>) => void): () => void;
+    /**
+     * 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: string, url: URL, headers?: Headers, params?: Payload): Promise<any>;
 }
 export { Client, AppwriteException };

package/types/enums/credit-card.d.ts

@@ -2,7 +2,7 @@ export declare enum CreditCard {
     AmericanExpress = "amex",
     Argencard = "argencard",
     Cabal = "cabal",
-    Consosud = "censosud",
+    Cencosud = "cencosud",
     DinersClub = "diners",
     Discover = "discover",
     Elo = "elo",

package/types/enums/name.d.ts

@@ -6,10 +6,9 @@ export declare enum Name {
     V1functions = "v1-functions",
     V1usage = "v1-usage",
     V1usagedump = "v1-usage-dump",
-    Webhooksv1 = "webhooksv1",
+    V1webhooks = "v1-webhooks",
     V1certificates = "v1-certificates",
     V1builds = "v1-builds",
     V1messaging = "v1-messaging",
-    V1migrations = "v1-migrations",
-    Hamsterv1 = "hamsterv1"
+    V1migrations = "v1-migrations"
 }

package/types/enums/runtime.d.ts

@@ -19,9 +19,6 @@ export declare enum Runtime {
     Python311 = "python-3.11",
     Python312 = "python-3.12",
     Pythonml311 = "python-ml-3.11",
-    Deno121 = "deno-1.21",
-    Deno124 = "deno-1.24",
-    Deno135 = "deno-1.35",
     Deno140 = "deno-1.40",
     Dart215 = "dart-2.15",
     Dart216 = "dart-2.16",

package/types/id.d.ts

@@ -1,5 +1,20 @@
+/**
+ * Helper class to generate ID strings for resources.
+ */
 export declare class ID {
     #private;
+    /**
+     * Uses the provided ID as the ID for the resource.
+     *
+     * @param {string} id
+     * @returns {string}
+     */
     static custom(id: string): string;
+    /**
+     * Have Appwrite generate a unique ID for you.
+     *
+     * @param {number} padding. Default is 7.
+     * @returns {string}
+     */
     static unique(padding?: number): string;
 }

package/types/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Appwrite Console SDK
+ *
+ * This SDK is compatible with Appwrite server version 1.5.x.
+ * For older versions, please check
+ * [previous releases](https://github.com/appwrite/sdk-for-console/releases).
+ */
 export { Client, Query, AppwriteException } from './client';
 export { Account } from './services/account';
 export { Avatars } from './services/avatars';