@selfcommunity/utils 0.1.7 → 0.1.8-alpha.0

package/lib/esm/utils/url.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Utility Url Replacer
+ * @param path
+ */
+export declare const urlReplacer: (path: string) => (params: object) => any;
+/**
+ * Get domain
+ * @param url
+ */
+export declare const getDomain: (url: string) => string;
+/**
+ * Check a str is a valid url pattern
+ * @param url
+ */
+export declare const isValidUrl: (url: string) => boolean;
+/**
+ * Check a str is a valid list of urls separated by delimiter
+ * @param value
+ * @param delimiter
+ */
+export declare const isValidUrls: (value: string, delimiter: string) => boolean;
+/**
+ * Append params
+ * @param baseUrl
+ * @param queryParams
+ */
+export declare function appendURLSearchParams(baseUrl: string, queryParams: Record<string, string | number>[]): string;
+/**
+ * Take the application server's public key, which is Base64 URL-safe encoded,
+ * and convert it to a UInt8Array, because this is the expected input of the subscribe()
+ */
+export declare const urlB64ToUint8Array: (base64String: any) => Uint8Array;
+//# sourceMappingURL=url.d.ts.map

package/lib/esm/utils/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../src/utils/url.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,WAAW,SAAU,MAAM,cAWtB,MAAM,QACvB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,SAAS,QAAS,MAAM,KAAG,MAOvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,KAAG,OAGxC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,UAAW,MAAM,aAAa,MAAM,KAAG,OAG9D,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,UAWpG;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,mCAW9B,CAAC"}

package/lib/esm/utils/url.js

@@ -1,112 +1,78 @@
-"use strict";
-
-exports.__esModule = true;
-exports.appendURLSearchParams = appendURLSearchParams;
-exports.urlReplacer = exports.urlB64ToUint8Array = exports.isValidUrls = exports.isValidUrl = exports.getDomain = void 0;
-
 /**
  * Utility Url Replacer
  * @param path
  */
-const urlReplacer = path => {
-  const replacer = function replacer(tpl, data) {
-    const re = /\$\(([^)]+)?\)/g;
-    let match = re.exec(tpl);
-
-    while (match) {
-      tpl = tpl.replace(match[0], data[match[1]]);
-      re.lastIndex = 0;
-      match = re.exec(tpl);
-    }
-
-    return tpl;
-  };
-
-  return params => replacer(path, params);
+export const urlReplacer = (path) => {
+    const replacer = function (tpl, data) {
+        const re = /\$\(([^)]+)?\)/g;
+        let match = re.exec(tpl);
+        while (match) {
+            tpl = tpl.replace(match[0], data[match[1]]);
+            re.lastIndex = 0;
+            match = re.exec(tpl);
+        }
+        return tpl;
+    };
+    return (params) => replacer(path, params);
 };
 /**
  * Get domain
  * @param url
  */
-
-
-exports.urlReplacer = urlReplacer;
-
-const getDomain = url => {
-  // eslint-disable-next-line no-useless-escape,@typescript-eslint/prefer-regexp-exec
-  const matches = url.match(/^https?\:\/\/([^\/?#]+)(?:[\/?#]|$)/i);
-
-  if (matches && matches[1]) {
-    return matches[1];
-  }
-
-  return '';
+export const getDomain = (url) => {
+    // eslint-disable-next-line no-useless-escape,@typescript-eslint/prefer-regexp-exec
+    const matches = url.match(/^https?\:\/\/([^\/?#]+)(?:[\/?#]|$)/i);
+    if (matches && matches[1]) {
+        return matches[1];
+    }
+    return '';
 };
 /**
  * Check a str is a valid url pattern
  * @param url
  */
-
-
-exports.getDomain = getDomain;
-
-const isValidUrl = url => {
-  const regexp = /(ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-/]))?/;
-  return regexp.test(url);
+export const isValidUrl = (url) => {
+    const regexp = /(ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-/]))?/;
+    return regexp.test(url);
 };
 /**
  * Check a str is a valid list of urls separated by delimiter
  * @param value
  * @param delimiter
  */
-
-
-exports.isValidUrl = isValidUrl;
-
-const isValidUrls = (value, delimiter) => {
-  const urls = value.trim().split(delimiter);
-  return urls.every(isValidUrl);
+export const isValidUrls = (value, delimiter) => {
+    const urls = value.trim().split(delimiter);
+    return urls.every(isValidUrl);
 };
 /**
  * Append params
  * @param baseUrl
  * @param queryParams
  */
-
-
-exports.isValidUrls = isValidUrls;
-
-function appendURLSearchParams(baseUrl, queryParams) {
-  let _url = baseUrl;
-
-  if (queryParams.length && _url) {
-    const key = Object.keys(queryParams[0])[0];
-    _url += (_url.split('?')[1] ? '&' : '?') + `${key}=${queryParams[0][key]}`;
-    queryParams.slice(1).map(p => {
-      const key = Object.keys(p)[0];
-      _url += `&${key}=${p[key]}`;
-    });
-  }
-
-  return _url;
+export function appendURLSearchParams(baseUrl, queryParams) {
+    let _url = baseUrl;
+    if (queryParams.length && _url) {
+        const key = Object.keys(queryParams[0])[0];
+        _url += (_url.split('?')[1] ? '&' : '?') + `${key}=${queryParams[0][key]}`;
+        queryParams.slice(1).map((p) => {
+            const key = Object.keys(p)[0];
+            _url += `&${key}=${p[key]}`;
+        });
+    }
+    return _url;
 }
 /**
  * Take the application server's public key, which is Base64 URL-safe encoded,
  * and convert it to a UInt8Array, because this is the expected input of the subscribe()
  */
-
-
-const urlB64ToUint8Array = base64String => {
-  const padding = '='.repeat((4 - base64String.length % 4) % 4);
-  const base64 = (base64String + padding).replace(/-/g, '+').replace(/_/g, '/');
-  const rawData = window.atob(base64);
-  const outputArray = new Uint8Array(rawData.length);
-
-  for (let i = 0; i < rawData.length; ++i) {
-    outputArray[i] = rawData.charCodeAt(i);
-  }
-
-  return outputArray;
+export const urlB64ToUint8Array = (base64String) => {
+    const padding = '='.repeat((4 - (base64String.length % 4)) % 4);
+    const base64 = (base64String + padding).replace(/-/g, '+').replace(/_/g, '/');
+    const rawData = window.atob(base64);
+    const outputArray = new Uint8Array(rawData.length);
+    for (let i = 0; i < rawData.length; ++i) {
+        outputArray[i] = rawData.charCodeAt(i);
+    }
+    return outputArray;
 };
-
-exports.urlB64ToUint8Array = urlB64ToUint8Array;
+//# sourceMappingURL=url.js.map

package/lib/esm/utils/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../src/utils/url.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE;IAC1C,MAAM,QAAQ,GAAG,UAAU,GAAG,EAAE,IAAI;QAClC,MAAM,EAAE,GAAG,iBAAiB,CAAC;QAC7B,IAAI,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,OAAO,KAAK,EAAE;YACZ,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,EAAE,CAAC,SAAS,GAAG,CAAC,CAAC;YACjB,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACtB;QACD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IACF,OAAO,CAAC,MAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAU,EAAE;IAC/C,mFAAmF;IACnF,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAClE,IAAI,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE;QACzB,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;KACnB;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAW,EAAW,EAAE;IACjD,MAAM,MAAM,GAAG,kFAAkF,CAAC;IAClG,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,SAAiB,EAAW,EAAE;IACvE,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AAChC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAe,EAAE,WAA8C;IACnG,IAAI,IAAI,GAAG,OAAO,CAAC;IACnB,IAAI,WAAW,CAAC,MAAM,IAAI,IAAI,EAAE;QAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3E,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC7B,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9B,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,YAAY,EAAE,EAAE;IACjD,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAE9E,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,WAAW,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACvC,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;KACxC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC"}

package/lib/esm/utils/websocket.d.ts

@@ -0,0 +1,177 @@
+/**
+ * WSClientPropTypes interface
+ */
+export interface WSClientPropTypes {
+    /**
+     * The Websocket URI
+     */
+    uri: string;
+    /**
+     * The Websocket Protocols
+     */
+    protocols: string | string[];
+    /**
+     * String to identify the heartbeat message.
+     */
+    heartbeatMsg?: string;
+    /**
+     * Reconnect the websocket if close
+     */
+    mustReconnect?: boolean;
+    /**
+     * Callback called after the websocket is connected.
+     */
+    connected?: () => any;
+    /**
+     * Callback called when the websocket is connecting.
+     */
+    connecting?: () => any;
+    /**
+     * Callback called after the websocket is disconnected.
+     */
+    disconnected?: (evt: any) => any;
+    /**
+     * Callback called when a message is received from the websocket.
+     */
+    receiveMessage?: (data: any) => any;
+    /**
+     * Enable/disable debug
+     */
+    debug?: boolean;
+}
+export interface WSClientType {
+    /**
+     * Send message
+     * @param message
+     */
+    sendMessage: (message: any) => void;
+    /**
+     * Get current state
+     */
+    getState: () => string;
+    /**
+     * Get current connection state
+     */
+    isConnecting: () => boolean;
+    /**
+     * Check if ws is connected
+     */
+    isConnected: () => boolean;
+    /**
+     * Check if ws is closing connection
+     */
+    isClosing: () => boolean;
+    /**
+     * Return if ws is closed
+     */
+    isClosed: () => boolean;
+    /**
+     * Close the connection
+     */
+    close: () => void;
+}
+/**
+ * WSClient: manage socket connection
+ * @param options
+ * @constructor
+ */
+export default class WSClient implements WSClientType {
+    private static _instance;
+    private _cfg;
+    private _ws;
+    private _timer;
+    private _attempts;
+    private _heartbeatInterval;
+    private _missedHeartbeats;
+    /**
+     * Constructor
+     * @param cfg
+     */
+    constructor(cfg: WSClientPropTypes);
+    /**
+     * Get instance
+     */
+    static getInstance(cfg: any): WSClient;
+    /**
+     * Connect
+     */
+    connect(): void;
+    /**
+     * Validate options
+     * @param cfg
+     */
+    isValidOptions(cfg: WSClientPropTypes): boolean;
+    /**
+     * Try to reconnect if previous connection failed
+     * Generate an interval, after that try to reconnect
+     */
+    tryToReconnect(): void;
+    /**
+     * Reestablish the connection
+     * Increase the number of attempts
+     */
+    reconnect(): void;
+    /**
+     * Send heartbeat every 5 seconds
+     * If missing more than 3 heartbeats close connection
+     */
+    sendHeartbeat(): void;
+    /**
+     * Established the new connection
+     * Reset this._attempts counter
+     */
+    onOpen(): void;
+    /**
+     * Connection closed. Try to reconnect.
+     * @param evt
+     */
+    onClose(evt: any): void;
+    /**
+     * An error occured
+     * @param evt
+     */
+    onError(evt: any): void;
+    /**
+     * A message has arrived.
+     * If it is the heartbeat -> reset this._missedHeartbeats
+     * If it is data pass data to the callback
+     * @param evt
+     */
+    onMessage(evt: any): any;
+    /**
+     * Generate an interval that is randomly between 0 and 2^k - 1, where k is
+     * the number of connection attmpts, with a maximum interval of 30 seconds,
+     * so it starts at 0 - 1 seconds and maxes out at 0 - 30 seconds
+     */
+    generateInteval(k: any): number;
+    /**
+     * Send message
+     * @param message
+     */
+    sendMessage(message: any): void;
+    /**
+     * Get the ws state
+     */
+    getState(): any;
+    /**
+     * Check if ws is in connecting state
+     */
+    isConnecting(): boolean;
+    /**
+     * Check if ws is connected
+     */
+    isConnected(): boolean;
+    /**
+     * Check if ws is in closing state
+     */
+    isClosing(): boolean;
+    /**
+     * Check if ws is closed
+     */
+    isClosed(): boolean;
+    /**
+     * Close the connection
+     */
+    close(): void;
+}
+//# sourceMappingURL=websocket.d.ts.map

package/lib/esm/utils/websocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../../../src/utils/websocket.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE7B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,KAAA,KAAK,GAAG,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,IAAI,KAAA,KAAK,GAAG,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,WAAW,EAAE,CAAC,OAAO,KAAA,KAAK,IAAI,CAAC;IAE/B;;OAEG;IACH,QAAQ,EAAE,MAAM,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,OAAO,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,YAAW,YAAY;IACnD,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;IACzB,OAAO,CAAC,IAAI,CAAC;IACb,OAAO,CAAC,GAAG,CAAC;IACZ,OAAO,CAAC,MAAM,CAAC;IACf,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,iBAAiB,CAAK;IAE9B;;;OAGG;gBACS,GAAG,EAAE,iBAAiB;IAQlC;;OAEG;WACW,WAAW,CAAC,GAAG,KAAA,GAAG,QAAQ;IAKxC;;OAEG;IACH,OAAO;IAyBP;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,iBAAiB;IAqCrC;;;OAGG;IACH,cAAc;IAQd;;;OAGG;IACH,SAAS;IAKT;;;OAGG;IACH,aAAa;IAeb;;;OAGG;IACH,MAAM;IAUN;;;OAGG;IACH,OAAO,CAAC,GAAG,KAAA;IAMX;;;OAGG;IACH,OAAO,CAAC,GAAG,KAAA;IAKX;;;;;OAKG;IACH,SAAS,CAAC,GAAG,KAAA;IASb;;;;OAIG;IACH,eAAe,CAAC,CAAC,KAAA;IAUjB;;;OAGG;IACI,WAAW,CAAC,OAAO,KAAA;IAI1B;;OAEG;IACI,QAAQ;IAIf;;OAEG;IACI,YAAY;IAInB;;OAEG;IACI,WAAW;IAIlB;;OAEG;IACI,SAAS;IAIhB;;OAEG;IACI,QAAQ;IAIf;;OAEG;IACI,KAAK;CAQb"}