@super-protocol/sp-cli 0.0.2-alpha.1 → 0.0.2-beta.1

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.2-alpha.1 linux-x64 node-v22.21.1
+@super-protocol/sp-cli/0.0.2-beta.1 linux-x64 node-v22.21.1
 $ sp --help [COMMAND]
 USAGE
   $ sp COMMAND
@@ -52,6 +52,10 @@ USAGE
 * [`sp plugins uninstall [PLUGIN]`](#sp-plugins-uninstall-plugin)
 * [`sp plugins unlink [PLUGIN]`](#sp-plugins-unlink-plugin)
 * [`sp plugins update`](#sp-plugins-update)
+* [`sp storage base`](#sp-storage-base)
+* [`sp storage create`](#sp-storage-create)
+* [`sp storage select`](#sp-storage-select)
+* [`sp storage update`](#sp-storage-update)
 
 ## `sp auth login`
 
@@ -73,7 +77,7 @@ EXAMPLES
   $ sp auth login
 ```
 
-_See code: [src/commands/auth/login.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-alpha.1/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/auth/login.ts)_
 
 ## `sp auth me`
 
@@ -87,7 +91,7 @@ GLOBAL FLAGS
   --url=<value>     Specify provider base URL.
 ```
 
-_See code: [src/commands/auth/me.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-alpha.1/src/commands/auth/me.ts)_
+_See code: [src/commands/auth/me.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/auth/me.ts)_
 
 ## `sp base`
 
@@ -101,7 +105,7 @@ GLOBAL FLAGS
   --url=<value>     Specify provider base URL.
 ```
 
-_See code: [src/commands/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-alpha.1/src/commands/base.ts)_
+_See code: [src/commands/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/base.ts)_
 
 ## `sp config`
 
@@ -133,7 +137,7 @@ EXAMPLES
   $ sp config delete - Delete a configuration
 ```
 
-_See code: [src/commands/config/index.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-alpha.1/src/commands/config/index.ts)_
+_See code: [src/commands/config/index.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/config/index.ts)_
 
 ## `sp config add [FILE]`
 
@@ -174,7 +178,7 @@ EXAMPLES
     }
 ```
 
-_See code: [src/commands/config/add.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-alpha.1/src/commands/config/add.ts)_
+_See code: [src/commands/config/add.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/config/add.ts)_
 
 ## `sp config base`
 
@@ -188,7 +192,7 @@ GLOBAL FLAGS
   --url=<value>     Specify provider base URL.
 ```
 
-_See code: [src/commands/config/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-alpha.1/src/commands/config/base.ts)_
+_See code: [src/commands/config/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/config/base.ts)_
 
 ## `sp config create`
 
@@ -216,7 +220,7 @@ EXAMPLES
   $ 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-alpha.1/src/commands/config/create.ts)_
+_See code: [src/commands/config/create.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/config/create.ts)_
 
 ## `sp config delete`
 
@@ -246,7 +250,7 @@ EXAMPLES
   $ 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-alpha.1/src/commands/config/delete.ts)_
+_See code: [src/commands/config/delete.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/config/delete.ts)_
 
 ## `sp config list`
 
@@ -268,7 +272,7 @@ EXAMPLES
   $ sp config list
 ```
 
-_See code: [src/commands/config/list.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-alpha.1/src/commands/config/list.ts)_
+_See code: [src/commands/config/list.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/config/list.ts)_
 
 ## `sp config show`
 
@@ -290,7 +294,7 @@ EXAMPLES
   $ sp config show
 ```
 
-_See code: [src/commands/config/show.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-alpha.1/src/commands/config/show.ts)_
+_See code: [src/commands/config/show.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/config/show.ts)_
 
 ## `sp config use`
 
@@ -312,7 +316,7 @@ EXAMPLES
   $ sp config use
 ```
 
-_See code: [src/commands/config/use.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-alpha.1/src/commands/config/use.ts)_
+_See code: [src/commands/config/use.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/config/use.ts)_
 
 ## `sp help [COMMAND]`
 
@@ -623,4 +627,103 @@ DESCRIPTION
 ```
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/update.ts)_
+
+## `sp storage base`
+
+```
+USAGE
+  $ sp storage 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/storage/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/storage/base.ts)_
+
+## `sp storage create`
+
+Create a new storage entry from file or interactive prompts.
+
+```
+USAGE
+  $ sp storage create [--json] [--config <value>] [--url <value>] [-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.
+  --url=<value>     Specify provider base URL.
+
+DESCRIPTION
+  Create a new storage entry from file or interactive prompts.
+
+EXAMPLES
+  $ sp storage create
+
+  $ sp storage create --fromFile ./storage.json
+
+  $ sp storage create --not-default
+```
+
+_See code: [src/commands/storage/create.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/storage/create.ts)_
+
+## `sp storage select`
+
+Select a storage that will be used by subsequent commands.
+
+```
+USAGE
+  $ sp storage select [--json] [--config <value>] [--url <value>] [-i <value>]
+
+FLAGS
+  -i, --id=<value>  Storage ID to select
+
+GLOBAL FLAGS
+  --config=<value>  Specify config file.
+  --json            Format output as json.
+  --url=<value>     Specify provider base URL.
+
+DESCRIPTION
+  Select a storage that will be used by subsequent commands.
+
+EXAMPLES
+  $ sp storage select
+
+  $ sp storage select --id=2de3e3a4-0000-1111-2222-333344445555
+```
+
+_See code: [src/commands/storage/select.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.1/src/commands/storage/select.ts)_
+
+## `sp storage update`
+
+Update the configuration of an existing storage.
+
+```
+USAGE
+  $ sp storage update [--json] [--config <value>] [--url <value>] [-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.
+  --url=<value>     Specify provider base URL.
+
+DESCRIPTION
+  Update the configuration of an existing storage.
+
+EXAMPLES
+  $ sp storage update --id=2de3e3a4-0000-1111-2222-333344445555 --fromFile ./storage-update.json
+
+  $ 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.2-beta.1/src/commands/storage/update.ts)_
 <!-- commandsstop -->

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

@@ -2,6 +2,7 @@ import { BaseCommand } from '../base.js';
 export default class SpLogin extends BaseCommand<typeof SpLogin> {
     static description: string;
     static examples: string[];
+    checkStorage(): Promise<void>;
     getTokens(nonce: string): Promise<void>;
     getUserNonce(address: string): Promise<{
         error: {

package/dist/commands/auth/login.js

@@ -1,4 +1,5 @@
 import { ux } from '@oclif/core';
+import { StorageService } from '../../services/storage.service.js';
 import { BaseCommand } from '../base.js';
 export default class SpLogin extends BaseCommand {
     static description = 'Authorization';
@@ -6,6 +7,17 @@ export default class SpLogin extends BaseCommand {
         `<%= config.bin %> <%= command.id %>
 `,
     ];
+    async checkStorage() {
+        await this.container.initProviderClient({ enableAuth: true, enableCookies: true, rebuild: true }).build();
+        const { configManager, providerClient } = this.container;
+        const storageService = new StorageService(configManager, providerClient, this.logger);
+        if (!await storageService.hasStorage()) {
+            this.logger.info('Requesting default storage');
+            const storage = await storageService.initStorage();
+            this.logger.info({ storage }, 'Requested new storage');
+            await storageService.saveStorage(storage.id);
+        }
+    }
     async getTokens(nonce) {
         const { accountManager, configManager, providerClient } = this.container;
         const signature = await accountManager.createSign(nonce);
@@ -94,5 +106,12 @@ export default class SpLogin extends BaseCommand {
         else {
             ux.error('Unable to retrieve authentication nonce. Please try again later or contact support if the issue persists.');
         }
+        try {
+            await this.checkStorage();
+        }
+        catch (error) {
+            this.logger.error({ err: error }, 'Storage initialization failed');
+            this.warn('Storage initialization failed. You can set up storage later using "sp storage create" or "sp storage select".');
+        }
     }
 }

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

@@ -0,0 +1,8 @@
+import { Command } from '@oclif/core';
+import { BaseCommand } from '../../commands/base.js';
+import { StorageService } from '../../services/storage.service.js';
+export declare abstract class BaseStorageCommand<T extends typeof Command> extends BaseCommand<T> {
+    protected currentDir: string;
+    protected storageService: StorageService;
+    init(): Promise<void>;
+}

package/dist/commands/storage/base.js

@@ -0,0 +1,12 @@
+import { BaseCommand } from '../../commands/base.js';
+import { StorageService } from '../../services/storage.service.js';
+export class BaseStorageCommand extends BaseCommand {
+    currentDir = process.cwd();
+    storageService;
+    async init() {
+        await super.init();
+        await this.container.initConfigManager().initProviderClient().build();
+        const { configManager, providerClient } = this.container;
+        this.storageService = new StorageService(configManager, providerClient, this.logger);
+    }
+}

package/dist/commands/storage/create.d.ts

@@ -0,0 +1,15 @@
+import { BaseStorageCommand } from './base.js';
+export default class StorageCreate extends BaseStorageCommand<typeof StorageCreate> {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        fromFile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        notDefault: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private loadStorageFromFile;
+    private promptS3Credentials;
+    private promptStoragePayload;
+    private promptStorJCredentials;
+    private validateStoragePayload;
+}

package/dist/commands/storage/create.js

@@ -0,0 +1,169 @@
+import { input, password, select } from '@inquirer/prompts';
+import { Flags } from '@oclif/core';
+import { StorageType } from '@super-protocol/provider-client';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { BaseStorageCommand } from './base.js';
+export default class StorageCreate extends BaseStorageCommand {
+    static description = 'Create a new storage entry from file or interactive prompts.';
+    static examples = [
+        '<%= config.bin %> storage create',
+        '<%= config.bin %> storage create --fromFile ./storage.json',
+        '<%= config.bin %> storage create --not-default',
+    ];
+    static flags = {
+        fromFile: Flags.string({
+            aliases: ['fromFile'],
+            char: 'f',
+            description: 'Path to a JSON file that contains AddStorageDto payload.',
+        }),
+        notDefault: Flags.boolean({
+            description: 'Skip setting the created storage as default.',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(StorageCreate);
+        const payload = flags.fromFile
+            ? await this.loadStorageFromFile(flags.fromFile)
+            : await this.promptStoragePayload();
+        try {
+            const storage = await this.storageService.createStorage(payload);
+            this.log(`Storage created: ${storage.id}`);
+            if (!flags.notDefault) {
+                await this.storageService.saveStorage(storage.id);
+                this.log('Storage set as default');
+            }
+        }
+        catch (error) {
+            this.error(error instanceof Error ? error.message : String(error));
+        }
+    }
+    async loadStorageFromFile(filePath) {
+        const absolutePath = path.isAbsolute(filePath)
+            ? filePath
+            : path.join(this.currentDir, filePath);
+        try {
+            const fileContent = await fs.readFile(absolutePath, 'utf8');
+            const parsed = JSON.parse(fileContent);
+            this.validateStoragePayload(parsed);
+            return parsed;
+        }
+        catch (error) {
+            this.error(`Failed to load storage definition: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    async promptS3Credentials() {
+        const region = await input({
+            message: 'AWS region',
+            validate(value) {
+                return value ? true : 'Region is required';
+            },
+        }).then(value => value.trim());
+        const readAccessKeyId = await input({
+            message: 'Read access key ID',
+            validate(value) {
+                return value ? true : 'Read access key ID is required';
+            },
+        }).then(value => value.trim());
+        const readSecretAccessKey = await password({
+            message: 'Read secret access key',
+            validate(value) {
+                return value ? true : 'Read secret access key is required';
+            },
+        }).then(value => value.trim());
+        const writeAccessKeyId = await input({
+            message: 'Write access key ID',
+            validate(value) {
+                return value ? true : 'Write access key ID is required';
+            },
+        }).then(value => value.trim());
+        const writeSecretAccessKey = await password({
+            message: 'Write secret access key',
+            validate(value) {
+                return value ? true : 'Write secret access key is required';
+            },
+        }).then(value => value.trim());
+        return {
+            readAccessKeyId,
+            readSecretAccessKey,
+            region,
+            writeAccessKeyId,
+            writeSecretAccessKey,
+        };
+    }
+    async promptStoragePayload() {
+        const storageType = await select({
+            choices: [
+                { name: 'Amazon S3', value: StorageType.S3 },
+                { name: 'StorJ', value: StorageType.StorJ },
+            ],
+            message: 'Select storage type',
+        });
+        const bucket = await input({
+            message: 'Bucket name',
+            validate(value) {
+                return value ? true : 'Bucket is required';
+            },
+        }).then(value => value.trim());
+        const prefix = await input({
+            default: '/',
+            message: 'Prefix',
+            validate(value) {
+                return value ? true : 'Prefix is required';
+            },
+        }).then(value => value.trim());
+        const storage = {
+            bucket,
+            prefix,
+            storageType,
+        };
+        if (storageType === StorageType.S3) {
+            storage.s3Credentials = await this.promptS3Credentials();
+        }
+        if (storageType === StorageType.StorJ) {
+            storage.storjCredentials = await this.promptStorJCredentials();
+        }
+        return storage;
+    }
+    async promptStorJCredentials() {
+        const readAccessToken = await password({
+            message: 'Read access token',
+            validate(value) {
+                return value ? true : 'Read access token is required';
+            },
+        }).then(value => value.trim());
+        const writeAccessToken = await password({
+            message: 'Write access token',
+            validate(value) {
+                return value ? true : 'Write access token is required';
+            },
+        }).then(value => value.trim());
+        return {
+            readAccessToken,
+            writeAccessToken,
+        };
+    }
+    validateStoragePayload(payload) {
+        if (!payload || typeof payload !== 'object') {
+            this.error('Storage definition must be an object');
+        }
+        if (!payload.bucket) {
+            this.error('Storage definition missing "bucket"');
+        }
+        if (!payload.prefix) {
+            this.error('Storage definition missing "prefix"');
+        }
+        if (!payload.storageType) {
+            this.error('Storage definition missing "storageType"');
+        }
+        if (!Object.values(StorageType).includes(payload.storageType)) {
+            this.error(`Unsupported storage type: ${payload.storageType}`);
+        }
+        if (payload.storageType === StorageType.S3 && !payload.s3Credentials) {
+            this.error('S3 storage requires "s3Credentials"');
+        }
+        if (payload.storageType === StorageType.StorJ && !payload.storjCredentials) {
+            this.error('StorJ storage requires "storjCredentials"');
+        }
+    }
+}

package/dist/commands/storage/select.d.ts

@@ -0,0 +1,9 @@
+import { BaseStorageCommand } from './base.js';
+export default class StorageSelect extends BaseStorageCommand<typeof StorageSelect> {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/storage/select.js

@@ -0,0 +1,44 @@
+import { select } from '@inquirer/prompts';
+import { Flags } from '@oclif/core';
+import { StoragesEmptyError } from '../../services/storage.service.js';
+import { BaseStorageCommand } from './base.js';
+export default class StorageSelect extends BaseStorageCommand {
+    static description = 'Select a storage that will be used by subsequent commands.';
+    static examples = [
+        '<%= config.bin %> storage select',
+        '<%= config.bin %> storage select --id=2de3e3a4-0000-1111-2222-333344445555',
+    ];
+    static flags = {
+        id: Flags.string({
+            char: 'i',
+            description: 'Storage ID to select',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(StorageSelect);
+        try {
+            let storageId = flags.id;
+            if (!storageId) {
+                const storages = await this.storageService.requestStorage();
+                storageId = await select({
+                    choices: storages.map(storage => ({
+                        name: `${storage.id} (${storage.storageType}) ${storage.bucket}/${storage.prefix} `,
+                        value: storage.id,
+                    })),
+                    message: 'Select storage',
+                });
+            }
+            if (!storageId) {
+                this.error('Storage ID is required');
+            }
+            await this.storageService.saveStorage(storageId);
+            this.log(`Selected storage: ${storageId}`);
+        }
+        catch (error) {
+            if (error instanceof StoragesEmptyError) {
+                this.error('No storages available. Run "sp storage create" first.');
+            }
+            this.error(error instanceof Error ? error.message : String(error));
+        }
+    }
+}

package/dist/commands/storage/update.d.ts

@@ -0,0 +1,16 @@
+import { BaseStorageCommand } from './base.js';
+export default class StorageUpdate extends BaseStorageCommand<typeof StorageUpdate> {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        fromFile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+    private ensureNonEmptyString;
+    private ensureUpdatePayload;
+    private loadStorageFromFile;
+    private promptS3Credentials;
+    private promptStorageUpdate;
+    private promptStorJCredentials;
+}