@3sixty/api-service 0.0.0-stage → 0.20.0-next.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# 3Sixty API Service
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This package provides information and hosting service implementations with generated REST route handlers.
+
+## Installation
+
+```shell
+npm install @3sixty/api-service
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
+
+## Origin
+
+This package is derived from the original [iotaledger/twin-api](https://github.com/iotaledger/twin-api/tree/next/packages/api-service) repository.

package/dist/es/healthApplicationTask.js

@@ -0,0 +1,151 @@
+import { ContextIdKeys, ContextIdStore } from "@3sixty/context";
+import { GeneralError, Is } from "@3sixty/core";
+import { ModuleHelper } from "@3sixty/modules";
+let engine;
+let startupPromise;
+let excludeCloneComponents;
+/**
+ * Start the engine clone used for application health checks.
+ * @param engineCloneData The engine clone data supplied automatically by the background task framework.
+ * @param excludeComponents Verified regular expression patterns for component types to exclude
+ * from the clone, validated by the health service before registration.
+ */
+export async function healthApplicationTaskStart(engineCloneData, excludeComponents) {
+    excludeCloneComponents = excludeComponents;
+    startupPromise = (async () => {
+        if (!Is.empty(engineCloneData)) {
+            const cloneData = Is.object(engineCloneData) && Is.arrayValue(excludeComponents)
+                ? await ModuleHelper.execModuleMethod("@3sixty/engine-models", "EngineCloneHelper.filterCloneComponents", [engineCloneData, excludeComponents])
+                : engineCloneData;
+            const clone = await ModuleHelper.execModuleMethod("@3sixty/engine-core", "EngineCoreBuilder.fromClone", [
+                "engine",
+                cloneData,
+                await ContextIdStore.getContextIds(),
+                { logLevel: "error" }
+            ]);
+            if (Is.empty(clone)) {
+                throw new GeneralError("applicationHealthTask", "engineNotStarted");
+            }
+            await clone.start();
+            engine = clone;
+        }
+    })();
+    try {
+        await startupPromise;
+    }
+    catch (err) {
+        startupPromise = undefined;
+        throw err;
+    }
+}
+/**
+ * Stop the engine clone used for application health checks.
+ */
+export async function healthApplicationTaskEnd() {
+    if (!Is.empty(engine)) {
+        await engine.stop();
+        engine = undefined;
+    }
+    startupPromise = undefined;
+    excludeCloneComponents = undefined;
+}
+/**
+ * Execute the application health lifecycle (init, application, teardown) across all registered
+ * components. Called by the background task framework in a worker thread; the engine clone data
+ * is used to initialise a local clone of the engine so component factories are available.
+ * @param engineCloneData The engine clone data supplied automatically by the background task framework.
+ * @returns The health entries collected across all three passes.
+ */
+export async function healthApplicationTask(engineCloneData) {
+    if (Is.empty(engineCloneData)) {
+        return [];
+    }
+    if (startupPromise) {
+        try {
+            await startupPromise;
+        }
+        catch {
+            startupPromise = undefined;
+        }
+    }
+    if (Is.empty(engine)) {
+        await healthApplicationTaskStart(engineCloneData, excludeCloneComponents);
+    }
+    return executeApplicationHealthCycle();
+}
+/**
+ * Run the application health lifecycle for each registered provider: initialise shared context,
+ * run the health checks, then tear down the per-check context in reverse registration order.
+ * @returns The health entries collected for the current application health pass.
+ */
+async function executeApplicationHealthCycle() {
+    if (Is.empty(engine)) {
+        throw new GeneralError("applicationHealthTask", "engineNotStarted");
+    }
+    const engineContextIds = engine.getContextIds() ?? {};
+    const registeredInstances = await engine.getRegisteredComponents();
+    // Pass 1: Init - providers populate healthContextIds with any IDs they establish
+    const healthContextIds = {
+        // Only use Node from the main engine context.
+        // All other keys should be provided by healthApplicationInit of each component
+        // as we don't want to use real ids.
+        [ContextIdKeys.Node]: engineContextIds[ContextIdKeys.Node]
+    };
+    for (const registeredInstance of registeredInstances) {
+        if (Is.object(registeredInstance.component)) {
+            const initMethod = registeredInstance.component.healthApplicationInit?.bind(registeredInstance.component);
+            if (Is.function(initMethod)) {
+                await initMethod(healthContextIds);
+            }
+        }
+    }
+    // Pass 2: Application health check wrapped in combined engine + init context
+    const allHealth = [];
+    const lazyPromises = [];
+    await ContextIdStore.run(healthContextIds, async () => {
+        for (const registeredInstance of registeredInstances) {
+            if (Is.object(registeredInstance.component)) {
+                const healthMethod = registeredInstance.component.healthApplication?.bind(registeredInstance.component);
+                if (Is.function(healthMethod)) {
+                    let fired = false;
+                    let callback = async () => { };
+                    const lazyPromise = new Promise(resolve => {
+                        callback = async (result) => {
+                            if (!fired) {
+                                fired = true;
+                                allHealth.push(...result);
+                                resolve();
+                            }
+                        };
+                    });
+                    const result = await healthMethod(callback);
+                    // undefined result indicates that the component will provide the
+                    // result asynchronously via the callback
+                    if (Is.undefined(result)) {
+                        lazyPromises.push(lazyPromise);
+                    }
+                    else {
+                        allHealth.push(...result);
+                    }
+                }
+            }
+        }
+    });
+    // Wait for all deferred callbacks before proceeding to teardown
+    if (lazyPromises.length > 0) {
+        await Promise.allSettled(lazyPromises);
+    }
+    // Pass 3: Teardown wrapped in combined engine + init context
+    await ContextIdStore.run(healthContextIds, async () => {
+        for (const registeredInstance of registeredInstances.slice().reverse()) {
+            if (Is.object(registeredInstance.component)) {
+                const teardownMethod = registeredInstance.component.healthApplicationTeardown?.bind(registeredInstance.component);
+                if (Is.function(teardownMethod)) {
+                    await teardownMethod();
+                }
+            }
+        }
+    });
+    return allHealth;
+}
+//# sourceMappingURL=healthApplicationTask.js.map

package/dist/es/healthApplicationTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthApplicationTask.js","sources":["../../src/healthApplicationTask.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,IAAI,MAOQ,CAAC;AACb,IAAI,cAAyC,CAAC;AAC9C,IAAI,sBAA4C,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC/C,eAAwB,EACxB,iBAA4B;IAE5B,sBAAsB,GAAG,iBAAiB,CAAC;IAE3C,cAAc,GAAG,CAAC,KAAK,IAAI,EAAE;QAC5B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;YAChC,MAAM,SAAS,GACd,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC;gBAC7D,CAAC,CAAC,MAAM,YAAY,CAAC,gBAAgB,CACnC,uBAAuB,EACvB,yCAAyC,EACzC,CAAC,eAAe,EAAE,iBAAiB,CAAC,CACpC;gBACF,CAAC,CAAC,eAAe,CAAC;YACpB,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAK9C,qBAAqB,EAAE,6BAA6B,EAAE;gBACxD,QAAQ;gBACR,SAAS;gBACT,MAAM,cAAc,CAAC,aAAa,EAAE;gBACpC,EAAE,QAAQ,EAAE,OAAO,EAAE;aACrB,CAAC,CAAC;YACH,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,YAAY,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;YACpB,MAAM,GAAG,KAAK,CAAC;QAChB,CAAC;IACF,CAAC,CAAC,EAAE,CAAC;IAEL,IAAI,CAAC;QACJ,MAAM,cAAc,CAAC;IACtB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,cAAc,GAAG,SAAS,CAAC;QAC3B,MAAM,GAAG,CAAC;IACX,CAAC;AACF,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB;IAC7C,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,MAAM,GAAG,SAAS,CAAC;IACpB,CAAC;IACD,cAAc,GAAG,SAAS,CAAC;IAC3B,sBAAsB,GAAG,SAAS,CAAC;AACpC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,eAAwB;IACnE,IAAI,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,CAAC;IACX,CAAC;IAED,IAAI,cAAc,EAAE,CAAC;QACpB,IAAI,CAAC;YACJ,MAAM,cAAc,CAAC;QACtB,CAAC;QAAC,MAAM,CAAC;YACR,cAAc,GAAG,SAAS,CAAC;QAC5B,CAAC;IACF,CAAC;IAED,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,MAAM,0BAA0B,CAAC,eAAe,EAAE,sBAAsB,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,6BAA6B,EAAE,CAAC;AACxC,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,6BAA6B;IAC3C,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,YAAY,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC;IACtD,MAAM,mBAAmB,GAAG,MAAM,MAAM,CAAC,uBAAuB,EAAE,CAAC;IAEnE,iFAAiF;IACjF,MAAM,gBAAgB,GAAgB;QACrC,8CAA8C;QAC9C,+EAA+E;QAC/E,oCAAoC;QACpC,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC;KAC1D,CAAC;IACF,KAAK,MAAM,kBAAkB,IAAI,mBAAmB,EAAE,CAAC;QACtD,IAAI,EAAE,CAAC,MAAM,CAA2B,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;YACvE,MAAM,UAAU,GAAG,kBAAkB,CAAC,SAAS,CAAC,qBAAqB,EAAE,IAAI,CAC1E,kBAAkB,CAAC,SAAS,CAC5B,CAAC;YACF,IAAI,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7B,MAAM,UAAU,CAAC,gBAAgB,CAAC,CAAC;YACpC,CAAC;QACF,CAAC;IACF,CAAC;IAED,6EAA6E;IAC7E,MAAM,SAAS,GAAc,EAAE,CAAC;IAChC,MAAM,YAAY,GAAoB,EAAE,CAAC;IAEzC,MAAM,cAAc,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QACrD,KAAK,MAAM,kBAAkB,IAAI,mBAAmB,EAAE,CAAC;YACtD,IAAI,EAAE,CAAC,MAAM,CAA2B,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;gBACvE,MAAM,YAAY,GAAG,kBAAkB,CAAC,SAAS,CAAC,iBAAiB,EAAE,IAAI,CACxE,kBAAkB,CAAC,SAAS,CAC5B,CAAC;gBACF,IAAI,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;oBAC/B,IAAI,KAAK,GAAG,KAAK,CAAC;oBAClB,IAAI,QAAQ,GAA8B,KAAK,IAAI,EAAE,GAAE,CAAC,CAAC;oBACzD,MAAM,WAAW,GAAG,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;wBAC/C,QAAQ,GAAG,KAAK,EAAE,MAAiB,EAAE,EAAE;4BACtC,IAAI,CAAC,KAAK,EAAE,CAAC;gCACZ,KAAK,GAAG,IAAI,CAAC;gCACb,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;gCAC1B,OAAO,EAAE,CAAC;4BACX,CAAC;wBACF,CAAC,CAAC;oBACH,CAAC,CAAC,CAAC;oBAEH,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;oBAC5C,iEAAiE;oBACjE,yCAAyC;oBACzC,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC1B,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBAChC,CAAC;yBAAM,CAAC;wBACP,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;oBAC3B,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC,CAAC,CAAC;IAEH,gEAAgE;IAChE,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IACxC,CAAC;IAED,6DAA6D;IAC7D,MAAM,cAAc,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QACrD,KAAK,MAAM,kBAAkB,IAAI,mBAAmB,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC;YACxE,IAAI,EAAE,CAAC,MAAM,CAA2B,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;gBACvE,MAAM,cAAc,GAAG,kBAAkB,CAAC,SAAS,CAAC,yBAAyB,EAAE,IAAI,CAClF,kBAAkB,CAAC,SAAS,CAC5B,CAAC;gBACF,IAAI,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;oBACjC,MAAM,cAAc,EAAE,CAAC;gBACxB,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC;AAClB,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tHealthApplicationCallback,\n\tIHealth,\n\tIHealthProviderComponent\n} from \"@3sixty/api-models\";\nimport { ContextIdKeys, ContextIdStore } from \"@3sixty/context\";\nimport type { IContextIds } from \"@3sixty/context\";\nimport { GeneralError, Is } from \"@3sixty/core\";\nimport type { IComponent } from \"@3sixty/core\";\nimport { ModuleHelper } from \"@3sixty/modules\";\n\nlet engine:\n\t| {\n\t\t\tstart: () => Promise<void>;\n\t\t\tstop: () => Promise<void>;\n\t\t\tgetContextIds: () => IContextIds | undefined;\n\t\t\tgetRegisteredComponents: () => Promise<{ instanceType: string; component: IComponent }[]>;\n\t  }\n\t| undefined;\nlet startupPromise: Promise<void> | undefined;\nlet excludeCloneComponents: string[] | undefined;\n\n/**\n * Start the engine clone used for application health checks.\n * @param engineCloneData The engine clone data supplied automatically by the background task framework.\n * @param excludeComponents Verified regular expression patterns for component types to exclude\n * from the clone, validated by the health service before registration.\n */\nexport async function healthApplicationTaskStart(\n\tengineCloneData: unknown,\n\texcludeComponents?: string[]\n): Promise<void> {\n\texcludeCloneComponents = excludeComponents;\n\n\tstartupPromise = (async () => {\n\t\tif (!Is.empty(engineCloneData)) {\n\t\t\tconst cloneData =\n\t\t\t\tIs.object(engineCloneData) && Is.arrayValue(excludeComponents)\n\t\t\t\t\t? await ModuleHelper.execModuleMethod<unknown>(\n\t\t\t\t\t\t\t\"@3sixty/engine-models\",\n\t\t\t\t\t\t\t\"EngineCloneHelper.filterCloneComponents\",\n\t\t\t\t\t\t\t[engineCloneData, excludeComponents]\n\t\t\t\t\t\t)\n\t\t\t\t\t: engineCloneData;\n\t\t\tconst clone = await ModuleHelper.execModuleMethod<{\n\t\t\t\tstart: () => Promise<void>;\n\t\t\t\tstop: () => Promise<void>;\n\t\t\t\tgetContextIds: () => IContextIds | undefined;\n\t\t\t\tgetRegisteredComponents: () => Promise<{ instanceType: string; component: IComponent }[]>;\n\t\t\t}>(\"@3sixty/engine-core\", \"EngineCoreBuilder.fromClone\", [\n\t\t\t\t\"engine\",\n\t\t\t\tcloneData,\n\t\t\t\tawait ContextIdStore.getContextIds(),\n\t\t\t\t{ logLevel: \"error\" }\n\t\t\t]);\n\t\t\tif (Is.empty(clone)) {\n\t\t\t\tthrow new GeneralError(\"applicationHealthTask\", \"engineNotStarted\");\n\t\t\t}\n\t\t\tawait clone.start();\n\t\t\tengine = clone;\n\t\t}\n\t})();\n\n\ttry {\n\t\tawait startupPromise;\n\t} catch (err) {\n\t\tstartupPromise = undefined;\n\t\tthrow err;\n\t}\n}\n\n/**\n * Stop the engine clone used for application health checks.\n */\nexport async function healthApplicationTaskEnd(): Promise<void> {\n\tif (!Is.empty(engine)) {\n\t\tawait engine.stop();\n\t\tengine = undefined;\n\t}\n\tstartupPromise = undefined;\n\texcludeCloneComponents = undefined;\n}\n\n/**\n * Execute the application health lifecycle (init, application, teardown) across all registered\n * components. Called by the background task framework in a worker thread; the engine clone data\n * is used to initialise a local clone of the engine so component factories are available.\n * @param engineCloneData The engine clone data supplied automatically by the background task framework.\n * @returns The health entries collected across all three passes.\n */\nexport async function healthApplicationTask(engineCloneData: unknown): Promise<IHealth[]> {\n\tif (Is.empty(engineCloneData)) {\n\t\treturn [];\n\t}\n\n\tif (startupPromise) {\n\t\ttry {\n\t\t\tawait startupPromise;\n\t\t} catch {\n\t\t\tstartupPromise = undefined;\n\t\t}\n\t}\n\n\tif (Is.empty(engine)) {\n\t\tawait healthApplicationTaskStart(engineCloneData, excludeCloneComponents);\n\t}\n\n\treturn executeApplicationHealthCycle();\n}\n\n/**\n * Run the application health lifecycle for each registered provider: initialise shared context,\n * run the health checks, then tear down the per-check context in reverse registration order.\n * @returns The health entries collected for the current application health pass.\n */\nasync function executeApplicationHealthCycle(): Promise<IHealth[]> {\n\tif (Is.empty(engine)) {\n\t\tthrow new GeneralError(\"applicationHealthTask\", \"engineNotStarted\");\n\t}\n\n\tconst engineContextIds = engine.getContextIds() ?? {};\n\tconst registeredInstances = await engine.getRegisteredComponents();\n\n\t// Pass 1: Init - providers populate healthContextIds with any IDs they establish\n\tconst healthContextIds: IContextIds = {\n\t\t// Only use Node from the main engine context.\n\t\t// All other keys should be provided by healthApplicationInit of each component\n\t\t// as we don't want to use real ids.\n\t\t[ContextIdKeys.Node]: engineContextIds[ContextIdKeys.Node]\n\t};\n\tfor (const registeredInstance of registeredInstances) {\n\t\tif (Is.object<IHealthProviderComponent>(registeredInstance.component)) {\n\t\t\tconst initMethod = registeredInstance.component.healthApplicationInit?.bind(\n\t\t\t\tregisteredInstance.component\n\t\t\t);\n\t\t\tif (Is.function(initMethod)) {\n\t\t\t\tawait initMethod(healthContextIds);\n\t\t\t}\n\t\t}\n\t}\n\n\t// Pass 2: Application health check wrapped in combined engine + init context\n\tconst allHealth: IHealth[] = [];\n\tconst lazyPromises: Promise<void>[] = [];\n\n\tawait ContextIdStore.run(healthContextIds, async () => {\n\t\tfor (const registeredInstance of registeredInstances) {\n\t\t\tif (Is.object<IHealthProviderComponent>(registeredInstance.component)) {\n\t\t\t\tconst healthMethod = registeredInstance.component.healthApplication?.bind(\n\t\t\t\t\tregisteredInstance.component\n\t\t\t\t);\n\t\t\t\tif (Is.function(healthMethod)) {\n\t\t\t\t\tlet fired = false;\n\t\t\t\t\tlet callback: HealthApplicationCallback = async () => {};\n\t\t\t\t\tconst lazyPromise = new Promise<void>(resolve => {\n\t\t\t\t\t\tcallback = async (result: IHealth[]) => {\n\t\t\t\t\t\t\tif (!fired) {\n\t\t\t\t\t\t\t\tfired = true;\n\t\t\t\t\t\t\t\tallHealth.push(...result);\n\t\t\t\t\t\t\t\tresolve();\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t};\n\t\t\t\t\t});\n\n\t\t\t\t\tconst result = await healthMethod(callback);\n\t\t\t\t\t// undefined result indicates that the component will provide the\n\t\t\t\t\t// result asynchronously via the callback\n\t\t\t\t\tif (Is.undefined(result)) {\n\t\t\t\t\t\tlazyPromises.push(lazyPromise);\n\t\t\t\t\t} else {\n\t\t\t\t\t\tallHealth.push(...result);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t});\n\n\t// Wait for all deferred callbacks before proceeding to teardown\n\tif (lazyPromises.length > 0) {\n\t\tawait Promise.allSettled(lazyPromises);\n\t}\n\n\t// Pass 3: Teardown wrapped in combined engine + init context\n\tawait ContextIdStore.run(healthContextIds, async () => {\n\t\tfor (const registeredInstance of registeredInstances.slice().reverse()) {\n\t\t\tif (Is.object<IHealthProviderComponent>(registeredInstance.component)) {\n\t\t\t\tconst teardownMethod = registeredInstance.component.healthApplicationTeardown?.bind(\n\t\t\t\t\tregisteredInstance.component\n\t\t\t\t);\n\t\t\t\tif (Is.function(teardownMethod)) {\n\t\t\t\t\tawait teardownMethod();\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t});\n\n\treturn allHealth;\n}\n"]}

package/dist/es/healthRoutes.js

@@ -0,0 +1,125 @@
+// Copyright 2024 IOTA Stiftung.
+// Copyright 2026 3Sixty Trade Ltd.
+// SPDX-License-Identifier: Apache-2.0.
+import { HealthCategory, HealthStatus } from "@3sixty/api-models";
+import { ComponentFactory } from "@3sixty/core";
+/**
+ * The tag to associate with the routes.
+ */
+export const tagsHealth = [
+    {
+        name: "Health",
+        description: "Health endpoints for the REST server."
+    }
+];
+/**
+ * The default authorization for the routes, used to seed authorization rules.
+ */
+const DEFAULT_AUTHORIZATION_READER = {
+    permission: "health:read",
+    role: "devops"
+};
+/**
+ * The REST routes for server health.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export function generateRestRoutesHealth(baseRouteName, componentName) {
+    const healthRoute = {
+        operationId: "serverHealth",
+        summary: "Get the health for the server",
+        tag: tagsHealth[0].name,
+        method: "GET",
+        path: `${baseRouteName}/`,
+        handler: async (httpRequestContext, request) => serverHealth(httpRequestContext, componentName, request),
+        responseType: [
+            {
+                type: "IServerHealthResponse",
+                examples: [
+                    {
+                        id: "healthResponseOK",
+                        description: "The response for the health request.",
+                        response: {
+                            body: {
+                                status: HealthStatus.Ok,
+                                components: [
+                                    {
+                                        source: "Database",
+                                        status: HealthStatus.Ok,
+                                        category: HealthCategory.Connectivity
+                                    },
+                                    {
+                                        source: "Storage",
+                                        status: HealthStatus.Ok,
+                                        category: HealthCategory.Connectivity
+                                    }
+                                ]
+                            }
+                        }
+                    },
+                    {
+                        id: "healthResponseWarning",
+                        description: "The response for the health request with warnings.",
+                        response: {
+                            body: {
+                                status: HealthStatus.Warning,
+                                components: [
+                                    {
+                                        source: "Database",
+                                        status: HealthStatus.Warning,
+                                        description: "slowRunning",
+                                        category: HealthCategory.Connectivity
+                                    },
+                                    {
+                                        source: "Storage",
+                                        status: HealthStatus.Ok,
+                                        category: HealthCategory.Connectivity
+                                    }
+                                ]
+                            }
+                        }
+                    },
+                    {
+                        id: "healthResponseError",
+                        description: "The response for the health request with errors.",
+                        response: {
+                            body: {
+                                status: HealthStatus.Error,
+                                components: [
+                                    {
+                                        source: "Database",
+                                        status: HealthStatus.Ok,
+                                        category: HealthCategory.Connectivity
+                                    },
+                                    {
+                                        source: "Storage",
+                                        status: HealthStatus.Error,
+                                        description: "storageFull",
+                                        category: HealthCategory.Connectivity
+                                    }
+                                ]
+                            }
+                        }
+                    }
+                ]
+            }
+        ],
+        defaultAuthorization: DEFAULT_AUTHORIZATION_READER
+    };
+    return [healthRoute];
+}
+/**
+ * Get the health for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function serverHealth(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    return {
+        body: await component.healthStatus()
+    };
+}
+//# sourceMappingURL=healthRoutes.js.map

package/dist/es/healthRoutes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthRoutes.js","sources":["../../src/healthRoutes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,mCAAmC;AACnC,uCAAuC;AACvC,OAAO,EACN,cAAc,EACd,YAAY,EAQZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGhD;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAW;IACjC;QACC,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,uCAAuC;KACpD;CACD,CAAC;AAEF;;GAEG;AACH,MAAM,4BAA4B,GAAwB;IACzD,UAAU,EAAE,aAAa;IACzB,IAAI,EAAE,QAAQ;CACd,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACvC,aAAqB,EACrB,aAAqB;IAErB,MAAM,WAAW,GAAyD;QACzE,WAAW,EAAE,cAAc;QAC3B,OAAO,EAAE,+BAA+B;QACxC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;QACvB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,YAAY,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACzD,YAAY,EAAE;YACb;gBACC,IAAI,EAAE,uBAAuB;gBAC7B,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,kBAAkB;wBACtB,WAAW,EAAE,sCAAsC;wBACnD,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,MAAM,EAAE,YAAY,CAAC,EAAE;gCACvB,UAAU,EAAE;oCACX;wCACC,MAAM,EAAE,UAAU;wCAClB,MAAM,EAAE,YAAY,CAAC,EAAE;wCACvB,QAAQ,EAAE,cAAc,CAAC,YAAY;qCACrC;oCACD;wCACC,MAAM,EAAE,SAAS;wCACjB,MAAM,EAAE,YAAY,CAAC,EAAE;wCACvB,QAAQ,EAAE,cAAc,CAAC,YAAY;qCACrC;iCACD;6BACD;yBACD;qBACD;oBACD;wBACC,EAAE,EAAE,uBAAuB;wBAC3B,WAAW,EAAE,oDAAoD;wBACjE,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,MAAM,EAAE,YAAY,CAAC,OAAO;gCAC5B,UAAU,EAAE;oCACX;wCACC,MAAM,EAAE,UAAU;wCAClB,MAAM,EAAE,YAAY,CAAC,OAAO;wCAC5B,WAAW,EAAE,aAAa;wCAC1B,QAAQ,EAAE,cAAc,CAAC,YAAY;qCACrC;oCACD;wCACC,MAAM,EAAE,SAAS;wCACjB,MAAM,EAAE,YAAY,CAAC,EAAE;wCACvB,QAAQ,EAAE,cAAc,CAAC,YAAY;qCACrC;iCACD;6BACD;yBACD;qBACD;oBACD;wBACC,EAAE,EAAE,qBAAqB;wBACzB,WAAW,EAAE,kDAAkD;wBAC/D,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,MAAM,EAAE,YAAY,CAAC,KAAK;gCAC1B,UAAU,EAAE;oCACX;wCACC,MAAM,EAAE,UAAU;wCAClB,MAAM,EAAE,YAAY,CAAC,EAAE;wCACvB,QAAQ,EAAE,cAAc,CAAC,YAAY;qCACrC;oCACD;wCACC,MAAM,EAAE,SAAS;wCACjB,MAAM,EAAE,YAAY,CAAC,KAAK;wCAC1B,WAAW,EAAE,aAAa;wCAC1B,QAAQ,EAAE,cAAc,CAAC,YAAY;qCACrC;iCACD;6BACD;yBACD;qBACD;iBACD;aACD;SACD;QACD,oBAAoB,EAAE,4BAA4B;KAClD,CAAC;IAEF,OAAO,CAAC,WAAW,CAAC,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CACjC,kBAAuC,EACvC,aAAqB,EACrB,OAA0B;IAE1B,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAmB,aAAa,CAAC,CAAC;IACxE,OAAO;QACN,IAAI,EAAE,MAAM,SAAS,CAAC,YAAY,EAAE;KACpC,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// Copyright 2026 3Sixty Trade Ltd.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tHealthCategory,\n\tHealthStatus,\n\ttype IHealthComponent,\n\ttype IHttpRequestContext,\n\ttype INoContentRequest,\n\ttype IRestRoute,\n\ttype IServerHealthResponse,\n\ttype ITag,\n\ttype IRouteAuthorization\n} from \"@3sixty/api-models\";\nimport { ComponentFactory } from \"@3sixty/core\";\n\n\n/**\n * The tag to associate with the routes.\n */\nexport const tagsHealth: ITag[] = [\n\t{\n\t\tname: \"Health\",\n\t\tdescription: \"Health endpoints for the REST server.\"\n\t}\n];\n\n/**\n * The default authorization for the routes, used to seed authorization rules.\n */\nconst DEFAULT_AUTHORIZATION_READER: IRouteAuthorization = {\n\tpermission: \"health:read\",\n\trole: \"devops\"\n};\n\n/**\n * The REST routes for server health.\n * @param baseRouteName Prefix to prepend to the paths.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @returns The generated routes.\n */\nexport function generateRestRoutesHealth(\n\tbaseRouteName: string,\n\tcomponentName: string\n): IRestRoute[] {\n\tconst healthRoute: IRestRoute<INoContentRequest, IServerHealthResponse> = {\n\t\toperationId: \"serverHealth\",\n\t\tsummary: \"Get the health for the server\",\n\t\ttag: tagsHealth[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tserverHealth(httpRequestContext, componentName, request),\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: \"IServerHealthResponse\",\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"healthResponseOK\",\n\t\t\t\t\t\tdescription: \"The response for the health request.\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tstatus: HealthStatus.Ok,\n\t\t\t\t\t\t\t\tcomponents: [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tsource: \"Database\",\n\t\t\t\t\t\t\t\t\t\tstatus: HealthStatus.Ok,\n\t\t\t\t\t\t\t\t\t\tcategory: HealthCategory.Connectivity\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tsource: \"Storage\",\n\t\t\t\t\t\t\t\t\t\tstatus: HealthStatus.Ok,\n\t\t\t\t\t\t\t\t\t\tcategory: HealthCategory.Connectivity\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"healthResponseWarning\",\n\t\t\t\t\t\tdescription: \"The response for the health request with warnings.\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tstatus: HealthStatus.Warning,\n\t\t\t\t\t\t\t\tcomponents: [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tsource: \"Database\",\n\t\t\t\t\t\t\t\t\t\tstatus: HealthStatus.Warning,\n\t\t\t\t\t\t\t\t\t\tdescription: \"slowRunning\",\n\t\t\t\t\t\t\t\t\t\tcategory: HealthCategory.Connectivity\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tsource: \"Storage\",\n\t\t\t\t\t\t\t\t\t\tstatus: HealthStatus.Ok,\n\t\t\t\t\t\t\t\t\t\tcategory: HealthCategory.Connectivity\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"healthResponseError\",\n\t\t\t\t\t\tdescription: \"The response for the health request with errors.\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tstatus: HealthStatus.Error,\n\t\t\t\t\t\t\t\tcomponents: [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tsource: \"Database\",\n\t\t\t\t\t\t\t\t\t\tstatus: HealthStatus.Ok,\n\t\t\t\t\t\t\t\t\t\tcategory: HealthCategory.Connectivity\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tsource: \"Storage\",\n\t\t\t\t\t\t\t\t\t\tstatus: HealthStatus.Error,\n\t\t\t\t\t\t\t\t\t\tdescription: \"storageFull\",\n\t\t\t\t\t\t\t\t\t\tcategory: HealthCategory.Connectivity\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\tdefaultAuthorization: DEFAULT_AUTHORIZATION_READER\n\t};\n\n\treturn [healthRoute];\n}\n\n/**\n * Get the health for the server.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function serverHealth(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: INoContentRequest\n): Promise<IServerHealthResponse> {\n\tconst component = ComponentFactory.get<IHealthComponent>(componentName);\n\treturn {\n\t\tbody: await component.healthStatus()\n\t};\n}\n"]}