EPILIBS-186: wrap several endpoints with new adapters by kailerg · Pull Request #162 · forio/epicenter-libs

kailerg · 2026-04-20T18:53:27Z

Created with the help of AI

Not entirely sure what some endpoints do so i may have made some wrong assumptions or added inaccurate descriptions

automaton
context
dashboard
encyclopedia
fido2
forge
information
notification

gemini-code-assist

Code Review

This pull request introduces several new adapters to the epicenter-libs package, including automaton, context, dashboard, encyclopedia, fido2, forge, information, and notification. Each new adapter comes with comprehensive unit tests and updated type definitions. Additionally, common constants like MODEL_LANGUAGE and MORPHOLOGY have been centralized. Feedback highlights a necessary correction to the return type of the dashboard getAll method, the removal of redundant await keywords when chaining promises, and improvements for consistency in imports and test data access.

gemini-code-assist · 2026-04-20T18:56:17Z

@@ -0,0 +1,112 @@
+import type { RoutingOptions } from '../utils/router';
+
+import Router from '../utils/router';


For consistency with other adapter files in this PR (e.g., automaton.ts), please use a named import for Router. This also applies to src/adapters/fido2.ts.

Suggested change

import Router from '../utils/router';

import { Router } from '../utils/router';

^ I agree with keeping this consistent

gemini-code-assist · 2026-04-20T18:56:17Z

+        it('Should send the credential in the body', async () => {
+            await fido2Adapter.register(credential);
+            const req = capturedRequests[capturedRequests.length - 1];
+            const body = JSON.parse(req.requestBody);


There's an inconsistency in how the request body is accessed in the new test files. Some use req.requestBody while others use req.options.body. To maintain consistency across the test suite, please prefer using req.options.body.

This comment also applies to line 165 in this file and similar instances in tests/forge.spec.js.

Suggested change

const body = JSON.parse(req.requestBody);

const body = JSON.parse(req.options.body);

this is a bit of a style nitpick but I do agree, and req.options.body is consistent with the rest of hte test suite

sparklerfish · 2026-06-30T21:56:06Z

+ * @param [optionals]   Optional arguments; pass network call options overrides here.
+ * @returns promise that resolves when the translation is complete (204 no content)
+ */
+export async function translate(


The return type here is inaccurate per the Epicenter source, looks like the type varies by translator:

ASCIIDOC → text/plain

ASCIIDOC_TO_HTML → text/html

OPENAPI → application/json

Since Router is designed for JSON only (and throws on other types), we can follow the pattern that the assetAdapter uses to get the URL then do a direct fetch. Something like:

export async function translate(version, api, translator, optionals = {}) { const url = new Router() .getURL(`/encyclopedia/as/${translator}/v${version}/${api}`, optionals) .toString(); const session = authAdapter.getLocalSession(); const response = await fetch(url, { headers: session ? { Authorization: `Bearer ${session.token}` } : {}, }); return translator === 'OPENAPI' ? response.json() : response.text(); }

Then the return type of the function would be Promise<string | object>

sparklerfish · 2026-06-30T21:56:39Z

@@ -0,0 +1,112 @@
+import type { RoutingOptions } from '../utils/router';
+
+import Router from '../utils/router';


^ I agree with keeping this consistent

sparklerfish · 2026-06-30T22:00:57Z

+ *
+ * @param modelLanguage   The model language to check readiness for
+ * @param [optionals]     Optional arguments; pass network call options overrides here.
+ * @returns promise that resolves when the check is complete (204 no content)


Looks likeready returns a boolean (actually the only forge endpoint that doesn't return void)

sparklerfish · 2026-06-30T22:14:32Z

+ * @param optOutToken   Token used to opt out of notifications
+ * @param [optionals]   Optional arguments; pass network call options overrides here.
+ * @returns promise that resolves to the opt-out result
+ */


Looks like both optOut and optOutByType return a 303 redirect (they're email links that would be executed in a browser, rather than a fetch call). So for the libs purposes, the return type would just be Promise<void> and we can explain the 303 in the docstring (or maybe not even include them since this wouldn't ever be called this way, but if we're keeping them in for completeness, fix return type and document behavior)

sparklerfish · 2026-06-30T22:27:20Z

+
+export interface NotificationPreferenceCreateInView {
+    notificationType?: NotificationType;
+    adminKey?: string;


per NotificationResource in the Epicenter source, adminKey is required (so just drop the ?)

sparklerfish · 2026-06-30T23:14:46Z

+export interface DashboardPreferenceReadOutView {
+    projectKey: string | null;
+    adminKey: string | null;
+    items: Record<string, unknown>;


per DashboardPreference in the java, items is also nullable -
items: Record<string, unknown> | null;

sparklerfish · 2026-06-30T23:44:37Z

+
+        it('Should pass executionContext in the request body', async () => {
+            const executionContext = {
+                version: 1,


With the update of the execution context version type to string (or V1), this should also change to V1

sparklerfish · 2026-06-30T23:48:44Z

+        it('Should send the credential in the body', async () => {
+            await fido2Adapter.register(credential);
+            const req = capturedRequests[capturedRequests.length - 1];
+            const body = JSON.parse(req.requestBody);


this is a bit of a style nitpick but I do agree, and req.options.body is consistent with the rest of hte test suite

feat: wrap several endpoints with new adapters

b478b1e

kailerg changed the title ~~feat: wrap several endpoints with new adapters~~ EPILIBS-186: wrap several endpoints with new adapters Apr 20, 2026

gemini-code-assist Bot reviewed Apr 20, 2026

View reviewed changes

sparklerfish requested changes Jun 30, 2026

View reviewed changes

		@@ -0,0 +1,112 @@
		import type { RoutingOptions } from '../utils/router';

		import Router from '../utils/router';

	import Router from '../utils/router';
	import { Router } from '../utils/router';

	const body = JSON.parse(req.requestBody);
	const body = JSON.parse(req.options.body);

Uh oh!

Conversation

kailerg commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

gemini-code-assist Bot Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kailerg commented Apr 20, 2026 •

edited

Loading