chirag-appwrite-cli 0.1.0

package/lib/commands/tokens.js

@@ -0,0 +1,261 @@
+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 } = 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) {
+  return new ReadableStream({
+    start(controller) {
+      readStream.on("data", (chunk) => {
+        controller.enqueue(chunk);
+      });
+      readStream.on("end", () => {
+        controller.close();
+      });
+      readStream.on("error", (err) => {
+        controller.error(err);
+      });
+    },
+    cancel() {
+      readStream.destroy();
+    },
+  });
+}
+
+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} overrideForCli
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TokensListRequestParams} params
+ */
+const tokensList = async ({bucketId,fileId,queries,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+    let payload = {};
+    if (typeof queries !== 'undefined') {
+        payload['queries'] = queries;
+    }
+
+    let response = undefined;
+
+    response = await client.call('get', apiPath, {
+    }, payload);
+
+    if (parseOutput) {
+        if(console) {
+            showConsoleLink('tokens', 'list', bucketId, fileId);
+         } else {
+            parse(response)
+        }
+    }
+
+    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}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+    let payload = {};
+    if (typeof expire !== 'undefined') {
+        payload['expire'] = expire;
+    }
+
+    let response = undefined;
+
+    response = await client.call('post', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    if (parseOutput) {
+        parse(response)
+    }
+
+    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}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/tokens/{tokenId}'.replace('{tokenId}', tokenId);
+    let payload = {};
+
+    let response = undefined;
+
+    response = await client.call('get', apiPath, {
+    }, payload);
+
+    if (parseOutput) {
+        if(console) {
+            showConsoleLink('tokens', 'get', tokenId);
+         } else {
+            parse(response)
+        }
+    }
+
+    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}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/tokens/{tokenId}'.replace('{tokenId}', tokenId);
+    let payload = {};
+    if (typeof expire !== 'undefined') {
+        payload['expire'] = expire;
+    }
+
+    let response = undefined;
+
+    response = await client.call('patch', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    if (parseOutput) {
+        parse(response)
+    }
+
+    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}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/tokens/{tokenId}'.replace('{tokenId}', tokenId);
+    let payload = {};
+
+    let response = undefined;
+
+    response = await client.call('delete', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    if (parseOutput) {
+        parse(response)
+    }
+
+    return response;
+
+}
+
+tokens
+    .command(`list`)
+    .description(`List all the tokens created for a specific file or bucket. You can use the query params to filter your results.`)
+    .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(`--console`, `Get the resource console url`)
+    .action(actionRunner(tokensList))
+
+tokens
+    .command(`create-file-token`)
+    .description(`Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.`)
+    .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(`--expire <expire>`, `Token expiry date`)
+    .action(actionRunner(tokensCreateFileToken))
+
+tokens
+    .command(`get`)
+    .description(`Get a token by its unique ID.`)
+    .requiredOption(`--token-id <token-id>`, `Token ID.`)
+    .option(`--console`, `Get the resource console url`)
+    .action(actionRunner(tokensGet))
+
+tokens
+    .command(`update`)
+    .description(`Update a token by its unique ID. Use this endpoint to update a token's expiry date.`)
+    .requiredOption(`--token-id <token-id>`, `Token unique ID.`)
+    .option(`--expire <expire>`, `File token expiry date`)
+    .action(actionRunner(tokensUpdate))
+
+tokens
+    .command(`delete`)
+    .description(`Delete a token by its unique ID.`)
+    .requiredOption(`--token-id <token-id>`, `Token ID.`)
+    .action(actionRunner(tokensDelete))
+
+module.exports = {
+    tokens,
+    tokensList,
+    tokensCreateFileToken,
+    tokensGet,
+    tokensUpdate,
+    tokensDelete
+};

package/lib/commands/types.js

@@ -0,0 +1,156 @@
+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, 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");
+
+/**
+ * @param {string} language
+ * @returns {import("../type-generation/languages/language").LanguageMeta}
+ */
+function createLanguageMeta(language) {
+  switch (language) {
+    case "ts":
+      return new TypeScript();
+    case "js":
+      return new JavaScript();
+    case "php":
+      return new PHP();
+    case "kotlin":
+      return new Kotlin();
+    case "swift":
+      return new Swift();
+    case "java":
+      return new Java();
+    case "dart":
+      return new Dart();
+    default:
+      throw new Error(`Language '${language}' is not supported`);
+  }
+}
+
+const templateHelpers = {
+  toPascalCase: LanguageMeta.toPascalCase,
+  toCamelCase: LanguageMeta.toCamelCase,
+  toSnakeCase: LanguageMeta.toSnakeCase,
+  toKebabCase: LanguageMeta.toKebabCase,
+  toUpperSnakeCase: LanguageMeta.toUpperSnakeCase
+}
+
+const typesOutputArgument = new Argument(
+  "<output-directory>",
+  "The directory to write the types to"
+);
+
+const typesLanguageOption = new Option(
+  "-l, --language <language>",
+  "The language of the types"
+)
+  .choices(["auto", "ts", "js", "php", "kotlin", "swift", "java", "dart"])
+  .default("auto");
+
+const typesStrictOption = new Option(
+  "-s, --strict",
+  "Enable strict mode to automatically convert field names to follow language conventions"
+)
+  .default(false);
+
+const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict}) => {
+  if (language === "auto") {
+    language = detectLanguage();
+    log(`Detected language: ${language}`);
+  }
+
+  if (strict) {
+    log(`Strict mode enabled: Field names will be converted to follow ${language} conventions`);
+  }
+
+  const meta = createLanguageMeta(language);
+
+  const rawOutputPath = rawOutputDirectory;
+  const outputExt = path.extname(rawOutputPath);
+  const isFileOutput = !!outputExt;
+  let outputDirectory = rawOutputPath;
+  let singleFileDestination = null;
+
+  if (isFileOutput) {
+    if (meta.isSingleFile()) {
+      // Use the file path directly for single file languages
+      outputDirectory = path.dirname(rawOutputPath);
+      singleFileDestination = rawOutputPath;
+    } else {
+      throw new Error(`Invalid output path: ${rawOutputPath}. Output path must be a directory for languages that generate multiple files.`);
+    }
+  }
+
+  if (!fs.existsSync(outputDirectory)) {
+    log(`Directory: ${outputDirectory} does not exist, creating...`);
+    fs.mkdirSync(outputDirectory, { recursive: true });
+  }
+
+  if (!fs.existsSync("appwrite.json")) {
+    throw new Error("appwrite.json not found in current directory");
+  }
+
+  const collections = localConfig.getCollections();
+  if (collections.length === 0) {
+    throw new Error("No collections found in appwrite.json");
+  }
+
+  log(`Found ${collections.length} collections: ${collections.map(c => c.name).join(", ")}`);
+
+  const totalAttributes = collections.reduce((count, collection) => count + collection.attributes.length, 0);
+  log(`Found ${totalAttributes} attributes across all collections`);
+
+  const templater = ejs.compile(meta.getTemplate());
+
+  if (meta.isSingleFile()) {
+    const content = templater({
+      collections,
+      strict,
+      path: rawOutputDirectory ?? '',
+      ...templateHelpers,
+      getType: meta.getType,
+    });
+
+    const destination = singleFileDestination || path.join(outputDirectory, meta.getFileName());
+
+    fs.writeFileSync(destination, content);
+    log(`Added types to ${destination}`);
+  } else {
+    for (const collection of collections) {
+      const content = templater({
+        collection,
+        strict,
+        path: rawOutputDirectory ?? '',
+        ...templateHelpers,
+        getType: meta.getType,
+      });
+  
+      const destination = path.join(outputDirectory, meta.getFileName(collection));
+  
+      fs.writeFileSync(destination, content);
+      log(`Added types for ${collection.name} to ${destination}`);
+    }
+  }
+  
+  success(`Generated types for all the listed collections`);
+});
+
+const types = new Command("types")
+  .description("Generate types for your Appwrite project")
+  .addArgument(typesOutputArgument)
+  .addOption(typesLanguageOption)
+  .addOption(typesStrictOption)
+  .action(actionRunner(typesCommand));
+
+module.exports = { types };