13 Commits
v1.0.7 ... main

15 changed files with 9884 additions and 4447 deletions

View File

@@ -6,8 +6,8 @@ on:
- '**' - '**'
env: env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}} NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}} NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}} NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@@ -26,7 +26,7 @@ jobs:
- name: Install pnpm and npmci - name: Install pnpm and npmci
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @shipzone/npmci pnpm install -g @ship.zone/npmci
- name: Run npm prepare - name: Run npm prepare
run: npmci npm prepare run: npmci npm prepare

View File

@@ -6,8 +6,8 @@ on:
- '*' - '*'
env: env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}} NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}} NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}} NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@@ -26,7 +26,7 @@ jobs:
- name: Prepare - name: Prepare
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @shipzone/npmci pnpm install -g @ship.zone/npmci
npmci npm prepare npmci npm prepare
- name: Audit production dependencies - name: Audit production dependencies
@@ -54,7 +54,7 @@ jobs:
- name: Prepare - name: Prepare
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @shipzone/npmci pnpm install -g @ship.zone/npmci
npmci npm prepare npmci npm prepare
- name: Test stable - name: Test stable
@@ -82,7 +82,7 @@ jobs:
- name: Prepare - name: Prepare
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @shipzone/npmci pnpm install -g @ship.zone/npmci
npmci npm prepare npmci npm prepare
- name: Release - name: Release
@@ -104,7 +104,7 @@ jobs:
- name: Prepare - name: Prepare
run: | run: |
pnpm install -g pnpm pnpm install -g pnpm
pnpm install -g @shipzone/npmci pnpm install -g @ship.zone/npmci
npmci npm prepare npmci npm prepare
- name: Code quality - name: Code quality

7
.gitignore vendored
View File

@@ -3,7 +3,6 @@
# artifacts # artifacts
coverage/ coverage/
public/ public/
pages/
# installs # installs
node_modules/ node_modules/
@@ -17,4 +16,8 @@ node_modules/
dist/ dist/
dist_*/ dist_*/
# custom # AI
.claude/
.serena/
#------# custom

67
changelog.md Normal file
View File

@@ -0,0 +1,67 @@
# Changelog
## 2025-11-19 - 2.0.0 - BREAKING CHANGE(core)
Implement custom XmlBuilder, remove xmlbuilder2, upgrade fast-xml-parser, update SmartXml API, tests and CI
- Add a new chainable XmlBuilder implementation (create(), ele(), txt(), att(), up(), com(), end(), toString()) and export it from the package
- Remove xmlbuilder2 dependency and its export from smartxml.plugins.ts
- Upgrade fast-xml-parser dependency to ^5.3.2 and use it for parsing and building XML
- Update SmartXml to use XmlBuilder.create() as the create factory and export XmlBuilder for direct use
- Extend and update tests to cover the new XmlBuilder chainable API and XML serialization behavior
- Update CI workflows: switch container IMAGE registry, adjust NPMCI_COMPUTED_REPOURL and change pnpm install target for npmci package name
- Bump several devDependencies, add pnpm packageManager/pnpm metadata, and apply small tsconfig/.gitignore cleanups
## 2025-11-19 - 1.2.0 - feat(core)
Implement custom XmlBuilder with chainable API and upgrade dependencies
- **BREAKING**: Removed xmlbuilder2 dependency (replaced with custom implementation)
- Upgraded fast-xml-parser from 4.5.1 to 5.3.2
- Implemented custom XmlBuilder class with fluent/chainable API
- `.ele(name, attrs)` - Add elements
- `.txt(content)` - Add text content
- `.att(name, value)` - Add attributes
- `.up()` - Navigate to parent
- `.end(options)` - Serialize to XML
- Added comprehensive tests for XmlBuilder functionality
- Maintains API compatibility: `smartxml.create()` continues to work
- Browser-compatible implementation (no Node.js dependencies)
- Export XmlBuilder class for direct usage
## 2024-12-30 - 1.1.1 - fix(dependencies)
Added missing xmlbuilder2 dependency and relevant exports
- Added xmlbuilder2 to dependencies in package.json
- Export xmlbuilder2 functionality from smartxml.plugins.ts and ts/index.ts
## 2024-12-30 - 1.1.0 - feat(core)
Upgrade dependencies and enhance XML parsing and building
- Updated fast-xml-parser dependency to version ^4.5.1
- Enhanced XML parsing to preserve order and handle attributes
- Refactored createXmlFromObject method with a new XMLBuilder implementation
- Improved test coverage for XML string creation and parsing
## 2024-05-29 - 1.0.8 - Various Updates
Minor updates and improvements to configuration and documentation.
- Updated project description
- Modified `tsconfig` file
- Updated `npmextra.json`: githost
## 2023-10-20 - 1.0.6 to 1.0.8 - Core Fixes and Updates
Maintenance and core updates with improvements in project configuration.
- Core functionality fixes and updates
- Configuration updates
- Preparation for versioning to 1.0.8
## 2020-10-24 - 1.0.1 to 1.0.6 - Core Fixes
Multiple fixes and enhancements in core components.
- Series of core updates to improve stability and performance

View File

@@ -2,17 +2,28 @@
"gitzone": { "gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "push.rocks", "gitscope": "push.rocks",
"gitrepo": "smartxml", "gitrepo": "smartxml",
"description": "a package for creating and parsing xml formated files", "description": "A package for creating and parsing XML formatted files.",
"npmPackagename": "@push.rocks/smartxml", "npmPackagename": "@push.rocks/smartxml",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks" "projectDomain": "push.rocks",
"keywords": [
"XML",
"parsing",
"XML creation",
"fast-xml-parser",
"TypeScript",
"data serialization"
]
} }
}, },
"npmci": { "npmci": {
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "npmAccessLevel": "public"
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
} }
} }

View File

@@ -1,8 +1,8 @@
{ {
"name": "@push.rocks/smartxml", "name": "@push.rocks/smartxml",
"version": "1.0.7", "version": "2.0.0",
"private": false, "private": false,
"description": "a package for creating and parsing xml formated files", "description": "A package for creating and parsing XML formatted files.",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH", "author": "Lossless GmbH",
@@ -13,15 +13,15 @@
"buildDocs": "tsdoc" "buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.25", "@git.zone/tsbuild": "^3.1.0",
"@git.zone/tsbundle": "^2.0.10", "@git.zone/tsbundle": "^2.5.2",
"@git.zone/tsrun": "^1.2.46", "@git.zone/tsrun": "^2.0.0",
"@git.zone/tstest": "^1.0.44", "@git.zone/tstest": "^2.8.2",
"@push.rocks/tapbundle": "^5.0.15", "@push.rocks/tapbundle": "^6.0.3",
"@types/node": "^20.8.7" "@types/node": "^22.10.2"
}, },
"dependencies": { "dependencies": {
"fast-xml-parser": "^4.3.2" "fast-xml-parser": "^5.3.2"
}, },
"browserslist": [ "browserslist": [
"last 1 chrome versions" "last 1 chrome versions"
@@ -40,11 +40,23 @@
], ],
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://gitlab.com/push.rocks/smartxml.git" "url": "https://code.foss.global/push.rocks/smartxml.git"
}, },
"bugs": { "bugs": {
"url": "https://gitlab.com/push.rocks/smartxml/issues" "url": "https://code.foss.global/push.rocks/smartxml/issues"
}, },
"homepage": "https://gitlab.com/push.rocks/smartxml#readme", "homepage": "https://code.foss.global/push.rocks/smartxml#readme",
"type": "module" "type": "module",
"keywords": [
"XML",
"parsing",
"XML creation",
"fast-xml-parser",
"TypeScript",
"data serialization"
],
"packageManager": "pnpm@10.18.1+sha512.77a884a165cbba2d8d1c19e3b4880eee6d2fcabd0d879121e282196b80042351d5eb3ca0935fa599da1dc51265cc68816ad2bddd2a2de5ea9fdf92adbec7cd34",
"pnpm": {
"overrides": {}
}
} }

13738
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

@@ -0,0 +1 @@

136
readme.md
View File

@@ -1,39 +1,121 @@
# @push.rocks/smartxml # @push.rocks/smartxml
a package for creating and parsing xml formated files
## Availabililty and Links a package for creating and parsing XML formatted files
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartxml)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartxml)
* [github.com (source mirror)](https://github.com/pushrocks/smartxml)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartxml/)
## Status for master ## Install
Status Category | Status Badge To start using @push.rocks/smartxml in your project, you'll first need to install it. This package is distributed via npm, so you can install it by running the following command in your project's root directory:
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartxml/badges/master/pipeline.svg)](https://lossless.cloud) ```sh
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartxml/badges/master/coverage.svg)](https://lossless.cloud) npm install @push.rocks/smartxml --save
npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartxml)](https://lossless.cloud) ```
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartxml)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartxml)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartxml)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartxml)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## Usage
Use TypeScript for best in class intellisense ### Getting Started
## Contribution First, ensure that your project is set up to use TypeScript and ESM syntax. Then, you can import `SmartXml` from @push.rocks/smartxml as follows:
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :) ```typescript
import { SmartXml } from '@push.rocks/smartxml';
```
For further information read the linked docs at the top of this readme. `SmartXml` provides two main functionalities: parsing XML formatted strings into JavaScript objects and vice versa, creating XML formatted strings from JavaScript objects.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) ### Parsing XML String to Object
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com) To parse an XML string to a JavaScript object, you can use the `parseXmlToObject` method. This method takes an XML string as its argument and returns a JavaScript object.
Here's a simple example:
```typescript
const xmlString = `
<note>
<to>Tove</to>
<from>Jani</from>
<heading>Reminder</heading>
<body>Don't forget me this weekend!</body>
</note>
`;
const smartXml = new SmartXml();
const resultObject = smartXml.parseXmlToObject(xmlString);
console.log(resultObject);
```
### Creating XML String from Object
Conversely, if you have a JavaScript object that you want to convert into an XML formatted string, you can use the `createXmlFromObject` method. This method accepts a JavaScript object and returns a string containing the XML representation of the object.
Here's an example:
```typescript
const noteObject = {
note: {
to: 'Tove',
from: 'Jani',
heading: 'Reminder',
body: "Don't forget me this weekend!",
},
};
const smartXml = new SmartXml();
const xmlString = smartXml.createXmlFromObject(noteObject);
console.log(xmlString);
```
### Advanced Usage
The `SmartXml` class is built on top of the `fast-xml-parser` library, which provides a lot of flexibility for both parsing and creation. For example, when creating XML from objects, you can control attributes, formatting, and more.
Let's look at a more complex example that includes XML attributes:
```typescript
const complexObject = {
note: {
'@_id': '12345',
'@_priority': 'high',
to: 'Tove',
from: { '@_domain': 'personal', '#text': 'Jani' },
heading: {
'@_style': 'bold',
'#text': 'Reminder',
},
body: 'This is a special note for the weekend.',
},
};
const smartXml = new SmartXml();
const complexXmlString = smartXml.createXmlFromObject(complexObject, {
format: true,
});
console.log(complexXmlString);
```
This example demonstrates how to add attributes (using `"@_attributeName": "value"`) and mixed content (using `"#text": "text value"`) to your objects before converting them to XML.
### Conclusion
The `@push.rocks/smartxml` package offers a straightforward and powerful means to work with XML in your JavaScript or TypeScript projects. By integrating it, you can easily convert between XML strings and JavaScript objects, allowing for efficient data processing and transmission in scenarios where XML is the preferred format. Whether you're building web services, APIs, or need to handle configuration files in XML, `SmartXml` offers the necessary tools to get the job done with minimal hassle.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

View File

@@ -2,11 +2,7 @@ import { expect, tap } from '@push.rocks/tapbundle';
import * as smartxml from '../ts/index.js'; import * as smartxml from '../ts/index.js';
let testSmartxml: smartxml.SmartXml; let testSmartxml: smartxml.SmartXml;
let testXml = ` let testXml = '';
<hello>
<wow>nice</wow>
</hello>
`;
tap.test('should create an instance', async () => { tap.test('should create an instance', async () => {
testSmartxml = new smartxml.SmartXml(); testSmartxml = new smartxml.SmartXml();
@@ -15,21 +11,79 @@ tap.test('should create an instance', async () => {
tap.test('should create an xml string', async () => { tap.test('should create an xml string', async () => {
const xmlResult = testSmartxml.createXmlFromObject({ const xmlResult = testSmartxml.createXmlFromObject({
hello: { hello: {
"@_xlmns:teststring": "hellothere", '@_xlmns:teststring': 'hellothere',
"@_xlmns:testnumber": 10, '@_xlmns:testnumber': 10,
wow: 'test', wow: 'test',
url: [{loc: 3},{loc: 3}] url: [{ loc: 3 }, { loc: 3 }],
} },
}); });
console.log(xmlResult); console.log(xmlResult);
testXml = xmlResult;
}); });
tap.test('should parse an yml file', async () => { tap.test('should parse an yml file', async () => {
const jsObject = testSmartxml.parseXmlToObject(testXml); const jsObject = testSmartxml.parseXmlToObject(testXml);
console.log(jsObject); // console.log(JSON.stringify(jsObject, null, 2));
expect(typeof jsObject).toEqual('object'); expect(typeof jsObject).toEqual('object');
expect(jsObject).property('hello').property('wow').toEqual('nice'); expect(jsObject)
.arrayItem(1)
.property('hello')
.arrayItem(0)
.property('wow')
.arrayItem(0)
.property('#text')
.toEqual('test');
}); });
// Test XmlBuilder chainable API
tap.test('should create XML using chainable API', async () => {
const xml = testSmartxml.create()
.ele('root', { att: 'val' })
.ele('foo')
.ele('bar').txt('foobar').up()
.up()
.ele('baz').up()
.up()
.end({ prettyPrint: true });
tap.start(); console.log('Chainable XML:', xml);
expect(xml).toContain('<root');
expect(xml).toContain('att="val"');
expect(xml).toContain('<foo>');
expect(xml).toContain('<bar>foobar</bar>');
expect(xml).toContain('<baz');
});
tap.test('should create XML from object using XmlBuilder', async () => {
const obj = {
root: {
'@_att': 'val',
foo: {
bar: 'foobar'
},
baz: {}
}
};
const xml = testSmartxml.create(obj).end({ prettyPrint: true });
console.log('Object-based XML:', xml);
expect(xml).toContain('<root');
expect(xml).toContain('att="val"');
expect(xml).toContain('<bar>foobar</bar>');
});
tap.test('should add attributes using att() method', async () => {
const xml = testSmartxml.create()
.ele('data')
.att('x', 1)
.att('y', 2)
.txt('value')
.up()
.end();
expect(xml).toContain('x="1"');
expect(xml).toContain('y="2"');
expect(xml).toContain('>value</data>');
});
export default tap.start();

View File

@@ -1,8 +1,8 @@
/** /**
* autocreated commitinfo by @pushrocks/commitinfo * autocreated commitinfo by @push.rocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/smartxml', name: '@push.rocks/smartxml',
version: '1.0.7', version: '2.0.0',
description: 'a package for creating and parsing xml formated files' description: 'A package for creating and parsing XML formatted files.'
} }

View File

@@ -1,22 +1,33 @@
import * as plugins from './smartxml.plugins.js'; import * as plugins from './smartxml.plugins.js';
import { XmlBuilder } from './smartxml.xmlbuilder.js';
export class SmartXml { export class SmartXml {
constructor() {} constructor() {}
public create = XmlBuilder.create;
public parseXmlToObject<T = any>(xmlStringArg: string): T { public parseXmlToObject<T = any>(xmlStringArg: string): T {
const parser = new plugins.fastXmlParser.XMLParser(); const parser = new plugins.fastXmlParser.XMLParser({
preserveOrder: true,
ignoreAttributes: false,
parseTagValue: true,
parseAttributeValue: true,
// ignoreDeclaration: true
});
const jsonObject = parser.parse(xmlStringArg); const jsonObject = parser.parse(xmlStringArg);
return jsonObject; return jsonObject as T;
} }
public createXmlFromObject(jsObject: any): string { public createXmlFromObject(jsObject: any): string {
const jsToXmlParser = new plugins.fastXmlParser.XMLBuilder({ const builder = new plugins.fastXmlParser.XMLBuilder({
ignoreAttributes: false, ignoreAttributes: false,
attributeNamePrefix: "@_", attributeNamePrefix: '@_',
format: true, format: true,
indentBy: ' ', indentBy: ' ',
}); });
const xml = jsToXmlParser.build(jsObject); const xml = builder.build(jsObject);
return '<?xml version="1.0" encoding="UTF-8"?>\n' + xml; return '<?xml version="1.0" encoding="UTF-8"?>\n' + xml;
} }
} }
export { XmlBuilder };

View File

@@ -1,5 +1,3 @@
import * as fastXmlParser from 'fast-xml-parser'; import * as fastXmlParser from 'fast-xml-parser';
export { export { fastXmlParser };
fastXmlParser
};

180
ts/smartxml.xmlbuilder.ts Normal file
View File

@@ -0,0 +1,180 @@
import * as plugins from './smartxml.plugins.js';
/**
* A lightweight chainable XML builder that provides a fluent API
* for programmatically constructing XML documents.
*/
export class XmlBuilder {
private stack: any[] = [];
private current: any = null;
private rootElement: any = null;
/**
* Creates a new XML builder instance
* @param input Optional: object to convert to XML, or XML string to parse
*/
constructor(input?: any) {
if (input) {
if (typeof input === 'string') {
// Parse XML string using fast-xml-parser
const parser = new plugins.fastXmlParser.XMLParser({
preserveOrder: true,
ignoreAttributes: false,
});
this.rootElement = parser.parse(input);
this.current = this.rootElement;
} else if (typeof input === 'object') {
// Accept object input
this.rootElement = input;
this.current = input;
}
}
}
/**
* Static factory method for creating instances
*/
static create(input?: any): XmlBuilder {
return new XmlBuilder(input);
}
/**
* Add an element
* @param name Element name
* @param attributes Optional attributes object
*/
public ele(name: string, attributes?: Record<string, any>): this {
if (!this.current) {
// First element becomes root
this.rootElement = {};
this.current = this.rootElement;
}
const newElement: any = {};
// Add attributes with @_ prefix (fast-xml-parser format)
if (attributes) {
for (const [key, value] of Object.entries(attributes)) {
newElement[`@_${key}`] = value;
}
}
// Check if this property already exists
if (this.current[name]) {
// Convert to array if not already
if (!Array.isArray(this.current[name])) {
this.current[name] = [this.current[name]];
}
this.current[name].push(newElement);
this.stack.push(this.current);
this.current = newElement;
} else {
this.current[name] = newElement;
this.stack.push(this.current);
this.current = newElement;
}
return this;
}
/**
* Add text content to current element
* @param content Text content
*/
public txt(content: string | number): this {
if (this.current) {
// Check if current element already has properties
const hasProperties = Object.keys(this.current).length > 0;
if (hasProperties) {
// Use #text format for mixed content
this.current['#text'] = String(content);
} else {
// For simple text-only elements, we can use direct assignment
// But to maintain consistency, we'll use #text
this.current['#text'] = String(content);
}
}
return this;
}
/**
* Add attribute to current element
* @param name Attribute name
* @param value Attribute value
*/
public att(name: string, value: any): this {
if (this.current) {
this.current[`@_${name}`] = value;
}
return this;
}
/**
* Move up to parent element
*/
public up(): this {
if (this.stack.length > 0) {
this.current = this.stack.pop();
}
return this;
}
/**
* Get the root element (for navigation)
*/
public root(): this {
if (this.stack.length > 0) {
this.current = this.stack[0];
this.stack = [];
}
return this;
}
/**
* Add a comment
* @param content Comment text
*/
public com(content: string): this {
// Comments in fast-xml-parser format
if (this.current) {
if (!this.current['#comment']) {
this.current['#comment'] = [];
}
if (!Array.isArray(this.current['#comment'])) {
this.current['#comment'] = [this.current['#comment']];
}
this.current['#comment'].push(content);
}
return this;
}
/**
* Serialize the XML document
* @param options Serialization options
*/
public end(options?: { prettyPrint?: boolean; format?: string }): string | any {
const opts = options || {};
if (opts.format === 'object') {
return this.rootElement;
}
// Use fast-xml-parser to build XML
const builder = new plugins.fastXmlParser.XMLBuilder({
ignoreAttributes: false,
attributeNamePrefix: '@_',
format: opts.prettyPrint !== false,
indentBy: ' ',
});
const xml = builder.build(this.rootElement || {});
return '<?xml version="1.0" encoding="UTF-8"?>\n' + xml;
}
/**
* Convert to string (alias for end)
*/
public toString(): string {
return this.end() as string;
}
}

View File

@@ -6,9 +6,9 @@
"module": "NodeNext", "module": "NodeNext",
"moduleResolution": "NodeNext", "moduleResolution": "NodeNext",
"esModuleInterop": true, "esModuleInterop": true,
"verbatimModuleSyntax": true "verbatimModuleSyntax": true,
"baseUrl": ".",
"paths": {}
}, },
"exclude": [ "exclude": ["dist_*/**/*.d.ts"]
"dist_*/**/*.d.ts"
]
} }