anixapi 0.2.1 → 0.3.1

package/README.md

@@ -2,13 +2,13 @@
 > **Дисклеймер.** Проект создан в **ознакомительных и исследовательских целях**. Автор **не поддерживает и осуждает** использование библиотеки для авторегистрации, спам-ботов, накрутки, обхода ограничений сервиса и любого злоупотребления API Anixart. Вы используете библиотеку **на свой страх и риск** и несёте ответственность за соблюдение правил Anixart и применимого законодательства.
 
 > [!CAUTION]
-> **Миграция с [theDesConnet/AnixartJS](https://github.com/theDesConnet/AnixartJS).** Плавного перехода на AnixApi **не будет**. Изменились структура `src/api`, имена эндпоинтов, типы, обработка ошибок (`AnixApiError`) и покрытие API 9.0 beta 11. При переносе с версии DesConnet закладывайте время на переписывание вызовов, импортов и проверку ответов. Подробности - в [документации](docs/DOCUMENTATION.md).
+> **Миграция с [theDesConnet/AnixartJS](https://github.com/theDesConnet/AnixartJS).** Плавного перехода на AnixApi **не будет**. Изменились структура `src/api`, имена эндпоинтов, типы, обработка ошибок (`AnixApiError`) и покрытие API 9.0. При переносе с версии DesConnet закладывайте время на переписывание вызовов, импортов и проверку ответов. Подробности — в [документации](docs/DOCUMENTATION.md).
 
 <h2 align="center">AnixApi</h2>
 
 <p align="center">
   TypeScript-обёртка над API Anixart 9.x для Node.js.<br>
-  275 эндпоинтов · типизация · доменные классы · обработка ошибок
+  286 эндпоинтов · OAuth (VK / Google / Telegram / Yandex) · типизация · доменные классы
 </p>
 
 <p align="center">
@@ -16,150 +16,119 @@
   <a href="LICENSE">Лицензия GPL-2.0</a>
 </p>
 
----
-
+<p align="center">
+  <code>anixapi@0.3.1</code> · актуально под <strong>Anixart 9.0 BETA 21</strong> (build <code>26080522</code>)
+</p>
 
+---
 
 ## О проекте
 
-
-
-**AnixApi** - неофициальная имплементация REST API приложения [Anixart](https://anixart.ru). Библиотека даёт типизированный доступ к эндпоинтам, высокоуровневые методы (`getReleaseById`, `getProfileById`, …) и классы-обёртки для статей, каналов, релизов и коллекций.
-
-
+**AnixApi** — неофициальная имплементация REST API приложения [Anixart](https://anixart.ru). Библиотека даёт типизированный доступ к эндпоинтам, высокоуровневые методы (`getReleaseById`, `getProfileById`, …) и классы-обёртки для статей, каналов, релизов и коллекций.
 
 ### Форк и оригинал
 
-
-
 Проект развивается на базе **[theDesConnet/AnixartJS](https://github.com/theDesConnet/AnixartJS)** (автор Roman U. / DesConnet, лицензия GPL-2.0).
 
+| | |
+|---|---|
 | **Оригинальный репозиторий** | https://github.com/theDesConnet/AnixartJS |
-
 | **Базовая архитектура API** | DesConnet |
-
-| **Расширения** | полное покрытие API 9.0 beta 11, реструктуризация `src/api`, типы, `AnixApiError`, `typecheck` в сборке |
-
-
+| **Расширения** | покрытие API 9.0 (до beta 21), реструктуризация `src/api`, типы, `AnixApiError`, OAuth-провайдеры, `typecheck` в сборке |
 
 При публикации изменений обязательно сохраняйте указание на оригинальный проект и условия GPL-2.0.
 
-
-
 ---
 
-
-
 ## Быстрый старт
 
-
-
 ```bash
-
 npm install anixapi
-
 ```
 
-
-
 ```javascript
-
 const { Anixart, DefaultResult } = require("anixapi");
 
-
-
 const client = new Anixart();
-
 const code = await client.login("username", "password");
 
-
-
 if (code === DefaultResult.Ok) {
-
     const release = await client.endpoints.release.info(789, true);
-
     console.log(release);
-
 }
-
 ```
 
+### OAuth (VK / Google / Telegram / Yandex)
 
+```javascript
+const { Anixart, DefaultResult, OAuthAuthResult } = require("anixapi");
 
-Подробные примеры, структура API и обработка ошибок - в **[документации](docs/DOCUMENTATION.md)**.
+const client = new Anixart();
 
+// Вход: при code === 3 (NotRegistered) нужно signUpWith*
+const res = await client.endpoints.auth.signInWithYandex({
+    yandexAccessToken: "...",
+});
+
+if (res.code === DefaultResult.Ok && res.profileToken) {
+    client.setToken(res.profileToken.token);
+} else if (res.code === OAuthAuthResult.NotRegistered) {
+    await client.endpoints.auth.signUpWithYandex({
+        login: "newuser",
+        email: res.email || "user@example.com",
+        yandexAccessToken: "...",
+    });
+}
+```
 
+| Провайдер | Sign-in | Поле токена |
+|-----------|---------|-------------|
+| VK | `signInWithVk` | `vkAccessToken` |
+| Google | `signInWithGoogle` | `googleIdToken` |
+| Telegram | `signInWithTelegram` | `telegramIdToken` |
+| Yandex | `signInWithYandex` | `yandexAccessToken` |
 
----
+Флаги доступности: `GET config/urls` → `vk_auth_available`, `google_auth_available`, `telegram_auth_available`, `yandex_auth_available`.
 
+Подробные примеры, структура API и обработка ошибок — в **[документации](docs/DOCUMENTATION.md)**.
 
+---
 
 ## Возможности
 
-
-
-- **275 эндпоинтов** - `client.endpoints.*`
-
-- **TypeScript** - типы запросов, ответов и enum-кодов (`LoginResult`, `CommentAddResult`, …)
-
-- **Доменные классы** - `Article`, `Channel`, `Release`, `FullProfile`, `Collection`
-
-- **Ошибки** - `AnixApiError`, `describeResultCode()`, опция `throwOnApiError`
-
-
+- **286 эндпоинтов** — `client.endpoints.*` (Anixart 9.0 BETA 21)
+- **OAuth** — VK, Google, Telegram, Yandex (sign-in / sign-up / bind / unbind)
+- **TypeScript** — типы запросов, ответов и enum-кодов (`LoginResult`, `OAuthAuthResult`, …)
+- **Доменные классы** — `Article`, `Channel`, `Release`, `FullProfile`, `Collection`
+- **Ошибки** — `AnixApiError`, `describeResultCode()`, опция `throwOnApiError`
 
 ---
 
-
-
 ## TODO
 
-
-
-- [x] Все эндпоинты API (275)
-
-- [x] Типы / схемы / Swagger-документация
-
+- [x] Все эндпоинты API (286, beta 21)
+- [x] OAuth: VK / Google / Telegram / Yandex
+- [x] Типы и документация
 - [x] Классы для коллекций
-
 - [ ] Возможность использовать библиотеку в браузере полностью
 
-
-
 ---
 
-
 ## Проекты на базе библиотеки
 
-
-
-- [AniDesk](https://github.com/theDesConnet/AniDesk) - неофициальный десктоп-клиент Anixart
-
-- [AnixApp](https://github.com/Maks1mio/anixapp) - неофициальное приложение Anixart для ПК
-
-
+- [AniDesk](https://github.com/theDesConnet/AniDesk) — неофициальный десктоп-клиент Anixart
+- [AnixApp](https://github.com/Maks1mio/anixapp) — неофициальное приложение Anixart для ПК
 
 ---
 
-
-
 ## Лицензия
 
-
-
-Проект распространяется под **[GPL-2.0](LICENSE)** - как и [оригинальный AnixartJS](https://github.com/theDesConnet/AnixartJS).
-
-
+Проект распространяется под **[GPL-2.0](LICENSE)** — как и [оригинальный AnixartJS](https://github.com/theDesConnet/AnixartJS).
 
 ---
 
-
-
 ## Связь
 
-
-
-Вопросы и баги - через Issues в [репозитории AnixApi](https://github.com/Maks1mio/AnixApi).  
+Вопросы и баги — через Issues в [репозитории AnixApi](https://github.com/Maks1mio/anixapi).
 
 Оригинальная библиотека: [theDesConnet/AnixartJS](https://github.com/theDesConnet/AnixartJS).
-

package/dist/api/auth.d.ts

@@ -1,11 +1,21 @@
 import { Anixart } from "../client";
-import { IBaseApiParams, ILoginRequest, ILoginResponse, IOAuthGoogleSignInRequest, IOAuthGoogleSignUpRequest, IOAuthVkSignInRequest, IOAuthVkSignUpRequest, IRegisterResponse, IResendRequest, IResponse, IRestoreEmailRequest, IRestoreResendRequest, IRestoreVerifyRequest, ISignUpRequest, ISignUpVerifyRequest } from "../types";
+import { IBaseApiParams, ICheckLoginRequest, ICheckLoginResponse, IGoogleAuthResponse, ILoginRequest, ILoginResponse, IOAuthGoogleSignInRequest, IOAuthGoogleSignUpRequest, IOAuthTelegramSignInRequest, IOAuthTelegramSignUpRequest, IOAuthVkSignInRequest, IOAuthVkSignUpRequest, IOAuthYandexSignInRequest, IOAuthYandexSignUpRequest, IRegisterResponse, IResendRequest, IResponse, IRestoreEmailRequest, IRestoreResendRequest, IRestoreVerifyRequest, ISignUpRequest, ISignUpVerifyRequest, ITelegramAuthResponse, IVkAuthResponse, IYandexAuthResponse } from "../types";
 /**
  * Класс с эндпоинтами авторизации
  */
 export declare class Auth {
     private readonly client;
     constructor(client: Anixart);
+    /**
+     * POST auth/checkLogin
+     *
+     * Возможные коды ответа: {@link CheckLoginResult}
+     * @returns {@link ICheckLoginResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.checkLogin({ login: 'user' });
+     */
+    checkLogin(data: ICheckLoginRequest, options?: IBaseApiParams): Promise<ICheckLoginResponse>;
     /**
      * POST auth/firebase
      *
@@ -69,23 +79,43 @@ export declare class Auth {
     /**
      * POST auth/google
      *
-     * Возможные коды ответа: {@link LoginResult}
-     * @returns {@link ILoginResponse}
+     * Возможные коды ответа: {@link GoogleAuthResult}
+     * @returns {@link IGoogleAuthResponse}
      *
      * @example
      * const result = await client.endpoints.auth.signInWithGoogle(...);
      */
-    signInWithGoogle(data: IOAuthGoogleSignInRequest, options?: IBaseApiParams): Promise<ILoginResponse>;
+    signInWithGoogle(data: IOAuthGoogleSignInRequest, options?: IBaseApiParams): Promise<IGoogleAuthResponse>;
+    /**
+     * POST auth/telegram
+     *
+     * Возможные коды ответа: {@link TelegramAuthResult}
+     * @returns {@link ITelegramAuthResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.signInWithTelegram(...);
+     */
+    signInWithTelegram(data: IOAuthTelegramSignInRequest, options?: IBaseApiParams): Promise<ITelegramAuthResponse>;
     /**
      * POST auth/vk
      *
-     * Возможные коды ответа: {@link LoginResult}
-     * @returns {@link ILoginResponse}
+     * Возможные коды ответа: {@link OAuthAuthResult}
+     * @returns {@link IVkAuthResponse}
      *
      * @example
      * const result = await client.endpoints.auth.signInWithVk(...);
      */
-    signInWithVk(data: IOAuthVkSignInRequest, options?: IBaseApiParams): Promise<ILoginResponse>;
+    signInWithVk(data: IOAuthVkSignInRequest, options?: IBaseApiParams): Promise<IVkAuthResponse>;
+    /**
+     * POST auth/yandex (с beta 21)
+     *
+     * Возможные коды ответа: {@link OAuthAuthResult}
+     * @returns {@link IYandexAuthResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.signInWithYandex({ yandexAccessToken });
+     */
+    signInWithYandex(data: IOAuthYandexSignInRequest, options?: IBaseApiParams): Promise<IYandexAuthResponse>;
     /**
      * POST auth/signUp
      *
@@ -99,23 +129,43 @@ export declare class Auth {
     /**
      * POST auth/google
      *
-     * Возможные коды ответа: {@link LoginResult}
-     * @returns {@link ILoginResponse}
+     * Возможные коды ответа: {@link GoogleAuthResult}
+     * @returns {@link IGoogleAuthResponse}
      *
      * @example
      * const result = await client.endpoints.auth.signUpWithGoogle(...);
      */
-    signUpWithGoogle(data: IOAuthGoogleSignUpRequest, options?: IBaseApiParams): Promise<ILoginResponse>;
+    signUpWithGoogle(data: IOAuthGoogleSignUpRequest, options?: IBaseApiParams): Promise<IGoogleAuthResponse>;
+    /**
+     * POST auth/telegram
+     *
+     * Возможные коды ответа: {@link TelegramAuthResult}
+     * @returns {@link ITelegramAuthResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.signUpWithTelegram(...);
+     */
+    signUpWithTelegram(data: IOAuthTelegramSignUpRequest, options?: IBaseApiParams): Promise<ITelegramAuthResponse>;
     /**
      * POST auth/vk
      *
-     * Возможные коды ответа: {@link LoginResult}
-     * @returns {@link ILoginResponse}
+     * Возможные коды ответа: {@link OAuthAuthResult}
+     * @returns {@link IVkAuthResponse}
      *
      * @example
      * const result = await client.endpoints.auth.signUpWithVk(...);
      */
-    signUpWithVk(data: IOAuthVkSignUpRequest, options?: IBaseApiParams): Promise<ILoginResponse>;
+    signUpWithVk(data: IOAuthVkSignUpRequest, options?: IBaseApiParams): Promise<IVkAuthResponse>;
+    /**
+     * POST auth/yandex (с beta 21)
+     *
+     * Возможные коды ответа: {@link OAuthAuthResult}
+     * @returns {@link IYandexAuthResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.signUpWithYandex({ login, email, yandexAccessToken });
+     */
+    signUpWithYandex(data: IOAuthYandexSignUpRequest, options?: IBaseApiParams): Promise<IYandexAuthResponse>;
     /**
      * POST auth/verify
      *

package/dist/api/auth.js

@@ -8,6 +8,18 @@ class Auth {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * POST auth/checkLogin
+     *
+     * Возможные коды ответа: {@link CheckLoginResult}
+     * @returns {@link ICheckLoginResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.checkLogin({ login: 'user' });
+     */
+    async checkLogin(data, options) {
+        return await this.client.call({ path: `/auth/checkLogin`, method: 'POST', urlEncoded: data, ...options });
+    }
     /**
      * POST auth/firebase
      *
@@ -83,8 +95,8 @@ class Auth {
     /**
      * POST auth/google
      *
-     * Возможные коды ответа: {@link LoginResult}
-     * @returns {@link ILoginResponse}
+     * Возможные коды ответа: {@link GoogleAuthResult}
+     * @returns {@link IGoogleAuthResponse}
      *
      * @example
      * const result = await client.endpoints.auth.signInWithGoogle(...);
@@ -92,11 +104,23 @@ class Auth {
     async signInWithGoogle(data, options) {
         return await this.client.call({ path: `/auth/google`, method: 'POST', urlEncoded: data, ...options });
     }
+    /**
+     * POST auth/telegram
+     *
+     * Возможные коды ответа: {@link TelegramAuthResult}
+     * @returns {@link ITelegramAuthResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.signInWithTelegram(...);
+     */
+    async signInWithTelegram(data, options) {
+        return await this.client.call({ path: `/auth/telegram`, method: 'POST', urlEncoded: data, ...options });
+    }
     /**
      * POST auth/vk
      *
-     * Возможные коды ответа: {@link LoginResult}
-     * @returns {@link ILoginResponse}
+     * Возможные коды ответа: {@link OAuthAuthResult}
+     * @returns {@link IVkAuthResponse}
      *
      * @example
      * const result = await client.endpoints.auth.signInWithVk(...);
@@ -104,6 +128,18 @@ class Auth {
     async signInWithVk(data, options) {
         return await this.client.call({ path: `/auth/vk`, method: 'POST', urlEncoded: data, ...options });
     }
+    /**
+     * POST auth/yandex (с beta 21)
+     *
+     * Возможные коды ответа: {@link OAuthAuthResult}
+     * @returns {@link IYandexAuthResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.signInWithYandex({ yandexAccessToken });
+     */
+    async signInWithYandex(data, options) {
+        return await this.client.call({ path: `/auth/yandex`, method: 'POST', urlEncoded: data, ...options });
+    }
     /**
      * POST auth/signUp
      *
@@ -119,8 +155,8 @@ class Auth {
     /**
      * POST auth/google
      *
-     * Возможные коды ответа: {@link LoginResult}
-     * @returns {@link ILoginResponse}
+     * Возможные коды ответа: {@link GoogleAuthResult}
+     * @returns {@link IGoogleAuthResponse}
      *
      * @example
      * const result = await client.endpoints.auth.signUpWithGoogle(...);
@@ -128,11 +164,23 @@ class Auth {
     async signUpWithGoogle(data, options) {
         return await this.client.call({ path: `/auth/google`, method: 'POST', urlEncoded: data, ...options });
     }
+    /**
+     * POST auth/telegram
+     *
+     * Возможные коды ответа: {@link TelegramAuthResult}
+     * @returns {@link ITelegramAuthResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.signUpWithTelegram(...);
+     */
+    async signUpWithTelegram(data, options) {
+        return await this.client.call({ path: `/auth/telegram`, method: 'POST', urlEncoded: data, ...options });
+    }
     /**
      * POST auth/vk
      *
-     * Возможные коды ответа: {@link LoginResult}
-     * @returns {@link ILoginResponse}
+     * Возможные коды ответа: {@link OAuthAuthResult}
+     * @returns {@link IVkAuthResponse}
      *
      * @example
      * const result = await client.endpoints.auth.signUpWithVk(...);
@@ -140,6 +188,18 @@ class Auth {
     async signUpWithVk(data, options) {
         return await this.client.call({ path: `/auth/vk`, method: 'POST', urlEncoded: data, ...options });
     }
+    /**
+     * POST auth/yandex (с beta 21)
+     *
+     * Возможные коды ответа: {@link OAuthAuthResult}
+     * @returns {@link IYandexAuthResponse}
+     *
+     * @example
+     * const result = await client.endpoints.auth.signUpWithYandex({ login, email, yandexAccessToken });
+     */
+    async signUpWithYandex(data, options) {
+        return await this.client.call({ path: `/auth/yandex`, method: 'POST', urlEncoded: data, ...options });
+    }
     /**
      * POST auth/verify
      *

package/dist/api/channel/channel.d.ts

@@ -1,5 +1,5 @@
 import { Anixart } from "../../client";
-import { IArticle, IArticleMuteResponse, IBaseApiParams, IChannel, IChannelBlockInfoResponse, IChannelBlockManageRequest, IChannelCreateRequest, IChannelMediaTokenResponse, IChannelPermissionManageRequest, IChannelPermissionManageResponse, IChannelPermissionsFilterRequest, IChannelProfile, IChannelResponse, IChannelSubscribeResponse, IChannelUnsubscribeResponse, IChannelUploadCoverAvatarResponse, IChannelsFilterRequest, IPageableResponse, ISubscriptionCountResponse } from "../../types";
+import { IArticle, IArticleMuteResponse, IBaseApiParams, IChannel, IChannelBlockInfoResponse, IChannelBlockManageRequest, IChannelCreateRequest, IChannelMediaTokenResponse, IChannelPermissionManageRequest, IChannelPermissionManageResponse, IChannelPermissionsFilterRequest, IChannelProfile, IChannelResponse, IChannelSubscribeResponse, IChannelUnsubscribeResponse, IChannelUploadCoverAvatarResponse, IChannelsFilterRequest, IEditorChannelsResponse, IPageableResponse, ISubscriptionCountResponse } from "../../types";
 /**
  * Класс с эндпоинтами каналов
  */
@@ -146,6 +146,16 @@ export declare class Channel {
      * const result = await client.endpoints.channel.editorAvailable(1, ...);
      */
     editorAvailable(channelId: number, query?: Record<string, string | number | boolean | undefined>, options?: IBaseApiParams): Promise<IChannelMediaTokenResponse>;
+    /**
+     * GET channel/editor/available/all
+     *
+     * Возможные коды ответа: {@link DefaultResult}
+     * @returns {@link IEditorChannelsResponse}
+     *
+     * @example
+     * const result = await client.endpoints.channel.editorAvailableAll(...);
+     */
+    editorAvailableAll(options?: IBaseApiParams): Promise<IEditorChannelsResponse>;
     /**
      * POST channel/mute/{c_id}
      *

package/dist/api/channel/channel.js

@@ -176,6 +176,18 @@ class Channel {
     async editorAvailable(channelId, query, options) {
         return await this.client.call({ path: `/channel/${channelId}/editor/available`, queryParams: query, ...options });
     }
+    /**
+     * GET channel/editor/available/all
+     *
+     * Возможные коды ответа: {@link DefaultResult}
+     * @returns {@link IEditorChannelsResponse}
+     *
+     * @example
+     * const result = await client.endpoints.channel.editorAvailableAll(...);
+     */
+    async editorAvailableAll(options) {
+        return await this.client.call({ path: `/channel/editor/available/all`, ...options });
+    }
     /**
      * POST channel/mute/{c_id}
      *

package/dist/api/config.d.ts

@@ -1,11 +1,21 @@
 import { Anixart } from "../client";
-import { IBaseApiParams, IConfigUrlsResponse, ITogglesResponse } from "../types";
+import { IAnixPlayerConfigResponse, IBaseApiParams, IConfigUrlsResponse, ITogglesResponse } from "../types";
 /**
  * Класс с эндпоинтами конфигурации
  */
 export declare class Config {
     private readonly client;
     constructor(client: Anixart);
+    /**
+     * GET config/anixplayer
+     *
+     * Возможные коды ответа: {@link DefaultResult}
+     * @returns {@link IAnixPlayerConfigResponse}
+     *
+     * @example
+     * const result = await client.endpoints.config.anixplayer(...);
+     */
+    anixplayer(query?: Record<string, string | number | boolean | undefined>, options?: IBaseApiParams): Promise<IAnixPlayerConfigResponse>;
     /**
      * GET config/toggles
      *

package/dist/api/config.js

@@ -8,6 +8,18 @@ class Config {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * GET config/anixplayer
+     *
+     * Возможные коды ответа: {@link DefaultResult}
+     * @returns {@link IAnixPlayerConfigResponse}
+     *
+     * @example
+     * const result = await client.endpoints.config.anixplayer(...);
+     */
+    async anixplayer(query, options) {
+        return await this.client.call({ path: `/config/anixplayer`, queryParams: query, ...options });
+    }
     /**
      * GET config/toggles
      *