@appwrite.io/console 13.1.0 → 14.0.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.
Files changed (40) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/sdk.js +5059 -687
  3. package/dist/cjs/sdk.js.map +1 -1
  4. package/dist/esm/sdk.js +5057 -688
  5. package/dist/esm/sdk.js.map +1 -1
  6. package/dist/iife/sdk.js +5061 -689
  7. package/package.json +1 -1
  8. package/types/enums/{site-adapter.d.ts → adapter.d.ts} +1 -1
  9. package/types/enums/{organization-addon.d.ts → addon.d.ts} +1 -1
  10. package/types/enums/appwrite-migration-resource.d.ts +13 -1
  11. package/types/enums/{function-runtime.d.ts → build-runtime.d.ts} +1 -1
  12. package/types/enums/embedding-model.d.ts +4 -1
  13. package/types/enums/{site-framework.d.ts → framework.d.ts} +1 -1
  14. package/types/enums/{migration-on-duplicate.d.ts → on-duplicate.d.ts} +1 -1
  15. package/types/enums/project-key-scopes.d.ts +3 -0
  16. package/types/enums/project-policy-id.d.ts +5 -1
  17. package/types/enums/query-suggestion-resource.d.ts +3 -0
  18. package/types/enums/{site-build-runtime.d.ts → runtime.d.ts} +1 -1
  19. package/types/enums/{redirect-status-code.d.ts → status-code.d.ts} +1 -1
  20. package/types/enums/status.d.ts +3 -0
  21. package/types/index.d.ts +11 -8
  22. package/types/models.d.ts +1490 -67
  23. package/types/services/account.d.ts +2 -2
  24. package/types/services/advisor.d.ts +123 -0
  25. package/types/services/apps.d.ts +302 -0
  26. package/types/services/compute.d.ts +1074 -0
  27. package/types/services/databases.d.ts +24 -24
  28. package/types/services/documents-db.d.ts +4 -1
  29. package/types/services/functions.d.ts +13 -13
  30. package/types/services/health.d.ts +8 -0
  31. package/types/services/messaging.d.ts +92 -0
  32. package/types/services/migrations.d.ts +13 -13
  33. package/types/services/organizations.d.ts +13 -13
  34. package/types/services/project.d.ts +96 -7
  35. package/types/services/projects.d.ts +5 -5
  36. package/types/services/proxy.d.ts +5 -5
  37. package/types/services/sites.d.ts +27 -27
  38. package/types/services/tables-db.d.ts +28 -25
  39. package/types/services/vectors-db.d.ts +4 -1
  40. package/types/enums/project-status.d.ts +0 -3
@@ -40,6 +40,7 @@ export declare class TablesDB {
40
40
  * @param {string} params.databaseId - Unique 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.
41
41
  * @param {string} params.name - Database name. Max length: 128 chars.
42
42
  * @param {boolean} params.enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
43
+ * @param {string} params.dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
43
44
  * @throws {AppwriteException}
44
45
  * @returns {Promise<Models.Database>}
45
46
  */
@@ -47,6 +48,7 @@ export declare class TablesDB {
47
48
  databaseId: string;
48
49
  name: string;
49
50
  enabled?: boolean;
51
+ dedicatedDatabaseId?: string;
50
52
  }): Promise<Models.Database>;
51
53
  /**
52
54
  * Create a new Database.
@@ -55,11 +57,12 @@ export declare class TablesDB {
55
57
  * @param {string} databaseId - Unique 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.
56
58
  * @param {string} name - Database name. Max length: 128 chars.
57
59
  * @param {boolean} enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
60
+ * @param {string} dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
58
61
  * @throws {AppwriteException}
59
62
  * @returns {Promise<Models.Database>}
60
63
  * @deprecated Use the object parameter style method for a better developer experience.
61
64
  */
62
- create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
65
+ create(databaseId: string, name: string, enabled?: boolean, dedicatedDatabaseId?: string): Promise<Models.Database>;
63
66
  /**
64
67
  * List transactions across all databases.
65
68
  *
@@ -1059,7 +1062,7 @@ export declare class TablesDB {
1059
1062
  * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1060
1063
  * @param {string} params.key - Column Key.
1061
1064
  * @param {boolean} params.required - Is column required?
1062
- * @param {any[]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
1065
+ * @param {any[][]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
1063
1066
  * @throws {AppwriteException}
1064
1067
  * @returns {Promise<Models.ColumnLine>}
1065
1068
  */
@@ -1068,7 +1071,7 @@ export declare class TablesDB {
1068
1071
  tableId: string;
1069
1072
  key: string;
1070
1073
  required: boolean;
1071
- xdefault?: any[];
1074
+ xdefault?: any[][];
1072
1075
  }): Promise<Models.ColumnLine>;
1073
1076
  /**
1074
1077
  * Create a geometric line column.
@@ -1077,12 +1080,12 @@ export declare class TablesDB {
1077
1080
  * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1078
1081
  * @param {string} key - Column Key.
1079
1082
  * @param {boolean} required - Is column required?
1080
- * @param {any[]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
1083
+ * @param {any[][]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
1081
1084
  * @throws {AppwriteException}
1082
1085
  * @returns {Promise<Models.ColumnLine>}
1083
1086
  * @deprecated Use the object parameter style method for a better developer experience.
1084
1087
  */
1085
- createLineColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.ColumnLine>;
1088
+ createLineColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[][]): Promise<Models.ColumnLine>;
1086
1089
  /**
1087
1090
  * Update a line column. Changing the `default` value will not update already existing rows.
1088
1091
  *
@@ -1090,7 +1093,7 @@ export declare class TablesDB {
1090
1093
  * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1091
1094
  * @param {string} params.key - Column Key.
1092
1095
  * @param {boolean} params.required - Is column required?
1093
- * @param {any[]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
1096
+ * @param {any[][]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
1094
1097
  * @param {string} params.newKey - New Column Key.
1095
1098
  * @throws {AppwriteException}
1096
1099
  * @returns {Promise<Models.ColumnLine>}
@@ -1100,7 +1103,7 @@ export declare class TablesDB {
1100
1103
  tableId: string;
1101
1104
  key: string;
1102
1105
  required: boolean;
1103
- xdefault?: any[];
1106
+ xdefault?: any[][];
1104
1107
  newKey?: string;
1105
1108
  }): Promise<Models.ColumnLine>;
1106
1109
  /**
@@ -1110,13 +1113,13 @@ export declare class TablesDB {
1110
1113
  * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1111
1114
  * @param {string} key - Column Key.
1112
1115
  * @param {boolean} required - Is column required?
1113
- * @param {any[]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
1116
+ * @param {any[][]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
1114
1117
  * @param {string} newKey - New Column Key.
1115
1118
  * @throws {AppwriteException}
1116
1119
  * @returns {Promise<Models.ColumnLine>}
1117
1120
  * @deprecated Use the object parameter style method for a better developer experience.
1118
1121
  */
1119
- updateLineColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnLine>;
1122
+ updateLineColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[][], newKey?: string): Promise<Models.ColumnLine>;
1120
1123
  /**
1121
1124
  * Create a longtext column.
1122
1125
  *
@@ -1274,7 +1277,7 @@ export declare class TablesDB {
1274
1277
  * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1275
1278
  * @param {string} params.key - Column Key.
1276
1279
  * @param {boolean} params.required - Is column required?
1277
- * @param {any[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
1280
+ * @param {number[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
1278
1281
  * @throws {AppwriteException}
1279
1282
  * @returns {Promise<Models.ColumnPoint>}
1280
1283
  */
@@ -1283,7 +1286,7 @@ export declare class TablesDB {
1283
1286
  tableId: string;
1284
1287
  key: string;
1285
1288
  required: boolean;
1286
- xdefault?: any[];
1289
+ xdefault?: number[];
1287
1290
  }): Promise<Models.ColumnPoint>;
1288
1291
  /**
1289
1292
  * Create a geometric point column.
@@ -1292,12 +1295,12 @@ export declare class TablesDB {
1292
1295
  * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1293
1296
  * @param {string} key - Column Key.
1294
1297
  * @param {boolean} required - Is column required?
1295
- * @param {any[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
1298
+ * @param {number[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
1296
1299
  * @throws {AppwriteException}
1297
1300
  * @returns {Promise<Models.ColumnPoint>}
1298
1301
  * @deprecated Use the object parameter style method for a better developer experience.
1299
1302
  */
1300
- createPointColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.ColumnPoint>;
1303
+ createPointColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: number[]): Promise<Models.ColumnPoint>;
1301
1304
  /**
1302
1305
  * Update a point column. Changing the `default` value will not update already existing rows.
1303
1306
  *
@@ -1305,7 +1308,7 @@ export declare class TablesDB {
1305
1308
  * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1306
1309
  * @param {string} params.key - Column Key.
1307
1310
  * @param {boolean} params.required - Is column required?
1308
- * @param {any[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
1311
+ * @param {number[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
1309
1312
  * @param {string} params.newKey - New Column Key.
1310
1313
  * @throws {AppwriteException}
1311
1314
  * @returns {Promise<Models.ColumnPoint>}
@@ -1315,7 +1318,7 @@ export declare class TablesDB {
1315
1318
  tableId: string;
1316
1319
  key: string;
1317
1320
  required: boolean;
1318
- xdefault?: any[];
1321
+ xdefault?: number[];
1319
1322
  newKey?: string;
1320
1323
  }): Promise<Models.ColumnPoint>;
1321
1324
  /**
@@ -1325,13 +1328,13 @@ export declare class TablesDB {
1325
1328
  * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1326
1329
  * @param {string} key - Column Key.
1327
1330
  * @param {boolean} required - Is column required?
1328
- * @param {any[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
1331
+ * @param {number[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
1329
1332
  * @param {string} newKey - New Column Key.
1330
1333
  * @throws {AppwriteException}
1331
1334
  * @returns {Promise<Models.ColumnPoint>}
1332
1335
  * @deprecated Use the object parameter style method for a better developer experience.
1333
1336
  */
1334
- updatePointColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnPoint>;
1337
+ updatePointColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: number[], newKey?: string): Promise<Models.ColumnPoint>;
1335
1338
  /**
1336
1339
  * Create a geometric polygon column.
1337
1340
  *
@@ -1339,7 +1342,7 @@ export declare class TablesDB {
1339
1342
  * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1340
1343
  * @param {string} params.key - Column Key.
1341
1344
  * @param {boolean} params.required - Is column required?
1342
- * @param {any[]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
1345
+ * @param {any[][]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
1343
1346
  * @throws {AppwriteException}
1344
1347
  * @returns {Promise<Models.ColumnPolygon>}
1345
1348
  */
@@ -1348,7 +1351,7 @@ export declare class TablesDB {
1348
1351
  tableId: string;
1349
1352
  key: string;
1350
1353
  required: boolean;
1351
- xdefault?: any[];
1354
+ xdefault?: any[][];
1352
1355
  }): Promise<Models.ColumnPolygon>;
1353
1356
  /**
1354
1357
  * Create a geometric polygon column.
@@ -1357,12 +1360,12 @@ export declare class TablesDB {
1357
1360
  * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1358
1361
  * @param {string} key - Column Key.
1359
1362
  * @param {boolean} required - Is column required?
1360
- * @param {any[]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
1363
+ * @param {any[][]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
1361
1364
  * @throws {AppwriteException}
1362
1365
  * @returns {Promise<Models.ColumnPolygon>}
1363
1366
  * @deprecated Use the object parameter style method for a better developer experience.
1364
1367
  */
1365
- createPolygonColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.ColumnPolygon>;
1368
+ createPolygonColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[][]): Promise<Models.ColumnPolygon>;
1366
1369
  /**
1367
1370
  * Update a polygon column. Changing the `default` value will not update already existing rows.
1368
1371
  *
@@ -1370,7 +1373,7 @@ export declare class TablesDB {
1370
1373
  * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1371
1374
  * @param {string} params.key - Column Key.
1372
1375
  * @param {boolean} params.required - Is column required?
1373
- * @param {any[]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
1376
+ * @param {any[][]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
1374
1377
  * @param {string} params.newKey - New Column Key.
1375
1378
  * @throws {AppwriteException}
1376
1379
  * @returns {Promise<Models.ColumnPolygon>}
@@ -1380,7 +1383,7 @@ export declare class TablesDB {
1380
1383
  tableId: string;
1381
1384
  key: string;
1382
1385
  required: boolean;
1383
- xdefault?: any[];
1386
+ xdefault?: any[][];
1384
1387
  newKey?: string;
1385
1388
  }): Promise<Models.ColumnPolygon>;
1386
1389
  /**
@@ -1390,13 +1393,13 @@ export declare class TablesDB {
1390
1393
  * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1391
1394
  * @param {string} key - Column Key.
1392
1395
  * @param {boolean} required - Is column required?
1393
- * @param {any[]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
1396
+ * @param {any[][]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
1394
1397
  * @param {string} newKey - New Column Key.
1395
1398
  * @throws {AppwriteException}
1396
1399
  * @returns {Promise<Models.ColumnPolygon>}
1397
1400
  * @deprecated Use the object parameter style method for a better developer experience.
1398
1401
  */
1399
- updatePolygonColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnPolygon>;
1402
+ updatePolygonColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[][], newKey?: string): Promise<Models.ColumnPolygon>;
1400
1403
  /**
1401
1404
  * Create relationship column. [Learn more about relationship columns](https://appwrite.io/docs/databases-relationships#relationship-columns).
1402
1405
  *
@@ -36,6 +36,7 @@ export declare class VectorsDB {
36
36
  * @param {string} params.databaseId - Unique 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.
37
37
  * @param {string} params.name - Database name. Max length: 128 chars.
38
38
  * @param {boolean} params.enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
39
+ * @param {string} params.dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
39
40
  * @throws {AppwriteException}
40
41
  * @returns {Promise<Models.Database>}
41
42
  */
@@ -43,6 +44,7 @@ export declare class VectorsDB {
43
44
  databaseId: string;
44
45
  name: string;
45
46
  enabled?: boolean;
47
+ dedicatedDatabaseId?: string;
46
48
  }): Promise<Models.Database>;
47
49
  /**
48
50
  * Create a new Database.
@@ -51,11 +53,12 @@ export declare class VectorsDB {
51
53
  * @param {string} databaseId - Unique 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.
52
54
  * @param {string} name - Database name. Max length: 128 chars.
53
55
  * @param {boolean} enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
56
+ * @param {string} dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
54
57
  * @throws {AppwriteException}
55
58
  * @returns {Promise<Models.Database>}
56
59
  * @deprecated Use the object parameter style method for a better developer experience.
57
60
  */
58
- create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
61
+ create(databaseId: string, name: string, enabled?: boolean, dedicatedDatabaseId?: string): Promise<Models.Database>;
59
62
  /**
60
63
  * 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.
61
64
  *
@@ -1,3 +0,0 @@
1
- export declare enum ProjectStatus {
2
- Active = "active"
3
- }