sse-cat 2.1.0 → 3.0.0

package/README.md

@@ -3,7 +3,7 @@ Command-line client for Server-Sent Events(SSE).
 
 ## Install
 ```sh
-npm install -g sse-cat
+npm install --global sse-cat
 # or
 yarn global add sse-cat
 ```
@@ -22,12 +22,12 @@ Usage: sse-cat [options] <url...>
 Command-line client for Server-Sent Events(SSE).
 
 Options:
-  -V, --version             output the version number
-  --header [header...]         Pass custom header(s) to server
-  --event [name...]            Pass custom event(s) that need to be captured
-  --heartbeat-event [name]
-  --heartbeat-timeout [ms]
-  -h, --help                display help for command
+  -V, --version                       output the version number
+  --header <header...>                Pass custom header(s) to server
+  --event <name...>                   Pass custom event(s) that need to be captured
+  --heartbeat-event <name>
+  --heartbeat-timeout <milliseconds>
+  -h, --help                          display help for command
 ```
 
 ### Single SSE

package/lib/cli.js

@@ -0,0 +1,80 @@
+#!/usr/bin/env node
+import { program } from 'commander';
+import { subscribeMessages } from './subscribe-events.js';
+import { parseHeaders } from "./utils/parse-headers.js";
+import { assert, isUndefined, isntUndefined } from '@blackglory/prelude';
+import { version, description } from "./utils/package.js";
+const name = 'sse-cat';
+process.title = name;
+program
+    .name(name)
+    .version(version)
+    .description(description)
+    .option('--header <header...>', 'Pass custom header(s) to server')
+    .option('--event <name...>', 'Pass custom event(s) that need to be captured')
+    .option('--heartbeat-event <name>')
+    .option('--heartbeat-timeout <milliseconds>')
+    .arguments('<url...>')
+    .action((urls) => {
+    const options = program.opts();
+    const headers = getHeaders(options);
+    const events = getEvents(options);
+    const heartbeatOptions = getHeartbeatOptions(options);
+    urls.forEach(async (url) => {
+        for await (const message of subscribeMessages(url, {
+            headers,
+            events,
+            heartbeat: heartbeatOptions
+        })) {
+            console.log(message);
+        }
+    });
+})
+    .parse();
+function getHeartbeatOptions(options) {
+    const heartbeatEvent = getHeartbeatEvent(options);
+    const heartbeatTimeout = getHeartbeatTimeout(options);
+    if (isntUndefined(heartbeatEvent) && isntUndefined(heartbeatTimeout)) {
+        const options = {
+            event: heartbeatEvent,
+            timeout: heartbeatTimeout
+        };
+        return options;
+    }
+    else {
+        return undefined;
+    }
+}
+function getHeartbeatTimeout(options) {
+    if (isUndefined(options.heartbeatTimeout)) {
+        return undefined;
+    }
+    else {
+        assert(isNumberString(options.heartbeatTimeout), 'The parameter heartbeat-timeout must be an integer');
+        const timeout = Number.parseInt(options.heartbeatTimeout, 10);
+        assert(timeout > 0, 'timeout must greater than zero');
+        return timeout;
+    }
+}
+function getHeartbeatEvent(options) {
+    return options.heartbeatEvent;
+}
+function getHeaders(options) {
+    var _a;
+    return parseHeaders((_a = options.header) !== null && _a !== void 0 ? _a : []);
+}
+function getEvents(options) {
+    return createEvents(options.event);
+}
+function createEvents(events) {
+    if (events && events.length > 0) {
+        return events;
+    }
+    else {
+        return ['message'];
+    }
+}
+function isNumberString(str) {
+    return /^\d+$/.test(str);
+}
+//# sourceMappingURL=cli.js.map

package/lib/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,iBAAiB,EAAqB,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EAAE,YAAY,EAAE,iCAA+B;AACtD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAExE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,2BAAyB;AASxD,MAAM,IAAI,GAAG,SAAS,CAAA;AACtB,OAAO,CAAC,KAAK,GAAG,IAAI,CAAA;AAEpB,OAAO;KACJ,IAAI,CAAC,IAAI,CAAC;KACV,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,WAAW,CAAC;KACxB,MAAM,CAAC,sBAAsB,EAAE,iCAAiC,CAAC;KACjE,MAAM,CAAC,mBAAmB,EAAE,+CAA+C,CAAC;KAC5E,MAAM,CAAC,0BAA0B,CAAC;KAClC,MAAM,CAAC,oCAAoC,CAAC;KAC5C,SAAS,CAAC,UAAU,CAAC;KACrB,MAAM,CAAC,CAAC,IAAc,EAAE,EAAE;IACzB,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAY,CAAA;IACxC,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IACnC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAA;IACjC,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAA;IAErD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAC,GAAG,EAAC,EAAE;QACvB,IAAI,KAAK,EACP,MAAM,OAAO,IAAI,iBAAiB,CAAC,GAAG,EAAE;YACtC,OAAO;YACP,MAAM;YACN,SAAS,EAAE,gBAAgB;SAC5B,CAAC,EACF;YACA,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;SACrB;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC;KACD,KAAK,EAAE,CAAA;AAEV,SAAS,mBAAmB,CAAC,OAAiB;IAC5C,MAAM,cAAc,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAA;IACjD,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAA;IAErD,IAAI,aAAa,CAAC,cAAc,CAAC,IAAI,aAAa,CAAC,gBAAgB,CAAC,EAAE;QACpE,MAAM,OAAO,GAAsB;YACjC,KAAK,EAAE,cAAc;YACrB,OAAO,EAAE,gBAAgB;SAC1B,CAAA;QACD,OAAO,OAAO,CAAA;KACf;SAAM;QACL,OAAO,SAAS,CAAA;KACjB;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAiB;IAC5C,IAAI,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;QACzC,OAAO,SAAS,CAAA;KACjB;SAAM;QACL,MAAM,CACJ,cAAc,CAAC,OAAO,CAAC,gBAAgB,CAAC,EACxC,oDAAoD,CACrD,CAAA;QAED,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;QAC7D,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE,gCAAgC,CAAC,CAAA;QAErD,OAAO,OAAO,CAAA;KACf;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAiB;IAC1C,OAAO,OAAO,CAAC,cAAc,CAAA;AAC/B,CAAC;AAED,SAAS,UAAU,CAAC,OAAiB;;IACnC,OAAO,YAAY,CAAC,MAAA,OAAO,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAA;AAC3C,CAAC;AAED,SAAS,SAAS,CAAC,OAAiB;IAClC,OAAO,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AACpC,CAAC;AAED,SAAS,YAAY,CAAC,MAAiB;IACrC,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/B,OAAO,MAAM,CAAA;KACd;SAAM;QACL,OAAO,CAAC,SAAS,CAAC,CAAA;KACnB;AACH,CAAC;AAED,SAAS,cAAc,CAAC,GAAW;IACjC,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC1B,CAAC"}

package/lib/subscribe-events.js

@@ -0,0 +1,51 @@
+import { setTimeout } from 'extra-timers';
+import { fetchEvents } from 'extra-sse';
+import { Request } from 'extra-fetch';
+import { isntUndefined } from '@blackglory/prelude';
+import { AbortController, AbortError } from 'extra-abort';
+export async function* subscribeMessages(url, { events, headers, heartbeat }) {
+    let cancelHeartbeatTimeout = undefined;
+    let lastEventId = undefined;
+    while (true) {
+        try {
+            const controller = new AbortController();
+            for await (const { event = 'message', data, id } of fetchEvents(() => new Request(url, { headers, signal: controller.signal }), { lastEventId })) {
+                if (isntUndefined(lastEventId)) {
+                    lastEventId = id;
+                }
+                if (heartbeat) {
+                    if (cancelHeartbeatTimeout) {
+                        if (heartbeat.event === event) {
+                            cancelHeartbeatTimeout();
+                            cancelHeartbeatTimeout = setTimeout(heartbeat.timeout, () => {
+                                controller.abort();
+                            });
+                        }
+                    }
+                    else {
+                        cancelHeartbeatTimeout = setTimeout(heartbeat.timeout, () => {
+                            controller.abort();
+                        });
+                    }
+                }
+                if (events.includes(event)) {
+                    if (isntUndefined(data)) {
+                        yield data;
+                    }
+                }
+            }
+        }
+        catch (e) {
+            if (e instanceof AbortError) {
+                console.error('heartbeat timeout');
+            }
+            else {
+                throw e;
+            }
+        }
+        finally {
+            cancelHeartbeatTimeout === null || cancelHeartbeatTimeout === void 0 ? void 0 : cancelHeartbeatTimeout();
+        }
+    }
+}
+//# sourceMappingURL=subscribe-events.js.map

package/lib/subscribe-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscribe-events.js","sourceRoot":"","sources":["../src/subscribe-events.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAOzD,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,iBAAiB,CACtC,GAAW,EACX,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAI3B;IAED,IAAI,sBAAsB,GAA6B,SAAS,CAAA;IAChE,IAAI,WAAW,GAAuB,SAAS,CAAA;IAE/C,OAAO,IAAI,EAAE;QACX,IAAI;YACF,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;YACxC,IAAI,KAAK,EACP,MAAM,EACJ,KAAK,GAAG,SAAS,EACjB,IAAI,EACJ,EAAE,EACH,IAAI,WAAW,CACd,GAAG,EAAE,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,EAC9D,EAAE,WAAW,EAAE,CAChB,EACD;gBACA,IAAI,aAAa,CAAC,WAAW,CAAC,EAAE;oBAC9B,WAAW,GAAG,EAAE,CAAA;iBACjB;gBAED,IAAI,SAAS,EAAE;oBACb,IAAI,sBAAsB,EAAE;wBAC1B,IAAI,SAAS,CAAC,KAAK,KAAK,KAAK,EAAE;4BAC7B,sBAAsB,EAAE,CAAA;4BACxB,sBAAsB,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE;gCAC1D,UAAU,CAAC,KAAK,EAAE,CAAA;4BACpB,CAAC,CAAC,CAAA;yBACH;qBACF;yBAAM;wBACL,sBAAsB,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE;4BAC1D,UAAU,CAAC,KAAK,EAAE,CAAA;wBACpB,CAAC,CAAC,CAAA;qBACH;iBACF;gBAED,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBAC1B,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE;wBACvB,MAAM,IAAI,CAAA;qBACX;iBACF;aACF;SACF;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,YAAY,UAAU,EAAE;gBAC3B,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;aACnC;iBAAM;gBACL,MAAM,CAAC,CAAA;aACR;SACF;gBAAS;YACR,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,EAAI,CAAA;SAC3B;KACF;AACH,CAAC"}

package/lib/utils/package.js

@@ -0,0 +1,16 @@
+import { fileURLToPath } from 'node:url';
+import { readJSONFileSync, findUpPackageFilenameSync } from 'extra-filesystem';
+import { assert, isString } from '@blackglory/prelude';
+import path from 'path';
+const pkgFilename = findUpPackageFilenameSync(fileURLToPath(new URL(import.meta.url)));
+assert(pkgFilename, 'The package.json is not found');
+export const pkgDirname = path.dirname(pkgFilename);
+const pkg = readJSONFileSync(pkgFilename);
+export const name = pkg.name;
+assert(isString(name), 'The name is not found in package.json');
+export const description = pkg.description;
+assert(isString(description), 'The description is not found in package.json');
+export const version = pkg.version;
+assert(isString(version), 'The version is not found in package.json');
+assert(/^\d+\.\d+\.\d+$/.test(version), 'The version is invalid');
+//# sourceMappingURL=package.js.map

package/lib/utils/package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/utils/package.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAA;AAC9E,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,IAAI,MAAM,MAAM,CAAA;AAEvB,MAAM,WAAW,GAAG,yBAAyB,CAC3C,aAAa,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CACxC,CAAA;AACD,MAAM,CAAC,WAAW,EAAE,+BAA+B,CAAC,CAAA;AAEpD,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;AAEnD,MAAM,GAAG,GAAG,gBAAgB,CAAyB,WAAW,CAAC,CAAA;AAEjE,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;AAC5B,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,uCAAuC,CAAC,CAAA;AAE/D,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAA;AAC1C,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,8CAA8C,CAAC,CAAA;AAE7E,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,CAAC,OAA0C,CAAA;AACrE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,0CAA0C,CAAC,CAAA;AACrE,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,wBAAwB,CAAC,CAAA"}

package/lib/utils/parse-headers.js

@@ -0,0 +1,4 @@
+export function parseHeaders(headers) {
+    return Object.fromEntries(headers.map(x => x.split(/:\s+/)));
+}
+//# sourceMappingURL=parse-headers.js.map

package/lib/utils/parse-headers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-headers.js","sourceRoot":"","sources":["../../src/utils/parse-headers.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,YAAY,CAAC,OAAiB;IAC5C,OAAO,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAC9D,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sse-cat",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "Command-line client for Server-Sent Events(SSE).",
   "keywords": [
     "CLI",
@@ -9,70 +9,77 @@
     "Server-Sent Event",
     "Server-Sent Events"
   ],
+  "type": "module",
   "bin": {
-    "sse-cat": "dist/cli.cjs"
+    "sse-cat": "lib/cli.js"
+  },
+  "engines": {
+    "node": ">=16"
   },
   "files": [
-    "dist"
+    "lib"
   ],
   "repository": "git@github.com:BlackGlory/sse-cat.git",
   "author": "BlackGlory <woshenmedoubuzhidao@blackglory.me>",
   "license": "MIT",
   "scripts": {
-    "deduplicate": "yarn-deduplicate",
-    "prepublishOnly": "run-s prepare clean build bundle",
     "prepare": "ts-patch install -s",
-    "lint": "eslint --ext .js,.jsx,.ts,.tsx --quiet src",
-    "test": "jest --config jest.config.js",
-    "test:coverage": "jest --coverage --config jest.config.js",
+    "deduplicate": "yarn-deduplicate",
+    "prepublishOnly": "run-s prepare clean build",
+    "lint": "eslint --ext .js,.jsx,.ts,.tsx --quiet src __tests__",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --runInBand --config jest.config.cjs",
+    "test:coverage": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --runInBand --coverage --config jest.config.cjs",
+    "test:debug": "cross-env NODE_OPTIONS='--experimental-vm-modules --inspect-brk' jest --runInBand --config jest.config.cjs",
     "dev": "ts-node -r tsconfig-paths/register src/cli.ts",
     "dev:debug": "node --inspect-brk node_modules/.bin/ts-node -r tsconfig-paths/register src/cli.ts",
-    "clean": "rimraf lib dist",
+    "clean": "rimraf lib",
     "build": "tsc --project tsconfig.build.json",
-    "bundle": "webpack --stats-error-details",
-    "smoke": "node dist/cli.cjs --help",
+    "smoke": "node lib/cli.js --help",
     "release": "standard-version"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "run-s prepare clean lint build test bundle smoke",
+      "pre-commit": "run-s prepare clean lint build test smoke",
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }
   },
-  "dependencies": {
-    "@blackglory/errors": "^2.2.1",
-    "@blackglory/go": "^1.1.1",
-    "@blackglory/types": "^1.2.1",
-    "commander": "^9.4.0",
-    "eventsource": "^2.0.2",
-    "extra-timers": "^0.2.5",
-    "hotypes": "^0.4.4",
-    "justypes": "^2.0.0",
-    "rxjs": "^7.5.6"
-  },
   "devDependencies": {
-    "@commitlint/cli": "^17.0.3",
-    "@commitlint/config-conventional": "^17.0.3",
-    "@types/eventsource": "^1.1.9",
-    "@types/jest": "^27.4.0",
-    "@types/node": "14",
-    "@typescript-eslint/eslint-plugin": "^5.31.0",
-    "@typescript-eslint/parser": "^5.31.0",
-    "eslint": "^8.20.0",
+    "@blackglory/jest-resolver": "^0.3.1",
+    "@commitlint/cli": "^17.6.7",
+    "@commitlint/config-conventional": "^17.6.7",
+    "@types/jest": "^29.5.3",
+    "@types/node": "20.4.5",
+    "@typescript-eslint/eslint-plugin": "^6.2.1",
+    "@typescript-eslint/parser": "^6.2.1",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.46.0",
+    "extra-promise": "^6.0.7",
     "husky": "4",
-    "jest": "^27.5.1",
+    "iterable-operator": "^4.0.6",
+    "jest": "^29.6.2",
+    "jest-resolve": "^29.6.2",
+    "msw": "^1.2.3",
     "npm-run-all": "^4.1.5",
-    "rimraf": "^3.0.2",
+    "return-style": "^3.0.1",
+    "rimraf": "^5.0.1",
     "standard-version": "^9.5.0",
-    "ts-jest": "^27.1.3",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "ts-patch": "^2.0.1",
-    "tsconfig-paths": "^4.0.0",
-    "typescript": "^4.7.4",
-    "typescript-transform-paths": "^3.3.1",
-    "webpack": "^5.74.0",
-    "webpack-cli": "^4.10.0",
-    "webpack-shebang-plugin": "^1.1.7",
-    "yarn-deduplicate": "^5.0.0"
+    "ts-patch": "^3.0.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.1.6",
+    "typescript-transform-paths": "^3.4.6",
+    "yarn-deduplicate": "^6.0.2"
+  },
+  "dependencies": {
+    "@blackglory/http-status": "^2.0.2",
+    "@blackglory/prelude": "^0.3.3",
+    "commander": "^11.0.0",
+    "extra-abort": "^0.3.7",
+    "extra-fetch": "^4.0.7",
+    "extra-filesystem": "^0.5.1",
+    "extra-sse": "^0.3.0",
+    "extra-timers": "^0.2.6",
+    "justypes": "^4.2.1"
   }
 }