Merge pull request #184 from appwrite/dev

chore: regenerate

Author: loks0n

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 8.3.0
+
+* **Feat:** Add support for `appwrite.config.json` file
+  * All new projects will be initialized with this configuration file
+  * Resolves bundler conflicts (e.g., Vite) that incorrectly interpret `.json` files as library imports
+* Add `incrementDocumentAttribute` and `decrementDocumentAttribute` support to `Databases` service
+* Type generation fixes:
+  * Fix relationships using the relatedCollection's id instead of name
+  * Update auto generated comment to show relative path instead of absolute path
+
+> **Note:** The existing `appwrite.json` file remains fully supported for backward compatibility
+
 ## 8.2.2
 
 * Fix object comparison logic when pushing settings

README.md

@@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using
 
 ```sh
 $ appwrite -v
-8.2.2
+8.3.0
 ```
 
 ### Install using prebuilt binaries
@@ -60,7 +60,7 @@ $ scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/sc
 Once the installation completes, you can verify your install using
 ```
 $ appwrite -v
-8.2.2
+8.3.0
 ```
 
 ## Getting Started 

docs/examples/databases/decrement-document-attribute.md

@@ -0,0 +1,7 @@
+appwrite databases decrementDocumentAttribute \
+        --databaseId <DATABASE_ID> \
+        --collectionId <COLLECTION_ID> \
+        --documentId <DOCUMENT_ID> \
+        --attribute '' \
+
+

docs/examples/databases/increment-document-attribute.md

@@ -0,0 +1,7 @@
+appwrite databases incrementDocumentAttribute \
+        --databaseId <DATABASE_ID> \
+        --collectionId <COLLECTION_ID> \
+        --documentId <DOCUMENT_ID> \
+        --attribute '' \
+
+

install.ps1

@@ -13,8 +13,8 @@
 # You can use "View source" of this page to see the full script.
 
 # REPO
-$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/8.2.2/appwrite-cli-win-x64.exe"
-$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/8.2.2/appwrite-cli-win-arm64.exe"
+$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/8.3.0/appwrite-cli-win-x64.exe"
+$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/8.3.0/appwrite-cli-win-arm64.exe"
 
 $APPWRITE_BINARY_NAME = "appwrite.exe"
 

install.sh

@@ -97,7 +97,7 @@ printSuccess() {
 downloadBinary() {
     echo "[2/4] Downloading executable for $OS ($ARCH) ..."
 
-    GITHUB_LATEST_VERSION="8.2.2"
+    GITHUB_LATEST_VERSION="8.3.0"
     GITHUB_FILE="appwrite-cli-${OS}-${ARCH}"
     GITHUB_URL="https://github.com/$GITHUB_REPOSITORY_NAME/releases/download/$GITHUB_LATEST_VERSION/$GITHUB_FILE"
 

lib/client.js

@@ -16,8 +16,8 @@ class Client {
       'x-sdk-name': 'Command Line',
       'x-sdk-platform': 'console',
       'x-sdk-language': 'cli',
-      'x-sdk-version': '8.2.2',
-      'user-agent' : `AppwriteCLI/8.2.2 (${os.type()} ${os.version()}; ${os.arch()})`,
+      'x-sdk-version': '8.3.0',
+      'user-agent' : `AppwriteCLI/8.3.0 (${os.type()} ${os.version()}; ${os.arch()})`,
       'X-Appwrite-Response-Format' : '1.7.0',
     };
   }

lib/commands/databases.js

@@ -1990,6 +1990,90 @@ const databasesListDocumentLogs = async ({databaseId,collectionId,documentId,que
 
 }
 
+/**
+ * @typedef {Object} DatabasesDecrementDocumentAttributeRequestParams
+ * @property {string} databaseId Database ID.
+ * @property {string} collectionId Collection ID.
+ * @property {string} documentId Document ID.
+ * @property {string} attribute Attribute key.
+ * @property {number} value Value to decrement the attribute by. The value must be a number.
+ * @property {number} min Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.
+ * @property {boolean} overrideForCli
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {DatabasesDecrementDocumentAttributeRequestParams} params
+ */
+const databasesDecrementDocumentAttribute = async ({databaseId,collectionId,documentId,attribute,value,min,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId).replace('{attribute}', attribute);
+    let payload = {};
+    if (typeof value !== 'undefined') {
+        payload['value'] = value;
+    }
+    if (typeof min !== 'undefined') {
+        payload['min'] = min;
+    }
+
+    let response = undefined;
+
+    response = await client.call('patch', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    if (parseOutput) {
+        parse(response)
+    }
+
+    return response;
+
+}
+
+/**
+ * @typedef {Object} DatabasesIncrementDocumentAttributeRequestParams
+ * @property {string} databaseId Database ID.
+ * @property {string} collectionId Collection ID.
+ * @property {string} documentId Document ID.
+ * @property {string} attribute Attribute key.
+ * @property {number} value Value to increment the attribute by. The value must be a number.
+ * @property {number} max Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.
+ * @property {boolean} overrideForCli
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {DatabasesIncrementDocumentAttributeRequestParams} params
+ */
+const databasesIncrementDocumentAttribute = async ({databaseId,collectionId,documentId,attribute,value,max,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId).replace('{attribute}', attribute);
+    let payload = {};
+    if (typeof value !== 'undefined') {
+        payload['value'] = value;
+    }
+    if (typeof max !== 'undefined') {
+        payload['max'] = max;
+    }
+
+    let response = undefined;
+
+    response = await client.call('patch', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    if (parseOutput) {
+        parse(response)
+    }
+
+    return response;
+
+}
+
 /**
  * @typedef {Object} DatabasesListIndexesRequestParams
  * @property {string} databaseId Database ID.
@@ -2668,7 +2752,7 @@ databases
 
 databases
     .command(`upsert-documents`)
-    .description(`**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.  Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.`)
+    .description(`**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.  Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console. `)
     .requiredOption(`--database-id <database-id>`, `Database ID.`)
     .requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
     .requiredOption(`--documents [documents...]`, `Array of document data as JSON objects. May contain partial documents.`)
@@ -2738,6 +2822,28 @@ databases
     .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset`)
     .action(actionRunner(databasesListDocumentLogs))
 
+databases
+    .command(`decrement-document-attribute`)
+    .description(`Decrement a specific attribute of a document by a given value.`)
+    .requiredOption(`--database-id <database-id>`, `Database ID.`)
+    .requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
+    .requiredOption(`--document-id <document-id>`, `Document ID.`)
+    .requiredOption(`--attribute <attribute>`, `Attribute key.`)
+    .option(`--value <value>`, `Value to decrement the attribute by. The value must be a number.`, parseInteger)
+    .option(`--min <min>`, `Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.`, parseInteger)
+    .action(actionRunner(databasesDecrementDocumentAttribute))
+
+databases
+    .command(`increment-document-attribute`)
+    .description(`Increment a specific attribute of a document by a given value.`)
+    .requiredOption(`--database-id <database-id>`, `Database ID.`)
+    .requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
+    .requiredOption(`--document-id <document-id>`, `Document ID.`)
+    .requiredOption(`--attribute <attribute>`, `Attribute key.`)
+    .option(`--value <value>`, `Value to increment the attribute by. The value must be a number.`, parseInteger)
+    .option(`--max <max>`, `Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.`, parseInteger)
+    .action(actionRunner(databasesIncrementDocumentAttribute))
+
 databases
     .command(`list-indexes`)
     .description(`List indexes in the collection.`)
@@ -2853,6 +2959,8 @@ module.exports = {
     databasesUpdateDocument,
     databasesDeleteDocument,
     databasesListDocumentLogs,
+    databasesDecrementDocumentAttribute,
+    databasesIncrementDocumentAttribute,
     databasesListIndexes,
     databasesCreateIndex,
     databasesGetIndex,

lib/commands/types.js

@@ -4,7 +4,7 @@ const path = require("path");
 const { LanguageMeta, detectLanguage } = require("../type-generation/languages/language");
 const { Command, Option, Argument } = require("commander");
 const { localConfig } = require("../config");
-const { success, log, actionRunner } = require("../parser");
+const { success, log, warn, actionRunner } = require("../parser");
 const { PHP } = require("../type-generation/languages/php");
 const { TypeScript } = require("../type-generation/languages/typescript");
 const { Kotlin } = require("../type-generation/languages/kotlin");
@@ -71,7 +71,7 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
   }
 
   if (strict) {
-    log(`Strict mode enabled: Field names will be converted to follow ${language} conventions`);
+    warn(`Strict mode enabled: Field names will be converted to follow ${language} conventions`);
   }
 
   const meta = createLanguageMeta(language);
@@ -97,13 +97,10 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
     fs.mkdirSync(outputDirectory, { recursive: true });
   }
 
-  if (!fs.existsSync("appwrite.json")) {
-    throw new Error("appwrite.json not found in current directory");
-  }
-
   const collections = localConfig.getCollections();
   if (collections.length === 0) {
-    throw new Error("No collections found in appwrite.json");
+    const configFileName = path.basename(localConfig.path);
+    throw new Error(`No collections found in configuration. Make sure ${configFileName} exists and contains collections.`);
   }
 
   log(`Found ${collections.length} collections: ${collections.map(c => c.name).join(", ")}`);
@@ -118,7 +115,7 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
       collections,
       strict,
       ...templateHelpers,
-      getType: meta.getType
+      getType: meta.getType,
     });
 
     const destination = singleFileDestination || path.join(outputDirectory, meta.getFileName());
@@ -128,10 +125,11 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
   } else {
     for (const collection of collections) {
       const content = templater({
+        collections,
         collection,
         strict,
         ...templateHelpers,
-        getType: meta.getType
+        getType: meta.getType,
       });
 
       const destination = path.join(outputDirectory, meta.getFileName(collection));

lib/commands/users.js

@@ -1361,7 +1361,7 @@ const usersUpdateStatus = async ({userId,status,parseOutput = true, overrideForC
 /**
  * @typedef {Object} UsersListTargetsRequestParams
  * @property {string} userId User ID.
- * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
+ * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
@@ -1927,7 +1927,7 @@ users
     .command(`list-targets`)
     .description(`List the messaging targets that are associated with a user.`)
     .requiredOption(`--user-id <user-id>`, `User ID.`)
-    .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels`)
+    .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType`)
     .action(actionRunner(usersListTargets))
 
 users