npm - @xapi-js/adaptor-nestjs - Versions diffs - 1.1.0 → 1.2.0 - Mend

@xapi-js/adaptor-nestjs 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

package/dist/index.cjs +83 -0
package/dist/index.d.cts +45 -0
package/dist/index.d.ts +45 -0
package/dist/index.js +56 -0
package/package.json +6 -3
package/coverage/base.css +0 -224
package/coverage/block-navigation.js +0 -87
package/coverage/clover.xml +0 -49
package/coverage/coverage-final.json +0 -3
package/coverage/favicon.png +0 -0
package/coverage/index.html +0 -131
package/coverage/prettify.css +0 -1
package/coverage/prettify.js +0 -2
package/coverage/sort-arrow-sprite.png +0 -0
package/coverage/sorter.js +0 -196
package/coverage/xapi-request-interceptor.ts.html +0 -133
package/coverage/xapi-response-interceptor.ts.html +0 -169
package/src/xapi-request-interceptor.ts +0 -31
package/src/xapi-response-interceptor.ts +0 -43
package/test/xapi-request-interceptor.test.ts +0 -115
package/test/xapi-response-interceptor.test.ts +0 -113
package/vitest.config.ts +0 -16

package/coverage/xapi-response-interceptor.ts.html DELETED Viewed

@@ -1,169 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-    <title>Code coverage report for xapi-response-interceptor.ts</title>
-    <meta charset="utf-8" />
-    <link rel="stylesheet" href="prettify.css" />
-    <link rel="stylesheet" href="base.css" />
-    <link rel="shortcut icon" type="image/x-icon" href="favicon.png" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <style type='text/css'>
-        .coverage-summary .sorter {
-            background-image: url(sort-arrow-sprite.png);
-        }
-    </style>
-</head>
-<body>
-<div class='wrapper'>
-    <div class='pad1'>
-        <h1><a href="index.html">All files</a> xapi-response-interceptor.ts</h1>
-        <div class='clearfix'>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">100% </span>
-                <span class="quiet">Statements</span>
-                <span class='fraction'>24/24</span>
-            </div>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">100% </span>
-                <span class="quiet">Branches</span>
-                <span class='fraction'>6/6</span>
-            </div>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">100% </span>
-                <span class="quiet">Functions</span>
-                <span class='fraction'>2/2</span>
-            </div>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">100% </span>
-                <span class="quiet">Lines</span>
-                <span class='fraction'>24/24</span>
-            </div>
-        </div>
-        <p class="quiet">
-            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
-        </p>
-        <template id="filterTemplate">
-            <div class="quiet">
-                Filter:
-                <input type="search" id="fileSearch">
-            </div>
-        </template>
-    </div>
-    <div class='status-line high'></div>
-    <pre><table class="coverage">
-<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
-<a name='L2'></a><a href='#L2'>2</a>
-<a name='L3'></a><a href='#L3'>3</a>
-<a name='L4'></a><a href='#L4'>4</a>
-<a name='L5'></a><a href='#L5'>5</a>
-<a name='L6'></a><a href='#L6'>6</a>
-<a name='L7'></a><a href='#L7'>7</a>
-<a name='L8'></a><a href='#L8'>8</a>
-<a name='L9'></a><a href='#L9'>9</a>
-<a name='L10'></a><a href='#L10'>10</a>
-<a name='L11'></a><a href='#L11'>11</a>
-<a name='L12'></a><a href='#L12'>12</a>
-<a name='L13'></a><a href='#L13'>13</a>
-<a name='L14'></a><a href='#L14'>14</a>
-<a name='L15'></a><a href='#L15'>15</a>
-<a name='L16'></a><a href='#L16'>16</a>
-<a name='L17'></a><a href='#L17'>17</a>
-<a name='L18'></a><a href='#L18'>18</a>
-<a name='L19'></a><a href='#L19'>19</a>
-<a name='L20'></a><a href='#L20'>20</a>
-<a name='L21'></a><a href='#L21'>21</a>
-<a name='L22'></a><a href='#L22'>22</a>
-<a name='L23'></a><a href='#L23'>23</a>
-<a name='L24'></a><a href='#L24'>24</a>
-<a name='L25'></a><a href='#L25'>25</a>
-<a name='L26'></a><a href='#L26'>26</a>
-<a name='L27'></a><a href='#L27'>27</a>
-<a name='L28'></a><a href='#L28'>28</a>
-<a name='L29'></a><a href='#L29'>29</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">4x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">3x</span>
-<span class="cline-any cline-yes">3x</span>
-<span class="cline-any cline-yes">3x</span>
-<span class="cline-any cline-yes">3x</span>
-<span class="cline-any cline-yes">2x</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">2x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">2x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">3x</span>
-<span class="cline-any cline-yes">3x</span>
-<span class="cline-any cline-yes">3x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { CallHandler, ExecutionContext, Injectable, Logger, NestInterceptor } from '@nestjs/common';
-import { XapiRoot, writeString } from '@xapi-js/core';
-import { Observable, map } from 'rxjs';
-&nbsp;
-@Injectable()
-export class XapiResponseInterceptor implements NestInterceptor&lt;XapiRoot, Promise&lt;string&gt;&gt; {
-  private readonly logger: Logger = new Logger(XapiResponseInterceptor.name);
-  intercept(context: ExecutionContext, next: CallHandler): Observable&lt;Promise&lt;string&gt;&gt; {
-    this.logger.debug(`XapiResponseInterceptor Intercepting response`);
-    return next.handle().pipe(
-      map(async (value) =&gt; {
-        if (value instanceof XapiRoot) {
-          try {
-            // Serialize XapiRoot output to XML string
-            const xmlOutput = await writeString(value as XapiRoot);
-            return xmlOutput!!;
-          } catch (error) {
-            this.logger.error(`Failed to serialize XapiRoot to XML string: ${error.message}`);
-            throw error; // Re-throw the original error
-          }
-        }
-        else {
-          throw new Error('Handler did not return an XapiRoot instance');
-        }
-      })
-    )
-  }
-}
-&nbsp;</pre></td></tr></table></pre>
-                <div class='push'></div><!-- for sticky footer -->
-            </div><!-- /wrapper -->
-            <div class='footer quiet pad2 space-top1 center small'>
-                Code coverage generated by
-                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-07-05T15:46:50.456Z
-            </div>
-        <script src="prettify.js"></script>
-        <script>
-            window.onload = function () {
-                prettyPrint();
-            };
-        </script>
-        <script src="sorter.js"></script>
-        <script src="block-navigation.js"></script>
-    </body>
-</html>

package/src/xapi-request-interceptor.ts DELETED Viewed

@@ -1,31 +0,0 @@
-import { CallHandler, ExecutionContext, Injectable, Logger, NestInterceptor } from "@nestjs/common";
-import { parse } from "@xapi-js/core";
-import { Observable } from "rxjs";
-/**
- * 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.
- */
-@Injectable()
-export class XapiRequestInterceptor implements NestInterceptor {
-  private readonly logger: Logger = new Logger(XapiRequestInterceptor.name);
-  /**
-   * 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
-   * into an `XapiRoot` object and replaces the original request body with it.
-   * @param context - The execution context of the request.
-   * @param next - A `CallHandler` to invoke the next interceptor or the route handler.
-   * @returns An `Observable` that will eventually contain the response.
-   */
-  async intercept(context: ExecutionContext, next: CallHandler): Promise<Observable<any>> {
-    const request = context.switchToHttp().getRequest();
-    this.logger.debug(`XapiRequestInterceptor Intercepting request: ${request.method} ${request.url}`);
-    // Deserialize XML input to XapiRoot object
-    if (request.headers['content-type'] === 'application/xml' && request.body) {
-      request.body = await parse(request.body);
-    }
-    return next.handle()
-  }
-}

package/src/xapi-response-interceptor.ts DELETED Viewed

@@ -1,43 +0,0 @@
-import { CallHandler, ExecutionContext, Injectable, Logger, NestInterceptor } from '@nestjs/common';
-import { XapiRoot, writeString } from '@xapi-js/core';
-import { Observable, map } from 'rxjs';
-/**
- * Interceptor that serializes XapiRoot objects returned by NestJS route handlers into XML strings.
- * This interceptor should be applied to routes that return an `XapiRoot` instance
- * and whose response should be `application/xml`.
- */
-@Injectable()
-export class XapiResponseInterceptor implements NestInterceptor<XapiRoot, Promise<string>> {
-  private readonly logger: Logger = new Logger(XapiResponseInterceptor.name);
-  /**
-   * Intercepts the outgoing response to serialize XapiRoot to XML string.
-   * If the handler returns an `XapiRoot` instance, it attempts to serialize it
-   * into an XML string.
-   * @param context - The execution context of the request.
-   * @param next - A `CallHandler` to invoke the next interceptor or the route handler.
-   * @returns An `Observable` that will eventually contain the XML string response.
-   * @throws {Error} if the handler does not return an `XapiRoot` instance or serialization fails.
-   */
-  intercept(context: ExecutionContext, next: CallHandler): Observable<Promise<string>> {
-    this.logger.debug(`XapiResponseInterceptor Intercepting response`);
-    return next.handle().pipe(
-      map(async (value) => {
-        if (value instanceof XapiRoot) {
-          try {
-            // Serialize XapiRoot output to XML string
-            const xmlOutput = await writeString(value as XapiRoot);
-            return xmlOutput!!;
-          } catch (error) {
-            this.logger.error(`Failed to serialize XapiRoot to XML string: ${error.message}`);
-            throw error; // Re-throw the original error
-          }
-        }
-        else {
-          throw new Error('Handler did not return an XapiRoot instance');
-        }
-      })
-    )
-  }
-}

package/test/xapi-request-interceptor.test.ts DELETED Viewed

@@ -1,115 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { of, firstValueFrom } from 'rxjs';
-import { XapiRequestInterceptor } from '../src/xapi-request-interceptor';
-import { CallHandler, ExecutionContext } from '@nestjs/common';
-import { XapiRoot } from '@xapi-js/core';
-describe('XapiRequestInterceptor', () => {
-  let interceptor: XapiRequestInterceptor;
-  beforeEach(() => {
-    interceptor = new XapiRequestInterceptor();
-  });
-  it('should be defined', () => {
-    expect(interceptor).toBeDefined();
-  });
-  it('should deserialize Nexacro XAPI XML input to XapiRoot object', async () => {
-    const nexacroXmlInput = `<?xml version="1.0" encoding="UTF-8"?>
-<Root xmlns="http://www.tobesoft.com/platform/Dataset" ver="4000">
-  <Dataset id="test">
-    <ColumnInfo>
-      <Column id="intCol" size="10" type="INT" />
-      <Column id="stringCol" size="50" type="STRING" />
-    </ColumnInfo>
-    <Rows>
-      <Row>
-        <Col id="intCol">123</Col>
-        <Col id="stringCol">hello</Col>
-      </Row>
-      <Row>
-        <Col id="intCol">456</Col>
-        <Col id="stringCol">world</Col>
-      </Row>
-    </Rows>
-  </Dataset>
-</Root>`;
-    const mockRequest = {
-      body: nexacroXmlInput,
-      headers: { 'content-type': 'application/xml' },
-    };
-    const mockContext = {
-      switchToHttp: () => ({
-        getRequest: () => mockRequest,
-        getResponse: () => ({}),
-      }),
-    } as ExecutionContext;
-    const mockCallHandler = {
-      handle: () => of({}), // Mock a successful handler call
-    } as CallHandler;
-    const observableResult = await interceptor.intercept(mockContext, mockCallHandler);
-    await firstValueFrom(observableResult);
-    const request = mockContext.switchToHttp().getRequest();
-    expect(request.body).toBeInstanceOf(XapiRoot);
-    expect(request.body.datasets).toBeDefined();
-    expect(request.body.getDataset('test')).toBeDefined();
-    const dataset = request.body.getDataset('test');
-    expect(dataset.rows).toBeDefined();
-    expect(dataset.rows.length).toBe(2);
-    expect(dataset.getColumn(0, 'intCol')).toBe(123);
-    expect(dataset.getColumn(0, 'stringCol')).toBe('hello');
-    expect(dataset.getColumn(1, 'intCol')).toBe(456);
-    expect(dataset.getColumn(1, 'stringCol')).toBe('world');
-  });
-  it('should not deserialize non-XML input', async () => {
-    const jsonInput = `{ "data": "test" }`;
-    const mockRequest = {
-      body: jsonInput,
-      headers: { 'content-type': 'application/json' },
-    };
-    const mockContext = {
-      switchToHttp: () => ({
-        getRequest: () => mockRequest,
-        getResponse: () => ({}),
-      }),
-    } as ExecutionContext;
-    const mockCallHandler = {
-      handle: () => of({}),
-    } as CallHandler;
-    const observableResult = await interceptor.intercept(mockContext, mockCallHandler);
-    await firstValueFrom(observableResult);
-    const request = mockContext.switchToHttp().getRequest();
-    expect(request.body).toBe(jsonInput);
-    expect(request.body).not.toBeInstanceOf(XapiRoot);
-  });
-  it('should pass through if no body is present', async () => {
-    const mockRequest = {
-      headers: { 'content-type': 'application/xml' },
-    };
-    const mockContext = {
-      switchToHttp: () => ({
-        getRequest: () => mockRequest,
-        getResponse: () => ({}),
-      }),
-    } as ExecutionContext;
-    const mockCallHandler = {
-      handle: () => of({}),
-    } as CallHandler;
-    const observableResult = await interceptor.intercept(mockContext, mockCallHandler);
-    await firstValueFrom(observableResult);
-    const request = mockContext.switchToHttp().getRequest();
-    expect(request.body).toBeUndefined();
-  });
-});

package/test/xapi-response-interceptor.test.ts DELETED Viewed

@@ -1,113 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { of, firstValueFrom } from 'rxjs';
-import { XapiResponseInterceptor } from '../src/xapi-response-interceptor';
-import { CallHandler, ExecutionContext } from '@nestjs/common';
-import { XapiRoot, Dataset, Column, writeString } from '@xapi-js/core';
-// Mock the writeString function from @xapi-js/core
-vi.mock('@xapi-js/core', async (importOriginal) => {
-  const actual = await importOriginal();
-  return {
-    ...actual,
-    writeString: vi.fn(actual.writeString), // Use the actual implementation for mocking
-  };
-});
-describe('XapiResponseInterceptor', () => {
-  let interceptor: XapiResponseInterceptor;
-  beforeEach(() => {
-    interceptor = new XapiResponseInterceptor();
-    // Reset the mock before each test
-    vi.mocked(writeString).mockClear(); // Use writeString directly
-  });
-  it('should be defined', () => {
-    expect(interceptor).toBeDefined();
-  });
-  it('should serialize XapiRoot output to Nexacro XAPI XML string', async () => {
-    const xapiRootOutput = new XapiRoot();
-    const dataset = new Dataset('test');
-    dataset.addColumn({ id: 'intCol', size: 10, type: 'INT' });
-    dataset.addColumn({ id: 'stringCol', size: 50, type: 'STRING' });
-    dataset.newRow();
-    dataset.setColumn(0, 'intCol', 123);
-    dataset.setColumn(0, 'stringCol', 'hello');
-    dataset.newRow();
-    dataset.setColumn(1, 'intCol', 456);
-    dataset.setColumn(1, 'stringCol', 'world');
-    xapiRootOutput.addDataset(dataset);
-    const mockContext = {
-      switchToHttp: () => ({
-        getRequest: () => ({}),
-        getResponse: () => ({}),
-      }),
-    } as ExecutionContext;
-    const mockCallHandler = {
-      handle: () => of(xapiRootOutput),
-    } as CallHandler;
-    const observableResult = interceptor.intercept(mockContext, mockCallHandler);
-    const result = await firstValueFrom(observableResult);
-    expect(typeof result).toBe('string');
-    expect(result).toContain('<Root xmlns="http://www.nexacroplatform.com/platform/dataset" version="4000">');
-    expect(result).toContain('<Dataset id="test">');
-    expect(result).toMatch(/<Column id="intCol" size="10" type="INT"\s*\/>/);
-    expect(result).toMatch(/<Column id="stringCol" size="50" type="STRING"\s*\/>/);
-    expect(result).toContain('<Rows>');
-    expect(result).toContain('<Row>');
-    expect(result).toContain('<Col id="intCol">123</Col>');
-    expect(result).toContain('<Col id="stringCol">hello</Col>');
-    expect(result).toContain('<Col id="intCol">456</Col>');
-    expect(result).toContain('<Col id="stringCol">world</Col>');
-    expect(result).toContain('</Row>');
-    expect(result).toContain('</Rows>');
-    expect(result).toContain('</Dataset>');
-    expect(result).toContain('</Root>');
-  });
-  it('should throw an error if handler does not return XapiRoot', async () => {
-    const nonXapiRootOutput = { message: 'hello' };
-    const mockContext = {
-      switchToHttp: () => ({
-        getRequest: () => ({}),
-        getResponse: () => ({}),
-      }),
-    } as ExecutionContext;
-    const mockCallHandler = {
-      handle: () => of(nonXapiRootOutput),
-    } as CallHandler;
-    const observableResult = interceptor.intercept(mockContext, mockCallHandler);
-    await expect(firstValueFrom(observableResult)).rejects.toThrow('Handler did not return an XapiRoot instance');
-  });
-  it('should re-throw error from writeString', async () => {
-    const xapiRootOutput = new XapiRoot();
-    const mockContext = {
-      switchToHttp: () => ({
-        getRequest: () => ({}),
-        getResponse: () => ({}),
-      }),
-    } as ExecutionContext;
-    const mockCallHandler = {
-      handle: () => of(xapiRootOutput),
-    } as CallHandler;
-    const testError = new Error('Test writeString error');
-    vi.mocked(writeString).mockRejectedValue(testError);
-    const observableResult = interceptor.intercept(mockContext, mockCallHandler);
-    await expect(firstValueFrom(observableResult)).rejects.toThrow(testError);
-  });
-});

package/vitest.config.ts DELETED Viewed

@@ -1,16 +0,0 @@
-import { defineConfig } from 'vitest/config'
-export default defineConfig({
-  test: {
-    globals: true,
-    pool: "threads",
-    exclude: [
-      "**/node_modules/**",
-      "**/coverage/**",
-      "**/dist/**",
-      '**/.{idea,git,cache,output,temp}/**',
-      '**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build}.config.*',
-    ],
-  include: ['test/**/*.test.ts'],
-  },
-})