appwrite-cli 12.0.0 → 13.0.0-rc.1

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

@@ -1,18 +1,17 @@
-const fs = require("fs");
-const path = require("path");
-const childProcess = require('child_process');
-const { Command } = require("commander");
-const inquirer = require("inquirer");
-const { fetch } = require("undici");
-const { projectsCreate, projectsGet } = require("./projects");
-const { storageCreateBucket } = require("./storage");
-const { messagingCreateTopic } = require("./messaging");
-const { functionsCreate } = require("./functions");
-const { databasesCreateCollection } = require("./databases");
-const { pullResources } = require("./pull");
-const ID = require("../id");
-const { localConfig, globalConfig } = require("../config");
-const {
+import fs = require('fs');
+import path = require('path');
+import childProcess = require('child_process');
+import { Command } from 'commander';
+import inquirer from 'inquirer';
+import { projectsCreate, projectsGet } from './projects';
+import { storageCreateBucket } from './storage';
+import { messagingCreateTopic } from './messaging';
+import { functionsCreate } from './functions';
+import { databasesCreateCollection } from './databases';
+import { pullResources } from './pull';
+import ID from '../id';
+import { localConfig, globalConfig } from '../config';
+import {
     questionsCreateFunction,
     questionsCreateFunctionSelectTemplate,
     questionsCreateSite,
@@ -24,15 +23,15 @@ const {
     questionsInitProjectAutopull,
     questionsInitResources,
     questionsCreateTeam
-} = require("../questions");
-const { cliConfig, success, log, hint, error, actionRunner, commandDescriptions } = require("../parser");
-const { accountGet } = require("./account");
-const { sitesListTemplates } = require("./sites");
-const { sdkForConsole } = require("../sdks");
-const { isCloud } = require('../utils');
-
-const initResources = async () => {
-    const actions = {
+} from '../questions';
+import { cliConfig, success, log, hint, error, actionRunner, commandDescriptions } from '../parser';
+import { accountGet } from './account';
+import { sitesListTemplates } from './sites';
+import { sdkForConsole } from '../sdks';
+import { isCloud } from '../utils';
+
+const initResources = async (): Promise<void> => {
+    const actions: Record<string, (options?: any) => Promise<void>> = {
         function: initFunction,
         site: initSite,
         table: initTable,
@@ -50,8 +49,14 @@ const initResources = async () => {
     }
 };
 
-const initProject = async ({ organizationId, projectId, projectName } = {}) => {
-    let response = {};
+interface InitProjectOptions {
+    organizationId?: string;
+    projectId?: string;
+    projectName?: string;
+}
+
+const initProject = async ({ organizationId, projectId, projectName }: InitProjectOptions = {}): Promise<void> => {
+    let response: any = {};
 
     try {
         if (globalConfig.getEndpoint() === '' || globalConfig.getCookie() === '') {
@@ -68,7 +73,7 @@ const initProject = async ({ organizationId, projectId, projectName } = {}) => {
         process.exit(1);
     }
 
-    let answers = {};
+    let answers: any = {};
 
     if (!organizationId && !projectId && !projectName) {
         answers = await inquirer.prompt(questionsInitProject)
@@ -86,7 +91,7 @@ const initProject = async ({ organizationId, projectId, projectName } = {}) => {
 
         try {
             await projectsGet({ projectId, parseOutput: false });
-        } catch (e) {
+        } catch (e: any) {
             if (e.code === 404) {
                 answers.start = 'new';
                 answers.id = answers.project;
@@ -137,7 +142,7 @@ const initProject = async ({ organizationId, projectId, projectName } = {}) => {
     hint("Next you can use 'appwrite init' to create resources in your project, or use 'appwrite pull' and 'appwrite push' to synchronize your project.")
 }
 
-const initBucket = async () => {
+const initBucket = async (): Promise<void> => {
     const answers = await inquirer.prompt(questionsCreateBucket)
 
     localConfig.addBucket({
@@ -150,7 +155,7 @@ const initBucket = async () => {
     log("Next you can use 'appwrite push bucket' to deploy the changes.");
 };
 
-const initTeam = async () => {
+const initTeam = async (): Promise<void> => {
     const answers = await inquirer.prompt(questionsCreateTeam)
 
     localConfig.addTeam({
@@ -162,7 +167,7 @@ const initTeam = async () => {
     log("Next you can use 'appwrite push team' to deploy the changes.");
 };
 
-const initTable = async () => {
+const initTable = async (): Promise<void> => {
     const answers = await inquirer.prompt(questionsCreateTable)
     const newDatabase = (answers.method ?? '').toLowerCase() !== 'existing';
 
@@ -196,7 +201,7 @@ const initTable = async () => {
     log("Next you can use 'appwrite push table' to deploy the changes.");
 };
 
-const initCollection = async () => {
+const initCollection = async (): Promise<void> => {
     const answers = await inquirer.prompt(questionsCreateCollection)
     const newDatabase = (answers.method ?? '').toLowerCase() !== 'existing';
 
@@ -229,7 +234,7 @@ const initCollection = async () => {
     log("Next you can use 'appwrite push collection' to deploy the changes.");
 };
 
-const initTopic = async () => {
+const initTopic = async (): Promise<void> => {
     const answers = await inquirer.prompt(questionsCreateMessagingTopic)
 
     localConfig.addMessagingTopic({
@@ -242,7 +247,7 @@ const initTopic = async () => {
     log("Next you can use 'appwrite push topic' to deploy the changes.");
 };
 
-const initFunction = async () => {
+const initFunction = async (): Promise<void> => {
     process.chdir(localConfig.configDirectoryPath)
 
     // TODO: Add CI/CD support (ID, name, runtime)
@@ -273,11 +278,11 @@ const initFunction = async () => {
         log(`Installation command for this runtime not found. You will be asked to configure the install command when you first push the function.`);
     }
 
-    fs.mkdirSync(functionDir, "777");
-    fs.mkdirSync(templatesDir, "777");
+    fs.mkdirSync(functionDir, { mode: 0o777 });
+    fs.mkdirSync(templatesDir, { mode: 0o777 });
     const repo = "https://github.com/appwrite/templates";
     const api = `https://api.github.com/repos/appwrite/templates/contents/${answers.runtime.name}`
-    let selected = { template: 'starter' };
+    let selected: { template: string } = { template: 'starter' };
 
     const sparse = (selected ? `${answers.runtime.name}/${selected.template}` : answers.runtime.name).toLowerCase();
 
@@ -295,20 +300,20 @@ const initFunction = async () => {
     try {
         childProcess.execSync(gitInitCommands, { stdio: 'pipe', cwd: templatesDir });
         childProcess.execSync(gitPullCommands, { stdio: 'pipe', cwd: templatesDir });
-    } catch (error) {
+    } catch (err: any) {
         /* Specialised errors with recommended actions to take */
-        if (error.message.includes('error: unknown option')) {
-            throw new Error(`${error.message} \n\nSuggestion: Try updating your git to the latest version, then trying to run this command again.`)
-        } else if (error.message.includes('is not recognized as an internal or external command,') || error.message.includes('command not found')) {
-            throw new Error(`${error.message} \n\nSuggestion: It appears that git is not installed, try installing git then trying to run this command again.`)
+        if (err.message.includes('error: unknown option')) {
+            throw new Error(`${err.message} \n\nSuggestion: Try updating your git to the latest version, then trying to run this command again.`)
+        } else if (err.message.includes('is not recognized as an internal or external command,') || err.message.includes('command not found')) {
+            throw new Error(`${err.message} \n\nSuggestion: It appears that git is not installed, try installing git then trying to run this command again.`)
         } else {
-            throw error;
+            throw err;
         }
     }
 
     fs.rmSync(path.join(templatesDir, ".git"), { recursive: true });
     if (!selected) {
-        const templates = [];
+        const templates: string[] = [];
         templates.push(...fs.readdirSync(runtimeDir, { withFileTypes: true })
             .filter(item => item.isDirectory() && item.name !== 'starter')
             .map(dirent => dirent.name));
@@ -319,10 +324,10 @@ const initFunction = async () => {
         }
     }
 
-    const copyRecursiveSync = (src, dest) => {
+    const copyRecursiveSync = (src: string, dest: string): void => {
         let exists = fs.existsSync(src);
         let stats = exists && fs.statSync(src);
-        let isDirectory = exists && stats.isDirectory();
+        let isDirectory = exists && stats && stats.isDirectory();
         if (isDirectory) {
             if (!fs.existsSync(dest)) {
                 fs.mkdirSync(dest);
@@ -369,7 +374,7 @@ const initFunction = async () => {
     log("Next you can use 'appwrite run function' to develop a function locally. To deploy the function, use 'appwrite push function'");
 }
 
-const initSite = async () => {
+const initSite = async (): Promise<void> => {
     process.chdir(localConfig.configDirectoryPath)
 
     const answers = await inquirer.prompt(questionsCreateSite);
@@ -390,7 +395,7 @@ const initSite = async () => {
         throw new Error(`( ${siteName} ) already exists in the current directory. Please choose another name.`);
     }
 
-    let templateDetails;
+    let templateDetails: any;
     try {
         const response = await sitesListTemplates({
             frameworks: [answers.framework.key],
@@ -402,12 +407,12 @@ const initSite = async () => {
             throw new Error(`No starter template found for framework ${answers.framework.key}`);
         }
         templateDetails = response.templates[0];
-    } catch (error) {
-        throw new Error(`Failed to fetch template for framework ${answers.framework.key}: ${error.message}`);
+    } catch (err: any) {
+        throw new Error(`Failed to fetch template for framework ${answers.framework.key}: ${err.message}`);
     }
 
-    fs.mkdirSync(siteDir, "777");
-    fs.mkdirSync(templatesDir, "777");
+    fs.mkdirSync(siteDir, { mode: 0o777 });
+    fs.mkdirSync(templatesDir, { mode: 0o777 });
     const repo = `https://github.com/${templateDetails.providerOwner}/${templateDetails.providerRepositoryId}`;
     let selected = { template: templateDetails.frameworks[0].providerRootDirectory };
 
@@ -451,23 +456,23 @@ const initSite = async () => {
     /*  Execute the child process but do not print any std output */
     try {
         childProcess.execSync(gitCloneCommands, { stdio: 'pipe', cwd: templatesDir });
-    } catch (error) {
+    } catch (err: any) {
         /* Specialised errors with recommended actions to take */
-        if (error.message.includes('error: unknown option')) {
-            throw new Error(`${error.message} \n\nSuggestion: Try updating your git to the latest version, then trying to run this command again.`)
-        } else if (error.message.includes('is not recognized as an internal or external command,') || error.message.includes('command not found')) {
-            throw new Error(`${error.message} \n\nSuggestion: It appears that git is not installed, try installing git then trying to run this command again.`)
+        if (err.message.includes('error: unknown option')) {
+            throw new Error(`${err.message} \n\nSuggestion: Try updating your git to the latest version, then trying to run this command again.`)
+        } else if (err.message.includes('is not recognized as an internal or external command,') || err.message.includes('command not found')) {
+            throw new Error(`${err.message} \n\nSuggestion: It appears that git is not installed, try installing git then trying to run this command again.`)
         } else {
-            throw error;
+            throw err;
         }
     }
 
     fs.rmSync(path.join(templatesDir, ".git"), { recursive: true });
 
-    const copyRecursiveSync = (src, dest) => {
+    const copyRecursiveSync = (src: string, dest: string): void => {
         let exists = fs.existsSync(src);
         let stats = exists && fs.statSync(src);
-        let isDirectory = exists && stats.isDirectory();
+        let isDirectory = exists && stats && stats.isDirectory();
         if (isDirectory) {
             if (!fs.existsSync(dest)) {
                 fs.mkdirSync(dest);
@@ -491,9 +496,9 @@ const initSite = async () => {
     newReadmeFile.splice(1, 2);
     fs.writeFileSync(readmePath, newReadmeFile.join('\n'));
 
-    let vars = (templateDetails.variables ?? []).map(variable => {
+    let vars = (templateDetails.variables ?? []).map((variable: any) => {
         let value = variable.value;
-        const replacements = {
+        const replacements: Record<string, string> = {
             '{apiEndpoint}': globalConfig.getEndpoint(),
             '{projectId}': localConfig.getProject().projectId,
             '{projectName}': localConfig.getProject().projectName,
@@ -551,7 +556,7 @@ const initSite = async () => {
     log("Next you can use 'appwrite push site' to deploy the changes.");
 };
 
-const init = new Command("init")
+export const init = new Command("init")
     .description(commandDescriptions['init'])
     .action(actionRunner(initResources));
 
@@ -605,6 +610,3 @@ init
     .description("Init a new Appwrite topic")
     .action(actionRunner(initTopic));
 
-module.exports = {
-    init,
-};

package/lib/commands/{locale.js → locale.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,21 +31,17 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const locale = new Command("locale").description(commandDescriptions['locale'] ?? '').configureHelp({
+export const locale = new Command("locale").description(commandDescriptions['locale'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
-/**
- * @typedef {Object} LocaleGetRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {LocaleGetRequestParams} params
- */
-const localeGet = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface LocaleGetRequestParams {
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const localeGet = async ({parseOutput = true, overrideForCli = false, sdk = undefined}: LocaleGetRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/locale';
@@ -67,17 +59,13 @@ const localeGet = async ({parseOutput = true, overrideForCli = false, sdk = unde
     return response;
 
 }
-/**
- * @typedef {Object} LocaleListCodesRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {LocaleListCodesRequestParams} params
- */
-const localeListCodes = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface LocaleListCodesRequestParams {
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const localeListCodes = async ({parseOutput = true, overrideForCli = false, sdk = undefined}: LocaleListCodesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/locale/codes';
@@ -95,17 +83,13 @@ const localeListCodes = async ({parseOutput = true, overrideForCli = false, sdk
     return response;
 
 }
-/**
- * @typedef {Object} LocaleListContinentsRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {LocaleListContinentsRequestParams} params
- */
-const localeListContinents = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface LocaleListContinentsRequestParams {
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const localeListContinents = async ({parseOutput = true, overrideForCli = false, sdk = undefined}: LocaleListContinentsRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/locale/continents';
@@ -123,17 +107,13 @@ const localeListContinents = async ({parseOutput = true, overrideForCli = false,
     return response;
 
 }
-/**
- * @typedef {Object} LocaleListCountriesRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {LocaleListCountriesRequestParams} params
- */
-const localeListCountries = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface LocaleListCountriesRequestParams {
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const localeListCountries = async ({parseOutput = true, overrideForCli = false, sdk = undefined}: LocaleListCountriesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/locale/countries';
@@ -151,17 +131,13 @@ const localeListCountries = async ({parseOutput = true, overrideForCli = false,
     return response;
 
 }
-/**
- * @typedef {Object} LocaleListCountriesEURequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {LocaleListCountriesEURequestParams} params
- */
-const localeListCountriesEU = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface LocaleListCountriesEURequestParams {
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const localeListCountriesEU = async ({parseOutput = true, overrideForCli = false, sdk = undefined}: LocaleListCountriesEURequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/locale/countries/eu';
@@ -179,17 +155,13 @@ const localeListCountriesEU = async ({parseOutput = true, overrideForCli = false
     return response;
 
 }
-/**
- * @typedef {Object} LocaleListCountriesPhonesRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {LocaleListCountriesPhonesRequestParams} params
- */
-const localeListCountriesPhones = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface LocaleListCountriesPhonesRequestParams {
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const localeListCountriesPhones = async ({parseOutput = true, overrideForCli = false, sdk = undefined}: LocaleListCountriesPhonesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/locale/countries/phones';
@@ -207,17 +179,13 @@ const localeListCountriesPhones = async ({parseOutput = true, overrideForCli = f
     return response;
 
 }
-/**
- * @typedef {Object} LocaleListCurrenciesRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {LocaleListCurrenciesRequestParams} params
- */
-const localeListCurrencies = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface LocaleListCurrenciesRequestParams {
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const localeListCurrencies = async ({parseOutput = true, overrideForCli = false, sdk = undefined}: LocaleListCurrenciesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/locale/currencies';
@@ -235,17 +203,13 @@ const localeListCurrencies = async ({parseOutput = true, overrideForCli = false,
     return response;
 
 }
-/**
- * @typedef {Object} LocaleListLanguagesRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {LocaleListLanguagesRequestParams} params
- */
-const localeListLanguages = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface LocaleListLanguagesRequestParams {
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const localeListLanguages = async ({parseOutput = true, overrideForCli = false, sdk = undefined}: LocaleListLanguagesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/locale/languages';
@@ -303,14 +267,4 @@ locale
     .description(`List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.`)
     .action(actionRunner(localeListLanguages))
 
-module.exports = {
-    locale,
-    localeGet,
-    localeListCodes,
-    localeListContinents,
-    localeListCountries,
-    localeListCountriesEU,
-    localeListCountriesPhones,
-    localeListCurrencies,
-    localeListLanguages
-};
+