@appwrite.io/console 18.1.0 → 18.3.0-rc.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": "18.1.0",
+    "version": "18.3.0-rc.1",
     "license": "BSD-3-Clause",
     "main": "dist/cjs/sdk.js",
     "exports": {
@@ -58,7 +58,7 @@
         "typescript-eslint": "8.70.0"
     },
     "overrides": {
-        "brace-expansion": "5.0.9"
+        "brace-expansion": "5.0.12"
     },
     "jsdelivr": "dist/iife/sdk.js",
     "unpkg": "dist/iife/sdk.js"

package/types/client.d.ts

@@ -172,7 +172,10 @@ declare class Client {
      *
      * A stable client id for the AppwritePush service. The broker keys its
      * offline-replay cursor on this id, so pass a stable value to resume replay across
-     * reloads/restarts. Defaults to a per-connection id when unset.
+     * reloads/restarts. Defaults, when unset, to one per user and tab: stable across reloads of
+     * the tab, different in every other tab, and distinct for each connection open at the same
+     * time, so no two connections take over each other's session. An explicit id shared by
+     * several tabs or connections makes them do that.
      *
      * @param {string} pushClientId
      *

package/types/enums/analytics-dimension.d.ts

@@ -0,0 +1,24 @@
+export declare enum AnalyticsDimension {
+    Country = "country",
+    Region = "region",
+    City = "city",
+    Browser = "browser",
+    OperatingSystem = "operatingSystem",
+    Device = "device",
+    ScreenSize = "screenSize",
+    ReferrerSource = "referrerSource",
+    Channel = "channel",
+    UtmSource = "utmSource",
+    UtmMedium = "utmMedium",
+    UtmCampaign = "utmCampaign",
+    UtmContent = "utmContent",
+    UtmTerm = "utmTerm",
+    Page = "page",
+    Hostname = "hostname",
+    EntryPage = "entryPage",
+    ExitPage = "exitPage",
+    TrafficType = "trafficType",
+    BotName = "botName",
+    BotCategory = "botCategory",
+    EventName = "eventName"
+}

package/types/enums/analytics-interval.d.ts

@@ -0,0 +1,6 @@
+export declare enum AnalyticsInterval {
+    OneHour = "1h",
+    OneDay = "1d",
+    OneWeek = "1w",
+    OneMonth = "1m"
+}

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

@@ -31,6 +31,9 @@ export declare enum BuildRuntime {
     Pythonml311 = "python-ml-3.11",
     Pythonml312 = "python-ml-3.12",
     Pythonml313 = "python-ml-3.13",
+    Deno121 = "deno-1.21",
+    Deno124 = "deno-1.24",
+    Deno135 = "deno-1.35",
     Deno140 = "deno-1.40",
     Deno146 = "deno-1.46",
     Deno20 = "deno-2.0",

package/types/enums/o-auth-provider.d.ts

@@ -41,6 +41,7 @@ export declare enum OAuthProvider {
     Tradeshift = "tradeshift",
     TradeshiftBox = "tradeshiftBox",
     Twitch = "twitch",
+    Webflow = "webflow",
     Wordpress = "wordpress",
     X = "x",
     Yahoo = "yahoo",

package/types/enums/project-key-scopes.d.ts

@@ -89,6 +89,7 @@ export declare enum ProjectKeyScopes {
     WebhooksWrite = "webhooks.write",
     LocaleRead = "locale.read",
     AvatarsRead = "avatars.read",
+    AvatarsWrite = "avatars.write",
     HealthRead = "health.read",
     AssistantRead = "assistant.read",
     MigrationsRead = "migrations.read",
@@ -120,5 +121,7 @@ export declare enum ProjectKeyScopes {
     AppsWrite = "apps.write",
     Oauth2Read = "oauth2.read",
     Oauth2Write = "oauth2.write",
-    Oauth2Introspect = "oauth2.introspect"
+    Oauth2Introspect = "oauth2.introspect",
+    AnalyticsRead = "analytics.read",
+    AnalyticsWrite = "analytics.write"
 }

package/types/enums/project-o-auth-provider-id.d.ts

@@ -41,6 +41,7 @@ export declare enum ProjectOAuthProviderId {
     Tradeshift = "tradeshift",
     TradeshiftBox = "tradeshiftBox",
     Twitch = "twitch",
+    Webflow = "webflow",
     Wordpress = "wordpress",
     X = "x",
     Yahoo = "yahoo",

package/types/enums/proxy-rule-deployment-resource-type.d.ts

@@ -1,4 +1,5 @@
 export declare enum ProxyRuleDeploymentResourceType {
     Function = "function",
-    Site = "site"
+    Site = "site",
+    DedicatedDatabase = "dedicatedDatabase"
 }

package/types/enums/query-suggestion-resource.d.ts

@@ -88,6 +88,7 @@ export declare enum QuerySuggestionResource {
     ResourceTokens = "resourcetokens",
     Transactions = "transactions",
     TransactionLogs = "transactionlogs",
+    AnalyticsProperties = "analyticsproperties",
     DedicatedDatabases = "dedicateddatabases",
     DedicatedDatabaseConfigs = "dedicateddatabaseconfigs",
     DedicatedDatabaseRuntimes = "dedicateddatabaseruntimes",

package/types/enums/runtime.d.ts

@@ -31,6 +31,9 @@ export declare enum Runtime {
     Pythonml311 = "python-ml-3.11",
     Pythonml312 = "python-ml-3.12",
     Pythonml313 = "python-ml-3.13",
+    Deno121 = "deno-1.21",
+    Deno124 = "deno-1.24",
+    Deno135 = "deno-1.35",
     Deno140 = "deno-1.40",
     Deno146 = "deno-1.46",
     Deno20 = "deno-2.0",

package/types/enums/usage-event-dimension.d.ts

@@ -18,6 +18,15 @@ export declare enum UsageEventDimension {
     SdkVersion = "sdkVersion",
     TeamId = "teamId",
     ResourceId = "resourceId",
+    Protocol = "protocol",
+    QueryKeys = "queryKeys",
+    Accept = "accept",
+    AcceptLanguage = "acceptLanguage",
+    PostalCode = "postalCode",
+    Latitude = "latitude",
+    Longitude = "longitude",
+    TimeZone = "timeZone",
+    WeatherCode = "weatherCode",
     Isp = "isp",
     AutonomousSystemNumber = "autonomousSystemNumber",
     AutonomousSystemOrganization = "autonomousSystemOrganization",

package/types/enums/usage-event-metric.d.ts

@@ -1,4 +1,7 @@
 export declare enum UsageEventMetric {
+    AnalyticsEvents = "analytics.events",
+    AnalyticsPageviews = "analytics.pageviews",
+    AnalyticsBotsEvents = "analytics.bots.events",
     NetworkRequests = "network.requests",
     NetworkInbound = "network.inbound",
     NetworkOutbound = "network.outbound",
@@ -6,6 +9,7 @@ export declare enum UsageEventMetric {
     WebhooksEventsFailed = "webhooks.events.failed",
     AuthMethodPhone = "auth.method.phone",
     MessagesSent = "messages.sent",
+    MessagesFailed = "messages.failed",
     MessagesSmsSent = "messages.sms.sent",
     Executions = "executions",
     ExecutionsCompute = "executions.compute",

package/types/enums/usage-gauge-metric.d.ts

@@ -1,4 +1,5 @@
 export declare enum UsageGaugeMetric {
+    AnalyticsProperties = "analytics.properties",
     Teams = "teams",
     Users = "users",
     Messages = "messages",

package/types/index.d.ts

@@ -11,6 +11,7 @@ export { Client, Query, AppwriteException } from './client';
 export { Account } from './services/account';
 export { Activities } from './services/activities';
 export { Affiliates } from './services/affiliates';
+export { Analytics } from './services/analytics';
 export { Apps } from './services/apps';
 export { Avatars } from './services/avatars';
 export { Backups } from './services/backups';
@@ -52,9 +53,11 @@ export { Waf } from './services/waf';
 export { Webhooks } from './services/webhooks';
 export { Realtime } from './services/realtime';
 export { Push } from './services/push';
+export { AnalyticsTracking } from './services/analytics-tracking';
 export type { Models, Payload, RealtimeResponseEvent, UploadProgress, } from './client';
 export type { RealtimeSubscription } from './services/realtime';
 export type { PushMessage, PushSubscription, SubscribeOptions, MessageCallback, } from './services/push';
+export type { AnalyticsEventEmitter, AnalyticsEventOptions, AnalyticsTrackingOptions, DownloadTrackingOptions, OutboundTrackingOptions, } from './services/analytics-tracking';
 export type { QueryTypes, QueryTypesList } from './query';
 export { Permission } from './permission';
 export { Role } from './role';
@@ -67,6 +70,8 @@ export { AuthenticatorType } from './enums/authenticator-type';
 export { AuthenticationFactor } from './enums/authentication-factor';
 export { IdTokenProvider } from './enums/id-token-provider';
 export { OAuthProvider } from './enums/o-auth-provider';
+export { AnalyticsInterval } from './enums/analytics-interval';
+export { AnalyticsDimension } from './enums/analytics-dimension';
 export { Browser } from './enums/browser';
 export { CreditCard } from './enums/credit-card';
 export { Flag } from './enums/flag';

package/types/models.d.ts

@@ -3272,6 +3272,107 @@ export declare namespace Models {
          */
         threads: number;
     };
+    /**
+     * Account
+     */
+    export type Account<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
+        /**
+         * User ID.
+         */
+        $id: string;
+        /**
+         * User creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * User update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * User name.
+         */
+        name: string;
+        /**
+         * User registration date in ISO 8601 format.
+         */
+        registration: string;
+        /**
+         * User status. Pass `true` for enabled and `false` for disabled.
+         */
+        status: boolean;
+        /**
+         * Labels for the user.
+         */
+        labels: string[];
+        /**
+         * Password update time in ISO 8601 format.
+         */
+        passwordUpdate: string;
+        /**
+         * User email address.
+         */
+        email: string;
+        /**
+         * User phone number in E.164 format.
+         */
+        phone: string;
+        /**
+         * Email verification status.
+         */
+        emailVerification: boolean;
+        /**
+         * Canonical form of the user email address.
+         */
+        emailCanonical?: string;
+        /**
+         * Whether the user email is from a free email provider.
+         */
+        emailIsFree?: boolean;
+        /**
+         * Whether the user email is from a disposable email provider.
+         */
+        emailIsDisposable?: boolean;
+        /**
+         * Whether the user email is from a corporate domain.
+         */
+        emailIsCorporate?: boolean;
+        /**
+         * Whether the user email is in its canonical form.
+         */
+        emailIsCanonical?: boolean;
+        /**
+         * Whether the password was found in a known data breach the last time it was checked. Null when the password has never been checked.
+         */
+        passwordPwned?: boolean;
+        /**
+         * Phone verification status.
+         */
+        phoneVerification: boolean;
+        /**
+         * Multi factor authentication status.
+         */
+        mfa: boolean;
+        /**
+         * User preferences as a key-value object
+         */
+        prefs: Preferences;
+        /**
+         * A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.
+         */
+        targets: Target[];
+        /**
+         * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
+         */
+        accessedAt: string;
+        /**
+         * Whether the user can impersonate other users.
+         */
+        impersonator?: boolean;
+        /**
+         * ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.
+         */
+        impersonatorUserId?: string;
+    };
     /**
      * Preferences
      */
@@ -5226,7 +5327,7 @@ export declare namespace Models {
          */
         authUsername: string;
         /**
-         * HTTP basic authentication password.
+         * HTTP basic authentication password. Write-only: always returned empty.
          */
         authPassword: string;
         /**
@@ -5688,6 +5789,27 @@ export declare namespace Models {
          */
         clientSecret: string;
     };
+    /**
+     * OAuth2Webflow
+     */
+    export type OAuth2Webflow = {
+        /**
+         * OAuth2 provider ID.
+         */
+        $id: string;
+        /**
+         * OAuth2 provider is active and can be used to create sessions.
+         */
+        enabled: boolean;
+        /**
+         * Webflow OAuth2 client ID.
+         */
+        clientId: string;
+        /**
+         * Webflow OAuth2 client secret.
+         */
+        clientSecret: string;
+    };
     /**
      * OAuth2Twitch
      */
@@ -6446,7 +6568,7 @@ export declare namespace Models {
         /**
          * List of OAuth2 providers.
          */
-        providers: (Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Appwrite | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft | Models.OAuth2HuggingFace | Models.OAuth2Resend | Models.OAuth2Cloudflare | Models.OAuth2TikTok | Models.OAuth2Kakao)[];
+        providers: (Models.OAuth2Github | Models.OAuth2Discord | Models.OAuth2Figma | Models.OAuth2Dropbox | Models.OAuth2Dailymotion | Models.OAuth2Bitbucket | Models.OAuth2Bitly | Models.OAuth2Box | Models.OAuth2Autodesk | Models.OAuth2Google | Models.OAuth2Zoom | Models.OAuth2Zoho | Models.OAuth2Yandex | Models.OAuth2X | Models.OAuth2WordPress | Models.OAuth2Webflow | Models.OAuth2Twitch | Models.OAuth2Stripe | Models.OAuth2Spotify | Models.OAuth2Slack | Models.OAuth2Podio | Models.OAuth2Notion | Models.OAuth2Salesforce | Models.OAuth2Yahoo | Models.OAuth2Linkedin | Models.OAuth2Disqus | Models.OAuth2Amazon | Models.OAuth2Etsy | Models.OAuth2Facebook | Models.OAuth2Tradeshift | Models.OAuth2Paypal | Models.OAuth2Gitlab | Models.OAuth2Appwrite | Models.OAuth2Authentik | Models.OAuth2Auth0 | Models.OAuth2FusionAuth | Models.OAuth2Keycloak | Models.OAuth2Oidc | Models.OAuth2Apple | Models.OAuth2Okta | Models.OAuth2Kick | Models.OAuth2Microsoft | Models.OAuth2HuggingFace | Models.OAuth2Resend | Models.OAuth2Cloudflare | Models.OAuth2TikTok | Models.OAuth2Kakao)[];
     };
     /**
      * Policy Password Dictionary
@@ -7163,6 +7285,26 @@ export declare namespace Models {
          * Region/state chain when broken down by `subdivisions`.
          */
         subdivisions?: string;
+        /**
+         * Postal code when broken down by `postalCode`.
+         */
+        postalCode?: string;
+        /**
+         * Latitude when broken down by `latitude`.
+         */
+        latitude?: string;
+        /**
+         * Longitude when broken down by `longitude`.
+         */
+        longitude?: string;
+        /**
+         * Time zone when broken down by `timeZone`.
+         */
+        timeZone?: string;
+        /**
+         * Weather station code when broken down by `weatherCode`.
+         */
+        weatherCode?: string;
         /**
          * Internet service provider when broken down by `isp`.
          */
@@ -7306,7 +7448,7 @@ export declare namespace Models {
          */
         deploymentId: string;
         /**
-         * Type of deployment. Possible values are "function", "site". Used if rule's type is "deployment".
+         * Type of deployment resource: function, site, or dedicatedDatabase.
          */
         deploymentResourceType?: ProxyRuleDeploymentResourceType;
         /**
@@ -8762,6 +8904,117 @@ export declare namespace Models {
          */
         resources: UsageResources[];
     };
+    /**
+     * AnalyticsMetric
+     */
+    export type AnalyticsMetric = {
+        /**
+         * Dimension value this row covers. Null when no dimension was requested, empty when the dimension could not be derived for those events.
+         */
+        value?: string;
+        /**
+         * Start of the time bucket this row covers, in ISO 8601. Null when no interval was requested.
+         */
+        date?: string;
+        /**
+         * Unique visitors in the requested range.
+         */
+        visitors: number;
+        /**
+         * Unique sessions in the requested range.
+         */
+        sessions: number;
+        /**
+         * Total pageview events (events with name="pageview") in the requested range. Only the flat aggregate computes it; null on breakdown and time-series rows.
+         */
+        pageviews?: number;
+        /**
+         * Total events in the requested range.
+         */
+        events: number;
+        /**
+         * Total sessions with activity in the requested range. Only the flat aggregate computes it; null on breakdown and time-series rows.
+         */
+        visits?: number;
+        /**
+         * Share of single-event sessions, as a percentage. Only the flat aggregate computes it; null on breakdown and time-series rows.
+         */
+        bounceRate?: number;
+        /**
+         * Average session length in seconds, measured first event to last event. Single-event sessions count as 0. Only the flat aggregate computes it; null on breakdown and time-series rows.
+         */
+        visitDuration?: number;
+        /**
+         * Average pageviews per session (pageviews divided by visits). Only the flat aggregate computes it; null on breakdown and time-series rows.
+         */
+        viewsPerVisit?: number;
+        /**
+         * Average scroll depth across events, as a percentage. Only the flat aggregate computes it; null on breakdown and time-series rows.
+         */
+        scrollDepth?: number;
+        /**
+         * Average engaged time per session in seconds, counting only foreground time. Sessions that reported no engagement are excluded. Only the flat aggregate computes it; null on breakdown and time-series rows.
+         */
+        engagementTime?: number;
+    };
+    /**
+     * AnalyticsMetricList
+     */
+    export type AnalyticsMetricList = {
+        /**
+         * Total number of metric rows returned.
+         */
+        total: number;
+        /**
+         * Metric rows: one per time bucket, one per dimension value, or a single row for the flat aggregate.
+         */
+        metrics: AnalyticsMetric[];
+    };
+    /**
+     * AnalyticsProperty
+     */
+    export type AnalyticsProperty = {
+        /**
+         * Analytics property ID.
+         */
+        $id: string;
+        /**
+         * Property creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Property update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Human-readable name of the tracked website or application.
+         */
+        name: string;
+        /**
+         * Primary domain being tracked (e.g. example.com). May be empty for native apps.
+         */
+        domain: string;
+        /**
+         * IANA timezone used to define the daily boundary for stats.
+         */
+        timezone: string;
+        /**
+         * Whether tracking is currently active.
+         */
+        enabled: boolean;
+        /**
+         * Whether stats for this property are publicly viewable.
+         */
+        public: boolean;
+        /**
+         * List of origins allowed to send tracking events. Use ["*"] to allow all.
+         */
+        allowedOrigins: string[];
+        /**
+         * Unique identifier for the tracking script snippet.
+         */
+        snippetId: string;
+    };
     /**
      * Team
      */
@@ -8912,17 +9165,17 @@ export declare namespace Models {
          */
         policyId: string;
         /**
-         * Archive size in bytes.
+         * Archive size in bytes. Null until the size is known.
          */
-        size: number;
+        size?: number;
         /**
          * The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.
          */
         status: string;
         /**
-         * The backup start time.
+         * The backup start time. Null until the backup starts.
          */
-        startedAt: string;
+        startedAt?: string;
         /**
          * Migration ID.
          */
@@ -9294,9 +9547,9 @@ export declare namespace Models {
          */
         alertLimit: number;
         /**
-         * Additional resources
+         * Additional resources. Null when the plan does not support usage billing.
          */
-        usage: UsageBillingPlan;
+        usage?: UsageBillingPlan;
         /**
          * Addons
          */
@@ -10249,9 +10502,9 @@ export declare namespace Models {
          */
         uptime: number;
         /**
-         * Connection statistics.
+         * Connection statistics. Null when the database has not been probed.
          */
-        connections: DatabaseStatusConnections;
+        connections?: DatabaseStatusConnections;
         /**
          * Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.
          */
@@ -11650,9 +11903,9 @@ export declare namespace Models {
          */
         status: string;
         /**
-         * The backup start time.
+         * The restoration start time. Null until the restoration starts.
          */
-        startedAt: string;
+        startedAt?: string;
         /**
          * Migration ID.
          */
@@ -11666,9 +11919,9 @@ export declare namespace Models {
          */
         resources: string[];
         /**
-         * Optional data in key-value object.
+         * Restoration options as a key-value object.
          */
-        options: string;
+        options: object;
     };
     /**
      * Dedicated database restorations list
@@ -11979,6 +12232,10 @@ export declare namespace Models {
          * Aggregated stats for total backups storage.
          */
         backupsStorageTotal: number;
+        /**
+         * Aggregated stats for total custom user photos storage.
+         */
+        avatarsStorageTotal: number;
         /**
          * Aggregated stats for total storage.
          */
@@ -13220,6 +13477,19 @@ export declare namespace Models {
          */
         addons: Addon[];
     };
+    /**
+     * Analytics properties list
+     */
+    export type AnalyticsPropertyList = {
+        /**
+         * Total number of properties that matched your query.
+         */
+        total: number;
+        /**
+         * List of properties.
+         */
+        properties: AnalyticsProperty[];
+    };
     /**
      * Aggregation team list
      */