@appwrite.io/console 2.1.3 → 2.3.0

package/src/services/vcs.ts

@@ -21,7 +21,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<Models.DetectionFramework>}
      */
-    createRepositoryDetection(params: { installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string  }): Promise<Models.DetectionFramework>;
+    createRepositoryDetection(params: { installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string }): Promise<Models.DetectionFramework>;
     /**
      * Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
      *
@@ -101,7 +101,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProviderRepositoryFrameworkList>}
      */
-    listRepositories(params: { installationId: string, type: VCSDetectionType, search?: string, queries?: string[]  }): Promise<Models.ProviderRepositoryFrameworkList>;
+    listRepositories(params: { installationId: string, type: VCSDetectionType, search?: string, queries?: string[] }): Promise<Models.ProviderRepositoryFrameworkList>;
     /**
      * Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
      *
@@ -176,7 +176,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProviderRepository>}
      */
-    createRepository(params: { installationId: string, name: string, xprivate: boolean  }): Promise<Models.ProviderRepository>;
+    createRepository(params: { installationId: string, name: string, xprivate: boolean }): Promise<Models.ProviderRepository>;
     /**
      * Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
      *
@@ -248,7 +248,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProviderRepository>}
      */
-    getRepository(params: { installationId: string, providerRepositoryId: string  }): Promise<Models.ProviderRepository>;
+    getRepository(params: { installationId: string, providerRepositoryId: string }): Promise<Models.ProviderRepository>;
     /**
      * Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
      *
@@ -308,7 +308,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<Models.BranchList>}
      */
-    listRepositoryBranches(params: { installationId: string, providerRepositoryId: string  }): Promise<Models.BranchList>;
+    listRepositoryBranches(params: { installationId: string, providerRepositoryId: string }): Promise<Models.BranchList>;
     /**
      * Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
      * 
@@ -370,7 +370,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<Models.VcsContentList>}
      */
-    getRepositoryContents(params: { installationId: string, providerRepositoryId: string, providerRootDirectory?: string, providerReference?: string  }): Promise<Models.VcsContentList>;
+    getRepositoryContents(params: { installationId: string, providerRepositoryId: string, providerRootDirectory?: string, providerReference?: string }): Promise<Models.VcsContentList>;
     /**
      * Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
      *
@@ -442,7 +442,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
-    updateExternalDeployments(params: { installationId: string, repositoryId: string, providerPullRequestId: string  }): Promise<{}>;
+    updateExternalDeployments(params: { installationId: string, repositoryId: string, providerPullRequestId: string }): Promise<{}>;
     /**
      * Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.
      *
@@ -513,7 +513,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<Models.InstallationList>}
      */
-    listInstallations(params?: { queries?: string[], search?: string, total?: boolean  }): Promise<Models.InstallationList>;
+    listInstallations(params?: { queries?: string[], search?: string, total?: boolean }): Promise<Models.InstallationList>;
     /**
      * List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
      * 
@@ -578,7 +578,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Installation>}
      */
-    getInstallation(params: { installationId: string  }): Promise<Models.Installation>;
+    getInstallation(params: { installationId: string }): Promise<Models.Installation>;
     /**
      * Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. 
      *
@@ -629,7 +629,7 @@ export class Vcs {
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
-    deleteInstallation(params: { installationId: string  }): Promise<{}>;
+    deleteInstallation(params: { installationId: string }): Promise<{}>;
     /**
      * Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
      *

package/types/channel.d.ts

@@ -37,7 +37,7 @@ interface Membership {
 interface Resolved {
     _res: any;
 }
-declare type Actionable = Document | Row | File | Execution | Team | Membership;
+declare type Actionable = Document | Row | File | Team | Membership;
 export declare class Channel<T> {
     private readonly segments;
     _type: T;
@@ -50,21 +50,23 @@ export declare class Channel<T> {
     table(this: Channel<TablesDB>, id?: string): Channel<Table>;
     row(this: Channel<Table>, id?: string): Channel<Row>;
     file(this: Channel<Bucket>, id?: string): Channel<File>;
-    execution(this: Channel<Func>, id?: string): Channel<Execution>;
     create(this: Channel<Actionable>): 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(userId?: string): string;
-    static get documents(): string;
-    static get rows(): string;
-    static get files(): string;
-    static get executions(): string;
+    static account(): string;
+    static documents(): string;
+    static rows(): string;
+    static files(): string;
+    static executions(): string;
+    static teams(): string;
+    static memberships(): string;
 }
 export declare type ActionableChannel = Channel<Document> | Channel<Row> | Channel<File> | Channel<Execution> | Channel<Team> | Channel<Membership>;
 export declare type ResolvedChannel = Channel<Resolved>;

package/types/client.d.ts

@@ -1,5 +1,6 @@
 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.
  */
@@ -27,11 +28,15 @@ declare type RealtimeResponseEvent<T extends unknown> = {
     /**
      * Timestamp indicating the time of the event.
      */
-    timestamp: number;
+    timestamp: string;
     /**
      * Payload containing event-specific data.
      */
     payload: T;
+    /**
+     * Subscription IDs this event matches (from backend, optional).
+     */
+    subscriptions?: string[];
 };
 /**
  * Type representing upload progress information.
@@ -238,7 +243,7 @@ declare class Client {
      * @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): () => void;
+    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;

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

@@ -0,0 +1,5 @@
+export declare enum BackupServices {
+    Databases = "databases",
+    Functions = "functions",
+    Storage = "storage"
+}

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/build-runtime.d.ts

@@ -21,6 +21,9 @@ export declare enum BuildRuntime {
     Python312 = "python-3.12",
     Pythonml311 = "python-ml-3.11",
     Pythonml312 = "python-ml-3.12",
+    Deno121 = "deno-1.21",
+    Deno124 = "deno-1.24",
+    Deno135 = "deno-1.35",
     Deno140 = "deno-1.40",
     Deno146 = "deno-1.46",
     Deno20 = "deno-2.0",
@@ -35,6 +38,7 @@ export declare enum BuildRuntime {
     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",
@@ -62,5 +66,6 @@ export declare enum BuildRuntime {
     Flutter327 = "flutter-3.27",
     Flutter329 = "flutter-3.29",
     Flutter332 = "flutter-3.32",
-    Flutter335 = "flutter-3.35"
+    Flutter335 = "flutter-3.35",
+    Flutter338 = "flutter-3.38"
 }

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

@@ -3,5 +3,6 @@ export declare enum DeploymentStatus {
     Processing = "processing",
     Building = "building",
     Ready = "ready",
+    Canceled = "canceled",
     Failed = "failed"
 }

package/types/enums/frameworks.d.ts

@@ -0,0 +1,17 @@
+export declare enum Frameworks {
+    Analog = "analog",
+    Angular = "angular",
+    Nextjs = "nextjs",
+    React = "react",
+    Nuxt = "nuxt",
+    Vue = "vue",
+    Sveltekit = "sveltekit",
+    Astro = "astro",
+    Tanstackstart = "tanstack-start",
+    Remix = "remix",
+    Lynx = "lynx",
+    Flutter = "flutter",
+    Reactnative = "react-native",
+    Vite = "vite",
+    Other = "other"
+}

package/types/enums/order-by.d.ts

@@ -0,0 +1,4 @@
+export declare enum OrderBy {
+    Asc = "asc",
+    Desc = "desc"
+}

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

@@ -0,0 +1,6 @@
+export declare enum RegistrationType {
+    New = "new",
+    Transfer = "transfer",
+    Renewal = "renewal",
+    Trade = "trade"
+}

package/types/enums/resources.d.ts

@@ -0,0 +1,13 @@
+export declare enum Resources {
+    User = "user",
+    Database = "database",
+    Table = "table",
+    Column = "column",
+    Index = "index",
+    Row = "row",
+    Document = "document",
+    Attribute = "attribute",
+    Collection = "collection",
+    Bucket = "bucket",
+    File = "file"
+}

package/types/enums/runtime.d.ts

@@ -21,6 +21,9 @@ export declare enum Runtime {
     Python312 = "python-3.12",
     Pythonml311 = "python-ml-3.11",
     Pythonml312 = "python-ml-3.12",
+    Deno121 = "deno-1.21",
+    Deno124 = "deno-1.24",
+    Deno135 = "deno-1.35",
     Deno140 = "deno-1.40",
     Deno146 = "deno-1.46",
     Deno20 = "deno-2.0",
@@ -35,6 +38,7 @@ export declare enum Runtime {
     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",
@@ -62,5 +66,6 @@ export declare enum Runtime {
     Flutter327 = "flutter-3.27",
     Flutter329 = "flutter-3.29",
     Flutter332 = "flutter-3.32",
-    Flutter335 = "flutter-3.35"
+    Flutter335 = "flutter-3.35",
+    Flutter338 = "flutter-3.38"
 }

package/types/enums/runtimes.d.ts

@@ -0,0 +1,71 @@
+export declare enum Runtimes {
+    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",
+    Php80 = "php-8.0",
+    Php81 = "php-8.1",
+    Php82 = "php-8.2",
+    Php83 = "php-8.3",
+    Ruby30 = "ruby-3.0",
+    Ruby31 = "ruby-3.1",
+    Ruby32 = "ruby-3.2",
+    Ruby33 = "ruby-3.3",
+    Python38 = "python-3.8",
+    Python39 = "python-3.9",
+    Python310 = "python-3.10",
+    Python311 = "python-3.11",
+    Python312 = "python-3.12",
+    Pythonml311 = "python-ml-3.11",
+    Pythonml312 = "python-ml-3.12",
+    Deno121 = "deno-1.21",
+    Deno124 = "deno-1.24",
+    Deno135 = "deno-1.35",
+    Deno140 = "deno-1.40",
+    Deno146 = "deno-1.46",
+    Deno20 = "deno-2.0",
+    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",
+    Java80 = "java-8.0",
+    Java110 = "java-11.0",
+    Java170 = "java-17.0",
+    Java180 = "java-18.0",
+    Java210 = "java-21.0",
+    Java22 = "java-22",
+    Swift55 = "swift-5.5",
+    Swift58 = "swift-5.8",
+    Swift59 = "swift-5.9",
+    Swift510 = "swift-5.10",
+    Kotlin16 = "kotlin-1.6",
+    Kotlin18 = "kotlin-1.8",
+    Kotlin19 = "kotlin-1.9",
+    Kotlin20 = "kotlin-2.0",
+    Cpp17 = "cpp-17",
+    Cpp20 = "cpp-20",
+    Bun10 = "bun-1.0",
+    Bun11 = "bun-1.1",
+    Go123 = "go-1.23",
+    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/scopes.d.ts

@@ -0,0 +1,66 @@
+export declare enum Scopes {
+    SessionsWrite = "sessions.write",
+    UsersRead = "users.read",
+    UsersWrite = "users.write",
+    TeamsRead = "teams.read",
+    TeamsWrite = "teams.write",
+    DatabasesRead = "databases.read",
+    DatabasesWrite = "databases.write",
+    CollectionsRead = "collections.read",
+    CollectionsWrite = "collections.write",
+    TablesRead = "tables.read",
+    TablesWrite = "tables.write",
+    AttributesRead = "attributes.read",
+    AttributesWrite = "attributes.write",
+    ColumnsRead = "columns.read",
+    ColumnsWrite = "columns.write",
+    IndexesRead = "indexes.read",
+    IndexesWrite = "indexes.write",
+    DocumentsRead = "documents.read",
+    DocumentsWrite = "documents.write",
+    RowsRead = "rows.read",
+    RowsWrite = "rows.write",
+    FilesRead = "files.read",
+    FilesWrite = "files.write",
+    BucketsRead = "buckets.read",
+    BucketsWrite = "buckets.write",
+    FunctionsRead = "functions.read",
+    FunctionsWrite = "functions.write",
+    SitesRead = "sites.read",
+    SitesWrite = "sites.write",
+    LogRead = "log.read",
+    LogWrite = "log.write",
+    ExecutionRead = "execution.read",
+    ExecutionWrite = "execution.write",
+    LocaleRead = "locale.read",
+    AvatarsRead = "avatars.read",
+    HealthRead = "health.read",
+    ProvidersRead = "providers.read",
+    ProvidersWrite = "providers.write",
+    MessagesRead = "messages.read",
+    MessagesWrite = "messages.write",
+    TopicsRead = "topics.read",
+    TopicsWrite = "topics.write",
+    SubscribersRead = "subscribers.read",
+    SubscribersWrite = "subscribers.write",
+    TargetsRead = "targets.read",
+    TargetsWrite = "targets.write",
+    RulesRead = "rules.read",
+    RulesWrite = "rules.write",
+    MigrationsRead = "migrations.read",
+    MigrationsWrite = "migrations.write",
+    VcsRead = "vcs.read",
+    VcsWrite = "vcs.write",
+    AssistantRead = "assistant.read",
+    TokensRead = "tokens.read",
+    TokensWrite = "tokens.write",
+    PoliciesWrite = "policies.write",
+    PoliciesRead = "policies.read",
+    ArchivesRead = "archives.read",
+    ArchivesWrite = "archives.write",
+    RestorationsRead = "restorations.read",
+    RestorationsWrite = "restorations.write",
+    DomainsRead = "domains.read",
+    DomainsWrite = "domains.write",
+    EventsRead = "events.read"
+}

package/types/enums/use-cases.d.ts

@@ -0,0 +1,11 @@
+export declare enum UseCases {
+    Portfolio = "portfolio",
+    Starter = "starter",
+    Events = "events",
+    Ecommerce = "ecommerce",
+    Documentation = "documentation",
+    Blog = "blog",
+    Ai = "ai",
+    Forms = "forms",
+    Dashboard = "dashboard"
+}

package/types/index.d.ts

@@ -38,6 +38,7 @@ export { Role } from './role';
 export { ID } from './id';
 export { Channel } from './channel';
 export { Operator, Condition } from './operator';
+export { Scopes } from './enums/scopes';
 export { AuthenticatorType } from './enums/authenticator-type';
 export { AuthenticationFactor } from './enums/authentication-factor';
 export { OAuthProvider } from './enums/o-auth-provider';
@@ -46,15 +47,21 @@ export { CreditCard } from './enums/credit-card';
 export { Flag } from './enums/flag';
 export { Theme } from './enums/theme';
 export { Timezone } from './enums/timezone';
+export { BrowserPermission } from './enums/browser-permission';
 export { ImageFormat } from './enums/image-format';
+export { BackupServices } from './enums/backup-services';
 export { Platform } from './enums/platform';
 export { ConsoleResourceType } from './enums/console-resource-type';
 export { UsageRange } from './enums/usage-range';
 export { RelationshipType } from './enums/relationship-type';
 export { RelationMutate } from './enums/relation-mutate';
 export { IndexType } from './enums/index-type';
+export { OrderBy } from './enums/order-by';
+export { RegistrationType } from './enums/registration-type';
 export { FilterType } from './enums/filter-type';
 export { Runtime } from './enums/runtime';
+export { Runtimes } from './enums/runtimes';
+export { UseCases } from './enums/use-cases';
 export { TemplateReferenceType } from './enums/template-reference-type';
 export { VCSReferenceType } from './enums/vcs-reference-type';
 export { DeploymentDownloadType } from './enums/deployment-download-type';
@@ -62,7 +69,7 @@ export { ExecutionMethod } from './enums/execution-method';
 export { Name } from './enums/name';
 export { MessagePriority } from './enums/message-priority';
 export { SmtpEncryption } from './enums/smtp-encryption';
-export { BillingPlan } from './enums/billing-plan';
+export { Resources } from './enums/resources';
 export { ProjectUsageRange } from './enums/project-usage-range';
 export { Region } from './enums/region';
 export { Api } from './enums/api';
@@ -70,7 +77,6 @@ export { AuthMethod } from './enums/auth-method';
 export { PlatformType } from './enums/platform-type';
 export { ApiService } from './enums/api-service';
 export { SMTPSecure } from './enums/smtp-secure';
-export { Status } from './enums/status';
 export { EmailTemplateType } from './enums/email-template-type';
 export { EmailTemplateLocale } from './enums/email-template-locale';
 export { SmsTemplateType } from './enums/sms-template-type';
@@ -80,6 +86,7 @@ export { ProxyResourceType } from './enums/proxy-resource-type';
 export { Framework } from './enums/framework';
 export { BuildRuntime } from './enums/build-runtime';
 export { Adapter } from './enums/adapter';
+export { Frameworks } from './enums/frameworks';
 export { Compression } from './enums/compression';
 export { ImageGravity } from './enums/image-gravity';
 export { PasswordHash } from './enums/password-hash';