wip

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

Author: jkowalleck

examples/node/typescript/example.mjs/src/example.ts

@@ -54,6 +54,7 @@ const serializedJson = jsonSerializer.serialize(bom)
 console.log(serializedJson)
 const jsonValidator = new CDX.Validation.JsonStrictValidator(serializeSpec.version)
 try {
+  /* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- intended */
   const validationErrors = await jsonValidator.validate(serializedJson)
   if (validationErrors === null) {
     console.info('JSON valid')
@@ -75,6 +76,7 @@ const serializedXML = xmlSerializer.serialize(bom)
 console.log(serializedXML)
 const xmlValidator = new CDX.Validation.XmlValidator(serializeSpec.version)
 try {
+  /* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- intended */
   const validationErrors = await xmlValidator.validate(serializedXML)
   if (validationErrors === null) {
     console.info('XML valid')

src/_optPlug.node/__jsonValidators/ajv.ts

@@ -36,15 +36,19 @@ const ajvOptions: AjvOptions = Object.freeze({
 
 /** @internal */
 export default (async function (schemaPath: string, schemaMap: Record<string, string> = {}): Promise<Validator> {
+  /* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-return -- intended */
   const [schema, schemas] = await Promise.all([
     readFile(schemaPath, 'utf-8').then(c => JSON.parse(c)),
     Promise.all(Object.entries(schemaMap).map(
       async ([k, v]) => await readFile(v, 'utf-8').then(c => [k, JSON.parse(c)])
     )).then(es => Object.fromEntries(es))
   ])
+  /* eslint-enable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-return  */
 
+  /* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- intended */
   const ajv = new Ajv({ ...ajvOptions, schemas })
   addFormats(ajv)
+  /* eslint-disable-next-line @typescript-eslint/no-unsafe-call -- intended */
   addFormats2019(ajv, { formats: ['idn-email'] })
   // there is just no working implementation for format "iri-reference": see https://github.com/luzlab/ajv-formats-draft2019/issues/22
   ajv.addFormat('iri-reference', true)

src/_optPlug.node/errors.ts

@@ -22,6 +22,7 @@ export class OptPlugError extends Error {
 
   constructor (message: string, cause?: any) {
     super(message)
+    /* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- intended */
     this.cause = cause
   }
 }

src/_optPlug.node/jsonValidator.ts

@@ -24,8 +24,14 @@ export type Validator = (data: string) => null | ValidationError
 export type Functionality = (schemaPath: string, schemaMap: Record<string, string>) => Promise<Validator>
 
 export default opWrapper<Functionality>('JsonValidator', [
+  /* eslint-disable @typescript-eslint/no-unsafe-member-access -- needed */
+  /* eslint-disable @typescript-eslint/no-require-imports -- needed */
+  /* eslint-disable @typescript-eslint/no-unsafe-return -- needed */
 
   ['( ajv && ajv-formats && ajv-formats-draft2019 )', () => require('./__jsonValidators/ajv').default]
   // ... add others here, pull-requests welcome!
 
+  /* eslint-enable @typescript-eslint/no-unsafe-return */
+  /* eslint-enable @typescript-eslint/no-require-imports */
+  /* eslint-enable @typescript-eslint/no-unsafe-member-access */
 ]) satisfies Functionality | WillThrow

src/_optPlug.node/xmlStringify.ts

@@ -24,8 +24,14 @@ import opWrapper, { type WillThrow } from './_wrapper'
 export type Functionality = (element: SimpleXml.Element, options?: SerializerOptions) => string
 
 export default opWrapper<Functionality>('XmlStringifier', [
+  /* eslint-disable @typescript-eslint/no-unsafe-member-access -- needed */
+  /* eslint-disable @typescript-eslint/no-require-imports -- needed */
+  /* eslint-disable @typescript-eslint/no-unsafe-return -- needed */
 
   ['xmlbuilder2', () => require('./__xmlStringifiers/xmlbuilder2').default]
   // ... add others here, pull-requests welcome!
 
+  /* eslint-enable @typescript-eslint/no-unsafe-return */
+  /* eslint-enable @typescript-eslint/no-require-imports */
+  /* eslint-enable @typescript-eslint/no-unsafe-member-access */
 ]) satisfies Functionality | WillThrow

src/_optPlug.node/xmlValidator.ts

@@ -24,8 +24,14 @@ export type Validator = (data: string) => null | ValidationError
 export type Functionality = (schemaPath: string) => Promise<Validator>
 
 export default opWrapper<Functionality>('XmlValidator', [
+  /* eslint-disable @typescript-eslint/no-unsafe-member-access -- needed */
+  /* eslint-disable @typescript-eslint/no-require-imports -- needed */
+  /* eslint-disable @typescript-eslint/no-unsafe-return -- needed */
 
   ['libxmljs2', () => require('./__xmlValidators/libxmljs2').default]
   // ... add others here, pull-requests welcome!
 
+  /* eslint-enable @typescript-eslint/no-unsafe-return */
+  /* eslint-enable @typescript-eslint/no-require-imports */
+  /* eslint-enable @typescript-eslint/no-unsafe-member-access */
 ]) satisfies Functionality | WillThrow

src/factories/fromNodePackageJson.node.ts

@@ -54,8 +54,8 @@ export class ExternalReferenceFactory {
   makeVcs (data: PackageJson): ExternalReference | undefined {
     /* see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#repositoryc */
     const {repository} = data
-    let url
-    let comment: string | undefined
+    let url = undefined
+    let comment: string | undefined = undefined
     if (typeof repository === 'object') {
       url = tryCanonicalizeGitUrl(repository.url)
       comment = 'as detected from PackageJson property "repository.url"'
@@ -87,8 +87,8 @@ export class ExternalReferenceFactory {
   makeIssueTracker (data: PackageJson): ExternalReference | undefined {
     /* see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#bugs */
     const {bugs} = data
-    let url
-    let comment: string | undefined
+    let url = undefined
+    let comment: string | undefined =undefined
     if (typeof bugs === 'object') {
       url = bugs.url
       comment = 'as detected from PackageJson property "bugs.url"'

src/factories/packageUrl.ts

@@ -34,9 +34,10 @@ export class PackageUrlFactory<PurlType extends PackageURL['type'] = PackageURL[
     return this.#type
   }
 
+  /* eslint-disable-next-line @typescript-eslint/no-inferrable-types -- docs */
   makeFromComponent (component: Component, sort: boolean = false): PackageURL | undefined {
     const qualifiers: PackageURL['qualifiers'] = {}
-    let subpath: PackageURL['subpath']
+    let subpath: PackageURL['subpath'] = undefined
 
     // sorting to allow reproducibility: use the last instance for a `extRef.type`, if multiples exist
     const extRefs = sort
@@ -51,6 +52,7 @@ export class PackageUrlFactory<PurlType extends PackageURL['type'] = PackageURL[
       // According to https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst
       // there is no formal requirement to a `..._url`.
       // Everything is possible: URL-encoded, not encoded, with schema, without schema
+      /* eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check -- intended */
       switch (extRef.type) {
         case ExternalReferenceType.VCS:
           [qualifiers[PackageUrlQualifierNames.VcsUrl], subpath] = url.split('#', 2)

src/serialize/bomRefDiscriminator.ts

@@ -24,6 +24,7 @@ export class BomRefDiscriminator {
 
   readonly #prefix: string
 
+  /* eslint-disable-next-line @typescript-eslint/no-inferrable-types -- docs */
   constructor (bomRefs: Iterable<BomRef>, prefix: string = 'BomRef') {
     this.#originalValues = Array.from(bomRefs, r => [r, r.value])
     this.#prefix = prefix

src/serialize/index.common.ts

@@ -21,7 +21,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 
 export * from './bomRefDiscriminator'
 export * from './errors'
-export * as Types from './types'
+export type * as Types from './types'
 
 // region base