next-box 2.3.1 → 2.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -228
- package/app/types/storage-element.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
Библиотека для разработки расширений, компонентов и работы с данными на платформе [NextBox](https://next-box.ru/).
|
|
2
2
|
|
|
3
|
+
- [Документация](https://docs.next-box.ru/npm-next-box/introduction)
|
|
4
|
+
- [История изменений](https://docs.next-box.ru/npm-next-box/versions)
|
|
5
|
+
|
|
3
6
|
#### NPM Установка
|
|
4
7
|
|
|
5
8
|
```
|
|
@@ -32,231 +35,3 @@ nb.init((state) => {
|
|
|
32
35
|
})
|
|
33
36
|
});
|
|
34
37
|
```
|
|
35
|
-
|
|
36
|
-
## Навигация
|
|
37
|
-
|
|
38
|
-
#### В родительском фрейме
|
|
39
|
-
|
|
40
|
-
- Перейти на **/** `Transport.navigate('/', {}, '_parent')`
|
|
41
|
-
- Изменить queryParams на текущей странице `Transport.navigate('', {'key': 'value'}, '_parent')`
|
|
42
|
-
|
|
43
|
-
#### Открыть в новом окне
|
|
44
|
-
|
|
45
|
-
- Перейти на **/** `Transport.navigate('/', {}, '_blank')`
|
|
46
|
-
- Перейти на **/** и добавить **queryParams** `Transport.navigate('/', {'key': 'value'}, '_blank')`
|
|
47
|
-
|
|
48
|
-
#### Управление url текущим фреймом
|
|
49
|
-
|
|
50
|
-
- Перейти на **/** `Transport.navigate('/', {}, '_self')`
|
|
51
|
-
- Перейти на **/** и добавить **queryParams** `Transport.navigate('/', {'key': 'value'}, '_self')`
|
|
52
|
-
|
|
53
|
-
## Инстанс NextBox
|
|
54
|
-
|
|
55
|
-
```javascript
|
|
56
|
-
export declare class NextBox extends EventEmitter {
|
|
57
|
-
/**
|
|
58
|
-
* Хранит актуальное состояние подключения
|
|
59
|
-
*/
|
|
60
|
-
state?: AppState;
|
|
61
|
-
|
|
62
|
-
/**
|
|
63
|
-
* Метод подключения к приложению, будет вызван после получения актуального состояния
|
|
64
|
-
*/
|
|
65
|
-
init(handler?: (state: AppState) => void): void;
|
|
66
|
-
}
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
## Инстанс StorageApi
|
|
70
|
-
|
|
71
|
-
```javascript
|
|
72
|
-
export declare class StorageApi extends Api {
|
|
73
|
-
/**
|
|
74
|
-
* Получить список файлов
|
|
75
|
-
*/
|
|
76
|
-
list(params: StorageRequestListParams): Promise<ResponseList<StorageElement>>;
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
* Информация о файле (модель)
|
|
80
|
-
*/
|
|
81
|
-
info(path: string): Promise<StorageElement>;
|
|
82
|
-
|
|
83
|
-
/**
|
|
84
|
-
* Создать файл или папку
|
|
85
|
-
*/
|
|
86
|
-
create(name: string, path: string, type: 'dir' | 'file'): Promise<ResponseItem<StorageElement>>;
|
|
87
|
-
|
|
88
|
-
/**
|
|
89
|
-
* Удалить файл или папку
|
|
90
|
-
*/
|
|
91
|
-
delete(path: string, hard?: boolean): Promise<any>;
|
|
92
|
-
|
|
93
|
-
/**
|
|
94
|
-
* Возвращает полный путь для загрузки файла
|
|
95
|
-
*/
|
|
96
|
-
makeDownloadPath(path?: string, options?: MakePathOption): string;
|
|
97
|
-
|
|
98
|
-
/**
|
|
99
|
-
* Возвращает полный путь к изображению предварительного просмотра
|
|
100
|
-
*/
|
|
101
|
-
makeImagePreview(path?: string, options?: MakePathOption): string;
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* Получить тело файла
|
|
105
|
-
*/
|
|
106
|
-
download(path?: string): Promise<Response>;
|
|
107
|
-
|
|
108
|
-
/**
|
|
109
|
-
* Отправьте запрос на изменение файла
|
|
110
|
-
*/
|
|
111
|
-
replace(body: any, path?: string): Promise<Response | null>;
|
|
112
|
-
|
|
113
|
-
/**
|
|
114
|
-
* Синхронная запись в файлы
|
|
115
|
-
*/
|
|
116
|
-
liveReplace(body: any, path?: string, finalize?: () => void): void;
|
|
117
|
-
|
|
118
|
-
/**
|
|
119
|
-
* Загрузить файл
|
|
120
|
-
*/
|
|
121
|
-
upload(path: string, file: File): Promise<{
|
|
122
|
-
row: StorageElement;
|
|
123
|
-
}>;
|
|
124
|
-
|
|
125
|
-
/**
|
|
126
|
-
* Загрузить файл по URL-адресу
|
|
127
|
-
*/
|
|
128
|
-
uploadNet(path: string, url: string, overwrite?: boolean): Promise<StorageElement>;
|
|
129
|
-
|
|
130
|
-
/**
|
|
131
|
-
* Создать файд метаданных для расширения
|
|
132
|
-
*/
|
|
133
|
-
createMeta(name?: string, path?: string): Promise<{
|
|
134
|
-
row: StorageElement;
|
|
135
|
-
}>;
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* Прочитать метаданные расширения
|
|
139
|
-
*/
|
|
140
|
-
readMeta(path?: string): Promise<any>;
|
|
141
|
-
|
|
142
|
-
/**
|
|
143
|
-
* Сохранить метаданные расширения
|
|
144
|
-
*/
|
|
145
|
-
saveMeta(body: any, path?: string): Promise<any>;
|
|
146
|
-
|
|
147
|
-
/**
|
|
148
|
-
* Относительный путь (откуда вызывается редактор)
|
|
149
|
-
*/
|
|
150
|
-
relativePath(path?: string, defaultPath?: string): string;
|
|
151
|
-
|
|
152
|
-
/**
|
|
153
|
-
* Возвращает действительный URL-адрес в API (storage или FCA)
|
|
154
|
-
*/
|
|
155
|
-
makeApiPath(...arg: string[]): URL;
|
|
156
|
-
|
|
157
|
-
/**
|
|
158
|
-
* Возвращает имя метафайла расширения (берется из extenstion.name.ru)
|
|
159
|
-
*/
|
|
160
|
-
get metaName(): string;
|
|
161
|
-
}
|
|
162
|
-
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
## Инстанс UserApi
|
|
166
|
-
|
|
167
|
-
```javascript
|
|
168
|
-
export declare class UserApi extends Api {
|
|
169
|
-
/**
|
|
170
|
-
* Выход из системы
|
|
171
|
-
*/
|
|
172
|
-
logout(): Promise<void>;
|
|
173
|
-
|
|
174
|
-
/**
|
|
175
|
-
* Получить данные пользователя по его id
|
|
176
|
-
*/
|
|
177
|
-
get(id: number): Promise<User>;
|
|
178
|
-
|
|
179
|
-
/**
|
|
180
|
-
* Список пользователей
|
|
181
|
-
*/
|
|
182
|
-
list(params: RequestUserListParams): Promise<ResponseList<User>>;
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* Вернуть удаленного пользователя
|
|
186
|
-
*/
|
|
187
|
-
restore(id: number): Promise<void>;
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Удалить пользователя
|
|
191
|
-
*/
|
|
192
|
-
delete(id: number, params?: {
|
|
193
|
-
hard: boolean;
|
|
194
|
-
}): Promise<void>;
|
|
195
|
-
|
|
196
|
-
/**
|
|
197
|
-
* Обновить данные пользователя
|
|
198
|
-
*/
|
|
199
|
-
update(data: UpdateUserParams): Promise<ResponseItem<User>>;
|
|
200
|
-
|
|
201
|
-
/**
|
|
202
|
-
* Создать нового пользователя
|
|
203
|
-
*/
|
|
204
|
-
create(data: CreateUserParams): Promise<ResponseItem<User>>;
|
|
205
|
-
|
|
206
|
-
/**
|
|
207
|
-
* Создать API токен
|
|
208
|
-
*/
|
|
209
|
-
createToken(data: {
|
|
210
|
-
name: string;
|
|
211
|
-
expire_in: string | null;
|
|
212
|
-
}): Promise<UserToken>;
|
|
213
|
-
|
|
214
|
-
/**
|
|
215
|
-
* Получить список пользователей
|
|
216
|
-
*/
|
|
217
|
-
listToken(params: RequestBaseParams): Promise<ResponseList<UserToken>>;
|
|
218
|
-
|
|
219
|
-
/**
|
|
220
|
-
* Удалить токен
|
|
221
|
-
*/
|
|
222
|
-
deleteToken(id: number): Promise<void>;
|
|
223
|
-
|
|
224
|
-
/**
|
|
225
|
-
* Изменить пароль
|
|
226
|
-
*/
|
|
227
|
-
changePassword(data: {
|
|
228
|
-
new_password: string;
|
|
229
|
-
old_password: string;
|
|
230
|
-
}): Promise<{
|
|
231
|
-
success: boolean;
|
|
232
|
-
}>;
|
|
233
|
-
|
|
234
|
-
/**
|
|
235
|
-
* Получить данные о себе
|
|
236
|
-
*/
|
|
237
|
-
me(): Promise<ResponseItem<User>>;
|
|
238
|
-
|
|
239
|
-
/**
|
|
240
|
-
* Загрузить аватар
|
|
241
|
-
*/
|
|
242
|
-
meUploadAvatar(file: Blob, fileName: string): Promise<{
|
|
243
|
-
file_path: string;
|
|
244
|
-
}>;
|
|
245
|
-
|
|
246
|
-
/**
|
|
247
|
-
* Удалить аватар
|
|
248
|
-
*/
|
|
249
|
-
meDeleteAvatar(): Promise<void>;
|
|
250
|
-
|
|
251
|
-
/**
|
|
252
|
-
* Получить список активных сессий
|
|
253
|
-
*/
|
|
254
|
-
meListSession(params: RequestBaseParams): Promise<ResponseList<UserSession>>;
|
|
255
|
-
|
|
256
|
-
/**
|
|
257
|
-
* Удалить сессию по id или все
|
|
258
|
-
*/
|
|
259
|
-
meDeleteSession(id?: number): Promise<void>;
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
```
|