Merge pull request #12 from CDPTechnologies/NPM

NPM setup

Author: stefanrammo

.github/README.md

@@ -0,0 +1,57 @@
+# CDPLogger Client for JavaScript
+
+A simple JavaScript interface for communicating with CDP applications that include a CDPLogger component to retrieve historic data. 
+- For documentation on the JS logger client see [DOCUMENTATION.md](DOCUMENTATION.md).
+- For a quickstart guide on how to set-up the npm project for either Node or Web see [QUICKSTART.md](QUICKSTART.md)
+- For more information about CDP Studio see https://cdpstudio.com/.
+
+## Installation
+
+Clone the repository and install dependencies:
+
+```bash
+npm install
+```
+
+
+## Running Tests
+
+To run the automatic tests with fake data, execute:
+
+```bash
+npm test
+```
+
+Note: these jest tests execute on every push and pull of the repo as well.
+
+To test the time sync functionality using simulated response:
+
+```bash
+node test/testTimeSync.js
+```
+
+
+## Usage
+
+The value.js file contains a simple logger built for the CDP Studio example case.
+
+1. Set up and run the Logger in CDP Studio.
+(Refer to Help → Framework - Data Logging → How to Setup Logging in Automation System)
+https://cdpstudio.com/manual/cdp/cdplogger/cdplogger-configuration-example.html
+
+2. Run the value.js file from the command line:
+
+```bash
+node examples/value.js
+```
+
+For usage related to events run:
+
+```bash
+node examples/event.js
+```
+
+
+## Contact
+
+Email: support@cdptech.com

QUICKSTART.md

@@ -56,14 +56,6 @@ To enable web support, ensure your `client.js` file includes these modifications
    const EventQuery = root.DBMessaging.Protobuf.EventQuery;
    ```
 
-3. **Expose the Client Globally:**  
-   At the end of your `client.js`, attach the client API to the global window:
-   ```js
-   cdplogger.Client = Client;
-   window.cdplogger = cdplogger;
-   ```
-   This ensures that when `client.js` is loaded in a browser, the `cdplogger` object (and its `Client` class) is available globally.
-
 *Make sure these modifications are only applied for the browser version of your client module.*
 
 ## Usage

README.md

@@ -1,57 +1,67 @@
-# CDPLogger Client for JavaScript
+# CDP Logger Client
 
-A simple JavaScript interface for communicating with CDP applications that include a CDPLogger component to retrieve historic data. 
-- For documentation on the JS logger client see [DOCUMENTATION.md](DOCUMENTATION.md).
-- For a quickstart guide on how to set-up the npm project for either Node or Web see [QUICKSTART.md](QUICKSTART.md)
-- For more information about CDP Studio see https://cdpstudio.com/.
-
-## Installation
-
-Clone the repository and install dependencies:
-
-```bash
-npm install
-```
+# CDP Logger Client
 
+A JavaScript client for reading historic data from systems created with the CDP Studio development platform. 
+For more information about CDP Studio, see https://cdpstudio.com/.
+For more information about CDP Logger, see https://cdpstudio.com/manual/cdp/cdplogger/cdplogger-index.html.
 
-## Running Tests
+This client allows you to:
+- Connect to a CDP Logger or LogServer component
+- Request logged nodes and their metadata
+- Retrieve data points for specific nodes
+- Query events from the logger
+- Get log limits and API version information
 
-To run the automatic tests with fake data, execute:
+## Installation
 
 ```bash
-npm test
+npm install cdp-logger-client
 ```
 
-Note: these jest tests execute on every push and pull of the repo as well.
+## Quick Start
 
-To test the time sync functionality using simulated response:
+For a quick introduction, see the [QUICKSTART.md](QUICKSTART.md) guide.
 
-```bash
-node test/testTimeSync.js
-```
+## Documentation
 
+For detailed documentation, see [DOCUMENTATION.md](DOCUMENTATION.md).
 
 ## Usage
 
-The value.js file contains a simple logger built for the CDP Studio example case.
+### Node.js
 
-1. Set up and run the Logger in CDP Studio.
-(Refer to Help → Framework - Data Logging → How to Setup Logging in Automation System)
-https://cdpstudio.com/manual/cdp/cdplogger/cdplogger-configuration-example.html
+```javascript
+const cdplogger = require('cdp-logger-client');
+global.WebSocket = require('ws');
 
-2. Run the value.js file from the command line:
+const client = new cdplogger.Client('127.0.0.1:17000');
 
-```bash
-node examples/value.js
+// List logged nodes
+client.requestLoggedNodes().then(nodes => {
+  console.log("Available nodes:", nodes);
+});
 ```
 
-For usage related to events run:
-
-```bash
-node examples/event.js
+### Browser
+
+```html
+<script src="protobuf.min.js"></script>
+<script src="containerPb.js"></script>
+<script src="client.js"></script>
+<script>
+  const client = new cdplogger.Client(window.location.hostname + ":17000");
+  
+  client.requestLoggedNodes().then(nodes => {
+    console.log("Available nodes:", nodes);
+  });
+</script>
 ```
 
-
 ## Contact
 
-Email: support@cdptech.com
+Email: support@cdptech.com
+
+## License
+
+MIT

client.js

@@ -1117,7 +1117,15 @@ class Client {
   }
 }
 
+// Export the module
 const cdplogger = {};
 cdplogger.Client = Client;
 
-module.exports = cdplogger;
+// For Node.js
+if (typeof module !== 'undefined' && module.exports) {
+  module.exports = cdplogger;
+}
+// For Browser
+else if (typeof window !== 'undefined') {
+  window.cdplogger = cdplogger;
+}

package.json

@@ -1,12 +1,47 @@
 {
-  "devDependencies": {
-    "jest": "^29.7.0",
-    "ws": "^8.18.1"
+  "name": "cdp-logger-client",
+  "version": "1.0.0",
+  "description": "A JavaScript client for interacting with CDP Logger or LogServer via WebSocket",
+  "main": "client.js",
+  "files": [
+    "client.js",
+    "generated/containerPb.js",
+    "README.md",
+    "QUICKSTART.md",
+    "DOCUMENTATION.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CDPTechnologies/JavascriptCDPLoggerClient.git"
   },
   "scripts": {
     "test": "jest"
   },
+  "keywords": [
+    "cdp",
+    "cdp-studio",
+    "cdplogger",
+    "cdp-logger",
+    "cdp-logger-client",
+    "cdploggerclient",
+    "cdpjsclientlogger",
+    "cdp-js-client-logger",
+    "cdp-studio-logger",
+    "logger",
+    "logger-client"
+  ],
+  "author": "CDP Technologies",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/CDPTechnologies/JavascriptCDPLoggerClient/issues"
+  },
+  "homepage": "https://github.com/CDPTechnologies/JavascriptCDPLoggerClient#readme",
   "dependencies": {
     "protobufjs": "^7.4.0"
+  },
+  "devDependencies": {
+    "ws": "^8.13.0",
+    "jest": "^29.5.0"
   }
 }