fix: import optional deps gracefully (#554)

Author: pmb0

src/adapter/http.adapter.ts

@@ -1,15 +1,19 @@
+import type { ExtendOptions, Got, RequestError } from 'got'
 import { ImageAdapter } from '../interfaces'
-import got, { Got, ExtendOptions, RequestError } from 'got'
 import { getLogger } from '../logger'
+import { optionalRequire } from '../optional-require'
 
 export class HttpAdapter implements ImageAdapter {
   private client: Got
   private log = getLogger('adapter:http')
 
   constructor(gotOptions: ExtendOptions) {
+    const got = optionalRequire<{ default: Got }>('got').default
+
     this.client = got.extend({
       ...gotOptions,
     })
+
     this.log(`Using prefixUrl: ${this.getPrefixUrl()}`)
   }
 

src/adapter/s3.adapter.ts

@@ -1,23 +1,29 @@
-import { S3 } from 'aws-sdk'
-import { ImageAdapter } from '../interfaces'
+import type { S3 as S3Type } from 'aws-sdk'
+import { ImageAdapter, Type } from '../interfaces'
 import { getLogger } from '../logger'
+import { optionalRequire } from '../optional-require'
 
 export class S3Adapter implements ImageAdapter {
   private log = getLogger('adapter:s3')
 
   constructor(
     public readonly bucketName: string,
-    private readonly s3client = new S3(),
+    private readonly s3client?: S3Type,
   ) {
+    const { S3 } = optionalRequire<{ S3: Type<S3Type> }>('aws-sdk')
+    this.s3client ??= new S3()
+
     this.log(`Using bucket name: ${bucketName}`)
   }
 
   async fetch(id: string): Promise<Buffer | undefined> {
     this.log(`Fetching image "${id}" from bucket "${this.bucketName}"`)
     try {
-      const object = await this.s3client
-        .getObject({ Bucket: this.bucketName, Key: id })
-        .promise()
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const object = await this.s3client!.getObject({
+        Bucket: this.bucketName,
+        Key: id,
+      }).promise()
 
       if (!Buffer.isBuffer(object.Body)) {
         return undefined

src/interfaces.ts

@@ -35,3 +35,7 @@ export interface Signer {
   sign(string: string | URL): string
   verify(string: string): boolean
 }
+
+export interface Type<T = unknown> extends Function {
+  new (...args: unknown[]): T
+}

src/optional-require.ts

@@ -0,0 +1,11 @@
+export function optionalRequire<T>(
+  packageName: string,
+  // eslint-disable-next-line @typescript-eslint/ban-types
+): T {
+  try {
+    // eslint-disable-next-line security/detect-non-literal-require,  @typescript-eslint/no-var-requires
+    return require(packageName) as unknown as T
+  } catch {
+    return {} as unknown as T
+  }
+}