mercury-composable 4.12.1

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 ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2018-2026 Accenture.
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,195 @@
1
+ # Mercury Composable — polyglot functions for Node.js
2
+
3
+ Write decoupled functions in JavaScript/TypeScript and let
4
+ [Mercury Composable](https://github.com/Accenture/mercury-composable) engines (Java, and the
5
+ official [Rust port](https://github.com/Accenture/mercury)) orchestrate them from Event Script
6
+ flows and MiniGraph knowledge graphs — with no orchestration code in Node.js at all.
7
+
8
+ This package is a deliberately **lightweight wrapper of the Event-over-HTTP protocol**:
9
+
10
+ - an **Event API host** (`POST /api/event`) that dispatches incoming event envelopes to your
11
+ registered functions,
12
+ - a **thin client** (`PostOffice`) to call functions on peer applications the same way,
13
+ - the **standard event envelope wire format** codec (language-neutral MsgPack), and
14
+ - a **primitive in-process event bus** — the single dispatch pipeline: one FIFO mailbox
15
+ per route consumed by `instances` worker loops, and
16
+ - the **minimalist utilities** shared with the engines for consistency: configuration
17
+ management, logging in the engines' presentation format, and distributed-trace context.
18
+
19
+ Orchestration deliberately stays in the engines. Functions written here are addressed by
20
+ route name through the engines' declarative `yaml.event.over.http` map, so a flow or a
21
+ graph task calls a Node.js function exactly as if it were local.
22
+
23
+ **Documentation:** <https://accenture.github.io/mercury-nodejs/> — including the
24
+ [AI Agent Guide](https://accenture.github.io/mercury-nodejs/guides/ai-agent-guide/)
25
+ for deterministic function generation.
26
+
27
+ > **Status: pre-release.** This repository was repurposed in August 2026 for the polyglot
28
+ > initiative: instead of re-porting the full composable foundation to Node.js, the fresh
29
+ > start rides the engines' Event-over-HTTP protocol — light by design. The previous
30
+ > Node.js port (up to v4.3.28) remains available in the git history and on npm.
31
+
32
+ ## Quick start
33
+
34
+ ```javascript
35
+ // app.mjs
36
+ import { AppException, platform, preload } from 'mercury-composable';
37
+
38
+ preload('hello.node', { instances: 10 }, async (headers, body) => {
39
+ if (typeof body !== 'object' || body === null || !('text' in body)) {
40
+ throw new AppException(400, "missing 'text'");
41
+ }
42
+ return { text: String(body.text).toUpperCase(), language: 'node.js' };
43
+ });
44
+
45
+ await platform.run(); // port from rest.server.port (default 8085)
46
+ ```
47
+
48
+ Run it:
49
+
50
+ ```bash
51
+ npm install && npm run build
52
+ node dist/src/cli.js app.mjs -Drest.server.port=8087 # or: mercury-serve app.mjs -Drest.server.port=8087
53
+ ```
54
+
55
+ Call it from a Mercury engine application with two configuration entries and no code —
56
+ `application.properties`:
57
+
58
+ ```properties
59
+ yaml.event.over.http=classpath:/event-over-http.yaml
60
+ ```
61
+
62
+ `event-over-http.yaml`:
63
+
64
+ ```yaml
65
+ event.http:
66
+ - route: 'hello.node'
67
+ target: 'http://127.0.0.1:8087/api/event'
68
+ ```
69
+
70
+ Any Event Script task or MiniGraph `graph.task` node that names the route `hello.node`
71
+ now executes the Node.js function, with trace context carried end to end.
72
+
73
+ ## The function contract
74
+
75
+ A handler receives the same two-part input as an engine `TypedLambdaFunction` —
76
+ `(headers, body)` — and returns the reply body (or an `EventEnvelope` for full control of
77
+ status and reply headers). Node.js is non-blocking by nature; handlers may be async.
78
+
79
+ - Throw `AppException(status, message)` for intentional errors — it becomes the portable
80
+ error contract on the wire (envelope status + message), handled by the calling flow's
81
+ exception handler or the graph's `error.*` contract.
82
+ - `getTrace()` exposes `traceId` / `tracePath` / `cid`; `annotateTrace(k, v)` sends an
83
+ annotation back on the reply envelope.
84
+ - Functions must be stateless; anything you must keep belongs to the caller's flow model
85
+ or state machine.
86
+
87
+ ### Local function calls
88
+
89
+ `PostOffice` **without an endpoint** delivers through this application's own event bus —
90
+ the engines' semantics for an in-app `po` call:
91
+
92
+ - `isPrivate: true` means exactly what it means in the engines: callable **in-app only**.
93
+ Local calls reach private and public routes alike; the HTTP host keeps answering 403
94
+ for private targets from the wire.
95
+ - `instances` is faithful: each route has one FIFO mailbox consumed by that many worker
96
+ loops. RPC waits are bounded by `timeoutMs` (the standard 408 envelope on breach), and
97
+ a queued call whose caller already timed out is skipped, never wastefully executed.
98
+ - There is **no spill tier and no queue cap** by design: back-pressure belongs to the tier
99
+ that owns recovery — the engines' flows and graphs. A leaf host fails fast by deadline
100
+ instead of hoarding work.
101
+
102
+ Local eventing is for simple leaf-side composition. Workflow processing belongs in Event
103
+ Script and Knowledge Graph on the engines — that boundary is the architecture.
104
+
105
+ ## Configuration, logging, telemetry
106
+
107
+ The same conventions as the engines, so a polyglot installation stays uniform:
108
+
109
+ | Key | Meaning | Default |
110
+ |-----|---------|---------|
111
+ | `application.name` | application identity in logs | `application` |
112
+ | `rest.server.port` | Event API port | `8085` |
113
+ | `log.format` | `text`, `json` (pretty-printed) or `compact` (single-line JSONL) | `text` |
114
+ | `log.level` | log level (`LOG_LEVEL` env var wins) | `INFO` |
115
+
116
+ Configuration lives in the `resources` folder, mirroring the engines:
117
+ `resources/application.yml` (or `.yaml` / `.properties`) in the working directory or next
118
+ to the application file, or an explicit `--config` path — see
119
+ [`examples/resources/application.yml`](examples/resources/application.yml) for a worked
120
+ sample. Values support `${ENV_VAR:default}` substitution. Runtime parameter overrides use the
121
+ same `-D` syntax as the Java engine and the Rust port — checked first on every read
122
+ (`appConfig().set(key, value)` does the same programmatically, the `f:setConfig` analog):
123
+
124
+ ```bash
125
+ mercury-serve app.mjs -Drest.server.port=8087 -Dlog.format=json
126
+ ```
127
+
128
+ Log lines follow the Java reference engine's pattern for one-aggregation consistency:
129
+
130
+ ```text
131
+ 2026-08-22 10:15:30.123 INFO app:12 - Loaded PUBLIC hello.node, instances=10
132
+ ```
133
+
134
+ ## Actuator endpoints
135
+
136
+ The host serves the engines' operational endpoints on the same port as `/api/event`, so
137
+ Kubernetes probes and dashboards treat a Node.js app exactly like a Java or Rust engine app:
138
+
139
+ | Endpoint | Purpose |
140
+ |----------|---------|
141
+ | `GET /` | minimal index page linking the endpoints below |
142
+ | `GET /info` | app identity, runtime, origin id, start time, uptime |
143
+ | `GET /info/routes` | registered routes split by visibility, with instance counts |
144
+ | `GET /env` | selected environment variables and configuration parameters |
145
+ | `GET /health` | dependency health checks — `UP` (HTTP 200) or `DOWN` (HTTP 400) |
146
+ | `GET /livenessprobe` | `OK` while the last health outcome was good, else HTTP 400 |
147
+
148
+ Configuration keys carry the engines' names: `info.app.version`, `info.app.description`,
149
+ `show.env.variables` and `show.application.properties` (opt-in lists — secrets are never
150
+ dumped wholesale), and `mandatory.health.dependencies` / `optional.health.dependencies`
151
+ (routes of health check functions; optional ones never change the overall status). A
152
+ health check function is a normal registered function — usually private — speaking the
153
+ engines' interface contract, called through the event bus:
154
+
155
+ ```javascript
156
+ preload('demo.health', { isPrivate: true }, async (headers, _body) => {
157
+ if (headers.type === 'info') {
158
+ return { service: 'demo.service', href: 'http://127.0.0.1' };
159
+ }
160
+ return 'demo.service is running fine'; // a non-200 reply marks it down
161
+ });
162
+ ```
163
+
164
+ JSON responses are pretty-printed — the engines' default-serializer presentation — and
165
+ unknown paths answer the engines' error shape
166
+ (`{"status": 404, "message": "Resource not found", "type": "error"}`).
167
+
168
+ Kubernetes wiring: point `livenessProbe` at `/livenessprobe` and `readinessProbe` at
169
+ `/health`.
170
+
171
+ ## Wire compatibility
172
+
173
+ The codec implements the
174
+ [Event Envelope Wire Format](https://accenture.github.io/mercury-composable/guides/event-envelope-wire-format/)
175
+ (standard format) and is verified against the golden conformance vectors shared by the
176
+ Java and Rust engines (`test/vectors/vectors.json`). The classic compact format is
177
+ detected and rejected with a teaching error — engines default to the standard format for
178
+ Event over HTTP.
179
+
180
+ Serialization notes: 64-bit integers beyond `Number.MAX_SAFE_INTEGER` decode as `BigInt`
181
+ (exact), smaller ones as `number`; timestamps travel as ISO-8601 UTC strings with
182
+ millisecond precision; binary payloads are `Uint8Array`.
183
+
184
+ ## Scope
185
+
186
+ This package intentionally contains **no orchestration: no flows, no graphs, no
187
+ persistence, no pub/sub broadcast** — those live in the engines. What it does carry is
188
+ deliberately minimal: functions, a primitive in-process event bus (route mailboxes +
189
+ workers, RPC and drop-n-forget — nothing more), and the minimalist foundation utilities,
190
+ keeping Node.js fast to prototype with while the composable core guarantees the
191
+ architecture.
192
+
193
+ ## License
194
+
195
+ Apache 2.0 — see [LICENSE](LICENSE).
@@ -0,0 +1,36 @@
1
+ import * as http from 'node:http';
2
+ import { FunctionRegistry } from './registry.js';
3
+ /**
4
+ * Unique instance id, minted once per process (the Java reference engine's
5
+ * format: UTC yyyyMMdd date prefix + 32-hex uuid).
6
+ */
7
+ export declare function appOrigin(): string;
8
+ /**
9
+ * Human-readable duration matching the engines' rendering (including their
10
+ * strict boundary behavior, kept verbatim for parity).
11
+ */
12
+ export declare function elapsedTime(milliseconds: number): string;
13
+ /** The engines' host-level error shape (SimpleHttpUtility signature). */
14
+ export declare function sendError(res: http.ServerResponse, status: number, message: string): void;
15
+ /** HTTP handlers for the actuator endpoints (wired by EventApiServer). */
16
+ export declare class Actuator {
17
+ private readonly registry;
18
+ private readonly start;
19
+ private healthy;
20
+ private readonly appName;
21
+ private readonly appVersion;
22
+ private readonly description;
23
+ private readonly required;
24
+ private readonly optional;
25
+ constructor(registry: FunctionRegistry);
26
+ /** Route a GET to its actuator endpoint; false when the path is not ours. */
27
+ handle(pathname: string, res: http.ServerResponse): Promise<boolean>;
28
+ private appBlock;
29
+ private info;
30
+ private routes;
31
+ private env;
32
+ private health;
33
+ private checkServices;
34
+ /** Probe one health-check function; false when it is missing or down. */
35
+ private checkService;
36
+ }