rustore 1.0.1 → 1.0.3

package/README.en.md

@@ -0,0 +1,331 @@
+<div align="center">
+  <img src="assets/icon.png" alt="rustore CLI" width="128" height="128">
+  <h1>rustore<br>CLI for RuStore API</h1>
+  <p>Command-line interface for interacting with RuStore API</p>
+  <p>
+    <a href="README.en.md">English</a> | <a href="README.md">Русский</a>
+  </p>
+</div>
+
+[![NPM version][npm-image]][npm-url]
+![npm-typescript]
+[![License][github-license]][github-license-url]
+
+## 🌟 Features
+
+- 🔐 Authentication via private key from RuStore Console
+- 🔑 Automatic access token management
+- 📦 Work with RuStore API (payments, subscriptions, applications)
+- 📄 JSON output format (`--json`) for convenient integration and processing
+- ⚙️ Configuration saved in `~/.rustore/config.json`
+- 🧪 Full test coverage
+
+## 🛠️ Installation
+
+### Global Installation
+
+```sh
+npm install -g rustore
+```
+
+After installation, use the command:
+
+```sh
+rustore --help
+```
+
+### Using via npx (without installation)
+
+You can use the CLI without installation via `npx`:
+
+```sh
+npx rustore --help
+npx rustore login --key-id <keyId> --key <privateKey>
+npx rustore apps list
+```
+
+### Local Installation
+
+```sh
+npm install rustore
+```
+
+## 📖 Usage
+
+### Initial Setup
+
+Before using the CLI, you need to obtain a private key from [RuStore Console](https://console.rustore.ru/sign-in).
+
+### Authentication
+
+```sh
+# Authentication with keyId and private key
+rustore login --key-id <keyId> --key <base64-key>
+
+# Or short form
+rustore login -i <keyId> -k <base64-key>
+```
+
+**Example:**
+
+```sh
+rustore login --key-id 123456 --key MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQC...
+```
+
+### Check Status
+
+```sh
+# Show information about current authentication
+rustore whoami
+```
+
+### Logout
+
+```sh
+# Remove token (keys remain in config)
+rustore logout
+```
+
+### Working with Applications
+
+```sh
+# Get list of applications
+rustore apps list
+
+# Get all applications (with pagination)
+rustore apps list --all
+
+# Output result in JSON format (convenient for scripts and integrations)
+rustore apps list --json
+
+# Combining options: get all applications in JSON format
+rustore apps list --all --json
+
+# Filtering with JSON output
+rustore apps list --app-name "MyApp" --json
+rustore apps list --app-status PUBLISHED --json
+
+# Create draft version of application
+rustore apps create-draft --app-id 123456 --version-name "1.0.0" --version-code 1
+
+# Create draft version with JSON output
+rustore apps create-draft --app-id 123456 --version-name "2.0.0" --version-code 2 --json
+
+# Upload APK file for version (is-main-apk is required)
+rustore apps upload-apk --package-name com.example.app --version-id 789 --file ./app-release.apk --is-main-apk true
+
+# Upload APK file with Huawei Mobile Services
+rustore apps upload-apk --package-name com.example.app --version-id 789 --file ./app-release.apk --is-main-apk false --services-type HMS
+
+# Upload APK file with JSON output
+rustore apps upload-apk --package-name com.example.app --version-id 789 --file ./app-release.apk --is-main-apk true --json
+```
+
+### Working with Feedback
+
+```sh
+# Get application feedback
+rustore feedback list --package-name com.example.app
+
+# Get all feedback (with pagination)
+rustore feedback list --package-name com.example.app --all
+
+# Get feedback in JSON format
+rustore feedback list --package-name com.example.app --json
+
+# Leave a response to feedback
+rustore feedback answer --package-name com.example.app --comment-id 123456 --text "Thank you for your feedback!"
+
+# Get feedback response status
+rustore feedback status --package-name com.example.app --feedback-id 789
+
+# Get all feedback responses
+rustore feedback status --package-name com.example.app
+
+# Update feedback response
+rustore feedback update --package-name com.example.app --feedback-id 789 --text "Updated response"
+
+# Delete feedback response
+rustore feedback delete --package-name com.example.app --feedback-id 789
+```
+
+**💡 Tip:** The `--json` flag is useful for:
+
+- Automation and scripts
+- Integration with other tools
+- Data processing via `jq` or other JSON parsers
+- Saving results to file: `rustore apps list --json > apps.json`
+
+## 📁 Configuration
+
+The CLI saves configuration in `~/.rustore/config.json`:
+
+```json
+{
+  "keyId": "your-key-id",
+  "privateKey": "your-private-key-base64",
+  "token": "jwe-token",
+  "tokenExpiresAt": 1234567890
+}
+```
+
+## 🔧 Development
+
+### Installing Dependencies
+
+```sh
+npm install
+```
+
+### Building
+
+```sh
+npm run build
+```
+
+### Running in Development Mode
+
+```sh
+npm start
+```
+
+### Testing
+
+```sh
+# Run all tests
+npm test
+
+# Tests in watch mode
+npm run test:watch
+
+# With coverage
+npm run test:coverage
+```
+
+#### How to Test Current Changes
+
+1. **Build the project:**
+
+   ```sh
+   npm run build
+   ```
+
+2. **Type checking:**
+
+   ```sh
+   npm run type-check
+   # or
+   ./node_modules/.bin/tsc --noEmit
+   ```
+
+3. **Run tests:**
+
+   ```sh
+   npm test
+   ```
+
+4. **Test CLI locally:**
+
+   ```sh
+   # Run without installation (via tsx)
+   npm start -- login <keyId> --key <key>
+
+   # Or after build
+   node dist/bin.js whoami
+   ```
+
+5. **Linting:**
+   ```sh
+   npm run lint
+   npm run lint:fix
+   ```
+
+### Type Checking
+
+```sh
+npm run type-check
+```
+
+### Linting
+
+```sh
+npm run lint
+npm run lint:fix
+```
+
+## 📚 API
+
+### API Structure
+
+The API is organized by categories, as in RuStore documentation:
+
+- **Apps API** (`appsApi`) - Application upload and publication (general methods)
+- **Payments API** (`paymentsApi`) - Working with payments and subscriptions (general methods)
+- **Payments App API** (`paymentsAppApi`) - Working with payments and subscriptions (application methods)
+- **Catalog API** (`catalogApi`) - Product catalog API
+- **Feedback API** (`feedbackApi`) - Working with application feedback
+
+### Programmatic Access
+
+```typescript
+import {login, appsApi, paymentsApi, catalogApi, feedbackApi} from 'rustore';
+
+// Authentication
+await login('keyId', 'privateKey');
+
+// Get list of applications
+const appsResponse = await appsApi.getAppList();
+console.log(appsResponse.body.content);
+
+// Get all applications (with automatic pagination)
+const allApps = await appsApi.getAllApps();
+
+// Create draft version of application
+const draftVersion = await appsApi.createDraftVersion(123456, {
+  versionName: '1.0.0',
+  versionCode: 1,
+});
+
+// Upload APK file for version
+const uploadResult = await appsApi.uploadApkFile(
+  'com.example.app', // packageName instead of appId
+  draftVersion.body?.versionId || 789,
+  './app-release.apk',
+  {
+    isMainApk: true, // required parameter
+    servicesType: 'Unknown', // optional: 'HMS' or 'Unknown'
+  },
+);
+
+// Get application feedback
+const feedbackResponse = await feedbackApi.getFeedback('com.example.app');
+
+// Leave a response to feedback
+const answerResponse = await feedbackApi.createFeedbackAnswer('com.example.app', 123456, {
+  text: 'Thank you for your feedback!',
+});
+
+// Get feedback response status
+const statusResponse = await feedbackApi.getFeedbackAnswerStatus('com.example.app', 789);
+
+// Using other API categories
+// await paymentsApi.refund(...);
+// await catalogApi.getProducts(...);
+```
+
+## 🔗 Useful Links
+
+- [RuStore API Documentation](https://www.rustore.ru/help/en/work-with-rustore-api)
+- [Authorization Process](https://www.rustore.ru/help/work-with-rustore-api/api-authorization-token)
+- [RuStore Console](https://console.rustore.ru/sign-in)
+
+## 📝 License
+
+MIT
+
+[package-name]: rustore
+[npm-url]: https://www.npmjs.com/package/rustore
+[npm-image]: https://img.shields.io/npm/v/rustore
+[github-license]: https://img.shields.io/github/license/romankurnovskii/rustore
+[github-license-url]: https://github.com/romankurnovskii/rustore/blob/main/LICENSE
+[npm-typescript]: https://img.shields.io/npm/types/rustore

package/README.md

@@ -1,8 +1,11 @@
-<h1 align="center">rustore<br>CLI для работы с RuStore API</h1>
-
-<p align="center">
-  Командная строка для взаимодействия с RuStore API, похожая на Expo CLI
-</p>
+<div align="center">
+  <img src="assets/icon.png" alt="rustore CLI" width="128" height="128">
+  <h1>rustore<br>CLI для работы с RuStore API</h1>
+  <p>Командная строка для взаимодействия с RuStore API</p>
+  <p>
+    <a href="README.en.md">English</a> | <a href="README.md">Русский</a>
+  </p>
+</div>
 
 [![NPM version][npm-image]][npm-url]
 ![npm-typescript]
@@ -13,16 +16,35 @@
 - 🔐 Авторизация через приватный ключ из RuStore Консоль
 - 🔑 Автоматическое управление токенами доступа
 - 📦 Работа с API RuStore (платежи, подписки, приложения)
+- 📄 Вывод результатов в формате JSON (`--json`) для удобной интеграции и обработки
 - ⚙️ Сохранение конфигурации в `~/.rustore/config.json`
 - 🧪 Полное покрытие тестами
 
 ## 🛠️ Установка
 
+### Глобальная установка
+
 ```sh
 npm install -g rustore
 ```
 
-или локально:
+После установки используйте команду:
+
+```sh
+rustore --help
+```
+
+### Использование через npx (без установки)
+
+Вы можете использовать CLI без установки через `npx`:
+
+```sh
+npx rustore --help
+npx rustore login --key-id <keyId> --key <privateKey>
+npx rustore apps list
+```
+
+### Локальная установка
 
 ```sh
 npm install rustore
@@ -73,10 +95,67 @@ rustore apps list
 # Получить все приложения (с пагинацией)
 rustore apps list --all
 
-# Вывести результат в формате JSON
+# Вывести результат в формате JSON (удобно для скриптов и интеграций)
 rustore apps list --json
+
+# Комбинирование опций: получить все приложения в JSON формате
+rustore apps list --all --json
+
+# Фильтрация с JSON выводом
+rustore apps list --app-name "MyApp" --json
+rustore apps list --app-status PUBLISHED --json
+
+# Создать черновую версию приложения
+rustore apps create-draft --app-id 123456 --version-name "1.0.0" --version-code 1
+
+# Создать черновую версию с JSON выводом
+rustore apps create-draft --app-id 123456 --version-name "2.0.0" --version-code 2 --json
+
+# Загрузить APK файл для версии (обязательно указать is-main-apk)
+rustore apps upload-apk --package-name com.example.app --version-id 789 --file ./app-release.apk --is-main-apk true
+
+# Загрузить APK файл с Huawei Mobile Services
+rustore apps upload-apk --package-name com.example.app --version-id 789 --file ./app-release.apk --is-main-apk false --services-type HMS
+
+# Загрузить APK файл с JSON выводом
+rustore apps upload-apk --package-name com.example.app --version-id 789 --file ./app-release.apk --is-main-apk true --json
+```
+
+### Работа с отзывами
+
+```sh
+# Получить отзывы приложения
+rustore feedback list --package-name com.example.app
+
+# Получить все отзывы (с пагинацией)
+rustore feedback list --package-name com.example.app --all
+
+# Получить отзывы в JSON формате
+rustore feedback list --package-name com.example.app --json
+
+# Оставить ответ на отзыв
+rustore feedback answer --package-name com.example.app --comment-id 123456 --text "Спасибо за отзыв!"
+
+# Получить статус ответа на отзыв
+rustore feedback status --package-name com.example.app --feedback-id 789
+
+# Получить все ответы на отзывы
+rustore feedback status --package-name com.example.app
+
+# Изменить ответ на отзыв
+rustore feedback update --package-name com.example.app --feedback-id 789 --text "Обновлённый ответ"
+
+# Удалить ответ на отзыв
+rustore feedback delete --package-name com.example.app --feedback-id 789
 ```
 
+**💡 Совет:** Флаг `--json` полезен для:
+
+- Автоматизации и скриптов
+- Интеграции с другими инструментами
+- Обработки данных через `jq` или другие JSON-парсеры
+- Сохранения результатов в файл: `rustore apps list --json > apps.json`
+
 ## 📁 Конфигурация
 
 CLI сохраняет конфигурацию в `~/.rustore/config.json`:
@@ -90,8 +169,6 @@ CLI сохраняет конфигурацию в `~/.rustore/config.json`:
 }
 ```
 
-**Важно:** Приватный ключ хранится в открытом виде. Защитите доступ к файлу конфигурации.
-
 ## 🔧 Разработка
 
 ### Установка зависимостей
@@ -190,7 +267,7 @@ API организовано по категориям, как в докумен
 ### Программный доступ
 
 ```typescript
-import {login, appsApi, paymentsApi, catalogApi} from 'rustore';
+import {login, appsApi, paymentsApi, catalogApi, feedbackApi} from 'rustore';
 
 // Авторизация
 await login('keyId', 'privateKey');
@@ -202,6 +279,34 @@ console.log(appsResponse.body.content);
 // Получить все приложения (с автоматической пагинацией)
 const allApps = await appsApi.getAllApps();
 
+// Создать черновую версию приложения
+const draftVersion = await appsApi.createDraftVersion(123456, {
+  versionName: '1.0.0',
+  versionCode: 1,
+});
+
+// Загрузить APK файл для версии
+const uploadResult = await appsApi.uploadApkFile(
+  'com.example.app', // packageName вместо appId
+  draftVersion.body?.versionId || 789,
+  './app-release.apk',
+  {
+    isMainApk: true, // обязательный параметр
+    servicesType: 'Unknown', // опциональный: 'HMS' или 'Unknown'
+  },
+);
+
+// Получить отзывы приложения
+const feedbackResponse = await feedbackApi.getFeedback('com.example.app');
+
+// Оставить ответ на отзыв
+const answerResponse = await feedbackApi.createFeedbackAnswer('com.example.app', 123456, {
+  text: 'Спасибо за отзыв!',
+});
+
+// Получить статус ответа на отзыв
+const statusResponse = await feedbackApi.getFeedbackAnswerStatus('com.example.app', 789);
+
 // Использование других API категорий
 // await paymentsApi.refund(...);
 // await catalogApi.getProducts(...);

package/dist/api/apps.d.ts

@@ -1,9 +1,11 @@
 /**
  * API для работы с приложениями
  * Категория: Загрузка и публикация приложений (общие методы)
+ *
+ * @see https://www.rustore.ru/help/work-with-rustore-api/api-upload-publication-app
  */
 import { RustoreApiClient } from './client.js';
-import type { GetAppListResponse, App } from '../types.js';
+import type { GetAppListResponse, App, GetAppListOptions, CreateDraftVersionRequest, CreateDraftVersionResponse, UploadApkFileResponse, UploadApkFileOptions } from '../types.js';
 /**
  * Клиент для работы с приложениями
  */
@@ -15,15 +17,54 @@ export declare class AppsApi extends RustoreApiClient {
      * Метод позволяет получить приложения, доступные владельцу аккаунта,
      * для которого создан приватный ключ.
      *
-     * @param continuationToken - Токен для пагинации (опционально)
+     * @param options - Параметры запроса (continuationToken, pageSize, appName и др.)
      * @returns Список приложений
+     *
+     * @see https://www.rustore.ru/help/work-with-rustore-api/api-upload-publication-app/get-app-list
      */
-    getAppList(continuationToken?: string): Promise<GetAppListResponse>;
+    getAppList(options?: GetAppListOptions): Promise<GetAppListResponse>;
     /**
      * Получить все приложения (с автоматической пагинацией)
+     *
+     * Вспомогательный метод, который автоматически обрабатывает пагинацию
+     * и возвращает все приложения из всех страниц.
+     *
+     * @param options - Параметры запроса (pageSize, appName и др., кроме continuationToken)
      * @returns Массив всех приложений
+     *
+     * @see https://www.rustore.ru/help/work-with-rustore-api/api-upload-publication-app/get-app-list
+     */
+    getAllApps(options?: Omit<GetAppListOptions, 'continuationToken'>): Promise<App[]>;
+    /**
+     * Создать черновую версию приложения
+     * POST /public/v1/application/{packageName}/version
+     *
+     * Метод позволяет создать черновик версии и заполнить его основной информацией.
+     * Обязательный параметр: minAndroidVersion (от 1 до 16).
+     *
+     * @param packageName - Наименование пакета приложения (например, com.example.app)
+     * @param data - Данные для создания черновой версии
+     * @returns Информация о созданной черновой версии
+     *
+     * @see https://www.rustore.ru/help/work-with-rustore-api/api-upload-publication-app/create-draft-version
+     */
+    createDraftVersion(packageName: string, data: CreateDraftVersionRequest): Promise<CreateDraftVersionResponse>;
+    /**
+     * Загрузить APK файл для версии приложения
+     * POST /public/v1/application/{packageName}/version/{versionId}/apk
+     *
+     * Метод позволяет загрузить APK файл для версии приложения.
+     * Согласно документации API, endpoint использует packageName, а не appId.
+     *
+     * @param packageName - Имя пакета приложения (например, com.example.app)
+     * @param versionId - ID версии (полученный из createDraftVersion)
+     * @param filePath - Путь к APK файлу
+     * @param options - Параметры загрузки (isMainApk - обязательный, servicesType - опциональный)
+     * @returns Информация о загруженном файле
+     *
+     * @see https://www.rustore.ru/help/work-with-rustore-api/api-upload-publication-app/apk-file-upload/file-upload-apk
      */
-    getAllApps(): Promise<App[]>;
+    uploadApkFile(packageName: string, versionId: number, filePath: string, options: UploadApkFileOptions): Promise<UploadApkFileResponse>;
 }
 /**
  * Экспортируемый экземпляр клиента для работы с приложениями

package/dist/api/apps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apps.d.ts","sourceRoot":"","sources":["../../src/api/apps.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAC,kBAAkB,EAAE,GAAG,EAAC,MAAM,aAAa,CAAC;AAEzD;;GAEG;AACH,qBAAa,OAAQ,SAAQ,gBAAgB;IAC3C;;;;;;;;;OASG;IACG,UAAU,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAoBzE;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;CAanC;AAED;;GAEG;AACH,eAAO,MAAM,OAAO,SAAgB,CAAC"}
+{"version":3,"file":"apps.d.ts","sourceRoot":"","sources":["../../src/api/apps.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,EACV,kBAAkB,EAClB,GAAG,EACH,iBAAiB,EACjB,yBAAyB,EACzB,0BAA0B,EAC1B,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,gBAAgB;IAC3C;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA4B1E;;;;;;;;;;OAUG;IACG,UAAU,CACd,OAAO,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,GACrD,OAAO,CAAC,GAAG,EAAE,CAAC;IAcjB;;;;;;;;;;;;OAYG;IACG,kBAAkB,CACtB,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,0BAA0B,CAAC;IAKtC;;;;;;;;;;;;;;OAcG;IACG,aAAa,CACjB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,qBAAqB,CAAC;CAmFlC;AAED;;GAEG;AACH,eAAO,MAAM,OAAO,SAAgB,CAAC"}