flamerest 1.0.76 → 1.0.78

package/REST.d.ts

@@ -1,4 +1,36 @@
-export default REST = {
+interface IREST {
+
+  /**
+   * Сервер, endpoint
+   */
+  SERVER: string,
+
+  /**
+   * Версия api
+   */
+  version: string,
+
+  /**
+   * Если авторизация по токену
+   */
+  isAuthByJWTQuery: boolean,
+
+  /**
+   * Токен авторизации
+   */
+  token: string | null,
+
+  /**
+   * Будет вызван, если любой из запросов вернут требование авторизоваться
+   */
+  unauthorized_callback: () => {},
+
+  /**
+   * Стандартное число запросов на страницу
+   * @type {number}
+   */
+  perPageDefault: number,
+
   /**
    *
    * @param {string} url Адрес
@@ -6,7 +38,7 @@ export default REST = {
    * @param {string} type Тип
    * @param {string} responseType Тип ответа: json или blob
    */
-  request(url: string, params: object | string, type?: string, responseType?: string): object { },
+  request(url: string, params: object | string, type?: string, responseType?: string): object,
 
   /**
    * Получить выборку из таблицы через REST
@@ -22,7 +54,7 @@ export default REST = {
    * @param titles Это чтобы мы могли контроллить какие названия полей мы будет загружать при экспорте, чтобы они были как в таблице
    * @return Promise<object>
    */
-  get<T>(table: string, where?: object | string | null, extfields?: object | Array<string>, fields?: object | Array<string> | string | null, sortfields?: object | Array<string> | string | null, page?: number, perPage?: number, RemoveDuplicates?, format?, titles?): Promise<Rows<T>> { },
+  get<T>(table: string, where?: object | string | null, extfields?: object | Array<string>, fields?: object | Array<string> | string | null, sortfields?: object | Array<string> | string | null, page?: number, perPage?: number, RemoveDuplicates?, format?, titles?): Promise<Rows<T>>,
 
   /**
    * Получить все записи по запросу [постранично]
@@ -30,7 +62,7 @@ export default REST = {
    * @param {object} params 
    * @returns 
    */
-  all<T>(table: string, params?: { where?: object, extfields?: object | Array<string>, fields?: object | Array<string>, sort?: Array<string>, page?: number, perPage?: number, tree?: number }): Promise<Rows<T>> { },
+  all<T>(table: string, params?: { where?: object, extfields?: object | Array<string>, fields?: object | Array<string>, sort?: Array<string>, page?: number, perPage?: number, tree?: number }): Promise<Rows<T>>,
 
   /**
      * Получить одну запись по ID или по условию выборки [первая запись]
@@ -39,14 +71,14 @@ export default REST = {
      * @param {object|Array} fields 
      * @param {string} primaryKeyName если указан ID, то указать название первичного ключа, если от id он отличается
    */
-  one<T>(table: string, IDOrWhere: number | string | object, extfields?: object | Array<string>, fields?: object | Array<string> | null, primaryKeyName?: string): Promise<T | null> { },
+  one<T>(table: string, IDOrWhere: number | string | object, extfields?: object | Array<string>, fields?: object | Array<string> | null, primaryKeyName?: string): Promise<T | null>,
 
   /**
    * Создать новую запись
    * @param table
    * @param values
    */
-  create<T>(table: string, values: object, appendTo?: number | string | null, insertAfter?: number | string | null, insertFirst?: number | string | null): Promise<SavedObject<T>> { },
+  create<T>(table: string, values: object, appendTo?: number | string | null, insertAfter?: number | string | null, insertFirst?: number | string | null): Promise<SavedObject<T>>,
 
   /**
    * Удалить запись
@@ -54,7 +86,7 @@ export default REST = {
    * @param id
    * @param byFields Если указан, удаляет по этим параметрам
    */
-  remove(table: string, id: number | string, byFields?: object): Promise<boolean | Array<any>> { },
+  remove(table: string, id: number | string, byFields?: object): Promise<boolean | Array<any>>,
 
   /**
    * Редактировать значения
@@ -62,20 +94,20 @@ export default REST = {
    * @param ID
    * @param values
    */
-  edit<T>(table: string, ID: number | string, values: object, appendTo: number | string | null, insertAfter: number | string | null, insertFirst: number | string | null): Promise<SavedObject<T>> { },
+  edit<T>(table: string, ID: number | string, values: object, appendTo: number | string | null, insertAfter: number | string | null, insertFirst: number | string | null): Promise<SavedObject<T>>,
 
 
   /**
    * Получить схемы всех таблиц
    */
-  getCRUDInfo(): object { },
+  getCRUDInfo(): object,
 
   /**
    * Авторизоваться
    * @param username 
    * @param password 
    */
-  auth(username?: string, password?: string): Promise<Authorized> { },
+  auth(username?: string, password?: string): Promise<Authorized>,
 
   /**
    * Зарегистрироваться с этим логином и паролем
@@ -84,20 +116,20 @@ export default REST = {
    * @param password 
    * @param name 
    */
-  signup(email: string | null, username: string | null, password: string, name: string | null): Promise<Authorized> { },
+  signup(email: string | null, username: string | null, password: string, name: string | null): Promise<Authorized>,
 
 
   /**
    * Выйти из системы
    */
-  logout(): Promise<object> { },
+  logout(): Promise<object>,
 
   /**
    * Подготовить объект под загрузку: загрузить данные из элементов [type=file]
    * Работает ссылочно, меняя основной массив
    * @param values 
    */
-  prepare(values: any): Promise<any> { },
+  prepare(values: any): Promise<any>,
 
 
   /**
@@ -105,7 +137,7 @@ export default REST = {
    * @param object Заполняемый объект
    * @param values Аналогичный объект-источник данных
    */
-  fillObject<T>(object: T, values: any): T { },
+  fillObject<T>(object: T, values: any): T,
 
 }
 
@@ -155,4 +187,8 @@ export type Authorized = {
   };
   errors: { [key: string]: any };
   token: string;
-}
+}
+
+declare const REST: IREST;
+
+export default REST;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flamerest",
-  "version": "1.0.76",
+  "version": "1.0.78",
   "description": "",
   "main": "REST.js",
   "typings": "./REST.d.ts",