feat

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

Author: jkowalleck

src/_helpers/mime.ts

@@ -20,10 +20,13 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 
 import {extname} from "path";
 
-export type MimeType = string
+import type {MimeType} from "../types/mimeType";
 
 const MAP_TEXT_EXTENSION_MIMETYPE: Readonly<Record<string, MimeType>> = {
   '': 'text/plain', // our scope is text!
+  '.csv': 'text/csv',
+  '.htm': 'text/html',
+  '.html': 'text/html',
   '.licence': 'text/plain',
   '.license': 'text/plain',
   '.md': 'text/markdown',
@@ -32,6 +35,10 @@ const MAP_TEXT_EXTENSION_MIMETYPE: Readonly<Record<string, MimeType>> = {
   '.xml': 'text/xml' // not `application/xml` -- our scope is text!
 } as const
 
+/**
+ * Returns the guessed mime type of file, based on file name extension.
+ * Returns undefined if tile extension is unknown.
+ */
 export function getMimeTypeForTextFile (filename: string): MimeType | undefined {
   return MAP_TEXT_EXTENSION_MIMETYPE[extname(filename).toLowerCase()]
 }

src/builders/fromPath.node.ts

@@ -24,7 +24,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 import {readdirSync} from "fs";
 import {join, relative, resolve} from "path";
 
-import type {AttachmentFactory} from "../factories/fromPath.node";
+import type * as Factories from "../factories/index.node";
 import {NamedLicense} from "../models/license";
 
 
@@ -34,21 +34,23 @@ import {NamedLicense} from "../models/license";
  */
 export class LicenseEvidenceBuilder {
 
-  readonly #afac: AttachmentFactory
+  readonly #attachmentFactory: Factories.FromPath.AttachmentFactory
 
-  constructor(afac: AttachmentFactory) {
-    this.#afac = afac
+  constructor(attachmentFactory: LicenseEvidenceBuilder['attachmentFactory']) {
+    this.#attachmentFactory = attachmentFactory
   }
 
-  readonly #LICENSE_FILENAME_PATTERN = /^(?:UN)?LICEN[CS]E|.\.LICEN[CS]E$|^NOTICE$/i
+  get attachmentFactory (): Factories.FromPath.AttachmentFactory {
+    return this.#attachmentFactory
+  }
 
   /**
-   * Return a license on success, returns undefined if it appears to bes no known text file.
+   * Return a license on success.
+   * Returns undefined if it appears to bes no known text file.
    * Throws error, if license attachment content could not be fetched.
    *
    * @param file - path to file
-   * @param relativeFrom - path the file shall be relative to
-   * @returns {@link NamedLicense} on success
+   * @param relativeFrom - path the file shall be relative from
    */
   public fromFile(file: string, relativeFrom: string | undefined = undefined): NamedLicense | undefined {
     let name
@@ -59,19 +61,23 @@ export class LicenseEvidenceBuilder {
       file = resolve(relativeFrom, file)
       name = `file: ${relative(relativeFrom, file)}`
     }
-    const text = this.#afac.fromTextFile(file)
+    const text = this.#attachmentFactory.fromTextFile(file)
     if (text === undefined) {
       return undefined
     }
     return new NamedLicense(name, {text})
   }
 
+  readonly #LICENSE_FILENAME_PATTERN = /^(?:UN)?LICEN[CS]E|.\.LICEN[CS]E$|^NOTICE$/i
+
   /**
-   * Returns a generator for license evidences.
-   * Throws error, if dir content could not be inspected.
+   * Returns a generator for license evidences in a directory.
+   * Throws error, if directory content could not be inspected.
+   *
+   * Unreadable files will be omitted.
    *
    * @param dir - path to inspect
-   * @param relativeFrom - path the dir and files shall be relative to
+   * @param relativeFrom - path the dir and files shall be relative from
    */
   public * fromDir(dir: string, relativeFrom: string | undefined = undefined): Generator<NamedLicense> {
     if ( relativeFrom !== undefined) {

src/factories/fromPath.node.ts

@@ -23,9 +23,10 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 
 import {readFileSync} from "fs";
 
-import {getMimeTypeForTextFile, type MimeType} from "../_helpers/mime";
+import {getMimeTypeForTextFile} from "../_helpers/mime";
 import {AttachmentEncoding} from "../enums/attachmentEncoding";
 import {Attachment} from "../models/attachment";
+import type {MimeType} from "../types/mimeType";
 
 
 
@@ -35,26 +36,26 @@ import {Attachment} from "../models/attachment";
 export class AttachmentFactory {
 
   /**
-   * Return an attachment on success.
-   * Throws error, if content could not be fetched.
+   * Throws error, if file content could not be read.
    *
-   * @returns {@link NamedLicense} on success
+   * Content will be base64 encoded.
    */
-  public fromFile(file: string, contentType: MimeType): Attachment {
+  public fromFile(file: string, contentType: MimeType | undefined = undefined): Attachment {
     return new Attachment(
           // may throw if `readFileSync()` fails
-          readFileSync(file).toString('base64'),
+          readFileSync(file, {encoding: 'base64'}),
           {
             contentType,
             encoding: AttachmentEncoding.Base64
           })
   }
 
   /**
-   * Return an attachment on success, returns undefined if it appears to bes no known text file.
+   * Return an attachment on success.
+   * Returns undefined if it appears to be no known text file.
    * Throws error, if content could not be fetched.
    *
-   * @returns {@link Attachment} on success
+   * Tries to guess the file's mime-type.
    */
   public fromTextFile(file: string): Attachment | undefined {
     const contentType = getMimeTypeForTextFile(file)