@internxt/cli 0.1.4

package/.env

@@ -0,0 +1,11 @@
+DRIVE_URL=https://drive.internxt.com
+DRIVE_API_URL=https://drive.internxt.com/api
+DRIVE_NEW_API_URL=https://api.internxt.com/drive
+PAYMENTS_API_URL=https://api.internxt.com/payments
+PHOTOS_API_URL=https://photos.internxt.com/api
+APP_CRYPTO_SECRET=6KYQBP847D4ATSFA
+APP_CRYPTO_SECRET2=8Q8VMUE3BJZV87GT
+APP_MAGIC_IV=d139cb9a2cd17092e79e1861cf9d7023
+APP_MAGIC_SALT=38dce0391b49efba88dbc8c39ebf868f0267eb110bb0012ab27dc52a528d61b1d1ed9d76f400ff58e3240028442b1eab9bb84e111d9dadd997982dbde9dbd25e
+NETWORK_URL=https://api.internxt.com
+WEBDAV_SERVER_PORT=3005

package/README.md

@@ -0,0 +1,297 @@
+# Internxt CLI
+
+[![Commands Unit Tests](https://github.com/internxt/cli/actions/workflows/commands-unit-tests.yml/badge.svg)](https://github.com/internxt/cli/actions/workflows/commands-unit-tests.yml)
+[![CodeQL](https://github.com/internxt/cli/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/internxt/cli/actions/workflows/github-code-scanning/codeql)
+
+A CLI tool to interact with yout Internxt encrypted files
+
+<!-- toc -->
+* [Internxt CLI](#internxt-cli)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+
+# Usage
+
+<!-- usage -->
+```sh-session
+$ npm install -g @internxt/cli
+$ internxt COMMAND
+running command...
+$ internxt (--version)
+@internxt/cli/0.1.4 darwin-arm64 node-v18.16.1
+$ internxt --help [COMMAND]
+USAGE
+  $ internxt COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+
+<!-- commands -->
+* [`internxt config`](#internxt-config)
+* [`internxt download`](#internxt-download)
+* [`internxt list`](#internxt-list)
+* [`internxt login`](#internxt-login)
+* [`internxt logout`](#internxt-logout)
+* [`internxt logs`](#internxt-logs)
+* [`internxt move`](#internxt-move)
+* [`internxt trash`](#internxt-trash)
+* [`internxt upload`](#internxt-upload)
+* [`internxt webdav ACTION`](#internxt-webdav-action)
+* [`internxt whoami`](#internxt-whoami)
+
+## `internxt config`
+
+Display useful information from the user logged into the Internxt CLI.
+
+```
+USAGE
+  $ internxt config [--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]]
+    [--output csv|json|yaml |  | ] [--sort <value>]
+
+FLAGS
+  -x, --extended         show extra columns
+      --columns=<value>  only show provided columns (comma-separated)
+      --csv              output is csv format [alias: --output=csv]
+      --filter=<value>   filter property by partial string matching, ex: name=foo
+      --no-header        hide table header from output
+      --no-truncate      do not truncate output to fit screen
+      --output=<option>  output in a more machine friendly format
+                         <options: csv|json|yaml>
+      --sort=<value>     property to sort by (prepend '-' for descending)
+
+DESCRIPTION
+  Display useful information from the user logged into the Internxt CLI.
+
+EXAMPLES
+  $ internxt config
+```
+
+_See code: [src/commands/config.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/config.ts)_
+
+## `internxt download`
+
+Download and decrypts a file from Internxt Drive to a directory. The file name will be the same as the file name in your Drive
+
+```
+USAGE
+  $ internxt download --id <value> --directory <value> [--overwrite]
+
+FLAGS
+  --directory=<value>  (required) The directory to download the file to.
+  --id=<value>         (required) The id of the file to download. Use internxt list to view your files ids
+  --overwrite          Overwrite the file if it already exists
+
+DESCRIPTION
+  Download and decrypts a file from Internxt Drive to a directory. The file name will be the same as the file name in
+  your Drive
+
+EXAMPLES
+  $ internxt download
+```
+
+_See code: [src/commands/download.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/download.ts)_
+
+## `internxt list`
+
+Lists the content of a folder id.
+
+```
+USAGE
+  $ internxt list [-n] [-f <value>] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv |
+    --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>]
+
+FLAGS
+  -f, --id=<value>       The folder id to list. Leave empty for the root folder.
+  -x, --extended         show extra columns
+      --columns=<value>  only show provided columns (comma-separated)
+      --csv              output is csv format [alias: --output=csv]
+      --filter=<value>   filter property by partial string matching, ex: name=foo
+      --no-header        hide table header from output
+      --no-truncate      do not truncate output to fit screen
+      --output=<option>  output in a more machine friendly format
+                         <options: csv|json|yaml>
+      --sort=<value>     property to sort by (prepend '-' for descending)
+
+HELPER FLAGS
+  -n, --non-interactive  Blocks the cli from being interactive. If passed, the cli will not request data through the
+                         console and will throw errors directly
+
+DESCRIPTION
+  Lists the content of a folder id.
+
+EXAMPLES
+  $ internxt list
+```
+
+_See code: [src/commands/list.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/list.ts)_
+
+## `internxt login`
+
+Logs into an Internxt account. If the account is two-factor protected, then an extra code will be required.
+
+```
+USAGE
+  $ internxt login [-n] [-e <value>] [-p <value>] [-w <value>]
+
+FLAGS
+  -e, --email=<value>     The email to log in
+  -p, --password=<value>  The plain password to log in
+  -w, --twofactor=123456  The two factor auth code (only needed if the account is two-factor protected)
+
+HELPER FLAGS
+  -n, --non-interactive  Blocks the cli from being interactive. If passed, the cli will not request data through the
+                         console and will throw errors directly
+
+DESCRIPTION
+  Logs into an Internxt account. If the account is two-factor protected, then an extra code will be required.
+
+EXAMPLES
+  $ internxt login
+```
+
+_See code: [src/commands/login.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/login.ts)_
+
+## `internxt logout`
+
+Logs out the current internxt user that is logged into the Internxt CLI.
+
+```
+USAGE
+  $ internxt logout
+
+DESCRIPTION
+  Logs out the current internxt user that is logged into the Internxt CLI.
+
+EXAMPLES
+  $ internxt logout
+```
+
+_See code: [src/commands/logout.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/logout.ts)_
+
+## `internxt logs`
+
+Displays the Internxt CLI logs directory path
+
+```
+USAGE
+  $ internxt logs
+
+DESCRIPTION
+  Displays the Internxt CLI logs directory path
+
+EXAMPLES
+  $ internxt logs
+```
+
+_See code: [src/commands/logs.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/logs.ts)_
+
+## `internxt move`
+
+Move a folder/file into a destination folder.
+
+```
+USAGE
+  $ internxt move [-n] [-i <value>] [-d <value>]
+
+FLAGS
+  -d, --destination=<value>  The destination folder id where the item is going to be moved.
+  -i, --id=<value>           The item id to be moved (it can be a file id or a folder id).
+
+HELPER FLAGS
+  -n, --non-interactive  Blocks the cli from being interactive. If passed, the cli will not request data through the
+                         console and will throw errors directly
+
+DESCRIPTION
+  Move a folder/file into a destination folder.
+
+EXAMPLES
+  $ internxt move
+```
+
+_See code: [src/commands/move.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/move.ts)_
+
+## `internxt trash`
+
+Moves a given folder/file to the trash.
+
+```
+USAGE
+  $ internxt trash [-n] [-i <value>]
+
+FLAGS
+  -i, --id=<value>  The item id to be trashed (it can be a file id or a folder id).
+
+HELPER FLAGS
+  -n, --non-interactive  Blocks the cli from being interactive. If passed, the cli will not request data through the
+                         console and will throw errors directly
+
+DESCRIPTION
+  Moves a given folder/file to the trash.
+
+EXAMPLES
+  $ internxt trash
+```
+
+_See code: [src/commands/trash.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/trash.ts)_
+
+## `internxt upload`
+
+Upload a file to Internxt Drive
+
+```
+USAGE
+  $ internxt upload --file <value> [--json] [--id <value>]
+
+FLAGS
+  --file=<value>  (required) The path to read the file in your system
+  --id=<value>    The folder id to upload the file to
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Upload a file to Internxt Drive
+
+EXAMPLES
+  $ internxt upload
+```
+
+_See code: [src/commands/upload.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/upload.ts)_
+
+## `internxt webdav ACTION`
+
+Enable or disable the Internxt CLI WebDav server
+
+```
+USAGE
+  $ internxt webdav ACTION
+
+DESCRIPTION
+  Enable or disable the Internxt CLI WebDav server
+
+EXAMPLES
+  $ internxt webdav
+```
+
+_See code: [src/commands/webdav.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/webdav.ts)_
+
+## `internxt whoami`
+
+Display the current user logged into the Internxt CLI.
+
+```
+USAGE
+  $ internxt whoami
+
+DESCRIPTION
+  Display the current user logged into the Internxt CLI.
+
+EXAMPLES
+  $ internxt whoami
+```
+
+_See code: [src/commands/whoami.ts](https://github.com/internxt/cli/blob/v0.1.4/src/commands/whoami.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node_modules/.bin/ts-node
+/* eslint-disable */
+require('dotenv').config({ path: __dirname + '/../.env' });
+(async () => {
+  const oclif = await import('@oclif/core');
+  await oclif.execute({ development: true, dir: __dirname });
+})();

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+/* eslint-disable */
+require('dotenv').config({ path: __dirname + '/../.env' });
+(async () => {
+  const oclif = await import('@oclif/core');
+  await oclif.execute({ development: false, dir: __dirname });
+})();

package/dist/commands/config.d.ts

@@ -0,0 +1,18 @@
+import { Command } from '@oclif/core';
+export default class Config extends Command {
+    static readonly args: {};
+    static readonly description = "Display useful information from the user logged into the Internxt CLI.";
+    static readonly examples: string[];
+    static readonly flags: {
+        columns: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        csv: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        extended: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        filter: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'no-header': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'no-truncate': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        sort: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+    };
+    catch(error: Error): Promise<void>;
+    run(): Promise<void>;
+}

package/dist/commands/config.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const config_service_1 = require("../services/config.service");
+const cli_utils_1 = require("../utils/cli.utils");
+const errors_utils_1 = require("../utils/errors.utils");
+const usage_service_1 = require("../services/usage.service");
+const format_utils_1 = require("../utils/format.utils");
+class Config extends core_1.Command {
+    static args = {};
+    static description = 'Display useful information from the user logged into the Internxt CLI.';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        ...core_1.ux.table.flags(),
+    };
+    async catch(error) {
+        errors_utils_1.ErrorUtils.report(error, { command: this.id });
+        cli_utils_1.CLIUtils.error(error.message);
+        this.exit(1);
+    }
+    async run() {
+        const { flags } = await this.parse(Config);
+        const userCredentials = await config_service_1.ConfigService.instance.readUser();
+        if (userCredentials?.user) {
+            const configList = [
+                { key: 'Email', value: userCredentials.user.email },
+                { key: 'Root folder ID', value: userCredentials.root_folder_uuid },
+                { key: 'Used space', value: format_utils_1.FormatUtils.humanFileSize(await usage_service_1.UsageService.instance.fetchTotalUsage()) },
+                { key: 'Available space', value: format_utils_1.FormatUtils.formatLimit(await usage_service_1.UsageService.instance.fetchSpaceLimit()) },
+            ];
+            core_1.ux.table(configList, {
+                key: {
+                    header: 'Key',
+                    get: (row) => row.key,
+                },
+                value: {
+                    header: 'Value',
+                    get: (row) => row.value,
+                },
+            }, {
+                printLine: this.log.bind(this),
+                ...flags,
+            });
+        }
+        else {
+            cli_utils_1.CLIUtils.error('You are not logged in');
+        }
+    }
+}
+exports.default = Config;

package/dist/commands/download.d.ts

@@ -0,0 +1,19 @@
+import { Command } from '@oclif/core';
+import { NetworkFacade } from '../services/network/network-facade.service';
+import { UserSettings } from '@internxt/sdk/dist/shared/types/userSettings';
+import { DriveFileItem } from '../types/drive.types';
+export default class Download extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        overwrite: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        id: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        directory: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    catch(error: Error): Promise<void>;
+    getFileMetadata: (uuid: string) => Promise<DriveFileItem>;
+    getUser: () => Promise<UserSettings>;
+    getDownloadPath: (downloadDirectory: string, driveFile: DriveFileItem, overwrite: boolean) => Promise<string>;
+    prepareNetwork: (user: UserSettings) => Promise<NetworkFacade>;
+    run(): Promise<void>;
+}

package/dist/commands/download.js

@@ -0,0 +1,119 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const drive_file_service_1 = require("../services/drive/drive-file.service");
+const cli_utils_1 = require("../utils/cli.utils");
+const network_facade_service_1 = require("../services/network/network-facade.service");
+const auth_service_1 = require("../services/auth.service");
+const crypto_service_1 = require("../services/crypto.service");
+const download_service_1 = require("../services/network/download.service");
+const upload_service_1 = require("../services/network/upload.service");
+const sdk_manager_service_1 = require("../services/sdk-manager.service");
+const fs_1 = require("fs");
+const promises_1 = __importDefault(require("fs/promises"));
+const path_1 = __importDefault(require("path"));
+const stream_utils_1 = require("../utils/stream.utils");
+const errors_utils_1 = require("../utils/errors.utils");
+class Download extends core_1.Command {
+    static description = 'Download and decrypts a file from Internxt Drive to a directory. The file name will be the same as the file name in your Drive';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        overwrite: core_1.Flags.boolean({ description: 'Overwrite the file if it already exists', default: false }),
+        id: core_1.Flags.string({
+            description: 'The id of the file to download. Use <%= config.bin %> list to view your files ids',
+            required: true,
+        }),
+        directory: core_1.Flags.string({
+            description: 'The directory to download the file to.',
+            required: true,
+        }),
+    };
+    async catch(error) {
+        errors_utils_1.ErrorUtils.report(error, { command: this.id });
+        cli_utils_1.CLIUtils.error(error.message);
+        this.exit(1);
+    }
+    getFileMetadata = async (uuid) => {
+        cli_utils_1.CLIUtils.doing('Getting file metadata');
+        const driveFile = await drive_file_service_1.DriveFileService.instance.getFileMetadata(uuid);
+        cli_utils_1.CLIUtils.done();
+        if (!driveFile) {
+            throw new Error('File not found');
+        }
+        return driveFile;
+    };
+    getUser = async () => {
+        const { mnemonic } = await auth_service_1.AuthService.instance.getAuthDetails();
+        const user = await auth_service_1.AuthService.instance.getUser();
+        return {
+            ...user,
+            mnemonic,
+        };
+    };
+    getDownloadPath = async (downloadDirectory, driveFile, overwrite) => {
+        const filename = path_1.default.format({
+            name: driveFile.name,
+            ext: `.${driveFile.type}`,
+        });
+        const downloadPath = path_1.default.join(downloadDirectory, filename);
+        await promises_1.default.access(downloadDirectory, promises_1.default.constants.W_OK);
+        try {
+            const stat = await promises_1.default.stat(downloadPath);
+            if (stat.isFile() && !overwrite) {
+                throw new Error('File already exists, use --overwrite flag to overwrite it');
+            }
+        }
+        catch (err) {
+            if (err.code !== 'ENOENT') {
+                throw err;
+            }
+        }
+        return downloadPath;
+    };
+    prepareNetwork = async (user) => {
+        cli_utils_1.CLIUtils.doing('Preparing Network');
+        const networkModule = sdk_manager_service_1.SdkManager.instance.getNetwork({
+            user: user.bridgeUser,
+            pass: user.userId,
+        });
+        const networkFacade = new network_facade_service_1.NetworkFacade(networkModule, upload_service_1.UploadService.instance, download_service_1.DownloadService.instance, crypto_service_1.CryptoService.instance);
+        cli_utils_1.CLIUtils.done();
+        return networkFacade;
+    };
+    async run() {
+        const { flags } = await this.parse(Download);
+        const { directory: downloadDirectory, id: fileUuid, overwrite } = flags;
+        const directoryStat = await promises_1.default.stat(downloadDirectory);
+        if (!directoryStat.isDirectory()) {
+            throw new Error('The directory provided is not a directory');
+        }
+        const driveFile = await this.getFileMetadata(fileUuid);
+        const downloadPath = await this.getDownloadPath(downloadDirectory, driveFile, overwrite);
+        const user = await this.getUser();
+        const networkFacade = await this.prepareNetwork(user);
+        const fileWriteStream = (0, fs_1.createWriteStream)(downloadPath);
+        const progressBar = core_1.ux.progress({
+            format: 'Downloading file [{bar}] {percentage}%',
+            linewrap: true,
+        });
+        progressBar.start(100, 0);
+        const [executeDownload, abortable] = await networkFacade.downloadToStream(user.bucket, user.mnemonic, driveFile.fileId, stream_utils_1.StreamUtils.writeStreamToWritableStream(fileWriteStream), {
+            abortController: new AbortController(),
+            progressCallback: (progress) => {
+                progressBar.update(progress);
+            },
+        });
+        process.on('SIGINT', () => {
+            abortable.abort('SIGINT received');
+            process.exit(1);
+        });
+        await executeDownload;
+        progressBar.update(100);
+        progressBar.stop();
+        cli_utils_1.CLIUtils.success(`File downloaded successfully to ${downloadPath}`);
+    }
+}
+exports.default = Download;

package/dist/commands/list.d.ts

@@ -0,0 +1,22 @@
+import { Command } from '@oclif/core';
+export default class List extends Command {
+    static readonly args: {};
+    static readonly description = "Lists the content of a folder id.";
+    static readonly examples: string[];
+    static readonly flags: {
+        columns: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        csv: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        extended: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        filter: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'no-header': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'no-truncate': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        sort: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        id: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'non-interactive': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    catch(error: Error): Promise<void>;
+    getFolderUuid: (folderUuidFlag: string | undefined, nonInteractive: boolean) => Promise<string>;
+    getFolderUuidInteractively: () => Promise<string>;
+}