[WIP] allow to use libxml2-wasm for XML validation
#1184
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,52 @@ | ||||||
| /*! | ||||||
| This file is part of CycloneDX JavaScript Library. | ||||||
|
|
||||||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| you may not use this file except in compliance with the License. | ||||||
| You may obtain a copy of the License at | ||||||
|
|
||||||
| http://www.apache.org/licenses/LICENSE-2.0 | ||||||
|
|
||||||
| Unless required by applicable law or agreed to in writing, software | ||||||
| distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| See the License for the specific language governing permissions and | ||||||
| limitations under the License. | ||||||
|
|
||||||
| SPDX-License-Identifier: Apache-2.0 | ||||||
| Copyright (c) OWASP Foundation. All Rights Reserved. | ||||||
| */ | ||||||
|
|
||||||
| import { readFile } from 'fs/promises'; | ||||||
| import { ParseOption, XmlDocument, XsdValidator } from 'libxml2-wasm'; | ||||||
|
There was a problem hiding this comment. did not look into details of untested code for #1184 (comment)
Suggested change
There was a problem hiding this comment. or, we could see if we can get There was a problem hiding this comment. or you could ask the library authors for help. There was a problem hiding this comment.
This isn't possible with module set to CommonJS in the tsconfig: There was a problem hiding this comment. would it be possible to move the export default (async function (schemaPath: string): Promise<Validator> {
const { ParseOption, XmlDocument, XsdValidator } = await import('libxml2-wasm');
// ...
}) satisfies FunctionalityThere was a problem hiding this comment. I also tried that, but it always gets transpiled into a require, which triggers the error. There was a problem hiding this comment. I see. So we might require dropping node14 support, This will cause breaking-changes - which is no blocker, just a remark. I would be happy working with you to make this happen. 👍 You have carte blanche - change whatever is needed to make this feature work. Just don't rush, good things may take a while. There was a problem hiding this comment. I can give it a shot, I've done some tests locally and it seems the most work is in the Mocha tests, since they're written in Javascript with requires. They all need to be rewritten to imports. |
||||||
| import { pathToFileURL } from 'url'; | ||||||
|
|
||||||
| import type { ValidationError } from '../../validation/types'; | ||||||
| import type { Functionality, Validator } from '../xmlValidator'; | ||||||
|
|
||||||
| /** @internal */ | ||||||
| export default (async function (schemaPath: string): Promise<Validator> { | ||||||
| const options = ParseOption.XML_PARSE_NONET | ParseOption.XML_PARSE_COMPACT; | ||||||
| const schema = XmlDocument.fromString( | ||||||
| await readFile(schemaPath, 'utf-8'), | ||||||
| { | ||||||
| option: options, | ||||||
| url: pathToFileURL(schemaPath).toString() | ||||||
| }); | ||||||
| const validator = XsdValidator.fromDoc(schema); | ||||||
|
|
||||||
| return function (data: string): null | ValidationError { | ||||||
| const doc = XmlDocument.fromString(data, { option: options }); | ||||||
| let errors = null; | ||||||
| try { | ||||||
| validator.validate(doc); | ||||||
| } | ||||||
| catch (validationErrors) { | ||||||
| errors = validationErrors; | ||||||
| } | ||||||
|
|
||||||
| doc.dispose(); | ||||||
|
|
||||||
| return errors; | ||||||
| } | ||||||
| }) satisfies Functionality | ||||||
Uh oh!
There was an error while loading. Please reload this page.