@xapi-js/adaptor-express 1.0.0 → 1.2.0

package/README.md

@@ -1,29 +1,115 @@
-# @xapi-ts/adaptor-express
-
-This package provides an Express.js adaptor for X-API data.
-
-## Installation
-
-```bash
-pnpm add @xapi-ts/adaptor-express
-```
-
-## Usage
-
-(Add usage examples here)
-
----
-
-# @xapi-ts/adaptor-express
-
-이 패키지는 X-API 데이터를 위한 Express.js 어댑터를 제공합니다.
-
-## 설치
-
-```bash
-pnpm add @xapi-ts/adaptor-express
-```
-
-## 사용법
-
-(여기에 사용 예시를 추가하세요)
+# @xapi-ts/adaptor-express
+
+This package provides an Express.js adaptor for X-API data.
+
+## Installation
+
+```bash
+# npm
+npm install @xapi-ts/adaptor-express
+
+# yarn
+yarn add @xapi-ts/adaptor-express
+
+# pnpm
+pnpm add @xapi-ts/adaptor-express
+
+# bun
+bun add @xapi-ts/adaptor-express
+
+# deno
+deno add @xapi-ts/adaptor-express
+```
+
+## Usage
+
+Here's how to use `@xapi-ts/adaptor-express` with an Express application:
+
+```typescript
+import express from 'express';
+import { xapiExpress } from '@xapi-ts/adaptor-express';
+import { XapiRoot } from '@xapi-ts/core';
+
+const app = express();
+
+// Define your X-API handler function
+const xapiHandler = async (xapi: XapiRoot): Promise<XapiRoot> => {
+  // Process the incoming X-API request (xapi)
+  // For example, you can access parameters or datasets:
+  const service = xapi.parameters.get('service')?.value;
+  console.log(`Service requested: ${service}`);
+
+  // Create a response X-API object
+  const responseXapi = new XapiRoot();
+  responseXapi.addParameter({ id: 'result', value: 'success' });
+  return responseXapi;
+};
+
+// Use the xapiExpress middleware
+app.use('/xapi', xapiExpress(xapiHandler));
+
+// Start the server
+const PORT = 3000;
+app.listen(PORT, () => {
+  console.log(`Express server listening on port ${PORT}`);
+});
+```
+
+---
+
+# @xapi-ts/adaptor-express
+
+이 패키지는 X-API 데이터를 위한 Express.js 어댑터를 제공합니다.
+
+## 설치
+
+```bash
+# npm
+npm install @xapi-ts/adaptor-express
+
+# yarn
+yarn add @xapi-ts/adaptor-express
+
+# pnpm
+pnpm add @xapi-ts/adaptor-express
+
+# bun
+bun add @xapi-ts/adaptor-express
+
+# deno
+deno add @xapi-ts/adaptor-express
+```
+
+## 사용법
+
+다음은 Express 애플리케이션에서 `@xapi-ts/adaptor-express`를 사용하는 방법입니다:
+
+```typescript
+import express from 'express';
+import { xapiExpress } from '@xapi-ts/adaptor-express';
+import { XapiRoot } from '@xapi-ts/core';
+
+const app = express();
+
+// X-API 핸들러 함수 정의
+const xapiHandler = async (xapi: XapiRoot): Promise<XapiRoot> => {
+  // 들어오는 X-API 요청(xapi) 처리
+  // 예를 들어, 파라미터 또는 데이터셋에 접근할 수 있습니다:
+  const service = xapi.parameters.get('service')?.value;
+  console.log(`Service requested: ${service}`);
+
+  // 응답 X-API 객체 생성
+  const responseXapi = new XapiRoot();
+  responseXapi.addParameter({ id: 'result', value: 'success' });
+  return responseXapi;
+};
+
+// xapiExpress 미들웨어 사용
+app.use('/xapi', xapiExpress(xapiHandler));
+
+// 서버 시작
+const PORT = 3000;
+app.listen(PORT, () => {
+  console.log(`Express server listening on port ${PORT}`);
+});
+```

package/dist/index.cjs

@@ -0,0 +1,53 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let __xapi_js_core = require("@xapi-js/core");
+__xapi_js_core = __toESM(__xapi_js_core);
+
+//#region src/index.ts
+/**
+* Express middleware to handle X-API XML requests and responses.
+* It parses incoming XML into an XapiRoot object, passes it to the provided handler function,
+* and then serializes the handler's XapiRoot response back into XML.
+*
+* @param handler - An asynchronous function that takes an XapiRoot object and returns a Promise of an XapiRoot object.
+* @returns An Express middleware function.
+*/
+const xapiExpress = (handler) => {
+	return async (req, res, next) => {
+		if (req.headers["content-type"] !== "application/xml") return next();
+		try {
+			const xapiReq = (0, __xapi_js_core.parse)(req.body);
+			const xapiRes = await handler(xapiReq);
+			const xml = (0, __xapi_js_core.write)(xapiRes);
+			res.setHeader("Content-Type", "application/xml");
+			res.write(xml);
+			res.end();
+		} catch (error) {
+			next(error);
+		}
+	};
+};
+
+//#endregion
+exports.xapiExpress = xapiExpress;

package/dist/index.d.cts

@@ -0,0 +1,21 @@
+import { XapiRoot } from "@xapi-js/core";
+import { NextFunction, Request, Response } from "express";
+
+//#region src/index.d.ts
+
+/**
+ * Type definition for an X-API Express handler function.
+ * This function receives an XapiRoot object (parsed from the request body) and should return a Promise resolving to an XapiRoot object (for the response).
+ */
+type XapiExpressHandler = (xapi: XapiRoot) => Promise<XapiRoot>;
+/**
+ * Express middleware to handle X-API XML requests and responses.
+ * It parses incoming XML into an XapiRoot object, passes it to the provided handler function,
+ * and then serializes the handler's XapiRoot response back into XML.
+ *
+ * @param handler - An asynchronous function that takes an XapiRoot object and returns a Promise of an XapiRoot object.
+ * @returns An Express middleware function.
+ */
+declare const xapiExpress: (handler: XapiExpressHandler) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+//#endregion
+export { xapiExpress };

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { XapiRoot } from "@xapi-js/core";
+import { NextFunction, Request, Response } from "express";
+
+//#region src/index.d.ts
+
+/**
+ * Type definition for an X-API Express handler function.
+ * This function receives an XapiRoot object (parsed from the request body) and should return a Promise resolving to an XapiRoot object (for the response).
+ */
+type XapiExpressHandler = (xapi: XapiRoot) => Promise<XapiRoot>;
+/**
+ * Express middleware to handle X-API XML requests and responses.
+ * It parses incoming XML into an XapiRoot object, passes it to the provided handler function,
+ * and then serializes the handler's XapiRoot response back into XML.
+ *
+ * @param handler - An asynchronous function that takes an XapiRoot object and returns a Promise of an XapiRoot object.
+ * @returns An Express middleware function.
+ */
+declare const xapiExpress: (handler: XapiExpressHandler) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+//#endregion
+export { xapiExpress };

package/dist/index.js

@@ -0,0 +1,29 @@
+import { parse, write } from "@xapi-js/core";
+
+//#region src/index.ts
+/**
+* Express middleware to handle X-API XML requests and responses.
+* It parses incoming XML into an XapiRoot object, passes it to the provided handler function,
+* and then serializes the handler's XapiRoot response back into XML.
+*
+* @param handler - An asynchronous function that takes an XapiRoot object and returns a Promise of an XapiRoot object.
+* @returns An Express middleware function.
+*/
+const xapiExpress = (handler) => {
+	return async (req, res, next) => {
+		if (req.headers["content-type"] !== "application/xml") return next();
+		try {
+			const xapiReq = parse(req.body);
+			const xapiRes = await handler(xapiReq);
+			const xml = write(xapiRes);
+			res.setHeader("Content-Type", "application/xml");
+			res.write(xml);
+			res.end();
+		} catch (error) {
+			next(error);
+		}
+	};
+};
+
+//#endregion
+export { xapiExpress };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xapi-js/adaptor-express",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -31,14 +31,14 @@
   "license": "MIT",
   "dependencies": {
     "express": "^5.1.0",
-    "@xapi-js/core": "1.0.0"
+    "@xapi-js/core": "1.2.0"
   },
   "devDependencies": {
     "@types/express": "^5.0.3",
     "node-mocks-http": "^1.17.2"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "build": "tsdown",
     "test": "vitest run",
     "test:watch": "vitest",
     "coverage": "vitest run --coverage"