flamerest 1.0.77 → 1.0.78

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.
Files changed (2) hide show
  1. package/REST.d.ts +22 -20
  2. package/package.json +1 -1
package/REST.d.ts CHANGED
@@ -1,9 +1,8 @@
1
- export default REST = {
1
+ interface IREST {
2
2
 
3
3
  /**
4
- * Адрес серва
5
- * @type {string}
6
- */
4
+ * Сервер, endpoint
5
+ */
7
6
  SERVER: string,
8
7
 
9
8
  /**
@@ -11,7 +10,6 @@ export default REST = {
11
10
  */
12
11
  version: string,
13
12
 
14
-
15
13
  /**
16
14
  * Если авторизация по токену
17
15
  */
@@ -25,7 +23,7 @@ export default REST = {
25
23
  /**
26
24
  * Будет вызван, если любой из запросов вернут требование авторизоваться
27
25
  */
28
- unauthorized_callback: function () { },
26
+ unauthorized_callback: () => {},
29
27
 
30
28
  /**
31
29
  * Стандартное число запросов на страницу
@@ -40,7 +38,7 @@ export default REST = {
40
38
  * @param {string} type Тип
41
39
  * @param {string} responseType Тип ответа: json или blob
42
40
  */
43
- request(url: string, params: object | string, type?: string, responseType?: string): object { },
41
+ request(url: string, params: object | string, type?: string, responseType?: string): object,
44
42
 
45
43
  /**
46
44
  * Получить выборку из таблицы через REST
@@ -56,7 +54,7 @@ export default REST = {
56
54
  * @param titles Это чтобы мы могли контроллить какие названия полей мы будет загружать при экспорте, чтобы они были как в таблице
57
55
  * @return Promise<object>
58
56
  */
59
- 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>> { },
57
+ 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>>,
60
58
 
61
59
  /**
62
60
  * Получить все записи по запросу [постранично]
@@ -64,7 +62,7 @@ export default REST = {
64
62
  * @param {object} params
65
63
  * @returns
66
64
  */
67
- 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>> { },
65
+ 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>>,
68
66
 
69
67
  /**
70
68
  * Получить одну запись по ID или по условию выборки [первая запись]
@@ -73,14 +71,14 @@ export default REST = {
73
71
  * @param {object|Array} fields
74
72
  * @param {string} primaryKeyName если указан ID, то указать название первичного ключа, если от id он отличается
75
73
  */
76
- one<T>(table: string, IDOrWhere: number | string | object, extfields?: object | Array<string>, fields?: object | Array<string> | null, primaryKeyName?: string): Promise<T | null> { },
74
+ one<T>(table: string, IDOrWhere: number | string | object, extfields?: object | Array<string>, fields?: object | Array<string> | null, primaryKeyName?: string): Promise<T | null>,
77
75
 
78
76
  /**
79
77
  * Создать новую запись
80
78
  * @param table
81
79
  * @param values
82
80
  */
83
- create<T>(table: string, values: object, appendTo?: number | string | null, insertAfter?: number | string | null, insertFirst?: number | string | null): Promise<SavedObject<T>> { },
81
+ create<T>(table: string, values: object, appendTo?: number | string | null, insertAfter?: number | string | null, insertFirst?: number | string | null): Promise<SavedObject<T>>,
84
82
 
85
83
  /**
86
84
  * Удалить запись
@@ -88,7 +86,7 @@ export default REST = {
88
86
  * @param id
89
87
  * @param byFields Если указан, удаляет по этим параметрам
90
88
  */
91
- remove(table: string, id: number | string, byFields?: object): Promise<boolean | Array<any>> { },
89
+ remove(table: string, id: number | string, byFields?: object): Promise<boolean | Array<any>>,
92
90
 
93
91
  /**
94
92
  * Редактировать значения
@@ -96,20 +94,20 @@ export default REST = {
96
94
  * @param ID
97
95
  * @param values
98
96
  */
99
- edit<T>(table: string, ID: number | string, values: object, appendTo: number | string | null, insertAfter: number | string | null, insertFirst: number | string | null): Promise<SavedObject<T>> { },
97
+ edit<T>(table: string, ID: number | string, values: object, appendTo: number | string | null, insertAfter: number | string | null, insertFirst: number | string | null): Promise<SavedObject<T>>,
100
98
 
101
99
 
102
100
  /**
103
101
  * Получить схемы всех таблиц
104
102
  */
105
- getCRUDInfo(): object { },
103
+ getCRUDInfo(): object,
106
104
 
107
105
  /**
108
106
  * Авторизоваться
109
107
  * @param username
110
108
  * @param password
111
109
  */
112
- auth(username?: string, password?: string): Promise<Authorized> { },
110
+ auth(username?: string, password?: string): Promise<Authorized>,
113
111
 
114
112
  /**
115
113
  * Зарегистрироваться с этим логином и паролем
@@ -118,20 +116,20 @@ export default REST = {
118
116
  * @param password
119
117
  * @param name
120
118
  */
121
- signup(email: string | null, username: string | null, password: string, name: string | null): Promise<Authorized> { },
119
+ signup(email: string | null, username: string | null, password: string, name: string | null): Promise<Authorized>,
122
120
 
123
121
 
124
122
  /**
125
123
  * Выйти из системы
126
124
  */
127
- logout(): Promise<object> { },
125
+ logout(): Promise<object>,
128
126
 
129
127
  /**
130
128
  * Подготовить объект под загрузку: загрузить данные из элементов [type=file]
131
129
  * Работает ссылочно, меняя основной массив
132
130
  * @param values
133
131
  */
134
- prepare(values: any): Promise<any> { },
132
+ prepare(values: any): Promise<any>,
135
133
 
136
134
 
137
135
  /**
@@ -139,7 +137,7 @@ export default REST = {
139
137
  * @param object Заполняемый объект
140
138
  * @param values Аналогичный объект-источник данных
141
139
  */
142
- fillObject<T>(object: T, values: any): T { },
140
+ fillObject<T>(object: T, values: any): T,
143
141
 
144
142
  }
145
143
 
@@ -189,4 +187,8 @@ export type Authorized = {
189
187
  };
190
188
  errors: { [key: string]: any };
191
189
  token: string;
192
- }
190
+ }
191
+
192
+ declare const REST: IREST;
193
+
194
+ export default REST;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "flamerest",
3
- "version": "1.0.77",
3
+ "version": "1.0.78",
4
4
  "description": "",
5
5
  "main": "REST.js",
6
6
  "typings": "./REST.d.ts",