Merge branch 'refs/heads/feat-cli-sudo' into feat-non-destructive-db-actions

# Conflicts:
#	templates/cli/lib/commands/push.js.twig

Author: byawitz

src/SDK/Language.php

@@ -84,6 +84,15 @@ public function getFilters(): array
         return [];
     }
 
+    /**
+     * Language specific functions.
+     * @return array
+     */
+    public function getFunctions(): array
+    {
+        return [];
+    }
+
     protected function toPascalCase(string $value): string
     {
         return \ucfirst($this->toCamelCase($value));

src/SDK/Language/CLI.php

@@ -2,8 +2,66 @@
 
 namespace Appwrite\SDK\Language;
 
+use Twig\TwigFunction;
+
 class CLI extends Node
 {
+    /**
+     * List of functions to ignore for console preview.
+     * @var array
+     */
+    private $consoleIgnoreFunctions = [
+        'listidentities',
+        'listmfafactors',
+        'getprefs',
+        'getsession',
+        'getattribute',
+        'listdocumentlogs',
+        'getindex',
+        'listcollectionlogs',
+        'getcollectionusage',
+        'listlogs',
+        'listruntimes',
+        'getusage',
+        'getusage',
+        'listvariables',
+        'getvariable',
+        'listproviderlogs',
+        'listsubscriberlogs',
+        'getsubscriber',
+        'listtopiclogs',
+        'getemailtemplate',
+        'getsmstemplate',
+        'getfiledownload',
+        'getfilepreview',
+        'getfileview',
+        'getusage',
+        'listlogs',
+        'getprefs',
+        'getusage',
+        'listlogs',
+        'getmembership',
+        'listmemberships',
+        'listmfafactors',
+        'getmfarecoverycodes',
+        'getprefs',
+        'listtargets',
+        'gettarget',
+    ];
+
+    /**
+     * List of SDK services to ignore for console preview.
+     * @var array
+     */
+    private $consoleIgnoreServices = [
+        'health',
+        'migrations',
+        'locale',
+        'avatars',
+        'project',
+        'proxy',
+        'vcs'
+    ];
     /**
      * @var array
      */
@@ -172,6 +230,11 @@ public function getFiles(): array
                 'destination'   => 'lib/utils.js',
                 'template'      => 'cli/lib/utils.js.twig',
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/commands/init.js',
+                'template'      => 'cli/lib/commands/init.js.twig',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => 'lib/commands/pull.js',
@@ -285,4 +348,18 @@ public function getParamExample(array $param): string
 
         return $output;
     }
+
+    /**
+     * Language specific filters.
+     * @return array
+     */
+    public function getFunctions(): array
+    {
+        return [
+            /** Return true if the entered service->method is enabled for a console preview link */
+            new TwigFunction('methodHaveConsolePreview', fn($method, $service) => preg_match('/^([Gg]et|[Ll]ist)/', $method)
+                && !in_array(strtolower($method), $this->consoleIgnoreFunctions)
+                && !in_array($service, $this->consoleIgnoreServices)),
+        ];
+    }
 }

src/SDK/SDK.php

@@ -85,6 +85,13 @@ public function __construct(Language $language, Spec $spec)
             'debug' => true
         ]);
 
+        /**
+         * Add language-specific functions
+         */
+        foreach ($this->language->getFunctions() as $function) {
+            $this->twig->addFunction($function);
+        }
+
         /**
          * Add language specific filters
          */

templates/cli/base/params.twig

@@ -75,8 +75,10 @@
 {% endif %}
 {% endfor %}
 {% if method.type == 'location' %}
-    payload['project'] = localConfig.getProject().projectId
-    payload['key'] = globalConfig.getKey();
-    const queryParams = new URLSearchParams(payload);
-    apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    if (!overrideForCli) {
+        payload['project'] = localConfig.getProject().projectId
+        payload['key'] = globalConfig.getKey();
+        const queryParams = new URLSearchParams(payload);
+        apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    }
 {% endif %}

templates/cli/base/requests/api.twig

@@ -9,13 +9,27 @@
 {% endfor %}
     }, payload{% if method.type == 'location' %}, 'arraybuffer'{% endif %});
 
-{% if method.type == 'location' %}
-    fs.writeFileSync(destination, response);
+    {%~ if method.type == 'location' %}
+    if (overrideForCli) {
+        response = Buffer.from(response);
+    }
 
-{% endif %}
+    fs.writeFileSync(destination, response);
+    {%~ endif %}
     if (parseOutput) {
+    {%~ if methodHaveConsolePreview(method.name,service.name) %}
+        if(console) {
+            showConsoleLink('{{service.name}}', '{{ method.name }}',open
+        {%- for parameter in method.parameters.path -%}{%- set param = (parameter.name | caseCamel | escapeKeyword)  -%}{%- if param  ends with 'Id' -%}, {{ param }} {%- endif -%}{%- endfor -%}
+            );
+         } else {
+            parse(response)
+            success()
+        }
+    {%~ else %}
         parse(response)
         success()
+    {%~ endif %}
     }
-    
-    return response;
+
+    return response;

templates/cli/index.js.twig

@@ -12,6 +12,7 @@ const { commandDescriptions, cliConfig } = require("./lib/parser");
 const { client } = require("./lib/commands/generic");
 {% if sdk.test != "true" %}
 const { login, logout, whoami } = require("./lib/commands/generic");
+const { init } = require("./lib/commands/init");
 const { pull } = require("./lib/commands/pull");
 const { push } = require("./lib/commands/push");
 {% endif %}
@@ -28,16 +29,34 @@ program
   .version(version, "-v, --version")
   .option("--verbose", "Show complete error log")
   .option("--json", "Output in JSON format")
+  .option("-f,--force", "Flag to confirm all warnings")
+  .option("-a,--all", "Flag to push all resources")
+  .option("--id [id...]", "Flag to pass list of ids for a giving action")
+  .option("--report", "Enable reporting when cli is crashing")
   .on("option:json", () => {
     cliConfig.json = true;
   })
   .on("option:verbose", () => {
     cliConfig.verbose = true;
   })
+  .on("option:report", function() {
+    cliConfig.report = true;
+    cliConfig.reportData = { data: this };
+  })
+  .on("option:force", () => {
+    cliConfig.force = true;
+  })
+  .on("option:all", () => {
+    cliConfig.all = true;
+  })
+  .on("option:id", function() {
+    cliConfig.ids = this.opts().id;
+  })
   .showSuggestionAfterError()
 {% if sdk.test != "true" %}
   .addCommand(whoami)
   .addCommand(login)
+  .addCommand(init)
   .addCommand(pull)
   .addCommand(push)
   .addCommand(logout)

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

@@ -4,7 +4,7 @@ const tar = require("tar");
 const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const { getAllFiles } = require('../utils.js');
+const { getAllFiles, showConsoleLink } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -45,6 +45,7 @@ const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower
 {% for parameter in method.parameters.all %}
  * @property {{ "{" }}{{ parameter | typeName }}{{ "}" }} {{ parameter.name | caseCamel | escapeKeyword }} {{ parameter.description | replace({'`':'\''}) | replace({'\n':' '}) | replace({'\n \n':' '}) }}
 {% endfor %}
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
 {% if 'multipart/form-data' in method.consumes %}
@@ -58,8 +59,22 @@ const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower
 /**
  * @param {{ "{" }}{{ service.name | caseUcfirst }}{{ method.name | caseUcfirst }}RequestParams{{ "}" }} params
  */
-const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({ {% for parameter in method.parameters.all %}{{ parameter.name | caseCamel | escapeKeyword }}, {% endfor %}parseOutput = true, sdk = undefined{% if 'multipart/form-data' in method.consumes %}, onProgress = () => {}{% endif %}{% if method.type == 'location' %}, destination{% endif %}}) => {
-    let client = !sdk ? await {% if service.name == "projects" %}sdkForConsole(){% else %}sdkForProject(){% endif %} : sdk;
+{%~ block decleration -%}
+const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({
+        {%- for parameter in method.parameters.all -%}
+            {{ parameter.name | caseCamel | escapeKeyword }},
+        {%- endfor -%}
+
+        {%- block baseParams -%}parseOutput = true, overrideForCli = false, sdk = undefined {%- endblock -%}
+
+        {%- if 'multipart/form-data' in method.consumes -%},onProgress = () => {}{%- endif -%}
+
+        {%- if method.type == 'location' -%}, destination{%- endif -%}
+        {% if methodHaveConsolePreview(method.name,service.name) %}, console, open{%- endif -%}
+}) => {
+{%~ endblock %}
+    let client = !sdk ? await {% if service.name == "projects" %}sdkForConsole(){% else %}sdkForProject(){% endif %} :
+    sdk;
     let apiPath = '{{ method.path }}'{% for parameter in method.parameters.path %}.replace('{{ '{' }}{{ parameter.name | caseCamel }}{{ '}' }}', {{ parameter.name | caseCamel | escapeKeyword }}){% endfor %};
 {{ include ('cli/base/params.twig') }}
 {% if 'multipart/form-data' in method.consumes %}
@@ -80,6 +95,10 @@ const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({ {
 {% if method.type == 'location' %}
     .requiredOption(`--destination <path>`, `output file path.`)
 {% endif %}
+{% if methodHaveConsolePreview(method.name,service.name) %}
+    .option(`--console`, `Get the resource console url`)
+    .option(`--open`, `Use with '--console' to open the using default browser`)
+{% endif %}
 {% endautoescape %}
     .action(actionRunner({{ service.name | caseLower }}{{ method.name | caseUcfirst }}))
 
@@ -90,4 +109,4 @@ module.exports = {
     {{ service.name | caseLower }}{{ method.name | caseUcfirst }}{% if not loop.last %},{% endif %}
 
 {% endfor %}
-};
+};