appwrite-cli 12.0.1 → 13.0.0-rc.1

package/lib/commands/{proxy.js → proxy.ts}

@@ -1,31 +1,27 @@
-const fs = require('fs');
-const pathLib = require('path');
-const tar = require("tar");
-const ignore = require("ignore");
-const { promisify } = require('util');
-const libClient = require('../client.js');
-const { getAllFiles, showConsoleLink } = require('../utils.js');
-const { Command } = require('commander');
-const { sdkForProject, sdkForConsole } = require('../sdks')
-const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log, warn } = require('../parser')
-const { localConfig, globalConfig } = require("../config");
-const { File } = require('undici');
-const { ReadableStream } = require('stream/web');
-
-/**
- * @param {fs.ReadStream} readStream
- * @returns {ReadableStream}
- */
-function convertReadStreamToReadableStream(readStream) {
+import fs = require('fs');
+import pathLib = require('path');
+import tar = require('tar');
+import ignore = require('ignore');
+import { promisify } from 'util';
+import Client from '../client';
+import { getAllFiles, showConsoleLink } from '../utils';
+import { Command } from 'commander';
+import { sdkForProject, sdkForConsole } from '../sdks';
+import { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log, warn } from '../parser';
+import { localConfig, globalConfig } from '../config';
+import { File } from 'undici';
+import { ReadableStream } from 'stream/web';
+
+function convertReadStreamToReadableStream(readStream: fs.ReadStream): ReadableStream {
   return new ReadableStream({
     start(controller) {
-      readStream.on("data", (chunk) => {
+      readStream.on("data", (chunk: Buffer) => {
         controller.enqueue(chunk);
       });
       readStream.on("end", () => {
         controller.close();
       });
-      readStream.on("error", (err) => {
+      readStream.on("error", (err: Error) => {
         controller.error(err);
       });
     },
@@ -35,24 +31,20 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const proxy = new Command("proxy").description(commandDescriptions['proxy'] ?? '').configureHelp({
+export const proxy = new Command("proxy").description(commandDescriptions['proxy'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
-/**
- * @typedef {Object} ProxyListRulesRequestParams
- * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch
- * @property {string} search Search term to filter your list results. Max length: 256 chars.
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProxyListRulesRequestParams} params
- */
-const proxyListRules = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProxyListRulesRequestParams {
+    queries?: string[];
+    search?: string;
+    total?: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const proxyListRules = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined}: ProxyListRulesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/proxy/rules';
@@ -79,18 +71,14 @@ const proxyListRules = async ({queries,search,total,parseOutput = true, override
     return response;
 
 }
-/**
- * @typedef {Object} ProxyCreateAPIRuleRequestParams
- * @property {string} domain Domain name.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProxyCreateAPIRuleRequestParams} params
- */
-const proxyCreateAPIRule = async ({domain,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProxyCreateAPIRuleRequestParams {
+    domain: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const proxyCreateAPIRule = async ({domain,parseOutput = true, overrideForCli = false, sdk = undefined}: ProxyCreateAPIRuleRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/proxy/rules/api';
@@ -112,20 +100,16 @@ const proxyCreateAPIRule = async ({domain,parseOutput = true, overrideForCli = f
     return response;
 
 }
-/**
- * @typedef {Object} ProxyCreateFunctionRuleRequestParams
- * @property {string} domain Domain name.
- * @property {string} functionId ID of function to be executed.
- * @property {string} branch Name of VCS branch to deploy changes automatically
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProxyCreateFunctionRuleRequestParams} params
- */
-const proxyCreateFunctionRule = async ({domain,functionId,branch,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProxyCreateFunctionRuleRequestParams {
+    domain: string;
+    functionId: string;
+    branch?: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const proxyCreateFunctionRule = async ({domain,functionId,branch,parseOutput = true, overrideForCli = false, sdk = undefined}: ProxyCreateFunctionRuleRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/proxy/rules/function';
@@ -153,22 +137,18 @@ const proxyCreateFunctionRule = async ({domain,functionId,branch,parseOutput = t
     return response;
 
 }
-/**
- * @typedef {Object} ProxyCreateRedirectRuleRequestParams
- * @property {string} domain Domain name.
- * @property {string} url Target URL of redirection
- * @property {StatusCode} statusCode Status code of redirection
- * @property {string} resourceId ID of parent resource.
- * @property {ProxyResourceType} resourceType Type of parent resource.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProxyCreateRedirectRuleRequestParams} params
- */
-const proxyCreateRedirectRule = async ({domain,url,statusCode,resourceId,resourceType,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProxyCreateRedirectRuleRequestParams {
+    domain: string;
+    url: string;
+    statusCode: StatusCode;
+    resourceId: string;
+    resourceType: ProxyResourceType;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const proxyCreateRedirectRule = async ({domain,url,statusCode,resourceId,resourceType,parseOutput = true, overrideForCli = false, sdk = undefined}: ProxyCreateRedirectRuleRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/proxy/rules/redirect';
@@ -202,20 +182,16 @@ const proxyCreateRedirectRule = async ({domain,url,statusCode,resourceId,resourc
     return response;
 
 }
-/**
- * @typedef {Object} ProxyCreateSiteRuleRequestParams
- * @property {string} domain Domain name.
- * @property {string} siteId ID of site to be executed.
- * @property {string} branch Name of VCS branch to deploy changes automatically
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProxyCreateSiteRuleRequestParams} params
- */
-const proxyCreateSiteRule = async ({domain,siteId,branch,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProxyCreateSiteRuleRequestParams {
+    domain: string;
+    siteId: string;
+    branch?: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const proxyCreateSiteRule = async ({domain,siteId,branch,parseOutput = true, overrideForCli = false, sdk = undefined}: ProxyCreateSiteRuleRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/proxy/rules/site';
@@ -243,18 +219,14 @@ const proxyCreateSiteRule = async ({domain,siteId,branch,parseOutput = true, ove
     return response;
 
 }
-/**
- * @typedef {Object} ProxyGetRuleRequestParams
- * @property {string} ruleId Rule ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProxyGetRuleRequestParams} params
- */
-const proxyGetRule = async ({ruleId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProxyGetRuleRequestParams {
+    ruleId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const proxyGetRule = async ({ruleId,parseOutput = true, overrideForCli = false, sdk = undefined}: ProxyGetRuleRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/proxy/rules/{ruleId}'.replace('{ruleId}', ruleId);
@@ -272,18 +244,14 @@ const proxyGetRule = async ({ruleId,parseOutput = true, overrideForCli = false,
     return response;
 
 }
-/**
- * @typedef {Object} ProxyDeleteRuleRequestParams
- * @property {string} ruleId Rule ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProxyDeleteRuleRequestParams} params
- */
-const proxyDeleteRule = async ({ruleId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProxyDeleteRuleRequestParams {
+    ruleId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const proxyDeleteRule = async ({ruleId,parseOutput = true, overrideForCli = false, sdk = undefined}: ProxyDeleteRuleRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/proxy/rules/{ruleId}'.replace('{ruleId}', ruleId);
@@ -302,18 +270,14 @@ const proxyDeleteRule = async ({ruleId,parseOutput = true, overrideForCli = fals
     return response;
 
 }
-/**
- * @typedef {Object} ProxyUpdateRuleVerificationRequestParams
- * @property {string} ruleId Rule ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProxyUpdateRuleVerificationRequestParams} params
- */
-const proxyUpdateRuleVerification = async ({ruleId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProxyUpdateRuleVerificationRequestParams {
+    ruleId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const proxyUpdateRuleVerification = async ({ruleId,parseOutput = true, overrideForCli = false, sdk = undefined}: ProxyUpdateRuleVerificationRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/proxy/rules/{ruleId}/verification'.replace('{ruleId}', ruleId);
@@ -337,7 +301,7 @@ proxy
     .description(`Get a list of all the proxy rules. You can use the query params to filter your results.`)
     .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
-    .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
+    .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .action(actionRunner(proxyListRules))
 
 proxy
@@ -390,14 +354,4 @@ proxy
     .requiredOption(`--rule-id <rule-id>`, `Rule ID.`)
     .action(actionRunner(proxyUpdateRuleVerification))
 
-module.exports = {
-    proxy,
-    proxyListRules,
-    proxyCreateAPIRule,
-    proxyCreateFunctionRule,
-    proxyCreateRedirectRule,
-    proxyCreateSiteRule,
-    proxyGetRule,
-    proxyDeleteRule,
-    proxyUpdateRuleVerification
-};
+

package/lib/commands/{pull.js → pull.ts}

@@ -1,25 +1,39 @@
-const fs = require("fs");
-const chalk = require('chalk');
-const tar = require("tar");
-const { Command } = require("commander");
-const inquirer = require("inquirer");
-const { messagingListTopics } = require("./messaging");
-const { teamsList } = require("./teams");
-const { projectsGet } = require("./projects");
-const { functionsList, functionsGetDeploymentDownload, functionsListDeployments } = require("./functions");
-const { sitesList, sitesGetDeploymentDownload, sitesListDeployments } = require("./sites");
-const { databasesGet, databasesListCollections, databasesList } = require("./databases");
-const { tablesDBList, tablesDBGet, tablesDBListTables } = require("./tables-db");
-const { storageListBuckets } = require("./storage");
-const { localConfig } = require("../config");
-const { paginate } = require("../paginate");
-const { questionsPullCollection, questionsPullFunctions, questionsPullFunctionsCode, questionsPullSites, questionsPullSitesCode, questionsPullResources } = require("../questions");
-const { cliConfig, success, log, warn, actionRunner, commandDescriptions } = require("../parser");
-
-const pullResources = async ({
+import fs = require('fs');
+import chalk from 'chalk';
+import tar = require('tar');
+import { Command } from 'commander';
+import inquirer from 'inquirer';
+import { messagingListTopics } from './messaging';
+import { teamsList } from './teams';
+import { projectsGet } from './projects';
+import { functionsList, functionsGetDeploymentDownload, functionsListDeployments } from './functions';
+import { sitesList, sitesGetDeploymentDownload, sitesListDeployments } from './sites';
+import { databasesGet, databasesListCollections, databasesList } from './databases';
+import { tablesDBList, tablesDBGet, tablesDBListTables } from './tables-db';
+import { storageListBuckets } from './storage';
+import { localConfig } from '../config';
+import { paginate } from '../paginate';
+import { questionsPullCollection, questionsPullFunctions, questionsPullFunctionsCode, questionsPullSites, questionsPullSitesCode, questionsPullResources } from '../questions';
+import { cliConfig, success, log, warn, actionRunner, commandDescriptions } from '../parser';
+
+interface PullResourcesOptions {
+    skipDeprecated?: boolean;
+}
+
+interface PullFunctionsOptions {
+    code?: boolean;
+    withVariables?: boolean;
+}
+
+interface PullSitesOptions {
+    code?: boolean;
+    withVariables?: boolean;
+}
+
+export const pullResources = async ({
     skipDeprecated = false
-} = {}) => {
-    const actions = {
+}: PullResourcesOptions = {}): Promise<void> => {
+    const actions: Record<string, (options?: any) => Promise<void>> = {
         settings: pullSettings,
         functions: pullFunctions,
         sites: pullSites,
@@ -49,7 +63,7 @@ const pullResources = async ({
     }
 };
 
-const pullSettings = async () => {
+const pullSettings = async (): Promise<void> => {
     log("Pulling project settings ...");
 
     try {
@@ -66,7 +80,7 @@ const pullSettings = async () => {
     }
 }
 
-const pullFunctions = async ({ code, withVariables }) => {
+const pullFunctions = async ({ code, withVariables }: PullFunctionsOptions = {}): Promise<void> => {
     process.chdir(localConfig.configDirectoryPath)
 
     log("Fetching functions ...");
@@ -86,7 +100,7 @@ const pullFunctions = async ({ code, withVariables }) => {
         ? (await paginate(functionsList, { parseOutput: false }, 100, 'functions')).functions
         : (await inquirer.prompt(questionsPullFunctions)).functions;
 
-    let allowCodePull = cliConfig.force === true ? true : null;
+    let allowCodePull: boolean | null = cliConfig.force === true ? true : null;
 
     for (let func of functions) {
         total++;
@@ -121,7 +135,7 @@ const pullFunctions = async ({ code, withVariables }) => {
             continue;
         }
 
-        let deploymentId = null;
+        let deploymentId: string | null = null;
 
         try {
             const fetchResponse = await functionsListDeployments({
@@ -172,14 +186,14 @@ const pullFunctions = async ({ code, withVariables }) => {
             } catch {
             }
 
-            fs.writeFileSync(envFileLocation, holdingVars.map(r => `${r.key}=${r.value}\n`).join(''))
+            fs.writeFileSync(envFileLocation, holdingVars.map((r: any) => `${r.key}=${r.value}\n`).join(''))
         }
     }
 
     success(`Successfully pulled ${chalk.bold(total)} functions.`);
 }
 
-const pullSites = async ({ code, withVariables }) => {
+const pullSites = async ({ code, withVariables }: PullSitesOptions = {}): Promise<void> => {
     process.chdir(localConfig.configDirectoryPath)
 
     log("Fetching sites ...");
@@ -199,7 +213,7 @@ const pullSites = async ({ code, withVariables }) => {
         ? (await paginate(sitesList, { parseOutput: false }, 100, 'sites')).sites
         : (await inquirer.prompt(questionsPullSites)).sites;
 
-    let allowCodePull = cliConfig.force === true ? true : null;
+    let allowCodePull: boolean | null = cliConfig.force === true ? true : null;
 
     for (let site of sites) {
         total++;
@@ -234,7 +248,7 @@ const pullSites = async ({ code, withVariables }) => {
             continue;
         }
 
-        let deploymentId = null;
+        let deploymentId: string | null = null;
 
         try {
             const fetchResponse = await sitesListDeployments({
@@ -285,14 +299,14 @@ const pullSites = async ({ code, withVariables }) => {
             } catch {
             }
 
-            fs.writeFileSync(envFileLocation, holdingVars.map(r => `${r.key}=${r.value}\n`).join(''))
+            fs.writeFileSync(envFileLocation, holdingVars.map((r: any) => `${r.key}=${r.value}\n`).join(''))
         }
     }
 
     success(`Successfully pulled ${chalk.bold(total)} sites.`);
 }
 
-const pullCollection = async () => {
+const pullCollection = async (): Promise<void> => {
     warn("appwrite pull collection has been deprecated. Please consider using 'appwrite pull tables' instead");
     log("Fetching collections ...");
     let totalDatabases = 0;
@@ -308,11 +322,11 @@ const pullCollection = async () => {
         return;
     }
 
-    let databases = cliConfig.ids;
+    let databases: string[] = cliConfig.ids;
 
     if (databases.length === 0) {
         if (cliConfig.all) {
-            databases = (await paginate(databasesList, { parseOutput: false }, 100, 'databases')).databases.map(database => database.$id);
+            databases = (await paginate(databasesList, { parseOutput: false }, 100, 'databases')).databases.map((database: any) => database.$id);
         } else {
             databases = (await inquirer.prompt(questionsPullCollection)).databases;
         }
@@ -347,7 +361,7 @@ const pullCollection = async () => {
     success(`Successfully pulled ${chalk.bold(totalCollections)} collections from ${chalk.bold(totalDatabases)} databases.`);
 }
 
-const pullTable = async () => {
+const pullTable = async (): Promise<void> => {
     log("Fetching tables ...");
     let totalTablesDBs = 0;
     let totalTables = 0;
@@ -362,11 +376,11 @@ const pullTable = async () => {
         return;
     }
 
-    let databases = cliConfig.ids;
+    let databases: string[] = cliConfig.ids;
 
     if (databases.length === 0) {
         if (cliConfig.all) {
-            databases = (await paginate(tablesDBList, { parseOutput: false }, 100, 'databases')).databases.map(database => database.$id);
+            databases = (await paginate(tablesDBList, { parseOutput: false }, 100, 'databases')).databases.map((database: any) => database.$id);
         } else {
             databases = (await inquirer.prompt(questionsPullCollection)).databases;
         }
@@ -401,7 +415,7 @@ const pullTable = async () => {
     success(`Successfully pulled ${chalk.bold(totalTables)} tables from ${chalk.bold(totalTablesDBs)} tableDBs.`);
 }
 
-const pullBucket = async () => {
+const pullBucket = async (): Promise<void> => {
     log("Fetching buckets ...");
     let total = 0;
 
@@ -426,7 +440,7 @@ const pullBucket = async () => {
     success(`Successfully pulled ${chalk.bold(total)} buckets.`);
 }
 
-const pullTeam = async () => {
+const pullTeam = async (): Promise<void> => {
     log("Fetching teams ...");
     let total = 0;
 
@@ -451,7 +465,7 @@ const pullTeam = async () => {
     success(`Successfully pulled ${chalk.bold(total)} teams.`);
 }
 
-const pullMessagingTopic = async () => {
+const pullMessagingTopic = async (): Promise<void> => {
     log("Fetching topics ...");
     let total = 0;
 
@@ -476,7 +490,7 @@ const pullMessagingTopic = async () => {
     success(`Successfully pulled ${chalk.bold(total)} topics.`);
 }
 
-const pull = new Command("pull")
+export const pull = new Command("pull")
     .description(commandDescriptions['pull'])
     .action(actionRunner(() => pullResources({ skipDeprecated: true })));
 
@@ -541,7 +555,3 @@ pull
     .description("Pull your Appwrite messaging topics")
     .action(actionRunner(pullMessagingTopic))
 
-module.exports = {
-    pull,
-    pullResources
-};