@appwrite.io/console 12.0.0 → 12.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/dist/iife/sdk.js CHANGED
@@ -4404,12 +4404,13 @@
4404
4404
  locale: '',
4405
4405
  mode: '',
4406
4406
  cookie: '',
4407
+ session: '',
4408
+ devkey: '',
4407
4409
  impersonateuserid: '',
4408
4410
  impersonateuseremail: '',
4409
4411
  impersonateuserphone: '',
4410
4412
  platform: '',
4411
4413
  selfSigned: false,
4412
- session: undefined,
4413
4414
  };
4414
4415
  /**
4415
4416
  * Custom headers for API requests.
@@ -4418,7 +4419,7 @@
4418
4419
  'x-sdk-name': 'Console',
4419
4420
  'x-sdk-platform': 'console',
4420
4421
  'x-sdk-language': 'web',
4421
- 'x-sdk-version': '12.0.0',
4422
+ 'x-sdk-version': '12.1.0',
4422
4423
  'X-Appwrite-Response-Format': '1.9.3',
4423
4424
  };
4424
4425
  this.realtime = {
@@ -4728,7 +4729,7 @@
4728
4729
  /**
4729
4730
  * Set Cookie
4730
4731
  *
4731
- * The user cookie to authenticate with
4732
+ * The user cookie to authenticate with. Used by SDKs that forward an incoming Cookie header in server-side runtimes.
4732
4733
  *
4733
4734
  * @param value string
4734
4735
  *
@@ -4739,6 +4740,34 @@
4739
4740
  this.config.cookie = value;
4740
4741
  return this;
4741
4742
  }
4743
+ /**
4744
+ * Set Session
4745
+ *
4746
+ * The user session to authenticate with
4747
+ *
4748
+ * @param value string
4749
+ *
4750
+ * @return {this}
4751
+ */
4752
+ setSession(value) {
4753
+ this.headers['X-Appwrite-Session'] = value;
4754
+ this.config.session = value;
4755
+ return this;
4756
+ }
4757
+ /**
4758
+ * Set DevKey
4759
+ *
4760
+ * Your secret dev API key
4761
+ *
4762
+ * @param value string
4763
+ *
4764
+ * @return {this}
4765
+ */
4766
+ setDevKey(value) {
4767
+ this.headers['X-Appwrite-Dev-Key'] = value;
4768
+ this.config.devkey = value;
4769
+ return this;
4770
+ }
4742
4771
  /**
4743
4772
  * Set ImpersonateUserId
4744
4773
  *
@@ -8263,6 +8292,47 @@
8263
8292
  const apiHeaders = {};
8264
8293
  return this.client.call('get', uri, apiHeaders, payload);
8265
8294
  }
8295
+ suggestQueries(paramsOrFirst, ...rest) {
8296
+ let params;
8297
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && ('resource' in paramsOrFirst || 'input' in paramsOrFirst || 'databaseId' in paramsOrFirst || 'tableId' in paramsOrFirst))) {
8298
+ params = (paramsOrFirst || {});
8299
+ }
8300
+ else {
8301
+ params = {
8302
+ resource: paramsOrFirst,
8303
+ input: rest[0],
8304
+ databaseId: rest[1],
8305
+ tableId: rest[2]
8306
+ };
8307
+ }
8308
+ const resource = params.resource;
8309
+ const input = params.input;
8310
+ const databaseId = params.databaseId;
8311
+ const tableId = params.tableId;
8312
+ if (typeof resource === 'undefined') {
8313
+ throw new AppwriteException('Missing required parameter: "resource"');
8314
+ }
8315
+ if (typeof input === 'undefined') {
8316
+ throw new AppwriteException('Missing required parameter: "input"');
8317
+ }
8318
+ const apiPath = '/console/suggestions/queries';
8319
+ const payload = {};
8320
+ if (typeof resource !== 'undefined') {
8321
+ payload['resource'] = resource;
8322
+ }
8323
+ if (typeof input !== 'undefined') {
8324
+ payload['input'] = input;
8325
+ }
8326
+ if (typeof databaseId !== 'undefined') {
8327
+ payload['databaseId'] = databaseId;
8328
+ }
8329
+ if (typeof tableId !== 'undefined') {
8330
+ payload['tableId'] = tableId;
8331
+ }
8332
+ const uri = new URL(this.client.config.endpoint + apiPath);
8333
+ const apiHeaders = {};
8334
+ return this.client.call('get', uri, apiHeaders, payload);
8335
+ }
8266
8336
  /**
8267
8337
  * Get all Environment Variables that are relevant for the console.
8268
8338
  *
@@ -35778,6 +35848,8 @@
35778
35848
  Scopes["MocksWrite"] = "mocks.write";
35779
35849
  Scopes["PoliciesRead"] = "policies.read";
35780
35850
  Scopes["PoliciesWrite"] = "policies.write";
35851
+ Scopes["ProjectPoliciesRead"] = "project.policies.read";
35852
+ Scopes["ProjectPoliciesWrite"] = "project.policies.write";
35781
35853
  Scopes["TemplatesRead"] = "templates.read";
35782
35854
  Scopes["TemplatesWrite"] = "templates.write";
35783
35855
  Scopes["Oauth2Read"] = "oauth2.read";
@@ -35842,6 +35914,8 @@
35842
35914
  Scopes["VcsWrite"] = "vcs.write";
35843
35915
  Scopes["RulesRead"] = "rules.read";
35844
35916
  Scopes["RulesWrite"] = "rules.write";
35917
+ Scopes["BackupsPoliciesRead"] = "backups.policies.read";
35918
+ Scopes["BackupsPoliciesWrite"] = "backups.policies.write";
35845
35919
  Scopes["ArchivesRead"] = "archives.read";
35846
35920
  Scopes["ArchivesWrite"] = "archives.write";
35847
35921
  Scopes["RestorationsRead"] = "restorations.read";
@@ -36638,6 +36712,82 @@
36638
36712
  ConsoleResourceType["Rules"] = "rules";
36639
36713
  })(exports.ConsoleResourceType || (exports.ConsoleResourceType = {}));
36640
36714
 
36715
+ exports.QuerySuggestionResource = void 0;
36716
+ (function (QuerySuggestionResource) {
36717
+ QuerySuggestionResource["Activities"] = "activities";
36718
+ QuerySuggestionResource["ActivityEvents"] = "activityevents";
36719
+ QuerySuggestionResource["Archives"] = "archives";
36720
+ QuerySuggestionResource["Credits"] = "credits";
36721
+ QuerySuggestionResource["DnsRecords"] = "dnsrecords";
36722
+ QuerySuggestionResource["Domains"] = "domains";
36723
+ QuerySuggestionResource["Invoices"] = "invoices";
36724
+ QuerySuggestionResource["PaymentMethods"] = "paymentmethods";
36725
+ QuerySuggestionResource["Policies"] = "policies";
36726
+ QuerySuggestionResource["Projects"] = "projects";
36727
+ QuerySuggestionResource["Restorations"] = "restorations";
36728
+ QuerySuggestionResource["TeamAggregations"] = "teamaggregations";
36729
+ QuerySuggestionResource["Teams"] = "teams";
36730
+ QuerySuggestionResource["Databases"] = "databases";
36731
+ QuerySuggestionResource["Tables"] = "tables";
36732
+ QuerySuggestionResource["Rows"] = "rows";
36733
+ QuerySuggestionResource["Schedules"] = "schedules";
36734
+ QuerySuggestionResource["Platforms"] = "platforms";
36735
+ QuerySuggestionResource["Keys"] = "keys";
36736
+ QuerySuggestionResource["DevKeys"] = "devkeys";
36737
+ QuerySuggestionResource["Webhooks"] = "webhooks";
36738
+ QuerySuggestionResource["Certificates"] = "certificates";
36739
+ QuerySuggestionResource["Realtime"] = "realtime";
36740
+ QuerySuggestionResource["Rules"] = "rules";
36741
+ QuerySuggestionResource["Installations"] = "installations";
36742
+ QuerySuggestionResource["Repositories"] = "repositories";
36743
+ QuerySuggestionResource["VcsComments"] = "vcscomments";
36744
+ QuerySuggestionResource["VcsCommentLocks"] = "vcscommentlocks";
36745
+ QuerySuggestionResource["Users"] = "users";
36746
+ QuerySuggestionResource["Cache"] = "cache";
36747
+ QuerySuggestionResource["Tokens"] = "tokens";
36748
+ QuerySuggestionResource["Authenticators"] = "authenticators";
36749
+ QuerySuggestionResource["Challenges"] = "challenges";
36750
+ QuerySuggestionResource["Sessions"] = "sessions";
36751
+ QuerySuggestionResource["Identities"] = "identities";
36752
+ QuerySuggestionResource["Memberships"] = "memberships";
36753
+ QuerySuggestionResource["Buckets"] = "buckets";
36754
+ QuerySuggestionResource["Providers"] = "providers";
36755
+ QuerySuggestionResource["Messages"] = "messages";
36756
+ QuerySuggestionResource["Topics"] = "topics";
36757
+ QuerySuggestionResource["Subscribers"] = "subscribers";
36758
+ QuerySuggestionResource["Targets"] = "targets";
36759
+ QuerySuggestionResource["Companies"] = "companies";
36760
+ QuerySuggestionResource["BillingAddresses"] = "billingaddresses";
36761
+ QuerySuggestionResource["BillingAggregations"] = "billingaggregations";
36762
+ QuerySuggestionResource["BillingAggregationResources"] = "billingaggregationresources";
36763
+ QuerySuggestionResource["BillingTeamProjectAggregations"] = "billingteamprojectaggregations";
36764
+ QuerySuggestionResource["BillingTeamAggregationsV2"] = "billingteamaggregations_v2";
36765
+ QuerySuggestionResource["BillingTeamAggregationResources"] = "billingteamaggregationresources";
36766
+ QuerySuggestionResource["BillingInvoicesV2"] = "billinginvoices_v2";
36767
+ QuerySuggestionResource["BillingAddons"] = "billingaddons";
36768
+ QuerySuggestionResource["Alerts"] = "alerts";
36769
+ QuerySuggestionResource["Payments"] = "payments";
36770
+ QuerySuggestionResource["BillingDiscounts"] = "billingdiscounts";
36771
+ QuerySuggestionResource["Sources"] = "sources";
36772
+ QuerySuggestionResource["Deals"] = "deals";
36773
+ QuerySuggestionResource["Blocks"] = "blocks";
36774
+ QuerySuggestionResource["Threats"] = "threats";
36775
+ QuerySuggestionResource["Feedbacks"] = "feedbacks";
36776
+ QuerySuggestionResource["ShInstallations"] = "sh_installations";
36777
+ QuerySuggestionResource["Attributes"] = "attributes";
36778
+ QuerySuggestionResource["Indexes"] = "indexes";
36779
+ QuerySuggestionResource["Functions"] = "functions";
36780
+ QuerySuggestionResource["Sites"] = "sites";
36781
+ QuerySuggestionResource["Deployments"] = "deployments";
36782
+ QuerySuggestionResource["Executions"] = "executions";
36783
+ QuerySuggestionResource["Variables"] = "variables";
36784
+ QuerySuggestionResource["Migrations"] = "migrations";
36785
+ QuerySuggestionResource["ResourceTokens"] = "resourcetokens";
36786
+ QuerySuggestionResource["Transactions"] = "transactions";
36787
+ QuerySuggestionResource["TransactionLogs"] = "transactionlogs";
36788
+ QuerySuggestionResource["Stats"] = "stats";
36789
+ })(exports.QuerySuggestionResource || (exports.QuerySuggestionResource = {}));
36790
+
36641
36791
  exports.UsageRange = void 0;
36642
36792
  (function (UsageRange) {
36643
36793
  UsageRange["TwentyFourHours"] = "24h";
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@appwrite.io/console",
3
3
  "homepage": "https://appwrite.io/support",
4
4
  "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",
5
- "version": "12.0.0",
5
+ "version": "12.1.0",
6
6
  "license": "BSD-3-Clause",
7
7
  "main": "dist/cjs/sdk.js",
8
8
  "exports": {
package/types/client.d.ts CHANGED
@@ -114,12 +114,13 @@ declare class Client {
114
114
  locale: string;
115
115
  mode: string;
116
116
  cookie: string;
117
+ session: string;
118
+ devkey: string;
117
119
  impersonateuserid: string;
118
120
  impersonateuseremail: string;
119
121
  impersonateuserphone: string;
120
122
  platform: string;
121
123
  selfSigned: boolean;
122
- session?: string;
123
124
  };
124
125
  /**
125
126
  * Custom headers for API requests.
@@ -209,13 +210,33 @@ declare class Client {
209
210
  /**
210
211
  * Set Cookie
211
212
  *
212
- * The user cookie to authenticate with
213
+ * The user cookie to authenticate with. Used by SDKs that forward an incoming Cookie header in server-side runtimes.
213
214
  *
214
215
  * @param value string
215
216
  *
216
217
  * @return {this}
217
218
  */
218
219
  setCookie(value: string): this;
220
+ /**
221
+ * Set Session
222
+ *
223
+ * The user session to authenticate with
224
+ *
225
+ * @param value string
226
+ *
227
+ * @return {this}
228
+ */
229
+ setSession(value: string): this;
230
+ /**
231
+ * Set DevKey
232
+ *
233
+ * Your secret dev API key
234
+ *
235
+ * @param value string
236
+ *
237
+ * @return {this}
238
+ */
239
+ setDevKey(value: string): this;
219
240
  /**
220
241
  * Set ImpersonateUserId
221
242
  *
@@ -0,0 +1,74 @@
1
+ export declare enum QuerySuggestionResource {
2
+ Activities = "activities",
3
+ ActivityEvents = "activityevents",
4
+ Archives = "archives",
5
+ Credits = "credits",
6
+ DnsRecords = "dnsrecords",
7
+ Domains = "domains",
8
+ Invoices = "invoices",
9
+ PaymentMethods = "paymentmethods",
10
+ Policies = "policies",
11
+ Projects = "projects",
12
+ Restorations = "restorations",
13
+ TeamAggregations = "teamaggregations",
14
+ Teams = "teams",
15
+ Databases = "databases",
16
+ Tables = "tables",
17
+ Rows = "rows",
18
+ Schedules = "schedules",
19
+ Platforms = "platforms",
20
+ Keys = "keys",
21
+ DevKeys = "devkeys",
22
+ Webhooks = "webhooks",
23
+ Certificates = "certificates",
24
+ Realtime = "realtime",
25
+ Rules = "rules",
26
+ Installations = "installations",
27
+ Repositories = "repositories",
28
+ VcsComments = "vcscomments",
29
+ VcsCommentLocks = "vcscommentlocks",
30
+ Users = "users",
31
+ Cache = "cache",
32
+ Tokens = "tokens",
33
+ Authenticators = "authenticators",
34
+ Challenges = "challenges",
35
+ Sessions = "sessions",
36
+ Identities = "identities",
37
+ Memberships = "memberships",
38
+ Buckets = "buckets",
39
+ Providers = "providers",
40
+ Messages = "messages",
41
+ Topics = "topics",
42
+ Subscribers = "subscribers",
43
+ Targets = "targets",
44
+ Companies = "companies",
45
+ BillingAddresses = "billingaddresses",
46
+ BillingAggregations = "billingaggregations",
47
+ BillingAggregationResources = "billingaggregationresources",
48
+ BillingTeamProjectAggregations = "billingteamprojectaggregations",
49
+ BillingTeamAggregationsV2 = "billingteamaggregations_v2",
50
+ BillingTeamAggregationResources = "billingteamaggregationresources",
51
+ BillingInvoicesV2 = "billinginvoices_v2",
52
+ BillingAddons = "billingaddons",
53
+ Alerts = "alerts",
54
+ Payments = "payments",
55
+ BillingDiscounts = "billingdiscounts",
56
+ Sources = "sources",
57
+ Deals = "deals",
58
+ Blocks = "blocks",
59
+ Threats = "threats",
60
+ Feedbacks = "feedbacks",
61
+ ShInstallations = "sh_installations",
62
+ Attributes = "attributes",
63
+ Indexes = "indexes",
64
+ Functions = "functions",
65
+ Sites = "sites",
66
+ Deployments = "deployments",
67
+ Executions = "executions",
68
+ Variables = "variables",
69
+ Migrations = "migrations",
70
+ ResourceTokens = "resourcetokens",
71
+ Transactions = "transactions",
72
+ TransactionLogs = "transactionlogs",
73
+ Stats = "stats"
74
+ }
@@ -12,6 +12,8 @@ export declare enum Scopes {
12
12
  MocksWrite = "mocks.write",
13
13
  PoliciesRead = "policies.read",
14
14
  PoliciesWrite = "policies.write",
15
+ ProjectPoliciesRead = "project.policies.read",
16
+ ProjectPoliciesWrite = "project.policies.write",
15
17
  TemplatesRead = "templates.read",
16
18
  TemplatesWrite = "templates.write",
17
19
  Oauth2Read = "oauth2.read",
@@ -76,6 +78,8 @@ export declare enum Scopes {
76
78
  VcsWrite = "vcs.write",
77
79
  RulesRead = "rules.read",
78
80
  RulesWrite = "rules.write",
81
+ BackupsPoliciesRead = "backups.policies.read",
82
+ BackupsPoliciesWrite = "backups.policies.write",
79
83
  ArchivesRead = "archives.read",
80
84
  ArchivesWrite = "archives.write",
81
85
  RestorationsRead = "restorations.read",
package/types/index.d.ts CHANGED
@@ -58,6 +58,7 @@ export { ImageFormat } from './enums/image-format';
58
58
  export { BackupServices } from './enums/backup-services';
59
59
  export { Platform } from './enums/platform';
60
60
  export { ConsoleResourceType } from './enums/console-resource-type';
61
+ export { QuerySuggestionResource } from './enums/query-suggestion-resource';
61
62
  export { UsageRange } from './enums/usage-range';
62
63
  export { RelationshipType } from './enums/relationship-type';
63
64
  export { RelationMutate } from './enums/relation-mutate';
@@ -2,6 +2,7 @@ import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
3
  import { Platform } from '../enums/platform';
4
4
  import { ConsoleResourceType } from '../enums/console-resource-type';
5
+ import { QuerySuggestionResource } from '../enums/query-suggestion-resource';
5
6
  export declare class Console {
6
7
  client: Client;
7
8
  constructor(client: Client);
@@ -252,6 +253,36 @@ export declare class Console {
252
253
  * @deprecated Use the object parameter style method for a better developer experience.
253
254
  */
254
255
  suggestIndexes(databaseId: string, tableId: string, min?: number, max?: number): Promise<Models.ColumnIndexList>;
256
+ /**
257
+ * Suggest valid Appwrite query JSON objects for a supported list resource from free-text user intent. The endpoint picks a validator based on `resource` — for system resources it uses the static validator and its allowed attributes, and for user-owned table rows it loads the table schema and validates against those attributes at request time. The returned queries are guaranteed to parse and pass the relevant queries validator.
258
+ *
259
+ *
260
+ * @param {QuerySuggestionResource} params.resource - Resource to generate queries for.
261
+ * @param {string} params.input - Natural language query intent used to generate filters/sorting/pagination.
262
+ * @param {string} params.databaseId - Database ID. Required when resource is `tables` or `rows`.
263
+ * @param {string} params.tableId - Table ID. Required when resource is `rows`.
264
+ * @throws {AppwriteException}
265
+ * @returns {Promise<{}>}
266
+ */
267
+ suggestQueries(params: {
268
+ resource: QuerySuggestionResource;
269
+ input: string;
270
+ databaseId?: string;
271
+ tableId?: string;
272
+ }): Promise<{}>;
273
+ /**
274
+ * Suggest valid Appwrite query JSON objects for a supported list resource from free-text user intent. The endpoint picks a validator based on `resource` — for system resources it uses the static validator and its allowed attributes, and for user-owned table rows it loads the table schema and validates against those attributes at request time. The returned queries are guaranteed to parse and pass the relevant queries validator.
275
+ *
276
+ *
277
+ * @param {QuerySuggestionResource} resource - Resource to generate queries for.
278
+ * @param {string} input - Natural language query intent used to generate filters/sorting/pagination.
279
+ * @param {string} databaseId - Database ID. Required when resource is `tables` or `rows`.
280
+ * @param {string} tableId - Table ID. Required when resource is `rows`.
281
+ * @throws {AppwriteException}
282
+ * @returns {Promise<{}>}
283
+ * @deprecated Use the object parameter style method for a better developer experience.
284
+ */
285
+ suggestQueries(resource: QuerySuggestionResource, input: string, databaseId?: string, tableId?: string): Promise<{}>;
255
286
  /**
256
287
  * Get all Environment Variables that are relevant for the console.
257
288
  *