@xapi-js/core 1.0.0 → 1.1.1

package/README.md

@@ -5,12 +5,107 @@ This package provides core utilities and types for working with X-API data.
 ## Installation
 
 ```bash
+# npm
+npm install @xapi-ts/core
+
+# yarn
+yarn add @xapi-ts/core
+
+# pnpm
 pnpm add @xapi-ts/core
+
+# bun
+bun add @xapi-ts/core
+
+# deno
+deno add @xapi-ts/core
 ```
 
 ## Usage
 
-(Add usage examples here)
+`@xapi-ts/core` provides the fundamental classes and functions for working with X-API data.
+
+### Parsing X-API XML
+
+You can parse an X-API XML string into an `XapiRoot` object:
+
+```typescript
+import { parse, XapiRoot } from '@xapi-ts/core';
+
+const xmlString = `<?xml version="1.0" encoding="UTF-8"?>
+<Root xmlns="http://www.tobesoft.com/platform/Dataset" ver="4000">
+  <Parameters>
+    <Parameter id="service">stock</Parameter>
+    <Parameter id="method">search</Parameter>
+  </Parameters>
+</Root>`;
+
+async function parseXapi() {
+  const xapi = await parse(xmlString);
+  console.log('Service:', xapi.getParameter('service')?.value);
+  console.log('Method:', xapi.getParameter('method')?.value);
+}
+
+parseXapi();
+```
+
+### Creating and Manipulating XapiRoot
+
+You can create an `XapiRoot` object and add parameters and datasets programmatically:
+
+```typescript
+import { XapiRoot, Dataset } from '@xapi-ts/core';
+
+const xapi = new XapiRoot();
+
+// Add parameters
+xapi.addParameter({ id: 'resultCode', value: '0' });
+xapi.addParameter({ id: 'resultMsg', value: 'SUCCESS' });
+
+// Create and add a dataset
+const usersDataset = new Dataset('users');
+usersDataset.addColumn({ id: 'id', type: 'INT' });
+usersDataset.addColumn({ id: 'name', type: 'STRING' });
+
+usersDataset.newRow();
+usersDataset.setColumn(0, 'id', 1);
+usersDataset.setColumn(0, 'name', 'Alice');
+
+usersDataset.newRow();
+usersDataset.setColumn(1, 'id', 2);
+usersDataset.setColumn(1, 'name', 'Bob');
+
+xapi.addDataset(usersDataset);
+
+console.log('XapiRoot created:', xapi);
+```
+
+### Serializing XapiRoot to XML
+
+You can serialize an `XapiRoot` object back into an X-API XML string:
+
+```typescript
+import { writeString, XapiRoot, Dataset } from '@xapi-ts/core';
+
+const xapi = new XapiRoot();
+xapi.addParameter({ id: 'status', value: 'OK' });
+
+const productsDataset = new Dataset('products');
+productsDataset.addColumn({ id: 'productId', type: 'STRING' });
+productsDataset.addColumn({ id: 'price', type: 'INT' });
+productsDataset.newRow();
+productsDataset.setColumn(0, 'productId', 'P001');
+productsDataset.setColumn(0, 'price', 1000);
+xapi.addDataset(productsDataset);
+
+async function writeXapi() {
+  const xmlOutput = await writeString(xapi);
+  console.log('생성된 XML:
+', xmlOutput);
+}
+
+writeXapi();
+```
 
 ---
 
@@ -21,9 +116,103 @@ pnpm add @xapi-ts/core
 ## 설치
 
 ```bash
+# npm
+npm install @xapi-ts/core
+
+# yarn
+yarn add @xapi-ts/core
+
+# pnpm
 pnpm add @xapi-ts/core
+
+# bun
+bun add @xapi-ts/core
+
+# deno
+deno add @xapi-ts/core
 ```
 
 ## 사용법
 
-(여기에 사용 예시를 추가하세요)
+`@xapi-ts/core`는 X-API 데이터를 다루기 위한 기본적인 클래스와 함수를 제공합니다.
+
+### X-API XML 파싱
+
+X-API XML 문자열을 `XapiRoot` 객체로 파싱할 수 있습니다:
+
+```typescript
+import { parse, XapiRoot } from '@xapi-ts/core';
+
+const xmlString = `<?xml version="1.0" encoding="UTF-8"?>
+<Root xmlns="http://www.tobesoft.com/platform/Dataset" ver="4000">
+  <Parameters>
+    <Parameter id="service">stock</Parameter>
+    <Parameter id="method">search</Parameter>
+  </Parameters>
+</Root>`;
+
+async function parseXapi() {
+  const xapi = await parse(xmlString);
+  console.log('서비스:', xapi.getParameter('service')?.value);
+  console.log('메서드:', xapi.getParameter('method')?.value);
+}
+
+parseXapi();
+```
+
+### XapiRoot 생성 및 조작
+
+`XapiRoot` 객체를 생성하고 매개변수 및 데이터셋을 프로그래밍 방식으로 추가할 수 있습니다:
+
+```typescript
+import { XapiRoot, Dataset } from '@xapi-ts/core';
+
+const xapi = new XapiRoot();
+
+// 매개변수 추가
+xapi.addParameter({ id: 'resultCode', value: '0' });
+xapi.addParameter({ id: 'resultMsg', value: 'SUCCESS' });
+
+// 데이터셋 생성 및 추가
+const usersDataset = new Dataset('users');
+usersDataset.addColumn({ id: 'id', type: 'INT' });
+usersDataset.addColumn({ id: 'name', type: 'STRING' });
+let rowIdx: number;
+rowIdx = usersDataset.newRow();
+usersDataset.setColumn(rowIdx, 'id', 1);
+usersDataset.setColumn(rowIdx, 'name', 'Alice');
+
+rowIdx = usersDataset.newRow();
+usersDataset.setColumn(rowIdx, 'id', 2);
+usersDataset.setColumn(rowIdx, 'name', 'Bob');
+
+xapi.addDataset(usersDataset);
+
+console.log('XapiRoot 생성됨:', xapi);
+```
+
+### XapiRoot를 XML로 직렬화
+
+`XapiRoot` 객체를 X-API XML 문자열로 다시 직렬화할 수 있습니다:
+
+```typescript
+import { write, XapiRoot, Dataset } from '@xapi-ts/core';
+
+const xapi = new XapiRoot();
+xapi.addParameter({ id: 'status', value: 'OK' });
+
+const productsDataset = new Dataset('products');
+productsDataset.addColumn({ id: 'productId', type: 'STRING' });
+productsDataset.addColumn({ id: 'price', type: 'INT' });
+productsDataset.newRow();
+productsDataset.setColumn(0, 'productId', 'P001');
+productsDataset.setColumn(0, 'price', 1000);
+xapi.addDataset(productsDataset);
+
+async function writeXapi() {
+  const xmlOutput = await write(xapi);
+  console.log('생성된 XML:\n', xmlOutput);
+}
+
+writeXapi();
+```

package/dist/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
+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 __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -22,10 +32,13 @@ var index_exports = {};
 __export(index_exports, {
   ColumnTypeError: () => ColumnTypeError,
   Dataset: () => Dataset,
+  InvalidXmlError: () => InvalidXmlError,
   NexaVersion: () => NexaVersion,
   StringWritableStream: () => StringWritableStream,
   XapiRoot: () => XapiRoot,
   XplatformVersion: () => XplatformVersion,
+  _unescapeXml: () => _unescapeXml,
+  arrayBufferToString: () => arrayBufferToString,
   base64ToUint8Array: () => base64ToUint8Array,
   columnType: () => columnType,
   convertToColumnType: () => convertToColumnType,
@@ -34,7 +47,7 @@ __export(index_exports, {
   initXapi: () => initXapi,
   makeParseEntities: () => makeParseEntities,
   makeWriterEntities: () => makeWriterEntities,
-  parse: () => parse,
+  parse: () => parse2,
   rowType: () => rowType,
   stringToDate: () => stringToDate,
   stringToReadableStream: () => stringToReadableStream,
@@ -46,6 +59,7 @@ module.exports = __toCommonJS(index_exports);
 
 // src/handler.ts
 var import_stax_xml = require("stax-xml");
+var txml = __toESM(require("txml"), 1);
 
 // src/types.ts
 var rowType = ["insert", "update", "delete"];
@@ -64,21 +78,31 @@ var ColumnTypeError = class extends Error {
     this.name = "ColumnTypeError";
   }
 };
+var InvalidXmlError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "InvalidXmlError";
+  }
+};
 
 // src/utils.ts
+function arrayBufferToString(buffer) {
+  const decoder = new TextDecoder();
+  return decoder.decode(buffer);
+}
 function makeParseEntities() {
-  const entities = [];
+  const entities2 = [];
   for (let i = 1; i <= 32; i++) {
-    entities.push({ entity: `&#${i};`, value: String.fromCharCode(i) });
+    entities2.push({ entity: `&#${i};`, value: String.fromCharCode(i) });
   }
-  return entities;
+  return entities2;
 }
 function makeWriterEntities() {
-  const entities = [];
+  const entities2 = [];
   for (let i = 1; i <= 32; i++) {
-    entities.push({ entity: `&#${i};`, value: String.fromCharCode(i) });
+    entities2.push({ entity: `&#${i};`, value: String.fromCharCode(i) });
   }
-  return entities;
+  return entities2;
 }
 function base64ToUint8Array(base64String) {
   const binaryString = atob(base64String);
@@ -156,6 +180,7 @@ function dateToString(date, type) {
   }
 }
 var StringWritableStream = class extends WritableStream {
+  result = "";
   constructor() {
     const decoder = new TextDecoder();
     super({
@@ -166,7 +191,6 @@ var StringWritableStream = class extends WritableStream {
         this.result += decoder.decode();
       }
     });
-    this.result = "";
   }
   /**
    * Returns the collected string result.
@@ -227,23 +251,34 @@ function convertToString(value, type) {
       return dateToString(value, type);
     case "BLOB":
       return uint8ArrayToBase64(value);
+    case "STRING":
+      return String(value);
     default:
       return String(value);
   }
 }
+var entities = makeParseEntities();
+function _unescapeXml(str) {
+  if (!str) return str;
+  const regex = new RegExp(entities.map((e) => e.entity).join("|"), "g");
+  return str.replace(regex, (match) => {
+    const entity = entities.find((e) => e.entity === match);
+    return entity ? entity.value : match;
+  });
+}
 
 // src/xapi-data.ts
 var XapiRoot = class {
+  /** An array of datasets within the X-API root. */
+  datasets = [];
+  /** Parameters associated with the X-API root. */
+  parameters = { params: [] };
   /**
    * Creates an instance of XapiRoot.
    * @param datasets - Initial array of datasets.
    * @param parameters - Initial parameters.
    */
   constructor(datasets = [], parameters = { params: [] }) {
-    /** An array of datasets within the X-API root. */
-    this.datasets = [];
-    /** Parameters associated with the X-API root. */
-    this.parameters = { params: [] };
     this.datasets = datasets;
     this.parameters = parameters;
   }
@@ -331,6 +366,13 @@ var XapiRoot = class {
   }
 };
 var Dataset = class {
+  /** The ID of the dataset. */
+  id;
+  constColumns = [];
+  columns = [];
+  /** An array of rows in the dataset. */
+  rows = [];
+  _columnIndexMap = /* @__PURE__ */ new Map();
   /**
    * Creates an instance of Dataset.
    * @param id - The ID of the dataset.
@@ -339,11 +381,6 @@ var Dataset = class {
    * @param rows - Initial array of rows.
    */
   constructor(id, constColumns = [], columns = [], rows = []) {
-    this.constColumns = [];
-    this.columns = [];
-    /** An array of rows in the dataset. */
-    this.rows = [];
-    this._columnIndexMap = /* @__PURE__ */ new Map();
     this.id = id;
     this.constColumns = constColumns;
     this.columns = columns;
@@ -524,127 +561,105 @@ function initXapi(options) {
     ...options
   };
 }
-async function parse(reader) {
-  let _stream;
-  if (typeof reader === "string") {
-    _stream = new ReadableStream({
-      start(controller) {
-        controller.enqueue(new TextEncoder().encode(reader));
-        controller.close();
-      }
-    });
-  } else {
-    _stream = reader;
-  }
-  const xmlParser = new import_stax_xml.StaxXmlParser(_stream, {
-    addEntities: makeParseEntities(),
-    encoding: "UTF-8"
-  });
+function parse2(xml) {
+  const parsedXml = txml.parse(xml);
   const xapiRoot = new XapiRoot();
-  for await (const event of xmlParser) {
-    if (event.type === import_stax_xml.XmlEventType.START_ELEMENT) {
-      const startEvent = event;
-      switch (startEvent.localName) {
-        case "Parameter":
-          let paramValue = void 0;
-          const charEvent = (await xmlParser.next()).value;
-          if (charEvent.type === import_stax_xml.XmlEventType.CHARACTERS) {
-            paramValue = charEvent.value;
-          }
-          xapiRoot.addParameter({
-            id: startEvent.attributes["id"],
-            type: startEvent.attributes["type"] || "STRING",
-            value: _options.parseToTypes ? convertToColumnType(paramValue, startEvent.attributes["type"] || "STRING") : paramValue
-          });
-          break;
-        case "Dataset":
-          xapiRoot.addDataset(await parseDataset(startEvent, xmlParser));
-          break;
+  const rootElement = parsedXml.find((node) => {
+    const rootNode = node;
+    return rootNode.tagName === "Root";
+  });
+  if (rootElement === void 0) return xapiRoot;
+  const parametersElement = rootElement.children?.find((node) => node.tagName === "Parameters");
+  parseParameters(parametersElement, xapiRoot);
+  const datasetsElements = rootElement.children?.filter((node) => node.tagName === "Dataset");
+  if (datasetsElements && datasetsElements?.length && datasetsElements.length > 0) {
+    for (const datasetsElement of datasetsElements) {
+      if (!datasetsElement.attributes || !datasetsElement.attributes.id) {
+        throw new InvalidXmlError("Dataset element must have an 'id' attribute");
       }
+      const datasetId = datasetsElement.attributes?.id;
+      const dataset = new Dataset(datasetId);
+      xapiRoot.addDataset(dataset);
+      const columnInfoElement = datasetsElement.children?.find((node) => node.tagName === "ColumnInfo");
+      parseColumnInfo(columnInfoElement, dataset);
+      const rowsElement = datasetsElement.children?.find((node) => node.tagName === "Rows");
+      parseRows(rowsElement, dataset);
     }
   }
   return xapiRoot;
 }
-async function parseDataset(initEvent, xmlParser) {
-  const dataset = new Dataset(initEvent.attributes["id"]);
-  let currentRowIndex = -1;
-  for await (const event of xmlParser) {
-    if (event.type === import_stax_xml.XmlEventType.END_ELEMENT && event.localName === "Dataset") {
-      break;
-    } else if (event.type === import_stax_xml.XmlEventType.START_ELEMENT) {
-      const startEvent = event;
-      switch (startEvent.localName) {
-        case "ConstColumn":
-          dataset.addConstColumn({
-            id: startEvent.attributes["id"],
-            size: parseInt(startEvent.attributes["size"] || "0", 10),
-            type: startEvent.attributes["type"] || "STRING",
-            value: startEvent.attributes["value"] || void 0
-          });
-          break;
-        case "Column":
-          dataset.addColumn({
-            id: startEvent.attributes["id"],
-            size: parseInt(startEvent.attributes["size"] || "0", 10),
-            type: startEvent.attributes["type"] || "STRING"
+function parseValue(value, type = "STRING") {
+  value = _unescapeXml(value);
+  return _options.parseToTypes ? convertToColumnType(value, type) : value;
+}
+function parseColumnInfo(columnInfoElement, dataset) {
+  if (!columnInfoElement) throw new InvalidXmlError("ColumnInfo element is missing in the dataset");
+  columnInfoElement.children?.forEach((colInfo) => {
+    if (colInfo.tagName === "ConstColumn") {
+      dataset.addConstColumn({
+        id: colInfo.attributes?.id,
+        size: parseInt(colInfo.attributes?.size || "0", 10),
+        type: colInfo.attributes?.type || "STRING",
+        value: parseValue(colInfo.attributes?.value, colInfo.attributes?.type)
+      });
+    } else if (colInfo.tagName === "Column") {
+      dataset.addColumn({
+        id: colInfo.attributes?.id,
+        size: parseInt(colInfo.attributes?.size || "0", 10),
+        type: colInfo.attributes?.type || "STRING"
+      });
+    }
+  });
+}
+function parseRows(rowsElement, dataset) {
+  rowsElement?.children?.forEach((r) => {
+    if (r.tagName === "Row") {
+      const rowIndex = dataset.newRow();
+      dataset.rows[rowIndex].type = r.attributes?.type || void 0;
+      r.children?.forEach((col) => {
+        if (col.tagName === "Col") {
+          const colId = col.attributes?.id;
+          const value = col.children?.[0];
+          const columnInfo = dataset.getColumnInfo(colId);
+          if (!columnInfo) throw new InvalidXmlError(`Column with id ${colId} not found in dataset ${dataset.id}`);
+          const castedValue = parseValue(value, columnInfo.type);
+          dataset.rows[rowIndex].cols.push({ id: colId, value: castedValue });
+        } else if (col.tagName === "OrgRow") {
+          dataset.rows[rowIndex].orgRow = [];
+          col.children?.forEach((orgCol) => {
+            if (orgCol.tagName === "Col") {
+              const colId = orgCol.attributes?.id;
+              const value = orgCol.children?.[0];
+              const columnInfo = dataset.getColumnInfo(colId);
+              const castedValue = parseValue(value, columnInfo.type);
+              if (dataset && dataset.rows && dataset.rows[rowIndex] && dataset.rows[rowIndex].orgRow) {
+                dataset.rows[rowIndex].orgRow.push({ id: colId, value: castedValue });
+              }
+            }
           });
-          break;
-        case "Row":
-          currentRowIndex = dataset.newRow();
-          dataset.rows[currentRowIndex].type = startEvent.attributes["type"] || void 0;
-          break;
-        case "Col": {
-          await parseCol(xmlParser, startEvent, dataset, currentRowIndex, false);
-          break;
         }
-        case "OrgRow":
-          if (currentRowIndex < 0) {
-            throw new Error("Row must be defined before OrgRow");
-          }
-          dataset.rows[currentRowIndex].orgRow = [];
-          for await (const orgRowEvent of xmlParser) {
-            if (orgRowEvent.type === import_stax_xml.XmlEventType.END_ELEMENT && orgRowEvent.localName === "OrgRow") {
-              break;
-            }
-            if (orgRowEvent.type === import_stax_xml.XmlEventType.START_ELEMENT && orgRowEvent.localName === "Col") {
-              const orgColEvent = orgRowEvent;
-              await parseCol(xmlParser, orgColEvent, dataset, currentRowIndex, true);
-            }
-          }
-      }
+      });
+    } else if (r.tagName === "Col") {
+      throw new InvalidXmlError("Row must be defined before Col");
+    } else if (r.tagName === "OrgRow") {
+      throw new InvalidXmlError("Row must be defined before OrgRow");
     }
-  }
-  return dataset;
+  });
 }
-async function parseCol(xmlParser, startEvent, dataset, currentRowIndex, isOrgRow) {
-  if (currentRowIndex < 0) {
-    throw new Error("Row must be defined before Col");
-  }
-  const colId = startEvent.attributes["id"];
-  const colIndex = dataset.getColumnIndex(colId);
-  if (colIndex === void 0 || colIndex < 0) {
-    throw new Error(`Column with id ${colId} not found in dataset ${dataset.id}`);
-  }
-  const colCharEvent = (await xmlParser.next()).value;
-  let value;
-  if (colCharEvent.type === import_stax_xml.XmlEventType.CDATA) {
-    value = colCharEvent.value;
-  } else if (colCharEvent.type === import_stax_xml.XmlEventType.CHARACTERS) {
-    value = colCharEvent.value;
-  }
-  let castedValue = value;
-  if (_options.parseToTypes) {
-    const columnInfo = dataset.getColumnInfo(colId);
-    if (!columnInfo || columnType.includes(columnInfo.type) === false) {
-      throw new Error(`Column type for ${colId} not found in dataset ${dataset.id}`);
+function parseParameters(parametersElement, xapiRoot) {
+  if (!parametersElement) return;
+  parametersElement.children?.forEach((p) => {
+    if (p.tagName === "Parameter") {
+      const id = p.attributes?.id;
+      const type = p.attributes?.type || "STRING";
+      const value = p.children?.[0];
+      xapiRoot.addParameter({
+        id,
+        type,
+        value: parseValue(value, type)
+      });
     }
-    castedValue = convertToColumnType(value, columnInfo.type);
-  }
-  if (!isOrgRow) {
-    dataset.rows[currentRowIndex].cols.push({ id: colId, value: castedValue });
-  } else {
-    dataset.rows[currentRowIndex].orgRow.push({ id: colId, value: castedValue });
-  }
+  });
 }
 async function writeString(root) {
   const stringStream = new StringWritableStream();
@@ -765,10 +780,13 @@ async function writeColumn(writer, dataset, col) {
 0 && (module.exports = {
   ColumnTypeError,
   Dataset,
+  InvalidXmlError,
   NexaVersion,
   StringWritableStream,
   XapiRoot,
   XplatformVersion,
+  _unescapeXml,
+  arrayBufferToString,
   base64ToUint8Array,
   columnType,
   convertToColumnType,

package/dist/index.d.cts

@@ -127,6 +127,9 @@ interface XapiOptions {
 declare class ColumnTypeError extends Error {
     constructor(message: string);
 }
+declare class InvalidXmlError extends Error {
+    constructor(message: string);
+}
 
 /**
  * Represents the root of an X-API XML structure, containing datasets and parameters.
@@ -312,17 +315,19 @@ declare class Dataset {
 /**
  * Initializes the X-API handler with the provided options.
  * @param options - The options to initialize the X-API handler.
+ * @returns void
  */
 declare function initXapi(options: XapiOptions): void;
 /**
- * Parses an XML stream or string into an XapiRoot object.
- * @param reader - The ReadableStream or string containing the XML data.
+ * Parses an XML string into an XapiRoot object using txml.
+ * @param xml - The string containing the XML data.
  * @returns A Promise that resolves to an XapiRoot object.
  */
-declare function parse(reader: ReadableStream | string): Promise<XapiRoot>;
+declare function parse(xml: string): XapiRoot;
 declare function writeString(root: XapiRoot): Promise<string>;
 declare function write(stream: WritableStream<Uint8Array>, root: XapiRoot): Promise<void>;
 
+declare function arrayBufferToString(buffer: ArrayBuffer): string;
 /**
  * Creates an array of entities for parsing XML, including control characters.
  * @returns An array of objects, each with an `entity` (e.g., "&#1;") and its `value` (e.g., "\x01").
@@ -398,5 +403,6 @@ declare function convertToColumnType(value: XapiValueType, type: ColumnType): Xa
  * @returns The string representation of the value.
  */
 declare function convertToString(value: XapiValueType, type: ColumnType): string;
+declare function _unescapeXml(str?: string): string | undefined;
 
-export { type Col, type Column, type ColumnInfo, type ColumnType, ColumnTypeError, type ConstColumn, Dataset, NexaVersion, type Parameter, type Row, type RowType, type Rows, StringWritableStream, type XapiOptions, type XapiParameters, XapiRoot, type XapiValueType, type XapiVersion, XplatformVersion, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, initXapi, makeParseEntities, makeWriterEntities, parse, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, writeString };
+export { type Col, type Column, type ColumnInfo, type ColumnType, ColumnTypeError, type ConstColumn, Dataset, InvalidXmlError, NexaVersion, type Parameter, type Row, type RowType, type Rows, StringWritableStream, type XapiOptions, type XapiParameters, XapiRoot, type XapiValueType, type XapiVersion, XplatformVersion, _unescapeXml, arrayBufferToString, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, initXapi, makeParseEntities, makeWriterEntities, parse, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, writeString };

package/dist/index.d.ts

@@ -127,6 +127,9 @@ interface XapiOptions {
 declare class ColumnTypeError extends Error {
     constructor(message: string);
 }
+declare class InvalidXmlError extends Error {
+    constructor(message: string);
+}
 
 /**
  * Represents the root of an X-API XML structure, containing datasets and parameters.
@@ -312,17 +315,19 @@ declare class Dataset {
 /**
  * Initializes the X-API handler with the provided options.
  * @param options - The options to initialize the X-API handler.
+ * @returns void
  */
 declare function initXapi(options: XapiOptions): void;
 /**
- * Parses an XML stream or string into an XapiRoot object.
- * @param reader - The ReadableStream or string containing the XML data.
+ * Parses an XML string into an XapiRoot object using txml.
+ * @param xml - The string containing the XML data.
  * @returns A Promise that resolves to an XapiRoot object.
  */
-declare function parse(reader: ReadableStream | string): Promise<XapiRoot>;
+declare function parse(xml: string): XapiRoot;
 declare function writeString(root: XapiRoot): Promise<string>;
 declare function write(stream: WritableStream<Uint8Array>, root: XapiRoot): Promise<void>;
 
+declare function arrayBufferToString(buffer: ArrayBuffer): string;
 /**
  * Creates an array of entities for parsing XML, including control characters.
  * @returns An array of objects, each with an `entity` (e.g., "&#1;") and its `value` (e.g., "\x01").
@@ -398,5 +403,6 @@ declare function convertToColumnType(value: XapiValueType, type: ColumnType): Xa
  * @returns The string representation of the value.
  */
 declare function convertToString(value: XapiValueType, type: ColumnType): string;
+declare function _unescapeXml(str?: string): string | undefined;
 
-export { type Col, type Column, type ColumnInfo, type ColumnType, ColumnTypeError, type ConstColumn, Dataset, NexaVersion, type Parameter, type Row, type RowType, type Rows, StringWritableStream, type XapiOptions, type XapiParameters, XapiRoot, type XapiValueType, type XapiVersion, XplatformVersion, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, initXapi, makeParseEntities, makeWriterEntities, parse, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, writeString };
+export { type Col, type Column, type ColumnInfo, type ColumnType, ColumnTypeError, type ConstColumn, Dataset, InvalidXmlError, NexaVersion, type Parameter, type Row, type RowType, type Rows, StringWritableStream, type XapiOptions, type XapiParameters, XapiRoot, type XapiValueType, type XapiVersion, XplatformVersion, _unescapeXml, arrayBufferToString, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, initXapi, makeParseEntities, makeWriterEntities, parse, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, writeString };

package/dist/index.js

@@ -1,5 +1,6 @@
 // src/handler.ts
-import { StaxXmlParser, StaxXmlWriter, XmlEventType } from "stax-xml";
+import { StaxXmlWriter } from "stax-xml";
+import * as txml from "txml";
 
 // src/types.ts
 var rowType = ["insert", "update", "delete"];
@@ -18,21 +19,31 @@ var ColumnTypeError = class extends Error {
     this.name = "ColumnTypeError";
   }
 };
+var InvalidXmlError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "InvalidXmlError";
+  }
+};
 
 // src/utils.ts
+function arrayBufferToString(buffer) {
+  const decoder = new TextDecoder();
+  return decoder.decode(buffer);
+}
 function makeParseEntities() {
-  const entities = [];
+  const entities2 = [];
   for (let i = 1; i <= 32; i++) {
-    entities.push({ entity: `&#${i};`, value: String.fromCharCode(i) });
+    entities2.push({ entity: `&#${i};`, value: String.fromCharCode(i) });
   }
-  return entities;
+  return entities2;
 }
 function makeWriterEntities() {
-  const entities = [];
+  const entities2 = [];
   for (let i = 1; i <= 32; i++) {
-    entities.push({ entity: `&#${i};`, value: String.fromCharCode(i) });
+    entities2.push({ entity: `&#${i};`, value: String.fromCharCode(i) });
   }
-  return entities;
+  return entities2;
 }
 function base64ToUint8Array(base64String) {
   const binaryString = atob(base64String);
@@ -110,6 +121,7 @@ function dateToString(date, type) {
   }
 }
 var StringWritableStream = class extends WritableStream {
+  result = "";
   constructor() {
     const decoder = new TextDecoder();
     super({
@@ -120,7 +132,6 @@ var StringWritableStream = class extends WritableStream {
         this.result += decoder.decode();
       }
     });
-    this.result = "";
   }
   /**
    * Returns the collected string result.
@@ -181,23 +192,34 @@ function convertToString(value, type) {
       return dateToString(value, type);
     case "BLOB":
       return uint8ArrayToBase64(value);
+    case "STRING":
+      return String(value);
     default:
       return String(value);
   }
 }
+var entities = makeParseEntities();
+function _unescapeXml(str) {
+  if (!str) return str;
+  const regex = new RegExp(entities.map((e) => e.entity).join("|"), "g");
+  return str.replace(regex, (match) => {
+    const entity = entities.find((e) => e.entity === match);
+    return entity ? entity.value : match;
+  });
+}
 
 // src/xapi-data.ts
 var XapiRoot = class {
+  /** An array of datasets within the X-API root. */
+  datasets = [];
+  /** Parameters associated with the X-API root. */
+  parameters = { params: [] };
   /**
    * Creates an instance of XapiRoot.
    * @param datasets - Initial array of datasets.
    * @param parameters - Initial parameters.
    */
   constructor(datasets = [], parameters = { params: [] }) {
-    /** An array of datasets within the X-API root. */
-    this.datasets = [];
-    /** Parameters associated with the X-API root. */
-    this.parameters = { params: [] };
     this.datasets = datasets;
     this.parameters = parameters;
   }
@@ -285,6 +307,13 @@ var XapiRoot = class {
   }
 };
 var Dataset = class {
+  /** The ID of the dataset. */
+  id;
+  constColumns = [];
+  columns = [];
+  /** An array of rows in the dataset. */
+  rows = [];
+  _columnIndexMap = /* @__PURE__ */ new Map();
   /**
    * Creates an instance of Dataset.
    * @param id - The ID of the dataset.
@@ -293,11 +322,6 @@ var Dataset = class {
    * @param rows - Initial array of rows.
    */
   constructor(id, constColumns = [], columns = [], rows = []) {
-    this.constColumns = [];
-    this.columns = [];
-    /** An array of rows in the dataset. */
-    this.rows = [];
-    this._columnIndexMap = /* @__PURE__ */ new Map();
     this.id = id;
     this.constColumns = constColumns;
     this.columns = columns;
@@ -478,127 +502,105 @@ function initXapi(options) {
     ...options
   };
 }
-async function parse(reader) {
-  let _stream;
-  if (typeof reader === "string") {
-    _stream = new ReadableStream({
-      start(controller) {
-        controller.enqueue(new TextEncoder().encode(reader));
-        controller.close();
-      }
-    });
-  } else {
-    _stream = reader;
-  }
-  const xmlParser = new StaxXmlParser(_stream, {
-    addEntities: makeParseEntities(),
-    encoding: "UTF-8"
-  });
+function parse2(xml) {
+  const parsedXml = txml.parse(xml);
   const xapiRoot = new XapiRoot();
-  for await (const event of xmlParser) {
-    if (event.type === XmlEventType.START_ELEMENT) {
-      const startEvent = event;
-      switch (startEvent.localName) {
-        case "Parameter":
-          let paramValue = void 0;
-          const charEvent = (await xmlParser.next()).value;
-          if (charEvent.type === XmlEventType.CHARACTERS) {
-            paramValue = charEvent.value;
-          }
-          xapiRoot.addParameter({
-            id: startEvent.attributes["id"],
-            type: startEvent.attributes["type"] || "STRING",
-            value: _options.parseToTypes ? convertToColumnType(paramValue, startEvent.attributes["type"] || "STRING") : paramValue
-          });
-          break;
-        case "Dataset":
-          xapiRoot.addDataset(await parseDataset(startEvent, xmlParser));
-          break;
+  const rootElement = parsedXml.find((node) => {
+    const rootNode = node;
+    return rootNode.tagName === "Root";
+  });
+  if (rootElement === void 0) return xapiRoot;
+  const parametersElement = rootElement.children?.find((node) => node.tagName === "Parameters");
+  parseParameters(parametersElement, xapiRoot);
+  const datasetsElements = rootElement.children?.filter((node) => node.tagName === "Dataset");
+  if (datasetsElements && datasetsElements?.length && datasetsElements.length > 0) {
+    for (const datasetsElement of datasetsElements) {
+      if (!datasetsElement.attributes || !datasetsElement.attributes.id) {
+        throw new InvalidXmlError("Dataset element must have an 'id' attribute");
       }
+      const datasetId = datasetsElement.attributes?.id;
+      const dataset = new Dataset(datasetId);
+      xapiRoot.addDataset(dataset);
+      const columnInfoElement = datasetsElement.children?.find((node) => node.tagName === "ColumnInfo");
+      parseColumnInfo(columnInfoElement, dataset);
+      const rowsElement = datasetsElement.children?.find((node) => node.tagName === "Rows");
+      parseRows(rowsElement, dataset);
     }
   }
   return xapiRoot;
 }
-async function parseDataset(initEvent, xmlParser) {
-  const dataset = new Dataset(initEvent.attributes["id"]);
-  let currentRowIndex = -1;
-  for await (const event of xmlParser) {
-    if (event.type === XmlEventType.END_ELEMENT && event.localName === "Dataset") {
-      break;
-    } else if (event.type === XmlEventType.START_ELEMENT) {
-      const startEvent = event;
-      switch (startEvent.localName) {
-        case "ConstColumn":
-          dataset.addConstColumn({
-            id: startEvent.attributes["id"],
-            size: parseInt(startEvent.attributes["size"] || "0", 10),
-            type: startEvent.attributes["type"] || "STRING",
-            value: startEvent.attributes["value"] || void 0
-          });
-          break;
-        case "Column":
-          dataset.addColumn({
-            id: startEvent.attributes["id"],
-            size: parseInt(startEvent.attributes["size"] || "0", 10),
-            type: startEvent.attributes["type"] || "STRING"
+function parseValue(value, type = "STRING") {
+  value = _unescapeXml(value);
+  return _options.parseToTypes ? convertToColumnType(value, type) : value;
+}
+function parseColumnInfo(columnInfoElement, dataset) {
+  if (!columnInfoElement) throw new InvalidXmlError("ColumnInfo element is missing in the dataset");
+  columnInfoElement.children?.forEach((colInfo) => {
+    if (colInfo.tagName === "ConstColumn") {
+      dataset.addConstColumn({
+        id: colInfo.attributes?.id,
+        size: parseInt(colInfo.attributes?.size || "0", 10),
+        type: colInfo.attributes?.type || "STRING",
+        value: parseValue(colInfo.attributes?.value, colInfo.attributes?.type)
+      });
+    } else if (colInfo.tagName === "Column") {
+      dataset.addColumn({
+        id: colInfo.attributes?.id,
+        size: parseInt(colInfo.attributes?.size || "0", 10),
+        type: colInfo.attributes?.type || "STRING"
+      });
+    }
+  });
+}
+function parseRows(rowsElement, dataset) {
+  rowsElement?.children?.forEach((r) => {
+    if (r.tagName === "Row") {
+      const rowIndex = dataset.newRow();
+      dataset.rows[rowIndex].type = r.attributes?.type || void 0;
+      r.children?.forEach((col) => {
+        if (col.tagName === "Col") {
+          const colId = col.attributes?.id;
+          const value = col.children?.[0];
+          const columnInfo = dataset.getColumnInfo(colId);
+          if (!columnInfo) throw new InvalidXmlError(`Column with id ${colId} not found in dataset ${dataset.id}`);
+          const castedValue = parseValue(value, columnInfo.type);
+          dataset.rows[rowIndex].cols.push({ id: colId, value: castedValue });
+        } else if (col.tagName === "OrgRow") {
+          dataset.rows[rowIndex].orgRow = [];
+          col.children?.forEach((orgCol) => {
+            if (orgCol.tagName === "Col") {
+              const colId = orgCol.attributes?.id;
+              const value = orgCol.children?.[0];
+              const columnInfo = dataset.getColumnInfo(colId);
+              const castedValue = parseValue(value, columnInfo.type);
+              if (dataset && dataset.rows && dataset.rows[rowIndex] && dataset.rows[rowIndex].orgRow) {
+                dataset.rows[rowIndex].orgRow.push({ id: colId, value: castedValue });
+              }
+            }
           });
-          break;
-        case "Row":
-          currentRowIndex = dataset.newRow();
-          dataset.rows[currentRowIndex].type = startEvent.attributes["type"] || void 0;
-          break;
-        case "Col": {
-          await parseCol(xmlParser, startEvent, dataset, currentRowIndex, false);
-          break;
         }
-        case "OrgRow":
-          if (currentRowIndex < 0) {
-            throw new Error("Row must be defined before OrgRow");
-          }
-          dataset.rows[currentRowIndex].orgRow = [];
-          for await (const orgRowEvent of xmlParser) {
-            if (orgRowEvent.type === XmlEventType.END_ELEMENT && orgRowEvent.localName === "OrgRow") {
-              break;
-            }
-            if (orgRowEvent.type === XmlEventType.START_ELEMENT && orgRowEvent.localName === "Col") {
-              const orgColEvent = orgRowEvent;
-              await parseCol(xmlParser, orgColEvent, dataset, currentRowIndex, true);
-            }
-          }
-      }
+      });
+    } else if (r.tagName === "Col") {
+      throw new InvalidXmlError("Row must be defined before Col");
+    } else if (r.tagName === "OrgRow") {
+      throw new InvalidXmlError("Row must be defined before OrgRow");
     }
-  }
-  return dataset;
+  });
 }
-async function parseCol(xmlParser, startEvent, dataset, currentRowIndex, isOrgRow) {
-  if (currentRowIndex < 0) {
-    throw new Error("Row must be defined before Col");
-  }
-  const colId = startEvent.attributes["id"];
-  const colIndex = dataset.getColumnIndex(colId);
-  if (colIndex === void 0 || colIndex < 0) {
-    throw new Error(`Column with id ${colId} not found in dataset ${dataset.id}`);
-  }
-  const colCharEvent = (await xmlParser.next()).value;
-  let value;
-  if (colCharEvent.type === XmlEventType.CDATA) {
-    value = colCharEvent.value;
-  } else if (colCharEvent.type === XmlEventType.CHARACTERS) {
-    value = colCharEvent.value;
-  }
-  let castedValue = value;
-  if (_options.parseToTypes) {
-    const columnInfo = dataset.getColumnInfo(colId);
-    if (!columnInfo || columnType.includes(columnInfo.type) === false) {
-      throw new Error(`Column type for ${colId} not found in dataset ${dataset.id}`);
+function parseParameters(parametersElement, xapiRoot) {
+  if (!parametersElement) return;
+  parametersElement.children?.forEach((p) => {
+    if (p.tagName === "Parameter") {
+      const id = p.attributes?.id;
+      const type = p.attributes?.type || "STRING";
+      const value = p.children?.[0];
+      xapiRoot.addParameter({
+        id,
+        type,
+        value: parseValue(value, type)
+      });
     }
-    castedValue = convertToColumnType(value, columnInfo.type);
-  }
-  if (!isOrgRow) {
-    dataset.rows[currentRowIndex].cols.push({ id: colId, value: castedValue });
-  } else {
-    dataset.rows[currentRowIndex].orgRow.push({ id: colId, value: castedValue });
-  }
+  });
 }
 async function writeString(root) {
   const stringStream = new StringWritableStream();
@@ -718,10 +720,13 @@ async function writeColumn(writer, dataset, col) {
 export {
   ColumnTypeError,
   Dataset,
+  InvalidXmlError,
   NexaVersion,
   StringWritableStream,
   XapiRoot,
   XplatformVersion,
+  _unescapeXml,
+  arrayBufferToString,
   base64ToUint8Array,
   columnType,
   convertToColumnType,
@@ -730,7 +735,7 @@ export {
   initXapi,
   makeParseEntities,
   makeWriterEntities,
-  parse,
+  parse2 as parse,
   rowType,
   stringToDate,
   stringToReadableStream,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xapi-js/core",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -32,12 +32,14 @@
     "typescript": "^5.3.3"
   },
   "dependencies": {
-    "stax-xml": "^0.2.4"
+    "stax-xml": "^0.2.4",
+    "txml": "^5.1.1"
   },
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "test": "vitest run",
     "test:watch": "vitest",
-    "coverage": "vitest run --coverage"
+    "coverage": "vitest run --coverage",
+    "benchmark": "node test/performance.test.mjs"
   }
 }