serverless-kms-alias 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 2.2.0 - 2023-02-08
+
+- Replace enable/disable by stage with `enabled`
+
 ## 2.1.0 - 2023-02-08
 
 - Add configuration to enable for explicit stages. Fix #3

package/README.md

@@ -45,7 +45,7 @@ functions:
     kmsKeyArn: '${kms:arn:aws:kms:${aws:region}:${aws:accountId}:alias/aws/lambda}'
 ```
 
-### Example - Enable for specific stages
+### Example - Disable the plugin
 
 ```yaml
 service: foo
@@ -58,9 +58,7 @@ plugins:
 
 custom:
   kmsAlias:
-    stages:
-      # list of stages for which the plugin should be enabled
-      - production
+    enabled: false
 
 functions:
   foo:

package/dist/index.js

@@ -1,25 +1,27 @@
 "use strict";
 const client_kms_1 = require("@aws-sdk/client-kms");
 class KmsAliasPlugin {
-    constructor(serverless, options) {
+    constructor(serverless) {
         this.configurationVariablesSources = {
             kms: {
                 async resolve({ address }) {
                     if (!/^(alias\/[a-zA-Z]|arn:aws:kms:[\w-]*:[\d]*:alias)/i.test(address)) {
                         throw new Error(`Expected variable in the form of 'kms:alias/foo'`);
                     }
-                    if (serverless.service?.custom?.kmsAlias?.stages?.length) {
-                        const stage = options?.stage || serverless.config?.stage || serverless.service?.provider?.stage;
-                        if (stage) {
-                            if (!serverless.service.custom.kmsAlias.stages.includes(stage)) {
-                                serverless.cli.log(`Info: KMS Alias plugin not enabled for stage`);
+                    if (serverless.service?.custom?.kmsAlias?.enabled != null) {
+                        try {
+                            const isEnabled = serverless.service.custom.kmsAlias.enabled ? Boolean(JSON.parse(`${serverless.service.custom.kmsAlias.enabled}`.toLowerCase())) : false;
+                            if (!isEnabled) {
+                                serverless.cli.log(`Info: KMS Alias plugin not enabled`);
                                 return {
                                     value: address,
                                 };
                             }
                         }
-                        else {
-                            serverless.cli.log(`Warn: Unable to determine stage for KMS alias`);
+                        catch (ex) {
+                            throw new Error(`Unable to get enabled configuration for kms alias.`, {
+                                cause: ex,
+                            });
                         }
                     }
                     serverless.cli.log(`Info: Fetching KMS key for alias: ${address}`);
@@ -48,4 +50,4 @@ class KmsAliasPlugin {
     }
 }
 module.exports = KmsAliasPlugin;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLG9EQUFvRTtBQWtCcEUsTUFBTSxjQUFjO0lBR2xCLFlBQW1CLFVBQThCLEVBQUUsT0FBMEI7UUFDM0UsSUFBSSxDQUFDLDZCQUE2QixHQUFHO1lBQ25DLEdBQUcsRUFBRTtnQkFDSCxLQUFLLENBQUMsT0FBTyxDQUFDLEVBQUUsT0FBTyxFQUFpQjtvQkFDdEMsSUFBSSxDQUFDLG9EQUFvRCxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsRUFBRTt3QkFDdkUsTUFBTSxJQUFJLEtBQUssQ0FBQyxrREFBa0QsQ0FBQyxDQUFDO3FCQUNyRTtvQkFFRCxJQUFJLFVBQVUsQ0FBQyxPQUFPLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFO3dCQUN4RCxNQUFNLEtBQUssR0FBRyxPQUFPLEVBQUUsS0FBSyxJQUFJLFVBQVUsQ0FBQyxNQUFNLEVBQUUsS0FBSyxJQUFJLFVBQVUsQ0FBQyxPQUFPLEVBQUUsUUFBUSxFQUFFLEtBQUssQ0FBQzt3QkFDaEcsSUFBSSxLQUFLLEVBQUU7NEJBQ1QsSUFBSSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxFQUFFO2dDQUM5RCxVQUFVLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyw4Q0FBOEMsQ0FBQyxDQUFDO2dDQUNuRSxPQUFPO29DQUNMLEtBQUssRUFBRSxPQUFPO2lDQUNmLENBQUM7NkJBQ0g7eUJBQ0Y7NkJBQU07NEJBQ0wsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsK0NBQStDLENBQUMsQ0FBQzt5QkFDckU7cUJBQ0Y7b0JBRUQsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMscUNBQXFDLE9BQU8sRUFBRSxDQUFDLENBQUM7b0JBRW5FLE1BQU0sTUFBTSxHQUFHLElBQUksc0JBQVMsQ0FBQzt3QkFDM0IsR0FBRyxVQUFVLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxjQUFjLEVBQUU7d0JBQzVDLE1BQU0sRUFBRSxVQUFVLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxTQUFTLEVBQUU7cUJBQzdDLENBQUMsQ0FBQztvQkFDSCxNQUFNLE9BQU8sR0FBRyxJQUFJLCtCQUFrQixDQUFDO3dCQUNyQyxLQUFLLEVBQUUsT0FBTztxQkFDZixDQUFDLENBQUM7b0JBQ0gsTUFBTSxRQUFRLEdBQUcsTUFBTSxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO29CQUU1QyxNQUFNLFdBQVcsR0FBRyxRQUFRLENBQUMsV0FBVyxDQUFDO29CQUV6QyxJQUFJLENBQUMsV0FBVyxFQUFFO3dCQUNoQixNQUFNLElBQUksS0FBSyxDQUFDLDZDQUE2QyxPQUFPLEVBQUUsQ0FBQyxDQUFDO3FCQUN6RTtvQkFFRCxJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsRUFBRTt3QkFDcEIsTUFBTSxJQUFJLEtBQUssQ0FBQywwQ0FBMEMsT0FBTyxFQUFFLENBQUMsQ0FBQztxQkFDdEU7b0JBRUQsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsa0NBQWtDLE9BQU8sTUFBTSxXQUFXLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztvQkFFckYsT0FBTzt3QkFDTCxLQUFLLEVBQUUsV0FBVyxDQUFDLEdBQUc7cUJBQ3ZCLENBQUM7Z0JBQ0osQ0FBQzthQUNGO1NBQ0YsQ0FBQztJQUNKLENBQUM7Q0FDRjtBQUVELGlCQUFTLGNBQWMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLG9EQUFvRTtBQWtCcEUsTUFBTSxjQUFjO0lBR2xCLFlBQW1CLFVBQThCO1FBQy9DLElBQUksQ0FBQyw2QkFBNkIsR0FBRztZQUNuQyxHQUFHLEVBQUU7Z0JBQ0gsS0FBSyxDQUFDLE9BQU8sQ0FBQyxFQUFFLE9BQU8sRUFBaUI7b0JBQ3RDLElBQUksQ0FBQyxvREFBb0QsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUU7d0JBQ3ZFLE1BQU0sSUFBSSxLQUFLLENBQUMsa0RBQWtELENBQUMsQ0FBQztxQkFDckU7b0JBRUQsSUFBSSxVQUFVLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxRQUFRLEVBQUUsT0FBTyxJQUFJLElBQUksRUFBRTt3QkFDekQsSUFBSTs0QkFDRixNQUFNLFNBQVMsR0FBRyxVQUFVLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLFVBQVUsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxXQUFXLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQzs0QkFDMUosSUFBSSxDQUFDLFNBQVMsRUFBRTtnQ0FDZCxVQUFVLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxvQ0FBb0MsQ0FBQyxDQUFDO2dDQUN6RCxPQUFPO29DQUNMLEtBQUssRUFBRSxPQUFPO2lDQUNmLENBQUM7NkJBQ0g7eUJBQ0Y7d0JBQUMsT0FBTyxFQUFFLEVBQUU7NEJBQ1gsTUFBTSxJQUFJLEtBQUssQ0FBQyxvREFBb0QsRUFBRTtnQ0FDcEUsS0FBSyxFQUFFLEVBQUU7NkJBQ1YsQ0FBQyxDQUFDO3lCQUNKO3FCQUNGO29CQUVELFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLHFDQUFxQyxPQUFPLEVBQUUsQ0FBQyxDQUFDO29CQUVuRSxNQUFNLE1BQU0sR0FBRyxJQUFJLHNCQUFTLENBQUM7d0JBQzNCLEdBQUcsVUFBVSxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsY0FBYyxFQUFFO3dCQUM1QyxNQUFNLEVBQUUsVUFBVSxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsU0FBUyxFQUFFO3FCQUM3QyxDQUFDLENBQUM7b0JBQ0gsTUFBTSxPQUFPLEdBQUcsSUFBSSwrQkFBa0IsQ0FBQzt3QkFDckMsS0FBSyxFQUFFLE9BQU87cUJBQ2YsQ0FBQyxDQUFDO29CQUNILE1BQU0sUUFBUSxHQUFHLE1BQU0sTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztvQkFFNUMsTUFBTSxXQUFXLEdBQUcsUUFBUSxDQUFDLFdBQVcsQ0FBQztvQkFFekMsSUFBSSxDQUFDLFdBQVcsRUFBRTt3QkFDaEIsTUFBTSxJQUFJLEtBQUssQ0FBQyw2Q0FBNkMsT0FBTyxFQUFFLENBQUMsQ0FBQztxQkFDekU7b0JBRUQsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLEVBQUU7d0JBQ3BCLE1BQU0sSUFBSSxLQUFLLENBQUMsMENBQTBDLE9BQU8sRUFBRSxDQUFDLENBQUM7cUJBQ3RFO29CQUVELFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLGtDQUFrQyxPQUFPLE1BQU0sV0FBVyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7b0JBRXJGLE9BQU87d0JBQ0wsS0FBSyxFQUFFLFdBQVcsQ0FBQyxHQUFHO3FCQUN2QixDQUFDO2dCQUNKLENBQUM7YUFDRjtTQUNGLENBQUM7SUFDSixDQUFDO0NBQ0Y7QUFFRCxpQkFBUyxjQUFjLENBQUMifQ==

package/dist/types/index.js

@@ -16,5 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./KmsAliasSettings"), exports);
 __exportStar(require("./ServerlessInstance"), exports);
-__exportStar(require("./ServerlessOptions"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHFEQUFtQztBQUNuQyx1REFBcUM7QUFDckMsc0RBQW9DIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHFEQUFtQztBQUNuQyx1REFBcUMifQ==

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-kms-alias",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "engines": {
     "node": ">= 14"
   },

package/src/index.ts

@@ -1,6 +1,6 @@
 import { DescribeKeyCommand, KMSClient } from '@aws-sdk/client-kms';
 
-import type { ServerlessInstance, ServerlessOptions } from './types';
+import type { ServerlessInstance } from './types';
 
 interface ResolveParams {
   address: string;
@@ -19,7 +19,7 @@ interface ServerlessVariableSource {
 class KmsAliasPlugin {
   public configurationVariablesSources: Record<string, ServerlessVariableSource>;
 
-  public constructor(serverless: ServerlessInstance, options: ServerlessOptions) {
+  public constructor(serverless: ServerlessInstance) {
     this.configurationVariablesSources = {
       kms: {
         async resolve({ address }: ResolveParams): Promise<ResolveResult> {
@@ -27,17 +27,19 @@ class KmsAliasPlugin {
             throw new Error(`Expected variable in the form of 'kms:alias/foo'`);
           }
 
-          if (serverless.service?.custom?.kmsAlias?.stages?.length) {
-            const stage = options?.stage || serverless.config?.stage || serverless.service?.provider?.stage;
-            if (stage) {
-              if (!serverless.service.custom.kmsAlias.stages.includes(stage)) {
-                serverless.cli.log(`Info: KMS Alias plugin not enabled for stage`);
+          if (serverless.service?.custom?.kmsAlias?.enabled != null) {
+            try {
+              const isEnabled = serverless.service.custom.kmsAlias.enabled ? Boolean(JSON.parse(`${serverless.service.custom.kmsAlias.enabled}`.toLowerCase())) : false;
+              if (!isEnabled) {
+                serverless.cli.log(`Info: KMS Alias plugin not enabled`);
                 return {
                   value: address,
                 };
               }
-            } else {
-              serverless.cli.log(`Warn: Unable to determine stage for KMS alias`);
+            } catch (ex) {
+              throw new Error(`Unable to get enabled configuration for kms alias.`, {
+                cause: ex,
+              });
             }
           }
 

package/src/types/KmsAliasSettings.ts

@@ -1,3 +1,3 @@
 export interface KmsAliasSettings {
-  stages?: string[];
+  enabled?: string;
 }

package/src/types/ServerlessInstance.ts

@@ -3,9 +3,6 @@ import type { AwsAuthInputConfig } from '@aws-sdk/middleware-signing/dist-types/
 import type { KmsAliasSettings } from './KmsAliasSettings';
 
 export interface ServerlessInstance {
-  config?: {
-    stage?: string;
-  };
   providers: {
     aws: {
       getCredentials(): AwsAuthInputConfig['credentials'];
@@ -13,9 +10,6 @@ export interface ServerlessInstance {
     };
   };
   service: {
-    provider: {
-      stage?: string;
-    };
     custom: {
       kmsAlias?: KmsAliasSettings;
     };

package/src/types/index.ts

@@ -1,3 +1,2 @@
 export * from './KmsAliasSettings';
 export * from './ServerlessInstance';
-export * from './ServerlessOptions';

package/dist/types/ServerlessOptions.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2VydmVybGVzc09wdGlvbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMvU2VydmVybGVzc09wdGlvbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/src/types/ServerlessOptions.ts

@@ -1,3 +0,0 @@
-export interface ServerlessOptions {
-  stage?: string;
-}