prep structures

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

Author: jkowalleck

src/index.node.ts

@@ -24,6 +24,7 @@ export * from './index.common'
 export * as Builders from './builders/index.node'
 export * as Factories from './factories/index.node'
 export * as Serialize from './serialize/index.node'
+export * as Validation from './validation/index.node'
 
 /**
  * Internal, until the resources-module was finalized and shows any value

src/validation/errors.ts

@@ -0,0 +1,31 @@
+/*!
+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 class ValidationError extends Error {
+  readonly #details: any | undefined
+
+  constructor (message?: string, details?: any) {
+    super(message)
+    this.#details = details
+  }
+
+  get details (): any | undefined {
+    return this.#details
+  }
+}

src/validation/index.node.ts

@@ -0,0 +1,22 @@
+/*!
+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 './errors'
+export * from './validator'
+export * as Validators from './validators'

src/validation/validator.ts

@@ -0,0 +1,25 @@
+/*!
+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 {
+  /**
+   * @throws {@link Validation.ValidationError | ValidationError} in case of validation errors
+   */
+  validate: (data: any) => void
+}

src/validation/validators/_helpers.ts

@@ -0,0 +1,35 @@
+/*!
+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 {Version} from "../../spec";
+import {Validator} from "../validator";
+
+export abstract class BaseValidator implements Validator {
+  readonly #version: Version;
+
+  constructor(version: Version) {
+    this.#version = version
+  }
+
+  get version(): Version {
+    return this.#version
+  }
+
+  abstract validate(data: any): void
+}

src/validation/validators/index.ts

@@ -0,0 +1,21 @@
+/*!
+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 './json'
+export * from './xml'

src/validation/validators/json.ts

@@ -0,0 +1,41 @@
+/*!
+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 { ValidationError } from '../errors'
+import { BaseValidator } from './_helpers'
+
+export class JsonValidator extends BaseValidator {
+  /**
+   * @throws {@link Validation.ValidationError | ValidationError} in case of validation errors
+   */
+  validate (data: any): void {
+    // TODO
+    throw new ValidationError('not implemented')
+  }
+}
+
+export class JsonStrictValidator extends BaseValidator {
+  /**
+   * @throws {@link Validation.ValidationError | ValidationError} in case of validation errors
+   */
+  validate (data: any): void {
+    // TODO
+    throw new ValidationError('not implemented')
+  }
+}

src/validation/validators/xml.ts

@@ -0,0 +1,31 @@
+/*!
+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 { ValidationError } from '../errors'
+import { BaseValidator } from './_helpers'
+
+export class XmlValidator extends BaseValidator {
+  /**
+   * @throws {@link Validation.ValidationError | ValidationError} in case of validation errors
+   */
+  validate (data: any): void {
+    // TODO
+    throw new ValidationError('not implemented')
+  }
+}