appwrite-cli 12.0.0 → 13.0.0-rc.1

package/lib/commands/{project.js → project.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 project = new Command("project").description(commandDescriptions['project'] ?? '').configureHelp({
+export const project = new Command("project").description(commandDescriptions['project'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
-/**
- * @typedef {Object} ProjectGetUsageRequestParams
- * @property {string} startDate Starting date for the usage
- * @property {string} endDate End date for the usage
- * @property {ProjectUsageRange} period Period used
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProjectGetUsageRequestParams} params
- */
-const projectGetUsage = async ({startDate,endDate,period,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProjectGetUsageRequestParams {
+    startDate: string;
+    endDate: string;
+    period?: ProjectUsageRange;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const projectGetUsage = async ({startDate,endDate,period,parseOutput = true, overrideForCli = false, sdk = undefined}: ProjectGetUsageRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/project/usage';
@@ -79,17 +71,13 @@ const projectGetUsage = async ({startDate,endDate,period,parseOutput = true, ove
     return response;
 
 }
-/**
- * @typedef {Object} ProjectListVariablesRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProjectListVariablesRequestParams} params
- */
-const projectListVariables = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProjectListVariablesRequestParams {
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const projectListVariables = async ({parseOutput = true, overrideForCli = false, sdk = undefined}: ProjectListVariablesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/project/variables';
@@ -107,20 +95,16 @@ const projectListVariables = async ({parseOutput = true, overrideForCli = false,
     return response;
 
 }
-/**
- * @typedef {Object} ProjectCreateVariableRequestParams
- * @property {string} key Variable key. Max length: 255 chars.
- * @property {string} value Variable value. Max length: 8192 chars.
- * @property {boolean} secret Secret variables can be updated or deleted, but only projects can read them during build and runtime.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProjectCreateVariableRequestParams} params
- */
-const projectCreateVariable = async ({key,value,secret,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProjectCreateVariableRequestParams {
+    key: string;
+    value: string;
+    secret?: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const projectCreateVariable = async ({key,value,secret,parseOutput = true, overrideForCli = false, sdk = undefined}: ProjectCreateVariableRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/project/variables';
@@ -148,18 +132,14 @@ const projectCreateVariable = async ({key,value,secret,parseOutput = true, overr
     return response;
 
 }
-/**
- * @typedef {Object} ProjectGetVariableRequestParams
- * @property {string} variableId Variable unique ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProjectGetVariableRequestParams} params
- */
-const projectGetVariable = async ({variableId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProjectGetVariableRequestParams {
+    variableId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const projectGetVariable = async ({variableId,parseOutput = true, overrideForCli = false, sdk = undefined}: ProjectGetVariableRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/project/variables/{variableId}'.replace('{variableId}', variableId);
@@ -177,21 +157,17 @@ const projectGetVariable = async ({variableId,parseOutput = true, overrideForCli
     return response;
 
 }
-/**
- * @typedef {Object} ProjectUpdateVariableRequestParams
- * @property {string} variableId Variable unique ID.
- * @property {string} key Variable key. Max length: 255 chars.
- * @property {string} value Variable value. Max length: 8192 chars.
- * @property {boolean} secret Secret variables can be updated or deleted, but only projects can read them during build and runtime.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProjectUpdateVariableRequestParams} params
- */
-const projectUpdateVariable = async ({variableId,key,value,secret,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProjectUpdateVariableRequestParams {
+    variableId: string;
+    key: string;
+    value?: string;
+    secret?: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const projectUpdateVariable = async ({variableId,key,value,secret,parseOutput = true, overrideForCli = false, sdk = undefined}: ProjectUpdateVariableRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/project/variables/{variableId}'.replace('{variableId}', variableId);
@@ -219,18 +195,14 @@ const projectUpdateVariable = async ({variableId,key,value,secret,parseOutput =
     return response;
 
 }
-/**
- * @typedef {Object} ProjectDeleteVariableRequestParams
- * @property {string} variableId Variable unique ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {ProjectDeleteVariableRequestParams} params
- */
-const projectDeleteVariable = async ({variableId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface ProjectDeleteVariableRequestParams {
+    variableId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const projectDeleteVariable = async ({variableId,parseOutput = true, overrideForCli = false, sdk = undefined}: ProjectDeleteVariableRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/project/variables/{variableId}'.replace('{variableId}', variableId);
@@ -267,7 +239,7 @@ project
     .description(`Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.`)
     .requiredOption(`--key <key>`, `Variable key. Max length: 255 chars.`)
     .requiredOption(`--value <value>`, `Variable value. Max length: 8192 chars.`)
-    .option(`--secret [value]`, `Secret variables can be updated or deleted, but only projects can read them during build and runtime.`, (value) => value === undefined ? true : parseBool(value))
+    .option(`--secret [value]`, `Secret variables can be updated or deleted, but only projects can read them during build and runtime.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .action(actionRunner(projectCreateVariable))
 
 project
@@ -282,7 +254,7 @@ project
     .requiredOption(`--variable-id <variable-id>`, `Variable unique ID.`)
     .requiredOption(`--key <key>`, `Variable key. Max length: 255 chars.`)
     .option(`--value <value>`, `Variable value. Max length: 8192 chars.`)
-    .option(`--secret [value]`, `Secret variables can be updated or deleted, but only projects can read them during build and runtime.`, (value) => value === undefined ? true : parseBool(value))
+    .option(`--secret [value]`, `Secret variables can be updated or deleted, but only projects can read them during build and runtime.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .action(actionRunner(projectUpdateVariable))
 
 project
@@ -291,12 +263,4 @@ project
     .requiredOption(`--variable-id <variable-id>`, `Variable unique ID.`)
     .action(actionRunner(projectDeleteVariable))
 
-module.exports = {
-    project,
-    projectGetUsage,
-    projectListVariables,
-    projectCreateVariable,
-    projectGetVariable,
-    projectUpdateVariable,
-    projectDeleteVariable
-};
+