@appwrite.io/console 0.1.0 → 0.2.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/.github/workflows/publish.yml +18 -0
- package/README.md +5 -5
- package/dist/cjs/sdk.js +155 -36
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +154 -37
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +155 -36
- package/docs/examples/account/create-with-invite-code.md +18 -0
- package/docs/examples/console/variables.md +18 -0
- package/docs/examples/health/get-pub-sub.md +18 -0
- package/docs/examples/health/get-queue.md +18 -0
- package/docs/examples/{projects → project}/get-usage.md +3 -3
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/index.ts +2 -0
- package/src/models.ts +117 -215
- package/src/query.ts +18 -0
- package/src/services/account.ts +60 -0
- package/src/services/console.ts +30 -0
- package/src/services/databases.ts +11 -11
- package/src/services/health.ts +39 -2
- package/src/services/project.ts +34 -0
- package/src/services/projects.ts +0 -27
- package/src/services/storage.ts +1 -1
- package/src/services/users.ts +1 -6
- package/types/index.d.ts +2 -0
- package/types/models.d.ts +117 -215
- package/types/query.d.ts +6 -0
- package/types/services/account.d.ts +19 -0
- package/types/services/console.d.ts +15 -0
- package/types/services/databases.d.ts +11 -11
- package/types/services/health.d.ts +21 -2
- package/types/services/project.d.ts +15 -0
- package/types/services/projects.d.ts +0 -10
- package/types/services/storage.d.ts +1 -1
- package/types/services/users.d.ts +1 -2
- package/.travis.yml +0 -32
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Service } from '../service';
|
|
2
|
+
import { Client } from '../client';
|
|
3
|
+
import type { Models } from '../models';
|
|
4
|
+
export declare class Console extends Service {
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* Get Variables
|
|
8
|
+
*
|
|
9
|
+
* Get all Environment Variables that are relevant for the console.
|
|
10
|
+
*
|
|
11
|
+
* @throws {AppwriteException}
|
|
12
|
+
* @returns {Promise}
|
|
13
|
+
*/
|
|
14
|
+
variables(): Promise<Models.ConsoleVariables>;
|
|
15
|
+
}
|
|
@@ -176,7 +176,7 @@ export declare class Databases extends Service {
|
|
|
176
176
|
* @throws {AppwriteException}
|
|
177
177
|
* @returns {Promise}
|
|
178
178
|
*/
|
|
179
|
-
updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault
|
|
179
|
+
updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise<Models.AttributeBoolean>;
|
|
180
180
|
/**
|
|
181
181
|
* Create DateTime Attribute
|
|
182
182
|
*
|
|
@@ -203,7 +203,7 @@ export declare class Databases extends Service {
|
|
|
203
203
|
* @throws {AppwriteException}
|
|
204
204
|
* @returns {Promise}
|
|
205
205
|
*/
|
|
206
|
-
updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault
|
|
206
|
+
updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeDatetime>;
|
|
207
207
|
/**
|
|
208
208
|
* Create Email Attribute
|
|
209
209
|
*
|
|
@@ -235,7 +235,7 @@ export declare class Databases extends Service {
|
|
|
235
235
|
* @throws {AppwriteException}
|
|
236
236
|
* @returns {Promise}
|
|
237
237
|
*/
|
|
238
|
-
updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault
|
|
238
|
+
updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeEmail>;
|
|
239
239
|
/**
|
|
240
240
|
* Create Enum Attribute
|
|
241
241
|
*
|
|
@@ -267,7 +267,7 @@ export declare class Databases extends Service {
|
|
|
267
267
|
* @throws {AppwriteException}
|
|
268
268
|
* @returns {Promise}
|
|
269
269
|
*/
|
|
270
|
-
updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault
|
|
270
|
+
updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise<Models.AttributeEnum>;
|
|
271
271
|
/**
|
|
272
272
|
* Create Float Attribute
|
|
273
273
|
*
|
|
@@ -304,7 +304,7 @@ export declare class Databases extends Service {
|
|
|
304
304
|
* @throws {AppwriteException}
|
|
305
305
|
* @returns {Promise}
|
|
306
306
|
*/
|
|
307
|
-
updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault
|
|
307
|
+
updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeFloat>;
|
|
308
308
|
/**
|
|
309
309
|
* Create Integer Attribute
|
|
310
310
|
*
|
|
@@ -341,7 +341,7 @@ export declare class Databases extends Service {
|
|
|
341
341
|
* @throws {AppwriteException}
|
|
342
342
|
* @returns {Promise}
|
|
343
343
|
*/
|
|
344
|
-
updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault
|
|
344
|
+
updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeInteger>;
|
|
345
345
|
/**
|
|
346
346
|
* Create IP Address Attribute
|
|
347
347
|
*
|
|
@@ -373,12 +373,12 @@ export declare class Databases extends Service {
|
|
|
373
373
|
* @throws {AppwriteException}
|
|
374
374
|
* @returns {Promise}
|
|
375
375
|
*/
|
|
376
|
-
updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault
|
|
376
|
+
updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeIp>;
|
|
377
377
|
/**
|
|
378
378
|
* Create Relationship Attribute
|
|
379
379
|
*
|
|
380
380
|
* Create relationship attribute. [Learn more about relationship
|
|
381
|
-
* attributes](docs/databases-relationships#relationship-attributes).
|
|
381
|
+
* attributes](/docs/databases-relationships#relationship-attributes).
|
|
382
382
|
*
|
|
383
383
|
*
|
|
384
384
|
* @param {string} databaseId
|
|
@@ -425,7 +425,7 @@ export declare class Databases extends Service {
|
|
|
425
425
|
* @throws {AppwriteException}
|
|
426
426
|
* @returns {Promise}
|
|
427
427
|
*/
|
|
428
|
-
updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault
|
|
428
|
+
updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeString>;
|
|
429
429
|
/**
|
|
430
430
|
* Create URL Attribute
|
|
431
431
|
*
|
|
@@ -457,7 +457,7 @@ export declare class Databases extends Service {
|
|
|
457
457
|
* @throws {AppwriteException}
|
|
458
458
|
* @returns {Promise}
|
|
459
459
|
*/
|
|
460
|
-
updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault
|
|
460
|
+
updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeUrl>;
|
|
461
461
|
/**
|
|
462
462
|
* Get Attribute
|
|
463
463
|
*
|
|
@@ -484,7 +484,7 @@ export declare class Databases extends Service {
|
|
|
484
484
|
* Update Relationship Attribute
|
|
485
485
|
*
|
|
486
486
|
* Update relationship attribute. [Learn more about relationship
|
|
487
|
-
* attributes](docs/databases-relationships#relationship-attributes).
|
|
487
|
+
* attributes](/docs/databases-relationships#relationship-attributes).
|
|
488
488
|
*
|
|
489
489
|
*
|
|
490
490
|
* @param {string} databaseId
|
|
@@ -24,7 +24,7 @@ export declare class Health extends Service {
|
|
|
24
24
|
/**
|
|
25
25
|
* Get Cache
|
|
26
26
|
*
|
|
27
|
-
* Check the Appwrite in-memory cache
|
|
27
|
+
* Check the Appwrite in-memory cache servers are up and connection is
|
|
28
28
|
* successful.
|
|
29
29
|
*
|
|
30
30
|
* @throws {AppwriteException}
|
|
@@ -34,12 +34,31 @@ export declare class Health extends Service {
|
|
|
34
34
|
/**
|
|
35
35
|
* Get DB
|
|
36
36
|
*
|
|
37
|
-
* Check the Appwrite database
|
|
37
|
+
* Check the Appwrite database servers are up and connection is successful.
|
|
38
38
|
*
|
|
39
39
|
* @throws {AppwriteException}
|
|
40
40
|
* @returns {Promise}
|
|
41
41
|
*/
|
|
42
42
|
getDB(): Promise<Models.HealthStatus>;
|
|
43
|
+
/**
|
|
44
|
+
* Get PubSub
|
|
45
|
+
*
|
|
46
|
+
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
47
|
+
*
|
|
48
|
+
* @throws {AppwriteException}
|
|
49
|
+
* @returns {Promise}
|
|
50
|
+
*/
|
|
51
|
+
getPubSub(): Promise<Models.HealthStatus>;
|
|
52
|
+
/**
|
|
53
|
+
* Get Queue
|
|
54
|
+
*
|
|
55
|
+
* Check the Appwrite queue messaging servers are up and connection is
|
|
56
|
+
* successful.
|
|
57
|
+
*
|
|
58
|
+
* @throws {AppwriteException}
|
|
59
|
+
* @returns {Promise}
|
|
60
|
+
*/
|
|
61
|
+
getQueue(): Promise<Models.HealthStatus>;
|
|
43
62
|
/**
|
|
44
63
|
* Get Certificates Queue
|
|
45
64
|
*
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Service } from '../service';
|
|
2
|
+
import { Client } from '../client';
|
|
3
|
+
import type { Models } from '../models';
|
|
4
|
+
export declare class Project extends Service {
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* Get usage stats for a project
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* @param {string} range
|
|
11
|
+
* @throws {AppwriteException}
|
|
12
|
+
* @returns {Promise}
|
|
13
|
+
*/
|
|
14
|
+
getUsage(range?: string): Promise<Models.UsageProject>;
|
|
15
|
+
}
|
|
@@ -317,16 +317,6 @@ export declare class Projects extends Service {
|
|
|
317
317
|
* @returns {Promise}
|
|
318
318
|
*/
|
|
319
319
|
updateServiceStatus(projectId: string, service: string, status: boolean): Promise<Models.Project>;
|
|
320
|
-
/**
|
|
321
|
-
* Get usage stats for a project
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
* @param {string} projectId
|
|
325
|
-
* @param {string} range
|
|
326
|
-
* @throws {AppwriteException}
|
|
327
|
-
* @returns {Promise}
|
|
328
|
-
*/
|
|
329
|
-
getUsage(projectId: string, range?: string): Promise<Models.UsageProject>;
|
|
330
320
|
/**
|
|
331
321
|
* List Webhooks
|
|
332
322
|
*
|
|
@@ -155,11 +155,10 @@ export declare class Users extends Service {
|
|
|
155
155
|
*
|
|
156
156
|
*
|
|
157
157
|
* @param {string} range
|
|
158
|
-
* @param {string} provider
|
|
159
158
|
* @throws {AppwriteException}
|
|
160
159
|
* @returns {Promise}
|
|
161
160
|
*/
|
|
162
|
-
getUsage(range?: string
|
|
161
|
+
getUsage(range?: string): Promise<Models.UsageUsers>;
|
|
163
162
|
/**
|
|
164
163
|
* Get User
|
|
165
164
|
*
|
package/.travis.yml
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
language: node_js
|
|
2
|
-
node_js:
|
|
3
|
-
- "14.16"
|
|
4
|
-
|
|
5
|
-
jobs:
|
|
6
|
-
include:
|
|
7
|
-
- stage: NPM RC Release
|
|
8
|
-
if: tag == *-RC*
|
|
9
|
-
node_js: "14.16"
|
|
10
|
-
script:
|
|
11
|
-
- npm install
|
|
12
|
-
- npm run build
|
|
13
|
-
- echo "Deploying RC to NPM..."
|
|
14
|
-
deploy:
|
|
15
|
-
provider: npm
|
|
16
|
-
email: $NPM_EMAIL
|
|
17
|
-
api_key: $NPM_API_KEY
|
|
18
|
-
tag: next
|
|
19
|
-
- stage: NPM Release
|
|
20
|
-
if: tag != *-RC*
|
|
21
|
-
node_js: "14.16"
|
|
22
|
-
script:
|
|
23
|
-
- npm install
|
|
24
|
-
- npm run build
|
|
25
|
-
- echo "Deploying to NPM..."
|
|
26
|
-
deploy:
|
|
27
|
-
provider: npm
|
|
28
|
-
email: $NPM_EMAIL
|
|
29
|
-
api_key: $NPM_API_KEY
|
|
30
|
-
skip_cleanup: true
|
|
31
|
-
on:
|
|
32
|
-
tags: true
|