Merge pull request #319 from Roaders/main

Update build process / refine adaptor interface

Author: Roaders

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[*.ts]
+indent_size = 2

.gitattributes

@@ -0,0 +1,27 @@
+# Auto-detect text files and normalize
+* text=auto
+
+# Force LF for common text files
+*.js     text eol=lf
+*.cjs    text eol=lf
+*.mjs    text eol=lf
+*.ts     text eol=lf
+*.tsx    text eol=lf
+*.jsx    text eol=lf
+*.json   text eol=lf
+*.html   text eol=lf
+*.css    text eol=lf
+*.scss   text eol=lf
+*.md     text eol=lf
+*.yml    text eol=lf
+*.yaml   text eol=lf
+*.sh     text eol=lf
+
+# Binary files
+*.png    binary
+*.jpg    binary
+*.jpeg   binary
+*.gif    binary
+*.ico    binary
+*.pdf    binary
+*.zip    binary

.github/workflows/build-with-latest-deps.yml

@@ -0,0 +1,28 @@
+name: Build with latest dependencies
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+    workflow_dispatch:
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                node-version: [20.x, 22.x, 24.x]
+
+        steps:
+            - uses: actions/checkout@v5
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v6
+              with:
+                  node-version: ${{ matrix.node-version }}
+            - run: npm ci
+            - run: npm uninstall rxjs @morgan-stanley/needle uuid
+            - run: npm install rxjs@^7 @morgan-stanley/needle@^0 uuid@^13
+            - run: npm ls @morgan-stanley/needle uuid rxjs
+            - run: npm run build:release

.github/workflows/build.yml

@@ -21,7 +21,5 @@ jobs:
               uses: actions/setup-node@v6
               with:
                   node-version: ${{ matrix.node-version }}
-            - run: npm install
-            - run: npm run build-release
-            - run: npm run lint
-            - run: npm run test
+            - run: npm ci
+            - run: npm run build:release

.github/workflows/release.yml

@@ -27,10 +27,7 @@ jobs:
           node-version: '24'
 
       - name: Install node modules and verify build
-        run: npm install && npm run build-release
-
-      - name: Lint and test
-        run: npm run lint && npm run test
+        run: npm ci && npm run build:release
 
       - name: Publish
         run: npm publish --provenance --access public

.gitignore

@@ -6,4 +6,4 @@ reports/
 *.tgz
 npm-debug.log
 npm
-/package-lock.json
+coverage/

CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog and this project follows [Semantic Versioning](https://semver.org/).
+
+## [2.0.0] - 2025-11-21
+
+### Breaking
+
+- remove `rsvp` support from `IMessageBroker`
+- renamed all `RSVP` interfaces
+- tightened interfaces for definition of messaging channels for `IMessageBroker` and `IMessageBrokerAdapter`
+- removed `initialize` from `IMessageBrokerAdapter`
+- moved library to ESM
+
+### Added
+- Added `createMessage` function to `IMessageBroker`
+- message broker now calls `connect` and `disconnect` on registered adapters
+- added `ResponseBroker` in place of old rsvp functionality:
+
+```ts
+
+interface IMyAppResponseChannels {
+    channelOne: {
+        payload: MyCustomPayloadOne;
+        response: MyCustomResponseOne;
+    }
+    channelTwo: {
+        payload: MyCustomPayloadTwo;
+        response: MyCustomResponseTwo;
+    }
+}
+
+const responseBroker = new ResponseBroker<IMyAppResponseChannels>();
+
+// listen for response requests
+
+responseBroker.registerResponder("channelOne", (payload: MyCustomPayloadOne) => {
+    const response: MyCustomResponseOne = generateResponse();
+
+    return response;
+});
+
+// collate responses from multiple registered responders
+
+const payload: MyCustomPayloadOne = generatePayload();
+
+const result: ResponseReply<MyCustomResponseOne>[] = responseBroker.collate("channelOne", payload);
+
+```
+
+

eslint.config.js

@@ -0,0 +1,39 @@
+import eslint from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import prettierPlugin from 'eslint-plugin-prettier';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+import unusedImports from 'eslint-plugin-unused-imports';
+import tseslint from 'typescript-eslint';
+
+const prettierConfig = {
+    trailingComma: 'all',
+    tabWidth: 4,
+    singleQuote: true,
+    printWidth: 120,
+};
+
+export default defineConfig(
+    {
+        ignores: ['**/dist/', '**/reports/', '**/docs/', '**/site/'],
+    },
+    eslint.configs.recommended,
+    tseslint.configs.recommended,
+
+    {
+        plugins: {
+            prettier: prettierPlugin,
+            'simple-import-sort': simpleImportSort,
+            'unused-imports': unusedImports,
+        },
+
+        rules: {
+            '@typescript-eslint/explicit-module-boundary-types': 'off',
+            '@typescript-eslint/no-explicit-any': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+            '@typescript-eslint/no-this-alias': 'off',
+            'simple-import-sort/imports': 'error',
+            'unused-imports/no-unused-imports': 'error',
+            'prettier/prettier': ['error', prettierConfig],
+        },
+    },
+);