feat: use serverless v3 logger and error class

Author: robin-thomas

src/index.ts

@@ -1,16 +1,20 @@
 import { SecretsManagerClient, GetSecretValueCommand } from '@aws-sdk/client-secrets-manager';
 
-import type { Serverless, ServerlessSecretHooks, ServerlessSecretOptions } from './index.types';
+import type { Serverless, ServerlessSecretHooks, ServerlessSecretOptions, ServerlessOptions } from './index.types';
 
 class ServerlessAWSSecret {
+  Error: ErrorConstructor;
   hooks: ServerlessSecretHooks;
+  log: NonNullable<ServerlessOptions['log']>;
   options: ServerlessSecretOptions;
   serverless: Serverless;
 
-  constructor(serverless: Serverless) {
+  constructor(serverless: Serverless, cliOptions: unknown, options: ServerlessOptions) {
     this.setOptions(serverless);
+    this.setLogger(options);
 
     this.serverless = serverless;
+    this.Error = serverless.classes?.Error ?? Error;
 
     this.hooks = {
       'before:package:initialize': this.loadSecrets.bind(this),
@@ -25,7 +29,7 @@ class ServerlessAWSSecret {
     const { SecretString } = await client.send(command);
 
     if (!SecretString) {
-      throw new this.serverless.classes.Error(`Failed to retrieve the secret: ${this.options.secretId}`);
+      throw new this.Error(`Failed to retrieve the secret: ${this.options.secretId}`);
     }
 
     const secrets = JSON.parse(SecretString);
@@ -36,20 +40,18 @@ class ServerlessAWSSecret {
         const secretKey = value.replace(this.options.secretPrefix!, '');
 
         if (!secrets[secretKey]) {
-          throw new Error(`Secret ${secretKey} do not exist`);
+          throw new this.Error(`Secret ${secretKey} do not exist`);
         }
 
-        if (this.options.verbose) {
-          console.log(`[serverless-aws-secrets]: Replacing ${key} with secret of ${secretKey}`);
-        }
+        this.log.verbose(`[serverless-aws-secrets]: Replacing ${key} with secret of ${secretKey}`);
 
         this.serverless.service.provider.environment[key] = secrets[secretKey];
 
         ++replaceCount;
       }
     }
 
-    console.log(`[serverless-aws-secrets]: Replaced ${replaceCount} secrets in environment variables`);
+    this.log.success(`[serverless-aws-secrets]: Replaced ${replaceCount} secrets in environment variables`);
   }
 
   setOptions(serverless: Serverless) {
@@ -60,6 +62,13 @@ class ServerlessAWSSecret {
     this.options.verbose = this.options.verbose ?? false;
   }
 
+  setLogger(options: ServerlessOptions) {
+    this.log = {
+      verbose: options.log?.verbose ?? this.options.verbose ? console.log : () => {},
+      success: options.log?.success ?? console.log,
+    };
+  }
+
   getSecretId(serverless: Serverless) {
     if (this.options?.secretId) {
       return this.options.secretId;

src/index.types.ts

@@ -13,7 +13,7 @@ export interface Serverless {
       };
     };
   };
-  classes: {
+  classes?: {
     Error: ErrorConstructor;
   };
 }
@@ -22,6 +22,13 @@ export interface ServerlessSecretHooks {
   [key: string]: () => void;
 }
 
+export interface ServerlessOptions {
+  log?: {
+    verbose: (message: string) => void;
+    success: (message: string) => void;
+  };
+}
+
 export interface ServerlessSecretOptions {
   /**
    * @dev Environment variables with values that start with this prefix are treated as secrets