@xapi-js/adaptor-express 1.3.0 → 1.4.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Robert Soriano <https://github.com/wobsoriano>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Robert Soriano <https://github.com/wobsoriano>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,115 +1,51 @@
-# @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}`);
-});
-```
+# @xapi-js/adaptor-express
+
+Express middleware for raw or schema-typed X-API handlers.
+
+## Installation
+
+```bash
+pnpm add @xapi-js/core @xapi-js/adaptor-express express
+```
+
+## Typed usage
+
+```ts
+import express from 'express';
+import { xapi } from '@xapi-js/core';
+import { xapiExpress } from '@xapi-js/adaptor-express';
+
+const search = xapi.operation({
+  request: xapi.root({
+    datasets: {
+      input: xapi.dataset({ id: xapi.int() }),
+    },
+  }),
+  response: xapi.root({
+    datasets: {
+      users: xapi.dataset({
+        id: xapi.int(),
+        name: xapi.string({ size: 100 }),
+      }),
+    },
+  }),
+});
+
+const app = express();
+app.use(express.text({ type: 'application/xml' }));
+app.post('/xapi', xapiExpress(search, request => ({
+  parameters: {},
+  datasets: {
+    users: request.datasets.input.map(({ id }) => ({ id, name: `user-${id}` })),
+  },
+})));
+```
+
+The handler request and response types are inferred from the operation. The
+existing `xapiExpress(handler)` overload remains available for `XapiRoot`
+handlers.
+
+---
+
+operation schema를 넘기면 Express 핸들러가 Dataset 대신 타입이 추론된 배열과
+plain object를 직접 받고 반환합니다.

package/dist/index.cjs

@@ -1,51 +1,28 @@
-//#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);
-
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _xapi_js_core = require("@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();
+function xapiExpress(operationOrHandler, operationHandler) {
+	const operation = typeof operationOrHandler === "function" ? void 0 : operationOrHandler;
+	const handler = typeof operationOrHandler === "function" ? operationOrHandler : operationHandler;
+	return createMiddleware(async (req, res, next) => {
+		if (!req.headers["content-type"]?.startsWith("application/xml")) return next();
 		try {
-			const xml = (0, __xapi_js_core.write)(await handler((0, __xapi_js_core.parse)(req.body)));
+			const requestRoot = (0, _xapi_js_core.parse)(req.body);
+			const request = operation ? (0, _xapi_js_core.decodeRoot)(operation.request, requestRoot) : requestRoot;
+			const response = await handler(request);
+			const xml = (0, _xapi_js_core.write)(operation ? (0, _xapi_js_core.encodeRoot)(operation.response, response) : response);
 			res.setHeader("Content-Type", "application/xml");
 			res.write(xml);
 			res.end();
 		} catch (error) {
 			next(error);
 		}
+	});
+}
+function createMiddleware(middleware) {
+	return async (req, res, next) => {
+		return middleware(req, res, next);
 	};
-};
-
+}
 //#endregion
-exports.xapiExpress = xapiExpress;
+exports.xapiExpress = xapiExpress;

package/dist/index.d.cts

@@ -1,13 +1,12 @@
-import { XapiRoot } from "@xapi-js/core";
+import { RequestOf, ResponseOf, XapiOperation, 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>;
+type XapiOperationHandler<Operation extends XapiOperation> = (request: RequestOf<Operation>) => ResponseOf<Operation> | Promise<ResponseOf<Operation>>;
 /**
  * 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,
@@ -16,6 +15,8 @@ type XapiExpressHandler = (xapi: XapiRoot) => Promise<XapiRoot>;
  * @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>;
+declare function xapiExpress(handler: XapiExpressHandler): ReturnType<typeof createMiddleware>;
+declare function xapiExpress<Operation extends XapiOperation>(operation: Operation, handler: XapiOperationHandler<Operation>): ReturnType<typeof createMiddleware>;
+declare function createMiddleware(middleware: (req: Request, res: Response, next: NextFunction) => Promise<unknown>): (req: Request, res: Response, next: NextFunction) => Promise<unknown>;
 //#endregion
 export { xapiExpress };

package/dist/index.d.ts

@@ -1,13 +1,12 @@
-import { XapiRoot } from "@xapi-js/core";
+import { RequestOf, ResponseOf, XapiOperation, 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>;
+type XapiOperationHandler<Operation extends XapiOperation> = (request: RequestOf<Operation>) => ResponseOf<Operation> | Promise<ResponseOf<Operation>>;
 /**
  * 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,
@@ -16,6 +15,8 @@ type XapiExpressHandler = (xapi: XapiRoot) => Promise<XapiRoot>;
  * @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>;
+declare function xapiExpress(handler: XapiExpressHandler): ReturnType<typeof createMiddleware>;
+declare function xapiExpress<Operation extends XapiOperation>(operation: Operation, handler: XapiOperationHandler<Operation>): ReturnType<typeof createMiddleware>;
+declare function createMiddleware(middleware: (req: Request, res: Response, next: NextFunction) => Promise<unknown>): (req: Request, res: Response, next: NextFunction) => Promise<unknown>;
 //#endregion
 export { xapiExpress };

package/dist/index.js

@@ -1,27 +1,27 @@
-import { parse, write } from "@xapi-js/core";
-
+import { decodeRoot, encodeRoot, 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();
+function xapiExpress(operationOrHandler, operationHandler) {
+	const operation = typeof operationOrHandler === "function" ? void 0 : operationOrHandler;
+	const handler = typeof operationOrHandler === "function" ? operationOrHandler : operationHandler;
+	return createMiddleware(async (req, res, next) => {
+		if (!req.headers["content-type"]?.startsWith("application/xml")) return next();
 		try {
-			const xml = write(await handler(parse(req.body)));
+			const requestRoot = parse(req.body);
+			const request = operation ? decodeRoot(operation.request, requestRoot) : requestRoot;
+			const response = await handler(request);
+			const xml = write(operation ? encodeRoot(operation.response, response) : response);
 			res.setHeader("Content-Type", "application/xml");
 			res.write(xml);
 			res.end();
 		} catch (error) {
 			next(error);
 		}
+	});
+}
+function createMiddleware(middleware) {
+	return async (req, res, next) => {
+		return middleware(req, res, next);
 	};
-};
-
+}
 //#endregion
-export { xapiExpress };
+export { xapiExpress };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xapi-js/adaptor-express",
   "type": "module",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -31,7 +31,7 @@
   "license": "MIT",
   "dependencies": {
     "express": "^5.1.0",
-    "@xapi-js/core": "1.3.0"
+    "@xapi-js/core": "1.4.1"
   },
   "devDependencies": {
     "@types/express": "^5.0.3",