UNPKG

xml-helper-ts

Version:

A TypeScript library for XML parsing, validation with XSD schema, and XML/JSON conversion - built from scratch without external dependencies

61 lines 2.19 kB
import { ValidationError, XmlParseResult, XmlToJsonOptions, JsonToXmlOptions, XsdSchema, XmlNode } from './types'; export declare class XmlHelper { private xmlParser; private xsdParser; private schema; private validator; /** * Load and parse an XSD schema * @param xsdContent The XSD schema content as string * @returns Array of validation errors if any */ loadSchema(xsdContent: string): ValidationError[]; /** * Validate XML against the loaded schema * @param xmlContent The XML content to validate * @returns Array of validation errors with line numbers */ validateXml(xmlContent: string): ValidationError[]; /** * Parse XML to JSON object * @param xmlContent The XML content to parse * @param options Options for XML to JSON conversion * @returns Parsed JSON object or null if parsing failed */ xmlToJson(xmlContent: string, options?: XmlToJsonOptions): XmlParseResult; /** * Convert JSON object to XML string * @param jsonData The JSON data to convert * @param rootElement The root element name (optional) * @param options Options for JSON to XML conversion * @returns XML string representation */ jsonToXml(jsonData: any, rootElement?: string, options?: JsonToXmlOptions): string; /** * Parse XML without validation (schema-free parsing) * @param xmlContent The XML content to parse * @returns Parsed XML node structure */ parseXml(xmlContent: string): { node: XmlNode | null; errors: ValidationError[]; }; /** * Get the currently loaded schema * @returns The loaded XSD schema or null */ getSchema(): XsdSchema | null; /** * Check if a schema is currently loaded * @returns True if a schema is loaded */ hasSchema(): boolean; } export * from './types'; export { XmlParser } from './xml-parser'; export { XsdParser } from './xsd-parser'; export { XmlValidator } from './xml-validator'; export { XmlToJsonConverter } from './xml-to-json'; export { JsonToXmlConverter } from './json-to-xml'; export default XmlHelper; //# sourceMappingURL=index.d.ts.map