@appwrite.io/console 8.1.0 → 8.1.1

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 abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
-  "version": "8.1.0",
+  "version": "8.1.1",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
@@ -15,6 +15,10 @@
   },
   "module": "dist/esm/sdk.js",
   "types": "types/index.d.ts",
+  "files": [
+    "dist",
+    "types"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/appwrite/sdk-for-console"

package/types/channel.d.ts

@@ -0,0 +1,74 @@
+interface Database {
+    _db: any;
+}
+interface Collection {
+    _coll: any;
+}
+interface Document {
+    _doc: any;
+}
+interface TablesDB {
+    _tdb: any;
+}
+interface Table {
+    _tbl: any;
+}
+interface Row {
+    _row: any;
+}
+interface Bucket {
+    _bkt: any;
+}
+interface File {
+    _file: any;
+}
+interface Func {
+    _fn: any;
+}
+interface Execution {
+    _exec: any;
+}
+interface Team {
+    _team: any;
+}
+interface Membership {
+    _mem: any;
+}
+interface Resolved {
+    _res: any;
+}
+type Actionable = Document | Row | File | Team | Membership;
+export declare class Channel<T> {
+    private readonly segments;
+    _type: T;
+    private constructor();
+    private next;
+    private resolve;
+    toString(): string;
+    collection(this: Channel<Database>, id: string): Channel<Collection>;
+    document(this: Channel<Collection>, id?: string): Channel<Document>;
+    table(this: Channel<TablesDB>, id: string): Channel<Table>;
+    row(this: Channel<Table>, id?: string): Channel<Row>;
+    file(this: Channel<Bucket>, id?: string): Channel<File>;
+    create(this: Channel<Actionable>): Channel<Resolved>;
+    upsert(this: Channel<Document | Row>): Channel<Resolved>;
+    update(this: Channel<Actionable>): Channel<Resolved>;
+    delete(this: Channel<Actionable>): Channel<Resolved>;
+    static database(id: string): Channel<Database>;
+    static execution(id: string): Channel<Execution>;
+    static tablesdb(id: string): Channel<TablesDB>;
+    static bucket(id: string): Channel<Bucket>;
+    static function(id: string): Channel<Func>;
+    static team(id: string): Channel<Team>;
+    static membership(id: string): Channel<Membership>;
+    static account(): string;
+    static documents(): string;
+    static rows(): string;
+    static files(): string;
+    static executions(): string;
+    static teams(): string;
+    static memberships(): string;
+}
+export type ActionableChannel = Channel<Document> | Channel<Row> | Channel<File> | Channel<Execution> | Channel<Team> | Channel<Membership>;
+export type ResolvedChannel = Channel<Resolved>;
+export {};

package/types/client.d.ts

@@ -0,0 +1,302 @@
+import { Models } from './models';
+import { Channel, ActionableChannel, ResolvedChannel } from './channel';
+import { Query } from './query';
+/**
+ * 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 event response structure with generic payload type.
+ */
+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: string;
+    /**
+     * Payload containing event-specific data.
+     */
+    payload: T;
+    /**
+     * Subscription IDs this event matches (from backend, optional).
+     */
+    subscriptions?: string[];
+};
+/**
+ * Type representing upload progress information.
+ */
+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 {
+    static CHUNK_SIZE: number;
+    /**
+     * Holds configuration such as project.
+     */
+    config: {
+        endpoint: string;
+        endpointRealtime: string;
+        project: string;
+        key: string;
+        jwt: string;
+        locale: string;
+        mode: string;
+        cookie: string;
+        impersonateuserid: string;
+        impersonateuseremail: string;
+        impersonateuserphone: string;
+        platform: string;
+        selfSigned: boolean;
+        session?: string;
+    };
+    /**
+     * Custom headers for API requests.
+     */
+    headers: Headers;
+    /**
+     * Get Headers
+     *
+     * Returns a copy of the current request headers, including any
+     * authentication headers. Handle with care.
+     *
+     * @returns {Headers}
+     */
+    getHeaders(): Headers;
+    /**
+     * Set Endpoint
+     *
+     * Your project endpoint
+     *
+     * @param {string} endpoint
+     *
+     * @returns {this}
+     */
+    setEndpoint(endpoint: string): this;
+    /**
+     * Set Realtime Endpoint
+     *
+     * @param {string} endpointRealtime
+     *
+     * @returns {this}
+     */
+    setEndpointRealtime(endpointRealtime: string): this;
+    /**
+     * Set self-signed
+     *
+     * @param {boolean} selfSigned
+     *
+     * @returns {this}
+     */
+    setSelfSigned(selfSigned: boolean): this;
+    /**
+     * Set Project
+     *
+     * Your project ID
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setProject(value: string): this;
+    /**
+     * Set Key
+     *
+     * Your secret API key
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setKey(value: string): this;
+    /**
+     * Set JWT
+     *
+     * Your secret JSON Web Token
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setJWT(value: string): this;
+    /**
+     * Set Locale
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setLocale(value: string): this;
+    /**
+     * Set Mode
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setMode(value: string): this;
+    /**
+     * Set Cookie
+     *
+     * The user cookie to authenticate with
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setCookie(value: string): this;
+    /**
+     * Set ImpersonateUserId
+     *
+     * Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setImpersonateUserId(value: string): this;
+    /**
+     * Set ImpersonateUserEmail
+     *
+     * Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setImpersonateUserEmail(value: string): this;
+    /**
+     * Set ImpersonateUserPhone
+     *
+     * Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setImpersonateUserPhone(value: string): this;
+    /**
+     * Set Platform
+     *
+     * The platform type (Appwrite or Imagine)
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setPlatform(value: string): this;
+    private realtime;
+    /**
+     * Subscribes to Appwrite events and passes you the payload in realtime.
+     *
+     * @deprecated Use the Realtime service instead.
+     * @see Realtime
+     *
+     * @param {string|string[]|Channel<any>|ActionableChannel|ResolvedChannel|(Channel<any>|ActionableChannel|ResolvedChannel)[]} channels
+     * Channel to subscribe - pass a single channel as a string or Channel builder instance, or multiple with an array.
+     *
+     * Possible channels are:
+     * - account
+     * - collections
+     * - collections.[ID]
+     * - collections.[ID].documents
+     * - documents
+     * - documents.[ID]
+     * - files
+     * - files.[ID]
+     * - executions
+     * - executions.[ID]
+     * - functions.[ID]
+     * - teams
+     * - teams.[ID]
+     * - memberships
+     * - memberships.[ID]
+     *
+     * You can also use Channel builders:
+     * - Channel.database('db').collection('col').document('doc').create()
+     * - Channel.bucket('bucket').file('file').update()
+     * - Channel.function('func').execution('exec').delete()
+     * - Channel.team('team').create()
+     * - Channel.membership('membership').update()
+     * @param {(payload: RealtimeMessage) => void} callback Is called on every realtime update.
+     * @returns {() => void} Unsubscribes from events.
+     */
+    subscribe<T extends unknown>(channels: string | string[] | Channel<any> | ActionableChannel | ResolvedChannel | (Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (payload: RealtimeResponseEvent<T>) => void, queries?: (string | Query)[]): () => void;
+    prepareRequest(method: string, url: URL, headers?: Headers, params?: Payload): {
+        uri: string;
+        options: RequestInit;
+    };
+    chunkedUpload(method: string, url: URL, headers: Headers | undefined, originalPayload: Payload | undefined, onProgress: (progress: UploadProgress) => void): Promise<any>;
+    ping(): Promise<string>;
+    call(method: string, url: URL, headers?: Headers, params?: Payload, responseType?: string): Promise<any>;
+    static flatten(data: Payload, prefix?: string): Payload;
+}
+export { Client, AppwriteException };
+export { Query } from './query';
+export type { Models, Payload, UploadProgress };
+export type { RealtimeResponseEvent };
+export type { QueryTypes, QueryTypesList } from './query';

package/types/enums/adapter.d.ts

@@ -0,0 +1,4 @@
+export declare enum Adapter {
+    Static = "static",
+    Ssr = "ssr"
+}

package/types/enums/api-service.d.ts

@@ -0,0 +1,15 @@
+export declare enum ApiService {
+    Account = "account",
+    Avatars = "avatars",
+    Databases = "databases",
+    Tablesdb = "tablesdb",
+    Locale = "locale",
+    Health = "health",
+    Storage = "storage",
+    Teams = "teams",
+    Users = "users",
+    Sites = "sites",
+    Functions = "functions",
+    Graphql = "graphql",
+    Messaging = "messaging"
+}

package/types/enums/api.d.ts

@@ -0,0 +1,5 @@
+export declare enum Api {
+    Rest = "rest",
+    Graphql = "graphql",
+    Realtime = "realtime"
+}

package/types/enums/appwrite-migration-resource.d.ts

@@ -0,0 +1,27 @@
+export declare enum AppwriteMigrationResource {
+    User = "user",
+    Team = "team",
+    Membership = "membership",
+    Database = "database",
+    Table = "table",
+    Column = "column",
+    Index = "index",
+    Row = "row",
+    Document = "document",
+    Attribute = "attribute",
+    Collection = "collection",
+    Documentsdb = "documentsdb",
+    Vectorsdb = "vectorsdb",
+    Bucket = "bucket",
+    File = "file",
+    Function = "function",
+    Deployment = "deployment",
+    Environmentvariable = "environment-variable",
+    Provider = "provider",
+    Topic = "topic",
+    Subscriber = "subscriber",
+    Message = "message",
+    Site = "site",
+    Sitedeployment = "site-deployment",
+    Sitevariable = "site-variable"
+}

package/types/enums/attribute-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/auth-method.d.ts

@@ -0,0 +1,9 @@
+export declare enum AuthMethod {
+    Emailpassword = "email-password",
+    Magicurl = "magic-url",
+    Emailotp = "email-otp",
+    Anonymous = "anonymous",
+    Invites = "invites",
+    Jwt = "jwt",
+    Phone = "phone"
+}

package/types/enums/authentication-factor.d.ts

@@ -0,0 +1,6 @@
+export declare enum AuthenticationFactor {
+    Email = "email",
+    Phone = "phone",
+    Totp = "totp",
+    Recoverycode = "recoverycode"
+}

package/types/enums/authenticator-type.d.ts

@@ -0,0 +1,3 @@
+export declare enum AuthenticatorType {
+    Totp = "totp"
+}

package/types/enums/backup-services.d.ts

@@ -0,0 +1,8 @@
+export declare enum BackupServices {
+    Databases = "databases",
+    Tablesdb = "tablesdb",
+    Documentsdb = "documentsdb",
+    Vectorsdb = "vectorsdb",
+    Functions = "functions",
+    Storage = "storage"
+}

package/types/enums/billing-plan-group.d.ts

@@ -0,0 +1,5 @@
+export declare enum BillingPlanGroup {
+    Starter = "starter",
+    Pro = "pro",
+    Scale = "scale"
+}

package/types/enums/browser-permission.d.ts

@@ -0,0 +1,22 @@
+export declare enum BrowserPermission {
+    Geolocation = "geolocation",
+    Camera = "camera",
+    Microphone = "microphone",
+    Notifications = "notifications",
+    Midi = "midi",
+    Push = "push",
+    Clipboardread = "clipboard-read",
+    Clipboardwrite = "clipboard-write",
+    Paymenthandler = "payment-handler",
+    Usb = "usb",
+    Bluetooth = "bluetooth",
+    Accelerometer = "accelerometer",
+    Gyroscope = "gyroscope",
+    Magnetometer = "magnetometer",
+    Ambientlightsensor = "ambient-light-sensor",
+    Backgroundsync = "background-sync",
+    Persistentstorage = "persistent-storage",
+    Screenwakelock = "screen-wake-lock",
+    Webshare = "web-share",
+    Xrspatialtracking = "xr-spatial-tracking"
+}

package/types/enums/browser.d.ts

@@ -0,0 +1,16 @@
+export declare enum Browser {
+    AvantBrowser = "aa",
+    AndroidWebViewBeta = "an",
+    GoogleChrome = "ch",
+    GoogleChromeIOS = "ci",
+    GoogleChromeMobile = "cm",
+    Chromium = "cr",
+    MozillaFirefox = "ff",
+    Safari = "sf",
+    MobileSafari = "mf",
+    MicrosoftEdge = "ps",
+    MicrosoftEdgeIOS = "oi",
+    OperaMini = "om",
+    Opera = "op",
+    OperaNext = "on"
+}

package/types/enums/build-runtime.d.ts

@@ -0,0 +1,88 @@
+export declare enum BuildRuntime {
+    Node145 = "node-14.5",
+    Node160 = "node-16.0",
+    Node180 = "node-18.0",
+    Node190 = "node-19.0",
+    Node200 = "node-20.0",
+    Node210 = "node-21.0",
+    Node22 = "node-22",
+    Node23 = "node-23",
+    Node24 = "node-24",
+    Node25 = "node-25",
+    Php80 = "php-8.0",
+    Php81 = "php-8.1",
+    Php82 = "php-8.2",
+    Php83 = "php-8.3",
+    Php84 = "php-8.4",
+    Ruby30 = "ruby-3.0",
+    Ruby31 = "ruby-3.1",
+    Ruby32 = "ruby-3.2",
+    Ruby33 = "ruby-3.3",
+    Ruby34 = "ruby-3.4",
+    Ruby40 = "ruby-4.0",
+    Python38 = "python-3.8",
+    Python39 = "python-3.9",
+    Python310 = "python-3.10",
+    Python311 = "python-3.11",
+    Python312 = "python-3.12",
+    Python313 = "python-3.13",
+    Python314 = "python-3.14",
+    Pythonml311 = "python-ml-3.11",
+    Pythonml312 = "python-ml-3.12",
+    Pythonml313 = "python-ml-3.13",
+    Deno140 = "deno-1.40",
+    Deno146 = "deno-1.46",
+    Deno20 = "deno-2.0",
+    Deno25 = "deno-2.5",
+    Deno26 = "deno-2.6",
+    Dart215 = "dart-2.15",
+    Dart216 = "dart-2.16",
+    Dart217 = "dart-2.17",
+    Dart218 = "dart-2.18",
+    Dart219 = "dart-2.19",
+    Dart30 = "dart-3.0",
+    Dart31 = "dart-3.1",
+    Dart33 = "dart-3.3",
+    Dart35 = "dart-3.5",
+    Dart38 = "dart-3.8",
+    Dart39 = "dart-3.9",
+    Dart310 = "dart-3.10",
+    Dotnet60 = "dotnet-6.0",
+    Dotnet70 = "dotnet-7.0",
+    Dotnet80 = "dotnet-8.0",
+    Dotnet10 = "dotnet-10",
+    Java80 = "java-8.0",
+    Java110 = "java-11.0",
+    Java170 = "java-17.0",
+    Java180 = "java-18.0",
+    Java210 = "java-21.0",
+    Java22 = "java-22",
+    Java25 = "java-25",
+    Swift55 = "swift-5.5",
+    Swift58 = "swift-5.8",
+    Swift59 = "swift-5.9",
+    Swift510 = "swift-5.10",
+    Swift62 = "swift-6.2",
+    Kotlin16 = "kotlin-1.6",
+    Kotlin18 = "kotlin-1.8",
+    Kotlin19 = "kotlin-1.9",
+    Kotlin20 = "kotlin-2.0",
+    Kotlin23 = "kotlin-2.3",
+    Cpp17 = "cpp-17",
+    Cpp20 = "cpp-20",
+    Bun10 = "bun-1.0",
+    Bun11 = "bun-1.1",
+    Bun12 = "bun-1.2",
+    Bun13 = "bun-1.3",
+    Go123 = "go-1.23",
+    Go124 = "go-1.24",
+    Go125 = "go-1.25",
+    Go126 = "go-1.26",
+    Static1 = "static-1",
+    Flutter324 = "flutter-3.24",
+    Flutter327 = "flutter-3.27",
+    Flutter329 = "flutter-3.29",
+    Flutter332 = "flutter-3.32",
+    Flutter335 = "flutter-3.35",
+    Flutter338 = "flutter-3.38"
+}

package/types/enums/column-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum ColumnStatus {
+    Available = "available",
+    Processing = "processing",
+    Deleting = "deleting",
+    Stuck = "stuck",
+    Failed = "failed"
+}

package/types/enums/compression.d.ts

@@ -0,0 +1,5 @@
+export declare enum Compression {
+    None = "none",
+    Gzip = "gzip",
+    Zstd = "zstd"
+}

package/types/enums/console-resource-type.d.ts

@@ -0,0 +1,3 @@
+export declare enum ConsoleResourceType {
+    Rules = "rules"
+}

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

@@ -0,0 +1,19 @@
+export declare enum CreditCard {
+    AmericanExpress = "amex",
+    Argencard = "argencard",
+    Cabal = "cabal",
+    Cencosud = "cencosud",
+    DinersClub = "diners",
+    Discover = "discover",
+    Elo = "elo",
+    Hipercard = "hipercard",
+    JCB = "jcb",
+    Mastercard = "mastercard",
+    Naranja = "naranja",
+    TarjetaShopping = "targeta-shopping",
+    UnionPay = "unionpay",
+    Visa = "visa",
+    MIR = "mir",
+    Maestro = "maestro",
+    Rupay = "rupay"
+}

package/types/enums/database-type.d.ts

@@ -0,0 +1,6 @@
+export declare enum DatabaseType {
+    Legacy = "legacy",
+    Tablesdb = "tablesdb",
+    Documentsdb = "documentsdb",
+    Vectorsdb = "vectorsdb"
+}

package/types/enums/databases-index-type.d.ts

@@ -0,0 +1,6 @@
+export declare enum DatabasesIndexType {
+    Key = "key",
+    Fulltext = "fulltext",
+    Unique = "unique",
+    Spatial = "spatial"
+}