Import cdplogger-client into logger/ subdirectory

Merge JavascriptCDPLoggerClient repository into logger/ with full
commit history preserved. All files imported unchanged.

Source: https://github.com/CDPTechnologies/JavascriptCDPLoggerClient

Author: stefanrammo

logger/.github/README.md

@@ -0,0 +1,67 @@
+# 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
+
+### NPM Package (Recommended)
+
+```bash
+npm install cdplogger-client
+```
+
+### Development Setup
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/CDPTechnologies/JavascriptCDPLoggerClient.git
+cd JavascriptCDPLoggerClient
+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

logger/.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Run Jest Tests
+
+on:
+  push:
+    branches: [ '**' ]  # Run on all branches
+  pull_request:
+    branches: [ '**' ]  # Run on PRs targeting any branch
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+      - name: Cleanup
+        if: always()
+        run: |
+          echo "Cleaning up..."
+          rm -rf node_modules
+          rm -rf .npm 

logger/.gitignore

@@ -0,0 +1,68 @@
+# Dependencies
+node_modules/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage
+.grunt
+
+# Bower dependency directory
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons
+build/Release
+
+# Dependency directories
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+# npm config file
+.npmrc
+
+protos/

logger/DOCUMENTATION.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CDP Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

logger/LICENSE

@@ -0,0 +1,167 @@
+# Quick Start Guide – CDPLogger Client
+
+This guide demonstrates how to get started with the CDPLogger Client in both **Node.js** and **Browser** environments. The client automatically detects the environment and works seamlessly in both.
+
+## Documentation
+
+For documentation on the JS logger client see [DOCUMENTATION.md](DOCUMENTATION.md)
+
+## Overview
+
+The CDPLogger Client uses **automatic environment detection** to work in both Node.js and browser environments from a single source file:
+
+- **Node.js:**
+  - Automatically loads protobuf definitions using `require('./generated/containerPb.js')`
+  - Uses the `ws` package for WebSocket functionality (installed as a dependency)
+  - No manual setup required
+
+- **Browser:**
+  - Uses the browser's native WebSocket API
+  - Expects protobuf definitions to be available at `window.root`
+  - Requires including the containerPb.js script before the client
+
+## Installation
+
+### For Node.js
+
+```bash
+npm install cdplogger-client
+```
+
+### For Browser
+
+Include the following scripts in your HTML:
+- `protobuf.min.js` – for the ProtoBuf runtime.
+- `containerPb.js` – which sets up `window.root` with your protobuf definitions
+- `client.js` – the same file works in both Node.js and browser environments
+- Instead of importing protobuf definitions via CommonJS, obtain them from the global scope:
+   ```js
+   const root = window.root;
+   const Container = root.DBMessaging.Protobuf.Container;
+   const CDPValueType = root.ICD.Protobuf.CDPValueType;
+   const EventQuery = root.DBMessaging.Protobuf.EventQuery;
+   ```
+
+## Usage
+
+### Node.js Example
+
+```js
+// Import the client
+const cdplogger = require('cdplogger-client');
+
+// Create a client instance (endpoint can be "127.0.0.1:17000" or "ws://127.0.0.1:17000")
+const client = new cdplogger.Client('127.0.0.1:17000');
+
+// List logged nodes (displaying name and routing information)
+client.requestLoggedNodes().then(nodes => {
+  nodes.forEach(node => {
+    console.log(`Name: ${node.name}, Routing: ${node.routing}`);
+  });
+  
+  // If we have nodes, request data points for the first one
+  if (nodes.length > 0) {
+    const nodeName = nodes[0].name;
+    console.log(`\nRequesting data points for node: ${nodeName}`);
+    
+    // Get log limits and request data points
+    client.requestLogLimits().then(limits => {
+      return client.requestDataPoints([nodeName], limits.startS, limits.endS, 10, 0);
+    }).then(dataPoints => {
+      console.log(`\nReceived ${dataPoints.length} data points:`);
+      dataPoints.forEach(point => {
+        console.log(`Timestamp: ${new Date(point.timestamp * 1000).toISOString()}`);
+        if (point.value && point.value[nodeName]) {
+          const val = point.value[nodeName];
+          console.log(`  Min: ${val.min}, Max: ${val.max}, Last: ${val.last}`);
+        }
+      });
+    }).catch(err => {
+      console.error("Error retrieving data points:", err);
+    });
+  }
+});
+
+// Disconnect after a short delay (for demonstration purposes)
+setTimeout(() => {
+  client.disconnect();
+  process.exit(0);
+}, 5000);
+```
+
+*The client automatically detects the Node.js environment and uses the `ws` package for WebSocket functionality.*
+
+### Browser Example
+
+Create an HTML file that includes the necessary scripts. For example:
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>CDPLogger Client Quick Start</title>
+    <!-- Include the protobuf runtime -->
+    <script src="protobuf.min.js"></script>
+    <!-- Include containerPb.js to set up global "root" -->
+    <script src="containerPb.js"></script>
+    <!-- Include client.js -->
+    <script src="client.js"></script>
+  </head>
+  <body>
+    <script>
+      // Access protobuf definitions from global scope
+      const root = window.root;
+      const Container = root.DBMessaging.Protobuf.Container;
+      const CDPValueType = root.ICD.Protobuf.CDPValueType;
+      const EventQuery = root.DBMessaging.Protobuf.EventQuery;
+      
+      // The client is now available globally as "cdplogger" (attached to window)
+      // Use window.location.hostname to connect to the same host as the web page
+      const client = new cdplogger.Client(window.location.hostname + ":17000");
+
+      // List logged nodes and output their names and routings
+      client.requestLoggedNodes().then(nodes => {
+        nodes.forEach(node => {
+          console.log(`Name: ${node.name}, Routing: ${node.routing}`);
+        });
+        
+        // If we have nodes, request data points for the first one
+        if (nodes.length > 0) {
+          const nodeName = nodes[0].name;
+          console.log(`\nRequesting data points for node: ${nodeName}`);
+          
+          // Get log limits and request data points
+          client.requestLogLimits().then(limits => {
+            return client.requestDataPoints([nodeName], limits.startS, limits.endS, 10, 0);
+          }).then(dataPoints => {
+            console.log(`\nReceived ${dataPoints.length} data points:`);
+            dataPoints.forEach(point => {
+              console.log(`Timestamp: ${new Date(point.timestamp * 1000).toISOString()}`);
+              if (point.value && point.value[nodeName]) {
+                const val = point.value[nodeName];
+                console.log(`  Min: ${val.min}, Max: ${val.max}, Last: ${val.last}`);
+              }
+            });
+          }).catch(err => {
+            console.error("Error retrieving data points:", err);
+          });
+        }
+      });
+    </script>
+  </body>
+</html>
+```
+
+*In the browser version, we use `window.location.hostname` to connect to the same host as the web page, with the default logger port 17000.*
+
+## Prerequisites
+
+- **CDP Studio:** Ensure a CDP Studio application is running with an active **CDPLogger** (or LogServer) on a known WebSocket port (e.g., 17000).
+- **For Node.js:** No additional setup required - WebSocket support is automatically configured.
+- **For Browser:** Ensure `containerPb.js` is available and sets up `window.root` with protobuf definitions.
+
+## Learn More
+
+- [Full README](https://github.com/CDPTechnologies/JavascriptCDPLoggerClient)
+- [CDP Logger Documentation](https://cdpstudio.com/manual/cdp/cdplogger/cdplogger-configuration-manual.html)