@iflow-ai/search-openapi 0.1.0-pre.0

package/dist/server.js

@@ -0,0 +1,150 @@
+/**
+ * HTTP request listener for the iFlow Search OpenAPI server.
+ *
+ * Routes:
+ *   GET  /health                       — liveness, never gated by bearer auth
+ *   GET  /openapi.json                 — OpenAPI 3.1 schema (bearer-gated when configured)
+ *   POST /tools/iflow_web_search       — search-core webSearch passthrough
+ *   POST /tools/iflow_image_search     — search-core imageSearch passthrough
+ *   POST /tools/iflow_web_fetch        — search-core webFetch passthrough
+ *
+ * Design notes:
+ *   - The server is dependency-light: just the Node built-in `http` module
+ *     plus search-core. No Express / Fastify / Koa.
+ *   - All HTTP, Authorization, attribution headers, and iFlow error mapping
+ *     live in @iflow-ai/search-core. This server only translates between
+ *     JSON-over-HTTP and the typed search-core client.
+ *   - The handler list is the single source of truth for both the routes
+ *     and /openapi.json.
+ *   - Body size is capped at MAX_BODY_BYTES to keep tool platforms from
+ *     accidentally streaming megabytes into the server.
+ */
+import { checkBearer } from "./auth.js";
+import { TOOL_HANDLERS } from "./handlers/index.js";
+import { buildOpenApiDocument } from "./openapi.js";
+import { genericErrorBody } from "./errors.js";
+import { VERSION } from "./version.js";
+const MAX_BODY_BYTES = 1 * 1024 * 1024; // 1 MiB
+export function createApp(options) {
+    const { client, authToken } = options;
+    const openApiDocument = buildOpenApiDocument({
+        bearerAuth: authToken !== undefined,
+    });
+    const openApiJson = JSON.stringify(openApiDocument);
+    const handlersByPath = new Map();
+    for (const handler of TOOL_HANDLERS) {
+        handlersByPath.set(`/tools/${handler.name}`, handler);
+    }
+    return async function listener(req, res) {
+        try {
+            const method = req.method ?? "GET";
+            const url = new URL(req.url ?? "/", "http://localhost");
+            const pathname = url.pathname;
+            // /health is intentionally outside the auth gate.
+            if (method === "GET" && pathname === "/health") {
+                return sendJson(res, 200, { ok: true, version: VERSION });
+            }
+            const authResult = checkBearer(req.headers["authorization"], authToken);
+            if (!authResult.ok) {
+                return sendJson(res, authResult.status, {
+                    ok: false,
+                    error: { code: authResult.code, message: authResult.message },
+                });
+            }
+            if (method === "GET" && pathname === "/openapi.json") {
+                return sendRawJson(res, 200, openApiJson);
+            }
+            const toolHandler = handlersByPath.get(pathname);
+            if (toolHandler) {
+                if (method !== "POST") {
+                    return sendJson(res, 405, genericErrorBody("method_not_allowed", `Use POST for /tools/${toolHandler.name}.`));
+                }
+                const bodyResult = await readJsonBody(req);
+                if (!bodyResult.ok) {
+                    return sendJson(res, bodyResult.status, bodyResult.body);
+                }
+                const handlerResult = await toolHandler.handle(bodyResult.value, client);
+                return sendJson(res, handlerResult.status, handlerResult.body);
+            }
+            return sendJson(res, 404, genericErrorBody("not_found", `No route for ${method} ${pathname}.`));
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            // Last-resort fallback. Should never be reached because handlers
+            // route IFlowError through statusForIFlowError + iflowErrorToBody.
+            return sendJson(res, 500, genericErrorBody("internal_error", message));
+        }
+    };
+}
+async function readJsonBody(req) {
+    return new Promise((resolve) => {
+        const chunks = [];
+        let total = 0;
+        let aborted = false;
+        req.on("data", (chunk) => {
+            if (aborted)
+                return;
+            total += chunk.length;
+            if (total > MAX_BODY_BYTES) {
+                aborted = true;
+                req.destroy();
+                resolve({
+                    ok: false,
+                    status: 413,
+                    body: genericErrorBody("payload_too_large", `Request body exceeds ${MAX_BODY_BYTES} bytes.`),
+                });
+                return;
+            }
+            chunks.push(chunk);
+        });
+        req.on("end", () => {
+            if (aborted)
+                return;
+            const raw = Buffer.concat(chunks).toString("utf8").trim();
+            if (raw.length === 0) {
+                resolve({ ok: true, value: {} });
+                return;
+            }
+            try {
+                const parsed = JSON.parse(raw);
+                if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed)) {
+                    resolve({
+                        ok: false,
+                        status: 400,
+                        body: genericErrorBody("invalid_input", "Request body must be a JSON object."),
+                    });
+                    return;
+                }
+                resolve({ ok: true, value: parsed });
+            }
+            catch (err) {
+                const message = err instanceof Error ? err.message : String(err);
+                resolve({
+                    ok: false,
+                    status: 400,
+                    body: genericErrorBody("invalid_input", `Request body is not valid JSON: ${message}`),
+                });
+            }
+        });
+        req.on("error", (err) => {
+            if (aborted)
+                return;
+            aborted = true;
+            resolve({
+                ok: false,
+                status: 400,
+                body: genericErrorBody("invalid_input", err.message),
+            });
+        });
+    });
+}
+function sendJson(res, status, body) {
+    sendRawJson(res, status, JSON.stringify(body));
+}
+function sendRawJson(res, status, json) {
+    res.statusCode = status;
+    res.setHeader("Content-Type", "application/json; charset=utf-8");
+    res.setHeader("Content-Length", Buffer.byteLength(json).toString());
+    res.end(json);
+}
+//# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAIH,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,aAAa,EAAoB,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAkB,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,cAAc,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,QAAQ;AAShD,MAAM,UAAU,SAAS,CAAC,OAAmB;IAC3C,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACtC,MAAM,eAAe,GAAG,oBAAoB,CAAC;QAC3C,UAAU,EAAE,SAAS,KAAK,SAAS;KACpC,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAEpD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAuB,CAAC;IACtD,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;QACpC,cAAc,CAAC,GAAG,CAAC,UAAU,OAAO,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,KAAK,UAAU,QAAQ,CAAC,GAAG,EAAE,GAAG;QACrC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,KAAK,CAAC;YACnC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,kBAAkB,CAAC,CAAC;YACxD,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;YAE9B,kDAAkD;YAClD,IAAI,MAAM,KAAK,KAAK,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC/C,OAAO,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,UAAU,GAAG,WAAW,CAC5B,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,EAC5B,SAAS,CACV,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;gBACnB,OAAO,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,MAAM,EAAE;oBACtC,EAAE,EAAE,KAAK;oBACT,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE;iBAC1C,CAAC,CAAC;YACzB,CAAC;YAED,IAAI,MAAM,KAAK,KAAK,IAAI,QAAQ,KAAK,eAAe,EAAE,CAAC;gBACrD,OAAO,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;YAC5C,CAAC;YAED,MAAM,WAAW,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACjD,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;oBACtB,OAAO,QAAQ,CACb,GAAG,EACH,GAAG,EACH,gBAAgB,CACd,oBAAoB,EACpB,uBAAuB,WAAW,CAAC,IAAI,GAAG,CAC3C,CACF,CAAC;gBACJ,CAAC;gBAED,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;gBAC3C,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;oBACnB,OAAO,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC3D,CAAC;gBAED,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBACzE,OAAO,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;YACjE,CAAC;YAED,OAAO,QAAQ,CACb,GAAG,EACH,GAAG,EACH,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,MAAM,IAAI,QAAQ,GAAG,CAAC,CACrE,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjE,iEAAiE;YACjE,mEAAmE;YACnE,OAAO,QAAQ,CACb,GAAG,EACH,GAAG,EACH,gBAAgB,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAC5C,CAAC;QACJ,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAYD,KAAK,UAAU,YAAY,CACzB,GAAoB;IAEpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YAC/B,IAAI,OAAO;gBAAE,OAAO;YACpB,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC;YACtB,IAAI,KAAK,GAAG,cAAc,EAAE,CAAC;gBAC3B,OAAO,GAAG,IAAI,CAAC;gBACf,GAAG,CAAC,OAAO,EAAE,CAAC;gBACd,OAAO,CAAC;oBACN,EAAE,EAAE,KAAK;oBACT,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,gBAAgB,CACpB,mBAAmB,EACnB,wBAAwB,cAAc,SAAS,CAChD;iBACF,CAAC,CAAC;gBACH,OAAO;YACT,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YACjB,IAAI,OAAO;gBAAE,OAAO;YACpB,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;YAC1D,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrB,OAAO,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;gBACjC,OAAO;YACT,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC/B,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC3E,OAAO,CAAC;wBACN,EAAE,EAAE,KAAK;wBACT,MAAM,EAAE,GAAG;wBACX,IAAI,EAAE,gBAAgB,CACpB,eAAe,EACf,qCAAqC,CACtC;qBACF,CAAC,CAAC;oBACH,OAAO;gBACT,CAAC;gBACD,OAAO,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YACvC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjE,OAAO,CAAC;oBACN,EAAE,EAAE,KAAK;oBACT,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,gBAAgB,CACpB,eAAe,EACf,mCAAmC,OAAO,EAAE,CAC7C;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACtB,IAAI,OAAO;gBAAE,OAAO;YACpB,OAAO,GAAG,IAAI,CAAC;YACf,OAAO,CAAC;gBACN,EAAE,EAAE,KAAK;gBACT,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,gBAAgB,CAAC,eAAe,EAAE,GAAG,CAAC,OAAO,CAAC;aACrD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,GAAmB,EAAE,MAAc,EAAE,IAAY;IACjE,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,WAAW,CAAC,GAAmB,EAAE,MAAc,EAAE,IAAY;IACpE,GAAG,CAAC,UAAU,GAAG,MAAM,CAAC;IACxB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,iCAAiC,CAAC,CAAC;IACjE,GAAG,CAAC,SAAS,CAAC,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACpE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/dist/version.d.ts

@@ -0,0 +1,4 @@
+export declare const VERSION: string;
+export declare const INTEGRATION_NAME = "@iflow-ai/search-openapi";
+export declare const SOURCE = "openapi";
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,OAAO,EAAE,MAAoB,CAAC;AAC3C,eAAO,MAAM,gBAAgB,6BAA6B,CAAC;AAC3D,eAAO,MAAM,MAAM,YAAY,CAAC"}

package/dist/version.js

@@ -0,0 +1,7 @@
+import { createRequire } from "node:module";
+const localRequire = createRequire(import.meta.url);
+const pkg = localRequire("../package.json");
+export const VERSION = pkg.version;
+export const INTEGRATION_NAME = "@iflow-ai/search-openapi";
+export const SOURCE = "openapi";
+//# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,YAAY,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpD,MAAM,GAAG,GAAG,YAAY,CAAC,iBAAiB,CAAwB,CAAC;AAEnE,MAAM,CAAC,MAAM,OAAO,GAAW,GAAG,CAAC,OAAO,CAAC;AAC3C,MAAM,CAAC,MAAM,gBAAgB,GAAG,0BAA0B,CAAC;AAC3D,MAAM,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@iflow-ai/search-openapi",
+  "version": "0.1.0-pre.0",
+  "description": "HTTP / OpenAPI tool server for the iFlow Search API. Exposes web search, image search, and web fetch over JSON-over-HTTP for Open WebUI, Coze, and other OpenAPI 3.x tool hosts. Built on @iflow-ai/search-core.",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zhengyanglsun/iflow-search-js.git",
+    "directory": "packages/search-openapi"
+  },
+  "bugs": {
+    "url": "https://github.com/zhengyanglsun/iflow-search-js/issues"
+  },
+  "homepage": "https://github.com/zhengyanglsun/iflow-search-js/tree/main/packages/search-openapi#readme",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "iflow-search-openapi": "./dist/bin.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "iflow",
+    "iflow-search",
+    "openapi",
+    "http",
+    "tool-server",
+    "open-webui",
+    "coze",
+    "web-search",
+    "image-search",
+    "web-fetch"
+  ],
+  "dependencies": {
+    "@iflow-ai/search-core": "0.1.0-pre.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.6.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}