next-box 2.1.83 → 2.1.85

package/README.md

@@ -1,4 +1,4 @@
-A library for developing extensions, components and working with data in the NextBox platform.
+A library for developing extensions, components and working with data in the [NextBox](https://next-box.ru/) platform.
 
 #### Install NPM
 
@@ -43,3 +43,214 @@ nb.init((state) => {
 
 -   Перейти на **/** `Transport.navigate('/', {}, '_self')`
 -   Перейти на **/** и добавить **queryParams** `Transport.navigate('/', {'key': 'value'}, '_self')`
+
+## Инстанс NextBox
+
+```javascript
+export declare class NextBox extends EventEmitter {
+    /**
+     *  Хранит актуальное состояние подключения
+     */
+    state?: AppState;
+
+    /**
+     *  Метод подключения к приложению, будет вызван после получения актуального состояния
+     */
+    init(handler?: (state: AppState) => void): void;
+}
+```
+
+## Инстанс StorageApi
+
+```javascript
+export declare class StorageApi extends Api {
+    /**
+     * Получить список файлов
+     */
+    list(params: StorageRequestListParams): Promise<ResponseList<StorageElement>>;
+
+    /**
+     * Информация о файле (модель)
+     */
+    info(path: string): Promise<StorageElement>;
+
+    /**
+     * Создать файл или папку
+     */
+    create(name: string, path: string, type: 'dir' | 'file'): Promise<ResponseItem<StorageElement>>;
+
+    /**
+     * Удалить файл или папку
+     */
+    delete(path: string, hard?: boolean): Promise<any>;
+
+    /**
+     * Возвращает полный путь для загрузки файла
+     */
+    makeDownloadPath(path?: string, options?: MakePathOption): string;
+
+    /**
+     * Возвращает полный путь к изображению предварительного просмотра
+     */
+    makeImagePreview(path?: string, options?: MakePathOption): string;
+
+    /**
+     * Получить тело файла
+     */
+    download(path?: string): Promise<Response>;
+
+    /**
+     * Отправьте запрос на изменение файла
+     */
+    replace(body: any, path?: string): Promise<Response | null>;
+
+    /**
+     * Синхронная запись в файлы
+     */
+    liveReplace(body: any, path?: string): void;
+
+    /**
+     * Загрузить файл
+     */
+    upload(path: string, file: File): Promise<{
+        row: StorageElement;
+    }>;
+
+    /**
+     * Загрузить файл по URL-адресу
+     */
+    uploadNet(path: string, url: string, overwrite?: boolean): Promise<StorageElement>;
+
+    /**
+     * Создать файд метаданных для расширения
+     */
+    createMeta(name?: string, path?: string): Promise<{
+        row: StorageElement;
+    }>;
+
+    /**
+     * Прочитать метаданные расширения
+     */
+    readMeta(path?: string): Promise<any>;
+
+    /**
+     * Сохранить метаданные расширения
+     */
+    saveMeta(body: any, path?: string): Promise<any>;
+
+    /**
+     * Относительный путь (откуда вызывается редактор)
+     */
+    relativePath(path?: string, defaultPath?: string): string;
+
+    /**
+     * Возвращает действительный URL-адрес в API (storage или FCA)
+     */
+    makeApiPath(...arg: string[]): URL;
+
+    /**
+     * Возвращает имя метафайла расширения (берется из extenstion.name.ru)
+     */
+    get metaName(): string;
+}
+
+```
+
+## Инстанс UserApi
+
+```javascript
+export declare class UserApi extends Api {
+    /**
+     * Выход из системы
+     */
+    logout(): Promise<void>;
+
+    /**
+     * Получить данные пользователя по его id
+     */
+    get(id: number): Promise<User>;
+
+    /**
+     * Список пользователей
+     */
+    list(params: RequestUserListParams): Promise<ResponseList<User>>;
+
+    /**
+     * Вернуть удаленного пользователя
+     */
+    restore(id: number): Promise<void>;
+
+    /**
+     * Удалить пользователя
+     */
+    delete(id: number, params?: {
+        hard: boolean;
+    }): Promise<void>;
+
+    /**
+     * Обновить данные пользователя
+     */
+    update(data: UpdateUserParams): Promise<ResponseItem<User>>;
+
+    /**
+     * Создать нового пользователя
+     */
+    create(data: CreateUserParams): Promise<ResponseItem<User>>;
+
+    /**
+     * Создать API токен
+     */
+    createToken(data: {
+        name: string;
+        expire_in: string | null;
+    }): Promise<UserToken>;
+
+    /**
+     * Получить список пользователей
+     */
+    listToken(params: RequestBaseParams): Promise<ResponseList<UserToken>>;
+
+    /**
+     * Удалить токен
+     */
+    deleteToken(id: number): Promise<void>;
+
+    /**
+     * Изменить пароль
+     */
+    changePassword(data: {
+        new_password: string;
+        old_password: string;
+    }): Promise<{
+        success: boolean;
+    }>;
+
+    /**
+     * Получить данные о себе
+     */
+    me(): Promise<ResponseItem<User>>;
+
+    /**
+     * Загрузить аватар
+     */
+    meUploadAvatar(file: Blob, fileName: string): Promise<{
+        file_path: string;
+    }>;
+
+    /**
+     * Удалить аватар
+     */
+    meDeleteAvatar(): Promise<void>;
+
+    /**
+     * Получить список активных сессий
+     */
+    meListSession(params: RequestBaseParams): Promise<ResponseList<UserSession>>;
+
+    /**
+     * Удалить сессию по id или все
+     */
+    meDeleteSession(id?: number): Promise<void>;
+}
+
+```

package/app/api/storage-api.d.ts

@@ -1,6 +1,6 @@
 import { Api } from '../classes/api';
 import { StorageElement, StorageElementType } from '../types/storage-element';
-import { RequestBaseParams, ResponseList } from './types/base';
+import { RequestBaseParams, ResponseItem, ResponseList } from './types/base';
 import { RequestStatus } from '../types';
 export interface StorageRequestListParams extends RequestBaseParams {
     path?: string;
@@ -36,14 +36,18 @@ export declare class StorageApi extends Api {
     /**
      * Create empty file
      */
-    create(name: string, path: string, type: 'dir' | 'file'): Promise<{
-        row: StorageElement;
-    }>;
+    create(name: string, path: string, type: 'dir' | 'file'): Promise<ResponseItem<StorageElement>>;
     /**
      * Delete file
      */
     delete(path: string, hard?: boolean): Promise<any>;
+    /**
+     * Returns the full path to download the file
+     */
     makeDownloadPath(path?: string, options?: MakePathOption): string;
+    /**
+     * Returns the full path for the preview image
+     */
     makeImagePreview(path?: string, options?: MakePathOption): string;
     /**
      * Submit a file download request
@@ -53,6 +57,9 @@ export declare class StorageApi extends Api {
      * Submit a file change request
      */
     replace(body: any, path?: string): Promise<Response | null>;
+    /**
+     * Synchronous writing to files
+     */
     liveReplace(body: any, path?: string): void;
     /**
      * Upload file
@@ -78,7 +85,16 @@ export declare class StorageApi extends Api {
      * Saving metadata extension
      */
     saveMeta(body: any, path?: string): Promise<any>;
+    /**
+     * Relative path (where the editor is called from)
+     */
     relativePath(path?: string, defaultPath?: string): string;
+    /**
+     * Returns a valid URL to the API (storage or fca)
+     */
     makeApiPath(...arg: string[]): URL;
+    /**
+     * Returns the name for the extension meta file (taken from extenstion.name.ru)
+     */
     get metaName(): string;
 }

package/app/api/user-api.d.ts

@@ -22,32 +22,80 @@ export interface UserSession {
     id: number;
 }
 export declare class UserApi extends Api {
+    /**
+     * Logout from the system
+     */
     logout(): Promise<void>;
+    /**
+     * Get user data by his id
+     */
     get(id: number): Promise<User>;
+    /**
+     * List users
+     */
     list(params: RequestUserListParams): Promise<ResponseList<User>>;
+    /**
+     * Return deleted user
+     */
     restore(id: number): Promise<void>;
+    /**
+     * Delete user
+     */
     delete(id: number, params?: {
         hard: boolean;
     }): Promise<void>;
+    /**
+     * Update user details
+     */
     update(data: UpdateUserParams): Promise<ResponseItem<User>>;
+    /**
+     * Create a new user
+     */
     create(data: CreateUserParams): Promise<ResponseItem<User>>;
+    /**
+     * Create an API token
+     */
     createToken(data: {
         name: string;
         expire_in: string | null;
     }): Promise<UserToken>;
+    /**
+     * Get list of users
+     */
     listToken(params: RequestBaseParams): Promise<ResponseList<UserToken>>;
+    /**
+     * Delete token
+     */
     deleteToken(id: number): Promise<void>;
+    /**
+     * Change password
+     */
     changePassword(data: {
         new_password: string;
         old_password: string;
     }): Promise<{
         success: boolean;
     }>;
+    /**
+     * Get information about yourself
+     */
     me(): Promise<ResponseItem<User>>;
+    /**
+     * Upload avatar
+     */
     meUploadAvatar(file: Blob, fileName: string): Promise<{
         file_path: string;
     }>;
+    /**
+     * Delete avatar
+     */
     meDeleteAvatar(): Promise<void>;
+    /**
+     * Get a list of active sessions
+     */
     meListSession(params: RequestBaseParams): Promise<ResponseList<UserSession>>;
+    /**
+     * Delete session by id or all
+     */
     meDeleteSession(id?: number): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "next-box",
-    "version": "2.1.83",
+    "version": "2.1.85",
     "description": "",
     "main": "index.js",
     "types": "index.d.ts",