larapi 0.1.2 → 0.1.5

package/src/index.ts

@@ -1,8 +1,16 @@
 import Core from "./Core";
-import { TMethod, TParams } from "./types";
+import type {
+	TMethod,
+	TParams,
+	TListenerEvents
+} from "./types";
+import type {
+	Event
+} from "easy-event-emitter";
 import Http from "./Http";
 
 type TUser = {
+	id: number;
 	[index: string]: any;
 }
 
@@ -10,17 +18,18 @@ type TConfig = {
 	host: string;
 }
 
-class API extends Core {
+/** Laravel API Client */
+class API<USER extends TUser = TUser> extends Core {
 	private static instance = new API({
 		host: ''
 	});
-	private _user: TUser;
+	private _user: USER;
 		token?: string;
 
 	constructor(config: TConfig) {
 		super();
 		this.setHost(config.host);
-		this._user = {};
+		this._user = {} as USER;
 		this.init();
 
 		this.setToken = this.setToken.bind(this);
@@ -31,6 +40,10 @@ class API extends Core {
 		this.http = this.http.bind(this);
 		this.get = this.get.bind(this);
 		this.post = this.post.bind(this);
+		this.put = this.put.bind(this);
+		this.patch = this.patch.bind(this);
+		this.delete = this.delete.bind(this);
+		this.options = this.options.bind(this);
 		this.getUid = this.getUid.bind(this);
 		this.getUser = this.getUser.bind(this);
 	}
@@ -51,12 +64,28 @@ class API extends Core {
 		return this.http('POST', params).request();
 	}
 
+	public put(params: TParams): Http {
+		return this.http('PUT', params).request();
+	}
+
+	public patch(params: TParams): Http {
+		return this.http('PATCH', params).request();
+	}
+
+	public delete(params: TParams): Http {
+		return this.http('DELETE', params).request();
+	}
+
+	public options(params: TParams): Http {
+		return this.http('OPTIONS', params).request();
+	}
+
 	private init(): void {
 		if (typeof window === 'undefined') return;
 		const token = localStorage.getItem('token');
 		const strUser = localStorage.getItem('user');
 		if (strUser) {
-			const user: TUser = JSON.parse(strUser);
+			const user: USER = JSON.parse(strUser);
 			this.setUser(user);
 		}
 		if (token) {
@@ -64,6 +93,10 @@ class API extends Core {
 		}
 	}
 
+	public addListener(event: TListenerEvents, callback: (data: any) => void): Event {
+		return this.events.addListener(event, callback);
+	}
+
 	public setToken(token: string) {
 		if (typeof window === 'undefined') return;
 		localStorage.setItem('token', token);
@@ -75,10 +108,10 @@ class API extends Core {
 	}
 
 	public getUid(): number {
-		return 'id' in this._user ? Number(this._user.id) : 0;
+		return ('id' in this._user) ? Number(this._user.id) : 0;
 	}
 
-	public getUser(): TUser {
+	public getUser(): USER {
 		return this._user;
 	}
 
@@ -86,18 +119,18 @@ class API extends Core {
 		return this.getUid();
 	}
 
-	public get user(): TUser {
+	public get user(): USER {
 		return this.getUser();
 	}
 
-	public setUser(user: TUser) {
+	public setUser(user: USER) {
 		if (typeof window === 'undefined') return;
 		localStorage.setItem('user', JSON.stringify(user));
 		this._user = user;
 		this.events.emit('login', user);
 	}
 
-	public updateUser(user: TUser) {
+	public updateUser(user: USER) {
 		this.events.emit('update', this.user);
 		this.setUser({...this.user, ...user});
 	}
@@ -107,7 +140,7 @@ class API extends Core {
 		localStorage.removeItem('user');
 		localStorage.removeItem('token');
 		this.events.emit('logout', this.user);
-		this.setUser({});
+		this.setUser({} as USER);
 		this.setToken('');
 	}
 
@@ -127,6 +160,11 @@ class API extends Core {
 	public static getUser = this.instance.getUser;
 	public static user = this.instance.user;
 	public static uid = this.instance.uid;
+
+	/**
+	 * @deprecated The method should not be used
+	 */
+	public static deleteCacheGroup = this.instance.clearCacheGroup;
 }
 
 (globalThis as any).apiSetInitData = API.setInitData;

package/src/types.ts

@@ -16,7 +16,7 @@ export type TGroupsData = {
 	[index: string]: TData;
 }
 
-export type TMethod = 'GET' | 'POST';
+export type TMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
 
 export type TCacheControll = string | {
 	group: string;
@@ -44,4 +44,4 @@ export type TRequestParams = {
 	body?: string;
 }
 
-export type TListenerEvents = 'api-request-fail' | 'api-request-error' | 'api-request-complete' | 'login' | 'logout' | 'user-update';
+export type TListenerEvents = 'api-request-success' | 'api-request-fail' | 'api-request-error' | 'api-request-complete' | 'login' | 'logout' | 'user-update';

package/webpack.config.js

@@ -0,0 +1,32 @@
+const path = require('path');
+
+module.exports = {
+  entry: {
+	index: '/src/index.ts',
+  },
+  target: 'web',
+  mode: 'production', //production | development
+  devtool: "source-map",
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: [
+			'ts-loader'
+		],
+        exclude: /node_modules/,
+      }
+    ],
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+  },
+
+  output: {
+    filename: '[name].js',
+    path: path.resolve(__dirname, 'dist'),
+	library: 'API',
+	libraryTarget: 'umd',
+	auxiliaryComment: 'API client for laravel'
+  }
+};

package/lib/Core.js

@@ -1,149 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const easy_event_emitter_1 = __importDefault(require("easy-event-emitter"));
-class Core {
-    constructor(context) {
-        Object.defineProperty(this, "cache", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "initData", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "events", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "host", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.events = new easy_event_emitter_1.default();
-        this.host = 'http://127.0.0.1/';
-        this.cache = {};
-        this.initData = {};
-        this.setHost = this.setHost.bind(this);
-        this.addListener = this.addListener.bind(this);
-        this.setInitData = this.setInitData.bind(this);
-        this.clearCacheGroup = this.clearCacheGroup.bind(this);
-        Object.assign(this, context);
-    }
-    addListener(event, callback) {
-        return this.events.addListener(event, callback);
-    }
-    getCache(key) {
-        if (this.cache[key]) {
-            if ((new Date()).getTime() <= (this.cache[key].time + 3600000000)) {
-                return this.cache[key].data;
-            }
-            else {
-                delete this.cache[key];
-            }
-        }
-    }
-    isJsonString(str) {
-        try {
-            JSON.parse(str);
-        }
-        catch (e) {
-            return false;
-        }
-        return true;
-    }
-    setHost(host) {
-        this.host = host;
-    }
-    setCache(key, data, group) {
-        this.cache[key] = {
-            time: (new Date()).getTime(),
-            data: data,
-            group: group
-        };
-    }
-    clearCacheGroup(group, data, fieldKey = 'id') {
-        if (data) {
-            const clear = (cacheData) => {
-                if ((fieldKey && (cacheData === null || cacheData === void 0 ? void 0 : cacheData[fieldKey]) === (data === null || data === void 0 ? void 0 : data[fieldKey])) || fieldKey === null) {
-                    for (const key in cacheData) {
-                        if (key in data) {
-                            return false;
-                        }
-                    }
-                }
-                return true;
-            };
-            for (const key in this.cache) {
-                if (this.cache[key].group === group) {
-                    if (Array.isArray(this.cache[key].data)) {
-                        this.cache[key].data = Object.values(this.cache[key].data).filter(clear);
-                    }
-                    else {
-                        if (!clear(this.cache[key].data))
-                            delete this.cache[key];
-                    }
-                }
-            }
-        }
-        else {
-            for (const key in this.cache) {
-                if (this.cache[key].group === group) {
-                    delete this.cache[key];
-                }
-            }
-        }
-    }
-    updateCacheGroup(group, data, fieldKey = 'id') {
-        const update = (cacheData) => {
-            const retData = cacheData;
-            for (const key of fieldKey.split('.')) {
-                cacheData = cacheData[key];
-            }
-            if ((fieldKey && cacheData[fieldKey] === data[fieldKey]) || fieldKey === null) {
-                for (const key in cacheData) {
-                    if (key in data) {
-                        cacheData[key] = data[key];
-                    }
-                }
-            }
-            return retData;
-        };
-        for (const key in this.cache) {
-            if (this.cache[key].group === group) {
-                if (Array.isArray(this.cache[key].data)) {
-                    this.cache[key].data = Object.values(this.cache[key].data).map(update);
-                }
-                else {
-                    this.cache[key].data = update(this.cache[key].data);
-                }
-            }
-        }
-    }
-    getCacheByIndex(index) {
-        return this.cache[index];
-    }
-    deleteCache(key) {
-        if (!this.cache[key])
-            return;
-        const group = this.cache[key].group;
-        if (group) {
-            this.clearCacheGroup(group);
-        }
-        delete this.cache[key];
-    }
-    setInitData(data) {
-        this.initData = data;
-    }
-}
-exports.default = Core;

package/lib/Http.js

@@ -1,212 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-//@ts-ignore
-const md5_1 = __importDefault(require("md5"));
-const Core_1 = __importDefault(require("./Core"));
-class Http extends Core_1.default {
-    constructor(method, params, context) {
-        super(context);
-        Object.defineProperty(this, "cacheIndex", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "currentCache", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "requestParams", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "method", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "params", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "path", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.cacheIndex = '';
-        this.method = method;
-        this.params = params;
-        this.path = this.params.path;
-        this.requestParams = {
-            method: this.method
-        };
-        this.success = this.success.bind(this);
-        this.fail = this.fail.bind(this);
-        this.error = this.error.bind(this);
-        this.complete = this.complete.bind(this);
-        this.request = this.request.bind(this);
-        this.addListener = this.addListener.bind(this);
-        this.addHeader = this.addHeader.bind(this);
-        this.deleteHeader = this.deleteHeader.bind(this);
-        this.initRequest();
-        this.initCache();
-    }
-    initRequest() {
-        this.requestParams.headers = {
-            'Accept': 'application/json',
-            'Content-Type': 'application/json'
-        };
-        this.params.data = this.params.data ? this.cuteUndifinedParams(this.params.data) : this.params.data;
-        if (this.method === 'GET') {
-            if (this.params.data)
-                this.path = this.params.path + '?' + this.encodeUrlParams(this.params.data);
-        }
-        if (this.method === 'POST') {
-            this.requestParams.body = JSON.stringify(this.params.data);
-        }
-    }
-    initCache() {
-        var _a;
-        this.cacheIndex = (0, md5_1.default)(this.path + JSON.stringify(this.params.data));
-        if (this.params.globalName) {
-            if (this.initData[this.params.globalName]) {
-                this.setCache(this.cacheIndex, this.initData[this.params.globalName], (typeof this.params.cache === 'boolean' ? undefined : this.params.cache));
-                this.params.cache = (_a = this.params.cache) !== null && _a !== void 0 ? _a : true;
-                delete this.initData[this.params.globalName];
-            }
-        }
-        if (this.params.cache) {
-            if (this.currentCache = this.getCache(this.cacheIndex)) {
-                this.success(this.currentCache);
-                this.complete(this.currentCache);
-            }
-        }
-        else {
-            this.deleteCache(this.cacheIndex);
-        }
-    }
-    //Заголовки от 200 до 299
-    success(...args) {
-        if (typeof this.params.success === 'function')
-            this.params.success(...args);
-        if (this.params.cacheUpdate && this.params.data) {
-            this.updateCacheGroup(typeof this.params.cacheUpdate === 'string' ? this.params.cacheUpdate : this.params.cacheUpdate.group, this.params.data, typeof this.params.cacheUpdate === 'string' ? undefined : this.params.cacheUpdate.fieldKey);
-        }
-        if (this.params.cacheClear && this.params.data) {
-            this.clearCacheGroup(typeof this.params.cacheClear === 'string' ? this.params.cacheClear : this.params.cacheClear.group, this.params.data, typeof this.params.cacheClear === 'string' ? undefined : this.params.cacheClear.fieldKey);
-        }
-    }
-    //Заголовки от 400 до 499
-    fail(...args) {
-        if (typeof this.params.fail === 'function') {
-            this.params.fail(...args);
-        }
-        this.events.emit('api-request-fail', args);
-    }
-    //Все остальные
-    error(...args) {
-        if (typeof this.params.error === 'function') {
-            this.params.error(...args);
-        }
-        this.events.emit('api-request-error', args);
-    }
-    complete(...args) {
-        if (typeof this.params.complete === 'function') {
-            this.params.complete(...args);
-        }
-        this.events.emit('api-request-complete', args);
-    }
-    encodeUrlParams(data) {
-        return Object.keys(data).map(function (k) {
-            return encodeURIComponent(k) + "=" + encodeURIComponent(data[k]);
-        }).join('&');
-    }
-    cuteUndifinedParams(data) {
-        if (typeof data !== 'object') {
-            return;
-        }
-        for (const key in data) {
-            if (!data[key]) {
-                delete data[key];
-            }
-        }
-        return data;
-    }
-    request() {
-        if (typeof XMLHttpRequest === 'undefined' || this.currentCache)
-            return this;
-        try {
-            const xhr = new XMLHttpRequest();
-            xhr.open(this.method, this.host + this.path, true);
-            for (const header in this.requestParams.headers) {
-                xhr.setRequestHeader(header, this.requestParams.headers[header]);
-            }
-            xhr.onreadystatechange = () => {
-                if (xhr.readyState !== 4) {
-                    return;
-                }
-                const result = this.isJsonString(xhr.responseText) ? JSON.parse(xhr.responseText) : {};
-                if (xhr.status >= 200 && xhr.status <= 299) {
-                    if (this.params.cache) {
-                        this.setCache(this.cacheIndex, result, (typeof this.params.cache === 'boolean' ? undefined : this.params.cache));
-                    }
-                    this.success(result);
-                }
-                else {
-                    if (xhr.status >= 400 && xhr.status <= 499) {
-                        this.fail(result);
-                    }
-                    this.error(result);
-                    console.warn(result);
-                }
-                this.complete(result);
-            };
-            xhr.send(this.requestParams.body);
-        }
-        catch (e) {
-            console.warn(e);
-            throw e;
-        }
-        return this;
-    }
-    addHeader(key, value) {
-        this.requestParams.headers = Object.assign(Object.assign({}, this.requestParams.headers), { [key]: value });
-        return this;
-    }
-    deleteHeader(key) {
-        if (this.requestParams.headers && (key in this.requestParams.headers)) {
-            delete this.requestParams.headers[key];
-        }
-        return this;
-    }
-    updateCache(data, fieldKey = 'id') {
-        const cache = this.getCacheByIndex(this.cacheIndex);
-        if (cache && cache.group) {
-            this.updateCacheGroup(cache.group, data, fieldKey);
-        }
-    }
-    clearCache(data, fieldKey = 'id') {
-        if (data) {
-            const cache = this.getCacheByIndex(this.cacheIndex);
-            if (cache && cache.group) {
-                this.clearCacheGroup(cache.group, data, fieldKey);
-            }
-        }
-        else {
-            this.deleteCache(this.cacheIndex);
-        }
-    }
-}
-exports.default = Http;