Merge pull request #136 from appwrite/dev

abnegate · web-flow · commit 8a5d716e4a60 · 2025-09-08T23:11:11.000+12:00
Add time between queries
diff --git a/README.md b/README.md
@@ -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>
 ```
 
 
diff --git a/docs/examples/account/update-prefs.md b/docs/examples/account/update-prefs.md
@@ -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);
diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md
@@ -10,7 +10,13 @@ const result = await databases.createDocument({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
     documentId: '<DOCUMENT_ID>',
-    data: {},
+    data: {
+        "username": "walter.obrien",
+        "email": "walter.obrien@example.com",
+        "fullName": "Walter O'Brien",
+        "age": 30,
+        "isAdmin": false
+    },
     permissions: ["read("any")"] // optional
 });
 
diff --git a/docs/examples/tablesdb/create-row.md b/docs/examples/tablesdb/create-row.md
@@ -10,7 +10,13 @@ const result = await tablesDB.createRow({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
     rowId: '<ROW_ID>',
-    data: {},
+    data: {
+        "username": "walter.obrien",
+        "email": "walter.obrien@example.com",
+        "fullName": "Walter O'Brien",
+        "age": 30,
+        "isAdmin": false
+    },
     permissions: ["read("any")"] // optional
 });
 
diff --git a/package.json b/package.json
@@ -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": {
diff --git a/src/client.ts b/src/client.ts
@@ -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',
     };
 
diff --git a/src/enums/credit-card.ts b/src/enums/credit-card.ts
@@ -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',
diff --git a/src/enums/execution-method.ts b/src/enums/execution-method.ts
@@ -5,4 +5,5 @@ export enum ExecutionMethod {
     PATCH = 'PATCH',
     DELETE = 'DELETE',
     OPTIONS = 'OPTIONS',
+    HEAD = 'HEAD',
 }
diff --git a/src/query.ts b/src/query.ts
@@ -1,5 +1,5 @@
 type QueryTypesSingle = string | number | boolean;
-export type QueryTypesList = string[] | number[] | boolean[] | Query[];
+export type QueryTypesList = string[] | number[] | boolean[] | Query[] | any[];
 export type QueryTypes = QueryTypesSingle | QueryTypesList;
 type AttributesTypes = string | string[];
 
@@ -52,20 +52,20 @@ export class Query {
    * Filter resources where attribute is equal to value.
    *
    * @param {string} attribute
-   * @param {QueryTypes} value
+   * @param {QueryTypes | any[]} value
    * @returns {string}
    */
-  static equal = (attribute: string, value: QueryTypes): string =>
+  static equal = (attribute: string, value: QueryTypes | any[]): string =>
     new Query("equal", attribute, value).toString();
 
   /**
    * Filter resources where attribute is not equal to value.
    *
    * @param {string} attribute
-   * @param {QueryTypes} value
+   * @param {QueryTypes | any[]} value
    * @returns {string}
    */
-  static notEqual = (attribute: string, value: QueryTypes): string =>
+  static notEqual = (attribute: string, value: QueryTypes | any[]): string =>
     new Query("notEqual", attribute, value).toString();
 
   /**
@@ -238,17 +238,17 @@ export class Query {
    * @param {string | string[]} value
    * @returns {string}
    */
-  static contains = (attribute: string, value: string | string[]): string =>
+  static contains = (attribute: string, value: string | any[]): string =>
     new Query("contains", attribute, value).toString();
 
   /**
    * Filter resources where attribute does not contain the specified value.
    *
    * @param {string} attribute
-   * @param {string | string[]} value
+   * @param {string | any[]} value
    * @returns {string}
    */
-  static notContains = (attribute: string, value: string | string[]): string =>
+  static notContains = (attribute: string, value: string | any[]): string =>
     new Query("notContains", attribute, value).toString();
 
   /**
@@ -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.
    *
@@ -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.
    *
@@ -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();
 }
diff --git a/src/services/account.ts b/src/services/account.ts
@@ -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>;
     /**
@@ -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>;
     /**
diff --git a/src/services/avatars.ts b/src/services/avatars.ts
@@ -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.
@@ -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.
diff --git a/src/services/databases.ts b/src/services/databases.ts
@@ -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 = {};
@@ -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 = {};
@@ -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 = {};
diff --git a/src/services/functions.ts b/src/services/functions.ts
@@ -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}
@@ -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}

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,5 @@ export enum ExecutionMethod {`
`5`	`5`	`PATCH = 'PATCH',`
`6`	`6`	`DELETE = 'DELETE',`
`7`	`7`	`OPTIONS = 'OPTIONS',`
	`8`	`+ HEAD = 'HEAD',`
`8`	`9`	`}`