@appwrite.io/console 12.2.0 → 13.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cjs/sdk.js +1719 -1204
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1717 -1205
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +1736 -1221
- package/package.json +1 -1
- package/types/channel.d.ts +8 -3
- package/types/client.d.ts +1 -1
- package/types/enums/account-key-scopes.d.ts +5 -0
- package/types/enums/appwrite-migration-resource.d.ts +1 -0
- package/types/enums/backup-services.d.ts +1 -0
- package/types/enums/{resource-type.d.ts → block-resource-type.d.ts} +2 -6
- package/types/enums/{theme.d.ts → browser-theme.d.ts} +1 -1
- package/types/enums/cache-database.d.ts +5 -0
- package/types/enums/cache-target.d.ts +8 -0
- package/types/enums/{registration-type.d.ts → domain-registration-type.d.ts} +1 -1
- package/types/enums/{filter-type.d.ts → domain-suggestion-type.d.ts} +1 -1
- package/types/enums/{model.d.ts → embedding-model.d.ts} +1 -1
- package/types/enums/{runtime.d.ts → function-runtime.d.ts} +4 -2
- package/types/enums/function-template-use-case.d.ts +9 -0
- package/types/enums/{name.d.ts → health-queue-name.d.ts} +1 -1
- package/types/enums/{on-duplicate.d.ts → migration-on-duplicate.d.ts} +1 -1
- package/types/enums/o-auth-2-google-prompt.d.ts +5 -0
- package/types/enums/o-auth-provider.d.ts +1 -3
- package/types/enums/organization-addon.d.ts +4 -0
- package/types/enums/organization-key-scopes.d.ts +12 -0
- package/types/enums/{auth-method.d.ts → project-auth-method-id.d.ts} +1 -1
- package/types/enums/{email-template-type.d.ts → project-email-template-id.d.ts} +1 -1
- package/types/enums/{email-template-locale.d.ts → project-email-template-locale.d.ts} +1 -1
- package/types/enums/{scopes.d.ts → project-key-scopes.d.ts} +10 -8
- package/types/enums/project-o-auth-2-google-prompt.d.ts +5 -0
- package/types/enums/project-o-auth-provider-id.d.ts +45 -0
- package/types/enums/{project-policy.d.ts → project-policy-id.d.ts} +1 -1
- package/types/enums/{protocol-id.d.ts → project-protocol-id.d.ts} +1 -1
- package/types/enums/{service-id.d.ts → project-service-id.d.ts} +3 -2
- package/types/enums/project-smtp-secure.d.ts +4 -0
- package/types/enums/project-status.d.ts +3 -0
- package/types/enums/query-suggestion-resource.d.ts +10 -1
- package/types/enums/redirect-status-code.d.ts +6 -0
- package/types/enums/schedule-resource-type.d.ts +6 -0
- package/types/enums/{adapter.d.ts → site-adapter.d.ts} +1 -1
- package/types/enums/{runtimes.d.ts → site-build-runtime.d.ts} +4 -2
- package/types/enums/{framework.d.ts → site-framework.d.ts} +1 -1
- package/types/enums/{use-cases.d.ts → site-template-use-case.d.ts} +3 -8
- package/types/index.d.ts +36 -26
- package/types/models.d.ts +1186 -1185
- package/types/services/account.d.ts +9 -9
- package/types/services/avatars.d.ts +5 -5
- package/types/services/console.d.ts +31 -0
- package/types/services/documents-db.d.ts +1 -4
- package/types/services/domains.d.ts +216 -216
- package/types/services/functions.d.ts +36 -25
- package/types/services/health.d.ts +5 -5
- package/types/services/manager.d.ts +49 -9
- package/types/services/migrations.d.ts +13 -13
- package/types/services/organization.d.ts +234 -0
- package/types/services/organizations.d.ts +5 -131
- package/types/services/presences.d.ts +166 -0
- package/types/services/project.d.ts +226 -215
- package/types/services/projects.d.ts +10 -159
- package/types/services/proxy.d.ts +5 -5
- package/types/services/realtime.d.ts +45 -3
- package/types/services/sites.d.ts +43 -32
- package/types/services/usage.d.ts +50 -0
- package/types/services/vectors-db.d.ts +6 -9
- package/types/enums/addon.d.ts +0 -3
- package/types/enums/build-runtime.d.ts +0 -91
- package/types/enums/frameworks.d.ts +0 -17
- package/types/enums/secure.d.ts +0 -4
- package/types/enums/status-code.d.ts +0 -6
- package/types/enums/status.d.ts +0 -3
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
export declare class Usage {
|
|
4
|
+
client: Client;
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* Query usage event metrics from the usage database. Returns individual event rows with full metadata. Pass Query objects as JSON strings to filter, paginate, and order results. Supported query methods: equal, greaterThanEqual, lessThanEqual, orderAsc, orderDesc, limit, offset. Supported filter attributes: metric, path, method, status, resource, resourceId, country, userAgent, time (these match the underlying column names — note that the response surfaces `resource` as `resourceType` and `country` as `countryCode`). When no time filter is supplied the endpoint defaults to the last 7 days. Default `limit(100)` is applied if none is given; user-supplied limits are capped at 500. The `total` field is capped at 5000 to keep counts predictable — pass `total=false` to skip the count entirely.
|
|
8
|
+
*
|
|
9
|
+
* @param {string[]} params.queries - Array of query strings as JSON. Supported: equal("metric", [...]), equal("path", [...]), equal("method", [...]), equal("status", [...]), equal("resource", [...]), equal("resourceId", [...]), equal("country", [...]), equal("userAgent", [...]), greaterThanEqual("time", "..."), lessThanEqual("time", "..."), orderAsc("time"), orderDesc("time"), limit(N), offset(N).
|
|
10
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
11
|
+
* @throws {AppwriteException}
|
|
12
|
+
* @returns {Promise<Models.UsageEventList>}
|
|
13
|
+
*/
|
|
14
|
+
listEvents(params?: {
|
|
15
|
+
queries?: string[];
|
|
16
|
+
total?: boolean;
|
|
17
|
+
}): Promise<Models.UsageEventList>;
|
|
18
|
+
/**
|
|
19
|
+
* Query usage event metrics from the usage database. Returns individual event rows with full metadata. Pass Query objects as JSON strings to filter, paginate, and order results. Supported query methods: equal, greaterThanEqual, lessThanEqual, orderAsc, orderDesc, limit, offset. Supported filter attributes: metric, path, method, status, resource, resourceId, country, userAgent, time (these match the underlying column names — note that the response surfaces `resource` as `resourceType` and `country` as `countryCode`). When no time filter is supplied the endpoint defaults to the last 7 days. Default `limit(100)` is applied if none is given; user-supplied limits are capped at 500. The `total` field is capped at 5000 to keep counts predictable — pass `total=false` to skip the count entirely.
|
|
20
|
+
*
|
|
21
|
+
* @param {string[]} queries - Array of query strings as JSON. Supported: equal("metric", [...]), equal("path", [...]), equal("method", [...]), equal("status", [...]), equal("resource", [...]), equal("resourceId", [...]), equal("country", [...]), equal("userAgent", [...]), greaterThanEqual("time", "..."), lessThanEqual("time", "..."), orderAsc("time"), orderDesc("time"), limit(N), offset(N).
|
|
22
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
23
|
+
* @throws {AppwriteException}
|
|
24
|
+
* @returns {Promise<Models.UsageEventList>}
|
|
25
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
26
|
+
*/
|
|
27
|
+
listEvents(queries?: string[], total?: boolean): Promise<Models.UsageEventList>;
|
|
28
|
+
/**
|
|
29
|
+
* Query usage gauge metrics (point-in-time resource snapshots) from the usage database. Returns individual gauge snapshots with metric, value, timestamp, resourceType, and resourceId. Pass Query objects as JSON strings to filter, paginate, and order results. Supported query methods: equal, greaterThanEqual, lessThanEqual, orderAsc, orderDesc, limit, offset. Supported filter attributes: metric, time. Use `orderDesc("time"), limit(1)` to fetch the most recent snapshot. When no time filter is supplied the endpoint defaults to the last 7 days. Default `limit(100)` is applied if none is given; user-supplied limits are capped at 500. The `total` field is capped at 5000 to keep counts predictable — pass `total=false` to skip the count entirely.
|
|
30
|
+
*
|
|
31
|
+
* @param {string[]} params.queries - Array of query strings as JSON. Supported: equal("metric", [...]), greaterThanEqual("time", "..."), lessThanEqual("time", "..."), orderAsc("time"), orderDesc("time"), limit(N), offset(N).
|
|
32
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
33
|
+
* @throws {AppwriteException}
|
|
34
|
+
* @returns {Promise<Models.UsageGaugeList>}
|
|
35
|
+
*/
|
|
36
|
+
listGauges(params?: {
|
|
37
|
+
queries?: string[];
|
|
38
|
+
total?: boolean;
|
|
39
|
+
}): Promise<Models.UsageGaugeList>;
|
|
40
|
+
/**
|
|
41
|
+
* Query usage gauge metrics (point-in-time resource snapshots) from the usage database. Returns individual gauge snapshots with metric, value, timestamp, resourceType, and resourceId. Pass Query objects as JSON strings to filter, paginate, and order results. Supported query methods: equal, greaterThanEqual, lessThanEqual, orderAsc, orderDesc, limit, offset. Supported filter attributes: metric, time. Use `orderDesc("time"), limit(1)` to fetch the most recent snapshot. When no time filter is supplied the endpoint defaults to the last 7 days. Default `limit(100)` is applied if none is given; user-supplied limits are capped at 500. The `total` field is capped at 5000 to keep counts predictable — pass `total=false` to skip the count entirely.
|
|
42
|
+
*
|
|
43
|
+
* @param {string[]} queries - Array of query strings as JSON. Supported: equal("metric", [...]), greaterThanEqual("time", "..."), lessThanEqual("time", "..."), orderAsc("time"), orderDesc("time"), limit(N), offset(N).
|
|
44
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
45
|
+
* @throws {AppwriteException}
|
|
46
|
+
* @returns {Promise<Models.UsageGaugeList>}
|
|
47
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
48
|
+
*/
|
|
49
|
+
listGauges(queries?: string[], total?: boolean): Promise<Models.UsageGaugeList>;
|
|
50
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
-
import {
|
|
3
|
+
import { EmbeddingModel } from '../enums/embedding-model';
|
|
4
4
|
import { UsageRange } from '../enums/usage-range';
|
|
5
5
|
import { VectorsDBIndexType } from '../enums/vectors-db-index-type';
|
|
6
6
|
import { OrderBy } from '../enums/order-by';
|
|
@@ -11,27 +11,24 @@ export declare class VectorsDB {
|
|
|
11
11
|
* Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.
|
|
12
12
|
*
|
|
13
13
|
* @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 on the following columns: name
|
|
14
|
-
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
15
14
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
16
15
|
* @throws {AppwriteException}
|
|
17
16
|
* @returns {Promise<Models.DatabaseList>}
|
|
18
17
|
*/
|
|
19
18
|
list(params?: {
|
|
20
19
|
queries?: string[];
|
|
21
|
-
search?: string;
|
|
22
20
|
total?: boolean;
|
|
23
21
|
}): Promise<Models.DatabaseList>;
|
|
24
22
|
/**
|
|
25
23
|
* Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.
|
|
26
24
|
*
|
|
27
25
|
* @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 on the following columns: name
|
|
28
|
-
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
29
26
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
30
27
|
* @throws {AppwriteException}
|
|
31
28
|
* @returns {Promise<Models.DatabaseList>}
|
|
32
29
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
33
30
|
*/
|
|
34
|
-
list(queries?: string[],
|
|
31
|
+
list(queries?: string[], total?: boolean): Promise<Models.DatabaseList>;
|
|
35
32
|
/**
|
|
36
33
|
* Create a new Database.
|
|
37
34
|
*
|
|
@@ -63,24 +60,24 @@ export declare class VectorsDB {
|
|
|
63
60
|
* Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#documentsDBCreateCollection) API or directly from your database console.
|
|
64
61
|
*
|
|
65
62
|
* @param {string[]} params.texts - Array of text to generate embeddings.
|
|
66
|
-
* @param {
|
|
63
|
+
* @param {EmbeddingModel} params.model - The embedding model to use for generating vector embeddings.
|
|
67
64
|
* @throws {AppwriteException}
|
|
68
65
|
* @returns {Promise<Models.EmbeddingList>}
|
|
69
66
|
*/
|
|
70
67
|
createTextEmbeddings(params: {
|
|
71
68
|
texts: string[];
|
|
72
|
-
model?:
|
|
69
|
+
model?: EmbeddingModel;
|
|
73
70
|
}): Promise<Models.EmbeddingList>;
|
|
74
71
|
/**
|
|
75
72
|
* Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#documentsDBCreateCollection) API or directly from your database console.
|
|
76
73
|
*
|
|
77
74
|
* @param {string[]} texts - Array of text to generate embeddings.
|
|
78
|
-
* @param {
|
|
75
|
+
* @param {EmbeddingModel} model - The embedding model to use for generating vector embeddings.
|
|
79
76
|
* @throws {AppwriteException}
|
|
80
77
|
* @returns {Promise<Models.EmbeddingList>}
|
|
81
78
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
82
79
|
*/
|
|
83
|
-
createTextEmbeddings(texts: string[], model?:
|
|
80
|
+
createTextEmbeddings(texts: string[], model?: EmbeddingModel): Promise<Models.EmbeddingList>;
|
|
84
81
|
/**
|
|
85
82
|
* List transactions across all databases.
|
|
86
83
|
*
|
package/types/enums/addon.d.ts
DELETED
|
@@ -1,91 +0,0 @@
|
|
|
1
|
-
export declare enum BuildRuntime {
|
|
2
|
-
Node145 = "node-14.5",
|
|
3
|
-
Node160 = "node-16.0",
|
|
4
|
-
Node180 = "node-18.0",
|
|
5
|
-
Node190 = "node-19.0",
|
|
6
|
-
Node200 = "node-20.0",
|
|
7
|
-
Node210 = "node-21.0",
|
|
8
|
-
Node22 = "node-22",
|
|
9
|
-
Node23 = "node-23",
|
|
10
|
-
Node24 = "node-24",
|
|
11
|
-
Node25 = "node-25",
|
|
12
|
-
Php80 = "php-8.0",
|
|
13
|
-
Php81 = "php-8.1",
|
|
14
|
-
Php82 = "php-8.2",
|
|
15
|
-
Php83 = "php-8.3",
|
|
16
|
-
Php84 = "php-8.4",
|
|
17
|
-
Ruby30 = "ruby-3.0",
|
|
18
|
-
Ruby31 = "ruby-3.1",
|
|
19
|
-
Ruby32 = "ruby-3.2",
|
|
20
|
-
Ruby33 = "ruby-3.3",
|
|
21
|
-
Ruby34 = "ruby-3.4",
|
|
22
|
-
Ruby40 = "ruby-4.0",
|
|
23
|
-
Python38 = "python-3.8",
|
|
24
|
-
Python39 = "python-3.9",
|
|
25
|
-
Python310 = "python-3.10",
|
|
26
|
-
Python311 = "python-3.11",
|
|
27
|
-
Python312 = "python-3.12",
|
|
28
|
-
Python313 = "python-3.13",
|
|
29
|
-
Python314 = "python-3.14",
|
|
30
|
-
Pythonml311 = "python-ml-3.11",
|
|
31
|
-
Pythonml312 = "python-ml-3.12",
|
|
32
|
-
Pythonml313 = "python-ml-3.13",
|
|
33
|
-
Deno140 = "deno-1.40",
|
|
34
|
-
Deno146 = "deno-1.46",
|
|
35
|
-
Deno20 = "deno-2.0",
|
|
36
|
-
Deno25 = "deno-2.5",
|
|
37
|
-
Deno26 = "deno-2.6",
|
|
38
|
-
Dart215 = "dart-2.15",
|
|
39
|
-
Dart216 = "dart-2.16",
|
|
40
|
-
Dart217 = "dart-2.17",
|
|
41
|
-
Dart218 = "dart-2.18",
|
|
42
|
-
Dart219 = "dart-2.19",
|
|
43
|
-
Dart30 = "dart-3.0",
|
|
44
|
-
Dart31 = "dart-3.1",
|
|
45
|
-
Dart33 = "dart-3.3",
|
|
46
|
-
Dart35 = "dart-3.5",
|
|
47
|
-
Dart38 = "dart-3.8",
|
|
48
|
-
Dart39 = "dart-3.9",
|
|
49
|
-
Dart310 = "dart-3.10",
|
|
50
|
-
Dart311 = "dart-3.11",
|
|
51
|
-
Dotnet60 = "dotnet-6.0",
|
|
52
|
-
Dotnet70 = "dotnet-7.0",
|
|
53
|
-
Dotnet80 = "dotnet-8.0",
|
|
54
|
-
Dotnet10 = "dotnet-10",
|
|
55
|
-
Java80 = "java-8.0",
|
|
56
|
-
Java110 = "java-11.0",
|
|
57
|
-
Java170 = "java-17.0",
|
|
58
|
-
Java180 = "java-18.0",
|
|
59
|
-
Java210 = "java-21.0",
|
|
60
|
-
Java22 = "java-22",
|
|
61
|
-
Java25 = "java-25",
|
|
62
|
-
Swift55 = "swift-5.5",
|
|
63
|
-
Swift58 = "swift-5.8",
|
|
64
|
-
Swift59 = "swift-5.9",
|
|
65
|
-
Swift510 = "swift-5.10",
|
|
66
|
-
Swift62 = "swift-6.2",
|
|
67
|
-
Kotlin16 = "kotlin-1.6",
|
|
68
|
-
Kotlin18 = "kotlin-1.8",
|
|
69
|
-
Kotlin19 = "kotlin-1.9",
|
|
70
|
-
Kotlin20 = "kotlin-2.0",
|
|
71
|
-
Kotlin23 = "kotlin-2.3",
|
|
72
|
-
Cpp17 = "cpp-17",
|
|
73
|
-
Cpp20 = "cpp-20",
|
|
74
|
-
Bun10 = "bun-1.0",
|
|
75
|
-
Bun11 = "bun-1.1",
|
|
76
|
-
Bun12 = "bun-1.2",
|
|
77
|
-
Bun13 = "bun-1.3",
|
|
78
|
-
Go123 = "go-1.23",
|
|
79
|
-
Go124 = "go-1.24",
|
|
80
|
-
Go125 = "go-1.25",
|
|
81
|
-
Go126 = "go-1.26",
|
|
82
|
-
Rust183 = "rust-1.83",
|
|
83
|
-
Static1 = "static-1",
|
|
84
|
-
Flutter324 = "flutter-3.24",
|
|
85
|
-
Flutter327 = "flutter-3.27",
|
|
86
|
-
Flutter329 = "flutter-3.29",
|
|
87
|
-
Flutter332 = "flutter-3.32",
|
|
88
|
-
Flutter335 = "flutter-3.35",
|
|
89
|
-
Flutter338 = "flutter-3.38",
|
|
90
|
-
Flutter341 = "flutter-3.41"
|
|
91
|
-
}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
export declare enum Frameworks {
|
|
2
|
-
Analog = "analog",
|
|
3
|
-
Angular = "angular",
|
|
4
|
-
Nextjs = "nextjs",
|
|
5
|
-
React = "react",
|
|
6
|
-
Nuxt = "nuxt",
|
|
7
|
-
Vue = "vue",
|
|
8
|
-
Sveltekit = "sveltekit",
|
|
9
|
-
Astro = "astro",
|
|
10
|
-
Tanstackstart = "tanstack-start",
|
|
11
|
-
Remix = "remix",
|
|
12
|
-
Lynx = "lynx",
|
|
13
|
-
Flutter = "flutter",
|
|
14
|
-
Reactnative = "react-native",
|
|
15
|
-
Vite = "vite",
|
|
16
|
-
Other = "other"
|
|
17
|
-
}
|
package/types/enums/secure.d.ts
DELETED
package/types/enums/status.d.ts
DELETED