@super-protocol/sp-cli 0.0.6 → 0.0.8

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @super-protocol/sp-cli
 $ sp COMMAND
 running command...
 $ sp (--version)
-@super-protocol/sp-cli/0.0.6 linux-x64 node-v22.21.1
+@super-protocol/sp-cli/0.0.8 linux-x64 node-v22.21.1
 $ sp --help [COMMAND]
 USAGE
   $ sp COMMAND
@@ -30,18 +30,13 @@ USAGE
 <!-- usagestop -->
 # Commands
 <!-- commands -->
+* [`sp account forget`](#sp-account-forget)
 * [`sp account get-sppi`](#sp-account-get-sppi)
 * [`sp account info`](#sp-account-info)
-* [`sp auth login`](#sp-auth-login)
-* [`sp auth me`](#sp-auth-me)
+* [`sp account list`](#sp-account-list)
+* [`sp account login`](#sp-account-login)
+* [`sp account switch`](#sp-account-switch)
 * [`sp autocomplete [SHELL]`](#sp-autocomplete-shell)
-* [`sp config`](#sp-config)
-* [`sp config add [FILE]`](#sp-config-add-file)
-* [`sp config create`](#sp-config-create)
-* [`sp config delete`](#sp-config-delete)
-* [`sp config list`](#sp-config-list)
-* [`sp config show`](#sp-config-show)
-* [`sp config use`](#sp-config-use)
 * [`sp files download RESOURCEFILE LOCALDIRECTORY`](#sp-files-download-resourcefile-localdirectory)
 * [`sp files upload PATH`](#sp-files-upload-path)
 * [`sp help [COMMAND]`](#sp-help-command)
@@ -52,296 +47,178 @@ USAGE
 * [`sp storage update`](#sp-storage-update)
 * [`sp workflows extend-lease ORDERID`](#sp-workflows-extend-lease-orderid)
 
-## `sp account get-sppi`
+## `sp account forget`
 
-Get SPPI (Super Protocol incentive tokens)
+Purge all account details
 
 ```
 USAGE
-  $ sp account get-sppi [--json] [--config <value>]
+  $ sp account forget -n <value> [--json] [--tty] [-f]
 
-GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
-
-DESCRIPTION
-  Get SPPI (Super Protocol incentive tokens)
-
-EXAMPLES
-  $ sp account get-sppi
-```
-
-_See code: [src/commands/account/get-sppi.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/account/get-sppi.ts)_
-
-## `sp account info`
-
-Information about current authorized user
-
-```
-USAGE
-  $ sp account info [--json] [--config <value>]
-
-GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
-
-DESCRIPTION
-  Information about current authorized user
-```
-
-_See code: [src/commands/account/info.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/account/info.ts)_
-
-## `sp auth login`
-
-Login to SuperProtocol (sign up or sign in).
-
-```
-USAGE
-  $ sp auth login [--json] [--config <value>]
-
-GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
-
-DESCRIPTION
-  Login to SuperProtocol (sign up or sign in).
-
-ALIASES
-  $ sp login
-
-EXAMPLES
-  $ sp auth login
-```
-
-_See code: [src/commands/auth/login.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/auth/login.ts)_
-
-## `sp auth me`
-
-```
-USAGE
-  $ sp auth me [--json] [--config <value>]
+FLAGS
+  -f, --force         Force deletion without confirmation
+  -n, --name=<value>  (required) Configuration name to delete
 
 GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
-```
-
-_See code: [src/commands/auth/me.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/auth/me.ts)_
-
-## `sp autocomplete [SHELL]`
-
-Display autocomplete installation instructions.
-
-```
-USAGE
-  $ sp autocomplete [SHELL] [-r]
-
-ARGUMENTS
-  [SHELL]  (zsh|bash|powershell) Shell type
-
-FLAGS
-  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
-  Display autocomplete installation instructions.
+  Purge all account details
 
 EXAMPLES
-  $ sp autocomplete
+  $ sp account forget
 
-  $ sp autocomplete bash
-
-  $ sp autocomplete zsh
+  $ sp account forget --name "My Account"
 
-  $ sp autocomplete powershell
-
-  $ sp autocomplete --refresh-cache
+  $ sp account forget --name "My Account" --force
 ```
 
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.39/src/commands/autocomplete/index.ts)_
+_See code: [src/commands/account/forget.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/account/forget.ts)_
 
-## `sp config`
+## `sp account get-sppi`
 
-Manage configuration configs
+Get SPPI (Super Protocol incentive tokens)
 
 ```
 USAGE
-  $ sp config [--json]
+  $ sp account get-sppi [--json] [--tty]
 
 GLOBAL FLAGS
-  --json  Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
-  Manage configuration configs
+  Get SPPI (Super Protocol incentive tokens)
 
 EXAMPLES
-  $ sp config show - Show current configuration details
-
-  $ sp config list - List all configurations
-
-  $ sp config use - Switch to a configuration
-
-  $ sp config create --name "My Config" - Create new configuration
-
-  $ sp config add ./config.json - Import configuration from file
-
-  $ sp config delete - Delete a configuration
+  $ sp account get-sppi
 ```
 
-_See code: [src/commands/config/index.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/config/index.ts)_
+_See code: [src/commands/account/get-sppi.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/account/get-sppi.ts)_
 
-## `sp config add [FILE]`
+## `sp account info`
 
-Import a configuration from a file
+Information about current authorized user
 
 ```
 USAGE
-  $ sp config add [FILE] [--json] [-n <value>] [-y]
-
-ARGUMENTS
-  [FILE]  Configuration file path to import
+  $ sp account info [--json] [--tty] [--detail]
 
 FLAGS
-  -n, --name=<value>  Custom name for the imported configuration
-  -y, --yes           Automatically switch to imported configuration
+  --detail  Detailed information about Account
 
 GLOBAL FLAGS
-  --json  Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
-  Import a configuration from a file
-
-EXAMPLES
-  $ sp config add ./my-config.json
-
-  $ sp config add ./my-config.json --name "Imported"
-
-  Configuration files must follow this schema:
-    {
-      "providerUrl": "https://api.dp.superprotocol.com",
-      "name": "Some name",
-      "account": {
-        "address": "0x111222333444555....",
-        "privateKey": "0x000011122233344555..."
-      }
-    }
+  Information about current authorized user
 ```
 
-_See code: [src/commands/config/add.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/config/add.ts)_
+_See code: [src/commands/account/info.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/account/info.ts)_
 
-## `sp config create`
+## `sp account list`
 
-Create a new configuration
+List all Accounts
 
 ```
 USAGE
-  $ sp config create -n <value> [--json] [-u <value>] [-y]
-
-FLAGS
-  -n, --name=<value>  (required) Configuration name
-  -u, --url=<value>   Provider base URL
-  -y, --yes           Switch to new config
+  $ sp account list [--json] [--tty]
 
 GLOBAL FLAGS
-  --json  Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
-  Create a new configuration
+  List all Accounts
 
 EXAMPLES
-  $ sp config create --name "My Config"
-
-  $ sp config create --name "Production" --url "https://api.dp.superprotocol.com"
+  $ sp account list
 ```
 
-_See code: [src/commands/config/create.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/config/create.ts)_
+_See code: [src/commands/account/list.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/account/list.ts)_
 
-## `sp config delete`
+## `sp account login`
 
-Delete a configuration file
+Login to SuperProtocol (sign up or sign in).
 
 ```
 USAGE
-  $ sp config delete [--json] [-f] [-n <value>]
+  $ sp account login [--json] [--tty] [--name <value>] [--privateKey <value>] [-y]
 
 FLAGS
-  -f, --force         Force deletion without confirmation
-  -n, --name=<value>  Configuration name to delete
+  -y, --yes                 Skip questions (generate keys when needed).
+      --name=<value>        Account readable name
+      --privateKey=<value>  Account private key used for authentication
 
 GLOBAL FLAGS
-  --json  Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
-  Delete a configuration file
-
-EXAMPLES
-  $ sp config delete
+  Login to SuperProtocol (sign up or sign in).
 
-  $ sp config delete --name "My Config"
+ALIASES
+  $ sp login
 
-  $ sp config delete --name "My Config" --force
+EXAMPLES
+  $ sp account login
 ```
 
-_See code: [src/commands/config/delete.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/config/delete.ts)_
+_See code: [src/commands/account/login.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/account/login.ts)_
 
-## `sp config list`
+## `sp account switch`
 
-List all configurations
+Switch to a different account
 
 ```
 USAGE
-  $ sp config list [--json]
+  $ sp account switch [--json] [--tty]
 
 GLOBAL FLAGS
-  --json  Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
-  List all configurations
+  Switch to a different account
 
 EXAMPLES
-  $ sp config list
+  $ sp account switch
 ```
 
-_See code: [src/commands/config/list.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/config/list.ts)_
+_See code: [src/commands/account/switch.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/account/switch.ts)_
 
-## `sp config show`
+## `sp autocomplete [SHELL]`
 
-Show current configuration
+Display autocomplete installation instructions.
 
 ```
 USAGE
-  $ sp config show [--json]
+  $ sp autocomplete [SHELL] [-r]
 
-GLOBAL FLAGS
-  --json  Format output as json.
+ARGUMENTS
+  [SHELL]  (zsh|bash|powershell) Shell type
+
+FLAGS
+  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
 
 DESCRIPTION
-  Show current configuration
+  Display autocomplete installation instructions.
 
 EXAMPLES
-  $ sp config show
-```
-
-_See code: [src/commands/config/show.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/config/show.ts)_
-
-## `sp config use`
-
-Switch to a different configuration file
+  $ sp autocomplete
 
-```
-USAGE
-  $ sp config use [--json]
+  $ sp autocomplete bash
 
-GLOBAL FLAGS
-  --json  Format output as json.
+  $ sp autocomplete zsh
 
-DESCRIPTION
-  Switch to a different configuration file
+  $ sp autocomplete powershell
 
-EXAMPLES
-  $ sp config use
+  $ sp autocomplete --refresh-cache
 ```
 
-_See code: [src/commands/config/use.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/config/use.ts)_
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.39/src/commands/autocomplete/index.ts)_
 
 ## `sp files download RESOURCEFILE LOCALDIRECTORY`
 
@@ -349,7 +226,7 @@ Download file or directory described in resource file
 
 ```
 USAGE
-  $ sp files download RESOURCEFILE LOCALDIRECTORY [--json] [--config <value>] [--maximum-concurrent <value>]
+  $ sp files download RESOURCEFILE LOCALDIRECTORY [--json] [--tty] [--maximum-concurrent <value>]
 
 ARGUMENTS
   RESOURCEFILE    Path to a resource file
@@ -359,8 +236,8 @@ FLAGS
   --maximum-concurrent=<value>  [default: 1] Maximum concurrent pieces to download at once per transfer
 
 GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
   Download file or directory described in resource file
@@ -369,7 +246,7 @@ EXAMPLES
   $ sp files download ./resource.json ./pathToDownload
 ```
 
-_See code: [src/commands/files/download.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/files/download.ts)_
+_See code: [src/commands/files/download.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/files/download.ts)_
 
 ## `sp files upload PATH`
 
@@ -377,8 +254,8 @@ Upload file or directory to remote storage
 
 ```
 USAGE
-  $ sp files upload PATH [--json] [--config <value>] [--filename <value>] [--maximum-concurrent <value>]
-    [--metadata <value>] [--output <value>] [--skip-encryption] [--sync]
+  $ sp files upload PATH [--json] [--tty] [--filename <value>] [--maximum-concurrent <value>] [--metadata <value>]
+    [--output <value>] [--skip-encryption] [--sync]
 
 ARGUMENTS
   PATH  file or directory to upload
@@ -393,8 +270,8 @@ FLAGS
   --sync                        Sync mode: delete files in target that don't exist in source
 
 GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
   Upload file or directory to remote storage
@@ -403,7 +280,7 @@ EXAMPLES
   $ sp files upload ./file.txt
 ```
 
-_See code: [src/commands/files/upload.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/files/upload.ts)_
+_See code: [src/commands/files/upload.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/files/upload.ts)_
 
 ## `sp help [COMMAND]`
 
@@ -431,11 +308,16 @@ Login to SuperProtocol (sign up or sign in).
 
 ```
 USAGE
-  $ sp login [--json] [--config <value>]
+  $ sp login [--json] [--tty] [--name <value>] [--privateKey <value>] [-y]
+
+FLAGS
+  -y, --yes                 Skip questions (generate keys when needed).
+      --name=<value>        Account readable name
+      --privateKey=<value>  Account private key used for authentication
 
 GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
   Login to SuperProtocol (sign up or sign in).
@@ -453,15 +335,15 @@ Create a new storage entry from file or interactive prompts.
 
 ```
 USAGE
-  $ sp storage create [--json] [--config <value>] [-f <value>] [--notDefault]
+  $ sp storage create [--json] [--tty] [-f <value>] [--notDefault]
 
 FLAGS
   -f, --fromFile=<value>  Path to a JSON file that contains AddStorageDto payload.
       --notDefault        Skip setting the created storage as default.
 
 GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
   Create a new storage entry from file or interactive prompts.
@@ -474,7 +356,7 @@ EXAMPLES
   $ sp storage create --not-default
 ```
 
-_See code: [src/commands/storage/create.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/storage/create.ts)_
+_See code: [src/commands/storage/create.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/storage/create.ts)_
 
 ## `sp storage select`
 
@@ -482,11 +364,11 @@ Select a storage that will be used by subsequent commands.
 
 ```
 USAGE
-  $ sp storage select [--json] [--config <value>]
+  $ sp storage select [--json] [--tty]
 
 GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
   Select a storage that will be used by subsequent commands.
@@ -495,7 +377,7 @@ EXAMPLES
   $ sp storage select
 ```
 
-_See code: [src/commands/storage/select.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/storage/select.ts)_
+_See code: [src/commands/storage/select.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/storage/select.ts)_
 
 ## `sp storage show`
 
@@ -503,11 +385,11 @@ Show current selected storage
 
 ```
 USAGE
-  $ sp storage show [--json] [--config <value>]
+  $ sp storage show [--json] [--tty]
 
 GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
   Show current selected storage
@@ -516,7 +398,7 @@ EXAMPLES
   $ sp storage show
 ```
 
-_See code: [src/commands/storage/show.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/storage/show.ts)_
+_See code: [src/commands/storage/show.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/storage/show.ts)_
 
 ## `sp storage update`
 
@@ -524,15 +406,15 @@ Update the configuration of an existing storage.
 
 ```
 USAGE
-  $ sp storage update [--json] [--config <value>] [-f <value>] [-i <value>]
+  $ sp storage update [--json] [--tty] [-f <value>] [-i <value>]
 
 FLAGS
   -f, --fromFile=<value>  Path to a JSON file that contains UpdateStorageDto payload.
   -i, --id=<value>        Storage ID to update
 
 GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
   Update the configuration of an existing storage.
@@ -543,7 +425,7 @@ EXAMPLES
   $ sp storage update --id=2de3e3a4-0000-1111-2222-333344445555
 ```
 
-_See code: [src/commands/storage/update.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/storage/update.ts)_
+_See code: [src/commands/storage/update.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/storage/update.ts)_
 
 ## `sp workflows extend-lease ORDERID`
 
@@ -551,7 +433,7 @@ Replenish deposit for a workflow to extend its lease time
 
 ```
 USAGE
-  $ sp workflows extend-lease ORDERID [--json] [--config <value>] [--minutes <value>] [--sppi <value>] [-y]
+  $ sp workflows extend-lease ORDERID [--json] [--tty] [--minutes <value>] [--sppi <value>] [-y]
 
 ARGUMENTS
   ORDERID  Order ID
@@ -562,8 +444,8 @@ FLAGS
       --sppi=<value>     SPPI token amount to add to the order
 
 GLOBAL FLAGS
-  --config=<value>  Specify config file.
-  --json            Format output as json.
+  --json      Format output as json.
+  --[no-]tty  Force or disable interactive mode (use --no-tty to disable).
 
 DESCRIPTION
   Replenish deposit for a workflow to extend its lease time
@@ -576,5 +458,5 @@ EXAMPLES
   $ sp workflows extend-lease <orderId> --sppi 2 --yes
 ```
 
-_See code: [src/commands/workflows/extend-lease.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.6/src/commands/workflows/extend-lease.ts)_
+_See code: [src/commands/workflows/extend-lease.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.8/src/commands/workflows/extend-lease.ts)_
 <!-- commandsstop -->

package/dist/commands/account/base.d.ts

@@ -0,0 +1,19 @@
+import type { Command } from '@oclif/core';
+import type { AccountManager } from '../../managers/index.js';
+import { type SelectOptions } from '../../utils/prompt.service.js';
+import { BaseCommand } from '../base.js';
+type ProviderInitOptions = {
+    assumeYes?: boolean;
+    enableAuth?: boolean;
+    enableCookies?: boolean;
+    rebuild?: boolean;
+};
+export declare abstract class BaseAccountCommand<T extends typeof Command> extends BaseCommand<T> {
+    protected initAccountContext(providerOptions?: ProviderInitOptions): Promise<void>;
+    interactWithUser(accountManager: AccountManager): Promise<{
+        address: string;
+        privateKey: string;
+    }>;
+    protected selectPrompt<Value>(options: SelectOptions<Value>): Promise<Value>;
+}
+export {};

package/dist/commands/account/base.js

@@ -0,0 +1,42 @@
+import { promptService } from '../../utils/prompt.service.js';
+import { BaseCommand } from '../base.js';
+export class BaseAccountCommand extends BaseCommand {
+    async initAccountContext(providerOptions = {}) {
+        const rebuild = Boolean(providerOptions.rebuild);
+        const { accountManager } = await this.container.initAccountManager(rebuild).build();
+        if (!(await accountManager.hasAccount())) {
+            await (providerOptions.assumeYes
+                ? accountManager.create()
+                : this.interactWithUser(accountManager));
+        }
+        const { assumeYes: _assumeYes, rebuild: _rebuild, ...initOptions } = providerOptions;
+        await this.container.initProviderClient({ ...initOptions, rebuild }).build();
+    }
+    async interactWithUser(accountManager) {
+        this.warn("Account doesn't exist in current configuration");
+        const ask = await promptService.confirm({
+            message: 'Do you want to create a new account?',
+        });
+        if (ask) {
+            const account = await accountManager.create();
+            this.log('Generated new keyPair for new account.');
+            return account;
+        }
+        const privateKeyInput = await promptService.password({
+            message: 'Please input your privateKey for using in account',
+        });
+        const privateKey = privateKeyInput.trim();
+        try {
+            const account = await accountManager.createFromKey(privateKey);
+            this.log('Your privateKey will be used in config. Keypair created');
+            return account;
+        }
+        catch (error) {
+            this.debug(error);
+            this.error('Invalid private key format. Please try again.');
+        }
+    }
+    async selectPrompt(options) {
+        return promptService.select(options);
+    }
+}