@super-protocol/sp-cli 0.0.1-alpha.42 → 0.0.2

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.1-alpha.42 linux-x64 node-v22.20.0
+@super-protocol/sp-cli/0.0.2 linux-x64 node-v22.21.1
 $ sp --help [COMMAND]
 USAGE
   $ sp COMMAND
@@ -32,6 +32,15 @@ USAGE
 <!-- commands -->
 * [`sp auth login`](#sp-auth-login)
 * [`sp auth me`](#sp-auth-me)
+* [`sp base`](#sp-base)
+* [`sp config`](#sp-config)
+* [`sp config add [FILE]`](#sp-config-add-file)
+* [`sp config base`](#sp-config-base)
+* [`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 help [COMMAND]`](#sp-help-command)
 * [`sp plugins`](#sp-plugins)
 * [`sp plugins add PLUGIN`](#sp-plugins-add-plugin)
@@ -43,8 +52,6 @@ USAGE
 * [`sp plugins uninstall [PLUGIN]`](#sp-plugins-uninstall-plugin)
 * [`sp plugins unlink [PLUGIN]`](#sp-plugins-unlink-plugin)
 * [`sp plugins update`](#sp-plugins-update)
-* [`sp refresh`](#sp-refresh)
-* [`sp update [CHANNEL]`](#sp-update-channel)
 
 ## `sp auth login`
 
@@ -52,7 +59,12 @@ Authorization
 
 ```
 USAGE
-  $ sp auth login
+  $ sp auth login [--json] [--config <value>] [--url <value>]
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
 
 DESCRIPTION
   Authorization
@@ -61,16 +73,246 @@ EXAMPLES
   $ sp auth login
 ```
 
-_See code: [src/commands/auth/login.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.1-alpha.42/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/auth/login.ts)_
 
 ## `sp auth me`
 
 ```
 USAGE
-  $ sp auth me
+  $ sp auth me [--json] [--config <value>] [--url <value>]
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+```
+
+_See code: [src/commands/auth/me.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/auth/me.ts)_
+
+## `sp base`
+
+```
+USAGE
+  $ sp base [--json] [--config <value>] [--url <value>]
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+```
+
+_See code: [src/commands/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/base.ts)_
+
+## `sp config`
+
+Manage configuration configs
+
+```
+USAGE
+  $ sp config [--json] [--config <value>] [--url <value>]
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+
+DESCRIPTION
+  Manage configuration configs
+
+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
+```
+
+_See code: [src/commands/config/index.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/config/index.ts)_
+
+## `sp config add [FILE]`
+
+Import a configuration from a file
+
+```
+USAGE
+  $ sp config add [FILE] [--json] [--config <value>] [--url <value>] [-n <value>] [-y]
+
+ARGUMENTS
+  [FILE]  Configuration file path to import
+
+FLAGS
+  -n, --name=<value>  Custom name for the imported configuration
+  -y, --yes           Automatically switch to imported configuration
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+
+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..."
+      }
+    }
+```
+
+_See code: [src/commands/config/add.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/config/add.ts)_
+
+## `sp config base`
+
+```
+USAGE
+  $ sp config base [--json] [--config <value>] [--url <value>]
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+```
+
+_See code: [src/commands/config/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/config/base.ts)_
+
+## `sp config create`
+
+Create a new configuration
+
+```
+USAGE
+  $ sp config create -n <value> [--json] [--config <value>] [-u <value>] [-y]
+
+FLAGS
+  -n, --name=<value>  (required) Configuration name
+  -u, --url=<value>   Provider base URL
+  -y, --yes           Switch to new config
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+
+DESCRIPTION
+  Create a new configuration
+
+EXAMPLES
+  $ sp config create --name "My Config"
+
+  $ sp config create --name "Production" --url "https://api.dp.superprotocol.com"
+```
+
+_See code: [src/commands/config/create.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/config/create.ts)_
+
+## `sp config delete`
+
+Delete a configuration file
+
+```
+USAGE
+  $ sp config delete [--json] [--config <value>] [--url <value>] [-f] [-n <value>]
+
+FLAGS
+  -f, --force         Force deletion without confirmation
+  -n, --name=<value>  Configuration name to delete
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+
+DESCRIPTION
+  Delete a configuration file
+
+EXAMPLES
+  $ sp config delete
+
+  $ sp config delete --name "My Config"
+
+  $ sp config delete --name "My Config" --force
+```
+
+_See code: [src/commands/config/delete.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/config/delete.ts)_
+
+## `sp config list`
+
+List all configurations
+
 ```
+USAGE
+  $ sp config list [--json] [--config <value>] [--url <value>]
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+
+DESCRIPTION
+  List all configurations
+
+EXAMPLES
+  $ sp config list
+```
+
+_See code: [src/commands/config/list.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/config/list.ts)_
+
+## `sp config show`
+
+Show current configuration
+
+```
+USAGE
+  $ sp config show [--json] [--config <value>] [--url <value>]
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+
+DESCRIPTION
+  Show current configuration
+
+EXAMPLES
+  $ sp config show
+```
+
+_See code: [src/commands/config/show.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/config/show.ts)_
 
-_See code: [src/commands/auth/me.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.1-alpha.42/src/commands/auth/me.ts)_
+## `sp config use`
+
+Switch to a different configuration file
+
+```
+USAGE
+  $ sp config use [--json] [--config <value>] [--url <value>]
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+
+DESCRIPTION
+  Switch to a different configuration file
+
+EXAMPLES
+  $ sp config use
+```
+
+_See code: [src/commands/config/use.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2/src/commands/config/use.ts)_
 
 ## `sp help [COMMAND]`
 
@@ -81,7 +323,7 @@ USAGE
   $ sp help [COMMAND...] [-n]
 
 ARGUMENTS
-  COMMAND...  Command to show help for.
+  [COMMAND...]  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -113,7 +355,7 @@ EXAMPLES
   $ sp plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/index.ts)_
 
 ## `sp plugins add PLUGIN`
 
@@ -187,7 +429,7 @@ EXAMPLES
   $ sp plugins inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/inspect.ts)_
 
 ## `sp plugins install PLUGIN`
 
@@ -236,7 +478,7 @@ EXAMPLES
     $ sp plugins install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/install.ts)_
 
 ## `sp plugins link PATH`
 
@@ -267,7 +509,7 @@ EXAMPLES
   $ sp plugins link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/link.ts)_
 
 ## `sp plugins remove [PLUGIN]`
 
@@ -278,7 +520,7 @@ USAGE
   $ sp plugins remove [PLUGIN...] [-h] [-v]
 
 ARGUMENTS
-  PLUGIN...  plugin to uninstall
+  [PLUGIN...]  plugin to uninstall
 
 FLAGS
   -h, --help     Show CLI help.
@@ -308,7 +550,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/reset.ts)_
 
 ## `sp plugins uninstall [PLUGIN]`
 
@@ -319,7 +561,7 @@ USAGE
   $ sp plugins uninstall [PLUGIN...] [-h] [-v]
 
 ARGUMENTS
-  PLUGIN...  plugin to uninstall
+  [PLUGIN...]  plugin to uninstall
 
 FLAGS
   -h, --help     Show CLI help.
@@ -336,7 +578,7 @@ EXAMPLES
   $ sp plugins uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/uninstall.ts)_
 
 ## `sp plugins unlink [PLUGIN]`
 
@@ -347,7 +589,7 @@ USAGE
   $ sp plugins unlink [PLUGIN...] [-h] [-v]
 
 ARGUMENTS
-  PLUGIN...  plugin to uninstall
+  [PLUGIN...]  plugin to uninstall
 
 FLAGS
   -h, --help     Show CLI help.
@@ -380,52 +622,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/update.ts)_
-
-## `sp refresh`
-
-```
-USAGE
-  $ sp refresh
-```
-
-_See code: [src/commands/refresh.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.1-alpha.42/src/commands/refresh.ts)_
-
-## `sp update [CHANNEL]`
-
-update the sp CLI
-
-```
-USAGE
-  $ sp update [CHANNEL] [--force |  | [-a | -v <value> | -i]] [-b ]
-
-FLAGS
-  -a, --available        See available versions.
-  -b, --verbose          Show more details about the available versions.
-  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
-  -v, --version=<value>  Install a specific version.
-      --force            Force a re-download of the requested version.
-
-DESCRIPTION
-  update the sp CLI
-
-EXAMPLES
-  Update to the stable channel:
-
-    $ sp update stable
-
-  Update to a specific version:
-
-    $ sp update --version 1.0.0
-
-  Interactively select version:
-
-    $ sp update --interactive
-
-  See available versions:
-
-    $ sp update --available
-```
-
-_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.7.11/src/commands/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

package/bin/dev.cmd

@@ -1,3 +1,3 @@
 @echo off
 
-node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*
+node --import tsx "%~dp0\dev" %*

package/bin/dev.js

@@ -1,5 +1,7 @@
-#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
-
+#!/usr/bin/env -S node --import tsx
 import { execute } from '@oclif/core';
 
-await execute({ development: true, dir: import.meta.url });
+await execute({
+  development: true,
+  dir: import.meta.url,
+});

package/bin/run.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
-
 import { execute } from '@oclif/core';
 
-await execute({ dir: import.meta.url });
+await execute({
+  dir: import.meta.url,
+});

package/dist/commands/auth/login.d.ts

@@ -1,5 +1,5 @@
-import { SpCommand } from '../../interfaces/index.js';
-export default class SpLogin extends SpCommand {
+import { BaseCommand } from '../base.js';
+export default class SpLogin extends BaseCommand<typeof SpLogin> {
     static description: string;
     static examples: string[];
     getTokens(nonce: string): Promise<void>;
@@ -12,5 +12,6 @@ export default class SpLogin extends SpCommand {
             nonce?: string;
         } | undefined;
     }>;
+    init(): Promise<void>;
     run(): Promise<void>;
 }

package/dist/commands/auth/login.js

@@ -1,45 +1,66 @@
 import { ux } from '@oclif/core';
-import { SpCommand } from '../../interfaces/index.js';
-export default class SpLogin extends SpCommand {
+import { BaseCommand } from '../base.js';
+export default class SpLogin extends BaseCommand {
     static description = 'Authorization';
     static examples = [
         `<%= config.bin %> <%= command.id %>
 `,
     ];
     async getTokens(nonce) {
-        const signature = await this.accountManager.createSign(nonce);
-        const { data: tokenResponse, error, } = await this.providerClient.POST('/api/auth/token', {
+        const { accountManager, configManager, providerClient } = this.container;
+        const signature = await accountManager.createSign(nonce);
+        const { data: tokenResponse, error, } = await providerClient.POST('/api/auth/token', {
             body: {
-                address: this.accountManager.getAddress(),
+                address: accountManager.getAddress(),
                 provider: 'sp-cli',
                 signature,
             },
         });
         if (error) {
-            ux.stderr(error.message);
-            return;
+            this.logger.error({ err: error }, 'Token exchange failed');
+            ux.error('Authorization failed please try again later.');
         }
-        const { accessToken } = tokenResponse;
-        await this.authManager.setCredentials({ accessKey: accessToken });
-        ux.stdout('Authorization successful');
+        const { accessToken } = tokenResponse || {};
+        if (!accessToken) {
+            this.logger.error({ response: tokenResponse }, 'Unexpected token response');
+            ux.error('Provider returned an unexpected token response.');
+        }
+        await configManager.setCredentials({ accessKey: accessToken });
+        this.log('Authorization successful');
     }
     async getUserNonce(address) {
-        const { data, error } = await this.providerClient.GET('/api/users/nonce/{address}', {
-            params: {
-                path: {
-                    address,
+        const { providerClient } = this.container;
+        try {
+            const { data, error } = await providerClient.GET('/api/users/nonce/{address}', {
+                params: {
+                    path: {
+                        address,
+                    },
                 },
-            },
-        });
-        this.logger.debug({ data, error }, 'Getting user nonce');
-        return { error, user: data };
+            });
+            this.logger.debug({ data, error }, 'Getting user nonce');
+            return { error, user: data };
+        }
+        catch (error) {
+            this.logger.error({ err: error }, 'Error request nonce');
+            ux.error('Connection failure, please try again later');
+        }
+    }
+    async init() {
+        await super.init();
+        await this.container
+            .initConfigManager()
+            .initAccountManager()
+            .initProviderClient({ enableAuth: false })
+            .build();
     }
     async run() {
-        const address = this.accountManager.getAddress();
+        const { accountManager, providerClient } = this.container;
+        const address = accountManager.getAddress();
         const { error: nonceError, user } = await this.getUserNonce(address);
         if (nonceError && nonceError.statusCode === 404) {
             this.logger.debug('Nonce error call sign up');
-            const { data: nonceResponse, error: signUpError } = await this.providerClient.POST('/api/auth/sign-up', {
+            const { data: nonceResponse, error: signUpError } = await providerClient.POST('/api/auth/sign-up', {
                 body: {
                     address,
                 },
@@ -51,11 +72,18 @@ export default class SpLogin extends SpCommand {
                 if (user && user.nonce)
                     await this.getTokens(user.nonce);
                 else
-                    throw new Error('Cannot complete login');
+                    ux.error('User exists but nonce is unavailable. Please try again or contact support.');
+            }
+            else if (signUpError) {
+                this.logger.error({ signUpError }, 'Sign-up failed');
+                ux.error('Sign-up failed. Please try again later.');
             }
             else {
-                // TODO: fix this changeset on @super-protocol/provider-client side
-                const { nonce } = nonceResponse;
+                const nonce = nonceResponse?.nonce;
+                if (!nonce) {
+                    this.logger.error({ response: nonceResponse }, 'Unexpected sign-up response');
+                    ux.error('Provider did not return a nonce.');
+                }
                 await this.getTokens(nonce);
             }
         }
@@ -64,7 +92,7 @@ export default class SpLogin extends SpCommand {
             await this.getTokens(user.nonce);
         }
         else {
-            ux.error('Something went wrong');
+            ux.error('Unable to retrieve authentication nonce. Please try again later or contact support if the issue persists.');
         }
     }
 }

package/dist/commands/auth/me.d.ts

@@ -1,4 +1,5 @@
-import { SpCommand } from '../../interfaces/abstract.command.js';
-export default class Me extends SpCommand {
+import { BaseCommand } from '../base.js';
+export default class Me extends BaseCommand<typeof Me> {
+    init(): Promise<void>;
     run(): Promise<void>;
 }

package/dist/commands/auth/me.js

@@ -1,11 +1,16 @@
-import { SpCommand } from '../../interfaces/abstract.command.js';
-export default class Me extends SpCommand {
+import { BaseCommand } from '../base.js';
+export default class Me extends BaseCommand {
+    async init() {
+        await super.init();
+        await this.container.initProviderClient().build();
+    }
     async run() {
-        const { data, error } = await this.providerClient.GET('/api/auth/me');
+        const { providerClient } = this.container;
+        const { data, error } = await providerClient.GET('/api/auth/me');
         if (error) {
             this.error(error.message);
         }
-        this.log('Requested me ');
+        this.log('Requested me');
         this.logJson(data);
     }
 }

package/dist/commands/base.d.ts

@@ -0,0 +1,18 @@
+import { Command, Config, Interfaces } from '@oclif/core';
+import pino from 'pino';
+import { AppContainer } from '../lib/container.js';
+export type CommandFlags<T extends typeof Command> = Interfaces.InferredFlags<T['flags'] & typeof BaseCommand['baseFlags']>;
+export type CommandArgs<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+export declare abstract class BaseCommand<T extends typeof Command> extends Command {
+    static baseFlags: {
+        config: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+        url: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+    };
+    static enableJsonFlag: boolean;
+    protected args: CommandArgs<T>;
+    protected container: AppContainer;
+    protected flags: CommandFlags<T>;
+    protected logger: pino.BaseLogger;
+    constructor(argv: string[], config: Config);
+    init(): Promise<void>;
+}