@appwrite.io/console 18.3.0-rc.1 → 18.3.0

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.3.0-rc.1",
+    "version": "18.3.0",
     "license": "BSD-3-Clause",
     "main": "dist/cjs/sdk.js",
     "exports": {

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

@@ -121,7 +121,5 @@ export declare enum ProjectKeyScopes {
     AppsWrite = "apps.write",
     Oauth2Read = "oauth2.read",
     Oauth2Write = "oauth2.write",
-    Oauth2Introspect = "oauth2.introspect",
-    AnalyticsRead = "analytics.read",
-    AnalyticsWrite = "analytics.write"
+    Oauth2Introspect = "oauth2.introspect"
 }

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

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

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

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

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

@@ -1,7 +1,4 @@
 export declare enum UsageEventMetric {
-    AnalyticsEvents = "analytics.events",
-    AnalyticsPageviews = "analytics.pageviews",
-    AnalyticsBotsEvents = "analytics.bots.events",
     NetworkRequests = "network.requests",
     NetworkInbound = "network.inbound",
     NetworkOutbound = "network.outbound",

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

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

package/types/index.d.ts

@@ -11,7 +11,6 @@ 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';
@@ -53,11 +52,9 @@ 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';
@@ -70,8 +67,6 @@ 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

@@ -4328,6 +4328,10 @@ export declare namespace Models {
          * Function execution schedule in CRON format.
          */
         schedule: string;
+        /**
+         * Minutes between scheduled executions. 0 when the function has no interval.
+         */
+        interval?: number;
         /**
          * Function execution timeout in seconds.
          */
@@ -7448,7 +7452,7 @@ export declare namespace Models {
          */
         deploymentId: string;
         /**
-         * Type of deployment resource: function, site, or dedicatedDatabase.
+         * Type of deployment. Possible values are "function", "site". Used if rule's type is "deployment".
          */
         deploymentResourceType?: ProxyRuleDeploymentResourceType;
         /**
@@ -7508,6 +7512,10 @@ export declare namespace Models {
          * The CRON schedule expression.
          */
         schedule: string;
+        /**
+         * Minutes between runs. 0 when the schedule has no interval.
+         */
+        interval?: number;
         /**
          * Schedule data used to store resource-specific context needed for execution.
          */
@@ -8904,117 +8912,6 @@ 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
      */
@@ -9165,17 +9062,17 @@ export declare namespace Models {
          */
         policyId: string;
         /**
-         * Archive size in bytes. Null until the size is known.
+         * Archive size in bytes.
          */
-        size?: number;
+        size: number;
         /**
          * The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.
          */
         status: string;
         /**
-         * The backup start time. Null until the backup starts.
+         * The backup start time.
          */
-        startedAt?: string;
+        startedAt: string;
         /**
          * Migration ID.
          */
@@ -9547,9 +9444,9 @@ export declare namespace Models {
          */
         alertLimit: number;
         /**
-         * Additional resources. Null when the plan does not support usage billing.
+         * Additional resources
          */
-        usage?: UsageBillingPlan;
+        usage: UsageBillingPlan;
         /**
          * Addons
          */
@@ -9654,6 +9551,10 @@ export declare namespace Models {
          * Maximum function and site deployment size in MB
          */
         buildSize: number;
+        /**
+         * Shortest function schedule interval allowed, in minutes. 0 allows every interval.
+         */
+        functionsIntervalMinimum: number;
         /**
          * Does the plan support encrypted string attributes or not.
          */
@@ -10502,9 +10403,9 @@ export declare namespace Models {
          */
         uptime: number;
         /**
-         * Connection statistics. Null when the database has not been probed.
+         * Connection statistics.
          */
-        connections?: DatabaseStatusConnections;
+        connections: DatabaseStatusConnections;
         /**
          * Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.
          */
@@ -11903,9 +11804,9 @@ export declare namespace Models {
          */
         status: string;
         /**
-         * The restoration start time. Null until the restoration starts.
+         * The backup start time.
          */
-        startedAt?: string;
+        startedAt: string;
         /**
          * Migration ID.
          */
@@ -11919,9 +11820,9 @@ export declare namespace Models {
          */
         resources: string[];
         /**
-         * Restoration options as a key-value object.
+         * Optional data in key-value object.
          */
-        options: object;
+        options: string;
     };
     /**
      * Dedicated database restorations list
@@ -12232,10 +12133,6 @@ 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.
          */
@@ -13477,19 +13374,6 @@ 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
      */

package/types/service.d.ts

@@ -0,0 +1,11 @@
+import { Client } from './client';
+import type { Payload } from './client';
+export declare class Service {
+    /**
+     * The size for chunked uploads in bytes.
+     */
+    static CHUNK_SIZE: number;
+    client: Client;
+    constructor(client: Client);
+    static flatten(data: Payload, prefix?: string): Payload;
+}

package/types/services/functions.d.ts

@@ -43,7 +43,7 @@ export declare class Functions {
      * @param {Runtime} params.runtime - Execution runtime.
      * @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
      * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
-     * @param {string} params.schedule - Schedule CRON syntax.
+     * @param {string} params.schedule - Schedule CRON syntax. Cannot be combined with interval.
      * @param {number} params.timeout - Function maximum execution time in seconds.
      * @param {boolean} params.enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
      * @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
@@ -60,6 +60,7 @@ export declare class Functions {
      * @param {string} params.buildSpecification - Build specification for the function deployments.
      * @param {string} params.runtimeSpecification - Runtime specification for the function executions.
      * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+     * @param {number} params.interval - Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      */
@@ -86,6 +87,7 @@ export declare class Functions {
         buildSpecification?: string;
         runtimeSpecification?: string;
         deploymentRetention?: number;
+        interval?: number;
     }): Promise<Models.Function>;
     /**
      * Create a new function. You can pass a list of [permissions](https://appwrite.io/docs/permissions) to allow different project users or team with access to execute the function using the client API.
@@ -95,7 +97,7 @@ export declare class Functions {
      * @param {Runtime} runtime - Execution runtime.
      * @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
      * @param {string[]} events - Events list. Maximum of 100 events are allowed.
-     * @param {string} schedule - Schedule CRON syntax.
+     * @param {string} schedule - Schedule CRON syntax. Cannot be combined with interval.
      * @param {number} timeout - Function maximum execution time in seconds.
      * @param {boolean} enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
      * @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
@@ -112,11 +114,12 @@ export declare class Functions {
      * @param {string} buildSpecification - Build specification for the function deployments.
      * @param {string} runtimeSpecification - Runtime specification for the function executions.
      * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+     * @param {number} interval - Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
+    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number, interval?: number): Promise<Models.Function>;
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *
@@ -235,7 +238,7 @@ export declare class Functions {
      * @param {Runtime} params.runtime - Execution runtime.
      * @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
      * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
-     * @param {string} params.schedule - Schedule CRON syntax.
+     * @param {string} params.schedule - Schedule CRON syntax. Cannot be combined with interval.
      * @param {number} params.timeout - Maximum execution time in seconds.
      * @param {boolean} params.enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
      * @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
@@ -252,6 +255,7 @@ export declare class Functions {
      * @param {string} params.buildSpecification - Build specification for the function deployments.
      * @param {string} params.runtimeSpecification - Runtime specification for the function executions.
      * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+     * @param {number} params.interval - Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule. When omitted, the current interval is kept unless schedule is set.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      */
@@ -278,6 +282,7 @@ export declare class Functions {
         buildSpecification?: string;
         runtimeSpecification?: string;
         deploymentRetention?: number;
+        interval?: number;
     }): Promise<Models.Function>;
     /**
      * Update function by its unique ID.
@@ -287,7 +292,7 @@ export declare class Functions {
      * @param {Runtime} runtime - Execution runtime.
      * @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
      * @param {string[]} events - Events list. Maximum of 100 events are allowed.
-     * @param {string} schedule - Schedule CRON syntax.
+     * @param {string} schedule - Schedule CRON syntax. Cannot be combined with interval.
      * @param {number} timeout - Maximum execution time in seconds.
      * @param {boolean} enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
      * @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
@@ -304,11 +309,12 @@ export declare class Functions {
      * @param {string} buildSpecification - Build specification for the function deployments.
      * @param {string} runtimeSpecification - Runtime specification for the function executions.
      * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
+     * @param {number} interval - Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule. When omitted, the current interval is kept unless schedule is set.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
+    update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number, interval?: number): Promise<Models.Function>;
     /**
      * Delete a function by its unique ID.
      *

package/types/services/projects.d.ts

@@ -195,9 +195,10 @@ export declare class Projects {
      * @param {string} params.projectId - Project unique ID.
      * @param {ScheduleResourceType} params.resourceType - The resource type for the schedule. Possible values: function, execution, message, backup.
      * @param {string} params.resourceId - The resource ID to associate with this schedule.
-     * @param {string} params.schedule - Schedule CRON expression.
+     * @param {string} params.schedule - Schedule CRON expression. Cannot be combined with interval.
      * @param {boolean} params.active - Whether the schedule is active.
      * @param {object} params.data - Schedule data as a JSON string. Used to store resource-specific context needed for execution.
+     * @param {number} params.interval - Minutes between runs, for function schedules only. Use 0 to disable. Cannot be combined with schedule.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Schedule>}
      */
@@ -205,9 +206,10 @@ export declare class Projects {
         projectId: string;
         resourceType: ScheduleResourceType;
         resourceId: string;
-        schedule: string;
+        schedule?: string;
         active?: boolean;
         data?: object;
+        interval?: number;
     }): Promise<Models.Schedule>;
     /**
      * Create a new schedule for a resource.
@@ -215,14 +217,15 @@ export declare class Projects {
      * @param {string} projectId - Project unique ID.
      * @param {ScheduleResourceType} resourceType - The resource type for the schedule. Possible values: function, execution, message, backup.
      * @param {string} resourceId - The resource ID to associate with this schedule.
-     * @param {string} schedule - Schedule CRON expression.
+     * @param {string} schedule - Schedule CRON expression. Cannot be combined with interval.
      * @param {boolean} active - Whether the schedule is active.
      * @param {object} data - Schedule data as a JSON string. Used to store resource-specific context needed for execution.
+     * @param {number} interval - Minutes between runs, for function schedules only. Use 0 to disable. Cannot be combined with schedule.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Schedule>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createSchedule(projectId: string, resourceType: ScheduleResourceType, resourceId: string, schedule: string, active?: boolean, data?: object): Promise<Models.Schedule>;
+    createSchedule(projectId: string, resourceType: ScheduleResourceType, resourceId: string, schedule?: string, active?: boolean, data?: object, interval?: number): Promise<Models.Schedule>;
     /**
      * Get a schedule by its unique ID.
      *

package/types/services/push.d.ts

@@ -1,4 +1,5 @@
 import { Client } from '../client';
+import { Service } from '../service';
 import type { ResolvedTopic, Topic } from '../topic';
 /** A message delivered on a subscribed topic (the MQTT analog of a Realtime event). */
 export interface PushMessage {
@@ -57,8 +58,7 @@ export interface PushSubscription {
  *     );
  *     // sub.update({ background: true }); sub.unsubscribe();
  */
-export declare class Push {
-    client: Client;
+export declare class Push extends Service {
     private mqtt;
     private connecting;
     private Buffer;

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

@@ -1,24 +0,0 @@
-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

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