@appwrite.io/console 18.3.0 → 18.4.0-rc.2

package/types/services/account.d.ts

@@ -846,6 +846,135 @@ export declare class Account {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(name: string): Promise<Models.User<Preferences>>;
+    /**
+     * Get the list of verified passkeys registered by the currently logged in user.
+     *
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter and order on the following attributes: $id, $createdAt, $updatedAt
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PasskeyList>}
+     */
+    listPasskeys(params?: {
+        queries?: string[];
+        total?: boolean;
+    }): Promise<Models.PasskeyList>;
+    /**
+     * Get the list of verified passkeys registered by the currently logged in user.
+     *
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter and order on the following attributes: $id, $createdAt, $updatedAt
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PasskeyList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listPasskeys(queries?: string[], total?: boolean): Promise<Models.PasskeyList>;
+    /**
+     * Start registering a passkey for the currently logged in user. The session must have signed in or completed an MFA challenge within the last 10 minutes. Pass the returned `publicKey` options to `navigator.credentials.create()`, then complete the registration with [Update passkey verification](/docs/references/cloud/client-web/account#updatePasskeyVerification). The passkey stays pending until verified, and the challenge expires after 5 minutes.
+     *
+     * @param {string} params.passkeyId - Passkey ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {string} params.name - Passkey name, shown when listing passkeys. Max length: 128 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PasskeyChallenge>}
+     */
+    createPasskey(params?: {
+        passkeyId?: string;
+        name?: string;
+    }): Promise<Models.PasskeyChallenge>;
+    /**
+     * Start registering a passkey for the currently logged in user. The session must have signed in or completed an MFA challenge within the last 10 minutes. Pass the returned `publicKey` options to `navigator.credentials.create()`, then complete the registration with [Update passkey verification](/docs/references/cloud/client-web/account#updatePasskeyVerification). The passkey stays pending until verified, and the challenge expires after 5 minutes.
+     *
+     * @param {string} passkeyId - Passkey ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {string} name - Passkey name, shown when listing passkeys. Max length: 128 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PasskeyChallenge>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createPasskey(passkeyId?: string, name?: string): Promise<Models.PasskeyChallenge>;
+    /**
+     * Get a verified passkey of the currently logged in user by its unique ID.
+     *
+     * @param {string} params.passkeyId - Passkey ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Passkey>}
+     */
+    getPasskey(params: {
+        passkeyId: string;
+    }): Promise<Models.Passkey>;
+    /**
+     * Get a verified passkey of the currently logged in user by its unique ID.
+     *
+     * @param {string} passkeyId - Passkey ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Passkey>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getPasskey(passkeyId: string): Promise<Models.Passkey>;
+    /**
+     * Rename a passkey of the currently logged in user.
+     *
+     * @param {string} params.passkeyId - Passkey ID.
+     * @param {string} params.name - Passkey name. Max length: 128 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Passkey>}
+     */
+    updatePasskey(params: {
+        passkeyId: string;
+        name: string;
+    }): Promise<Models.Passkey>;
+    /**
+     * Rename a passkey of the currently logged in user.
+     *
+     * @param {string} passkeyId - Passkey ID.
+     * @param {string} name - Passkey name. Max length: 128 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Passkey>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updatePasskey(passkeyId: string, name: string): Promise<Models.Passkey>;
+    /**
+     * Delete a passkey from the currently logged in user. The passkey can no longer be used to sign in, although it may remain stored on the user's device. The session must have signed in or completed an MFA challenge within the last 10 minutes.
+     *
+     * @param {string} params.passkeyId - Passkey ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deletePasskey(params: {
+        passkeyId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a passkey from the currently logged in user. The passkey can no longer be used to sign in, although it may remain stored on the user's device. The session must have signed in or completed an MFA challenge within the last 10 minutes.
+     *
+     * @param {string} passkeyId - Passkey ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deletePasskey(passkeyId: string): Promise<{}>;
+    /**
+     * Complete a passkey registration started with [Create passkey](/docs/references/cloud/client-web/account#createPasskey). Pass the challenge ID and the JSON form of the credential returned by `navigator.credentials.create()`, for example `credential.toJSON()`. Each challenge can only be used once.
+     *
+     * @param {string} params.passkeyId - Passkey ID.
+     * @param {string} params.challengeId - Challenge ID returned when the passkey was created.
+     * @param {object} params.credential - Registration credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Passkey>}
+     */
+    updatePasskeyVerification(params: {
+        passkeyId: string;
+        challengeId: string;
+        credential: object;
+    }): Promise<Models.Passkey>;
+    /**
+     * Complete a passkey registration started with [Create passkey](/docs/references/cloud/client-web/account#createPasskey). Pass the challenge ID and the JSON form of the credential returned by `navigator.credentials.create()`, for example `credential.toJSON()`. Each challenge can only be used once.
+     *
+     * @param {string} passkeyId - Passkey ID.
+     * @param {string} challengeId - Challenge ID returned when the passkey was created.
+     * @param {object} credential - Registration credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Passkey>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updatePasskeyVerification(passkeyId: string, challengeId: string, credential: object): Promise<Models.Passkey>;
     /**
      * Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.
      *
@@ -1632,6 +1761,35 @@ export declare class Account {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     createOAuth2Token(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | string;
+    /**
+     * Start signing in with a passkey. No email or user ID is needed: pass the returned `publicKey` options to `navigator.credentials.get()` and the user picks one of their passkeys. Then call [Update passkey token](/docs/references/cloud/client-web/account#updatePasskeyToken) with the credential to receive a token, and exchange it with [Create session](/docs/references/cloud/client-web/account#createSession). The challenge expires after 5 minutes.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PasskeyChallenge>}
+     */
+    createPasskeyToken(): Promise<Models.PasskeyChallenge>;
+    /**
+     * Complete a passkey sign-in started with [Create passkey token](/docs/references/cloud/client-web/account#createPasskeyToken). Pass the challenge ID and the JSON form of the credential returned by `navigator.credentials.get()`, for example `credential.toJSON()`. The returned token includes its secret and expires after 1 minute: exchange it for a session with [Create session](/docs/references/cloud/client-web/account#createSession). Passkeys require user verification, so the session also satisfies MFA. Each challenge can only be used once.
+     *
+     * @param {string} params.challengeId - Challenge ID returned by createPasskeyToken.
+     * @param {object} params.credential - Authentication credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Token>}
+     */
+    updatePasskeyToken(params: {
+        challengeId: string;
+        credential: object;
+    }): Promise<Models.Token>;
+    /**
+     * Complete a passkey sign-in started with [Create passkey token](/docs/references/cloud/client-web/account#createPasskeyToken). Pass the challenge ID and the JSON form of the credential returned by `navigator.credentials.get()`, for example `credential.toJSON()`. The returned token includes its secret and expires after 1 minute: exchange it for a session with [Create session](/docs/references/cloud/client-web/account#createSession). Passkeys require user verification, so the session also satisfies MFA. Each challenge can only be used once.
+     *
+     * @param {string} challengeId - Challenge ID returned by createPasskeyToken.
+     * @param {object} credential - Authentication credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Token>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updatePasskeyToken(challengeId: string, credential: object): Promise<Models.Token>;
     /**
      * Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.
      *

package/types/services/admin.d.ts

@@ -0,0 +1,80 @@
+import { Client } from '../client';
+import { PlatformResourceType } from '../enums/platform-resource-type';
+import { ProjectResourceType } from '../enums/project-resource-type';
+export declare class Admin {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Delete everything cached from the platform database in the region serving the request.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deletePlatformCache(): Promise<{}>;
+    /**
+     * Delete the cache of one platform resource, or of every resource of a type, in the region serving the request.
+     *
+     * @param {PlatformResourceType} params.resourceType - Resource type.
+     * @param {string} params.resourceId - Resource ID. Leave empty to delete the cache of every resource of this type.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deletePlatformResourceCache(params: {
+        resourceType: PlatformResourceType;
+        resourceId?: string;
+    }): Promise<{}>;
+    /**
+     * Delete the cache of one platform resource, or of every resource of a type, in the region serving the request.
+     *
+     * @param {PlatformResourceType} resourceType - Resource type.
+     * @param {string} resourceId - Resource ID. Leave empty to delete the cache of every resource of this type.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deletePlatformResourceCache(resourceType: PlatformResourceType, resourceId?: string): Promise<{}>;
+    /**
+     * Delete everything cached for a project. Send the request to the project's region.
+     *
+     * @param {string} params.projectId - Project ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteProjectCache(params: {
+        projectId: string;
+    }): Promise<{}>;
+    /**
+     * Delete everything cached for a project. Send the request to the project's region.
+     *
+     * @param {string} projectId - Project ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteProjectCache(projectId: string): Promise<{}>;
+    /**
+     * Delete the cache of one project resource, or of every resource of a type. Send the request to the project's region.
+     *
+     * @param {string} params.projectId - Project ID.
+     * @param {ProjectResourceType} params.resourceType - Resource type.
+     * @param {string} params.resourceId - Resource ID. Leave empty to delete the cache of every resource of this type.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteProjectResourceCache(params: {
+        projectId: string;
+        resourceType: ProjectResourceType;
+        resourceId?: string;
+    }): Promise<{}>;
+    /**
+     * Delete the cache of one project resource, or of every resource of a type. Send the request to the project's region.
+     *
+     * @param {string} projectId - Project ID.
+     * @param {ProjectResourceType} resourceType - Resource type.
+     * @param {string} resourceId - Resource ID. Leave empty to delete the cache of every resource of this type.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteProjectResourceCache(projectId: string, resourceType: ProjectResourceType, resourceId?: string): Promise<{}>;
+}

package/types/services/analytics-tracking.d.ts

@@ -0,0 +1,211 @@
+/**
+ * Analytics auto-tracking helpers.
+ *
+ * These are hand-written companions to the generated `Analytics` service.
+ * The generated service exposes `createEvent(params)` for arbitrary events;
+ * this module wires up common auto-tracking behaviours (pageviews, outbound
+ * links, downloads, scroll depth, active engagement) on top of it.
+ *
+ * The tracking helpers accept a plain event-emitter function so they do not
+ * hard-couple to the generated `Analytics` class. The emitter adapts this
+ * module's option shape to `createEvent`: `url` is required there, and `props`
+ * is a flat alternating key/value list rather than an object.
+ *
+ * ```ts
+ * const analytics = new Analytics(client);
+ * const tracking = new AnalyticsTracking(
+ *     (name, options) => analytics.createEvent({
+ *         propertyId: options?.propertyId ?? '<PROPERTY_ID>',
+ *         name,
+ *         url: options?.url ?? window.location.href,
+ *         referrer: options?.referrer,
+ *         scrollDepth: options?.scrollDepth,
+ *         engagementTime: options?.engagementTime,
+ *         props: Object.entries(options?.props ?? {}).flatMap(
+ *             ([key, value]) => [key, String(value)],
+ *         ),
+ *     }),
+ *     { propertyId: '<PROPERTY_ID>' }
+ * );
+ * tracking.enableAllAutoTracking();
+ * ```
+ *
+ * `propertyId` is optional: when set it is merged into the options of every
+ * emitted event, so an emitter that forwards `options.propertyId` (as above)
+ * picks it up instead of every caller hand-rolling it into the closure.
+ * Per-event `propertyId` always wins over the configured default.
+ *
+ * All helpers respect `navigator.doNotTrack === '1'` by default; opt out with
+ * `respectDoNotTrack: false` in the constructor options.
+ *
+ * Engagement time follows Plausible's model: rather than one total at unload,
+ * a delta is emitted at every natural checkpoint of the visit (tab hidden, SPA
+ * route change, unload). See `enableAutoEngagementTime` for details.
+ *
+ * Auto-emitted event names follow `snake_case` + lowercase (`pageview`,
+ * `outbound_link`, `file_download`, `screen_view`, etc.). Any prop keys use
+ * camelCase to match the endpoint's parameter naming. Callers can pass any
+ * custom event name; the auto-track methods only own the events they emit
+ * themselves.
+ */
+export type AnalyticsEventOptions = {
+    props?: Record<string, unknown>;
+    url?: string;
+    referrer?: string;
+    propertyId?: string;
+    scrollDepth?: number;
+    engagementTime?: number;
+};
+export type AnalyticsEventEmitter = (name: string, options?: AnalyticsEventOptions) => unknown;
+export type AnalyticsTrackingOptions = {
+    /**
+     * When true (default) the tracker becomes a no-op if `navigator.doNotTrack`
+     * is set to `'1'`. Set to false to always fire regardless of the DNT signal.
+     */
+    respectDoNotTrack?: boolean;
+    /**
+     * Analytics property (or snippet) ID to attach to every emitted event.
+     * Optional — omit it when the emitter closure already supplies one. A
+     * `propertyId` passed on an individual event takes precedence.
+     */
+    propertyId?: string;
+};
+export type OutboundTrackingOptions = {
+    /**
+     * When true, links pointing at the current host's subdomains are treated
+     * as outbound. Defaults to false (subdomains are same-origin for tracking).
+     */
+    includeSubdomains?: boolean;
+};
+export type DownloadTrackingOptions = {
+    /**
+     * File extensions (without the leading dot) that mark an anchor as a
+     * download. Defaults cover the common set.
+     */
+    extensions?: string[];
+};
+export declare class AnalyticsTracking {
+    private readonly emit;
+    private readonly respectDoNotTrack;
+    private readonly propertyId?;
+    private pageviewCleanups;
+    private outboundCleanup?;
+    private downloadCleanup?;
+    private scrollCleanups;
+    private engagementCleanups;
+    private currentPath?;
+    private maxScrollDepth;
+    private scrollTicking;
+    private lastScrollReport;
+    private engagementStart;
+    private engagementAccumulatedMs;
+    private engagementActive;
+    constructor(emit: AnalyticsEventEmitter, options?: AnalyticsTrackingOptions);
+    /**
+     * Enable the opinionated default auto-tracking set: pageviews, outbound
+     * links, scroll depth and active engagement time. Downloads must be opted
+     * into separately via `enableAutoDownloadTracking()` because the extension
+     * list is application-specific.
+     */
+    enableAllAutoTracking(): void;
+    /**
+     * Track an event manually. Respects the DNT setting and swallows emitter
+     * exceptions so tracking failures never surface to the host page.
+     */
+    track(name: string, options?: AnalyticsEventOptions): void;
+    /**
+     * Convenience wrapper for pageview-shaped events.
+     */
+    pageview(url?: string, referrer?: string): void;
+    /**
+     * Enable SPA-aware pageview tracking. Fires an initial pageview on
+     * enable, then again on every `pushState`, `replaceState`, `popstate`
+     * or hashchange. Idempotent — repeat calls no-op.
+     */
+    enableAutoPageviews(): void;
+    /**
+     * Disable auto-pageview tracking installed by `enableAutoPageviews`.
+     * Safe to call when auto-pageviews were never enabled.
+     */
+    disableAutoPageviews(): void;
+    /**
+     * Enable click-based outbound link tracking. Detects anchor clicks that
+     * navigate to a different origin and fires an `outbound_link` event
+     * (with `hostname` and `href` props) before the browser navigates.
+     */
+    enableAutoOutboundTracking(options?: OutboundTrackingOptions): void;
+    /**
+     * Disable outbound-link tracking installed by `enableAutoOutboundTracking`.
+     * Safe to call when auto-outbound was never enabled.
+     */
+    disableAutoOutboundTracking(): void;
+    /**
+     * Enable click-based download tracking. Detects anchor clicks that point
+     * at a file whose extension appears in the configured list and fires a
+     * `file_download` event with `filename`, `extension` and `href` props.
+     */
+    enableAutoDownloadTracking(options?: DownloadTrackingOptions): void;
+    /**
+     * Disable file-download tracking installed by `enableAutoDownloadTracking`.
+     * Safe to call when auto-download was never enabled.
+     */
+    disableAutoDownloadTracking(): void;
+    /**
+     * Enable passive scroll-depth tracking. Records the maximum percent of the
+     * document scrolled and reports it on `beforeunload` and on SPA route
+     * changes. Uses a throttled passive listener so it is safe on hot paths.
+     */
+    enableAutoScrollDepth(): void;
+    /**
+     * Disable scroll-depth tracking installed by `enableAutoScrollDepth`. Safe
+     * to call when auto-scroll-depth was never enabled. Any accumulated depth
+     * for the current page is dropped.
+     */
+    disableAutoScrollDepth(): void;
+    /**
+     * Enable active engagement-time tracking. Counts time the tab is visible
+     * and uses `visibilitychange` to exclude background time.
+     *
+     * Delivery follows Plausible's model rather than a single total at the
+     * end of the visit: an `engagement_time` event is emitted at every natural
+     * checkpoint — the tab going hidden, an SPA route change, and finally
+     * `beforeunload`/`pagehide`. Unload is kept only as a best-effort last
+     * flush; it is the least reliable moment to send anything (browsers
+     * routinely cancel in-flight requests there, and `sendBeacon` cannot set
+     * the `X-Appwrite-Project` header the endpoint requires), so it must never
+     * be the only delivery.
+     *
+     * Each event carries a **delta** — the seconds accrued since the previous
+     * flush, not a running total — so the values are additive per session and
+     * a lost event costs only its own slice.
+     *
+     * There is deliberately no periodic ping. The cadence is driven by
+     * navigation and tab switches, so request volume tracks what the visitor
+     * actually does instead of multiplying with time on page.
+     */
+    enableAutoEngagementTime(): void;
+    /**
+     * Disable engagement-time tracking installed by `enableAutoEngagementTime`.
+     * Safe to call when auto-engagement was never enabled. Any accumulated
+     * engagement time is dropped without being emitted.
+     */
+    disableAutoEngagementTime(): void;
+    /**
+     * Merge the configured `propertyId` into an event's options. Returns the
+     * caller's object untouched when no default is configured (or the event
+     * already carries one), so emitters written against the pre-`propertyId`
+     * shape keep receiving exactly what they received before.
+     */
+    private withPropertyId;
+    private canTrack;
+    private currentPageUrl;
+    private findAnchor;
+    private parseUrl;
+    private isExternal;
+    private rootDomain;
+    private computeScrollDepth;
+    private flushScrollDepth;
+    private startEngagement;
+    private pauseEngagement;
+    private flushEngagement;
+}