flamerest 1.0.31 → 1.0.34

package/REST.d.ts

@@ -5,7 +5,7 @@
  * @param {string} type Тип
  * @param {string} responseType Тип ответа: json или blob
  */
-export function request(url: string, params: object | string, type: string, responseType: string): object
+export function request(url: string, params: object | string, type?: string, responseType?: string): object
 
 /**
  * Получить выборку из таблицы через REST
@@ -21,7 +21,7 @@ export function request(url: string, params: object | string, type: string, resp
  * @param titles Это чтобы мы могли контроллить какие названия полей мы будет загружать при экспорте, чтобы они были как в таблице
  * @return Promise<object>
  */
-export function get(table: string, where: object | string | null, expand: object | string | null, fields: object | Array<string> | string | null, sortfields: object | Array<string> | string | null, page: number, perPage: number, RemoveDuplicates, format, titles): object
+export function get<T>(table: string, where?: object | string | null, expand?: object | string | null, fields?: object | Array<string> | string | null, sortfields?: object | Array<string> | string | null, page?: number, perPage?: number, RemoveDuplicates?, format?, titles?): Promise<Rows<T>>;
 
 /**
  * Получить все записи по запросу [постранично]
@@ -29,7 +29,25 @@ export function get(table: string, where: object | string | null, expand: object
  * @param {object} params 
  * @returns 
  */
-export function all(table: string, params: {where: object, fields: object|Array<string>, sort: Array<string>, page: number, perPage: number}): object;
+export function all<T>(table: string, params?: { where?: object, fields?: object | Array<string>, sort?: Array<string>, page?: number, perPage?: number }): Promise<Rows<T>>;
+
+/**
+ * Стандартный ответ от Request с несколькими строками
+ */
+type Rows<T> = {
+  type: string,
+  status: Number,
+  ok: boolean,
+  data?: Array<T>,
+  errors: Object|undefined,
+  message: string|undefined,
+  pages: {
+    page: Number,
+    perPage: Number,
+    count: Number,
+    total: Number,
+  }
+}
 
 /**
    * Получить одну запись по ID или по условию выборки [первая запись]
@@ -38,14 +56,14 @@ export function all(table: string, params: {where: object, fields: object|Array<
    * @param {object|Array} fields 
    * @param {string} primaryKeyName если указан ID, то указать название первичного ключа, если от id он отличается
  */
-export function one(table: string, IDOrWhere: number|string|object, fields: object|Array<string>, primaryKeyName: string): object;
+export function one<T>(table: string, IDOrWhere: number | string | object, fields?: object | Array<string> | null, primaryKeyName?: string): Promise<T | null>;
 
 /**
  * Создать новую запись
  * @param table
  * @param values
  */
-export function create(table: string, values: object)
+export function create<T>(table: string, values: object): Promise<T>
 
 /**
  * Удалить запись
@@ -53,7 +71,7 @@ export function create(table: string, values: object)
  * @param id
  * @param byFields Если указан, удаляет по этим параметрам
  */
-export function remove(table: string, id: number | string, byFields: object)
+export function remove(table: string, id: number | string, byFields?: object)
 
 /**
  * Редактировать значения
@@ -73,14 +91,30 @@ export function getCRUDInfo(): object
  * @param username 
  * @param password 
  */
-export function auth(username: string, password: string);
+export function auth(username: string, password: string): Authorized;
 
 /**
  * Зарегистрироваться с этим логином и паролем
  * @param username 
  * @param password 
  */
-export function signup(username: string, password: string);
+export function signup(username: string, password: string): Authorized;
+
+/**
+ * Результат авторизации
+ */
+type Authorized = {
+  isAuthorized: boolean;
+  User: {
+    avatar: string,
+    country: string,
+    id: Number,
+    lang: string,
+    name: string,
+    role: string
+  };
+  errors: object|undefined;
+}
 
 /**
  * Выйти из системы

package/REST.js

@@ -359,7 +359,7 @@ class FLAMEREST {
    * @param {number|string|object} IDOrWhere 
    * @param {object|Array} fields 
    * @param {string} primaryKeyName 
-   * @returns {object}
+   * @returns {object|null}
    */
   async one(table, IDOrWhere, fields = null, primaryKeyName = 'id') {
     

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flamerest",
-  "version": "1.0.31",
+  "version": "1.0.34",
   "description": "",
   "main": "REST.js",
   "typings": "./REST.d.ts",
@@ -14,7 +14,8 @@
   "keywords": [
     "rest",
     "yii2",
-    "js"
+    "js",
+    "ts"
   ],
   "author": "FlameArt",
   "license": "MIT",