Merge branch 'master' into patch-1

Author: ThexXTURBOXx

CONTRIBUTING.md

@@ -115,7 +115,7 @@ sdk-generator/blob/master/example.php:
 Run the following command (make sure you have an updated docker version on your machine):
 
 ```bash
-docker run --rm -v $(pwd):/app -w /app php:7.4-cli php example.php
+docker run --rm -v $(pwd):/app -w /app php:8.1-cli php example.php
 ```
 
 >Note: You can just add the new language next to the other languages in the `example.php` file. You don't need to rewrite the file completely.
@@ -252,7 +252,7 @@ Also in `.travis.yml` add new env `SDK=[Language]` so that travis will run a tes
 
 Finally, you can run tests using:
 ```sh
-docker run --rm -v $(pwd):$(pwd):rw -w $(pwd) -v /var/run/docker.sock:/var/run/docker.sock  php:7.4-cli-alpine sh -c "apk add docker-cli && vendor/bin/phpunit"
+docker run --rm -v $(pwd):$(pwd):rw -w $(pwd) -v /var/run/docker.sock:/var/run/docker.sock  php:8.1-cli-alpine sh -c "apk add docker-cli && vendor/bin/phpunit"
 ```
 
 ## SDK Generator Interface

src/SDK/Language/Flutter.php

@@ -205,6 +205,26 @@ public function getFiles(): array
                 'destination'   => '/lib/src/interceptor.dart',
                 'template'      => 'flutter/lib/src/interceptor.dart.twig',
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => '/lib/src/offline_db_io.dart',
+                'template'      => 'flutter/lib/src/offline_db_io.dart.twig',
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => '/lib/src/offline_db_stub.dart',
+                'template'      => 'flutter/lib/src/offline_db_stub.dart.twig',
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => '/lib/src/offline_db_web.dart',
+                'template'      => 'flutter/lib/src/offline_db_web.dart.twig',
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => '/lib/src/client_offline_mixin.dart',
+                'template'      => 'flutter/lib/src/client_offline_mixin.dart.twig',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => '/lib/{{ language.params.packageName }}.dart',

src/Spec/Swagger2.php

@@ -184,6 +184,11 @@ public function getMethods($service)
                             'query' => [],
                             'body' => [],
                         ],
+                        'offline' => [
+                            'model' => $method['x-appwrite']['offline-model'] ?? '',
+                            'key' => $method['x-appwrite']['offline-key'] ?? '',
+                            'response-key' => $method['x-appwrite']['offline-response-key'] ?? '$id',
+                        ],
                         'emptyResponse' => $emptyResponse,
                         'responseModel' => $responseModel,
                     ];

templates/cli/lib/commands/command.js.twig

@@ -81,6 +81,10 @@ const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({ {
     }
 
 {% else %}
+{% if parameter.type == 'array' %}
+    {{ parameter.name | caseCamel | escapeKeyword}} = {{ parameter.name | caseCamel | escapeKeyword}} === true ? [] : {{ parameter.name | caseCamel | escapeKeyword}};
+{% endif %}
+
     if (typeof {{ parameter.name | caseCamel | escapeKeyword }} !== 'undefined') {
         payload['{{ parameter.name }}'] = {{ parameter.name | caseCamel | escapeKeyword}}{% if method.consumes[0] == "multipart/form-data" and ( parameter.type != "string" and parameter.type != "array" ) %}.toString(){% endif %};
     }
@@ -224,7 +228,7 @@ const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({ {
 {% autoescape false %}
     .description(`{{ method.description | replace({'`':'\''}) | replace({'\n':' '}) | replace({'\n \n':' '}) }}`)
 {% for parameter in method.parameters.all %}
-    .{% if parameter.required %}requiredOption{% else %}option{% endif %}(`--{{ parameter.name | escapeKeyword }} <{{ parameter.name | escapeKeyword }}{% if parameter.array.type|length > 0 %}...{% endif %}>`, `{{ parameter.description | replace({'`':'\''}) | replace({'\n':' '}) | replace({'\n \n':' '}) }}`{% if parameter | typeName == 'boolean' %}, parseBool{% elseif parameter | typeName == 'number' %}, parseInteger{% endif %})
+    .{% if parameter.required %}requiredOption{% else %}option{% endif %}(`--{{ parameter.name | escapeKeyword }} {% if parameter.array.type|length > 0 %}[{% else %}<{% endif %}{{ parameter.name | escapeKeyword }}{% if parameter.array.type|length > 0 %}...{% endif %}{% if parameter.array.type|length > 0 %}]{% else %}>{% endif %}`, `{{ parameter.description | replace({'`':'\''}) | replace({'\n':' '}) | replace({'\n \n':' '}) }}`{% if parameter | typeName == 'boolean' %}, parseBool{% elseif parameter | typeName == 'number' %}, parseInteger{% endif %})
 {% endfor %}
 {% if method.type == 'location' %}
     .requiredOption(`--destination <path>`, `output file path.`)

templates/cli/lib/commands/deploy.js.twig

@@ -2,7 +2,7 @@ const inquirer = require("inquirer");
 const JSONbig = require("json-bigint")({ storeAsString: false });
 const { Command } = require("commander");
 const { localConfig } = require("../config");
-const { questionsDeployTeams, questionsDeployFunctions, questionsGetEntrypoint, questionsDeployCollections, questionsConfirmDeployCollections } = require("../questions");
+const { questionsDeployBuckets, questionsDeployTeams, questionsDeployFunctions, questionsGetEntrypoint, questionsDeployCollections, questionsConfirmDeployCollections } = require("../questions");
 const { actionRunner, success, log, error, commandDescriptions } = require("../parser");
 const { functionsGet, functionsCreate, functionsUpdate, functionsCreateDeployment, functionsUpdateDeployment, functionsListVariables, functionsDeleteVariable, functionsCreateVariable } = require('./functions');
 const {
@@ -23,8 +23,12 @@ const {
     databasesDeleteAttribute,
     databasesListAttributes,
     databasesListIndexes,
-    databasesDeleteIndex
+    databasesDeleteIndex,
+    databasesUpdateCollection
 } = require("./databases");
+const {
+    storageGetBucket, storageUpdateBucket, storageCreateBucket
+} = require("./storage");
 const {
     teamsGet,
     teamsUpdate,
@@ -437,17 +441,27 @@ const deployCollection = async ({ all, yes } = {}) => {
 
         let databaseId;
 
+        const localDatabase = localConfig.getDatabase(collection.databaseId);
+
         try {
             const database = await databasesGet({
                 databaseId: collection.databaseId,
                 parseOutput: false,
             });
             databaseId = database.$id;
+
+            await databasesUpdate({
+                databaseId: collection.databaseId,
+                name: localDatabase.name ?? collection.databaseId,
+                parseOutput: false
+            })
+
+            success(`Updated ${localDatabase.name} ( ${collection.databaseId} )`);
         } catch(err) {
             log(`Database ${collection.databaseId} not found. Creating it now...`);
             const database = await databasesCreate({
                 databaseId: collection.databaseId,
-                name: collection.databaseId,
+                name: localDatabase.name ?? collection.databaseId,
                 parseOutput: false,
             });
             databaseId = database.$id;
@@ -547,6 +561,18 @@ const deployCollection = async ({ all, yes } = {}) => {
             }
 
             success(`Created ${collection.indexes.length} indexes`);
+
+            await databasesUpdateCollection({
+                databaseId,
+                collectionId: collection['$id'],
+                name: collection.name,
+                documentSecurity: collection.documentSecurity,
+                permissions: collection['$permissions'],
+                enabled: collection.enabled,
+                parseOutput: false
+            })
+
+            success(`Deployed ${collection.name} ( ${collection['$id']} )`);
         } catch (e) {
             if (e.code == 404) {
                 log(`Collection ${collection.name} does not exist in the project. Creating ... `);
@@ -601,6 +627,93 @@ const deployCollection = async ({ all, yes } = {}) => {
     }
 }
 
+const deployBucket = async ({ all, yes } = {}) => {
+    let response = {};
+
+    let bucketIds = [];
+    const configBuckets = localConfig.getBuckets();
+
+    if(all) {
+        if (configBuckets.length === 0) {
+            throw new Error("No buckets found in the current directory. Run `appwrite init bucket` to fetch all your buckets.");
+        }
+        bucketIds.push(...configBuckets.map((b) => b.$id));
+    }
+
+    if(bucketIds.length === 0) {
+        let answers = await inquirer.prompt(questionsDeployBuckets[0])
+        bucketIds.push(...answers.buckets);
+    }
+
+    let buckets = [];
+
+    for(const bucketId of bucketIds) {
+        const idBuckets = configBuckets.filter((b) => b.$id === bucketId);
+        buckets.push(...idBuckets);
+    }
+
+    for (let bucket of buckets) {
+        log(`Deploying bucket ${bucket.name} ( ${bucket['$id']} )`)
+
+        try {
+            response = await storageGetBucket({
+                bucketId: bucket['$id'],
+                parseOutput: false,
+            })
+            log(`Bucket ${bucket.name} ( ${bucket['$id']} ) already exists.`);
+
+            if(!yes) {
+                answers = await inquirer.prompt(questionsDeployBuckets[1])
+                if (answers.override !== "YES") {
+                    log(`Received "${answers.override}". Skipping ${bucket.name} ( ${bucket['$id']} )`);
+                    continue;
+                }
+            }
+
+            log(`Updating bucket ...`)
+
+            await storageUpdateBucket({
+                bucketId: bucket['$id'],
+                name: bucket.name,
+                permissions: bucket['$permissions'],
+                fileSecurity: bucket.fileSecurity,
+                enabled: bucket.enabled,
+                maximumFileSize: bucket.maximumFileSize,
+                allowedFileExtensions: bucket.allowedFileExtensions,
+                compression: bucket.compression,
+                encryption: bucket.encryption,
+                antivirus: bucket.antivirus,
+                compression: bucket.compression,
+                parseOutput: false
+            });
+
+            success(`Deployed ${bucket.name} ( ${bucket['$id']} )`);
+        } catch (e) {
+            if (e.code == 404) {
+                log(`Bucket ${bucket.name} does not exist in the project. Creating ... `);
+
+                response = await storageCreateBucket({
+                    bucketId: bucket['$id'],
+                    name: bucket.name,
+                    permissions: bucket['$permissions'],
+                    fileSecurity: bucket.fileSecurity,
+                    enabled: bucket.enabled,
+                    maximumFileSize: bucket.maximumFileSize,
+                    allowedFileExtensions: bucket.allowedFileExtensions,
+                    compression: bucket.compression,
+                    encryption: bucket.encryption,
+                    antivirus: bucket.antivirus,
+                    parseOutput: false
+                })
+
+                success(`Deployed ${bucket.name} ( ${bucket['$id']} )`);
+            } else {
+                throw e;
+            }
+        }
+    }
+}
+
 const deployTeam = async ({ all, yes } = {}) => {
     let response = {};
 
@@ -686,6 +799,13 @@ deploy
     .option(`--yes`, `Flag to confirm all warnings`)
     .action(actionRunner(deployCollection));
 
+deploy
+    .command("bucket")
+    .description("Deploy buckets in the current project.")
+    .option(`--all`, `Flag to deploy all buckets`)
+    .option(`--yes`, `Flag to confirm all warnings`)
+    .action(actionRunner(deployBucket));
+
 deploy
     .command("team")
     .description("Deploy teams in the current project.")

templates/cli/lib/commands/init.js.twig

@@ -7,6 +7,7 @@ const { teamsCreate, teamsList } = require("./teams");
 const { projectsCreate } = require("./projects");
 const { functionsCreate } = require("./functions");
 const { databasesListCollections, databasesList } = require("./databases");
+const { storageListBuckets } = require("./storage");
 const { sdkForConsole } = require("../sdks");
 const { localConfig } = require("../config");
 const { questionsInitProject, questionsInitFunction, questionsInitCollection } = require("../questions");
@@ -170,6 +171,13 @@ const initCollection = async ({ all, databaseId } = {}) => {
   }
 
   for(const databaseId of databaseIds) {
+    const database = await databasesGet({
+      databaseId,
+      parseOutput: false
+    });
+
+    localConfig.addDatabase(database);
+
     // TODO: Pagination?
     let response = await databasesListCollections({
       databaseId,
@@ -193,6 +201,24 @@ const initCollection = async ({ all, databaseId } = {}) => {
   success();
 }
 
+const initBucket = async () => {
+  // TODO: Pagination?
+  let response = await storageListBuckets({
+    queries: [ 'limit(100)' ],
+    parseOutput: false
+  })
+
+  let buckets = response.buckets;
+  log(`Found ${buckets.length} buckets`);
+
+  buckets.forEach(async bucket => {
+    log(`Fetching ${bucket.name} ...`);
+    localConfig.addBucket(bucket);
+  });
+
+  success();
+}
+
 const initTeam = async () => {
   // TODO: Pagination?
   let response = await teamsList({
@@ -233,6 +259,11 @@ init
   .option(`--all`, `Flag to initialize all databases`)
   .action(actionRunner(initCollection))
 
+init
+  .command("bucket")
+  .description("Initialise your Appwrite buckets")
+  .action(actionRunner(initBucket))
+
 init
   .command("team")
   .description("Initialise your Appwrite teams")