@lsdsoftware/utils 1.0.0 → 1.0.1

package/README.md

@@ -1,7 +1,7 @@
 # Useful JavaScript utilities
 
 
-## State Machine
+### State Machine
 Make implementing state machines less error prone.
 
 ```typescript
@@ -48,12 +48,36 @@ sm.getState()   //BUSY
 
 
 
-## Message Dispatcher
-Dispatch messages to handlers.  This utility assumes messages are one of three types: request, response, or notification, and follow a predefined format (see type definition below).
+### Message Dispatcher
+Dispatch messages to handlers.  This utility assumes messages are one of three types: request, response, or notification; and follow a predefined format (see type definition below).
 
-Requests and notifications are dispatched to provided request handlers, and responses are generated from their return values.  Responses are dispatched to response listeners.  The caller registers a response listener by calling the waitForResponse method, which returns a promise.
+```typescript
+interface Request {
+  to: string
+  type: "request"
+  id: "string"
+  method: string
+  args: Record<string, unknown>
+}
 
-When constructing a dispatcher, caller provides a _myAddress_ parameter used to filter messages.  Only requests and notifications whose _to_ attribute matches _myAddress_ will be processed.
+interface Notification {
+  to: string
+  type: "notification"
+  method: string
+  args: Record<string, unknown>
+}
+
+interface Response {
+  type: "response"
+  id: string
+  error: unknown
+  result: unknown
+}
+```
+
+Call `dispatch` to dispatch a message you received.  Requests and notifications are dispatched to request handlers that you provide at construction.  Responses are dispatched to response listeners; to listen for a response, call `waitForResponse` with the request ID.
+
+A _myAddress_ parameter provided at construction is used to filter messages.  Only requests and notifications whose _to_ attribute matches _myAddress_ will be processed.
 
 ```typescript
 import { makeMessageDispatcher } from "@lsdsoftware/utils"
@@ -91,7 +115,7 @@ dispatcher.waitForResponse(id)
 
 
 
-## Rate Limiter
+### Rate Limiter
 Basic rate limiter using the token bucket algorithm.
 
 ```typescript
@@ -107,7 +131,7 @@ function handleRequest(userId, req) {
 
 
 
-## Connection Manager
+### Connection Manager
 Takes a connect() method and:
 - Only call it to create a connection when needed
 - Automatically retry on failure
@@ -134,16 +158,11 @@ conMgr.shutdown()
 
 
 
-## Line Split Stream
-A Transform stream that transforms a byte stream into lines of text (by GPT-4)
+### Line Reader
+Split text into lines
 
 ```typescript
-import { makeLineSplitStream } from "@lsdsoftware/utils"
-
-const splitter = makeLineSplitStream()
-splitter.on('data', line => console.log('Received line:', line))
+import { makeLineReader } from "@lsdsoftware/utils"
 
-// Simulating input
-splitter.write('This is a line\nThis is another line\nAnd this is a line as well')
-splitter.end() // End the stream to see the _flush effect.
+myStream.pipe(makeLineReader(line => console.log(line)))
 ```

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { makeLineSplitStream } from "./line-split-stream";
+import { makeLineReader } from "./line-reader";
 import { makeStateMachine } from "./state-machine";
 import { makeConnectionManager } from "./connection-manager";
 import { makeMessageDispatcher } from "./message-dispatcher";
 import { makeRateLimiter } from "./rate-limiter";
-export { makeLineSplitStream, makeStateMachine, makeConnectionManager, makeMessageDispatcher, makeRateLimiter, };
+export { makeLineReader, makeStateMachine, makeConnectionManager, makeMessageDispatcher, makeRateLimiter, };

package/dist/index.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeRateLimiter = exports.makeMessageDispatcher = exports.makeConnectionManager = exports.makeStateMachine = exports.makeLineSplitStream = void 0;
-const line_split_stream_1 = require("./line-split-stream");
-Object.defineProperty(exports, "makeLineSplitStream", { enumerable: true, get: function () { return line_split_stream_1.makeLineSplitStream; } });
+exports.makeRateLimiter = exports.makeMessageDispatcher = exports.makeConnectionManager = exports.makeStateMachine = exports.makeLineReader = void 0;
+const line_reader_1 = require("./line-reader");
+Object.defineProperty(exports, "makeLineReader", { enumerable: true, get: function () { return line_reader_1.makeLineReader; } });
 const state_machine_1 = require("./state-machine");
 Object.defineProperty(exports, "makeStateMachine", { enumerable: true, get: function () { return state_machine_1.makeStateMachine; } });
 const connection_manager_1 = require("./connection-manager");

package/dist/index.test.js

@@ -9,10 +9,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const line_split_stream_test_1 = require("./line-split-stream.test");
+const line_reader_test_1 = require("./line-reader.test");
 const rate_limiter_test_1 = require("./rate-limiter.test");
 const state_machine_test_1 = require("./state-machine.test");
-run(Object.assign(Object.assign(Object.assign({}, line_split_stream_test_1.default), rate_limiter_test_1.default), state_machine_test_1.default))
+run(Object.assign(Object.assign(Object.assign({}, line_reader_test_1.default), rate_limiter_test_1.default), state_machine_test_1.default))
     .catch(console.error);
 function run(tests) {
     return __awaiter(this, void 0, void 0, function* () {

package/dist/line-reader.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import { Writable } from "stream";
+export declare function makeLineReader(lineCallback: (line: string) => void): Writable;

package/dist/line-reader.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeLineReader = void 0;
+const stream_1 = require("stream");
+const string_decoder_1 = require("string_decoder");
+function makeLineReader(lineCallback) {
+    // Buffer for the part of the chunk that doesn't form a complete line.
+    let remainder = '';
+    const decoder = new string_decoder_1.StringDecoder();
+    return new stream_1.Writable({
+        //prevent auto-decoding string to Buffer, so processed chunk could be either string or Buffer
+        decodeStrings: false,
+        write(chunk, encoding, callback) {
+            // encoding param here is irrelevant because it applies only to string chunks
+            const chunkStr = remainder + decoder.write(chunk);
+            const lines = chunkStr.split('\n');
+            // Keep the last line in remainder if it doesn't end with a newline character.
+            remainder = lines.pop();
+            // Push each complete line.
+            for (const line of lines)
+                lineCallback(line);
+            callback();
+        },
+        final(callback) {
+            // When the stream is ending, push any remainder as a line if it's not empty.
+            if (remainder)
+                lineCallback(remainder);
+            callback();
+        }
+    });
+}
+exports.makeLineReader = makeLineReader;

package/dist/{line-split-stream.test.js → line-reader.test.js}

@@ -9,50 +9,38 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const line_split_stream_1 = require("./line-split-stream");
+const line_reader_1 = require("./line-reader");
 const assert = require("assert");
 exports.default = {
     lineSplitStream1() {
         return __awaiter(this, void 0, void 0, function* () {
-            const splitter = (0, line_split_stream_1.makeLineSplitStream)();
+            const lines = [];
+            const splitter = (0, line_reader_1.makeLineReader)(line => lines.push(line));
             splitter.write('This is a line\nThis is another line\nAnd this is a line as well');
             splitter.end();
-            const lines = yield new Promise(fulfill => {
-                let accum = [];
-                splitter.on('data', line => accum.push(line));
-                splitter.on('end', () => fulfill(accum));
-            });
-            assert(lines[0] == "This is a line\n" &&
-                lines[1] == "This is another line\n" &&
-                lines[2] == "And this is a line as well\n");
+            assert(lines[0] == "This is a line" &&
+                lines[1] == "This is another line" &&
+                lines[2] == "And this is a line as well");
         });
     },
     lineSplitStream2() {
         return __awaiter(this, void 0, void 0, function* () {
-            const splitter = (0, line_split_stream_1.makeLineSplitStream)();
+            const lines = [];
+            const splitter = (0, line_reader_1.makeLineReader)(line => lines.push(line));
             splitter.write('\nThis is a line\n');
             splitter.end();
-            const lines = yield new Promise(fulfill => {
-                let accum = [];
-                splitter.on('data', line => accum.push(line));
-                splitter.on('end', () => fulfill(accum));
-            });
-            assert(lines[0] == "\n" &&
-                lines[1] == "This is a line\n");
+            assert(lines[0] == "" &&
+                lines[1] == "This is a line");
         });
     },
     lineSplitStream3() {
         return __awaiter(this, void 0, void 0, function* () {
-            const splitter = (0, line_split_stream_1.makeLineSplitStream)();
+            const lines = [];
+            const splitter = (0, line_reader_1.makeLineReader)(line => lines.push(line));
             splitter.write('\n\n');
             splitter.end();
-            const lines = yield new Promise(fulfill => {
-                let accum = [];
-                splitter.on('data', line => accum.push(line));
-                splitter.on('end', () => fulfill(accum));
-            });
-            assert(lines[0] == "\n" &&
-                lines[1] == "\n");
+            assert(lines[0] == "" &&
+                lines[1] == "");
         });
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lsdsoftware/utils",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Useful JavaScript utilities",
   "main": "dist/index.js",
   "files": [

package/dist/line-split-stream.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="node" />
-import { Transform } from "stream";
-export declare function makeLineSplitStream(): Transform;

package/dist/line-split-stream.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeLineSplitStream = void 0;
-const stream_1 = require("stream");
-function makeLineSplitStream() {
-    // Buffer for the part of the chunk that doesn't form a complete line.
-    let remainder = '';
-    return new stream_1.Transform({
-        transform(chunk, encoding, callback) {
-            // Convert chunk to string and add it to the remainder.
-            const chunkStr = remainder + chunk.toString();
-            const lines = chunkStr.split('\n');
-            // Keep the last line in remainder if it doesn't end with a newline character.
-            remainder = lines.pop();
-            // Push each complete line.
-            for (const line of lines)
-                this.push(line + '\n');
-            callback();
-        },
-        flush(callback) {
-            // When the stream is ending, push any remainder as a line if it's not empty.
-            if (remainder)
-                this.push(remainder + '\n');
-            callback();
-        },
-    });
-}
-exports.makeLineSplitStream = makeLineSplitStream;