appwrite-cli 12.0.0 → 13.0.0-rc.1

package/lib/commands/{tokens.js → tokens.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,25 +31,22 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const tokens = new Command("tokens").description(commandDescriptions['tokens'] ?? '').configureHelp({
+export const tokens = new Command("tokens").description(commandDescriptions['tokens'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
-/**
- * @typedef {Object} TokensListRequestParams
- * @property {string} bucketId Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
- * @property {string} fileId File unique 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: expire
- * @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 {TokensListRequestParams} params
- */
-const tokensList = async ({bucketId,fileId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+interface TokensListRequestParams {
+    bucketId: string;
+    fileId: string;
+    queries?: string[];
+    total?: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    console?: boolean;
+}
+
+export const tokensList = async ({bucketId,fileId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined, console: showConsole}: TokensListRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
@@ -71,7 +64,7 @@ const tokensList = async ({bucketId,fileId,queries,total,parseOutput = true, ove
     }, payload);
 
     if (parseOutput) {
-        if(console) {
+        if(showConsole) {
             showConsoleLink('tokens', 'list', bucketId, fileId);
          } else {
             parse(response)
@@ -81,20 +74,16 @@ const tokensList = async ({bucketId,fileId,queries,total,parseOutput = true, ove
     return response;
 
 }
-/**
- * @typedef {Object} TokensCreateFileTokenRequestParams
- * @property {string} bucketId Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
- * @property {string} fileId File unique ID.
- * @property {string} expire Token expiry date
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {TokensCreateFileTokenRequestParams} params
- */
-const tokensCreateFileToken = async ({bucketId,fileId,expire,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface TokensCreateFileTokenRequestParams {
+    bucketId: string;
+    fileId: string;
+    expire?: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const tokensCreateFileToken = async ({bucketId,fileId,expire,parseOutput = true, overrideForCli = false, sdk = undefined}: TokensCreateFileTokenRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
@@ -116,18 +105,15 @@ const tokensCreateFileToken = async ({bucketId,fileId,expire,parseOutput = true,
     return response;
 
 }
-/**
- * @typedef {Object} TokensGetRequestParams
- * @property {string} tokenId Token ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {TokensGetRequestParams} params
- */
-const tokensGet = async ({tokenId,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+interface TokensGetRequestParams {
+    tokenId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    console?: boolean;
+}
+
+export const tokensGet = async ({tokenId,parseOutput = true, overrideForCli = false, sdk = undefined, console: showConsole}: TokensGetRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/tokens/{tokenId}'.replace('{tokenId}', tokenId);
@@ -139,7 +125,7 @@ const tokensGet = async ({tokenId,parseOutput = true, overrideForCli = false, sd
     }, payload);
 
     if (parseOutput) {
-        if(console) {
+        if(showConsole) {
             showConsoleLink('tokens', 'get', tokenId);
          } else {
             parse(response)
@@ -149,19 +135,15 @@ const tokensGet = async ({tokenId,parseOutput = true, overrideForCli = false, sd
     return response;
 
 }
-/**
- * @typedef {Object} TokensUpdateRequestParams
- * @property {string} tokenId Token unique ID.
- * @property {string} expire File token expiry date
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {TokensUpdateRequestParams} params
- */
-const tokensUpdate = async ({tokenId,expire,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface TokensUpdateRequestParams {
+    tokenId: string;
+    expire?: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const tokensUpdate = async ({tokenId,expire,parseOutput = true, overrideForCli = false, sdk = undefined}: TokensUpdateRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/tokens/{tokenId}'.replace('{tokenId}', tokenId);
@@ -183,18 +165,14 @@ const tokensUpdate = async ({tokenId,expire,parseOutput = true, overrideForCli =
     return response;
 
 }
-/**
- * @typedef {Object} TokensDeleteRequestParams
- * @property {string} tokenId Token ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {TokensDeleteRequestParams} params
- */
-const tokensDelete = async ({tokenId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface TokensDeleteRequestParams {
+    tokenId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const tokensDelete = async ({tokenId,parseOutput = true, overrideForCli = false, sdk = undefined}: TokensDeleteRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/tokens/{tokenId}'.replace('{tokenId}', tokenId);
@@ -219,7 +197,7 @@ tokens
     .requiredOption(`--bucket-id <bucket-id>`, `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`)
     .requiredOption(`--file-id <file-id>`, `File unique 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: expire`)
-    .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))
     .option(`--console`, `Get the resource console url`)
     .action(actionRunner(tokensList))
 
@@ -251,11 +229,4 @@ tokens
     .requiredOption(`--token-id <token-id>`, `Token ID.`)
     .action(actionRunner(tokensDelete))
 
-module.exports = {
-    tokens,
-    tokensList,
-    tokensCreateFileToken,
-    tokensGet,
-    tokensUpdate,
-    tokensDelete
-};
+

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

@@ -1,24 +1,22 @@
-const ejs = require("ejs");
-const fs = require("fs");
-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, 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");
-const { Swift } = require("../type-generation/languages/swift");
-const { Java } = require("../type-generation/languages/java");
-const { Dart } = require("../type-generation/languages/dart");
-const { JavaScript } = require("../type-generation/languages/javascript");
-const { CSharp } = require("../type-generation/languages/csharp");
-
-/**
- * @param {string} language
- * @returns {import("../type-generation/languages/language").LanguageMeta}
- */
-function createLanguageMeta(language) {
+import ejs = require('ejs');
+import fs = require('fs');
+import path = require('path');
+import { LanguageMeta, detectLanguage, Collection } from '../type-generation/languages/language';
+import { Command, Option, Argument } from 'commander';
+import { localConfig } from '../config';
+import { success, log, warn, actionRunner } from '../parser';
+import { PHP } from '../type-generation/languages/php';
+import { TypeScript } from '../type-generation/languages/typescript';
+import { Kotlin } from '../type-generation/languages/kotlin';
+import { Swift } from '../type-generation/languages/swift';
+import { Java } from '../type-generation/languages/java';
+import { Dart } from '../type-generation/languages/dart';
+import { JavaScript } from '../type-generation/languages/javascript';
+import { CSharp } from '../type-generation/languages/csharp';
+
+type SupportedLanguage = 'ts' | 'js' | 'php' | 'kotlin' | 'swift' | 'java' | 'dart' | 'cs';
+
+function createLanguageMeta(language: SupportedLanguage): LanguageMeta {
   switch (language) {
     case "ts":
       return new TypeScript();
@@ -47,7 +45,7 @@ const templateHelpers = {
   toSnakeCase: LanguageMeta.toSnakeCase,
   toKebabCase: LanguageMeta.toKebabCase,
   toUpperSnakeCase: LanguageMeta.toUpperSnakeCase
-}
+};
 
 const typesOutputArgument = new Argument(
   "<output-directory>",
@@ -67,7 +65,12 @@ const typesStrictOption = new Option(
 )
   .default(false);
 
-const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict}) => {
+interface TypesOptions {
+  language: string;
+  strict: boolean;
+}
+
+const typesCommand = actionRunner(async (rawOutputDirectory: string, {language, strict}: TypesOptions) => {
   if (language === "auto") {
     language = detectLanguage();
     log(`Detected language: ${language}`);
@@ -77,13 +80,13 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
     warn(`Strict mode enabled: Field names will be converted to follow ${language} conventions`);
   }
 
-  const meta = createLanguageMeta(language);
+  const meta = createLanguageMeta(language as SupportedLanguage);
 
   const rawOutputPath = rawOutputDirectory;
   const outputExt = path.extname(rawOutputPath);
   const isFileOutput = !!outputExt;
   let outputDirectory = rawOutputPath;
-  let singleFileDestination = null;
+  let singleFileDestination: string | null = null;
 
   if (isFileOutput) {
     if (meta.isSingleFile()) {
@@ -102,7 +105,7 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
 
   // Try tables first, fallback to collections
   let tables = localConfig.getTables();
-  let collections = [];
+  let collections: any[] = [];
   let dataSource = 'tables';
   
   if (tables.length === 0) {
@@ -116,7 +119,7 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
   }
 
   // Use tables if available, otherwise use collections
-  let dataItems = tables.length > 0 ? tables : collections;
+  let dataItems: any[] = tables.length > 0 ? tables : collections;
   const itemType = tables.length > 0 ? 'tables' : 'collections';
 
   // Normalize tables data: rename 'columns' to 'attributes' for template compatibility
@@ -125,7 +128,7 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
       const { columns, ...rest } = table;
       return {
         ...rest,
-        attributes: (columns || []).map(column => {
+        attributes: (columns || []).map((column: any) => {
           if (column.relatedTable) {
             const { relatedTable, ...columnRest } = column;
             return {
@@ -139,12 +142,12 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
     });
   }
 
-  log(`Found ${dataItems.length} ${itemType}: ${dataItems.map(c => c.name).join(", ")}`);
+  log(`Found ${dataItems.length} ${itemType}: ${dataItems.map((c: any) => c.name).join(", ")}`);
 
   // Use columns if available, otherwise use attributes
   const resourceType = tables.length > 0 ? 'columns' : 'attributes';
 
-  const totalAttributes = dataItems.reduce((count, item) => count + (item.attributes || []).length, 0);
+  const totalAttributes = dataItems.reduce((count: number, item: any) => count + (item.attributes || []).length, 0);
   log(`Found ${totalAttributes} ${resourceType} across all ${itemType}`);
 
   const templater = ejs.compile(meta.getTemplate());
@@ -154,7 +157,7 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
       collections: dataItems,
       strict,
       ...templateHelpers,
-      getType: meta.getType,
+      getType: meta.getType.bind(meta),
     });
 
     const destination = singleFileDestination || path.join(outputDirectory, meta.getFileName());
@@ -168,10 +171,10 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
         collection: item,
         strict,
         ...templateHelpers,
-        getType: meta.getType,
+        getType: meta.getType.bind(meta),
       });
   
-      const destination = path.join(outputDirectory, meta.getFileName(item));
+      const destination = path.join(outputDirectory, meta.getFileName(item as Collection));
   
       fs.writeFileSync(destination, content);
       log(`Added types for ${item.name} to ${destination}`);
@@ -181,11 +184,10 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
   success(`Generated types for all the listed ${itemType}`);
 });
 
-const types = new Command("types")
+export const types = new Command("types")
   .description("Generate types for your Appwrite project")
   .addArgument(typesOutputArgument)
   .addOption(typesLanguageOption)
   .addOption(typesStrictOption)
   .action(actionRunner(typesCommand));
 
-module.exports = { types };

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

@@ -1,18 +1,17 @@
-const fs = require("fs");
-const path = require("path");
-const { spawn } = require("child_process");
-const { Command } = require("commander");
-const { fetch } = require("undici");
-const chalk = require("chalk");
-const inquirer = require("inquirer");
-const { success, log, warn, error, hint, actionRunner, commandDescriptions } = require("../parser");
-const { getLatestVersion, compareVersions } = require("../utils");
-const { version } = require("../../package.json");
+import fs = require('fs');
+import path = require('path');
+import { spawn } from 'child_process';
+import { Command } from 'commander';
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import { success, log, warn, error, hint, actionRunner, commandDescriptions } from '../parser';
+import { getLatestVersion, compareVersions } from '../utils';
+const { version } = require('../../../package.json');
 
 /**
  * Check if the CLI was installed via npm
  */
-const isInstalledViaNpm = () => {
+const isInstalledViaNpm = (): boolean => {
     try {
         const scriptPath = process.argv[1];
 
@@ -36,7 +35,7 @@ const isInstalledViaNpm = () => {
 /**
  * Check if the CLI was installed via Homebrew
  */
-const isInstalledViaHomebrew = () => {
+const isInstalledViaHomebrew = (): boolean => {
     try {
         const scriptPath = process.argv[1];
         return scriptPath.includes('/opt/homebrew/') || scriptPath.includes('/usr/local/Cellar/');
@@ -45,12 +44,10 @@ const isInstalledViaHomebrew = () => {
     }
 };
 
-
-
 /**
  * Execute command and return promise
  */
-const execCommand = (command, args = [], options = {}) => {
+const execCommand = (command: string, args: string[] = [], options: any = {}): Promise<void> => {
     return new Promise((resolve, reject) => {
         const child = spawn(command, args, { 
             stdio: 'inherit',
@@ -75,13 +72,13 @@ const execCommand = (command, args = [], options = {}) => {
 /**
  * Update via npm
  */
-const updateViaNpm = async () => {
+const updateViaNpm = async (): Promise<void> => {
     try {
         await execCommand('npm', ['install', '-g', 'appwrite-cli@latest']);
         console.log("");
         success("Updated to latest version via npm!");
         hint("Run 'appwrite --version' to verify the new version.");
-    } catch (e) {
+    } catch (e: any) {
         if (e.message.includes('EEXIST') || e.message.includes('file already exists')) {
             console.log("");
             success("Latest version is already installed via npm!");
@@ -97,13 +94,13 @@ const updateViaNpm = async () => {
 /**
  * Update via Homebrew
  */
-const updateViaHomebrew = async () => {
+const updateViaHomebrew = async (): Promise<void> => {
     try {
         await execCommand('brew', ['upgrade', 'appwrite']);
         console.log("");
         success("Updated to latest version via Homebrew!");
         hint("Run 'appwrite --version' to verify the new version.");
-    } catch (e) {
+    } catch (e: any) {
         if (e.message.includes('already installed') || e.message.includes('up-to-date')) {
             console.log("");
             success("Latest version is already installed via Homebrew!");
@@ -119,7 +116,7 @@ const updateViaHomebrew = async () => {
 /**
  * Show manual update instructions
  */
-const showManualInstructions = (latestVersion) => {
+const showManualInstructions = (latestVersion: string): void => {
     log("Manual update options:");
     console.log("");
     
@@ -138,7 +135,7 @@ const showManualInstructions = (latestVersion) => {
 /**
  * Show interactive menu for choosing update method
  */
-const chooseUpdateMethod = async (latestVersion) => {
+const chooseUpdateMethod = async (latestVersion: string): Promise<void> => {
     const choices = [
         { name: 'NPM', value: 'npm' },
         { name: 'Homebrew', value: 'homebrew' },
@@ -167,10 +164,14 @@ const chooseUpdateMethod = async (latestVersion) => {
     }
 };
 
+interface UpdateOptions {
+    manual?: boolean;
+}
+
 /**
  * Main update function
  */
-const updateCli = async ({ manual } = {}) => {
+const updateCli = async ({ manual }: UpdateOptions = {}): Promise<void> => {
     try {
         const latestVersion = await getLatestVersion();
         
@@ -201,18 +202,15 @@ const updateCli = async ({ manual } = {}) => {
             await chooseUpdateMethod(latestVersion);
         }
         
-    } catch (e) {
+    } catch (e: any) {
         console.log("");
         error(`Failed to check for updates: ${e.message}`);
         hint("You can manually check for updates at: https://github.com/appwrite-cli/releases");
     }
 };
 
-const update = new Command("update")
+export const update = new Command("update")
     .description("Update the Appwrite CLI to the latest version")
     .option("--manual", "Show manual update instructions instead of auto-updating")
     .action(actionRunner(updateCli));
 
-module.exports = {
-    update
-};