flamerest 1.0.77 → 1.0.79

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 (3) hide show
  1. package/REST.d.ts +28 -20
  2. package/REST.js +7 -2
  3. 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,13 @@ export default REST = {
25
23
  /**
26
24
  * Будет вызван, если любой из запросов вернут требование авторизоваться
27
25
  */
28
- unauthorized_callback: function () { },
26
+ unauthorized_callback: () => {},
27
+
28
+ /**
29
+ * Токен приложения конкретного клиента для отправки пуш уведомлений именно ему
30
+ */
31
+ pushNotificationToken: string | null;
32
+
29
33
 
30
34
  /**
31
35
  * Стандартное число запросов на страницу
@@ -40,7 +44,7 @@ export default REST = {
40
44
  * @param {string} type Тип
41
45
  * @param {string} responseType Тип ответа: json или blob
42
46
  */
43
- request(url: string, params: object | string, type?: string, responseType?: string): object { },
47
+ request(url: string, params: object | string, type?: string, responseType?: string): object,
44
48
 
45
49
  /**
46
50
  * Получить выборку из таблицы через REST
@@ -56,7 +60,7 @@ export default REST = {
56
60
  * @param titles Это чтобы мы могли контроллить какие названия полей мы будет загружать при экспорте, чтобы они были как в таблице
57
61
  * @return Promise<object>
58
62
  */
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>> { },
63
+ 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
64
 
61
65
  /**
62
66
  * Получить все записи по запросу [постранично]
@@ -64,7 +68,7 @@ export default REST = {
64
68
  * @param {object} params
65
69
  * @returns
66
70
  */
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>> { },
71
+ 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
72
 
69
73
  /**
70
74
  * Получить одну запись по ID или по условию выборки [первая запись]
@@ -73,14 +77,14 @@ export default REST = {
73
77
  * @param {object|Array} fields
74
78
  * @param {string} primaryKeyName если указан ID, то указать название первичного ключа, если от id он отличается
75
79
  */
76
- one<T>(table: string, IDOrWhere: number | string | object, extfields?: object | Array<string>, fields?: object | Array<string> | null, primaryKeyName?: string): Promise<T | null> { },
80
+ one<T>(table: string, IDOrWhere: number | string | object, extfields?: object | Array<string>, fields?: object | Array<string> | null, primaryKeyName?: string): Promise<T | null>,
77
81
 
78
82
  /**
79
83
  * Создать новую запись
80
84
  * @param table
81
85
  * @param values
82
86
  */
83
- create<T>(table: string, values: object, appendTo?: number | string | null, insertAfter?: number | string | null, insertFirst?: number | string | null): Promise<SavedObject<T>> { },
87
+ create<T>(table: string, values: object, appendTo?: number | string | null, insertAfter?: number | string | null, insertFirst?: number | string | null): Promise<SavedObject<T>>,
84
88
 
85
89
  /**
86
90
  * Удалить запись
@@ -88,7 +92,7 @@ export default REST = {
88
92
  * @param id
89
93
  * @param byFields Если указан, удаляет по этим параметрам
90
94
  */
91
- remove(table: string, id: number | string, byFields?: object): Promise<boolean | Array<any>> { },
95
+ remove(table: string, id: number | string, byFields?: object): Promise<boolean | Array<any>>,
92
96
 
93
97
  /**
94
98
  * Редактировать значения
@@ -96,20 +100,20 @@ export default REST = {
96
100
  * @param ID
97
101
  * @param values
98
102
  */
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>> { },
103
+ 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
104
 
101
105
 
102
106
  /**
103
107
  * Получить схемы всех таблиц
104
108
  */
105
- getCRUDInfo(): object { },
109
+ getCRUDInfo(): object,
106
110
 
107
111
  /**
108
112
  * Авторизоваться
109
113
  * @param username
110
114
  * @param password
111
115
  */
112
- auth(username?: string, password?: string): Promise<Authorized> { },
116
+ auth(username?: string, password?: string): Promise<Authorized>,
113
117
 
114
118
  /**
115
119
  * Зарегистрироваться с этим логином и паролем
@@ -118,20 +122,20 @@ export default REST = {
118
122
  * @param password
119
123
  * @param name
120
124
  */
121
- signup(email: string | null, username: string | null, password: string, name: string | null): Promise<Authorized> { },
125
+ signup(email: string | null, username: string | null, password: string, name: string | null, pushNotificationToken: string | null): Promise<Authorized>,
122
126
 
123
127
 
124
128
  /**
125
129
  * Выйти из системы
126
130
  */
127
- logout(): Promise<object> { },
131
+ logout(): Promise<object>,
128
132
 
129
133
  /**
130
134
  * Подготовить объект под загрузку: загрузить данные из элементов [type=file]
131
135
  * Работает ссылочно, меняя основной массив
132
136
  * @param values
133
137
  */
134
- prepare(values: any): Promise<any> { },
138
+ prepare(values: any): Promise<any>,
135
139
 
136
140
 
137
141
  /**
@@ -139,7 +143,7 @@ export default REST = {
139
143
  * @param object Заполняемый объект
140
144
  * @param values Аналогичный объект-источник данных
141
145
  */
142
- fillObject<T>(object: T, values: any): T { },
146
+ fillObject<T>(object: T, values: any): T,
143
147
 
144
148
  }
145
149
 
@@ -189,4 +193,8 @@ export type Authorized = {
189
193
  };
190
194
  errors: { [key: string]: any };
191
195
  token: string;
192
- }
196
+ }
197
+
198
+ declare const REST: IREST;
199
+
200
+ export default REST;
package/REST.js CHANGED
@@ -25,6 +25,11 @@ class FLAMEREST {
25
25
  */
26
26
  this.unauthorized_callback = unauthorized_callback;
27
27
 
28
+ /**
29
+ * Токен приложения конкретного клиента для отправки пуш уведомлений именно ему
30
+ */
31
+ this.pushNotificationToken = null;
32
+
28
33
  /**
29
34
  * Версия api
30
35
  */
@@ -499,9 +504,9 @@ class FLAMEREST {
499
504
 
500
505
  }
501
506
 
502
- async signup(email, username, password, name) {
507
+ async signup(email, username, password, name, pushNotificationToken) {
503
508
 
504
- let resp = await this.request(this.SERVER + '/auth/signup', JSON.stringify({ login: username, email: email, password: password, name: name }), 'POST', 'json', false);
509
+ let resp = await this.request(this.SERVER + '/auth/signup', JSON.stringify({ login: username, email: email, password: password, name: name, pushNotificationToken: (pushNotificationToken ?? this.pushNotificationToken ?? null) }), 'POST', 'json', false);
505
510
 
506
511
  if (resp.errors) return resp;
507
512
  if (resp.data.length === 0) { resp.errors = []; return resp; }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "flamerest",
3
- "version": "1.0.77",
3
+ "version": "1.0.79",
4
4
  "description": "",
5
5
  "main": "REST.js",
6
6
  "typings": "./REST.d.ts",