feat: add afterPackage hook for plugins

Author: Inqnuam

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-aws-lambda",
-  "version": "4.8.2",
+  "version": "4.8.3",
   "description": "AWS Application Load Balancer and API Gateway - Lambda dev tool for Serverless. Allows Express synthax in handlers. Supports packaging, local invoking and offline ALB, APG, S3, SNS, SQS, DynamoDB Stream server mocking.",
   "author": "Inqnuam",
   "license": "MIT",
@@ -70,7 +70,7 @@
     "@types/archiver": "^5.3.2",
     "@types/node": "^14.14.31",
     "@types/serve-static": "^1.15.5",
-    "typescript": "^5.5.3",
+    "typescript": "^5.5.4",
     "vitest": "^1.6.0"
   },
   "keywords": [

src/config.ts

@@ -18,6 +18,7 @@ export interface Config {
   offline?: OfflineConfig;
   buildCallback?: (result: BuildResult, isRebuild: boolean) => Promise<void> | void;
   afterDeployCallbacks?: (() => Promise<void> | void)[];
+  afterPackageCallbacks?: (() => Promise<void> | void)[];
 }
 
 export interface ServerConfig {

src/defineConfig.ts

@@ -83,6 +83,7 @@ export interface SlsAwsLambdaPlugin {
   onInit?: (this: ClientConfigParams) => Promise<void> | void;
   onExit?: (this: ClientConfigParams, code: string | number) => void;
   afterDeploy?: (this: ClientConfigParams) => Promise<void> | void;
+  afterPackage?: (this: ClientConfigParams) => Promise<void> | void;
   offline?: {
     onReady?: (this: ClientConfigParams, port: number, ip: string) => Promise<void> | void;
     /**
@@ -171,6 +172,7 @@ function defineConfig(options: Options) {
         port: options.offline?.port,
       },
       afterDeployCallbacks: [],
+      afterPackageCallbacks: [],
     };
 
     if (options.services) {
@@ -244,6 +246,11 @@ function defineConfig(options: Options) {
         if (typeof plugin.afterDeploy == "function") {
           config.afterDeployCallbacks!.push(plugin.afterDeploy.bind(self));
         }
+
+        if (typeof plugin.afterPackage == "function") {
+          config.afterPackageCallbacks!.push(plugin.afterPackage.bind(self));
+        }
+
         if (plugin.onInit) {
           try {
             await plugin.onInit.call(self);
@@ -258,6 +265,10 @@ function defineConfig(options: Options) {
     if (!config.afterDeployCallbacks!.length) {
       delete config.afterDeployCallbacks;
     }
+    if (!config.afterPackageCallbacks!.length) {
+      delete config.afterPackageCallbacks;
+    }
+
     return config;
   };
 }

src/index.ts

@@ -55,6 +55,7 @@ class ServerlessAwsLambda extends Daemon {
   nodeVersion: number | boolean | string | undefined = false;
   invokeName?: string;
   afterDeployCallbacks: (() => void | Promise<void>)[] = [];
+  afterPackageCallbacks: (() => void | Promise<void>)[] = [];
   resources: ReturnType<typeof getResources> = { ddb: {}, kinesis: {}, sns: {}, sqs: {} };
   static tags: string[] = ["build"];
   constructor(serverless: any, options: any, pluginUtils: PluginUtils) {
@@ -120,6 +121,7 @@ class ServerlessAwsLambda extends Daemon {
       "before:invoke:local:invoke": this.invokeLocal.bind(this),
       "after:aws:deploy:finalize:cleanup": this.afterDeploy.bind(this),
       "after:invoke:local:invoke": process.exit,
+      "after:package:finalize": this.afterPackage.bind(this),
     };
   }
 
@@ -139,6 +141,11 @@ class ServerlessAwsLambda extends Daemon {
       }
     }
   }
+  async afterPackage() {
+    for (const cb of this.afterPackageCallbacks) {
+      await cb();
+    }
+  }
   async init(isPackaging: boolean) {
     this.resources = getResources(this.serverless);
     this.#setRuntimeEnvs();
@@ -581,6 +588,10 @@ class ServerlessAwsLambda extends Daemon {
         this.afterDeployCallbacks = exportedObject.afterDeployCallbacks;
       }
 
+      if (Array.isArray(exportedObject.afterPackageCallbacks)) {
+        this.afterPackageCallbacks = exportedObject.afterPackageCallbacks;
+      }
+
       if (exportedObject.offline && typeof exportedObject.offline == "object") {
         if (Array.isArray(exportedObject.offline.request)) {
           customOfflineRequests.unshift(...exportedObject.offline.request);

yarn.lock

@@ -1687,10 +1687,10 @@ lazystream@^1.0.0:
   dependencies:
     readable-stream "^2.0.5"
 
-local-aws-sqs@^1.0.1:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/local-aws-sqs/-/local-aws-sqs-1.0.1.tgz#1e9c25fd3409598595a309684bcb1d23991ce76c"
-  integrity sha512-Dn5ueF5WUV5LOHrKhjjYUvZo7Rchla3DtkjZ1G8cy6zNxfmJYlu3PTRkponCtBSaVehrMZ0SKKdIJ2JXJsOXFQ==
+local-aws-sqs@^1.0.2:
+  version "1.0.2"
+  resolved "https://registry.yarnpkg.com/local-aws-sqs/-/local-aws-sqs-1.0.2.tgz#c921fbe50b86d79df91e3a93c8c12a80f6d414c7"
+  integrity sha512-l5MwX8zS+mLAVYwEAbRZEf9kmbeJxRbn03vJnuglCNQA1urgWmFCh1C2reQtoo9B2Maiw8iDKrDyZAZfYSTQig==
   dependencies:
     aws-md5-of-message-attributes "^1.0.0"
     aws-query-decoder "^1.0.1"
@@ -2145,10 +2145,10 @@ type-detect@^4.0.0, type-detect@^4.0.8:
   resolved "https://registry.yarnpkg.com/type-detect/-/type-detect-4.0.8.tgz#7646fb5f18871cfbb7749e69bd39a6388eb7450c"
   integrity sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==
 
-typescript@^5.5.3:
-  version "5.5.3"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.5.3.tgz#e1b0a3c394190838a0b168e771b0ad56a0af0faa"
-  integrity sha512-/hreyEujaB0w76zKo6717l3L0o/qEUtRgdvUBvlkhoWeOVMjMuHNHk0BRBzikzuGDqNmPQbg5ifMEqsHLiIUcQ==
+typescript@^5.5.4:
+  version "5.5.4"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.5.4.tgz#d9852d6c82bad2d2eda4fd74a5762a8f5909e9ba"
+  integrity sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q==
 
 ufo@^1.5.3:
   version "1.5.3"