akeyless-client-commons 1.1.6 → 1.1.8

package/dist/helpers/index.d.mts

@@ -3,7 +3,7 @@ import { FirebaseStorage } from 'firebase/storage';
 import { Auth, GoogleAuthProvider, User } from 'firebase/auth';
 import { AppCheck } from 'firebase/app-check';
 import { WhereFilterOp, Unsubscribe, Firestore, CollectionReference, DocumentData, Timestamp, DocumentSnapshot } from 'firebase/firestore';
-import { TObject, NxUser, CountryOptions, LanguageOptions, UserPermissionsObject, userPermissionsObjectValue, Client } from 'akeyless-types-commons';
+import { TObject, NxUser, CountryOptions, LanguageOptions, UserPermissionsObject, userPermissionsObjectValue, Client, RedisUpdateType, RedisUpdatePayload, SocketCallbackResponse } from 'akeyless-types-commons';
 import React, { Dispatch, SetStateAction } from 'react';
 import { ClassValue } from 'clsx';
 
@@ -31,6 +31,8 @@ interface OnSnapshotConfig extends OnSnapshotParsers {
         fieldName: string;
         direction: "asc" | "desc";
     }[];
+    parseAs?: "object" | "array";
+    subscribeTo?: "cache" | "db";
 }
 interface OnSnapshotConfigDocument extends Omit<OnSnapshotParsers, "onAdd"> {
     collectionName: string;
@@ -258,4 +260,36 @@ declare const initializeUserPermissions: ({ phoneNumber, email, firstTimeArray,
     permissions: TObject<TObject<boolean>>;
 }>;
 
-export { type ValidationType, addAuditRecord, addLoginAudit, add_document, addressRegex, akeylessOnlineDomain, app, appCheck, auth, baseDomain, biDomain, calculateBearing, callCenterEventsDomain, callCenterGeoDomain, carsRegex, chartsRegex, checkUserPermissions, cleanNxSites, cn, collections, colorRegex, createSelectors, db, delete_document, devicesDomain, displayFormatPhoneNumber, durationToSeconds, emailRegex, extractAlertsData, extractBoardsData, extractCanbusData, extractCarsData, extractClientData, extractLocationData, extractSiteData, fire_base_TIME_TEMP, formatCarNumber, getAddressByGeo, getFixedNumber, getFormCheckboxValue, getFormElementValue, getLocationUrl, getUserByEmail, getUserByIdentifier, getUserByPhone, getUserCountryByIp, get_all_documents, get_document_by_id, get_international_phone_number, googleLoginProvider, handleChange, handleInvalid, handlePaste, initializeUserPermissions, international_israel_phone_format, isInternational, isInternationalIsraelPhone, isLocal, isNodeEnv, is_iccid, local_israel_phone_format, mode, multiStringFormat, notificationsDomain, numbersOnlyRegex, numbersRegex, nxApiCall, parseMultiSelectInput, parsePermissions, parseSnapshotAsArray, priceRegex, propsAreEqual, query_document, query_document_by_conditions, query_documents, query_documents_by_conditions, renderOnce, secondsToDuration, setFormElementValue, setState, set_document, simpleExtractData, snapshot, snapshotDocument, sort_by_timestamp, storage, textNumbersRegex, textRegex, timestamp_to_millis, timestamp_to_string, useLoginWithGoogle, useStoreValues, useValidation, userNameFormat, validateAndCast, validateUserStatusAndPermissions };
+interface GetDataPayload<T = any> {
+    key: string;
+    collection_name: string;
+    callback: (value: T) => void;
+    defaultValue: T;
+}
+declare class SocketService {
+    private static instance;
+    private socket;
+    private connectCallbacks;
+    private disconnectCallbacks;
+    private initSocket;
+    private constructor();
+    static getInstance(): SocketService;
+    private getSocketInstance;
+    subscribeToCollections(config: OnSnapshotConfig[]): () => void;
+    setData<UpdateType extends RedisUpdateType, DataType = any>(payload: RedisUpdatePayload<UpdateType, DataType>): Promise<SocketCallbackResponse>;
+    getCollectionData<T>(payload: Omit<GetDataPayload<T>, "key">): void;
+    getDocumentData<T>(payload: GetDataPayload<T>): void;
+    deleteData(payload: {
+        key: string;
+        collection_name: string;
+    }): Promise<SocketCallbackResponse>;
+    clearAllRedisData(): Promise<SocketCallbackResponse>;
+    onConnect(callback: () => void): void;
+    offConnect(callback: () => void): void;
+    onDisconnect(callback: () => void): void;
+    offDisconnect(callback: () => void): void;
+    isConnected(): boolean;
+}
+declare const socketServiceInstance: SocketService;
+
+export { type ValidationType, addAuditRecord, addLoginAudit, add_document, addressRegex, akeylessOnlineDomain, app, appCheck, auth, baseDomain, biDomain, calculateBearing, callCenterEventsDomain, callCenterGeoDomain, carsRegex, chartsRegex, checkUserPermissions, cleanNxSites, cn, collections, colorRegex, createSelectors, db, delete_document, devicesDomain, displayFormatPhoneNumber, durationToSeconds, emailRegex, extractAlertsData, extractBoardsData, extractCanbusData, extractCarsData, extractClientData, extractLocationData, extractSiteData, fire_base_TIME_TEMP, formatCarNumber, getAddressByGeo, getFixedNumber, getFormCheckboxValue, getFormElementValue, getLocationUrl, getUserByEmail, getUserByIdentifier, getUserByPhone, getUserCountryByIp, get_all_documents, get_document_by_id, get_international_phone_number, googleLoginProvider, handleChange, handleInvalid, handlePaste, initializeUserPermissions, international_israel_phone_format, isInternational, isInternationalIsraelPhone, isLocal, isNodeEnv, is_iccid, local_israel_phone_format, mode, multiStringFormat, notificationsDomain, numbersOnlyRegex, numbersRegex, nxApiCall, parseMultiSelectInput, parsePermissions, parseSnapshotAsArray, priceRegex, propsAreEqual, query_document, query_document_by_conditions, query_documents, query_documents_by_conditions, renderOnce, secondsToDuration, setFormElementValue, setState, set_document, simpleExtractData, snapshot, snapshotDocument, socketServiceInstance, sort_by_timestamp, storage, textNumbersRegex, textRegex, timestamp_to_millis, timestamp_to_string, useLoginWithGoogle, useStoreValues, useValidation, userNameFormat, validateAndCast, validateUserStatusAndPermissions };

package/dist/helpers/index.d.ts

@@ -3,7 +3,7 @@ import { FirebaseStorage } from 'firebase/storage';
 import { Auth, GoogleAuthProvider, User } from 'firebase/auth';
 import { AppCheck } from 'firebase/app-check';
 import { WhereFilterOp, Unsubscribe, Firestore, CollectionReference, DocumentData, Timestamp, DocumentSnapshot } from 'firebase/firestore';
-import { TObject, NxUser, CountryOptions, LanguageOptions, UserPermissionsObject, userPermissionsObjectValue, Client } from 'akeyless-types-commons';
+import { TObject, NxUser, CountryOptions, LanguageOptions, UserPermissionsObject, userPermissionsObjectValue, Client, RedisUpdateType, RedisUpdatePayload, SocketCallbackResponse } from 'akeyless-types-commons';
 import React, { Dispatch, SetStateAction } from 'react';
 import { ClassValue } from 'clsx';
 
@@ -31,6 +31,8 @@ interface OnSnapshotConfig extends OnSnapshotParsers {
         fieldName: string;
         direction: "asc" | "desc";
     }[];
+    parseAs?: "object" | "array";
+    subscribeTo?: "cache" | "db";
 }
 interface OnSnapshotConfigDocument extends Omit<OnSnapshotParsers, "onAdd"> {
     collectionName: string;
@@ -258,4 +260,36 @@ declare const initializeUserPermissions: ({ phoneNumber, email, firstTimeArray,
     permissions: TObject<TObject<boolean>>;
 }>;
 
-export { type ValidationType, addAuditRecord, addLoginAudit, add_document, addressRegex, akeylessOnlineDomain, app, appCheck, auth, baseDomain, biDomain, calculateBearing, callCenterEventsDomain, callCenterGeoDomain, carsRegex, chartsRegex, checkUserPermissions, cleanNxSites, cn, collections, colorRegex, createSelectors, db, delete_document, devicesDomain, displayFormatPhoneNumber, durationToSeconds, emailRegex, extractAlertsData, extractBoardsData, extractCanbusData, extractCarsData, extractClientData, extractLocationData, extractSiteData, fire_base_TIME_TEMP, formatCarNumber, getAddressByGeo, getFixedNumber, getFormCheckboxValue, getFormElementValue, getLocationUrl, getUserByEmail, getUserByIdentifier, getUserByPhone, getUserCountryByIp, get_all_documents, get_document_by_id, get_international_phone_number, googleLoginProvider, handleChange, handleInvalid, handlePaste, initializeUserPermissions, international_israel_phone_format, isInternational, isInternationalIsraelPhone, isLocal, isNodeEnv, is_iccid, local_israel_phone_format, mode, multiStringFormat, notificationsDomain, numbersOnlyRegex, numbersRegex, nxApiCall, parseMultiSelectInput, parsePermissions, parseSnapshotAsArray, priceRegex, propsAreEqual, query_document, query_document_by_conditions, query_documents, query_documents_by_conditions, renderOnce, secondsToDuration, setFormElementValue, setState, set_document, simpleExtractData, snapshot, snapshotDocument, sort_by_timestamp, storage, textNumbersRegex, textRegex, timestamp_to_millis, timestamp_to_string, useLoginWithGoogle, useStoreValues, useValidation, userNameFormat, validateAndCast, validateUserStatusAndPermissions };
+interface GetDataPayload<T = any> {
+    key: string;
+    collection_name: string;
+    callback: (value: T) => void;
+    defaultValue: T;
+}
+declare class SocketService {
+    private static instance;
+    private socket;
+    private connectCallbacks;
+    private disconnectCallbacks;
+    private initSocket;
+    private constructor();
+    static getInstance(): SocketService;
+    private getSocketInstance;
+    subscribeToCollections(config: OnSnapshotConfig[]): () => void;
+    setData<UpdateType extends RedisUpdateType, DataType = any>(payload: RedisUpdatePayload<UpdateType, DataType>): Promise<SocketCallbackResponse>;
+    getCollectionData<T>(payload: Omit<GetDataPayload<T>, "key">): void;
+    getDocumentData<T>(payload: GetDataPayload<T>): void;
+    deleteData(payload: {
+        key: string;
+        collection_name: string;
+    }): Promise<SocketCallbackResponse>;
+    clearAllRedisData(): Promise<SocketCallbackResponse>;
+    onConnect(callback: () => void): void;
+    offConnect(callback: () => void): void;
+    onDisconnect(callback: () => void): void;
+    offDisconnect(callback: () => void): void;
+    isConnected(): boolean;
+}
+declare const socketServiceInstance: SocketService;
+
+export { type ValidationType, addAuditRecord, addLoginAudit, add_document, addressRegex, akeylessOnlineDomain, app, appCheck, auth, baseDomain, biDomain, calculateBearing, callCenterEventsDomain, callCenterGeoDomain, carsRegex, chartsRegex, checkUserPermissions, cleanNxSites, cn, collections, colorRegex, createSelectors, db, delete_document, devicesDomain, displayFormatPhoneNumber, durationToSeconds, emailRegex, extractAlertsData, extractBoardsData, extractCanbusData, extractCarsData, extractClientData, extractLocationData, extractSiteData, fire_base_TIME_TEMP, formatCarNumber, getAddressByGeo, getFixedNumber, getFormCheckboxValue, getFormElementValue, getLocationUrl, getUserByEmail, getUserByIdentifier, getUserByPhone, getUserCountryByIp, get_all_documents, get_document_by_id, get_international_phone_number, googleLoginProvider, handleChange, handleInvalid, handlePaste, initializeUserPermissions, international_israel_phone_format, isInternational, isInternationalIsraelPhone, isLocal, isNodeEnv, is_iccid, local_israel_phone_format, mode, multiStringFormat, notificationsDomain, numbersOnlyRegex, numbersRegex, nxApiCall, parseMultiSelectInput, parsePermissions, parseSnapshotAsArray, priceRegex, propsAreEqual, query_document, query_document_by_conditions, query_documents, query_documents_by_conditions, renderOnce, secondsToDuration, setFormElementValue, setState, set_document, simpleExtractData, snapshot, snapshotDocument, socketServiceInstance, sort_by_timestamp, storage, textNumbersRegex, textRegex, timestamp_to_millis, timestamp_to_string, useLoginWithGoogle, useStoreValues, useValidation, userNameFormat, validateAndCast, validateUserStatusAndPermissions };

package/dist/helpers/index.js

@@ -39,6 +39,25 @@ function _async_to_generator(fn) {
         });
     };
 }
+function _class_call_check(instance, Constructor) {
+    if (!(instance instanceof Constructor)) {
+        throw new TypeError("Cannot call a class as a function");
+    }
+}
+function _defineProperties(target, props) {
+    for(var i = 0; i < props.length; i++){
+        var descriptor = props[i];
+        descriptor.enumerable = descriptor.enumerable || false;
+        descriptor.configurable = true;
+        if ("value" in descriptor) descriptor.writable = true;
+        Object.defineProperty(target, descriptor.key, descriptor);
+    }
+}
+function _create_class(Constructor, protoProps, staticProps) {
+    if (protoProps) _defineProperties(Constructor.prototype, protoProps);
+    if (staticProps) _defineProperties(Constructor, staticProps);
+    return Constructor;
+}
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -554,6 +573,9 @@ __export(index_exports, {
     snapshotDocument: function() {
         return snapshotDocument;
     },
+    socketServiceInstance: function() {
+        return socketServiceInstance;
+    },
     sort_by_timestamp: function() {
         return sort_by_timestamp;
     },
@@ -2261,6 +2283,277 @@ var nxApiCall = /*#__PURE__*/ function() {
         return _ref.apply(this, arguments);
     };
 }();
+// src/helpers/socket.ts
+var import_socket = require("socket.io-client");
+var SocketService = /*#__PURE__*/ function() {
+    "use strict";
+    function _SocketService() {
+        _class_call_check(this, _SocketService);
+        this.socket = null;
+        this.connectCallbacks = [];
+        this.disconnectCallbacks = [];
+    }
+    _create_class(_SocketService, [
+        {
+            /// Initialize the socket connection
+            key: "initSocket",
+            value: function initSocket() {
+                var _this = this;
+                if (!this.socket) {
+                    var SOCKET_SERVER_URL = "http://localhost:9009";
+                    var SOCKET_PATH = "/api/data-socket/connect";
+                    this.socket = (0, import_socket.io)(SOCKET_SERVER_URL, {
+                        path: SOCKET_PATH,
+                        transports: [
+                            "websocket"
+                        ]
+                    });
+                    this.socket.on("connect", function() {
+                        var _this_socket;
+                        console.log("Socket connected:", (_this_socket = _this.socket) === null || _this_socket === void 0 ? void 0 : _this_socket.id);
+                        _this.connectCallbacks.forEach(function(cb) {
+                            return cb();
+                        });
+                    });
+                    this.socket.on("disconnect", function(reason) {
+                        console.log("Socket disconnected:", reason);
+                        _this.disconnectCallbacks.forEach(function(cb) {
+                            return cb();
+                        });
+                    });
+                    this.socket.on("connect_error", function(error) {
+                        console.error("Socket connection error:", error);
+                    });
+                }
+            }
+        },
+        {
+            /// get socket instance
+            key: "getSocketInstance",
+            value: function getSocketInstance() {
+                if (!this.socket) {
+                    this.initSocket();
+                }
+                if (!this.socket) {
+                    throw new Error("Socket not initialized");
+                }
+                if (!this.socket.connected) {
+                    this.socket.connect();
+                }
+                return this.socket;
+            }
+        },
+        {
+            /// subscribe to collections
+            key: "subscribeToCollections",
+            value: function subscribeToCollections(config) {
+                var s = this.getSocketInstance();
+                var collectionsNames = config.map(function(c) {
+                    return c.collectionName;
+                });
+                var eventHandlers = [];
+                config.forEach(function(configuration) {
+                    var collectionName = configuration.collectionName, onAdd = configuration.onAdd, onFirstTime = configuration.onFirstTime, onModify = configuration.onModify, onRemove = configuration.onRemove, extraParsers = configuration.extraParsers, conditions = configuration.conditions, orderBy2 = configuration.orderBy;
+                    s.on("initial:".concat(collectionName), onFirstTime);
+                    eventHandlers.push({
+                        eventName: "initial:".concat(collectionName),
+                        handler: onFirstTime
+                    });
+                    s.on("add:".concat(collectionName), onAdd);
+                    eventHandlers.push({
+                        eventName: "add:".concat(collectionName),
+                        handler: onAdd
+                    });
+                    s.on("update:".concat(collectionName), onModify);
+                    eventHandlers.push({
+                        eventName: "update:".concat(collectionName),
+                        handler: onModify
+                    });
+                    s.on("delete:".concat(collectionName), onRemove);
+                    eventHandlers.push({
+                        eventName: "delete:".concat(collectionName),
+                        handler: onRemove
+                    });
+                    extraParsers === null || extraParsers === void 0 ? void 0 : extraParsers.forEach(function(parsers) {
+                        var extraOnAdd = parsers.onAdd, extraOnFirstTime = parsers.onFirstTime, extraOnModify = parsers.onModify, extraOnRemove = parsers.onRemove;
+                        s.on("initial:".concat(collectionName), extraOnFirstTime);
+                        eventHandlers.push({
+                            eventName: "initial:".concat(collectionName),
+                            handler: extraOnFirstTime
+                        });
+                        s.on("add:".concat(collectionName), extraOnAdd);
+                        eventHandlers.push({
+                            eventName: "add:".concat(collectionName),
+                            handler: extraOnAdd
+                        });
+                        s.on("update:".concat(collectionName), extraOnModify);
+                        eventHandlers.push({
+                            eventName: "update:".concat(collectionName),
+                            handler: extraOnModify
+                        });
+                        s.on("delete:".concat(collectionName), extraOnRemove);
+                        eventHandlers.push({
+                            eventName: "delete:".concat(collectionName),
+                            handler: extraOnRemove
+                        });
+                    });
+                });
+                s.emit("subscribe_collections", collectionsNames, function(callback) {
+                    if (callback.success) {
+                        console.log("Successfully subscribed to: ".concat(collectionsNames.join(", ")));
+                    } else {
+                        console.error("Failed to subscribe to ".concat(config.join(", "), ": ").concat(callback.message));
+                    }
+                });
+                return function() {
+                    console.log("Cleaning up subscriptions for: ".concat(collectionsNames.join(", ")));
+                    s.emit("unsubscribe_collections", collectionsNames);
+                    eventHandlers.forEach(function(eh) {
+                        s.off(eh.eventName, eh.handler);
+                    });
+                };
+            }
+        },
+        {
+            /// set data
+            key: "setData",
+            value: function setData(payload) {
+                var s = this.getSocketInstance();
+                return new Promise(function(resolve, reject) {
+                    s.emit("set_data", payload, function(callback) {
+                        if (callback.success) {
+                            console.log("Data saved successfully:", payload);
+                            console.log("ack", callback);
+                            resolve(callback);
+                        } else {
+                            reject(new Error(callback.message || "Save operation failed"));
+                        }
+                    });
+                });
+            }
+        },
+        {
+            /// get data
+            key: "getCollectionData",
+            value: function getCollectionData(payload) {
+                var s = this.getSocketInstance();
+                s.emit("get_data", {
+                    collection_name: payload.collection_name
+                }, function(socketCallback) {
+                    if (socketCallback.success && socketCallback.data) {
+                        payload.callback(socketCallback.data);
+                    } else {
+                        payload.callback(payload.defaultValue);
+                    }
+                });
+            }
+        },
+        {
+            key: "getDocumentData",
+            value: function getDocumentData(payload) {
+                var s = this.getSocketInstance();
+                s.emit("get_data", {
+                    collection_name: payload.collection_name,
+                    key: payload.key
+                }, function(socketCallback) {
+                    if (socketCallback.success && socketCallback.data) {
+                        payload.callback(socketCallback.data);
+                    } else {
+                        payload.callback(payload.defaultValue);
+                    }
+                });
+            }
+        },
+        {
+            /// delete data
+            key: "deleteData",
+            value: function deleteData(payload) {
+                var s = this.getSocketInstance();
+                return new Promise(function(resolve, reject) {
+                    s.emit("delete_data", payload, function(callback) {
+                        if (callback.success) {
+                            console.log("Data deleted successfully:", payload);
+                            console.log("delete ack", callback);
+                            resolve(callback);
+                        } else {
+                            reject(new Error(callback.message || "Delete operation failed"));
+                        }
+                    });
+                });
+            }
+        },
+        {
+            key: "clearAllRedisData",
+            value: function clearAllRedisData() {
+                var s = this.getSocketInstance();
+                return new Promise(function(resolve, reject) {
+                    s.emit("clear_all_redis_data", function(ack) {
+                        if (ack.success) {
+                            resolve(ack);
+                        } else {
+                            reject(new Error(ack.message || "Clear all Redis data operation failed"));
+                        }
+                    });
+                });
+            }
+        },
+        {
+            /// connection management methods
+            key: "onConnect",
+            value: function onConnect(callback) {
+                var _this_socket;
+                this.connectCallbacks.push(callback);
+                if ((_this_socket = this.socket) === null || _this_socket === void 0 ? void 0 : _this_socket.connected) {
+                    callback();
+                }
+            }
+        },
+        {
+            key: "offConnect",
+            value: function offConnect(callback) {
+                this.connectCallbacks = this.connectCallbacks.filter(function(cb) {
+                    return cb !== callback;
+                });
+            }
+        },
+        {
+            key: "onDisconnect",
+            value: function onDisconnect(callback) {
+                this.disconnectCallbacks.push(callback);
+                if (this.socket && !this.socket.connected) {
+                    callback();
+                }
+            }
+        },
+        {
+            key: "offDisconnect",
+            value: function offDisconnect(callback) {
+                this.disconnectCallbacks = this.disconnectCallbacks.filter(function(cb) {
+                    return cb !== callback;
+                });
+            }
+        },
+        {
+            key: "isConnected",
+            value: function isConnected() {
+                var _this_socket;
+                return ((_this_socket = this.socket) === null || _this_socket === void 0 ? void 0 : _this_socket.connected) || false;
+            }
+        }
+    ], [
+        {
+            key: "getInstance",
+            value: function getInstance() {
+                if (!_SocketService.instance) {
+                    _SocketService.instance = new _SocketService();
+                }
+                return _SocketService.instance;
+            }
+        }
+    ]);
+    return _SocketService;
+}();
+var socketServiceInstance = SocketService.getInstance();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
     addAuditRecord: addAuditRecord,
@@ -2346,6 +2639,7 @@ var nxApiCall = /*#__PURE__*/ function() {
     simpleExtractData: simpleExtractData,
     snapshot: snapshot,
     snapshotDocument: snapshotDocument,
+    socketServiceInstance: socketServiceInstance,
     sort_by_timestamp: sort_by_timestamp,
     storage: storage,
     textNumbersRegex: textNumbersRegex,