@appwrite.io/console 0.6.2 → 0.6.4

package/src/client.ts

@@ -1,83 +1,275 @@
 import { Models } from './models';
 import { Service } from './service';
 
+/**
+ * Payload type representing a key-value pair with string keys and any values.
+ */
 type Payload = {
     [key: string]: any;
 }
 
+/**
+ * Headers type representing a key-value pair with string keys and string values.
+ */
 type Headers = {
     [key: string]: string;
 }
 
+/**
+ * Realtime response structure with different types.
+ */
 type RealtimeResponse = {
+    /**
+     * Type of the response: 'error', 'event', 'connected', or 'response'.
+     */
     type: 'error' | 'event' | 'connected' | 'response';
+
+    /**
+     * Data associated with the response based on the response type.
+     */
     data: RealtimeResponseAuthenticated | RealtimeResponseConnected | RealtimeResponseError | RealtimeResponseEvent<unknown>;
 }
 
+/**
+ * Realtime request structure for authentication.
+ */
 type RealtimeRequest = {
+    /**
+     * Type of the request: 'authentication'.
+     */
     type: 'authentication';
+
+    /**
+     * Data required for authentication.
+     */
     data: RealtimeRequestAuthenticate;
 }
 
+/**
+ * Realtime event response structure with generic payload type.
+ */
 export 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;
 }
 
+/**
+ * Realtime response structure for errors.
+ */
 type RealtimeResponseError = {
+    /**
+     * Numeric error code indicating the type of error.
+     */
     code: number;
+
+    /**
+     * Error message describing the encountered error.
+     */
     message: string;
 }
 
+/**
+ * Realtime response structure for a successful connection.
+ */
 type RealtimeResponseConnected = {
+    /**
+     * List of channels the user is connected to.
+     */
     channels: string[];
+
+    /**
+     * User object representing the connected user (optional).
+     */
     user?: object;
 }
 
+/**
+ * Realtime response structure for authenticated connections.
+ */
 type RealtimeResponseAuthenticated = {
+    /**
+     * Destination channel for the response.
+     */
     to: string;
+
+    /**
+     * Boolean indicating the success of the authentication process.
+     */
     success: boolean;
+
+    /**
+     * User object representing the authenticated user.
+     */
     user: object;
 }
 
+/**
+ * Realtime request structure for authentication.
+ */
 type RealtimeRequestAuthenticate = {
+    /**
+     * Session identifier for authentication.
+     */
     session: string;
 }
 
+/**
+ * Realtime interface representing the structure of a realtime communication object.
+ */
 type Realtime = {
+    /**
+     * WebSocket instance for realtime communication.
+     */
     socket?: WebSocket;
+
+    /**
+     * Timeout duration for communication operations.
+     */
     timeout?: number;
+
+    /**
+     * URL for establishing the WebSocket connection.
+     */
     url?: string;
+
+    /**
+     * Last received message from the realtime server.
+     */
     lastMessage?: RealtimeResponse;
+
+    /**
+     * Set of channel names the client is subscribed to.
+     */
     channels: Set<string>;
+
+    /**
+     * Map of subscriptions containing channel names and corresponding callback functions.
+     */
     subscriptions: Map<number, {
         channels: string[];
         callback: (payload: RealtimeResponseEvent<any>) => void
     }>;
+
+    /**
+     * Counter for managing subscriptions.
+     */
     subscriptionsCounter: number;
+
+    /**
+     * Boolean indicating whether automatic reconnection is enabled.
+     */
     reconnect: boolean;
+
+    /**
+     * Number of reconnection attempts made.
+     */
     reconnectAttempts: number;
+
+    /**
+     * Function to get the timeout duration for communication operations.
+     */
     getTimeout: () => number;
+
+    /**
+     * Function to establish a WebSocket connection.
+     */
     connect: () => void;
+
+    /**
+     * Function to create a new WebSocket instance.
+     */
     createSocket: () => void;
+
+    /**
+     * Function to clean up resources associated with specified channels.
+     *
+     * @param {string[]} channels - List of channel names to clean up.
+     */
     cleanUp: (channels: string[]) => void;
+
+    /**
+     * Function to handle incoming messages from the WebSocket connection.
+     *
+     * @param {MessageEvent} event - Event containing the received message.
+     */
     onMessage: (event: MessageEvent) => void;
 }
 
+/**
+ * Type representing upload progress information.
+ */
 export 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
+ */
 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 = 0, type: string = '', response: string = '') {
         super(message);
         this.name = 'AppwriteException';
@@ -88,7 +280,13 @@ class AppwriteException extends Error {
     }
 }
 
+/**
+ * Client that handles requests to Appwrite
+ */
 class Client {
+    /**
+     * Holds configuration such as project.
+     */
     config = {
         endpoint: 'https://cloud.appwrite.io/v1',
         endpointRealtime: '',
@@ -98,11 +296,15 @@ class Client {
         locale: '',
         mode: '',
     };
+
+    /**
+     * Custom headers for API requests.
+     */
     headers: 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',
     };
 
@@ -390,6 +592,19 @@ class Client {
         }
     }
 
+    /**
+     * 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.
+     */
     async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}): Promise<any> {
         method = method.toUpperCase();
 
@@ -442,6 +657,11 @@ class Client {
             let data = null;
             const response = await fetch(url.toString(), options);
 
+            const warnings = response.headers.get('x-appwrite-warning');
+            if (warnings) {
+                warnings.split(';').forEach((warning: string) => console.warn('Warning: ' + warning));
+            }
+
             if (response.headers.get('content-type')?.includes('application/json')) {
                 data = await response.json();
             } else {

package/src/enums/credit-card.ts

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

package/src/enums/name.ts

@@ -6,10 +6,9 @@ export 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',
 }

package/src/enums/runtime.ts

@@ -19,9 +19,6 @@ export 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/src/id.ts

@@ -1,6 +1,13 @@
+/**
+ * Helper class to generate ID strings for resources.
+ */
 export class ID {
-    // Generate an hex ID based on timestamp
-    // Recreated from https://www.php.net/manual/en/function.uniqid.php
+    /**
+     * Generate an hex ID based on timestamp.
+     * Recreated from https://www.php.net/manual/en/function.uniqid.php
+     *
+     * @returns {string}
+     */
     static #hexTimestamp(): string {
         const now = new Date();
         const sec = Math.floor(now.getTime() / 1000);
@@ -11,10 +18,22 @@ export class ID {
         return hexTimestamp;
     }
 
+    /**
+     * Uses the provided ID as the ID for the resource.
+     *
+     * @param {string} id
+     * @returns {string}
+     */
     public static custom(id: string): string {
         return id
     }
 
+    /**
+     * Have Appwrite generate a unique ID for you.
+     * 
+     * @param {number} padding. Default is 7.
+     * @returns {string}
+     */
     public static unique(padding: number = 7): string {
         // Generate a unique ID with padding to have a longer ID
         const baseId = ID.#hexTimestamp();

package/src/index.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';

package/src/models.ts

@@ -1,3 +1,6 @@
+/**
+ * Appwrite Models
+ */
 export namespace Models {
     /**
      * Documents List
@@ -493,6 +496,19 @@ export namespace Models {
          */
         projects: FirebaseProject[];
     }
+    /**
+     * Specifications List
+     */
+    export type SpecificationList = {
+        /**
+         * Total number of specifications documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of specifications.
+         */
+        specifications: Specification[];
+    }
     /**
      * Database
      */
@@ -1838,6 +1854,10 @@ export namespace Models {
          * Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
          */
         providerSilentMode: boolean;
+        /**
+         * Function execution and builds machine specification.
+         */
+        specification: string;
     }
     /**
      * Installation
@@ -2926,6 +2946,10 @@ export namespace Models {
          * Total aggregated sum of functions build compute time.
          */
         buildsTimeTotal: number;
+        /**
+         * Total aggregated sum of functions build mbSeconds.
+         */
+        buildsMbSecondsTotal: number;
         /**
          * Total  aggregated number of functions execution.
          */
@@ -2934,6 +2958,10 @@ export namespace Models {
          * Total aggregated sum of functions  execution compute time.
          */
         executionsTimeTotal: number;
+        /**
+         * Total aggregated sum of functions execution mbSeconds.
+         */
+        executionsMbSecondsTotal: number;
         /**
          * Aggregated number of functions per period.
          */
@@ -2958,6 +2986,10 @@ export namespace Models {
          * Aggregated sum of  functions build compute time per period.
          */
         buildsTime: Metric[];
+        /**
+         * Aggregated sum of functions build mbSeconds per period.
+         */
+        buildsMbSeconds: Metric[];
         /**
          * Aggregated number of  functions execution per period.
          */
@@ -2966,6 +2998,10 @@ export namespace Models {
          * Aggregated number of functions execution compute time per period.
          */
         executionsTime: Metric[];
+        /**
+         * Aggregated number of functions mbSeconds per period.
+         */
+        executionsMbSeconds: Metric[];
     }
     /**
      * UsageFunction
@@ -2995,6 +3031,10 @@ export namespace Models {
          * Total aggregated sum of function builds compute time.
          */
         buildsTimeTotal: number;
+        /**
+         * Total aggregated sum of function builds mbSeconds.
+         */
+        buildsMbSecondsTotal: number;
         /**
          * Total  aggregated number of function executions.
          */
@@ -3003,6 +3043,10 @@ export namespace Models {
          * Total aggregated sum of function  executions compute time.
          */
         executionsTimeTotal: number;
+        /**
+         * Total aggregated sum of function executions mbSeconds.
+         */
+        executionsMbSecondsTotal: number;
         /**
          * Aggregated number of function deployments per period.
          */
@@ -3023,6 +3067,10 @@ export namespace Models {
          * Aggregated sum of function builds compute time per period.
          */
         buildsTime: Metric[];
+        /**
+         * Aggregated number of function builds mbSeconds per period.
+         */
+        buildsMbSeconds: Metric[];
         /**
          * Aggregated number of function executions per period.
          */
@@ -3031,6 +3079,10 @@ export namespace Models {
          * Aggregated number of function executions compute time per period.
          */
         executionsTime: Metric[];
+        /**
+         * Aggregated number of function mbSeconds per period.
+         */
+        executionsMbSeconds: Metric[];
     }
     /**
      * UsageProject
@@ -3056,10 +3108,22 @@ export namespace Models {
          * Total aggregated sum of files storage size (in bytes).
          */
         filesStorageTotal: number;
+        /**
+         * Total aggregated sum of deployments storage size (in bytes).
+         */
+        deploymentsStorageTotal: number;
         /**
          * Total aggregated number of buckets.
          */
         bucketsTotal: number;
+        /**
+         * Total aggregated number of function executions mbSeconds.
+         */
+        executionsMbSecondsTotal: number;
+        /**
+         * Total aggregated number of function builds mbSeconds.
+         */
+        buildsMbSecondsTotal: number;
         /**
          * Aggregated  number of requests per period.
          */
@@ -3084,6 +3148,18 @@ export namespace Models {
          * Aggregated breakdown in totals of usage by buckets.
          */
         bucketsBreakdown: MetricBreakdown[];
+        /**
+         * Aggregated breakdown in totals of execution mbSeconds by functions.
+         */
+        executionsMbSecondsBreakdown: MetricBreakdown[];
+        /**
+         * Aggregated breakdown in totals of build mbSeconds by functions.
+         */
+        buildsMbSecondsBreakdown: MetricBreakdown[];
+        /**
+         * Aggregated breakdown in totals of deployments storage size (in bytes).
+         */
+        deploymentsStorageBreakdown: MetricBreakdown[];
     }
     /**
      * Headers
@@ -3098,6 +3174,27 @@ export namespace Models {
          */
         value: string;
     }
+    /**
+     * Specification
+     */
+    export type Specification = {
+        /**
+         * Memory size in MB.
+         */
+        memory: number;
+        /**
+         * Number of CPUs.
+         */
+        cpus: number;
+        /**
+         * Is size enabled.
+         */
+        enabled: boolean;
+        /**
+         * Size slug.
+         */
+        slug: string;
+    }
     /**
      * Rule
      */

package/src/permission.ts

@@ -1,22 +1,57 @@
+/**
+ * Helper class to generate permission strings for resources.
+ */
 export class Permission {
-
+    /**
+     * Generate read permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static read = (role: string): string => {
-        return `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}
+     */
     static write = (role: string): string => {
-        return `write("${role}")`
+        return `write("${role}")`;
     }
 
+    /**
+     * Generate create permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static create = (role: string): string => {
-        return `create("${role}")`
+        return `create("${role}")`;
     }
 
+    /**
+     * Generate update permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static update = (role: string): string => {
-        return `update("${role}")`
+        return `update("${role}")`;
     }
 
+    /**
+     * Generate delete permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static delete = (role: string): string => {
-        return `delete("${role}")`
+        return `delete("${role}")`;
     }
 }