Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import { Client, Account } from "appwrite";
To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:

```html
<script src="https://cdn.jsdelivr.net/npm/appwrite@19.0.0"></script>
<script src="https://cdn.jsdelivr.net/npm/appwrite@20.0.0"></script>
```


Expand Down
6 changes: 5 additions & 1 deletion docs/examples/account/update-prefs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ const client = new Client()
const account = new Account(client);

const result = await account.updatePrefs({
prefs: {}
prefs: {
"language": "en",
"timezone": "UTC",
"darkTheme": true
}
});

console.log(result);
8 changes: 7 additions & 1 deletion docs/examples/databases/create-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ const result = await databases.createDocument({
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
data: {},
data: {
"username": "walter.obrien",
"email": "[email protected]",
"fullName": "Walter O'Brien",
"age": 30,
"isAdmin": false
},
permissions: ["read("any")"] // optional
});

Expand Down
8 changes: 7 additions & 1 deletion docs/examples/tablesdb/create-row.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ const result = await tablesDB.createRow({
databaseId: '<DATABASE_ID>',
tableId: '<TABLE_ID>',
rowId: '<ROW_ID>',
data: {},
data: {
"username": "walter.obrien",
"email": "[email protected]",
"fullName": "Walter O'Brien",
"age": 30,
"isAdmin": false
},
permissions: ["read("any")"] // optional
});

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "appwrite",
"homepage": "https://appwrite.io/support",
"description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
"version": "19.0.0",
"version": "20.0.0",
"license": "BSD-3-Clause",
"main": "dist/cjs/sdk.js",
"exports": {
Expand Down
2 changes: 1 addition & 1 deletion src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ class Client {
'x-sdk-name': 'Web',
'x-sdk-platform': 'client',
'x-sdk-language': 'web',
'x-sdk-version': '19.0.0',
'x-sdk-version': '20.0.0',
'X-Appwrite-Response-Format': '1.8.0',
};

Expand Down
2 changes: 1 addition & 1 deletion src/enums/credit-card.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export enum CreditCard {
Mastercard = 'mastercard',
Naranja = 'naranja',
TarjetaShopping = 'targeta-shopping',
UnionChinaPay = 'union-china-pay',
UnionPay = 'unionpay',
Visa = 'visa',
MIR = 'mir',
Maestro = 'maestro',
Expand Down
1 change: 1 addition & 0 deletions src/enums/execution-method.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ export enum ExecutionMethod {
PATCH = 'PATCH',
DELETE = 'DELETE',
OPTIONS = 'OPTIONS',
HEAD = 'HEAD',
}
148 changes: 148 additions & 0 deletions src/query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,16 @@ export class Query {
static createdAfter = (value: string): string =>
new Query("createdAfter", undefined, value).toString();

/**
* Filter resources where document was created between dates.
*
* @param {string} start
* @param {string} end
* @returns {string}
*/
static createdBetween = (start: string, end: string): string =>
new Query("createdBetween", undefined, [start, end] as QueryTypesList).toString();

/**
* Filter resources where document was updated before date.
*
Expand All @@ -329,6 +339,16 @@ export class Query {
static updatedAfter = (value: string): string =>
new Query("updatedAfter", undefined, value).toString();

/**
* Filter resources where document was updated between dates.
*
* @param {string} start
* @param {string} end
* @returns {string}
*/
static updatedBetween = (start: string, end: string): string =>
new Query("updatedBetween", undefined, [start, end] as QueryTypesList).toString();

/**
* Combine multiple queries using logical OR operator.
*
Expand All @@ -346,4 +366,132 @@ export class Query {
*/
static and = (queries: string[]) =>
new Query("and", undefined, queries.map((query) => JSON.parse(query))).toString();

/**
* Filter resources where attribute is at a specific distance from the given coordinates.
*
* @param {string} attribute
* @param {any[]} values
* @param {number} distance
* @param {boolean} meters
* @returns {string}
*/
static distanceEqual = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
new Query("distanceEqual", attribute, [values, distance, meters] as QueryTypesList).toString();

/**
* Filter resources where attribute is not at a specific distance from the given coordinates.
*
* @param {string} attribute
* @param {any[]} values
* @param {number} distance
* @param {boolean} meters
* @returns {string}
*/
static distanceNotEqual = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
new Query("distanceNotEqual", attribute, [values, distance, meters] as QueryTypesList).toString();

/**
* Filter resources where attribute is at a distance greater than the specified value from the given coordinates.
*
* @param {string} attribute
* @param {any[]} values
* @param {number} distance
* @param {boolean} meters
* @returns {string}
*/
static distanceGreaterThan = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
new Query("distanceGreaterThan", attribute, [values, distance, meters] as QueryTypesList).toString();

/**
* Filter resources where attribute is at a distance less than the specified value from the given coordinates.
*
* @param {string} attribute
* @param {any[]} values
* @param {number} distance
* @param {boolean} meters
* @returns {string}
*/
static distanceLessThan = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
new Query("distanceLessThan", attribute, [values, distance, meters] as QueryTypesList).toString();

/**
* Filter resources where attribute intersects with the given geometry.
*
* @param {string} attribute
* @param {any[]} values
* @returns {string}
*/
static intersects = (attribute: string, values: any[]): string =>
new Query("intersects", attribute, values).toString();

/**
* Filter resources where attribute does not intersect with the given geometry.
*
* @param {string} attribute
* @param {any[]} values
* @returns {string}
*/
static notIntersects = (attribute: string, values: any[]): string =>
new Query("notIntersects", attribute, values).toString();

/**
* Filter resources where attribute crosses the given geometry.
*
* @param {string} attribute
* @param {any[]} values
* @returns {string}
*/
static crosses = (attribute: string, values: any[]): string =>
new Query("crosses", attribute, values).toString();

/**
* Filter resources where attribute does not cross the given geometry.
*
* @param {string} attribute
* @param {any[]} values
* @returns {string}
*/
static notCrosses = (attribute: string, values: any[]): string =>
new Query("notCrosses", attribute, values).toString();

/**
* Filter resources where attribute overlaps with the given geometry.
*
* @param {string} attribute
* @param {any[]} values
* @returns {string}
*/
static overlaps = (attribute: string, values: any[]): string =>
new Query("overlaps", attribute, values).toString();

/**
* Filter resources where attribute does not overlap with the given geometry.
*
* @param {string} attribute
* @param {any[]} values
* @returns {string}
*/
static notOverlaps = (attribute: string, values: any[]): string =>
new Query("notOverlaps", attribute, values).toString();

/**
* Filter resources where attribute touches the given geometry.
*
* @param {string} attribute
* @param {any[]} values
* @returns {string}
*/
static touches = (attribute: string, values: any[]): string =>
new Query("touches", attribute, values).toString();

/**
* Filter resources where attribute does not touch the given geometry.
*
* @param {string} attribute
* @param {any[]} values
* @returns {string}
*/
static notTouches = (attribute: string, values: any[]): string =>
new Query("notTouches", attribute, values).toString();
}
4 changes: 2 additions & 2 deletions src/services/account.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1751,7 +1751,7 @@ export class Account {
* @param {string} params.secret - Valid verification token.
* @throws {AppwriteException}
* @returns {Promise<Models.Session>}
* @deprecated This API has been deprecated.
* @deprecated This API has been deprecated since 1.6.0. Please use `Account.createSession` instead.
*/
updateMagicURLSession(params: { userId: string, secret: string }): Promise<Models.Session>;
/**
Expand Down Expand Up @@ -1907,7 +1907,7 @@ export class Account {
* @param {string} params.secret - Valid verification token.
* @throws {AppwriteException}
* @returns {Promise<Models.Session>}
* @deprecated This API has been deprecated.
* @deprecated This API has been deprecated since 1.6.0. Please use `Account.createSession` instead.
*/
updatePhoneSession(params: { userId: string, secret: string }): Promise<Models.Session>;
/**
Expand Down
4 changes: 2 additions & 2 deletions src/services/avatars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export class Avatars {
* When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
*
*
* @param {CreditCard} params.code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.
* @param {CreditCard} params.code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.
* @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
* @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
* @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
Expand All @@ -111,7 +111,7 @@ export class Avatars {
* When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
*
*
* @param {CreditCard} code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.
* @param {CreditCard} code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.
* @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
* @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
* @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
Expand Down
9 changes: 0 additions & 9 deletions src/services/databases.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,6 @@ export class Databases {
if (typeof data === 'undefined') {
throw new AppwriteException('Missing required parameter: "data"');
}
delete data?.$sequence;
delete data?.$collectionId;
delete data?.$databaseId;

const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId);
const payload: Payload = {};
Expand Down Expand Up @@ -304,9 +301,6 @@ export class Databases {
if (typeof data === 'undefined') {
throw new AppwriteException('Missing required parameter: "data"');
}
delete data?.$sequence;
delete data?.$collectionId;
delete data?.$databaseId;

const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
const payload: Payload = {};
Expand Down Expand Up @@ -389,9 +383,6 @@ export class Databases {
if (typeof documentId === 'undefined') {
throw new AppwriteException('Missing required parameter: "documentId"');
}
delete data?.$sequence;
delete data?.$collectionId;
delete data?.$databaseId;

const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
const payload: Payload = {};
Expand Down
4 changes: 2 additions & 2 deletions src/services/functions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ export class Functions {
* @param {string} params.body - HTTP body of execution. Default value is empty string.
* @param {boolean} params.async - Execute code in the background. Default value is false.
* @param {string} params.xpath - HTTP path of execution. Path can include query params. Default value is /
* @param {ExecutionMethod} params.method - HTTP method of execution. Default value is GET.
* @param {ExecutionMethod} params.method - HTTP method of execution. Default value is POST.
* @param {object} params.headers - HTTP headers of execution. Defaults to empty.
* @param {string} params.scheduledAt - Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
* @throws {AppwriteException}
Expand All @@ -91,7 +91,7 @@ export class Functions {
* @param {string} body - HTTP body of execution. Default value is empty string.
* @param {boolean} async - Execute code in the background. Default value is false.
* @param {string} xpath - HTTP path of execution. Path can include query params. Default value is /
* @param {ExecutionMethod} method - HTTP method of execution. Default value is GET.
* @param {ExecutionMethod} method - HTTP method of execution. Default value is POST.
* @param {object} headers - HTTP headers of execution. Defaults to empty.
* @param {string} scheduledAt - Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
* @throws {AppwriteException}
Expand Down