namespace adjusts for validation

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

src/index.web.ts

@@ -23,5 +23,6 @@ export * from './index.common'
 
 export * as Factories from './factories/index.web'
 export * as Serialize from './serialize/index.web'
+export * as Validation from './validation/index.web'
 
 // endregion web-specifics

src/validation/validator.ts renamed to src/validation/baseValidator.ts

@@ -29,7 +29,7 @@ export interface Validator {
   validate: (data: string) => Promise<void>
 }
 
-export abstract class BaseValidator implements Validator {
+export abstract class BaseValidator implements BaseValidator {
   readonly #version: Version
 
   constructor (version: Version) {

src/validation/validators/index.ts renamed to src/validation/index.common.ts

@@ -17,5 +17,5 @@ SPDX-License-Identifier: Apache-2.0
 Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
-export * from './json'
-export * from './xml'
+export * from './errors'
+export * from './types'

src/validation/index.node.ts

@@ -17,6 +17,11 @@ SPDX-License-Identifier: Apache-2.0
 Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
-export * from './errors'
-export type { Validator } from './validator'
-export * as Validators from './validators'
+export * from './index.common'
+
+// region node-specifics
+
+export * from './jsonValidator'
+export * from './xmlValidator.node'
+
+// endregion node-specifics

src/validation/index.web.ts

@@ -0,0 +1,29 @@
+/*!
+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.
+*/
+
+export * from './index.common'
+
+// region web-specifics
+
+// json validator is experimental, and not public to web, yet
+// export * from './jsonValidator'
+
+// there is no XML validator for the web, yet
+
+// endregion web-specifics

src/validation/validators/json.ts renamed to src/validation/jsonValidator.ts

@@ -21,9 +21,9 @@ import type Ajv from 'ajv'
 import { type ValidateFunction } from 'ajv'
 import { readFile } from 'fs/promises'
 
-import { FILES } from '../../resources.node'
-import { MissingOptionalDependencyError, NotImplementedError, ValidationError } from '../errors'
-import { BaseValidator } from '../validator'
+import { FILES } from '../resources.node'
+import { BaseValidator } from './baseValidator'
+import { MissingOptionalDependencyError, NotImplementedError, ValidationError } from './errors'
 
 let _ajv: Ajv | undefined
 

src/validation/types.ts

@@ -0,0 +1,28 @@
+/*!
+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.
+*/
+
+export interface Validator {
+  /**
+   * Promise rejects with one of the following
+   * - {@link Validation.NotImplementedError | NotImplementedError} when there is no validator available for `this.version`
+   * - {@link Validation.MissingOptionalDependencyError | MissingOptionalDependencyError} when a required dependency was not installed
+   * - {@link Validation.ValidationError | ValidationError} when `data` was invalid to the schema
+   */
+  validate: (data: string) => Promise<void>
+}

src/validation/validators/xml.ts renamed to src/validation/xmlValidator.node.ts

@@ -21,9 +21,9 @@ import { readFile } from 'fs/promises'
 import type { Document, ParserOptions, parseXml } from 'libxmljs2'
 import { pathToFileURL } from 'url'
 
-import { FILES } from '../../resources.node'
-import { MissingOptionalDependencyError, NotImplementedError, ValidationError } from '../errors'
-import { BaseValidator } from '../validator'
+import { FILES } from '../resources.node'
+import { BaseValidator } from './baseValidator'
+import { MissingOptionalDependencyError, NotImplementedError, ValidationError } from './errors'
 
 let _parser: typeof parseXml | undefined
 

tests/integration/Serialize.JsonSerialize.test.js

@@ -32,7 +32,7 @@ const {
   Spec: { Spec1dot2, Spec1dot3, Spec1dot4 },
   Validation: {
     ValidationError, MissingOptionalDependencyError,
-    Validators: { JsonStrictValidator }
+    JsonStrictValidator
   }
 } = require('../../')
 

tests/integration/Serialize.XmlSerialize.test.js

@@ -32,7 +32,7 @@ const {
   Spec: { Spec1dot2, Spec1dot3, Spec1dot4 },
   Validation: {
     ValidationError, MissingOptionalDependencyError,
-    Validators: { XmlValidator }
+    XmlValidator
   }
 } = require('../../')