flamerest 1.0.125 → 1.0.126

package/README.md

@@ -18,6 +18,31 @@ import FLAMEREST from "flamerest";
 window.REST = new FLAMEREST('localhost');
 ```
 
+## Callbacks
+
+### Unauthorized Callback
+Обработка 401 ошибок (неавторизован):
+```javascript
+const rest = new FLAMEREST('https://api.example.com', undefined, () => {
+    // Пользователь не авторизован - перенаправляем на страницу входа
+    window.location.href = '/login';
+});
+```
+
+### Maintenance Callback
+Обработка 503 ошибок (сервер на обслуживании):
+```javascript
+const rest = new FLAMEREST('https://api.example.com', undefined, undefined, 'v1', (errorMessage) => {
+    // Сервер на обслуживании
+    if (errorMessage) {
+        alert(`Сервер временно недоступен: ${errorMessage}`);
+    } else {
+        alert('Сервер временно недоступен. Попробуйте позже.');
+    }
+    // Можно показать модальное окно с сообщением об обслуживании
+});
+```
+
 # Create and Update
 
 Just field list, but any field can be HTML Input [type=file], Clipboard object, DataTransfer [Drag&Drop/Clipboard] or FileList (automatically upload any of that)

package/REST.ts

@@ -39,6 +39,15 @@ export type CustomAnyRequest = BaseResponse<any>;
  */
 export type SavedObject<T> = BaseResponse<T>;
 
+/**
+ * Элемент баланса пользователя
+ */
+export interface BalanceItem {
+    name: string;
+    balance_decimal: string;
+    value: number;
+}
+
 /**
  * Результат авторизации
  */
@@ -51,12 +60,16 @@ export type Authorized = {
         lang: string,
         name: string,
         role: string,
-        user_hash?: string
+        user_hash?: string,
+        balance: 0,
+        balance_all: { [key: string]: BalanceItem },
     };
     errors: { [key: string]: any };
     token: string;
 }
 
+
+
 export class FLAMEREST {
 
     /**
@@ -74,6 +87,12 @@ export class FLAMEREST {
      */
     public unauthorized_callback: (() => void) | undefined;
 
+    /**
+     * Будет вызван, если сервер вернёт статус 503 (Service Unavailable / Maintenance)
+     * Может содержать сообщение об ошибке из JSON ответа
+     */
+    public maintenance_callback: ((errorMessage?: string) => void) | undefined;
+
     /**
      * Токен приложения конкретного клиента для отправки пуш уведомлений именно ему
      */
@@ -97,7 +116,15 @@ export class FLAMEREST {
     public token: string | null = null;
 
 
-    constructor(server_address?: string, localhost_endpoint?: string, unauthorized_callback?: () => void, version?: string) {
+    /**
+     * Конструктор класса FLAMEREST
+     * @param {string} server_address Адрес сервера (опционально)
+     * @param {string} localhost_endpoint Альтернативный адрес для localhost (опционально)
+     * @param {Function} unauthorized_callback Колбек для обработки 401 ошибок (опционально)
+     * @param {string} version Версия API (по умолчанию 'v1')
+     * @param {Function} maintenance_callback Колбек для обработки 503 ошибок (опционально)
+     */
+    constructor(server_address?: string, localhost_endpoint?: string, unauthorized_callback?: () => void, version?: string, maintenance_callback?: (errorMessage?: string) => void) {
         if (typeof window === 'undefined') {
             // SSR: используем предоставленный адрес или дефолтный
             this.SERVER = server_address ?? "http://localhost/";
@@ -118,6 +145,7 @@ export class FLAMEREST {
         this.SERVER = this.SERVER.endsWith('/') ? this.SERVER.substring(0, this.SERVER.length - 1) : this.SERVER;
 
         this.unauthorized_callback = unauthorized_callback;
+        this.maintenance_callback = maintenance_callback;
         this.version = version ?? 'v1';
     }
 
@@ -141,7 +169,15 @@ export class FLAMEREST {
      * @param {boolean} isNeedToken нужен ли токен для запроса
      * @param {Object} customHeaders объект с доп заголовками, которые надо включить в запрос
      */
-    request(url: string, params: object | string | FormData, type: 'GET' | 'POST' | 'PUT' | 'DELETE' = 'GET', responseType: 'json' | 'blob' = 'json', isNeedToken = true, customHeaders: Record<string, string> = {}): Promise<BaseResponse<any> & Partial<Paginated>> {
+    async request(url: string, params: object | string | FormData, type: 'GET' | 'POST' | 'PUT' | 'DELETE' = 'GET', responseType: 'json' | 'blob' = 'json', isNeedToken = true, customHeaders: Record<string, string> = {}): Promise<BaseResponse<any> & Partial<Paginated>> {
+
+        // Подставляем сервер автоматом в запрос начинающийся с /
+        if (url[0] === '/' && url[1] !== '/') {
+            url = this.SERVER + url;
+        }
+
+        // Создаём подпись запроса до его модификации
+        const SIGN = await this._generateRequestSignature(url, params);
 
         // Нормализуем параметры, если они есть
         if (typeof params === "object" && params !== null) {
@@ -155,10 +191,6 @@ export class FLAMEREST {
             responseType = 'json';
         }
 
-        // Подставляем сервер автоматом в запрос начинающийся с /
-        if (url[0] === '/' && url[1] !== '/') {
-            url = this.SERVER + url;
-        }
 
         const that = this;
 
@@ -204,14 +236,7 @@ export class FLAMEREST {
                         requestBody.body = params;
                     }
 
-                    // Создаём подпись каждого запроса
-                    let SIGN = "empty";
-                    try {
-                        // Используем user_hash для подписи, если он есть
-                        SIGN = await this.hmac_sha256(requestBody.body, user_hash ?? "");
-                    } catch (ex) {
-                        // console.error('Can`t create a request sign');
-                    }
+                    // Добавляем подпись в заголовки
                     (requestBody.headers as any)['sign'] = SIGN;
 
                     // Делаем запрос
@@ -244,6 +269,16 @@ export class FLAMEREST {
                                         this.unauthorized_callback();
                                     }
                                     break;
+                                case 503:
+                                    // Обработка режима обслуживания (maintenance)
+                                    let maintenanceMessage: string | undefined = undefined;
+                                    if (ResolveBody.errors && typeof ResolveBody.errors === 'object' && 'error' in ResolveBody.errors) {
+                                        maintenanceMessage = (ResolveBody.errors as any).error;
+                                    }
+                                    if (typeof this.maintenance_callback === 'function') {
+                                        this.maintenance_callback(maintenanceMessage);
+                                    }
+                                    break;
                             }
                         } catch (exjson) {
                             ResolveBody.errors = await response.text();
@@ -776,6 +811,98 @@ export class FLAMEREST {
         return result;
     }
 
+    /**
+     * Вычисляет на лету детерминированную строку, которая будет использоваться как часть ключа для подписи.
+     * Ключ генерируется на основе последовательности числовых преобразований, что делает его неочевидным
+     * при статическом анализе кода. Этот метод всегда возвращает один и тот же результат.
+     * @returns {string} Детерминированно сгенерированная строка.
+     */
+    getDeterministicKeyPart(): string {
+        // Начальная последовательность чисел. Она может быть любой, главное - постоянной.
+        const sequence = [5, 12, 23, 8, 17, 3, 29, 14, 31, 2, 11, 28, 7, 20, 1, 16, 22, 5, 13, 19, 4, 25, 10, 30, 9, 21, 6, 18, 27, 15, 24, 26];
+        // "Магическое число" для усложнения преобразований.
+        const magicNumber = 177;
+        let result = '';
+
+        for (let i = 0; i < sequence.length; i++) {
+            const num = sequence[i];
+            let charCode;
+
+            // В зависимости от позиции применяем разные преобразования,
+            // чтобы получить символы в разных регистрах и цифры.
+            switch (i % 3) {
+                case 0:
+                    // Генерируем заглавную букву (A-Z)
+                    charCode = (num * magicNumber + i) % 26;
+                    result += String.fromCharCode(65 + charCode);
+                    break;
+                case 1:
+                    // Генерируем строчную букву (a-z)
+                    charCode = (num + magicNumber * (i + 1)) % 26;
+                    result += String.fromCharCode(97 + charCode);
+                    break;
+                case 2:
+                    // Генерируем цифру (0-9)
+                    charCode = (num * (i + 1) + magicNumber) % 10;
+                    result += String.fromCharCode(48 + charCode);
+                    break;
+            }
+        }
+        return result;
+    }
+
+    /**
+     * Создаёт подпись для запроса на основе его параметров, используя лучшие практики.
+     * Собирает все GET и POST параметры, сортирует их и формирует каноническую строку для хеширования.
+     * @param url URL запроса, включая GET-параметры.
+     * @param params POST-параметры запроса (в виде объекта).
+     * @returns Promise<string> Строка подписи.
+     */
+    private async _generateRequestSignature(url: string, params: object | string | FormData): Promise<string> {
+        const secretKey = (this.token ?? '') + this.getDeterministicKeyPart();
+
+        // Если параметры - это FormData или не объект, мы не можем их надежно обработать для подписи.
+        // В этом случае подписываем пустую строку, как и раньше.
+        if (params instanceof FormData || typeof params !== 'object' || params === null) {
+            return this.hmac_sha256('', secretKey);
+        }
+
+        const allParams: { [key: string]: any } = {};
+
+        // 1. Извлекаем GET-параметры из URL
+        if (url.includes('?')) {
+            const queryString = url.split('?')[1];
+            const urlParams = new URLSearchParams(queryString);
+            urlParams.forEach((value, key) => {
+                allParams[key] = value;
+            });
+        }
+
+        // 2. Добавляем POST-параметры из тела запроса
+        Object.assign(allParams, params);
+
+        // 3. Создаём каноническую строку
+        // Сортируем ключи для консистентности
+        const sortedKeys = Object.keys(allParams).sort();
+        
+        // Формируем строку вида "key1=value1&key2=value2..."
+        const canonicalString = sortedKeys
+            .map(key => {
+                const value = allParams[key];
+                // Пропускаем null и undefined значения, они не участвуют в подписи
+                if (value === null || value === undefined) {
+                    return '';
+                }
+                // Если значение - объект (включая массив), заменяем его на слово "object" для консистентности подписи.
+                const stringValue = (typeof value === 'object' && value !== null) ? 'object' : String(value);
+                return `${encodeURIComponent(key)}=${encodeURIComponent(stringValue)}`;
+            })
+            .filter(part => part !== '') // Убираем пустые части
+            .join('&');
+            
+        return this.hmac_sha256(canonicalString, secretKey);
+    }
+
     /**
      *
      * @param {string} data
@@ -797,12 +924,13 @@ export class FLAMEREST {
         if (typeof window === 'undefined') {
             // Динамически импортируем модуль 'crypto' для Node.js, чтобы избежать ошибок на фронтенде,
             // где этот модуль недоступен.
+            // @ts-ignore
             const { createHmac } = await import('crypto');
             const hash = createHmac('sha256', key).update(data).digest('hex');
             return Promise.resolve(hash);
         } else {
 
-            if (typeof window.crypto?.subtle === 'undefined') throw new Error("Can`t create hash");
+            if (typeof window.crypto?.subtle === 'undefined') return Promise.resolve("");
 
             return window.crypto.subtle
                 .importKey(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flamerest",
-  "version": "1.0.125",
+  "version": "1.0.126",
   "description": "",
   "main": "./REST.ts",
   "typings": "./REST.ts",