cdsclient-lib 0.0.2 → 0.0.4

package/README.md

@@ -153,49 +153,48 @@ const initializeSocketClient = (dispatch, data) => {
 # Build
 ---
 
-1. Simple compile - Generate output files
+## 1. Simple compile - Generate output files
 
-```shell
+```bash
     npm run build
 ```
 
+This will build outputs for es6 & commonjs in the `dist/lib` directory.
 
+</br>
 
-2. Compile (Platform specific)
+## 2. Create package for installing locally
 
 **Linux**
 
 
-```shell
-    npm run build_linux
+```bash
+    npm run pack:output
 ```
 
+This will create a `tgz` file in the build folder. This file can be used to install the dependency locally.
 
-**Windows**
-
-```shell
-    npm run build_win
+```bash
+npm install /path-to/build/cdsclient-lib-0.0.2.tgz
 ```
 
 
-3. Distribute compiled files for linux to react client project
+**Windows**
 
-> When building alongside `Cloudisense` main project folder
+TO DO
 
-**Linux**
+</br>
 
+## 3. Distribute the library on `npm`
 
-```shell
-    TO DO
-```
+The final step is to publish this on `npm`, so that it can be installed directly from there.
 
-**Windows**
+* **Login:**: Type `npm login` at the console to initiate login. This will open a browser window, where you can authenticate on `npm`.
 
+* **Publish:**: Type `npm publish` to publish this library on `npm`. Make sure the version is above the one existing on `npm`
 
-```shell
-    TO DO
-```
+</br>
     
-4. NPM 
+## 4. Libray on NPM 
 
 The library is hosted on NPM @ [https://www.npmjs.com/package/cdsclient-lib](https://www.npmjs.com/package/cdsclient-lib)

package/dist/lib/cjs/client.d.ts

@@ -0,0 +1,304 @@
+/**
+ * Copyright © 2024 Rajdeep Rath. All Rights Reserved.
+ *
+ * This codebase is open-source and provided for use exclusively with the Cloudisense platform,
+ * as governed by its End-User License Agreement (EULA). Unauthorized use, reproduction,
+ * or distribution of this code outside of the Cloudisense ecosystem is strictly prohibited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is available at:
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code may include third-party open-source libraries subject to their respective licenses.
+ * Such licenses are referenced in the source files or accompanying documentation.
+ *
+ * For questions or permissions beyond the scope of this notice, please contact Rajdeep Rath.
+ */
+import 'reflect-metadata';
+import { IServiceClient, IClientConfig } from "./interfaces";
+import { IEventHandler } from "strongly-typed-events";
+import { ClientEventProvider } from "./event/eventprovider";
+import { LogInfo, AuthData, RuleInfo } from "./models";
+export declare class CloudisenseApiClient extends ClientEventProvider implements IServiceClient {
+    host: string;
+    port: number;
+    autoconnect?: boolean;
+    reconnectOnFailure?: boolean;
+    authdata: AuthData;
+    private _socketservice;
+    private _restEndPoint;
+    private _authtime;
+    private _lastCredentials;
+    private _errorCount;
+    private static MAX_ERROR_TOLERANCE;
+    private _topicevents;
+    constructor(config: IClientConfig);
+    /**
+     * Subscribes to a specific DataEvent topic
+     *
+     * @param topicname topic name to subscribe to
+     * @param fn subscriber handler function
+     */
+    subscribeTopic(topicname: string, fn: IEventHandler<IServiceClient, any>): Function;
+    /**
+     * Unsubscribes from a specific DataEvent topic. The handler is executed at most once
+     *
+     * @param topicname topic name to unsubscribe from
+     * @param fn subscriber handler function
+     */
+    unsubscribeTopic(topicname: string, fn: IEventHandler<IServiceClient, any>): void;
+    /**
+     * Checks to see if a given DataEvent topic has a handler registered against it or not
+     *
+     * @param topicname
+     * @param fn
+     */
+    hasTopicHandler(topicname: string, fn: IEventHandler<IServiceClient, any>): boolean;
+    /**
+     * Gets the root path of the filesystem (constrained by sandbox)
+     *
+     * @returns Promise that resolved to root path data of the filesystem
+     */
+    get_accessible_file_system_paths(): Promise<any>;
+    /**
+     * Requests deletion of a file from the file system
+     *
+     * @param path The path of the file to delete
+     * @returns Promise that resolves to nothing if operation is successful and error if unsuccessful
+     */
+    delete_file(path: string): Promise<any>;
+    /**
+     * Requests deletion of a directory from the file system
+     *
+     * @param path The path of the directory to delete
+     * @returns Promise that resolves to nothing if operation is successful and error if unsuccessful
+     */
+    delete_folder(root: string, dirname: string, deleteNonEmpty?: boolean): Promise<any>;
+    /**
+     * Requests the download file from the file system (within allowed scope)
+     *
+     * @param path The path of the file to download
+     * @returns Promise that resolves to a download link if operation is successful and error if unsuccessful
+     */
+    download_file(path: string, mode?: string): Promise<any>;
+    /**
+     * Gets content listing of the file system path specified
+     *
+     * @returns Promise that resolved to path content (if any)
+     */
+    list_path_content(root: string, path?: string): Promise<any>;
+    /**
+     * Fetched the content of a simple text file from server
+     *
+     * @returns
+     */
+    read_file(path: string): Promise<string>;
+    /**
+     * Saves the content of a simple text file on server
+     *
+     * @returns
+     */
+    write_file(path: string, content: string): Promise<void>;
+    /**
+     * Gets list of accessible logs
+     *
+     * @returns Promise that resolved to List of logs
+     */
+    get_logs(): Promise<Array<LogInfo>>;
+    /**
+     * Gets list of reaction engine rules
+     *
+     * @returns Promise that resolved to List of ReactionRules
+     */
+    list_rules(head?: boolean): Promise<Array<RuleInfo>>;
+    /**
+     * Attempts to reloads all reaction rules in the system
+     *
+     * @returns Promise that resolved to nothing
+     */
+    reload_rules(): Promise<any>;
+    /**
+     * Attempts to reloads a reaction rules by specified id
+     * in the system
+     *
+     * @returns Promise that resolved to id of the reaction rule
+     */
+    reload_rule(id: string): Promise<any>;
+    /**
+    * Gets rule data of a reaction engine rule by specified id
+    *
+    * @returns Promise that resolved to Rule data
+    */
+    get_rule(id: string): Promise<any>;
+    /**
+    * Requests service to initiate restart via systemctl.
+    * Server should have sufficient permissions to execute the command
+    *
+    * @returns Promise that resolved to nothing (no return value)
+    */
+    request_restart(id: string): Promise<any>;
+    /**
+    * Requests to load settings / configuration information from the server
+    *
+    * @returns Promise that resolved to settings data
+    */
+    loadSettings(): Promise<any>;
+    /**
+     * Gets sample reaction rule data from server
+     *
+     * @returns Promise that resolved to Rule data
+     */
+    generate_sample_rule(): Promise<any>;
+    /**
+    * Saves rule data of a reaction engine rule on server
+    *
+    * @returns Promise that resolved to Rule Id on successful write
+    */
+    write_rule(data: string, update?: boolean): Promise<any>;
+    /**
+     * Deletes a rule by specified id
+     *
+     * @returns Promise that resolves to the id of the deleted rule
+     */
+    delete_rule(id: string): Promise<string>;
+    /**
+     * Subscribes to arbitrary data channel (topic path) to get realtime data
+     *
+     * @returns Promise that resolved to subscribable topic path for the data channel for stats
+     */
+    subscribe_datachannel(topic: string): Promise<any>;
+    /**
+     * Subscribes to stats channel (topic path) to get realtime data
+     *
+     * @returns Promise that resolved to subscribable topic path for the data channel for stats
+     */
+    subscribe_stats(): Promise<any>;
+    /**
+     * Subscribes to ui updates channel (topic path) to get data updates for dashboard widgets
+     *
+     * @returns Promise that resolved to subscribable topic path for the data channel for stats
+     */
+    subscribe_ui_updates(): Promise<any>;
+    /**
+     * Unsubscribes from stats channel (topic path) to get realtime data
+     *
+     * @returns Promise that resolved to boolean true on unsubscribe success
+     */
+    unsubscribe_stats(): Promise<any>;
+    /**
+     * Subscribes to log channel (topic path) to get realtime data
+     *
+     * @param topic
+     * @returns Promise that resolved to subscribable topic path for the data channel of thsi log
+     */
+    subscribe_log(topic: string): Promise<any>;
+    /**
+     *
+     * Unsubscribes from a log channel
+     *
+     * @param logkey
+     * @returns
+     */
+    unsubscribe_log(topic: string): Promise<void>;
+    /**
+     * Requests to download a log file from server
+     *
+     * @param logkey
+     * @returns
+     */
+    download_log(logkey: string, mode?: string): Promise<string>;
+    /**
+     * Gets list of system services that can be started/stopped through the service
+     *
+     * @returns
+     */
+    get_system_services(): Promise<string[]>;
+    /**
+     * Starts a system service using its name
+     *
+     * @param name
+     * @returns
+     */
+    start_service(name: string): Promise<void>;
+    /**
+     * Stops a system service using its name
+     *
+     * @param name
+     * @returns
+     */
+    stop_service(name: string): Promise<void>;
+    /**
+     * Restarts a system service using its name
+     *
+     * @param name
+     * @returns
+     */
+    restart_service(name: string): Promise<void>;
+    /**
+     *
+     * Execute arbitrary intent request
+     *
+     * @param intent
+     * @param params
+     * @returns
+     */
+    execute_arbitrary_action(intent: string, params: any): Promise<void>;
+    /**
+     * Connects to backend service using auth data from previous authentication
+     *
+     * @param authData
+     * @returns Promise
+     */
+    connectWithAuthData(authData: AuthData): Promise<any>;
+    /**
+     * Connects to backend service using a set of valid credentials
+     *
+     * @param username
+     * @param password
+     * @returns
+     */
+    connectWithCredentials(username: string, password: string): Promise<any>;
+    private __wsconnect;
+    /**
+     * Returns a boolean promise to help determine if socket si conencted or not
+     * @returns
+     */
+    connected(): Promise<boolean>;
+    /**
+     * Disconnects the client if connected to the server, otherwise
+     * throws error.
+     */
+    disconnect(): Promise<any>;
+    /**
+     * Attempts to reconenct back to service using last successful credentials
+     */
+    private attemptReconnect;
+    /**
+     * Process push data from server and dispatch events for client
+     *
+     * @param data
+     */
+    private processChannelData;
+    /**
+     * Dispatches topic specific error event with topic specific data
+     * @param event
+     */
+    private _dispatchTopicOrientedErrorEvent;
+    /**
+     * Dispatches topic specific event with topic specific data - (generic)
+     *
+     * @param event
+     */
+    private _dispatchTopicOrientedDataEvent;
+    private getBaseAPIendPoint;
+    /**
+     * Authenticates a user based on username and password
+     *
+     * @param username
+     * @param password
+     * @returns
+     */
+    private authenticate;
+    dispose(): void;
+}