@morgan-stanley/composeui-messaging-abstractions 0.1.0-alpha.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +68 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +160 -0
- package/dist/services/Delegates.d.ts +20 -0
- package/dist/services/IMessaging.d.ts +39 -0
- package/dist/services/JsonMessaging.d.ts +99 -0
- package/dist/services/JsonMessaging.test.d.ts +1 -0
- package/package.json +45 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2024 Morgan Stanley
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
@morgan-stanley/composeui-messaging-abstractions
|
|
2
|
+
|
|
3
|
+
Messaging helpers that wrap a lower‑level IMessaging abstraction (publish/subscribe plus request/response). Provides simple, typed APIs for sending and receiving structured data as JSON without duplicating serialization logic in callers. Provides JSON focused extension methods available using the `JsonMessaging` class.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Thin adapter: JsonMessaging delegates to any IMessaging implementation.
|
|
8
|
+
- Typed publish/subscribe via JSON (subscribeJson / publishJson).
|
|
9
|
+
- Typed request/response services (registerJsonService / invokeJsonService / invokeJsonServiceNoRequest).
|
|
10
|
+
- Automatic serialization/deserialization.
|
|
11
|
+
- String short‑circuit: if a typed service handler returns a string it is passed through without double JSON.stringify.
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
Install as a workspace dependency (pnpm/yarn/npm):
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @your-scope/composeui-messaging-abstractions
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
Implement the `IMessaging` API to declare your own communication.
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { IMessaging } from "@morgant-stanley/composeui-messaging-abstractions";
|
|
26
|
+
import { HubConnection } from '@microsoft/signalr';
|
|
27
|
+
|
|
28
|
+
export class MyMessaging implements IMessaging {
|
|
29
|
+
constructor(private readonly signalRMessaging: MySignalWrapper) {}
|
|
30
|
+
//Implement the IMessging API...
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Module format
|
|
35
|
+
|
|
36
|
+
Rollup emits dual builds:
|
|
37
|
+
- ES Module: dist/index.js
|
|
38
|
+
- CommonJS: dist/index.cjs
|
|
39
|
+
|
|
40
|
+
package.json exports map require to CJS and import to ESM. Use:
|
|
41
|
+
```typescript
|
|
42
|
+
// CJS
|
|
43
|
+
const { JsonMessaging } = require('@your-scope/composeui-messaging-abstractions');
|
|
44
|
+
|
|
45
|
+
// ESM / TypeScript
|
|
46
|
+
import { JsonMessaging } from '@your-scope/composeui-messaging-abstractions';
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Dependencies
|
|
50
|
+
|
|
51
|
+
Runtime:
|
|
52
|
+
- rxjs (Unsubscribable type)
|
|
53
|
+
|
|
54
|
+
Build / Dev:
|
|
55
|
+
- typescript
|
|
56
|
+
- @rollup/plugin-typescript
|
|
57
|
+
- @rollup/plugin-node-resolve
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
Apache-2.0 (see NOTICE and LICENSE files).
|
|
62
|
+
|
|
63
|
+
## Documentation
|
|
64
|
+
|
|
65
|
+
- [FDC3 Standard](https://fdc3.finos.org/)
|
|
66
|
+
- [ComposeUI Documentation](https://morganstanley.github.io/ComposeUI/)
|
|
67
|
+
|
|
68
|
+
© Morgan Stanley. See NOTICE file for additional information.
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
|
|
2
|
+
/**
|
|
3
|
+
* @license
|
|
4
|
+
* author: Morgan Stanley
|
|
5
|
+
* composeui-messaging-abstractions.js v0.1.0-alpha.10
|
|
6
|
+
* Released under the Apache-2.0 license.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
/*
|
|
10
|
+
* Morgan Stanley makes this available to you under the Apache License,
|
|
11
|
+
* Version 2.0 (the "License"). You may obtain a copy of the License at
|
|
12
|
+
* http://www.apache.org/licenses/LICENSE-2.0.
|
|
13
|
+
* See the NOTICE file distributed with this work for additional information
|
|
14
|
+
* regarding copyright ownership. Unless required by applicable law or agreed
|
|
15
|
+
* to in writing, software distributed under the License is distributed on an
|
|
16
|
+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
|
|
17
|
+
* or implied. See the License for the specific language governing permissions
|
|
18
|
+
* and limitations under the License.
|
|
19
|
+
*
|
|
20
|
+
*/
|
|
21
|
+
/**
|
|
22
|
+
* JSON wrapper around a lower-level IMessaging implementation.
|
|
23
|
+
* Provides typed helpers for publish/subscribe and request/response using JSON serialization.
|
|
24
|
+
*/
|
|
25
|
+
class JsonMessaging {
|
|
26
|
+
messaging;
|
|
27
|
+
/**
|
|
28
|
+
* Creates a new JsonMessaging adapter.
|
|
29
|
+
* @param messaging Underlying messaging implementation handling raw string messages.
|
|
30
|
+
*/
|
|
31
|
+
constructor(messaging) {
|
|
32
|
+
this.messaging = messaging;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Subscribes to a topic with a raw string handler.
|
|
36
|
+
* @param topic Topic identifier.
|
|
37
|
+
* @param subscriber Callback invoked with each serialized message string.
|
|
38
|
+
* @param cancellationToken Optional abort signal for subscription setup.
|
|
39
|
+
* @returns Promise resolving to an Unsubscribable to stop receiving messages.
|
|
40
|
+
*/
|
|
41
|
+
async subscribe(topic, subscriber, cancellationToken) {
|
|
42
|
+
return this.messaging.subscribe(topic, subscriber, cancellationToken);
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Publishes a raw string message.
|
|
46
|
+
* @param topic Topic identifier.
|
|
47
|
+
* @param message Serialized message string.
|
|
48
|
+
* @param cancellationToken Optional abort signal.
|
|
49
|
+
*/
|
|
50
|
+
async publish(topic, message, cancellationToken) {
|
|
51
|
+
return this.messaging.publish(topic, message, cancellationToken);
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Registers a raw service handler.
|
|
55
|
+
* @param serviceName Service name used for invocation.
|
|
56
|
+
* @param serviceHandler Handler operating on serialized request/response strings.
|
|
57
|
+
* @param cancellationToken Optional abort signal.
|
|
58
|
+
* @returns Promise resolving to an AsyncDisposable for unregistering.
|
|
59
|
+
*/
|
|
60
|
+
async registerService(serviceName, serviceHandler, cancellationToken) {
|
|
61
|
+
return this.messaging.registerService(serviceName, serviceHandler, cancellationToken);
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Invokes a raw service.
|
|
65
|
+
* @param serviceName Service name.
|
|
66
|
+
* @param payload Optional serialized request payload or null.
|
|
67
|
+
* @param cancellationToken Optional abort signal.
|
|
68
|
+
* @returns Promise resolving to a serialized response or null.
|
|
69
|
+
*/
|
|
70
|
+
async invokeService(serviceName, payload, cancellationToken) {
|
|
71
|
+
return this.messaging.invokeService(serviceName, payload, cancellationToken);
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Subscribes with a typed JSON payload handler.
|
|
75
|
+
* @typeParam TPayload Deserialized payload type.
|
|
76
|
+
* @param topic Topic identifier.
|
|
77
|
+
* @param typedSubscriber Callback receiving the typed payload.
|
|
78
|
+
* @param cancellationToken Optional abort signal.
|
|
79
|
+
* @returns Promise resolving to an Unsubscribable for the subscription.
|
|
80
|
+
*/
|
|
81
|
+
async subscribeJson(topic, typedSubscriber, cancellationToken) {
|
|
82
|
+
const jsonSubscriber = async (message) => {
|
|
83
|
+
const payload = JSON.parse(message);
|
|
84
|
+
await typedSubscriber(payload);
|
|
85
|
+
};
|
|
86
|
+
return this.messaging.subscribe(topic, jsonSubscriber, cancellationToken);
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Publishes a typed payload by JSON serializing it.
|
|
90
|
+
* @typeParam TPayload Payload type.
|
|
91
|
+
* @param topic Topic identifier.
|
|
92
|
+
* @param payload Typed payload instance.
|
|
93
|
+
* @param cancellationToken Optional abort signal.
|
|
94
|
+
*/
|
|
95
|
+
async publishJson(topic, payload, cancellationToken) {
|
|
96
|
+
const stringPayload = JSON.stringify(payload);
|
|
97
|
+
return this.messaging.publish(topic, stringPayload, cancellationToken);
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Invokes a service with a typed request and typed response.
|
|
101
|
+
* @typeParam TPayload Request type.
|
|
102
|
+
* @typeParam TResult Response type.
|
|
103
|
+
* @param serviceName Service name.
|
|
104
|
+
* @param payload Typed request payload.
|
|
105
|
+
* @param cancellationToken Optional abort signal.
|
|
106
|
+
* @returns Promise resolving to typed response or null.
|
|
107
|
+
*/
|
|
108
|
+
async invokeJsonService(serviceName, payload, cancellationToken) {
|
|
109
|
+
const stringPayload = JSON.stringify(payload);
|
|
110
|
+
const response = await this.messaging.invokeService(serviceName, stringPayload, cancellationToken);
|
|
111
|
+
if (response == null) {
|
|
112
|
+
return null;
|
|
113
|
+
}
|
|
114
|
+
return JSON.parse(response);
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Invokes a service that expects no request body.
|
|
118
|
+
* @typeParam TResult Response type.
|
|
119
|
+
* @param serviceName Service name.
|
|
120
|
+
* @param cancellationToken Optional abort signal.
|
|
121
|
+
* @returns Promise resolving to typed response or null.
|
|
122
|
+
*/
|
|
123
|
+
async invokeJsonServiceNoRequest(serviceName, cancellationToken) {
|
|
124
|
+
const response = await this.messaging.invokeService(serviceName, null, cancellationToken);
|
|
125
|
+
return response == null ? null : JSON.parse(response);
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Registers a typed JSON service handler.
|
|
129
|
+
* @typeParam TRequest Request type.
|
|
130
|
+
* @typeParam TResult Response type.
|
|
131
|
+
* @param serviceName Service name to register.
|
|
132
|
+
* @param typedHandler Handler receiving a typed request and returning a typed response or null.
|
|
133
|
+
* @param cancellationToken Optional abort signal.
|
|
134
|
+
* @returns Promise resolving to an AsyncDisposable for unregistering.
|
|
135
|
+
*/
|
|
136
|
+
async registerJsonService(serviceName, typedHandler, cancellationToken) {
|
|
137
|
+
const jsonServiceHandler = this.createJsonServiceHandler(typedHandler);
|
|
138
|
+
return this.messaging.registerService(serviceName, jsonServiceHandler, cancellationToken);
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Creates an internal raw service handler that performs JSON serialization/deserialization.
|
|
142
|
+
* @typeParam TRequest Request type.
|
|
143
|
+
* @typeParam TResult Response type.
|
|
144
|
+
* @param realHandler Typed handler to wrap.
|
|
145
|
+
* @returns A ServiceHandler operating on serialized strings.
|
|
146
|
+
*/
|
|
147
|
+
createJsonServiceHandler(realHandler) {
|
|
148
|
+
return async (payload) => {
|
|
149
|
+
const request = payload == null ? null : JSON.parse(payload);
|
|
150
|
+
const result = await realHandler(request);
|
|
151
|
+
if (typeof result === 'string') {
|
|
152
|
+
return result;
|
|
153
|
+
}
|
|
154
|
+
return result == null ? null : JSON.stringify(result);
|
|
155
|
+
};
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
export { JsonMessaging };
|
|
160
|
+
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VzIjpbIi4uL3NyYy9zZXJ2aWNlcy9Kc29uTWVzc2FnaW5nLnRzIl0sInNvdXJjZXNDb250ZW50IjpbbnVsbF0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7O0FBQUE7Ozs7Ozs7Ozs7O0FBV0c7QUFNSDs7O0FBR0c7TUFDVSxhQUFhLENBQUE7QUFLTyxJQUFBLFNBQUE7QUFKN0I7OztBQUdHO0FBQ0gsSUFBQSxXQUFBLENBQTZCLFNBQXFCLEVBQUE7UUFBckIsSUFBQSxDQUFBLFNBQVMsR0FBVCxTQUFTO0lBQWU7QUFFckQ7Ozs7OztBQU1HO0FBQ0gsSUFBQSxNQUFNLFNBQVMsQ0FBQyxLQUFhLEVBQUUsVUFBK0IsRUFBRSxpQkFBK0IsRUFBQTtBQUMzRixRQUFBLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsS0FBSyxFQUFFLFVBQVUsRUFBRSxpQkFBaUIsQ0FBQztJQUN6RTtBQUVBOzs7OztBQUtHO0FBQ0gsSUFBQSxNQUFNLE9BQU8sQ0FBQyxLQUFhLEVBQUUsT0FBZSxFQUFFLGlCQUErQixFQUFBO0FBQ3pFLFFBQUEsT0FBTyxJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsT0FBTyxFQUFFLGlCQUFpQixDQUFDO0lBQ3BFO0FBRUE7Ozs7OztBQU1HO0FBQ0gsSUFBQSxNQUFNLGVBQWUsQ0FBQyxXQUFtQixFQUFFLGNBQThCLEVBQUUsaUJBQStCLEVBQUE7QUFDdEcsUUFBQSxPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsZUFBZSxDQUFDLFdBQVcsRUFBRSxjQUFjLEVBQUUsaUJBQWlCLENBQUM7SUFDekY7QUFFQTs7Ozs7O0FBTUc7QUFDSCxJQUFBLE1BQU0sYUFBYSxDQUFDLFdBQW1CLEVBQUUsT0FBdUIsRUFBRSxpQkFBK0IsRUFBQTtBQUM3RixRQUFBLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxhQUFhLENBQUMsV0FBVyxFQUFFLE9BQU8sRUFBRSxpQkFBaUIsQ0FBQztJQUNoRjtBQUVBOzs7Ozs7O0FBT0c7QUFDSCxJQUFBLE1BQU0sYUFBYSxDQUNmLEtBQWEsRUFDYixlQUE0RCxFQUM1RCxpQkFBK0IsRUFBQTtBQUUvQixRQUFBLE1BQU0sY0FBYyxHQUF3QixPQUFPLE9BQWUsS0FBbUI7WUFDakYsTUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQWE7QUFDL0MsWUFBQSxNQUFNLGVBQWUsQ0FBQyxPQUFPLENBQUM7QUFDbEMsUUFBQSxDQUFDO0FBRUQsUUFBQSxPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLEtBQUssRUFBRSxjQUFjLEVBQUUsaUJBQWlCLENBQUM7SUFDN0U7QUFFQTs7Ozs7O0FBTUc7QUFDSCxJQUFBLE1BQU0sV0FBVyxDQUNiLEtBQWEsRUFDYixPQUFpQixFQUNqQixpQkFBK0IsRUFBQTtRQUUvQixNQUFNLGFBQWEsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQztBQUM3QyxRQUFBLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFLGFBQWEsRUFBRSxpQkFBaUIsQ0FBQztJQUMxRTtBQUVBOzs7Ozs7OztBQVFHO0FBQ0gsSUFBQSxNQUFNLGlCQUFpQixDQUNuQixXQUFtQixFQUNuQixPQUFpQixFQUNqQixpQkFBK0IsRUFBQTtRQUUvQixNQUFNLGFBQWEsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQztBQUM3QyxRQUFBLE1BQU0sUUFBUSxHQUFHLE1BQU0sSUFBSSxDQUFDLFNBQVMsQ0FBQyxhQUFhLENBQUMsV0FBVyxFQUFFLGFBQWEsRUFBRSxpQkFBaUIsQ0FBQztBQUVsRyxRQUFBLElBQUksUUFBUSxJQUFJLElBQUksRUFBRTtBQUNsQixZQUFBLE9BQU8sSUFBSTtRQUNmO0FBRUEsUUFBQSxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFZO0lBQzFDO0FBRUE7Ozs7OztBQU1HO0FBQ0gsSUFBQSxNQUFNLDBCQUEwQixDQUM1QixXQUFtQixFQUNuQixpQkFBK0IsRUFBQTtBQUUvQixRQUFBLE1BQU0sUUFBUSxHQUFHLE1BQU0sSUFBSSxDQUFDLFNBQVMsQ0FBQyxhQUFhLENBQUMsV0FBVyxFQUFFLElBQUksRUFBRSxpQkFBaUIsQ0FBQztBQUV6RixRQUFBLE9BQU8sUUFBUSxJQUFJLElBQUksR0FBRyxJQUFJLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQVk7SUFDcEU7QUFFQTs7Ozs7Ozs7QUFRRztBQUNILElBQUEsTUFBTSxtQkFBbUIsQ0FDckIsV0FBbUIsRUFDbkIsWUFBb0QsRUFDcEQsaUJBQStCLEVBQUE7UUFFL0IsTUFBTSxrQkFBa0IsR0FBRyxJQUFJLENBQUMsd0JBQXdCLENBQUMsWUFBWSxDQUFDO0FBQ3RFLFFBQUEsT0FBTyxJQUFJLENBQUMsU0FBUyxDQUFDLGVBQWUsQ0FBQyxXQUFXLEVBQUUsa0JBQWtCLEVBQUUsaUJBQWlCLENBQUM7SUFDN0Y7QUFFQTs7Ozs7O0FBTUc7QUFDSyxJQUFBLHdCQUF3QixDQUM1QixXQUFtRCxFQUFBO0FBRW5ELFFBQUEsT0FBTyxPQUFPLE9BQXVCLEtBQTRCO0FBQzdELFlBQUEsTUFBTSxPQUFPLEdBQUcsT0FBTyxJQUFJLElBQUksR0FBRyxJQUFJLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQWE7QUFDeEUsWUFBQSxNQUFNLE1BQU0sR0FBRyxNQUFNLFdBQVcsQ0FBQyxPQUFPLENBQUM7QUFFekMsWUFBQSxJQUFJLE9BQU8sTUFBTSxLQUFLLFFBQVEsRUFBRTtBQUM1QixnQkFBQSxPQUFPLE1BQU07WUFDakI7QUFFQSxZQUFBLE9BQU8sTUFBTSxJQUFJLElBQUksR0FBRyxJQUFJLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUM7QUFDekQsUUFBQSxDQUFDO0lBQ0w7QUFDSDs7OzsifQ==
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Handles a topic message already serialized as a string.
|
|
3
|
+
* @param payload Serialized message string.
|
|
4
|
+
* @returns A promise that resolves when processing is complete.
|
|
5
|
+
*/
|
|
6
|
+
export type TopicMessageHandler = (payload: string) => Promise<void>;
|
|
7
|
+
/**
|
|
8
|
+
* Handles a service request where the request and response are JSON-serialized strings.
|
|
9
|
+
* @param request Optional serialized request string or null.
|
|
10
|
+
* @returns A promise resolving to a serialized response string or null.
|
|
11
|
+
*/
|
|
12
|
+
export type ServiceHandler = (request?: string | null) => Promise<string | null>;
|
|
13
|
+
/**
|
|
14
|
+
* Handles a typed service request/response with generic payloads.
|
|
15
|
+
* @typeParam TRequest The request type after deserialization.
|
|
16
|
+
* @typeParam TResponse The response type before serialization.
|
|
17
|
+
* @param request Optional typed request or null.
|
|
18
|
+
* @returns A promise resolving to a typed response or null.
|
|
19
|
+
*/
|
|
20
|
+
export type TypedServiceHandler<TRequest, TResponse> = (request?: TRequest | null) => Promise<TResponse | null>;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { TopicMessageHandler, ServiceHandler } from './Delegates';
|
|
2
|
+
import { Unsubscribable } from 'rxjs';
|
|
3
|
+
/**
|
|
4
|
+
* Abstraction for basic messaging: publish/subscribe and request/response services.
|
|
5
|
+
*/
|
|
6
|
+
export interface IMessaging {
|
|
7
|
+
/**
|
|
8
|
+
* Subscribes to a topic and receives raw string messages.
|
|
9
|
+
* @param topic Topic identifier.
|
|
10
|
+
* @param subscriber Callback invoked for each serialized message.
|
|
11
|
+
* @param cancellationToken Optional abort signal to cancel subscription establishment.
|
|
12
|
+
* @returns Promise resolving to an Unsubscribable used to stop receiving messages.
|
|
13
|
+
*/
|
|
14
|
+
subscribe(topic: string, subscriber: TopicMessageHandler, cancellationToken?: AbortSignal): Promise<Unsubscribable>;
|
|
15
|
+
/**
|
|
16
|
+
* Publishes a raw string message to a topic.
|
|
17
|
+
* @param topic Topic identifier.
|
|
18
|
+
* @param message Serialized message string.
|
|
19
|
+
* @param cancellationToken Optional abort signal to cancel publish operation.
|
|
20
|
+
* @returns Promise that resolves when the message is dispatched.
|
|
21
|
+
*/
|
|
22
|
+
publish(topic: string, message: string, cancellationToken?: AbortSignal): Promise<void>;
|
|
23
|
+
/**
|
|
24
|
+
* Registers a service handler for request/response style messaging.
|
|
25
|
+
* @param serviceName Name used by clients to invoke this service.
|
|
26
|
+
* @param serviceHandler Handler receiving an optional serialized request and returning a serialized response or null.
|
|
27
|
+
* @param cancellationToken Optional abort signal to cancel registration.
|
|
28
|
+
* @returns Promise resolving to an AsyncDisposable to unregister the service.
|
|
29
|
+
*/
|
|
30
|
+
registerService(serviceName: string, serviceHandler: ServiceHandler, cancellationToken?: AbortSignal): Promise<AsyncDisposable>;
|
|
31
|
+
/**
|
|
32
|
+
* Invokes a registered service.
|
|
33
|
+
* @param serviceName Target service name.
|
|
34
|
+
* @param payload Optional serialized request payload or null.
|
|
35
|
+
* @param cancellationToken Optional abort signal to cancel invocation.
|
|
36
|
+
* @returns Promise resolving to a serialized response string or null.
|
|
37
|
+
*/
|
|
38
|
+
invokeService(serviceName: string, payload?: string | null, cancellationToken?: AbortSignal): Promise<string | null>;
|
|
39
|
+
}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { IMessaging } from './IMessaging';
|
|
2
|
+
import { TopicMessageHandler, ServiceHandler, TypedServiceHandler } from './Delegates';
|
|
3
|
+
import { Unsubscribable } from 'rxjs';
|
|
4
|
+
/**
|
|
5
|
+
* JSON wrapper around a lower-level IMessaging implementation.
|
|
6
|
+
* Provides typed helpers for publish/subscribe and request/response using JSON serialization.
|
|
7
|
+
*/
|
|
8
|
+
export declare class JsonMessaging implements IMessaging {
|
|
9
|
+
private readonly messaging;
|
|
10
|
+
/**
|
|
11
|
+
* Creates a new JsonMessaging adapter.
|
|
12
|
+
* @param messaging Underlying messaging implementation handling raw string messages.
|
|
13
|
+
*/
|
|
14
|
+
constructor(messaging: IMessaging);
|
|
15
|
+
/**
|
|
16
|
+
* Subscribes to a topic with a raw string handler.
|
|
17
|
+
* @param topic Topic identifier.
|
|
18
|
+
* @param subscriber Callback invoked with each serialized message string.
|
|
19
|
+
* @param cancellationToken Optional abort signal for subscription setup.
|
|
20
|
+
* @returns Promise resolving to an Unsubscribable to stop receiving messages.
|
|
21
|
+
*/
|
|
22
|
+
subscribe(topic: string, subscriber: TopicMessageHandler, cancellationToken?: AbortSignal): Promise<Unsubscribable>;
|
|
23
|
+
/**
|
|
24
|
+
* Publishes a raw string message.
|
|
25
|
+
* @param topic Topic identifier.
|
|
26
|
+
* @param message Serialized message string.
|
|
27
|
+
* @param cancellationToken Optional abort signal.
|
|
28
|
+
*/
|
|
29
|
+
publish(topic: string, message: string, cancellationToken?: AbortSignal): Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* Registers a raw service handler.
|
|
32
|
+
* @param serviceName Service name used for invocation.
|
|
33
|
+
* @param serviceHandler Handler operating on serialized request/response strings.
|
|
34
|
+
* @param cancellationToken Optional abort signal.
|
|
35
|
+
* @returns Promise resolving to an AsyncDisposable for unregistering.
|
|
36
|
+
*/
|
|
37
|
+
registerService(serviceName: string, serviceHandler: ServiceHandler, cancellationToken?: AbortSignal): Promise<AsyncDisposable>;
|
|
38
|
+
/**
|
|
39
|
+
* Invokes a raw service.
|
|
40
|
+
* @param serviceName Service name.
|
|
41
|
+
* @param payload Optional serialized request payload or null.
|
|
42
|
+
* @param cancellationToken Optional abort signal.
|
|
43
|
+
* @returns Promise resolving to a serialized response or null.
|
|
44
|
+
*/
|
|
45
|
+
invokeService(serviceName: string, payload?: string | null, cancellationToken?: AbortSignal): Promise<string | null>;
|
|
46
|
+
/**
|
|
47
|
+
* Subscribes with a typed JSON payload handler.
|
|
48
|
+
* @typeParam TPayload Deserialized payload type.
|
|
49
|
+
* @param topic Topic identifier.
|
|
50
|
+
* @param typedSubscriber Callback receiving the typed payload.
|
|
51
|
+
* @param cancellationToken Optional abort signal.
|
|
52
|
+
* @returns Promise resolving to an Unsubscribable for the subscription.
|
|
53
|
+
*/
|
|
54
|
+
subscribeJson<TPayload>(topic: string, typedSubscriber: (payload: TPayload) => void | Promise<void>, cancellationToken?: AbortSignal): Promise<Unsubscribable>;
|
|
55
|
+
/**
|
|
56
|
+
* Publishes a typed payload by JSON serializing it.
|
|
57
|
+
* @typeParam TPayload Payload type.
|
|
58
|
+
* @param topic Topic identifier.
|
|
59
|
+
* @param payload Typed payload instance.
|
|
60
|
+
* @param cancellationToken Optional abort signal.
|
|
61
|
+
*/
|
|
62
|
+
publishJson<TPayload>(topic: string, payload: TPayload, cancellationToken?: AbortSignal): Promise<void>;
|
|
63
|
+
/**
|
|
64
|
+
* Invokes a service with a typed request and typed response.
|
|
65
|
+
* @typeParam TPayload Request type.
|
|
66
|
+
* @typeParam TResult Response type.
|
|
67
|
+
* @param serviceName Service name.
|
|
68
|
+
* @param payload Typed request payload.
|
|
69
|
+
* @param cancellationToken Optional abort signal.
|
|
70
|
+
* @returns Promise resolving to typed response or null.
|
|
71
|
+
*/
|
|
72
|
+
invokeJsonService<TPayload, TResult>(serviceName: string, payload: TPayload, cancellationToken?: AbortSignal): Promise<TResult | null>;
|
|
73
|
+
/**
|
|
74
|
+
* Invokes a service that expects no request body.
|
|
75
|
+
* @typeParam TResult Response type.
|
|
76
|
+
* @param serviceName Service name.
|
|
77
|
+
* @param cancellationToken Optional abort signal.
|
|
78
|
+
* @returns Promise resolving to typed response or null.
|
|
79
|
+
*/
|
|
80
|
+
invokeJsonServiceNoRequest<TResult>(serviceName: string, cancellationToken?: AbortSignal): Promise<TResult | null>;
|
|
81
|
+
/**
|
|
82
|
+
* Registers a typed JSON service handler.
|
|
83
|
+
* @typeParam TRequest Request type.
|
|
84
|
+
* @typeParam TResult Response type.
|
|
85
|
+
* @param serviceName Service name to register.
|
|
86
|
+
* @param typedHandler Handler receiving a typed request and returning a typed response or null.
|
|
87
|
+
* @param cancellationToken Optional abort signal.
|
|
88
|
+
* @returns Promise resolving to an AsyncDisposable for unregistering.
|
|
89
|
+
*/
|
|
90
|
+
registerJsonService<TRequest, TResult>(serviceName: string, typedHandler: TypedServiceHandler<TRequest, TResult>, cancellationToken?: AbortSignal): Promise<AsyncDisposable>;
|
|
91
|
+
/**
|
|
92
|
+
* Creates an internal raw service handler that performs JSON serialization/deserialization.
|
|
93
|
+
* @typeParam TRequest Request type.
|
|
94
|
+
* @typeParam TResult Response type.
|
|
95
|
+
* @param realHandler Typed handler to wrap.
|
|
96
|
+
* @returns A ServiceHandler operating on serialized strings.
|
|
97
|
+
*/
|
|
98
|
+
private createJsonServiceHandler;
|
|
99
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/package.json
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@morgan-stanley/composeui-messaging-abstractions",
|
|
3
|
+
"version": "0.1.0-alpha.10",
|
|
4
|
+
"description": "TypeScript abstractions library for ComposeUI's messaging",
|
|
5
|
+
"private": false,
|
|
6
|
+
"author": "Morgan Stanley",
|
|
7
|
+
"license": "Apache-2.0",
|
|
8
|
+
"type": "module",
|
|
9
|
+
"files": [
|
|
10
|
+
"dist/**/*"
|
|
11
|
+
],
|
|
12
|
+
"main": "dist/index.js",
|
|
13
|
+
"module": "dist/index.js",
|
|
14
|
+
"types": "dist/index.d.ts",
|
|
15
|
+
"scripts": {
|
|
16
|
+
"build": "npm run build:clean && npm run build:rollup",
|
|
17
|
+
"build:clean": "rimraf dist",
|
|
18
|
+
"build:rollup": "rollup -c",
|
|
19
|
+
"test": "vitest run",
|
|
20
|
+
"test:watch": "vitest",
|
|
21
|
+
"test:coverage": "vitest run --coverage"
|
|
22
|
+
},
|
|
23
|
+
"publishConfig": {
|
|
24
|
+
"access": "public",
|
|
25
|
+
"provenance": true
|
|
26
|
+
},
|
|
27
|
+
"repository": {
|
|
28
|
+
"type": "git",
|
|
29
|
+
"url": "git+https://github.com/morganstanley/ComposeUI.git"
|
|
30
|
+
},
|
|
31
|
+
"dependencies": {
|
|
32
|
+
"rxjs": "^7.8.0"
|
|
33
|
+
},
|
|
34
|
+
"devDependencies": {
|
|
35
|
+
"@rollup/plugin-node-resolve": "^16.0.0",
|
|
36
|
+
"@rollup/plugin-typescript": "^12.1.0",
|
|
37
|
+
"@types/node": "^24.5.2",
|
|
38
|
+
"@vitest/coverage-v8": "^1.2.0",
|
|
39
|
+
"rollup": "^4.12.1",
|
|
40
|
+
"rollup-plugin-dts": "^6.1.0",
|
|
41
|
+
"typescript": "^5.0.0",
|
|
42
|
+
"vitest": "^1.2.0"
|
|
43
|
+
},
|
|
44
|
+
"gitHead": "4dc7ce6e9965a0b0a772e8d9b8f3cf348ba875df"
|
|
45
|
+
}
|