@xapi-js/adaptor-nestjs 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,151 +1,58 @@
-# @xapi-ts/adaptor-nestjs
-
-This package provides a NestJS adaptor for X-API data.
-
-## Installation
-
-```bash
-# npm
-npm install @xapi-ts/adaptor-nestjs
-
-# yarn
-yarn add @xapi-ts/adaptor-nestjs
-
-# pnpm
-pnpm add @xapi-ts/adaptor-nestjs
-
-# bun
-bun add @xapi-ts/adaptor-nestjs
-
-# deno
-deno add @xapi-ts/adaptor-nestjs
-```
-
-## Usage
-
-`@xapi-ts/adaptor-nestjs` provides NestJS interceptors to automatically handle X-API request deserialization and response serialization.
-
-### XapiRequestInterceptor
-
-Use `XapiRequestInterceptor` to automatically parse incoming `application/xml` requests into `XapiRoot` objects.
-
-```typescript
-// app.controller.ts
-import { Controller, Post, UseInterceptors, Body } from '@nestjs/common';
-import { XapiRoot } from '@xapi-ts/core';
-import { XapiRequestInterceptor } from '@xapi-ts/adaptor-nestjs';
-
-@Controller('xapi')
-export class AppController {
-  @Post('/')
-  @UseInterceptors(XapiRequestInterceptor)
-  handleXapi(@Body() xapi: XapiRoot): XapiRoot {
-    console.log('Received XapiRoot:', xapi.parameters.get('service')?.value);
-    // Process the XapiRoot object
-    const responseXapi = new XapiRoot();
-    responseXapi.addParameter({ id: 'result', value: 'success' });
-    return responseXapi;
-  }
-}
-```
-
-### XapiResponseInterceptor
-
-Use `XapiResponseInterceptor` to automatically serialize `XapiRoot` objects returned from your NestJS controllers into `application/xml` responses.
-
-```typescript
-// app.controller.ts
-import { Controller, Post, UseInterceptors, Body } from '@nestjs/common';
-import { XapiRoot } from '@xapi-ts/core
-import { XapiRequestInterceptor, XapiResponseInterceptor } from '@xapi-ts/adaptor-nestjs';
-
-@Controller('xapi')
-export class AppController {
-  @Post('/')
-  @UseInterceptors(XapiRequestInterceptor, XapiResponseInterceptor)
-  handleXapi(@Body() xapi: XapiRoot): XapiRoot {
-    console.log('Received XapiRoot:', xapi.parameters.get('service')?.value);
-    // Process the XapiRoot object
-    const responseXapi = new XapiRoot();
-    responseXapi.addParameter({ id: 'result', value: 'success' });
-    return responseXapi;
-  }
-}
-```
-
----
-
-# @xapi-ts/adaptor-nestjs
-
-이 패키지는 X-API 데이터를 위한 NestJS 어댑터를 제공합니다.
-
-## 설치
-
-```bash
-# npm
-npm install @xapi-ts/adaptor-nestjs
-
-# yarn
-yarn add @xapi-ts/adaptor-nestjs
-
-# pnpm
-pnpm add @xapi-ts/adaptor-nestjs
-
-# bun
-bun add @xapi-ts/adaptor-nestjs
-
-# deno
-deno add @xapi-ts/adaptor-nestjs
-```
-
-## 사용법
-
-`@xapi-ts/adaptor-nestjs`는 X-API 요청 역직렬화 및 응답 직렬화를 자동으로 처리하는 NestJS 인터셉터를 제공합니다.
-
-### XapiRequestInterceptor
-
-들어오는 `application/xml` 요청을 `XapiRoot` 객체로 자동 구문 분석하려면 `XapiRequestInterceptor`를 사용하십시오.
-
-```typescript
-// app.controller.ts
-import { Controller, Post, UseInterceptors, Body } from '@nestjs/common';
-import { XapiRoot } from '@xapi-ts/core';
-import { XapiRequestInterceptor } from '@xapi-ts/adaptor-nestjs';
-
-@Controller('xapi')
-export class AppController {
-  @Post('/')
-  @UseInterceptors(XapiRequestInterceptor)
-  handleXapi(@Body() xapi: XapiRoot): XapiRoot {
-    console.log('Received XapiRoot:', xapi.parameters.get('service')?.value);
-    // XapiRoot 객체 처리
-    const responseXapi = new XapiRoot();
-    responseXapi.addParameter({ id: 'result', value: 'success' });
-    return responseXapi;
-  }
-}
-```
-
-### XapiResponseInterceptor
-
-NestJS 컨트롤러에서 반환된 `XapiRoot` 객체를 `application/xml` 응답으로 자동 직렬화하려면 `XapiResponseInterceptor`를 사용하십시오.
-
-```typescript
-// app.controller.ts
-import { Controller, Post, UseInterceptors, Body } from '@nestjs/common';
-import { XapiRoot } from '@xapi-ts/core
-import { XapiRequestInterceptor, XapiResponseInterceptor } from '@xapi-ts/adaptor-nestjs';
-
-@Controller('xapi')
-export class AppController {
-  @Post('/')
-  @UseInterceptors(XapiRequestInterceptor, XapiResponseInterceptor)
-  handleXapi(@Body() xapi: XapiRoot): XapiRoot {
-    console.log('Received XapiRoot:', xapi.parameters.get('service')?.value);
-    // XapiRoot 객체 처리
-    const responseXapi = new XapiRoot();
-    responseXapi.addParameter({ id: 'result', value: 'success' });
-    return responseXapi;
-  }
-}
-```
+# @xapi-js/adaptor-nestjs
+
+NestJS interceptors for raw or schema-typed X-API requests and responses.
+
+## Installation
+
+```bash
+pnpm add @xapi-js/core @xapi-js/adaptor-nestjs @nestjs/common rxjs
+```
+
+## Typed usage
+
+```ts
+import { Body, Controller, Post, UseInterceptors } from '@nestjs/common';
+import { InferRoot, xapi } from '@xapi-js/core';
+import {
+  XapiRequestInterceptor,
+  XapiResponseInterceptor,
+} from '@xapi-js/adaptor-nestjs';
+
+const requestSchema = xapi.root({
+  datasets: {
+    input: xapi.dataset({ id: xapi.int() }),
+  },
+});
+
+const responseSchema = xapi.root({
+  datasets: {
+    users: xapi.dataset({ id: xapi.int(), name: xapi.string() }),
+  },
+});
+
+@Controller('xapi')
+export class XapiController {
+  @Post()
+  @UseInterceptors(
+    new XapiRequestInterceptor(requestSchema),
+    new XapiResponseInterceptor(responseSchema),
+  )
+  handle(
+    @Body() request: InferRoot<typeof requestSchema>,
+  ): InferRoot<typeof responseSchema> {
+    return {
+      parameters: {},
+      datasets: {
+        users: request.datasets.input.map(({ id }) => ({ id, name: `user-${id}` })),
+      },
+    };
+  }
+}
+```
+
+Without a schema, both interceptors retain their original `XapiRoot` behavior.
+
+---
+
+schema를 interceptor에 전달하면 컨트롤러 body와 반환값을 Dataset 기반
+`XapiRoot` 대신 타입이 추론된 plain object로 사용할 수 있습니다.

package/dist/index.cjs

@@ -1,37 +1,21 @@
-//#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 __nestjs_common = require("@nestjs/common");
-__nestjs_common = __toESM(__nestjs_common);
-let __xapi_js_core = require("@xapi-js/core");
-__xapi_js_core = __toESM(__xapi_js_core);
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _nestjs_common = require("@nestjs/common");
+let _xapi_js_core = require("@xapi-js/core");
 let rxjs = require("rxjs");
-rxjs = __toESM(rxjs);
-
+//#region \0@oxc-project+runtime@0.139.0/helpers/esm/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+//#endregion
 //#region src/xapi-request-interceptor.ts
-var XapiRequestInterceptor = @((0, __nestjs_common.Injectable)()) class XapiRequestInterceptor {
-	constructor() {
-		this.logger = new __nestjs_common.Logger(XapiRequestInterceptor.name);
+var _XapiRequestInterceptor;
+let XapiRequestInterceptor = _XapiRequestInterceptor = class XapiRequestInterceptor {
+	constructor(schema) {
+		this.schema = schema;
+		this.logger = new _nestjs_common.Logger(_XapiRequestInterceptor.name);
 	}
 	/**
 	* Intercepts the incoming request to parse XML body.
@@ -44,16 +28,21 @@ var XapiRequestInterceptor = @((0, __nestjs_common.Injectable)()) class XapiRequ
 	async intercept(context, next) {
 		const request = context.switchToHttp().getRequest();
 		this.logger.debug(`XapiRequestInterceptor Intercepting request: ${request.method} ${request.url}`);
-		if (request.headers["content-type"] === "application/xml" && request.body) request.body = await (0, __xapi_js_core.parse)(request.body);
+		if (request.headers["content-type"]?.startsWith("application/xml") && request.body) {
+			const root = (0, _xapi_js_core.parse)(request.body);
+			request.body = this.schema ? (0, _xapi_js_core.decodeRoot)(this.schema, root) : root;
+		}
 		return next.handle();
 	}
 };
-
+XapiRequestInterceptor = _XapiRequestInterceptor = __decorate([(0, _nestjs_common.Injectable)()], XapiRequestInterceptor);
 //#endregion
 //#region src/xapi-response-interceptor.ts
-var XapiResponseInterceptor = @((0, __nestjs_common.Injectable)()) class XapiResponseInterceptor {
-	constructor() {
-		this.logger = new __nestjs_common.Logger(XapiResponseInterceptor.name);
+var _XapiResponseInterceptor;
+let XapiResponseInterceptor = _XapiResponseInterceptor = class XapiResponseInterceptor {
+	constructor(schema) {
+		this.schema = schema;
+		this.logger = new _nestjs_common.Logger(_XapiResponseInterceptor.name);
 	}
 	/**
 	* Intercepts the outgoing response to serialize XapiRoot to XML string.
@@ -67,8 +56,9 @@ var XapiResponseInterceptor = @((0, __nestjs_common.Injectable)()) class XapiRes
 	intercept(context, next) {
 		this.logger.debug(`XapiResponseInterceptor Intercepting response`);
 		return next.handle().pipe((0, rxjs.map)((value) => {
-			if ((0, __xapi_js_core.isXapiRoot)(value)) try {
-				return (0, __xapi_js_core.write)(value);
+			const root = this.schema ? (0, _xapi_js_core.encodeRoot)(this.schema, value) : value;
+			if ((0, _xapi_js_core.isXapiRoot)(root)) try {
+				return (0, _xapi_js_core.write)(root);
 			} catch (error) {
 				this.logger.error(`Failed to serialize XapiRoot to XML string: ${error}`);
 				throw error;
@@ -77,7 +67,17 @@ var XapiResponseInterceptor = @((0, __nestjs_common.Injectable)()) class XapiRes
 		}));
 	}
 };
-
+XapiResponseInterceptor = _XapiResponseInterceptor = __decorate([(0, _nestjs_common.Injectable)()], XapiResponseInterceptor);
 //#endregion
-exports.XapiRequestInterceptor = XapiRequestInterceptor;
-exports.XapiResponseInterceptor = XapiResponseInterceptor;
+Object.defineProperty(exports, "XapiRequestInterceptor", {
+	enumerable: true,
+	get: function() {
+		return XapiRequestInterceptor;
+	}
+});
+Object.defineProperty(exports, "XapiResponseInterceptor", {
+	enumerable: true,
+	get: function() {
+		return XapiResponseInterceptor;
+	}
+});

package/dist/index.d.cts

@@ -1,16 +1,16 @@
 import { CallHandler, ExecutionContext, NestInterceptor } from "@nestjs/common";
+import { XapiRootSchema } from "@xapi-js/core";
 import { Observable } from "rxjs";
-import { XapiRoot } from "@xapi-js/core";
-
 //#region src/xapi-request-interceptor.d.ts
-
 /**
  * Interceptor that parses incoming XML request bodies into XapiRoot objects.
  * This interceptor should be applied to routes that expect an `application/xml` content type
  * and whose body contains X-API XML data.
  */
 declare class XapiRequestInterceptor implements NestInterceptor {
+  private readonly schema?;
   private readonly logger;
+  constructor(schema?: XapiRootSchema | undefined);
   /**
    * Intercepts the incoming request to parse XML body.
    * If the content type is `application/xml` and a body exists, it attempts to parse the body
@@ -28,8 +28,10 @@ declare class XapiRequestInterceptor implements NestInterceptor {
  * This interceptor should be applied to routes that return an `XapiRoot` instance
  * and whose response should be `application/xml`.
  */
-declare class XapiResponseInterceptor implements NestInterceptor<XapiRoot, string> {
+declare class XapiResponseInterceptor implements NestInterceptor<unknown, string> {
+  private readonly schema?;
   private readonly logger;
+  constructor(schema?: XapiRootSchema | undefined);
   /**
    * Intercepts the outgoing response to serialize XapiRoot to XML string.
    * If the handler returns an `XapiRoot` instance, it attempts to serialize it

package/dist/index.d.ts

@@ -1,16 +1,16 @@
 import { CallHandler, ExecutionContext, NestInterceptor } from "@nestjs/common";
-import { XapiRoot } from "@xapi-js/core";
+import { XapiRootSchema } from "@xapi-js/core";
 import { Observable } from "rxjs";
-
 //#region src/xapi-request-interceptor.d.ts
-
 /**
  * Interceptor that parses incoming XML request bodies into XapiRoot objects.
  * This interceptor should be applied to routes that expect an `application/xml` content type
  * and whose body contains X-API XML data.
  */
 declare class XapiRequestInterceptor implements NestInterceptor {
+  private readonly schema?;
   private readonly logger;
+  constructor(schema?: XapiRootSchema | undefined);
   /**
    * Intercepts the incoming request to parse XML body.
    * If the content type is `application/xml` and a body exists, it attempts to parse the body
@@ -28,8 +28,10 @@ declare class XapiRequestInterceptor implements NestInterceptor {
  * This interceptor should be applied to routes that return an `XapiRoot` instance
  * and whose response should be `application/xml`.
  */
-declare class XapiResponseInterceptor implements NestInterceptor<XapiRoot, string> {
+declare class XapiResponseInterceptor implements NestInterceptor<unknown, string> {
+  private readonly schema?;
   private readonly logger;
+  constructor(schema?: XapiRootSchema | undefined);
   /**
    * Intercepts the outgoing response to serialize XapiRoot to XML string.
    * If the handler returns an `XapiRoot` instance, it attempts to serialize it

package/dist/index.js

@@ -1,11 +1,20 @@
 import { Injectable, Logger } from "@nestjs/common";
-import { isXapiRoot, parse, write } from "@xapi-js/core";
+import { decodeRoot, encodeRoot, isXapiRoot, parse, write } from "@xapi-js/core";
 import { map } from "rxjs";
-
+//#region \0@oxc-project+runtime@0.139.0/helpers/esm/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+//#endregion
 //#region src/xapi-request-interceptor.ts
-var XapiRequestInterceptor = @Injectable() class XapiRequestInterceptor {
-	constructor() {
-		this.logger = new Logger(XapiRequestInterceptor.name);
+var _XapiRequestInterceptor;
+let XapiRequestInterceptor = _XapiRequestInterceptor = class XapiRequestInterceptor {
+	constructor(schema) {
+		this.schema = schema;
+		this.logger = new Logger(_XapiRequestInterceptor.name);
 	}
 	/**
 	* Intercepts the incoming request to parse XML body.
@@ -18,16 +27,21 @@ var XapiRequestInterceptor = @Injectable() class XapiRequestInterceptor {
 	async intercept(context, next) {
 		const request = context.switchToHttp().getRequest();
 		this.logger.debug(`XapiRequestInterceptor Intercepting request: ${request.method} ${request.url}`);
-		if (request.headers["content-type"] === "application/xml" && request.body) request.body = await parse(request.body);
+		if (request.headers["content-type"]?.startsWith("application/xml") && request.body) {
+			const root = parse(request.body);
+			request.body = this.schema ? decodeRoot(this.schema, root) : root;
+		}
 		return next.handle();
 	}
 };
-
+XapiRequestInterceptor = _XapiRequestInterceptor = __decorate([Injectable()], XapiRequestInterceptor);
 //#endregion
 //#region src/xapi-response-interceptor.ts
-var XapiResponseInterceptor = @Injectable() class XapiResponseInterceptor {
-	constructor() {
-		this.logger = new Logger(XapiResponseInterceptor.name);
+var _XapiResponseInterceptor;
+let XapiResponseInterceptor = _XapiResponseInterceptor = class XapiResponseInterceptor {
+	constructor(schema) {
+		this.schema = schema;
+		this.logger = new Logger(_XapiResponseInterceptor.name);
 	}
 	/**
 	* Intercepts the outgoing response to serialize XapiRoot to XML string.
@@ -41,8 +55,9 @@ var XapiResponseInterceptor = @Injectable() class XapiResponseInterceptor {
 	intercept(context, next) {
 		this.logger.debug(`XapiResponseInterceptor Intercepting response`);
 		return next.handle().pipe(map((value) => {
-			if (isXapiRoot(value)) try {
-				return write(value);
+			const root = this.schema ? encodeRoot(this.schema, value) : value;
+			if (isXapiRoot(root)) try {
+				return write(root);
 			} catch (error) {
 				this.logger.error(`Failed to serialize XapiRoot to XML string: ${error}`);
 				throw error;
@@ -51,6 +66,6 @@ var XapiResponseInterceptor = @Injectable() class XapiResponseInterceptor {
 		}));
 	}
 };
-
+XapiResponseInterceptor = _XapiResponseInterceptor = __decorate([Injectable()], XapiResponseInterceptor);
 //#endregion
-export { XapiRequestInterceptor, XapiResponseInterceptor };
+export { XapiRequestInterceptor, XapiResponseInterceptor };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xapi-js/adaptor-nestjs",
   "type": "module",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -33,7 +33,7 @@
     "express": "^5.1.0",
     "rxjs": "^7.8.1",
     "@nestjs/common": "^10.3.10",
-    "@xapi-js/core": "1.3.0"
+    "@xapi-js/core": "1.4.1"
   },
   "devDependencies": {},
   "scripts": {